# Get information for all standing orders

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

Endpoint: GET /accounts/{accountId}/standing-orders
Security: Bearer, BasicAuth

## Header parameters:

  - `on-behalf-of` (string, required)
    The tokenId represents the consent granted by the user (PSU).
    Example: "ta:3eYPU1BEKKunfmYgQuSKXFCeo851C5Y3XiZW3XA465TU:5zKtXEAq"

  - `token-customer-ip-address` (string)
    The user's IP address if the user is currently logged in with the TPP. If the customer  IP address is supplied (recommended), it is inferred that the user is present during the session (i.e., the request is user-initiated; adding a customer-initiated = true header makes this explicit). For AIS calls, if the customer's IP address is not provided in the request, the bank assumes it is a TPP-initiated request and may limit the TPP to 4 TPP-initiated access attempts within a given 24-hour period.
    Example: "172.16.254.1"

## Path parameters:

  - `accountId` (string)
    The unique bank account id, which specifies the account for which the information is requested.
    Example: "a:8DbPteGnytmMbKXdnWTReeRB6cYWKXZ84JgLTBC7fKL4:5zKcENpV"

## Query parameters:

  - `page.offset` (string)
    The offset for the current page. If the offset has been provided in the request, this offset will be equal to the provided one. But if no offset was provided in the request (i.e. this is the first page) and the page is not empty, this field will be populated with a non-empty string. This may be helpful for loading the same page again, which might not always be possible with an empty offset due to a dynamic nature of the data. The offset is not visible to a user and should not be parsed and/or understood in any way.
    Example: "LerV6Jmex"

  - `page.limit` (integer, required)
    The maximum number of records to return. This must be less than 200.
    Example: 175

## Response 200 fields (application/json):

  - `offset` (string)
    The offset of the first item returned in the collection.
    Example: "LerV6Jmex"

  - `standingOrders` (array)

  - `standingOrders.createdAtMs` (string)
    Specifies the time the transfer was created; timestamp (UTC) in milliseconds, 1 day (24 hours) = 8640000000, 1 hour = 36000000, and 1 minute = 60000.
    Example: 1729212980771

  - `standingOrders.creditorEndpoint` (object)

  - `standingOrders.creditorEndpoint.account` (object)
    Specifies information about the bank account.

  - `standingOrders.creditorEndpoint.accountFeatures` (object)
    Open Banking features supported for this account.

  - `standingOrders.creditorEndpoint.accountFeatures.supportsInformation` (boolean)
    An account available for AIS operations.

  - `standingOrders.creditorEndpoint.accountFeatures.supportsReceivePayment` (boolean)
    An account that can receive money transfers.

  - `standingOrders.creditorEndpoint.accountFeatures.supportsSendPayment` (boolean)
    An account that can send money transfers.

  - `standingOrders.creditorEndpoint.metadata` (object)
    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.

  - `standingOrders.creditorEndpoint.accountIdentifier` (object)
    Account numbers and other strings that identify this as a unique bank account.

  - `standingOrders.creditorEndpoint.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.e., API-only integration when EMBEDDED_HOSTED_PAGES is selected in flowType, or Hosted Pages embedded (modal) integration.
    Example: "ob-modelo"

  - `standingOrders.creditorEndpoint.bic` (string)
    The Business Identifier Code (BIC), ISO 9362, 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."
    Example: "BOFIIE2D"

  - `standingOrders.creditorEndpoint.customerData` (object)
    Specifies the legal identity information for the account. This information is not required for settlement accounts.

  - `standingOrders.creditorEndpoint.customerData.address` (object)
    The complete postal address of a party.

  - `standingOrders.creditorEndpoint.customerData.address.city` (string)
    Name of the city as given in postal addresses of the building/area.
    Example: "Berlin"

  - `standingOrders.creditorEndpoint.customerData.address.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.
    Example: "2831"

  - `standingOrders.creditorEndpoint.customerData.address.country` (string)
    Two-letter country code in upper case (ISO 3166-1 alpha-2).
    Example: "DE"

  - `standingOrders.creditorEndpoint.customerData.address.district` (string)
    A defined district within the city or country containing the address.
    Example: "Friedrichshain"

  - `standingOrders.creditorEndpoint.customerData.address.flats` (string)
    House numbers (range or list) of flats behind a door.
    Example: "21A - 21C"

  - `standingOrders.creditorEndpoint.customerData.address.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.
    Example: "Fifth house on the left after the village oak, Smalltown, Smallcountry"

  - `standingOrders.creditorEndpoint.customerData.address.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.
    Example: "Botzowviertel"

  - `standingOrders.creditorEndpoint.customerData.address.houseName` (string)
    The name of a house. Sometimes used in countries like England instead of (or in addition to) a house number.
    Example: "Grossen Blauen Haus"

  - `standingOrders.creditorEndpoint.customerData.address.houseNumber` (string)
    The house number (may contain letters, dashes, or other characters). This identifies a single building with multiple addresses.
    Example: "123"

  - `standingOrders.creditorEndpoint.customerData.address.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.
    Example: "Arnswalder Platz"

  - `standingOrders.creditorEndpoint.customerData.address.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.
    Example: "10243"

  - `standingOrders.creditorEndpoint.customerData.address.province` (string)
    For Canada, uppercase two-letter postal abbreviations, e.g., BC, AB, ON, QC.
    Example: "BC"

  - `standingOrders.creditorEndpoint.customerData.address.state` (string)
    For the US, uppercase two-letter postal abbreviations, e.g., AK, CA, HI, NY, TX, WY.
    Example: "CA"

  - `standingOrders.creditorEndpoint.customerData.address.street` (string)
    the name of the respective street in which the dwelling or business is located or where mail is received.
    Example: "Hans-Otto-Strasse"

  - `standingOrders.creditorEndpoint.customerData.address.subdistrict` (string)
    A smaller, readily identifiable part of a district.
    Example: "Friedrichshain Nord"

  - `standingOrders.creditorEndpoint.customerData.address.suburb` (string)
    Suburbs and localities are the names of geographic subdivisions of urban areas in Australia.
    Example: "Altona Meadows Suburb"

  - `standingOrders.creditorEndpoint.customerData.legalNames` (array)
    The legal owner name for the account.
    Example: "Mr John Arthur Smith"

  - `standingOrders.frequency` (string)
    Specifies the ISO 20022 code for the scheduled frequency of standing order payments occurring between the first and final payments. Options:DAIL - daily/once a dayWEEK - weekly/once a weekTOWK - twice weekly/two times a weekMNTH - monthly/once a monthTOMN - twice monthly/two times a monthQUTR - quarterly/once every three monthsSEMI - semi-annually/twice a yearYEAR - annually/once a year
    Example: "WEEK"

  - `standingOrders.id` (string)
    The standing order identifier; labelled standingOrderId in specific standing order access requests.
    Example: "tt:83KiRJuXmEDV5m2b8ZvLGE91ELf7PPw5BaDab98kMguu:3VMczyq7r7b6HwC"

  - `standingOrders.providerStandingOrderDetails` (object)

  - `standingOrders.providerStandingOrderDetails.cma9StandingOrderDetails` (object)
    Specifies applicable non-standard (varied frequency and payment amount) recurring payment instructions and schedule.

  - `standingOrders.providerStandingOrderDetails.cma9StandingOrderDetails.creditorAccount` (object)
    Specifies the payee's account with the creditor.

  - `standingOrders.providerStandingOrderDetails.cma9StandingOrderDetails.creditorAccount.identification` (string)

  - `standingOrders.providerStandingOrderDetails.cma9StandingOrderDetails.creditorAccount.name` (string)

  - `standingOrders.providerStandingOrderDetails.cma9StandingOrderDetails.creditorAccount.schemeName` (string)

  - `standingOrders.providerStandingOrderDetails.cma9StandingOrderDetails.finalPaymentAmount` (object)
    The balance currency and value.

  - `standingOrders.providerStandingOrderDetails.cma9StandingOrderDetails.finalPaymentAmount.currency` (string, required)
    The ISO 4217 three letter currency code.
    Example: "EUR"

  - `standingOrders.providerStandingOrderDetails.cma9StandingOrderDetails.finalPaymentAmount.value` (string, required)
    The transaction amount with up to four digits after the decimal point.
    Example: "10.23"

  - `standingOrders.providerStandingOrderDetails.cma9StandingOrderDetails.finalPaymentDateTime` (string)
    The date and time of the final payment made under the standing order.

  - `standingOrders.providerStandingOrderDetails.cma9StandingOrderDetails.firstPaymentAmount` (object)
    The balance currency and value.

  - `standingOrders.providerStandingOrderDetails.cma9StandingOrderDetails.firstPaymentAmount.currency` (string, required)
    The ISO 4217 three letter currency code.
    Example: "EUR"

  - `standingOrders.providerStandingOrderDetails.cma9StandingOrderDetails.firstPaymentAmount.value` (string, required)
    The transaction amount with up to four digits after the decimal point.
    Example: "10.23"

  - `standingOrders.providerStandingOrderDetails.cma9StandingOrderDetails.firstPaymentDateTime` (string)
    The date and time of the first payment made under the standing order.

  - `standingOrders.providerStandingOrderDetails.cma9StandingOrderDetails.frequency` (string)
    Specifies the ISO 20022 code for the scheduled frequency of standing order payments occurring between the first and final payments. Options:DAIL - daily/once a dayWEEK - weekly/once a weekTOWK - twice weekly/two times a weekMNTH - monthly/once a monthTOMN - twice monthly/two times a monthQUTR - quarterly/once every three monthsSEMI - semi-annually/twice a yearYEAR - annually/once a year
    Example: "WEEK"

  - `standingOrders.providerStandingOrderDetails.cma9StandingOrderDetails.nextPaymentAmount` (object)
    The balance currency and value.

  - `standingOrders.providerStandingOrderDetails.cma9StandingOrderDetails.nextPaymentAmount.currency` (string, required)
    The ISO 4217 three letter currency code.
    Example: "EUR"

  - `standingOrders.providerStandingOrderDetails.cma9StandingOrderDetails.nextPaymentAmount.value` (string, required)
    The transaction amount with up to four digits after the decimal point.
    Example: "10.23"

  - `standingOrders.providerStandingOrderDetails.cma9StandingOrderDetails.nextPaymentDateTime` (string)
    The Date and time of the next standing order payment.

  - `standingOrders.providerStandingOrderDetails.cma9StandingOrderDetails.numberOfPayments` (integer)
    The number of payments made under the standing order.

  - `standingOrders.providerStandingOrderDetails.cma9StandingOrderDetails.reference` (string)
    The reference for the CMA9 standing order.

  - `standingOrders.status` (string)
    The current status of the standing order.
    Enum: "INVALID", "ACTIVE", "INACTIVE", "PROCESSING", "FAILED", "UNKNOWN"

  - `standingOrders.tokenId` (string)
    Access token ID of the account information request authorised by the account holder.
    Example: "tt:8zK1dic95omjWb72gvc3z3ELKbTNfnGd89MbDnM73er4:ZhBVAJSH8DeU1"

  - `standingOrders.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.
    Example: "12345678"

  - `status` (string)
    Specifies the status of the request.
    Enum: "INVALID_REQUEST", "SUCCESSFUL_REQUEST", "MORE_SIGNATURES_NEEDED"

## Response 400 fields (application/json):

  - `error` (object)
    The request does not have valid authentication credentials needed to perform the operation.

  - `error.message` (string)
    A description of the error.
    Example: "This is a description of the error."

  - `error.tokenTraceId` (string)
    The trace identifier for the given call.
    Example: "5678912345"

## Response 401 fields (application/json):

  - `error` (object)
    The request does not have valid authentication credentials needed to perform the operation.

  - `error.message` (string)
    A description of the error.
    Example: "This is a description of the error."

  - `error.tokenTraceId` (string)
    The trace identifier for the given call.
    Example: "5678912345"

## Response 403 fields (application/json):

  - `error` (object, required)
    The error returned when the member is not authorized to perform the given operation: PermissionDenied. This error message will be accompanied by the reason from the bank. Typically this means the access token has expired and the user must re-authenticate with the bank.

  - `error.errorCode` (string, required)
    A textual error code categorising the error.
    Example: "InternalServerError"

  - `error.message` (string, required)
    A description of the error that occurred and a possible way to fix it.
    Example: "This is a description of the error."

  - `error.tokenTraceId` (string)
    The trace identifier for the given call.
    Example: "5678912345"

## Response 404 fields (application/json):

  - `error` (object, required)
    The error object returned when given payment cannot be found: ResourceNotFound.

  - `error.errorCode` (string, required)
    A textual error code categorising the error.
    Example: "InternalServerError"

  - `error.paymentId` (string, required)
    The requested entity, the paymentID, was not found.
    Example: "pm2:12345abcd:abcde"

  - `error.message` (string, required)
    A description of the error that occurred and a possible way to fix it.
    Example: "This is a description of the error."

  - `error.tokenTraceId` (string)
    The trace identifier for the given call.
    Example: "5678912345"

## Response 429 fields (application/json):

  - `error` (object, required)
    Resource exhausted. Too many requests.

  - `error.errorCode` (string, required)
    A textual error code categorising the error.
    Example: "InternalServerError"

  - `error.paymentId` (string, required)
    The maximum number of requests has been reached.
    Example: "Resource exhausted. Check quota."

  - `error.message` (string, required)
    A description of the error that occurred and a possible way to fix it.
    Example: "This is a description of the error."

  - `error.tokenTraceId` (string)
    The trace identifier for the given call.
    Example: "5678912345"

## Response 500 fields (application/json):

  - `error` (object)
    This could refer to either an error by the payment service provider or the bank. When the bank reports a 5xx error, "token-external-error": "true" is set as a header in the HTTP response, indicating that the "internal" error originates from the bank. When one of the payment service providers internal services fails or when the bank reports a 4xx error, this header is not populated. The absence of this response header should be interpreted as "token-external-error": "false".

  - `error.errorCode` (string, required)
    This is a textual error code categorising the error.
    Example: "InternalServerError"

  - `error.message` (string, required)
    A description of the error.
    Example: "This is a description of the error."

  - `error.tokenTraceId` (string)
    The trace identifier for the given call.
    Example: "5678912345"

## Response 501 fields (application/json):

  - `error` (object, required)
    The operation was not implemented, supported or enabled by the bank.

  - `error.errorCode` (string, required)
    A textual error code categorising the error.
    Example: "InternalServerError"

  - `error.paymentId` (string, required)
    The operation was not implemented,supported or enabled by the bank.
    Example: "Not implemented."

  - `error.message` (string, required)
    A description of the error that occurred and a possible way to fix it.
    Example: "This is a description of the error."

  - `error.tokenTraceId` (string)
    The trace identifier for the given call.
    Example: "5678912345"

## Response 503 fields (application/json):

  - `error` (object, required)
    Service is unavailable, likely due to a transient condition; this is usually corrected with a retry.

  - `error.errorCode` (string, required)
    A textual error code categorising the error.
    Example: "InternalServerError"

  - `error.paymentId` (string, required)
    The service is unavailable, likely due to a transient condition; this is usually corrected with a retry.
    Example: "Unavailable"

  - `error.message` (string, required)
    A description of the error that occurred and a possible way to fix it.
    Example: "This is a description of the error."

  - `error.tokenTraceId` (string)
    The trace identifier for the given call.
    Example: "5678912345"

## Response 504 fields (application/json):

  - `error` (object, required)
    The deadline expired before the operation could complete.

  - `error.errorCode` (string, required)
    A textual error code categorising the error.
    Example: "InternalServerError"

  - `error.paymentId` (string, required)
    The deadline expired before the operation could complete.
    Example: "Deadline exceeded."

  - `error.message` (string, required)
    A description of the error that occurred and a possible way to fix it.
    Example: "This is a description of the error."

  - `error.tokenTraceId` (string)
    The trace identifier for the given call.
    Example: "5678912345"