Revoke a mandate

Revokes an existing mandate by setting its status to INACTIVE.

SecurityOAuth2
Request
path Parameters
mandateId
required
string <uuid>

The unique identifier of the mandate.

Responses
204

Successful operation. Mandate revoked.

400

Invalid mandate ID format.

403

Unauthorized access.

404

Mandate not found.

delete/v1/mandates/{mandateId}
Request samples
curl -i -X DELETE \
  'https://toast-api-server/v1/mandates/{mandateId}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'
Response samples
application/json
{
  • "status": 0,
  • "code": 0,
  • "message": "string",
  • "messageKey": "string",
  • "fieldName": "string",
  • "link": "string",
  • "requestId": "string",
  • "developerMessage": "string",
  • "errors": [
    ],
  • "canRetry": true
}