Payment Methods
Get the business pool account
Returns the pool account for the supplied country. Use the reference on the response to reconcile incoming deposits; it is a shortened form such as afx1234 (with a customer, afx1234012). Each call also sends a PAYMENT_METHOD.UPDATED webhook carrying the pool account.
get/api/v1/payment-method/pool-account
Request
- Base URLhttps://sandbox.api.afriex.com
- AuthAPI key in header x-api-key
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Query parameters
countrystring required
Example:NG
ISO 3166-1 alpha-2 country code.
customerIdstring
Optional customer ID to associate with this account.
amountnumber
Optional positive amount. Accepted but ignored.
referencestring
Optional merchant-supplied reference. Accepted but ignored.
Response
Pool account returned successfully.
Changes
No recorded changes to this operation across all 1 revision of this API.