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 una transacción con tarjeta, realizar conciliación o confirmar el resultado 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 tarjeta.

​
¿Cuándo usarla?

Conciliación

Cuando necesitas validar el resultado almacenado en tu sistema con el estado real de la transacción.

Segunda validación

Cuando debes confirmar desde backend si el pago con tarjeta terminó autorizado, pendiente, denegado o expirado.

Flujos con redirect

Cuando la tarjeta requiere autenticación 3DS Redirect y necesitas consultar continue_url, expiración o el resultado posterior.

Checkout Web (Flex)

Si integras Flex, usa esta consulta como validación final antes de cerrar la orden, no solo el resultado mostrado en frontend.

​
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 tarjeta 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, CANCELADO, EXPIRADO, 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 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. En este flujo el método es CARD.ObjectSI
operation.transactions[].payment_method.method_nameNombre del método de pago usado en la transacción.StringSI
operation.transactions[].payment_method.method_detailsObjeto que contiene información detallada relacionada al método.ObjectNO
operation.transactions[].continue_urlVisible en estado PENDIENTE. URL para continuar el proceso de pago cuando el método CARD requiere autenticación.StringNO
operation.transactions[].expiration_dateVisible en estado PENDIENTE. Objeto que contiene la fecha en la que expirará la transacción.ObjectNO
operation.transactions[].processor_responseVisible normalmente en estados AUTORIZADO, DENEGADO o EXTORNADO. Objeto con el resultado de autorización devuelto por la procesadora.ObjectNO
operation.transactions[].authentication_resultObjeto que contiene el resultado de la autenticación usada en la transacción.ObjectNO
operation.transactions[].risk_evaluationObjeto que contiene el resultado de la evaluación de antifraude.ObjectNO
operation.transactions[].additional_fieldsObjeto que contiene los datos adicionales enviados en el request de autorización.ObjectNO
operation.transactions[].lifecycleArray que contiene el listado de estados por los que pasó la transacción.ArraySI

​
Objeto operation.transactions[].payment_method.method_details

CampoDescripciónTipoObligatorio
operation.transactions[].payment_method.method_details.masked_panTarjeta enmascarada usada en la transacción.StringNO
operation.transactions[].payment_method.method_details.brandMarca de la tarjeta usada en la transacción.StringNO
operation.transactions[].payment_method.method_details.binBIN de la tarjeta usada en la transacción.StringNO
operation.transactions[].payment_method.method_details.last_panÚltimos 4 dígitos de la tarjeta usada en la transacción.StringNO
operation.transactions[].payment_method.method_details.card_typeTipo de tarjeta.StringNO
operation.transactions[].payment_method.method_details.card_countryPaís de la tarjeta.StringNO
operation.transactions[].payment_method.method_details.issuerBanco emisor de la tarjeta.StringNO
operation.transactions[].payment_method.method_details.installmentsObjeto que contiene información de planes y cuotas usadas en la transacción.ObjectNO
operation.transactions[].payment_method.method_details.redirect_urlVisible cuando aplica redirect. URL enviada en el request de autorización.StringNO
operation.transactions[].payment_method.method_details.callback_urlURL de callback enviada en el request de autorización.StringNO

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

CampoDescripciónTipoObligatorio
operation.transactions[].payment_method.method_details.installments.planPlan de cuotas. Valores frecuentes: NORMAL, DIFERIDO.StringNO
operation.transactions[].payment_method.method_details.installments.installment_numberNúmero de cuotas.StringNO

​
Objeto operation.transactions[].expiration_date

CampoDescripciónTipoObligatorio
operation.transactions[].expiration_date.utc_timeFecha en UTC.StringNO
operation.transactions[].expiration_date.unix_timeFecha en Unix time.IntegerNO

​
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[].authentication_result

CampoDescripciónTipoObligatorio
operation.transactions[].authentication_result.versionVersión del protocolo de autenticación.StringNO
operation.transactions[].authentication_result.eciECI.StringNO
operation.transactions[].authentication_result.vciVCI.StringNO
operation.transactions[].authentication_result.ds_transaction_idDS Transaction ID.StringNO
operation.transactions[].authentication_result.3ds_transaction_id3DS Server Transaction ID.StringNO

​
Objeto operation.transactions[].lifecycle

CampoDescripciónTipoObligatorio
operation.transactions[].lifecycle[].stateEstado de la transacción. Valores frecuentes: REGISTRADO, PENDIENTE, INVALIDO, AUTORIZADO, DENEGADO, CANCELADO, EXPIRADO, 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 1: sin autenticación

Response de consulta de tarjeta sin autenticación. 
{
  "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": "CARD",
          "method_details": {
            "masked_pan": "455788******9268",
            "brand": "VISA",
            "bin": "455788",
            "last_pan": "9268",
            "card_type": "DEBIT",
            "card_country": "PE",
            "issuer": "BANCO DE CREDITO DEL PERU - BCP",
            "installments": {
              "plan": "NORMAL",
              "installment_number": "2"
            },
            "redirect_url": "https://pay-me.com",
            "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"
        }
      ]
    }
  }
}

​
Ejemplo 2: con autenticación Redirect

Response de consulta de tarjeta con Redirect para un API único de autorización más autenticación 3DS. 
{
  "success": true,
  "merchant_code": "abc",
  "operation": {
    "merchant_operation_number": "2391645",
    "state": "PENDIENTE",
    "amount": "15000",
    "currency": "604",
    "transactions": [
      {
        "transaction_id": "5hk8rwa3h3cq9oyfs3a28v1ms",
        "channel": "ecommerce",
        "state": "PENDIENTE",
        "state_reason": "Url generada para continuar con la Autenticacion",
        "continue_url": "https://api.dev.alignet.io/payment/continue/card/81vrxn30vja1gwcfsdng4i5g5",
        "expiration_date": {
          "utc_time": "2024-03-12T22:49:36.018Z",
          "unix_time": 1711585037
        },
        "amount": "15000",
        "currency": "604",
        "payment_method": {
          "method_name": "CARD",
          "method_details": {
            "masked_pan": "455788******9268",
            "brand": "VISA",
            "bin": "455788",
            "last_pan": "9268",
            "card_type": "DEBIT",
            "card_country": "PE",
            "issuer": "BANCO DE CREDITO DEL PERU - BCP",
            "installments": {
              "plan": "NORMAL",
              "installment_number": "2"
            },
            "redirect_url": "https://pay-me.com",
            "callback_url": "https://pay-me.com/callback"
          }
        },
        "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
            }
          }
        ]
      }
    ]
  },
  "meta": {
    "status": {
      "code": "00",
      "message_ilgn": [
        {
          "locale": "es_PE",
          "value": "Se proceso correctamente"
        }
      ]
    }
  }
}

​
Ejemplo 3: con datos de autenticación

Response de consulta de tarjeta con datos resultado de autenticación 3DS obtenidos previamente por otro API 3DS. 
{
  "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": "CARD",
          "method_details": {
            "masked_pan": "411111********1111",
            "brand": "VISA",
            "bin": "411111",
            "last_pan": "9268",
            "card_type": "DEBIT",
            "card_country": "PE",
            "issuer": "BANCO DE CREDITO DEL PERU - BCP",
            "installments": {
              "plan": "NORMAL",
              "installment_number": "2"
            },
            "callback_url": "https://pay-me.com/callback"
          }
        },
        "processor_response": {
          "authorization_code": "055552",
          "brand_transaction_id": "100B",
          "result_message": {
            "code": "00",
            "description": "Approval and completed successfully"
          }
        },
        "additional_fields": null,
        "authentication_result": {
          "version": "2.1.0",
          "eci": "05",
          "vci": "TSYF",
          "ds_transaction_id": "",
          "3ds_transaction_id": ""
        },
        "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": "Procesado correctamente"
        }
      ]
    }
  }
}

​
Siguiente paso

API de Cancelación

Si la transacción sigue autorizada, revisa cómo cancelarla antes de liquidación.