Skip to content

Redemption

Property Type Description
redemptionId string Unique identifier of this redemption
adId string The ID of the ad that was redeemed
amount string The monetary amount earned
redemptionDate string An ISO-8601 formatted date string representing the data the redemption was processed. This differs from the date of the redeeming transaction.
sourceCustomerId string The sourceCustomerId of the recipient customer
sourceAccountId string The sourceAccountId of the recipient account
redeemingTransactionAmount string The monetary amount of the redeeming transaction
transactionId string The transaction ID that this redemption should be placed underneath or in relation to
rewardSettlementRunDate string An ISO-8601 formatted date string representing the time at which the reward settlement was processed. Null if the reward settlement has not yet processed

Example

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
{
    "redemptionId": "992745",
    "adId": "123",
    "amount": 103,
    "redemptionDate": "2023-03-21T12:58:34Z",
    "sourceCustomerId": "609a180c-c896-4ccb-8ef6-8b24fd6ef32b",
    "sourceAccountId": "388836454",
    "redeemingTransactionAmount": 1000,
    "transactionId": "929994552",
    "rewardSettlementRunDate": "2023-03-23T10:44:23"
}

Payload Example

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
{
   "event": "REDEMPTION_PENDING",
   "eventId": "70d91940-3d0a-4ed1-9d64-8aaed5b25648",
   "eventTimestamp": "2024-03-29T16:14:05.712273548Z",
   "redemptions": [
      {
         "redemptionId": "70d91940-3d0a-4ed1-9d64-8aaed5b25648",
         "adId": "1000052938",
         "amount": "700",
         "date": "2024-03-29T16:14:05.712273548Z",
         "sourceCustomerId": "200_March28_07_Ralph_CustId",
         "sourceAccountId": "200_March28_07_Ralph_AccId",
         "redeemingTransactionAmount": "10000",
         "transactionId": "RTM_6108599",
         "rewardSettlementRunDate": null
      }
   ]
}

<div class="bottomPageSpacer"></div>