Create My Bank (Self-Service)
POST /obp/v7.0.0/my/banks
OBPv7.0.0-createMyBank No role required Bank
Create a bank for the current User without requiring the role CanCreateBank.
This is the self-service flavour of Create Bank, intended for sandbox instances.
On this instance, self-service bank creation is currently disabled.
When the limit is reached, further banks require the role CanCreateBank (see POST /banks). The limit binds to the human User: banks created by the User directly and by any agent acting for the User under a Consent count toward the same limit.
The request body must be empty (an empty JSON object {} is also accepted):
the bank_id, short name and full name are
auto-generated by the server (e.g. bank_id granite-astra-falcon-4f2a, full name
Granite Astra Falcon Bank) and are permanent. Users holding the role CanCreateBank can instead use POST /banks to create
banks with chosen names and branding.
The user creating the bank is automatically assigned the Role CanCreateEntitlementAtOneBank at the new bank, and can therefore manage the bank and assign Roles to other Users.
The settlement accounts are automatically created by the system when the bank is created, as for POST /banks.
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
JSON request body fields (0)
JSON response body fields (11)
- address
- bank_code
- CGHZ
- bank_id
- gh.29.uk
- bank_routings
- bank routing in form of (scheme, address)
- full_name
- full name string
- logo
- logo url
- name
- ACCOUNT_MANAGEMENT_FEE
- scheme
- OBP
- value
- 5987953
- website
- www.openbankproject.com
- attributes
- attribute value in form of (name, value)
Example success response
{
"bank_id": "gh.29.uk",
"bank_code": "CGHZ",
"full_name": "bank fullName string",
"logo": "bank logoUrl string",
"website": "bank logoUrl string",
"bank_routings": [
{
"scheme": "OBP",
"address": "gh.29.uk"
}
],
"attributes": [
{
"name": "ACCOUNT_MANAGEMENT_FEE",
"value": "5987953"
}
]
}Possible errors (5)
- OBP-20001: User not logged in. Authentication is required!
- OBP-30230: Self-service bank creation is disabled on this instance.
- OBP-30231: Self-service bank creation limit reached. To create more banks you require the role CanCreateBank.
- OBP-10001: Incorrect json format.
- OBP-50000: Unknown Error.