> ## Documentation Index
> Fetch the complete documentation index at: https://docs.sarafa.ss/llms.txt
> Use this file to discover all available pages before exploring further.

# Sarafa Business API

> Collect payments, send funds, convert balances, and create hosted payment links.

The Sarafa Business API gives your server access to your verified organization's account. Use it to read balances and transactions, collect payments, send payouts, swap wallet balances, and create hosted checkout links.

## Get started

1. Complete your organization's verification in the merchant dashboard.
2. Create an API key in the dashboard's API section. Save the full key when it is created; the secret is shown only once.
3. Make your first authenticated request:

```bash theme={null}
curl "https://api.sarafa.site/v3/" \
  -H "Authorization: Bearer $SARAFA_API_KEY" \
  -H "Content-Type: application/json"
```

Keep your API key on your server. It grants access only to your organization's account.

## Choose an operation

| Task | Endpoint | Guide |
| - | - | - |
| Read your organization and account | `GET /v3/` | [Profile](https://docs.sarafa.ss/api-reference/endpoint/profile.md) |
| Read wallet balances and deposit addresses | `GET /v3/wallets` and `GET /v3/wallets/{currency}` | [Wallets](https://docs.sarafa.ss/api-reference/endpoint/wallet.md) |
| Read transaction history | `GET /v3/transactions` | [Transactions](https://docs.sarafa.ss/api-reference/endpoint/getTransactions.md) |
| Check payment status | `GET /v3/transactions/{id}` | [Payment details](https://docs.sarafa.ss/api-reference/endpoint/getTransaction.md) |
| Collect a payment | `POST /v3/charge` | [Charge](https://docs.sarafa.ss/api-reference/endpoint/charge.md) |
| Send a payment | `POST /v3/transfer` | [Transfer](https://docs.sarafa.ss/api-reference/endpoint/transfer.md) |
| Convert wallet balances | `POST /v3/swap` | [Swap](https://docs.sarafa.ss/api-reference/endpoint/exchange.md) |
| Create or check a hosted payment link | `POST /v3/checkout` and `GET /v3/checkout/{reference}` | [Hosted checkout](https://docs.sarafa.ss/services/checkout.md) |

Read [authentication and request conventions](https://docs.sarafa.ss/api-reference/introduction.md) before integrating, then implement [signed callbacks and retries](https://docs.sarafa.ss/services/api.md).

> [!NOTE]
>
> Charge, transfer, and swap default to a quote. Set `quote` to `false` to execute.
> A response with `status: "success"` confirms the API request succeeded. Only
> `transaction.status: "completed"` confirms payment.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.