Skip to main content
Version: v1.22.43

triple API

Overview

The triple API enables Partners to integrate with the triple platform and Customers (consumers or card holders) to access offer content.

Connecting to our environment requires proper credentials. See the Authentication section for more details.

Additionally, triple content will be placed on a client-specific S3 bucket for ingestion. Please contact your triple client engagement manager for more information and to setup access.

Conventions​

For a PATCH operation, any field marked required should always be passed and any other fields are optional and will not be updated if no field value is passed.

Concepts​

Partner Types​

Portfolio Managers are, generally, companies that provide services to multiple separate financial institutions such as regional banks, credit unions, or companies running open-enrollment rewards programs. These partners manage a portfolio of Publishers.

Publishers are, generally, banks or companies that offer one or more payment Card Programs to individuals.

Content Providers are the companies that publish Offers on the triple platform.

Card Programs​

Card Programs represent a logical grouping of issued payment cards. A Publisher will create a Card Program for each debit or credit card offering, such as miles or cash back. For Publishers that are not Banks/Card Issuers (for example, a third-party rewards program), Card Programs can provide a simple way to organize Card Accounts.

Card Accounts represent the account connected to a payment card. Multiple physical cards may be associated with a single Card Account, such as when there are multiple authorized users or cards are replaced as lost, stolen, or expired. Each Transaction reported to triple must specify the Card Account to which it belongs.

Consumers represent individual card holders. A Consumer may be associated with multiple Card Accounts across a Publisher's Card Programs, such as when an individual has both a "miles" and a "cash back" card with the same bank. Multiple Consumers may be associated with the same Card Account, such as when there are multiple authorized users.

External IDs​

triple requires Partners to specify IDs for the entities they create through the triple API. Generally, these "external" IDs only need to be unique within the scope of an object's parent entity, but we encourage the use of UUIDs to avoid confusion. External IDs must be stable and never sensitive, as they cannot be updated through the API.

triple will also create a unique ID for each entity created through the API.

Partner API​

Most integration effort will focus on calls to endpoints under the /partner path. These endpoints will allow Content Providers to create and update Offer content and Publishers to register card holders, retrieve Offer content for display, and submit Transactions for Rewards.

The exposed APIs allow developers to authenticate to the triple service, register and unregister (delete) cards, retrieve affiliate offer URLs, submit transactions, and see user notifications delivered over webhooks.

The /affiliate-link-api endpoint will soon be updated to integrate with the Partner API. However, the process for generating a link and redirecting the user to the affiliate website will remain generally the same.

Authentication​

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.

# 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 for more information.

Security Scheme Type:

oauth2

OAuth Flow (clientCredentials):

Scopes:

  • api.tripleup.com/partner.portfolios: Manage Portfolio Manager details and portfolios of Publishers

  • api.tripleup.com/partner.publishers: Manage Publisher details, Card Programs, Consumers, Card Accounts, and Transactions

  • api.tripleup.com/partner.view_offers: View recommended Offers, search Offers, and view Offer details

  • api.tripleup.com/partner.content_providers: Manage Content Provider details, Merchants, Merchant Locations, and Offers

License

Commercial