v1

latestOpenAPI 3.1.02026-07-2656114159.7 KB

Virtual Accounts

Create Virtual Account

Create a reserved virtual bank account for a customer. Each reserved account is unique per customer, supports static and dynamic modes, and triggers notifications when funded. Use static accounts for recurring funding and dynamic accounts for one-time payments.

post/pms/api/external/request/customerReservedAccount/

Headers

api-keystring required

Your Payvessel public API key

api-secretstring required

Your Payvessel secret

Content-Type'application/json' required

Request content type

Request body

emailstring email required

Customer email address

namestring required

Customer full name (first name and last name)

phoneNumberstring required

Customer phone number in international format

bankcodestring[] required

List of partner bank codes to provision the virtual account with

account_type'STATIC' | 'DYNAMIC' required

Type of virtual account to create

businessidstring required

Merchant business ID supplied by Payvessel

bvnstring

Customer Bank Verification Number (required for STATIC accounts)

ninstring

Customer National Identification Number (use when BVN is unavailable)

Example request

{
  "bankcode": [
    "999991",
    "120001"
  ]
}

Response

Virtual account created successfully

statusboolean required

Indicates whether the request succeeded

servicestring required

Operation identifier

businessstring required

Merchant business ID

Example response

{
  "service": "CREATE_VIRTUAL_ACCOUNT"
}