Skip to main content
Para realizar una consulta o un extorno mediante el SDK, se deben invocar las funciones startSearch o startReversal, según la operación requerida.

​
Datos de Entrada

Estas funciones esperan los siguientes parámetros:
ParámetroTipoObligatorioDescripción
operationNumberStringSíNúmero de operación único generado por la pasarela y utilizado para identificar la transacción.
transactionIDStringNoIdentificador único de la transacción generado por Pay-me.
Para las operaciones de consulta startSearch), se puede utilizar el operationNumber o el transactionID para localizar la transacción.

​
Datos de Salida

La función de consulta devuelve un objeto PMSearchResponse.

​
PMSearchResponse

ParámetroTipoObligatorioDescripción
successBooleanSíIndica si el proceso fue ejecutado correctamente.
resultCodeStringSíCódigo de resultado de la operación.
resultMessageStringSíMensaje descriptivo asociado al resultado.
resultOperationResultNoObjeto que contiene el detalle de la operación consultada.

​
OperationResult

ParámetroTipoObligatorioDescripción
merchantOperationNumberStringSíNúmero de operación proporcionado por el comercio.
transactionsTransactionDetail[]SíLista de transacciones asociadas a la operación consultada.

​
TransactionDetail

ParámetroTipoObligatorioDescripción
transactionIDStringSíIdentificador único de la transacción generado por Pay-me.
stateStringSíEstado actual de la transacción.
stateReasonStringSíMotivo asociado al estado de la transacción.
amountStringSíMonto de la transacción.
currencyStringSíMoneda utilizada en la transacción.
additionalFieldsDictionaryNoInformación adicional proporcionada por el comercio.
paymentMethodTransactionPaymentMethodSíInformación del método de pago utilizado.
processorResponseStringNoCadena JSON con la respuesta devuelta por la procesadora.
lifecycleTransactionLifecycle[]SíHistorial de estados por los que pasó la transacción.

​
TransactionPaymentMethod

ParámetroTipoObligatorioDescripción
nameStringSíMétodo de pago utilizado en la transacción.
methodDetailStringNoCadena JSON con información adicional del método de pago. Disponible para métodos CARD y QR.

​
TransactionLifecycle

ParámetroTipoObligatorioDescripción
stateStringSíEstado de la transacción.
utcDateTimeStringSíFecha y hora en formato UTC en la que la transacción cambió de estado.
unixTimeStringSíFecha y hora en formato UNIX en la que la transacción cambió de estado.
El arreglo lifecycle permite conocer el historial completo de la transacción, incluyendo todos los cambios de estado registrados durante su procesamiento.

​
Ejemplo de Respuesta

{
  "success": true,
  "resultCode": "00",
  "resultMessage": "Consulta exitosa",
  "result": {
    "merchantOperationNumber": "ORDER-123456",
    "transactions": [
      {
        "transactionID": "TRX987654321",
        "state": "AUTHORIZED",
        "stateReason": "Aprobada",
        "amount": "1000",
        "currency": "PEN",
        "paymentMethod": {
          "name": "CARD",
          "methodDetail": "{\"brand\":\"VISA\",\"maskedPan\":\"411111******1111\"}"
        },
        "lifecycle": [
          {
            "state": "AUTHORIZED",
            "utcDateTime": "2026-06-03T18:30:00Z",
            "unixTime": "1780501800"
          }
        ]
      }
    ]
  }
}