v1

latestOpenAPI 3.0.12026-07-2679100267.2 KB

Virtual Accounts

Create virtual account for a sub account

You can use this endpoint to create a virtual account to receive payments for a sub account. Funds sent to the virtual account is collected in the sub account specified

post/v1/accounts/virtual/{subAccountId}

Path parameters

subAccountIdstring required

The sub accountId of the business.

Headers

accountIdstring uuid required

Example:890022ce-bae0-45c1-9b9d-ee7872e6ca27

The parent accountId of the business.

Request body

accountRefstring required

Account reference

accountNamestring required

Account holder's name

bvnstring

Account holder's BVN. Optional.

expiryDatestring

Account expiry date. Optional. ⚠️Be careful with this.

expectedAmountnumber double

Amount the account can receive. Optional.

Example request

{
  "accountRef": "1oWbJQQHLyQqqf1SwxjSpudeA21",
  "accountName": "Daniel Scorsese",
  "bvn": "12345678",
  "expiryDate": "2026-01-30 12:15:00"
}

Response

Virtual account creation successful.

codestring required

Response Code

descriptionstring required

Response description

Example response

{
  "code": "00",
  "description": "Success",
  "data": {
    "createdAt": "2023-09-04T07:09:06.900Z",
    "accountHolderId": "01a10aeb-d989-460a-bbde-9842f2b4320f",
    "accountRef": "1oWbJQQHLyQqqf1SwxjSpudeA21",
    "bvn": "12234412345",
    "accountName": "Daniel Scorsese",
    "bankName": "Nombank MFB",
    "bankAccountNumber": "9391076543",
    "bankAccountName": "Nomba/Ifeoluwa Adeboye",
    "currency": "NGN",
    "callbackUrl": "https://webhook.site/98ef100f-5adc-4434-800a-0808h60bd8d7",
    "expired": true
  }
}