Sign in

v1

latestOpenAPI 3.1.02026-07-26590236.8 KB

Create Bank Account

post/bank_account

Request body

business_idstring

Required for business accounts

person_idstring

Required for personal accounts

labelstring required
currency'USD' | 'NGN' | 'EUR' required
autosweep_enabledboolean

When 'autosweep_enabled' is set to true, any funds deposited in the account will automatically flow to your master wallet; if set to false, the deposited money stays in the balance of this account.

whitelist_enabledboolean

Enable this if you want to restrict deposits to only come from a specific bank account. This option is only available to NGN accounts

Response

201

messagestring
{"stackTrail":"paths:/bank_account:post:responses:201:content:application/json:schema:properties:meta","oasType":"schema","type":"unknown"}
statusstring

Example response

{
  "data": {
    "id": "8b013b5868f111eda78fe041a4724e32",
    "holder_id": "6289dedc686511eda78fe041a4724e32",
    "holder_type": "person",
    "label": "Yomi's Account",
    "currency": "USD",
    "type": "personal_checking",
    "status": "pending",
    "created_at": "2022-11-20T17:36:54Z",
    "updated_at": "2022-11-20T17:36:54Z"
  },
  "message": "Bank account creation processing",
  "status": "success"
}