Creation OnePay Mandate

Qué hace

Crea un mandato/deuda de tipo ONEPAY, pensado para un pago unico.

Cuándo usarlo

Se utiliza para un cobro puntual, sin recurrencia, en el que el cliente realiza el pago mediante un enlace. Es adecuado cuando no se necesita establecer un compromiso de cobros periódicos.

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.

Reglas de negocio

• Selecciona en paymentMethods uno o más medios admitidos para ONEPAY, mediante sus nombres públicos o IDs de entrada. Cada opción debe estar habilitada para el comercio.
• 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.
• Envía mandate.isMall de forma explícita. Para un pago sin distribución Mall, utiliza false.
• Usa mandate.type=ONEPAY.
• El monto total debe ser consistente con los cargos/cuotas informados.
• Este producto se finaliza cuando el cobro queda completado segun la configuracion.

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

Se envía una sola cuota por 25000 PESOS, el mismo total declarado en totalAmounts. terminateWhenCharged: true solicita finalizar el producto al completar el cobro e isMall: false indica un pago sin distribución Mall.

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.