Redeem

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

Enables the redemption of a freebie associated with a user's loyalty card within a merchant's loyalty program. It requires parameters such as a card number and either the freebie's external ID or its internal ID. The function retrieves the user's loyalty card associated with the merchant. If no active card is found, it returns an error indicating so. It then fetches the freebies based on the provided IDs and external IDs that belong to the merchant's loyalty program. For each freebie found, it attempts to redeem the freebie item associated with the user's loyalty card. If redemption is successful, it returns a success response indicating that the freebie has been redeemed.

Body Params
string
required
string
string
required
string

Required if freebieExternalId is not provided

string

Required if freebieId is not provided

string
required
json
Responses

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