{ "info": { "_postman_id": "ad9b62a8-6106-45e7-b69d-965ead75a425", "name": "Thredd IAM API v1.3", "description": "## Thredd API Hub – IAM Postman Collection Setup\n\nTo use the Thredd API Hub , you must first create an Application and an OAuth Client in the Thredd Portal.\n\nFor information on how to set up the Postman Collection for both TLS and mTLS connection methods, see [Setting Up IAM Postman Collection](https://cardsapidocs.thredd.com/v2.0/docs/setting-up-iam-postman-collection).\n\n## **Changelog**\n\n### v1.3 (16th October 2026)\n\nCorrected the endpoints for the following Webhooks endpoints:\n\n- Update Webhook Details\n \n- Create Webhook\n \n- List Webhooks\n \n- Get Webhook Details\n \n- Get Notification Details\n \n\n### v1.2 (7th October 2026)\n\nUpdated the Apple Web Push Provisioning endpoint from GET to POST and updated the version to V2.\n\n### v1.1 (18th September 2026)\n\nAdded the following endpoint folders to the Postman Collection:\n\n- Card Tokenisation\n \n- Custom PAN\n \n- Card Limits\n \n- Alias Directory Service\n \n\nAlso added the Bulk Create Create endpoint to the SOAP Converted Endpoints folder.\n\n### v1.0 (14th September 2026)\n\nFirst version of the IAM Postman Collection.", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "_exporter_id": "20946476" }, "item": [ { "name": "Authorisation", "item": [ { "name": "Get Access Token", "event": [ { "listen": "prerequest", "script": { "exec": [ "" ], "type": "text/javascript", "packages": {}, "requests": {} } }, { "listen": "test", "script": { "exec": [ "var jsonData = pm.response.json();", "if (jsonData.access_token) {", " pm.environment.set('access_token', jsonData.access_token);", "}" ], "type": "text/javascript", "packages": {}, "requests": {} } } ], "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "", "value": "", "type": "text", "disabled": true } ], "body": { "mode": "urlencoded", "urlencoded": [ { "key": "grant_type", "value": "client_credentials", "type": "text" }, { "key": "client_id", "value": "{{client_id}}", "type": "text" }, { "key": "client_secret", "value": "{{client_secret}}", "type": "text" }, { "key": "", "value": "", "type": "text", "uuid": "b1fdb636-7cd0-4b5f-b967-6d7292a4ba69", "disabled": true } ] }, "url": { "raw": "{{token_endpoint}}", "host": [ "{{token_endpoint}}" ] } }, "response": [] } ] }, { "name": "REST Endpoints", "item": [ { "name": "Cards", "item": [ { "name": "Create Virtual Card", "event": [ { "listen": "test", "script": { "exec": [ "let responseJSON = pm.response.json();", "let publicToken = responseJSON.publicToken;", "", "// Set the Postman variables", "pm.collectionVariables.set(\"publicToken\", publicToken);", "// Log them for confirmation", "console.log(\"Public Token set to: \" + publicToken);", "" ], "type": "text/javascript", "packages": {}, "requests": {} } } ], "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{access_token}}", "type": "string" } ] }, "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\r\n \"cardType\":\"Virtual\",\r\n \"cardProduct\": 10041,\r\n \"customerReference\": \"CustNo12345A\",\r\n \"activateNow\": true,\r\n \"freetext1\": \"Comments for the card manufacturer here\",\r\n \"freetext2\": \"And in this field too.\",\r\n \"nameOnCard\": \"Mr Johnny Bruce\",\r\n \"isSingleUse\": false,\r\n \"isNonReloadable\": false,\r\n \"language3ds\": \"en-GB\",\r\n \"cardHolder\": {\r\n \"title\": \"Mr.\",\r\n \"firstName\": \"John\",\r\n \"middleName\": \"Bruce\",\r\n \"lastName\": \"Bloggs\",\r\n \"dateOfBirth\": \"1982-02-19\",\r\n \"mobile\": \"07755123456\",\r\n \"email\": \"jbloggs@email.com\"\r\n },\r\n \"address\": {\r\n \"addressLine1\": \"32 Metropolis Ave\",\r\n \"addressLine2\": \"Mountain Drive\",\r\n \"city\": \"London\",\r\n \"postCode\": \"SW11 2LD\",\r\n \"country\": \"GBR\"\r\n }\r\n \r\n\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base-url}}core/api/v1/cards", "host": [ "{{base-url}}core" ], "path": [ "api", "v1", "cards" ] }, "description": "The first \"Starter\" Core API request, for details of which APIs to call, what parameters to use etc see elsewhere \n[https://cardsapidocs.thredd.com/](https://cardsapidocs.thredd.com/)" }, "response": [ { "name": "Create Physical Card", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\r\n \"cardType\":\"Physical\",\r\n \"cardProduct\": 4660,\r\n \"customerReference\": \"CustNo12345A\",\r\n \"activateNow\": true,\r\n \"freetext1\": \"Comments for the card manufacturer here\",\r\n \"freetext2\": \"And in this field too.\",\r\n \"nameOnCard\": \"Mr Johnny Bruce\",\r\n \"isSingleUse\": false,\r\n \"isNonReloadable\": false,\r\n \"language3ds\": \"en-GB\",\r\n \"cardHolder\": {\r\n \"title\": \"Mr.\",\r\n \"firstName\": \"John\",\r\n \"middleName\": \"Bruce\",\r\n \"lastName\": \"Bloggs\",\r\n \"dateOfBirth\": \"1982-02-19\",\r\n \"mobile\": \"07755123456\",\r\n \"email\": \"jbloggs@email.com\"\r\n },\r\n \"address\": {\r\n \"addressLine1\": \"32 Metropolis Ave\",\r\n \"addressLine2\": \"Mountain Drive\",\r\n \"city\": \"London\",\r\n \"postCode\": \"SW11 2LD\",\r\n \"country\": \"GBR\"\r\n },\r\n \"fulfilment\": {\r\n \"addressLine1\": \"32 Metropolis Ave\",\r\n \"addressLine2\": \"Mountain Drive\",\r\n \"city\": \"London\",\r\n \"postCode\": \"SW11 2LD\",\r\n \"country\": \"GBR\"\r\n },\r\n \"manufacturingDetails\":\r\n {\r\n \"deliveryMethod\": 0,\r\n \"carrierType\": \"Type 1\",\r\n \"language\": \"HU\",\r\n \"thermalLine1\": \"asdeoivh2neriuvnqkr\",\r\n \"thermalLine2\" : \"asjkfnkerjnkwe\",\r\n \"embossLine4\" : \"jdwncwlkejr\",\r\n \"vanityName\" : \"Name Mane\",\r\n \"imageDetails\":\r\n {\r\n \"imageId\": \"An image id\",\r\n \"logoFrontId\" : \"A logo ID\",\r\n \"logoBackId\": \"Another logo ID\"\r\n }\r\n \r\n \r\n }\r\n\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base-url}}core/api/v1/cards", "host": [ "{{base-url}}core" ], "path": [ "api", "v1", "cards" ] } }, "_postman_previewlanguage": "Text", "header": [], "cookie": [], "body": "" }, { "name": "Create a Master Virtual Card", "originalRequest": { "method": "POST", "header": [ { "key": "Postman-Token", "value": "", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Content-Length", "value": "", "type": "text" }, { "key": "Host", "value": "", "type": "text" }, { "key": "User-Agent", "value": "PostmanRuntime/7.30.0", "type": "text" }, { "key": "Accept", "value": "*/*", "type": "text" }, { "key": "Accept-Encoding", "value": "gzip, deflate, br", "type": "text" }, { "key": "Connection", "value": "keep-alive", "type": "text" } ], "body": { "mode": "raw", "raw": "{\r\n \"cardHolder\": {\r\n \"title\": \"Mr\",\r\n \"firstName\": \"Jon\",\r\n \"lastName\": \"Smith\",\r\n \"dateOfBirth\": \"1982-11-03\"\r\n },\r\n \"address\": {\r\n \"addressLine1\": \"32 Western Drive\",\r\n \"postCode\": \"S25 2BZ\",\r\n \"country\": \"GBR\"\r\n },\r\n \"fulfilment\": {\r\n \"addressLine1\": \"e43\",\r\n \"postCode\": \"34\",\r\n \"country\": \"GBR\"\r\n },\r\n \"virtualCardImageDetails\": {\r\n \"virtualCardImageId\": \"4155\",\r\n \"imageSize\": 1\r\n },\r\n \"cardType\": \"MasterVirtual\",\r\n \"cardProduct\": 10005,\r\n \"activateNow\": true,\r\n \"designId\": \"New Card Brand\",\r\n \"customerReference\": \"my ref 12345\"\r\n}\r\n", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base-url}}core/api/v1/cards", "host": [ "{{base-url}}core" ], "path": [ "api", "v1", "cards" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "", "type": "text" } ], "cookie": [], "body": "{\n \"publicToken\": \"103170245\",\n \"customerReference\": \"my ref 12345\",\n \"embossName\": \"Mr Jon Smith\",\n \"maskedPan\": \"999999******4212\",\n \"startDate\": \"2023-01-26\",\n \"expiryDate\": \"2024-01-31\"\n}" } ] }, { "name": "Retrieve Card", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{access_token}}", "type": "string" } ] }, "method": "GET", "header": [], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base-url}}core/api/v1/cards/{{publicToken}}", "host": [ "{{base-url}}core" ], "path": [ "api", "v1", "cards", "{{publicToken}}" ] }, "description": "The first \"Starter\" Core API request, for details of which APIs to call, what parameters to use etc see elsewhere \n[https://cardsapidocs.thredd.com/](https://cardsapidocs.thredd.com/)" }, "response": [ { "name": "Retrieve a Card", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{base-url}}core/api/v1/cards/{{publicToken}}", "host": [ "{{base-url}}core" ], "path": [ "api", "v1", "cards", "{{publicToken}}" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "" } ], "cookie": [], "body": "{\n \"cardType\": \"Physical\",\n \"publicToken\": \"638050230\",\n \t\"status\": \"Active\",\n \"cardStatusCode\": \"00\",\n \"cardStatusDescription\": \"00 (Active)\",\n \"balance\": {\n \"currencyCode\": \"GBP\",\n \"cardBalance\": 300.67,\n \"pendingAmount\": -74,\n \"availableBalance\": 226.67\n },\n \"cardDetails\": {\n \"customerReference\": \"CustNo12345A\",\n \"fullNameOnCard\": \"Mr. Bruce Simms\",\n \"maskedPan\": \"531610******0462\",\n \"startDate\": \"2023-10-23\",\n \"expiryDate\": \"2028-10-31\",\n \"clearPan\": null,\n \"cvv\": null,\n \"activationDate\": \"2024-05-14 08:31:33Z\"\n },\n \"cardHolder\": {\n \"title\": \"Mr\",\n \"firstName\": \"John\",\n \"middleName\": \"\",\n \"lastName\": \"Smith\",\n \"dateOfBirth\": \"1963-11-22\",\n \"mobile\": \"\",\n \"email\": \"\"\n },\n \"cardProduct\": {\n \"scheme\": \"Sandbox Scheme\",\n \"product\": 1234,\n \t\"productShortName\": \"Sandbox\",\n \"ehiMode\": 1\n },\n \"controlGroups\": {\n \"limitsGroup\": 1,\n \"usageGroup\": 0,\n \"recurringFeeGroup\": 0,\n \"webServiceFeeGroup\": -1,\n \"authFeeGroup\": 0,\n \"mccGroup\": 0,\n \"cardLinkageGroup\": 0,\n \"calendarGroup\": -1,\n \"fxGroup\": 0,\n \"paymentTokenUsageGroup\": 0,\n \t\"cardAcceptorAllowList\": 0,\n \"cardAcceptorDisallowList\": 0\n },\n \"3DS\": [],\n \"designId\": \"Sandbox\",\n \t\"childCards\": [],\n \"siblingCards\": [],\n \"address\": {\n \"addressLine1\": \"32 Eastern Lane\",\n \"addressLine2\": \"\",\n \"addressLine3\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"county\": \"\",\n \"postCode\": \"S11 7AA\",\n \"country\": \"826\"\n },\n \"fulfilment\": {\n \"addressLine1\": \"32 Eastern Lane\",\n \"addressLine2\": \"\",\n \"addressLine3\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"county\": \"\",\n \"postCode\": \"S11 7AA\",\n \"country\": \"826\"\n },\n \t \"freetext1\": \"Comments for the card manufacturer here\",\n \"freetext2\": \"And in this field too.\",\n \"IsSingleUse\" : \"true\",\n \"IsNonReloadable\" : \"false\",\n \"cardAcceptorIds\": {\n \"allowCardAcceptors\": [],\n \"disallowCardAcceptors\": []\n },\n \"language3ds\": null,\n \t\"programManagerID\": 78,\n \"programManagerCode\": \"PMT\"\n}" } ] }, { "name": "Update Card", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{access_token}}", "type": "string" } ] }, "method": "PATCH", "header": [], "body": { "mode": "raw", "raw": "{\r\n \"cardType\":\"Physical\",\r\n \"customerReference\": \"CustNo12345A\",\r\n \"freetext1\": \"Comments for the card manufacturer here\",\r\n \"freetext2\": \"And in this field too.\",\r\n \"nameOnCard\": \"Mr Johnny Bruce\",\r\n \"cardHolder\": {\r\n \"title\": \"Mr.\",\r\n \"firstName\": \"John\",\r\n \"middleName\": \"Bruce\",\r\n \"lastName\": \"Bloggs\",\r\n \"dateOfBirth\": \"1982-02-19\",\r\n \"mobile\": \"07755123456\",\r\n \"email\": \"jbloggs@email.com\"\r\n },\r\n \"address\": {\r\n \"addressLine1\": \"32 Metropolis Ave\",\r\n \"addressLine2\": \"Mountain Drive\",\r\n \"city\": \"London\",\r\n \"postCode\": \"SW11 2LD\",\r\n \"country\": \"GBR\"\r\n },\r\n \"fulfilment\": {\r\n \"addressLine1\": \"32 Metropolis Ave\",\r\n \"addressLine2\": \"Mountain Drive\",\r\n \"city\": \"London\",\r\n \"postCode\": \"SW11 2LD\",\r\n \"country\": \"GBR\"\r\n },\r\n \"manufacturingDetails\":\r\n {\r\n \"cardManufacturer\": \"AB Note\",\r\n \"deliveryMethod\": 0,\r\n \"carrierType\": \"Type 1\",\r\n \"quantity\": 1,\r\n \"language\": \"HU\",\r\n \"thermalLine1\": \"asdeoivh2neriuvnqkr\",\r\n \"thermalLine2\" : \"asjkfnkerjnkwe\",\r\n \"embossLine4\" : \"jdwncwlkejr\",\r\n \"vanityName\" : \"Name Mane\",\r\n \"imageDetails\":\r\n {\r\n \"imageId\": \"An image id\",\r\n \"logoFrontId\" : \"A logo ID\",\r\n \"logoBackId\": \"Another logo ID\"\r\n }\r\n }\r\n \r\n \r\n }", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base-url}}core/api/v1/cards/{{publicToken}}", "host": [ "{{base-url}}core" ], "path": [ "api", "v1", "cards", "{{publicToken}}" ] }, "description": "The first \"Starter\" Core API request, for details of which APIs to call, what parameters to use etc see elsewhere \n[https://cardsapidocs.thredd.com/](https://cardsapidocs.thredd.com/)" }, "response": [ { "name": "Update Card", "originalRequest": { "method": "PATCH", "header": [], "body": { "mode": "raw", "raw": "{\r\n \"cardType\":\"Physical\",\r\n \"customerReference\": \"CustNo12345A\",\r\n \"freetext1\": \"Comments for the card manufacturer here\",\r\n \"freetext2\": \"And in this field too.\",\r\n \"nameOnCard\": \"Mr Johnny Bruce\"\r\n \"cardHolder\": {\r\n \"title\": \"Mr.\",\r\n \"firstName\": \"John\",\r\n \"middleName\": \"Bruce\",\r\n \"lastName\": \"Bloggs\",\r\n \"dateOfBirth\": \"1982-02-19\",\r\n \"mobile\": \"07755123456\",\r\n \"email\": \"jbloggs@email.com\"\r\n },\r\n \"address\": {\r\n \"addressLine1\": \"32 Metropolis Ave\",\r\n \"addressLine2\": \"Mountain Drive\",\r\n \"city\": \"London\",\r\n \"postCode\": \"SW11 2LD\",\r\n \"country\": \"GBR\"\r\n },\r\n \"fulfilment\": {\r\n \"addressLine1\": \"32 Metropolis Ave\",\r\n \"addressLine2\": \"Mountain Drive\",\r\n \"city\": \"London\",\r\n \"postCode\": \"SW11 2LD\",\r\n \"country\": \"GBR\"\r\n },\r\n \"manufacturingDetails\":\r\n {\r\n \"cardManufacturer\": \"AB Note\",\r\n \"deliveryMethod\": 0,\r\n \"carrierType\": \"Type 1\",\r\n \"quantity\": 1,\r\n \"language\": \"HU\",\r\n \"thermalLine1\": \"asdeoivh2neriuvnqkr\",\r\n \"thermalLine2\" : \"asjkfnkerjnkwe\",\r\n \"embossLine4\" : \"jdwncwlkejr\",\r\n \"vanityName\" : \"Name Mane\",\r\n \"imageDetails\":\r\n {\r\n \"imageId\": \"An image id\",\r\n \"logoFrontId\" : \"A logo ID\",\r\n \"logoBackId\": \"Another logo ID\"\r\n }\r\n }\r\n \r\n \r\n }", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base-url}}core/api/v1/cards/{{publicToken}}", "host": [ "{{base-url}}core" ], "path": [ "api", "v1", "cards", "{{publicToken}}" ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "", "type": "text" } ], "cookie": [], "body": "" } ] }, { "name": "Renew Card", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{access_token}}", "type": "string" } ] }, "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\r\n \"renewStep\" : \"renew\"\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base-url}}core/api/v1/cards/{{publicToken}}/renew", "host": [ "{{base-url}}core" ], "path": [ "api", "v1", "cards", "{{publicToken}}", "renew" ] }, "description": "The first \"Starter\" Core API request, for details of which APIs to call, what parameters to use etc see elsewhere \n[https://cardsapidocs.thredd.com/](https://cardsapidocs.thredd.com/)" }, "response": [ { "name": "Renew Virtual Card", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base-url}}core/api/v1/cards/{{publicToken}}/renew", "host": [ "{{base-url}}core" ], "path": [ "api", "v1", "cards", "{{publicToken}}", "renew" ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "Text", "header": [], "cookie": [], "body": "" }, { "name": "Renew Physical Card", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\r\n \"renewStep\" : \"renew\"\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base-url}}core/api/v1/cards/{{publicToken}}/renew", "host": [ "{{base-url}}core" ], "path": [ "api", "v1", "cards", "{{publicToken}}", "renew" ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "Text", "header": [], "cookie": [], "body": "" }, { "name": "Renew a card with same expiry", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\r\n \"renewStep\" : \"RenewWithSameExpiry\"\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base-url}}core/api/v1/cards/{{publicToken}}/renew", "host": [ "{{base-url}}core" ], "path": [ "api", "v1", "cards", "{{publicToken}}", "renew" ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "", "type": "text" } ], "cookie": [], "body": "" }, { "name": "Migrate card", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\r\n \"renewStep\" : \"migrate\"\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base-url}}core/api/v1/cards/{{publicToken}}/renew", "host": [ "{{base-url}}core" ], "path": [ "api", "v1", "cards", "{{publicToken}}", "renew" ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "Text", "header": [], "cookie": [], "body": "" } ] }, { "name": "Replace Card", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{access_token}}", "type": "string" } ] }, "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\r\n \"moveBalance\": true,\r\n \"moveLimitAccumulators\": true,\r\n \"moveChildCards\": false,\r\n \"moveExpiryDate\": false,\r\n \"expiryDate\": \"2023-04\"\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base-url}}core/api/v1/cards/{{publicToken}}/replace", "host": [ "{{base-url}}core" ], "path": [ "api", "v1", "cards", "{{publicToken}}", "replace" ] }, "description": "The first \"Starter\" Core API request, for details of which APIs to call, what parameters to use etc see elsewhere \n[https://cardsapidocs.thredd.com/](https://cardsapidocs.thredd.com/)" }, "response": [ { "name": "Replace a Card", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\r\n \"moveBalance\": true,\r\n \"moveLimitAccumulators\": true,\r\n \"moveChildCards\": false,\r\n \"moveExpiryDate\": false,\r\n \"expiryDate\": \"2023-04\"\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base-url}}core/api/v1/cards/{{publicToken}}/replace", "host": [ "{{base-url}}core" ], "path": [ "api", "v1", "cards", "{{publicToken}}", "replace" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "", "type": "text" } ], "cookie": [], "body": "{\n \"publicToken\": \"103169963\",\n \"customerReference\": \"my ref 12345\",\n \"embossName\": \"Mr Jon Smith\",\n \"maskedPan\": \"999999******5974\",\n \"startDate\": \"2023-05-05\",\n \"expiryDate\": \"2023-04-30\"\n}" } ] }, { "name": "Get Full PAN", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{access_token}}", "type": "string" } ] }, "method": "GET", "header": [], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base-url}}core/api/v1/cards/{{publicToken}}/showpan", "host": [ "{{base-url}}core" ], "path": [ "api", "v1", "cards", "{{publicToken}}", "showpan" ] } }, "response": [ { "name": "Get Full PAN", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{base-url}}core/api/v1/cards/{{publicToken}}/showpan", "host": [ "{{base-url}}core" ], "path": [ "api", "v1", "cards", "{{publicToken}}", "showpan" ] } }, "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "", "type": "text" } ], "cookie": [], "body": "{\n \"cardType\": \"Physical\",\n \"publicToken\": \"103170027\",\n \"status\": \"Active\",\n \"cardStatusCode\": \"00\",\n \"cardStatusDescription\": \"00 (Active)\",\n \"balance\": {\n \"currencyCode\": \"GBP\",\n \"cardBalance\": 1000,\n \"pendingAmount\": 0,\n \"availableBalance\": 1000\n },\n \"cardDetails\": {\n \"customerReference\": \"CustNo12345A\",\n \"fullNameOnCard\": \"Mr Johnny Bloggs\",\n \"maskedPan\": \"9999999042424199\",\n \"startDate\": \"2023-05-26\",\n \"expiryDate\": \"2028-06-30\"\n },\n \"cardHolder\": {\n \"title\": \"Mr.\",\n \"firstName\": \"John\",\n \"middleName\": \"Bruce\",\n \"lastName\": \"Bloggs\",\n \"dateOfBirth\": \"1982-02-19\",\n \"mobile\": \"07755123456\",\n \"email\": \"jbloggs@email.com\"\n },\n \"cardProduct\": {\n \"scheme\": \"GPS VIRTUAL SCHEME TEST\",\n \"product\": 10005,\n \"productShortName\": \"GPSDUMMY\"\n },\n \"controlGroups\": {\n \"limitsGroup\": 1201,\n \"usageGroup\": 0,\n \"recurringFeeGroup\": 0,\n \"webServiceFeeGroup\": 0,\n \"authFeeGroup\": 786,\n \"mccGroup\": 0,\n \"cardLinkageGroup\": 0,\n \"calendarGroup\": 0,\n \"fxGroup\": 0,\n \"paymentTokenUsageGroup\": 20\n },\n \"3DS\": [\n {\n \"configuration\": \"RDX\",\n \"defaultCredentials\": [\n {\n \"type\": \"OTPSMS\",\n \"value\": \"286999\",\n \"id\": 1909236\n }\n ],\n \"fallbackCredentials\": {\n \"type\": \"BIOMETRIC\",\n \"value\": \"8988\",\n \"id\": 2008233\n }\n }\n ],\n \"designId\": \"New Card Brand\",\n \"childCards\": [],\n \"siblingCards\": [],\n \"address\": {\n \"addressLine1\": \"32 Metropolis Ave\",\n \"addressLine2\": \"Mountain Drive\",\n \"addressLine3\": \"\",\n \"city\": \"London\",\n \"state\": \"\",\n \"county\": \"Essex\",\n \"postCode\": \"SW11 2LD\",\n \"country\": \"826\"\n },\n \"fulfilment\": {\n \"addressLine1\": \"32 Metropolis Ave\",\n \"addressLine2\": \"Mountain Drive\",\n \"addressLine3\": \"\",\n \"city\": \"London\",\n \"state\": \"\",\n \"county\": \"\",\n \"postCode\": \"SW11 2LD\",\n \"country\": \"826\"\n },\n \"freetext1\": \"Comments for the card manufacturer here\",\n \"freetext2\": \"And in this field too.\"\n}" } ] }, { "name": "Retrieve Card Status", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{access_token}}", "type": "string" } ] }, "method": "GET", "header": [], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base-url}}core/api/v1/cards/{{publicToken}}/status", "host": [ "{{base-url}}core" ], "path": [ "api", "v1", "cards", "{{publicToken}}", "status" ] }, "description": "The first \"Starter\" Core API request, for details of which APIs to call, what parameters to use etc see elsewhere \n[https://cardsapidocs.thredd.com/](https://cardsapidocs.thredd.com/)" }, "response": [] }, { "name": "Update Card Status", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{access_token}}", "type": "string" } ] }, "method": "PUT", "header": [], "body": { "mode": "raw", "raw": "{\r\n \"cardStatusCode\": \"00\",\r\n \"updatedBy\": \"John Bloggs\",\r\n \"description\": \"Card activated\",\r\n \"validityDate\": \"2023-02\"\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base-url}}core/api/v1/cards/{{publicToken}}/status", "host": [ "{{base-url}}core" ], "path": [ "api", "v1", "cards", "{{publicToken}}", "status" ] }, "description": "The first \"Starter\" Core API request, for details of which APIs to call, what parameters to use etc see elsewhere \n[https://cardsapidocs.thredd.com/](https://cardsapidocs.thredd.com/)" }, "response": [] }, { "name": "List Card Balance", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{access_token}}", "type": "string" } ] }, "method": "GET", "header": [], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base-url}}core/api/v1/cards/{{publicToken}}/balance", "host": [ "{{base-url}}core" ], "path": [ "api", "v1", "cards", "{{publicToken}}", "balance" ] }, "description": "The first \"Starter\" Core API request, for details of which APIs to call, what parameters to use etc see elsewhere \n[https://cardsapidocs.thredd.com/](https://cardsapidocs.thredd.com/)" }, "response": [] }, { "name": "Convert Card", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{access_token}}", "type": "string" } ] }, "method": "PUT", "header": [], "body": { "mode": "raw", "raw": "{\r\n \"cardType\": 2\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base-url}}core/api/v1/cards/{{publicToken}}/card-type", "host": [ "{{base-url}}core" ], "path": [ "api", "v1", "cards", "{{publicToken}}", "card-type" ] }, "description": "The first \"Starter\" Core API request, for details of which APIs to call, what parameters to use etc see elsewhere \n[https://cardsapidocs.thredd.com/](https://cardsapidocs.thredd.com/)" }, "response": [] }, { "name": "Get Card Image", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{access_token}}", "type": "string" } ] }, "method": "GET", "header": [], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base-url}}core/api/v1/cards/{{publicToken}}/image", "host": [ "{{base-url}}core" ], "path": [ "api", "v1", "cards", "{{publicToken}}", "image" ] }, "description": "The first \"Starter\" Core API request, for details of which APIs to call, what parameters to use etc see elsewhere \n[https://cardsapidocs.thredd.com/](https://cardsapidocs.thredd.com/)" }, "response": [] }, { "name": "Get Cardholder Details", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{access_token}}", "type": "string" } ] }, "method": "GET", "header": [], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base-url}}core/api/v1/cardholder/{{publicToken}}", "host": [ "{{base-url}}core" ], "path": [ "api", "v1", "cardholder", "{{publicToken}}" ] }, "description": "The first \"Starter\" Core API request, for details of which APIs to call, what parameters to use etc see elsewhere \n[https://cardsapidocs.thredd.com/](https://cardsapidocs.thredd.com/)" }, "response": [] }, { "name": "Complete a Card Replacement", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{access_token}}", "type": "string" } ] }, "method": "PUT", "header": [], "body": { "mode": "raw", "raw": "{\r\n \"moveBalance\": true,\r\n \"moveLimitAccumulators\": true,\r\n \"moveChildCards\": false,\r\n \"moveExpiryDate\": true\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base-url}}core/api/v1/cards/{{publicToken}}/complete-replacement", "host": [ "{{base-url}}core" ], "path": [ "api", "v1", "cards", "{{publicToken}}", "complete-replacement" ] }, "description": "The first \"Starter\" Core API request, for details of which APIs to call, what parameters to use etc see elsewhere \n[https://cardsapidocs.thredd.com/](https://cardsapidocs.thredd.com/)" }, "response": [] }, { "name": "Get Card Limits", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{access_token}}", "type": "string" } ] }, "method": "GET", "header": [], "url": { "raw": "{{base-url}}core/api/v1/cards/{{publicToken}}/balance/cardlimits", "host": [ "{{base-url}}core" ], "path": [ "api", "v1", "cards", "{{publicToken}}", "balance", "cardlimits" ] } }, "response": [ { "name": "Get Card Limits", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{base-url}}core/api/v1/cards/{{publicToken}}/balance/cardlimits", "host": [ "{{base-url}}core" ], "path": [ "api", "v1", "cards", "{{publicToken}}", "balance", "cardlimits" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "", "type": "text" } ], "cookie": [], "body": "{\r\n \"availableBalance\": 0,\r\n \"maxAllowableBalance\": 5000,\r\n \"currencyCode\": \"GBP\",\r\n \"blockedAmount\": 0,\r\n \"cardLimits\": [\r\n {\r\n \"subGroup\": \"CASH\",\r\n \"period\": 0,\r\n \"unit\": \"day\",\r\n \"limit\": 0,\r\n \"frequency\": 0,\r\n \"spent\": 0,\r\n \"transactionCount\": 0,\r\n },\r\n {\r\n \"subGroup\": \"LOAD\",\r\n \"period\": 4,\r\n \"unit\": \"day\",\r\n \"limit\": 4000,\r\n \"frequency\": 8,\r\n \"spent\": 0,\r\n \"transactionCount\": 0,\r\n },\r\n {\r\n \"subGroup\": \"PAY_IN\",\r\n \"period\": 0,\r\n \"unit\": \"day\",\r\n \"limit\": 0,\r\n \"frequency\": 0,\r\n \"spent\": 0,\r\n \"transactionCount\": 0,\r\n },\r\n {\r\n \"subGroup\": \"PAY_OUT\",\r\n \"period\": 0,\r\n \"unit\": \"day\",\r\n \"limit\": 0,\r\n \"frequency\": 0,\r\n \"spent\": 0,\r\n \"transactionCount\": 0,\r\n },\r\n {\r\n \"subGroup\": \"PIN\",\r\n \"period\": 4,\r\n \"unit\": \"day\",\r\n \"limit\": 0,\r\n \"frequency\": 6,\r\n \"spent\": 0,\r\n \"transactionCount\": 0,\r\n },\r\n {\r\n \"subGroup\": \"POS\",\r\n \"period\": 4,\r\n \"unit\": \"day\",\r\n \"limit\": 4000,\r\n \"frequency\": 400,\r\n \"spent\": 0,\r\n \"transactionCount\": 0,\r\n },\r\n {\r\n \"subGroup\": \"UNLOAD\",\r\n \"period\": 4,\r\n \"unit\": \"day\",\r\n \"limit\": 750,\r\n \"frequency\": 8,\r\n \"spent\": 0,\r\n \"transactionCount\": 0,\r\n }\r\n ]\r\n}" } ] }, { "name": "Retrieve an Encrypted Card", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{access_token}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"key\": \"1bCumLAf8vrciAcRmeWrE7WBisRNnx/870uKUKSAGuM=\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{base-url}}core/api/v1/cards/{{publicToken}}/encrypted", "host": [ "{{base-url}}core" ], "path": [ "api", "v1", "cards", "{{publicToken}}", "encrypted" ] }, "description": "The Get Encrypted Data endpoint enables you to share secure card data to a cardholder's device.\n\nYou can get encrypted data by making a POST request to the Get Encrypted Data endpoint.\n\nFor more information, see [Introduction to Sending Secure Data](https://cardsapidocs.thredd.com/docs/introduction-to-sending-secure-data)." }, "response": [ { "name": "Retrieve an Encrypted Card", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"key\": \"1bCumLAf8vrciAcRmeWrE7WBisRNnx/870uKUKSAGuM=\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{base-url}}core/api/v1/cards/{{publicToken}}/encrypted", "host": [ "{{base-url}}core" ], "path": [ "api", "v1", "cards", "{{publicToken}}", "encrypted" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "", "type": "text" } ], "cookie": [], "body": "{\n \"iv\": \"6gq/DgXSllG/U+fVjlWV6Q==\",\n \"encryptedPayload\": \"shLEyy/H/6BYqS3zI9oHI0UBaK2x6s0ZPWRITkZYFItBN8p+UDc/xX0binhN9J7LbNAIt4LkBv2n3MSKs3+3Gg==\",\n \"signatureOfPayloadAndIv\": \"mk0GpVNR6ksQFpWS5m4boCS8WJSB4Popuikce+W0eubFH2vMcQ3XyASqnG0rKNaKW0MbgI7V6u5ZkbPllhroczn01ZhZAwYUWPD72KFpe4bBZjAjzdPkBzYc2SBybUBRey/5Q2VuGGlBG0hw/LmHRfOqCh1sA9EFE/c06jjCvGcqPmV6dAIKzE6/JK8oG+9JU89b+cznuKAJPa/qhX1f0VZkLriXMTu7Fv6wPF0gFnETDJJW0J/va7O5zynlvxYs86umP2h5MM2+/RgFzPOnleeE5mczlPGPtFS+KRuUWAQL2CwnWI+JLMEAeUngFE3wWic8h8GzIEVpWPeuNcaPxA==\"\n}" } ] }, { "name": "Create Bulk Cards", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{access_token}}", "type": "string" } ] }, "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\r\n \"cardProduct\": 123456,\r\n \"quantity\": 50,\r\n \"nameOnCard\": \"Thredd\",\r\n \"imageId\": \"101\",\r\n \"deliveryMethod\": \"StandardDelivery\",\r\n \"fulfilmentAddress\": {\r\n \"addressLine1\": \"32 Eastern Road\",\r\n \"city\": \"Sheffield\",\r\n \"county\": \"South Yorkshire\",\r\n \"postCode\": \"S11 8AA\",\r\n \"country\": \"GBR\"\r\n },\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base-url}}core/api/v1/cards/bulk", "host": [ "{{base-url}}core" ], "path": [ "api", "v1", "cards", "bulk" ] }, "description": "The Bulk Create Card endpoint enables you to create in bulk a number of non personalised cards (For example, creating gift cards, or rolling out new products) in a single request. Cards created by the Bulk Create Cards endpoint can be viewed in the Get Bulk Cards endpoint.\n\nFor more information, see [Bulk Create Cards](https://cardsapidocs.thredd.com/docs/bulk-create-cards)." }, "response": [ { "name": "Create Bulk Cards", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\r\n \"cardProduct\": 123456,\r\n \"quantity\": 5\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base-url}}core/api/v1/cards/bulk", "host": [ "{{base-url}}core" ], "path": [ "api", "v1", "cards", "bulk" ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "", "type": "text" } ], "cookie": [], "body": "{\n \"id\": \"123456\"\n}" } ] }, { "name": "Get Bulk Card Requests", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{access_token}}", "type": "string" } ] }, "method": "GET", "header": [], "url": { "raw": "{{base-url}}core/api/v1/cards/bulk?bulkCardRequestId=26145", "host": [ "{{base-url}}core" ], "path": [ "api", "v1", "cards", "bulk" ], "query": [ { "key": "bulkCardRequestId", "value": "26145" } ] }, "description": "The Get Bulk Cards endpoint enables you to retrieve public tokens created from the bulk create card process using the unique identifier output from a successful response.\n\nFor more information, see [Bulk Create Cards](https://cardsapidocs.thredd.com/docs/bulk-create-cards)." }, "response": [ { "name": "Get Bulk Card Requests", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{base-url}}/api/v1/cards/bulk?bulkCardRequestId=", "host": [ "{{base-url}}" ], "path": [ "api", "v1", "cards", "bulk" ], "query": [ { "key": "bulkCardRequestId", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "name": "Content-Type", "description": "", "type": "text" } ], "cookie": [], "body": "{\r\n \"tokens\": {\r\n 123456789,\r\n 987654321\r\n },\r\n \"pageNumber\": 2147483647,\r\n \"total\": 50,\r\n \"pageSize\": 6\r\n}" } ] }, { "name": "Get Bulk Tokens", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{access_token}}", "type": "string" } ] }, "method": "GET", "header": [], "url": { "raw": "{{base-url}}core/api/v1/cards/bulk/tokens?bulkCardRequestId=&pageNumber=&pageSize=", "host": [ "{{base-url}}core" ], "path": [ "api", "v1", "cards", "bulk", "tokens" ], "query": [ { "key": "bulkCardRequestId", "value": "" }, { "key": "pageNumber", "value": "" }, { "key": "pageSize", "value": "" } ] } }, "response": [ { "name": "Get Bulk Tokens", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{base-url}}/cards/bulk/tokens?bulkCardRequestId=12345&pageNumber=2&pageSize=1", "host": [ "{{base-url}}" ], "path": [ "cards", "bulk", "tokens" ], "query": [ { "key": "bulkCardRequestId", "value": "12345" }, { "key": "pageNumber", "value": "2" }, { "key": "pageSize", "value": "1" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "name": "Content-Type", "description": "", "type": "text" } ], "cookie": [], "body": "{\n \"tokens\": [\n 115794151,\n 123456789\n ],\n \"pageNumber\": 2,\n \"total\": 2,\n \"pageSize\": 1\n}" } ] } ] }, { "name": "Groups", "item": [ { "name": "List Card Control Groups for Product ID", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{access_token}}", "type": "string" } ] }, "method": "GET", "header": [], "url": { "raw": "{{base-url}}core/api/v1/products/{{productId}}/groups", "host": [ "{{base-url}}core" ], "path": [ "api", "v1", "products", "{{productId}}", "groups" ] } }, "response": [] }, { "name": "List Card Control Groups", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{access_token}}", "type": "string" } ] }, "method": "GET", "header": [], "url": { "raw": "{{base-url}}core/api/v1/groups", "host": [ "{{base-url}}core" ], "path": [ "api", "v1", "groups" ] }, "description": "This endpoint enables you to list the control groups for your card program.\n\nFor more information on how to list card control groups, see [Managing Card Usage Groups](https://cardsapidocs.thredd.com/docs/card-controls)." }, "response": [ { "name": "List Card Control Groups", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{base-url}}core/api/v1/groups", "host": [ "{{base-url}}core" ], "path": [ "api", "v1", "groups" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "" } ], "cookie": [], "body": "[\n {\n \"groupType\": \"4\",\n \"groupTypeName\": \"AuthFeeGroup\",\n \"groups\": [\n {\n \"id\": 786,\n \"code\": \"TEST\",\n \"description\": \"TEST\"\n },\n {\n \"id\": 1063,\n \"code\": \"TEST-1\",\n \"description\": \"TEST 1\"\n },\n {\n \"id\": 1137,\n \"code\": \"TEST-2\",\n \"description\": \"Tran Test\"\n },\n {\n \"id\": 1202,\n \"code\": \"NEW-TEST-1\",\n \"description\": \"MENA TEST 1\"\n },\n {\n \"id\": 1221,\n \"code\": \"TEST008\",\n \"description\": \"Test 08\"\n }\n ]\n }\n]" } ] }, { "name": "Update Card Control Groups", "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Your test name\", function () {\r", " var jsonData = pm.response.json();\r", " pm.expect(jsonData.value).to.eql(100);\r", "});" ], "type": "text/javascript", "packages": {}, "requests": {} } } ], "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{access_token}}", "type": "string" } ] }, "method": "PUT", "header": [], "body": { "mode": "raw", "raw": "{\r\n \"controlGroups\": {\r\n \"authFeeGroup\": 786 \r\n }\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base-url}}core/api/v1/cards/{{publicToken}}/groups", "host": [ "{{base-url}}core" ], "path": [ "api", "v1", "cards", "{{publicToken}}", "groups" ] }, "description": "This endpoint enables you to update the control groups that define the card behaviour." }, "response": [ { "name": "Update Card Control Groups", "originalRequest": { "method": "PUT", "header": [], "body": { "mode": "raw", "raw": "{\r\n \"controlGroups\": {\r\n \"authFeeGroup\": 786 \r\n }\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base-url}}core/api/v1/cards/{{publicToken}}/groups", "host": [ "{{base-url}}core" ], "path": [ "api", "v1", "cards", "{{publicToken}}", "groups" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "", "type": "text" } ], "cookie": [], "body": "{\n \"limitsGroup\": 1051,\n \"usageGroup\": 374,\n \"recurringFeeGroup\": 0,\n \"webServiceFeeGroup\": 0,\n \"authFeeGroup\": 786,\n \"mccGroup\": 0,\n \"cardLinkageGroup\": 0,\n \"calendarGroup\": 0,\n \"fxGroup\": 0,\n \"paymentTokenUsageGroup\": 0,\n \"cardAcceptorAllowList\": 0,\n \"cardAcceptorDisallowList\": 0,\n \"limitedNetworkGroup\": 0\n}" } ] } ] }, { "name": "3D Secure", "item": [ { "name": "Create 3DS Credentials", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{access_token}}", "type": "string" } ] }, "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\r\n\"type\":\"OTPSMS\",\r\n\"value\": \"8988\"\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base-url}}core/api/v1/cards/{{publicToken}}/3ds-credentials", "host": [ "{{base-url}}core" ], "path": [ "api", "v1", "cards", "{{publicToken}}", "3ds-credentials" ] }, "description": "This endpoint enables you to create 3D Secure authorisation credential for a card.\n\nFor more information on how to create 3DS credentials, see [Managing 3D Secure Credentials](https://cardsapidocs.thredd.com/docs/creating-3d-secure-credentials)." }, "response": [ { "name": "Create 3DS Credentials", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\r\n\"type\":\"OTPSMS\",\r\n\"value\": \"8988\"\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base-url}}core/api/v1/cards/{{publicToken}}/3ds-credentials", "host": [ "{{base-url}}core" ], "path": [ "api", "v1", "cards", "{{publicToken}}", "3ds-credentials" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "", "type": "text" } ], "cookie": [], "body": "{\r\n \"identifier\": 1864825\r\n}" } ] }, { "name": "List 3DS Credentials", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{access_token}}", "type": "string" } ] }, "method": "GET", "header": [], "url": { "raw": "{{base-url}}core/api/v1/cards/{{publicToken}}/3ds-credentials", "host": [ "{{base-url}}core" ], "path": [ "api", "v1", "cards", "{{publicToken}}", "3ds-credentials" ] }, "description": "This endpoint enables you to list the 3D Secure authorisation credentials for a card.\n\nFor more information on how to list 3DS credentials, see [Managing 3D Secure Credentials](https://cardsapidocs.thredd.com/docs/creating-3d-secure-credentials)." }, "response": [ { "name": "List 3DS Credentials", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{base-url}}core/api/v1/cards/{{publicToken}}/3ds-credentials", "host": [ "{{base-url}}core" ], "path": [ "api", "v1", "cards", "{{publicToken}}", "3ds-credentials" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "", "type": "text" } ], "cookie": [], "body": "[\n {\n \"type\": \"OTPSMS\",\n \"value\": \"8988\",\n \"id\": 1864825\n }\n]" } ] }, { "name": "Update 3DS Credentials", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{access_token}}", "type": "string" } ] }, "method": "PUT", "header": [], "body": { "mode": "raw", "raw": "{\r\n\r\n \"value\": \"286999\"\r\n\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base-url}}core/api/v1/cards/{{publicToken}}/3ds-credentials/{{3dsCredentialId}}", "host": [ "{{base-url}}core" ], "path": [ "api", "v1", "cards", "{{publicToken}}", "3ds-credentials", "{{3dsCredentialId}}" ] }, "description": "This endpoint enables you to update the 3D Secure authorisation credential for a card.\n\nFor more information on how to update 3DS credentials, see [Managing 3D Secure Credentials](https://cardsapidocs.thredd.com/docs/creating-3d-secure-credentials)." }, "response": [ { "name": "Update 3DS Credentials", "originalRequest": { "method": "PUT", "header": [], "body": { "mode": "raw", "raw": "{\r\n\r\n \"value\": \"janedoe@email.com\"\r\n\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base-url}}core/api/v1/cards/{{publicToken}}/3ds-credentials/2222", "host": [ "{{base-url}}core" ], "path": [ "api", "v1", "cards", "{{publicToken}}", "3ds-credentials", "2222" ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "", "type": "text" } ], "cookie": [], "body": "" } ] }, { "name": "Delete 3DS Credentials", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{access_token}}", "type": "string" } ] }, "method": "DELETE", "header": [], "body": { "mode": "raw", "raw": "" }, "url": { "raw": "{{base-url}}core/api/v1/cards/{{publicToken}}/3ds-credentials/{{3dsCredentialId}}", "host": [ "{{base-url}}core" ], "path": [ "api", "v1", "cards", "{{publicToken}}", "3ds-credentials", "{{3dsCredentialId}}" ] }, "description": "This endpoint enables you to delete 3D Secure authorisation credentials for a card.\n\nFor more information on how to delete 3DS credentials, see [Managing 3D Secure Credentials](https://cardsapidocs.thredd.com/docs/creating-3d-secure-credentials)." }, "response": [ { "name": "Delete 3DS Credentials", "originalRequest": { "method": "DELETE", "header": [], "body": { "mode": "raw", "raw": "" }, "url": { "raw": "{{base-url}}core/api/v1/cards/{{publicToken}}/3ds-credentials/2222", "host": [ "{{base-url}}core" ], "path": [ "api", "v1", "cards", "{{publicToken}}", "3ds-credentials", "2222" ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "", "type": "text" } ], "cookie": [], "body": "" } ] }, { "name": "Get 3DS Configuration", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{access_token}}", "type": "string" } ] }, "method": "GET", "header": [], "url": { "raw": "{{base-url}}core/api/v1/cards/{{publicToken}}/3ds-configuration", "host": [ "{{base-url}}core" ], "path": [ "api", "v1", "cards", "{{publicToken}}", "3ds-configuration" ] } }, "response": [ { "name": "Get 3DS Configuration", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{base-url}}core/api/v1/cards/{{publicToken}}/3ds-configuration", "host": [ "{{base-url}}core" ], "path": [ "api", "v1", "cards", "{{publicToken}}", "3ds-configuration" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "" } ], "cookie": [], "body": "{\r\n \"provider\": 4,\r\n \"providerName\": \"Apata\",\r\n \"version\": \"Apata\",\r\n \"programManager\": {\r\n \"programManagerCode\": \"PMT\",\r\n \"shortName\": \"GPSDUMMY\"\r\n },\r\n \"mobile\": \"8988\",\r\n \"email\": null,\r\n \"isActive\": true,\r\n \"status\": \"00\",\r\n \"has3dSecureCredentialEntry\": true,\r\n \"apataConfig\": {\r\n \"cardProgramId\": \"sudbhcfndjfncvfhgn\",\r\n \"challengeProfileId\": \"rshgbvbhmbhverdctgvrwe\",\r\n \"financialInstitutionId\": \"egegdfbvcvskdfng\",\r\n \"numberOfQuestionsToAnswer\": 0,\r\n \"numberIncorrectPermissible\": 0,\r\n \"language\": \"en-EN\"\r\n },\r\n \"kba\": [],\r\n \"otpSms\": {\r\n \"otpSmsTemplateFullFormat\": null,\r\n \"otpSmsTemplateDefaultFormat\": null\r\n },\r\n \"biometric\": {\r\n \"autoEnrol3DSBiometrics\": 0,\r\n \"autoEnrol3DSOOB\": 0,\r\n \"biometricUrl\": null,\r\n \"hasBiometricCredentials\": false,\r\n \"hasOOBCredentials\": false\r\n }\r\n}" } ] } ] }, { "name": "Card PIN", "item": [ { "name": "Get PIN", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{access_token}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "accept", "value": "application/json" } ], "url": { "raw": "{{base-url}}core/api/v1/cards/{{publicToken}}/pin", "host": [ "{{base-url}}core" ], "path": [ "api", "v1", "cards", "{{publicToken}}", "pin" ] }, "description": "This endpoint enables you to retrieve the PIN for a card in plain text.\n\nFor more information on how to retrieve a card PIN, see [PIN Management](https://cardsapidocs.thredd.com/docs/card-personal-identification-number-pin)." }, "response": [ { "name": "Get PIN", "originalRequest": { "method": "GET", "header": [ { "key": "accept", "value": "application/json" } ], "url": { "raw": "{{base-url}}core/api/v1/cards/{{publicToken}}/pin", "host": [ "{{base-url}}core" ], "path": [ "api", "v1", "cards", "{{publicToken}}", "pin" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "", "type": "text" } ], "cookie": [], "body": "{\r\n \"pin\": \"0028\"\r\n}" } ] }, { "name": "Set PIN", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{access_token}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\r\n \"cardPin\": \"1234\"\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base-url}}core/api/v1/cards/{{publicToken}}/pin", "host": [ "{{base-url}}core" ], "path": [ "api", "v1", "cards", "{{publicToken}}", "pin" ] }, "description": "This end point enables you to set a PIN for the card. This will overwrite the PIN allocated to the card during card creation.\n\nFor more information on how to set a PIN, see [PIN Management](https://cardsapidocs.thredd.com/docs/card-personal-identification-number-pin)." }, "response": [ { "name": "Set PIN", "originalRequest": { "method": "POST", "header": [ { "key": "accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\r\n \"cardPin\": \"1234\"\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base-url}}core/api/v1/cards/{{publicToken}}/pin", "host": [ "{{base-url}}core" ], "path": [ "api", "v1", "cards", "{{publicToken}}", "pin" ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "", "type": "text" } ], "cookie": [], "body": "" } ] }, { "name": "Get PIN Status", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{access_token}}", "type": "string" } ] }, "method": "GET", "header": [], "url": { "raw": "{{base-url}}core/api/v1/cards/{{publicToken}}/pin/status", "host": [ "{{base-url}}core" ], "path": [ "api", "v1", "cards", "{{publicToken}}", "pin", "status" ] }, "description": "This endpoint enables you to retrieve the current status of the card's PIN.\n\nFor more information on how to get a PIN's status, see [PIN Management](https://cardsapidocs.thredd.com/docs/card-personal-identification-number-pin)." }, "response": [ { "name": "Get PIN Status", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{base-url}}core/api/v1/cards/{{publicToken}}/pin/status", "host": [ "{{base-url}}core" ], "path": [ "api", "v1", "cards", "{{publicToken}}", "pin", "status" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "", "type": "text" } ], "cookie": [], "body": "{\n \"status\": \"Unblocked\",\n \"remainingTries\": \"3\"\n}" } ] }, { "name": "Unblock PIN", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{access_token}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base-url}}core/api/v1/cards/{{publicToken}}/pin/unblock", "host": [ "{{base-url}}core" ], "path": [ "api", "v1", "cards", "{{publicToken}}", "pin", "unblock" ] }, "description": "This endpoint enables you to unblock a PIN for a card.\n\nFor more information on how to unblock a card PIN, see [PIN Management](https://cardsapidocs.thredd.com/docs/card-personal-identification-number-pin)." }, "response": [ { "name": "Unblock PIN", "originalRequest": { "method": "POST", "header": [ { "key": "accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base-url}}core/api/v1/cards/{{publicToken}}/pin/unblock", "host": [ "{{base-url}}core" ], "path": [ "api", "v1", "cards", "{{publicToken}}", "pin", "unblock" ] } }, "_postman_previewlanguage": "Text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "Card CVV", "item": [ { "name": "Get CVV", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{access_token}}", "type": "string" } ] }, "method": "GET", "header": [], "url": { "raw": "{{base-url}}core/api/v1/cards/{{publicToken}}/cvv", "host": [ "{{base-url}}core" ], "path": [ "api", "v1", "cards", "{{publicToken}}", "cvv" ] }, "description": "This endpoint enables you to retrieve a card's Card Verification Value (CVV).\n\nFor more information on how to retrieve a card CVV, see [Card Verification Value (CVV)](https://cardsapidocs.thredd.com/docs/card-verification-value-cvv)." }, "response": [ { "name": "Get CVV", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{base-url}}core/api/v1/cards/{{publicToken}}/cvv", "host": [ "{{base-url}}core" ], "path": [ "api", "v1", "cards", "{{publicToken}}", "cvv" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "", "type": "text" } ], "cookie": [], "body": "{\n \"cvv\": \"885\",\n \"resultStatus\": \"Success\"\n}" } ] }, { "name": "Get CVV Status", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{access_token}}", "type": "string" } ] }, "method": "GET", "header": [], "url": { "raw": "{{base-url}}core/api/v1/cards/{{publicToken}}/cvv/status", "host": [ "{{base-url}}core" ], "path": [ "api", "v1", "cards", "{{publicToken}}", "cvv", "status" ] }, "description": "This endpoint enables you to get the CVV status of a card.\n\nFor more information on how to get a card's CVV status, see [Card Verification Value (CVV)](https://cardsapidocs.thredd.com/docs/card-verification-value-cvv)." }, "response": [ { "name": "Get CVV Status", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{base-url}}core/api/v1/cards/{{publicToken}}/cvv/status", "host": [ "{{base-url}}core" ], "path": [ "api", "v1", "cards", "{{publicToken}}", "cvv", "status" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "", "type": "text" } ], "cookie": [], "body": "{\n \"status\": \"Unblocked\",\n \"remainingTries\": \"Unlimited\"\n}" } ] }, { "name": "Unblock CVV", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{access_token}}", "type": "string" } ] }, "method": "PUT", "header": [], "body": { "mode": "raw", "raw": "{\r\n \"status\": \"Unblocked\"\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base-url}}core/api/v1/cards/{{publicToken}}/cvv/status", "host": [ "{{base-url}}core" ], "path": [ "api", "v1", "cards", "{{publicToken}}", "cvv", "status" ] }, "description": "This endpoint enables you to unblock a card's Card Verification Value (CVV).\n\nFor more information on how to unblock a CVV, see [Card Verification Value (CVV)](https://cardsapidocs.thredd.com/docs/card-verification-value-cvv)." }, "response": [ { "name": "Unblock CVV", "originalRequest": { "method": "PUT", "header": [], "body": { "mode": "raw", "raw": "{\r\n \"status\": \"Unblocked\"\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base-url}}core/api/v1/cards/{{publicToken}}/cvv/status", "host": [ "{{base-url}}core" ], "path": [ "api", "v1", "cards", "{{publicToken}}", "cvv", "status" ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "", "type": "text" } ], "cookie": [], "body": "" } ] } ] }, { "name": "Products", "item": [ { "name": "Get Product for Program Manager", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{access_token}}", "type": "string" } ] }, "method": "GET", "header": [], "url": { "raw": "{{base-url}}core/api/v1/products/{{productId}}", "host": [ "{{base-url}}core" ], "path": [ "api", "v1", "products", "{{productId}}" ] }, "description": "This endpoint allows you to retrieve details for a specified product id. This id must be specified in the endpoint.\n\nFor more information, see [Getting Product Data](https://cardsapidocs.thredd.com/docs/getting-product-data)." }, "response": [ { "name": "Get Product for Program Manager", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{base-url}}core/api/v1/products/{{productId}}", "host": [ "{{base-url}}core" ], "path": [ "api", "v1", "products", "{{productId}}" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "" } ], "cookie": [], "body": "{\r\n \"supportedCredentialTypesCsv\": null,\r\n \"supportedCredentialTypes\": [],\r\n \"defaultCredentialTypeId\": null,\r\n \"fallbackCredentialTypeId\": null,\r\n \"productId\": 10023,\r\n \"accountCode\": \"01\",\r\n \"schemeId\": 644,\r\n \"schemeName\": \"GPS SCHEME TEST\",\r\n \"currencyCode\": \"GBP\",\r\n \"groupFeeTranCode\": \"\",\r\n \"groupFeeMasterCode\": \"\",\r\n \"groupFeeWebCode\": \"\",\r\n \"groupMCCCode\": \"\",\r\n \"groupUsageCode\": \"PMT-CU-001\",\r\n \"ehiMode\": 3,\r\n \"supplier3DS\": \"4\",\r\n \"supplier3DSName\": null,\r\n \"supplier3DSVersion\": \"Apata\",\r\n \"fraudManagement\": 0,\r\n \"cardDefaultIsSingleUse\": null,\r\n \"cardDefaultIsNonReloadable\": null,\r\n \"fraudNotificationMethod\": 0,\r\n \"config3dSecure\": {\r\n \"language\": \"en-EN\",\r\n \"apata\": {\r\n \"cardProgramId\": \"sudbhcfndjfncvfhgn\",\r\n \"challengeProfileId\": \"rshgbvbhmbhverdctgvrwe\",\r\n \"kbaNumberOfQuestionsToAnswer\": 0,\r\n \"kbaNumberOfIncorrectPermissible\": 0\r\n }\r\n }\r\n}" } ] }, { "name": "Get Products", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{access_token}}", "type": "string" } ] }, "method": "GET", "header": [], "url": { "raw": "{{base-url}}core/api/v1/products", "host": [ "{{base-url}}core" ], "path": [ "api", "v1", "products" ] }, "description": "This endpoint allows you to retrieve the a list of products for your program.\n\nFor more information, see [Getting Product Data](https://cardsapidocs.thredd.com/docs/getting-product-data)." }, "response": [ { "name": "Get Products", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{base-url}}core/api/v1/products", "host": [ "{{base-url}}core" ], "path": [ "api", "v1", "products" ] } }, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "", "type": "text" } ], "cookie": [], "body": "{\n \"productID\": 10003,\n \"productName\": \"Currency Cloud Test UK\",\n \"accountCode\": \"02\",\n \"schemeName\": \"SCHEME TEST\",\n \"currencyCode\": \"GBP\"\n},\n{\n \"productID\": 10004,\n \"productName\": \"REST API TEST\",\n \"accountCode\": \"02\",\n \"schemeName\": \"SCHEME TEST\",\n \"currencyCode\": \"GBP\"\n}\n]" } ] }, { "name": "Get Product Card Stock", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{access_token}}", "type": "string" } ] }, "method": "GET", "header": [], "url": { "raw": "{{base-url}}core/api/v1/products/{{productId}}/stock", "host": [ "{{base-url}}core" ], "path": [ "api", "v1", "products", "{{productId}}", "stock" ] }, "description": "The Get Product Card Stock endpoint enables you to find out how much card stock you have associated with a product. You can retrieve a product's card stock by making a GET request to the Get Card Stock endpoint.\n\nFor more information, see [Getting Card Stock Data.](https://cardsapidocs.thredd.com/docs/getting-card-stock-data)" }, "response": [ { "name": "Get Product Card Stock", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{base-url}}core/api/v1/products/{{productId}}/stock", "host": [ "{{base-url}}core" ], "path": [ "api", "v1", "products", "{{productId}}", "stock" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "", "type": "text" } ], "cookie": [], "body": "{\n \"productId\": 10003,\n \"availableStock\": 3\n}" } ] } ] }, { "name": "Merchants", "item": [ { "name": "Get Card Acceptors", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{access_token}}", "type": "string" } ] }, "method": "GET", "header": [], "url": { "raw": "{{base-url}}core/api/v1/cards/{{publicToken}}/card-acceptor", "host": [ "{{base-url}}core" ], "path": [ "api", "v1", "cards", "{{publicToken}}", "card-acceptor" ] }, "description": "Acceptor lists enable you to control which merchants or merchant code are blocked or allowed to use your service. You can set up multiple acceptor lists and link cards to a list.\n\nThe Get Card Acceptor endpoint enables you to return the allow and disallow lists associated with a card.\n\nFor more information, see [Card Acceptors](https://cardsapidocs.thredd.com/docs/card-acceptors)." }, "response": [ { "name": "Get Card Acceptors", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{base-url}}core/api/v1/cards/{{publicToken}}/card-acceptor", "host": [ "{{base-url}}core" ], "path": [ "api", "v1", "cards", "{{publicToken}}", "card-acceptor" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "", "type": "text" } ], "cookie": [], "body": "{\r\n\t\"cardAcceptorAllowList\":\r\n\t{\r\n\t\t\"id\": 2323,\r\n\t\t\"name\":\"string\",\r\n\t\t\"merchantIds\":\r\n\t\t[\r\n\t\t\t\"Merchant5\",\r\n\t\t\t\"Merchant6\"\r\n\t\t],\r\n\t},\r\n\t\"cardAcceptorDisallowList\":\r\n\t{\r\n\t\t\"id\":23232,\r\n\t\t\"name\":\"string\",\r\n\t\t\"merchantIds\":\r\n\t\t[\r\n\t\t\t\"Merchant1\",\r\n\t\t\t\"Merchant2\"\r\n\t\t],\r\n\t}\r\n}" } ] }, { "name": "Get Allowed Merchants", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{access_token}}", "type": "string" } ] }, "method": "GET", "header": [], "url": { "raw": "{{base-url}}core/api/v1/groups/allow-merchant", "host": [ "{{base-url}}core" ], "path": [ "api", "v1", "groups", "allow-merchant" ] } }, "response": [] }, { "name": "Add Merchant to Allow List", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{access_token}}", "type": "string" } ] }, "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\r\n \"merchantIds\": [\r\n \"Merchant5\"\r\n ]\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base-url}}core/api/v1/groups/allow-merchant/{{merchantId}}", "host": [ "{{base-url}}core" ], "path": [ "api", "v1", "groups", "allow-merchant", "{{merchantId}}" ] }, "description": "This endpoint allows you to add merchants to the allow list. You can do this by adding the List ID to the end of the Allow Merchant endpoint.\n\nFor more information, see [Merchant Allow Lists](https://cardsapidocs.thredd.com/docs/merchant-allow-lists)." }, "response": [ { "name": "Add Merchant to Allow List", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\r\n \"merchantIds\": [\r\n \"Merchant5\"\r\n ]\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base-url}}core/api/v1/groups/allow-merchant/{{merchantId}}", "host": [ "{{base-url}}core" ], "path": [ "api", "v1", "groups", "allow-merchant", "{{merchantId}}" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "", "type": "text" } ], "cookie": [], "body": "[\n {\n \"listId\": 12,\n \"listName\": \"MERCHANT1\",\n \"listType\": \"Allow\",\n \"isActive\": true,\n \"schemeId\": 809,\n \"schemeName\": \"Operation Testing\",\n \"institutionId\": 142,\n \"institutionName\": \"INSTITUTION TEST\",\n \"cardAcceptors\": [\n \"123456\",\n \"Merchant5\"\n ]\n }\n]" } ] }, { "name": "Remove Merchant from Allow List", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{access_token}}", "type": "string" } ] }, "method": "DELETE", "header": [], "body": { "mode": "raw", "raw": "" }, "url": { "raw": "{{base-url}}core/api/v1/groups/allow-merchant/{{listId}}/{{merchantId}}", "host": [ "{{base-url}}core" ], "path": [ "api", "v1", "groups", "allow-merchant", "{{listId}}", "{{merchantId}}" ] }, "description": "This endpoint allows you to remove a merchant from an allow list. You can do this by using the DELETE method and adding the List ID and Merchant ID to the end of the Allow Merchant endpoint.\n\nFor more information, see [Merchant Allow Lists](https://cardsapidocs.thredd.com/docs/merchant-allow-lists)." }, "response": [ { "name": "Remove Merchant from Allow List", "originalRequest": { "method": "DELETE", "header": [], "body": { "mode": "raw", "raw": "" }, "url": { "raw": "{{base-url}}core/api/v1/groups/allow-merchant/70/{{merchantId}}", "host": [ "{{base-url}}core" ], "path": [ "api", "v1", "groups", "allow-merchant", "70", "{{merchantId}}" ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "Text", "header": [], "cookie": [], "body": "" } ] }, { "name": "Get Disallowed Merchants", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{access_token}}", "type": "string" } ] }, "method": "GET", "header": [], "url": { "raw": "{{base-url}}core/api/v1/groups/disallow-merchant", "host": [ "{{base-url}}core" ], "path": [ "api", "v1", "groups", "disallow-merchant" ] }, "description": "This endpoint allows you to retrieve the merchant disallow list for your program. You can retrieve the merchant disallow list by making a GET request to the Disallow Merchant endpoint.\n\nFor more information, see [Merchant Disallow Lists](https://cardsapidocs.thredd.com/docs/merchant-disallow-lists)." }, "response": [ { "name": "Get Disallowed Merchants", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{base-url}}core/api/v1/groups/disallow-merchant", "host": [ "{{base-url}}core" ], "path": [ "api", "v1", "groups", "disallow-merchant" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "", "type": "text" } ], "cookie": [], "body": "[\r\n {\r\n \"listId\": 71,\r\n \"listName\": \"TST\",\r\n \"listType\": \"Disallow\",\r\n \"isActive\": true,\r\n \"schemeId\": null,\r\n \"schemeName\": \"\",\r\n \"institutionId\": 142,\r\n \"institutionName\": \"INSTITUTION TEST\",\r\n \"cardAcceptors\": [\r\n \"12345\",\r\n \"3214\",\r\n \"Merchant15\",\r\n \"Merchant5\"\r\n ]\r\n },\r\n {\r\n \"listId\": 90,\r\n \"listName\": \"TESTX2\",\r\n \"listType\": \"Disallow\",\r\n \"isActive\": true,\r\n \"schemeId\": null,\r\n \"schemeName\": \"\",\r\n \"institutionId\": 142,\r\n \"institutionName\": \"INSTITUTION TEST\",\r\n \"cardAcceptors\": [\r\n \"MOTO 1\"\r\n ]\r\n }\r\n]" } ] }, { "name": "Add Merchant to Disallow List", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{access_token}}", "type": "string" } ] }, "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\r\n \"merchantIds\": [\r\n \"Merchant5\"\r\n ]\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base-url}}core/api/v1/groups/disallow-merchant/{{merchantId}}", "host": [ "{{base-url}}core" ], "path": [ "api", "v1", "groups", "disallow-merchant", "{{merchantId}}" ] }, "description": "This endpoint allows you to add merchants to a disallow list. You can do this by adding the List ID to the end of the Disallow Merchant endpoint.\n\nFor more information, see [Merchant Disallow Lists](https://cardsapidocs.thredd.com/docs/merchant-disallow-lists)." }, "response": [ { "name": "Add Merchant to Disallow List", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\r\n \"merchantIds\": [\r\n \"Test1\"\r\n ]\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base-url}}core/api/v1/groups/disallow-merchant/{{merchantId}}", "host": [ "{{base-url}}core" ], "path": [ "api", "v1", "groups", "disallow-merchant", "{{merchantId}}" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "", "type": "text" } ], "cookie": [], "body": "{\n \"listId\": 90,\n \"listName\": \"TESTX2\",\n \"listType\": \"Disallow\",\n \"isActive\": true,\n \"schemeId\": null,\n \"schemeName\": \"\",\n \"institutionId\": 142,\n \"institutionName\": \"INSTITUTION TEST\",\n \"cardAcceptors\": [\n \"MOTO 1\",\n \"Test1\"\n ]\n}" } ] }, { "name": "Remove Merchant from Disallow List", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{access_token}}", "type": "string" } ] }, "method": "DELETE", "header": [], "body": { "mode": "raw", "raw": "" }, "url": { "raw": "{{base-url}}core/api/v1/groups/disallow-merchant/{{listId}}/{{merchantId}}", "host": [ "{{base-url}}core" ], "path": [ "api", "v1", "groups", "disallow-merchant", "{{listId}}", "{{merchantId}}" ] }, "description": "This endpoint allows you to remove a merchant from an allow list. You can do this by using the DELETE method and adding the List ID and Merchant ID to the end of the Allow Merchant endpoint.\n\nFor more information, see [Merchant Allow Lists](https://cardsapidocs.thredd.com/docs/merchant-allow-lists)." }, "response": [ { "name": "Remove Merchant from Disallow List", "originalRequest": { "method": "DELETE", "header": [], "body": { "mode": "raw", "raw": "" }, "url": { "raw": "{{base-url}}core/api/v1/groups/disallow-merchant/{{listId}}/{{merchantId}}", "host": [ "{{base-url}}core" ], "path": [ "api", "v1", "groups", "disallow-merchant", "{{listId}}", "{{merchantId}}" ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "Text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "Card Tokenisation", "item": [ { "name": "Get Card Payment Tokens", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{access_token}}", "type": "string" } ] }, "method": "GET", "header": [], "url": { "raw": "{{base-url}}core/api/v1/cards/{{publicToken}}/payment-tokens", "host": [ "{{base-url}}core" ], "path": [ "api", "v1", "cards", "{{publicToken}}", "payment-tokens" ] }, "description": "This endpoint allows you to retrieve details for a specified product id. This id must be specified in the endpoint.\n\nFor more information, see [Getting Product Data](https://cardsapidocs.thredd.com/docs/getting-product-data)." }, "response": [ { "name": "Get Card Payment Tokens", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{base-url}}core/api/v1/cards/{{publicToken}}/payment-tokens", "host": [ "{{base-url}}core" ], "path": [ "api", "v1", "cards", "{{publicToken}}", "payment-tokens" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "" } ], "cookie": [], "body": "[\r\n {\r\n \"id\": 0,\r\n \"walletId\": \"string\",\r\n \"walletProvider\": \"string\",\r\n \"tokenPAN\": \"string\",\r\n \"statuses\": {\r\n \"tokenisedStatus\": {\r\n \"code\": \"string\",\r\n \"description\": \"string\"\r\n },\r\n \"authorisationStatus\": {\r\n \"code\": \"string\",\r\n \"description\": \"string\"\r\n },\r\n \"authorisationDecision\": {\r\n \"code\": \"string\",\r\n \"description\": \"string\"\r\n },\r\n \"transactionStatus\": {\r\n \"code\": \"string\",\r\n \"description\": \"string\"\r\n },\r\n \"gpsStatusInfo\": {\r\n \"code\": \"string\",\r\n \"description\": \"string\"\r\n }\r\n },\r\n \"tokenisedDate\": \"string\",\r\n \"expiryDate\": \"string\",\r\n \"tokenType\": \"string\",\r\n \"deviceType\": \"string\",\r\n \"deviceName\": \"string\",\r\n \"activationCode\": \"string\",\r\n \"threddDecisionAt\": \"string\",\r\n \"threddDecision\": \"string\"\r\n }\r\n]" } ] }, { "name": "Get Card Payment Token Devices", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{access_token}}", "type": "string" } ] }, "method": "GET", "header": [], "url": { "raw": "{{base-url}}core/api/v1/cards/{{publicToken}}/payment-tokens/{{tokenId}}/devices", "host": [ "{{base-url}}core" ], "path": [ "api", "v1", "cards", "{{publicToken}}", "payment-tokens", "{{tokenId}}", "devices" ] }, "description": "This endpoint allows you to retrieve details for a specified product id. This id must be specified in the endpoint.\n\nFor more information, see [Getting Product Data](https://cardsapidocs.thredd.com/docs/getting-product-data)." }, "response": [ { "name": "Get Card Payment Tokens", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{base-url}}core/api/v1/cards/{{publicToken}}/payment-tokens/{{tokenId}}/devices", "host": [ "{{base-url}}core" ], "path": [ "api", "v1", "cards", "{{publicToken}}", "payment-tokens", "{{tokenId}}", "devices" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "" } ], "cookie": [], "body": "[\r\n {\r\n \"gpsID\": 0,\r\n \"index\": 0,\r\n \"gpsStatus\": \"string\",\r\n \"paymentSchemeStatus\": \"string\",\r\n \"bindDate\": \"string\",\r\n \"statusDate\": \"string\",\r\n \"deviceID\": \"string\"\r\n }\r\n]" } ] }, { "name": "Update Payment Token Status", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{access_token}}", "type": "string" } ] }, "method": "PUT", "header": [], "body": { "mode": "raw", "raw": "{\r\n \"tokenId\": 0,\r\n \"status\": \"string\",\r\n \"notifyProcessor\": true,\r\n \"description\": \"string\",\r\n \"updatedBy\": \"string\"\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base-url}}core/api/v1/cards/{{publicToken}}/payment-tokens/{{tokenId}}/status", "host": [ "{{base-url}}core" ], "path": [ "api", "v1", "cards", "{{publicToken}}", "payment-tokens", "{{tokenId}}", "status" ] }, "description": "This endpoint enables you to unblock a card's Card Verification Value (CVV).\n\nFor more information on how to unblock a CVV, see [Card Verification Value (CVV)](https://cardsapidocs.thredd.com/docs/card-verification-value-cvv)." }, "response": [ { "name": "Update Payment Token Status", "originalRequest": { "method": "PUT", "header": [], "body": { "mode": "raw", "raw": "{\r\n \"status\": \"Unblocked\"\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base-url}}core/api/v1/cards/{{publicToken}}/payment-tokens/{{tokenId}}/status", "host": [ "{{base-url}}core" ], "path": [ "api", "v1", "cards", "{{publicToken}}", "payment-tokens", "{{tokenId}}", "status" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "", "type": "text" } ], "cookie": [], "body": "{\n \"status\": \"Active\",\n \"comment\": \"string\"\n}" } ] }, { "name": "Unbind Payment Token", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{access_token}}", "type": "string" } ] }, "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\r\n \"deviceIndex\":0\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base-url}}core/api/v1/cards/{{publicToken}}/payment-tokens/{{tokenId}}/devices/unbind", "host": [ "{{base-url}}core" ], "path": [ "api", "v1", "cards", "{{publicToken}}", "payment-tokens", "{{tokenId}}", "devices", "unbind" ] }, "description": "This endpoint allows you to add merchants to the allow list. You can do this by adding the List ID to the end of the Allow Merchant endpoint.\n\nFor more information, see [Merchant Allow Lists](https://cardsapidocs.thredd.com/docs/merchant-allow-lists)." }, "response": [ { "name": "Unbind Payment Token", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\r\n \"deviceIndex\":0\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base-url}}core/api/v1/cards/{{publicToken}}/payment-tokens/{{tokenId}}/devices/unbind", "host": [ "{{base-url}}core" ], "path": [ "api", "v1", "cards", "{{publicToken}}", "payment-tokens", "{{tokenId}}", "devices", "unbind" ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "", "type": "text" } ], "cookie": [], "body": "" } ] } ] }, { "name": "Transactions", "item": [ { "name": "Load Card", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{access_token}}", "type": "string" } ] }, "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\r\n\"transactionType\": \"Load\",\r\n\"amount\": 1000.00,\r\n\"currencyCode\": \"GBP\",\r\n\"loadedBy\": \"string\",\r\n\"description\": \"string\"\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base-url}}core/api/v1/cards/{{publicToken}}/transactions", "host": [ "{{base-url}}core" ], "path": [ "api", "v1", "cards", "{{publicToken}}", "transactions" ] }, "description": "This endpoint enables you to load funds onto a card, allowing you to add a positive balance onto the card.\n\nFor more information on how to load a card, see [Loading, Unloading and Balance Adjustments](https://cardsapidocs.thredd.com/docs/loading-unloading-a-card)." }, "response": [ { "name": "Load Card", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\r\n\"transactionType\": \"Load\",\r\n\"amount\": 1000.00,\r\n\"currencyCode\": \"GBP\",\r\n\"loadedBy\": \"string\",\r\n\"description\": \"string\"\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base-url}}core/api/v1/cards/{{publicToken}}/transactions", "host": [ "{{base-url}}core" ], "path": [ "api", "v1", "cards", "{{publicToken}}", "transactions" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "", "type": "text" } ], "cookie": [], "body": "{\n \"transaction\": [\n {\n \"transactionType\": \"Load\",\n \"transactionId\": 6157564898,\n \"amount\": 1000,\n \"currencyCode\": \"GBP\",\n \"publicToken\": \"103169969\"\n }\n ],\n \"balance\": {\n \"currencyCode\": \"GBP\",\n \"cardBalance\": 1000,\n \"pendingAmount\": 0,\n \"availableBalance\": 1000\n }\n}" } ] }, { "name": "Load Card for Issuer", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{access_token}}", "type": "string" } ] }, "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\r\n\"transactionType\": \"Load\",\r\n\"amount\": 1000.00,\r\n\"currencyCode\": \"GBP\",\r\n\"loadedBy\": \"string\",\r\n\"description\": \"string\"\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base-url}}core/api/v1/cards/issuer/{{publicToken}}/transactions", "host": [ "{{base-url}}core" ], "path": [ "api", "v1", "cards", "issuer", "{{publicToken}}", "transactions" ] }, "description": "This endpoint enables you to load funds onto a card, allowing you to add a positive balance onto the card.\n\nFor more information on how to load a card, see [Load and Unload BIN Sponsor.](https://cardsapidocs.thredd.com/docs/load-and-unload-bin-sponsor)" }, "response": [ { "name": "Load Card", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\r\n\"transactionType\": \"Load\",\r\n\"amount\": 1000.00,\r\n\"currencyCode\": \"GBP\",\r\n\"loadedBy\": \"string\",\r\n\"description\": \"string\"\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base-url}}core/api/v1/cards/issuer/{{publicToken}}/transactions", "host": [ "{{base-url}}core" ], "path": [ "api", "v1", "cards", "issuer", "{{publicToken}}", "transactions" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "", "type": "text" } ], "cookie": [], "body": "{\n \"transaction\": [\n {\n \"transactionType\": \"Load\",\n \"transactionId\": 6157564898,\n \"amount\": 1000,\n \"currencyCode\": \"GBP\",\n \"publicToken\": \"103169969\"\n }\n ],\n \"balance\": {\n \"currencyCode\": \"GBP\",\n \"cardBalance\": 1000,\n \"pendingAmount\": 0,\n \"availableBalance\": 1000\n }\n}" } ] }, { "name": "Unload Card", "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200\", function () {\r", " pm.response.to.have.status(200);\r", "});\r", "\r", "pm.test(\"Check Response\", function () {\r", " var jsonData = pm.response.json();\r", " var req = JSON.parse(pm.request.body.raw);\r", " const transaction = jsonData.transaction[0];\r", "\r", "console.log(JSON.stringify(jsonData));\r", "//Get the card balance after loading the card\r", " const cardBalance = pm.collectionVariables.get(\"cardBalance\");\r", " const expectedResult = {\r", " \"balance\": {\r", " \"currencyCode\": \"GBP\",\r", " \"cardBalance\": cardBalance - req.Amount,\r", " \"pendingAmount\": 0,\r", " \"availableBalance\": cardBalance - req.Amountt\r", " }\r", " }\r", "\r", " pm.expect(jsonData).to.deep.include(expectedResult);\r", " pm.expect(transaction.transactionType).to.be.eql('Unload');\r", " pm.expect(transaction.transactionId).to.be.a('string');\r", " pm.expect(transaction.amount).to.be.eql(req.Amount);\r", " pm.expect(transaction.currencyCode).to.be.eql(req.currencyCode);\r", "\r", "});" ], "type": "text/javascript", "packages": {}, "requests": {} } } ], "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{access_token}}", "type": "string" } ] }, "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\r\n\"transactionType\": \"Unload\",\r\n\"amount\": 50.00,\r\n\"currencyCode\": \"GBP\",\r\n\"loadedBy\": \"string\",\r\n\"description\": \"string\"\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base-url}}core/api/v1/cards/{{publicToken}}/transactions", "host": [ "{{base-url}}core" ], "path": [ "api", "v1", "cards", "{{publicToken}}", "transactions" ] }, "description": "This endpoint enables you to unload funds from a card, allowing you to remove or partially remove the balance from the card.\n\nFor more information on how to load a card, see [Loading, Unloading and Balance Adjustments](https://cardsapidocs.thredd.com/docs/loading-unloading-a-card)." }, "response": [ { "name": "Unload Card", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\r\n\"transactionType\": \"Unload\",\r\n\"amount\": 50.00,\r\n\"currencyCode\": \"GBP\",\r\n\"loadedBy\": \"string\",\r\n\"description\": \"string\"\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base-url}}core/api/v1/cards/{{publicToken}}/transactions", "host": [ "{{base-url}}core" ], "path": [ "api", "v1", "cards", "{{publicToken}}", "transactions" ] } }, "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "", "type": "text" } ], "cookie": [], "body": "{\n \"transaction\": [\n {\n \"transactionType\": \"Unload\",\n \"transactionId\": 6157564901,\n \"amount\": 50,\n \"currencyCode\": \"GBP\",\n \"publicToken\": \"103169969\"\n }\n ],\n \"balance\": {\n \"currencyCode\": \"GBP\",\n \"cardBalance\": 950,\n \"pendingAmount\": 0,\n \"availableBalance\": 950\n }\n}" } ] }, { "name": "Unload Card for Issuer", "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200\", function () {\r", " pm.response.to.have.status(200);\r", "});\r", "\r", "pm.test(\"Check Response\", function () {\r", " var jsonData = pm.response.json();\r", " var req = JSON.parse(pm.request.body.raw);\r", " const transaction = jsonData.transaction[0];\r", "\r", "console.log(JSON.stringify(jsonData));\r", "//Get the card balance after loading the card\r", " const cardBalance = pm.collectionVariables.get(\"cardBalance\");\r", " const expectedResult = {\r", " \"balance\": {\r", " \"currencyCode\": \"GBP\",\r", " \"cardBalance\": cardBalance - req.Amount,\r", " \"pendingAmount\": 0,\r", " \"availableBalance\": cardBalance - req.Amountt\r", " }\r", " }\r", "\r", " pm.expect(jsonData).to.deep.include(expectedResult);\r", " pm.expect(transaction.transactionType).to.be.eql('Unload');\r", " pm.expect(transaction.transactionId).to.be.a('string');\r", " pm.expect(transaction.amount).to.be.eql(req.Amount);\r", " pm.expect(transaction.currencyCode).to.be.eql(req.currencyCode);\r", "\r", "});" ], "type": "text/javascript", "packages": {}, "requests": {} } } ], "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{access_token}}", "type": "string" } ] }, "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\r\n\"transactionType\": \"Unload\",\r\n\"amount\": 50.00,\r\n\"currencyCode\": \"GBP\",\r\n\"loadedBy\": \"string\",\r\n\"description\": \"string\"\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base-url}}core/api/v1/cards/issuer/{{publicToken}}/transactions", "host": [ "{{base-url}}core" ], "path": [ "api", "v1", "cards", "issuer", "{{publicToken}}", "transactions" ] }, "description": "This endpoint enables you to unload funds from a card, allowing you to remove or partially remove the balance from the card.\n\nFor more information on how to unload a card, see [Load and Unload BIN Sponsor.](https://cardsapidocs.thredd.com/docs/load-and-unload-bin-sponsor)" }, "response": [ { "name": "Unload Card", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\r\n\"transactionType\": \"Unload\",\r\n\"amount\": 50.00,\r\n\"currencyCode\": \"GBP\",\r\n\"loadedBy\": \"string\",\r\n\"description\": \"string\"\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base-url}}core/api/v1/cards/issuer/{{publicToken}}/transactions", "host": [ "{{base-url}}core" ], "path": [ "api", "v1", "cards", "issuer", "{{publicToken}}", "transactions" ] } }, "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "", "type": "text" } ], "cookie": [], "body": "{\n \"transaction\": [\n {\n \"transactionType\": \"Unload\",\n \"transactionId\": 6157564901,\n \"amount\": 50,\n \"currencyCode\": \"GBP\",\n \"publicToken\": \"103169969\"\n }\n ],\n \"balance\": {\n \"currencyCode\": \"GBP\",\n \"cardBalance\": 950,\n \"pendingAmount\": 0,\n \"availableBalance\": 950\n }\n}" } ] }, { "name": "Adjust Balance", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{access_token}}", "type": "string" } ] }, "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\r\n \"transactionType\": \"BalanceAdjustment\",\r\n \"amount\": 500,\r\n \"currencyCode\": \"GBP\",\r\n \"loadedBy\": \"User\",\r\n \"description\": \"Description\"\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base-url}}core/api/v1/cards/{{publicToken}}/transactions", "host": [ "{{base-url}}core" ], "path": [ "api", "v1", "cards", "{{publicToken}}", "transactions" ] }, "description": "This endpoint enables you to create a transaction to modify the balance on the card.\n\nFor more information on how to load and unload a card, see [Loading, Unloading and Balance Adjustments](https://cardsapidocs.thredd.com/docs/loading-unloading-a-card)." }, "response": [ { "name": "Adjust Balance", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\r\n \"transactionType\": \"BalanceAdjustment\",\r\n \"amount\": 500,\r\n \"currencyCode\": \"GBP\",\r\n \"loadedBy\": \"User\",\r\n \"description\": \"Description\"\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base-url}}core/api/v1/cards/{{publicToken}}/transactions", "host": [ "{{base-url}}core" ], "path": [ "api", "v1", "cards", "{{publicToken}}", "transactions" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "", "type": "text" } ], "cookie": [], "body": "{\r\n \"transaction\": [\r\n {\r\n \"transactionType\": \"BalanceAdjustment\",\r\n \"transactionId\": 6157564902,\r\n \"amount\": 500,\r\n \"currencyCode\": \"GBP\",\r\n \"publicToken\": \"103169969\"\r\n }\r\n ],\r\n \"balance\": {\r\n \"currencyCode\": \"GBP\",\r\n \"cardBalance\": 1450,\r\n \"pendingAmount\": 0,\r\n \"availableBalance\": 1450\r\n }\r\n}" } ] }, { "name": "Transfer Funds", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{access_token}}", "type": "string" } ] }, "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\r\n\"transactionType\": \"TransferFunds\",\r\n\"amount\": 10.00,\r\n\"currencyCode\": \"GBP\",\r\n\"toPublicToken\": \"987654321\"\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base-url}}core/api/v1/cards/{{publicToken}}/transactions", "host": [ "{{base-url}}core" ], "path": [ "api", "v1", "cards", "{{publicToken}}", "transactions" ] }, "description": "This endpoint enables users to transfer funds between cards in the GPS system, and to facilitate loading cards from an MVC.\n\nFunds are transferred from the publicToken set in the URL and transferred to the token set in the ToPublicToken field in the body.\n\nFor more information on how to transfer funds, see [Transaction Types](https://cardsapidocs.thredd.com/docs/loading-unloading-a-card)." }, "response": [ { "name": "Transfer Funds", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\r\n\"transactionType\": \"TransferFunds\",\r\n\"amount\": 10.00,\r\n\"currencyCode\": \"GBP\",\r\n\"toPublicToken\": \"103169968\"\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base-url}}core/api/v1/cards/{{publicToken}}/transactions", "host": [ "{{base-url}}core" ], "path": [ "api", "v1", "cards", "{{publicToken}}", "transactions" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "", "type": "text" } ], "cookie": [], "body": "{\n \"transaction\": [\n {\n \"transactionType\": \"Unload\",\n \"transactionId\": 6157564904,\n \"amount\": 10,\n \"currencyCode\": \"GBP\",\n \"publicToken\": \"103169969\"\n },\n {\n \"transactionType\": \"Load\",\n \"transactionId\": 6157564905,\n \"amount\": 10,\n \"currencyCode\": \"GBP\",\n \"publicToken\": \"103169968\"\n }\n ],\n \"balance\": {\n \"currencyCode\": \"GBP\",\n \"cardBalance\": 1440,\n \"pendingAmount\": 0,\n \"availableBalance\": 1440\n }\n}" } ] }, { "name": "Get Card Transactions", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{access_token}}", "type": "string" } ] }, "method": "GET", "header": [], "url": { "raw": "{{base-url}}core/api/v1/cards/{{publicToken}}/transactions?fromDate=20210101&toDate=20221231", "host": [ "{{base-url}}core" ], "path": [ "api", "v1", "cards", "{{publicToken}}", "transactions" ], "query": [ { "key": "fromDate", "value": "20210101" }, { "key": "toDate", "value": "20221231" } ] }, "description": "This endpoint retrieves the transactions for a card between two specified dates.\n\nFor more information on how to list card transactions, see [Listing Card Transactions](https://cardsapidocs.thredd.com/docs/retrieving-card-transactions)." }, "response": [ { "name": "Get Card Transactions", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{base-url}}core/api/v1/cards/{{publicToken}}/transactions?fromDate=20210101&toDate=20221231", "host": [ "{{base-url}}core" ], "path": [ "api", "v1", "cards", "{{publicToken}}", "transactions" ], "query": [ { "key": "fromDate", "value": "20210101" }, { "key": "toDate", "value": "20221231" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "", "type": "text" } ], "cookie": [], "body": "[\r\n {\r\n \"id\": 6160502008,\r\n \"description\": \"string\",\r\n \"dateTime\": \"2024-02-20T14:16:18.34Z\",\r\n \"lifeCycleId\": null,\r\n \"type\": {\r\n \"code\": \"U\",\r\n \"description\": \"Unload\"\r\n },\r\n \"status\": {\r\n \"code\": \"S\",\r\n \"description\": \"Settled\"\r\n },\r\n \"amount\": {\r\n \"billingValue\": 50.00,\r\n \"billingCurrency\": \"GBP\",\r\n \"transactionValue\": 50.0000,\r\n \"transactionCurrency\": \"GBP\",\r\n \"settlementAmount\": 50.00,\r\n \"settlementCurrency\": \"GBP\",\r\n \"actualBalance\": 1950.00,\r\n \"availableBalance\": 1950.00\r\n },\r\n \"fees\": {\r\n \"id\": 0,\r\n \"fixedFee\": 0.00,\r\n \"rateFee\": 0.00,\r\n \"fxPadding\": 0.00,\r\n \"mccPadding\": 0.00\r\n },\r\n \"productId\": 10023,\r\n \"cardNetwork\": \"MASTERCARD\",\r\n \"processingCode\": \"230000\",\r\n \"recordId\": 0,\r\n \"note\": \"API Load by \",\r\n \"systemTraceAuditNumber\": 0,\r\n \"transactionCountry\": \"GBR\",\r\n \"transactionLink\": 6160502008,\r\n \"additionalDetail\": null,\r\n \"paymentTokenId\": null,\r\n \"paymentMethod\": \"None\",\r\n \"ehiMode\": 3\r\n },\r\n {\r\n \"id\": 6160502007,\r\n \"description\": \"string\",\r\n \"dateTime\": \"2024-02-20T14:16:11.17Z\",\r\n \"lifeCycleId\": null,\r\n \"type\": {\r\n \"code\": \"L\",\r\n \"description\": \"Load\"\r\n },\r\n \"status\": {\r\n \"code\": \"S\",\r\n \"description\": \"Settled\"\r\n },\r\n \"amount\": {\r\n \"billingValue\": 1000.00,\r\n \"billingCurrency\": \"GBP\",\r\n \"transactionValue\": 1000.0000,\r\n \"transactionCurrency\": \"GBP\",\r\n \"settlementAmount\": 1000.00,\r\n \"settlementCurrency\": \"GBP\",\r\n \"actualBalance\": 2000.00,\r\n \"availableBalance\": 2000.00\r\n },\r\n \"fees\": {\r\n \"id\": 0,\r\n \"fixedFee\": 0.00,\r\n \"rateFee\": 0.00,\r\n \"fxPadding\": 0.00,\r\n \"mccPadding\": 0.00\r\n },\r\n \"productId\": 10023,\r\n \"cardNetwork\": \"MASTERCARD\",\r\n \"processingCode\": \"220000\",\r\n \"recordId\": 0,\r\n \"note\": \"API Load by \",\r\n \"systemTraceAuditNumber\": 0,\r\n \"transactionCountry\": \"GBR\",\r\n \"transactionLink\": 6160502007,\r\n \"additionalDetail\": null,\r\n \"paymentTokenId\": null,\r\n \"paymentMethod\": \"None\",\r\n \"ehiMode\": 3\r\n },\r\n {\r\n \"id\": 6159718325,\r\n \"description\": \"string\",\r\n \"dateTime\": \"2023-12-07T11:03:38.837Z\",\r\n \"lifeCycleId\": null,\r\n \"type\": {\r\n \"code\": \"L\",\r\n \"description\": \"Load\"\r\n },\r\n \"status\": {\r\n \"code\": \"S\",\r\n \"description\": \"Settled\"\r\n },\r\n \"amount\": {\r\n \"billingValue\": 1000.00,\r\n \"billingCurrency\": \"GBP\",\r\n \"transactionValue\": 1000.0000,\r\n \"transactionCurrency\": \"GBP\",\r\n \"settlementAmount\": 1000.00,\r\n \"settlementCurrency\": \"GBP\",\r\n \"actualBalance\": 1000.00,\r\n \"availableBalance\": 1000.00\r\n },\r\n \"fees\": {\r\n \"id\": 0,\r\n \"fixedFee\": 0.00,\r\n \"rateFee\": 0.00,\r\n \"fxPadding\": 0.00,\r\n \"mccPadding\": 0.00\r\n },\r\n \"productId\": 10023,\r\n \"cardNetwork\": \"MASTERCARD\",\r\n \"processingCode\": \"220000\",\r\n \"recordId\": 0,\r\n \"note\": \"API Load by \",\r\n \"systemTraceAuditNumber\": 0,\r\n \"transactionCountry\": \"GBR\",\r\n \"transactionLink\": 6159718325,\r\n \"additionalDetail\": null,\r\n \"paymentTokenId\": null,\r\n \"paymentMethod\": \"None\",\r\n \"ehiMode\": 3\r\n }\r\n]" } ] } ] }, { "name": "Custom PAN", "item": [ { "name": "Create Custom PAN", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{access_token}}", "type": "string" } ] }, "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\r\n \"productReference\": \"\",\r\n \"customerAccount\": \"\",\r\n \"expiryDate\": \"\",\r\n \"accessCode\": \"\",\r\n \"coBrand\": \"\",\r\n \"fulfil1\": \"\",\r\n \"fulfil2\": \"\",\r\n \"cardName\": \"\",\r\n \"singleUse\": false,\r\n \"nonReloadable\": false,\r\n \"CardHolder\": {\r\n \"Title\": \"Mrs.\",\r\n \"FirstName\": \"Francis\",\r\n \"LastName\": \"Armstrong\",\r\n \"Dob\": \"2002-09-26\",\r\n \"Gender\": \"F\",\r\n \"Mobile\": \"(246) 779-6344 x88395\",\r\n \"Telephone\": \"714.342.9465 x799\",\r\n \"Email\": \"Dolores_Simonis@gmail.com\",\r\n \"Address\": {\r\n \"AddressLine1\": \"21156\",\r\n \"AddressLine2\": \"Northwest\",\r\n \"AddressLine3\": \"6469 Ullrich Street\",\r\n \"City\": \"North Erichhaven\",\r\n \"PostCode\": \"74494-8786\",\r\n \"Country\": \"826\"\r\n },\r\n \"DeliveryAddress\": {\r\n \"AddressLine1\": \"21156\",\r\n \"AddressLine2\": \"Northwest\",\r\n \"AddressLine3\": \"6469 Ullrich Street\",\r\n \"City\": \"North Erichhaven\",\r\n \"County\": \"Cambridgeshire\",\r\n \"PostCode\": \"74494-8786\",\r\n \"Country\": \"826\"\r\n }\r\n },\r\n \"Groups\": {\r\n \"Limit\": \"\",\r\n \"Mcc\": \"\",\r\n \"Usage\": \"\",\r\n \"AuthorisationFee\": \"\",\r\n \"ScheduledFee\": \"\",\r\n \"WebserviceFee\": \"\",\r\n \"LimitedNetwork\": \"\",\r\n \"CardLinkage\": \"\",\r\n \"AuthorisationCalendar\": \"\",\r\n \"ForeignExchange\": \"\",\r\n \"Whitelist\": \"\",\r\n \"Blacklist\": \"\"\r\n },\r\n \"customPan\": \"008185\",\r\n \"referenceNumber\": 2053406,\r\n \"productId\": 443,\r\n \"ManufacturerDetails\": {\r\n \"DeliveryMethod\": \"\",\r\n \"DeliveryCode\": \"suywmq\",\r\n \"LanguageCode\": \"EN\",\r\n \"CarrierType\": \"suywmq\",\r\n \"VanityName\": \"suywmq\",\r\n \"Url\": \"https://natalia.net\",\r\n \"CardPhysicalLayout\": {\r\n \"ImageId\": \"suywmq\",\r\n \"EmbossLine4\": \"suywmq\",\r\n \"ThermalLine1\": \"suywmq\",\r\n \"ThermalLine2\": \"suywmq\",\r\n \"LogoFrontId\": \"suywmq\",\r\n \"LogoBackId\": \"suywmq\"\r\n }\r\n }\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://thredd-cg-custompan-uat.thredd.net/api/v1/card/create", "protocol": "https", "host": [ "thredd-cg-custompan-uat", "thredd", "net" ], "path": [ "api", "v1", "card", "create" ] }, "description": "This endpoint allows you to add merchants to the allow list. You can do this by adding the List ID to the end of the Allow Merchant endpoint.\n\nFor more information, see [Merchant Allow Lists](https://cardsapidocs.thredd.com/docs/merchant-allow-lists)." }, "response": [ { "name": "Create Custom PAN", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\r\n \"productReference\": \"\",\r\n \"customerAccount\": \"\",\r\n \"expiryDate\": \"\",\r\n \"accessCode\": \"\",\r\n \"coBrand\": \"\",\r\n \"fulfil1\": \"\",\r\n \"fulfil2\": \"\",\r\n \"cardName\": \"\",\r\n \"singleUse\": false,\r\n \"nonReloadable\": false,\r\n \"CardHolder\": {\r\n \"Title\": \"Mrs.\",\r\n \"FirstName\": \"Francis\",\r\n \"LastName\": \"Armstrong\",\r\n \"Dob\": \"2002-09-26\",\r\n \"Gender\": \"F\",\r\n \"Mobile\": \"(246) 779-6344 x88395\",\r\n \"Telephone\": \"714.342.9465 x799\",\r\n \"Email\": \"Dolores_Simonis@gmail.com\",\r\n \"Address\": {\r\n \"AddressLine1\": \"21156\",\r\n \"AddressLine2\": \"Northwest\",\r\n \"AddressLine3\": \"6469 Ullrich Street\",\r\n \"City\": \"North Erichhaven\",\r\n \"PostCode\": \"74494-8786\",\r\n \"Country\": \"826\"\r\n },\r\n \"DeliveryAddress\": {\r\n \"AddressLine1\": \"21156\",\r\n \"AddressLine2\": \"Northwest\",\r\n \"AddressLine3\": \"6469 Ullrich Street\",\r\n \"City\": \"North Erichhaven\",\r\n \"County\": \"Cambridgeshire\",\r\n \"PostCode\": \"74494-8786\",\r\n \"Country\": \"826\"\r\n }\r\n },\r\n \"Groups\": {\r\n \"Limit\": \"\",\r\n \"Mcc\": \"\",\r\n \"Usage\": \"\",\r\n \"AuthorisationFee\": \"\",\r\n \"ScheduledFee\": \"\",\r\n \"WebserviceFee\": \"\",\r\n \"LimitedNetwork\": \"\",\r\n \"CardLinkage\": \"\",\r\n \"AuthorisationCalendar\": \"\",\r\n \"ForeignExchange\": \"\",\r\n \"Whitelist\": \"\",\r\n \"Blacklist\": \"\"\r\n },\r\n \"customPan\": \"008185\",\r\n \"referenceNumber\": 2053406,\r\n \"productId\": 443,\r\n \"ManufacturerDetails\": {\r\n \"DeliveryMethod\": \"\",\r\n \"DeliveryCode\": \"suywmq\",\r\n \"LanguageCode\": \"EN\",\r\n \"CarrierType\": \"suywmq\",\r\n \"VanityName\": \"suywmq\",\r\n \"Url\": \"https://natalia.net\",\r\n \"CardPhysicalLayout\": {\r\n \"ImageId\": \"suywmq\",\r\n \"EmbossLine4\": \"suywmq\",\r\n \"ThermalLine1\": \"suywmq\",\r\n \"ThermalLine2\": \"suywmq\",\r\n \"LogoFrontId\": \"suywmq\",\r\n \"LogoBackId\": \"suywmq\"\r\n }\r\n }\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://thredd-cg-custompan-uat.thredd.net/api/v1/card/create", "protocol": "https", "host": [ "thredd-cg-custompan-uat", "thredd", "net" ], "path": [ "api", "v1", "card", "create" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "", "type": "text" } ], "cookie": [], "body": "{\n \"messageId\": \"60b83k64-526e-4d25-84c7-32b6e47c02b3\"\n}" } ] }, { "name": "Validate Custom PAN", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{access_token}}", "type": "string" } ] }, "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\r\n \"productId\": 443,\r\n \"customPan\": 8185,\r\n \"panOptions\": [\r\n {\r\n \"id\": 1,\r\n \"pan\": \"78965\"\r\n },\r\n {\r\n \"id\": 2,\r\n \"pan\": \"78765\"\r\n }\r\n ]\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://thredd-cg-custompan-uat.thredd.net/api/v1/card/custom-pan", "protocol": "https", "host": [ "thredd-cg-custompan-uat", "thredd", "net" ], "path": [ "api", "v1", "card", "custom-pan" ] }, "description": "This endpoint allows you to add merchants to the allow list. You can do this by adding the List ID to the end of the Allow Merchant endpoint.\n\nFor more information, see [Merchant Allow Lists](https://cardsapidocs.thredd.com/docs/merchant-allow-lists)." }, "response": [ { "name": "Validate Custom PAN", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\r\n \"productId\": 443,\r\n \"customPan\": 8185,\r\n \"panOptions\": [\r\n {\r\n \"id\": 1,\r\n \"pan\": \"78965\"\r\n },\r\n {\r\n \"id\": 2,\r\n \"pan\": \"78765\"\r\n }\r\n ]\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://thredd-cg-custompan-uat.thredd.net/api/v1/card/custom-pan", "protocol": "https", "host": [ "thredd-cg-custompan-uat", "thredd", "net" ], "path": [ "api", "v1", "card", "custom-pan" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "", "type": "text" } ], "cookie": [], "body": "{\n \"isCustomPanValid\": true,\n \"panOptions\": []\n}" } ] } ] } ] }, { "name": "SOAP Converted Endpoints", "item": [ { "name": "PIN Control", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{access_token}}", "type": "string" } ] }, "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\r\n \"AuthType\": \"2\",\r\n \t\"DOB\": \"1982-11-03\",\r\n \"PublicToken\": \"123456789\",\r\n \"Func\": \"05\"\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base-url}}/ws/api/v1/WS_PinControl", "host": [ "{{base-url}}" ], "path": [ "ws", "api", "v1", "WS_PinControl" ] }, "description": "The Set PIN Control endpoint enables you to set, retrieve, unblock and change the PIN associated with the card. It also allows you to unblock the CVC2 of a card or mobile device token.\n\nFor more information, see [Set PIN Control.](https://cardsapidocs.thredd.com/docs/set-pin-control)" }, "response": [ { "name": "PIN Control", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\r\n \"moveBalance\": true,\r\n \"moveLimitAccumulators\": true,\r\n \"moveChildCards\": false,\r\n \"moveExpiryDate\": false,\r\n \"expiryDate\": \"2023-04\"\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base-url}}/ws/api/v1/WS_PinControl", "host": [ "{{base-url}}" ], "path": [ "ws", "api", "v1", "WS_PinControl" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "", "type": "text" } ], "cookie": [], "body": "{\n \"IssCode\": \"string\",\n \"PublicToken\": \"string\",\n \"ActionCode\": \"string\",\n \"PINStatus\": 0\n}" } ] }, { "name": "Customer Enquiry", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{access_token}}", "type": "string" } ] }, "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\r\n \r\n\"IssCode\":\"PMT\",\r\n\"PublicToken\": \"120398473\",\r\n\"ItemSrc\": 0\r\n \r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base-url}}/ws/api/v1/Ws_Customer_Enquiry", "host": [ "{{base-url}}" ], "path": [ "ws", "api", "v1", "Ws_Customer_Enquiry" ] }, "description": "The Set PIN Control endpoint enables you to set, retrieve, unblock and change the PIN associated with the card. It also allows you to unblock the CVC2 of a card or mobile device token.\n\nFor more information, see [Set PIN Control.](https://cardsapidocs.thredd.com/docs/set-pin-control)" }, "response": [ { "name": "Customer Enquiry", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\r\n \"moveBalance\": true,\r\n \"moveLimitAccumulators\": true,\r\n \"moveChildCards\": false,\r\n \"moveExpiryDate\": false,\r\n \"expiryDate\": \"2023-04\"\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base-url}}/ws/api/v1/Ws_Customer_Enquiry", "host": [ "{{base-url}}" ], "path": [ "ws", "api", "v1", "Ws_Customer_Enquiry" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "", "type": "text" } ], "cookie": [], "body": "{\n \"IssCode\": \"PMT\",\n \"TxnCode\": \"4\",\n \"PublicToken\": \"120398473\",\n \"CustAccount\": \"Mode 4 token\",\n \"CurCode\": \"GBP\",\n \"ActionCode\": \"000\",\n \"Primary\": null,\n \"Cards\": {\n \"CardList2\": [\n {\n \"PAN\": \"9999999894639225\",\n \"ExpDate\": \"2026-03-04\",\n \"CurCode\": \"GBP\",\n \"StatCode\": \"02\",\n \"CrdProduct\": \"MCRD\",\n \"Program\": \"PMTCGP\",\n \"DesignRef\": \"PMTCGP\",\n \"EmbossName\": \"Mr John Bloggs\",\n \"AvlBal\": \"100.00\",\n \"BlkAmt\": \"10.00\",\n \"FirstName\": \"John\",\n \"LastName\": \"Bloggs\",\n \"CustType\": null,\n \"PublicToken\": \"120398473\",\n \"Primary\": \"Y\",\n \"IsLive\": 0,\n \"Scheme\": \"GPS SCHEME TEST\",\n \"Product\": \"Test UK\",\n \"MCCGroup\": null,\n \"LimitGroup\": \"PMT-VL-003\",\n \"PERMSGroup\": \"PMT-CU-003\",\n \"FeeGroup\": null,\n \"SchedFeeGroup\": null,\n \"WsFeeGroup\": null,\n \"LinkageGroup\": null,\n \"PrimaryToken\": \"120398473\",\n \"MaskedPAN\": \"9999999894639225\",\n \"ProductID\": \"10006\",\n \"ProductRef\": \"PMTCGP\",\n \"AuthCalendarGroup\": null,\n \"FXGroup\": \"GPS-FX-001\",\n \"PaymentTokenUsageGroup\": \"20-GPS Dummy\",\n \"StartDate\": \"03/25\",\n \"EndDate\": \"02/35\"\n }\n ]\n }\n}" } ] }, { "name": "Clear Accumulator", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{access_token}}", "type": "string" } ] }, "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\r\n \"AuthType\": \"1\",\r\n \"PAN\": \"9999999999999999\",\r\n \"AccumulatorType\": \"1\",\r\n \"ClearAllDPANs\": \"1\"\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base-url}}/ws/api/v1/Ws_ResetAccumulator", "host": [ "{{base-url}}" ], "path": [ "ws", "api", "v1", "Ws_ResetAccumulator" ] }, "description": "The Clear Accumulator endpoint enables you to reset transaction and amount counters (since the last strongly-cardholder-authenticated transaction) on a card or payment-token. The endpoint also re-enables transactions (which are blocked as a result of the transaction) and amount counters exceeding the defined maximum limits for transactions that don’t meet the security requirements.\n\nFor more information, see [Clear Accumulator.](https://cardsapidocs.thredd.com/docs/clear-accumulator)" }, "response": [ { "name": "Clear Accumulator", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\r\n \"AuthType\": \"1\",\r\n \"PAN\": \"9999999999999999\",\r\n \"AccumulatorType\": \"1\",\r\n \"ClearAllDPANs\": \"1\"\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base-url}}/ws/api/v1/Ws_ResetAccumulator", "host": [ "{{base-url}}" ], "path": [ "ws", "api", "v1", "Ws_ResetAccumulator" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "", "type": "text" } ], "cookie": [], "body": "{\n \"IssCode\": \"string\",\n \"PublicToken\": \"string\",\n \"ActionCode\": \"string\",\n \"WebServiceResult\": {\n \"IssCode\": \"string\",\n \"PublicToken\": \"string\",\n \"Response\": \"string\",\n \"Description\": \"string\",\n \"ActionCode\": \"string\"\n }\n}" } ] }, { "name": "STIP Balance Update", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{access_token}}", "type": "string" } ] }, "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\r\n \"wsid\": \"20250213165006\",\r\n \"TxnCode\": \"16\",\r\n \"PublicToken\": \"123456789\",\r\n \"CurrCode\": \"GBP\",\r\n \"AvlBalance_GPS_STIP\": \"100\",\r\n \"CurBalance_GPS_STIP\": \"110\",\r\n \"Balance_Sequence_Exthost\": \"1\",\r\n \"LoadedBy\": \"John Bloggs\",\r\n \"IssCode\": \"PMT\",\r\n \"LocDate\": \"2025-02-13\",\r\n \"LocTime\": \"120000\"\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base-url}}ws/api/v1/Ws_BalanceUpdate", "host": [ "{{base-url}}ws" ], "path": [ "api", "v1", "Ws_BalanceUpdate" ] }, "description": "The Card Balance Update endpoint enables you to update the available and current balance for EHI (External Host Interface) Mode 4 and 5 Cards.\n\nFor more information, see [Card Balance Update.](https://cardsapidocs.thredd.com/docs/card-balance-update)" }, "response": [ { "name": "STIP Balance Update", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\r\n \"wsid\": \"20250213165006\",\r\n \"TxnCode\": \"16\",\r\n \"PublicToken\": \"123456789\",\r\n \"CurrCode\": \"GBP\",\r\n \"AvlBalance_GPS_STIP\": \"100\",\r\n \"CurBalance_GPS_STIP\": \"110\",\r\n \"Balance_Sequence_Exthost\": \"1\",\r\n \"LoadedBy\": \"John Bloggs\",\r\n \"IssCode\": \"PMT\",\r\n \"LocDate\": \"2025-02-13\",\r\n \"LocTime\": \"120000\"\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base-url}}ws/api/v1/Ws_BalanceUpdate", "host": [ "{{base-url}}ws" ], "path": [ "api", "v1", "Ws_BalanceUpdate" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "", "type": "text" } ], "cookie": [], "body": "{\n \"IssCode\": \"string\",\n \"CurCode\": \"string\",\n \"Balance_Sequence_Exthost\": 0,\n \"Balance_Sequence\": 0,\n \"ItemID\": \"string\",\n \"ActionCode\": \"string\",\n \"WebServiceResult\": {}\n}" } ] }, { "name": "Bulk Card Creation", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{access_token}}", "type": "string" } ] }, "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\r\n \"CARD\": [\r\n {\r\n \"IssCode\": \"PMT\",\r\n \"CardDesign\": \"10023\",\r\n \"LoadValue\": \"0\",\r\n \"CurCode\": \"EUR\",\r\n \"ItemSrc\": \"2\",\r\n \"LoadFee\": \"0.0\",\r\n \"CreateImage\": \"0\",\r\n \"CreateType\": \"2\"\r\n },\r\n {\r\n \"IssCode\": \"PMT\",\r\n \"CardDesign\": \"10023\",\r\n \"LoadValue\": \"0\",\r\n \"CurCode\": \"EUR\",\r\n \"ItemSrc\": \"2\",\r\n \"LoadFee\": \"0.0\",\r\n \"CreateImage\": \"0\",\r\n \"CreateType\": \"2\"\r\n }\r\n ]\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base-url}}ws/api/v1/Ws_BulkWalletCreation", "host": [ "{{base-url}}ws" ], "path": [ "api", "v1", "Ws_BulkWalletCreation" ] }, "description": "The Card Balance Update endpoint enables you to update the available and current balance for EHI (External Host Interface) Mode 4 and 5 Cards.\n\nFor more information, see [Card Balance Update.](https://cardsapidocs.thredd.com/docs/card-balance-update)" }, "response": [ { "name": "Bulk Card Creation", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\r\n \"CARD\": [\r\n {\r\n \"IssCode\": \"PMT\",\r\n \"CardDesign\": \"10023\",\r\n \"LoadValue\": \"0\",\r\n \"CurCode\": \"EUR\",\r\n \"ItemSrc\": \"2\",\r\n \"LoadFee\": \"0.0\",\r\n \"CreateImage\": \"0\",\r\n \"CreateType\": \"2\"\r\n },\r\n {\r\n \"IssCode\": \"PMT\",\r\n \"CardDesign\": \"10023\",\r\n \"LoadValue\": \"0\",\r\n \"CurCode\": \"EUR\",\r\n \"ItemSrc\": \"2\",\r\n \"LoadFee\": \"0.0\",\r\n \"CreateImage\": \"0\",\r\n \"CreateType\": \"2\"\r\n }\r\n ]\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base-url}}ws/api/v1/Ws_BulkCreation", "host": [ "{{base-url}}ws" ], "path": [ "api", "v1", "Ws_BulkCreation" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "" } ], "cookie": [], "body": "{\n \"CardsCreated\": 2,\n \"CardsNotCreated\": 0,\n \"ActionCode\": \"000\",\n \"RequestWithError\": null,\n \"Cards\": [\n {\n \"IssCode\": \"PMT\",\n \"PublicToken\": \"121731745\",\n \"ExternalRef\": null,\n \"ItemID\": \"6167079530\",\n \"ClientCode\": \"0\",\n \"SysDate\": \"2025-10-07\",\n \"ActionCode\": \"000\",\n \"LoadValue\": \"10.00\",\n \"IsLive\": \"false\",\n \"StartDate\": \"10/25\",\n \"ExpDate\": \"08/35\",\n \"CVV\": \"037\",\n \"MaskedPAN\": \"9999999318829972\"\n },\n {\n \"IssCode\": \"PMT\",\n \"PublicToken\": \"121731746\",\n \"ExternalRef\": null,\n \"ItemID\": \"6167079531\",\n \"ClientCode\": \"0\",\n \"SysDate\": \"2025-10-07\",\n \"ActionCode\": \"000\",\n \"LoadValue\": \"10.00\",\n \"IsLive\": \"false\",\n \"StartDate\": \"10/25\",\n \"ExpDate\": \"08/35\",\n \"CVV\": \"724\",\n \"MaskedPAN\": \"9999999294446783\"\n }\n ]\n}" } ] }, { "name": "Card Balance Update", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{access_token}}", "type": "string" } ] }, "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\r\n \"TxnCode\": \"16\",\r\n \"PublicToken\": \"123456789\",\r\n \"CurrCode\": \"GBP\",\r\n \"AvlBalance_GPS_STIP\": \"100\",\r\n \"CurBalance_GPS_STIP\": \"110\",\r\n \"Balance_Sequence_Exthost\": \"1\",\r\n \"LoadedBy\": \"John Bloggs\"\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base-url}}ws/api/v1/Ws_BalanceUpdate", "host": [ "{{base-url}}ws" ], "path": [ "api", "v1", "Ws_BalanceUpdate" ] }, "description": "The Card Balance Update endpoint enables you to update the available and current balance for EHI (External Host Interface) Mode 4 and 5 Cards.\n\nFor more information, see [Card Balance Update.](https://cardsapidocs.thredd.com/docs/card-balance-update)" }, "response": [ { "name": "Card Balance Update", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\r\n \"TxnCode\": \"16\",\r\n \"PublicToken\": \"123456789\",\r\n \"CurrCode\": \"GBP\",\r\n \"AvlBalance_GPS_STIP\": \"100\",\r\n \"CurBalance_GPS_STIP\": \"110\",\r\n \"Balance_Sequence_Exthost\": \"1\",\r\n \"LoadedBy\": \"John Bloggs\"\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base-url}}ws/api/v1/Ws_BalanceUpdate", "host": [ "{{base-url}}ws" ], "path": [ "api", "v1", "Ws_BalanceUpdate" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "", "type": "text" } ], "cookie": [], "body": "{\n \"IssCode\": \"string\",\n \"CurCode\": \"string\",\n \"Balance_Sequence_Exthost\": 0,\n \"Balance_Sequence\": 0,\n \"ItemID\": \"string\",\n \"ActionCode\": \"string\",\n \"WebServiceResult\": {}\n}" } ] } ], "description": "SOAP Webservices to REST via API Hub" }, { "name": "Provisioning Enablement", "item": [ { "name": "Google Unified Push Provisioning", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{access_token}}", "type": "string" } ] }, "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\r\n \"clientWalletProvider\": \"40010075001\",\r\n \"clientWalletAccountID\": \"Lejk2eFZ0gPe9DOFNDAhfHy3\",\r\n \"clientDeviceID\": \"rdtZyP8u4O5LkQFRgPAB-sHo\",\r\n \"clientAppID\": \"VisaApp\",\r\n \"billing\": {\r\n \"line1\": \"1 Pier Road\",\r\n \"line2\": \"St Bees\",\r\n \"city\": \"Southend\",\r\n \"countrySubdivision\": \"Essex\",\r\n \"postalCode\": \"GU9 8DW\",\r\n \"country\": \"United Kingdom\"\r\n }\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base-url}}dcs/api/v1/provisioning/{{publicToken}}/googlewallet", "host": [ "{{base-url}}dcs" ], "path": [ "api", "v1", "provisioning", "{{publicToken}}", "googlewallet" ] }, "description": "The Google In-App Push Provisioning endpoint enables you to share a customer's Google wallet information with Thredd.\n\nYou can share a Google wallet by making a POST request to the Google In-App Push Provisioning endpoint. \n\nFor more information, see [Google In-App Push Provisioning.](https://cardsapidocs.thredd.com/docs/request-google-payload)" }, "response": [ { "name": "Google Unified Push Provisioning Wallet", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\r\n \"clientWalletProvider\": \"40010075001\",\r\n \"clientWalletAccountID\": \"Lejk2eFZ0gPe9DOFNDAhfHy3\",\r\n \"clientDeviceID\": \"rdtZyP8u4O5LkQFRgPAB-sHo\",\r\n \"clientAppID\": \"VisaApp\",\r\n \"billing\": {\r\n \"line1\": \"1 Pier Road\",\r\n \"line2\": \"St Bees\",\r\n \"city\": \"Southend\",\r\n \"countrySubdivision\": \"Essex\",\r\n \"postalCode\": \"GU9 8DW\",\r\n \"country\": \"United Kingdom\"\r\n }\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base-url}}dcs/api/v1/provisioning/{{publicToken}}/googlewallet", "host": [ "{{base-url}}dcs" ], "path": [ "api", "v1", "provisioning", "{{publicToken}}", "googlewallet" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "", "type": "text" } ], "cookie": [], "body": "{\n \"opaquePaymentCard\": \"ewogICJmdW5kaW5nQWNjb3VudEluZm8iOiB7CiAgICAiZW5jcnlwdGVkUGF5bG9hZCI6ICI3QjBBMjAyMDIyNzA3NTYyNkM2OTYzNEI2NTc5NDY2OTZFNjc2NTcyNzA3MjY5NkU3NDIyM0EyMDIyMzczNjMxNDIzMDMwMzM0MzMxNDU0MTQ0NDUzMzQxMzUzNDM5MzA0NTM1MzAzMDMwNDQzMzM3MzgzODM3NDI0MTQxMzU0NTM2NDU0MzMwNDUzMjMyMzY0MzMwMzczNzMwMzY0NTM1MzkzOTM0MzUzMTQ2NDMzMDMzMzI0MTM3MzkyMjJDMEEyMDIwMjI2NTZFNjM3Mjc5NzA3NDY1NjQ0QjY1NzkyMjNBMjAyMjMyNDQzOTM3NDI0NjMzNDE0MzMzMzIzMjMxMzY0NDMwMzMzMzM1MzAzOTMxMzczOTMyMzIzNzMxMzMzODMzMzYzNzQ1NDUzNjQzMzQzNzQ1MzczNTM3NDIzNzM2NDYzMjM4NDM0NTM0NDUzMDMzNDQzNjQyMzA0NDM3NDUzNjQyMzI0NjM5MzUzOTMzMzk0MTMyMzgzNTQxNDEzNjM1NDU0MzQ0MzAzMzQzNDYzMDM1MzYzNDQzNDUzOTM1NDYzOTMzNDMzODQzNDEzMTQyMzI0MTMxMzgzNzM2MzkzNzMxNDI0MjMxMzMzNTQzNDUzNzQxMzYzNjMzNDU0NDMxNDQzODQ1NDMzNDQzNDQ0NDM5NDE0MTQ1NDEzMjMzNDUzNDM5NDEzMDQ2MzMzODQ2MzkzMzQxNDI0MzM4NDUzMjM3NDM0MzMyNDYzMDQ2MzAzMjM4NDEzMDQ2MzUzMjM5Mzc0MTQ2MzAzNTMwNDI0NDM1NDMzMjM3NDQzMTMwMzkzNzMxNDU0NTQyMzgzMTQ2Mzg0MjM1NDEzODMyNDIzMDM3MzMzMjM2Mzc0NTM1MzczNjM1NDEzNjM5NDQ0MTQ2MzMzMDQ1Mzc0NDM5NDE0MzQ2MzQ0MzM4MzEzODQyMzE0NjM4MzYzODQyMzM0NTM5NDY0MzMzMzY0MzMwNDEzODM0MzY0MTM2NDE0NDQxMzIzMDQzNDEzNDMxNDY0NTMwMzM0NDQxNDU0MTQxMzQ0MjQ2MzQzNDMzMzMzMjQyNDUzNDQxMzc0MjQzMzE0MzMwMzg0NTMzMzU0NDQzMzAzNDQzNDQ0MjMzNDY0MTM0MzAzMTM5MzQzMDQxNDYzMDMzMzczOTM4MzAzNzMyMzYzMjQyNDEzMDM4MzEzMjQyMzczMDM5MzA0MzM5MzIzNTQxMzkzMzQ1MzI0NjMyMzAzMzM3MzQ0MjM5MzQzNTQxNDQ0MjQxNDM0MjQ2MzU0NDM3NDQzODMyMzY0NDQxNDU0MzM5NDEzMzMwNDYzNTQ2NDUzNDM0NDQzNDMxMzQzNDQyNDMzOTQxMzUzODM5MzgzMjMxMzA0NDMwMzU0NjM5MzczNTQyMzQzMTQ0MzYzNTMxNDY0MzQyMzMzNTQxMzQzNzM5NDQ0MzQxMzA0MjMzMzI0NjMwMzU0NDQ0MzA0MTMxNDUzMTM1MzEzMzQxMzczODQzNDEzNDQzMzczNzMyMzU0NjQ0NDE0MjMxNDY0MzM0Mzc0NTMyNDI0NTQzMzgzNjM4MzI0NTM1NDM0MTM2MzkzNDM4NDU0MzM2MzkzNzM3NDQ0MTM0NDUzMzMxNDQzNzM3NDYzNTM2NDUzMTQ1NDU0NDM0MzIzNDM2MzQzNjM3MzEyMjJDMEEyMDIwMjI2RjYxNjU3MDQ4NjE3MzY4Njk2RTY3NDE2QzY3NkY3MjY5NzQ2ODZEMjIzQTIwMjI1MzQ4NDEzMjM1MzYyMjJDMEEyMDIwMjI2OTc2MjIzQTIwMjIzNzM4MzczMDQ2MzIzMTQ0MzgzODM5NDYzNjM3MzgzNTQ1NDM0MjM2MzIzNjMwMzYzNTQxNDM0NjQ2NDUzMzMwMjIyQzBBMjAyMDIyNjU2RTYzNzI3OTcwNzQ2NTY0NDQ2MTc0NjEyMjNBMjAyMjM5MzAzOTQ1MzgzMzQyMzg0NjM0NDYzMzMwMzg0NTQxNDI0MjQzMzAzMzMxNDMzNjM2MzczOTMxNDEzMjMxNDEzMjMzMzUzMjMzMzYzNjMwNDIzMjM1NDEzMTQ2MzM0NjQzNDQzMDM1NDUzMDM3NDQzODMwNDUzNjMzNDQzOTM1MzM0MTM0NDU0NDM5NDU0NTQyNDY0MTQ0MzczODQ1Mzk0NjQzMzk0MjQxMzkzNzQ0MzMzMDQyMzU0MjM2MzkzNjMzNDUzNjM1NDUzOTMwMzAzNDMyMzE0MzMxNDU0NjM3NDIzNDMxNDQzMTQzMzEzMTMxNDYzMjM5MzA0NjM1MzAzMzMyMzEzMTM5NDEzMDMzMzk0NjM4MzEzOTQ1MzY0NTM0NDQzMzQ1MzMzMDMxMzUzNDM1Mzg0NjMxMzM0NTQzMzUzNTQzMzI0NTM5NDY0MjM5Mzc0NDM2MzEzMTM2NDE0MjQ0NDQzMzM3MzU0MjQyMzgzMTM2MzEzOTQxNDE0MzM2NDIzNTM2MzUzMjQ0Mzk0NDM0NDI0MzM5NDM0NTM2MzQzNDM1MzkzMDMyNDYzMTQ1NDMzNzM1MzczNzQ1MzAzNDQ1NDM0MjM1MzA0NTM0MzIzMTMwMzMzNDQ2NDI0NTMwNDQzODMzNDMzODQ2NDY0MzM3MzYzNTMwNDIzNTQxMzYzODQ1MzQzOTQyMzAzODMxMzgzODM3MzMzOTM2MzUzMjM1NDIzNjMwMzYzNDQ0MzczOTM2MzAzNDMzNDY0MjMzMzI0NTQyMzczMDM5MzMzNjM4NDQ0MzQyNDM0NTM5MzIzNTM4MzkzOTM4NDEzODQ2MzIzNDQ0MzQzNjMwMzczNTQzMzg0MzQ1MzAzMzQyMzIzODMwMzA0NjMxMzE0MzMzMzgzMzM0NDMzODM1NDEzMTMyNDIzNTM1MzIzMDM4NDMzMjM0NDUzODQ2MzM0MTM1MzI0NTQ2MzUzOTQxMzMzMDM4NDEzNDM3MzYzMDQ1MzY0MzMxMzU0MjM3NDQzNTQzNDIzNjM4MzQ0MTMwMzgzNzQ2MzQzNzQyMzk0NTM3NDQzNDMzNDQ0MzM0MzMzMTM2MzMzNzQyNDEzMTQzNDMzMDMwNDYzMDQxMzg0NjQ0MzEzMTM4MzEzODQ0NDUzMjM3MzQ0NTM3MzYzMDQ2MzM0MzM2NDE0MTQ2NDYzNDQxMzQ0MTM5NDY0MzM5MzIzNTM4MzUzMjM1NDQzODM5MzEzOTQ1MzEzNDM2NDEzNDM1MzUzOTMxMzM0MjMxNDMzNzMxMzQ0MTMxMzE0NTMyMzUzMDM3NDQzMjM4MzIzNDM4NDM0MjM1MzQ0MjM3MzczNzM5MzIzMjM4MzQzMDM0NDQzNTQzNDEzNzQxMzgzODM3MzkzNTQxNDUzMjQ2MzQzMTQ1MzIzMTM5MzE0MzM3NDIzNjM3MzkzMzQyMzE0MTMyMzkzNzM4MzM0NTM5MzE0MTQ2NDUzNDQ1MzUzNjQzNDIzOTM4MzUzMjM4Mzk0NDMxMzMzNDMzMzAzNTMyMzMzNTIyMEE3RCIKICB9LAogICJ0b2tlbml6YXRpb25BdXRoZW50aWNhdGlvblZhbHVlIjogImV3b2dJQ0oyWlhKemFXOXVJam9nSWpRaUxBb2dJQ0pyWlhsQmJHbGhjeUk2SUNKVVpYTjBTMlY1UVd4cFlYTWlMQW9nSUNKemFXZHVZWFIxY21WQmJHZHZjbWwwYUcwaU9pQWlVbE5CTFZOSVFUSTFOaUlzQ2lBZ0ltbHVZMngxWkdWa1JtbGxiR1J6U1c1UGNtUmxjaUk2SUNKa1lYUmhWbUZzYVdSVmJuUnBiRlJwYldWemRHRnRjSHhoWTJOdmRXNTBUblZ0WW1WeWZHRmpZMjkxYm5SRmVIQnBjbmtpTEFvZ0lDSmtZWFJoVm1Gc2FXUlZiblJwYkZScGJXVnpkR0Z0Y0NJNklDSXlNREkwTFRBMUxUSXdWREV3T2pVME9qRTJXaUlzQ2lBZ0luTnBaMjVoZEhWeVpTSTZJQ0pMTW5kWlRYUjBPSGRaVTNSSE5Vc3dObE5EWVRGb2VsRm9UbEY2YTJwNlZXTkpjbUZzWTA1YVVtbDJhR0UzUm5KT2ExUlpNMGRMVG5JclRIUnVhM29yYUZwa2JHeHVOMkpJVEZweFpYaHBVMmhoTUdKVFVURkRNVFJ6Vm0xcWRrWllTVXB3ZEVOUFdsaERZV2xFU3prMlRuUm5TVFpqU1c1WWNUTTJXVkJJZUhKd1RXWkNUWEZ1VUVKSFkyaGhhVXB5TDNwRldrNXpNbTAxUzB0WmFsUkplakpxVm5oa1VsUnJPR3g0YjNkaldpOXpPV0pVVjNONWNsUjJTRWhVYm05Mk5ubGpiMHM0VWpSRFdXbG5SVXRTT0dZMGVqUlhXbUUzU1Rsd1EydzJNRTluVDFwNWR6UlRZMDlOY0RocWQyRndialE0UVd4UGJsTm9iMllyTlhoclYxQmpWVEJ2WVZkNFUwVm9abVJITW1kYVVrTm9TRGs0YmxWSmIzazFaemxPU1ZoaVptbEhPV2gxUzJ0ME0wWnpZMHRzWWtZd1ZUVXdRMWxJV0d4cFp6WlpPRFppYlVnNEwxVTFNMEozYzFOMU1YbzNiV2M5UFNJS2ZRPT0iCn0=\",\n \"last4digits\": \"9999\",\n \"name\": \"Test User\",\n \"network\": \"Mastercard\",\n \"address\": {\n \"line1\": \"1 Pier Road\",\n \"line2\": \"St Bees\",\n \"city\": \"Southend\",\n \"countrySubdivision\": \"Essex\",\n \"postalCode\": \"GU9 8DW\",\n \"country\": \"United Kingdom\"\n }\n}" } ] }, { "name": "Apple In-App Push Provisioning", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{access_token}}", "type": "string" } ] }, "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\r\n \"certificates\": [\r\n \"MIICYDCCAgagAwIBAgIUCKCe7rVrw/SGstpLx4KPeLyRjCswCgYIKoZIzj0EAwIwaDELMAkGA1UEBhMCVUsxDjAMBgNVBAgMBVN0YXRlMQ8wDQYDVQQHDAZMb25kb24xDzANBgNVBAoMBlRocmVkZDEPMA0GA1UECwwGVGhyZWRkMRYwFAYDVQQDDA1QUFRocmVkZFN1YkNBMB4XDTI1MDIxMzE1MjAzMVoXDTM1MDIxMTE1MjAzMVowZzELMAkGA1UEBhMCVUsxDjAMBgNVBAgMBVN0YXRlMQ8wDQYDVQQHDAZMb25kb24xDzANBgNVBAoMBlRocmVkZDEPMA0GA1UECwwGVGhyZWRkMRUwEwYDVQQDDAxQUFRocmVkZExlYWYwWTATBgcqhkjOPQIBBggqhkjOPQMBBwNCAATQE/gJiPV/b0xByi4Fbr+UZbq7W5a7NmJlkXjIvBaiL5DoJQIM1maimcEXcuGxQg5ZGa78QVxZIC2QkUTBMYuko4GOMIGLMAkGA1UdEwQCMAAwDgYDVR0PAQH/BAQDAgWgMB0GA1UdJQQWMBQGCCsGAQUFBwMBBggrBgEFBQcDAjAPBgkqhkiG92NkBicEAgUAMB0GA1UdDgQWBBQ+D0zl7sC8vBWb/g90X1uF2xmNhDAfBgNVHSMEGDAWgBTmiALoFDbCkZEInQdscUx+10NpVDAKBggqhkjOPQQDAgNIADBFAiEAtdZ3fLs2gcidvknZQs9uDoVv6/fyf5GQ4SkeddbsYaACICYczmRL0PFSgF9O5LKDOSVnLbs9TDK1RiLEELtH6ovN\",\r\n \"MIICYDCCAgagAwIBAgIUCKCe7rVrw/SGstpLx4KPeLyRjCswCgYIKoZIzj0EAwIwaDELMAkGA1UEBhMCVUsxDjAMBgNVBAgMBVN0YXRlMQ8wDQYDVQQHDAZMb25kb24xDzANBgNVBAoMBlRocmVkZDEPMA0GA1UECwwGVGhyZWRkMRYwFAYDVQQDDA1QUFRocmVkZFN1YkNBMB4XDTI1MDIxMzE1MjAzMVoXDTM1MDIxMTE1MjAzMVowZzELMAkGA1UEBhMCVUsxDjAMBgNVBAgMBVN0YXRlMQ8wDQYDVQQHDAZMb25kb24xDzANBgNVBAoMBlRocmVkZDEPMA0GA1UECwwGVGhyZWRkMRUwEwYDVQQDDAxQUFRocmVkZExlYWYwWTATBgcqhkjOPQIBBggqhkjOPQMBBwNCAATQE/gJiPV/b0xByi4Fbr+UZbq7W5a7NmJlkXjIvBaiL5DoJQIM1maimcEXcuGxQg5ZGa78QVxZIC2QkUTBMYuko4GOMIGLMAkGA1UdEwQCMAAwDgYDVR0PAQH/BAQDAgWgMB0GA1UdJQQWMBQGCCsGAQUFBwMBBggrBgEFBQcDAjAPBgkqhkiG92NkBicEAgUAMB0GA1UdDgQWBBQ+D0zl7sC8vBWb/g90X1uF2xmNhDAfBgNVHSMEGDAWgBTmiALoFDbCkZEInQdscUx+10NpVDAKBggqhkjOPQQDAgNIADBFAiEAtdZ3fLs2gcidvknZQs9uDoVv6/fyf5GQ4SkeddbsYaACICYczmRL0PFSgF9O5LKDOSVnLbs9TDK1RiLEELtH6ovN\"\r\n ],\r\n \"nonce\": \"c5846fb5\",\r\n \"nonceSignature\": \"4061d9d63ed34825f285d953274a6c5e06ebe011bf91d79660e1f7c6f6d21427abb3a62e6352e430abff987f6ec37e5dff9f3dbe40275156d03eeb594ab191d2792f37ef13ac528a65f56165c1d753463f\"\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base-url}}dcs/api/v1/provisioning/{{publicToken}}/applewallet", "host": [ "{{base-url}}dcs" ], "path": [ "api", "v1", "provisioning", "{{publicToken}}", "applewallet" ] }, "description": "The Apple In-App Push Provisioning endpoint enables you to share a customer's Apple wallet information with Thredd.\n\nYou can share a customer's Apple wallet information by making a POST request to the Apple In-App Push Provisioning endpoint.\n\nFor more information, see [Apple In-App Push Provisioning.](https://cardsapidocs.thredd.com/docs/request-apple-payload)" }, "response": [ { "name": "Apple In-App Push Provisioning", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\r\n \"certificates\": [\r\n \"MIICYDCCAgagAwIBAgIUCKCe7rVrw/SGstpLx4KPeLyRjCswCgYIKoZIzj0EAwIwaDELMAkGA1UEBhMCVUsxDjAMBgNVBAgMBVN0YXRlMQ8wDQYDVQQHDAZMb25kb24xDzANBgNVBAoMBlRocmVkZDEPMA0GA1UECwwGVGhyZWRkMRYwFAYDVQQDDA1QUFRocmVkZFN1YkNBMB4XDTI1MDIxMzE1MjAzMVoXDTM1MDIxMTE1MjAzMVowZzELMAkGA1UEBhMCVUsxDjAMBgNVBAgMBVN0YXRlMQ8wDQYDVQQHDAZMb25kb24xDzANBgNVBAoMBlRocmVkZDEPMA0GA1UECwwGVGhyZWRkMRUwEwYDVQQDDAxQUFRocmVkZExlYWYwWTATBgcqhkjOPQIBBggqhkjOPQMBBwNCAATQE/gJiPV/b0xByi4Fbr+UZbq7W5a7NmJlkXjIvBaiL5DoJQIM1maimcEXcuGxQg5ZGa78QVxZIC2QkUTBMYuko4GOMIGLMAkGA1UdEwQCMAAwDgYDVR0PAQH/BAQDAgWgMB0GA1UdJQQWMBQGCCsGAQUFBwMBBggrBgEFBQcDAjAPBgkqhkiG92NkBicEAgUAMB0GA1UdDgQWBBQ+D0zl7sC8vBWb/g90X1uF2xmNhDAfBgNVHSMEGDAWgBTmiALoFDbCkZEInQdscUx+10NpVDAKBggqhkjOPQQDAgNIADBFAiEAtdZ3fLs2gcidvknZQs9uDoVv6/fyf5GQ4SkeddbsYaACICYczmRL0PFSgF9O5LKDOSVnLbs9TDK1RiLEELtH6ovN\",\r\n \"MIICYDCCAgagAwIBAgIUCKCe7rVrw/SGstpLx4KPeLyRjCswCgYIKoZIzj0EAwIwaDELMAkGA1UEBhMCVUsxDjAMBgNVBAgMBVN0YXRlMQ8wDQYDVQQHDAZMb25kb24xDzANBgNVBAoMBlRocmVkZDEPMA0GA1UECwwGVGhyZWRkMRYwFAYDVQQDDA1QUFRocmVkZFN1YkNBMB4XDTI1MDIxMzE1MjAzMVoXDTM1MDIxMTE1MjAzMVowZzELMAkGA1UEBhMCVUsxDjAMBgNVBAgMBVN0YXRlMQ8wDQYDVQQHDAZMb25kb24xDzANBgNVBAoMBlRocmVkZDEPMA0GA1UECwwGVGhyZWRkMRUwEwYDVQQDDAxQUFRocmVkZExlYWYwWTATBgcqhkjOPQIBBggqhkjOPQMBBwNCAATQE/gJiPV/b0xByi4Fbr+UZbq7W5a7NmJlkXjIvBaiL5DoJQIM1maimcEXcuGxQg5ZGa78QVxZIC2QkUTBMYuko4GOMIGLMAkGA1UdEwQCMAAwDgYDVR0PAQH/BAQDAgWgMB0GA1UdJQQWMBQGCCsGAQUFBwMBBggrBgEFBQcDAjAPBgkqhkiG92NkBicEAgUAMB0GA1UdDgQWBBQ+D0zl7sC8vBWb/g90X1uF2xmNhDAfBgNVHSMEGDAWgBTmiALoFDbCkZEInQdscUx+10NpVDAKBggqhkjOPQQDAgNIADBFAiEAtdZ3fLs2gcidvknZQs9uDoVv6/fyf5GQ4SkeddbsYaACICYczmRL0PFSgF9O5LKDOSVnLbs9TDK1RiLEELtH6ovN\"\r\n ],\r\n \"nonce\": \"c5846fb5\",\r\n \"nonceSignature\": \"4061d9d63ed34825f285d953274a6c5e06ebe011bf91d79660e1f7c6f6d21427abb3a62e6352e430abff987f6ec37e5dff9f3dbe40275156d03eeb594ab191d2792f37ef13ac528a65f56165c1d753463f\"\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base-url}}dcs/api/v1/provisioning/{{publicToken}}/applewallet", "host": [ "{{base-url}}dcs" ], "path": [ "api", "v1", "provisioning", "{{publicToken}}", "applewallet" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "", "type": "text" } ], "cookie": [], "body": "{\n \"encryptedPassData\": \"ew0KICAiTmFtZSI6ICIiLA0KICAiTm9uY2UiOiAiIiwNCiAgIk5vbmNlU2lnbmF0dXJlIjogIiIsDQogICJQcmltYXJ5QWNjb3VudE51bWJlclByZWZpeCI6ICIiLA0KICAiRW5jcnlwdGVkUHJpbWFyeUFjY291bnROdW1iZXIiOiB7DQogICAgIkVuY3J5cHRlZFBheWxvYWQiOiB7DQogICAgICAiUHVibGljS2V5RmluZ2VyUHJpbnQiOiAiIiwNCiAgICAgICJFbmNyeXB0ZWRLZXkiOiAiIiwNCiAgICAgICJPYWVwSGFzaGluZ0FsZ29yaXRobSI6ICIiLA0KICAgICAgIkl2IjogIiIsDQogICAgICAiRW5jcnlwdGVkRGF0YSI6ICIiDQogICAgfQ0KICB9LA0KICAiTmV0d29ya05hbWUiOiAiTWFzdGVyY2FyZCIsDQogICJQcm9kdWN0VHlwZSI6ICJERUZBVUxUX01BU1RFUkNBUkQiLA0KICAiVmVyc2lvbiI6ICIxIg0KfQ==\",\n \"activationData\": \"ew0KICAiVmVyc2lvbiI6ICI0IiwNCiAgIktleUFsaWFzIjogIiIsDQogICJTaWduYXR1cmVBbGdvcml0aG0iOiAiUlNBLVNIQTI1NiIsDQogICJJbmNsdWRlZEZpZWxkc0luT3JkZXIiOiAiZGF0YVZhbGlkVW50aWxUaW1lc3RhbXB8YWNjb3VudE51bWJlcnxhY2NvdW50RXhwaXJ5IiwNCiAgIkRhdGFWYWxpZFVudGlsVGltZXN0YW1wIjogIiIsDQogICJTaWduYXR1cmUiOiAiIg0KfQ==\",\n \"ephemeralPublicKey\": \"MzkzMDAwMDA=\"\n}" } ] }, { "name": "Samsung In-App Push Provisioning (Visa only)", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{access_token}}", "type": "string" } ] }, "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\r\n \"clientWalletProvider\": \"40010075001\",\r\n \"clientWalletAccountID\": \"Lejk2eFZ0gPe9DOFNDAhfHy3\",\r\n \"clientDeviceID\": \"rdtZyP8u4O5LkQFRgPAB-sHo\",\r\n \"clientAppID\": \"VisaApp\",\r\n \"billing\": {\r\n \"line1\": \"1 Pier Road\",\r\n \"line2\": \"St Bees\",\r\n \"city\": \"Southend\",\r\n \"countrySubdivision\": \"Essex\",\r\n \"postalCode\": \"GU9 8DW\",\r\n \"country\": \"GBR\"\r\n }\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base-url}}dcs/api/v1/provisioning/{{publicToken}}/samsungwallet", "host": [ "{{base-url}}dcs" ], "path": [ "api", "v1", "provisioning", "{{publicToken}}", "samsungwallet" ] }, "description": "The Apple In-App Push Provisioning endpoint enables you to share a customer's Apple wallet information with Thredd.\n\nYou can share a customer's Apple wallet information by making a POST request to the Apple In-App Push Provisioning endpoint.\n\nFor more information, see [Apple In-App Push Provisioning.](https://cardsapidocs.thredd.com/docs/request-apple-payload)" }, "response": [ { "name": "Samsung In-App Push Provisioning (Visa only)", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\r\n \"clientWalletProvider\": \"40010075001\",\r\n \"clientWalletAccountID\": \"Lejk2eFZ0gPe9DOFNDAhfHy3\",\r\n \"clientDeviceID\": \"rdtZyP8u4O5LkQFRgPAB-sHo\",\r\n \"clientAppID\": \"VisaApp\",\r\n \"billing\": {\r\n \"line1\": \"1 Pier Road\",\r\n \"line2\": \"St Bees\",\r\n \"city\": \"Southend\",\r\n \"countrySubdivision\": \"Essex\",\r\n \"postalCode\": \"GU9 8DW\",\r\n \"country\": \"GBR\"\r\n }\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base-url}}dcs/api/v1/provisioning/{{publicToken}}/samsungwallet", "host": [ "{{base-url}}dcs" ], "path": [ "api", "v1", "provisioning", "{{publicToken}}", "samsungwallet" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "", "header": [], "cookie": [ { "expires": "Invalid Date", "domain": "", "path": "" } ], "body": "{\n \"opaquePaymentCard\": \"ewogICJmdW5kaW5nQWNjb3VudEluZm8iOiB7CiAgICAiZW5jcnlwdGVkUGF5bG9hZCI6ICI3QjBBMjAyMDIyNzA3NTYyNkM2OTYzNEI2NTc5NDY2OTZFNjc2NTcyNzA3MjY5NkU3NDIyM0EyMDIyMzczNjMxNDIzMDMwMzM0MzMxNDU0MTQ0NDUzMzQxMzUzNDM5MzA0NTM1MzAzMDMwNDQzMzM3MzgzODM3NDI0MTQxMzU0NTM2NDU0MzMwNDUzMjMyMzY0MzMwMzczNzMwMzY0NTM1MzkzOTM0MzUzMTQ2NDMzMDMzMzI0MTM3MzkyMjJDMEEyMDIwMjI2NTZFNjM3Mjc5NzA3NDY1NjQ0QjY1NzkyMjNBMjAyMjMyNDQzOTM3NDI0NjMzNDE0MzMzMzIzMjMxMzY0NDMwMzMzMzM1MzAzOTMxMzczOTMyMzIzNzMxMzMzODMzMzYzNzQ1NDUzNjQzMzQzNzQ1MzczNTM3NDIzNzM2NDYzMjM4NDM0NTM0NDUzMDMzNDQzNjQyMzA0NDM3NDUzNjQyMzI0NjM5MzUzOTMzMzk0MTMyMzgzNTQxNDEzNjM1NDU0MzQ0MzAzMzQzNDYzMDM1MzYzNDQzNDUzOTM1NDYzOTMzNDMzODQzNDEzMTQyMzI0MTMxMzgzNzM2MzkzNzMxNDI0MjMxMzMzNTQzNDUzNzQxMzYzNjMzNDU0NDMxNDQzODQ1NDMzNDQzNDQ0NDM5NDE0MTQ1NDEzMjMzNDUzNDM5NDEzMDQ2MzMzODQ2MzkzMzQxNDI0MzM4NDUzMjM3NDM0MzMyNDYzMDQ2MzAzMjM4NDEzMDQ2MzUzMjM5Mzc0MTQ2MzAzNTMwNDI0NDM1NDMzMjM3NDQzMTMwMzkzNzMxNDU0NTQyMzgzMTQ2Mzg0MjM1NDEzODMyNDIzMDM3MzMzMjM2Mzc0NTM1MzczNjM1NDEzNjM5NDQ0MTQ2MzMzMDQ1Mzc0NDM5NDE0MzQ2MzQ0MzM4MzEzODQyMzE0NjM4MzYzODQyMzM0NTM5NDY0MzMzMzY0MzMwNDEzODM0MzY0MTM2NDE0NDQxMzIzMDQzNDEzNDMxNDY0NTMwMzM0NDQxNDU0MTQxMzQ0MjQ2MzQzNDMzMzMzMjQyNDUzNDQxMzc0MjQzMzE0MzMwMzg0NTMzMzU0NDQzMzAzNDQzNDQ0MjMzNDY0MTM0MzAzMTM5MzQzMDQxNDYzMDMzMzczOTM4MzAzNzMyMzYzMjQyNDEzMDM4MzEzMjQyMzczMDM5MzA0MzM5MzIzNTQxMzkzMzQ1MzI0NjMyMzAzMzM3MzQ0MjM5MzQzNTQxNDQ0MjQxNDM0MjQ2MzU0NDM3NDQzODMyMzY0NDQxNDU0MzM5NDEzMzMwNDYzNTQ2NDUzNDM0NDQzNDMxMzQzNDQyNDMzOTQxMzUzODM5MzgzMjMxMzA0NDMwMzU0NjM5MzczNTQyMzQzMTQ0MzYzNTMxNDY0MzQyMzMzNTQxMzQzNzM5NDQ0MzQxMzA0MjMzMzI0NjMwMzU0NDQ0MzA0MTMxNDUzMTM1MzEzMzQxMzczODQzNDEzNDQzMzczNzMyMzU0NjQ0NDE0MjMxNDY0MzM0Mzc0NTMyNDI0NTQzMzgzNjM4MzI0NTM1NDM0MTM2MzkzNDM4NDU0MzM2MzkzNzM3NDQ0MTM0NDUzMzMxNDQzNzM3NDYzNTM2NDUzMTQ1NDU0NDM0MzIzNDM2MzQzNjM3MzEyMjJDMEEyMDIwMjI2RjYxNjU3MDQ4NjE3MzY4Njk2RTY3NDE2QzY3NkY3MjY5NzQ2ODZEMjIzQTIwMjI1MzQ4NDEzMjM1MzYyMjJDMEEyMDIwMjI2OTc2MjIzQTIwMjIzNzM4MzczMDQ2MzIzMTQ0MzgzODM5NDYzNjM3MzgzNTQ1NDM0MjM2MzIzNjMwMzYzNTQxNDM0NjQ2NDUzMzMwMjIyQzBBMjAyMDIyNjU2RTYzNzI3OTcwNzQ2NTY0NDQ2MTc0NjEyMjNBMjAyMjM5MzAzOTQ1MzgzMzQyMzg0NjM0NDYzMzMwMzg0NTQxNDI0MjQzMzAzMzMxNDMzNjM2MzczOTMxNDEzMjMxNDEzMjMzMzUzMjMzMzYzNjMwNDIzMjM1NDEzMTQ2MzM0NjQzNDQzMDM1NDUzMDM3NDQzODMwNDUzNjMzNDQzOTM1MzM0MTM0NDU0NDM5NDU0NTQyNDY0MTQ0MzczODQ1Mzk0NjQzMzk0MjQxMzkzNzQ0MzMzMDQyMzU0MjM2MzkzNjMzNDUzNjM1NDUzOTMwMzAzNDMyMzE0MzMxNDU0NjM3NDIzNDMxNDQzMTQzMzEzMTMxNDYzMjM5MzA0NjM1MzAzMzMyMzEzMTM5NDEzMDMzMzk0NjM4MzEzOTQ1MzY0NTM0NDQzMzQ1MzMzMDMxMzUzNDM1Mzg0NjMxMzM0NTQzMzUzNTQzMzI0NTM5NDY0MjM5Mzc0NDM2MzEzMTM2NDE0MjQ0NDQzMzM3MzU0MjQyMzgzMTM2MzEzOTQxNDE0MzM2NDIzNTM2MzUzMjQ0Mzk0NDM0NDI0MzM5NDM0NTM2MzQzNDM1MzkzMDMyNDYzMTQ1NDMzNzM1MzczNzQ1MzAzNDQ1NDM0MjM1MzA0NTM0MzIzMTMwMzMzNDQ2NDI0NTMwNDQzODMzNDMzODQ2NDY0MzM3MzYzNTMwNDIzNTQxMzYzODQ1MzQzOTQyMzAzODMxMzgzODM3MzMzOTM2MzUzMjM1NDIzNjMwMzYzNDQ0MzczOTM2MzAzNDMzNDY0MjMzMzI0NTQyMzczMDM5MzMzNjM4NDQ0MzQyNDM0NTM5MzIzNTM4MzkzOTM4NDEzODQ2MzIzNDQ0MzQzNjMwMzczNTQzMzg0MzQ1MzAzMzQyMzIzODMwMzA0NjMxMzE0MzMzMzgzMzM0NDMzODM1NDEzMTMyNDIzNTM1MzIzMDM4NDMzMjM0NDUzODQ2MzM0MTM1MzI0NTQ2MzUzOTQxMzMzMDM4NDEzNDM3MzYzMDQ1MzY0MzMxMzU0MjM3NDQzNTQzNDIzNjM4MzQ0MTMwMzgzNzQ2MzQzNzQyMzk0NTM3NDQzNDMzNDQ0MzM0MzMzMTM2MzMzNzQyNDEzMTQzNDMzMDMwNDYzMDQxMzg0NjQ0MzEzMTM4MzEzODQ0NDUzMjM3MzQ0NTM3MzYzMDQ2MzM0MzM2NDE0MTQ2NDYzNDQxMzQ0MTM5NDY0MzM5MzIzNTM4MzUzMjM1NDQzODM5MzEzOTQ1MzEzNDM2NDEzNDM1MzUzOTMxMzM0MjMxNDMzNzMxMzQ0MTMxMzE0NTMyMzUzMDM3NDQzMjM4MzIzNDM4NDM0MjM1MzQ0MjM3MzczNzM5MzIzMjM4MzQzMDM0NDQzNTQzNDEzNzQxMzgzODM3MzkzNTQxNDUzMjQ2MzQzMTQ1MzIzMTM5MzE0MzM3NDIzNjM3MzkzMzQyMzE0MTMyMzkzNzM4MzM0NTM5MzE0MTQ2NDUzNDQ1MzUzNjQzNDIzOTM4MzUzMjM4Mzk0NDMxMzMzNDMzMzAzNTMyMzMzNTIyMEE3RCIKICB9LAogICJ0b2tlbml6YXRpb25BdXRoZW50aWNhdGlvblZhbHVlIjogImV3b2dJQ0oyWlhKemFXOXVJam9nSWpRaUxBb2dJQ0pyWlhsQmJHbGhjeUk2SUNKVVpYTjBTMlY1UVd4cFlYTWlMQW9nSUNKemFXZHVZWFIxY21WQmJHZHZjbWwwYUcwaU9pQWlVbE5CTFZOSVFUSTFOaUlzQ2lBZ0ltbHVZMngxWkdWa1JtbGxiR1J6U1c1UGNtUmxjaUk2SUNKa1lYUmhWbUZzYVdSVmJuUnBiRlJwYldWemRHRnRjSHhoWTJOdmRXNTBUblZ0WW1WeWZHRmpZMjkxYm5SRmVIQnBjbmtpTEFvZ0lDSmtZWFJoVm1Gc2FXUlZiblJwYkZScGJXVnpkR0Z0Y0NJNklDSXlNREkwTFRBMUxUSXdWREV3T2pVME9qRTJXaUlzQ2lBZ0luTnBaMjVoZEhWeVpTSTZJQ0pMTW5kWlRYUjBPSGRaVTNSSE5Vc3dObE5EWVRGb2VsRm9UbEY2YTJwNlZXTkpjbUZzWTA1YVVtbDJhR0UzUm5KT2ExUlpNMGRMVG5JclRIUnVhM29yYUZwa2JHeHVOMkpJVEZweFpYaHBVMmhoTUdKVFVURkRNVFJ6Vm0xcWRrWllTVXB3ZEVOUFdsaERZV2xFU3prMlRuUm5TVFpqU1c1WWNUTTJXVkJJZUhKd1RXWkNUWEZ1VUVKSFkyaGhhVXB5TDNwRldrNXpNbTAxUzB0WmFsUkplakpxVm5oa1VsUnJPR3g0YjNkaldpOXpPV0pVVjNONWNsUjJTRWhVYm05Mk5ubGpiMHM0VWpSRFdXbG5SVXRTT0dZMGVqUlhXbUUzU1Rsd1EydzJNRTluVDFwNWR6UlRZMDlOY0RocWQyRndialE0UVd4UGJsTm9iMllyTlhoclYxQmpWVEJ2WVZkNFUwVm9abVJITW1kYVVrTm9TRGs0YmxWSmIzazFaemxPU1ZoaVptbEhPV2gxUzJ0ME0wWnpZMHRzWWtZd1ZUVXdRMWxJV0d4cFp6WlpPRFppYlVnNEwxVTFNMEozYzFOMU1YbzNiV2M5UFNJS2ZRPT0iCn0=\",\n \"last4digits\": \"9999\",\n \"name\": \"Test User\",\n \"network\": \"Visa\",\n \"address\": {\n \"line1\": \"1 Pier Road\",\n \"line2\": \"St Bees\",\n \"city\": \"Southend\",\n \"countrySubdivision\": \"Essex\",\n \"postalCode\": \"GU9 8DW\",\n \"country\": \"GBR\"\n }\n}" } ] }, { "name": "Apple In-App Verification", "request": { "method": "GET", "header": [ { "key": "client-id", "value": "123", "type": "text" } ], "url": { "raw": "{{base-url}}dcs/api/v1/provisioning/{{publicToken}}/applewallet/verification", "host": [ "{{base-url}}dcs" ], "path": [ "api", "v1", "provisioning", "{{publicToken}}", "applewallet", "verification" ] }, "description": "Get all accounts for a specific OpenBanking customer." }, "response": [ { "name": "Apple In-App Verification", "originalRequest": { "method": "GET", "header": [ { "key": "client-id", "value": "123", "type": "text" } ], "url": { "raw": "{{base-url}}dcs/api/v1/provisioning/{{publicToken}}/applewallet/verification", "host": [ "{{base-url}}dcs" ], "path": [ "api", "v1", "provisioning", "{{publicToken}}", "applewallet", "verification" ] } }, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "", "type": "text" } ], "cookie": [ { "expires": "Invalid Date", "domain": "", "path": "" } ], "body": "{\n \"activationData\": \"ew0KICAiVmVyc2lvbiI6ICI0IiwNCiAgIktleUFsaWFzIjogIiIsDQogICJTaWduYXR1cmVBbGdvcml0aG0iOiAiUlNBLVNIQTI1NiIsDQogICJJbmNsdWRlZEZpZWxkc0luT3JkZXIiOiAiZGF0YVZhbGlkVW50aWxUaW1lc3RhbXB8YWNjb3VudE51bWJlcnxhY2NvdW50RXhwaXJ5IiwNCiAgIkRhdGFWYWxpZFVudGlsVGltZXN0YW1wIjogIiIsDQogICJTaWduYXR1cmUiOiAiIg0KfQ==\"\n}" } ] }, { "name": "Apple Web Push Provisioning", "request": { "method": "POST", "header": [ { "key": "client-id", "value": "123", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"cardArtId\": \"12345\",\n \"termsId\": \"67890\",\n \"productName\": \"Product A\",\n \"policyId\": \"f47ac10b-58cc-4372-a567-0e02b2c3d479\" \n}\n", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base-url}}api/v2/webprovisioning/{{publicToken}}/applewallet", "host": [ "{{base-url}}api" ], "path": [ "v2", "webprovisioning", "{{publicToken}}", "applewallet" ] }, "description": "Get all accounts for a specific OpenBanking customer." }, "response": [ { "name": "Apple Web Push Provisioning", "originalRequest": { "method": "POST", "header": [ { "key": "client-id", "value": "123", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"cardArtId\": \"12345\",\n \"termsId\": \"67890\",\n \"productName\": \"Product A\",\n \"policyId\": \"f47ac10b-58cc-4372-a567-0e02b2c3d479\" \n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base-url}}api/v2/webprovisioning/{{publicToken}}/applewallet", "host": [ "{{base-url}}api" ], "path": [ "v2", "webprovisioning", "{{publicToken}}", "applewallet" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "", "type": "text" } ], "cookie": [ { "expires": "Invalid Date", "domain": "", "path": "" } ], "body": "{\n \"jws\": {\n \"protected\": \"string\",\n \"payload\": \"string\",\n \"signature\": \"string\",\n \"header\": {\n \"kid\": \"string\"\n }\n },\n \"state\": \"string\"\n}" } ] } ] }, { "name": "Transaction Confirmation Events", "item": [ { "name": "Create Configuration", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{access_token}}", "type": "string" } ] }, "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\r\n \"pmId\": 20,\r\n \"productId\": 345678,\r\n \"status\": \"Active\",\r\n \"messageTypeFilter\": [1, 2, 3 ]\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base-url}}eds/api/v1/Configs", "host": [ "{{base-url}}eds" ], "path": [ "api", "v1", "Configs" ] }, "description": "The Create Configuration endpoint enables you to create a configuration for a Transaction Confirmation (TC) event.\n\nFor more information, see [Create Configuration](https://cardsapidocs.thredd.com/v2.0/docs/create-configuration#/)." }, "response": [ { "name": "Create Configuration", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\r\n \"pmId\": 20,\r\n \"productId\": 345678,\r\n \"status\": \"Active\",\r\n \"messageTypeFilter\": [1, 2, 3 ]\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base-url}}eds/api/v1/Configs", "host": [ "{{base-url}}eds" ], "path": [ "api", "v1", "Configs" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "", "type": "text" } ], "cookie": [], "body": "{\n \"status\": \"success\",\n \"response\": {\n \"content\": [\n {\n \"configId\": \"5789653-20250602063331\",\n \"pmId\": 20,\n \"status\": \"Active\",\n \"messageTypeFilter\": [1,2],\n \"message\": \"Configuration created successfully.\"\n },\n {\n \"configId\": \"5789654-20250602063331\",\n \"productId\": 4589,\n \"status\": \"Active\",\n \"messageTypeFilter\": [1,2],\n \"message\": \"Configuration created successfully.\"\n }\n ],\n \"totalCount\": 2\n }\n}" } ] }, { "name": "List Configurations", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{access_token}}", "type": "string" } ] }, "method": "GET", "header": [], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base-url}}eds/api/v1/Configs", "host": [ "{{base-url}}eds" ], "path": [ "api", "v1", "Configs" ] }, "description": "The List Configurations endpoint enables you to retrieve all configurations that your institution has access to. \n\nFor more information, see [List Configuration](https://cardsapidocs.thredd.com/v2.0/docs/list-configurations#/)." }, "response": [ { "name": "List Configurations", "originalRequest": { "method": "GET", "header": [], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base-url}}eds/api/v1/Configs", "host": [ "{{base-url}}eds" ], "path": [ "api", "v1", "Configs" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "", "type": "text" } ], "cookie": [], "body": "{\n \"status\": \"success\",\n \"response\": {\n \"content\": [\n {\n \"configId\": \"85456236-20250758063331\",\n \"pmId\": 20,\n \"productId\": 345678,\n \"status\": \"active\",\n \"messageTypeFilter\": [\n 1,\n 2\n ],\n \"createdDate\": \"2025-07-01\",\n \"lastUpdatedDate\": \"2025-07-01T14:10:00Z\"\n }\n ],\n \"totalCount\": 1\n }\n}" } ] }, { "name": "Get Configuration by configId", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{access_token}}", "type": "string" } ] }, "method": "GET", "header": [], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base-url}}eds/api/v1/Configs/{{configId}}", "host": [ "{{base-url}}eds" ], "path": [ "api", "v1", "Configs", "{{configId}}" ] }, "description": "The Get Configuration by configId endpoint enables you to retrieve details for a specific configuration by the `configId`. \n\nFor more information, see [Get Configuration by configId](https://cardsapidocs.thredd.com/v2.0/docs/get-configuration-by-config-id#/)." }, "response": [ { "name": "Get Configuration by configId", "originalRequest": { "method": "GET", "header": [], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base-url}}eds/api/v1/Configs/{{configId}}", "host": [ "{{base-url}}eds" ], "path": [ "api", "v1", "Configs", "{{configId}}" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "", "type": "text" } ], "cookie": [], "body": "{\n \"pmId\": 20,\n \"productId\": 345678,\n \"status\": \"active\",\n \"messageTypeFilter\": [\n 1,\n 2\n ],\n \"createdDate\": \"2025-07-01T14:10:00Z\",\n \"lastUpdatedDate\": \"2025-07-01T14:10:00Z\"\n}" } ] }, { "name": "Update Configuration", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{access_token}}", "type": "string" } ] }, "method": "PUT", "header": [], "body": { "mode": "raw", "raw": "{\r\n \"status\": \"active\",\r\n \"messageTypeFilter\": [1,3]\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base-url}}eds/api/v1/Configs/{{configId}}", "host": [ "{{base-url}}eds" ], "path": [ "api", "v1", "Configs", "{{configId}}" ] }, "description": "The Update Configuration endpoint enables you to update an existing configuration based on the provided `configId` and request payload. \n\nFor more information, see [Update Configuration](https://cardsapidocs.thredd.com/v2.0/docs/update-configuration#/)." }, "response": [ { "name": "Update Configuration", "originalRequest": { "method": "PUT", "header": [], "body": { "mode": "raw", "raw": "{\r\n \"status\": \"active\",\r\n \"messageTypeFilter\": [1,3]\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base-url}}eds/api/v1/Configs/{{configId}}", "host": [ "{{base-url}}eds" ], "path": [ "api", "v1", "Configs", "{{configId}}" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "", "type": "text" } ], "cookie": [], "body": "" } ] }, { "name": "Update Configuration Status", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{access_token}}", "type": "string" } ] }, "method": "PATCH", "header": [], "body": { "mode": "raw", "raw": "{\r\n\"status\": \"inactive\"\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base-url}}eds/api/v1/Configs/{{configId}}/status", "host": [ "{{base-url}}eds" ], "path": [ "api", "v1", "Configs", "{{configId}}", "status" ] }, "description": "The Update Configuration Status enables you to update the status of an existing configuration using a `configId`.\n\nFor more information, see [Update Configuration Status](https://cardsapidocs.thredd.com/v2.0/docs/update-configuration-status#/)." }, "response": [ { "name": "Update Configuration Status", "originalRequest": { "method": "PATCH", "header": [], "body": { "mode": "raw", "raw": "{\r\n \"status\": \"active\"\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base-url}}eds/api/v1/Configs/{{configId}}/status", "host": [ "{{base-url}}eds" ], "path": [ "api", "v1", "Configs", "{{configId}}", "status" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "", "type": "text" } ], "cookie": [], "body": "" } ] }, { "name": "Delete Configuration", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{access_token}}", "type": "string" } ] }, "method": "DELETE", "header": [], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base-url}}eds/api/v1/Configs/{{configId}}", "host": [ "{{base-url}}eds" ], "path": [ "api", "v1", "Configs", "{{configId}}" ] }, "description": "The Delete Configuration endpoint enables you to delete a configuration, with the configuration identifier specified in the URL. \n\nFor more information, see [Delete Configuration](https://cardsapidocs.thredd.com/v2.0/docs/delete-configuration#/)." }, "response": [ { "name": "Delete Configuration", "originalRequest": { "method": "DELETE", "header": [], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base-url}}eds/api/v1/Configs/{{configId}}", "host": [ "{{base-url}}eds" ], "path": [ "api", "v1", "Configs", "{{configId}}" ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "", "type": "text" } ], "cookie": [], "body": "" } ] } ] }, { "name": "Card Limits", "item": [ { "name": "Get Card Limits (Card Level)", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{access_token}}", "type": "string" } ] }, "method": "GET", "header": [], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base-url}}cardlimits/api/v1/get_limit", "host": [ "{{base-url}}cardlimits" ], "path": [ "api", "v1", "get_limit" ] }, "description": "The List Configurations endpoint enables you to retrieve all configurations that your institution has access to. \n\nFor more information, see [List Configuration](https://cardsapidocs.thredd.com/v2.0/docs/list-configurations#/)." }, "response": [ { "name": "Get Card Limits (Card Level)", "originalRequest": { "method": "GET", "header": [], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base-url}}cardlimits/api/v1/get_limit", "host": [ "{{base-url}}cardlimits" ], "path": [ "api", "v1", "get_limit" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "", "type": "text" } ], "cookie": [], "body": "{\n \"public_token\": \"223344559\",\n \"limits_with_counter\": [\n {\n \"category\": \"POS\",\n \"limits\": {\n \"maximumpertransaction\": \"0.2\",\n \"minimumpertransaction\": \"0.0\",\n \"dailylimit\": \"0.234\",\n \"dailyfrequency\": 10,\n \"accumlimit1\": \"1000.0\",\n \"accumfrequency1\": 100,\n \"accumperiod1\": 30,\n \"accumlimit2\": \"2000.0\",\n \"accumfrequency2\": 12789,\n \"accumperiod2\": 365\n },\n \"counters\": {\n \"daily_count\": 0,\n \"daily_amount\": 0.0,\n \"accumlimit1_count\": 0,\n \"accumlimit1_amount\": 0.0,\n \"accumlimit2_count\": 0,\n \"accumlimit2_amount\": 0.0\n },\n \"subcategories\": [\n {\n \"subcategory\": \"Contactless\",\n \"limits\": {\n \"maximumpertransaction\": \"0.1\",\n \"minimumpertransaction\": \"0.0\",\n \"dailylimit\": \"0.1\",\n \"dailyfrequency\": 10,\n \"accumlimit1\": \"10.0\",\n \"accumfrequency1\": 10,\n \"accumperiod1\": 10,\n \"accumlimit2\": \"10.0\",\n \"accumfrequency2\": 1000,\n \"accumperiod2\": 100\n },\n \"counters\": {\n \"daily_count\": 0,\n \"daily_amount\": 0.0,\n \"accumlimit1_count\": 0,\n \"accumlimit1_amount\": 0.0,\n \"accumlimit2_count\": 0,\n \"accumlimit2_amount\": 0.0\n }\n }\n ]\n }\n}" } ] }, { "name": "Get Card Limits (Product Level)", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{access_token}}", "type": "string" } ] }, "method": "GET", "header": [], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base-url}}core/api/v1/cards/{{publicToken}}/balance/cardlimits", "host": [ "{{base-url}}core" ], "path": [ "api", "v1", "cards", "{{publicToken}}", "balance", "cardlimits" ] }, "description": "The List Configurations endpoint enables you to retrieve all configurations that your institution has access to. \n\nFor more information, see [List Configuration](https://cardsapidocs.thredd.com/v2.0/docs/list-configurations#/)." }, "response": [ { "name": "Get Card Limits (Product Level)", "originalRequest": { "method": "GET", "header": [], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base-url}}core/api/v1/cards/{{publicToken}}/balance/cardlimits", "host": [ "{{base-url}}core" ], "path": [ "api", "v1", "cards", "{{publicToken}}", "balance", "cardlimits" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "", "type": "text" } ], "cookie": [], "body": "{\n \"public_token\": \"223344559\",\n \"limits_with_counter\": [\n {\n \"category\": \"Cash\",\n \"limits\": {\n \"maximumpertransaction\": \"70.0\",\n \"minimumpertransaction\": \"0.0\",\n \"dailylimit\": \"100.0\",\n \"dailyfrequency\": 10,\n \"accumlimit1\": \"100.0\",\n \"accumfrequency1\": 100,\n \"accumperiod1\": 30,\n \"accumlimit2\": \"1000.0\",\n \"accumfrequency2\": 1000,\n \"accumperiod2\": 36\n },\n \"counters\": {\n \"daily_count\": 0,\n \"daily_amount\": 0.0,\n \"accumlimit1_count\": 0,\n \"accumlimit1_amount\": 0.0,\n \"accumlimit2_count\": 0,\n \"accumlimit2_amount\": 0.0\n },\n \"subcategories\": []\n },\n {\n \"category\": \"Pos\",\n \"limits\": {\n \"maximumpertransaction\": \"0.2\",\n \"minimumpertransaction\": \"0.0\",\n \"dailylimit\": \"0.234\",\n \"dailyfrequency\": 10,\n \"accumlimit1\": \"1000.0\",\n \"accumfrequency1\": 100,\n \"accumperiod1\": 30,\n \"accumlimit2\": \"2000.0\",\n \"accumfrequency2\": 12789,\n \"accumperiod2\": 365\n },\n \"counters\": {\n \"daily_count\": 0,\n \"daily_amount\": 0.0,\n \"accumlimit1_count\": 0,\n \"accumlimit1_amount\": 0.0,\n \"accumlimit2_count\": 0,\n \"accumlimit2_amount\": 0.0\n },\n \"subcategories\": [\n {\n \"subcategory\": \"Contactless\",\n \"limits\": {\n \"maximumpertransaction\": \"0.1\",\n \"minimumpertransaction\": \"0.0\",\n \"dailylimit\": \"0.1\",\n \"dailyfrequency\": 10,\n \"accumlimit1\": \"10.0\",\n \"accumfrequency1\": 10,\n \"accumperiod1\": 10,\n \"accumlimit2\": \"10.0\",\n \"accumfrequency2\": 1000,\n \"accumperiod2\": 100\n },\n \"counters\": {\n \"daily_count\": 0,\n \"daily_amount\": 0.0,\n \"accumlimit1_count\": 0,\n \"accumlimit1_amount\": 0.0,\n \"accumlimit2_count\": 0,\n \"accumlimit2_amount\": 0.0\n }\n }\n ]\n },\n {\n \"category\": \"Pay_in\",\n \"limits\": {\n \"maximumpertransaction\": \"10.0\",\n \"minimumpertransaction\": \"0.0\",\n \"dailylimit\": \"100.0\",\n \"dailyfrequency\": 10,\n \"accumlimit1\": \"1000.0\",\n \"accumfrequency1\": 100,\n \"accumperiod1\": 30,\n \"accumlimit2\": \"1000.0\",\n \"accumfrequency2\": 1000,\n \"accumperiod2\": 367\n },\n \"counters\": {\n \"daily_count\": 0,\n \"daily_amount\": 0.0,\n \"accumlimit1_count\": 0,\n \"accumlimit1_amount\": 0.0,\n \"accumlimit2_count\": 0,\n \"accumlimit2_amount\": 0.0\n },\n \"subcategories\": []\n },\n {\n \"category\": \"Pay_out\",\n \"limits\": {\n \"maximumpertransaction\": \"10.0\",\n \"minimumpertransaction\": \"0.0\",\n \"dailylimit\": \"100.0\",\n \"dailyfrequency\": 10,\n \"accumlimit1\": \"1000.0\",\n \"accumfrequency1\": 100,\n \"accumperiod1\": 30,\n \"accumlimit2\": \"1234567890.0\",\n \"accumfrequency2\": 1000,\n \"accumperiod2\": 367\n },\n \"counters\": {\n \"daily_count\": 0,\n \"daily_amount\": 0.0,\n \"accumlimit1_count\": 0,\n \"accumlimit1_amount\": 0.0,\n \"accumlimit2_count\": 0,\n \"accumlimit2_amount\": 0.0\n },\n \"subcategories\": []\n }\n ]\n}" } ] }, { "name": "Set Card Limits (Card Level)", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{access_token}}", "type": "string" } ] }, "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\r\n \"public_token\": 123456789,\r\n \"category_limits\": [\r\n {\r\n \"category\": \"POS\",\r\n \"subcategories\": [\r\n {\r\n \"subcategory\": \"Contactless\",\r\n \"limits\": {\r\n \"maximumpertransaction\": 100,\r\n \"minimumpertransaction\": 0,\r\n \"dailylimit\": 200,\r\n \"dailyfrequency\": 10,\r\n \"accumlimit1\": 800,\r\n \"accumfrequency1\": 100,\r\n \"accumperiod1\": 30,\r\n \"accumlimit2\": 2000,\r\n \"accumfrequency2\": 300,\r\n \"accumperiod2\": 365\r\n }\r\n }\r\n ]\r\n }\r\n ]\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base-url}}cardlimits/api/v1/set_limit", "host": [ "{{base-url}}cardlimits" ], "path": [ "api", "v1", "set_limit" ] }, "description": "The Create Configuration endpoint enables you to create a configuration for a Transaction Confirmation (TC) event.\n\nFor more information, see [Create Configuration](https://cardsapidocs.thredd.com/v2.0/docs/create-configuration#/)." }, "response": [ { "name": "Set Card Limits (Card Level)", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\r\n \"public_token\": 123456789,\r\n \"category_limits\": [\r\n {\r\n \"category\": \"POS\",\r\n \"subcategories\": [\r\n {\r\n \"subcategory\": \"Contactless\",\r\n \"limits\": {\r\n \"maximumpertransaction\": 100,\r\n \"minimumpertransaction\": 0,\r\n \"dailylimit\": 200,\r\n \"dailyfrequency\": 10,\r\n \"accumlimit1\": 800,\r\n \"accumfrequency1\": 100,\r\n \"accumperiod1\": 30,\r\n \"accumlimit2\": 2000,\r\n \"accumfrequency2\": 300,\r\n \"accumperiod2\": 365\r\n }\r\n }\r\n ]\r\n }\r\n ]\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base-url}}cardlimits/api/v1/set_limit", "host": [ "{{base-url}}cardlimits" ], "path": [ "api", "v1", "set_limit" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "", "type": "text" } ], "cookie": [], "body": "{\n \"response\": \"Success\"\n}" } ] } ] }, { "name": "Fraud", "item": [ { "name": "Fraud Login Event", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{access_token}}", "type": "string" } ] }, "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\r\n \"channel\": \"online\",\r\n \"customerEnrollmentDate\": \"2025-02-26T00:00:00Z\",\r\n \"customerFlag\": [\r\n \"VIP\"\r\n ],\r\n \"customerId\": \"CA13771612318\",\r\n \"customerType\": \"retail\",\r\n \"device\": {\r\n \"anonymizerInUseFlag\": true,\r\n \"areaCode\": \"020\",\r\n \"browserType\": \"Google Chrome\",\r\n \"browserVersion\": \"143.0.7499.147\",\r\n \"city\": \"London\",\r\n \"clientTimezone\": \"GMT+0\",\r\n \"continentCode\": \"EU\",\r\n \"cookieId\": \"9B1B9952EC2B47BD9CD67D117774EF23\",\r\n \"countryCode\": \"44\",\r\n \"countryName\": \"United Kingdom\",\r\n \"deviceIMEI\": \"WERWERWER\",\r\n \"deviceFingerprint\": \"1234\",\r\n \"deviceName\": \"PC\",\r\n \"flashPluginPresent\": \"yes\",\r\n \"httpHeader\": \"1223\",\r\n \"ipAddressV4\": \"192.168.10.10\",\r\n \"ipAddressV6\": \"2001:0db8:0000:0000:0000:ff00:0042:8329\",\r\n \"metroCode\": \"1B\",\r\n \"mimeTypesPresent\": \"yes\",\r\n \"mobileNumberDeviceLink\": \"07966123456193232\",\r\n \"networkCarrier\": \"EE\",\r\n \"oS\": \"iOS\",\r\n \"postalCode\": \"SW1A 1AA\",\r\n \"region\": \"E12000007\",\r\n \"sessionLatitude\": 51.4500912,\r\n \"timestamp\": \"2025-08-22T11:26:23.784\",\r\n \"sessionLongitude\": -0.177627238449149\r\n },\r\n \"deviceId\": \"FG9834YY82\",\r\n \"eventTime\": \"2025-12-10T15:41:26.575Z\",\r\n \"initiatingPartyType\": \"user\",\r\n \"programManagerCode\": \"123456789\",\r\n \"session\": {\r\n \"sessionId\": \"12324\",\r\n \"sessionStartTime\": \"2025-02-27T15:41:26.575Z\"\r\n },\r\n \"traceId\": \"b414f2ed-c1d4-4200-98b0-73396cd0f92e\",\r\n \"thirdPartyDetails\": {\r\n \"authenticationFailedReason\": \"user cancel\"\r\n },\r\n \"verificationResult\": \"SUCC\",\r\n \"verificationType\": {\r\n \"aa\": \"SUCC\",\r\n \"accountDigitalSignature\": \"FAIL\",\r\n \"avs\": \"NOVF\",\r\n \"biometry\": \"SUCC\",\r\n \"cryptogramVerification\": \"NOVF\",\r\n \"cardholderIdentificationData\": \"FAIL\",\r\n \"cscVerification\": \"SUCC\",\r\n \"cvv\": \"FAIL\",\r\n \"offlinePIN\": \"NOVF\",\r\n \"oneTimePassword\": \"SUCC\",\r\n \"onlinePIN\": \"FAIL\",\r\n \"other\": \"NOVF\",\r\n \"paperSignature\": \"SUCC\",\r\n \"passiveAuthentication\": \"FAIL\",\r\n \"password\": \"NOVF\",\r\n \"threeDS\": \"SUCC\",\r\n \"tokenAuthentication\": \"FAIL\"\r\n }\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base-url}}risk/api/v1/fraud/login", "host": [ "{{base-url}}risk" ], "path": [ "api", "v1", "fraud", "login" ] }, "description": "The Create Configuration endpoint enables you to create a configuration for a Transaction Confirmation (TC) event.\n\nFor more information, see [Create Configuration](https://cardsapidocs.thredd.com/v2.0/docs/create-configuration#/)." }, "response": [ { "name": "Fraud Login Event", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\r\n \"channel\": \"online\",\r\n \"customerEnrollmentDate\": \"2025-02-26T00:00:00Z\",\r\n \"customerFlag\": [\r\n \"VIP\"\r\n ],\r\n \"customerId\": \"CA13771612318\",\r\n \"customerType\": \"retail\",\r\n \"device\": {\r\n \"anonymizerInUseFlag\": true,\r\n \"areaCode\": \"020\",\r\n \"browserType\": \"Google Chrome\",\r\n \"browserVersion\": \"143.0.7499.147\",\r\n \"city\": \"London\",\r\n \"clientTimezone\": \"GMT+0\",\r\n \"continentCode\": \"EU\",\r\n \"cookieId\": \"9B1B9952EC2B47BD9CD67D117774EF23\",\r\n \"countryCode\": \"44\",\r\n \"countryName\": \"United Kingdom\",\r\n \"deviceIMEI\": \"WERWERWER\",\r\n \"deviceFingerprint\": \"1234\",\r\n \"deviceName\": \"PC\",\r\n \"flashPluginPresent\": \"yes\",\r\n \"httpHeader\": \"1223\",\r\n \"ipAddressV4\": \"192.168.10.10\",\r\n \"ipAddressV6\": \"2001:0db8:0000:0000:0000:ff00:0042:8329\",\r\n \"metroCode\": \"1B\",\r\n \"mimeTypesPresent\": \"yes\",\r\n \"mobileNumberDeviceLink\": \"07966123456193232\",\r\n \"networkCarrier\": \"EE\",\r\n \"oS\": \"iOS\",\r\n \"postalCode\": \"SW1A 1AA\",\r\n \"region\": \"E12000007\",\r\n \"sessionLatitude\": 51.4500912,\r\n \"timestamp\": \"2025-08-22T11:26:23.784\",\r\n \"sessionLongitude\": -0.177627238449149\r\n },\r\n \"deviceId\": \"FG9834YY82\",\r\n \"eventTime\": \"2025-12-10T15:41:26.575Z\",\r\n \"initiatingPartyType\": \"user\",\r\n \"programManagerCode\": \"123456789\",\r\n \"session\": {\r\n \"sessionId\": \"12324\",\r\n \"sessionStartTime\": \"2025-02-27T15:41:26.575Z\"\r\n },\r\n \"traceId\": \"b414f2ed-c1d4-4200-98b0-73396cd0f92e\",\r\n \"thirdPartyDetails\": {\r\n \"authenticationFailedReason\": \"user cancel\"\r\n },\r\n \"verificationResult\": \"SUCC\",\r\n \"verificationType\": {\r\n \"aa\": \"SUCC\",\r\n \"accountDigitalSignature\": \"FAIL\",\r\n \"avs\": \"NOVF\",\r\n \"biometry\": \"SUCC\",\r\n \"cryptogramVerification\": \"NOVF\",\r\n \"cardholderIdentificationData\": \"FAIL\",\r\n \"cscVerification\": \"SUCC\",\r\n \"cvv\": \"FAIL\",\r\n \"offlinePIN\": \"NOVF\",\r\n \"oneTimePassword\": \"SUCC\",\r\n \"onlinePIN\": \"FAIL\",\r\n \"other\": \"NOVF\",\r\n \"paperSignature\": \"SUCC\",\r\n \"passiveAuthentication\": \"FAIL\",\r\n \"password\": \"NOVF\",\r\n \"threeDS\": \"SUCC\",\r\n \"tokenAuthentication\": \"FAIL\"\r\n }\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base-url}}risk/api/v1/fraud/login", "host": [ "{{base-url}}risk" ], "path": [ "api", "v1", "fraud", "login" ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "", "type": "text" } ], "cookie": [], "body": "" } ] } ] }, { "name": "Open Banking", "item": [ { "name": "Webhook Notifications", "item": [ { "name": "Webhook Notification", "request": { "auth": { "type": "noauth" }, "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\r\n\t\"customerId\": \"9011771620\",\r\n\t\"eventType\": \"added\",\r\n\t\"eventId\": \"1738860463483-2c710e601c11e354c864808c\",\r\n\t\"payload\": {},\r\n\t\"webhookData\": {\r\n\t\t\"threddSessionId\": \"603afe05-1a92-4657-b5c7-03cf36d9dfe6\"\r\n\t}\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base-url}}/api/v1/open-banking/webhook-notification", "host": [ "{{base-url}}" ], "path": [ "api", "v1", "open-banking", "webhook-notification" ] }, "description": "Register a new OpenBanking customer without providing an existing customer ID." }, "response": [] }, { "name": "Webhook Notification AVA", "request": { "auth": { "type": "noauth" }, "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\r\n \"customerId\": \"9011771620\",\r\n \"eventType\": \"microdepositStatus\",\r\n \"eventId\": \"1709221545468-26ec6400711615d32d138f6d\",\r\n \"payload\": {\r\n \"event\": {\r\n \"id\": \"0cf5ed33-e45a-43c1-b4b7-a9574f587e0b\",\r\n \"type\": \"statusChange\",\r\n \"class\": \"microdeposit\"\r\n },\r\n \"accounts\": [\r\n {\r\n \"id\": \"7034681725\",\r\n \"name\": \"Checking\",\r\n \"type\": \"moneyTransferChecking\",\r\n \"status\": \"inactive\",\r\n \"customerId\": \"7018439927\",\r\n \"createdDate\": \"2024-02-29T15:45:43Z\",\r\n \"lastUpdatedDate\": null,\r\n \"microdepositStatus\": \"Rejected\",\r\n \"description\": \"Microdeposits are rejected due to AM04\",\r\n \"microdepositCreatedDate\": \"2024-02-29T15:45:43Z\",\r\n \"microdepositLastUpdatedDate\": null,\r\n \"autoVerifiedAccount\": null\r\n }\r\n ]\r\n }\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base-url}}/api/v1/open-banking/webhook-notification", "host": [ "{{base-url}}" ], "path": [ "api", "v1", "open-banking", "webhook-notification" ] }, "description": "Register a new OpenBanking customer without providing an existing customer ID." }, "response": [] }, { "name": "Webhook Notification Ping", "request": { "auth": { "type": "noauth" }, "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\r\n\t\"eventType\": \"ping\",\r\n\t\"eventId\": \"1738860463483-2c710e601c11e354c864808c\",\r\n\t\"payload\": {},\r\n\t\"webhookData\": {\r\n\t\t\"threddSessionId\": \"603afe05-1a92-4657-b5c7-03cf36d9dfe6\"\r\n\t}\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base-url}}/api/v1/open-banking/webhook-notification", "host": [ "{{base-url}}" ], "path": [ "api", "v1", "open-banking", "webhook-notification" ] }, "description": "Register a new OpenBanking customer without providing an existing customer ID." }, "response": [] } ], "description": "Webhook Notification is a public endpoint exposed and used only by Mastercard.\n\nTo test notification processing there is no need to set Certificates or retrieve AccessTtoken." }, { "name": "Register Open Banking", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{access_token}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "client-id", "value": "123", "type": "text" }, { "key": "partner-id", "value": "2445584740743", "type": "text", "disabled": true } ], "body": { "mode": "raw", "raw": "{\r\n \"external_id\": \"b7a122c3-c9ef-4b09-8205-fa8c43432e2a\",\r\n \"redirect_uri\": \"https://exampley.com\",\r\n \"application_id\": \"2c2635ee-1593-484a-9d38-e62a8d742d24\",\r\n \"is_hosted_in_mobile_app\": false\r\n //\"experience\": \"\"\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base-url}}/api/v1/open-banking/register", "host": [ "{{base-url}}" ], "path": [ "api", "v1", "open-banking", "register" ] }, "description": "Register a new OpenBanking customer without providing an existing customer ID." }, "response": [ { "name": "Register Open Banking", "originalRequest": { "method": "POST", "header": [ { "key": "client-id", "value": "", "type": "text" }, { "key": "partner-id", "value": "", "type": "text" } ], "body": { "mode": "raw", "raw": "{\r\n \"is_hosted_in_mobile_app\": true,\r\n \"redirect_uri\": \"https://myapp.com/callback\",\r\n \"openbanking_customer_id\": \"12345\",\r\n \"customer_id\": \"09876\",\r\n \"experience\": \"fa39b699-a208-4c3d-9579-4f66e600acf8\"\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base-url}}/api/v1/open-banking/register", "host": [ "{{base-url}}" ], "path": [ "api", "v1", "open-banking", "register" ] } }, "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "", "type": "text" } ], "cookie": [], "body": "{\r\n \"openbanking_customer_id\": \"12345\",\r\n \"redirect_url\": \"https://example.com/redirect\"\r\n}" } ] }, { "name": "Get All Customer Accounts", "request": { "method": "GET", "header": [ { "key": "client-id", "value": "123", "type": "text" } ], "url": { "raw": "{{base-url}}/api/v1/open-banking/customers/{{openbanking_customer_id}}/accounts", "host": [ "{{base-url}}" ], "path": [ "api", "v1", "open-banking", "customers", "{{openbanking_customer_id}}", "accounts" ] }, "description": "Get all accounts for a specific OpenBanking customer." }, "response": [ { "name": "Get All Customer Account", "originalRequest": { "method": "GET", "header": [], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base-url}}/api/v1/open-banking/customers/{{openbanking_customer_id}}/accounts", "host": [ "{{base-url}}" ], "path": [ "api", "v1", "open-banking", "customers", "{{openbanking_customer_id}}", "accounts" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "", "type": "text" } ], "cookie": [], "body": "{\n \"request_id\": \"string\",\n \"customer_accounts\": [\n {\n \"id\": \"string\",\n \"number\": \"string\",\n \"accountNumberDisplay\": \"1234-9\",\n \"name\": \"string\",\n \"balance\": 0,\n \"type\": \"checking\",\n \"status\": \"pending\",\n \"customerId\": \"string\",\n \"institutionId\": \"string\",\n \"currency\": \"USD\",\n \"realAccountNumberLast4\": \"string\",\n \"balanceDate\": 0,\n \"aggregationSuccessDate\": 0,\n \"aggregationStatusCode\": 0,\n \"aggregationAttemptDate\": 0,\n \"createdDate\": 0,\n \"lastUpdatedDate\": 0,\n \"linkedAccountDate\": 0,\n \"lastTransactionDate\": 0,\n \"institutionLoginId\": 0,\n \"displayPosition\": 0,\n \"accountNickname\": \"string\",\n \"oldestTransactionDate\": 0,\n \"marketSegment\": \"string\",\n \"detail\": {\n \"available_balance_amount\": 0\n }\n }\n ],\n \"count\": 1\n}" } ] }, { "name": "Get Customer Account Details", "request": { "method": "GET", "header": [ { "key": "client-id", "value": "123", "type": "text" } ], "url": { "raw": "{{base-url}}/api/v1/open-banking/customers/{{openbanking_customer_id}}/accounts/{{account_id}}/details", "host": [ "{{base-url}}" ], "path": [ "api", "v1", "open-banking", "customers", "{{openbanking_customer_id}}", "accounts", "{{account_id}}", "details" ] }, "description": "Get detailed payment instructions for a specific account." }, "response": [ { "name": "Get All Customer Accounts Copy", "originalRequest": { "method": "GET", "header": [], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base-url}}/api/v1/open-banking/customers/{{openbanking_customer_id}}/accounts", "host": [ "{{base-url}}" ], "path": [ "api", "v1", "open-banking", "customers", "{{openbanking_customer_id}}", "accounts" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "", "type": "text" } ], "cookie": [], "body": "{\n \"paymentInstruction\": {\n \"type\": \"ach\",\n \"accountNumber\": \"1000001111\",\n \"tanEnabled\": true,\n \"descriptors\": [\n {\n \"type\": \"routingNumber\",\n \"value\": \"2434345\"\n }\n ],\n \"transferInEnabled\": true,\n \"transferOutEnabled\": true\n }\n}" } ] }, { "name": "Get Account Balance", "request": { "method": "GET", "header": [ { "key": "client-id", "value": "123", "type": "text" } ], "url": { "raw": "{{base-url}}/api/v1/open-banking/customers/{{openbanking_customer_id}}/accounts/{{account_id}}/balance", "host": [ "{{base-url}}" ], "path": [ "api", "v1", "open-banking", "customers", "{{openbanking_customer_id}}", "accounts", "{{account_id}}", "balance" ] }, "description": "Delete a specific account for an OpenBanking customer." }, "response": [ { "name": "Get Account Balance", "originalRequest": { "method": "GET", "header": [], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base-url}}/api/v1/open-banking/customers/{{openbanking_customer_id}}/accounts/{{account_id}}/balance", "host": [ "{{base-url}}" ], "path": [ "api", "v1", "open-banking", "customers", "{{openbanking_customer_id}}", "accounts", "{{account_id}}", "balance" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "", "type": "text" } ], "cookie": [], "body": "{\n \"id\": 1005061234,\n \"realAccountNumberLast4\": \"5678\",\n \"availableBalance\": 173.47,\n \"availableBalanceDate\": 1607450357,\n \"clearedBalance\": 222.25,\n \"clearedBalanceDate\": 1607450357,\n \"aggregationStatusCode\": 0,\n \"currency\": \"USD\"\n}" } ] }, { "name": "Get Institution Branding", "request": { "method": "GET", "header": [ { "key": "client-id", "value": "123", "type": "text" } ], "url": { "raw": "{{base-url}}/api/v1/open-banking/institutions/{{institution_id}}/branding", "host": [ "{{base-url}}" ], "path": [ "api", "v1", "open-banking", "institutions", "{{institution_id}}", "branding" ] }, "description": "Get branding information for a specific financial institution." }, "response": [ { "name": "Get Institution Branding", "originalRequest": { "method": "GET", "header": [], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base-url}}/api/v1/open-banking/institutions/{{institution_id}}/branding", "host": [ "{{base-url}}" ], "path": [ "api", "v1", "open-banking", "institutions", "{{institution_id}}", "branding" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "", "type": "text" } ], "cookie": [], "body": "{\n \"branding\": {\n \"logo\": \"https://example.com/logo.svg\",\n \"alternateLogo\": \"https://example.com/alternateLogo.svg\",\n \"icon\": \"https://example.com/icon.svg\",\n \"primaryColor\": \"#0167AE\",\n \"tile\": \"https://example.com/tile.svg\"\n }\n}" } ] }, { "name": "Create Microdeposit Verification Link", "request": { "method": "POST", "header": [ { "key": "client-id", "value": "123", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"redirect_uri\": \"https://example.com\",\n \"is_hosted_in_mobile_app\": false\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base-url}}/api/v1/open-banking/customers/{{openbanking_customer_id}}/accounts/{{account_id}}/microdeposits/verify", "host": [ "{{base-url}}" ], "path": [ "api", "v1", "open-banking", "customers", "{{openbanking_customer_id}}", "accounts", "{{account_id}}", "microdeposits", "verify" ] }, "description": "Register an existing OpenBanking customer by providing their customer ID." }, "response": [ { "name": "Create Microdeposit Verification Link", "originalRequest": { "method": "POST", "header": [ { "key": "client-id", "value": "123", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"redirect_uri\": \"https://example.com\",\n \"is_hosted_in_mobile_app\": false\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base-url}}/api/v1/open-banking/customers/{{openbanking_customer_id}}/accounts/{{account_id}}/microdeposits/verify", "host": [ "{{base-url}}" ], "path": [ "api", "v1", "open-banking", "customers", "{{openbanking_customer_id}}", "accounts", "{{account_id}}", "microdeposits", "verify" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "", "type": "text" } ], "cookie": [ { "expires": "Invalid Date", "domain": "", "path": "" } ], "body": "{\n \"openbanking_customer_id\": \"string\",\n \"account_id\": \"string\",\n \"verification_url\": \"string\"\n}" } ] } ], "description": "OpenBanking API endpoints for customer registration, account management, and institution branding.", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{access_token}}", "type": "string" } ] } }, { "name": "Click to Pay", "item": [ { "name": "Enroll Cardholder & Payment Data", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{access_token}}", "type": "string" } ] }, "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\r\n \"customers\": [\r\n {\r\n \"customerDetails\": {\r\n \"billingAddress\": {\r\n \"city\": \"San Francisco\",\r\n \"state\": \"CA\",\r\n \"country\": \"USA\",\r\n \"postalCode\": \"94105\",\r\n \"addressLine1\": \"1000 Market Street\",\r\n \"addressLine2\": \"Building 56\",\r\n \"addressLine3\": \"Suite 101\"\r\n },\r\n \"customerReferenceId\": \"ImACustomer\",\r\n \"email\": \"jbloggs@email.com\",\r\n \"phone\": \"+442071234567\",\r\n \"firstName\": \"John\",\r\n \"middleName\": \"Robert\",\r\n \"lastName\": \"Bloggs\",\r\n \"nationalIdentifiers\": [\r\n {\r\n \"type\": \"PASSPORT\",\r\n \"value\": \"A123456\"\r\n }\r\n ]\r\n },\r\n \"pubTokens\": [\r\n {\r\n \"value\": \"123456789\"\r\n }\r\n ]\r\n }\r\n ]\r\n}{\r\n \"customers\": [\r\n {\r\n \"customerDetails\": {\r\n \"billingAddress\": {\r\n \"city\": \"San Francisco\",\r\n \"state\": \"CA\",\r\n \"country\": \"USA\",\r\n \"postalCode\": \"94105\",\r\n \"addressLine1\": \"1000 Market Street\",\r\n \"addressLine2\": \"Building 56\",\r\n \"addressLine3\": \"Suite 101\"\r\n },\r\n \"customerReferenceId\": \"ImACustomer\",\r\n \"email\": \"jbloggs@email.com\",\r\n \"phone\": \"+442071234567\",\r\n \"firstName\": \"John\",\r\n \"middleName\": \"Robert\",\r\n \"lastName\": \"Bloggs\",\r\n \"nationalIdentifiers\": [\r\n {\r\n \"type\": \"PASSPORT\",\r\n \"value\": \"A123456\"\r\n }\r\n ]\r\n },\r\n \"pubTokens\": [\r\n {\r\n \"value\": \"123456789\"\r\n }\r\n ]\r\n }\r\n ]\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base-url}}ctp/api/v1/enrolldata", "host": [ "{{base-url}}ctp" ], "path": [ "api", "v1", "enrolldata" ] }, "description": "The Google In-App Push Provisioning endpoint enables you to share a customer's Google wallet information with Thredd.\n\nYou can share a Google wallet by making a POST request to the Google In-App Push Provisioning endpoint. \n\nFor more information, see [Google In-App Push Provisioning.](https://cardsapidocs.thredd.com/docs/request-google-payload)" }, "response": [ { "name": "Enroll Cardholder & Payment Data", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\r\n \"customers\": [\r\n {\r\n \"customerDetails\": {\r\n \"billingAddress\": {\r\n \"city\": \"San Francisco\",\r\n \"state\": \"CA\",\r\n \"country\": \"USA\",\r\n \"postalCode\": \"94105\",\r\n \"addressLine1\": \"1000 Market Street\",\r\n \"addressLine2\": \"Building 56\",\r\n \"addressLine3\": \"Suite 101\"\r\n },\r\n \"customerReferenceId\": \"ImACustomer\",\r\n \"email\": \"jbloggs@email.com\",\r\n \"phone\": \"+442071234567\",\r\n \"firstName\": \"John\",\r\n \"middleName\": \"Robert\",\r\n \"lastName\": \"Bloggs\",\r\n \"nationalIdentifiers\": [\r\n {\r\n \"type\": \"PASSPORT\",\r\n \"value\": \"A123456\"\r\n }\r\n ]\r\n },\r\n \"pubTokens\": [\r\n {\r\n \"value\": \"123456789\"\r\n }\r\n ]\r\n }\r\n ]\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base-url}}ctp/api/v1/enrolldata", "host": [ "{{base-url}}ctp" ], "path": [ "api", "v1", "enrolldata" ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "", "type": "text" } ], "cookie": [], "body": "{\n \"requestTraceId\": \"351562ba-83cf-11ee-b962-0242ac120002\"\n}" } ] }, { "name": "Enroll Payment Instruments", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{access_token}}", "type": "string" } ] }, "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\r\n \"billingAddress\": {\r\n \"city\": \"San Francisco\",\r\n \"state\": \"CA\",\r\n \"country\": \"USA\",\r\n \"postalCode\": \"94105\",\r\n \"addressLine1\": \"1000 Market Street\",\r\n \"addressLine2\": \"Building 56\",\r\n \"addressLine3\": \"Suite 101\"\r\n },\r\n \"customerReferenceId\": \"ImACustomer\",\r\n \"pubToken\": \"123456789\"\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base-url}}ctp/api/v1/enrollpaymentinstruments", "host": [ "{{base-url}}ctp" ], "path": [ "api", "v1", "enrollpaymentinstruments" ] }, "description": "The Google In-App Push Provisioning endpoint enables you to share a customer's Google wallet information with Thredd.\n\nYou can share a Google wallet by making a POST request to the Google In-App Push Provisioning endpoint. \n\nFor more information, see [Google In-App Push Provisioning.](https://cardsapidocs.thredd.com/docs/request-google-payload)" }, "response": [ { "name": "Enroll Payment Instruments", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\r\n \"billingAddress\": {\r\n \"city\": \"San Francisco\",\r\n \"state\": \"CA\",\r\n \"country\": \"USA\",\r\n \"postalCode\": \"94105\",\r\n \"addressLine1\": \"1000 Market Street\",\r\n \"addressLine2\": \"Building 56\",\r\n \"addressLine3\": \"Suite 101\"\r\n },\r\n \"customerReferenceId\": \"ImACustomer\",\r\n \"pubToken\": \"123456789\"\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base-url}}ctp/api/v1/enrollpaymentinstruments", "host": [ "{{base-url}}ctp" ], "path": [ "api", "v1", "enrollpaymentinstruments" ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "", "type": "text" } ], "cookie": [], "body": "{\n \"requestTraceId\": \"351562ba-83cf-11ee-b962-0242ac120002\"\n}" } ] }, { "name": "Get Mastercard Payment Data", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{access_token}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "client-id", "value": "", "type": "text" }, { "key": "partner-id", "value": "", "type": "text" } ], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base-url}}ctp/api/v1/paymentinstrument/{{customerReferenceId}}/{{publicToken}}", "host": [ "{{base-url}}ctp" ], "path": [ "api", "v1", "paymentinstrument", "{{customerReferenceId}}", "{{publicToken}}" ] }, "description": "The List Configurations endpoint enables you to retrieve all configurations that your institution has access to. \n\nFor more information, see [List Configuration](https://cardsapidocs.thredd.com/v2.0/docs/list-configurations#/)." }, "response": [ { "name": "Get Mastercard Payment Data", "originalRequest": { "method": "GET", "header": [], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base-url}}ctp/api/v1/paymentinstrument/{{customerReferenceId}}/{{publicToken}}", "host": [ "{{base-url}}ctp" ], "path": [ "api", "v1", "paymentinstrument", "{{customerReferenceId}}", "{{publicToken}}" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "", "type": "text" } ], "cookie": [], "body": "{\n \"intent\": {\n \"type\": \"PRODUCT_CODE\",\n \"value\": \"CLICK_TO_PAY\"\n },\n \"paymentInstrument\": {\n \"type\": \"CARD\",\n \"cardType\": \"CREDIT\",\n \"status\": \"ACTIVE\",\n \"issuerName\": \"Bank A\",\n \"nameOnCard\": \"John Doe\",\n \"accountNumber\": \"4111111145551140\",\n \"tokenDetails\": {\n \"tokenReferenceId\": \"DM4MMC1US0000000a8513863213e4f1b99e4d016b4f61624\"\n },\n \"billingAddress\": {\n \"city\": \"San Francisco\",\n \"state\": \"CA\",\n \"country\": \"USA\",\n \"postalCode\": \"94105\",\n \"addressLine1\": \"1000 Market Street\",\n \"addressLine2\": \"Building 56\",\n \"addressLine3\": \"Suite 101\"\n },\n \"expirationDate\": \"2030-01\",\n \"paymentAccountReference\": \"5001DW4DS6FRSHVXVBC7HVP6JYAS6\"\n }\n}" } ] }, { "name": "Get Click to Pay Data", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{access_token}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "client-id", "value": "", "type": "text" }, { "key": "partner-id", "value": "", "type": "text" } ], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base-url}}ctp/api/v1/consumerinformation/{{customerReferenceId}}", "host": [ "{{base-url}}ctp" ], "path": [ "api", "v1", "consumerinformation", "{{customerReferenceId}}" ] }, "description": "The List Configurations endpoint enables you to retrieve all configurations that your institution has access to. \n\nFor more information, see [List Configuration](https://cardsapidocs.thredd.com/v2.0/docs/list-configurations#/)." }, "response": [ { "name": "Get Click to Pay Data", "originalRequest": { "method": "GET", "header": [], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base-url}}ctp/api/v1/consumerinformation/{{customerReferenceId}}", "host": [ "{{base-url}}ctp" ], "path": [ "api", "v1", "consumerinformation", "{{customerReferenceId}}" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "", "type": "text" } ], "cookie": [], "body": "{\n \"intent\": {\n \"type\": \"PRODUCT_CODE\",\n \"value\": \"CLICK_TO_PAY\"\n },\n \"paymentInstrument\": {\n \"type\": \"CARD\",\n \"cardType\": \"CREDIT\",\n \"status\": \"ACTIVE\",\n \"issuerName\": \"Bank A\",\n \"nameOnCard\": \"John Doe\",\n \"accountNumber\": \"4111111145551140\",\n \"tokenDetails\": {\n \"tokenReferenceId\": \"DM4MMC1US0000000a8513863213e4f1b99e4d016b4f61624\"\n },\n \"billingAddress\": {\n \"city\": \"San Francisco\",\n \"state\": \"CA\",\n \"country\": \"USA\",\n \"postalCode\": \"94105\",\n \"addressLine1\": \"1000 Market Street\",\n \"addressLine2\": \"Building 56\",\n \"addressLine3\": \"Suite 101\"\n },\n \"expirationDate\": \"2030-01\",\n \"paymentAccountReference\": \"5001DW4DS6FRSHVXVBC7HVP6JYAS6\"\n }\n}" } ] }, { "name": "Manage Payment Data", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{access_token}}", "type": "string" } ] }, "method": "PUT", "header": [], "body": { "mode": "raw", "raw": "{\r\n \"customerReferenceId\": \"1234\",\r\n \"pubToken\": \"275797862\", \r\n \"billingAddress\": {\r\n \"city\": \"San Francisco\",\r\n \"state\": \"CA\",\r\n \"country\": \"USA\",\r\n \"postalCode\": 94105,\r\n \"addressLine1\": \"1000 Market Street\",\r\n \"addressLine2\": \"Building 56\",\r\n \"addressLine3\": \"Suite 102\"\r\n }\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base-url}}ctp/api/v1/paymentinstrument", "host": [ "{{base-url}}ctp" ], "path": [ "api", "v1", "paymentinstrument" ] }, "description": "The Update Configuration endpoint enables you to update an existing configuration based on the provided `configId` and request payload. \n\nFor more information, see [Update Configuration](https://cardsapidocs.thredd.com/v2.0/docs/update-configuration#/)." }, "response": [ { "name": "Manage Payment Data - Visa", "originalRequest": { "method": "PUT", "header": [], "body": { "mode": "raw", "raw": "{\r\n \"customerReferenceId\": \"1234\",\r\n \"pubToken\": \"275797862\", \r\n \"billingAddress\": {\r\n \"city\": \"San Francisco\",\r\n \"state\": \"CA\",\r\n \"country\": \"USA\",\r\n \"postalCode\": 94105,\r\n \"addressLine1\": \"1000 Market Street\",\r\n \"addressLine2\": \"Building 56\",\r\n \"addressLine3\": \"Suite 102\"\r\n }\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base-url}}ctp/api/v1/paymentinstrument", "host": [ "{{base-url}}ctp" ], "path": [ "api", "v1", "paymentinstrument" ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "", "type": "text" } ], "cookie": [], "body": "{\r\n \"requestTraceId\": \"351562ba-83cf-11ee-b962-0242ac120002\"\r\n}" }, { "name": "Manage Payment Data - Mastercard", "originalRequest": { "method": "PUT", "header": [], "body": { "mode": "raw", "raw": "{\r\n \"customerReferenceId\": \"1234\",\r\n \"pubToken\": \"275797862\", \r\n \"billingAddress\": {\r\n \"city\": \"San Francisco\",\r\n \"state\": \"CA\",\r\n \"country\": \"USA\",\r\n \"postalCode\": 94105,\r\n \"addressLine1\": \"1000 Market Street\",\r\n \"addressLine2\": \"Building 56\",\r\n \"addressLine3\": \"Suite 102\"\r\n }\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base-url}}ctp/api/v1/paymentinstrument", "host": [ "{{base-url}}ctp" ], "path": [ "api", "v1", "paymentinstrument" ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "", "type": "text" } ], "cookie": [], "body": "{\r\n \"srcCorrelationId\": \"b17b686c-4759-4ade-a3b1-6b29c61b6774\"\r\n}" } ] }, { "name": "Delete Consumer Information", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{access_token}}", "type": "string" } ] }, "method": "DELETE", "header": [], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base-url}}ctp/api/v1/consumerinformation/{{customerReferenceId}}", "host": [ "{{base-url}}ctp" ], "path": [ "api", "v1", "consumerinformation", "{{customerReferenceId}}" ] }, "description": "The Delete Configuration endpoint enables you to delete a configuration, with the configuration identifier specified in the URL. \n\nFor more information, see [Delete Configuration](https://cardsapidocs.thredd.com/v2.0/docs/delete-configuration#/)." }, "response": [ { "name": "Delete Consumer Information - Visa", "originalRequest": { "method": "DELETE", "header": [], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base-url}}ctp/api/v1/consumerinformation/{{customerReferenceId}}", "host": [ "{{base-url}}ctp" ], "path": [ "api", "v1", "consumerinformation", "{{customerReferenceId}}" ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "", "type": "text" } ], "cookie": [], "body": "{\n \"requestTraceId\": \"351562ba-83cf-11ee-b962-0242ac120002\"\n}" }, { "name": "Delete Consumer Information - Mastercard", "originalRequest": { "method": "DELETE", "header": [], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base-url}}ctp/api/v1/consumerinformation/{{customerReferenceId}}", "host": [ "{{base-url}}ctp" ], "path": [ "api", "v1", "consumerinformation", "{{customerReferenceId}}" ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "", "type": "text" } ], "cookie": [], "body": "{\n \"srcCorrelationId\": \"b17b686c-4759-4ade-a3b1-6b29c61b6774\"\n}" } ] }, { "name": "Manage Consumer Information", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{access_token}}", "type": "string" } ] }, "method": "PUT", "header": [], "body": { "mode": "raw", "raw": "{\r\n \"customerDetails\": {\r\n \"nationalIdentifiers\": [\r\n {\r\n \"type\": \"PASSPORT\",\r\n \"value\": \"A123456\"\r\n }\r\n ],\r\n \"customerReferenceId\": \"63421837-d597-4f0f-89e4-930c1a7b9e85\",\r\n \"email\": \"alex123@hotmail.com\",\r\n \"phone\": \"16504005555\",\r\n \"firstName\": \"Alex\",\r\n \"middleName\": \"Robert\",\r\n \"lastName\": \"Miller\",\r\n \"countryCode\": \"USA\",\r\n \"languageCode\": \"en\"\r\n },\r\n \"cardNetwork\": \"Visa\"\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base-url}}ctp/api/v1/consumerinformation", "host": [ "{{base-url}}ctp" ], "path": [ "api", "v1", "consumerinformation" ] }, "description": "The Update Configuration endpoint enables you to update an existing configuration based on the provided `configId` and request payload. \n\nFor more information, see [Update Configuration](https://cardsapidocs.thredd.com/v2.0/docs/update-configuration#/)." }, "response": [ { "name": "Manage Consumer Information - Visa", "originalRequest": { "method": "PUT", "header": [], "body": { "mode": "raw", "raw": "{\r\n \"customerDetails\": {\r\n \"nationalIdentifiers\": [\r\n {\r\n \"type\": \"PASSPORT\",\r\n \"value\": \"A123456\"\r\n }\r\n ],\r\n \"customerReferenceId\": \"63421837-d597-4f0f-89e4-930c1a7b9e85\",\r\n \"email\": \"alex123@hotmail.com\",\r\n \"phone\": \"16504005555\",\r\n \"firstName\": \"Alex\",\r\n \"middleName\": \"Robert\",\r\n \"lastName\": \"Miller\",\r\n \"countryCode\": \"USA\",\r\n \"languageCode\": \"en\"\r\n },\r\n \"cardNetwork\": \"Visa\"\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base-url}}ctp/api/v1/consumerinformation", "host": [ "{{base-url}}ctp" ], "path": [ "api", "v1", "consumerinformation" ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "", "type": "text" } ], "cookie": [], "body": "{\r\n \"requestTraceId\": \"351562ba-83cf-11ee-b962-0242ac120002\"\r\n}" }, { "name": "Manage Consumer Information - Mastercard", "originalRequest": { "method": "PUT", "header": [], "body": { "mode": "raw", "raw": "{\r\n \"customerDetails\": {\r\n \"nationalIdentifiers\": [\r\n {\r\n \"type\": \"PASSPORT\",\r\n \"value\": \"A123456\"\r\n }\r\n ],\r\n \"customerReferenceId\": \"63421837-d597-4f0f-89e4-930c1a7b9e85\",\r\n \"email\": \"alex123@hotmail.com\",\r\n \"phone\": \"16504005555\",\r\n \"firstName\": \"Alex\",\r\n \"middleName\": \"Robert\",\r\n \"lastName\": \"Miller\",\r\n \"countryCode\": \"USA\",\r\n \"languageCode\": \"en\"\r\n },\r\n \"cardNetwork\": \"Visa\"\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base-url}}ctp/api/v1/consumerinformation", "host": [ "{{base-url}}ctp" ], "path": [ "api", "v1", "consumerinformation" ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "", "type": "text" } ], "cookie": [], "body": "{\r\n \"srcCorrelationId\": \"b17b686c-4759-4ade-a3b1-6b29c61b6774\"\r\n}" } ] }, { "name": "Delete Payment Data", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{access_token}}", "type": "string" } ] }, "method": "DELETE", "header": [], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base-url}}ctp/api/v1/paymentinstrument/{{customerReferenceId}}/{{publicToken}}", "host": [ "{{base-url}}ctp" ], "path": [ "api", "v1", "paymentinstrument", "{{customerReferenceId}}", "{{publicToken}}" ] }, "description": "The Delete Configuration endpoint enables you to delete a configuration, with the configuration identifier specified in the URL. \n\nFor more information, see [Delete Configuration](https://cardsapidocs.thredd.com/v2.0/docs/delete-configuration#/)." }, "response": [ { "name": "Delete Payment Data - Visa", "originalRequest": { "method": "DELETE", "header": [], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base-url}}ctp/api/v1/paymentinstrument/{{customerReferenceId}}/{{publicToken}}", "host": [ "{{base-url}}ctp" ], "path": [ "api", "v1", "paymentinstrument", "{{customerReferenceId}}", "{{publicToken}}" ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "", "type": "text" } ], "cookie": [], "body": "{\n \"requestTraceId\": \"351562ba-83cf-11ee-b962-0242ac120002\"\n}" }, { "name": "Delete Payment Instrument - Mastercard", "originalRequest": { "method": "DELETE", "header": [], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base-url}}ctp/api/v1/paymentinstrument/{{customerReferenceId}}/{{publicToken}}", "host": [ "{{base-url}}ctp" ], "path": [ "api", "v1", "paymentinstrument", "{{customerReferenceId}}", "{{publicToken}}" ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "", "type": "text" } ], "cookie": [], "body": "{\n \"srcCorrelationId\": \"b17b686c-4759-4ade-a3b1-6b29c61b6774\"\n}" } ] } ] }, { "name": "Webhooks", "item": [ { "name": "Create Webhook", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{access_token}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "client-id", "value": "", "type": "text" }, { "key": "partner-id", "value": "", "type": "text" } ], "body": { "mode": "raw", "raw": "{ \r\n \"productId\": 12345,\r\n \"events\": [101],\r\n \"webhookStatus\": \"active\", \r\n \"config\": {\r\n \"url\": \"https://client_domain.com/webhook\",\r\n \"customHeaders\": {\r\n \"header1\": \"value_1\",\r\n \"header2\": \"value_2\"\r\n }\r\n }\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base-url}}/eds/api/v1/Webhooks", "host": [ "{{base-url}}" ], "path": [ "eds", "api", "v1", "Webhooks" ] }, "description": "The Create Configuration endpoint enables you to create a configuration for a Transaction Confirmation (TC) event.\n\nFor more information, see [Create Configuration](https://cardsapidocs.thredd.com/v2.0/docs/create-configuration#/)." }, "response": [ { "name": "Create Webhook", "originalRequest": { "method": "POST", "header": [ { "key": "client-id", "value": "", "type": "text" }, { "key": "partner-id", "value": "", "type": "text" } ], "body": { "mode": "raw", "raw": "{ \r\n \"productId\": 12345,\r\n \"events\": [101],\r\n \"webhookStatus\": \"active\", \r\n \"config\": {\r\n \"url\": \"https://client_domain.com/webhook\",\r\n \"customHeaders\": {\r\n \"header1\": \"value_1\",\r\n \"header2\": \"value_2\"\r\n }\r\n }\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base-url}}/eds/api/v1/Webhooks", "host": [ "{{base-url}}" ], "path": [ "eds", "api", "v1", "Webhooks" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "", "type": "text" } ], "cookie": [], "body": "{\r\n\"status\": \"success\",\r\n\"response\" : {\r\n \"webhookid\" : \"W000001ABC\",\r\n \"productId\": 12345,\r\n \"events\": [101],\r\n \"webhookStatus\": \"active\",\r\n \"config\": {\r\n \"url\": \"https://client_domain.com/webhook\", \r\n \"customHeaders\": {\r\n \"header1\": \"value_1\",\r\n \"header2\": \"value_2\"\r\n }\r\n }, \r\n \"createdTime\": \"2024-01-24T23:20:28Z\"\r\n}" } ] }, { "name": "List Webhooks", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{access_token}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "client-id", "value": "", "type": "text" }, { "key": "partner-id", "value": "", "type": "text" } ], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base-url}}/eds/api/v1/Webhooks", "host": [ "{{base-url}}" ], "path": [ "eds", "api", "v1", "Webhooks" ] }, "description": "The List Configurations endpoint enables you to retrieve all configurations that your institution has access to. \n\nFor more information, see [List Configuration](https://cardsapidocs.thredd.com/v2.0/docs/list-configurations#/)." }, "response": [ { "name": "List Webhooks", "originalRequest": { "method": "GET", "header": [], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base-url}}/eds/api/v1/Webhooks", "host": [ "{{base-url}}" ], "path": [ "eds", "api", "v1", "Webhooks" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "", "type": "text" } ], "cookie": [], "body": "{\n\"status\": \"success\",\n\"response\" : { \n \"content\": [\n {\n \"webhookId\" : \"uniqueWebhookId\",\n \"webhookStatus\": active,\n \"productId\": 12345,\n \"events\":[101,102],\n \"config\": {\n \"url\": \"https://client_domain.com/webhook\", \n \"customHeader\": {\n \"header1\": \"value_1\",\n \"header2\": \"value_2\"\n }\n },\n \"createdTime\": \"2024-01-24T23:20:28Z\",\n \"lastModifiedTime\": \"2024-01-24T23:20:28Z\"\n }\n ]\n}" } ] }, { "name": "Ping Webhook", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{access_token}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "client-id", "value": "", "type": "text" }, { "key": "partner-id", "value": "", "type": "text" } ], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base-url}}/eds/api/v1/Webhooks/{{webhook_id}}/heartbeat", "host": [ "{{base-url}}" ], "path": [ "eds", "api", "v1", "Webhooks", "{{webhook_id}}", "heartbeat" ] }, "description": "The List Configurations endpoint enables you to retrieve all configurations that your institution has access to. \n\nFor more information, see [List Configuration](https://cardsapidocs.thredd.com/v2.0/docs/list-configurations#/)." }, "response": [ { "name": "Ping Webhook", "originalRequest": { "method": "GET", "header": [], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base-url}}/eds/api/v1/Webhooks/{{webhook_id}}/heartbeat", "host": [ "{{base-url}}" ], "path": [ "eds", "api", "v1", "Webhooks", "{{webhook_id}}", "heartbeat" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "", "type": "text" } ], "cookie": [], "body": "{\n \"status\": \"success\",\n \"response\": {\n \"webhookId\": 1234567890,\n \"healthStatus\": \"healthy\"\n }\n}" } ] }, { "name": "Get Webhook Details", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{access_token}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "client-id", "value": "", "type": "text" }, { "key": "partner-id", "value": "", "type": "text" } ], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base-url}}/eds/api/v1/Webhooks/{{webhookId}}", "host": [ "{{base-url}}" ], "path": [ "eds", "api", "v1", "Webhooks", "{{webhookId}}" ] }, "description": "The List Configurations endpoint enables you to retrieve all configurations that your institution has access to. \n\nFor more information, see [List Configuration](https://cardsapidocs.thredd.com/v2.0/docs/list-configurations#/)." }, "response": [ { "name": "Get Webhook Details", "originalRequest": { "method": "GET", "header": [], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base-url}}/eds/api/v1/Webhooks/{{webhookId}}", "host": [ "{{base-url}}" ], "path": [ "eds", "api", "v1", "Webhooks", "{{webhookId}}" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "", "type": "text" } ], "cookie": [], "body": "{\n \"status\": \"success\",\n \"response\": {\n \"webhookId\": \"af2d48de-2ad7-42f8-a252-8422cd9e6078\",\n \"productId\": 123,\n \"events\": [\n 101,\n 102\n ],\n \"webhookStatus\": \"active\",\n \"config\": {\n \"url\": \"https://client_domain.com/webhook\",\n \"customHeaders\": \"{\\\"key1\\\": \\\"value1\\\", \\\"key2\\\": \\\"value2\\\", \\\"key3\\\": \\\"value3\\\"}\"\n },\n \"createdTime\": \"2024-01-24T23:20:28Z\",\n \"lastModifiedTime\": \"2024-02-24T23:20:28Z\"\n }\n}" } ] }, { "name": "Update Webhook Details", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{access_token}}", "type": "string" } ] }, "method": "PUT", "header": [], "body": { "mode": "raw", "raw": "{\r\n \"productId\": \"123\",\r\n \"events\": \"[101, 102]\",\r\n \"config\": {\r\n \"url\": \"https://client_domain.com/webhook\",\r\n \"customHeaders\": \"{\\\"key1\\\": \\\"value1\\\", \\\"key2\\\": \\\"value2\\\", \\\"key3\\\": \\\"value3\\\"}\"\r\n }\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base-url}}/eds/api/v1/Webhooks/{{webhookId}}", "host": [ "{{base-url}}" ], "path": [ "eds", "api", "v1", "Webhooks", "{{webhookId}}" ] }, "description": "The Update Configuration endpoint enables you to update an existing configuration based on the provided `configId` and request payload. \n\nFor more information, see [Update Configuration](https://cardsapidocs.thredd.com/v2.0/docs/update-configuration#/)." }, "response": [ { "name": "Update Webhook Details", "originalRequest": { "method": "PUT", "header": [], "body": { "mode": "raw", "raw": "{\r\n \"productId\": \"123\",\r\n \"events\": \"[101, 102]\",\r\n \"config\": {\r\n \"url\": \"https://client_domain.com/webhook\",\r\n \"customHeaders\": \"{\\\"key1\\\": \\\"value1\\\", \\\"key2\\\": \\\"value2\\\", \\\"key3\\\": \\\"value3\\\"}\"\r\n }\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base-url}}/eds/api/v1/Webhooks/{{webhookId}}", "host": [ "{{base-url}}" ], "path": [ "eds", "api", "v1", "Webhooks", "{{webhookId}}" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "", "type": "text" } ], "cookie": [], "body": "{\r\n \"status\": \"success\",\r\n \"response\": {\r\n \"webhookId\": \"af2d48de-2ad7-42f8-a252-8422cd9e6078\",\r\n \"productId\": 123,\r\n \"events\": [\r\n 101,\r\n 102\r\n ],\r\n \"webhookStatus\": \"active\",\r\n \"config\": {\r\n \"url\": \"https://client_domain.com/webhook\",\r\n \"customHeaders\": \"{\\\"key1\\\": \\\"value1\\\", \\\"key2\\\": \\\"value2\\\", \\\"key3\\\": \\\"value3\\\"}\"\r\n },\r\n \"createdTime\": \"2024-01-24T23:20:28Z\",\r\n \"lastModifiedTime\": \"2024-02-24T23:20:28Z\"\r\n }\r\n}" } ] }, { "name": "Update Webhook Status", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{access_token}}", "type": "string" } ] }, "method": "PUT", "header": [], "body": { "mode": "raw", "raw": "{\r\n \"webhookStatus\" : \"inactive\"\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base-url}}/eds/api/v1/Webhooks/{{webhookId}}/status", "host": [ "{{base-url}}" ], "path": [ "eds", "api", "v1", "Webhooks", "{{webhookId}}", "status" ] }, "description": "The Update Configuration endpoint enables you to update an existing configuration based on the provided `configId` and request payload. \n\nFor more information, see [Update Configuration](https://cardsapidocs.thredd.com/v2.0/docs/update-configuration#/)." }, "response": [ { "name": "Update Webhook Status", "originalRequest": { "method": "PUT", "header": [], "body": { "mode": "raw", "raw": "{\r\n \"webhookStatus\" : \"inactive\"\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base-url}}/eds/api/v1/Webhooks/{{webhookId}}", "host": [ "{{base-url}}" ], "path": [ "eds", "api", "v1", "Webhooks", "{{webhookId}}" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "", "type": "text" } ], "cookie": [], "body": "{\r\n\"status\": \"success\",\r\n\"response\" : {\r\n \"webhookId\" : \"12345\",\r\n \"webhookStatus\" : \"Webhook is inactive.\"\r\n}" } ] }, { "name": "Add Event Subscriptions", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{access_token}}", "type": "string" } ] }, "method": "PUT", "header": [], "body": { "mode": "raw", "raw": " {\r\n \"events\" : [101,102]\r\n }", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base-url}}/eds/api/v1/Webhooks/{{webhook_id}}/subscriptions", "host": [ "{{base-url}}" ], "path": [ "eds", "api", "v1", "Webhooks", "{{webhook_id}}", "subscriptions" ] }, "description": "The Update Configuration endpoint enables you to update an existing configuration based on the provided `configId` and request payload. \n\nFor more information, see [Update Configuration](https://cardsapidocs.thredd.com/v2.0/docs/update-configuration#/)." }, "response": [ { "name": "Add Event Subscriptions", "originalRequest": { "method": "PUT", "header": [], "body": { "mode": "raw", "raw": " {\r\n \"events\" : [101,102]\r\n }", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base-url}}/eds/api/v1/Webhooks/{{webhook_id}}/subscriptions", "host": [ "{{base-url}}" ], "path": [ "eds", "api", "v1", "Webhooks", "{{webhook_id}}", "subscriptions" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "", "type": "text" } ], "cookie": [], "body": "{\r\n\"status\": \"success\",\r\n\"response\" : {\r\n \"webhookId\" : \"uniqueWebhookId\",\r\n \"responseStatus\" : \"Webhook events updated\"\r\n}" } ] }, { "name": "Get Event Subscriptions", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{access_token}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "client-id", "value": "", "type": "text" }, { "key": "partner-id", "value": "", "type": "text" } ], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base-url}}/eds/api/v1/Webhooks/{{webhook_id}}/subscriptions", "host": [ "{{base-url}}" ], "path": [ "eds", "api", "v1", "Webhooks", "{{webhook_id}}", "subscriptions" ] }, "description": "The List Configurations endpoint enables you to retrieve all configurations that your institution has access to. \n\nFor more information, see [List Configuration](https://cardsapidocs.thredd.com/v2.0/docs/list-configurations#/)." }, "response": [ { "name": "Get Event Subscriptions", "originalRequest": { "method": "GET", "header": [], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base-url}}/eds/api/v1/Webhooks/{{webhook_id}}/subscriptions", "host": [ "{{base-url}}" ], "path": [ "eds", "api", "v1", "Webhooks", "{{webhook_id}}", "subscriptions" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "", "type": "text" } ], "cookie": [], "body": "{\n\"status\": \"success\",\n\"response\" : {\n \"webhookId\":\"12345666\",\n content: [\n {\n \"eventCode\" : 101,\n \"description\" :\"Fraud Alert\"\n }\n }" } ] }, { "name": "Get Notifications for Event Code", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{access_token}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "client-id", "value": "", "type": "text" }, { "key": "partner-id", "value": "", "type": "text" } ], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base-url}}/eds/api/v1/Webhooks/{{webhook_id}}/events/{{event_code}}/notifications?from={{date}}", "host": [ "{{base-url}}" ], "path": [ "eds", "api", "v1", "Webhooks", "{{webhook_id}}", "events", "{{event_code}}", "notifications" ], "query": [ { "key": "from", "value": "{{date}}" } ] }, "description": "The List Configurations endpoint enables you to retrieve all configurations that your institution has access to. \n\nFor more information, see [List Configuration](https://cardsapidocs.thredd.com/v2.0/docs/list-configurations#/)." }, "response": [ { "name": "Get Notifications for Event Code", "originalRequest": { "method": "GET", "header": [], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base-url}}/eds/api/v1/Webhooks/{{webhook_id}}/events/{{event_code}}/notifications?from={{date}}", "host": [ "{{base-url}}" ], "path": [ "eds", "api", "v1", "Webhooks", "{{webhook_id}}", "events", "{{event_code}}", "notifications" ], "query": [ { "key": "from", "value": "{{date}}" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "", "type": "text" } ], "cookie": [], "body": "{\n \"status\": \"success\",\n \"response\": {\n \"webhookId\": \"af2d48de-2ad7-42f8-a252-8422cd9e6078\",\n \"content\": [\n {\n \"notificationStatus\": \"Delivered\",\n \"notificationBody\": {\n \"context\": {\n \"notificationId\": \"f47ac10b-58cc-4372-a567-0e02b2c3d479\",\n \"eventCode\": 101,\n \"eventVersion\": \"v1\",\n \"notificationTime\": \"2025-05-24T23:20:28.000Z\"\n },\n \"payload\": {\n \"fraudAlertId\": \"05e991e3-9058-4d79-bf01-76d4e8fe2059\",\n \"productId\": 123,\n \"transactionId\": 98765432101212,\n \"tokenId\": 545454121,\n \"transactionAmount\": \"50.75\",\n \"currency\": \"USD\",\n \"merchantName\": \"Sample Merchant\",\n \"location\": \"United Kingdom\",\n \"dateTime\": \"2025-05-24T14:30:00Z\",\n \"mcc\": \"4567\",\n \"notificationMessageContent\": \"Did you attempt $50.75 on card ending 1234 at Example Merchant? We suspect fraud and blocked the card, Acknowledge if you made this purchase.\"\n }\n },\n \"createdTime\": \"2024-01-24T23:20:28.000Z\",\n \"lastSentTime\": \"2024-01-24T23:20:28.000Z\"\n }\n ]\n }\n}" } ] }, { "name": "Get Notification Details", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{access_token}}", "type": "string" } ] }, "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\r\n \"notificationIds\" : [\"1212-8543434-232\",\"34343-7989-46232\"]\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base-url}}/eds/api/v1/Webhooks/{{webhook_id}}/notifications", "host": [ "{{base-url}}" ], "path": [ "eds", "api", "v1", "Webhooks", "{{webhook_id}}", "notifications" ] }, "description": "The Update Configuration endpoint enables you to update an existing configuration based on the provided `configId` and request payload. \n\nFor more information, see [Update Configuration](https://cardsapidocs.thredd.com/v2.0/docs/update-configuration#/)." }, "response": [ { "name": "Get Notification Details", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\r\n \"notificationIds\" : [\"1212-8543434-232\",\"34343-7989-46232\"]\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base-url}}/eds/api/v1/Webhooks/{{webhook_id}}/notifications", "host": [ "{{base-url}}" ], "path": [ "eds", "api", "v1", "Webhooks", "{{webhook_id}}", "notifications" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "" } ], "cookie": [], "body": "{\r\n \"status\": \"success\",\r\n \"response\": {\r\n \"webhookId\": \"af2d48de-2ad7-42f8-a252-8422cd9e6078\",\r\n \"content\": [\r\n {\r\n \"notificationStatus\": \"Delivered\",\r\n \"notificationBody\": {\r\n \"context\": {\r\n \"notificationId\": \"f47ac10b-58cc-4372-a567-0e02b2c3d479\",\r\n \"eventCode\": 101,\r\n \"eventVersion\": \"v1\",\r\n \"notificationTime\": \"2024-01-24T23:20:28.000Z\"\r\n },\r\n \"payload\": {\r\n \"fraudAlertId\": \"05e991e3-9058-4d79-bf01-76d4e8fe2059\",\r\n \"productId\": 123,\r\n \"transactionId\": 98765432101212,\r\n \"tokenId\": 545454121,\r\n \"transactionAmount\": \"50.75\",\r\n \"currency\": \"USD\",\r\n \"merchantName\": \"Sample Merchant\",\r\n \"location\": \"United Kingdom\",\r\n \"dateTime\": \"2024-01-24T14:30:00Z\",\r\n \"mcc\": \"4567\",\r\n \"notificationMessageContent\": \"Did you attempt $50.75 on card ending 1234 at Example Merchant? We suspect fraud and blocked the card, Acknowledge if you made this purchase.\"\r\n }\r\n },\r\n \"createdTime\": \"2024-01-24T23:20:28.000Z\",\r\n \"lastSentTime\": \"2024-01-24T23:20:28.000Z\"\r\n }\r\n ]\r\n }\r\n}" } ] }, { "name": "Get Undelivered Notification Details", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{access_token}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "client-id", "value": "", "type": "text" }, { "key": "partner-id", "value": "", "type": "text" } ], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base-url}}/eds/api/v1/Webhooks/{{webhookId}}/notifications/undelivered?from={{date}}", "host": [ "{{base-url}}" ], "path": [ "eds", "api", "v1", "Webhooks", "{{webhookId}}", "notifications", "undelivered" ], "query": [ { "key": "from", "value": "{{date}}" } ] }, "description": "The List Configurations endpoint enables you to retrieve all configurations that your institution has access to. \n\nFor more information, see [List Configuration](https://cardsapidocs.thredd.com/v2.0/docs/list-configurations#/)." }, "response": [ { "name": "Get Notifications for Event Code", "originalRequest": { "method": "GET", "header": [], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base-url}}/eds/api/v1/Webhooks/{{webhookId}}/notifications/undelivered?from={{date}}", "host": [ "{{base-url}}" ], "path": [ "eds", "api", "v1", "Webhooks", "{{webhookId}}", "notifications", "undelivered" ], "query": [ { "key": "from", "value": "{{date}}" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "", "type": "text" } ], "cookie": [], "body": "{\n \"status\": \"success\",\n \"response\": {\n \"webhookid\": \"af2d48de-2ad7-42f8-a252-8422cd9e6078\",\n \"content\": [\n {\n \"eventCode\": 101,\n \"count\": 3,\n \"notificationId\": [\n \"3434-8543-232\",\n \"5656-7989-546\",\n \"9866-5654-532\"\n ]\n }\n ],\n \"totalCount\": 3\n }\n}" } ] }, { "name": "Resend Thredd Notifications", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{access_token}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "client-id", "value": "", "type": "text" }, { "key": "partner-id", "value": "", "type": "text" } ], "body": { "mode": "raw", "raw": "{\r\n \"notificationIds\": [\r\n \"1313-8543434-999\",\r\n \"1212-8543434-232\"\r\n ]\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base-url}}/eds/api/v1/Webhooks/{{webhook_id}}/resend", "host": [ "{{base-url}}" ], "path": [ "eds", "api", "v1", "Webhooks", "{{webhook_id}}", "resend" ] }, "description": "The Create Configuration endpoint enables you to create a configuration for a Transaction Confirmation (TC) event.\n\nFor more information, see [Create Configuration](https://cardsapidocs.thredd.com/v2.0/docs/create-configuration#/)." }, "response": [ { "name": "Resend Thredd Notifications", "originalRequest": { "method": "POST", "header": [ { "key": "client-id", "value": "", "type": "text" }, { "key": "partner-id", "value": "", "type": "text" } ], "body": { "mode": "raw", "raw": "{\r\n \"notificationIds\": [\r\n \"1313-8543434-999\",\r\n \"1212-8543434-232\"\r\n ]\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base-url}}/eds/api/v1/Webhooks/{{webhook_id}}/resend", "host": [ "{{base-url}}" ], "path": [ "eds", "api", "v1", "Webhooks", "{{webhook_id}}", "resend" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "", "type": "text" } ], "cookie": [], "body": "{\r\n\"status\": \"success\",\r\n\"response\" : {\r\n \"webhookId\":\"12345\",\r\n \"content\": [\r\n {\r\n \"notificationId\" : \"1212-8543434-232\",\r\n \"resendStatus\": \"Resend request initiated\", \r\n },\r\n {\r\n \"notificationId\" : \"34343-7989-46\",\r\n \"resendStatus\": \"Unable to resend request\", \r\n },\r\n {\r\n \"notificationId\" : \"5456-56542-532\",\r\n \"resendStatus\": \"Invalid notification details\", \r\n },\r\n ]\r\n}" } ] } ] }, { "name": "Alias Directory Service", "item": [ { "name": "Get Alias", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{access_token}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "client-id", "value": "", "type": "text" }, { "key": "partner-id", "value": "", "type": "text" } ], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base-url}}ads/api/v1/aliases/{{aliasId}}", "host": [ "{{base-url}}ads" ], "path": [ "api", "v1", "aliases", "{{aliasId}}" ] }, "description": "The List Configurations endpoint enables you to retrieve all configurations that your institution has access to. \n\nFor more information, see [List Configuration](https://cardsapidocs.thredd.com/v2.0/docs/list-configurations#/)." }, "response": [ { "name": "Get Alias", "originalRequest": { "method": "GET", "header": [], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base-url}}ads/api/v1/aliases/{{aliasId}}", "host": [ "{{base-url}}ads" ], "path": [ "api", "v1", "aliases", "{{aliasId}}" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "", "type": "text" } ], "cookie": [], "body": "{\n \"status\": \"success\",\n \"response\": {\n \"status\": \"ACTIVE\",\n \"trackingId\": \"alias#-64111a56-20250602063331\",\n \"aliasType\": \"PHONE\",\n \"createdOn\": \"2021-01-01T22:52:46.000Z\",\n \"aliasValue\": \"1231231234\",\n \"lastModifiedOn\": \"2021-01-01T22:52:46.000Z\",\n \"consent\": {\n \"version\": \"1.0\",\n \"presenter\": \"Bank A\",\n \"expiryDateTime\": \"2022-06-20T10:00:00Z\",\n \"intermediaries\": [\n \"Client A\"\n ],\n \"validFromDateTime\": \"2021-12-01T10:00:00Z\"\n },\n \"profile\": {\n \"lastName\": \"Miller\",\n \"firstName\": \"Alex\",\n \"middleName\": \"Robert\",\n \"contactInfo\": [\n {\n \"type\": \"PHONE\",\n \"value\": \"1231234321\"\n }\n ],\n \"dateOfBirth\": \"1980-02-01\",\n \"lastNameLocal\": \"Miller\",\n \"preferredName\": \"Miller's Shop\",\n \"firstNameLocal\": \"Alexander\",\n \"middleNameLocal\": \"Roberto\"\n },\n \"identification\": {\n \"type\": \"PASSPORT\",\n \"value\": \"A123456\",\n \"verificationDetails\": {\n \"authDateTime\": \"2021-01-01T22:52:46Z\",\n \"verifiedEmail\": true,\n \"verifiedPhone\": false,\n \"creationDateTime\": \"2021-01-01T22:52:46Z\",\n \"authMethodReference\": \"EXTERNAL, SMS OTP, Email OTP\"\n }\n }\n }\n}" } ] }, { "name": "Update Alias", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{access_token}}", "type": "string" } ] }, "method": "PUT", "header": [], "body": { "mode": "raw", "raw": "{\r\n \"identificationInfo\": {\r\n \"type\": \"PASSPORT\",\r\n \"value\": \"A123456\",\r\n \"verificationInfo\": {\r\n \"isPhoneVerified\": false,\r\n \"authMethodReference\": \"EXTERNAL, SMS OTP, Email OTP\",\r\n \"authDateTime\": \"2021-01-01T22:52:46.000Z\",\r\n \"isEmailVerified\": true,\r\n \"creationDateTime\": \"2021-01-01T22:52:46.000Z\"\r\n }\r\n },\r\n \"profileInfo\": {\r\n \"firstName\": \"Alex\",\r\n \"lastName\": \"Miller\",\r\n \"firstNameLocal\": \"Roberto\",\r\n \"lastNameLocal\": \"Miller\",\r\n \"middleName\": \"Robert\",\r\n \"middleNameLocal\": \"Alexander\",\r\n \"preferredName\": \"Miller's Shop\",\r\n \"dateOfBirth\": \"1980-02-01\",\r\n \"contactInfo\": [\r\n {\r\n \"type\": \"PHONE\",\r\n \"value\": \"1231234321\"\r\n }\r\n ]\r\n },\r\n \"consentInfo\": {\r\n \"presenter\": \"Bank A\",\r\n \"validFromDateTime\": \"2021-12-01T10:00:00.000Z\",\r\n \"version\": \"1.0\",\r\n \"expiryDateTime\": \"2025-06-11T10:00:00.000Z\",\r\n \"intermediaries\": [\r\n \"Client A\"\r\n ]\r\n }\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base-url}}ads/api/v1/aliases/{{aliasId}}", "host": [ "{{base-url}}ads" ], "path": [ "api", "v1", "aliases", "{{aliasId}}" ] }, "description": "The Update Configuration endpoint enables you to update an existing configuration based on the provided `configId` and request payload. \n\nFor more information, see [Update Configuration](https://cardsapidocs.thredd.com/v2.0/docs/update-configuration#/)." }, "response": [ { "name": "Update Alias", "originalRequest": { "method": "PUT", "header": [], "body": { "mode": "raw", "raw": "{\r\n \"identificationInfo\": {\r\n \"type\": \"PASSPORT\",\r\n \"value\": \"A123456\",\r\n \"verificationInfo\": {\r\n \"isPhoneVerified\": false,\r\n \"authMethodReference\": \"EXTERNAL, SMS OTP, Email OTP\",\r\n \"authDateTime\": \"2021-01-01T22:52:46.000Z\",\r\n \"isEmailVerified\": true,\r\n \"creationDateTime\": \"2021-01-01T22:52:46.000Z\"\r\n }\r\n },\r\n \"profileInfo\": {\r\n \"firstName\": \"Alex\",\r\n \"lastName\": \"Miller\",\r\n \"firstNameLocal\": \"Roberto\",\r\n \"lastNameLocal\": \"Miller\",\r\n \"middleName\": \"Robert\",\r\n \"middleNameLocal\": \"Alexander\",\r\n \"preferredName\": \"Miller's Shop\",\r\n \"dateOfBirth\": \"1980-02-01\",\r\n \"contactInfo\": [\r\n {\r\n \"type\": \"PHONE\",\r\n \"value\": \"1231234321\"\r\n }\r\n ]\r\n },\r\n \"consentInfo\": {\r\n \"presenter\": \"Bank A\",\r\n \"validFromDateTime\": \"2021-12-01T10:00:00.000Z\",\r\n \"version\": \"1.0\",\r\n \"expiryDateTime\": \"2025-06-11T10:00:00.000Z\",\r\n \"intermediaries\": [\r\n \"Client A\"\r\n ]\r\n }\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base-url}}ads/api/v1/aliases/{{aliasId}}", "host": [ "{{base-url}}ads" ], "path": [ "api", "v1", "aliases", "{{aliasId}}" ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "", "type": "text" } ], "cookie": [], "body": "" } ] }, { "name": "Delete Alias", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{access_token}}", "type": "string" } ] }, "method": "DELETE", "header": [], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base-url}}ads/api/v1/aliases/{{aliasId}}", "host": [ "{{base-url}}ads" ], "path": [ "api", "v1", "aliases", "{{aliasId}}" ] }, "description": "The Delete Configuration endpoint enables you to delete a configuration, with the configuration identifier specified in the URL. \n\nFor more information, see [Delete Configuration](https://cardsapidocs.thredd.com/v2.0/docs/delete-configuration#/)." }, "response": [] }, { "name": "Create Alias", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{access_token}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "client-id", "value": "", "type": "text" }, { "key": "partner-id", "value": "", "type": "text" } ], "body": { "mode": "raw", "raw": "{\r\n \"aliasInfo\": {\r\n \"type\": \"PHONE\",\r\n \"value\": \"1231231234\",\r\n \"externalId\": \"21267931-7975-4b61-be7a-86915883b2b4\"\r\n },\r\n \"paymentType\": \"CARD\",\r\n \"paymentInfo\": {\r\n \"cardInfo\": {\r\n \"nameOnCard\": \"Alex Miller\",\r\n \"issuerName\": \"Bank A\",\r\n \"cardType\": \"Visa Platinum\",\r\n \"expirationDate\": \"2030-01\",\r\n \"externalId\": \"63421837-d597-4f0f-89e4-930c1a7b9e85\",\r\n \"currencyCode\": \"USD\",\r\n \"preferredFor\": [\r\n {\r\n \"type\": \"RECEIVE\"\r\n }\r\n ],\r\n \"billingAddress\": {\r\n \"country\": \"USA\",\r\n \"addressLine1\": \"1000 Market Street\",\r\n \"addressLine2\": \"Suite 101\",\r\n \"buildingNumber\": \"56\",\r\n \"city\": \"San Francisco\",\r\n \"minorSubdivisionCode\": \"CA\",\r\n \"streetName\": \"12\",\r\n \"postalCode\": \"94105\",\r\n \"state\": \"CA\"\r\n },\r\n \"accountNumber\": \"411*****455***42\"\r\n },\r\n \"bankInfo\": {\r\n \"accountName\": \"Alex Miller\",\r\n \"accountNumber\": \"411*****455***42\",\r\n \"accountNumberType\": \"DEFAULT\",\r\n \"accountType\": \"SAVING\",\r\n \"bankName\": \"Bank A\",\r\n \"bankCode\": \"173\",\r\n \"branchCode\": \"123456\",\r\n \"bankCodeType\": \"ABA\",\r\n \"bic\": \"AAAABBCC123\",\r\n \"countryCode\": \"USA\",\r\n \"currencyCode\": \"USD\",\r\n \"externalId\": \"63421837-d597-4f0f-89e4-930c1a7b9e85\",\r\n \"address\": {\r\n \"country\": \"USA\",\r\n \"addressLine1\": \"1000 Market Street\",\r\n \"addressLine2\": \"Suite 101\",\r\n \"buildingNumber\": \"56\",\r\n \"city\": \"San Francisco\",\r\n \"minorSubdivisionCode\": \"CA\",\r\n \"streetName\": \"12\",\r\n \"postalCode\": \"94105\",\r\n \"state\": \"CA\"\r\n },\r\n \"preferredFor\": [\r\n {\r\n \"type\": \"RECEIVE\"\r\n }\r\n ]\r\n },\r\n \"threddInfo\": {\r\n \"accountNumber\": \"238915978\",\r\n \"nameOnCard\": \"Alex Miller\",\r\n \"issuerName\": \"Bank A\",\r\n \"cardType\": \"Visa Platinum\",\r\n \"externalIdForCard\": \"63421837-d597-4f0f-89e4-930c1a7b9e85\",\r\n \"currencyCode\": \"USD\",\r\n \"preferredFor\": [\r\n {\r\n \"type\": \"RECEIVE\"\r\n }\r\n ],\r\n \"billingAddress\": {\r\n \"country\": \"USA\",\r\n \"addressLine1\": \"1000 Market Street\",\r\n \"addressLine2\": \"Suite 101\",\r\n \"buildingNumber\": \"56\",\r\n \"city\": \"San Francisco\",\r\n \"minorSubdivisionCode\": \"CA\",\r\n \"streetName\": \"12\",\r\n \"postalCode\": \"94105\",\r\n \"state\": \"CA\"\r\n }\r\n }\r\n },\r\n \"identificationInfo\": {\r\n \"type\": \"PASSPORT\",\r\n \"value\": \"A123456\",\r\n \"verificationInfo\": {\r\n \"isPhoneVerified\": false,\r\n \"authMethodReference\": \"EXTERNAL, SMS OTP, Email OTP\",\r\n \"authDateTime\": \"2021-01-01T22:52:46Z\",\r\n \"isEmailVerified\": true,\r\n \"creationDateTime\": \"2021-01-01T22:52:46Z\"\r\n }\r\n },\r\n \"consentInfo\": {\r\n \"presenter\": \"Bank A\",\r\n \"validFromDateTime\": \"2021-12-01T10:00:00Z\",\r\n \"version\": \"1.0\",\r\n \"expiryDateTime\": \"2025-06-11T10:00:00Z\",\r\n \"intermediaries\": [\r\n \"Client A\",\r\n \"Client B\"\r\n ]\r\n },\r\n \"profileInfo\": {\r\n \"firstName\": \"Alex\",\r\n \"lastName\": \"Miller\",\r\n \"firstNameLocal\": \"Alexander\",\r\n \"lastNameLocal\": \"Miller\",\r\n \"middleName\": \"Robert\",\r\n \"middleNameLocal\": \"Roberto\",\r\n \"preferredName\": \"Miller's Shop\",\r\n \"dateOfBirth\": \"1980-02-01\",\r\n \"contactInfo\": [\r\n {\r\n \"type\": \"PHONE\",\r\n \"value\": \"1231234321\"\r\n },\r\n {\r\n \"type\": \"EMAIL\",\r\n \"value\": \"alex.miller@email.com\"\r\n }\r\n ]\r\n }\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base-url}}ads/api/v1/aliases", "host": [ "{{base-url}}ads" ], "path": [ "api", "v1", "aliases" ] }, "description": "The Create Configuration endpoint enables you to create a configuration for a Transaction Confirmation (TC) event.\n\nFor more information, see [Create Configuration](https://cardsapidocs.thredd.com/v2.0/docs/create-configuration#/)." }, "response": [ { "name": "Create Alias", "originalRequest": { "method": "POST", "header": [ { "key": "client-id", "value": "", "type": "text" }, { "key": "partner-id", "value": "", "type": "text" } ], "body": { "mode": "raw", "raw": "{\r\n \"aliasInfo\": {\r\n \"type\": \"PHONE\",\r\n \"value\": \"1231231234\",\r\n \"externalId\": \"21267931-7975-4b61-be7a-86915883b2b4\"\r\n },\r\n \"paymentType\": \"CARD\",\r\n \"paymentInfo\": {\r\n \"cardInfo\": {\r\n \"nameOnCard\": \"Alex Miller\",\r\n \"issuerName\": \"Bank A\",\r\n \"cardType\": \"Visa Platinum\",\r\n \"expirationDate\": \"2030-01\",\r\n \"externalId\": \"63421837-d597-4f0f-89e4-930c1a7b9e85\",\r\n \"currencyCode\": \"USD\",\r\n \"preferredFor\": [\r\n {\r\n \"type\": \"RECEIVE\"\r\n }\r\n ],\r\n \"billingAddress\": {\r\n \"country\": \"USA\",\r\n \"addressLine1\": \"1000 Market Street\",\r\n \"addressLine2\": \"Suite 101\",\r\n \"buildingNumber\": \"56\",\r\n \"city\": \"San Francisco\",\r\n \"minorSubdivisionCode\": \"CA\",\r\n \"streetName\": \"12\",\r\n \"postalCode\": \"94105\",\r\n \"state\": \"CA\"\r\n },\r\n \"accountNumber\": \"411*****455***42\"\r\n },\r\n \"bankInfo\": {\r\n \"accountName\": \"Alex Miller\",\r\n \"accountNumber\": \"411*****455***42\",\r\n \"accountNumberType\": \"DEFAULT\",\r\n \"accountType\": \"SAVING\",\r\n \"bankName\": \"Bank A\",\r\n \"bankCode\": \"173\",\r\n \"branchCode\": \"123456\",\r\n \"bankCodeType\": \"ABA\",\r\n \"bic\": \"AAAABBCC123\",\r\n \"countryCode\": \"USA\",\r\n \"currencyCode\": \"USD\",\r\n \"externalId\": \"63421837-d597-4f0f-89e4-930c1a7b9e85\",\r\n \"address\": {\r\n \"country\": \"USA\",\r\n \"addressLine1\": \"1000 Market Street\",\r\n \"addressLine2\": \"Suite 101\",\r\n \"buildingNumber\": \"56\",\r\n \"city\": \"San Francisco\",\r\n \"minorSubdivisionCode\": \"CA\",\r\n \"streetName\": \"12\",\r\n \"postalCode\": \"94105\",\r\n \"state\": \"CA\"\r\n },\r\n \"preferredFor\": [\r\n {\r\n \"type\": \"RECEIVE\"\r\n }\r\n ]\r\n },\r\n \"threddInfo\": {\r\n \"accountNumber\": \"238915978\",\r\n \"nameOnCard\": \"Alex Miller\",\r\n \"issuerName\": \"Bank A\",\r\n \"cardType\": \"Visa Platinum\",\r\n \"externalIdForCard\": \"63421837-d597-4f0f-89e4-930c1a7b9e85\",\r\n \"currencyCode\": \"USD\",\r\n \"preferredFor\": [\r\n {\r\n \"type\": \"RECEIVE\"\r\n }\r\n ],\r\n \"billingAddress\": {\r\n \"country\": \"USA\",\r\n \"addressLine1\": \"1000 Market Street\",\r\n \"addressLine2\": \"Suite 101\",\r\n \"buildingNumber\": \"56\",\r\n \"city\": \"San Francisco\",\r\n \"minorSubdivisionCode\": \"CA\",\r\n \"streetName\": \"12\",\r\n \"postalCode\": \"94105\",\r\n \"state\": \"CA\"\r\n }\r\n }\r\n },\r\n \"identificationInfo\": {\r\n \"type\": \"PASSPORT\",\r\n \"value\": \"A123456\",\r\n \"verificationInfo\": {\r\n \"isPhoneVerified\": false,\r\n \"authMethodReference\": \"EXTERNAL, SMS OTP, Email OTP\",\r\n \"authDateTime\": \"2021-01-01T22:52:46Z\",\r\n \"isEmailVerified\": true,\r\n \"creationDateTime\": \"2021-01-01T22:52:46Z\"\r\n }\r\n },\r\n \"consentInfo\": {\r\n \"presenter\": \"Bank A\",\r\n \"validFromDateTime\": \"2021-12-01T10:00:00Z\",\r\n \"version\": \"1.0\",\r\n \"expiryDateTime\": \"2025-06-11T10:00:00Z\",\r\n \"intermediaries\": [\r\n \"Client A\",\r\n \"Client B\"\r\n ]\r\n },\r\n \"profileInfo\": {\r\n \"firstName\": \"Alex\",\r\n \"lastName\": \"Miller\",\r\n \"firstNameLocal\": \"Alexander\",\r\n \"lastNameLocal\": \"Miller\",\r\n \"middleName\": \"Robert\",\r\n \"middleNameLocal\": \"Roberto\",\r\n \"preferredName\": \"Miller's Shop\",\r\n \"dateOfBirth\": \"1980-02-01\",\r\n \"contactInfo\": [\r\n {\r\n \"type\": \"PHONE\",\r\n \"value\": \"1231234321\"\r\n },\r\n {\r\n \"type\": \"EMAIL\",\r\n \"value\": \"alex.miller@email.com\"\r\n }\r\n ]\r\n }\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base-url}}ads/api/v1/aliases", "host": [ "{{base-url}}ads" ], "path": [ "api", "v1", "aliases" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "", "type": "text" } ], "cookie": [], "body": "{\r\n \"status\": \"success\",\r\n \"response\": {\r\n \"aliasId\": \"e336c8c8-2945-4be3-af3e-951ec2d01219\",\r\n \"externalId\": \"21267931-7975-4b61-be7a-86915883b2b4\",\r\n \"trackingId\": \"87347931-5975-4b61-be7a-86915883b2c6\",\r\n \"paymentCredentials\": [\r\n {\r\n \"id\": \"a44c9553-e687-4f3c-b7e7-a4245d9f238e\",\r\n \"type\": \"CARD\",\r\n \"externalId\": \"63421837-d597-4f0f-89e4-930c1a7b9e85\"\r\n }\r\n ]\r\n }\r\n}" } ] }, { "name": "Create Additional Alias", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{access_token}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "client-id", "value": "", "type": "text" }, { "key": "partner-id", "value": "", "type": "text" } ], "body": { "mode": "raw", "raw": "{\r\n \"aliasType\": \"PHONE\",\r\n \"aliasValue\": \"1231231234\"\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base-url}}ads/api/v1/aliases/{{aliasId}}/additionalAlias", "host": [ "{{base-url}}ads" ], "path": [ "api", "v1", "aliases", "{{aliasId}}", "additionalAlias" ] }, "description": "The Create Configuration endpoint enables you to create a configuration for a Transaction Confirmation (TC) event.\n\nFor more information, see [Create Configuration](https://cardsapidocs.thredd.com/v2.0/docs/create-configuration#/)." }, "response": [ { "name": "Create Additional Alias", "originalRequest": { "method": "POST", "header": [ { "key": "client-id", "value": "", "type": "text" }, { "key": "partner-id", "value": "", "type": "text" } ], "body": { "mode": "raw", "raw": "{\r\n \"aliasType\": \"PHONE\",\r\n \"aliasValue\": \"1231231234\"\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base-url}}ads/api/v1/aliases/{{aliasId}}/additionalAlias", "host": [ "{{base-url}}ads" ], "path": [ "api", "v1", "aliases", "{{aliasId}}", "additionalAlias" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "", "type": "text" } ], "cookie": [], "body": "{\r\n \"status\": \"success\",\r\n \"response\": {\r\n \"trackingId\": \"alias#-64111a56-20250602063331\",\r\n \"id\": \"e336c8c8-2945-4be3-af3e-951ec2d01219\"\r\n }\r\n}" } ] }, { "name": "Get Alias ID From Value", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{access_token}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "client-id", "value": "", "type": "text" }, { "key": "partner-id", "value": "", "type": "text" } ], "body": { "mode": "raw", "raw": "{\r\n \"aliasValue\": \"1231231234\"\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base-url}}ads/api/v1/aliases/aliasId", "host": [ "{{base-url}}ads" ], "path": [ "api", "v1", "aliases", "aliasId" ] }, "description": "The Create Configuration endpoint enables you to create a configuration for a Transaction Confirmation (TC) event.\n\nFor more information, see [Create Configuration](https://cardsapidocs.thredd.com/v2.0/docs/create-configuration#/)." }, "response": [ { "name": "Get Alias ID From Value", "originalRequest": { "method": "POST", "header": [ { "key": "client-id", "value": "", "type": "text" }, { "key": "partner-id", "value": "", "type": "text" } ], "body": { "mode": "raw", "raw": "{\r\n \"aliasValue\": \"1231231234\"\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base-url}}ads/api/v1/aliases/aliasId", "host": [ "{{base-url}}ads" ], "path": [ "api", "v1", "aliases", "aliasId" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "", "type": "text" } ], "cookie": [], "body": "{\r\n \"status\": \"success\",\r\n \"response\": {\r\n \"trackingId\": \"alias#-64111a56-20250602063331\",\r\n \"aliasId\": \"e336c8c8-2945-4be3-af3e-951ec2d01219\"\r\n }\r\n}" } ] }, { "name": "Get By External ID", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{access_token}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "client-id", "value": "", "type": "text" }, { "key": "partner-id", "value": "", "type": "text" } ], "body": { "mode": "raw", "raw": "{\r\n \"externalId\": \"21267931-7975-4b61-be7a-86915883b2b4\",\r\n \"type\": \"ALIAS\"\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base-url}}ads/api/v1/aliases/getByExternalId", "host": [ "{{base-url}}ads" ], "path": [ "api", "v1", "aliases", "getByExternalId" ] }, "description": "The Create Configuration endpoint enables you to create a configuration for a Transaction Confirmation (TC) event.\n\nFor more information, see [Create Configuration](https://cardsapidocs.thredd.com/v2.0/docs/create-configuration#/)." }, "response": [ { "name": "Get By External ID", "originalRequest": { "method": "POST", "header": [ { "key": "client-id", "value": "", "type": "text" }, { "key": "partner-id", "value": "", "type": "text" } ], "body": { "mode": "raw", "raw": "{\r\n \"externalId\": \"21267931-7975-4b61-be7a-86915883b2b4\",\r\n \"type\": \"ALIAS\"\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base-url}}ads/api/v1/aliases/getByExternalId", "host": [ "{{base-url}}ads" ], "path": [ "api", "v1", "aliases", "getByExternalId" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "", "type": "text" } ], "cookie": [], "body": "{\r\n \"status\": \"success\",\r\n \"response\": {\r\n \"trackingId\": \"alias#-64111a56-20250602063331\",\r\n \"id\": \"e336c8c8-2945-4be3-af3e-951ec2d01219\",\r\n \"associatedIds\": [\r\n {\r\n \"id\": \"string\",\r\n \"type\": \"string\"\r\n }\r\n ]\r\n }\r\n}" } ] }, { "name": "Update Alias Status", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{access_token}}", "type": "string" } ] }, "method": "PUT", "header": [], "body": { "mode": "raw", "raw": "{\r\n \"status\":\"ACTIVE\"\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base-url}}ads/api/v1/aliases/{{aliasId}}/status", "host": [ "{{base-url}}ads" ], "path": [ "api", "v1", "aliases", "{{aliasId}}", "status" ] }, "description": "The Update Configuration endpoint enables you to update an existing configuration based on the provided `configId` and request payload. \n\nFor more information, see [Update Configuration](https://cardsapidocs.thredd.com/v2.0/docs/update-configuration#/)." }, "response": [ { "name": "Update Alias Status", "originalRequest": { "method": "PUT", "header": [], "body": { "mode": "raw", "raw": "{\r\n \"status\":\"ACTIVE\"\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base-url}}ads/api/v1/aliases/{{aliasId}}/status", "host": [ "{{base-url}}ads" ], "path": [ "api", "v1", "aliases", "{{aliasId}}", "status" ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "", "type": "text" } ], "cookie": [], "body": "" } ] }, { "name": "Delete Additional Alias", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{access_token}}", "type": "string" } ] }, "method": "DELETE", "header": [], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base-url}}ads/api/v1/aliases/additional/{{additionalAlias}}", "host": [ "{{base-url}}ads" ], "path": [ "api", "v1", "aliases", "additional", "{{additionalAlias}}" ] }, "description": "The Delete Configuration endpoint enables you to delete a configuration, with the configuration identifier specified in the URL. \n\nFor more information, see [Delete Configuration](https://cardsapidocs.thredd.com/v2.0/docs/delete-configuration#/)." }, "response": [] }, { "name": "Get All Payment Credentials", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{access_token}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "client-id", "value": "", "type": "text" }, { "key": "partner-id", "value": "", "type": "text" } ], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base-url}}ads/api/v1/aliases/{{aliasId}}/paymentCredentials", "host": [ "{{base-url}}ads" ], "path": [ "api", "v1", "aliases", "{{aliasId}}", "paymentCredentials" ] }, "description": "The List Configurations endpoint enables you to retrieve all configurations that your institution has access to. \n\nFor more information, see [List Configuration](https://cardsapidocs.thredd.com/v2.0/docs/list-configurations#/)." }, "response": [ { "name": "Get All Payment Credentials", "originalRequest": { "method": "GET", "header": [], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base-url}}ads/api/v1/aliases/{{aliasId}}/paymentCredentials", "host": [ "{{base-url}}ads" ], "path": [ "api", "v1", "aliases", "{{aliasId}}", "paymentCredentials" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "", "type": "text" } ], "cookie": [], "body": "{\n \"status\": \"success\",\n \"response\": {\n \"trackingId\": \"alias#-c1185292-20250528122428\",\n \"paymentCredentialsAll\": [\n {\n \"cardInfoAll\": [\n {\n \"id\": \"88703d56-872f-4fb9-abba-9721479eb624\",\n \"nameOnCard\": \"John Doe\",\n \"issuerName\": \"Bank A\",\n \"cardType\": \"Visa Platinum\",\n \"accountNumber\": \"411X********1142\",\n \"expirationDate\": \"2030-01\",\n \"externalId\": \"63421837-d597-4f0f-89e4-930c1a7b9u82\",\n \"currencyCode\": \"USD\",\n \"billingAddress\": {\n \"country\": \"USA\",\n \"addressLine1\": \"1000 Market Street\",\n \"addressLine2\": \"Suite 101\",\n \"buildingNumber\": \"56\",\n \"city\": \"San Francisco\",\n \"minorSubdivisionCode\": \"CA\",\n \"postalCode\": \"94105\",\n \"state\": \"CA\",\n \"streetName\": \"12\"\n },\n \"preferredFor\": [\n {\n \"type\": \"RECEIVE\",\n \"date\": \"2021-01-01T22:52:46Z\"\n }\n ],\n \"accountNumberType\": \"PAN\",\n \"lastFourDigits\": \"1142\",\n \"status\": \"ACTIVE\",\n \"createdOn\": \"2021-06-21T13:00:00.645Z\",\n \"lastUpdatedOn\": \"2021-06-22T15:12:00.322Z\",\n \"type\": \"CARD\"\n }\n ],\n \"bankInfoAll\": [\n {\n \"id\": \"e122cfde-9fe2-4e56-abbf-2d4c6e4a7d96\",\n \"accountName\": \"John Doe\",\n \"accountNumber\": \"411X********1142\",\n \"accountNumberType\": \"IBAN\",\n \"accountType\": \"CHECKING\",\n \"bankName\": \"JPMorgan Chase Bank\",\n \"bankCode\": \"021000021\",\n \"bankCodeType\": \"ABA\",\n \"bic\": \"AAAABBCC123\",\n \"countryCode\": \"USA\",\n \"currencyCode\": \"USD\",\n \"externalId\": \"63421837-d597-4f0f-89e4-930c1a7b9e85\",\n \"branchCode\": \"123456\",\n \"address\": {\n \"country\": \"USA\",\n \"addressLine1\": \"1000 Market Street\",\n \"addressLine2\": \"Suite 101\",\n \"buildingNumber\": \"56\",\n \"city\": \"San Francisco\",\n \"minorSubdivisionCode\": \"CA\",\n \"postalCode\": \"94105\",\n \"state\": \"CA\",\n \"streetName\": \"12\"\n },\n \"type\": \"BANK\",\n \"status\": \"ACTIVE\",\n \"createdOn\": \"05/28/2025 11:46:29\",\n \"lastUpdatedOn\": \"2021-06-22T15:12:00.322Z\",\n \"preferredFor\": [\n {\n \"type\": \"RECEIVE\",\n \"date\": \"2021-01-01T22:52:46Z\"\n }\n ]\n }\n ]\n }\n ]\n }\n}" } ] }, { "name": "Create Payment Credential", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{access_token}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "client-id", "value": "", "type": "text" }, { "key": "partner-id", "value": "", "type": "text" } ], "body": { "mode": "raw", "raw": "{\r\n \"paymentType\": \"CARD\",\r\n \"paymentInfo\": {\r\n \"cardInfo\": {\r\n \"nameOnCard\": \"Alex Miller\",\r\n \"issuerName\": \"Bank A\",\r\n \"cardType\": \"Visa Platinum\",\r\n \"expirationDate\": \"2030-01\",\r\n \"externalId\": \"63421837-d597-4f0f-89e4-930c1a7b9e85\",\r\n \"currencyCode\": \"USD\",\r\n \"preferredFor\": [\r\n {\r\n \"type\": \"RECEIVE\"\r\n }\r\n ],\r\n \"billingAddress\": {\r\n \"country\": \"USA\",\r\n \"addressLine1\": \"1000 Market Street\",\r\n \"addressLine2\": \"Suite 101\",\r\n \"buildingNumber\": \"56\",\r\n \"city\": \"San Francisco\",\r\n \"minorSubdivisionCode\": \"CA\",\r\n \"streetName\": \"12\",\r\n \"postalCode\": \"94105\",\r\n \"state\": \"CA\"\r\n },\r\n \"accountNumber\": \"411*****455***42\"\r\n },\r\n \"bankInfo\": {\r\n \"accountName\": \"Alex Miller\",\r\n \"accountNumber\": \"411*****455***42\",\r\n \"accountNumberType\": \"DEFAULT\",\r\n \"accountType\": \"SAVING\",\r\n \"bankName\": \"Bank A\",\r\n \"bankCode\": \"173\",\r\n \"branchCode\": \"123456\",\r\n \"bankCodeType\": \"ABA\",\r\n \"bic\": \"AAAABBCC123\",\r\n \"countryCode\": \"USA\",\r\n \"currencyCode\": \"USD\",\r\n \"externalId\": \"63421837-d597-4f0f-89e4-930c1a7b9e85\",\r\n \"address\": {\r\n \"country\": \"USA\",\r\n \"addressLine1\": \"1000 Market Street\",\r\n \"addressLine2\": \"Suite 101\",\r\n \"buildingNumber\": \"56\",\r\n \"city\": \"San Francisco\",\r\n \"minorSubdivisionCode\": \"CA\",\r\n \"streetName\": \"12\",\r\n \"postalCode\": \"94105\",\r\n \"state\": \"CA\"\r\n },\r\n \"preferredFor\": [\r\n {\r\n \"type\": \"RECEIVE\"\r\n }\r\n ]\r\n },\r\n \"threddInfo\": {\r\n \"accountNumber\": \"238915978\",\r\n \"nameOnCard\": \"Alex Miller\",\r\n \"issuerName\": \"Bank A\",\r\n \"cardType\": \"Visa Platinum\",\r\n \"externalIdForCard\": \"63421837-d597-4f0f-89e4-930c1a7b9e85\",\r\n \"currencyCode\": \"USD\",\r\n \"preferredFor\": [\r\n {\r\n \"type\": \"RECEIVE\"\r\n }\r\n ],\r\n \"billingAddress\": {\r\n \"country\": \"USA\",\r\n \"addressLine1\": \"1000 Market Street\",\r\n \"addressLine2\": \"Suite 101\",\r\n \"buildingNumber\": \"56\",\r\n \"city\": \"San Francisco\",\r\n \"minorSubdivisionCode\": \"CA\",\r\n \"streetName\": \"12\",\r\n \"postalCode\": \"94105\",\r\n \"state\": \"CA\"\r\n }\r\n }\r\n }\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base-url}}ads/api/v1/aliases/{{aliasId}}/paymentCredentials", "host": [ "{{base-url}}ads" ], "path": [ "api", "v1", "aliases", "{{aliasId}}", "paymentCredentials" ] }, "description": "The Create Configuration endpoint enables you to create a configuration for a Transaction Confirmation (TC) event.\n\nFor more information, see [Create Configuration](https://cardsapidocs.thredd.com/v2.0/docs/create-configuration#/)." }, "response": [ { "name": "Create Payment Credential", "originalRequest": { "method": "POST", "header": [ { "key": "client-id", "value": "", "type": "text" }, { "key": "partner-id", "value": "", "type": "text" } ], "body": { "mode": "raw", "raw": "{\r\n \"paymentType\": \"CARD\",\r\n \"paymentInfo\": {\r\n \"cardInfo\": {\r\n \"nameOnCard\": \"Alex Miller\",\r\n \"issuerName\": \"Bank A\",\r\n \"cardType\": \"Visa Platinum\",\r\n \"expirationDate\": \"2030-01\",\r\n \"externalId\": \"63421837-d597-4f0f-89e4-930c1a7b9e85\",\r\n \"currencyCode\": \"USD\",\r\n \"preferredFor\": [\r\n {\r\n \"type\": \"RECEIVE\"\r\n }\r\n ],\r\n \"billingAddress\": {\r\n \"country\": \"USA\",\r\n \"addressLine1\": \"1000 Market Street\",\r\n \"addressLine2\": \"Suite 101\",\r\n \"buildingNumber\": \"56\",\r\n \"city\": \"San Francisco\",\r\n \"minorSubdivisionCode\": \"CA\",\r\n \"streetName\": \"12\",\r\n \"postalCode\": \"94105\",\r\n \"state\": \"CA\"\r\n },\r\n \"accountNumber\": \"411*****455***42\"\r\n },\r\n \"bankInfo\": {\r\n \"accountName\": \"Alex Miller\",\r\n \"accountNumber\": \"411*****455***42\",\r\n \"accountNumberType\": \"DEFAULT\",\r\n \"accountType\": \"SAVING\",\r\n \"bankName\": \"Bank A\",\r\n \"bankCode\": \"173\",\r\n \"branchCode\": \"123456\",\r\n \"bankCodeType\": \"ABA\",\r\n \"bic\": \"AAAABBCC123\",\r\n \"countryCode\": \"USA\",\r\n \"currencyCode\": \"USD\",\r\n \"externalId\": \"63421837-d597-4f0f-89e4-930c1a7b9e85\",\r\n \"address\": {\r\n \"country\": \"USA\",\r\n \"addressLine1\": \"1000 Market Street\",\r\n \"addressLine2\": \"Suite 101\",\r\n \"buildingNumber\": \"56\",\r\n \"city\": \"San Francisco\",\r\n \"minorSubdivisionCode\": \"CA\",\r\n \"streetName\": \"12\",\r\n \"postalCode\": \"94105\",\r\n \"state\": \"CA\"\r\n },\r\n \"preferredFor\": [\r\n {\r\n \"type\": \"RECEIVE\"\r\n }\r\n ]\r\n },\r\n \"threddInfo\": {\r\n \"accountNumber\": \"238915978\",\r\n \"nameOnCard\": \"Alex Miller\",\r\n \"issuerName\": \"Bank A\",\r\n \"cardType\": \"Visa Platinum\",\r\n \"externalIdForCard\": \"63421837-d597-4f0f-89e4-930c1a7b9e85\",\r\n \"currencyCode\": \"USD\",\r\n \"preferredFor\": [\r\n {\r\n \"type\": \"RECEIVE\"\r\n }\r\n ],\r\n \"billingAddress\": {\r\n \"country\": \"USA\",\r\n \"addressLine1\": \"1000 Market Street\",\r\n \"addressLine2\": \"Suite 101\",\r\n \"buildingNumber\": \"56\",\r\n \"city\": \"San Francisco\",\r\n \"minorSubdivisionCode\": \"CA\",\r\n \"streetName\": \"12\",\r\n \"postalCode\": \"94105\",\r\n \"state\": \"CA\"\r\n }\r\n }\r\n }\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base-url}}ads/api/v1/aliases/{{aliasId}}/paymentCredentials", "host": [ "{{base-url}}ads" ], "path": [ "api", "v1", "aliases", "{{aliasId}}", "paymentCredentials" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "", "type": "text" } ], "cookie": [], "body": "{\r\n \"status\": \"success\",\r\n \"response\": {\r\n \"trackingId\": \"alias#-64111a56-20250602063331\",\r\n \"paymentCredentialId\": \"a44c9553-e687-4f3c-b7e7-a4245d9f238e\",\r\n \"type\": \"CARD\",\r\n \"externalId\": \"63421837-d597-4f0f-89e4-930c1a7b9e85\"\r\n }\r\n}" } ] }, { "name": "Get Payment Credentials", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{access_token}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "client-id", "value": "", "type": "text" }, { "key": "partner-id", "value": "", "type": "text" } ], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base-url}}ads/api/v1/paymentCredentials/{{paymentCredentialId}}", "host": [ "{{base-url}}ads" ], "path": [ "api", "v1", "paymentCredentials", "{{paymentCredentialId}}" ] }, "description": "The List Configurations endpoint enables you to retrieve all configurations that your institution has access to. \n\nFor more information, see [List Configuration](https://cardsapidocs.thredd.com/v2.0/docs/list-configurations#/)." }, "response": [ { "name": "Get Payment Credentials", "originalRequest": { "method": "GET", "header": [], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base-url}}ads/api/v1/paymentCredentials/{{paymentCredentialId}}", "host": [ "{{base-url}}ads" ], "path": [ "api", "v1", "paymentCredentials", "{{paymentCredentialId}}" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "", "type": "text" } ], "cookie": [], "body": "{\n \"status\": \"success\",\n \"response\": {\n \"trackingId\": \"alias#-8a995901-20250602101655\",\n \"paymentCredentials\": {\n \"id\": \"88c1977e-ef85-4982-9fcc-01dffdb45d30\",\n \"nameOnCard\": \"John Doe\",\n \"issuerName\": \"Bank of America\",\n \"cardType\": \"VISA\",\n \"accountNumber\": \"411X********1142\",\n \"expirationDate\": \"2025-12\",\n \"currencyCode\": \"USD\",\n \"billingAddress\": {\n \"country\": \"USA\",\n \"addressLine1\": \"123 Main St\",\n \"addressLine2\": \"Apt 4B\",\n \"buildingNumber\": \"456\",\n \"city\": \"Los Angeles\",\n \"minorSubdivisionCode\": \"CA\",\n \"streetName\": \"Sunset Blvd\",\n \"postalCode\": \"90001\",\n \"state\": \"California\"\n },\n \"preferredFor\": [\n {\n \"type\": \"SEND\",\n \"date\": \"2025-05-30T16:18:25\"\n }\n ],\n \"accountNumberType\": \"PAN\",\n \"lastFourDigits\": \"1142\",\n \"status\": \"ACTIVE\",\n \"createdOn\": \"2025-05-30T09:59:03\",\n \"lastUpdatedOn\": \"2025-05-30T16:18:25\",\n \"type\": \"CARD\",\n \"externalId\": \"\"\n }\n }\n}" } ] }, { "name": "Update Payment Credential", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{access_token}}", "type": "string" } ] }, "method": "PUT", "header": [], "body": { "mode": "raw", "raw": "{\r\n \"paymentType\": \"CARD\",\r\n \"cardInfo\": {\r\n \"nameOnCard\": \"Alex Miller\",\r\n \"issuerName\": \"Bank A\",\r\n \"cardType\": \"Visa Platinum\",\r\n \"expirationDate\": \"2030-01\",\r\n \"externalId\": \"63421837-d597-4f0f-89e4-930c1a7b9e85\",\r\n \"currencyCode\": \"USD\",\r\n \"preferredFor\": [\r\n {\r\n \"type\": \"RECEIVE\"\r\n }\r\n ],\r\n \"billingAddress\": {\r\n \"country\": \"USA\",\r\n \"addressLine1\": \"1000 Market Street\",\r\n \"addressLine2\": \"Suite 101\",\r\n \"buildingNumber\": \"56\",\r\n \"city\": \"San Francisco\",\r\n \"minorSubdivisionCode\": \"CA\",\r\n \"streetName\": \"12\",\r\n \"postalCode\": \"94105\",\r\n \"state\": \"CA\"\r\n }\r\n },\r\n \"bankInfo\": {\r\n \"accountName\": \"Alex Miller\",\r\n \"accountNumber\": \"411*****455***42\",\r\n \"accountNumberType\": \"DEFAULT\",\r\n \"accountType\": \"SAVING\",\r\n \"bankName\": \"Bank A\",\r\n \"bankCode\": \"173\",\r\n \"branchCode\": \"123456\",\r\n \"bankCodeType\": \"ABA\",\r\n \"bic\": \"AAAABBCC123\",\r\n \"countryCode\": \"USA\",\r\n \"currencyCode\": \"USD\",\r\n \"externalId\": \"63421837-d597-4f0f-89e4-930c1a7b9e85\",\r\n \"address\": {\r\n \"country\": \"USA\",\r\n \"addressLine1\": \"1000 Market Street\",\r\n \"addressLine2\": \"Suite 101\",\r\n \"buildingNumber\": \"56\",\r\n \"city\": \"San Francisco\",\r\n \"minorSubdivisionCode\": \"CA\",\r\n \"streetName\": \"12\",\r\n \"postalCode\": \"94105\",\r\n \"state\": \"CA\"\r\n },\r\n \"preferredFor\": [\r\n {\r\n \"type\": \"RECEIVE\"\r\n }\r\n ]\r\n }\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base-url}}ads/api/v1/paymentCredentials/{{paymentCredentialId}}", "host": [ "{{base-url}}ads" ], "path": [ "api", "v1", "paymentCredentials", "{{paymentCredentialId}}" ] }, "description": "The Update Configuration endpoint enables you to update an existing configuration based on the provided `configId` and request payload. \n\nFor more information, see [Update Configuration](https://cardsapidocs.thredd.com/v2.0/docs/update-configuration#/)." }, "response": [ { "name": "Update Payment Credential", "originalRequest": { "method": "PUT", "header": [], "body": { "mode": "raw", "raw": "{\r\n \"paymentType\": \"CARD\",\r\n \"cardInfo\": {\r\n \"nameOnCard\": \"Alex Miller\",\r\n \"issuerName\": \"Bank A\",\r\n \"cardType\": \"Visa Platinum\",\r\n \"expirationDate\": \"2030-01\",\r\n \"externalId\": \"63421837-d597-4f0f-89e4-930c1a7b9e85\",\r\n \"currencyCode\": \"USD\",\r\n \"preferredFor\": [\r\n {\r\n \"type\": \"RECEIVE\"\r\n }\r\n ],\r\n \"billingAddress\": {\r\n \"country\": \"USA\",\r\n \"addressLine1\": \"1000 Market Street\",\r\n \"addressLine2\": \"Suite 101\",\r\n \"buildingNumber\": \"56\",\r\n \"city\": \"San Francisco\",\r\n \"minorSubdivisionCode\": \"CA\",\r\n \"streetName\": \"12\",\r\n \"postalCode\": \"94105\",\r\n \"state\": \"CA\"\r\n }\r\n },\r\n \"bankInfo\": {\r\n \"accountName\": \"Alex Miller\",\r\n \"accountNumber\": \"411*****455***42\",\r\n \"accountNumberType\": \"DEFAULT\",\r\n \"accountType\": \"SAVING\",\r\n \"bankName\": \"Bank A\",\r\n \"bankCode\": \"173\",\r\n \"branchCode\": \"123456\",\r\n \"bankCodeType\": \"ABA\",\r\n \"bic\": \"AAAABBCC123\",\r\n \"countryCode\": \"USA\",\r\n \"currencyCode\": \"USD\",\r\n \"externalId\": \"63421837-d597-4f0f-89e4-930c1a7b9e85\",\r\n \"address\": {\r\n \"country\": \"USA\",\r\n \"addressLine1\": \"1000 Market Street\",\r\n \"addressLine2\": \"Suite 101\",\r\n \"buildingNumber\": \"56\",\r\n \"city\": \"San Francisco\",\r\n \"minorSubdivisionCode\": \"CA\",\r\n \"streetName\": \"12\",\r\n \"postalCode\": \"94105\",\r\n \"state\": \"CA\"\r\n },\r\n \"preferredFor\": [\r\n {\r\n \"type\": \"RECEIVE\"\r\n }\r\n ]\r\n }\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base-url}}ads/api/v1/paymentCredentials/{{paymentCredentialId}}", "host": [ "{{base-url}}ads" ], "path": [ "api", "v1", "paymentCredentials", "{{paymentCredentialId}}" ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "", "type": "text" } ], "cookie": [], "body": "" } ] }, { "name": "Delete Payment Credential", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{access_token}}", "type": "string" } ] }, "method": "DELETE", "header": [], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base-url}}ads/api/v1/paymentCredentials/{{paymentCredentialId}}", "host": [ "{{base-url}}ads" ], "path": [ "api", "v1", "paymentCredentials", "{{paymentCredentialId}}" ] }, "description": "The Delete Configuration endpoint enables you to delete a configuration, with the configuration identifier specified in the URL. \n\nFor more information, see [Delete Configuration](https://cardsapidocs.thredd.com/v2.0/docs/delete-configuration#/)." }, "response": [] } ] } ], "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "packages": {}, "requests": {}, "exec": [ "" ] } }, { "listen": "test", "script": { "type": "text/javascript", "packages": {}, "requests": {}, "exec": [ "" ] } } ], "variable": [ { "key": "publicToken", "value": "" }, { "key": "client_id", "value": "" }, { "key": "client_secret", "value": "" } ] }