1. Home
  2. Docs
  3. Developers Guide
  4. Integration APIs
  5. Offers
  6. check_offer_status (2nd Usage)

check_offer_status (2nd Usage)

This API is used to check the status of an offer when only the parameters Offer Key and card number are passed as input. This API can be used to check the offer status when offer is created using bin only. In this case we can depict that the offer has been created for which category (like CC/DC/NB/EMI). Hence, for using this API, you need to pass the Offer Key and Card Number in var1 and var5 field as inputs and leave the rest field empty.

The return parameters are status, msg, error_code (In case of error), category, offer_key, offer_type (instant/cashback), offer_availed_count, ‘offer_remaining_count’.

ParameterDescriptionMandatorySample Value
var1Offer KeyYesoffer@123
var2blankNo
var3blankNo
var4blankNo
var5Card NumberYes
5432112345678901

Error Codes

1. ‘INV ALID_OFFER’=>’E001′
2. ‘INVALID_PAYMENT_METHOD’=>’E002’

In the Output:

Parameter ‘status’ = 1, means offer is valid
Parameter ‘status’ = 0, means offer is invalid

Web Service Response

a. If the offer is a valid offer for the given card number(bin):

Array 
(
[status] => 1
[msg] => Valid offer 
[category] => creditcard 
[offer_key] => abc@123 
[offer_type] => instant 
[offer_availed_count] => 5 
[offer_remaining_count] => 1
)

b. If the offer is expired:

Array 
(
[status] =>0
[msg] => Offer Expired 
[error_code] => E001
[category] => Unknown
[offer_key] => offerKey 
[offer_type] => Unknown 
[offer_availed_count] => Unknown 
[offer_remaining_count] => Unknown
)

c. If the card limit is exhausted:

Array
(
[status] => 0
    [msg] => Offer Exhausted
    [error_code] => E001
[category] => Unknown
[offer_key] => offerKey 
[offer_type] => Unknown 
[offer_availed_count] => Unknown 
[offer_remaining_count] => Unknown
)

d. If offerKey is invalid:

Array 
(
[status] => 0
[msg] => Invalid offer Key 
[error_code] => E001
[offer_key] => newoffer1@568 
[offer_type] => Unknown 
[offer_availed_count] => Unknown 
[offer_remaining_count] => Unknown
)