API Reference

Registro de orden para pago

post
https://api.zenki.fi/v1/pay/orders

Servicio que permite registrar una orden de pago y asociarla a un comercio.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Se mandará una estructura JSON que tendrá la información requerida para crear una orden.

Objeto utilizado con la información requerida para crear una orden.

string
required
length ≤ 9

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

string | null

Identificador único de la orden generado por el comercio. Para tener una trazabilidad correcta y métricas de conversion adecuadas es requerido mandar el campo de OrderId o el Campo CardId.

string | null

Identificador único del carrito de compra que permite identificar la compra de uno o varios productos o servicios. Para tener una trazabilidad correcta y métricas de conversion adecuadas es requerido mandar el campo de OrderId o el Campo CardId.

string
enum
required

Indica el modelo para la entrega del producto o servicio.

Posibles valores:

  • WITH_CARRIER - Si se va a utilizar una mensajería para el envío y entrega del producto o servicio.
  • WITHOUT_CARRIER - Si no se va a utilizar una mensajería para el envío y entrega del producto o servicio.
  • MIXED - Si se va a utilizar una mensajería para el envío de una parte de los productos o servicios y otra parte se entregara sin utilizar una mensajería de envío.
Allowed:
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

shopper
object | null

Información del comprador.

breakdown
object
required

Resumen de los montos del carrito de compra.

items
array of objects
required

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

items*

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

Headers
string

Identificador único del cliente utilizado para establecer la coenxión con los servicios de Zenkipay.

string

Indica el tipo código de lenguaje para qu el contenido de la respuesta de los servicios se regresen de acuerdo al lenguaje informado.

Se utiliza la definición del estándar ISO_639 Véase: https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes o https://www.iso.org/iso-639-language-codes.html

string
required

Tipo de contenido aceptado.

string
required

Formatos aceptados.

Responses

Updated over 2 years ago

Language
Credentials
Bearer
ACCESS_TOKEN
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/hal+json
application/json

Updated over 2 years ago