Sign in
Mandates

Mandates - Revoke Mandate

Revokes a mandate created using the Payments/Create API

post/mandates/revoke/{mandate_id}

Path parameters

mandate_idstring required

The identifier for a mandate

Response

The mandate was revoked successfully

mandate_idstring required

The identifier for mandate

status'active' | 'inactive' | 'pending' | 'revoked' required

The status of the mandate, which indicates whether it can be used to initiate a payment.

error_codestring nullable

If there was an error while calling the connectors the code is received here

error_messagestring nullable

If there was an error while calling the connector the error message is received here

Example response

{
  "error_code": "E0001",
  "error_message": "Failed while verifying the card"
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.