Skip to main content
POST
/
v1
/
virtual-accounts
/
create
Create virtual account (customer)
curl --request POST \
  --url https://api.platnova.com/v1/virtual-accounts/create \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "currency": "NGN",
  "customer_id": "43a2b75e-5c59-429e-872a-2a54c7b17e34",
  "id_number": "22123456789",
  "codes": [
    "058"
  ],
  "beneficiary_account_id": "5c5e173f-7754-41af-a2ee-b4be7d709e0c"
}
'
{
  "status": true,
  "data": {
    "customer_id": "<string>",
    "reference": "<string>",
    "currency": "<string>",
    "email": "[email protected]",
    "first_name": "<string>",
    "last_name": "<string>",
    "created_on": "2023-11-07T05:31:56Z",
    "accounts": [
      {
        "account_number": "<string>",
        "account_name": "<string>",
        "bank_name": "<string>",
        "bank_code": "<string>",
        "ach_routing_number": "<string>",
        "rtp_routing_number": "<string>",
        "wire_routing_number": "<string>",
        "swift_code": "<string>",
        "bank_address": "<string>"
      }
    ]
  },
  "error": [
    "<unknown>"
  ],
  "message": "<string>"
}

Overview

Create a virtual account for a customer. Virtual accounts allow customers to receive payments directly into their account. This endpoint creates a bank account that can be used for receiving funds. To generate USD virtual accounts, ensure a default USD settlement wallet is set on your dashboard settings. This wallet will be billed for USD account creation fees if applicable. For NGN virtual accounts, you can optionally specify an id_number parameter in the request body, which corresponds to a valid BVN.

Authorizations

X-API-KEY
string
header
required

API key for authentication.

Body

application/json
currency
string
required

Account currency (e.g. USD, NGN)

customer_id
string
required

Customer ID

id_number
string

BVN for NGN accounts

codes
string[]

Bank codes

beneficiary_account_id
string

Required for USD; business beneficiary account UID

Response

Virtual account created successfully

status
boolean
data
object
error
any[]
message
string