Welcome to Stamps’ API documentation!

Our API is built on HTTP and allows third party systems to easily initiate a transaction. All our APIs are:

• Secured using SSL (uses HTTPS)

• Real time

• Uses JSON as data interchange format

Contents

• Introduction
  • JSON
  • Making a HTTP Request
• Access Token Authentication
  • 1. JWT Token
  • 2. Static Token
• Transaction API
  • 1. Adding a Transaction
  • 2. Adding a Transaction with Redemptions
  • 3. Canceling a Transaction
  • 4. Modify Transaction’s Value or Items
  • 5. Getting Transaction Detail
  • 6. Preview Transaction Earnings
  • 7. List User Transaction
  • 8. Add or Update Transaction
• Redemption API
  • 1. Adding Reward Redemption
  • 2. Adding Voucher Redemption
  • 3. Deduct Voucher Value
  • 4. Adding Redemption by Voucher Code
  • 5. Adding Promo Code Redemption
  • 6. Canceling a Redemption
  • 7. Authorize Redemption
  • 8. Multiple Reward Redemption
• Expiration Journals API
  • 1. Index
• Reward API
  • 1. Querying for Available Rewards
  • 2. Get Reward Detail
  • 3. Rewards by Merchant Group
• Membership API
  • 1. Getting Member Data
  • 2. Member Suggestions
  • 3. Registration
  • 4. Change Member Info
  • 5. Get Full Profile
  • 6. Level Upgrade Requirement
  • 7. Add Membership Tag
  • 8. Remove Membership Tag
  • 9. Set social media profile
  • 10. Anonymize Customer
  • 11. Set Pending Anonymization Customer
  • 12. Set Level
  • 13. Request OTP to Modify Mobile Number
  • 14. Modify Mobile Number
  • 15. Request OTP to Modify Email
  • 16. Modify Email
  • 17. Partial Registration
• Balance API
  • 1. Crediting to a Customer’s Balance
  • 2. Debiting from a Customer’s Balance
  • 3. Canceling a Balance Update
• Voucher API
  • 1. Issuing a voucher to user
  • 2. Validating a Voucher
  • 3. Get Vouchers by Merchant Group
  • 4. Get Vouchers Count by Merchant Group
  • 5. Get Voucher Details
• Feedback API
  • 1. Adding a Feedback
• Booking API
  • 1. Adding a Booking
• Stamps API
  • 1. Add customer stamps
  • 2. Cancel awarded customer stamps
  • 3. Deduct stamps
• Activity API
  • 1. Get Activity List
  • 2. Get Activity List by Merchant Group
• Auth API
  • 1. Validate Password
  • 2. Set PIN
  • 3. Change PIN
  • 4. Validate PIN
  • 5. Unblock PIN
  • 6. Requesting an OTP to Reset PIN
  • 7. Reset PIN
  • 8. Reset PIN with Password
  • 9. Change Password
  • 10. Set Password
  • 11. Requesting an OTP to Reset Password
  • 12. Reset Password with OTP
  • 13. Validate Mobile Number
  • 14. Reset OTP Limit
• Legacy Membership API
  • 1. Validate Legacy Membership
  • 2. Validate Legacy Membership Pin
  • 3. Get Duplicate Legacy Members
  • 4. Search Legacy Membership
  • 5. Merge Legacy Membership
  • 6. Request Pin
  • 7. Activate Legacy Membership
  • 8. Get Merged Legacy Members
• Children API
  • 1. Add Child
  • 2. Delete Child
• Pet API
  • 1. Add Pet
  • 2. Delete Pet
• Hobbies API
  • 1. Set Hobbies
• Survey Api
  • 1. List Survey
• Cards API
  • 1. Create Card
  • 2. Assign Card
• Merchant API
  • 1. Add or Update Payment Method
• Messages API
  • 1. Send Message
• Store API
  • 1. Add or Update Store
• Testing and Error Handling
  • 1. Account Verification
  • 2. Error 500
  • 3. Error 400
  • 4. Error 401
  • 5. Error 403