IvoryPay API Documentation
  • Authorization
    • Using your API key
  • Webhook
  • Country
  • Currency
  • Exchange Rates
  • Accept a payment
    • Initiate a transaction
    • Verify transaction
    • Pay Via Wallet Connection
  • Payment Link
    • Create a payment link
    • Update a payment link
    • Fetch payment links
    • Fetch a payment link
    • Delete a payment link
    • Initiate a payment link transaction
  • Customer
    • Add a customer
    • Update a customer
    • Fetch customers
    • Fetch a customer
    • Remove a customer
  • Swap
    • Initiate a swap
    • Fetch a swap
    • Execute a swap
  • Bank
    • Fetch banks
    • Resolve Bank Account Name
  • Bank Detail
    • Add a bank detail
    • Fetch bank details
    • Remove a bank detail
  • Payout Request
    • Create on-chain payout request
    • Create bank payout request
    • Cancel a payout request
  • Virtual Bank Account
    • Create a private customer virtual account
    • Create a business customer virtual account
    • Fetch virtual accounts
    • Simulate a transfer to a virtual account
  • Packages and SDKs
    • React Native
    • Flutter
Powered by GitBook
On this page
  1. Virtual Bank Account

Fetch virtual accounts

Fetch a paginated list of virtual accounts

GET https://api.ivorypay.io/v1virtual-accounts

Query Parameters

Name
Type
Description

type

String

The virtual account type. Possible values are CUSTOMER_ACCOUNT and PERSONAL_ACCOUNT.

page

String

Page for pagination

limit

String

Number of records per page

{
    "status": "success",
    "message": "Query successful",
    "data": {
        "records": [
            {
                "uuid": "0e761a4d-1df1-4a43-8891-27eb8aa33f36",
                "accountNumber": "6353226122",
                "bankIdentifier": "058",
                "bankName": "GTBank",
                "currency": "NGN",
                "customerReference": "77iugugiuf87t98ytg0gh809",
                "type": "CUSTOMER_ACCOUNT",
                "createdAt": "2023-09-13T10:40:42.263Z",
                "updatedAt": "2023-09-13T10:40:42.263Z"
            },
        ],
        "count": 1
    }
}
PreviousCreate a business customer virtual accountNextSimulate a transfer to a virtual account

Last updated 1 year ago