Update

Update Mandate

Qué hace

Actualiza campos permitidos de un mandato existente. La ruta incluye identificadores externo e interno para ubicar el recurso segun el contrato actual.

Cuándo usarlo

Usalo cuando necesites modificar informacion permitida del mandato, por ejemplo datos de configuracion o metadata segun el producto.

Endpoint

PUT /mandate/update/id/{mandateExternalId}/internalId/{mandateId}

Autenticación

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

Parámetros para probar en OpenAPI

CampoDescripcion
mandateExternalIdID externo del mandato enviado por el comercio.
mandateIdID interno Forpay del mandato.

Body / Parámetros

Usa el schema y ejemplo JSON precargado. Ajusta solo campos permitidos por el producto; no cambies identificadores de cliente o comercio desde el body.

Reglas de negocio

  • El mandato debe pertenecer al comercio autenticado.
  • No todos los campos son modificables en todos los estados.
  • Mantén correlationId por intento de actualizacion.

Respuesta exitosa

Retorna confirmacion de actualizacion y/o el recurso actualizado segun implementacion.

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

Identificador del mandato en el Comercio Id.

int32
required
≥ 0

Identificador interno del mandato en Forpay internalId.

Body Params

Body Paramas de actualización de solo aplicable al mandato SUBSCRIPTION

customer
object
required

Datos del cliente (Comercio).

mandate
object
required

Datos del mandato SUBSCRIPTION a actualizar.

boolean

Indicador que determina si se muestra la ventana de Detalle de Compra.

urls
object

URLs de retorno y webhooks del mandato.

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