Redemption Cancellation

Revert a specific set of redemption transactions.

This action is available in API version 51.0 and later for users with Loyalty Management license.

Supported REST HTTP Methods

URI
/services/data/vXX.X/actions/standard/cancelRedemption
Formats
JSON, XML
HTTP Methods
POST
Authentication
Authorization: Bearer token

Inputs

Input Details
CancellationReason
Type
string
Description
Required. The reason for cancellation of redemption transaction.
ExpiryDate
Type
date
Description
The date of expiration.
ReversalCategory
Type
string
Description
The category of reversal.
TransactionJournalId
Type
string
Description
Required. ID of the transaction journal.

Outputs

Output Details
CancellationTransactionJournalId
Type
string
Description
The ID of the cancellation transaction journal generated after the request is successful.

Example

Sample Request

{
   "inputs":[{
      "TransactionJournalId":"0lvxx00004000001AAA",
      "CancellationReason":"Order Returned by Member",
      "ExpiryDate":"2020-04-15"
   }]
}

Sample Response

{
   "errors":null,
   "isSuccess":true,
   "outputValues":{ 
        "CancellationTransactionJournalId":"0lvxx00004000001AAB"}
   }
}