{
"id": "card_xyz123",
"client_card_id": "<string>",
"account_id": "account_xyz123",
"entity_id": "entity_xyz123",
"status": "active",
"status_reason": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"details": {
"card_product_name": "<string>",
"is_virtual": true,
"card_type": "hsa",
"expiry_date": "2023-12-25",
"last_four": "1234",
"replacement_for": "card_xyz123",
"closed_at": "2023-11-07T05:31:56Z"
},
"metadata": {}
}{
"code": "<string>",
"title": "<string>",
"detail": "<string>",
"status": "<string>",
"invalid_parameters": [
{
"parameter": "transaction_type",
"reason": "<string>"
}
],
"instance": "<string>"
}{
"code": "<string>",
"title": "<string>",
"detail": "<string>",
"status": "<string>",
"invalid_parameters": [
{
"parameter": "transaction_type",
"reason": "<string>"
}
],
"instance": "<string>"
}{
"code": "<string>",
"title": "<string>",
"detail": "<string>",
"status": "<string>",
"invalid_parameters": [
{
"parameter": "transaction_type",
"reason": "<string>"
}
],
"instance": "<string>"
}{
"code": "<string>",
"title": "<string>",
"detail": "<string>",
"status": "<string>",
"invalid_parameters": [
{
"parameter": "transaction_type",
"reason": "<string>"
}
],
"instance": "<string>"
}{
"code": "idempotency_request_inconsistent",
"title": "The request made does not match the previous request made with this idempotency key.",
"detail": "If you are trying to make a new request, then please update the idempotency key; otherwise, please use the same request body to make this request.",
"invalid_parameters": []
}{
"code": "rate_limit_exceeded",
"title": "You've reached the rate limit for this call.",
"detail": "If you are continuously hitting rate limits please contact the Lead team.",
"invalid_parameters": []
}{
"code": "<string>",
"title": "<string>",
"detail": "<string>",
"status": "<string>",
"invalid_parameters": [
{
"parameter": "transaction_type",
"reason": "<string>"
}
],
"instance": "<string>"
}Update a Card
Beta: This endpoint is in beta and may change before general availability.
Updates mutable attributes of a card. This is a partial update: only the
fields present in the request body are changed; omitted fields are left
unchanged. Card status is system-managed and changes through the
status-transition endpoints, not this endpoint.
Idempotency
The Idempotency-Key header is required. Reusing a key with a different request body will return a 422 error.
{
"id": "card_xyz123",
"client_card_id": "<string>",
"account_id": "account_xyz123",
"entity_id": "entity_xyz123",
"status": "active",
"status_reason": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"details": {
"card_product_name": "<string>",
"is_virtual": true,
"card_type": "hsa",
"expiry_date": "2023-12-25",
"last_four": "1234",
"replacement_for": "card_xyz123",
"closed_at": "2023-11-07T05:31:56Z"
},
"metadata": {}
}{
"code": "<string>",
"title": "<string>",
"detail": "<string>",
"status": "<string>",
"invalid_parameters": [
{
"parameter": "transaction_type",
"reason": "<string>"
}
],
"instance": "<string>"
}{
"code": "<string>",
"title": "<string>",
"detail": "<string>",
"status": "<string>",
"invalid_parameters": [
{
"parameter": "transaction_type",
"reason": "<string>"
}
],
"instance": "<string>"
}{
"code": "<string>",
"title": "<string>",
"detail": "<string>",
"status": "<string>",
"invalid_parameters": [
{
"parameter": "transaction_type",
"reason": "<string>"
}
],
"instance": "<string>"
}{
"code": "<string>",
"title": "<string>",
"detail": "<string>",
"status": "<string>",
"invalid_parameters": [
{
"parameter": "transaction_type",
"reason": "<string>"
}
],
"instance": "<string>"
}{
"code": "idempotency_request_inconsistent",
"title": "The request made does not match the previous request made with this idempotency key.",
"detail": "If you are trying to make a new request, then please update the idempotency key; otherwise, please use the same request body to make this request.",
"invalid_parameters": []
}{
"code": "rate_limit_exceeded",
"title": "You've reached the rate limit for this call.",
"detail": "If you are continuously hitting rate limits please contact the Lead team.",
"invalid_parameters": []
}{
"code": "<string>",
"title": "<string>",
"detail": "<string>",
"status": "<string>",
"invalid_parameters": [
{
"parameter": "transaction_type",
"reason": "<string>"
}
],
"instance": "<string>"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
Unique key to ensure idempotent requests
255Path Parameters
The server-generated Card ID (card_*). Unlike retrieve, this endpoint
accepts only the server-generated ID, not a client_card_id.
The server-generated ID of the Card object.
^card_\w+$"card_xyz123"
Body
Request body for updating a card. This is a partial update: every field is
optional and only the fields present are changed. Card status is
system-managed (see the status-transition endpoints) and cannot be set here.
The mutable subset of a card's details. Only the fields present are updated; physical attributes (card_type, last_four, is_virtual) and expiry_date are immutable and cannot be changed through this endpoint.
Show child attributes
Show child attributes
A set of key-value pairs that can be used to store additional information related to this object.
Show child attributes
Show child attributes
Response
Card updated successfully.
A card object
The server-generated ID of the Card object.
^card_\w+$"card_xyz123"
Client-provided identifier for the card. Optional: present only for cards created via file upload, and omitted for cards created through the API, which are identified solely by their server-generated ID.
The ID of the Account object.
^account_\w+$"account_xyz123"
The ID of your entity.
^entity_[^\s]{1,33}$"entity_xyz123"
Status is system-managed and cannot be set on create; status changes go through the status-transition endpoints.
active, inactive, closed The reason for the card's current status. Empty when the card is active; otherwise
populated. Set via the status-transition endpoints.
Creation timestamp.
Last update timestamp.
Physical and product attributes of the card.
Show child attributes
Show child attributes
A set of key-value pairs that can be used to store additional information related to this object.
Show child attributes
Show child attributes
Was this page helpful?

