# Web Rabbit Payments API Documentation

> Web Rabbit Payments is a payment platform for Ghana: Mobile Money collections
> and payouts, card payments, and transaction APIs. Base URL: https://api.webrabbitmedia.com/v1

Full documentation in one file: https://webrabbitmedia.com/llms-full.txt

## Get Started

- [Introduction](https://webrabbitmedia.com/docs/introduction.md): What Web Rabbit Payments is and how the API is structured.
- [Quickstart](https://webrabbitmedia.com/docs/quickstart.md): Create a key, charge a customer, and inspect a transaction in five minutes.
- [Authentication](https://webrabbitmedia.com/docs/authentication.md): Authenticate every request with your secret API key.
- [Idempotency](https://webrabbitmedia.com/docs/idempotency.md): Retry money-moving requests safely with an Idempotency-Key header.
- [Rate limits](https://webrabbitmedia.com/docs/rate-limits.md): Per-key and per-IP limits enforced at the Cloudflare edge.
- [Request IDs & logs](https://webrabbitmedia.com/docs/request-ids.md): Every response is tagged with an x-request-id; we log it for 30 days.
- [Errors](https://webrabbitmedia.com/docs/errors.md): HTTP status codes, error shapes, and how to recover.
- [Fees](https://webrabbitmedia.com/docs/fees.md): How the platform fee and the payout fee are calculated and settled — 10% starting rate, 1.5% on withdrawals.
## Commerce

- [Products, orders & inventory](https://webrabbitmedia.com/docs/products-orders.md): Sell from a permanent product link and manage orders and stock.
## Collect

- [Mobile Money](https://webrabbitmedia.com/docs/collect-momo.md): Charge a customer over MTN, Telecel, or AirtelTigo.
- [Hosted Checkout](https://webrabbitmedia.com/docs/hosted-checkout.md): Create a hosted payment page that accepts card and Mobile Money.
## Split Payments

- [Split payments & sub-accounts](https://webrabbitmedia.com/docs/split-payments.md): Divide a collection between your platform and the people you pay, at capture.
## Refunds

- [Refunds](https://webrabbitmedia.com/docs/refunds.md): Send money back to the wallet that paid, in full or in part, from your dashboard.
## Disbursements

- [Disbursements (payouts to third parties)](https://webrabbitmedia.com/docs/disbursements.md): Batch payouts to drivers, vendors and couriers, with release tiers and review.
## Bills

- [Bills & Airtime](https://webrabbitmedia.com/docs/bills.md): Currently unavailable — airtime, data bundles and bill payments are switched off.
## Transactions

- [List transactions](https://webrabbitmedia.com/docs/transactions-list.md): Paginate through every transaction for your business.
- [Retrieve a transaction](https://webrabbitmedia.com/docs/transactions-retrieve.md): Fetch a single transaction by id.
- [Me (preflight)](https://webrabbitmedia.com/docs/me.md): Verify the current key mode and business approval status before charging.
## Reference

- [OpenAPI & SDKs](https://webrabbitmedia.com/docs/openapi.md): The machine-readable OpenAPI 3.1 contract, client generation, and the TypeScript SDK.
- [System status](https://webrabbitmedia.com/docs/system-status.md): Live health of every payment route, incident updates and how to subscribe.
- [API changelog](https://webrabbitmedia.com/docs/changelog.md): Dated entries for every field and behaviour change on the public API.
- [Amounts & currency](https://webrabbitmedia.com/docs/amounts.md): Decimal cedis and exact pesewa minor units, and the rounding rules behind them.
- [Provider codes](https://webrabbitmedia.com/docs/provider-codes.md): Lifecycle statuses and the upstream code field returned on every transaction.
- [Test data](https://webrabbitmedia.com/docs/test-data.md): Sandbox wallets and how test-mode charges behave.
- [Webhooks](https://webrabbitmedia.com/docs/webhooks.md): Signed, retried event delivery for collections, payouts and top-ups.
## Messaging

- [Messaging overview](https://webrabbitmedia.com/docs/messaging-overview.md): Base URL, messaging keys, credits and error shapes for SMS, OTP and voice.
- [Send SMS](https://webrabbitmedia.com/docs/messaging-sms.md): Create a bulk SMS campaign and pull per-recipient delivery reports.
- [OTP](https://webrabbitmedia.com/docs/messaging-otp.md): Send and verify one-time passcodes with hashed storage and expiry.
- [WhatsApp, opt-outs & lookup](https://webrabbitmedia.com/docs/messaging-channels.md): WhatsApp templates, the do-not-contact list, number lookup and phone verification.
- [Voice & balances](https://webrabbitmedia.com/docs/messaging-voice.md): Place outbound voice campaigns, pull call reports and read network balances.
## Policies

- [Merchant Acceptance Policy](https://webrabbitmedia.com/docs/merchant-acceptance.md): Businesses we support, the prohibited list, review categories, and enforcement.
- [Onboarding & verification](https://webrabbitmedia.com/docs/onboarding.md): Individual vs registered entity, the verification checklist, review statuses and going live.
- [Rabbit AI assistant](https://webrabbitmedia.com/docs/rabbit-ai.md): Ask, Build and Plan modes, dashboard actions, and auto-approval settings.
- [Payment methods by country](https://webrabbitmedia.com/docs/payment-methods-by-country.md): Mobile Money networks, Nigeria bank transfer and failure codes for each country.
- [Merchant eligibility](https://webrabbitmedia.com/docs/merchant-countries.md): Where you can register a business and receive payouts. Live in all 16 registration countries.
- [Accepted countries](https://webrabbitmedia.com/docs/accepted-countries.md): The countries and territories your customers can pay from.