Skip to main content
POST
/
pms
/
api
/
external
/
request
/
customerReservedAccount
Create Virtual Account
curl --request POST \
  --url http://sandbox.mintlify.com/pms/api/external/request/customerReservedAccount/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: <content-type>' \
  --header 'api-key: <api-key>' \
  --header 'api-secret: <api-secret>' \
  --data '
{
  "email": "[email protected]",
  "name": "JOHN DOE",
  "phoneNumber": "09012345672",
  "bankcode": [
    "999991",
    "120001"
  ],
  "account_type": "STATIC",
  "businessid": "061C074E2F91F944B93993B4",
  "bvn": "22345678901",
  "nin": "12345678901"
}
'
{
  "status": true,
  "service": "CREATE_VIRTUAL_ACCOUNT",
  "business": "<string>",
  "banks": [
    {
      "bankName": "<string>",
      "accountNumber": "<string>",
      "accountName": "<string>",
      "account_type": "STATIC",
      "trackingReference": "<string>",
      "expire_date": "2023-11-07T05:31:56Z"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
api-key
string
required

Your Payvessel public API key

​
api-secret
string
required

Bearer token with your Payvessel secret

​
Content-Type
enum<string>
required

Request content type

Available options:
application/json

Body

application/json
​
email
string<email>
required

Customer email address

​
name
string
required

Customer full name (first name and last name)

​
phoneNumber
string
required

Customer phone number in international format

​
bankcode
enum<string>[]
required

List of partner bank codes to provision the virtual account with

Available options:
999991,
120001
Example:
["999991", "120001"]
​
account_type
enum<string>
required

Type of virtual account to create

Available options:
STATIC,
DYNAMIC
​
businessid
string
required

Merchant business ID supplied by Payvessel

​
bvn
string

Customer Bank Verification Number (required for STATIC accounts)

​
nin
string

Customer National Identification Number (use when BVN is unavailable)

Response

Virtual account created successfully

​
status
boolean
required

Indicates whether the request succeeded

​
service
string
required

Operation identifier

Example:

"CREATE_VIRTUAL_ACCOUNT"

​
business
string
required

Merchant business ID

​
banks
object[]
required

Generated virtual bank accounts