v1
latestSwagger 2.02026-07-14157576.8 KBUsed to suspend an active token so that it may not initiate any new transactions. All authorizations for a SUSPENDED token will be declined. Tokens may be suspended by multiple parties (suspenders) concurrently. The token status is updated from ACTIVE to SUSPENDED when the first suspender triggers a suspend action. Additional suspenders can add their suspend action to the list of suspenders. Suspenders can unsuspend only their own suspend action. All suspenders need to perform an unsuspend action to move a token from SUSPENDED to ACTIVE. The token status will only change when the last suspender has unsuspended the token. <br>For CoF tokens, the only two supported suspenders are issuer and token requestor. <br>For Apple Pay tokens, there are some differences in behavior versus the general principles. An issuer may add themselves as a suspender to a token already suspended by a cardholder, as above. However, a cardholder cannot suspend a token already suspended by the issuer. As a special case for Apple Pay, an issuer may unsuspend (override) a token already suspended by a cardholder. However, a cardholder cannot unsuspend a token already suspended by the issuer.
Request body
Example request
{
"TokenSuspendRequest": {
"AuditInfo": {
"Organization": "Solid Bank Inc",
"UserId": "A1435477",
"UserName": "John Smith"
},
"CommentText": "Cardholder reported fraudulent transactions",
"ReasonCode": "T",
"TokenUniqueReference": "DWSPMC00000000010906a349d9ca4eb1a4d53e3c90a11d9c"
}
}Response
Contains the details of the response message.
Example response
{
"TokenSuspendResponse": {
"Token": {
"CommentId": "ABC123456",
"TokenUniqueReference": "DWSPMC00000000010906a349d9ca4eb1a4d53e3c90a11d9c"
}
}
}