Create Account

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Creates a bank account number for one of your customers. Transfers into it are credited to your business and reported with wallet events. A successful request returns HTTP 201.

The account name is your business name followed by the customer's name.

Dedicated or omnibus

You sendYou getWebhook when funded
No destinationWalletA dedicated account with its own wallet. You can read its historyvirtual_account_funded
destinationWallet set to one of your NGN balance walletsAn omnibus account that pays into that wallet. It has no history of its ownvirtual_account_funded
📘

Before you start

Get a provider slug from Available Providers. customerAccountNumber and customerBankCode are the customer's own bank account, which the provider uses to verify them. Get bank codes from List Banks.

Errors

CodeMessageWhen
204Input is invalidA required field is missing or malformed. data lists each field
208Data not updatedThe provider couldn't create the account. Check the customer details and try again
221Wallet not founddestinationWallet isn't one of your NGN balance wallets
342You do not have permission to take that actionYour keys lack the dedicated-accounts permission
Path Params
string
required
Body Params
string
required
string
required
string
required
string
required
string
required
string
required
string
required

Provider slug from Available Providers.

string
required
Defaults to NGN

ISO currency code

string
required
Defaults to NG

ISO code for country

string
enum
required
Defaults to personal
Allowed:
integer

Optional NGN balance wallet to pay into. Leave it out to create a dedicated wallet for this account; set it to create an omnibus account that pays into that wallet.

integer

Existing customer to attach the account to.

Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json