Skip to content

docs: add Overview section to README #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
Copilot wants to merge 2 commits into
base: main
Choose a base branch
from
Draft

docs: add Overview section to README #2

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6507218
Initial plan
Copilot Feb 21, 2026
7764c9c
docs: add Overview section to README explaining what Afriex and the S…
Copilot Feb 21, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,21 @@

Official TypeScript SDK for the Afriex Business API. A unified interface for all Afriex services.

## Overview

**Afriex** is a cross-border payments and money-transfer platform that lets businesses send money, convert currencies, and manage payouts across Africa and beyond.

This SDK is the official TypeScript/JavaScript client for the **Afriex Business API**. It lets your backend application:

- **Onboard customers** and manage their KYC details.
- **Create and track transactions** — send money across currencies (e.g. USD → NGN).
- **Manage payment methods** — bank accounts, mobile money, crypto wallets, and virtual accounts.
- **Query exchange rates** in real time.
- **Check your organisation's wallet balances**.
- **Verify webhook signatures** to securely receive Afriex event notifications.

The SDK is written in TypeScript, ships with full type definitions, and is organised as a monorepo so you can install the single `@afriex/sdk` umbrella package or pick individual packages (`@afriex/customers`, `@afriex/rates`, …) to keep your bundle size small.

## Installation

```bash
Expand Down