Collection API
The Collection API allows you to collect payments from customers using mobile money services. You can initiate payment requests and check the status of existing transactions.
Available Endpoints
- Create Collection: Initiate a payment collection request
- Check Status: Check the status of an existing collection request
Transaction Lifecycle
When you create a collection request, it goes through the following stages:
- PENDING: The initial state of a transaction. The customer has not yet authorized the payment.
- SUCCESS: The customer has authorized the payment and the funds have been transferred.
- FAILED: The payment could not be processed due to a rejection by the provider or customer.
- ROLLED_BACK: The transaction was initially successful but has been reversed.
Common Use Cases
- Collecting payments for goods and services
- Subscription billing
- One-time purchases
- Invoice payments
Provider Support
The Collection API currently supports the following mobile money providers:
- AIRTEL_UG: Airtel Money Uganda
- MTN_UG: MTN Mobile Money Uganda