Skip to main content

Get an Offer

GET 

https://api.tripleup.dev/partner/offers/:id

Get an Offer

Request

Path Parameters

    id EntityIdrequired

    Possible values: non-empty and <= 100 characters

Responses

Offer

Schema
    activation_duration_in_daysOfferActivationInDays (integer)nullable

    If specified, the number of days (inclusive) for which an offer activation is valid.

    If a transaction falls outside of this duration, it will not qualify for the offer. The day of activation is considered day 1. So, if a cardholder activates an offer on Monday with a 3 day duration, they must make their transaction on or before Wednesday.

    activation_requiredOfferActivationIsRequired (boolean)required

    Indicates whether or not a cardholder must activate this offer prior to transacting and qualifying for the offer reward.

    If true, transactions that occur prior to the date of the cardholder activating the offer will not qualify for the offer's reward.

    campaign_ends_ondate

    The date on which the offer campaign ends.

    Possible values: Value must match regular expression ^\d{4}-\d{2}-\d{2}

    Example: 2021-12-01
    categoryOfferCategory (string)

    triple Offer Category

    Possible values: [AUTOMOTIVE, CHILDREN_AND_FAMILY, ELECTRONICS, ENTERTAINMENT, FINANCIAL_SERVICES, FOOD, HEALTH_AND_BEAUTY, HOME, OFFICE_AND_BUSINESS, RETAIL, SERVICES_AND_SUBSCRIPTIONS, TRAVEL, UTILITIES_AND_TELECOM]

    category_tagsOfferCategoryTags (string)

    A comma-delimited collection of Offer tags

    created_atdate-time

    RFC 3339 date time used for creation and mod times

    Example: 2021-12-01T01:59:59.000Z
    currency_codeOfferCurrencyCode (string)required

    The currency for the offer reward, minimum spend requirement, and maximum reward limitations. The value is an ISO-4217 currency code.

    Possible values: >= 3 characters and <= 3 characters, Value must match regular expression ^[A-Z]{3}$

    Default value: USD
    Example: USD
    descriptionOfferDescription (string)

    A long-form text description of or promotional content for an offer

    Possible values: >= 6 characters and <= 65535 characters

    effective_datedaterequired

    The first date on which the offer is valid.

    Possible values: Value must match regular expression ^\d{4}-\d{2}-\d{2}

    Example: 2021-12-01
    excluded_datesdate[]

    Dates for which the offer is not valid. Transactions made on these dates will not qualify for a reward.

    Possible values: Value must match regular expression ^\d{4}-\d{2}-\d{2}

    expiration_datedatenullablerequired

    If specified, the last date on which the offer is valid.

    Possible values: Value must match regular expression ^\d{4}-\d{2}-\d{2}

    Example: 2021-12-31
    external_idOffer External ID (string)required

    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 (###-##-####).

    Possible values: non-empty and <= 255 characters, Value must match regular expression ^(?!\d{3}-\d\d-\d{4}$)

    Example: id-for-entity
    headlineOfferHeadline (string)required

    The headline or title for the offer, appropriate for top-level display.

    Possible values: >= 6 characters and <= 100 characters

    idEntityId (string)required

    The triple-defined ID for the entity.

    Possible values: non-empty and <= 100 characters

    Example: triple-abc-123
    invalid_day_parts object

    If specified, the days of the week and times during which the offer is invalid.

    friday object
    timesstring[]

    Possible values: >= 1, <= 3

    monday object
    timesstring[]

    Possible values: >= 1, <= 3

    saturday object
    timesstring[]

    Possible values: >= 1, <= 3

    sunday object
    timesstring[]

    Possible values: >= 1, <= 3

    thursday object
    timesstring[]

    Possible values: >= 1, <= 3

    tuesday object
    timesstring[]

    Possible values: >= 1, <= 3

    wednesday object
    timesstring[]

    Possible values: >= 1, <= 3

    marketing_fee_currency_codeOfferMarketingFeeCurrencyCode (string)nullable

    The ISO-3166 label for marketing currency. Defaults to 'USD' if omitted or null.

    Possible values: >= 3 characters and <= 3 characters, Value must match regular expression ^[A-Z]{3}$

    Default value: USD
    Example: USD
    marketing_fee_ratedoublenullable

    The share percentage if this offer has a marketing_fee_type of percentage, the amount will be between 0.0 and 100.0. The value is a string but can be parsed as a double precision floating point number.

    marketing_fee_typeOfferMarketingFeeType (string)

    Possible values: [FIXED, PERCENTAGE]

    marketing_fee_valueOfferMarketingFeeValue (string)

    The fixed share value if this offer has a marketing_fee_type of fixed, the amount must be greater than or equal to 0. The value is a string but can be parsed as a double precision floating point number.

    maximum_redemptionsOfferMaximumRedemptions (string)nullable

    The maximum number of times a cardholder may receive a reward for this offer over a given period of time.

    The numerator of this value is the number of times a reward can be earned. The numerator must be less than 1000. The denominator is the period of time over which the limit is enforced.

    Time periods must conform to the following restrictions:

    • a period of years (Y) must be 1-3
    • a period of months (M) must be 1-36
    • a period of weeks (W) must be 1-156
    • a period of days (D) must be 1-365

    Possible values: Value must match regular expression ^\d{1,3}\/\d{1,3}[YMWD]$

    Example: 1/3M
    maximum_reward_cumulativeOfferMaximumRewardCumulative (string)nullable

    The maximum monetary value a cardholder may earn for this offer across multiple transactions over a given period of time.

    The numerator of this value is the maximum monetary value a reward can earn. The numerator must be less than 1000000000000. The denominator is the period of time over which the limit is enforced.

    Time periods must conform to the following restrictions:

    • a period of years (Y) must be 1-3
    • a period of months (M) must be 1-36
    • a period of weeks (W) must be 1-156
    • a period of days (D) must be 1-365

    Possible values: Value must match regular expression ^\d{1,12}\/\d{1,3}[YMWD]$

    Example: 1/3M
    maximum_reward_per_transactiondoublenullable

    The maximum monetary value a cardholder may earn for a percentage-based reward on any single transaction. The value is a string but can be parsed as a double precision floating point number.

    Possible values: > 0

    merchant_category_codesMerchantCategoryCode (string)[]nullable

    The Merchant Category Codes included for a categorical offer.

    Possible values: >= 1, <= 25

    merchant_external_idMerchant External ID (string)

    Partner-provided, external ID for a Merchant.

    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 Merchant 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 (###-##-####).

    Possible values: non-empty and <= 255 characters, Value must match regular expression ^(?!\d{3}-\d\d-\d{4}$)

    Example: id-for-entity
    merchant_websiteurlnullable

    Possible values: <= 2000 characters, Value must match regular expression ^https://.+$

    Example: https://merchant-website.com
    minimum_spenddouble

    The minimum monetary value that a cardholder must spend for a transaction to qualify for this offer. The value is a string but can be parsed as a double precision floating point number.

    Possible values: >= 0

    modeOfferMode (string)required

    The offer delivery mode

    Possible values: [ONLINE, IN_PERSON, IN_PERSON_AND_ONLINE]

    offer_budget object
    currency_codeCurrencyCode (string)required

    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.

    Possible values: >= 3 characters and <= 3 characters, Value must match regular expression ^[A-Z]{3}$

    Default value: USD
    Example: USD
    estimated_allocationdoublerequired

    The maximum allocation available for this offer's budget. The value is a string but can be parsed as a double precision floating point number.

    excluded_from_searchbooleanrequired
    limitintegerrequired
    offer_typeOfferType (string)required

    The type of offer - card-linked, affiliate, categorical, etc.

    Possible values: [CARD_LINKED, AFFILIATE, CATEGORICAL]

    reward_ratedoublenullable

    The reward percentage if this offer has a reward_type of percentage, the amount will be between 0.0 and 100.0. The value is a string but can be parsed as a double precision floating point number.

    Possible values: > 0

    reward_typeOfferRewardType (string)required

    Indicates whether this offer is for a fixed or percentage-based amount.

    Possible values: [FIXED, PERCENTAGE]

    reward_valuedoublenullable

    The fixed reward value if this offer has a reward_type of fixed, the amount must be greater than or equal to 0. The value is a string but can be parsed as a double precision floating point number.

    Possible values: > 0

    termsOfferTermsAndConditions (string)nullable

    Terms and conditions for the offer, not inclusive of other limits specified by the offer properties, such as minimum spend, excluded dates, or activation requirements.

    updated_atdate-time

    RFC 3339 date time used for creation and mod times

    Example: 2021-12-01T01:59:59.000Z
    valid_day_parts object

    If specified, the days of the week and times during which the offer is valid. If unspecified, the offer is valid for all days and times during the week.

    friday object
    timesstring[]

    Possible values: >= 1, <= 3

    monday object
    timesstring[]

    Possible values: >= 1, <= 3

    saturday object
    timesstring[]

    Possible values: >= 1, <= 3

    sunday object
    timesstring[]

    Possible values: >= 1, <= 3

    thursday object
    timesstring[]

    Possible values: >= 1, <= 3

    tuesday object
    timesstring[]

    Possible values: >= 1, <= 3

    wednesday object
    timesstring[]

    Possible values: >= 1, <= 3

Authorization: oauth2

name: triple_authtype: oauth2scopes: api.tripleup.com/partner.content_providersdescription: The triple API uses OAuth2 with a client id and client secret.
The URL to get an OAuth2 token is here:
https://auth.tripleup.dev/oauth2/token
This is an example of how to call the API from the command line.
Code will need to be developed by the partner in their servers.
```bash
# Fetch an access token
TOKEN_URL=https://auth.tripleup.dev/oauth2/token
CLIENT_ID=fake
CLIENT_SECRET=another-fake
# Fetch a space-separated list of scopes
# If not provided, will return an access token
# with all scopes to which the client has access
SCOPE=api.tripleup.com/partner.publishers
TOKEN_RESPONSE=$(curl -s -X POST $TOKEN_URL \
  --user $CLIENT_ID:$CLIENT_SECRET \
  --data grant_type=client_credentials \
  --data-urlencode "scope=$SCOPE")
# Use an access token
ACCESS_TOKEN=$(echo $TOKEN_RESPONSE | jq -r '.access_token')
TOKEN_TYPE=$(echo $TOKEN_RESPONSE | jq -r '.token_type')
API_URL=https://api.tripleup.dev
curl -X GET "$API_URL/partner/publishers" \
  --header "Authorization: $TOKEN_TYPE $ACCESS_TOKEN"
```
See the _Client credentials grant_ section at the bottom of this
[AWS blog post](https://aws.amazon.com/blogs/mobile/understanding-amazon-cognito-user-pool-oauth-2-0-grants/)
for more information.
flows: {
  "clientCredentials": {
    "tokenUrl": "https://auth.tripleup.dev/oauth2/token",
    "scopes": {
      "api.tripleup.com/partner.portfolios": "Manage Portfolio Manager details and portfolios of Publishers\n",
      "api.tripleup.com/partner.publishers": "Manage Publisher details, Card Programs, Consumers, Card Accounts,\nand Transactions\n",
      "api.tripleup.com/partner.view_offers": "View recommended Offers, search Offers, and view Offer details\n",
      "api.tripleup.com/partner.content_providers": "Manage Content Provider details, Merchants, Merchant Locations,\nand Offers\n"
    }
  }
}
import http.client

conn = http.client.HTTPSConnection("api.tripleup.dev")
payload = ''
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer <token>'
}
conn.request("GET", "/partner/offers/:id", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
Request Collapse all
Base URL
https://api.tripleup.dev
Auth
Parameters
— pathrequired