API de Consulta

El API de Consulta permite consultar una transacción generada anteriormente por el API de Autorización - ecommerce.

REQUEST

Path

Method: GET

URL: {{base}}/charges/{{merchant_code}}/{{merchant_operation_number}}/{{transaction_id}}

Field	Description	Accepted Value	Type
`merchant_code`	Identificador del comercio	Cadena Alfanumérica	`String`
`merchant_operation_number`	Numero de operación	Cadena Alfanumérica	`String`
`transaction_id`	Identificador único de la transacción. Es usando solamente para realizar consultas de una única transacción dentro de una Operación	Cadena Alfanumérica	`String`

Headers

Para todos los métodos de pagos, se enviará los siguientes parámetros en la cabecera de la petición:

Field	Description	Accepted Value	Type
`Authorization`	Token de identificación para uso del API creado previamente en API de Seguridad	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.

Operación

Field	Description	Accepted Value	Type	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
`operation`	Objeto que contiene el detalle de la operación		`Object`	SI
`operation.merchant_operation_number`	Número de pedido de la operación que fue cancelado o extornado	Cadena numérica mayor o igual de 6 dígitos	`String`	SI
`operation.amount`	Monto de la operación	Cadena Numérica	`String`	SI
`operation.currency`	Código de la moneda de la operación	Cadena Numérica	`String`	SI
`operation.state`	Estado actual de la operación	REGISTRADO PENDIENTE AUTORIZADO CANCELADO EXPIRADO LIQUIDADO DEPOSITADO	`String`	SI
`operation.transactions`	Array que contiene el listado de transacciones realizadas sobre la operación Este objeto cambia según el método de pago: CARD → Api de Consulta con Tarjeta BANK_TRANSFER → Api de Consulta con Transferencia Bancaria QR → Api de Consulta con QR YAPE → Api de Consulta con Yape CUOTEALO → Api de Consulta con Cuotéalo PAGOEFECTIVO → Api de Consulta con PagoEfectivo		`Array`	SI
`operation.transactions.[].transaction_id`	Identificador unico de la transacción	Cadena Alfanumérica	`String`	SI
`operation.transactions.[].channel`	Canal por la cual se realizó la transacción	ecommerce	`String`	SI
`operation.transactions.[].state`	Estado actual de la transacción	REGISTRADO PENDIENTE AUTORIZADO CANCELADO EXPIRADO LIQUIDADO DEPOSITADO	`String`	SI
`operation.transactions.[].state_reason`	Observacion del estado	Cadena alfanumérica	`String`	SI
`operation.transactions.[].amount`	Monto de la transacción	Cadena Numérica	`String`	SI
`operation.transactions.[].currency`	Código de la moneda de la operación	Cadena Numérica	`String`	SI
`operation.transactions.[].payment_method`	Objeto que contiene información sobre el método de pago usado en la transacción		`Object`	SI
`operation.transactions.[].payment_method.method_name`	Nombre del método de pago usado en la transacción	Cadena Alfanumérica	`String`	SI
`operation.transactions.[].payment_method.method_details`	Objeto que contiene información detallada relacionada al método. Este objeto varia por método. CARD → Api de Consulta con Tarjeta BANK_TRANSFER → Api de Consulta con Transferencia Bancaria QR → Api de Consulta con QR YAPE → Api de Consulta con Yape CUOTEALO → Api de Consulta con Cuotéalo PAGOEFECTIVO → Api de Consulta con PagoEfectivo		`Object`	SI
`operation.transactions.[].payment_method.method_details.redirect_url`	URL del redirect enviado en la Autorizacion	Cadena alfanumérica	`String`	NO
`operation.transactions.[].payment_method.method_details.callback_url`	URL del callback enviado en la Autorizacion	Cadena alfanumérica	`String`	NO
`operation.transactions.[].continue_url`	Visible en estado PENDIENTE URL para continuar el proceso de pago para: CARD (Cuando es por Redirect) BANK_TRANSFER CUOTEALO	Cadena alfanumérica	`String`	NO
`operation.transactions.[].expiration_date`	Visible en estado PENDIENTE Objeto que contiene la fecha en la que se expirará la transacción. Este objeto solo esta disponible para los siguientes métodos de pagos: CARD (Cuando es por Redirect) BANK_TRANSFER PAGOEFECTIVO QR CUOTEALO		`Object`	NO
`operation.transactions.[].expiration_date.utc_time`	Fecha en UTC	Cadena alfanumérica	`String`	NO
`operation.transactions.[].expiration_date.unix_time`	Fecha en unix time	Cadena numérica	`Integer`	NO
`operation.transactions.[].processor_response`	Objeto que contiene resultado detallado del procesamiento. Este objeto puede cambiar según el método de pago. Visible en estado AUTORIZADO, DENEGADO, EXTORNADO Este campo es variable y modificable en el tiempo, tomarlo como referencial. CARD → Api de Consulta con Tarjeta BANK_TRANSFER → Api de Consulta con Transferencia Bancaria QR → Api de Consulta con QR YAPE → Api de Consulta con Yape CUOTEALO → Api de Consulta con Cuotéalo PAGOEFECTIVO → Api de Consulta con PagoEfectivo		`Object`	NO
`operation.transactions.[].additional_fields`	Objeto que contiene los datos adicionales de la transacción enviados en la Autorización	`key:value`	`Dictionary`	NO
`operation.transactions.[].lifecycle`	Array que contiene listado de los estado por la cual pasó la transacción		`Array`	SI
`operation.transactions.[].lifecycle.[].state`	Estado de la transacción	REGISTRADO PENDIENTE AUTORIZADO EXTORNADO CANCELADO EXPIRADO LIQUIDADO DEPOSITADO	`String`	SI
`operation.transactions.[].lifecycle.[].date`	Objeto que contiene la fecha en la que se realizó el cambio de estado		`Object`	SI
`operation.transactions.[].lifecycle.[].date.utc_time`	Fecha en UTC	Cadena alfanumérica	`String`	SI
`operation.transactions.[].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

Transacción

Se devolverá la misma respuesta que la Operación, pero solo con una Transaccion dentro de “transactions”.