Create a Card Program

1 min

POST

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

Creates a card program.

default_country_code may be set to the country associated with the card program. It defaults to US if it is not specified.

default_postal_code must be set to a postal code associated with the card program (e.g. domicile, other). The actual value is left to the discretion of the caller.

NB: The default_postal_code will be used in lieu of proximity_target if one is not specified during a CardAccount instance request for associated offers. If default_postal_code is not set for the card account, the CardProgram default_postal_code for the program will be used instead.

Body Parameters

bodyobject
- 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.
- default_country_codeUSDefaultedCountryCode
  Default
  US
  - CountryCode
- default_postal_codePostalCoderequired
  Example
  15206
  Description
  ZIP Code™, ZIP+4, or postal code
- 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
- nameCardProgramNamerequired
  Description
  Display name of the Card Program
- descriptionCardProgramDescription
  Description
  Description 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
- 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.
- 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

Responses

201Card Program

CardProgram
- 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

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/card-programs \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '{
     "default_country_code": {},
     "default_postal_code": "15206",
     "external_id": {},
     "name": "",
     "program_currency": "USD",
     "publisher_external_id": {}
     }'

javascript

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

var raw = JSON.stringify({
   "default_country_code": {},
   "default_postal_code": "15206",
   "external_id": {},
   "name": "",
   "program_currency": "USD",
   "publisher_external_id": {}
});

var requestOptions = {
   method: 'POST',
   headers: myHeaders,
   body: raw,
   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::Post.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"
request.body = JSON.dump({
   "default_country_code": {},
   "default_postal_code": "15206",
   "external_id": {},
   "name": "",
   "program_currency": "USD",
   "publisher_external_id": {}
})

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

python

import requests
import json

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

payload = json.dumps({
   "default_country_code": {},
   "default_postal_code": "15206",
   "external_id": {},
   "name": "",
   "program_currency": "USD",
   "publisher_external_id": {}
})
headers = {
   'accept': 'application/json',
   'content-type': 'application/json'
}

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

print(response.text)

201

// Card Program
{
  "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"
}

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

Creates a card program.

default_country_code may be set to the country associated with the card program. It defaults to US if it is not specified.

default_postal_code must be set to a postal code associated with the card program (e.g. domicile, other). The actual value is left to the discretion of the caller.

NB: The default_postal_code will be used in lieu of proximity_target if one is not specified during a CardAccount instance request for associated offers. If default_postal_code is not set for the card account, the CardProgram default_postal_code for the program will be used instead.