# Afriex Business API

**Canonical:** https://apis.io/apis/afriex/afriex-business-api/  
**Provider:** Afriex — https://apis.io/providers/afriex/  
**Base URL:** https://api.afriex.com  
**Documentation:** https://docs.afriex.com/

Afriex Business API is one of 2 APIs that [Afriex](https://apis.io/providers/afriex/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. Tagged areas include Payments, Remittances, Cross-Border Payments, Foreign Exchange, and Mobile Money. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and a getting-started guide.

The Afriex Business API is a REST API for cross-border money movement. It covers customer creation and KYC verification, payment-method registration across bank accounts, mobile money, SWIFT, UPI, Interac and crypto wallets, institution and recipient resolution, DEPOSIT / WITHDRAW / SWAP transactions with OTP authorization, multi-currency wallet balances and live FX rates, hosted checkout sessions, virtual and pool collection accounts, SME registration, presigned media upload for KYC documents, and five families of RSA-SHA256 signed webhook events. Authentication is a per-key, permission-scoped x-api-key header; the contract is OpenAPI 3.1 with 32 operations and in-spec webhooks.

## Operations (32)

| Method | Path | Summary |
|---|---|---|
| POST | `/api/v1/customer` | Create a new customer |
| GET | `/api/v1/customer` | Get customer list |
| GET | `/api/v1/customer/{customerId}` | Get customer by ID |
| PATCH | `/api/v1/customer/{customerId}` | Update customer profile |
| DELETE | `/api/v1/customer/{customerId}` | Delete customer by ID |
| PATCH | `/api/v1/customer/{customerId}/kyc` | Update customer KYC information |
| POST | `/api/v1/customer/{customerId}/verify` | Verify a customer document |
| POST | `/api/v1/transaction` | Create a new transaction |
| GET | `/api/v1/transaction` | Get transaction list |
| GET | `/api/v1/transaction/{transactionId}` | Get transaction by ID |
| POST | `/api/v1/transaction/{transactionId}/authorize` | Authorize a pending transaction |
| GET | `/api/v1/transaction/{transactionId}/advice` | Get settlement & remittance advice |
| POST | `/api/v1/transaction/pool-account` | Submit a pool-account payment proof |
| POST | `/api/v1/payment-method` | Create a payment method |
| GET | `/api/v1/payment-method` | Get payment method list |
| GET | `/api/v1/payment-method/{paymentMethodId}` | Get payment method by ID |
| DELETE | `/api/v1/payment-method/{paymentMethodId}` | Delete payment method |
| GET | `/api/v1/payment-method/institution` | Get list of payment method institutions by country |
| GET | `/api/v1/payment-method/institution/codes` | Resolve bank code to institution name |
| GET | `/api/v1/payment-method/resolve` | Resolve payment method recipient by account number |
| GET | `/api/v1/org/balance` | Fetch wallet balance |
| POST | `/api/v1/org/balance/topup` | Top up sandbox balance |
| GET | `/api/v1/org/rates` | Get exchange rates |
| GET | `/api/v1/payment-method/crypto-wallet` | Get or create crypto wallet payment method |
| GET | `/api/v1/payment-method/virtual-account` | List existing virtual accounts |
| POST | `/api/v1/payment-method/virtual-account` | Create a virtual account payment method |
| GET | `/api/v1/payment-method/pool-account` | Get the business pool account |
| POST | `/api/v1/checkout-session` | Create a checkout session |
| POST | `/api/v1/webhooks/trigger` | Trigger a test webhook (sandbox-only) |
| POST | `/api/v1/media/url` | Generate a presigned URL for file upload |
| POST | `/api/v1/sme-registration` | Register a business as an SME (step-based) |
| GET | `/api/v1/sme-registration/status` | Get SME registration status |

## Machine-readable artifacts (6)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/afriex/refs/heads/main/openapi/afriex-business-openapi-original.json
- **Documentation** — https://docs.afriex.com/
- **APIReference** — https://docs.afriex.com/api-reference/introduction
- **GettingStarted** — https://docs.afriex.com/quickstart
- **Webhooks** — https://raw.githubusercontent.com/api-evangelist/afriex/refs/heads/main/asyncapi/afriex-business-webhooks.yml
- **APIsJSON** — https://raw.githubusercontent.com/api-evangelist/afriex/refs/heads/main/apis.yml

## Other Afriex APIs (1)

- [Afriex MCP Server](https://apis.io/apis/afriex/afriex-mcp-server/)

## Tags

Payments, Remittances, Cross-Border Payments, Foreign Exchange, Mobile Money, Webhook

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/afriex/afriex-business-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/afriex/.
