Stamp Redemption API

The Stamp Redemption API marks a reward (e.g., free drink, discount) as redeemed once a customer completes all required stamps.

After redemption, the stamp cannot be used again, and a new stamp must be issued to start the next cycle.
This API is typically used in systems that provide rewards based on visit or purchase history.

This API is available on the Personal plan or higher.

PUT

/api/stamp/v1/redeem 

{
    "stampIdx": 394,
    "onsitePwd": "12345"
}

Request Parameters

stampIdx integer required
Stamp IDX.
onsitePwd string
Employee authentication password used for on-site stamps.
Required only when the stamp has onsiteYn = Y, and must be entered by staff when approving a customer’s reward redemption (e.g., free drink).
Refer to the onsitePwd value returned by the Validate API for input. 
{
    "code": 0,
    "message": "",
    "result": null
}

Response Parameters

code integer
Response code: 0 = Success, other values = Error
message string
Response message. If the response code is not 0, an error message is returned.
result null

Where Does Stamp Redemption Fit?

This is the final stage of the stamp system.

  • Verify that stamp accumulation is complete
  • Process reward fulfillment
  • Mark the stamp as redeemed

It is not just a state change, but the step that finalizes the campaign outcome.

Completion Point of the Stamp Lifecycle

This API represents the final step in the stamp lifecycle.

From the user’s perspective, it’s the moment they receive a reward after completing the stamps. From a developer’s perspective, it marks the end of one cycle and the start of the next.

After calling the Redemption API, issuing a new stamp immediately with the Create API helps maintain continuous user engagement.

Full Stamp Lifecycle

  1. Create → Issue a stamp to the user
  2. Add Stamp → Accumulate stamps on visits or purchases
  3. Validate → Check if all stamps are completed
  4. Redeem → Process reward redemption
  5. Create → Start a new cycle with a new stamp

On-site Stamp Handling

onsitePwd is required only when an on-site verification password is enabled for the stamp (onsiteYn = Y).

Store staff enter this value when approving reward redemption to prevent unauthorized use.

Use the onsitePwd value returned by the Validation API.
If no password is configured for the stamp, this field can be omitted.

Post-Redemption Automation Flow

You can trigger automated workflows when a reward is marked as redeemed.

  • Call the Coupon Create API to instantly issue a reward coupon
  • Immediately create a new stamp to start the next accumulation cycle
  • Use webhooks to notify users that redemption is complete

Automating this flow enables a complete reward lifecycle—from fulfillment to re-engagement—without manual intervention.

Operational Considerations

This API is not just a feature—it is the point where business outcomes are finalized.

  • Incorrect handling can lead to duplicate rewards
  • Potential user claims or disputes
  • Increased campaign costs

Always enforce validate → redeem sequencing, server-side transactional control, and audit logging.