# Get Account Standing Orders source: https://developer.mastercard.com/open-banking-connect/documentation/aisfeatures/get-account-standing-orders/index.md ## Request overview {#request-overview} The goal of this request is to be able to retrieve the list of standing orders for the specified `accountid` from the ASPSP, based on the previously obtained `consentid`. ### Endpoint details {#endpoint-details} | **Endpoints/Resources** | **Method** | **API Profiles** | **Description** | |-------------------------------------------------------------------------------------------------------------|------------|------------------|---------------------------------------------------| | /accounts/account/standing-orders | `POST` | CMA9 | Returns a list of standing orders for the account | | The following sequence diagram shows the flow for obtaining a list of standing orders from a PSU's Account. | | | | | Diagram get_account_standing_orders | | | | ## Request scenario {#request-scenario} API Reference: `POST /accounts/account/standing-orders` #### Request header {#request-header} N/A #### Request body {#request-body} | **Name** | **Purpose** | **Required by** | **How it can be used** | **Condition** | **Multiplicity** | **Type** | **Description** | **Limitations/Parameters** | |----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------|------------------|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `requestInfo` | Includes information about request being processed | MC | This element encapsulates all request information sent to the API Service | M | 1..1 | Object | Set of elements used to define the request details | | | `xRequestId` | ID of the request, unique to the call, as determined by the TPP | TPP | A memorable ID could be used to support in a dispute | M | 1..1 | String UUID | Free field that allows for the addition of information that can be referenced for future use | pattern: `^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$` | | `consentId` | A unique reference to the account information consent stored by the ASPSP. This is required to enable subsequent account information requests related to the consent (for example, to request account or transaction details) | ASPSP | Pass this value as part of the account information requests related to the consent. | M | 1..1 | String | A unique reference to the account information consent stored by the ASPSP. Please note that this is not the original value generated by the ASPSP but a generated 'proxy' value related to that. | 1-256 | | `aspspId` | ID of a financial institution servicing the Accounts of the PSU | ASPSP | Identification of ASPSP | M | 1..1 | String | This element is used to specify the identification code of a financial institution which holds PSU accounts | pattern: `^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$` | | `isLivePsuRequest` | Indicates if PSU actively initiated request | ASPSP | Type of PSU request | O | 0..1 | Boolean | PSU request type | Boolean: true or false | | `psuIPAddress` | The forwarded IP address field consists of the corresponding HTTP request IP address field between PSU and TPP. | ASPSP | It shall be contained only if the PSU actively initiated this request | C | 0..1 | String | IP address of PSU's terminal device | 1-256 Required when isLivePsuRequest=true pattern: `(^(([0-9]` \| `[1-9][0-9]` \| `1[0-9]{2}` \| `2[0-4][0-9]` \| `25[0-5])\.){3}([0-9]` \| `[1-9][0-9]` \| `1[0-9]{2}` \| `2[0-4][0-9]` \| `25[0-5])$)` \| `(^(([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}` \| `([0-9a-fA-F]{1,4}:){1,7}:` \| `([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}` \| `([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}` \| `([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}` \| `([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}` \| `([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}` \| `[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})` \| `:((:[0-9a-fA-F]{1,4}){1,7}` \| `:)` \| `fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}` \| `::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]` \| `(2[0-4]` \| `1{0,1}[0-9]){0,1}[0-9])\.){3,3}(25[0-5]` \| `(2[0-4]` \| `1{0,1}[0-9]){0,1}[0-9])` \| `([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]` \| `(2[0-4]` \| `1{0,1}[0-9]){0,1}[0-9])\.){3,3}(25[0-5]` \| `(2[0-4]` \| `1{0,1}[0-9]){0,1}[0-9]))$)` | | `psuAgent` | Indicates the user-agent for the PSU. If the PSU is using the TPP's mobile app, make sure the mobile app user-agent string is different than browser-based user-agent strings. | ASPSP | If user-agent is supplied to ASPSP, then this information can be used by ASPSP's security mechanisms. To avoid rejections, it is recommended to include this field when providing isLivePsuRequest and psuIPAddress. | O | 0..1 | String | PSU's browser agent details | 1-256 | | `psuTppCustomerId` | This is an internal field used for billing. | MC | Used for reconciliation and clarifications | O | 0..1 | String | Identifier of the PSU in TPP system. | 1-256 | | `merchant` | Collect merchant data for reporting purposes | MC | Merchant data used for reporting or reconciliation purposes | O | 0..1 | Object | Set of elements used to define the merchant details | | | `id` | Merchant identification code to identify the merchant | MC | Unique Merchant identifier per TPP, which could be used for reporting/reconciliation purposes | M | 1..1 | String | Field is available for TPPs to enable capturing of a merchant ID | 1-256 | | `name` | Merchant name to identify the merchant | MC | Name of merchant | M | 1..1 | String | Field is available for TPPs to enable capturing of a merchant name | 1-256 | | `accountId` | A unique identifier used to identify the account resource. | ASPSP | Identification of account resource to fetch account data (Use the id received in Get List of Accounts response -- in the `resourceId` field) | M | 1..1 | String | Account reference identification as returned in the list of accounts. | 1-256 | | `limit` | Number of transactions to be returned in response | MC | Number of transactions on the page | M | 1..1 | Integer | Number of transactions returned | Min:1 | | `offset` | Offset value from which the next set of transactions will be returned | MC | Offset value used for pagination | O | 0..1 | String | Offset value obtained from previous calls to get next set of transactions | 1024 | | Tip: For an explanation of notations used, refer to **Open Banking General FAQ** in our [Frequently Asked Questions](https://developer.mastercard.com/open-banking-connect/documentation/frequently-asked-questions/index.md) section. | | | | | | | | | ### Response -- Success {#response--success} HTTP Response Code = 200, OK Tip: For a list of general response codes and error code structure see [Response and Error Codes](https://developer.mastercard.com/open-banking-connect/documentation/response-and-error-codes/index.md). For specific error codes for this feature see **Feature specific error codes** below.
#### Response header {#response-header} N/A #### Response body {#response-body} | **Name** | **Purpose** | **Required by** | **How it can be used** | **Condition** | **Multiplicity** | **Type** | **Description** | **Limitations/Parameters** | |-----------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------|-----------------------------------------------------------------------------------------------------------|---------------|------------------|----------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------| | `originalRequestInfo` | Returns original request information to the TPP | MC | This object contains original request information | M | 1..1 | Object | Original request information received from the TPP | N/A | | `xRequestId` | A memorable ID which could be used to support in a dispute | TPP | This element could be used for request-response tracking | M | 1..1 | String | Original xRequestId given by the client on request | -pattern: `^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$` | | `offset` | Offset value from which the next set of transactions should be returned | MC | Offset value used for pagination | O | 0..1 | String | Offset value for next call to get transactions | | | `standingOrders` | List of standing orders for a given accounts | TPP | List of standing orders in account | O | 0..\* | Object | Set of elements used to define the details of the standing order | - | | `standingOrderId` | A unique identifier used to identify the standing order resource. | TPP | Identification of standing order resource to fetch standing order data | O | 0..1 | String | Standing order identification | - | | `firstPayment` | Details of the first recurring payment for a standing order schedule | TPP | This element has the details of the first recurring payment for a standing order schedule. | O | 0..1 | Object | Set of elements used to define first payment's details | - | | `date` | The date of execution for the first recurring payment. | TPP | This element is used to show the first payment date. | O | 0..1 | String | First payment date | ISODateTime "YYYY-MM-DDThh:mm:ssTZD" | | `currency` | 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" | TPP | The currency of the amount used in transaction | O | 0..1 | string | Three letter ISO currency code | ISO 4217 ALPHA 3 CHAR | | `amount` | A number of monetary units specified in an active currency. | TPP | The amount of first recurring payment as billed to the account. | O | 0..1 | Decimal | Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party | Minimum:0 exclusiveMinimum: true- | | `nextPayment` | Details of the next recurring payment for a standing order schedule. | TPP | This element has the details of the next recurring payment for a standing order schedule. | O | 0..1 | Object | Set of elements used to define next payment's details. | | | `date` | The date of execution for the next recurring payment. | TPP | This element is used to show the next payment date. | O | 0..1 | String | The date on which the next payment for a standing order schedule is made | ISODateTime "YYYY-MM-DDThh:mm:ssTZD" | | `currency` | 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". | TPP | The currency of the amount used in transaction | O | 0..1 | String | Three letter ISO currency code | ISO 4217 ALPHA 3 CHAR | | `amount` | A number of monetary units specified in an active currency. | TPP | Amount of money of the next payment from the standing order instruction. | O | 0..1 | Decimal | Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party | Minimum:0 exclusiveMinimum: true- | | `finalPayment` | Details of the final recurring payment for a standing order schedule. | TPP | This element has the details of the final recurring payment for a standing order schedule. | O | 0..1 | Object | Set of elements used to define final payment's details. | | | `date` | The date of execution for the final recurring payment. | TPP | This element is used to show the final payment date. | O | 0..1 | String | The date on which the final payment for a standing order schedule is made. | ISODateTime "YYYY-MM-DDThh:mm:ssTZD" | | `currency` | 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". | TPP | The currency of the amount used in transaction | O | 0..1 | String | Three letter ISO currency code | ISO 4217 ALPHA 3 CHAR | | `amount` | A number of monetary units specified in an active currency. | TPP | Amount of money of the final payment from the standing order instruction. | O | 0..1 | Decimal | Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party | Minimum:0 exclusiveMinimum: true- | | `schedule` | Details of the standing order schedule. | TPP | This element has the details of the standing order schedule. | O | 0..1 | Object | Set of elements used to define details of standing order schedule. | | | `frequency` | Frequency rule for standing orders. | TPP | This element specifies the frequency of payment from the standing order. | O | 0..1 | String | This is a specific format of describing the rule for creating the payments of a standing order. It should comply with one of the permitted patterns. Full pattern represented as a regular expression which can be used for validating the value provided in this field: `^(EvryDay)$|^(EvryWorkgDay)$|^(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))$` | | | `recipientAccount` | Details of the account receiving a payment scheduled through a standing order. | TPP | This element specifies the details of the account receiving a payment scheduled through a standing order. | O | 0..1 | Object | Set of elements used to define details of recipient's account (creditor account). | | | `schemeName` | Name of the identification scheme in a coded form as published in an external list. | TPP | This field is used to identify the type of Identification used to identify an account. | O | 0..1 | String | Account scheme name. | | | `identification` | Identification assigned by an institution to identify an account. This identification is known by the account owner. | TPP | This element is used to specify the account identification number. | O | 0..1 | String | Recipient account identification. | | | `name` | Name(s) of the account owner | TPP | This element is used to specify the name of the account owner. | O | 0..1 | 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. | | | `reference` | A unique identifier used to identify the payment. | TPP | Identification of payment to fetch payment data. | O | 0..1 | String | Unique reference, as assigned by the creditor (recipient), to unambiguously refer to the payment transaction. | | | `status` | Specifies the status of the standing order. | TPP | Status of the standing order. | O | 0..1 | String | Specifies the status of the standing order. Expected values: Active, Inactive.. | | ## Feature specific error codes {#feature-specific-error-codes} Tip: For a list of general response codes and error code structure see [Response and Error Codes](https://developer.mastercard.com/open-banking-connect/documentation/response-and-error-codes/index.md). | **Message** | **Reason Code** | **Description** | **Developer Details** | **Typical Occurrences** | **Next Steps** | |-----------------------------------------------------------------------------|-----------------|-----------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------| | Conditional field `psuIPAddress` is expected when `isLivePsuRequest`='true' | `FORMAT_ERROR` | `IP address` field is mandatory if parameter `isLivePsuRequest`=true. | "path\[i\]=\<\\path to the element that failed the validation\>;" where i = 0, 1, 2, etc. for each element that failed the validation | Typically occurs because the TPP has provided in request `isLivePsuRequest`=true and didn't provide the IP address value. | Provide IP address of PSU in the request when providing `isLivePsuRequest`=true. | **Error example code** ```json { "Errors": { "Error": [ { "Source": "OBC", "ReasonCode": "FORMAT_ERROR", "Description": "Conditional field psuIPAddress is expected when isLivePsuRequest='true'", "Details": "path[0]=/requestInfo/psuIPAddress" } ] } } ``` | **Message** | **Reason Code** | **Description** | **Developer Details** | **Typical Occurrences** | **Next Steps** | |--------------------------------------------------------|-----------------|------------------------------------------------------|-----------------------|------------------------------------------------------------------------------------------------|-------------------------------------| | "Access Token associated with the Request has expired" | `INVALID_TOKEN` | Access Token associated with the Request has expired | n/a | Typically occurs when the consent that the TPP has previously obtained from a PSU has expired. | PSU needs to provide a new consent. | **Error example code** ```json { "Errors": { "Error": [ { "ReasonCode": " INVALID_TOKEN ", "Description": "Access Token associated with the Request has expired" } ] } } ``` | **Message** | **Reason Code** | **Description** | **Developer Details** | **Typical Occurrences** | **Next Steps** | |------------------------------------------------------------|------------------|-----------------------------------------------------------|-----------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------| | "Provided account is invalid or unlinked from the consent" | `PROVIDER_ERROR` | Provided account is invalid or unlinked from the consent. | N/A | Typically occurs when an invalid account id is included in the request, or when the account id was unlinked from the consent due to various issues with previous requests using the same consent. | Ensure a valid account id is included or ask for a fresh consent from the PSU and include in the request. | **Error example code** ```json { "Errors": { "Error": [ { "ReasonCode": " PROVIDER_ERROR ", "Description": "Provided account is invalid or unlinked from the consent" } ] } } ``` | **Message** | **Reason Code** | **Description** | **Developer Details** | **Typical Occurrences** | **Next Steps** | |----------------------------------------------------|------------------|---------------------------------------------------|-----------------------|--------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | "ASPSP limit for unattended requests was exceeded" | `PROVIDER_ERROR` | ASPSP limit for unattended requests was exceeded. | N/A | Typically occurs when ASPSP limit (usually set to 4 requests) for unattended requests (without PSU details) is exceeded. | Please ensure that PSU is online during AIS requests, include PSU details (isLivePsuRequest , psuIPAddress and psuAgent), or try submitting requests the following day. | **Error example code** ```json { "Errors": { "Error": [ { "ReasonCode": " PROVIDER_ERROR ", "Description": "ASPSP limit for unattended requests was exceeded" } ] } } ```