Skip to main content
POST
Cancel a mandate (ALPHA)

Authorizations

x-api-key
string
header
required

Path Parameters

mandate_id
string
required

Body

application/json
signer_public_key
string
required
signature
string
required

Response

Mandate terminated — rejected if it was still pending, revoked if it was active.

Scheduled payments are NOT cancelled. They are signer-scoped and decoupled from mandate lifecycle, so any payment this mandate was covering stays scheduled and then FAILS at its due date, when the executor finds no mandate authorizing it. Cancel those payments explicitly if they should not remain on the customer's schedule.

id
string
status
enum<string>
Available options:
pending,
active,
rejected,
revoked,
done
approved_by_signer_id
string
rejected_by_signer_id
string

The signer that cancelled the mandate while it was still pending (§8); absent otherwise.

revoked_by_signer_id
string

The signer that cancelled the mandate after activation (§8); absent otherwise.