Virtual Accounts

Create a Virtual Account

POST
/v1/virtual-accounts

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?

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.

virtualAccountNumber*string

The complete virtual account number including any mandatory prefixes.

Response Body

*/*

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"}