Cancel (Internal IDs)

delete

https://devapi.forpayservices.cl/white/label/mandate/cancel/internalId/{mandateId}/internalUserId/{internalUserId}

Cancel Mandate (Internal 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/internalId/{mandateId}/internalUserId/{internalUserId}

Autenticación

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

Campos principales

Campo	Descripcion
`mandateId`	ID interno Forpay del mandato.
`internalUserId`	ID interno Forpay del usuario/cliente.
`description`	Motivo funcional de la cancelacion.

Reglas de negocio

Incluye description en la query con el motivo de cancelación. Debe ser una cadena no vacía.
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

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

mandateId

string

required

Identificador interno Forpay del mandato.

internalUserId

string

required

Identificador interno Forpay del cliente.

Query Params

description

string

required

length ≥ 1

Motivo de cancelación obligatorio, expresado como una cadena no vacía.

Headers

country

string

enum

required

Identificador de país donde proviene la solicitud

Allowed:

commerce

string

required

length between 5 and 30

Identificador único del comercio asociado definido por forpay

channel

string

required

length ≥ 3

Tipo de plataforma usada por el comercio para integrarse con Forpay

requestDateTime

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.

correlationId

string

required

length ≥ 1

Identificador de trazabilidad obligatorio. Se recomienda usar un UUID único por solicitud.

processId

string

required

length ≥ 5

Proceso de la solicitud. Para el flujo de nuevas integraciones documentado, utiliza HYBRID.

salesExecutiveId

string

required

length ≥ 1

Identificador del ejecutivo que realiza la venta

x-api-key

string

required

Clave x-api-key

Response

200Operación exitosa