Redeem Coupon

Redeem a coupon on behalf of the member associated with the given card.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

This endpoint allows a user to redeem a coupon associated with their loyalty card.
The client must provide at least one identifier to specify the coupon to be redeemed:

  • a user-specific coupon ID (user_coupon_id)
  • a general coupon ID (coupon_id)
  • or a coupon code (coupon_code, such as a barcode or QR code)

The server will attempt to locate and redeem the correct coupon based on the provided input.
If multiple identifiers are provided, the user_coupon_id takes precedence, followed by the coupon_code, and finally the coupon_id.

Path Params
string
required

Your custom card identificator or UUID of the card

Body Params
string

UUID of the assigned User Coupon

string

Code of the coupon

string

UUID of the Coupon

string
enum
Defaults to CustomParam

Type of provided Venue ID

Allowed:
string
Defaults to OurID:V001

For custom param use param_slug:custom_param_value

json
Defaults to []
Headers
string
enum
Defaults to application/json

Generated from available request content types

Allowed:
Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json