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	Type	Description
`CancellationReason`	string	Required. The reason for cancellation of redemption transaction.
`ExpiryDate`	date	The date of expiration.
`ReversalCategory`	string	The category of reversal.
`TransactionJournalId`	string	Required. ID of the transaction journal.

Outputs

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

Example

Sample Request

1{
2   "inputs":[{
3      "TransactionJournalId":"0lvxx00004000001AAA",
4      "CancellationReason":"Order Returned by Member",
5      "ExpiryDate":"2020-04-15"
6   }]
7}

Sample Response

1{
2   "errors":null,
3   "isSuccess":true,
4   "outputValues":{ 
5        "CancellationTransactionJournalId":"0lvxx00004000001AAB"}
6   }
7}