Devolución de una compra posterior a su realización.
Tipo de petición: POST
Ruta de petición: https://api.pagandocheck.com/v1/pagando/orders/refund-order
Headers: Autorization: Bearer <token provisto>
Parámetros
| Campo | Tipo | Descripción | Requerido |
|---|---|---|---|
userId | String | Identificador del cliente al que pertenece la tarjeta | true |
cardId | String | Identificador de la tarjeta que realizó la compra previa | true |
orderNumber | String | Número de orden a devolver otorgado en el procesamiento de pagos | true |
amount | String | Monto por el que se realizara la devolución, no puede exceder el monto total de la transacción a realizar la devolución | true |
Ejemplo de parámetros
{
"userId": "e13452da-847d-4281-ae3a-96cb8e6d35c5",
"cardId": "cd_7xszhkl2h-x758fj",
"orderNumber": "171",
"amount": "100"
}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_ORDER_REFUND",
"message": "The order has been successfully cancelled.",
"code": 69,
"data": {
"transactionNumber": 31859,
"reference": "PAG-000000011789",
"orderNumber": 5978
}
}Explicación de campos
| Campo | Explicación |
transactionNumber | Identificador de transacción para seguimiento interno |
reference | Folio de seguimiento de la transacción |
orderNumber | Número de orden que puede ser encontrada en el panel de transacciones |
Respuesta con error
{
"type": "API_ORDERS",
"key": "ALREADY_REFUNDED",
"message": "A refund already exists for this order",
"code": 316,
"data": null,
"error": true
}Posibles códigos de respuesta
| Código | Mensaje | Explicación |
|---|---|---|
69 | The order has been successfully completed | Procesamiento de transacción correcta |
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 |
301 | The payment method associated with the provided user was not found | No se recibió el identificador de tarjeta en la petición de pago |
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 erronea, 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 |
316 | A refund already exists for this order | La orden ya fue previamente devuelta o cancelada |
317 | The amount to refund must be a positive number | El parámetro de amount no fue proporcionado o no es válido. El monto debe ser mayor a cero |
318 | The amount to refund exceeds the order’s amount | El parámetro de amount proporcionado no debe sobrepasar el monto de la orden |
321 | An error occurred and the refund could not be processed. Please try again later | Error interno de sistema al hacer la devolución o cancelación, revisar información adicional para comunicarse con un asesor |
