{
"uuid": "5a129474-3df5-4b23-8b48-1449cbfc6071",
"lastMigration": 29,
"name": "MDES Customer Service",
"endpointPrefix": "mdes/csapi/v2",
"latency": 0,
"port": 3000,
"hostname": "",
"routes": [
{
"uuid": "35985b81-7690-4c1c-859c-e08a686ea738",
"documentation": "Allows issuers to display customized messages per token within the Apple Pay wallet, below the digitized image of the card.\n",
"method": "post",
"endpoint": "accountholdermessaging",
"responses": [
{
"uuid": "edd36109-91b9-40bf-810e-e683b9514728",
"body": "{\n \"AccountHolderMessagingResponse\": {\n \"Token\": {\n \"TokenUniqueReference\": \"DWSPMC00000000010906a349d9ca4eb1a4d53e3c90a11d9c\"\n }\n }\n}",
"latency": 0,
"statusCode": 200,
"label": "Contains the details of the response",
"headers": [{ "key": "Content-Type", "value": "application/json" }],
"bodyType": "INLINE",
"filePath": "",
"databucketID": "",
"sendFileAsBody": false,
"rules": [],
"rulesOperator": "OR",
"disableTemplating": false,
"fallbackTo404": false,
"default": true,
"crudKey": "id"
},
{
"uuid": "8c880297-3d9c-4cfd-9f44-6a1ad72680b8",
"body": "{\n \"Errors\": {\n \"Error\": [\n {\n \"Description\": \"The date field is missing.\",\n \"ErrorCode\": \"DATE\",\n \"ReasonCode\": \"EMPTY_RESULT\",\n \"Recoverable\": true,\n \"Source\": \"Atms.Atm.Location.Address.Line1\"\n }\n ]\n }\n}",
"latency": 0,
"statusCode": 200,
"label": "unexpected error",
"headers": [{ "key": "Content-Type", "value": "application/json" }],
"bodyType": "INLINE",
"filePath": "",
"databucketID": "",
"sendFileAsBody": false,
"rules": [],
"rulesOperator": "OR",
"disableTemplating": false,
"fallbackTo404": false,
"default": false,
"crudKey": "id"
}
],
"enabled": true,
"responseMode": null,
"type": "http"
},
{
"uuid": "9bd016dc-eb02-4082-9c9d-00d85f2b0a1c",
"documentation": "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.
_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.
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",
"method": "post",
"endpoint": "search",
"responses": [
{
"uuid": "eb6ca498-6e1f-449d-9ead-f583a019b70e",
"body": "{\n \"SearchResponse\": {\n \"Accounts\": {\n \"Account\": [\n {\n \"AccountPanSuffix\": 1234,\n \"AlternateAccountIdentifierSuffix\": 4300,\n \"ExpirationDate\": 1225,\n \"Tokens\": {\n \"Token\": [\n {\n \"AccountPanSequenceNumber\": 59,\n \"ActivationCodeExpirationDateTime\": \"2015-01-21T00:04:35.000Z\",\n \"CorrelationId\": 98765432101234,\n \"CurrentStatusCode\": \"A\",\n \"CurrentStatusDateTime\": \"2015-01-21T00:04:35.000Z\",\n \"CurrentStatusDescription\": \"Active\",\n \"Device\": {\n \"DeviceId\": \"C2ZBY14310005664\",\n \"DeviceName\": \"John's phone\",\n \"DeviceType\": 14,\n \"SecureElementId\": \"92de9357a535b2c21a3566e446f43c532a46b54c46\"\n },\n \"DigitizationRequestDateTime\": \"2015-01-21T00:04:35.000Z\",\n \"ExpirationDate\": 1026,\n \"FinalTokenizationDecision\": \"A\",\n \"LastCommentId\": \"ABC123456\",\n \"PaymentAppInstanceId\": \"645b532a245e4723d7a9c4f62b24f24a24ba98e27d43e34e\",\n \"PrimaryAccountNumberUniqueReference\": \"FWSPMC0000000004793dac803f190a4dca4bad33c90a11d3\",\n \"ProvisioningStatusCode\": \"P\",\n \"ProvisioningStatusDescription\": \"Provisioning successful\",\n \"StorageTechnology\": \"S\",\n \"Suspenders\": {\n \"Suspender\": [\n \"I\"\n ]\n },\n \"TokenActivatedDateTime\": \"2015-01-21T00:04:35.000Z\",\n \"TokenAssuranceLevel\": 1,\n \"TokenDeletedFromConsumerApp\": \"\",\n \"TokenRequestorConsumerFacingEntityName\": \"Sunday Store\",\n \"TokenRequestorId\": 212345678,\n \"TokenRequestorName\": \"Popular High Street Merchant\",\n \"TokenSuffix\": 7890,\n \"TokenType\": \"S\",\n \"TokenUniqueReference\": \"DWSPMC00000000010906a349d9ca4eb1a4d53e3c90a11d9c\",\n \"WalletId\": 123\n }\n ]\n }\n }\n ]\n }\n }\n}",
"latency": 0,
"statusCode": 200,
"label": "Contains the details of the response message.",
"headers": [{ "key": "Content-Type", "value": "application/json" }],
"bodyType": "INLINE",
"filePath": "",
"databucketID": "",
"sendFileAsBody": false,
"rules": [],
"rulesOperator": "OR",
"disableTemplating": false,
"fallbackTo404": false,
"default": true,
"crudKey": "id"
},
{
"uuid": "1844f6a5-0b6e-49c0-9196-3cb2cca3fbb9",
"body": "{\n \"Errors\": {\n \"Error\": [\n {\n \"Description\": \"The date field is missing.\",\n \"ErrorCode\": \"DATE\",\n \"ReasonCode\": \"EMPTY_RESULT\",\n \"Recoverable\": true,\n \"Source\": \"Atms.Atm.Location.Address.Line1\"\n }\n ]\n }\n}",
"latency": 0,
"statusCode": 200,
"label": "unexpected error",
"headers": [{ "key": "Content-Type", "value": "application/json" }],
"bodyType": "INLINE",
"filePath": "",
"databucketID": "",
"sendFileAsBody": false,
"rules": [],
"rulesOperator": "OR",
"disableTemplating": false,
"fallbackTo404": false,
"default": false,
"crudKey": "id"
}
],
"enabled": true,
"responseMode": null,
"type": "http"
},
{
"uuid": "5a9dda94-774c-48a4-ab7e-560d386ca2e1",
"documentation": "Returns the overall system status of the Mastercard Digital Enablement Service.",
"method": "get",
"endpoint": "systemstatus",
"responses": [
{
"uuid": "da5cdffa-ee73-4395-94d6-369dc54248a4",
"body": "{\n \"SystemStatusResponse\": {\n \"CommentText\": \"Mastercard Digital Enablement Service is fully operational\",\n \"LastStatusDateTime\": \"2015-01-21T00:04:35.000Z\"\n }\n}",
"latency": 0,
"statusCode": 200,
"label": "Contains the details of the response message.",
"headers": [{ "key": "Content-Type", "value": "application/json" }],
"bodyType": "INLINE",
"filePath": "",
"databucketID": "",
"sendFileAsBody": false,
"rules": [],
"rulesOperator": "OR",
"disableTemplating": false,
"fallbackTo404": false,
"default": true,
"crudKey": "id"
},
{
"uuid": "336d64cb-515a-4429-b7e9-fe06a58a4663",
"body": "{\n \"Errors\": {\n \"Error\": [\n {\n \"Description\": \"The date field is missing.\",\n \"ErrorCode\": \"DATE\",\n \"ReasonCode\": \"EMPTY_RESULT\",\n \"Recoverable\": true,\n \"Source\": \"Atms.Atm.Location.Address.Line1\"\n }\n ]\n }\n}",
"latency": 0,
"statusCode": 200,
"label": "unexpected error",
"headers": [{ "key": "Content-Type", "value": "application/json" }],
"bodyType": "INLINE",
"filePath": "",
"databucketID": "",
"sendFileAsBody": false,
"rules": [],
"rulesOperator": "OR",
"disableTemplating": false,
"fallbackTo404": false,
"default": false,
"crudKey": "id"
}
],
"enabled": true,
"responseMode": null,
"type": "http"
},
{
"uuid": "d6acd718-d3c5-42a6-ae3e-3e32c8c1ca7c",
"documentation": "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",
"method": "post",
"endpoint": "token/activate",
"responses": [
{
"uuid": "82d68a83-8b66-4d68-877c-b6625fec1da6",
"body": "{\n \"TokenActivateResponse\": {\n \"Token\": {\n \"CommentId\": \"ABC123456\",\n \"TokenUniqueReference\": \"DWSPMC00000000010906a349d9ca4eb1a4d53e3c90a11d9c\"\n }\n }\n}",
"latency": 0,
"statusCode": 200,
"label": "Contains the details of the response message.",
"headers": [{ "key": "Content-Type", "value": "application/json" }],
"bodyType": "INLINE",
"filePath": "",
"databucketID": "",
"sendFileAsBody": false,
"rules": [],
"rulesOperator": "OR",
"disableTemplating": false,
"fallbackTo404": false,
"default": true,
"crudKey": "id"
},
{
"uuid": "f0971692-82f4-4f75-b3a4-4d5c39e144c3",
"body": "{\n \"Errors\": {\n \"Error\": [\n {\n \"Description\": \"The date field is missing.\",\n \"ErrorCode\": \"DATE\",\n \"ReasonCode\": \"EMPTY_RESULT\",\n \"Recoverable\": true,\n \"Source\": \"Atms.Atm.Location.Address.Line1\"\n }\n ]\n }\n}",
"latency": 0,
"statusCode": 200,
"label": "unexpected error",
"headers": [{ "key": "Content-Type", "value": "application/json" }],
"bodyType": "INLINE",
"filePath": "",
"databucketID": "",
"sendFileAsBody": false,
"rules": [],
"rulesOperator": "OR",
"disableTemplating": false,
"fallbackTo404": false,
"default": false,
"crudKey": "id"
}
],
"enabled": true,
"responseMode": null,
"type": "http"
},
{
"uuid": "4df39f97-dee5-4531-b69c-e64db461a517",
"documentation": "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",
"method": "post",
"endpoint": "token/activationmethods",
"responses": [
{
"uuid": "19dd54e3-75dd-4074-bded-ad5ce1fe8330",
"body": "{\n \"TokenActivationMethodsResponse\": {\n \"ActivationMethods\": {\n \"ActivationMethod\": [\n {\n \"ActivationMethodId\": 123123122,\n \"ActivationMethodType\": \"CLC\",\n \"ActivationMethodValue\": \"555-123-4567\",\n \"ResendIndicator\": \"\"\n }\n ]\n }\n }\n}",
"latency": 0,
"statusCode": 200,
"label": "Contains the details of the response message.",
"headers": [{ "key": "Content-Type", "value": "application/json" }],
"bodyType": "INLINE",
"filePath": "",
"databucketID": "",
"sendFileAsBody": false,
"rules": [],
"rulesOperator": "OR",
"disableTemplating": false,
"fallbackTo404": false,
"default": true,
"crudKey": "id"
},
{
"uuid": "5e242297-01db-4ece-b4ee-801bb62e1d9b",
"body": "{\n \"Errors\": {\n \"Error\": [\n {\n \"Description\": \"The date field is missing.\",\n \"ErrorCode\": \"DATE\",\n \"ReasonCode\": \"EMPTY_RESULT\",\n \"Recoverable\": true,\n \"Source\": \"Atms.Atm.Location.Address.Line1\"\n }\n ]\n }\n}",
"latency": 0,
"statusCode": 200,
"label": "unexpected error",
"headers": [{ "key": "Content-Type", "value": "application/json" }],
"bodyType": "INLINE",
"filePath": "",
"databucketID": "",
"sendFileAsBody": false,
"rules": [],
"rulesOperator": "OR",
"disableTemplating": false,
"fallbackTo404": false,
"default": false,
"crudKey": "id"
}
],
"enabled": true,
"responseMode": null,
"type": "http"
},
{
"uuid": "ef0f8df1-fc31-43b0-8570-15b7c7ecb9c2",
"documentation": "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",
"method": "post",
"endpoint": "token/comments",
"responses": [
{
"uuid": "d5b9deaa-5c26-421b-b93e-054c91a0e15e",
"body": "{\n \"TokenCommentsResponse\": {\n \"Comments\": {\n \"Comment\": [\n {\n \"AuditInfo\": {\n \"Organization\": \"Solid Bank Inc\",\n \"Phone\": 5555551234,\n \"UserId\": \"A1435477\",\n \"UserName\": \"John Smith\"\n },\n \"CommentDateTime\": \"2015-01-21T00:04:35.000Z\",\n \"CommentId\": \"ABC123456\",\n \"CommentText\": \"Cardholder called to activate their digital card.\"\n }\n ]\n }\n }\n}",
"latency": 0,
"statusCode": 200,
"label": "Contains the details of the response message.",
"headers": [{ "key": "Content-Type", "value": "application/json" }],
"bodyType": "INLINE",
"filePath": "",
"databucketID": "",
"sendFileAsBody": false,
"rules": [],
"rulesOperator": "OR",
"disableTemplating": false,
"fallbackTo404": false,
"default": true,
"crudKey": "id"
},
{
"uuid": "0d3842ea-128b-4201-aaae-34d271bb4f27",
"body": "{\n \"Errors\": {\n \"Error\": [\n {\n \"Description\": \"The date field is missing.\",\n \"ErrorCode\": \"DATE\",\n \"ReasonCode\": \"EMPTY_RESULT\",\n \"Recoverable\": true,\n \"Source\": \"Atms.Atm.Location.Address.Line1\"\n }\n ]\n }\n}",
"latency": 0,
"statusCode": 200,
"label": "unexpected error",
"headers": [{ "key": "Content-Type", "value": "application/json" }],
"bodyType": "INLINE",
"filePath": "",
"databucketID": "",
"sendFileAsBody": false,
"rules": [],
"rulesOperator": "OR",
"disableTemplating": false,
"fallbackTo404": false,
"default": false,
"crudKey": "id"
}
],
"enabled": true,
"responseMode": null,
"type": "http"
},
{
"uuid": "6c78f112-1b88-4509-a747-a86996afb37c",
"documentation": "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",
"method": "post",
"endpoint": "token/delete",
"responses": [
{
"uuid": "4b6bc1a7-2936-4e79-ae8d-e184b804b5fb",
"body": "{\n \"TokenDeleteResponse\": {\n \"Token\": {\n \"CommentId\": \"ABC123456\",\n \"TokenUniqueReference\": \"DWSPMC00000000010906a349d9ca4eb1a4d53e3c90a11d9c\"\n }\n }\n}",
"latency": 0,
"statusCode": 200,
"label": "Contains the details of the response message.",
"headers": [{ "key": "Content-Type", "value": "application/json" }],
"bodyType": "INLINE",
"filePath": "",
"databucketID": "",
"sendFileAsBody": false,
"rules": [],
"rulesOperator": "OR",
"disableTemplating": false,
"fallbackTo404": false,
"default": true,
"crudKey": "id"
},
{
"uuid": "576dbaa9-ff03-4bd6-af11-18856a2b2f46",
"body": "{\n \"Errors\": {\n \"Error\": [\n {\n \"Description\": \"The date field is missing.\",\n \"ErrorCode\": \"DATE\",\n \"ReasonCode\": \"EMPTY_RESULT\",\n \"Recoverable\": true,\n \"Source\": \"Atms.Atm.Location.Address.Line1\"\n }\n ]\n }\n}",
"latency": 0,
"statusCode": 200,
"label": "unexpected error",
"headers": [{ "key": "Content-Type", "value": "application/json" }],
"bodyType": "INLINE",
"filePath": "",
"databucketID": "",
"sendFileAsBody": false,
"rules": [],
"rulesOperator": "OR",
"disableTemplating": false,
"fallbackTo404": false,
"default": false,
"crudKey": "id"
}
],
"enabled": true,
"responseMode": null,
"type": "http"
},
{
"uuid": "27c0df80-7bb9-49b5-9d3e-d911d7f1d2ea",
"documentation": "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",
"method": "post",
"endpoint": "token/resendactivationcode",
"responses": [
{
"uuid": "f09ad9e2-b941-47b7-a725-71413a979c9a",
"body": "{\n \"TokenResendActivationCodeResponse\": {\n \"Token\": {\n \"TokenUniqueReference\": \"DWSPMC00000000010906a349d9ca4eb1a4d53e3c90a11d9c\"\n }\n }\n}",
"latency": 0,
"statusCode": 200,
"label": "Contains the details of the response message.",
"headers": [{ "key": "Content-Type", "value": "application/json" }],
"bodyType": "INLINE",
"filePath": "",
"databucketID": "",
"sendFileAsBody": false,
"rules": [],
"rulesOperator": "OR",
"disableTemplating": false,
"fallbackTo404": false,
"default": true,
"crudKey": "id"
},
{
"uuid": "6dee9011-8e2d-47b0-b427-f3770bc613ae",
"body": "{\n \"Errors\": {\n \"Error\": [\n {\n \"Description\": \"The date field is missing.\",\n \"ErrorCode\": \"DATE\",\n \"ReasonCode\": \"EMPTY_RESULT\",\n \"Recoverable\": true,\n \"Source\": \"Atms.Atm.Location.Address.Line1\"\n }\n ]\n }\n}",
"latency": 0,
"statusCode": 200,
"label": "unexpected error",
"headers": [{ "key": "Content-Type", "value": "application/json" }],
"bodyType": "INLINE",
"filePath": "",
"databucketID": "",
"sendFileAsBody": false,
"rules": [],
"rulesOperator": "OR",
"disableTemplating": false,
"fallbackTo404": false,
"default": false,
"crudKey": "id"
}
],
"enabled": true,
"responseMode": null,
"type": "http"
},
{
"uuid": "83ddb3fb-6792-4922-ac12-c14fcd954211",
"documentation": "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",
"method": "post",
"endpoint": "token/resetmobilepin",
"responses": [
{
"uuid": "a2787b3a-45c7-4d05-a7bf-3a8a7bdeebc3",
"body": "{\n \"TokenResetMobilePinResponse\": {\n \"Token\": {\n \"CommentId\": \"ABC123456\",\n \"TokenUniqueReference\": \"DWSPMC00000000010906a349d9ca4eb1a4d53e3c90a11d9c\"\n }\n }\n}",
"latency": 0,
"statusCode": 200,
"label": "Contains the details of the response message.",
"headers": [{ "key": "Content-Type", "value": "application/json" }],
"bodyType": "INLINE",
"filePath": "",
"databucketID": "",
"sendFileAsBody": false,
"rules": [],
"rulesOperator": "OR",
"disableTemplating": false,
"fallbackTo404": false,
"default": true,
"crudKey": "id"
},
{
"uuid": "a1741568-1411-4d75-a0bb-380cd553986d",
"body": "{\n \"Errors\": {\n \"Error\": [\n {\n \"Description\": \"The date field is missing.\",\n \"ErrorCode\": \"DATE\",\n \"ReasonCode\": \"EMPTY_RESULT\",\n \"Recoverable\": true,\n \"Source\": \"Atms.Atm.Location.Address.Line1\"\n }\n ]\n }\n}",
"latency": 0,
"statusCode": 200,
"label": "unexpected error",
"headers": [{ "key": "Content-Type", "value": "application/json" }],
"bodyType": "INLINE",
"filePath": "",
"databucketID": "",
"sendFileAsBody": false,
"rules": [],
"rulesOperator": "OR",
"disableTemplating": false,
"fallbackTo404": false,
"default": false,
"crudKey": "id"
}
],
"enabled": true,
"responseMode": null,
"type": "http"
},
{
"uuid": "26103eea-7623-45c2-9124-e9fdf0ca56d4",
"documentation": "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",
"method": "post",
"endpoint": "token/statushistory",
"responses": [
{
"uuid": "2811ae3c-4cd4-49df-ae1b-be7072a23631",
"body": "{\n \"TokenStatusHistoryResponse\": {\n \"Statuses\": {\n \"Status\": [\n {\n \"AuditInfo\": {\n \"Organization\": \"Solid Bank Inc\",\n \"Phone\": 5555551234,\n \"UserId\": \"A1435477\",\n \"UserName\": \"John Smith\"\n },\n \"CommentId\": 1234,\n \"Initiator\": \"I\",\n \"ReasonCode\": \"Z\",\n \"StatusCode\": \"U\",\n \"StatusDateTime\": \"2015-01-21T00:04:35.000Z\",\n \"StatusDescription\": \"Unmapped\"\n }\n ]\n }\n }\n}",
"latency": 0,
"statusCode": 200,
"label": "Contains the details of the response message.",
"headers": [{ "key": "Content-Type", "value": "application/json" }],
"bodyType": "INLINE",
"filePath": "",
"databucketID": "",
"sendFileAsBody": false,
"rules": [],
"rulesOperator": "OR",
"disableTemplating": false,
"fallbackTo404": false,
"default": true,
"crudKey": "id"
},
{
"uuid": "29a20bfd-be51-4253-88f4-e75294cbabb0",
"body": "{\n \"Errors\": {\n \"Error\": [\n {\n \"Description\": \"The date field is missing.\",\n \"ErrorCode\": \"DATE\",\n \"ReasonCode\": \"EMPTY_RESULT\",\n \"Recoverable\": true,\n \"Source\": \"Atms.Atm.Location.Address.Line1\"\n }\n ]\n }\n}",
"latency": 0,
"statusCode": 200,
"label": "unexpected error",
"headers": [{ "key": "Content-Type", "value": "application/json" }],
"bodyType": "INLINE",
"filePath": "",
"databucketID": "",
"sendFileAsBody": false,
"rules": [],
"rulesOperator": "OR",
"disableTemplating": false,
"fallbackTo404": false,
"default": false,
"crudKey": "id"
}
],
"enabled": true,
"responseMode": null,
"type": "http"
},
{
"uuid": "4102bda6-c5c2-48a3-8c60-82ed9b29f262",
"documentation": "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.\n",
"method": "post",
"endpoint": "token/suspend",
"responses": [
{
"uuid": "9794f3da-c750-4ee4-b38a-c92949ae56cf",
"body": "{\n \"TokenSuspendResponse\": {\n \"Token\": {\n \"CommentId\": \"ABC123456\",\n \"TokenUniqueReference\": \"DWSPMC00000000010906a349d9ca4eb1a4d53e3c90a11d9c\"\n }\n }\n}",
"latency": 0,
"statusCode": 200,
"label": "Contains the details of the response message.",
"headers": [{ "key": "Content-Type", "value": "application/json" }],
"bodyType": "INLINE",
"filePath": "",
"databucketID": "",
"sendFileAsBody": false,
"rules": [],
"rulesOperator": "OR",
"disableTemplating": false,
"fallbackTo404": false,
"default": true,
"crudKey": "id"
},
{
"uuid": "b3a346b2-a717-4a9a-9f32-95d60651c13d",
"body": "{\n \"Errors\": {\n \"Error\": [\n {\n \"Description\": \"The date field is missing.\",\n \"ErrorCode\": \"DATE\",\n \"ReasonCode\": \"EMPTY_RESULT\",\n \"Recoverable\": true,\n \"Source\": \"Atms.Atm.Location.Address.Line1\"\n }\n ]\n }\n}",
"latency": 0,
"statusCode": 200,
"label": "unexpected error",
"headers": [{ "key": "Content-Type", "value": "application/json" }],
"bodyType": "INLINE",
"filePath": "",
"databucketID": "",
"sendFileAsBody": false,
"rules": [],
"rulesOperator": "OR",
"disableTemplating": false,
"fallbackTo404": false,
"default": false,
"crudKey": "id"
}
],
"enabled": true,
"responseMode": null,
"type": "http"
},
{
"uuid": "43bc2d0d-d489-426b-afc1-15f416bc8a0c",
"documentation": "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.
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.\n",
"method": "post",
"endpoint": "token/unsuspend",
"responses": [
{
"uuid": "c8f2cc94-3d3e-414d-b7b5-eae8f6938beb",
"body": "{\n \"TokenUnsuspendResponse\": {\n \"Token\": {\n \"CommentId\": \"ABC123456\",\n \"TokenUniqueReference\": \"DWSPMC00000000010906a349d9ca4eb1a4d53e3c90a11d9c\"\n }\n }\n}",
"latency": 0,
"statusCode": 200,
"label": "Contains the details of the response message.",
"headers": [{ "key": "Content-Type", "value": "application/json" }],
"bodyType": "INLINE",
"filePath": "",
"databucketID": "",
"sendFileAsBody": false,
"rules": [],
"rulesOperator": "OR",
"disableTemplating": false,
"fallbackTo404": false,
"default": true,
"crudKey": "id"
},
{
"uuid": "57c485f2-f9f0-4169-b736-791fed16b68f",
"body": "{\n \"Errors\": {\n \"Error\": [\n {\n \"Description\": \"The date field is missing.\",\n \"ErrorCode\": \"DATE\",\n \"ReasonCode\": \"EMPTY_RESULT\",\n \"Recoverable\": true,\n \"Source\": \"Atms.Atm.Location.Address.Line1\"\n }\n ]\n }\n}",
"latency": 0,
"statusCode": 200,
"label": "unexpected error",
"headers": [{ "key": "Content-Type", "value": "application/json" }],
"bodyType": "INLINE",
"filePath": "",
"databucketID": "",
"sendFileAsBody": false,
"rules": [],
"rulesOperator": "OR",
"disableTemplating": false,
"fallbackTo404": false,
"default": false,
"crudKey": "id"
}
],
"enabled": true,
"responseMode": null,
"type": "http"
},
{
"uuid": "9591cba4-1075-4802-acdc-bd322e908f4d",
"documentation": "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",
"method": "post",
"endpoint": "token/update",
"responses": [
{
"uuid": "b399e05e-53da-4991-af20-44ed4ead34b7",
"body": "{\n \"TokenUpdateResponse\": {\n \"Tokens\": {\n \"Token\": [\n {\n \"CommentId\": \"ABC123456\",\n \"TokenUniqueReference\": \"DWSPMC00000000010906a349d9ca4eb1a4d53e3c90a11d9c\"\n }\n ]\n }\n }\n}",
"latency": 0,
"statusCode": 200,
"label": "Contains the details of the response message.",
"headers": [{ "key": "Content-Type", "value": "application/json" }],
"bodyType": "INLINE",
"filePath": "",
"databucketID": "",
"sendFileAsBody": false,
"rules": [],
"rulesOperator": "OR",
"disableTemplating": false,
"fallbackTo404": false,
"default": true,
"crudKey": "id"
},
{
"uuid": "9ef5970f-edc0-4d6b-8fa7-b5c6ec208bf2",
"body": "{\n \"Errors\": {\n \"Error\": [\n {\n \"Description\": \"The date field is missing.\",\n \"ErrorCode\": \"DATE\",\n \"ReasonCode\": \"EMPTY_RESULT\",\n \"Recoverable\": true,\n \"Source\": \"Atms.Atm.Location.Address.Line1\"\n }\n ]\n }\n}",
"latency": 0,
"statusCode": 200,
"label": "unexpected error",
"headers": [{ "key": "Content-Type", "value": "application/json" }],
"bodyType": "INLINE",
"filePath": "",
"databucketID": "",
"sendFileAsBody": false,
"rules": [],
"rulesOperator": "OR",
"disableTemplating": false,
"fallbackTo404": false,
"default": false,
"crudKey": "id"
}
],
"enabled": true,
"responseMode": null,
"type": "http"
},
{
"uuid": "1ea098ff-85b0-4496-8c62-0be004d1b2fb",
"documentation": "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.
_Notes:_ The Transaction History API response is not supported for static Card on File (CoF) tokens.
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",
"method": "post",
"endpoint": "transactions",
"responses": [
{
"uuid": "01f93091-879f-49aa-964f-258a034fc15c",
"body": "{\n \"TransactionsResponse\": {\n \"Transactions\": {\n \"Transaction\": [\n {\n \"CurrencyCode\": \"USD\",\n \"MerchantCategoryCode\": 1234,\n \"MerchantCategoryDescription\": \"GROCERY STORES, SUPERMARKETS\",\n \"MerchantName\": \"FoodMart\",\n \"POSEntryMode\": 90,\n \"TransactionAmount\": 123.45,\n \"TransactionDateTime\": \"2015-01-21T00:04:35.000Z\",\n \"TransactionStatusCode\": \"AUTH\",\n \"TransactionTypeCode\": \"PURCH\",\n \"TransactionTypeDescription\": \"Purchase\"\n }\n ]\n }\n }\n}",
"latency": 0,
"statusCode": 200,
"label": "Contains the details of the response message.",
"headers": [{ "key": "Content-Type", "value": "application/json" }],
"bodyType": "INLINE",
"filePath": "",
"databucketID": "",
"sendFileAsBody": false,
"rules": [],
"rulesOperator": "OR",
"disableTemplating": false,
"fallbackTo404": false,
"default": true,
"crudKey": "id"
},
{
"uuid": "0d10c58f-d261-4c97-bb24-8c2f71bc4df6",
"body": "{\n \"Errors\": {\n \"Error\": [\n {\n \"Description\": \"The date field is missing.\",\n \"ErrorCode\": \"DATE\",\n \"ReasonCode\": \"EMPTY_RESULT\",\n \"Recoverable\": true,\n \"Source\": \"Atms.Atm.Location.Address.Line1\"\n }\n ]\n }\n}",
"latency": 0,
"statusCode": 200,
"label": "unexpected error",
"headers": [{ "key": "Content-Type", "value": "application/json" }],
"bodyType": "INLINE",
"filePath": "",
"databucketID": "",
"sendFileAsBody": false,
"rules": [],
"rulesOperator": "OR",
"disableTemplating": false,
"fallbackTo404": false,
"default": false,
"crudKey": "id"
}
],
"enabled": true,
"responseMode": null,
"type": "http"
},
{
"uuid": "82d4c8a0-ca9e-46c6-b0f1-694b59332b12",
"documentation": "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",
"method": "post",
"endpoint": "updatetokenassurance",
"responses": [
{
"uuid": "47bfd04b-551e-4cfb-b5c9-0dcdba61b57f",
"body": "{\n \"UpdateTokenAssuranceResponse\": {\n \"Token\": {\n \"CommentId\": \"ABC123456\",\n \"TokenUniqueReference\": \"DWSPMC00000000010906a349d9ca4eb1a4d53e3c90a11d9c\"\n }\n }\n}",
"latency": 0,
"statusCode": 200,
"label": "Contains the details of the response message.",
"headers": [{ "key": "Content-Type", "value": "application/json" }],
"bodyType": "INLINE",
"filePath": "",
"databucketID": "",
"sendFileAsBody": false,
"rules": [],
"rulesOperator": "OR",
"disableTemplating": false,
"fallbackTo404": false,
"default": true,
"crudKey": "id"
},
{
"uuid": "debb4ad5-f030-423e-925d-392a0a9e602c",
"body": "{\n \"Errors\": {\n \"Error\": [\n {\n \"Description\": \"The date field is missing.\",\n \"ErrorCode\": \"DATE\",\n \"ReasonCode\": \"EMPTY_RESULT\",\n \"Recoverable\": true,\n \"Source\": \"Atms.Atm.Location.Address.Line1\"\n }\n ]\n }\n}",
"latency": 0,
"statusCode": 200,
"label": "unexpected error",
"headers": [{ "key": "Content-Type", "value": "application/json" }],
"bodyType": "INLINE",
"filePath": "",
"databucketID": "",
"sendFileAsBody": false,
"rules": [],
"rulesOperator": "OR",
"disableTemplating": false,
"fallbackTo404": false,
"default": false,
"crudKey": "id"
}
],
"enabled": true,
"responseMode": null,
"type": "http"
}
],
"proxyMode": false,
"proxyHost": "",
"proxyRemovePrefix": false,
"tlsOptions": {
"enabled": false,
"type": "CERT",
"pfxPath": "",
"certPath": "",
"keyPath": "",
"caPath": "",
"passphrase": ""
},
"cors": true,
"headers": [],
"proxyReqHeaders": [{ "key": "", "value": "" }],
"proxyResHeaders": [{ "key": "", "value": "" }],
"data": [],
"folders": [],
"rootChildren": [
{ "type": "route", "uuid": "35985b81-7690-4c1c-859c-e08a686ea738" },
{ "type": "route", "uuid": "9bd016dc-eb02-4082-9c9d-00d85f2b0a1c" },
{ "type": "route", "uuid": "5a9dda94-774c-48a4-ab7e-560d386ca2e1" },
{ "type": "route", "uuid": "d6acd718-d3c5-42a6-ae3e-3e32c8c1ca7c" },
{ "type": "route", "uuid": "4df39f97-dee5-4531-b69c-e64db461a517" },
{ "type": "route", "uuid": "ef0f8df1-fc31-43b0-8570-15b7c7ecb9c2" },
{ "type": "route", "uuid": "6c78f112-1b88-4509-a747-a86996afb37c" },
{ "type": "route", "uuid": "27c0df80-7bb9-49b5-9d3e-d911d7f1d2ea" },
{ "type": "route", "uuid": "83ddb3fb-6792-4922-ac12-c14fcd954211" },
{ "type": "route", "uuid": "26103eea-7623-45c2-9124-e9fdf0ca56d4" },
{ "type": "route", "uuid": "4102bda6-c5c2-48a3-8c60-82ed9b29f262" },
{ "type": "route", "uuid": "43bc2d0d-d489-426b-afc1-15f416bc8a0c" },
{ "type": "route", "uuid": "9591cba4-1075-4802-acdc-bd322e908f4d" },
{ "type": "route", "uuid": "1ea098ff-85b0-4496-8c62-0be004d1b2fb" },
{ "type": "route", "uuid": "82d4c8a0-ca9e-46c6-b0f1-694b59332b12" }
]
}