# Afriex Business API

## Docs

- [Connecting the Pieces](https://docs.afriex.com/api-reference/connecting-the-pieces.md): How Customers, Payment Methods, and Transactions link together
- [Get Balance](https://docs.afriex.com/api-reference/endpoint/balance/get.md): Returns the balances of the business in the provided currencies.
- [Top Up Sandbox Balance](https://docs.afriex.com/api-reference/endpoint/balance/topup.md): Credits the business wallet with the specified amount and currency. **This endpoint is only available in the sandbox/staging environment and will return a `403 Forbidden` response in production.** Use it during integration development to top up your test balance without making real transfers.
- [Create Customer](https://docs.afriex.com/api-reference/endpoint/customers/create.md): Creates a new customer for a business, with optional KYC information.
- [Delete Customer](https://docs.afriex.com/api-reference/endpoint/customers/delete.md): Deletes a specific customer by their unique identifier.
- [Get Customer](https://docs.afriex.com/api-reference/endpoint/customers/get.md): Retrieves a specific customer by their unique identifier.
- [List Customers](https://docs.afriex.com/api-reference/endpoint/customers/list.md): Retrieves a paginated list of customers.
- [Update Customer KYC](https://docs.afriex.com/api-reference/endpoint/customers/update-kyc.md): Partially updates a customer's KYC information.
- [Create Payment Method](https://docs.afriex.com/api-reference/endpoint/payment-methods/create.md): Creates a new payment method.
- [Get or Create Crypto Wallet](https://docs.afriex.com/api-reference/endpoint/payment-methods/crypto-wallet.md): Retrieves an existing crypto wallet or creates a new one for the specified crypto asset. **Important:** This endpoint is **only active in production** and does **not work on staging/dev**. Supports idempotency to prevent duplicate wallet creation. Currently supports USDT and USDC assets. Send a GET…
- [Delete Payment Method](https://docs.afriex.com/api-reference/endpoint/payment-methods/delete.md): Removes a payment method from the system.
- [Get Payment Method](https://docs.afriex.com/api-reference/endpoint/payment-methods/get.md): Retrieves a specific payment method by its unique identifier.
- [List Institutions](https://docs.afriex.com/api-reference/endpoint/payment-methods/institution.md): Retrieves a list of banks or mobile money providers available for a specific country.
- [Institution Codes](https://docs.afriex.com/api-reference/endpoint/payment-methods/institution-codes.md): Resolves a bank code (SWIFT code or US routing number) to the corresponding bank or institution name.
- [List Payment Methods](https://docs.afriex.com/api-reference/endpoint/payment-methods/list.md): Retrieves a paginated list of payment methods.
- [Resolve Payment Method](https://docs.afriex.com/api-reference/endpoint/payment-methods/resolve.md): Resolves payment method user information for bank accounts or mobile money.
- [Get or Create Virtual Account](https://docs.afriex.com/api-reference/endpoint/payment-methods/virtual-account.md): Retrieves an existing virtual account or creates a new one for the specified currency. **Important:** This endpoint is **only active in production** and does **not work on staging/dev**. Send a GET request with the required `currency` parameter and optional fields. The system will either return an e…
- [Get Exchange Rates](https://docs.afriex.com/api-reference/endpoint/rates/get.md): Retrieves real-time exchange rates.
- [Create Transaction](https://docs.afriex.com/api-reference/endpoint/transactions/create.md): Creates a new transaction for a customer.
- [Get Transaction](https://docs.afriex.com/api-reference/endpoint/transactions/get.md): Retrieves a specific transaction by its unique identifier.
- [List Transactions](https://docs.afriex.com/api-reference/endpoint/transactions/list.md): Retrieves a paginated list of transactions.
- [Customer Events](https://docs.afriex.com/api-reference/endpoint/webhooks/customer-events.md)
- [Introduction](https://docs.afriex.com/api-reference/endpoint/webhooks/introduction.md): Webhook overview, security, and verification
- [Payment Method Events](https://docs.afriex.com/api-reference/endpoint/webhooks/payment-method-events.md)
- [Transaction Events](https://docs.afriex.com/api-reference/endpoint/webhooks/transaction-events.md)
- [Introduction](https://docs.afriex.com/api-reference/introduction.md): Welcome to the Afriex Business API
- [Models](https://docs.afriex.com/api-reference/models.md): Data models, enumerations, and field references for the Afriex Business API
- [Integration Guide](https://docs.afriex.com/development.md): Best practices for integrating the Afriex Business API
- [Connecting the Pieces](https://docs.afriex.com/guides/connecting-the-pieces.md): How Customers, Payment Methods, and Transactions link together
- [Afriex Business API](https://docs.afriex.com/index.md): Build seamless payment experiences with the Afriex Business API
- [Connecting MCP Clients](https://docs.afriex.com/mcp/connecting.md): Connect Claude Desktop, Claude Code, and Cursor to the Afriex MCP server
- [MCP Server](https://docs.afriex.com/mcp/introduction.md): Use the Afriex Business API with AI assistants via the Model Context Protocol
- [Quickstart](https://docs.afriex.com/quickstart.md): Get up and running with the Afriex Business API in minutes

## OpenAPI Specs

- [openapi](https://docs.afriex.com/api-reference/openapi.json)

## Optional

- [Documentation](https://docs.afriex.com/)
- [Support](mailto:support@afriex.com)


Built with [Mintlify](https://mintlify.com).