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.

Usa esta consulta para validar el estado de cobros con Yape cuando necesitas respaldo adicional, conciliación o confirmación final desde backend.
​
GET /charges/{merchant_code}/{merchant_operation_number}/{transaction_id}
endpoint
Este flujo usa la misma estructura general documentada en el Overview de Consulta. Aquí se detalla específicamente el objeto operation.transactions[] para pagos con Yape.

​
¿Cuándo usarla?

Conciliación

Cuando necesitas contrastar el estado del pago con tu sistema o con el resultado registrado por tu backend.

Segunda validación

Cuando debes confirmar desde backend si el cobro con Yape terminó autorizado, denegado, extornado o liquidado.

Soporte operativo

Cuando requieres revisar una operación reportada por el comercio o por el usuario final.

Checkout Web (Flex)

Si integras Flex, úsala como validación final del resultado antes de marcar la orden como pagada.

​
Consideraciones

Conserva merchant_code, merchant_operation_number y transaction_id desde la autorización para consultar sin ambigüedad.
En esta documentación se usa method_details para mantener consistencia con el resto de la referencia. Si en material previo encuentras method_detail, trátalo como el mismo objeto.

​
Response

Objeto operation.transactions[] para pagos con Yape dentro de la trama de respuesta del API de Consulta.

​
Objeto operation.transactions[]

CampoDescripciónTipoObligatorio
operation.transactions[].transaction_idIdentificador único de la transacción.StringSI
operation.transactions[].channelCanal por el cual se realizó la transacción. Valor esperado: ecommerce.StringSI
operation.transactions[].stateEstado actual de la transacción. Valores frecuentes: PENDIENTE, INVALIDO, AUTORIZADO, DENEGADO, EXTORNADO, LIQUIDADO.StringSI
operation.transactions[].state_reasonObservación o detalle del estado.StringSI
operation.transactions[].amountMonto de la transacción.StringSI
operation.transactions[].currencyCódigo de la moneda de la operación.StringSI
operation.transactions[].payment_methodObjeto que contiene información sobre el método de pago usado en la transacción.ObjectSI
operation.transactions[].payment_method.method_nameNombre del método de pago usado en la transacción. Valor esperado: YAPE.StringSI
operation.transactions[].payment_method.method_detailsObjeto que contiene información detallada relacionada al método.ObjectSI
operation.transactions[].processor_responseVisible normalmente en estados AUTORIZADO, DENEGADO o EXTORNADO. Objeto que contiene el resultado de la autorización.ObjectNO
operation.transactions[].additional_fieldsObjeto que contiene los datos adicionales de la transacción enviados en el request.ObjectNO
operation.transactions[].lifecycleArray que contiene el listado de estados por los cuales pasó la transacción.ArraySI

​
Objeto operation.transactions[].payment_method.method_details

CampoDescripciónTipoObligatorio
operation.transactions[].payment_method.method_details.phoneObjeto phone que contiene la información del número telefónico usado para realizar el Yape.ObjectSI
operation.transactions[].payment_method.method_details.masked_panTarjeta enmascarada usada en la transacción.StringSI
operation.transactions[].payment_method.method_details.brandMarca de la tarjeta usada en la transacción.StringSI
operation.transactions[].payment_method.method_details.binBIN de la tarjeta usada en la transacción.StringSI
operation.transactions[].payment_method.method_details.last_panÚltimos 4 dígitos de la tarjeta usada en la transacción.StringSI
operation.transactions[].payment_method.method_details.card_typeTipo de tarjeta.StringSI
operation.transactions[].payment_method.method_details.card_countryPaís de la tarjeta.StringSI
operation.transactions[].payment_method.method_details.issuerBanco emisor de la tarjeta.StringSI
operation.transactions[].payment_method.method_details.callback_urlURL del callback enviado en el request.StringNO

​
Objeto operation.transactions[].payment_method.method_details.phone

CampoDescripciónTipoObligatorio
operation.transactions[].payment_method.method_details.phone.country_codeCódigo del país.StringSI
operation.transactions[].payment_method.method_details.phone.subscriberNúmero celular.StringSI

​
Objeto operation.transactions[].processor_response

CampoDescripciónTipoObligatorio
operation.transactions[].processor_response.authorization_codeCódigo de autorización.StringNO
operation.transactions[].processor_response.brand_transaction_idID de la transacción ante la marca.StringNO
operation.transactions[].processor_response.result_messageObjeto que contiene el mensaje del resultado de la autorización.ObjectNO

​
Objeto operation.transactions[].processor_response.result_message

CampoDescripciónTipoObligatorio
operation.transactions[].processor_response.result_message.codeCódigo del resultado de la autorización.StringNO
operation.transactions[].processor_response.result_message.descriptionDescripción del resultado de la autorización.StringNO

​
Objeto operation.transactions[].lifecycle

CampoDescripciónTipoObligatorio
operation.transactions[].lifecycle[].stateEstado de la transacción. Valores frecuentes: REGISTRADO, PENDIENTE, INVALIDO, AUTORIZADO, DENEGADO, EXTORNADO, LIQUIDADO.StringSI
operation.transactions[].lifecycle[].dateObjeto que contiene la fecha en la que se realizó el cambio de estado.ObjectSI

​
Objeto operation.transactions[].lifecycle[].date

CampoDescripciónTipoObligatorio
operation.transactions[].lifecycle[].date.utc_timeFecha en UTC.StringSI
operation.transactions[].lifecycle[].date.unix_timeFecha en Unix time.IntegerSI

​
Ejemplo

Response de consulta de Yape. 
{
  "success": true,
  "merchant_code": "abc",
  "operation": {
    "merchant_operation_number": "2391645",
    "state": "AUTORIZADO",
    "amount": "15000",
    "currency": "604",
    "transactions": [
      {
        "transaction_id": "5hk8rwa3h3cq9oyfs3a28v1ms",
        "channel": "ecommerce",
        "state": "AUTORIZADO",
        "state_reason": "Approval and completed successfully",
        "amount": "15000",
        "currency": "604",
        "payment_method": {
          "method_name": "YAPE",
          "method_details": {
            "phone": {
              "country_code": "+51",
              "subscriber": "969929157"
            },
            "masked_pan": "455788******9268",
            "brand": "VISA",
            "bin": "455788",
            "last_pan": "9268",
            "card_type": "DEBIT",
            "card_country": "PE",
            "issuer": "BANCO DE CREDITO DEL PERU - BCP",
            "callback_url": "https://pay-me.com/callback"
          }
        },
        "processor_response": {
          "authorization_code": "055552",
          "brand_transaction_id": "A055552",
          "result_message": {
            "code": "00",
            "description": "Approval and completed successfully"
          }
        },
        "lifecycle": [
          {
            "state": "REGISTRADO",
            "date": {
              "utc_time": "2024-03-12T22:49:36.018Z",
              "unix_time": 1710282940
            }
          },
          {
            "state": "PENDIENTE",
            "date": {
              "utc_time": "2024-03-12T22:49:36.018Z",
              "unix_time": 1710282940
            }
          },
          {
            "state": "AUTORIZADO",
            "date": {
              "utc_time": "2024-03-12T22:49:36.018Z",
              "unix_time": 1710282940
            }
          }
        ]
      }
    ]
  },
  "meta": {
    "status": {
      "code": "00",
      "message_ilgn": [
        {
          "locale": "es_PE",
          "value": "Se proceso correctamente"
        }
      ]
    }
  }
}

​
Siguiente paso

API de Cancelación

Si la operación aún lo permite, revisa el flujo de cancelación.