Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.pay-me.com/llms.txt

Use this file to discover all available pages before exploring further.

El API de Consulta Unitaria de Devolución permite consultar una devolución generada anteriormente por el API de Devoluciones.
​
GET /refund/{merchant_code}/{merchant_operation_number}
endpoint

Pre-Producción

https://api.preprod.alignet.io/refund/{merchant_code}/{merchant_operation_number}

Producción

https://api.alignet.io/refund/{merchant_code}/{merchant_operation_number}
Esta consulta devuelve el detalle de las devoluciones asociadas a una operación del comercio. El resultado incluye operations_count, el listado encontrado y el lifecycle de cada devolución.

​
Request

​
Path

CampoDescripciónTipo
merchant_codeIdentificador del comercioString
merchant_operation_numberNúmero de operaciónString

​
Headers

CampoDescripciónValorTipoObligatorio
AuthorizationToken de identificación para uso del API creado previamente en API de SeguridadBearer <Access Token>StringSI
ALG-API-VERSIONVersión del API a usar1709847567StringSI
payment-facilitator-codeIdentificador del PF, obligatorio para Payment FacilitatorCadena alfanuméricaStringNO

​
Response

CampoDescripciónEjemploTipoObligatorio
successIndica si el proceso se realizó correctamentetrue, falseStringSI
merchant_codeIdentificador del comercio41bb301e-3c37-4332-accb-ed5ec19081e4StringSI
operations_countCantidad de operaciones encontradas1StringSI
operationsArray que contiene objetos de transacciones a devolverArrayArraySI
operations[].refund_idUUID único de la devoluciónUUIDStringSI
operations[].stateEstado de la solicitudREGISTERED, IN_PROCESS, RESOLVED, REJECTEDStringSI
operations[].refund_reasonMotivo o detalle asociado al estadoSolicitud recibida y validadaStringSI
operations[].merchant_operation_numberNúmero de pedido de la operación239766StringSI
operations[].typeTipo de devoluciónTOTAL, PARTIALStringSI
operations[].transaction_idCódigo alfanumérico de la transacciónbko66gpi8czns4tcde93q96vdStringSI
operations[].refund_amountMonto a devolver en centavos1050StringSI
operations[].transaction_amountMonto original de la transacción en centavos1050StringSI
operations[].currencyCódigo ISO 4217 de la moneda de la transacción604StringSI
operations[].additional_fieldsDiccionario para enviar campos y valores personalizados como key:valueDictionaryDictionaryNO
operations[].payment_methodObjeto relacionado al medio y procesador de pagoObjectObjectSI
operations[].payment_method.nameNombre del método de pagoCARD, YAPE, CUOTEALOStringSI
operations[].payment_method.brandMarca de la tarjetaVISA, MSCD, AMEX, DINCStringSI
operations[].payment_method.masked_panTarjeta enmascarada447411******2240StringSI
operations[].lifecycleArray que contiene listado de los estados por los que pasó la devoluciónArrayArraySI
operations[].lifecycle[].stateEstado de la devoluciónREGISTERED, IN_PROCESS, RESOLVED, REJECTEDStringSI
operations[].lifecycle[].dateObjeto que contiene la fecha en la que se realizó el cambio de estadoObjectObjectSI
operations[].lifecycle[].date.utc_timeFecha en UTC2025-05-26T06:06:45StringSI
operations[].lifecycle[].date.unix_timeFecha en unix time1748239605IntegerSI
metaObjeto que contiene metadatos del flujo ejecutadoObjectObjectSI
meta.statusObjeto que contiene el resultado del flujo ejecutadoObjectObjectSI
meta.status.codeCódigo que representa el resultado del flujo ejecutado00StringSI
meta.status.message_ilgnObjeto que contiene el mensaje resultante del flujoObjectObjectSI
meta.status.message_ilgn[].localeLocalidad a nivel de lenguaje para el mensaje del flujo ejecutadoes_PEStringSI
meta.status.message_ilgn[].valueMensaje resultante del flujo ejecutadoSe procesó correctamente la peticiónStringSI

​
Ejemplo (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
          }
        }
      ]
    }
  ],
  "meta": {
    "status": {
      "code": "00",
      "message_ilgn": [
        {
          "locale": "es_PE",
          "value": "Se procesó correctamente la petición"
        }
      ]
    }
  }
}

​
Siguiente paso

API de Devoluciones

Usa el POST /refund para registrar nuevas solicitudes de devolución.

Devoluciones

Vuelve al overview del módulo para revisar el resto de APIs del flujo.