Payment Status Endpoint
GET
/status/{operationId}Consultar el estado de una transacción de pago
Objetivo
El endpoint /status/{operationId} permite verificar el estado actual de una transacción de pago previamente iniciada, proporcionando información detallada sobre su progreso.
Request
Headers
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
x-authorization-token | String | Sí | Token de autenticación obtenido en el login. |
x-api-key | String | Sí | API Key proporcionada para el acceso a la API. |
Path Parameters
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
operationId | String | Sí | Es lo que nos permite identificar qué operación es la que estamos consultando. |
Response
Response Body
| Parámetro | Tipo | Descripción |
|---|---|---|
externalPaymentId | String | ID de identificación de la operación propio del cliente. Utilizado para facilitar la trazabilidad. |
externalClientId | String | ID de identificación de la operación propio del cliente. Utilizado para facilitar la trazabilidad. |
operationId | String | Id de la operación |
companyCode | String | Código de compañía |
companyName | String | Nombre de la compañía |
amount | Number | Monto a pagar |
createdAt | String | Es la fecha con el horario en UTC en el cuál se procesó el pago y se creó el registro |
status | String | Es el estado en el cuál se encuentra la transacción. Estos pueden ser 3: *processing, confirmed* o *failed.* |
additionalData | Object[] | Estos son datos adicionales que sirven para agregar información sobre la imputación de pago. |
amountType | String | Tipo de monto. Abierto o cerrado. |
Response Examples
200 OK
Consideraciones
- Este endpoint también permite consultar a través del externalPaymentId, campo que la fintech genera para nosotros tener trazabilidad de todas las transacciones. Para estos casos deben sumar un queryParam que indique ese ID es de la fintech.
- Ejemplo de búsqueda por externalPaymentId: /status/9f50e278-ddf2-4059-b49b-be12fa0a22e1?type=external-payment-id
CLIENT LIBRARIES
REQUEST EXAMPLE
curl --request GET \ --url https://services.homo.tapila.cloud/status/f7872991-be03-49ae-ba0e-567d0dffd6ac \ --header 'x-authorization-token: YOUR_TOKEN_HERE' \ --header 'x-api-key: YOUR_API_KEY_HERE'