Reverse Redeemed Rewards

Converts rewards back to points when the order is cancelled or returned.
Note: Once a reward has been redeemed, it cannot be cancelled. To cancel the rewards (convert back to points) before redemption, use the Cancel Reward endpoint - POST /api/v1/redeem/cancel.

Authorizations

Authorization

string

headerrequired

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

Body

application/json

Details of Reverse Rewards endpoint

redemptionCode

string

required

Redemption code used to identify the rewards used in a specific transaction. This is generated in the response of the Issue Variable Rewards endpoint - POST /api/v1/redeem/reward/issue.

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.

Response

200 - application/json

Response (metadata) of reward reversal

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

object

Additional data, if applicable