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

Se utiliza para registrar un compromiso y cargar sus cuotas posteriormente, a medida que se conocen los cobros. Es adecuado para cobros variables o que se informan durante la vigencia del mandato.

Endpoint

POST /mandate

Autenticación

Envía x-api-key y Authorization: Bearer <token> con las credenciales del ambiente de la solicitud. Obtén el token mediante el proceso de autenticación.

Headers requeridos

• country, commerce y channel: contexto comercial autorizado para la solicitud.
• requestDateTime: fecha y hora de la solicitud.
• correlationId: identificador de la solicitud. Se recomienda usar un UUID para facilitar su seguimiento.
• processId y salesExecutiveId: valores obligatorios en esta operación.

Consulta los parámetros de la operación para conocer las restricciones de cada header y utiliza los valores asignados a tu integración.

Campos principales

Variantes soportadas

• Cliente por customer.userId externo.
• Cliente por customer.internalUserId interno Forpay.
• Creacion con bloque signature cuando se requiere iniciar firma junto con el mandato.

Reglas de negocio

• Si envías validateCreation: true y mandate.serviceId, desarrollo comprueba si ese serviceId ya existe. La prevalidación de producción no realiza esa comprobación.
• El usuario debe estar asociado al comercio en este ambiente. Regístralo o asócialo antes mediante Create User.
• Para este endpoint documentado como Dynamic, usa mandate.type=DYNAMIC.
• mandate.id debe ser unico por comercio.
• needPayNow normalmente debe ser false salvo flujos acordados de cobro inmediato.
• Si incluyes installments, cada cuota debe tener ID externo unico.

Respuesta exitosa

Si creas el compromiso sin firma, la respuesta incluye statusCode, message y payload. Según el resultado del flujo, los datos se entregan en payload.customer, payload.mandate, payload.installments y payload.activation.

Guarda los identificadores del cliente, del mandato y de las cuotas que recibas para utilizarlos en consultas posteriores. Si la respuesta incluye un enlace de activación, lo encontrarás en payload.activation.url.

Ejemplo recomendado

Este ejemplo crea únicamente el mandato dinámico. No incluye installments ni installmentsNumber. La carga posterior de cuotas se muestra en Flujo de integración y Create Installments.

Los datos son ficticios. Sustituye customer.internalUserId por el valor real devuelto por POST /user, usa un mandate.id nuevo y reemplaza las URLs por las de tu integración. El medio seleccionado debe estar habilitado para el comercio. Estos cuerpos se envían a POST /mandate con los headers de la operación. Los ejemplos no incluyen firma documental.

La URL de la respuesta es ilustrativa. En la integración, utiliza exactamente payload.activation.url devuelto por Forpay; no construyas el enlace a partir de su ejemplo.