Wex Health and Benefits APIs

Sections

Theme switcher

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.

provider_aliasstring Required

The short alias identifying the issuing provider/bank of the card.

mail_datestring | null

Optional date the card was mailed.

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).

pin_request_phone_numberstring

Toll-free IVR phone number the cardholder can call to request a new PIN. Omitted when no phone number is configured for the consumer's employer card design.

allowed_actionsobject | null

Optional. Present only when include=allowed_actions is specified in the request. Omitted from the response when not requested.

Show child attributes

_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 | null
titlestring | null
statusinteger | null
detailstring | null
instancestring | null
invalid_paramsarray | null

List of invalid parameters that caused the validation error.

Max items
10

Show child attributes

errorsobject

Human-readable validation error messages keyed by field name. Each key maps to one or more error message strings.

validation_errorsobject

Field-level validation errors keyed by field name. Each key maps to one or more structured error details.

401
Object

Unauthorized. Authentication failed.

Response Attributes

typestring | null
titlestring | null
statusinteger | null
detailstring | null
instancestring | null
invalid_paramsarray | null

List of invalid parameters that caused the validation error.

Max items
10

Show child attributes

errorsobject

Human-readable validation error messages keyed by field name. Each key maps to one or more error message strings.

validation_errorsobject

Field-level validation errors keyed by field name. Each key maps to one or more structured error details.

403
Object

Forbidden. User does not have permission to update this card resource.

Response Attributes

typestring | null
titlestring | null
statusinteger | null
detailstring | null
instancestring | null
invalid_paramsarray | null

List of invalid parameters that caused the validation error.

Max items
10

Show child attributes

errorsobject

Human-readable validation error messages keyed by field name. Each key maps to one or more error message strings.

validation_errorsobject

Field-level validation errors keyed by field name. Each key maps to one or more structured error details.

404
Object

Card not found.

Response Attributes

typestring | null
titlestring | null
statusinteger | null
detailstring | null
instancestring | null
invalid_paramsarray | null

List of invalid parameters that caused the validation error.

Max items
10

Show child attributes

errorsobject

Human-readable validation error messages keyed by field name. Each key maps to one or more error message strings.

validation_errorsobject

Field-level validation errors keyed by field name. Each key maps to one or more structured error details.

default
Object

Unexpected error

Response Attributes

typestring | null
titlestring | null
statusinteger | null
detailstring | null
instancestring | null
invalid_paramsarray | null

List of invalid parameters that caused the validation error.

Max items
10

Show child attributes

errorsobject

Human-readable validation error messages keyed by field name. Each key maps to one or more error message strings.

validation_errorsobject

Field-level validation errors keyed by field name. Each key maps to one or more structured error details.

Was this section helpful?

PATCH

/

Select
1

Response

Was this section helpful?