-
Notifications
You must be signed in to change notification settings - Fork 431
BoP OBP API Sandbox
This is a special page for the Bank of Portugal OBP API sandbox.
Go here: Bank of Portugal
This document may be updated.
Open Bank Project is an open source API for banks that provides a RESTful interface for developers to build customer facing applications without needing to code for each bank or account type differently. You can use it as a flexible toolbox of data and services to help realise (a.k.a. hack!) your ideas together. For the hackathons, developers have access to simulated transaction data for imaginary customers that match certain customer profiles.
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..
This OBP instance contains simulated customer related data.
- 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
- Onboard Customers (KYC etc.)
You will need to register your application here. You will get a consumer key and consumer secret for the calls requiring OAuth or Direct Login authentication.
The recommended way to authenticate in the hackathon context is to use Direct Login.
To get started with OBP and OAuth we recommend you use (and fork) one of our OAuth 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. bop.openbankproject.com !
- For the latest version (recommended) see 3.0.0
During the OAuth login, the user of your app will be asked for a customer username/password.
Here are some example logins to test your Direct Login or OAuth flow:
"user_name":"Alfio.Pt.02"
"password":"X!3e8787f5"
"email":"[email protected]"
"user_name":"Roberto.Pt.02"
"password":"X!09b77bcd"
"email":"[email protected]"
"user_name":"Susanna.Pt.02"
"password":"X!3f36ee78"
"email":"[email protected]"
"user_name":"Elisa.Pt.02"
"password":"X!b8d673be"
"email":"[email protected]"
Please ask a member of the Open Bank Project team for more logins if you require. You can use this application which also uses OAuth to browse your transaction data (use the above username/password).
-
Q: I'm getting a 401 even if I enter the right consumer key and secret. Is the endpoint: apisandbox... correct ?
A: No, its bop.openbankproject.com
-
Q: I'm getting 404's / errors
A: Avoid trailing slashes:
https://bop.openbankproject.com/obp/v3.0.0 200 OK
https://bop.openbankproject.com/obp/v3.0.0/ 404 Not Found
https://bop.openbankproject.com/obp/v3.0.0/banks 200 OK
https://bop.openbankproject.com/obp/v3.0.0/banks/ 400 Not Found {"error":"OBP-30001: Bank not found. Please specify a valid value for BANK_ID."}
https://bop.openbankproject.com/obp/v3.0.0/banks/bop.01.com.au 200 OK
https://bop.openbankproject.com/obp/v3.0.0/banks/bop.01.com.au/ 404 Not Found
-
Q: Why doesn't it work?
A: Double check parameters are spelt correctly (including http vs https etc.)
A: Check your encoding (use UTF8)
-
To contact Open Bank Project use:
Email: [email protected]
Twitter: @OpenBankProject