1. pointsonline pointsonline REWARD REDEEMPointsonline API Integration Guide Version 1.8 May 2011 Contents Introduction .................................................................................................................................................. 3 1. Reward points/Discount transaction ............................................................................................... 4 2. Redemption ..................................................................................................................................... 5 3. Get Points Balance ........................................................................................................................... 6 4. Redeem Coupon .............................................................................................................................. 7 5. Credit Cash to a Customer ............................................................................................................... 8 6. Debit Cash from a Customer ........................................................................................................... 9 7. Create Customer ............................................................................................................................ 10 8. Delete a Customer ......................................................................................................................... 11 9. Reward Scheme ............................................................................................................................. 12 10. Redemption Scheme ................................................................................................................... 13 11. Qualifying Redemptions .............................................................................................................. 14 12. List Items....................................................................................................................................... 15 13. Get Redemption List ......................................................................................................................... 16 14. Initiate Redemption .......................................................................................................................... 17 1

2. pointsonline 15. Authorize Redemption ...................................................................................................................... 18 16. Cancel Initiated Redemption ............................................................................................................ 19HTTP FAILURE Responses............................................................................................................................ 20 2

3. pointsonlineIntroductionPointsonline.com services can be easily integrated with applications such as POS systems, Mobile POS,E-Commerce sites, Coupon sites, Smart Phone Apps, Back office accounting systems etc.Pointsonline.com is a cloud service that is available for integration through a standard REST-ful API.Before you can access the API, you must first register your business with pointsonline.com. (go topointsonline.com and click on Merchants and follow the sign up link!) Once registered, you will receivelogin id and password (which you can change later) within 24 hrs to 48 hrs after satisfactoryauthentication of your business.You must Login and set your loyalty scheme before you can use the API. For all http(s) API requests:loginid, password and merchant key are mandatory.Using the API you can do the following 1. Reward Points/Discount transaction 2. Redemption 3. Get Point Balance 4. Redeem Coupon 5. Credit Cash to a Customer 6. Debit Cash from a Customer 7. Create Customer 8. Delete a Customer 9. Reward Scheme 10. Redemption Scheme 11. Qualifying Redemptions 12. List ItemsE-Commerce API 13. Get the Redemption List 14. Initiate Redemption 15. Authorize Redemption 16. Cancel Initiated Redemption (For Create Customer please use API call No 7 from above list)*Advanced API is available for registered merchants upon written request, please contactsales@pointsonline.com. Advanced API enables requesting for high value real time predictive analyticssuch as personalized coupons and relevant offers when checking out shopping-cart.Note: Customer-Id is one of email or global mobile no. or customer-no. By default an item "Cash" isdefined and a Reward Formula is defined for cash which is editable._____________________________________________________________________________________ 3

4. pointsonline1. Reward points/Discount transactionhttps://www.pointsonline.com/pol-api/api.php?loginid=test@gmail.com&password=abcd1234&key=biz123&submit-reward=cust001,1,2700,22,10/11/2009,good service,reward,,,;Returns points added to the customer.HTTP Method GET, POSTSupported response formats: jsonParameter Descriptiona. Customer-Id (Mandatory) - Customer-Id can be email/ISD-Mobile/Merchant Specific customer No.b. Item-Id (Mandatory)c. Bill-Amount (Mandatory)d. Bill-No.e. Bill-Date (Mandatory)f. Customer-Commentg. Transaction-Type (REWARD/DISCOUNT) (Default is REWARD)h. Discount-Percent (Mandatory if it is a Discount Transaction)i. Store-Id (For Merchant default to store-id=1 and for operators default to respective store-id)j. Division-Id (Mandatory if the transaction is against a Division)Response fieldsAn array of objects representing response, points.Look for FAILURE responses at the end of this document_____________________________________________________________________________________ 4

5. pointsonline2. Redemptionhttps://www.pointsonline.com/pol-api/api.php?loginid=test@gmail.com&password=abcd1234&key=biz123&submit-redemption=cust001,1,50;Returns redemption_amount.HTTP Method GET, POSTSupported response formats: jsonParameter Descriptiona. Customer-Id (Mandatory)b. Item-Id (Mandatory)c. Amount/ Count to redeem (Mandatory)Response fieldsAn array of objects representing response, amount.Look for FAILURE responses at the end of this document_____________________________________________________________________________________ 5

6. pointsonline3. Get Points Balancehttps://www.pointsonline.com/pol-api/api.php?loginid=test@gmail.com&password=abcd1234&key=biz123&customer-password=abc456&customer-balance=cust001;Returns customer points_balance,cash_balance,points_to_cash balance.HTTP Method GET, POSTSupported response formats: jsonParameter Description a. Customer-Password (Mandatory) b. Customer-Id (Mandatory)Response fieldsAn array of objects representing response, points, cash, points_to_cash.Look for FAILURE responses at the end of this document_____________________________________________________________________________________ 6

7. pointsonline4. Redeem Coupon https://www.pointsonline.com/pol-api/api.php?loginid=test@gmail.com&password=abcd1234&key=biz123&coupon-redemption=cust001,567646501177;Returns coupon_code.HTTP Method GET, POSTSupported response formats: jsonParameter Descriptiona. Customer-Id (Mandatory)b. Coupon-Code (Mandatory)Response fieldsAn array of objects representing response, coupon_code.Look for FAILURE responses at the end of this document_____________________________________________________________________________________ 7

8. pointsonline5. Credit Cash to a Customerhttps://www.pointsonline.com/pol-api/api.php?loginid=test@gmail.com&password=abcd1234&key=biz123&cash-txn=cust001,credit,7500;Returns amount.HTTP Method GET, POSTSupported response formats: jsonParameter Descriptiona. Customer-Id (Mandatory)b. Transaction-Type (Mandatory)c. Amount to Credit (Mandatory)Response fieldsAn array of objects representing response, amount.Look for FAILURE responses at the end of this document_____________________________________________________________________________________ 8

9. pointsonline6. Debit Cash from a Customerhttps://www.pointsonline.com/pol-api/api.php?loginid=test@gmail.com&password=abcd1234&key=biz123&cash-txn=cust001,debit,500;Returns amount.HTTP Method GET, POSTSupported response formats: jsonParameter Descriptiona. Customer-Id (Mandatory)b. Transaction-Type (Mandatory)c. Amount to Debit (Mandatory)Response fieldsAn array of objects representing response, amount.Look for FAILURE responses at the end of this document_____________________________________________________________________________________ 9

10. pointsonline 7. Create Customerhttps://www.pointsonline.com/pol-api/api.php?loginid=test@gmail.com&password=abcd1234&key=biz123&create-customer=Mr.,Rakesh,kumar,rajeshk17@gmail.com,91,9495969789,cust001,1985-10-25,GE;Returns customer id.HTTP Method GET, POSTSupported response formats: jsonParameter Descriptiona. Salutationb. First Name (Mandatory)c. Last Named. Email (One of Email or ISD-Code along with Mobile-No is Mandatory)e. ISD-Codef. Mobile-No (One of Email or ISD-Code along with Mobile-No is Mandatory)g. Customer-No (Length of Customer No can be 1 to 9 alpha-numeric or 16 characters)h. Date-of-birthi. Company-NameResponse fieldsAn array of objects representing response, id.Look for FAILURE responses at the end of this document_____________________________________________________________________________________ 10

11. pointsonline8. Delete a Customerhttps://www.pointsonline.com/pol-api/api.php?loginid=test@gmail.com&password=abcd1234&key=biz123&update-status=cust001,deleted;Returns customer status.HTTP Method GET, POSTSupported response formats: jsonParameter Descriptiona. Customer-Id (Mandatory)b. Status (Mandatory)Response fieldsAn array of objects representing response, status.Look for FAILURE responses at the end of this document_____________________________________________________________________________________ 11

12. pointsonline9. Reward Schemehttps:// www.pointsonline.com /pol-api/api.php?loginid=test@gmail.com&password=abcd1234&key=biz123&reward-scheme=merItemId;Returns Merchants Reward Scheme.HTTP Method GET, POSTSupported response formats: jsonParameter Descriptiona. merItemId (Mandatory)Response fieldsAn array of objects representing response, points, bill_amount, minimum_amount.Look for FAILURE responses at the end of this document_____________________________________________________________________________________ 12

13. pointsonline10. Redemption Schemehttps:// www.pointsonline.com /pol-api/api.php?loginid=test@gmail.com&password=abcd1234&key=biz123&redemption-scheme=merItemId;Returns Merchants Redemption Scheme.HTTP Method GET, POSTSupported response formats: jsonParameter Descriptiona. merItemId (Mandatory)Response fieldsAn array of objects representing response, points, redeem_amount.Look for FAILURE responses at the end of this document_____________________________________________________________________________________ 13

14. pointsonline11. Qualifying Redemptionshttps:// www.pointsonline.com /pol-api/api.php?loginid=test@gmail.com&password=abcd1234&key=biz123&qualifying-redemptions=cust001;Returns Customer Qualifying Redemptions.HTTP Method GET, POSTSupported response formats: jsonParameter Descriptiona. Customer-Id (Mandatory)Response fieldsAn array of objects representing response, qualifying_list which is an array of objects representing itemname and points-needed-to-redeem.Look for FAILURE responses at the end of this document._____________________________________________________________________________________ 14

15. pointsonline12. List Itemshttps:// www.pointsonline.com /pol-api/api.php?loginid=test@gmail.com&password=abcd1234&key=biz123& list-items=offer;Returns Items List.HTTP Method GET, POSTSupported response formats: jsonParameter Descriptiona. Item Type (Mandatory) -> Offer/ Inventory/ BothResponse fieldsAn array of objects representing response, item_list .Look for FAILURE responses at the end of this document_____________________________________________________________________________________ 15

16. pointsonline13. Get Redemption Listhttps:// www.pointsonline.com /pol-api/api.php?loginid=test@gmail.com&password=abcd1234&key=biz123&redemption-list=cust001;Returns Redemptions List. Shows Valid Redemption list and Invalid Redemption list.HTTP Method GET, POSTSupported response formats: jsonParameter Descriptiona. Customer-Id (Mandatory)Response fieldsAn array of objects representing response, redemptions_list.Look for FAILURE responses at the end of this document_____________________________________________________________________________________ 16

17. pointsonline14. Initiate Redemptionhttps:// www.pointsonline.com /pol-api/api.php?loginid=test@gmail.com&password=abcd1234&key=biz123&customer-id=cust001&customer-password=abc456&initiate-redemption=1,3;6,8;Returns redemption-code, item-count, item-Id, item-name and item-price.HTTP Method GET, POSTSupported response formats: jsonParameter Description a. Customer-Id (Mandatory) b. Customer-Password (Mandatory) c. initiate-redemption (Mandatory) 1. Item-Count (Mandatory) 2. Item-Id (Mandatory)Item-count and Item-id separated by comma ( , ) and ends with semi colon ( ; )Response fieldsAn array of objects representing response, redemption-code, item-count, item-Id, item-name and item-price.Look for FAILURE responses at the end of this document_____________________________________________________________________________________ 17

18. pointsonline15. Authorize Redemptionhttps:// www.pointsonline.com /pol-api/api.php?loginid=test@gmail.com&password=abcd1234&key=biz123&authorise-redemption=cust001,54893;Returns Success/ Failure message along with redemption code.HTTP Method GET, POSTSupported response formats: jsonParameter Descriptiona. Customer-Id (Mandatory)b. Redemption-Code (Mandatory)Response fieldsAn array of objects representing response, Success/ Failure message along with redemption code.Look for FAILURE responses at the end of this document_____________________________________________________________________________________ 18

19. pointsonline16. Cancel Initiated Redemptionhttps:// www.pointsonline.com /pol-api/api.php?loginid=test@gmail.com&password=abcd1234&key=biz123&customer-id=cust001&customer-password=abc456&cancel-initiate-redemption=63116;Returns Redemption code, Valid / Invalid redemption code.HTTP Method GET, POSTSupported response formats: jsonParameter Descriptiona. Customer-Id (Mandatory)b. Customer-Password (Mandatory)c. cancel-initiate-redemption 1. Redemption-Code (Mandatory)Response fieldsAn array of objects representing response, Redemption code, valid/ Invalid redemption code.Look for FAILURE responses at the end of this document 19

20. pointsonlineHTTP FAILURE ResponsesAn array of objects representing response, code.6300-We are unable to process the request now please try again Later6301-please check your Request6303-Invalid Merchant6304-Invalid Customer6305-Invalid Transaction Type6307-Insufficient cash Balance. Unable to debit6308-Unable to delete, customer has points6309-Invalid Status6310-Bill Amount is less than minimum amount6314- Reward transaction failed. Customer is deleted6315-Customer creation Failed. User already exists with given email/mobile No.6317-Customer creation failed. Email is mandatory6318-Customer creation failed. Name should be minimum of three characters6320-Invalid Email6321-Customer creation failed. Customer No. length must be in the range of 1 to 9 characters6322-Customer creation failed. Customer No. exist6323-Customer creation failed. Customer No. is required6326-Customer has not enough points balance to redeem6330-Invalid Coupon6331-Coupon code is mandatory6332-Coupon Redemption period expired6333-Coupon already used6334-No Item Found with the given name6336-Bill Amount/Count Required. 20

21. pointsonline6337-valid division-Id is required6338-merchant User should use his/her store-Id6339-Entered amount should be multiples of redeem Amount.6340-No Reward scheme defined6341-No Qualifying redemptions6342-No Items Found6343-Already Authorized6344-No Active Formula6345-Invalid Item Id6346-Already Cancelled_________________________________________________________________________________________________For more information please contact:Pointsonline Pvt. Ltd.1D Doctors Colony, Madhapur, Hyderabad 500081, Andhra Pradesh, IndiaPh: +91 064522557support@pointsonline.com www.pointsonline.com 21