Virtual Accounts
Create a Virtual Account
The accountDetails is only required for on-behalf-of collections via Virtual Account.
Authorization
authorization AuthorizationBearer <token>
Set Your Secret API Key
In: header
Header Parameters
Idempotency-Key?string
A unique value, eg. a UUID.
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
accountDetails?AccountDetails
Details of the person or corporate associated with this virtual account. Only required for on-behalf-of collections via Virtual Account.
virtualAccountName*string
The name associated with the virtual account.
For DBS, maximum length is 50 characters.
virtualAccountNumber*string
The complete virtual account number including any mandatory prefixes.
Response Body
*/*
application/json
application/json
curl -X POST "https://example.com/v1/virtual-accounts" \
-H "Content-Type: application/json" \
-d '{
"virtualAccountName": "string",
"virtualAccountNumber": "string"
}'{
"accountDetails": {
"address": {
"city": "string",
"country": "string",
"line1": "string",
"line2": "string",
"postalCode": "string",
"state": "string"
},
"alias": "string",
"countryOfIncorporation": "string",
"dateOfBirth": "string",
"dateOfIncorporation": "string",
"idCountry": "string",
"idNumber": "string",
"idType": "string",
"nationality": "string",
"type": "string"
},
"createdAt": "string",
"id": "string",
"internalAccountId": "string",
"resultCode": "string",
"status": "string",
"updatedAt": "string",
"virtualAccountName": "string",
"virtualAccountNumber": "string"
}