Get a schedule

Developing

Cloud Mock

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

GET

schedules/{schedule_id}

OperationId:get_schedule_by_id

Returns the schedule matching the Id provided.

Request

Authorization

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:

schedules:read-Can read payment schedules.

Path Params

Responses

🟢200Success

application/json

Body

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://mock.apidog.com/m1/828215-0-defaultschedules/' \
--header 'Authorization: Bearer <token>'

Response Example

{
    "schedule_record": {
        "id": "d184efe4-1c16-4045-a3c9-d36937913fab",
        "mandate_id": "a113709e-c69d-4437-82de-d8053c665fce",
        "currency": "GBP",
        "total_amount": 15000,
        "instalments": [
            {
                "amount": 7500,
                "due_date": "2026-04-20",
                "payment_request_id": "1b3529ce-5630-4c32-aa43-0da7b1accc60"
            },
            {
                "amount": 7500,
                "due_date": "2026-10-31",
                "payment_request_id": "2ef2628c-4fb5-41d2-b2f2-2c22e6973153"
            }
        ],
        "schedule_status": "Provisioned",
        "metadata": null
    }
}

Cancel an existing schedule

Get many schedules