Create a Transaction

1 min

POST

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

Important notes:

Do not submit authorizations as purchases.
The amount for a Purchase transaction should not include cashback if it was part of the transaction.
Transactions must be uploaded within 3 days of when they take place.
Triple requires below mentioned field to generate rewards on the transaction
- card_bin
- card_last_4
- processor_mid
- processor_mid_type
- merchant_address.postal_code
- merchant_address.country_subdivision_code
- merchant_category_code

Note: Triple will make every effort to match transactions with any information that is submitted. However, without the additional required fields, we make no guarantee that a transaction will be matched and/or submitted for a cardholder reward or marketing fee.

Body Parameters

bodyobject
- 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.
- card_account_external_idCardAccountExternalIdrequired
  Description
  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 (###-##-####).
  - ExternalId
- 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.
- card_program_external_idCardProgramExternalIdrequired
  Description
  Partner-provided, external ID for a Card Program. 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 Program within the scope of its parent Publisher. 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
- 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
- debitTransactionIsDebitrequired
  Description
  Whether this is a debit or credit
- descriptionTransactionDescriptionrequired
  Example
  Pittsburgh Zoo
  Description
  The transaction description, usually the merchant name
- external_idTransactionExternalIdrequired
  Description
  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.
- merchant_category_codeMerchantCategoryCode
  Example
  7998
  Description
  The 4-digit Merchant Category Code
- merchant_addressAddress
  Description
  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
    Example
    PITTSBURGH
    Description
    Municipality or city name
  - completeCompleteAddress
    Example
    7370 BAKER ST, STE 100 PITTSBURGH, PA 15206
    Description
    The complete delivery address, composed from the Address properties.
  - country_codeCountryCode
    Example
    US
    Description
    2-letter ISO-3166 country code
  - country_subdivision_codestring
    Example
    PA
    Description
    ISO-3166-2; 2-6 letter code for a country subdivision
  - latitudeLatitude
    Example
    40.440624
  - longitudeLongitude
    Example
    -79.995888
  - postal_codePostalCode
    Example
    15206
    Description
    ZIP Code™, ZIP+4, or postal code
  - street_addressstring
    Example
    7370 BAKER ST, STE 100
    Description
    Single or multi-line physical address
- processor_midProcessorMIDValue
  Example
  9000012345
  Description
  The Merchant ID (MID) value
- processor_mid_typeProcessorMIDType
  Example
  VISA_VMID
  Description
  The type of Merchant ID
- publisher_external_idPublisherExternalId
  Description
  Partner-provided, external ID for a Publisher. 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 Publisher within the scope of its parent Portfolio Manager. 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
- timestampTimestamprequired
  Example
  2021-12-01T01:59:59.000Z
  Description
  RFC 3339 date time used for creation and mod times
- transaction_typeTransactionTyperequired
  Example
  PURCHASE
  Description
  The type of transaction. triple will only calculate offers based on a history of Purchases and Refunds.

Responses

201Transaction

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.
- card_account_idEntityIdrequired
  Example
  triple-abc-123
  Description
  The triple-defined ID for the entity.
- created_atTimestamprequired
  Example
  2021-12-01T01:59:59.000Z
  Description
  RFC 3339 date time used for creation and mod times
- 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
- debitTransactionIsDebitrequired
  Description
  Whether this is a debit or credit
- descriptionTransactionDescriptionrequired
  Example
  Pittsburgh Zoo
  Description
  The transaction description, usually the merchant name
- external_idTransactionExternalIdrequired
  Description
  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.
- idEntityIdrequired
  Example
  triple-abc-123
  Description
  The triple-defined ID for the entity.
- matching_statusTransactionMatchingStatusrequired
  Description
  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.
- merchant_addressAddressrequired
  Description
  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
    Example
    PITTSBURGH
    Description
    Municipality or city name
  - completeCompleteAddress
    Example
    7370 BAKER ST, STE 100 PITTSBURGH, PA 15206
    Description
    The complete delivery address, composed from the Address properties.
  - country_codeCountryCode
    Example
    US
    Description
    2-letter ISO-3166 country code
  - country_subdivision_codestring
    Example
    PA
    Description
    ISO-3166-2; 2-6 letter code for a country subdivision
  - latitudeLatitude
    Example
    40.440624
  - longitudeLongitude
    Example
    -79.995888
  - postal_codePostalCode
    Example
    15206
    Description
    ZIP Code™, ZIP+4, or postal code
  - street_addressstring
    Example
    7370 BAKER ST, STE 100
    Description
    Single or multi-line physical address
- merchant_categoryMerchantCategory
  - codeMerchantCategoryCoderequired
    Example
    7998
    Description
    The 4-digit Merchant Category Code
  - descriptionstringrequired
    Example
    Aquariums, Dolphinariums, Seaquariums, and Zoos
    Description
    The description of the Merchant Category Code
- processor_midProcessorMIDValue
  Example
  9000012345
  Description
  The Merchant ID (MID) value
- processor_mid_typeProcessorMIDType
  Example
  VISA_VMID
  Description
  The type of Merchant ID
- reward_detailsRewardDetails
- timestampTimestamprequired
  Example
  2021-12-01T01:59:59.000Z
  Description
  RFC 3339 date time used for creation and mod times
- transaction_typeTransactionTyperequired
  Example
  PURCHASE
  Description
  The type of transaction. triple will only calculate offers based on a history of Purchases and Refunds.
- updated_atTimestamprequired
  Example
  2021-12-01T01:59:59.000Z
  Description
  RFC 3339 date time used for creation and mod times

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 POST \
     --url https://api.sandbox.tripleup.dev/partner/transactions \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '{
     "amount": 12,
     "card_account_external_id": {},
     "card_program_external_id": {},
     "currency_code": "USD",
     "debit": "",
     "description": "Pittsburgh Zoo",
     "external_id": "",
     "publisher_external_id": {},
     "timestamp": "2021-12-01T01:59:59.000Z",
     "transaction_type": "PURCHASE"
     }'

javascript

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

var raw = JSON.stringify({
   "amount": 12,
   "card_account_external_id": {},
   "card_program_external_id": {},
   "currency_code": "USD",
   "debit": "",
   "description": "Pittsburgh Zoo",
   "external_id": "",
   "publisher_external_id": {},
   "timestamp": "2021-12-01T01:59:59.000Z",
   "transaction_type": "PURCHASE"
});

var requestOptions = {
   method: 'POST',
   headers: myHeaders,
   body: raw,
   redirect: 'follow'
};

fetch("https://api.sandbox.tripleup.dev/partner/transactions", 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/transactions")

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

request = Net::HTTP::Post.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"
request.body = JSON.dump({
   "amount": 12,
   "card_account_external_id": {},
   "card_program_external_id": {},
   "currency_code": "USD",
   "debit": "",
   "description": "Pittsburgh Zoo",
   "external_id": "",
   "publisher_external_id": {},
   "timestamp": "2021-12-01T01:59:59.000Z",
   "transaction_type": "PURCHASE"
})

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

python

import requests
import json

url = "https://api.sandbox.tripleup.dev/partner/transactions"

payload = json.dumps({
   "amount": 12,
   "card_account_external_id": {},
   "card_program_external_id": {},
   "currency_code": "USD",
   "debit": "",
   "description": "Pittsburgh Zoo",
   "external_id": "",
   "publisher_external_id": {},
   "timestamp": "2021-12-01T01:59:59.000Z",
   "transaction_type": "PURCHASE"
})
headers = {
   'accept': 'application/json',
   'content-type': 'application/json'
}

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

print(response.text)

201

// Transaction
{
  "amount": {},
  "card_account_id": "triple-abc-123",
  "created_at": "2021-12-01T01:59:59.000Z",
  "currency_code": "USD",
  "debit": false,
  "description": "Pittsburgh Zoo",
  "external_id": "",
  "id": "triple-abc-123",
  "matching_status": "",
  "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",
    "description": "Aquariums, Dolphinariums, Seaquariums, and Zoos"
  },
  "processor_mid": "9000012345",
  "processor_mid_type": "VISA_VMID",
  "reward_details": [
    ""
  ],
  "timestamp": "2021-12-01T01:59:59.000Z",
  "transaction_type": "PURCHASE",
  "updated_at": "2021-12-01T01:59:59.000Z"
}

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": ""
  }
}

Important notes:

Do not submit authorizations as purchases.
The amount for a Purchase transaction should not include cashback if it was part of the transaction.
Transactions must be uploaded within 3 days of when they take place.
Triple requires below mentioned field to generate rewards on the transaction
- card_bin
- card_last_4
- processor_mid
- processor_mid_type
- merchant_address.postal_code
- merchant_address.country_subdivision_code
- merchant_category_code

Note: Triple will make every effort to match transactions with any information that is submitted. However, without the additional required fields, we make no guarantee that a transaction will be matched and/or submitted for a cardholder reward or marketing fee.