---
title: "Get information for all standing orders"
method: GET
path: "/accounts/{accountId}/standing-orders"
tags: ["Accounts"]
---

# Get information for all standing orders

`GET /accounts/{accountId}/standing-orders`

The `GET /accounts/{accountId}/standing-orders` endpoint retrieves information for all standing orders in a given account, once consent has been given.

## Path parameters

- `accountId` string

## Query parameters

- `page.offset` string
- `page.limit` integer, required

## Headers

- `on-behalf-of` string, required
- `token-customer-ip-address` string, ipv4

## Response `200`

Successful response

- GetStandingOrdersResponse
  - `offset` string — The offset of the first item returned in the collection.
  - `standingOrders` StandingOrder[]
    - `createdAtMs` string, string — Specifies the time the transfer was created; timestamp (UTC) in milliseconds, 1 day (24 hours) = 8640000000, 1 hour = 36000000, and 1 minute = 60000.
    - `creditorEndpoint` CreditorEndpoint
      - `account` union — Specifies information about the bank account.
        - object
          - `custom` Custom — Custom authorization.
            - `bankId` string — The Token.io id of the bank where the consent is created. **This field is required if the customer is not using Token.io's Hosted Pages for bank selection, <i>i.e.</i>, API-only integration when `EMBEDDED_HOSTED_PAGES` is selected in `flowType`, or Hosted Pages embedded (modal) integration.**
            - `payload` string — The standing order payload.
        - object
          - `domestic` Domestic — A domestic bank account in the UK.
            - `accountNumber` string — The unique identifier for the bank account.
            - `bankCode` string — The number assigned to a branch of a bank, typically containing six digits and most commonly used in the UK and Ireland.
            - `country` string — Two-letter country code in upper case (ISO 3166-1 alpha-2).
        - object
          - `iban` Iban
            - `bic` string — The Business Identifier Code (BIC), <a href="https://www.iso.org/standard/84108.html" target="_blank">ISO 9362</a>, is the SWIFT Address assigned to a bank in order to send automated payments quickly and accurately to the banks concerned. It uniquely identifies the name and country, (and sometimes the branch) of the bank involved. BICs are often called SWIFT Codes and can be either 8 or 11 characters long."
            - `iban` string — The International Bank Account Number. This consists of a two-letter country code followed by two check digits and up to thirty-five alphanumeric characters.
        - object
          - `token` StandingOrderToken
            - `accountId` string — The account id. Available account ids can be found in the account info consent.
            - `memberId` string — The Token.io-generated member id for the user/account holder.
      - `accountFeatures` AccountFeatures — Open Banking features supported for this account.
        - `supportsInformation` boolean — An account available for AIS operations.
        - `supportsReceivePayment` boolean — An account that can receive money transfers.
        - `supportsSendPayment` boolean — An account that can send money transfers.
      - `metadata` StandingOrderMetadataEntry — Additional fields returned by the bank at its option in response to your particular request. The presence and type of metadata are entirely dependent on the bank and generally comprise additional information about the account or the transaction pertinent to your specific use case. How you use this information, when included in the bank's response, is at your discretion.
      - `accountIdentifier` union — Account numbers and other strings that identify this as a unique bank account.
        - object
          - `bankgiro` AccountIdentifierBankgiro, required — The identifier for domestic bank accounts in Sweden.
            - `bankgiroNumber` string — The unique identifier for the bank account in Sweden (known in Swedish as Bankgironummer); it consists of 7 or 8 digits; the clearing code is not used.
        - object
          - `bban` AccountIdentifierBban, required
            - `bban` string — Represents a country-specific bank account number. The BBAN is the last part of the IBAN when used for international funds transfers. Every country has its own specific BBAN format and length. At present, there is no common EU or other standard unifying the BBAN. This is why IBAN was introduced to standardise international bank transfers.
            - `clearingNumber` string — The bank clearing number or BC number is a number used for the identification of financial institutions in Switzerland and Liechtenstein. Bank clearing numbers are connected to the Swiss Interbank Clearing and the EuroSIC system.
        - object
          - `gbDomestic` AccountIdentifierGbDomestic, required — A domestic bank account in the UK.
            - `accountNumber` string — The unique identifier for the bank account in the UK or Ireland.
            - `sortCode` string — The number assigned to a branch of a bank, typically containing six digits and most commonly used in the UK and Ireland.
        - object
          - `iban` AccountIdentifierIban, required — The International Bank Account Number, used when sending interbank transfers or wiring money from one bank to another, especially across international borders.
            - `iban` string — The International Bank Account Number. This consists of a two-letter country code followed by two check digits and up to thirty-five alphanumeric characters.
        - object
          - `msisdn` AccountIdentifierMsisdn, required — The Mobile Station International Subscriber Director Number (MSISDN) is the user's mobile phone number, used as a unique identifier to enable routing of voice and SMS traffic to and from a specific subscription/device on a wireless/mobile network.
            - `msisdn` string — The MSISDN is composed of the country code and the national destination code. Ensure you remove the + sign and any 0 before the mobile number.
        - object
          - `pan` AccountIdentifierPan, required — The Primary Account Number (PAN). The card identifier found on payment cards, such as credit cards and debit cards, as well as stored-value cards, gift cards and other similar card, sometimes referred to as a bank card number.
            - `pan` string — The 14, 15, or 16 digit number generated as a unique identifier for a primary account.
        - object
          - `plusgiro` AccountIdentifierPlusgiro — The domestic transaction clearing system in Sweden. The credit transfer function, which is part of <a href="https://www.nordea.com" target="blank">Nordea</a>, and used for mediating payments between accounts held by companies and individuals.
            - `plusgiroNumber` string — The account number (minimum 2 and maximum 8 digits) for a PlusGiro account. The clearing code is not used.
        - object
          - `token` AccountIdentifierToken, required — The primary account number; the card identifier found on payment cards, such as credit cards and debit cards, as well as stored-value cards, gift cards and other similar card, sometimes referred to as a bank card number.
            - `accountId` string — The bank account identifier for a linked account used by Token.io's Bank Integration Account Linking Service.
            - `memberId` string — The Token.io-generated member id for the user/account holder.
      - `bankId` string — The Token.io id of the bank where the consent is created. **This field is required if the customer is not using Token.io's Hosted Pages for bank selection, <i>i.e.</i>, API-only integration when `EMBEDDED_HOSTED_PAGES` is selected in `flowType`, or Hosted Pages embedded (modal) integration.**
      - `bic` string — The Business Identifier Code (BIC), <a href="https://www.iso.org/standard/84108.html" target="_blank">ISO 9362</a>, is the SWIFT Address assigned to a bank in order to send automated payments quickly and accurately to the banks concerned. It uniquely identifies the name and country, (and sometimes the branch) of the bank involved. BICs are often called SWIFT Codes and can be either 8 or 11 characters long."
      - `customerData` CustomerData — Specifies the legal identity information for the account. This information is not required for settlement accounts.
        - `address` AddressInfo — The complete postal address of a party.
          - `city` string — Name of the city as given in postal addresses of the building/area.
          - `conscriptionNumber` string — A special kind of house number. This relates to a settlement instead of a street. Conscription numbers are in use in some parts of Europe, sometimes together with street-related house numbers, which are also called orientation numbers.
          - `country` string — Two-letter country code in upper case (ISO 3166-1 alpha-2).
          - `district` string — A defined district within the city or country containing the address.
          - `flats` string — House numbers (range or list) of flats behind a door.
          - `full` string — This is used for a full-text, often multi-line address if you find the structured address fields unsuitable for denoting the address of this particular location. Typically such strings cannot be parsed by software.
          - `hamlet` string — A small settlement. In different jurisdictions and geographies, a hamlet may be the size of a town, village, or parish, or may be considered to be a smaller settlement or subdivision or satellite entity to a larger settlement.
          - `houseName` string — The name of a house. Sometimes used in countries like England instead of (or in addition to) a house number.
          - `houseNumber` string — The house number (may contain letters, dashes, or other characters). This identifies a single building with multiple addresses.
          - `place` string — The part of an address which refers to the name of some territorial zone (like an island or square) instead of a street. It should not be included together with `street`.
          - `postCode` string — An identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
          - `province` string — For Canada, uppercase two-letter postal abbreviations, <i>e.g.</i>, BC, AB, ON, QC.
          - `state` string — For the US, uppercase two-letter postal abbreviations, <i>e.g.</i>, AK, CA, HI, NY, TX, WY.
          - `street` string — the name of the respective street in which the dwelling or business is located or where mail is received.
          - `subdistrict` string — A smaller, readily identifiable part of a district.
          - `suburb` string — Suburbs and localities are the names of geographic subdivisions of urban areas in Australia.
        - `legalNames` string[] — The legal owner name for the account.
    - `frequency` string — Specifies the <a href="https://www.iso.org/standard/55005.html" target="_blank">ISO 20022</a> code for the scheduled frequency of standing order payments occurring between the first and final payments. Options:<ul><li>DAIL - daily/once a day</li><li>WEEK - weekly/once a week</li><li>TOWK - twice weekly/two times a week</li><li>MNTH - monthly/once a month</li><li>TOMN - twice monthly/two times a month</li><li>QUTR - quarterly/once every three months</li><li>SEMI - semi-annually/twice a year</li><li>YEAR - annually/once a year</li></ul>
    - `id` string — The standing order identifier; labelled standingOrderId in specific standing order access requests.
    - `providerStandingOrderDetails` ProviderStandingOrderDetails
      - `cma9StandingOrderDetails` Cma9StandingOrderDetails — Specifies applicable non-standard (varied frequency and payment amount) recurring payment instructions and schedule.
        - `creditorAccount` object — Specifies the payee's account with the creditor.
          - `identification` string
          - `name` string
          - `schemeName` string
        - `finalPaymentAmount` object — The amount of the final payment.
          - `currency` string, required — The <a href="https://www.iso.org/iso-4217-currency-codes.html" target="_blank">ISO 4217</a> three letter currency code.
          - `value` string, required — The transaction amount with up to four digits after the decimal point.
        - `finalPaymentDateTime` string — The date and time of the final payment made under the standing order.
        - `firstPaymentAmount` object — The amount of the first payment.
          - `currency` string, required — The <a href="https://www.iso.org/iso-4217-currency-codes.html" target="_blank">ISO 4217</a> three letter currency code.
          - `value` string, required — The transaction amount with up to four digits after the decimal point.
        - `firstPaymentDateTime` string — The date and time of the first payment made under the standing order.
        - `frequency` string — Specifies the <a href="https://www.iso.org/standard/55005.html" target="_blank">ISO 20022</a> code for the scheduled frequency of standing order payments occurring between the first and final payments. Options:<ul><li>DAIL - daily/once a day</li><li>WEEK - weekly/once a week</li><li>TOWK - twice weekly/two times a week</li><li>MNTH - monthly/once a month</li><li>TOMN - twice monthly/two times a month</li><li>QUTR - quarterly/once every three months</li><li>SEMI - semi-annually/twice a year</li><li>YEAR - annually/once a year</li></ul>
        - `nextPaymentAmount` object — The amount of the next payment.
          - `currency` string, required — The <a href="https://www.iso.org/iso-4217-currency-codes.html" target="_blank">ISO 4217</a> three letter currency code.
          - `value` string, required — The transaction amount with up to four digits after the decimal point.
        - `nextPaymentDateTime` string — The Date and time of the next standing order payment.
        - `numberOfPayments` integer — The number of payments made under the standing order.
        - `reference` string — The reference for the CMA9 standing order.
    - `status` 'INVALID' | 'ACTIVE' | 'INACTIVE' | 'PROCESSING' | 'FAILED' | 'UNKNOWN' — The current status of the standing order.
    - `tokenId` string — Access token ID of the account information request authorised by the account holder.
    - `tokenSubmissionId` string — The submission ID of the standing order information request; it points to the token submission and is only set for Token.io standing orders.
  - `status` 'INVALID_REQUEST' | 'SUCCESSFUL_REQUEST' | 'MORE_SIGNATURES_NEEDED' — Specifies the status of the request.

## Other responses

- `400` — The client specified an invalid argument
- `401` — The authorization information is missing or invalid
- `403` — Permission to access this endpoint is denied
- `404` — The requested entity, such as a payment, was not found
- `429` — Too many requests
- `500` — An unexpected or internal server error
- `501` — The operation was not implemented
- `503` — Service is unavailable
- `504` — Gateway has timed out

---

[API](https://skmtc.net/token/apis/token-io-s-open-banking-api-for-tpps.md) · [All operations](https://skmtc.net/token/apis/token-io-s-open-banking-api-for-tpps/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/token/token-io-s-open-banking-api-for-tpps/versions/5e8d6d2c24a1/schema)
