Servicio que realiza el cierre de un check-in realizado por medio de tarjeta presente.
Tipo de petición: POST
Ruta de petición: https://api.pagandocheck.com/v1/pagando/orders/checkout-order
Headers: Autorization: Bearer <token provisto>
Parámetros
Campo | Tipo | Descripción | Requerido |
---|---|---|---|
amount | String | Total por el cual se realizara el cierre del check-in | true |
reference | String | Folio de la transacción otorgado por la terminal para realizar el cierre de check-in | true |
Ejemplo de parámetros.
{
"amount": "200.11",
"reference": "PAG-000000011492"
}
Ejemplo de respuesta
Todas las respuestas de API se encuentran homologadas para asegurar consistencia con el cliente, puedes conocer más a fondo esto en el glosario de respuestas.
Así mismo, los campos generales type
, key
, message
, code
vienen explicados en ese mismo glosario.
Respuesta exitosa
{
"type": "API_ORDERS",
"key": "SUCCESS_REQUEST",
"message": "The request ended successfully.",
"code": 72,
"data": {
"reference": "PAG-000000011820",
}
}
Explicación de campos (Data)
Campo | Explicación |
reference | Folio de seguimiento de la transacción |
Respuesta con error
{
"type": "AGREGADOR_SWITCH",
"key": "SWITCH_4025",
"message": "Ya existe una orden de checkout para el check-in",
"code": "4025",
"data": null,
"error": true
}
Posibles códigos de respuesta
Código | Mensaje | Explicación |
---|---|---|
72 | The order has been successfully completed | Cierre de check-in correcto |
300 | No payment settings found, please check your public key | El sistema de pagos en producción no ha sido liberado completamente, por favor contacta a soporte |
302 | An error occurred and the payment could not be processed. Please try again later | Puede darse por la falta de configuración de un elemento para el procesamiento de pagos o por una configuración errónea, por favor contacta a soporte |
314 | The order number has not been specified | No se recibió el parámetro de orderNumber en la petición |
315 | There is no order for the number provided | No se encontró información de la orden en los registros del sistema |
323 | A checkout already exists for this order | Actualmente ya existe un checkout para la orden realizada |
4010 | El total de la transacción debe de ser igual o menor a la transacción original | Se intento realizar el cierre del check-in por un valor no válido |
4020 | El parámetro amount debe de ser menor que el monto de la transacción original más el 20% | Se intento realizar |
4025 | Ya existe una orden de check-out para el check-in | Ya existe una orden pendiente de confirmar para el check-in, por favor contacta a soporte |