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

# Introduction

> Pay people, get paid and change currency across African corridors with one API.

Payve is a payments API. You hold balances in wallets, pay out to bank accounts and mobile money, collect from payers, and convert between currencies. You see the rate and the fee before you send.

> [card] [Quickstart](/quickstart.md)
>
> Quote a rate, send a payout and receive the webhook.

> [card] [Get your API keys](/get-started/api-keys.md)
>
> Create a key in the dashboard. The secret is shown once.

> [card] [Webhooks](/webhooks/overview.md)
>
> Know the moment a payment lands.

> [card] [API reference](/api-reference/overview.md)
>
> Every endpoint, generated from the API code.

## What you can do

| You want to | Use | Guide |
| - | - | - |
| See a rate and a fee | A quote, held for five minutes by default | [Quotes](/guides/quotes.md) |
| Pay a person | A payout to a bank account or mobile money wallet | [Payouts](/guides/payouts.md) |
| Pay many people | Up to 100 payouts in one call | [Bulk payouts](/guides/bulk-payouts.md) |
| Check a recipient | A name check on the account before you send | [Name check](/guides/name-check.md) |
| Get paid | A pay-in to a virtual account, or a hosted payment link | [Pay-ins](/guides/payins.md) |
| Change currency | A conversion between two of your wallets | [Conversions](/guides/conversions.md) |
| See what you hold | Wallet balances and virtual accounts | [Wallets](/guides/wallets.md) |

## How the API works

* **Base path.** Every endpoint starts with `/v1`. The live API is at `https://api.payvehq.com`.
* **Authentication.** Send your secret key in the `x-api-key` header. See [Authentication](/get-started/authentication.md).
* **Money.** Every amount is a whole number in minor units: `150000` is ₦1,500.00. See [Requests and responses](/essentials/requests-and-responses.md).
* **Safe retries.** Money calls take an `Idempotency-Key` header, so a retry never pays twice. See [Idempotency](/essentials/idempotency.md).
* **Four statuses.** A transaction is `pending`, `processing`, `successful` or `failed`. See [Statuses](/essentials/statuses.md).
* **Webhooks.** Payve posts a signed event to your server when a transaction finishes. See [Webhooks](/webhooks/overview.md).

> [!NOTE]
>
> Amounts, rates, fees and names in the examples are made up. Your own responses carry your own
> values.

## Currencies

The API accepts `NGN`, `GHS` and `KES`. [Coverage](/essentials/coverage.md) lists what works in each country.
