Within 24 hours you can integrated our Loyalty Solution with your E-Commerce website through our smart APIs. For further information please contact support@pointsonline.com

1. pointsonline
pointsonline
REWARD
REDEEM
Pointsonline 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 ............................................................................................................ 19
HTTP FAILURE Responses............................................................................................................................ 20
2

3. pointsonline
Introduction
Pointsonline.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 to
pointsonline.com and click on Merchants and follow the sign up link!) Once registered, you will receive
login id and password (which you can change later) within 24 hrs to 48 hrs after satisfactory
authentication 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 Items
E-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 contact
sales@pointsonline.com. Advanced API enables requesting for high value real time predictive analytics
such 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" is
defined and a Reward Formula is defined for cash which is editable.
_____________________________________________________________________________________
3

4. pointsonline
1. Reward points/Discount transaction
https://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, POST
Supported response formats: json
Parameter Description
a. 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-Comment
g. 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 fields
An array of objects representing response, points.
Look for FAILURE responses at the end of this document
_____________________________________________________________________________________
4

5. pointsonline
2. Redemption
https://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, POST
Supported response formats: json
Parameter Description
a. Customer-Id (Mandatory)
b. Item-Id (Mandatory)
c. Amount/ Count to redeem (Mandatory)
Response fields
An array of objects representing response, amount.
Look for FAILURE responses at the end of this document
_____________________________________________________________________________________
5

6. pointsonline
3. Get Points Balance
https://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, POST
Supported response formats: json
Parameter Description
a. Customer-Password (Mandatory)
b. Customer-Id (Mandatory)
Response fields
An array of objects representing response, points, cash, points_to_cash.
Look for FAILURE responses at the end of this document
_____________________________________________________________________________________
6

7. pointsonline
4. 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, POST
Supported response formats: json
Parameter Description
a. Customer-Id (Mandatory)
b. Coupon-Code (Mandatory)
Response fields
An array of objects representing response, coupon_code.
Look for FAILURE responses at the end of this document
_____________________________________________________________________________________
7

8. pointsonline
5. Credit Cash to a Customer
https://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, POST
Supported response formats: json
Parameter Description
a. Customer-Id (Mandatory)
b. Transaction-Type (Mandatory)
c. Amount to Credit (Mandatory)
Response fields
An array of objects representing response, amount.
Look for FAILURE responses at the end of this document
_____________________________________________________________________________________
8

9. pointsonline
6. Debit Cash from a Customer
https://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, POST
Supported response formats: json
Parameter Description
a. Customer-Id (Mandatory)
b. Transaction-Type (Mandatory)
c. Amount to Debit (Mandatory)
Response fields
An array of objects representing response, amount.
Look for FAILURE responses at the end of this document
_____________________________________________________________________________________
9

10. pointsonline
7. Create Customer
https://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, POST
Supported response formats: json
Parameter Description
a. Salutation
b. First Name (Mandatory)
c. Last Name
d. Email (One of Email or ISD-Code along with Mobile-No is Mandatory)
e. ISD-Code
f. 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-birth
i. Company-Name
Response fields
An array of objects representing response, id.
Look for FAILURE responses at the end of this document
_____________________________________________________________________________________
10

11. pointsonline
8. Delete a Customer
https://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, POST
Supported response formats: json
Parameter Description
a. Customer-Id (Mandatory)
b. Status (Mandatory)
Response fields
An array of objects representing response, status.
Look for FAILURE responses at the end of this document
_____________________________________________________________________________________
11

12. pointsonline
9. Reward Scheme
https:// 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, POST
Supported response formats: json
Parameter Description
a. merItemId (Mandatory)
Response fields
An array of objects representing response, points, bill_amount, minimum_amount.
Look for FAILURE responses at the end of this document
_____________________________________________________________________________________
12

13. pointsonline
10. Redemption Scheme
https:// 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, POST
Supported response formats: json
Parameter Description
a. merItemId (Mandatory)
Response fields
An array of objects representing response, points, redeem_amount.
Look for FAILURE responses at the end of this document
_____________________________________________________________________________________
13

14. pointsonline
11. Qualifying Redemptions
https:// 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, POST
Supported response formats: json
Parameter Description
a. Customer-Id (Mandatory)
Response fields
An array of objects representing response, qualifying_list which is an array of objects representing item
name and points-needed-to-redeem.
Look for FAILURE responses at the end of this document.
_____________________________________________________________________________________
14

15. pointsonline
12. List Items
https:// www.pointsonline.com /pol-api/api.php?
loginid=test@gmail.com&password=abcd1234&key=biz123& list-items=offer;
Returns Items List.
HTTP Method GET, POST
Supported response formats: json
Parameter Description
a. Item Type (Mandatory) -> Offer/ Inventory/ Both
Response fields
An array of objects representing response, item_list .
Look for FAILURE responses at the end of this document
_____________________________________________________________________________________
15

16. pointsonline
13. Get Redemption List
https:// 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, POST
Supported response formats: json
Parameter Description
a. Customer-Id (Mandatory)
Response fields
An array of objects representing response, redemptions_list.
Look for FAILURE responses at the end of this document
_____________________________________________________________________________________
16

17. pointsonline
14. Initiate Redemption
https:// 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, POST
Supported response formats: json
Parameter 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 fields
An 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. pointsonline
15. Authorize Redemption
https:// 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, POST
Supported response formats: json
Parameter Description
a. Customer-Id (Mandatory)
b. Redemption-Code (Mandatory)
Response fields
An array of objects representing response, Success/ Failure message along with redemption code.
Look for FAILURE responses at the end of this document
_____________________________________________________________________________________
18

19. pointsonline
16. Cancel Initiated Redemption
https:// 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, POST
Supported response formats: json
Parameter Description
a. Customer-Id (Mandatory)
b. Customer-Password (Mandatory)
c. cancel-initiate-redemption
1. Redemption-Code (Mandatory)
Response fields
An array of objects representing response, Redemption code, valid/ Invalid redemption code.
Look for FAILURE responses at the end of this document
19

20. pointsonline
HTTP FAILURE Responses
An array of objects representing response, code.
6300-We are unable to process the request now please try again Later
6301-please check your Request
6303-Invalid Merchant
6304-Invalid Customer
6305-Invalid Transaction Type
6307-Insufficient cash Balance. Unable to debit
6308-Unable to delete, customer has points
6309-Invalid Status
6310-Bill Amount is less than minimum amount
6314- Reward transaction failed. Customer is deleted
6315-Customer creation Failed. User already exists with given email/mobile No.
6317-Customer creation failed. Email is mandatory
6318-Customer creation failed. Name should be minimum of three characters
6320-Invalid Email
6321-Customer creation failed. Customer No. length must be in the range of 1 to 9 characters
6322-Customer creation failed. Customer No. exist
6323-Customer creation failed. Customer No. is required
6326-Customer has not enough points balance to redeem
6330-Invalid Coupon
6331-Coupon code is mandatory
6332-Coupon Redemption period expired
6333-Coupon already used
6334-No Item Found with the given name
6336-Bill Amount/Count Required.
20

21. pointsonline
6337-valid division-Id is required
6338-merchant User should use his/her store-Id
6339-Entered amount should be multiples of redeem Amount.
6340-No Reward scheme defined
6341-No Qualifying redemptions
6342-No Items Found
6343-Already Authorized
6344-No Active Formula
6345-Invalid Item Id
6346-Already Cancelled
_________________________________________________________________________________________________
For more information please contact:
Pointsonline Pvt. Ltd.
1D Doctors Colony, Madhapur, Hyderabad 500081, Andhra Pradesh, India
Ph: +91 064522557
support@pointsonline.com
www.pointsonline.com
21