AFafriex
Payment Methods

List existing virtual accounts

Returns every active virtual account for the resolved customer-or-owner and currency. Read-only: when no virtual account exists, the response is 200 with data: [].

Pass customerId to scope the list to a specific end-user; omit it to list the virtual accounts belonging to the business owner.

Breaking change from earlier versions: the previous endpoint returned a single virtual account and would create one on the fly when absent. It now returns a list and never creates. The create path lives at POST /api/v1/payment-method/virtual-account; the POOL_ACCOUNT variant has moved to GET /api/v1/payment-method/pool-account.

get/api/v1/payment-method/virtual-account

Request

Query parameters

currency'NGN' | 'GHS' | 'KES' | 'USD' required

The 3-letter ISO 4217 currency code for the virtual account. The listed values are the supported currencies; other valid currency codes pass validation and simply return an empty list.

customerIdstring

Optional customer ID. When supplied, the lookup is scoped to that customer. When omitted, it resolves to the business owner.

countrystring

Optional ISO 3166-1 alpha-2 country code.

amountnumber

Optional positive amount.

referencestring

Optional merchant-supplied reference.

Response

Virtual accounts retrieved successfully (possibly empty list).

totalinteger

Number of items in data.

pageinteger

Page index. Currently always 0, the endpoint returns all matching VAs in a single response.

Changes

No recorded changes to this operation across all 1 revision of this API.