Subscribe to offer

HTTP Method

GET /api/Integration/v4.0/subscribeToOffer

Request

Request Header

Attribute	Type	Required
ClientId	string	YES

Request Body

http://baseurl/api/couponz/SubscribeToOffer?offerNumber=01010&ratePlan=20&channel=USSD&subscribeWithOfferDetails=true&msisdn=01000000001&languageId=1&externalTransactionId=45478215487

Attribute	Type	Required	Description
offerNumber	string	YES	Offer Number
msisdn	string	YES	Branch Msisdn
channel	string	NO	Channel Type
ratePlan	string	NO	Rate Plan
forceXmlResult	boolean	NO	Force XML Response Format
subscribeWithOfferDetails	boolean	NO	Subscribe with Offer Details
languageId	integer	NO	Language Id
onlineOfferValue	double	NO	Online Offer Value
nationalId	string	NO	National Id
externalTransactionId	string	NO	Unique identifier for the voucher creation to prevent the duplication

Response

Response Body

{
    "Id": 38469,
    "CouponNumber": "ppcfgucdzhhr6qn0",
    "ErrorCode": 0,
    "Message": "Success",
    "ExpiryDate": "2023-10-18T00:00:00Z",
    "TransactionID": 38469,
    "DiscountType": 3,
    "MerchantName": "merchant 1",
    "FormattedMessage": "Thank you for subscribing you won a voucher from merchant 1 and the coupon number is  ppcfgucdzhhr6qn0 
                        \nAnd the expiration of your coupon is 18/10/2023\n\nthis is a test ENGLISH message \n\nOffer Title is : pet-child",
    "ExternalTransactionId": "",
    "OfferMaxDiscount": null,
    "OfferMinInvoice": null
}