Retrieve a domestic payment
Get the status of a domestic payment.
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 domestic payment.
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 Payments Read
Header containing a detached JWS signature of the body of the payload.
An RFC4122 UUID used as a correlation ID.
OBWriteDataDomesticResponse2
Possible length: non-empty and <= 40 characters
The unique ID that the ASPSP assigns to uniquely identify the domestic payment resource.
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 message 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: [AcceptedSettlementCompleted, AcceptedSettlementInProcess, Pending, Rejected]
The status of the payment information group.
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.
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 single domestic payment.
Possible length: non-empty and <= 35 characters
The unique ID that an instructing party assigns for an instructed party to unambiguously identify the instruction.
This ID is used between the instructing party and the instructed party to refer to an individual instruction. It can be included in the messages related to the instruction.
Possible length: non-empty and <= 35 characters
The unique and immutable ID that the initiating party assigns to unambiguously identify the transaction.
This ID is used for reconciliation or to link tasks related to the transaction. It can be included in the messages related to the transaction.
Faster Payments Scheme can access only 31 characters for the EndToEndIdentification field.
The amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency that the initiating party instructs.
This amount has to be transported unchanged through the transaction chain.
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 postal address of the creditor, as defined by postal services.
Possible length: non-empty and <= 70 characters
The name of the department.
Possible length: non-empty and <= 70 characters
The name of the sub-department.
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 address.
Possible length: non-empty and <= 35 characters
The name of the town.
Possible length: non-empty and <= 35 characters
The subdivision of the country, such as state, region, or county.
Pattern: Value must match regular expression ^[A-Z]{2,2}$
The name of the country.
Possible number of items: <= 7 items
The information that locates and identifies the address of the creditor, presented in free format text.
The information used for matching an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts' receivable system.
Possible length: non-empty and <= 140 characters
The information used for matching/reconciliation of an entry with the items that the payment is intended to settle, such as commercial invoices in an accounts' receivable system, in an unstructured form.
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.
Faster Payments Scheme can accept only 18 characters for the Reference field.
Only one reference should be provided, if both Reference and Unstructured parameters are provided, then the Unstructured parameter will be ignored.
Possible length: non-empty and <= 40 characters
The additional information that can not be captured in the structured fields and/or any other specific block.
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.