Api de Consulta Unitaria de Devolución

El API de Consulta Unitaria de Devolución permite consultar una devolución generada anteriormente por el Api de Devoluciones.

REQUEST

Path

Method: GET

URL: {{base}}/refund/{{merchant_code}}/{{merchant_operation_number}}

Campo	Descripcion	Valor Aceptado	Tipo
`merchant_code`	Identificador del comercio	Cadena Alfanumérica	`String`
`merchant_operation_number`	Numero de operación	Cadena Alfanumérica	`String`

Headers

Campo

Descripcion

Valor Aceptado

Tipo

Authorization

Token de identificación para uso del API creado previamente en API de Seguridad

Bearer <Access Token>

String

ALG-API-VERSION

Versión del API a usar

Cadena alfanumérica:

1709847567

String

payment-facilitator-code

Identificador del PF - uso obligatorio para PF

Cadena alfanumérica

String

RESPONSE

El orquestador responderá información detallada de la operación con un listado de las transacciones realizadas bajo esa operación. En caso de consultar una transacción, la respuesta tendrá la misma estructura con la diferencia que en el listado de transacciones solo estará la transacción solicitada.

Campo	Descripcion	Valor Aceptado	Tipo	Obligatorio
`success`	Indica si el proceso se realizó correctamente	Cadena Alfanumérica: true false	`String`	SI
`merchant_code`	Identificador del comercio	Cadena Alfanumérica	`String`	SI
`operations_count`	Cantidad de Operaciones encontradas	Cadena numérica	`String`	SI
`operations`	Array que contiene Objetos de transacciones a devolver		`Array`	SI
`operations.[].refund_id`	UUID único de la devolución		`String`	SI
`operations.[].state`	Estado de la solicitud	REGISTERED IN_PROCESS RESOLVED REJECTED	`String`	SI
`operations.[].refund_reason`	Motivo o detalle asociado al estado		`String`	SI
`operations.[].merchant_operation_number`	Número de pedido de la operación	Cadena numérica mayor o igual de 6 dígitos	`String`	SI
`operations.[].type`	Tipo de devolución	TOTAL PARTIAL	`String`	SI
`operations.[].merchant_operation_number`	Número de pedido de la operación	Cadena numérica mayor o igual de 6 dígitos	`String`	SI
`operations.[].transaction_id`	Código alfanumérico de la transacción		`String`	SI
`operations.[].refund_amount`	Monto a devolver en centavos		`String`	SI
`operations.[].transaction_amount`	Monto original de la transacción en centavos		`String`	SI
`operations.[].currency`	Código ISO 4217 de la moneda de la transacción.	Cadena numérica	`String`	SI
`operations.[].additional_fields`	Diccionario para enviar campos y valores personalizados como `key:value` Ej.: external_id:21871054	`key:value`	`Dictionary`	NO
`operations.[].payment_method`	Objeto relacionado al medio y procesador de pago		`Object`	SI
`operations.[].payment_method.[].name`	Nombre del método de Pago	CARD YAPE CUOTEALO	`String`	SI
`operations.[].payment_method.[].brand`	Marca de la tarjeta.	VISA MSCD AMEX DINC	`String`	SI
`operations.[].payment_method.[].masked_pan`	Tarjeta enmascarada		`String`	SI
`operations.[].lifecycle`	Array que contiene listado de los estado por la cual pasó la transacción		`Array`	SI
`operations.[].lifecycle.[].state`	Estado de la transacción	REGISTERED IN_PROCESS RESOLVED REJECTED	`String`	SI
`operations.[].lifecycle.[].date`	Objeto que contiene la fecha en la que se realizó el cambio de estado		`Object`	SI
`operation.[].lifecycle.[].date.utc_time`	Fecha en UTC	Cadena alfanumérica	`String`	SI
`operation.[].lifecycle.[].date.unix_time`	Fecha en unix time	Cadena alfanumérica	`Integer`	SI
`meta`	Objeto que contiene metadados del flujo ejecutado		`Object`	SI
`meta.status`	Objeto que contiene el resultado del flujo ejecutado		`Object`	SI
`meta.status.code`	Código que representa el resultado del flujo ejecutado	Cadena numérica	`String`	SI
`meta.status.message_ilgn`	Objeto que contiene el mensaje resultante del flujo		`Object`	SI
`meta.status.message_ilgn.[].locale`	Localidad a nivel de lenguaje para el mensaje del flujo ejecutado	Cadena alfanumérica	`String`	SI
`meta.status.message_ilgn.[].value`	Mensaje resultante del flujo ejecutado	Cadena alfanumérica	`String`	SI

JSON

{
    "success": "true",
    "merchant_code": "41bb301e-3c37-4332-accb-ed5ec19081e4",
    "operations_count": "1",
    "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"
                }
            ]
        }
    }
}