Replace Card

Queues a request for a card replacement using the system card id as a route parameter.

Cards are created asynchronously; use Get Account Cards to find the new card.

Card Replacement Error Codes (422)

CodeDetailExpected Condition
UNEXPECTED_ERRORAn unexpected error occurred.Unhandled error from downstream card service.
NO_DATA_FOUNDThe household, member or card record was not found.Card ID not found.
HOUSEHOLD_NOT_ACTIVEYou cannot replace a card for an inactive household.Household is inactive.
MEMBER_NOT_ACTIVEYou cannot replace a card for an inactive member.Member is inactive.
CARD_TYPE_NOT_ALLOWEDThe member does not qualify for that card type.Card type not permitted.
REPLACEMENT_FEEInsufficient benefits to cover the card replacement fee.Member unsponsored, no benefit balance.
NOT_CURRENT_CARDYou cannot replace a card that is not current.Card is not the current active card.
REQUEST_TOO_SOONA replacement card has recently been requested.Cooldown period not elapsed.
CARD_ALREADY_AVAILABLEA new card is available — please activate it.New card already issued.
CARD_PENDINGA replacement is already in progress.Replacement in pending state.
ADDRESS_NOT_VALIDThe address provided is not valid for card delivery.addressId not a valid deliverable address.
CARD_REPLACEMENT_FROZENCard replacement is currently frozen.Account/card has a replacement freeze.
AUTHENTICATION_ERRORAuthentication error communicating with downstream service.Internal service-to-service auth failed.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
int64
required

The id of the card to replace.

Body Params

Request body for replacing a card.

string | null

Optional caller-supplied correlation ID. Returned in response headers and logs for end-to-end tracing.

string | null

Username or system identifier of the user performing the update. Used for audit trail.

int64

S3 internal card identifier. Populated from the {cardId} path parameter — do not set manually.

boolean

When true, validates the replacement request without committing changes.
Set to false to execute the replacement.

int64 | null

S3 internal address identifier to ship the replacement card to. If omitted, the address on file is used.

string
required
length ≥ 1

Reason code for the card replacement (e.g. Lost, Stolen, Damaged, Fraud, RiskMitigation, CardNotReceived). Required.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
string
enum
Defaults to application/json-patch+json

Generated from available request content types

Allowed:
Responses
202

Accepted

Language
Credentials
Missing 4 required scopes
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/plain
application/json
text/json