Suscribir a Autopay
PATCH
/automatic-debitActiva o desactiva el débito automático sobre una adhesión de agenda existente, y opcionalmente registra los parámetros de configuración del autopago.
Objetivo
Permitir que el usuario final delegue el pago automático de un servicio que ya tiene adherido en su agenda.
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 sobre la que se activa el débito automático. |
subscribeToAutomaticDebit | Boolean | Sí | true activa el débito automático, false lo desactiva. |
autopayConfig | Object | No | Parámetros de configuración del autopago. Si se envía, sus dos campos internos son obligatorios. |
endDate tiene que ser estrictamente futura. El mínimo aceptado es el día de mañana: la fecha de hoy se rechaza. Si enviás una fecha igual o anterior a hoy, la API responde AGXCX0003 indicando endDate como parámetro inválido. Cuando enviás sólo la fecha (YYYY-MM-DD), se interpreta como el fin de ese día.
Si enviás autopayConfig, incluí los dos campos. El objeto en sí es opcional, pero maxAmount y endDate no admiten valores nulos una vez que decidís enviarlo. Enviarlo incompleto produce un error del servidor.
No confundir autopayConfig.maxAmount con el campo maxAmount de una deuda. Son cosas distintas: el de la deuda es el monto máximo que el biller acepta para ese pago; el de autopayConfig es el parámetro que configurás vos al suscribir el servicio.
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. |
CLIENT LIBRARIES
REQUEST EXAMPLE
curl --request PATCH \
--url https://agenda.homo.tapila.cloud/automatic-debit \
--header 'x-authorization-token: YOUR_TOKEN_HERE' \
--header 'x-api-key: YOUR_API_KEY_HERE' \
--header 'Content-Type: application/json' \
--data '{
"agendaId": "pruebaAgenda1#51ea6bf3-819f-44cf-9df7-5eb25b404150#0000000901",
"subscribeToAutomaticDebit": true,
"autopayConfig": {"maxAmount":1000,"endDate":"2027-12-31"}
}'