List Rewards

1 min

GET

https://api.sandbox.tripleup.dev/partner/rewards

Lists Rewards and associated Transaction details that triple has matched to active Offers in the last 90 days.

Query Parameters

statusobject
- object
- objectRewardStatus

Responses

200Rewards

object
- rewardsobject[]required
  - card_binCardBIN
    Example
    444789
    Description
    The Bank Identification Number (BIN) of a payment card.
  - card_last_4CardLast4
    Example
    0001
    Description
    The last four digits of the Primary Account Number (PAN) of a card.
  - merchant_complete_addressCompleteAddress
    Example
    7370 BAKER ST, STE 100 PITTSBURGH, PA 15206
    Description
    The complete delivery address, composed from the Address properties.
  - merchant_nameMerchantAssumedNamerequired
    Description
    The (doing-business-as) name of the Merchant.
  - offer_external_idOfferExternalId
    Description
    Partner-provided, external ID for an Offer. External IDs should be **stable** and **never sensitive**. External IDs do not need to be globally unique, but we encourage the use of UUIDs. They must be unique for the Offer within the scope of its parent Content Provider. To protect against accidental inclusion of sensitive personal information, external IDs may not be 9-digit numbers or use the US Tax ID format (###-##-####).
    - ExternalId
  - offer_headlineOfferHeadline
    Description
    The headline or title for the offer, appropriate for top-level display.
  - offer_idEntityIdrequired
    Example
    triple-abc-123
    Description
    The triple-defined ID for the entity.
  - reward_idEntityIdrequired
    Example
    triple-abc-123
    Description
    The triple-defined ID for the entity.
  - reward_amountRewardAmount
    Description
    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.
  - reward_currency_codeCurrencyCode
    Example
    USD
    Description
    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.
    Default
    USD
  - statusRewardStatusrequired
    Description
    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.
  - transaction_amountTransactionAmountrequired
    Example
    12
    Description
    The amount of the transaction. An error will be returned if the field contains fractional amounts smaller than those allowed by the transaction's currency code.
  - transaction_currency_codeCurrencyCoderequired
    Example
    USD
    Description
    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.
    Default
    USD
  - transaction_idEntityIdrequired
    Example
    triple-abc-123
    Description
    The triple-defined ID for the entity.
  - transaction_timestampobjectrequired
    - Timestamp
- totalnumberrequired
  Description
  The total number of rewards.

400TripleBadRequestError

object
- status_codeintegerrequired
  Description
  The 3-digit HTTP Response Status code
- contentobjectrequired
  Description
  The error response content.
  - detailsErrorResponseDetails
    Description
    An array of error detail
  - error_messagestringrequired
    Description
    Short description of what went wrong.
    Default
    The request is malformed.
  - exceptionstring<TripleBadRequestError>required
    Description
    The exception type.

403TripleNotAuthenticatedError

object
- status_codeintegerrequired
  Description
  The 3-digit HTTP Response Status code
- contentobjectrequired
  Description
  The error response content.
  - detailsErrorResponseDetails
    Description
    An array of error detail
  - error_messagestringrequired
    Description
    Short description of what went wrong.
    Default
    Client authentication failed.
  - exceptionstring<TripleNotAuthenticatedError>required
    Description
    The exception type.

404TripleInvalidPathError

object
- status_codeintegerrequired
  Description
  The 3-digit HTTP Response Status code
- contentobjectrequired
  Description
  The error response content.
  - detailsErrorResponseDetails
    Description
    An array of error detail
  - error_messagestringrequired
    Description
    Short description of what went wrong.
    Default
    The url path or path parameter is invalid.
  - exceptionstring<TripleInvalidPathError>required
    Description
    The exception type.

409TripleIntegrityError

object
- status_codeintegerrequired
  Description
  The 3-digit HTTP Response Status code
- contentobjectrequired
  Description
  The error response content.
  - detailsErrorResponseDetails
    Description
    An array of error detail
  - error_messagestringrequired
    Description
    Short description of what went wrong.
    Default
    The request was well-formed but violated entity integrity constraints.
  - exceptionstring<TripleIntegrityError>required
    Description
    The exception type.

415TripleUnsupportedMediaType

object
- status_codeintegerrequired
  Description
  The 3-digit HTTP Response Status code
- contentobjectrequired
  Description
  The error response content.
  - detailsErrorResponseDetails
    Description
    An array of error detail
  - error_messagestringrequired
    Description
    Short description of what went wrong.
    Default
    The request defined an unsupported media type.
  - exceptionstring<TripleUnsupportedMediaType>required
    Description
    The exception type.

422TripleUnprocessableEntity

object
- status_codeintegerrequired
  Description
  The 3-digit HTTP Response Status code
- contentobjectrequired
  Description
  The error response content.
  - detailsErrorResponseDetails
    Description
    An array of error detail
  - error_messagestringrequired
    Description
    Short description of what went wrong.
    Default
    The request was well-formed but could not be processed.
  - exceptionstring<TripleUnprocessableEntity>required
    Description
    The exception type.

500TripleInternalServerError

object
- status_codeintegerrequired
  Description
  The 3-digit HTTP Response Status code
- contentobjectrequired
  Description
  The error response content.
  - detailsErrorResponseDetails
    Description
    An array of error detail
  - error_messagestringrequired
    Description
    Short description of what went wrong.
    Default
    Triple was unable to process the request due to an internal error.
  - exceptionstring<TripleInternalServerError>required
    Description
    The exception type.

501TripleNotImplementedError

object
- status_codeintegerrequired
  Description
  The 3-digit HTTP Response Status code
- contentobjectrequired
  Description
  The error response content.
  - detailsErrorResponseDetails
    Description
    An array of error detail
  - error_messagestringrequired
    Description
    Short description of what went wrong.
    Default
    The request failed because it requires a feature that is not yet implemented.
  - exceptionstring<TripleNotImplementedError>required
    Description
    The exception type.

503TripleServiceUnavailable

object
- status_codeintegerrequired
  Description
  The 3-digit HTTP Response Status code
- contentobjectrequired
  Description
  The error response content.
  - detailsErrorResponseDetails
    Description
    An array of error detail
  - error_messagestringrequired
    Description
    Short description of what went wrong.
    Default
    The request failed due to a triple service interruption.
  - exceptionstring<TripleServiceUnavailable>required
    Description
    The exception type.

curl

curl --request GET \
     --url 'https://api.sandbox.tripleup.dev/partner/rewards?status=object' \
     --header 'accept: application/json'

javascript

var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");

var requestOptions = {
   method: 'GET',
   headers: myHeaders,
   redirect: 'follow'
};

fetch("https://api.sandbox.tripleup.dev/partner/rewards?status=object", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));

ruby

require "uri"
require "json"
require "net/http"

url = URI("https://api.sandbox.tripleup.dev/partner/rewards?status=object")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Get.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"

response = https.request(request)
puts response.read_body

python

import requests
import json

url = "https://api.sandbox.tripleup.dev/partner/rewards?status=object"

payload = {}
headers = {
   'accept': 'application/json',
   'content-type': 'application/json'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

200

// Rewards
{
  "rewards": [
    {
      "card_bin": "444789",
      "card_last_4": "0001",
      "merchant_complete_address": "7370 BAKER ST, STE 100\nPITTSBURGH, PA 15206",
      "merchant_name": "",
      "offer_external_id": {},
      "offer_headline": "",
      "offer_id": "triple-abc-123",
      "reward_id": "triple-abc-123",
      "reward_amount": 0,
      "reward_currency_code": "USD",
      "status": "",
      "transaction_amount": {},
      "transaction_currency_code": "USD",
      "transaction_id": "triple-abc-123",
      "transaction_timestamp": {}
    }
  ],
  "total": 0
}

400

// TripleBadRequestError
{
  "status_code": 0,
  "content": {
    "details": [
      ""
    ],
    "error_message": "",
    "exception": ""
  }
}

403

// TripleNotAuthenticatedError
{
  "status_code": 0,
  "content": {
    "details": [
      ""
    ],
    "error_message": "",
    "exception": ""
  }
}

404

// TripleInvalidPathError
{
  "status_code": 0,
  "content": {
    "details": [
      ""
    ],
    "error_message": "",
    "exception": ""
  }
}

409

// TripleIntegrityError
{
  "status_code": 0,
  "content": {
    "details": [
      ""
    ],
    "error_message": "",
    "exception": ""
  }
}

415

// TripleUnsupportedMediaType
{
  "status_code": 0,
  "content": {
    "details": [
      ""
    ],
    "error_message": "",
    "exception": ""
  }
}

422

// TripleUnprocessableEntity
{
  "status_code": 0,
  "content": {
    "details": [
      ""
    ],
    "error_message": "",
    "exception": ""
  }
}

500

// TripleInternalServerError
{
  "status_code": 0,
  "content": {
    "details": [
      ""
    ],
    "error_message": "",
    "exception": ""
  }
}

501

// TripleNotImplementedError
{
  "status_code": 0,
  "content": {
    "details": [
      ""
    ],
    "error_message": "",
    "exception": ""
  }
}

503

// TripleServiceUnavailable
{
  "status_code": 0,
  "content": {
    "details": [
      ""
    ],
    "error_message": "",
    "exception": ""
  }
}

Lists Rewards and associated Transaction details that triple has matched to active Offers in the last 90 days.