Eligibility Check

A user can use the Eligibility Check API for operators Zain Bahrain, Zain Jordan, Zain Kuwait, Etisalat UAE, Celcom and Digi. 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


Name	Description	Type	Usage
msisdn	The MSISDN that you want to check the charging eligibility of.	string	mandatory
campaign	The Alacrity service URI that identifies the service that this transaction belongs to.	string	mandatory
merchant	The Alacrity merchant URI that identifies which merchant this transaction belongs to.	string	mandatory

Response Parameters


Name	Description	Type	Usage
success	A flag that indicates whether the MSISDN is eligible or not.	boolean	mandatory
customer_type	The 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.	string	mandatory
operator_id	This will only be present for Celcom and Digi and will be either CEL-MY or DIG-MY	string	optional

Name

Description

Type

Usage

success

A flag that indicates whether the MSISDN is eligible or not.

boolean

mandatory

customer_type

The 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.

string

mandatory

operator_id

This will only be present for Celcom and Digi and will be either CEL-MY or DIG-MY

string

optional

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"
}