Cancel an existing mandate

Developing

Cloud Mock

https://mock.apidog.com/m1/828215-0-default

DELETE

/mandates/{mandate_id}

OperationId:cancel_mandate_by_id

Deletes an existing mandate.

Request

Authorization

API Key

Add parameter in header

x-api-key

Example:

x-api-key: ********************

OAuth 2.0

Client Credentials

Add the parameter

Authorization

to Headers，whose value is to concatenate the Token after the Bearer.

Example:

Authorization: Bearer ********************

Token URL: https://{domain}.auth.{region}.amazoncognito.com

Scopes:

mandates:write-Create and cancel payment mandates.

Path Params

Responses

🟢200Success

application/json

Body

🟠409Conflict

🟠404Record Not Found

Request Example

Shell

JavaScript

Java

Swift

curl --location --request DELETE 'https://mock.apidog.com/m1/828215-0-default/mandates/2892d13d-4389-46d7-babd-6e0871ee1f3f' \
--header 'x-api-key: <api-key>' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Example 1

{
    "mandate_record": {
        "reference": "e24fd8e6-3181-46a6-a553-19a8cfae9a95",
        "start_date": "2024-12-12T14:23:43.059Z",
        "end_date": "2025-05-14T09:33:39.237Z",
        "authorisation_source": "web",
        "status": "cancelled",
        "limitations": {
            "currency": "EUR",
            "maximum_payment_amount": 1000,
            "percentage_of_payment_amount_accepted": 100
        },
        "id": "81e9f5f5-c6f4-4876-98f4-a3da457c0b1e"
    }
}

Create a new mandate

Get a Mandate