POST api/Search

Provides the ability to search for tokens based on Account PAN, Alternate Account,Identifier, Token Unique Reference, Token, Payment App Instance Id or Comment Id. Returns all of the tokens associated with an account according to the scope of the indicated search request criteria. The response includes key state and informational data for each token, including the Token Unique Reference which is needed for subsequent token lifecycle management activities. Note - The Search API request must include only one of the available search methods Account PAN, Token Unique Reference, Token, Payment App Instance Id, Comment Id, or Alternate Account Identifier.They cannot be used together in a single request.

Request Information

URI Parameters

None.

Body Parameters

SearchRequest

Name	Description	Type	Additional information
CHID	When present, the search will return tokens for the Account matching this Cardholder ID (CHID), for any Wallet Provider or device. PAN will be minimum 9 digits and maximum 19 digits. Cannot be used together with any of the following search request parameters: AccountPan, TokenUniqueReference, Token, PaymentAppInstanceId, CommentId, or AlternateAccountIdentifier. Example: 20015415412	string	None.
AccountPan	When present, the search will return tokens for the Account matching this Primary Account Number (PAN), for any Wallet Provider or device. PAN will be minimum 9 digits and maximum 19 digits. Cannot be used together with any of the following search request parameters:TokenUniqueReference, Token, PaymentAppInstanceId, CommentId, or AlternateAccountIdentifier. 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. When present, the search will return one specific matching token. The TUR field will be a 48 char string. Cannot be used together with any of the following search request parameters: AccountPan, Token, PaymentAppInstanceId, CommentId, or AlternateAccountIdentifier. Example: DWSPMC00000000010906a349d9ca4eb1a4d53e3c90a11d9c	string	None.
Token	When present, the search will return one specific token. Token will be minimum 9 digits and maximum 19 digits. Cannot be used together with any of the following search request parameters: AccountPan, TokenUniqueReference, PaymentAppInstanceId, CommentId, or AlternateAccountIdentifier. Example: 5598765432109876	string	None.
PaymentAppInstanceId	When present, the search will return tokens already present or to be provisioned to the specified Payment App instance. Note - This may contain the identifier of the Secure Element or a mobile device for some programs. Cannot be used together with any of the following search request parameters: AccountPan, TokenUniqueReference, Token, CommentId, or AlternateAccountIdentifier. Example: 645b532a245e4723d7a9c4f62b24f24a24ba98e27d43e34e	string	None.
CommentId	When present, the search will return one specific token linked to the comment. Cannot be used together with any of the following search request parameters: AccountPan, TokenUniqueReference, Token, PaymentAppInstanceId, or AlternateAccountIdentifier. Example: 123456	string	None.
AlternateAccountIdentifier	When present, the search will return tokens matching this Alternate Account Identifier, for any Wallet Provider or device. Alternate Account Identifier will be minimum 9 and maximum 64 characters. Space characters are not allowed. Cannot be used together with any of the following search request parameters: AccountPan, TokenUniqueReference, Token, PaymentAppInstanceId, or CommentId. Example: NL91ABNA0417164300	string	None.
FinancialAccountInformation	When present, return tokens for the Account matching this Financial Account Information, for any Wallet Provider or device. Example: NL91ABNA0417164300	string	None.
ExcludeDeletedIndicator	Indicates whether deleted tokens should be excluded from the search results. When omitted, deleted tokens are included in the results. "true" indicates deleted tokens are excluded from the search results. "false" means deleted tokens are included in the search results. 5 characters in length, max. Example: true	string	None.
AuditInfo	Audit Info - See AuditInfo Object Documentation	AuditInfo	Required

Request Formats

application/json, text/json

Sample:

{
  "chid": "sample string 1",
  "accountPan": "sample string 2",
  "tokenUniqueReference": "sample string 3",
  "token": "sample string 4",
  "paymentAppInstanceId": "sample string 5",
  "commentId": "sample string 6",
  "alternateAccountIdentifier": "sample string 7",
  "financialAccountInformation": "sample string 8",
  "excludeDeletedIndicator": "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:

<SearchRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MDES.CustomerService.Models">
  <AccountPan>sample string 2</AccountPan>
  <AlternateAccountIdentifier>sample string 7</AlternateAccountIdentifier>
  <AuditInfo>
    <Organization>sample string 3</Organization>
    <Phone>sample string 4</Phone>
    <UserId>sample string 1</UserId>
    <UserName>sample string 2</UserName>
  </AuditInfo>
  <CHID>sample string 1</CHID>
  <CommentId>sample string 6</CommentId>
  <ExcludeDeletedIndicator>sample string 9</ExcludeDeletedIndicator>
  <FinancialAccountInformation>sample string 8</FinancialAccountInformation>
  <PaymentAppInstanceId>sample string 5</PaymentAppInstanceId>
  <Token>sample string 4</Token>
  <TokenUniqueReference>sample string 3</TokenUniqueReference>
</SearchRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

SearchResponse

Name	Description	Type	Additional information
Account	Account Object - See Account Object Definition	Account	None.

Response Formats

application/json, text/json

Sample:

{
  "account": {
    "accountPanSuffix": "sample string 1",
    "financialAccountSuffix": "sample string 2",
    "countryCode": "sample string 3",
    "interbankCardAssociationId": "sample string 4",
    "institutionName": "sample string 5",
    "expirationDate": "sample string 6",
    "alternateAccountIdentifierSuffix": "sample string 7",
    "tokens": [
      {
        "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"
      },
      {
        "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:

<SearchResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MDES.CustomerService.Models">
  <Account>
    <AccountPanSuffix>sample string 1</AccountPanSuffix>
    <AlternateAccountIdentifierSuffix>sample string 7</AlternateAccountIdentifierSuffix>
    <CountryCode>sample string 3</CountryCode>
    <ExpirationDate>sample string 6</ExpirationDate>
    <FinancialAccountSuffix>sample string 2</FinancialAccountSuffix>
    <InstitutionName>sample string 5</InstitutionName>
    <InterbankCardAssociationId>sample string 4</InterbankCardAssociationId>
    <Tokens>
      <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>
      <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>
    </Tokens>
  </Account>
</SearchResponse>