Retrieve a domestic standing order consent
Get the details of a domestic standing order consent.
See also Tutorials: Initiate your first payment.
Authorization
Each Open Banking API must contain an authorization header in the following format to make a call: Bearer <yourAccessToken>.
Before you start, ensure that you've got an access token with the correct scope using the /token endpoint.
You need to get the authorization code first and exchange it for an access token.
Never share your access_token with anyone, as it can be used to access the banking data that you have access to and initiate transactions.
For more information, see Tutorial: Get account and transaction information and Tutorial: Initiate your first payment as examples.
x-jws-signature
Open Banking API Payment requests additionally require a JSON Web Signature (JWS) which needs to be added to the header of the request. The JWS signature must be obtained using the full content of the payload.
Request
The ID of the account access consent.
The unique ID of the ASPSP that the request is issued to.
The ID of Revolut is 001580000103UAvAAM.
Pattern: Value must match regular expression ^(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)$
An RFC4122 UUID used as a correlation ID.
The access token that you've generated. For more information, see Generate an access token.
The user agent that the PSU is using.
Response
Domestic Standing Order Consents Read
Header containing a detached JWS signature of the body of the payload.
An RFC4122 UUID used as a correlation ID.
OBWriteDataDomesticStandingOrderConsentResponse2
Possible length: non-empty and <= 128 characters
The unique ID that the ASPSP assigns to identify the consent resource.
The date and time when the resource was created.
All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone.
For example: 2017-04-05T10:43:07+00:00.
Possible values: [Authorised, AwaitingAuthorisation, Consumed, Rejected]
The status of the consent.
The date and time when the resource status was updated.
All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone.
For example: 2017-04-05T10:43:07+00:00.
Possible values: [Create]
The Open Banking service request type.
The Initiation payload that the initiating party sends to the ASPSP, which is used to request movement of funds from the debtor account to the creditor for a domestic standing order.
Possible length: non-empty and <= 35 characters
The frequency of the standing order:
EvryDay: Every dayIntrvlWkDay: 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:
EvryDayIntrvlWkDay:01:0[1-7]IntrvlMnthDay:01:(0[1-9]|[12][0-9]|3[01])
Possible length: non-empty and <= 35 characters
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.
Possible length: non-empty and <= 35 characters
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.
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 date-time format. All date-time fields in responses must include the timezone.
For example: 2017-04-05T10:43:07+00:00.
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 date-time format. All date-time fields in responses must include the timezone.
For example: 2017-04-05T10:43:07+00:00.
The amount of the recurring standing order. If provided, must be equal to FirstPaymentAmount.
Currently, standing orders do not support ending conditions, so this field is ignored.
The amount of the final standing order.
The details to identify the account.
Possible values: [UK.OBIE.IBAN, UK.OBIE.SortCodeAccountNumber, US.RoutingNumberAccountNumber, US.BranchCodeAccountNumber]
Example: ["UK.OBIE.IBAN","UK.OBIE.SortCodeAccountNumber"]
The name of the identification scheme.
Possible length: non-empty and <= 256 characters
The account ID that an institution assigns to identify the account, which is known by the account owner.
Possible length: non-empty and <= 70 characters
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.
Possible length: non-empty and <= 34 characters
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.
The details to identify the account.
Possible values: [UK.OBIE.IBAN, UK.OBIE.SortCodeAccountNumber, US.RoutingNumberAccountNumber, US.BranchCodeAccountNumber]
Example: ["UK.OBIE.IBAN","UK.OBIE.SortCodeAccountNumber"]
The name of the identification scheme.
Possible length: non-empty and <= 256 characters
The account ID that the institution assigns to identify an account, which is known by the account owner.
Possible length: non-empty and <= 70 characters
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.
ASPSPs might optionally validate this name to confirm the payee.
Possible length: non-empty and <= 34 characters
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.
The Risk section contains the risk indicators that the initiating party sends to the ASPSP, which can be used to specify additional details for risk scoring for account information.
Possible values: [BillPayment, EcommerceGoods, EcommerceServices, Other, PartyToParty]
The payment context.
The merchant category code.
The merchant customer identification.
The information that locates and identifies the delivery address, as defined by postal services or in free format text.
Possible number of items: <= 2 items
The information that locates and identifies the delivery address, as defined by postal services, that is presented in free format text.
Possible length: non-empty and <= 70 characters
The name of the street.
Possible length: non-empty and <= 16 characters
The number of the building.
Possible length: non-empty and <= 16 characters
The post code of the delivery address.
Possible length: non-empty and <= 35 characters
The name of the town.
Possible number of items: <= 2 items
The subdivision of the country, for example, state, region or county.
Pattern: Value must match regular expression ^[A-Z]{2,2}$
The name of the country.
Links relevant to the payload.
The absolute URI to the resource.
The absolute URI to the next pagination resource.
The absolute URI to the previous pagination resource.
Meta data relevant to the payload.
Used for pagination. Indicates how many pages of results are available.