---
title: "Get Scheduled Payments"
method: GET
path: "/data/v2/accounts/{account_id}/scheduled-payments"
tags: ["Scheduled Payments Raw Data"]
---

# Get Scheduled Payments

`GET /data/v2/accounts/{account_id}/scheduled-payments`

Get the scheduled payments for a specific account given an accountId. 
The accountId can be found by making a call to the /accounts endpoint. 
Requires the following permissions: `scheduled_payments`

## Path parameters

- `account_id` string, uuid, required

## Query parameters

- `async` boolean
- `page` integer
- `size` integer
- `entity_id` string, uuid
- `meta` string

## Response `200`

OK

- ScheduledPaymentsResult
  - `status` 'OK' | 'PENDING' | 'FAILED' | 'CONSENT_EXPIRED' | 'RECONNECT_REQUIRED' | 'PROCESSING_STARTED', required — The status of the request
  - `results_id` string, uuid, required — The unique identifier for the request
  - `message` string, required — A message describing the status of the request
  - `meta` object, nullable — Meta information about the request
  - `timestamp` string, date-time, required — The datetime of when the request was made
  - `status_detail` StatusDetail, nullable
    - `granular_status_code` string, nullable — Granular status code
    - `status_additional_info` string, nullable — Additional information about the status
  - `refreshed_at` string, date-time, nullable — The datetime of when the data was refreshed
  - `type` string, nullable — The endpoint the original request was made to.
  - `data` ScheduledPaymentsData
    - `type` 'scheduled-payments', required — The endpoint the original request was made to.
    - `page` PageMetadata — Metadata about the current page of results
      - `number` integer, required — The current page being returned by the API
      - `size` integer, required — The page size requested
      - `total_elements` integer, required — The total number of elements in all pages
      - `total_pages` integer, required — The total number of pages retrievable
      - `sort` string[] — Sort parameters applied to the results
    - `scheduled_payments` ScheduledPayment[] — An array of scheduled payments associated with the account.
      - `entity_id` string, uuid — The unique identifier for the entity. Provided as a UUID.
      - `account_id` string — Account ID for the bank account
      - `account_holder_name` string — Full name of the account holder
      - `account_holder_short_name` unknown
      - `scheduled_payment_id` string — Scheduled payment ID
      - `scheduled_type` 'ARRIVAL' | 'EXECUTION' | 'UNSUPPORTED' — Specifies the scheduled payment date type requested
      - `scheduled_payment_date_time` string, date-time — The date on which the scheduled payment will be made.
      - `debtor_reference` string — A reference value provided by the user (i.e. the Debtor) to the PISP while setting up the scheduled payment.
      - `instructed_amount` CurrencyAmount
        - `currency` string, required — The ISO 3 letter currency code
        - `amount` number, required — The amount of money in the currency specified.
      - `creditor_agent` CreditorAgent
        - `identification_type` string — identification_type
        - `identification` string — Unique identification of the servicing institution.
        - `name` string — Name of the agent or institution
        - `postal_address` PostalAddressSau
          - `address_type` string — Identifies the nature of the postal address.
          - `short_address` string — Abbreviated form of the address.
          - `building_number` string — Number that identifies the position of a building on a street.
          - `unit_number` string — Number identifying a specific unit within a building.
          - `street_name` string — Name of a street or thoroughfare.
          - `secondary_number` string — Additional number used to identify a location.
          - `district` string — District or neighborhood name within a city.
          - `postal_code` string — Identifier consisting of a group of letters and/or numbers that is added to a postal address.
          - `city` string — Name of the city.
          - `country` string — Nation with its own government.
      - `creditor_account` AccountIdentification
        - `scheme_name` 'PAN' | 'IBAN' | 'BBAN' | 'COMMERCIAL_REGISTRATION_NUMBER' | 'EMAIL' | 'MOBILE_NUMBER' | 'NATIONAL_ID' | 'IQAMA_NUMBER' | 'PASSPORT_NUMBER' | 'OTHER' | 'UNSUPPORTED' — The scheme name of the account identification value
        - `identification` string — The identification value for the account assigned by the Bank based on the Account Scheme Name.
        - `name` string — Account name

## Other responses

- `202` — Accepted (Asynchronous request)
- `400` — Bad Request
- `404` — Account or entity not found
- `500` — Internal Server Error

---

[API](https://skmtc.net/leantech/apis/auth.md) · [All operations](https://skmtc.net/leantech/apis/auth/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/leantech/auth/revisions/c2e46d54d886/schema)