{ "info": { "_postman_id": "b294f094-a5dc-488e-adb7-2d2be932dd6f", "name": "The Helcim API", "description": "This API covers publicly accessible merchant actions", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "lastUpdatedBy": "35240", "uid": "35240-b294f094-a5dc-488e-adb7-2d2be932dd6f" }, "item": [ { "name": "connection-test", "item": [ { "name": "Tests connectivity to the Helcim API", "id": "f55edb51-3a6e-4794-bfd4-d11bf74fa140", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api-token", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/connection-test", "host": [ "{{baseUrl}}" ], "path": [ "connection-test" ] } }, "response": [ { "id": "9d9c61b1-bea1-47e8-ada6-81286d339d3b", "name": "Successful", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "api-token", "value": "" } ], "url": { "raw": "{{baseUrl}}/connection-test", "host": [ "{{baseUrl}}" ], "path": [ "connection-test" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"title\": \"Successful Connection Test\",\n \"example\": {\n \"message\": \"Connection Successful\"\n }\n}", "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-9d9c61b1-bea1-47e8-ada6-81286d339d3b" }, { "id": "f5ca1605-6418-4ba4-a5b3-d07789b0dd56", "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "api-token", "value": "" } ], "url": { "raw": "{{baseUrl}}/connection-test", "host": [ "{{baseUrl}}" ], "path": [ "connection-test" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"title\": \"Invalid Business ID\",\n \"example\": {\n \"errors\": \"invalid businessId\"\n }\n}", "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-f5ca1605-6418-4ba4-a5b3-d07789b0dd56" }, { "id": "5fb68d75-6d2e-4855-8c1d-79bd0b0456e4", "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "api-token", "value": "" } ], "url": { "raw": "{{baseUrl}}/connection-test", "host": [ "{{baseUrl}}" ], "path": [ "connection-test" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"title\": \"No credentials included\",\n \"description\": \"No API token was included in the request\"\n}", "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-5fb68d75-6d2e-4855-8c1d-79bd0b0456e4" }, { "id": "8a7687c6-4a5a-4916-a962-fcd5556a2718", "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "api-token", "value": "" } ], "url": { "raw": "{{baseUrl}}/connection-test", "host": [ "{{baseUrl}}" ], "path": [ "connection-test" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"title\": \"Forbidden\",\n \"description\": \"Invalid API token was included in the request\"\n}", "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-8a7687c6-4a5a-4916-a962-fcd5556a2718" } ], "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-f55edb51-3a6e-4794-bfd4-d11bf74fa140" } ], "id": "67134328-08d7-4fe4-bfd3-aea9d0247d5e", "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-67134328-08d7-4fe4-bfd3-aea9d0247d5e" }, { "name": "payment", "item": [ { "name": "purchase", "item": [ { "name": "Process a Purchase Transaction", "id": "b88db85d-4c80-41f7-b24e-367b5e8c0e6d", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api-token", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "POST", "header": [ { "description": "(Required) A UUID-formatted idempotency key. Accepted format is 25-36 alphanumeric characters (including '-' and '_').", "key": "idempotency-key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"amount\": \"\",\n \"cardData\": {\n \"cardNumber\": \"\",\n \"cardExpiry\": \"\",\n \"cardCVV\": \"\",\n \"cardHolderName\": \"\"\n },\n \"currency\": \"\",\n \"ipAddress\": \"\",\n \"ecommerce\": \"\",\n \"terminalId\": \"\",\n \"customerCode\": \"\",\n \"invoiceNumber\": \"\",\n \"billingAddress\": {\n \"name\": \"\",\n \"street1\": \"\",\n \"postalCode\": \"\",\n \"street2\": \"\",\n \"city\": \"\",\n \"province\": \"\",\n \"country\": \"\",\n \"phone\": \"\",\n \"email\": \"\"\n },\n \"invoice\": {\n \"invoiceNumber\": \"\",\n \"notes\": \"\",\n \"tipAmount\": \"\",\n \"shipping\": {\n \"amount\": \"\",\n \"details\": \"\",\n \"address\": {\n \"name\": \"\",\n \"street1\": \"\",\n \"postalCode\": \"\",\n \"street2\": \"\",\n \"city\": \"\",\n \"province\": \"\",\n \"country\": \"\",\n \"phone\": \"\",\n \"email\": \"\"\n }\n },\n \"pickup\": {\n \"date\": \"\",\n \"name\": \"\"\n },\n \"tax\": {\n \"amount\": \"\",\n \"details\": \"\"\n },\n \"discount\": {\n \"amount\": \"\",\n \"details\": \"\"\n },\n \"lineItems\": [\n {\n \"description\": \"\",\n \"quantity\": \"\",\n \"price\": \"\",\n \"taxAmount\": \"\",\n \"discountAmount\": \"\",\n \"sku\": \"\"\n },\n {\n \"description\": \"\",\n \"quantity\": \"\",\n \"price\": \"\",\n \"taxAmount\": \"\",\n \"discountAmount\": \"\",\n \"sku\": \"\"\n }\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/payment/purchase", "host": [ "{{baseUrl}}" ], "path": [ "payment", "purchase" ] } }, "response": [ { "id": "7b6d806f-e17d-4439-8d91-bbffa265fb3a", "name": "Successful", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) A UUID-formatted idempotency key. Accepted format is 25-36 alphanumeric characters (including '-' and '_').", "key": "idempotency-key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "api-token", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"amount\": \"\",\n \"cardData\": {\n \"cardNumber\": \"\",\n \"cardExpiry\": \"\",\n \"cardCVV\": \"\",\n \"cardHolderName\": \"\"\n },\n \"currency\": \"\",\n \"ipAddress\": \"\",\n \"ecommerce\": \"\",\n \"terminalId\": \"\",\n \"customerCode\": \"\",\n \"invoiceNumber\": \"\",\n \"billingAddress\": {\n \"name\": \"\",\n \"street1\": \"\",\n \"postalCode\": \"\",\n \"street2\": \"\",\n \"city\": \"\",\n \"province\": \"\",\n \"country\": \"\",\n \"phone\": \"\",\n \"email\": \"\"\n },\n \"invoice\": {\n \"invoiceNumber\": \"\",\n \"notes\": \"\",\n \"tipAmount\": \"\",\n \"shipping\": {\n \"amount\": \"\",\n \"details\": \"\",\n \"address\": {\n \"name\": \"\",\n \"street1\": \"\",\n \"postalCode\": \"\",\n \"street2\": \"\",\n \"city\": \"\",\n \"province\": \"\",\n \"country\": \"\",\n \"phone\": \"\",\n \"email\": \"\"\n }\n },\n \"pickup\": {\n \"date\": \"\",\n \"name\": \"\"\n },\n \"tax\": {\n \"amount\": \"\",\n \"details\": \"\"\n },\n \"discount\": {\n \"amount\": \"\",\n \"details\": \"\"\n },\n \"lineItems\": [\n {\n \"description\": \"\",\n \"quantity\": \"\",\n \"price\": \"\",\n \"taxAmount\": \"\",\n \"discountAmount\": \"\",\n \"sku\": \"\"\n },\n {\n \"description\": \"\",\n \"quantity\": \"\",\n \"price\": \"\",\n \"taxAmount\": \"\",\n \"discountAmount\": \"\",\n \"sku\": \"\"\n }\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/payment/purchase", "host": [ "{{baseUrl}}" ], "path": [ "payment", "purchase" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"transactionId\": \"\",\n \"cardBatchId\": \"\",\n \"dateCreated\": \"\",\n \"status\": \"\",\n \"user\": \"\",\n \"type\": \"\",\n \"amount\": \"\",\n \"currency\": \"\",\n \"avsResponse\": \"\",\n \"cvvResponse\": \"\",\n \"cardType\": \"\",\n \"approvalCode\": \"\",\n \"cardToken\": \"\",\n \"cardNumber\": \"\",\n \"cardHolderName\": \"\",\n \"customerCode\": \"\",\n \"invoiceNumber\": \"\",\n \"warning\": \"\"\n}", "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-7b6d806f-e17d-4439-8d91-bbffa265fb3a" }, { "id": "9b463ce9-ac93-4b41-8130-7685bff68325", "name": "Failed", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) A UUID-formatted idempotency key. Accepted format is 25-36 alphanumeric characters (including '-' and '_').", "key": "idempotency-key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "api-token", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"amount\": \"\",\n \"cardData\": {\n \"cardNumber\": \"\",\n \"cardExpiry\": \"\",\n \"cardCVV\": \"\",\n \"cardHolderName\": \"\"\n },\n \"currency\": \"\",\n \"ipAddress\": \"\",\n \"ecommerce\": \"\",\n \"terminalId\": \"\",\n \"customerCode\": \"\",\n \"invoiceNumber\": \"\",\n \"billingAddress\": {\n \"name\": \"\",\n \"street1\": \"\",\n \"postalCode\": \"\",\n \"street2\": \"\",\n \"city\": \"\",\n \"province\": \"\",\n \"country\": \"\",\n \"phone\": \"\",\n \"email\": \"\"\n },\n \"invoice\": {\n \"invoiceNumber\": \"\",\n \"notes\": \"\",\n \"tipAmount\": \"\",\n \"shipping\": {\n \"amount\": \"\",\n \"details\": \"\",\n \"address\": {\n \"name\": \"\",\n \"street1\": \"\",\n \"postalCode\": \"\",\n \"street2\": \"\",\n \"city\": \"\",\n \"province\": \"\",\n \"country\": \"\",\n \"phone\": \"\",\n \"email\": \"\"\n }\n },\n \"pickup\": {\n \"date\": \"\",\n \"name\": \"\"\n },\n \"tax\": {\n \"amount\": \"\",\n \"details\": \"\"\n },\n \"discount\": {\n \"amount\": \"\",\n \"details\": \"\"\n },\n \"lineItems\": [\n {\n \"description\": \"\",\n \"quantity\": \"\",\n \"price\": \"\",\n \"taxAmount\": \"\",\n \"discountAmount\": \"\",\n \"sku\": \"\"\n },\n {\n \"description\": \"\",\n \"quantity\": \"\",\n \"price\": \"\",\n \"taxAmount\": \"\",\n \"discountAmount\": \"\",\n \"sku\": \"\"\n }\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/payment/purchase", "host": [ "{{baseUrl}}" ], "path": [ "payment", "purchase" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-9b463ce9-ac93-4b41-8130-7685bff68325" } ], "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-b88db85d-4c80-41f7-b24e-367b5e8c0e6d" } ], "id": "ee29562f-f674-41e0-8c7c-3d5bd5d9f3b5", "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-ee29562f-f674-41e0-8c7c-3d5bd5d9f3b5" }, { "name": "preauth", "item": [ { "name": "Process a Preauth Transaction", "id": "f304f71d-e763-468f-aa05-966ab79a2845", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api-token", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "POST", "header": [ { "description": "(Required) A UUID-formatted idempotency key. Accepted format is 25-36 alphanumeric characters (including '-' and '_').", "key": "idempotency-key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"amount\": \"\",\n \"cardData\": {\n \"cardNumber\": \"\",\n \"cardExpiry\": \"\",\n \"cardCVV\": \"\",\n \"cardHolderName\": \"\"\n },\n \"currency\": \"\",\n \"ipAddress\": \"\",\n \"ecommerce\": \"\",\n \"terminalId\": \"\",\n \"customerCode\": \"\",\n \"invoiceNumber\": \"\",\n \"billingAddress\": {\n \"name\": \"\",\n \"street1\": \"\",\n \"postalCode\": \"\",\n \"street2\": \"\",\n \"city\": \"\",\n \"province\": \"\",\n \"country\": \"\",\n \"phone\": \"\",\n \"email\": \"\"\n },\n \"invoice\": {\n \"invoiceNumber\": \"\",\n \"notes\": \"\",\n \"shipping\": {\n \"amount\": \"\",\n \"details\": \"\",\n \"address\": {\n \"name\": \"\",\n \"street1\": \"\",\n \"postalCode\": \"\",\n \"street2\": \"\",\n \"city\": \"\",\n \"province\": \"\",\n \"country\": \"\",\n \"phone\": \"\",\n \"email\": \"\"\n }\n },\n \"pickup\": {\n \"date\": \"\",\n \"name\": \"\"\n },\n \"tax\": {\n \"amount\": \"\",\n \"details\": \"\"\n },\n \"discount\": {\n \"amount\": \"\",\n \"details\": \"\"\n },\n \"lineItems\": [\n {\n \"description\": \"\",\n \"quantity\": \"\",\n \"price\": \"\",\n \"taxAmount\": \"\",\n \"discountAmount\": \"\",\n \"sku\": \"\"\n },\n {\n \"description\": \"\",\n \"quantity\": \"\",\n \"price\": \"\",\n \"taxAmount\": \"\",\n \"discountAmount\": \"\",\n \"sku\": \"\"\n }\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/payment/preauth", "host": [ "{{baseUrl}}" ], "path": [ "payment", "preauth" ] } }, "response": [ { "id": "715e1bfe-859d-476f-b567-121916ce46ad", "name": "Successful", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) A UUID-formatted idempotency key. Accepted format is 25-36 alphanumeric characters (including '-' and '_').", "key": "idempotency-key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "api-token", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"amount\": \"\",\n \"cardData\": {\n \"cardNumber\": \"\",\n \"cardExpiry\": \"\",\n \"cardCVV\": \"\",\n \"cardHolderName\": \"\"\n },\n \"currency\": \"\",\n \"ipAddress\": \"\",\n \"ecommerce\": \"\",\n \"terminalId\": \"\",\n \"customerCode\": \"\",\n \"invoiceNumber\": \"\",\n \"billingAddress\": {\n \"name\": \"\",\n \"street1\": \"\",\n \"postalCode\": \"\",\n \"street2\": \"\",\n \"city\": \"\",\n \"province\": \"\",\n \"country\": \"\",\n \"phone\": \"\",\n \"email\": \"\"\n },\n \"invoice\": {\n \"invoiceNumber\": \"\",\n \"notes\": \"\",\n \"shipping\": {\n \"amount\": \"\",\n \"details\": \"\",\n \"address\": {\n \"name\": \"\",\n \"street1\": \"\",\n \"postalCode\": \"\",\n \"street2\": \"\",\n \"city\": \"\",\n \"province\": \"\",\n \"country\": \"\",\n \"phone\": \"\",\n \"email\": \"\"\n }\n },\n \"pickup\": {\n \"date\": \"\",\n \"name\": \"\"\n },\n \"tax\": {\n \"amount\": \"\",\n \"details\": \"\"\n },\n \"discount\": {\n \"amount\": \"\",\n \"details\": \"\"\n },\n \"lineItems\": [\n {\n \"description\": \"\",\n \"quantity\": \"\",\n \"price\": \"\",\n \"taxAmount\": \"\",\n \"discountAmount\": \"\",\n \"sku\": \"\"\n },\n {\n \"description\": \"\",\n \"quantity\": \"\",\n \"price\": \"\",\n \"taxAmount\": \"\",\n \"discountAmount\": \"\",\n \"sku\": \"\"\n }\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/payment/preauth", "host": [ "{{baseUrl}}" ], "path": [ "payment", "preauth" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"transactionId\": \"\",\n \"cardBatchId\": \"\",\n \"dateCreated\": \"\",\n \"status\": \"\",\n \"user\": \"\",\n \"type\": \"\",\n \"amount\": \"\",\n \"currency\": \"\",\n \"avsResponse\": \"\",\n \"cvvResponse\": \"\",\n \"cardType\": \"\",\n \"approvalCode\": \"\",\n \"cardToken\": \"\",\n \"cardNumber\": \"\",\n \"cardHolderName\": \"\",\n \"customerCode\": \"\",\n \"invoiceNumber\": \"\",\n \"warning\": \"\"\n}", "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-715e1bfe-859d-476f-b567-121916ce46ad" }, { "id": "05b4da24-f2d3-4fb1-af77-5b4a500c77a4", "name": "Failed", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) A UUID-formatted idempotency key. Accepted format is 25-36 alphanumeric characters (including '-' and '_').", "key": "idempotency-key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "api-token", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"amount\": \"\",\n \"cardData\": {\n \"cardNumber\": \"\",\n \"cardExpiry\": \"\",\n \"cardCVV\": \"\",\n \"cardHolderName\": \"\"\n },\n \"currency\": \"\",\n \"ipAddress\": \"\",\n \"ecommerce\": \"\",\n \"terminalId\": \"\",\n \"customerCode\": \"\",\n \"invoiceNumber\": \"\",\n \"billingAddress\": {\n \"name\": \"\",\n \"street1\": \"\",\n \"postalCode\": \"\",\n \"street2\": \"\",\n \"city\": \"\",\n \"province\": \"\",\n \"country\": \"\",\n \"phone\": \"\",\n \"email\": \"\"\n },\n \"invoice\": {\n \"invoiceNumber\": \"\",\n \"notes\": \"\",\n \"shipping\": {\n \"amount\": \"\",\n \"details\": \"\",\n \"address\": {\n \"name\": \"\",\n \"street1\": \"\",\n \"postalCode\": \"\",\n \"street2\": \"\",\n \"city\": \"\",\n \"province\": \"\",\n \"country\": \"\",\n \"phone\": \"\",\n \"email\": \"\"\n }\n },\n \"pickup\": {\n \"date\": \"\",\n \"name\": \"\"\n },\n \"tax\": {\n \"amount\": \"\",\n \"details\": \"\"\n },\n \"discount\": {\n \"amount\": \"\",\n \"details\": \"\"\n },\n \"lineItems\": [\n {\n \"description\": \"\",\n \"quantity\": \"\",\n \"price\": \"\",\n \"taxAmount\": \"\",\n \"discountAmount\": \"\",\n \"sku\": \"\"\n },\n {\n \"description\": \"\",\n \"quantity\": \"\",\n \"price\": \"\",\n \"taxAmount\": \"\",\n \"discountAmount\": \"\",\n \"sku\": \"\"\n }\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/payment/preauth", "host": [ "{{baseUrl}}" ], "path": [ "payment", "preauth" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-05b4da24-f2d3-4fb1-af77-5b4a500c77a4" } ], "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-f304f71d-e763-468f-aa05-966ab79a2845" } ], "id": "925fb347-471f-464b-878e-4c6f2dead168", "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-925fb347-471f-464b-878e-4c6f2dead168" }, { "name": "capture", "item": [ { "name": "Process a Capture Transaction", "id": "0ad999a9-829b-44f4-8611-c552ad3c3cfb", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api-token", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "POST", "header": [ { "description": "(Required) A UUID-formatted idempotency key. Accepted format is 25-36 alphanumeric characters (including '-' and '_').", "key": "idempotency-key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"preAuthTransactionId\": \"\",\n \"amount\": \"\",\n \"ipAddress\": \"\",\n \"ecommerce\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/payment/capture", "host": [ "{{baseUrl}}" ], "path": [ "payment", "capture" ] } }, "response": [ { "id": "39a154d3-263b-4de5-83dc-299dedb2ebae", "name": "Successful", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) A UUID-formatted idempotency key. Accepted format is 25-36 alphanumeric characters (including '-' and '_').", "key": "idempotency-key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "api-token", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"preAuthTransactionId\": \"\",\n \"amount\": \"\",\n \"ipAddress\": \"\",\n \"ecommerce\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/payment/capture", "host": [ "{{baseUrl}}" ], "path": [ "payment", "capture" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"transactionId\": \"\",\n \"cardBatchId\": \"\",\n \"dateCreated\": \"\",\n \"status\": \"\",\n \"user\": \"\",\n \"type\": \"\",\n \"amount\": \"\",\n \"currency\": \"\",\n \"avsResponse\": \"\",\n \"cvvResponse\": \"\",\n \"cardType\": \"\",\n \"approvalCode\": \"\",\n \"cardToken\": \"\",\n \"cardNumber\": \"\",\n \"cardHolderName\": \"\",\n \"customerCode\": \"\",\n \"invoiceNumber\": \"\",\n \"warning\": \"\"\n}", "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-39a154d3-263b-4de5-83dc-299dedb2ebae" }, { "id": "1cb322fd-4fd7-4566-ac5f-326fe7b07fac", "name": "Failed", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) A UUID-formatted idempotency key. Accepted format is 25-36 alphanumeric characters (including '-' and '_').", "key": "idempotency-key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "api-token", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"preAuthTransactionId\": \"\",\n \"amount\": \"\",\n \"ipAddress\": \"\",\n \"ecommerce\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/payment/capture", "host": [ "{{baseUrl}}" ], "path": [ "payment", "capture" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-1cb322fd-4fd7-4566-ac5f-326fe7b07fac" } ], "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-0ad999a9-829b-44f4-8611-c552ad3c3cfb" } ], "id": "a21ca649-d1a1-48f8-bfa6-f88acc936be8", "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-a21ca649-d1a1-48f8-bfa6-f88acc936be8" }, { "name": "verify", "item": [ { "name": "Process a Verify Transaction", "id": "bd5465f9-94bf-4abd-8fe5-871e3fde471c", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api-token", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "POST", "header": [ { "description": "(Required) A UUID-formatted idempotency key. Accepted format is 25-36 alphanumeric characters (including '-' and '_').", "key": "idempotency-key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"amount\": \"\",\n \"currency\": \"\",\n \"cardData\": {\n \"cardNumber\": \"\",\n \"cardExpiry\": \"\",\n \"cardCVV\": \"\",\n \"cardHolderName\": \"\"\n },\n \"billingAddress\": {\n \"name\": \"\",\n \"street1\": \"\",\n \"postalCode\": \"\",\n \"street2\": \"\",\n \"city\": \"\",\n \"province\": \"\",\n \"country\": \"\",\n \"phone\": \"\",\n \"email\": \"\"\n },\n \"ipAddress\": \"\",\n \"ecommerce\": \"\",\n \"customerCode\": \"\",\n \"invoiceNumber\": \"\",\n \"invoice\": {\n \"invoiceNumber\": \"\",\n \"notes\": \"\",\n \"shipping\": {\n \"amount\": \"\",\n \"details\": \"\",\n \"address\": {\n \"name\": \"\",\n \"street1\": \"\",\n \"postalCode\": \"\",\n \"street2\": \"\",\n \"city\": \"\",\n \"province\": \"\",\n \"country\": \"\",\n \"phone\": \"\",\n \"email\": \"\"\n }\n },\n \"pickup\": {\n \"date\": \"\",\n \"name\": \"\"\n },\n \"tax\": {\n \"amount\": \"\",\n \"details\": \"\"\n },\n \"discount\": {\n \"amount\": \"\",\n \"details\": \"\"\n },\n \"lineItems\": [\n {\n \"description\": \"\",\n \"quantity\": \"\",\n \"price\": \"\",\n \"taxAmount\": \"\",\n \"discountAmount\": \"\",\n \"sku\": \"\"\n },\n {\n \"description\": \"\",\n \"quantity\": \"\",\n \"price\": \"\",\n \"taxAmount\": \"\",\n \"discountAmount\": \"\",\n \"sku\": \"\"\n }\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/payment/verify", "host": [ "{{baseUrl}}" ], "path": [ "payment", "verify" ] } }, "response": [ { "id": "9bf53a0a-42ca-46d2-9609-8377fc97ce10", "name": "Successful", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) A UUID-formatted idempotency key. Accepted format is 25-36 alphanumeric characters (including '-' and '_').", "key": "idempotency-key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "api-token", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"amount\": \"\",\n \"currency\": \"\",\n \"cardData\": {\n \"cardNumber\": \"\",\n \"cardExpiry\": \"\",\n \"cardCVV\": \"\",\n \"cardHolderName\": \"\"\n },\n \"billingAddress\": {\n \"name\": \"\",\n \"street1\": \"\",\n \"postalCode\": \"\",\n \"street2\": \"\",\n \"city\": \"\",\n \"province\": \"\",\n \"country\": \"\",\n \"phone\": \"\",\n \"email\": \"\"\n },\n \"ipAddress\": \"\",\n \"ecommerce\": \"\",\n \"customerCode\": \"\",\n \"invoiceNumber\": \"\",\n \"invoice\": {\n \"invoiceNumber\": \"\",\n \"notes\": \"\",\n \"shipping\": {\n \"amount\": \"\",\n \"details\": \"\",\n \"address\": {\n \"name\": \"\",\n \"street1\": \"\",\n \"postalCode\": \"\",\n \"street2\": \"\",\n \"city\": \"\",\n \"province\": \"\",\n \"country\": \"\",\n \"phone\": \"\",\n \"email\": \"\"\n }\n },\n \"pickup\": {\n \"date\": \"\",\n \"name\": \"\"\n },\n \"tax\": {\n \"amount\": \"\",\n \"details\": \"\"\n },\n \"discount\": {\n \"amount\": \"\",\n \"details\": \"\"\n },\n \"lineItems\": [\n {\n \"description\": \"\",\n \"quantity\": \"\",\n \"price\": \"\",\n \"taxAmount\": \"\",\n \"discountAmount\": \"\",\n \"sku\": \"\"\n },\n {\n \"description\": \"\",\n \"quantity\": \"\",\n \"price\": \"\",\n \"taxAmount\": \"\",\n \"discountAmount\": \"\",\n \"sku\": \"\"\n }\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/payment/verify", "host": [ "{{baseUrl}}" ], "path": [ "payment", "verify" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"transactionId\": \"\",\n \"cardBatchId\": \"\",\n \"dateCreated\": \"\",\n \"status\": \"\",\n \"user\": \"\",\n \"type\": \"\",\n \"amount\": \"\",\n \"currency\": \"\",\n \"avsResponse\": \"\",\n \"cvvResponse\": \"\",\n \"cardType\": \"\",\n \"approvalCode\": \"\",\n \"cardToken\": \"\",\n \"cardNumber\": \"\",\n \"cardHolderName\": \"\",\n \"customerCode\": \"\",\n \"invoiceNumber\": \"\",\n \"warning\": \"\"\n}", "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-9bf53a0a-42ca-46d2-9609-8377fc97ce10" }, { "id": "2c8f3011-a239-4e46-8d3d-d34ede5ccf17", "name": "Failed", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) A UUID-formatted idempotency key. Accepted format is 25-36 alphanumeric characters (including '-' and '_').", "key": "idempotency-key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "api-token", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"amount\": \"\",\n \"currency\": \"\",\n \"cardData\": {\n \"cardNumber\": \"\",\n \"cardExpiry\": \"\",\n \"cardCVV\": \"\",\n \"cardHolderName\": \"\"\n },\n \"billingAddress\": {\n \"name\": \"\",\n \"street1\": \"\",\n \"postalCode\": \"\",\n \"street2\": \"\",\n \"city\": \"\",\n \"province\": \"\",\n \"country\": \"\",\n \"phone\": \"\",\n \"email\": \"\"\n },\n \"ipAddress\": \"\",\n \"ecommerce\": \"\",\n \"customerCode\": \"\",\n \"invoiceNumber\": \"\",\n \"invoice\": {\n \"invoiceNumber\": \"\",\n \"notes\": \"\",\n \"shipping\": {\n \"amount\": \"\",\n \"details\": \"\",\n \"address\": {\n \"name\": \"\",\n \"street1\": \"\",\n \"postalCode\": \"\",\n \"street2\": \"\",\n \"city\": \"\",\n \"province\": \"\",\n \"country\": \"\",\n \"phone\": \"\",\n \"email\": \"\"\n }\n },\n \"pickup\": {\n \"date\": \"\",\n \"name\": \"\"\n },\n \"tax\": {\n \"amount\": \"\",\n \"details\": \"\"\n },\n \"discount\": {\n \"amount\": \"\",\n \"details\": \"\"\n },\n \"lineItems\": [\n {\n \"description\": \"\",\n \"quantity\": \"\",\n \"price\": \"\",\n \"taxAmount\": \"\",\n \"discountAmount\": \"\",\n \"sku\": \"\"\n },\n {\n \"description\": \"\",\n \"quantity\": \"\",\n \"price\": \"\",\n \"taxAmount\": \"\",\n \"discountAmount\": \"\",\n \"sku\": \"\"\n }\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/payment/verify", "host": [ "{{baseUrl}}" ], "path": [ "payment", "verify" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-2c8f3011-a239-4e46-8d3d-d34ede5ccf17" } ], "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-bd5465f9-94bf-4abd-8fe5-871e3fde471c" } ], "id": "8d51b1f8-84a6-4dcc-b771-acfb43cc679a", "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-8d51b1f8-84a6-4dcc-b771-acfb43cc679a" }, { "name": "refund", "item": [ { "name": "Process a Refund Transaction", "id": "38aa408a-25f1-45a1-8439-285ea1f3f31e", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api-token", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "POST", "header": [ { "description": "(Required) A UUID-formatted idempotency key. Accepted format is 25-36 alphanumeric characters (including '-' and '_').", "key": "idempotency-key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"originalTransactionId\": \"\",\n \"amount\": \"\",\n \"ipAddress\": \"\",\n \"ecommerce\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/payment/refund", "host": [ "{{baseUrl}}" ], "path": [ "payment", "refund" ] } }, "response": [ { "id": "4874db5a-19ae-4a3c-a962-19505259ff89", "name": "Successful", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) A UUID-formatted idempotency key. Accepted format is 25-36 alphanumeric characters (including '-' and '_').", "key": "idempotency-key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "api-token", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"originalTransactionId\": \"\",\n \"amount\": \"\",\n \"ipAddress\": \"\",\n \"ecommerce\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/payment/refund", "host": [ "{{baseUrl}}" ], "path": [ "payment", "refund" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"transactionId\": \"\",\n \"cardBatchId\": \"\",\n \"dateCreated\": \"\",\n \"status\": \"\",\n \"user\": \"\",\n \"type\": \"\",\n \"amount\": \"\",\n \"currency\": \"\",\n \"avsResponse\": \"\",\n \"cvvResponse\": \"\",\n \"cardType\": \"\",\n \"approvalCode\": \"\",\n \"cardToken\": \"\",\n \"cardNumber\": \"\",\n \"cardHolderName\": \"\",\n \"customerCode\": \"\",\n \"invoiceNumber\": \"\",\n \"warning\": \"\"\n}", "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-4874db5a-19ae-4a3c-a962-19505259ff89" }, { "id": "7de00e68-4e4c-4b10-87d4-6946732946d1", "name": "Failed", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) A UUID-formatted idempotency key. Accepted format is 25-36 alphanumeric characters (including '-' and '_').", "key": "idempotency-key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "api-token", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"originalTransactionId\": \"\",\n \"amount\": \"\",\n \"ipAddress\": \"\",\n \"ecommerce\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/payment/refund", "host": [ "{{baseUrl}}" ], "path": [ "payment", "refund" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-7de00e68-4e4c-4b10-87d4-6946732946d1" } ], "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-38aa408a-25f1-45a1-8439-285ea1f3f31e" } ], "id": "21ffd341-784d-41a3-bb82-44846d4ad864", "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-21ffd341-784d-41a3-bb82-44846d4ad864" }, { "name": "reverse", "item": [ { "name": "Process a Reverse Transaction", "id": "ec16a61e-6fb2-443b-85d5-c974a8bb3a42", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api-token", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "POST", "header": [ { "description": "(Required) A UUID-formatted idempotency key. Accepted format is 25-36 alphanumeric characters (including '-' and '_').", "key": "idempotency-key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"cardTransactionId\": \"\",\n \"ipAddress\": \"\",\n \"ecommerce\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/payment/reverse", "host": [ "{{baseUrl}}" ], "path": [ "payment", "reverse" ] } }, "response": [ { "id": "4fb8cfc6-93fd-430f-a7fe-562fa6456afe", "name": "Successful", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) A UUID-formatted idempotency key. Accepted format is 25-36 alphanumeric characters (including '-' and '_').", "key": "idempotency-key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "api-token", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"cardTransactionId\": \"\",\n \"ipAddress\": \"\",\n \"ecommerce\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/payment/reverse", "host": [ "{{baseUrl}}" ], "path": [ "payment", "reverse" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"transactionId\": \"\",\n \"cardBatchId\": \"\",\n \"dateCreated\": \"\",\n \"status\": \"\",\n \"user\": \"\",\n \"type\": \"\",\n \"amount\": \"\",\n \"currency\": \"\",\n \"avsResponse\": \"\",\n \"cvvResponse\": \"\",\n \"cardType\": \"\",\n \"approvalCode\": \"\",\n \"cardToken\": \"\",\n \"cardNumber\": \"\",\n \"cardHolderName\": \"\",\n \"customerCode\": \"\",\n \"invoiceNumber\": \"\",\n \"warning\": \"\"\n}", "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-4fb8cfc6-93fd-430f-a7fe-562fa6456afe" }, { "id": "a93d51f1-61f3-44e2-a576-b23e07420b81", "name": "Failed", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) A UUID-formatted idempotency key. Accepted format is 25-36 alphanumeric characters (including '-' and '_').", "key": "idempotency-key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "api-token", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"cardTransactionId\": \"\",\n \"ipAddress\": \"\",\n \"ecommerce\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/payment/reverse", "host": [ "{{baseUrl}}" ], "path": [ "payment", "reverse" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-a93d51f1-61f3-44e2-a576-b23e07420b81" } ], "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-ec16a61e-6fb2-443b-85d5-c974a8bb3a42" } ], "id": "1889e591-3b99-49c0-8643-c12a0a0e6532", "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-1889e591-3b99-49c0-8643-c12a0a0e6532" }, { "name": "withdraw", "item": [ { "name": "Process a Withdraw Transaction", "id": "cabebb8d-1d0a-4f33-8a9f-77d84538effd", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api-token", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "POST", "header": [ { "description": "(Required) A UUID-formatted idempotency key. Accepted format is 25-36 alphanumeric characters (including '-' and '_').", "key": "idempotency-key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"amount\": \"\",\n \"bankData\": {\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"companyName\": \"\",\n \"bankAccountNumber\": \"\",\n \"accountType\": \"\",\n \"accountCorporate\": \"\",\n \"streetAddress\": \"\",\n \"city\": \"\",\n \"country\": \"\",\n \"province\": \"\",\n \"postalCode\": \"\",\n \"bankIdNumber\": \"\",\n \"transitNumber\": \"\",\n \"routingNumber\": \"\",\n \"padAgreement\": \"\"\n },\n \"cardData\": {\n \"cardNumber\": \"\",\n \"cardExpiry\": \"\",\n \"cardCVV\": \"\",\n \"cardHolderName\": \"\"\n },\n \"currency\": \"\",\n \"ipAddress\": \"\",\n \"ecommerce\": \"\",\n \"terminalId\": \"\",\n \"customerCode\": \"\",\n \"invoiceNumber\": \"\",\n \"billingAddress\": {\n \"name\": \"\",\n \"street1\": \"\",\n \"postalCode\": \"\",\n \"street2\": \"\",\n \"city\": \"\",\n \"province\": \"\",\n \"country\": \"\",\n \"phone\": \"\",\n \"email\": \"\"\n },\n \"invoice\": {\n \"invoiceNumber\": \"\",\n \"notes\": \"\",\n \"tipAmount\": \"\",\n \"shipping\": {\n \"amount\": \"\",\n \"details\": \"\",\n \"address\": {\n \"name\": \"\",\n \"street1\": \"\",\n \"postalCode\": \"\",\n \"street2\": \"\",\n \"city\": \"\",\n \"province\": \"\",\n \"country\": \"\",\n \"phone\": \"\",\n \"email\": \"\"\n }\n },\n \"pickup\": {\n \"date\": \"\",\n \"name\": \"\"\n },\n \"tax\": {\n \"amount\": \"\",\n \"details\": \"\"\n },\n \"discount\": {\n \"amount\": \"\",\n \"details\": \"\"\n },\n \"lineItems\": [\n {\n \"description\": \"\",\n \"quantity\": \"\",\n \"price\": \"\",\n \"taxAmount\": \"\",\n \"discountAmount\": \"\",\n \"sku\": \"\"\n },\n {\n \"description\": \"\",\n \"quantity\": \"\",\n \"price\": \"\",\n \"taxAmount\": \"\",\n \"discountAmount\": \"\",\n \"sku\": \"\"\n }\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/payment/withdraw", "host": [ "{{baseUrl}}" ], "path": [ "payment", "withdraw" ] } }, "response": [ { "id": "6cdc4e50-f38c-430c-b4f6-302195cf6afc", "name": "Successful", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) A UUID-formatted idempotency key. Accepted format is 25-36 alphanumeric characters (including '-' and '_').", "key": "idempotency-key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "api-token", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"amount\": \"\",\n \"bankData\": {\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"companyName\": \"\",\n \"bankAccountNumber\": \"\",\n \"accountType\": \"\",\n \"accountCorporate\": \"\",\n \"streetAddress\": \"\",\n \"city\": \"\",\n \"country\": \"\",\n \"province\": \"\",\n \"postalCode\": \"\",\n \"bankIdNumber\": \"\",\n \"transitNumber\": \"\",\n \"routingNumber\": \"\",\n \"padAgreement\": \"\"\n },\n \"cardData\": {\n \"cardNumber\": \"\",\n \"cardExpiry\": \"\",\n \"cardCVV\": \"\",\n \"cardHolderName\": \"\"\n },\n \"currency\": \"\",\n \"ipAddress\": \"\",\n \"ecommerce\": \"\",\n \"terminalId\": \"\",\n \"customerCode\": \"\",\n \"invoiceNumber\": \"\",\n \"billingAddress\": {\n \"name\": \"\",\n \"street1\": \"\",\n \"postalCode\": \"\",\n \"street2\": \"\",\n \"city\": \"\",\n \"province\": \"\",\n \"country\": \"\",\n \"phone\": \"\",\n \"email\": \"\"\n },\n \"invoice\": {\n \"invoiceNumber\": \"\",\n \"notes\": \"\",\n \"tipAmount\": \"\",\n \"shipping\": {\n \"amount\": \"\",\n \"details\": \"\",\n \"address\": {\n \"name\": \"\",\n \"street1\": \"\",\n \"postalCode\": \"\",\n \"street2\": \"\",\n \"city\": \"\",\n \"province\": \"\",\n \"country\": \"\",\n \"phone\": \"\",\n \"email\": \"\"\n }\n },\n \"pickup\": {\n \"date\": \"\",\n \"name\": \"\"\n },\n \"tax\": {\n \"amount\": \"\",\n \"details\": \"\"\n },\n \"discount\": {\n \"amount\": \"\",\n \"details\": \"\"\n },\n \"lineItems\": [\n {\n \"description\": \"\",\n \"quantity\": \"\",\n \"price\": \"\",\n \"taxAmount\": \"\",\n \"discountAmount\": \"\",\n \"sku\": \"\"\n },\n {\n \"description\": \"\",\n \"quantity\": \"\",\n \"price\": \"\",\n \"taxAmount\": \"\",\n \"discountAmount\": \"\",\n \"sku\": \"\"\n }\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/payment/withdraw", "host": [ "{{baseUrl}}" ], "path": [ "payment", "withdraw" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"transactionId\": \"\",\n \"batchId\": \"\",\n \"dateCreated\": \"\",\n \"statusAuth\": \"\",\n \"statusClearing\": \"\",\n \"type\": \"\",\n \"amount\": \"\",\n \"currency\": \"\",\n \"approvalCode\": \"\",\n \"bankAccountNumber\": \"\",\n \"bankToken\": \"\",\n \"invoiceNumber\": \"\"\n}", "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-6cdc4e50-f38c-430c-b4f6-302195cf6afc" }, { "id": "8e16ca4f-13ab-4cf3-845c-9cc8e96828be", "name": "Failed", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) A UUID-formatted idempotency key. Accepted format is 25-36 alphanumeric characters (including '-' and '_').", "key": "idempotency-key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "api-token", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"amount\": \"\",\n \"bankData\": {\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"companyName\": \"\",\n \"bankAccountNumber\": \"\",\n \"accountType\": \"\",\n \"accountCorporate\": \"\",\n \"streetAddress\": \"\",\n \"city\": \"\",\n \"country\": \"\",\n \"province\": \"\",\n \"postalCode\": \"\",\n \"bankIdNumber\": \"\",\n \"transitNumber\": \"\",\n \"routingNumber\": \"\",\n \"padAgreement\": \"\"\n },\n \"cardData\": {\n \"cardNumber\": \"\",\n \"cardExpiry\": \"\",\n \"cardCVV\": \"\",\n \"cardHolderName\": \"\"\n },\n \"currency\": \"\",\n \"ipAddress\": \"\",\n \"ecommerce\": \"\",\n \"terminalId\": \"\",\n \"customerCode\": \"\",\n \"invoiceNumber\": \"\",\n \"billingAddress\": {\n \"name\": \"\",\n \"street1\": \"\",\n \"postalCode\": \"\",\n \"street2\": \"\",\n \"city\": \"\",\n \"province\": \"\",\n \"country\": \"\",\n \"phone\": \"\",\n \"email\": \"\"\n },\n \"invoice\": {\n \"invoiceNumber\": \"\",\n \"notes\": \"\",\n \"tipAmount\": \"\",\n \"shipping\": {\n \"amount\": \"\",\n \"details\": \"\",\n \"address\": {\n \"name\": \"\",\n \"street1\": \"\",\n \"postalCode\": \"\",\n \"street2\": \"\",\n \"city\": \"\",\n \"province\": \"\",\n \"country\": \"\",\n \"phone\": \"\",\n \"email\": \"\"\n }\n },\n \"pickup\": {\n \"date\": \"\",\n \"name\": \"\"\n },\n \"tax\": {\n \"amount\": \"\",\n \"details\": \"\"\n },\n \"discount\": {\n \"amount\": \"\",\n \"details\": \"\"\n },\n \"lineItems\": [\n {\n \"description\": \"\",\n \"quantity\": \"\",\n \"price\": \"\",\n \"taxAmount\": \"\",\n \"discountAmount\": \"\",\n \"sku\": \"\"\n },\n {\n \"description\": \"\",\n \"quantity\": \"\",\n \"price\": \"\",\n \"taxAmount\": \"\",\n \"discountAmount\": \"\",\n \"sku\": \"\"\n }\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/payment/withdraw", "host": [ "{{baseUrl}}" ], "path": [ "payment", "withdraw" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-8e16ca4f-13ab-4cf3-845c-9cc8e96828be" } ], "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-cabebb8d-1d0a-4f33-8a9f-77d84538effd" } ], "id": "f809c94e-d6c9-4638-81e5-4f06891b6090", "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-f809c94e-d6c9-4638-81e5-4f06891b6090" } ], "id": "78ef2192-cab6-44e3-a095-0ec8196bccaf", "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-78ef2192-cab6-44e3-a095-0ec8196bccaf" }, { "name": "card-batches", "item": [ { "name": "{cardBatchId}", "item": [ { "name": "settle", "item": [ { "name": "Settles an Open Card Batch", "id": "e8118512-d7a8-4165-9b98-53c5e235fe25", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api-token", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/card-batches/:cardBatchId/settle", "host": [ "{{baseUrl}}" ], "path": [ "card-batches", ":cardBatchId", "settle" ], "variable": [ { "id": "43fce283-4a8d-43e2-8249-0059994512cf", "key": "cardBatchId", "value": "", "description": "(Required) The Card Batch Id of the Card Batch you want to settle" } ] } }, "response": [ { "id": "d538f60d-2475-43e7-97bb-0b1b6d6a8bfd", "name": "Successful", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "api-token", "value": "" } ], "url": { "raw": "{{baseUrl}}/card-batches/:cardBatchId/settle", "host": [ "{{baseUrl}}" ], "path": [ "card-batches", ":cardBatchId", "settle" ], "variable": [ { "key": "cardBatchId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"dateCreated\": \"\",\n \"dateUpdated\": \"\",\n \"dateClosed\": \"\",\n \"closed\": \"\",\n \"terminalId\": \"\",\n \"batchNumber\": \"\",\n \"netSales\": \"\",\n \"totalSales\": \"\",\n \"totalRefunds\": \"\",\n \"totalReversed\": \"\",\n \"totalRefundsReversed\": \"\",\n \"countTotal\": \"\",\n \"countApproved\": \"\",\n \"countDeclined\": \"\"\n}", "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-d538f60d-2475-43e7-97bb-0b1b6d6a8bfd" }, { "id": "d3a8c7e0-33d3-4796-b909-1c50a68bbbbe", "name": "Failed", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "api-token", "value": "" } ], "url": { "raw": "{{baseUrl}}/card-batches/:cardBatchId/settle", "host": [ "{{baseUrl}}" ], "path": [ "card-batches", ":cardBatchId", "settle" ], "variable": [ { "key": "cardBatchId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-d3a8c7e0-33d3-4796-b909-1c50a68bbbbe" } ], "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-e8118512-d7a8-4165-9b98-53c5e235fe25" } ], "id": "1248149c-853d-49bd-8562-bb229d6b73ba", "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-1248149c-853d-49bd-8562-bb229d6b73ba" }, { "name": "Get Card Batch", "id": "940d6f11-a72c-4e68-8303-ba1ab167315d", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api-token", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/card-batches/:cardBatchId?collect-stats=false", "host": [ "{{baseUrl}}" ], "path": [ "card-batches", ":cardBatchId" ], "query": [ { "description": "Includes transaction statistics for the batch", "key": "collect-stats", "value": "false" } ], "variable": [ { "id": "9c105a53-ccb0-4697-b3e4-fdb7de526c4f", "key": "cardBatchId", "value": "", "description": "(Required) The Card Batch Id of the Card Batch you want to get" } ] } }, "response": [ { "id": "d5d7bc22-9565-4e77-bbea-f85e0cd5e072", "name": "Successful", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "api-token", "value": "" } ], "url": { "raw": "{{baseUrl}}/card-batches/:cardBatchId?collect-stats=false", "host": [ "{{baseUrl}}" ], "path": [ "card-batches", ":cardBatchId" ], "query": [ { "description": "Includes transaction statistics for the batch", "key": "collect-stats", "value": "false" } ], "variable": [ { "key": "cardBatchId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"dateCreated\": \"\",\n \"dateUpdated\": \"\",\n \"dateClosed\": \"\",\n \"closed\": \"\",\n \"terminalId\": \"\",\n \"batchNumber\": \"\",\n \"netSales\": \"\",\n \"totalSales\": \"\",\n \"totalRefunds\": \"\",\n \"totalReversed\": \"\",\n \"totalRefundsReversed\": \"\",\n \"countTotal\": \"\",\n \"countApproved\": \"\",\n \"countDeclined\": \"\"\n}", "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-d5d7bc22-9565-4e77-bbea-f85e0cd5e072" }, { "id": "ef3dd837-3eec-496f-ad29-22b141ba25e9", "name": "Failed", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "api-token", "value": "" } ], "url": { "raw": "{{baseUrl}}/card-batches/:cardBatchId?collect-stats=false", "host": [ "{{baseUrl}}" ], "path": [ "card-batches", ":cardBatchId" ], "query": [ { "description": "Includes transaction statistics for the batch", "key": "collect-stats", "value": "false" } ], "variable": [ { "key": "cardBatchId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-ef3dd837-3eec-496f-ad29-22b141ba25e9" } ], "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-940d6f11-a72c-4e68-8303-ba1ab167315d" } ], "id": "28662ef2-0b40-41c1-8e98-74b4fe9e4517", "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-28662ef2-0b40-41c1-8e98-74b4fe9e4517" }, { "name": "Get Card Batches", "id": "27ebf3d5-ba86-4ab7-bceb-536af75d6509", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api-token", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/card-batches?batchNumber=&terminalId=&collect-stats=false", "host": [ "{{baseUrl}}" ], "path": [ "card-batches" ], "query": [ { "description": "The number of the batch to retrieve. Note that this is the batch number, not batch ID.", "key": "batchNumber", "value": "" }, { "description": "The terminalId of the requested batch", "key": "terminalId", "value": "" }, { "description": "Includes transaction statistics for the batch", "key": "collect-stats", "value": "false" } ] } }, "response": [ { "id": "b601266d-924f-46dd-82d1-7d6345858eb8", "name": "Successful", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "api-token", "value": "" } ], "url": { "raw": "{{baseUrl}}/card-batches?batchNumber=&terminalId=&collect-stats=false", "host": [ "{{baseUrl}}" ], "path": [ "card-batches" ], "query": [ { "description": "The number of the batch to retrieve. Note that this is the batch number, not batch ID.", "key": "batchNumber", "value": "" }, { "description": "The terminalId of the requested batch", "key": "terminalId", "value": "" }, { "description": "Includes transaction statistics for the batch", "key": "collect-stats", "value": "false" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"id\": \"\",\n \"dateCreated\": \"\",\n \"dateUpdated\": \"\",\n \"dateClosed\": \"\",\n \"closed\": \"\",\n \"terminalId\": \"\",\n \"batchNumber\": \"\",\n \"netSales\": \"\",\n \"totalSales\": \"\",\n \"totalRefunds\": \"\",\n \"totalReversed\": \"\",\n \"totalRefundsReversed\": \"\",\n \"countTotal\": \"\",\n \"countApproved\": \"\",\n \"countDeclined\": \"\"\n },\n {\n \"id\": \"\",\n \"dateCreated\": \"\",\n \"dateUpdated\": \"\",\n \"dateClosed\": \"\",\n \"closed\": \"\",\n \"terminalId\": \"\",\n \"batchNumber\": \"\",\n \"netSales\": \"\",\n \"totalSales\": \"\",\n \"totalRefunds\": \"\",\n \"totalReversed\": \"\",\n \"totalRefundsReversed\": \"\",\n \"countTotal\": \"\",\n \"countApproved\": \"\",\n \"countDeclined\": \"\"\n }\n]", "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-b601266d-924f-46dd-82d1-7d6345858eb8" }, { "id": "5cfa20f1-3cc1-449b-8d61-d972951402cb", "name": "Failed", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "api-token", "value": "" } ], "url": { "raw": "{{baseUrl}}/card-batches?batchNumber=&terminalId=&collect-stats=false", "host": [ "{{baseUrl}}" ], "path": [ "card-batches" ], "query": [ { "description": "The number of the batch to retrieve. Note that this is the batch number, not batch ID.", "key": "batchNumber", "value": "" }, { "description": "The terminalId of the requested batch", "key": "terminalId", "value": "" }, { "description": "Includes transaction statistics for the batch", "key": "collect-stats", "value": "false" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-5cfa20f1-3cc1-449b-8d61-d972951402cb" } ], "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-27ebf3d5-ba86-4ab7-bceb-536af75d6509" } ], "id": "a5075c82-8308-4a42-9414-80ec627374ef", "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-a5075c82-8308-4a42-9414-80ec627374ef" }, { "name": "card-transactions", "item": [ { "name": "{cardTransactionId}", "item": [ { "name": "Get Card Transaction by id", "id": "9384c348-8b9e-4c56-b99d-d251ceae0d3e", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api-token", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/card-transactions/:cardTransactionId", "host": [ "{{baseUrl}}" ], "path": [ "card-transactions", ":cardTransactionId" ], "variable": [ { "id": "635e2828-6976-41d1-90e3-636346e0f93b", "key": "cardTransactionId", "value": "", "description": "(Required) The Card Transaction Id of the Card Transaction you want to get" } ] } }, "response": [ { "id": "84644ac3-01ed-4ac6-98e9-c9b02abc3750", "name": "Successful", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "api-token", "value": "" } ], "url": { "raw": "{{baseUrl}}/card-transactions/:cardTransactionId", "host": [ "{{baseUrl}}" ], "path": [ "card-transactions", ":cardTransactionId" ], "variable": [ { "key": "cardTransactionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"transactionId\": \"\",\n \"cardBatchId\": \"\",\n \"dateCreated\": \"\",\n \"status\": \"\",\n \"user\": \"\",\n \"type\": \"\",\n \"amount\": \"\",\n \"currency\": \"\",\n \"avsResponse\": \"\",\n \"cvvResponse\": \"\",\n \"cardType\": \"\",\n \"approvalCode\": \"\",\n \"cardToken\": \"\",\n \"cardNumber\": \"\",\n \"cardHolderName\": \"\",\n \"customerCode\": \"\",\n \"invoiceNumber\": \"\",\n \"warning\": \"\"\n}", "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-84644ac3-01ed-4ac6-98e9-c9b02abc3750" }, { "id": "87b36e00-4380-454c-b0b7-7effd8b51b7b", "name": "Failed", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "api-token", "value": "" } ], "url": { "raw": "{{baseUrl}}/card-transactions/:cardTransactionId", "host": [ "{{baseUrl}}" ], "path": [ "card-transactions", ":cardTransactionId" ], "variable": [ { "key": "cardTransactionId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-87b36e00-4380-454c-b0b7-7effd8b51b7b" } ], "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-9384c348-8b9e-4c56-b99d-d251ceae0d3e" } ], "id": "0c7d9477-eb98-4193-a199-a30d1a50d6dc", "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-0c7d9477-eb98-4193-a199-a30d1a50d6dc" }, { "name": "Collects up to 1000 Card Transactions", "id": "3c3881a9-d273-441f-b5b2-cd9ac3897008", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api-token", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/card-transactions?dateFrom=&dateTo=&search=&customerCode=&invoiceNumber=&cardToken=&cardBatchId=&limit=&page=", "host": [ "{{baseUrl}}" ], "path": [ "card-transactions" ], "query": [ { "description": "Filters transactions created from 2020-01-01 (Mountain Time)", "key": "dateFrom", "value": "" }, { "description": "Filters transactions created until 2021-01-01 (Mountain Time)", "key": "dateTo", "value": "" }, { "description": "Searches amount, card number(F6L4 only), cardholder name, & approval codes", "key": "search", "value": "" }, { "description": "The code of the customer associated with the transaction", "key": "customerCode", "value": "" }, { "description": "The number of the invoice associated with the transaction", "key": "invoiceNumber", "value": "" }, { "description": "The token of the card associated with the transaction", "key": "cardToken", "value": "" }, { "description": "The id of the batch associated with the transaction", "key": "cardBatchId", "value": "" }, { "description": "The limit number of transactions will be returned in one request. We only allow maximum 1000 objects per request. If no limit specified, the default limit will be 1000 objects.", "key": "limit", "value": "" }, { "description": "Specifies the page number of the results you want to retrieve.", "key": "page", "value": "" } ] } }, "response": [ { "id": "4b029783-8dd9-4579-a718-40d3b624ecb8", "name": "Successful", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "api-token", "value": "" } ], "url": { "raw": "{{baseUrl}}/card-transactions?dateFrom=&dateTo=&search=&customerCode=&invoiceNumber=&cardToken=&cardBatchId=&limit=&page=", "host": [ "{{baseUrl}}" ], "path": [ "card-transactions" ], "query": [ { "description": "Filters transactions created from 2020-01-01 (Mountain Time)", "key": "dateFrom", "value": "" }, { "description": "Filters transactions created until 2021-01-01 (Mountain Time)", "key": "dateTo", "value": "" }, { "description": "Searches amount, card number(F6L4 only), cardholder name, & approval codes", "key": "search", "value": "" }, { "description": "The code of the customer associated with the transaction", "key": "customerCode", "value": "" }, { "description": "The number of the invoice associated with the transaction", "key": "invoiceNumber", "value": "" }, { "description": "The token of the card associated with the transaction", "key": "cardToken", "value": "" }, { "description": "The id of the batch associated with the transaction", "key": "cardBatchId", "value": "" }, { "description": "The limit number of transactions will be returned in one request. We only allow maximum 1000 objects per request. If no limit specified, the default limit will be 1000 objects.", "key": "limit", "value": "" }, { "description": "Specifies the page number of the results you want to retrieve.", "key": "page", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"transactionId\": \"\",\n \"cardBatchId\": \"\",\n \"dateCreated\": \"\",\n \"status\": \"\",\n \"user\": \"\",\n \"type\": \"\",\n \"amount\": \"\",\n \"currency\": \"\",\n \"avsResponse\": \"\",\n \"cvvResponse\": \"\",\n \"cardType\": \"\",\n \"approvalCode\": \"\",\n \"cardToken\": \"\",\n \"cardNumber\": \"\",\n \"cardHolderName\": \"\",\n \"customerCode\": \"\",\n \"invoiceNumber\": \"\",\n \"warning\": \"\"\n },\n {\n \"transactionId\": \"\",\n \"cardBatchId\": \"\",\n \"dateCreated\": \"\",\n \"status\": \"\",\n \"user\": \"\",\n \"type\": \"\",\n \"amount\": \"\",\n \"currency\": \"\",\n \"avsResponse\": \"\",\n \"cvvResponse\": \"\",\n \"cardType\": \"\",\n \"approvalCode\": \"\",\n \"cardToken\": \"\",\n \"cardNumber\": \"\",\n \"cardHolderName\": \"\",\n \"customerCode\": \"\",\n \"invoiceNumber\": \"\",\n \"warning\": \"\"\n }\n]", "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-4b029783-8dd9-4579-a718-40d3b624ecb8" }, { "id": "4772af0a-6392-40eb-835c-44c83ae95ea9", "name": "Failed", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "api-token", "value": "" } ], "url": { "raw": "{{baseUrl}}/card-transactions?dateFrom=&dateTo=&search=&customerCode=&invoiceNumber=&cardToken=&cardBatchId=&limit=&page=", "host": [ "{{baseUrl}}" ], "path": [ "card-transactions" ], "query": [ { "description": "Filters transactions created from 2020-01-01 (Mountain Time)", "key": "dateFrom", "value": "" }, { "description": "Filters transactions created until 2021-01-01 (Mountain Time)", "key": "dateTo", "value": "" }, { "description": "Searches amount, card number(F6L4 only), cardholder name, & approval codes", "key": "search", "value": "" }, { "description": "The code of the customer associated with the transaction", "key": "customerCode", "value": "" }, { "description": "The number of the invoice associated with the transaction", "key": "invoiceNumber", "value": "" }, { "description": "The token of the card associated with the transaction", "key": "cardToken", "value": "" }, { "description": "The id of the batch associated with the transaction", "key": "cardBatchId", "value": "" }, { "description": "The limit number of transactions will be returned in one request. We only allow maximum 1000 objects per request. If no limit specified, the default limit will be 1000 objects.", "key": "limit", "value": "" }, { "description": "Specifies the page number of the results you want to retrieve.", "key": "page", "value": "" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-4772af0a-6392-40eb-835c-44c83ae95ea9" } ], "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-3c3881a9-d273-441f-b5b2-cd9ac3897008" } ], "id": "0511e5db-c248-416c-a3b9-58fc6d9908d3", "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-0511e5db-c248-416c-a3b9-58fc6d9908d3" }, { "name": "customers", "item": [ { "name": "{customerId}", "item": [ { "name": "cards", "item": [ { "name": "{cardId}", "item": [ { "name": "default", "item": [ { "name": "Set customer card as default", "id": "cd36aed8-33c3-4e59-9b26-a5f15eea44f5", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api-token", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/customers/:customerId/cards/:cardId/default", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":customerId", "cards", ":cardId", "default" ], "variable": [ { "id": "58944842-bdfb-42dd-95e6-56bc0b2e610a", "key": "customerId", "value": "", "description": "(Required) The ID of the customer" }, { "id": "a6d6f6a2-25dd-4adb-8c1b-533869fd25ec", "key": "cardId", "value": "", "description": "(Required) The ID of the card" } ] } }, "response": [ { "id": "3bf1aaa9-0c94-4a0a-a06f-3903fbc06389", "name": "Successful", "originalRequest": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "api-token", "value": "" } ], "url": { "raw": "{{baseUrl}}/customers/:customerId/cards/:cardId/default", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":customerId", "cards", ":cardId", "default" ], "variable": [ { "key": "customerId" }, { "key": "cardId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"id\": \"\",\n \"customerCode\": \"\",\n \"businessName\": \"\",\n \"contactName\": \"\",\n \"cellPhone\": \"\",\n \"billingAddress\": {\n \"name\": \"\",\n \"street1\": \"\",\n \"postalCode\": \"\",\n \"street2\": \"\",\n \"city\": \"\",\n \"province\": \"\",\n \"country\": \"\",\n \"phone\": \"\",\n \"email\": \"\"\n },\n \"shippingAddress\": {\n \"name\": \"\",\n \"street1\": \"\",\n \"postalCode\": \"\",\n \"street2\": \"\",\n \"city\": \"\",\n \"province\": \"\",\n \"country\": \"\",\n \"phone\": \"\",\n \"email\": \"\"\n },\n \"cards\": [\n {\n \"cardHolderName\": \"\",\n \"cardF6L4\": \"\",\n \"cardToken\": \"\"\n },\n {\n \"cardHolderName\": \"\",\n \"cardF6L4\": \"\",\n \"cardToken\": \"\"\n }\n ]\n },\n {\n \"id\": \"\",\n \"customerCode\": \"\",\n \"businessName\": \"\",\n \"contactName\": \"\",\n \"cellPhone\": \"\",\n \"billingAddress\": {\n \"name\": \"\",\n \"street1\": \"\",\n \"postalCode\": \"\",\n \"street2\": \"\",\n \"city\": \"\",\n \"province\": \"\",\n \"country\": \"\",\n \"phone\": \"\",\n \"email\": \"\"\n },\n \"shippingAddress\": {\n \"name\": \"\",\n \"street1\": \"\",\n \"postalCode\": \"\",\n \"street2\": \"\",\n \"city\": \"\",\n \"province\": \"\",\n \"country\": \"\",\n \"phone\": \"\",\n \"email\": \"\"\n },\n \"cards\": [\n {\n \"cardHolderName\": \"\",\n \"cardF6L4\": \"\",\n \"cardToken\": \"\"\n },\n {\n \"cardHolderName\": \"\",\n \"cardF6L4\": \"\",\n \"cardToken\": \"\"\n }\n ]\n }\n]", "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-3bf1aaa9-0c94-4a0a-a06f-3903fbc06389" }, { "id": "b7f67c7f-4c28-4e5e-bccb-3da8b9ef3360", "name": "Failed", "originalRequest": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "api-token", "value": "" } ], "url": { "raw": "{{baseUrl}}/customers/:customerId/cards/:cardId/default", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":customerId", "cards", ":cardId", "default" ], "variable": [ { "key": "customerId" }, { "key": "cardId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-b7f67c7f-4c28-4e5e-bccb-3da8b9ef3360" } ], "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-cd36aed8-33c3-4e59-9b26-a5f15eea44f5" } ], "id": "7d3a3248-bff4-4436-8934-d62513737723", "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-7d3a3248-bff4-4436-8934-d62513737723" }, { "name": "Get customer card", "id": "af13e971-3bea-4d2b-a0b8-403565c50124", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api-token", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/customers/:customerId/cards/:cardId", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":customerId", "cards", ":cardId" ], "variable": [ { "id": "0b9ca78a-fedc-4517-804b-ca154ed9f53e", "key": "customerId", "value": "", "description": "(Required) The Id of the customer" }, { "id": "f2dadcb0-9c85-4998-a7c6-ec05c146036c", "key": "cardId", "value": "", "description": "(Required) The Id of the card" } ] } }, "response": [ { "id": "95cb1b0b-c723-42b7-b370-89cb43858d71", "name": "Successful", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "api-token", "value": "" } ], "url": { "raw": "{{baseUrl}}/customers/:customerId/cards/:cardId", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":customerId", "cards", ":cardId" ], "variable": [ { "key": "customerId" }, { "key": "cardId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"id\": \"\",\n \"cardToken\": \"\",\n \"dateCreated\": \"\",\n \"dateUpdated\": \"\",\n \"cardHolderName\": \"\",\n \"cardF6L4\": \"\",\n \"cardExpiry\": \"\",\n \"cardCVV\": \"\"\n },\n {\n \"id\": \"\",\n \"cardToken\": \"\",\n \"dateCreated\": \"\",\n \"dateUpdated\": \"\",\n \"cardHolderName\": \"\",\n \"cardF6L4\": \"\",\n \"cardExpiry\": \"\",\n \"cardCVV\": \"\"\n }\n]", "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-95cb1b0b-c723-42b7-b370-89cb43858d71" }, { "id": "15963182-e035-45cf-897c-269597a4c605", "name": "Failed", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "api-token", "value": "" } ], "url": { "raw": "{{baseUrl}}/customers/:customerId/cards/:cardId", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":customerId", "cards", ":cardId" ], "variable": [ { "key": "customerId" }, { "key": "cardId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-15963182-e035-45cf-897c-269597a4c605" } ], "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-af13e971-3bea-4d2b-a0b8-403565c50124" }, { "name": "Delete customer card", "id": "beb14e53-d78e-4ef5-ba26-c5a4ae1ab3e9", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api-token", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/customers/:customerId/cards/:cardId", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":customerId", "cards", ":cardId" ], "variable": [ { "id": "432bc9a6-543f-4ae2-8a96-80351bba6aa6", "key": "customerId", "value": "", "description": "(Required) The ID of the customer" }, { "id": "8305eaf2-76be-4c1b-80e1-a8d5a2c050c4", "key": "cardId", "value": "", "description": "(Required) The ID of the card" } ] } }, "response": [ { "id": "89aa549b-f9b7-4ffc-a4c1-0fb4b4a49bf3", "name": "Successfully deleted card", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "api-token", "value": "" } ], "url": { "raw": "{{baseUrl}}/customers/:customerId/cards/:cardId", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":customerId", "cards", ":cardId" ], "variable": [ { "key": "customerId" }, { "key": "cardId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-89aa549b-f9b7-4ffc-a4c1-0fb4b4a49bf3" }, { "id": "b2f278ca-6f84-4274-93a6-8ca2c6054782", "name": "No card found", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "api-token", "value": "" } ], "url": { "raw": "{{baseUrl}}/customers/:customerId/cards/:cardId", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":customerId", "cards", ":cardId" ], "variable": [ { "key": "customerId" }, { "key": "cardId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-b2f278ca-6f84-4274-93a6-8ca2c6054782" }, { "id": "6777529d-b171-4bc3-b465-1aa1d16a5f0c", "name": "Failed", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "api-token", "value": "" } ], "url": { "raw": "{{baseUrl}}/customers/:customerId/cards/:cardId", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":customerId", "cards", ":cardId" ], "variable": [ { "key": "customerId" }, { "key": "cardId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-6777529d-b171-4bc3-b465-1aa1d16a5f0c" } ], "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-beb14e53-d78e-4ef5-ba26-c5a4ae1ab3e9" } ], "id": "db0e4493-f505-42d5-88cc-915c5b1d7fba", "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-db0e4493-f505-42d5-88cc-915c5b1d7fba" }, { "name": "Get customer cards", "id": "e69fcd97-7780-4b30-b135-e8b3a063730b", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api-token", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/customers/:customerId/cards?cardToken=", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":customerId", "cards" ], "query": [ { "description": "The card token.", "key": "cardToken", "value": "" } ], "variable": [ { "id": "560f0fc6-5c53-4c5b-8792-97b378f2cde2", "key": "customerId", "value": "", "description": "(Required) The Id of the customer" } ] } }, "response": [ { "id": "d96fe53b-c782-4e74-a620-687e14a37ff3", "name": "Successful", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "api-token", "value": "" } ], "url": { "raw": "{{baseUrl}}/customers/:customerId/cards?cardToken=", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":customerId", "cards" ], "query": [ { "description": "The card token.", "key": "cardToken", "value": "" } ], "variable": [ { "key": "customerId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"id\": \"\",\n \"cardToken\": \"\",\n \"dateCreated\": \"\",\n \"dateUpdated\": \"\",\n \"cardHolderName\": \"\",\n \"cardF6L4\": \"\",\n \"cardExpiry\": \"\",\n \"cardCVV\": \"\"\n },\n {\n \"id\": \"\",\n \"cardToken\": \"\",\n \"dateCreated\": \"\",\n \"dateUpdated\": \"\",\n \"cardHolderName\": \"\",\n \"cardF6L4\": \"\",\n \"cardExpiry\": \"\",\n \"cardCVV\": \"\"\n }\n]", "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-d96fe53b-c782-4e74-a620-687e14a37ff3" }, { "id": "3c690cc4-965c-46f7-8945-ac2b467386e9", "name": "Failed", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "api-token", "value": "" } ], "url": { "raw": "{{baseUrl}}/customers/:customerId/cards?cardToken=", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":customerId", "cards" ], "query": [ { "description": "The card token.", "key": "cardToken", "value": "" } ], "variable": [ { "key": "customerId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-3c690cc4-965c-46f7-8945-ac2b467386e9" } ], "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-e69fcd97-7780-4b30-b135-e8b3a063730b" } ], "id": "2cc95c51-8435-4f26-8a9a-c505596d549f", "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-2cc95c51-8435-4f26-8a9a-c505596d549f" }, { "name": "pads", "item": [ { "name": "Get all PADS for a customer.", "id": "4c90eb60-73fe-4573-8bb9-43fc5cb5f783", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api-token", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/customers/:customerId/pads", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":customerId", "pads" ], "variable": [ { "id": "4e22f423-7458-4d61-87c5-66ae06d891fc", "key": "customerId", "value": "", "description": "(Required) Customer ID." } ] } }, "response": [ { "id": "1a6f4b7b-cf23-4888-bcd1-eadc46144564", "name": "Successfully retrieved all PADs.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "api-token", "value": "" } ], "url": { "raw": "{{baseUrl}}/customers/:customerId/pads", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":customerId", "pads" ], "variable": [ { "key": "customerId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"pads\": [\n {\n \"id\": \"\",\n \"accepted\": 1,\n \"bankAccountId\": \"\",\n \"customerId\": \"\",\n \"dateAccepted\": \"\",\n \"dateCreated\": \"\",\n \"dateEarliestDebit\": \"\",\n \"dateRevoked\": \"\",\n \"dateUpdated\": \"\",\n \"ipAddress\": \"\",\n \"merchantId\": \"\",\n \"type\": 2,\n \"status\": 1\n },\n {\n \"id\": \"\",\n \"accepted\": 1,\n \"bankAccountId\": \"\",\n \"customerId\": \"\",\n \"dateAccepted\": \"\",\n \"dateCreated\": \"\",\n \"dateEarliestDebit\": \"\",\n \"dateRevoked\": \"\",\n \"dateUpdated\": \"\",\n \"ipAddress\": \"\",\n \"merchantId\": \"\",\n \"type\": 1,\n \"status\": 1\n }\n ]\n}", "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-1a6f4b7b-cf23-4888-bcd1-eadc46144564" }, { "id": "b63167bf-4f65-4abe-b2a8-9236f72b7797", "name": "No PADs for a given customer.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "api-token", "value": "" } ], "url": { "raw": "{{baseUrl}}/customers/:customerId/pads", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":customerId", "pads" ], "variable": [ { "key": "customerId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-b63167bf-4f65-4abe-b2a8-9236f72b7797" }, { "id": "534ca9e4-8b10-4a5c-83ee-f8c8eabcaf74", "name": "Invalid request.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "api-token", "value": "" } ], "url": { "raw": "{{baseUrl}}/customers/:customerId/pads", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":customerId", "pads" ], "variable": [ { "key": "customerId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-534ca9e4-8b10-4a5c-83ee-f8c8eabcaf74" }, { "id": "2b5bcacd-6d40-4b2e-9ee0-30df3dd8c441", "name": "User does not have valid permissions.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "api-token", "value": "" } ], "url": { "raw": "{{baseUrl}}/customers/:customerId/pads", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":customerId", "pads" ], "variable": [ { "key": "customerId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-2b5bcacd-6d40-4b2e-9ee0-30df3dd8c441" }, { "id": "2acf8a5c-b30d-4c5d-856f-5c89c3699db4", "name": "Unexpected internal error.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "api-token", "value": "" } ], "url": { "raw": "{{baseUrl}}/customers/:customerId/pads", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":customerId", "pads" ], "variable": [ { "key": "customerId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-2acf8a5c-b30d-4c5d-856f-5c89c3699db4" } ], "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-4c90eb60-73fe-4573-8bb9-43fc5cb5f783" } ], "id": "dbb929dc-4c37-468d-8b3c-7ea002374f01", "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-dbb929dc-4c37-468d-8b3c-7ea002374f01" }, { "name": "bank-accounts", "item": [ { "name": "request-new", "item": [ { "name": "Request bank account information from a customer.", "id": "08d6b6cf-1a70-406e-84de-648176a6cbe2", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api-token", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/customers/:customerId/bank-accounts/request-new", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":customerId", "bank-accounts", "request-new" ], "variable": [ { "id": "6fd33a34-a623-4a60-8be7-331c12c0731e", "key": "customerId", "value": "", "description": "(Required) Customer ID." } ] } }, "response": [ { "id": "e70c19ac-9cbb-4232-85d1-eb0881d5cdee", "name": "Successfully sent bank account request email to customer.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "api-token", "value": "" } ], "url": { "raw": "{{baseUrl}}/customers/:customerId/bank-accounts/request-new", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":customerId", "bank-accounts", "request-new" ], "variable": [ { "key": "customerId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-e70c19ac-9cbb-4232-85d1-eb0881d5cdee" }, { "id": "dcb7a83e-46f0-4666-adb5-468b74b6a158", "name": "Invalid request.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "api-token", "value": "" } ], "url": { "raw": "{{baseUrl}}/customers/:customerId/bank-accounts/request-new", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":customerId", "bank-accounts", "request-new" ], "variable": [ { "key": "customerId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-dcb7a83e-46f0-4666-adb5-468b74b6a158" }, { "id": "85aaeceb-954d-44e8-846a-c71fcdd3e1f8", "name": "User does not have valid permissions.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "api-token", "value": "" } ], "url": { "raw": "{{baseUrl}}/customers/:customerId/bank-accounts/request-new", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":customerId", "bank-accounts", "request-new" ], "variable": [ { "key": "customerId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-85aaeceb-954d-44e8-846a-c71fcdd3e1f8" }, { "id": "11bff141-5b3d-4ca8-bc3b-84da24212246", "name": "Unexpected internal error.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "api-token", "value": "" } ], "url": { "raw": "{{baseUrl}}/customers/:customerId/bank-accounts/request-new", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":customerId", "bank-accounts", "request-new" ], "variable": [ { "key": "customerId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-11bff141-5b3d-4ca8-bc3b-84da24212246" } ], "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-08d6b6cf-1a70-406e-84de-648176a6cbe2" } ], "id": "125532e7-f5d2-406c-a34e-e76f8ef2ea9e", "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-125532e7-f5d2-406c-a34e-e76f8ef2ea9e" }, { "name": "{bankAccountId}", "item": [ { "name": "default", "item": [ { "name": "Set customer bank account as default", "id": "40826e02-81ea-4b2e-851c-0884a8f7a9c4", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api-token", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/customers/:customerId/bank-accounts/:bankAccountId/default", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":customerId", "bank-accounts", ":bankAccountId", "default" ], "variable": [ { "id": "e5e8d3c7-4ff5-425c-8a19-dc84d3e58673", "key": "customerId", "value": "", "description": "(Required) The Id of the customer" }, { "id": "df8b7b85-b56e-488e-996b-4f6aa2f6d059", "key": "bankAccountId", "value": "", "description": "(Required) The Id of the bank account" } ] } }, "response": [ { "id": "00770c20-9fff-43b9-a238-ca8c0539b4e0", "name": "Successful", "originalRequest": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "api-token", "value": "" } ], "url": { "raw": "{{baseUrl}}/customers/:customerId/bank-accounts/:bankAccountId/default", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":customerId", "bank-accounts", ":bankAccountId", "default" ], "variable": [ { "key": "customerId" }, { "key": "bankAccountId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"id\": \"\",\n \"customerId\": \"\",\n \"dateCreated\": \"\",\n \"dateUpdated\": \"\",\n \"dateLastUsed\": \"\",\n \"dateVerified\": \"\",\n \"bankToken\": \"\",\n \"accountType\": \"\",\n \"accountCorporate\": \"\",\n \"verified\": \"\",\n \"ready\": \"\",\n \"bankIdNumber\": \"\",\n \"transitNumber\": \"\",\n \"routingNumber\": \"\",\n \"bankAccountNumberL4\": \"\",\n \"address\": {\n \"name\": \"\",\n \"street1\": \"\",\n \"postalCode\": \"\",\n \"street2\": \"\",\n \"city\": \"\",\n \"province\": \"\",\n \"country\": \"\",\n \"phone\": \"\",\n \"email\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"customerId\": \"\",\n \"dateCreated\": \"\",\n \"dateUpdated\": \"\",\n \"dateLastUsed\": \"\",\n \"dateVerified\": \"\",\n \"bankToken\": \"\",\n \"accountType\": \"\",\n \"accountCorporate\": \"\",\n \"verified\": \"\",\n \"ready\": \"\",\n \"bankIdNumber\": \"\",\n \"transitNumber\": \"\",\n \"routingNumber\": \"\",\n \"bankAccountNumberL4\": \"\",\n \"address\": {\n \"name\": \"\",\n \"street1\": \"\",\n \"postalCode\": \"\",\n \"street2\": \"\",\n \"city\": \"\",\n \"province\": \"\",\n \"country\": \"\",\n \"phone\": \"\",\n \"email\": \"\"\n }\n }\n]", "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-00770c20-9fff-43b9-a238-ca8c0539b4e0" }, { "id": "d7ef8af4-4deb-498d-8aea-4e8940668d54", "name": "Failed", "originalRequest": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "api-token", "value": "" } ], "url": { "raw": "{{baseUrl}}/customers/:customerId/bank-accounts/:bankAccountId/default", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":customerId", "bank-accounts", ":bankAccountId", "default" ], "variable": [ { "key": "customerId" }, { "key": "bankAccountId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-d7ef8af4-4deb-498d-8aea-4e8940668d54" } ], "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-40826e02-81ea-4b2e-851c-0884a8f7a9c4" } ], "id": "29ecdafd-5e4f-4b31-9f2e-751001c6b0fa", "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-29ecdafd-5e4f-4b31-9f2e-751001c6b0fa" }, { "name": "pads", "item": [ { "name": "{padId}", "item": [ { "name": "Get a PAD by its ID.", "id": "84c3b4e5-fbc8-4791-930f-3a78927cef5b", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api-token", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/customers/:customerId/bank-accounts/:bankAccountId/pads/:padId", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":customerId", "bank-accounts", ":bankAccountId", "pads", ":padId" ], "variable": [ { "id": "ea0ca24f-df42-4282-9274-b7e070f57303", "key": "customerId", "value": "", "description": "(Required) Customer ID." }, { "id": "b9ad67b1-94eb-41b7-add5-a6bb002ea21e", "key": "bankAccountId", "value": "", "description": "(Required) Bank account ID." }, { "id": "a802b8dd-c40c-47a0-babe-899eb56c2b5d", "key": "padId", "value": "", "description": "(Required) PAD ID." } ] } }, "response": [ { "id": "42fe3189-2a6b-49d4-9b75-8aef73796138", "name": "Successfully retrieved PAD.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "api-token", "value": "" } ], "url": { "raw": "{{baseUrl}}/customers/:customerId/bank-accounts/:bankAccountId/pads/:padId", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":customerId", "bank-accounts", ":bankAccountId", "pads", ":padId" ], "variable": [ { "key": "customerId" }, { "key": "bankAccountId" }, { "key": "padId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"pad\": {\n \"id\": \"\",\n \"accepted\": 1,\n \"bankAccountId\": \"\",\n \"customerId\": \"\",\n \"dateAccepted\": \"\",\n \"dateCreated\": \"\",\n \"dateEarliestDebit\": \"\",\n \"dateRevoked\": \"\",\n \"dateUpdated\": \"\",\n \"ipAddress\": \"\",\n \"merchantId\": \"\",\n \"type\": 2,\n \"status\": 1\n }\n}", "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-42fe3189-2a6b-49d4-9b75-8aef73796138" }, { "id": "ec47ba5f-5200-4265-8ecc-b2f082ea7434", "name": "Invalid request.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "api-token", "value": "" } ], "url": { "raw": "{{baseUrl}}/customers/:customerId/bank-accounts/:bankAccountId/pads/:padId", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":customerId", "bank-accounts", ":bankAccountId", "pads", ":padId" ], "variable": [ { "key": "customerId" }, { "key": "bankAccountId" }, { "key": "padId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-ec47ba5f-5200-4265-8ecc-b2f082ea7434" }, { "id": "8574b8dc-7c88-487c-b5ae-2765232111d1", "name": "User does not have valid permissions.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "api-token", "value": "" } ], "url": { "raw": "{{baseUrl}}/customers/:customerId/bank-accounts/:bankAccountId/pads/:padId", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":customerId", "bank-accounts", ":bankAccountId", "pads", ":padId" ], "variable": [ { "key": "customerId" }, { "key": "bankAccountId" }, { "key": "padId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-8574b8dc-7c88-487c-b5ae-2765232111d1" }, { "id": "d8fc52a2-1111-4c43-9f05-319175448c01", "name": "Unexpected internal error.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "api-token", "value": "" } ], "url": { "raw": "{{baseUrl}}/customers/:customerId/bank-accounts/:bankAccountId/pads/:padId", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":customerId", "bank-accounts", ":bankAccountId", "pads", ":padId" ], "variable": [ { "key": "customerId" }, { "key": "bankAccountId" }, { "key": "padId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-d8fc52a2-1111-4c43-9f05-319175448c01" } ], "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-84c3b4e5-fbc8-4791-930f-3a78927cef5b" }, { "name": "Update a PAD by its ID.", "id": "0c8a5771-300a-4084-ba5b-7a139bb6abf7", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api-token", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"accepted\": 0,\n \"ipAddress\": \"\",\n \"type\": 2,\n \"status\": 2\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/customers/:customerId/bank-accounts/:bankAccountId/pads/:padId", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":customerId", "bank-accounts", ":bankAccountId", "pads", ":padId" ], "variable": [ { "id": "bde8c791-b5a8-4ecd-83fc-2648c7a5ca7e", "key": "customerId", "value": "", "description": "(Required) Customer ID." }, { "id": "5caf4207-6c1a-4df9-b388-74c9fad7310f", "key": "bankAccountId", "value": "", "description": "(Required) Bank account ID." }, { "id": "c639c49a-bd50-45d4-9086-eddaa4b6c434", "key": "padId", "value": "", "description": "(Required) PAD ID." } ] } }, "response": [ { "id": "d911601e-bc80-49c0-b6e3-f4cc654bcc32", "name": "Successfully updated PAD.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "api-token", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"accepted\": 0,\n \"ipAddress\": \"\",\n \"type\": 2,\n \"status\": 2\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/customers/:customerId/bank-accounts/:bankAccountId/pads/:padId", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":customerId", "bank-accounts", ":bankAccountId", "pads", ":padId" ], "variable": [ { "key": "customerId" }, { "key": "bankAccountId" }, { "key": "padId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-d911601e-bc80-49c0-b6e3-f4cc654bcc32" }, { "id": "6b713d35-0b51-4ed9-acd3-2c99911aa82f", "name": "Invalid request.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "api-token", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"accepted\": 0,\n \"ipAddress\": \"\",\n \"type\": 2,\n \"status\": 2\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/customers/:customerId/bank-accounts/:bankAccountId/pads/:padId", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":customerId", "bank-accounts", ":bankAccountId", "pads", ":padId" ], "variable": [ { "key": "customerId" }, { "key": "bankAccountId" }, { "key": "padId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-6b713d35-0b51-4ed9-acd3-2c99911aa82f" }, { "id": "100b46b1-5920-4cb4-a3de-47ed168c77e0", "name": "User does not have valid permissions.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "api-token", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"accepted\": 0,\n \"ipAddress\": \"\",\n \"type\": 2,\n \"status\": 2\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/customers/:customerId/bank-accounts/:bankAccountId/pads/:padId", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":customerId", "bank-accounts", ":bankAccountId", "pads", ":padId" ], "variable": [ { "key": "customerId" }, { "key": "bankAccountId" }, { "key": "padId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-100b46b1-5920-4cb4-a3de-47ed168c77e0" }, { "id": "294f6b3d-96cc-4074-9a23-a3afe833e892", "name": "Unexpected internal error.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "api-token", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"accepted\": 0,\n \"ipAddress\": \"\",\n \"type\": 2,\n \"status\": 2\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/customers/:customerId/bank-accounts/:bankAccountId/pads/:padId", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":customerId", "bank-accounts", ":bankAccountId", "pads", ":padId" ], "variable": [ { "key": "customerId" }, { "key": "bankAccountId" }, { "key": "padId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-294f6b3d-96cc-4074-9a23-a3afe833e892" } ], "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-0c8a5771-300a-4084-ba5b-7a139bb6abf7" } ], "id": "2a3f919f-20c9-4c63-a96a-7b37a73523f8", "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-2a3f919f-20c9-4c63-a96a-7b37a73523f8" } ], "id": "ebdb27ed-002e-44c2-a7c8-52ecc9b1ffaa", "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-ebdb27ed-002e-44c2-a7c8-52ecc9b1ffaa" }, { "name": "Get customer bank account", "id": "7b2c6559-5871-4a73-9122-bc7fed465bfb", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api-token", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/customers/:customerId/bank-accounts/:bankAccountId", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":customerId", "bank-accounts", ":bankAccountId" ], "variable": [ { "id": "b6fa324e-7f5a-4533-9fce-9b263d4e6db8", "key": "customerId", "value": "", "description": "(Required) The Id of the customer" }, { "id": "c838b30d-db68-4f5d-b676-8f05eb2d5c88", "key": "bankAccountId", "value": "", "description": "(Required) The Id of the bank account" } ] } }, "response": [ { "id": "c066b34e-344c-411e-8851-b4ae7abd3299", "name": "Successful", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "api-token", "value": "" } ], "url": { "raw": "{{baseUrl}}/customers/:customerId/bank-accounts/:bankAccountId", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":customerId", "bank-accounts", ":bankAccountId" ], "variable": [ { "key": "customerId" }, { "key": "bankAccountId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"id\": \"\",\n \"customerId\": \"\",\n \"dateCreated\": \"\",\n \"dateUpdated\": \"\",\n \"dateLastUsed\": \"\",\n \"dateVerified\": \"\",\n \"bankToken\": \"\",\n \"accountType\": \"\",\n \"accountCorporate\": \"\",\n \"verified\": \"\",\n \"ready\": \"\",\n \"bankIdNumber\": \"\",\n \"transitNumber\": \"\",\n \"routingNumber\": \"\",\n \"bankAccountNumberL4\": \"\",\n \"address\": {\n \"name\": \"\",\n \"street1\": \"\",\n \"postalCode\": \"\",\n \"street2\": \"\",\n \"city\": \"\",\n \"province\": \"\",\n \"country\": \"\",\n \"phone\": \"\",\n \"email\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"customerId\": \"\",\n \"dateCreated\": \"\",\n \"dateUpdated\": \"\",\n \"dateLastUsed\": \"\",\n \"dateVerified\": \"\",\n \"bankToken\": \"\",\n \"accountType\": \"\",\n \"accountCorporate\": \"\",\n \"verified\": \"\",\n \"ready\": \"\",\n \"bankIdNumber\": \"\",\n \"transitNumber\": \"\",\n \"routingNumber\": \"\",\n \"bankAccountNumberL4\": \"\",\n \"address\": {\n \"name\": \"\",\n \"street1\": \"\",\n \"postalCode\": \"\",\n \"street2\": \"\",\n \"city\": \"\",\n \"province\": \"\",\n \"country\": \"\",\n \"phone\": \"\",\n \"email\": \"\"\n }\n }\n]", "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-c066b34e-344c-411e-8851-b4ae7abd3299" }, { "id": "dea01a74-d0fb-4064-821a-d5d4a34c4740", "name": "Failed", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "api-token", "value": "" } ], "url": { "raw": "{{baseUrl}}/customers/:customerId/bank-accounts/:bankAccountId", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":customerId", "bank-accounts", ":bankAccountId" ], "variable": [ { "key": "customerId" }, { "key": "bankAccountId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-dea01a74-d0fb-4064-821a-d5d4a34c4740" } ], "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-7b2c6559-5871-4a73-9122-bc7fed465bfb" }, { "name": "Delete customer bank account.", "id": "db4c74f4-779e-494e-96ac-23cb54bd33a5", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api-token", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/customers/:customerId/bank-accounts/:bankAccountId", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":customerId", "bank-accounts", ":bankAccountId" ], "variable": [ { "id": "3839d6ed-e1ed-42bf-8a3c-ca33931fe500", "key": "customerId", "value": "", "description": "(Required) The ID of the customer" }, { "id": "cff8d9d1-ad6e-412a-a715-81cbb09d577d", "key": "bankAccountId", "value": "", "description": "(Required) The ID of the bank account." } ] } }, "response": [ { "id": "aa9f6685-0350-414f-a084-623c782fdf57", "name": "Bank account successfully deleted.", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "api-token", "value": "" } ], "url": { "raw": "{{baseUrl}}/customers/:customerId/bank-accounts/:bankAccountId", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":customerId", "bank-accounts", ":bankAccountId" ], "variable": [ { "key": "customerId" }, { "key": "bankAccountId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-aa9f6685-0350-414f-a084-623c782fdf57" }, { "id": "75bfd41e-9fb3-4731-9934-be2c72e6fae0", "name": "Invalid request. Customer ID or bank account ID is missing or invalid.", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "api-token", "value": "" } ], "url": { "raw": "{{baseUrl}}/customers/:customerId/bank-accounts/:bankAccountId", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":customerId", "bank-accounts", ":bankAccountId" ], "variable": [ { "key": "customerId" }, { "key": "bankAccountId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-75bfd41e-9fb3-4731-9934-be2c72e6fae0" }, { "id": "44e43f28-d0f6-49a1-bb17-4f412747bb8e", "name": "User does not have valid permissions.", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "api-token", "value": "" } ], "url": { "raw": "{{baseUrl}}/customers/:customerId/bank-accounts/:bankAccountId", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":customerId", "bank-accounts", ":bankAccountId" ], "variable": [ { "key": "customerId" }, { "key": "bankAccountId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-44e43f28-d0f6-49a1-bb17-4f412747bb8e" }, { "id": "74a58506-963f-48e6-8f88-5adbde59bf5a", "name": "Bank account not found or has already been deleted.", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "api-token", "value": "" } ], "url": { "raw": "{{baseUrl}}/customers/:customerId/bank-accounts/:bankAccountId", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":customerId", "bank-accounts", ":bankAccountId" ], "variable": [ { "key": "customerId" }, { "key": "bankAccountId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-74a58506-963f-48e6-8f88-5adbde59bf5a" }, { "id": "6f0cf2dd-f8cb-4829-828c-439a8519e2dc", "name": "Internal server error while deleting the bank account.", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "api-token", "value": "" } ], "url": { "raw": "{{baseUrl}}/customers/:customerId/bank-accounts/:bankAccountId", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":customerId", "bank-accounts", ":bankAccountId" ], "variable": [ { "key": "customerId" }, { "key": "bankAccountId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-6f0cf2dd-f8cb-4829-828c-439a8519e2dc" } ], "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-db4c74f4-779e-494e-96ac-23cb54bd33a5" } ], "id": "01fb88ae-1eab-4b16-919a-3cc220a2696f", "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-01fb88ae-1eab-4b16-919a-3cc220a2696f" }, { "name": "Get customer bank accounts.", "id": "ee1bd8db-467b-49af-853d-3d02a5668bea", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api-token", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/customers/:customerId/bank-accounts?bankToken=&verified=&ready=", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":customerId", "bank-accounts" ], "query": [ { "description": "The bank account token.", "key": "bankToken", "value": "" }, { "description": "If the bank account is verified or not. Use 1 or 0.", "key": "verified", "value": "" }, { "description": "If the bank account is verified or not. Use 1 or 0.", "key": "ready", "value": "" } ], "variable": [ { "id": "4d66c99a-432c-4108-ab17-1fe553a435a9", "key": "customerId", "value": "", "description": "(Required) The ID of the customer" } ] } }, "response": [ { "id": "4615a544-9ad6-45e0-af10-ef48013e7be8", "name": "Successful", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "api-token", "value": "" } ], "url": { "raw": "{{baseUrl}}/customers/:customerId/bank-accounts?bankToken=&verified=&ready=", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":customerId", "bank-accounts" ], "query": [ { "description": "The bank account token.", "key": "bankToken", "value": "" }, { "description": "If the bank account is verified or not. Use 1 or 0.", "key": "verified", "value": "" }, { "description": "If the bank account is verified or not. Use 1 or 0.", "key": "ready", "value": "" } ], "variable": [ { "key": "customerId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"id\": \"\",\n \"customerId\": \"\",\n \"dateCreated\": \"\",\n \"dateUpdated\": \"\",\n \"dateLastUsed\": \"\",\n \"dateVerified\": \"\",\n \"bankToken\": \"\",\n \"accountType\": \"\",\n \"accountCorporate\": \"\",\n \"verified\": \"\",\n \"ready\": \"\",\n \"bankIdNumber\": \"\",\n \"transitNumber\": \"\",\n \"routingNumber\": \"\",\n \"bankAccountNumberL4\": \"\",\n \"address\": {\n \"name\": \"\",\n \"street1\": \"\",\n \"postalCode\": \"\",\n \"street2\": \"\",\n \"city\": \"\",\n \"province\": \"\",\n \"country\": \"\",\n \"phone\": \"\",\n \"email\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"customerId\": \"\",\n \"dateCreated\": \"\",\n \"dateUpdated\": \"\",\n \"dateLastUsed\": \"\",\n \"dateVerified\": \"\",\n \"bankToken\": \"\",\n \"accountType\": \"\",\n \"accountCorporate\": \"\",\n \"verified\": \"\",\n \"ready\": \"\",\n \"bankIdNumber\": \"\",\n \"transitNumber\": \"\",\n \"routingNumber\": \"\",\n \"bankAccountNumberL4\": \"\",\n \"address\": {\n \"name\": \"\",\n \"street1\": \"\",\n \"postalCode\": \"\",\n \"street2\": \"\",\n \"city\": \"\",\n \"province\": \"\",\n \"country\": \"\",\n \"phone\": \"\",\n \"email\": \"\"\n }\n }\n]", "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-4615a544-9ad6-45e0-af10-ef48013e7be8" }, { "id": "d81a97bf-5fcb-4a41-879f-ecba0e72b507", "name": "Failed", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "api-token", "value": "" } ], "url": { "raw": "{{baseUrl}}/customers/:customerId/bank-accounts?bankToken=&verified=&ready=", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":customerId", "bank-accounts" ], "query": [ { "description": "The bank account token.", "key": "bankToken", "value": "" }, { "description": "If the bank account is verified or not. Use 1 or 0.", "key": "verified", "value": "" }, { "description": "If the bank account is verified or not. Use 1 or 0.", "key": "ready", "value": "" } ], "variable": [ { "key": "customerId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-d81a97bf-5fcb-4a41-879f-ecba0e72b507" } ], "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-ee1bd8db-467b-49af-853d-3d02a5668bea" }, { "name": "Create a bank account.", "id": "b15b280a-6c84-4cf8-b933-a011241fdd56", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api-token", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"accountCorporate\": 2,\n \"accountType\": 1,\n \"bankAccountNumber\": \"\",\n \"city\": \"\",\n \"countryAlpha2\": \"\",\n \"postalCode\": \"\",\n \"provinceAlpha2\": \"\",\n \"streetAddress\": \"\",\n \"bankFinancialNumber\": \"\",\n \"bankRoutingNumber\": \"\",\n \"bankTransitNumber\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"companyName\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/customers/:customerId/bank-accounts", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":customerId", "bank-accounts" ], "variable": [ { "id": "04943860-6aa9-4caf-a61e-22fd8dfea296", "key": "customerId", "value": "", "description": "(Required) Customer ID." } ] } }, "response": [ { "id": "7332f249-430a-46e8-8de5-17910b0d7d89", "name": "Successfully created new bank account. A bank authorization was also emailed to the customer.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "api-token", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"accountCorporate\": 2,\n \"accountType\": 1,\n \"bankAccountNumber\": \"\",\n \"city\": \"\",\n \"countryAlpha2\": \"\",\n \"postalCode\": \"\",\n \"provinceAlpha2\": \"\",\n \"streetAddress\": \"\",\n \"bankFinancialNumber\": \"\",\n \"bankRoutingNumber\": \"\",\n \"bankTransitNumber\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"companyName\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/customers/:customerId/bank-accounts", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":customerId", "bank-accounts" ], "variable": [ { "key": "customerId" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"message\": \"\",\n \"bankAccount\": {\n \"id\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-7332f249-430a-46e8-8de5-17910b0d7d89" }, { "id": "204b7594-036f-4845-9e5e-690f9a353cf0", "name": "Invalid request.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "api-token", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"accountCorporate\": 2,\n \"accountType\": 1,\n \"bankAccountNumber\": \"\",\n \"city\": \"\",\n \"countryAlpha2\": \"\",\n \"postalCode\": \"\",\n \"provinceAlpha2\": \"\",\n \"streetAddress\": \"\",\n \"bankFinancialNumber\": \"\",\n \"bankRoutingNumber\": \"\",\n \"bankTransitNumber\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"companyName\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/customers/:customerId/bank-accounts", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":customerId", "bank-accounts" ], "variable": [ { "key": "customerId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-204b7594-036f-4845-9e5e-690f9a353cf0" }, { "id": "da1f1d86-fbeb-410c-8312-b5e5620a0997", "name": "User does not have valid permissions.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "api-token", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"accountCorporate\": 2,\n \"accountType\": 1,\n \"bankAccountNumber\": \"\",\n \"city\": \"\",\n \"countryAlpha2\": \"\",\n \"postalCode\": \"\",\n \"provinceAlpha2\": \"\",\n \"streetAddress\": \"\",\n \"bankFinancialNumber\": \"\",\n \"bankRoutingNumber\": \"\",\n \"bankTransitNumber\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"companyName\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/customers/:customerId/bank-accounts", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":customerId", "bank-accounts" ], "variable": [ { "key": "customerId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-da1f1d86-fbeb-410c-8312-b5e5620a0997" }, { "id": "c3826c3d-27fb-4378-b242-fdde052c1a95", "name": "Unexpected internal error.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "api-token", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"accountCorporate\": 2,\n \"accountType\": 1,\n \"bankAccountNumber\": \"\",\n \"city\": \"\",\n \"countryAlpha2\": \"\",\n \"postalCode\": \"\",\n \"provinceAlpha2\": \"\",\n \"streetAddress\": \"\",\n \"bankFinancialNumber\": \"\",\n \"bankRoutingNumber\": \"\",\n \"bankTransitNumber\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"companyName\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/customers/:customerId/bank-accounts", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":customerId", "bank-accounts" ], "variable": [ { "key": "customerId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-c3826c3d-27fb-4378-b242-fdde052c1a95" } ], "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-b15b280a-6c84-4cf8-b933-a011241fdd56" } ], "id": "a707f76b-32c3-46fc-93cf-b0aaf70255f3", "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-a707f76b-32c3-46fc-93cf-b0aaf70255f3" }, { "name": "Get customer", "id": "554c1bf7-a726-4f1c-ba7d-2b46d5b0e559", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api-token", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/customers/:customerId", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":customerId" ], "variable": [ { "id": "3a29cd12-8a80-46fe-b8e8-fb7752ad05f8", "key": "customerId", "value": "", "description": "(Required) The Id of the customer" } ] } }, "response": [ { "id": "a4ad9ef0-45b5-431b-ba43-20a264158775", "name": "Successful", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "api-token", "value": "" } ], "url": { "raw": "{{baseUrl}}/customers/:customerId", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":customerId" ], "variable": [ { "key": "customerId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"customerCode\": \"\",\n \"businessName\": \"\",\n \"contactName\": \"\",\n \"cellPhone\": \"\",\n \"billingAddress\": {\n \"name\": \"\",\n \"street1\": \"\",\n \"postalCode\": \"\",\n \"street2\": \"\",\n \"city\": \"\",\n \"province\": \"\",\n \"country\": \"\",\n \"phone\": \"\",\n \"email\": \"\"\n },\n \"shippingAddress\": {\n \"name\": \"\",\n \"street1\": \"\",\n \"postalCode\": \"\",\n \"street2\": \"\",\n \"city\": \"\",\n \"province\": \"\",\n \"country\": \"\",\n \"phone\": \"\",\n \"email\": \"\"\n },\n \"cards\": [\n {\n \"cardHolderName\": \"\",\n \"cardF6L4\": \"\",\n \"cardToken\": \"\"\n },\n {\n \"cardHolderName\": \"\",\n \"cardF6L4\": \"\",\n \"cardToken\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-a4ad9ef0-45b5-431b-ba43-20a264158775" }, { "id": "210c4287-b247-4ba0-bb14-55ee9e1f1eb8", "name": "Failed", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "api-token", "value": "" } ], "url": { "raw": "{{baseUrl}}/customers/:customerId", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":customerId" ], "variable": [ { "key": "customerId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-210c4287-b247-4ba0-bb14-55ee9e1f1eb8" } ], "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-554c1bf7-a726-4f1c-ba7d-2b46d5b0e559" }, { "name": "Update customer", "id": "89b9029e-af26-45b8-92f7-43a3ee12e903", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api-token", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"customerCode\": \"\",\n \"contactName\": \"\",\n \"businessName\": \"\",\n \"cellPhone\": \"\",\n \"billingAddress\": {\n \"name\": \"\",\n \"street1\": \"\",\n \"postalCode\": \"\",\n \"street2\": \"\",\n \"city\": \"\",\n \"province\": \"\",\n \"country\": \"\",\n \"phone\": \"\",\n \"email\": \"\"\n },\n \"shippingAddress\": {\n \"name\": \"\",\n \"street1\": \"\",\n \"postalCode\": \"\",\n \"street2\": \"\",\n \"city\": \"\",\n \"province\": \"\",\n \"country\": \"\",\n \"phone\": \"\",\n \"email\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/customers/:customerId", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":customerId" ], "variable": [ { "id": "a320284c-4bdd-4dbe-8274-01d099facfbc", "key": "customerId", "value": "", "description": "(Required) The Id of the customer" } ] } }, "response": [ { "id": "62acbdc8-f4b3-4438-9d8c-2b565d33e161", "name": "Successful", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "api-token", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"customerCode\": \"\",\n \"contactName\": \"\",\n \"businessName\": \"\",\n \"cellPhone\": \"\",\n \"billingAddress\": {\n \"name\": \"\",\n \"street1\": \"\",\n \"postalCode\": \"\",\n \"street2\": \"\",\n \"city\": \"\",\n \"province\": \"\",\n \"country\": \"\",\n \"phone\": \"\",\n \"email\": \"\"\n },\n \"shippingAddress\": {\n \"name\": \"\",\n \"street1\": \"\",\n \"postalCode\": \"\",\n \"street2\": \"\",\n \"city\": \"\",\n \"province\": \"\",\n \"country\": \"\",\n \"phone\": \"\",\n \"email\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/customers/:customerId", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":customerId" ], "variable": [ { "key": "customerId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"customerCode\": \"\",\n \"businessName\": \"\",\n \"contactName\": \"\",\n \"cellPhone\": \"\",\n \"billingAddress\": {\n \"name\": \"\",\n \"street1\": \"\",\n \"postalCode\": \"\",\n \"street2\": \"\",\n \"city\": \"\",\n \"province\": \"\",\n \"country\": \"\",\n \"phone\": \"\",\n \"email\": \"\"\n },\n \"shippingAddress\": {\n \"name\": \"\",\n \"street1\": \"\",\n \"postalCode\": \"\",\n \"street2\": \"\",\n \"city\": \"\",\n \"province\": \"\",\n \"country\": \"\",\n \"phone\": \"\",\n \"email\": \"\"\n },\n \"cards\": [\n {\n \"cardHolderName\": \"\",\n \"cardF6L4\": \"\",\n \"cardToken\": \"\"\n },\n {\n \"cardHolderName\": \"\",\n \"cardF6L4\": \"\",\n \"cardToken\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-62acbdc8-f4b3-4438-9d8c-2b565d33e161" }, { "id": "ade0dbba-a43e-4999-8ed3-4df934e6a4a9", "name": "Failed", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "api-token", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"customerCode\": \"\",\n \"contactName\": \"\",\n \"businessName\": \"\",\n \"cellPhone\": \"\",\n \"billingAddress\": {\n \"name\": \"\",\n \"street1\": \"\",\n \"postalCode\": \"\",\n \"street2\": \"\",\n \"city\": \"\",\n \"province\": \"\",\n \"country\": \"\",\n \"phone\": \"\",\n \"email\": \"\"\n },\n \"shippingAddress\": {\n \"name\": \"\",\n \"street1\": \"\",\n \"postalCode\": \"\",\n \"street2\": \"\",\n \"city\": \"\",\n \"province\": \"\",\n \"country\": \"\",\n \"phone\": \"\",\n \"email\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/customers/:customerId", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":customerId" ], "variable": [ { "key": "customerId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-ade0dbba-a43e-4999-8ed3-4df934e6a4a9" } ], "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-89b9029e-af26-45b8-92f7-43a3ee12e903" } ], "id": "cffb834b-82a3-498c-8163-8f1bae7a6ded", "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-cffb834b-82a3-498c-8163-8f1bae7a6ded" }, { "name": "Get customers", "id": "2e1c03d9-d802-4d29-b4dd-5917d595125d", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api-token", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/customers?search=&customerCode=&limit=&page=&includeCards=", "host": [ "{{baseUrl}}" ], "path": [ "customers" ], "query": [ { "description": "The search term to be used for partial matching on contactName, businessName, customerCode, city, phone and email (Only use one query field per request).", "key": "search", "value": "" }, { "description": "Existing customer code (Only use one query field per request).", "key": "customerCode", "value": "" }, { "description": "The limit number of customers will be returned in one request. We only allow maximum 100 objects per request. If no limit specified, the default limit will be 100 objects.", "key": "limit", "value": "" }, { "description": "Specifies the page number of the results you want to retrieve.", "key": "page", "value": "" }, { "description": "Specifies whether to return any credit cards for retrieved customers. By default no cards are returned.\n * `yes` - return all available cards for retrieved customers.\n", "key": "includeCards", "value": "" } ] } }, "response": [ { "id": "092ce994-cba9-418f-91ab-5c0a2bac673c", "name": "Successful", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "api-token", "value": "" } ], "url": { "raw": "{{baseUrl}}/customers?search=&customerCode=&limit=&page=&includeCards=", "host": [ "{{baseUrl}}" ], "path": [ "customers" ], "query": [ { "description": "The search term to be used for partial matching on contactName, businessName, customerCode, city, phone and email (Only use one query field per request).", "key": "search", "value": "" }, { "description": "Existing customer code (Only use one query field per request).", "key": "customerCode", "value": "" }, { "description": "The limit number of customers will be returned in one request. We only allow maximum 100 objects per request. If no limit specified, the default limit will be 100 objects.", "key": "limit", "value": "" }, { "description": "Specifies the page number of the results you want to retrieve.", "key": "page", "value": "" }, { "description": "Specifies whether to return any credit cards for retrieved customers. By default no cards are returned.\n * `yes` - return all available cards for retrieved customers.\n", "key": "includeCards", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"id\": \"\",\n \"customerCode\": \"\",\n \"businessName\": \"\",\n \"contactName\": \"\",\n \"cellPhone\": \"\",\n \"billingAddress\": {\n \"name\": \"\",\n \"street1\": \"\",\n \"postalCode\": \"\",\n \"street2\": \"\",\n \"city\": \"\",\n \"province\": \"\",\n \"country\": \"\",\n \"phone\": \"\",\n \"email\": \"\"\n },\n \"shippingAddress\": {\n \"name\": \"\",\n \"street1\": \"\",\n \"postalCode\": \"\",\n \"street2\": \"\",\n \"city\": \"\",\n \"province\": \"\",\n \"country\": \"\",\n \"phone\": \"\",\n \"email\": \"\"\n },\n \"cards\": [\n {\n \"cardHolderName\": \"\",\n \"cardF6L4\": \"\",\n \"cardToken\": \"\"\n },\n {\n \"cardHolderName\": \"\",\n \"cardF6L4\": \"\",\n \"cardToken\": \"\"\n }\n ]\n },\n {\n \"id\": \"\",\n \"customerCode\": \"\",\n \"businessName\": \"\",\n \"contactName\": \"\",\n \"cellPhone\": \"\",\n \"billingAddress\": {\n \"name\": \"\",\n \"street1\": \"\",\n \"postalCode\": \"\",\n \"street2\": \"\",\n \"city\": \"\",\n \"province\": \"\",\n \"country\": \"\",\n \"phone\": \"\",\n \"email\": \"\"\n },\n \"shippingAddress\": {\n \"name\": \"\",\n \"street1\": \"\",\n \"postalCode\": \"\",\n \"street2\": \"\",\n \"city\": \"\",\n \"province\": \"\",\n \"country\": \"\",\n \"phone\": \"\",\n \"email\": \"\"\n },\n \"cards\": [\n {\n \"cardHolderName\": \"\",\n \"cardF6L4\": \"\",\n \"cardToken\": \"\"\n },\n {\n \"cardHolderName\": \"\",\n \"cardF6L4\": \"\",\n \"cardToken\": \"\"\n }\n ]\n }\n]", "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-092ce994-cba9-418f-91ab-5c0a2bac673c" }, { "id": "59349362-3f6b-420b-a2a7-bc1ab5bf1841", "name": "Failed", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "api-token", "value": "" } ], "url": { "raw": "{{baseUrl}}/customers?search=&customerCode=&limit=&page=&includeCards=", "host": [ "{{baseUrl}}" ], "path": [ "customers" ], "query": [ { "description": "The search term to be used for partial matching on contactName, businessName, customerCode, city, phone and email (Only use one query field per request).", "key": "search", "value": "" }, { "description": "Existing customer code (Only use one query field per request).", "key": "customerCode", "value": "" }, { "description": "The limit number of customers will be returned in one request. We only allow maximum 100 objects per request. If no limit specified, the default limit will be 100 objects.", "key": "limit", "value": "" }, { "description": "Specifies the page number of the results you want to retrieve.", "key": "page", "value": "" }, { "description": "Specifies whether to return any credit cards for retrieved customers. By default no cards are returned.\n * `yes` - return all available cards for retrieved customers.\n", "key": "includeCards", "value": "" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-59349362-3f6b-420b-a2a7-bc1ab5bf1841" } ], "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-2e1c03d9-d802-4d29-b4dd-5917d595125d" }, { "name": "Create customer", "id": "21974901-d0d7-4299-8692-47fbb7031016", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api-token", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"customerCode\": \"\",\n \"contactName\": \"\",\n \"businessName\": \"\",\n \"cellPhone\": \"\",\n \"billingAddress\": {\n \"name\": \"\",\n \"street1\": \"\",\n \"postalCode\": \"\",\n \"street2\": \"\",\n \"city\": \"\",\n \"province\": \"\",\n \"country\": \"\",\n \"phone\": \"\",\n \"email\": \"\"\n },\n \"shippingAddress\": {\n \"name\": \"\",\n \"street1\": \"\",\n \"postalCode\": \"\",\n \"street2\": \"\",\n \"city\": \"\",\n \"province\": \"\",\n \"country\": \"\",\n \"phone\": \"\",\n \"email\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/customers", "host": [ "{{baseUrl}}" ], "path": [ "customers" ] } }, "response": [ { "id": "ebe276d4-a34f-4f21-b49e-0b6839c1d98e", "name": "Successful", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "api-token", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"customerCode\": \"\",\n \"contactName\": \"\",\n \"businessName\": \"\",\n \"cellPhone\": \"\",\n \"billingAddress\": {\n \"name\": \"\",\n \"street1\": \"\",\n \"postalCode\": \"\",\n \"street2\": \"\",\n \"city\": \"\",\n \"province\": \"\",\n \"country\": \"\",\n \"phone\": \"\",\n \"email\": \"\"\n },\n \"shippingAddress\": {\n \"name\": \"\",\n \"street1\": \"\",\n \"postalCode\": \"\",\n \"street2\": \"\",\n \"city\": \"\",\n \"province\": \"\",\n \"country\": \"\",\n \"phone\": \"\",\n \"email\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/customers", "host": [ "{{baseUrl}}" ], "path": [ "customers" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"customerCode\": \"\",\n \"businessName\": \"\",\n \"contactName\": \"\",\n \"cellPhone\": \"\",\n \"billingAddress\": {\n \"name\": \"\",\n \"street1\": \"\",\n \"postalCode\": \"\",\n \"street2\": \"\",\n \"city\": \"\",\n \"province\": \"\",\n \"country\": \"\",\n \"phone\": \"\",\n \"email\": \"\"\n },\n \"shippingAddress\": {\n \"name\": \"\",\n \"street1\": \"\",\n \"postalCode\": \"\",\n \"street2\": \"\",\n \"city\": \"\",\n \"province\": \"\",\n \"country\": \"\",\n \"phone\": \"\",\n \"email\": \"\"\n },\n \"cards\": [\n {\n \"cardHolderName\": \"\",\n \"cardF6L4\": \"\",\n \"cardToken\": \"\"\n },\n {\n \"cardHolderName\": \"\",\n \"cardF6L4\": \"\",\n \"cardToken\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-ebe276d4-a34f-4f21-b49e-0b6839c1d98e" }, { "id": "795f2821-e457-4fd1-9d87-3a85d1702817", "name": "Failed", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "api-token", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"customerCode\": \"\",\n \"contactName\": \"\",\n \"businessName\": \"\",\n \"cellPhone\": \"\",\n \"billingAddress\": {\n \"name\": \"\",\n \"street1\": \"\",\n \"postalCode\": \"\",\n \"street2\": \"\",\n \"city\": \"\",\n \"province\": \"\",\n \"country\": \"\",\n \"phone\": \"\",\n \"email\": \"\"\n },\n \"shippingAddress\": {\n \"name\": \"\",\n \"street1\": \"\",\n \"postalCode\": \"\",\n \"street2\": \"\",\n \"city\": \"\",\n \"province\": \"\",\n \"country\": \"\",\n \"phone\": \"\",\n \"email\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/customers", "host": [ "{{baseUrl}}" ], "path": [ "customers" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-795f2821-e457-4fd1-9d87-3a85d1702817" } ], "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-21974901-d0d7-4299-8692-47fbb7031016" } ], "id": "d1a6613f-0627-43aa-bb08-b14a609aa4fe", "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-d1a6613f-0627-43aa-bb08-b14a609aa4fe" }, { "name": "invoices", "item": [ { "name": "{invoiceId}", "item": [ { "name": "Get invoice", "id": "11eec988-b03b-420a-99ad-30fccb35ca17", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api-token", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/invoices/:invoiceId", "host": [ "{{baseUrl}}" ], "path": [ "invoices", ":invoiceId" ], "variable": [ { "id": "e8f5b7d8-b7e8-486a-a975-f7190ed87f91", "key": "invoiceId", "value": "", "description": "(Required) The unique ID of the invoice to retrieve." } ] } }, "response": [ { "id": "f5028d0f-2064-4524-a8b1-2ca359f78b12", "name": "Successful", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "api-token", "value": "" } ], "url": { "raw": "{{baseUrl}}/invoices/:invoiceId", "host": [ "{{baseUrl}}" ], "path": [ "invoices", ":invoiceId" ], "variable": [ { "key": "invoiceId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"invoiceId\": \"\",\n \"invoiceNumber\": \"\",\n \"token\": \"\",\n \"type\": \"\",\n \"status\": \"\",\n \"currency\": \"\",\n \"customerId\": \"\",\n \"billingAddress\": {\n \"name\": \"\",\n \"street1\": \"\",\n \"postalCode\": \"\",\n \"street2\": \"\",\n \"city\": \"\",\n \"province\": \"\",\n \"country\": \"\",\n \"phone\": \"\",\n \"email\": \"\"\n },\n \"shipping\": {\n \"amount\": \"\",\n \"details\": \"\",\n \"address\": {\n \"name\": \"\",\n \"street1\": \"\",\n \"postalCode\": \"\",\n \"street2\": \"\",\n \"city\": \"\",\n \"province\": \"\",\n \"country\": \"\",\n \"phone\": \"\",\n \"email\": \"\"\n }\n },\n \"pickup\": {\n \"date\": \"\",\n \"name\": \"\"\n },\n \"tax\": {\n \"amount\": \"\",\n \"details\": \"\"\n },\n \"discount\": {\n \"amount\": \"\",\n \"details\": \"\"\n },\n \"lineItems\": [\n {\n \"description\": \"\",\n \"quantity\": \"\",\n \"price\": \"\",\n \"taxAmount\": \"\",\n \"discountAmount\": \"\",\n \"sku\": \"\"\n },\n {\n \"description\": \"\",\n \"quantity\": \"\",\n \"price\": \"\",\n \"taxAmount\": \"\",\n \"discountAmount\": \"\",\n \"sku\": \"\"\n }\n ],\n \"dateCreated\": \"\",\n \"dateUpdated\": \"\",\n \"datePaid\": \"\",\n \"dateIssued\": \"\",\n \"amount\": \"\",\n \"amountPaid\": \"\",\n \"amountDue\": \"\",\n \"tipAmount\": \"\",\n \"depositAmount\": \"\",\n \"convenienceFee\": \"\",\n \"convenienceFeeEnabled\": \"\",\n \"surchargingFee\": \"\",\n \"orderFields\": [\n {\n \"displayName\": \"\",\n \"value\": \"\"\n },\n {\n \"displayName\": \"\",\n \"value\": \"\"\n }\n ],\n \"notes\": \"\"\n}", "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-f5028d0f-2064-4524-a8b1-2ca359f78b12" }, { "id": "d881596f-6c92-4271-8e21-8983bf05c5a1", "name": "Failed", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "api-token", "value": "" } ], "url": { "raw": "{{baseUrl}}/invoices/:invoiceId", "host": [ "{{baseUrl}}" ], "path": [ "invoices", ":invoiceId" ], "variable": [ { "key": "invoiceId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-d881596f-6c92-4271-8e21-8983bf05c5a1" } ], "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-11eec988-b03b-420a-99ad-30fccb35ca17" }, { "name": "Update invoice", "id": "e76c31c3-d714-46ce-9759-362dc0271ffc", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api-token", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"currency\": \"USD\",\n \"lineItems\": [\n {\n \"description\": \"\",\n \"quantity\": \"\",\n \"price\": \"\",\n \"taxAmount\": \"\",\n \"discountAmount\": \"\",\n \"sku\": \"\"\n }\n ],\n \"customerId\": 0,\n \"billingAddress\": {\n \"name\": \"\",\n \"street1\": \"\",\n \"postalCode\": \"\",\n \"street2\": \"\",\n \"city\": \"\",\n \"province\": \"\",\n \"country\": \"\",\n \"phone\": \"\",\n \"email\": \"\"\n },\n \"shipping\": {\n \"amount\": \"\",\n \"details\": \"\",\n \"address\": {\n \"name\": \"\",\n \"street1\": \"\",\n \"postalCode\": \"\",\n \"street2\": \"\",\n \"city\": \"\",\n \"province\": \"\",\n \"country\": \"\",\n \"phone\": \"\",\n \"email\": \"\"\n }\n },\n \"pickup\": {\n \"date\": \"\",\n \"name\": \"\"\n },\n \"tax\": {\n \"amount\": \"\",\n \"details\": \"\"\n },\n \"discount\": {\n \"amount\": \"\",\n \"details\": \"\"\n },\n \"type\": \"INVOICE\",\n \"status\": \"DUE\",\n \"convenienceFeeEnabled\": \"\",\n \"tipAmount\": \"\",\n \"invoiceNumber\": \"\",\n \"notes\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/invoices/:invoiceId", "host": [ "{{baseUrl}}" ], "path": [ "invoices", ":invoiceId" ], "variable": [ { "id": "644dc220-5bd1-461d-8185-1719e6131248", "key": "invoiceId", "value": "", "description": "(Required) The unique invoice Id" } ] } }, "response": [ { "id": "c1fad6ba-805d-4201-8536-7054790025bf", "name": "Successful", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "api-token", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"currency\": \"USD\",\n \"lineItems\": [\n {\n \"description\": \"\",\n \"quantity\": \"\",\n \"price\": \"\",\n \"taxAmount\": \"\",\n \"discountAmount\": \"\",\n \"sku\": \"\"\n }\n ],\n \"customerId\": 0,\n \"billingAddress\": {\n \"name\": \"\",\n \"street1\": \"\",\n \"postalCode\": \"\",\n \"street2\": \"\",\n \"city\": \"\",\n \"province\": \"\",\n \"country\": \"\",\n \"phone\": \"\",\n \"email\": \"\"\n },\n \"shipping\": {\n \"amount\": \"\",\n \"details\": \"\",\n \"address\": {\n \"name\": \"\",\n \"street1\": \"\",\n \"postalCode\": \"\",\n \"street2\": \"\",\n \"city\": \"\",\n \"province\": \"\",\n \"country\": \"\",\n \"phone\": \"\",\n \"email\": \"\"\n }\n },\n \"pickup\": {\n \"date\": \"\",\n \"name\": \"\"\n },\n \"tax\": {\n \"amount\": \"\",\n \"details\": \"\"\n },\n \"discount\": {\n \"amount\": \"\",\n \"details\": \"\"\n },\n \"type\": \"INVOICE\",\n \"status\": \"DUE\",\n \"convenienceFeeEnabled\": \"\",\n \"tipAmount\": \"\",\n \"invoiceNumber\": \"\",\n \"notes\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/invoices/:invoiceId", "host": [ "{{baseUrl}}" ], "path": [ "invoices", ":invoiceId" ], "variable": [ { "key": "invoiceId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"invoiceId\": \"\",\n \"invoiceNumber\": \"\",\n \"token\": \"\",\n \"type\": \"\",\n \"status\": \"\",\n \"currency\": \"\",\n \"customerId\": \"\",\n \"billingAddress\": {\n \"name\": \"\",\n \"street1\": \"\",\n \"postalCode\": \"\",\n \"street2\": \"\",\n \"city\": \"\",\n \"province\": \"\",\n \"country\": \"\",\n \"phone\": \"\",\n \"email\": \"\"\n },\n \"shipping\": {\n \"amount\": \"\",\n \"details\": \"\",\n \"address\": {\n \"name\": \"\",\n \"street1\": \"\",\n \"postalCode\": \"\",\n \"street2\": \"\",\n \"city\": \"\",\n \"province\": \"\",\n \"country\": \"\",\n \"phone\": \"\",\n \"email\": \"\"\n }\n },\n \"pickup\": {\n \"date\": \"\",\n \"name\": \"\"\n },\n \"tax\": {\n \"amount\": \"\",\n \"details\": \"\"\n },\n \"discount\": {\n \"amount\": \"\",\n \"details\": \"\"\n },\n \"lineItems\": [\n {\n \"description\": \"\",\n \"quantity\": \"\",\n \"price\": \"\",\n \"taxAmount\": \"\",\n \"discountAmount\": \"\",\n \"sku\": \"\"\n },\n {\n \"description\": \"\",\n \"quantity\": \"\",\n \"price\": \"\",\n \"taxAmount\": \"\",\n \"discountAmount\": \"\",\n \"sku\": \"\"\n }\n ],\n \"dateCreated\": \"\",\n \"dateUpdated\": \"\",\n \"datePaid\": \"\",\n \"dateIssued\": \"\",\n \"amount\": \"\",\n \"amountPaid\": \"\",\n \"amountDue\": \"\",\n \"tipAmount\": \"\",\n \"depositAmount\": \"\",\n \"convenienceFee\": \"\",\n \"convenienceFeeEnabled\": \"\",\n \"surchargingFee\": \"\",\n \"orderFields\": [\n {\n \"displayName\": \"\",\n \"value\": \"\"\n },\n {\n \"displayName\": \"\",\n \"value\": \"\"\n }\n ],\n \"notes\": \"\"\n}", "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-c1fad6ba-805d-4201-8536-7054790025bf" }, { "id": "9cd0f2a2-30f8-481d-98e5-4ac8a4ad7f27", "name": "Failed", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "api-token", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"currency\": \"USD\",\n \"lineItems\": [\n {\n \"description\": \"\",\n \"quantity\": \"\",\n \"price\": \"\",\n \"taxAmount\": \"\",\n \"discountAmount\": \"\",\n \"sku\": \"\"\n }\n ],\n \"customerId\": 0,\n \"billingAddress\": {\n \"name\": \"\",\n \"street1\": \"\",\n \"postalCode\": \"\",\n \"street2\": \"\",\n \"city\": \"\",\n \"province\": \"\",\n \"country\": \"\",\n \"phone\": \"\",\n \"email\": \"\"\n },\n \"shipping\": {\n \"amount\": \"\",\n \"details\": \"\",\n \"address\": {\n \"name\": \"\",\n \"street1\": \"\",\n \"postalCode\": \"\",\n \"street2\": \"\",\n \"city\": \"\",\n \"province\": \"\",\n \"country\": \"\",\n \"phone\": \"\",\n \"email\": \"\"\n }\n },\n \"pickup\": {\n \"date\": \"\",\n \"name\": \"\"\n },\n \"tax\": {\n \"amount\": \"\",\n \"details\": \"\"\n },\n \"discount\": {\n \"amount\": \"\",\n \"details\": \"\"\n },\n \"type\": \"INVOICE\",\n \"status\": \"DUE\",\n \"convenienceFeeEnabled\": \"\",\n \"tipAmount\": \"\",\n \"invoiceNumber\": \"\",\n \"notes\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/invoices/:invoiceId", "host": [ "{{baseUrl}}" ], "path": [ "invoices", ":invoiceId" ], "variable": [ { "key": "invoiceId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-9cd0f2a2-30f8-481d-98e5-4ac8a4ad7f27" } ], "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-e76c31c3-d714-46ce-9759-362dc0271ffc" } ], "id": "0a78e45d-ce41-4b58-b624-688672a7b2d6", "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-0a78e45d-ce41-4b58-b624-688672a7b2d6" }, { "name": "Create invoice", "id": "5d57ae0e-7c2b-46bf-b8f0-262854e427a7", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api-token", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"currency\": \"USD\",\n \"lineItems\": [\n {\n \"description\": \"\",\n \"quantity\": \"\",\n \"price\": \"\",\n \"taxAmount\": \"\",\n \"discountAmount\": \"\",\n \"sku\": \"\"\n }\n ],\n \"customerId\": 0,\n \"billingAddress\": {\n \"name\": \"\",\n \"street1\": \"\",\n \"postalCode\": \"\",\n \"street2\": \"\",\n \"city\": \"\",\n \"province\": \"\",\n \"country\": \"\",\n \"phone\": \"\",\n \"email\": \"\"\n },\n \"shipping\": {\n \"amount\": \"\",\n \"details\": \"\",\n \"address\": {\n \"name\": \"\",\n \"street1\": \"\",\n \"postalCode\": \"\",\n \"street2\": \"\",\n \"city\": \"\",\n \"province\": \"\",\n \"country\": \"\",\n \"phone\": \"\",\n \"email\": \"\"\n }\n },\n \"pickup\": {\n \"date\": \"\",\n \"name\": \"\"\n },\n \"tax\": {\n \"amount\": \"\",\n \"details\": \"\"\n },\n \"discount\": {\n \"amount\": \"\",\n \"details\": \"\"\n },\n \"type\": \"INVOICE\",\n \"status\": \"DUE\",\n \"convenienceFeeEnabled\": \"\",\n \"tipAmount\": \"\",\n \"invoiceNumber\": \"\",\n \"notes\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/invoices", "host": [ "{{baseUrl}}" ], "path": [ "invoices" ] } }, "response": [ { "id": "b00ccba6-6233-4561-8b7c-e5bd587a11e1", "name": "Successful", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "api-token", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"currency\": \"USD\",\n \"lineItems\": [\n {\n \"description\": \"\",\n \"quantity\": \"\",\n \"price\": \"\",\n \"taxAmount\": \"\",\n \"discountAmount\": \"\",\n \"sku\": \"\"\n }\n ],\n \"customerId\": 0,\n \"billingAddress\": {\n \"name\": \"\",\n \"street1\": \"\",\n \"postalCode\": \"\",\n \"street2\": \"\",\n \"city\": \"\",\n \"province\": \"\",\n \"country\": \"\",\n \"phone\": \"\",\n \"email\": \"\"\n },\n \"shipping\": {\n \"amount\": \"\",\n \"details\": \"\",\n \"address\": {\n \"name\": \"\",\n \"street1\": \"\",\n \"postalCode\": \"\",\n \"street2\": \"\",\n \"city\": \"\",\n \"province\": \"\",\n \"country\": \"\",\n \"phone\": \"\",\n \"email\": \"\"\n }\n },\n \"pickup\": {\n \"date\": \"\",\n \"name\": \"\"\n },\n \"tax\": {\n \"amount\": \"\",\n \"details\": \"\"\n },\n \"discount\": {\n \"amount\": \"\",\n \"details\": \"\"\n },\n \"type\": \"INVOICE\",\n \"status\": \"DUE\",\n \"convenienceFeeEnabled\": \"\",\n \"tipAmount\": \"\",\n \"invoiceNumber\": \"\",\n \"notes\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/invoices", "host": [ "{{baseUrl}}" ], "path": [ "invoices" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"invoiceId\": \"\",\n \"invoiceNumber\": \"\",\n \"token\": \"\",\n \"type\": \"\",\n \"status\": \"\",\n \"currency\": \"\",\n \"customerId\": \"\",\n \"billingAddress\": {\n \"name\": \"\",\n \"street1\": \"\",\n \"postalCode\": \"\",\n \"street2\": \"\",\n \"city\": \"\",\n \"province\": \"\",\n \"country\": \"\",\n \"phone\": \"\",\n \"email\": \"\"\n },\n \"shipping\": {\n \"amount\": \"\",\n \"details\": \"\",\n \"address\": {\n \"name\": \"\",\n \"street1\": \"\",\n \"postalCode\": \"\",\n \"street2\": \"\",\n \"city\": \"\",\n \"province\": \"\",\n \"country\": \"\",\n \"phone\": \"\",\n \"email\": \"\"\n }\n },\n \"pickup\": {\n \"date\": \"\",\n \"name\": \"\"\n },\n \"tax\": {\n \"amount\": \"\",\n \"details\": \"\"\n },\n \"discount\": {\n \"amount\": \"\",\n \"details\": \"\"\n },\n \"lineItems\": [\n {\n \"description\": \"\",\n \"quantity\": \"\",\n \"price\": \"\",\n \"taxAmount\": \"\",\n \"discountAmount\": \"\",\n \"sku\": \"\"\n },\n {\n \"description\": \"\",\n \"quantity\": \"\",\n \"price\": \"\",\n \"taxAmount\": \"\",\n \"discountAmount\": \"\",\n \"sku\": \"\"\n }\n ],\n \"dateCreated\": \"\",\n \"dateUpdated\": \"\",\n \"datePaid\": \"\",\n \"dateIssued\": \"\",\n \"amount\": \"\",\n \"amountPaid\": \"\",\n \"amountDue\": \"\",\n \"tipAmount\": \"\",\n \"depositAmount\": \"\",\n \"convenienceFee\": \"\",\n \"convenienceFeeEnabled\": \"\",\n \"surchargingFee\": \"\",\n \"orderFields\": [\n {\n \"displayName\": \"\",\n \"value\": \"\"\n },\n {\n \"displayName\": \"\",\n \"value\": \"\"\n }\n ],\n \"notes\": \"\"\n}", "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-b00ccba6-6233-4561-8b7c-e5bd587a11e1" }, { "id": "e3be29c5-8265-4c9f-9f81-f183b159a6c3", "name": "Failed", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "api-token", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"currency\": \"USD\",\n \"lineItems\": [\n {\n \"description\": \"\",\n \"quantity\": \"\",\n \"price\": \"\",\n \"taxAmount\": \"\",\n \"discountAmount\": \"\",\n \"sku\": \"\"\n }\n ],\n \"customerId\": 0,\n \"billingAddress\": {\n \"name\": \"\",\n \"street1\": \"\",\n \"postalCode\": \"\",\n \"street2\": \"\",\n \"city\": \"\",\n \"province\": \"\",\n \"country\": \"\",\n \"phone\": \"\",\n \"email\": \"\"\n },\n \"shipping\": {\n \"amount\": \"\",\n \"details\": \"\",\n \"address\": {\n \"name\": \"\",\n \"street1\": \"\",\n \"postalCode\": \"\",\n \"street2\": \"\",\n \"city\": \"\",\n \"province\": \"\",\n \"country\": \"\",\n \"phone\": \"\",\n \"email\": \"\"\n }\n },\n \"pickup\": {\n \"date\": \"\",\n \"name\": \"\"\n },\n \"tax\": {\n \"amount\": \"\",\n \"details\": \"\"\n },\n \"discount\": {\n \"amount\": \"\",\n \"details\": \"\"\n },\n \"type\": \"INVOICE\",\n \"status\": \"DUE\",\n \"convenienceFeeEnabled\": \"\",\n \"tipAmount\": \"\",\n \"invoiceNumber\": \"\",\n \"notes\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/invoices", "host": [ "{{baseUrl}}" ], "path": [ "invoices" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-e3be29c5-8265-4c9f-9f81-f183b159a6c3" } ], "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-5d57ae0e-7c2b-46bf-b8f0-262854e427a7" }, { "name": "Get invoices", "id": "30fff7c3-842e-46e0-9e35-8a4cb0e08b80", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api-token", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/invoices?page=&dateStart=&dateEnd=&invoiceNumber=&customerId=&status=APPROVED&type=ORDER¤cy=CAD&withConvenienceFee=1&withOrderFields=1&convenienceFeeEnabled=1", "host": [ "{{baseUrl}}" ], "path": [ "invoices" ], "query": [ { "description": "Page number for paginated results. Defaults to the first page if omitted.\n", "key": "page", "value": "" }, { "description": "Filter invoices created on or after this date or date-time. Format: `YYYY-MM-DD` or `YYYY-MM-DD HH:MM:SS`. If time is omitted, `00:00:00` is assumed. If `dateEnd` is provided, it must not be earlier than `dateStart`.\n", "key": "dateStart", "value": "" }, { "description": "Filter invoices created on or before this date or date-time. Format: `YYYY-MM-DD` or `YYYY-MM-DD HH:MM:SS`. If time is omitted, `23:59:59` is assumed. If `dateStart` is provided, `dateEnd` must not be earlier than `dateStart`.\n", "key": "dateEnd", "value": "" }, { "description": "Filter invoices by the exact invoice number. Matches exactly (case-insensitive). If no match exists, no invoices are returned.\n", "key": "invoiceNumber", "value": "" }, { "description": "Filter invoices by customer ID.\n", "key": "customerId", "value": "" }, { "description": "Filter invoices by status.\n", "key": "status", "value": "APPROVED" }, { "description": "Filter invoices by type.\n", "key": "type", "value": "ORDER" }, { "description": "Filter invoices by currency code.\n", "key": "currency", "value": "CAD" }, { "description": "Include the convenience fee for each invoice. If `1`, the convenience fee is included in the response. If `0` or omitted, the convenience fee is set to 0.\n", "key": "withConvenienceFee", "value": "1" }, { "description": "Include custom field values for each invoice. If `1`, the `orderFields` array for each invoice is populated. If `0` or omitted, `orderFields` is always an empty array.\n", "key": "withOrderFields", "value": "1" }, { "description": "Filter invoices by whether the convenience fee is enabled. If `1`, return all invoices with the convenience fee enabled. If `0`, return all invoices with the convenience fee disabled. If omitted, no filter is applied.\n", "key": "convenienceFeeEnabled", "value": "1" } ] } }, "response": [ { "id": "8b6ead3e-e4d3-47d0-b5a5-09509dbefe1b", "name": "Successful", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "api-token", "value": "" } ], "url": { "raw": "{{baseUrl}}/invoices?page=&dateStart=&dateEnd=&invoiceNumber=&customerId=&status=APPROVED&type=ORDER¤cy=CAD&withConvenienceFee=1&withOrderFields=1&convenienceFeeEnabled=1", "host": [ "{{baseUrl}}" ], "path": [ "invoices" ], "query": [ { "description": "Page number for paginated results. Defaults to the first page if omitted.\n", "key": "page", "value": "" }, { "description": "Filter invoices created on or after this date or date-time. Format: `YYYY-MM-DD` or `YYYY-MM-DD HH:MM:SS`. If time is omitted, `00:00:00` is assumed. If `dateEnd` is provided, it must not be earlier than `dateStart`.\n", "key": "dateStart", "value": "" }, { "description": "Filter invoices created on or before this date or date-time. Format: `YYYY-MM-DD` or `YYYY-MM-DD HH:MM:SS`. If time is omitted, `23:59:59` is assumed. If `dateStart` is provided, `dateEnd` must not be earlier than `dateStart`.\n", "key": "dateEnd", "value": "" }, { "description": "Filter invoices by the exact invoice number. Matches exactly (case-insensitive). If no match exists, no invoices are returned.\n", "key": "invoiceNumber", "value": "" }, { "description": "Filter invoices by customer ID.\n", "key": "customerId", "value": "" }, { "description": "Filter invoices by status.\n", "key": "status", "value": "APPROVED" }, { "description": "Filter invoices by type.\n", "key": "type", "value": "ORDER" }, { "description": "Filter invoices by currency code.\n", "key": "currency", "value": "CAD" }, { "description": "Include the convenience fee for each invoice. If `1`, the convenience fee is included in the response. If `0` or omitted, the convenience fee is set to 0.\n", "key": "withConvenienceFee", "value": "1" }, { "description": "Include custom field values for each invoice. If `1`, the `orderFields` array for each invoice is populated. If `0` or omitted, `orderFields` is always an empty array.\n", "key": "withOrderFields", "value": "1" }, { "description": "Filter invoices by whether the convenience fee is enabled. If `1`, return all invoices with the convenience fee enabled. If `0`, return all invoices with the convenience fee disabled. If omitted, no filter is applied.\n", "key": "convenienceFeeEnabled", "value": "1" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"invoiceId\": \"\",\n \"invoiceNumber\": \"\",\n \"token\": \"\",\n \"type\": \"\",\n \"status\": \"\",\n \"currency\": \"\",\n \"customerId\": \"\",\n \"billingAddress\": {\n \"name\": \"\",\n \"street1\": \"\",\n \"postalCode\": \"\",\n \"street2\": \"\",\n \"city\": \"\",\n \"province\": \"\",\n \"country\": \"\",\n \"phone\": \"\",\n \"email\": \"\"\n },\n \"shipping\": {\n \"amount\": \"\",\n \"details\": \"\",\n \"address\": {\n \"name\": \"\",\n \"street1\": \"\",\n \"postalCode\": \"\",\n \"street2\": \"\",\n \"city\": \"\",\n \"province\": \"\",\n \"country\": \"\",\n \"phone\": \"\",\n \"email\": \"\"\n }\n },\n \"pickup\": {\n \"date\": \"\",\n \"name\": \"\"\n },\n \"tax\": {\n \"amount\": \"\",\n \"details\": \"\"\n },\n \"discount\": {\n \"amount\": \"\",\n \"details\": \"\"\n },\n \"lineItems\": [\n {\n \"description\": \"\",\n \"quantity\": \"\",\n \"price\": \"\",\n \"taxAmount\": \"\",\n \"discountAmount\": \"\",\n \"sku\": \"\"\n },\n {\n \"description\": \"\",\n \"quantity\": \"\",\n \"price\": \"\",\n \"taxAmount\": \"\",\n \"discountAmount\": \"\",\n \"sku\": \"\"\n }\n ],\n \"dateCreated\": \"\",\n \"dateUpdated\": \"\",\n \"datePaid\": \"\",\n \"dateIssued\": \"\",\n \"amount\": \"\",\n \"amountPaid\": \"\",\n \"amountDue\": \"\",\n \"tipAmount\": \"\",\n \"depositAmount\": \"\",\n \"convenienceFee\": \"\",\n \"convenienceFeeEnabled\": \"\",\n \"surchargingFee\": \"\",\n \"orderFields\": [\n {\n \"displayName\": \"\",\n \"value\": \"\"\n },\n {\n \"displayName\": \"\",\n \"value\": \"\"\n }\n ],\n \"notes\": \"\"\n },\n {\n \"invoiceId\": \"\",\n \"invoiceNumber\": \"\",\n \"token\": \"\",\n \"type\": \"\",\n \"status\": \"\",\n \"currency\": \"\",\n \"customerId\": \"\",\n \"billingAddress\": {\n \"name\": \"\",\n \"street1\": \"\",\n \"postalCode\": \"\",\n \"street2\": \"\",\n \"city\": \"\",\n \"province\": \"\",\n \"country\": \"\",\n \"phone\": \"\",\n \"email\": \"\"\n },\n \"shipping\": {\n \"amount\": \"\",\n \"details\": \"\",\n \"address\": {\n \"name\": \"\",\n \"street1\": \"\",\n \"postalCode\": \"\",\n \"street2\": \"\",\n \"city\": \"\",\n \"province\": \"\",\n \"country\": \"\",\n \"phone\": \"\",\n \"email\": \"\"\n }\n },\n \"pickup\": {\n \"date\": \"\",\n \"name\": \"\"\n },\n \"tax\": {\n \"amount\": \"\",\n \"details\": \"\"\n },\n \"discount\": {\n \"amount\": \"\",\n \"details\": \"\"\n },\n \"lineItems\": [\n {\n \"description\": \"\",\n \"quantity\": \"\",\n \"price\": \"\",\n \"taxAmount\": \"\",\n \"discountAmount\": \"\",\n \"sku\": \"\"\n },\n {\n \"description\": \"\",\n \"quantity\": \"\",\n \"price\": \"\",\n \"taxAmount\": \"\",\n \"discountAmount\": \"\",\n \"sku\": \"\"\n }\n ],\n \"dateCreated\": \"\",\n \"dateUpdated\": \"\",\n \"datePaid\": \"\",\n \"dateIssued\": \"\",\n \"amount\": \"\",\n \"amountPaid\": \"\",\n \"amountDue\": \"\",\n \"tipAmount\": \"\",\n \"depositAmount\": \"\",\n \"convenienceFee\": \"\",\n \"convenienceFeeEnabled\": \"\",\n \"surchargingFee\": \"\",\n \"orderFields\": [\n {\n \"displayName\": \"\",\n \"value\": \"\"\n },\n {\n \"displayName\": \"\",\n \"value\": \"\"\n }\n ],\n \"notes\": \"\"\n }\n]", "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-8b6ead3e-e4d3-47d0-b5a5-09509dbefe1b" }, { "id": "117c1e4d-ccaa-473c-9f88-63f6fd1cb4ad", "name": "Failed", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "api-token", "value": "" } ], "url": { "raw": "{{baseUrl}}/invoices?page=&dateStart=&dateEnd=&invoiceNumber=&customerId=&status=APPROVED&type=ORDER¤cy=CAD&withConvenienceFee=1&withOrderFields=1&convenienceFeeEnabled=1", "host": [ "{{baseUrl}}" ], "path": [ "invoices" ], "query": [ { "description": "Page number for paginated results. Defaults to the first page if omitted.\n", "key": "page", "value": "" }, { "description": "Filter invoices created on or after this date or date-time. Format: `YYYY-MM-DD` or `YYYY-MM-DD HH:MM:SS`. If time is omitted, `00:00:00` is assumed. If `dateEnd` is provided, it must not be earlier than `dateStart`.\n", "key": "dateStart", "value": "" }, { "description": "Filter invoices created on or before this date or date-time. Format: `YYYY-MM-DD` or `YYYY-MM-DD HH:MM:SS`. If time is omitted, `23:59:59` is assumed. If `dateStart` is provided, `dateEnd` must not be earlier than `dateStart`.\n", "key": "dateEnd", "value": "" }, { "description": "Filter invoices by the exact invoice number. Matches exactly (case-insensitive). If no match exists, no invoices are returned.\n", "key": "invoiceNumber", "value": "" }, { "description": "Filter invoices by customer ID.\n", "key": "customerId", "value": "" }, { "description": "Filter invoices by status.\n", "key": "status", "value": "APPROVED" }, { "description": "Filter invoices by type.\n", "key": "type", "value": "ORDER" }, { "description": "Filter invoices by currency code.\n", "key": "currency", "value": "CAD" }, { "description": "Include the convenience fee for each invoice. If `1`, the convenience fee is included in the response. If `0` or omitted, the convenience fee is set to 0.\n", "key": "withConvenienceFee", "value": "1" }, { "description": "Include custom field values for each invoice. If `1`, the `orderFields` array for each invoice is populated. If `0` or omitted, `orderFields` is always an empty array.\n", "key": "withOrderFields", "value": "1" }, { "description": "Filter invoices by whether the convenience fee is enabled. If `1`, return all invoices with the convenience fee enabled. If `0`, return all invoices with the convenience fee disabled. If omitted, no filter is applied.\n", "key": "convenienceFeeEnabled", "value": "1" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-117c1e4d-ccaa-473c-9f88-63f6fd1cb4ad" } ], "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-30fff7c3-842e-46e0-9e35-8a4cb0e08b80" } ], "id": "80d9a1ef-5658-4358-b016-6b22b4e70632", "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-80d9a1ef-5658-4358-b016-6b22b4e70632" }, { "name": "ach", "item": [ { "name": "withdraw", "item": [ { "name": "Process an ACH withdraw.", "id": "446985ac-ab7f-43b3-92b4-43b88d68b7a5", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api-token", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "PUT", "header": [ { "description": "(Required) A UUID-formatted idempotency key. Accepted format is 25-36 alphanumeric characters (including '-' and '_').", "key": "idempotency-key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"bankAccountId\": \"\",\n \"customerId\": \"\",\n \"amount\": \"\",\n \"currencyId\": 2,\n \"orderId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/ach/withdraw", "host": [ "{{baseUrl}}" ], "path": [ "ach", "withdraw" ] } }, "response": [ { "id": "90bec50d-4b0e-403a-ad86-6c09f333f3f9", "name": "An ACH withdrawal was successfully processed. This does not guarantee that all necessary sub-objects were updated, only a guarantee that the payments action was successful.", "originalRequest": { "method": "PUT", "header": [ { "description": "(Required) A UUID-formatted idempotency key. Accepted format is 25-36 alphanumeric characters (including '-' and '_').", "key": "idempotency-key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "api-token", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"bankAccountId\": \"\",\n \"customerId\": \"\",\n \"amount\": \"\",\n \"currencyId\": 2,\n \"orderId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/ach/withdraw", "host": [ "{{baseUrl}}" ], "path": [ "ach", "withdraw" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"transaction\": {\n \"id\": \"\",\n \"merchantId\": \"\",\n \"dateCreated\": \"\",\n \"statusAuth\": \"\",\n \"statusClearing\": \"\",\n \"userId\": \"\",\n \"batchId\": \"\",\n \"bankAccountId\": \"\",\n \"bankAccountL4l4\": \"\",\n \"transactionType\": \"\",\n \"amount\": \"\",\n \"currency\": \"\",\n \"approvalCode\": \"\",\n \"test\": \"\",\n \"acquirerTransactionId\": \"\",\n \"responseMessage\": \"\",\n \"payFacTransactionId\": \"\",\n \"originalTransactionId\": \"\",\n \"statusBatch\": \"\",\n \"dateClosed\": \"\"\n }\n}", "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-90bec50d-4b0e-403a-ad86-6c09f333f3f9" }, { "id": "17d518ce-4444-46b1-a173-2a6d5b0440bb", "name": "Invalid request. Likely caused by malformed content in request payload.", "originalRequest": { "method": "PUT", "header": [ { "description": "(Required) A UUID-formatted idempotency key. Accepted format is 25-36 alphanumeric characters (including '-' and '_').", "key": "idempotency-key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "api-token", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"bankAccountId\": \"\",\n \"customerId\": \"\",\n \"amount\": \"\",\n \"currencyId\": 2,\n \"orderId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/ach/withdraw", "host": [ "{{baseUrl}}" ], "path": [ "ach", "withdraw" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-17d518ce-4444-46b1-a173-2a6d5b0440bb" }, { "id": "a023bf92-7453-4e66-999f-88beb51253e4", "name": "User does not have valid permissions.", "originalRequest": { "method": "PUT", "header": [ { "description": "(Required) A UUID-formatted idempotency key. Accepted format is 25-36 alphanumeric characters (including '-' and '_').", "key": "idempotency-key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "api-token", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"bankAccountId\": \"\",\n \"customerId\": \"\",\n \"amount\": \"\",\n \"currencyId\": 2,\n \"orderId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/ach/withdraw", "host": [ "{{baseUrl}}" ], "path": [ "ach", "withdraw" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-a023bf92-7453-4e66-999f-88beb51253e4" }, { "id": "3f0eca0f-5bdb-4d04-8689-2adf96a9f96c", "name": "Unexpected internal error.", "originalRequest": { "method": "PUT", "header": [ { "description": "(Required) A UUID-formatted idempotency key. Accepted format is 25-36 alphanumeric characters (including '-' and '_').", "key": "idempotency-key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "api-token", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"bankAccountId\": \"\",\n \"customerId\": \"\",\n \"amount\": \"\",\n \"currencyId\": 2,\n \"orderId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/ach/withdraw", "host": [ "{{baseUrl}}" ], "path": [ "ach", "withdraw" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-3f0eca0f-5bdb-4d04-8689-2adf96a9f96c" } ], "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-446985ac-ab7f-43b3-92b4-43b88d68b7a5" } ], "id": "b1f812b2-a4b5-47c5-8240-bd390fdb49b2", "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-b1f812b2-a4b5-47c5-8240-bd390fdb49b2" }, { "name": "transactions", "item": [ { "name": "{transactionId}", "item": [ { "name": "refund", "item": [ { "name": "Refund an ACH transaction.", "id": "8ec29265-0b5e-4e3f-84cb-e8ef177d1493", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api-token", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "PUT", "header": [ { "description": "(Required) A UUID-formatted idempotency key. Accepted format is 25-36 alphanumeric characters (including '-' and '_').", "key": "idempotency-key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"amount\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/ach/transactions/:transactionId/refund", "host": [ "{{baseUrl}}" ], "path": [ "ach", "transactions", ":transactionId", "refund" ], "variable": [ { "id": "05bf299a-3799-4384-81a3-8ee916f16391", "key": "transactionId", "value": "", "description": "(Required) The ID of the ACH transaction to refund." } ] } }, "response": [ { "id": "f16b74b0-bf84-4b86-9f30-790469356aac", "name": "An ACH refund was successfully processed. This does not guarantee that all necessary sub-objects were updated, only a guarantee that the payments action was successful.", "originalRequest": { "method": "PUT", "header": [ { "description": "(Required) A UUID-formatted idempotency key. Accepted format is 25-36 alphanumeric characters (including '-' and '_').", "key": "idempotency-key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "api-token", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"amount\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/ach/transactions/:transactionId/refund", "host": [ "{{baseUrl}}" ], "path": [ "ach", "transactions", ":transactionId", "refund" ], "variable": [ { "key": "transactionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-f16b74b0-bf84-4b86-9f30-790469356aac" }, { "id": "138f7aee-4be8-43d5-9cc8-62fd9445c83b", "name": "Invalid request. Likely caused by malformed content in request payload.", "originalRequest": { "method": "PUT", "header": [ { "description": "(Required) A UUID-formatted idempotency key. Accepted format is 25-36 alphanumeric characters (including '-' and '_').", "key": "idempotency-key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "api-token", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"amount\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/ach/transactions/:transactionId/refund", "host": [ "{{baseUrl}}" ], "path": [ "ach", "transactions", ":transactionId", "refund" ], "variable": [ { "key": "transactionId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-138f7aee-4be8-43d5-9cc8-62fd9445c83b" }, { "id": "f8a78da8-6172-4a6b-8789-e9b34fdd380a", "name": "User does not have valid permissions.", "originalRequest": { "method": "PUT", "header": [ { "description": "(Required) A UUID-formatted idempotency key. Accepted format is 25-36 alphanumeric characters (including '-' and '_').", "key": "idempotency-key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "api-token", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"amount\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/ach/transactions/:transactionId/refund", "host": [ "{{baseUrl}}" ], "path": [ "ach", "transactions", ":transactionId", "refund" ], "variable": [ { "key": "transactionId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-f8a78da8-6172-4a6b-8789-e9b34fdd380a" }, { "id": "ac33a1a5-0593-4bbc-b2b1-c9bffab7d611", "name": "Unexpected internal error.", "originalRequest": { "method": "PUT", "header": [ { "description": "(Required) A UUID-formatted idempotency key. Accepted format is 25-36 alphanumeric characters (including '-' and '_').", "key": "idempotency-key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "api-token", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"amount\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/ach/transactions/:transactionId/refund", "host": [ "{{baseUrl}}" ], "path": [ "ach", "transactions", ":transactionId", "refund" ], "variable": [ { "key": "transactionId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-ac33a1a5-0593-4bbc-b2b1-c9bffab7d611" } ], "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-8ec29265-0b5e-4e3f-84cb-e8ef177d1493" } ], "id": "7e28abc7-59b2-4ba9-9cdf-5c571bfbee4a", "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-7e28abc7-59b2-4ba9-9cdf-5c571bfbee4a" }, { "name": "void", "item": [ { "name": "Void an ACH transaction.", "id": "b087ff15-2440-4966-a8fd-f92d8fd20f36", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api-token", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "PUT", "header": [ { "description": "(Required) A UUID-formatted idempotency key. Accepted format is 25-36 alphanumeric characters (including '-' and '_').", "key": "idempotency-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/ach/transactions/:transactionId/void", "host": [ "{{baseUrl}}" ], "path": [ "ach", "transactions", ":transactionId", "void" ], "variable": [ { "id": "25026bc0-046b-4849-9f89-857dc12c8e64", "key": "transactionId", "value": "", "description": "(Required) The ID of the ACH transaction to void." } ] } }, "response": [ { "id": "b74316d7-2ebc-447d-86a2-f7e2c8c2efa6", "name": "The ACH transaction was successfully voided. This does not guarantee that all necessary sub-objects were updated, only a guarantee that the payments action was successful.", "originalRequest": { "method": "PUT", "header": [ { "description": "(Required) A UUID-formatted idempotency key. Accepted format is 25-36 alphanumeric characters (including '-' and '_').", "key": "idempotency-key", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "api-token", "value": "" } ], "url": { "raw": "{{baseUrl}}/ach/transactions/:transactionId/void", "host": [ "{{baseUrl}}" ], "path": [ "ach", "transactions", ":transactionId", "void" ], "variable": [ { "key": "transactionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-b74316d7-2ebc-447d-86a2-f7e2c8c2efa6" }, { "id": "66568ccd-3d91-45ff-9d47-e1f6124ec66a", "name": "Invalid request. Likely caused by providing an ACH transaction ID referencing a transaction that is not eligible for voiding.", "originalRequest": { "method": "PUT", "header": [ { "description": "(Required) A UUID-formatted idempotency key. Accepted format is 25-36 alphanumeric characters (including '-' and '_').", "key": "idempotency-key", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "api-token", "value": "" } ], "url": { "raw": "{{baseUrl}}/ach/transactions/:transactionId/void", "host": [ "{{baseUrl}}" ], "path": [ "ach", "transactions", ":transactionId", "void" ], "variable": [ { "key": "transactionId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-66568ccd-3d91-45ff-9d47-e1f6124ec66a" }, { "id": "07876dea-a43e-4c02-a15a-0d098e8c42c7", "name": "User does not have valid permissions.", "originalRequest": { "method": "PUT", "header": [ { "description": "(Required) A UUID-formatted idempotency key. Accepted format is 25-36 alphanumeric characters (including '-' and '_').", "key": "idempotency-key", "value": "" }, { "description": "Added as a part of security scheme: apikey", "key": "api-token", "value": "" } ], "url": { "raw": "{{baseUrl}}/ach/transactions/:transactionId/void", "host": [ "{{baseUrl}}" ], "path": [ "ach", "transactions", ":transactionId", "void" ], "variable": [ { "key": "transactionId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-07876dea-a43e-4c02-a15a-0d098e8c42c7" }, { "id": "7f97aa83-6c7e-4199-a501-9526a173287f", "name": "Unexpected internal error.", "originalRequest": { "method": "PUT", "header": [ { "description": "(Required) A UUID-formatted idempotency key. Accepted format is 25-36 alphanumeric characters (including '-' and '_').", "key": "idempotency-key", "value": "" }, { "description": "Added as a part of security scheme: apikey", "key": "api-token", "value": "" } ], "url": { "raw": "{{baseUrl}}/ach/transactions/:transactionId/void", "host": [ "{{baseUrl}}" ], "path": [ "ach", "transactions", ":transactionId", "void" ], "variable": [ { "key": "transactionId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-7f97aa83-6c7e-4199-a501-9526a173287f" } ], "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-b087ff15-2440-4966-a8fd-f92d8fd20f36" } ], "id": "a5b0f107-4b33-4e90-b791-b63742c635f6", "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-a5b0f107-4b33-4e90-b791-b63742c635f6" }, { "name": "cancel", "item": [ { "name": "Cancel a pending ACH transaction.", "id": "6bd2fa7e-ad3f-475b-be36-95a8bb61b5ed", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api-token", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "PATCH", "header": [ { "description": "(Required) A UUID-formatted idempotency key. Accepted format is 25-36 alphanumeric characters (including '-' and '_').", "key": "idempotency-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/ach/transactions/:transactionId/cancel", "host": [ "{{baseUrl}}" ], "path": [ "ach", "transactions", ":transactionId", "cancel" ], "variable": [ { "id": "cd475472-3be8-418b-9ed9-496e1e669df1", "key": "transactionId", "value": "", "description": "(Required) The ID of the ACH transaction to cancel." } ] } }, "response": [ { "id": "839be6aa-6555-42dc-8cb4-17a37f9351c2", "name": "The pending ACH transaction was successfully cancelled.", "originalRequest": { "method": "PATCH", "header": [ { "description": "(Required) A UUID-formatted idempotency key. Accepted format is 25-36 alphanumeric characters (including '-' and '_').", "key": "idempotency-key", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "api-token", "value": "" } ], "url": { "raw": "{{baseUrl}}/ach/transactions/:transactionId/cancel", "host": [ "{{baseUrl}}" ], "path": [ "ach", "transactions", ":transactionId", "cancel" ], "variable": [ { "key": "transactionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-839be6aa-6555-42dc-8cb4-17a37f9351c2" }, { "id": "ca7a3104-04ca-4e8b-b50a-d0c1b8f75875", "name": "Invalid request. Likely due to the ACH transaction not being pending.", "originalRequest": { "method": "PATCH", "header": [ { "description": "(Required) A UUID-formatted idempotency key. Accepted format is 25-36 alphanumeric characters (including '-' and '_').", "key": "idempotency-key", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "api-token", "value": "" } ], "url": { "raw": "{{baseUrl}}/ach/transactions/:transactionId/cancel", "host": [ "{{baseUrl}}" ], "path": [ "ach", "transactions", ":transactionId", "cancel" ], "variable": [ { "key": "transactionId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-ca7a3104-04ca-4e8b-b50a-d0c1b8f75875" }, { "id": "a5b9d120-7cb4-4145-b357-d1113150ba54", "name": "User does not have valid permissions.", "originalRequest": { "method": "PATCH", "header": [ { "description": "(Required) A UUID-formatted idempotency key. Accepted format is 25-36 alphanumeric characters (including '-' and '_').", "key": "idempotency-key", "value": "" }, { "description": "Added as a part of security scheme: apikey", "key": "api-token", "value": "" } ], "url": { "raw": "{{baseUrl}}/ach/transactions/:transactionId/cancel", "host": [ "{{baseUrl}}" ], "path": [ "ach", "transactions", ":transactionId", "cancel" ], "variable": [ { "key": "transactionId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-a5b9d120-7cb4-4145-b357-d1113150ba54" }, { "id": "74fa0286-a799-487b-995b-d24abb11da46", "name": "Unexpected internal error.", "originalRequest": { "method": "PATCH", "header": [ { "description": "(Required) A UUID-formatted idempotency key. Accepted format is 25-36 alphanumeric characters (including '-' and '_').", "key": "idempotency-key", "value": "" }, { "description": "Added as a part of security scheme: apikey", "key": "api-token", "value": "" } ], "url": { "raw": "{{baseUrl}}/ach/transactions/:transactionId/cancel", "host": [ "{{baseUrl}}" ], "path": [ "ach", "transactions", ":transactionId", "cancel" ], "variable": [ { "key": "transactionId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-74fa0286-a799-487b-995b-d24abb11da46" } ], "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-6bd2fa7e-ad3f-475b-be36-95a8bb61b5ed" } ], "id": "03646639-21b4-4531-ac4e-1d4d541afc69", "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-03646639-21b4-4531-ac4e-1d4d541afc69" }, { "name": "Retrieves a single ACH transaction.", "id": "814faf3e-23d6-421d-a069-f7efd3b76ad1", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api-token", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/ach/transactions/:transactionId", "host": [ "{{baseUrl}}" ], "path": [ "ach", "transactions", ":transactionId" ], "variable": [ { "id": "8e799db1-ed75-40ec-8a47-c6a9c03163c8", "key": "transactionId", "value": "", "description": "(Required) The ID of the ACH transaction." } ] } }, "response": [ { "id": "b971b2e3-b70b-43e2-9742-af0ed1c8bb15", "name": "An ACH transaction.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "api-token", "value": "" } ], "url": { "raw": "{{baseUrl}}/ach/transactions/:transactionId", "host": [ "{{baseUrl}}" ], "path": [ "ach", "transactions", ":transactionId" ], "variable": [ { "key": "transactionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"merchantId\": \"\",\n \"dateCreated\": \"\",\n \"statusAuth\": \"\",\n \"statusClearing\": \"\",\n \"userId\": \"\",\n \"batchId\": \"\",\n \"bankAccountId\": \"\",\n \"bankAccountL4l4\": \"\",\n \"transactionType\": \"\",\n \"amount\": \"\",\n \"currency\": \"\",\n \"approvalCode\": \"\",\n \"test\": \"\",\n \"acquirerTransactionId\": \"\",\n \"responseMessage\": \"\",\n \"payFacTransactionId\": \"\",\n \"originalTransactionId\": \"\",\n \"statusBatch\": \"\",\n \"dateClosed\": \"\"\n}", "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-b971b2e3-b70b-43e2-9742-af0ed1c8bb15" }, { "id": "2a1835bf-62d5-4ffe-9f3b-bf93a7283e00", "name": "Invalid request. Likely due to using an invalid ACH transaction ID.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "api-token", "value": "" } ], "url": { "raw": "{{baseUrl}}/ach/transactions/:transactionId", "host": [ "{{baseUrl}}" ], "path": [ "ach", "transactions", ":transactionId" ], "variable": [ { "key": "transactionId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-2a1835bf-62d5-4ffe-9f3b-bf93a7283e00" }, { "id": "63bd3de1-7a35-4560-b8eb-f9181c057e09", "name": "User does not have valid permissions.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "api-token", "value": "" } ], "url": { "raw": "{{baseUrl}}/ach/transactions/:transactionId", "host": [ "{{baseUrl}}" ], "path": [ "ach", "transactions", ":transactionId" ], "variable": [ { "key": "transactionId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-63bd3de1-7a35-4560-b8eb-f9181c057e09" }, { "id": "b3de7999-afc8-4772-bd22-5c9bbb3407b1", "name": "Unexpected internal error.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "api-token", "value": "" } ], "url": { "raw": "{{baseUrl}}/ach/transactions/:transactionId", "host": [ "{{baseUrl}}" ], "path": [ "ach", "transactions", ":transactionId" ], "variable": [ { "key": "transactionId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-b3de7999-afc8-4772-bd22-5c9bbb3407b1" } ], "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-814faf3e-23d6-421d-a069-f7efd3b76ad1" } ], "id": "35aeb19f-bf36-49ad-a8f2-4dd7a33b66d0", "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-35aeb19f-bf36-49ad-a8f2-4dd7a33b66d0" }, { "name": "Collects all ACH transactions.", "id": "3f39d19f-5aba-4649-a65b-b5f3a08c445b", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api-token", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/ach/transactions?page=&limit=&startDate=&endDate=&amountMin=&amountMax=&statusAuth=DECLINED&statusAuth=APPROVED&statusClearing=CLEARED&statusClearing=OPENED&users=&users=&search=", "host": [ "{{baseUrl}}" ], "path": [ "ach", "transactions" ], "query": [ { "description": "Page number for paginated results.", "key": "page", "value": "" }, { "description": "The number of transactions that will be returned in one request. We only allow maximum 125 objects per request. If no limit specified, the default limit will be 125 objects.\n", "key": "limit", "value": "" }, { "description": "Filter transactions created on or after this date. Format: `YYYY-MM-DD`. If `endDate` is provided, it must not be earlier than `startDate`.\n", "key": "startDate", "value": "" }, { "description": "Filter transactions created on or before this date. Format: `YYYY-MM-DD`. If `startDate` is provided, `endDate` must not be earlier than `startDate`.\n", "key": "endDate", "value": "" }, { "description": "Filter transactions by minimum amount. If `amountMax` is provided, `amountMin` must not be greater than `amountMax`.\n", "key": "amountMin", "value": "" }, { "description": "Filter transactions by maximum amount. If `amountMin` is provided, `amountMax` must not be less than `amountMin`.\n", "key": "amountMax", "value": "" }, { "description": "Filter transactions by auth status.", "key": "statusAuth", "value": "DECLINED" }, { "description": "Filter transactions by auth status.", "key": "statusAuth", "value": "APPROVED" }, { "description": "Filter transactions by clearing status.", "key": "statusClearing", "value": "CLEARED" }, { "description": "Filter transactions by clearing status.", "key": "statusClearing", "value": "OPENED" }, { "description": "Filter transactions by users.", "key": "users", "value": "" }, { "description": "Filter transactions by users.", "key": "users", "value": "" }, { "description": "Searches id, bankAccountL4l4, order id, batch id, contact name and business name.\n", "key": "search", "value": "" } ] } }, "response": [ { "id": "9b5ebe07-dd85-4b9a-befa-ab83ab98fcc8", "name": "All ACH transactions.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "api-token", "value": "" } ], "url": { "raw": "{{baseUrl}}/ach/transactions?page=&limit=&startDate=&endDate=&amountMin=&amountMax=&statusAuth=APPROVED&statusClearing=OPENED&users=&search=", "host": [ "{{baseUrl}}" ], "path": [ "ach", "transactions" ], "query": [ { "description": "Page number for paginated results.", "key": "page", "value": "" }, { "description": "The number of transactions that will be returned in one request. We only allow maximum 125 objects per request. If no limit specified, the default limit will be 125 objects.\n", "key": "limit", "value": "" }, { "description": "Filter transactions created on or after this date. Format: `YYYY-MM-DD`. If `endDate` is provided, it must not be earlier than `startDate`.\n", "key": "startDate", "value": "" }, { "description": "Filter transactions created on or before this date. Format: `YYYY-MM-DD`. If `startDate` is provided, `endDate` must not be earlier than `startDate`.\n", "key": "endDate", "value": "" }, { "description": "Filter transactions by minimum amount. If `amountMax` is provided, `amountMin` must not be greater than `amountMax`.\n", "key": "amountMin", "value": "" }, { "description": "Filter transactions by maximum amount. If `amountMin` is provided, `amountMax` must not be less than `amountMin`.\n", "key": "amountMax", "value": "" }, { "description": "Filter transactions by auth status.", "key": "statusAuth", "value": "APPROVED" }, { "description": "Filter transactions by clearing status.", "key": "statusClearing", "value": "OPENED" }, { "description": "Filter transactions by users.", "key": "users", "value": "" }, { "description": "Searches id, bankAccountL4l4, order id, batch id, contact name and business name.\n", "key": "search", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"id\": \"\",\n \"merchantId\": \"\",\n \"dateCreated\": \"\",\n \"statusAuth\": \"\",\n \"statusClearing\": \"\",\n \"userId\": \"\",\n \"batchId\": \"\",\n \"bankAccountId\": \"\",\n \"bankAccountL4l4\": \"\",\n \"transactionType\": \"\",\n \"amount\": \"\",\n \"currency\": \"\",\n \"approvalCode\": \"\",\n \"test\": \"\",\n \"acquirerTransactionId\": \"\",\n \"responseMessage\": \"\",\n \"payFacTransactionId\": \"\",\n \"originalTransactionId\": \"\",\n \"statusBatch\": \"\",\n \"dateClosed\": \"\"\n },\n {\n \"id\": \"\",\n \"merchantId\": \"\",\n \"dateCreated\": \"\",\n \"statusAuth\": \"\",\n \"statusClearing\": \"\",\n \"userId\": \"\",\n \"batchId\": \"\",\n \"bankAccountId\": \"\",\n \"bankAccountL4l4\": \"\",\n \"transactionType\": \"\",\n \"amount\": \"\",\n \"currency\": \"\",\n \"approvalCode\": \"\",\n \"test\": \"\",\n \"acquirerTransactionId\": \"\",\n \"responseMessage\": \"\",\n \"payFacTransactionId\": \"\",\n \"originalTransactionId\": \"\",\n \"statusBatch\": \"\",\n \"dateClosed\": \"\"\n }\n]", "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-9b5ebe07-dd85-4b9a-befa-ab83ab98fcc8" }, { "id": "24f9e6ca-9a5b-47f6-9222-464a12d06532", "name": "Invalid request.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "api-token", "value": "" } ], "url": { "raw": "{{baseUrl}}/ach/transactions?page=&limit=&startDate=&endDate=&amountMin=&amountMax=&statusAuth=APPROVED&statusClearing=OPENED&users=&search=", "host": [ "{{baseUrl}}" ], "path": [ "ach", "transactions" ], "query": [ { "description": "Page number for paginated results.", "key": "page", "value": "" }, { "description": "The number of transactions that will be returned in one request. We only allow maximum 125 objects per request. If no limit specified, the default limit will be 125 objects.\n", "key": "limit", "value": "" }, { "description": "Filter transactions created on or after this date. Format: `YYYY-MM-DD`. If `endDate` is provided, it must not be earlier than `startDate`.\n", "key": "startDate", "value": "" }, { "description": "Filter transactions created on or before this date. Format: `YYYY-MM-DD`. If `startDate` is provided, `endDate` must not be earlier than `startDate`.\n", "key": "endDate", "value": "" }, { "description": "Filter transactions by minimum amount. If `amountMax` is provided, `amountMin` must not be greater than `amountMax`.\n", "key": "amountMin", "value": "" }, { "description": "Filter transactions by maximum amount. If `amountMin` is provided, `amountMax` must not be less than `amountMin`.\n", "key": "amountMax", "value": "" }, { "description": "Filter transactions by auth status.", "key": "statusAuth", "value": "APPROVED" }, { "description": "Filter transactions by clearing status.", "key": "statusClearing", "value": "OPENED" }, { "description": "Filter transactions by users.", "key": "users", "value": "" }, { "description": "Searches id, bankAccountL4l4, order id, batch id, contact name and business name.\n", "key": "search", "value": "" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-24f9e6ca-9a5b-47f6-9222-464a12d06532" }, { "id": "3330b687-e51f-4d1f-978b-e174254c681f", "name": "User does not have valid permissions.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "api-token", "value": "" } ], "url": { "raw": "{{baseUrl}}/ach/transactions?page=&limit=&startDate=&endDate=&amountMin=&amountMax=&statusAuth=APPROVED&statusClearing=OPENED&users=&search=", "host": [ "{{baseUrl}}" ], "path": [ "ach", "transactions" ], "query": [ { "description": "Page number for paginated results.", "key": "page", "value": "" }, { "description": "The number of transactions that will be returned in one request. We only allow maximum 125 objects per request. If no limit specified, the default limit will be 125 objects.\n", "key": "limit", "value": "" }, { "description": "Filter transactions created on or after this date. Format: `YYYY-MM-DD`. If `endDate` is provided, it must not be earlier than `startDate`.\n", "key": "startDate", "value": "" }, { "description": "Filter transactions created on or before this date. Format: `YYYY-MM-DD`. If `startDate` is provided, `endDate` must not be earlier than `startDate`.\n", "key": "endDate", "value": "" }, { "description": "Filter transactions by minimum amount. If `amountMax` is provided, `amountMin` must not be greater than `amountMax`.\n", "key": "amountMin", "value": "" }, { "description": "Filter transactions by maximum amount. If `amountMin` is provided, `amountMax` must not be less than `amountMin`.\n", "key": "amountMax", "value": "" }, { "description": "Filter transactions by auth status.", "key": "statusAuth", "value": "APPROVED" }, { "description": "Filter transactions by clearing status.", "key": "statusClearing", "value": "OPENED" }, { "description": "Filter transactions by users.", "key": "users", "value": "" }, { "description": "Searches id, bankAccountL4l4, order id, batch id, contact name and business name.\n", "key": "search", "value": "" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-3330b687-e51f-4d1f-978b-e174254c681f" }, { "id": "06d1c364-c4ab-475a-8f56-bc3f4dd6b703", "name": "Unexpected internal error.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "api-token", "value": "" } ], "url": { "raw": "{{baseUrl}}/ach/transactions?page=&limit=&startDate=&endDate=&amountMin=&amountMax=&statusAuth=APPROVED&statusClearing=OPENED&users=&search=", "host": [ "{{baseUrl}}" ], "path": [ "ach", "transactions" ], "query": [ { "description": "Page number for paginated results.", "key": "page", "value": "" }, { "description": "The number of transactions that will be returned in one request. We only allow maximum 125 objects per request. If no limit specified, the default limit will be 125 objects.\n", "key": "limit", "value": "" }, { "description": "Filter transactions created on or after this date. Format: `YYYY-MM-DD`. If `endDate` is provided, it must not be earlier than `startDate`.\n", "key": "startDate", "value": "" }, { "description": "Filter transactions created on or before this date. Format: `YYYY-MM-DD`. If `startDate` is provided, `endDate` must not be earlier than `startDate`.\n", "key": "endDate", "value": "" }, { "description": "Filter transactions by minimum amount. If `amountMax` is provided, `amountMin` must not be greater than `amountMax`.\n", "key": "amountMin", "value": "" }, { "description": "Filter transactions by maximum amount. If `amountMin` is provided, `amountMax` must not be less than `amountMin`.\n", "key": "amountMax", "value": "" }, { "description": "Filter transactions by auth status.", "key": "statusAuth", "value": "APPROVED" }, { "description": "Filter transactions by clearing status.", "key": "statusClearing", "value": "OPENED" }, { "description": "Filter transactions by users.", "key": "users", "value": "" }, { "description": "Searches id, bankAccountL4l4, order id, batch id, contact name and business name.\n", "key": "search", "value": "" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-06d1c364-c4ab-475a-8f56-bc3f4dd6b703" } ], "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-3f39d19f-5aba-4649-a65b-b5f3a08c445b" } ], "id": "0bd047b9-1324-49e8-964e-833bf497f8ed", "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-0bd047b9-1324-49e8-964e-833bf497f8ed" }, { "name": "batches", "item": [ { "name": "{batchId}", "item": [ { "name": "settle", "item": [ { "name": "Settle an ACH batch.", "id": "d43c4adc-fa07-46f8-814b-dfc12e99458e", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api-token", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "PUT", "header": [ { "description": "(Required) A UUID-formatted idempotency key. Accepted format is 25-36 alphanumeric characters (including '-' and '_').", "key": "idempotency-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/ach/batches/:batchId/settle", "host": [ "{{baseUrl}}" ], "path": [ "ach", "batches", ":batchId", "settle" ], "variable": [ { "id": "ae38e64c-12b1-4974-bbd3-da2d98f9dffd", "key": "batchId", "value": "", "description": "(Required) The ID of the ACH batch." } ] } }, "response": [ { "id": "da9dfada-89af-4755-a576-b3d0025a2980", "name": "The ACH batch was successfully settled.", "originalRequest": { "method": "PUT", "header": [ { "description": "(Required) A UUID-formatted idempotency key. Accepted format is 25-36 alphanumeric characters (including '-' and '_').", "key": "idempotency-key", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "api-token", "value": "" } ], "url": { "raw": "{{baseUrl}}/ach/batches/:batchId/settle", "host": [ "{{baseUrl}}" ], "path": [ "ach", "batches", ":batchId", "settle" ], "variable": [ { "key": "batchId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-da9dfada-89af-4755-a576-b3d0025a2980" }, { "id": "b85f721a-1d25-4237-a091-93a784b4db93", "name": "Invalid request. Likely caused by the batch not being eligible for settling.", "originalRequest": { "method": "PUT", "header": [ { "description": "(Required) A UUID-formatted idempotency key. Accepted format is 25-36 alphanumeric characters (including '-' and '_').", "key": "idempotency-key", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "api-token", "value": "" } ], "url": { "raw": "{{baseUrl}}/ach/batches/:batchId/settle", "host": [ "{{baseUrl}}" ], "path": [ "ach", "batches", ":batchId", "settle" ], "variable": [ { "key": "batchId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-b85f721a-1d25-4237-a091-93a784b4db93" }, { "id": "8ff4d2d6-c523-4f74-a0fc-0ca166605e66", "name": "User does not have valid permissions.", "originalRequest": { "method": "PUT", "header": [ { "description": "(Required) A UUID-formatted idempotency key. Accepted format is 25-36 alphanumeric characters (including '-' and '_').", "key": "idempotency-key", "value": "" }, { "description": "Added as a part of security scheme: apikey", "key": "api-token", "value": "" } ], "url": { "raw": "{{baseUrl}}/ach/batches/:batchId/settle", "host": [ "{{baseUrl}}" ], "path": [ "ach", "batches", ":batchId", "settle" ], "variable": [ { "key": "batchId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-8ff4d2d6-c523-4f74-a0fc-0ca166605e66" }, { "id": "457327dc-4a9c-4474-9d7b-ac38a9653a55", "name": "Unexpected internal error.", "originalRequest": { "method": "PUT", "header": [ { "description": "(Required) A UUID-formatted idempotency key. Accepted format is 25-36 alphanumeric characters (including '-' and '_').", "key": "idempotency-key", "value": "" }, { "description": "Added as a part of security scheme: apikey", "key": "api-token", "value": "" } ], "url": { "raw": "{{baseUrl}}/ach/batches/:batchId/settle", "host": [ "{{baseUrl}}" ], "path": [ "ach", "batches", ":batchId", "settle" ], "variable": [ { "key": "batchId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-457327dc-4a9c-4474-9d7b-ac38a9653a55" } ], "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-d43c4adc-fa07-46f8-814b-dfc12e99458e" } ], "id": "30c52a44-a7be-4c42-9ae8-89c1f350942f", "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-30c52a44-a7be-4c42-9ae8-89c1f350942f" } ], "id": "6042c2c3-acdd-4e72-839a-da8bbf2337db", "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-6042c2c3-acdd-4e72-839a-da8bbf2337db" }, { "name": "Collects all ACH batches.", "id": "5c818cf2-7ea7-4d75-b7c5-ada724fef1f9", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api-token", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/ach/batches", "host": [ "{{baseUrl}}" ], "path": [ "ach", "batches" ] } }, "response": [ { "id": "04537916-548b-4c58-99d3-47cdeda33ee3", "name": "All ACH Batches.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "api-token", "value": "" } ], "url": { "raw": "{{baseUrl}}/ach/batches", "host": [ "{{baseUrl}}" ], "path": [ "ach", "batches" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"batchId\": \"\",\n \"batchReference\": \"\",\n \"merchantId\": \"\",\n \"statusBatch\": 1,\n \"amountWithdrawals\": \"\",\n \"countWithdrawals\": \"\",\n \"amountDeposits\": \"\",\n \"countDeposits\": \"\",\n \"amountReversed\": \"\",\n \"countReversed\": \"\",\n \"amountRefunded\": \"\",\n \"countRefunded\": \"\",\n \"dateOpened\": \"\",\n \"dateClosed\": \"\"\n },\n {\n \"batchId\": \"\",\n \"batchReference\": \"\",\n \"merchantId\": \"\",\n \"statusBatch\": 1,\n \"amountWithdrawals\": \"\",\n \"countWithdrawals\": \"\",\n \"amountDeposits\": \"\",\n \"countDeposits\": \"\",\n \"amountReversed\": \"\",\n \"countReversed\": \"\",\n \"amountRefunded\": \"\",\n \"countRefunded\": \"\",\n \"dateOpened\": \"\",\n \"dateClosed\": \"\"\n }\n]", "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-04537916-548b-4c58-99d3-47cdeda33ee3" }, { "id": "24a238be-1d12-44db-b402-fe89ac330562", "name": "Invalid request.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "api-token", "value": "" } ], "url": { "raw": "{{baseUrl}}/ach/batches", "host": [ "{{baseUrl}}" ], "path": [ "ach", "batches" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-24a238be-1d12-44db-b402-fe89ac330562" }, { "id": "093ef59b-503f-439b-a53f-9639a5d5a18e", "name": "User does not have valid permissions.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "api-token", "value": "" } ], "url": { "raw": "{{baseUrl}}/ach/batches", "host": [ "{{baseUrl}}" ], "path": [ "ach", "batches" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-093ef59b-503f-439b-a53f-9639a5d5a18e" }, { "id": "8591c013-6834-498a-a07a-d50f2ff7dfaa", "name": "Unexpected internal error.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "api-token", "value": "" } ], "url": { "raw": "{{baseUrl}}/ach/batches", "host": [ "{{baseUrl}}" ], "path": [ "ach", "batches" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-8591c013-6834-498a-a07a-d50f2ff7dfaa" } ], "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-5c818cf2-7ea7-4d75-b7c5-ada724fef1f9" } ], "id": "5878f1ea-2b18-4888-a016-c7287c0c4db0", "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-5878f1ea-2b18-4888-a016-c7287c0c4db0" } ], "id": "08afa05f-2564-4fd6-b525-075b77b2f61d", "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-08afa05f-2564-4fd6-b525-075b77b2f61d" }, { "name": "card-terminals", "item": [ { "name": "Get card terminals", "id": "77277778-4abf-41e6-8f37-67bd9d1989d2", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api-token", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/card-terminals?currency=&status=", "host": [ "{{baseUrl}}" ], "path": [ "card-terminals" ], "query": [ { "description": "The abbreviation of the card terminal's currency. Possible values are CAD | USD", "key": "currency", "value": "" }, { "description": "The card terminal's status. possible values are ACTIVE | INACTIVE", "key": "status", "value": "" } ] } }, "response": [ { "id": "ef0c1dda-48dc-42fc-b8d7-ce4e14c15cf0", "name": "Successful", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "api-token", "value": "" } ], "url": { "raw": "{{baseUrl}}/card-terminals?currency=&status=", "host": [ "{{baseUrl}}" ], "path": [ "card-terminals" ], "query": [ { "description": "The abbreviation of the card terminal's currency. Possible values are CAD | USD", "key": "currency", "value": "" }, { "description": "The card terminal's status. possible values are ACTIVE | INACTIVE", "key": "status", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"id\": \"\",\n \"nickname\": \"\",\n \"currency\": \"\",\n \"status\": \"\",\n \"address\": {\n \"street1\": \"\",\n \"street2\": \"\",\n \"city\": \"\",\n \"province\": \"\",\n \"country\": \"\",\n \"postalCode\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"nickname\": \"\",\n \"currency\": \"\",\n \"status\": \"\",\n \"address\": {\n \"street1\": \"\",\n \"street2\": \"\",\n \"city\": \"\",\n \"province\": \"\",\n \"country\": \"\",\n \"postalCode\": \"\"\n }\n }\n]", "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-ef0c1dda-48dc-42fc-b8d7-ce4e14c15cf0" }, { "id": "6467b27b-863e-4fc6-847c-39e89b5db2e0", "name": "Failed", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "api-token", "value": "" } ], "url": { "raw": "{{baseUrl}}/card-terminals?currency=&status=", "host": [ "{{baseUrl}}" ], "path": [ "card-terminals" ], "query": [ { "description": "The abbreviation of the card terminal's currency. Possible values are CAD | USD", "key": "currency", "value": "" }, { "description": "The card terminal's status. possible values are ACTIVE | INACTIVE", "key": "status", "value": "" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-6467b27b-863e-4fc6-847c-39e89b5db2e0" } ], "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-77277778-4abf-41e6-8f37-67bd9d1989d2" } ], "id": "2b691079-c785-47a6-815e-28a0b0cce97b", "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-2b691079-c785-47a6-815e-28a0b0cce97b" }, { "name": "devices", "item": [ { "name": "{code}", "item": [ { "name": "payment", "item": [ { "name": "purchase", "item": [ { "name": "Start A Purchase", "id": "59cb9f9f-bda8-46d6-ae4c-4e7aa36e6460", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api-token", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"currency\": \"\",\n \"transactionAmount\": \"\",\n \"invoiceNumber\": \"\",\n \"customerCode\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/devices/:code/payment/purchase", "host": [ "{{baseUrl}}" ], "path": [ "devices", ":code", "payment", "purchase" ], "variable": [ { "id": "3dd8720e-bb26-44d0-9844-0369e5b5aa91", "key": "code", "value": "", "description": "(Required) Four Digit Alphanumeric Code." } ] }, "description": "This operation requires the provided API key to have Processing permission set to 'PositiveTransaction' or higher.\n" }, "response": [ { "id": "a9887852-305a-44a5-bf58-7918129f6b36", "name": "Accepted", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "api-token", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"currency\": \"\",\n \"transactionAmount\": \"\",\n \"invoiceNumber\": \"\",\n \"customerCode\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/devices/:code/payment/purchase", "host": [ "{{baseUrl}}" ], "path": [ "devices", ":code", "payment", "purchase" ], "variable": [ { "key": "code" } ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-a9887852-305a-44a5-bf58-7918129f6b36" }, { "id": "f37187dc-b88f-4f06-b9bc-7303df5b8af2", "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "api-token", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"currency\": \"\",\n \"transactionAmount\": \"\",\n \"invoiceNumber\": \"\",\n \"customerCode\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/devices/:code/payment/purchase", "host": [ "{{baseUrl}}" ], "path": [ "devices", ":code", "payment", "purchase" ], "variable": [ { "key": "code" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-f37187dc-b88f-4f06-b9bc-7303df5b8af2" }, { "id": "aa3f0c0a-1666-4159-8f6e-7975b90fac6b", "name": "Device Not Found", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "api-token", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"currency\": \"\",\n \"transactionAmount\": \"\",\n \"invoiceNumber\": \"\",\n \"customerCode\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/devices/:code/payment/purchase", "host": [ "{{baseUrl}}" ], "path": [ "devices", ":code", "payment", "purchase" ], "variable": [ { "key": "code" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-aa3f0c0a-1666-4159-8f6e-7975b90fac6b" }, { "id": "4dd8d04b-7171-468e-b452-fac9305ca5f4", "name": "Device Not Listening", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "api-token", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"currency\": \"\",\n \"transactionAmount\": \"\",\n \"invoiceNumber\": \"\",\n \"customerCode\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/devices/:code/payment/purchase", "host": [ "{{baseUrl}}" ], "path": [ "devices", ":code", "payment", "purchase" ], "variable": [ { "key": "code" } ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-4dd8d04b-7171-468e-b452-fac9305ca5f4" }, { "id": "b7043675-a3e9-457a-9e65-18f0ec020235", "name": "Internal server error", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "api-token", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"currency\": \"\",\n \"transactionAmount\": \"\",\n \"invoiceNumber\": \"\",\n \"customerCode\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/devices/:code/payment/purchase", "host": [ "{{baseUrl}}" ], "path": [ "devices", ":code", "payment", "purchase" ], "variable": [ { "key": "code" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-b7043675-a3e9-457a-9e65-18f0ec020235" } ], "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-59cb9f9f-bda8-46d6-ae4c-4e7aa36e6460" } ], "id": "d52afab2-0af6-43d4-9f2b-83b3adae6086", "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-d52afab2-0af6-43d4-9f2b-83b3adae6086" }, { "name": "refund", "item": [ { "name": "Start A Refund", "id": "fdd37dc3-104e-44ec-8a9b-95d784107b7b", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api-token", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"transactionAmount\": \"\",\n \"originalTransactionId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/devices/:code/payment/refund", "host": [ "{{baseUrl}}" ], "path": [ "devices", ":code", "payment", "refund" ], "variable": [ { "id": "deab0f61-e3d2-4c49-8593-f44c48139e9f", "key": "code", "value": "", "description": "(Required) Four Digit Alphanumeric Code." } ] }, "description": "This operation requires the provided API key to have Processing permission set to 'Admin'.\n" }, "response": [ { "id": "0eb7cd0e-61e2-41f1-b71e-8b99cc2520cd", "name": "Accepted", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "api-token", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"transactionAmount\": \"\",\n \"originalTransactionId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/devices/:code/payment/refund", "host": [ "{{baseUrl}}" ], "path": [ "devices", ":code", "payment", "refund" ], "variable": [ { "key": "code" } ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-0eb7cd0e-61e2-41f1-b71e-8b99cc2520cd" }, { "id": "24b4ddc8-2a25-43f5-80fb-ca82462de7d7", "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "api-token", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"transactionAmount\": \"\",\n \"originalTransactionId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/devices/:code/payment/refund", "host": [ "{{baseUrl}}" ], "path": [ "devices", ":code", "payment", "refund" ], "variable": [ { "key": "code" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-24b4ddc8-2a25-43f5-80fb-ca82462de7d7" }, { "id": "f1c471df-4c0c-4cdb-8c21-f8cbf88726b4", "name": "Device Not Found", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "api-token", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"transactionAmount\": \"\",\n \"originalTransactionId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/devices/:code/payment/refund", "host": [ "{{baseUrl}}" ], "path": [ "devices", ":code", "payment", "refund" ], "variable": [ { "key": "code" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-f1c471df-4c0c-4cdb-8c21-f8cbf88726b4" }, { "id": "d6986ac3-fb1c-4519-83fc-5068a53c0ff1", "name": "Device Not Listening", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "api-token", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"transactionAmount\": \"\",\n \"originalTransactionId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/devices/:code/payment/refund", "host": [ "{{baseUrl}}" ], "path": [ "devices", ":code", "payment", "refund" ], "variable": [ { "key": "code" } ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-d6986ac3-fb1c-4519-83fc-5068a53c0ff1" }, { "id": "23fec0b2-52b4-4dbf-b8c6-dc43ecb3dc31", "name": "Internal server error", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "api-token", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"transactionAmount\": \"\",\n \"originalTransactionId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/devices/:code/payment/refund", "host": [ "{{baseUrl}}" ], "path": [ "devices", ":code", "payment", "refund" ], "variable": [ { "key": "code" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-23fec0b2-52b4-4dbf-b8c6-dc43ecb3dc31" } ], "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-fdd37dc3-104e-44ec-8a9b-95d784107b7b" } ], "id": "b8bce605-8f0b-4fd4-b255-273f6c6128d1", "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-b8bce605-8f0b-4fd4-b255-273f6c6128d1" } ], "id": "5534737d-7a6f-4a4c-b520-9616801a8eaf", "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-5534737d-7a6f-4a4c-b520-9616801a8eaf" }, { "name": "ping", "item": [ { "name": "Send a Ping Event to a Device", "id": "d6f613f5-0dab-427b-9bcd-3a972d156264", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api-token", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/devices/:code/ping", "host": [ "{{baseUrl}}" ], "path": [ "devices", ":code", "ping" ], "variable": [ { "id": "6521ef91-f7ff-4aa6-a612-38336f3bf9dc", "key": "code", "value": "", "description": "(Required) Four Digit Alphanumeric Code" } ] } }, "response": [ { "id": "b7efc21f-8cf3-4288-a421-7fbe76cbc203", "name": "Accepted", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "api-token", "value": "" } ], "url": { "raw": "{{baseUrl}}/devices/:code/ping", "host": [ "{{baseUrl}}" ], "path": [ "devices", ":code", "ping" ], "variable": [ { "key": "code" } ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-b7efc21f-8cf3-4288-a421-7fbe76cbc203" }, { "id": "449f4756-88d3-4c9c-a632-04a3bc782410", "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "api-token", "value": "" } ], "url": { "raw": "{{baseUrl}}/devices/:code/ping", "host": [ "{{baseUrl}}" ], "path": [ "devices", ":code", "ping" ], "variable": [ { "key": "code" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-449f4756-88d3-4c9c-a632-04a3bc782410" }, { "id": "601b0064-5369-48af-92d0-5c661947fb06", "name": "Device Not Found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "api-token", "value": "" } ], "url": { "raw": "{{baseUrl}}/devices/:code/ping", "host": [ "{{baseUrl}}" ], "path": [ "devices", ":code", "ping" ], "variable": [ { "key": "code" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-601b0064-5369-48af-92d0-5c661947fb06" }, { "id": "463fb8b5-4e7b-49d7-9e95-0df3a23485ef", "name": "Device Not Listening", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "api-token", "value": "" } ], "url": { "raw": "{{baseUrl}}/devices/:code/ping", "host": [ "{{baseUrl}}" ], "path": [ "devices", ":code", "ping" ], "variable": [ { "key": "code" } ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-463fb8b5-4e7b-49d7-9e95-0df3a23485ef" }, { "id": "941bb32a-1fca-492d-9260-a4b21e650099", "name": "Internal server error", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "api-token", "value": "" } ], "url": { "raw": "{{baseUrl}}/devices/:code/ping", "host": [ "{{baseUrl}}" ], "path": [ "devices", ":code", "ping" ], "variable": [ { "key": "code" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-941bb32a-1fca-492d-9260-a4b21e650099" } ], "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-d6f613f5-0dab-427b-9bcd-3a972d156264" } ], "id": "31218120-4ae7-44fb-a12a-8db5b0fa462c", "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-31218120-4ae7-44fb-a12a-8db5b0fa462c" }, { "name": "Get Device Information", "id": "b537658e-d426-4f20-8a55-bedb474eaf6f", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api-token", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/devices/:code", "host": [ "{{baseUrl}}" ], "path": [ "devices", ":code" ], "variable": [ { "id": "c45f9bd5-fcf5-497b-ae88-c52d950fb244", "key": "code", "value": "", "description": "(Required) Four Digit Alphanumeric Code" } ] }, "description": "This operation requires the provided API key to have General permission set to 'Read' or higher, and Settings permission set to 'Read' or higher.\n" }, "response": [ { "id": "da60f151-cfac-489b-af75-1ff9820c2821", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "api-token", "value": "" } ], "url": { "raw": "{{baseUrl}}/devices/:code", "host": [ "{{baseUrl}}" ], "path": [ "devices", ":code" ], "variable": [ { "key": "code" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"dateCreated\": \"\"\n}", "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-da60f151-cfac-489b-af75-1ff9820c2821" }, { "id": "2a749edd-23fd-4df1-862e-e3b1898496de", "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "api-token", "value": "" } ], "url": { "raw": "{{baseUrl}}/devices/:code", "host": [ "{{baseUrl}}" ], "path": [ "devices", ":code" ], "variable": [ { "key": "code" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-2a749edd-23fd-4df1-862e-e3b1898496de" }, { "id": "c9de10d6-a127-463d-8e76-fd319bcb1d22", "name": "Device Not Found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "api-token", "value": "" } ], "url": { "raw": "{{baseUrl}}/devices/:code", "host": [ "{{baseUrl}}" ], "path": [ "devices", ":code" ], "variable": [ { "key": "code" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-c9de10d6-a127-463d-8e76-fd319bcb1d22" }, { "id": "f2cee2d1-ca90-4f8c-acca-70c0c086cf27", "name": "Internal server error", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "api-token", "value": "" } ], "url": { "raw": "{{baseUrl}}/devices/:code", "host": [ "{{baseUrl}}" ], "path": [ "devices", ":code" ], "variable": [ { "key": "code" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-f2cee2d1-ca90-4f8c-acca-70c0c086cf27" } ], "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-b537658e-d426-4f20-8a55-bedb474eaf6f" } ], "id": "47c5fb5c-2de4-4aeb-86a5-b3300b66c68b", "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-47c5fb5c-2de4-4aeb-86a5-b3300b66c68b" }, { "name": "Get Devices", "id": "f4930dfe-9b90-48b1-a626-d6984866e2e0", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api-token", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/devices?code=&limit=100&offset=0&page=0", "host": [ "{{baseUrl}}" ], "path": [ "devices" ], "query": [ { "description": "Four Digit Alphanumeric Code. Can be a partial match.", "key": "code", "value": "" }, { "description": "Specifies the maximum number of devices to be returned in one request.\nThe maximum allowed limit is 100 objects per request.\nIf not specified, the default limit is 100 objects.\n", "key": "limit", "value": "100" }, { "description": "Specifies the offset of the results you want to retrieve.\nNote: offset and page cannot be used simultaneously.\n", "key": "offset", "value": "0" }, { "description": "Specifies the page number of the results you want to retrieve.\nNote: offset and page cannot be used simultaneously.\n", "key": "page", "value": "0" } ] }, "description": "This operation requires the provided API key to have General permission set to 'Read' or higher, and Settings permission set to 'Read' or higher.\n" }, "response": [ { "id": "fc4a6310-390e-4d35-97a9-637672e49aba", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "api-token", "value": "" } ], "url": { "raw": "{{baseUrl}}/devices?code=&limit=100&offset=0&page=0", "host": [ "{{baseUrl}}" ], "path": [ "devices" ], "query": [ { "description": "Four Digit Alphanumeric Code. Can be a partial match.", "key": "code", "value": "" }, { "description": "Specifies the maximum number of devices to be returned in one request.\nThe maximum allowed limit is 100 objects per request.\nIf not specified, the default limit is 100 objects.\n", "key": "limit", "value": "100" }, { "description": "Specifies the offset of the results you want to retrieve.\nNote: offset and page cannot be used simultaneously.\n", "key": "offset", "value": "0" }, { "description": "Specifies the page number of the results you want to retrieve.\nNote: offset and page cannot be used simultaneously.\n", "key": "page", "value": "0" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"code\": \"\",\n \"dateCreated\": \"\"\n },\n {\n \"code\": \"\",\n \"dateCreated\": \"\"\n }\n]", "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-fc4a6310-390e-4d35-97a9-637672e49aba" }, { "id": "6bc4894d-a0e0-402c-bc72-8e8407eeb367", "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "api-token", "value": "" } ], "url": { "raw": "{{baseUrl}}/devices?code=&limit=100&offset=0&page=0", "host": [ "{{baseUrl}}" ], "path": [ "devices" ], "query": [ { "description": "Four Digit Alphanumeric Code. Can be a partial match.", "key": "code", "value": "" }, { "description": "Specifies the maximum number of devices to be returned in one request.\nThe maximum allowed limit is 100 objects per request.\nIf not specified, the default limit is 100 objects.\n", "key": "limit", "value": "100" }, { "description": "Specifies the offset of the results you want to retrieve.\nNote: offset and page cannot be used simultaneously.\n", "key": "offset", "value": "0" }, { "description": "Specifies the page number of the results you want to retrieve.\nNote: offset and page cannot be used simultaneously.\n", "key": "page", "value": "0" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-6bc4894d-a0e0-402c-bc72-8e8407eeb367" }, { "id": "eddfb9ca-6367-464f-a9eb-eeb63d60bf9b", "name": "Devices Not Found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "api-token", "value": "" } ], "url": { "raw": "{{baseUrl}}/devices?code=&limit=100&offset=0&page=0", "host": [ "{{baseUrl}}" ], "path": [ "devices" ], "query": [ { "description": "Four Digit Alphanumeric Code. Can be a partial match.", "key": "code", "value": "" }, { "description": "Specifies the maximum number of devices to be returned in one request.\nThe maximum allowed limit is 100 objects per request.\nIf not specified, the default limit is 100 objects.\n", "key": "limit", "value": "100" }, { "description": "Specifies the offset of the results you want to retrieve.\nNote: offset and page cannot be used simultaneously.\n", "key": "offset", "value": "0" }, { "description": "Specifies the page number of the results you want to retrieve.\nNote: offset and page cannot be used simultaneously.\n", "key": "page", "value": "0" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-eddfb9ca-6367-464f-a9eb-eeb63d60bf9b" }, { "id": "14a0d47d-2716-4fd7-99ae-7fb4951a877f", "name": "Internal server error", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "api-token", "value": "" } ], "url": { "raw": "{{baseUrl}}/devices?code=&limit=100&offset=0&page=0", "host": [ "{{baseUrl}}" ], "path": [ "devices" ], "query": [ { "description": "Four Digit Alphanumeric Code. Can be a partial match.", "key": "code", "value": "" }, { "description": "Specifies the maximum number of devices to be returned in one request.\nThe maximum allowed limit is 100 objects per request.\nIf not specified, the default limit is 100 objects.\n", "key": "limit", "value": "100" }, { "description": "Specifies the offset of the results you want to retrieve.\nNote: offset and page cannot be used simultaneously.\n", "key": "offset", "value": "0" }, { "description": "Specifies the page number of the results you want to retrieve.\nNote: offset and page cannot be used simultaneously.\n", "key": "page", "value": "0" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-14a0d47d-2716-4fd7-99ae-7fb4951a877f" } ], "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-f4930dfe-9b90-48b1-a626-d6984866e2e0" } ], "id": "9ea4e0f7-dcff-4775-8a74-59cff24986a4", "createdAt": "2026-07-28T01:54:30.000Z", "updatedAt": "2026-07-28T01:54:30.000Z", "uid": "35240-9ea4e0f7-dcff-4775-8a74-59cff24986a4" } ], "variable": [ { "key": "baseUrl", "value": "https://api.helcim.com/v2" } ] }