Payment Notifications
Payment Notifications
One-time Charges
When a product is purchased, MessageCloud will send a HTTP POST to the postback URL set in Control Panel or in your call back URL via the API:
| Parameter Name |
Example |
Description |
| key |
d33c80bc45d65303e33ca83108a9952b745af9ef |
The campaign password assigned by MessageCloud, if 'id' set in the API call, we use 'id' instead |
| billed |
1 = billed 0 = not billed |
A flag to report whether this notification means that the end user was billed |
| status |
OK (See Possible Report Statuses) |
The human-readable status |
| transactionId |
1258470153 |
The unique transactionId |
| msisdn |
447445566731 |
The MSISDN of the end user who made a purchase |
| network |
THREEUK |
The network to which the MSISDN belongs |
If the end user wishes to receive marketing communications then the following HTTP POST will also be sent through:
| Parameter Name |
Example |
Description |
| key |
d33c80bc45d65303e33ca83108a9952b745af9ef |
The campaign password assigned by MessageCloud, if 'id' set in the API call, we use 'id' instead |
| billed |
0 |
The end user will never be charged for requesting marketing information |
| transactionId |
1258470153 |
The unique transactionId |
| marketing |
1 = Yes 0 = No |
A flag to determine if the end user wishes to be added to marketing notifications. |
If the end user aborts the transaction midway through, no notifications will be sent to the client.
Subscription Charges
When a service subscription is started Payforit handles all subsequent messages. MessageCloud has no control over rebilling.
Subscription Charge Notification
When an end user first starts their subscription to a service, the following HTTP POST is sent:
| Parameter Name |
Example |
Description |
| key |
d33c80bc45d65303e33ca83108a9952b745af9ef |
The campaign password assigned by MessageCloud, if 'id' set in the API call, we use 'id' instead |
| billed |
1 = billed 0 = not billed |
Whether this notification informs us that a payment has been made |
| status |
OK |
A human-readable status of the transaction |
| transactionId |
1258470153 |
The unique subscriptionId. This should be used to identify the transaction. |
| msisdn |
447445566731 |
The MSISDN of the end user who made the purchase |
| network |
THREEUK |
The network to which the end user belongs |
Similarly to the one-time charge notifications, a marketing confirmation HTTP POST may also be sent at this time:
| Parameter Name |
Example |
Description |
| key |
d33c80bc45d65303e33ca83108a9952b745af9ef |
The campaign password assigned by MessageCloud, if 'id' set in the API call, we use 'id' instead |
| billed |
0 |
The end user will never be charged for requesting marketing information |
| transactionId |
1258470153 |
subscriptionId |
| marketing |
1 = Yes 0 = No |
A flag to determine if the end user wishes to be added to marketing notifications. |
Subscription Cancelled
When the end user decides to opt-out of the subscription service, the following HTTP POST is made:
| Parameter Name |
Example |
Description |
| key |
d33c80bc45d65303e33ca83108a9952b745af9ef |
The campaign password assigned by MessageCloud, if 'id' set in the API call, we use 'id' instead |
| billed |
0 |
The end user will never be charged for STOP requests |
| transactionId |
1258470153 |
The unique subscriptionId. This should be used to identify the transaction. |
| status |
UNSUBSCRIBED |
A human-readable status of the transaction |
| stop |
1 |
This parameter will always be set to 1 for STOP requests. |
Possible Network Values
When a successful payment is made the network of the MSISDN will also be returned via HTTP POST. The following table lists the possible values for the network field:
| Value |
Description |
| ORANGEUK |
Orange UK (now branded as Everything Everywhere or EE) |
| O2UK |
O2 UK |
| O2MVNOUK |
O2 MVNOs, such as Giffgaff and Tesco Mobile |
| THREEUK |
3 UK |
| TMOBILEUK |
T-Mobile UK (now branded as Everything Everywhere or EE) |
| VODAFONEUK |
Vodafone UK |
| VIRGINUK |
VIRGIN UK (MVNO of T-Mobile) |
Possible Report Statuses
When you receive a delivery report you should use the `status` parameter to determine the status of the transaction. The table below lists the different statuses you may encounter:
| Status Value |
Description |
| OK |
The purchase / subscription initiation was successful. |
| SUBSCRIBED |
The subscription was started. No billing has happened at this point. |
| FAILED |
The purchase was not successful and the end user was not charged. |
| INSUFFICIENT_CREDIT |
The end user had insufficient credit to complete the transaction and was not charged. |
| CANCELLED |
The end user cancelled the purchase (by clicking the Cancel button on the PFI window). |
| EXPIRED |
The end user took too long to make the purchase. Normally, however, this is because the end user navigated away from the PFI window without cancelling. |
| UNSUBSCRIBED |
The end user was unsubscribed from the service. |
| SUSPENDED |
The end user was suspended from the subscription service, normally due to insufficient credit. |
| UNKNOWN |
Contact MessageCloud support for more information. |
