Cancel (External IDs)

Cancel Mandate (External IDs)

Qué hace

Cancela un mandato/deuda existente usando identificadores externos o internos, segun la ruta.

Cuándo usarlo

Usalo cuando el cliente o el comercio soliciten terminar la autorizacion y no deban ejecutarse nuevos cobros.

Endpoint

DELETE /mandate/cancel/id/{mandateExternalId}/userId/USERID

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.
userIdID externo del usuario/cliente.
descriptionMotivo funcional de la cancelacion.

Reglas de negocio

  • El mandato y el usuario deben pertenecer al comercio autenticado.
  • La cancelacion puede no aplicar si el mandato ya esta finalizado, eliminado o en un estado incompatible.
  • Registra un motivo claro en description.

Respuesta exitosa

Retorna confirmacion de cancelacion. Luego puedes validar estado con Find o Search.

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

Identificador externo del mandato enviado por el comercio.

string
required

Identificador externo del cliente enviado por el comercio.

Query Params
string
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