Consultar operación por ID externo

GET

/walletentidad-operaciones/v1/api/v1.201/OperacionByIdExterno/{IdExterno}

Devuelve información completa de una operación, buscándola por el código externo de la entidad.

Request

idExterno string
REQUIRED
Identificador o código externo de la entidad informado opcionalmente al momento de la creación de la operación.


curl request

Copy code

curl --location 'https://gw-staging-qrbind.epays.services/walletentidad-operaciones/v1/api/v1.201/OperacionByIdExterno/1234' \
--header 'Authorization: Bearer {{access_token}}'

Response

id int
Identificador de la operación consultada.

tipoOperacionId int
Identificador del tipo de operación.
Valores posibles: 15 (Pago QR Pix)

tipoOperacionNombre string
Nombre del tipo de operación.
Valores posibles: "Pago QR Pix"

estadoOperacionId int
Identificador del estado de la operación. Este es el estado que importa en nuestro sistema.
Valores posibles:
1 (A procesar - La operación fue ingresada con éxito pero aún está pendiente de procesar. Estado no definitivo),
2 (Aprobada - La operación se completó exitosamente. Estado definitivo),
3 (Rechazada - La operación fue rechazada por algún error. Estado definitivo),
4 (A consultar - Ya se inició el procesamiento de la operación pero aún este no fue resuelto y el sistema está monitoreando su resultado final. Estado no definitivo),
5 (Auditar - Ya se inició el procesamiento de la operación pero aún este no pudo ser resuelto, y pasó un tiempo considerable por lo que el sistema ya no monitoreará su resultado final. El estado definitivo será resuelto manualmente por el equipo de conciliaciones. Estado no definitivo),
6 (Devuelta - Se registró una devolución o contracargo por el monto total de esta operación y este se resolvió exitosamente. Estado definitivo),
7 (Devuelta parcial - Se registró una devolución o contracargo por un monto parcial de esta operación y este se resolvió exitosamente. Aún no se registra que se haya devuelto la totalidad de la monto de la operación, por lo que puede volver a registrar nuevas devoluciones parciales. Estado no definitivo.).

estadoOperacionNombre string
Nombre del estado de la operación.
Valores posibles: "A procesar", "Aprobada", "Rechazada", "A consultar", "Auditar", "Devuelta", "Devuelta parcial".

cuentaId int
Identificador de la cuenta asociada a la operación.

fechaCreacion datetime
Fecha y hora en que se creó la operación.

fechaActualización datetime
Fecha y hora en que se actualizó por ultima vez el estado de la operación.

importe double
Valor del importe de la operación.

comprobanteId int
Identificador del comprobante creado asociado a esta operación. Es el comprobante original.

comprobanteDevolucionId int
Identificador del comprobante de la devolución, si corresponde. Este comprobante se crearía eventualmente si la operación falló durante su procesamiento y se tuvo que reversar.

referencia string
Referencia de la operación.

auditada boolean
Indica si la operación fue auditada o no. Que haya sido auditada indica que su estado pasó a ser definitivo luego de pasar por un proceso especial de conciliación manual.

idExterno string
Identificador o código externo de la entidad informado opcionalmente para ser relacionado como atributo adicional de la operación.

detalle[{}] array of objects
Array de objetos con información adicional de la operación. La información que contenga dependerá del tipo de operación en cuestión. Dentro de este atributo, la información se ordena como clave-valor. Todos los objetos son opcionales y pueden agregarse nuevos a futuro según necesidad de Bind PSP.

detalle[{}].nombre string
Nombre identificador del atributo técnico o variable de la operación que se está informando en la tupla actual.
Valores posibles: "LecturaPixId", "EstadoExterno", "MotivoRechazo", "MontoReales", "PaymentId".

detalle[{}].valor string
Valor alfanumérico asignado al atributo transaccional especificado en el campo de nombre. Su contenido varía y se valida de acuerdo al nombre del objeto.
Valores posibles:
Si nombre = "LecturaPixId": Id de intención de pago Pix asociado.
Si nombre = "EstadoExterno": Estado externo que nos informó el procesador.
Si nombre = "MotivoRechazo": Describe el argumento o la causa técnica del fallo en caso de que la transacción adquiera un estado negativo.
Si nombre = "MontoReales": Importe en reales brasileros que se pagó.
Si nombre = "PaymentId": Es el idenfiticador del procesador externo.

HTTP 200

Consulta exitosa

HTTP 404

No existe la operación consultada

HTTP 401

Token de autenticación inválido