Actualización de Escrow

patch https://api.zenki.fi/v1/pay/escrow/{zenkiOrderId}/fulfillments

Servicio encargado de actualizar el Escrow para pedidos sin número de rastreo.

Responses

Response body

object

version

string

required

length ≤ 9

Versión del modelo de datos, su valor actual debe ser v1.0.0.

zenkiOrderId

string

required

length ≤ 128

Identificador único de la orden generado por Zenkipay.

orderId

string

length ≤ 128

Identificador único de la orden generado por el comercio.

cartId

string

length ≤ 128

Identificador único del carrito de compra que permite identificar la compra de uno o varios productos o servicios.

type

string

required

Indica el modelo para la entrega del producto o servicio.

Posibles valores:

WITH_CARRIER - Para la entrega del producto o servicio se va a utilizar un carrier de envío.
WITHOUT_CARRIER - Para la entrega del producto o servicio NO se va a utilizar un carrier de envío.
MIXED - Para la entrega de los productos o servicios una parteutilizará un carrier de envío y otra parte se entregara sin utilizar un carrier de envío.

WITH_CARRIER WITHOUT_CARRIER MIXED

countryCodeIso2

string

required

length ≤ 2

Identificador único del país, se utiliza la definición del estándar ISO_3166-1 a 2 caracteres véase: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2 o https://www.iso.org/iso-3166-country-codes.html

status

string

required

Estado de la orden

Posibles valores:

PENDING - En espera a que el comprador pague la orden de pago.
READY4PAY - Al comprador se le ha mostrado la modal y la orden está lista para que el comprador pague la orden con su monedero.
AWAITING_PAYMENT - Se ha recibido una primera confirmación por la red de blockchain, está en espera de tener las confirmaciones requeridas.
AWAITING_DELIVERY - Ya se realizó el pago del producto o servicio y la entrega del producto o servicio está en proceso.
DELIVERED_SERVICE - Ya se ha realizado la entrega del servicio.
AWAITING_SHIPMENT - Ya se realizó la carga de la guía para los productos y está en proceso el envío.
SHIPPED - Se ha enviado el producto o servicio.
SHIPMENT_ERROR - Hubo un problema en el proceso de envío.
AWAITING_SHOPPER_APPROVAL - Esperando la aprobación por parte del comprador para confirmar que ha recibido el producto o servicio.
DISPUTED - El comprador ha iniciado un proceso de disputa con el comercio.
PENDING_SHOPPER_RETURN - El comercio esta esperando a que el comrpador realice el regreso del producto, como resultado de la disputa.
REFUNDED - Se ha realizado el reembolso del producto o servicio al comprador.
COMPLETED - El comprador confirma la recepción del producto o servicio satisfactoriamente y se ha hecho el intercambio a moneda estable del valor de la venta solo si aplica.
SETTLED - Se ha liquidado la transacción al comercio.

PENDING READY4PAY AWAITING_PAYMENT AWAITING_DELIVERY DELIVERED_SERVICE AWAITING_SHIPMENT SHIPPED SHIPMENT_ERROR AWAITING_SHOPPER_APPROVAL DISPUTED PENDING_SHOPPER_RETURN REFUNDED COMPLETED SETTLED

createdAt

int64

required

≥ 0

Fecha y hora cuando Zenkipay recibió la solicitud para crear la orden, en formato de milisegundos y UTC.

La época Unix (o Unix time o POSIX time o Unix timestamp) es el número de segundos transcurridos desde el 1 de enero de 1970 (medianoche UTC/GMT), sin contar los segundos bisiestos (en ISO 8601: 1970-01-01T00:00 :00Z)

shopper

object | null

Información del comprador.

string | null

Identificador único del comprador generado por el comercio.

name

string | null

Nombre del comprador.

phone

string | null

Número telefónico del comprador.

string

required

length ≤ 128

Correo electrónico del comprador usaado para notificar el estado de su procedo de envío y entrega.

breakdown

object

required

Resumen de los montos del carrito de compra.

currencyCodeIso3

string

required

length ≤ 5

Código único de la moneda del país, se utiliza la definición del estándar ISO 4217 a 3 caracteres véase: https://es.wikipedia.org/wiki/ISO_4217 o https://www.iso.org/iso-4217-currency-codes.html.

totalItemsAmount

double

required

≥ 0

Suma del total del costo de los artículos (quantity * unitPrice).

shipmentAmount

double

required

≥ 0

Costo de envío, en caso de no aplicar su valor debe ser 0.

subtotalAmount

double

required

≥ 0

Suma del totalItemsAmount más shipmentAmount.

taxesAmount

double

required

≥ 0

Impuestos, en caso de no aplicar su valor debe ser 0.

localTaxesAmount

double | null

≥ 0

Impuestos locales, en caso de no aplicar su valor debe ser 0.

importCosts

double | null

≥ 0

Costos de importación, en caso de no aplicar su valor debe ser 0.

discountAmount

double | null

≥ 0

Descuento de tu comercio, en caso de no aplicar su valor debe ser 0.

additionalCharges

Cargos adicionales, se compone de un objeto llave/valor que comprende la descripción del cargo/el monto respectivamente.

grandTotalAmount

double

required

≥ 0

Suma de subtotalAmount, taxesAmount, localTaxesAmount, importCosts y cada valor dde additionalCharges menos discountAmount.

paymentInfo

object | null

Información del pago

exchangeRate

object

required

Resumen del tipo de cambio usado para el pago, desde la moneda local a USD

cryptoLove

object

required

Resumen del descuento realizado a la compra por el uso de crypto love.

cryptoPayment

object

required

Resumen del monto pagado en crypto moenda por el comprador.

settlementInfo

object | null

Información de la orden para la liquidación a comercio

cryptoSettlement

object

required

Detalle del pago a realizar en cripto moneda

items

array of objects

required

Conjunto de productos o servicios considerados dentro del carrito de compra.

items*

object

externalId

string

length ≤ 128

Identificador único del producto o servicio asignado por el comercio.

quantity

int64

required

≥ 0

Número total de productos o servicios del pedido del mismo tipo.

unitPrice

double

required

≥ 0

Precio unitario del producto o servicio.

name

string

required

length ≤ 128

Nombre corto del producto o servicio.

description

string | null

Descripción del producto o servicio.

type

string

Indica el modelo para la entrega del producto o servicio.

Posibles valores:

WITH_CARRIER - Para la entrega del producto o servicio se va a utilizar un carrier de envío.
WITHOUT_CARRIER - Para la entrega del producto o servicio NO se va a utilizar un carrier de envío.

WITH_CARRIER WITHOUT_CARRIER

thumbnailUrl

string | null

URL de la imagen del producto (miniatura).

metadata

Información complementaria del producto o servicio que se requiere informar o tener en el sistema de Zenkipay.

metadata

Información complementaria de la orden que el comercio requiera enviar e informar a Zenkipay.

dispute

object

Detalle del proceso de una disputa.

status

string

required

Estado actual de la disputa.

Posibles valores:

OPEN - Se ha iniciado el proceso de disputa.
REFUND - Se ha cerrado el proceso de disputa y se realizó un reembolso parcial o total del monto total de la orden.
RESOLVED - Se ha cerrado el proceso de disputa sin realizar ningún movimiento de reembolso hacia el comprador.

OPEN REFUND RESOLVED

createdAt

int64

required

≥ 0

Fecha y hora en la que se inicio la disputa, en formato de milisegundos y UTC.

resolutionRequestType

string

Tipo de apoyo solicitado a staff de Zenki.

Posibles valores:

REQUEST_REFUND - Solicitud de apoyo a staff de Zenki para realizar reembolso.
REQUEST_CONCILIATED - Solicitud a staff de Zenki para conciliar dispita entre comprador y comercio.

REQUEST_REFUND REQUEST_CONCILIATED

resolutionRequestAt

int64

≥ 0

Fecha y hora en la que se finalizo la disputa y se dió una resolución final del proceso al comprador, en formato de milisegundos y UTC.

claim

object

Detalle del proceso de una reclamación, cuando se realiza un pago y Zenkipay no puede identificarlo y asocialo a la orden para el pago.

reason

string | null

Razón por la que se inicio la aclaración.

status

string

required

Estado actual del reclamo.

Posibles valores:

OPEN - Se ha iniciado el proceso de la reclamación.
REFUND - Se ha cerrado el proceso de la reclamación y se realizó un reembolso parcial o total del monto total de la orden.
RESOLVED - Se ha cerrado el proceso de la reclamación sin realizar ningún movimiento de reembolso hacia el comprador, solamente se asocia la transacción de pago a la orden indicada.
REJECTED - Cuando no aplica el reclamo, por que trata de asociar un pago que no coincide con los datos de la transacción.

OPEN REFUND RESOLVED REJECTED

createdAt

int64

required

≥ 0

Fecha y hora en la que se inicio la aclaración, en formato de milisegundos y UTC.

_links

object | null

Lista de recursos relacionados a la orden.
Los estándares utilizdos para operar bajo el modelo de HATEOAS son: https://stateless.group/hal_specification.html, https://datatracker.ietf.org/doc/html/draft-kelly-json-hal y https://www.rfc-editor.org/rfc/rfc8288

Los recursos soportados actualmente para regresar dentro de la propiedad _link son:

refund - Regresa la URI del reembolso en caso de existir para la orden.

refund

object

Detalle del reembolso en caso de tener algún registrado a la orden.

paymentSignature

string

Firma de la información de la orden de pago para mostrar la modal.

Response body

object

requestId

string

required

length ≤ 128

Identificador único del error generado por Zenkipay por cada petición enviada al API.

title

string

required

length ≤ 255

Descripción corta del error.

errorCode

int64

required

0 to 999

Código de error que ayuda a identificar el motivo del problema al momento de procesar la petición, este código estará basado en los códigos HTTP actualmente soportados por la especificación: https://www.rfc-editor.org/rfc/rfc9110#section-15

category

string

required

Categoría del error ocurrido.

Posibles valores:

FATAL - Cualquier error que fuerce el cierre del servicio o la aplicación para evitar la pérdida de datos (o una mayor pérdida de datos). Se reserva solo para los errores y situaciones más atroces en los que se garantiza que ha habido corrupción o pérdida de datos.
SEVERE - Cualquier error que sea fatal para el servicio, pero no para la aplicación completa (El servicio dejo de responder o no se puede ejecutar una operación). Estos errores forzarán la intervención del usuario (administrador o usuario directo).
ERROR - Cualquier error que sea fatal para la operación, pero no para el servicio o la aplicación (no se puede abrir un archivo requerido, faltan datos, etc.). Estos errores forzarán la intervención del usuario (administrador o usuario directo).
WARN - Cualquier cosa que potencialmente pueda causar rarezas en la aplicación, pero para lo cual me estoy recuperando automáticamente (Como cambiar de un servidor primario a uno de respaldo, volver a intentar una operación, perder datos secundarios, etc.).
INFO - Designa mensajes informativos que resaltan el progreso de la aplicación y posiblemnte hubo algún error menor que afecta muy poco a la experiencia.

FATAL SEVERE ERROR WARN INFO

validationErrors

array of objects | null

Conjunto de validaciones que no pasaron al evaluar la información de la petición.

validationErrors

object

objectName

string

required

length ≤ 255

Nombre del objeto en la estructura de datos donde se origina el error.

field

string

required

length ≤ 255

Campo del objeto donde presenta errores de validación.

message

string

required

length ≤ 255

Descripción del error ocasionado al no pasar alguna validación de la información.

humanMessage

string

required

length ≤ 300

Mensaje de error recomendado para mostrar a los compradores, este mensaje está soportado para los lenguajes de ingles y español.

timestamp

int64

required

≥ 0

Fecha y hora en formato de milisegundos y UTC para identificar las diferentes peiticiones en el tiempo los diferentes que han tenido errores.

Response body

object

requestId

string

required

length ≤ 128

Identificador único del error generado por Zenkipay por cada petición enviada al API.

title

string

required

length ≤ 255

Descripción corta del error.

errorCode

int64

required

0 to 999

category

string

required

Categoría del error ocurrido.

Posibles valores:

FATAL - Cualquier error que fuerce el cierre del servicio o la aplicación para evitar la pérdida de datos (o una mayor pérdida de datos). Se reserva solo para los errores y situaciones más atroces en los que se garantiza que ha habido corrupción o pérdida de datos.
SEVERE - Cualquier error que sea fatal para el servicio, pero no para la aplicación completa (El servicio dejo de responder o no se puede ejecutar una operación). Estos errores forzarán la intervención del usuario (administrador o usuario directo).
ERROR - Cualquier error que sea fatal para la operación, pero no para el servicio o la aplicación (no se puede abrir un archivo requerido, faltan datos, etc.). Estos errores forzarán la intervención del usuario (administrador o usuario directo).
WARN - Cualquier cosa que potencialmente pueda causar rarezas en la aplicación, pero para lo cual me estoy recuperando automáticamente (Como cambiar de un servidor primario a uno de respaldo, volver a intentar una operación, perder datos secundarios, etc.).
INFO - Designa mensajes informativos que resaltan el progreso de la aplicación y posiblemnte hubo algún error menor que afecta muy poco a la experiencia.

FATAL SEVERE ERROR WARN INFO

validationErrors

array of objects | null

Conjunto de validaciones que no pasaron al evaluar la información de la petición.

validationErrors

object

objectName

string

required

length ≤ 255

Nombre del objeto en la estructura de datos donde se origina el error.

field

string

required

length ≤ 255

Campo del objeto donde presenta errores de validación.

message

string

required

length ≤ 255

Descripción del error ocasionado al no pasar alguna validación de la información.

humanMessage

string

required

length ≤ 300

Mensaje de error recomendado para mostrar a los compradores, este mensaje está soportado para los lenguajes de ingles y español.

timestamp

int64

required

≥ 0

Fecha y hora en formato de milisegundos y UTC para identificar las diferentes peiticiones en el tiempo los diferentes que han tenido errores.

Response body

object

requestId

string

required

length ≤ 128

Identificador único del error generado por Zenkipay por cada petición enviada al API.

title

string

required

length ≤ 255

Descripción corta del error.

errorCode

int64

required

0 to 999

category

string

required

Categoría del error ocurrido.

Posibles valores:

FATAL - Cualquier error que fuerce el cierre del servicio o la aplicación para evitar la pérdida de datos (o una mayor pérdida de datos). Se reserva solo para los errores y situaciones más atroces en los que se garantiza que ha habido corrupción o pérdida de datos.
SEVERE - Cualquier error que sea fatal para el servicio, pero no para la aplicación completa (El servicio dejo de responder o no se puede ejecutar una operación). Estos errores forzarán la intervención del usuario (administrador o usuario directo).
ERROR - Cualquier error que sea fatal para la operación, pero no para el servicio o la aplicación (no se puede abrir un archivo requerido, faltan datos, etc.). Estos errores forzarán la intervención del usuario (administrador o usuario directo).
WARN - Cualquier cosa que potencialmente pueda causar rarezas en la aplicación, pero para lo cual me estoy recuperando automáticamente (Como cambiar de un servidor primario a uno de respaldo, volver a intentar una operación, perder datos secundarios, etc.).
INFO - Designa mensajes informativos que resaltan el progreso de la aplicación y posiblemnte hubo algún error menor que afecta muy poco a la experiencia.

FATAL SEVERE ERROR WARN INFO

validationErrors

array of objects | null

Conjunto de validaciones que no pasaron al evaluar la información de la petición.

validationErrors

object

objectName

string

required

length ≤ 255

Nombre del objeto en la estructura de datos donde se origina el error.

field

string

required

length ≤ 255

Campo del objeto donde presenta errores de validación.

message

string

required

length ≤ 255

Descripción del error ocasionado al no pasar alguna validación de la información.

humanMessage

string

required

length ≤ 300

Mensaje de error recomendado para mostrar a los compradores, este mensaje está soportado para los lenguajes de ingles y español.

timestamp

int64

required

≥ 0

Fecha y hora en formato de milisegundos y UTC para identificar las diferentes peiticiones en el tiempo los diferentes que han tenido errores.

Response body

object

requestId

string

required

length ≤ 128

Identificador único del error generado por Zenkipay por cada petición enviada al API.

title

string

required

length ≤ 255

Descripción corta del error.

errorCode

int64

required

0 to 999

category

string

required

Categoría del error ocurrido.

Posibles valores:

FATAL - Cualquier error que fuerce el cierre del servicio o la aplicación para evitar la pérdida de datos (o una mayor pérdida de datos). Se reserva solo para los errores y situaciones más atroces en los que se garantiza que ha habido corrupción o pérdida de datos.
SEVERE - Cualquier error que sea fatal para el servicio, pero no para la aplicación completa (El servicio dejo de responder o no se puede ejecutar una operación). Estos errores forzarán la intervención del usuario (administrador o usuario directo).
ERROR - Cualquier error que sea fatal para la operación, pero no para el servicio o la aplicación (no se puede abrir un archivo requerido, faltan datos, etc.). Estos errores forzarán la intervención del usuario (administrador o usuario directo).
WARN - Cualquier cosa que potencialmente pueda causar rarezas en la aplicación, pero para lo cual me estoy recuperando automáticamente (Como cambiar de un servidor primario a uno de respaldo, volver a intentar una operación, perder datos secundarios, etc.).
INFO - Designa mensajes informativos que resaltan el progreso de la aplicación y posiblemnte hubo algún error menor que afecta muy poco a la experiencia.

FATAL SEVERE ERROR WARN INFO

validationErrors

array of objects | null

Conjunto de validaciones que no pasaron al evaluar la información de la petición.

validationErrors

object

objectName

string

required

length ≤ 255

Nombre del objeto en la estructura de datos donde se origina el error.

field

string

required

length ≤ 255

Campo del objeto donde presenta errores de validación.

message

string

required

length ≤ 255

Descripción del error ocasionado al no pasar alguna validación de la información.

humanMessage

string

required

length ≤ 300

Mensaje de error recomendado para mostrar a los compradores, este mensaje está soportado para los lenguajes de ingles y español.

timestamp

int64

required

≥ 0

Fecha y hora en formato de milisegundos y UTC para identificar las diferentes peiticiones en el tiempo los diferentes que han tenido errores.

Response body

object

requestId

string

required

length ≤ 128

Identificador único del error generado por Zenkipay por cada petición enviada al API.

title

string

required

length ≤ 255

Descripción corta del error.

errorCode

int64

required

0 to 999

category

string

required

Categoría del error ocurrido.

Posibles valores:

FATAL - Cualquier error que fuerce el cierre del servicio o la aplicación para evitar la pérdida de datos (o una mayor pérdida de datos). Se reserva solo para los errores y situaciones más atroces en los que se garantiza que ha habido corrupción o pérdida de datos.
SEVERE - Cualquier error que sea fatal para el servicio, pero no para la aplicación completa (El servicio dejo de responder o no se puede ejecutar una operación). Estos errores forzarán la intervención del usuario (administrador o usuario directo).
ERROR - Cualquier error que sea fatal para la operación, pero no para el servicio o la aplicación (no se puede abrir un archivo requerido, faltan datos, etc.). Estos errores forzarán la intervención del usuario (administrador o usuario directo).
WARN - Cualquier cosa que potencialmente pueda causar rarezas en la aplicación, pero para lo cual me estoy recuperando automáticamente (Como cambiar de un servidor primario a uno de respaldo, volver a intentar una operación, perder datos secundarios, etc.).
INFO - Designa mensajes informativos que resaltan el progreso de la aplicación y posiblemnte hubo algún error menor que afecta muy poco a la experiencia.

FATAL SEVERE ERROR WARN INFO

validationErrors

array of objects | null

Conjunto de validaciones que no pasaron al evaluar la información de la petición.

validationErrors

object

objectName

string

required

length ≤ 255

Nombre del objeto en la estructura de datos donde se origina el error.

field

string

required

length ≤ 255

Campo del objeto donde presenta errores de validación.

message

string

required

length ≤ 255

Descripción del error ocasionado al no pasar alguna validación de la información.

humanMessage

string

required

length ≤ 300

Mensaje de error recomendado para mostrar a los compradores, este mensaje está soportado para los lenguajes de ingles y español.

timestamp

int64

required

≥ 0

Fecha y hora en formato de milisegundos y UTC para identificar las diferentes peiticiones en el tiempo los diferentes que han tenido errores.

Response body

object

requestId

string

required

length ≤ 128

Identificador único del error generado por Zenkipay por cada petición enviada al API.

title

string

required

length ≤ 255

Descripción corta del error.

errorCode

int64

required

0 to 999

category

string

required

Categoría del error ocurrido.

Posibles valores:

FATAL - Cualquier error que fuerce el cierre del servicio o la aplicación para evitar la pérdida de datos (o una mayor pérdida de datos). Se reserva solo para los errores y situaciones más atroces en los que se garantiza que ha habido corrupción o pérdida de datos.
SEVERE - Cualquier error que sea fatal para el servicio, pero no para la aplicación completa (El servicio dejo de responder o no se puede ejecutar una operación). Estos errores forzarán la intervención del usuario (administrador o usuario directo).
ERROR - Cualquier error que sea fatal para la operación, pero no para el servicio o la aplicación (no se puede abrir un archivo requerido, faltan datos, etc.). Estos errores forzarán la intervención del usuario (administrador o usuario directo).
WARN - Cualquier cosa que potencialmente pueda causar rarezas en la aplicación, pero para lo cual me estoy recuperando automáticamente (Como cambiar de un servidor primario a uno de respaldo, volver a intentar una operación, perder datos secundarios, etc.).
INFO - Designa mensajes informativos que resaltan el progreso de la aplicación y posiblemnte hubo algún error menor que afecta muy poco a la experiencia.

FATAL SEVERE ERROR WARN INFO

validationErrors

array of objects | null

Conjunto de validaciones que no pasaron al evaluar la información de la petición.

validationErrors

object

objectName

string

required

length ≤ 255

Nombre del objeto en la estructura de datos donde se origina el error.

field

string

required

length ≤ 255

Campo del objeto donde presenta errores de validación.

message

string

required

length ≤ 255

Descripción del error ocasionado al no pasar alguna validación de la información.

humanMessage

string

required

length ≤ 300

Mensaje de error recomendado para mostrar a los compradores, este mensaje está soportado para los lenguajes de ingles y español.

timestamp

int64

required

≥ 0

Fecha y hora en formato de milisegundos y UTC para identificar las diferentes peiticiones en el tiempo los diferentes que han tenido errores.

Language

Credentials

Bearer

ACCESS_TOKEN


xxxxxxxxxx
1
curl --request PATCH \
2
     --url https://api.zenki.fi/v1/pay/escrow/zenkiOrderId/fulfillments \
3
     --header 'accept: application/hal+json'

Click Try It! to start a request and see the response here! Or choose an example:

application/hal+json

application/json

201Escrow actualizado.

400Parámetro de orden esperado.

403Acceso denegado

404Recurso no encontrado.

406Encabezados no aceptados.

428El nombre del parámetro no puede encontrarse.

500Error interno del servidor.