API Reference

Confirm Payment

POST/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
StringAPI Key provista para autenticar el request.
x-authorization-token
StringToken de autenticación del cliente.

Body Parameters

CampoTipoObligatorioDescripción
operationId
StringID único de la operación generada en el proceso de pago.
status
StringEstado final de la operación (confirmed o failed).
statusDescription
StringNoDescripción adicional del estado.
externalPaymentId
StringID de la operación provisto por el cliente.
externalClientId
StringID del usuario final asignado por el cliente.

Response

Response Body

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

Response Examples

200 OK

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'.

CLIENT LIBRARIES

REQUEST EXAMPLE

curl --request POST \
--url https://recharges.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 '{
  "operationId": "",
  "status": "",
  "statusDescription": "",
  "externalPaymentId": "",
  "externalClientId": ""
}'