Eligibility Check

A user can use the Eligibility Check API for operators Zain Bahrain, Zain Jordan and Zain Kuwait. This can be used to ensure that the user can be charged. For example corporate accounts would not be eligibile. If known the customer type will be returned to you.

For details see: Eligibility

HTTP Request

POST /v2.2/eligibility?msisdn={msisdn}&campaign={campaign}&merchant={merchant}

Request Parameters

NameDescriptionTypeUsage
msisdnThe MSISDN that you want to check the charging eligibility of.stringmandatory
campaignThe Alacrity service URI that identifies the service that this transaction belongs to.stringmandatory
merchantThe Alacrity merchant URI that identifies which merchant this transaction belongs to.stringmandatory

Response Parameters

NameDescriptionTypeUsage
successA flag that indicates whether the MSISDN is eligible or not.booleanmandatory
customer_typeThe customer type that is associated to that MSISDN. Below is a list of possible values:

  • postpaid: Postpaid MSISDN.
  • prepaid: Prepaid MSISDN.
  • unknown: MSISDN type is unknown.
  • stringmandatory
    GET /v2.2/eligibility?msisdn=9739360370
    &campaign=campaign:bfbce4fac619bxxxxxxxx2d9aecbb6f7
    &merchant=partner:ea552d72-xxxx-xxxx-9741-195989dae658
    
    Host: api.sla-alacrity.com
    Authorization: Basic XXXXxxxYYYY
    Accept: application/json
    
    HTTP/1.1 200 OK
    Content-Type: application/json
    {
        "success": true,
        "customer_type": "prepaid"
    }