Etisalat Integration Guide (Infomedia-Hosted)

PIN Entry Page

Please check the Compliance Guide↗ for the relevant design rules for this integration.

On this page the user will enter the PIN they have received and click a button to complete their subscription. You will need to call the SubscriptionJoinWithParams API, passing the relevant details. Infomedia will send a PIN SMS to the customer via Etisalat.

SubscriptionJoinWithParams API

The example below shows the minimum fields required for the Etisalat subscription creation. If you're experiencing errors, first validate that all required headers and parameters are present and in the correct format. Please refer to the documentation page for more detailed information about each parameter.

SubscriptionJoinWithParams Documentation↗

Example Request

POST https://api.infomedia.co.uk/dcb/SubscriptionJoinWithParams
Content-Type: application/json
X-Infomedia-Api-Key: {Your API Key}

{
  "mx": "971500000000",
  "mcc": "424",
  "mnc": "02",
  "productId": 8000000,
  "u": "username",
  "p": "password",
  "params": [
    {
      "key": "amount",
      "value": "0.10"
    },
    {
      "key": "frequency",
      "value": "day"
    },
    {
      "key": "language",
      "value": "en"
    },
    {
      "key": "description",
      "value": "Service Name"
    }
  ]
}

Example Response (Free Period)

{
  "status": "Success",
  "description": "00 - User is subscribed",
  "sid": "8000000",
  "mx": "971500000000",
  "mcc": "424",
  "mnc": "2",
  "user": {
    "subscribed": "True",
    "suspended": "False"
  },
  "txid": null,
  "conf": {
    "status": null,
    "description": null,
    "portedMcc": null,
    "portedMnc": null
  }
}

SubscriptionJoinWithParams returns a real-time confirmation of the successful subscription. Infomedia will also send a type 1 (Subscribe) webhook to the merchant during the subscription flow. This is an asynchronous process and there is no guarantee of the order of events. Therefore, it is possible that the webhook arrives before the response to SubscriptionJoinWithParams is finalised. The information from the webhook should be used as a backup if there is a technical issue with the API response.

Resubscription

Note that free periods are only available once per MSISDN. A user who cancels and later resubscribes to the service will be charged immediately. In this case the transaction status will be reflected in the SubscriptionJoinWithParams response in real-time. You will also receive a type 5 (Charge) webhook in addition to the type 1 (Subscribe). Example webhooks can be seen further below.

Example Response (No Free Period)

{
  "status": "Success",
  "description": "00 - User is subscribed",
  "sid": "8000000",
  "mx": "971500000000",
  "mcc": "424",
  "mnc": "2",
  "user": {
    "subscribed": "True",
    "suspended": "False"
  },
  "txid": "6c6a7971-1957-4b3b-bcfa-d0d11231ba51",
  "conf": {
    "status": "Success",
    "description": "00 - Payment has been made",
    "portedMcc": null,
    "portedMnc": null
  }
}

Reactivation

Reactivation occurs when a customer attempts to resubscribe after recently cancelling their subscription, but before their subscription expires. For example: if a customer pays for a weekly subscription and cancels after 2 days, any attempt to resubscribe before the end of the paid week will result in Reactivation. After the week has expired any attempt to subscribe will be treated as a new subscription again. In this scenario you will receive a type 3 (Reactivation) webhook rather than a type 1 (Subscribe).

Example Response (Reactivation)

{
  "status": "Success",
  "description": "23 - User has been reactivated",
  "sid": "8000000",
  "mx": "971500000000",
  "mcc": "424",
  "mnc": "2",
  "user": {
    "subscribed": "True",
    "suspended": "False"
  },
  "txid": null,
  "conf": {
    "status": null,
    "description": null,
    "portedMcc": null,
    "portedMnc": null
  }
}

Webhooks

Webhook Documentation↗

Example Subscribe Webhook (type 1)

https://www.example.com/?msisdn=971500000000&mcc=424&mnc=2&productid=92000000&etid=1&pt=Your_pass_through_value&success=1

Example Reactivate Webhook (type 3)

https://www.example.com/?msisdn=971500000000&mcc=424&mnc=2&productid=92000000&etid=3&pt=Your_pass_through_value&success=1

Example Charge Webhook (type 5)

https://www.example.com/?msisdn=971500000000&mcc=424&mnc=2&productid=92000000&etid=5&pt=Your+pass+through+value&chargeAmount=20&currencyCode=AED&productDescription=Your+product+description&transactionStatus=00&success=1