Skip to main content

Update a digital wallet token’s state

POST /v2/cards/{cardId}/digital-wallet-token-transitions

Request

Use this endpoint to update a digital wallet token’s state.
You can’t update a digital wallet token that has the REQUEST_DECLINED or TERMINATED state, as these are final states. Instead, you should create a new digital wallet token for that card.

Path parameters

string (uuid)
required
The ID of the card to work with.Allowable values: An existing cardId (≤ 36 characters)

Query parameters

string
required
The ID of the account that the card is associated with.Allowable values: An existing accountId
string (uuid)
The ID of the person that the card belongs to.Allowable values: An existing personId (≤ 36 characters)

Request body schema

string (enum)
required
The state that you want to update the digital wallet token to. The original state is REQUESTED. You can’t update the state if its current value is either REQUEST_DECLINED or TERMINATED.Allowable values: ACTIVE, SUSPENDED, TERMINATED
string (uuid)
required
The digital wallet token that you want to update the state for.Allowable values: An existing digitalWalletToken (≤ 36)

Response

If your request is successful, you’ll receive a 201 response. If you’ve subscribed to webhooks, you’ll also receive a DigitalWalletTokenTransition webhook.
For more detailed information about this request and its response, see the API reference.