POST
/
mandates
/
revoke
/
{mandate_id}
curl --request POST \
  --url https://sandbox.hyperswitch.io/mandates/revoke/{mandate_id} \
  --header 'api-key: <api-key>'
{
  "mandate_id": "<string>",
  "status": "active",
  "error_code": "E0001",
  "error_message": "Failed while verifying the card"
}

Authorizations

api-key
string
headerrequired

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

200 - application/json
mandate_id
string
required

The identifier for mandate

status
enum<string>
required

The status of the mandate, which indicates 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

error_message
string | null

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

Customers - ListMandates - Retrieve Mandate