POST
/
v1
/
redeem
/
member-reward

Authorizations

Authorization
string
headerrequired

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

Body

application/json

Reward details

redemptionCode
string
required

Redemption code. This code must be specified. Redemption code is generated in the response of the Issue Variable Rewards (POST /api/v1/redeem/reward/issue) endpoint.

locationExternalReference
string
required

Represents the store where the rewards are being redeemed. Each store (online, physical or POS) has a unique locationExternalReference name or ID.

Minimum length: 1
profileId
string

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

redeemAuditUser
string

Representative who is issuing the reward redemption.

Minimum length: 1

Response

200 - application/json

Response (metadata) of redeemed rewards

status
integer

Status of the call

message
string
default: Exception message

Message corresponding to the call

Minimum length: 1
errors
object

Error details, if applicable

data
any

Reward details, if applicable

Was this page helpful?

Issue RewardCancel Rewards