UNPKG

openapi-directory

Version:

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

1 lines 79.9 kB
{"openapi":"3.0.0","info":{"contact":{"email":"apisupport@mastercard.com","name":"Mastercard API Support"},"description":"This API provides our Issuer partners with resources to help resolve consumer queries about payment accounts enabled through our digitization platform.","title":"MDES Customer Service","version":"2.0.7","x-artifactId":"mdes-customer-service","x-origin":[{"format":"swagger","url":"https://developer.mastercard.com/devzone/api/portal/swagger/mdes-customer-service","version":"2.0"}],"x-providerName":"mastercard.com","x-serviceName":"MDES"},"paths":{"/accountholdermessaging":{"post":{"description":"Allows issuers to display customized messages per token within the Apple Pay wallet, below the digitized image of the card.\n","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountHolderMessagingRequest"}}},"description":"Contains the details of the request message."},"responses":{"200":{"description":"Contains the details of the response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountHolderMessagingResponseSchema"}}}},"default":{"description":"unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorsResponse"}}}}},"tags":["Account Holder Messaging"],"x-samples":[{"name":"account_holder_messaging","request":{"application/json":"{\n \"AccountHolderMessagingRequest\": {\n\"TokenUniqueReference\": \"DWSPMC00000000010906a349d9ca4eb1a4d53e3c90a11d9c\",\n\"MessageText\": \" You have earned a statement credit \",\n\"MessageExpiration\": \"2020-06-18T18:04:35-06:00\",\n\"MessageLanguageCode\": \"en\",\n\"MessageIdentifier\": \"6598123486451346764616431064\",\n\"IssuerApplicationMessageDisplay\": \"FALSE\",\n \"AuditInfo\": {\n \"UserId\": \"A1435477\",\n \"UserName\": \"John Smith\",\n \"Organization\": \"Any Bank\",\n \"Phone\": \"5555551234\"\n }\n }\n}"},"response":{"application/json":"{\n \"AccountHolderMessagingResponse\": {\n \"Token\": {\"TokenUniqueReference\": \"DWSPMC00000000010906a349d9ca4eb1a4d53e3c90a11d9c\"}\n }\n }"}}]}},"/search":{"post":{"description":"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.<br><br>_Notes:_ 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.<br> Moreover, this function only retrieves results if the search criteria matches a current value from the token vault. In other words, if the search criteria is a PAN that has been replaced, the system will not retrieve any data. \n","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchRequestSchema"}}},"description":"Contains the details of the request message."},"responses":{"200":{"description":"Contains the details of the response message.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchResponseSchema"}}}},"default":{"description":"unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorsResponse"}}}}},"tags":["Search"],"x-samples":[{"ignoreAsserts":["SearchResponse.Accounts.Account[0].AlternateAccountIdentifierSuffix","SearchResponse.Accounts.Account[0].Tokens.Token[0].AccountPanSequenceNumber","SearchResponse.Accounts.Account[0].Tokens.Token[0].TokenDeletedFromConsumerApp"],"name":"example_mdes_search_token_unique_ref","request":{"application/json":"{\n \"SearchRequest\": {\n \"TokenUniqueReference\": \"DWSPMC00000000010906a349d9ca4eb1a4d53e3c90a11d9c\",\n \"AuditInfo\": {\n \"UserId\": \"A1435477\",\n \"UserName\": \"John Smith\",\n \"Organization\": \"Any Bank\",\n \"Phone\": \"5555551234\"\n }\n }\n }"},"response":{"application/json":"{\n \"SearchResponse\": {\n \"Accounts\": {\n \"Account\": [{\n \"AccountPanSuffix\": \"1234\",\n \"ExpirationDate\": \"1215\",\n \"AlternateAccountIdentifierSuffix\": \"\",\n \"Tokens\": {\n \"Token\": [{\n \"TokenUniqueReference\": \"DWSPMC00000000010906a349d9ca4eb1a4d53e3c90a11d9c\",\n \"PrimaryAccountNumberUniqueReference\": \"FWSPMC0000000004793dac803f190a4dca4bad33c90a11d3\",\n \"TokenSuffix\": \"7639\",\n \"ExpirationDate\": \"0216\",\n \"AccountPanSequenceNumber\" : \"02\",\n \"DigitizationRequestDateTime\": \"2015-01-20T18:04:35-06:00\",\n \"TokenActivatedDateTime\": \"2015-01-20T18:04:35-06:00\",\n \"FinalTokenizationDecision\": \"A\",\n \"CorrelationId\": \"101234\",\n \"CurrentStatusCode\": \"A\",\n \"CurrentStatusDescription\": \"Active\",\n \"ProvisioningStatusCode\": \"S\",\n \"ProvisioningStatusDescription\": \"Provisioning successful\",\n \"TokenRequestorId\": \"00212345678\",\n \"WalletId\": \"103\",\n \"PaymentAppInstanceId\": \"92de9357a535b2c21a3566e446f43c532a46b54c46\",\n \"TokenType\": \"S\",\n \"LastCommentId\": \"2376\",\n \"Device\": {\n \"DeviceId\": \"3e5edf24a24ba98e27d43e345b532a245e4723d7a9c4f624e93452c92de9357a535b2c21a3566e446f43c532d34s6\",\n \"DeviceName\": \"John Phone\",\n \"DeviceType\": \"09\",\n \"SecureElementId\": \"92de9357a535b2c21a3566e446f43c532a46b54c46\"\n },\n \"TokenDeletedFromConsumerApp\" : false\n }]\n }\n }]\n }\n }\n}"}},{"name":"example_mdes_search_account_pan","request":{"application/json":"{\n \"SearchRequest\": {\n \"AccountPan\": \"5412345678901234\",\n \"ExcludeDeletedIndicator\": \"false\",\n \"AuditInfo\": {\n \"UserId\": \"A1435477\",\n \"UserName\": \"John Smith\",\n \"Organization\": \"Any Bank\",\n \"Phone\": \"5555551234\"\n }\n }\n }"},"response":{"application/json":"{\n\n}"}},{"name":"example_mdes_search_token","request":{"application/json":"{\n \"SearchRequest\": {\n \"Token\": \"5598765432109876\",\n \"AuditInfo\": {\n \"UserId\": \"A14354773\",\n \"UserName\": \"John Smith\",\n \"Organization\": \"Any Bank\",\n \"Phone\": \"5551234658\"\n }\n }\n}"},"response":{"application/json":"{\n\n}"}},{"name":"example_mdes_search_comment_id","request":{"application/json":"{\n \"SearchRequest\": {\n \"CommentId\": \"123456\",\n \"AuditInfo\": {\n \"UserId\": \"A1435477\",\n \"UserName\": \"John Smith\",\n \"Organization\": \"Any Bank\",\n \"Phone\": \"5555551234\"\n }\n }\n}"},"response":{"application/json":"{\n\n}"}},{"name":"example_mdes_search_payment_app_id","request":{"application/json":"{\n \"SearchRequest\": {\n \"PaymentAppInstanceId\": \"645b532a245e4723d7a9c4f62b24f24a24ba98e27d43e34e\",\n \"AuditInfo\": {\n \"UserId\": \"A14354773\",\n \"UserName\": \"John Smith\",\n \"Organization\": \"Any Bank\",\n \"Phone\": \"5551234658\"\n }\n }\n}"},"response":{"application/json":"{\n\n}"}}]}},"/systemstatus":{"get":{"description":"Returns the overall system status of the Mastercard Digital Enablement Service.","responses":{"200":{"description":"Contains the details of the response message.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SystemStatusResponseSchema"}}}},"default":{"description":"unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorsResponse"}}}}},"tags":["System Status"],"x-samples":[{"name":"example_mdes_system_status","request":{"application/json":"{\n\n}"},"response":{"application/json":"{\n \"SystemStatusResponse\": {\n \"CommentText\": \"<p><b>The MDES Customer Service Application has been updated as follows:</b><br>&#160;&#8226;&#160;&#160;The text 'UTC' (Coordinated Universal Time) will be displayed next to each date/time stamp to make date/time stamp more obvious.</p>\"\n }\n}"}}]}},"/token/activate":{"post":{"description":"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.\n","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TokenActivateRequestSchema"}}},"description":"Contains the details of the request message."},"responses":{"200":{"description":"Contains the details of the response message.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TokenActivateResponseSchema"}}}},"default":{"description":"unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorsResponse"}}}}},"tags":["Token Activate"],"x-samples":[{"name":"example_mdes_token_activate_token_unique_ref","request":{"application/json":"{\n \"TokenActivateRequest\": {\n \"TokenUniqueReference\": \"DWSPMC00000000010906a349d9ca4eb1a4d53e3c90a11d9c\",\n \"CommentText\": \"Confirmed cardholder identity.\",\n \"ReasonCode\": \"C\",\n \"AuditInfo\": {\n \"UserId\": \"A1435477\",\n \"UserName\": \"John Smith\",\n \"Organization\": \"Any Bank\",\n \"Phone\": \"5555551234\"\n }\n }\n}"},"response":{"application/json":"{\n \"TokenActivateResponse\": {\n \"Token\": {\n \"TokenUniqueReference\": \"DWSPMC00000000010906a349d9ca4eb1a4d53e3c90a11d9c\",\n \"CommentId\": \"1234\"\n }\n }\n}"}},{"name":"example_mdes_token_activate_pan_payment_app","request":{"application/json":"{\n \"TokenActivateRequest\": {\n \"AccountPan\": \"5412345678901234\",\n \"PaymentAppInstanceId\": \"645b532a245e4723d7a9c4f62b24f24a24ba98e27d43e34e\",\n \"CommentText\": \"Confirmed cardholder identity.\",\n \"ReasonCode\": \"A\",\n \"AuditInfo\": {\n \"UserId\": \"A14354773\",\n \"UserName\": \"John Smith\",\n \"Organization\": \"Any Bank\",\n \"Phone\": \"5556789876\"\n }\n }\n}"},"response":{"application/json":"{\n\n}"}}]}},"/token/activationmethods":{"post":{"description":"Used to retrieve the available Activation Methods for a token that is awaiting activation. Activation Methods are the means by which a cardholder may complete cardholder authentication with the issuer beyond the scope of MDES. It is possible that there are no Activation Methods for a token when an issuer did not provide any cardholder-specific information with the Tokenization Authorization Request (TAR) pre-digitization network message response.\n","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TokenActivationMethodsRequestSchema"}}},"description":"Contains the details of the request message."},"responses":{"200":{"description":"Contains the details of the response message.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TokenActivationMethodsResponseSchema"}}}},"default":{"description":"unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorsResponse"}}}}},"tags":["Token Activation Methods"],"x-samples":[{"name":"example_mdes_token_activation_methods","request":{"application/json":"{\n \"TokenActivationMethodsRequest\": {\n \"TokenUniqueReference\": \"DWSPMC00000000010906a349d9ca4eb1a4d53e3c90a11d9c\",\n \"AuditInfo\": {\n \"UserId\": \"A1435477\",\n \"UserName\": \"John Smith\",\n \"Organization\": \"Any Bank\",\n \"Phone\": \"5555551234\"\n }\n }\n}"},"response":{"application/json":"{\n \"TokenActivationMethodsResponse\": {\n \"ActivationMethods\": {\n \"ActivationMethod\": [\n {\n \"ActivationMethodType\": \"EMA\",\n \"ActivationMethodValue\": \"AXXXXXXD@mc.com\",\n \"ActivationMethodId\": \"123123122\",\n \"ResendIndicator\": \"FALSE\"\n },\n {\n \"ActivationMethodType\": \"CLC\",\n \"ActivationMethodValue\": \"(555)123-4567\",\n \"ActivationMethodId\": \"123123123\",\n \"ResendIndicator\": \"FALSE\"\n }\n ]\n }\n }\n}"}}]}},"/token/comments":{"post":{"description":"Used to retrieve all comments associated with a token. Typically the response includes comments created earlier by Issuer Customer Service representatives detailing additional information about a particular inquiry or event. There may also be comments with warnings of potential fraud. These comments are created automatically by the MDES system when a Token requestor indicates a high risk of fraud during digitization.\n","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TokenCommentsRequestSchema"}}},"description":"Contains the details of the request message."},"responses":{"200":{"description":"Contains the details of the response message.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TokenCommentsResponseSchema"}}}},"default":{"description":"unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorsResponse"}}}}},"tags":["Token Comments"],"x-samples":[{"name":"example_mdes_token_comments","request":{"application/json":"{\n \"TokenCommentsRequest\": {\n \"TokenUniqueReference\": \"DWSPMC00000000010906a349d9ca4eb1a4d53e3c90a11d9c\",\n \"AuditInfo\": {\n \"UserId\": \"A1435477\",\n \"UserName\": \"John Smith\",\n \"Organization\": \"Any Bank\",\n \"Phone\": \"5555551234\"\n }\n }\n}"},"response":{"application/json":"{\n \"TokenCommentsResponse\": {\n \"Comments\": {\n \"Comment\": [\n {\n \"CommentId\": \"1648\",\n \"CommentText\": \"Cardholder lost phone. Suspending device.\",\n \"CommentDateTime\": \"2015-01-21T18:04:35-06:00\",\n \"AuditInfo\": {\n \"UserId\": \"A14354774\",\n \"UserName\": \"Jade Mark\",\n \"Organization\": \"Any Bank\",\n \"Phone\": \"5555558888\"\n }\n },\n {\n \"CommentId\": \"1647\",\n \"CommentText\": \"Cardholder called to activate their digital card.\",\n \"CommentDateTime\": \"2015-01-19T11:02:25-06:00\",\n \"AuditInfo\": {\n \"UserId\": \"A14354773\",\n \"UserName\": \"Tom Smith\",\n \"Organization\": \"Any Bank\",\n \"Phone\": \"5555559999\"\n }\n }\n ]\n }\n }\n}"}}]}},"/token/delete":{"post":{"description":"Used to delete a token so that it may not initiate any new transactions. All authorizations for a deleted token will be declined. A deleted token may not be returned to an active state.\n","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TokenDeleteRequestSchema"}}},"description":"Contains the details of the request message."},"responses":{"200":{"description":"Contains the details of the response message.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TokenDeleteResponseSchema"}}}},"default":{"description":"unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorsResponse"}}}}},"tags":["Token Delete"],"x-samples":[{"name":"example_mdes_token_delete","request":{"application/json":"{\n \"TokenDeleteRequest\": {\n \"TokenUniqueReference\": \"DWSPMC00000000010906a349d9ca4eb1a4d53e3c90a11d9c\",\n \"CommentText\": \"Fraudulent transactions confirmed.\",\n \"ReasonCode\": \"T\",\n \"AuditInfo\": {\n \"UserId\": \"A1435477\",\n \"UserName\": \"John Smith\",\n \"Organization\": \"Any Bank\",\n \"Phone\": \"5555551234\"\n }\n }\n}"},"response":{"application/json":"{\n \"TokenDeleteResponse\": {\n \"Token\": {\n \"TokenUniqueReference\": \"DWSPMC00000000010906a349d9ca4eb1a4d53e3c90a11d9c\",\n \"CommentId\": \"1234\"\n }\n }\n}"}}]}},"/token/resendactivationcode":{"post":{"description":"Used to trigger the process of generating and sending a new Activation Code (for a specific token) to the cardholder via the requested Activation Method. When successful, a new Activation Code Expiration Date Time period will begin, and a new Activation Code will be sent to the issuer using the Activation Code Notification (ACN) pre-digitization network message. It can only be used to do this for Activation Methods that involve the external distribution of an Activation Code to the cardholder. For example, via email or SMS. It cannot be used to send a new activation code via the \"Mobile Application\" activation method, for instance. A new Activation Code can be sent even if the previous code has not expired. A new Activation Code can also be sent even after the previous code has expired; however, it can only be done up to 30 days after the token was created (the number of days is subject to change at the discretion of Mastercard).\n","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TokenResendActivationCodeRequestSchema"}}},"description":"Contains the details of the request message."},"responses":{"200":{"description":"Contains the details of the response message.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TokenResendActivationCodeResponseSchema"}}}},"default":{"description":"unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorsResponse"}}}}},"tags":["Token Resend Activation Code"],"x-samples":[{"name":"example_mdes_token_resend_activation_code","request":{"application/json":"{\n \"TokenResendActivationCodeRequest\": {\n \"TokenUniqueReference\": \"DWSPMC00000000010906a349d9ca4eb1a4d53e3c90a11d9c\",\n \"ActivationMethodId\": \"123123122\",\n \"AuditInfo\": {\n \"UserId\": \"A1435477\",\n \"UserName\": \"John Smith\",\n \"Organization\": \"Any Bank\",\n \"Phone\": \"5555551234\"\n }\n }\n}"},"response":{"application/json":"{\n \"TokenResendActivationCodeResponse\": {\n \"Token\": {\n \"TokenUniqueReference\": \"DWSPMC00000000010906a349d9ca4eb1a4d53e3c90a11d9c\"\n }\n }\n}"}}]}},"/token/resetmobilepin":{"post":{"description":"Used to request that the Mobile PIN for a Mastercard Cloud-Based Payment token in a single issuer wallet is reset. The request is passed to the Credential Management System for processing. When the Mobile PIN is a token-level PIN (as opposed to a wallet-level PIN), the cardholder must choose a new PIN within 10 minutes of a Reset Mobile PIN action. Otherwise, the reset will need to be re-requested.\n","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TokenResetMobilePinRequestSchema"}}},"description":"Contains the details of the request message."},"responses":{"200":{"description":"Contains the details of the response message.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TokenResetMobilePinResponseSchema"}}}},"default":{"description":"unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorsResponse"}}}}},"tags":["Token Reset Mobile PIN"],"x-samples":[{"name":"example_mdes_token_reset_mobilepin","request":{"application/json":"{\n \"TokenResetMobilePinRequest\": {\n \"TokenUniqueReference\": \"DWSPMC00000000010906a349d9ca4eb1a4d53e3c90a11d9c\",\n \"CommentText\": \"Confirmed cardholder identity.\",\n \"ReasonCode\": \"N\",\n \"AuditInfo\": {\n \"UserId\": \"A1435477\",\n \"UserName\": \"John Smith\",\n \"Organization\": \"Any Bank\",\n \"Phone\": \"5555551234\"\n }\n }\n}"},"response":{"application/json":"{\n \"TokenResetMobilePinResponse\": {\n \"Token\": {\n \"TokenUniqueReference\": \"DWSPMC00000000010906a349d9ca4eb1a4d53e3c90a11d9c\",\n \"CommentId\": \"2356\"\n }\n }\n}"}}]}},"/token/statushistory":{"post":{"description":"Used to retrieve the historical statuses and lifecycle events for a token, such as when it was initially activated, subsequently suspended or resumed, and finally deleted.\n","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TokenStatusHistoryRequestSchema"}}},"description":"Contains the details of the request message."},"responses":{"200":{"description":"Contains the details of the response message.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TokenStatusHistoryResponseSchema"}}}},"default":{"description":"unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorsResponse"}}}}},"tags":["Token Status History"],"x-samples":[{"name":"example_mdes_token_status_history","request":{"application/json":"{\n \"TokenStatusHistoryRequest\": {\n \"TokenUniqueReference\": \"DWSPMC00000000010906a349d9ca4eb1a4d53e3c90a11d9c\",\n \"AuditInfo\": {\n \"UserId\": \"A1435477\",\n \"UserName\": \"John Smith\",\n \"Organization\": \"Any Bank\",\n \"Phone\": \"5555551234\"\n }\n }\n}"},"response":{"application/json":"{\n \"TokenStatusHistoryResponse\": {\n \"Statuses\": {\n \"Status\": [\n {\n \"StatusCode\": \"D\",\n \"StatusDescription\": \"Deleted\",\n \"StatusDateTime\": \"2014-12-16T13:04:35-06:00\",\n \"Initiator\": \"C\",\n \"ReasonCode\": \"L\"\n },\n {\n \"StatusCode\": \"A\",\n \"StatusDescription\": \"Active\",\n \"StatusDateTime\": \"2014-12-15T11:05:35-06:00\",\n \"Initiator\": \"I\",\n \"ReasonCode\": \"A\",\n \"AuditInfo\": {\n \"UserId\": \"AI145530\",\n \"UserName\": \"John Smith\",\n \"Organization\": \"Any Bank\",\n \"Phone\": \"6362205555\"\n }\n },\n {\n \"StatusCode\": \"S\",\n \"StatusDescription\": \"Suspended\",\n \"StatusDateTime\": \"2014-12-14T12:04:35-06:00\",\n \"Initiator\": \"I\",\n \"ReasonCode\": \"L\",\n \"AuditInfo\": {\n \"UserId\": \"AI145530\",\n \"UserName\": \"John Smith\",\n \"Organization\": \"Any Bank\",\n \"Phone\": \"6362205555\"\n }\n },\n {\n \"StatusCode\": \"A\",\n \"StatusDescription\": \"Active\",\n \"StatusDateTime\": \"2014-12-13T11:05:35-06:00\",\n \"Initiator\": \"I\",\n \"ReasonCode\": \"A\",\n \"AuditInfo\": {\n \"UserId\": \"AI145530\",\n \"UserName\": \"John Smith\",\n \"Organization\": \"Any Bank\",\n \"Phone\": \"6362205555\"\n }\n },\n {\n \"StatusCode\": \"U\",\n \"StatusDescription\": \"Unmapped\",\n \"StatusDateTime\": \"2014-12-12T10:04:35-06:00\",\n \"ReasonCode\": \"Z\"\n }\n ]\n }\n }\n}"}}]}},"/token/suspend":{"post":{"description":"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. <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.\n","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TokenSuspendRequestSchema"}}},"description":"Contains the details of the request message."},"responses":{"200":{"description":"Contains the details of the response message.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TokenSuspendResponseSchema"}}}},"default":{"description":"unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorsResponse"}}}}},"tags":["Token Suspend"],"x-samples":[{"name":"example_mdes_token_suspend","request":{"application/json":"{\n \"TokenSuspendRequest\": {\n \"TokenUniqueReference\": \"DWSPMC00000000010906a349d9ca4eb1a4d53e3c90a11d9c\",\n \"CommentText\": \"Suspected fraudulent transactions reported.\",\n \"ReasonCode\": \"T\",\n \"AuditInfo\": {\n \"UserId\": \"A1435477\",\n \"UserName\": \"John Smith\",\n \"Organization\": \"Any Bank\",\n \"Phone\": \"5555551234\"\n }\n }\n}"},"response":{"application/json":"{\n \"TokenSuspendResponse\": {\n \"Token\": {\n \"TokenUniqueReference\": \"DWSPMC00000000010906a349d9ca4eb1a4d53e3c90a11d9c\",\n \"CommentId\": \"1234\"\n }\n }\n}"}}]}},"/token/unsuspend":{"post":{"description":"Used to unsuspend or resume a suspended token and return it to the active state where it may initiate new transactions. 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.\n","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TokenUnsuspendRequestSchema"}}},"description":"Contains the details of the request message."},"responses":{"200":{"description":"Contains the details of the response message.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TokenUnsuspendResponseSchema"}}}},"default":{"description":"unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorsResponse"}}}}},"tags":["Token Unsuspend"],"x-samples":[{"name":"example_mdes_token_unsuspend","request":{"application/json":"{\n \"TokenUnsuspendRequest\": {\n \"TokenUniqueReference\": \"DWSPMC00000000010906a349d9ca4eb1a4d53e3c90a11d9c\",\n \"CommentText\": \"Transactionsc confirmed as not fraudulent.\",\n \"ReasonCode\": \"T\",\n \"AuditInfo\": {\n \"UserId\": \"A1435477\",\n \"UserName\": \"John Smith\",\n \"Organization\": \"Any Bank\",\n \"Phone\": \"5555551234\"\n }\n }\n}"},"response":{"application/json":"{\n \"TokenUnsuspendResponse\": {\n \"Token\": {\n \"TokenUniqueReference\": \"DWSPMC00000000010906a349d9ca4eb1a4d53e3c90a11d9c\",\n \"CommentId\": \"1234\"\n }\n }\n}"}}]}},"/token/update":{"post":{"description":"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.\n","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TokenUpdateRequestSchema"}}},"description":"Contains the details of the request message."},"responses":{"200":{"description":"Contains the details of the response message.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TokenUpdateResponseSchema"}}}},"default":{"description":"unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorsResponse"}}}}},"tags":["Token Update"],"x-samples":[{"name":"example_mdes_token_update_pan_exp_token_unique_ref","request":{"application/json":"{\n \"TokenUpdateRequest\": {\n \"TokenUniqueReference\": \"DWSPMC00000000010906a349d9ca4eb1a4d53e3c90a11d9c\",\n \"NewAccountPan\": \"5412345678908888\",\n \"ExpirationDate\": \"0125\",\n \"AccountPanSequenceNumber\": \"1\",\n \"UpdateWalletProviderIndicator\": \"1\",\n \"CommentText\": \"Confirmed cardholder identity.\",\n \"AuditInfo\": {\n \"UserId\": \"A1435477\",\n \"UserName\": \"John Smith\",\n \"Organization\": \"Any Bank\",\n \"Phone\": \"5555551234\"\n }\n }\n}"},"response":{"application/json":"{\n \"TokenUpdateResponse\": {\n \"Tokens\": {\n \"Token\": [{\n \"TokenUniqueReference\": \"DWSPMC00000000010906a349d9ca4eb1a4d53e3c90a11d9c\",\n \"CommentId\": \"2345\"\n }]\n }\n }\n}"}},{"name":"example_mdes_token_update_pan_exp_current_pan","request":{"application/json":"{\n \"TokenUpdateRequest\": {\n \"CurrentAccountPan\": \"1234567890123456\",\n \"NewAccountPan\": \"5412345678908888\",\n \"ExpirationDate\": \"1219\",\n \"AccountPanSequenceNumber\": \"1\",\n \"CommentText\": \"Cardholder has a new Account Pan.\",\n \"AuditInfo\": {\n \"UserId\": \"A1435477\",\n \"UserName\": \"John Smith\",\n \"Organization\": \"Any Bank\",\n \"Phone\": \"555 1234\"\n }\n }\n}"},"response":{"application/json":"{\n\n}"}},{"name":"example_mdes_token_update_issuer_prod_config_single_token_by_token_unique_ref","request":{"application/json":"{\n \"TokenUpdateRequest\": {\n \"TokenUniqueReference\": \"DWSPMC00000000010906a349d9ca4eb1a4d53e3c90a11d9c\",\n \"IssuerProductConfigurationId\": \"ANYGOLD101\",\n \"CommentText\": \"Update gold artwork\",\n \"AuditInfo\": {\n \"UserId\": \"A1435477\",\n \"UserName\": \"John Smith\",\n \"Organization\": \"Any Bank\",\n \"Phone\": \"555 1234\"\n }\n }\n}"},"response":{"application/json":"{\n\n}"}},{"name":"example_mdes_token_update_issuer_prod_config_token_by_pan","request":{"application/json":"{\n \"TokenUpdateRequest\": {\n \"CurrentAccountPan\": \"1234567890123456\",\n \"IssuerProductConfigurationId\": \"ANYGOLD101\",\n \"CommentText\": \"Update gold artwork\",\n \"AuditInfo\": {\n \"UserId\": \"A1435477\",\n \"UserName\": \"John Smith\",\n \"Organization\": \"Any Bank\",\n \"Phone\": \"555 1234\"\n }\n }\n}"},"response":{"application/json":"{\n\n}"}}]}},"/transactions":{"post":{"description":"Used to retrieve transactions performed by a token. It only returns transactions performed within the last 30 days, to help identify a particular token, or to identify a particular recent transaction. It is not intended to provide the full transaction history of a token or Account PAN.<br><br>_Notes:_ The Transaction History API response is not supported for static Card on File (CoF) tokens.<br>If a set of tokens has been re-mapped to a new FPAN, all digital transactions will be made available before or after the FPAN has been updated. MDES does not return the value of the FPAN which was mapped to the particular token at the time of the transaction. However, MDES will return the history of all transactions performed on that particular token in the last 30 days, based on old and/or new FPAN.\n","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransactionsRequestSchema"}}},"description":"Contains the details of the request message."},"responses":{"200":{"description":"Contains the details of the response message.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransactionsResponseSchema"}}}},"default":{"description":"unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorsResponse"}}}}},"tags":["Transactions"],"x-samples":[{"name":"example_mdes_transactions","request":{"application/json":"{\n \"TransactionsRequest\": {\n \"TokenUniqueReference\": \"DWSPMC00000000010906a349d9ca4eb1a4d53e3c90a11d9c\",\n \"AuditInfo\": {\n \"UserId\": \"A1435477\",\n \"UserName\": \"John Smith\",\n \"Organization\": \"Any Bank\",\n \"Phone\": \"5555551234\"\n }\n }\n}"},"response":{"application/json":"{\n \"TransactionsResponse\": {\n \"Transactions\": {\n \"Transaction\": [\n {\n \"CurrencyCode\": \"USD\",\n \"TransactionAmount\": \"123.45\",\n \"TransactionTypeCode\": \"PURCH\",\n \"TransactionTypeDescription\": \"Purchase\",\n \"TransactionStatusCode\": \"AUTH\",\n \"MerchantName\": \"FOODMART\",\n \"MerchantCategoryCode\": \"1234\",\n \"MerchantCategoryDescription\": \"GROCERY STORES, SUPERMARKETS\",\n \"POSEntryMode\": \"90\"\n },\n {\n \"CurrencyCode\": \"USD\",\n \"TransactionAmount\": \"29.47\",\n \"TransactionTypeCode\": \"PURCB\",\n \"TransactionTypeDescription\": \"Purchase with Cashback\",\n \"TransactionStatusCode\": \"COMP\",\n \"MerchantName\": \"RXMART\",\n \"MerchantCategoryCode\": \"5678\",\n \"MerchantCategoryDescription\": \"DRUG STORES, PHARMACIES\",\n \"POSEntryMode\": \"91\"\n },\n {\n \"CurrencyCode\": \"USD\",\n \"TransactionAmount\": \"-16.30\",\n \"TransactionTypeCode\": \"REFND\",\n \"TransactionTypeDescription\": \"Refund\",\n \"TransactionStatusCode\": \"COMP\",\n \"MerchantName\": \"AUTOMART\",\n \"MerchantCategoryCode\": \"9012\",\n \"MerchantCategoryDescription\": \"AUTOMOTIVE PARTS, ACCESSORIES STORES\",\n \"POSEntryMode\": \"07\"\n },\n {\n \"CurrencyCode\": \"USD\",\n \"TransactionAmount\": \"41.89\",\n \"TransactionTypeCode\": \"AFD\",\n \"TransactionTypeDescription\": \"Purchase Pre-Auth AFD\",\n \"TransactionStatusCode\": \"PAUTC\",\n \"MerchantName\": \"GASMART\",\n \"MerchantCategoryCode\": \"3456\",\n \"MerchantCategoryDescription\": \"FUEL DISPENSER, AUTOMATED\",\n \"POSEntryMode\": \"90\"\n }\n ]\n }\n }\n}"}}]}},"/updatetokenassurance":{"post":{"description":"Used after an issuer has performed additional cardholder authentication to indicate an increased level of token assurance. It will only be applied to tokens that actually have a Token Assurance Level, and those that are in ACTIVE or SUSPENDED state.\n","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateTokenAssuranceRequestSchema"}}},"description":"Contains the details of the request message."},"responses":{"200":{"description":"Contains the details of the response message.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateTokenAssuranceResponseSchema"}}}},"default":{"description":"unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorsResponse"}}}}},"tags":["Update Token Assurance"],"x-samples":[{"name":"example_mdes_update_token_assurance","request":{"application/json":"{\n \"UpdateTokenAssuranceRequest\": {\n \"TokenUniqueReference\": \"DWSPMC00000000010906a349d9ca4eb1a4d53e3c90a11d9c\",\n \"CommentText\": \"Updating assurance.\",\n \"AuditInfo\": {\n \"UserId\": \"A1435477\",\n \"UserName\": \"John Smith\",\n \"Organization\": \"Any Bank\",\n \"Phone\": \"5555551234\"\n }\n }\n}"},"response":{"application/json":"{\n \"UpdateTokenAssuranceResponse\": {\n \"Token\": {\n \"TokenUniqueReference\": \"DWSPMC00000000010906a349d9ca4eb1a4d53e3c90a11d9c\",\n \"CommentId\": \"12345\"\n }\n }\n}"}}]}}},"servers":[{"url":"https://api.mastercard.com/mdes/csapi/v2"}],"components":{"schemas":{"Account":{"properties":{"AccountPanSuffix":{"description":"Last 4 digits of Account PAN mapped (or to be mapped) to Token(s).","example":1234,"maxLength":4,"type":"string"},"AlternateAccountIdentifierSuffix":{"description":"Alternate Account Identifier is a cardholder friendly reference to a bank account. It is typically used to identify associated tokens when the cardholder is unaware of their Account PAN. The Alternate Account Identifier Suffix exposes just the last few characters of the full identifier in order to protect the full identifier from possible fraud.","example":4300,"maxLength":4,"type":"string"},"ExpirationDate":{"description":"Expiration date of Account PAN mapped (or to be mapped) to Token(s). 'MMYY' Format.","example":1225,"maxLength":4,"type":"string"},"Tokens":{"$ref":"#/components/schemas/Tokens"}}},"AccountHolderMessagingRequest":{"properties":{"AccountHolderMessagingRequest":{"$ref":"#/components/schemas/AccountHolderMessagingRequestSchema"}}},"AccountHolderMessagingRequestSchema":{"properties":{"AuditInfo":{"$ref":"#/components/schemas/AuditInfo"},"IssuerApplicationMessageDisplay":{"description":"This is the indicator if the message can be viewed in the Issuer Application using the MessageIdentifier. <br>Please refer to the Apple Card Notification Specification for Notification Deep Linking. Mandatory field. Valid values are;<br>TRUE ? The message can be viewed in the issuer application<br>FALSE ? The message cannot be viewed in the issuer application.","example":"FALSE","maxLength":5,"minLength":4,"type":"string"},"MessageExpiration":{"description":"Date and time after which the message is no longer valid. Maximum value of 30 days in the future. Mandatory field. __ISO 8601 format ? YYYY-MM-DDThh:mm:ssTZD__","example":"2025-06-15T13:47:48.489Z","type":"string"},"MessageIdentifier":{"description":"This is the message identifier. This could be used for linking into the issuer application. Mandatory field.","example":6.598123486451347e+27,"maxLength":64,"type":"string"},"MessageLanguageCode":{"description":"The language of the message. Only messages with the requested language code will be presented to the account holder. Mandatory field. <br>__ISO 639-1 format__","example":"en","maxLength":3,"type":"string"},"MessageText":{"description":"This is the message which will be displayed to the cardholder. Mandatory field.","example":"You have earned a statement credit.","maxLength":128,"type":"string"},"TokenUniqueReference":{"description":"When present, the search will return one specific matching token. Cannot be used together with any of the following search request parameters; AccountPan, Token, PaymentAppInstanceId, CommentId, or AlternateAccountIdentifier. Mandatory field.","example":"DWSPMC00000000010906a349d9ca4eb1a4d53e3c90a11d9c","maxLength":48,"type":"string"}},"required":["TokenUniqueReference","MessageIdentifier","IssuerApplicationMessageDisplay","MessageText","MessageExpiration","MessageLanguageCode","AuditInfo"]},"AccountHolderMessagingResponse":{"properties":{"Token":{"$ref":"#/components/schemas/TokenResponse"}}},"AccountHolderMessagingResponseSchema":{"properties":{"AccountHolderMessagingResponse":{"$ref":"#/components/schemas/AccountHolderMessagingResponse"}}},"Accounts":{"properties":{"Account":{"description":"When searching by Account PAN or by Payment App Instance Id, the search response may contain more than one token. Each individual token can be updated during its lifetime and associated to a different Account PAN, or given a new Expiration Date. Different tokens within a single search response may therefore have different Account PANs and/or Expiration Dates. Account objects are used to group tokens that have exactly the same Account PAN and Account PAN Expiration Date.","items":{"$ref":"#/components/schemas/Account"},"type":"array"}}},"ActivationMethod":{"properties":{"ActivationMethodId":{"description":"Unique identifier of the activation method.","example":123123122,"maxLength":0,"type":"string"},"ActivationMethodType":{"description":"Type of activation method. Valid values:<br /> \"SMS\" ? Activation code sent in text message to masked mobile phone number<br /> \"EMA\" ? Activation code sent in email to masked email address<br /> \"ACC\" ? Cardholder to call automated call center phone number<br /> \"CLC\" ? Cardholder to call Call Center phone number<br /> \"WEB\" ? Website<br /> \"BAP\" ? Mobile application<br /> \"OBC\" ? Activation code spoken via call to cardholder on masked voice call phone number.","example":"CLC","maxLength":3,"type":"string"},"ActivationMethodValue":{"description":"Activation method details value.","example":"555-123-4567","maxLength":0,"type":"string"},"ResendIndicator":{"description":"Whether the activation method can be used to re-send an activation code. Valid values are TRUE and FALSE.","example":false,"maxLength":5,"minLength":4,"type":"string"}}},"ActivationMethods":{"properties":{"ActivationMethod":{"items":{"$ref":"#/components/schemas/ActivationMethod"},"type":"array"}}},"AuditInfo":{"properties":{"Organization":{"description":"Name of the Issuer or Processor to which the Customer Service Representative who triggered the API request belongs.","example":"Solid Bank Inc","maxLength":200,"type":"string"},"Phone":{"description":"Phone Number of the Customer Service Representative who triggered the API request.","example":5555551234,"maxLength":20,"type":"string"},"UserId":{"description":"User ID (as assigned by the Issuer/Processor) of the Customer Service Representative who triggered the API request.","example":"A1435477","maxLength":50,"type":"string"},"UserName":{"description":"User Name of the Customer Service Representative who triggered the API request.","example":"John Smith","maxLength":200,"type":"string"}},"required":["UserId","UserName","Organization"]},"Comment":{"properties":{"AuditInfo":{"$ref":"#/components/schemas/AuditInfo"},"CommentDateTime":{"description":"Date and time that the comment was updated. Format - YYYY-MM-DDThh:mm:ssTZD .","example":"2025-06-15T13:47:48.489Z","type":"string"},"CommentId":{"description":"Identifier for the comment.","example":"ABC123456","maxLength":0,"type":"string"},"CommentText":{"description":"Comment text.","example":"Cardholder called to activate their digital card.","maxLength":500,"type":"string"}}},"Comments":{"properties":{"Comment":{"items":{"$ref":"#/components/schemas/Comment"},"type":"array"}}},"Device":{"properties":{"DeviceId":{"description":"Serial number of the device provisioned with the token. May be masked. Conditional field, not present for CoF tokens, and only present when provided by a Wallet Provider. May be masked (by the Wallet Provider).<br />Example (unmasked) \"C2ZBY14310005664\". Example (masked) \"xxxxY1431xxxxxxx\".","example":"C2ZBY14310005664","maxLength":0,"type":"string"},"DeviceName":{"description":"Nickname of the device provisioned with the token. Conditional field, not present for CoF tokens, and only present when the Payment App Provider has implemented the 'Get Device Info' MDES API.","example":"John's phone","maxLength":0,"type":"string"},"DeviceType":{"description":"Type of the device provisioned with the token. Valid values:<br /> \"03\" - Watch<br /> \"09\" - Mobile Phone or Smartphone with a fixed (non-removable) secure element not controlled by the mobile network operator<br /> \"13\" - Tablet or e-reader with a fixed (non-removable) secure element not controlled by the mobile network operator<br /> \"14\" - Mobile phone or Smartphone with a payment application running in a host processor<br /> \"15\" - Tablet or E-Book with a payment application running in a host processor<br /> \"16\" ? Mobile Phone or Smartphone with a payment application running in the TEE of a host processor<br /> \"17\" ? Tablet or E-Book with a payment application running in the TEE of a host processor<br /> \"18\" ? Watch with a payment application running in the TEE of a host processor<br /> \"19\" ? Watch with a payment application running in a host processor.<br /> \"21\" ? Phone.<br /> \"22\" ? Tablet. <br /> \"23\" ? Watch.<br /> \"24\" ? Sticker.<br /> \"25\" ? Personal Computer.<br /> \"26\" ? Device Peripheral.<br /> \"27\" ? Tag.<br /> \"28\" ? Jewelry.<br /> \"29\" ? Fashion Accessory.<br /> \"30\" ? Garment.<br /> \"31\" ? Domestic Appliance.<br /> \"32\" ? Vehicle.<br /> \"33\" ? Media or Gaming Device.<br /> \"99\" ? Undefined.<br />Conditional field, not present for CoF tokens, and only present when supplied by the Payment App Provider.","example":14,"maxLength":2,"type":"string"},"SecureElementId":{"description":"Identifier of the secure element provisioned with the token. Conditional field, not present for CoF tokens, and only present when the token is provisioned to a secure element.","example":"92de9357a535b2c21a3566e446f43c532a46b54c46","maxLength":128,"type":"string"}}},"Error":{"properties":{"Description":{"description":"A textual description of the error that is appropriate for logging and may communicate additional details related to the reason code.","example":"The date field is missing.","type":"string"},"ErrorCode":{"description":"An identifier that represents additional detail for the reason of the error.","example":"DATE","maxLength":0,"type":"string"},"ReasonCode":{"description":"Indicator that identifies the reason for the error.","example":"EMPTY_RESULT","maxLength":0,"type":"string"},"Recoverable":{"description":"An indicator stating whether it is reasonable to retry a failed request.","example":true,"maxLength":5,"minLength":4,"type":"string"},"Source":{"description":"Unique identifier that attempts to define the field in error when available. If a specific field can't be identified, \"System\" will be returned.","example":"Atms.Atm.Location.Address.Line1","maxLength":0,"type":"string"}}},"Errors":{"properties":{"Error":{"items":{"$ref":"#/components/schemas/Error"},"type":"array"}}},"ErrorsResponse":{"properties":{"Errors":{"$ref":"#/components/schemas/Errors"}}},"SearchRequest":{"properties":{"AccountPan":{"description":"When present, the search will return tokens for the Account matching this Primary Account Number (PAN), for any Wallet Provider or device. Cannot be used together with any of the following search request. parameters:TokenUniqueReference, Token, PaymentAppInstanceId, CommentId, or AlternateAccountIdentifier.","example":5412345678901234,"maxLength":19,"minLength":9,"type":"string"},"AlternateAccountIdentifier":{"description":"When present, the search will return tokens matching this Alternate Account Identifier, for any Wallet Provider or device. 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","maxLength":64,"minLength":9,"type":"string"},"AuditInfo":{"$ref":"#/components/schemas/AuditInfo"},"CommentId":{"description":"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,"maxLength":0,"type":"string"},"ExcludeDeletedIndicator":{"description":"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.","enum":["true","false"],"example":"true","type":"string"},"PaymentAppInstanceId":{"description":"When present, the search will return tokens already present or to be provisioned to the specified Payment App instance.<br><br>_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","maxLength":48,"type":"string"},"Token":{"description":"When presen