VantPay API Documentation
API Docs
API Docs
  1. API Docs
  • Authentication
    • Authenticate
      POST
  • Virtual Account
    • Create Static Virtual Account
      POST
    • Create Dynamic Virtual Account
      POST
    • List Static Virtual Accounts
      GET
    • get-wallet-balance
      GET
    • get-prefixes
      GET
    • get-dynamic-virtual-accounts
      GET
    • validate-virtual-account
      POST
  • Inward Transfers
    • Inward TransQuery (TSQ)
      • inward-transquery
    • Inward Transactions
      • get-wallet transactions
  • Merchant Settlement
    • Merchant Payout
      • merchant-settlement
    • Get Settlement History
      • get-settlement-history
    • Confirm Payout Status
      • get-settlement-status
  • Checkout
    • initiate-checkout
      POST
    • create-account
      POST
    • complete-checkout
      POST
    • query-access-code
      GET
  • Transactions
    • List Transactions (and fetch by reference)
      GET
  • Wallet
    • Get Wallet Balance
      GET
  • Webhooks
    • Set Notification (Webhook) URL
      POST
    • Collection Notification (received by YOU, not called by you)
      POST
  • Schemas
    • AuthData
    • ApiResponseEnvelope
    • StaticAccountData
    • AuthenticateResponse
    • DynamicAccountData
    • VirtualAccountStatic
    • StaticAccountListItem
    • CreateStaticVirtualAccountResponse
    • Transaction
    • VirtualAccountDynamic
    • PagedStaticAccounts
    • CreateDynamicVirtualAccountResponse
    • PagedTransactions
    • VirtualAccountListItem
    • WalletBalanceData
    • CollectionNotification
    • PagedVirtualAccountList
    • ListStaticVirtualAccountsResponse
    • PagedTransactionList
    • ListTransactionsResponse
    • WalletBalance
    • WalletBalanceResponse
    • SetNotificationUrlResponse
    • WebhookCollectionPayload
  1. API Docs

Create Virtual Account

Both create virtual endpoints are designed to create both dynamic & static wallet on the VantPay platform for collection purposes.

Create Static Account#

Descriptions for each field:
BVN: Customer’s Bank Verification Number. This is a mandatory field required for identity validation and for the creation of a static virtual account.
Prefix: Merchant-specific prefix assigned by the system. This mandatory field is used in generating the customer’s virtual account number.
TerminalId: Unique identifier of the merchant’s terminal or channel initiating the request. Used in identifying POS transaction and routing (Optional).
Amount: Transaction amount to be processed, expressed in the lowest currency denomination where applicable. Must be greater than zero if amount validation is enabled on the prefix (Optional).
IsPos: Boolean flag indicating whether the account is to be used on a POS terminal (Optional).
true – Transaction initiated via POS
false – Transaction initiated via a non-POS channel
This endpoint enables the creation of static virtual accounts on the VantPay platform for collection purposes.

Create Dynamic Account#

Descriptions for each field:
Prefix: Merchant-specific prefix assigned by the system. This mandatory field is used in generating the customer’s virtual account number.
Amount: Transaction amount to be processed, expressed in the lowest currency denomination where applicable. Must be greater than zero if amount validation is enabled on the prefix (Optional).
FirstName: Customer’s first name as it appears on official records. This field is mandatory for account identification and record creation.
LastName: Customer’s surname/last name as it appears on official records. This field is mandatory for proper customer identification.
PhoneNumber: Customer’s valid and active mobile number. Used for communication, transaction notifications, and account association. Must be in a valid format.

This endpoint enables the creation of dynamic virtual accounts on the VantPay platform for collection purposes.

NB:
This type of account has a configurable validity period and expires after the defined timeframe.
Modified at 2026-02-26 02:43:09
Previous
Authenticate
Next
Create Static Virtual Account
Built with