API Reference

Solicitud de cambio de estado de cuotas de un Compromiso de pago, independiente si es un Mandato Dinámico o un Mandato Permanente. Con esto, se puede solicitar la anulación o la conciliación del pago de una cuota.

Log in to see full request history
Body Params
product
object
required

Solo se debe utilizar una propiedad id o internalId

installments
object
required

Listado de cuotas que se quieren anular. Solo enviar en caso de ANULAR cuotas. Se debe enviar solo un campo entre internalIds y ids.

payments
array of objects
required

Listado de pagos de cuotas que se quieren conciliar. Solo enviar en caso de marcar cuotas como PAGADAS

payments*
Headers
string
required

Identificador de país donde proviene la solicitud

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

Fecha y hora de la solicitud

string
required

Identificador único para la trazabilidad de la solicitud

string
required

Identificador único del proceso interno de forpayque realiza la solicitud

string
required

Identificador del ejecutivo que realiza la venta

string
required

Clave x-api-key

Responses

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