post
https://devapi.forpayservices.cl/white/label/mandate
Creation Dynamic Mandate
Qué hace
Crea un mandato/deuda de tipo DYNAMIC. Este producto permite crear cuotas iniciales o cargar cuotas posteriormente mediante POST /installments.
Cuándo usarlo
Usalo cuando el comercio administra compromisos flexibles, cuotas bajo demanda o planes donde las cuotas se crean desde la integracion.
Endpoint
POST /mandate
Autenticación
Requiere x-api-key y Authorization: Bearer <JWT>, salvo endpoints publicos de autenticacion o contratos de webhook receptor del cliente.
Headers requeridos
country,commerce,channel: contexto comercial autorizado.requestDateTime: fecha/hora ISO 8601.correlationId: UUID unico para trazabilidad.processIdysalesExecutiveId: contexto funcional/comercial cuando aplique.
Campos principales para probar en OpenAPI
| Campo | Uso para prueba |
|---|---|
customer.userId o customer.internalUserId | Identifica al cliente. Usa solo una variante segun el ejemplo. |
mandate.id | ID externo unico del comercio para el mandato/deuda. |
mandate.type | Tipo del producto: DYNAMIC, PERMANENT, SUBSCRIPTION u ONEPAY. |
mandate.name / mandate.detail | Texto visible o descriptivo del compromiso. |
mandate.charges | Configuracion de vigencia, monto, moneda y periodicidad segun el tipo. |
paymentMethods | Metodos habilitados para este mandato; si se omite, se usan los disponibles para el comercio. |
installments | Cuotas iniciales cuando el producto lo permite. |
metadata | Datos propios del comercio para conciliacion. |
urls.callback, urls.activationWebhook, urls.paymentWebhook | URLs de retorno/notificacion si tu flujo las usa. |
Variantes soportadas
- Cliente por
customer.userIdexterno. - Cliente por
customer.internalUserIdinterno Forpay. - Creacion con bloque
signaturecuando se requiere iniciar firma junto con el mandato.
Reglas de negocio
- Para este endpoint documentado como Dynamic, usa
mandate.type=DYNAMIC. mandate.iddebe ser unico por comercio.needPayNownormalmente debe serfalsesalvo flujos acordados de cobro inmediato.- Si incluyes
installments, cada cuota debe tener ID externo unico.
Respuesta exitosa
Retorna una respuesta de creacion con IDs internos/externos del cliente y mandato. Guarda estos IDs para busqueda, actualizacion, cancelacion y conciliacion.
Ejemplo recomendado
Usa el ejemplo JSON precargado en OpenAPI como base. Cambia customer, mandate.id, fechas, montos, paymentMethods y URLs antes de ejecutar.
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
Callbacks

