---
title: List Card Programs
slug: mihai-tests/list-card-programs
createdAt: 2025-05-02T10:16:35.482Z
---
{
"id": "x1rn_lEWJQu5kiEy_EILL",
"type": "api-oas-v2",
"data": {
"method": "GET",
"url": "https://api.sandbox.tripleup.dev/partner/card-programs",
"servers": [
{
"url": "https://api.sandbox.tripleup.dev/partner/card-programs",
"description": "triple Sandbox"
}
],
"name": "List Card Programs",
"description": "Returns a list of Card Programs, optionally filtered.\nThis list can be used to find Card Programs' ID given an external ID.
",
"contentType": "application/json",
"request": {
"pathParameters": [],
"headerParameters": [],
"queryParameters": [
{
"kind": "optional",
"name": "publisher_external_id",
"type": "string",
"description": "Partner-provided external ID of a Publisher. This parameter is ignored unless the client is a Portfolio Manager.
"
},
{
"kind": "optional",
"name": "card_program_external_id",
"type": "string",
"description": "Partner-provided external ID
"
}
],
"bodyDataParameters": [],
"formDataParameters": [],
"oAuthParameters": []
},
"responses": [
{
"statusCode": "200",
"description": "Card Programs",
"jsonExample": "",
"isExpanded": true,
"schema": [
{
"kind": "optional",
"type": "object",
"description": "",
"schema": [
{
"name": "card_programs",
"kind": "required",
"type": "array",
"description": "",
"modelRef": "#/components/schemas/CardProgram",
"customType": "CardProgram[]",
"schema": [
{
"name": "card_bins",
"kind": "optional",
"type": "array",
"description": "The Bank Identification Numbers for cards in this Card Program.\n\nProviding these values helps triple validate Transactions during\nreward processing and enforce card requirements during purchases\nthrough Affiliate Offers.\n",
"modelRef": "#/components/schemas/CardProgramCardBins",
"customType": "CardProgramCardBins",
"schema": []
},
{
"name": "created_at",
"kind": "required",
"type": "string",
"description": "RFC 3339 date time used for creation and mod times",
"example": "2021-12-01T01:59:59.000Z",
"modelRef": "#/components/schemas/Timestamp",
"customType": "Timestamp",
"schema": []
},
{
"name": "default_country_code",
"kind": "optional",
"type": "object",
"description": "",
"default": "US",
"modelRef": "#/components/schemas/USDefaultedCountryCode",
"customType": "USDefaultedCountryCode",
"schema": [],
"complexType": "allOf",
"complexItems": [
{
"name": "CountryCode",
"description": "",
"modelRef": "#/components/schemas/CountryCode",
"schema": []
}
]
},
{
"name": "default_postal_code",
"kind": "required",
"type": "string",
"description": "ZIP Code™, ZIP+4, or postal code",
"example": "15206",
"modelRef": "#/components/schemas/PostalCode",
"customType": "PostalCode",
"schema": []
},
{
"name": "description",
"kind": "optional",
"type": "string",
"description": "Description of the Card Program",
"modelRef": "#/components/schemas/CardProgramDescription",
"customType": "CardProgramDescription",
"schema": []
},
{
"name": "external_id",
"kind": "required",
"type": "object",
"description": "Partner-provided, external ID for a Card Program.\n\nExternal IDs should be **stable** and **never sensitive**.\n\nExternal IDs do not need to be globally unique, but we encourage\nthe use of UUIDs. They must be unique for the Card Program within\nthe scope of its parent Publisher.\n\nTo protect against accidental inclusion of sensitive personal\ninformation, external IDs may not be 9-digit numbers or use the\nUS Tax ID format (###-##-####).\n",
"modelRef": "#/components/schemas/CardProgramExternalId",
"customType": "CardProgramExternalId",
"schema": [],
"complexType": "allOf",
"complexItems": [
{
"name": "ExternalId",
"description": "",
"modelRef": "#/components/schemas/ExternalId",
"schema": []
}
]
},
{
"name": "id",
"kind": "required",
"type": "string",
"description": "The triple-defined ID for the entity.",
"example": "triple-abc-123",
"modelRef": "#/components/schemas/EntityId",
"customType": "EntityId",
"schema": []
},
{
"name": "loyalty_unit",
"kind": "optional",
"type": "string",
"description": "The unit used to pay with loyalty. Currently only POINTS and MILES are supported.\n",
"modelRef": "#/components/schemas/CardProgramLoyaltyUnit",
"customType": "CardProgramLoyaltyUnit",
"schema": []
},
{
"name": "loyalty_conversion_rate",
"kind": "optional",
"type": "number",
"description": "The rate of loyalty units earned per reward dollar earned.\n\nFor example, setting this to 100 would earn customers 100 loyalty miles\nfor every reward dollar earned.\n",
"example": 100,
"modelRef": "#/components/schemas/CardProgramLoyaltyConversionRate",
"customType": "CardProgramLoyaltyConversionRate",
"schema": []
},
{
"name": "name",
"kind": "required",
"type": "string",
"description": "Display name of the Card Program",
"modelRef": "#/components/schemas/CardProgramName",
"customType": "CardProgramName",
"schema": []
},
{
"name": "program_currency",
"kind": "required",
"type": "string",
"description": "3-character ISO-4217 currency code. Only USD is currently supported.\n\nContact your Triple representative for support with additional\ncurrencies. Note that some values are not supported, particularly\ntest and fund codes.\n",
"example": "USD",
"default": "USD",
"modelRef": "#/components/schemas/CurrencyCode",
"customType": "CurrencyCode",
"schema": []
},
{
"name": "publisher_id",
"kind": "required",
"type": "string",
"description": "The triple-defined ID for the entity.",
"example": "triple-abc-123",
"modelRef": "#/components/schemas/EntityId",
"customType": "EntityId",
"schema": []
},
{
"name": "updated_at",
"kind": "required",
"type": "string",
"description": "RFC 3339 date time used for creation and mod times",
"example": "2021-12-01T01:59:59.000Z",
"modelRef": "#/components/schemas/Timestamp",
"customType": "Timestamp",
"schema": []
}
]
},
{
"name": "total",
"kind": "required",
"type": "number",
"description": "The total number of card programs.",
"example": ""
}
],
"isExpanded": true
}
]
},
{
"statusCode": "400",
"description": "TripleBadRequestError",
"jsonExample": "",
"isExpanded": true,
"schema": [
{
"kind": "optional",
"type": "object",
"description": "",
"schema": [
{
"name": "status_code",
"kind": "required",
"type": "integer",
"description": "The 3-digit HTTP Response Status code",
"example": 0
},
{
"name": "content",
"kind": "required",
"type": "object",
"description": "The error response content.",
"example": "",
"schema": [
{
"name": "details",
"kind": "optional",
"type": "array",
"description": "An array of error detail",
"modelRef": "#/components/schemas/ErrorResponseDetails",
"customType": "ErrorResponseDetails",
"schema": []
},
{
"name": "error_message",
"kind": "required",
"type": "string",
"description": "Short description of what went wrong.",
"example": "",
"default": "The request is malformed."
},
{
"name": "exception",
"kind": "required",
"type": "string",
"description": "The exception type.",
"example": ""
}
]
}
],
"isExpanded": true
}
]
},
{
"statusCode": "403",
"description": "TripleNotAuthenticatedError",
"jsonExample": "",
"isExpanded": true,
"schema": [
{
"kind": "optional",
"type": "object",
"description": "",
"schema": [
{
"name": "status_code",
"kind": "required",
"type": "integer",
"description": "The 3-digit HTTP Response Status code",
"example": 0
},
{
"name": "content",
"kind": "required",
"type": "object",
"description": "The error response content.",
"example": "",
"schema": [
{
"name": "details",
"kind": "optional",
"type": "array",
"description": "An array of error detail",
"modelRef": "#/components/schemas/ErrorResponseDetails",
"customType": "ErrorResponseDetails",
"schema": []
},
{
"name": "error_message",
"kind": "required",
"type": "string",
"description": "Short description of what went wrong.",
"example": "",
"default": "Client authentication failed."
},
{
"name": "exception",
"kind": "required",
"type": "string",
"description": "The exception type.",
"example": ""
}
]
}
],
"isExpanded": true
}
]
},
{
"statusCode": "404",
"description": "TripleInvalidPathError",
"jsonExample": "",
"isExpanded": true,
"schema": [
{
"kind": "optional",
"type": "object",
"description": "",
"schema": [
{
"name": "status_code",
"kind": "required",
"type": "integer",
"description": "The 3-digit HTTP Response Status code",
"example": 0
},
{
"name": "content",
"kind": "required",
"type": "object",
"description": "The error response content.",
"example": "",
"schema": [
{
"name": "details",
"kind": "optional",
"type": "array",
"description": "An array of error detail",
"modelRef": "#/components/schemas/ErrorResponseDetails",
"customType": "ErrorResponseDetails",
"schema": []
},
{
"name": "error_message",
"kind": "required",
"type": "string",
"description": "Short description of what went wrong.",
"example": "",
"default": "The url path or path parameter is invalid."
},
{
"name": "exception",
"kind": "required",
"type": "string",
"description": "The exception type.",
"example": ""
}
]
}
],
"isExpanded": true
}
]
},
{
"statusCode": "409",
"description": "TripleIntegrityError",
"jsonExample": "",
"isExpanded": true,
"schema": [
{
"kind": "optional",
"type": "object",
"description": "",
"schema": [
{
"name": "status_code",
"kind": "required",
"type": "integer",
"description": "The 3-digit HTTP Response Status code",
"example": 0
},
{
"name": "content",
"kind": "required",
"type": "object",
"description": "The error response content.",
"example": "",
"schema": [
{
"name": "details",
"kind": "optional",
"type": "array",
"description": "An array of error detail",
"modelRef": "#/components/schemas/ErrorResponseDetails",
"customType": "ErrorResponseDetails",
"schema": []
},
{
"name": "error_message",
"kind": "required",
"type": "string",
"description": "Short description of what went wrong.",
"example": "",
"default": "The request was well-formed but violated entity integrity constraints."
},
{
"name": "exception",
"kind": "required",
"type": "string",
"description": "The exception type.",
"example": ""
}
]
}
],
"isExpanded": true
}
]
},
{
"statusCode": "415",
"description": "TripleUnsupportedMediaType",
"jsonExample": "",
"isExpanded": true,
"schema": [
{
"kind": "optional",
"type": "object",
"description": "",
"schema": [
{
"name": "status_code",
"kind": "required",
"type": "integer",
"description": "The 3-digit HTTP Response Status code",
"example": 0
},
{
"name": "content",
"kind": "required",
"type": "object",
"description": "The error response content.",
"example": "",
"schema": [
{
"name": "details",
"kind": "optional",
"type": "array",
"description": "An array of error detail",
"modelRef": "#/components/schemas/ErrorResponseDetails",
"customType": "ErrorResponseDetails",
"schema": []
},
{
"name": "error_message",
"kind": "required",
"type": "string",
"description": "Short description of what went wrong.",
"example": "",
"default": "The request defined an unsupported media type."
},
{
"name": "exception",
"kind": "required",
"type": "string",
"description": "The exception type.",
"example": ""
}
]
}
],
"isExpanded": true
}
]
},
{
"statusCode": "422",
"description": "TripleUnprocessableEntity",
"jsonExample": "",
"isExpanded": true,
"schema": [
{
"kind": "optional",
"type": "object",
"description": "",
"schema": [
{
"name": "status_code",
"kind": "required",
"type": "integer",
"description": "The 3-digit HTTP Response Status code",
"example": 0
},
{
"name": "content",
"kind": "required",
"type": "object",
"description": "The error response content.",
"example": "",
"schema": [
{
"name": "details",
"kind": "optional",
"type": "array",
"description": "An array of error detail",
"modelRef": "#/components/schemas/ErrorResponseDetails",
"customType": "ErrorResponseDetails",
"schema": []
},
{
"name": "error_message",
"kind": "required",
"type": "string",
"description": "Short description of what went wrong.",
"example": "",
"default": "The request was well-formed but could not be processed."
},
{
"name": "exception",
"kind": "required",
"type": "string",
"description": "The exception type.",
"example": ""
}
]
}
],
"isExpanded": true
}
]
},
{
"statusCode": "500",
"description": "TripleInternalServerError",
"jsonExample": "",
"isExpanded": true,
"schema": [
{
"kind": "optional",
"type": "object",
"description": "",
"schema": [
{
"name": "status_code",
"kind": "required",
"type": "integer",
"description": "The 3-digit HTTP Response Status code",
"example": 0
},
{
"name": "content",
"kind": "required",
"type": "object",
"description": "The error response content.",
"example": "",
"schema": [
{
"name": "details",
"kind": "optional",
"type": "array",
"description": "An array of error detail",
"modelRef": "#/components/schemas/ErrorResponseDetails",
"customType": "ErrorResponseDetails",
"schema": []
},
{
"name": "error_message",
"kind": "required",
"type": "string",
"description": "Short description of what went wrong.",
"example": "",
"default": "Triple was unable to process the request due to an internal error."
},
{
"name": "exception",
"kind": "required",
"type": "string",
"description": "The exception type.",
"example": ""
}
]
}
],
"isExpanded": true
}
]
},
{
"statusCode": "501",
"description": "TripleNotImplementedError",
"jsonExample": "",
"isExpanded": true,
"schema": [
{
"kind": "optional",
"type": "object",
"description": "",
"schema": [
{
"name": "status_code",
"kind": "required",
"type": "integer",
"description": "The 3-digit HTTP Response Status code",
"example": 0
},
{
"name": "content",
"kind": "required",
"type": "object",
"description": "The error response content.",
"example": "",
"schema": [
{
"name": "details",
"kind": "optional",
"type": "array",
"description": "An array of error detail",
"modelRef": "#/components/schemas/ErrorResponseDetails",
"customType": "ErrorResponseDetails",
"schema": []
},
{
"name": "error_message",
"kind": "required",
"type": "string",
"description": "Short description of what went wrong.",
"example": "",
"default": "The request failed because it requires a feature that is not yet implemented."
},
{
"name": "exception",
"kind": "required",
"type": "string",
"description": "The exception type.",
"example": ""
}
]
}
],
"isExpanded": true
}
]
},
{
"statusCode": "503",
"description": "TripleServiceUnavailable",
"jsonExample": "",
"isExpanded": true,
"schema": [
{
"kind": "optional",
"type": "object",
"description": "",
"schema": [
{
"name": "status_code",
"kind": "required",
"type": "integer",
"description": "The 3-digit HTTP Response Status code",
"example": 0
},
{
"name": "content",
"kind": "required",
"type": "object",
"description": "The error response content.",
"example": "",
"schema": [
{
"name": "details",
"kind": "optional",
"type": "array",
"description": "An array of error detail",
"modelRef": "#/components/schemas/ErrorResponseDetails",
"customType": "ErrorResponseDetails",
"schema": []
},
{
"name": "error_message",
"kind": "required",
"type": "string",
"description": "Short description of what went wrong.",
"example": "",
"default": "The request failed due to a triple service interruption."
},
{
"name": "exception",
"kind": "required",
"type": "string",
"description": "The exception type.",
"example": ""
}
]
}
],
"isExpanded": true
}
]
}
],
"hasXCodeSamples": false,
"examples": {
"languages": [
{
"id": "example-0-curl",
"language": "curl",
"label": "cURL",
"code": "curl --request GET \\\n --url https://api.sandbox.tripleup.dev/partner/card-programs \\\n --header 'accept: application/json'"
},
{
"id": "example-1-javascript",
"language": "javascript",
"label": "javascript",
"code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\n\nvar requestOptions = {\n method: 'GET',\n headers: myHeaders,\n redirect: 'follow'\n};\n\nfetch(\"https://api.sandbox.tripleup.dev/partner/card-programs\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));"
},
{
"id": "example-2-ruby",
"language": "ruby",
"label": "Ruby",
"code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.sandbox.tripleup.dev/partner/card-programs\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Get.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\n\nresponse = https.request(request)\nputs response.read_body\n"
},
{
"id": "example-3-python",
"language": "python",
"label": "Python",
"code": "import requests\nimport json\n\nurl = \"https://api.sandbox.tripleup.dev/partner/card-programs\"\n\npayload = {}\nheaders = {\n 'accept': 'application/json',\n 'content-type': 'application/json'\n}\n\nresponse = requests.request(\"GET\", url, headers=headers, data=payload)\n\nprint(response.text)\n"
}
],
"selectedLanguageId": "example-0-curl"
},
"results": {
"languages": [
{
"id": "response-0-200",
"language": "200",
"code": "// Card Programs\n{\n \"card_programs\": [\n {\n \"card_bins\": [\n \"\"\n ],\n \"created_at\": \"2021-12-01T01:59:59.000Z\",\n \"default_country_code\": {},\n \"default_postal_code\": \"15206\",\n \"description\": \"\",\n \"external_id\": {},\n \"id\": \"triple-abc-123\",\n \"loyalty_unit\": \"\",\n \"loyalty_conversion_rate\": 100,\n \"name\": \"\",\n \"program_currency\": \"USD\",\n \"publisher_id\": \"triple-abc-123\",\n \"updated_at\": \"2021-12-01T01:59:59.000Z\"\n }\n ],\n \"total\": 0\n}"
},
{
"id": "response-1-400",
"language": "400",
"code": "// TripleBadRequestError\n{\n \"status_code\": 0,\n \"content\": {\n \"details\": [\n \"\"\n ],\n \"error_message\": \"\",\n \"exception\": \"\"\n }\n}"
},
{
"id": "response-2-403",
"language": "403",
"code": "// TripleNotAuthenticatedError\n{\n \"status_code\": 0,\n \"content\": {\n \"details\": [\n \"\"\n ],\n \"error_message\": \"\",\n \"exception\": \"\"\n }\n}"
},
{
"id": "response-3-404",
"language": "404",
"code": "// TripleInvalidPathError\n{\n \"status_code\": 0,\n \"content\": {\n \"details\": [\n \"\"\n ],\n \"error_message\": \"\",\n \"exception\": \"\"\n }\n}"
},
{
"id": "response-4-409",
"language": "409",
"code": "// TripleIntegrityError\n{\n \"status_code\": 0,\n \"content\": {\n \"details\": [\n \"\"\n ],\n \"error_message\": \"\",\n \"exception\": \"\"\n }\n}"
},
{
"id": "response-5-415",
"language": "415",
"code": "// TripleUnsupportedMediaType\n{\n \"status_code\": 0,\n \"content\": {\n \"details\": [\n \"\"\n ],\n \"error_message\": \"\",\n \"exception\": \"\"\n }\n}"
},
{
"id": "response-6-422",
"language": "422",
"code": "// TripleUnprocessableEntity\n{\n \"status_code\": 0,\n \"content\": {\n \"details\": [\n \"\"\n ],\n \"error_message\": \"\",\n \"exception\": \"\"\n }\n}"
},
{
"id": "response-7-500",
"language": "500",
"code": "// TripleInternalServerError\n{\n \"status_code\": 0,\n \"content\": {\n \"details\": [\n \"\"\n ],\n \"error_message\": \"\",\n \"exception\": \"\"\n }\n}"
},
{
"id": "response-8-501",
"language": "501",
"code": "// TripleNotImplementedError\n{\n \"status_code\": 0,\n \"content\": {\n \"details\": [\n \"\"\n ],\n \"error_message\": \"\",\n \"exception\": \"\"\n }\n}"
},
{
"id": "response-9-503",
"language": "503",
"code": "// TripleServiceUnavailable\n{\n \"status_code\": 0,\n \"content\": {\n \"details\": [\n \"\"\n ],\n \"error_message\": \"\",\n \"exception\": \"\"\n }\n}"
}
],
"selectedLanguageId": "response-0-200"
}
},
"children": [
{
"id": "_1htjjch8udKd8HtA0u8n",
"type": "paragraph",
"children": [
{
"text": "Returns a list of Card Programs, optionally filtered.\nThis list can be used to find Card Programs' ID given an external ID."
}
]
}
]
}