Triple API and Webhooks
Rewards
Get the details of a reward.
1min
GET
https://api.tripleup.dev/partner/rewards/{id}
triple Prod
PATH PARAMETERS
id
string
*Example: triple-abc-123
The triple-defined ID for the entity.
RESPONSES
200
The reward resulting from a matched offer and transaction.
object[]
amount
number
The calculated reward amount for this Transaction and Offer.
This field may be negative if the Transaction is a Return that
has resulted in an adjustment to a previous reward.
currency_code
string
Example: USD
3-character ISO-4217 currency code. Only USD is currently supported.
Contact your Triple representative for support with additional
currencies. Note that some values are not supported, particularly
test and fund codes.
notes
string
A text description or additional information about why the
Offer was rejected or denied by the merchant. This field is
not intended to be displayed to cardholders.
offer_id
string
*Example: triple-abc-123
The triple-defined ID for the entity.
rejection
string<PURCHASE_AMOUNT_TOO_LOW | ACTIVATION_REQUIRED | MAX_USES_MET | MAX_REWARD_MET | DAY_OF_WEEK_RESTRICTION | TIME_OF_WEEK_RESTRICTION | EXCLUDED_DATE | NON_PARTICIPATING_LOCATION | OTHER>
The reason this matched offer was not applied to the
Transaction.
reward_id
string
*Example: triple-abc-123
The triple-defined ID for the entity.
status
string<REJECTED | PENDING_REVIEW | PENDING_MERCHANT_APPROVAL | DENIED_BY_MERCHANT | PENDING_MERCHANT_FUNDING | PENDING_TRANSFER_TO_PUBLISHER | DISTRIBUTED_TO_PUBLISHER | DISTRIBUTED_TO_CARDHOLDER>
*The Reward status.
- `REJECTED` - The Transaction did not meet the offer terms.
- `PENDING_REVIEW` - The Transaction is pending a manual review.
The reward may be deleted if it is determined to be an invalid
match to this merchant's offer.
- `PENDING_MERCHANT_APPROVAL` - The Transaction is waiting for the
Merchant or Content Provider to approve or deny the Reward.
- `DENIED_BY_MERCHANT` - The Merchant or Content Provider denied
the Reward. A reason will be included in `reward_details`.
- `PENDING_MERCHANT_FUNDING` - The Reward was approved and is
awaiting funding by the Merchant.
- `PENDING_TRANSFER_TO_PUBLISHER` - The Reward is funded and funds
are awaiting distribution to the Publisher.
- `DISTRIBUTED_TO_PUBLISHER` - Reward funds have been sent to the
Publisher.
- `DISTRIBUTED_TO_CARDHOLDER` - The Publisher has reported that the
Reward has been given to the cardholder.
404
TripleInvalidPathError
object
status_code
integer
*The 3-digit HTTP Response Status code
content
object
*The error response content.
422
TripleUnprocessableEntity
object
status_code
integer
*The 3-digit HTTP Response Status code
content
object
*The error response content.
Updated 24 Oct 2023
Did this page help you?