POST /obp/v7.0.0/banks/BANK_ID/settlement-accounts

OBPv4.0.0-createSettlementAccount Roles: CanCreateSettlementAccountAtOneBank(per bank) Bank

Create a new settlement account at a bank.

The created settlement account id will be the concatenation of the payment system and the account currency. For examples: SEPA_SETTLEMENT_ACCOUNT_EUR, CARD_SETTLEMENT_ACCOUNT_USD

By default, when you create a new bank, two settlements accounts are created automatically: OBP_DEFAULT_INCOMING_ACCOUNT_ID and OBP_DEFAULT_OUTGOING_ACCOUNT_ID Those two accounts have EUR as default currency.

If you want to create default settlement account for a specific currency, you can fill the payment_system field with the DEFAULT value.

When a transaction is saved in OBP through the mapped connector, OBP-API look for the account to save the double-entry transaction. If no OBP account can be found from the counterparty, the double-entry transaction will be saved on a bank settlement account.

First, the mapped connector looks for a settlement account specific to the payment system and currency. E.g SEPA_SETTLEMENT_ACCOUNT_EUR.
If we don't find any specific settlement account with the payment system, we look for a default settlement account for the counterparty currency. E.g DEFAULT_SETTLEMENT_ACCOUNT_EUR.
Else, we select one of the two OBP default settlement accounts (OBP_DEFAULT_INCOMING_ACCOUNT_ID/OBP_DEFAULT_OUTGOING_ACCOUNT_ID) according to the transaction direction.

If the POST body USER_ID is specified, the logged in user must have the Role CanCreateAccount. Once created, the Account will be owned by the User specified by USER_ID.

If the POST body USER_ID is not specified, the account will be owned by the logged in User.

Note: The Amount MUST be zero.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

BANK_ID: gh.29.uk

{ "user_id": "9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "payment_system": "SEPA", "balance": { "currency": "EUR", "amount": "0" }, "label": "My Account", "branch_id": "DERBY6", "account_routings": [ { "scheme": "OBP", "address": "8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0" } ] }

{ "account_id": "8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "user_id": "9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "payment_system": "SEPA", "balance": { "currency": "EUR", "amount": "0" }, "label": "My Account", "branch_id": "DERBY6", "account_routings": [ { "scheme": "OBP", "address": "8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0" } ], "account_attributes": [ { "product_code": "1234BW", "account_attribute_id": "613c83ea-80f9-4560-8404-b9cd4ec42a7f", "name": "OVERDRAFT_START_DATE", "type": "DATE_WITH_DAY", "value": "2012-04-23", "product_instance_code": "LKJL98769F" } ] }