Webhooks are available for all types of service. Different types are available depending on the Flow used. You must set up a URL to handle these notifications upon certain events taking place.
Notifications are sent via HTTP GET with all parameters being provided, percent-encoded, in the QueryString.
Parameter
Description
mx
Encrypted MSISDN/Alias. This can be decrypted using DecryptMX.
mcc
The Mobile Country Code.
mnc
The Mobile Network Code.
productid
The Product ID (PID).
etid
See the Webhook Types table below.
pt
Either the PTSubscriberID passed via SubscriptionJoinWithParams or the pt passed via SendBillWithPin.
success
1 or 0 (True or False) to show if the event was successful. Applies to webhook types 1 (only for carrier-hosted checkout flows) and 5.
chargeAmount
Charge and Refund only: The amount that was charged or refunded in decimal format.
currencyCode
Charge and Refund only: The ISO 4217 Currency Code.
productDescription
Charge and Refund only: The product description shown to the end user.
transactionStatus
Charge and Refund only: The success or error status relating to the transaction. See TransactionStatus Values for details.
txid
Charge and Refund only: A unique GUID for the transaction.
Status
Description
00
Successfully billed
AA
Error - Insufficient credit
A5
Error - Operator Bar on this MSISDN
A3
Error - MSISDN not recognised by the mobile network
A6, A7, A8, A9, AB, AC, AD
Error - MSISDNs expenditure limit reached
01, 48, 74, A0, A1, A2, A4, AF
Error - Billing attempt has failed
Type
Title
Description
1
Subscribe
The customer has successfully subscribed to a service.
2
Unsubscribe
The customer has cancelled their subscription to a service.
3
Reactivation
The customer has re-subscribed after cancelling, but before their paid subscription has elapsed.
5
Charge
A charge has been attempted. The transactionStatus will indicate the result.
24
Suspend
The customer has failed to pay and should not be given access to the service. Further billing attempts will be made.
25
Unsuspend
The customer has successfully paid after previously failing and may now be given access to the service.
31
Refund
A refund has been processed.
Type 1 - Subscribe
https://www.example.com/?mx=nRjrQf7rkGX-437Y6)5gR)5uMlRi3cy-3Ft9s2qvzD4=&mcc=234&mnc=02&productid=92000000&etid=1&pt=Your_pass_through_value&success=1Type 2 - Unsubscribe
https://www.example.com/?mx=nRjrQf7rkGX-437Y6)5gR)5uMlRi3cy-3Ft9s2qvzD4=&mcc=234&mnc=02&productid=92000000&etid=2&pt=Your_pass_through_value&success=1Type 3 - Reactivation
https://www.example.com/?mx=nRjrQf7rkGX-437Y6)5gR)5uMlRi3cy-3Ft9s2qvzD4=&mcc=234&mnc=02&productid=92000000&etid=3&pt=Your_pass_through_value&success=1Type 5 - Charge
https://www.example.com/?mx=nRjrQf7rkGX-437Y6)5gR)5uMlRi3cy-3Ft9s2qvzD4=&mcc=234&mnc=02&productid=92000000&etid=5&pt=Your+pass+through+value&chargeAmount=20¤cyCode=AED&productDescription=Your+product+description&transactionStatus=00&success=1Type 24 - Suspend
https://www.example.com/?mx=nRjrQf7rkGX-437Y6)5gR)5uMlRi3cy-3Ft9s2qvzD4=&mcc=234&mnc=02&productid=92000000&etid=24&pt=Your_pass_through_value&success=1Type 25 - Unsuspend
https://www.example.com/?mx=nRjrQf7rkGX-437Y6)5gR)5uMlRi3cy-3Ft9s2qvzD4=&mcc=234&mnc=02&productid=92000000&etid=25&pt=Your_pass_through_value&success=1Type 31 - Refund
https://www.example.com/?mx=nRjrQf7rkGX-437Y6)5gR)5uMlRi3cy-3Ft9s2qvzD4=&mcc=234&mnc=02&productid=92000000&etid=31&pt=Your+pass+through+value&chargeAmount=20¤cyCode=AED&productDescription=Your+product+description&transactionStatus=00&success=1Powered by Infomedia