{ "variable": [ { "id": "baseUrl", "key": "baseUrl", "type": "string", "name": "string", "value": "https:\/\/app.dimepayments.com" } ], "info": { "name": "Dime Payments API Documentation", "_postman_id": "e5764d38-4454-45a6-9d4f-9ca690e8278e", "description": "A simple, basic API for managing Merchants through Dime Payments. JSON based REST API", "schema": "https:\/\/schema.getpostman.com\/json\/collection\/v2.1.0\/collection.json" }, "item": [ { "name": "Merchant management", "description": "", "item": [ { "name": "List Merchants", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/merchant\/list", "query": [], "raw": "{{baseUrl}}\/api\/merchant\/list" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"filters\":{\"start_date\":\"2024-01-01 00:00:00\",\"end_date\":\"2024-12-31 23:59:59\"}}" }, "description": "Get a list of all merchants and their fields" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"name\":\"Dime Payments\",\"dba\":\"\",\"sid\":\"00001\",\"ein\":\"\",\"mcc\":\"8999\",\"slug\":\"pay\",\"pub_api_key\":\"pkapi_prod_B5n2hQhy6uAp1rLjqs\",\"processor_mid\":\"650000012366624\",\"active\":true,\"pipeline_stage\":null,\"pipeline_lost_at\":null,\"active_at\":null,\"manual_only_at\":null,\"pending_cancellation\":null,\"approved_cancellation\":null,\"approved_cancellation_by\":null,\"g_pay\":false,\"a_pay\":false,\"pci_compliance\":true,\"api_access\":\"2025-05-20T12:43:00.000000Z\",\"api_enabled_by_id\":1,\"website\":\"https:\\\/\\\/dimepayments.com\",\"addr1\":\"53 S. Main St\",\"addr2\":\"\",\"addr3\":\"\",\"city\":\"Alpharetta\",\"state\":\"GA\",\"zip\":\"30009\",\"phone\":\"4049064975\",\"primary_phone\":\"4049064975\",\"primary_email\":\"ben@dimepayments.com\",\"primary_name\":\"Ben Habeck\"},{\"name\":\"Dime Payments\",\"dba\":\"\",\"sid\":\"00001\",\"ein\":\"\",\"mcc\":\"8999\",\"slug\":\"pay\",\"pub_api_key\":\"pkapi_prod_B5n2hQhy6uAp1rLjqs\",\"processor_mid\":\"650000012366624\",\"active\":true,\"pipeline_stage\":null,\"pipeline_lost_at\":null,\"active_at\":null,\"manual_only_at\":null,\"pending_cancellation\":null,\"approved_cancellation\":null,\"approved_cancellation_by\":null,\"g_pay\":false,\"a_pay\":false,\"pci_compliance\":true,\"api_access\":\"2025-05-20T12:43:00.000000Z\",\"api_enabled_by_id\":1,\"website\":\"https:\\\/\\\/dimepayments.com\",\"addr1\":\"53 S. Main St\",\"addr2\":\"\",\"addr3\":\"\",\"city\":\"Alpharetta\",\"state\":\"GA\",\"zip\":\"30009\",\"phone\":\"4049064975\",\"primary_phone\":\"4049064975\",\"primary_email\":\"ben@dimepayments.com\",\"primary_name\":\"Ben Habeck\"}]}", "name": "" }, { "header": [], "code": 400, "body": "{\n \"errors\":\n {\n \"filters.start_date\": [\"The filters.start_date field must be a valid date.\"]\n }\n }", "name": "Failed validation" }, { "header": [], "code": 401, "body": "{\"message\": \"Permission Denied.\"}", "name": "Bad API Key Permission" } ] }, { "name": "Show a specific Merchant's Details", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/merchant\/show", "query": [], "raw": "{{baseUrl}}\/api\/merchant\/show" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"data\":{\"sid\":1234567}}" }, "description": "List all non-protected fields for a merchant. Other fields are available using their specific requests." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": {\n \"name\": \"Dime Payments\",\n \"sid\": \"00001\",\n \"mcc\": \"8999\",\n \"slug\": \"pay\",\n \"pub_api_key\": \"pkapi_prod_B5n2hQhy6uAp1rLjqs\",\n \"processor_mid\": \"650000012366624\",\n \"active\": true,\n \"active_at\": null,\n \"g_pay\": false,\n \"a_pay\": false,\n \"pci_compliance\": true,\n \"website\": \"https:\/\/dimepayments.com\",\n \"addr1\": \"53 S. Main St\",\n \"addr2\": \"\",\n \"city\": \"Alpharetta\",\n \"state\": \"GA\",\n \"zip\": \"30009\",\n \"phone\": \"4049064975\",\n \"primary_phone\": \"4049064975\",\n \"primary_email\": \"ben@dimepayments.com\",\n \"primary_name\": \"Ben Habeck\"\n }\n}", "name": "" }, { "header": [], "code": 400, "body": "{\n \"errors\":\n {\n \"filters.start_date\": [\"The filters.start_date field must be a valid date.\"]\n }\n }", "name": "Failed validation" }, { "header": [], "code": 401, "body": "{\"message\": \"Permission Denied.\"}", "name": "Bad API Key Permission" } ] }, { "name": "Create Merchant", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/merchant\/create", "query": [], "raw": "{{baseUrl}}\/api\/merchant\/create" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"data\":{\"name\":\"Acme Inc\",\"slug\":\"acme-inc\",\"mcc\":8661,\"website\":\"https:\\\/\\\/acme-inc.com\",\"addr1\":\"123 4th Street\",\"addr2\":\"Suite 5\",\"city\":\"Alpharetta\",\"state\":\"GA\",\"zip\":30009,\"phone\":\"+177012345678\",\"primary_phone\":\"+140412345678\",\"primary_name\":\"John Doe\",\"primary_email\":\"john@acme.com\",\"industry\":\"Church\",\"acknowledge_duplicate\":false}}" }, "description": "Create a merchant record which can be used for generating an application." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": {\n \"name\": \"Dime Payments\",\n \"sid\": \"00001\",\n \"mcc\": \"8999\",\n \"slug\": \"pay\",\n \"pub_api_key\": \"pkapi_prod_B5n2hQhy6uAp1rLjqs\",\n \"processor_mid\": \"650000012366624\",\n \"active\": true,\n \"active_at\": null,\n \"g_pay\": false,\n \"a_pay\": false,\n \"pci_compliance\": true,\n \"website\": \"https:\/\/dimepayments.com\",\n \"addr1\": \"53 S. Main St\",\n \"addr2\": \"\",\n \"city\": \"Alpharetta\",\n \"state\": \"GA\",\n \"zip\": \"30009\",\n \"phone\": \"4049064975\",\n \"primary_phone\": \"4049064975\",\n \"primary_email\": \"ben@dimepayments.com\",\n \"primary_name\": \"Ben Habeck\"\n }\n}", "name": "" }, { "header": [], "code": 400, "body": "{\n \"errors\":\n {\n \"data.phone\": [\"The data.phone field is required.\"]\n }\n }", "name": "Failed validation" }, { "header": [], "code": 400, "body": "{\"data\": {\"message\": \"Something went wrong: contact Dime Payments Rep\"}}", "name": "Merchant not created" }, { "header": [], "code": 401, "body": "{\"message\": \"Permission Denied.\"}", "name": "Bad API Key Permission" }, { "header": [], "code": 409, "body": "{\n \"data\":\n {\n \"message\": \"You already have one or more merchants that look like this one. ...\",\n \"possible_duplicates\":\n [\n {\"sid\": \"00031\", \"name\": \"Abundance Ministries\", \"matched_on\": \"Same business name\", \"onboarded\": true}\n ]\n }\n }", "name": "Looks like a merchant you already have" } ] }, { "name": "Update a specific Merchant's Details", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/merchant\/update", "query": [], "raw": "{{baseUrl}}\/api\/merchant\/update" }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"data\":{\"sid\":99,\"slug\":\"acme-inc\",\"name\":\"Acme Inc\",\"mcc\":8661,\"website\":\"https:\\\/\\\/acme-inc.com\",\"addr1\":\"123 4th Street\",\"addr2\":\"Suite 5\",\"city\":\"Alpharetta\",\"state\":\"GA\",\"zip\":30009,\"phone\":\"+177012345678\",\"primary_phone\":\"+140412345678\",\"primary_name\":\"John Doe\",\"primary_email\":\"john@acme.com\",\"industry\":\"Church\"}}" }, "description": "Update a Merchant's details." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": {\n \"name\": \"Dime Payments\",\n \"sid\": \"00001\",\n \"mcc\": \"8999\",\n \"slug\": \"pay\",\n \"pub_api_key\": \"pkapi_prod_B5n2hQhy6uAp1rLjqs\",\n \"processor_mid\": \"650000012366624\",\n \"active\": true,\n \"active_at\": null,\n \"g_pay\": false,\n \"a_pay\": false,\n \"pci_compliance\": true,\n \"website\": \"https:\/\/dimepayments.com\",\n \"addr1\": \"53 S. Main St\",\n \"addr2\": \"\",\n \"city\": \"Alpharetta\",\n \"state\": \"GA\",\n \"zip\": \"30009\",\n \"phone\": \"4049064975\",\n \"primary_phone\": \"4049064975\",\n \"primary_email\": \"ben@dimepayments.com\",\n \"primary_name\": \"Ben Habeck\"\n }\n}", "name": "" }, { "header": [], "code": 400, "body": "{\n \"errors\":\n {\n \"data.phone\": [\"The data.phone field is required.\"]\n }\n }", "name": "Failed validation" }, { "header": [], "code": 400, "body": "{\"data\": {\"message\": \"Something went wrong: contact Dime Payments Rep\"}}", "name": "Merchant not created" }, { "header": [], "code": 401, "body": "{\"message\": \"Permission Denied.\"}", "name": "Bad API Key Permission" } ] }, { "name": "Get a unique, secure link to the signup application for a Merchant.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/merchant\/get-form-link", "query": [], "raw": "{{baseUrl}}\/api\/merchant\/get-form-link" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"data\":{\"sid\":69}}" }, "description": "Passed a merchant's ID, returns a full URL to the application for processor\napproval. This link expires in 30 days (App\\Models\\Company::APPLICATION_LINK_DAYS)." }, "response": [ { "header": [], "code": 200, "body": "{\"data\": {\"link\": \"https:\/\/app.dimepayments.com\/some\/link\"}}", "name": "Success" }, { "header": [], "code": 400, "body": "{\n \"errors\":\n {\n \"data.sid\": [\"The data.sid field is required.\"]\n }\n }", "name": "Failed validation" }, { "header": [], "code": 401, "body": "{\"message\": \"Permission Denied.\"}", "name": "Bad API Key Permission" } ] } ] }, { "name": "Transaction management", "description": "\nAPIs for managing transactions. Depending on API KEY permissions, one should be able to\ncharge credit cards, ACH, Google\/Apple Pay wallets along with other functions.", "item": [ { "name": "List Transactions", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/transactions", "query": [], "raw": "{{baseUrl}}\/api\/transactions" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"data\":{\"sid\":\"12345\"},\"filters\":{\"start_date\":\"2021-01-01 00:00:00\",\"end_date\":\"2021-12-31 23:59:59\",\"sweep_id\":\"sweep_123*\",\"customer_uuid\":\"cust_456\"}}" }, "description": "Retrieves a list of transactions for a given Merchant, filtered by various parameters." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"transaction_type\":\"CC\",\"transaction_status\":\"CC_CREDIT\",\"transaction_status_description\":\"Successful credit\\\/debit card transaction that brings funds into the merchant account.\",\"transaction_number\":\"741046715\",\"transaction_date\":\"2023-02-15T19:14:44.000000Z\",\"fund_date\":\"2023-02-17T05:05:35.000000Z\",\"settle_date\":\"2023-03-24T11:30:04.000000Z\",\"amount\":\"1.0000\",\"description\":\"\",\"status_code\":\"\",\"status_text\":\"\",\"email\":\"\",\"phone\":\"\",\"customer_uuid\":\"\",\"multi_use_token\":\"\",\"pending\":false,\"transaction_info_id\":\"789161791\",\"parent_transaction_info_id\":\"\",\"billing_address\":{\"first_name\":null,\"last_name\":null,\"addr1\":null,\"addr2\":null,\"city\":null,\"state\":null,\"zip\":null},\"shippingAddress\":{\"addr1\":null,\"addr2\":null,\"city\":null,\"state\":null,\"zip\":null}},{\"transaction_type\":\"CC\",\"transaction_status\":\"CC_CREDIT\",\"transaction_status_description\":\"Successful credit\\\/debit card transaction that brings funds into the merchant account.\",\"transaction_number\":\"741046715\",\"transaction_date\":\"2023-02-15T19:14:44.000000Z\",\"fund_date\":\"2023-02-17T05:05:35.000000Z\",\"settle_date\":\"2023-03-24T11:30:04.000000Z\",\"amount\":\"1.0000\",\"description\":\"\",\"status_code\":\"\",\"status_text\":\"\",\"email\":\"\",\"phone\":\"\",\"customer_uuid\":\"\",\"multi_use_token\":\"\",\"pending\":false,\"transaction_info_id\":\"789161791\",\"parent_transaction_info_id\":\"\",\"billing_address\":{\"first_name\":null,\"last_name\":null,\"addr1\":null,\"addr2\":null,\"city\":null,\"state\":null,\"zip\":null},\"shippingAddress\":{\"addr1\":null,\"addr2\":null,\"city\":null,\"state\":null,\"zip\":null}}],\"links\":{\"prev\":null,\"next\":null},\"meta\":{\"path\":\"\\\/\",\"per_page\":15,\"next_cursor\":null,\"prev_cursor\":null}}", "name": "" }, { "header": [], "code": 400, "body": "{\n \"errors\":\n {\n \"filters.start_date\": [\"The filters.start_date field must be a valid date.\"]\n }\n}", "name": "Failed validation" }, { "header": [], "code": 401, "body": "{\"data\": { \"message\": \"Permission Denied.\"}}", "name": "Token unauthorized" }, { "header": [], "code": 401, "body": "{\"data\": { \"message\": \"Unauthorized\"}}", "name": "Invalid merchant or affiliate authorization" }, { "header": [], "code": 401, "body": "{\"data\": { \"message\": \"Not associated with affiliate\"}}", "name": "Invalid merchant or affiliate associations" }, { "header": [], "code": 404, "body": "{\"data\": { \"message\": \"No such Merchant\"}}", "name": "Invalid sid" }, { "header": [], "code": 404, "body": "{\"data\": {\"message\": \"No transactions found\"}}", "name": "No transactions found" } ] }, { "name": "Charge a Credit Card", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/transaction\/charge-card", "query": [], "raw": "{{baseUrl}}\/api\/transaction\/charge-card" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"data\":{\"amount\":4326.41688,\"sid\":1234567,\"phone\":\"+177012345678\",\"customer_uuid\":\"977e5426-8d13-3824-86aa-b092f8ae52c5\",\"email\":\"gbailey@example.net\",\"memo\":\"architecto\",\"token\":\"abc123\",\"cardholder_name\":\"John Doe\",\"card_number\":1231231231231231,\"expiration_date\":\"01\\\/2025\",\"cvv\":123,\"billing_address\":{\"first_name\":\"m\",\"last_name\":\"i\",\"addr1\":\"1234 Main St\",\"addr2\":\"Suite 100\",\"city\":\"Atlanta\",\"state\":\"NY\",\"zip\":10001},\"shipping_address\":{\"addr1\":\"123 A Street\",\"addr2\":\"Suite 123\",\"city\":\"Alpharetta\",\"state\":\"GA\",\"zip\":12345},\"uuid\":\"60dac128-28da-41ae-8632-aee299de13fd\"}}" }, "description": "This endpoint allows you to charge a credit card using the PAN Data or a Token. This endpoint will process the charge and return a token\nrepresenting the card that can be used for transactions as well as the transactionId and the customerUUID if requested.\nIf you pass a customer UUID or a customer phone number, then a customer record will be created or retrieved if it already exists, also making the customer UUID available for the purpose of associating charges to a customer.\nYou must be PCI Compliant (have an AoC on file with Dime Payments) to process PAN Data. A token can optionally be provided to process charges without requiring PCI compliance as no PAN data is being sent." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": {\n \"transaction_type\": \"Credit Card\",\n \"transaction_status\": \"Success\",\n \"transaction_status_description\": \"Transaction Successful\",\n \"transaction_number\": \"1234567890\",\n \"transaction_date\": \"2020-01-01\",\n \"fund_date\": \"2020-01-01\",\n \"settle_date\": \"2020-01-01\",\n \"amount\": \"100.00\",\n \"description\": \"a memo concerning this transaction\",\n \"status_code\": \"00\",\n \"status_text\": \"APPROVAL\",\n \"email\": \"email@email.com\",\n \"phone\": \"+17701234567\",\n \"customer_uuid\": \"66f1c230-1337-5g59-b43c-1bcb83adfaaa\",\n \"multi_use_token\": \"abcdefg123456790\",\n \"pending\": true,\n \"transaction_info_id\": \"1234567890\",\n \"parent_transaction_info_id\": \"1234567890\",\n \"billing_address\": {\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"addr1\": \"123 Main St\",\n \"addr2\": \"Suite 100\",\n \"city\": \"New York\",\n \"state\": \"NY\"\n },\n \"shipping_address\": {\n \"addr1\": \"12 Street Ave\",\n \"addr2\": \"Suite 123\",\n \"city\": \"Boulder\",\n \"state\": \"CO\",\n \"zip\": \"80302\"\n }\n }\n}", "name": "" }, { "header": [], "code": 400, "body": "{\n \"errors\": {\n \"sid\": [\n \"The sid is required.\"\n ]\n }\n}", "name": "" }, { "header": [], "code": 400, "body": "{\n \"data\": {\n \"transaction_type\": \"Credit Card\",\n \"transaction_status\": \"Failed\",\n \"transaction_status_description\": \"Transaction failed\",\n \"transaction_number\": \"1234567890\",\n \"transaction_date\": \"2020-01-01\",\n \"fund_date\": \"2020-01-01\",\n \"settle_date\": \"2020-01-01\",\n \"amount\": \"100.00\",\n \"description\": \"a memo concerning this transaction\",\n \"status_code\": \"05\",\n \"status_text\": \"DECLINE\",\n \"email\": \"email@email.com\",\n \"phone\": \"+17701234567\",\n \"customer_uuid\": \"66f1c230-1337-5g59-b43c-1bcb83adfaaa\",\n \"multi_use_token\": \"abcdefg123456790\",\n \"pending\": true,\n \"transaction_info_id\": \"1234567890\",\n \"parent_transaction_info_id\": \"1234567890\",\n \"billing_address\": {\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"addr1\": \"123 Main St\",\n \"addr2\": \"Suite 100\",\n \"city\": \"New York\",\n \"state\": \"NY\"\n },\n \"shipping_address\": {\n \"addr1\": \"12 Street Ave\",\n \"addr2\": \"Suite 123\",\n \"city\": \"Boulder\",\n \"state\": \"CO\",\n \"zip\": \"80302\"\n }\n }\n}", "name": "" }, { "header": [], "code": 403, "body": "{\n \"message\": \"Permission Denied.\"\n}", "name": "" } ] }, { "name": "Charge a Bank Account", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/transaction\/charge-ach", "query": [], "raw": "{{baseUrl}}\/api\/transaction\/charge-ach" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"data\":{\"sid\":1234567,\"routing_number\":\"123456789\",\"account_number\":\"91828382\",\"account_type\":\"Checking\",\"account_name\":\"Acme Inc.\",\"amount\":99.19,\"phone\":\"7701234567\",\"customer_uuid\":\"12312312-123123123-1231231231\",\"email\":\"okon.justina@example.com\",\"memo\":\"payment for something\",\"billing_address\":{\"first_name\":\"Ryan\",\"last_name\":\"Taylor\",\"addr1\":\"123 A Street\",\"addr2\":\"Suite 123\",\"city\":\"Alpharetta\",\"state\":\"GA\",\"zip\":30009},\"shipping_address\":{\"addr1\":\"123 A Street\",\"addr2\":\"Suite 123\",\"city\":\"Alpharetta\",\"state\":\"GA\",\"zip\":12345}}}" }, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": {\n \"transaction_type\": \"ACH\",\n \"transaction_status\": \"Success\",\n \"transaction_status_description\": \"Success\",\n \"transaction_number\": \"130\",\n \"transaction_date\": \"2021-01-01\",\n \"fund_date\": \"2021-01-01\",\n \"settle_date\": \"2021-01-01\",\n \"amount\": \"25\",\n \"description\": \"\",\n \"status_code\": \"00\",\n \"status_text\": \"Success\",\n \"email\": \"test@test.com\",\n \"phone\": \"\",\n \"customer_uuid\": \"\",\n \"multi_use_token\": \"\",\n \"pending\": false,\n \"transaction_info_id\": \"1234567890\",\n \"parent_transaction_info_id\": \"1234567890\",\n \"billing_address\": {\n \"first_name\": \"First\",\n \"last_name\": \"Last\",\n \"addr1\": \"12 Street Ave\",\n \"addr2\": \"Suite 123\",\n \"city\": \"Boulder\",\n \"state\": \"CO\",\n \"zip\": \"80302\"\n },\n \"shipping_address\": {\n \"addr1\": \"12 Street Ave\",\n \"addr2\": \"Suite 123\",\n \"city\": \"Boulder\",\n \"state\": \"CO\",\n \"zip\": \"80302\"\n }\n }\n}", "name": "Successful Transaction" }, { "header": [], "code": 400, "body": "{\n \"errors\":\n {\n \"data.amount\": [\"The data.amount field is required.\"],\n \"data.account_type\": [\"The selected data.account_type is invalid.\"]\n }\n}", "name": "Failed validation" }, { "header": [], "code": 401, "body": "{\"data\": { \"message\": \"Permission Denied.\"}}", "name": "Token unauthorized" }, { "header": [], "code": 401, "body": "{\"data\": { \"message\": \"Unauthorized\"}}", "name": "Invalid merchant or affiliate authorization" }, { "header": [], "code": 401, "body": "{\"data\": { \"message\": \"Not associated with affiliate\"}}", "name": "Invalid merchant or affiliate association" }, { "header": [], "code": 404, "body": "{\"data\": { \"message\": \"No such Merchant\"}}", "name": "Invalid sid" } ] }, { "name": "Tokenize a Credit Card", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/transaction\/tokenize-card", "query": [], "raw": "{{baseUrl}}\/api\/transaction\/tokenize-card" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"data\":{\"sid\":1234567,\"cardholder_name\":\"John Doe\",\"card_number\":1234567812345678,\"expiration_date\":\"01\\\/2025\",\"cvv\":123,\"billing_address\":{\"addr1\":\"1234 Main St\",\"addr2\":\"Suite 100\",\"city\":\"New York\",\"state\":\"NY\",\"zip\":10001}}}" }, "description": "This endpoint allows you to tokenize a credit card, which will verify its validity and return a token representing the card that can be used for transactions. This method requires PCI compliance on the part of the affiliate or merchant." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": {\n \"token\": \"abcd1234\"\n }\n}", "name": "" }, { "header": [], "code": 400, "body": "{\n \"errors\": {\n \"card_number\": [\n \"The card number must be a number.\"\n ]\n }\n}", "name": "" }, { "header": [], "code": 400, "body": "{\n \"data\": {\n \"message\": \"Validation of card failed.\"\n }\n}", "name": "" }, { "header": [], "code": 401, "body": "{\n \"data\": {\n \"message\": \"Permission Denied.\"\n }\n}", "name": "" } ] }, { "name": "Show Transaction", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/transaction", "query": [], "raw": "{{baseUrl}}\/api\/transaction" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"data\":{\"sid\":1234567,\"transaction_info_id\":6789131231,\"transaction_type\":\"ACH\",\"transaction_id\":123}}" }, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": {\n \"transaction_type\": \"CC\",\n \"transaction_status\": \"CC Pending\",\n \"transaction_status_description\": \"A cc transaction that is pending\",\n \"transaction_number\": \"1231\",\n \"transaction_date\": \"2021-01-01\",\n \"fund_date\": \"2021-01-01\",\n \"settle_date\": \"2021-01-01\",\n \"amount\": \"25.0000\",\n \"description\": \"\",\n \"status_code\": \"\",\n \"status_text\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"customer_uuid\": \"68d9feaa-04a9-4c48-8c00-a0b79c8b2f70\",\n \"multi_use_token\": \"\",\n \"pending\": true,\n \"transaction_info_id\": \"1231321\",\n \"parent_transaction_info_id\": \"12313244444\",\n \"billing_address\": {\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"addr1\": \"\",\n \"addr2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\"\n },\n \"shipping_address\": {\n \"addr1\": \"123 Main St\",\n \"addr2\": \"apt 1\",\n \"city\": \"Alpharetta\",\n \"state\": \"GA\",\n \"zip\": \"12345\"\n }\n }\n}", "name": "Successful Show" }, { "header": [], "code": 400, "body": "{\"errors\": {\"data.sid\": [\"The data.sid is not the correct format.\"]}}", "name": "Field Validation Failed" }, { "header": [], "code": 401, "body": "{\"data\": {\"message\": \"Permission Denied.\"}}", "name": "Invalid API Key Permission" }, { "header": [], "code": 401, "body": "{\"data\": {\"message\": \"User not associated with the affiliate.\"}}", "name": "User perm issue" }, { "header": [], "code": 404, "body": "{\"data\": {\"message\": \"No transaction found\"}}", "name": "No transaction found" } ] }, { "name": "Authorize a Credit Card", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/transaction\/authorize", "query": [], "raw": "{{baseUrl}}\/api\/transaction\/authorize" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"data\":{\"amount\":100.5,\"sid\":1234567,\"phone\":\"+17701234567\",\"customer_uuid\":\"60dac128-28da-41ae-8632-aee299de13fd\",\"email\":\"john@example.com\",\"memo\":\"order 1234\",\"token\":\"abc123def456\",\"cardholder_name\":\"John Doe\",\"card_number\":1231231231231231,\"expiration_date\":\"01\\\/2030\",\"cvv\":123,\"billing_address\":{\"first_name\":\"John\",\"last_name\":\"Doe\",\"addr1\":\"1234 Main St\",\"addr2\":\"Suite 100\",\"city\":\"Atlanta\",\"state\":\"NY\",\"zip\":10001},\"shipping_address\":{\"addr1\":\"123 A Street\",\"addr2\":\"Suite 123\",\"city\":\"Alpharetta\",\"state\":\"GA\",\"zip\":12345}}}" }, "description": "Places a hold on a credit card without moving any money. The authorized amount is reserved\nagainst the cardholder's available credit, and no funds reach the merchant until the\nauthorization is captured via the capture endpoint.\n\nUse this when the final amount is not yet known or goods have not shipped. Capture the\nauthorization once you are ready to collect. An authorization that is never captured is\nreleased by the card issuer on its own schedule, so capture promptly \u2014 typically within 24\nhours \u2014 to avoid the hold expiring.\n\nThe `transaction_number` in the response is your handle on the authorization: pass it as\n`data.transaction_id` to the capture endpoint to collect, or to the void endpoint to release.\n\n**Releasing the hold.** If the sale falls through, release the held funds instead of\ncapturing by calling the void endpoint \u2014 `PATCH \/api\/transaction\/void`:\n\n```json\n{ \"data\": { \"sid\": 1234567, \"transaction_type\": \"CC\", \"transaction_id\": \"1234567890\" } }\n```\n\n`data.transaction_type` must be `CC`. Voiding is gated by its own separate API key\npermission, not by this one, so make sure your key carries it if you need to release holds.\n\n**Two ways to supply the card, pick one.** Either send a `token` from the tokenize-card\nendpoint, or send the raw card fields \u2014 `card_number`, `expiration_date`, `cardholder_name` and\n`billing_address.zip`, all four of which are required only when no `token` is present, and\nignored when one is. Sending raw card data requires PCI compliance (an AoC on file with Dime\nPayments); a token does not, because no card number is transmitted." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": {\n \"transaction_type\": \"Credit Card\",\n \"transaction_status\": \"Pending\",\n \"transaction_status_description\": \"Pending\",\n \"transaction_number\": \"1234567890\",\n \"transaction_date\": \"2020-01-01\",\n \"fund_date\": \"\",\n \"settle_date\": \"\",\n \"amount\": \"100.50\",\n \"description\": \"a memo concerning this transaction\",\n \"status_code\": \"00\",\n \"status_text\": \"APPROVAL\",\n \"email\": \"email@email.com\",\n \"phone\": \"+17701234567\",\n \"customer_uuid\": \"66f1c230-1337-5g59-b43c-1bcb83adfaaa\",\n \"multi_use_token\": \"abcdefg123456790\",\n \"pending\": true,\n \"transaction_info_id\": \"\",\n \"parent_transaction_info_id\": \"\",\n \"billing_address\": {\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"addr1\": \"123 Main St\",\n \"addr2\": \"Suite 100\",\n \"city\": \"New York\",\n \"state\": \"NY\",\n \"zip\": \"10001\"\n },\n \"shipping_address\": {\n \"addr1\": \"12 Street Ave\",\n \"addr2\": \"Suite 123\",\n \"city\": \"Boulder\",\n \"state\": \"CO\",\n \"zip\": \"80302\"\n }\n }\n}", "name": "Successful Authorization" }, { "header": [], "code": 400, "body": "{\n \"errors\": {\n \"data.amount\": [\"The data.amount field is required.\"]\n }\n}", "name": "Failed validation" }, { "header": [], "code": 400, "body": "{\n \"data\": {\n \"transaction_type\": \"Credit Card\",\n \"transaction_status\": \"\",\n \"transaction_status_description\": \"\",\n \"transaction_number\": \"\",\n \"amount\": \"100.50\",\n \"status_code\": \"05\",\n \"status_text\": \"DECLINE\",\n \"pending\": false\n }\n}", "name": "Processor declined the authorization" }, { "header": [], "code": 401, "body": "{\"data\": {\"message\": \"Permission Denied.\"}}", "name": "Token unauthorized" }, { "header": [], "code": 401, "body": "{\"data\": {\"message\": \"Not associated with Affiliate\"}}", "name": "Invalid merchant or affiliate association" }, { "header": [], "code": 403, "body": "{\"data\": {\"message\": \"Merchant is not PCI Compliant\"}}", "name": "Merchant not PCI compliant" }, { "header": [], "code": 404, "body": "{\"data\": {\"message\": \"No such Merchant\"}}", "name": "Invalid sid" }, { "header": [], "code": 422, "body": "{\"data\": {\"message\": \"Token expired. Please retokenize, or provide the card details.\"}}", "name": "Expired token" } ] }, { "name": "Capture an Authorized Credit Card", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/transaction\/capture", "query": [], "raw": "{{baseUrl}}\/api\/transaction\/capture" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"data\":{\"sid\":1234567,\"transaction_id\":1234567890,\"amount\":100.5}}" }, "description": "Captures funds from a credit card authorization created by the authorize endpoint. This is the\npoint at which money actually moves: the authorization only reserved the funds.\n\nPass the `transaction_number` returned by the authorize endpoint as `data.transaction_id`.\nOmit `data.amount` to capture the full authorized amount, or pass a smaller amount to capture\npart of it \u2014 useful when the final total came in below the original estimate. The capture\namount may not exceed the authorized amount.\n\n**An authorization can only be captured once, and a partial capture closes it.** Capturing\n$50 of a $100 hold settles $50 and releases the remaining $50 back to the cardholder \u2014 a\nsecond call for the balance is refused with \"Transaction is not an open authorization.\" If you\nneed to collect in more than one instalment (a split shipment, say), authorize each instalment\nseparately. Capture the true final amount in one call wherever you can.\n\nCapture promptly, typically within 24 hours of authorizing: an uncaptured authorization is\nreleased by the card issuer on its own schedule and can no longer be captured once it expires.\n\nA captured transaction becomes an ordinary card payment and can be refunded or voided through\nthe refund and void endpoints. Note that the refund endpoint voids rather than refunds until\nthe transaction has settled, and reports `\"message\": \"void\"` when it does \u2014 that is the\ncorrect handling for money that has not left the cardholder's account yet, and it emits a\nCredit Card Void event rather than a Credit Card Refund one.\n\nTo release a hold without taking any money, do not call this endpoint \u2014 call\n`PATCH \/api\/transaction\/void` with `data.transaction_type` of `CC` and the authorization's\n`transaction_number` as `data.transaction_id`. The refund and void endpoints are gated by\ntheir own separate API key permission, not by this one." }, "response": [ { "header": [], "code": 200, "body": "{\"data\": {\"message\": \"Transaction captured successfully.\"}}", "name": "Successful Capture" }, { "header": [], "code": 400, "body": "{\"errors\": {\"data.transaction_id\": [\"The data.transaction_id field is required.\"]}}", "name": "Field Validation Failed" }, { "header": [], "code": 400, "body": "{\"data\": {\"message\": \"No transaction found.\"}}", "name": "Transaction not found" }, { "header": [], "code": 400, "body": "{\"data\": {\"message\": \"Transaction is not an open authorization.\"}}", "name": "Not an open authorization" }, { "header": [], "code": 400, "body": "{\"data\": {\"message\": \"Amount cannot be greater than the authorized amount\"}}", "name": "Amount exceeds the authorization" }, { "header": [], "code": 400, "body": "{\"data\": {\"message\": \"Error processing capture\"}}", "name": "Processor could not capture" }, { "header": [], "code": 400, "body": "{\"data\": {\"message\": \"Unsupported processor.\"}}", "name": "Unsupported Processor" }, { "header": [], "code": 401, "body": "{\"data\": {\"message\": \"Permission Denied.\"}}", "name": "Bad API Key Permission" }, { "header": [], "code": 401, "body": "{\"data\": {\"message\": \"Not associated with Affiliate\"}}", "name": "Invalid merchant or affiliate association" }, { "header": [], "code": 404, "body": "{\"data\": {\"message\": \"No such Merchant\"}}", "name": "Invalid sid" } ] }, { "name": "Refund Transaction", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/transaction\/refund", "query": [], "raw": "{{baseUrl}}\/api\/transaction\/refund" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"data\":{\"sid\":1234567,\"amount\":100.5,\"transaction_info_id\":6789131231,\"transaction_type\":\"CC\",\"transaction_id\":6789131231,\"override_ach_settlement_wait\":true}}" }, "description": "Processes a refund for a transaction based on the provided data." }, "response": [ { "header": [], "code": 200, "body": "{\"data\": { \"message\" : \"refund\"}}", "name": "Successful Refund" }, { "header": [], "code": 200, "body": "{\"data\": { \"message\" : \"refund\"}}", "name": "Unsettled ACH refund submitted with override_ach_settlement_wait" }, { "header": [], "code": 400, "body": "{\n \"errors\":\n {\n \"data.sid\": [\"The sid field is required.\"],\n \"data.transaction_info_id\": [\"The selected transaction_info_id is invalid.\"]\n }\n}", "name": "" }, { "header": [], "code": 400, "body": "{\n \"data\": {\n \"message\": \"No such Merchant\"\n }\n }", "name": "" }, { "header": [], "code": 400, "body": "{\n \"message\": \"ACH transactions can only be refunded after 7 days. 4.9999996830324 day(s) remaining.\"\n }", "name": "Unsettled ACH payment, no override sent" }, { "header": [], "code": 400, "body": "{\n \"data\": {\n \"message\": \"Error processing refund\"\n }\n }", "name": "" }, { "header": [], "code": 400, "body": "{\n \"data\":\n {\n \"message\": \"Unsupported processor.\"\n }\n }", "name": "" }, { "header": [], "code": 401, "body": "{\"data\": {\"message\": \"Permission Denied.\"}}", "name": "Bad API Key Permission" } ] }, { "name": "Void Transaction", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/transaction\/void", "query": [], "raw": "{{baseUrl}}\/api\/transaction\/void" }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"data\":{\"sid\":\"91828382\",\"transaction_type\":\"ACH\",\"transaction_id\":123}}" }, "description": "Void a transaction" }, "response": [ { "header": [], "code": 200, "body": "{\"data\": {\"message\" : \"Transaction voided successfully\"}}", "name": "Successful Void" }, { "header": [], "code": 400, "body": "{\"errors\": {\"data.sid\": [\"The data.sid is not the correct format.\"]}}", "name": "Field Validation Failed" }, { "header": [], "code": 400, "body": "{\"data\": {\"message\": \"No transaction found\"}}", "name": "Transaction not found" }, { "header": [], "code": 400, "body": "{\"data\": {\"message\": \"Unsupported Processor\"}}", "name": "Unsupported Processor" }, { "header": [], "code": 400, "body": "{\"data\": {\"message\": \"Transaction cannot be voided\"}}", "name": "Transaction cannot be voided" }, { "header": [], "code": 401, "body": "{\"data\": {\"message\": \"Permission Denied.\"}}", "name": "Bad API Key Permission" }, { "header": [], "code": 401, "body": "{\"data\": {\"message\": \"User not associated with the affiliate.\"}}", "name": "User perm issue" } ] } ] }, { "name": "Chargeback management", "description": "", "item": [ { "name": "List Chargebacks", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/chargeback\/list", "query": [], "raw": "{{baseUrl}}\/api\/chargeback\/list" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"data\":{\"sid\":\"91828382\"},\"filters\":{\"start_date\":\"\\\"2026-04-01 00:00:00\\\"\",\"end_date\":\"\\\"2026-04-30 23:59:59\\\"\",\"representment_status\":\"\\\"New\\\"\"}}" }, "description": "Get the chargebacks raised against a merchant.\n\nChargeback data reaches us through a once-daily file from the processor,\nso this reflects the most recent daily import rather than live dispute\nactivity. Pair it with the `chargeback_opened` \/ `chargeback_updated` \/\n`chargeback_resolved` webhooks: the webhooks tell you when something\nchanged, this endpoint is how you reconcile or backfill after an outage,\nsince webhook deliveries are not replayable." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": [\n {\n \"transaction_info_id\": \"1134722723\",\n \"parent_transaction_info_id\": \"1132652128\",\n \"gateway_transaction_id\": null,\n \"transaction_number\": \"1566\",\n \"invoice_number\": null,\n \"chargeback_date\": \"2025-05-04T17:45:05-04:00\",\n \"merchant_chargeback_date\": \"2025-05-04T19:45:05-04:00\",\n \"transaction_amount\": 391.48,\n \"chargeback_amount\": 391.48,\n \"card_brand\": \"V\",\n \"cc_last_four\": \"2510\",\n \"payee_name\": null,\n \"days_to_represent\": 0,\n \"representment_date\": \"2025-05-12T06:26:00-04:00\",\n \"merchant_representment_date\": \"2025-05-05T07:32:01-04:00\",\n \"representment_status\": \"accepting chargeback\",\n \"result\": \"Accepting\",\n \"chargeback_code\": \"4\",\n \"chargeback_response_code\": \"Other fraud - Card Absent Environment\",\n \"resolved\": false\n },\n {\n \"transaction_info_id\": \"1134722723\",\n \"parent_transaction_info_id\": \"1132652128\",\n \"gateway_transaction_id\": null,\n \"transaction_number\": \"1566\",\n \"invoice_number\": null,\n \"chargeback_date\": \"2025-05-04T17:45:05-04:00\",\n \"merchant_chargeback_date\": \"2025-05-04T19:45:05-04:00\",\n \"transaction_amount\": 391.48,\n \"chargeback_amount\": 391.48,\n \"card_brand\": \"V\",\n \"cc_last_four\": \"2510\",\n \"payee_name\": null,\n \"days_to_represent\": 0,\n \"representment_date\": \"2025-05-12T06:26:00-04:00\",\n \"merchant_representment_date\": \"2025-05-05T07:32:01-04:00\",\n \"representment_status\": \"accepting chargeback\",\n \"result\": \"Accepting\",\n \"chargeback_code\": \"4\",\n \"chargeback_response_code\": \"Other fraud - Card Absent Environment\",\n \"resolved\": false\n }\n ],\n \"links\": {\n \"prev\": null,\n \"next\": null\n },\n \"meta\": {\n \"path\": \"\/\",\n \"per_page\": 500,\n \"next_cursor\": null,\n \"prev_cursor\": null\n }\n}", "name": "" }, { "header": [], "code": 400, "body": "{\n \"errors\": {\n \"filters.start_date\": [\n \"The filters.start_date field must match the format Y-m-d H:i:s.\"\n ]\n }\n}", "name": "Malformed Request" }, { "header": [], "code": 401, "body": "{\"data\": {\"message\": \"Permission Denied.\"}}", "name": "Incorrect API Key Permission" }, { "header": [], "code": 401, "body": "{\"data\": {\"message\": \"Not associated with Affiliate\"}}", "name": "Not associated with Affiliate" }, { "header": [], "code": 404, "body": "{\"data\": {\"message\": \"No such Merchant\"}}", "name": "Unknown merchant" }, { "header": [], "code": 404, "body": "{\"data\": {\"message\": \"No chargebacks found\"}}", "name": "No chargebacks found" } ] }, { "name": "Show Chargeback", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/chargeback\/show", "query": [], "raw": "{{baseUrl}}\/api\/chargeback\/show" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"data\":{\"sid\":\"91828382\",\"transaction_info_id\":\"\\\"8675309\\\"\"}}" }, "description": "Get a single chargeback by its processor identifier." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"transaction_info_id\":\"1134722723\",\"parent_transaction_info_id\":\"1132652128\",\"gateway_transaction_id\":null,\"transaction_number\":\"1566\",\"invoice_number\":null,\"chargeback_date\":\"2025-05-04T17:45:05-04:00\",\"merchant_chargeback_date\":\"2025-05-04T19:45:05-04:00\",\"transaction_amount\":391.48,\"chargeback_amount\":391.48,\"card_brand\":\"V\",\"cc_last_four\":\"2510\",\"payee_name\":null,\"days_to_represent\":0,\"representment_date\":\"2025-05-12T06:26:00-04:00\",\"merchant_representment_date\":\"2025-05-05T07:32:01-04:00\",\"representment_status\":\"accepting chargeback\",\"result\":\"Accepting\",\"chargeback_code\":\"4\",\"chargeback_response_code\":\"Other fraud - Card Absent Environment\",\"resolved\":false}}", "name": "" }, { "header": [], "code": 400, "body": "{\n \"errors\": {\n \"data.transaction_info_id\": [\"The data.transaction_info_id field is required.\"]\n }\n}", "name": "Malformed Request" }, { "header": [], "code": 401, "body": "{\"data\": {\"message\": \"Permission Denied.\"}}", "name": "Incorrect API Key Permission" }, { "header": [], "code": 401, "body": "{\"data\": {\"message\": \"Not associated with Affiliate\"}}", "name": "Not associated with Affiliate" }, { "header": [], "code": 404, "body": "{\"data\": {\"message\": \"No such Merchant\"}}", "name": "Unknown merchant" }, { "header": [], "code": 404, "body": "{\"data\": {\"message\": \"No chargeback found\"}}", "name": "No chargeback found" } ] } ] }, { "name": "Document management", "description": "", "item": [ { "name": "Upload Documents", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/document\/upload", "query": [], "raw": "{{baseUrl}}\/api\/document\/upload" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart\/form-data" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "formdata", "formdata": [ { "key": "data[sid]", "value": "91828382", "type": "text", "description": "" }, { "key": "data[doc_type]", "value": "RetrievalRequest", "type": "text", "description": "" }, { "key": "data[chargeback_transaction_info_id]", "value": "\"8675309\"", "type": "text", "description": "" }, { "key": "files[]", "src": [], "type": "file" } ] }, "description": "Send us one or more documents for a merchant, stating what they are for.\n\nThis endpoint is general purpose \u2014 underwriting paperwork, identity\nverification, and evidence contesting a chargeback all come through here,\ndistinguished by `data.doc_type`. To attach evidence to a specific\ndispute, pass `data.chargeback_transaction_info_id` as well; the value is\nthe `transaction_info_id` from the chargeback endpoints or the chargeback\nwebhooks.\n\n**This request is `multipart\/form-data`, not JSON** \u2014 it is the only\nendpoint on this API that is. Send the body fields as form fields named\n`data[sid]`, `data[doc_type]` and so on, and the files as `files[]`.\n\nNote the bracket notation: multipart has no JSON parsing, so a single\nfield named `data` containing `{\"sid\": \"...\"}` is read as a plain string\nand the merchant is never identified. That fails as\n`403 You do not have access to this company.`, which looks like a\ncredentials problem but is not \u2014 check your field names first. Likewise\nthe files field is `files[]`, not `files`.\n\nFiles are stored independently. If one fails, the rest are still kept and\nthe response lists what did not store under `failed`, so you can re-send\nonly those rather than the whole batch.\n\nUploading does not send the document to the processor. It lands in the\nmerchant's document list and notifies our team, who review it and forward\nit. There is no programmatic way to file a representment with the\nprocessor on your behalf." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": {\n \"message\": \"2 documents uploaded.\",\n \"documents\": [\n {\"uuid\": \"9b1c...\", \"file_name\": \"receipt.pdf\", \"doc_type\": \"RetrievalRequest\", \"size\": 20841}\n ]\n }\n}", "name": "Uploaded" }, { "header": [], "code": 200, "body": "{\n \"data\": {\n \"message\": \"2 documents uploaded. 1 could not be stored.\",\n \"documents\": [\n {\"uuid\": \"9b1c...\", \"file_name\": \"receipt.pdf\", \"doc_type\": \"RetrievalRequest\", \"size\": 20841}\n ],\n \"failed\": [\n {\"file_name\": \"statement.pdf\", \"reason\": \"The file could not be stored. Send it again.\"}\n ]\n }\n}", "name": "Partly uploaded" }, { "header": [], "code": 400, "body": "{\n \"errors\": {\n \"files.0\": [\"The files.0 field must be a file of type: pdf, jpg, jpeg, png, doc, docx, rtf.\"]\n }\n}", "name": "Malformed Request" }, { "header": [], "code": 401, "body": "{\"data\": {\"message\": \"Permission Denied.\"}}", "name": "Incorrect API Key Permission" }, { "header": [], "code": 401, "body": "{\"data\": {\"message\": \"Not associated with Affiliate\"}}", "name": "Not associated with Affiliate" }, { "header": [], "code": 404, "body": "{\"data\": {\"message\": \"No such Merchant\"}}", "name": "Unknown merchant" }, { "header": [], "code": 413, "body": "{\n \"errors\": {\n \"files\": [\"The upload is larger than this server accepts (8M per request). Send fewer files per request, or split them across requests.\"]\n }\n}", "name": "Request too large" }, { "header": [], "code": 422, "body": "{\"data\": {\"message\": \"Merchant is not set up to receive documents\"}}", "name": "Merchant not set up for documents" } ] }, { "name": "List Documents", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/document\/list", "query": [], "raw": "{{baseUrl}}\/api\/document\/list" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"data\":{\"sid\":\"91828382\"},\"filters\":{\"doc_type\":\"RetrievalRequest\",\"chargeback_transaction_info_id\":\"\\\"8675309\\\"\"}}" }, "description": "The documents held for a merchant, so you can confirm what we have\nreceived. Covers documents uploaded through this API and those added by\nour team or through the merchant application." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": [\n {\n \"uuid\": \"9b1c...\",\n \"file_name\": \"receipt.pdf\",\n \"doc_type\": \"RetrievalRequest\",\n \"chargeback_transaction_info_id\": \"8675309\",\n \"size\": 20841,\n \"uploaded_at\": \"2026-09-18T11:35:01+00:00\",\n \"uploaded_via\": \"api\",\n \"sent_to_processor\": null\n }\n ]\n}", "name": "Found" }, { "header": [], "code": 401, "body": "{\"data\": {\"message\": \"Permission Denied.\"}}", "name": "Incorrect API Key Permission" }, { "header": [], "code": 404, "body": "{\"data\": {\"message\": \"No such Merchant\"}}", "name": "Unknown merchant" }, { "header": [], "code": 404, "body": "{\"data\": {\"message\": \"No documents found\"}}", "name": "No documents found" } ] } ] }, { "name": "Addresses", "description": "\nAPIs for managing customer addresses", "item": [ { "name": "List Addresses", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/address\/list", "query": [], "raw": "{{baseUrl}}\/api\/address\/list" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"data\":{\"sid\":12345,\"uuid\":\"60dac128-28da-41ae-8632-aee299de13fd\"}}" }, "description": "List all addresses for a specific customer." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": [\n [\n {\n \"id\": 1,\n \"recipient\": null,\n \"line_one\": \"\",\n \"line_two\": null,\n \"line_three\": null,\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\"\n },\n {\n \"id\": 1,\n \"recipient\": null,\n \"line_one\": \"\",\n \"line_two\": null,\n \"line_three\": null,\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\"\n }\n ]\n ]\n}", "name": "" }, { "header": [], "code": 401, "body": "{\n \"data\": {\n \"message\": \"Permission Denied.\"\n }\n}", "name": "Unauthorized Access" }, { "header": [], "code": 404, "body": "{\n \"data\": {\n \"message\": \"No such Customer\"\n }\n}", "name": "Customer Not Found" }, { "header": [], "code": 404, "body": "{\n \"data\": {\n \"message\": \"No such Merchant\"\n }\n}", "name": "Merchant Not Found" } ] }, { "name": "Show Address", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/address\/show", "query": [], "raw": "{{baseUrl}}\/api\/address\/show" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"data\":{\"sid\":12345,\"uuid\":\"60dac128-28da-41ae-8632-aee299de13fd\",\"address_id\":1}}" }, "description": "Show details of a specific address." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": {\n \"address_id\": 1,\n \"recipient\": null,\n \"line_one\": \"\",\n \"line_two\": null,\n \"line_three\": null,\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\"\n }\n}", "name": "" }, { "header": [], "code": 401, "body": "{\n \"data\": {\n \"message\": \"Permission Denied.\"\n }\n}", "name": "Unauthorized Access" }, { "header": [], "code": 404, "body": "{\n \"data\": {\n \"message\": \"No such Address\"\n }\n}", "name": "Address Not Found" }, { "header": [], "code": 404, "body": "{\n \"data\": {\n \"message\": \"No such Merchant\"\n }\n}", "name": "Merchant Not Found" }, { "header": [], "code": 404, "body": "{\n \"data\": {\n \"message\": \"No such Customer\"\n }\n}", "name": "Customer Not Found" } ] }, { "name": "Create Address", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/address\/create", "query": [], "raw": "{{baseUrl}}\/api\/address\/create" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"data\":{\"sid\":12345,\"uuid\":\"60dac128-28da-41ae-8632-aee299de13fd\",\"recipient\":\"John Doe\",\"line_one\":\"123 Main St\",\"line_two\":\"Apt 4B\",\"line_three\":\"architecto\",\"city\":\"Atlanta\",\"state\":\"GA\",\"zip\":\"30301\"}}" }, "description": "Create a new address for a customer." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": {\n \"address_id\": 1,\n \"recipient\": null,\n \"line_one\": \"\",\n \"line_two\": null,\n \"line_three\": null,\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\"\n }\n}", "name": "" }, { "header": [], "code": 400, "body": "{\n \"data\": {\n \"message\": \"Failed to create address\"\n }\n}", "name": "Creation Failed" }, { "header": [], "code": 401, "body": "{\n \"data\": {\n \"message\": \"Permission Denied.\"\n }\n}", "name": "Unauthorized Access" }, { "header": [], "code": 404, "body": "{\n \"data\": {\n \"message\": \"No such Merchant\"\n }\n}", "name": "Merchant Not Found" }, { "header": [], "code": 404, "body": "{\n \"data\": {\n \"message\": \"No such Customer\"\n }\n}", "name": "Customer Not Found" } ] }, { "name": "Update Address", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/address\/update", "query": [], "raw": "{{baseUrl}}\/api\/address\/update" }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"data\":{\"sid\":12345,\"uuid\":\"60dac128-28da-41ae-8632-aee299de13fd\",\"address_id\":1,\"recipient\":\"John Doe\",\"line_one\":\"123 Main St\",\"line_two\":\"Apt 4B\",\"line_three\":\"architecto\",\"city\":\"Atlanta\",\"state\":\"GA\",\"zip\":\"30301\"}}" }, "description": "Update an existing address." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": {\n \"address_id\": 1,\n \"recipient\": null,\n \"line_one\": \"\",\n \"line_two\": null,\n \"line_three\": null,\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\"\n }\n}", "name": "" }, { "header": [], "code": 400, "body": "{\n \"data\": {\n \"message\": \"Failed to update address\"\n }\n}", "name": "Update Failed" }, { "header": [], "code": 401, "body": "{\n \"data\": {\n \"message\": \"Permission Denied.\"\n }\n}", "name": "Unauthorized Access" }, { "header": [], "code": 404, "body": "{\n \"data\": {\n \"message\": \"No such Merchant\"\n }\n}", "name": "Merchant Not Found" }, { "header": [], "code": 404, "body": "{\n \"data\": {\n \"message\": \"No such Customer\"\n }\n}", "name": "Customer Not Found" } ] }, { "name": "Delete Address", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/address\/delete", "query": [], "raw": "{{baseUrl}}\/api\/address\/delete" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"data\":{\"sid\":12345,\"uuid\":\"60dac128-28da-41ae-8632-aee299de13fd\",\"address_id\":1}}" }, "description": "Remove an address from a customer." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": {\n \"message\": \"Address deleted successfully\"\n }\n}", "name": "Address Deleted Successfully" }, { "header": [], "code": 400, "body": "{\n \"data\": {\n \"message\": \"Unable to delete\"\n }\n}", "name": "Deletion Failed" }, { "header": [], "code": 401, "body": "{\n \"data\": {\n \"message\": \"Permission Denied.\"\n }\n}", "name": "Unauthorized Access" }, { "header": [], "code": 404, "body": "{\n \"data\": {\n \"message\": \"No such Address\"\n }\n}", "name": "Address Not Found" }, { "header": [], "code": 404, "body": "{\n \"data\": {\n \"message\": \"No such Merchant\"\n }\n}", "name": "Merchant Not Found" }, { "header": [], "code": 404, "body": "{\n \"data\": {\n \"message\": \"No such Customer\"\n }\n}", "name": "Customer Not Found" } ] } ] }, { "name": "Customer management", "description": "\nAPIs for managing customers. Depending on API KEY permissions, one should be able to\nlist, create, update, and delete customers along with several other customer specific requests.", "item": [ { "name": "List Customers", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/customer\/list", "query": [], "raw": "{{baseUrl}}\/api\/customer\/list" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"data\":{\"sid\":12345},\"filters\":{\"start_date\":\"2024-01-01 00:00:00\",\"end_date\":\"2024-12-31 23:59:59\",\"phone\":\"+15555555555\",\"email\":\"example@example.com\"}}" }, "description": "Retrieves a list of customers for a given company, filtered by various parameters." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": [\n [\n {\n \"id\": 6,\n \"uuid\": \"66f1c230-68cf-4d58-b47c-1bcb83adfddd\",\n \"first_name\": \"Ryan\",\n \"last_name\": \"Taylor\",\n \"company_name\": \"\",\n \"phone\": \"+17707892072\",\n \"phone_verified_at\": \"2026-09-04T20:40:06.000000Z\",\n \"email\": \"rtaylor82@gmail.com\",\n \"email_verified_at\": null,\n \"addr1\": \"4655 Hwy 136 W\",\n \"addr2\": \"\",\n \"addr3\": \"\",\n \"city\": \"Dawsonville\",\n \"state\": \"GA\",\n \"zip\": \"30534\",\n \"country\": \"USA\",\n \"email_communications\": true,\n \"sms_communications\": false,\n \"payment_reminders\": true,\n \"last_login_at\": \"2026-09-04T20:40:06.000000Z\",\n \"last_login_ip\": \"72.255.199.38\"\n },\n {\n \"id\": 6,\n \"uuid\": \"66f1c230-68cf-4d58-b47c-1bcb83adfddd\",\n \"first_name\": \"Ryan\",\n \"last_name\": \"Taylor\",\n \"company_name\": \"\",\n \"phone\": \"+17707892072\",\n \"phone_verified_at\": \"2026-09-04T20:40:06.000000Z\",\n \"email\": \"rtaylor82@gmail.com\",\n \"email_verified_at\": null,\n \"addr1\": \"4655 Hwy 136 W\",\n \"addr2\": \"\",\n \"addr3\": \"\",\n \"city\": \"Dawsonville\",\n \"state\": \"GA\",\n \"zip\": \"30534\",\n \"country\": \"USA\",\n \"email_communications\": true,\n \"sms_communications\": false,\n \"payment_reminders\": true,\n \"last_login_at\": \"2026-09-04T20:40:06.000000Z\",\n \"last_login_ip\": \"72.255.199.38\"\n }\n ]\n ]\n}", "name": "" }, { "header": [], "code": 400, "body": "{\n \"message\": \"Validation errors\"\n }", "name": "" }, { "header": [], "code": 400, "body": "{\n \"data\":\n {\n \"message\": \"No such Merchant\"\n }\n }", "name": "" }, { "header": [], "code": 401, "body": "{\n \"data\":\n {\n \"message\": \"Permission Denied.\"\n }\n }", "name": "" }, { "header": [], "code": 401, "body": "{\n \"data\":\n {\n \"message\": \"Merchant or Affiliate check failed\"\n }\n }", "name": "" } ] }, { "name": "Show Customer", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/customer\/show", "query": [], "raw": "{{baseUrl}}\/api\/customer\/show" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"data\":{\"sid\":12345},\"filters\":{\"phone\":\"+15555555555\",\"email\":\"example@example.com\",\"uuid\":\"60dac128-28da-41ae-8632-aee299de13fd\"}}" }, "description": "Show a specific customer's details" }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": {\n \"uuid\": \"66f1c230-68cf-4d58-b47c-1bcb83adfddd\",\n \"first_name\": \"Ryan\",\n \"last_name\": \"Taylor\",\n \"phone\": \"+17707892072\",\n \"email\": \"rtaylor82@gmail.com\",\n \"addr1\": \"4655 Hwy 136 W\",\n \"addr2\": \"\",\n \"addr3\": \"\",\n \"city\": \"Dawsonville\",\n \"state\": \"GA\",\n \"zip\": \"30534\",\n \"country\": \"USA\"\n }\n}", "name": "" }, { "header": [], "code": 400, "body": "{\n \"message\": \"Validation errors\"\n }", "name": "" }, { "header": [], "code": 400, "body": "{\n \"data\":\n {\n \"message\": \"No such Merchant\"\n }\n }", "name": "" }, { "header": [], "code": 401, "body": "{\n \"data\":\n {\n \"message\": \"Permission Denied.\"\n }\n }", "name": "" }, { "header": [], "code": 401, "body": "{\n \"data\":\n {\n \"message\": \"Merchant or Affiliate check failed\"\n }\n }", "name": "" } ] }, { "name": "Create Customer", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/customer\/create", "query": [], "raw": "{{baseUrl}}\/api\/customer\/create" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"data\":{\"sid\":12345,\"first_name\":\"architecto\",\"last_name\":\"architecto\",\"company_name\":\"architecto\",\"phone\":\"architecto\",\"email\":\"gbailey@example.net\",\"addr1\":\"architecto\",\"addr2\":\"architecto\",\"addr3\":\"architecto\",\"city\":\"architecto\",\"state\":\"architecto\",\"zip\":\"architecto\",\"country\":\"n\"}}" }, "description": "Create a customer record linked to your Company\/Merchant." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": {\n \"uuid\": \"66f1c230-68cf-4d58-b47c-1bcb83adfddd\",\n \"first_name\": \"Ryan\",\n \"last_name\": \"Taylor\",\n \"phone\": \"+17707892072\",\n \"email\": \"rtaylor82@gmail.com\",\n \"addr1\": \"4655 Hwy 136 W\",\n \"addr2\": \"\",\n \"addr3\": \"\",\n \"city\": \"Dawsonville\",\n \"state\": \"GA\",\n \"zip\": \"30534\",\n \"country\": \"USA\"\n }\n}", "name": "" }, { "header": [], "code": 400, "body": "{\n \"message\": \"Validation errors\"\n }", "name": "" }, { "header": [], "code": 400, "body": "{\n \"message\": \"Failed to create Customer\"\n }", "name": "" }, { "header": [], "code": 400, "body": "{\n \"data\":\n {\n \"message\": \"No such Merchant\"\n }\n }", "name": "" }, { "header": [], "code": 401, "body": "{\n \"data\":\n {\n \"message\": \"Permission Denied.\"\n }\n }", "name": "" }, { "header": [], "code": 401, "body": "{\n \"data\":\n {\n \"message\": \"Merchant or Affiliate check failed\"\n }\n }", "name": "" } ] }, { "name": "Update Customer", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/customer\/update", "query": [], "raw": "{{baseUrl}}\/api\/customer\/update" }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"filters\":{\"phone\":\"+15555555555\",\"uuid\":\"60dac128-28da-41ae-8632-aee299de13fd\",\"email\":\"example@example.com\"},\"data\":{\"sid\":12345,\"first_name\":\"architecto\",\"last_name\":\"architecto\",\"company_name\":\"architecto\",\"addr1\":\"architecto\",\"addr2\":\"architecto\",\"addr3\":\"architecto\",\"city\":\"architecto\",\"state\":\"architecto\",\"zip\":\"architecto\",\"country\":\"n\"}}" }, "description": "Update a customer record. Make changes to the customer referenced by UUID, phone number, or email. One of the\nfilters is required to be provided to select a unique customer. Only pass the fields that require updating in\nthe data object." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": {\n \"uuid\": \"66f1c230-68cf-4d58-b47c-1bcb83adfddd\",\n \"first_name\": \"Ryan\",\n \"last_name\": \"Taylor\",\n \"phone\": \"+17707892072\",\n \"email\": \"rtaylor82@gmail.com\",\n \"addr1\": \"4655 Hwy 136 W\",\n \"addr2\": \"\",\n \"addr3\": \"\",\n \"city\": \"Dawsonville\",\n \"state\": \"GA\",\n \"zip\": \"30534\",\n \"country\": \"USA\"\n }\n}", "name": "" }, { "header": [], "code": 400, "body": "{\n \"message\": \"Validation errors\"\n }", "name": "" }, { "header": [], "code": 400, "body": "{\n \"data\":\n {\n \"message\": \"No such Merchant\"\n }\n }", "name": "" }, { "header": [], "code": 401, "body": "{\n \"data\":\n {\n \"message\": \"Permission Denied.\"\n }\n }", "name": "" }, { "header": [], "code": 401, "body": "{\n \"data\":\n {\n \"message\": \"Merchant or Affiliate check failed\"\n }\n }", "name": "" } ] }, { "name": "Delete Customer", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/customer\/delete", "query": [], "raw": "{{baseUrl}}\/api\/customer\/delete" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"filters\":{\"phone\":\"+15555555555\",\"uuid\":\"60dac128-28da-41ae-8632-aee299de13fd\",\"email\":\"example@example.com\"},\"data\":{\"sid\":12345}}" }, "description": "Delete a customer record from the selected Merchant. One of the filters is required to select a unique customer. This will also cancel any recurring payments associated with the customer for your company." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": {\n \"uuid\": \"66f1c230-68cf-4d58-b47c-1bcb83adfddd\",\n \"first_name\": \"Ryan\",\n \"last_name\": \"Taylor\",\n \"phone\": \"+17707892072\",\n \"email\": \"rtaylor82@gmail.com\",\n \"addr1\": \"4655 Hwy 136 W\",\n \"addr2\": \"\",\n \"addr3\": \"\",\n \"city\": \"Dawsonville\",\n \"state\": \"GA\",\n \"zip\": \"30534\",\n \"country\": \"USA\"\n }\n}", "name": "" }, { "header": [], "code": 200, "body": "{\n \"data\":\n {\n \"message\": \"Customer removed successfully\"\n }\n }", "name": "Successful Deletion" }, { "header": [], "code": 400, "body": "{\n \"message\": \"Validation errors\"\n }", "name": "" }, { "header": [], "code": 400, "body": "{\n \"data\":\n {\n \"message\": \"No such Merchant\"\n }\n }", "name": "" }, { "header": [], "code": 401, "body": "{\n \"data\":\n {\n \"message\": \"Permission Denied.\"\n }\n }", "name": "" }, { "header": [], "code": 401, "body": "{\n \"data\":\n {\n \"message\": \"Merchant or Affiliate check failed\"\n }\n }", "name": "" } ] } ] }, { "name": "Deposit management", "description": "", "item": [ { "name": "List Deposits", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/deposit\/list", "query": [], "raw": "{{baseUrl}}\/api\/deposit\/list" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"data\":{\"sid\":\"91828382\"},\"filters\":{\"start_date\":\"\\\"2024-04-01 00:00:00\\\"\",\"end_date\":\"\\\"2024-04-01 23:59:59\\\"\"}}" }, "description": "Get Deposits from Merchant Account with supporting transactions" }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": [\n {\n \"transaction_date\": \"2023-02-15T19:14:44.000000Z\",\n \"fund_date\": \"2023-02-17 00:05:35\",\n \"transaction_info_id\": \"789161791\",\n \"transaction_id\": \"1\",\n \"transaction_detail_account\": \"1005\",\n \"authorization_amount\": \"1.0000\",\n \"net_amount\": \"0.7200\",\n \"sweep_id\": \"125068038\",\n \"type\": \"withdraw_funds\"\n },\n {\n \"transaction_date\": \"2023-02-15T19:14:44.000000Z\",\n \"fund_date\": \"2023-02-17 00:05:35\",\n \"transaction_info_id\": \"789161791\",\n \"transaction_id\": \"1\",\n \"transaction_detail_account\": \"1005\",\n \"authorization_amount\": \"1.0000\",\n \"net_amount\": \"0.7200\",\n \"sweep_id\": \"125068038\",\n \"type\": \"withdraw_funds\"\n }\n ],\n \"links\": {\n \"prev\": null,\n \"next\": null\n },\n \"meta\": {\n \"path\": \"\/\",\n \"per_page\": 15,\n \"next_cursor\": null,\n \"prev_cursor\": null\n }\n}", "name": "" }, { "header": [], "code": 400, "body": "{\n \"errors\": {\n \"filters.start_date\": [\n \"The filters.start_date field must be a valid date.\",\n \"The filters.start_date field must match the format Y-m-d H:i:s.\"\n ]\n }\n}", "name": "Malformed Request" }, { "header": [], "code": 401, "body": "{\"message\": \"Permission Denied.\"}", "name": "Incorrect API Key Permission" }, { "header": [], "code": 401, "body": "{\"message\": \"Not associated with Affiliate\"}", "name": "Not associated with Affiliate" }, { "header": [], "code": 401, "body": "{\"message\": \"The selected data.sid is invalid\"}", "name": "Incorrect SID" }, { "header": [], "code": 403, "body": "{\"message\": \"Unauthorized\"}", "name": "Unauthorized" }, { "header": [], "code": 404, "body": "{\"message\": \"No deposits found\"}", "name": "No deposits found" } ] }, { "name": "List Deposits with Supporting Trans", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/deposit\/list-with-trans", "query": [], "raw": "{{baseUrl}}\/api\/deposit\/list-with-trans" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"data\":{\"sid\":\"91828382\"},\"filters\":{\"start_date\":\"2024-05-01 00:00:00\",\"end_date\":\"2024-05-01 00:00:00\"}}" }, "description": "Get Deposits from Merchant Account with supporting transactions. Could result in large datasets if range is too large." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": {\n \"sid\": \"XXXXX\",\n \"count\": 1,\n \"deposits\": {\n \"128298672\": {\n \"sid\": \"XXXXX\",\n \"transaction_info_id\": \"983999999\",\n \"transaction_id\": \"382\",\n \"transaction_date\": \"2024-05-01T04:00:00.000000Z\",\n \"fund_date\": \"2024-05-01 02:20:35\",\n \"type\": \"withdraw_funds\",\n \"countOfTransactions\": 3,\n \"transTotal\": \"545.98\",\n \"transactions\": [\n {\n \"transaction_type\": \"ACH\",\n \"transaction_status\": \"ACH_PAYMENT_CREDIT\",\n \"transaction_status_description\": \"Successfully completed ACH Payment that has been posted to the Escrow Account.\",\n \"transaction_number\": \"369\",\n \"transaction_date\": \"2024-04-29T08:30:25.000000Z\",\n \"fund_date\": \"2024-04-30T20:05:21.000000Z\",\n \"settle_date\": \"2024-04-29T17:51:02.000000Z\",\n \"amount\": \"369.0000\",\n \"description\": \"\",\n \"status_code\": \"\",\n \"status_text\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"customer_uuid\": \"\",\n \"multi_use_token\": \"\",\n \"pending\": false,\n \"transaction_info_id\": \"123123123123\",\n \"parent_transaction_info_id\": \"123123123124\",\n \"billing_address\": {\n \"first_name\": null,\n \"last_name\": null,\n \"addr1\": null,\n \"addr2\": null,\n \"city\": null,\n \"state\": null,\n \"zip\": null\n }\n },\n {\n \"transaction_type\": \"CC\",\n \"transaction_status\": \"CC_CREDIT\",\n \"transaction_status_description\": \"Successful credit\/debit card transaction that brings funds into the merchant account.\",\n \"transaction_number\": \"1919162951\",\n \"transaction_date\": \"2024-04-29T08:37:29.000000Z\",\n \"fund_date\": \"2024-04-30T20:05:22.000000Z\",\n \"settle_date\": \"2024-05-07T11:30:03.000000Z\",\n \"amount\": \"103.0800\",\n \"description\": \"\",\n \"status_code\": \"\",\n \"status_text\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"customer_uuid\": \"\",\n \"multi_use_token\": \"\",\n \"pending\": false,\n \"transaction_info_id\": \"123123123123\",\n \"parent_transaction_info_id\": \"123123123124\",\n \"billing_address\": {\n \"first_name\": null,\n \"last_name\": null,\n \"addr1\": null,\n \"addr2\": null,\n \"city\": null,\n \"state\": null,\n \"zip\": null\n }\n },\n {\n \"transaction_type\": \"CC\",\n \"transaction_status\": \"CC_CREDIT\",\n \"transaction_status_description\": \"Successful credit\/debit card transaction that brings funds into the merchant account.\",\n \"transaction_number\": \"1920383851\",\n \"transaction_date\": \"2024-04-29T11:52:43.000000Z\",\n \"fund_date\": \"2024-04-30T20:05:22.000000Z\",\n \"settle_date\": \"2024-05-07T11:30:03.000000Z\",\n \"amount\": \"82.5200\",\n \"description\": \"\",\n \"status_code\": \"\",\n \"status_text\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"customer_uuid\": \"\",\n \"multi_use_token\": \"\",\n \"pending\": false,\n \"transaction_info_id\": \"123123123123\",\n \"parent_transaction_info_id\": \"123123123124\",\n \"billing_address\": {\n \"first_name\": null,\n \"last_name\": null,\n \"addr1\": null,\n \"addr2\": null,\n \"city\": null,\n \"state\": null,\n \"zip\": null\n }\n }\n ]\n }\n }\n }\n}", "name": "Successful Transaction" }, { "header": [], "code": 200, "body": "{}", "name": "Empty Response" }, { "header": [], "code": 400, "body": "{\"errors\": {\"data.sid\": [\"The data.sid is not the correct format.\"]}}", "name": "Field Validation Failed" }, { "header": [], "code": 401, "body": "{\"data.message\": \"Permission Denied.\"}", "name": "Bad API Key Permission" }, { "header": [], "code": 401, "body": "{\"data.message\": \"No Merchant found with SID provided.\"}", "name": "No such Merchant" }, { "header": [], "code": 401, "body": "{\"data.message\": \"User not associated with the affiliate.\"}", "name": "User perm issue" }, { "header": [], "code": 401, "body": "{\"data.message\": \"Merchant not associated with affiliate.\"}", "name": "Merchant not associated" } ] }, { "name": "Show Deposit with Supporting Trans", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/deposit\/show", "query": [], "raw": "{{baseUrl}}\/api\/deposit\/show" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"data\":{\"sid\":4326.41688,\"transaction_info_id\":\"91828382\",\"sweep_id\":\"\\\"2024-04-01 00:00:00\\\"\"}}" }, "description": "Show a Deposit from Merchant Account with supporting transactions" }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": {\n \"sid\": \"XXXXX\",\n \"transaction_info_id\": \"983999999\",\n \"transaction_id\": \"382\",\n \"transaction_date\": \"2024-05-01T04:00:00.000000Z\",\n \"fund_date\": \"2024-05-01 02:20:35\",\n \"type\": \"withdraw_funds\",\n \"countOfTransactions\": 3,\n \"transTotal\": \"545.98\",\n \"transactions\": [\n {\n \"transaction_type\": \"ACH\",\n \"transaction_status\": \"ACH_PAYMENT_CREDIT\",\n \"transaction_status_description\": \"Successfully completed ACH Payment that has been posted to the Escrow Account.\",\n \"transaction_number\": \"369\",\n \"transaction_date\": \"2024-04-29T08:30:25.000000Z\",\n \"fund_date\": \"2024-04-30T20:05:21.000000Z\",\n \"settle_date\": \"2024-04-29T17:51:02.000000Z\",\n \"amount\": \"369.0000\",\n \"description\": \"\",\n \"status_code\": \"\",\n \"status_text\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"customer_uuid\": \"\",\n \"multi_use_token\": \"\",\n \"pending\": false,\n \"transaction_info_id\": \"123123212312\",\n \"parent_transaction_info_id\": \"123123212314\",\n \"billing_address\": {\n \"first_name\": null,\n \"last_name\": null,\n \"addr1\": null,\n \"addr2\": null,\n \"city\": null,\n \"state\": null,\n \"zip\": null\n }\n },\n {\n \"transaction_type\": \"CC\",\n \"transaction_status\": \"CC_CREDIT\",\n \"transaction_status_description\": \"Successful credit\/debit card transaction that brings funds into the merchant account.\",\n \"transaction_number\": \"1919162951\",\n \"transaction_date\": \"2024-04-29T08:37:29.000000Z\",\n \"fund_date\": \"2024-04-30T20:05:22.000000Z\",\n \"settle_date\": \"2024-05-07T11:30:03.000000Z\",\n \"amount\": \"103.0800\",\n \"description\": \"\",\n \"status_code\": \"\",\n \"status_text\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"customer_uuid\": \"\",\n \"multi_use_token\": \"\",\n \"pending\": false,\n \"transaction_info_id\": \"123123212312\",\n \"parent_transaction_info_id\": \"123123212314\",\n \"billing_address\": {\n \"first_name\": null,\n \"last_name\": null,\n \"addr1\": null,\n \"addr2\": null,\n \"city\": null,\n \"state\": null,\n \"zip\": null\n }\n },\n {\n \"transaction_type\": \"CC\",\n \"transaction_status\": \"CC_CREDIT\",\n \"transaction_status_description\": \"Successful credit\/debit card transaction that brings funds into the merchant account.\",\n \"transaction_number\": \"1920383851\",\n \"transaction_date\": \"2024-04-29T11:52:43.000000Z\",\n \"fund_date\": \"2024-04-30T20:05:22.000000Z\",\n \"settle_date\": \"2024-05-07T11:30:03.000000Z\",\n \"amount\": \"82.5200\",\n \"description\": \"\",\n \"status_code\": \"\",\n \"status_text\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"customer_uuid\": \"\",\n \"multi_use_token\": \"\",\n \"pending\": false,\n \"transaction_info_id\": \"123123212314\",\n \"billing_address\": {\n \"first_name\": null,\n \"last_name\": null,\n \"addr1\": null,\n \"addr2\": null,\n \"city\": null,\n \"state\": null,\n \"zip\": null\n }\n }\n ]\n }\n}", "name": "Successful Transaction" }, { "header": [], "code": 200, "body": "{}", "name": "Empty Response" }, { "header": [], "code": 400, "body": "{\"errors\": {\"data.sid\": [\"The data.sid is not the correct format.\"]}}", "name": "Field Validation Failed" }, { "header": [], "code": 401, "body": "{\"data.message\": \"Permission Denied.\"}", "name": "Bad API Key Permission" }, { "header": [], "code": 401, "body": "{\"data.message\": \"No Merchant found with SID provided.\"}", "name": "No such Merchant" }, { "header": [], "code": 401, "body": "{\"data.message\": \"User not associated with the affiliate.\"}", "name": "User perm issue" }, { "header": [], "code": 401, "body": "{\"data.message\": \"Merchant not associated with affiliate.\"}", "name": "Merchant not associated" } ] } ] }, { "name": "Invoice management", "description": "\nAPIs for managing invoices. Depending on API KEY permissions, one should be\nable to list, create, update, delete, and send invoices, manage their line\nitems, and manage recurring-invoice schedules. Every request is scoped to a\nsingle Merchant via the required `data.sid`.", "item": [ { "name": "List Invoices", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/invoices", "query": [], "raw": "{{baseUrl}}\/api\/invoices" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"data\":{\"sid\":12345},\"filters\":{\"status\":\"sent\"}}" }, "description": "Retrieves a paginated (cursor) list of invoices for a Merchant, optionally\nfiltered by status." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":1,\"invoice_number\":\"INV-0001\",\"status\":\"paid\",\"customer_name\":\"Scott Porter\",\"customer_email\":\"sporter@abidingwordchurch.org\",\"total\":2000,\"amount_paid\":2000,\"balance\":0,\"cover_fee_required\":true,\"issue_date\":\"2026-09-03\",\"due_date\":\"2026-09-18\",\"is_overdue\":false,\"public_url\":\"http:\\\/\\\/app.dimepayments.com\\\/invoice\\\/cNSdqmHw52vavVVFYchTd609JEIVJWs64HBw9QeK\"},{\"id\":1,\"invoice_number\":\"INV-0001\",\"status\":\"paid\",\"customer_name\":\"Scott Porter\",\"customer_email\":\"sporter@abidingwordchurch.org\",\"total\":2000,\"amount_paid\":2000,\"balance\":0,\"cover_fee_required\":true,\"issue_date\":\"2026-09-03\",\"due_date\":\"2026-09-18\",\"is_overdue\":false,\"public_url\":\"http:\\\/\\\/app.dimepayments.com\\\/invoice\\\/cNSdqmHw52vavVVFYchTd609JEIVJWs64HBw9QeK\"}],\"links\":{\"prev\":null,\"next\":null},\"meta\":{\"path\":\"\\\/\",\"per_page\":500,\"next_cursor\":null,\"prev_cursor\":null}}", "name": "" }, { "header": [], "code": 400, "body": "{\"errors\": {\"filters.status\": [\"The selected filters.status is invalid.\"]}}", "name": "Failed validation" }, { "header": [], "code": 401, "body": "{\"data\": {\"message\": \"Permission Denied.\"}}", "name": "Token unauthorized" }, { "header": [], "code": 404, "body": "{\"data\": {\"message\": \"No such Merchant\"}}", "name": "Invalid sid" } ] }, { "name": "Show Invoice", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/invoice", "query": [], "raw": "{{baseUrl}}\/api\/invoice" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "[]" }, "description": "Retrieves a single invoice with its line items, payments, and event history." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": {\n \"id\": 1,\n \"token\": \"cNSdqmHw52vavVVFYchTd609JEIVJWs64HBw9QeK\",\n \"invoice_number\": \"INV-0001\",\n \"status\": \"paid\",\n \"payment_terms\": \"net_15\",\n \"issue_date\": \"2026-09-03\",\n \"due_date\": \"2026-09-18\",\n \"is_overdue\": false,\n \"subtotal\": 2000,\n \"total\": 2000,\n \"amount_paid\": 2000,\n \"balance\": 0,\n \"allow_partial_payment\": false,\n \"cover_fee_required\": true,\n \"cover_fee_quote\": {\n \"basis\": \"balance\",\n \"base\": 0,\n \"cc\": {\n \"fee\": 0,\n \"total\": 0\n },\n \"ach\": {\n \"fee\": 0,\n \"total\": 0\n }\n },\n \"thank_you_note\": null,\n \"public_url\": \"http:\/\/app.dimepayments.com\/invoice\/cNSdqmHw52vavVVFYchTd609JEIVJWs64HBw9QeK\",\n \"customer\": {\n \"id\": 16032,\n \"name\": \"Scott Porter\",\n \"email\": \"sporter@abidingwordchurch.org\"\n },\n \"items\": [\n {\n \"id\": 1,\n \"item_id\": 1365,\n \"name\": \"Implementation Fee\",\n \"description\": null,\n \"quantity\": 1,\n \"unit_price\": 2000,\n \"amount\": 2000\n }\n ],\n \"payments\": [\n {\n \"amount\": 2000,\n \"cover_fee\": 56.81,\n \"paid_at\": \"2026-09-03T11:21:27-04:00\",\n \"method\": \"+CC\",\n \"transaction_id\": 107272\n }\n ],\n \"events\": [\n {\n \"type\": \"payment_received\",\n \"label\": \"Payment received\",\n \"description\": \"Payment of $2,000.00 received\",\n \"created_at\": \"2026-09-03T11:21:27-04:00\"\n },\n {\n \"type\": \"viewed\",\n \"label\": \"Invoice viewed\",\n \"description\": \"Opened by sporter@abidingwordchurch.org\",\n \"created_at\": \"2026-09-03T11:18:10-04:00\"\n },\n {\n \"type\": \"created\",\n \"label\": \"Invoice created\",\n \"description\": \"Invoice created via API\",\n \"created_at\": \"2026-09-03T11:17:43-04:00\"\n },\n {\n \"type\": \"sent\",\n \"label\": \"Invoice sent\",\n \"description\": \"Marked as sent via API \\u2014 shared manually (no email)\",\n \"created_at\": \"2026-09-03T11:17:43-04:00\"\n }\n ]\n }\n}", "name": "" }, { "header": [], "code": 401, "body": "{\"data\": {\"message\": \"Permission Denied.\"}}", "name": "Token unauthorized" }, { "header": [], "code": 404, "body": "{\"data\": {\"message\": \"No such Merchant\"}}", "name": "Invalid sid" }, { "header": [], "code": 404, "body": "{\"data\": {\"message\": \"Invoice not found\"}}", "name": "Invoice not found" } ] }, { "name": "Create Invoice", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/invoice\/create", "query": [], "raw": "{{baseUrl}}\/api\/invoice\/create" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"data\":{\"lines\":[{\"item_id\":5,\"name\":\"Consulting\",\"description\":\"2 hours\",\"quantity\":2,\"unit_price\":125}]}}" }, "description": "Creates a draft invoice with its line items. Every line must reference an\nitem (fund\/designation) that belongs to the Merchant; the line name and\nunit price are snapshotted onto the invoice. The invoice number may be\nsupplied, otherwise the next number is allocated automatically." }, "response": [ { "header": [], "code": 201, "body": "{\n \"data\": {\n \"id\": 1,\n \"token\": \"cNSdqmHw52vavVVFYchTd609JEIVJWs64HBw9QeK\",\n \"invoice_number\": \"INV-0001\",\n \"status\": \"paid\",\n \"payment_terms\": \"net_15\",\n \"issue_date\": \"2026-09-03\",\n \"due_date\": \"2026-09-18\",\n \"is_overdue\": false,\n \"subtotal\": 2000,\n \"total\": 2000,\n \"amount_paid\": 2000,\n \"balance\": 0,\n \"allow_partial_payment\": false,\n \"cover_fee_required\": true,\n \"cover_fee_quote\": {\n \"basis\": \"balance\",\n \"base\": 0,\n \"cc\": {\n \"fee\": 0,\n \"total\": 0\n },\n \"ach\": {\n \"fee\": 0,\n \"total\": 0\n }\n },\n \"thank_you_note\": null,\n \"public_url\": \"http:\/\/app.dimepayments.com\/invoice\/cNSdqmHw52vavVVFYchTd609JEIVJWs64HBw9QeK\",\n \"customer\": {\n \"id\": 16032,\n \"name\": \"Scott Porter\",\n \"email\": \"sporter@abidingwordchurch.org\"\n },\n \"items\": [\n {\n \"id\": 1,\n \"item_id\": 1365,\n \"name\": \"Implementation Fee\",\n \"description\": null,\n \"quantity\": 1,\n \"unit_price\": 2000,\n \"amount\": 2000\n }\n ],\n \"payments\": [\n {\n \"amount\": 2000,\n \"cover_fee\": 56.81,\n \"paid_at\": \"2026-09-03T11:21:27-04:00\",\n \"method\": \"+CC\",\n \"transaction_id\": 107272\n }\n ],\n \"events\": [\n {\n \"type\": \"payment_received\",\n \"label\": \"Payment received\",\n \"description\": \"Payment of $2,000.00 received\",\n \"created_at\": \"2026-09-03T11:21:27-04:00\"\n },\n {\n \"type\": \"viewed\",\n \"label\": \"Invoice viewed\",\n \"description\": \"Opened by sporter@abidingwordchurch.org\",\n \"created_at\": \"2026-09-03T11:18:10-04:00\"\n },\n {\n \"type\": \"created\",\n \"label\": \"Invoice created\",\n \"description\": \"Invoice created via API\",\n \"created_at\": \"2026-09-03T11:17:43-04:00\"\n },\n {\n \"type\": \"sent\",\n \"label\": \"Invoice sent\",\n \"description\": \"Marked as sent via API \\u2014 shared manually (no email)\",\n \"created_at\": \"2026-09-03T11:17:43-04:00\"\n }\n ]\n }\n}", "name": "" }, { "header": [], "code": 400, "body": "{\"errors\": {\"data.lines\": [\"The data.lines field is required.\"]}}", "name": "Failed validation" }, { "header": [], "code": 401, "body": "{\"data\": {\"message\": \"Permission Denied.\"}}", "name": "Token unauthorized" }, { "header": [], "code": 404, "body": "{\"data\": {\"message\": \"No such Merchant\"}}", "name": "Invalid sid" } ] }, { "name": "Update Invoice", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/invoice\/update", "query": [], "raw": "{{baseUrl}}\/api\/invoice\/update" }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"data\":{\"lines\":[{\"item_id\":5,\"name\":\"Consulting\",\"description\":\"2 hours\",\"quantity\":2,\"unit_price\":125}]}}" }, "description": "Updates a draft invoice. Only draft invoices can be edited \u2014 once sent, an\ninvoice is locked. Passing `data.lines` replaces the existing line items." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": {\n \"id\": 1,\n \"token\": \"cNSdqmHw52vavVVFYchTd609JEIVJWs64HBw9QeK\",\n \"invoice_number\": \"INV-0001\",\n \"status\": \"paid\",\n \"payment_terms\": \"net_15\",\n \"issue_date\": \"2026-09-03\",\n \"due_date\": \"2026-09-18\",\n \"is_overdue\": false,\n \"subtotal\": 2000,\n \"total\": 2000,\n \"amount_paid\": 2000,\n \"balance\": 0,\n \"allow_partial_payment\": false,\n \"cover_fee_required\": true,\n \"cover_fee_quote\": {\n \"basis\": \"balance\",\n \"base\": 0,\n \"cc\": {\n \"fee\": 0,\n \"total\": 0\n },\n \"ach\": {\n \"fee\": 0,\n \"total\": 0\n }\n },\n \"thank_you_note\": null,\n \"public_url\": \"http:\/\/app.dimepayments.com\/invoice\/cNSdqmHw52vavVVFYchTd609JEIVJWs64HBw9QeK\",\n \"customer\": {\n \"id\": 16032,\n \"name\": \"Scott Porter\",\n \"email\": \"sporter@abidingwordchurch.org\"\n },\n \"items\": [\n {\n \"id\": 1,\n \"item_id\": 1365,\n \"name\": \"Implementation Fee\",\n \"description\": null,\n \"quantity\": 1,\n \"unit_price\": 2000,\n \"amount\": 2000\n }\n ],\n \"payments\": [\n {\n \"amount\": 2000,\n \"cover_fee\": 56.81,\n \"paid_at\": \"2026-09-03T11:21:27-04:00\",\n \"method\": \"+CC\",\n \"transaction_id\": 107272\n }\n ],\n \"events\": [\n {\n \"type\": \"payment_received\",\n \"label\": \"Payment received\",\n \"description\": \"Payment of $2,000.00 received\",\n \"created_at\": \"2026-09-03T11:21:27-04:00\"\n },\n {\n \"type\": \"viewed\",\n \"label\": \"Invoice viewed\",\n \"description\": \"Opened by sporter@abidingwordchurch.org\",\n \"created_at\": \"2026-09-03T11:18:10-04:00\"\n },\n {\n \"type\": \"created\",\n \"label\": \"Invoice created\",\n \"description\": \"Invoice created via API\",\n \"created_at\": \"2026-09-03T11:17:43-04:00\"\n },\n {\n \"type\": \"sent\",\n \"label\": \"Invoice sent\",\n \"description\": \"Marked as sent via API \\u2014 shared manually (no email)\",\n \"created_at\": \"2026-09-03T11:17:43-04:00\"\n }\n ]\n }\n}", "name": "" }, { "header": [], "code": 400, "body": "{\"errors\": {\"data.customer_email\": [\"The data.customer email field is required.\"]}}", "name": "Failed validation" }, { "header": [], "code": 401, "body": "{\"data\": {\"message\": \"Permission Denied.\"}}", "name": "Token unauthorized" }, { "header": [], "code": 404, "body": "{\"data\": {\"message\": \"No such Merchant\"}}", "name": "Invalid sid" }, { "header": [], "code": 404, "body": "{\"data\": {\"message\": \"Invoice not found\"}}", "name": "Invoice not found" }, { "header": [], "code": 422, "body": "{\"data\": {\"message\": \"Only draft invoices can be edited.\"}}", "name": "Invoice locked" } ] }, { "name": "Delete Invoice", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/invoice\/delete", "query": [], "raw": "{{baseUrl}}\/api\/invoice\/delete" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "[]" }, "description": "Soft-deletes a draft invoice. Only draft invoices can be deleted." }, "response": [ { "header": [], "code": 200, "body": "{\"data\": {\"message\": \"Draft invoice deleted.\"}}", "name": "Deleted" }, { "header": [], "code": 401, "body": "{\"data\": {\"message\": \"Permission Denied.\"}}", "name": "Token unauthorized" }, { "header": [], "code": 404, "body": "{\"data\": {\"message\": \"No such Merchant\"}}", "name": "Invalid sid" }, { "header": [], "code": 404, "body": "{\"data\": {\"message\": \"Invoice not found\"}}", "name": "Invoice not found" }, { "header": [], "code": 422, "body": "{\"data\": {\"message\": \"Only draft invoices can be deleted.\"}}", "name": "Invoice locked" } ] }, { "name": "Send Invoice", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/invoice\/send", "query": [], "raw": "{{baseUrl}}\/api\/invoice\/send" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "[]" }, "description": "Emails the invoice to the customer with a link to the public pay page and\nadvances the invoice to Sent. A paid, void, or refunded invoice cannot be\nsent." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": {\n \"id\": 1,\n \"token\": \"cNSdqmHw52vavVVFYchTd609JEIVJWs64HBw9QeK\",\n \"invoice_number\": \"INV-0001\",\n \"status\": \"paid\",\n \"payment_terms\": \"net_15\",\n \"issue_date\": \"2026-09-03\",\n \"due_date\": \"2026-09-18\",\n \"is_overdue\": false,\n \"subtotal\": 2000,\n \"total\": 2000,\n \"amount_paid\": 2000,\n \"balance\": 0,\n \"allow_partial_payment\": false,\n \"cover_fee_required\": true,\n \"cover_fee_quote\": {\n \"basis\": \"balance\",\n \"base\": 0,\n \"cc\": {\n \"fee\": 0,\n \"total\": 0\n },\n \"ach\": {\n \"fee\": 0,\n \"total\": 0\n }\n },\n \"thank_you_note\": null,\n \"public_url\": \"http:\/\/app.dimepayments.com\/invoice\/cNSdqmHw52vavVVFYchTd609JEIVJWs64HBw9QeK\",\n \"customer\": {\n \"id\": 16032,\n \"name\": \"Scott Porter\",\n \"email\": \"sporter@abidingwordchurch.org\"\n },\n \"items\": [\n {\n \"id\": 1,\n \"item_id\": 1365,\n \"name\": \"Implementation Fee\",\n \"description\": null,\n \"quantity\": 1,\n \"unit_price\": 2000,\n \"amount\": 2000\n }\n ],\n \"payments\": [\n {\n \"amount\": 2000,\n \"cover_fee\": 56.81,\n \"paid_at\": \"2026-09-03T11:21:27-04:00\",\n \"method\": \"+CC\",\n \"transaction_id\": 107272\n }\n ],\n \"events\": [\n {\n \"type\": \"payment_received\",\n \"label\": \"Payment received\",\n \"description\": \"Payment of $2,000.00 received\",\n \"created_at\": \"2026-09-03T11:21:27-04:00\"\n },\n {\n \"type\": \"viewed\",\n \"label\": \"Invoice viewed\",\n \"description\": \"Opened by sporter@abidingwordchurch.org\",\n \"created_at\": \"2026-09-03T11:18:10-04:00\"\n },\n {\n \"type\": \"created\",\n \"label\": \"Invoice created\",\n \"description\": \"Invoice created via API\",\n \"created_at\": \"2026-09-03T11:17:43-04:00\"\n },\n {\n \"type\": \"sent\",\n \"label\": \"Invoice sent\",\n \"description\": \"Marked as sent via API \\u2014 shared manually (no email)\",\n \"created_at\": \"2026-09-03T11:17:43-04:00\"\n }\n ]\n }\n}", "name": "" }, { "header": [], "code": 401, "body": "{\"data\": {\"message\": \"Permission Denied.\"}}", "name": "Token unauthorized" }, { "header": [], "code": 404, "body": "{\"data\": {\"message\": \"No such Merchant\"}}", "name": "Invalid sid" }, { "header": [], "code": 404, "body": "{\"data\": {\"message\": \"Invoice not found\"}}", "name": "Invoice not found" }, { "header": [], "code": 422, "body": "{\"data\": {\"message\": \"Invoice has no customer email to send to.\"}}", "name": "No email" }, { "header": [], "code": 422, "body": "{\"data\": {\"message\": \"A paid, void, or refunded invoice cannot be sent.\"}}", "name": "Terminal" } ] }, { "name": "Mark Invoice Sent", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/invoice\/mark-sent", "query": [], "raw": "{{baseUrl}}\/api\/invoice\/mark-sent" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "[]" }, "description": "Activates a draft invoice for payment WITHOUT emailing it \u2014 for Merchants\nwho share the public link themselves. Advances Draft to Sent so the pay\nlink becomes live." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": {\n \"id\": 1,\n \"token\": \"cNSdqmHw52vavVVFYchTd609JEIVJWs64HBw9QeK\",\n \"invoice_number\": \"INV-0001\",\n \"status\": \"paid\",\n \"payment_terms\": \"net_15\",\n \"issue_date\": \"2026-09-03\",\n \"due_date\": \"2026-09-18\",\n \"is_overdue\": false,\n \"subtotal\": 2000,\n \"total\": 2000,\n \"amount_paid\": 2000,\n \"balance\": 0,\n \"allow_partial_payment\": false,\n \"cover_fee_required\": true,\n \"cover_fee_quote\": {\n \"basis\": \"balance\",\n \"base\": 0,\n \"cc\": {\n \"fee\": 0,\n \"total\": 0\n },\n \"ach\": {\n \"fee\": 0,\n \"total\": 0\n }\n },\n \"thank_you_note\": null,\n \"public_url\": \"http:\/\/app.dimepayments.com\/invoice\/cNSdqmHw52vavVVFYchTd609JEIVJWs64HBw9QeK\",\n \"customer\": {\n \"id\": 16032,\n \"name\": \"Scott Porter\",\n \"email\": \"sporter@abidingwordchurch.org\"\n },\n \"items\": [\n {\n \"id\": 1,\n \"item_id\": 1365,\n \"name\": \"Implementation Fee\",\n \"description\": null,\n \"quantity\": 1,\n \"unit_price\": 2000,\n \"amount\": 2000\n }\n ],\n \"payments\": [\n {\n \"amount\": 2000,\n \"cover_fee\": 56.81,\n \"paid_at\": \"2026-09-03T11:21:27-04:00\",\n \"method\": \"+CC\",\n \"transaction_id\": 107272\n }\n ],\n \"events\": [\n {\n \"type\": \"payment_received\",\n \"label\": \"Payment received\",\n \"description\": \"Payment of $2,000.00 received\",\n \"created_at\": \"2026-09-03T11:21:27-04:00\"\n },\n {\n \"type\": \"viewed\",\n \"label\": \"Invoice viewed\",\n \"description\": \"Opened by sporter@abidingwordchurch.org\",\n \"created_at\": \"2026-09-03T11:18:10-04:00\"\n },\n {\n \"type\": \"created\",\n \"label\": \"Invoice created\",\n \"description\": \"Invoice created via API\",\n \"created_at\": \"2026-09-03T11:17:43-04:00\"\n },\n {\n \"type\": \"sent\",\n \"label\": \"Invoice sent\",\n \"description\": \"Marked as sent via API \\u2014 shared manually (no email)\",\n \"created_at\": \"2026-09-03T11:17:43-04:00\"\n }\n ]\n }\n}", "name": "" }, { "header": [], "code": 401, "body": "{\"data\": {\"message\": \"Permission Denied.\"}}", "name": "Token unauthorized" }, { "header": [], "code": 404, "body": "{\"data\": {\"message\": \"No such Merchant\"}}", "name": "Invalid sid" }, { "header": [], "code": 404, "body": "{\"data\": {\"message\": \"Invoice not found\"}}", "name": "Invoice not found" }, { "header": [], "code": 422, "body": "{\"data\": {\"message\": \"This invoice has already been sent.\"}}", "name": "Already sent" } ] }, { "name": "Void Invoice", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/invoice\/void", "query": [], "raw": "{{baseUrl}}\/api\/invoice\/void" }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "[]" }, "description": "Voids an invoice. Voiding is terminal \u2014 the invoice can no longer be paid.\nAn already void or refunded invoice cannot be voided again." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": {\n \"id\": 1,\n \"token\": \"cNSdqmHw52vavVVFYchTd609JEIVJWs64HBw9QeK\",\n \"invoice_number\": \"INV-0001\",\n \"status\": \"paid\",\n \"payment_terms\": \"net_15\",\n \"issue_date\": \"2026-09-03\",\n \"due_date\": \"2026-09-18\",\n \"is_overdue\": false,\n \"subtotal\": 2000,\n \"total\": 2000,\n \"amount_paid\": 2000,\n \"balance\": 0,\n \"allow_partial_payment\": false,\n \"cover_fee_required\": true,\n \"cover_fee_quote\": {\n \"basis\": \"balance\",\n \"base\": 0,\n \"cc\": {\n \"fee\": 0,\n \"total\": 0\n },\n \"ach\": {\n \"fee\": 0,\n \"total\": 0\n }\n },\n \"thank_you_note\": null,\n \"public_url\": \"http:\/\/app.dimepayments.com\/invoice\/cNSdqmHw52vavVVFYchTd609JEIVJWs64HBw9QeK\",\n \"customer\": {\n \"id\": 16032,\n \"name\": \"Scott Porter\",\n \"email\": \"sporter@abidingwordchurch.org\"\n },\n \"items\": [\n {\n \"id\": 1,\n \"item_id\": 1365,\n \"name\": \"Implementation Fee\",\n \"description\": null,\n \"quantity\": 1,\n \"unit_price\": 2000,\n \"amount\": 2000\n }\n ],\n \"payments\": [\n {\n \"amount\": 2000,\n \"cover_fee\": 56.81,\n \"paid_at\": \"2026-09-03T11:21:27-04:00\",\n \"method\": \"+CC\",\n \"transaction_id\": 107272\n }\n ],\n \"events\": [\n {\n \"type\": \"payment_received\",\n \"label\": \"Payment received\",\n \"description\": \"Payment of $2,000.00 received\",\n \"created_at\": \"2026-09-03T11:21:27-04:00\"\n },\n {\n \"type\": \"viewed\",\n \"label\": \"Invoice viewed\",\n \"description\": \"Opened by sporter@abidingwordchurch.org\",\n \"created_at\": \"2026-09-03T11:18:10-04:00\"\n },\n {\n \"type\": \"created\",\n \"label\": \"Invoice created\",\n \"description\": \"Invoice created via API\",\n \"created_at\": \"2026-09-03T11:17:43-04:00\"\n },\n {\n \"type\": \"sent\",\n \"label\": \"Invoice sent\",\n \"description\": \"Marked as sent via API \\u2014 shared manually (no email)\",\n \"created_at\": \"2026-09-03T11:17:43-04:00\"\n }\n ]\n }\n}", "name": "" }, { "header": [], "code": 401, "body": "{\"data\": {\"message\": \"Permission Denied.\"}}", "name": "Token unauthorized" }, { "header": [], "code": 404, "body": "{\"data\": {\"message\": \"No such Merchant\"}}", "name": "Invalid sid" }, { "header": [], "code": 404, "body": "{\"data\": {\"message\": \"Invoice not found\"}}", "name": "Invoice not found" }, { "header": [], "code": 422, "body": "{\"data\": {\"message\": \"This invoice is already void or refunded.\"}}", "name": "Terminal" } ] }, { "name": "Duplicate Invoice", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/invoice\/duplicate", "query": [], "raw": "{{baseUrl}}\/api\/invoice\/duplicate" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "[]" }, "description": "Clones any invoice into a new draft (copying its line items) with a freshly\nallocated invoice number." }, "response": [ { "header": [], "code": 201, "body": "{\n \"data\": {\n \"id\": 1,\n \"token\": \"cNSdqmHw52vavVVFYchTd609JEIVJWs64HBw9QeK\",\n \"invoice_number\": \"INV-0001\",\n \"status\": \"paid\",\n \"payment_terms\": \"net_15\",\n \"issue_date\": \"2026-09-03\",\n \"due_date\": \"2026-09-18\",\n \"is_overdue\": false,\n \"subtotal\": 2000,\n \"total\": 2000,\n \"amount_paid\": 2000,\n \"balance\": 0,\n \"allow_partial_payment\": false,\n \"cover_fee_required\": true,\n \"cover_fee_quote\": {\n \"basis\": \"balance\",\n \"base\": 0,\n \"cc\": {\n \"fee\": 0,\n \"total\": 0\n },\n \"ach\": {\n \"fee\": 0,\n \"total\": 0\n }\n },\n \"thank_you_note\": null,\n \"public_url\": \"http:\/\/app.dimepayments.com\/invoice\/cNSdqmHw52vavVVFYchTd609JEIVJWs64HBw9QeK\",\n \"customer\": {\n \"id\": 16032,\n \"name\": \"Scott Porter\",\n \"email\": \"sporter@abidingwordchurch.org\"\n },\n \"items\": [\n {\n \"id\": 1,\n \"item_id\": 1365,\n \"name\": \"Implementation Fee\",\n \"description\": null,\n \"quantity\": 1,\n \"unit_price\": 2000,\n \"amount\": 2000\n }\n ],\n \"payments\": [\n {\n \"amount\": 2000,\n \"cover_fee\": 56.81,\n \"paid_at\": \"2026-09-03T11:21:27-04:00\",\n \"method\": \"+CC\",\n \"transaction_id\": 107272\n }\n ],\n \"events\": [\n {\n \"type\": \"payment_received\",\n \"label\": \"Payment received\",\n \"description\": \"Payment of $2,000.00 received\",\n \"created_at\": \"2026-09-03T11:21:27-04:00\"\n },\n {\n \"type\": \"viewed\",\n \"label\": \"Invoice viewed\",\n \"description\": \"Opened by sporter@abidingwordchurch.org\",\n \"created_at\": \"2026-09-03T11:18:10-04:00\"\n },\n {\n \"type\": \"created\",\n \"label\": \"Invoice created\",\n \"description\": \"Invoice created via API\",\n \"created_at\": \"2026-09-03T11:17:43-04:00\"\n },\n {\n \"type\": \"sent\",\n \"label\": \"Invoice sent\",\n \"description\": \"Marked as sent via API \\u2014 shared manually (no email)\",\n \"created_at\": \"2026-09-03T11:17:43-04:00\"\n }\n ]\n }\n}", "name": "" }, { "header": [], "code": 401, "body": "{\"data\": {\"message\": \"Permission Denied.\"}}", "name": "Token unauthorized" }, { "header": [], "code": 404, "body": "{\"data\": {\"message\": \"No such Merchant\"}}", "name": "Invalid sid" }, { "header": [], "code": 404, "body": "{\"data\": {\"message\": \"Invoice not found\"}}", "name": "Invoice not found" } ] }, { "name": "Pay Invoice", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/invoice\/pay", "query": [], "raw": "{{baseUrl}}\/api\/invoice\/pay" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "[]" }, "description": "Records a merchant-initiated (MOTO) payment against an open invoice, charging\na credit card (raw card or a stored token) or a bank account (ACH) through\nthe processor. Mirrors the card\/ACH charge endpoints but targets the invoice: the\namount is the invoice balance (or a partial amount when the invoice allows\nit), and on approval the invoice status\/payment history\/per-line\nclassification are updated exactly as a customer payment.\n\nWhen the invoice has `cover_fee_required`, the processing fee for the method\nbeing charged is added on top of `data.amount` \u2014 so the card or bank account\nis charged more than the amount credited to the invoice. The invoice is\ncredited `data.amount`; the fee appears as `cover_fee` on the resulting entry\nin the response's `payments` array. Card and ACH rates differ, so the same\n`data.amount` produces a different charge per `data.payment_type`. Read\n`cover_fee_quote` from the invoice beforehand to know the totals in advance.\n\nThe invoice must be open (Sent\/Viewed\/Partially Paid) with a balance due on\nan active card-processing merchant. A declined card is NOT recorded as a payment." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": {\n \"id\": 1,\n \"token\": \"cNSdqmHw52vavVVFYchTd609JEIVJWs64HBw9QeK\",\n \"invoice_number\": \"INV-0001\",\n \"status\": \"paid\",\n \"payment_terms\": \"net_15\",\n \"issue_date\": \"2026-09-03\",\n \"due_date\": \"2026-09-18\",\n \"is_overdue\": false,\n \"subtotal\": 2000,\n \"total\": 2000,\n \"amount_paid\": 2000,\n \"balance\": 0,\n \"allow_partial_payment\": false,\n \"cover_fee_required\": true,\n \"cover_fee_quote\": {\n \"basis\": \"balance\",\n \"base\": 0,\n \"cc\": {\n \"fee\": 0,\n \"total\": 0\n },\n \"ach\": {\n \"fee\": 0,\n \"total\": 0\n }\n },\n \"thank_you_note\": null,\n \"public_url\": \"http:\/\/app.dimepayments.com\/invoice\/cNSdqmHw52vavVVFYchTd609JEIVJWs64HBw9QeK\",\n \"customer\": {\n \"id\": 16032,\n \"name\": \"Scott Porter\",\n \"email\": \"sporter@abidingwordchurch.org\"\n },\n \"items\": [\n {\n \"id\": 1,\n \"item_id\": 1365,\n \"name\": \"Implementation Fee\",\n \"description\": null,\n \"quantity\": 1,\n \"unit_price\": 2000,\n \"amount\": 2000\n }\n ],\n \"payments\": [\n {\n \"amount\": 2000,\n \"cover_fee\": 56.81,\n \"paid_at\": \"2026-09-03T11:21:27-04:00\",\n \"method\": \"+CC\",\n \"transaction_id\": 107272\n }\n ],\n \"events\": [\n {\n \"type\": \"payment_received\",\n \"label\": \"Payment received\",\n \"description\": \"Payment of $2,000.00 received\",\n \"created_at\": \"2026-09-03T11:21:27-04:00\"\n },\n {\n \"type\": \"viewed\",\n \"label\": \"Invoice viewed\",\n \"description\": \"Opened by sporter@abidingwordchurch.org\",\n \"created_at\": \"2026-09-03T11:18:10-04:00\"\n },\n {\n \"type\": \"created\",\n \"label\": \"Invoice created\",\n \"description\": \"Invoice created via API\",\n \"created_at\": \"2026-09-03T11:17:43-04:00\"\n },\n {\n \"type\": \"sent\",\n \"label\": \"Invoice sent\",\n \"description\": \"Marked as sent via API \\u2014 shared manually (no email)\",\n \"created_at\": \"2026-09-03T11:17:43-04:00\"\n }\n ]\n }\n}", "name": "" }, { "header": [], "code": 400, "body": "{\"errors\": {\"data.card_number\": [\"The data.card number field is required when data.token is not present.\"]}}", "name": "Failed validation" }, { "header": [], "code": 401, "body": "{\"data\": {\"message\": \"Permission Denied.\"}}", "name": "Token unauthorized" }, { "header": [], "code": 404, "body": "{\"data\": {\"message\": \"No such Merchant\"}}", "name": "Invalid sid" }, { "header": [], "code": 404, "body": "{\"data\": {\"message\": \"Invoice not found\"}}", "name": "Invoice not found" }, { "header": [], "code": 422, "body": "{\"data\": {\"message\": \"This invoice cannot be paid (it must be an open invoice with a balance due on an active card-processing merchant).\"}}", "name": "Not payable" }, { "header": [], "code": 422, "body": "{\"data\": {\"message\": \"This payment method is not accepted by the merchant.\"}}", "name": "Method not accepted" }, { "header": [], "code": 422, "body": "{\"data\": {\"message\": \"A payment for this invoice is already being processed. Please try again in a moment.\"}}", "name": "Already processing" }, { "header": [], "code": 422, "body": "{\"data\": {\"message\": \"The payment amount exceeds the $50.00 balance now due.\"}}", "name": "Amount exceeds balance" }, { "header": [], "code": 422, "body": "{\"data\": {\"message\": \"The card was declined.\", \"code\": \"51\"}}", "name": "Declined" }, { "header": [], "code": 500, "body": "{\"data\": {\"message\": \"The payment was captured but could not be recorded. Do not retry \u2014 please contact support to reconcile this invoice.\"}}", "name": "Captured but not recorded" } ] }, { "name": "Get Invoice Link", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/invoice\/link", "query": [], "raw": "{{baseUrl}}\/api\/invoice\/link" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "[]" }, "description": "Returns the public pay link (and token) for an invoice." }, "response": [ { "header": [], "code": 200, "body": "{\"data\": {\"public_url\": \"https:\/\/example.test\/invoice\/abcd\", \"token\": \"abcd\"}}", "name": "Success" }, { "header": [], "code": 401, "body": "{\"data\": {\"message\": \"Permission Denied.\"}}", "name": "Token unauthorized" }, { "header": [], "code": 404, "body": "{\"data\": {\"message\": \"No such Merchant\"}}", "name": "Invalid sid" }, { "header": [], "code": 404, "body": "{\"data\": {\"message\": \"Invoice not found\"}}", "name": "Invoice not found" } ] }, { "name": "Add Line Item", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/invoice\/line-item\/add", "query": [], "raw": "{{baseUrl}}\/api\/invoice\/line-item\/add" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "[]" }, "description": "Appends a single line item to a draft invoice and recalculates totals." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": {\n \"id\": 1,\n \"token\": \"cNSdqmHw52vavVVFYchTd609JEIVJWs64HBw9QeK\",\n \"invoice_number\": \"INV-0001\",\n \"status\": \"paid\",\n \"payment_terms\": \"net_15\",\n \"issue_date\": \"2026-09-03\",\n \"due_date\": \"2026-09-18\",\n \"is_overdue\": false,\n \"subtotal\": 2000,\n \"total\": 2000,\n \"amount_paid\": 2000,\n \"balance\": 0,\n \"allow_partial_payment\": false,\n \"cover_fee_required\": true,\n \"cover_fee_quote\": {\n \"basis\": \"balance\",\n \"base\": 0,\n \"cc\": {\n \"fee\": 0,\n \"total\": 0\n },\n \"ach\": {\n \"fee\": 0,\n \"total\": 0\n }\n },\n \"thank_you_note\": null,\n \"public_url\": \"http:\/\/app.dimepayments.com\/invoice\/cNSdqmHw52vavVVFYchTd609JEIVJWs64HBw9QeK\",\n \"customer\": {\n \"id\": 16032,\n \"name\": \"Scott Porter\",\n \"email\": \"sporter@abidingwordchurch.org\"\n },\n \"items\": [\n {\n \"id\": 1,\n \"item_id\": 1365,\n \"name\": \"Implementation Fee\",\n \"description\": null,\n \"quantity\": 1,\n \"unit_price\": 2000,\n \"amount\": 2000\n }\n ],\n \"payments\": [\n {\n \"amount\": 2000,\n \"cover_fee\": 56.81,\n \"paid_at\": \"2026-09-03T11:21:27-04:00\",\n \"method\": \"+CC\",\n \"transaction_id\": 107272\n }\n ],\n \"events\": [\n {\n \"type\": \"payment_received\",\n \"label\": \"Payment received\",\n \"description\": \"Payment of $2,000.00 received\",\n \"created_at\": \"2026-09-03T11:21:27-04:00\"\n },\n {\n \"type\": \"viewed\",\n \"label\": \"Invoice viewed\",\n \"description\": \"Opened by sporter@abidingwordchurch.org\",\n \"created_at\": \"2026-09-03T11:18:10-04:00\"\n },\n {\n \"type\": \"created\",\n \"label\": \"Invoice created\",\n \"description\": \"Invoice created via API\",\n \"created_at\": \"2026-09-03T11:17:43-04:00\"\n },\n {\n \"type\": \"sent\",\n \"label\": \"Invoice sent\",\n \"description\": \"Marked as sent via API \\u2014 shared manually (no email)\",\n \"created_at\": \"2026-09-03T11:17:43-04:00\"\n }\n ]\n }\n}", "name": "" }, { "header": [], "code": 400, "body": "{\"errors\": {\"data.item_id\": [\"The selected data.item id is invalid.\"]}}", "name": "Failed validation" }, { "header": [], "code": 401, "body": "{\"data\": {\"message\": \"Permission Denied.\"}}", "name": "Token unauthorized" }, { "header": [], "code": 404, "body": "{\"data\": {\"message\": \"No such Merchant\"}}", "name": "Invalid sid" }, { "header": [], "code": 404, "body": "{\"data\": {\"message\": \"Invoice not found\"}}", "name": "Invoice not found" }, { "header": [], "code": 422, "body": "{\"data\": {\"message\": \"Only draft invoices can be edited.\"}}", "name": "Invoice locked" } ] }, { "name": "Update Line Item", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/invoice\/line-item\/update", "query": [], "raw": "{{baseUrl}}\/api\/invoice\/line-item\/update" }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "[]" }, "description": "Updates a single line item on a draft invoice. Only the fields you pass are\nchanged; the line amount is recomputed and invoice totals refreshed." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": {\n \"id\": 1,\n \"token\": \"cNSdqmHw52vavVVFYchTd609JEIVJWs64HBw9QeK\",\n \"invoice_number\": \"INV-0001\",\n \"status\": \"paid\",\n \"payment_terms\": \"net_15\",\n \"issue_date\": \"2026-09-03\",\n \"due_date\": \"2026-09-18\",\n \"is_overdue\": false,\n \"subtotal\": 2000,\n \"total\": 2000,\n \"amount_paid\": 2000,\n \"balance\": 0,\n \"allow_partial_payment\": false,\n \"cover_fee_required\": true,\n \"cover_fee_quote\": {\n \"basis\": \"balance\",\n \"base\": 0,\n \"cc\": {\n \"fee\": 0,\n \"total\": 0\n },\n \"ach\": {\n \"fee\": 0,\n \"total\": 0\n }\n },\n \"thank_you_note\": null,\n \"public_url\": \"http:\/\/app.dimepayments.com\/invoice\/cNSdqmHw52vavVVFYchTd609JEIVJWs64HBw9QeK\",\n \"customer\": {\n \"id\": 16032,\n \"name\": \"Scott Porter\",\n \"email\": \"sporter@abidingwordchurch.org\"\n },\n \"items\": [\n {\n \"id\": 1,\n \"item_id\": 1365,\n \"name\": \"Implementation Fee\",\n \"description\": null,\n \"quantity\": 1,\n \"unit_price\": 2000,\n \"amount\": 2000\n }\n ],\n \"payments\": [\n {\n \"amount\": 2000,\n \"cover_fee\": 56.81,\n \"paid_at\": \"2026-09-03T11:21:27-04:00\",\n \"method\": \"+CC\",\n \"transaction_id\": 107272\n }\n ],\n \"events\": [\n {\n \"type\": \"payment_received\",\n \"label\": \"Payment received\",\n \"description\": \"Payment of $2,000.00 received\",\n \"created_at\": \"2026-09-03T11:21:27-04:00\"\n },\n {\n \"type\": \"viewed\",\n \"label\": \"Invoice viewed\",\n \"description\": \"Opened by sporter@abidingwordchurch.org\",\n \"created_at\": \"2026-09-03T11:18:10-04:00\"\n },\n {\n \"type\": \"created\",\n \"label\": \"Invoice created\",\n \"description\": \"Invoice created via API\",\n \"created_at\": \"2026-09-03T11:17:43-04:00\"\n },\n {\n \"type\": \"sent\",\n \"label\": \"Invoice sent\",\n \"description\": \"Marked as sent via API \\u2014 shared manually (no email)\",\n \"created_at\": \"2026-09-03T11:17:43-04:00\"\n }\n ]\n }\n}", "name": "" }, { "header": [], "code": 400, "body": "{\"errors\": {\"data.quantity\": [\"The data.quantity field must be at least 0.\"]}}", "name": "Failed validation" }, { "header": [], "code": 401, "body": "{\"data\": {\"message\": \"Permission Denied.\"}}", "name": "Token unauthorized" }, { "header": [], "code": 404, "body": "{\"data\": {\"message\": \"No such Merchant\"}}", "name": "Invalid sid" }, { "header": [], "code": 404, "body": "{\"data\": {\"message\": \"Invoice not found\"}}", "name": "Invoice not found" }, { "header": [], "code": 404, "body": "{\"data\": {\"message\": \"Line item not found\"}}", "name": "Line item not found" }, { "header": [], "code": 422, "body": "{\"data\": {\"message\": \"Only draft invoices can be edited.\"}}", "name": "Invoice locked" } ] }, { "name": "Delete Line Item", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/invoice\/line-item\/delete", "query": [], "raw": "{{baseUrl}}\/api\/invoice\/line-item\/delete" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "[]" }, "description": "Removes a single line item from a draft invoice and recalculates totals." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": {\n \"id\": 1,\n \"token\": \"cNSdqmHw52vavVVFYchTd609JEIVJWs64HBw9QeK\",\n \"invoice_number\": \"INV-0001\",\n \"status\": \"paid\",\n \"payment_terms\": \"net_15\",\n \"issue_date\": \"2026-09-03\",\n \"due_date\": \"2026-09-18\",\n \"is_overdue\": false,\n \"subtotal\": 2000,\n \"total\": 2000,\n \"amount_paid\": 2000,\n \"balance\": 0,\n \"allow_partial_payment\": false,\n \"cover_fee_required\": true,\n \"cover_fee_quote\": {\n \"basis\": \"balance\",\n \"base\": 0,\n \"cc\": {\n \"fee\": 0,\n \"total\": 0\n },\n \"ach\": {\n \"fee\": 0,\n \"total\": 0\n }\n },\n \"thank_you_note\": null,\n \"public_url\": \"http:\/\/app.dimepayments.com\/invoice\/cNSdqmHw52vavVVFYchTd609JEIVJWs64HBw9QeK\",\n \"customer\": {\n \"id\": 16032,\n \"name\": \"Scott Porter\",\n \"email\": \"sporter@abidingwordchurch.org\"\n },\n \"items\": [\n {\n \"id\": 1,\n \"item_id\": 1365,\n \"name\": \"Implementation Fee\",\n \"description\": null,\n \"quantity\": 1,\n \"unit_price\": 2000,\n \"amount\": 2000\n }\n ],\n \"payments\": [\n {\n \"amount\": 2000,\n \"cover_fee\": 56.81,\n \"paid_at\": \"2026-09-03T11:21:27-04:00\",\n \"method\": \"+CC\",\n \"transaction_id\": 107272\n }\n ],\n \"events\": [\n {\n \"type\": \"payment_received\",\n \"label\": \"Payment received\",\n \"description\": \"Payment of $2,000.00 received\",\n \"created_at\": \"2026-09-03T11:21:27-04:00\"\n },\n {\n \"type\": \"viewed\",\n \"label\": \"Invoice viewed\",\n \"description\": \"Opened by sporter@abidingwordchurch.org\",\n \"created_at\": \"2026-09-03T11:18:10-04:00\"\n },\n {\n \"type\": \"created\",\n \"label\": \"Invoice created\",\n \"description\": \"Invoice created via API\",\n \"created_at\": \"2026-09-03T11:17:43-04:00\"\n },\n {\n \"type\": \"sent\",\n \"label\": \"Invoice sent\",\n \"description\": \"Marked as sent via API \\u2014 shared manually (no email)\",\n \"created_at\": \"2026-09-03T11:17:43-04:00\"\n }\n ]\n }\n}", "name": "" }, { "header": [], "code": 401, "body": "{\"data\": {\"message\": \"Permission Denied.\"}}", "name": "Token unauthorized" }, { "header": [], "code": 404, "body": "{\"data\": {\"message\": \"No such Merchant\"}}", "name": "Invalid sid" }, { "header": [], "code": 404, "body": "{\"data\": {\"message\": \"Invoice not found\"}}", "name": "Invoice not found" }, { "header": [], "code": 404, "body": "{\"data\": {\"message\": \"Line item not found\"}}", "name": "Line item not found" }, { "header": [], "code": 422, "body": "{\"data\": {\"message\": \"Only draft invoices can be edited.\"}}", "name": "Invoice locked" } ] }, { "name": "List Invoice Items", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/invoice\/items", "query": [], "raw": "{{baseUrl}}\/api\/invoice\/items" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"data\":{\"sid\":12345}}" }, "description": "Lists the Merchant's items (funds\/designations) available to use as invoice\nline items, ordered alphabetically." }, "response": [ { "header": [], "code": 200, "body": "{\"data\": [{\"id\": 5, \"name\": \"Consulting\", \"description\": null, \"price\": 125.00}]}", "name": "Success" }, { "header": [], "code": 401, "body": "{\"data\": {\"message\": \"Permission Denied.\"}}", "name": "Token unauthorized" }, { "header": [], "code": 404, "body": "{\"data\": {\"message\": \"No such Merchant\"}}", "name": "Invalid sid" } ] }, { "name": "Create Invoice Item", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/invoice\/item\/create", "query": [], "raw": "{{baseUrl}}\/api\/invoice\/item\/create" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"data\":{\"sid\":12345,\"name\":\"Consulting\",\"description\":\"Professional services\",\"price\":125,\"tax_deductible\":false}}" }, "description": "Creates an invoicing-only item (fund\/designation) for the Merchant. The\nitem is hidden from public giving pages and can be referenced as a line\nitem's `item_id`." }, "response": [ { "header": [], "code": 201, "body": "{\"data\": {\"id\": 5, \"name\": \"Consulting\", \"description\": null, \"price\": 125.00, \"tax_deductible\": false}}", "name": "Created" }, { "header": [], "code": 400, "body": "{\"errors\": {\"data.name\": [\"The data.name field is required.\"]}}", "name": "Failed validation" }, { "header": [], "code": 401, "body": "{\"data\": {\"message\": \"Permission Denied.\"}}", "name": "Token unauthorized" }, { "header": [], "code": 404, "body": "{\"data\": {\"message\": \"No such Merchant\"}}", "name": "Invalid sid" } ] }, { "name": "List Recurring Invoices", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/recurring-invoices", "query": [], "raw": "{{baseUrl}}\/api\/recurring-invoices" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"data\":{\"sid\":12345},\"filters\":{\"status\":\"Active\"}}" }, "description": "Retrieves a paginated (cursor) list of recurring-invoice templates for a\nMerchant, optionally filtered by status." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":null,\"status\":\"Active\",\"recurrence_schedule\":\"Monthly\",\"payment_terms\":\"net_15\",\"cover_fee_required\":false,\"start_date\":\"2026-09-22\",\"end_date\":null,\"next_run_date\":\"2026-10-22\",\"last_run_date\":null,\"customer_name\":\"Lafayette Considine\"},{\"id\":null,\"status\":\"Active\",\"recurrence_schedule\":\"Monthly\",\"payment_terms\":\"net_15\",\"cover_fee_required\":false,\"start_date\":\"2026-09-22\",\"end_date\":null,\"next_run_date\":\"2026-10-22\",\"last_run_date\":null,\"customer_name\":\"Margaretta Thiel\"}],\"links\":{\"prev\":null,\"next\":null},\"meta\":{\"path\":\"\\\/\",\"per_page\":500,\"next_cursor\":null,\"prev_cursor\":null}}", "name": "" }, { "header": [], "code": 401, "body": "{\"data\": {\"message\": \"Permission Denied.\"}}", "name": "Token unauthorized" }, { "header": [], "code": 404, "body": "{\"data\": {\"message\": \"No such Merchant\"}}", "name": "Invalid sid" } ] }, { "name": "Show Recurring Invoice", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/recurring-invoice", "query": [], "raw": "{{baseUrl}}\/api\/recurring-invoice" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "[]" }, "description": "Retrieves a single recurring-invoice template with its line items, the\ninvoices it has generated (the 50 most recent), and the upcoming run dates." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": {\n \"id\": null,\n \"status\": \"Active\",\n \"recurrence_schedule\": \"Monthly\",\n \"payment_terms\": \"net_15\",\n \"cover_fee_required\": false,\n \"start_date\": \"2026-09-22\",\n \"end_date\": null,\n \"next_run_date\": \"2026-10-22\",\n \"last_run_date\": null,\n \"thank_you_note\": null,\n \"customer\": {\n \"id\": 16371,\n \"name\": \"Marcelo Predovic\",\n \"email\": \"pauline09@example.com\"\n },\n \"items\": [],\n \"upcoming_run_dates\": [\n \"2026-10-22\",\n \"2026-11-22\",\n \"2026-12-22\"\n ],\n \"invoices\": []\n }\n}", "name": "" }, { "header": [], "code": 401, "body": "{\"data\": {\"message\": \"Permission Denied.\"}}", "name": "Token unauthorized" }, { "header": [], "code": 404, "body": "{\"data\": {\"message\": \"No such Merchant\"}}", "name": "Invalid sid" }, { "header": [], "code": 404, "body": "{\"data\": {\"message\": \"Recurring invoice not found\"}}", "name": "Not found" } ] }, { "name": "Create Recurring Invoice", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/recurring-invoice\/create", "query": [], "raw": "{{baseUrl}}\/api\/recurring-invoice\/create" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"data\":{\"lines\":[{\"item_id\":5,\"name\":\"Monthly retainer\",\"description\":\"Support plan\",\"quantity\":1,\"unit_price\":500}]}}" }, "description": "Creates a recurring-invoice template. The template carries its own snapshot\nof the line items and requires a linked customer (used to resolve the email\non every run). When the start date is today the first invoice is generated\nand sent immediately; a future start date just schedules the first run." }, "response": [ { "header": [], "code": 201, "body": "{\n \"data\": {\n \"id\": null,\n \"status\": \"Active\",\n \"recurrence_schedule\": \"Monthly\",\n \"payment_terms\": \"net_15\",\n \"cover_fee_required\": false,\n \"start_date\": \"2026-09-22\",\n \"end_date\": null,\n \"next_run_date\": \"2026-10-22\",\n \"last_run_date\": null,\n \"thank_you_note\": null,\n \"customer\": {\n \"id\": 16372,\n \"name\": \"Pauline Runte\",\n \"email\": \"alayna44@example.org\"\n },\n \"items\": [],\n \"upcoming_run_dates\": [\n \"2026-10-22\",\n \"2026-11-22\",\n \"2026-12-22\"\n ],\n \"invoices\": []\n }\n}", "name": "" }, { "header": [], "code": 400, "body": "{\"errors\": {\"data.customer_id\": [\"The data.customer id field is required.\"]}}", "name": "Failed validation" }, { "header": [], "code": 401, "body": "{\"data\": {\"message\": \"Permission Denied.\"}}", "name": "Token unauthorized" }, { "header": [], "code": 404, "body": "{\"data\": {\"message\": \"No such Merchant\"}}", "name": "Invalid sid" } ] }, { "name": "Cancel Recurring Invoice", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/recurring-invoice\/cancel", "query": [], "raw": "{{baseUrl}}\/api\/recurring-invoice\/cancel" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "[]" }, "description": "Cancels an active recurring-invoice template. No further invoices are\ngenerated. Only active templates can be cancelled." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": {\n \"id\": null,\n \"status\": \"Active\",\n \"recurrence_schedule\": \"Monthly\",\n \"payment_terms\": \"net_15\",\n \"cover_fee_required\": false,\n \"start_date\": \"2026-09-22\",\n \"end_date\": null,\n \"next_run_date\": \"2026-10-22\",\n \"last_run_date\": null,\n \"thank_you_note\": null,\n \"customer\": {\n \"id\": 16373,\n \"name\": \"Marcelo Predovic\",\n \"email\": \"kconsidine@example.net\"\n },\n \"items\": [],\n \"upcoming_run_dates\": [\n \"2026-10-22\",\n \"2026-11-22\",\n \"2026-12-22\"\n ],\n \"invoices\": []\n }\n}", "name": "" }, { "header": [], "code": 401, "body": "{\"data\": {\"message\": \"Permission Denied.\"}}", "name": "Token unauthorized" }, { "header": [], "code": 404, "body": "{\"data\": {\"message\": \"No such Merchant\"}}", "name": "Invalid sid" }, { "header": [], "code": 404, "body": "{\"data\": {\"message\": \"Recurring invoice not found\"}}", "name": "Not found" }, { "header": [], "code": 422, "body": "{\"data\": {\"message\": \"Only active recurring invoices can be cancelled.\"}}", "name": "Not active" } ] } ] }, { "name": "Payment Method management", "description": "\nAPIs for managing payment methods associated with customers. Depending on API KEY permissions, one should be able to\nlist, show, create, update, and delete payment methods.", "item": [ { "name": "List payment methods for a customer", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/payment-method\/list", "query": [], "raw": "{{baseUrl}}\/api\/payment-method\/list" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"data\":{\"sid\":12345},\"filters\":{\"phone\":\"+15551237890\",\"uuid\":\"3c37db03-dc71-4e8b-90e7-6668290b7c3d\",\"email\":\"an-email@domain.com\"}}" }, "description": "This endpoint shows all payment methods for a customer. Must pass at least one filter to select\n a specific customer" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":2,\"type\":\"cc\",\"token\":\"qYV343433d9BEu75dqES1005\",\"first_name\":\"Ben\",\"last_name\":\"Habeck\",\"cc_name_on_card\":\"Ben Habeck\",\"cc_last_four\":\"1005\",\"cc_expiration_date\":\"05\\\/2029\",\"cc_brand\":\"Amex\",\"status\":\"Default\",\"status_date\":\"2025-05-20 14:04:55\",\"enabled\":true,\"default\":true,\"addr1\":\"53 S. Main Street\",\"addr2\":\"\",\"addr3\":null,\"city\":\"Alpharetta\",\"state\":\"GA\",\"zip\":\"30009\"},{\"id\":2,\"type\":\"cc\",\"token\":\"qYV343433d9BEu75dqES1005\",\"first_name\":\"Ben\",\"last_name\":\"Habeck\",\"cc_name_on_card\":\"Ben Habeck\",\"cc_last_four\":\"1005\",\"cc_expiration_date\":\"05\\\/2029\",\"cc_brand\":\"Amex\",\"status\":\"Default\",\"status_date\":\"2025-05-20 14:04:55\",\"enabled\":true,\"default\":true,\"addr1\":\"53 S. Main Street\",\"addr2\":\"\",\"addr3\":null,\"city\":\"Alpharetta\",\"state\":\"GA\",\"zip\":\"30009\"}],\"links\":{\"prev\":null,\"next\":null},\"meta\":{\"path\":\"\\\/\",\"per_page\":15,\"next_cursor\":null,\"prev_cursor\":null}}", "name": "" }, { "header": [], "code": 401, "body": "{\n\"data\": {\n \"message\": \"Permission denied\"\n }\n}", "name": "Token permission error" }, { "header": [], "code": 404, "body": "{\n\"data\": {\n \"message\": \"Customer not found.\"\n }\n}", "name": "Customer not found" }, { "header": [], "code": 404, "body": "{\n \"data\": {\n \"message\": \"No such Merchant\"\n }\n}", "name": "No such Merchant" } ] }, { "name": "Show a Payment Method for a customer", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/payment-method\/show", "query": [], "raw": "{{baseUrl}}\/api\/payment-method\/show" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"data\":{\"sid\":12345,\"payment_method_id\":12345},\"filters\":{\"phone\":\"+15551237890\",\"uuid\":\"3c37db03-dc71-4e8b-90e7-6668290b7c3d\",\"email\":\"an-email@domain.com\"}}" }, "description": "This endpoint shows a specific payment method for a customer. Must pass at least one filter to select\n a specific customer" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":2,\"type\":\"cc\",\"token\":\"qYV343433d9BEu75dqES1005\",\"first_name\":\"Ben\",\"last_name\":\"Habeck\",\"cc_name_on_card\":\"Ben Habeck\",\"cc_last_four\":\"1005\",\"cc_expiration_date\":\"05\\\/2029\",\"cc_brand\":\"Amex\",\"status\":\"Default\",\"status_date\":\"2025-05-20 14:04:55\",\"enabled\":true,\"default\":true,\"addr1\":\"53 S. Main Street\",\"addr2\":\"\",\"addr3\":null,\"city\":\"Alpharetta\",\"state\":\"GA\",\"zip\":\"30009\"}}", "name": "" }, { "header": [], "code": 401, "body": "{\n \"data\": {\n \"message\": \"Permission denied\"\n }\n}", "name": "Token permission error" }, { "header": [], "code": 404, "body": "{\n \"data\": {\n \"message\": \"Customer not found.\"\n }\n}", "name": "Customer not found" }, { "header": [], "code": 404, "body": "{\n \"data\": {\n \"message\": \"Payment Method not found.\"\n }\n}", "name": "Payment Method not found" }, { "header": [], "code": 404, "body": "{\n\"data\": {\n \"message\": \"No such Merchant\"\n}\n}", "name": "No such Merchant" } ] }, { "name": "Create a Payment Method for a customer", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/payment-method\/create", "query": [], "raw": "{{baseUrl}}\/api\/payment-method\/create" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"data\":{\"uuid\":\"3c37db03-dc71-4e8b-90e7-6668290b7c3d\",\"sid\":12345,\"type\":\"cc\",\"cc_name_on_card\":\"John Doe\",\"cc_number\":\"7890\",\"cc_expiration_date\":\"01\\\/2025\",\"cc_cvv\":\"1234\",\"cc_brand\":\"Visa\",\"ach_bank_account_name\":\"Acme Inc.\",\"ach_routing_number\":\"123456789\",\"ach_account_number\":\"123456789\",\"ach_ownership_type\":\"Personal\",\"ach_account_type\":\"Checking\",\"ach_bank_name\":\"Wells Fargo\",\"default\":true,\"addr1\":\"123 First St.\",\"addr2\":\"Suite 111\",\"city\":\"Alpharetta\",\"state\":\"GA\",\"zip\":\"30009\"}}" }, "description": "This endpoint creates a new payment method for a customer. Must pass at least one filter to select\n a specific customer" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":2,\"type\":\"cc\",\"token\":\"qYV343433d9BEu75dqES1005\",\"first_name\":\"Ben\",\"last_name\":\"Habeck\",\"cc_name_on_card\":\"Ben Habeck\",\"cc_last_four\":\"1005\",\"cc_expiration_date\":\"05\\\/2029\",\"cc_brand\":\"Amex\",\"status\":\"Default\",\"status_date\":\"2025-05-20 14:04:55\",\"enabled\":true,\"default\":true,\"addr1\":\"53 S. Main Street\",\"addr2\":\"\",\"addr3\":null,\"city\":\"Alpharetta\",\"state\":\"GA\",\"zip\":\"30009\"}}", "name": "" }, { "header": [], "code": 401, "body": "{\n \"data\": {\n \"message\": \"Permission denied\"\n }\n}", "name": "Token permission error" }, { "header": [], "code": 404, "body": "{\n\"data\": {\n \"message\": \"Customer not found.\"\n}\n}", "name": "Customer not found" }, { "header": [], "code": 404, "body": "{\n\"data\": {\n \"message\": \"No such Merchant\"\n}\n}", "name": "No such Merchant" } ] }, { "name": "Update a Payment Method for a customer", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/payment-method\/update", "query": [], "raw": "{{baseUrl}}\/api\/payment-method\/update" }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"data\":{\"uuid\":\"6ff8f7f6-1eb3-3525-be4a-3932c805afed\",\"sid\":12345,\"payment_method_id\":4326.41688,\"type\":\"cc\",\"cc_name_on_card\":\"John Doe\",\"cc_number\":\"7890\",\"cc_expiration_date\":\"01\\\/2025\",\"cc_cvv\":\"1234\",\"cc_brand\":\"Visa\",\"ach_bank_account_name\":\"Acme Inc.\",\"ach_routing_number\":\"123456789\",\"ach_account_number\":\"123456789\",\"ach_ownership_type\":\"Personal\",\"ach_account_type\":\"Checking\",\"ach_bank_name\":\"Wells Fargo\",\"default\":true,\"addr1\":\"123 First St.\",\"addr2\":\"Suite 111\",\"city\":\"Alpharetta\",\"state\":\"GA\",\"zip\":\"30009\"}}" }, "description": "This endpoint updates a payment method for a customer. Must pass at least one filter to select\n a specific customer" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":2,\"type\":\"cc\",\"token\":\"qYV343433d9BEu75dqES1005\",\"first_name\":\"Ben\",\"last_name\":\"Habeck\",\"cc_name_on_card\":\"Ben Habeck\",\"cc_last_four\":\"1005\",\"cc_expiration_date\":\"05\\\/2029\",\"cc_brand\":\"Amex\",\"status\":\"Default\",\"status_date\":\"2025-05-20 14:04:55\",\"enabled\":true,\"default\":true,\"addr1\":\"53 S. Main Street\",\"addr2\":\"\",\"addr3\":null,\"city\":\"Alpharetta\",\"state\":\"GA\",\"zip\":\"30009\"}}", "name": "" }, { "header": [], "code": 401, "body": "{\n\"data\": {\n \"message\": \"Permission denied\"\n}\n}", "name": "Token permission error" }, { "header": [], "code": 404, "body": "{\n\"data\": {\n \"message\": \"Customer not found.\"\n}\n}", "name": "Customer not found" }, { "header": [], "code": 404, "body": "{\n\"data\": {\n \"message\": \"No such Merchant\"\n}\n}", "name": "Merchant not found" } ] }, { "name": "Delete a Payment Method for a customer", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/payment-method\/delete", "query": [], "raw": "{{baseUrl}}\/api\/payment-method\/delete" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"data\":{\"sid\":12345,\"payment_method_id\":12345,\"uuid\":\"3c37db03-dc71-4e8b-90e7-6668290b7c3d\"}}" }, "description": "This endpoint deletes a payment method for a customer. Must pass at least one filter to select\n a specific customer" }, "response": [ { "header": [], "code": 200, "body": "{\n\"data\": {\n \"message\": \"Payment Method deleted successfully.\"\n }\n}", "name": "Successful Deletion" }, { "header": [], "code": 401, "body": "{\n\"data\": {\n \"message\": \"Permission denied\"\n}\n}", "name": "Token permission error" }, { "header": [], "code": 404, "body": "{\n\"data\": {\n \"message\": \"Customer not found.\"\n}\n}", "name": "Customer not found" }, { "header": [], "code": 404, "body": "{\n\"data\": {\n \"message\": \"No such Merchant\"\n}\n}", "name": "Merchant not found" }, { "header": [], "code": 404, "body": "{\n\"data\": {\n \"message\": \"Payment Method not found\"\n}\n}", "name": "Payment Method not found" }, { "header": [], "code": 409, "body": "{\n\"data\": {\n \"message\": \"Cannot delete payment method with active recurring payments.\"\n}\n}", "name": "Payment method has active recurring payments" } ] } ] }, { "name": "Recurring Payments management", "description": "\nAPIs for managing recurring payments. Depending on API KEY permissions, one should be able to\ncreate, edit, pause, cancel along with other functions.", "item": [ { "name": "List Recurring Payments", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/recurring-payment\/list", "query": [], "raw": "{{baseUrl}}\/api\/recurring-payment\/list" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"data\":{\"sid\":\"12345\"},\"filters\":{\"status\":\"Active, Failed, Paused, Canceled\",\"customer_uuid\":\"cust_456\"}}" }, "description": "Retrieves a list of recurring payments for a given Merchant, filtered by various parameters." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":1,\"name\":\"Car Was Solutions \",\"amount\":\"4,574.99\",\"cover_processing_amount\":null,\"start_date\":\"2024-11-07T05:00:00.000000Z\",\"end_date\":\"2026-12-31T05:00:00.000000Z\",\"recurrence_schedule\":\"Monthly\",\"last_run_date\":\"2025-12-15T05:00:00.000000Z\",\"last_run_status\":\"Failed\",\"last_run_failed_count\":3,\"next_run_date\":null,\"status\":\"Cancelled\",\"paused_until_date\":null,\"customer_uuid\":\"9a242468-6b4e-4382-a61b-a728fbc8edae\",\"cancelled_at\":\"2026-06-29T04:00:00.000000Z\",\"error\":\"DECLINE\",\"payment_method\":{\"id\":7,\"type\":\"cc\",\"last_four\":\"4003\",\"expiration\":\"09\\\/2029\",\"zip\":\"\",\"name_on_card\":\"Geo Perez\"},\"shipping_address\":{\"addr1\":null,\"addr2\":null,\"city\":null,\"state\":null,\"zip\":null}},{\"id\":1,\"name\":\"Car Was Solutions \",\"amount\":\"4,574.99\",\"cover_processing_amount\":null,\"start_date\":\"2024-11-07T05:00:00.000000Z\",\"end_date\":\"2026-12-31T05:00:00.000000Z\",\"recurrence_schedule\":\"Monthly\",\"last_run_date\":\"2025-12-15T05:00:00.000000Z\",\"last_run_status\":\"Failed\",\"last_run_failed_count\":3,\"next_run_date\":null,\"status\":\"Cancelled\",\"paused_until_date\":null,\"customer_uuid\":\"9a242468-6b4e-4382-a61b-a728fbc8edae\",\"cancelled_at\":\"2026-06-29T04:00:00.000000Z\",\"error\":\"DECLINE\",\"payment_method\":{\"id\":7,\"type\":\"cc\",\"last_four\":\"4003\",\"expiration\":\"09\\\/2029\",\"zip\":\"\",\"name_on_card\":\"Geo Perez\"},\"shipping_address\":{\"addr1\":null,\"addr2\":null,\"city\":null,\"state\":null,\"zip\":null}}],\"links\":{\"prev\":null,\"next\":null},\"meta\":{\"path\":\"\\\/\",\"per_page\":15,\"next_cursor\":null,\"prev_cursor\":null}}", "name": "" }, { "header": [], "code": 400, "body": "{\n \"errors\":\n {\n \"filters.status\": [\"The filters.status field is not valid.\"]\n }\n}", "name": "Failed validation" }, { "header": [], "code": 401, "body": "{\"data\": { \"message\": \"Permission Denied.\"}}", "name": "Token unauthorized" }, { "header": [], "code": 401, "body": "{\"data\": { \"message\": \"Unauthorized\"}}", "name": "Invalid merchant or affiliate authorization" }, { "header": [], "code": 401, "body": "{\"data\": { \"message\": \"Not associated with affiliate\"}}", "name": "Invalid merchant or affiliate associations" }, { "header": [], "code": 404, "body": "{\"data\": { \"message\": \"No such Merchant\"}}", "name": "Invalid sid" }, { "header": [], "code": 404, "body": "{\"data\": {\"message\": \"No recurring payments found\"}}", "name": "No recurring payments found" } ] }, { "name": "Pause Recurring Payment", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/recurring-payment\/pause", "query": [], "raw": "{{baseUrl}}\/api\/recurring-payment\/pause" }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"data\":{\"sid\":\"12345\",\"recurring_payment_id\":12345,\"pause_until_date\":\"2021-01-01 00:00:00\"}}" }, "description": "Pauses a scheduled recurring payment. If pause_until_date is not passed, it will be set to 2099-12-31" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":1,\"name\":\"Car Was Solutions \",\"amount\":\"4,574.99\",\"cover_processing_amount\":null,\"start_date\":\"2024-11-07T05:00:00.000000Z\",\"end_date\":\"2026-12-31T05:00:00.000000Z\",\"recurrence_schedule\":\"Monthly\",\"last_run_date\":\"2025-12-15T05:00:00.000000Z\",\"last_run_status\":\"Failed\",\"last_run_failed_count\":3,\"next_run_date\":null,\"status\":\"Cancelled\",\"paused_until_date\":null,\"customer_uuid\":\"9a242468-6b4e-4382-a61b-a728fbc8edae\",\"cancelled_at\":\"2026-06-29T04:00:00.000000Z\",\"error\":\"DECLINE\",\"payment_method\":{\"id\":7,\"type\":\"cc\",\"last_four\":\"4003\",\"expiration\":\"09\\\/2029\",\"zip\":\"\",\"name_on_card\":\"Geo Perez\"},\"shipping_address\":{\"addr1\":null,\"addr2\":null,\"city\":null,\"state\":null,\"zip\":null}}}", "name": "" }, { "header": [], "code": 400, "body": "{\n \"errors\":\n {\n \"data.pause_until_date\": [\"Invalid date format.\"]\n }\n}", "name": "Failed validation" }, { "header": [], "code": 401, "body": "{\"data\": { \"message\": \"Permission Denied.\"}}", "name": "Token unauthorized" }, { "header": [], "code": 401, "body": "{\"data\": { \"message\": \"Unauthorized\"}}", "name": "Invalid merchant or affiliate authorization" }, { "header": [], "code": 401, "body": "{\"data\": { \"message\": \"Not associated with affiliate\"}}", "name": "Invalid merchant or affiliate associations" }, { "header": [], "code": 404, "body": "{\"data\": { \"message\": \"No such Merchant\"}}", "name": "Invalid sid" }, { "header": [], "code": 404, "body": "{\"data\": {\"message\": \"No recurring payment found\"}}", "name": "No recurring payment found" } ] }, { "name": "Cancel Recurring Payment", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/recurring-payment\/cancel", "query": [], "raw": "{{baseUrl}}\/api\/recurring-payment\/cancel" }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"data\":{\"sid\":\"12345\",\"recurring_payment_id\":12345}}" }, "description": "Cancels a scheduled recurring payment." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":1,\"name\":\"Car Was Solutions \",\"amount\":\"4,574.99\",\"cover_processing_amount\":null,\"start_date\":\"2024-11-07T05:00:00.000000Z\",\"end_date\":\"2026-12-31T05:00:00.000000Z\",\"recurrence_schedule\":\"Monthly\",\"last_run_date\":\"2025-12-15T05:00:00.000000Z\",\"last_run_status\":\"Failed\",\"last_run_failed_count\":3,\"next_run_date\":null,\"status\":\"Cancelled\",\"paused_until_date\":null,\"customer_uuid\":\"9a242468-6b4e-4382-a61b-a728fbc8edae\",\"cancelled_at\":\"2026-06-29T04:00:00.000000Z\",\"error\":\"DECLINE\",\"payment_method\":{\"id\":7,\"type\":\"cc\",\"last_four\":\"4003\",\"expiration\":\"09\\\/2029\",\"zip\":\"\",\"name_on_card\":\"Geo Perez\"},\"shipping_address\":{\"addr1\":null,\"addr2\":null,\"city\":null,\"state\":null,\"zip\":null}}}", "name": "" }, { "header": [], "code": 401, "body": "{\"data\": { \"message\": \"Permission Denied.\"}}", "name": "Token unauthorized" }, { "header": [], "code": 401, "body": "{\"data\": { \"message\": \"Unauthorized\"}}", "name": "Invalid merchant or affiliate authorization" }, { "header": [], "code": 401, "body": "{\"data\": { \"message\": \"Not associated with affiliate\"}}", "name": "Invalid merchant or affiliate associations" }, { "header": [], "code": 404, "body": "{\"data\": { \"message\": \"No such Merchant\"}}", "name": "Invalid sid" }, { "header": [], "code": 404, "body": "{\"data\": {\"message\": \"No recurring payment found\"}}", "name": "No recurring payment found" } ] }, { "name": "Activate Recurring Payment", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/recurring-payment\/activate", "query": [], "raw": "{{baseUrl}}\/api\/recurring-payment\/activate" }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"data\":{\"sid\":\"12345\",\"recurring_payment_id\":12345}}" }, "description": "Activates a scheduled recurring payment. Set to status of Active and calculates next run date." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":1,\"name\":\"Car Was Solutions \",\"amount\":\"4,574.99\",\"cover_processing_amount\":null,\"start_date\":\"2024-11-07T05:00:00.000000Z\",\"end_date\":\"2026-12-31T05:00:00.000000Z\",\"recurrence_schedule\":\"Monthly\",\"last_run_date\":\"2025-12-15T05:00:00.000000Z\",\"last_run_status\":\"Failed\",\"last_run_failed_count\":3,\"next_run_date\":null,\"status\":\"Cancelled\",\"paused_until_date\":null,\"customer_uuid\":\"9a242468-6b4e-4382-a61b-a728fbc8edae\",\"cancelled_at\":\"2026-06-29T04:00:00.000000Z\",\"error\":\"DECLINE\",\"payment_method\":{\"id\":7,\"type\":\"cc\",\"last_four\":\"4003\",\"expiration\":\"09\\\/2029\",\"zip\":\"\",\"name_on_card\":\"Geo Perez\"},\"shipping_address\":{\"addr1\":null,\"addr2\":null,\"city\":null,\"state\":null,\"zip\":null}}}", "name": "" }, { "header": [], "code": 401, "body": "{\"data\": { \"message\": \"Permission Denied.\"}}", "name": "Token unauthorized" }, { "header": [], "code": 401, "body": "{\"data\": { \"message\": \"Unauthorized\"}}", "name": "Invalid merchant or affiliate authorization" }, { "header": [], "code": 401, "body": "{\"data\": { \"message\": \"Not associated with affiliate\"}}", "name": "Invalid merchant or affiliate associations" }, { "header": [], "code": 404, "body": "{\"data\": { \"message\": \"No such Merchant\"}}", "name": "Invalid sid" }, { "header": [], "code": 404, "body": "{\"data\": {\"message\": \"No recurring payment found\"}}", "name": "No recurring payment found" } ] }, { "name": "Edit Recurring Payment", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/recurring-payment\/edit", "query": [], "raw": "{{baseUrl}}\/api\/recurring-payment\/edit" }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"data\":{\"sid\":\"12345\",\"recurring_payment_id\":12345,\"name\":\"Rent\",\"amount\":1101.69,\"start_date\":\"2025-06-12 13:26:00\",\"end_date\":\"2026-06-12 13:26:00\",\"recurrence_schedule\":\"Monthly\",\"payment_method\":69585,\"customer_covers_fee\":true,\"shipping_address\":{\"addr1\":\"123 Main St.\",\"addr2\":\"apt 1\",\"city\":\"Alpharetta.\",\"state\":\"GA.\",\"zip\":\"12345.\"}}}" }, "description": "Edits an existing recurring payment. All fields other than `sid` and `recurring_payment_id` are optional; only\nthe fields you pass will be updated. The customer cannot be changed, and a new payment method must belong to the\nrecurring payment's existing customer. When `recurrence_schedule` or `start_date` change on an Active payment,\nthe next run date is recalculated automatically." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":1,\"name\":\"Car Was Solutions \",\"amount\":\"4,574.99\",\"cover_processing_amount\":null,\"start_date\":\"2024-11-07T05:00:00.000000Z\",\"end_date\":\"2026-12-31T05:00:00.000000Z\",\"recurrence_schedule\":\"Monthly\",\"last_run_date\":\"2025-12-15T05:00:00.000000Z\",\"last_run_status\":\"Failed\",\"last_run_failed_count\":3,\"next_run_date\":null,\"status\":\"Cancelled\",\"paused_until_date\":null,\"customer_uuid\":\"9a242468-6b4e-4382-a61b-a728fbc8edae\",\"cancelled_at\":\"2026-06-29T04:00:00.000000Z\",\"error\":\"DECLINE\",\"payment_method\":{\"id\":7,\"type\":\"cc\",\"last_four\":\"4003\",\"expiration\":\"09\\\/2029\",\"zip\":\"\",\"name_on_card\":\"Geo Perez\"},\"shipping_address\":{\"addr1\":null,\"addr2\":null,\"city\":null,\"state\":null,\"zip\":null}}}", "name": "" }, { "header": [], "code": 400, "body": "{\n \"errors\":\n {\n \"data.amount\": [\"The data.amount field must be greater than 0.\"]\n }\n}", "name": "Failed validation" }, { "header": [], "code": 401, "body": "{\"data\": { \"message\": \"Permission Denied.\"}}", "name": "Token unauthorized" }, { "header": [], "code": 401, "body": "{\"data\": { \"message\": \"Unauthorized\"}}", "name": "Invalid merchant or affiliate authorization" }, { "header": [], "code": 401, "body": "{\"data\": { \"message\": \"Not associated with affiliate\"}}", "name": "Invalid merchant or affiliate associations" }, { "header": [], "code": 404, "body": "{\"data\": { \"message\": \"No such Merchant\"}}", "name": "Invalid sid" }, { "header": [], "code": 404, "body": "{\"data\": { \"message\": \"No such Payment Method\"}}", "name": "Invalid payment method" }, { "header": [], "code": 404, "body": "{\"data\": { \"message\": \"Payment Method does not belong to Customer\"}}", "name": "Payment method belongs to another customer" }, { "header": [], "code": 404, "body": "{\"data\": {\"message\": \"No recurring payment found\"}}", "name": "No recurring payment found" } ] }, { "name": "Create Recurring Payment", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/recurring-payment\/create", "query": [], "raw": "{{baseUrl}}\/api\/recurring-payment\/create" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"data\":{\"sid\":\"12345\",\"name\":\"Rent\",\"amount\":1101.69,\"start_date\":\"2025-06-12 13:26:00\",\"end_date\":\"2026-06-12 13:26:00\",\"recurrence_schedule\":\"Monthly\",\"payment_method\":69585,\"customer_uuid\":\"12312312-12312321-12312312-12312312\",\"customer_covers_fee\":true,\"shipping_address\":{\"addr1\":\"123 Main St.\",\"addr2\":\"apt 1\",\"city\":\"Alpharetta.\",\"state\":\"GA.\",\"zip\":\"12345.\"}}}" }, "description": "Creates a scheduled recurring payment. The payment will run on the next date based on schedule and start date. So\nif you create one that starts on 2025-01-01 00:00:00 with Monthly, then the payment method will be charged on 2025-02-01\nRecurring Payments run around 0500 EST." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":1,\"name\":\"Car Was Solutions \",\"amount\":\"4,574.99\",\"cover_processing_amount\":null,\"start_date\":\"2024-11-07T05:00:00.000000Z\",\"end_date\":\"2026-12-31T05:00:00.000000Z\",\"recurrence_schedule\":\"Monthly\",\"last_run_date\":\"2025-12-15T05:00:00.000000Z\",\"last_run_status\":\"Failed\",\"last_run_failed_count\":3,\"next_run_date\":null,\"status\":\"Cancelled\",\"paused_until_date\":null,\"customer_uuid\":\"9a242468-6b4e-4382-a61b-a728fbc8edae\",\"cancelled_at\":\"2026-06-29T04:00:00.000000Z\",\"error\":\"DECLINE\",\"payment_method\":{\"id\":7,\"type\":\"cc\",\"last_four\":\"4003\",\"expiration\":\"09\\\/2029\",\"zip\":\"\",\"name_on_card\":\"Geo Perez\"},\"shipping_address\":{\"addr1\":null,\"addr2\":null,\"city\":null,\"state\":null,\"zip\":null}}}", "name": "" }, { "header": [], "code": 401, "body": "{\"data\": { \"message\": \"Permission Denied.\"}}", "name": "Token unauthorized" }, { "header": [], "code": 401, "body": "{\"data\": { \"message\": \"Unauthorized\"}}", "name": "Invalid merchant or affiliate authorization" }, { "header": [], "code": 401, "body": "{\"data\": { \"message\": \"Not associated with affiliate\"}}", "name": "Invalid merchant or affiliate associations" }, { "header": [], "code": 404, "body": "{\"data\": { \"message\": \"No such Merchant\"}}", "name": "Invalid sid" } ] }, { "name": "Show Recurring Payment", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/recurring-payment\/show", "query": [], "raw": "{{baseUrl}}\/api\/recurring-payment\/show" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"data\":{\"sid\":\"12345\",\"recurring_payment_id\":12345}}" }, "description": "Show details of a scheduled recurring payment." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":1,\"name\":\"Car Was Solutions \",\"amount\":\"4,574.99\",\"cover_processing_amount\":null,\"start_date\":\"2024-11-07T05:00:00.000000Z\",\"end_date\":\"2026-12-31T05:00:00.000000Z\",\"recurrence_schedule\":\"Monthly\",\"last_run_date\":\"2025-12-15T05:00:00.000000Z\",\"last_run_status\":\"Failed\",\"last_run_failed_count\":3,\"next_run_date\":null,\"status\":\"Cancelled\",\"paused_until_date\":null,\"customer_uuid\":\"9a242468-6b4e-4382-a61b-a728fbc8edae\",\"cancelled_at\":\"2026-06-29T04:00:00.000000Z\",\"error\":\"DECLINE\",\"payment_method\":{\"id\":7,\"type\":\"cc\",\"last_four\":\"4003\",\"expiration\":\"09\\\/2029\",\"zip\":\"\",\"name_on_card\":\"Geo Perez\"},\"shipping_address\":{\"addr1\":null,\"addr2\":null,\"city\":null,\"state\":null,\"zip\":null}}}", "name": "" }, { "header": [], "code": 401, "body": "{\"data\": { \"message\": \"Permission Denied.\"}}", "name": "Token unauthorized" }, { "header": [], "code": 401, "body": "{\"data\": { \"message\": \"Unauthorized\"}}", "name": "Invalid merchant or affiliate authorization" }, { "header": [], "code": 401, "body": "{\"data\": { \"message\": \"Not associated with affiliate\"}}", "name": "Invalid merchant or affiliate associations" }, { "header": [], "code": 404, "body": "{\"data\": { \"message\": \"No such Merchant\"}}", "name": "Invalid sid" }, { "header": [], "code": 404, "body": "{\"data\": {\"message\": \"No recurring payment found\"}}", "name": "No recurring payment found" } ] }, { "name": "Delete Recurring Payment", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/recurring-payment\/delete", "query": [], "raw": "{{baseUrl}}\/api\/recurring-payment\/delete" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"data\":{\"sid\":\"12345\",\"recurring_payment_id\":12345}}" }, "description": "Delete a recurring payment." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": {\n \"message\": \"Recurring payment successfully deleted.\"\n }\n}", "name": "Successful Deletion" }, { "header": [], "code": 401, "body": "{\"data\": { \"message\": \"Permission Denied.\"}}", "name": "Token unauthorized" }, { "header": [], "code": 401, "body": "{\"data\": { \"message\": \"Unauthorized\"}}", "name": "Invalid merchant or affiliate authorization" }, { "header": [], "code": 401, "body": "{\"data\": { \"message\": \"Not associated with affiliate\"}}", "name": "Invalid merchant or affiliate associations" }, { "header": [], "code": 404, "body": "{\"data\": { \"message\": \"No such Merchant\"}}", "name": "Invalid sid" }, { "header": [], "code": 404, "body": "{\"data\": {\"message\": \"No recurring payment found\"}}", "name": "No recurring payment found" } ] } ] }, { "name": "Subscription Plans management", "description": "\nMerchant-facing API for subscription plans (recurring offerings customers\nsubscribe to). The merchant is identified by `data.sid`; the token must carry\nthe matching `subscription-plan:*` ability. Mirrors the recurring-payment and\ninvoice API controllers.", "item": [ { "name": "List subscription plans", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/subscription-plan\/list", "query": [], "raw": "{{baseUrl}}\/api\/subscription-plan\/list" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "[]" }, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":null,\"name\":\"Monthly Membership 54634\",\"description\":\"Qui commodi incidunt iure odit.\",\"recurrence_schedule\":\"Monthly\",\"status\":\"active\",\"subtotal\":0,\"total\":0,\"token\":\"3G7NdMXiBDJ6X7bosY061UoySQUxE7cTGnB2FHUp\",\"public_url\":\"http:\\\/\\\/app.dimepayments.com\\\/subscribe\\\/3G7NdMXiBDJ6X7bosY061UoySQUxE7cTGnB2FHUp\",\"allow_public\":true,\"created_at\":null,\"items\":[]},{\"id\":null,\"name\":\"Monthly Membership 35354\",\"description\":\"Ex voluptatem laboriosam praesentium quis adipisci.\",\"recurrence_schedule\":\"Monthly\",\"status\":\"active\",\"subtotal\":0,\"total\":0,\"token\":\"nf9if1KTegZn15OII510i0s5Ibw93tgSuO7iRUzf\",\"public_url\":\"http:\\\/\\\/app.dimepayments.com\\\/subscribe\\\/nf9if1KTegZn15OII510i0s5Ibw93tgSuO7iRUzf\",\"allow_public\":true,\"created_at\":null,\"items\":[]}],\"links\":{\"prev\":null,\"next\":null},\"meta\":{\"path\":\"\\\/\",\"per_page\":500,\"next_cursor\":null,\"prev_cursor\":null}}", "name": "" } ] }, { "name": "Show a subscription plan", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/subscription-plan\/show", "query": [], "raw": "{{baseUrl}}\/api\/subscription-plan\/show" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "[]" }, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":null,\"name\":\"Monthly Membership 80304\",\"description\":\"Commodi incidunt iure odit.\",\"recurrence_schedule\":\"Monthly\",\"status\":\"active\",\"subtotal\":0,\"total\":0,\"token\":\"2GoGWosXssjWWWrrIBKSxGkPp4R2Xb8dCHI6heJw\",\"public_url\":\"http:\\\/\\\/app.dimepayments.com\\\/subscribe\\\/2GoGWosXssjWWWrrIBKSxGkPp4R2Xb8dCHI6heJw\",\"allow_public\":true,\"created_at\":null,\"items\":[]}}", "name": "" } ] }, { "name": "Create a subscription plan", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/subscription-plan\/create", "query": [], "raw": "{{baseUrl}}\/api\/subscription-plan\/create" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"data\":{\"lines\":[{\"item_id\":5,\"name\":\"Base membership\",\"quantity\":1,\"unit_price\":25}]}}" }, "description": "The plan is created as a draft. Publish it (or use the merchant UI) before\ncustomers can subscribe." }, "response": [ { "header": [], "code": 201, "body": "{\"data\":{\"id\":null,\"name\":\"Community Circle 70546\",\"description\":\"Quos velit et fugiat sunt nihil accusantium harum.\",\"recurrence_schedule\":\"Monthly\",\"status\":\"active\",\"subtotal\":0,\"total\":0,\"token\":\"H8QrmUgkmlOQYH2NPLUcJvHIY2I27bOmNGn2iJ0q\",\"public_url\":\"http:\\\/\\\/app.dimepayments.com\\\/subscribe\\\/H8QrmUgkmlOQYH2NPLUcJvHIY2I27bOmNGn2iJ0q\",\"allow_public\":true,\"created_at\":null,\"items\":[]}}", "name": "" } ] }, { "name": "Update a subscription plan", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/subscription-plan\/edit", "query": [], "raw": "{{baseUrl}}\/api\/subscription-plan\/edit" }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "[]" }, "description": "Replaces the plan's fields and line items wholesale. Existing subscribers\nkeep their own snapshot and are unaffected." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":null,\"name\":\"Community Circle 63526\",\"description\":null,\"recurrence_schedule\":\"Monthly\",\"status\":\"active\",\"subtotal\":0,\"total\":0,\"token\":\"3icVdZHR02Sjogda0RPSgCirYn7XQZ0zln3x32Rk\",\"public_url\":\"http:\\\/\\\/app.dimepayments.com\\\/subscribe\\\/3icVdZHR02Sjogda0RPSgCirYn7XQZ0zln3x32Rk\",\"allow_public\":true,\"created_at\":null,\"items\":[]}}", "name": "" } ] }, { "name": "Delete a subscription plan", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/subscription-plan\/delete", "query": [], "raw": "{{baseUrl}}\/api\/subscription-plan\/delete" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "[]" }, "description": "Only plans with no subscribers can be deleted; otherwise archive it." }, "response": [ { "header": [], "code": 200, "body": "{\"data\": {\"message\": \"Subscription plan deleted\"}}", "name": "Deleted" }, { "header": [], "code": 422, "body": "{\"data\": {\"message\": \"Cannot delete a plan with subscribers. Archive it instead.\"}}", "name": "Has subscribers" } ] }, { "name": "Publish a subscription plan", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/subscription-plan\/publish", "query": [], "raw": "{{baseUrl}}\/api\/subscription-plan\/publish" }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "[]" }, "description": "Moves a draft plan to active so customers can subscribe. The plan must be a\ndraft and carry at least one line item." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":null,\"name\":\"Monthly Membership 14650\",\"description\":null,\"recurrence_schedule\":\"Monthly\",\"status\":\"active\",\"subtotal\":0,\"total\":0,\"token\":\"NOIsACYHidsVtD35hmwriVpZQ604ExlWYRfJanwf\",\"public_url\":\"http:\\\/\\\/app.dimepayments.com\\\/subscribe\\\/NOIsACYHidsVtD35hmwriVpZQ604ExlWYRfJanwf\",\"allow_public\":true,\"created_at\":null,\"items\":[]}}", "name": "" } ] }, { "name": "Archive a subscription plan", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/subscription-plan\/archive", "query": [], "raw": "{{baseUrl}}\/api\/subscription-plan\/archive" }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "[]" }, "description": "Stops new subscriptions and hides it from the catalog. Existing subscribers\nkeep their subscription." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":null,\"name\":\"Monthly Membership 62492\",\"description\":\"Iure odit et et modi ipsum nostrum omnis.\",\"recurrence_schedule\":\"Monthly\",\"status\":\"active\",\"subtotal\":0,\"total\":0,\"token\":\"FGZR14ITUjzTgDRZjCUUycpqmuWLv2em01kZ9PPN\",\"public_url\":\"http:\\\/\\\/app.dimepayments.com\\\/subscribe\\\/FGZR14ITUjzTgDRZjCUUycpqmuWLv2em01kZ9PPN\",\"allow_public\":true,\"created_at\":null,\"items\":[]}}", "name": "" } ] }, { "name": "Reactivate a subscription plan", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/subscription-plan\/unarchive", "query": [], "raw": "{{baseUrl}}\/api\/subscription-plan\/unarchive" }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "[]" }, "description": "Moves an archived plan back to draft so it can be reviewed and re-published.\n`allow_public` stays off until the merchant opts back into the catalog." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":null,\"name\":\"Monthly Membership 45193\",\"description\":\"Odit et et modi.\",\"recurrence_schedule\":\"Monthly\",\"status\":\"active\",\"subtotal\":0,\"total\":0,\"token\":\"zOiiyTxB6dwjOTciRdSPMq28DUt79qERchbW7ooj\",\"public_url\":\"http:\\\/\\\/app.dimepayments.com\\\/subscribe\\\/zOiiyTxB6dwjOTciRdSPMq28DUt79qERchbW7ooj\",\"allow_public\":true,\"created_at\":null,\"items\":[]}}", "name": "" } ] }, { "name": "Subscribe a customer to a plan", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/subscription-plan\/subscribe", "query": [], "raw": "{{baseUrl}}\/api\/subscription-plan\/subscribe" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "[]" }, "description": "Charges the first payment against the customer's saved payment method and\nenrolls them in the plan. The plan must be active. Fires SUBSCRIPTION_CREATED." }, "response": [ { "header": [], "code": 201, "body": "{\"data\": {\"subscription_id\": 10, \"status\": \"Active\", \"next_run_date\": \"2026-08-21\", \"transaction_number\": \"TXN-123\", \"amount\": 25.0}}", "name": "Subscribed" }, { "header": [], "code": 422, "body": "{\"data\": {\"message\": \"Card declined\", \"transaction_number\": null}}", "name": "Charge failed" } ] } ] }, { "name": "Subscriptions management", "description": "\nMerchant-facing API for individual customer subscriptions (enrollments in a\nplan). The merchant is identified by `data.sid`; the token must carry the\nmatching `subscription:*` ability. Lifecycle transitions delegate to the\n{@see \\App\\Actions\\Subscription} action classes so the matching `SUBSCRIPTION_*`\nwebhook always fires. Mirrors the recurring-payment and subscription-plan API\ncontrollers.", "item": [ { "name": "List subscriptions", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/subscription\/list", "query": [], "raw": "{{baseUrl}}\/api\/subscription\/list" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"data\":{\"sid\":12345},\"filters\":{\"status\":\"Active\",\"customer_uuid\":\"9c1e6a7e-1f2b-4c3d-8e9f-0a1b2c3d4e5f\"}}" }, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":null,\"subscription_plan_id\":211,\"plan_name\":\"Premium Plan 24492\",\"amount\":\"0.00\",\"recurrence_schedule\":\"Monthly\",\"start_date\":\"2026-08-22T04:00:00.000000Z\",\"end_date\":null,\"last_run_date\":null,\"last_run_status\":null,\"last_run_failed_count\":0,\"next_run_date\":\"2026-10-22T04:00:00.000000Z\",\"status\":\"Active\",\"paused_until_date\":null,\"cancelled_at\":null,\"cancelled_by\":null,\"customer_uuid\":\"7528ef5b-50a4-4124-879d-321631ac5948\",\"error\":null,\"payment_method\":{\"id\":6187,\"type\":\"cc\",\"last_four\":\"3642\",\"expiration\":\"08\\\/2030\"}},{\"id\":null,\"subscription_plan_id\":212,\"plan_name\":\"Monthly Membership 88481\",\"amount\":\"0.00\",\"recurrence_schedule\":\"Monthly\",\"start_date\":\"2026-08-22T04:00:00.000000Z\",\"end_date\":null,\"last_run_date\":null,\"last_run_status\":null,\"last_run_failed_count\":0,\"next_run_date\":\"2026-10-22T04:00:00.000000Z\",\"status\":\"Active\",\"paused_until_date\":null,\"cancelled_at\":null,\"cancelled_by\":null,\"customer_uuid\":\"f5af1bab-c5c7-4eed-85a1-b82e373c935f\",\"error\":null,\"payment_method\":{\"id\":6188,\"type\":\"cc\",\"last_four\":\"5053\",\"expiration\":\"08\\\/2030\"}}],\"links\":{\"prev\":null,\"next\":null},\"meta\":{\"path\":\"\\\/\",\"per_page\":500,\"next_cursor\":null,\"prev_cursor\":null}}", "name": "" } ] }, { "name": "Show a subscription", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/subscription\/show", "query": [], "raw": "{{baseUrl}}\/api\/subscription\/show" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "[]" }, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":null,\"subscription_plan_id\":213,\"plan_name\":\"Monthly Membership 30805\",\"amount\":\"0.00\",\"recurrence_schedule\":\"Monthly\",\"start_date\":\"2026-08-22T04:00:00.000000Z\",\"end_date\":null,\"last_run_date\":null,\"last_run_status\":null,\"last_run_failed_count\":0,\"next_run_date\":\"2026-10-22T04:00:00.000000Z\",\"status\":\"Active\",\"paused_until_date\":null,\"cancelled_at\":null,\"cancelled_by\":null,\"customer_uuid\":\"a35294f2-8012-40c8-a165-32d152edabc3\",\"error\":null,\"payment_method\":{\"id\":6189,\"type\":\"cc\",\"last_four\":\"1161\",\"expiration\":\"08\\\/2030\"}}}", "name": "" } ] }, { "name": "Pause a subscription", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/subscription\/pause", "query": [], "raw": "{{baseUrl}}\/api\/subscription\/pause" }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "[]" }, "description": "Pauses an active subscription until the given date. If `data.pause_until_date`\nis omitted it pauses indefinitely. Fires the `SUBSCRIPTION_PAUSED` webhook." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":null,\"subscription_plan_id\":214,\"plan_name\":\"Monthly Membership 93082\",\"amount\":\"0.00\",\"recurrence_schedule\":\"Monthly\",\"start_date\":\"2026-08-22T04:00:00.000000Z\",\"end_date\":null,\"last_run_date\":null,\"last_run_status\":null,\"last_run_failed_count\":0,\"next_run_date\":\"2026-10-22T04:00:00.000000Z\",\"status\":\"Active\",\"paused_until_date\":null,\"cancelled_at\":null,\"cancelled_by\":null,\"customer_uuid\":\"97b27f0e-9073-4f5b-a3af-e47df7800514\",\"error\":null,\"payment_method\":{\"id\":6190,\"type\":\"cc\",\"last_four\":\"7849\",\"expiration\":\"08\\\/2030\"}}}", "name": "" } ] }, { "name": "Resume a subscription", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/subscription\/resume", "query": [], "raw": "{{baseUrl}}\/api\/subscription\/resume" }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "[]" }, "description": "Reactivates a paused subscription and recomputes its next charge date. Fires\nthe `SUBSCRIPTION_RESUMED` webhook." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":null,\"subscription_plan_id\":215,\"plan_name\":\"Monthly Membership 43383\",\"amount\":\"0.00\",\"recurrence_schedule\":\"Monthly\",\"start_date\":\"2026-08-22T04:00:00.000000Z\",\"end_date\":null,\"last_run_date\":null,\"last_run_status\":null,\"last_run_failed_count\":0,\"next_run_date\":\"2026-10-22T04:00:00.000000Z\",\"status\":\"Active\",\"paused_until_date\":null,\"cancelled_at\":null,\"cancelled_by\":null,\"customer_uuid\":\"d3fe0d42-d878-4b50-b28a-54bea540bcb1\",\"error\":null,\"payment_method\":{\"id\":6191,\"type\":\"cc\",\"last_four\":\"2895\",\"expiration\":\"08\\\/2030\"}}}", "name": "" } ] }, { "name": "Cancel a subscription", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/subscription\/cancel", "query": [], "raw": "{{baseUrl}}\/api\/subscription\/cancel" }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "[]" }, "description": "Permanently cancels a subscription \u2014 no further charges are made. Fires the\n`SUBSCRIPTION_CANCELLED` webhook." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":null,\"subscription_plan_id\":216,\"plan_name\":\"Monthly Membership 92439\",\"amount\":\"0.00\",\"recurrence_schedule\":\"Monthly\",\"start_date\":\"2026-08-22T04:00:00.000000Z\",\"end_date\":null,\"last_run_date\":null,\"last_run_status\":null,\"last_run_failed_count\":0,\"next_run_date\":\"2026-10-22T04:00:00.000000Z\",\"status\":\"Active\",\"paused_until_date\":null,\"cancelled_at\":null,\"cancelled_by\":null,\"customer_uuid\":\"d736d007-bca0-4347-a467-58408c36d132\",\"error\":null,\"payment_method\":{\"id\":6192,\"type\":\"cc\",\"last_four\":\"2074\",\"expiration\":\"08\\\/2030\"}}}", "name": "" } ] } ] }, { "name": "Zapier", "description": "\nAPIs for use through Zapier. Depending on API KEY permissions, one should be able to\nsee customers and transactions data.", "item": [ { "name": "Get New Customers", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/zapier\/new-customers", "query": [], "raw": "{{baseUrl}}\/api\/zapier\/new-customers" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Get a list of all new customers since the last time it was checked." }, "response": [ { "header": [], "code": 200, "body": "{\"data\": [{\"id\": 1, \"first_name\": \"John\", \"last_name\": \"Doe\", \"phone\": \"1234567890\", \"email\": \"email@email.com\", \"addr1\": \"123 Main St\", \"addr2\": \"\", \"addr3\": \"\", \"city\": \"Anytown\", \"state\": \"CA\", \"zip\": \"12345\", \"country\": \"US\"}]}", "name": "Successful Listing" }, { "header": [], "code": 401, "body": "{\"message\": \"Unauthorized\"}", "name": "Token permission error" }, { "header": [], "code": 404, "body": "{\"message\": \"Merchant not found\"}", "name": "Merchant not found" }, { "header": [], "code": 404, "body": "{\"message\": \"No transactions found\"}", "name": "Transactions not found" } ] }, { "name": "Get Transactions", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/zapier\/transactions", "query": [], "raw": "{{baseUrl}}\/api\/zapier\/transactions" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Get a list of all transactions for a Merchant" }, "response": [ { "header": [], "code": 200, "body": "[{\"amount\": \"100.00\", \"business\": \"Acme Inc\", \"transaction_date\": \"2020-10-15 12:00:00\", \"customer_uuid\": \"1234567890\", \"first_name\": \"John\", \"last_name\": \"Doe\", \"customer_phone\": \"1234567890\", \"customer_email\": \"email@email.com\"}, {\"amount\": \"100.00\", \"business\": \"Acme Inc\", \"transaction_date\": \"2020-10-15 12:00:00\", \"customer_uuid\": \"1234567890\", \"first_name\": \"John\", \"last_name\": \"Doe\", \"customer_phone\": \"1234567890\", \"customer_email\": \"email@email.com\"}]", "name": "Successful Listing" }, { "header": [], "code": 401, "body": "{\"message\" : \"Permission denied\"}", "name": "Token permission error" }, { "header": [], "code": 404, "body": "{\"message\" : \"Merchant not found\"}", "name": "Merchant not found" }, { "header": [], "code": 404, "body": "[]", "name": "Transactions not found" } ] }, { "name": "Get Transactions by Customer", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/zapier\/transactions\/:phone", "query": [], "raw": "{{baseUrl}}\/api\/zapier\/transactions\/:phone", "variable": [ { "id": "phone", "key": "phone", "value": "1", "description": "" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"start_date\":\"2020-10-15\",\"end_date\":\"2020-10-15\",\"last_days\":90}" }, "description": "Get a list of all transactions for a given customer using their phone number\n\n