SwitchApp API
  • Introduction
  • Quick Start
  • Authentication
  • Errors
  • Metadata
  • Pagination
  • Versioning
  • No-code solutions
  • Webhooks
  • Payments
    • Transactions
      • Initialize a transaction
      • Verify transaction
      • List transactions
      • Retrieve Transaction
      • Transaction Webhooks
  • Payment Providers
    • Payment Providers
  • Countries & Currencies
    • Countries
    • Currencies
  • Products
    • Products
      • Create a product
      • Retrieve a product
      • Update a product
      • List all products
      • Delete a product
  • Customers
    • Customers
      • Create Customer
      • List Customers
      • Fetch Customer
      • Update Customer
      • Delete/Archive Customer
  • Payment Links
    • Payment Links
      • Create a payment link
      • Fetch payment link
      • Update a payment link
      • List all payment links
      • Delete a payment link
  • Payouts
    • Payouts
      • List Payouts
      • Fetch Payout
      • Retry Payout
  • BALANCES
    • Balances
      • Fetch all balances
      • Fetch a balance
      • Fetch currency balance
  • DISBURSEMENTS
    • Disbursements (Transfers)
      • Batch Disbursements
        • Initiate A Disbursement
        • List Batch Transfers
        • Fetch A Batch
        • Requeue All Failed Transfers
      • Single Disbursements
        • Fetch List By Batch Reference
        • Fetch All Singles By Page
        • Fetch A Single Disbursement
        • Fetch fee
        • Fetch rate
    • Beneficiaries
      • Create a beneficiary
      • List all beneficiaries
      • Fetch a beneficiary
      • Delete a beneficiary
    • Banks
      • Bank list
      • Bank slugs
      • Resolve account details
  • VIRTUAL ACCOUNTS
    • Virtual Accounts
      • Top-up virtual accounts
        • Fetch providers
        • Create top-up account
        • List accounts
        • Fetch account
        • Requery account
        • Deallocate account
      • Payment virtual accounts
        • Fetch providers
        • Create payment account
        • Update account details
        • List accounts
        • Fetch account
        • Requery account
        • Deallocate account
Powered by GitBook
On this page
  1. VIRTUAL ACCOUNTS
  2. Virtual Accounts
  3. Payment virtual accounts

List accounts

PreviousUpdate account detailsNextFetch account

Last updated 6 months ago

get
Authorizations
Query parameters
searchstringOptional
pageinteger · int32Optional
page_sizeinteger · int32Optional
CurrencystringOptional
Responses
200
Success
application/json
get
GET /v1/customer-dedicated-accounts HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
200

Success

{
  "status": "success",
  "message": "text",
  "data": [
    {
      "id": "text",
      "is_live": true,
      "account_reference": "text",
      "gateway_code": "text",
      "callback_url": "text",
      "account_name": "text",
      "account_number": "text",
      "country": "text",
      "bank_code": "text",
      "bank_name": "text",
      "currency": "text",
      "bvn": "text",
      "metadata": "text",
      "created_at": "2025-05-20T16:32:32.542Z",
      "edited_at": "2025-05-20T16:32:32.542Z",
      "customer_id": "text",
      "payout_tag": "text",
      "payout_tag_description": "text",
      "payout_tag_metadata": "text"
    }
  ],
  "meta": {
    "page_meta": {
      "page_count": 1,
      "item_count": 1,
      "search": "text",
      "page": 1,
      "page_size": 1
    }
  },
  "errors": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  },
  "is_error": true
}