Update Card Status
Header Parameters
Authorizationstring
Path Parameters
card_idstring Required
The Globally Unique Identifier (GUID) for the card.
Body Parameters
statusstring Required
Enumeration for the possible statuses of a debit card.
reasonstring
Optional description or reason for the status change.
Max length
500
Response
200
Object
Card status updated successfully.
Response Attributes
idstring Required
Globally Unique Identifier for the card.
last_fourstring Required
The last four digits of the card number.
Pattern
^[0-9]{4}$
statusstring Required
Enumeration for the possible statuses of a debit card.
expirationstring
The card's expiration date in ISO 8601 format (YYYY-MM-DD)
card_holder_namestring Required
The name of the card holder.
providerstring Required
The issuing provider/bank of the card.
mail_datestring
Optional date the card was mailed.
Nullable:
True
consumer_idstring Required
The associated consumer identifier.
effective_datestring Required
The date when the card becomes active.
is_primaryboolean Required
Indicates if the card is primary (false for dependent).
_linksobject
Hypermedia links related to this Card resource.
Show child attributes
400
Object
Invalid request or attempt to update a read-only field.
Response Attributes
typestring
Nullable:
True
titlestring
Nullable:
True
statusinteger
Nullable:
True
detailstring
Nullable:
True
instancestring
Nullable:
True
401
Object
Unauthorized. Authentication failed.
Response Attributes
typestring
Nullable:
True
titlestring
Nullable:
True
statusinteger
Nullable:
True
detailstring
Nullable:
True
instancestring
Nullable:
True
403
Object
Forbidden. User does not have permission to update this card resource.
Response Attributes
typestring
Nullable:
True
titlestring
Nullable:
True
statusinteger
Nullable:
True
detailstring
Nullable:
True
instancestring
Nullable:
True
404
Object
Card not found.
Response Attributes
typestring
Nullable:
True
titlestring
Nullable:
True
statusinteger
Nullable:
True
detailstring
Nullable:
True
instancestring
Nullable:
True
default
Object
Unexpected error
Response Attributes
typestring
Nullable:
True
titlestring
Nullable:
True
statusinteger
Nullable:
True
detailstring
Nullable:
True
instancestring
Nullable:
True
Was this section helpful?
Response
Was this section helpful?