{ "variable": [ { "id": "baseUrl", "key": "baseUrl", "type": "string", "name": "string", "value": "https:\/\/app.dimepayments.com" } ], "info": { "name": "Dime Payments API Documentation", "_postman_id": "870d97cc-8a59-4e0b-9263-68556bd135be", "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": "{\n\"data\": [\n {\n \"name\": \"Streich, Kub and Steuber\",\n \"sid\": \"000010\",\n \"mcc\": \"8661\",\n \"slug\": \"deleniti-sunt-at-unde\",\n \"pub_api_key\": \"pub_1zBYuKWfl4hvL71yOt40lM3QfMf\",\n \"processor_mid\": null,\n \"active\": true,\n \"active_at\": null,\n \"g_pay\": false,\n \"a_pay\": false,\n \"pci_compliance\": false,\n \"website\": null,\n \"addr1\": null,\n \"addr2\": null,\n \"addr3\": null,\n \"city\": null,\n \"state\": null,\n \"zip\": null,\n \"phone\": null,\n \"contracted_date\": null,\n \"primary_phone\": null,\n \"payment_token\": null,\n \"primary_email\": null,\n \"primary_name\": null\n},\n{\n \"name\": \"Kling, McGlynn and McKenzie\",\n \"sid\": \"000002\",\n \"mcc\": \"8661\",\n \"slug\": \"sint-inventore-cum-tempore\",\n \"pub_api_key\": \"pkapi_cert_CjsyGGXamvz9xxcrri\",\n \"processor_mid\": \"\",\n \"active\": true,\n \"active_at\": null,\n \"g_pay\": true,\n \"a_pay\": true,\n \"pci_compliance\": true,\n \"website\": \"https:\\\/\\\/www.google.com\",\n \"addr1\": \"78686 hjgjgj gjh\",\n \"addr2\": \"hkjhk 7777\",\n \"addr3\": \"\",\n \"city\": \"city\",\n \"state\": \"GA\",\n \"zip\": \"30303\",\n \"phone\": \"7707892072\",\n \"contracted_date\": null,\n \"primary_phone\": \"7707892072\",\n \"payment_token\": null,\n \"primary_email\": \"rtaylor82@gmail.com\",\n \"primary_name\": \"Ryan Taylor\"\n },", "name": "Successful Listing" }, { "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": 200, "body": "{\n \"data\": [\n {\n \"name\": \"Streich, Kub and Steuber\",\n \"sid\": \"000010\",\n \"mcc\": \"8661\",\n \"slug\": \"deleniti-sunt-at-unde\",\n \"pub_api_key\": \"pub_1zBYuKWfl4hvL71yOt40lM3QfMf\",\n \"processor_mid\": null,\n \"active\": true,\n \"active_at\": null,\n \"g_pay\": false,\n \"a_pay\": false,\n \"pci_compliance\": false,\n \"website\": null,\n \"addr1\": null,\n \"addr2\": null,\n \"city\": null,\n \"state\": null,\n \"zip\": null,\n \"phone\": null,\n \"primary_phone\": null,\n \"primary_email\": null,\n \"primary_name\": null\n }", "name": "Successful Show" }, { "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,\"processor_config_one\":\"Tier1\",\"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": "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": 200, "body": "{\n \"data\": [\n {\n \"name\": \"Streich, Kub and Steuber\",\n \"sid\": \"000010\",\n \"mcc\": \"8661\",\n \"slug\": \"deleniti-sunt-at-unde\",\n \"pub_api_key\": \"\",\n \"processor_mid\": null,\n \"active\": true,\n \"active_at\": null,\n \"g_pay\": false,\n \"a_pay\": false,\n \"pci_compliance\": false,\n \"website\": null,\n \"addr1\": null,\n \"addr2\": null,\n \"city\": null,\n \"state\": null,\n \"zip\": null,\n \"phone\": null,\n \"contracted_date\": null,\n \"primary_phone\": null,\n \"primary_email\": null,\n \"primary_name\": null\n }", "name": "Successful Creation" }, { "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": "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,\"processor_config_one\":\"Tier1\",\"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": 200, "body": "{\n \"data\": [\n {\n \"name\": \"Streich, Kub and Steuber\",\n \"sid\": \"000010\",\n \"mcc\": \"8661\",\n \"slug\": \"deleniti-sunt-at-unde\",\n \"pub_api_key\": \"\",\n \"processor_mid\": null,\n \"active\": true,\n \"active_at\": null,\n \"g_pay\": false,\n \"a_pay\": false,\n \"pci_compliance\": false,\n \"website\": null,\n \"addr1\": null,\n \"addr2\": null,\n \"city\": null,\n \"state\": null,\n \"zip\": null,\n \"phone\": null,\n \"primary_phone\": null,\n \"primary_email\": null,\n \"primary_name\": null\n }", "name": "Successful Update" }, { "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 48 hours." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": [\n {\n \"link\": \"https:\/\/app.dimepayments.com\/some\/link\",\n }", "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": "{\n \"data\": [\n {\n \"transaction_type\": \"CC\",\n \"transaction_status\": \"CC Pending\",\n \"transaction_status_description\": \"A transaction that has not cleared yet\",\n \"transaction_number\": \"1234567890\",\n \"transaction_date\": \"2025-10-28T22:04:22.000000Z\",\n \"fund_date\": \"2025-10-28T22:04:22.000000Z\",\n \"settle_date\": \"2025-10-28T22:04:22.000000Z\",\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\": \"1231321321231\"\n \"parent_transaction_info_id\": \"1231321321231\"\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 {\n \"transaction_type\": \"CC\",\n \"transaction_status\": \"CC Pending\",\n \"transaction_status_description\": \"A transaction that has not cleared yet\",\n \"transaction_number\": \"\",\n \"transaction_date\": \"2025-10-28T22:04:22.000000Z\",\n \"fund_date\": \"2025-10-28T22:04:22.000000Z\",\n \"settle_date\": \"2025-10-28T22:04:22.000000Z\",\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\": \"1231321321231\"\n \"parent_transaction_info_id\": \"1231321321231\"\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 ]\n}", "name": "Successful Listing" }, { "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\":0},\"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": "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.50\",\"transaction_info_id\":\"6789131231\",\"transaction_type\":\"CC\",\"transaction_id\":\"6789131231\"}}" }, "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": 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 \"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": "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": 200, "body": "{\n \"data\": [\n {\n \"id\": 1,\n \"recipient\": \"John Doe\",\n \"line_one\": \"123 Main St\",\n \"line_two\": \"Apt 4B\",\n \"line_three\": null,\n \"city\": \"Atlanta\",\n \"state\": \"GA\",\n \"zip\": \"30301\",\n }\n ]\n}", "name": "Successful Listing" }, { "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": 200, "body": "{\n \"data\": {\n \"id\": 1,\n \"recipient\": \"John Doe\",\n \"line_one\": \"123 Main St\",\n \"line_two\": \"Apt 4B\",\n \"line_three\": null,\n \"city\": \"Atlanta\",\n \"state\": \"GA\",\n \"zip\": \"30301\",\n }\n}", "name": "Successful Retrieval" }, { "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": 201, "body": "{\n \"data\": {\n \"id\": 1,\n \"recipient\": \"John Doe\",\n \"line_one\": \"123 Main St\",\n \"line_two\": \"Apt 4B\",\n \"line_three\": null,\n \"city\": \"Atlanta\",\n \"state\": \"GA\",\n \"zip\": \"30301\",\n }\n}", "name": "Successful Creation" }, { "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": 200, "body": "{\n \"data\": {\n \"id\": 1,\n \"recipient\": \"John Doe\",\n \"line_one\": \"123 Main St\",\n \"line_two\": \"Apt 4B\",\n \"line_three\": null,\n \"city\": \"Atlanta\",\n \"state\": \"GA\",\n \"zip\": \"30301\",\n }\n}", "name": "Address Updated Successfully" }, { "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 \"id\": 1,\n \"uuid\": \"60dac128-28da-41ae-8632-aee299de13fd\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"company_name\": \"Acme Inc.\",\n \"phone\": \"+17707892222\",\n \"email\": \"an-email@gmail.com\",\n \"addr1\": \"\",\n \"addr2\": \"\",\n \"addr3\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"USA\",\n \"last_login_at\": \"2024-08-30T13:08:19.000000Z\",\n \"last_login_ip\": \"127.0.0.1\"\n },\n {\n \"id\": 2,\n \"uuid\": \"60dac128-28da-41ae-8632-aee299de13fd\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"company_name\": \"\",\n \"phone\": \"+17707893333\",\n \"email\": \"another@gmail.com\",\n \"addr1\": \"\",\n \"addr2\": \"\",\n \"addr3\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"USA\",\n \"last_login_at\": \"2024-08-30T13:08:19.000000Z\",\n \"last_login_ip\": \"127.0.0.1\"\n }\n ],\n \"links\": {\n \"prev\": null,\n \"next\": null\n },\n \"meta\": {\n \"path\": \"http:\/\/relictum.test\/api\/customers\",\n \"per_page\": 500,\n \"next_cursor\": null,\n \"prev_cursor\": null\n }\n }", "name": "Successful Listing" }, { "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": 200, "body": "{\n \"data\":\n {\n \"uuid\": \"60dac128-28da-41ae-8632-aee299de13fd\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"phone\": \"+17707892222\",\n \"email\": \"an-email@gmail.com\",\n \"addr1\": \"\",\n \"addr2\": \"\",\n \"addr3\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"USA\"\n }\n}", "name": "Successful Show" }, { "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": 200, "body": "{\n \"data\":\n {\n \"uuid\": \"60dac128-28da-41ae-8632-aee299de13fd\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"phone\": \"+17707892222\",\n \"email\": \"an-email@gmail.com\",\n \"addr1\": \"\",\n \"addr2\": \"\",\n \"addr3\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"USA\"\n }\n}", "name": "Successful Creation" }, { "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": 200, "body": "{\n \"data\":\n {\n \"uuid\": \"60dac128-28da-41ae-8632-aee299de13fd\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"phone\": \"+17707892222\",\n \"email\": \"an-email@gmail.com\",\n \"addr1\": \"\",\n \"addr2\": \"\",\n \"addr3\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"USA\"\n }\n }", "name": "Successful Update" }, { "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" }, "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-17 02:41:04\",\n \"fund_date\": \"2023-02-17 02:41:04\",\n \"transaction_info_id\": \"789846193\",\n \"transaction_id\": \"3\",\n \"transaction_detail_account\": \"0089..9845\",\n \"authorization_amount\": \"0.7100\",\n \"net_amount\": \"0.7200\",\n \"sweep_id\": \"125068038\",\n \"type\": \"withdraw_funds\"\n }\n ]\n}", "name": "Successful Listing" }, { "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 ProPay 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 ProPay 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}", "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 ProPay 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 \"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 ProPay 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": "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": "{\n \"data\":[\n{\n \"id\": 1,\n \"type\": \"cc\",\n \"token\": \"xxxxxxxx\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"cc_name_on_card\": \"Johnny Doe\",\n \"cc_last_four\": \"1234\",\n \"cc_expiration_date\": \"01\/2027\",\n \"cc_brand\": \"Visa\",\n \"status\": \"New\",\n \"status_date\": \"2024-12-08 05:00:04\",\n \"enabled\": true,\n \"default\": true,\n \"addr1\": \"123 My Street\",\n \"addr2\": \"Suite 123\",\n \"addr3\": \"\",\n \"city\": \"Alpharetta\",\n \"state\": \"GA\",\n \"zip\": \"30009\",\n },\n\"id\": 3,\n\"type\": \"ach\",\n\"first_name\": \"John\",\n\"last_name\": \"Doe\",\n\"ach_bank_account_name\": \"My savings\",\n\"ach_routing_number\": \"12345\",\n\"ach_account_number\": \"12345\",\n\"ach_ownership_type\": Personal,\n\"ach_account_type\": \"Checking\",\n\"ach_bank_name\": Wells Fargo,\n\"status\": \"New\",\n\"status_date\": \"2025-01-01 00:00:00\",\n\"enabled\": true,\n\"default\": false,\n\"addr1\": \"\",\n\"addr2\": \"\",\n\"addr3\": null,\n\"city\": \"\",\n\"state\": \"\",\n\"zip\": \"\"\n]\n}", "name": "Successful Listing" }, { "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": "{\n \"data\": {\n \"id\": 1,\n \"type\": \"cc\",\n \"token\": \"xxxxxxxx\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"cc_name_on_card\": \"Johnny Doe\",\n \"cc_last_four\": \"1234\",\n \"cc_expiration_date\": \"01\/2027\",\n \"cc_brand\": \"Visa\",\n \"status\": \"New\",\n \"status_date\": \"2024-12-08 05:00:04\",\n \"enabled\": true,\n \"default\": true,\n \"addr1\": \"123 My Street\",\n \"addr2\": \"Suite 123\",\n \"addr3\": \"\",\n \"city\": \"Alpharetta\",\n \"state\": \"GA\",\n \"zip\": \"30009\",\n }\n}", "name": "Successful Creation" }, { "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": "{\n \"data\": {\n \"id\": 1,\n \"type\": \"cc\",\n \"token\": \"xxxxxxxx\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"cc_name_on_card\": \"Johnny Doe\",\n \"cc_last_four\": \"1234\",\n \"cc_expiration_date\": \"01\/2027\",\n \"cc_brand\": \"Visa\",\n \"status\": \"New\",\n \"status_date\": \"2024-12-08 05:00:04\",\n \"enabled\": true,\n \"default\": true,\n \"addr1\": \"123 My Street\",\n \"addr2\": \"Suite 123\",\n \"addr3\": \"\",\n \"city\": \"Alpharetta\",\n \"state\": \"GA\",\n \"zip\": \"30009\",\n }\n}", "name": "Successful Creation" }, { "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": "{\n \"data\": {\n \"id\": 1,\n \"type\": \"cc\",\n \"token\": \"xxxxxxxx\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"cc_name_on_card\": \"Johnny Doe\",\n \"cc_last_four\": \"1234\",\n \"cc_expiration_date\": \"01\/2027\",\n \"cc_brand\": \"Visa\",\n \"status\": \"New\",\n \"status_date\": \"2024-12-08 05:00:04\",\n \"enabled\": true,\n \"default\": true,\n \"addr1\": \"123 My Street\",\n \"addr2\": \"Suite 123\",\n \"addr3\": \"\",\n \"city\": \"Alpharetta\",\n \"state\": \"GA\",\n \"zip\": \"30009\",\n }\n}", "name": "Successful Update" }, { "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": "{\n\"data\": {\n\"id\": \"12345\",\n\"name\": \"A Smith\",\n\"amount\": \"1819.16\",\n\"start_date\": \"2025-04-04T04:00:00.000000Z\",\n\"end_date\": null,\n\"recurrence_schedule\": \"Monthly\",\n\"last_run_date\": \"2025-05-06T04:00:00.000000Z\",\n\"last_run_status\": \"Failed\",\n\"last_run_failed_count\": 3,\n\"next_run_date\": null,\n\"status\": \"Failed\",\n\"paused_until_date\": null,\n\"customer_uuid\": \"941d46d5-ad8e-4737-8dda-cec4a5116cde\",\n\"cancelled_at\": null,\n\"error\": \"EXPIRED CARD\",\n\"payment_method\": {\n\"id\": 22,\n\"type\": \"cc\",\n\"last_four\": \"8747\",\n\"expiration\": \"08\/2029\",\n\"zip\": \"30115\",\n\"name_on_card\": \"Kody Smith\"\n}\n}\n],\n\"links\": {\n\"prev\": null,\n\"next\": null\n},\n\"meta\": {\n\"path\": \"https:\/\/app.dimepayments.com\/api\/recurring-payment\/list\",\n\"per_page\": 500,\n\"next_cursor\": null,\n\"prev_cursor\": null\n}\n}", "name": "Successful Listing" }, { "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": "{\n\"data\": {\n\"id\": \"12345\",\n\"name\": \"A Smith\",\n\"amount\": \"1819.16\",\n\"start_date\": \"2025-04-04T04:00:00.000000Z\",\n\"end_date\": null,\n\"recurrence_schedule\": \"Monthly\",\n\"last_run_date\": \"2025-05-06T04:00:00.000000Z\",\n\"last_run_status\": \"Failed\",\n\"last_run_failed_count\": 3,\n\"next_run_date\": null,\n\"status\": \"Paused\",\n\"paused_until_date\": \"2027-05-06T04:00:00.000000Z\",\n\"customer_uuid\": \"941d46d5-ad8e-4737-8dda-cec4a5116cde\",\n\"cancelled_at\": null,\n\"error\": \"EXPIRED CARD\",\n\"payment_method\": {\n\"id\": 22,\n\"type\": \"cc\",\n\"last_four\": \"8747\",\n\"expiration\": \"08\/2029\",\n\"zip\": \"30115\",\n\"name_on_card\": \"Kody Smith\"\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],\n\"links\": {\n\"prev\": null,\n\"next\": null\n},\n\"meta\": {\n\"path\": \"https:\/\/app.dimepayments.com\/api\/recurring-payment\/list\",\n\"per_page\": 500,\n\"next_cursor\": null,\n\"prev_cursor\": null\n}\n}", "name": "Successful Pause" }, { "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": "{\n\"data\": {\n\"id\": \"12345\",\n\"name\": \"A Smith\",\n\"amount\": \"1819.1600\",\n\"start_date\": \"2025-04-04T04:00:00.000000Z\",\n\"end_date\": null,\n\"recurrence_schedule\": \"Monthly\",\n\"last_run_date\": \"2025-05-06T04:00:00.000000Z\",\n\"last_run_status\": \"Failed\",\n\"last_run_failed_count\": 3,\n\"next_run_date\": null,\n\"status\": \"Cancelled\",\n\"paused_until_date\": null,\n\"customer_uuid\": \"941d46d5-ad8e-4737-8dda-cec4a5116cde\",\n\"cancelled_at\": \"2027-05-06T04:00:00.000000Z\",\n\"error\": \"EXPIRED CARD\",\n\"payment_method\": {\n\"id\": 22,\n\"type\": \"cc\",\n\"last_four\": \"8747\",\n\"expiration\": \"08\/2029\",\n\"zip\": \"30115\",\n\"name_on_card\": \"Kody Smith\",\n \"shipping_address\": {\n \"addr1\": \"123 Main St\",\n \"addr2\": \"apt 1\",\n \"city\": \"Alpharetta\",\n \"state\": \"GA\",\n \"zip\": \"12345\"\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 Pause" }, { "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": "{\n\"data\": {\n\"id\": \"12345\",\n\"name\": \"A Smith\",\n\"amount\": \"1819.16\",\n\"start_date\": \"2025-04-04T04:00:00.000000Z\",\n\"end_date\": null,\n\"recurrence_schedule\": \"Monthly\",\n\"last_run_date\": \"2025-05-06T04:00:00.000000Z\",\n\"last_run_status\": \"Failed\",\n\"last_run_failed_count\": 3,\n\"next_run_date\": \"2027-06-06T04:00:00.000000Z\",\n\"status\": \"Active\",\n\"paused_until_date\": null,\n\"customer_uuid\": \"941d46d5-ad8e-4737-8dda-cec4a5116cde\",\n\"cancelled_at\": null,\n\"error\": \"EXPIRED CARD\",\n\"payment_method\": {\n\"id\": 22,\n\"type\": \"cc\",\n\"last_four\": \"8747\",\n\"expiration\": \"08\/2029\",\n\"zip\": \"30115\",\n\"name_on_card\": \"Kody Smith\"\n},\n \"shipping_address\": {\n \"addr1\": \"123 Main St\",\n \"addr2\": \"apt 1\",\n \"city\": \"Alpharetta\",\n \"state\": \"GA\",\n \"zip\": \"12345\"\n }\n}", "name": "Successful Pause" }, { "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": "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\",\"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": "{\n\"data\": {\n\"id\": \"12345\",\n\"name\": \"Rent\",\n\"amount\": \"1819.16\",\n\"start_date\": \"2025-04-04T04:00:00.000000Z\",\n\"end_date\": null,\n\"recurrence_schedule\": \"Monthly\",\n\"last_run_date\": \"\",\n\"last_run_status\": \"\",\n\"last_run_failed_count\": 3,\n\"next_run_date\": \"2027-06-06T04:00:00.000000Z\",\n\"status\": \"Active\",\n\"paused_until_date\": null,\n\"customer_uuid\": \"941d46d5-ad8e-4737-8dda-cec4a5116cde\",\n\"cancelled_at\": null,\n\"error\": \"\",\n\"payment_method\": {\n\"id\": 22,\n\"type\": \"cc\",\n\"last_four\": \"8247\",\n\"expiration\": \"08\/2030\",\n\"zip\": \"30111\",\n\"name_on_card\": \"John Doe\"\n}\n \"shipping_address\": {\n \"addr1\": \"123 Main St\",\n \"addr2\": \"apt 1\",\n \"city\": \"Alpharetta\",\n \"state\": \"GA\",\n \"zip\": \"12345\"\n }\n}", "name": "Successful Creation" }, { "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": "{\n\"data\": {\n\"id\": \"12345\",\n\"name\": \"A Smith\",\n\"amount\": \"1819.16\",\n\"start_date\": \"2025-04-04T04:00:00.000000Z\",\n\"end_date\": null,\n\"recurrence_schedule\": \"Monthly\",\n\"last_run_date\": \"2025-05-06T04:00:00.000000Z\",\n\"last_run_status\": \"Failed\",\n\"last_run_failed_count\": 3,\n\"next_run_date\": \"2027-06-06T04:00:00.000000Z\",\n\"status\": \"Active\",\n\"paused_until_date\": null,\n\"customer_uuid\": \"941d46d5-ad8e-4737-8dda-cec4a5116cde\",\n\"cancelled_at\": null,\n\"error\": \"EXPIRED CARD\",\n\"payment_method\": {\n\"id\": 22,\n\"type\": \"cc\",\n\"last_four\": \"8747\",\n\"expiration\": \"08\/2029\",\n\"zip\": \"30115\",\n\"name_on_card\": \"Kody Smith\"\n}\n \"shipping_address\": {\n \"addr1\": \"123 Main St\",\n \"addr2\": \"apt 1\",\n \"city\": \"Alpharetta\",\n \"state\": \"GA\",\n \"zip\": \"12345\"\n }\n}", "name": "Successful Show" }, { "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": "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": "{", "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": "{\n [\n \"amount\": \"100.00\",\n \"business\": \"Acme Inc\",\n \"transaction_date\": \"2020-10-15 12:00:00\",\n \"customer_uuid\": \"1234567890\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"customer_phone\": \"1234567890\",\n \"customer_email\": \"email@email.com\"\n ],\n [\n \"amount\": \"100.00\",\n \"business\": \"Acme Inc\",\n \"transaction_date\": \"2020-10-15 12:00:00\",\n \"customer_uuid\": \"1234567890\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"customer_phone\": \"1234567890\",\n \"customer_email\": \"email@email.com\"\n ]\n}", "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": "architecto", "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