Shared Secret string used to validate requests, is hardcoded within codebase, and not exposed in this document on purpose.
| Property name | Description | Value format |
|---|---|---|
| Valid email, max 100 characters | ||
| mobileNo | Mobile number | Full country code, only dialling digits, no symbols e.g. 48693427795 |
| businessId | TIW unique business id, provided by MaxCom | Exactly: 1 |
| customerName | Customer name | String, only A-Za-z0-9 and space, max 100 chars |
| amount | Amount to be charged in TSh | Positive integer |
| txnId | Transaction id, unique, generated by TIW | Positive integer, Max 11 digits |
| paymentMethod | Chosen payment method (either Credit Card or Mobile Money) | One of the tokens: cc, mp |
| hashCode | MD5 Hash of Shared Secret + amount + businessId + customerName + email + mobileNo + paymentMethod + txnId | MD5 Hash |
Status: 201 Created
Location: [url to which user should be redirected]
Where Status is a HTTP Status, any other (not 201) HTTP status code should not be handled (failure should be assumed).
Location is HTTP header specifying to which page on MaxCom website we should redirect user.
Status: 201 Created
[Some text that should be displayed to user within TIW application]
Where Status is a HTTP Status, any other (not 201) HTTP status code should not be handled (failure should be assumed).
| Property name | Description | Value format |
|---|---|---|
| txnId | Transaction id | as at initialization |
| businessId | TIW unique business id, provided by MaxCom | as at initialization |
| hashCode | MD5 Hash of Shared Secret + businessId + txnId | MD5 Hash |
Status: 200 OK
Where Status is a HTTP Status, any other (not 200) HTTP status code should not be handled (failure should be assumed).
| Property name | Description | Value format |
|---|---|---|
| txnId | Transaction Id | as at initialization |
| status | Status (approved, cancelled or rejected) | One of the following tokens: approved, cancelled, rejected |
| responseMessage | Human friendly description of a status | Max 200 characters |
| receiptNo | Receipt Number | Provided only in case of approved status (otherwise an empty string), Max 20 characters |
| hashCode | MD5 Hash of Shared Secret + receiptNo + responseMessage + status + txnId | MD5 Hash |
Status: 200 OK
Where Status is a HTTP Status, any other (not 200) HTTP status code should not be handled (failure should be assumed).