Create Virtual Account

Create a dedicated virtual bank account for receiving fiat deposits.

Creates a permanent virtual bank account that can receive fiat deposits. Deposits are automatically settled into crypto.

Endpoint

POST /v1/virtual-accounts

Authentication

Header

Value

x-api-key

Your API key

Request body

Field

Type

Required

Description

email

string

Yes

Customer's email address

identityType

string

Yes

Identity verification type: bvn, nin, or cac

identityNumber

string

Yes

Identity number corresponding to the identity type

currency

string

Yes

Fiat currency for the account. See Supported Currencies

Example request

curl -X POST https://ramp-api.ivorypay.io/api/v1/virtual-accounts \
  -H "x-api-key: your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "email": "merchant-user@example.com",
    "identityType": "bvn",
    "identityNumber": "22222222222",
    "currency": "NGN"
  }'

const response = await fetch("https://ramp-api.ivorypay.io/api/v1/virtual-accounts", {
  method: "POST",
  headers: {
    "x-api-key": "your_api_key",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    email: "merchant-user@example.com",
    identityType: "bvn",
    identityNumber: "22222222222",
    currency: "NGN",
  }),
});

const data = await response.json();
console.log(data);

import requests

response = requests.post(
    "https://ramp-api.ivorypay.io/api/v1/virtual-accounts",
    headers={
        "x-api-key": "your_api_key",
        "Content-Type": "application/json",
    },
    json={
        "email": "merchant-user@example.com",
        "identityType": "bvn",
        "identityNumber": "22222222222",
        "currency": "NGN",
    },
)

print(response.json())

package main

import (
	"bytes"
	"encoding/json"
	"fmt"
	"io"
	"net/http"
)

func main() {
	body, _ := json.Marshal(map[string]string{
		"email":          "merchant-user@example.com",
		"identityType":   "bvn",
		"identityNumber": "22222222222",
		"currency":       "NGN",
	})

	req, _ := http.NewRequest("POST", "https://ramp-api.ivorypay.io/api/v1/virtual-accounts", bytes.NewBuffer(body))
	req.Header.Set("x-api-key", "your_api_key")
	req.Header.Set("Content-Type", "application/json")

	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()

	respBody, _ := io.ReadAll(resp.Body)
	fmt.Println(string(respBody))
}

Example response

{
  "statusCode": 201,
  "success": true,
  "message": "Virtual account created successfully",
  "data": {
    "bankCode": "101",
    "bankName": "Providus Bank",
    "virtualAccountNumber": "9900123456",
    "virtualAccountName": "IvoryPay - Merchant User",
    "customerIdentifier": "merchant-user@example.com",
    "currency": "NGN",
    "createdDate": "2026-03-26T12:00:00.000Z"
  }
}

Response fields

Field

Type

Description

bankCode

string

Bank code of the virtual account provider

bankName

string

Bank name

virtualAccountNumber

string

The virtual account number — share this with your user

virtualAccountName

string

Account name displayed to senders

customerIdentifier

string

Email used to create the account

currency

string

Fiat currency

createdDate

string

ISO 8601 creation timestamp

Identity types

Type

Description

Example

bvn

Bank Verification Number (Nigeria)

11-digit number

nin

National Identification Number (Nigeria)

11-digit number

cac

Corporate Affairs Commission (Nigeria, businesses)

Registration number

PreviousDelete Customer NextList Virtual Accounts

Last updated 1 month ago

hashtagEndpoint

hashtagAuthentication

hashtagRequest body

hashtagExample request

hashtagExample response

hashtagResponse fields

hashtagIdentity types

Endpoint

Authentication

Request body

Example request

Example response

Response fields

Identity types