Get a Transaction

GET 
https://api.tripleup.dev/partner/transactions/:id

Get a Transaction

Request

Path Parameters

id EntityIdrequired

Possible values: non-empty and <= 100 characters

Responses

200

Transaction

application/json

Schema

Schema

amountTransactionAmountrequired
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.
Possible values: > 0
Example: 12
card_account_idEntityId (string)required
The triple-defined ID for the entity.
Possible values: non-empty and <= 100 characters
Example: triple-abc-123
card_account_external_idCard Account External ID (string)
Partner-provided, external ID for a Card Account.
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 Card Account within the scope of its parent Card Program.
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
card_binCardBIN (string)required
The Bank Identification Number (BIN) of a payment card.
Possible values: >= 6 characters and <= 6 characters, Value must match regular expression ^\d{6}$
Example: 444789
card_last_4CardLast4 (string)required
The last four digits of the Primary Account Number (PAN) of a card.
Possible values: >= 4 characters and <= 4 characters, Value must match regular expression ^\d{4}$
Example: 0001
created_atdate-timerequired
RFC 3339 date time used for creation and mod times
Example: 2021-12-01T01:59:59.000Z
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
debitTransactionIsDebit (boolean)required

Whether this is a debit or credit

descriptionTransactionDescription (string)required
The transaction description, usually the merchant name
Possible values: non-empty and <= 256 characters
Example: Pittsburgh Zoo
external_idTransaction External ID (string)required

Partner-provided, external ID.

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 Transactions within the scope of the associated Card Account.

Possible values: non-empty and <= 255 characters, Value must match regular expression ^[a-z0-9]([-_\.a-z0-9]{0,48}[a-z0-9])?$

idEntityId (string)required
The triple-defined ID for the entity.
Possible values: non-empty and <= 100 characters
Example: triple-abc-123
matching_statusTransactionMatchingStatus (string)required

The status of triple matching the Transaction to Offers.

• HISTORIC_TRANSACTION - The Transaction was more than 3 days old when it was submitted to triple. It is not eligible for a Reward.
• NOT_APPLICABLE - The Transaction is not a Purchase or Return, or is otherwise not eligible for a Reward.
• NOT_ENROLLED - The Card Account was not enrolled for Rewards at the time of the Transaction.
• QUEUED - The Transaction is waiting for Offer matching.
• NO_ACTIVE_OFFER - The Transaction did not match any active Offer or meet Offer terms.
• MATCHED - The Transaction was matched to offers and is potentially eligible for a reward. See reward_details for more information.

Possible values: [HISTORIC_TRANSACTION, QUEUED, NOT_APPLICABLE, NOT_ENROLLED, NO_ACTIVE_OFFER, MATCHED]

merchant_address objectrequired
A physical address in the world. triple uses address validation services to update and standardize addresses on our platform. Address data sent to the API may be updated as we process, validate, and normalize addresses. NOTE: Though not marked as required, the street address, postal code, and country code are required for transaction matching to function properly.
citystring
Municipality or city name
Possible values: non-empty and <= 100 characters
Example: PITTSBURGH
completeCompleteAddress (string)
The complete delivery address, composed from the Address properties.
Possible values: non-empty and <= 500 characters
Example: 7370 BAKER ST, STE 100 PITTSBURGH, PA 15206
country_codeCountryCode (string)
2-letter ISO-3166 country code
Possible values: >= 2 characters and <= 2 characters, Value must match regular expression ^[A-Z]{2}$
Example: US
country_subdivision_codestring
ISO-3166-2; 2-6 letter code for a country subdivision
Possible values: >= 2 characters and <= 6 characters
Example: PA
latitudedouble
The latitude of caller. The value is a string but can be parsed as a double precision floating point number.
Possible values: Value must match regular expression ^-?([0-8]?[0-9]|90)(\.[0-9]{1,6})$
Example: 40.440624
longitudedouble
The longitude of caller. The value is a string but can be parsed as a double precision floating point number.
Possible values: Value must match regular expression ^-?([0-9]\.?\d{6}|[1-9][0-9]\.?\d{6}|[1][1-7][1-9]\.?\d{6}|[1][1-8][0]\.?\d{6})?$
Example: -79.995888
postal_codePostalCode (string)
ZIP Code™, ZIP+4, or postal code
Possible values: non-empty and <= 15 characters
Example: 15206
street_addressstring
Single or multi-line physical address
Possible values: >= 2 characters and <= 500 characters
Example: 7370 BAKER ST, STE 100
merchant_category object
codeMerchantCategoryCode (string)required
The 4-digit Merchant Category Code
Possible values: >= 4 characters and <= 4 characters, Value must match regular expression ^\d{4}$
Example: 7998
processor_midProcessorMIDValue (string)
The Merchant ID (MID) value
Possible values: non-empty and <= 50 characters
Example: 9000012345
processor_mid_typeProcessorMIDType (string)
The type of Merchant ID
Possible values: [AMEX_SE_NUMBER, DISCOVER_MID, MC_AUTH_LOC_ID, MC_AUTH_ACQ_ID, MC_AUTH_ICA, MC_CLEARING_LOC_ID, MC_CLEARING_ACQ_ID, MC_CLEARING_ICA, MERCHANT_PROCESSOR, NCR, VISA_VMID, VISA_VSID]
Example: VISA_VMID
processor_tridProcessorTRID (string)
The Token Requestor ID (TRID)
Possible values: >= 11 characters and <= 11 characters, Value must match regular expression ^[0-9]{11}$
Example: 40012345678
reward_details object[]
Array [
merchant_logo_urlurl
A link to the merchant's logo
Possible values: <= 2000 characters, Value must match regular expression ^https://.+$
Example: https://merchant-website.com/merchant-logo.png
offer_titleOfferHeadline (string)
The headline or title for the offer, appropriate for top-level display.
Possible values: >= 6 characters and <= 100 characters
offer_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
offer_reward_typeOfferRewardType (string)
Indicates whether this offer is for a fixed or percentage-based amount.
Possible values: [FIXED, PERCENTAGE]
offer_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
amountdouble
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.
This is a string but can be parsed as a double precision floating point number.
currency_codeCurrencyCode (string)
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
notesRewardRejectionNotes (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.
Possible values: <= 512 characters
offer_idEntityId (string)required
The triple-defined ID for the entity.
Possible values: non-empty and <= 100 characters
Example: triple-abc-123
rejectionRewardRejectionReason (string)
The reason this matched offer was not applied to the Transaction.
Possible values: [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]
reward_idEntityId (string)required
The triple-defined ID for the entity.
Possible values: non-empty and <= 100 characters
Example: triple-abc-123
statusRewardStatus (string)required
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.
Possible values: [REJECTED, PENDING_REVIEW, PENDING_MERCHANT_APPROVAL, DENIED_BY_MERCHANT, PENDING_MERCHANT_FUNDING, PENDING_TRANSFER_TO_PUBLISHER, DISTRIBUTED_TO_PUBLISHER, DISTRIBUTED_TO_CARDHOLDER]
]
timestampdate-timerequired
RFC 3339 date time used for creation and mod times
Example: 2021-12-01T01:59:59.000Z
transaction_typeTransactionType (string)required
The type of transaction. triple will only calculate offers based on a history of Purchases and Refunds.
Possible values: [CHECK, DEPOSIT, FEE, PAYMENT, PURCHASE, REFUND, TRANSFER, WITHDRAWAL]
Example: PURCHASE
updated_atdate-timerequired
RFC 3339 date time used for creation and mod times
Example: 2021-12-01T01:59:59.000Z

Example (auto)

{
  "amount": 12,
  "card_account_id": "triple-abc-123",
  "card_account_external_id": "id-for-entity",
  "card_bin": "444789",
  "card_last_4": "0001",
  "created_at": "2021-12-01T01:59:59.000Z",
  "currency_code": "USD",
  "debit": true,
  "description": "Pittsburgh Zoo",
  "external_id": "string",
  "id": "triple-abc-123",
  "matching_status": "HISTORIC_TRANSACTION",
  "merchant_address": {
    "city": "PITTSBURGH",
    "complete": "7370 BAKER ST, STE 100\nPITTSBURGH, PA 15206",
    "country_code": "US",
    "country_subdivision_code": "PA",
    "latitude": "40.440624",
    "longitude": "-79.995888",
    "postal_code": "15206",
    "street_address": "7370 BAKER ST, STE 100\n"
  },
  "merchant_category": {
    "code": "7998"
  },
  "processor_mid": "9000012345",
  "processor_mid_type": "VISA_VMID",
  "processor_trid": "40012345678",
  "reward_details": [
    {
      "merchant_logo_url": "https://merchant-website.com/merchant-logo.png",
      "offer_title": "string",
      "offer_reward_rate": "string",
      "offer_reward_type": "FIXED",
      "offer_reward_value": "string",
      "amount": "string",
      "currency_code": "USD",
      "notes": "string",
      "offer_id": "triple-abc-123",
      "rejection": "PURCHASE_AMOUNT_TOO_LOW",
      "reward_id": "triple-abc-123",
      "status": "REJECTED"
    }
  ],
  "timestamp": "2021-12-01T01:59:59.000Z",
  "transaction_type": "PURCHASE",
  "updated_at": "2021-12-01T01:59:59.000Z"
}

400

TripleBadRequestError

application/json

Schema

Schema

status_codeintegerrequired

The 3-digit HTTP Response Status code

Possible values: [400]

content required

The error response content.

detailsundefined[]

An array of error detail

Possible values: <= 20

error_messagestringrequired

Short description of what went wrong.

Default value: The request is malformed.

exceptionstringrequired

The exception type.

Possible values: [TripleBadRequestError]

Example (auto)

{
  "status_code": 400,
  "content": {
    "details": [
      null
    ],
    "error_message": "The request is malformed.",
    "exception": "TripleBadRequestError"
  }
}

403

TripleNotAuthenticatedError

application/json

Schema

Schema

status_codeintegerrequired

The 3-digit HTTP Response Status code

Possible values: [401]

content required

The error response content.

detailsundefined[]

An array of error detail

Possible values: <= 20

error_messagestringrequired

Short description of what went wrong.

Default value: Client authentication failed.

exceptionstringrequired

The exception type.

Possible values: [TripleNotAuthenticatedError]

Example (auto)

{
  "status_code": 401,
  "content": {
    "details": [
      null
    ],
    "error_message": "Client authentication failed.",
    "exception": "TripleNotAuthenticatedError"
  }
}

404

TripleInvalidPathError

application/json

Schema

Schema

status_codeintegerrequired

The 3-digit HTTP Response Status code

Possible values: [404]

content required

The error response content.

detailsundefined[]

An array of error detail

Possible values: <= 20

error_messagestringrequired

Short description of what went wrong.

Default value: The url path or path parameter is invalid.

exceptionstringrequired

The exception type.

Possible values: [TripleInvalidPathError]

Example (auto)

{
  "status_code": 404,
  "content": {
    "details": [
      null
    ],
    "error_message": "The url path or path parameter is invalid.",
    "exception": "TripleInvalidPathError"
  }
}

409

TripleIntegrityError

application/json

Schema

Schema

status_codeintegerrequired

The 3-digit HTTP Response Status code

Possible values: [409]

content required

The error response content.

detailsundefined[]

An array of error detail

Possible values: <= 20

error_messagestringrequired

Short description of what went wrong.

Default value: The request was well-formed but violated entity integrity constraints.

exceptionstringrequired

The exception type.

Possible values: [TripleIntegrityError]

Example (auto)

{
  "status_code": 409,
  "content": {
    "details": [
      null
    ],
    "error_message": "The request was well-formed but violated entity integrity constraints.",
    "exception": "TripleIntegrityError"
  }
}

415

TripleUnsupportedMediaType

application/json

Schema

Schema

status_codeintegerrequired

The 3-digit HTTP Response Status code

Possible values: [415]

content required

The error response content.

detailsundefined[]

An array of error detail

Possible values: <= 20

error_messagestringrequired

Short description of what went wrong.

Default value: The request defined an unsupported media type.

exceptionstringrequired

The exception type.

Possible values: [TripleUnsupportedMediaType]

Example (auto)

{
  "status_code": 415,
  "content": {
    "details": [
      null
    ],
    "error_message": "The request defined an unsupported media type.",
    "exception": "TripleUnsupportedMediaType"
  }
}

422

TripleUnprocessableEntity

application/json

Schema

Schema

status_codeintegerrequired

The 3-digit HTTP Response Status code

Possible values: [422]

content required

The error response content.

detailsundefined[]

An array of error detail

Possible values: <= 20

error_messagestringrequired

Short description of what went wrong.

Default value: The request was well-formed but could not be processed.

exceptionstringrequired

The exception type.

Possible values: [TripleUnprocessableEntity]

Example (auto)

{
  "status_code": 422,
  "content": {
    "details": [
      null
    ],
    "error_message": "The request was well-formed but could not be processed.",
    "exception": "TripleUnprocessableEntity"
  }
}

500

TripleInternalServerError

application/json

Schema

Schema

status_codeintegerrequired

The 3-digit HTTP Response Status code

Possible values: [500]

content required

The error response content.

detailsundefined[]

An array of error detail

Possible values: <= 20

error_messagestringrequired

Short description of what went wrong.

Default value: Triple was unable to process the request due to an internal error.

exceptionstringrequired

The exception type.

Possible values: [TripleInternalServerError]

Example (auto)

{
  "status_code": 500,
  "content": {
    "details": [
      null
    ],
    "error_message": "Triple was unable to process the request due to an internal error.",
    "exception": "TripleInternalServerError"
  }
}

501

TripleNotImplementedError

application/json

Schema

Schema

status_codeintegerrequired

The 3-digit HTTP Response Status code

Possible values: [501]

content required

The error response content.

detailsundefined[]

An array of error detail

Possible values: <= 20

error_messagestringrequired

Short description of what went wrong.

Default value: The request failed because it requires a feature that is not yet implemented.

exceptionstringrequired

The exception type.

Possible values: [TripleNotImplementedError]

Example (auto)

{
  "status_code": 501,
  "content": {
    "details": [
      null
    ],
    "error_message": "The request failed because it requires a feature that is not yet implemented.",
    "exception": "TripleNotImplementedError"
  }
}

503

TripleServiceUnavailable

application/json

Schema

Schema

status_codeintegerrequired

The 3-digit HTTP Response Status code

Possible values: [503]

content required

The error response content.

detailsundefined[]

An array of error detail

Possible values: <= 20

error_messagestringrequired

Short description of what went wrong.

Default value: The request failed due to a triple service interruption.

exceptionstringrequired

The exception type.

Possible values: [TripleServiceUnavailable]

Example (auto)

{
  "status_code": 503,
  "content": {
    "details": [
      null
    ],
    "error_message": "The request failed due to a triple service interruption.",
    "exception": "TripleServiceUnavailable"
  }
}

Authorization: oauth2

name: triple_authtype: oauth2scopes: api.tripleup.com/partner.publishersdescription: 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"
    }
  }
}

• python
• curl
• csharp
• go
• nodejs
• ruby
• php
• java
• powershell
• dart
• javascript
• c
• objective-c
• ocaml
• r
• swift
• kotlin
• rust

• HTTP.CLIENT
• REQUESTS

import http.client

conn = http.client.HTTPSConnection("api.tripleup.dev")
payload = ''
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer <token>'
}
conn.request("GET", "/partner/transactions/:id", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))

Request Collapse all

Base URL

https://api.tripleup.dev

Auth

Bearer Token

Parameters

id — pathrequired