Mandates - Revoke Mandate

POST /mandates/revoke/{mandate_id}

Revoke a mandate by its identifier.

cURL
curl --request POST \
  --url https://sandbox.hyperswitch.io/mandates/revoke/{mandate_id} \
  --header 'api-key: <api-key>'

Sample successful response (200):

{
  "mandate_id": "<string>",
  "status": "active",
  "error_code": "E0001",
  "error_message": "Failed while verifying the card"
}

Authorizations

  • Header: api-key (string) — required Use the API key created under your merchant account from the HyperSwitch dashboard. API key is used to authenticate API requests from your merchant server only. Don't expose this key on a website or embed it in a mobile application.

Path Parameters

  • mandate_id (string) — required The identifier for a mandate.

Response

  • Status: 200

  • Content-Type: application/json

  • Description: The mandate was revoked successfully

Response object fields:

  • mandate_id — string (required) The identifier for mandate.

  • status — enum (required) The status of the mandate, indicating whether it can be used to initiate a payment. Available options: active, inactive, pending, revoked.

  • error_code — string | null If there was an error while calling the connectors the code is received here. Example: "E0001"

  • error_message — string | null If there was an error while calling the connector the error message is received here. Example: "Failed while verifying the card"

Was this page helpful? Yes / No

Suggest edits: https://github.com/juspay/hyperswitch/edit/main/api-reference/v1/mandates/mandates--revoke-mandate.mdx Raise issue: https://github.com/juspay/hyperswitch/issues/new?title=Issue%20on%20docs&body=Path:%20/v1/mandates/mandates--revoke-mandate

Related:

  • https://api-reference.hyperswitch.io/v1/customers/customers--list

  • https://api-reference.hyperswitch.io/v1/mandates/mandates--retrieve-mandate

PreviousDisputes - Retrieve DisputeNextCustomers - Create