Create a virtual account

Create a virtual account

Body Params
string
required
length between 6 and 42

A custom identifier to track the transaction, This must be unique across all your transactions.

string
required

The customer id

number
required

The amount to be collected. Specify 0 for static accounts.

integer
60 to 31536000

The expiry time of the virtual account.

enum
required

ISO 4217 currency code.

Allowed:
string
enum
required

The type of virtual account.

Allowed:
meta
object
string

This allows you specify the name shown when the account is resolved.

string

This is the customer's Bank Verification Number.

string

This is the customer's National Identity Number.

string

This is the bank account the transfer will originate from. required for EGP and KES

number
string

The bank code.

Headers
string
length between 12 and 255

A unique identifier to track this operation. It must be between 12 and 255 characters in length.

string
length between 12 and 255

A unique identifier to prevent duplicate requests. It must be between 12 and 255 characters in length.

string
1 to 1000

An optional scenario key that can be used to simulate specific behaviors or test different scenarios within the API. Providing this header allows you to trigger predefined responses or alter data based on the key's value, which can be useful for testing, development, or demonstrating specific functionalities. The key should be a string of 1 to 1000 characters.

Responses

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