--- api: 'Open Banking API' --- # Retrieve a domestic standing order consent Get the details of a domestic standing order consent. See also [Tutorials: Initiate your first payment](/docs/guides/build-banking-apps/tutorials/initiate-your-first-payment). ## Endpoint GET `/domestic-standing-order-consents/{ConsentId}` ## Parameters ### header parameters - `x-fapi-financial-id` (string, required) The unique ID of the [ASPSP](/docs/guides/build-banking-apps/glossary) that the request is issued to. The ID of Revolut is `001580000103UAvAAM`. - `x-fapi-customer-last-logged-time` (string, optional) The date and time when the [PSU](/docs/guides/build-banking-apps/glossary) last logged in with the [TPP](/docs/guides/build-banking-apps/glossary). All dates in the HTTP headers are represented as [RFC 7231](https://datatracker.ietf.org/doc/html/rfc7231#section-7.1.1.1) Full Dates. For example: `Sun, 10 Sep 2017 19:43:31 UTC`. - `x-fapi-customer-ip-address` (string, optional) The IP address of the [PSU](/docs/guides/build-banking-apps/glossary) if the PSU is logged in with the [TPP](/docs/guides/build-banking-apps/glossary). - `x-fapi-interaction-id` (string, optional) An [RFC4122](https://datatracker.ietf.org/doc/html/rfc4122) UUID used as a correlation ID. - `Authorization` (string, required) The access token that you've generated. For more information, see [Generate an access token](/docs/guides/build-banking-apps/get-started/get-access-token). - `x-customer-user-agent` (string, optional) The user agent that the [PSU](/docs/guides/build-banking-apps/glossary) is using. ### path parameters - `ConsentId` (string, required) The ID of the account access consent. ## Returns ### 200 Domestic Standing Order Consents Read #### Response attributes - `Data` (object) - `Data.ConsentId` (string) The unique ID that the [ASPSP](/docs/guides/build-banking-apps/glossary) assigns to identify the consent resource. - `Data.CreationDateTime` (string) The date and time when the resource was created. All dates in the JSON payloads are represented in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date-time format. All date-time fields in responses must include the timezone. For example: `2017-04-05T10:43:07+00:00`. - `Data.Status` (enum) The status of the consent. Possible enum values: - `Authorised` - `AwaitingAuthorisation` - `Consumed` - `Rejected` - `Data.StatusUpdateDateTime` (string) The date and time when the resource status was updated. All dates in the JSON payloads are represented in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date-time format. All date-time fields in responses must include the timezone. For example: `2017-04-05T10:43:07+00:00`. - `Data.Permission` (enum) The Open Banking service request type. Possible enum values: - `Create` - `Data.Initiation` (object) The Initiation payload that the initiating party sends to the [ASPSP](/docs/guides/build-banking-apps/glossary), which is used to request movement of funds from the debtor account to the creditor for a domestic standing order. - `Data.Initiation.Frequency` (string) The frequency of the standing order: - `EvryDay`: Every day - `IntrvlWkDay`: Only one week interval is supported (01) and any day within the week (01 to 07) - `IntrvlMnthDay`: Only one month interval is supported (01) and any day within the month (1 to 31) Example values: - `EvryDay` - `IntrvlWkDay:01:0[1-7]` - `IntrvlMnthDay:01:(0[1-9]|[12][0-9]|3[01])` :::warning The day of the interval must agree with the day from `FirstPaymentDateTime`, otherwise, for `POST` requests, the `Unsupported frequency` error is returned. For example: - Correct: `Frequency=IntrvlMnthDay:01:03` and `FirstPaymentDateTime=2026-02-03T14:15:22Z` - the day to schedule the payment is the 3rd day of the month, and the first occurrence will be on the 3rd of February - Incorrect: `Frequency=IntrvlMnthDay:01:03` and `FirstPaymentDateTime=2026-02-17T14:15:22Z` - the day to schedule the payment is the 3rd day of the month, but the first occurrence is set to the 17th of February, so the days don't match. ::: - `Data.Initiation.Reference` (string, optional) The unique reference that the creditor assigns to unambiguously identify the payment transaction. If available, the initiating party should provide this reference in the structured remittance information to enable reconciliation by the creditor upon receipt of the amount of money. If the business context requires the use of a creditor reference or a payment remit identification, and only one identifier can be passed through the end-to-end chain, the creditor's reference or payment remittance identification should be quoted in the end-to-end transaction identification. - `Data.Initiation.NumberOfPayments` (string, optional) :::warning Currently, standing orders do not support ending conditions, so using this field will result in an error. ::: The number of payments to make, with the interval set in `frequency`, counting from the start date set in `FirstPaymentDateTime`. - `Data.Initiation.FirstPaymentDateTime` (string) The date and time when the first payment for a standing order schedule is made. All dates in the JSON payloads are represented in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date-time format. All date-time fields in responses must include the timezone. For example: `2017-04-05T10:43:07+00:00`. :::warning The day part of the date must agree with the day of the interval set in `Frequency`, otherwise, for `POST` requests, the `Unsupported frequency` error is returned. For example: - Correct: `Frequency=IntrvlMnthDay:01:03` and `FirstPaymentDateTime=2026-02-03T14:15:22Z` - the day to schedule the payment is the 3rd day of the month, and the first occurrence will be on the 3rd of February - Incorrect: `Frequency=IntrvlMnthDay:01:03` and `FirstPaymentDateTime=2026-02-17T14:15:22Z` - the day to schedule the payment is the 3rd day of the month, but the first occurrence is set to the 17th of February, so the days don't match. ::: - `Data.Initiation.FinalPaymentDateTime` (string, optional) :::warning Currently, standing orders do not support ending conditions, so this field is ignored. ::: The date and time when the final payment for a standing order schedule is made. All dates in the JSON payloads are represented in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date-time format. All date-time fields in responses must include the timezone. For example: `2017-04-05T10:43:07+00:00`. - `Data.Initiation.FirstPaymentAmount` (object) The amount of the first standing order. - `Data.Initiation.FirstPaymentAmount.Amount` (string) The amount of money where the unit of currency is explicit and compliant with [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217). - `Data.Initiation.FirstPaymentAmount.Currency` (string) [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code in upper case. - `Data.Initiation.RecurringPaymentAmount` (object, optional) The amount of the recurring standing order. If provided, must be equal to `FirstPaymentAmount`. - `Data.Initiation.RecurringPaymentAmount.Amount` (string) The amount of money where the unit of currency is explicit and compliant with [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217). - `Data.Initiation.RecurringPaymentAmount.Currency` (string) [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code in upper case. - `Data.Initiation.FinalPaymentAmount` (object, optional) :::warning Currently, standing orders do not support ending conditions, so this field is ignored. ::: The amount of the final standing order. - `Data.Initiation.FinalPaymentAmount.Amount` (string) The amount of money where the unit of currency is explicit and compliant with [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217). - `Data.Initiation.FinalPaymentAmount.Currency` (string) [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code in upper case. - `Data.Initiation.CreditorAccount` (object) The details to identify the account. - `Data.Initiation.CreditorAccount.SchemeName` (enum) The name of the identification scheme. Possible enum values: - `UK.OBIE.IBAN` - `UK.OBIE.SortCodeAccountNumber` - `US.RoutingNumberAccountNumber` - `US.BranchCodeAccountNumber` - `Data.Initiation.CreditorAccount.Identification` (string) The account ID that the institution assigns to identify an account, which is known by the account owner. - `Data.Initiation.CreditorAccount.Name` (string) The account name that the account servicing institution assigns. The account name is the name or names of the account owner(s) represented at an account level. The account name is not the product name or the nickname of the account. :::note [ASPSP](/docs/guides/build-banking-apps/glossary)s might optionally validate this name to confirm the payee. ::: - `Data.Initiation.CreditorAccount.SecondaryIdentification` (string, optional) The secondary account ID that the account servicing institution assigns. Building societies can use this ID to identify accounts with a roll number in addition to a sort code and account number combination. - `Data.Initiation.DebtorAccount` (object, optional) The details to identify the account from which the payment consent can be approved. If provided in the consent, the [PSU](/docs/guides/build-banking-apps/glossary) will only be able to approve the payment consent from an account which matches the provided account identifier. - `Data.Initiation.DebtorAccount.SchemeName` (enum) The name of the identification scheme. Possible enum values: - `UK.OBIE.IBAN` - `UK.OBIE.SortCodeAccountNumber` - `US.RoutingNumberAccountNumber` - `US.BranchCodeAccountNumber` - `Data.Initiation.DebtorAccount.Identification` (string) The identifier assigned to the account, which is known by the account owner. - `Data.Initiation.DebtorAccount.Name` (string, optional) The name or names of the account owner(s) represented at an account level. The account name is not the product name or the nickname of the account. :::warning The name value is not validated against the actual owner name of the account. ::: - `Data.Initiation.DebtorAccount.SecondaryIdentification` (string, optional) The secondary account ID that the account servicing institution assigns. Building societies can use this ID to identify accounts with a roll number in addition to a sort code and account number combination. - `Risk` (object) The Risk section contains the risk indicators that the initiating party sends to the [ASPSP](/docs/guides/build-banking-apps/glossary), which can be used to specify additional details for risk scoring for account information. - `Risk.PaymentContextCode` (enum, optional) The payment context. Possible enum values: - `BillPayment` - `EcommerceGoods` - `EcommerceServices` - `Other` - `PartyToParty` - `Risk.MerchantCategoryCode` (string, optional) The merchant category code. - `Risk.MerchantCustomerIdentification` (string, optional) The merchant customer identification. - `Risk.DeliveryAddress` (object, optional) The information that locates and identifies the delivery address, as defined by postal services or in free format text. - `Risk.DeliveryAddress.AddressLine` (array of string, optional) The information that locates and identifies the delivery address, as defined by postal services, that is presented in free format text. - `Risk.DeliveryAddress.StreetName` (string, optional) The name of the street. - `Risk.DeliveryAddress.BuildingNumber` (string, optional) The number of the building. - `Risk.DeliveryAddress.PostCode` (string, optional) The post code of the delivery address. - `Risk.DeliveryAddress.TownName` (string) The name of the town. - `Risk.DeliveryAddress.CountrySubDivision` (array of string, optional) The subdivision of the country, for example, state, region or county. - `Risk.DeliveryAddress.Country` (string) The name of the country. - `Links` (object) Links relevant to the payload. - `Links.Self` (string) The absolute URI to the resource. - `Links.Next` (string, optional) The absolute URI to the next pagination resource. - `Links.Prev` (string, optional) The absolute URI to the previous pagination resource. - `Meta` (object) Meta data relevant to the payload. - `Meta.TotalPages` (integer, optional) Used for pagination. Indicates how many pages of results are available. ## Error responses | HTTP status code | Description | | --- | --- | | 400 | Bad request | | 401 | Unauthorized | | 403 | Forbidden | | 405 | Method Not Allowed | | 406 | Not Acceptable | | 429 | Too Many Requests | | 500 | Internal Server Error |