Update Installments

Update Installments

Qué hace

Actualiza estado de cuotas, por ejemplo marcarlas como pagadas o anuladas, usando IDs externos o internos segun el ejemplo.

Cuándo usarlo

Usalo cuando un evento externo o conciliacion confirma que una cuota cambio de estado y Forpay debe reflejarlo.

Endpoint

PUT /installments/status/change

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
product.id o product.internalIdMandato/deuda padre.
installments.ids o installments.internalIdsCuotas a actualizar.
actionAccion/estado objetivo segun el contrato, por ejemplo pago o anulacion.
paymentDatos del pago cuando se marca como pagada.

Variantes soportadas

  • Marcar cuotas como pagadas usando IDs externos.
  • Marcar cuotas como pagadas usando IDs internos.
  • Marcar cuotas como anuladas/canceladas usando IDs externos.
  • Marcar cuotas como anuladas/canceladas usando IDs internos.

Reglas de negocio

  • La cuota debe pertenecer al mandato y comercio autenticado.
  • Para pagos, informa fecha, monto, moneda y autorizacion cuando el contrato lo requiera.
  • No marques como pagada una cuota sin evidencia de pago/conciliacion.

Respuesta exitosa

Retorna confirmacion del cambio de estado. Valida el resultado con GET /receivables si necesitas conciliacion.

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

Actualización de cuotas para mandatos tipo DYNAMIC. Permite ANULAR o marcar como PAGADAS.

product
object
required

Enviar solo uno de estos campos: internalId (Forpay) o id (Comercio).

action
required
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

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