List Card Programs

1 min

GET

https://api.sandbox.tripleup.dev/partner/card-programs

Returns a list of Card Programs, optionally filtered. This list can be used to find Card Programs' ID given an external ID.

Query Parameters

publisher_external_idstring
Description
Partner-provided external ID of a Publisher. This parameter is ignored unless the client is a Portfolio Manager.
card_program_external_idstring
Description
Partner-provided external ID

Responses

200Card Programs

object
- card_programsCardProgram[]required
  - card_binsCardProgramCardBins
    Description
    The Bank Identification Numbers for cards in this Card Program. Providing these values helps triple validate Transactions during reward processing and enforce card requirements during purchases through Affiliate Offers.
  - created_atTimestamprequired
    Example
    2021-12-01T01:59:59.000Z
    Description
    RFC 3339 date time used for creation and mod times
  - default_country_codeUSDefaultedCountryCode
    Default
    US
    - CountryCode
  - default_postal_codePostalCoderequired
    Example
    15206
    Description
    ZIP Code™, ZIP+4, or postal code
  - descriptionCardProgramDescription
    Description
    Description of the 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
  - idEntityIdrequired
    Example
    triple-abc-123
    Description
    The triple-defined ID for the entity.
  - loyalty_unitCardProgramLoyaltyUnit
    Description
    The unit used to pay with loyalty. Currently only POINTS and MILES are supported.
  - loyalty_conversion_rateCardProgramLoyaltyConversionRate
    Example
    100
    Description
    The rate of loyalty units earned per reward dollar earned. For example, setting this to 100 would earn customers 100 loyalty miles for every reward dollar earned.
  - nameCardProgramNamerequired
    Description
    Display name of the Card Program
  - program_currencyCurrencyCoderequired
    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
  - publisher_idEntityIdrequired
    Example
    triple-abc-123
    Description
    The triple-defined ID for the entity.
  - updated_atTimestamprequired
    Example
    2021-12-01T01:59:59.000Z
    Description
    RFC 3339 date time used for creation and mod times
- totalnumberrequired
  Description
  The total number of card programs.

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/card-programs \
     --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/card-programs", 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/card-programs")

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/card-programs"

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

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

print(response.text)

200

// Card Programs
{
  "card_programs": [
    {
      "card_bins": [
        ""
      ],
      "created_at": "2021-12-01T01:59:59.000Z",
      "default_country_code": {},
      "default_postal_code": "15206",
      "description": "",
      "external_id": {},
      "id": "triple-abc-123",
      "loyalty_unit": "",
      "loyalty_conversion_rate": 100,
      "name": "",
      "program_currency": "USD",
      "publisher_id": "triple-abc-123",
      "updated_at": "2021-12-01T01:59:59.000Z"
    }
  ],
  "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": ""
  }
}

Returns a list of Card Programs, optionally filtered. This list can be used to find Card Programs' ID given an external ID.