Update Token Status

Update the status of a token based on card_proxy and token_guid.

Request

Security:

path Parameters

card_proxy required	string card_proxy
version required	string

Request Body schema: application/json

TokenStatusRequest

token_status required	string (TokenStatusOperation) Token status operation types Enum: "SUSPEND" "UNSUSPEND" "DELETE"
reason_code required	string (TokenStatusReasonCode) Reason codes for token lifecycle operations based on MDES specifications. Different codes are valid for different operations (SUSPEND, UNSUSPEND, DELETE). Enum: "LOST" "STOLEN" "FRAUD" "FRAUD_DEPRECATED" "FOUND" "NO_FRAUD" "ACCOUNT_CLOSED" "CONSUMER_DELETED" "OTHER"
comment	string or null <= 256 characters Optional description providing additional context for the status change
delete_from_consumer_app	boolean or null When true, indicates the token should also be deleted from the consumer's mobile app/wallet. Only applicable when token_status is DELETE. MDES Specification: true: The token will be removed only from the device/token requestor but will remain active on the MDES platform. Any historical payments (such as subscriptions) will continue to be processed but no new payments will be possible as the token will have been removed from the device/token requestor. false: The token will be deleted from both the device/token requestor and the MDES platform.
token_guid required	string <uuid> The unique identifier (GUID) for the token in the Qolo system. This is a standardized internal representation that maps to the token_unique_reference from both MDES (Mastercard) and VTS (Visa) token service providers.

Responses

200

Returns the updated token status

400

Bad request

401

Unauthorized

404

Card not found

500

Server Error

post/api/{version}/cards/{card_proxy}/tokens/status

Request samples

Payload
curl
JavaScript
Node.js

application/json

{"token_status": "SUSPEND",
"reason_code": "LOST",
"comment": "string",
"delete_from_consumer_app": true,
"token_guid": "612f310f-a8d2-401b-8e5a-ce42b43d6d85"
}

Response samples

application/json

{"token_guid": "612f310f-a8d2-401b-8e5a-ce42b43d6d85",
"card_proxy": "string",
"tsp_name": "string",
"token_unique_reference": "string",
"token_requestor_name": "string",
"token_requestor_id": "string",
"device_name": "string",
"device_type": "string",
"token_status": "ACTIVE",
"token_expiration_date": "string",
"wallet_id": "string",
"token_deleted_from_consumer_app": "string",
"provisioning_description": "string",
"token_suffix": "string",
"account_suffix": "string"
}