POST api/Activate

Used to activate a token for a digitization that has been approved and provisioned, but requires additional cardholder authentication prior to activation. If the provisioning was not completed successfully, activation cannot be accomplished using Customer Service API. It is expected that a cardholder will complete the authentication process using an issuer's call center or using an issuer-supplied mobile application, and only then should the issuer use this API to activate the token.

Request Information

URI Parameters

None.

Body Parameters

HttpRequestMessage

ActivateRequest

Name	Description	Type	Additional information
AccountPan	The Account PAN of the token to be activated. Conditional field, must be present when PaymentAppInstanceId is present. Must not be present when TokenUniqueReference is present. PAN will be minimum 9, maximum 19 digits. Example: 5412345678901234	string	None.
TokenUniqueReference	A unique reference assigned following the allocation of a token used to identify the token for the duration of its lifetime.Length - 48 characters.Conditional field, present when AccountPan and PaymentAppInstanceId are not present. Example: DWSPMC00000000010906a349d9ca4eb1a4d53e3c90a11d9c	string	None.
PaymentAppInstanceId	Identifier of the Payment App instance within a device that will be provisioned with a token. NOTE - This may contain the identifier of the Secure Element or a mobile device for some programs. Conditional field, must be present when AccountPan is present. Must not be present when TokenUniqueReference is present. 48 characters string. Example: 645b532a245e4723d7a9c4f62b24f24a24ba98e27d43e34e	string	None.
CommentText	Comment related to activating this token. Maximum length of 500. Example: Activated after confirming cardholder identity	string	None.
ReasonCode	Reason for the activation. Valid values: "A" = Cardholder successfully authenticated prior to activation. "C" = Cardholder successfully authenticated with a customer service agent prior to activation. Example: A	string	Required
AuditInfo	Audit Info - See AuditInfo Object Documentation	AuditInfo	Required

Request Formats

application/json, text/json

Sample:

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

application/xml, text/xml

Sample:

<ActivateRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MDES.CustomerService.Models">
  <AccountPan>sample string 1</AccountPan>
  <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 4</CommentText>
  <PaymentAppInstanceId>sample string 3</PaymentAppInstanceId>
  <ReasonCode>sample string 5</ReasonCode>
  <TokenUniqueReference>sample string 2</TokenUniqueReference>
</ActivateRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ActivateResponse 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>