Confirmar débito ejecutado
POST
/automatic-debit/confirmInforma a tapi que el débito sobre la cuenta del usuario final fue ejecutado, para que tapi registre el pago contra el biller.
Objetivo
Dar curso al pago del usuario final generado a partir de una notificación debit-incoming.
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
| Parámetro | Tipo | Requerido | Descripción |
|---|---|---|---|
agendaId | String | Sí | Identificador de la adhesión de agenda. |
paymentMethod | String | Sí | Método de pago usado por el usuario final. Valores admitidos: ACCOUNT, DEBIT, CREDIT, TRANSFER, CASH, BANK_AUTOPAY. |
externalPaymentId | String | Sí | Identificador que asigna el cliente al pago realizado. |
token | String | Sí | El taskToken que tapi envió en el webhook debit-incoming, sin modificar. |
paymentDetails | Object | No | Detalles adicionales del pago ejecutado. Objeto de forma libre; si se omite, se usa {}. |
paymentMethod es un enum cerrado. Cualquier valor fuera de la lista produce AD0005.
Response
Response Body
| Parámetro | Tipo | Descripción |
|---|---|---|
tx | UUID | Identificador del paso dentro de la transacción. |
mainTx | UUID | Identificador principal de la transacción. |
Consideraciones
- Una vez confirmado, el estado del pago se consulta en GET /operation/{operationId}, con el operationId que recibiste en el webhook.
CLIENT LIBRARIES
REQUEST EXAMPLE
curl --request POST \
--url https://agenda.homo.tapila.cloud/automatic-debit/confirm \
--header 'x-authorization-token: YOUR_TOKEN_HERE' \
--header 'x-api-key: YOUR_API_KEY_HERE' \
--header 'Content-Type: application/json' \
--data '{
"agendaId": "test-qa#51ea6bf3-819f-44cf-9df7-5eb25b404150#874127",
"paymentMethod": "CREDIT",
"externalPaymentId": "00000000-0000-4000-8000-000000000003",
"token": "AAAAKgAAAAIAAAAAAAAAA...",
"paymentDetails": {"installments":3,"cardBrand":"VISA"}
}'