Initiate Mobile Money Collection
Initiates a mobile money collection request from a customer's mobile wallet. The customer will receive a payment prompt on their mobile device and must authorize the transaction before the funds are collected.
Request Fields
| Field | Type | Required | Description |
|---|---|---|---|
accountNumber | String | Yes | The customer's mobile money phone number registered with their mobile money provider (e.g. 0971111111). This is the account that will receive the collection prompt. |
amount | Number | Yes | The amount to collect from the customer. |
correlatorId | String | Yes | A unique transaction reference generated by your system. This value is used to identify and track the transaction in both your system and Astragate. It must be unique for every request. |
currency | String | Yes | The transaction currency. Currently supported: ZMW. |
paymentDescription | String | Yes | A short description of the payment. This may appear in transaction records and helps identify the purpose of the payment. |
Initiate Mobile Money Payout
Initiates a mobile money payout to a customer's mobile wallet. Once the request is successfully processed, the specified amount is sent to the customer's registered mobile money account.
Request Fields
| Field | Type | Required | Description |
|---|---|---|---|
accountNumber | String | Yes | The recipient's mobile money phone number registered with their mobile money provider (e.g. 0971111111). Funds will be sent to this account. |
amount | Number | Yes | The amount to be paid out. |
correlatorId | String | Yes | A unique transaction reference generated by your system. This value is used to identify and track the transaction in both your system and Astragate. It must be unique for every payout request. |
currency | String | Yes | The transaction currency. Currently supported: ZMW. |
paymentDescription | String | Yes | A short description of the payout. This helps identify the purpose of the transaction in reports and transaction history. |
Notes
- accountNumber refers to the customer's mobile money phone number, not a bank account number.
- correlatorId must be unique for every transaction. Reusing the same value may result in duplicate transaction detection or request rejection.
- The amount should be specified in the major currency unit (e.g. 20 for ZMW 20.00).