Newer Version Available

This content describes an older version of this product. View Latest

Redemption Cancellation Actions

Revert a specific set of redemption transactions.

This object 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
GET, HEAD, POST
Authentication
Authorization: Bearer token

Inputs

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

Outputs

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

Example

Sample Request

1{
2   "inputs":[ 
3      {
4        "TransactionJournalId":"0lvxx00004000001AAA",
5        "CancellationReason":"Duplicate Accrual",
6        "ExpiryDate":"2020-04-15"
7      }
8   ]
9}

Sample Response

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