Disbursements API

The Disbursements API allows you to transfer funds from your AWDPay merchant balance to your customers' mobile wallets, partners, freelancers, or internal sub-accounts.

Use cases

• 💸 Customer refunds — Refund a cancelled purchase
• 👷 Service provider payments — Pay delivery drivers, chauffeurs, freelancers
• 🎁 Cashback & rewards — Distribute winnings, bonuses or promotions
• 🏢 Internal transfers — Fund sub-accounts or subsidiaries
• 📤 Bulk transfers — Pay salaries or commissions in batch

Quick navigation

Core features

Feature	Description
Create withdrawal	Initiate a disbursement to a beneficiary
Check status	Track withdrawal status in real-time
List withdrawals	View paginated disbursement history
Statistics	Access aggregated metrics
Webhooks	Receive real-time notifications

Supported countries & gateways

Country	Providers	Gateway names	Types
🇸🇳 Senegal	Wave, Orange Money	wave-senegal, orange-money-sn	REDIRECT, OTP
🇨🇮 Ivory Coast	Orange Money, MTN, Wave, Moov	orange-money-ci, mtn-ci, wave-ci, moov-ci	OTP, DIRECT, REDIRECT
🇧🇯 Benin	Moov	moov-benin	DIRECT
🇲🇱 Mali	Orange Money, Moov	orange-money-mali, moov-mali	DIRECT
🇧🇫 Burkina Faso	Orange Money	orange-money-burkina	OTP
🇨🇲 Cameroon	MTN	mtn-cm	DIRECT

Dynamic gateways

Retrieve the exact list of enabled gateways with GET /api/gateways?flow=disbursement

Best practices

Idempotence

Use idempotency keys to avoid double disbursements during retries:

curl -X POST "https://app.awdpay.com/api/withdraws/initiate" \
  -H "Authorization: Bearer $AWDPAY_TOKEN" \
  -H "Idempotency-Key: payout-8831-attempt-1" \
  -H "Content-Type: application/json" \
  -d '{...}'

Rate limits

• Respect operator limits (per transaction, daily, weekly)
• AWDPay returns limit_exceeded if a limit is reached
• Check limits via GET /api/gateways?flow=disbursement

OTP methods

For OTP gateways (e.g. Orange Money SN):

1. The beneficiary receives an OTP on their phone
2. They must confirm the code to finalize the transfer
3. Status changes from pending → processing → success

Audit & reconciliation

• Always keep the AWDPay reference and your orderReference
• Use metadata to store your internal identifiers
• Regularly export your transactions via the dashboard

---

Next steps

1. Authentication → Get your API token
2. Environments → Test in sandbox
3. Error handling → Handle failure cases
4. Collections → Also accept incoming payments