# Mavapay

- [Introduction](https://docs.mavapay.co/introduction.md): Welcome to the Mavapay Developer Documentation where you’ll learn how to build amazing payment experiences with the Mavapay API.  Regardless of whether you are a developer or a business, a startup or enterprise, Mavapay API is for you. With Mavapay, you can accept payments from customers in Bitcoin,…
- [Authentication](https://docs.mavapay.co/authentication.md): Set up your account and start building with the Mavapay API.
- [Development](https://docs.mavapay.co/development.md): Learn how to integrate with Mavapay API in a test environment
- [Introduction](https://docs.mavapay.co/payouts/introduction.md): Learn how to integrate Mavapay payouts for supported currencies
- [Nigerian Naira (NGN) Payouts](https://docs.mavapay.co/payouts/ngn-payout.md)
- [South African Rand (ZAR) Payouts](https://docs.mavapay.co/payouts/zar-payout.md): Learn how to integrate Mavapay payouts for South African Rand (ZAR)
- [Kenyan Shilling (KES) Payouts](https://docs.mavapay.co/payouts/kes-payout.md): Learn how to integrate Mavapay payouts for Kenyan Shilling (KES)
- [Ghanaian Cedi (GHS) Payouts](https://docs.mavapay.co/payouts/ghs-payout.md): Learn how to integrate Mavapay payouts for Ghanaian Cedi (GHS) with MTN Mobile Money
- [Stablecoins](https://docs.mavapay.co/stablecoins/introduction.md): Deposit and withdraw USDT using your Mavapay stablecoin wallet
- [Introduction](https://docs.mavapay.co/webhooks/introduction.md): Learn how to integrate and handle Mavapay webhooks
- [Webhook Examples](https://docs.mavapay.co/webhooks/webhook-examples.md): Complete webhook payload examples for all supported currencies
- [Quote Examples](https://docs.mavapay.co/guides/quote-examples.md): Comprehensive examples for creating quotes across all supported currency pairs
- [Prefunded Quote (Internal Wallet)](https://docs.mavapay.co/guides/prefunded-internal-wallet.md): Learn how to create a quote funded from your internal wallet and accept it for payout
- [Beneficiary Formats](https://docs.mavapay.co/guides/beneficiary-formats.md): Required beneficiary object formats for each supported currency
- [Name Enquiry Guide](https://docs.mavapay.co/guides/name-enquiry-guide.md): Complete guide to validating Nigerian bank account details before creating quotes
- [Payment Simulation](https://docs.mavapay.co/guides/simulation.md): Test quote payments in staging environment using the simulation endpoint
- [Buying Bitcoin (Lightning)](https://docs.mavapay.co/guides/buying-bitcoin.md): Complete guide to implementing Bitcoin purchase functionality with fiat currencies via Lightning Network
- [Buying Bitcoin (On-Chain)](https://docs.mavapay.co/guides/buying-bitcoin-onchain.md): Complete guide to implementing on-chain Bitcoin purchase functionality with fiat currencies
- [Internal Currency Swap](https://docs.mavapay.co/guides/internal-currency-swap.md): Learn how to perform an internal currency swap from NGN to BTC
- [NGN Withdrawal Workflow](https://docs.mavapay.co/guides/ngn-withdrawal.md): Learn how to perform NGN withdrawals using the Mavapay API
- [NGN to ZAR](https://docs.mavapay.co/guides/ngn-zar.md): Complete guide to sending Nigerian Naira to South African Rand bank accounts using the Mavapay API
- [NGN to GHS](https://docs.mavapay.co/guides/ngn-ghs.md): Complete guide to sending Nigerian Naira to Ghanaian Cedi mobile money accounts using the Mavapay API
- [Introduction](https://docs.mavapay.co/api-reference/introduction.md): Learn how to integrate our APIs into your application.
- [Authentication](https://docs.mavapay.co/api-reference/authentication.md): All API endpoints are authenticated using API keys.
- [Errors](https://docs.mavapay.co/api-reference/errors.md): Common errors and response codes
- [Get price ticker for currency pair](https://docs.mavapay.co/api-reference/endpoint/price/get-price.md): Returns the exchange rate for a given currency pair
- [Get bank account details](https://docs.mavapay.co/api-reference/endpoint/bank-account/get-account.md): Returns all your saved bank accounts for a given currency. The bank account details used to make payouts to your customers.
- [Register a bank account](https://docs.mavapay.co/api-reference/endpoint/bank-account/register-account.md): Register a bank account that can be used for withdrawal for a given currency. Only NGN is supported at the moment.
- [Get bank code](https://docs.mavapay.co/api-reference/endpoint/bank-info/bank-code.md): Returns all bank codes for a given country. This endpoint is currently limited to Nigeria(NGN) and South Africa(ZAR) only.
- [Name Enquiry](https://docs.mavapay.co/api-reference/endpoint/bank-info/name-enquiry.md): Verify bank account details if it is correct. The response returned should match the account number and account name of the user. This endpoint is currently limited to Nigeria(NGN) only
- [Get order details](https://docs.mavapay.co/api-reference/endpoint/order/get-order-by-id.md): Returns the order details for a given order ID
- [Get all orders](https://docs.mavapay.co/api-reference/endpoint/order/get-all-orders.md): Returns all orders
- [Create a quote](https://docs.mavapay.co/api-reference/endpoint/quote/get-quote.md): Create a quote for a given currency
- [Validate KES identifier](https://docs.mavapay.co/api-reference/endpoint/quote/validate-kes-identifier.md): Validate a Kenyan M-Pesa PayBill or Till number and retrieve the associated business name. This endpoint is only available in production.
- [Create a payment link](https://docs.mavapay.co/api-reference/endpoint/payment-link/create-payment-link.md): Create a hosted payment link for collecting payments. Payment links simplify the checkout process by creating a hosted payment page where users can complete payments.
- [Get payment link details](https://docs.mavapay.co/api-reference/endpoint/payment-link/get-payment-link-details.md): Retrieve details about a payment link for rendering a custom UI or checking payment status.
- [Get payment link orders](https://docs.mavapay.co/api-reference/endpoint/payment-link/get-payment-link-orders.md): Retrieve orders associated with a payment link. Useful for getting the order ID for payment simulation in staging.
- [Get wallet details](https://docs.mavapay.co/api-reference/endpoint/wallet/get-wallets.md): Returns the wallet details for a given wallet ID or all wallets
- [Accept Swap Quote](https://docs.mavapay.co/api-reference/endpoint/wallet/accept-quote.md): Accept a quote to perform an internal currency swap
- [Generate a stablecoin deposit address](https://docs.mavapay.co/api-reference/endpoint/collection/generate-stablecoin-address.md): Generate a unique USDT deposit address on a supported network. Send this address to customers so they can deposit USDT into your Mavapay stablecoin wallet. You can generate multiple addresses per network and use `label` to identify them.
- [List stablecoin deposit addresses](https://docs.mavapay.co/api-reference/endpoint/collection/get-stablecoin-addresses.md): Retrieve all previously generated USDT deposit addresses for your account. Filter by currency using the `currency` query parameter.
- [Withdraw fiat](https://docs.mavapay.co/api-reference/endpoint/withdraw/withdraw-fiat.md): Withdraw funds to a bank account. The amount is specified in the lowest denomination of the currency (e.g., Kobo for NGN). You must first verify the bank account using the Name Enquiry endpoint before initiating a withdrawal.
- [Withdraw BTC](https://docs.mavapay.co/api-reference/endpoint/withdraw/withdraw-btc.md): Withdraw BTC to a wallet
- [Withdraw stablecoin](https://docs.mavapay.co/api-reference/endpoint/withdraw/withdraw-stablecoin.md): Withdraw USDT from your Mavapay stablecoin wallet to an external address. The amount is specified in USDT cents (2 decimal places). For example, `100` = 1 USDT.
- [Get transaction details](https://docs.mavapay.co/api-reference/endpoint/transaction/get-transaction.md): Returns the transaction details for a given transaction ID or transactions associated with an order
- [Get all transactions](https://docs.mavapay.co/api-reference/endpoint/transaction/get-all-transactions.md): Returns all transactions with pagination and filtering options
- [Get user profile](https://docs.mavapay.co/api-reference/endpoint/user/get-user-profile.md): Returns an exhaustive user profile detail
- [Register Webhook](https://docs.mavapay.co/api-reference/endpoint/webhook/register-webhook.md): Register a webhook endpoint to receive event notifications
- [Update Webhook](https://docs.mavapay.co/api-reference/endpoint/webhook/update-webhook.md): Update an existing webhook configuration

## OpenAPI Specs

- [openapi](/api-reference/openapi.json)

## Optional

- [Products](https://mavapay.co)
- [Blog](https://blog.mavapay.co)