Skip to main content

Give Chop Stamp

Issue a chop stamp to a customer's loyalty card. Each scan adds one stamp toward their reward.

When to Use

Use this endpoint when:

  • A customer presents their chop-stamp QR code at checkout
  • Manually awarding stamps from the merchant terminal

How to Use

Endpoint
POST/v3/loyalty/chop-stamp/card/scan

POST the scanned QR code to the endpoint. The response confirms the new stamp count and whether the card is complete.


Request Parameters

codeSTRING

QR code Url link

Example: EhQKCE1lcmNoYW50EJXVzd3wraqTORIgChRMb3lhbHR5Q2hvcFN0YW1wQ2FyZBCm1qHe2eDX_BU:d439a47d-3cd3-48bc-aae7-1effda5c7e1b

images

Response Parameters

itemOBJECT

Transaction object

idSTRING

Chop Stamp ID

Example: "1583401221690518310"

keySTRING

Chop Stamp Key

Example: "EhQKCE1lcmNoYW50EJXVzd3wraqTORIgChRMb3lhbHR5Q2hvcFN0YW1wQ2FyZBCm1qHe2eDX_BU"

noOfChoppedStampINTEGER

Number of redeem

Example: 2

isCompletedBOOLEAN

True or False

Example: false

startAtDATETIME

Time Start

Example: "2020-03-02T13:49:08Z"

endAtDATETIME

Time End

Example: "2021-04-02T13:49:08Z"

createdAtDATETIME

Creation date time

Example: "2020-03-05T09:40:21Z"

updatedAtDATETIME

Last update date time

Example: "2020-03-05T09:40:21Z"

codeSTRING

Successfully call this endpoint. If fail, will return error code object (Refer Appendix 1: Error Codes)

Example: "SUCCESS"