---
title: Update a Card Account
slug: mihai-tests/update-a-card-account
createdAt: 2025-05-02T10:16:35.478Z
---
{
"id": "VBAZiC8aUIs5f6it6H6eL",
"type": "api-oas-v2",
"data": {
"method": "PATCH",
"url": "https://api.sandbox.tripleup.dev/partner/card-accounts/{cardholder_id}",
"servers": [
{
"url": "https://api.sandbox.tripleup.dev/partner/card-accounts/{cardholder_id}",
"description": "triple Sandbox"
}
],
"name": "Update a Card Account",
"description": "(Alpha - this endpoint is subject to breaking change)
\nEnroll, un-enroll, or close a Card Account.
\nCard Accounts must be enrolled at the time of a transaction and not\nclosed at the time of distribution in order to receive Rewards.
\nThe date of enrollment defaults to the current date at UTC-12. The date\nof un-enrollment defaults to the current date at UTC+12. (This is to\naccommodate the possibility of a customer's current local date being\ndifferent than the server's.)
\nA future API release will address the edge case of unenrolling and then\nre-enrolling an account within the same day.
",
"contentType": "application/json",
"request": {
"pathParameters": [
{
"kind": "required",
"name": "cardholder_id",
"type": "object",
"example": "triple-abc-123",
"description": "The triple-defined ID for the entity.",
"customType": "EntityId",
"schema": [],
"modelRef": "#/components/schemas/EntityId"
}
],
"headerParameters": [],
"queryParameters": [],
"bodyDataParameters": [
{
"kind": "optional",
"name": "body",
"type": "object",
"description": "",
"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": []
}
],
"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 PATCH \\\n --url https://api.sandbox.tripleup.dev/partner/card-accounts/{cardholder_id} \\\n --header 'accept: application/json' \\\n --header 'content-type: application/json' \\\n --data '{\n \"status\": \"ENROLLED\"\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 \"status\": \"ENROLLED\"\n});\n\nvar requestOptions = {\n method: 'PATCH',\n headers: myHeaders,\n body: raw,\n redirect: 'follow'\n};\n\nfetch(\"https://api.sandbox.tripleup.dev/partner/card-accounts/{cardholder_id}\", 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-accounts/{cardholder_id}\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Patch.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\nrequest.body = JSON.dump({\n \"status\": \"ENROLLED\"\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-accounts/{cardholder_id}\"\n\npayload = json.dumps({\n \"status\": \"ENROLLED\"\n})\nheaders = {\n 'accept': 'application/json',\n 'content-type': 'application/json'\n}\n\nresponse = requests.request(\"PATCH\", 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": "uSnoPEjx3QL2W-rBqmUUs",
"type": "paragraph",
"children": [
{
"text": "(Alpha - this endpoint is subject to breaking change)"
}
]
},
{
"id": "Hf1xA4O3TeoD4PEBHWT-g",
"type": "paragraph",
"children": [
{
"text": "Enroll, un-enroll, or close a Card Account."
}
]
},
{
"id": "Dja57fK4CcL81gjXFIdFU",
"type": "paragraph",
"children": [
{
"text": "Card Accounts must be enrolled at the time of a transaction and not\nclosed at the time of distribution in order to receive Rewards."
}
]
},
{
"id": "VED9SAzQNts3QMuMZijO-",
"type": "paragraph",
"children": [
{
"text": "The date of enrollment defaults to the current date at UTC-12. The date\nof un-enrollment defaults to the current date at UTC+12. (This is to\naccommodate the possibility of a customer's current local date being\ndifferent than the server's.)"
}
]
},
{
"id": "jXrWMvkjwMiShUZ4b2E3l",
"type": "paragraph",
"children": [
{
"text": "A future API release will address the edge case of unenrolling and then\nre-enrolling an account within the same day."
}
]
}
]
}