Get a Mandate

Developing

Cloud Mock

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

GET

/mandates/{mandate_id}

OperationId:get_mandate_by_id

Provides a means to return an ordered, pages list of mandates of a given status. The madates will be return ordered by 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.

Path Params

Responses

🟢200Success

application/json

Body

🟠404Record Not Found

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://mock.apidog.com/m1/828215-0-default/mandates/' \
--header 'x-api-key: <api-key>' \
--header 'Authorization: Bearer <token>'

Response Example

{
    "results": {
        "mandates": [
            {
                "mandate": {
                    "start_date": "2024-09-10T09:46:41.096Z",
                    "end_date": "2024-12-20T06:29:48.267Z",
                    "authorisation_source": "web",
                    "status": "active",
                    "limitations": {
                        "currency": "BRL",
                        "maximum_payment_amount": 634.15,
                        "percentage_of_payment_amount_accepted": 357.38
                    },
                    "id": "cb6f2d8a-dcd0-4201-a8b9-ec8184418045",
                    "initiator_data": {
                        "consumer_data": {
                            "given_name": "Kelsie",
                            "family_name": "Murazik",
                            "biller_reference": "esse eiusmod commodo",
                            "metadata": {
                                "nulla_8": [
                                    "mollit",
                                    "velit cillum aliquip laborum",
                                    "reprehenderit aliquip"
                                ],
                                "sit_e9": [
                                    "ut reprehenderit Lorem Duis magna",
                                    "fugiat quis et",
                                    "ad"
                                ]
                            }
                        }
                    }
                }
            },
            {
                "mandate": {
                    "start_date": "2024-06-12T05:26:27.820Z",
                    "end_date": "2024-12-24T12:23:54.507Z",
                    "authorisation_source": "web",
                    "status": "active",
                    "limitations": {
                        "currency": "ZMW",
                        "maximum_payment_amount": 926.39,
                        "percentage_of_payment_amount_accepted": 398.44
                    },
                    "id": "d54c0864-a82c-4f44-8d21-bc44b85faf68",
                    "initiator_data": {
                        "consumer_data": {
                            "given_name": "Clyde",
                            "family_name": "Marvin",
                            "biller_reference": "dolore in eu",
                            "metadata": {
                                "ipsum_1e": [
                                    "in et minim adipisicing reprehenderit",
                                    "nulla adipisicing magna dolore anim"
                                ]
                            }
                        }
                    }
                }
            }
        ],
        "paging": {
            "start_index": 7650998689901040,
            "count": 1706613042299189,
            "previous_page": "http://api.ontime.co/mandates/search?start_index=0&limit=50",
            "next_page": "http://api.ontime.co/mandates/search?start_index=51&limit=50"
        }
    }
}

Cancel an existing mandate

Get many Mandates