Create Installments

Create Installments

Qué hace

Crea cuotas/cargos asociados a un mandato, principalmente para mandatos dinamicos.

Cuándo usarlo

Usalo cuando el comercio crea cuotas despues de haber creado el mandato o necesita cargar nuevos cobros bajo un compromiso existente.

Endpoint

POST /installments

Autenticación

Requiere x-api-key y Authorization: Bearer <JWT>, salvo endpoints publicos de autenticacion o contratos de webhook receptor del cliente.

Campos principales para probar en OpenAPI

CampoUso
customer.userId o customer.internalUserIdCliente propietario del mandato.
product.id o product.internalIdMandato/deuda padre de las cuotas.
installmentsNumberCantidad de cuotas enviadas.
installments[].idID externo unico de cada cuota.
installments[].amountMonto de la cuota.
installments[].installmentDueDateFecha de vencimiento YYYY-MM-DD.
installments[].currencyIdMoneda de la cuota.

Variantes soportadas

  • Creacion usando IDs externos del comercio.
  • Creacion usando IDs internos Forpay.

Reglas de negocio

  • Cada cuota debe tener un identificador externo unico por comercio/mandato.
  • Los montos y moneda deben ser consistentes con el mandato.
  • No crees cuotas duplicadas para el mismo cobro.

Respuesta exitosa

Retorna confirmacion de creacion y datos de las cuotas aceptadas.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Body para crear cuotas asociadas a un mandato DYNAMIC.

customer
object
required

Enviar solo uno de estos campos: internalUserId (Forpay) o userId (Comercio). Si envías ambos o ninguno, la solicitud será rechazada.

product
object
required

Enviar solo uno de estos campos: internalId (Forpay) o id (Comercio). Si envías ambos o ninguno, la solicitud será rechazada.

number
required

Cantidad de cuotas ingresadas a cobrar con el mandato.

installments
array of objects
required

Listado de cuotas ingresadas a cobrar con el mandato.

installments*
urls
object
Headers
string
enum
required

Identificador de país donde proviene la solicitud

Allowed:
string
required

Identificador único del comercio asociado definido por forpay

string
required

Tipo de plataforma usada por el comercio para integrarse con Forpay

date-time
required
Defaults to 2026-07-09T14:35:12.500Z

Fecha y hora de la solicitud en formato ISO 8601. En esta documentación se muestra un ejemplo precargado; al consumir la API debe enviarse la fecha/hora real de la solicitud.

string
required

Identificador único para la trazabilidad de la solicitud

string
enum
required

Identificador único del proceso interno de Forpay que realiza la solicitud

Allowed:
string
required

Identificador del ejecutivo que realiza la venta

string
required

Clave x-api-key

Responses

Callback
Language
Credentials
LoadingLoading…
Click Try It! to start a request and see the response here! Or choose an example:
application/json