Reembolso
La transacción de reembolso en nuestra pasarela de pagos es una función para recibir y procesar datos necesarios para llevar a cabo el reembolso, ya sea parcial o completo, de un pago previamente realizado. A continuación, se presenta una descripción detallada de este endpoint y cómo se utiliza para gestionar reembolsos de manera efectiva.
Notas importantes
- El período en que se permiten los reembolsos varía según los emisores y puede estar sujeto a límites de tiempo específicos.
- Se pueden aplicar varios reembolsos al mismo pago, pero no deben superar el monto total del pago original.
Este endpoint recibe los datos de la transacción de reembolso y devuelve el resultado.
Method: post
URL: http://{environment-domain}/api/v1/refund
Encabezados HTTP: Content-Type: application/json
Agregar encabezados de autenticación
Ejemplo:
{
"id": "5c51bebd-5b21-4ef3-b980-d41eb0b83568",
"merchantId": "3ae25846-d5fe-40cc-a311-eb2de5174c29",
"terminalId": "3ae25846-d5fe-40cc-a311-eb2de5174c29",
"order": {
"merchantOrderId": "9a6ecf36-8265-11ee-b962-0242ac120002",
"amount": "100.00",
"currency": "484"
}
}
Descripción de campos
Campo | Descripción |
---|---|
id | Id único de la transacción asignado por la pasarela de pagos. |
merchantId | Identificador único del comerciante en la pasarela de pago, es asignado al momento de crear |
terminalId | Identificador único de la terminal, es asignado al momento de crear la cuenta. |
order | Contiene detalles sobre la orden de compra. |
merchantOrderId | Identificador único de la orden asignado por el comercio. |
amount | Monto total del reembolso. |
currency | Código de moneda según el estándar ISO 4217. |
Ejemplo de respuesta exitosa
Http code 200
{
"id": "63fa692e-66fe-47a0-acdd-50c13970d4f3",
"order": {
"id": "9a6ecf36-8265-11ee-b962-0242ac120002",
"amount": "100.00",
"currency": "484"
},
"payload": {
"paymentId": "4d0cbd45-bc39-4d17-96ef-34affa296bde",
"responseCode": "00",
"responseDescription": "Approved or completed successfully (if balances are available)",
"authorizationNumber": "280188",
"referenceNumber": "000027389440",
"status": "refund"
},
"isApproved": true,
"isFailure": false,
"errors": null
}
Descripción de campos
Campo | Descripción |
---|---|
id | Id único de la transacción asignado por la pasarela de pagos. |
order | Contiene detalles sobre la orden de compra. |
merchantOrderId | Identificador único de la orden asignado por el comercio. |
amount | Monto total de la orden. |
currency | Código de moneda según el estándar ISO 4217. |
payload | Contiene información detallada sobre la transacción. |
paymentId | Identificador único de la transacción de pago. |
responseCode | Código de respuesta que indica el resultado de la transacción (en este caso, "00" indica aprobación). |
responseDescription | Descripción asociada al código de respuesta. |
authorizationNumber | Número de autorización de la transacción. |
referenceNumber | Número de referencia asociado a la transacción. |
status | Estado de la transacción, en este caso, "refund" indica que la transacción ha sido completada con éxito. |
isApproved | Indica si la transacción fue aprobada. En este ejemplo, es “true”, lo que significa que la transacción fue aprobada. |
isFailure | Indica si la transacción ha fallado. En este ejemplo, es “false”, indicando que la transacción no ha fallado. |
errors | Contiene detalles como número de error y una descripción, si los hubiera. En este caso, es “null”, lo que significa que no se han producido errores en la transacción. |
Updated 3 months ago