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

Confirmar Pago

WEBHOOK/confirmPayment

Confirma el resultado de una operación de recarga.

Objetivo

Este endpoint es utilizado por Tapi para notificar a la fintech que un pago ha sido completado exitosamente. Tapi envía esta confirmación a un endpoint que la fintech debe disponibilizar, actualizando así el estado de la deuda correspondiente en ambos sistemas.

Request

Headers

CampoTipoObligatorioDescripción
x-api-key
StringSíAPI Key provista para autenticar el request.
x-authorization-token
StringSíToken de autenticación del cliente.

Body Parameters

ParámetroTipoRequeridoDescripción
externalPaymentId
StringSíID de identificación de la operación propio del cliente. Utilizado para facilitar la trazabilidad.
externalClientId
StringSíIdentificador del usuario final por parte del cliente.
operationId
StringSíId de la operación.
status
StringSíEstado final de la operación (confirmed o failed).
companyCode
StringSíCódigo de la compañía.
companyName
StringSíNombre de la compañía.
amount
NumberSíMonto a pagar.
type
StringSíVertical de negocio.
hash
StringNoHash.

Response

Response Body

ParámetroTipoDescripción
status
StringEstado de la confirmación de la operación.

Consideraciones

  • Este webhook es invocado por TAPI y debe ser implementado por el cliente.
  • Viaja con headers personalizados para autenticación.
  • El campo 'status' puede ser 'confirmed' o 'failed'.
Ver la librería de errores de esta referencia

CLIENT LIBRARIES

REQUEST EXAMPLE

curl --request POST \
--url https://recharge.homo.tapila.cloud/confirmPayment \
--header 'x-authorization-token: YOUR_TOKEN_HERE' \
--header 'x-api-key: YOUR_API_KEY_HERE' \
--header 'Content-Type: application/json' \
--data '{
  "externalPaymentId": "",
  "externalClientId": "",
  "operationId": "",
  "status": "",
  "companyCode": "",
  "companyName": "",
  "amount": 0,
  "type": "",
  "hash": ""
}'