Skip to main content
POST
Create virtual account

Authorizations

x-api-key
string
header
required

Body

application/json
customerId
string
required

The customer uuid

Example:

"224ca5c5-f2a6-419b-bf36-73997434d945"

currency
string
required

NGN, CAD, USD, EUR, GBP, KES, GHS or TZS

Example:

"NGN"

type
enum<string>
required
Available options:
dedicated,
dynamic
Example:

"dedicated"

country
string
Example:

"NG"

reference
string

Your own reference, unique per merchant

Example:

"va_1001"

metadata
object
Example:
amount
number

Dynamic accounts only: the amount the payer must send

Example:

5000

expiresIn
number

Dynamic accounts only: seconds until the account expires

Example:

7200

redirectUrl
string

Where the customer returns after a hosted verification step (USD, EUR, GBP)

Example:

"https://app.example.com/verification-complete"

termsAcceptance
object

Needed for CAD accounts

Response