Confirm Payment Endpoint

POST/confirm-payment

Confirmar el pago de una transacción procesada

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

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.

Body Parameters

Campo	Tipo	Obligatorio	Descripción
externalPaymentId	String	Sí	ID de identificación de la operación propio del cliente. Utilizado para facilitar la trazabilidad.
externalClientId	String	Sí	Identificador del usuario final por parte del cliente.
operationId	String	Sí	Id de la operación.
status	String	Sí	Tendrá valor *confirmed* si se pudo abonar correctamente ante la empresa proveedora de servicio. Será *failed* en caso de que haya ocurrido algún error en la imputación.
additionalData	Object[]	Sí	Información adicional sujeta al servicio que se esta abonando.
companyCode	String	Sí	Código de la compañía.
companyName	String	Sí	Nombre de la compañía.
amount	Number	Sí	Monto a pagar.
type	String	Sí	Tipo de notificación que se envía
hash	String	No	Viaja con un hash en caso de que se requiera validar la identidad de tapi

Response

Response Body

Parámetro	Tipo	Descripción
status	String	Estado de la operación.

Response Examples

200 OK

Consideraciones

La confirmación del pago actualiza automáticamente el estado de la deuda a 'pagada'.
El estado de la operación debe guardarse como referencia para futuras consultas.

CLIENT LIBRARIES

REQUEST EXAMPLE

curl --request POST \
--url https://services.homo.tapila.cloud/confirm-payment \
--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": "confirmed",
  "additionalData": [],
  "companyCode": "",
  "companyName": "",
  "amount": 0,
  "type": "",
  "hash": ""
}'

API Reference