-
Notifications
You must be signed in to change notification settings - Fork 430
PSD2 Sandbox
This is a special page for the PSD2 OBP API sandbox. See https://psd2-api.openbankproject.com/ for some background information.
If you have any questions, please ask us! Contact details are at the bottom of this page.
TL;DR Go here: PSD2 OBP API Sandbox
Open Bank Project is an open source API for banks providing a common RESTful interface for developers to build customer facing applications. You can use it as a flexible toolbox of data and services to help build your ideas. This sandbox contains simulated transaction data for typical customers.
Customer facing retail banking and fintech applications for consumers, SMEs, associations, charities, governments and NGOs; including (but not limited to!) Personal Finance Management (PFM) Solutions, online accounting integration, financial widgets, Savings Apps, Education Apps, Gamification, Peace of Mind Apps, Transparency Apps, Crowd funding, on boarding, CRM etc..
- Account information, balance and transaction history of multiple bank accounts
- Enrich bank transactions with metadata (tags, comments, urls and geolocation) for example to link a receipt or video to a transaction
- Create/Access different views on accounts. Each view grants a subset of the data to a restricted group of users. For example, a customer could offer special views on his account to his accountants, auditors or regulators. A charity might open their accounts to the public
- Initiate payments
- Access Customer messages
- Access data related to branches, ATMs and financial products
https://psd2-api.openbankproject.com/obp/v2.0.0
Use the OBP API Explorer to browse and test the API.
- Bank X
- Bank Y
In order to build and test your Apps, you will use two different logins:
-
- Your developer login to get your API keys (see Application registration below)
-
- One or more simulated customer logins to access transaction data etc. (See customer logins below)
To logout [go here] (https://psd2-api.openbankproject.com)
Please register your application here. You will get a consumer key and consumer secret for the calls requiring OAuth authentication. You can also use the consumer key for "Direct Login"
To get started with OBP and OAuth we recommend you use (and fork) one of our Starter SDKs
Note: Many examples in the docs / SDKs use the general OBP sandbox domain. Make sure you use the correct domain in all calls i.e. psd2-api.openbankproject.com !
-
Q: I'm getting a 401 even if I enter the right consumer key and secret. Is the endpoint: apisandbox... ?
A: No, its psd2-api.openbankproject.com
-
Q: I'm getting 404's / errors
A: Avoid trailing slashes:
https://psd2-api.openbankproject.com/obp/v1.4.0 200 OK
https://psd2-api.openbankproject.com/obp/v1.4.0/ 404 Not Found
https://psd2-api.openbankproject.com/obp/v1.4.0/banks 200 OK
https://psd2-api.openbankproject.com/obp/v1.4.0/banks/ 200 OK {"error":"error"}
https://psd2-api.openbankproject.com/obp/v1.4.0/banks/rbs-rbs-c 200 OK
https://psd2-api.openbankproject.com/obp/v1.4.0/banks/rbs-rbs-c/ 404 Not Found
-
Q: I'm getting 404s when POSTing
A: Check you have the correct JSON body, headers and encoding. If in doubt, see an example here
-
Q: Why am I not seeing any data for the test user?
A: Make sure you are using the correct bank_id/account_id for the user. Use the OBP API Explorer to check
-
Q: It still doesn't work. Why?
A: Double check parameters are spelt correctly (including http vs https etc.)
A: Check your encoding (use UTF8)
Technical details about the OAuth flow are available here. However we recomend using an OAuth SDK or Direct Login [to start with] (https://github.com/OpenBankProject/OBP-API/wiki/OAuth-Client-SDKS). Please ask us (see below) if you are stuck with this.
-
For the current stable API version see 1.4.0.
-
For the latest draft (recomended) see 2.0.0 with the API Explorer
-
Try the OBP API Explorer to browse and test the API.
During the OAuth login, the user of your app will be asked for a customer username/password.
Here are some simulated customer logins to test your App / OAuth flow:
[{ "email":"[email protected]", "password":"5232e7", "display_name":"Robert XUk X" },{ "email":"[email protected]", "password":"43ca4d", "display_name":"Susan XUk X" },{ "email":"[email protected]", "password":"d8c716", "display_name":"Anil XUk X" },{ "email":"[email protected]", "password":"6187b9", "display_name":"Ellie XUk X" },{ "email":"[email protected]", "password":"e5046a", "display_name":"Robert YUk Y" },{ "email":"[email protected]", "password":"5b38a6", "display_name":"Susan YUk Y" },{ "email":"[email protected]", "password":"dcf03d", "display_name":"Anil YUk Y" },{ "email":"[email protected]", "password":"4f9eaa", "display_name":"Ellie YUk Y" }],
You can use the Sofi application to browse your transaction data (use the above username/password).
To get different logins just for your team please ask a member of the Open Bank Project team.
-
To contact Open Bank Project about the use of this sandbox use:
Email: [email protected] (we will invite you to our Slack channel)
Twitter: @OpenBankProject