POST
/
v1
/
redeem
/
reward
/
issue

Authorizations

Authorization
string
headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Details needed to issue a variable reward

profileId
string
required

Profile ID of the member. In an ecosystem, it acts as a primary ID to keep the various systems (apps, websites, etc.) in sync.

locationExternalReference
string
required

External reference ID (or name) of the location where the points are being redeemed.

amountToRedeem
number
required

Dollar amount being redeemed. Maximum amount which can be redeemed (or the reward limit) is configurable. When a member has $100 in their loyalty account and the store has a reward limit of $50, they can use two rewards certificates to redeem the amount fully.

issueAuditUser
string

Name of the representative who is issuing the reward.

tierDiscountValue
number
required

Tier-based discounts can be offered by attaching members to different tiers, such as silver, gold, platinum, etc. Discount percentage or discount amounts can be customized.

Response

200 - application/json
status
integer

Status of the call

message
string
default: Exception message

Message corresponding to the call

errors
any

Error details, if applicable

data
object

Details of the points issued as reward.