v1

latestOpenAPI 3.1.02026-07-26540161.7 KB

Create Virtual Account

This API lets you create local currency virtual accounts.

post/profile/virtual-accounts/requests-1

Request body

currency'NGN' | 'GHS' | 'KES' | 'TZS' required

The virtual account currency.

accountType'individual' | 'corporate' required

The Virtual account type

merchantReferencestring

A unique ID/reference of the virtual account on your system.

phoneNumberstring

The customer's phone number

Response

200

successboolean

messagestring

Example response

{
  "success": true,
  "message": "Thank you, Omobola Ibrahim. We are now processing your GBP account request",
  "data": {
    "status": "pending",
    "KYCInformation": {
      "address": {
        "countryOfResidence": "NG",
        "zip": "23401",
        "street": "Ikereku",
        "number": "2",
        "state": "Lagos",
        "city": "Alimosho"
      },
      "document": {
        "type": "passport",
        "number": "B23455",
        "issuedCountryCode": "NG",
        "issuedBy": "government",
        "issuedDate": "2020-01-01",
        "expirationDate": "2025-02-02T00:00:00.000Z"
      },
      "firstName": "Ayomide",
      "lastName": "Omotolani",
      "email": "omotola@gmail.com",
      "birthDate": "1223-02-02",
      "nationality": "NG",
      "incomeBand": "0-90000",
      "phone": "09098765432",
      "occupation": "Dev Rel",
      "sourceOfIncome": "Dev rel",
      "accountDesignation": "personal",
      "employmentStatus": "Employed"
    },
    "isPermanent": true,
    "meansOfId": [
      {
        "name": "france-in-pictures-beautiful-places-to-photograph-eiffel-tower.jpg",
        "url": "https://reviewtestbucket.s3.amazonaws.com/va_documents/france-in-pictures-beautiful-places-to-photograph-eiffel-tower_033abdf0-2adc-499c-af6d-086b315d5cdc.jpg"
      }
    ],
    "bankStatement": [
      {
        "name": "france-in-pictures-beautiful-places-to-photograph-eiffel-tower.jpg",
        "url": "https://reviewtestbucket.s3.amazonaws.com/va_documents/france-in-pictures-beautiful-places-to-photograph-eiffel-tower_85379bd3-8cf6-444f-848b-97b03e8f7a1c.jpg"
      }
    ],
    "utilityBill": [
      {
        "name": "france-in-pictures-beautiful-places-to-photograph-eiffel-tower.jpg",
        "url": "https://reviewtestbucket.s3.amazonaws.com/va_documents/france-in-pictures-beautiful-places-to-photograph-eiffel-tower_347b4c39-ccd0-4298-a5d4-c8b11e113e90.jpg"
      }
    ],
    "virtualAccountType": "additional",
    "_id": "64ad8a2748165924f46d6ad0",
    "business": "63da866cb938c4e0b871f514",
    "currency": "GBP",
    "accountType": "individual",
    "entityType": "main_account",
    "currencyType": "fiat",
    "createdAt": "2023-07-11T16:58:15.641Z",
    "updatedAt": "2023-07-11T16:58:15.641Z"
  }
}