Create a new mandate

Developing

Cloud Mock

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

POST

/mandates

OperationId:create_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.

Header Params

Body Params application/json

Examples

Responses

🟢200Success

application/json

Body

🟠409Conflict

🟠400Bad Request

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://mock.apidog.com/m1/828215-0-default/mandates' \
--header 'Idempotency-Key: {{$string.uuid}}' \
--header 'x-api-key: <api-key>' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "mandate_record": {
        "start_date": "2024-09-09T08:09:58.706Z",
        "end_date": "2025-01-14T20:10:25.763Z",
        "authorisation_source": "string",
        "limitations": {
            "currency": "BWP",
            "maximum_payment_amount": 36800,
            "percentage_of_payment_amount_accepted": 67
        },
        "initiator_data": {
            "consumer_data": {
                "given_name": "Vida",
                "family_name": "Kozey",
                "payment_reference": "non",
                "national_registration_number": "QQ999999A",
                "email_address": "Gretchen84@example.net",
                "mobile_number": "+15367056250"
            }
        },
        "metadata": {}
    }
}'

Response Example

200 - Example 1

{
    "mandate_record": {
        "start_date": "2025-02-25T00:08:59.298Z",
        "end_date": "2024-10-26T22:06:14.487Z",
        "authorisation_source": "string",
        "status": "string",
        "limitations": {
            "currency": "DZD",
            "maximum_payment_amount": 21500,
            "percentage_of_payment_amount_accepted": 63
        },
        "id": "e64ecf0e-9130-45bb-b5aa-9b83ecd69ed7",
        "initiator_data": {
            "consumer_data": {
                "given_name": "Layla",
                "family_name": "Bartell-Boyle",
                "payment_reference": "nisi Ut amet non",
                "national_registration_number": "QQ999999A",
                "email_address": "Caden.Collins84@example.org",
                "phone_number": "+14006529317"
            }
        },
        "metadata": null
    }
}

Mandates

Cancel an existing mandate