POST api/Suspend

Used 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. For CoF tokens, the only two supported suspenders are issuer and token requestor. 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 Information

URI Parameters

None.

Body Parameters

HttpRequestMessage

SuspendRequest

Name	Description	Type	Additional information
TokenUniqueReference	Unique reference of the token to be updated. Conditional field, used for updating a single token and not used when CurrentAccountPan is present. Length 48 characters. Example: DWSPMC00000000010906a349d9ca4eb1a4d53e3c90a11d9c	string	Required
CommentText	Comment related to the updated token(s). Maximum length 500 characters. Example: Update gold artwork	string	None.
ReasonCode	The reason for the action. Valid Suspend values: "L" - Cardholder reported token device lost. "S" - Cardholder reported token device stolen. "T" - Issue or cardholder reported fraudulent token transactions. "Z" - Other. Valid UnSuspend values: "F" - Cardholder reported token device found or not stolen. "T" - Issuer or cardholder confirmed no fraudulent token transactions. "Z" - Other. Example: T	string	None.
AuditInfo	Audit Info - See AuditInfo Object Documentation	AuditInfo	Required

Request Formats

application/json, text/json

Sample:

{
  "tokenUniqueReference": "sample string 1",
  "commentText": "sample string 2",
  "reasonCode": "sample string 3",
  "auditInfo": {
    "userId": "sample string 1",
    "userName": "sample string 2",
    "organization": "sample string 3",
    "phone": "sample string 4"
  }
}

application/xml, text/xml

Sample:

<SuspendRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MDES.CustomerService.Models">
  <AuditInfo>
    <Organization>sample string 3</Organization>
    <Phone>sample string 4</Phone>
    <UserId>sample string 1</UserId>
    <UserName>sample string 2</UserName>
  </AuditInfo>
  <CommentText>sample string 2</CommentText>
  <ReasonCode>sample string 3</ReasonCode>
  <TokenUniqueReference>sample string 1</TokenUniqueReference>
</SuspendRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

TokenResponse with Token object - Only the TokenUniqueReference and CommentId fields will be populated

TokenResponse

Name	Description	Type	Additional information
token	Token - See Token Object Documentation	Token	None.

Response Formats

application/json, text/json

Sample:

{
  "token": {
    "tokenUniqueReference": "sample string 1",
    "primaryAccountNumberUniqueReference": "sample string 2",
    "tokenSuffix": "sample string 3",
    "expirationDate": "sample string 4",
    "accountPanSequenceNumber": "sample string 5",
    "activationCodeExpirationDateTime": "sample string 6",
    "correlationId": "sample string 7",
    "currentStatusCode": "sample string 8",
    "currentStatusDescription": "sample string 9",
    "currentStatusDateTime": "sample string 10",
    "digitizationRequestDateTime": "sample string 11",
    "finalTokenizationDecision": "sample string 12",
    "lastCommentId": "sample string 13",
    "paymentAppInstanceId": "sample string 14",
    "provisioningStatusCode": "sample string 15",
    "provisioningStatusDescription": "sample string 16",
    "storageTechnology": "sample string 17",
    "suspender": [
      {
        "suspendedBy": "sample string 1"
      },
      {
        "suspendedBy": "sample string 1"
      }
    ],
    "tokenActivatedDateTime": "sample string 18",
    "tokenAssuranceLevel": "sample string 19",
    "tokenRequestorId": "sample string 20",
    "tokenRequestorName": "sample string 21",
    "tokenType": "sample string 22",
    "walletId": "sample string 23",
    "devices": [
      {
        "deviceId": "sample string 1",
        "deviceName": "sample string 2",
        "deviceType": "sample string 3",
        "secureElementId": "sample string 4"
      },
      {
        "deviceId": "sample string 1",
        "deviceName": "sample string 2",
        "deviceType": "sample string 3",
        "secureElementId": "sample string 4"
      }
    ],
    "tokenDeletedFromConsumerApp": "sample string 24",
    "tokenRequestorConsumerFacingEntityName": "sample string 25"
  }
}

application/xml, text/xml

Sample:

<TokenResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MDES.CustomerService.Models">
  <token>
    <AccountPanSequenceNumber>sample string 5</AccountPanSequenceNumber>
    <ActivationCodeExpirationDateTime>sample string 6</ActivationCodeExpirationDateTime>
    <CorrelationId>sample string 7</CorrelationId>
    <CurrentStatusCode>sample string 8</CurrentStatusCode>
    <CurrentStatusDateTime>sample string 10</CurrentStatusDateTime>
    <CurrentStatusDescription>sample string 9</CurrentStatusDescription>
    <Devices>
      <Device>
        <DeviceId>sample string 1</DeviceId>
        <DeviceName>sample string 2</DeviceName>
        <DeviceType>sample string 3</DeviceType>
        <SecureElementId>sample string 4</SecureElementId>
      </Device>
      <Device>
        <DeviceId>sample string 1</DeviceId>
        <DeviceName>sample string 2</DeviceName>
        <DeviceType>sample string 3</DeviceType>
        <SecureElementId>sample string 4</SecureElementId>
      </Device>
    </Devices>
    <DigitizationRequestDateTime>sample string 11</DigitizationRequestDateTime>
    <ExpirationDate>sample string 4</ExpirationDate>
    <FinalTokenizationDecision>sample string 12</FinalTokenizationDecision>
    <LastCommentId>sample string 13</LastCommentId>
    <PaymentAppInstanceId>sample string 14</PaymentAppInstanceId>
    <PrimaryAccountNumberUniqueReference>sample string 2</PrimaryAccountNumberUniqueReference>
    <ProvisioningStatusCode>sample string 15</ProvisioningStatusCode>
    <ProvisioningStatusDescription>sample string 16</ProvisioningStatusDescription>
    <StorageTechnology>sample string 17</StorageTechnology>
    <Suspender>
      <Suspender>
        <SuspendedBy>sample string 1</SuspendedBy>
      </Suspender>
      <Suspender>
        <SuspendedBy>sample string 1</SuspendedBy>
      </Suspender>
    </Suspender>
    <TokenActivatedDateTime>sample string 18</TokenActivatedDateTime>
    <TokenAssuranceLevel>sample string 19</TokenAssuranceLevel>
    <TokenDeletedFromConsumerApp>sample string 24</TokenDeletedFromConsumerApp>
    <TokenRequestorConsumerFacingEntityName>sample string 25</TokenRequestorConsumerFacingEntityName>
    <TokenRequestorId>sample string 20</TokenRequestorId>
    <TokenRequestorName>sample string 21</TokenRequestorName>
    <TokenSuffix>sample string 3</TokenSuffix>
    <TokenType>sample string 22</TokenType>
    <TokenUniqueReference>sample string 1</TokenUniqueReference>
    <WalletId>sample string 23</WalletId>
  </token>
</TokenResponse>