Get many Mandates

Developing

Cloud Mock

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

GET

/mandates/search

OperationId:get_filtered_mandates

Provides a means to return an ordered, pages list of mandates of a given status. The madates will be return in the order of the date they were created.

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:read-Can read payment mandates.

Query Params

Responses

🟢200Success

application/json

Body

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://mock.apidog.com/m1/828215-0-default/mandates/search?status&cursor=0&limit=50' \
--header 'x-api-key: <api-key>' \
--header 'Authorization: Bearer <token>'

Response Example

{
    "results": {
        "mandates": [
            {
                "mandate_record": {
                    "start_date": "2025-12-30T05:12:47.710Z",
                    "end_date": "2025-05-11T02:34:29.609Z",
                    "authorisation_source": "web",
                    "status": "string",
                    "limitations": {
                        "currency": "TJS",
                        "maximum_payment_amount": 132600,
                        "percentage_of_payment_amount_accepted": 8
                    },
                    "id": "4e055866-1de4-4d76-9235-04da469dfe61",
                    "initiator_data": {
                        "consumer_data": {
                            "given_name": "Preston",
                            "family_name": "Dare",
                            "national_registration_number": "QQ999999A",
                            "email_address": "Jerrod.Roob@example.org",
                            "phone_number": "+16933072917"
                        }
                    },
                    "metadata": null
                }
            }
        ],
        "paging": {
            "limit": 5938,
            "has_more": true,
            "next_cursor": "9f367214-9776-d8dc-27b5-57e3ec3d4c11"
        }
    }
}

Get a Mandate

Payment Requests