Create a domestic standing order consent
Create a domestic standing order consent described in the Open Banking API documentation: Account and Transaction API Specification.
Use domestic standing orders for local recurring payments in the local currency of the user.
:::note Revolut supports only GBP as local in the UK and EUR in Single Euro Payments Area (SEPA) countries. :::
Because Revolut Business users can have multiple accounts in the same currency, they can choose which account they want to be charged in the consent authorization UI.
When you make the API call, ensure that you pass the corresponding JSON Web Signature (JWS) in the x-jws-signature request header. Note:
- The JWS is generated from the request body with the TPP signing key that is specified in the JWS header.
- The JWS consists of a header and a signature in the <jws_header>..<jws_signature> format.
To see how to create a JWS, see the guide: Work with JSON Web Signatures.
The following types of standing orders frequency are supported:
| FREQUENCY | EXAMPLE | DETAILS |
|---|---|---|
| EvryDay | EvryDay | Daily, supported only for personal accounts |
| IntrvlWkDay | IntrvlWkDay:01:03 | Weekly on a specified week day, only 1 week interval is supported |
| IntrvlMnthDay | IntrvlMnthDay:01:03 | Monthly on a specified day of month, only 1 month interval is supported |
See also Tutorials: Initiate your first payment.
Request
- Base URLhttps://oba-auth.revolut.com
- AuthAPI key in header Authorization and API key in header x-jws-signature
Headers
The unique ID of the ASPSP that the request is issued to. The ID of Revolut is 001580000103UAvAAM.
An RFC4122 UUID used as a correlation ID.
The access token that you've generated. For more information, see Generate an access token.
Each request is processed only once per x-idempotency-key. The idempotency key is valid for 24 hours.
A detached JWS signature of the body of the payload.
The user agent that the PSU is using.
Request body
Example request
{
"Data": {
"Initiation": {
"CreditorAccount": {
"SchemeName": "UK.OBIE.IBAN"
},
"DebtorAccount": {
"SchemeName": "UK.OBIE.IBAN"
}
}
}
}Response
Domestic Standing Order Consents Created
Example response
{
"Data": {
"Initiation": {
"CreditorAccount": {
"SchemeName": "UK.OBIE.IBAN"
},
"DebtorAccount": {
"SchemeName": "UK.OBIE.IBAN"
}
}
}
}Changes
No recorded changes to this operation across all 2 revisions of this API.