Registro de rembolsos para una orden

Response body

object

zenkiRefundId

string

required

length ≤ 128

Identificador único del reembolso generado por Zenkipay.

reason

string

required

length ≤ 100

Motivo o razón del reembolso.

fiatOriginalPayment

object

Detalle del pago original realizado por el comprador.

amount

double

required

≥ 0

Monto del reembolso, parcial o total.

currencyCodeIso3

string

length ≤ 5

Identificador ú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

cryptoPayment

object

required

Resumen del monto pagado en crypto moenda por el comprador.

amount

string

required

length ≤ 64

Monto del pago en cripto moneda.

currency

string

required

length ≤ 5

Código de la cripto moneda soportadas por Zenkipay, véase: https://developer.zenki.fi/global-v1/docs/zenkipay-recursos-catalogos-criptomonedas-soportadas

blockchain

string

required

length ≤ 30

Listado de blockchains soportadas.

Posibles valores:

Bitcoin
Ethereum
Litecoin
Bitcoin Cash
Solana
Algorand
Polygon
Arbitrum
BSC
Avalanche
Ripple
Terra
Cardano
Polkadot
Tron
Stellar
Ethereum Classic
Hedera Hashgraph
Tezos
EOSIO
Fantom Opera
ZCash
Celo
Dash
XDC Network

transactionHash

string | null

Identificador único de la transacción, proprocionado por la blockchain.

networkScanUrl

string | null

URL para consultar el estado de la transacción directamente en la blockchain.

transactionStatus

string

Estado de la transacción de pago en la red de blockchain.

Posibles valores:

CONFIRMING - Pendiente de confirmación en la cadena de bloques (blockchain)
PARTIALLY_COMPLETED - Uno o más de los registros de transacciones se completaron con éxito (Solo para transacciones agregadas).
COMPLETED - Completado con éxito
CANCELLED - La transacción fue cancelada por el staff de Zenkipay o por el servicio de terceros.
REJECTED - La transacción fue rechazada por el servicio de terceros.
BLOCKED - La transacción fue bloqueada debido a una regla de política de autorización de transacciones.
FAILED - La transacción ha fallado.

CONFIRMING PARTIALLY_COMPLETED COMPLETED CANCELLED REJECTED BLOCKED FAILED

status

string

required

Estado del reembolso

Posibles valores:

PENDING - En espera a que se aplique el reemboslo.
AWAITING_REFUND - Se ha recibido una primera confirmación por la red de blockchain, está en la espera de tener las confirmaciones requeridas.
REFUNDED - Se ha realizado el reembolso del producto o servicio al comprador.
FAILED - Ha surgido un problema al momento de realizar el reembolso.

PENDING AWAITING_REFUND REFUNDED FAILED

placedAt

int64

required

≥ 0

Fecha y hora cuando el comercio mando el reembolso a Zenkipay, 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)

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.

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)

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.

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)

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.

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)

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.

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)

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.

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)

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.

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)

201Reembolso generado

400Parámetro de reembolso esperado

403Acceso denegado

404Recurso no encontrado

406Encabezados no aceptados

428El nombre del parámetro no puede encontrarse

500Error interno del servidor