POST api/Update

Used to update Account PAN Mapping Information or Issuer Product Configuration ID associated to a provisioned token. To update a specific token, the API should be requested using the Token Unique Reference. To update all tokens mapped to a specific Account PAN, the API should be requested using the Account PAN. In either case, updates will only be applied to tokens in ACTIVE or SUSPENDED state, not those in IN PROGRESS or DELETED state. When updating Account PAN Mapping Information, the Account PAN, Expiration Date and Sequence Number, may be updated individually or in any combination. Only information provided will be updated. The account mapping will only update an Account PAN for a new Account PAN when they are both in the same Account Range.

Request Information

URI Parameters

None.

Body Parameters

UpdateRequest

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	None.
CurrentAccountPan	String Length 16 Current Account PAN of the token(s) to be updated. Conditional field, used for updating all tokens mapped to a single Account PAN and must not be present when TokenUniqueReference is present. Length 9 - 19 characters. Example: 5412345678901234	string	None.
CardholderId	The CardholderId assigned to the Cardholder in question, can be used instead of the PAN, if that is not available. Conditional field, used for updating all tokens mapped to a single Account PAN and must not be present when TokenUniqueReference is present. Example: 20000587525	string	None.
NewAccountPan	New Account PAN to be applied to the updated token(s) if there is in fact a new Account PAN. Optional if updating Expiration Date or PAN Sequence Number. Length 9 - 19 characters. Example: 5412345678908888	string	None.
ExpirationDate	New Account PAN expiration date. Conditional field, must not be present when IssuerProductConfigurationId is present. Optional if updating PAN mapping or PAN Sequence Number. Maximum length 4 characters. Example: 1215	string	None.
AccountPanSequenceNumber	New PAN sequence number to be applied to the updated token(s). Conditional field, must not be present when IssuerProductConfigurationId is present. Optional if updating PAN mapping or Expiration Date. Maximum length 3 characters. Example: 3	string	None.
IssuerProductConfigurationId	New product configuration ID to be applied to the updated token(s). Conditional field, must not be present if any of the following are present - NewAccountPan, ExpirationDate, AccountPanSequenceNumber. Maximum length 10 characters. Example: ANYGOLD101	string	None.
UpdateWalletProviderIndicator	Indicates whether the updated token information should be provided to the Wallet Provider. Valid values: "0" - Pass the updated information to the Wallet Provider. "1" - Do not pass the updated information to the Wallet Provider. Optional parameter.The default is 1 if not present. Example: 0	string	None.
CommentText	Comment related to the updated token(s). Maximum length 500 characters. Example: Update gold artwork	string	None.
AuditInfo	Audit Info - See AuditInfo Object Documentation	AuditInfo	Required

Request Formats

application/json, text/json

Sample:

{
  "tokenUniqueReference": "sample string 1",
  "currentAccountPan": "sample string 2",
  "cardholderId": "sample string 3",
  "newAccountPan": "sample string 4",
  "expirationDate": "sample string 5",
  "accountPanSequenceNumber": "sample string 6",
  "issuerProductConfigurationId": "sample string 7",
  "updateWalletProviderIndicator": "sample string 8",
  "commentText": "sample string 9",
  "auditInfo": {
    "userId": "sample string 1",
    "userName": "sample string 2",
    "organization": "sample string 3",
    "phone": "sample string 4"
  }
}

application/xml, text/xml

Sample:

<UpdateRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MDES.CustomerService.Models">
  <AccountPanSequenceNumber>sample string 6</AccountPanSequenceNumber>
  <AuditInfo>
    <Organization>sample string 3</Organization>
    <Phone>sample string 4</Phone>
    <UserId>sample string 1</UserId>
    <UserName>sample string 2</UserName>
  </AuditInfo>
  <CardholderId>sample string 3</CardholderId>
  <CommentText>sample string 9</CommentText>
  <CurrentAccountPan>sample string 2</CurrentAccountPan>
  <ExpirationDate>sample string 5</ExpirationDate>
  <IssuerProductConfigurationId>sample string 7</IssuerProductConfigurationId>
  <NewAccountPan>sample string 4</NewAccountPan>
  <TokenUniqueReference>sample string 1</TokenUniqueReference>
  <UpdateWalletProviderIndicator>sample string 8</UpdateWalletProviderIndicator>
</UpdateRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

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>