---
title: "Get Standing Orders"
method: GET
path: "/standing-orders"
tags: ["Standing Orders"]
---

# Get Standing Orders

`GET /standing-orders`

Enables an AISP to retrieve Standing Order information for account(s) that the PSU has consented to.

## Headers

- `x-fapi-auth-date` string
- `x-fapi-customer-ip-address` string
- `x-fapi-interaction-id` string
- `Authorization` string, required
- `x-customer-user-agent` string
- `x-client-id` string

## Response `200`

Standing Orders Read

- OBReadStandingOrder6
  - `Data` object, required
    - `StandingOrder` OBStandingOrder6[]
      - `AccountId` string, required — A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner.
      - `StandingOrderId` string — A unique and immutable identifier used to identify the standing order resource. This identifier has no meaning to the account owner.
      - `NextPaymentDateTime` string, date-time — The date on which the next payment for a Standing Order schedule will be made. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
      - `LastPaymentDateTime` string, date-time — The date on which the last (most recent) payment for a Standing Order schedule was made. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
      - `NumberOfPayments` string — Number of the payments that will be made in completing this frequency sequence including any executed since the sequence start date.
      - `StandingOrderStatusCode` 'ACTV' | 'CANC' | 'EXPI' | 'SUSP' — Specifies the status of the standing order in code form. For a full list of enumeration values refer to 'ExternalMandateStatus1Code' in *ISO_External_Codeset* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)
      - `FirstPaymentAmount` OBActiveOrHistoricCurrencyAndAmount2 — The amount of the first Standing Order
        - `Amount` string, required — A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
        - `Currency` string, required — A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
      - `NextPaymentAmount` OBActiveOrHistoricCurrencyAndAmount3 — The amount of the next Standing Order.
        - `Amount` string, required — A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
        - `Currency` string, required — A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
      - `LastPaymentAmount` OBActiveOrHistoricCurrencyAndAmount11 — The amount of the last (most recent) Standing Order instruction.
        - `Amount` string, required — A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
        - `Currency` string, required — A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
      - `FinalPaymentAmount` OBActiveOrHistoricCurrencyAndAmount4 — The amount of the final Standing Order
        - `Amount` string, required — A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
        - `Currency` string, required — A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
      - `CreditorAgent` OBBranchAndFinancialInstitutionIdentification51 — Party that manages the account on behalf of the account owner, that is manages the registration and booking of entries on the account, calculates balances on the account and provides information about the account. This is the servicer of the beneficiary account.
        - `SchemeName` string, required — Name of the identification scheme, in a coded form as published in an external list.<br/> For a full list of enumeration values refer to `OBInternalFinancialInstitutionIdentification4Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)
        - `Identification` string, required — Unique and unambiguous identification of the servicing institution.
        - `Name` string — Name by which an agent is known and which is usually used to identify that agent.
        - `PostalAddress` OBPostalAddress7 — Information that locates and identifies a specific address, as defined by postal services.
          - `AddressType` 'BIZZ' | 'DLVY' | 'MLTO' | 'PBOX' | 'ADDR' | 'HOME' | 'CORR' | 'STAT' — Identifies the nature of the postal address. <br /> For a full set of codes see `OBAddressType2Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets).
          - `Department` string — Identification of a division of a large organisation or building.
          - `SubDepartment` string — Identification of a sub-division of a large organisation or building.
          - `StreetName` string — Name of a street or thoroughfare.
          - `BuildingNumber` string — Number that identifies the position of a building on a street.
          - `BuildingName` string — Name of a referenced building.
          - `Floor` string — Number that identifies the level within a building
          - `UnitNumber` string — Number that identifies the unit of a specific address .
          - `Room` string — Information that locates and identifies a room to form part of an address
          - `PostBox` string — Information that locates and identifies a box in a post office assigned to a person or organization, where letters for them are kept until called for.
          - `TownLocationName` string — Name of a built-up area, with defined boundaries, and a local government.
          - `DistrictName` string — Number that of the regional area, known as a district, which forms part of an address
          - `CareOf` string — The 'care of' address is used whenever sending mail to a person or organisation who does not actually live or work at the address. They will receive the mail for the individual.
          - `PostCode` string — Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
          - `TownName` string — Name of a built-up area, with defined boundaries, and a local government.
          - `CountrySubDivision` string — Identifies a subdivision of a country such as state, region, county.
          - `Country` string — Nation with its own government.
          - `AddressLine` string[]
        - `LEI` string — Legal entity identification as an alternate identification for a party. Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)".
      - `CreditorAccount` OBCashAccount51 — Provides the details to identify the beneficiary account.
        - `SchemeName` string, required — Name of the identification scheme, in a coded form as published in an external list. <br /> For a full list of enumeration values refer to `OBInternalAccountIdentification4Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)
        - `Identification` string, required — Beneficiary account identification.
        - `Name` string — The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels. Note, the account name is not the product name or the nickname of the account.
        - `SecondaryIdentification` string — This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).
        - `Proxy` OBProxy1 — Specifies an alternate assumed name for the identification of the account.
          - `Identification` string, required — Identification used to indicate the account identification under another specified name.
          - `Code` 'TELE' | 'EMAL' | 'DNAM' | 'CINC' | 'COTX' | 'COID' | 'CUST' | 'DRLC' | 'EIDN' | 'EWAL' | 'PVTX' | 'LEIC' | 'MBNO' | 'NIDN' | 'CCPT' | 'SHID' | 'SOSE' | 'TOKN' | 'UBIL' | 'VIPN' | 'BIID', required — Specifies the external proxy account type code, as published in the proxy account type external code set.<br /> For more information and a full list of values see `ExternalProxyAccountType1Code` in *ISO_External_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)
          - `Type` string — Type of the proxy identification.
      - `SupplementaryData` OBSupplementaryData1 — Additional information that can not be captured in the structured fields and/or any other specific block.
      - `MandateRelatedInformation` OBMandateRelatedInformation1 — Provides further details of the mandate signed between the creditor and the debtor.
        - `MandateIdentification` string — Unique identification, as assigned by the creditor, to unambiguously identify the mandate.
        - `Classification` 'FIXE' | 'USGB' | 'VARI' — Type of mandate instruction. For a full list of values see `OBExternalClassification1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)
        - `CategoryPurposeCode` 'BONU' | 'CASH' | 'CBLK' | 'CCRD' | 'CGWV' | 'CIPC' | 'CONC' | 'CORT' | 'DCRD' | 'DIVI' | 'DVPM' | 'EPAY' | 'FCDT' | 'FCIN' | 'FCOL' | 'GOVT' | 'GP2P' | 'HEDG' | 'ICCP' | 'IDCP' | 'INTC' | 'INTE' | 'LBOX' | 'LOAN' | 'MP2B' | 'MP2P' | 'OTHR' | 'PENS' | 'RPRE' | 'RRCT' | 'RVPM' | 'SALA' | 'SECU' | 'SSBE' | 'SUPP' | 'SWEP' | 'TAXS' | 'TOPG' | 'TRAD' | 'TREA' | 'VATX' | 'VOST' | 'WHLD' | 'ZABA' — Enumeration of codes that outlines the type of purpose behind a transaction, payment or risk. For all enum values see `ExternalCategoryPurpose1Code` in *ISO_External_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)
        - `FirstPaymentDateTime` string, date-time — The date on which the first payment for a recurrent credit transfer will be made.
        - `RecurringPaymentDateTime` string, date-time — The date on which the first recurring payment for a Standing Order schedule will be made. Usage: This must be populated only if the first recurring date is different to the first payment date. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
        - `FinalPaymentDateTime` string, date-time — The date on which the final payment for a recurrent credit transfer will be made.
        - `Frequency` OBFrequency6, required — Regularity with which credit transfer instructions are to be created and processed
          - `Type` union, required
            - 'ADHO' | 'YEAR' | 'DAIL' | 'FRTN' | 'INDA' | 'MNTH' | 'QURT' | 'MIAN' | 'WEEK' | 'WODL' | 'FOWK' | 'TWMH' | 'FOMH' | 'FIMH' | 'ALMH' | 'NONE' | 'LWMH' | 'LXMH' | 'TWYR' — For a full list of values see `OBFrequency6Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)
            - string — Individual Definitions: NotKnown - Not Known EvryDay - Every day EvryWorkgDay - Every working day IntrvlDay - An interval specified in number of calendar days (02 to 31) IntrvlWkDay - An interval specified in weeks (01 to 09), and the day within the week (01 to 07) WkInMnthDay - A monthly interval, specifying the week of the month (01 to 05) and day within the week (01 to 07) IntrvlMnthDay - An interval specified in months (between 01 to 06, 12, 24), specifying the day within the month (-05 to -01, 01 to 31) QtrDay - Quarterly (either ENGLISH, SCOTTISH, or RECEIVED) ENGLISH = Paid on the 25th March, 24th June, 29th September and 25th December. SCOTTISH = Paid on the 2nd February, 15th May, 1st August and 11th November. RECEIVED = Paid on the 20th March, 19th June, 24th September and 20th December. Individual Patterns: NotKnown (ScheduleCode) EvryDay (ScheduleCode) EvryWorkgDay (ScheduleCode) IntrvlDay:NoOfDay (ScheduleCode + NoOfDay) IntrvlWkDay:IntervalInWeeks:DayInWeek (ScheduleCode + IntervalInWeeks + DayInWeek) WkInMnthDay:WeekInMonth:DayInWeek (ScheduleCode + WeekInMonth + DayInWeek) IntrvlMnthDay:IntervalInMonths:DayInMonth (ScheduleCode + IntervalInMonths + DayInMonth) QtrDay: + either (ENGLISH, SCOTTISH or RECEIVED) ScheduleCode + QuarterDay The regular expression for this element combines five smaller versions for each permitted pattern. To aid legibility - the components are presented individually here: NotKnown EvryDay EvryWorkgDay IntrvlDay:((0[2-9])|([1-2][0-9])|3[0-1]) IntrvlWkDay:0[1-9]:0[1-7] WkInMnthDay:0[1-5]:0[1-7] IntrvlMnthDay:(0[1-6]|12|24):(-0[1-5]|0[1-9]|[12][0-9]|3[01]) QtrDay:(ENGLISH|SCOTTISH|RECEIVED) Full Regular Expression: ^(NotKnown)$|^(EvryDay)$|^(EvryWorkgDay)$|^(IntrvlDay:((0[2-9])|([1-2][0-9])|3[0-1]))$|^(IntrvlWkDay:0[1-9]:0[1-7])$|^(WkInMnthDay:0[1-5]:0[1-7])$|^(IntrvlMnthDay:(0[1-6]|12|24):(-0[1-5]|0[1-9]|[12][0-9]|3[01]))$|^(QtrDay:(ENGLISH|SCOTTISH|RECEIVED))$
          - `CountPerPeriod` integer — Number of instructions to be created and processed during the specified period. Specifies a frequency in terms of a count per period within a specified frequency type. Note: should not be used alongside `PointInTime`
          - `PointInTime` string — Exact2NumericText - Further information on the exact point in time the event should take place. Specifies a frequency in terms of an exact point in time or moment within a specified frequency type. Note: should not be used alongside `CountPerPeriod`.
        - `Reason` string — Reason for the setup of the credit transfer mandate.
      - `RemittanceInformation` OBRemittanceInformation2 — Information supplied to enable the matching of an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts' receivable system
        - `Structured` OBRemittanceInformationStructured[]
          - `ReferredDocumentInformation` OBReferredDocumentInformation[]
            - `Code` 'AROI' | 'BOLD' | 'CINV' | 'CMCN' | 'CNFA' | 'CONT' | 'CREN' | 'DEBN' | 'DISP' | 'DNFA' | 'HIRI' | 'INVS' | 'MSIN' | 'PROF' | 'PUOR' | 'QUOT' | 'SBIN' | 'SOAC' | 'SPRR' | 'TISH' | 'TSUT' | 'USAR' | 'VCHR' — Specifies the document type as published in an external document type code list. For more information see `ExternalDocumentType1Code` in *ISO_External_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)
            - `Issuer` string — Identification of the issuer of the reference document type.
            - `Number` string — Identification of the type specified for the referred document line.
            - `RelatedDate` string, date-time — Date associated with the referred document line.
            - `LineDetails` string[] — Set of elements used to provide the content of the referred document line.
          - `ReferredDocumentAmount` string — A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
          - `CreditorReferenceInformation` object — Reference information provided by the creditor to allow the identification of the underlying documents.
            - `Code` 'DISP' | 'FXDR' | 'PUOR' | 'RPIN' | 'RADM' | 'SCOR' — Specifies the type of creditor reference as published in an external creditor reference type code set. For more information see `ExternalCreditorReferenceType1Code` in *ISO_External_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)
            - `Issuer` string — Entity that assigns the identification.
            - `Reference` string — Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction.
          - `Invoicer` string — Identification of the organisation issuing the invoice, when it is different from the creditor or ultimate creditor
          - `Invoicee` string — Identification of the party to whom an invoice is issued, when it is different from the debtor or ultimate debtor.
          - `TaxRemittance` string — Provides remittance information about a payment made for tax-related purposes.
          - `AdditionalRemittanceInformation` string[] — Additional information, in free text form, to complement the structured remittance information.
        - `Unstructured` string[] — Information supplied to enable the matching/reconciliation of an entry with the items that the payment is intended to settle, such as commercial invoices in an accounts' receivable system, in an unstructured form.
  - `Links` Links — Links relevant to the payload
    - `Self` string, uri, required
    - `First` string, uri
    - `Prev` string, uri
    - `Next` string, uri
    - `Last` string, uri
  - `Meta` Meta — Meta Data relevant to the payload
    - `TotalPages` integer
    - `FirstAvailableDateTime` string, date-time — All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
    - `LastAvailableDateTime` string, date-time — All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

## Other responses

- `400` — Bad request
- `401` — Unauthorized
- `403` — Forbidden
- `404` — Not found
- `405` — Method Not Allowed
- `406` — Not Acceptable
- `429` — Too Many Requests
- `500` — Internal Server Error

---

[API](https://skmtc.net/openbankinguk/apis/account-and-transaction-api-specification.md) · [All operations](https://skmtc.net/openbankinguk/apis/account-and-transaction-api-specification/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/openbankinguk/account-and-transaction-api-specification/revisions/b1c449c8ecb0/schema)