Contratos de Cliente (Merchant API)

A diferencia de la API estándar donde tú inicias las peticiones, en los Contratos de Cliente es AutoPay quien consulta a tu servidor para realizar operaciones críticas en tiempo real.

Esta sección documenta los endpoints que tu infraestructura debe exponer para permitir la automatización de cobros y la sincronización de estados.

Configuración y Base URL

Base URL: Debes entregar esta URL durante el onboarding. Ten en cuenta que AutoPay concatenará automáticamente el prefijo /autopay a todas las peticiones, por lo que tu enrutador debe estar configurado para soportarlo.

Ejemplo:

Base URL entregada: https://api.tucomercio.com
Petición final de AutoPay: POST https://api.tucomercio.com/autopay/balance

Autenticación (Basic Authentication): Este endpoint requiere autenticación vía header Authorization. El comercio debe validar las credenciales configuradas para AutoPay en cada solicitud entrante. Ver más en Autenticación de contratos.

Servicios a Implementar

Para garantizar una integración completa, debes exponer los siguientes contratos:

Recurso	Método	Función
/balance	`POST`	Exclusivo para Cobro Variable. Nos permite consultar el monto a cobrar en cada ciclo. Necesario si usas modelos `TOTAL_BALANCE` o `MINIMUM_BALANCE`.
/settlement	`POST`	Obligatorio. Confirmación final del pago aprobado para que puedas registrarlo/asentarlo en tus sistemas internos.
/webhook	`POST`	Obligatorio. Canal de notificación para recibir actualizaciones de estado (creación, cancelación) y resultados de los cobros.

Requisitos Técnicos

Tu API debe cumplir con los siguientes estándares:

1. Seguridad (Basic Auth)

AutoPay se autenticará enviando una cabecera Authorization. Tú defines las credenciales (username y password) y debes validarlas en cada petición entrante.

2. Formato y Transporte

Protocolo: HTTPS estricto.
Formato: JSON (Content-Type: application/json).
Rendimiento: Se recomienda responder en menos de 3 segundos para evitar timeouts.