Update a digital wallet token's state beta

Updates the state of a digital wallet token.

The possible states are:

  • "REQUESTED"
  • "REQUEST_DECLINED"
  • "ACTIVE"
  • "TERMINATED"
  • "SUSPENDED"
SecurityCommonAuth
Request
path Parameters
cardId
required
string <uuid> <= 36 characters

The ID of the card to work with.

Example: e9293471-5eb3-4dbc-916c-dbaf9e2deefd
query Parameters
accountId
required
string

The ID of the account to work with.

Example: accountId=F50091
personId
string <uuid> <= 36 characters

The ID of the person to work with.

Example: personId=775596ae-2624-40af-a9dc-9756110a4a04
Request Body schema: application/json

Body

state
required
string

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.

Enum: "ACTIVE" "SUSPENDED" "TERMINATED"
digitalWalletToken
required
string <uuid>

The digital wallet token that you want to update the state of.

Responses
201

Created

post/cards/{cardId}/digital-wallet-token-transitions
Request samples
application/json
{
  • "state": "ACTIVE",
  • "digitalWalletToken": "9d3dee7c-19df-4b71-bbb9-521bb04307bf"
}
Response samples
application/json
{
  • "state": "ACTIVE",
  • "digitalWalletToken": "9d3dee7c-19df-4b71-bbb9-521bb04307bf",
  • "fulfillmentStatus": "PROVISIONED"
}