API Reference

Operation Status

GET/operation/{operationId}

Consulta el estado actual de una operación de recarga.

Objetivo

Permite consultar el detalle de una operación de recarga iniciada, incluyendo su estado actual y sus datos relacionados.

Request

Headers

CampoTipoObligatorioDescripción
x-api-key
StringAPI Key provista para acceder al endpoint.
x-authorization-token
StringToken de autenticación generado en el login.

Path Parameters

CampoTipoObligatorioDescripción
operationId
StringID único de la operación a consultar.

Response

Response Body

ParámetroTipoDescripción
operationId
StringID único de la operación.
createdAt
StringFecha y hora de creación de la operación (UTC).
companyCode
StringCódigo de la compañía.
companyName
StringNombre de la compañía.
amount
NumberMonto de la recarga.
status
StringEstado actual de la transacción (pending, confirmed, failed).
identifiers
Object[]Identificadores utilizados para realizar la recarga.
agent
StringNombre del agente procesador.
clientUsername
StringNombre del cliente fintech.
externalClientId
StringID del usuario final proporcionado por el cliente.
externalPaymentId
StringID de la operación provisto por el cliente.
additionalData
ObjectInformación adicional sobre la operación.

Response Examples

200 OK

Consideraciones

  • Este endpoint permite consultar una operación en cualquier momento posterior a su creación.
  • Si el operationId es inválido o no existe, se devolverá un error.

CLIENT LIBRARIES

REQUEST EXAMPLE

curl --request GET \
--url https://recharges.homo.tapila.cloud/operation/79bdf09b-523f-4646-8ef0-e34bbaa35519 \
--header 'x-authorization-token: YOUR_TOKEN_HERE' \
--header 'x-api-key: YOUR_API_KEY_HERE'