---
title: Get Card Account External
slug: mihai-tests/get-card-account-external
createdAt: 2025-05-02T10:16:35.477Z
---
{
"id": "mg0-J22FUCciq4EW5TFMJ",
"type": "api-oas-v2",
"data": {
"method": "POST",
"url": "https://api.sandbox.tripleup.dev/partner/card-account.by-ids",
"servers": [
{
"url": "https://api.sandbox.tripleup.dev/partner/card-account.by-ids",
"description": "triple Sandbox"
}
],
"name": "Get Card Account External",
"description": "Returns a CardAccount instance using one or more of its associated\nexternal IDs:
\n\n- external card account ID
\n- external card program ID
\n- external publisher ID
\n
\nThe receiver returns the same object as calling the /card-accounts/{id}\nendpoint with the triple card account ID if a matching CardAccount\nexists.
",
"contentType": "application/json",
"request": {
"pathParameters": [],
"headerParameters": [],
"queryParameters": [],
"bodyDataParameters": [
{
"kind": "optional",
"name": "body",
"type": "object",
"description": "",
"schema": [
{
"name": "card_account_external_id",
"kind": "required",
"type": "object",
"description": "Partner-provided, external ID for a Card Account.\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 Account within\nthe scope of its parent Card Program.\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/CardAccountExternalId",
"customType": "CardAccountExternalId",
"schema": [],
"complexType": "allOf",
"complexItems": [
{
"name": "ExternalId",
"description": "",
"modelRef": "#/components/schemas/ExternalId",
"schema": []
}
]
},
{
"name": "card_program_external_id",
"kind": "optional",
"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": "publisher_external_id",
"kind": "optional",
"type": "object",
"description": "Partner-provided, external ID for a Publisher.\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 Publisher within\nthe scope of its parent Portfolio Manager.\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/PublisherExternalId",
"customType": "PublisherExternalId",
"schema": [],
"complexType": "allOf",
"complexItems": [
{
"name": "ExternalId",
"description": "",
"modelRef": "#/components/schemas/ExternalId",
"schema": []
}
]
}
],
"isExpanded": true
}
],
"formDataParameters": [],
"oAuthParameters": []
},
"responses": [
{
"statusCode": "200",
"description": "Card Account",
"jsonExample": "",
"isExpanded": true,
"schema": [
{
"kind": "optional",
"type": "object",
"description": "",
"customType": "CardAccount",
"schema": [
{
"name": "card_program_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": "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": "string",
"description": "2-letter ISO-3166 country code",
"example": "US",
"modelRef": "#/components/schemas/CountryCode",
"customType": "CountryCode",
"schema": []
},
{
"name": "default_postal_code",
"kind": "optional",
"type": "string",
"description": "ZIP Code™, ZIP+4, or postal code",
"example": "15206",
"modelRef": "#/components/schemas/PostalCode",
"customType": "PostalCode",
"schema": []
},
{
"name": "external_id",
"kind": "required",
"type": "object",
"description": "Partner-provided, external ID for a Card Account.\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 Account within\nthe scope of its parent Card Program.\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/CardAccountExternalId",
"customType": "CardAccountExternalId",
"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": "status",
"kind": "required",
"type": "string",
"description": "- `ENROLLED` - The account is enrolled for rewards\n- `NOT_ENROLLED` - The account is not enrolled for rewards\n- `CLOSED` - The account is closed and cannot receive rewards\n",
"default": "ENROLLED",
"modelRef": "#/components/schemas/CardAccountEnrollmentStatus",
"customType": "CardAccountEnrollmentStatus",
"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": []
}
],
"modelRef": "#/components/schemas/CardAccount",
"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 POST \\\n --url https://api.sandbox.tripleup.dev/partner/card-account.by-ids \\\n --header 'accept: application/json' \\\n --header 'content-type: application/json' \\\n --data '{\n \"card_account_external_id\": {},\n \"card_program_external_id\": {},\n \"publisher_external_id\": {}\n }'"
},
{
"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 raw = JSON.stringify({\n \"card_account_external_id\": {},\n \"card_program_external_id\": {},\n \"publisher_external_id\": {}\n});\n\nvar requestOptions = {\n method: 'POST',\n headers: myHeaders,\n body: raw,\n redirect: 'follow'\n};\n\nfetch(\"https://api.sandbox.tripleup.dev/partner/card-account.by-ids\", 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-account.by-ids\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Post.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\nrequest.body = JSON.dump({\n \"card_account_external_id\": {},\n \"card_program_external_id\": {},\n \"publisher_external_id\": {}\n})\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-account.by-ids\"\n\npayload = json.dumps({\n \"card_account_external_id\": {},\n \"card_program_external_id\": {},\n \"publisher_external_id\": {}\n})\nheaders = {\n 'accept': 'application/json',\n 'content-type': 'application/json'\n}\n\nresponse = requests.request(\"POST\", url, headers=headers, data=payload)\n\nprint(response.text)\n"
}
],
"selectedLanguageId": "example-0-curl"
},
"results": {
"languages": [
{
"id": "response-0-200",
"language": "200",
"code": "// Card Account\n{\n \"card_program_id\": \"triple-abc-123\",\n \"created_at\": \"2021-12-01T01:59:59.000Z\",\n \"default_country_code\": \"US\",\n \"default_postal_code\": \"15206\",\n \"external_id\": {},\n \"id\": \"triple-abc-123\",\n \"status\": \"\",\n \"updated_at\": \"2021-12-01T01:59:59.000Z\"\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": "C3me-QiIsA4G4F7OhixVx",
"type": "paragraph",
"children": [
{
"text": "Returns a CardAccount instance using one or more of its associated\nexternal IDs:"
}
]
},
{
"id": "x5s85Im1tnuzkFvjNqKIa",
"type": "bulleted-list",
"children": [
{
"id": "YdoI1ItkP9CswvPB0ZUif",
"type": "list-item",
"children": [
{
"id": "q2BXSkBCpFEAEDqWw-8KG",
"type": "list-item-child",
"children": [
{
"text": "external card account ID"
}
]
}
]
},
{
"id": "P1xZWxnTnJq62FO6pBuVW",
"type": "list-item",
"children": [
{
"id": "W80yJL7lr8tBUBIF-tuON",
"type": "list-item-child",
"children": [
{
"text": "external card program ID"
}
]
}
]
},
{
"id": "7GuiC4U8eijTEIX46Gkkf",
"type": "list-item",
"children": [
{
"id": "JkGgafNII3NXr8YKSB3cU",
"type": "list-item-child",
"children": [
{
"text": "external publisher ID"
}
]
}
]
}
]
},
{
"id": "_8zm4jm9c7kjBVCccqktm",
"type": "paragraph",
"children": [
{
"text": "The receiver returns the same object as calling the "
},
{
"text": "/card-accounts/{id}",
"highlight": true
},
{
"text": "\nendpoint with the triple card account ID if a matching CardAccount\nexists."
}
]
}
]
}