API Explorer

All UK APIs v2.0 (7)

Bank

Accounts

Views

Counterparties

Transactions

Get Resource Docs.

Get documentation about the RESTful resources on this server including example bodies for POST and PUT requests.

This is the native data format used to document OBP endpoints. Each endpoint has a Resource Doc (a Scala case class) defined in the source code.

This endpoint is used by OBP API Explorer to display and work with the API documentation.

Most (but not all) fields are also available in swagger format. (The Swagger endpoint is built from Resource Docs.)

API_VERSION is the version you want documentation about e.g. v3.0.0

You may filter this endpoint with tags parameter e.g. ?tags=Account,Bank

You may filter this endpoint with functions parameter e.g. ?functions=enableDisableConsumers,getConnectorMetrics

For possible function values, see implemented_by.function in the JSON returned by this endpoint or the OBP source code or the footer of the API Explorer which produces a comma separated list of functions that reflect the server or filtering by API Explorer based on tags etc.

  • operation_id is concatenation of "v", version and function and should be unique (used for DOM element IDs etc. maybe used to link to source code)
  • version references the version that the API call is defined in.
  • function is the (scala) partial function that implements this endpoint. It is unique per version of the API.
  • request_url is empty for the root call, else the path.
  • summary is a short description inline with the swagger terminology.
  • description may contain html markup (generated from markdown on the server).
Typical Successful Response:

								
									
{ "jsonString":"{}" }
Headers:

								
									
Possible Errors:
  • OBP-50000: Unknown Error.
Implmented in 1_4_0 by getResourceDocsObp

Get Swagger documentation

Returns documentation about the RESTful resources on this server in Swagger format.

API_VERSION is the version you want documentation about e.g. v3.0.0

You may filter this endpoint using the 'tags' url parameter e.g. ?tags=Account,Bank

(All endpoints are given one or more tags which for used in grouping)

You may filter this endpoint using the 'functions' url parameter e.g. ?functions=enableDisableConsumers,getConnectorMetrics

(Each endpoint is implemented in the OBP Scala code by a 'function')

See the Resource Doc endpoint for more information.

Typical Successful Response:

								
									
{ "jsonString":"{}" }
Headers:

								
									
Possible Errors:
  • OBP-50000: Unknown Error.
Implmented in 1_4_0 by getResourceDocsSwagger

UK Open Banking: Get Account

Reads a bank account, with balances where required. It is assumed that a consent of the PSU to this access is already given and stored on the ASPSP system.

Authentication is Mandatory

This call is work in progress - Experimental!

Typical Successful Response:

								
									
{ "Data":{ "Account":[{ "AccountId":"22289", "Currency":"GBP", "AccountType":"Personal", "AccountSubType":"CurrentAccount", "Nickname":"Bills", "Account":{ "SchemeName":"SortCodeAccountNumber", "Identification":"80200110203345", "Name":"Mr Kevin", "SecondaryIdentification":"00021" } }] }, "Links":{ "Self":"https://apisandbox.openbankproject.com/open-banking/v2.0/accounts/" }, "Meta":{ "TotalPages":1 } }
Headers:

								
									
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Implmented in 2_0 by getAccount

UK Open Banking: Get Account Balances

An AISP may retrieve the account balance information resource for a specific AccountId (which is retrieved in the call to GET /accounts).

Authentication is Mandatory

This call is work in progress - Experimental!

Typical Successful Response:

								
									
{ "Data":{ "Balance":[{ "AccountId":"22289", "Amount":{ "currency":"EUR", "amount":"10" }, "CreditDebitIndicator":"Credit", "Type":"InterimAvailable", "DateTime":"2017-09-19T00:00:00Z", "CreditLine":[{ "Included":true, "Amount":{ "currency":"EUR", "amount":"10" }, "Type":"Pre-Agreed" }] }] }, "Links":{ "Self":"https://apisandbox.openbankproject.com/open-banking/v2.0/accounts/22289/balances/" }, "Meta":{ "TotalPages":1 } }
Headers:

								
									
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Implmented in 2_0 by getAccountBalances

UK Open Banking: Get Account List

Reads a list of bank accounts, with balances where required. It is assumed that a consent of the PSU to this access is already given and stored on the ASPSP system.

Authentication is Mandatory

This call is work in progress - Experimental!

Typical Successful Response:

								
									
{ "Data":{ "Account":[{ "AccountId":"22289", "Currency":"GBP", "AccountType":"Personal", "AccountSubType":"CurrentAccount", "Nickname":"Bills", "Account":{ "SchemeName":"SortCodeAccountNumber", "Identification":"80200110203345", "Name":"Mr Kevin", "SecondaryIdentification":"00021" } }] }, "Links":{ "Self":"https://apisandbox.openbankproject.com/open-banking/v2.0/accounts/" }, "Meta":{ "TotalPages":1 } }
Headers:

								
									
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Implmented in 2_0 by getAccountList

UK Open Banking: Get Account Transactions

Reads account data from a given account addressed by “account-id”. Authentication is Mandatory

This call is work in progress - Experimental!

Typical Successful Response:

								
									
{ "Data":{ "Transaction":[{ "AccountId":"123", "TransactionId":"123", "TransactionReference":"Ref 1", "Amount":{ "currency":"EUR", "amount":"10" }, "CreditDebitIndicator":"Credit", "Status":"Booked", "BookingDateTime":"2017-09-19T00:00:00Z", "ValueDateTime":"2017-09-19T00:00:00Z", "TransactionInformation":"Cash from Aubrey", "BankTransactionCode":{ "Code":"ReceivedCreditTransfer", "SubCode":"DomesticCreditTransfer" }, "ProprietaryBankTransactionCode":{ "Code":"Transfer", "Issuer":"AlphaBank" }, "Balance":{ "Amount":{ "currency":"EUR", "amount":"10" }, "CreditDebitIndicator":"Credit", "Type":"InterimBooked" } }] }, "Links":{ "Self":"https://apisandbox.openbankproject.com/open-banking/v2.0/accounts/22289/transactions/" }, "Meta":{ "TotalPages":1, "FirstAvailableDateTime":"2017-09-19T00:00:00Z", "LastAvailableDateTime":"2017-09-19T00:00:00Z" } }
Headers:

								
									
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Implmented in 2_0 by getAccountTransactions

UK Open Banking: Get Balances

If an ASPSP has implemented the bulk retrieval endpoints - an AISP may optionally retrieve the account information resources in bulk. This will retrieve the resources for all authorised accounts linked to the account-request.

Authentication is Mandatory

This call is work in progress - Experimental!

Typical Successful Response:

								
									
{ "Data":{ "Balance":[{ "AccountId":"22289", "Amount":{ "currency":"EUR", "amount":"10" }, "CreditDebitIndicator":"Credit", "Type":"InterimAvailable", "DateTime":"2017-09-19T00:00:00Z", "CreditLine":[{ "Included":true, "Amount":{ "currency":"EUR", "amount":"10" }, "Type":"Pre-Agreed" }] }] }, "Links":{ "Self":"https://apisandbox.openbankproject.com/open-banking/v2.0/accounts/22289/balances/" }, "Meta":{ "TotalPages":1 } }
Headers:

								
									
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Implmented in 2_0 by getBalances