Access to Accounts
List, view, and work with bank accounts via the API.
Access to Accounts
This page explains how to list, view, and work with bank accounts via the OBP API.
List Your Accounts
To get all accounts you have access to across all banks(see in API Explorer):
curl -X GET "https://YOUR_OBP_HOST/obp/v5.1.0/my/accounts" \
-H "Content-Type: application/json" \
-H "Authorization: DirectLogin token=YOUR_TOKEN"To list accounts at a specific bank(see in API Explorer):
curl -X GET "https://YOUR_OBP_HOST/obp/v6.0.0/banks/BANK_ID/accounts" \
-H "Content-Type: application/json" \
-H "Authorization: DirectLogin token=YOUR_TOKEN"Get Account Details
To get the full details of a specific account, you need the bank_id, account_id, and a view_id you have access to(see in API Explorer):
curl -X GET "https://YOUR_OBP_HOST/obp/v6.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/owner/account" \
-H "Content-Type: application/json" \
-H "Authorization: DirectLogin token=YOUR_TOKEN"The response includes the account balance, type, label, IBAN, and other routing information.
Get Account Balances
To get balances for a specific account(see in API Explorer):
GET /obp/v5.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/views/VIEW_ID/balancesOr get balances for all accounts at a bank(see in API Explorer):
GET /obp/v5.1.0/banks/BANK_ID/balancesGet Transactions
To list transactions on an account(see in API Explorer):
curl -X GET "https://YOUR_OBP_HOST/obp/v6.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/owner/transactions" \
-H "Content-Type: application/json" \
-H "Authorization: DirectLogin token=YOUR_TOKEN"Transactions include the amount, currency, description, date, counterparty details, and metadata. The View you use determines which fields are returned.
Public Accounts
Some accounts may be marked as public. These can be accessed without authentication(see in API Explorer):
GET /obp/v5.1.0/banks/BANK_ID/accounts/publicCounterparties
Counterparties are the other parties in a transaction (the payee or payer). You can list and manage counterparties on an account(see in API Explorer):
GET /obp/v5.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/counterpartiesYou can also create counterparties, which is needed before making COUNTERPARTY transaction requests(see in API Explorer).
Check Funds Available
You can check whether sufficient funds are available on an account without seeing the balance itself. This supports the PSD2 Confirmation of Funds Service(see in API Explorer):
GET /obp/v5.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/funds-availableAccessing Accounts as a Third Party
If you are building a third-party application that needs to access other users' accounts, you will need:
- The user to grant a Consent specifying which accounts and Views your app can access
- An OAuth2 flow for the user to authorise your app
- The consent JWT, which you include in your API requests
See Account Access for details on how Views control what data is visible through each access level.
Related
- Account Access — how Views and access control work
- Transaction Requests — make payments from an account
- Consents — grant third-party access to accounts
- All Account endpoints in the API Explorer