> ## Documentation Index > Fetch the complete documentation index at: https://docs.openfinance-hackathon.com/llms.txt > Use this file to discover all available pages before exploring further. # Get Standing Orders > **The list below outlines the Consent Permissions that are applicable to this resource:** * ReadStandingOrdersBasic * ReadStandingOrdersDetail Refer to *Customer Experience Guidelines*, *Account Information*, *Data Groups* for further information. ## OpenAPI ````yaml open-finance-api/yaml/uae-account-information-openapi.yaml get /accounts/{AccountId}/standing-orders openapi: 3.0.0 info: title: UAE Account Information API description: '## UAE Open Finance Account Information API Specification' version: v1.2 servers: - url: /open-finance/account-information/v1.2 security: [] tags: - name: Account Access description: Account Access Consents Resource - name: Accounts description: Accounts Resource - name: Balances description: Balances Resource - name: Beneficiaries description: Beneficiaries Resource - name: Direct Debits description: Direct Debits Resource - name: Product description: Product Resource - name: Scheduled Payments description: Scheduled Payments Resource - name: Standing Orders description: Standing Orders Resource - name: Transactions description: Transactions Resource - name: Consents description: Consents Resource - name: Parties description: Parties Resource paths: /accounts/{AccountId}/standing-orders: get: tags: - Standing Orders summary: Get Standing Orders description: > **The list below outlines the Consent Permissions that are applicable to this resource:** * ReadStandingOrdersBasic * ReadStandingOrdersDetail Refer to *Customer Experience Guidelines*, *Account Information*, *Data Groups* for further information. operationId: GetAccountsAccountIdStandingOrders parameters: - $ref: '#/components/parameters/AccountId' - $ref: '#/components/parameters/x-fapi-auth-date' - $ref: '#/components/parameters/x-fapi-customer-ip-address' - $ref: '#/components/parameters/x-fapi-interaction-id' - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/x-customer-user-agent' responses: '200': $ref: '#/components/responses/200AccountsAccountIdStandingOrdersRead' '400': $ref: '#/components/responses/400Error' '401': $ref: '#/components/responses/401Error' '403': $ref: '#/components/responses/403Error' '404': $ref: '#/components/responses/404Error' '405': $ref: '#/components/responses/405Error' '406': $ref: '#/components/responses/406Error' '429': $ref: '#/components/responses/429Error' '500': $ref: '#/components/responses/500Error' security: - UserOAuth2Security: - openid - accounts components: parameters: AccountId: name: AccountId in: path description: AccountId required: true schema: type: string x-fapi-auth-date: in: header name: x-fapi-auth-date required: false description: >- The time when the User last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC schema: type: string pattern: >- ^(Mon|Tue|Wed|Thu|Fri|Sat|Sun), \d{2} (Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec) \d{4} \d{2}:\d{2}:\d{2} (GMT|UTC)$ x-fapi-customer-ip-address: in: header name: x-fapi-customer-ip-address required: false description: The User's IP address if the User is currently logged in with the TPP. schema: type: string x-fapi-interaction-id: in: header name: x-fapi-interaction-id required: false description: An RFC4122 UID used as a correlation id. schema: type: string Authorization: name: authorization in: header required: true description: An authorization Token as per https://tools.ietf.org/html/rfc6750 schema: type: string x-customer-user-agent: in: header name: x-customer-user-agent description: Indicates the user-agent that the User is using. required: false schema: type: string responses: 200AccountsAccountIdStandingOrdersRead: description: Standing Orders Read headers: x-fapi-interaction-id: required: true description: An RFC4122 UID used as a correlation id. schema: type: string content: application/json; charset=utf-8: schema: $ref: '#/components/schemas/AEReadStandingOrder' application/json: schema: $ref: '#/components/schemas/AEReadStandingOrder' application/jwt: schema: $ref: '#/components/schemas/AEReadStandingOrderSigned' 400Error: description: Bad request headers: x-fapi-interaction-id: required: true description: An RFC4122 UID used as a correlation id. schema: type: string content: application/json; charset=utf-8: schema: $ref: '#/components/schemas/AEErrorResponse' application/json: schema: $ref: '#/components/schemas/AEErrorResponse' application/jwt: schema: $ref: '#/components/schemas/AEErrorResponseSigned' 401Error: description: Unauthorized headers: x-fapi-interaction-id: required: true description: An RFC4122 UID used as a correlation id. schema: type: string 403Error: description: Forbidden headers: x-fapi-interaction-id: required: true description: An RFC4122 UID used as a correlation id. schema: type: string content: application/json; charset=utf-8: schema: $ref: '#/components/schemas/AEErrorResponse' application/json: schema: $ref: '#/components/schemas/AEErrorResponse' application/jwt: schema: $ref: '#/components/schemas/AEErrorResponseSigned' 404Error: description: Not found headers: x-fapi-interaction-id: required: true description: An RFC4122 UID used as a correlation id. schema: type: string 405Error: description: Method Not Allowed headers: x-fapi-interaction-id: required: true description: An RFC4122 UID used as a correlation id. schema: type: string 406Error: description: Not Acceptable headers: x-fapi-interaction-id: required: true description: An RFC4122 UID used as a correlation id. schema: type: string 429Error: description: Too Many Requests headers: Retry-After: description: Number in seconds to wait schema: type: integer x-fapi-interaction-id: description: An RFC4122 UID used as a correlation id. schema: type: string 500Error: description: Internal Server Error headers: x-fapi-interaction-id: required: true description: An RFC4122 UID used as a correlation id. schema: type: string content: application/json; charset=utf-8: schema: $ref: '#/components/schemas/AEErrorResponse' application/json: schema: $ref: '#/components/schemas/AEErrorResponse' application/jwt: schema: $ref: '#/components/schemas/AEErrorResponseSigned' schemas: AEReadStandingOrder: description: List of Standing Orders for an Account type: object required: - Data - Links - Meta properties: Data: type: object description: Primary data for the resource required: - AccountId - StandingOrder properties: AccountId: $ref: '#/components/schemas/AccountId' StandingOrder: type: array items: $ref: '#/components/schemas/AEStandingOrder' additionalProperties: false Links: $ref: '#/components/schemas/Links' Meta: $ref: '#/components/schemas/MetaTotalPages' additionalProperties: false AEReadStandingOrderSigned: allOf: - $ref: '#/components/schemas/Jwt' - type: object properties: message: $ref: '#/components/schemas/AEReadStandingOrder' required: - message additionalProperties: false AEErrorResponse: description: >- An array of detail error codes, and messages, and URLs to documentation to help remediation. type: object properties: Errors: items: $ref: '#/components/schemas/AEError' type: array minItems: 1 required: - Errors additionalProperties: false AEErrorResponseSigned: allOf: - $ref: '#/components/schemas/Jwt' - type: object properties: message: $ref: '#/components/schemas/AEErrorResponse' required: - message additionalProperties: false AccountId: description: >- A unique and immutable identifier produced by the LFI to identify the account resource.This identifier has no meaning to the account owner (User 1). type: string minLength: 1 maxLength: 40 AEStandingOrder: description: Standing Orders for a specific AccountId type: object required: - Frequency - StandingOrderId - FirstPaymentDateTime - StandingOrderStatusCode - FirstPaymentAmount properties: StandingOrderId: $ref: '#/components/schemas/StandingOrderId' AccountHolderName: $ref: '#/components/schemas/AccountHolderName' AccountHolderShortName: $ref: '#/components/schemas/AccountHolderShortName' StandingOrderType: $ref: '#/components/schemas/StandingOrderType' Frequency: $ref: '#/components/schemas/Frequency' CreditorReference: $ref: '#/components/schemas/Reference' Purpose: $ref: '#/components/schemas/PurposeSO' FirstPaymentDateTime: $ref: '#/components/schemas/FirstPaymentDateTime' NextPaymentDateTime: $ref: '#/components/schemas/NextPaymentDateTime' LastPaymentDateTime: $ref: '#/components/schemas/LastPaymentDateTime' FinalPaymentDateTime: $ref: '#/components/schemas/FinalPaymentDateTime' NumberOfPayments: $ref: '#/components/schemas/NumberOfPayments' StandingOrderStatusCode: $ref: '#/components/schemas/AEExternalStandingOrderStatusCode' FirstPaymentAmount: $ref: '#/components/schemas/AEActiveOrHistoricCurrencyAndAmount_2' NextPaymentAmount: $ref: '#/components/schemas/AEActiveOrHistoricCurrencyAndAmount_3' LastPaymentAmount: $ref: '#/components/schemas/AEActiveOrHistoricCurrencyAndAmount_7' FinalPaymentAmount: $ref: '#/components/schemas/AEActiveOrHistoricCurrencyAndAmount_4' CreditorAgent: $ref: >- #/components/schemas/AEBranchAndFinancialInstitutionIdentification5_1 CreditorAccount: type: array items: $ref: '#/components/schemas/AECashAccount5_0' SupplementaryData: $ref: '#/components/schemas/AESupplementaryData' additionalProperties: false Links: description: Links relevant to the resource required: - Self properties: Self: $ref: '#/components/schemas/Self' First: $ref: '#/components/schemas/First' Prev: $ref: '#/components/schemas/Prev' Next: $ref: '#/components/schemas/Next' Last: $ref: '#/components/schemas/Last' additionalProperties: false MetaTotalPages: description: Meta Data relevant to the resource type: object required: - TotalPages properties: TotalPages: $ref: '#/components/schemas/TotalPages' additionalProperties: false Jwt: description: > [https://www.rfc-editor.org/rfc/rfc7519](https://www.rfc-editor.org/rfc/rfc7519) type: object properties: iss: description: > [https://www.rfc-editor.org/rfc/rfc7519#section-4.1.1](https://www.rfc-editor.org/rfc/rfc7519#section-4.1.1) type: string exp: description: > [https://www.rfc-editor.org/rfc/rfc7519#section-4.1.4](https://www.rfc-editor.org/rfc/rfc7519#section-4.1.4) type: number nbf: description: > [https://www.rfc-editor.org/rfc/rfc7519#section-4.1.5](https://www.rfc-editor.org/rfc/rfc7519#section-4.1.5) type: number aud: description: > [https://www.rfc-editor.org/rfc/rfc7519#section-4.1.3](https://www.rfc-editor.org/rfc/rfc7519#section-4.1.3) type: array items: type: string iat: description: > [https://www.rfc-editor.org/rfc/rfc7519#section-4.1.6](https://www.rfc-editor.org/rfc/rfc7519#section-4.1.6) type: number required: - iss - exp - nbf additionalProperties: false AEError: description: Error type: object properties: Code: description: Low level textual error code, e.g., Field.Missing type: string enum: - AccessToken.Unauthorized - AccessToken.InvalidScope - Consent.Revoked - Consent.TransientAccountAccessFailure - Consent.AccountTemporarilyBlocked - Consent.PermanentAccountAccessFailure - Consent.Invalid - JWS.InvalidSignature - JWS.Malformed - JWS.InvalidClaim - JWS.InvalidHeader - GenericRecoverableError - GenericError - JWE.DecryptionError - JWE.InvalidHeader - Event.UnexpectedEvent - Body.InvalidFormat - Resource.InvalidResourceId - Resource.InvalidFormat - Consent.BusinessRuleViolation Message: description: >- A description of the error that occurred. e.g., 'A mandatory field isn't supplied' or 'RequestedExecutionDateTime must be in future' UAEOF doesn't standardise this field type: string minLength: 1 maxLength: 500 Path: description: >- Recommended but optional reference to the JSON Path of the field with error, e.g., Data.Initiation.InstructedAmount.Currency type: string minLength: 1 maxLength: 500 Url: description: >- URL to help remediate the problem, or provide more information, or to API Reference, or help etc type: string required: - Code - Message additionalProperties: false minProperties: 1 StandingOrderId: description: >- A unique and immutable identifier produced by the LFI to identify the account resource. This identifier has no meaning to the account owner. type: string minLength: 1 maxLength: 40 AccountHolderName: type: string description: > * /accounts resource The Account Holder Name is the name or names of the Account owner(s) represented at the account level * /accounts/{AccountId} resource The Account Holder Name is the name or names of the Account owner(s) represented at the account level * /beneficiaries resource The Account Holder Name is the name or names of the Beneficiary account owner(s) represented at the account level, as displayed by the Creditor Agent's online channels and as provided by the Beneficiary to the User 1 when adding the Beneficiary in the Beneficiary list. Note, the Account Holder Name is not the product name or the nickname of the account. * /scheduled-payments resource The Account Holder Name is the name or names of the Beneficiary account owner(s) represented at the account level, as displayed by the Creditor Agent's online channels and as provided by the Beneficiary to the User 1 when adding the Beneficiary in the Beneficiary list. Note, the Account Holder Name is not the product name or the nickname of the account. * /standing-orders resource The Account Holder Name is the name or names of the Beneficiary account owner(s) represented at the account level, as displayed by the Creditor Agent's online channels and as provided by the Beneficiary to the User 1 when adding the Beneficiary in the Beneficiary list. Note, the Account Holder Name is not the product name or the nickname of the account. AccountHolderShortName: type: string description: | * /accounts resource The Account holder nick name * /accounts/{AccountId} resource The Account holder nick name * /beneficiaries resource The Beneficiary account holder nick name * /scheduled-payments resource The Beneficiary account holder nick name * /standing-orders resource The Beneficiary account holder nick name StandingOrderType: description: The type of Standing Order. type: string enum: - BetweenMyAccounts - SameBankTransfer - LocalBankTransfer - InternationalTransfer - Charity Frequency: type: string minLength: 1 maxLength: 35 description: > * The frequency that the Standing Order payments are executed from the User1s account. Encoded with allowable values as follows: * Individual Definitions: NotKnown - SO frequency is not known (i.e. not provided) EveryDay - SO frequency is Every day EveryWorkingDay - SO frequency is every working day IntervalDay - SO frequency is an interval specified in number of calendar days (2 to 31) IntervalWeekDay - SO frequency is an interval specified in weeks (1 to 51), and the day within the week (1 to 7) WeekInMonthDay - SO frequency is a monthly interval, specifying the week of the month (1 to 5) and day within the week (1 to 7) IntervalMonthDay - SO frequency is an interval specified in months (between 1 to 6, 12, 24), specifying the day within the month (-5 to -1, 1 to 31) QuarterDay - SO frequency is quarterly RECEIVED BiAnnual - SO frequency is every 6 months Annual - SO frequency is every year RECEIVED = Paid on the 20th March, 19th June, 24th September and 20th December. * Individual Patterns: NotKnown (ScheduleCode) EveryDay (ScheduleCode) EveryWorkingDay (ScheduleCode) IntervalDay:NoOfDay (ScheduleCode + NoOfDay) IntervalWeekDay:IntervalInWeeks:DayInWeek (ScheduleCode + IntervalInWeeks + DayInWeek) WeekInMonthDay:WeekInMonth:DayInWeek (ScheduleCode + WeekInMonth + DayInWeek) IntervalMonthDay:IntervalInMonths:DayInMonth (ScheduleCode + IntervalInMonths + DayInMonth) QuarterDay: + either (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 EveryDay EveryWorkingDay IntervalDay:(([2-9])|([1-2][0-9])|3[0-1]) IntervalWeekDay:[1-51]:[1-7] WeekInMonthDay:[1-5]:[1-7] IntervalMonthDay:([1-6]|12|24):(-[1-5]|[1-9]|[12][0-9]|3[01]) QuarterDay:(RECEIVED) * Full Regular Expression: ^(NotKnown)$|^(EveryDay)$|^(EveryWorkingDay)$|^(IntervalDay:(([2-9])|([1-2][0-9])|3[0-1]))$|^(IntervalWeekDay:[1-51]:[1-7])$|^(WeekInMonthDay:[1-5]:[1-7])$|^(IntervalMonthDay:([1-6]|12|24):(-[1-5]|[1-9]|[12][0-9]|3[01]))$|^(QuarterDay:(RECEIVED))$" type: "string" pattern: "^(NotKnown)$|^(EveryDay)$|^(EveryWorkingDay)$|^(IntervalDay:(([2-9])|([1-2][0-9])|3[0-1]))$|^(IntervalWeekDay:[1-51]:[1-7])$|^(WeekInMonthDay:[1-5]:[1-7])$|^(IntervalMonthDay:([1-6]|12|24):(-[1-5]|[1-9]|[12][0-9]|3[01]))$|^(QuarterDay:(RECEIVED))$" Reference: description: >- Unique reference in the context of the creditor, provided by the creditor to the User1 (Debtor), to unambiguously refer to the payment transaction. Usage: If available, the initiating party (i.e. Debtor) provides this reference in the structured remittance information, to enable reconciliation by the Creditor upon receipt of the amount of money. This field is populated by the User 1 (who is the initiating party of the payment e.g. the Debtor). Field is free format text type: string minLength: 1 maxLength: 35 PurposeSO: description: > The purpose of the Standing Order payment. A free format string in the form of transaction categorisation. Example: "Bills and expenses", "Government payment", "Personal Expenses". type: string minLength: 1 maxLength: 50 FirstPaymentDateTime: description: >- The date on which the first 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 type: string format: date-time NextPaymentDateTime: description: >- 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 type: string format: date-time LastPaymentDateTime: description: >- 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 type: string format: date-time FinalPaymentDateTime: description: >- The date on which the final 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 type: string format: date-time NumberOfPayments: description: >- Number of the payments that will be made in completing this frequency sequence including any executed since the sequence start date. type: string minLength: 1 maxLength: 35 AEExternalStandingOrderStatusCode: description: Specifies the status of the standing order in code form. type: string enum: - Active - Inactive AEActiveOrHistoricCurrencyAndAmount_2: type: object required: - Amount - Currency description: The amount of the first Standing Order properties: Amount: $ref: '#/components/schemas/AEActiveCurrencyAndAmount_SimpleType' Currency: $ref: '#/components/schemas/ActiveOrHistoricCurrencyCode_1' additionalProperties: false AEActiveOrHistoricCurrencyAndAmount_3: type: object required: - Amount - Currency description: The amount of the next Standing Order. properties: Amount: $ref: '#/components/schemas/AEActiveCurrencyAndAmount_SimpleType' Currency: $ref: '#/components/schemas/ActiveOrHistoricCurrencyCode_1' additionalProperties: false AEActiveOrHistoricCurrencyAndAmount_7: type: object required: - Amount - Currency description: The amount of the last (most recent) Standing Order instruction. properties: Amount: $ref: '#/components/schemas/AEActiveCurrencyAndAmount_SimpleType' Currency: $ref: '#/components/schemas/ActiveOrHistoricCurrencyCode_1' additionalProperties: false AEActiveOrHistoricCurrencyAndAmount_4: type: object required: - Amount - Currency description: The amount of the final Standing Order properties: Amount: $ref: '#/components/schemas/AEActiveCurrencyAndAmount_SimpleType' Currency: $ref: '#/components/schemas/ActiveOrHistoricCurrencyCode_1' additionalProperties: false AEBranchAndFinancialInstitutionIdentification5_1: type: object required: - SchemeName - Identification description: > Creditor Agent refers to the Financial Institution that manages the account on behalf of the scheduled payment beneficiary party, managing registration, booking of entries on the account, calculating balances on the account and providing information about the account. This is the servicing Financial Institution of the Beneficiary account. properties: SchemeName: $ref: >- #/components/schemas/AEExternalFinancialInstitutionIdentificationCode Identification: $ref: '#/components/schemas/Identification_1' additionalProperties: false AECashAccount5_0: type: object required: - SchemeName - Identification description: Provides the details to identify the beneficiary account. properties: SchemeName: $ref: '#/components/schemas/AEExternalAccountIdentificationCode1' Identification: $ref: '#/components/schemas/Identification_0' additionalProperties: false AESupplementaryData: type: object properties: {} additionalProperties: false description: >- Additional information that can not be captured in the structured fields and/or any other specific block. Self: description: A link to the current resource type: string format: uri First: description: A link to the first page in a paginated result set type: string format: uri Prev: description: A link to the previous page in a paginated result set type: string format: uri Next: description: A link to the next page in a paginated result set type: string format: uri Last: description: A link to the last page in a paginated result set type: string format: uri TotalPages: description: Total number of Pages where a result set is paginated type: integer format: int32 minimum: 0 AEActiveCurrencyAndAmount_SimpleType: description: >- A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217. type: string pattern: ^\d{1,13}$|^\d{1,13}\.\d{1,5}$ ActiveOrHistoricCurrencyCode_1: description: >- A 3 character alphabetic code allocated to a currency under an international currency identification scheme, as described in the latest edition of the international standard ISO 4217 'Codes for the representation of currencies and funds'. type: string pattern: ^[A-Z]{3,3}$ example: AED AEExternalFinancialInstitutionIdentificationCode: description: > * /accounts resource The name of the identification scheme for the LFI as the account services provider. Encoded with allowable value as published in an external list. * /beneficiaries resource Refers to the Financial Institution that manages the account on behalf of the Beneficiary party, managing registration, booking of entries on the account, calculating balances on the account and providing information about the account. This is the servicing Financial Institution of the Beneficiary account. * /scheduled-payments resource Refers to the identification scheme for uniquely identifying the Creditor Agent. * /standing-orders resource Refers to the identification scheme for uniquely identifying the Creditor Agent. * /transactions resource Refers to the identification scheme for uniquely identifying the Creditor Agent. type: string enum: - BICFI - Other Identification_1: description: > * /accounts resource Unique and unambiguous identification of the LFI as the account servicing institution for the Open Banking Services. * /beneficiaries resource Unique and unambiguous identification of the Creditor Agency as the servicing institution of the Beneficiary. * /scheduled-payments resource Unique and unambiguous identification of the LFI as the account servicing institution for the Open Banking Services. * /standing-orders resource Unique and unambiguous identification of the LFI as the account servicing institution for the Open Banking Services. * /transactions resource Unique and unambiguous identification of the LFI as the account servicing institution for the Open Banking Services. * Notes: Based on the value of the field **SchemeName**, this entry may be : * BICFI: The BIC/SWIFT Code * Other: The ID; A Country Code followed by a Bank Code (4 character code). type: string minLength: 1 maxLength: 35 AEExternalAccountIdentificationCode1: description: >- Name of the identification scheme for the account. Encoded with allowable values published in an external list. type: string enum: - IBAN - AccountNumber - MaskedPAN - MobileNumber - UtilityName - EWallet Identification_0: description: > Identification for the account assigned by the LFI based on the Account Scheme Name. This identification is known by the User 1 account owner. For IBAN, refer to the ISO Standard 13616. type: string minLength: 1 maxLength: 400 securitySchemes: UserOAuth2Security: type: oauth2 description: >- [OAuth2 PAR flow](https://datatracker.ietf.org/doc/html/rfc9126), it is required when the User needs to perform SCA with the LFI when a TPP wants to access an LFI resource owned by the User. **Please refer to [OpenID FAPI Security Profile 1.0 -Part 2 Advanced](https://openid.net/specs/openid-financial-api-part-2-1_0.html#authorization-server) - 5.2.2 point 14 - shall authenticate the confidential client using one of the following methods private_key_jwt and [OpenID Connect Core 1.0](https://openid.net/specs/openid-connect-core-1_0.html#ClientAuthentication) 9. Client Authentication private_key_jwt** flows: authorizationCode: authorizationUrl: https://authserver.example/authorization tokenUrl: https://authserver.example/token scopes: openid: Activates OpenID Connect Support accounts: >- Ability to read Accounts Information. This is a parameterized scope with the ConsentId ````