List Virtual Accounts

List Dedicated Accounts

Get all dedicated virtual accounts on your integration.

Endpoint: GET https://api.budpay.com/api/v2/list_dedicated_accounts

Parameters

This section details the header information required for listing dedicated accounts.

Field Name	Description
URL	`https://api.budpay.com/api/v2/list_dedicated_accounts`
Method	`GET`
Authorization	`Bearer YOUR_SECRET_KEY` (Replace with your actual BudPay secret key)

Query Parameters (Optional)

Parameter	Type	Required	Description
`active`	String	No	Filter by account status
`currency`	String	No	Filter by currency (only `NGN` supported)

Sample Request

curl https://api.budpay.com/api/v2/list_dedicated_accounts \
  -H "Authorization: Bearer YOUR_SECRET_KEY" \
  -X GET

Sample Response

{
  "status": true,
  "message": "Dedicated accounts retrieved",
  "data": [
    {
      "account_name": "Samji Ventures / Tolu Oye",
      "account_number": "7235483839",
      "bank": "Wema Bank",
      "currency": "NGN",
      "status": "active",
      "customer": {
        "email": "toluxsys@yahoo.ca",
        "customer_code": "CUS_ctiv4kdyniqtjqe"
      }
    }
  ]
}

Try it out

Response Fields

Field	Description
`account_name`	Generated account name (Business Name / Customer Name)
`account_number`	Dedicated NUBAN account number
`bank`	Bank providing the virtual account
`currency`	Account currency (`NGN`)
`status`	Account status (`active`, `inactive`)
`customer`	Customer details attached to the account

Create Bulk Virtual Accounts Fetch Virtual Account Details