Tapi Logo

Recomendamos ingresar en Desktop

Nuestra documentación y herramientas de integración están optimizadas para brindarte la mejor experiencia en computadora.

Por favor, accede desde una computadora para continuar.

Referencia API

Estado de Pago

GET/operation/{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

CampoTipoObligatorioDescripción
x-authorization-token
StringSíToken de autenticación obtenido en el login.
x-api-key
StringSíAPI Key proporcionada para el acceso a la API.

Path Parameters

CampoTipoObligatorioDescripción
operationId
StringSíEs lo que nos permite identificar qué operación es la que estamos consultando.

Response

Response Body

ParámetroTipoDescripción
operation
ObjectObjeto que contiene los detalles de la operación.
tx
StringIdentificador de la transacción.
mainTx
StringIdentificador de la transacción principal.

Consideraciones

  • Desde este endpoint se genera el comprobante de la transacción: su respuesta (dentro de additionalData) contiene los datos necesarios para emitirlo.
  • Es necesario consultar este endpoint para poder generar el comprobante de pago, ya que devuelve los datos de la transacción (dentro de additionalData) requeridos para emitirlo.
  • 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: /operation/9f50e278-ddf2-4059-b49b-be12fa0a22e1?type=external-payment-id
Ver la librería de errores de esta referencia

CLIENT LIBRARIES

REQUEST EXAMPLE

curl --request GET \
--url https://services.homo.tapila.cloud/operation/f7872991-be03-49ae-ba0e-567d0dffd6ac \
--header 'x-authorization-token: YOUR_TOKEN_HERE' \
--header 'x-api-key: YOUR_API_KEY_HERE'