Información del comercio

Response body

object

merchantInfo

object

required

Información general del comercio.

commercialName

string

required

length ≤ 300

Nombre comercial del comercio que registro cuando se creo su cuenta en Zenki.

legalName

string

length ≤ 300

Nombre legal del comercio que registro durante el proceso de activación de cuenta en Zenki.

accountType

string

required

Tipo de cuenta del comercio.

Posibles valores:

PERSONAL - Persona natural física con actividad comercial.
ENTITY - Empresa con actividad comercial.

PERSONAL ENTITY

kycStatus

string

required

Estado del proceso documental en el que se encuentra el comercio.

Posibles valores:

PENDING - Indica que aún falta por enviar información o documentos para concluir su proceso de KYC.
APPROVED - Se ha finalizado el proceso de registro documental y el staff de Zenki ha autorizado al comercio para operar.
REQUEST_INFO - El Staff de Zenki solicitó más información o cambio en documentos del comercio.
REJECTED - El Staff de Zenki rechazó definitivamente la solicitud del comercio.

PENDING APPROVED REQUEST_INFO REJECTED

integrationStatus

string

required

Estado del proceso de integración en el que se encuentra el comercio.

Posibles valores:

PENDING - Indica que el comercio aún no ha concluido su proceso de integración técnica y aún no está en ambiente productivo.
COMPLETED - Indica que el comercio ha concluido su proceso de integración técnica y ya se encuentra en producción o live.

PENDING COMPLETED

operationMode

string

Esquema en el que el comercio recibirá el importe de sus ventas cuando el comercio realice un retiro.

Posibles valores:

FIAT - En este esquema, el comercio recibirá el retiro de sus fondos en la moneda local de su país.
CRYPTO - En este esquema, el comercio recibirá el retiro de sus fondos en moneda estable o criptomoneda.

FIAT CRYPTO

integrationConfig

object

required

Configuraciones de las integraciones del comercio.

plugins

array of objects

required

Configuración de cada plugin activa del comercio.

plugins*

object

name

string

required

Nombre del plugin activo.

Posibles valores:

SCRIPT - Integración mediante API de Zenkipay.
WOOCOMMERCE - Integración mediante el plugin de WooCommerce.
BIGCOMMERCE - Integración mediante el plugin de BigCommerce.
MAGENTO - Integración mediante el plugin de Magento.
ECWID - Integración mediante el plugin de ECWID.
SHOPIFY - Integración mediante el plugin de Shopify.
VTEX - Integración mediante el plugin de VTEX.
ANGULAR - Integración mediante de la librería Front-End de Angular.
REACT - Integración mediante de la librería Front-End de React.
VUEJS - Integración mediante de la librería Front-End de VUE JS.
PRESTASHOP - Integración mediante el plugin de Prestashop.

SCRIPT WOOCOMMERCE BIGCOMMERCE MAGENTO ECWID SHOPIFY VTEX ANGULAR REACT VUEJS PRESTASHOP

clientId

string

required

length ≤ 128

Key del plugin activo.

cryptoLovePercentage

double

required

0 to 100

Descuento en porcentaje otorgado por el comercio al comprador en su compra por activar crypto love.

cryptoAssets

array of objects

Listado de cripto monedas soportadas.

cryptoAssets

object

currency

string

required

length ≤ 64

Idnetificador de la moneda soportada, véase https://developer.zenki.fi/global-v1/docs/zenkipay-recursos-catalogos-criptomonedas-soportadas

blockchain

string

length ≤ 64

Identificador de la blockchain soportada, véase https://support.zenki.fi/developer-center/docs/es/blockchains-soportadas

active

boolean

required

Indica si la cripto moenda esta activa o no.

escrowConfig

object

required

Resumen del monto pagado en crypto moenda por el comprador.

orderType

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.
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

shopperNotification

int64

≥ 0

Número de horas de espera para que el comercio notifique a Zenki que ha entregado los servicios al comprador. El tiempo está expresado en horas.

timeWaitToApproval

int64

≥ 0

Cantidad de horas que se va a esperar Zenki para tener confirmación por parte del comprador antes de aprovar el pago y liberar los fondos al comercio. El tiempo está expresado en horas.

fiatAssets

array of objects

Listado de monedas soportadas.

fiatAssets

object

currency

string

required

length ≤ 64

Código único de la moneda del país que se informa en la orden, 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

active

boolean

required

Indica si la moenda esta activa o no.

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)

200Obtiene información del comercio

400Parámetro de comercio esperado

403Acceso denegado

404Recurso no encontrado

406Encabezados no aceptados

428El nombre del parámetro no puede encontrarse

500Error interno del servidor