Skip to main content
GET
/
api
/
v1
/
payment-method
/
pool-account
Get the business pool account
curl --request GET \
  --url https://sandbox.api.afriex.com/api/v1/payment-method/pool-account \
  --header 'x-api-key: <api-key>'
{ "data": { "paymentMethodId": "69c2804b30314b491e48b305", "channel": "VIRTUAL_BANK_ACCOUNT", "customerId": "6929843e2c4653277440acc0", "reference": "6929843e2c4653277440acc0", "institution": { "institutionName": "UBA" }, "accountName": "TEST", "accountNumber": "12345678", "countryCode": "NG" } }

Documentation Index

Fetch the complete documentation index at: https://docs.afriex.com/llms.txt

Use this file to discover all available pages before exploring further.

Returns the business’s pool account for a given country. A pool account is a shared, Afriex-managed account that customers pay into; Afriex reconciles incoming funds to the merchant using the reference returned on this response. Important: Pool accounts are only active in production and do not work on staging/dev.

​
How the call works

  1. Call this endpoint with country (required). Optionally pass customerId to scope the response to a specific end-user.
  2. Afriex returns the pool account (account name, account number, institution) as a PaymentMethod, along with a reference.
  3. Share the account details with your customer so they can pay in. When Afriex receives the inbound funds, it uses the reference to attribute the deposit on your account.

​
The reference field

Every response includes a reference string. Persist it alongside the deposit you expect and use it to reconcile incoming pool deposits. When you pass a customerId, the response reference matches it, so the deposit can be attributed back to that customer on your side.

​
Currency is derived from country

Unlike dedicated virtual accounts, this endpoint does not take a currency parameter. The currency is determined by the country code (for example, NG resolves to NGN). Pool accounts are only available in countries where Afriex operates a pool; an unsupported country code returns a 400.

Authorizations

​
x-api-key
string
header
required

Static business API key from the dashboard

Query Parameters

​
country
string
required

ISO 3166-1 alpha-2 country code.

Example:

"NG"

​
customerId
string

Optional customer ID to associate with this account. When supplied, it is also returned as the reference on the response.

Response

Pool account returned successfully.

​
data
object