{
"depositId": "f4401bd2-1568-4140-bf2d-eb77d2b2b639",
"requestedAmount": "15",
"currency": "ZMW",
"country": "ZMB",
"correspondent": "MTN_MOMO_ZMB",
"payer": {
"type": "MSISDN",
"address": {
"value": "260763456789"
}
},
"customerTimestamp": "2020-02-21T17:32:28Z",
"created": "2020-02-21T17:32:29Z",
"statementDescription": "Note of 4 to 22 chars",
"depositedAmount": "15",
"respondedByPayer": "2020-02-21T17:32:30Z",
"correspondentIds": {
"MTN_INIT": "ABC123",
"MTN_FINAL": "DEF456"
},
"suspiciousActivityReport": [
{
"activityType": "AMOUNT_DISCREPANCY",
"comment": "There is a discrepancy between requested and actual deposit amount."
}
],
"metadata": {
"orderId": "ORD-123456789",
"customerId": "customer@email.com"
}
}Deposit callback
POST a callback to your configured callback URL for each deposit when it reaches a final status.
Read more about handling callbacks and callback URLs.
If you have not configured callbacks, you can always call our Check Deposit Status endpoint to get the latest status and details of a specific deposit request.
Headers
Body
The amount to be collected (deposit) or disbursed (payout or refund).
Amount must follow below requirements or the request will be rejected:
- Between zero and two decimal places can be supplied, depending on what the specific MMO supports. Learn about all MMO supported decimal places.
- The minimum and maximum amount depends on the limits of the specific MMO. You can find them from the Active Configuration endpoint.
- Leading zeroes are not permitted except where the value is less than 1. For any value less than one, one and only one leading zero must be supplied.
- Trailing zeroes are permitted.
Valid examples:
5, 5.0, 5.00, 5.5, 5.55, 5555555, 0.5
Not valid examples:
5., 5.555, 5555555555555555555, .5, -5.5, 00.5, 00.00, 00001.32
1 - 23^([0]|([1-9][0-9]{0,17}))([.][0-9]{0,3}[1-9])?$"15"
The currency in which the amount is specified.
Format must be the ISO 4217 three character currency code in upper case. Read more from Wikipedia.
You can find all the supported currencies that the specific correspondent supports from here.
The active configuration endpoint provides the list of correspondents configured for your account together with the currencies.
"ZMW"
The country in which the MMO operates.
Format is ISO 3166-1 alpha-3, three character country code in upper case. Read more from Wikipedia.
"ZMB"
The correspondent code refers to the specific MMO that the specified phone number (MSISDN) has an active mobile money wallet with.
You can find all the supported correspondents listed here.
The active configuration endpoint provides the list of correspondents configured for your account.
You can use the predict correspondent enpoint to predict the correct correspondent to use based on the phone number (MSISDN).
"MTN_MOMO_ZMB"
The timestamp for when you initiated the deposit process. Format defined by 'date-time' in RFC3339 section 5.6 from IETF
"2020-02-21T17:32:28Z"
The timestamp of when the deposit was created in the PawaPay platform. Format defined by 'date-time' in RFC3339 section 5.6 from IETF
"2020-02-21T17:32:29Z"
Short description for the transaction. Depending on the specific MMO performing the transaction this message may be visible to the customer in the SMS receipt or within their transaction history.
Must be between 4 and 22 alphanumeric characters.
4 - 22^[a-zA-Z0-9 ]+$"Note of 4 to 22 chars"
The amount to be collected (deposit) or disbursed (payout or refund).
Amount must follow below requirements or the request will be rejected:
- Between zero and two decimal places can be supplied, depending on what the specific MMO supports. Learn about all MMO supported decimal places.
- The minimum and maximum amount depends on the limits of the specific MMO. You can find them from the Active Configuration endpoint.
- Leading zeroes are not permitted except where the value is less than 1. For any value less than one, one and only one leading zero must be supplied.
- Trailing zeroes are permitted.
Valid examples:
5, 5.0, 5.00, 5.5, 5.55, 5555555, 0.5
Not valid examples:
5., 5.555, 5555555555555555555, .5, -5.5, 00.5, 00.00, 00001.32
1 - 23^([0]|([1-9][0-9]{0,17}))([.][0-9]{0,3}[1-9])?$"15"
When the MMO responded to this deposit request. Format defined by 'date-time' in RFC3339 section 5.6 from IETF
"2020-02-21T17:32:30Z"
Was this page helpful?