β¨Create Virtual Account
Partners Bank Code.
20867
Palmpay
29007
Safehaven (Dynamic)
π Request Headers
{
"Authorization": "Bearer YOUR_API_SECRET",
"Content-Type": "application/json",
"api-key": "YOUR_API_KEY"
}
π¦ Request Body
You can provide customer details in two ways, depending on whether you already have a customer_id
(an existing KYC-verified customer):
β
Option 1: Using customer_id
(for existing KYCed customers)
customer_id
string
β
The unique customer identifier
bankCode
array
β
List of partner bank codes
businessId
string
β
Your registered business ID
accountType
string
β
static
or dynamic
amount
number
β if dynamic
Amount to be paid (for dynamic only)
externalReference
string
No
externalReference For dynamic account (Not required)
callbackUrl
string|url
No
callbackUrl for dynamic account (Not required)
β‘οΈ Notes:
πΈ If accountType
is dynamic
, amount
is required.
πΈ Do not include name
, email
, phoneNumber
, id_type
, or id_number
.
Example:
{
"customer_id": "cus_8ed239dks2s7",
"bankCode": ["20867"],
"businessId": "xixapay-business-id-123",
"accountType": "dynamic",
"amount": 1500
}
β Option 2: Using Raw Customer Data (for new or unverified customers)
string
β
Customer email address
name
string
β
Customer full name
phoneNumber
string
β
Customer phone number
bankCode
array
β
List of partner bank codes
businessId
string
β
Your registered business ID
accountType
string
β
static
or dynamic
amount
number
β if dynamic
Amount to be paid (for dynamic only)
id_type
string
π
e.g., nin
, bvn
β required if static
id_number
string
π
The actual ID number β required if static
β‘οΈ Notes:
id_type
andid_number
are only required ifaccountType
is set tostatic
.For
dynamic
accounts, they are optional.
Example (Static Account):
{
"email": "[email protected]",
"name": "John Doe",
"phoneNumber": "08123456789",
"bankCode": ["20867"],
"businessId": "xixapay-business-id-123",
"accountType": "static",
"id_type": "nin",
"id_number": "12345678901"
}
Example (Dynamic Account without ID):
{
"email": "[email protected]",
"name": "Jane Doe",
"phoneNumber": "08012345678",
"bankCode": ["20867"],
"businessId": "xixapay-business-id-123",
"accountType": "dynamic",
"amount": 5000
}
// response sample
{
"status": "success",
"message": "Customer account created successfully. Bank account(s) processed and ready for use.",
"customer": {
"customer_id": "fa6aa77cbc60ee04c67f5b7d56394733ed67b924",
"customer_name": "a",
"customer_email": "ad.com",
"customer_phone_number": "07"
},
"business": {
"business_name": "Av",
"business_email": "a",
"business_phone_number": "07018",
"business_Id": null
},
"bankAccounts": [
{
"bankCode": "20867",
"accountNumber": "6698059290",
"accountName": "A(xixapay)",
"bankName": "Palmpay",
"accountTye": "static"
"Reserved_Account_Id": "3a28cfe332ccf8596bd454584"
},
],
}
Last updated