Collections Overview
Collections allow you to receive payments from customers via mobile money. This section covers everything you need to know about collecting payments through ZoPay.
How Collections Work
The collection process involves three main steps:
- Create a Quote: Get pricing information for the transaction
- Execute Collection: Process the payment from the customer
- Check Status: Monitor the transaction status
Supported Gateways
- MTN Mobile Money: Available in Cameroon, Ivory Coast, and other supported countries
- Orange Money: Merchant payment integration
Collection Flow
- Customer initiates payment on your platform
- Your application creates a quote via
POST /api/v1/wallets/quote - Quote includes fees and total amount
- Customer confirms payment details
- Your application executes collection via
POST /api/v1/wallets/collect - ZoPay processes payment with the mobile money provider
- Webhook notification sent when transaction completes
- Check transaction status via
GET /api/v1/wallets/transactions/:id
Transaction Statuses
- PENDING: Transaction initiated, awaiting processing
- VERIFYING: Payment is being verified with the gateway
- SUCCESS: Payment completed successfully
- FAILED: Payment failed (check error details)
- CANCELLED: Transaction was cancelled
Fees
Each collection includes:
- Gateway Fee: Fee charged by the mobile money provider (MTN, Orange, etc.)
- Platform Fee: ZoPay service fee
- Total Amount: Amount customer pays (original amount + fees)
- Net to Merchant: Amount you receive after fees
Idempotency
Always include an idempotency_key when executing collections. This ensures that if a request is retried due to network issues, the same transaction won't be processed twice.
💡
Quote Expiry: Quotes are valid for 15 minutes. After expiry, you must create a new quote as fees may have changed. Always use the quote ID from the most recent quote when executing a collection.
Next Steps
- Learn how to Create a Quote
- See how to Execute a Collection
- Understand Transaction Status