Api de Devoluciones
El API de Devoluciones permite enviar una o mas transacciones en Estado LIQUIDADO
a devolver. Solo disponible para los métodos: CARD
, YAPE
y CUOTEALO
.
REQUEST
Path
Method: POST
URL: {{base}}/refund
Headers
Campo | Descripcion | Valor Aceptado | Tipo |
---|---|---|---|
| Token de identificación para uso del API creado previamente en API de Seguridad | Bearer <Access Token> |
|
| Versión del API a usar | Cadena alfanumérica:
|
|
| Identificador del PF - uso obligatorio para PF | Cadena alfanumérica |
|
Body
Campo | Descripcion | Valor Aceptado | Tipo | Obligatorio |
---|---|---|---|---|
| Identificador del comercio | Cadena Alfanumérica |
| SI |
| Array que contiene Objetos de transacciones a devolver |
|
| SI |
| Tipo de devolución |
|
| SI |
| Número de pedido de la operación | Cadena numérica mayor o igual de 6 dígitos |
| SI |
| Código alfanumérico de la transacción |
| NO | |
| Monto a devolver en centavos. La separación de decimales se aplicará según la moneda. Ej.: Para S/. 10.50, se debe enviar “1050” |
| SI | |
| Diccionario para enviar campos y valores personalizados como Ej.: external_id:21871054 |
|
| NO |
{
"merchant_code": "41bb301e-3c37-4332-accb-ed5ec19081e4",
"operations": [
{
"type": "TOTAL",
"merchant_operation_number": "239766",
"transaction_id": null,
"refund_amount": "1050",
"additional_fields": {
"canal": "WEB",
"reason": "cliente no reconoció el consumo",
"description": "solicitud por desconocimiento"
}
}
]
}
RESPONSE
Campo | Descripcion | Valor Aceptado | Tipo | Obligatorio |
---|---|---|---|---|
| Indica si el proceso se realizó correctamente |
|
| SI |
| Acción ejecutada. |
|
| SI |
| Identificador del comercio | Cadena Alfanumérica |
| SI |
| Array que contiene Objetos de transacciones a devolver |
|
| SI |
| UUID único de la devolución |
| SI | |
| Estado de la solicitud |
|
| SI |
| Motivo o detalle asociado al estado |
| SI | |
| Número de pedido de la operación | Cadena numérica mayor o igual de 6 dígitos |
| SI |
| Tipo de devolución |
|
| SI |
| Número de pedido de la operación | Cadena numérica mayor o igual de 6 dígitos |
| SI |
| Código alfanumérico de la transacción |
| SI | |
| Monto a devolver en centavos |
| SI | |
| Monto original de la transacción en centavos |
| SI | |
| Código ISO 4217 de la moneda de la transacción. | Cadena numérica |
| SI |
| Diccionario para enviar campos y valores personalizados como Ej.: external_id:21871054 |
|
| NO |
| Objeto relacionado al medio y procesador de pago |
| SI | |
| Nombre del método de Pago |
|
| SI |
| Marca de la tarjeta |
|
| SI |
| Tarjeta enmascarada |
| SI | |
| Array que contiene listado de los estado por la cual pasó la transacción |
|
| SI |
| Estado de la transacción |
|
| SI |
| Objeto que contiene la fecha en la que se realizó el cambio de estado |
|
| SI |
| Fecha en UTC | Cadena alfanumérica |
| SI |
| Fecha en unix time | Cadena alfanumérica |
| SI |
| Objeto que contiene el resultado del flujo ejecutado |
| | SI |
| Código que representa el resultado del flujo ejecutado | Cadena numérica | | SI |
| Objeto que contiene el mensaje resultante del flujo |
| | SI |
| Localidad a nivel de lenguaje para el mensaje del flujo ejecutado | Cadena alfanumérica | | SI |
| Mensaje resultante del flujo ejecutado | Cadena alfanumérica | | SI |
{
"success": "true",
"action": "refund",
"merchant_code": "41bb301e-3c37-4332-accb-ed5ec19081e4",
"operations": [
{
"refund_id": "922178aa-ce4c-4c5f-8190-82fa7e009425",
"state": "REGISTERED",
"refund_reason": "Solicitud recibida y validada",
"type": "TOTAL",
"merchant_operation_number": "239766",
"transaction_id": "bko66gpi8czns4tcde93q96vd",
"refund_amount": "1050",
"transaction_amount": "1050",
"currency": "604",
"payment_method": {
"name": "CARD",
"brand": "VISA",
"masked_pan": "447411******2240"
},
"additional_fields": {
"canal": "WEB",
"reason": "cliente no reconoció el consumo",
"description": "solicitud por desconocimiento"
},
"lifecycle": [
{
"state": "REGISTERED",
"date": {
"utc_time": "2025-05-26T06:06:45",
"unix_time": 1748239605.788
}
}
]
}
],
"meta": {
"status": {
"code": "00",
"message_ilgn": [
{
"locale": "es_PE",
"value": "Se procesó correctamente la petición"
}
]
}
}
}