> ## 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. # Get Pool Account > Returns the pool account for the supplied `country`. Use the `reference` on the response to reconcile incoming deposits. 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`. *** ## Related * [List Virtual Accounts](/api-reference/endpoint/payment-methods/virtual-account) for dedicated per-customer accounts. * [Create Virtual Account](/api-reference/endpoint/payment-methods/virtual-account-create) to mint a new dedicated account. ## OpenAPI ````yaml GET /api/v1/payment-method/pool-account openapi: 3.1.0 info: title: Afriex Business API version: 1.0.8 description: >- Welcome to the Afriex Business API. This API allows you to manage customers, process payments, handle payouts, and receive real-time notifications via webhooks. For detailed guidance on authentication, pagination, error handling, and webhooks, please refer to the [dedicated guides](https://docs.afriex.com) in the top bar. The guide provides a step-by-step instructions to help you integrate seamlessly. termsOfService: https://www.afriex.com/terms-and-condition contact: name: Afriex API Support email: eng@afriex.co url: https://docs.afriex.com license: name: Proprietary url: https://www.afriex.com/terms-and-condition servers: - url: https://sandbox.api.afriex.com description: Staging Base URL - url: https://api.afriex.com description: Production Base URL security: - ApiKey: [] tags: - name: Customers description: Create and manage your customers. - name: Payment Methods description: Register and resolve customer payout and collection methods. - name: Transactions description: Create and track deposits, withdrawals, and swaps. - name: Balance description: View and top up your business wallet balances. - name: Rates description: Fetch real-time exchange rates. - name: Checkout Sessions description: Create hosted checkout sessions. - name: Webhooks description: Webhook event payloads and sandbox webhook testing. paths: /api/v1/payment-method/pool-account: parameters: - $ref: '#/components/parameters/x-api-version' get: tags: - Payment Methods summary: Get the business pool account description: | Returns the pool account for the supplied `country`. Use the `reference` on the response to reconcile incoming deposits. operationId: getPoolAccount parameters: - name: country in: query description: ISO 3166-1 alpha-2 country code. required: true schema: type: string examples: - NG - name: customerId in: query description: Optional customer ID to associate with this account. required: false schema: type: string - name: amount in: query description: Optional positive amount. Accepted but ignored. required: false schema: type: number - name: reference in: query description: Optional merchant-supplied reference. Accepted but ignored. required: false schema: type: string responses: '200': description: Pool account returned successfully. content: application/json: schema: type: object properties: data: $ref: '#/components/schemas/PaymentMethod' examples: poolAccountNG: summary: Pool account assigned for an NG/NGN deposit value: data: paymentMethodId: 69c2804b30314b491e48b305 channel: VIRTUAL_BANK_ACCOUNT customerId: 6929843e2c4653277440acc0 reference: 6929843e2c4653277440acc0 institution: institutionName: UBA accountName: TEST accountNumber: '12345678' countryCode: NG '400': description: >- Invalid request, no pool account configured for the country, or an unsupported country code was supplied. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: missingCountry: summary: Missing country value: code: INVALID_BUSINESS_POOL_ACCOUNT_REQUEST error: Invalid business pool account request details: errorMessage: Invalid business pool account request friendlyMessage: No country code provided '401': description: Unauthorized - Invalid business API key. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: missingApiKey: summary: Missing API key value: code: AUTHENTICATION_ERROR error: Authorization header is missing details: {} invalidApiKey: summary: Invalid API key value: code: AUTHENTICATION_ERROR error: Invalid authorization header details: {} '500': description: Server error. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: processorNotFound: summary: No pool account available for the country (for example, MX) value: code: TRANSACTION_PROCESSOR_NOT_FOUND error: Transaction processor not found details: errorMessage: Transaction processor not found friendlyMessage: No pool account available for business for this country serverError: summary: Unexpected server error value: code: INTERNAL_SERVER_ERROR error: It's not you, it's us, please reach out to support details: {} x-codeSamples: - lang: TypeScript label: Afriex SDK source: | const poolAccount = await afriex.paymentMethods.listPoolAccounts({ customerId: "customer-id", country: "NG", }); components: parameters: x-api-version: name: x-api-version in: header required: false description: >- API version in ISO 8601 format (e.g. 2025-12-28). Defaults to latest stable. schema: type: string schemas: PaymentMethod: type: object description: >- A payment method. Empty fields are omitted. Account-shaped channels (BANK_ACCOUNT, MOBILE_MONEY, SWIFT, etc.) populate accountName, accountNumber, and institution; the CARD channel instead populates last4, brand, expiration, and cardName. properties: paymentMethodId: type: string description: The unique identifier for the payment method. customerId: $ref: '#/components/schemas/customerId' reference: type: string description: Identifier to reconcile incoming deposits against. institution: $ref: '#/components/schemas/PaymentMethodInstitution' transaction: $ref: '#/components/schemas/PaymentMethodTransaction' recipient: $ref: '#/components/schemas/PaymentMethodRecipient' channel: type: string enum: - BANK_ACCOUNT - MOBILE_MONEY - SWIFT - INTERAC - UPI - WE_CHAT - ALIPAY - CARD - CRYPTO - VIRTUAL_BANK_ACCOUNT - POOL_ACCOUNT - ACH_BANK_ACCOUNT - PAYBILL_TILL - RFP - VIRTUAL_CARD description: The payment method channel. countryCode: type: string description: The ISO 3166-1 alpha-2 country code. currency: type: string description: >- The payment method's currency (ISO 4217). Use this instead of inferring currency from countryCode, which is ambiguous (e.g. a USD account in a non-US country). capabilities: type: array items: type: string description: >- The operations this payment method is enabled for (e.g. DEPOSIT, WITHDRAW). Use it to select deposit-capable vs withdraw-capable methods. Also filterable via the `capabilities` query parameter. accountName: type: string description: Name of the account holder. Present for account-shaped channels. accountNumber: type: string description: Account number. Present for account-shaped channels. routingNumber: type: string description: >- Bank routing number. Present for account-shaped channels that carry one (e.g. ACH bank accounts). status: type: string enum: - active - pending - deleted - expired - blocked description: Lifecycle status of the payment method. last4: type: string description: Last 4 digits of the card. CARD channel only. brand: type: string enum: - Visa - MasterCard - Discover - American Express - JCB - Diners Club - Eftpos Australia - UnionPay - Unknown description: Card brand. CARD channel only. expiration: type: object description: Card expiration. CARD channel only. properties: month: type: integer year: type: integer cardName: type: string description: Name on the card. CARD channel only. expiresInMinutes: type: integer description: Minutes until a dynamic virtual account expires, when applicable. amount: type: number description: Requested amount for a dynamic virtual account, when applicable. extra: type: object description: Additional channel-specific properties. additionalProperties: true meta: type: object description: Optional meta data you attached to the payment method. ErrorResponse: type: object properties: code: type: string description: Machine-readable error code. error: type: string description: Human-readable error message. details: $ref: '#/components/schemas/ErrorDetails' customerId: type: string description: The unique identifier of the customer. PaymentMethodInstitution: type: object properties: institutionId: type: string description: >- The unique identifier of the bank or mobile money provider if required. institutionName: type: string description: The name of the bank or mobile money provider if required. institutionCode: type: string description: The code of the bank or mobile money provider. institutionAddress: type: string description: The address of the bank or mobile money provider if required. PaymentMethodTransaction: type: object properties: transactionInvoice: type: string description: The invoice for the transaction in base64 string. transactionNarration: type: string description: The optional reason for the transaction. PaymentMethodRecipient: type: object properties: recipientEmail: type: string format: email description: The email address of the recipient if needed. recipientPhone: type: string description: The phone number of the recipient in E.164 format. recipientAddress: type: string description: The address of the recipient if needed. recipientName: type: string description: The name of the recipient if needed. ErrorDetails: type: object properties: errorMessage: type: string description: Detailed/technical error message. friendlyMessage: type: string description: User-facing error message safe to display. data: type: object description: >- Optional caller-safe context for the error. On a customer-create uniqueness conflict (EMAIL_ALREADY_EXISTS / PHONE_NUMBER_ALREADY_EXISTS) this carries the existing customer's id, so you can adopt it without a follow-up lookup. properties: customerId: type: string description: Id of the existing customer (on a create conflict). securitySchemes: ApiKey: type: apiKey in: header name: x-api-key description: >- Static business API key issued from the dashboard. A business can provision **multiple API keys**, each scoped to a configurable set of **permissions** (e.g. read transactions, create deposits, etc). Permissions are chosen per key at creation time in the dashboard and may be revoked by deleting the key. Requests made with a key that does not include the permission required by the target endpoint will be rejected with a `403 Forbidden` response; an unrecognised, malformed or revoked key returns `401 Unauthorized`. Manage your keys and their permissions under **Developer → API keys** in the dashboard. ````