{ "openapi": "3.1.0", "info": { "title": "stax-api", "version": "0.1" }, "servers": [ { "url": "https://apiprod.fattlabs.com/" } ], "components": { "securitySchemes": { "ApiKeyAuth": { "type": "http", "scheme": "bearer", "bearerFormat": "JWT", "description": "API key for merchant-level operations. Provides access to merchant-specific endpoints including transactions, payments, customer management, and merchant account settings. This key is scoped to a single merchant account and cannot access partner-level functionality." }, "PartnerApiKey": { "type": "http", "scheme": "bearer", "bearerFormat": "JWT", "description": "Partner-level API key with elevated privileges. Grants access to all partner operations including merchant management, portfolio oversight, reporting across multiple merchant accounts, and partner-specific administrative functions. Also provides access to all merchant-level operations for accounts under the partner's management." }, "EphemeralAuth": { "type": "http", "scheme": "bearer", "bearerFormat": "JWT", "description": "Temporary authentication token with limited lifespan. Used for short-term access to specific operations, typically generated for secure one-time actions or time-bounded sessions. Automatically expires after a predefined period for enhanced security." } } }, "security": [ { "ApiKeyAuth": [] } ], "paths": { "/query/statement/v3/ach-rejects": { "get": { "summary": "ACH Rejections", "description": "", "operationId": "ach-rejections", "parameters": [ { "name": "startDate", "in": "query", "required": true, "description": "YYYY-MM-DD", "schema": { "type": "string", "default": "" } }, { "name": "endDate", "in": "query", "required": true, "description": "YYYY-MM-DD", "schema": { "type": "string", "default": "" } } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"data\": [\n {\n \"ach_reject_transaction_id\": \"redacted-transaction-id\",\n \"ach_reject_transaction_created_at\": \"2024-08-23T18:39:39.000Z\",\n \"ach_reject_transaction_amount\": 861.8,\n \"ach_reject_transaction_timing\": \"post_payout\",\n \"original_transaction_id\": \"redacted-original-transaction-id\",\n \"original_transaction_created_at\": \"2024-08-19T16:48:26.000Z\",\n \"original_transaction_amount\": 861.8,\n \"deposit_id\": null,\n \"ach_reject_fee_id\": \"redacted-fee-id\",\n \"ach_reject_fee_amount\": 15,\n \"ach_reject_fee_deducted_at\": \"2024-08-23T11:00:58.000Z\"\n }\n ],\n \"summary\": {\n \"ach_reject_transaction_count\": 1,\n \"ach_reject_transaction_amount\": 861.8,\n \"original_transaction_amount\": 861.8,\n \"ach_reject_fee_amount\": 15\n },\n \"total\": 1,\n \"per_page\": 1000,\n \"current_page\": 1,\n \"last_page\": 1,\n \"next_page_url\": null,\n \"prev_page_url\": null,\n \"from\": 1,\n \"to\": 1\n}" } }, "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "ach_reject_transaction_id": { "type": "string", "example": "redacted-transaction-id" }, "ach_reject_transaction_created_at": { "type": "string", "example": "2024-08-23T18:39:39.000Z" }, "ach_reject_transaction_amount": { "type": "number", "example": 861.8, "default": 0 }, "ach_reject_transaction_timing": { "type": "string", "example": "post_payout" }, "original_transaction_id": { "type": "string", "example": "redacted-original-transaction-id" }, "original_transaction_created_at": { "type": "string", "example": "2024-08-19T16:48:26.000Z" }, "original_transaction_amount": { "type": "number", "example": 861.8, "default": 0 }, "deposit_id": {}, "ach_reject_fee_id": { "type": "string", "example": "redacted-fee-id" }, "ach_reject_fee_amount": { "type": "integer", "example": 15, "default": 0 }, "ach_reject_fee_deducted_at": { "type": "string", "example": "2024-08-23T11:00:58.000Z" } } } }, "summary": { "type": "object", "properties": { "ach_reject_transaction_count": { "type": "integer", "example": 1, "default": 0 }, "ach_reject_transaction_amount": { "type": "number", "example": 861.8, "default": 0 }, "original_transaction_amount": { "type": "number", "example": 861.8, "default": 0 }, "ach_reject_fee_amount": { "type": "integer", "example": 15, "default": 0 } } }, "total": { "type": "integer", "example": 1, "default": 0 }, "per_page": { "type": "integer", "example": 1000, "default": 0 }, "current_page": { "type": "integer", "example": 1, "default": 0 }, "last_page": { "type": "integer", "example": 1, "default": 0 }, "next_page_url": {}, "prev_page_url": {}, "from": { "type": "integer", "example": 1, "default": 0 }, "to": { "type": "integer", "example": 1, "default": 0 } } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "{}" } }, "schema": { "type": "object", "properties": {} } } } } }, "deprecated": false } }, "/file": { "post": { "description": "", "operationId": "post_file", "responses": { "200": { "description": "", "content": { "application/json": { "examples": { "OK": { "summary": "OK", "value": { "merchant_id": "55394e80-826a-4e04-bafa-2e2d615209cf", "user_id": "0dcb6380-962a-4b9d-b318-81e5625d0316", "name": "Test Energy Drink Image", "tag": "generic", "id": "497da262-d9b3-4d24-920f-25c9c27522b4", "updated_at": "2025-11-20 20:46:05", "created_at": "2025-11-20 20:46:05", "public_url": "https://fattpaydocuments.s3.us-west-2.amazonaws.com/generic/497da262-d9b3-4d24-920f-25c9c27522b4.jpg", "meta": { "filesize_bytes": 7384, "filesize": "7.38 kB", "extension": "jpg", "size": { "width": 225, "height": 225 }, "mime": "image/jpeg" } } } } } } } }, "parameters": [], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "name": { "type": "string", "description": "The name for the file." }, "tag": { "type": "string", "description": "Description to classify the file type (e.g., generic, product-image)." }, "file": { "type": "string", "format": "binary", "description": "The pathway to the file being uploaded." } }, "required": [ "name", "tag", "file" ] }, "examples": { "New Example": { "summary": "New Example", "value": "curl --location 'https://apiprod.fattlabs.com/file' \\\n--header 'Accept: application/json' \\\n--header 'Content-Type: application/json' \\\n--header 'Authorization: Bearer \u2018ey\u2026\u2019 \\\n--form 'name=\"Test Energy Drink Image\"' \\\n--form 'tag=\"generic\"' \\\n--form 'file=@\"/Users/testuser/Downloads/energydrink.jpeg\"'}" } } } } } }, "get": { "description": "", "operationId": "get_file", "responses": { "200": { "description": "", "content": { "application/json": { "examples": { "OK": { "summary": "OK", "value": { "current_page": 1, "data": [ { "id": "a66bcfb0-8a41-4ef9-99b3-15fe1846bd36", "merchant_id": "55394e80-826a-4e04-bafa-2e2d615209cf", "user_id": "5aec6f90-69be-48a5-a419-44ff016f364a", "name": "Screenshot 2025-11-20 at 2.06.58\u202fPM.png", "public_url": "https://fattpaydocuments.s3.us-west-2.amazonaws.com/a66bcfb0-8a41-4ef9-99b3-15fe1846bd36.png", "tag": null, "meta": { "filesize_bytes": 139295, "filesize": "139.3 kB", "extension": "png", "size": { "width": 446, "height": 496 }, "mime": "image/png" }, "created_at": "2025-12-01 19:00:08", "updated_at": "2025-12-01 19:00:08", "deleted_at": null }, { "id": "864ab716-6277-40d8-aed5-271ff878296d", "merchant_id": "55394e80-826a-4e04-bafa-2e2d615209cf", "user_id": "5aec6f90-69be-48a5-a419-44ff016f364a", "name": "", "public_url": "https://fattpaydocuments.s3.us-west-2.amazonaws.com/itemThumbnail/864ab716-6277-40d8-aed5-271ff878296d.png", "tag": "itemThumbnail", "meta": { "filesize_bytes": 45272, "filesize": "45.27 kB", "extension": "png", "size": { "width": 222, "height": 223 }, "mime": "image/png" }, "created_at": "2025-11-20 21:04:34", "updated_at": "2025-11-20 21:04:34", "deleted_at": null }, { "id": "497da262-d9b3-4d24-920f-25c9c27522b4", "merchant_id": "55394e80-826a-4e04-bafa-2e2d615209cf", "user_id": "0dcb6380-962a-4b9d-b318-81e5625d0316", "name": "Test Energy Drink Image", "public_url": "https://fattpaydocuments.s3.us-west-2.amazonaws.com/generic/497da262-d9b3-4d24-920f-25c9c27522b4.jpg", "tag": "generic", "meta": { "filesize_bytes": 7384, "filesize": "7.38 kB", "extension": "jpg", "size": { "width": 225, "height": 225 }, "mime": "image/jpeg" }, "created_at": "2025-11-20 20:46:05", "updated_at": "2025-11-20 20:46:05", "deleted_at": null } ], "first_page_url": "http://apiprod.fattlabs.com/file?page=1", "from": 1, "last_page": 1, "last_page_url": "http://apiprod.fattlabs.com/file?page=1", "links": [ { "url": null, "label": "« Previous", "active": false }, { "url": "http://apiprod.fattlabs.com/file?page=1", "label": "1", "active": true }, { "url": null, "label": "Next »", "active": false } ], "next_page_url": null, "path": "http://apiprod.fattlabs.com/file", "per_page": 20, "prev_page_url": null, "to": 3, "total": 3 } } } } } } }, "parameters": [] } }, "/merchant/{id}/registration/file": { "post": { "summary": "Add File to Merchant Registration", "description": "Uploads a file to a merchant's registration.", "operationId": "add-file-to-merchant-registration", "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true, "description": "ID of the merchant." } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "name", "file" ], "properties": { "name": { "type": "string", "description": "The name of the file." }, "file": { "type": "string", "description": "The file itself.", "format": "binary" }, "registration_document_id": { "type": "string", "description": "Associates the file with a specific registration document." } } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"annual_volume\": \"\",\n \"avg_trans_size\": \"\",\n \"b2b_percent\": \"\",\n \"bank_account_type\": \"\",\n \"business_address_1\": \"\",\n \"business_address_2\": \"\",\n \"business_address_city\": \"\",\n \"business_address_country\": \"\",\n \"business_address_state\": \"\",\n \"business_address_zip\": \"\",\n \"business_dba\": \"\",\n \"business_email\": \"\",\n \"business_fax\": \"\",\n \"business_legal_name\": \"\",\n \"business_open_date\": \"\",\n \"business_phone_number\": \"\",\n \"business_tax_id\": \"\",\n \"business_website\": \"\",\n \"card_not_present_percent\": \"\",\n \"card_present_percent\": \"\",\n \"card_swiped_percent\": \"\",\n \"chosen_plan\": \"\",\n \"chosen_processing_method\": \"\",\n \"company_type\": \"\",\n \"email\": \"\",\n \"first_name\": \"\",\n \"highest_trans_amount\": \"\",\n \"international\": \"\",\n \"internet\": \"\",\n \"job_title\": \"\",\n \"last_name\": \"\",\n \"location_type\": \"\",\n \"meta\": {\n \"ownership_percentage\": 60,\n \"owner_citizenship\": \"ALA\",\n \"representatives\": [\n {\n \"title\": \"\",\n \"date_of_birth\": \"\",\n \"ssn\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"type\": \"\",\n \"ownership_percentage\": 40,\n \"email\": \"\",\n \"phone\": \"\",\n \"address_1\": \"\",\n \"address_2\": \"\",\n \"address_city\": \"\",\n \"address_state\": \"\",\n \"address_zip\": \"\",\n \"citizenship\": \"ALA\"\n }\n ]\n },\n \"moto_percent\": \"\",\n \"network\": \"\",\n \"owner_address_1\": \"\",\n \"owner_address_2\": \"\",\n \"owner_address_city\": \"\",\n \"owner_address_country\": \"\",\n \"owner_address_state\": \"\",\n \"owner_address_zip\": \"\",\n \"phone_number\": \"\",\n \"plan\": \"\",\n \"principal_owners_name\": \"\",\n \"reason_for_applying\": \"\",\n \"referred_by\": \"\",\n \"refund_policy\": \"\",\n \"seasonal_flag\": false,\n \"seasonal_months\": \"\",\n \"service_you_provide\": \"\",\n \"title\": \"\",\n \"user_dob\": \"\",\n \"merchant_id\": \"791fc3fa-4534-4617-97b6-d41c9e1ce8da\",\n \"user_id\": \"a01a5f74-cbdb-4704-9e9b-56fd5a8ee7b8\",\n \"updated_at\": \"2019-06-19 21:22:03\",\n \"created_at\": \"2019-06-19 21:22:03\",\n \"files\": [\n {\n \"id\": \"69ad5457-c027-4057-ad52-05ef0e39ec39\",\n \"merchant_id\": \"866ccc18-315e-496d-8a49-f16a5da79b75\",\n \"user_id\": \"8f5f7d73-d53c-47c6-8880-6da0de8d9a10\",\n \"name\": \"voidcheck\",\n \"path\": \"onboarding/69ad5457-c027-4057-ad52-05ef0e39ec39.png\",\n \"public_url\": \"https://fattonboardingfiles.s3.us-west-2.amazonaws.com/onboarding/69ad5457-c027-4057-ad52-05ef0e39ec39.png\",\n \"tag\": \"onboarding\",\n \"meta\": {\n \"filesize_bytes\": 2631,\n \"filesize\": \"0.03 kB\",\n \"extension\": \"png\",\n \"size\": {\n \"width\": 225,\n \"height\": 225\n },\n \"mime\": \"image/png\"\n },\n \"created_at\": \"2020-01-16 18:35:03\",\n \"updated_at\": \"2020-01-16 18:35:04\",\n \"deleted_at\": null,\n \"registration_document_id\": \"RD11eb3bbd85936820828f2b181cd9c9d0\"\n }\n ],\n \"electronic_signature\": {\n \"html_content\": \"I agree to...\",\n \"ip\": \"42.1.1.113\",\n \"timestamp\": \"2019-06-19 21:22:03\",\n \"user_id\": \"a01a5f74-cbdb-4704-9e9b-56fd5a8ee7b8\",\n \"email\": \"john@doe.com\",\n \"browser_agent\": \"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_6) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/79.0.3945.88 Safari/537.36\"\n }\n}" } }, "schema": { "type": "object", "properties": { "annual_volume": { "type": "string", "example": "" }, "avg_trans_size": { "type": "string", "example": "" }, "b2b_percent": { "type": "string", "example": "" }, "bank_account_type": { "type": "string", "example": "" }, "business_address_1": { "type": "string", "example": "" }, "business_address_2": { "type": "string", "example": "" }, "business_address_city": { "type": "string", "example": "" }, "business_address_country": { "type": "string", "example": "" }, "business_address_state": { "type": "string", "example": "" }, "business_address_zip": { "type": "string", "example": "" }, "business_dba": { "type": "string", "example": "" }, "business_email": { "type": "string", "example": "" }, "business_fax": { "type": "string", "example": "" }, "business_legal_name": { "type": "string", "example": "" }, "business_open_date": { "type": "string", "example": "" }, "business_phone_number": { "type": "string", "example": "" }, "business_tax_id": { "type": "string", "example": "" }, "business_website": { "type": "string", "example": "" }, "card_not_present_percent": { "type": "string", "example": "" }, "card_present_percent": { "type": "string", "example": "" }, "card_swiped_percent": { "type": "string", "example": "" }, "chosen_plan": { "type": "string", "example": "" }, "chosen_processing_method": { "type": "string", "example": "" }, "company_type": { "type": "string", "example": "" }, "email": { "type": "string", "example": "" }, "first_name": { "type": "string", "example": "" }, "highest_trans_amount": { "type": "string", "example": "" }, "international": { "type": "string", "example": "" }, "internet": { "type": "string", "example": "" }, "job_title": { "type": "string", "example": "" }, "last_name": { "type": "string", "example": "" }, "location_type": { "type": "string", "example": "" }, "meta": { "type": "object", "properties": { "ownership_percentage": { "type": "integer", "example": 60, "default": 0 }, "owner_citizenship": { "type": "string", "example": "ALA" }, "representatives": { "type": "array", "items": { "type": "object", "properties": { "title": { "type": "string", "example": "" }, "date_of_birth": { "type": "string", "example": "" }, "ssn": { "type": "string", "example": "" }, "first_name": { "type": "string", "example": "" }, "last_name": { "type": "string", "example": "" }, "type": { "type": "string", "example": "" }, "ownership_percentage": { "type": "integer", "example": 40, "default": 0 }, "email": { "type": "string", "example": "" }, "phone": { "type": "string", "example": "" }, "address_1": { "type": "string", "example": "" }, "address_2": { "type": "string", "example": "" }, "address_city": { "type": "string", "example": "" }, "address_state": { "type": "string", "example": "" }, "address_zip": { "type": "string", "example": "" }, "citizenship": { "type": "string", "example": "ALA" } } } } } }, "moto_percent": { "type": "string", "example": "" }, "network": { "type": "string", "example": "" }, "owner_address_1": { "type": "string", "example": "" }, "owner_address_2": { "type": "string", "example": "" }, "owner_address_city": { "type": "string", "example": "" }, "owner_address_country": { "type": "string", "example": "" }, "owner_address_state": { "type": "string", "example": "" }, "owner_address_zip": { "type": "string", "example": "" }, "phone_number": { "type": "string", "example": "" }, "plan": { "type": "string", "example": "" }, "principal_owners_name": { "type": "string", "example": "" }, "reason_for_applying": { "type": "string", "example": "" }, "referred_by": { "type": "string", "example": "" }, "refund_policy": { "type": "string", "example": "" }, "seasonal_flag": { "type": "boolean", "example": false, "default": true }, "seasonal_months": { "type": "string", "example": "" }, "service_you_provide": { "type": "string", "example": "" }, "title": { "type": "string", "example": "" }, "user_dob": { "type": "string", "example": "" }, "merchant_id": { "type": "string", "example": "791fc3fa-4534-4617-97b6-d41c9e1ce8da" }, "user_id": { "type": "string", "example": "a01a5f74-cbdb-4704-9e9b-56fd5a8ee7b8" }, "updated_at": { "type": "string", "example": "2019-06-19 21:22:03" }, "created_at": { "type": "string", "example": "2019-06-19 21:22:03" }, "files": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "69ad5457-c027-4057-ad52-05ef0e39ec39" }, "merchant_id": { "type": "string", "example": "866ccc18-315e-496d-8a49-f16a5da79b75" }, "user_id": { "type": "string", "example": "8f5f7d73-d53c-47c6-8880-6da0de8d9a10" }, "name": { "type": "string", "example": "voidcheck" }, "path": { "type": "string", "example": "onboarding/69ad5457-c027-4057-ad52-05ef0e39ec39.png" }, "public_url": { "type": "string", "example": "https://fattonboardingfiles.s3.us-west-2.amazonaws.com/onboarding/69ad5457-c027-4057-ad52-05ef0e39ec39.png" }, "tag": { "type": "string", "example": "onboarding" }, "meta": { "type": "object", "properties": { "filesize_bytes": { "type": "integer", "example": 2631, "default": 0 }, "filesize": { "type": "string", "example": "0.03 kB" }, "extension": { "type": "string", "example": "png" }, "size": { "type": "object", "properties": { "width": { "type": "integer", "example": 225, "default": 0 }, "height": { "type": "integer", "example": 225, "default": 0 } } }, "mime": { "type": "string", "example": "image/png" } } }, "created_at": { "type": "string", "example": "2020-01-16 18:35:03" }, "updated_at": { "type": "string", "example": "2020-01-16 18:35:04" }, "deleted_at": {}, "registration_document_id": { "type": "string", "example": "RD11eb3bbd85936820828f2b181cd9c9d0" } } } }, "electronic_signature": { "type": "object", "properties": { "html_content": { "type": "string", "example": "I agree to..." }, "ip": { "type": "string", "example": "42.1.1.113" }, "timestamp": { "type": "string", "example": "2019-06-19 21:22:03" }, "user_id": { "type": "string", "example": "a01a5f74-cbdb-4704-9e9b-56fd5a8ee7b8" }, "email": { "type": "string", "example": "john@doe.com" }, "browser_agent": { "type": "string", "example": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_6) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/79.0.3945.88 Safari/537.36" } } } } } } } }, "422": { "description": "422", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"file\": [\n \"The file field is required.\"\n ]\n}" } }, "schema": { "type": "object", "properties": { "file": { "type": "array", "items": { "type": "string", "example": "The file field is required." } } } } } } } }, "deprecated": false, "security": [ { "PartnerApiKey": [] } ] } }, "/team/options": { "put": { "summary": "Add/Update Team Settings", "description": "Adds team/merchant options, also known as team settings, to a team", "operationId": "addupdate-team-settings", "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"id\": \"aa7766b2-242f-43b9-9476-3c9018f0ce52\",\n \"mid\": \"\",\n \"status\": \"PENDING\",\n \"subdomain\": \"\",\n \"company_name\": \"Stax\",\n \"contact_name\": \"Stax\",\n \"contact_email\": \"contact@example.com\",\n \"contact_phone\": \"8555503288\",\n \"address_1\": \"25 Wall Street\",\n \"address_2\": \"Suite 1\",\n \"address_city\": \"Orlando\",\n \"address_state\": \"FL\",\n \"address_zip\": \"32801\",\n \"hosted_payments_token\": \"BARTLE-_\",\n \"currency\": [\n \"USD\"\n ],\n \"plan\": {\n \"id\": \"f92fee2b-fdae-4474-988c-c8f2df92772a\",\n \"merchant_id\": \"aa7766b2-242f-43b9-9476-3c9018f0ce52\",\n \"user_id\": \"b58d7eee-e68d-4d12-a1f8-62f5e71382ae\",\n \"name\": null,\n \"created_at\": \"2017-05-15 18:41:25\",\n \"updated_at\": \"2017-05-15 18:41:25\"\n },\n \"options\": {\n \"hosted_payments_url_long\": \"http://localhost.app:5477/#/pay/BARTLE-_\",\n \"hosted_payments_url_short\": \"http://bit.ly/1RofD0T\",\n \"hosted_payments_success_note\": \"Success Note\",\n \"hosted_payments_note\": \"Page Memo\",\n \"webpayment_customer_matching_enabled\": false\n },\n \"gateway_type\": null,\n \"processor\": \"\",\n \"product_type\": \"\",\n \"welcome_email_sent_at\": null,\n \"created_at\": \"2017-05-15 17:02:37\",\n \"updated_at\": \"2017-05-15 21:52:16\",\n \"deleted_at\": null,\n \"gateway_name\": null,\n \"branding\": {\n \"id\": \"81218dbb-74ad-480e-958e-839ced6e6962\",\n \"merchant_id\": \"aa7766b2-242f-43b9-9476-3c9018f0ce52\",\n \"user_id\": \"b58d7eee-e68d-4d12-a1f8-62f5e71382ae\",\n \"name\": \"Bugu the Catu\",\n \"public_url\": \"https://s3-us-west-2.amazonaws.com/fattpaydocuments/branding/81218dbb-74ad-480e-958e-839ced6e6962.png\",\n \"tag\": \"branding\",\n \"meta\": {\n \"filesize_bytes\": 109524,\n \"filesize\": \"1.1 kB\",\n \"extension\": \"png\",\n \"size\": {\n \"width\": 537,\n \"height\": 512\n },\n \"mime\": \"image/png\"\n },\n \"created_at\": \"2017-05-15 19:15:53\",\n \"updated_at\": \"2017-05-15 19:15:56\",\n \"deleted_at\": null\n },\n \"allow_ach\": false\n}" } }, "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "aa7766b2-242f-43b9-9476-3c9018f0ce52" }, "mid": { "type": "string", "example": "" }, "status": { "type": "string", "example": "PENDING" }, "subdomain": { "type": "string", "example": "" }, "company_name": { "type": "string", "example": "Stax" }, "contact_name": { "type": "string", "example": "Stax" }, "contact_email": { "type": "string", "example": "contact@example.com" }, "contact_phone": { "type": "string", "example": "8555503288" }, "address_1": { "type": "string", "example": "25 Wall Street" }, "address_2": { "type": "string", "example": "Suite 1" }, "address_city": { "type": "string", "example": "Orlando" }, "address_state": { "type": "string", "example": "FL" }, "address_zip": { "type": "string", "example": "32801" }, "hosted_payments_token": { "type": "string", "example": "BARTLE-_" }, "currency": { "type": "array", "items": { "type": "string", "example": "USD" } }, "plan": { "type": "object", "properties": { "id": { "type": "string", "example": "f92fee2b-fdae-4474-988c-c8f2df92772a" }, "merchant_id": { "type": "string", "example": "aa7766b2-242f-43b9-9476-3c9018f0ce52" }, "user_id": { "type": "string", "example": "b58d7eee-e68d-4d12-a1f8-62f5e71382ae" }, "name": {}, "created_at": { "type": "string", "example": "2017-05-15 18:41:25" }, "updated_at": { "type": "string", "example": "2017-05-15 18:41:25" } } }, "options": { "type": "object", "properties": { "hosted_payments_url_long": { "type": "string", "example": "http://localhost.app:5477/#/pay/BARTLE-_" }, "hosted_payments_url_short": { "type": "string", "example": "http://bit.ly/1RofD0T" }, "hosted_payments_success_note": { "type": "string", "example": "Success Note" }, "hosted_payments_note": { "type": "string", "example": "Page Memo" }, "webpayment_customer_matching_enabled": { "type": "boolean", "example": false, "default": true } } }, "gateway_type": {}, "processor": { "type": "string", "example": "" }, "product_type": { "type": "string", "example": "" }, "welcome_email_sent_at": {}, "created_at": { "type": "string", "example": "2017-05-15 17:02:37" }, "updated_at": { "type": "string", "example": "2017-05-15 21:52:16" }, "deleted_at": {}, "gateway_name": {}, "branding": { "type": "object", "properties": { "id": { "type": "string", "example": "81218dbb-74ad-480e-958e-839ced6e6962" }, "merchant_id": { "type": "string", "example": "aa7766b2-242f-43b9-9476-3c9018f0ce52" }, "user_id": { "type": "string", "example": "b58d7eee-e68d-4d12-a1f8-62f5e71382ae" }, "name": { "type": "string", "example": "Bugu the Catu" }, "public_url": { "type": "string", "example": "https://s3-us-west-2.amazonaws.com/fattpaydocuments/branding/81218dbb-74ad-480e-958e-839ced6e6962.png" }, "tag": { "type": "string", "example": "branding" }, "meta": { "type": "object", "properties": { "filesize_bytes": { "type": "integer", "example": 109524, "default": 0 }, "filesize": { "type": "string", "example": "1.1 kB" }, "extension": { "type": "string", "example": "png" }, "size": { "type": "object", "properties": { "width": { "type": "integer", "example": 537, "default": 0 }, "height": { "type": "integer", "example": 512, "default": 0 } } }, "mime": { "type": "string", "example": "image/png" } } }, "created_at": { "type": "string", "example": "2017-05-15 19:15:53" }, "updated_at": { "type": "string", "example": "2017-05-15 19:15:56" }, "deleted_at": { "type": "string", "format": "date-time" } } }, "allow_ach": { "type": "boolean", "example": false, "default": true } } } } } } }, "deprecated": false } }, "/team/option/advanced_customizations": { "put": { "description": "", "operationId": "post_teamoptionadvanced_customizations", "responses": { "200": { "description": "", "content": { "application/json": { "examples": { "OK": { "summary": "OK", "value": { "id": "{merchant_id}", "mid": "{processor_merchant_id}", "status": "ACTIVE", "subdomain": "{merchant_subdomain}", "company_name": "{company_name}", "display_name": "{display_name}", "contact_name": "{contact_name}", "contact_email": "{contact_email}", "contact_phone": "{contact_phone}", "address_1": "{address_line_1}", "address_2": "{address_line_2}", "address_city": "{city}", "address_state": "{state}", "address_zip": "{zip_code}", "hosted_payments_token": "{webpayments_token}", "plan": { "id": "{plan_id}", "merchant_id": "{merchant_id}", "user_id": "{user_id}", "name": null, "created_at": "{timestamp}", "updated_at": "{timestamp}" }, "options": { "receipts_emails": [ "{receipt_email}" ], "merchant_copy_email_receipt_options": { "notify_options_all": true }, "webpayment_button_color": "{hex_color}", "webpayment_redirect_link": "{redirect_url}", "advanced_customization": { "hosted_custom_fields": [ { "placeholder": "{field_placeholder}", "required": true, "visible": true, "id": "{field_id}", "name": "{field_name}", "type": "text" } ] } }, "currency": [ "USD" ], "gateway_type": "ACH", "processor": "{processor_name}", "partner": null, "product_type": "{product_type}", "is_enterprise": false, "is_payfac": false, "is_sandbox": false, "is_test_mode": 0, "fm_billing_schedule_id": null, "fee_reconciliation_payment_method_id": null, "welcome_email_sent_at": null, "activated_at": null, "created_at": "{timestamp}", "updated_at": "{timestamp}", "deleted_at": null, "brand": "{brand_name}", "risk_hold": false, "merchant_processor_application": "iso", "reference": null, "branding": null, "allow_ach": true, "allow_paypal": true, "require_address": false, "is_portal": false, "is_flat_rate": false, "allow_credits": true, "allow_terminal": false, "gateways": [ { "name": "{gateway_name}", "type": "{gateway_type}", "processor_mid": "{processor_mid}" } ], "is_surcharge_enabled": false, "cnp_credit_surcharge_rate": null, "is_trust": false, "underwriting_status": null, "underwriting_substatuses": null, "allow_cnp_digital_wallet": false, "registration": { "merchant_id": "{merchant_id}", "user_id": "{user_id}", "electronic_signature": { "ip": "{ip_address}", "email": "{signer_email}", "user_id": "{user_id}", "timestamp": "{timestamp}", "browser_agent": "{user_agent}", "signed_terms_and_conditions": "{terms_url}" }, "credit_inquiry_electronic_signature": null, "application_agreed_at": "{timestamp}", "countersigned_at": "{timestamp}", "signature_status": "SIGNED", "application_status": null, "underwriting_status": null, "underwriting_substatuses": null, "underwriting_note": null, "meta": { "ownership_percentage": "{percentage}", "owner_citizenship": "{country}", "representatives": [] }, "first_name": "{first_name}", "last_name": "{last_name}", "email": "{email}", "title": "{job_title}", "company_type": "{entity_type}", "entity_ownership_type": "PRIVATE", "phone_number": "{phone}", "source": null, "promo_code": null, "ref_code": null, "plan": "{plan_name}", "fm_pc_name": null, "business_legal_name": "{legal_name}", "business_dba": "{dba_name}", "business_website": "{website_url}", "business_fax": null, "business_email": null, "business_address_1": "{business_address_line_1}", "business_address_2": null, "business_address_city": "{city}", "business_address_state": "{state}", "business_address_zip": "{zip}", "business_address_country": "{country}", "owner_address_1": "{owner_address_line_1}", "owner_address_2": "{owner_address_line_2}", "owner_address_city": "{city}", "owner_address_state": "{state}", "owner_address_zip": "{zip}", "owner_address_country": "{country}", "user_ip": "{ip_address}", "user_ssn": "{ssn}", "user_dob": "{date_of_birth}", "business_phone_number": "{phone}", "business_tax_id": "{ein}", "business_open_date": "{date}", "job_title": "{job_title}", "refund_policy": "{refund_policy_code}", "reason_for_applying": "{reason}", "service_you_provide": "{mcc_description}", "annual_volume": "{amount}", "avg_trans_size": "{amount}", "highest_trans_amount": "{amount}", "card_present_percent": "{percentage}", "card_not_present_percent": "{percentage}", "card_swiped_percent": null, "moto_percent": null, "b2b_percent": "{percentage}", "bank_routing_number": "{routing_number}", "bank_account_number": "{account_number}", "bank_account_owner_name": "{account_owner}", "secondary_bank_routing_number": null, "secondary_bank_account_number": null, "secondary_bank_account_owner_name": null, "secondary_bank_account_type": null, "secondary_bank_account_purpose": null, "principal_owners_name": "{owner_name}", "chosen_plan": null, "chosen_processing_method": "{processing_method}", "plan_txamnt": "{transaction_fee}", "plan_dcamnt": "{discount_rate}", "plan_ach_cap": "{ach_cap}", "plan_ach_txamnt": "{ach_transaction_fee}", "plan_ach_dcamnt": "{ach_discount_rate}", "plan_nabu": null, "referred_by": null, "created_at": "{timestamp}", "updated_at": "{timestamp}", "deleted_at": null, "paper_statement": false, "num_of_locs": "{number}", "addl_loc": false, "addl_loc_main_mid": "{mid}", "internet": "{percentage}", "international": "{percentage}", "mcc": "{mcc_code}", "proc_change": "{processor_change_reason}", "seasonal_flag": false, "seasonal_months": "{months}", "bus_type": "{business_type_code}", "sub_bus_type": "{sub_business_type}", "special_proc": "{special_processing}", "pos_software_publisher": "{publisher}", "pos_software_name": "{software_name}", "pos_software_version": "{version}", "site_inspection": "{inspection_status}", "location_type": "{location_type}", "network": "{network}", "bank_account_type": "{account_type}", "mcc_addl_desc": "{description}", "business_location_address_1": "{location_address_line_1}", "business_location_address_2": null, "business_location_address_city": "{city}", "business_location_address_country": "{country}", "business_location_address_state": "{state}", "business_location_address_zip": "{zip}", "business_location_email": null, "business_location_fax": null, "business_location_phone_number": "{phone}", "note": null, "credit_qual_disc_rate": "{rate}", "credit_qual_trans_fee": "{fee}", "credit_mid_disc_rate": "{rate}", "credit_mid_trans_fee": "{fee}", "credit_non_disc_rate": "{rate}", "credit_non_trans_fee": "{fee}", "amex_qual_disc_rate": "{rate}", "amex_qual_trans_fee": "{fee}", "amex_mid_disc_rate": "{rate}", "amex_mid_trans_fee": "{fee}", "amex_non_disc_rate": "{rate}", "amex_non_trans_fee": "{fee}", "is_flat_rate": false, "pricing_plan": "{pricing_plan_name}", "finix_merchant_id": null, "finix_identity_id": null, "annual_gross_ach_revenue": "{amount}", "avg_ach_transaction": "{amount}", "largest_ach_transaction": "{amount}", "cp_transaction_rate": "{rate}", "cp_per_item_rate": "{fee}", "cp_amex_rate": "{rate}", "cp_amex_per_item_rate": "{fee}", "warnings": [], "merchant_autoverification_authorization": { "ip": "{ip_address}", "email": "{email}", "user_id": "{user_id}", "timestamp": "{timestamp}", "browser_agent": "{user_agent}" }, "chargeback_percent": null, "annual_gross_shopping_cart_revenue": "{amount}", "avg_shopping_cart_transaction": "{amount}", "largest_shopping_cart_transaction": "{amount}", "shopping_cart_card_present_percent": "{percentage}", "shopping_cart_b2b_percent": "{percentage}", "shopping_cart_international": "{percentage}", "cp_credit_surcharge_rate": null, "cnp_credit_surcharge_rate": null, "cp_debit_trans_fee": null, "cnp_debit_trans_fee": null, "cp_debit_discount_rate": null, "cnp_debit_discount_rate": null, "field_permissions": null, "drivers_license_id": "{license_number}", "drivers_license_state": "{state}", "bank_institution_name": null, "external_company_id": null, "secondary_bank_institution_name": null, "registration_source": "{source}", "created_by": "{user_id}", "meta_json": "{json_string}", "signature_request_id": null, "is_trust": null, "monthly_minimum_fee": null, "monthly_service_fee": null, "fees": null, "pci_compromise_type": null, "paypal_transaction_fee": null, "paypal_per_item_fee": null, "amex_direct_number": null, "amex_annual_volume": null, "surcharge_merchant_fee": null, "files": [], "brand": "{brand_name}", "underwriting_substatus": null, "empty_required_fields": [], "latest_file_uploaded_at": null, "allow_conditional_approval": true, "merchant": { "id": "{merchant_id}", "mid": "{processor_merchant_id}", "status": "ACTIVE", "subdomain": "{subdomain}", "company_name": "{company_name}", "display_name": "{display_name}", "contact_name": "{contact_name}", "contact_email": "{contact_email}", "contact_phone": "{contact_phone}", "address_1": "{address_line_1}", "address_2": "{address_line_2}", "address_city": "{city}", "address_state": "{state}", "address_zip": "{zip}", "hosted_payments_token": "{webpayments_token}", "plan": { "id": "{plan_id}", "merchant_id": "{merchant_id}", "user_id": "{user_id}", "name": null, "created_at": "{timestamp}", "updated_at": "{timestamp}" }, "options": { "receipts_emails": [ "{receipt_email}" ], "merchant_copy_email_receipt_options": { "notify_options_all": true }, "webpayment_button_color": "{hex_color}", "webpayment_redirect_link": "{redirect_url}", "advanced_customization": { "hosted_custom_fields": [ { "placeholder": "{placeholder}", "required": true, "visible": true, "id": "{field_id}", "name": "{field_name}", "type": "text" } ] } }, "notes": "{notes}", "currency": [ "USD" ], "gateway_type": "{gateway_type}", "vendor_keys": null, "processor": "{processor_name}", "partner": null, "product_type": "{product_type}", "is_enterprise": false, "is_payfac": false, "is_sandbox": false, "is_test_mode": 0, "fm_billing_schedule_id": null, "fee_reconciliation_payment_method_id": null, "welcome_email_sent_at": null, "activated_at": null, "created_at": "{timestamp}", "updated_at": "{timestamp}", "deleted_at": null, "brand": "{brand_name}", "risk_hold": false, "merchant_processor_application": "iso", "reference": null, "branding": null, "allow_ach": true, "allow_paypal": true, "require_address": false, "is_portal": false, "is_flat_rate": false, "allow_credits": true, "allow_terminal": false, "gateways": [ { "name": "{gateway_name}", "type": "{gateway_type}", "processor_mid": "{processor_mid}" } ], "is_surcharge_enabled": false, "cnp_credit_surcharge_rate": null, "is_trust": false, "underwriting_status": null, "underwriting_substatuses": null, "allow_cnp_digital_wallet": false } } } } } } } } }, "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "visible": { "type": "boolean" }, "type": { "type": "string", "enum": [ "select", "text" ] }, "option": { "type": "object", "properties": { "name": { "type": "string", "description": "nullable, max 100 characters" }, "value": { "type": "string", "description": "max 100 characters" } }, "required": [ "value" ] } }, "required": [ "option", "id", "name", "required", "visible", "type" ] }, "examples": {} } } } } }, "/transaction/{transactionid}/capture": { "post": { "summary": "Capture a Pre-Auth Transaction", "description": "Captures funds from a pre-authorized transaction. This converts a pre-authorization into a completed charge.", "operationId": "capture-a-pre-auth-transaction", "parameters": [ { "name": "transactionid", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "string", "description": "Amount that you would like to capture" } } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"id\": \"d4db6c3b-4a96-48b6-a08b-551326fada40\",\n \"invoice_id\": \"\",\n \"reference_id\": \"\",\n \"recurring_transaction_id\": \"\",\n \"auth_id\": null,\n \"type\": \"pre_auth\",\n \"source\": null,\n \"is_merchant_present\": true,\n \"merchant_id\": \"e7bcf7a6-ea72-4981-894d-73b41a690fa8\",\n \"user_id\": \"2d089742-6aca-462d-8db3-c2966e1f9e68\",\n \"customer_id\": \"3a50862a-c2d5-47ae-8f49-d42afff8ee77\",\n \"payment_method_id\": \"f096d9b4-c890-45af-9b47-3de0aa10e5d2\",\n \"is_manual\": null,\n \"success\": true,\n \"message\": null,\n \"meta\": {\n \"tax\": 2,\n \"subtotal\": 10\n },\n \"total\": 1,\n \"method\": \"card\",\n \"pre_auth\": true,\n \"is_captured\": 1,\n \"last_four\": \"1111\",\n \"interchange_code\": \"\",\n \"interchange_fee\": null,\n \"batch_id\": \"\",\n \"batched_at\": \"2018-03-20 13:27:19\",\n \"emv_response\": \"\",\n \"avs_response\": \"\",\n \"cvv_response\": \"\",\n \"pos_entry\": \"\",\n \"pos_salesperson\": \"\",\n \"receipt_email_at\": null,\n \"receipt_sms_at\": null,\n \"created_at\": \"2018-03-05 13:27:05\",\n \"updated_at\": \"2018-03-05 13:27:19\",\n \"total_refunded\": 0,\n \"is_refundable\": false,\n \"is_voided\": false,\n \"is_voidable\": false,\n \"schedule_id\": null,\n \"child_captures\": [\n {\n \"id\": \"936e3b88-6df1-4048-9d39-00469748008f\",\n \"invoice_id\": \"\",\n \"reference_id\": \"\",\n \"recurring_transaction_id\": \"\",\n \"auth_id\": \"d4db6c3b-4a96-48b6-a08b-551326fada40\",\n \"type\": \"capture\",\n \"source\": null,\n \"is_merchant_present\": true,\n \"merchant_id\": \"e7bcf7a6-ea72-4981-894d-73b41a690fa8\",\n \"user_id\": \"2d089742-6aca-462d-8db3-c2966e1f9e68\",\n \"customer_id\": \"3a50862a-c2d5-47ae-8f49-d42afff8ee77\",\n \"payment_method_id\": \"f096d9b4-c890-45af-9b47-3de0aa10e5d2\",\n \"is_manual\": null,\n \"success\": true,\n \"message\": null,\n \"meta\": {\n \"tax\": 2,\n \"subtotal\": 10\n },\n \"total\": 5,\n \"method\": \"card\",\n \"pre_auth\": false,\n \"is_captured\": 0,\n \"last_four\": \"1111\",\n \"interchange_code\": \"\",\n \"interchange_fee\": null,\n \"batch_id\": \"\",\n \"batched_at\": \"2018-03-20 13:27:18\",\n \"emv_response\": \"\",\n \"avs_response\": \"\",\n \"cvv_response\": \"\",\n \"pos_entry\": \"\",\n \"pos_salesperson\": \"\",\n \"receipt_email_at\": null,\n \"receipt_sms_at\": null,\n \"created_at\": \"2018-03-05 13:27:18\",\n \"updated_at\": \"2018-03-05 13:27:18\",\n \"total_refunded\": 0,\n \"is_refundable\": false,\n \"is_voided\": false,\n \"is_voidable\": true,\n \"currency\": \"USD\",\n \"schedule_id\": null,\n \"child_captures\": [],\n \"parent_auth\": null,\n \"customer\": {\n \"id\": \"3a50862a-c2d5-47ae-8f49-d42afff8ee77\",\n \"firstname\": \"John\",\n \"lastname\": \"Smith\",\n \"company\": \"ABC INC\",\n \"email\": \"contact@example.com\",\n \"cc_emails\": [\n \"demo@abc.com\"\n ],\n \"cc_sms\": null,\n \"phone\": \"1234567898\",\n \"address_1\": \"123 Rite Way\",\n \"address_2\": \"Unit 12\",\n \"address_city\": \"Orlando\",\n \"address_state\": \"FL\",\n \"address_zip\": \"32801\",\n \"address_country\": \"USA\",\n \"notes\": null,\n \"reference\": \"BARTLE\",\n \"options\": \"\",\n \"created_at\": \"2018-03-02 16:20:06\",\n \"updated_at\": \"2018-03-02 16:20:06\",\n \"deleted_at\": null,\n \"gravatar\": \"//www.gravatar.com/avatar/45357c125af15b6df8864a71a653bea2\"\n },\n \"child_transactions\": [],\n \"files\": [],\n \"payment_method\": {\n \"id\": \"f096d9b4-c890-45af-9b47-3de0aa10e5d2\",\n \"customer_id\": \"3a50862a-c2d5-47ae-8f49-d42afff8ee77\",\n \"merchant_id\": \"e7bcf7a6-ea72-4981-894d-73b41a690fa8\",\n \"user_id\": \"2d089742-6aca-462d-8db3-c2966e1f9e68\",\n \"nickname\": \"VISA: Steven Smith Jr. (ending in: 1111)\",\n \"has_cvv\": 1,\n \"is_default\": 1,\n \"method\": \"card\",\n \"person_name\": \"Steven Smith Jr.\",\n \"card_type\": \"visa\",\n \"card_last_four\": \"1111\",\n \"card_exp\": \"042019\",\n \"bank_name\": null,\n \"bank_type\": null,\n \"bank_holder_type\": null,\n \"address_1\": null,\n \"address_2\": null,\n \"address_city\": null,\n \"address_state\": null,\n \"address_zip\": \"32944\",\n \"address_country\": \"USA\",\n \"purged_at\": null,\n \"deleted_at\": null,\n \"created_at\": \"2018-03-03 16:21:09\",\n \"updated_at\": \"2018-03-03 16:21:09\",\n \"card_exp_datetime\": \"2019-04-30 23:59:59\",\n \"customer\": {\n \"id\": \"3a50862a-c2d5-47ae-8f49-d42afff8ee77\",\n \"firstname\": \"John\",\n \"lastname\": \"Smith\",\n \"company\": \"ABC INC\",\n \"email\": \"contact@example.com\",\n \"cc_emails\": [\n \"demo@abc.com\"\n ],\n \"cc_sms\": null,\n \"phone\": \"1234567898\",\n \"address_1\": \"123 Rite Way\",\n \"address_2\": \"Unit 12\",\n \"address_city\": \"Orlando\",\n \"address_state\": \"FL\",\n \"address_zip\": \"32801\",\n \"address_country\": \"USA\",\n \"notes\": null,\n \"reference\": \"BARTLE\",\n \"options\": \"\",\n \"created_at\": \"2018-03-03 16:20:06\",\n \"updated_at\": \"2018-03-03 16:20:06\",\n \"deleted_at\": null,\n \"gravatar\": \"//www.gravatar.com/avatar/45357c125af15b6df8864a71a653bea2\"\n }\n },\n \"user\": {\n \"id\": \"2d089742-6aca-462d-8db3-c2966e1f9e68\",\n \"system_admin\": true,\n \"name\": \"Morty Junior\",\n \"email\": \"contact@example.com\",\n \"email_verification_sent_at\": \"2016-05-11 17:13:33\",\n \"email_verified_at\": \"2016-05-11 17:13:33\",\n \"is_api_key\": false,\n \"acknowledgments\": {\n \"tutorial\": true,\n \"signedApplication\": true,\n \"godviewWelcome\": true\n },\n \"created_at\": \"2016-05-18 14:11:46\",\n \"updated_at\": \"2018-03-05 20:26:20\",\n \"deleted_at\": null,\n \"gravatar\": \"//www.gravatar.com/avatar/772cbf95746d7da86789cc3634c46ba8\",\n \"team_admin\": null,\n \"team_enabled\": null,\n \"team_role\": null,\n \"merchant_options\": [],\n \"is_portal\": false\n }\n }\n ],\n \"parent_auth\": null,\n \"customer\": {\n \"id\": \"3a50862a-c2d5-47ae-8f49-d42afff8ee77\",\n \"firstname\": \"John\",\n \"lastname\": \"Smith\",\n \"company\": \"ABC INC\",\n \"email\": \"contact@example.com\",\n \"cc_emails\": [\n \"demo@abc.com\"\n ],\n \"cc_sms\": null,\n \"phone\": \"1234567898\",\n \"address_1\": \"123 Rite Way\",\n \"address_2\": \"Unit 12\",\n \"address_city\": \"Orlando\",\n \"address_state\": \"FL\",\n \"address_zip\": \"32801\",\n \"address_country\": \"USA\",\n \"notes\": null,\n \"reference\": \"BARTLE\",\n \"options\": \"\",\n \"created_at\": \"2018-03-03 16:20:06\",\n \"updated_at\": \"2018-03-03 16:20:06\",\n \"deleted_at\": null,\n \"gravatar\": \"//www.gravatar.com/avatar/45357c125af15b6df8864a71a653bea2\"\n },\n \"child_transactions\": [],\n \"files\": [],\n \"payment_method\": {\n \"id\": \"f096d9b4-c890-45af-9b47-3de0aa10e5d2\",\n \"customer_id\": \"3a50862a-c2d5-47ae-8f49-d42afff8ee77\",\n \"merchant_id\": \"e7bcf7a6-ea72-4981-894d-73b41a690fa8\",\n \"user_id\": \"2d089742-6aca-462d-8db3-c2966e1f9e68\",\n \"nickname\": \"VISA: Steven Smith Jr. (ending in: 1111)\",\n \"has_cvv\": 1,\n \"is_default\": 1,\n \"method\": \"card\",\n \"person_name\": \"Steven Smith Jr.\",\n \"card_type\": \"visa\",\n \"card_last_four\": \"1111\",\n \"card_exp\": \"042019\",\n \"bank_name\": null,\n \"bank_type\": null,\n \"bank_holder_type\": null,\n \"address_1\": null,\n \"address_2\": null,\n \"address_city\": null,\n \"address_state\": null,\n \"address_zip\": \"32944\",\n \"address_country\": \"USA\",\n \"purged_at\": null,\n \"deleted_at\": null,\n \"created_at\": \"2018-03-03 16:21:09\",\n \"updated_at\": \"2018-03-03 16:21:09\",\n \"card_exp_datetime\": \"2019-04-30 23:59:59\",\n \"customer\": {\n \"id\": \"3a50862a-c2d5-47ae-8f49-d42afff8ee77\",\n \"firstname\": \"John\",\n \"lastname\": \"Smith\",\n \"company\": \"ABC INC\",\n \"email\": \"contact@example.com\",\n \"cc_emails\": [\n \"demo@abc.com\"\n ],\n \"cc_sms\": null,\n \"phone\": \"1234567898\",\n \"address_1\": \"123 Rite Way\",\n \"address_2\": \"Unit 12\",\n \"address_city\": \"Orlando\",\n \"address_state\": \"FL\",\n \"address_zip\": \"32801\",\n \"address_country\": \"USA\",\n \"notes\": null,\n \"reference\": \"BARTLE\",\n \"options\": \"\",\n \"created_at\": \"2018-03-03 16:20:06\",\n \"updated_at\": \"2018-03-03 16:20:06\",\n \"deleted_at\": null,\n \"gravatar\": \"//www.gravatar.com/avatar/45357c125af15b6df8864a71a653bea2\"\n }\n },\n \"user\": {\n \"id\": \"2d089742-6aca-462d-8db3-c2966e1f9e68\",\n \"system_admin\": true,\n \"name\": \"Morty Junior\",\n \"email\": \"contact@example.com\",\n \"email_verification_sent_at\": \"2016-05-11 17:13:33\",\n \"email_verified_at\": \"2016-05-11 17:13:33\",\n \"is_api_key\": false,\n \"acknowledgments\": {\n \"tutorial\": true,\n \"signedApplication\": true,\n \"godviewWelcome\": true\n },\n \"created_at\": \"2016-05-18 14:11:46\",\n \"updated_at\": \"2018-03-05 20:26:20\",\n \"deleted_at\": null,\n \"gravatar\": \"//www.gravatar.com/avatar/772cbf95746d7da86789cc3634c46ba8\",\n \"team_admin\": null,\n \"team_enabled\": null,\n \"team_role\": null,\n \"merchant_options\": [],\n \"is_portal\": false\n }\n}" } }, "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "d4db6c3b-4a96-48b6-a08b-551326fada40" }, "invoice_id": { "type": "string", "example": "" }, "reference_id": { "type": "string", "example": "" }, "recurring_transaction_id": { "type": "string", "example": "" }, "auth_id": {}, "type": { "type": "string", "example": "pre_auth" }, "source": {}, "is_merchant_present": { "type": "boolean", "example": true, "default": true }, "merchant_id": { "type": "string", "example": "e7bcf7a6-ea72-4981-894d-73b41a690fa8" }, "user_id": { "type": "string", "example": "2d089742-6aca-462d-8db3-c2966e1f9e68" }, "customer_id": { "type": "string", "example": "3a50862a-c2d5-47ae-8f49-d42afff8ee77" }, "payment_method_id": { "type": "string", "example": "f096d9b4-c890-45af-9b47-3de0aa10e5d2" }, "is_manual": {}, "success": { "type": "boolean", "example": true, "default": true }, "message": {}, "meta": { "type": "object", "properties": { "tax": { "type": "integer", "example": 2, "default": 0 }, "subtotal": { "type": "integer", "example": 10, "default": 0 } } }, "total": { "type": "integer", "example": 1, "default": 0 }, "method": { "type": "string", "example": "card" }, "pre_auth": { "type": "boolean", "example": true, "default": true }, "is_captured": { "type": "integer", "example": 1, "default": 0 }, "last_four": { "type": "string", "example": "1111" }, "interchange_code": { "type": "string", "example": "" }, "interchange_fee": {}, "batch_id": { "type": "string", "example": "" }, "batched_at": { "type": "string", "example": "2018-03-20 13:27:19" }, "emv_response": { "type": "string", "example": "" }, "avs_response": { "type": "string", "example": "" }, "cvv_response": { "type": "string", "example": "" }, "pos_entry": { "type": "string", "example": "" }, "pos_salesperson": { "type": "string", "example": "" }, "receipt_email_at": {}, "receipt_sms_at": {}, "created_at": { "type": "string", "example": "2018-03-05 13:27:05" }, "updated_at": { "type": "string", "example": "2018-03-05 13:27:19" }, "total_refunded": { "type": "integer", "example": 0, "default": 0 }, "is_refundable": { "type": "boolean", "example": false, "default": true }, "is_voided": { "type": "boolean", "example": false, "default": true }, "is_voidable": { "type": "boolean", "example": false, "default": true }, "schedule_id": {}, "child_captures": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "936e3b88-6df1-4048-9d39-00469748008f" }, "invoice_id": { "type": "string", "example": "" }, "reference_id": { "type": "string", "example": "" }, "recurring_transaction_id": { "type": "string", "example": "" }, "auth_id": { "type": "string", "example": "d4db6c3b-4a96-48b6-a08b-551326fada40" }, "type": { "type": "string", "example": "capture" }, "source": {}, "is_merchant_present": { "type": "boolean", "example": true, "default": true }, "merchant_id": { "type": "string", "example": "e7bcf7a6-ea72-4981-894d-73b41a690fa8" }, "user_id": { "type": "string", "example": "2d089742-6aca-462d-8db3-c2966e1f9e68" }, "customer_id": { "type": "string", "example": "3a50862a-c2d5-47ae-8f49-d42afff8ee77" }, "payment_method_id": { "type": "string", "example": "f096d9b4-c890-45af-9b47-3de0aa10e5d2" }, "is_manual": {}, "success": { "type": "boolean", "example": true, "default": true }, "message": {}, "meta": { "type": "object", "properties": { "tax": { "type": "integer", "example": 2, "default": 0 }, "subtotal": { "type": "integer", "example": 10, "default": 0 } } }, "total": { "type": "integer", "example": 5, "default": 0 }, "method": { "type": "string", "example": "card" }, "pre_auth": { "type": "boolean", "example": false, "default": true }, "is_captured": { "type": "integer", "example": 0, "default": 0 }, "last_four": { "type": "string", "example": "1111" }, "interchange_code": { "type": "string", "example": "" }, "interchange_fee": {}, "batch_id": { "type": "string", "example": "" }, "batched_at": { "type": "string", "example": "2018-03-20 13:27:18" }, "emv_response": { "type": "string", "example": "" }, "avs_response": { "type": "string", "example": "" }, "cvv_response": { "type": "string", "example": "" }, "pos_entry": { "type": "string", "example": "" }, "pos_salesperson": { "type": "string", "example": "" }, "receipt_email_at": {}, "receipt_sms_at": {}, "created_at": { "type": "string", "example": "2018-03-05 13:27:18" }, "updated_at": { "type": "string", "example": "2018-03-05 13:27:18" }, "total_refunded": { "type": "integer", "example": 0, "default": 0 }, "is_refundable": { "type": "boolean", "example": false, "default": true }, "is_voided": { "type": "boolean", "example": false, "default": true }, "is_voidable": { "type": "boolean", "example": true, "default": true }, "currency": { "type": "string", "example": "USD" }, "schedule_id": {}, "child_captures": { "type": "array" }, "parent_auth": {}, "customer": { "type": "object", "properties": { "id": { "type": "string", "example": "3a50862a-c2d5-47ae-8f49-d42afff8ee77" }, "firstname": { "type": "string", "example": "John" }, "lastname": { "type": "string", "example": "Smith" }, "company": { "type": "string", "example": "ABC INC" }, "email": { "type": "string", "example": "contact@example.com" }, "cc_emails": { "type": "array", "items": { "type": "string", "example": "demo@abc.com" } }, "cc_sms": {}, "phone": { "type": "string", "example": "1234567898" }, "address_1": { "type": "string", "example": "123 Rite Way" }, "address_2": { "type": "string", "example": "Unit 12" }, "address_city": { "type": "string", "example": "Orlando" }, "address_state": { "type": "string", "example": "FL" }, "address_zip": { "type": "string", "example": "32801" }, "address_country": { "type": "string", "example": "USA" }, "notes": {}, "reference": { "type": "string", "example": "BARTLE" }, "options": { "type": "string", "example": "" }, "created_at": { "type": "string", "example": "2018-03-02 16:20:06" }, "updated_at": { "type": "string", "example": "2018-03-02 16:20:06" }, "deleted_at": {}, "gravatar": { "type": "string", "example": "//www.gravatar.com/avatar/45357c125af15b6df8864a71a653bea2" } } }, "child_transactions": { "type": "array" }, "files": { "type": "array" }, "payment_method": { "type": "object", "properties": { "id": { "type": "string", "example": "f096d9b4-c890-45af-9b47-3de0aa10e5d2" }, "customer_id": { "type": "string", "example": "3a50862a-c2d5-47ae-8f49-d42afff8ee77" }, "merchant_id": { "type": "string", "example": "e7bcf7a6-ea72-4981-894d-73b41a690fa8" }, "user_id": { "type": "string", "example": "2d089742-6aca-462d-8db3-c2966e1f9e68" }, "nickname": { "type": "string", "example": "VISA: Steven Smith Jr. (ending in: 1111)" }, "has_cvv": { "type": "integer", "example": 1, "default": 0 }, "is_default": { "type": "integer", "example": 1, "default": 0 }, "method": { "type": "string", "example": "card" }, "person_name": { "type": "string", "example": "Steven Smith Jr." }, "card_type": { "type": "string", "example": "visa" }, "card_last_four": { "type": "string", "example": "1111" }, "card_exp": { "type": "string", "example": "042019" }, "bank_name": {}, "bank_type": {}, "bank_holder_type": {}, "address_1": {}, "address_2": {}, "address_city": {}, "address_state": {}, "address_zip": { "type": "string", "example": "32944" }, "address_country": { "type": "string", "example": "USA" }, "purged_at": {}, "deleted_at": {}, "created_at": { "type": "string", "example": "2018-03-03 16:21:09" }, "updated_at": { "type": "string", "example": "2018-03-03 16:21:09" }, "card_exp_datetime": { "type": "string", "example": "2019-04-30 23:59:59" }, "customer": { "type": "object", "properties": { "id": { "type": "string", "example": "3a50862a-c2d5-47ae-8f49-d42afff8ee77" }, "firstname": { "type": "string", "example": "John" }, "lastname": { "type": "string", "example": "Smith" }, "company": { "type": "string", "example": "ABC INC" }, "email": { "type": "string", "example": "contact@example.com" }, "cc_emails": { "type": "array", "items": { "type": "string", "example": "demo@abc.com" } }, "cc_sms": {}, "phone": { "type": "string", "example": "1234567898" }, "address_1": { "type": "string", "example": "123 Rite Way" }, "address_2": { "type": "string", "example": "Unit 12" }, "address_city": { "type": "string", "example": "Orlando" }, "address_state": { "type": "string", "example": "FL" }, "address_zip": { "type": "string", "example": "32801" }, "address_country": { "type": "string", "example": "USA" }, "notes": {}, "reference": { "type": "string", "example": "BARTLE" }, "options": { "type": "string", "example": "" }, "created_at": { "type": "string", "example": "2018-03-03 16:20:06" }, "updated_at": { "type": "string", "example": "2018-03-03 16:20:06" }, "deleted_at": {}, "gravatar": { "type": "string", "example": "//www.gravatar.com/avatar/45357c125af15b6df8864a71a653bea2" } } } } }, "user": { "type": "object", "properties": { "id": { "type": "string", "example": "2d089742-6aca-462d-8db3-c2966e1f9e68" }, "system_admin": { "type": "boolean", "example": true, "default": true }, "name": { "type": "string", "example": "Morty Junior" }, "email": { "type": "string", "example": "contact@example.com" }, "email_verification_sent_at": { "type": "string", "example": "2016-05-11 17:13:33" }, "email_verified_at": { "type": "string", "example": "2016-05-11 17:13:33" }, "is_api_key": { "type": "boolean", "example": false, "default": true }, "acknowledgments": { "type": "object", "properties": { "tutorial": { "type": "boolean", "example": true, "default": true }, "signedApplication": { "type": "boolean", "example": true, "default": true }, "godviewWelcome": { "type": "boolean", "example": true, "default": true } } }, "created_at": { "type": "string", "example": "2016-05-18 14:11:46" }, "updated_at": { "type": "string", "example": "2018-03-05 20:26:20" }, "deleted_at": {}, "gravatar": { "type": "string", "example": "//www.gravatar.com/avatar/772cbf95746d7da86789cc3634c46ba8" }, "team_admin": {}, "team_enabled": {}, "team_role": {}, "merchant_options": { "type": "array" }, "is_portal": { "type": "boolean", "example": false, "default": true } } } } } }, "parent_auth": {}, "customer": { "type": "object", "properties": { "id": { "type": "string", "example": "3a50862a-c2d5-47ae-8f49-d42afff8ee77" }, "firstname": { "type": "string", "example": "John" }, "lastname": { "type": "string", "example": "Smith" }, "company": { "type": "string", "example": "ABC INC" }, "email": { "type": "string", "example": "contact@example.com" }, "cc_emails": { "type": "array", "items": { "type": "string", "example": "demo@abc.com" } }, "cc_sms": {}, "phone": { "type": "string", "example": "1234567898" }, "address_1": { "type": "string", "example": "123 Rite Way" }, "address_2": { "type": "string", "example": "Unit 12" }, "address_city": { "type": "string", "example": "Orlando" }, "address_state": { "type": "string", "example": "FL" }, "address_zip": { "type": "string", "example": "32801" }, "address_country": { "type": "string", "example": "USA" }, "notes": {}, "reference": { "type": "string", "example": "BARTLE" }, "options": { "type": "string", "example": "" }, "created_at": { "type": "string", "example": "2018-03-03 16:20:06" }, "updated_at": { "type": "string", "example": "2018-03-03 16:20:06" }, "deleted_at": {}, "gravatar": { "type": "string", "example": "//www.gravatar.com/avatar/45357c125af15b6df8864a71a653bea2" } } }, "child_transactions": { "type": "array" }, "files": { "type": "array" }, "payment_method": { "type": "object", "properties": { "id": { "type": "string", "example": "f096d9b4-c890-45af-9b47-3de0aa10e5d2" }, "customer_id": { "type": "string", "example": "3a50862a-c2d5-47ae-8f49-d42afff8ee77" }, "merchant_id": { "type": "string", "example": "e7bcf7a6-ea72-4981-894d-73b41a690fa8" }, "user_id": { "type": "string", "example": "2d089742-6aca-462d-8db3-c2966e1f9e68" }, "nickname": { "type": "string", "example": "VISA: Steven Smith Jr. (ending in: 1111)" }, "has_cvv": { "type": "integer", "example": 1, "default": 0 }, "is_default": { "type": "integer", "example": 1, "default": 0 }, "method": { "type": "string", "example": "card" }, "person_name": { "type": "string", "example": "Steven Smith Jr." }, "card_type": { "type": "string", "example": "visa" }, "card_last_four": { "type": "string", "example": "1111" }, "card_exp": { "type": "string", "example": "042019" }, "bank_name": {}, "bank_type": {}, "bank_holder_type": {}, "address_1": {}, "address_2": {}, "address_city": {}, "address_state": {}, "address_zip": { "type": "string", "example": "32944" }, "address_country": { "type": "string", "example": "USA" }, "purged_at": {}, "deleted_at": {}, "created_at": { "type": "string", "example": "2018-03-03 16:21:09" }, "updated_at": { "type": "string", "example": "2018-03-03 16:21:09" }, "card_exp_datetime": { "type": "string", "example": "2019-04-30 23:59:59" }, "customer": { "type": "object", "properties": { "id": { "type": "string", "example": "3a50862a-c2d5-47ae-8f49-d42afff8ee77" }, "firstname": { "type": "string", "example": "John" }, "lastname": { "type": "string", "example": "Smith" }, "company": { "type": "string", "example": "ABC INC" }, "email": { "type": "string", "example": "contact@example.com" }, "cc_emails": { "type": "array", "items": { "type": "string", "example": "demo@abc.com" } }, "cc_sms": {}, "phone": { "type": "string", "example": "1234567898" }, "address_1": { "type": "string", "example": "123 Rite Way" }, "address_2": { "type": "string", "example": "Unit 12" }, "address_city": { "type": "string", "example": "Orlando" }, "address_state": { "type": "string", "example": "FL" }, "address_zip": { "type": "string", "example": "32801" }, "address_country": { "type": "string", "example": "USA" }, "notes": {}, "reference": { "type": "string", "example": "BARTLE" }, "options": { "type": "string", "example": "" }, "created_at": { "type": "string", "example": "2018-03-03 16:20:06" }, "updated_at": { "type": "string", "example": "2018-03-03 16:20:06" }, "deleted_at": {}, "gravatar": { "type": "string", "example": "//www.gravatar.com/avatar/45357c125af15b6df8864a71a653bea2" } } } } }, "user": { "type": "object", "properties": { "id": { "type": "string", "example": "2d089742-6aca-462d-8db3-c2966e1f9e68" }, "system_admin": { "type": "boolean", "example": true, "default": true }, "name": { "type": "string", "example": "Morty Junior" }, "email": { "type": "string", "example": "contact@example.com" }, "email_verification_sent_at": { "type": "string", "example": "2016-05-11 17:13:33" }, "email_verified_at": { "type": "string", "example": "2016-05-11 17:13:33" }, "is_api_key": { "type": "boolean", "example": false, "default": true }, "acknowledgments": { "type": "object", "properties": { "tutorial": { "type": "boolean", "example": true, "default": true }, "signedApplication": { "type": "boolean", "example": true, "default": true }, "godviewWelcome": { "type": "boolean", "example": true, "default": true } } }, "created_at": { "type": "string", "example": "2016-05-18 14:11:46" }, "updated_at": { "type": "string", "example": "2018-03-05 20:26:20" }, "deleted_at": {}, "gravatar": { "type": "string", "example": "//www.gravatar.com/avatar/772cbf95746d7da86789cc3634c46ba8" }, "team_admin": {}, "team_enabled": {}, "team_role": {}, "merchant_options": { "type": "array" }, "is_portal": { "type": "boolean", "example": false, "default": true } } } } } } } }, "422": { "description": "422", "content": { "application/json": { "examples": { "Invalid Id": { "value": "{\n \"id\": [\n \"The selected id is invalid.\"\n ]\n}" } }, "schema": { "type": "object", "properties": { "id": { "type": "array", "items": { "type": "string", "example": "The selected id is invalid." } } } } } } } }, "deprecated": false } }, "/query/statement/v3/volumes/card-processing": { "get": { "summary": "Card Processing", "description": "", "operationId": "card-processing", "parameters": [ { "name": "startDate", "in": "query", "required": true, "description": "(YYYY-MM-DD)", "schema": { "type": "string", "default": "" } }, { "name": "endDate", "in": "query", "required": true, "description": "(YYYY-MM-DD)", "schema": { "type": "string", "default": "" } } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"data\": {\n \"groupByPaymentMethod\": [\n {\n \"method\": \"card\",\n \"bin_type\": \"CREDIT\",\n \"total_amt\": 0.01\n },\n {\n \"method\": \"bank\",\n \"bin_type\": \"\",\n \"total_amt\": 2\n },\n {\n \"method\": \"card\",\n \"bin_type\": \"DEBIT\",\n \"total_amt\": 0.02\n }\n ],\n \"groupByTransactionType\": [\n {\n \"method\": \"card\",\n \"is_card_present\": 0,\n \"total_amt\": 0.02\n },\n {\n \"method\": \"card\",\n \"is_card_present\": 1,\n \"total_amt\": 0.01\n },\n {\n \"method\": \"bank\",\n \"is_card_present\": 0,\n \"total_amt\": 2\n }\n ],\n \"groupByCardBrand\": [\n {\n \"card_type\": \"mastercard\",\n \"total_amt\": 0.03\n }\n ]\n }\n}" } }, "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "groupByPaymentMethod": { "type": "array", "items": { "type": "object", "properties": { "method": { "type": "string", "example": "card" }, "bin_type": { "type": "string", "example": "CREDIT" }, "total_amt": { "type": "number", "example": 0.01, "default": 0 } } } }, "groupByTransactionType": { "type": "array", "items": { "type": "object", "properties": { "method": { "type": "string", "example": "card" }, "is_card_present": { "type": "integer", "example": 0, "default": 0 }, "total_amt": { "type": "number", "example": 0.02, "default": 0 } } } }, "groupByCardBrand": { "type": "array", "items": { "type": "object", "properties": { "card_type": { "type": "string", "example": "mastercard" }, "total_amt": { "type": "number", "example": 0.03, "default": 0 } } } } } } } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "{}" } }, "schema": { "type": "object", "properties": {} } } } } }, "deprecated": false } }, "/charge": { "post": { "summary": "Charge a Payment Method", "description": "Processes a charge on a specified payment method under the merchant's account.", "operationId": "charge-a-payment-method", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "total", "payment_method_id", "pre_auth" ], "properties": { "total": { "type": "number", "description": "Float is required and will be the amount a customer is charged, in dollars and cents. Min: 00.01", "format": "float" }, "payment_method_id": { "type": "string", "description": "An existing payment_method id within Stax. The customer_id is derived from this automatically." }, "meta": { "properties": { "tax": { "type": "number", "description": "This tax dollar amount value must be a numeric value representing 0.1% and 30% of the transaction's total in order to qualify for L2 processing rates." }, "poNumber": { "type": "string", "description": "This is the customer code or customer identifier sometimes referred to as the PO number, and is used for L2 processing" }, "shippingAmount": { "type": "number", "description": "The shipping amount for the transaction. Can be zero and still qualify for L2 processing." }, "payment_note": { "type": "string", "description": "This note displays in Stax Pay when viewing a payment's details." }, "fee": { "type": "integer", "description": "The amount to be used for the transaction fee, if allowed.", "format": "int32" }, "transaction_initiation_type": { "type": "string", "description": "This specifies whether a transaction is Merchant Initiated Transaction (MIT) or Customer Initiated Transaction (CIT).", "enum": [ "MIT", "CIT" ] }, "transaction_schedule_type": { "type": "string", "description": "This specifies whether a transaction is recurring (scheduled) or unscheduled.", "enum": [ "scheduled", "unscheduled" ] }, "lineItems": { "properties": { "id": { "type": "string", "description": "id is optional and corresponds to the Stax Catalog Item Id" }, "price": { "type": "string", "description": "Price of the line item" }, "quantity": { "type": "integer", "description": "Quantity of the line item", "format": "int32" }, "item": { "type": "string", "description": "Name of the line item" }, "details": { "type": "string", "description": "Description of the line item" } }, "required": [], "type": "object" } }, "required": [], "type": "object", "description": "Can contain any json object" }, "pre_auth": { "type": "boolean", "description": "Creates a pre authorization" }, "invoice_id": { "type": "string", "description": "Creates a pre authorization" }, "idempotency_id": { "type": "string", "description": "A unique string identifier to help prevent against duplicate operations" }, "channel": { "type": "string", "description": "A way to identify where a transaction originated (ex. \"partner-mobile-application\" or \"partner-web-application:). Stax's UI fills this channel parameter with values that correspond to where the transaction originated from. This value lives in the API only and does not show up on the Stax Payment dashboards." }, "funding": { "properties": { "account_id": { "type": "string" }, "amount": { "type": "number", "format": "float" } }, "required": [], "type": "object", "description": "Defines how the funds from this transaction should be paid out. This attribute is only supported with the Split Funding feature enabled" } } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"id\": \"ad107d1a-819b-45f8-9f46-0260a3b05d26\",\n \"invoice_id\": \"\",\n \"reference_id\": \"\",\n \"recurring_transaction_id\": \"\",\n \"type\": \"charge\",\n \"source\": null,\n \"merchant_id\": \"dd36b936-1eb7-4ece-bebc-b514c6a36ebd\",\n \"user_id\": \"b58d7eee-e68d-4d12-a1f8-62f5e71382ae\",\n \"customer_id\": \"d1e9fdca-52e8-4b8a-9dd6-5ae8b0b03178\",\n \"payment_method_id\": \"b5f8729c-93ee-4bbb-9bfe-4a71f7b0e126\",\n \"is_manual\": null,\n \"success\": true,\n \"message\": null,\n \"meta\": {\n \"tax\": 4,\n \"poNumber\": \"1234\",\n \"shippingAmount\": 2,\n \"subtotal\": 20,\n \"lineItems\": [\n {\n \"id\": \"optional-fm-catalog-item-id\",\n \"item\": \"Demo Item\",\n \"details\": \"this is a regular demo item\",\n \"quantity\": 20,\n \"price\": 1\n }\n ]\n },\n \"total\": 26,\n \"method\": \"card\",\n \"pre_auth\": false,\n \"last_four\": \"1111\",\n \"receipt_email_at\": null,\n \"receipt_sms_at\": null,\n \"settled_at\": null,\n \"created_at\": \"2017-05-08 17:59:32\",\n \"updated_at\": \"2017-05-08 17:59:32\",\n \"total_refunded\": null,\n \"issuer_auth_code\": \"06782D\",\n \"is_refundable\": false,\n \"is_voided\": false,\n \"is_voidable\": true,\n \"currency\": \"USD\",\n \"is_settling\": null,\n \"schedule_id\": null,\n \"customer\": {\n \"id\": \"d1e9fdca-52e8-4b8a-9dd6-5ae8b0b03178\",\n \"firstname\": \"Jfdfddohn\",\n \"lastname\": \"Smith\",\n \"company\": \"ABC INC\",\n \"email\": \"contact@example.com\",\n \"cc_emails\": [\n \"demo@abc.com\"\n ],\n \"phone\": \"1234567898\",\n \"address_1\": \"123 Rite Way\",\n \"address_2\": \"Unit 12\",\n \"address_city\": \"Orlando\",\n \"address_state\": \"FL\",\n \"address_zip\": \"32801\",\n \"address_country\": \"USA\",\n \"notes\": null,\n \"reference\": \"BARTLE\",\n \"options\": \"\",\n \"created_at\": \"2017-04-17 15:16:28\",\n \"updated_at\": \"2017-04-17 15:16:28\",\n \"deleted_at\": null,\n \"gravatar\": \"//www.gravatar.com/avatar/45357c125af15b6df8864a71a653bea2\"\n },\n \"child_transactions\": [],\n \"files\": [],\n \"payment_method\": {\n \"id\": \"b5f8729c-93ee-4bbb-9bfe-4a71f7b0e126\",\n \"customer_id\": \"d1e9fdca-52e8-4b8a-9dd6-5ae8b0b03178\",\n \"merchant_id\": \"dd36b936-1eb7-4ece-bebc-b514c6a36ebd\",\n \"user_id\": \"b58d7eee-e68d-4d12-a1f8-62f5e71382ae\",\n \"nickname\": \"VISA: Steven Smith Jr. (ending in: 1111)\",\n \"is_default\": 1,\n \"method\": \"card\",\n \"person_name\": \"Steven Smith Jr.\",\n \"card_type\": \"visa\",\n \"card_last_four\": \"1111\",\n \"card_exp\": \"042019\",\n \"bank_name\": null,\n \"bank_type\": null,\n \"bank_holder_type\": null,\n \"address_1\": null,\n \"address_2\": null,\n \"address_city\": null,\n \"address_state\": null,\n \"address_zip\": \"32944\",\n \"address_country\": \"USA\",\n \"purged_at\": null,\n \"deleted_at\": null,\n \"created_at\": \"2017-05-08 17:59:19\",\n \"updated_at\": \"2017-05-08 17:59:19\",\n \"card_exp_datetime\": \"2019-04-30 23:59:59\",\n \"customer\": {\n \"id\": \"d1e9fdca-52e8-4b8a-9dd6-5ae8b0b03178\",\n \"firstname\": \"Jfdfddohn\",\n \"lastname\": \"Smith\",\n \"company\": \"ABC INC\",\n \"email\": \"contact@example.com\",\n \"cc_emails\": [\n \"demo@abc.com\"\n ],\n \"phone\": \"1234567898\",\n \"address_1\": \"123 Rite Way\",\n \"address_2\": \"Unit 12\",\n \"address_city\": \"Orlando\",\n \"address_state\": \"FL\",\n \"address_zip\": \"32801\",\n \"address_country\": \"USA\",\n \"notes\": null,\n \"reference\": \"BARTLE\",\n \"options\": \"\",\n \"created_at\": \"2017-04-17 15:16:28\",\n \"updated_at\": \"2017-04-17 15:16:28\",\n \"deleted_at\": null,\n \"gravatar\": \"//www.gravatar.com/avatar/45357c125af15b6df8864a71a653bea2\"\n }\n },\n \"user\": {\n \"id\": \"b58d7eee-e68d-4d12-a1f8-62f5e71382ae\",\n \"system_admin\": false,\n \"name\": \"Demo\",\n \"email\": \"contact@example.com\",\n \"email_verification_sent_at\": \"2017-03-29 15:27:19\",\n \"email_verified_at\": \"2017-03-29 15:27:21\",\n \"is_api_key\": false,\n \"created_at\": \"2017-01-11 21:44:02\",\n \"updated_at\": \"2017-04-24 15:41:58\",\n \"deleted_at\": null,\n \"gravatar\": \"//www.gravatar.com/avatar/157965dea7cd2f44e349382d1d791650\",\n \"team_admin\": null,\n \"team_enabled\": null,\n \"team_role\": null\n },\n \"avs_code\": null,\n \"avs_message\": \"Postcode and Address Matched\"\n}" } }, "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "ad107d1a-819b-45f8-9f46-0260a3b05d26" }, "invoice_id": { "type": "string", "example": "" }, "reference_id": { "type": "string", "example": "" }, "recurring_transaction_id": { "type": "string", "example": "" }, "type": { "type": "string", "example": "charge" }, "source": {}, "merchant_id": { "type": "string", "example": "dd36b936-1eb7-4ece-bebc-b514c6a36ebd" }, "user_id": { "type": "string", "example": "b58d7eee-e68d-4d12-a1f8-62f5e71382ae" }, "customer_id": { "type": "string", "example": "d1e9fdca-52e8-4b8a-9dd6-5ae8b0b03178" }, "payment_method_id": { "type": "string", "example": "b5f8729c-93ee-4bbb-9bfe-4a71f7b0e126" }, "is_manual": {}, "success": { "type": "boolean", "example": true, "default": true }, "message": {}, "meta": { "type": "object", "properties": { "tax": { "type": "integer", "example": 4, "default": 0 }, "poNumber": { "type": "string", "example": "1234" }, "shippingAmount": { "type": "integer", "example": 2, "default": 0 }, "subtotal": { "type": "integer", "example": 20, "default": 0 }, "lineItems": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "optional-fm-catalog-item-id" }, "item": { "type": "string", "example": "Demo Item" }, "details": { "type": "string", "example": "this is a regular demo item" }, "quantity": { "type": "integer", "example": 20, "default": 0 }, "price": { "type": "integer", "example": 1, "default": 0 } } } } } }, "total": { "type": "integer", "example": 26, "default": 0 }, "method": { "type": "string", "example": "card" }, "pre_auth": { "type": "boolean", "example": false, "default": true }, "last_four": { "type": "string", "example": "1111" }, "receipt_email_at": {}, "receipt_sms_at": {}, "settled_at": {}, "created_at": { "type": "string", "example": "2017-05-08 17:59:32" }, "updated_at": { "type": "string", "example": "2017-05-08 17:59:32" }, "total_refunded": {}, "issuer_auth_code": { "type": "string", "example": "06782D" }, "is_refundable": { "type": "boolean", "example": false, "default": true }, "is_voided": { "type": "boolean", "example": false, "default": true }, "is_voidable": { "type": "boolean", "example": true, "default": true }, "currency": { "type": "string", "example": "USD" }, "is_settling": {}, "schedule_id": {}, "customer": { "type": "object", "properties": { "id": { "type": "string", "example": "d1e9fdca-52e8-4b8a-9dd6-5ae8b0b03178" }, "firstname": { "type": "string", "example": "Jfdfddohn" }, "lastname": { "type": "string", "example": "Smith" }, "company": { "type": "string", "example": "ABC INC" }, "email": { "type": "string", "example": "contact@example.com" }, "cc_emails": { "type": "array", "items": { "type": "string", "example": "demo@abc.com" } }, "phone": { "type": "string", "example": "1234567898" }, "address_1": { "type": "string", "example": "123 Rite Way" }, "address_2": { "type": "string", "example": "Unit 12" }, "address_city": { "type": "string", "example": "Orlando" }, "address_state": { "type": "string", "example": "FL" }, "address_zip": { "type": "string", "example": "32801" }, "address_country": { "type": "string", "example": "USA" }, "notes": {}, "reference": { "type": "string", "example": "BARTLE" }, "options": { "type": "string", "example": "" }, "created_at": { "type": "string", "example": "2017-04-17 15:16:28" }, "updated_at": { "type": "string", "example": "2017-04-17 15:16:28" }, "deleted_at": {}, "gravatar": { "type": "string", "example": "//www.gravatar.com/avatar/45357c125af15b6df8864a71a653bea2" } } }, "child_transactions": { "type": "array" }, "files": { "type": "array" }, "payment_method": { "type": "object", "properties": { "id": { "type": "string", "example": "b5f8729c-93ee-4bbb-9bfe-4a71f7b0e126" }, "customer_id": { "type": "string", "example": "d1e9fdca-52e8-4b8a-9dd6-5ae8b0b03178" }, "merchant_id": { "type": "string", "example": "dd36b936-1eb7-4ece-bebc-b514c6a36ebd" }, "user_id": { "type": "string", "example": "b58d7eee-e68d-4d12-a1f8-62f5e71382ae" }, "nickname": { "type": "string", "example": "VISA: Steven Smith Jr. (ending in: 1111)" }, "is_default": { "type": "integer", "example": 1, "default": 0 }, "method": { "type": "string", "example": "card" }, "person_name": { "type": "string", "example": "Steven Smith Jr." }, "card_type": { "type": "string", "example": "visa" }, "card_last_four": { "type": "string", "example": "1111" }, "card_exp": { "type": "string", "example": "042019" }, "bank_name": {}, "bank_type": {}, "bank_holder_type": {}, "address_1": {}, "address_2": {}, "address_city": {}, "address_state": {}, "address_zip": { "type": "string", "example": "32944" }, "address_country": { "type": "string", "example": "USA" }, "purged_at": {}, "deleted_at": {}, "created_at": { "type": "string", "example": "2017-05-08 17:59:19" }, "updated_at": { "type": "string", "example": "2017-05-08 17:59:19" }, "card_exp_datetime": { "type": "string", "example": "2019-04-30 23:59:59" }, "customer": { "type": "object", "properties": { "id": { "type": "string", "example": "d1e9fdca-52e8-4b8a-9dd6-5ae8b0b03178" }, "firstname": { "type": "string", "example": "Jfdfddohn" }, "lastname": { "type": "string", "example": "Smith" }, "company": { "type": "string", "example": "ABC INC" }, "email": { "type": "string", "example": "contact@example.com" }, "cc_emails": { "type": "array", "items": { "type": "string", "example": "demo@abc.com" } }, "phone": { "type": "string", "example": "1234567898" }, "address_1": { "type": "string", "example": "123 Rite Way" }, "address_2": { "type": "string", "example": "Unit 12" }, "address_city": { "type": "string", "example": "Orlando" }, "address_state": { "type": "string", "example": "FL" }, "address_zip": { "type": "string", "example": "32801" }, "address_country": { "type": "string", "example": "USA" }, "notes": {}, "reference": { "type": "string", "example": "BARTLE" }, "options": { "type": "string", "example": "" }, "created_at": { "type": "string", "example": "2017-04-17 15:16:28" }, "updated_at": { "type": "string", "example": "2017-04-17 15:16:28" }, "deleted_at": {}, "gravatar": { "type": "string", "example": "//www.gravatar.com/avatar/45357c125af15b6df8864a71a653bea2" } } } } }, "user": { "type": "object", "properties": { "id": { "type": "string", "example": "b58d7eee-e68d-4d12-a1f8-62f5e71382ae" }, "system_admin": { "type": "boolean", "example": false, "default": true }, "name": { "type": "string", "example": "Demo" }, "email": { "type": "string", "example": "contact@example.com" }, "email_verification_sent_at": { "type": "string", "example": "2017-03-29 15:27:19" }, "email_verified_at": { "type": "string", "example": "2017-03-29 15:27:21" }, "is_api_key": { "type": "boolean", "example": false, "default": true }, "created_at": { "type": "string", "example": "2017-01-11 21:44:02" }, "updated_at": { "type": "string", "example": "2017-04-24 15:41:58" }, "deleted_at": {}, "gravatar": { "type": "string", "example": "//www.gravatar.com/avatar/157965dea7cd2f44e349382d1d791650" }, "team_admin": {}, "team_enabled": {}, "team_role": {} } }, "avs_code": {}, "avs_message": { "type": "string", "example": "Postcode and Address Matched" } } } } } }, "422": { "description": "422", "content": { "application/json": { "examples": { "Missing Fields": { "value": "{\n \"payment_method_id\": [\n \"The payment method id field is required.\"\n ],\n \"meta\": [\n \"The meta field is required.\"\n ],\n \"total\": [\n \"The total field is required.\"\n ],\n \"files.0\": [\n \"The selected files.0 is invalid.\"\n ]\n}" }, "Invalid/Unauthorized": { "value": "{\n \"payment_method_id\": [\n \"Payment method is invalid or unauthorized.\"\n ]\n}" }, "Redacted": { "value": "{\n \"payment_method_id\": [\n \"The Payment Method has been redacted.\"\n ]\n}" }, "Deleted": { "value": "{\n \"payment_method_id\": [\n \"The Payment Method has been deleted.\"\n ]\n}" }, "Missing Funding Field": { "value": "{\n \"funding.0.account_id\": [\n \"The funding.0.account_id field is required.\"\n ]\n}" }, "Inactive Funding Account": { "value": "{\n \"funding.0.account_id\": [\n \"Inactive funding account\"\n ]\n}" }, "Mismatch Sum": { "value": "{\n \"error\": [\n \"The transaction total does not match the sum of the funding amounts.\"\n ]\n}" }, "Invalid Transaction Meta": { "value": "{\n \"meta.transaction_initiation_type\": [\n \"The selected meta.transaction initiation type is invalid.\"\n ],\n \"meta.transaction_schedule_type\": [\n \"The selected meta.transaction schedule type is invalid.\"\n ]\n}" }, "Inactive Account": { "value": "{\n \"authorization_error\": [\n \"your merchant account must be ACTIVE to perform this action\"\n ]\n}" } }, "schema": { "oneOf": [ { "title": "Missing Fields", "type": "object", "properties": { "payment_method_id": { "type": "array", "items": { "type": "string", "example": "The payment method id field is required." } }, "meta": { "type": "array", "items": { "type": "string", "example": "The meta field is required." } }, "total": { "type": "array", "items": { "type": "string", "example": "The total field is required." } }, "files.0": { "type": "array", "items": { "type": "string", "example": "The selected files.0 is invalid." } } } }, { "title": "Invalid/Unauthorized", "type": "object", "properties": { "payment_method_id": { "type": "array", "items": { "type": "string", "example": "Payment method is invalid or unauthorized." } } } }, { "title": "Redacted", "type": "object", "properties": { "payment_method_id": { "type": "array", "items": { "type": "string", "example": "The Payment Method has been redacted." } } } }, { "title": "Deleted", "type": "object", "properties": { "payment_method_id": { "type": "array", "items": { "type": "string", "example": "The Payment Method has been deleted." } } } }, { "title": "Missing Funding Field", "type": "object", "properties": { "funding.0.account_id": { "type": "array", "items": { "type": "string", "example": "The funding.0.account_id field is required." } } } }, { "title": "Inactive Funding Account", "type": "object", "properties": { "funding.0.account_id": { "type": "array", "items": { "type": "string", "example": "Inactive funding account" } } } }, { "title": "Mismatch Sum", "type": "object", "properties": { "error": { "type": "array", "items": { "type": "string", "example": "The transaction total does not match the sum of the funding amounts." } } } }, { "title": "Invalid Transaction Meta", "type": "object", "properties": { "meta.transaction_initiation_type": { "type": "array", "items": { "type": "string", "example": "The selected meta.transaction initiation type is invalid." } }, "meta.transaction_schedule_type": { "type": "array", "items": { "type": "string", "example": "The selected meta.transaction schedule type is invalid." } } } }, { "title": "Inactive Account", "type": "object", "properties": { "authorization_error": { "type": "array", "items": { "type": "string", "example": "your merchant account must be ACTIVE to perform this action" } } } } ] } } } } } } }, "/terminal/charge/queue": { "post": { "summary": "Charge (Queue)", "description": "Queues a card-present sale on the terminal rather than waking it immediately. Useful when multiple transactions need to be staged (e.g., busy lanes) or when the device is currently in use. Response mirrors `/terminal/charge` but processing begins only when the terminal becomes available.\n\nWorkflow:\n1. Create queued charge.\n2. Terminal processes queued items FIFO.\n3. Poll status endpoint for each queued transaction.\n\nDifferences vs `/terminal/charge`:\n- Terminal may return `terminalservice.waiting` until it dequeues.\n- If queue is full returns a 422 or device-specific error.\n- Cancellation before processing removes from queue.\n\nRecommended Use: High concurrency environments; fall back to direct charge for immediate processing.\n\nSecurity: ApiKeyAuth or EphemeralAuth required.\n\nPolling: Same recommendations as charge; consider exponential backoff if many queued items.", "security": [ { "ApiKeyAuth": [] } ], "operationId": "charge-queue", "parameters": [], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"id\": \"71d7f9ec-59d9-4fab-891e-fa612cd2e275\",\n \"invoice_id\": \"02936d77-93cc-48a6-b712-7f7234c19b7c\",\n \"reference_id\": \"\",\n \"recurring_transaction_id\": \"\",\n \"auth_id\": null,\n \"type\": \"charge\",\n \"source\": \"terminalservice.dejavoo\",\n \"source_ip\": \"127.0.0.1\",\n \"is_merchant_present\": true,\n \"merchant_id\": \"07420820-9b00-4816-9199-2071af7019f4\",\n \"user_id\": \"61822412-09b3-4f5a-a90f-fd9f1db703b4\",\n \"customer_id\": \"df25411e-4b01-4efe-8368-496b959b253f\",\n \"payment_method_id\": null,\n \"is_manual\": true,\n \"success\": false,\n \"message\": \"terminalservice.waiting\",\n \"meta\": {\n \"lineItems\": [],\n \"tax\": 0,\n \"subtotal\": 0.01,\n \"printReceipt\": \"Merchant\",\n \"paymentType\": \"Credit\",\n \"invoiceId\": \"02936d77-93cc-48a6-b712-7f7234c19b7c\",\n \"message\": \"terminalservice.waiting\",\n \"type\": \"charge\",\n \"registerId\": \"ba5c-5b03\",\n \"registerStatusPort\": \"3594291\",\n \"registerNickname\": \"Dejavoo Z8\",\n \"registerSerial\": \"\",\n \"registerType\": \"dejavoo\"\n },\n \"total\": 0.01,\n \"method\": \"card\",\n \"pre_auth\": false,\n \"is_captured\": 0,\n \"last_four\": \"\",\n \"interchange_code\": \"\",\n \"interchange_fee\": null,\n \"batch_id\": \"\",\n \"batched_at\": \"2018-12-19 14:23:43\",\n \"emv_response\": \"\",\n \"avs_response\": \"\",\n \"cvv_response\": \"\",\n \"pos_entry\": \"\",\n \"pos_salesperson\": \"\",\n \"receipt_email_at\": null,\n \"receipt_sms_at\": null,\n \"settled_at\": null,\n \"created_at\": \"2018-12-19 19:23:43\",\n \"updated_at\": \"2018-12-19 19:23:43\",\n \"gateway_id\": null,\n \"total_refunded\": 0,\n \"is_refundable\": false,\n \"is_voided\": false,\n \"is_voidable\": false,\n \"schedule_id\": null,\n \"child_captures\": [],\n \"parent_auth\": null,\n \"gateway_name\": \"\",\n \"customer\": {\n \"id\": \"df25411e-4b01-4efe-8368-496b959b253f\",\n \"firstname\": \"Swipe\",\n \"lastname\": \"Customer\",\n \"company\": \"\",\n \"email\": \"\",\n \"cc_emails\": null,\n \"cc_sms\": null,\n \"phone\": \"\",\n \"address_1\": \"\",\n \"address_2\": \"\",\n \"address_city\": \"\",\n \"address_state\": \"\",\n \"address_zip\": \"\",\n \"address_country\": \"\",\n \"notes\": \"\",\n \"reference\": \"Physical Terminal customer\",\n \"options\": null,\n \"created_at\": \"2018-12-19 19:23:43\",\n \"updated_at\": \"2018-12-19 19:23:43\",\n \"deleted_at\": null,\n \"allow_invoice_credit_card_payments\": true,\n \"gravatar\": false\n },\n \"child_transactions\": [],\n \"files\": [],\n \"payment_method\": null,\n \"user\": {\n \"id\": \"61822412-09b3-4f5a-a90f-fd9f1db703b4\",\n \"name\": \"David Johnson\",\n \"email\": \"demo1@abc.com\",\n \"email_verification_sent_at\": \"2018-09-27 15:24:38\",\n \"email_verified_at\": \"2017-12-05 19:05:53\",\n \"is_api_key\": false,\n \"acknowledgments\": {\n \"setPassword\": true,\n \"godviewOmniSearchTooltip\": true,\n \"tutorial\": true,\n \"godviewWelcome\": true\n },\n \"created_at\": \"2016-12-05 19:05:53\",\n \"updated_at\": \"2018-11-20 14:51:28\",\n \"deleted_at\": null,\n \"brand\": \"Stax\",\n \"gravatar\": \"//www.gravatar.com/avatar/1cd5aef1d36d07e495abb73061f857d4\",\n \"team_admin\": null,\n \"team_enabled\": null,\n \"team_role\": null,\n \"merchant_options\": [],\n \"is_default\": false\n }\n}" } }, "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "71d7f9ec-59d9-4fab-891e-fa612cd2e275" }, "invoice_id": { "type": "string", "example": "02936d77-93cc-48a6-b712-7f7234c19b7c" }, "reference_id": { "type": "string", "example": "" }, "recurring_transaction_id": { "type": "string", "example": "" }, "auth_id": {}, "type": { "type": "string", "example": "charge" }, "source": { "type": "string", "example": "terminalservice.dejavoo" }, "source_ip": { "type": "string", "example": "127.0.0.1" }, "is_merchant_present": { "type": "boolean", "example": true, "default": true }, "merchant_id": { "type": "string", "example": "07420820-9b00-4816-9199-2071af7019f4" }, "user_id": { "type": "string", "example": "61822412-09b3-4f5a-a90f-fd9f1db703b4" }, "customer_id": { "type": "string", "example": "df25411e-4b01-4efe-8368-496b959b253f" }, "payment_method_id": {}, "is_manual": { "type": "boolean", "example": true, "default": true }, "success": { "type": "boolean", "example": false, "default": true }, "message": { "type": "string", "example": "terminalservice.waiting" }, "meta": { "type": "object", "properties": { "lineItems": { "type": "array" }, "tax": { "type": "integer", "example": 0, "default": 0 }, "subtotal": { "type": "number", "example": 0.01, "default": 0 }, "printReceipt": { "type": "string", "example": "Merchant" }, "paymentType": { "type": "string", "example": "Credit" }, "invoiceId": { "type": "string", "example": "02936d77-93cc-48a6-b712-7f7234c19b7c" }, "message": { "type": "string", "example": "terminalservice.waiting" }, "type": { "type": "string", "example": "charge" }, "registerId": { "type": "string", "example": "ba5c-5b03" }, "registerStatusPort": { "type": "string", "example": "3594291" }, "registerNickname": { "type": "string", "example": "Dejavoo Z8" }, "registerSerial": { "type": "string", "example": "" }, "registerType": { "type": "string", "example": "dejavoo" } } }, "total": { "type": "number", "example": 0.01, "default": 0 }, "method": { "type": "string", "example": "card" }, "pre_auth": { "type": "boolean", "example": false, "default": true }, "is_captured": { "type": "integer", "example": 0, "default": 0 }, "last_four": { "type": "string", "example": "" }, "interchange_code": { "type": "string", "example": "" }, "interchange_fee": {}, "batch_id": { "type": "string", "example": "" }, "batched_at": { "type": "string", "example": "2018-12-19 14:23:43" }, "emv_response": { "type": "string", "example": "" }, "avs_response": { "type": "string", "example": "" }, "cvv_response": { "type": "string", "example": "" }, "pos_entry": { "type": "string", "example": "" }, "pos_salesperson": { "type": "string", "example": "" }, "receipt_email_at": {}, "receipt_sms_at": {}, "settled_at": {}, "created_at": { "type": "string", "example": "2018-12-19 19:23:43" }, "updated_at": { "type": "string", "example": "2018-12-19 19:23:43" }, "gateway_id": {}, "total_refunded": { "type": "integer", "example": 0, "default": 0 }, "is_refundable": { "type": "boolean", "example": false, "default": true }, "is_voided": { "type": "boolean", "example": false, "default": true }, "is_voidable": { "type": "boolean", "example": false, "default": true }, "schedule_id": {}, "child_captures": { "type": "array" }, "parent_auth": {}, "gateway_name": { "type": "string", "example": "" }, "customer": { "type": "object", "properties": { "id": { "type": "string", "example": "df25411e-4b01-4efe-8368-496b959b253f" }, "firstname": { "type": "string", "example": "Swipe" }, "lastname": { "type": "string", "example": "Customer" }, "company": { "type": "string", "example": "" }, "email": { "type": "string", "example": "" }, "cc_emails": {}, "cc_sms": {}, "phone": { "type": "string", "example": "" }, "address_1": { "type": "string", "example": "" }, "address_2": { "type": "string", "example": "" }, "address_city": { "type": "string", "example": "" }, "address_state": { "type": "string", "example": "" }, "address_zip": { "type": "string", "example": "" }, "address_country": { "type": "string", "example": "" }, "notes": { "type": "string", "example": "" }, "reference": { "type": "string", "example": "Physical Terminal customer" }, "options": {}, "created_at": { "type": "string", "example": "2018-12-19 19:23:43" }, "updated_at": { "type": "string", "example": "2018-12-19 19:23:43" }, "deleted_at": {}, "allow_invoice_credit_card_payments": { "type": "boolean", "example": true, "default": true }, "gravatar": { "type": "boolean", "example": false, "default": true } } }, "child_transactions": { "type": "array" }, "files": { "type": "array" }, "payment_method": {}, "user": { "type": "object", "properties": { "id": { "type": "string", "example": "61822412-09b3-4f5a-a90f-fd9f1db703b4" }, "name": { "type": "string", "example": "David Johnson" }, "email": { "type": "string", "example": "demo1@abc.com" }, "email_verification_sent_at": { "type": "string", "example": "2018-09-27 15:24:38" }, "email_verified_at": { "type": "string", "example": "2017-12-05 19:05:53" }, "is_api_key": { "type": "boolean", "example": false, "default": true }, "acknowledgments": { "type": "object", "properties": { "setPassword": { "type": "boolean", "example": true, "default": true }, "godviewOmniSearchTooltip": { "type": "boolean", "example": true, "default": true }, "tutorial": { "type": "boolean", "example": true, "default": true }, "godviewWelcome": { "type": "boolean", "example": true, "default": true } } }, "created_at": { "type": "string", "example": "2016-12-05 19:05:53" }, "updated_at": { "type": "string", "example": "2018-11-20 14:51:28" }, "deleted_at": {}, "brand": { "type": "string", "example": "Stax" }, "gravatar": { "type": "string", "example": "//www.gravatar.com/avatar/1cd5aef1d36d07e495abb73061f857d4" }, "team_admin": {}, "team_enabled": {}, "team_role": {}, "merchant_options": { "type": "array" }, "is_default": { "type": "boolean", "example": false, "default": true } } } } } } } } }, "deprecated": false, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "number", "description": "(Min: 0.01) The dollar amount a customer is charged. This field is required and will be the amount a customer is charged. If tip prompting is enabled, the selected tip will be added to this total.", "format": "float" }, "meta": { "type": "object", "required": true, "description": "(required, json literal) i.e. {\"tax\":2,\"subtotal\":10} can contain any json object. Will be blindly stored and returned during a GET operation. Values in meta may also appear in an email receipt if the template calls for it. The Stax front-end uses subtotal, tax, memo, lineItems = [].", "properties": {} }, "register": { "type": "string", "required": true, "description": "The id of the register performing this operation. This should be the 'id' value returned by GET /terminal/register, not the serial or status_port." }, "printReceipt": { "type": "string", "enum": [ "No", "Merchant", "Customer", "Both" ], "description": "Possible values: No, Merchant, Customer, Both. Defaults to Both.", "default": "both" }, "promptCardType": { "type": "boolean", "description": "If true, will prompt the user to select Credit or Debit for this transaction.", "default": "true" }, "paymentType": { "type": "string", "enum": [ "Credit", "Debit", "Check", "Gift", "Loyalty" ], "default": "Credit", "description": "Possible values: Credit, Debit, Check, Gift, Loyalty. Defaults to Credit." }, "customerId": { "type": "string", "description": "The id of the customer attributed to this charge." }, "invoiceId": { "type": "string", "description": "The id of the invoice attributed to this charge." }, "promptTipInput": { "type": "boolean", "description": "If true, will prompt the user to input a custom tip that will be added to total and set to meta.tip. promptTipInput and promptTipChoice cannot both be true. (defaults to false)", "default": "false" }, "promptTipChoice": { "type": "boolean", "description": "If true, will prompt the user to select a tip from a list defined by either percentageTipChoices or wholeTipChoices. The selected tip will be added to total and set to meta.tip. ", "default": "false" }, "percentageTipThreshold": { "type": "integer", "format": "int32", "default": "10", "description": "If total is greater than or equal to percentageTipThreshold, percentageTipChoices will be used. If the total is less than percentageTipThreshold, wholeTipChoices will be used. (defaults to 10)" }, "percentageTipChoices": { "type": "array", "description": "The array of tip percentages to show to the user. Tip amount will be automatically calculated and shown alongside the percent.", "items": { "type": "integer", "format": "int32" }, "default": "15,18,20,25" }, "wholeTipChoices": { "type": "array", "items": { "type": "string" }, "description": "The array of flat dollar amount tips to show to the user. Defaults to [1, 3, 5].", "default": "1,3,5" }, "tokenize": { "type": "boolean", "description": "This value is ignored unless the CP tokenization feature is enabled. If true, the system will attempt to tokenize the card and attach it to the customer associated with customerId. Please reach out to Stax for more information about enabling the CP tokenization feature." } }, "required": [ "total", "register" ] } } } } } }, "/terminal/charge": { "post": { "summary": "Charge", "description": "Initiates a card-present sale (auth + capture) on a paired terminal. The initial synchronous response will often have `success = false` and a `message` like `terminalservice.waiting` while the customer is interacting with the device. Poll `GET /terminal/{registerId}/status/{transactionId}` (or listen for webhooks, if configured) until the transaction reaches an approved or declined state.\n\nWorkflow:\n1. POST this endpoint with `total`, `register`, optional `invoiceId`, and `meta` fields.\n2. Terminal wakes and prompts customer to insert, tap, or swipe.\n3. (Optional) Signature / additional prompts may fire based on card brand, amount, or merchant configuration.\n4. Status endpoint returns approved/declined details; final transaction object will have `success = true` when approved.\n\nKey Fields:\n- `total`: Decimal amount in dollars; must be >= 0.01; negative values are not allowed.\n- `meta.lineItems`: Array of { price, quantity, item, details } used for receipts & reporting (schema not previously documented).\n- `printReceipt`: One of Merchant|Customer|Both|No; defaults to Both. If the hardware cannot print, receipt is silently skipped.\n- `paymentType`: Currently most terminals default to `Credit`; `Debit`, `Gift`, etc. depend on device/gateway support.\n- `tokenize`: If card-present tokenization feature is enabled and true, Stax will attempt to create a reusable payment method after settlement (see Settlement Tokenization).\n- `invoiceId`: Link the sale to an existing invoice for reporting and partial payments.\n\nBusiness Rules:\n- Pre-authorizations: For variable final amounts, pass `pre_auth = true` (if supported); capture later via standard transaction endpoints.\n- Idempotency: Provide a unique `idempotency_id` in `meta` if you need safe retries; duplicate will return original transaction.\n- Tips: If supported by device configuration, tip prompts may occur automatically (not defined in schema here).\n- Custom Fees: Card-present sales cannot use `meta.customFee`.\n\nErrors & States:\n- 422 validation errors before reaching a gateway (e.g. missing register).\n- 400 gateway errors after processing attempt (e.g. decline).\n- Cancellation: Customer or merchant cancels; `cancelled = true`.\n- Offline Approval: Terminals may approve offline; final capture occurs at batch close.\n\nSecurity: Requires ApiKeyAuth or EphemeralAuth. PartnerApiKey may be required for advanced features (e.g. settlement tokenization enablement).\n\nPCI: Raw PAN data never passes through your application; terminal handles encryption.\n\nPolling Recommendation: 1\u20132s interval, max 30 attempts, then surface a timeout error and instruct merchant to check device.\n\nReceipts: Email/SMS receipts can be triggered using transaction receipt endpoints after approval.", "security": [ { "ApiKeyAuth": [] }, { "EphemeralAuth": [] } ], "operationId": "charge", "parameters": [], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"id\": \"71d7f9ec-59d9-4fab-891e-fa612cd2e275\",\n \"invoice_id\": \"02936d77-93cc-48a6-b712-7f7234c19b7c\",\n \"reference_id\": \"\",\n \"recurring_transaction_id\": \"\",\n \"auth_id\": null,\n \"type\": \"charge\",\n \"source\": \"terminalservice.dejavoo\",\n \"source_ip\": \"127.0.0.1\",\n \"is_merchant_present\": true,\n \"merchant_id\": \"07420820-9b00-4816-9199-2071af7019f4\",\n \"user_id\": \"61822412-09b3-4f5a-a90f-fd9f1db703b4\",\n \"customer_id\": \"df25411e-4b01-4efe-8368-496b959b253f\",\n \"payment_method_id\": null,\n \"is_manual\": true,\n \"success\": false,\n \"message\": \"terminalservice.waiting\",\n \"meta\": {\n \"lineItems\": [],\n \"tax\": 0,\n \"subtotal\": 0.01,\n \"printReceipt\": \"Merchant\",\n \"paymentType\": \"Credit\",\n \"invoiceId\": \"02936d77-93cc-48a6-b712-7f7234c19b7c\",\n \"message\": \"terminalservice.waiting\",\n \"type\": \"charge\",\n \"registerId\": \"ba5c-5b03\",\n \"registerStatusPort\": \"3594291\",\n \"registerNickname\": \"Dejavoo Z8\",\n \"registerSerial\": \"\",\n \"registerType\": \"dejavoo\"\n },\n \"total\": 0.01,\n \"method\": \"card\",\n \"pre_auth\": false,\n \"is_captured\": 0,\n \"last_four\": \"\",\n \"interchange_code\": \"\",\n \"interchange_fee\": null,\n \"batch_id\": \"\",\n \"batched_at\": \"2018-12-19 14:23:43\",\n \"emv_response\": \"\",\n \"avs_response\": \"\",\n \"cvv_response\": \"\",\n \"pos_entry\": \"\",\n \"pos_salesperson\": \"\",\n \"receipt_email_at\": null,\n \"receipt_sms_at\": null,\n \"settled_at\": null,\n \"created_at\": \"2018-12-19 19:23:43\",\n \"updated_at\": \"2018-12-19 19:23:43\",\n \"gateway_id\": null,\n \"total_refunded\": 0,\n \"is_refundable\": false,\n \"is_voided\": false,\n \"is_voidable\": false,\n \"schedule_id\": null,\n \"child_captures\": [],\n \"parent_auth\": null,\n \"gateway_name\": \"\",\n \"customer\": {\n \"id\": \"df25411e-4b01-4efe-8368-496b959b253f\",\n \"firstname\": \"Swipe\",\n \"lastname\": \"Customer\",\n \"company\": \"\",\n \"email\": \"\",\n \"cc_emails\": null,\n \"cc_sms\": null,\n \"phone\": \"\",\n \"address_1\": \"\",\n \"address_2\": \"\",\n \"address_city\": \"\",\n \"address_state\": \"\",\n \"address_zip\": \"\",\n \"address_country\": \"\",\n \"notes\": \"\",\n \"reference\": \"Physical Terminal customer\",\n \"options\": null,\n \"created_at\": \"2018-12-19 19:23:43\",\n \"updated_at\": \"2018-12-19 19:23:43\",\n \"deleted_at\": null,\n \"allow_invoice_credit_card_payments\": true,\n \"gravatar\": false\n },\n \"child_transactions\": [],\n \"files\": [],\n \"payment_method\": null,\n \"user\": {\n \"id\": \"61822412-09b3-4f5a-a90f-fd9f1db703b4\",\n \"name\": \"David Johnson\",\n \"email\": \"demo1@abc.com\",\n \"email_verification_sent_at\": \"2018-09-27 15:24:38\",\n \"email_verified_at\": \"2017-12-05 19:05:53\",\n \"is_api_key\": false,\n \"acknowledgments\": {\n \"setPassword\": true,\n \"godviewOmniSearchTooltip\": true,\n \"tutorial\": true,\n \"godviewWelcome\": true\n },\n \"created_at\": \"2016-12-05 19:05:53\",\n \"updated_at\": \"2018-11-20 14:51:28\",\n \"deleted_at\": null,\n \"brand\": \"Stax\",\n \"gravatar\": \"//www.gravatar.com/avatar/1cd5aef1d36d07e495abb73061f857d4\",\n \"team_admin\": null,\n \"team_enabled\": null,\n \"team_role\": null,\n \"merchant_options\": [],\n \"is_default\": false\n }\n}" } }, "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "71d7f9ec-59d9-4fab-891e-fa612cd2e275" }, "invoice_id": { "type": "string", "example": "02936d77-93cc-48a6-b712-7f7234c19b7c" }, "reference_id": { "type": "string", "example": "" }, "recurring_transaction_id": { "type": "string", "example": "" }, "auth_id": {}, "type": { "type": "string", "example": "charge" }, "source": { "type": "string", "example": "terminalservice.dejavoo" }, "source_ip": { "type": "string", "example": "127.0.0.1" }, "is_merchant_present": { "type": "boolean", "example": true, "default": true }, "merchant_id": { "type": "string", "example": "07420820-9b00-4816-9199-2071af7019f4" }, "user_id": { "type": "string", "example": "61822412-09b3-4f5a-a90f-fd9f1db703b4" }, "customer_id": { "type": "string", "example": "df25411e-4b01-4efe-8368-496b959b253f" }, "payment_method_id": {}, "is_manual": { "type": "boolean", "example": true, "default": true }, "success": { "type": "boolean", "example": false, "default": true }, "message": { "type": "string", "example": "terminalservice.waiting" }, "meta": { "type": "object", "properties": { "lineItems": { "type": "array" }, "tax": { "type": "integer", "example": 0, "default": 0 }, "subtotal": { "type": "number", "example": 0.01, "default": 0 }, "printReceipt": { "type": "string", "example": "Merchant" }, "paymentType": { "type": "string", "example": "Credit" }, "invoiceId": { "type": "string", "example": "02936d77-93cc-48a6-b712-7f7234c19b7c" }, "message": { "type": "string", "example": "terminalservice.waiting" }, "type": { "type": "string", "example": "charge" }, "registerId": { "type": "string", "example": "ba5c-5b03" }, "registerStatusPort": { "type": "string", "example": "3594291" }, "registerNickname": { "type": "string", "example": "Dejavoo Z8" }, "registerSerial": { "type": "string", "example": "" }, "registerType": { "type": "string", "example": "dejavoo" } } }, "total": { "type": "number", "example": 0.01, "default": 0 }, "method": { "type": "string", "example": "card" }, "pre_auth": { "type": "boolean", "example": false, "default": true }, "is_captured": { "type": "integer", "example": 0, "default": 0 }, "last_four": { "type": "string", "example": "" }, "interchange_code": { "type": "string", "example": "" }, "interchange_fee": {}, "batch_id": { "type": "string", "example": "" }, "batched_at": { "type": "string", "example": "2018-12-19 14:23:43" }, "emv_response": { "type": "string", "example": "" }, "avs_response": { "type": "string", "example": "" }, "cvv_response": { "type": "string", "example": "" }, "pos_entry": { "type": "string", "example": "" }, "pos_salesperson": { "type": "string", "example": "" }, "receipt_email_at": {}, "receipt_sms_at": {}, "settled_at": {}, "created_at": { "type": "string", "example": "2018-12-19 19:23:43" }, "updated_at": { "type": "string", "example": "2018-12-19 19:23:43" }, "gateway_id": {}, "total_refunded": { "type": "number", "example": 0, "default": 0 }, "is_refundable": { "type": "boolean", "example": false, "default": true }, "is_voided": { "type": "boolean", "example": false, "default": true }, "is_voidable": { "type": "boolean", "example": false, "default": true }, "schedule_id": {}, "child_captures": { "type": "array" }, "parent_auth": {}, "gateway_name": { "type": "string", "example": "" }, "customer": { "type": "object", "properties": { "id": { "type": "string", "example": "df25411e-4b01-4efe-8368-496b959b253f" }, "firstname": { "type": "string", "example": "Swipe" }, "lastname": { "type": "string", "example": "Customer" }, "company": { "type": "string", "example": "" }, "email": { "type": "string", "example": "" }, "cc_emails": {}, "cc_sms": {}, "phone": { "type": "string", "example": "" }, "address_1": { "type": "string", "example": "" }, "address_2": { "type": "string", "example": "" }, "address_city": { "type": "string", "example": "" }, "address_state": { "type": "string", "example": "" }, "address_zip": { "type": "string", "example": "" }, "address_country": { "type": "string", "example": "" }, "notes": { "type": "string", "example": "" }, "reference": { "type": "string", "example": "Physical Terminal customer" }, "options": {}, "created_at": { "type": "string", "example": "2018-12-19 19:23:43" }, "updated_at": { "type": "string", "example": "2018-12-19 19:23:43" }, "deleted_at": {}, "allow_invoice_credit_card_payments": { "type": "boolean", "example": true, "default": true }, "gravatar": { "type": "boolean", "example": false, "default": true } } }, "child_transactions": { "type": "array" }, "files": { "type": "array" }, "payment_method": {}, "user": { "type": "object", "properties": { "id": { "type": "string", "example": "61822412-09b3-4f5a-a90f-fd9f1db703b4" }, "name": { "type": "string", "example": "David Johnson" }, "email": { "type": "string", "example": "demo1@abc.com" }, "email_verification_sent_at": { "type": "string", "example": "2018-09-27 15:24:38" }, "email_verified_at": { "type": "string", "example": "2017-12-05 19:05:53" }, "is_api_key": { "type": "boolean", "example": false, "default": true }, "acknowledgments": { "type": "object", "properties": { "setPassword": { "type": "boolean", "example": true, "default": true }, "godviewOmniSearchTooltip": { "type": "boolean", "example": true, "default": true }, "tutorial": { "type": "boolean", "example": true, "default": true }, "godviewWelcome": { "type": "boolean", "example": true, "default": true } } }, "created_at": { "type": "string", "example": "2016-12-05 19:05:53" }, "updated_at": { "type": "string", "example": "2018-11-20 14:51:28" }, "deleted_at": {}, "brand": { "type": "string", "example": "Stax" }, "gravatar": { "type": "string", "example": "//www.gravatar.com/avatar/1cd5aef1d36d07e495abb73061f857d4" }, "team_admin": {}, "team_enabled": {}, "team_role": {}, "merchant_options": { "type": "array" }, "is_default": { "type": "boolean", "example": false, "default": true } } } } } } } } }, "deprecated": false, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "number", "description": "(Min: 0.01) The dollar amount a customer is charged. This field is required and will be the amount a customer is charged. If tip prompting is enabled, the selected tip will be added to this total." }, "meta": { "type": "object", "required": true, "description": "(required, json literal) i.e. {\"tax\":2,\"subtotal\":10} can contain any json object. Will be blindly stored and returned during a GET operation. Values in meta may also appear in an email receipt if the template calls for it. The Stax front-end uses subtotal, tax, memo, lineItems = [].", "properties": {} }, "register": { "type": "string", "required": true, "description": "The id of the register performing this operation. This should be the 'id' value returned by GET /terminal/register, not the serial or status_port." }, "printReceipt": { "type": "string", "enum": [ "Merchant", "Customer", "Both", "No" ], "description": "Possible values: No, Merchant, Customer, Both. Defaults to Both.", "default": "Both" }, "promptCardType": { "type": "boolean", "description": "If true, will prompt the user to select Credit or Debit for this transaction.", "default": "true" }, "paymentType": { "type": "string", "enum": [ "Credit", "Debit", "Gift", "Loyalty", "Check" ], "default": "Credit", "description": "Possible values: Credit, Debit, Check, Gift, Loyalty. Defaults to Credit." }, "customerId": { "type": "string", "description": "The id of the customer attributed to this charge." }, "invoiceId": { "type": "string", "description": "The id of the invoice attributed to this charge." }, "promptTipInput": { "type": "boolean", "description": "If true, will prompt the user to input a custom tip that will be added to total and set to meta.tip. promptTipInput and promptTipChoice cannot both be true. Defaults to false.", "default": "false" }, "promptTipChoice": { "type": "boolean", "description": "If true, will prompt the user to select a tip from a list defined by either percentageTipChoices or wholeTipChoices. The selected tip will be added to total and set to meta.tip. See the following params for more details. Defaults to false.", "default": "false" }, "percentageTipThreshold": { "type": "number", "default": "10", "description": "If total is greater than or equal to percentageTipThreshold, percentageTipChoices will be used. If the total is less than percentageTipThreshold, wholeTipChoices will be used. Defaults to 10." }, "percentageTipChoices": { "type": "array", "items": { "type": "integer", "format": "int32" }, "default": "15,18,20,25", "description": "The array of tip percentages to show to the user. Tip amount will be automatically calculated and shown alongside the percent. Defaults to [15, 20, 25]." }, "wholeTipChoices": { "type": "array", "default": "1,3,5", "description": "The array of flat dollar amount tips to show to the user. Defaults to [1, 3, 5].", "items": { "type": "string" } }, "tokenize": { "type": "boolean", "description": "This value is ignored unless the CP tokenization feature is enabled. If true, the system will attempt to tokenize the card and attach it to the customer associated with customerId. Please reach out to Stax for more information about enabling the CP tokenization feature." } }, "required": [ "total", "register" ] } } } } } }, "/self/exists": { "get": { "summary": "Check if E-Mail Exists", "description": "Verifies if the inputted email is valid", "operationId": "check-if-e-mail-exists", "parameters": [ { "name": "email", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n true\n}" } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"email\": [\n \"The user cannot be found\"\n ]\n}" } }, "schema": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string", "example": "The user cannot be found" } } } } } } } }, "deprecated": false } }, "/merchant": { "post": { "summary": "Create a Merchant", "description": "Creates a new merchant", "operationId": "create-a-merchant", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "company_name": { "type": "string", "description": "Name of the company" }, "contact_name": { "type": "string", "description": "Name of the main contact person for the company." }, "contact_email": { "type": "string", "description": "Email for communication." }, "contact_phone": { "type": "string", "description": "Phone number of the company." }, "address_1": { "type": "string", "description": "Address of the company." }, "Address_2": { "type": "string" }, "address_city": { "type": "string", "description": "CIty of the company location." }, "address_state": { "type": "string", "description": "2 letter abbreviation of the state where the company is located." }, "Address_zip": { "type": "string", "description": "Zip code of the company." }, "hosted_payments_token": { "type": "string", "description": "Payment token." }, "currency": { "type": "string", "description": "Three letter abbreviation of the currency. e.g., USD." }, "reference": { "type": "string", "description": "This reference field can be used as an external identifier, and can be used to filter the GET /merchant API." } } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"id\": \"9cbfffba-33e2-4d25-aa2b-11e9bc11c301\",\n \"mid\": \"\",\n \"status\": \"ACTIVE\",\n \"subdomain\": \"\",\n \"company_name\": \"Stax\",\n \"display_name\": \"Stax\",\n \"contact_name\": \"Stax\",\n \"contact_email\": \"contact@example.com\",\n \"contact_phone\": \"8555503288\",\n \"address_1\": \"25 Wall Street\",\n \"address_2\": \"Suite 1\",\n \"address_city\": \"Orlando\",\n \"address_state\": \"FL\",\n \"address_zip\": \"32801\",\n \"hosted_payments_token\": \"CompanyName-c3073a83d4a2\",\n \"currency\": [\n \"USD\"\n ],\n \"plan\": {\n \"id\": \"1de08ed1-27e3-4e5a-bc17-ea76444b636c\",\n \"merchant_id\": \"9cbfffba-33e2-4d25-aa2b-11e9bc11c301\",\n \"user_id\": \"user1\",\n \"name\": \"premium\",\n \"created_at\": \"2020-02-17 13:35:11\",\n \"updated_at\": \"2020-02-17 13:35:11\"\n },\n \"options\": [],\n \"notes\": \"\",\n \"gateway_type\": null,\n \"vendor_keys\": [],\n \"processor\": \"\",\n \"partner\": null,\n \"product_type\": \"\",\n \"is_enterprise\": false,\n \"is_payfac\": false,\n \"fm_billing_schedule_id\": null,\n \"welcome_email_sent_at\": null,\n \"created_at\": \"2020-02-17 13:35:11\",\n \"updated_at\": \"2020-02-17 13:35:11\",\n \"deleted_at\": null,\n \"brand\": \"fattmerchant\",\n \"branding\": null,\n \"allow_ach\": false,\n \"is_portal\": false,\n \"allow_credits\": false,\n \"allow_terminal\": false,\n \"users\": [],\n \"reference\": \"Entity00000\"}" } }, "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "9cbfffba-33e2-4d25-aa2b-11e9bc11c301" }, "mid": { "type": "string", "example": "" }, "status": { "type": "string", "example": "ACTIVE" }, "subdomain": { "type": "string", "example": "" }, "company_name": { "type": "string", "example": "Stax" }, "display_name": { "type": "string", "example": "Stax" }, "contact_name": { "type": "string", "example": "Stax" }, "contact_email": { "type": "string", "example": "contact@example.com" }, "contact_phone": { "type": "string", "example": "8555503288" }, "address_1": { "type": "string", "example": "25 Wall Street" }, "address_2": { "type": "string", "example": "Suite 1" }, "address_city": { "type": "string", "example": "Orlando" }, "address_state": { "type": "string", "example": "FL" }, "address_zip": { "type": "string", "example": "32801" }, "hosted_payments_token": { "type": "string", "example": "CompanyName-c3073a83d4a2" }, "currency": { "type": "array", "items": { "type": "string", "example": "USD" } }, "plan": { "type": "object", "properties": { "id": { "type": "string", "example": "1de08ed1-27e3-4e5a-bc17-ea76444b636c" }, "merchant_id": { "type": "string", "example": "9cbfffba-33e2-4d25-aa2b-11e9bc11c301" }, "user_id": { "type": "string", "example": "user1" }, "name": { "type": "string", "example": "premium" }, "created_at": { "type": "string", "example": "2020-02-17 13:35:11" }, "updated_at": { "type": "string", "example": "2020-02-17 13:35:11" } } }, "options": { "type": "array" }, "notes": { "type": "string", "example": "" }, "gateway_type": {}, "vendor_keys": { "type": "array" }, "processor": { "type": "string", "example": "" }, "partner": {}, "product_type": { "type": "string", "example": "" }, "is_enterprise": { "type": "boolean", "example": false, "default": true }, "is_payfac": { "type": "boolean", "example": false, "default": true }, "fm_billing_schedule_id": {}, "welcome_email_sent_at": {}, "created_at": { "type": "string", "example": "2020-02-17 13:35:11" }, "updated_at": { "type": "string", "example": "2020-02-17 13:35:11" }, "deleted_at": {}, "brand": { "type": "string", "example": "fattmerchant" }, "branding": {}, "allow_ach": { "type": "boolean", "example": false, "default": true }, "is_portal": { "type": "boolean", "example": false, "default": true }, "allow_credits": { "type": "boolean", "example": false, "default": true }, "allow_terminal": { "type": "boolean", "example": false, "default": true }, "users": { "type": "array" }, "reference": { "type": "string", "example": "Entity00000" } } } } } }, "422": { "description": "422", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"company_name\": [\n \"The company name field is required.\"\n ],\n \"contact_email\": [\n \"The contact email field is required.\"\n ]\n}" } }, "schema": { "type": "object", "properties": { "company_name": { "type": "array", "items": { "type": "string", "example": "The company name field is required." } }, "contact_email": { "type": "array", "items": { "type": "string", "example": "The contact email field is required." } } } } } } } }, "deprecated": false, "security": [ { "PartnerApiKey": [] } ] }, "get": { "summary": "Get all Merchants", "description": "Returns paginated data for all of your merchants", "operationId": "get-all-merchants", "parameters": [ { "name": "per_page", "in": "query", "description": "Determines how many records will be returned per page.", "schema": { "type": "integer", "format": "int32" } }, { "name": "page", "in": "query", "description": "Returns data for the page given.", "schema": { "type": "integer", "format": "int32" } }, { "name": "statuses[]", "in": "query", "description": "Returns the merchant(s) with the given merchant status(es). Possible values: ACTIVE, PENDING, INACTIVE.", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "reference", "in": "query", "description": "Filters merchants whose reference field holds the exact value specified.", "schema": { "type": "string" } }, { "name": "risk_hold", "in": "query", "description": "Filters merchants who have a risk hold on their account.", "schema": { "type": "boolean" } }, { "name": "ids[]", "in": "query", "description": "Returns the merchant(s) with the given merchant id(s).", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "contact_email", "in": "query", "description": "Returns all merchants with the given email.", "schema": { "type": "string" } }, { "name": "contact_phone", "in": "query", "description": "Returns all merchants with the given phone number.", "schema": { "type": "string" } }, { "name": "contact_name", "in": "query", "description": "Returns all merchants with the given name.", "schema": { "type": "string" } }, { "name": "company_name", "in": "query", "description": "Returns all merchants with the given company name.", "schema": { "type": "string" } }, { "name": "address_city", "in": "query", "description": "Returns all merchants in a given city.", "schema": { "type": "string" } }, { "name": "address_state", "in": "query", "description": "Returns all merchants in a given state.", "schema": { "type": "string" } }, { "name": "address_zip", "in": "query", "description": "Returns all merchants in a given zip code.", "schema": { "type": "string" } }, { "name": "sort", "in": "query", "description": "The property by which the results are sorted.", "schema": { "type": "string", "enum": [ "created_at", "updated_at", "status" ] } }, { "name": "order", "in": "query", "description": "The order in which the results are sorted.", "schema": { "type": "string", "enum": [ "DESC", "ASC" ] } } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"current_page\": 3,\n \"data\": [\n {\n \"id\": \"87e7872f-ba17-4e6a-aa6f-3346a7345444\",\n \"mid\": \"\",\n \"status\": \"PENDING\",\n \"subdomain\": \"\",\n \"company_name\": \"Company\",\n \"display_name\": \"Company\",\n \"contact_name\": \"\",\n \"contact_email\": \"contact@example.com\",\n \"contact_phone\": \"9202856700\",\n \"address_1\": \"\",\n \"address_2\": \"\",\n \"address_city\": \"\",\n \"address_state\": \"\",\n \"address_zip\": \"\",\n \"hosted_payments_token\": \"Company-fea49bf66320\",\n \"currency\": [\n \"USD\"\n ],\n \"plan\": {\n \"id\": \"a513f85f-f944-4aa2-bee0-75dd1bce9275\",\n \"merchant_id\": \"87e7872f-ba17-4e6a-aa6f-3346a7345444\",\n \"user_id\": \"992f0ffc-03a9-47d7-9eff-5c170c78e830\",\n \"name\": \"portal\",\n \"created_at\": \"2020-05-05 19:43:20\",\n \"updated_at\": \"2020-05-05 19:43:20\"\n },\n \"options\": null,\n \"notes\": \"\",\n \"gateway_type\": null,\n \"vendor_keys\": null,\n \"processor\": \"\",\n \"partner\": null,\n \"product_type\": \"\",\n \"is_enterprise\": false,\n \"is_payfac\": false,\n \"fm_billing_schedule_id\": null,\n \"welcome_email_sent_at\": null,\n \"created_at\": \"2020-05-05 19:43:20\",\n \"updated_at\": \"2020-05-05 19:43:20\",\n \"deleted_at\": null,\n \"brand\": \"fattmerchant\",\n \"branding\": null,\n \"allow_ach\": false,\n \"is_portal\": true,\n \"allow_credits\": false,\n \"allow_terminal\": false,\n \"users\": []\n },\n {\n \"id\": \"249196af-fcc0-4f8a-bf13-64e9be20df4a\",\n \"mid\": \"\",\n \"status\": \"PENDING\",\n \"subdomain\": \"\",\n \"company_name\": \"Company\",\n \"display_name\": \"Company\",\n \"contact_name\": \"\",\n \"contact_email\": \"contact@example.com\",\n \"contact_phone\": \"9202856700\",\n \"address_1\": \"\",\n \"address_2\": \"\",\n \"address_city\": \"\",\n \"address_state\": \"\",\n \"address_zip\": \"\",\n \"hosted_payments_token\": \"Company-1eb16c7e33e3\",\n \"currency\": [\n \"USD\"\n ],\n \"plan\": {\n \"id\": \"d8e29ffa-8d20-47c9-b40f-74add7b937d6\",\n \"merchant_id\": \"249196af-fcc0-4f8a-bf13-64e9be20df4a\",\n \"user_id\": \"992f0ffc-03a9-47d7-9eff-5c170c78e830\",\n \"name\": \"portal\",\n \"created_at\": \"2020-05-05 19:04:30\",\n \"updated_at\": \"2020-05-05 19:04:30\"\n },\n \"options\": null,\n \"notes\": \"\",\n \"gateway_type\": null,\n \"vendor_keys\": null,\n \"processor\": \"\",\n \"partner\": null,\n \"product_type\": \"\",\n \"is_enterprise\": false,\n \"is_payfac\": false,\n \"fm_billing_schedule_id\": null,\n \"welcome_email_sent_at\": null,\n \"created_at\": \"2020-05-05 19:04:30\",\n \"updated_at\": \"2020-05-05 19:04:30\",\n \"deleted_at\": null,\n \"brand\": \"fattmerchant\",\n \"branding\": null,\n \"allow_ach\": false,\n \"is_portal\": true,\n \"allow_credits\": false,\n \"allow_terminal\": false,\n \"users\": []\n }\n ],\n \"first_page_url\": \"https://apiprod.fattlabs.com//merchant?page=1\",\n \"from\": 5,\n \"last_page\": 34,\n \"last_page_url\": \"https://apiprod.fattlabs.com//merchant?page=34\",\n \"next_page_url\": \"https://apiprod.fattlabs.com//merchant?page=4\",\n \"path\": \"https://apiprod.fattlabs.com//merchant\",\n \"per_page\": \"2\",\n \"prev_page_url\": \"https://apiprod.fattlabs.com//merchant?page=2\",\n \"to\": 6,\n \"total\": 67\n}" } }, "schema": { "type": "object", "properties": { "current_page": { "type": "integer", "example": 3, "default": 0 }, "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "87e7872f-ba17-4e6a-aa6f-3346a7345444" }, "mid": { "type": "string", "example": "" }, "status": { "type": "string", "example": "PENDING" }, "subdomain": { "type": "string", "example": "" }, "company_name": { "type": "string", "example": "Company" }, "display_name": { "type": "string", "example": "Company" }, "contact_name": { "type": "string", "example": "" }, "contact_email": { "type": "string", "example": "contact@example.com" }, "contact_phone": { "type": "string", "example": "9202856700" }, "address_1": { "type": "string", "example": "" }, "address_2": { "type": "string", "example": "" }, "address_city": { "type": "string", "example": "" }, "address_state": { "type": "string", "example": "" }, "address_zip": { "type": "string", "example": "" }, "hosted_payments_token": { "type": "string", "example": "Company-fea49bf66320" }, "currency": { "type": "array", "items": { "type": "string", "example": "USD" } }, "plan": { "type": "object", "properties": { "id": { "type": "string", "example": "a513f85f-f944-4aa2-bee0-75dd1bce9275" }, "merchant_id": { "type": "string", "example": "87e7872f-ba17-4e6a-aa6f-3346a7345444" }, "user_id": { "type": "string", "example": "992f0ffc-03a9-47d7-9eff-5c170c78e830" }, "name": { "type": "string", "example": "portal" }, "created_at": { "type": "string", "example": "2020-05-05 19:43:20" }, "updated_at": { "type": "string", "example": "2020-05-05 19:43:20" } } }, "options": {}, "notes": { "type": "string", "example": "" }, "gateway_type": {}, "vendor_keys": {}, "processor": { "type": "string", "example": "" }, "partner": {}, "product_type": { "type": "string", "example": "" }, "is_enterprise": { "type": "boolean", "example": false, "default": true }, "is_payfac": { "type": "boolean", "example": false, "default": true }, "fm_billing_schedule_id": {}, "welcome_email_sent_at": {}, "created_at": { "type": "string", "example": "2020-05-05 19:43:20" }, "updated_at": { "type": "string", "example": "2020-05-05 19:43:20" }, "deleted_at": {}, "brand": { "type": "string", "example": "fattmerchant" }, "branding": {}, "allow_ach": { "type": "boolean", "example": false, "default": true }, "is_portal": { "type": "boolean", "example": true, "default": true }, "allow_credits": { "type": "boolean", "example": false, "default": true }, "allow_terminal": { "type": "boolean", "example": false, "default": true }, "users": { "type": "array" } } } }, "first_page_url": { "type": "string", "example": "https://apiprod.fattlabs.com//merchant?page=1" }, "from": { "type": "integer", "example": 5, "default": 0 }, "last_page": { "type": "integer", "example": 34, "default": 0 }, "last_page_url": { "type": "string", "example": "https://apiprod.fattlabs.com//merchant?page=34" }, "next_page_url": { "type": "string", "example": "https://apiprod.fattlabs.com//merchant?page=4" }, "path": { "type": "string", "example": "https://apiprod.fattlabs.com//merchant" }, "per_page": { "type": "string", "example": "2" }, "prev_page_url": { "type": "string", "example": "https://apiprod.fattlabs.com//merchant?page=2" }, "to": { "type": "integer", "example": 6, "default": 0 }, "total": { "type": "integer", "example": 67, "default": 0 } } } } } } }, "deprecated": false, "security": [ { "PartnerApiKey": [] } ] } }, "/merchant/{id}/apikey": { "post": { "summary": "Create a New API Key for Merchant", "description": "Generates a new API key for the specified merchant.", "operationId": "create-a-new-api-key-for-merchant", "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true, "description": "Merchant ID for which to create a new API key." } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "description": " Name for the key. 255 character max. Example: \"api-key-1\"" }, "team_role": { "type": "string", "enum": [ "\"admin\"", "\"staff\"", "\"full\"", "\"reporting\"" ], "description": "We recommend \"admin\" so the API key can be used for all routes.", "default": "full" } } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{}" } }, "schema": { "type": "object", "properties": {} } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "{}" } }, "schema": { "type": "object", "properties": {} } } } } }, "deprecated": false, "security": [ { "PartnerApiKey": [] } ] }, "get": { "summary": "List API Keys for Merchant", "description": "Lists all API keys associated with the specified merchant.", "operationId": "list-api-keys-for-merchant", "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true, "description": "ID of the merchant." } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": " {\n \"current_page\": 1,\n \"data\": [\n {\n \"id\": \"ebf007e4-90c9-4764-b8be-4b2a21a7deda\",\n \"name\": \"api-key-1\",\n \"email\": null,\n \"email_verification_sent_at\": null,\n \"email_verified_at\": null,\n \"created_at\": \"2019-06-19 20:32:15\",\n \"updated_at\": \"2019-06-19 20:32:15\",\n \"deleted_at\": null,\n \"gravatar\": \"//www.gravatar.com/avatar/d41d8cd98f00b204e9800998ecf8427e\",\n \"team_role\": \"full\",\n \"team_admin\": false,\n \"team_enabled\": true,\n \"api_key\": \"THIS_VALUE_WILL_CONTAIN_JWT_STRING\"\n },\n {\n \"id\": \"71626cac-ba4e-4c71-a8d3-315a279b8ef1\",\n \"name\": \"api-key-2\",\n \"email\": null,\n \"email_verification_sent_at\": null,\n \"email_verified_at\": null,\n \"created_at\": \"2019-06-19 20:32:11\",\n \"updated_at\": \"2019-06-19 20:32:11\",\n \"deleted_at\": null,\n \"gravatar\": \"//www.gravatar.com/avatar/d41d8cd98f00b204e9800998ecf8427e\",\n \"team_role\": \"full\",\n \"team_admin\": false,\n \"team_enabled\": true,\n \"api_key\": \"THIS_VALUE_WILL_CONTAIN_JWT_STRING\"\n },\n ],\n \"from\": 1,\n \"last_page\": 1,\n \"per_page\": 20,\n \"prev_page_url\": null,\n \"to\": 2,\n \"total\": 2\n }" } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "{}" } }, "schema": { "type": "object", "properties": {} } } } } }, "deprecated": false, "security": [ { "PartnerApiKey": [] } ] } }, "/team/user": { "post": { "summary": "Create a New Team Member", "description": "This creates a whole new user account in your merchant team.", "operationId": "create-a-new-team-member", "parameters": [ { "name": "email", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "password", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "password_confirmation", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "name", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "team_role", "in": "query", "schema": { "type": "string", "enum": [ "admin", "staff", "full", "sales", "reporting" ] } }, { "name": "team_enabled", "in": "query", "schema": { "type": "boolean" } }, { "name": "send_verification_email", "in": "query", "schema": { "type": "boolean" } }, { "name": "url", "in": "query", "schema": { "type": "string", "default": "https://app.staxpayments.com/#/verify/" } } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"id\": \"21a64e9e-3c13-4b85-9f85-67cb4fda808a\",\n \"system_admin\": false,\n \"name\": \"James\",\n \"email\": \"fatttest737@gmail.com\",\n \"email_verification_sent_at\": null,\n \"email_verified_at\": null,\n \"created_at\": \"2017-05-15 19:31:35\",\n \"updated_at\": \"2017-05-15 19:31:35\",\n \"deleted_at\": null,\n \"gravatar\": \"//www.gravatar.com/avatar/52b3ef2ae70945ce0fca14086443dc1a\",\n \"team_role\": \"full\",\n \"team_admin\": false,\n \"team_enabled\": true\n}" } }, "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "21a64e9e-3c13-4b85-9f85-67cb4fda808a" }, "system_admin": { "type": "boolean", "example": false, "default": true }, "name": { "type": "string", "example": "James" }, "email": { "type": "string", "example": "fatttest737@gmail.com" }, "email_verification_sent_at": {}, "email_verified_at": {}, "created_at": { "type": "string", "example": "2017-05-15 19:31:35" }, "updated_at": { "type": "string", "example": "2017-05-15 19:31:35" }, "deleted_at": {}, "gravatar": { "type": "string", "example": "//www.gravatar.com/avatar/52b3ef2ae70945ce0fca14086443dc1a" }, "team_role": { "type": "string", "example": "full" }, "team_admin": { "type": "boolean", "example": false, "default": true }, "team_enabled": { "type": "boolean", "example": true, "default": true } } } } } }, "401": { "description": "401", "content": { "application/json": { "examples": { "Result": { "value": "[\n \"not team admin\"\n]" } }, "schema": { "type": "array", "items": { "type": "string", "example": "not team admin" } } } } }, "422": { "description": "422", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"name\": [\n \"The name field is required.\"\n ],\n \"email\": [\n \"The email field is required.\"\n ],\n \"password\": [\n \"The password field is required.\"\n ]\n}" } }, "schema": { "type": "object", "properties": { "name": { "type": "array", "items": { "type": "string", "example": "The name field is required." } }, "email": { "type": "array", "items": { "type": "string", "example": "The email field is required." } }, "password": { "type": "array", "items": { "type": "string", "example": "The password field is required." } } } } } } } }, "deprecated": false }, "get": { "summary": "Find the Merchant Team's Users", "description": "Retrieves all the users on a merchants team", "operationId": "find-the-merchant-teams-users", "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"total\": 2,\n \"per_page\": 20,\n \"current_page\": 1,\n \"last_page\": 1,\n \"next_page_url\": null,\n \"prev_page_url\": null,\n \"from\": 1,\n \"to\": 2,\n \"data\": [\n {\n \"id\": \"6b5e0337-817d-4025-8729-6370173295a9\",\n \"system_admin\": false,\n \"name\": \"Eric Andrews\",\n \"email\": \"contact@example.com\",\n \"email_verification_sent_at\": \"2016-09-08 19:05:55\",\n \"email_verified_at\": \"2016-05-11 17:13:33\",\n \"created_at\": \"2015-07-21 21:23:42\",\n \"updated_at\": \"2016-09-08 19:05:55\",\n \"deleted_at\": null,\n \"gravatar\": \"//www.gravatar.com/avatar/45357c125af15b6df8864a71a653bea2\",\n \"team_role\": \"admin\",\n \"team_admin\": true,\n \"team_enabled\": true,\n \"mfa_enabled\": null\n },\n {\n \"id\": \"372a0620-47cd-447e-9fcf-0f4671bdda26\",\n \"system_admin\": false,\n \"name\": \"Jacques Fu\",\n \"email\": \"jacques.fu@gmail.com\",\n \"email_verification_sent_at\": \"2016-05-11 17:13:33\",\n \"email_verified_at\": \"2016-05-11 17:13:33\",\n \"created_at\": \"2015-07-21 21:23:42\",\n \"updated_at\": \"2015-10-29 16:40:39\",\n \"deleted_at\": null,\n \"gravatar\": \"//www.gravatar.com/avatar/30d6b71a1803013e64894ae60ec53e34\",\n \"team_role\": \"admin\",\n \"team_admin\": true,\n \"team_enabled\": true,\n \"mfa_enabled\": null\n }\n ]\n}" } }, "schema": { "type": "object", "properties": { "total": { "type": "integer", "example": 2, "default": 0 }, "per_page": { "type": "integer", "example": 20, "default": 0 }, "current_page": { "type": "integer", "example": 1, "default": 0 }, "last_page": { "type": "integer", "example": 1, "default": 0 }, "next_page_url": {}, "prev_page_url": {}, "from": { "type": "integer", "example": 1, "default": 0 }, "to": { "type": "integer", "example": 2, "default": 0 }, "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "6b5e0337-817d-4025-8729-6370173295a9" }, "system_admin": { "type": "boolean", "example": false, "default": true }, "name": { "type": "string", "example": "Eric Andrews" }, "email": { "type": "string", "example": "contact@example.com" }, "email_verification_sent_at": { "type": "string", "example": "2016-09-08 19:05:55" }, "email_verified_at": { "type": "string", "example": "2016-05-11 17:13:33" }, "created_at": { "type": "string", "example": "2015-07-21 21:23:42" }, "updated_at": { "type": "string", "example": "2016-09-08 19:05:55" }, "deleted_at": {}, "gravatar": { "type": "string", "example": "//www.gravatar.com/avatar/45357c125af15b6df8864a71a653bea2" }, "team_role": { "type": "string", "example": "admin" }, "team_admin": { "type": "boolean", "example": true, "default": true }, "team_enabled": { "type": "boolean", "example": true, "default": true }, "mfa_enabled": {} } } } } } } } } }, "deprecated": false } }, "/query/payment-links": { "post": { "summary": "Create a Payment Link", "description": "Generate a new payment link to accept payments from customers. Supports both fixed and variable payment options.", "operationId": "create-a-payment-link", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "url", "common_name" ], "properties": { "url": { "type": "string", "description": "The URL of your application where the payment page is hosted." }, "common_name": { "type": "string", "description": "A human-readable name for the payment link. This is an internal name that the customer will not see." }, "link_meta": { "properties": { "total": { "type": "number", "description": "Set total amount for payment link", "format": "float" }, "memo": { "type": "string", "description": "Appears as a message for the customer on a payment screen." }, "successRedirect": { "type": "string", "description": "The URL to which the user will be redirected after payment or tokenization." }, "frequency": { "type": "string", "description": "Specifies the frequency of the recurring payments. This field will only be respected if rrule is true." }, "rrule": { "type": "boolean", "description": "Used to set up recurring payments." }, "isTotalEditable": { "type": "boolean", "description": "Determines whether customers can edit the total amount." }, "tokenizeOnly": { "type": "boolean", "description": "Only allow a payment to be tokenized. When set to true, only memo, successRedirect, buttonText, and active will be valid meta flags." }, "areCnpDigitalWalletPaymentsAllowed": { "type": "boolean", "description": "Determines whether to accept digital wallet (Apple Pay + Google Pay) payments." }, "areBankPaymentsAllowed": { "type": "boolean", "description": "Determines whether to accept bank (ACH) payments." }, "areCreditCardsPaymentsAllowed": { "type": "boolean", "description": "Determines whether to accept card (credit, debit) payments." }, "arePaypalPaymentsAllowed": { "type": "boolean", "description": "Determines whether to accept PayPal payments." }, "areVenmoPaymentsAllowed": { "type": "boolean", "description": "Determines whether to accept Venmo payments." }, "arePaypalBnplPaymentsAllowed": { "type": "boolean", "description": "Determines whether to accept PayPal Buy Now, Pay Later." }, "buttonText": { "type": "string", "description": "The text that will appear on the payment button." }, "active": { "type": "number", "description": "This is the active status of the payment link." }, "item": { "type": "string", "description": "Item description." }, "price": { "type": "number", "description": "Price of the line item." }, "quantity": { "type": "number", "description": "quantity of the item." }, "unitOfMeasurement": { "type": "string", "description": "Unit in which the item is sold. e.g., feet, each, litre, GB." }, "tax": { "type": "number", "description": "Tax amount applied to the line item." }, "productCode": { "type": "string", "description": "Unique product code assigned to the item." } }, "required": [], "type": "object", "description": "Contains more details and settings of the payment link." }, "amount": { "type": "number", "description": "This is the amount to be paid using the link. When it is set to 0, the value can be edited during payment. When it is set to a value greater than 0, the value cannot be changed during payment, unless isTotalEditable is set to true.", "format": "float" }, "active": { "type": "number", "description": "This is the active status of the payment link. Set a value of 1 to make the link active or 0 to make it inactive. An inactive link cannot be used for payment." } } } } } }, "responses": { "201": { "description": "201", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"status\": 201,\n \"message\": \"Payment Link created\",\n \"body\": {\n \"link_meta\": {\n \"paymentLinkId\": \"11eda15bbc337c209a1b615ba5112be7\"\n },\n \"merchant_id\": \"merchant1\",\n \"common_name\": \"sameple link\",\n \"id\": \"11eda15bbc337c209a1b615ba5112be7\",\n \"tinyurl\": \"https://paymnt.io/nMeuJc\"\n }\n}" } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "example": 201, "default": 0 }, "message": { "type": "string", "example": "Payment Link created" }, "body": { "type": "object", "properties": { "link_meta": { "type": "object", "properties": { "paymentLinkId": { "type": "string", "example": "11eda15bbc337c209a1b615ba5112be7" } } }, "merchant_id": { "type": "string", "example": "merchant1" }, "common_name": { "type": "string", "example": "sameple link" }, "id": { "type": "string", "example": "11eda15bbc337c209a1b615ba5112be7" }, "tinyurl": { "type": "string", "example": "https://paymnt.io/nMeuJc" } } } } } } } }, "500": { "description": "500", "content": { "application/json": { "examples": { "Invalid funding id": { "value": "{\n \"error\": \"Invalid funding account id\",\n \"status\": 500,\n \"message\": \"Generic Error\"\n}" }, "Missing link_meta": { "value": "{\n \"error\": \"link_meta is required\",\n \"status\": 500,\n \"message\": \"Generic Error\"\n}" } }, "schema": { "oneOf": [ { "title": "Invalid funding id", "type": "object", "properties": { "error": { "type": "string", "example": "Invalid funding account id" }, "status": { "type": "integer", "example": 500, "default": 0 }, "message": { "type": "string", "example": "Generic Error" } } }, { "title": "Missing link_meta", "type": "object", "properties": { "error": { "type": "string", "example": "link_meta is required" }, "status": { "type": "integer", "example": 500, "default": 0 }, "message": { "type": "string", "example": "Generic Error" } } } ] } } } } }, "deprecated": false }, "get": { "summary": "List And Filter All Payment Links", "description": "Retrieve all payment links associated with your merchant account, with options for filtering and sorting.", "operationId": "list-and-filter-all-payment-links", "parameters": [ { "name": "active", "in": "query", "schema": { "type": "boolean" } }, { "name": "keywords[]", "in": "query", "description": "Searches across the following fields: common_name, link_meta, amount", "schema": { "type": "string" } }, { "name": "order", "in": "query", "description": "Arranges the order of the returned payment links by either ascending or descending.", "schema": { "type": "string", "enum": [ "ASC", "DESC" ] } }, { "name": "sort", "in": "query", "description": "Defines the sorting of the returned payment links.", "schema": { "type": "string", "enum": [ "common_name", "amount", "created_at", "total_sales", "total_transactions" ] } } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "No results": { "value": "{\n \"data\": {\n \"current_page\": 1,\n \"first_page_url\": \"http://localhost:3005/payment-links?page=1\",\n \"from\": 1,\n \"last_page\": 0,\n \"last_page_url\": \"http://localhost:3005/payment-links?page=0\",\n \"next_page_url\": null,\n \"path\": \"http://localhost:3005/payment-links\",\n \"per_page\": 20,\n \"prev_page_url\": null,\n \"to\": 0,\n \"total\": 0,\n \"data\": []\n }\n}" }, "Suscessful Results": { "value": "{\n \"data\": {\n \"current_page\": 1,\n \"first_page_url\": \"http://localhost:3005/payment-links?page=1\",\n \"from\": 1,\n \"last_page\": 1,\n \"last_page_url\": \"http://localhost:3005/payment-links?page=1\",\n \"next_page_url\": null,\n \"path\": \"http://localhost:3005/payment-links\",\n \"per_page\": 20,\n \"prev_page_url\": null,\n \"to\": 4,\n \"total\": 4,\n \"data\": [\n {\n \"id\": \"11eda17551d9fec08a4793a483489785\",\n \"merchant_id\": \"merchant1\",\n \"common_name\": \"sameple link\",\n \"tinyurl\": \"https://paymnt.io/eBiNgF\",\n \"link_meta\": {\n \"paymentLinkId\": \"11eda17551d9fec08a4793a483489785\"\n },\n \"active\": 1,\n \"amount\": 0,\n \"created_at\": \"2023-01-31T14:41:19.000Z\",\n \"updated_at\": null,\n \"total_sales\": 0,\n \"total_transactions\": 0\n },\n {\n \"id\": \"11eda1746cd4b1309a1b615ba5112be7\",\n \"merchant_id\": \"merchant1\",\n \"common_name\": \"sameple link\",\n \"tinyurl\": \"https://paymnt.io/6QGXt0\",\n \"link_meta\": {\n \"total\": 2000,\n \"paymentLinkId\": \"11eda1746cd4b1309a1b615ba5112be7\"\n },\n \"active\": 1,\n \"amount\": 3000,\n \"created_at\": \"2023-01-31T14:34:54.000Z\",\n \"updated_at\": null,\n \"total_sales\": 0,\n \"total_transactions\": 0\n },\n {\n \"id\": \"11eda15d8052e4a09a1b615ba5112be7\",\n \"merchant_id\": \"merchant1\",\n \"common_name\": \"sameple link\",\n \"tinyurl\": \"https://paymnt.io/nkCsAQ\",\n \"link_meta\": {\n \"total\": 2000,\n \"paymentLinkId\": \"11eda15d8052e4a09a1b615ba5112be7\"\n },\n \"active\": 1,\n \"amount\": null,\n \"created_at\": \"2023-01-31T11:50:48.000Z\",\n \"updated_at\": null,\n \"total_sales\": 0,\n \"total_transactions\": 0\n },\n {\n \"id\": \"11eda15bbc337c209a1b615ba5112be7\",\n \"merchant_id\": \"merchant1\",\n \"common_name\": \"sameple link\",\n \"tinyurl\": \"https://paymnt.io/nMeuJc\",\n \"link_meta\": {\n \"paymentLinkId\": \"11eda15bbc337c209a1b615ba5112be7\"\n },\n \"active\": 1,\n \"amount\": null,\n \"created_at\": \"2023-01-31T11:38:09.000Z\",\n \"updated_at\": null,\n \"total_sales\": 0,\n \"total_transactions\": 0\n }\n ]\n }\n}" } }, "schema": { "oneOf": [ { "title": "No results", "type": "object", "properties": { "data": { "type": "object", "properties": { "current_page": { "type": "integer", "example": 1, "default": 0 }, "first_page_url": { "type": "string", "example": "http://localhost:3005/payment-links?page=1" }, "from": { "type": "integer", "example": 1, "default": 0 }, "last_page": { "type": "integer", "example": 0, "default": 0 }, "last_page_url": { "type": "string", "example": "http://localhost:3005/payment-links?page=0" }, "next_page_url": {}, "path": { "type": "string", "example": "http://localhost:3005/payment-links" }, "per_page": { "type": "integer", "example": 20, "default": 0 }, "prev_page_url": {}, "to": { "type": "integer", "example": 0, "default": 0 }, "total": { "type": "integer", "example": 0, "default": 0 }, "data": { "type": "array" } } } } }, { "title": "Suscessful Results", "type": "object", "properties": { "data": { "type": "object", "properties": { "current_page": { "type": "integer", "example": 1, "default": 0 }, "first_page_url": { "type": "string", "example": "http://localhost:3005/payment-links?page=1" }, "from": { "type": "integer", "example": 1, "default": 0 }, "last_page": { "type": "integer", "example": 1, "default": 0 }, "last_page_url": { "type": "string", "example": "http://localhost:3005/payment-links?page=1" }, "next_page_url": {}, "path": { "type": "string", "example": "http://localhost:3005/payment-links" }, "per_page": { "type": "integer", "example": 20, "default": 0 }, "prev_page_url": {}, "to": { "type": "integer", "example": 4, "default": 0 }, "total": { "type": "integer", "example": 4, "default": 0 }, "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "11eda17551d9fec08a4793a483489785" }, "merchant_id": { "type": "string", "example": "merchant1" }, "common_name": { "type": "string", "example": "sameple link" }, "tinyurl": { "type": "string", "example": "https://paymnt.io/eBiNgF" }, "link_meta": { "type": "object", "properties": { "paymentLinkId": { "type": "string", "example": "11eda17551d9fec08a4793a483489785" } } }, "active": { "type": "integer", "example": 1, "default": 0 }, "amount": { "type": "integer", "example": 0, "default": 0 }, "created_at": { "type": "string", "example": "2023-01-31T14:41:19.000Z" }, "updated_at": {}, "total_sales": { "type": "integer", "example": 0, "default": 0 }, "total_transactions": { "type": "integer", "example": 0, "default": 0 } } } } } } } } ] } } } } }, "deprecated": false } }, "/payment-method": { "post": { "summary": "Create a Bank Payment Method", "description": "Create a new payment method by securely tokenizing bank account details (ACH)", "operationId": "create-a-payment-method-copy", "parameters": [ { "name": "__cf_bm", "in": "cookie", "description": "Cloudflare Bot Management cookie for security verification", "required": false, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "customer_id", "method", "person_name", "bank_account", "bank_routing", "bank_name", "bank_type", "bank_holder_type" ], "properties": { "customer_id": { "type": "string", "description": "The customer id which will be associated with the payment method" }, "method": { "type": "string", "default": "bank", "enum": [ "bank" ] }, "person_name": { "type": "string", "description": "Account holder first and last name. For company card/account, you can use Company Name" }, "bank_account": { "type": "string" }, "bank_routing": { "type": "string" }, "bank_name": { "type": "string" }, "bank_type": { "type": "string", "enum": [ "checking", "savings" ] }, "bank_holder_type": { "type": "string", "enum": [ "personal", "business" ] }, "address_1": { "type": "string", "description": "This field may be used for AVS." }, "address_2": { "type": "string" }, "address_city": { "type": "string", "description": "The city associated with the cardholder." }, "address_state": { "type": "string", "description": "Use the 2-letter state abbreviation. " }, "address_zip": { "type": "string", "description": "This field may be used for AVS." }, "address_country": { "type": "string" } } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{}" } }, "schema": { "type": "object", "properties": {} } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "{}" } }, "schema": { "type": "object", "properties": {} } } } } }, "deprecated": false }, "get": { "summary": "Get all Payment Methods for a Merchant", "description": "Retrieves a paginated data array of all non-deleted payment methods associated with a merchant by default.", "operationId": "get-all-payment-methods-for-a-merchant", "parameters": [ { "name": "__cf_bm", "in": "cookie", "description": "Cloudflare Bot Management cookie for security verification", "required": false, "schema": { "type": "string" } }, { "name": "per_page", "in": "query", "description": "Used to indicate how many records you want to fetch per page. The maximum is 200 and the minimum is 1. Defaults to 20.", "schema": { "type": "integer", "format": "int32", "default": 20 } }, { "name": "au_last_event", "in": "query", "description": "Used to filter results by the account updater last event.", "schema": { "type": "string", "enum": [ "ReplacePaymentMethod", "ContactCardHolder", "ClosePaymentMethod" ] } }, { "name": "au_last_event_start_at", "in": "query", "description": "Used to filter results that have the au_last_event_at greater than or equal to the given datetime value.", "schema": { "type": "string", "format": "date" } }, { "name": "au_last_event_end_at", "in": "query", "description": "Used to filter results that have the au_last_event_at less than or equal to the given datetime value.", "schema": { "type": "string", "format": "date" } }, { "name": "status", "in": "query", "description": "Used to filter results by the payment method's status.", "schema": { "type": "string", "enum": [ "all", "deleted" ], "default": "all" } } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"current_page\": 1,\n \"data\": [\n {\n \"id\": \"7e3a83ea-6770-41f7-9b28-7ea1a3ae33e7\",\n \"customer_id\": \"35e4cfa9-d87e-45fc-84da-a6bdce2c3330\",\n \"merchant_id\": \"85c58c65-4da7-4f99-acb0-afa885874572\",\n \"user_id\": \"hosted-payments\",\n \"nickname\": \"VISA: Bob Smithers (ending in: 1111)\",\n \"has_cvv\": 0,\n \"is_default\": 0,\n \"method\": \"card\",\n \"person_name\": \"Bob Smithers\",\n \"card_type\": \"visa\",\n \"card_last_four\": \"1111\",\n \"card_exp\": \"032022\",\n \"bank_name\": null,\n \"bank_type\": null,\n \"bank_holder_type\": null,\n \"address_1\": null,\n \"address_2\": null,\n \"address_city\": null,\n \"address_state\": null,\n \"address_zip\": \"999999\",\n \"address_country\": null,\n \"purged_at\": null,\n \"deleted_at\": null,\n \"created_at\": \"2018-08-03 17:59:10\",\n \"updated_at\": \"2018-08-03 17:59:10\",\n \"card_exp_datetime\": \"2022-03-31 23:59:59\",\n \"is_usable_in_vt\": true,\n \"is_tokenized\": true,\n \"au_last_event\": null,\n \"au_last_event_at\": null,\n \"customer\": {\n \"id\": \"35e4cfa9-d87e-45fc-84da-a6bdce2c3330\",\n \"firstname\": \"John\",\n \"lastname\": \"Smith\",\n \"company\": \"ABC INC\",\n \"email\": \"webpaymentstest@test.com\",\n \"cc_emails\": [],\n \"cc_sms\": null,\n \"phone\": \"1234567898\",\n \"address_1\": \"123 Rite Way\",\n \"address_2\": \"Unit 12\",\n \"address_city\": \"Orlando\",\n \"address_state\": \"FL\",\n \"address_zip\": \"32801\",\n \"address_country\": \"USA\",\n \"notes\": null,\n \"reference\": \"\",\n \"options\": null,\n \"created_at\": \"2018-07-27 19:08:48\",\n \"updated_at\": \"2018-07-27 19:08:48\",\n \"deleted_at\": null,\n \"allow_invoice_credit_card_payments\": true,\n \"gravatar\": \"//www.gravatar.com/avatar/18dd69e3959903c248ac613b51bc7f8e\"\n },\n \"user\": {\n \"id\": \"35e4cfa9-d87e-45fc-32df-a6bdce2casytr\",\n \"system_admin\": true,\n \"name\": \"Smith John\",\n \"email\": \"userwebpaymenttest@test.com\",\n \"email_verification_sent_at\": \"2016-05-11 17:13:33\",\n \"email_verified_at\": \"2020-06-08 13:39:30\",\n \"is_api_key\": false,\n \"options\": null,\n \"acknowledgments\": {\n \"signedApplication\": true,\n \"editedOnboardingInformation\": true,\n \"godviewOmniSearchTooltip\": true,\n \"tutorial\": true,\n \"setPassword\": true,\n \"godviewWelcome\": true\n },\n \"created_at\": \"2023-11-07 17:53:36\",\n \"updated_at\": \"2023-11-07 17:53:36\",\n \"deleted_at\": null,\n \"brand\": \"fattmerchant\",\n \"mfa_enabled\": false,\n \"role_id\": null,\n \"gravatar\": \"//www.gravatar.com/avatar/772cbf95746d7da86789cc3634c46ba8\",\n \"team_admin\": null,\n \"team_enabled\": null,\n \"team_role\": null,\n \"merchant_options\": [],\n \"is_default\": false,\n \"brands\": [\n \"fattmerchant\"\n ],\n \"role_name\": null\n }\n },\n {\n \"id\": \"403e043d-2971-4062-adc7-7e64f7882786\",\n \"customer_id\": \"35e4cfa9-d87e-45fc-84da-a6bdce2c3330\",\n \"merchant_id\": \"85c58c65-4da7-4f99-acb0-afa885874572\",\n \"user_id\": \"a01a5f74-cbdb-4704-9e9b-56fd5a8ee7b8\",\n \"nickname\": \"personal savings, BANK INC (ending in: 3210)\",\n \"has_cvv\": 0,\n \"is_default\": 1,\n \"method\": \"bank\",\n \"person_name\": \"Bob Smith\",\n \"card_type\": null,\n \"card_last_four\": \"3210\",\n \"card_exp\": null,\n \"bank_name\": \"Bank INC\",\n \"bank_type\": \"savings\",\n \"bank_holder_type\": \"personal\",\n \"address_1\": null,\n \"address_2\": null,\n \"address_city\": null,\n \"address_state\": null,\n \"address_zip\": null,\n \"address_country\": null,\n \"purged_at\": null,\n \"deleted_at\": null,\n \"created_at\": \"2018-08-02 21:06:04\",\n \"updated_at\": \"2018-08-02 21:06:04\",\n \"card_exp_datetime\": \"2018-08-02 21:06:04\",\n \"is_usable_in_vt\": true,\n \"is_tokenized\": true,\n \"au_last_event\": \"ReplacePaymentMethod\",\n \"au_last_event_at\": \"2018-12-02 21:06:04\",\n \"customer\": {\n \"id\": \"35e4cfa9-d87e-45fc-84da-a6bdce2c3330\",\n \"firstname\": \"John\",\n \"lastname\": \"Smith\",\n \"company\": \"ABC INC\",\n \"email\": \"webpaymentstest@test.com\",\n \"cc_emails\": [],\n \"cc_sms\": null,\n \"phone\": \"1234567898\",\n \"address_1\": \"123 Rite Way\",\n \"address_2\": \"Unit 12\",\n \"address_city\": \"Orlando\",\n \"address_state\": \"FL\",\n \"address_zip\": \"32801\",\n \"address_country\": \"USA\",\n \"notes\": null,\n \"reference\": \"\",\n \"options\": null,\n \"created_at\": \"2018-07-27 19:08:48\",\n \"updated_at\": \"2018-07-27 19:08:48\",\n \"deleted_at\": null,\n \"allow_invoice_credit_card_payments\": true,\n \"gravatar\": \"//www.gravatar.com/avatar/18dd69e3959903c248ac613b51bc7f8e\"\n },\n \"user\": {\n \"id\": \"35e4cfa9-d87e-45fc-32df-a6bdce2casytr\",\n \"system_admin\": true,\n \"name\": \"Smith John\",\n \"email\": \"userwebpaymenttest@test.com\",\n \"email_verification_sent_at\": \"2016-05-11 17:13:33\",\n \"email_verified_at\": \"2020-06-08 13:39:30\",\n \"is_api_key\": false,\n \"options\": null,\n \"acknowledgments\": {\n \"signedApplication\": true,\n \"editedOnboardingInformation\": true,\n \"godviewOmniSearchTooltip\": true,\n \"tutorial\": true,\n \"setPassword\": true,\n \"godviewWelcome\": true\n },\n \"created_at\": \"2023-11-07 17:53:36\",\n \"updated_at\": \"2023-11-07 17:53:36\",\n \"deleted_at\": null,\n \"brand\": \"fattmerchant\",\n \"mfa_enabled\": false,\n \"role_id\": null,\n \"gravatar\": \"//www.gravatar.com/avatar/772cbf95746d7da86789cc3634c46ba8\",\n \"team_admin\": null,\n \"team_enabled\": null,\n \"team_role\": null,\n \"merchant_options\": [],\n \"is_default\": false,\n \"brands\": [\n \"fattmerchant\"\n ],\n \"role_name\": null\n }\n }\n ],\n \"first_page_url\": \"https://apiprod.fattlabs.com/payment-method?page=1\",\n \"from\": 1,\n \"last_page\": 1,\n \"last_page_url\": \"https://apiprod.fattlabs.com/payment-method?page=1\",\n \"next_page_url\": null,\n \"path\": \"https://apiprod.fattlabs.com/payment-method\",\n \"per_page\": \"10\",\n \"prev_page_url\": null,\n \"to\": 1,\n \"total\": 1\n}" } }, "schema": { "type": "object", "properties": { "current_page": { "type": "integer", "example": 1, "default": 0 }, "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "7e3a83ea-6770-41f7-9b28-7ea1a3ae33e7" }, "customer_id": { "type": "string", "example": "35e4cfa9-d87e-45fc-84da-a6bdce2c3330" }, "merchant_id": { "type": "string", "example": "85c58c65-4da7-4f99-acb0-afa885874572" }, "user_id": { "type": "string", "example": "hosted-payments" }, "nickname": { "type": "string", "example": "VISA: Bob Smithers (ending in: 1111)" }, "has_cvv": { "type": "integer", "example": 0, "default": 0 }, "is_default": { "type": "integer", "example": 0, "default": 0 }, "method": { "type": "string", "example": "card" }, "person_name": { "type": "string", "example": "Bob Smithers" }, "card_type": { "type": "string", "example": "visa" }, "card_last_four": { "type": "string", "example": "1111" }, "card_exp": { "type": "string", "example": "032022" }, "bank_name": {}, "bank_type": {}, "bank_holder_type": {}, "address_1": {}, "address_2": {}, "address_city": {}, "address_state": {}, "address_zip": { "type": "string", "example": "999999" }, "address_country": {}, "purged_at": {}, "deleted_at": {}, "created_at": { "type": "string", "example": "2018-08-03 17:59:10" }, "updated_at": { "type": "string", "example": "2018-08-03 17:59:10" }, "card_exp_datetime": { "type": "string", "example": "2022-03-31 23:59:59" }, "is_usable_in_vt": { "type": "boolean", "example": true, "default": true }, "is_tokenized": { "type": "boolean", "example": true, "default": true }, "au_last_event": {}, "au_last_event_at": {}, "customer": { "type": "object", "properties": { "id": { "type": "string", "example": "35e4cfa9-d87e-45fc-84da-a6bdce2c3330" }, "firstname": { "type": "string", "example": "John" }, "lastname": { "type": "string", "example": "Smith" }, "company": { "type": "string", "example": "ABC INC" }, "email": { "type": "string", "example": "webpaymentstest@test.com" }, "cc_emails": { "type": "array" }, "cc_sms": {}, "phone": { "type": "string", "example": "1234567898" }, "address_1": { "type": "string", "example": "123 Rite Way" }, "address_2": { "type": "string", "example": "Unit 12" }, "address_city": { "type": "string", "example": "Orlando" }, "address_state": { "type": "string", "example": "FL" }, "address_zip": { "type": "string", "example": "32801" }, "address_country": { "type": "string", "example": "USA" }, "notes": {}, "reference": { "type": "string", "example": "" }, "options": {}, "created_at": { "type": "string", "example": "2018-07-27 19:08:48" }, "updated_at": { "type": "string", "example": "2018-07-27 19:08:48" }, "deleted_at": {}, "allow_invoice_credit_card_payments": { "type": "boolean", "example": true, "default": true }, "gravatar": { "type": "string", "example": "//www.gravatar.com/avatar/18dd69e3959903c248ac613b51bc7f8e" } } }, "user": { "type": "object", "properties": { "id": { "type": "string", "example": "35e4cfa9-d87e-45fc-32df-a6bdce2casytr" }, "system_admin": { "type": "boolean", "example": true, "default": true }, "name": { "type": "string", "example": "Smith John" }, "email": { "type": "string", "example": "userwebpaymenttest@test.com" }, "email_verification_sent_at": { "type": "string", "example": "2016-05-11 17:13:33" }, "email_verified_at": { "type": "string", "example": "2020-06-08 13:39:30" }, "is_api_key": { "type": "boolean", "example": false, "default": true }, "options": {}, "acknowledgments": { "type": "object", "properties": { "signedApplication": { "type": "boolean", "example": true, "default": true }, "editedOnboardingInformation": { "type": "boolean", "example": true, "default": true }, "godviewOmniSearchTooltip": { "type": "boolean", "example": true, "default": true }, "tutorial": { "type": "boolean", "example": true, "default": true }, "setPassword": { "type": "boolean", "example": true, "default": true }, "godviewWelcome": { "type": "boolean", "example": true, "default": true } } }, "created_at": { "type": "string", "example": "2023-11-07 17:53:36" }, "updated_at": { "type": "string", "example": "2023-11-07 17:53:36" }, "deleted_at": {}, "brand": { "type": "string", "example": "fattmerchant" }, "mfa_enabled": { "type": "boolean", "example": false, "default": true }, "role_id": {}, "gravatar": { "type": "string", "example": "//www.gravatar.com/avatar/772cbf95746d7da86789cc3634c46ba8" }, "team_admin": {}, "team_enabled": {}, "team_role": {}, "merchant_options": { "type": "array" }, "is_default": { "type": "boolean", "example": false, "default": true }, "brands": { "type": "array", "items": { "type": "string", "example": "fattmerchant" } }, "role_name": {} } } } } }, "first_page_url": { "type": "string", "example": "https://apiprod.fattlabs.com/payment-method?page=1" }, "from": { "type": "integer", "example": 1, "default": 0 }, "last_page": { "type": "integer", "example": 1, "default": 0 }, "last_page_url": { "type": "string", "example": "https://apiprod.fattlabs.com/payment-method?page=1" }, "next_page_url": {}, "path": { "type": "string", "example": "https://apiprod.fattlabs.com/payment-method" }, "per_page": { "type": "string", "example": "10" }, "prev_page_url": {}, "to": { "type": "integer", "example": 1, "default": 0 }, "total": { "type": "integer", "example": 1, "default": 0 } } } } } }, "422": { "description": "422", "content": { "application/json": { "examples": { "Unformatted Date": { "value": "{\n \"au_last_event_end_at\": [\n \"The au last event end at does not match the format Y-m-d H:i:s.\"\n ]\n}" }, "Invalid Account Updater Event": { "value": "{\n \"au_last_event\": [\n \"The selected au last event is invalid.\"\n ]\n}" }, "Invalid Status": { "value": "{\n \"status\": [\n \"The selected status is invalid.\"\n ]\n}" } }, "schema": { "oneOf": [ { "title": "Unformatted Date", "type": "object", "properties": { "au_last_event_end_at": { "type": "array", "items": { "type": "string", "example": "The au last event end at does not match the format Y-m-d H:i:s." } } } }, { "title": "Invalid Account Updater Event", "type": "object", "properties": { "au_last_event": { "type": "array", "items": { "type": "string", "example": "The selected au last event is invalid." } } } }, { "title": "Invalid Status", "type": "object", "properties": { "status": { "type": "array", "items": { "type": "string", "example": "The selected status is invalid." } } } } ] } } } } }, "deprecated": false } }, "/payment-method/": { "post": { "summary": "Create a Card Payment Method", "description": "Create a new credit or debit card payment method by securely tokenizing the card details.", "operationId": "create-a-payment-method", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "customer_id", "method", "person_name", "card_number", "card_cvv", "card_type", "card_exp" ], "properties": { "customer_id": { "type": "string", "description": "The customer id which will be associated with the payment method" }, "method": { "type": "string", "default": "card", "enum": [ "card" ] }, "person_name": { "type": "string", "description": "Account holder first and last name. For company card/account, you can use Company Name" }, "card_number": { "type": "string" }, "card_cvv": { "type": "number" }, "card_exp": { "type": "string", "description": "4 digit expiration (ex. \"0427\")" }, "card_type": { "type": "string", "description": "null is accepted" }, "address_1": { "type": "string", "description": "This may be used for AVS." }, "address_2": { "type": "string" }, "address_city": { "type": "string", "description": "The cIty associated with the cardholder. " }, "address_state": { "type": "string", "description": "Use the 2-letter state abbreviation. " }, "address_zip": { "type": "string", "description": "This may be used for AVS." }, "address_country": { "type": "string" } } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{}" } }, "schema": { "type": "object", "properties": {} } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "{}" } }, "schema": { "type": "object", "properties": {} } } } } } } }, "/invoice/schedule/": { "post": { "summary": "Create a Scheduled Invoice", "description": "Creates a new scheduled invoice for automated recurring or one-time billing.", "operationId": "createScheduledInvoice", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "url", "total" ], "properties": { "url": { "type": "string", "description": "The URL for the hosted invoice page." }, "total": { "type": "number", "description": "The total amount for the invoice." }, "rule": { "type": "string", "description": "The iCalendar RRule recurrence rule string (e.g., DTSTART=20231101T120000Z;FREQ=MONTHLY;COUNT=12)." }, "customer_id": { "type": "string", "description": "The ID of the customer to associate with the schedule." }, "payment_method_id": { "type": "string", "description": "The ID of the payment method for autopay. If omitted, the customer will pay manually." }, "email_notification": { "type": "boolean", "description": "Whether to send email notifications when invoices are generated. Defaults to true.", "default": true }, "files": { "type": "array", "description": "Array of file IDs to attach to the schedule.", "items": { "type": "string" } }, "meta": { "type": "object", "description": "Metadata for the invoice, including line items, tax, and other details.", "properties": { "subtotal": { "type": "number", "description": "The subtotal amount before tax and fees." }, "tax": { "type": "number", "description": "The tax amount applied to the invoice." }, "fee": { "type": "number", "description": "An optional fee amount in dollars (not cents).", "minimum": 0 }, "poNumber": { "type": "string", "nullable": true, "description": "An optional purchase order number." }, "shippingAmount": { "type": "number", "description": "The shipping amount for the invoice.", "minimum": 0 }, "hideCustomerLineItems": { "type": "boolean", "nullable": true, "description": "When set to true, line item details are hidden from customer-facing emails and receipts. Line items remain stored on the invoice and are passed to the payment gateway." }, "lineItems": { "type": "array", "description": "Array of line items for the invoice.", "items": { "type": "object", "properties": { "item": { "type": "string", "description": "The name or description of the item." }, "quantity": { "type": "number", "description": "The quantity of the item." }, "price": { "type": "number", "description": "The price per unit of the item." } } } } } } } } } } }, "responses": { "201": { "description": "Schedule successfully created." }, "400": { "description": "Bad Request - Invalid parameters or missing required fields." }, "422": { "description": "Validation Error - DTSTART is in the past, recurrence rules are incorrectly formatted, or invalid field values." }, "500": { "description": "Internal Server Error." } } } }, "/team": { "post": { "summary": "Create a Team", "description": "This call makes a new merchant team.", "operationId": "create-a-team", "parameters": [ { "name": "company_name", "in": "query", "required": true, "schema": { "type": "string", "default": "Stax" } }, { "name": "contact_email", "in": "query", "required": true, "schema": { "type": "string", "default": "contact@example.com" } }, { "name": "contact_name", "in": "query", "schema": { "type": "string", "default": "Stax" } }, { "name": "contact_phone", "in": "query", "schema": { "type": "string", "default": "8555503288" } }, { "name": "address_1", "in": "query", "schema": { "type": "string", "default": "25 Wall Street" } }, { "name": "address_2", "in": "query", "schema": { "type": "string", "default": "Suite 1" } }, { "name": "address_city", "in": "query", "schema": { "type": "string", "default": "Orlando" } }, { "name": "address_state", "in": "query", "schema": { "type": "string", "default": "FL" } }, { "name": "address_zip", "in": "query", "schema": { "type": "string", "default": "32801" } } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "[\n {\n \"token\": \"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJtZXJjaGFudCI6ImFhNzc2NmIyLTI0MmYtNDNiOS05NDc2LTNjOTAxOGYwY2U1MiIsInN1YiI6ImI1OGQ3ZWVlLWU2OGQtNGQxMi1hMWY4LTYyZjVlNzEzODJhZSIsImlzcyI6Imh0dHA6XC9cL2ZtYXBpLmxvY2FsXC90ZWFtIiwiaWF0IjoxNDk0ODY3NzU3LCJleHAiOjE0OTQ5NTQxNTcsIm5iZiI6MTQ5NDg2Nzc1NywianRpIjoiNzA1MmNkZWQ3NDA2ZDgyNDAxN2MzNTE1YzVhZGU3ZWYifQ.B4bcNQIcHTimpHW2hlJtnPOodAgsm3C-khfkphphDzo\",\n \"user\": {\n \"id\": \"b58d7eee-e68d-4d12-a1f8-62f5e71382ae\",\n \"system_admin\": false,\n \"name\": \"demo\",\n \"email\": \"contact@example.com\",\n \"email_verification_sent_at\": \"2017-05-15 16:30:23\",\n \"email_verified_at\": \"2017-03-29 15:27:21\",\n \"created_at\": \"2017-01-11 21:44:02\",\n \"updated_at\": \"2017-05-15 16:30:23\",\n \"deleted_at\": null,\n \"gravatar\": \"//www.gravatar.com/avatar/157965dea7cd2f44e349382d1d791650\",\n \"team_role\": \"admin\",\n \"team_admin\": true,\n \"team_enabled\": true,\n \"mfa_enabled\": null\n },\n \"merchant\": {\n \"id\": \"aa7766b2-242f-43b9-9476-3c9018f0ce52\",\n \"mid\": \"\",\n \"status\": \"PENDING\",\n \"subdomain\": \"\",\n \"company_name\": \"Stax\",\n \"contact_name\": \"Stax\",\n \"contact_email\": \"contact@example.com\",\n \"contact_phone\": \"8555503288\",\n \"address_1\": \"25 Wall Street\",\n \"address_2\": \"Suite 1\",\n \"address_city\": \"Orlando\",\n \"address_state\": \"FL\",\n \"address_zip\": \"32801\",\n \"hosted_payments_token\": null,\n \"currency\": [\n \"USD\"\n ],\n \"plan\": null,\n \"options\": null,\n \"gateway_type\": null,\n \"processor\": \"\",\n \"product_type\": \"\",\n \"welcome_email_sent_at\": null,\n \"created_at\": \"2017-05-15 17:02:37\",\n \"updated_at\": \"2017-05-15 17:02:37\",\n \"deleted_at\": null,\n \"gateway_name\": null,\n \"branding\": null,\n \"allow_ach\": false\n }\n },\n {\n \"token\": \"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJtZXJjaGFudCI6ImRkMzZiOTM2LTFlYjctNGVjZS1iZWJjLWI1MTRjNmEzNmViZCIsInN1YiI6ImI1OGQ3ZWVlLWU2OGQtNGQxMi1hMWY4LTYyZjVlNzEzODJhZSIsImlzcyI6Imh0dHA6XC9cL2ZtYXBpLmxvY2FsXC90ZWFtIiwiaWF0IjoxNDk0ODY3NzU3LCJleHAiOjE0OTQ5NTQxNTcsIm5iZiI6MTQ5NDg2Nzc1NywianRpIjoiNzA1MmNkZWQ3NDA2ZDgyNDAxN2MzNTE1YzVhZGU3ZWYifQ._3rlhZzUyind1W138w4O7BjHYVlAOjUpgkmweSekKKE\",\n \"user\": {\n \"id\": \"b58d7eee-e68d-4d12-a1f8-62f5e71382ae\",\n \"system_admin\": false,\n \"name\": \"demo\",\n \"email\": \"contact@example.com\",\n \"email_verification_sent_at\": \"2017-05-15 16:30:23\",\n \"email_verified_at\": \"2017-03-29 15:27:21\",\n \"created_at\": \"2017-01-11 21:44:02\",\n \"updated_at\": \"2017-05-15 16:30:23\",\n \"deleted_at\": null,\n \"gravatar\": \"//www.gravatar.com/avatar/157965dea7cd2f44e349382d1d791650\",\n \"team_role\": \"admin\",\n \"team_admin\": true,\n \"team_enabled\": true\n },\n \"merchant\": {\n \"id\": \"dd36b936-1eb7-4ece-bebc-b514c6a36ebd\",\n \"mid\": \"520000294774\",\n \"status\": \"ACTIVE\",\n \"subdomain\": \"demo\",\n \"company_name\": \"Here\",\n \"contact_name\": \"Stax\",\n \"contact_email\": \"contact@example.com\",\n \"contact_phone\": \"8555503288\",\n \"address_1\": \"25 Wall Street\",\n \"address_2\": \"Suite 1\",\n \"address_city\": \"Orlando\",\n \"address_state\": \"FL\",\n \"address_zip\": \"32801\",\n \"hosted_payments_token\": \"okay\",\n \"currency\": [\n \"USD\"\n ],\n \"plan\": {\n \"id\": \"d619a0cc-b7e1-11e6-a0aa-08002777c33d\",\n \"merchant_id\": \"dd36b936-1eb7-4ece-bebc-b514c6a36ebd\",\n \"user_id\": \"\",\n \"name\": \"premium\",\n \"created_at\": \"2016-12-01 16:18:46\",\n \"updated_at\": \"2016-12-01 16:18:46\"\n },\n \"options\": {\n \"default_dashboard\": \"Summary\",\n \"social\": {\n \"website_url\": \"http://google.com\",\n \"facebook_url\": \"http://google.com\",\n \"instagram_url\": \"http://google.com\",\n \"twitter_url\": \"http://google.com\",\n \"linkedin_url\": \"http://google.com\"\n },\n \"hosted_payments_url_long\": \"http://localhost:5432/#/pay/okay\",\n \"hosted_payments_url_short\": \"\",\n \"hosted_payments_success_note\": \"31\",\n \"hosted_payments_note\": \"12\"\n },\n \"gateway_type\": \"test\",\n \"processor\": \"Vantiv\",\n \"product_type\": \"Terminal\",\n \"welcome_email_sent_at\": null,\n \"created_at\": \"2016-12-01 16:18:46\",\n \"updated_at\": \"2017-04-21 20:15:12\",\n \"deleted_at\": null,\n \"gateway_name\": null,\n \"branding\": {\n \"id\": \"af82b215-6081-42b0-b494-fbda189ce8f9\",\n \"merchant_id\": \"dd36b936-1eb7-4ece-bebc-b514c6a36ebd\",\n \"user_id\": \"b58d7eee-e68d-4d12-a1f8-62f5e71382ae\",\n \"name\": \"\",\n \"public_url\": \"https://s3-us-west-2.amazonaws.com/fattpaydocuments/branding/af82b215-6081-42b0-b494-fbda189ce8f9.png\",\n \"tag\": \"branding\",\n \"meta\": {\n \"filesize_bytes\": 3938556,\n \"filesize\": \"3.94 MB\",\n \"extension\": \"png\",\n \"size\": {\n \"width\": 3072,\n \"height\": 1728\n },\n \"mime\": \"image/png\"\n },\n \"created_at\": \"2017-04-19 15:50:41\",\n \"updated_at\": \"2017-04-19 15:50:52\",\n \"deleted_at\": null\n },\n \"allow_ach\": true\n }\n }\n]" } }, "schema": { "type": "array", "items": { "type": "object", "properties": { "token": { "type": "string", "example": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJtZXJjaGFudCI6ImFhNzc2NmIyLTI0MmYtNDNiOS05NDc2LTNjOTAxOGYwY2U1MiIsInN1YiI6ImI1OGQ3ZWVlLWU2OGQtNGQxMi1hMWY4LTYyZjVlNzEzODJhZSIsImlzcyI6Imh0dHA6XC9cL2ZtYXBpLmxvY2FsXC90ZWFtIiwiaWF0IjoxNDk0ODY3NzU3LCJleHAiOjE0OTQ5NTQxNTcsIm5iZiI6MTQ5NDg2Nzc1NywianRpIjoiNzA1MmNkZWQ3NDA2ZDgyNDAxN2MzNTE1YzVhZGU3ZWYifQ.B4bcNQIcHTimpHW2hlJtnPOodAgsm3C-khfkphphDzo" }, "user": { "type": "object", "properties": { "id": { "type": "string", "example": "b58d7eee-e68d-4d12-a1f8-62f5e71382ae" }, "system_admin": { "type": "boolean", "example": false, "default": true }, "name": { "type": "string", "example": "demo" }, "email": { "type": "string", "example": "contact@example.com" }, "email_verification_sent_at": { "type": "string", "example": "2017-05-15 16:30:23" }, "email_verified_at": { "type": "string", "example": "2017-03-29 15:27:21" }, "created_at": { "type": "string", "example": "2017-01-11 21:44:02" }, "updated_at": { "type": "string", "example": "2017-05-15 16:30:23" }, "deleted_at": {}, "gravatar": { "type": "string", "example": "//www.gravatar.com/avatar/157965dea7cd2f44e349382d1d791650" }, "team_role": { "type": "string", "example": "admin" }, "team_admin": { "type": "boolean", "example": true, "default": true }, "team_enabled": { "type": "boolean", "example": true, "default": true }, "mfa_enabled": {} } }, "merchant": { "type": "object", "properties": { "id": { "type": "string", "example": "aa7766b2-242f-43b9-9476-3c9018f0ce52" }, "mid": { "type": "string", "example": "" }, "status": { "type": "string", "example": "PENDING" }, "subdomain": { "type": "string", "example": "" }, "company_name": { "type": "string", "example": "Stax" }, "contact_name": { "type": "string", "example": "Stax" }, "contact_email": { "type": "string", "example": "contact@example.com" }, "contact_phone": { "type": "string", "example": "8555503288" }, "address_1": { "type": "string", "example": "25 Wall Street" }, "address_2": { "type": "string", "example": "Suite 1" }, "address_city": { "type": "string", "example": "Orlando" }, "address_state": { "type": "string", "example": "FL" }, "address_zip": { "type": "string", "example": "32801" }, "hosted_payments_token": {}, "currency": { "type": "array", "items": { "type": "string", "example": "USD" } }, "plan": {}, "options": {}, "gateway_type": {}, "processor": { "type": "string", "example": "" }, "product_type": { "type": "string", "example": "" }, "welcome_email_sent_at": {}, "created_at": { "type": "string", "example": "2017-05-15 17:02:37" }, "updated_at": { "type": "string", "example": "2017-05-15 17:02:37" }, "deleted_at": {}, "gateway_name": {}, "branding": {}, "allow_ach": { "type": "boolean", "example": false, "default": true } } } } } } } } }, "422": { "description": "422", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"company_name\": [\n \"The company name field is required.\"\n ],\n \"contact_email\": [\n \"The contact email field is required.\"\n ]\n}" } }, "schema": { "type": "object", "properties": { "company_name": { "type": "array", "items": { "type": "string", "example": "The company name field is required." } }, "contact_email": { "type": "array", "items": { "type": "string", "example": "The contact email field is required." } } } } } } } }, "deprecated": false }, "put": { "summary": "Edit Your Merchant Team's Info", "description": "This call makes a new merchant team.", "operationId": "edit-your-merchant-teams-info", "parameters": [ { "name": "company_name", "in": "query", "schema": { "type": "string", "default": "Stax" } }, { "name": "contact_email", "in": "query", "schema": { "type": "string", "default": "contact@example.com" } }, { "name": "contact_name", "in": "query", "schema": { "type": "string", "default": "Stax" } }, { "name": "contact_phone", "in": "query", "schema": { "type": "string", "default": "8555503288" } }, { "name": "address_1", "in": "query", "schema": { "type": "string", "default": "25 Wall Street" } }, { "name": "address_2", "in": "query", "schema": { "type": "string", "default": "Suite 1" } }, { "name": "address_city", "in": "query", "schema": { "type": "string", "default": "Orlando" } }, { "name": "address_state", "in": "query", "schema": { "type": "string", "default": "FL" } }, { "name": "address_zip", "in": "query", "schema": { "type": "string", "default": "32801" } } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"id\": \"aa7766b2-242f-43b9-9476-3c9018f0ce52\",\n \"mid\": \"\",\n \"status\": \"PENDING\",\n \"subdomain\": \"\",\n \"company_name\": \"Stax\",\n \"contact_name\": \"Stax\",\n \"contact_email\": \"contact@example.com\",\n \"contact_phone\": \"8555503288\",\n \"address_1\": \"25 Wall Street\",\n \"address_2\": \"Suite 1\",\n \"address_city\": \"Orlando\",\n \"address_state\": \"FL\",\n \"address_zip\": \"32801\",\n \"hosted_payments_token\": null,\n \"currency\": [\n \"USD\"\n ],\n \"plan\": {\n \"id\": \"f92fee2b-fdae-4474-988c-c8f2df92772a\",\n \"merchant_id\": \"aa7766b2-242f-43b9-9476-3c9018f0ce52\",\n \"user_id\": \"b58d7eee-e68d-4d12-a1f8-62f5e71382ae\",\n \"name\": null,\n \"created_at\": \"2017-05-15 18:41:25\",\n \"updated_at\": \"2017-05-15 18:41:25\"\n },\n \"options\": null,\n \"gateway_type\": null,\n \"processor\": \"\",\n \"product_type\": \"\",\n \"welcome_email_sent_at\": null,\n \"created_at\": \"2017-05-15 17:02:37\",\n \"updated_at\": \"2017-05-15 18:41:25\",\n \"deleted_at\": null,\n \"gateway_name\": null,\n \"branding\": null,\n \"allow_ach\": false\n}" } }, "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "aa7766b2-242f-43b9-9476-3c9018f0ce52" }, "mid": { "type": "string", "example": "" }, "status": { "type": "string", "example": "PENDING" }, "subdomain": { "type": "string", "example": "" }, "company_name": { "type": "string", "example": "Stax" }, "contact_name": { "type": "string", "example": "Stax" }, "contact_email": { "type": "string", "example": "contact@example.com" }, "contact_phone": { "type": "string", "example": "8555503288" }, "address_1": { "type": "string", "example": "25 Wall Street" }, "address_2": { "type": "string", "example": "Suite 1" }, "address_city": { "type": "string", "example": "Orlando" }, "address_state": { "type": "string", "example": "FL" }, "address_zip": { "type": "string", "example": "32801" }, "hosted_payments_token": {}, "currency": { "type": "array", "items": { "type": "string", "example": "USD" } }, "plan": { "type": "object", "properties": { "id": { "type": "string", "example": "f92fee2b-fdae-4474-988c-c8f2df92772a" }, "merchant_id": { "type": "string", "example": "aa7766b2-242f-43b9-9476-3c9018f0ce52" }, "user_id": { "type": "string", "example": "b58d7eee-e68d-4d12-a1f8-62f5e71382ae" }, "name": {}, "created_at": { "type": "string", "example": "2017-05-15 18:41:25" }, "updated_at": { "type": "string", "example": "2017-05-15 18:41:25" } } }, "options": {}, "gateway_type": {}, "processor": { "type": "string", "example": "" }, "product_type": { "type": "string", "example": "" }, "welcome_email_sent_at": {}, "created_at": { "type": "string", "example": "2017-05-15 17:02:37" }, "updated_at": { "type": "string", "example": "2017-05-15 18:41:25" }, "deleted_at": {}, "gateway_name": {}, "branding": {}, "allow_ach": { "type": "boolean", "example": false, "default": true } } } } } } }, "deprecated": false } }, "/self": { "post": { "summary": "Create a User Account - Self Registration", "description": "Make a new user account", "operationId": "create-a-user-account-self-registration", "parameters": [ { "name": "email", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "password", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "password_confirmation", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "name", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "url", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "[\n {\n \"token\": \"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJtZXJjaGFudCI6bnVsbCwic3ViIjoiZTEwYzg2OWYtZGFmZC00MmQ0LWJjZmItMTM5YjJiOGNhMTY3IiwiaXNzIjoiaHR0cHM6XC9cL2FwaWRldjAxLmZhdHRsYWJzLmNvbVwvc2VsZiIsImlhdCI6MTQ2MzE2MzQ5NywiZXhwIjoxNDYzMjQ5ODk3LCJuYmYiOjE0NjMxNjM0OTcsImp0aSI6ImM2MzZlNTI3OThjNWE3MWQwYmRmMzU2ZGRlYjBmYjFiIn0.nI35JMEPuMoiW_mgvBV5bqKdEYI28lE4a2HyW2KnJjA\",\n \"user\": {\n \"name\": \"Daniel Walker\",\n \"email\": \"contact@example.com\",\n \"id\": \"e10c869f-dafd-42d4-bcfb-139b2b8ca167\",\n \"updated_at\": \"2016-05-13 18:18:17\",\n \"created_at\": \"2016-05-13 18:18:17\",\n \"email_verification_sent_at\": \"2016-05-13 18:18:17\",\n \"gravatar\": \"//www.gravatar.com/avatar/acd8040614c912043ee5dcf1748b06d5\",\n \"team_admin\": null,\n \"team_enabled\": null\n },\n \"merchant\": null\n }\n]" } }, "schema": { "type": "array", "items": { "type": "object", "properties": { "token": { "type": "string", "example": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJtZXJjaGFudCI6bnVsbCwic3ViIjoiZTEwYzg2OWYtZGFmZC00MmQ0LWJjZmItMTM5YjJiOGNhMTY3IiwiaXNzIjoiaHR0cHM6XC9cL2FwaWRldjAxLmZhdHRsYWJzLmNvbVwvc2VsZiIsImlhdCI6MTQ2MzE2MzQ5NywiZXhwIjoxNDYzMjQ5ODk3LCJuYmYiOjE0NjMxNjM0OTcsImp0aSI6ImM2MzZlNTI3OThjNWE3MWQwYmRmMzU2ZGRlYjBmYjFiIn0.nI35JMEPuMoiW_mgvBV5bqKdEYI28lE4a2HyW2KnJjA" }, "user": { "type": "object", "properties": { "name": { "type": "string", "example": "Daniel Walker" }, "email": { "type": "string", "example": "contact@example.com" }, "id": { "type": "string", "example": "e10c869f-dafd-42d4-bcfb-139b2b8ca167" }, "updated_at": { "type": "string", "example": "2016-05-13 18:18:17" }, "created_at": { "type": "string", "example": "2016-05-13 18:18:17" }, "email_verification_sent_at": { "type": "string", "example": "2016-05-13 18:18:17" }, "gravatar": { "type": "string", "example": "//www.gravatar.com/avatar/acd8040614c912043ee5dcf1748b06d5" }, "team_admin": {}, "team_enabled": {} } }, "merchant": {} } } } } } }, "422": { "description": "422", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"name\": [\n \"The name field is required.\"\n ],\n \"email\": [\n \"The email has already been taken.\"\n ],\n \"password\": [\n \"The password field is required.\"\n ]\n}" } }, "schema": { "type": "object", "properties": { "name": { "type": "array", "items": { "type": "string", "example": "The name field is required." } }, "email": { "type": "array", "items": { "type": "string", "example": "The email has already been taken." } }, "password": { "type": "array", "items": { "type": "string", "example": "The password field is required." } } } } } } } }, "deprecated": false }, "get": { "summary": "Get User and Team's Info", "description": "Return information about the user", "operationId": "get-self-and-teams-info", "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"user\": {\n \"id\": \"b58d7eee-e68d-4d12-a1f8-62f5e71382ae\",\n \"system_admin\": false,\n \"name\": \"Demo\",\n \"email\": \"contact@example.com\",\n \"email_verification_sent_at\": \"2017-03-29 15:27:19\",\n \"email_verified_at\": \"2017-03-29 15:27:21\",\n \"created_at\": \"2017-01-11 21:44:02\",\n \"updated_at\": \"2017-04-24 15:41:58\",\n \"deleted_at\": null,\n \"gravatar\": \"//www.gravatar.com/avatar/157965dea7cd2f44e349382d1d791650\",\n \"team_role\": \"admin\",\n \"team_admin\": true,\n \"team_enabled\": true\n },\n \"merchant\": {\n \"id\": \"dd36b936-1eb7-4ece-bebc-b514c6a36ebd\",\n \"mid\": \"520000294774\",\n \"status\": \"ACTIVE\",\n \"subdomain\": \"demo\",\n \"company_name\": \"Here\",\n \"contact_name\": \"Stax\",\n \"contact_email\": \"contact@example.com\",\n \"contact_phone\": \"8555503288\",\n \"address_1\": \"25 Wall Street\",\n \"address_2\": \"Suite 1\",\n \"address_city\": \"Orlando\",\n \"address_state\": \"FL\",\n \"address_zip\": \"32801\",\n \"hosted_payments_token\": \"okay\",\n \"currency\": [\n \"USD\"\n ],\n \"plan\": {\n \"id\": \"d619a0cc-b7e1-11e6-a0aa-08002777c33d\",\n \"merchant_id\": \"dd36b936-1eb7-4ece-bebc-b514c6a36ebd\",\n \"user_id\": \"\",\n \"name\": \"premium\",\n \"created_at\": \"2016-12-01 16:18:46\",\n \"updated_at\": \"2016-12-01 16:18:46\"\n },\n \"options\": {\n \"default_dashboard\": \"Summary\",\n \"social\": {\n \"website_url\": \"http://google.com\",\n \"facebook_url\": \"http://google.com\",\n \"instagram_url\": \"http://google.com\",\n \"twitter_url\": \"http://google.com\",\n \"linkedin_url\": \"http://google.com\"\n },\n \"hosted_payments_url_long\": \"http://localhost:5432/#/pay/okay\",\n \"hosted_payments_url_short\": \"\",\n \"hosted_payments_success_note\": \"31\",\n \"hosted_payments_note\": \"12\"\n },\n \"gateway_type\": \"test\",\n \"processor\": \"Vantiv\",\n \"product_type\": \"Terminal\",\n \"welcome_email_sent_at\": null,\n \"created_at\": \"2016-12-01 16:18:46\",\n \"updated_at\": \"2017-04-21 20:15:12\",\n \"deleted_at\": null,\n \"gateway_name\": null,\n \"branding\": {\n \"id\": \"af82b215-6081-42b0-b494-fbda189ce8f9\",\n \"merchant_id\": \"dd36b936-1eb7-4ece-bebc-b514c6a36ebd\",\n \"user_id\": \"b58d7eee-e68d-4d12-a1f8-62f5e71382ae\",\n \"name\": \"\",\n \"public_url\": \"https://s3-us-west-2.amazonaws.com/fattpaydocuments/branding/af82b215-6081-42b0-b494-fbda189ce8f9.png\",\n \"tag\": \"branding\",\n \"meta\": {\n \"filesize_bytes\": 3938556,\n \"filesize\": \"3.94 MB\",\n \"extension\": \"png\",\n \"size\": {\n \"width\": 3072,\n \"height\": 1728\n },\n \"mime\": \"image/png\"\n },\n \"created_at\": \"2017-04-19 15:50:41\",\n \"updated_at\": \"2017-04-19 15:50:52\",\n \"deleted_at\": null\n },\n \"allow_ach\": true\n }\n}" } }, "schema": { "type": "object", "properties": { "user": { "type": "object", "properties": { "id": { "type": "string", "example": "b58d7eee-e68d-4d12-a1f8-62f5e71382ae" }, "system_admin": { "type": "boolean", "example": false, "default": true }, "name": { "type": "string", "example": "Demo" }, "email": { "type": "string", "example": "contact@example.com" }, "email_verification_sent_at": { "type": "string", "example": "2017-03-29 15:27:19" }, "email_verified_at": { "type": "string", "example": "2017-03-29 15:27:21" }, "created_at": { "type": "string", "example": "2017-01-11 21:44:02" }, "updated_at": { "type": "string", "example": "2017-04-24 15:41:58" }, "deleted_at": {}, "gravatar": { "type": "string", "example": "//www.gravatar.com/avatar/157965dea7cd2f44e349382d1d791650" }, "team_role": { "type": "string", "example": "admin" }, "team_admin": { "type": "boolean", "example": true, "default": true }, "team_enabled": { "type": "boolean", "example": true, "default": true } } }, "merchant": { "type": "object", "properties": { "id": { "type": "string", "example": "dd36b936-1eb7-4ece-bebc-b514c6a36ebd" }, "mid": { "type": "string", "example": "520000294774" }, "status": { "type": "string", "example": "ACTIVE" }, "subdomain": { "type": "string", "example": "demo" }, "company_name": { "type": "string", "example": "Here" }, "contact_name": { "type": "string", "example": "Stax" }, "contact_email": { "type": "string", "example": "contact@example.com" }, "contact_phone": { "type": "string", "example": "8555503288" }, "address_1": { "type": "string", "example": "25 Wall Street" }, "address_2": { "type": "string", "example": "Suite 1" }, "address_city": { "type": "string", "example": "Orlando" }, "address_state": { "type": "string", "example": "FL" }, "address_zip": { "type": "string", "example": "32801" }, "hosted_payments_token": { "type": "string", "example": "okay" }, "currency": { "type": "array", "items": { "type": "string", "example": "USD" } }, "plan": { "type": "object", "properties": { "id": { "type": "string", "example": "d619a0cc-b7e1-11e6-a0aa-08002777c33d" }, "merchant_id": { "type": "string", "example": "dd36b936-1eb7-4ece-bebc-b514c6a36ebd" }, "user_id": { "type": "string", "example": "" }, "name": { "type": "string", "example": "premium" }, "created_at": { "type": "string", "example": "2016-12-01 16:18:46" }, "updated_at": { "type": "string", "example": "2016-12-01 16:18:46" } } }, "options": { "type": "object", "properties": { "default_dashboard": { "type": "string", "example": "Summary" }, "social": { "type": "object", "properties": { "website_url": { "type": "string", "example": "http://google.com" }, "facebook_url": { "type": "string", "example": "http://google.com" }, "instagram_url": { "type": "string", "example": "http://google.com" }, "twitter_url": { "type": "string", "example": "http://google.com" }, "linkedin_url": { "type": "string", "example": "http://google.com" } } }, "hosted_payments_url_long": { "type": "string", "example": "http://localhost:5432/#/pay/okay" }, "hosted_payments_url_short": { "type": "string", "example": "" }, "hosted_payments_success_note": { "type": "string", "example": "31" }, "hosted_payments_note": { "type": "string", "example": "12" } } }, "gateway_type": { "type": "string", "example": "test" }, "processor": { "type": "string", "example": "Vantiv" }, "product_type": { "type": "string", "example": "Terminal" }, "welcome_email_sent_at": {}, "created_at": { "type": "string", "example": "2016-12-01 16:18:46" }, "updated_at": { "type": "string", "example": "2017-04-21 20:15:12" }, "deleted_at": {}, "gateway_name": {}, "branding": { "type": "object", "properties": { "id": { "type": "string", "example": "af82b215-6081-42b0-b494-fbda189ce8f9" }, "merchant_id": { "type": "string", "example": "dd36b936-1eb7-4ece-bebc-b514c6a36ebd" }, "user_id": { "type": "string", "example": "b58d7eee-e68d-4d12-a1f8-62f5e71382ae" }, "name": { "type": "string", "example": "" }, "public_url": { "type": "string", "example": "https://s3-us-west-2.amazonaws.com/fattpaydocuments/branding/af82b215-6081-42b0-b494-fbda189ce8f9.png" }, "tag": { "type": "string", "example": "branding" }, "meta": { "type": "object", "properties": { "filesize_bytes": { "type": "integer", "example": 3938556, "default": 0 }, "filesize": { "type": "string", "example": "3.94 MB" }, "extension": { "type": "string", "example": "png" }, "size": { "type": "object", "properties": { "width": { "type": "integer", "example": 3072, "default": 0 }, "height": { "type": "integer", "example": 1728, "default": 0 } } }, "mime": { "type": "string", "example": "image/png" } } }, "created_at": { "type": "string", "example": "2017-04-19 15:50:41" }, "updated_at": { "type": "string", "example": "2017-04-19 15:50:52" }, "deleted_at": {} } }, "allow_ach": { "type": "boolean", "example": true, "default": true } } } } } } } }, "401": { "description": "401", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"error\": \"token_expired\"\n}" } }, "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "token_expired" } } } } } } }, "deprecated": false }, "put": { "summary": "Update Your User Info", "description": "Allows the user to update their user information", "operationId": "update-your-user-info", "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"id\": \"b58d7eee-e68d-4d12-a1f8-62f5e71382ae\",\n \"system_admin\": false,\n \"name\": \"Demo\",\n \"email\": \"contact@example.com\",\n \"email_verification_sent_at\": \"2017-03-29 15:27:19\",\n \"email_verified_at\": \"2017-03-29 15:27:21\",\n \"created_at\": \"2017-01-11 21:44:02\",\n \"updated_at\": \"2017-04-24 15:41:58\",\n \"deleted_at\": null,\n \"gravatar\": \"//www.gravatar.com/avatar/157965dea7cd2f44e349382d1d791650\",\n \"team_role\": \"admin\",\n \"team_admin\": true,\n \"team_enabled\": true\n}" } }, "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "b58d7eee-e68d-4d12-a1f8-62f5e71382ae" }, "system_admin": { "type": "boolean", "example": false, "default": true }, "name": { "type": "string", "example": "Demo" }, "email": { "type": "string", "example": "contact@example.com" }, "email_verification_sent_at": { "type": "string", "example": "2017-03-29 15:27:19" }, "email_verified_at": { "type": "string", "example": "2017-03-29 15:27:21" }, "created_at": { "type": "string", "example": "2017-01-11 21:44:02" }, "updated_at": { "type": "string", "example": "2017-04-24 15:41:58" }, "deleted_at": {}, "gravatar": { "type": "string", "example": "//www.gravatar.com/avatar/157965dea7cd2f44e349382d1d791650" }, "team_role": { "type": "string", "example": "admin" }, "team_admin": { "type": "boolean", "example": true, "default": true }, "team_enabled": { "type": "boolean", "example": true, "default": true } } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"email\": [\n \"The email has already been taken.\"\n ]\n}" } }, "schema": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string", "example": "The email has already been taken." } } } } } } } }, "deprecated": false } }, "/invoice": { "post": { "summary": "Create an Invoice", "description": "Creates an invoice", "operationId": "create-an-invoice", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "customer_id": { "type": "string", "description": "If provided, it auto-assigns the invoice to a specific customer. If not, the invoice requires manual assignment before payment." }, "url": { "type": "string", "description": "Set it to https://app.staxpayments.com/#/bill/ to enable a clickable button in the invoice email, directing customers to our Stax bill pay page. Use a different URL only if you have a custom domain configured with Stax Connect.", "default": "https://app.staxpayments.com/#/bill/" }, "invoice_date_at": { "type": "string", "description": "Optional field. Defaults to current timestamp if blank. Used to track the date of service or work provided by the merchant." }, "due_at": { "type": "string", "format": "date-time", "description": "Invoice due date." }, "meta": { "properties": { "subtotal": { "type": "string", "description": "The subtotal amount of the invoice, excluding taxes and additional charges." }, "tax": { "type": "string", "description": "The tax amount applied to the invoice." }, "lineItems": { "type": "array", "items": { "properties": { "item": { "type": "string", "description": "Name of item." }, "price": { "type": "number", "description": "Price of the item." }, "quantity": { "type": "number", "description": "Amount of the item." }, "details": { "type": "string", "description": "Description of item." }, "id": { "type": "string", "description": "ID is optional and corresponds to the Stax Catalog Item Id." }, "productCode": { "type": "string", "description": "Unique product code." }, "commodityCode": { "type": "string", "description": "Merchant defined code that categorizes a line item." }, "unitOfMeasure": { "type": "string", "description": "Unit in which the item is sold. e.g., feet, each, litre, GB." }, "tax": { "type": "number", "description": "Tax amount applied to the line item." }, "taxRate": { "type": "number", "description": "Tax Rate for this line item or service." }, "discountRate": { "type": "number", "description": "Discount applied to this specific line item." }, "total": { "type": "number", "description": "Total amount for the line item." } }, "type": "object" } }, "memo": { "type": "string", "description": "Use this string field to set a customer-facing memo on the Hosted Invoice Page." }, "reference": { "type": "string", "description": "An optional reference field that can be used for internal tracking or customer reference purposes." }, "internalMemo": { "type": "string", "description": "Optional string field to set an internal memo on the invoice, viewable within Stax Pay by the merchant." }, "isCCPaymentEnabled": { "type": "boolean", "description": "Boolean field that determines if customers can pay with a credit card on the Hosted Invoice Page." }, "isACHPaymentEnabled": { "type": "boolean", "description": "Determines whether the customer can pay with ACH(bank) on the Hosted Invoice Page." }, "isTipEnabled": { "type": "string", "description": "Determines if the customer can add a tip on the hosted invoice page, which will add to the transaction's total." }, "successRedirect": { "type": "string", "description": "If provided, and if the invoice is paid on the hosted bill payment page at app.staxpayments.com/#/bill, the user will be redirected to the supplied URL after a successful payment." }, "iscnpdigitalwallet": { "type": "boolean", "description": "Set to True if this is a digital wallet payment. " } }, "required": [], "type": "object", "description": "Within this JSON object, certain fields are recognized by the Stax Pay web platform and are used for emailed receipts." }, "is_partial_payment_enabled": { "type": "boolean", "description": "Determines whether the customer can make a partial payment in the Stax Pay user interface. Set to true to allow partial payments, or false to disallow partial payments." }, "funding": { "type": "array", "description": "An array specifying funding instructions for payments made to this invoice. Each element should include an account_id that identifies the destination account and an amount specifying the portion of the payment to be allocated to that account. This feature requires Instructed Funding to be enabled.", "items": { "type": "string" } }, "total": { "type": "number", "format": "float", "description": "The total of the invoice." } }, "required": [ "url", "customer_id", "total" ] } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"id\": \"9ddcf02b-c2be-4f27-b758-dbc12b2aa924\",\n \"merchant_id\": \"dd36b936-1eb7-4ece-bebc-b514c6a36ebd\",\n \"user_id\": \"b58d7eee-e68d-4d12-a1f8-62f5e71382ae\",\n \"customer_id\": \"d45ee88c-8b27-4be8-8d81-77dda1b81826\",\n \"total\": 12,\n\t\"due_at\": \"2025-12-19 23:59:59\",\n\n \"meta\": {\n \"tax\":2,\n \"subtotal\":10,\n \"lineItems\": [\n {\n \"id\": \"optional-fm-catalog-item-id\",\n \"item\":\"Demo Item\",\n \"details\":\"this is a regular demo item\",\n \"quantity\":10,\n \"price\": 1\n }\n ],\n \"isCCPaymentEnabled\": true,\n \"isACHPaymentEnabled\": true,\n \"isTipEnabled\": true,\n \"internalMemo\": \"internalMemo\",\n \"memo\": \"customer facing memo\"\n },\n \"status\": \"DRAFT\",\n \"sent_at\": null,\n \"viewed_at\": null,\n \"paid_at\": null,\n \"schedule_id\": null,\n \"reminder_id\": null,\n \"payment_method_id\": \"\",\n \"url\": \"https://app.staxpayments.com/#/bill/\",\n \"is_webpayment\": false,\n \"is_partial_payment_enabled\": true\n \"deleted_at\": null,\n \"created_at\": \"2017-05-08 21:32:51\",\n \"updated_at\": \"2017-05-08 21:32:51\",\n \"payment_attempt_failed\": false,\n \"payment_attempt_message\": \"\",\n \"balance_due\": 10,\n \"total_paid\": 0,\n \"payment_meta\": [],\n \"customer\": {\n \"id\": \"d45ee88c-8b27-4be8-8d81-77dda1b81826\",\n \"firstname\": \"John\",\n \"lastname\": \"Smith\",\n \"company\": \"ABC INC\",\n \"email\": \"demo@abc.com\",\n \"cc_emails\": [\n \"demo1@abc.com\",\n \"demo2@abc.com\"\n ],\n \"phone\": \"1234567898\",\n \"address_1\": \"123 Rite Way\",\n \"address_2\": \"Unit 12\",\n \"address_city\": \"Orlando\",\n \"address_state\": \"FL\",\n \"address_zip\": \"32801\",\n \"address_country\": \"USA\",\n \"notes\": null,\n \"reference\": \"BARTLE\",\n \"options\": \"\",\n \"created_at\": \"2017-05-08 19:22:51\",\n \"updated_at\": \"2017-05-08 19:23:46\",\n \"deleted_at\": null,\n \"gravatar\": \"//www.gravatar.com/avatar/fe3e929dd80f1653c3a4b82812660061\"\n },\n \"user\": {\n \"id\": \"b58d7eee-e68d-4d12-a1f8-62f5e71382ae\",\n \"system_admin\": false,\n \"name\": \"Demo\",\n \"email\": \"contact@example.com\",\n \"email_verification_sent_at\": \"2017-03-29 15:27:19\",\n \"email_verified_at\": \"2017-03-29 15:27:21\",\n \"is_api_key\": false,\n \"created_at\": \"2017-01-11 21:44:02\",\n \"updated_at\": \"2017-04-24 15:41:58\",\n \"deleted_at\": null,\n \"gravatar\": \"//www.gravatar.com/avatar/157965dea7cd2f44e349382d1d791650\",\n \"team_admin\": null,\n \"team_enabled\": null,\n \"team_role\": null\n },\n \"files\": [],\n \"child_transactions\": [],\n \"reminder\": null\n}" } } } } }, "422": { "description": "422", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"customer_id\": [\"The customer id field is required.\"],\n \"url\": [\"The url field is required.\"],\n \"meta\": [\"The meta field is required.\"],\n \"meta\": [\"The meta field should not contain more than 60.000 characters\"]\n \"total\": [\"The total field is required.\"],\n \"files.0\": [\"The selected files.0 is invalid.\"]\n\n}" } } } } } } }, "get": { "summary": "Get All Invoices", "description": "", "operationId": "get-all-invoices", "parameters": [ { "name": "id", "in": "query", "schema": { "type": "string" } }, { "name": "name", "in": "query", "schema": { "type": "string" } }, { "name": "keywords[]", "in": "query", "schema": { "type": "string" } }, { "name": "company_name", "in": "query", "schema": { "type": "string" } }, { "name": "email", "in": "query", "schema": { "type": "string" } }, { "name": "address", "in": "query", "schema": { "type": "string" } }, { "name": "price", "in": "query", "schema": { "type": "string" } }, { "name": "schedule_id", "in": "query", "schema": { "type": "string" } }, { "name": "payment_method", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": { "total": 2, "per_page": 25, "current_page": 1, "last_page": 4, "next_page_url": null, "prev_page_url": null, "from": 1, "to": 25, "data": [ { "id": "8cbb929d-55d9-43b5-8d90-af3cab04ce17", "merchant_id": "dd36b936-1eb7-4ece-bebc-b514c6a36ebd", "user_id": "b58d7eee-e68d-4d12-a1f8-62f5e71382ae", "customer_id": "17a51927-312e-47e3-9b23-412f298888e3", "total": 10, "meta": { "tax": 0, "subtotal": 10, "lineItems": [ { "id": "optional-fm-catalog-item-id", "item": "Demo Item", "details": "This is a demo item", "quantity": 1, "price": 10 } ] }, "status": "SENT", "sent_at": "2025-04-24 15:16:15", "viewed_at": null, "paid_at": null, "schedule_id": "e70c126c-f7b7-4673-a129-5b650f00f84a", "reminder_id": "a6411419-0e95-4380-9d4e-94bdaced9d14", "payment_method_id": "", "url": "https://app.staxpayments.com/#/bill/", "is_webpayment": false, "deleted_at": null, "created_at": "2025-04-08 20:49:04", "updated_at": "2025-04-24 15:16:15", "payment_attempt_failed": false, "payment_attempt_message": "", "balance_due": 12, "total_paid": 0, "payment_meta": [], "customer": { "id": "17a51927-312e-47e3-9b23-412f298888e3", "firstname": "David", "lastname": "Bowie", "company": "Your Company Demo", "email": "staxdemo@demo.com", "cc_emails": null, "phone": "5555555555", "address_1": "608 Orange Ave.", "address_2": "Unit 12", "address_city": "Orlando", "address_state": "FL", "address_zip": "32801", "address_country": "USA", "notes": null, "reference": "", "options": "", "created_at": "2024-12-01 16:44:33", "updated_at": "2024-12-01 16:44:33", "deleted_at": null, "gravatar": "//www.gravatar.com/avatar/144fa42eb34883ecb00cbc3f81a060a1" }, "user": { "id": "b58d7eee-e68d-4d12-a1f8-62f5e71382ae", "system_admin": false, "name": "Demo User", "email": "contact@example.com", "email_verification_sent_at": "2025-03-29 15:27:19", "email_verified_at": "2025-03-29 15:27:21", "is_api_key": false, "created_at": "2025-01-11 21:44:02", "updated_at": "2025-04-24 15:41:58", "deleted_at": null, "gravatar": "//www.gravatar.com/avatar/157965dea7cd2f44e349382d1d791650", "team_admin": null, "team_enabled": null, "team_role": null }, "files": [], "child_transactions": [], "reminder": { "id": "a6411419-0e95-4380-9d4e-94bdaced9d14", "merchant_id": "", "user_id": "", "active": true, "count": 3, "rule": "FREQ=DAILY;COUNT=3;INTERVAL=5;WKST=MO;DTSTART=20250413T204904Z", "last_run_at": "2025-04-24 15:16:15", "next_run_at": null, "event": "InvoiceReminder", "meta": null, "payment_method_id": "", "customer_id": "17a51927-312e-47e3-9b23-412f298888e3", "created_at": "2025-04-08 20:49:04", "updated_at": "2025-04-24 15:16:15", "deleted_at": null, "rule_text": "every 5 days for 3 times", "future_occurrences": [], "max": 3, "end_at": null, "status": "COMPLETED" } }, { "id": "2744a7fd-d354-47a0-a99e-f6f3e96bffe1", "merchant_id": "dd36b936-1eb7-4ece-bebc-b514c6a36ebd", "user_id": "b58d7eee-e68d-4d12-a1f8-62f5e71382ae", "customer_id": "ffed4fd2-977e-412f-9048-293bb5e46c68", "total": 77, "meta": { "lineItems": [ { "item": "", "details": "", "quantity": 1, "price": "77" } ], "memo": "", "subtotal": 77, "tax": "", "type": "invoice/schedule" }, "status": "VIEWED", "sent_at": "2025-04-08 20:49:03", "viewed_at": null, "paid_at": "2025-04-08 20:49:03", "schedule_id": "85211708-5995-4e2f-83c3-7017cdbee25f", "reminder_id": null, "payment_method_id": "ad03da14-4f2b-4b43-8e12-e8d784018d79", "url": "https://app.staxpayments.com/#/bill/", "is_webpayment": false, "deleted_at": null, "created_at": "2025-04-08 20:49:02", "updated_at": "2025-04-24 19:38:42", "payment_attempt_failed": false, "payment_attempt_message": "", "balance_due": 77, "total_paid": 0, "payment_meta": { "lineItems": [ { "item": "", "details": "", "quantity": 1, "price": "77" } ], "memo": "", "subtotal": 77, "tax": "", "type": "invoice/schedule" }, "customer": { "id": "ffed4fd2-977e-412f-9048-293bb5e46c68", "firstname": "STAX", "lastname": "USER", "company": "Demo Company Name", "email": "staxdemo@demo.com", "cc_emails": null, "phone": "5555555555", "address_1": "608 Orange Ave.", "address_2": "Unit 12", "address_city": "Orlando", "address_state": "FL", "address_zip": "32801", "address_country": "USA", "notes": null, "reference": "BARTLE", "options": "", "created_at": "2025-03-31 17:04:27", "updated_at": "2025-03-31 17:04:27", "deleted_at": null, "gravatar": "//www.gravatar.com/avatar/144fa42eb34883ecb00cbc3f81a060a1" }, "user": { "id": "b58d7eee-e68d-4d12-a1f8-62f5e71382ae", "system_admin": false, "name": "Demo", "email": "contact@example.com", "email_verification_sent_at": "2025-03-29 15:27:19", "email_verified_at": "2025-03-29 15:27:21", "is_api_key": false, "created_at": "2025-01-11 21:44:02", "updated_at": "2025-04-24 15:41:58", "deleted_at": null, "gravatar": "//www.gravatar.com/avatar/157965dea7cd2f44e349382d1d791650", "team_admin": null, "team_enabled": null, "team_role": null }, "files": [], "child_transactions": [ { "id": "61b4a861-446f-45f8-b319-2ce98876751b", "invoice_id": "2744a7fd-d354-47a0-a99e-f6f3e96bffe1", "reference_id": "16427f4d-f33c-4e07-bfd3-beb2dfa55ca2", "recurring_transaction_id": "", "type": "refund", "source": null, "merchant_id": "dd36b936-1eb7-4ece-bebc-b514c6a36ebd", "user_id": "b58d7eee-e68d-4d12-a1f8-62f5e71382ae", "customer_id": "ffed4fd2-977e-412f-9048-293bb5e46c68", "payment_method_id": "ad03da14-4f2b-4b43-8e12-e8d784018d79", "is_manual": null, "success": true, "message": null, "meta": { "lineItems": [ { "item": "", "details": "", "quantity": 1, "price": "77" } ], "memo": "", "subtotal": 77, "tax": "", "type": "invoice/schedule" }, "total": 77, "method": "card", "pre_auth": false, "last_four": "1111", "receipt_email_at": null, "receipt_sms_at": null, "created_at": "2025-04-24 19:38:41", "updated_at": "2025-04-24 19:38:41", "total_refunded": null, "is_refundable": false, "is_voided": null, "is_voidable": false, "schedule_id": "85211708-5995-4e2f-83c3-7017cdbee25f", "customer": { "id": "ffed4fd2-977e-412f-9048-293bb5e46c68", "firstname": "STAX", "lastname": "USER", "company": "Demo Company Name", "email": "staxdemo@demo.com", "cc_emails": null, "phone": "5555555555", "address_1": "608 Orange Ave.", "address_2": "Unit 12", "address_city": "Orlando", "address_state": "FL", "address_zip": "32801", "address_country": "USA", "notes": null, "reference": "BARTLE", "options": "", "created_at": "2025-03-31 17:04:27", "updated_at": "2025-03-31 17:04:27", "deleted_at": null, "gravatar": "//www.gravatar.com/avatar/144fa42eb34883ecb00cbc3f81a060a1" }, "child_transactions": [], "files": [], "payment_method": { "id": "ad03da14-4f2b-4b43-8e12-e8d784018d79", "customer_id": "ffed4fd2-977e-412f-9048-293bb5e46c68", "merchant_id": "dd36b936-1eb7-4ece-bebc-b514c6a36ebd", "user_id": "b58d7eee-e68d-4d12-a1f8-62f5e71382ae", "nickname": "VISA: STAX USER (ending in: 1111)", "is_default": 0, "method": "card", "person_name": "STAX USER", "card_type": "visa", "card_last_four": "1111", "card_exp": "022020", "bank_name": null, "bank_type": null, "bank_holder_type": null, "address_1": null, "address_2": null, "address_city": null, "address_state": null, "address_zip": null, "address_country": "USA", "purged_at": null, "deleted_at": null, "created_at": "2025-04-05 15:30:05", "updated_at": "2025-04-05 15:30:05", "card_exp_datetime": "2020-02-29 23:59:59", "customer": { "id": "ffed4fd2-977e-412f-9048-293bb5e46c68", "firstname": "STAX", "lastname": "USER", "company": "Demo Company Name", "email": "staxdemo@demo.com", "cc_emails": null, "phone": "5555555555", "address_1": "608 Orange Ave.", "address_2": "Unit 12", "address_city": "Orlando", "address_state": "FL", "address_zip": "32801", "address_country": "USA", "notes": null, "reference": "BARTLE", "options": "", "created_at": "2025-03-31 17:04:27", "updated_at": "2025-03-31 17:04:27", "deleted_at": null, "gravatar": "//www.gravatar.com/avatar/144fa42eb34883ecb00cbc3f81a060a1" } }, "user": { "id": "b58d7eee-e68d-4d12-a1f8-62f5e71382ae", "system_admin": false, "name": "Demo", "email": "contact@example.com", "email_verification_sent_at": "2025-03-29 15:27:19", "email_verified_at": "2025-03-29 15:27:21", "is_api_key": false, "created_at": "2025-01-11 21:44:02", "updated_at": "2025-04-24 15:41:58", "deleted_at": null, "gravatar": "//www.gravatar.com/avatar/157965dea7cd2f44e349382d1d791650", "team_admin": null, "team_enabled": null, "team_role": null } }, { "id": "16427f4d-f33c-4e07-bfd3-beb2dfa55ca2", "invoice_id": "2744a7fd-d354-47a0-a99e-f6f3e96bffe1", "reference_id": "", "recurring_transaction_id": "", "type": "charge", "source": null, "merchant_id": "dd36b936-1eb7-4ece-bebc-b514c6a36ebd", "user_id": "b58d7eee-e68d-4d12-a1f8-62f5e71382ae", "customer_id": "ffed4fd2-977e-412f-9048-293bb5e46c68", "payment_method_id": "ad03da14-4f2b-4b43-8e12-e8d784018d79", "is_manual": null, "success": true, "message": null, "meta": { "lineItems": [ { "item": "", "details": "", "quantity": 1, "price": "77" } ], "memo": "", "subtotal": 77, "tax": "", "type": "invoice/schedule" }, "total": 77, "method": "card", "pre_auth": false, "last_four": "1111", "receipt_email_at": null, "receipt_sms_at": null, "created_at": "2025-04-08 20:49:02", "updated_at": "2025-04-08 20:49:02", "total_refunded": 77, "is_refundable": false, "is_voided": false, "is_voidable": false, "schedule_id": "85211708-5995-4e2f-83c3-7017cdbee25f", "customer": { "id": "ffed4fd2-977e-412f-9048-293bb5e46c68", "firstname": "STAX", "lastname": "USER", "company": "Demo Company Name", "email": "staxdemo@demo.com", "cc_emails": null, "phone": "5555555555", "address_1": "608 Orange Ave.", "address_2": "Unit 12", "address_city": "Orlando", "address_state": "FL", "address_zip": "32801", "address_country": "USA", "notes": null, "reference": "BARTLE", "options": "", "created_at": "2025-03-31 17:04:27", "updated_at": "2025-03-31 17:04:27", "deleted_at": null, "gravatar": "//www.gravatar.com/avatar/144fa42eb34883ecb00cbc3f81a060a1" }, "child_transactions": [ { "id": "61b4a861-446f-45f8-b319-2ce98876751b", "invoice_id": "2744a7fd-d354-47a0-a99e-f6f3e96bffe1", "reference_id": "16427f4d-f33c-4e07-bfd3-beb2dfa55ca2", "recurring_transaction_id": "", "type": "refund", "source": null, "merchant_id": "dd36b936-1eb7-4ece-bebc-b514c6a36ebd", "user_id": "b58d7eee-e68d-4d12-a1f8-62f5e71382ae", "customer_id": "ffed4fd2-977e-412f-9048-293bb5e46c68", "payment_method_id": "ad03da14-4f2b-4b43-8e12-e8d784018d79", "is_manual": null, "success": true, "message": null, "meta": { "lineItems": [ { "item": "", "details": "", "quantity": 1, "price": "77" } ], "memo": "", "subtotal": 77, "tax": "", "type": "invoice/schedule" }, "total": 77, "method": "card", "pre_auth": false, "last_four": "1111", "receipt_email_at": null, "receipt_sms_at": null, "created_at": "2025-04-24 19:38:41", "updated_at": "2025-04-24 19:38:41", "total_refunded": null, "is_refundable": false, "is_voided": null, "is_voidable": false, "schedule_id": "85211708-5995-4e2f-83c3-7017cdbee25f", "customer": { "id": "ffed4fd2-977e-412f-9048-293bb5e46c68", "firstname": "STAX", "lastname": "USER", "company": "Demo Company Name", "email": "staxdemo@demo.com", "cc_emails": null, "phone": "5555555555", "address_1": "608 Orange Ave.", "address_2": "Unit 12", "address_city": "Orlando", "address_state": "FL", "address_zip": "32801", "address_country": "USA", "notes": null, "reference": "BARTLE", "options": "", "created_at": "2025-03-31 17:04:27", "updated_at": "2025-03-31 17:04:27", "deleted_at": null, "gravatar": "//www.gravatar.com/avatar/144fa42eb34883ecb00cbc3f81a060a1" }, "child_transactions": [], "files": [], "payment_method": { "id": "ad03da14-4f2b-4b43-8e12-e8d784018d79", "customer_id": "ffed4fd2-977e-412f-9048-293bb5e46c68", "merchant_id": "dd36b936-1eb7-4ece-bebc-b514c6a36ebd", "user_id": "b58d7eee-e68d-4d12-a1f8-62f5e71382ae", "nickname": "VISA: STAX USER (ending in: 1111)", "is_default": 0, "method": "card", "person_name": "STAX USER", "card_type": "visa", "card_last_four": "1111", "card_exp": "022020", "bank_name": null, "bank_type": null, "bank_holder_type": null, "address_1": null, "address_2": null, "address_city": null, "address_state": null, "address_zip": null, "address_country": "USA", "purged_at": null, "deleted_at": null, "created_at": "2025-04-05 15:30:05", "updated_at": "2025-04-05 15:30:05", "card_exp_datetime": "2020-02-29 23:59:59", "customer": { "id": "ffed4fd2-977e-412f-9048-293bb5e46c68", "firstname": "STAX", "lastname": "USER", "company": "Demo Company Name", "email": "staxdemo@demo.com", "cc_emails": null, "phone": "5555555555", "address_1": "608 Orange Ave.", "address_2": "Unit 12", "address_city": "Orlando", "address_state": "FL", "address_zip": "32801", "address_country": "USA", "notes": null, "reference": "BARTLE", "options": "", "created_at": "2025-03-31 17:04:27", "updated_at": "2025-03-31 17:04:27", "deleted_at": null, "gravatar": "//www.gravatar.com/avatar/144fa42eb34883ecb00cbc3f81a060a1" } }, "user": { "id": "b58d7eee-e68d-4d12-a1f8-62f5e71382ae", "system_admin": false, "name": "Demo", "email": "contact@example.com", "email_verification_sent_at": "2025-03-29 15:27:19", "email_verified_at": "2025-03-29 15:27:21", "is_api_key": false, "created_at": "2025-01-11 21:44:02", "updated_at": "2025-04-24 15:41:58", "deleted_at": null, "gravatar": "//www.gravatar.com/avatar/157965dea7cd2f44e349382d1d791650", "team_admin": null, "team_enabled": null, "team_role": null } } ], "files": [], "payment_method": { "id": "ad03da14-4f2b-4b43-8e12-e8d784018d79", "customer_id": "ffed4fd2-977e-412f-9048-293bb5e46c68", "merchant_id": "dd36b936-1eb7-4ece-bebc-b514c6a36ebd", "user_id": "b58d7eee-e68d-4d12-a1f8-62f5e71382ae", "nickname": "VISA: STAX USER (ending in: 1111)", "is_default": 0, "method": "card", "person_name": "STAX USER", "card_type": "visa", "card_last_four": "1111", "card_exp": "022020", "bank_name": null, "bank_type": null, "bank_holder_type": null, "address_1": null, "address_2": null, "address_city": null, "address_state": null, "address_zip": null, "address_country": "USA", "purged_at": null, "deleted_at": null, "created_at": "2025-04-05 15:30:05", "updated_at": "2025-04-05 15:30:05", "card_exp_datetime": "2020-02-29 23:59:59", "customer": { "id": "ffed4fd2-977e-412f-9048-293bb5e46c68", "firstname": "STAX", "lastname": "USER", "company": "Demo Company Name", "email": "staxdemo@demo.com", "cc_emails": null, "phone": "5555555555", "address_1": "608 Orange Ave.", "address_2": "Unit 12", "address_city": "Orlando", "address_state": "FL", "address_zip": "32801", "address_country": "USA", "notes": null, "reference": "BARTLE", "options": "", "created_at": "2025-03-31 17:04:27", "updated_at": "2025-03-31 17:04:27", "deleted_at": null, "gravatar": "//www.gravatar.com/avatar/144fa42eb34883ecb00cbc3f81a060a1" } }, "user": { "id": "b58d7eee-e68d-4d12-a1f8-62f5e71382ae", "system_admin": false, "name": "Demo", "email": "contact@example.com", "email_verification_sent_at": "2025-03-29 15:27:19", "email_verified_at": "2025-03-29 15:27:21", "is_api_key": false, "created_at": "2025-01-11 21:44:02", "updated_at": "2025-04-24 15:41:58", "deleted_at": null, "gravatar": "//www.gravatar.com/avatar/157965dea7cd2f44e349382d1d791650", "team_admin": null, "team_enabled": null, "team_role": null } } ], "reminder": null } ] } } }, "schema": { "type": "object", "properties": {} } } } } }, "deprecated": false } }, "/item": { "post": { "summary": "Create a Catalog Item", "description": "Creates an item to be stored in a merchant's catalog.", "operationId": "create-catalog-item", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "item" ], "properties": { "item": { "type": "string" }, "code": { "type": "string", "description": "Internal code for the item." }, "details": { "type": "string", "description": "Provides a description of the item." }, "category": { "type": "string", "description": "Provide a description or category to organize items." }, "price": { "type": "number", "description": "Price of the item.", "format": "float" }, "in_stock": { "type": "integer", "description": "Set exact quantity.", "format": "int32" }, "is_service": { "type": "boolean", "description": "Determine if it is a service or product." }, "is_active": { "type": "boolean", "description": "Sets whether this item is active or inactive." }, "is_taxable": { "type": "boolean", "description": "Sets whether the item is taxable or not." }, "is_discount": { "type": "boolean", "description": "Sets the item to a discount. If true, this will override the is_service variable." }, "user_id": { "type": "string" }, "meta": { "type": "string" }, "thumbnail_id": { "type": "string" }, "files": { "type": "string" } } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": { "id": "9cf3bd88-da1b-4f35-a5a1-74153c8e7f28", "user_id": "2d089742-6aca-462d-8db3-c2966e1f9e68", "merchant_id": "a61d78cc-cde9-44ac-8a18-30c39be05879", "thumbnail_id": null, "item": "test item", "code": "aaaa", "category": "essential items", "details": "just a test item", "is_active": true, "is_taxable": false, "is_service": false, "is_discount": false, "price": 7.11, "in_stock": 0, "low_stock_alert": 3, "meta": [], "created_at": "2018-10-02 14:28:50", "updated_at": "2018-10-02 14:28:50", "deleted_at": null, "user": { "id": "2d089742-6aca-462d-8db3-c2966e1f9e68", "system_admin": true, "name": "Morty Junior", "email": "contact@example.com", "email_verification_sent_at": "2018-09-26 18:24:21", "email_verified_at": "2016-05-11 17:13:33", "is_api_key": false, "acknowledgments": { "signedApplication": true, "editedOnboardingInformation": false, "tutorial": true, "godviewWelcome": true }, "created_at": "2016-05-18 14:11:46", "updated_at": "2018-09-26 18:24:21", "deleted_at": null, "gravatar": "//www.gravatar.com/avatar/772cbf95746d7da86789cc3634c46ba8", "team_admin": null, "team_enabled": null, "team_role": null, "merchant_options": [], "is_default": false }, "files": [], "thumbnail": null } } }, "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "9cf3bd88-da1b-4f35-a5a1-74153c8e7f28" }, "user_id": { "type": "string", "example": "2d089742-6aca-462d-8db3-c2966e1f9e68" }, "merchant_id": { "type": "string", "example": "a61d78cc-cde9-44ac-8a18-30c39be05879" }, "thumbnail_id": { "type": "string" }, "item": { "type": "string", "example": "test item" }, "code": { "type": "string", "example": "aaaa" }, "category": { "type": "string", "example": "essential items" }, "details": { "type": "string", "example": "just a test item" }, "is_active": { "type": "boolean", "example": true, "default": true }, "is_taxable": { "type": "boolean", "example": false, "default": true }, "is_service": { "type": "boolean", "example": false, "default": true }, "is_subscription": { "type": "boolean", "example": false, "default": true }, "is_discount": { "type": "boolean", "example": false, "default": true }, "price": { "type": "number", "example": 7.11, "default": 0 }, "in_stock": { "type": "integer", "example": 0, "default": 0 }, "low_stock_alert": { "type": "integer", "example": 3, "default": 0 }, "meta": { "type": "array" }, "created_at": { "type": "string", "example": "2018-10-02 14:28:50" }, "updated_at": { "type": "string", "example": "2018-10-02 14:28:50" }, "deleted_at": {}, "user": { "type": "object", "properties": { "id": { "type": "string", "example": "2d089742-6aca-462d-8db3-c2966e1f9e68" }, "system_admin": { "type": "boolean", "example": true, "default": true }, "name": { "type": "string", "example": "Morty Junior" }, "email": { "type": "string", "example": "contact@example.com" }, "email_verification_sent_at": { "type": "string", "example": "2018-09-26 18:24:21" }, "email_verified_at": { "type": "string", "example": "2016-05-11 17:13:33" }, "is_api_key": { "type": "boolean", "example": false, "default": true }, "acknowledgments": { "type": "object", "properties": { "signedApplication": { "type": "boolean", "example": true, "default": true }, "editedOnboardingInformation": { "type": "boolean", "example": false, "default": true }, "tutorial": { "type": "boolean", "example": true, "default": true }, "godviewWelcome": { "type": "boolean", "example": true, "default": true } } }, "created_at": { "type": "string", "example": "2016-05-18 14:11:46" }, "updated_at": { "type": "string", "example": "2018-09-26 18:24:21" }, "deleted_at": {}, "gravatar": { "type": "string", "example": "//www.gravatar.com/avatar/772cbf95746d7da86789cc3634c46ba8" }, "team_admin": {}, "team_enabled": {}, "team_role": {}, "merchant_options": { "type": "array" }, "is_default": { "type": "boolean", "example": false, "default": true } } }, "files": { "type": "array" }, "thumbnail": {} } } } } }, "422": { "description": "422", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"sort\": [\n \"The selected sort is invalid.\"\n ],\n \"order\": [\n \"The selected order is invalid.\"\n ],\n \"is_active\": [\n \"The is active field must be true or false.\"\n ]\n}" } }, "schema": { "type": "object", "properties": { "sort": { "type": "array", "items": { "type": "string", "example": "The selected sort is invalid." } }, "order": { "type": "array", "items": { "type": "string", "example": "The selected order is invalid." } }, "is_active": { "type": "array", "items": { "type": "string", "example": "The is active field must be true or false." } } } } } } } }, "deprecated": false }, "get": { "summary": "Retrieve All Catalog Items", "description": "Retrieves all the items saved under a merchant's catalog.", "operationId": "retrieve-all-catalog-items", "parameters": [ { "name": "code", "in": "query", "description": "Filter by items of the exact code", "schema": { "type": "string" } }, { "name": "price", "in": "query", "description": "Filters by items of the exact price.", "schema": { "type": "number", "format": "float" } }, { "name": "quantity", "in": "query", "description": "Filters by items of the exact quantity.", "schema": { "type": "string" } }, { "name": "is_service", "in": "query", "description": "Filters for services.", "schema": { "type": "boolean" } }, { "name": "is_active", "in": "query", "description": "Filters for active items.", "schema": { "type": "boolean" } }, { "name": "is_taxable", "in": "query", "description": "Filters for taxable items.", "schema": { "type": "boolean" } }, { "name": "is_discount", "in": "query", "description": "Filters if the item is discounted or not.", "schema": { "type": "boolean" } }, { "name": "user_id", "in": "query", "schema": { "type": "string" }, "description": "Filters by user id." }, { "name": "name", "in": "query", "schema": { "type": "string" }, "description": "Filters out any items that don't share the inputted name. Does not have to be exact." }, { "name": "description", "in": "query", "schema": { "type": "string" }, "description": "Filters by part of description." }, { "name": "meta", "in": "query", "schema": { "type": "string" }, "description": "Filters by meta. Does not have to be exact." } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"total\": 2,\n \"per_page\": 25,\n \"current_page\": 1,\n \"last_page\": 1,\n \"next_page_url\": null,\n \"prev_page_url\": null,\n \"from\": 1,\n \"to\": 2,\n \"data\": [\n {\n \"id\": \"79256d84-3930-4e4b-bc71-9c6587cfc65c\",\n \"user_id\": \"b58d7eee-e68d-4d12-a1f8-62f5e71382ae\",\n \"merchant_id\": \"dd36b936-1eb7-4ece-bebc-b514c6a36ebd\",\n \"thumbnail_id\": null,\n \"item\": \"meeseeks\",\n \"code\": \"aaaa\",\n \"details\": \"just a test item\",\n \"is_active\": true,\n \"is_taxable\": false,\n \"is_service\": false,\n \"is_discount\": false,\n \"price\": 7.11,\n \"in_stock\": 0,\n \"meta\": [],\n \"created_at\": \"2017-05-05 19:49:21\",\n \"updated_at\": \"2017-05-05 19:49:21\",\n \"deleted_at\": null,\n \"deprecation_warning\": \"The name and decription fiels will be deprecated on 7/1/17\",\n \"user\": {\n \"id\": \"b58d7eee-e68d-4d12-a1f8-62f5e71382ae\",\n \"system_admin\": false,\n \"name\": \"Test Guy\",\n \"email\": \"contact@example.com\",\n \"email_verification_sent_at\": \"2017-03-29 15:27:19\",\n \"email_verified_at\": \"2017-03-29 15:27:21\",\n \"is_api_key\": false,\n \"created_at\": \"2017-01-11 21:44:02\",\n \"updated_at\": \"2017-04-24 15:41:58\",\n \"deleted_at\": null,\n \"gravatar\": \"//www.gravatar.com/avatar/157965dea7cd2f44e349382d1d791650\",\n \"team_admin\": null,\n \"team_enabled\": null,\n \"team_role\": null\n },\n \"files\": [],\n \"thumbnail\": null\n },\n {\n \"id\": \"62c6c812-36e6-4037-9569-caa1dfe968de\",\n \"user_id\": \"b58d7eee-e68d-4d12-a1f8-62f5e71382ae\",\n \"merchant_id\": \"dd36b936-1eb7-4ece-bebc-b514c6a36ebd\",\n \"thumbnail_id\": null,\n \"item\": \"Meeseeks Box\",\n \"code\": null,\n \"details\": null,\n \"is_active\": true,\n \"is_taxable\": false,\n \"is_service\": true,\n \"is_discount\": true,\n \"price\": 55,\n \"in_stock\": 0,\n \"meta\": [],\n \"created_at\": \"2017-05-05 19:55:05\",\n \"updated_at\": \"2017-05-05 19:55:06\",\n \"deleted_at\": null,\n \"deprecation_warning\": \"The name and decription fiels will be deprecated on 7/1/17\",\n \"user\": {\n \"id\": \"b58d7eee-e68d-4d12-a1f8-62f5e71382ae\",\n \"system_admin\": false,\n \"name\": \"test guy\",\n \"email\": \"contact@example.com\",\n \"email_verification_sent_at\": \"2017-03-29 15:27:19\",\n \"email_verified_at\": \"2017-03-29 15:27:21\",\n \"is_api_key\": false,\n \"created_at\": \"2017-01-11 21:44:02\",\n \"updated_at\": \"2017-04-24 15:41:58\",\n \"deleted_at\": null,\n \"gravatar\": \"//www.gravatar.com/avatar/157965dea7cd2f44e349382d1d791650\",\n \"team_admin\": null,\n \"team_enabled\": null,\n \"team_role\": null\n },\n \"files\": [\n {\n \"id\": \"cc5d4376-8a76-4de1-8fc1-b9135be5f26f\",\n \"merchant_id\": \"dd36b936-1eb7-4ece-bebc-b514c6a36ebd\",\n \"user_id\": \"b58d7eee-e68d-4d12-a1f8-62f5e71382ae\",\n \"name\": \"meeseeks.png\",\n \"public_url\": \"https://s3-us-west-2.amazonaws.com/fattpaydocuments/cc5d4376-8a76-4de1-8fc1-b9135be5f26f.png\",\n \"tag\": null,\n \"meta\": {\n \"filesize_bytes\": 14181,\n \"filesize\": \"0.14 kB\",\n \"extension\": \"png\",\n \"size\": {\n \"width\": 128,\n \"height\": 128\n },\n \"mime\": \"image/png\"\n },\n \"created_at\": \"2017-05-05 19:55:00\",\n \"updated_at\": \"2017-05-05 19:55:01\",\n \"deleted_at\": null\n }\n ],\n \"thumbnail\": null\n }\n ]\n}" } }, "schema": { "type": "object", "properties": { "total": { "type": "integer", "example": 2, "default": 0 }, "per_page": { "type": "integer", "example": 25, "default": 0 }, "current_page": { "type": "integer", "example": 1, "default": 0 }, "last_page": { "type": "integer", "example": 1, "default": 0 }, "next_page_url": {}, "prev_page_url": {}, "from": { "type": "integer", "example": 1, "default": 0 }, "to": { "type": "integer", "example": 2, "default": 0 }, "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "79256d84-3930-4e4b-bc71-9c6587cfc65c" }, "user_id": { "type": "string", "example": "b58d7eee-e68d-4d12-a1f8-62f5e71382ae" }, "merchant_id": { "type": "string", "example": "dd36b936-1eb7-4ece-bebc-b514c6a36ebd" }, "thumbnail_id": {}, "item": { "type": "string", "example": "meeseeks" }, "code": { "type": "string", "example": "aaaa" }, "details": { "type": "string", "example": "just a test item" }, "is_active": { "type": "boolean", "example": true, "default": true }, "is_taxable": { "type": "boolean", "example": false, "default": true }, "is_service": { "type": "boolean", "example": false, "default": true }, "is_discount": { "type": "boolean", "example": false, "default": true }, "price": { "type": "number", "example": 7.11, "default": 0 }, "in_stock": { "type": "integer", "example": 0, "default": 0 }, "meta": { "type": "array" }, "created_at": { "type": "string", "example": "2017-05-05 19:49:21" }, "updated_at": { "type": "string", "example": "2017-05-05 19:49:21" }, "deleted_at": {}, "deprecation_warning": { "type": "string", "example": "The name and decription fiels will be deprecated on 7/1/17" }, "user": { "type": "object", "properties": { "id": { "type": "string", "example": "b58d7eee-e68d-4d12-a1f8-62f5e71382ae" }, "system_admin": { "type": "boolean", "example": false, "default": true }, "name": { "type": "string", "example": "Test Guy" }, "email": { "type": "string", "example": "contact@example.com" }, "email_verification_sent_at": { "type": "string", "example": "2017-03-29 15:27:19" }, "email_verified_at": { "type": "string", "example": "2017-03-29 15:27:21" }, "is_api_key": { "type": "boolean", "example": false, "default": true }, "created_at": { "type": "string", "example": "2017-01-11 21:44:02" }, "updated_at": { "type": "string", "example": "2017-04-24 15:41:58" }, "deleted_at": {}, "gravatar": { "type": "string", "example": "//www.gravatar.com/avatar/157965dea7cd2f44e349382d1d791650" }, "team_admin": {}, "team_enabled": {}, "team_role": {} } }, "files": { "type": "array" }, "thumbnail": {} } } } } } } } }, "422": { "description": "422", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"sort\": [\n \"The selected sort is invalid.\"\n ],\n \"order\": [\n \"The selected order is invalid.\"\n ],\n \"is_active\": [\n \"The is active field must be true or false.\"\n ]\n}" } }, "schema": { "type": "object", "properties": { "sort": { "type": "array", "items": { "type": "string", "example": "The selected sort is invalid." } }, "order": { "type": "array", "items": { "type": "string", "example": "The selected order is invalid." } }, "is_active": { "type": "array", "items": { "type": "string", "example": "The is active field must be true or false." } } } } } } } }, "deprecated": false } }, "/customer": { "post": { "summary": "Create Customer", "description": "Create and store customer records tied to their merchant accounts.", "operationId": "create-customer", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "firstname": { "type": "string", "description": "Max: 255. Required if no lastname, email, company supplied" }, "lastname": { "type": "string", "description": "Max: 255. Required if no firstname, email, company supplied" }, "email": { "type": "string", "description": "Max: 255. Required if no firstname, lastname, company supplied" }, "company": { "type": "string", "description": "Max: 255. Required if no firstname, lastname, email supplied" }, "phone": { "type": "string", "description": "Matching regex: /[0-9]{10,15}/" }, "address_1": { "type": "string", "description": "Max: 255" }, "address_2": { "type": "string", "description": "Max: 255" }, "address_city": { "type": "string", "description": "Max: 255" }, "address_state": { "type": "string", "description": "Max: 2 Use the two-letter state abbreviation." }, "address_zip": { "type": "string", "description": "Max: 16" }, "address_country": { "type": "string", "description": "Max: 3" }, "notes": { "type": "string", "description": "Max: 21844. For internal notes only; not visible to customers in invoices or communications." }, "reference": { "type": "string", "description": "Max: 255. This field is for the merchant's internal use." }, "files": { "type": "array", "description": "Array of strings(50) where each index is a valid file_id", "items": { "type": "string" } }, "cc_emails": { "type": "array", "description": "Array of strings(255) where each index is a valid email address.", "items": { "type": "string" } }, "cc_sms": { "type": "array", "description": "Array of strings(255) where each item is a valid phone number.", "items": { "type": "string" } }, "allow_invoice_credit_card_payments": { "type": "boolean" }, "options": { "type": "object", "description": "Additional customer options such as custom fields", "properties": { "customer_custom_fields": { "type": "array", "items": { "properties": { "id": { "type": "string", "description": "Unique identifier for the custom field" }, "name": { "type": "string", "description": "Display name of the custom field" }, "placeholder": { "type": "string", "description": "Placeholder text for the field (can be empty)" }, "required": { "type": "boolean", "description": "Whether the field is required" }, "visible": { "type": "boolean", "description": "Whether the field is visible in the UI" }, "type": { "type": "string", "enum": [ "text" ], "description": "The data type of the field value" }, "value": { "type": "string", "description": "The actual value stored in the custom field" } }, "type": "object" }, "description": "An array of custom field objects that contain additional customer information." } } } } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": { "id": "59327746-fbca-4fb6-adf0-e88c99245548", "firstname": "John", "lastname": "Smith", "company": "ABC INC", "email": "contact@example.com", "cc_emails": [ "demo@abc.com" ], "phone": "1234567898", "address_1": "123 Rite Way", "address_2": "Unit 12", "address_city": "Orlando", "address_state": "FL", "address_zip": "32801", "address_country": "USA", "notes": null, "reference": "BARTLE", "options": { "customer_custom_fields": [ { "id": "95b5-fce4-08e6-e60b-c26e", "name": "Intenal ID", "placeholder": "Add an internal tracking ID", "required": false, "visible": true, "type": "text", "value": "0123456" } ] }, "created_at": "2017-05-08 19:13:41", "updated_at": "2017-05-08 19:13:41", "deleted_at": null, "gravatar": "//www.gravatar.com/avatar/45357c125af15b6df8864a71a653bea2", "has_address": true, "missing_address_components": [] } } }, "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "59327746-fbca-4fb6-adf0-e88c99245548" }, "firstname": { "type": "string", "example": "John" }, "lastname": { "type": "string", "example": "Smith" }, "company": { "type": "string", "example": "ABC INC" }, "email": { "type": "string", "example": "contact@example.com" }, "cc_emails": { "type": "array", "items": { "type": "string", "example": "demo@abc.com" } }, "phone": { "type": "string", "example": "1234567898" }, "address_1": { "type": "string", "example": "123 Rite Way" }, "address_2": { "type": "string", "example": "Unit 12" }, "address_city": { "type": "string", "example": "Orlando" }, "address_state": { "type": "string", "example": "FL" }, "address_zip": { "type": "string", "example": "32801" }, "address_country": { "type": "string", "example": "USA" }, "notes": {}, "reference": { "type": "string", "example": "BARTLE" }, "options": {}, "created_at": { "type": "string", "example": "2017-05-08 19:13:41" }, "updated_at": { "type": "string", "example": "2017-05-08 19:13:41" }, "deleted_at": {}, "gravatar": { "type": "string", "example": "//www.gravatar.com/avatar/45357c125af15b6df8864a71a653bea2" }, "has_address": { "type": "boolean", "example": true, "default": true }, "missing_address_components": { "type": "array" } } } } } }, "422": { "description": "422", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"firstname\": [\n \"The firstname field is required when none of lastname / email / company are present.\"\n ],\n \"lastname\": [\n \"The lastname field is required when none of firstname / email / company are present.\"\n ],\n \"email\": [\n \"The email field is required when none of firstname / lastname / company are present.\"\n ],\n \"company\": [\n \"The company field is required when none of firstname / lastname / email are present.\"\n ]\n}" } }, "schema": { "type": "object", "properties": { "firstname": { "type": "array", "items": { "type": "string", "example": "The firstname field is required when none of lastname / email / company are present." } }, "lastname": { "type": "array", "items": { "type": "string", "example": "The lastname field is required when none of firstname / email / company are present." } }, "email": { "type": "array", "items": { "type": "string", "example": "The email field is required when none of firstname / lastname / company are present." } }, "company": { "type": "array", "items": { "type": "string", "example": "The company field is required when none of firstname / lastname / email are present." } } } } } } } } }, "get": { "summary": "Find all Customer", "description": "Retrieve a list of customers associated with a merchant's account.", "operationId": "find-all-customers", "parameters": [ { "name": "firstname", "in": "query", "description": "Max: 255. Required if no lastname, email, company supplied", "schema": { "type": "string" } }, { "name": "lastname", "in": "query", "description": "Max: 255. Required if no firstname, email, company supplied", "schema": { "type": "string" } }, { "name": "email", "in": "query", "description": "Max: 255. Required if no firstname, lastname, company supplied", "schema": { "type": "string" } }, { "name": "company", "in": "query", "description": "Max: 255. Required if no firstname, lastname, email supplied", "schema": { "type": "string" } }, { "name": "phone", "in": "query", "description": "Matching regex: /[0-9]{10,15}/", "schema": { "type": "string" } }, { "name": "address_1", "in": "query", "description": "Max: 255", "schema": { "type": "string" } }, { "name": "address_2", "in": "query", "description": "Max: 255", "schema": { "type": "string" } }, { "name": "address_city", "in": "query", "description": "Max: 255", "schema": { "type": "string" } }, { "name": "address_state", "in": "query", "description": "Max: 2", "schema": { "type": "string" } }, { "name": "address_zip", "in": "query", "description": "Max: 16", "schema": { "type": "string" } }, { "name": "address_country", "in": "query", "description": "Max: 3", "schema": { "type": "string" } }, { "name": "notes", "in": "query", "description": "Max: 21844. For internal notes only; not visible to customers in invoices or communications.", "schema": { "type": "string" } }, { "name": "reference", "in": "query", "description": "Max: 255. This field is for the merchant's internal use.", "schema": { "type": "string" } }, { "name": "files", "in": "query", "description": "Array of strings(50) where each index is a valid file_id", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "cc_emails", "in": "query", "description": "Array of strings(255) where each index is a valid email address", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "cc_sms", "in": "query", "description": "Array of strings(255) where each index is a valid email address", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "allow_invoice_credit_card_payments", "in": "query", "schema": { "type": "boolean" } }, { "name": "keywords[]", "in": "query", "schema": { "type": "array", "items": { "type": "string" } } } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"total\": 2,\n \"per_page\": 50,\n \"current_page\": 1,\n \"last_page\": 1,\n \"next_page_url\": null,\n \"prev_page_url\": null,\n \"from\": 1,\n \"to\": 2,\n \"data\": [\n {\n \"id\": \"5ff4e048-c9f3-4993-81be-f7253d132c19\",\n \"firstname\": \"John\",\n \"lastname\": \"Smith\",\n \"company\": \"ABC INC\",\n \"email\": \"john@abc.com\",\n \"cc_emails\": null,\n \"phone\": \"1234567898\",\n \"address_1\": \"123 Rite Way\",\n \"address_2\": \"Unit 12\",\n \"address_city\": \"Orlando\",\n \"address_state\": \"FL\",\n \"address_zip\": \"32801\",\n \"address_country\": \"USA\",\n \"notes\": \"\",\n \"reference\": \"\",\n \"options\": null,\n \"created_at\": \"2016-04-26 13:52:10\",\n \"updated_at\": \"2016-04-26 13:52:10\",\n \"deleted_at\": null,\n \"gravatar\": \"//www.gravatar.com/avatar/144fa42eb34883ecb00cbc3f81a060a1\",\n \"has_address\": true,\n \"missing_address_components\": []\n },\n {\n \"id\": \"c20db54e-4078-46d9-9c09-2287612c8840\",\n \"firstname\": \"John\",\n \"lastname\": \"Smith\",\n \"company\": \"ABC INC\",\n \"email\": \"john@abc.com\",\n \"cc_emails\": null,\n \"phone\": \"1234567898\",\n \"address_1\": \"123 Rite Way\",\n \"address_2\": \"Unit 12\",\n \"address_city\": \"Orlando\",\n \"address_state\": \"FL\",\n \"address_zip\": \"32801\",\n \"notes\": \"\",\n \"reference\": \"\",\n \"options\": null,\n \"created_at\": \"2016-04-25 15:24:03\",\n \"updated_at\": \"2016-04-25 15:24:03\",\n \"deleted_at\": null,\n \"gravatar\": \"//www.gravatar.com/avatar/144fa42eb34883ecb00cbc3f81a060a1\",\n \"has_address\": true,\n \"missing_address_components\": []\n }\n ]\n}" } }, "schema": { "type": "object", "properties": { "total": { "type": "integer", "example": 2, "default": 0 }, "per_page": { "type": "integer", "example": 50, "default": 0 }, "current_page": { "type": "integer", "example": 1, "default": 0 }, "last_page": { "type": "integer", "example": 1, "default": 0 }, "next_page_url": {}, "prev_page_url": {}, "from": { "type": "integer", "example": 1, "default": 0 }, "to": { "type": "integer", "example": 2, "default": 0 }, "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "5ff4e048-c9f3-4993-81be-f7253d132c19" }, "firstname": { "type": "string", "example": "John" }, "lastname": { "type": "string", "example": "Smith" }, "company": { "type": "string", "example": "ABC INC" }, "email": { "type": "string", "example": "john@abc.com" }, "cc_emails": {}, "phone": { "type": "string", "example": "1234567898" }, "address_1": { "type": "string", "example": "123 Rite Way" }, "address_2": { "type": "string", "example": "Unit 12" }, "address_city": { "type": "string", "example": "Orlando" }, "address_state": { "type": "string", "example": "FL" }, "address_zip": { "type": "string", "example": "32801" }, "address_country": { "type": "string", "example": "USA" }, "notes": { "type": "string", "example": "" }, "reference": { "type": "string", "example": "" }, "options": {}, "created_at": { "type": "string", "example": "2016-04-26 13:52:10" }, "updated_at": { "type": "string", "example": "2016-04-26 13:52:10" }, "deleted_at": {}, "gravatar": { "type": "string", "example": "//www.gravatar.com/avatar/144fa42eb34883ecb00cbc3f81a060a1" }, "has_address": { "type": "boolean", "example": true, "default": true }, "missing_address_components": { "type": "array" } } } } } } } } } }, "deprecated": false } }, "/webhook": { "post": { "summary": "Create a Webhook for All User's Merchants", "description": "", "operationId": "create-new-webhook-for-all-of-my-users-merchants", "parameters": [ { "name": "target_url", "in": "query", "description": "The URL which will accept the data when the webhook fires.", "schema": { "type": "string" } }, { "name": "event", "in": "query", "description": "The event which will trigger the webhook.", "schema": { "type": "string", "enum": [ "create_customer", "create_deposit", "create_dispute", "create_invoice", "create_item", "create_scheduled_invoice", "create_transaction", "create_user", "create_webhook", "delete_item", "delete_scheduled_invoice", "delete_webhook", "update_item", "send_invoice", "set_branding", "set_gateway", "set_plan", "update_customer", "update_dispute", "update_invoice", "update_scheduled_invoice", "update_transaction", "update_user", "update_payment_method", "update_transaction_settled", "update_underwriting", "update_merchant_status", "update_electronic_signature", "fee_statement_ready" ] } } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"id\": \"a1069804-48f3-48fe-aa3f-654fbbc395aa\",\n \"user_id\": \"user1\",\n \"merchant_id\": null,\n \"reference_id\": null,\n \"url\": \"https://requestb.in/13q0j\",\n \"event\": \"update_transaction\",\n \"created_at\": \"2020-03-20 02:29:30\",\n \"updated_at\": \"2020-03-20 02:29:30\",\n \"deleted_at\": null\n}" } }, "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "a1069804-48f3-48fe-aa3f-654fbbc395aa" }, "user_id": { "type": "string", "example": "user1" }, "merchant_id": {}, "reference_id": {}, "url": { "type": "string", "example": "https://requestb.in/13q0j" }, "event": { "type": "string", "example": "update_transaction" }, "created_at": { "type": "string", "example": "2020-03-20 02:29:30" }, "updated_at": { "type": "string", "example": "2020-03-20 02:29:30" }, "deleted_at": {} } } } } }, "422": { "description": "422", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"target_url\": [\n \"The target url field is required.\"\n ],\n \"event\": [\n \"The event field is required.\"\n ]\n}" } }, "schema": { "type": "object", "properties": { "target_url": { "type": "array", "items": { "type": "string", "example": "The target url field is required." } }, "event": { "type": "array", "items": { "type": "string", "example": "The event field is required." } } } } } } } } }, "get": { "summary": "Get All Webhooks", "description": "Return all webhooks that you created for your merchant(s)", "operationId": "get-all-webhooks", "parameters": [ { "name": "per_page", "in": "query", "description": "How many webhook objects should return per page. Defaults to 20.", "schema": { "type": "integer", "format": "int32" } }, { "name": "page", "in": "query", "description": "Which page should return. Defaults to return 1st page", "schema": { "type": "string" } } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"current_page\": 2,\n \"data\": [\n {\n \"id\": \"25fb488a-c907-4e6c-87db-086150c5fa79\",\n \"user_id\": \"user1\",\n \"merchant_id\": \"merchant2\",\n \"reference_id\": null,\n \"url\": \"https://requestb.in/13q0jl11\",\n \"event\": \"create_item\",\n \"created_at\": \"2020-03-03 15:34:23\",\n \"updated_at\": \"2020-03-03 15:34:23\",\n \"deleted_at\": null\n },\n {\n \"id\": \"280e68e6-fe5e-44dc-8b2c-df5bea7e9ac4\",\n \"user_id\": \"user1\",\n \"merchant_id\": \"merchant2\",\n \"reference_id\": null,\n \"url\": \"https://requestb.in/13q0jl11\",\n \"event\": \"create_item\",\n \"created_at\": \"2020-03-04 21:26:19\",\n \"updated_at\": \"2020-03-04 21:26:19\",\n \"deleted_at\": null\n },\n {\n \"id\": \"2a43bdef-8577-401b-8ba8-7e195243287e\",\n \"user_id\": \"user1\",\n \"merchant_id\": \"merchant2\",\n \"reference_id\": null,\n \"url\": \"https://eni6l96xhnaqg.x.pipedream.net/\",\n \"event\": \"create_transaction\",\n \"created_at\": \"2020-03-05 19:23:51\",\n \"updated_at\": \"2020-03-05 19:23:51\",\n \"deleted_at\": null\n },\n {\n \"id\": \"3158600c-d431-4b9a-9cca-5ad334239997\",\n \"user_id\": \"user1\",\n \"merchant_id\": null,\n \"reference_id\": null,\n \"url\": \"https://requestb.in/13q0jl11\",\n \"event\": \"create_item\",\n \"created_at\": \"2020-03-02 23:18:58\",\n \"updated_at\": \"2020-03-02 23:18:58\",\n \"deleted_at\": null\n },\n {\n \"id\": \"34bf75ab-7906-468c-a636-4381fbe318c0\",\n \"user_id\": \"user1\",\n \"merchant_id\": \"merchant1\",\n \"reference_id\": \"8994e803-2e16-4bb0-b5ba-47fd9b447a0a\",\n \"url\": \"http://localhost:3006/fm/webhook/update_invoice/8994e803-2e16-4bb0-b5ba-47fd9b447a0a\",\n \"event\": \"update_invoice\",\n \"created_at\": \"2019-09-11 14:52:30\",\n \"updated_at\": \"2019-09-11 14:52:30\",\n \"deleted_at\": null\n }\n ],\n \"first_page_url\": \"https://apiprod.fattlabs.com/webhook?page=1\",\n \"from\": 6,\n \"last_page\": 8,\n \"last_page_url\": \"https://apiprod.fattlabs.com/webhook?page=8\",\n \"next_page_url\": \"https://apiprod.fattlabs.com/webhook?page=3\",\n \"path\": \"https://apiprod.fattlabs.com\",\n \"per_page\": \"5\",\n \"prev_page_url\": \"https://apiprod.fattlabs.com/webhook?page=1\",\n \"to\": 10,\n \"total\": 39\n}" } }, "schema": { "type": "object", "properties": { "current_page": { "type": "integer", "example": 2, "default": 0 }, "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "25fb488a-c907-4e6c-87db-086150c5fa79" }, "user_id": { "type": "string", "example": "user1" }, "merchant_id": { "type": "string", "example": "merchant2" }, "reference_id": {}, "url": { "type": "string", "example": "https://requestb.in/13q0jl11" }, "event": { "type": "string", "example": "create_item" }, "created_at": { "type": "string", "example": "2020-03-03 15:34:23" }, "updated_at": { "type": "string", "example": "2020-03-03 15:34:23" }, "deleted_at": {} } } }, "first_page_url": { "type": "string", "example": "https://apiprod.fattlabs.com/webhook?page=1" }, "from": { "type": "integer", "example": 6, "default": 0 }, "last_page": { "type": "integer", "example": 8, "default": 0 }, "last_page_url": { "type": "string", "example": "https://apiprod.fattlabs.com/webhook?page=8" }, "next_page_url": { "type": "string", "example": "https://apiprod.fattlabs.com/webhook?page=3" }, "path": { "type": "string", "example": "https://apiprod.fattlabs.com" }, "per_page": { "type": "string", "example": "5" }, "prev_page_url": { "type": "string", "example": "https://apiprod.fattlabs.com/webhook?page=1" }, "to": { "type": "integer", "example": 10, "default": 0 }, "total": { "type": "integer", "example": 39, "default": 0 } } } } } } }, "deprecated": false } }, "/webhookadmin/webhook/brand": { "post": { "summary": "Create Partner Level Webhook for your brand", "description": "Creates a webhook that triggers for all merchant accounts under your partner brand.", "operationId": "create-partner-level-webhook-for-your-brand", "parameters": [], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"id\": \"a1069804-48f3-48fe-aa3f-654fbbc395aa\",\n \"user_id\": \"\",\n \"merchant_id\": null,\n \"reference_id\": null,\n \"url\": \"https://requestb.in/13q0j\",\n \"event\": \"update_transaction\",\n \"created_at\": \"2020-03-20 02:29:30\",\n \"updated_at\": \"2020-03-20 02:29:30\",\n \"deleted_at\": null,\n \"brand_level\": \"fattmerchant\",\n \"meta\": {\n \"response_code\": \"200\",\n \"webhook_retry_frequency\": 10,\n \"webhook_retry_count\": 5\n }\n}" } }, "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "a1069804-48f3-48fe-aa3f-654fbbc395aa" }, "user_id": { "type": "string", "example": "" }, "merchant_id": {}, "reference_id": {}, "url": { "type": "string", "example": "https://requestb.in/13q0j" }, "event": { "type": "string", "example": "update_transaction" }, "created_at": { "type": "string", "example": "2020-03-20 02:29:30" }, "updated_at": { "type": "string", "example": "2020-03-20 02:29:30" }, "deleted_at": {}, "brand_level": { "type": "string", "example": "fattmerchant" }, "meta": { "type": "object", "properties": { "response_code": { "type": "string", "example": "200" }, "webhook_retry_frequency": { "type": "integer", "example": 10, "default": 0 }, "webhook_retry_count": { "type": "integer", "example": 5, "default": 0 } } } } } } } }, "422": { "description": "422", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"target_url\": [\n \"The target url field is required.\"\n ],\n \"event_name\": [\n \"The event field is required.\"\n ],\n \"meta.webhook_retry_frequency\": [\n \"The meta.webhook_retry_frequency field must be greater than 1\"\n ],\n \"meta.webhook_retry_count\": [\n \"The meta.webhook_retry_count field must be between or equal to 1 and 100\"\n ],\n \"meta.response_code\": [\n \"The meta.response_code field is required\"\n ]\n}" } }, "schema": { "type": "object", "properties": { "target_url": { "type": "array", "items": { "type": "string", "example": "The target url field is required." } }, "event_name": { "type": "array", "items": { "type": "string", "example": "The event field is required." } }, "meta.webhook_retry_frequency": { "type": "array", "items": { "type": "string", "example": "The meta.webhook_retry_frequency field must be greater than 1" } }, "meta.webhook_retry_count": { "type": "array", "items": { "type": "string", "example": "The meta.webhook_retry_count field must be between or equal to 1 and 100" } }, "meta.response_code": { "type": "array", "items": { "type": "string", "example": "The meta.response_code field is required" } } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "properties": { "target_url": { "type": "string", "description": "The URL which will accept the data when the web hook is triggered." }, "event_name": { "type": "string", "description": "The event which will trigger the web hook.", "enum": [ "create_dispute", "create_deposit", "create_invoice", "create_payment_method", "create_transaction", "create_user", "update_dispute", "update_payment_method", "update_transaction", "update_transaction_settled", "create_merchant", "update_underwriting", "update_merchant_status", "update_electronic_signature", "fee_statement_ready" ] }, "meta.response_code": { "type": "string", "description": "The expected response code from your webhook endpoint. Required if meta.webhook_retry_frequency or meta.webhook_retry_count is passed." }, "meta.webhook_retry_frequency": { "type": "integer", "format": "int32", "description": "How often (in minutes) the webhook will retry if webhook fails to return expected meta.response_code. Defaults to 5 if not passed. Requires a valid meta.response_code." }, "meta.webhook_retry_count ": { "type": "integer", "description": "How many times the webhook will attempt to retry. Defaults to 1 if not passed. Requires a valid meta.response_code.", "format": "int32" } }, "type": "object" } } } }, "security": [ { "PartnerApiKey": [] } ] }, "get": { "summary": "Get all Partner Level Webhooks for your brand", "description": "", "operationId": "get-all-partner-level-webhooks-for-your-brand", "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "[\n {\n \"id\": \"WH11ebfa619d7b0930745294713ecd118\",\n \"user_id\": \"\",\n \"merchant_id\": null,\n \"reference_id\": null,\n \"url\": \"https://requestb.in/13q0j/update_merchant_status\",\n \"event\": \"update_merchant_status\",\n \"created_at\": \"2021-08-10T05:04:33.000Z\",\n \"updated_at\": \"2021-08-10T05:04:33.000Z\",\n \"deleted_at\": null,\n \"brand_level\": \"fattmerchant\"\n },\n {\n \"id\": \"WH11ebfa628f8523437d9f94713ecd118\",\n \"user_id\": \"\",\n \"merchant_id\": null,\n \"reference_id\": null,\n \"url\": \"https://requestb.in/13q0j/update_underwriting\",\n \"event\": \"update_underwriting\",\n \"created_at\": \"2021-08-10T05:11:19.000Z\",\n \"updated_at\": \"2021-08-10T05:11:19.000Z\",\n \"deleted_at\": null,\n \"brand_level\": \"fattmerchant\"\n },\n {\n \"id\": \"WH14378bc022cd70bc96674cc0279cae\",\n \"user_id\": \"\",\n \"merchant_id\": null,\n \"reference_id\": null,\n \"url\": \"https://requestb.in/13q0j/update_transaction_settled\",\n \"event\": \"update_merchant_status\",\n \"created_at\": \"2021-08-11T13:55:13.000Z\",\n \"updated_at\": \"2021-08-11T13:55:13.000Z\",\n \"deleted_at\": null,\n \"brand_level\": \"fattmerchant\"\n }\n]" } }, "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "WH11ebfa619d7b0930745294713ecd118" }, "user_id": { "type": "string", "example": "" }, "merchant_id": {}, "reference_id": {}, "url": { "type": "string", "example": "https://requestb.in/13q0j/update_merchant_status" }, "event": { "type": "string", "example": "update_merchant_status" }, "created_at": { "type": "string", "example": "2021-08-10T05:04:33.000Z" }, "updated_at": { "type": "string", "example": "2021-08-10T05:04:33.000Z" }, "deleted_at": {}, "brand_level": { "type": "string", "example": "fattmerchant" } } } } } } } }, "deprecated": false, "security": [ { "PartnerApiKey": [] } ] } }, "/credit": { "post": { "summary": "Credit A Payment Method", "description": "", "operationId": "credit-a-payment-method", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "total", "payment_method_id" ], "properties": { "total": { "type": "number", "description": "A float that is required and will be the amount a customer is charged", "format": "float" }, "payment_method_id": { "type": "string", "description": "An existing payment_method_id within Stax." }, "meta": { "properties": { "subtotal": { "type": "string" }, "tax": { "type": "string" }, "memo": { "type": "string" }, "reference": { "type": "string" }, " lineItems": { "properties": { "price": { "type": "string", "description": "Can contain any json object" }, "quantity": { "type": "string" }, "item": { "type": "string", "description": "Name of line item" }, "details": { "type": "string", "description": "Description of line item" }, "id": { "type": "string" } }, "required": [ "price", "quantity", "item", "details" ], "type": "object" } }, "required": [], "type": "object" } } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"id\": \"85f59225-9a58-4b6e-8aae-f0ffe625e486\",\n \"invoice_id\": \"\",\n \"reference_id\": \"\",\n \"recurring_transaction_id\": \"\",\n \"type\": \"credit\",\n \"source\": null,\n \"merchant_id\": \"dd36b936-1eb7-4ece-bebc-b514c6a36ebd\",\n \"user_id\": \"b58d7eee-e68d-4d12-a1f8-62f5e71382ae\",\n \"customer_id\": \"d45ee88c-8b27-4be8-8d81-77dda1b81826\",\n \"payment_method_id\": \"d3050b19-77d9-44ac-9851-b1d1680a7684\",\n \"is_manual\": null,\n \"success\": true,\n \"message\": null,\n \"meta\": {\n \"memo\": \"Refund for Subscription\",\n \"subtotal\": \"1.00\",\n \"tax\": \"0\"\n },\n \"total\": 1,\n \"method\": \"card\",\n \"pre_auth\": false,\n \"last_four\": \"1111\",\n \"receipt_email_at\": null,\n \"receipt_sms_at\": null,\n \"created_at\": \"2017-05-08 20:25:28\",\n \"updated_at\": \"2017-05-08 20:25:28\",\n \"total_refunded\": null,\n \"is_refundable\": false,\n \"is_voided\": null,\n \"is_voidable\": false,\n \"schedule_id\": null,\n \"customer\": {\n \"id\": \"d45ee88c-8b27-4be8-8d81-77dda1b81826\",\n \"firstname\": \"John\",\n \"lastname\": \"Smith\",\n \"company\": \"ABC INC\",\n \"email\": \"demo@abc.com\",\n \"cc_emails\": [\n \"demo1@abc.com\",\n \"demo2@abc.com\"\n ],\n \"phone\": \"1234567898\",\n \"address_1\": \"123 Rite Way\",\n \"address_2\": \"Unit 12\",\n \"address_city\": \"Orlando\",\n \"address_state\": \"FL\",\n \"address_zip\": \"32801\",\n \"address_country\": \"USA\",\n \"notes\": null,\n \"reference\": \"BARTLE\",\n \"options\": \"\",\n \"created_at\": \"2017-05-08 19:22:51\",\n \"updated_at\": \"2017-05-08 19:23:46\",\n \"deleted_at\": null,\n \"gravatar\": \"//www.gravatar.com/avatar/fe3e929dd80f1653c3a4b82812660061\"\n },\n \"child_transactions\": [],\n \"files\": [],\n \"payment_method\": {\n \"id\": \"d3050b19-77d9-44ac-9851-b1d1680a7684\",\n \"customer_id\": \"d45ee88c-8b27-4be8-8d81-77dda1b81826\",\n \"merchant_id\": \"dd36b936-1eb7-4ece-bebc-b514c6a36ebd\",\n \"user_id\": \"b58d7eee-e68d-4d12-a1f8-62f5e71382ae\",\n \"nickname\": \"VISA: Steven Smith Jr. (ending in: 1111)\",\n \"is_default\": 1,\n \"method\": \"card\",\n \"person_name\": \"Steven Smith Jr.\",\n \"card_type\": \"visa\",\n \"card_last_four\": \"1111\",\n \"card_exp\": \"042019\",\n \"bank_name\": null,\n \"bank_type\": null,\n \"bank_holder_type\": null,\n \"address_1\": null,\n \"address_2\": null,\n \"address_city\": null,\n \"address_state\": null,\n \"address_zip\": \"32944\",\n \"address_country\": \"USA\",\n \"purged_at\": null,\n \"deleted_at\": null,\n \"created_at\": \"2017-05-08 19:41:03\",\n \"updated_at\": \"2017-05-08 19:41:03\",\n \"card_exp_datetime\": \"2019-04-30 23:59:59\",\n \"customer\": {\n \"id\": \"d45ee88c-8b27-4be8-8d81-77dda1b81826\",\n \"firstname\": \"John\",\n \"lastname\": \"Smith\",\n \"company\": \"ABC INC\",\n \"email\": \"demo@abc.com\",\n \"cc_emails\": [\n \"demo1@abc.com\",\n \"demo2@abc.com\"\n ],\n \"phone\": \"1234567898\",\n \"address_1\": \"123 Rite Way\",\n \"address_2\": \"Unit 12\",\n \"address_city\": \"Orlando\",\n \"address_state\": \"FL\",\n \"address_zip\": \"32801\",\n \"address_country\": \"USA\",\n \"notes\": null,\n \"reference\": \"BARTLE\",\n \"options\": \"\",\n \"created_at\": \"2017-05-08 19:22:51\",\n \"updated_at\": \"2017-05-08 19:23:46\",\n \"deleted_at\": null,\n \"gravatar\": \"//www.gravatar.com/avatar/fe3e929dd80f1653c3a4b82812660061\"\n }\n },\n \"user\": {\n \"id\": \"b58d7eee-e68d-4d12-a1f8-62f5e71382ae\",\n \"system_admin\": false,\n \"name\": \"Demo\",\n \"email\": \"contact@example.com\",\n \"email_verification_sent_at\": \"2017-03-29 15:27:19\",\n \"email_verified_at\": \"2017-03-29 15:27:21\",\n \"is_api_key\": false,\n \"created_at\": \"2017-01-11 21:44:02\",\n \"updated_at\": \"2017-04-24 15:41:58\",\n \"deleted_at\": null,\n \"gravatar\": \"//www.gravatar.com/avatar/157965dea7cd2f44e349382d1d791650\",\n \"team_admin\": null,\n \"team_enabled\": null,\n \"team_role\": null\n }\n}\n" } }, "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "85f59225-9a58-4b6e-8aae-f0ffe625e486" }, "invoice_id": { "type": "string", "example": "" }, "reference_id": { "type": "string", "example": "" }, "recurring_transaction_id": { "type": "string", "example": "" }, "type": { "type": "string", "example": "credit" }, "source": {}, "merchant_id": { "type": "string", "example": "dd36b936-1eb7-4ece-bebc-b514c6a36ebd" }, "user_id": { "type": "string", "example": "b58d7eee-e68d-4d12-a1f8-62f5e71382ae" }, "customer_id": { "type": "string", "example": "d45ee88c-8b27-4be8-8d81-77dda1b81826" }, "payment_method_id": { "type": "string", "example": "d3050b19-77d9-44ac-9851-b1d1680a7684" }, "is_manual": {}, "success": { "type": "boolean", "example": true, "default": true }, "message": {}, "meta": { "type": "object", "properties": { "memo": { "type": "string", "example": "Refund for Subscription" }, "subtotal": { "type": "string", "example": "1.00" }, "tax": { "type": "string", "example": "0" } } }, "total": { "type": "integer", "example": 1, "default": 0 }, "method": { "type": "string", "example": "card" }, "pre_auth": { "type": "boolean", "example": false, "default": true }, "last_four": { "type": "string", "example": "1111" }, "receipt_email_at": {}, "receipt_sms_at": {}, "created_at": { "type": "string", "example": "2017-05-08 20:25:28" }, "updated_at": { "type": "string", "example": "2017-05-08 20:25:28" }, "total_refunded": {}, "is_refundable": { "type": "boolean", "example": false, "default": true }, "is_voided": {}, "is_voidable": { "type": "boolean", "example": false, "default": true }, "schedule_id": {}, "customer": { "type": "object", "properties": { "id": { "type": "string", "example": "d45ee88c-8b27-4be8-8d81-77dda1b81826" }, "firstname": { "type": "string", "example": "John" }, "lastname": { "type": "string", "example": "Smith" }, "company": { "type": "string", "example": "ABC INC" }, "email": { "type": "string", "example": "demo@abc.com" }, "cc_emails": { "type": "array", "items": { "type": "string", "example": "demo1@abc.com" } }, "phone": { "type": "string", "example": "1234567898" }, "address_1": { "type": "string", "example": "123 Rite Way" }, "address_2": { "type": "string", "example": "Unit 12" }, "address_city": { "type": "string", "example": "Orlando" }, "address_state": { "type": "string", "example": "FL" }, "address_zip": { "type": "string", "example": "32801" }, "address_country": { "type": "string", "example": "USA" }, "notes": {}, "reference": { "type": "string", "example": "BARTLE" }, "options": { "type": "string", "example": "" }, "created_at": { "type": "string", "example": "2017-05-08 19:22:51" }, "updated_at": { "type": "string", "example": "2017-05-08 19:23:46" }, "deleted_at": {}, "gravatar": { "type": "string", "example": "//www.gravatar.com/avatar/fe3e929dd80f1653c3a4b82812660061" } } }, "child_transactions": { "type": "array" }, "files": { "type": "array" }, "payment_method": { "type": "object", "properties": { "id": { "type": "string", "example": "d3050b19-77d9-44ac-9851-b1d1680a7684" }, "customer_id": { "type": "string", "example": "d45ee88c-8b27-4be8-8d81-77dda1b81826" }, "merchant_id": { "type": "string", "example": "dd36b936-1eb7-4ece-bebc-b514c6a36ebd" }, "user_id": { "type": "string", "example": "b58d7eee-e68d-4d12-a1f8-62f5e71382ae" }, "nickname": { "type": "string", "example": "VISA: Steven Smith Jr. (ending in: 1111)" }, "is_default": { "type": "integer", "example": 1, "default": 0 }, "method": { "type": "string", "example": "card" }, "person_name": { "type": "string", "example": "Steven Smith Jr." }, "card_type": { "type": "string", "example": "visa" }, "card_last_four": { "type": "string", "example": "1111" }, "card_exp": { "type": "string", "example": "042019" }, "bank_name": {}, "bank_type": {}, "bank_holder_type": {}, "address_1": {}, "address_2": {}, "address_city": {}, "address_state": {}, "address_zip": { "type": "string", "example": "32944" }, "address_country": { "type": "string", "example": "USA" }, "purged_at": {}, "deleted_at": {}, "created_at": { "type": "string", "example": "2017-05-08 19:41:03" }, "updated_at": { "type": "string", "example": "2017-05-08 19:41:03" }, "card_exp_datetime": { "type": "string", "example": "2019-04-30 23:59:59" }, "customer": { "type": "object", "properties": { "id": { "type": "string", "example": "d45ee88c-8b27-4be8-8d81-77dda1b81826" }, "firstname": { "type": "string", "example": "John" }, "lastname": { "type": "string", "example": "Smith" }, "company": { "type": "string", "example": "ABC INC" }, "email": { "type": "string", "example": "demo@abc.com" }, "cc_emails": { "type": "array", "items": { "type": "string", "example": "demo1@abc.com" } }, "phone": { "type": "string", "example": "1234567898" }, "address_1": { "type": "string", "example": "123 Rite Way" }, "address_2": { "type": "string", "example": "Unit 12" }, "address_city": { "type": "string", "example": "Orlando" }, "address_state": { "type": "string", "example": "FL" }, "address_zip": { "type": "string", "example": "32801" }, "address_country": { "type": "string", "example": "USA" }, "notes": {}, "reference": { "type": "string", "example": "BARTLE" }, "options": { "type": "string", "example": "" }, "created_at": { "type": "string", "example": "2017-05-08 19:22:51" }, "updated_at": { "type": "string", "example": "2017-05-08 19:23:46" }, "deleted_at": {}, "gravatar": { "type": "string", "example": "//www.gravatar.com/avatar/fe3e929dd80f1653c3a4b82812660061" } } } } }, "user": { "type": "object", "properties": { "id": { "type": "string", "example": "b58d7eee-e68d-4d12-a1f8-62f5e71382ae" }, "system_admin": { "type": "boolean", "example": false, "default": true }, "name": { "type": "string", "example": "Demo" }, "email": { "type": "string", "example": "contact@example.com" }, "email_verification_sent_at": { "type": "string", "example": "2017-03-29 15:27:19" }, "email_verified_at": { "type": "string", "example": "2017-03-29 15:27:21" }, "is_api_key": { "type": "boolean", "example": false, "default": true }, "created_at": { "type": "string", "example": "2017-01-11 21:44:02" }, "updated_at": { "type": "string", "example": "2017-04-24 15:41:58" }, "deleted_at": {}, "gravatar": { "type": "string", "example": "//www.gravatar.com/avatar/157965dea7cd2f44e349382d1d791650" }, "team_admin": {}, "team_enabled": {}, "team_role": {} } } } } } } }, "422": { "description": "422", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"payment_method_id\": [\n \"The selected payment method id is invalid.\"\n ],\n \"total\": [\n \"The total field is required.\"\n ],\n \"meta\": [\n \"The meta field is required.\"\n ]\n}" } }, "schema": { "type": "object", "properties": { "payment_method_id": { "type": "array", "items": { "type": "string", "example": "The selected payment method id is invalid." } }, "total": { "type": "array", "items": { "type": "string", "example": "The total field is required." } }, "meta": { "type": "array", "items": { "type": "string", "example": "The meta field is required." } } } } } } } }, "deprecated": false } }, "/terminal/credit": { "post": { "summary": "Credit", "description": "Performs a standalone credit (general credit) returning funds to a customer without referencing an original sale. Only available when the merchant's gateway supports the general credit feature; otherwise returns a 400 error. Prefer refund routes when reversing a known prior transaction.\n\nUse Cases: Goodwill adjustments, manual payouts where an original transaction does not exist.\n\nRestrictions & Considerations:\n- Gateway must permit general credits; feature is rarely enabled by default.\n- May trigger higher fraud scrutiny; velocity limits can apply.\n- Amount must be >= 0.01.\n- Inventory adjustments: `meta.update_inventory` indicates stock changes (often inverted).\n\nDifferences vs Refund:\n- Refund references a prior sale; credit does not.\n- Settlement tokenization is not required for credit.\n\nSecurity: ApiKeyAuth or EphemeralAuth.\n\nErrors: 400 gateway reject, 422 validation, cancellation by user.\n\nPolling & Receipts: Same as charge. ", "security": [ { "ApiKeyAuth": [] } ], "operationId": "credit", "parameters": [], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"meta\": {\n \"reference\": 2479,\n \"taxRate\": 10,\n \"tax\": 0,\n \"subtotal\": -0.02,\n \"lineItems\": [\n {\n \"price\": \"-0.02\",\n \"quantity\": 1,\n \"details\": \"\",\n \"item\": \"Item Name\"\n }\n ]\n },\n \"customerId\": \"2a503ed1-99ea-4b35-a30a-605253f7c05a\",\n \"invoiceId\": \"\",\n \"register\": \"4f1b-f10a\",\n \"total\": 0.02\n}\nResponse\n200\nHEADERS\nContent-Type:application/json\nBODY\n{\n \"id\": \"07b7f3ac-20f0-472a-bf51-a4d534d1579d\",\n \"invoice_id\": \"\",\n \"reference_id\": \"\",\n \"recurring_transaction_id\": \"\",\n \"auth_id\": null,\n \"type\": \"credit\",\n \"source\": \"terminalservice.dejavoo\",\n \"is_merchant_present\": true,\n \"merchant_id\": \"27fad5e4-0210-4c91-9596-417b0ea0dbb1\",\n \"user_id\": \"dbc85118-3309-4129-b966-0108c0fb18a0\",\n \"customer_id\": \"2a503ed1-99ea-4b35-a30a-605253f7c05a\",\n \"payment_method_id\": \"bb61a1f5-c3ab-460f-ba8f-0aef9b4c550b\",\n \"is_manual\": true,\n \"success\": true,\n \"message\": \"\",\n \"meta\": {\n \"reference\": 2479,\n \"update_inventory\": true,\n \"taxOverride\": false,\n \"isBulkInvoice\": false,\n \"taxRate\": 10,\n \"tax\": 0,\n \"subtotal\": -0.02,\n \"lineItems\": [\n {\n \"price\": \"-0.02\",\n \"quantity\": 1,\n \"details\": \"\",\n \"item\": \"Item Name\"\n }\n ],\n \"RegisterId\": 3594291,\n \"ResultCode\": 0,\n \"RespMSG\": \"Approved Offline\",\n \"Message\": \"Approved\",\n \"PaymentType\": \"Credit\",\n \"TransType\": \"Return\",\n \"SN\": 118816524647,\n \"ExtData\": {\n \"Amount\": \"0.02\",\n \"InvNum\": \"7\",\n \"CardType\": \"VISA\",\n \"BatchNum\": \"56\",\n \"Tip\": \"0.00\",\n \"CashBack\": \"0.00\",\n \"Fee\": \"0.00\",\n \"AcntLast4\": \"1396\",\n \"Name\": \"JOHNSON/DAVID\",\n \"SVC\": \"0.00\",\n \"TotalAmt\": \"0.02\",\n \"DISC\": \"0.00\",\n \"Donation\": \"0.00\",\n \"SHFee\": \"0.00\",\n \"RwdPoints\": \"0\",\n \"RwdBalance\": \"0\",\n \"RwdIssued\": \"\",\n \"EBTFSLedgerBalance\": \"\",\n \"EBTFSAvailBalance\": \"\",\n \"EBTFSBeginBalance\": \"\",\n \"EBTCashLedgerBalance\": \"\",\n \"EBTCashAvailBalance\": \"\",\n \"EBTCashBeginBalance\": \"\",\n \"RewardCode\": \"\",\n \"AcqRefData\": \"\",\n \"ProcessData\": \"\",\n \"RefNo\": \"\",\n \"RewardQR\": \"\",\n \"Language\": \"English\",\n \"EntryType\": \"CHIP\",\n \"table_num\": \"0\",\n \"clerk_id\": \"\",\n \"ticket_num\": \"\",\n \"ControlNum\": \"\",\n \"TaxCity\": \"0.00\",\n \"TaxState\": \"0.00\",\n \"Cust1\": \"\",\n \"Cust1Value\": \"\",\n \"Cust2\": \"\",\n \"Cust2Value\": \"\",\n \"Cust3\": \"\",\n \"Cust3Value\": \"\",\n \"AcntFirst4\": \"4147\"\n },\n \"EMVData\": {\n \"AID\": \"A0000000031010\",\n \"AppName\": \"CHASE VISA\",\n \"TVR\": \"0080008000\",\n \"TSI\": \"E800\",\n \"IAD\": \"\",\n \"ARC\": \"00\"\n },\n \"CVMResult\": 2,\n \"cancelled\": false,\n \"gatewayStatus\": 200,\n \"gatewayStatusText\": \"OK\",\n \"printReceipt\": \"Both\",\n \"paymentType\": \"Credit\",\n \"type\": \"credit\",\n \"registerId\": \"4f1b-f10a\",\n \"registerStatusPort\": \"3594291\",\n \"registerNickname\": \"Tech Area Z8 (3594291)\",\n \"registerSerial\": \"124124\",\n \"registerType\": \"dejavoo\"\n },\n \"total\": 0.02,\n \"method\": \"card\",\n \"pre_auth\": false,\n \"is_captured\": 0,\n \"last_four\": \"\",\n \"interchange_code\": \"\",\n \"interchange_fee\": null,\n \"batch_id\": \"\",\n \"batched_at\": \"2018-04-16 19:02:24\",\n \"emv_response\": \"\",\n \"avs_response\": \"\",\n \"cvv_response\": \"\",\n \"pos_entry\": \"\",\n \"pos_salesperson\": \"\",\n \"receipt_email_at\": null,\n \"receipt_sms_at\": null,\n \"created_at\": \"2018-04-16 19:02:24\",\n \"updated_at\": \"2018-04-16 19:02:24\",\n \"total_refunded\": 0,\n \"is_refundable\": false,\n \"is_voided\": false,\n \"is_voidable\": true,\n \"currency\": \"USD\",\n \"schedule_id\": null,\n \"child_captures\": [],\n \"parent_auth\": null,\n \"customer\": {\n \"id\": \"2a503ed1-99ea-4b35-a30a-605253f7c05a\",\n \"firstname\": \"A\",\n \"lastname\": \"Customer\",\n \"company\": \"\",\n \"email\": \"\",\n \"cc_emails\": [],\n \"cc_sms\": null,\n \"phone\": \"\",\n \"address_1\": \"\",\n \"address_2\": \"\",\n \"address_city\": \"\",\n \"address_state\": \"\",\n \"address_zip\": \"\",\n \"address_country\": \"USA\",\n \"notes\": \"\",\n \"reference\": \"\",\n \"options\": \"\",\n \"created_at\": \"2018-02-23 22:32:19\",\n \"updated_at\": \"2018-02-23 22:32:19\",\n \"deleted_at\": null,\n \"allow_invoice_credit_card_payments\": true,\n \"gravatar\": false\n },\n \"child_transactions\": [],\n \"files\": [],\n \"payment_method\": {\n \"id\": \"bb61a1f5-c3ab-460f-ba8f-0aef9b4c550b\",\n \"customer_id\": \"2a503ed1-99ea-4b35-a30a-605253f7c05a\",\n \"merchant_id\": \"27fad5e4-0210-4c91-9596-417b0ea0dbb1\",\n \"user_id\": \"dbc85118-3309-4129-b966-0108c0fb18a0\",\n \"nickname\": \"VISA: JOHNSON/DAVID (ending in: 1396)\",\n \"has_cvv\": 0,\n \"is_default\": 1,\n \"method\": \"card\",\n \"person_name\": \"JOHNSON/DAVID\",\n \"card_type\": \"visa\",\n \"card_last_four\": \"1396\",\n \"card_exp\": \"992099\",\n \"bank_name\": null,\n \"bank_type\": null,\n \"bank_holder_type\": null,\n \"address_1\": null,\n \"address_2\": null,\n \"address_city\": null,\n \"address_state\": null,\n \"address_zip\": \"\",\n \"address_country\": \"\",\n \"purged_at\": null,\n \"deleted_at\": null,\n \"created_at\": \"2018-04-16 19:02:24\",\n \"updated_at\": \"2018-04-16 19:02:24\",\n \"card_exp_datetime\": \"2107-03-31 23:59:59\",\n \"customer\": {\n \"id\": \"2a503ed1-99ea-4b35-a30a-605253f7c05a\",\n \"firstname\": \"A\",\n \"lastname\": \"Customer\",\n \"company\": \"\",\n \"email\": \"\",\n \"cc_emails\": [],\n \"cc_sms\": null,\n \"phone\": \"\",\n \"address_1\": \"\",\n \"address_2\": \"\",\n \"address_city\": \"\",\n \"address_state\": \"\",\n \"address_zip\": \"\",\n \"address_country\": \"USA\",\n \"notes\": \"\",\n \"reference\": \"\",\n \"options\": \"\",\n \"created_at\": \"2018-02-23 22:32:19\",\n \"updated_at\": \"2018-02-23 22:32:19\",\n \"deleted_at\": null,\n \"allow_invoice_credit_card_payments\": true,\n \"gravatar\": false\n }\n },\n \"user\": {\n \"id\": \"dbc85118-3309-4129-b966-0108c0fb18a0\",\n \"system_admin\": true,\n \"name\": \"David Johnson\",\n \"email\": \"demo1@abc.com\",\n \"email_verification_sent_at\": \"2017-05-16 17:35:16\",\n \"email_verified_at\": \"2017-05-16 17:35:33\",\n \"is_api_key\": false,\n \"acknowledgments\": {\n \"tutorial\": true,\n \"godviewWelcome\": true\n },\n \"created_at\": \"2016-05-12 15:57:19\",\n \"updated_at\": \"2018-04-16 18:08:55\",\n \"deleted_at\": null,\n \"gravatar\": \"//www.gravatar.com/avatar/1cd5aef1d36d07e495abb73061f857d4\",\n \"team_admin\": null,\n \"team_enabled\": null,\n \"team_role\": null,\n \"merchant_options\": [],\n \"is_portal\": false\n }\n}" } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"success\": false,\n \"message\": \"User Cancelled\",\n \"gatewayStatus\": 200,\n \"gatewayStatusText\": \"OK\",\n \"cancelled\": true,\n \"status\": 400\n}" } }, "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false, "default": true }, "message": { "type": "string", "example": "User Cancelled" }, "gatewayStatus": { "type": "integer", "example": 200, "default": 0 }, "gatewayStatusText": { "type": "string", "example": "OK" }, "cancelled": { "type": "boolean", "example": true, "default": true }, "status": { "type": "integer", "example": 400, "default": 0 } } } } } }, "422": { "description": "422", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"validation\": \"register not found\",\n \"status\": 422,\n \"message\": \"Validation Error\"\n}" } }, "schema": { "type": "object", "properties": { "validation": { "type": "string", "example": "register not found" }, "status": { "type": "integer", "example": 422, "default": 0 }, "message": { "type": "string", "example": "Validation Error" } } } } } } }, "deprecated": false, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "number", "format": "float", "description": "this float is required and will be the amount a customer is credited." }, "meta": { "type": "string", "description": "i.e. {\"tax\":2,\"subtotal\":10} can contain any json objectwill be blindly stored and returned during a GET operation.values in meta may also appear in an email receipt if the template calls for it.the Stax front-end uses subtotal, tax, memo, lineItems = [].", "format": "json" }, "printReceipt": { "type": "string", "enum": [ "Both", "Customer", "Merchant", "No" ], "default": "Both", "description": "Possible values: No, Merchant, Customer, Both. (defaults to Both)." }, "paymentType": { "type": "string", "enum": [ "Credit", "Debit", "Check", "Gift", "Loyalty" ], "description": "Possible values: Credit, Debit, Check, Gift, Loyalty", "default": "Credit" }, "customerId": { "type": "string", "description": "The id of the customer attributed to this credit." }, "invoiceId": { "type": "string", "description": "The id of the invoice attributed to this charge." }, "register": { "type": "string", "description": "The id of the register performing this operation." } }, "required": [ "total", "register" ] } } } } } }, "/query/statement/v3/daily-sales": { "get": { "summary": "Daily Sales", "description": "This API returns the sales amount for each day of the date interval specified. The total sales, fees, and surcharges, if applicable, per day are returned.", "operationId": "daily-sales", "parameters": [ { "name": "startDate", "in": "query", "required": true, "description": "YYYY-MM-DD", "schema": { "type": "string", "default": "2025-01-01" } }, { "name": "endDate", "in": "query", "required": true, "description": "YYYY-MM-DD", "schema": { "type": "string", "default": "2025-01-31" } } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"data\": [\n {\n \"date\": \"2024-08-01\",\n \"sales_total\": 0.02,\n \"surcharge_total\": 0,\n \"fees_total\": 0.2\n },\n {\n \"date\": \"2024-08-12\",\n \"sales_total\": 0.01,\n \"surcharge_total\": 0,\n \"fees_total\": 0.06\n },\n {\n \"date\": \"2024-08-16\",\n \"sales_total\": 1,\n \"surcharge_total\": 0,\n \"fees_total\": 0.11\n },\n {\n \"date\": \"2024-08-19\",\n \"sales_total\": 1,\n \"surcharge_total\": 0,\n \"fees_total\": 0.11\n }\n ],\n \"summary\": {\n \"sales_total\": 2.03,\n \"surcharge_total\": 0,\n \"fees_total\": 0.48\n }\n}" } }, "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "date": { "type": "string", "example": "2024-08-01" }, "sales_total": { "type": "number", "example": 0.02, "default": 0 }, "surcharge_total": { "type": "integer", "example": 0, "default": 0 }, "fees_total": { "type": "number", "example": 0.2, "default": 0 } } } }, "summary": { "type": "object", "properties": { "sales_total": { "type": "number", "example": 2.03, "default": 0 }, "surcharge_total": { "type": "integer", "example": 0, "default": 0 }, "fees_total": { "type": "number", "example": 0.48, "default": 0 } } } } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "{}" } }, "schema": { "type": "object", "properties": {} } } } } }, "deprecated": false } }, "/item/{id}/decrement": { "put": { "summary": "Decrement Item's Stock", "description": "Decreases the stock of an item.", "operationId": "decrement-items-stock", "parameters": [ { "name": "quantity", "in": "query", "schema": { "type": "integer", "format": "int32" }, "required": true, "description": "The amount to reduce the in_stock value." }, { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true, "description": "ID of the item." } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"id\": \"0a6c966c-6a70-44eb-aa26-673310ca65c0\",\n \"user_id\": \"b58d7eee-e68d-4d12-a1f8-62f5e71382ae\",\n \"merchant_id\": \"dd36b936-1eb7-4ece-bebc-b514c6a36ebd\",\n \"thumbnail_id\": null,\n \"item\": \"Soap 2.0\",\n \"code\": \"aaaa\",\n \"details\": \"Even cleaner time\",\n \"is_active\": true,\n \"is_taxable\": false,\n \"is_service\": false,\n \"is_discount\": false,\n \"price\": 7.11,\n \"in_stock\": -9,\n \"meta\": [],\n \"created_at\": \"2017-05-05 20:13:12\",\n \"updated_at\": \"2017-05-05 20:16:21\",\n \"deleted_at\": null,\n \"deprecation_warning\": \"The name and decription fiels will be deprecated on 7/1/17\",\n \"user\": {\n \"id\": \"b58d7eee-e68d-4d12-a1f8-62f5e71382ae\",\n \"system_admin\": false,\n \"name\": \"Test Guy\",\n \"email\": \"contact@example.com\",\n \"email_verification_sent_at\": \"2017-03-29 15:27:19\",\n \"email_verified_at\": \"2017-03-29 15:27:21\",\n \"is_api_key\": false,\n \"created_at\": \"2017-01-11 21:44:02\",\n \"updated_at\": \"2017-04-24 15:41:58\",\n \"deleted_at\": null,\n \"gravatar\": \"//www.gravatar.com/avatar/157965dea7cd2f44e349382d1d791650\",\n \"team_admin\": null,\n \"team_enabled\": null,\n \"team_role\": null\n },\n \"files\": [],\n \"thumbnail\": null\n}" } }, "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "0a6c966c-6a70-44eb-aa26-673310ca65c0" }, "user_id": { "type": "string", "example": "b58d7eee-e68d-4d12-a1f8-62f5e71382ae" }, "merchant_id": { "type": "string", "example": "dd36b936-1eb7-4ece-bebc-b514c6a36ebd" }, "thumbnail_id": {}, "item": { "type": "string", "example": "Soap 2.0" }, "code": { "type": "string", "example": "aaaa" }, "details": { "type": "string", "example": "Even cleaner time" }, "is_active": { "type": "boolean", "example": true, "default": true }, "is_taxable": { "type": "boolean", "example": false, "default": true }, "is_service": { "type": "boolean", "example": false, "default": true }, "is_discount": { "type": "boolean", "example": false, "default": true }, "price": { "type": "number", "example": 7.11, "default": 0 }, "in_stock": { "type": "integer", "example": -9, "default": 0 }, "meta": { "type": "array" }, "created_at": { "type": "string", "example": "2017-05-05 20:13:12" }, "updated_at": { "type": "string", "example": "2017-05-05 20:16:21" }, "deleted_at": {}, "deprecation_warning": { "type": "string", "example": "The name and decription fiels will be deprecated on 7/1/17" }, "user": { "type": "object", "properties": { "id": { "type": "string", "example": "b58d7eee-e68d-4d12-a1f8-62f5e71382ae" }, "system_admin": { "type": "boolean", "example": false, "default": true }, "name": { "type": "string", "example": "Test Guy" }, "email": { "type": "string", "example": "contact@example.com" }, "email_verification_sent_at": { "type": "string", "example": "2017-03-29 15:27:19" }, "email_verified_at": { "type": "string", "example": "2017-03-29 15:27:21" }, "is_api_key": { "type": "boolean", "example": false, "default": true }, "created_at": { "type": "string", "example": "2017-01-11 21:44:02" }, "updated_at": { "type": "string", "example": "2017-04-24 15:41:58" }, "deleted_at": {}, "gravatar": { "type": "string", "example": "//www.gravatar.com/avatar/157965dea7cd2f44e349382d1d791650" }, "team_admin": {}, "team_enabled": {}, "team_role": {} } }, "files": { "type": "array" }, "thumbnail": {} } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"id\": [\n \"The item was not found\"\n ]\n}" } }, "schema": { "type": "object", "properties": { "id": { "type": "array", "items": { "type": "string", "example": "The item was not found" } } } } } } } }, "deprecated": false } }, "/item/{id}": { "delete": { "summary": "Delete a Catalog Item", "description": "", "operationId": "delete-a-catalog-item", "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{}" } }, "schema": { "type": "object", "properties": {} } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "{}" } }, "schema": { "type": "object", "properties": {} } } } } }, "deprecated": false }, "get": { "summary": "Retrieve an Item by ID", "description": "Retrieves the merchant's item matching the given id and then returns details about the item", "operationId": "retrieve-an-item-by-id", "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true, "description": "This is the ID of the item to be returned." } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"id\": \"79256d84-3930-4e4b-bc71-9c6587cfc65c\",\n \"user_id\": \"b58d7eee-e68d-4d12-a1f8-62f5e71382ae\",\n \"merchant_id\": \"dd36b936-1eb7-4ece-bebc-b514c6a36ebd\",\n \"thumbnail_id\": null,\n \"item\": \"meeseeks\",\n \"code\": \"aaaa\",\n \"details\": \"just a test item\",\n \"is_active\": true,\n \"is_taxable\": false,\n \"is_service\": false,\n \"is_discount\": false,\n \"price\": 7.11,\n \"in_stock\": 0,\n \"meta\": [],\n \"created_at\": \"2017-05-05 19:49:21\",\n \"updated_at\": \"2017-05-05 19:49:21\",\n \"deleted_at\": null,\n \"deprecation_warning\": \"The name and decription fiels will be deprecated on 7/1/17\",\n \"user\": {\n \"id\": \"b58d7eee-e68d-4d12-a1f8-62f5e71382ae\",\n \"system_admin\": false,\n \"name\": \"Test Guy\",\n \"email\": \"contact@example.com\",\n \"email_verification_sent_at\": \"2017-03-29 15:27:19\",\n \"email_verified_at\": \"2017-03-29 15:27:21\",\n \"is_api_key\": false,\n \"created_at\": \"2017-01-11 21:44:02\",\n \"updated_at\": \"2017-04-24 15:41:58\",\n \"deleted_at\": null,\n \"gravatar\": \"//www.gravatar.com/avatar/157965dea7cd2f44e349382d1d791650\",\n \"team_admin\": null,\n \"team_enabled\": null,\n \"team_role\": null\n },\n \"files\": [],\n \"thumbnail\": null\n}" } }, "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "79256d84-3930-4e4b-bc71-9c6587cfc65c" }, "user_id": { "type": "string", "example": "b58d7eee-e68d-4d12-a1f8-62f5e71382ae" }, "merchant_id": { "type": "string", "example": "dd36b936-1eb7-4ece-bebc-b514c6a36ebd" }, "thumbnail_id": {}, "item": { "type": "string", "example": "meeseeks" }, "code": { "type": "string", "example": "aaaa" }, "details": { "type": "string", "example": "just a test item" }, "is_active": { "type": "boolean", "example": true, "default": true }, "is_taxable": { "type": "boolean", "example": false, "default": true }, "is_service": { "type": "boolean", "example": false, "default": true }, "is_discount": { "type": "boolean", "example": false, "default": true }, "price": { "type": "number", "example": 7.11, "default": 0 }, "in_stock": { "type": "integer", "example": 0, "default": 0 }, "meta": { "type": "array" }, "created_at": { "type": "string", "example": "2017-05-05 19:49:21" }, "updated_at": { "type": "string", "example": "2017-05-05 19:49:21" }, "deleted_at": {}, "deprecation_warning": { "type": "string", "example": "The name and decription fiels will be deprecated on 7/1/17" }, "user": { "type": "object", "properties": { "id": { "type": "string", "example": "b58d7eee-e68d-4d12-a1f8-62f5e71382ae" }, "system_admin": { "type": "boolean", "example": false, "default": true }, "name": { "type": "string", "example": "Test Guy" }, "email": { "type": "string", "example": "contact@example.com" }, "email_verification_sent_at": { "type": "string", "example": "2017-03-29 15:27:19" }, "email_verified_at": { "type": "string", "example": "2017-03-29 15:27:21" }, "is_api_key": { "type": "boolean", "example": false, "default": true }, "created_at": { "type": "string", "example": "2017-01-11 21:44:02" }, "updated_at": { "type": "string", "example": "2017-04-24 15:41:58" }, "deleted_at": {}, "gravatar": { "type": "string", "example": "//www.gravatar.com/avatar/157965dea7cd2f44e349382d1d791650" }, "team_admin": {}, "team_enabled": {}, "team_role": {} } }, "files": { "type": "array" }, "thumbnail": {} } } } } }, "422": { "description": "422", "content": { "application/json": { "examples": { "Result": { "value": "\n{\n \"id\": [\n \"The item was not found\"\n ]\n}" } }, "schema": { "type": "object", "properties": { "id": { "type": "array", "items": { "type": "string", "example": "The item was not found" } } } } } } } }, "deprecated": false }, "put": { "summary": "Update an Item", "description": "Updates or edits any existing catalog item that matches the given id.", "operationId": "update-an-item", "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true, "description": "ID of the item to be modified." } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "item": { "type": "string", "description": "Name of the catalog item" }, "code": { "type": "string", "description": "Code of the catalog item" }, "category": { "type": "string", "description": "Set category for catalog item" }, "details": { "type": "string", "description": "Description for catalog item" }, "is_active": { "type": "boolean", "description": "Define if the item is active" }, "is_taxable": { "type": "boolean", "description": "Define if the item is taxable" }, "is_service": { "type": "boolean", "description": "Define if the item is a service" }, "is_discount": { "type": "boolean", "default": false, "description": "Defaults to false. Sets the item to a discount which overrides the is_service variable." }, "price": { "type": "number", "description": "Update the catalog item price", "format": "float" }, "in_stock": { "type": "integer", "description": "Sets the stock quantity", "format": "int32" }, "low_stock_alert": { "type": "integer", "description": "Update the low stock alert amount", "format": "int32" }, "meta": { "type": "string", "format": "json" }, "files": { "type": "string", "description": "IDs of files to be associated to the item." }, "thumbnail": { "type": "string", "description": "File ID of a file to be associated to the item as the thumbnail or preview. " } }, "required": [ "item" ] } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": { "id": "4cddf784-55d4-4dcb-a266-1eb5af051e01", "user_id": "2d089742-6aca-462d-8db3-c2966e1f9e68", "merchant_id": "a61d78cc-cde9-44ac-8a18-30c39be05879", "thumbnail_id": null, "item": "test item", "code": "aaaa", "category": "essential items", "details": "just a test item", "is_active": true, "is_taxable": false, "is_service": false, "is_discount": false, "price": 7.11, "in_stock": 0, "low_stock_alert": 3, "meta": [], "created_at": "2018-10-02 14:30:48", "updated_at": "2018-10-02 14:30:48", "deleted_at": null, "user": { "id": "2d089742-6aca-462d-8db3-c2966e1f9e68", "system_admin": true, "name": "Morty Junior", "email": "contact@example.com", "email_verification_sent_at": "2018-09-26 18:24:21", "email_verified_at": "2016-05-11 17:13:33", "is_api_key": false, "acknowledgments": { "signedApplication": true, "editedOnboardingInformation": false, "tutorial": true, "godviewWelcome": true }, "created_at": "2016-05-18 14:11:46", "updated_at": "2018-09-26 18:24:21", "deleted_at": null, "gravatar": "//www.gravatar.com/avatar/772cbf95746d7da86789cc3634c46ba8", "team_admin": null, "team_enabled": null, "team_role": null, "merchant_options": [], "is_default": false }, "files": [], "thumbnail": null } } }, "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "4cddf784-55d4-4dcb-a266-1eb5af051e01" }, "user_id": { "type": "string", "example": "2d089742-6aca-462d-8db3-c2966e1f9e68" }, "merchant_id": { "type": "string", "example": "a61d78cc-cde9-44ac-8a18-30c39be05879" }, "thumbnail_id": {}, "item": { "type": "string", "example": "test item" }, "code": { "type": "string", "example": "aaaa" }, "category": { "type": "string", "example": "essential items" }, "details": { "type": "string", "example": "just a test item" }, "is_active": { "type": "boolean", "example": true, "default": true }, "is_taxable": { "type": "boolean", "example": false, "default": true }, "is_service": { "type": "boolean", "example": false, "default": true }, "is_subscription": { "type": "boolean", "example": false, "default": true }, "is_discount": { "type": "boolean", "example": false, "default": true }, "price": { "type": "number", "example": 7.11, "default": 0 }, "in_stock": { "type": "integer", "example": 0, "default": 0 }, "low_stock_alert": { "type": "integer", "example": 3, "default": 0 }, "meta": { "type": "array" }, "created_at": { "type": "string", "example": "2018-10-02 14:30:48" }, "updated_at": { "type": "string", "example": "2018-10-02 14:30:48" }, "deleted_at": {}, "user": { "type": "object", "properties": { "id": { "type": "string", "example": "2d089742-6aca-462d-8db3-c2966e1f9e68" }, "system_admin": { "type": "boolean", "example": true, "default": true }, "name": { "type": "string", "example": "Morty Junior" }, "email": { "type": "string", "example": "contact@example.com" }, "email_verification_sent_at": { "type": "string", "example": "2018-09-26 18:24:21" }, "email_verified_at": { "type": "string", "example": "2016-05-11 17:13:33" }, "is_api_key": { "type": "boolean", "example": false, "default": true }, "acknowledgments": { "type": "object", "properties": { "signedApplication": { "type": "boolean", "example": true, "default": true }, "editedOnboardingInformation": { "type": "boolean", "example": false, "default": true }, "tutorial": { "type": "boolean", "example": true, "default": true }, "godviewWelcome": { "type": "boolean", "example": true, "default": true } } }, "created_at": { "type": "string", "example": "2016-05-18 14:11:46" }, "updated_at": { "type": "string", "example": "2018-09-26 18:24:21" }, "deleted_at": {}, "gravatar": { "type": "string", "example": "//www.gravatar.com/avatar/772cbf95746d7da86789cc3634c46ba8" }, "team_admin": {}, "team_enabled": {}, "team_role": {}, "merchant_options": { "type": "array" }, "is_default": { "type": "boolean", "example": false, "default": true } } }, "files": { "type": "array" }, "thumbnail": {} } } } } }, "422": { "description": "422", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"item\": [\n \"The item field is required.\"\n ]\n}" } }, "schema": { "type": "object", "properties": { "item": { "type": "array", "items": { "type": "string", "example": "The item field is required." } } } } } } } }, "deprecated": false } }, "/customer/{id}": { "delete": { "summary": "Delete a Customer", "description": "To soft delete a customer", "operationId": "delete-a-customer", "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"id\": \"d45ee88c-8b27-4be8-8d81-77dda1b81826\",\n \"firstname\": \"John\",\n \"lastname\": \"Smith\",\n \"company\": \"ABC INC\",\n \"email\": \"demo@abc.com\",\n \"cc_emails\": [\n \"demo1@abc.com\",\n \"demo2@abc.com\"\n ],\n \"phone\": \"1234567898\",\n \"address_1\": \"123 Rite Way\",\n \"address_2\": \"Unit 12\",\n \"address_city\": \"Orlando\",\n \"address_state\": \"FL\",\n \"address_zip\": \"32801\",\n \"address_country\": \"USA\",\n \"notes\": null,\n \"reference\": \"BARTLE\",\n \"options\": null,\n \"created_at\": \"2017-05-08 19:22:51\",\n \"updated_at\": \"2017-05-08 19:23:46\",\n \"deleted_at\": \"2020-03-29 15:46:00\",\n \"gravatar\": \"//www.gravatar.com/avatar/fe3e929dd80f1653c3a4b82812660061\",\n \"has_address\": true,\n \"missing_address_components\": []\n}" } }, "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "d45ee88c-8b27-4be8-8d81-77dda1b81826" }, "firstname": { "type": "string", "example": "John" }, "lastname": { "type": "string", "example": "Smith" }, "company": { "type": "string", "example": "ABC INC" }, "email": { "type": "string", "example": "demo@abc.com" }, "cc_emails": { "type": "array", "items": { "type": "string", "example": "demo1@abc.com" } }, "phone": { "type": "string", "example": "1234567898" }, "address_1": { "type": "string", "example": "123 Rite Way" }, "address_2": { "type": "string", "example": "Unit 12" }, "address_city": { "type": "string", "example": "Orlando" }, "address_state": { "type": "string", "example": "FL" }, "address_zip": { "type": "string", "example": "32801" }, "address_country": { "type": "string", "example": "USA" }, "notes": {}, "reference": { "type": "string", "example": "BARTLE" }, "options": {}, "created_at": { "type": "string", "example": "2017-05-08 19:22:51" }, "updated_at": { "type": "string", "example": "2017-05-08 19:23:46" }, "deleted_at": { "type": "string", "example": "2020-03-29 15:46:00" }, "gravatar": { "type": "string", "example": "//www.gravatar.com/avatar/fe3e929dd80f1653c3a4b82812660061" }, "has_address": { "type": "boolean", "example": true, "default": true }, "missing_address_components": { "type": "array" } } } } } }, "422": { "description": "422", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"id\": \"customer not found\"\n}" } }, "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "customer not found" } } } } } } }, "deprecated": false }, "get": { "summary": "Get a Customer's Information", "description": "Retrieves detailed information about a specific customer using their unique ID", "operationId": "get-a-customers-information", "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"id\": \"d45ee88c-8b27-4be8-8d81-77dda1b81826\",\n \"firstname\": \"John\",\n \"lastname\": \"Smith\",\n \"company\": \"ABC INC\",\n \"email\": \"contact@example.com\",\n \"cc_emails\": [\n \"demo@abc.com\"\n ],\n \"phone\": \"1234567898\",\n \"address_1\": \"123 Rite Way\",\n \"address_2\": \"Unit 12\",\n \"address_city\": \"Orlando\",\n \"address_state\": \"FL\",\n \"address_zip\": \"32801\",\n \"address_country\": \"USA\",\n \"notes\": null,\n \"reference\": \"BARTLE\",\n \"options\": null,\n \"created_at\": \"2017-05-08 19:22:51\",\n \"updated_at\": \"2017-05-08 19:22:51\",\n \"deleted_at\": null,\n \"gravatar\": \"//www.gravatar.com/avatar/45357c125af15b6df8864a71a653bea2\",\n \"has_address\": true,\n \"missing_address_components\": []\n}" } }, "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "d45ee88c-8b27-4be8-8d81-77dda1b81826" }, "firstname": { "type": "string", "example": "John" }, "lastname": { "type": "string", "example": "Smith" }, "company": { "type": "string", "example": "ABC INC" }, "email": { "type": "string", "example": "contact@example.com" }, "cc_emails": { "type": "array", "items": { "type": "string", "example": "demo@abc.com" } }, "phone": { "type": "string", "example": "1234567898" }, "address_1": { "type": "string", "example": "123 Rite Way" }, "address_2": { "type": "string", "example": "Unit 12" }, "address_city": { "type": "string", "example": "Orlando" }, "address_state": { "type": "string", "example": "FL" }, "address_zip": { "type": "string", "example": "32801" }, "address_country": { "type": "string", "example": "USA" }, "notes": {}, "reference": { "type": "string", "example": "BARTLE" }, "options": {}, "created_at": { "type": "string", "example": "2017-05-08 19:22:51" }, "updated_at": { "type": "string", "example": "2017-05-08 19:22:51" }, "deleted_at": {}, "gravatar": { "type": "string", "example": "//www.gravatar.com/avatar/45357c125af15b6df8864a71a653bea2" }, "has_address": { "type": "boolean", "example": true, "default": true }, "missing_address_components": { "type": "array" } } } } } }, "404": { "description": "404", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"id\": \"customer not found\"\n}" } }, "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "customer not found" } } } } } } }, "deprecated": false }, "put": { "summary": "Update Customer Information", "description": "Modify an existing customer record in your merchant account.", "operationId": "update-customer-info", "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"id\": \"d45ee88c-8b27-4be8-8d81-77dda1b81826\",\n \"firstname\": \"John\",\n \"lastname\": \"Smith\",\n \"company\": \"ABC INC\",\n \"email\": \"demo@abc.com\",\n \"cc_emails\": [\n \"demo1@abc.com\",\n \"demo2@abc.com\"\n ],\n \"phone\": \"1234567898\",\n \"address_1\": \"123 Rite Way\",\n \"address_2\": \"Unit 12\",\n \"address_city\": \"Orlando\",\n \"address_state\": \"FL\",\n \"address_zip\": \"32801\",\n \"address_country\": \"USA\",\n \"notes\": null,\n \"reference\": \"BARTLE\",\n \"options\": null,\n \"created_at\": \"2017-05-08 19:22:51\",\n \"updated_at\": \"2017-05-08 19:23:46\",\n \"deleted_at\": null,\n \"gravatar\": \"//www.gravatar.com/avatar/fe3e929dd80f1653c3a4b82812660061\",\n \"has_address\": true,\n \"missing_address_components\": []\n}" } }, "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "d45ee88c-8b27-4be8-8d81-77dda1b81826" }, "firstname": { "type": "string", "example": "John" }, "lastname": { "type": "string", "example": "Smith" }, "company": { "type": "string", "example": "ABC INC" }, "email": { "type": "string", "example": "demo@abc.com" }, "cc_emails": { "type": "array", "items": { "type": "string", "example": "demo1@abc.com" } }, "phone": { "type": "string", "example": "1234567898" }, "address_1": { "type": "string", "example": "123 Rite Way" }, "address_2": { "type": "string", "example": "Unit 12" }, "address_city": { "type": "string", "example": "Orlando" }, "address_state": { "type": "string", "example": "FL" }, "address_zip": { "type": "string", "example": "32801" }, "address_country": { "type": "string", "example": "USA" }, "notes": {}, "reference": { "type": "string", "example": "BARTLE" }, "options": {}, "created_at": { "type": "string", "example": "2017-05-08 19:22:51" }, "updated_at": { "type": "string", "example": "2017-05-08 19:23:46" }, "deleted_at": {}, "gravatar": { "type": "string", "example": "//www.gravatar.com/avatar/fe3e929dd80f1653c3a4b82812660061" }, "has_address": { "type": "boolean", "example": true, "default": true }, "missing_address_components": { "type": "array" } } } } } }, "422": { "description": "422", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"firstname\": [\n \"The firstname field is required when none of lastname / email / company are present.\"\n ],\n \"lastname\": [\n \"The lastname field is required when none of firstname / email / company are present.\"\n ],\n \"email\": [\n \"The email field is required when none of firstname / lastname / company are present.\"\n ],\n \"company\": [\n \"The company field is required when none of firstname / lastname / email are present.\"\n ]\n}" } }, "schema": { "type": "object", "properties": { "firstname": { "type": "array", "items": { "type": "string", "example": "The firstname field is required when none of lastname / email / company are present." } }, "lastname": { "type": "array", "items": { "type": "string", "example": "The lastname field is required when none of firstname / email / company are present." } }, "email": { "type": "array", "items": { "type": "string", "example": "The email field is required when none of firstname / lastname / company are present." } }, "company": { "type": "array", "items": { "type": "string", "example": "The company field is required when none of firstname / lastname / email are present." } } } } } } } }, "deprecated": false, "requestBody": { "content": { "application/json": { "schema": { "properties": { "firstname": { "type": "string", "description": "Max: 255. Required if no lastname, email, company supplied" }, "lastname": { "type": "string", "description": "Max: 255. Required if no firstname, email, company supplied" }, "email": { "type": "string", "description": "Max: 255. Required if no firstname, lastname, company supplied" }, "company": { "type": "string", "description": "Max: 255. Required if no firstname, lastname, email supplied" }, "phone": { "type": "string", "description": "Matching regex: /[0-9]{10,15}/" }, "address_1": { "type": "string", "description": "Max: 255" }, "address_2": { "type": "string", "description": "Max: 255" }, "address_city": { "type": "string", "description": "Max: 255" }, "address_state": { "type": "string", "description": "Max: 2" }, "address_zip": { "type": "string", "description": "Max: 16" }, "address_country": { "type": "string", "description": "Max: 3" }, "notes": { "type": "string", "description": "For internal notes only; not visible to customers in invoices or communications. Max: 21844" }, "reference": { "type": "string", "description": "This field is for the merchant's internal use. Max: 255. " }, "files": { "type": "array", "description": "Array of strings(50) where each index is a valid file_id", "items": { "type": "string" } }, "cc_emails": { "type": "array", "description": "Array of strings(255) where each index is a valid email address", "items": { "type": "string" } }, "cc_sms": { "type": "array", "description": "Array of strings(255) where each index is a valid phone number", "items": { "type": "string" } }, "allow_invoice_credit_card_payments": { "type": "boolean" }, "options": { "type": "object", "properties": { "customer_custom_fields": { "type": "array", "items": { "properties": { "id": { "type": "string", "description": "Unique identifier for the custom field" }, "name": { "type": "string", "description": "Display name of the custom field" }, "placeholder": { "type": "string", "description": "Placeholder text for the field (can be empty)" }, "required": { "type": "boolean", "description": "Whether the field is required" }, "visible": { "type": "boolean", "description": "Whether the field is visible in the UI" }, "type": { "type": "string", "description": "The data type of the field value", "enum": [ "text" ] }, "value": { "type": "string", "description": "The actual value stored in the custom field" } }, "type": "object" }, "description": "An array of custom field objects that contain additional customer information." } }, "description": "Additional customer options such as custom fields" } }, "type": "object" } } } } } }, "/file{id}": { "delete": { "description": "", "operationId": "delete_file{id}", "responses": { "200": { "description": "", "content": { "application/json": { "examples": { "OK": { "summary": "OK", "value": { "id": "a66bcfb0-8a41-4ef9-99b3-15fe1846bd36", "merchant_id": "55394e80-826a-4e04-bafa-2e2d615209cf", "user_id": "5aec6f90-69be-48a5-a419-44ff016f364a", "name": "FILENAMEEDIT", "public_url": "https://fattpaydocuments.s3.us-west-2.amazonaws.com/a66bcfb0-8a41-4ef9-99b3-15fe1846bd36.png", "tag": null, "meta": { "filesize_bytes": 139295, "filesize": "139.3 kB", "extension": "png", "size": { "width": 446, "height": 496 }, "mime": "image/png" }, "created_at": "2025-12-01 19:00:08", "updated_at": "2025-12-03 21:30:36", "deleted_at": "2025-12-05 08:17:56" } } } } } } }, "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true, "description": "ID of the file to delete." } ] } }, "/webhookadmin/webhook/brand/{webhook_id}": { "delete": { "summary": "Delete a Partner Level Webhook for your brand", "description": "", "operationId": "delete-a-partner-level-webhook-for-your-brand", "parameters": [ { "name": "webhook_id", "in": "path", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"id\": \"WH11ebfaabc029cd70bc96674cc0279c55\",\n \"user_id\": \"\",\n \"merchant_id\": null,\n \"reference_id\": null,\n \"url\": \"https://requestb.in/13q0j/update_merchant_status\",\n \"event\": \"update_merchant_status\",\n \"created_at\": \"2021-08-11T13:55:13.000Z\",\n \"updated_at\": \"2021-08-11T13:55:13.000Z\",\n \"deleted_at\": \"2021-08-11T14:21:51.000Z\",\n \"brand_level\": \"fattmerchant\"\n}" } }, "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "WH11ebfaabc029cd70bc96674cc0279c55" }, "user_id": { "type": "string", "example": "" }, "merchant_id": {}, "reference_id": {}, "url": { "type": "string", "example": "https://requestb.in/13q0j/update_merchant_status" }, "event": { "type": "string", "example": "update_merchant_status" }, "created_at": { "type": "string", "example": "2021-08-11T13:55:13.000Z" }, "updated_at": { "type": "string", "example": "2021-08-11T13:55:13.000Z" }, "deleted_at": { "type": "string", "example": "2021-08-11T14:21:51.000Z" }, "brand_level": { "type": "string", "example": "fattmerchant" } } } } } } }, "deprecated": false, "security": [ { "PartnerApiKey": [] } ] }, "get": { "summary": "Get a specific Partner Level Webhook for your brand", "description": "", "operationId": "get-a-specific-partner-level-webhook-for-your-brand", "parameters": [ { "name": "webhook_id", "in": "path", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"id\": \"WH11ebfa619d7b0930745294713ecd118\",\n \"user_id\": \"\",\n \"merchant_id\": null,\n \"reference_id\": null,\n \"url\": \"https://requestb.in/13q0j/update_merchant_status\",\n \"event\": \"update_merchant_status\",\n \"created_at\": \"2021-08-10T05:04:33.000Z\",\n \"updated_at\": \"2021-08-10T05:04:33.000Z\",\n \"deleted_at\": null,\n \"brand_level\": \"fattmerchant\"\n}" } }, "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "WH11ebfa619d7b0930745294713ecd118" }, "user_id": { "type": "string", "example": "" }, "merchant_id": {}, "reference_id": {}, "url": { "type": "string", "example": "https://requestb.in/13q0j/update_merchant_status" }, "event": { "type": "string", "example": "update_merchant_status" }, "created_at": { "type": "string", "example": "2021-08-10T05:04:33.000Z" }, "updated_at": { "type": "string", "example": "2021-08-10T05:04:33.000Z" }, "deleted_at": {}, "brand_level": { "type": "string", "example": "fattmerchant" } } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "{}" } }, "schema": { "type": "object", "properties": {} } } } } }, "deprecated": false, "security": [ { "PartnerApiKey": [] } ] } }, "/query/payment-links/{id}": { "delete": { "summary": "Delete a Payment Link", "description": "Remove an existing payment link from your merchant account using its unique identifier.", "operationId": "delete-a-payment-link", "parameters": [ { "name": "id", "in": "path", "description": "The id of your payment link", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"status\": 200,\n \"message\": \"Payment Link Deleted\"\n}" } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "example": 200, "default": 0 }, "message": { "type": "string", "example": "Payment Link Deleted" } } } } } } }, "deprecated": false }, "get": { "summary": "Get A Payment Link's Information", "description": "Retrieve detailed information for a specific payment link, including metadata and status.", "operationId": "get-a-payment-links-information", "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"data\": {\n \"id\": \"11edc285c23ba0c0b5ff8d3dfcce6b74\",\n \"merchant_id\": \"merchant1\",\n \"common_name\": \"sameple link\",\n \"tinyurl\": \"https://paymnt.io/RKWBJ5\",\n \"link_meta\": {\n \"paymentLinkId\": \"11edc285c23ba0c0b5ff8d3dfcce6b74\"\n },\n \"active\": 1,\n \"amount\": 200,\n \"created_at\": \"2023-03-14T16:32:07.000Z\",\n \"updated_at\": null,\n \"total_sales\": 0,\n \"total_transactions\": 0\n }\n}" } }, "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "example": "11edc285c23ba0c0b5ff8d3dfcce6b74" }, "merchant_id": { "type": "string", "example": "merchant1" }, "common_name": { "type": "string", "example": "sameple link" }, "tinyurl": { "type": "string", "example": "https://paymnt.io/RKWBJ5" }, "link_meta": { "type": "object", "properties": { "paymentLinkId": { "type": "string", "example": "11edc285c23ba0c0b5ff8d3dfcce6b74" } } }, "active": { "type": "integer", "example": 1, "default": 0 }, "amount": { "type": "integer", "example": 200, "default": 0 }, "created_at": { "type": "string", "example": "2023-03-14T16:32:07.000Z" }, "updated_at": { "type": "string", "format": "date-time" }, "total_sales": { "type": "integer", "example": 0, "default": 0 }, "total_transactions": { "type": "integer", "example": 0, "default": 0 } } } } } } } } }, "deprecated": false }, "put": { "summary": "Update (or Deactivate) a Payment Link", "description": "Modify attributes of an existing payment link or reactivate a previously deactivated link.", "operationId": "update-a-payment-link", "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "url", "common_name" ], "properties": { "url": { "type": "string", "description": "The URL of your application where the payment page is hosted." }, "common_name": { "type": "string", "description": "A human-readable name for the payment link. This is an internal name that the customer will not see." }, "link_meta": { "properties": { "total": { "type": "number", "description": "Set total amount for payment link", "format": "float" }, "memo": { "type": "string", "description": "Appears as a message for the customer on a payment screen." }, "successRedirect": { "type": "string", "description": "The URL to which the user will be redirected after payment or tokenization." }, "frequency": { "type": "string", "description": "Specifies the frequency of the recurring payments. This field will only be respected if rrule is true." }, "rrule": { "type": "boolean", "description": "Used to set up recurring payments." }, "isTotalEditable": { "type": "boolean", "description": "Determines whether customers can edit the total amount." }, "tokenizeOnly": { "type": "boolean", "description": "Only allow a payment to be tokenized. When set to true, only memo, successRedirect, buttonText, and active will be valid meta flags." }, "areCnpDigitalWalletPaymentsAllowed": { "type": "boolean", "description": "Determines whether to accept digital wallet (Apple Pay + Google Pay) payments." }, "areBankPaymentsAllowed": { "type": "boolean", "description": "Determines whether to accept bank (ACH) payments." }, " areCreditCardsPaymentsAllowed": { "type": "boolean", "description": "Determines whether to accept card (credit, debit) payments." }, "arePaypalPaymentsAllowed": { "type": "boolean", "description": "Determines whether to accept PayPal payments." }, "areVenmoPaymentsAllowed": { "type": "boolean", "description": "Determines whether to accept Venmo payments." }, "arePaypalBnplPaymentsAllowed": { "type": "string", "description": "Determines whether to accept PayPal Buy Now, Pay Later." }, "buttonText": { "type": "string", "description": "The text that will appear on the payment button." }, "active": { "type": "boolean", "description": "This is the active status of the payment link." } }, "required": [], "type": "object", "description": "Contains more details and settings of the payment link." }, "amount": { "type": "number", "description": "This is the amount to be paid using the link. When it is set to 0, the value can be edited during payment. When it is set to a value greater than 0, the value cannot be changed during payment, unless isTotalEditable is set to true.", "format": "float" }, "active": { "type": "boolean", "description": "This is the active status of the payment link. Set a value of 1 to make the link active or 0 to make it inactive. An inactive link cannot be used for payment." }, "funding": { "properties": { "account_id": { "type": "string", "description": "The funding accounts that will be used to receive payments." }, "memo": { "type": "string", "description": "Additional information displayed to customer on payment page." } }, "required": [], "type": "object", "description": "The funding accounts that will be used to receive payments. If no value provided, will default to primary merchant funding account." } } } } } }, "responses": { "201": { "description": "201", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"status\": 201,\n \"message\": \"Payment Link created\",\n \"body\": {\n \"link_meta\": {\n \"paymentLinkId\": \"11eda15bbc337c209a1b615ba5112be7\"\n },\n \"merchant_id\": \"merchant1\",\n \"common_name\": \"sameple link\",\n \"id\": \"11eda15bbc337c209a1b615ba5112be7\",\n \"tinyurl\": \"https://paymnt.io/nMeuJc\"\n }\n}" } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "example": 201, "default": 0 }, "message": { "type": "string", "example": "Payment Link created" }, "body": { "type": "object", "properties": { "link_meta": { "type": "object", "properties": { "paymentLinkId": { "type": "string", "example": "11eda15bbc337c209a1b615ba5112be7" } } }, "merchant_id": { "type": "string", "example": "merchant1" }, "common_name": { "type": "string", "example": "sameple link" }, "id": { "type": "string", "example": "11eda15bbc337c209a1b615ba5112be7" }, "tinyurl": { "type": "string", "example": "https://paymnt.io/nMeuJc" } } } } } } } }, "500": { "description": "500", "content": { "application/json": { "examples": { "Invalid funding id": { "value": "{\n \"error\": \"Invalid funding account id\",\n \"status\": 500,\n \"message\": \"Generic Error\"\n}" }, "Missing link_meta": { "value": "{\n \"error\": \"link_meta is required\",\n \"status\": 500,\n \"message\": \"Generic Error\"\n}" } }, "schema": { "oneOf": [ { "title": "Invalid funding id", "type": "object", "properties": { "error": { "type": "string", "example": "Invalid funding account id" }, "status": { "type": "integer", "example": 500, "default": 0 }, "message": { "type": "string", "example": "Generic Error" } } }, { "title": "Missing link_meta", "type": "object", "properties": { "error": { "type": "string", "example": "link_meta is required" }, "status": { "type": "integer", "example": 500, "default": 0 }, "message": { "type": "string", "example": "Generic Error" } } } ] } } } } }, "deprecated": false } }, "/payment-method/{id}": { "delete": { "summary": "Delete a Payment Method", "description": "This function deletes a payment-method of a customer.", "operationId": "delete-a-payment-method", "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"id\": \"6ba7babe-9906-4e7e-b1a5-f628c7badb61\",\n \"customer_id\": \"d45ee88c-8b27-4be8-8d81-77dda1b81826\",\n \"merchant_id\": \"dd36b936-1eb7-4ece-bebc-b514c6a36ebd\",\n \"user_id\": \"b58d7eee-e68d-4d12-a1f8-62f5e71382ae\",\n \"nickname\": \"VISA: Steven Smith Jr. (ending in: 1111)\",\n \"is_default\": 1,\n \"method\": \"card\",\n \"person_name\": \"Steven Smith Jr.\",\n \"card_type\": \"visa\",\n \"card_last_four\": \"1111\",\n \"card_exp\": \"042019\",\n \"bank_name\": null,\n \"bank_type\": null,\n \"bank_holder_type\": null,\n \"address_1\": null,\n \"address_2\": null,\n \"address_city\": null,\n \"address_state\": null,\n \"address_zip\": \"32944\",\n \"address_country\": \"USA\",\n \"purged_at\": null,\n \"deleted_at\": \"2017-05-10 19:54:09\",\n \"created_at\": \"2017-05-10 19:54:04\",\n \"updated_at\": \"2017-05-10 19:54:04\",\n \"card_exp_datetime\": \"2019-04-30 23:59:59\",\n \"customer\": {\n \"id\": \"d45ee88c-8b27-4be8-8d81-77dda1b81826\",\n \"firstname\": \"John\",\n \"lastname\": \"Smith\",\n \"company\": \"ABC INC\",\n \"email\": \"demo@abc.com\",\n \"cc_emails\": [\n \"demo1@abc.com\",\n \"demo2@abc.com\"\n ],\n \"phone\": \"1234567898\",\n \"address_1\": \"123 Rite Way\",\n \"address_2\": \"Unit 12\",\n \"address_city\": \"Orlando\",\n \"address_state\": \"FL\",\n \"address_zip\": \"32801\",\n \"address_country\": \"USA\",\n \"notes\": null,\n \"reference\": \"BARTLE\",\n \"options\": \"\",\n \"created_at\": \"2017-05-08 19:22:51\",\n \"updated_at\": \"2017-05-08 19:23:46\",\n \"deleted_at\": null,\n \"gravatar\": \"//www.gravatar.com/avatar/fe3e929dd80f1653c3a4b82812660061\"\n }\n}" } }, "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "6ba7babe-9906-4e7e-b1a5-f628c7badb61" }, "customer_id": { "type": "string", "example": "d45ee88c-8b27-4be8-8d81-77dda1b81826" }, "merchant_id": { "type": "string", "example": "dd36b936-1eb7-4ece-bebc-b514c6a36ebd" }, "user_id": { "type": "string", "example": "b58d7eee-e68d-4d12-a1f8-62f5e71382ae" }, "nickname": { "type": "string", "example": "VISA: Steven Smith Jr. (ending in: 1111)" }, "is_default": { "type": "integer", "example": 1, "default": 0 }, "method": { "type": "string", "example": "card" }, "person_name": { "type": "string", "example": "Steven Smith Jr." }, "card_type": { "type": "string", "example": "visa" }, "card_last_four": { "type": "string", "example": "1111" }, "card_exp": { "type": "string", "example": "042019" }, "bank_name": {}, "bank_type": {}, "bank_holder_type": {}, "address_1": {}, "address_2": {}, "address_city": {}, "address_state": {}, "address_zip": { "type": "string", "example": "32944" }, "address_country": { "type": "string", "example": "USA" }, "purged_at": {}, "deleted_at": { "type": "string", "example": "2017-05-10 19:54:09" }, "created_at": { "type": "string", "example": "2017-05-10 19:54:04" }, "updated_at": { "type": "string", "example": "2017-05-10 19:54:04" }, "card_exp_datetime": { "type": "string", "example": "2019-04-30 23:59:59" }, "customer": { "type": "object", "properties": { "id": { "type": "string", "example": "d45ee88c-8b27-4be8-8d81-77dda1b81826" }, "firstname": { "type": "string", "example": "John" }, "lastname": { "type": "string", "example": "Smith" }, "company": { "type": "string", "example": "ABC INC" }, "email": { "type": "string", "example": "demo@abc.com" }, "cc_emails": { "type": "array", "items": { "type": "string", "example": "demo1@abc.com" } }, "phone": { "type": "string", "example": "1234567898" }, "address_1": { "type": "string", "example": "123 Rite Way" }, "address_2": { "type": "string", "example": "Unit 12" }, "address_city": { "type": "string", "example": "Orlando" }, "address_state": { "type": "string", "example": "FL" }, "address_zip": { "type": "string", "example": "32801" }, "address_country": { "type": "string", "example": "USA" }, "notes": {}, "reference": { "type": "string", "example": "BARTLE" }, "options": { "type": "string", "example": "" }, "created_at": { "type": "string", "example": "2017-05-08 19:22:51" }, "updated_at": { "type": "string", "example": "2017-05-08 19:23:46" }, "deleted_at": {}, "gravatar": { "type": "string", "example": "//www.gravatar.com/avatar/fe3e929dd80f1653c3a4b82812660061" } } } } } } } }, "422": { "description": "422", "content": { "application/json": { "examples": { "Invalid Id": { "value": "{\n \"id\": [\n \"The selected id is invalid.\"\n ]\n}" } }, "schema": { "type": "object", "properties": { "id": { "type": "array", "items": { "type": "string", "example": "The selected id is invalid." } } } } } } } }, "deprecated": false }, "get": { "summary": "Get a Payment Method By ID", "description": "Retrieves the payment method matching the given id.", "operationId": "get-a-payment-method-by-id", "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"id\": \"6ba7babe-9906-4e7e-b1a5-f628c7badb61\",\n \"customer_id\": \"d45ee88c-8b27-4be8-8d81-77dda1b81826\",\n \"merchant_id\": \"dd36b936-1eb7-4ece-bebc-b514c6a36ebd\",\n \"user_id\": \"b58d7eee-e68d-4d12-a1f8-62f5e71382ae\",\n \"nickname\": \"VISA: Steven Smith Jr. (ending in: 1111)\",\n \"is_default\": 1,\n \"method\": \"card\",\n \"meta\": {\n \"cardDisplay\": \"484718\",\n \"routingDisplay\": null,\n \"accountDisplay\": null,\n \"eligibleForCardUpdater\": true,\n \"storageState\": \"cached\",\n \"fingerprint\": \"888999888777888999988\",\n \"errors\": [],\n \"prepaid\": null\n },\n \"bin_type\": \"DEBIT\",\n \"person_name\": \"Steven Smith Jr.\",\n \"card_type\": \"visa\",\n \"card_last_four\": \"1111\",\n \"card_exp\": \"042019\",\n \"bank_name\": null,\n \"bank_type\": null,\n \"bank_holder_type\": null,\n \"address_1\": null,\n \"address_2\": null,\n \"address_city\": null,\n \"address_state\": null,\n \"address_zip\": \"32944\",\n \"address_country\": \"USA\",\n \"purged_at\": null,\n \"deleted_at\": \"2017-05-10 19:54:09\",\n \"created_at\": \"2017-05-10 19:54:04\",\n \"updated_at\": \"2017-05-10 19:54:09\",\n \"card_exp_datetime\": \"2019-04-30 23:59:59\",\n \"customer\": {\n \"id\": \"d45ee88c-8b27-4be8-8d81-77dda1b81826\",\n \"firstname\": \"John\",\n \"lastname\": \"Smith\",\n \"company\": \"ABC INC\",\n \"email\": \"demo@abc.com\",\n \"cc_emails\": [\n \"demo1@abc.com\",\n \"demo2@abc.com\"\n ],\n \"phone\": \"1234567898\",\n \"address_1\": \"123 Rite Way\",\n \"address_2\": \"Unit 12\",\n \"address_city\": \"Orlando\",\n \"address_state\": \"FL\",\n \"address_zip\": \"32801\",\n \"address_country\": \"USA\",\n \"notes\": null,\n \"reference\": \"BARTLE\",\n \"options\": \"\",\n \"created_at\": \"2017-05-08 19:22:51\",\n \"updated_at\": \"2017-05-08 19:23:46\",\n \"deleted_at\": null,\n \"gravatar\": \"//www.gravatar.com/avatar/fe3e929dd80f1653c3a4b82812660061\"\n }\n}" } }, "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "6ba7babe-9906-4e7e-b1a5-f628c7badb61" }, "customer_id": { "type": "string", "example": "d45ee88c-8b27-4be8-8d81-77dda1b81826" }, "merchant_id": { "type": "string", "example": "dd36b936-1eb7-4ece-bebc-b514c6a36ebd" }, "user_id": { "type": "string", "example": "b58d7eee-e68d-4d12-a1f8-62f5e71382ae" }, "nickname": { "type": "string", "example": "VISA: Steven Smith Jr. (ending in: 1111)" }, "is_default": { "type": "integer", "example": 1, "default": 0 }, "method": { "type": "string", "example": "card" }, "meta": { "type": "object", "properties": { "cardDisplay": { "type": "string", "example": "484718" }, "routingDisplay": {}, "accountDisplay": {}, "eligibleForCardUpdater": { "type": "boolean", "example": true, "default": true }, "storageState": { "type": "string", "example": "cached" }, "fingerprint": { "type": "string", "example": "888999888777888999988" }, "errors": { "type": "array" }, "prepaid": {} } }, "bin_type": { "type": "string", "example": "DEBIT" }, "person_name": { "type": "string", "example": "Steven Smith Jr." }, "card_type": { "type": "string", "example": "visa" }, "card_last_four": { "type": "string", "example": "1111" }, "card_exp": { "type": "string", "example": "042019" }, "bank_name": {}, "bank_type": {}, "bank_holder_type": {}, "address_1": {}, "address_2": {}, "address_city": {}, "address_state": {}, "address_zip": { "type": "string", "example": "32944" }, "address_country": { "type": "string", "example": "USA" }, "purged_at": {}, "deleted_at": { "type": "string", "example": "2017-05-10 19:54:09" }, "created_at": { "type": "string", "example": "2017-05-10 19:54:04" }, "updated_at": { "type": "string", "example": "2017-05-10 19:54:09" }, "card_exp_datetime": { "type": "string", "example": "2019-04-30 23:59:59" }, "customer": { "type": "object", "properties": { "id": { "type": "string", "example": "d45ee88c-8b27-4be8-8d81-77dda1b81826" }, "firstname": { "type": "string", "example": "John" }, "lastname": { "type": "string", "example": "Smith" }, "company": { "type": "string", "example": "ABC INC" }, "email": { "type": "string", "example": "demo@abc.com" }, "cc_emails": { "type": "array", "items": { "type": "string", "example": "demo1@abc.com" } }, "phone": { "type": "string", "example": "1234567898" }, "address_1": { "type": "string", "example": "123 Rite Way" }, "address_2": { "type": "string", "example": "Unit 12" }, "address_city": { "type": "string", "example": "Orlando" }, "address_state": { "type": "string", "example": "FL" }, "address_zip": { "type": "string", "example": "32801" }, "address_country": { "type": "string", "example": "USA" }, "notes": {}, "reference": { "type": "string", "example": "BARTLE" }, "options": { "type": "string", "example": "" }, "created_at": { "type": "string", "example": "2017-05-08 19:22:51" }, "updated_at": { "type": "string", "example": "2017-05-08 19:23:46" }, "deleted_at": {}, "gravatar": { "type": "string", "example": "//www.gravatar.com/avatar/fe3e929dd80f1653c3a4b82812660061" } } } } } } } }, "422": { "description": "422", "content": { "application/json": { "examples": { "Invalid ID": { "value": "{\n \"id\": [\n \"The selected id is invalid.\"\n ]\n}" } }, "schema": { "type": "object", "properties": { "id": { "type": "array", "items": { "type": "string", "example": "The selected id is invalid." } } } } } } } } }, "put": { "summary": "Update a Payment Method", "description": "This function updates a payment-method after it already exists whether it was created through Stax.js or direct-post.", "operationId": "update-a-payment-method", "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "is_default", "in": "query", "schema": { "type": "boolean" }, "required": false, "description": "1 or 0 (true or false)" }, { "name": "person_name", "in": "query", "schema": { "type": "string" }, "description": "Name of the customer." }, { "name": "card_last_four", "in": "query", "schema": { "type": "integer", "format": "int32" }, "description": "Last four digits of the payment method to be modified." }, { "name": "card_type", "in": "query", "description": "10 character max. null is acceptable.", "schema": { "type": "string" } }, { "name": "card_exp", "in": "query", "schema": { "type": "string" }, "description": "4 digits of the expiry date." }, { "name": "has_cvv", "in": "query", "schema": { "type": "boolean" } }, { "name": "bank_name", "in": "query", "required": false, "schema": { "type": "string" }, "description": "255 character max. If supplied, MUST have a value, it is not nullable." }, { "name": "bank_type", "in": "query", "schema": { "type": "string", "enum": [ "checking", "savings" ] }, "description": " If supplied, MUST have a value, it is not nullable." }, { "name": "bank_holder_type", "in": "query", "schema": { "type": "string", "enum": [ "personal", "business" ] }, "description": " If supplied, MUST have a value, it is not nullable." }, { "name": "meta", "in": "query", "schema": { "type": "array", "items": { "type": "string" } }, "description": "Note this will overwrite all data currently in the meta field. " }, { "in": "query", "name": "address_1", "schema": { "type": "string" }, "description": "Max 255 characters. Null is accepted. This field may be used for AVS." }, { "in": "query", "name": "address_2", "schema": { "type": "string" }, "description": "Max 255 characters. Null is accepted." }, { "in": "query", "name": "address_city", "schema": { "type": "string" }, "description": "Max 255 characters. Null is accepted." }, { "in": "query", "name": "address_state", "schema": { "type": "string" }, "description": "Two character state.Null is accepted." }, { "in": "query", "name": "address_zip", "schema": { "type": "string" }, "description": "Max 16 characters. Null is accepted. This field may be used for AVS." }, { "in": "query", "name": "address_country", "schema": { "type": "string" }, "description": "Use country 3 character code. Null is accepted. " } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"id\": \"6ba7babe-9906-4e7e-b1a5-f628c7badb61\",\n \"customer_id\": \"d45ee88c-8b27-4be8-8d81-77dda1b81826\",\n \"merchant_id\": \"dd36b936-1eb7-4ece-bebc-b514c6a36ebd\",\n \"user_id\": \"b58d7eee-e68d-4d12-a1f8-62f5e71382ae\",\n \"nickname\": \"VISA: Carl Junior Sr. (ending in: 1111)\",\n \"is_default\": 1,\n \"method\": \"card\",\n \"person_name\": \"Carl Junior Sr.\",\n \"card_type\": \"visa\",\n \"card_last_four\": \"1111\",\n \"card_exp\": \"042019\",\n \"bank_name\": null,\n \"bank_type\": null,\n \"bank_holder_type\": null,\n \"address_1\": null,\n \"address_2\": null,\n \"address_city\": null,\n \"address_state\": null,\n \"address_zip\": \"32944\",\n \"address_country\": \"USA\",\n \"purged_at\": null,\n \"deleted_at\": null,\n \"created_at\": \"2017-05-10 19:54:04\",\n \"updated_at\": \"2017-05-10 19:54:04\",\n \"card_exp_datetime\": \"2019-04-30 23:59:59\",\n \"customer\": {\n \"id\": \"d45ee88c-8b27-4be8-8d81-77dda1b81826\",\n \"firstname\": \"John\",\n \"lastname\": \"Smith\",\n \"company\": \"ABC INC\",\n \"email\": \"demo@abc.com\",\n \"cc_emails\": [\n \"demo1@abc.com\",\n \"demo2@abc.com\"\n ],\n \"phone\": \"1234567898\",\n \"address_1\": \"123 Rite Way\",\n \"address_2\": \"Unit 12\",\n \"address_city\": \"Orlando\",\n \"address_state\": \"FL\",\n \"address_zip\": \"32801\",\n \"address_country\": \"USA\",\n \"notes\": null,\n \"reference\": \"BARTLE\",\n \"options\": \"\",\n \"created_at\": \"2017-05-08 19:22:51\",\n \"updated_at\": \"2017-05-08 19:23:46\",\n \"deleted_at\": null,\n \"gravatar\": \"//www.gravatar.com/avatar/fe3e929dd80f1653c3a4b82812660061\"\n }\n}" } }, "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "6ba7babe-9906-4e7e-b1a5-f628c7badb61" }, "customer_id": { "type": "string", "example": "d45ee88c-8b27-4be8-8d81-77dda1b81826" }, "merchant_id": { "type": "string", "example": "dd36b936-1eb7-4ece-bebc-b514c6a36ebd" }, "user_id": { "type": "string", "example": "b58d7eee-e68d-4d12-a1f8-62f5e71382ae" }, "nickname": { "type": "string", "example": "VISA: Carl Junior Sr. (ending in: 1111)" }, "is_default": { "type": "integer", "example": 1, "default": 0 }, "method": { "type": "string", "example": "card" }, "person_name": { "type": "string", "example": "Carl Junior Sr." }, "card_type": { "type": "string", "example": "visa" }, "card_last_four": { "type": "string", "example": "1111" }, "card_exp": { "type": "string", "example": "042019" }, "bank_name": {}, "bank_type": {}, "bank_holder_type": {}, "address_1": {}, "address_2": {}, "address_city": {}, "address_state": {}, "address_zip": { "type": "string", "example": "32944" }, "address_country": { "type": "string", "example": "USA" }, "purged_at": {}, "deleted_at": {}, "created_at": { "type": "string", "example": "2017-05-10 19:54:04" }, "updated_at": { "type": "string", "example": "2017-05-10 19:54:04" }, "card_exp_datetime": { "type": "string", "example": "2019-04-30 23:59:59" }, "customer": { "type": "object", "properties": { "id": { "type": "string", "example": "d45ee88c-8b27-4be8-8d81-77dda1b81826" }, "firstname": { "type": "string", "example": "John" }, "lastname": { "type": "string", "example": "Smith" }, "company": { "type": "string", "example": "ABC INC" }, "email": { "type": "string", "example": "demo@abc.com" }, "cc_emails": { "type": "array", "items": { "type": "string", "example": "demo1@abc.com" } }, "phone": { "type": "string", "example": "1234567898" }, "address_1": { "type": "string", "example": "123 Rite Way" }, "address_2": { "type": "string", "example": "Unit 12" }, "address_city": { "type": "string", "example": "Orlando" }, "address_state": { "type": "string", "example": "FL" }, "address_zip": { "type": "string", "example": "32801" }, "address_country": { "type": "string", "example": "USA" }, "notes": {}, "reference": { "type": "string", "example": "BARTLE" }, "options": { "type": "string", "example": "" }, "created_at": { "type": "string", "example": "2017-05-08 19:22:51" }, "updated_at": { "type": "string", "example": "2017-05-08 19:23:46" }, "deleted_at": {}, "gravatar": { "type": "string", "example": "//www.gravatar.com/avatar/fe3e929dd80f1653c3a4b82812660061" } } } } } } } }, "422": { "description": "422", "content": { "application/json": { "examples": { "Invalid Id": { "value": "{\n \"id\": [\n \"The selected id is invalid.\"\n ]\n}" } }, "schema": { "type": "object", "properties": { "id": { "type": "array", "items": { "type": "string", "example": "The selected id is invalid." } } } } } } } } } }, "/invoice/{id}": { "delete": { "summary": "Delete an Invoice", "description": "", "operationId": "delete-an-invoice", "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"id\": \"9ddcf02b-c2be-4f27-b758-dbc12b2aa924\",\n \"merchant_id\": \"dd36b936-1eb7-4ece-bebc-b514c6a36ebd\",\n \"user_id\": \"b58d7eee-e68d-4d12-a1f8-62f5e71382ae\",\n \"customer_id\": \"d45ee88c-8b27-4be8-8d81-77dda1b81826\",\n \"total\": 100,\n \"meta\": {\n \"tax\": 0,\n \"subtotal\": 10,\n \"lineItems\": [\n {\n \"id\": \"optional-fm-catalog-item-id\",\n \"item\": \"Demo Item\",\n \"details\": \"this is a regular demo item\",\n \"quantity\": 1,\n \"price\": 100\n }\n ]\n },\n \"status\": \"DELETED\",\n \"sent_at\": null,\n \"viewed_at\": null,\n \"paid_at\": null,\n \"schedule_id\": null,\n \"reminder_id\": null,\n \"payment_method_id\": \"d3050b19-77d9-44ac-9851-b1d1680a7684\",\n \"url\": \"https://app.staxpayments.com/#/bill/\",\n \"is_webpayment\": false,\n \"deleted_at\": \"2017-05-08 21:43:19\",\n \"created_at\": \"2017-05-08 21:32:51\",\n \"updated_at\": \"2017-05-08 21:43:19\",\n \"payment_attempt_failed\": false,\n \"payment_attempt_message\": \"\",\n \"balance_due\": 100,\n \"total_paid\": 0,\n \"payment_meta\": [],\n \"customer\": {\n \"id\": \"d45ee88c-8b27-4be8-8d81-77dda1b81826\",\n \"firstname\": \"John\",\n \"lastname\": \"Smith\",\n \"company\": \"ABC INC\",\n \"email\": \"demo@abc.com\",\n \"cc_emails\": [\n \"demo1@abc.com\",\n \"demo2@abc.com\"\n ],\n \"phone\": \"1234567898\",\n \"address_1\": \"123 Rite Way\",\n \"address_2\": \"Unit 12\",\n \"address_city\": \"Orlando\",\n \"address_state\": \"FL\",\n \"address_zip\": \"32801\",\n \"address_country\": \"USA\",\n \"notes\": null,\n \"reference\": \"BARTLE\",\n \"options\": \"\",\n \"created_at\": \"2017-05-08 19:22:51\",\n \"updated_at\": \"2017-05-08 19:23:46\",\n \"deleted_at\": null,\n \"gravatar\": \"//www.gravatar.com/avatar/fe3e929dd80f1653c3a4b82812660061\"\n },\n \"user\": {\n \"id\": \"b58d7eee-e68d-4d12-a1f8-62f5e71382ae\",\n \"system_admin\": false,\n \"name\": \"Demo\",\n \"email\": \"contact@example.com\",\n \"email_verification_sent_at\": \"2017-03-29 15:27:19\",\n \"email_verified_at\": \"2017-03-29 15:27:21\",\n \"is_api_key\": false,\n \"created_at\": \"2017-01-11 21:44:02\",\n \"updated_at\": \"2017-04-24 15:41:58\",\n \"deleted_at\": null,\n \"gravatar\": \"//www.gravatar.com/avatar/157965dea7cd2f44e349382d1d791650\",\n \"team_admin\": null,\n \"team_enabled\": null,\n \"team_role\": null\n },\n \"files\": [],\n \"child_transactions\": [],\n \"reminder\": null\n}" } }, "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "9ddcf02b-c2be-4f27-b758-dbc12b2aa924" }, "merchant_id": { "type": "string", "example": "dd36b936-1eb7-4ece-bebc-b514c6a36ebd" }, "user_id": { "type": "string", "example": "b58d7eee-e68d-4d12-a1f8-62f5e71382ae" }, "customer_id": { "type": "string", "example": "d45ee88c-8b27-4be8-8d81-77dda1b81826" }, "total": { "type": "integer", "example": 100, "default": 0 }, "meta": { "type": "object", "properties": { "tax": { "type": "integer", "example": 0, "default": 0 }, "subtotal": { "type": "integer", "example": 10, "default": 0 }, "lineItems": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "optional-fm-catalog-item-id" }, "item": { "type": "string", "example": "Demo Item" }, "details": { "type": "string", "example": "this is a regular demo item" }, "quantity": { "type": "integer", "example": 1, "default": 0 }, "price": { "type": "integer", "example": 100, "default": 0 } } } } } }, "status": { "type": "string", "example": "DELETED" }, "sent_at": {}, "viewed_at": {}, "paid_at": {}, "schedule_id": {}, "reminder_id": {}, "payment_method_id": { "type": "string", "example": "d3050b19-77d9-44ac-9851-b1d1680a7684" }, "url": { "type": "string", "example": "https://app.staxpayments.com/#/bill/" }, "is_webpayment": { "type": "boolean", "example": false, "default": true }, "deleted_at": { "type": "string", "example": "2017-05-08 21:43:19" }, "created_at": { "type": "string", "example": "2017-05-08 21:32:51" }, "updated_at": { "type": "string", "example": "2017-05-08 21:43:19" }, "payment_attempt_failed": { "type": "boolean", "example": false, "default": true }, "payment_attempt_message": { "type": "string", "example": "" }, "balance_due": { "type": "integer", "example": 100, "default": 0 }, "total_paid": { "type": "integer", "example": 0, "default": 0 }, "payment_meta": { "type": "array" }, "customer": { "type": "object", "properties": { "id": { "type": "string", "example": "d45ee88c-8b27-4be8-8d81-77dda1b81826" }, "firstname": { "type": "string", "example": "John" }, "lastname": { "type": "string", "example": "Smith" }, "company": { "type": "string", "example": "ABC INC" }, "email": { "type": "string", "example": "demo@abc.com" }, "cc_emails": { "type": "array", "items": { "type": "string", "example": "demo1@abc.com" } }, "phone": { "type": "string", "example": "1234567898" }, "address_1": { "type": "string", "example": "123 Rite Way" }, "address_2": { "type": "string", "example": "Unit 12" }, "address_city": { "type": "string", "example": "Orlando" }, "address_state": { "type": "string", "example": "FL" }, "address_zip": { "type": "string", "example": "32801" }, "address_country": { "type": "string", "example": "USA" }, "notes": {}, "reference": { "type": "string", "example": "BARTLE" }, "options": { "type": "string", "example": "" }, "created_at": { "type": "string", "example": "2017-05-08 19:22:51" }, "updated_at": { "type": "string", "example": "2017-05-08 19:23:46" }, "deleted_at": {}, "gravatar": { "type": "string", "example": "//www.gravatar.com/avatar/fe3e929dd80f1653c3a4b82812660061" } } }, "user": { "type": "object", "properties": { "id": { "type": "string", "example": "b58d7eee-e68d-4d12-a1f8-62f5e71382ae" }, "system_admin": { "type": "boolean", "example": false, "default": true }, "name": { "type": "string", "example": "Demo" }, "email": { "type": "string", "example": "contact@example.com" }, "email_verification_sent_at": { "type": "string", "example": "2017-03-29 15:27:19" }, "email_verified_at": { "type": "string", "example": "2017-03-29 15:27:21" }, "is_api_key": { "type": "boolean", "example": false, "default": true }, "created_at": { "type": "string", "example": "2017-01-11 21:44:02" }, "updated_at": { "type": "string", "example": "2017-04-24 15:41:58" }, "deleted_at": {}, "gravatar": { "type": "string", "example": "//www.gravatar.com/avatar/157965dea7cd2f44e349382d1d791650" }, "team_admin": {}, "team_enabled": {}, "team_role": {} } }, "files": { "type": "array" }, "child_transactions": { "type": "array" }, "reminder": {} } } } } }, "422": { "description": "422", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"deleted_at\": [\n \"The invoice is already deleted.\"\n ]\n}" } }, "schema": { "type": "object", "properties": { "deleted_at": { "type": "array", "items": { "type": "string", "example": "The invoice is already deleted." } } } } } } } }, "deprecated": false }, "get": { "summary": "Get an Invoice", "description": "Retrieves the invoice matching the given id.", "operationId": "get-an-invoice", "parameters": [ { "name": "keyword[]", "in": "query", "schema": { "type": "string" } }, { "name": "id", "in": "path", "schema": { "type": "string", "default": "the invoice id." }, "required": true } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": { "id": "e40bd293-f754-4d15-a6cb-56514757b73b", "status": "PAID", "total": 1, "created_at": "2025-06-25 18:00:03", "sent_at": null, "viewed_at": null, "paid_at": "2025-06-25 18:08:27", "due_at": null, "invoice_date_at": "2025-06-25 18:00:03", "payment_attempt_failed": false, "payment_attempt_message": "", "balance_due": 0, "total_paid": 1, "url": "https://app.staxpayments.com/#/bill/", "is_partial_payment_enabled": true, "merchant": { "id": "003b87f7-f4ed-43fc-b1b8-82604c8d1821", "company_name": "Sandbox Gateway Test Account", "display_name": "Sandbox Gateway Test Account", "contact_phone": "", "contact_email": "testemail@staxpayments.com", "address_1": "", "address_2": "", "address_city": "", "address_state": "", "address_zip": "", "branding": null, "options": { "social": null, "brand": { "logo": [ { "id": "staxconnect-sandbox_logoPngWideWhite", "url": "https://fattpaydocuments.s3.us-west-2.amazonaws.com/logo/staxconnect-sandbox_logoPngWideWhite.png?1709312609426", "filename": "Stax - with X Brandmark - White (5).png", "size": 52735, "type": "image/png", "thumbnails": { "small": { "url": "https://dl.airtable.com/.attachmentThumbnails/7780470946d0da3dd26e2569c605b1ea/6b93d9f9", "width": 72, "height": 36 }, "large": { "url": "https://dl.airtable.com/.attachmentThumbnails/ef736fa9fc4df641986299dd58c00aec/761118fa", "width": 1019, "height": 512 }, "full": { "url": "https://dl.airtable.com/.attachmentThumbnails/e05ef3e015bcf603932fb9d06a9e6872/80f30247", "width": 3000, "height": 3000 } } } ], "background_color": "101634", "primary_color": "101634", "platform_name": "Stax Connect Demo Sandbox" }, "advanced_customization": null, "invoice_display_data": null, "are_invoice_credit_card_payments_allowed_by_default": null, "hosted_hideCompanyName": null, "invoice_payment_methods": null }, "allow_ach": true, "hosted_payments_token": "Sandbox-Hosted-Payments-Token", "is_enterprise": false, "is_advanced_customization_enabled": false, "cnp_credit_surcharge_rate": null, "allow_paypal": true, "is_surcharge_enabled": false, "require_address": false }, "customer": { "id": "257833da-1a8f-4f3f-af5d-191cad3f9275", "phone": "5555555555", "email": "", "firstname": "Stax", "lastname": "Testuser", "company": "Your Company Here", "allow_invoice_credit_card_payments": true }, "payment_method": { "id": "1789f7da-eb8e-4b83-9b12-498b6ee1c947", "method": "card", "card_type": "visa", "card_last_four": "1111", "card_exp": "022027", "nickname": "VISA: Stax Testuser (ending in: 1111)", "created_at": "2025-06-25 18:08:24" }, "schedule": null, "transactions": [ { "id": "23616b07-3c2b-4d8b-a20c-3d8b747d2272", "invoice_id": "e40bd293-f754-4d15-a6cb-56514757b73b", "success": true, "message": null, "type": "charge", "created_at": "2025-06-25 18:08:25", "last_four": "1111", "issuer_auth_code": null, "total": 1, "method": "card", "payment_method_id": "1789f7da-eb8e-4b83-9b12-498b6ee1c947", "total_refunded": 0, "is_refundable": false, "is_voided": false, "is_voidable": false, "schedule_id": null, "child_captures": [], "parent_auth": null, "customer": null, "child_transactions": [], "files": [], "payment_method": { "id": "1789f7da-eb8e-4b83-9b12-498b6ee1c947", "method": "card", "card_type": "visa", "bank_type": null, "card_exp": "022027", "card_last_four": "1111", "nickname": "VISA: Stax Testuser (ending in: 1111)", "person_name": "Stax Testuser", "created_at": "2025-06-25 18:08:24", "customer": null }, "user": null } ], "files": [], "meta": { "memo": "" } } } }, "schema": { "type": "object", "properties": {} } } } }, "400": { "description": "400", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "default": " \"id\": [ \"The selected id is invalid.\"" } } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" } }, "required": [ "id" ] }, "examples": { "New Example": { "summary": "New Example", "value": "{ \"id\": [\n \"The selected id is invalid.\"}" } } } } } }, "deprecated": false }, "put": { "summary": "Update an Invoice", "description": "Alter or update an invoice.", "operationId": "update-an-invoice", "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "invoice_date_at", "in": "query", "description": "If left blank when the invoice was created, the value will have defaulted to the current timestamp of creation. This field is used for the date the work was done, service was provided, or any other date the merchant wishes to track.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"id\": \"9ddcf02b-c2be-4f27-b758-dbc12b2aa924\",\n \"merchant_id\": \"dd36b936-1eb7-4ece-bebc-b514c6a36ebd\",\n \"user_id\": \"b58d7eee-e68d-4d12-a1f8-62f5e71382ae\",\n \"customer_id\": \"d45ee88c-8b27-4be8-8d81-77dda1b81826\",\n \"total\": 100,\n \"meta\": {\n \"tax\": 0,\n \"subtotal\": 10,\n \"lineItems\": [\n {\n \"id\": \"optional-fm-catalog-item-id\",\n \"item\": \"Demo Item\",\n \"details\": \"this is a regular demo item\",\n \"quantity\": 1,\n \"price\": 100\n }\n ]\n },\n \"status\": \"DRAFT\",\n \"sent_at\": null,\n \"viewed_at\": null,\n \"paid_at\": null,\n \"schedule_id\": null,\n \"reminder_id\": null,\n \"payment_method_id\": \"d3050b19-77d9-44ac-9851-b1d1680a7684\",\n \"url\": \"https://app.staxpayments.com/#/bill/\",\n \"is_webpayment\": false,\n \"deleted_at\": null,\n \"created_at\": \"2017-05-08 21:32:51\",\n \"updated_at\": \"2017-05-08 21:42:50\",\n \"payment_attempt_failed\": false,\n \"payment_attempt_message\": \"\",\n \"balance_due\": 100,\n \"total_paid\": 0,\n \"payment_meta\": [],\n \"customer\": {\n \"id\": \"d45ee88c-8b27-4be8-8d81-77dda1b81826\",\n \"firstname\": \"John\",\n \"lastname\": \"Smith\",\n \"company\": \"ABC INC\",\n \"email\": \"demo@abc.com\",\n \"cc_emails\": [\n \"demo1@abc.com\",\n \"demo2@abc.com\"\n ],\n \"phone\": \"1234567898\",\n \"address_1\": \"123 Rite Way\",\n \"address_2\": \"Unit 12\",\n \"address_city\": \"Orlando\",\n \"address_state\": \"FL\",\n \"address_zip\": \"32801\",\n \"address_country\": \"USA\",\n \"notes\": null,\n \"reference\": \"BARTLE\",\n \"options\": \"\",\n \"created_at\": \"2017-05-08 19:22:51\",\n \"updated_at\": \"2017-05-08 19:23:46\",\n \"deleted_at\": null,\n \"gravatar\": \"//www.gravatar.com/avatar/fe3e929dd80f1653c3a4b82812660061\"\n },\n \"user\": {\n \"id\": \"b58d7eee-e68d-4d12-a1f8-62f5e71382ae\",\n \"system_admin\": false,\n \"name\": \"Demo\",\n \"email\": \"contact@example.com\",\n \"email_verification_sent_at\": \"2017-03-29 15:27:19\",\n \"email_verified_at\": \"2017-03-29 15:27:21\",\n \"is_api_key\": false,\n \"created_at\": \"2017-01-11 21:44:02\",\n \"updated_at\": \"2017-04-24 15:41:58\",\n \"deleted_at\": null,\n \"gravatar\": \"//www.gravatar.com/avatar/157965dea7cd2f44e349382d1d791650\",\n \"team_admin\": null,\n \"team_enabled\": null,\n \"team_role\": null\n },\n \"files\": [],\n \"child_transactions\": [],\n \"reminder\": null\n}" } }, "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "9ddcf02b-c2be-4f27-b758-dbc12b2aa924" }, "merchant_id": { "type": "string", "example": "dd36b936-1eb7-4ece-bebc-b514c6a36ebd" }, "user_id": { "type": "string", "example": "b58d7eee-e68d-4d12-a1f8-62f5e71382ae" }, "customer_id": { "type": "string", "example": "d45ee88c-8b27-4be8-8d81-77dda1b81826" }, "total": { "type": "integer", "example": 100, "default": 0 }, "meta": { "type": "object", "properties": { "tax": { "type": "integer", "example": 0, "default": 0 }, "subtotal": { "type": "integer", "example": 10, "default": 0 }, "lineItems": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "optional-fm-catalog-item-id" }, "item": { "type": "string", "example": "Demo Item" }, "details": { "type": "string", "example": "this is a regular demo item" }, "quantity": { "type": "integer", "example": 1, "default": 0 }, "price": { "type": "integer", "example": 100, "default": 0 } } } } } }, "status": { "type": "string", "example": "DRAFT" }, "sent_at": {}, "viewed_at": {}, "paid_at": {}, "schedule_id": {}, "reminder_id": {}, "payment_method_id": { "type": "string", "example": "d3050b19-77d9-44ac-9851-b1d1680a7684" }, "url": { "type": "string", "example": "https://app.staxpayments.com/#/bill/" }, "is_webpayment": { "type": "boolean", "example": false, "default": true }, "deleted_at": {}, "created_at": { "type": "string", "example": "2017-05-08 21:32:51" }, "updated_at": { "type": "string", "example": "2017-05-08 21:42:50" }, "payment_attempt_failed": { "type": "boolean", "example": false, "default": true }, "payment_attempt_message": { "type": "string", "example": "" }, "balance_due": { "type": "integer", "example": 100, "default": 0 }, "total_paid": { "type": "integer", "example": 0, "default": 0 }, "payment_meta": { "type": "array" }, "customer": { "type": "object", "properties": { "id": { "type": "string", "example": "d45ee88c-8b27-4be8-8d81-77dda1b81826" }, "firstname": { "type": "string", "example": "John" }, "lastname": { "type": "string", "example": "Smith" }, "company": { "type": "string", "example": "ABC INC" }, "email": { "type": "string", "example": "demo@abc.com" }, "cc_emails": { "type": "array", "items": { "type": "string", "example": "demo1@abc.com" } }, "phone": { "type": "string", "example": "1234567898" }, "address_1": { "type": "string", "example": "123 Rite Way" }, "address_2": { "type": "string", "example": "Unit 12" }, "address_city": { "type": "string", "example": "Orlando" }, "address_state": { "type": "string", "example": "FL" }, "address_zip": { "type": "string", "example": "32801" }, "address_country": { "type": "string", "example": "USA" }, "notes": {}, "reference": { "type": "string", "example": "BARTLE" }, "options": { "type": "string", "example": "" }, "created_at": { "type": "string", "example": "2017-05-08 19:22:51" }, "updated_at": { "type": "string", "example": "2017-05-08 19:23:46" }, "deleted_at": {}, "gravatar": { "type": "string", "example": "//www.gravatar.com/avatar/fe3e929dd80f1653c3a4b82812660061" } } }, "user": { "type": "object", "properties": { "id": { "type": "string", "example": "b58d7eee-e68d-4d12-a1f8-62f5e71382ae" }, "system_admin": { "type": "boolean", "example": false, "default": true }, "name": { "type": "string", "example": "Demo" }, "email": { "type": "string", "example": "contact@example.com" }, "email_verification_sent_at": { "type": "string", "example": "2017-03-29 15:27:19" }, "email_verified_at": { "type": "string", "example": "2017-03-29 15:27:21" }, "is_api_key": { "type": "boolean", "example": false, "default": true }, "created_at": { "type": "string", "example": "2017-01-11 21:44:02" }, "updated_at": { "type": "string", "example": "2017-04-24 15:41:58" }, "deleted_at": {}, "gravatar": { "type": "string", "example": "//www.gravatar.com/avatar/157965dea7cd2f44e349382d1d791650" }, "team_admin": {}, "team_enabled": {}, "team_role": {} } }, "files": { "type": "array" }, "child_transactions": { "type": "array" }, "reminder": {} } } } } }, "422": { "description": "422", "content": { "application/json": { "examples": { "Invalid ID": { "value": "{\n \"id\": [\n \"The selected id is invalid.\"\n ]\n}" } }, "schema": { "type": "object", "properties": { "id": { "type": "array", "items": { "type": "string", "example": "The selected id is invalid." } } } } } } } } } }, "/file/dispute/{evidenceFileId}": { "delete": { "summary": "Delete Evidence for Dispute", "description": "This route handles requests to delete a given evidence file.", "operationId": "delete-evidence-for-dispute", "parameters": [ { "name": "evidenceFileId", "in": "path", "description": "A unique identifier for an evidence file.", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"id\": \"b268c536-ba18-49da-83fa-914511f590f7\",\n \"merchant_id\": \"merchant1\",\n \"user_id\": \"user1\",\n \"name\": \"receipt evidence\",\n \"path\": \"dispute/b268c536-ba18-49da-83fa-914511f590f7.png\",\n \"public_url\": \"https://contractors-dev-bucket.s3.us-west-2.amazonaws.com/dispute/b268c536-ba18-49da-83fa-914511f590f7.png\",\n \"tag\": \"dispute\",\n \"meta\": {\n \"filesize_bytes\": 7640,\n \"filesize\": \"0.08 kB\",\n \"extension\": \"png\",\n \"size\": {\n \"width\": 698,\n \"height\": 165\n },\n \"mime\": \"image/png\"\n },\n \"created_at\": \"2020-01-24 18:46:49\",\n \"updated_at\": \"2020-02-11 17:31:03\",\n \"deleted_at\": \"2020-02-11 17:31:03\"\n}" } }, "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "b268c536-ba18-49da-83fa-914511f590f7" }, "merchant_id": { "type": "string", "example": "merchant1" }, "user_id": { "type": "string", "example": "user1" }, "name": { "type": "string", "example": "receipt evidence" }, "path": { "type": "string", "example": "dispute/b268c536-ba18-49da-83fa-914511f590f7.png" }, "public_url": { "type": "string", "example": "https://contractors-dev-bucket.s3.us-west-2.amazonaws.com/dispute/b268c536-ba18-49da-83fa-914511f590f7.png" }, "tag": { "type": "string", "example": "dispute" }, "meta": { "type": "object", "properties": { "filesize_bytes": { "type": "integer", "example": 7640, "default": 0 }, "filesize": { "type": "string", "example": "0.08 kB" }, "extension": { "type": "string", "example": "png" }, "size": { "type": "object", "properties": { "width": { "type": "integer", "example": 698, "default": 0 }, "height": { "type": "integer", "example": 165, "default": 0 } } }, "mime": { "type": "string", "example": "image/png" } } }, "created_at": { "type": "string", "example": "2020-01-24 18:46:49" }, "updated_at": { "type": "string", "example": "2020-02-11 17:31:03" }, "deleted_at": { "type": "string", "example": "2020-02-11 17:31:03" } } } } } } }, "deprecated": false } }, "/merchant/{id}/registration/file/{file_id}": { "delete": { "summary": "Delete File from Merchant Registration", "description": "Delete a file from a merchant's registration", "operationId": "delete-file-from-merchant-registration", "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true, "description": "ID of the merchant." }, { "name": "file_id", "in": "path", "schema": { "type": "string" }, "required": true, "description": "ID of the file to be removed." } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"annual_volume\": \"\",\n \"avg_trans_size\": \"\",\n \"b2b_percent\": \"\",\n \"bank_account_type\": \"\",\n \"business_address_1\": \"\",\n \"business_address_2\": \"\",\n \"business_address_city\": \"\",\n \"business_address_country\": \"\",\n \"business_address_state\": \"\",\n \"business_address_zip\": \"\",\n \"business_dba\": \"\",\n \"business_email\": \"\",\n \"business_fax\": \"\",\n \"business_legal_name\": \"\",\n \"business_open_date\": \"\",\n \"business_phone_number\": \"\",\n \"business_tax_id\": \"\",\n \"business_website\": \"\",\n \"card_not_present_percent\": \"\",\n \"card_present_percent\": \"\",\n \"card_swiped_percent\": \"\",\n \"chosen_plan\": \"\",\n \"chosen_processing_method\": \"\",\n \"company_type\": \"\",\n \"email\": \"\",\n \"first_name\": \"\",\n \"highest_trans_amount\": \"\",\n \"international\": \"\",\n \"internet\": \"\",\n \"job_title\": \"\",\n \"last_name\": \"\",\n \"location_type\": \"\",\n \"meta\": {\n \"ownership_percentage\": 60,\n \"owner_citizenship\": \"ALA\",\n \"representatives\": [\n {\n \"title\": \"\",\n \"date_of_birth\": \"\",\n \"ssn\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"type\": \"\",\n \"ownership_percentage\": 40,\n \"email\": \"\",\n \"phone\": \"\",\n \"address_1\": \"\",\n \"address_2\": \"\",\n \"address_city\": \"\",\n \"address_state\": \"\",\n \"address_zip\": \"\",\n \"citizenship\": \"ALA\"\n }\n ]\n },\n \"moto_percent\": \"\",\n \"network\": \"\",\n \"owner_address_1\": \"\",\n \"owner_address_2\": \"\",\n \"owner_address_city\": \"\",\n \"owner_address_country\": \"\",\n \"owner_address_state\": \"\",\n \"owner_address_zip\": \"\",\n \"phone_number\": \"\",\n \"plan\": \"\",\n \"principal_owners_name\": \"\",\n \"reason_for_applying\": \"\",\n \"referred_by\": \"\",\n \"refund_policy\": \"\",\n \"seasonal_flag\": false,\n \"seasonal_months\": \"\",\n \"service_you_provide\": \"\",\n \"title\": \"\",\n \"user_dob\": \"\",\n \"merchant_id\": \"791fc3fa-4534-4617-97b6-d41c9e1ce8da\",\n \"user_id\": \"a01a5f74-cbdb-4704-9e9b-56fd5a8ee7b8\",\n \"updated_at\": \"2019-06-19 21:22:03\",\n \"created_at\": \"2019-06-19 21:22:03\",\n \"files\": [\n {\n \"id\": \"69ad5457-c027-4057-ad52-05ef0e39ec39\",\n \"merchant_id\": \"866ccc18-315e-496d-8a49-f16a5da79b75\",\n \"user_id\": \"8f5f7d73-d53c-47c6-8880-6da0de8d9a10\",\n \"name\": \"voidcheck\",\n \"path\": \"onboarding/69ad5457-c027-4057-ad52-05ef0e39ec39.png\",\n \"public_url\": \"https://fattonboardingfiles.s3.us-west-2.amazonaws.com/onboarding/69ad5457-c027-4057-ad52-05ef0e39ec39.png\",\n \"tag\": \"onboarding\",\n \"meta\": {\n \"filesize_bytes\": 2631,\n \"filesize\": \"0.03 kB\",\n \"extension\": \"png\",\n \"size\": {\n \"width\": 225,\n \"height\": 225\n },\n \"mime\": \"image/png\"\n },\n \"created_at\": \"2020-01-16 18:35:03\",\n \"updated_at\": \"2020-01-16 18:35:04\",\n \"deleted_at\": null\n },\n {\n \"id\": \"e87441c2-4c1f-483f-87eb-117cbd909405\",\n \"merchant_id\": \"866ccc18-315e-496d-8a49-f16a5da79b75\",\n \"user_id\": \"8f5f7d73-d53c-47c6-8880-6da0de8d9a10\",\n \"name\": \"voidcheck\",\n \"path\": null,\n \"public_url\": null,\n \"tag\": \"onboarding\",\n \"meta\": null,\n \"created_at\": \"2020-01-16 18:34:08\",\n \"updated_at\": \"2020-01-16 18:34:08\",\n \"deleted_at\": null\n },\n {\n \"id\": \"67e140cc-73fb-439f-9c32-545ad5a8492d\",\n \"merchant_id\": \"866ccc18-315e-496d-8a49-f16a5da79b75\",\n \"user_id\": \"8f5f7d73-d53c-47c6-8880-6da0de8d9a10\",\n \"name\": \"voidcheck\",\n \"path\": \"onboarding/67e140cc-73fb-439f-9c32-545ad5a8492d.txt\",\n \"public_url\": \"https://fattonboardingfiles.s3.us-west-2.amazonaws.com/onboarding/67e140cc-73fb-439f-9c32-545ad5a8492d.txt\",\n \"tag\": \"onboarding\",\n \"meta\": {\n \"filesize_bytes\": 35,\n \"filesize\": \"0 kB\",\n \"extension\": \"txt\",\n \"size\": null,\n \"mime\": \"text/plain\"\n },\n \"created_at\": \"2020-01-16 18:01:54\",\n \"updated_at\": \"2020-01-16 18:01:54\",\n \"deleted_at\": null\n },\n {\n \"id\": \"72331b5e-340b-4dbf-a807-ad175d8eee53\",\n \"merchant_id\": \"866ccc18-315e-496d-8a49-f16a5da79b75\",\n \"user_id\": \"8f5f7d73-d53c-47c6-8880-6da0de8d9a10\",\n \"name\": \"voidcheck\",\n \"path\": null,\n \"public_url\": null,\n \"tag\": \"onboarding\",\n \"meta\": null,\n \"created_at\": \"2020-01-16 17:48:43\",\n \"updated_at\": \"2020-01-16 17:48:43\",\n \"deleted_at\": null\n }\n ],\n \"electronic_signature\": {\n \"html_content\": \"I agree to...\",\n \"ip\": \"42.1.1.113\",\n \"timestamp\": \"2019-06-19 21:22:03\",\n \"user_id\": \"a01a5f74-cbdb-4704-9e9b-56fd5a8ee7b8\",\n \"email\": \"john@doe.com\",\n \"browser_agent\": \"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_6) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/79.0.3945.88 Safari/537.36\"\n }\n}" } }, "schema": { "type": "object", "properties": { "annual_volume": { "type": "string", "example": "" }, "avg_trans_size": { "type": "string", "example": "" }, "b2b_percent": { "type": "string", "example": "" }, "bank_account_type": { "type": "string", "example": "" }, "business_address_1": { "type": "string", "example": "" }, "business_address_2": { "type": "string", "example": "" }, "business_address_city": { "type": "string", "example": "" }, "business_address_country": { "type": "string", "example": "" }, "business_address_state": { "type": "string", "example": "" }, "business_address_zip": { "type": "string", "example": "" }, "business_dba": { "type": "string", "example": "" }, "business_email": { "type": "string", "example": "" }, "business_fax": { "type": "string", "example": "" }, "business_legal_name": { "type": "string", "example": "" }, "business_open_date": { "type": "string", "example": "" }, "business_phone_number": { "type": "string", "example": "" }, "business_tax_id": { "type": "string", "example": "" }, "business_website": { "type": "string", "example": "" }, "card_not_present_percent": { "type": "string", "example": "" }, "card_present_percent": { "type": "string", "example": "" }, "card_swiped_percent": { "type": "string", "example": "" }, "chosen_plan": { "type": "string", "example": "" }, "chosen_processing_method": { "type": "string", "example": "" }, "company_type": { "type": "string", "example": "" }, "email": { "type": "string", "example": "" }, "first_name": { "type": "string", "example": "" }, "highest_trans_amount": { "type": "string", "example": "" }, "international": { "type": "string", "example": "" }, "internet": { "type": "string", "example": "" }, "job_title": { "type": "string", "example": "" }, "last_name": { "type": "string", "example": "" }, "location_type": { "type": "string", "example": "" }, "meta": { "type": "object", "properties": { "ownership_percentage": { "type": "integer", "example": 60, "default": 0 }, "owner_citizenship": { "type": "string", "example": "ALA" }, "representatives": { "type": "array", "items": { "type": "object", "properties": { "title": { "type": "string", "example": "" }, "date_of_birth": { "type": "string", "example": "" }, "ssn": { "type": "string", "example": "" }, "first_name": { "type": "string", "example": "" }, "last_name": { "type": "string", "example": "" }, "type": { "type": "string", "example": "" }, "ownership_percentage": { "type": "integer", "example": 40, "default": 0 }, "email": { "type": "string", "example": "" }, "phone": { "type": "string", "example": "" }, "address_1": { "type": "string", "example": "" }, "address_2": { "type": "string", "example": "" }, "address_city": { "type": "string", "example": "" }, "address_state": { "type": "string", "example": "" }, "address_zip": { "type": "string", "example": "" }, "citizenship": { "type": "string", "example": "ALA" } } } } } }, "moto_percent": { "type": "string", "example": "" }, "network": { "type": "string", "example": "" }, "owner_address_1": { "type": "string", "example": "" }, "owner_address_2": { "type": "string", "example": "" }, "owner_address_city": { "type": "string", "example": "" }, "owner_address_country": { "type": "string", "example": "" }, "owner_address_state": { "type": "string", "example": "" }, "owner_address_zip": { "type": "string", "example": "" }, "phone_number": { "type": "string", "example": "" }, "plan": { "type": "string", "example": "" }, "principal_owners_name": { "type": "string", "example": "" }, "reason_for_applying": { "type": "string", "example": "" }, "referred_by": { "type": "string", "example": "" }, "refund_policy": { "type": "string", "example": "" }, "seasonal_flag": { "type": "boolean", "example": false, "default": true }, "seasonal_months": { "type": "string", "example": "" }, "service_you_provide": { "type": "string", "example": "" }, "title": { "type": "string", "example": "" }, "user_dob": { "type": "string", "example": "" }, "merchant_id": { "type": "string", "example": "791fc3fa-4534-4617-97b6-d41c9e1ce8da" }, "user_id": { "type": "string", "example": "a01a5f74-cbdb-4704-9e9b-56fd5a8ee7b8" }, "updated_at": { "type": "string", "example": "2019-06-19 21:22:03" }, "created_at": { "type": "string", "example": "2019-06-19 21:22:03" }, "files": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "69ad5457-c027-4057-ad52-05ef0e39ec39" }, "merchant_id": { "type": "string", "example": "866ccc18-315e-496d-8a49-f16a5da79b75" }, "user_id": { "type": "string", "example": "8f5f7d73-d53c-47c6-8880-6da0de8d9a10" }, "name": { "type": "string", "example": "voidcheck" }, "path": { "type": "string", "example": "onboarding/69ad5457-c027-4057-ad52-05ef0e39ec39.png" }, "public_url": { "type": "string", "example": "https://fattonboardingfiles.s3.us-west-2.amazonaws.com/onboarding/69ad5457-c027-4057-ad52-05ef0e39ec39.png" }, "tag": { "type": "string", "example": "onboarding" }, "meta": { "type": "object", "properties": { "filesize_bytes": { "type": "integer", "example": 2631, "default": 0 }, "filesize": { "type": "string", "example": "0.03 kB" }, "extension": { "type": "string", "example": "png" }, "size": { "type": "object", "properties": { "width": { "type": "integer", "example": 225, "default": 0 }, "height": { "type": "integer", "example": 225, "default": 0 } } }, "mime": { "type": "string", "example": "image/png" } } }, "created_at": { "type": "string", "example": "2020-01-16 18:35:03" }, "updated_at": { "type": "string", "example": "2020-01-16 18:35:04" }, "deleted_at": {} } } }, "electronic_signature": { "type": "object", "properties": { "html_content": { "type": "string", "example": "I agree to..." }, "ip": { "type": "string", "example": "42.1.1.113" }, "timestamp": { "type": "string", "example": "2019-06-19 21:22:03" }, "user_id": { "type": "string", "example": "a01a5f74-cbdb-4704-9e9b-56fd5a8ee7b8" }, "email": { "type": "string", "example": "john@doe.com" }, "browser_agent": { "type": "string", "example": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_6) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/79.0.3945.88 Safari/537.36" } } } } } } } }, "422": { "description": "422", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"annual_volume\": [\n \"The annual volume may not be greater than 100 characters.\"\n ]\n}" } }, "schema": { "type": "object", "properties": { "annual_volume": { "type": "array", "items": { "type": "string", "example": "The annual volume may not be greater than 100 characters." } } } } } } } }, "deprecated": false, "security": [ { "PartnerApiKey": [] } ] } }, "/invoice/schedule/{id}": { "delete": { "summary": "Delete an Invoice Schedule", "description": "Deletes a recurring invoice schedule. This operation requires merchant authentication.", "operationId": "delete-invoice-schedule", "security": [ { "ApiKeyAuth": [] }, { "EphemeralAuth": [] } ], "responses": { "200": { "description": "", "content": { "application/json": { "examples": { "New Example": { "summary": "New Example", "value": { "id": "320c909f-7808-465f-b519-5d906bf615f8", "merchant_id": "f2010d6f-dc3c-40bb-bf13-8646c018ba38", "user_id": "41402d23-92d7-4be2-b3c4-5752ead46632", "active": true, "count": 0, "rule": "FREQ=MONTHLY;INTERVAL=1;DTSTART=20250703T140000Z", "last_run_at": null, "next_run_at": null, "event": "InvoiceGenerator", "payment_method_id": null, "customer_id": "cafe3d35-1128-44bc-bd49-b6587662544f", "created_at": "2025-07-02 18:38:00", "updated_at": "2025-07-02 19:03:38", "deleted_at": "2025-07-02 19:03:38", "last_invoice_status": null, "rule_text": "monthly", "future_occurrences": [], "max": null, "end_at": null, "status": "DELETED", "customer": { "id": "cafe3d35-1128-44bc-bd49-b6587662544f", "firstname": "Ayr", "lastname": "Kartingy", "company": "Testing Company", "email": "", "cc_emails": [], "cc_sms": null, "phone": "5555555555", "address_1": "2555 Adelia Blvd.", "address_2": "", "address_city": "Orlando", "address_state": "", "address_zip": "32725", "address_country": "USA", "notes": "", "reference": "", "options": { "customer_custom_fields": [] }, "created_at": "2025-06-23 18:26:53", "updated_at": "2025-06-23 18:26:53", "deleted_at": null, "allow_invoice_credit_card_payments": true, "gravatar": false, "has_address": true, "missing_address_components": [] }, "files": [], "payment_method": null, "meta": { "isVenmoPaymentEnabled": false, "isCnpDigitalWalletPaymentEnabled": false, "isCCPaymentEnabled": true, "tax": 0, "discountAfterTax": 0, "discountBeforeTax": 0, "surcharge": 0, "isTipEnabled": false, "type": "invoice/schedule", "update_inventory": true, "taxOverride": false, "isBulkInvoice": false, "shippingAmount": 0, "subtotal": 100, "internalMemo": "", "memo": "Test Memo", "lineItems": [ { "id": "generated-id-d36c-54b0-6515-bca5-fc53", "item": "Test Item", "details": "", "quantity": 1, "price": "100.00" } ], "isACHPaymentEnabled": true, "isPaypalPaymentEnabled": false, "isPaypalBnplPaymentEnabled": false }, "channel": "advanced-payment", "url": "https://app.staxpayments.com/#/bill/", "total": 100, "email_notification": true, "is_partial_payment_enabled": true } } } } } } }, "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ] }, "put": { "summary": "Edit an Invoice Schedule", "description": "Update an existing invoice schedule, allowing changes to metadata, recurrence rules, or the schedule's active status.", "operationId": "editInvoiceSchedule", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "The ID of the invoice schedule to update.", "schema": { "type": "string" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "number", "description": "The total amount for the invoice." }, "rule": { "type": "string", "description": "The iCalendar RRule recurrence rule string." }, "active": { "type": "boolean", "description": "Whether the schedule is active. Set to false to pause." }, "email_notification": { "type": "boolean", "description": "Whether to send email notifications when invoices are generated." }, "files": { "type": "array", "description": "Array of file IDs to attach to the schedule.", "items": { "type": "string" } }, "meta": { "type": "object", "description": "Metadata for the invoice, including line items, tax, and other details.", "properties": { "subtotal": { "type": "number", "description": "The subtotal amount before tax and fees." }, "tax": { "type": "number", "description": "The tax amount applied to the invoice." }, "fee": { "type": "number", "description": "An optional fee amount in dollars (not cents).", "minimum": 0 }, "poNumber": { "type": "string", "nullable": true, "description": "An optional purchase order number." }, "shippingAmount": { "type": "number", "description": "The shipping amount for the invoice.", "minimum": 0 }, "hideCustomerLineItems": { "type": "boolean", "nullable": true, "description": "When set to true, line item details are hidden from customer-facing emails and receipts. Line items remain stored on the invoice and are passed to the payment gateway." }, "lineItems": { "type": "array", "description": "Array of line items for the invoice.", "items": { "type": "object", "properties": { "item": { "type": "string", "description": "The name or description of the item." }, "quantity": { "type": "number", "description": "The quantity of the item." }, "price": { "type": "number", "description": "The price per unit of the item." } } } } } } } } } } }, "responses": { "200": { "description": "Schedule successfully updated." }, "400": { "description": "Bad Request - Invalid fields or missing required parameters." }, "422": { "description": "Validation Error - DTSTART or next_run_at is in the past, or invalid field values." }, "500": { "description": "Internal Server Error." } } } }, "/query/statement/v3/disputes": { "get": { "summary": "Disputes", "description": "", "operationId": "disputes", "parameters": [ { "name": "startDate", "in": "query", "required": true, "description": "YYYY-MM-DD", "schema": { "type": "string", "default": "" } }, { "name": "endDate", "in": "query", "required": true, "description": "YYYY-MM-DD", "schema": { "type": "string", "default": "" } } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"data\": [\n {\n \"id\": \"DSredacted-dispute-id\",\n \"date\": \"2024-07-28T02:31:16.000Z\",\n \"type\": \"HOLD\",\n \"dispute_amount\": 99,\n \"fee_amount\": 20\n }\n ],\n \"summary\": {\n \"dispute_amount_total\": -99,\n \"fee_amount_total\": 20\n }\n}" } }, "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "DSredacted-dispute-id" }, "date": { "type": "string", "example": "2024-07-28T02:31:16.000Z" }, "type": { "type": "string", "example": "HOLD" }, "dispute_amount": { "type": "integer", "example": 99, "default": 0 }, "fee_amount": { "type": "integer", "example": 20, "default": 0 } } } }, "summary": { "type": "object", "properties": { "dispute_amount_total": { "type": "integer", "example": -99, "default": 0 }, "fee_amount_total": { "type": "integer", "example": 20, "default": 0 } } } } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "{}" } }, "schema": { "type": "object", "properties": {} } } } } }, "deprecated": false } }, "/transaction/{id}/receipt/email": { "put": { "summary": "E-Mail Transaction Receipt", "description": "Send an email receipt for a specific transaction to the associated customer's email address on file.", "operationId": "e-mail-transaction-receipt", "parameters": [ { "name": "id", "in": "path", "description": "The id of the transaction that should be sent", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "ccEmails": { "type": "array", "description": "List of CC email addresses", "items": { "type": "string" } } } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"id\": \"184ef996-de5e-41a8-b139-4ba595426053\",\n \"invoice_id\": \"2230adc8-a755-4a26-95b5-a54a4b8aa0ad\",\n \"reference_id\": \"\",\n \"recurring_transaction_id\": \"\",\n \"auth_id\": null,\n \"type\": \"charge\",\n \"source\": null,\n \"is_merchant_present\": true,\n \"merchant_id\": \"a61d78cc-cde9-44ac-8a18-30c39be05879\",\n \"user_id\": \"2d089742-6aca-462d-8db3-c2966e1f9e68\",\n \"customer_id\": \"0f553deb-5dbd-4dca-9bef-743c4bc2809f\",\n \"payment_method_id\": \"giftcard\",\n \"is_manual\": true,\n \"success\": true,\n \"message\": null,\n \"meta\": {\n \"update_inventory\": true,\n \"taxOverride\": false,\n \"isBulkInvoice\": false,\n \"taxRate\": 0,\n \"tax\": 0,\n \"subtotal\": 55,\n \"memo\": \"\",\n \"lineItems\": [\n {\n \"id\": \"generated-id-0630-32fe-649d-cf6c-e38b\",\n \"item\": \"\",\n \"details\": \"\",\n \"quantity\": 1,\n \"price\": \"55\"\n }\n ],\n \"reference\": 1872,\n \"check_number\": null,\n \"driver_license\": null,\n \"driver_license_state\": null,\n \"payment_phone\": null,\n \"payment_note\": null\n },\n \"total\": 55,\n \"method\": \"giftcard\",\n \"pre_auth\": false,\n \"is_captured\": 1,\n \"last_four\": null,\n \"interchange_code\": \"\",\n \"interchange_fee\": null,\n \"batch_id\": \"\",\n \"batched_at\": \"2018-10-02 12:30:44\",\n \"emv_response\": \"\",\n \"avs_response\": \"\",\n \"cvv_response\": \"\",\n \"pos_entry\": \"\",\n \"pos_salesperson\": \"\",\n \"receipt_email_at\": \"2018-10-02 16:30:44\",\n \"receipt_sms_at\": \"2018-10-02 14:53:09\",\n \"created_at\": \"2018-07-23 18:21:42\",\n \"updated_at\": \"2018-10-02 16:30:44\",\n \"total_refunded\": 0,\n \"is_refundable\": true,\n \"is_voided\": false,\n \"is_voidable\": true,\n \"currency\": \"USD\",\n \"schedule_id\": null,\n \"child_captures\": [],\n \"parent_auth\": null,\n \"customer\": {\n \"id\": \"0f553deb-5dbd-4dca-9bef-743c4bc2809f\",\n \"firstname\": \"Elizabeth\",\n \"lastname\": \"Jones\",\n \"company\": \"Liz's Lemonade\",\n \"email\": \"contact@example.com\",\n \"cc_emails\": null,\n \"cc_sms\": null,\n \"phone\": \"\",\n \"address_1\": \"\",\n \"address_2\": \"\",\n \"address_city\": \"\",\n \"address_state\": \"\",\n \"address_zip\": \"\",\n \"address_country\": \"\",\n \"notes\": \"\",\n \"reference\": \"\",\n \"options\": null,\n \"created_at\": \"2016-10-09 11:04:35\",\n \"updated_at\": \"2018-08-14 13:09:21\",\n \"deleted_at\": null,\n \"allow_invoice_credit_card_payments\": true,\n \"gravatar\": \"//www.gravatar.com/avatar/45357c125af15b6df8864a71a653bea2\"\n },\n \"child_transactions\": [],\n \"files\": [],\n \"payment_method\": {\n \"id\": \"giftcard\",\n \"customer_id\": \"\",\n \"merchant_id\": \"\",\n \"user_id\": \"\",\n \"nickname\": \"GIFT CARD\",\n \"has_cvv\": 0,\n \"is_default\": 0,\n \"method\": \"giftcard\",\n \"person_name\": null,\n \"card_type\": null,\n \"card_last_four\": null,\n \"card_exp\": null,\n \"bank_name\": null,\n \"bank_type\": null,\n \"bank_holder_type\": null,\n \"address_1\": null,\n \"address_2\": null,\n \"address_city\": null,\n \"address_state\": null,\n \"address_zip\": null,\n \"address_country\": null,\n \"purged_at\": null,\n \"deleted_at\": null,\n \"created_at\": \"2018-06-05 16:45:43\",\n \"updated_at\": \"2018-06-05 16:45:43\",\n \"card_exp_datetime\": [],\n \"is_usable_in_vt\": false,\n \"customer\": {\n \"id\": \"\",\n \"firstname\": \"\",\n \"lastname\": \"\",\n \"company\": \"\",\n \"email\": \"\",\n \"cc_emails\": null,\n \"cc_sms\": null,\n \"phone\": \"\",\n \"address_1\": \"\",\n \"address_2\": \"\",\n \"address_city\": \"\",\n \"address_state\": \"\",\n \"address_zip\": \"\",\n \"address_country\": \"\",\n \"notes\": null,\n \"reference\": \"\",\n \"options\": null,\n \"created_at\": null,\n \"updated_at\": null,\n \"deleted_at\": null,\n \"allow_invoice_credit_card_payments\": true,\n \"gravatar\": false\n }\n },\n \"user\": {\n \"id\": \"2d089742-6aca-462d-8db3-c2966e1f9e68\",\n \"system_admin\": true,\n \"name\": \"Morty Junior\",\n \"email\": \"contact@example.com\",\n \"email_verification_sent_at\": \"2018-09-26 18:24:21\",\n \"email_verified_at\": \"2016-05-11 17:13:33\",\n \"is_api_key\": false,\n \"acknowledgments\": {\n \"signedApplication\": true,\n \"editedOnboardingInformation\": false,\n \"tutorial\": true,\n \"godviewWelcome\": true\n },\n \"created_at\": \"2016-05-18 14:11:46\",\n \"updated_at\": \"2018-09-26 18:24:21\",\n \"deleted_at\": null,\n \"gravatar\": \"//www.gravatar.com/avatar/772cbf95746d7da86789cc3634c46ba8\",\n \"team_admin\": null,\n \"team_enabled\": null,\n \"team_role\": null,\n \"merchant_options\": [],\n \"is_default\": false\n }\n}" } }, "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "184ef996-de5e-41a8-b139-4ba595426053" }, "invoice_id": { "type": "string", "example": "2230adc8-a755-4a26-95b5-a54a4b8aa0ad" }, "reference_id": { "type": "string", "example": "" }, "recurring_transaction_id": { "type": "string", "example": "" }, "auth_id": {}, "type": { "type": "string", "example": "charge" }, "source": {}, "is_merchant_present": { "type": "boolean", "example": true, "default": true }, "merchant_id": { "type": "string", "example": "a61d78cc-cde9-44ac-8a18-30c39be05879" }, "user_id": { "type": "string", "example": "2d089742-6aca-462d-8db3-c2966e1f9e68" }, "customer_id": { "type": "string", "example": "0f553deb-5dbd-4dca-9bef-743c4bc2809f" }, "payment_method_id": { "type": "string", "example": "giftcard" }, "is_manual": { "type": "boolean", "example": true, "default": true }, "success": { "type": "boolean", "example": true, "default": true }, "message": {}, "meta": { "type": "object", "properties": { "update_inventory": { "type": "boolean", "example": true, "default": true }, "taxOverride": { "type": "boolean", "example": false, "default": true }, "isBulkInvoice": { "type": "boolean", "example": false, "default": true }, "taxRate": { "type": "integer", "example": 0, "default": 0 }, "tax": { "type": "integer", "example": 0, "default": 0 }, "subtotal": { "type": "integer", "example": 55, "default": 0 }, "memo": { "type": "string", "example": "" }, "lineItems": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "generated-id-0630-32fe-649d-cf6c-e38b" }, "item": { "type": "string", "example": "" }, "details": { "type": "string", "example": "" }, "quantity": { "type": "integer", "example": 1, "default": 0 }, "price": { "type": "string", "example": "55" } } } }, "reference": { "type": "integer", "example": 1872, "default": 0 }, "check_number": {}, "driver_license": {}, "driver_license_state": {}, "payment_phone": {}, "payment_note": {} } }, "total": { "type": "integer", "example": 55, "default": 0 }, "method": { "type": "string", "example": "giftcard" }, "pre_auth": { "type": "boolean", "example": false, "default": true }, "is_captured": { "type": "integer", "example": 1, "default": 0 }, "last_four": {}, "interchange_code": { "type": "string", "example": "" }, "interchange_fee": {}, "batch_id": { "type": "string", "example": "" }, "batched_at": { "type": "string", "example": "2018-10-02 12:30:44" }, "emv_response": { "type": "string", "example": "" }, "avs_response": { "type": "string", "example": "" }, "cvv_response": { "type": "string", "example": "" }, "pos_entry": { "type": "string", "example": "" }, "pos_salesperson": { "type": "string", "example": "" }, "receipt_email_at": { "type": "string", "example": "2018-10-02 16:30:44" }, "receipt_sms_at": { "type": "string", "example": "2018-10-02 14:53:09" }, "created_at": { "type": "string", "example": "2018-07-23 18:21:42" }, "updated_at": { "type": "string", "example": "2018-10-02 16:30:44" }, "total_refunded": { "type": "integer", "example": 0, "default": 0 }, "is_refundable": { "type": "boolean", "example": true, "default": true }, "is_voided": { "type": "boolean", "example": false, "default": true }, "is_voidable": { "type": "boolean", "example": true, "default": true }, "currency": { "type": "string", "example": "USD" }, "schedule_id": {}, "child_captures": { "type": "array" }, "parent_auth": {}, "customer": { "type": "object", "properties": { "id": { "type": "string", "example": "0f553deb-5dbd-4dca-9bef-743c4bc2809f" }, "firstname": { "type": "string", "example": "Elizabeth" }, "lastname": { "type": "string", "example": "Jones" }, "company": { "type": "string", "example": "Liz's Lemonade" }, "email": { "type": "string", "example": "contact@example.com" }, "cc_emails": {}, "cc_sms": {}, "phone": { "type": "string", "example": "" }, "address_1": { "type": "string", "example": "" }, "address_2": { "type": "string", "example": "" }, "address_city": { "type": "string", "example": "" }, "address_state": { "type": "string", "example": "" }, "address_zip": { "type": "string", "example": "" }, "address_country": { "type": "string", "example": "" }, "notes": { "type": "string", "example": "" }, "reference": { "type": "string", "example": "" }, "options": {}, "created_at": { "type": "string", "example": "2016-10-09 11:04:35" }, "updated_at": { "type": "string", "example": "2018-08-14 13:09:21" }, "deleted_at": {}, "allow_invoice_credit_card_payments": { "type": "boolean", "example": true, "default": true }, "gravatar": { "type": "string", "example": "//www.gravatar.com/avatar/45357c125af15b6df8864a71a653bea2" } } }, "child_transactions": { "type": "array" }, "files": { "type": "array" }, "payment_method": { "type": "object", "properties": { "id": { "type": "string", "example": "giftcard" }, "customer_id": { "type": "string", "example": "" }, "merchant_id": { "type": "string", "example": "" }, "user_id": { "type": "string", "example": "" }, "nickname": { "type": "string", "example": "GIFT CARD" }, "has_cvv": { "type": "integer", "example": 0, "default": 0 }, "is_default": { "type": "integer", "example": 0, "default": 0 }, "method": { "type": "string", "example": "giftcard" }, "person_name": {}, "card_type": {}, "card_last_four": {}, "card_exp": {}, "bank_name": {}, "bank_type": {}, "bank_holder_type": {}, "address_1": {}, "address_2": {}, "address_city": {}, "address_state": {}, "address_zip": {}, "address_country": {}, "purged_at": {}, "deleted_at": {}, "created_at": { "type": "string", "example": "2018-06-05 16:45:43" }, "updated_at": { "type": "string", "example": "2018-06-05 16:45:43" }, "card_exp_datetime": { "type": "array" }, "is_usable_in_vt": { "type": "boolean", "example": false, "default": true }, "customer": { "type": "object", "properties": { "id": { "type": "string", "example": "" }, "firstname": { "type": "string", "example": "" }, "lastname": { "type": "string", "example": "" }, "company": { "type": "string", "example": "" }, "email": { "type": "string", "example": "" }, "cc_emails": {}, "cc_sms": {}, "phone": { "type": "string", "example": "" }, "address_1": { "type": "string", "example": "" }, "address_2": { "type": "string", "example": "" }, "address_city": { "type": "string", "example": "" }, "address_state": { "type": "string", "example": "" }, "address_zip": { "type": "string", "example": "" }, "address_country": { "type": "string", "example": "" }, "notes": {}, "reference": { "type": "string", "example": "" }, "options": {}, "created_at": {}, "updated_at": {}, "deleted_at": {}, "allow_invoice_credit_card_payments": { "type": "boolean", "example": true, "default": true }, "gravatar": { "type": "boolean", "example": false, "default": true } } } } }, "user": { "type": "object", "properties": { "id": { "type": "string", "example": "2d089742-6aca-462d-8db3-c2966e1f9e68" }, "system_admin": { "type": "boolean", "example": true, "default": true }, "name": { "type": "string", "example": "Morty Junior" }, "email": { "type": "string", "example": "contact@example.com" }, "email_verification_sent_at": { "type": "string", "example": "2018-09-26 18:24:21" }, "email_verified_at": { "type": "string", "example": "2016-05-11 17:13:33" }, "is_api_key": { "type": "boolean", "example": false, "default": true }, "acknowledgments": { "type": "object", "properties": { "signedApplication": { "type": "boolean", "example": true, "default": true }, "editedOnboardingInformation": { "type": "boolean", "example": false, "default": true }, "tutorial": { "type": "boolean", "example": true, "default": true }, "godviewWelcome": { "type": "boolean", "example": true, "default": true } } }, "created_at": { "type": "string", "example": "2016-05-18 14:11:46" }, "updated_at": { "type": "string", "example": "2018-09-26 18:24:21" }, "deleted_at": {}, "gravatar": { "type": "string", "example": "//www.gravatar.com/avatar/772cbf95746d7da86789cc3634c46ba8" }, "team_admin": {}, "team_enabled": {}, "team_role": {}, "merchant_options": { "type": "array" }, "is_default": { "type": "boolean", "example": false, "default": true } } } } } } } }, "422": { "description": "422", "content": { "application/json": { "examples": { "Invalid Email": { "value": "{\n \"ccEmails.0\": [\n \"The ccEmails.0 must be a valid email address.\"\n ]\n}" } }, "schema": { "type": "object", "properties": { "ccEmails.0": { "type": "array", "items": { "type": "string", "example": "The ccEmails.0 must be a valid email address." } } } } } } } }, "deprecated": false } }, "/file/{id}": { "put": { "description": "", "operationId": "put_file{id}", "responses": { "200": { "description": "", "content": { "application/json": { "examples": { "OK": { "summary": "OK", "value": { "id": "a66bcfb0-8a41-4ef9-99b3-15fe1846bd36", "merchant_id": "55394e80-826a-4e04-bafa-2e2d615209cf", "user_id": "5aec6f90-69be-48a5-a419-44ff016f364a", "name": "FILENAMEEDIT", "public_url": "https://fattpaydocuments.s3.us-west-2.amazonaws.com/a66bcfb0-8a41-4ef9-99b3-15fe1846bd36.png", "tag": null, "meta": { "filesize_bytes": 139295, "filesize": "139.3 kB", "extension": "png", "size": { "width": 446, "height": 496 }, "mime": "image/png" }, "created_at": "2025-12-01 19:00:08", "updated_at": "2025-12-03 21:30:36", "deleted_at": null } } } } } } }, "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true, "description": "ID of the file to edit." } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of the file." }, "tag": { "type": "string", "description": "Description of the the file, typically a type like thinbnail or product-closeup, etc.)" }, "file": { "type": "string", "format": "binary", "description": "The pathway to the file being uploaded." } } } } } } }, "get": { "description": "", "operationId": "get_file{id}", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "tag": { "type": "string" } } }, "examples": { "OK": { "summary": "OK", "value": { "id": "a66bcfb0-8a41-4ef9-99b3-15fe1846bd36", "merchant_id": "55394e80-826a-4e04-bafa-2e2d615209cf", "user_id": "5aec6f90-69be-48a5-a419-44ff016f364a", "name": "FILENAMEEDIT", "public_url": "https://fattpaydocuments.s3.us-west-2.amazonaws.com/a66bcfb0-8a41-4ef9-99b3-15fe1846bd36.png", "tag": null, "meta": { "filesize_bytes": 139295, "filesize": "139.3 kB", "extension": "png", "size": { "width": 446, "height": 496 }, "mime": "image/png" }, "created_at": "2025-12-01 19:00:08", "updated_at": "2025-12-03 21:30:36", "deleted_at": null } } } } } } }, "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true, "description": "The file ID to retrieve information." } ] } }, "/admin/enroll": { "post": { "summary": "Enroll a Merchant", "description": "Simultaneously create a merchant, registers the merchant, and creates a user record in a single request, associating them together.", "operationId": "enroll-a-merchant", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "skip_account_page": { "type": "boolean", "description": "Set to true to skip the setPassword page for the user when logging in." }, "hide_prefilled_fields": { "type": "boolean", "description": "When a field is pre-populated, it will not be displayed to a merchant. This can declutter the information presented to the merchant to be filled out." }, "registration": { "properties": { "pricing_plan": { "type": "string", "description": "Must be a valid pricing plan for the requesting user's Brand.", "default": "test-pricing" }, "business_email": { "type": "string", "description": "The email for the business." }, "email": { "type": "string", "description": "The principal owner's email." }, "business_legal_name": { "type": "string", "description": "Merchant business legal name. 100 character max." }, "business_dba": { "type": "string", "description": "Merchant business 'Doing Business As' name. Should be same as legal name if no DBA exists." }, "business_website": { "type": "string", "description": "Merchant business website address (include http://). 100 character max." }, "business_phone_number": { "type": "string", "description": "Merchant business phone number. Format: (999) 999-9999, 9999999999, or 999-999-9999." }, "business_fax": { "type": "string", "description": "Merchant fax number. Format: (999) 999-9999, 9999999999, or 999-999-9999." }, "business_address_1": { "type": "string", "description": "Merchant business address line 1. 100 character max." }, "business_address_2": { "type": "string", "description": "Merchant business address line 2. 100 character max." }, "business_address_city": { "type": "string", "description": "Merchant business city." }, "business_address_state": { "type": "string", "description": "Two-letter state abbreviation (e.g., FL)." }, "business_address_zip": { "type": "string", "description": "Merchant business ZIP code." }, "business_address_country": { "type": "string", "description": "Merchant business country. 2 character max." }, "business_open_date": { "type": "string", "description": "Merchant business open date. Format: MM/DD/YYYY." }, "business_tax_id": { "type": "string", "description": "Merchant business tax ID. Format: 12-3456789." }, "company_type": { "type": "string", "description": "Entity type. Values: A (Association/Estate/Trust), G (Government), S (Individual/Sole Proprietor), F (Financial Institution), L (LLC), E (Tax-Exempt 501C), P (Partnership), V (Private Corporation), B (Public Corporation), R (SEC-Registered Entity)." }, "entity_ownership_type": { "type": "string", "description": "Ownership type (e.g., PRIVATE)." }, "first_name": { "type": "string", "description": "Merchant owner/signer first name. 100 character max." }, "last_name": { "type": "string", "description": "Merchant owner/signer last name. 100 character max." }, "title": { "type": "string", "description": "Merchant owner title (e.g., Mr Prez)." }, "job_title": { "type": "string", "description": "Merchant owner job title. Same as title." }, "phone_number": { "type": "string", "description": "Owner/signer phone number. Format: (999) 999-9999." }, "user_dob": { "type": "string", "description": "Owner date of birth. Format: MM/DD/YYYY." }, "user_ssn": { "type": "string", "description": "Primary owner/signer Social Security Number." }, "owner_address_1": { "type": "string", "description": "Owner/signer address line 1." }, "owner_address_2": { "type": "string", "description": "Owner/signer address line 2." }, "owner_address_city": { "type": "string", "description": "Owner/signer city." }, "owner_address_state": { "type": "string", "description": "Owner/signer two-letter state abbreviation." }, "owner_address_zip": { "type": "string", "description": "Owner/signer ZIP/postal code." }, "owner_address_country": { "type": "string", "description": "Owner/signer country (e.g., USA)." }, "principal_owners_name": { "type": "string", "description": "Merchant owner principal first and last name." }, "service_you_provide": { "type": "string", "description": "Description of the merchant's main service or product. 200 character max." }, "annual_volume": { "type": "string", "description": "Merchant annual credit card volume. 100 character max." }, "avg_trans_size": { "type": "string", "description": "Merchant average transaction size." }, "highest_trans_amount": { "type": "string", "description": "Merchant reported highest credit card transaction amount." }, "card_present_percent": { "type": "string", "description": "Percentage of volume where the card is physically present (e.g., terminal transactions)." }, "card_not_present_percent": { "type": "string", "description": "Percentage of volume where the card is not present (e.g., online or keyed-in transactions)." }, "card_swiped_percent": { "type": "string", "description": "Percentage of volume from card-swiped transactions." }, "moto_percent": { "type": "string", "description": "Percentage of volume taken via mail order/telephone order. Typically the same as card_not_present_percent." }, "internet": { "type": "string", "description": "Percentage of volume taken over the internet." }, "b2b_percent": { "type": "string", "description": "Merchant business-to-business volume percentage." }, "international": { "type": "string", "description": "Merchant international volume percentage." }, "refund_policy": { "type": "string", "description": "Merchant refund policy. Values: N (No Refunds), E (Merchandise Exchange Only), T (30 Days or Fewer), O (Other)." }, "bank_routing_number": { "type": "string", "description": "Billing bank routing number." }, "bank_account_number": { "type": "string", "description": "Billing bank account number." }, "bank_account_owner_name": { "type": "string", "description": "Billing bank account owner name." }, "secondary_bank_routing_number": { "type": "string", "description": "Secondary bank routing number." }, "secondary_bank_account_number": { "type": "string", "description": "Secondary bank account number." }, "secondary_bank_account_purpose": { "type": "string", "description": "Purpose of the secondary bank account (e.g., fees)." }, "chosen_processing_method": { "type": "string", "description": "How the merchant will process payments (e.g., api)." }, "underwriting_status": { "type": "string", "description": "Underwriting status to set (e.g., APPROVED)." }, "field_permissions": { "type": "string", "description": "JSON object that manually controls field permissions." }, "amex_direct_number": { "type": "integer", "description": "If you have over a million in AMEX sales, AMEX will have provided a 10-digit direct number." }, "amex_annual_volume": { "type": "string", "default": "", "description": "The predicted annual gross sales of AMEX cards." }, "electronic_signature": { "type": "string" }, "credit_inquiry_electronic_signature": { "type": "string" }, "application_agreed_at": { "type": "string" }, "countersigned_at": { "type": "string" }, "signature_status": { "type": "string" }, "meta": { "type": "array", "items": { "properties": { "owner_citizenship": { "type": "string", "description": "3 character ISO country code for company representative, eg. ALA." }, "ownership_percentage": { "type": "string", "description": "The ownership percentage for primary owner, eg. 50." }, "representatives": { "type": "array", "items": { "properties": { "title": { "type": "string", "description": "Position within the organization." }, "first_name": { "type": "string", "description": "Name of representative." }, "last_name": { "type": "string", "description": "Surname of representative." }, "email": { "type": "string", "description": "Representative email." }, "ownership_percentage": { "type": "string", "description": "Ownership percentage for company representatives, eg. 50" }, "phone": { "type": "string", "description": "Representative phone number." }, "address_1": { "type": "string" }, "address_2": { "type": "string" }, "address_city": { "type": "string" }, "address_state": { "type": "string", "description": "State (two letter) (ex. FL)." }, "address_zip": { "type": "string" }, "citizenship": { "type": "string", "description": "3 character ISO country code for company representative, eg. ALA." }, "ssn": { "type": "string", "description": "Representative social security number." }, "type": { "type": "string", "enum": [ "Beneficial Owner", "Guarantor" ], "description": "Type of owner." } }, "type": "object" }, "description": "Any additional representatives (required for any owner/representative with 25% or more ownership)." } }, "type": "object" } } }, "required": [ "pricing_plan", "business_email", "email" ], "type": "object" }, "user": { "properties": { "email": { "type": "string", "description": "Provide the user's email if they exist; all other details will be ignored. For best practice, provide the rest of the details to ensure user creation. User.email must not be a Stax Connect level user." }, "name": { "type": "string", "description": "User's full name. This is required for new users." }, "password": { "type": "string", "description": "(required for new user)." }, "password_confirmation": { "type": "string", "description": "(required for new user)." } }, "required": [ "email" ], "type": "object" }, "merchant": { "properties": { "plan": { "type": "string", "description": "The plan which sets Stax Pay configuration.", "default": "premium" }, "company_name": { "type": "string", "description": "Name of the company." }, "contact_email": { "type": "string", "description": "Email for communication." }, "hosted_payments_token": { "type": "string", "description": "Each merchant record has a unique identifier for StaxJs. If not specified, one is autogenerated with the company name and a random string." } }, "required": [ "plan", "company_name", "contact_email" ], "type": "object" } } }, "examples": { "Example Request": { "summary": "Example Request", "value": "{\n \"skip_account_page\": true,\n \"merchant\": {\n \"plan\":\"premium\",\n \"company_name\": \"Stax\",\n \"contact_name\": \"James Holden\",\n \"contact_email\": \"James.Holden@example.com\",\n \"contact_phone\": \"4035551234\",\n \"address_1\": \"25 Wall Street\",\n \"address_2\": \"Suite 1\",\n \"address_city\": \"Orlando\",\n \"address_state\": \"FL\",\n \"address_zip\": \"32801\",\n \"hosted_payments_token\": \"Stax-c3073a83d4a2\",\n \"currency\": [\"USD\"],\n \"status\": \"PENDING\",\n },\n \"registration\": {\n \"pricing_plan\": \"test-pricing\",\n \"underwriting_status\": \"APPROVED\",\n \"first_name\": \"Post\",\n \"last_name\": \"Man\",\n \"email\": \"postman@example.com\",\n \"title\": \"Mr Prez\",\n \"company_type\": \"A\",\n \"entity_ownership_type\": \"PRIVATE\",\n \"business_phone_number\": \"5555555555\",\n \"business_legal_name\": \"Consulting by Post\",\n \"business_dba\": \"Post's Consulting\",\n \"business_website\": \"https://example.com/\",\n \"business_fax\": \"5555555555\",\n \"business_email\": \"postman@example.com\",\n \"owner_address_1\": \"618 E South St\",\n \"owner_address_2\": \"Suite 510\",\n \"owner_address_city\": \"Orlando\",\n \"owner_address_state\": \"\",\n \"owner_address_zip\": \"55555\",\n \"owner_address_country\": \"USA\",\n \"meta\": {\n \"ownership_percentage\": \"100\",\n \"owner_citizenship\":\"ALA\",\n \"representatives\": [\n {\n \"title\": \"king supreme ceo\",\n \"first_name\": \"David\",\n \"last_name\": \"Sandra\",\n \"email\": \"davesandra344@gmail.com\",\n \"ownership_percentage\": \"40\",\n \"phone\": \"5555555555\",\n \"address_1\": \"100 S Orange Ave\",\n \"address_2\": \"Suite 400\",\n \"address_city\": \"Orlando\",\n \"address_state\": \"CA\",\n \"address_zip\": \"55555\",\n \"citizenship\":\"ALB\",\n \"ssn\": \"123445666\",\n \"type\": \"Beneficial Owner\"\n }\n ]\n },\n \"business_tax_id\": \"123456789\",\n \"business_open_date\": \"12/25/2020\",\n \"job_title\": \"Mr Prez\",\n \"service_you_provide\": \"consulting services\",\n \"annual_volume\": \"1000\",\n \"highest_trans_amount\": \"100000\",\n \"card_not_present_percent\": \"100\",\n \"bank_routing_number\": \"021000021\",\n \"bank_account_number\": \"9876543210\",\n \"bank_account_owner_name\": \"Post Man\",\n \"secondary_bank_routing_number\": \"021000021\",\n \"secondary_bank_account_number\": \"9876543210\",\n \"secondary_bank_account_purpose\": \"fees\",\n \"principal_owners_name\": \"Post Man\",\n \"chosen_processing_method\": \"api\"\n },\n \"user\": {\n \"name\": \"James Holden\",\n \"email\": \"James.Holden@example.com\",\n \"team_role\": \"staff\",\n \"team_enabled\": true,\n \"password\": \"YesYouNeedToProvideThisAndAConfirmationToCreateAUser\",\n \"password_confirmation\": \"YesYouNeedToProvideThisAndAConfirmationToCreateAUser\"\n }\n}" } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": { "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJnb2RVc2VyIjpudWxsLCJtZXJjaGFudCI6IjdmZTk3ZTBmLTJlN2EtNDgxNy04NzJiLTZlYjg2ZWVhODQyYyIsInN1YiI6IjQwZmU4YTUyLWZiNzEtNGJlYy04OZZZZZZZZZZGMxOGE1MCIsImJyYW5kIjoiZmF0dG1lcmNoYW50ZZZZZZZZZZZZZZbGwiLCJpYXQiOjE2MzA2NzQ1NzUsImV4cCI6MTYzMTAyMDE3NSwibmJmIjoxNjMwNjc0NTc1LCJqdGkiOiJHclA2RTd5ZFlRTDdUS04yIiwiYXNzdW1pbmciOmZhbHNlfQ.zKFWYDSoUajuVq-n-7dlDwjAXvC44weYDBk8Y2C1qn8", "user": { "id": "40fe8a52-fb71-4bec-89b3-a48f1dc18a50", "system_admin": false, "name": "James Holden", "email": "James.Holden@example.com", "email_verification_sent_at": null, "email_verified_at": null, "created_at": "2021-09-03 13:09:34", "updated_at": "2021-09-03 13:09:34", "is_default": false, "is_api_key": false, "deleted_at": null, "gravatar": "//www.gravatar.com/avatar/3bb87cb08d869fcf9a21748861bcec08", "team_role": "admin", "team_admin": true, "team_enabled": true, "merchant_options": [], "acknowledgments": { "setPassword": true }, "options": null, "brand": "fattmerchant" }, "merchant": { "id": "7fe97e0f-2e7a-4817-872b-6eb86eea842c", "mid": "", "status": "PENDING", "subdomain": "", "company_name": "Stax", "display_name": "Fattmerchant", "contact_name": "Fattmerchant", "contact_email": "info2@fattmerchant.com", "contact_phone": "8555503288", "address_1": "25 Wall Street", "address_2": "Suite 1", "address_city": "Orlando", "address_state": "FL", "address_zip": "32801", "hosted_payments_token": "Fattmerchant-c3073a83d4a2", "currency": [ "USD" ], "plan": { "id": "42392492-ee45-41ea-8c43-a40a41ab1ba2", "merchant_id": "7fe97e0f-2e7a-4817-872b-6eb86eea842c", "user_id": "40fe8a52-fb71-4bec-89b3-a48f1dc18a50", "name": "test", "created_at": "2021-09-03 13:09:34", "updated_at": "2021-09-03 13:09:34" }, "options": null, "gateway_type": null, "processor": "", "partner": null, "product_type": "Other", "is_enterprise": false, "is_payfac": true, "is_sandbox": false, "is_test_mode": 0, "fm_billing_schedule_id": null, "fee_reconciliation_payment_method_id": null, "welcome_email_sent_at": null, "created_at": "2021-09-03 13:09:34", "updated_at": "2021-09-03 13:09:34", "deleted_at": null, "brand": "fattmerchant", "risk_hold": false, "branding": null, "allow_ach": false, "is_portal": false, "is_flat_rate": true, "allow_credits": false, "allow_terminal": false, "gateways": [], "is_surcharge_enabled": false, "is_trust": false, "underwriting_status": null, "underwriting_substatuses": null, "allow_cnp_digital_wallet": false, "registration": { "merchant_id": "7fe97e0f-2e7a-4817-872b-6eb86eea842c", "user_id": "40fe8a52-fb71-4bec-89b3-a48f1dc18a50", "electronic_signature": null, "credit_inquiry_electronic_signature": null, "application_agreed_at": null, "countersigned_at": null, "signature_status": null, "application_status": null, "underwriting_status": null, "underwriting_substatuses": null, "underwriting_note": null, "meta": { "owner_citizenship": "ALA", "ownership_percentage": "40", "representatives": [ { "title": "king supreme ceo", "first_name": "David", "last_name": "Sandra", "email": "davesandra344@gmail.com", "ownership_percentage": "40", "phone": "5555555555", "address_1": "100 S Orange Ave", "address_2": "Suite 400", "address_city": "Orlando", "address_state": "CA", "address_zip": "55555", "citizenship": "ALB", "ssn": "123445666", "type": "Beneficial Owner" } ] }, "first_name": null, "last_name": null, "email": null, "title": null, "company_type": null, "entity_ownership_type": "PRIVATE", "phone_number": null, "source": null, "promo_code": null, "ref_code": null, "plan": null, "fm_pc_name": null, "business_legal_name": "Consulting by Post", "business_dba": null, "business_website": null, "business_fax": null, "business_email": null, "business_address_1": null, "business_address_2": null, "business_address_city": null, "business_address_state": null, "business_address_zip": null, "business_address_country": null, "owner_address_1": "", "owner_address_2": "", "owner_address_city": "", "owner_address_state": "", "owner_address_zip": "", "owner_address_country": "", "user_ip": null, "user_ssn": null, "user_dob": null, "business_phone_number": null, "business_tax_id": null, "business_open_date": null, "job_title": null, "refund_policy": null, "reason_for_applying": null, "service_you_provide": null, "annual_volume": null, "avg_trans_size": null, "highest_trans_amount": null, "card_present_percent": null, "card_not_present_percent": null, "card_swiped_percent": null, "moto_percent": null, "b2b_percent": null, "bank_routing_number": null, "bank_account_number": null, "bank_account_owner_name": null, "secondary_bank_routing_number": null, "secondary_bank_account_number": null, "secondary_bank_account_owner_name": null, "secondary_bank_account_type": null, "secondary_bank_account_purpose": null, "principal_owners_name": null, "chosen_plan": null, "chosen_processing_method": null, "plan_txamnt": ".15", "plan_dcamnt": "2.99", "plan_ach_cap": "9999", "plan_ach_txamnt": "0", "plan_ach_dcamnt": "1.00", "plan_nabu": null, "referred_by": null, "created_at": "2021-09-03 13:09:34", "updated_at": "2021-09-03 13:09:35", "deleted_at": null, "paper_statement": false, "num_of_locs": "", "addl_loc": false, "addl_loc_main_mid": "", "internet": "", "international": "", "mcc": "", "proc_change": "", "seasonal_flag": false, "seasonal_months": "", "bus_type": "", "sub_bus_type": "", "special_proc": "", "pos_software_publisher": "", "pos_software_name": "", "pos_software_version": "", "site_inspection": "", "location_type": "", "network": "", "bank_account_type": "", "mcc_addl_desc": "", "business_location_address_1": null, "business_location_address_2": null, "business_location_address_city": null, "business_location_address_country": null, "business_location_address_state": null, "business_location_address_zip": null, "business_location_email": null, "business_location_fax": null, "business_location_phone_number": null, "note": null, "credit_qual_disc_rate": "2.99", "credit_qual_trans_fee": ".15", "credit_mid_disc_rate": "2.99", "credit_mid_trans_fee": ".15", "credit_non_disc_rate": "2.99", "credit_non_trans_fee": ".15", "amex_qual_disc_rate": "3.5", "amex_qual_trans_fee": ".15", "amex_mid_disc_rate": "3.5", "amex_mid_trans_fee": ".15", "amex_non_disc_rate": "3.5", "amex_non_trans_fee": ".15", "is_flat_rate": true, "pricing_plan": "finix", "finix_merchant_id": "", "finix_identity_id": "", "annual_gross_ach_revenue": null, "avg_ach_transaction": null, "largest_ach_transaction": null, "cp_transaction_rate": "2.99", "cp_per_item_rate": ".15", "cp_amex_rate": "3.5", "cp_amex_per_item_rate": ".15", "warnings": null, "merchant_autoverification_authorization": null, "chargeback_percent": null, "annual_gross_shopping_cart_revenue": null, "avg_shopping_cart_transaction": null, "largest_shopping_cart_transaction": null, "shopping_cart_card_present_percent": null, "shopping_cart_b2b_percent": null, "shopping_cart_international": null, "cp_credit_surcharge_rate": null, "cnp_credit_surcharge_rate": null, "cp_debit_trans_fee": null, "cnp_debit_trans_fee": null, "cp_debit_discount_rate": null, "cnp_debit_discount_rate": null, "files": [], "brand": "fattmerchant", "underwriting_substatus": null, "empty_required_fields": [ "business_dba", "business_address_1", "business_address_city", "business_address_state", "business_address_zip", "business_tax_id", "business_open_date", "service_you_provide", "annual_volume", "avg_trans_size", "highest_trans_amount", "card_present_percent", "b2b_percent", "international", "refund_policy", "bank_account_owner_name", "bank_routing_number", "bank_account_number", "title", "user_dob", "user_ssn", "first_name", "last_name", "email", "phone_number", "owner_address_1", "owner_address_city", "owner_address_state", "owner_address_zip" ], "latest_file_uploaded_at": null } }, "registration": { "business_legal_name": "Consulting by Post", "pricing_plan": "test-pricing", "user_id": "40fe8a52-fb71-4bec-89b3-a48f1dc18a50", "merchant_id": "7fe97e0f-2e7a-4817-872b-6eb86eea842c", "updated_at": "2021-09-03 13:09:35", "created_at": "2021-09-03 13:09:34", "plan_txamnt": ".15", "cp_per_item_rate": ".15", "credit_mid_trans_fee": ".15", "credit_non_trans_fee": ".15", "credit_qual_trans_fee": ".15", "amex_qual_trans_fee": ".15", "amex_mid_trans_fee": ".15", "amex_non_trans_fee": ".15", "cp_amex_per_item_rate": ".15", "plan_ach_txamnt": "0", "plan_ach_cap": "9999", "plan_dcamnt": "2.99", "cp_transaction_rate": "2.99", "credit_qual_disc_rate": "2.99", "credit_mid_disc_rate": "2.99", "credit_non_disc_rate": "2.99", "cp_amex_rate": "3.5", "amex_qual_disc_rate": "3.5", "amex_mid_disc_rate": "3.5", "amex_non_disc_rate": "3.5", "plan_ach_dcamnt": "1.00", "is_flat_rate": true, "cp_credit_surcharge_rate": null, "cnp_credit_surcharge_rate": null, "cp_debit_trans_fee": null, "cnp_debit_trans_fee": null, "cp_debit_discount_rate": null, "cnp_debit_discount_rate": null, "files": [], "brand": "fattmerchant", "underwriting_substatus": null, "empty_required_fields": [ "business_dba", "business_address_1", "business_address_city", "business_address_state", "business_address_zip", "business_tax_id", "business_open_date", "service_you_provide", "annual_volume", "avg_trans_size", "highest_trans_amount", "card_present_percent", "b2b_percent", "international", "refund_policy", "bank_account_owner_name", "bank_routing_number", "bank_account_number", "title", "user_dob", "user_ssn", "first_name", "last_name", "email", "phone_number", "owner_address_1", "owner_address_city", "owner_address_state", "owner_address_zip" ], "latest_file_uploaded_at": null, "merchant": { "id": "7fe97e0f-2e7a-4817-872b-6eb86eea842c", "mid": "", "status": "PENDING", "subdomain": "", "company_name": "Fattmerchant", "display_name": "Fattmerchant", "contact_name": "Fattmerchant", "contact_email": "info2@fattmerchant.com", "contact_phone": "8555503288", "address_1": "25 Wall Street", "address_2": "Suite 1", "address_city": "Orlando", "address_state": "FL", "address_zip": "32801", "hosted_payments_token": "Fattmerchant-c3073a83d4a2", "currency": [ "USD" ], "plan": { "id": "42392492-ee45-41ea-8c43-a40a41ab1ba2", "merchant_id": "7fe97e0f-2e7a-4817-872b-6eb86eea842c", "user_id": "40fe8a52-fb71-4bec-89b3-a48f1dc18a50", "name": "test", "created_at": "2021-09-03 13:09:34", "updated_at": "2021-09-03 13:09:34" }, "options": null, "notes": "", "gateway_type": null, "vendor_keys": null, "processor": "", "partner": null, "product_type": "Other", "is_enterprise": false, "is_payfac": true, "is_sandbox": false, "is_test_mode": 0, "fm_billing_schedule_id": null, "fee_reconciliation_payment_method_id": null, "welcome_email_sent_at": null, "created_at": "2021-09-03 13:09:34", "updated_at": "2021-09-03 13:09:34", "deleted_at": null, "brand": "fattmerchant", "risk_hold": false, "branding": null, "allow_ach": false, "is_portal": false, "is_flat_rate": true, "allow_credits": false, "allow_terminal": false, "gateways": [], "is_surcharge_enabled": false, "is_trust": false, "underwriting_status": null, "underwriting_substatuses": null, "allow_cnp_digital_wallet": false }, "user": { "id": "40fe8a52-fb71-4bec-89b3-a48f1dc18a50", "system_admin": false, "name": "James Holden", "email": "James.Holden@example.com", "email_verification_sent_at": null, "email_verified_at": null, "is_api_key": false, "options": null, "acknowledgments": { "setPassword": true }, "created_at": "2021-09-03 13:09:34", "updated_at": "2021-09-03 13:09:34", "deleted_at": null, "brand": "fattmerchant", "gravatar": "//www.gravatar.com/avatar/3bb87cb08d869fcf9a21748861bcec08", "team_admin": null, "team_enabled": null, "team_role": null, "merchant_options": [], "is_default": false, "brands": [ "fattmerchant" ] } }, "message": "User James.Holden@example.com created, linked to merchant 7fe97e0f-2e7a-4817-872b-6eb86eea842c" } } }, "schema": { "type": "object", "properties": { "token": { "type": "string", "example": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJnb2RVc2VyIjpudWxsLCJtZXJjaGFudCI6IjdmZTk3ZTBmLTJlN2EtNDgxNy04NzJiLTZlYjg2ZWVhODQyYyIsInN1YiI6IjQwZmU4YTUyLWZiNzEtNGJlYy04OZZZZZZZZZZGMxOGE1MCIsImJyYW5kIjoiZmF0dG1lcmNoYW50ZZZZZZZZZZZZZZbGwiLCJpYXQiOjE2MzA2NzQ1NzUsImV4cCI6MTYzMTAyMDE3NSwibmJmIjoxNjMwNjc0NTc1LCJqdGkiOiJHclA2RTd5ZFlRTDdUS04yIiwiYXNzdW1pbmciOmZhbHNlfQ.zKFWYDSoUajuVq-n-7dlDwjAXvC44weYDBk8Y2C1qn8" }, "user": { "type": "object", "properties": { "id": { "type": "string", "example": "40fe8a52-fb71-4bec-89b3-a48f1dc18a50" }, "system_admin": { "type": "boolean", "example": false, "default": true }, "name": { "type": "string", "example": "James Holden" }, "email": { "type": "string", "example": "James.Holden@example.com" } } }, "merchant": { "type": "object", "properties": { "id": { "type": "string", "example": "7fe97e0f-2e7a-4817-872b-6eb86eea842c" }, "status": { "type": "string", "example": "PENDING" }, "company_name": { "type": "string", "example": "Stax" } } }, "registration": { "type": "object", "properties": { "business_legal_name": { "type": "string", "example": "Consulting by Post" }, "pricing_plan": { "type": "string", "example": "test-pricing" }, "user_id": { "type": "string", "example": "40fe8a52-fb71-4bec-89b3-a48f1dc18a50" }, "merchant_id": { "type": "string", "example": "7fe97e0f-2e7a-4817-872b-6eb86eea842c" } } }, "message": { "type": "string", "example": "User James.Holden@example.com created, linked to merchant 7fe97e0f-2e7a-4817-872b-6eb86eea842c" } } } } } }, "422": { "description": "422", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"merchant.company_name\": [\n \"The merchant.company name field is required when registration.business legal name is not present.\"\n ],\n \"merchant.contact_email\": [\n \"The merchant.contact email field is required.\"\n ],\n \"merchant.plan\": [\n \"The merchant.plan field is required.\"\n ],\n \"user.name\": [\n \"The user.name field is required.\"\n ],\n \"user.password\": [\n \"The user.password field is required.\"\n ],\n \"user.email\": [\n \"The user.email field is required.\"\n ],\n \"user.brand\": [\n \"Existing user brand must match api key brand\"\n ],\n \"registration.business_legal_name\": [\n \"The registration.business legal name field is required when merchant.company name is not present.\"\n ],\n \"registration.pricing_plan\": [\n \"The registration.pricing plan field is required.\"\n ],\n \"errors\": [\n \"You do not have permission to request tokens for other users.\"\n ]\n }" } } } } } }, "security": [ { "PartnerApiKey": [] } ] } }, "/ephemeral": { "get": { "summary": "Ephemeral Authentication Tokens", "description": "This endpoint accepts a request made with an API Key in the Authorization header and issues an ephemeral authentication token (expiring in 24 hours) in response.", "operationId": "ephemeral-authentication-tokens-1", "parameters": [ { "name": "user_id", "in": "query", "description": "Provide the Stax User ID for whom the ephemeral token should be issued. Leave blank to issue the token for the API Key in the Authorization header.", "schema": { "type": "string" } }, { "name": "user_email", "in": "query", "description": "Provide the URL-encoded email of the Stax User for whom the ephemeral token should be issued. Leave blank to issue the token for the API Key in the Authorization header.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "[\n \"token\": \"emphemeralJWTString\"\n]" } } } } }, "422": { "description": "422", "content": { "application/json": { "examples": { "Invalid API Key": { "value": "{\n \"is_api_key\": [\n \"The bearer token must be an api key\"\n ]\n}" } }, "schema": { "type": "object", "properties": { "is_api_key": { "type": "array", "items": { "type": "string", "example": "The bearer token must be an api key" } } } } } } } }, "deprecated": false } }, "/file/{tag}": { "get": { "description": "", "operationId": "get_file{tag}", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "tag": { "type": "string" } } }, "examples": { "OK": { "summary": "OK", "value": "{ \"generic\",\n \"itemThumbnail\",\n null\n)" } } } } } }, "parameters": [ { "in": "path", "name": "tag", "schema": { "type": "string" }, "required": true, "description": "The tag of the file to retrieve." } ] } }, "/query/payment-links/{id}/is-active": { "get": { "summary": "Get A Payment Link's Active Status", "description": "Check whether a payment link is active or inactive without retrieving full details.", "operationId": "get-a-payment-links-active-status", "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{}" } }, "schema": { "type": "object", "properties": {} } } } } }, "deprecated": false } }, "/transaction/{id}/related": { "get": { "summary": "Get a Related Transaction", "description": "Retrieve a child transactions associated with a parent transaction.", "operationId": "get-a-related-transaction", "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "[\n {\n \"id\": \"3872e334-bba1-4bbd-91fc-bb3f48c74b1a\",\n \"invoice_id\": \"\",\n \"reference_id\": \"890eda03-0cb5-4c51-813d-8f1959d1a591\",\n \"recurring_transaction_id\": \"\",\n \"type\": \"refund\",\n \"source\": null,\n \"merchant_id\": \"dd36b936-1eb7-4ece-bebc-b514c6a36ebd\",\n \"user_id\": \"b58d7eee-e68d-4d12-a1f8-62f5e71382ae\",\n \"customer_id\": \"50d14fcb-b468-4ac4-afd8-d7c47172dc1c\",\n \"payment_method_id\": \"23c06bc1-7473-46fb-8d65-b8e9bde1fe75\",\n \"is_manual\": null,\n \"success\": true,\n \"message\": null,\n \"meta\": {\n \"tax\": 0,\n \"subtotal\": 2,\n \"lineItems\": [\n {\n \"id\": \"optional-fm-catalog-item-id\",\n \"item\": \"Demo Item\",\n \"details\": \"this is a regular demo item\",\n \"quantity\": 1,\n \"price\": 22\n }\n ]\n },\n \"total\": 22,\n \"method\": \"card\",\n \"pre_auth\": false,\n \"last_four\": \"1111\",\n \"receipt_email_at\": null,\n \"receipt_sms_at\": null,\n \"created_at\": \"2017-03-29 16:15:43\",\n \"updated_at\": \"2017-03-29 16:15:43\",\n \"total_refunded\": null,\n \"is_refundable\": false,\n \"is_voided\": null,\n \"is_voidable\": false,\n \"schedule_id\": null,\n \"customer\": {\n \"id\": \"50d14fcb-b468-4ac4-afd8-d7c47172dc1c\",\n \"firstname\": \"Mario\",\n \"lastname\": \"Henderson\",\n \"company\": \"\",\n \"email\": \"fatttest737@gmail.com\",\n \"cc_emails\": null,\n \"phone\": \"5555555555\",\n \"address_1\": \"123 S ST.\",\n \"address_2\": \"\",\n \"address_city\": \"Orlando\",\n \"address_state\": \"FL\",\n \"address_zip\": \"3222\",\n \"address_country\": \"USA\",\n \"notes\": \"\",\n \"reference\": \"\",\n \"options\": \"\",\n \"created_at\": \"2017-01-30 20:41:23\",\n \"updated_at\": \"2017-01-30 20:41:23\",\n \"deleted_at\": null,\n \"gravatar\": \"//www.gravatar.com/avatar/52b3ef2ae70945ce0fca14086443dc1a\"\n },\n \"child_transactions\": [],\n \"files\": [],\n \"payment_method\": {\n \"id\": \"23c06bc1-7473-46fb-8d65-b8e9bde1fe75\",\n \"customer_id\": \"50d14fcb-b468-4ac4-afd8-d7c47172dc1c\",\n \"merchant_id\": \"dd36b936-1eb7-4ece-bebc-b514c6a36ebd\",\n \"user_id\": \"41e60252-4f23-48de-a64f-e5a1e8a9359c\",\n \"nickname\": \"VISA: Mario Mario (ending in: 1111)\",\n \"is_default\": 0,\n \"method\": \"card\",\n \"person_name\": \"Mario Henderson\",\n \"card_type\": \"visa\",\n \"card_last_four\": \"1111\",\n \"card_exp\": \"022020\",\n \"bank_name\": null,\n \"bank_type\": null,\n \"bank_holder_type\": null,\n \"address_1\": null,\n \"address_2\": null,\n \"address_city\": null,\n \"address_state\": null,\n \"address_zip\": null,\n \"address_country\": \"USA\",\n \"purged_at\": null,\n \"deleted_at\": null,\n \"created_at\": \"2017-01-30 20:48:13\",\n \"updated_at\": \"2017-01-30 20:48:13\",\n \"card_exp_datetime\": \"2020-02-29 23:59:59\",\n \"customer\": {\n \"id\": \"50d14fcb-b468-4ac4-afd8-d7c47172dc1c\",\n \"firstname\": \"Mario\",\n \"lastname\": \"Henderson\",\n \"company\": \"\",\n \"email\": \"fatttest737@gmail.com\",\n \"cc_emails\": null,\n \"phone\": \"5555555555\",\n \"address_1\": \"123 S ST.\",\n \"address_2\": \"\",\n \"address_city\": \"Orlando\",\n \"address_state\": \"FL\",\n \"address_zip\": \"3222\",\n \"address_country\": \"USA\",\n \"notes\": \"\",\n \"reference\": \"\",\n \"options\": \"\",\n \"created_at\": \"2017-01-30 20:41:23\",\n \"updated_at\": \"2017-01-30 20:41:23\",\n \"deleted_at\": null,\n \"gravatar\": \"//www.gravatar.com/avatar/52b3ef2ae70945ce0fca14086443dc1a\"\n }\n },\n \"user\": {\n \"id\": \"b58d7eee-e68d-4d12-a1f8-62f5e71382ae\",\n \"system_admin\": true,\n \"name\": \"Demo Mann\",\n \"email\": \"contact@example.com\",\n \"email_verification_sent_at\": \"2017-05-15 16:30:23\",\n \"email_verified_at\": \"2017-03-29 15:27:21\",\n \"is_api_key\": false,\n \"created_at\": \"2017-01-11 21:44:02\",\n \"updated_at\": \"2017-05-15 16:30:23\",\n \"deleted_at\": null,\n \"gravatar\": \"//www.gravatar.com/avatar/157965dea7cd2f44e349382d1d791650\",\n \"team_admin\": null,\n \"team_enabled\": null,\n \"team_role\": null,\n \"merchant_options\": [],\n \"is_portal\": false\n }\n }\n]" } }, "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "3872e334-bba1-4bbd-91fc-bb3f48c74b1a" }, "invoice_id": { "type": "string", "example": "" }, "reference_id": { "type": "string", "example": "890eda03-0cb5-4c51-813d-8f1959d1a591" }, "recurring_transaction_id": { "type": "string", "example": "" }, "type": { "type": "string", "example": "refund" }, "source": {}, "merchant_id": { "type": "string", "example": "dd36b936-1eb7-4ece-bebc-b514c6a36ebd" }, "user_id": { "type": "string", "example": "b58d7eee-e68d-4d12-a1f8-62f5e71382ae" }, "customer_id": { "type": "string", "example": "50d14fcb-b468-4ac4-afd8-d7c47172dc1c" }, "payment_method_id": { "type": "string", "example": "23c06bc1-7473-46fb-8d65-b8e9bde1fe75" }, "is_manual": {}, "success": { "type": "boolean", "example": true, "default": true }, "message": {}, "meta": { "type": "object", "properties": { "tax": { "type": "integer", "example": 0, "default": 0 }, "subtotal": { "type": "integer", "example": 2, "default": 0 }, "lineItems": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "optional-fm-catalog-item-id" }, "item": { "type": "string", "example": "Demo Item" }, "details": { "type": "string", "example": "this is a regular demo item" }, "quantity": { "type": "integer", "example": 1, "default": 0 }, "price": { "type": "integer", "example": 22, "default": 0 } } } } } }, "total": { "type": "integer", "example": 22, "default": 0 }, "method": { "type": "string", "example": "card" }, "pre_auth": { "type": "boolean", "example": false, "default": true }, "last_four": { "type": "string", "example": "1111" }, "receipt_email_at": {}, "receipt_sms_at": {}, "created_at": { "type": "string", "example": "2017-03-29 16:15:43" }, "updated_at": { "type": "string", "example": "2017-03-29 16:15:43" }, "total_refunded": {}, "is_refundable": { "type": "boolean", "example": false, "default": true }, "is_voided": {}, "is_voidable": { "type": "boolean", "example": false, "default": true }, "schedule_id": {}, "customer": { "type": "object", "properties": { "id": { "type": "string", "example": "50d14fcb-b468-4ac4-afd8-d7c47172dc1c" }, "firstname": { "type": "string", "example": "Mario" }, "lastname": { "type": "string", "example": "Henderson" }, "company": { "type": "string", "example": "" }, "email": { "type": "string", "example": "fatttest737@gmail.com" }, "cc_emails": {}, "phone": { "type": "string", "example": "5555555555" }, "address_1": { "type": "string", "example": "123 S ST." }, "address_2": { "type": "string", "example": "" }, "address_city": { "type": "string", "example": "Orlando" }, "address_state": { "type": "string", "example": "FL" }, "address_zip": { "type": "string", "example": "3222" }, "address_country": { "type": "string", "example": "USA" }, "notes": { "type": "string", "example": "" }, "reference": { "type": "string", "example": "" }, "options": { "type": "string", "example": "" }, "created_at": { "type": "string", "example": "2017-01-30 20:41:23" }, "updated_at": { "type": "string", "example": "2017-01-30 20:41:23" }, "deleted_at": {}, "gravatar": { "type": "string", "example": "//www.gravatar.com/avatar/52b3ef2ae70945ce0fca14086443dc1a" } } }, "child_transactions": { "type": "array" }, "files": { "type": "array" }, "payment_method": { "type": "object", "properties": { "id": { "type": "string", "example": "23c06bc1-7473-46fb-8d65-b8e9bde1fe75" }, "customer_id": { "type": "string", "example": "50d14fcb-b468-4ac4-afd8-d7c47172dc1c" }, "merchant_id": { "type": "string", "example": "dd36b936-1eb7-4ece-bebc-b514c6a36ebd" }, "user_id": { "type": "string", "example": "41e60252-4f23-48de-a64f-e5a1e8a9359c" }, "nickname": { "type": "string", "example": "VISA: Mario Mario (ending in: 1111)" }, "is_default": { "type": "integer", "example": 0, "default": 0 }, "method": { "type": "string", "example": "card" }, "person_name": { "type": "string", "example": "Mario Henderson" }, "card_type": { "type": "string", "example": "visa" }, "card_last_four": { "type": "string", "example": "1111" }, "card_exp": { "type": "string", "example": "022020" }, "bank_name": {}, "bank_type": {}, "bank_holder_type": {}, "address_1": {}, "address_2": {}, "address_city": {}, "address_state": {}, "address_zip": {}, "address_country": { "type": "string", "example": "USA" }, "purged_at": {}, "deleted_at": {}, "created_at": { "type": "string", "example": "2017-01-30 20:48:13" }, "updated_at": { "type": "string", "example": "2017-01-30 20:48:13" }, "card_exp_datetime": { "type": "string", "example": "2020-02-29 23:59:59" }, "customer": { "type": "object", "properties": { "id": { "type": "string", "example": "50d14fcb-b468-4ac4-afd8-d7c47172dc1c" }, "firstname": { "type": "string", "example": "Mario" }, "lastname": { "type": "string", "example": "Henderson" }, "company": { "type": "string", "example": "" }, "email": { "type": "string", "example": "fatttest737@gmail.com" }, "cc_emails": {}, "phone": { "type": "string", "example": "5555555555" }, "address_1": { "type": "string", "example": "123 S ST." }, "address_2": { "type": "string", "example": "" }, "address_city": { "type": "string", "example": "Orlando" }, "address_state": { "type": "string", "example": "FL" }, "address_zip": { "type": "string", "example": "3222" }, "address_country": { "type": "string", "example": "USA" }, "notes": { "type": "string", "example": "" }, "reference": { "type": "string", "example": "" }, "options": { "type": "string", "example": "" }, "created_at": { "type": "string", "example": "2017-01-30 20:41:23" }, "updated_at": { "type": "string", "example": "2017-01-30 20:41:23" }, "deleted_at": {}, "gravatar": { "type": "string", "example": "//www.gravatar.com/avatar/52b3ef2ae70945ce0fca14086443dc1a" } } } } }, "user": { "type": "object", "properties": { "id": { "type": "string", "example": "b58d7eee-e68d-4d12-a1f8-62f5e71382ae" }, "system_admin": { "type": "boolean", "example": true, "default": true }, "name": { "type": "string", "example": "Demo Mann" }, "email": { "type": "string", "example": "contact@example.com" }, "email_verification_sent_at": { "type": "string", "example": "2017-05-15 16:30:23" }, "email_verified_at": { "type": "string", "example": "2017-03-29 15:27:21" }, "is_api_key": { "type": "boolean", "example": false, "default": true }, "created_at": { "type": "string", "example": "2017-01-11 21:44:02" }, "updated_at": { "type": "string", "example": "2017-05-15 16:30:23" }, "deleted_at": {}, "gravatar": { "type": "string", "example": "//www.gravatar.com/avatar/157965dea7cd2f44e349382d1d791650" }, "team_admin": {}, "team_enabled": {}, "team_role": {}, "merchant_options": { "type": "array" }, "is_portal": { "type": "boolean", "example": false, "default": true } } } } } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Invalid ID": { "value": "{\n \"id\": [\n \"The selected id is invalid.\"\n ]\n}" } }, "schema": { "type": "object", "properties": { "id": { "type": "array", "items": { "type": "string", "example": "The selected id is invalid." } } } } } } } }, "deprecated": false } }, "/transaction/{id}/funding": { "get": { "summary": "Get a Transaction's Funding Instructions", "description": "Fetch the funding instructions provided at the time of the transaction, specifically for transactions involving split funding.", "operationId": "get-a-transactions-funding-instructions", "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "[\n {\n \"id\": \"5d359074-4a39-4952-8e63-c56173807bbf\",\n \"transaction_id\": \"a72abd1a-ff7c-4b52-aaca-6c565da7904d\",\n \"invoice_id\": null,\n \"engine_settlement_id\": null,\n \"engine_transaction_id\": null,\n \"account_id\": \"41926685-879c-4240-b5d4-37dd44ee6ed4\",\n \"amount\": 50,\n \"memo\": \"example memo\",\n \"meta\": null,\n \"created_at\": \"2022-10-27 01:45:06\",\n \"updated_at\": \"2022-10-27 01:45:06\",\n \"deleted_at\": null\n },\n {\n \"id\": \"5f1cb9d3-dfb4-474c-9581-6690b8d0065a\",\n \"transaction_id\": \"a72abd1a-ff7c-4b52-aaca-6c565da7904d\",\n \"invoice_id\": null,\n \"engine_settlement_id\": null,\n \"engine_transaction_id\": null,\n \"account_id\": \"87fc674f-a7bb-4f02-ad9c-7f6c0cfb9d02\",\n \"amount\": 20,\n \"memo\": null,\n \"meta\": null,\n \"created_at\": \"2022-10-27 01:45:06\",\n \"updated_at\": \"2022-10-27 01:45:06\",\n \"deleted_at\": null\n },\n {\n \"id\": \"86b7f851-d16b-467e-832a-cce6b80c3442\",\n \"transaction_id\": \"a72abd1a-ff7c-4b52-aaca-6c565da7904d\",\n \"invoice_id\": null,\n \"engine_settlement_id\": null,\n \"engine_transaction_id\": null,\n \"account_id\": \"7ec0ebb6-36a4-4774-8f0a-f38aa3c5881e\",\n \"amount\": 30,\n \"memo\": \"example memo\",\n \"meta\": null,\n \"created_at\": \"2022-10-27 01:45:06\",\n \"updated_at\": \"2022-10-27 01:45:06\",\n \"deleted_at\": null\n }\n]" } }, "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "5d359074-4a39-4952-8e63-c56173807bbf" }, "transaction_id": { "type": "string", "example": "a72abd1a-ff7c-4b52-aaca-6c565da7904d" }, "invoice_id": {}, "engine_settlement_id": {}, "engine_transaction_id": {}, "account_id": { "type": "string", "example": "41926685-879c-4240-b5d4-37dd44ee6ed4" }, "amount": { "type": "integer", "example": 50, "default": 0 }, "memo": { "type": "string", "example": "example memo" }, "meta": {}, "created_at": { "type": "string", "example": "2022-10-27 01:45:06" }, "updated_at": { "type": "string", "example": "2022-10-27 01:45:06" }, "deleted_at": {} } } } } } }, "404": { "description": "404", "content": { "application/json": { "examples": { "Not Found": { "value": "[\n \"transaction not found\"\n]" } }, "schema": { "type": "array", "items": { "type": "string", "example": "transaction not found" } } } } } } } }, "/transaction/{id}": { "get": { "summary": "Get a Transaction's Information", "description": "Retrieve detailed information about a specific transaction using its unique ID. This includes transaction details, payment method used, customer information, and any associated child transactions (e.g., refunds or voids).", "operationId": "get-a-transactions-information", "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"id\": \"6f49149d-69a1-48e6-bec5-d63eb5816118\",\n \"invoice_id\": \"\",\n \"reference_id\": \"\",\n \"recurring_transaction_id\": \"\",\n \"type\": \"charge\",\n \"source\": null,\n \"merchant_id\": \"dd36b936-1eb7-4ece-bebc-b514c6a36ebd\",\n \"user_id\": \"41e60252-4f23-48de-a64f-e5a1e8a9359c\",\n \"customer_id\": \"d45ee88c-8b27-4be8-8d81-77dda1b81826\",\n \"payment_method_id\": \"129520d1-3844-45fd-a0b1-afb66bcdc74c\",\n \"is_manual\": null,\n \"success\": true,\n \"message\": null,\n \"meta\": {\n \"tax\": 0,\n \"subtotal\": 2,\n \"lineItems\": [\n {\n \"id\": \"optional-fm-catalog-item-id\",\n \"item\": \"Demo Item\",\n \"details\": \"this is a regular demo item\",\n \"quantity\": 1,\n \"price\": 1\n }\n ]\n },\n \"total\": 1,\n \"method\": \"card\",\n \"pre_auth\": false,\n \"last_four\": \"1111\",\n \"receipt_email_at\": null,\n \"receipt_sms_at\": null,\n \"created_at\": \"2017-05-17 19:57:08\",\n \"updated_at\": \"2017-05-17 19:57:08\",\n \"total_refunded\": null,\n \"is_refundable\": false,\n \"is_voided\": false,\n \"is_voidable\": true,\n \"currency\": \"USD\",\n \"schedule_id\": null,\n \"customer\": {\n \"id\": \"d45ee88c-8b27-4be8-8d81-77dda1b81826\",\n \"firstname\": \"John\",\n \"lastname\": \"Smith\",\n \"company\": \"ABC INC\",\n \"email\": \"demo@abc.com\",\n \"cc_emails\": [\n \"demo1@abc.com\",\n \"demo2@abc.com\"\n ],\n \"phone\": \"1234567898\",\n \"address_1\": \"123 Rite Way\",\n \"address_2\": \"Unit 12\",\n \"address_city\": \"Orlando\",\n \"address_state\": \"FL\",\n \"address_zip\": \"32801\",\n \"address_country\": \"USA\",\n \"notes\": null,\n \"reference\": \"BARTLE\",\n \"options\": \"\",\n \"created_at\": \"2017-05-08 19:22:51\",\n \"updated_at\": \"2017-05-08 19:23:46\",\n \"deleted_at\": null,\n \"gravatar\": \"//www.gravatar.com/avatar/fe3e929dd80f1653c3a4b82812660061\"\n },\n \"child_transactions\": [],\n \"files\": [],\n \"payment_method\": {\n \"id\": \"129520d1-3844-45fd-a0b1-afb66bcdc74c\",\n \"customer_id\": \"d45ee88c-8b27-4be8-8d81-77dda1b81826\",\n \"merchant_id\": \"dd36b936-1eb7-4ece-bebc-b514c6a36ebd\",\n \"user_id\": \"41e60252-4f23-48de-a64f-e5a1e8a9359c\",\n \"nickname\": \"VISA: Steven Smith Jr. (ending in: 1111)\",\n \"is_default\": 1,\n \"method\": \"card\",\n \"person_name\": \"Steven Smith Jr.\",\n \"card_type\": \"visa\",\n \"card_last_four\": \"1111\",\n \"card_exp\": \"042019\",\n \"bank_name\": null,\n \"bank_type\": null,\n \"bank_holder_type\": null,\n \"address_1\": null,\n \"address_2\": null,\n \"address_city\": null,\n \"address_state\": null,\n \"address_zip\": \"32944\",\n \"address_country\": \"USA\",\n \"purged_at\": null,\n \"deleted_at\": null,\n \"created_at\": \"2017-05-17 19:56:59\",\n \"updated_at\": \"2017-05-17 19:56:59\",\n \"card_exp_datetime\": \"2019-04-30 23:59:59\",\n \"customer\": {\n \"id\": \"d45ee88c-8b27-4be8-8d81-77dda1b81826\",\n \"firstname\": \"John\",\n \"lastname\": \"Smith\",\n \"company\": \"ABC INC\",\n \"email\": \"demo@abc.com\",\n \"cc_emails\": [\n \"demo1@abc.com\",\n \"demo2@abc.com\"\n ],\n \"phone\": \"1234567898\",\n \"address_1\": \"123 Rite Way\",\n \"address_2\": \"Unit 12\",\n \"address_city\": \"Orlando\",\n \"address_state\": \"FL\",\n \"address_zip\": \"32801\",\n \"address_country\": \"USA\",\n \"notes\": null,\n \"reference\": \"BARTLE\",\n \"options\": \"\",\n \"created_at\": \"2017-05-08 19:22:51\",\n \"updated_at\": \"2017-05-08 19:23:46\",\n \"deleted_at\": null,\n \"gravatar\": \"//www.gravatar.com/avatar/fe3e929dd80f1653c3a4b82812660061\"\n }\n },\n \"user\": {\n \"id\": \"41e60252-4f23-48de-a64f-e5a1e8a9359c\",\n \"system_admin\": true,\n \"name\": \"Benji\",\n \"email\": \"contact@example.com\",\n \"email_verification_sent_at\": \"2016-12-01 16:18:46\",\n \"email_verified_at\": \"2016-12-01 16:18:46\",\n \"is_api_key\": false,\n \"created_at\": \"2016-12-01 16:18:46\",\n \"updated_at\": \"2017-01-27 20:10:53\",\n \"deleted_at\": null,\n \"gravatar\": \"//www.gravatar.com/avatar/772cbf95746d7da86789cc3634c46ba8\",\n \"team_admin\": null,\n \"team_enabled\": null,\n \"team_role\": null,\n \"merchant_options\": [],\n \"is_portal\": false\n }\n}" }, "Payment Link w/ surcharging": { "summary": "Payment Link w/ surcharging", "value": "{\"id\": \"1f615a4d-23d7-4b84-9400-7a7cf088d39c\",\n \"invoice_id\": \"9e129e52-44d0-43df-9bcc-e4d5ab20bb38\",\n \"reference_id\": \"\",\n \"recurring_transaction_id\": \"\",\n \"auth_id\": null,\n \"type\": \"charge\",\n \"source\": null,\n \"source_ip\": \"2603:9001:2800:2f83:10b2:8adf:3056:e119\",\n \"is_merchant_present\": false,\n \"merchant_id\": \"f2010d6f-dc3c-40bb-bf13-8646c018ba38\",\n \"user_id\": \"hosted-payments\",\n \"customer_id\": \"a32bd442-dfe1-4863-8992-513d671e8d9a\",\n \"payment_method_id\": \"2717e886-8267-464d-b58e-696b7a857b2e\",\n \"is_manual\": false,\n \"success\": true,\n \"message\": null,\n \"meta\": {\n \"hosted_custom_fields\": [],\n \"subtotal\": 42,\n \"memo\": \"Additional information can be written here.\",\n \"tax\": 0,\n \"shippingAmount\": 0\n },\n \"total\": 42,\n \"method\": \"card\",\n \"pre_auth\": false,\n \"is_captured\": 0,\n \"last_four\": \"1111\",\n \"interchange_code\": \"\",\n \"interchange_fee\": null,\n \"batch_id\": \"939560f4\",\n \"batched_at\": \"2025-05-21 20:36:02\",\n \"emv_response\": \"\",\n \"avs_response\": \"\",\n \"cvv_response\": \"\",\n \"pos_entry\": \"\",\n \"pos_salesperson\": \"\",\n \"receipt_email_at\": \"2025-05-21 20:26:07\",\n \"receipt_sms_at\": null,\n \"settled_at\": \"2025-05-21 00:00:00\",\n \"created_at\": \"2025-05-21 20:26:06\",\n \"updated_at\": \"2025-05-21 20:26:07\",\n \"gateway_id\": \"8487aa7e-986d-487c-b573-ff5bd6e2bdd9\",\n \"issuer_auth_code\": \"35ec9504-3683-11f0-8bda-0a9723caf7a1\",\n \"channel\": \"website-payment\",\n \"currency\": null,\n \"total_refunded\": 0,\n \"is_cnp_refundable\": true,\n \"is_refundable\": false,\n \"is_voided\": false,\n \"is_voidable\": true,\n \"schedule_id\": null,\n \"child_captures\": [],\n \"parent_auth\": null,\n \"gateway_name\": \"test\",\n \"response\": {\n \"ip\": null,\n \"email\": null,\n \"state\": \"succeeded\",\n \"token\": \"MJTux2LDR5BgwX6fXcFcssu2IdH\",\n \"amount\": 4200,\n \"message\": \"Succeeded!\",\n \"warning\": null,\n \"AuthCode\": \"35ec9504-3683-11f0-8bda-0a9723caf7a1\",\n \"api_urls\": [\n {\n \"referencing_transaction\": []\n },\n {\n \"failover_transaction\": []\n }\n ],\n \"order_id\": \"9e129e52-44d0-43df-9bcc-e4d5ab20bb38\",\n \"response\": {\n \"message\": \"Successful purchase\",\n \"pending\": false,\n \"success\": true,\n \"avs_code\": null,\n \"cvv_code\": null,\n \"cancelled\": false,\n \"created_at\": \"2025-05-21T20:26:06Z\",\n \"error_code\": null,\n \"updated_at\": \"2025-05-21T20:26:06Z\",\n \"avs_message\": null,\n \"cvv_message\": null,\n \"error_detail\": null,\n \"fraud_review\": null,\n \"result_unknown\": false\n },\n \"risk_data\": null,\n \"succeeded\": true,\n \"created_at\": \"2025-05-21T20:26:06Z\",\n \"order_data\": null,\n \"updated_at\": \"2025-05-21T20:26:06Z\",\n \"description\": \"\",\n \"message_key\": \"messages.transaction_succeeded\",\n \"gateway_type\": \"test\",\n \"local_amount\": null,\n \"smart_routed\": false,\n \"workflow_key\": null,\n \"currency_code\": \"USD\",\n \"customer_data\": null,\n \"gateway_token\": \"1FF2C38TM88FASPCEYREGYE35R\",\n \"application_id\": null,\n \"payment_method\": {\n \"zip\": \"32837\",\n \"city\": \"Orlando\",\n \"data\": null,\n \"test\": true,\n \"year\": 2029,\n \"email\": \"rya.karleskint+testaxl21@staxpayments.com\",\n \"month\": 2,\n \"state\": \"FL\",\n \"token\": \"01JVT8CKGY549YGNH8BNWPCV8C\",\n \"errors\": [],\n \"number\": \"XXXX-XXXX-XXXX-1111\",\n \"company\": \"Your Company\",\n \"country\": \"USA\",\n \"managed\": false,\n \"address1\": \"12028 Green Emerald Court\",\n \"address2\": null,\n \"metadata\": null,\n \"card_type\": \"visa\",\n \"full_name\": \"Rya Karleskint\",\n \"last_name\": \"Karleskint\",\n \"created_at\": \"2025-05-21T20:26:04.702Z\",\n \"first_name\": \"Rya\",\n \"updated_at\": \"2025-05-21T20:26:05.904Z\",\n \"fingerprint\": \"4d8d9c44ecc9c357d02a9db8a9a66ec0277f\",\n \"bin_metadata\": {\n \"message\": \"BIN Metadata is available only to Advanced Vault enrolled customers and payment methods. Reach out to your account representative for more details.\"\n },\n \"callback_url\": null,\n \"click_to_pay\": false,\n \"phone_number\": null,\n \"shipping_zip\": null,\n \"shipping_city\": null,\n \"storage_state\": \"retained\",\n \"shipping_state\": null,\n \"first_six_digits\": \"411111\",\n \"last_four_digits\": \"1111\",\n \"shipping_country\": null,\n \"shipping_address1\": null,\n \"shipping_address2\": null,\n \"verification_value\": \"XXX\",\n \"payment_method_type\": \"credit_card\",\n \"shipping_phone_number\": null,\n \"eligible_for_card_updater\": false,\n \"issuer_identification_number\": \"41111111\"\n },\n \"on_test_gateway\": true,\n \"attempt_3dsecure\": false,\n \"shipping_address\": {\n \"zip\": null,\n \"city\": null,\n \"name\": \"Rya Karleskint\",\n \"state\": null,\n \"country\": null,\n \"address1\": null,\n \"address2\": null,\n \"phone_number\": null\n },\n \"sub_merchant_key\": null,\n \"transaction_type\": \"Purchase\",\n \"merchant_metadata\": null,\n \"retain_on_success\": true,\n \"gateway_latency_ms\": 20,\n \"merchant_profile_key\": null,\n \"payment_method_added\": false,\n \"protection_parameters\": null,\n \"gateway_transaction_id\": \"9e129e52-44d0-43df-9bcc-e4d5ab20bb38\",\n \"gateway_specific_fields\": null,\n \"merchant_name_descriptor\": \"Test A\",\n \"stored_credential_initiator\": null,\n \"merchant_location_descriptor\": \"https://omni.fattmerchant.com\",\n \"stored_credential_reason_type\": null,\n \"stored_credential_final_payment\": false,\n \"gateway_specific_response_fields\": [],\n \"stored_credential_alternate_gateway\": null\n },\n \"is_settling\": null,\n \"avs_code\": null,\n \"avs_message\": null,\n \"cvv_code\": null,\n \"cvv_message\": null,\n \"dispute\": null,\n \"status\": \"SUCCESS\",\n \"idempotency_id\": null,\n \"error_description\": null,\n \"customer\": {\n \"id\": \"a32bd442-dfe1-4863-8992-513d671e8d9a\",\n \"firstname\": \"Rya\",\n \"lastname\": \"Karleskint\",\n \"company\": \"Your Company\",\n \"email\": \"rya.karleskint+testaxl21@staxpayments.com\",\n \"cc_emails\": null,\n \"cc_sms\": null,\n \"phone\": \"4074166773\",\n \"address_1\": \"12028 Green Emerald Court\",\n \"address_2\": \"\",\n \"address_city\": \"Orlando\",\n \"address_state\": \"FL\",\n \"address_zip\": \"32837\",\n \"address_country\": \"USA\",\n \"notes\": null,\n \"reference\": \"\",\n \"options\": null,\n \"created_at\": \"2025-05-21 20:26:05\",\n \"updated_at\": \"2025-05-21 20:26:05\",\n \"deleted_at\": null,\n \"allow_invoice_credit_card_payments\": true,\n \"gravatar\": \"//www.gravatar.com/avatar/ef85ecd8fc83ab0b756220b6156d07ab\",\n \"has_address\": true,\n \"missing_address_components\": []\n },\n \"child_transactions\": [],\n \"files\": [],\n \"payment_method\": {\n \"id\": \"2717e886-8267-464d-b58e-696b7a857b2e\",\n \"customer_id\": \"a32bd442-dfe1-4863-8992-513d671e8d9a\",\n \"merchant_id\": \"f2010d6f-dc3c-40bb-bf13-8646c018ba38\",\n \"user_id\": \"hosted-payments\",\n \"nickname\": \"VISA: Rya Karleskint (ending in: 1111)\",\n \"has_cvv\": 1,\n \"is_default\": 0,\n \"method\": \"card\",\n \"person_name\": \"Rya Karleskint\",\n \"card_type\": \"visa\",\n \"card_last_four\": \"1111\",\n \"card_exp\": \"022029\",\n \"bank_name\": null,\n \"bank_type\": null,\n \"bank_holder_type\": null,\n \"address_1\": \"12028 Green Emerald Court\",\n \"address_2\": null,\n \"address_city\": \"Orlando\",\n \"address_state\": \"FL\",\n \"address_zip\": \"32837\",\n \"address_country\": \"USA\",\n \"purged_at\": null,\n \"deleted_at\": null,\n \"created_at\": \"2025-05-21 20:26:06\",\n \"updated_at\": \"2025-05-21 20:26:06\",\n \"meta\": {\n \"cardDisplay\": \"411111\",\n \"routingDisplay\": null,\n \"accountDisplay\": null,\n \"eligibleForCardUpdater\": false,\n \"storageState\": \"cached\",\n \"fingerprint\": \"4d8d9c44ecc9c357d02a9db8a9a66ec0277f\",\n \"errors\": [],\n \"prepaid\": false\n },\n \"bin_type\": \"CREDIT\",\n \"au_enrolled\": 0,\n \"au_last_event\": null,\n \"au_last_event_at\": null,\n \"card_exp_datetime\": \"2029-02-28 23:59:59\",\n \"is_usable_in_vt\": true,\n \"is_tokenized\": true,\n \"customer\": {\n \"id\": \"a32bd442-dfe1-4863-8992-513d671e8d9a\",\n \"firstname\": \"Rya\",\n \"lastname\": \"Karleskint\",\n \"company\": \"Your Company\",\n \"email\": \"rya.karleskint+testaxl21@staxpayments.com\",\n \"cc_emails\": null,\n \"cc_sms\": null,\n \"phone\": \"4074166773\",\n \"address_1\": \"12028 Green Emerald Court\",\n \"address_2\": \"\",\n \"address_city\": \"Orlando\",\n \"address_state\": \"FL\",\n \"address_zip\": \"32837\",\n \"address_country\": \"USA\",\n \"notes\": null,\n \"reference\": \"\",\n \"options\": null,\n \"created_at\": \"2025-05-21 20:26:05\",\n \"updated_at\": \"2025-05-21 20:26:05\",\n \"deleted_at\": null,\n \"allow_invoice_credit_card_payments\": true,\n \"gravatar\": \"//www.gravatar.com/avatar/ef85ecd8fc83ab0b756220b6156d07ab\",\n \"has_address\": true,\n \"missing_address_components\": []\n }\n },\n \"user\": {\n \"id\": \"hosted-payments\",\n \"system_admin\": false,\n \"name\": \"Hosted Payments\",\n \"email\": \"hostedpayments@staxpayments.com\",\n \"email_verification_sent_at\": \"2016-05-12 16:30:59\",\n \"email_verified_at\": \"2016-05-12 16:30:59\",\n \"is_api_key\": false,\n \"options\": null,\n \"acknowledgments\": null,\n \"created_at\": \"2016-01-18 13:42:25\",\n \"updated_at\": \"2023-03-24 14:23:43\",\n \"deleted_at\": null,\n \"brand\": \"fattmerchant\",\n \"mfa_enabled\": true,\n \"role_id\": null,\n \"gravatar\": \"//www.gravatar.com/avatar/8ec81100ba8c5a7818a4acf2279ca007\",\n \"team_admin\": null,\n \"team_enabled\": null,\n \"team_role\": null,\n \"merchant_options\": [],\n \"is_default\": false,\n \"brands\": [\n \"fattmerchant\"\n ],\n \"role_name\": null}" } }, "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "6f49149d-69a1-48e6-bec5-d63eb5816118" }, "invoice_id": { "type": "string", "example": "" }, "reference_id": { "type": "string", "example": "" }, "recurring_transaction_id": { "type": "string", "example": "" }, "type": { "type": "string", "example": "charge" }, "source": {}, "merchant_id": { "type": "string", "example": "dd36b936-1eb7-4ece-bebc-b514c6a36ebd" }, "user_id": { "type": "string", "example": "41e60252-4f23-48de-a64f-e5a1e8a9359c" }, "customer_id": { "type": "string", "example": "d45ee88c-8b27-4be8-8d81-77dda1b81826" }, "payment_method_id": { "type": "string", "example": "129520d1-3844-45fd-a0b1-afb66bcdc74c" }, "is_manual": {}, "success": { "type": "boolean", "example": true, "default": true }, "message": {}, "meta": { "type": "object", "properties": { "tax": { "type": "number", "example": 0, "default": 0 }, "subtotal": { "type": "number", "example": 2, "default": 0 }, "lineItems": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "optional-fm-catalog-item-id" }, "item": { "type": "string", "example": "Demo Item" }, "details": { "type": "string", "example": "this is a regular demo item" }, "quantity": { "type": "integer", "example": 1, "default": 0 }, "price": { "type": "integer", "example": 1, "default": 0 } } } } } }, "total": { "type": "number", "example": 1, "default": 0 }, "method": { "type": "string", "example": "card" }, "pre_auth": { "type": "boolean", "example": false, "default": true }, "last_four": { "type": "string", "example": "1111" }, "receipt_email_at": {}, "receipt_sms_at": {}, "created_at": { "type": "string", "example": "2017-05-17 19:57:08" }, "updated_at": { "type": "string", "example": "2017-05-17 19:57:08" }, "total_refunded": { "type": "number" }, "is_refundable": { "type": "boolean", "example": false, "default": true }, "is_voided": { "type": "boolean", "example": false, "default": true }, "is_voidable": { "type": "boolean", "example": true, "default": true }, "currency": { "type": "string", "example": "USD" }, "schedule_id": {}, "customer": { "type": "object", "properties": { "id": { "type": "string", "example": "d45ee88c-8b27-4be8-8d81-77dda1b81826" }, "firstname": { "type": "string", "example": "John" }, "lastname": { "type": "string", "example": "Smith" }, "company": { "type": "string", "example": "ABC INC" }, "email": { "type": "string", "example": "demo@abc.com" }, "cc_emails": { "type": "array", "items": { "type": "string", "example": "demo1@abc.com" } }, "phone": { "type": "string", "example": "1234567898" }, "address_1": { "type": "string", "example": "123 Rite Way" }, "address_2": { "type": "string", "example": "Unit 12" }, "address_city": { "type": "string", "example": "Orlando" }, "address_state": { "type": "string", "example": "FL" }, "address_zip": { "type": "string", "example": "32801" }, "address_country": { "type": "string", "example": "USA" }, "notes": {}, "reference": { "type": "string", "example": "BARTLE" }, "options": { "type": "string", "example": "" }, "created_at": { "type": "string", "example": "2017-05-08 19:22:51" }, "updated_at": { "type": "string", "example": "2017-05-08 19:23:46" }, "deleted_at": {}, "gravatar": { "type": "string", "example": "//www.gravatar.com/avatar/fe3e929dd80f1653c3a4b82812660061" } } }, "child_transactions": { "type": "array" }, "files": { "type": "array" }, "payment_method": { "type": "object", "properties": { "id": { "type": "string", "example": "129520d1-3844-45fd-a0b1-afb66bcdc74c" }, "customer_id": { "type": "string", "example": "d45ee88c-8b27-4be8-8d81-77dda1b81826" }, "merchant_id": { "type": "string", "example": "dd36b936-1eb7-4ece-bebc-b514c6a36ebd" }, "user_id": { "type": "string", "example": "41e60252-4f23-48de-a64f-e5a1e8a9359c" }, "nickname": { "type": "string", "example": "VISA: Steven Smith Jr. (ending in: 1111)" }, "is_default": { "type": "integer", "example": 1, "default": 0 }, "method": { "type": "string", "example": "card" }, "person_name": { "type": "string", "example": "Steven Smith Jr." }, "card_type": { "type": "string", "example": "visa" }, "card_last_four": { "type": "string", "example": "1111" }, "card_exp": { "type": "string", "example": "042019" }, "bank_name": {}, "bank_type": {}, "bank_holder_type": {}, "address_1": {}, "address_2": {}, "address_city": {}, "address_state": {}, "address_zip": { "type": "string", "example": "32944" }, "address_country": { "type": "string", "example": "USA" }, "purged_at": {}, "deleted_at": {}, "created_at": { "type": "string", "example": "2017-05-17 19:56:59" }, "updated_at": { "type": "string", "example": "2017-05-17 19:56:59" }, "card_exp_datetime": { "type": "string", "example": "2019-04-30 23:59:59" }, "customer": { "type": "object", "properties": { "id": { "type": "string", "example": "d45ee88c-8b27-4be8-8d81-77dda1b81826" }, "firstname": { "type": "string", "example": "John" }, "lastname": { "type": "string", "example": "Smith" }, "company": { "type": "string", "example": "ABC INC" }, "email": { "type": "string", "example": "demo@abc.com" }, "cc_emails": { "type": "array", "items": { "type": "string", "example": "demo1@abc.com" } }, "phone": { "type": "string", "example": "1234567898" }, "address_1": { "type": "string", "example": "123 Rite Way" }, "address_2": { "type": "string", "example": "Unit 12" }, "address_city": { "type": "string", "example": "Orlando" }, "address_state": { "type": "string", "example": "FL" }, "address_zip": { "type": "string", "example": "32801" }, "address_country": { "type": "string", "example": "USA" }, "notes": {}, "reference": { "type": "string", "example": "BARTLE" }, "options": { "type": "string", "example": "" }, "created_at": { "type": "string", "example": "2017-05-08 19:22:51" }, "updated_at": { "type": "string", "example": "2017-05-08 19:23:46" }, "deleted_at": {}, "gravatar": { "type": "string", "example": "//www.gravatar.com/avatar/fe3e929dd80f1653c3a4b82812660061" } } } } }, "user": { "type": "object", "properties": { "id": { "type": "string", "example": "41e60252-4f23-48de-a64f-e5a1e8a9359c" }, "system_admin": { "type": "boolean", "example": true, "default": true }, "name": { "type": "string", "example": "Benji" }, "email": { "type": "string", "example": "contact@example.com" }, "email_verification_sent_at": { "type": "string", "example": "2016-12-01 16:18:46" }, "email_verified_at": { "type": "string", "example": "2016-12-01 16:18:46" }, "is_api_key": { "type": "boolean", "example": false, "default": true }, "created_at": { "type": "string", "example": "2016-12-01 16:18:46" }, "updated_at": { "type": "string", "example": "2017-01-27 20:10:53" }, "deleted_at": {}, "gravatar": { "type": "string", "example": "//www.gravatar.com/avatar/772cbf95746d7da86789cc3634c46ba8" }, "team_admin": {}, "team_enabled": {}, "team_role": {}, "merchant_options": { "type": "array" }, "is_portal": { "type": "boolean", "example": false, "default": true } } } } } } } }, "422": { "description": "422", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"id\": [\n \"The selected id is invalid.\"\n ]\n}" } }, "schema": { "type": "object", "properties": { "id": { "type": "array", "items": { "type": "string", "example": "The selected id is invalid." } } } } } } } }, "deprecated": false } }, "/terminal/register": { "get": { "summary": "Get all devices", "description": "Returns a list of WIFI registers (devices) associated to the merchant account.", "operationId": "get-all-devices", "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "[\n {\n \"id\": \"4f1b-f10a\",\n \"nickname\": \"Tech Area Z8 (3594291)\",\n \"status_port\": \"3594291\",\n \"serial\": \"124124\",\n \"type\": \"dejavoo\",\n \"model\": \"\",\n \"isDefault\": false,\n \"register_num\": \"3594291\"\n },\n {\n \"id\": \"18a3-83e7\",\n \"nickname\": \"DANIEL HOME OFFICE (3598304)\",\n \"status_port\": \"3598304\",\n \"serial\": \"123123\",\n \"type\": \"dejavoo\",\n \"model\": \"\",\n \"isDefault\": true,\n \"register_num\": \"3598304\"\n },\n {\n \"id\": \"94d1-318d\",\n \"nickname\": \"Tech Area Z1 (6880)\",\n \"status_port\": \"6880\",\n \"serial\": \"2434\",\n \"type\": \"dejavoo\",\n \"model\": \"\",\n \"isDefault\": false,\n \"register_num\": \"6880\"\n }\n]" } }, "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "4f1b-f10a" }, "nickname": { "type": "string", "example": "Tech Area Z8 (3594291)" }, "status_port": { "type": "string", "example": "3594291" }, "serial": { "type": "string", "example": "124124" }, "type": { "type": "string", "example": "dejavoo" }, "model": { "type": "string", "example": "" }, "isDefault": { "type": "boolean", "example": false, "default": true }, "register_num": { "type": "string", "example": "3594291" } } } } } } } }, "deprecated": false } }, "/customer/{customerId}/payment-method": { "get": { "summary": "Get all Payment Methods for a Customer", "description": "Retrieves a non-paginated data array of all non-deleted payment methods associated with a customer.", "operationId": "get-all-payment-methods-for-a-customer", "parameters": [ { "name": "customerId", "in": "path", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "[\n {\n \"id\": \"7e3a83ea-6770-41f7-9b28-7ea1a3ae33e7\",\n \"customer_id\": \"35e4cfa9-d87e-45fc-84da-a6bdce2c3330\",\n \"merchant_id\": \"85c58c65-4da7-4f99-acb0-afa885874572\",\n \"user_id\": \"hosted-payments\",\n \"nickname\": \"VISA: Bob Smithers (ending in: 1111)\",\n \"has_cvv\": 0,\n \"is_default\": 0,\n \"method\": \"card\",\n \"person_name\": \"Bob Smithers\",\n \"card_type\": \"visa\",\n \"card_last_four\": \"1111\",\n \"card_exp\": \"032022\",\n \"bank_name\": null,\n \"bank_type\": null,\n \"bank_holder_type\": null,\n \"address_1\": null,\n \"address_2\": null,\n \"address_city\": null,\n \"address_state\": null,\n \"address_zip\": \"999999\",\n \"address_country\": null,\n \"purged_at\": null,\n \"deleted_at\": null,\n \"created_at\": \"2018-08-03 17:59:10\",\n \"updated_at\": \"2018-08-03 17:59:10\",\n \"card_exp_datetime\": \"2022-03-31 23:59:59\",\n \"is_usable_in_vt\": true,\n \"is_tokenized\": true,\n \"customer\": {\n \"id\": \"35e4cfa9-d87e-45fc-84da-a6bdce2c3330\",\n \"firstname\": \"John\",\n \"lastname\": \"Smith\",\n \"company\": \"ABC INC\",\n \"email\": \"webpaymentstest@test.com\",\n \"cc_emails\": [],\n \"cc_sms\": null,\n \"phone\": \"1234567898\",\n \"address_1\": \"123 Rite Way\",\n \"address_2\": \"Unit 12\",\n \"address_city\": \"Orlando\",\n \"address_state\": \"FL\",\n \"address_zip\": \"32801\",\n \"address_country\": \"USA\",\n \"notes\": null,\n \"reference\": \"\",\n \"options\": null,\n \"created_at\": \"2018-07-27 19:08:48\",\n \"updated_at\": \"2018-07-27 19:08:48\",\n \"deleted_at\": null,\n \"allow_invoice_credit_card_payments\": true,\n \"gravatar\": \"//www.gravatar.com/avatar/18dd69e3959903c248ac613b51bc7f8e\"\n }\n },\n {\n \"id\": \"403e043d-2971-4062-adc7-7e64f7882786\",\n \"customer_id\": \"35e4cfa9-d87e-45fc-84da-a6bdce2c3330\",\n \"merchant_id\": \"85c58c65-4da7-4f99-acb0-afa885874572\",\n \"user_id\": \"a01a5f74-cbdb-4704-9e9b-56fd5a8ee7b8\",\n \"nickname\": \"personal savings, BANK INC (ending in: 3210)\",\n \"has_cvv\": 0,\n \"is_default\": 1,\n \"method\": \"bank\",\n \"person_name\": \"Bob Smith\",\n \"card_type\": null,\n \"card_last_four\": \"3210\",\n \"card_exp\": null,\n \"bank_name\": \"Bank INC\",\n \"bank_type\": \"savings\",\n \"bank_holder_type\": \"personal\",\n \"address_1\": null,\n \"address_2\": null,\n \"address_city\": null,\n \"address_state\": null,\n \"address_zip\": null,\n \"address_country\": null,\n \"purged_at\": null,\n \"deleted_at\": null,\n \"created_at\": \"2018-08-02 21:06:04\",\n \"updated_at\": \"2018-08-02 21:06:04\",\n \"card_exp_datetime\": [],\n \"is_usable_in_vt\": true,\n \"is_tokenized\": true,\n \"customer\": {\n \"id\": \"35e4cfa9-d87e-45fc-84da-a6bdce2c3330\",\n \"firstname\": \"John\",\n \"lastname\": \"Smith\",\n \"company\": \"ABC INC\",\n \"email\": \"webpaymentstest@test.com\",\n \"cc_emails\": [],\n \"cc_sms\": null,\n \"phone\": \"1234567898\",\n \"address_1\": \"123 Rite Way\",\n \"address_2\": \"Unit 12\",\n \"address_city\": \"Orlando\",\n \"address_state\": \"FL\",\n \"address_zip\": \"32801\",\n \"address_country\": \"USA\",\n \"notes\": null,\n \"reference\": \"\",\n \"options\": null,\n \"created_at\": \"2018-07-27 19:08:48\",\n \"updated_at\": \"2018-07-27 19:08:48\",\n \"deleted_at\": null,\n \"allow_invoice_credit_card_payments\": true,\n \"gravatar\": \"//www.gravatar.com/avatar/18dd69e3959903c248ac613b51bc7f8e\"\n }\n }\n]" } }, "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "7e3a83ea-6770-41f7-9b28-7ea1a3ae33e7" }, "customer_id": { "type": "string", "example": "35e4cfa9-d87e-45fc-84da-a6bdce2c3330" }, "merchant_id": { "type": "string", "example": "85c58c65-4da7-4f99-acb0-afa885874572" }, "user_id": { "type": "string", "example": "hosted-payments" }, "nickname": { "type": "string", "example": "VISA: Bob Smithers (ending in: 1111)" }, "has_cvv": { "type": "integer", "example": 0, "default": 0 }, "is_default": { "type": "integer", "example": 0, "default": 0 }, "method": { "type": "string", "example": "card" }, "person_name": { "type": "string", "example": "Bob Smithers" }, "card_type": { "type": "string", "example": "visa" }, "card_last_four": { "type": "string", "example": "1111" }, "card_exp": { "type": "string", "example": "032022" }, "bank_name": {}, "bank_type": {}, "bank_holder_type": {}, "address_1": {}, "address_2": {}, "address_city": {}, "address_state": {}, "address_zip": { "type": "string", "example": "999999" }, "address_country": {}, "purged_at": {}, "deleted_at": {}, "created_at": { "type": "string", "example": "2018-08-03 17:59:10" }, "updated_at": { "type": "string", "example": "2018-08-03 17:59:10" }, "card_exp_datetime": { "type": "string", "example": "2022-03-31 23:59:59" }, "is_usable_in_vt": { "type": "boolean", "example": true, "default": true }, "is_tokenized": { "type": "boolean", "example": true, "default": true }, "customer": { "type": "object", "properties": { "id": { "type": "string", "example": "35e4cfa9-d87e-45fc-84da-a6bdce2c3330" }, "firstname": { "type": "string", "example": "John" }, "lastname": { "type": "string", "example": "Smith" }, "company": { "type": "string", "example": "ABC INC" }, "email": { "type": "string", "example": "webpaymentstest@test.com" }, "cc_emails": { "type": "array" }, "cc_sms": {}, "phone": { "type": "string", "example": "1234567898" }, "address_1": { "type": "string", "example": "123 Rite Way" }, "address_2": { "type": "string", "example": "Unit 12" }, "address_city": { "type": "string", "example": "Orlando" }, "address_state": { "type": "string", "example": "FL" }, "address_zip": { "type": "string", "example": "32801" }, "address_country": { "type": "string", "example": "USA" }, "notes": {}, "reference": { "type": "string", "example": "" }, "options": {}, "created_at": { "type": "string", "example": "2018-07-27 19:08:48" }, "updated_at": { "type": "string", "example": "2018-07-27 19:08:48" }, "deleted_at": {}, "allow_invoice_credit_card_payments": { "type": "boolean", "example": true, "default": true }, "gravatar": { "type": "string", "example": "//www.gravatar.com/avatar/18dd69e3959903c248ac613b51bc7f8e" } } } } } } } } }, "422": { "description": "422", "content": { "application/json": { "examples": { "Invalid ID": { "value": "{\n \"id\": [\n \"The selected id is invalid.\"\n ]\n}" } }, "schema": { "type": "object", "properties": { "id": { "type": "array", "items": { "type": "string", "example": "The selected id is invalid." } } } } } } } }, "deprecated": false } }, "/query/depositDetail": { "get": { "summary": "Get Details of Specific Deposit", "description": "Shows granular detail about a specific deposit.", "operationId": "get-detail-of-specific-deposit", "parameters": [ { "name": "startDate", "in": "query", "description": "(YYYY-MM-DD) No results before this date will be returned", "required": true, "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "description": "(YYYY-MM-DD) No results after this date will be returned", "required": true, "schema": { "type": "string" } }, { "name": "batchId", "in": "query", "description": "The id of the batch you are querying", "schema": { "type": "string" } }, { "name": "timezone", "in": "query", "description": "Stax supports US timezones only. Defaults to UTC", "schema": { "type": "string", "enum": [ "HST", "HDT", "AKST", "AKDT", "PDT", "PST", "MST", "MDT", "CST", "CDT", "EST", "EDT", "UTC" ], "default": "UTC" } }, { "name": "timeZoneOffset", "in": "query", "description": "Numeric offset value from UTC time (-4, 1, etc.)", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"data\": [\n {\n \"batched_at\": \"2019-01-01\",\n \"batch_id\": \"00001\",\n \"auth_id\": \"654321\",\n \"created_at\": \"2019-01-01T18:38:00.000Z\",\n \"total\": 40,\n \"method\": \"card\",\n \"last_four\": \"1896\",\n \"card_type\": \"visa\",\n \"fees\": 0.47,\n \"transaction_id\": \"93870317-c147-482f-b7c0-13ba0e83a253\"\n },\n {\n \"batched_at\": \"2019-01-01\",\n \"batch_id\": \"00001\",\n \"auth_id\": \"123456\",\n \"created_at\": \"2019-01-01T17:59:00.000Z\",\n \"total\": 41,\n \"method\": \"card\",\n \"last_four\": \"3243\",\n \"card_type\": \"mcrd\",\n \"fees\": 0.47,\n \"transaction_id\": \"43870317-c147-482f-b7c0-13ba0e83a253\"\n },\n {\n \"batched_at\": \"2019-01-01\",\n \"batch_id\": \"00001\",\n \"auth_id\": \"123456\",\n \"created_at\": \"2019-01-01T17:49:00.000Z\",\n \"total\": 35,\n \"method\": \"card\",\n \"last_four\": \"0637\",\n \"card_type\": \"visa\",\n \"fees\": 0.47,\n \"transaction_id\": \"83870317-c147-482f-b7c0-13ba0e83a253\"\n },\n // [etc]\n ]\n}" } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "{}" } }, "schema": { "type": "object", "properties": {} } } } } }, "deprecated": false } }, "/query/deposit": { "get": { "summary": "Get List of Deposits", "description": "Shows list of your merchant's deposits filtered by the batched_at date by default", "operationId": "get-list-of-deposits", "parameters": [ { "name": "startDate", "in": "query", "description": "(YYYY-MM-DD HH:mm:ss) No results before this date will be returned", "required": true, "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "description": "(YYYY-MM-DD HH:mm:ss) No results after this date will be returned", "required": true, "schema": { "type": "string" } }, { "name": "timezone", "in": "query", "description": "Stax supports US timezones only. Defaults to UTC", "schema": { "type": "string", "enum": [ "HST", "HDT", "AKST", "AKDT", "PDT", "PST", "MST", "MDT", "CST", "CDT", "EST", "EDT", "UTC" ], "default": "UTC" } }, { "name": "timeZoneOffset", "in": "query", "description": "numeric offset value from UTC time (-4, 1, etc.)", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"data\": [\n {\n \"batched_at\": \"2019-01-01\",\n \"batch_id\": \"00001\",\n \"last_transaction\": \"2019-01-01T18:38:00.000Z\",\n \"count\": 29,\n \"sum\": 1379.65,\n \"avg\": 47.57,\n \"min\": 10,\n \"max\": 199.93,\n \"std\": 33.82\n },\n {\n \"batched_at\": \"2019-01-02\",\n \"batch_id\": \"00002\",\n \"last_transaction\": \"2019-01-02T17:28:00.000Z\",\n \"count\": 18,\n \"sum\": 706,\n \"avg\": 39.22,\n \"min\": 10,\n \"max\": 75,\n \"std\": 12.9\n }\n ]\n}" } }, "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "batched_at": { "type": "string", "example": "2019-01-01" }, "batch_id": { "type": "string", "example": "00001" }, "last_transaction": { "type": "string", "example": "2019-01-01T18:38:00.000Z" }, "count": { "type": "integer", "example": 29, "default": 0 }, "sum": { "type": "number", "example": 1379.65, "default": 0 }, "avg": { "type": "number", "example": 47.57, "default": 0 }, "min": { "type": "integer", "example": 10, "default": 0 }, "max": { "type": "number", "example": 199.93, "default": 0 }, "std": { "type": "number", "example": 33.82, "default": 0 } } } } } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "{}" } }, "schema": { "type": "object", "properties": {} } } } } }, "deprecated": false } }, "/merchant/{merchant_id}": { "get": { "summary": "Get Merchant by ID", "description": "Retrieves the merchant specified by the {id} parameter.", "operationId": "get-merchant-by-id", "parameters": [ { "name": "merchant_id", "in": "path", "schema": { "type": "string" }, "required": true, "description": "ID of the merchant." } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"id\": \"65649c08-71be-4745-a437-c265df8f3ed3\",\n \"mid\": \"\",\n \"status\": \"PENDING\",\n \"subdomain\": \"\",\n \"company_name\": \"Test merchant\",\n \"display_name\": \"Test merchant\",\n \"contact_name\": \"\",\n \"contact_email\": \"payments@test.io\",\n \"contact_phone\": \"\",\n \"address_1\": \"\",\n \"address_2\": \"\",\n \"address_city\": \"\",\n \"address_state\": \"\",\n \"address_zip\": \"\",\n \"hosted_payments_token\": \"Test Merchant\",\n \"currency\": [\n \"USD\"\n ],\n \"plan\": {\n \"id\": \"ecc2e251-278d-4322-aaae-e4ba985f8f40\",\n \"merchant_id\": \"65649c08-71be-4745-a437-c265df8f3765\",\n \"user_id\": \"c3a7f735-a8f0-4ca1-937d-d0f2b76ba44b\",\n \"name\": \"plan-0\",\n \"created_at\": \"2021-07-14 18:53:53\",\n \"updated_at\": \"2021-07-14 18:53:53\"\n },\n \"options\": null,\n \"notes\": \"\",\n \"gateway_type\": null,\n \"vendor_keys\": null,\n \"processor\": \"\",\n \"partner\": null,\n \"product_type\": \"Other\",\n \"is_enterprise\": false,\n \"is_payfac\": false,\n \"is_sandbox\": false,\n \"fm_billing_schedule_id\": null,\n \"fee_reconciliation_payment_method_id\": null,\n \"welcome_email_sent_at\": null,\n \"created_at\": \"2021-07-14 18:53:52\",\n \"updated_at\": \"2021-07-14 18:53:52\",\n \"deleted_at\": null,\n \"brand\": \"fattmerchant\",\n \"risk_hold\": false,\n \"branding\": null,\n \"allow_ach\": false,\n \"is_portal\": false,\n \"is_flat_rate\": false,\n \"allow_credits\": false,\n \"allow_terminal\": false,\n \"gateways\": [],\n \"is_surcharge_enabled\": false,\n \"is_trust\": false,\n \"users\": [\n {\n \"id\": \"c3a7f735-a8fa-4ca1-937d-d0f2b76ba44b\",\n \"system_admin\": false,\n \"name\": \"Test user\",\n \"email\": \"payments@test.io\",\n \"email_verification_sent_at\": null,\n \"email_verified_at\": null,\n \"is_api_key\": false,\n \"options\": null,\n \"acknowledgments\": {\n \"setPassword\": true\n },\n \"created_at\": \"2021-07-14 18:51:27\",\n \"updated_at\": \"2021-07-14 18:53:16\",\n \"deleted_at\": null,\n \"brand\": \"fattmerchant\",\n \"gravatar\": \"//www.gravatar.com/avatar/c75f409ceae6d2a2ca1efdc2a313236f\",\n \"team_admin\": true,\n \"team_enabled\": true,\n \"team_role\": \"admin\",\n \"merchant_options\": [],\n \"is_default\": false,\n \"brands\": [\n \"fattmerchant\"\n ],\n \"pivot\": {\n \"merchant_id\": \"65649c08-71be-4745-a437-c265df8f3ed3\",\n \"user_id\": \"c3a7f735-a8fa-4ca1-937d-d0f2b76ba44b\",\n \"is_default\": false,\n \"team_role\": \"admin\",\n \"deleted_at\": null,\n \"merchant_options\": [],\n \"created_at\": \"2021-07-14 18:53:53\",\n \"updated_at\": \"2021-07-14 18:53:53\"\n }\n }\n ]\n}" } }, "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "65649c08-71be-4745-a437-c265df8f3ed3" }, "mid": { "type": "string", "example": "" }, "status": { "type": "string", "example": "PENDING" }, "subdomain": { "type": "string", "example": "" }, "company_name": { "type": "string", "example": "Test merchant" }, "display_name": { "type": "string", "example": "Test merchant" }, "contact_name": { "type": "string", "example": "" }, "contact_email": { "type": "string", "example": "payments@test.io" }, "contact_phone": { "type": "string", "example": "" }, "address_1": { "type": "string", "example": "" }, "address_2": { "type": "string", "example": "" }, "address_city": { "type": "string", "example": "" }, "address_state": { "type": "string", "example": "" }, "address_zip": { "type": "string", "example": "" }, "hosted_payments_token": { "type": "string", "example": "Test Merchant" }, "currency": { "type": "array", "items": { "type": "string", "example": "USD" } }, "plan": { "type": "object", "properties": { "id": { "type": "string", "example": "ecc2e251-278d-4322-aaae-e4ba985f8f40" }, "merchant_id": { "type": "string", "example": "65649c08-71be-4745-a437-c265df8f3765" }, "user_id": { "type": "string", "example": "c3a7f735-a8f0-4ca1-937d-d0f2b76ba44b" }, "name": { "type": "string", "example": "plan-0" }, "created_at": { "type": "string", "example": "2021-07-14 18:53:53" }, "updated_at": { "type": "string", "example": "2021-07-14 18:53:53" } } }, "options": {}, "notes": { "type": "string", "example": "" }, "gateway_type": {}, "vendor_keys": {}, "processor": { "type": "string", "example": "" }, "partner": {}, "product_type": { "type": "string", "example": "Other" }, "is_enterprise": { "type": "boolean", "example": false, "default": true }, "is_payfac": { "type": "boolean", "example": false, "default": true }, "is_sandbox": { "type": "boolean", "example": false, "default": true }, "fm_billing_schedule_id": {}, "fee_reconciliation_payment_method_id": {}, "welcome_email_sent_at": { "type": "string", "format": "date-time" }, "created_at": { "type": "string", "example": "2021-07-14 18:53:52" }, "updated_at": { "type": "string", "example": "2021-07-14 18:53:52" }, "deleted_at": { "type": "string" }, "brand": { "type": "string", "example": "fattmerchant" }, "risk_hold": { "type": "boolean", "example": false, "default": true }, "branding": { "type": "string" }, "allow_ach": { "type": "boolean", "example": false, "default": true }, "is_portal": { "type": "boolean", "example": false, "default": true }, "is_flat_rate": { "type": "boolean", "example": false, "default": true }, "allow_credits": { "type": "boolean", "example": false, "default": true }, "allow_terminal": { "type": "boolean", "example": false, "default": true }, "gateways": { "type": "array" }, "is_surcharge_enabled": { "type": "boolean", "example": false, "default": true }, "is_trust": { "type": "boolean", "example": false, "default": true }, "users": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "c3a7f735-a8fa-4ca1-937d-d0f2b76ba44b" }, "system_admin": { "type": "boolean", "example": false, "default": true }, "name": { "type": "string", "example": "Test user" }, "email": { "type": "string", "example": "payments@test.io" }, "email_verification_sent_at": { "type": "string", "format": "date-time" }, "email_verified_at": { "type": "string", "format": "date-time" }, "is_api_key": { "type": "boolean", "example": false, "default": true }, "options": {}, "acknowledgments": { "type": "object", "properties": { "setPassword": { "type": "boolean", "example": true, "default": true } } }, "created_at": { "type": "string", "example": "2021-07-14 18:51:27" }, "updated_at": { "type": "string", "example": "2021-07-14 18:53:16" }, "deleted_at": { "type": "string", "format": "date-time" }, "brand": { "type": "string", "example": "fattmerchant" }, "gravatar": { "type": "string", "example": "//www.gravatar.com/avatar/c75f409ceae6d2a2ca1efdc2a313236f" }, "team_admin": { "type": "boolean", "example": true, "default": true }, "team_enabled": { "type": "boolean", "example": true, "default": true }, "team_role": { "type": "string", "example": "admin" }, "merchant_options": { "type": "array" }, "is_default": { "type": "boolean", "example": false, "default": true }, "brands": { "type": "array", "items": { "type": "string", "example": "fattmerchant" } }, "pivot": { "type": "object", "properties": { "merchant_id": { "type": "string", "example": "65649c08-71be-4745-a437-c265df8f3ed3" }, "user_id": { "type": "string", "example": "c3a7f735-a8fa-4ca1-937d-d0f2b76ba44b" }, "is_default": { "type": "boolean", "example": false, "default": true }, "team_role": { "type": "string", "example": "admin" }, "deleted_at": { "type": "string", "format": "date-time" }, "merchant_options": { "type": "array" }, "created_at": { "type": "string", "example": "2021-07-14 18:53:53" }, "updated_at": { "type": "string", "example": "2021-07-14 18:53:53" } } } } } } } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "{}" } }, "schema": { "type": "object", "properties": {} } } } } }, "deprecated": false, "security": [ { "PartnerApiKey": [] } ] } }, "/merchant/{id}/registration": { "get": { "summary": "Get Merchant Registration Data", "description": "Retrieves the registration data used by our underwriting team during onboarding.", "operationId": "get-merchant-registration-data", "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true, "description": "ID of the merchant. " } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "" }, "Response": { "summary": "Response", "value": { "merchant_id": "0bb5b5a0-807b-4946-a911-cf6dd92aa9d8", "user_id": "user1", "electronic_signature": null, "credit_inquiry_electronic_signature": null, "application_agreed_at": null, "countersigned_at": null, "signature_status": null, "application_status": null, "underwriting_status": null, "underwriting_substatuses": null, "underwriting_note": null, "meta": { "ownership_percentage": "50", "owner_citizenship": "USA", "representatives": [ { "title": "CFO", "date_of_birth": "01/01/1990", "ssn": "592611899", "citizenship": "USA", "first_name": "Marcus", "last_name": "Reid", "type": "Beneficial Owner", "ownership_percentage": "50", "email": "demo@fattmerchant.com", "phone": "(123) 456-7890", "address_1": "5890 East Colfax Avenue", "address_2": "", "address_city": "Denver", "address_state": "CO", "address_country": "USA", "address_zip": "80220", "drivers_license_id": "0987654321", "drivers_license_state": "CO" } ] }, "first_name": "Lucia", "last_name": "Moore", "email": "demo@fattmerchant.com", "title": "CEO", "company_type": "L", "entity_ownership_type": "PRIVATE", "phone_number": "1234567890", "source": null, "promo_code": null, "ref_code": null, "plan": "portal", "fm_pc_name": null, "business_legal_name": "Olympus Test Onboarding Merchant", "business_dba": "Olympus Test Onboarding Merchant", "business_website": "olympustest.com", "business_fax": null, "business_email": "demo@fattmerchant.com", "business_address_1": "123 Main Street", "business_address_2": null, "business_address_city": "Broomfield", "business_address_state": "CO", "business_address_zip": "80020", "business_address_country": "USA", "owner_address_1": "1234 West Cedar Avenue", "owner_address_2": "", "owner_address_city": "Denver", "owner_address_state": "CO", "owner_address_zip": "80223", "owner_address_country": "USA", "user_ip": "127.0.0.1", "user_ssn": "592611800", "user_dob": "01/01/1990", "business_phone_number": "1234567890", "business_tax_id": "789029921", "business_open_date": "01/01/2024", "job_title": "CEO", "refund_policy": "T", "reason_for_applying": "Never Accepted Cards Before", "service_you_provide": "Chiropractors", "annual_volume": "100000.00", "avg_trans_size": "500.00", "highest_trans_amount": "2000.00", "card_present_percent": "0", "card_not_present_percent": "100", "card_swiped_percent": "50", "moto_percent": "0", "b2b_percent": "0", "bank_routing_number": "021000021", "bank_account_number": "1234567890123", "bank_account_owner_name": "Lucia Moore", "secondary_bank_routing_number": null, "secondary_bank_account_number": null, "secondary_bank_account_owner_name": "Lucia Moore", "secondary_bank_account_type": null, "secondary_bank_account_purpose": null, "principal_owners_name": "Lucia Moore", "chosen_plan": null, "chosen_processing_method": "api", "plan_txamnt": ".15", "plan_dcamnt": "3.0", "plan_ach_cap": "10", "plan_ach_txamnt": "0", "plan_ach_dcamnt": "1", "plan_nabu": null, "referred_by": null, "created_at": "2025-06-05 20:38:33", "updated_at": "2025-06-05 20:51:58", "deleted_at": null, "paper_statement": false, "num_of_locs": "", "addl_loc": false, "addl_loc_main_mid": "", "internet": "50", "international": "0", "mcc": "8041", "proc_change": "NOT_NOW_PROC", "seasonal_flag": false, "seasonal_months": "", "bus_type": "1", "sub_bus_type": "", "special_proc": "", "pos_software_publisher": "", "pos_software_name": "", "pos_software_version": "", "site_inspection": "", "location_type": "", "network": "", "bank_account_type": "", "mcc_addl_desc": "", "business_location_address_1": "123 Main Street", "business_location_address_2": null, "business_location_address_city": "Broomfield", "business_location_address_country": "USA", "business_location_address_state": "CO", "business_location_address_zip": "80020", "business_location_email": null, "business_location_fax": null, "business_location_phone_number": "1234567890", "note": null, "credit_qual_disc_rate": "3.0", "credit_qual_trans_fee": ".15", "credit_mid_disc_rate": "3.0", "credit_mid_trans_fee": ".15", "credit_non_disc_rate": "3.0", "credit_non_trans_fee": ".15", "amex_qual_disc_rate": "3.0", "amex_qual_trans_fee": ".15", "amex_mid_disc_rate": "3.0", "amex_mid_trans_fee": ".15", "amex_non_disc_rate": "3.0", "amex_non_trans_fee": ".15", "is_flat_rate": true, "pricing_plan": "stax-300-surcharging-CNP-291", "finix_merchant_id": null, "finix_identity_id": null, "annual_gross_ach_revenue": "40000.00", "avg_ach_transaction": "500.00", "largest_ach_transaction": "2000.00", "cp_transaction_rate": "3.0", "cp_per_item_rate": ".15", "cp_amex_rate": "3.0", "cp_amex_per_item_rate": ".15", "warnings": [], "merchant_autoverification_authorization": { "ip": "127.0.0.1", "email": "demo@fattmerchant.com", "user_id": "user1", "timestamp": "2024-09-05 21:10:53", "browser_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/128.0.0.0 Safari/537.36" }, "chargeback_percent": null, "annual_gross_shopping_cart_revenue": "100000.00", "avg_shopping_cart_transaction": "500.00", "largest_shopping_cart_transaction": "2000.00", "shopping_cart_card_present_percent": "0", "shopping_cart_b2b_percent": "0", "shopping_cart_international": "0", "cp_credit_surcharge_rate": null, "cnp_credit_surcharge_rate": "3.0", "cp_debit_trans_fee": null, "cnp_debit_trans_fee": ".15", "cp_debit_discount_rate": null, "cnp_debit_discount_rate": "2.91", "field_permissions": null, "drivers_license_id": "1234567890", "drivers_license_state": "CO", "bank_institution_name": null, "external_company_id": "CO11f085aaf0eae5ad424e8a2ceb9f66e0", "secondary_bank_institution_name": null, "registration_source": "enrollment-api", "created_by": "user1", "meta_json": "{\"representatives\": [{\"ssn\": \"592611899\", \"type\": \"Beneficial Owner\", \"email\": \"demo@fattmerchant.com\", \"phone\": \"(123) 456-7890\", \"title\": \"CFO\", \"address_1\": \"5890 East Colfax Avenue\", \"address_2\": \"\", \"last_name\": \"Reid\", \"first_name\": \"Marcus\", \"address_zip\": \"80220\", \"citizenship\": \"USA\", \"address_city\": \"Denver\", \"address_state\": \"CO\", \"date_of_birth\": \"01/01/1990\", \"address_country\": \"USA\", \"drivers_license_id\": \"0987654321\", \"ownership_percentage\": \"50\", \"drivers_license_state\": \"CO\"}], \"owner_citizenship\": \"USA\", \"ownership_percentage\": \"50\"}", "signature_request_id": null, "is_trust": null, "monthly_minimum_fee": null, "monthly_service_fee": null, "fees": null, "pci_compromise_type": null, "paypal_transaction_fee": null, "paypal_per_item_fee": null, "amex_direct_number": null, "amex_direct_required": 0, "files": [ { "id": "b87deb62-6fac-4ce2-9ece-94f56d21bd7b", "merchant_id": "0bb5b5a0-807b-4946-a911-cf6dd92aa9d8", "user_id": "user1", "name": "Document_Merchant_Application__devops-logo.jpg", "path": "onboarding/b87deb62-6fac-4ce2-9ece-94f56d21bd7b.jpg", "public_url": "https://stax-qa-onboarding.s3.us-west-2.amazonaws.com/onboarding/b87deb62-6fac-4ce2-9ece-94f56d21bd7b.jpg", "tag": "onboarding", "meta": { "filesize_bytes": 40396, "filesize": "40.4 kB", "extension": "jpg", "size": { "width": 820, "height": 431 }, "mime": "image/jpeg", "onboardingMagType": "21" }, "created_at": "2025-06-05 20:51:07", "updated_at": "2025-06-05 20:51:17", "deleted_at": null, "registration_document_id": null } ], "brand": "fattmerchant", "underwriting_substatus": null, "empty_required_fields": [], "latest_file_uploaded_at": "2025-06-05 20:51:07", "allow_conditional_approval": true, "merchant": { "id": "0bb5b5a0-807b-4946-a911-cf6dd92aa9d8", "mid": "", "status": "PENDING", "subdomain": "", "company_name": "BlockChyp Test Merchant", "display_name": "BlockChyp Test Merchant", "contact_name": "Lucia Moore", "contact_email": "demo@fattmerchant.com", "contact_phone": "", "address_1": "123 Main Street", "address_2": "", "address_city": "Broomfield", "address_state": "CO", "address_zip": "80020", "hosted_payments_token": "BlockChyp-Test-Merchant-6f3ad2ff616c", "plan": { "id": "f34b8c58-b958-4785-b603-e2f97315afdc", "merchant_id": "0bb5b5a0-807b-4946-a911-cf6dd92aa9d8", "user_id": "user1", "name": "portal", "created_at": "2025-06-05 20:38:33", "updated_at": "2025-06-05 20:38:33" }, "options": { "surcharge_policy": "always_allow", "transaction_limit": null, "ach_transaction_limit": null, "emv_user": null, "emv_password": null, "emv_terminal_id": null, "emv_terminal_secret": null, "hosted_payments_url_long": null, "hosted_payments_note": null, "hosted_payments_success_note": null, "repeat_method_use_limit": null, "repeat_method_use_window": 43200, "level_2_processing": null, "max_webhook_limit_per_event": null, "decline_limit_per_hour": null, "decline_period_grace_period_exp": null }, "notes": "", "currency": [ "USD" ], "gateway_type": "SETTLEMENTS", "vendor_keys": [], "processor": "", "partner": null, "product_type": "Fattpay Online", "is_enterprise": false, "is_payfac": true, "is_sandbox": false, "is_test_mode": 0, "fm_billing_schedule_id": null, "fee_reconciliation_payment_method_id": null, "welcome_email_sent_at": null, "activated_at": null, "created_at": "2025-06-05 20:38:33", "updated_at": "2025-06-05 20:38:33", "deleted_at": null, "brand": "fattmerchant", "risk_hold": false, "merchant_processor_application": "payfac", "reference": null, "branding": null, "allow_ach": false, "allow_paypal": false, "require_address": false, "is_portal": true, "is_flat_rate": true, "allow_credits": false, "allow_terminal": false, "gateways": [ { "name": "engine", "type": "SETTLEMENTS", "processor_mid": null } ], "is_surcharge_enabled": true, "cnp_credit_surcharge_rate": 3, "is_trust": false, "underwriting_status": null, "underwriting_substatuses": null, "allow_cnp_digital_wallet": false } } } }, "schema": { "type": "object", "properties": { "underwriting_status": { "type": "string", "example": "PENDED" }, "underwriting_substatuses": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string", "example": "Volume Clarity" } } } }, "annual_volume": { "type": "string", "example": "" }, "avg_trans_size": { "type": "string", "example": "" }, "b2b_percent": { "type": "string", "example": "" }, "bank_routing_number": {}, "bank_account_type": { "type": "string", "example": "" }, "bank_account_number": {}, "bank_account_owner_name": {}, "secondary_bank_routing_number": {}, "secondary_bank_account_number": {}, "secondary_bank_account_owner_name": {}, "secondary_bank_account_type": {}, "secondary_bank_account_purpose": {}, "business_address_1": { "type": "string", "example": "" }, "business_address_2": { "type": "string", "example": "" }, "business_address_city": { "type": "string", "example": "" }, "business_address_country": { "type": "string", "example": "" }, "business_address_state": { "type": "string", "example": "" }, "business_address_zip": { "type": "string", "example": "" }, "business_dba": { "type": "string", "example": "" }, "business_email": { "type": "string", "example": "" }, "business_fax": { "type": "string", "example": "" }, "business_legal_name": { "type": "string", "example": "" }, "business_open_date": { "type": "string", "example": "" }, "business_phone_number": { "type": "string", "example": "" }, "business_tax_id": { "type": "string", "example": "" }, "business_website": { "type": "string", "example": "" }, "card_not_present_percent": { "type": "string", "example": "" }, "card_present_percent": { "type": "string", "example": "" }, "card_swiped_percent": { "type": "string", "example": "" }, "chosen_plan": { "type": "string", "example": "" }, "chosen_processing_method": { "type": "string", "example": "" }, "company_type": { "type": "string", "example": "" }, "email": { "type": "string", "example": "" }, "first_name": { "type": "string", "example": "" }, "highest_trans_amount": { "type": "string", "example": "" }, "international": { "type": "string", "example": "" }, "internet": { "type": "string", "example": "" }, "job_title": { "type": "string", "example": "" }, "last_name": { "type": "string", "example": "" }, "location_type": { "type": "string", "example": "" }, "meta": { "type": "object", "properties": { "ownership_percentage": { "type": "integer", "example": 60, "default": 0 }, "owner_citizenship": { "type": "string", "example": "ALA" }, "representatives": { "type": "array", "items": { "type": "object", "properties": { "title": { "type": "string", "example": "" }, "date_of_birth": { "type": "string", "example": "" }, "ssn": { "type": "string", "example": "" }, "first_name": { "type": "string", "example": "" }, "last_name": { "type": "string", "example": "" }, "type": { "type": "string", "example": "" }, "ownership_percentage": { "type": "integer", "example": 40, "default": 0 }, "email": { "type": "string", "example": "" }, "phone": { "type": "string", "example": "" }, "address_1": { "type": "string", "example": "" }, "address_2": { "type": "string", "example": "" }, "address_city": { "type": "string", "example": "" }, "address_state": { "type": "string", "example": "" }, "address_zip": { "type": "string", "example": "" }, "citizenship": { "type": "string", "example": "ALA" } } } } } }, "moto_percent": { "type": "string", "example": "" }, "network": { "type": "string", "example": "" }, "owner_address_1": { "type": "string", "example": "" }, "owner_address_2": { "type": "string", "example": "" }, "owner_address_city": { "type": "string", "example": "" }, "owner_address_country": { "type": "string", "example": "" }, "owner_address_state": { "type": "string", "example": "" }, "owner_address_zip": { "type": "string", "example": "" }, "phone_number": { "type": "string", "example": "" }, "plan": { "type": "string", "example": "" }, "principal_owners_name": { "type": "string", "example": "" }, "reason_for_applying": { "type": "string", "example": "" }, "referred_by": { "type": "string", "example": "" }, "refund_policy": { "type": "string", "example": "" }, "seasonal_flag": { "type": "boolean", "example": false, "default": true }, "seasonal_months": { "type": "string", "example": "" }, "service_you_provide": { "type": "string", "example": "" }, "title": { "type": "string", "example": "" }, "user_dob": { "type": "string", "example": "" }, "merchant_id": { "type": "string", "example": "791fc3fa-4534-4617-97b6-d41c9e1ce8da" }, "user_id": { "type": "string", "example": "a01a5f74-cbdb-4704-9e9b-56fd5a8ee7b8" }, "updated_at": { "type": "string", "example": "2019-06-19 21:22:03" }, "created_at": { "type": "string", "example": "2019-06-19 21:22:03" }, "files": { "type": "array" }, "electronic_signature": { "type": "object", "properties": { "html_content": { "type": "string", "example": "I agree to..." }, "ip": { "type": "string", "example": "42.1.1.113" }, "timestamp": { "type": "string", "example": "2019-06-19 21:22:03" }, "user_id": { "type": "string", "example": "a01a5f74-cbdb-4704-9e9b-56fd5a8ee7b8" }, "email": { "type": "string", "example": "john@doe.com" }, "browser_agent": { "type": "string", "example": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_6) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/79.0.3945.88 Safari/537.36" } } } } } } } }, "422": { "description": "422", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"annual_volume\": [\n \"The annual volume may not be greater than 100 characters.\"\n ]\n}" } }, "schema": { "type": "object", "properties": { "annual_volume": { "type": "array", "items": { "type": "string", "example": "The annual volume may not be greater than 100 characters." } } } } } } } }, "deprecated": false, "security": [ { "PartnerApiKey": [] } ] }, "put": { "summary": "Update Merchant Registration Data", "description": "Upserts registration data for a merchant, used during onboarding.", "operationId": "update-merchant-registration-data", "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true, "description": "ID of the merchant" } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "email": { "type": "string", "description": "100 character max. Merchant email address." }, "first_name": { "type": "string", "description": "Merchant owner/signer first name. 100 character max." }, "last_name": { "type": "string", "description": "Merchant owner/signer last name. 100 character max." }, "refund_policy": { "type": "string", "enum": [ "'N'", "'E'", "'T'", "'O'" ], "description": "Refund policy. N: No Refunds, E: Merchandise Exchange Only, T: 30 Days or Fewer, O: Other" }, "business_fax": { "type": "string", "description": "Merchant fax number. format: (999) 999-9999, 9999999999, 999-999-9999." }, "business_legal_name": { "type": "string", "description": "Merchant business legal name. 100 character max." }, "business_dba": { "type": "string", "description": "Merchant business 'Doing Business As' name (should be same as legal name if no dba)." }, "business_website": { "type": "string", "description": "merchant business website address (include http://). 100 characters max." }, "business_phone_number": { "type": "string", "description": "Merchant business phone number, format: (999) 999-9999, 9999999999, 999-999-9999." }, "business_address_1": { "type": "string", "description": "Merchant business address line 1.100 characters max." }, "business_address_2": { "type": "string", "description": "merchant business address line 2 (optional if no address line 2). 100 characters max." }, "business_address_city": { "type": "string", "description": "Merchant business city." }, "business_address_state": { "type": "string", "description": "The two letter abbreviation of the state." }, "business_address_zip": { "type": "string", "description": "Merchant business zip" }, "business_address_country": { "type": "string", "description": "Merchant business country 2 characters." }, "business_location_address_1": { "type": "string", "description": "Merchant business address line 1 (if no secondary billing address, this field should be a duplicate of business_address_1)" }, "business_location_address_2": { "type": "string", "description": "Merchant business address line 2 (if no secondary billing address, this field should be a duplicate of business_address_2)" }, "business_location_address_city": { "type": "string", "description": "Merchant business city (if no secondary billing address, this field should be a duplicate of business_address_city)" }, "business_location_address_state": { "type": "string", "description": "Merchant business state two letters (if no secondary billing address, this field should be a duplicate of business_address_state)" }, "business_location_address_zip": { "type": "string", "description": "Merchant business zip (if no secondary billing address, this field should be a duplicate of business_address_zip)." }, "business_location_address_country": { "type": "string", "description": "Merchant business country iso alpha-2(if no secondary billing address, this field should be a duplicate of business_address_country)." }, "business_location_phone_number": { "type": "string", "description": "Merchant business phone number, format: (999) 999-9999 (if no secondary billing address, this field should be a duplicate of business_address_phone)." }, "business_open_date": { "type": "string", "description": "Merchant business open date. Format MM/DD/YYYY." }, "company_type": { "type": "string", "enum": [ "A", "G", "S", "F", "L", "E", "P", "V", "B", "R" ], "description": "A: Association/Estate/Trust, G: Government (Federal/State/Local), S: Individual/Sole Proprietor, F: Financial Institution, L: LLC (Limited-Liability Corporation), E: Tax-Exempt Organization (501C), P: Partnership, V: Private Corporation, B: Public Corporation, R: SEC-Registered Entity." }, "business_tax_id": { "type": "string", "description": "Merchant business tax id. Format: 12-3456789." }, "annual_volume": { "type": "string", "description": "Merchant's annual credit card only volume." }, "annual_gross_ach_revenue": { "type": "string", "description": "Merchant's annual ACH volume. Can be null." }, "avg_trans_size": { "type": "string", "description": "Merchant's credit card average transaction size." }, "avg_ach_transaction": { "type": "string", "description": "Merchant's average ACH transaction size. Can be null." }, "highest_trans_amount": { "type": "string", "description": "Merchant's reported highest credit card transaction amount." }, "largest_ach_transaction": { "type": "string", "description": "Merchant's reported highest ACH transaction amount. Can be null." }, "card_present_percent": { "type": "string", "description": "Merchant volume card present percent eg: 50 (ex. Terminal transactions where card is physically present at time of transaction)" }, "card_swiped_percent": { "type": "string", "description": "Merchant volume of card swiped transactions. percent eg 50. Can be null." }, "card_not_present_percent": { "type": "string", "description": "Merchant volume not present, e.g., 15 (e.g., transactions taken on the website where the user enters card information into a form)." }, "moto_percent": { "type": "string", "description": "Merchant volume percentage taken over moto (mail order telephone order) -- typically the same value as card_not_present_percent." }, "internet": { "type": "string", "description": "Merchant volume percentage taken over the internet." }, "b2b_percent": { "type": "string", "description": "The merchant business to business volume percentage" }, "international": { "type": "string", "description": "The merchant international volume percentage." }, "bank_routing_number": { "type": "string", "description": "The billing bank routing number." }, "bank_account_number": { "type": "string", "description": "The billing bank account number." }, "bank_account_owner_name": { "type": "string", "description": "The billing bank account owner name." }, "pricing_plan": { "type": "string", "description": "IMPORTANT: Partners only. Please reach out to your account manager or POC for information on your pricing plan option(s)." }, "proc_change": { "type": "string", "enum": [ "PROC_CHANGE", "NOT_NOW_PROC" ], "description": " Has merchant processed before or are they not currently processing. PROC_CHANGE: merchant is currently processing with a different processor and needs to change processors. NOT_NOW_PROC: merchant is not currently processing payments" }, "mcc": { "type": "string", "description": "IMPORTANT: Partners only. Please reach out to your account manager or POC for information on mcc codes if needed." }, "service_you_provide": { "type": "string", "description": "The merchant business main service/ product description. Max 200 characters." }, "bus_type": { "type": "string", "description": "Business type: 1: Retail, 11: Restaurant, 12: Moto, 18: Internet", "enum": [ "1", "11", "12", "18" ] }, "sub_bus_type": { "type": "string", "description": "Sub business type: 19: Retail.key entered, 45: Moto, 13: Dial pay capture, 36: Interchange plus", "enum": [ "19", "45", "13", "36" ] }, "principal_owners_name": { "type": "string", "description": "The merchant owner principal first and last name." }, "job_title": { "type": "string", "description": "The merchant owner title (same as title)." }, "title": { "type": "string", "description": "The merchant owner title (same as job_title)." }, "user_dob": { "type": "string", "description": "Owner date of birth. Format: MM/DD/YYYY" }, "drivers_license_id": { "type": "string", "description": "Driver's license id of the owner/signer. Can be null." }, "drivers_license_state": { "type": "string", "description": "The state where driver's license of the owner/signer was issued (Please send in a 2-character state code. ex. \"FL\" for Florida). Can be null." }, "phone_number": { "type": "string", "description": "Owner/signer phone number, format: (999) 999-9999." }, "owner_address_1": { "type": "string" }, "owner_address_2": { "type": "string" }, "owner_address_city": { "type": "string" }, "owner_address_state": { "type": "string", "description": "Owner/signer's 2-character state." }, "owner_address_country": { "type": "string", "description": "Owner/signer's 2 character state." }, "owner_address_zip": { "type": "string", "description": "Postal / Zip code." }, "user_ssn": { "type": "string", "description": "Primary owner/signer social security number." }, "note": { "type": "string", "description": "max 100 characters." }, "electronic_signature": { "properties": { "html_content": { "type": "string", "description": " Legal content displayed to user (talk to your Partner Success Team for more information)." }, "ip": { "type": "string", "description": "ipv4, ipv6" }, "user_id": { "type": "string", "description": "User_id or user email associated with the merchant." }, "email": { "type": "string", "description": "User email associated with the merchant." }, "browser_agent": { "type": "string", "description": "\"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_6) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/79.0.3945.88 Safari/537.36\"." } }, "required": [], "type": "object" }, "credit_inquiry_electronic_signature": { "properties": { "html_content": { "type": "string", "description": "legal content displayed to user which allows Stax to perform soft credit pulls. The credit inquiry must be agreed to independent of the payment processing agreement or any other terms in your application. We recommend having a separate checkbox for the credit inquiry before submitting the application (talk to your Partner Success Team for more information)\"You understand that by clicking on the checkbox associated with this notice, you are providing \u2018written instructions\u2019 to Stax and any lender to whom Stax forwards this application, in connection with this application, for commercial lending under the Fair Credit Reporting Act, hereby authorizing Stax and any such lender to obtain information from your personal credit report or other information from Experian. You authorize Stax and any such lender to obtain such information solely in connection with this application for commercial lending.\"" }, "ip": { "type": "string", "description": " ipv4, ipv6" }, "user_id": { "type": "string", "description": "User ID or user email associated with the merchant." }, "email": { "type": "string", "description": "User email associated with the merchant." }, "browser_agent": { "type": "string", "description": "e.g. \"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_6) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/79.0.3945.88 Safari/537.36\"." } }, "required": [], "type": "object" }, "meta": { "properties": { "owner_percentage": { "type": "string", "description": "The ownership percentage for primary owner, eg. 50" }, "owner_citizenship": { "type": "string", "description": "The ownership 3 character ISO country code for primary owner eg ALA." }, "representatives": { "properties": { "title": { "type": "string", "description": "Position within the organization." }, "date_of_birth": { "type": "string", "description": "DOB format: MM/DD/YYYY" }, "ssn": { "type": "string", "description": "Representative social security number." }, "drivers_license_id": { "type": "string", "description": "Driver's license id of the representative. Can be NULL." }, "drivers_license_state": { "type": "string", "description": "The state where driver's license was issued (Please send in a 2-character state code. ex. \"FL\" for Florida)." }, "first_name": { "type": "string", "description": "Name of representative." }, "last_name": { "type": "string", "description": "Surname of representative." }, "type": { "type": "string", "description": "Type of owner.", "enum": [ "Beneficial Owner", "Guarantor" ] }, "ownership_percentage": { "type": "string", "description": "Ownership percentage for company representatives, eg. 50" }, "email": { "type": "string", "description": "Representative email." }, "phone": { "type": "string", "description": "Representative phone number." }, "address_1": { "type": "string" }, "address_2": { "type": "string" }, "address_city": { "type": "string" }, "address_state": { "type": "string", "description": "State (two letter) (ex. FL)." }, "address_zip": { "type": "string" }, "citizenship": { "type": "string", "description": "3 character ISO country code for company representative, eg. ALA." } }, "required": [], "type": "object", "description": "Any additional representatives (required for any owner/representative with 25% or more ownership)." }, "{partnername}_created_at": { "type": "string", "description": "The created at date with the ISV software. Format YYYY-MM-DD." }, "{partnername}_netnew": { "type": "boolean", "description": " Indicates if the merchant is a brand new merchant for the ISV. " }, "{partnername}_months_processing": { "type": "string", "description": "Indicates the amount of months the merchant has processed payments with another payment solution in the ISV. If none, indicate \"0\"" } }, "required": [], "type": "object" }, "files": { "type": "string", "description": "See Add File To Merchant Registration route for more information." }, "autoverify": { "type": "boolean", "description": "Determines whether or not to run autoverification on the registration record. See \"Get Registration Documents\" for more info on autoverification." } } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"annual_volume\": \"\",\n \"avg_trans_size\": \"\",\n \"b2b_percent\": \"\",\n \"bank_account_type\": \"\",\n \"business_address_1\": \"\",\n \"business_address_2\": \"\",\n \"business_address_city\": \"\",\n \"business_address_country\": \"\",\n \"business_address_state\": \"\",\n \"business_address_zip\": \"\",\n \"business_dba\": \"\",\n \"business_email\": \"\",\n \"business_fax\": \"\",\n \"business_legal_name\": \"\",\n \"business_open_date\": \"\",\n \"business_phone_number\": \"\",\n \"business_tax_id\": \"\",\n \"business_website\": \"\",\n \"card_not_present_percent\": \"\",\n \"card_present_percent\": \"\",\n \"card_swiped_percent\": \"\",\n \"chosen_plan\": \"\",\n \"chosen_processing_method\": \"\",\n \"company_type\": \"\",\n \"drivers_license_id\": \"M9K778578\",\n \"drivers_license_state\": \"FL\",\n \"email\": \"\",\n \"first_name\": \"\",\n \"highest_trans_amount\": \"\",\n \"international\": \"\",\n \"internet\": \"\",\n \"job_title\": \"\",\n \"last_name\": \"\",\n \"location_type\": \"\",\n \"mcc\": \"1750\",\n \"meta\": {\n \"ownership_percentage\": 60,\n \"owner_citizenship\": \"ALA\",\n \"representatives\": [\n {\n \"title\": \"\",\n \"date_of_birth\": \"\",\n \"ssn\": \"\",\n \"drivers_license_id\": \"M9K778578\",\n \"drivers_license_state\": \"FL\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"type\": \"\",\n \"ownership_percentage\": 40,\n \"email\": \"\",\n \"phone\": \"\",\n \"address_1\": \"\",\n \"address_2\": \"\",\n \"address_city\": \"\",\n \"address_state\": \"\",\n \"address_zip\": \"\",\n \"citizenship\": \"ALA\"\n }\n ],\n \"stax_created_at\": \"2022-06-30\",\n \"stax_netnew\": true,\n \"stax_months_processing\": \"0\"\n },\n \"moto_percent\": \"\",\n \"network\": \"\",\n \"owner_address_1\": \"\",\n \"owner_address_2\": \"\",\n \"owner_address_city\": \"\",\n \"owner_address_country\": \"\",\n \"owner_address_state\": \"\",\n \"owner_address_zip\": \"\",\n \"phone_number\": \"\",\n \"plan\": \"\",\n \"pricing_plan\": \"interchange0-15\",\n \"principal_owners_name\": \"\",\n \"reason_for_applying\": \"\",\n \"referred_by\": \"\",\n \"refund_policy\": \"\",\n \"seasonal_flag\": false,\n \"seasonal_months\": \"\",\n \"service_you_provide\": \"\",\n \"title\": \"\",\n \"user_dob\": \"\",\n \"merchant_id\": \"791fc3fa-4534-4617-97b6-d41c9e1ce8da\",\n \"user_id\": \"a01a5f74-cbdb-4704-9e9b-56fd5a8ee7b8\",\n \"updated_at\": \"2019-06-19 21:22:03\",\n \"created_at\": \"2019-06-19 21:22:03\",\n \"files\": [],\n \"electronic_signature\": {\n \"html_content\": \"I agree to...\",\n \"ip\": \"42.1.1.113\",\n \"timestamp\": \"2019-06-19 21:22:03\",\n \"user_id\": \"a01a5f74-cbdb-4704-9e9b-56fd5a8ee7b8\",\n \"email\": \"john@doe.com\",\n \"browser_agent\": \"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_6) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/79.0.3945.88 Safari/537.36\"\n }\n}" } }, "schema": { "type": "object", "properties": { "annual_volume": { "type": "string", "example": "" }, "avg_trans_size": { "type": "string", "example": "" }, "b2b_percent": { "type": "string", "example": "" }, "bank_account_type": { "type": "string", "example": "" }, "business_address_1": { "type": "string", "example": "" }, "business_address_2": { "type": "string", "example": "" }, "business_address_city": { "type": "string", "example": "" }, "business_address_country": { "type": "string", "example": "" }, "business_address_state": { "type": "string", "example": "" }, "business_address_zip": { "type": "string", "example": "" }, "business_dba": { "type": "string", "example": "" }, "business_email": { "type": "string", "example": "" }, "business_fax": { "type": "string", "example": "" }, "business_legal_name": { "type": "string", "example": "" }, "business_open_date": { "type": "string", "example": "" }, "business_phone_number": { "type": "string", "example": "" }, "business_tax_id": { "type": "string", "example": "" }, "business_website": { "type": "string", "example": "" }, "card_not_present_percent": { "type": "string", "example": "" }, "card_present_percent": { "type": "string", "example": "" }, "card_swiped_percent": { "type": "string", "example": "" }, "chosen_plan": { "type": "string", "example": "" }, "chosen_processing_method": { "type": "string", "example": "" }, "company_type": { "type": "string", "example": "" }, "drivers_license_id": { "type": "string", "example": "M9K778578" }, "drivers_license_state": { "type": "string", "example": "FL" }, "email": { "type": "string", "example": "" }, "first_name": { "type": "string", "example": "" }, "highest_trans_amount": { "type": "string", "example": "" }, "international": { "type": "string", "example": "" }, "internet": { "type": "string", "example": "" }, "job_title": { "type": "string", "example": "" }, "last_name": { "type": "string", "example": "" }, "location_type": { "type": "string", "example": "" }, "mcc": { "type": "string", "example": "1750" }, "meta": { "type": "object", "properties": { "ownership_percentage": { "type": "integer", "example": 60, "default": 0 }, "owner_citizenship": { "type": "string", "example": "ALA" }, "representatives": { "type": "array", "items": { "type": "object", "properties": { "title": { "type": "string", "example": "" }, "date_of_birth": { "type": "string", "example": "" }, "ssn": { "type": "string", "example": "" }, "drivers_license_id": { "type": "string", "example": "M9K778578" }, "drivers_license_state": { "type": "string", "example": "FL" }, "first_name": { "type": "string", "example": "" }, "last_name": { "type": "string", "example": "" }, "type": { "type": "string", "example": "" }, "ownership_percentage": { "type": "integer", "example": 40, "default": 0 }, "email": { "type": "string", "example": "" }, "phone": { "type": "string", "example": "" }, "address_1": { "type": "string", "example": "" }, "address_2": { "type": "string", "example": "" }, "address_city": { "type": "string", "example": "" }, "address_state": { "type": "string", "example": "" }, "address_zip": { "type": "string", "example": "" }, "citizenship": { "type": "string", "example": "ALA" } } } }, "stax_created_at": { "type": "string", "example": "2022-06-30" }, "stax_netnew": { "type": "boolean", "example": true, "default": true }, "stax_months_processing": { "type": "string", "example": "0" } } }, "moto_percent": { "type": "string", "example": "" }, "network": { "type": "string", "example": "" }, "owner_address_1": { "type": "string", "example": "" }, "owner_address_2": { "type": "string", "example": "" }, "owner_address_city": { "type": "string", "example": "" }, "owner_address_country": { "type": "string", "example": "" }, "owner_address_state": { "type": "string", "example": "" }, "owner_address_zip": { "type": "string", "example": "" }, "phone_number": { "type": "string", "example": "" }, "plan": { "type": "string", "example": "" }, "pricing_plan": { "type": "string", "example": "interchange0-15" }, "principal_owners_name": { "type": "string", "example": "" }, "reason_for_applying": { "type": "string", "example": "" }, "referred_by": { "type": "string", "example": "" }, "refund_policy": { "type": "string", "example": "" }, "seasonal_flag": { "type": "boolean", "example": false, "default": true }, "seasonal_months": { "type": "string", "example": "" }, "service_you_provide": { "type": "string", "example": "" }, "title": { "type": "string", "example": "" }, "user_dob": { "type": "string", "example": "" }, "merchant_id": { "type": "string", "example": "791fc3fa-4534-4617-97b6-d41c9e1ce8da" }, "user_id": { "type": "string", "example": "a01a5f74-cbdb-4704-9e9b-56fd5a8ee7b8" }, "updated_at": { "type": "string", "example": "2019-06-19 21:22:03" }, "created_at": { "type": "string", "example": "2019-06-19 21:22:03" }, "files": { "type": "array" }, "electronic_signature": { "type": "object", "properties": { "html_content": { "type": "string", "example": "I agree to..." }, "ip": { "type": "string", "example": "42.1.1.113" }, "timestamp": { "type": "string", "example": "2019-06-19 21:22:03" }, "user_id": { "type": "string", "example": "a01a5f74-cbdb-4704-9e9b-56fd5a8ee7b8" }, "email": { "type": "string", "example": "john@doe.com" }, "browser_agent": { "type": "string", "example": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_6) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/79.0.3945.88 Safari/537.36" } } } } } } } }, "422": { "description": "422", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"annual_volume\": [\n \"The annual volume may not be greater than 100 characters.\"\n ]\n}" } }, "schema": { "type": "object", "properties": { "annual_volume": { "type": "array", "items": { "type": "string", "example": "The annual volume may not be greater than 100 characters." } } } } } } } }, "deprecated": false, "security": [ { "PartnerApiKey": [] } ] } }, "/underwriting/merchant/{id}/registration/documents": { "get": { "summary": "Get Registration Documents", "description": "Retrieves the registration documents required for a merchant's registration.", "operationId": "get-registration-documents", "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "user_id", "in": "query", "description": "Filters registration documents by the user id of the user who manually created this registration document.", "schema": { "type": "string" } }, { "name": "subject", "in": "query", "description": "Filters registration documents by the given subject.", "schema": { "type": "string", "enum": [ "business", "principal_owner", "beneficial_owner_1", "beneficial_owner_2", "beneficial_owner_3", "beneficial_owner_4" ] } }, { "name": "type", "in": "query", "description": "Filters registration documents by the given type.", "schema": { "type": "string", "enum": [ "3_MONTHS_STATEMENTS", "ARTICLES_ORGANIZATION", "BUSINESS_DOCUMENT", "BUSINESS_LICENSE", "UTILITY_BILL", "LEASE", "DRIVERS_LICENSE", "GOVERNMENT_ID", "MARKETING_MATERIAL", "SS4", "147c3", "SSN", "VOID_CHECK", "BANK_LETTER" ] } }, { "name": "is_enabled", "in": "query", "description": "Filters registration documents by whether or not they are enabled", "schema": { "type": "boolean", "default": true } }, { "name": "fill_missing", "in": "query", "description": "Whether or not to calculate and fill the response with all registration documents for this registration record regardless of if they exist or not.", "schema": { "type": "boolean", "default": false } }, { "name": "group_by", "in": "query", "description": "Groups registration documents by the given property.", "schema": { "type": "string", "enum": [ "registration_audit_log_id", "user_id", "subject", "type", "required_by", "is_enabled" ] } } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"business\": [\n {\n \"id\": \"RD11eb38a5249891f0a8b919df3793afa4\",\n \"registration_id\": \"pending\",\n \"registration_audit_log_id\": \"cdc89a24-caad-46a8-9680-10f71adf1ef7\",\n \"user_id\": \"user\",\n \"subject\": \"business\",\n \"type\": \"ARTICLES_ORGANIZATION,BUSINESS_DOCUMENT\",\n \"required_by\": \"autoverify\",\n \"is_enabled\": true,\n \"meta\": {\n \"verification_results\": {\n \"name\": \"giact_gidentify_business\",\n \"message\": \"Identification failed\",\n \"success\": false\n }\n },\n \"created_at\": \"2020-12-07 03:59:09\",\n \"updated_at\": \"2020-12-17 07:17:07\",\n \"title\": \"Articles of Organization or Official Business Doc\",\n \"files\": [\n {\n \"id\": \"9bc64deb-4fe8-47c4-be38-ce63b0912373\",\n \"merchant_id\": \"pending\",\n \"user_id\": \"user\",\n \"name\": \"BusinessArticlesofOrganization.pdf\",\n \"path\": \"onboarding/9bc64deb-4fe8-47c4-be38-ce63b0912373.pdf\",\n \"public_url\": \"https://fake-bucket.s3.us-west-2.amazonaws.com/onboarding/9bc64deb-4fe8-47c4-be38-ce63b0912373.pdf\",\n \"tag\": \"onboarding\",\n \"meta\": {\n \"filesize_bytes\": 3028,\n \"filesize\": \"0.03 kB\",\n \"extension\": \"pdf\",\n \"size\": null,\n \"mime\": \"application/pdf\",\n \"onboardingMagType\": \"1\"\n },\n \"created_at\": \"2020-12-11T14:32:15.000Z\",\n \"updated_at\": \"2020-12-17T20:41:26.000Z\",\n \"deleted_at\": null\n }\n ]\n },\n {\n \"id\": \"RD11eb3bbd83ac0a80828f2b181cd9c9d0\",\n \"registration_id\": \"pending\",\n \"registration_audit_log_id\": \"6db8dede-ad7c-465a-9e91-1125e9bb158a\",\n \"user_id\": \"user\",\n \"subject\": \"business\",\n \"type\": \"SS4,147c3\",\n \"required_by\": \"user\",\n \"is_enabled\": true,\n \"meta\": {\n \"verification_results\": {\n \"name\": \"tincheck_business\",\n \"message\": \"TIN/EIN passed\",\n \"success\": true\n }\n },\n \"created_at\": \"2020-12-11 02:31:10\",\n \"updated_at\": \"2020-12-17 07:17:06\",\n \"title\": \"SS4 or 147c3\",\n \"files\": []\n },\n {\n \"id\": \"RD11eb3bbd85936820828f2b181cd9c9d0\",\n \"registration_id\": \"pending\",\n \"registration_audit_log_id\": null,\n \"user_id\": \"user\",\n \"subject\": \"business\",\n \"type\": \"VOID_CHECK,BANK_LETTER\",\n \"required_by\": \"user\",\n \"is_enabled\": true,\n \"meta\": null,\n \"created_at\": \"2020-12-11 02:31:14\",\n \"updated_at\": \"2020-12-17 07:17:07\",\n \"title\": \"Void Check or Signed Bank Letter\",\n \"files\": []\n },\n {\n \"id\": \"RD11eb3bbd86740420828f2b181cd9c9d0\",\n \"registration_id\": \"pending\",\n \"registration_audit_log_id\": null,\n \"user_id\": \"user\",\n \"subject\": \"business\",\n \"type\": \"BUSINESS_LICENSE,UTILITY_BILL,LEASE\",\n \"required_by\": \"user\",\n \"is_enabled\": true,\n \"meta\": null,\n \"created_at\": \"2020-12-11 02:31:15\",\n \"updated_at\": \"2020-12-17 07:17:08\",\n \"title\": \"Business License, Utility Bill or Lease\",\n \"files\": []\n },\n {\n \"id\": \"RD11eb3bbd8752f270828f2b181cd9c9d0\",\n \"registration_id\": \"pending\",\n \"registration_audit_log_id\": null,\n \"user_id\": \"user\",\n \"subject\": \"business\",\n \"type\": \"MARKETING_MATERIAL\",\n \"required_by\": \"user\",\n \"is_enabled\": true,\n \"meta\": null,\n \"created_at\": \"2020-12-11 02:31:17\",\n \"updated_at\": \"2020-12-17 07:17:08\",\n \"title\": \"Marketing Materials\",\n \"files\": []\n },\n {\n \"id\": \"RD11eb3e25024747b08dcae1688ccea290\",\n \"registration_id\": \"pending\",\n \"registration_audit_log_id\": null,\n \"user_id\": \"user\",\n \"subject\": \"business\",\n \"type\": \"3_MONTHS_STATEMENTS\",\n \"required_by\": \"autoverify\",\n \"is_enabled\": true,\n \"meta\": {\n \"tooltip\": \"If past processing statements are unavailable, please upload past 3 months of bank statements.\",\n \"description\": \"Internal Verification\",\n \"verification_results\": {\n \"name\": \"internal-check_card-present-percent_business\",\n \"message\": \"card_present_percent less than 80%\",\n \"success\": false\n }\n },\n \"created_at\": \"2020-12-14 03:57:03\",\n \"updated_at\": \"2020-12-17 07:17:09\",\n \"title\": \"3 Months of Previous Processing Statements\",\n \"files\": []\n }\n ],\n \"principal_owner\": [\n {\n \"id\": \"RD11eb38a524992e30a8b919df3793afa4\",\n \"registration_id\": \"pending\",\n \"registration_audit_log_id\": \"42022cf7-a4ac-4842-ad44-8ab7a5ce4d2c\",\n \"user_id\": \"user\",\n \"subject\": \"principal_owner\",\n \"type\": \"DRIVERS_LICENSE,GOVERNMENT_ID\",\n \"required_by\": \"autoverify\",\n \"is_enabled\": true,\n \"meta\": {\n \"verification_results\": {\n \"name\": \"giact_gidentify_principal_owner\",\n \"message\": \"Identification failed\",\n \"success\": false\n }\n },\n \"created_at\": \"2020-12-07 03:59:09\",\n \"updated_at\": \"2020-12-17 07:17:12\",\n \"title\": \"Drivers License or Other Government Issued ID\",\n \"files\": []\n },\n {\n \"id\": \"RD11eb38a5249fe4f0a8b919df3793afa4\",\n \"registration_id\": \"pending\",\n \"registration_audit_log_id\": \"49cc416b-32f2-4bd6-985e-8045a09e4901\",\n \"user_id\": \"user\",\n \"subject\": \"principal_owner\",\n \"type\": \"SSN\",\n \"required_by\": \"autoverify\",\n \"is_enabled\": true,\n \"meta\": {\n \"verification_results\": {\n \"name\": \"tincheck_principal_owner\",\n \"message\": \"TIN/SSN invalid\",\n \"success\": false\n }\n },\n \"created_at\": \"2020-12-07 03:59:10\",\n \"updated_at\": \"2020-12-10 10:43:18\",\n \"title\": \"SSN Card\",\n \"files\": [\n {\n \"id\": \"b23f72a5-de72-490c-bc7a-cdc06b535f67\",\n \"merchant_id\": \"pending\",\n \"user_id\": \"user\",\n \"name\": \"PrincipalOwnerSocialSecurityCard.pdf\",\n \"path\": \"onboarding/b23f72a5-de72-490c-bc7a-cdc06b535f67.pdf\",\n \"public_url\": \"https://fake-bucket.s3.us-west-2.amazonaws.com/onboarding/b23f72a5-de72-490c-bc7a-cdc06b535f67.pdf\",\n \"tag\": \"onboarding\",\n \"meta\": {\n \"filesize_bytes\": 3028,\n \"filesize\": \"0.03 kB\",\n \"extension\": \"pdf\",\n \"size\": null,\n \"mime\": \"application/pdf\",\n \"onboardingMagType\": \"25\"\n },\n \"created_at\": \"2020-12-07T15:59:54.000Z\",\n \"updated_at\": \"2020-12-17T20:50:50.000Z\",\n \"deleted_at\": null\n }\n ]\n }\n ],\n \"beneficial_owner_1\": [\n {\n \"id\": \"RD11eb38a524995540a8b919df3793afa4\",\n \"registration_id\": \"pending\",\n \"registration_audit_log_id\": \"203a3b9d-0216-4dc6-8414-5c6c5fc739ff\",\n \"user_id\": \"user\",\n \"subject\": \"beneficial_owner_1\",\n \"type\": \"DRIVERS_LICENSE,GOVERNMENT_ID\",\n \"required_by\": \"autoverify\",\n \"is_enabled\": true,\n \"meta\": {\n \"verification_results\": {\n \"name\": \"giact_gidentify_beneficial_owner_1\",\n \"message\": \"Identification failed\",\n \"success\": false\n }\n },\n \"created_at\": \"2020-12-07 03:59:09\",\n \"updated_at\": \"2020-12-17 07:17:14\",\n \"title\": \"Drivers License or Other Government Issued ID\",\n \"files\": []\n },\n {\n \"id\": \"RD11eb38a524a05a20a8b919df3793afa4\",\n \"registration_id\": \"pending\",\n \"registration_audit_log_id\": \"3af923ab-8bc1-4e38-a2e4-e415f1cd9bab\",\n \"user_id\": \"user\",\n \"subject\": \"beneficial_owner_1\",\n \"type\": \"SSN\",\n \"required_by\": \"autoverify\",\n \"is_enabled\": true,\n \"meta\": {\n \"verification_results\": {\n \"name\": \"tincheck_beneficial_owner_1\",\n \"message\": \"TIN/SSN invalid\",\n \"success\": false\n }\n },\n \"created_at\": \"2020-12-07 03:59:10\",\n \"updated_at\": \"2020-12-17 07:17:14\",\n \"title\": \"SSN Card\",\n \"files\": []\n }\n ],\n \"beneficial_owner_2\": [\n {\n \"id\": \"RD11eb38a5249c1460a8b919df3793afa4\",\n \"registration_id\": \"pending\",\n \"registration_audit_log_id\": \"659fbb48-0e31-4807-a07a-372ad5c4e563\",\n \"user_id\": \"user\",\n \"subject\": \"beneficial_owner_2\",\n \"type\": \"DRIVERS_LICENSE,GOVERNMENT_ID\",\n \"required_by\": \"autoverify\",\n \"is_enabled\": true,\n \"meta\": {\n \"verification_results\": {\n \"name\": \"giact_gidentify_beneficial_owner_2\",\n \"message\": \"Identification failed\",\n \"success\": false\n }\n },\n \"created_at\": \"2020-12-07 03:59:10\",\n \"updated_at\": \"2020-12-07 04:03:09\",\n \"title\": \"Drivers License or Other Government Issued ID\",\n \"files\": []\n },\n {\n \"id\": \"RD11eb38a524a08130a8b919df3793afa4\",\n \"registration_id\": \"pending\",\n \"registration_audit_log_id\": \"6d738c3e-2580-483a-97eb-ea30acada2bf\",\n \"user_id\": \"user\",\n \"subject\": \"beneficial_owner_2\",\n \"type\": \"SSN\",\n \"required_by\": \"autoverify\",\n \"is_enabled\": true,\n \"meta\": {\n \"verification_results\": {\n \"name\": \"tincheck_beneficial_owner_2\",\n \"message\": \"TIN/SSN invalid\",\n \"success\": false\n }\n },\n \"created_at\": \"2020-12-07 03:59:10\",\n \"updated_at\": \"2020-12-07 04:03:09\",\n \"title\": \"SSN Card\",\n \"files\": [\n {\n \"id\": \"3317951c-82d1-49e5-857b-dc1a449e9505\",\n \"merchant_id\": \"pending\",\n \"user_id\": \"user\",\n \"name\": \"BeneficialOwner2SocialSecurityCard.pdf\",\n \"path\": \"onboarding/3317951c-82d1-49e5-857b-dc1a449e9505.pdf\",\n \"public_url\": \"https://fake-bucket.s3.us-west-2.amazonaws.com/onboarding/3317951c-82d1-49e5-857b-dc1a449e9505.pdf\",\n \"tag\": \"onboarding\",\n \"meta\": {\n \"filesize_bytes\": 3028,\n \"filesize\": \"0.03 kB\",\n \"extension\": \"pdf\",\n \"size\": null,\n \"mime\": \"application/pdf\",\n \"onboardingMagType\": \"35\"\n },\n \"created_at\": \"2020-12-15T20:54:25.000Z\",\n \"updated_at\": \"2020-12-17T20:47:54.000Z\",\n \"deleted_at\": null\n }\n ]\n }\n ]\n}" } }, "schema": { "type": "object", "properties": { "business": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "RD11eb38a5249891f0a8b919df3793afa4" }, "registration_id": { "type": "string", "example": "pending" }, "registration_audit_log_id": { "type": "string", "example": "cdc89a24-caad-46a8-9680-10f71adf1ef7" }, "user_id": { "type": "string", "example": "user" }, "subject": { "type": "string", "example": "business" }, "type": { "type": "string", "example": "ARTICLES_ORGANIZATION,BUSINESS_DOCUMENT" }, "required_by": { "type": "string", "example": "autoverify" }, "is_enabled": { "type": "boolean", "example": true, "default": true }, "meta": { "type": "object", "properties": { "verification_results": { "type": "object", "properties": { "name": { "type": "string", "example": "giact_gidentify_business" }, "message": { "type": "string", "example": "Identification failed" }, "success": { "type": "boolean", "example": false, "default": true } } } } }, "created_at": { "type": "string", "example": "2020-12-07 03:59:09" }, "updated_at": { "type": "string", "example": "2020-12-17 07:17:07" }, "title": { "type": "string", "example": "Articles of Organization or Official Business Doc" }, "files": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "9bc64deb-4fe8-47c4-be38-ce63b0912373" }, "merchant_id": { "type": "string", "example": "pending" }, "user_id": { "type": "string", "example": "user" }, "name": { "type": "string", "example": "BusinessArticlesofOrganization.pdf" }, "path": { "type": "string", "example": "onboarding/9bc64deb-4fe8-47c4-be38-ce63b0912373.pdf" }, "public_url": { "type": "string", "example": "https://fake-bucket.s3.us-west-2.amazonaws.com/onboarding/9bc64deb-4fe8-47c4-be38-ce63b0912373.pdf" }, "tag": { "type": "string", "example": "onboarding" }, "meta": { "type": "object", "properties": { "filesize_bytes": { "type": "integer", "example": 3028, "default": 0 }, "filesize": { "type": "string", "example": "0.03 kB" }, "extension": { "type": "string", "example": "pdf" }, "size": {}, "mime": { "type": "string", "example": "application/pdf" }, "onboardingMagType": { "type": "string", "example": "1" } } }, "created_at": { "type": "string", "example": "2020-12-11T14:32:15.000Z" }, "updated_at": { "type": "string", "example": "2020-12-17T20:41:26.000Z" }, "deleted_at": {} } } } } } }, "principal_owner": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "RD11eb38a524992e30a8b919df3793afa4" }, "registration_id": { "type": "string", "example": "pending" }, "registration_audit_log_id": { "type": "string", "example": "42022cf7-a4ac-4842-ad44-8ab7a5ce4d2c" }, "user_id": { "type": "string", "example": "user" }, "subject": { "type": "string", "example": "principal_owner" }, "type": { "type": "string", "example": "DRIVERS_LICENSE,GOVERNMENT_ID" }, "required_by": { "type": "string", "example": "autoverify" }, "is_enabled": { "type": "boolean", "example": true, "default": true }, "meta": { "type": "object", "properties": { "verification_results": { "type": "object", "properties": { "name": { "type": "string", "example": "giact_gidentify_principal_owner" }, "message": { "type": "string", "example": "Identification failed" }, "success": { "type": "boolean", "example": false, "default": true } } } } }, "created_at": { "type": "string", "example": "2020-12-07 03:59:09" }, "updated_at": { "type": "string", "example": "2020-12-17 07:17:12" }, "title": { "type": "string", "example": "Drivers License or Other Government Issued ID" }, "files": { "type": "array" } } } }, "beneficial_owner_1": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "RD11eb38a524995540a8b919df3793afa4" }, "registration_id": { "type": "string", "example": "pending" }, "registration_audit_log_id": { "type": "string", "example": "203a3b9d-0216-4dc6-8414-5c6c5fc739ff" }, "user_id": { "type": "string", "example": "user" }, "subject": { "type": "string", "example": "beneficial_owner_1" }, "type": { "type": "string", "example": "DRIVERS_LICENSE,GOVERNMENT_ID" }, "required_by": { "type": "string", "example": "autoverify" }, "is_enabled": { "type": "boolean", "example": true, "default": true }, "meta": { "type": "object", "properties": { "verification_results": { "type": "object", "properties": { "name": { "type": "string", "example": "giact_gidentify_beneficial_owner_1" }, "message": { "type": "string", "example": "Identification failed" }, "success": { "type": "boolean", "example": false, "default": true } } } } }, "created_at": { "type": "string", "example": "2020-12-07 03:59:09" }, "updated_at": { "type": "string", "example": "2020-12-17 07:17:14" }, "title": { "type": "string", "example": "Drivers License or Other Government Issued ID" }, "files": { "type": "array" } } } }, "beneficial_owner_2": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "RD11eb38a5249c1460a8b919df3793afa4" }, "registration_id": { "type": "string", "example": "pending" }, "registration_audit_log_id": { "type": "string", "example": "659fbb48-0e31-4807-a07a-372ad5c4e563" }, "user_id": { "type": "string", "example": "user" }, "subject": { "type": "string", "example": "beneficial_owner_2" }, "type": { "type": "string", "example": "DRIVERS_LICENSE,GOVERNMENT_ID" }, "required_by": { "type": "string", "example": "autoverify" }, "is_enabled": { "type": "boolean", "example": true, "default": true }, "meta": { "type": "object", "properties": { "verification_results": { "type": "object", "properties": { "name": { "type": "string", "example": "giact_gidentify_beneficial_owner_2" }, "message": { "type": "string", "example": "Identification failed" }, "success": { "type": "boolean", "example": false, "default": true } } } } }, "created_at": { "type": "string", "example": "2020-12-07 03:59:10" }, "updated_at": { "type": "string", "example": "2020-12-07 04:03:09" }, "title": { "type": "string", "example": "Drivers License or Other Government Issued ID" }, "files": { "type": "array" } } } } } } } } }, "401": { "description": "401", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"name\": \"UnauthorizedError\",\n \"message\": \"Auth Error\",\n \"code\": \"invalid_token\",\n \"status\": 401,\n \"validation\": {\n \"token\": \"invalid\"\n }\n}" } }, "schema": { "type": "object", "properties": { "name": { "type": "string", "example": "UnauthorizedError" }, "message": { "type": "string", "example": "Auth Error" }, "code": { "type": "string", "example": "invalid_token" }, "status": { "type": "integer", "example": 401, "default": 0 }, "validation": { "type": "object", "properties": { "token": { "type": "string", "example": "invalid" } } } } } } } } }, "deprecated": false, "security": [ { "PartnerApiKey": [] } ] } }, "/team/user/{id}": { "put": { "summary": "Update Team Member's Information", "description": "Allows team admins to change a team members information.", "operationId": "get-team-members-information-copy", "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"id\": \"21a64e9e-3c13-4b85-9f85-67cb4fda808a\",\n \"system_admin\": false,\n \"name\": \"James\",\n \"email\": \"fatttest737@gmail.com\",\n \"email_verification_sent_at\": null,\n \"email_verified_at\": null,\n \"created_at\": \"2017-05-15 19:31:35\",\n \"updated_at\": \"2017-05-15 19:31:35\",\n \"deleted_at\": null,\n \"gravatar\": \"//www.gravatar.com/avatar/52b3ef2ae70945ce0fca14086443dc1a\",\n \"team_role\": \"full\",\n \"team_admin\": false,\n \"team_enabled\": true\n}" } }, "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "21a64e9e-3c13-4b85-9f85-67cb4fda808a" }, "system_admin": { "type": "boolean", "example": false, "default": true }, "name": { "type": "string", "example": "James" }, "email": { "type": "string", "example": "fatttest737@gmail.com" }, "email_verification_sent_at": {}, "email_verified_at": {}, "created_at": { "type": "string", "example": "2017-05-15 19:31:35" }, "updated_at": { "type": "string", "example": "2017-05-15 19:31:35" }, "deleted_at": {}, "gravatar": { "type": "string", "example": "//www.gravatar.com/avatar/52b3ef2ae70945ce0fca14086443dc1a" }, "team_role": { "type": "string", "example": "full" }, "team_admin": { "type": "boolean", "example": false, "default": true }, "team_enabled": { "type": "boolean", "example": true, "default": true } } } } } }, "401": { "description": "401", "content": { "application/json": { "examples": { "Result": { "value": "[\n \"not team admin\"\n]" } }, "schema": { "type": "array", "items": { "type": "string", "example": "not team admin" } } } } }, "404": { "description": "404", "content": { "application/json": { "examples": { "Result": { "value": "[\n \"user not found\"\n]" } }, "schema": { "type": "array", "items": { "type": "string", "example": "user not found" } } } } } }, "deprecated": false }, "get": { "summary": "Get Team Member's Information", "description": "Retrieves the team member that matches the given id.", "operationId": "get-team-members-information", "parameters": [ { "name": "id", "in": "path", "description": "Team members id.", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"id\": \"21a64e9e-3c13-4b85-9f85-67cb4fda808a\",\n \"system_admin\": false,\n \"name\": \"James\",\n \"email\": \"fatttest737@gmail.com\",\n \"email_verification_sent_at\": null,\n \"email_verified_at\": null,\n \"created_at\": \"2017-05-15 19:31:35\",\n \"updated_at\": \"2017-05-15 19:31:35\",\n \"deleted_at\": null,\n \"gravatar\": \"//www.gravatar.com/avatar/52b3ef2ae70945ce0fca14086443dc1a\",\n \"team_role\": \"full\",\n \"team_admin\": false,\n \"team_enabled\": true\n}" } }, "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "21a64e9e-3c13-4b85-9f85-67cb4fda808a" }, "system_admin": { "type": "boolean", "example": false, "default": true }, "name": { "type": "string", "example": "James" }, "email": { "type": "string", "example": "fatttest737@gmail.com" }, "email_verification_sent_at": {}, "email_verified_at": {}, "created_at": { "type": "string", "example": "2017-05-15 19:31:35" }, "updated_at": { "type": "string", "example": "2017-05-15 19:31:35" }, "deleted_at": {}, "gravatar": { "type": "string", "example": "//www.gravatar.com/avatar/52b3ef2ae70945ce0fca14086443dc1a" }, "team_role": { "type": "string", "example": "full" }, "team_admin": { "type": "boolean", "example": false, "default": true }, "team_enabled": { "type": "boolean", "example": true, "default": true } } } } } }, "404": { "description": "404", "content": { "application/json": { "examples": { "Result": { "value": "[\n \"user not found\"\n]" } }, "schema": { "type": "array", "items": { "type": "string", "example": "user not found" } } } } } }, "deprecated": false } }, "/team/registration": { "get": { "summary": "Get Team Registration Data", "description": "Get a registration record for a merchant that is tied to your team.", "operationId": "get-team-registration-data", "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"annual_volume\": \"\",\n \"avg_trans_size\": \"\",\n \"b2b_percent\": \"\",\n \"bank_account_type\": \"\",\n \"business_address_1\": \"\",\n \"business_address_2\": \"\",\n \"business_address_city\": \"\",\n \"business_address_country\": \"\",\n \"business_address_state\": \"\",\n \"business_address_zip\": \"\",\n \"business_dba\": \"\",\n \"business_email\": \"\",\n \"business_fax\": \"\",\n \"business_legal_name\": \"\",\n \"business_open_date\": \"\",\n \"business_phone_number\": \"\",\n \"business_tax_id\": \"\",\n \"business_website\": \"\",\n \"card_not_present_percent\": \"\",\n \"card_present_percent\": \"\",\n \"card_swiped_percent\": \"\",\n \"chosen_plan\": \"\",\n \"chosen_processing_method\": \"\",\n \"company_type\": \"\",\n \"email\": \"\",\n \"first_name\": \"\",\n \"highest_trans_amount\": \"\",\n \"international\": \"\",\n \"internet\": \"\",\n \"job_title\": \"\",\n \"last_name\": \"\",\n \"location_type\": \"\",\n \"meta\": {\n \"ownership_percentage\": 60,\n \"owner_citizenship\": \"ALA\",\n \"representatives\": [\n {\n \"title\": \"\",\n \"date_of_birth\": \"\",\n \"ssn\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"type\": \"\",\n \"ownership_percentage\": 40,\n \"email\": \"\",\n \"phone\": \"\",\n \"address_1\": \"\",\n \"address_2\": \"\",\n \"address_city\": \"\",\n \"address_state\": \"\",\n \"address_zip\": \"\",\n \"citizenship\": \"ALA\"\n }\n ]\n },\n \"moto_percent\": \"\",\n \"network\": \"\",\n \"owner_address_1\": \"\",\n \"owner_address_2\": \"\",\n \"owner_address_city\": \"\",\n \"owner_address_country\": \"\",\n \"owner_address_state\": \"\",\n \"owner_address_zip\": \"\",\n \"phone_number\": \"\",\n \"plan\": \"\",\n \"principal_owners_name\": \"\",\n \"reason_for_applying\": \"\",\n \"referred_by\": \"\",\n \"refund_policy\": \"\",\n \"seasonal_flag\": false,\n \"seasonal_months\": \"\",\n \"service_you_provide\": \"\",\n \"title\": \"\",\n \"user_dob\": \"\",\n \"merchant_id\": \"791fc3fa-4534-4617-97b6-d41c9e1ce8da\",\n \"user_id\": \"a01a5f74-cbdb-4704-9e9b-56fd5a8ee7b8\",\n \"updated_at\": \"2019-06-19 21:22:03\",\n \"created_at\": \"2019-06-19 21:22:03\",\n \"files\": [],\n \"electronic_signature\": {\n \"html_content\": \"I agree to...\",\n \"ip\": \"42.1.1.113\",\n \"timestamp\": \"2019-06-19 21:22:03\",\n \"user_id\": \"a01a5f74-cbdb-4704-9e9b-56fd5a8ee7b8\",\n \"email\": \"john@doe.com\",\n \"browser_agent\": \"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_6) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/79.0.3945.88 Safari/537.36\"\n }\n}" } }, "schema": { "type": "object", "properties": { "annual_volume": { "type": "string", "example": "" }, "avg_trans_size": { "type": "string", "example": "" }, "b2b_percent": { "type": "string", "example": "" }, "bank_account_type": { "type": "string", "example": "" }, "business_address_1": { "type": "string", "example": "" }, "business_address_2": { "type": "string", "example": "" }, "business_address_city": { "type": "string", "example": "" }, "business_address_country": { "type": "string", "example": "" }, "business_address_state": { "type": "string", "example": "" }, "business_address_zip": { "type": "string", "example": "" }, "business_dba": { "type": "string", "example": "" }, "business_email": { "type": "string", "example": "" }, "business_fax": { "type": "string", "example": "" }, "business_legal_name": { "type": "string", "example": "" }, "business_open_date": { "type": "string", "example": "" }, "business_phone_number": { "type": "string", "example": "" }, "business_tax_id": { "type": "string", "example": "" }, "business_website": { "type": "string", "example": "" }, "card_not_present_percent": { "type": "string", "example": "" }, "card_present_percent": { "type": "string", "example": "" }, "card_swiped_percent": { "type": "string", "example": "" }, "chosen_plan": { "type": "string", "example": "" }, "chosen_processing_method": { "type": "string", "example": "" }, "company_type": { "type": "string", "example": "" }, "email": { "type": "string", "example": "" }, "first_name": { "type": "string", "example": "" }, "highest_trans_amount": { "type": "string", "example": "" }, "international": { "type": "string", "example": "" }, "internet": { "type": "string", "example": "" }, "job_title": { "type": "string", "example": "" }, "last_name": { "type": "string", "example": "" }, "location_type": { "type": "string", "example": "" }, "meta": { "type": "object", "properties": { "ownership_percentage": { "type": "integer", "example": 60, "default": 0 }, "owner_citizenship": { "type": "string", "example": "ALA" }, "representatives": { "type": "array", "items": { "type": "object", "properties": { "title": { "type": "string", "example": "" }, "date_of_birth": { "type": "string", "example": "" }, "ssn": { "type": "string", "example": "" }, "first_name": { "type": "string", "example": "" }, "last_name": { "type": "string", "example": "" }, "type": { "type": "string", "example": "" }, "ownership_percentage": { "type": "integer", "example": 40, "default": 0 }, "email": { "type": "string", "example": "" }, "phone": { "type": "string", "example": "" }, "address_1": { "type": "string", "example": "" }, "address_2": { "type": "string", "example": "" }, "address_city": { "type": "string", "example": "" }, "address_state": { "type": "string", "example": "" }, "address_zip": { "type": "string", "example": "" }, "citizenship": { "type": "string", "example": "ALA" } } } } } }, "moto_percent": { "type": "string", "example": "" }, "network": { "type": "string", "example": "" }, "owner_address_1": { "type": "string", "example": "" }, "owner_address_2": { "type": "string", "example": "" }, "owner_address_city": { "type": "string", "example": "" }, "owner_address_country": { "type": "string", "example": "" }, "owner_address_state": { "type": "string", "example": "" }, "owner_address_zip": { "type": "string", "example": "" }, "phone_number": { "type": "string", "example": "" }, "plan": { "type": "string", "example": "" }, "principal_owners_name": { "type": "string", "example": "" }, "reason_for_applying": { "type": "string", "example": "" }, "referred_by": { "type": "string", "example": "" }, "refund_policy": { "type": "string", "example": "" }, "seasonal_flag": { "type": "boolean", "example": false, "default": true }, "seasonal_months": { "type": "string", "example": "" }, "service_you_provide": { "type": "string", "example": "" }, "title": { "type": "string", "example": "" }, "user_dob": { "type": "string", "example": "" }, "merchant_id": { "type": "string", "example": "791fc3fa-4534-4617-97b6-d41c9e1ce8da" }, "user_id": { "type": "string", "example": "a01a5f74-cbdb-4704-9e9b-56fd5a8ee7b8" }, "updated_at": { "type": "string", "example": "2019-06-19 21:22:03" }, "created_at": { "type": "string", "example": "2019-06-19 21:22:03" }, "files": { "type": "array" }, "electronic_signature": { "type": "object", "properties": { "html_content": { "type": "string", "example": "I agree to..." }, "ip": { "type": "string", "example": "42.1.1.113" }, "timestamp": { "type": "string", "example": "2019-06-19 21:22:03" }, "user_id": { "type": "string", "example": "a01a5f74-cbdb-4704-9e9b-56fd5a8ee7b8" }, "email": { "type": "string", "example": "john@doe.com" }, "browser_agent": { "type": "string", "example": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_6) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/79.0.3945.88 Safari/537.36" } } } } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "{}" } }, "schema": { "type": "object", "properties": {} } } } } }, "deprecated": false }, "put": { "summary": "Update Team Registration Data", "description": "", "operationId": "update-team-registration-data", "parameters": [ { "name": "email", "in": "query", "description": "Merchant Email address. Max: 100", "schema": { "type": "string" } }, { "name": "first_name", "in": "query", "description": "Merchant owner/signer first name. Max: 100", "schema": { "type": "string" } }, { "name": "last_name", "in": "query", "description": "Merchant owner/signer last name. Max: 100", "schema": { "type": "string" } }, { "name": "refund_policy", "in": "query", "description": "Merchant business refund policy.", "schema": { "type": "string", "enum": [ "N", "E", "T", "O" ] } }, { "name": "business_fax", "in": "query", "description": "Merchant fax number only digits. Max: 100", "schema": { "type": "integer", "format": "int32" } }, { "name": "business_legal_name", "in": "query", "description": "Merchant legal business name. Max: 100", "schema": { "type": "string" } }, { "name": "business_dba", "in": "query", "description": "Merchant business 'Doing Business As'. Max: 100", "schema": { "type": "string" } }, { "name": "business_website", "in": "query", "description": "Merchants business website. Max: 100", "schema": { "type": "string" } }, { "name": "business_phone_number", "in": "query", "description": "Merchants business phone number, format: (999) 999-9999", "schema": { "type": "string" } }, { "name": "business_address_1", "in": "query", "schema": { "type": "string" } }, { "name": "business_address_2", "in": "query", "schema": { "type": "string" } }, { "name": "business_address_city", "in": "query", "schema": { "type": "string" } }, { "name": "business_address_state", "in": "query", "schema": { "type": "string" } }, { "name": "business_address_zip", "in": "query", "schema": { "type": "string" } }, { "name": "business_address_country", "in": "query", "schema": { "type": "string" } }, { "name": "business_location_address_1", "in": "query", "schema": { "type": "string" } }, { "name": "business_location_address_2", "in": "query", "schema": { "type": "string" } }, { "name": "business_location_address_city", "in": "query", "schema": { "type": "string" } }, { "name": "business_location_address_state", "in": "query", "schema": { "type": "string" } }, { "name": "business_location_address_zip", "in": "query", "schema": { "type": "string" } }, { "name": "business_location_address_country", "in": "query", "schema": { "type": "string" } }, { "name": "business_location_phone_number", "in": "query", "schema": { "type": "string" } }, { "name": "business_open_date", "in": "query", "description": "Merchants business open date format MM/DD/YYYY", "schema": { "type": "string" } }, { "name": "company_type", "in": "query", "schema": { "type": "string", "enum": [ "A", "G", "S", "F", "L", "E", "P", "V", "B", "R" ] } }, { "name": "business_tax_id", "in": "query", "description": "Merchant business tax id. Format: 99-9999999", "schema": { "type": "string" } }, { "name": "annual_volume", "in": "query", "description": "Merchant volume annual annual_volume (Credit Card and ACH combined)", "schema": { "type": "string" } }, { "name": "avg_trans_size", "in": "query", "schema": { "type": "string" } }, { "name": "highest_trans_amount", "in": "query", "schema": { "type": "string" } }, { "name": "card_present_percent", "in": "query", "schema": { "type": "string" } }, { "name": "card_swiped_percent", "in": "query", "schema": { "type": "string" } }, { "name": "card_not_present_percent", "in": "query", "schema": { "type": "string" } }, { "name": "moto_percent", "in": "query", "schema": { "type": "string" } }, { "name": "internet", "in": "query", "schema": { "type": "string" } }, { "name": "b2b_percent", "in": "query", "description": "Merchant business to business volume percentage.", "schema": { "type": "string" } }, { "name": "international", "in": "query", "description": "Merchant international volume percentage.", "schema": { "type": "string" } }, { "name": "bank_routing_number", "in": "query", "description": "Billing bank routing number.", "schema": { "type": "string" } }, { "name": "bank_account_number", "in": "query", "schema": { "type": "string" } }, { "name": "bank_account_owner_name", "in": "query", "schema": { "type": "string" } }, { "name": "pricing_plan", "in": "query", "description": "Partners only. Please reach out to your account manager or POC.", "schema": { "type": "string" } }, { "name": "proc_change", "in": "query", "description": "Merchant processed before or they are not currently processing.", "schema": { "type": "string", "enum": [ "PROC_CHANGE", "NOT_NOW_PROC" ] } }, { "name": "mcc", "in": "query", "description": "Partners only. Please reach out to your account manager or POC.", "schema": { "type": "string" } }, { "name": "service_you_provide", "in": "query", "description": "Merchant business what is sold description.", "schema": { "type": "string" } }, { "name": "bus_type", "in": "query", "description": "1: Retail 11: Restaurant 12: Moto 18: Internet", "schema": { "type": "string", "enum": [ "1", "11", "12", "18" ] } }, { "name": "sub_bus_type", "in": "query", "description": "19: Retail.key entered 45: Moto 13: Dial pay capture 36: Interchange plus", "schema": { "type": "string", "enum": [ "13", "19", "36", "45" ] } }, { "name": "principal_owners_name", "in": "query", "schema": { "type": "string" } }, { "name": "job_title", "in": "query", "description": "Owner Title", "schema": { "type": "string" } }, { "name": "user_dob", "in": "query", "description": "Owner Date of Birth", "schema": { "type": "string" } }, { "name": "phone_number", "in": "query", "description": "Owner / Signer phone number", "schema": { "type": "string" } }, { "name": "owner_address_1", "in": "query", "schema": { "type": "string" } }, { "name": "owner_address_2", "in": "query", "schema": { "type": "string" } }, { "name": "owner_address_city", "in": "query", "schema": { "type": "string" } }, { "name": "owner_address_state", "in": "query", "schema": { "type": "string" } }, { "name": "owner_address_country", "in": "query", "schema": { "type": "string" } }, { "name": "owner_address_zip", "in": "query", "schema": { "type": "string" } }, { "name": "user_ssn", "in": "query", "description": "Owner/Signer Social Service Number", "schema": { "type": "string" } }, { "name": "note", "in": "query", "schema": { "type": "string" } }, { "name": "electronic_signature", "in": "query", "schema": { "properties": { "html_content": { "type": "string" }, "ip": { "type": "string" }, "user_id": { "type": "string" }, "email": { "type": "string" }, "browser_agent": { "type": "string" } }, "type": "object" } }, { "name": "meta", "in": "query", "schema": { "properties": { "title": { "type": "string" }, "date_of_birth": { "type": "string", "description": "Owner DOB format: MM/DD/YYYY" }, "ssn": { "type": "string" }, "first_name": { "type": "string" }, "last_name": { "type": "string" }, "type": { "type": "string" }, "ownership_percentage": { "type": "string" }, "citizenship": { "type": "string" }, "email": { "type": "string" }, "phone": { "type": "string" }, "address_1": { "type": "string" }, "address_2": { "type": "string" }, "address_city": { "type": "string" }, "address_state": { "type": "string" }, "address_zip": { "type": "string" } }, "type": "object" } }, { "name": "files", "in": "query", "schema": { "items": { "properties": { "html_content": { "type": "string" }, "ip": { "type": "string" }, "user_id": { "type": "string" }, "email": { "type": "string" }, "browser_agent": { "type": "string" } }, "type": "object" }, "type": "array" }, "style": "deepObject", "explode": true } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "" } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "{}" } }, "schema": { "type": "object", "properties": {} } } } } }, "deprecated": false } }, "/terminal/{registerId}/status/{transactionId}": { "get": { "summary": "Get Transaction Status", "description": "Retrieves real-time status details for a previously initiated card-present transaction.", "security": [ { "ApiKeyAuth": [] } ], "operationId": "get-transaction-status", "parameters": [ { "name": "registerId", "in": "path", "description": "The id of the register where this transaction id located", "schema": { "type": "string" }, "required": true }, { "name": "transactionId", "in": "path", "description": "The id of the transaction you want the info about.", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"RefId\": \"fb1a60b1-2186-4a2b-9c02-b2c01e736d99\",\n \"RegisterId\": 3594291,\n \"ResultCode\": \"\",\n \"RespMSG\": \"APPROVAL 02051D\",\n \"Message\": \"Approved\",\n \"AuthCode\": \"02051D\",\n \"PNRef\": 835318402983,\n \"PaymentType\": \"Credit\",\n \"TransType\": \"Sale\",\n \"SN\": 118816524647,\n \"ExtData\": {\n \"Amount\": \"\",\n \"InvNum\": \"4\",\n \"CardType\": \"VISA\",\n \"BatchNum\": \"70\",\n \"Tip\": \"0.00\",\n \"CashBack\": \"0.00\",\n \"Fee\": \"0.00\",\n \"AcntLast4\": \"4301\",\n \"Name\": \"JOHNSON/DAVID\",\n \"SVC\": \"0.00\",\n \"TotalAmt\": \"0.01\",\n \"DISC\": \"0.00\",\n \"Donation\": \"0.00\",\n \"SHFee\": \"0.00\",\n \"RwdPoints\": \"0\",\n \"RwdBalance\": \"0\",\n \"RwdIssued\": \"\",\n \"EBTFSLedgerBalance\": \"\",\n \"EBTFSAvailBalance\": \"\",\n \"EBTFSBeginBalance\": \"\",\n \"EBTCashLedgerBalance\": \"\",\n \"EBTCashAvailBalance\": \"\",\n \"EBTCashBeginBalance\": \"\",\n \"RewardCode\": \"\",\n \"AcqRefData\": \"\",\n \"ProcessData\": \"\",\n \"RefNo\": \"\",\n \"RewardQR\": \"\",\n \"Language\": \"English\",\n \"EntryType\": \"CHIP\",\n \"table_num\": \"0\",\n \"clerk_id\": \"\",\n \"ticket_num\": \"\",\n \"ControlNum\": \"\",\n \"TaxCity\": \"0.00\",\n \"TaxState\": \"0.00\",\n \"Cust1\": \"\",\n \"Cust1Value\": \"\",\n \"Cust2\": \"\",\n \"Cust2Value\": \"\",\n \"Cust3\": \"\",\n \"Cust3Value\": \"\",\n \"AcntFirst4\": \"4147\",\n \"TaxAmount\": \"0.00\"\n },\n \"EMVData\": {\n \"AID\": \"A0000000031010\",\n \"AppName\": \"CHASE VISA\",\n \"TVR\": \"0080008800\",\n \"TSI\": \"E800\",\n \"IAD\": \"A07EEBA094234F9C3030\",\n \"ARC\": \"00\"\n },\n \"CVMResult\": 2,\n \"cancelled\": false,\n \"gatewayStatus\": 200,\n \"gatewayStatusText\": \"OK\",\n \"success\": true\n}" } }, "schema": { "type": "object", "properties": { "RefId": { "type": "string", "example": "fb1a60b1-2186-4a2b-9c02-b2c01e736d99" }, "RegisterId": { "type": "integer", "example": 3594291, "default": 0 }, "ResultCode": { "type": "string", "example": "" }, "RespMSG": { "type": "string", "example": "APPROVAL 02051D" }, "Message": { "type": "string", "example": "Approved" }, "AuthCode": { "type": "string", "example": "02051D" }, "PNRef": { "type": "integer", "example": 835318402983, "default": 0 }, "PaymentType": { "type": "string", "example": "Credit" }, "TransType": { "type": "string", "example": "Sale" }, "SN": { "type": "integer", "example": 118816524647, "default": 0 }, "ExtData": { "type": "object", "properties": { "Amount": { "type": "string", "example": "" }, "InvNum": { "type": "string", "example": "4" }, "CardType": { "type": "string", "example": "VISA" }, "BatchNum": { "type": "string", "example": "70" }, "Tip": { "type": "string", "example": "0.00" }, "CashBack": { "type": "string", "example": "0.00" }, "Fee": { "type": "string", "example": "0.00" }, "AcntLast4": { "type": "string", "example": "4301" }, "Name": { "type": "string", "example": "JOHNSON/DAVID" }, "SVC": { "type": "string", "example": "0.00" }, "TotalAmt": { "type": "string", "example": "0.01" }, "DISC": { "type": "string", "example": "0.00" }, "Donation": { "type": "string", "example": "0.00" }, "SHFee": { "type": "string", "example": "0.00" }, "RwdPoints": { "type": "string", "example": "0" }, "RwdBalance": { "type": "string", "example": "0" }, "RwdIssued": { "type": "string", "example": "" }, "EBTFSLedgerBalance": { "type": "string", "example": "" }, "EBTFSAvailBalance": { "type": "string", "example": "" }, "EBTFSBeginBalance": { "type": "string", "example": "" }, "EBTCashLedgerBalance": { "type": "string", "example": "" }, "EBTCashAvailBalance": { "type": "string", "example": "" }, "EBTCashBeginBalance": { "type": "string", "example": "" }, "RewardCode": { "type": "string", "example": "" }, "AcqRefData": { "type": "string", "example": "" }, "ProcessData": { "type": "string", "example": "" }, "RefNo": { "type": "string", "example": "" }, "RewardQR": { "type": "string", "example": "" }, "Language": { "type": "string", "example": "English" }, "EntryType": { "type": "string", "example": "CHIP" }, "table_num": { "type": "string", "example": "0" }, "clerk_id": { "type": "string", "example": "" }, "ticket_num": { "type": "string", "example": "" }, "ControlNum": { "type": "string", "example": "" }, "TaxCity": { "type": "string", "example": "0.00" }, "TaxState": { "type": "string", "example": "0.00" }, "Cust1": { "type": "string", "example": "" }, "Cust1Value": { "type": "string", "example": "" }, "Cust2": { "type": "string", "example": "" }, "Cust2Value": { "type": "string", "example": "" }, "Cust3": { "type": "string", "example": "" }, "Cust3Value": { "type": "string", "example": "" }, "AcntFirst4": { "type": "string", "example": "4147" }, "TaxAmount": { "type": "string", "example": "0.00" } } }, "EMVData": { "type": "object", "properties": { "AID": { "type": "string", "example": "A0000000031010" }, "AppName": { "type": "string", "example": "CHASE VISA" }, "TVR": { "type": "string", "example": "0080008800" }, "TSI": { "type": "string", "example": "E800" }, "IAD": { "type": "string", "example": "A07EEBA094234F9C3030" }, "ARC": { "type": "string", "example": "00" } } }, "CVMResult": { "type": "integer", "example": 2, "default": 0 }, "cancelled": { "type": "boolean", "example": false, "default": true }, "gatewayStatus": { "type": "integer", "example": 200, "default": 0 }, "gatewayStatusText": { "type": "string", "example": "OK" }, "success": { "type": "boolean", "example": true, "default": true } } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Transaction not Found": { "value": "{\n \"validation\": \"Transaction not found\",\n \"status\": 422,\n \"message\": \"Validation Error\"\n}" } }, "schema": { "type": "object", "properties": { "validation": { "type": "string", "example": "Transaction not found" }, "status": { "type": "integer", "example": 422, "default": 0 }, "message": { "type": "string", "example": "Validation Error" } } } } } } }, "deprecated": false } }, "/webhook/{id}": { "delete": { "summary": "Delete a Webhook", "description": "This resource will soft delete a webhook", "operationId": "delete-a-webhook", "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"id\": \"cf1c6275-ff7c-4c23-ae70-4740b2ca2d32\",\n \"user_id\": \"user1\",\n \"merchant_id\": \"merchant1\",\n \"reference_id\": \"8994e803-2e16-4bb0-b5ba-47fd9b447a0a\",\n \"url\": \"http://localhost:3006/fm/webhook/update_item/8994e803-2e16-4bb0-b5ba-47fd9b447a0a\",\n \"event\": \"update_item\",\n \"created_at\": \"2019-09-11 14:52:30\",\n \"updated_at\": \"2020-05-01 14:32:55\",\n \"deleted_at\": \"2020-05-01 14:32:55\"\n}" } }, "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "cf1c6275-ff7c-4c23-ae70-4740b2ca2d32" }, "user_id": { "type": "string", "example": "user1" }, "merchant_id": { "type": "string", "example": "merchant1" }, "reference_id": { "type": "string", "example": "8994e803-2e16-4bb0-b5ba-47fd9b447a0a" }, "url": { "type": "string", "example": "http://localhost:3006/fm/webhook/update_item/8994e803-2e16-4bb0-b5ba-47fd9b447a0a" }, "event": { "type": "string", "example": "update_item" }, "created_at": { "type": "string", "example": "2019-09-11 14:52:30" }, "updated_at": { "type": "string", "example": "2020-05-01 14:32:55" }, "deleted_at": { "type": "string", "example": "2020-05-01 14:32:55" } } } } } }, "422": { "description": "422", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"id\": [\n \"Webhook could not be found\"\n ]\n}" } }, "schema": { "type": "object", "properties": { "id": { "type": "array", "items": { "type": "string", "example": "Webhook could not be found" } } } } } } } }, "deprecated": false } }, "/item/{id}/increment": { "put": { "summary": "Increment Item's Stock", "description": "Increases the stock of an item.", "operationId": "increment-items-stock", "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "quantity", "in": "query", "schema": { "type": "integer", "format": "int32" }, "required": true, "description": "The number of stock to add to the in_stock value." } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"id\": \"0a6c966c-6a70-44eb-aa26-673310ca65c0\",\n \"user_id\": \"b58d7eee-e68d-4d12-a1f8-62f5e71382ae\",\n \"merchant_id\": \"dd36b936-1eb7-4ece-bebc-b514c6a36ebd\",\n \"thumbnail_id\": null,\n \"item\": \"Soap 2.0\",\n \"code\": \"aaaa\",\n \"details\": \"Even cleaner time\",\n \"is_active\": true,\n \"is_taxable\": false,\n \"is_service\": false,\n \"is_discount\": false,\n \"price\": 7.11,\n \"in_stock\": 1,\n \"meta\": [],\n \"created_at\": \"2017-05-05 20:13:12\",\n \"updated_at\": \"2017-05-05 20:15:55\",\n \"deleted_at\": null,\n \"deprecation_warning\": \"The name and decription fiels will be deprecated on 7/1/17\",\n \"user\": {\n \"id\": \"b58d7eee-e68d-4d12-a1f8-62f5e71382ae\",\n \"system_admin\": false,\n \"name\": \"Test guy\",\n \"email\": \"contact@example.com\",\n \"email_verification_sent_at\": \"2017-03-29 15:27:19\",\n \"email_verified_at\": \"2017-03-29 15:27:21\",\n \"is_api_key\": false,\n \"created_at\": \"2017-01-11 21:44:02\",\n \"updated_at\": \"2017-04-24 15:41:58\",\n \"deleted_at\": null,\n \"gravatar\": \"//www.gravatar.com/avatar/157965dea7cd2f44e349382d1d791650\",\n \"team_admin\": null,\n \"team_enabled\": null,\n \"team_role\": null\n },\n \"files\": [],\n \"thumbnail\": null\n}" } }, "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "0a6c966c-6a70-44eb-aa26-673310ca65c0" }, "user_id": { "type": "string", "example": "b58d7eee-e68d-4d12-a1f8-62f5e71382ae" }, "merchant_id": { "type": "string", "example": "dd36b936-1eb7-4ece-bebc-b514c6a36ebd" }, "thumbnail_id": {}, "item": { "type": "string", "example": "Soap 2.0" }, "code": { "type": "string", "example": "aaaa" }, "details": { "type": "string", "example": "Even cleaner time" }, "is_active": { "type": "boolean", "example": true, "default": true }, "is_taxable": { "type": "boolean", "example": false, "default": true }, "is_service": { "type": "boolean", "example": false, "default": true }, "is_discount": { "type": "boolean", "example": false, "default": true }, "price": { "type": "number", "example": 7.11, "default": 0 }, "in_stock": { "type": "integer", "example": 1, "default": 0 }, "meta": { "type": "array" }, "created_at": { "type": "string", "example": "2017-05-05 20:13:12" }, "updated_at": { "type": "string", "example": "2017-05-05 20:15:55" }, "deleted_at": {}, "deprecation_warning": { "type": "string", "example": "The name and decription fiels will be deprecated on 7/1/17" }, "user": { "type": "object", "properties": { "id": { "type": "string", "example": "b58d7eee-e68d-4d12-a1f8-62f5e71382ae" }, "system_admin": { "type": "boolean", "example": false, "default": true }, "name": { "type": "string", "example": "Test guy" }, "email": { "type": "string", "example": "contact@example.com" }, "email_verification_sent_at": { "type": "string", "example": "2017-03-29 15:27:19" }, "email_verified_at": { "type": "string", "example": "2017-03-29 15:27:21" }, "is_api_key": { "type": "boolean", "example": false, "default": true }, "created_at": { "type": "string", "example": "2017-01-11 21:44:02" }, "updated_at": { "type": "string", "example": "2017-04-24 15:41:58" }, "deleted_at": {}, "gravatar": { "type": "string", "example": "//www.gravatar.com/avatar/157965dea7cd2f44e349382d1d791650" }, "team_admin": {}, "team_enabled": {}, "team_role": {} } }, "files": { "type": "array" }, "thumbnail": {} } } } } }, "422": { "description": "422", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"id\": [\n \"The item was not found\"\n ]\n}" } }, "schema": { "type": "object", "properties": { "id": { "type": "array", "items": { "type": "string", "example": "The item was not found" } } } } } } } }, "deprecated": false } }, "/forgot": { "post": { "summary": "Initiate Password Reset", "description": "Initiate resetting a user's password", "operationId": "initiate-password-reset", "parameters": [ { "name": "email", "in": "query", "description": "The e-mail of an existing user.", "required": true, "schema": { "type": "string" } }, { "name": "url", "in": "query", "description": "The URL login reset URL that gets appended with the merchant's token.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "\n[\n \"email sent\"\n]" } }, "schema": { "type": "array", "items": { "type": "string", "example": "email sent" } } } } }, "422": { "description": "422", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"url\": [\n \"The url field is required.\"\n ],\n \"email\": [\n \"The selected email is required.\"\n ]\n}" } }, "schema": { "type": "object", "properties": { "url": { "type": "array", "items": { "type": "string", "example": "The url field is required." } }, "email": { "type": "array", "items": { "type": "string", "example": "The selected email is required." } } } } } } } }, "deprecated": false } }, "/merchant/{merchant_id}/user/{user_id}": { "post": { "summary": "**Link Existing User to Merchant", "description": "Link an existing user in Stax to a merchant account.", "operationId": "link-existing-user-to-merchant", "parameters": [ { "name": "merchant_id", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "user_id", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "is_default", "in": "query", "schema": { "type": "boolean" } }, { "name": "merchant_admin", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"id\": \"a9a36885-19bf-449b-be0d-c7c460576e04\",\n \"mid\": \"000000000\",\n \"status\": \"ACTIVE\",\n \"subdomain\": \"\",\n \"company_name\": \"Test\",\n \"display_name\": \"Test\",\n \"contact_name\": \" \",\n \"contact_email\": \"demo@staxpayments.com\",\n \"contact_phone\": \"\",\n \"address_1\": \"\",\n \"address_2\": \"\",\n \"address_city\": \"\",\n \"address_state\": \"\",\n \"address_zip\": \"\",\n \"hosted_payments_token\": \"Test123456789\",\n \"plan\": {\n \"id\": \"a4b9e249-7524-47c7-af4b-763701ck890b\",\n \"merchant_id\": \"a9a36885-19bf-449b-b40d-c7c460576e04\",\n \"user_id\": \"b5fa73fe-33dd-45ec-897a-7e8c3e5a3683\",\n \"name\": \"premium\",\n \"created_at\": \"2021-06-21 17:48:01\",\n \"updated_at\": \"2021-06-21 17:48:01\"\n },\n \"options\": {\n \"surcharge\": {\n \"rate\": 0,\n \"enabled\": false\n },\n \"receipts_emails\": [\n \"demo@staxpayments.com\"\n ],\n \"transaction_limit\": \"50000\",\n \"hosted_payments_note\": \"\",\n \"ach_transaction_limit\": \"85000\",\n \"repeat_method_use_limit\": 999,\n \"hosted_payments_url_long\": \"https://staxpayments.com/#/pay/Test-DEMO-a93786160d12\",\n \"repeat_method_use_window\": 43200,\n \"hosted_payments_url_short\": \"https://paymnt.io/iLBVUd\",\n \"hosted_payments_success_note\": \"\"\n },\n \"notes\": \"\",\n \"gateway_type\": \"TEST\",\n \"vendor_keys\": [],\n \"processor\": \"\",\n \"partner\": null,\n \"product_type\": \"\",\n \"is_enterprise\": false,\n \"is_payfac\": true,\n \"is_sandbox\": false,\n \"fm_billing_schedule_id\": null,\n \"fee_reconciliation_payment_method_id\": null,\n \"welcome_email_sent_at\": null,\n \"created_at\": \"2021-06-21 17:48:01\",\n \"updated_at\": \"2021-12-07 21:52:47\",\n \"deleted_at\": null,\n \"brand\": \"qa\",\n \"risk_hold\": false,\n \"branding\": null,\n \"allow_ach\": true,\n \"is_portal\": false,\n \"is_flat_rate\": false,\n \"allow_credits\": true,\n \"allow_terminal\": false,\n \"gateways\": [\n {\n \"name\": \"test\",\n \"type\": \"TEST\"\n }\n ],\n \"is_surcharge_enabled\": false,\n \"is_trust\": false,\n \"underwriting_status\": \"APPROVED\",\n \"underwriting_substatuses\": null,\n \"allow_cnp_digital_wallet\": false,\n \"users\": [\n {\n \"id\": \"b5fa73fe-57dd-45ec-897a-7e8c3e5a3683\",\n \"system_admin\": true,\n \"name\": \"Test Test\",\n \"email\": \"demo@staxpayments.com\",\n \"email_verification_sent_at\": \"2021-10-04 19:50:56\",\n \"email_verified_at\": \"2021-07-12 21:43:43\",\n \"is_api_key\": false,\n \"options\": null,\n \"acknowledgments\": {\n \"godviewOmniSearchTooltip\": true,\n \"setPassword\": true,\n \"godviewWelcome\": true\n },\n \"created_at\": \"2020-02-20 22:59:16\",\n \"updated_at\": \"2021-10-13 15:16:10\",\n \"deleted_at\": null,\n \"brand\": \"stax-sandbox\",\n \"gravatar\": \"//www.gravatar.com/avatar/663c9f306d08940340b1bf1e332b60a1\",\n \"team_admin\": true,\n \"team_enabled\": true,\n \"team_role\": \"admin\",\n \"merchant_options\": [],\n \"is_default\": false,\n \"brands\": [\n \"stax-sandbox\"\n ],\n \"pivot\": {\n \"merchant_id\": \"a9a36885-19bf-449b-be0d-c7c460576e04\",\n \"user_id\": \"b5fa73fe-57dd-45ec-897a-7e8c3e5a3683\",\n \"is_default\": false,\n \"team_role\": \"admin\",\n \"deleted_at\": null,\n \"merchant_options\": [],\n \"created_at\": \"2020-02-20 22:59:16\",\n \"updated_at\": \"2021-12-10 14:35:14\"\n }\n },\n {\n \"id\": \"99d2300e-5177-4b59-9708-fec6d4e9dbf0\",\n \"system_admin\": false,\n \"name\": \"main\",\n \"email\": null,\n \"email_verification_sent_at\": null,\n \"email_verified_at\": null,\n \"is_api_key\": true,\n \"options\": null,\n \"acknowledgments\": null,\n \"created_at\": \"2021-06-21 17:49:22\",\n \"updated_at\": \"2021-06-21 17:49:22\",\n \"deleted_at\": null,\n \"brand\": \"buildertrend\",\n \"gravatar\": \"//www.gravatar.com/avatar/d41d8cd98f00b204e9800998ecf8427e\",\n \"team_admin\": true,\n \"team_enabled\": true,\n \"team_role\": \"admin\",\n \"merchant_options\": [],\n \"is_default\": false,\n \"brands\": [\n \"stax-sandbox\"\n ],\n \"pivot\": {\n \"merchant_id\": \"a9a36885-19bf-449b-be0d-c7c460576e04\",\n \"user_id\": \"99d2300e-5177-4b59-9708-fec6d4e9dbf0\",\n \"is_default\": false,\n \"team_role\": \"admin\",\n \"deleted_at\": null,\n \"merchant_options\": [],\n \"created_at\": \"2021-06-21 17:49:22\",\n \"updated_at\": \"2021-06-21 17:49:22\"\n }\n }\n ]\n}" } }, "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "a9a36885-19bf-449b-be0d-c7c460576e04" }, "mid": { "type": "string", "example": "000000000" }, "status": { "type": "string", "example": "ACTIVE" }, "subdomain": { "type": "string", "example": "" }, "company_name": { "type": "string", "example": "Test" }, "display_name": { "type": "string", "example": "Test" }, "contact_name": { "type": "string", "example": " " }, "contact_email": { "type": "string", "example": "demo@staxpayments.com" }, "contact_phone": { "type": "string", "example": "" }, "address_1": { "type": "string", "example": "" }, "address_2": { "type": "string", "example": "" }, "address_city": { "type": "string", "example": "" }, "address_state": { "type": "string", "example": "" }, "address_zip": { "type": "string", "example": "" }, "hosted_payments_token": { "type": "string", "example": "Test123456789" }, "plan": { "type": "object", "properties": { "id": { "type": "string", "example": "a4b9e249-7524-47c7-af4b-763701ck890b" }, "merchant_id": { "type": "string", "example": "a9a36885-19bf-449b-b40d-c7c460576e04" }, "user_id": { "type": "string", "example": "b5fa73fe-33dd-45ec-897a-7e8c3e5a3683" }, "name": { "type": "string", "example": "premium" }, "created_at": { "type": "string", "example": "2021-06-21 17:48:01" }, "updated_at": { "type": "string", "example": "2021-06-21 17:48:01" } } }, "options": { "type": "object", "properties": { "surcharge": { "type": "object", "properties": { "rate": { "type": "integer", "example": 0, "default": 0 }, "enabled": { "type": "boolean", "example": false, "default": true } } }, "receipts_emails": { "type": "array", "items": { "type": "string", "example": "demo@staxpayments.com" } }, "transaction_limit": { "type": "string", "example": "50000" }, "hosted_payments_note": { "type": "string", "example": "" }, "ach_transaction_limit": { "type": "string", "example": "85000" }, "repeat_method_use_limit": { "type": "integer", "example": 999, "default": 0 }, "hosted_payments_url_long": { "type": "string", "example": "https://staxpayments.com/#/pay/Test-DEMO-a93786160d12" }, "repeat_method_use_window": { "type": "integer", "example": 43200, "default": 0 }, "hosted_payments_url_short": { "type": "string", "example": "https://paymnt.io/iLBVUd" }, "hosted_payments_success_note": { "type": "string", "example": "" } } }, "notes": { "type": "string", "example": "" }, "gateway_type": { "type": "string", "example": "TEST" }, "vendor_keys": { "type": "array" }, "processor": { "type": "string", "example": "" }, "partner": {}, "product_type": { "type": "string", "example": "" }, "is_enterprise": { "type": "boolean", "example": false, "default": true }, "is_payfac": { "type": "boolean", "example": true, "default": true }, "is_sandbox": { "type": "boolean", "example": false, "default": true }, "fm_billing_schedule_id": {}, "fee_reconciliation_payment_method_id": {}, "welcome_email_sent_at": {}, "created_at": { "type": "string", "example": "2021-06-21 17:48:01" }, "updated_at": { "type": "string", "example": "2021-12-07 21:52:47" }, "deleted_at": {}, "brand": { "type": "string", "example": "qa" }, "risk_hold": { "type": "boolean", "example": false, "default": true }, "branding": {}, "allow_ach": { "type": "boolean", "example": true, "default": true }, "is_portal": { "type": "boolean", "example": false, "default": true }, "is_flat_rate": { "type": "boolean", "example": false, "default": true }, "allow_credits": { "type": "boolean", "example": true, "default": true }, "allow_terminal": { "type": "boolean", "example": false, "default": true }, "gateways": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "example": "test" }, "type": { "type": "string", "example": "TEST" } } } }, "is_surcharge_enabled": { "type": "boolean", "example": false, "default": true }, "is_trust": { "type": "boolean", "example": false, "default": true }, "underwriting_status": { "type": "string", "example": "APPROVED" }, "underwriting_substatuses": {}, "allow_cnp_digital_wallet": { "type": "boolean", "example": false, "default": true }, "users": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "b5fa73fe-57dd-45ec-897a-7e8c3e5a3683" }, "system_admin": { "type": "boolean", "example": true, "default": true }, "name": { "type": "string", "example": "Test Test" }, "email": { "type": "string", "example": "demo@staxpayments.com" }, "email_verification_sent_at": { "type": "string", "example": "2021-10-04 19:50:56" }, "email_verified_at": { "type": "string", "example": "2021-07-12 21:43:43" }, "is_api_key": { "type": "boolean", "example": false, "default": true }, "options": {}, "acknowledgments": { "type": "object", "properties": { "godviewOmniSearchTooltip": { "type": "boolean", "example": true, "default": true }, "setPassword": { "type": "boolean", "example": true, "default": true }, "godviewWelcome": { "type": "boolean", "example": true, "default": true } } }, "created_at": { "type": "string", "example": "2020-02-20 22:59:16" }, "updated_at": { "type": "string", "example": "2021-10-13 15:16:10" }, "deleted_at": {}, "brand": { "type": "string", "example": "stax-sandbox" }, "gravatar": { "type": "string", "example": "//www.gravatar.com/avatar/663c9f306d08940340b1bf1e332b60a1" }, "team_admin": { "type": "boolean", "example": true, "default": true }, "team_enabled": { "type": "boolean", "example": true, "default": true }, "team_role": { "type": "string", "example": "admin" }, "merchant_options": { "type": "array" }, "is_default": { "type": "boolean", "example": false, "default": true }, "brands": { "type": "array", "items": { "type": "string", "example": "stax-sandbox" } }, "pivot": { "type": "object", "properties": { "merchant_id": { "type": "string", "example": "a9a36885-19bf-449b-be0d-c7c460576e04" }, "user_id": { "type": "string", "example": "b5fa73fe-57dd-45ec-897a-7e8c3e5a3683" }, "is_default": { "type": "boolean", "example": false, "default": true }, "team_role": { "type": "string", "example": "admin" }, "deleted_at": {}, "merchant_options": { "type": "array" }, "created_at": { "type": "string", "example": "2020-02-20 22:59:16" }, "updated_at": { "type": "string", "example": "2021-12-10 14:35:14" } } } } } } } } } } }, "401": { "description": "401", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"error\": \"token_invalid\"\n}" } }, "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "token_invalid" } } } } } } }, "deprecated": false }, "delete": { "summary": "**Unlink User from Merchant", "description": "Unlink a user from a merchant account", "operationId": "unlink-user-from-merchant", "parameters": [ { "name": "merchant_id", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "user_id", "in": "path", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "\n{\n \"id\": \"a9a36885-19bf-449b-6e0d-c7c460576e04\",\n \"mid\": \"000000000\",\n \"status\": \"ACTIVE\",\n \"subdomain\": \"\",\n \"company_name\": \"Test\",\n \"display_name\": \"Test\",\n \"contact_name\": \" \",\n \"contact_email\": \"karina.mills@fattmerchant.com\",\n \"contact_phone\": \"\",\n \"address_1\": \"\",\n \"address_2\": \"\",\n \"address_city\": \"\",\n \"address_state\": \"\",\n \"address_zip\": \"\",\n \"hosted_payments_token\": \"Test12346\",\n \"currency\": [\n \"USD\"\n ],\n \"plan\": {\n \"id\": \"a4b9e249-7525-47c7-af4b-763701c9890b\",\n \"merchant_id\": \"a6a36885-19bf-449b-be0d-c7c460576e04\",\n \"user_id\": \"b5fa737e-57dd-45ec-897a-7e8c3e5a3683\",\n \"name\": \"premium\",\n \"created_at\": \"2021-06-21 17:48:01\",\n \"updated_at\": \"2021-06-21 17:48:01\"\n },\n \"options\": {\n \"surcharge\": {\n \"rate\": 0,\n \"enabled\": false\n },\n \"receipts_emails\": [\n \"demo@staxpayments.com\"\n ],\n \"transaction_limit\": \"50000\",\n \"hosted_payments_note\": \"\",\n \"ach_transaction_limit\": \"85000\",\n \"repeat_method_use_limit\": 999,\n \"hosted_payments_url_long\": \"https://staxpayments.com/#/pay/Test-DEMO-a93786160d12\",\n \"repeat_method_use_window\": 43200,\n \"hosted_payments_url_short\": \"https://paymnt.io/iLBVUd\",\n \"hosted_payments_success_note\": \"\"\n },\n \"notes\": \"\",\n \"gateway_type\": \"TEST\",\n \"vendor_keys\": [],\n \"processor\": \"\",\n \"partner\": null,\n \"product_type\": \"\",\n \"is_enterprise\": false,\n \"is_payfac\": true,\n \"is_sandbox\": false,\n \"fm_billing_schedule_id\": null,\n \"fee_reconciliation_payment_method_id\": null,\n \"welcome_email_sent_at\": null,\n \"created_at\": \"2021-06-21 17:48:01\",\n \"updated_at\": \"2021-12-07 21:52:47\",\n \"deleted_at\": null,\n \"brand\": \"qa\",\n \"risk_hold\": false,\n \"branding\": null,\n \"allow_ach\": true,\n \"is_portal\": false,\n \"is_flat_rate\": false,\n \"allow_credits\": true,\n \"allow_terminal\": false,\n \"gateways\": [\n {\n \"name\": \"test\",\n \"type\": \"TEST\"\n }\n ],\n \"is_surcharge_enabled\": false,\n \"is_trust\": false,\n \"underwriting_status\": \"APPROVED\",\n \"underwriting_substatuses\": null,\n \"allow_cnp_digital_wallet\": false,\n \"users\": [\n {\n \"id\": \"b5fa63fe-57dd-45ec-897a-7e8c3e5a3683\",\n \"system_admin\": true,\n \"name\": \"Test Test\",\n \"email\": \"demo@staxpayments.com\",\n \"email_verification_sent_at\": \"2021-10-04 19:50:56\",\n \"email_verified_at\": \"2021-07-12 21:43:43\",\n \"is_api_key\": false,\n \"options\": null,\n \"acknowledgments\": {\n \"godviewOmniSearchTooltip\": true,\n \"setPassword\": true,\n \"godviewWelcome\": true\n },\n \"created_at\": \"2020-02-20 22:59:16\",\n \"updated_at\": \"2021-10-13 15:16:10\",\n \"deleted_at\": null,\n \"brand\": \"stax\",\n \"gravatar\": \"//www.gravatar.com/avatar/663c9f306d08940340b1bf1e332b60a1\",\n \"team_admin\": true,\n \"team_enabled\": false,\n \"team_role\": \"admin\",\n \"merchant_options\": {\n \"subscribed_to_weekly_summary\": true\n },\n \"is_default\": false,\n \"brands\": [\n \"stax\"\n ],\n \"pivot\": {\n \"merchant_id\": \"a9336885-19bf-449b-be0d-c7c460576e04\",\n \"user_id\": \"b5fa733e-57dd-45ec-897a-7e8c3e5a3683\",\n \"is_default\": false,\n \"team_role\": \"admin\",\n \"deleted_at\": \"2021-12-10 15:24:27\",\n \"merchant_options\": {\n \"subscribed_to_weekly_summary\": true\n },\n \"created_at\": \"2020-02-20 22:59:16\",\n \"updated_at\": \"2021-12-10 14:51:50\"\n }\n },\n {\n \"id\": \"99d2370e-5177-4b59-9708-fec6d4e9dbf0\",\n \"system_admin\": false,\n \"name\": \"main\",\n \"email\": null,\n \"email_verification_sent_at\": null,\n \"email_verified_at\": null,\n \"is_api_key\": true,\n \"options\": null,\n \"acknowledgments\": null,\n \"created_at\": \"2021-06-21 17:49:22\",\n \"updated_at\": \"2021-06-21 17:49:22\",\n \"deleted_at\": null,\n \"brand\": \"stax\",\n \"gravatar\": \"//www.gravatar.com/avatar/d41d8cd98f00b204e9800998ecf8427e\",\n \"team_admin\": true,\n \"team_enabled\": true,\n \"team_role\": \"admin\",\n \"merchant_options\": [],\n \"is_default\": false,\n \"brands\": [\n \"stax\"\n ],\n \"pivot\": {\n \"merchant_id\": \"a9a36886-19bf-449b-be0d-c7c460576e04\",\n \"user_id\": \"99d2300e-5176-4b59-9708-fec6d4e9dbf0\",\n \"is_default\": false,\n \"team_role\": \"admin\",\n \"deleted_at\": null,\n \"merchant_options\": [],\n \"created_at\": \"2021-06-21 17:49:22\",\n \"updated_at\": \"2021-06-21 17:49:22\"\n }\n }\n ]\n}" } }, "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "a9a36885-19bf-449b-6e0d-c7c460576e04" }, "mid": { "type": "string", "example": "000000000" }, "status": { "type": "string", "example": "ACTIVE" }, "subdomain": { "type": "string", "example": "" }, "company_name": { "type": "string", "example": "Test" }, "display_name": { "type": "string", "example": "Test" }, "contact_name": { "type": "string", "example": " " }, "contact_email": { "type": "string", "example": "karina.mills@fattmerchant.com" }, "contact_phone": { "type": "string", "example": "" }, "address_1": { "type": "string", "example": "" }, "address_2": { "type": "string", "example": "" }, "address_city": { "type": "string", "example": "" }, "address_state": { "type": "string", "example": "" }, "address_zip": { "type": "string", "example": "" }, "hosted_payments_token": { "type": "string", "example": "Test12346" }, "currency": { "type": "array", "items": { "type": "string", "example": "USD" } }, "plan": { "type": "object", "properties": { "id": { "type": "string", "example": "a4b9e249-7525-47c7-af4b-763701c9890b" }, "merchant_id": { "type": "string", "example": "a6a36885-19bf-449b-be0d-c7c460576e04" }, "user_id": { "type": "string", "example": "b5fa737e-57dd-45ec-897a-7e8c3e5a3683" }, "name": { "type": "string", "example": "premium" }, "created_at": { "type": "string", "example": "2021-06-21 17:48:01" }, "updated_at": { "type": "string", "example": "2021-06-21 17:48:01" } } }, "options": { "type": "object", "properties": { "surcharge": { "type": "object", "properties": { "rate": { "type": "integer", "example": 0, "default": 0 }, "enabled": { "type": "boolean", "example": false, "default": true } } }, "receipts_emails": { "type": "array", "items": { "type": "string", "example": "demo@staxpayments.com" } }, "transaction_limit": { "type": "string", "example": "50000" }, "hosted_payments_note": { "type": "string", "example": "" }, "ach_transaction_limit": { "type": "string", "example": "85000" }, "repeat_method_use_limit": { "type": "integer", "example": 999, "default": 0 }, "hosted_payments_url_long": { "type": "string", "example": "https://staxpayments.com/#/pay/Test-DEMO-a93786160d12" }, "repeat_method_use_window": { "type": "integer", "example": 43200, "default": 0 }, "hosted_payments_url_short": { "type": "string", "example": "https://paymnt.io/iLBVUd" }, "hosted_payments_success_note": { "type": "string", "example": "" } } }, "notes": { "type": "string", "example": "" }, "gateway_type": { "type": "string", "example": "TEST" }, "vendor_keys": { "type": "array" }, "processor": { "type": "string", "example": "" }, "partner": {}, "product_type": { "type": "string", "example": "" }, "is_enterprise": { "type": "boolean", "example": false, "default": true }, "is_payfac": { "type": "boolean", "example": true, "default": true }, "is_sandbox": { "type": "boolean", "example": false, "default": true }, "fm_billing_schedule_id": {}, "fee_reconciliation_payment_method_id": {}, "welcome_email_sent_at": {}, "created_at": { "type": "string", "example": "2021-06-21 17:48:01" }, "updated_at": { "type": "string", "example": "2021-12-07 21:52:47" }, "deleted_at": {}, "brand": { "type": "string", "example": "qa" }, "risk_hold": { "type": "boolean", "example": false, "default": true }, "branding": {}, "allow_ach": { "type": "boolean", "example": true, "default": true }, "is_portal": { "type": "boolean", "example": false, "default": true }, "is_flat_rate": { "type": "boolean", "example": false, "default": true }, "allow_credits": { "type": "boolean", "example": true, "default": true }, "allow_terminal": { "type": "boolean", "example": false, "default": true }, "gateways": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "example": "test" }, "type": { "type": "string", "example": "TEST" } } } }, "is_surcharge_enabled": { "type": "boolean", "example": false, "default": true }, "is_trust": { "type": "boolean", "example": false, "default": true }, "underwriting_status": { "type": "string", "example": "APPROVED" }, "underwriting_substatuses": {}, "allow_cnp_digital_wallet": { "type": "boolean", "example": false, "default": true }, "users": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "b5fa63fe-57dd-45ec-897a-7e8c3e5a3683" }, "system_admin": { "type": "boolean", "example": true, "default": true }, "name": { "type": "string", "example": "Test Test" }, "email": { "type": "string", "example": "demo@staxpayments.com" }, "email_verification_sent_at": { "type": "string", "example": "2021-10-04 19:50:56" }, "email_verified_at": { "type": "string", "example": "2021-07-12 21:43:43" }, "is_api_key": { "type": "boolean", "example": false, "default": true }, "options": {}, "acknowledgments": { "type": "object", "properties": { "godviewOmniSearchTooltip": { "type": "boolean", "example": true, "default": true }, "setPassword": { "type": "boolean", "example": true, "default": true }, "godviewWelcome": { "type": "boolean", "example": true, "default": true } } }, "created_at": { "type": "string", "example": "2020-02-20 22:59:16" }, "updated_at": { "type": "string", "example": "2021-10-13 15:16:10" }, "deleted_at": {}, "brand": { "type": "string", "example": "stax" }, "gravatar": { "type": "string", "example": "//www.gravatar.com/avatar/663c9f306d08940340b1bf1e332b60a1" }, "team_admin": { "type": "boolean", "example": true, "default": true }, "team_enabled": { "type": "boolean", "example": false, "default": true }, "team_role": { "type": "string", "example": "admin" }, "merchant_options": { "type": "object", "properties": { "subscribed_to_weekly_summary": { "type": "boolean", "example": true, "default": true } } }, "is_default": { "type": "boolean", "example": false, "default": true }, "brands": { "type": "array", "items": { "type": "string", "example": "stax" } }, "pivot": { "type": "object", "properties": { "merchant_id": { "type": "string", "example": "a9336885-19bf-449b-be0d-c7c460576e04" }, "user_id": { "type": "string", "example": "b5fa733e-57dd-45ec-897a-7e8c3e5a3683" }, "is_default": { "type": "boolean", "example": false, "default": true }, "team_role": { "type": "string", "example": "admin" }, "deleted_at": { "type": "string", "example": "2021-12-10 15:24:27" }, "merchant_options": { "type": "object", "properties": { "subscribed_to_weekly_summary": { "type": "boolean", "example": true, "default": true } } }, "created_at": { "type": "string", "example": "2020-02-20 22:59:16" }, "updated_at": { "type": "string", "example": "2021-12-10 14:51:50" } } } } } } } } } } }, "401": { "description": "401", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"error\": \"token_invalid\"\n}" } }, "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "token_invalid" } } } } } }, "422": { "description": "422", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"merchant_id\": [\n \"The selected merchant id is invalid.\"\n ],\n \"user_id\": [\n \"The selected user id is invalid.\"\n ]\n}" } }, "schema": { "type": "object", "properties": { "merchant_id": { "type": "array", "items": { "type": "string", "example": "The selected merchant id is invalid." } }, "user_id": { "type": "array", "items": { "type": "string", "example": "The selected user id is invalid." } } } } } } } }, "deprecated": false } }, "/transaction": { "get": { "summary": "List and Filter All Transactions", "description": "Retrieve a list of all transactions for the merchant account. Use query parameters to filter and sort transactions based on criteria such as date range, transaction type, status, amount, and more.", "operationId": "list-and-filter-all-transactions", "parameters": [ { "name": "export", "in": "query", "schema": { "type": "string", "enum": [ "csv" ], "default": "csv" } }, { "name": "keywords[]", "in": "query", "description": "Allows the transactions and customers to be searchable by keywords. Added by default. Allows searching by partial ID for customer's who match it.", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "startDate", "in": "query", "description": "Sets the earliest date to find transactions. Searches on the created_at", "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "description": "Sets the latest date to find transactions. Searches on the created_at", "schema": { "type": "string" } }, { "name": "user_id", "in": "query", "description": "Filters the data that matches the user ID", "schema": { "type": "string" } }, { "name": "customer_id", "in": "query", "description": "Filters data that matches the customer ID", "schema": { "type": "string" } }, { "name": "meta", "in": "query", "description": "Will filter results set to records that have an exact match", "schema": { "type": "string" } }, { "name": "total", "in": "query", "description": "Will filter results set to records that have an exact match", "schema": { "type": "number" } }, { "name": "pre_auth", "in": "query", "description": "Will filter results to only show pre-authorization or non pre-authorization transactions", "schema": { "type": "boolean" } }, { "name": "method", "in": "query", "description": "Filters the tables based on which payment method was chosen.", "schema": { "type": "string", "enum": [ "card", "bank", "cash", "giftcard", "check" ] } }, { "name": "maxTotal", "in": "query", "description": "Will filter transactions with totals less than the chosen maxTotal", "schema": { "type": "number" } }, { "name": "minTotal", "in": "query", "description": "Will filter transactions with totals more than the chosen minTotal", "schema": { "type": "number" } }, { "name": "type", "in": "query", "description": "Will filter transactions based on type", "schema": { "type": "string", "enum": [ "capture", "charge", "credit", "pre auth", "refund", "void" ] } }, { "name": "allTransactionsTopLevel", "in": "query", "description": "Will make child transactions (refunds, voids) appear at the top level of the response, allowing you to filter on these child transactions with a startDate and endDate that correspond to the child transaction", "schema": { "type": "string" } }, { "name": "success", "in": "query", "description": "Will filter transactions that are successful (true) or not successful", "schema": { "type": "boolean" } }, { "name": "is_manual", "in": "query", "description": "use: 0, or 1, not true or false. Indicating 1 here filters for manual transactions, meaning these transactions used a payment method of cash, check or giftcard and are simply records of a transaction which occurred outside the payment gateway.", "schema": { "type": "string" } }, { "name": "sort", "in": "query", "schema": { "type": "string", "enum": [ "created_at", "updated_at", "total", "pre_auth", "last_four" ] } }, { "name": "order", "in": "query", "schema": { "type": "string", "enum": [ "ASC", "DESC" ] } } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"net_sales\": null,\n \"total\": 1,\n \"per_page\": 50,\n \"current_page\": 1,\n \"last_page\": 1,\n \"next_page_url\": null,\n \"prev_page_url\": null,\n \"from\": 1,\n \"to\": 1,\n \"data\": [\n {\n \"id\": \"795c7b84-76aa-498c-b2b8-cd06ef6baf7a\",\n \"invoice_id\": \"\",\n \"reference_id\": \"\",\n \"recurring_transaction_id\": \"\",\n \"type\": \"charge\",\n \"source\": null,\n \"merchant_id\": \"aa7766b2-242f-43b9-9476-3c9018f0ce52\",\n \"user_id\": \"b58d7eee-e68d-4d12-a1f8-62f5e71382ae\",\n \"customer_id\": \"d45ee88c-8b27-4be8-8d81-77dda1b81826\",\n \"payment_method_id\": \"425dfe40-3f4d-443e-8ac8-dc4ec6f4edec\",\n \"is_manual\": null,\n \"success\": true,\n \"message\": null,\n \"meta\": {\n \"tax\": 0,\n \"subtotal\": 2,\n \"lineItems\": [\n {\n \"id\": \"optional-fm-catalog-item-id\",\n \"item\": \"Demo Item\",\n \"details\": \"this is a regular demo item\",\n \"quantity\": 1,\n \"price\": 1\n }\n ]\n },\n \"total\": 1,\n \"method\": \"card\",\n \"pre_auth\": false,\n \"last_four\": \"1111\",\n \"receipt_email_at\": null,\n \"receipt_sms_at\": null,\n \"created_at\": \"2017-05-15 22:13:18\",\n \"updated_at\": \"2017-05-15 22:13:18\",\n \"settled_at\": \"2021-11-17T00:00:00.000Z\",\n \"total_refunded\": null,\n \"is_refundable\": false,\n \"is_voided\": false,\n \"is_voidable\": true,\n \"currency\": \"USD\",\n \"schedule_id\": null,\n \"customer\": {\n \"id\": \"d45ee88c-8b27-4be8-8d81-77dda1b81826\",\n \"firstname\": \"John\",\n \"lastname\": \"Smith\",\n \"company\": \"ABC INC\",\n \"email\": \"demo@abc.com\",\n \"cc_emails\": [\n \"demo1@abc.com\",\n \"demo2@abc.com\"\n ],\n \"phone\": \"1234567898\",\n \"address_1\": \"123 Rite Way\",\n \"address_2\": \"Unit 12\",\n \"address_city\": \"Orlando\",\n \"address_state\": \"FL\",\n \"address_zip\": \"32801\",\n \"address_country\": \"USA\",\n \"notes\": null,\n \"reference\": \"BARTLE\",\n \"options\": \"\",\n \"created_at\": \"2017-05-08 19:22:51\",\n \"updated_at\": \"2017-05-08 19:23:46\",\n \"deleted_at\": null,\n \"gravatar\": \"//www.gravatar.com/avatar/fe3e929dd80f1653c3a4b82812660061\"\n },\n \"child_transactions\": [],\n \"files\": [],\n \"payment_method\": {\n \"id\": \"425dfe40-3f4d-443e-8ac8-dc4ec6f4edec\",\n \"customer_id\": \"d45ee88c-8b27-4be8-8d81-77dda1b81826\",\n \"merchant_id\": \"aa7766b2-242f-43b9-9476-3c9018f0ce52\",\n \"user_id\": \"b58d7eee-e68d-4d12-a1f8-62f5e71382ae\",\n \"nickname\": \"VISA: Steven Smith Jr. (ending in: 1111)\",\n \"is_default\": 1,\n \"method\": \"card\",\n \"person_name\": \"Steven Smith Jr.\",\n \"card_type\": \"visa\",\n \"card_last_four\": \"1111\",\n \"card_exp\": \"042019\",\n \"bank_name\": null,\n \"bank_type\": null,\n \"bank_holder_type\": null,\n \"address_1\": null,\n \"address_2\": null,\n \"address_city\": null,\n \"address_state\": null,\n \"address_zip\": \"32944\",\n \"address_country\": \"USA\",\n \"purged_at\": null,\n \"deleted_at\": null,\n \"created_at\": \"2017-05-15 22:13:12\",\n \"updated_at\": \"2017-05-15 22:13:12\",\n \"card_exp_datetime\": \"2019-04-30 23:59:59\",\n \"customer\": {\n \"id\": \"d45ee88c-8b27-4be8-8d81-77dda1b81826\",\n \"firstname\": \"John\",\n \"lastname\": \"Smith\",\n \"company\": \"ABC INC\",\n \"email\": \"demo@abc.com\",\n \"cc_emails\": [\n \"demo1@abc.com\",\n \"demo2@abc.com\"\n ],\n \"phone\": \"1234567898\",\n \"address_1\": \"123 Rite Way\",\n \"address_2\": \"Unit 12\",\n \"address_city\": \"Orlando\",\n \"address_state\": \"FL\",\n \"address_zip\": \"32801\",\n \"address_country\": \"USA\",\n \"notes\": null,\n \"reference\": \"BARTLE\",\n \"options\": \"\",\n \"created_at\": \"2017-05-08 19:22:51\",\n \"updated_at\": \"2017-05-08 19:23:46\",\n \"deleted_at\": null,\n \"gravatar\": \"//www.gravatar.com/avatar/fe3e929dd80f1653c3a4b82812660061\"\n }\n },\n \"user\": {\n \"id\": \"b58d7eee-e68d-4d12-a1f8-62f5e71382ae\",\n \"system_admin\": false,\n \"name\": \"Demo Mann\",\n \"email\": \"contact@example.com\",\n \"email_verification_sent_at\": \"2017-05-15 16:30:23\",\n \"email_verified_at\": \"2017-03-29 15:27:21\",\n \"is_api_key\": false,\n \"created_at\": \"2017-01-11 21:44:02\",\n \"updated_at\": \"2017-05-15 16:30:23\",\n \"deleted_at\": null,\n \"gravatar\": \"//www.gravatar.com/avatar/157965dea7cd2f44e349382d1d791650\",\n \"team_admin\": null,\n \"team_enabled\": null,\n \"team_role\": null,\n \"merchant_options\": [],\n \"is_portal\": false\n }\n }\n ]\n}" } }, "schema": { "type": "object", "properties": { "net_sales": {}, "total": { "type": "number", "example": 1, "default": 0 }, "per_page": { "type": "integer", "example": 50, "default": 0 }, "current_page": { "type": "integer", "example": 1, "default": 0 }, "last_page": { "type": "integer", "example": 1, "default": 0 }, "next_page_url": {}, "prev_page_url": {}, "from": { "type": "integer", "example": 1, "default": 0 }, "to": { "type": "integer", "example": 1, "default": 0 }, "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "795c7b84-76aa-498c-b2b8-cd06ef6baf7a" }, "invoice_id": { "type": "string", "example": "" }, "reference_id": { "type": "string", "example": "" }, "recurring_transaction_id": { "type": "string", "example": "" }, "type": { "type": "string", "example": "charge" }, "source": {}, "merchant_id": { "type": "string", "example": "aa7766b2-242f-43b9-9476-3c9018f0ce52" }, "user_id": { "type": "string", "example": "b58d7eee-e68d-4d12-a1f8-62f5e71382ae" }, "customer_id": { "type": "string", "example": "d45ee88c-8b27-4be8-8d81-77dda1b81826" }, "payment_method_id": { "type": "string", "example": "425dfe40-3f4d-443e-8ac8-dc4ec6f4edec" }, "is_manual": {}, "success": { "type": "boolean", "example": true, "default": true }, "message": {}, "meta": { "type": "object", "properties": { "tax": { "type": "integer", "example": 0, "default": 0 }, "subtotal": { "type": "integer", "example": 2, "default": 0 }, "lineItems": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "optional-fm-catalog-item-id" }, "item": { "type": "string", "example": "Demo Item" }, "details": { "type": "string", "example": "this is a regular demo item" }, "quantity": { "type": "integer", "example": 1, "default": 0 }, "price": { "type": "integer", "example": 1, "default": 0 } } } } } }, "total": { "type": "number", "example": 1, "default": 0 }, "method": { "type": "string", "example": "card" }, "pre_auth": { "type": "boolean", "example": false, "default": true }, "last_four": { "type": "string", "example": "1111" }, "receipt_email_at": {}, "receipt_sms_at": {}, "created_at": { "type": "string", "example": "2017-05-15 22:13:18" }, "updated_at": { "type": "string", "example": "2017-05-15 22:13:18" }, "settled_at": { "type": "string", "example": "2021-11-17T00:00:00.000Z" }, "total_refunded": { "type": "number" }, "is_refundable": { "type": "boolean", "example": false, "default": true }, "is_voided": { "type": "boolean", "example": false, "default": true }, "is_voidable": { "type": "boolean", "example": true, "default": true }, "currency": { "type": "string", "example": "USD" }, "schedule_id": {}, "customer": { "type": "object", "properties": { "id": { "type": "string", "example": "d45ee88c-8b27-4be8-8d81-77dda1b81826" }, "firstname": { "type": "string", "example": "John" }, "lastname": { "type": "string", "example": "Smith" }, "company": { "type": "string", "example": "ABC INC" }, "email": { "type": "string", "example": "demo@abc.com" }, "cc_emails": { "type": "array", "items": { "type": "string", "example": "demo1@abc.com" } }, "phone": { "type": "string", "example": "1234567898" }, "address_1": { "type": "string", "example": "123 Rite Way" }, "address_2": { "type": "string", "example": "Unit 12" }, "address_city": { "type": "string", "example": "Orlando" }, "address_state": { "type": "string", "example": "FL" }, "address_zip": { "type": "string", "example": "32801" }, "address_country": { "type": "string", "example": "USA" }, "notes": {}, "reference": { "type": "string", "example": "BARTLE" }, "options": { "type": "string", "example": "" }, "created_at": { "type": "string", "example": "2017-05-08 19:22:51" }, "updated_at": { "type": "string", "example": "2017-05-08 19:23:46" }, "deleted_at": {}, "gravatar": { "type": "string", "example": "//www.gravatar.com/avatar/fe3e929dd80f1653c3a4b82812660061" } } }, "child_transactions": { "type": "array" }, "files": { "type": "array" }, "payment_method": { "type": "object", "properties": { "id": { "type": "string", "example": "425dfe40-3f4d-443e-8ac8-dc4ec6f4edec" }, "customer_id": { "type": "string", "example": "d45ee88c-8b27-4be8-8d81-77dda1b81826" }, "merchant_id": { "type": "string", "example": "aa7766b2-242f-43b9-9476-3c9018f0ce52" }, "user_id": { "type": "string", "example": "b58d7eee-e68d-4d12-a1f8-62f5e71382ae" }, "nickname": { "type": "string", "example": "VISA: Steven Smith Jr. (ending in: 1111)" }, "is_default": { "type": "integer", "example": 1, "default": 0 }, "method": { "type": "string", "example": "card" }, "person_name": { "type": "string", "example": "Steven Smith Jr." }, "card_type": { "type": "string", "example": "visa" }, "card_last_four": { "type": "string", "example": "1111" }, "card_exp": { "type": "string", "example": "042019" }, "bank_name": {}, "bank_type": {}, "bank_holder_type": {}, "address_1": {}, "address_2": {}, "address_city": {}, "address_state": {}, "address_zip": { "type": "string", "example": "32944" }, "address_country": { "type": "string", "example": "USA" }, "purged_at": {}, "deleted_at": {}, "created_at": { "type": "string", "example": "2017-05-15 22:13:12" }, "updated_at": { "type": "string", "example": "2017-05-15 22:13:12" }, "card_exp_datetime": { "type": "string", "example": "2019-04-30 23:59:59" }, "customer": { "type": "object", "properties": { "id": { "type": "string", "example": "d45ee88c-8b27-4be8-8d81-77dda1b81826" }, "firstname": { "type": "string", "example": "John" }, "lastname": { "type": "string", "example": "Smith" }, "company": { "type": "string", "example": "ABC INC" }, "email": { "type": "string", "example": "demo@abc.com" }, "cc_emails": { "type": "array", "items": { "type": "string", "example": "demo1@abc.com" } }, "phone": { "type": "string", "example": "1234567898" }, "address_1": { "type": "string", "example": "123 Rite Way" }, "address_2": { "type": "string", "example": "Unit 12" }, "address_city": { "type": "string", "example": "Orlando" }, "address_state": { "type": "string", "example": "FL" }, "address_zip": { "type": "string", "example": "32801" }, "address_country": { "type": "string", "example": "USA" }, "notes": {}, "reference": { "type": "string", "example": "BARTLE" }, "options": { "type": "string", "example": "" }, "created_at": { "type": "string", "example": "2017-05-08 19:22:51" }, "updated_at": { "type": "string", "example": "2017-05-08 19:23:46" }, "deleted_at": {}, "gravatar": { "type": "string", "example": "//www.gravatar.com/avatar/fe3e929dd80f1653c3a4b82812660061" } } } } }, "user": { "type": "object", "properties": { "id": { "type": "string", "example": "b58d7eee-e68d-4d12-a1f8-62f5e71382ae" }, "system_admin": { "type": "boolean", "example": false, "default": true }, "name": { "type": "string", "example": "Demo Mann" }, "email": { "type": "string", "example": "contact@example.com" }, "email_verification_sent_at": { "type": "string", "example": "2017-05-15 16:30:23" }, "email_verified_at": { "type": "string", "example": "2017-03-29 15:27:21" }, "is_api_key": { "type": "boolean", "example": false, "default": true }, "created_at": { "type": "string", "example": "2017-01-11 21:44:02" }, "updated_at": { "type": "string", "example": "2017-05-15 16:30:23" }, "deleted_at": {}, "gravatar": { "type": "string", "example": "//www.gravatar.com/avatar/157965dea7cd2f44e349382d1d791650" }, "team_admin": {}, "team_enabled": {}, "team_role": {}, "merchant_options": { "type": "array" }, "is_portal": { "type": "boolean", "example": false, "default": true } } } } } } } } } } }, "422": { "description": "422", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"keywords\": [\n \"The keywords must be an array.\"\n ],\n \"startDate\": [\n \"The start date does not match the format Y-m-d G:i:s.\"\n ]\n}" } }, "schema": { "type": "object", "properties": { "keywords": { "type": "array", "items": { "type": "string", "example": "The keywords must be an array." } }, "startDate": { "type": "array", "items": { "type": "string", "example": "The start date does not match the format Y-m-d G:i:s." } } } } } } } } } }, "/team/apikey": { "get": { "summary": "List API Keys", "description": "List out all team member user records which are api keys.", "operationId": "list-api-keys", "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"current_page\": 1,\n \"data\": [\n {\n \"id\": \"ebf007e4-90c9-4764-b8be-4b2a21a7deda\",\n \"name\": \"api-key-1\",\n \"email\": null,\n \"email_verification_sent_at\": null,\n \"email_verified_at\": null,\n \"created_at\": \"2019-06-19 20:32:15\",\n \"updated_at\": \"2019-06-19 20:32:15\",\n \"deleted_at\": null,\n \"gravatar\": \"//www.gravatar.com/avatar/d41d8cd98f00b204e9800998ecf8427e\",\n \"team_role\": \"full\",\n \"team_admin\": false,\n \"team_enabled\": true,\n \"api_key\": \"THIS_VALUE_WILL_CONTAIN_JWT_STRING\"\n },\n {\n \"id\": \"71626cac-ba4e-4c71-a8d3-315a279b8ef1\",\n \"name\": \"api-key-2\",\n \"email\": null,\n \"email_verification_sent_at\": null,\n \"email_verified_at\": null,\n \"created_at\": \"2019-06-19 20:32:11\",\n \"updated_at\": \"2019-06-19 20:32:11\",\n \"deleted_at\": null,\n \"gravatar\": \"//www.gravatar.com/avatar/d41d8cd98f00b204e9800998ecf8427e\",\n \"team_role\": \"full\",\n \"team_admin\": false,\n \"team_enabled\": true,\n \"api_key\": \"THIS_VALUE_WILL_CONTAIN_JWT_STRING\"\n },\n ],\n \"from\": 1,\n \"last_page\": 1,\n \"per_page\": 20,\n \"prev_page_url\": null,\n \"to\": 2,\n \"total\": 2\n }" } } } } } }, "deprecated": false } }, "/underwriting/disputes/{merchantId}": { "get": { "summary": "List Disputes for a Merchant", "description": "Retrieves a paginated list (10 results per page) of disputes for the specified merchant in the request URL.", "operationId": "list-disputes-copy", "parameters": [ { "name": "id", "in": "query", "description": "Filters results by the dispute id.", "schema": { "type": "string" } }, { "name": "transaction_id", "in": "query", "description": "Filters results by the id of the dispute's associated transaction.", "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "Filters results according to the dispute's status in the process.", "schema": { "type": "string", "enum": [ "INQUIRY", "OPEN", "PENDING", "ACCEPTED", "PREARBITRATION", "WON", "LOST", "EVIDENCE_UPLOADED", "UPLOAD_FAILED" ] } }, { "name": "reason", "in": "query", "description": "Filters results according to the reason for the dispute's creation.", "schema": { "type": "string", "enum": [ "TECHNICAL", "CLERICAL", "QUALITY", "FRAUD", "INQUIRY" ] } }, { "name": "sort", "in": "query", "description": "The property by which the results are sorted", "schema": { "type": "string", "enum": [ "respond_by", "created_at", "updated_at", "status" ], "default": "respond_by" } }, { "name": "order", "in": "query", "description": "The order in which the results are sorted", "schema": { "type": "string", "enum": [ "DESC", "ASC" ] } }, { "name": "startDate", "in": "query", "description": "Filters results according to the dispute's created_at date.", "schema": { "type": "string", "format": "date" } }, { "name": "endDate", "in": "query", "description": "Filters results according to the dispute's created_at date.", "schema": { "type": "string", "format": "date" } }, { "name": "page", "in": "query", "description": "Each page returns up to 10 results.", "schema": { "type": "integer", "format": "int32" } }, { "name": "merchantId", "in": "path", "description": "The merchant ID value.", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"total\": 22,\n \"per_page\": 10,\n \"current_page\": 3,\n \"last_page\": 3,\n \"next_page_url\": null,\n \"prev_page_url\": \"https://apiprod.fattlabs.com/underwriting/disputes/merchant1?page=2\",\n \"from\": 21,\n \"to\": 22,\n \"data\": [\n {\n \"id\": \"07ad9751-443c-11ea-8e3f-0242ac140002\",\n \"transaction_id\": \"000e8694-d259-47ee-8fa1-bc0667e705a5\",\n \"merchant_id\": \"merchant1\",\n \"reason\": \"FRAUD\",\n \"amount\": 8888.88,\n \"status\": \"PENDING\",\n \"respond_by\": \"2020-01-20T23:48:03.000Z\",\n \"created_at\": \"2020-01-08T23:48:03.000Z\",\n \"updated_at\": \"2020-01-08T23:48:03.000Z\"\n },\n {\n \"id\": \"07dbfe08-443c-11ea-8e3f-0242ac140002\",\n \"transaction_id\": \"aca21c84-d37e-4d47-ad32-579dfda74458\",\n \"merchant_id\": \"merchant1\",\n \"reason\": \"FRAUD\",\n \"amount\": 8888.88,\n \"status\": \"EVIDENCE_UPLOADED\",\n \"respond_by\": \"2020-01-31T23:48:03.000Z\",\n \"created_at\": \"2020-01-08T23:48:03.000Z\",\n \"updated_at\": \"2020-01-08T23:48:03.000Z\"\n }\n ]\n}" } }, "schema": { "type": "object", "properties": { "total": { "type": "integer", "example": 22, "default": 0 }, "per_page": { "type": "integer", "example": 10, "default": 0 }, "current_page": { "type": "integer", "example": 3, "default": 0 }, "last_page": { "type": "integer", "example": 3, "default": 0 }, "next_page_url": {}, "prev_page_url": { "type": "string", "example": "https://apiprod.fattlabs.com/underwriting/disputes/merchant1?page=2" }, "from": { "type": "integer", "example": 21, "default": 0 }, "to": { "type": "integer", "example": 22, "default": 0 }, "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "07ad9751-443c-11ea-8e3f-0242ac140002" }, "transaction_id": { "type": "string", "example": "000e8694-d259-47ee-8fa1-bc0667e705a5" }, "merchant_id": { "type": "string", "example": "merchant1" }, "reason": { "type": "string", "example": "FRAUD" }, "amount": { "type": "number", "example": 8888.88, "default": 0 }, "status": { "type": "string", "example": "PENDING" }, "respond_by": { "type": "string", "example": "2020-01-20T23:48:03.000Z" }, "created_at": { "type": "string", "example": "2020-01-08T23:48:03.000Z" }, "updated_at": { "type": "string", "example": "2020-01-08T23:48:03.000Z" } } } } } } } } } }, "deprecated": false, "security": [ { "PartnerApiKey": [] } ] } }, "/underwriting/disputes": { "get": { "summary": "List Disputes", "description": "This route handles requests for a list of disputes for the currently authenticated merchant, and returns paginated data with 10 results per page.", "operationId": "list-disputes", "parameters": [ { "name": "id", "in": "query", "description": "Filters results by the dispute id.", "schema": { "type": "string" } }, { "name": "transaction_id", "in": "query", "description": "Filters results by the id of the dispute's associated transaction.", "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "Filters results according to the dispute's status in the process.", "schema": { "type": "string", "enum": [ "INQUIRY", "OPEN", "PENDING", "ACCEPTED", "PREARBITRATION", "WON", "LOST", "EVIDENCE_UPLOADED", "UPLOAD_FAILED" ] } }, { "name": "reason", "in": "query", "description": "Filters results according to the reason for the dispute's creation.", "schema": { "type": "string", "enum": [ "TECHNICAL", "CLERICAL", "QUALITY", "FRAUD", "INQUIRY" ] } }, { "name": "sort", "in": "query", "description": "The property by which the results are sorted", "schema": { "type": "string", "enum": [ "respond_by", "created_at", "updated_at", "status" ], "default": "respond_by" } }, { "name": "order", "in": "query", "description": "The order in which the results are sorted", "schema": { "type": "string", "enum": [ "DESC", "ASC" ] } }, { "name": "startDate", "in": "query", "description": "Filters results according to the dispute's created_at date.", "schema": { "type": "string", "format": "date" } }, { "name": "endDate", "in": "query", "description": "Filters results according to the dispute's created_at date.", "schema": { "type": "string", "format": "date" } }, { "name": "page", "in": "query", "description": "Each page returns up to 10 results.", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"total\": 22,\n \"per_page\": 10,\n \"current_page\": 3,\n \"last_page\": 3,\n \"next_page_url\": null,\n \"prev_page_url\": \"https://apiprod.fattlabs.com/underwriting/disputes/merchant1?page=2\",\n \"from\": 21,\n \"to\": 22,\n \"data\": [\n {\n \"id\": \"07ad9751-443c-11ea-8e3f-0242ac140002\",\n \"transaction_id\": \"000e8694-d259-47ee-8fa1-bc0667e705a5\",\n \"merchant_id\": \"merchant1\",\n \"reason\": \"FRAUD\",\n \"amount\": 8888.88,\n \"status\": \"PENDING\",\n \"respond_by\": \"2020-01-20T23:48:03.000Z\",\n \"created_at\": \"2020-01-08T23:48:03.000Z\",\n \"updated_at\": \"2020-01-08T23:48:03.000Z\"\n },\n {\n \"id\": \"07dbfe08-443c-11ea-8e3f-0242ac140002\",\n \"transaction_id\": \"aca21c84-d37e-4d47-ad32-579dfda74458\",\n \"merchant_id\": \"merchant1\",\n \"reason\": \"FRAUD\",\n \"amount\": 8888.88,\n \"status\": \"EVIDENCE_UPLOADED\",\n \"respond_by\": \"2020-01-31T23:48:03.000Z\",\n \"created_at\": \"2020-01-08T23:48:03.000Z\",\n \"updated_at\": \"2020-01-08T23:48:03.000Z\"\n }\n ]\n}" } }, "schema": { "type": "object", "properties": { "total": { "type": "integer", "example": 22, "default": 0 }, "per_page": { "type": "integer", "example": 10, "default": 0 }, "current_page": { "type": "integer", "example": 3, "default": 0 }, "last_page": { "type": "integer", "example": 3, "default": 0 }, "next_page_url": {}, "prev_page_url": { "type": "string", "example": "https://apiprod.fattlabs.com/underwriting/disputes/merchant1?page=2" }, "from": { "type": "integer", "example": 21, "default": 0 }, "to": { "type": "integer", "example": 22, "default": 0 }, "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "07ad9751-443c-11ea-8e3f-0242ac140002" }, "transaction_id": { "type": "string", "example": "000e8694-d259-47ee-8fa1-bc0667e705a5" }, "merchant_id": { "type": "string", "example": "merchant1" }, "reason": { "type": "string", "example": "FRAUD" }, "amount": { "type": "number", "example": 8888.88, "default": 0 }, "status": { "type": "string", "example": "PENDING" }, "respond_by": { "type": "string", "example": "2020-01-20T23:48:03.000Z" }, "created_at": { "type": "string", "example": "2020-01-08T23:48:03.000Z" }, "updated_at": { "type": "string", "example": "2020-01-08T23:48:03.000Z" } } } } } } } } } }, "deprecated": false } }, "/invoice/{id}/pay/{method}": { "post": { "summary": "Mark an Invoice Paid in Cash or Check", "description": "This marks an invoice as paid manually, meaning not a processed payment, but cash, check or giftcard", "operationId": "mark-an-invoice-paid-in-cash-or-check", "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "method", "in": "path", "schema": { "type": "string", "enum": [ "cash", "check", "giftcard" ] }, "required": true }, { "name": "apply_balance", "in": "query", "description": "For doing a partial payment. Amount must be less that the invoice total", "schema": { "type": "integer", "format": "int32" } }, { "name": "email_receipt", "in": "query", "description": "Send the receipt email to the customer attached to the invoice", "schema": { "type": "boolean" } }, { "name": "check_number", "in": "query", "description": "Max length: 25", "schema": { "type": "string" } }, { "name": "driver_license", "in": "query", "description": "Max length: 45", "schema": { "type": "string" } }, { "name": "driver_license_state", "in": "query", "description": "Max length: 20", "schema": { "type": "string" } }, { "name": "payment_phone", "in": "query", "description": "Max length: 20", "schema": { "type": "string" } }, { "name": "payment_note", "in": "query", "description": "Max length: 255", "schema": { "type": "string" } } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"id\": \"eb1ff2cc-edaf-4261-b1d2-f4ba24d49076\",\n \"merchant_id\": \"dd36b936-1eb7-4ece-bebc-b514c6a36ebd\",\n \"user_id\": \"b58d7eee-e68d-4d12-a1f8-62f5e71382ae\",\n \"customer_id\": \"d45ee88c-8b27-4be8-8d81-77dda1b81826\",\n \"total\": 10000,\n \"meta\": {\n \"tax\":0,\n \"subtotal\":10000,\n \"lineItems\": [\n {\n \"id\": \"optional-fm-catalog-item-id\",\n \"item\":\"Demo Item\",\n \"details\":\"this is a regular demo item\",\n \"quantity\":1,\n \"price\": 10000\n }\n ]\n },\n \"status\": \"PARTIALLY APPLIED\",\n \"sent_at\": null,\n \"viewed_at\": null,\n \"paid_at\": null,\n \"schedule_id\": null,\n \"reminder_id\": null,\n \"payment_method_id\": \"d3050b19-77d9-44ac-9851-b1d1680a7684\",\n \"url\": \"https://app.staxpayments.com/#/bill/\",\n \"is_webpayment\": false,\n \"deleted_at\": null,\n \"created_at\": \"2017-05-10 16:05:10\",\n \"updated_at\": \"2017-05-10 16:05:26\",\n \"payment_attempt_failed\": false,\n \"payment_attempt_message\": \"\",\n \"balance_due\": 9000,\n \"total_paid\": 1000,\n \"payment_meta\": {\n \"check_number\": null,\n \"driver_license\": null,\n \"driver_license_state\": null,\n \"payment_phone\": null,\n \"payment_note\": \"Customer walked in and handed me a huge stack of cash on Thursday\",\n \"tax\":0,\n \"subtotal\":10000,\n \"lineItems\": [\n {\n \"id\": \"optional-fm-catalog-item-id\",\n \"item\":\"Demo Item\",\n \"details\":\"this is a regular demo item\",\n \"quantity\":1,\n \"price\": 10000\n }\n ]\n },\n \"customer\": {\n \"id\": \"d45ee88c-8b27-4be8-8d81-77dda1b81826\",\n \"firstname\": \"John\",\n \"lastname\": \"Smith\",\n \"company\": \"ABC INC\",\n \"email\": \"demo@abc.com\",\n \"cc_emails\": [\n \"demo1@abc.com\",\n \"demo2@abc.com\"\n ],\n \"phone\": \"1234567898\",\n \"address_1\": \"123 Rite Way\",\n \"address_2\": \"Unit 12\",\n \"address_city\": \"Orlando\",\n \"address_state\": \"FL\",\n \"address_zip\": \"32801\",\n \"address_country\": \"USA\",\n \"notes\": null,\n \"reference\": \"BARTLE\",\n \"options\": \"\",\n \"created_at\": \"2017-05-08 19:22:51\",\n \"updated_at\": \"2017-05-08 19:23:46\",\n \"deleted_at\": null,\n \"gravatar\": \"//www.gravatar.com/avatar/fe3e929dd80f1653c3a4b82812660061\"\n },\n \"user\": {\n \"id\": \"b58d7eee-e68d-4d12-a1f8-62f5e71382ae\",\n \"system_admin\": false,\n \"name\": \"Demo\",\n \"email\": \"contact@example.com\",\n \"email_verification_sent_at\": \"2017-03-29 15:27:19\",\n \"email_verified_at\": \"2017-03-29 15:27:21\",\n \"is_api_key\": false,\n \"created_at\": \"2017-01-11 21:44:02\",\n \"updated_at\": \"2017-04-24 15:41:58\",\n \"deleted_at\": null,\n \"gravatar\": \"//www.gravatar.com/avatar/157965dea7cd2f44e349382d1d791650\",\n \"team_admin\": null,\n \"team_enabled\": null,\n \"team_role\": null\n },\n \"files\": [],\n \"child_transactions\": [\n {\n \"id\": \"0292381d-412e-4911-8e6e-e4a314401f5b\",\n \"invoice_id\": \"eb1ff2cc-edaf-4261-b1d2-f4ba24d49076\",\n \"reference_id\": \"\",\n \"recurring_transaction_id\": \"\",\n \"type\": \"charge\",\n \"source\": null,\n \"merchant_id\": \"dd36b936-1eb7-4ece-bebc-b514c6a36ebd\",\n \"user_id\": \"b58d7eee-e68d-4d12-a1f8-62f5e71382ae\",\n \"customer_id\": \"d45ee88c-8b27-4be8-8d81-77dda1b81826\",\n \"payment_method_id\": \"cash\",\n \"is_manual\": true,\n \"success\": true,\n \"message\": null,\n \"meta\": {\n \"check_number\": null,\n \"driver_license\": null,\n \"driver_license_state\": null,\n \"payment_phone\": null,\n \"payment_note\": \"Customer walked in and handed me a huge stack of cash on Thursday\",,\n \"tax\":0,\n \"subtotal\":10000,\n \"lineItems\": [\n {\n \"id\": \"optional-fm-catalog-item-id\",\n \"item\":\"Demo Item\",\n \"details\":\"this is a regular demo item\",\n \"quantity\":1,\n \"price\": 10000\n }\n ]\n },\n \"total\": 1000,\n \"method\": \"cash\",\n \"pre_auth\": false,\n \"last_four\": null,\n \"receipt_email_at\": \"2017-05-10 16:05:26\",\n \"receipt_sms_at\": null,\n \"created_at\": \"2017-05-10 16:05:26\",\n \"updated_at\": \"2017-05-10 16:05:26\",\n \"total_refunded\": null,\n \"is_refundable\": false,\n \"is_voided\": false,\n \"is_voidable\": false,\n \"schedule_id\": null,\n \"customer\": {\n \"id\": \"d45ee88c-8b27-4be8-8d81-77dda1b81826\",\n \"firstname\": \"John\",\n \"lastname\": \"Smith\",\n \"company\": \"ABC INC\",\n \"email\": \"demo@abc.com\",\n \"cc_emails\": [\n \"demo1@abc.com\",\n \"demo2@abc.com\"\n ],\n \"phone\": \"1234567898\",\n \"address_1\": \"123 Rite Way\",\n \"address_2\": \"Unit 12\",\n \"address_city\": \"Orlando\",\n \"address_state\": \"FL\",\n \"address_zip\": \"32801\",\n \"address_country\": \"USA\",\n \"notes\": null,\n \"reference\": \"BARTLE\",\n \"options\": \"\",\n \"created_at\": \"2017-05-08 19:22:51\",\n \"updated_at\": \"2017-05-08 19:23:46\",\n \"deleted_at\": null,\n \"gravatar\": \"//www.gravatar.com/avatar/fe3e929dd80f1653c3a4b82812660061\"\n },\n \"child_transactions\": [],\n \"files\": [],\n \"payment_method\": {\n \"id\": \"cash\",\n \"customer_id\": \"\",\n \"merchant_id\": \"\",\n \"user_id\": \"\",\n \"nickname\": \"CASH (MANUAL ENTRY)\",\n \"is_default\": 0,\n \"method\": \"cash\",\n \"person_name\": null,\n \"card_type\": null,\n \"card_last_four\": null,\n \"card_exp\": null,\n \"bank_name\": null,\n \"bank_type\": null,\n \"bank_holder_type\": null,\n \"address_1\": null,\n \"address_2\": null,\n \"address_city\": null,\n \"address_state\": null,\n \"address_zip\": null,\n \"address_country\": null,\n \"purged_at\": null,\n \"deleted_at\": \"2017-01-18 20:41:21\",\n \"created_at\": \"2015-12-01 16:18:45\",\n \"updated_at\": \"2016-12-01 16:18:45\",\n \"card_exp_datetime\": [],\n \"customer\": null\n },\n \"user\": {\n \"id\": \"b58d7eee-e68d-4d12-a1f8-62f5e71382ae\",\n \"system_admin\": false,\n \"name\": \"Demo\",\n \"email\": \"contact@example.com\",\n \"email_verification_sent_at\": \"2017-03-29 15:27:19\",\n \"email_verified_at\": \"2017-03-29 15:27:21\",\n \"is_api_key\": false,\n \"created_at\": \"2017-01-11 21:44:02\",\n \"updated_at\": \"2017-04-24 15:41:58\",\n \"deleted_at\": null,\n \"gravatar\": \"//www.gravatar.com/avatar/157965dea7cd2f44e349382d1d791650\",\n \"team_admin\": null,\n \"team_enabled\": null,\n \"team_role\": null\n }\n }\n ],\n \"reminder\": null\n}" } } } } }, "404": { "description": "404", "content": { "application/json": { "examples": { "ID not found": { "value": "{\n \"invoice_id\": [\n \"id not found\"\n ]\n}" } }, "schema": { "type": "object", "properties": { "invoice_id": { "type": "array", "items": { "type": "string", "example": "id not found" } } } } } } }, "422": { "description": "422", "content": { "text/plain": { "examples": { "Result": { "value": "[\n \"A paid invoice can't be paid again.\"\n]" } }, "schema": { "type": "array", "items": { "type": "string", "example": "A paid invoice can't be paid again." } } } } } }, "deprecated": false } }, "/invoice/{id}/pay": { "post": { "summary": "Pay an Invoice", "description": "", "operationId": "pay-an-invoice", "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "apply_balance", "in": "query", "schema": { "type": "number", "format": "float" } }, { "name": "email_receipt", "in": "query", "schema": { "type": "boolean", "default": false } }, { "name": "payment_method_id", "in": "query", "schema": { "type": "string" } }, { "name": "idempotency_id", "in": "query", "schema": { "type": "string" } }, { "name": "funding", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"id\": \"990117ce-b31f-4e76-b027-52e90b32e465\",\n \"merchant_id\": \"c8143a7b-11f0-43b9-9258-9b1f6459d0c3\",\n \"user_id\": \"a01a5f74-cbdb-4704-9e9b-56fd5a8ee7b8\",\n \"customer_id\": \"76e81366-a900-4fff-9f6b-5f30b06c2a1d\",\n \"total\": 10,\n \"meta\": {\n \"tax\": 0,\n \"subtotal\": 10,\n \"lineItems\": [\n {\n \"id\": \"optional-fm-catalog-item-id\",\n \"item\": \"Demo Item\",\n \"details\": \"this is a regular demo item\",\n \"quantity\": 1,\n \"price\": 10\n }\n ]\n },\n \"status\": \"PAID\",\n \"is_merchant_present\": true,\n \"sent_at\": null,\n \"viewed_at\": null,\n \"paid_at\": \"2018-08-22 01:48:27\",\n \"schedule_id\": null,\n \"reminder_id\": null,\n \"payment_method_id\": \"f27192f5-c170-451c-a45e-397acb870b15\",\n \"url\": \"http://127.0.0.1:5432/#/bill/\",\n \"is_webpayment\": false,\n \"deleted_at\": null,\n \"created_at\": \"2018-08-22 01:48:05\",\n \"updated_at\": \"2018-08-22 01:48:27\",\n \"due_at\": null,\n \"payment_attempt_failed\": false,\n \"payment_attempt_message\": \"\",\n \"balance_due\": 0,\n \"total_paid\": 10,\n \"payment_meta\": {\n \"tax\": 0,\n \"subtotal\": 10\n },\n \"customer\": {\n \"id\": \"76e81366-a900-4fff-9f6b-5f30b06c2a1d\",\n \"firstname\": \"John\",\n \"lastname\": \"Smith\",\n \"company\": \"ABC INC\",\n \"email\": \"contact@example.com\",\n \"cc_emails\": [],\n \"cc_sms\": null,\n \"phone\": \"1234567898\",\n \"address_1\": \"123 Rite Way\",\n \"address_2\": \"Unit 12\",\n \"address_city\": \"Orlando\",\n \"address_state\": \"FL\",\n \"address_zip\": \"32801\",\n \"address_country\": \"USA\",\n \"notes\": null,\n \"reference\": \"\",\n \"options\": null,\n \"created_at\": \"2018-08-22 01:47:52\",\n \"updated_at\": \"2018-08-22 01:47:52\",\n \"deleted_at\": null,\n \"allow_invoice_credit_card_payments\": true,\n \"gravatar\": \"//www.gravatar.com/avatar/fe3e929dd80f1653c3a4b82812660061\"\n },\n \"user\": {\n \"id\": \"a01a5f74-cbdb-4704-9e9b-56fd5a8ee7b8\",\n \"system_admin\": true,\n \"name\": \"Bob Stevenson\",\n \"email\": \"contact@example.com\",\n \"email_verification_sent_at\": \"2018-05-31 21:22:05\",\n \"email_verified_at\": \"2017-12-14 18:34:57\",\n \"is_api_key\": false,\n \"acknowledgments\": {\n \"tutorial\": true,\n \"editedOnboardingInformation\": true,\n \"signedApplicationPowerform\": true,\n \"godviewOmniSearchTooltip\": true,\n \"godviewWelcome\": true\n },\n \"created_at\": \"2017-12-14 18:34:57\",\n \"updated_at\": \"2018-07-02 22:51:45\",\n \"deleted_at\": null,\n \"gravatar\": \"//www.gravatar.com/avatar/772cbf95746d7da86789cc3634c46ba8\",\n \"team_admin\": null,\n \"team_enabled\": null,\n \"team_role\": null,\n \"merchant_options\": [],\n \"is_default\": false\n },\n \"files\": [],\n \"child_transactions\": [\n {\n \"id\": \"a4fb512c-55ee-49ef-bef9-ce45969d39c9\",\n \"invoice_id\": \"990117ce-b31f-4e76-b027-52e90b32e465\",\n \"reference_id\": \"\",\n \"recurring_transaction_id\": \"\",\n \"auth_id\": null,\n \"type\": \"charge\",\n \"source\": null,\n \"is_merchant_present\": true,\n \"merchant_id\": \"c8143a7b-11f0-43b9-9258-9b1f6459d0c3\",\n \"user_id\": \"a01a5f74-cbdb-4704-9e9b-56fd5a8ee7b8\",\n \"customer_id\": \"76e81366-a900-4fff-9f6b-5f30b06c2a1d\",\n \"payment_method_id\": \"f27192f5-c170-451c-a45e-397acb870b15\",\n \"is_manual\": false,\n \"success\": true,\n \"message\": null,\n \"meta\": {\n \"tax\": 0,\n \"subtotal\": 10,\n \"lineItems\": [\n {\n \"id\": \"optional-fm-catalog-item-id\",\n \"item\": \"Demo Item\",\n \"details\": \"this is a regular demo item\",\n \"quantity\": 1,\n \"price\": 10\n }\n ]\n },\n \"total\": 10,\n \"method\": \"card\",\n \"pre_auth\": false,\n \"is_captured\": 0,\n \"last_four\": \"8888\",\n \"interchange_code\": \"\",\n \"interchange_fee\": null,\n \"batch_id\": \"\",\n \"batched_at\": \"2018-08-21 21:48:27\",\n \"emv_response\": \"\",\n \"avs_response\": \"\",\n \"cvv_response\": \"\",\n \"pos_entry\": \"\",\n \"pos_salesperson\": \"\",\n \"receipt_email_at\": \"2018-08-22 01:48:27\",\n \"receipt_sms_at\": null,\n \"created_at\": \"2018-08-22 01:48:25\",\n \"updated_at\": \"2018-08-22 01:48:27\",\n \"total_refunded\": 0,\n \"is_refundable\": false,\n \"is_voided\": false,\n \"is_voidable\": true,\n \"currency\": \"USD\",\n \"schedule_id\": null,\n \"child_captures\": [],\n \"parent_auth\": null,\n \"customer\": {\n \"id\": \"76e81366-a900-4fff-9f6b-5f30b06c2a1d\",\n \"firstname\": \"John\",\n \"lastname\": \"Smith\",\n \"company\": \"ABC INC\",\n \"email\": \"demo@abc.com\",\n \"cc_emails\": [],\n \"cc_sms\": null,\n \"phone\": \"1234567898\",\n \"address_1\": \"123 Rite Way\",\n \"address_2\": \"Unit 12\",\n \"address_city\": \"Orlando\",\n \"address_state\": \"FL\",\n \"address_zip\": \"32801\",\n \"address_country\": \"USA\",\n \"notes\": null,\n \"reference\": \"\",\n \"options\": null,\n \"created_at\": \"2018-08-22 01:47:52\",\n \"updated_at\": \"2018-08-22 01:47:52\",\n \"deleted_at\": null,\n \"allow_invoice_credit_card_payments\": true,\n \"gravatar\": \"//www.gravatar.com/avatar/fe3e929dd80f1653c3a4b82812660061\"\n },\n \"child_transactions\": [],\n \"files\": [],\n \"payment_method\": {\n \"id\": \"f27192f5-c170-451c-a45e-397acb870b15\",\n \"customer_id\": \"76e81366-a900-4fff-9f6b-5f30b06c2a1d\",\n \"merchant_id\": \"c8143a7b-11f0-43b9-9258-9b1f6459d0c3\",\n \"user_id\": \"a01a5f74-cbdb-4704-9e9b-56fd5a8ee7b8\",\n \"nickname\": \"VISA: Steven Smith Jr. (ending in: 8888)\",\n \"has_cvv\": 1,\n \"is_default\": 1,\n \"method\": \"card\",\n \"person_name\": \"Steven Smith Jr.\",\n \"card_type\": \"visa\",\n \"card_last_four\": \"8888\",\n \"card_exp\": \"042019\",\n \"bank_name\": null,\n \"bank_type\": null,\n \"bank_holder_type\": null,\n \"address_1\": null,\n \"address_2\": null,\n \"address_city\": null,\n \"address_state\": null,\n \"address_zip\": \"32944\",\n \"address_country\": \"USA\",\n \"purged_at\": null,\n \"deleted_at\": null,\n \"created_at\": \"2018-08-22 01:47:59\",\n \"updated_at\": \"2018-08-22 01:47:59\",\n \"card_exp_datetime\": \"2019-04-30 23:59:59\",\n \"is_usable_in_vt\": true,\n \"customer\": {\n \"id\": \"76e81366-a900-4fff-9f6b-5f30b06c2a1d\",\n \"firstname\": \"John\",\n \"lastname\": \"Smith\",\n \"company\": \"ABC INC\",\n \"email\": \"contact@example.com\",\n \"cc_emails\": [],\n \"cc_sms\": null,\n \"phone\": \"1234567898\",\n \"address_1\": \"123 Rite Way\",\n \"address_2\": \"Unit 12\",\n \"address_city\": \"Orlando\",\n \"address_state\": \"FL\",\n \"address_zip\": \"32801\",\n \"address_country\": \"USA\",\n \"notes\": null,\n \"reference\": \"\",\n \"options\": null,\n \"created_at\": \"2018-08-22 01:47:52\",\n \"updated_at\": \"2018-08-22 01:47:52\",\n \"deleted_at\": null,\n \"allow_invoice_credit_card_payments\": true,\n \"gravatar\": \"//www.gravatar.com/avatar/fe3e929dd80f1653c3a4b82812660061\"\n }\n },\n \"user\": {\n \"id\": \"a01a5f74-cbdb-4704-9e9b-56fd5a8ee7b8\",\n \"system_admin\": true,\n \"name\": \"Bob Stevenson\",\n \"email\": \"contact@example.com\",\n \"email_verification_sent_at\": \"2018-05-31 21:22:05\",\n \"email_verified_at\": \"2017-12-14 18:34:57\",\n \"is_api_key\": false,\n \"acknowledgments\": {\n \"tutorial\": true,\n \"editedOnboardingInformation\": true,\n \"signedApplicationPowerform\": true,\n \"godviewOmniSearchTooltip\": true,\n \"godviewWelcome\": true\n },\n \"created_at\": \"2017-12-14 18:34:57\",\n \"updated_at\": \"2018-07-02 22:51:45\",\n \"deleted_at\": null,\n \"gravatar\": \"\",\n \"team_admin\": null,\n \"team_enabled\": null,\n \"team_role\": null,\n \"merchant_options\": [],\n \"is_default\": false\n }\n }\n ],\n \"reminder\": null\n}" } }, "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "990117ce-b31f-4e76-b027-52e90b32e465" }, "merchant_id": { "type": "string", "example": "c8143a7b-11f0-43b9-9258-9b1f6459d0c3" }, "user_id": { "type": "string", "example": "a01a5f74-cbdb-4704-9e9b-56fd5a8ee7b8" }, "customer_id": { "type": "string", "example": "76e81366-a900-4fff-9f6b-5f30b06c2a1d" }, "total": { "type": "integer", "example": 10, "default": 0 }, "meta": { "type": "object", "properties": { "tax": { "type": "integer", "example": 0, "default": 0 }, "subtotal": { "type": "integer", "example": 10, "default": 0 }, "lineItems": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "optional-fm-catalog-item-id" }, "item": { "type": "string", "example": "Demo Item" }, "details": { "type": "string", "example": "this is a regular demo item" }, "quantity": { "type": "integer", "example": 1, "default": 0 }, "price": { "type": "integer", "example": 10, "default": 0 } } } } } }, "status": { "type": "string", "example": "PAID" }, "is_merchant_present": { "type": "boolean", "example": true, "default": true }, "sent_at": {}, "viewed_at": {}, "paid_at": { "type": "string", "example": "2018-08-22 01:48:27" }, "schedule_id": {}, "reminder_id": {}, "payment_method_id": { "type": "string", "example": "f27192f5-c170-451c-a45e-397acb870b15" }, "url": { "type": "string", "example": "http://127.0.0.1:5432/#/bill/" }, "is_webpayment": { "type": "boolean", "example": false, "default": true }, "deleted_at": {}, "created_at": { "type": "string", "example": "2018-08-22 01:48:05" }, "updated_at": { "type": "string", "example": "2018-08-22 01:48:27" }, "due_at": {}, "payment_attempt_failed": { "type": "boolean", "example": false, "default": true }, "payment_attempt_message": { "type": "string", "example": "" }, "balance_due": { "type": "integer", "example": 0, "default": 0 }, "total_paid": { "type": "integer", "example": 10, "default": 0 }, "payment_meta": { "type": "object", "properties": { "tax": { "type": "integer", "example": 0, "default": 0 }, "subtotal": { "type": "integer", "example": 10, "default": 0 } } }, "customer": { "type": "object", "properties": { "id": { "type": "string", "example": "76e81366-a900-4fff-9f6b-5f30b06c2a1d" }, "firstname": { "type": "string", "example": "John" }, "lastname": { "type": "string", "example": "Smith" }, "company": { "type": "string", "example": "ABC INC" }, "email": { "type": "string", "example": "contact@example.com" }, "cc_emails": { "type": "array" }, "cc_sms": {}, "phone": { "type": "string", "example": "1234567898" }, "address_1": { "type": "string", "example": "123 Rite Way" }, "address_2": { "type": "string", "example": "Unit 12" }, "address_city": { "type": "string", "example": "Orlando" }, "address_state": { "type": "string", "example": "FL" }, "address_zip": { "type": "string", "example": "32801" }, "address_country": { "type": "string", "example": "USA" }, "notes": {}, "reference": { "type": "string", "example": "" }, "options": {}, "created_at": { "type": "string", "example": "2018-08-22 01:47:52" }, "updated_at": { "type": "string", "example": "2018-08-22 01:47:52" }, "deleted_at": {}, "allow_invoice_credit_card_payments": { "type": "boolean", "example": true, "default": true }, "gravatar": { "type": "string", "example": "//www.gravatar.com/avatar/fe3e929dd80f1653c3a4b82812660061" } } }, "user": { "type": "object", "properties": { "id": { "type": "string", "example": "a01a5f74-cbdb-4704-9e9b-56fd5a8ee7b8" }, "system_admin": { "type": "boolean", "example": true, "default": true }, "name": { "type": "string", "example": "Bob Stevenson" }, "email": { "type": "string", "example": "contact@example.com" }, "email_verification_sent_at": { "type": "string", "example": "2018-05-31 21:22:05" }, "email_verified_at": { "type": "string", "example": "2017-12-14 18:34:57" }, "is_api_key": { "type": "boolean", "example": false, "default": true }, "acknowledgments": { "type": "object", "properties": { "tutorial": { "type": "boolean", "example": true, "default": true }, "editedOnboardingInformation": { "type": "boolean", "example": true, "default": true }, "signedApplicationPowerform": { "type": "boolean", "example": true, "default": true }, "godviewOmniSearchTooltip": { "type": "boolean", "example": true, "default": true }, "godviewWelcome": { "type": "boolean", "example": true, "default": true } } }, "created_at": { "type": "string", "example": "2017-12-14 18:34:57" }, "updated_at": { "type": "string", "example": "2018-07-02 22:51:45" }, "deleted_at": {}, "gravatar": { "type": "string", "example": "//www.gravatar.com/avatar/772cbf95746d7da86789cc3634c46ba8" }, "team_admin": {}, "team_enabled": {}, "team_role": {}, "merchant_options": { "type": "array" }, "is_default": { "type": "boolean", "example": false, "default": true } } }, "files": { "type": "array" }, "child_transactions": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "a4fb512c-55ee-49ef-bef9-ce45969d39c9" }, "invoice_id": { "type": "string", "example": "990117ce-b31f-4e76-b027-52e90b32e465" }, "reference_id": { "type": "string", "example": "" }, "recurring_transaction_id": { "type": "string", "example": "" }, "auth_id": {}, "type": { "type": "string", "example": "charge" }, "source": {}, "is_merchant_present": { "type": "boolean", "example": true, "default": true }, "merchant_id": { "type": "string", "example": "c8143a7b-11f0-43b9-9258-9b1f6459d0c3" }, "user_id": { "type": "string", "example": "a01a5f74-cbdb-4704-9e9b-56fd5a8ee7b8" }, "customer_id": { "type": "string", "example": "76e81366-a900-4fff-9f6b-5f30b06c2a1d" }, "payment_method_id": { "type": "string", "example": "f27192f5-c170-451c-a45e-397acb870b15" }, "is_manual": { "type": "boolean", "example": false, "default": true }, "success": { "type": "boolean", "example": true, "default": true }, "message": {}, "meta": { "type": "object", "properties": { "tax": { "type": "integer", "example": 0, "default": 0 }, "subtotal": { "type": "integer", "example": 10, "default": 0 }, "lineItems": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "optional-fm-catalog-item-id" }, "item": { "type": "string", "example": "Demo Item" }, "details": { "type": "string", "example": "this is a regular demo item" }, "quantity": { "type": "integer", "example": 1, "default": 0 }, "price": { "type": "integer", "example": 10, "default": 0 } } } } } }, "total": { "type": "integer", "example": 10, "default": 0 }, "method": { "type": "string", "example": "card" }, "pre_auth": { "type": "boolean", "example": false, "default": true }, "is_captured": { "type": "integer", "example": 0, "default": 0 }, "last_four": { "type": "string", "example": "8888" }, "interchange_code": { "type": "string", "example": "" }, "interchange_fee": {}, "batch_id": { "type": "string", "example": "" }, "batched_at": { "type": "string", "example": "2018-08-21 21:48:27" }, "emv_response": { "type": "string", "example": "" }, "avs_response": { "type": "string", "example": "" }, "cvv_response": { "type": "string", "example": "" }, "pos_entry": { "type": "string", "example": "" }, "pos_salesperson": { "type": "string", "example": "" }, "receipt_email_at": { "type": "string", "example": "2018-08-22 01:48:27" }, "receipt_sms_at": {}, "created_at": { "type": "string", "example": "2018-08-22 01:48:25" }, "updated_at": { "type": "string", "example": "2018-08-22 01:48:27" }, "total_refunded": { "type": "integer", "example": 0, "default": 0 }, "is_refundable": { "type": "boolean", "example": false, "default": true }, "is_voided": { "type": "boolean", "example": false, "default": true }, "is_voidable": { "type": "boolean", "example": true, "default": true }, "currency": { "type": "string", "example": "USD" }, "schedule_id": {}, "child_captures": { "type": "array" }, "parent_auth": {}, "customer": { "type": "object", "properties": { "id": { "type": "string", "example": "76e81366-a900-4fff-9f6b-5f30b06c2a1d" }, "firstname": { "type": "string", "example": "John" }, "lastname": { "type": "string", "example": "Smith" }, "company": { "type": "string", "example": "ABC INC" }, "email": { "type": "string", "example": "demo@abc.com" }, "cc_emails": { "type": "array" }, "cc_sms": {}, "phone": { "type": "string", "example": "1234567898" }, "address_1": { "type": "string", "example": "123 Rite Way" }, "address_2": { "type": "string", "example": "Unit 12" }, "address_city": { "type": "string", "example": "Orlando" }, "address_state": { "type": "string", "example": "FL" }, "address_zip": { "type": "string", "example": "32801" }, "address_country": { "type": "string", "example": "USA" }, "notes": {}, "reference": { "type": "string", "example": "" }, "options": {}, "created_at": { "type": "string", "example": "2018-08-22 01:47:52" }, "updated_at": { "type": "string", "example": "2018-08-22 01:47:52" }, "deleted_at": {}, "allow_invoice_credit_card_payments": { "type": "boolean", "example": true, "default": true }, "gravatar": { "type": "string", "example": "//www.gravatar.com/avatar/fe3e929dd80f1653c3a4b82812660061" } } }, "child_transactions": { "type": "array" }, "files": { "type": "array" }, "payment_method": { "type": "object", "properties": { "id": { "type": "string", "example": "f27192f5-c170-451c-a45e-397acb870b15" }, "customer_id": { "type": "string", "example": "76e81366-a900-4fff-9f6b-5f30b06c2a1d" }, "merchant_id": { "type": "string", "example": "c8143a7b-11f0-43b9-9258-9b1f6459d0c3" }, "user_id": { "type": "string", "example": "a01a5f74-cbdb-4704-9e9b-56fd5a8ee7b8" }, "nickname": { "type": "string", "example": "VISA: Steven Smith Jr. (ending in: 8888)" }, "has_cvv": { "type": "integer", "example": 1, "default": 0 }, "is_default": { "type": "integer", "example": 1, "default": 0 }, "method": { "type": "string", "example": "card" }, "person_name": { "type": "string", "example": "Steven Smith Jr." }, "card_type": { "type": "string", "example": "visa" }, "card_last_four": { "type": "string", "example": "8888" }, "card_exp": { "type": "string", "example": "042019" }, "bank_name": {}, "bank_type": {}, "bank_holder_type": {}, "address_1": {}, "address_2": {}, "address_city": {}, "address_state": {}, "address_zip": { "type": "string", "example": "32944" }, "address_country": { "type": "string", "example": "USA" }, "purged_at": {}, "deleted_at": {}, "created_at": { "type": "string", "example": "2018-08-22 01:47:59" }, "updated_at": { "type": "string", "example": "2018-08-22 01:47:59" }, "card_exp_datetime": { "type": "string", "example": "2019-04-30 23:59:59" }, "is_usable_in_vt": { "type": "boolean", "example": true, "default": true }, "customer": { "type": "object", "properties": { "id": { "type": "string", "example": "76e81366-a900-4fff-9f6b-5f30b06c2a1d" }, "firstname": { "type": "string", "example": "John" }, "lastname": { "type": "string", "example": "Smith" }, "company": { "type": "string", "example": "ABC INC" }, "email": { "type": "string", "example": "contact@example.com" }, "cc_emails": { "type": "array" }, "cc_sms": {}, "phone": { "type": "string", "example": "1234567898" }, "address_1": { "type": "string", "example": "123 Rite Way" }, "address_2": { "type": "string", "example": "Unit 12" }, "address_city": { "type": "string", "example": "Orlando" }, "address_state": { "type": "string", "example": "FL" }, "address_zip": { "type": "string", "example": "32801" }, "address_country": { "type": "string", "example": "USA" }, "notes": {}, "reference": { "type": "string", "example": "" }, "options": {}, "created_at": { "type": "string", "example": "2018-08-22 01:47:52" }, "updated_at": { "type": "string", "example": "2018-08-22 01:47:52" }, "deleted_at": {}, "allow_invoice_credit_card_payments": { "type": "boolean", "example": true, "default": true }, "gravatar": { "type": "string", "example": "//www.gravatar.com/avatar/fe3e929dd80f1653c3a4b82812660061" } } } } }, "user": { "type": "object", "properties": { "id": { "type": "string", "example": "a01a5f74-cbdb-4704-9e9b-56fd5a8ee7b8" }, "system_admin": { "type": "boolean", "example": true, "default": true }, "name": { "type": "string", "example": "Bob Stevenson" }, "email": { "type": "string", "example": "contact@example.com" }, "email_verification_sent_at": { "type": "string", "example": "2018-05-31 21:22:05" }, "email_verified_at": { "type": "string", "example": "2017-12-14 18:34:57" }, "is_api_key": { "type": "boolean", "example": false, "default": true }, "acknowledgments": { "type": "object", "properties": { "tutorial": { "type": "boolean", "example": true, "default": true }, "editedOnboardingInformation": { "type": "boolean", "example": true, "default": true }, "signedApplicationPowerform": { "type": "boolean", "example": true, "default": true }, "godviewOmniSearchTooltip": { "type": "boolean", "example": true, "default": true }, "godviewWelcome": { "type": "boolean", "example": true, "default": true } } }, "created_at": { "type": "string", "example": "2017-12-14 18:34:57" }, "updated_at": { "type": "string", "example": "2018-07-02 22:51:45" }, "deleted_at": {}, "gravatar": { "type": "string", "example": "" }, "team_admin": {}, "team_enabled": {}, "team_role": {}, "merchant_options": { "type": "array" }, "is_default": { "type": "boolean", "example": false, "default": true } } } } } }, "reminder": {} } } } } }, "422": { "description": "422", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"payment_method_id\": [\n \"The selected payment method id is invalid.\"\n ],\n \"email_receipt\": [\n \"The email receipt field must be true or false.\"\n ],\n \"apply_balance\": [\n \"The apply balance must be a number.\"\n ]\n}" } }, "schema": { "type": "object", "properties": { "payment_method_id": { "type": "array", "items": { "type": "string", "example": "The selected payment method id is invalid." } }, "email_receipt": { "type": "array", "items": { "type": "string", "example": "The email receipt field must be true or false." } }, "apply_balance": { "type": "array", "items": { "type": "string", "example": "The apply balance must be a number." } } } } } } } }, "deprecated": false } }, "/terminal/print": { "post": { "summary": "Print", "description": "Prints a custom multi-line message or receipt supplement on the terminal's paper printer.", "operationId": "print", "parameters": [], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"RegisterId\": 3594291,\n \"Message\": \"Success\",\n \"cancelled\": false,\n \"gatewayStatus\": 200,\n \"gatewayStatusText\": \"OK\",\n \"success\": true,\n \"RespMSG\": \"undefined\"\n}" } }, "schema": { "type": "object", "properties": { "RegisterId": { "type": "integer", "example": 3594291, "default": 0 }, "Message": { "type": "string", "example": "Success" }, "cancelled": { "type": "boolean", "example": false, "default": true }, "gatewayStatus": { "type": "integer", "example": 200, "default": 0 }, "gatewayStatusText": { "type": "string", "example": "OK" }, "success": { "type": "boolean", "example": true, "default": true }, "RespMSG": { "type": "string", "example": "undefined" } } } } } } }, "deprecated": false, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "array", "items": { "type": "string" }, "required": true, "description": "The message which will print on the receipt. When specifying multiple strings within the array, each new string will begin on a new line. A single string may not respect word wrap on all terminal models." }, "register": { "type": "string", "required": true, "description": "The id of the register performing this operation. This should be the 'id' value returned by GET /terminal/register, not the register number or serial." } }, "required": [ "register", "message" ] } } } } } }, "/terminal/promptChoice": { "post": { "description": "", "operationId": "get_terminalpromptChoice", "responses": { "200": { "description": "" } }, "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "register": { "type": "string", "description": "The id of the register performing this operation." }, "title": { "type": "string", "description": "Title for this prompt, displayed on the top of the terminal screen. Default is \"\" (empty string)." }, "choices": { "type": "array", "description": "Choices to present to the user.", "items": { "type": "string" } } }, "required": [ "register", "choices" ] } } } } } }, "/terminal/promptInput": { "post": { "summary": "Prompt (Input)", "description": "Displays a text input prompt on the terminal for the customer or clerk to enter free-form data (e.g., table number, PO reference). Returns the entered string in the response.\n\nUsage:\n- Provide `register`.\n- Optional `title` customizes terminal screen header.\n\nConsiderations: Length and character restrictions depend on device; keep alphanumeric to ensure compatibility. Provide client-side validation if a specific format is needed.\n\nSecurity: ApiKeyAuth or EphemeralAuth.\n\nErrors: Cancelled entry, timeout, unsupported character input.", "security": [ { "ApiKeyAuth": [] } ], "operationId": "prompt-input", "parameters": [], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"input\": \"G164\"\n}" } }, "schema": { "type": "object", "properties": { "input": { "type": "string", "example": "G164" } } } } } } }, "deprecated": false, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "register": { "type": "string", "required": true, "description": " The id of the register performing this operation. This should be the 'id' value returned by GET /terminal/register." }, "title": { "type": "string", "description": "Title for this prompt, displayed on the top of the terminal screen. Defaults to '' (empty string)." } }, "required": [ "register" ] } } } } } }, "/terminal/prompt/signature": { "post": { "summary": "Prompt (Signature)", "description": "Captures a digital signature on the terminal when card brand or merchant configuration requires it (e.g., high amount, specific entry mode).", "security": [ { "ApiKeyAuth": [] } ], "operationId": "prompt-signature", "parameters": [], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"signature\": \"Qk1eCgAAAAAAAD4AAAAoAAAAIAEAAEgAAAABAAEAAAAAACAKAADEDgAAxA4AAAAAAAAAAAAAAAAAAP///wD///////////////////////4///////////////////////////////////////////////4///////////////////////////////////////////////4f/////////////h////////////////////////////////4P/////////////gf///////////////Af//////////////8P/////////////gH////////////4AAAB//////////////+H//////+P/////4B//////8D////AAAAAP/////////////+D//////8P/////+Af////4AD////AAAOAB//////////////B//////4P//////gH///+AAD////B///4Af/////4///////gf/////gP//////4A//+AAA//////////AB/////4///////wP////8A///////+AP/wAB///////////4B/////4///////4AAH//8B////////gBAAAf///////////+B/////4///////8AAAAAAH////////8AAAf////////////8B/////4///////8AAAAAAf////////4AAD/////////////AD/////4////////gfgAAA////////8AAA/////////////8AH/////4////////wP//4D///////+AAGAH////////////gA//////4////////8H//AH///////AAB/wB///////////4AP//////4////////+B/8Af//////wAA//8Af/////////8AA///////4/////////A/wB//////8AAf///gH/////////AAH///////4/////////geAP//////wAP////4B////////wAB/////gP/4/////////4AA///////wD/////+AP//////8AA//////gAB4f////////8AD///////w///////gH//////wAP//////gAAAAAAA/////8Af///////////////4B//////gD////////AAAAAAA////////////////////////B//////gAD////////4AAAAA////////////////////////h//////gAAAP///////8f///////////////////////////////////AAAAAD///////////////////////////////////////////wAAAAf////////////////////////////////////////////AAAf//////////////////////////////////////////////wf///////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////gP////////////////////////////////////////////+AAP///////////////////////////////////////////8AAAP//////////////////////////////////////////gAAAH//////////////////////////////////////////4AAAf/////////////////////////////////////////+AAAA///8H/////////////+AAH/////////////////////gAAH////8AH////////////+AAAAAAAAAAAP///////////4AAB/////8AAP///////////+AAAAAAAAAAAP//////////+AAf///////gAA//////////////gAAAAAAAAP//////////4AH/////////gAB////////////////////////////////+AB///////////AAB///////////////////////////////wAf///////////8AAH//////////////////////////////gB/////////////4AB///////////////j/////////////+Af//////////////4AH//////////////j/////////////8D////////////////gAf/////////////j/////////////8H////////////////4AD/////////////j/////////////4f/////////////////gAf////////////j/////////////4f/////////////////+AH////////////j/////////////4///////////////////wA////////////j/////////////4/////////j/////////+AH///////////j/////////////4f///////+D//////////gD///////////j/////////////4P///////8D//////////8B///////////j/////////////8H///////wH8P/////////g///////////j/////////////8B//////8Af8B/////////wf//////////j//////////////Af////8AA/8AD////////wf//////////j//////////////gH///4AAD//AAD///////gf//////////D//////////////4B//gAAA///4AAAAH///+B///////////D//////////////+AAAAAA/////wAAAAAAAAD///////////H///////////////gAAAB///////wAAAAAAAH///////////H///////////////4AAH///////////gAAAAf///////////H////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////8AAAAAAAAAAAD///////////////////////////////////8AAAAAAAAAAAD///////////////////////////////////8AAAAAAAAAAAD///////////////////////////////////8=\",\n}" } } } } } }, "deprecated": false, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "register": { "type": "string", "required": true, "description": "The id of the register performing this operation. This should be the 'id' value returned by GET /terminal/register." } }, "required": [ "register" ] } } } } } }, "/query/statement/v3/adjustments": { "get": { "summary": "Refund and Adjustments", "description": "", "operationId": "refund-and-adjustments", "parameters": [ { "name": "startDate", "in": "query", "required": true, "description": "YYYY-MM-DD", "schema": { "type": "string", "default": "" } }, { "name": "endDate", "in": "query", "required": true, "description": "YYYY-MM-DD", "schema": { "type": "string", "default": "" } } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"data\": [\n {\n \"id\": \"redacted-refund-1\",\n \"transaction_id\": \"redacted-transaction-id-1\",\n \"batch_id\": \"redacted-batch-id\",\n \"type\": \"refund\",\n \"subtype\": null,\n \"amount\": 217.5,\n \"created_at\": \"2024-02-14T16:48:51.000Z\"\n },\n {\n \"id\": \"11ee02f21cd6a3d5cccba85de9ee707b\",\n \"transaction_id\": \"1b9f50e0-a4f1-4153-8f28-9e2f7ced3d66\",\n \"batch_id\": \"11eedb477e29181eccdaad9f093a0c00\",\n \"type\": \"refund\",\n \"subtype\": null,\n \"amount\": 292.5,\n \"created_at\": \"2024-02-14T16:52:15.000Z\"\n }\n ],\n \"summary\": {\n \"adjustments_count\": 2,\n \"adjustments_amount\": 510\n },\n \"total\": 2,\n \"per_page\": 1000,\n \"current_page\": 1,\n \"last_page\": 1,\n \"next_page_url\": null,\n \"prev_page_url\": null,\n \"from\": 1,\n \"to\": 2\n}" } }, "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "redacted-refund-1" }, "transaction_id": { "type": "string", "example": "redacted-transaction-id-1" }, "batch_id": { "type": "string", "example": "redacted-batch-id" }, "type": { "type": "string", "example": "refund" }, "subtype": {}, "amount": { "type": "number", "example": 217.5, "default": 0 }, "created_at": { "type": "string", "example": "2024-02-14T16:48:51.000Z" } } } }, "summary": { "type": "object", "properties": { "adjustments_count": { "type": "integer", "example": 2, "default": 0 }, "adjustments_amount": { "type": "integer", "example": 510, "default": 0 } } }, "total": { "type": "integer", "example": 2, "default": 0 }, "per_page": { "type": "integer", "example": 1000, "default": 0 }, "current_page": { "type": "integer", "example": 1, "default": 0 }, "last_page": { "type": "integer", "example": 1, "default": 0 }, "next_page_url": {}, "prev_page_url": {}, "from": { "type": "integer", "example": 1, "default": 0 }, "to": { "type": "integer", "example": 2, "default": 0 } } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "{}" } }, "schema": { "type": "object", "properties": {} } } } } }, "deprecated": false } }, "/transaction/{id}/refund": { "post": { "summary": "Refund Transaction", "description": "Return funds from the merchant to the customer after a transaction has been processed (batched)", "operationId": "refund-transaction", "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "total" ], "properties": { "total": { "type": "string" } } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{}" } }, "schema": { "type": "object", "properties": {} } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "{}" } }, "schema": { "type": "object", "properties": {} } } } } }, "deprecated": false } }, "/terminal/refund": { "post": { "summary": "Refund", "description": "Performs a card-present refund for a prior sale by re-presenting the card at the terminal.", "operationId": "refund", "parameters": [], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"id\": \"4be11b7e-21cb-4c9e-ba8f-5e173d13d7b7\",\n \"invoice_id\": \"\",\n \"reference_id\": \"5114aea7-5c7f-40ab-8a62-84f239e4b2b1\",\n \"recurring_transaction_id\": \"\",\n \"auth_id\": null,\n \"type\": \"refund\",\n \"source\": \"terminalservice.dejavoo\",\n \"is_merchant_present\": true,\n \"merchant_id\": \"27fad5e4-0210-4c91-9596-417b0ea0dbb1\",\n \"user_id\": \"dbc85118-3309-4129-b966-0108c0fb18a0\",\n \"customer_id\": \"2a503ed1-99ea-4b35-a30a-605253f7c05a\",\n \"payment_method_id\": \"bf1aee65-dad9-4b74-8800-a75e435e3e7b\",\n \"is_manual\": true,\n \"success\": true,\n \"message\": \"\",\n \"meta\": {\n \"lineItems\": [\n {\n \"item\": \"\",\n \"details\": \"\",\n \"quantity\": 1,\n \"price\": \"0.01\"\n }\n ],\n \"subtotal\": 0.01,\n \"tax\": 0,\n \"taxRate\": 10,\n \"isBulkInvoice\": false,\n \"taxOverride\": false,\n \"update_inventory\": true,\n \"reference\": 2477,\n \"RegisterId\": 3594291,\n \"ResultCode\": 0,\n \"RespMSG\": \"Approved Offline\",\n \"Message\": \"Approved\",\n \"AuthCode\": 145599,\n \"PNRef\": 810618212223,\n \"PaymentType\": \"Credit\",\n \"TransType\": \"Return\",\n \"SN\": 118816524647,\n \"ExtData\": {\n \"Amount\": \"0.01\",\n \"InvNum\": \"10\",\n \"CardType\": \"VISA\",\n \"BatchNum\": \"56\",\n \"Tip\": \"0.00\",\n \"CashBack\": \"0.00\",\n \"Fee\": \"0.00\",\n \"AcntLast4\": \"0281\",\n \"Name\": \"YOU/A GIFT FOR\",\n \"SVC\": \"0.00\",\n \"TotalAmt\": \"0.01\",\n \"DISC\": \"0.00\",\n \"Donation\": \"0.00\",\n \"SHFee\": \"0.00\",\n \"RwdPoints\": \"0\",\n \"RwdBalance\": \"0\",\n \"RwdIssued\": \"\",\n \"EBTFSLedgerBalance\": \"\",\n \"EBTFSAvailBalance\": \"\",\n \"EBTFSBeginBalance\": \"\",\n \"EBTCashLedgerBalance\": \"\",\n \"EBTCashAvailBalance\": \"\",\n \"EBTCashBeginBalance\": \"\",\n \"RewardCode\": \"\",\n \"AcqRefData\": \"\",\n \"ProcessData\": \"\",\n \"RefNo\": \"\",\n \"RewardQR\": \"\",\n \"Language\": \"English\",\n \"EntryType\": \"Swipe\",\n \"table_num\": \"0\",\n \"clerk_id\": \"\",\n \"ticket_num\": \"\",\n \"ControlNum\": \"\",\n \"TaxCity\": \"0.00\",\n \"TaxState\": \"0.00\",\n \"Cust1\": \"\",\n \"Cust1Value\": \"\",\n \"Cust2\": \"\",\n \"Cust2Value\": \"\",\n \"Cust3\": \"\",\n \"Cust3Value\": \"\",\n \"AcntFirst4\": \"4941\"\n },\n \"CVMResult\": 2,\n \"cancelled\": false,\n \"gatewayStatus\": 200,\n \"gatewayStatusText\": \"OK\",\n \"printReceipt\": \"Both\",\n \"paymentType\": \"Credit\",\n \"type\": \"refund\",\n \"registerId\": \"4f1b-f10a\",\n \"registerStatusPort\": \"3594291\",\n \"registerNickname\": \"Tech Area Z8 (3594291)\",\n \"registerSerial\": \"124124\",\n \"registerType\": \"dejavoo\"\n },\n \"total\": 0.01,\n \"method\": \"card\",\n \"pre_auth\": false,\n \"is_captured\": 0,\n \"last_four\": \"5114\",\n \"interchange_code\": \"\",\n \"interchange_fee\": null,\n \"batch_id\": \"\",\n \"batched_at\": \"2018-04-16 19:09:37\",\n \"emv_response\": \"\",\n \"avs_response\": \"\",\n \"cvv_response\": \"\",\n \"pos_entry\": \"\",\n \"pos_salesperson\": \"\",\n \"receipt_email_at\": null,\n \"receipt_sms_at\": null,\n \"created_at\": \"2018-04-16 19:09:37\",\n \"updated_at\": \"2018-04-16 19:09:37\",\n \"total_refunded\": 0,\n \"is_refundable\": false,\n \"is_voided\": false,\n \"is_voidable\": false,\n \"schedule_id\": null,\n \"child_captures\": [],\n \"parent_auth\": null,\n \"customer\": {\n \"id\": \"2a503ed1-99ea-4b35-a30a-605253f7c05a\",\n \"firstname\": \"A\",\n \"lastname\": \"Customer\",\n \"company\": \"\",\n \"email\": \"\",\n \"cc_emails\": [],\n \"cc_sms\": null,\n \"phone\": \"\",\n \"address_1\": \"\",\n \"address_2\": \"\",\n \"address_city\": \"\",\n \"address_state\": \"\",\n \"address_zip\": \"\",\n \"address_country\": \"USA\",\n \"notes\": \"\",\n \"reference\": \"\",\n \"options\": \"\",\n \"created_at\": \"2018-02-23 22:32:19\",\n \"updated_at\": \"2018-02-23 22:32:19\",\n \"deleted_at\": null,\n \"allow_invoice_credit_card_payments\": true,\n \"gravatar\": false\n },\n \"child_transactions\": [],\n \"files\": [],\n \"payment_method\": {\n \"id\": \"bf1aee65-dad9-4b74-8800-a75e435e3e7b\",\n \"customer_id\": \"2a503ed1-99ea-4b35-a30a-605253f7c05a\",\n \"merchant_id\": \"27fad5e4-0210-4c91-9596-417b0ea0dbb1\",\n \"user_id\": \"dbc85118-3309-4129-b966-0108c0fb18a0\",\n \"nickname\": \"VISA: YOU/A GIFT FOR (ending in: 0281)\",\n \"has_cvv\": 0,\n \"is_default\": 1,\n \"method\": \"card\",\n \"person_name\": \"YOU/A GIFT FOR\",\n \"card_type\": \"visa\",\n \"card_last_four\": \"0281\",\n \"card_exp\": \"992099\",\n \"bank_name\": null,\n \"bank_type\": null,\n \"bank_holder_type\": null,\n \"address_1\": null,\n \"address_2\": null,\n \"address_city\": null,\n \"address_state\": null,\n \"address_zip\": \"\",\n \"address_country\": \"\",\n \"purged_at\": null,\n \"deleted_at\": null,\n \"created_at\": \"2018-04-16 19:09:36\",\n \"updated_at\": \"2018-04-16 19:09:36\",\n \"card_exp_datetime\": \"2107-03-31 23:59:59\",\n \"customer\": {\n \"id\": \"2a503ed1-99ea-4b35-a30a-605253f7c05a\",\n \"firstname\": \"A\",\n \"lastname\": \"Customer\",\n \"company\": \"\",\n \"email\": \"\",\n \"cc_emails\": [],\n \"cc_sms\": null,\n \"phone\": \"\",\n \"address_1\": \"\",\n \"address_2\": \"\",\n \"address_city\": \"\",\n \"address_state\": \"\",\n \"address_zip\": \"\",\n \"address_country\": \"USA\",\n \"notes\": \"\",\n \"reference\": \"\",\n \"options\": \"\",\n \"created_at\": \"2018-02-23 22:32:19\",\n \"updated_at\": \"2018-02-23 22:32:19\",\n \"deleted_at\": null,\n \"allow_invoice_credit_card_payments\": true,\n \"gravatar\": false\n }\n },\n \"user\": {\n \"id\": \"dbc85118-3309-4129-b966-0108c0fb18a0\",\n \"system_admin\": true,\n \"name\": \"David Johnson\",\n \"email\": \"demo1@abc.com\",\n \"email_verification_sent_at\": \"2017-05-16 17:35:16\",\n \"email_verified_at\": \"2017-05-16 17:35:33\",\n \"is_api_key\": false,\n \"acknowledgments\": {\n \"tutorial\": true,\n \"godviewWelcome\": true\n },\n \"created_at\": \"2016-05-12 15:57:19\",\n \"updated_at\": \"2018-04-16 18:08:55\",\n \"deleted_at\": null,\n \"gravatar\": \"//www.gravatar.com/avatar/1cd5aef1d36d07e495abb73061f857d4\",\n \"team_admin\": null,\n \"team_enabled\": null,\n \"team_role\": null,\n \"merchant_options\": [],\n \"is_portal\": false\n }\n}" } }, "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "4be11b7e-21cb-4c9e-ba8f-5e173d13d7b7" }, "invoice_id": { "type": "string", "example": "" }, "reference_id": { "type": "string", "example": "5114aea7-5c7f-40ab-8a62-84f239e4b2b1" }, "recurring_transaction_id": { "type": "string", "example": "" }, "auth_id": {}, "type": { "type": "string", "example": "refund" }, "source": { "type": "string", "example": "terminalservice.dejavoo" }, "is_merchant_present": { "type": "boolean", "example": true, "default": true }, "merchant_id": { "type": "string", "example": "27fad5e4-0210-4c91-9596-417b0ea0dbb1" }, "user_id": { "type": "string", "example": "dbc85118-3309-4129-b966-0108c0fb18a0" }, "customer_id": { "type": "string", "example": "2a503ed1-99ea-4b35-a30a-605253f7c05a" }, "payment_method_id": { "type": "string", "example": "bf1aee65-dad9-4b74-8800-a75e435e3e7b" }, "is_manual": { "type": "boolean", "example": true, "default": true }, "success": { "type": "boolean", "example": true, "default": true }, "message": { "type": "string", "example": "" }, "meta": { "type": "object", "properties": { "lineItems": { "type": "array", "items": { "type": "object", "properties": { "item": { "type": "string", "example": "" }, "details": { "type": "string", "example": "" }, "quantity": { "type": "integer", "example": 1, "default": 0 }, "price": { "type": "string", "example": "0.01" } } } }, "subtotal": { "type": "number", "example": 0.01, "default": 0 }, "tax": { "type": "integer", "example": 0, "default": 0 }, "taxRate": { "type": "integer", "example": 10, "default": 0 }, "isBulkInvoice": { "type": "boolean", "example": false, "default": true }, "taxOverride": { "type": "boolean", "example": false, "default": true }, "update_inventory": { "type": "boolean", "example": true, "default": true }, "reference": { "type": "integer", "example": 2477, "default": 0 }, "RegisterId": { "type": "integer", "example": 3594291, "default": 0 }, "ResultCode": { "type": "integer", "example": 0, "default": 0 }, "RespMSG": { "type": "string", "example": "Approved Offline" }, "Message": { "type": "string", "example": "Approved" }, "AuthCode": { "type": "integer", "example": 145599, "default": 0 }, "PNRef": { "type": "integer", "example": 810618212223, "default": 0 }, "PaymentType": { "type": "string", "example": "Credit" }, "TransType": { "type": "string", "example": "Return" }, "SN": { "type": "integer", "example": 118816524647, "default": 0 }, "ExtData": { "type": "object", "properties": { "Amount": { "type": "string", "example": "0.01" }, "InvNum": { "type": "string", "example": "10" }, "CardType": { "type": "string", "example": "VISA" }, "BatchNum": { "type": "string", "example": "56" }, "Tip": { "type": "string", "example": "0.00" }, "CashBack": { "type": "string", "example": "0.00" }, "Fee": { "type": "string", "example": "0.00" }, "AcntLast4": { "type": "string", "example": "0281" }, "Name": { "type": "string", "example": "YOU/A GIFT FOR" }, "SVC": { "type": "string", "example": "0.00" }, "TotalAmt": { "type": "string", "example": "0.01" }, "DISC": { "type": "string", "example": "0.00" }, "Donation": { "type": "string", "example": "0.00" }, "SHFee": { "type": "string", "example": "0.00" }, "RwdPoints": { "type": "string", "example": "0" }, "RwdBalance": { "type": "string", "example": "0" }, "RwdIssued": { "type": "string", "example": "" }, "EBTFSLedgerBalance": { "type": "string", "example": "" }, "EBTFSAvailBalance": { "type": "string", "example": "" }, "EBTFSBeginBalance": { "type": "string", "example": "" }, "EBTCashLedgerBalance": { "type": "string", "example": "" }, "EBTCashAvailBalance": { "type": "string", "example": "" }, "EBTCashBeginBalance": { "type": "string", "example": "" }, "RewardCode": { "type": "string", "example": "" }, "AcqRefData": { "type": "string", "example": "" }, "ProcessData": { "type": "string", "example": "" }, "RefNo": { "type": "string", "example": "" }, "RewardQR": { "type": "string", "example": "" }, "Language": { "type": "string", "example": "English" }, "EntryType": { "type": "string", "example": "Swipe" }, "table_num": { "type": "string", "example": "0" }, "clerk_id": { "type": "string", "example": "" }, "ticket_num": { "type": "string", "example": "" }, "ControlNum": { "type": "string", "example": "" }, "TaxCity": { "type": "string", "example": "0.00" }, "TaxState": { "type": "string", "example": "0.00" }, "Cust1": { "type": "string", "example": "" }, "Cust1Value": { "type": "string", "example": "" }, "Cust2": { "type": "string", "example": "" }, "Cust2Value": { "type": "string", "example": "" }, "Cust3": { "type": "string", "example": "" }, "Cust3Value": { "type": "string", "example": "" }, "AcntFirst4": { "type": "string", "example": "4941" } } }, "CVMResult": { "type": "integer", "example": 2, "default": 0 }, "cancelled": { "type": "boolean", "example": false, "default": true }, "gatewayStatus": { "type": "integer", "example": 200, "default": 0 }, "gatewayStatusText": { "type": "string", "example": "OK" }, "printReceipt": { "type": "string", "example": "Both" }, "paymentType": { "type": "string", "example": "Credit" }, "type": { "type": "string", "example": "refund" }, "registerId": { "type": "string", "example": "4f1b-f10a" }, "registerStatusPort": { "type": "string", "example": "3594291" }, "registerNickname": { "type": "string", "example": "Tech Area Z8 (3594291)" }, "registerSerial": { "type": "string", "example": "124124" }, "registerType": { "type": "string", "example": "dejavoo" } } }, "total": { "type": "number", "example": 0.01, "default": 0 }, "method": { "type": "string", "example": "card" }, "pre_auth": { "type": "boolean", "example": false, "default": true }, "is_captured": { "type": "integer", "example": 0, "default": 0 }, "last_four": { "type": "string", "example": "5114" }, "interchange_code": { "type": "string", "example": "" }, "interchange_fee": {}, "batch_id": { "type": "string", "example": "" }, "batched_at": { "type": "string", "example": "2018-04-16 19:09:37" }, "emv_response": { "type": "string", "example": "" }, "avs_response": { "type": "string", "example": "" }, "cvv_response": { "type": "string", "example": "" }, "pos_entry": { "type": "string", "example": "" }, "pos_salesperson": { "type": "string", "example": "" }, "receipt_email_at": {}, "receipt_sms_at": {}, "created_at": { "type": "string", "example": "2018-04-16 19:09:37" }, "updated_at": { "type": "string", "example": "2018-04-16 19:09:37" }, "total_refunded": { "type": "integer", "example": 0, "default": 0 }, "is_refundable": { "type": "boolean", "example": false, "default": true }, "is_voided": { "type": "boolean", "example": false, "default": true }, "is_voidable": { "type": "boolean", "example": false, "default": true }, "schedule_id": {}, "child_captures": { "type": "array" }, "parent_auth": {}, "customer": { "type": "object", "properties": { "id": { "type": "string", "example": "2a503ed1-99ea-4b35-a30a-605253f7c05a" }, "firstname": { "type": "string", "example": "A" }, "lastname": { "type": "string", "example": "Customer" }, "company": { "type": "string", "example": "" }, "email": { "type": "string", "example": "" }, "cc_emails": { "type": "array" }, "cc_sms": {}, "phone": { "type": "string", "example": "" }, "address_1": { "type": "string", "example": "" }, "address_2": { "type": "string", "example": "" }, "address_city": { "type": "string", "example": "" }, "address_state": { "type": "string", "example": "" }, "address_zip": { "type": "string", "example": "" }, "address_country": { "type": "string", "example": "USA" }, "notes": { "type": "string", "example": "" }, "reference": { "type": "string", "example": "" }, "options": { "type": "string", "example": "" }, "created_at": { "type": "string", "example": "2018-02-23 22:32:19" }, "updated_at": { "type": "string", "example": "2018-02-23 22:32:19" }, "deleted_at": {}, "allow_invoice_credit_card_payments": { "type": "boolean", "example": true, "default": true }, "gravatar": { "type": "boolean", "example": false, "default": true } } }, "child_transactions": { "type": "array" }, "files": { "type": "array" }, "payment_method": { "type": "object", "properties": { "id": { "type": "string", "example": "bf1aee65-dad9-4b74-8800-a75e435e3e7b" }, "customer_id": { "type": "string", "example": "2a503ed1-99ea-4b35-a30a-605253f7c05a" }, "merchant_id": { "type": "string", "example": "27fad5e4-0210-4c91-9596-417b0ea0dbb1" }, "user_id": { "type": "string", "example": "dbc85118-3309-4129-b966-0108c0fb18a0" }, "nickname": { "type": "string", "example": "VISA: YOU/A GIFT FOR (ending in: 0281)" }, "has_cvv": { "type": "integer", "example": 0, "default": 0 }, "is_default": { "type": "integer", "example": 1, "default": 0 }, "method": { "type": "string", "example": "card" }, "person_name": { "type": "string", "example": "YOU/A GIFT FOR" }, "card_type": { "type": "string", "example": "visa" }, "card_last_four": { "type": "string", "example": "0281" }, "card_exp": { "type": "string", "example": "992099" }, "bank_name": {}, "bank_type": {}, "bank_holder_type": {}, "address_1": {}, "address_2": {}, "address_city": {}, "address_state": {}, "address_zip": { "type": "string", "example": "" }, "address_country": { "type": "string", "example": "" }, "purged_at": {}, "deleted_at": {}, "created_at": { "type": "string", "example": "2018-04-16 19:09:36" }, "updated_at": { "type": "string", "example": "2018-04-16 19:09:36" }, "card_exp_datetime": { "type": "string", "example": "2107-03-31 23:59:59" }, "customer": { "type": "object", "properties": { "id": { "type": "string", "example": "2a503ed1-99ea-4b35-a30a-605253f7c05a" }, "firstname": { "type": "string", "example": "A" }, "lastname": { "type": "string", "example": "Customer" }, "company": { "type": "string", "example": "" }, "email": { "type": "string", "example": "" }, "cc_emails": { "type": "array" }, "cc_sms": {}, "phone": { "type": "string", "example": "" }, "address_1": { "type": "string", "example": "" }, "address_2": { "type": "string", "example": "" }, "address_city": { "type": "string", "example": "" }, "address_state": { "type": "string", "example": "" }, "address_zip": { "type": "string", "example": "" }, "address_country": { "type": "string", "example": "USA" }, "notes": { "type": "string", "example": "" }, "reference": { "type": "string", "example": "" }, "options": { "type": "string", "example": "" }, "created_at": { "type": "string", "example": "2018-02-23 22:32:19" }, "updated_at": { "type": "string", "example": "2018-02-23 22:32:19" }, "deleted_at": {}, "allow_invoice_credit_card_payments": { "type": "boolean", "example": true, "default": true }, "gravatar": { "type": "boolean", "example": false, "default": true } } } } }, "user": { "type": "object", "properties": { "id": { "type": "string", "example": "dbc85118-3309-4129-b966-0108c0fb18a0" }, "system_admin": { "type": "boolean", "example": true, "default": true }, "name": { "type": "string", "example": "David Johnson" }, "email": { "type": "string", "example": "demo1@abc.com" }, "email_verification_sent_at": { "type": "string", "example": "2017-05-16 17:35:16" }, "email_verified_at": { "type": "string", "example": "2017-05-16 17:35:33" }, "is_api_key": { "type": "boolean", "example": false, "default": true }, "acknowledgments": { "type": "object", "properties": { "tutorial": { "type": "boolean", "example": true, "default": true }, "godviewWelcome": { "type": "boolean", "example": true, "default": true } } }, "created_at": { "type": "string", "example": "2016-05-12 15:57:19" }, "updated_at": { "type": "string", "example": "2018-04-16 18:08:55" }, "deleted_at": {}, "gravatar": { "type": "string", "example": "//www.gravatar.com/avatar/1cd5aef1d36d07e495abb73061f857d4" }, "team_admin": {}, "team_enabled": {}, "team_role": {}, "merchant_options": { "type": "array" }, "is_portal": { "type": "boolean", "example": false, "default": true } } } } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"success\": false,\n \"message\": \"User Cancelled\",\n \"gatewayStatus\": 200,\n \"gatewayStatusText\": \"OK\",\n \"cancelled\": true,\n \"status\": 400\n}" } }, "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false, "default": true }, "message": { "type": "string", "example": "User Cancelled" }, "gatewayStatus": { "type": "integer", "example": 200, "default": 0 }, "gatewayStatusText": { "type": "string", "example": "OK" }, "cancelled": { "type": "boolean", "example": true, "default": true }, "status": { "type": "integer", "example": 400, "default": 0 } } } } } }, "422": { "description": "422", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"validation\": \"register not found\",\n \"status\": 422,\n \"message\": \"Validation Error\"\n}" } }, "schema": { "type": "object", "properties": { "validation": { "type": "string", "example": "register not found" }, "status": { "type": "integer", "example": 422, "default": 0 }, "message": { "type": "string", "example": "Validation Error" } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "number", "description": "The amount a customer is credited.", "format": "float" }, "printReceipt": { "type": "string", "enum": [ "Both", "Merchant", "Customer", "No" ], "default": "Both" }, "paymentType": { "type": "string", "enum": [ "Credit", "Debit", "Check", "Gift", "Loyalty" ] }, "customerId": { "type": "string", "description": "The id of the customer attributed to this credit." }, "invoiceID": { "type": "string", "description": "The id of the invoice attributed to this charge." }, "transactionId": { "type": "string" }, "register": { "type": "string", "description": "The id of the register performing this operation. This should be the 'id' value returned by GET /terminal/register. The card must be present for a refund operation." }, "meta": { "type": "array", "items": { "type": "string", "format": "json" } } }, "required": [ "total", "register", "transactionId" ] } } } } } }, "/self/verify/resend": { "put": { "summary": "Resend Verification E-Mail", "description": "Resends the verification e-mail for a new user.", "operationId": "resend-verification-e-mail", "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "\n{\n \"id\": \"b58d7eee-e68d-4d12-a1f8-62f5e71382ae\",\n \"system_admin\": false,\n \"name\": \"demo\",\n \"email\": \"contact@example.com\",\n \"email_verification_sent_at\": \"2017-05-12 18:07:27\",\n \"email_verified_at\": \"2017-03-29 15:27:21\",\n \"created_at\": \"2017-01-11 21:44:02\",\n \"updated_at\": \"2017-05-12 18:07:27\",\n \"deleted_at\": null,\n \"gravatar\": \"//www.gravatar.com/avatar/157965dea7cd2f44e349382d1d791650\",\n \"team_role\": \"admin\",\n \"team_admin\": true,\n \"team_enabled\": true\n}" } }, "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "b58d7eee-e68d-4d12-a1f8-62f5e71382ae" }, "system_admin": { "type": "boolean", "example": false, "default": true }, "name": { "type": "string", "example": "demo" }, "email": { "type": "string", "example": "contact@example.com" }, "email_verification_sent_at": { "type": "string", "example": "2017-05-12 18:07:27" }, "email_verified_at": { "type": "string", "example": "2017-03-29 15:27:21" }, "created_at": { "type": "string", "example": "2017-01-11 21:44:02" }, "updated_at": { "type": "string", "example": "2017-05-12 18:07:27" }, "deleted_at": {}, "gravatar": { "type": "string", "example": "//www.gravatar.com/avatar/157965dea7cd2f44e349382d1d791650" }, "team_role": { "type": "string", "example": "admin" }, "team_admin": { "type": "boolean", "example": true, "default": true }, "team_enabled": { "type": "boolean", "example": true, "default": true } } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "[\n \"option_not_found\"\n]" } }, "schema": { "type": "array", "items": { "type": "string", "example": "option_not_found" } } } } } }, "deprecated": false } }, "/reset/{token}": { "post": { "summary": "Reset Password", "description": "", "operationId": "reset-password", "parameters": [ { "name": "token", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "password", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "password_confirmation", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": [ { "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJtZXJjaGFudCI6ImRlZTc1MjE1LWIzYmMtNGU0NC05YmM1LTc1ZDBmYjQ5OGI2MSIsInN1YiI6IjdjMzBhN2Y2LWVhYmMtNDM1NS1iNTMwLWQzNTFmOGYwYTRmMSIsImlzcyI6Imh0dHA6XC9cL2ZtYXBpLmxvY2FsXC9yZXNldFwvZDg0ZGE3MzMtY2ExOC00YzczLWIwNmYtOGY3Y2JiMzU2NzIxIiwiaWF0IjoxNDYxMDgzMDQzLCJleHAiOjE0NjExNjk0NDMsIm5iZiI6MTQ2MTA4MzA0MywianRpIjoiMjNjZjU1MWQyZDllNDA4ODA1ZjQ5MWE1YjI5ZjY2YTQifQ.Io7dLSUBayeRbgZEkq60M3b7hmVzuWLEpj0r5bE7hYk", "user": { "id": "7c30a7f6-eabc-4355-b530-d351f8f0a4f1", "system_admin": true, "name": "DANIEL WALKER", "email": "contact@example.com", "created_at": "2016-04-12 13:52:26", "updated_at": "2016-04-19 16:24:02", "deleted_at": null, "gravatar": "//www.gravatar.com/avatar/772cbf95746d7da86789cc3634c46ba8", "team_admin": true, "team_enabled": true }, "merchant": { "id": "dee75215-b3bc-4e44-9bc5-75d0fb498b61", "mid": "520000294774", "status": "ACTIVE", "subdomain": "demo", "company_name": "Stax", "contact_name": "Stax", "contact_email": "contact@example.com", "contact_phone": "8555503288", "address_1": "25 Wall Street", "address_2": "Suite 1", "address_city": "Orlando", "address_state": "FL", "address_zip": "32801", "hosted_payments_token": null, "currency": [ "USD" ], "branding": "https://s3-us-west-2.amazonaws.com/fattpaydocuments/avatars/0624acc8-c0be-45dc-a153-134da1990218.jpeg", "options": null, "gateway_type": null, "gateway_name": null, "created_at": "2016-04-12 13:52:26", "updated_at": "2016-04-12 13:52:26", "deleted_at": null } } ] } }, "schema": { "type": "object", "properties": { "property1": { "type": "string" } } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "{}" } }, "schema": { "type": "object", "properties": {} } } } } }, "deprecated": false }, "get": { "summary": "Verify Password Reset Token", "description": "Determines if the given token in the URL is correct or not.", "operationId": "verify-password-reset-token", "parameters": [ { "name": "token", "in": "path", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"token\": \"d84da733-ca18-4c73-b06f-8f7cbb356721\",\n \"user_id\": \"7c30a7f\u00a36-eabc-4355-b530-d351f8f0a4f1\",\n \"email\": \"contact@example.com\",\n \"reset_at\": null,\n \"created_at\": \"2016-04-19 16:22:10\",\n \"updated_at\": \"2016-04-19 16:22:10\"\n}" } }, "schema": { "type": "object", "properties": { "token": { "type": "string", "example": "d84da733-ca18-4c73-b06f-8f7cbb356721" }, "user_id": { "type": "string", "example": "7c30a7f\u00a36-eabc-4355-b530-d351f8f0a4f1" }, "email": { "type": "string", "example": "contact@example.com" }, "reset_at": { "type": "string", "format": "date-time" }, "created_at": { "type": "string", "example": "2016-04-19 16:22:10" }, "updated_at": { "type": "string", "example": "2016-04-19 16:22:10" } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "Token": { "type": "string", "description": "404 page not found" } } } } } }, "422": { "description": "422", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"token\": [\n \"The selected token is invalid.\"\n ]\n}" } }, "schema": { "type": "object", "properties": { "token": { "type": "array", "items": { "type": "string", "example": "The selected token is invalid." } } } } } } } }, "deprecated": false } }, "/item/code": { "get": { "summary": "Retrieve All Item Codes", "description": "The item code is merchant-side code used for business to keep track of their items.", "operationId": "retrieve-all-item-codes", "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "" } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "{}" } }, "schema": { "type": "object", "properties": {} } } } } }, "deprecated": false } }, "/invoice/schedule": { "get": { "summary": "Retrieve All Scheduled Invoices", "description": "Finds and lists all scheduled invoices under a merchant's account.", "operationId": "retrieve-all-scheduled-invoices", "parameters": [ { "name": "customer_id", "in": "query", "description": "Used to filter results by customer", "schema": { "type": "string" } }, { "name": "sort", "in": "query", "schema": { "type": "string", "enum": [ "last_run_at", "next_run_at", "count", "created_at", "updated_at" ] } }, { "name": "order", "in": "query", "schema": { "type": "string", "enum": [ "DESC", "ASC" ] } } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"current_page\": 1,\n \"data\": [\n {\n \"id\": \"320c909f-7808-465f-b519-5d906bf615f8\",\n \"merchant_id\": \"f2010d6f-dc3c-40bb-bf13-8646c018ba38\",\n \"user_id\": \"41402d23-92d7-4be2-b3c4-5752ead46632\",\n \"active\": true,\n \"count\": 0,\n \"rule\": \"FREQ=MONTHLY;INTERVAL=1;DTSTART=20250703T140000Z\",\n \"last_run_at\": null,\n \"next_run_at\": \"2025-07-03 14:00:00\",\n \"event\": \"InvoiceGenerator\",\n \"payment_method_id\": null,\n \"customer_id\": \"cafe3d35-1128-44bc-bd49-b6587662544f\",\n \"created_at\": \"2025-07-02 18:38:00\",\n \"updated_at\": \"2025-07-02 18:38:00\",\n \"deleted_at\": null,\n \"last_invoice_status\": null,\n \"rule_text\": \"monthly\",\n \"future_occurrences\": [\n \"2025-07-03 14:00:00\",\n \"2025-08-03 14:00:00\",\n \"2025-09-03 14:00:00\",\n \"2025-10-03 14:00:00\",\n \"2025-11-03 14:00:00\",\n \"2025-12-03 14:00:00\",\n \"2026-01-03 14:00:00\",\n \"2026-02-03 14:00:00\",\n \"2026-03-03 14:00:00\",\n \"2026-04-03 14:00:00\",\n \"2026-05-03 14:00:00\",\n \"2026-06-03 14:00:00\",\n \"2026-07-03 14:00:00\"\n ],\n \"max\": null,\n \"end_at\": null,\n \"status\": \"NOT STARTED\",\n \"customer\": {\n \"id\": \"cafe3d35-1128-44bc-bd49-b6587662544f\",\n \"firstname\": \"Stax\",\n \"lastname\": \"Tester\",\n \"company\": \"Testing Company\",\n \"email\": \"staxtester@staxpayments.com\",\n \"cc_emails\": [],\n \"cc_sms\": null,\n \"phone\": \"5555555555\",\n \"address_1\": \"2455 Adelia Blvd.\",\n \"address_2\": \"\",\n \"address_city\": \"Orlando\",\n \"address_state\": \"FL\",\n \"address_zip\": \"32725\",\n \"address_country\": \"USA\",\n \"notes\": \"\",\n \"reference\": \"\",\n \"options\": {\n \"customer_custom_fields\": []\n },\n \"created_at\": \"2025-06-23 18:26:53\",\n \"updated_at\": \"2025-06-23 18:26:53\",\n \"deleted_at\": null,\n \"allow_invoice_credit_card_payments\": true,\n \"gravatar\": false,\n \"has_address\": true,\n \"missing_address_components\": []\n },\n \"files\": [],\n \"payment_method\": null,\n \"meta\": {\n \"isVenmoPaymentEnabled\": false,\n \"isCnpDigitalWalletPaymentEnabled\": false,\n \"isCCPaymentEnabled\": true,\n \"tax\": 0,\n \"discountAfterTax\": 0,\n \"discountBeforeTax\": 0,\n \"surcharge\": 0,\n \"isTipEnabled\": false,\n \"type\": \"invoice\\/schedule\",\n \"update_inventory\": true,\n \"taxOverride\": false,\n \"isBulkInvoice\": false,\n \"shippingAmount\": 0,\n \"subtotal\": 100,\n \"internalMemo\": \"\",\n \"memo\": \"Test Memo\",\n \"lineItems\": [\n {\n \"id\": \"generated-id-d36c-54b0-6515-bca5-fc53\",\n \"item\": \"Test Item\",\n \"details\": \"\",\n \"quantity\": 1,\n \"price\": \"100.00\"\n }\n ],\n \"isACHPaymentEnabled\": true,\n \"isPaypalPaymentEnabled\": false,\n \"isPaypalBnplPaymentEnabled\": false\n },\n \"channel\": \"advanced-payment\",\n \"url\": \"https://app.staxpayments.com/#/bill/\",\n \"total\": 100,\n \"email_notification\": true,\n \"is_partial_payment_enabled\": true\n }\n ],\n \"first_page_url\": \"http://apiprod.fattlabs.com/invoice/schedule?page=1\",\n \"from\": 1,\n \"last_page\": 1,\n \"last_page_url\": \"http://apiprod.fattlabs.com/invoice/schedule?page=1\",\n \"links\": [\n {\n \"url\": null,\n \"label\": \"« Previous\",\n \"active\": false\n },\n {\n \"url\": \"http://apiprod.fattlabs.com/invoice/schedule?page=1\",\n \"label\": \"1\",\n \"active\": true\n },\n {\n \"url\": null,\n \"label\": \"Next »\",\n \"active\": false\n }\n ],\n \"next_page_url\": null,\n \"path\": \"http://apiprod.fattlabs.com/invoice/schedule\",\n \"per_page\": 20,\n \"prev_page_url\": null,\n \"to\": 1,\n \"total\": 1\n }\n ]\n },\n \"url\": \"https://app.staxpayments.com/#/bill/\",\n \"total\": \"2.00\",\n \"email_notification\": false\n },\n {\n \"id\": \"af8d5ac4-ac2b-484f-8b97-3db7d8f79e35\",\n \"merchant_id\": \"26492104-dbd0-49f7-918a-a4dcf9b2df1b\",\n \"user_id\": \"41e60252-4f23-48de-a64f-e5a1e8a9359c\",\n \"active\": true,\n \"count\": 0,\n \"rule\": \"FREQ=DAILY;COUNT=3;DTSTART=20181126T000000Z\",\n \"last_run_at\": null,\n \"next_run_at\": \"2018-11-26 00:00:00\",\n \"event\": \"InvoiceGenerator\",\n \"payment_method_id\": null,\n \"customer_id\": \"d45ee88c-8b27-4be8-8d81-77dda1b81826\",\n \"created_at\": \"2017-05-10 17:36:23\",\n \"updated_at\": \"2017-05-10 17:36:23\",\n \"deleted_at\": null,\n \"rule_text\": \"daily for 3 times\",\n \"future_occurrences\": [\n \"2018-11-26 00:00:00\",\n \"2018-11-27 00:00:00\",\n \"2018-11-28 00:00:00\"\n ],\n \"max\": 3,\n \"end_at\": null,\n \"status\": \"NOT STARTED\",\n \"customer\": {\n \"id\": \"d45ee88c-8b27-4be8-8d81-77dda1b81826\",\n \"firstname\": \"John\",\n \"lastname\": \"Smith\",\n \"company\": \"ABC INC\",\n \"email\": \"demo@abc.com\",\n \"cc_emails\": [\n \"demo1@abc.com\",\n \"demo2@abc.com\"\n ],\n \"phone\": \"1234567898\",\n \"address_1\": \"123 Rite Way\",\n \"address_2\": \"Unit 12\",\n \"address_city\": \"Orlando\",\n \"address_state\": \"FL\",\n \"address_zip\": \"32801\",\n \"address_country\": \"USA\",\n \"notes\": null,\n \"reference\": \"BARTLE\",\n \"options\": \"\",\n \"created_at\": \"2017-05-08 19:22:51\",\n \"updated_at\": \"2017-05-08 19:23:46\",\n \"deleted_at\": null,\n \"gravatar\": \"//www.gravatar.com/avatar/fe3e929dd80f1653c3a4b82812660061\"\n },\n \"files\": [],\n \"invoices\": [],\n \"payment_method\": null,\n \"meta\": {\n \"tax\": 0,\n \"subtotal\": 2,\n \"lineItems\": [\n {\n \"id\": \"optional-fm-catalog-item-id\",\n \"item\": \"Demo Item\",\n \"details\": \"this is a regular demo item\",\n \"quantity\": 1,\n \"price\": 2\n }\n ]\n },\n \"url\": \"https://app.staxpayments.com/#/bill/\",\n \"total\": \"2.00\",\n \"email_notification\": false\n }\n ]\n}" } }, "schema": { "type": "object", "properties": { "total": { "type": "integer", "example": 2, "default": 0 }, "per_page": { "type": "integer", "example": 25, "default": 0 }, "current_page": { "type": "integer", "example": 1, "default": 0 }, "last_page": { "type": "integer", "example": 1, "default": 0 }, "next_page_url": {}, "prev_page_url": {}, "from": { "type": "integer", "example": 1, "default": 0 }, "to": { "type": "integer", "example": 2, "default": 0 }, "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "53ad71d4-b85f-4efc-9ae1-579ff6eeb206" }, "merchant_id": { "type": "string", "example": "26492104-dbd0-49f7-918a-a4dcf9b2df1b" }, "user_id": { "type": "string", "example": "41e60252-4f23-48de-a64f-e5a1e8a9359c" }, "active": { "type": "boolean", "example": true, "default": true }, "count": { "type": "integer", "example": 0, "default": 0 }, "rule": { "type": "string", "example": "FREQ=DAILY;COUNT=3;DTSTART=20181126T000000Z" }, "last_run_at": {}, "next_run_at": { "type": "string", "example": "2018-11-26 00:00:00" }, "event": { "type": "string", "example": "InvoiceGenerator" }, "payment_method_id": {}, "customer_id": { "type": "string", "example": "d45ee88c-8b27-4be8-8d81-77dda1b81826" }, "created_at": { "type": "string", "example": "2017-05-10 17:37:50" }, "updated_at": { "type": "string", "example": "2017-05-10 17:37:50" }, "deleted_at": {}, "rule_text": { "type": "string", "example": "daily for 3 times" }, "future_occurrences": { "type": "array", "items": { "type": "string", "example": "2018-11-26 00:00:00" } }, "max": { "type": "integer", "example": 3, "default": 0 }, "end_at": {}, "status": { "type": "string", "example": "NOT STARTED" }, "customer": { "type": "object", "properties": { "id": { "type": "string", "example": "d45ee88c-8b27-4be8-8d81-77dda1b81826" }, "firstname": { "type": "string", "example": "John" }, "lastname": { "type": "string", "example": "Smith" }, "company": { "type": "string", "example": "ABC INC" }, "email": { "type": "string", "example": "demo@abc.com" }, "cc_emails": { "type": "array", "items": { "type": "string", "example": "demo1@abc.com" } }, "phone": { "type": "string", "example": "1234567898" }, "address_1": { "type": "string", "example": "123 Rite Way" }, "address_2": { "type": "string", "example": "Unit 12" }, "address_city": { "type": "string", "example": "Orlando" }, "address_state": { "type": "string", "example": "FL" }, "address_zip": { "type": "string", "example": "32801" }, "address_country": { "type": "string", "example": "USA" }, "notes": {}, "reference": { "type": "string", "example": "BARTLE" }, "options": { "type": "string", "example": "" }, "created_at": { "type": "string", "example": "2017-05-08 19:22:51" }, "updated_at": { "type": "string", "example": "2017-05-08 19:23:46" }, "deleted_at": {}, "gravatar": { "type": "string", "example": "//www.gravatar.com/avatar/fe3e929dd80f1653c3a4b82812660061" } } }, "files": { "type": "array" }, "invoices": { "type": "array" }, "payment_method": {}, "meta": { "type": "object", "properties": { "tax": { "type": "integer", "example": 0, "default": 0 }, "subtotal": { "type": "integer", "example": 2, "default": 0 }, "lineItems": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "optional-fm-catalog-item-id" }, "item": { "type": "string", "example": "Demo Item" }, "details": { "type": "string", "example": "this is a regular demo item" }, "quantity": { "type": "integer", "example": 1, "default": 0 }, "price": { "type": "integer", "example": 2, "default": 0 } } } } } }, "url": { "type": "string", "example": "https://app.staxpayments.com/#/bill/" }, "total": { "type": "string", "example": "2.00" }, "email_notification": { "type": "boolean", "example": false, "default": true } } } } } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "{}" } }, "schema": { "type": "object", "properties": {} } } } } }, "deprecated": false } }, "/underwriting/terms-and-conditions/{id}": { "get": { "summary": "Retrieve Terms and Conditions", "description": "Retrieves the terms and conditions matching the given merchant id.", "operationId": "retrieve-terms-and-conditions", "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The merchant ID." } ], "responses": { "200": { "description": "200", "content": { "text/plain": { "examples": { "Result": { "value": "\"
Terms and Conditions content...
\"" } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"token\": \"invalid\"\n}" } }, "schema": { "type": "object", "properties": { "token": { "type": "string", "example": "invalid" } } } } } } }, "deprecated": false, "security": [ { "PartnerApiKey": [] } ] } }, "/surcharge/review": { "get": { "summary": "Review a Transaction's Surcharge Information", "description": "", "operationId": "review-a-transactions-surcharge-information", "parameters": [ { "name": "payment_method_id", "in": "query", "description": "Tokenized payment method id", "schema": { "type": "string" }, "required": true }, { "name": "total", "in": "query", "description": "Transaction subtotal", "schema": { "type": "string" } } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"bin_type\": \"CREDIT\",\n \"surcharge_rate\": 1.5,\n \"surcharge_amount\": 0.18,\n \"total_with_surcharge_amount\": 12.18\n}" } }, "schema": { "type": "object", "properties": { "bin_type": { "type": "string", "example": "CREDIT" }, "surcharge_rate": { "type": "number", "example": 1.5, "default": 0 }, "surcharge_amount": { "type": "number", "example": 0.18, "default": 0 }, "total_with_surcharge_amount": { "type": "number", "example": 12.18, "default": 0 } } } } } } }, "deprecated": false } }, "/invoice/{id}/send/email": { "put": { "summary": "Send an Invoice via Email", "description": "Sends the invoice to the customer's e-mail and other CC e-mails provided in the request.", "operationId": "send-an-invoice-via-email", "parameters": [ { "name": "id", "in": "path", "description": "The id of the invoice that should be sent", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "ccEmails": { "type": "array", "description": "List of CC email addresses", "items": { "type": "string" } } } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"id\": \"4bbd1a64-7472-44ed-afef-02b82d3eae24\",\n \"merchant_id\": \"dee75215-b3bc-4e44-9bc5-75d0fb498b61\",\n \"user_id\": \"7c30a7f6-eabc-4355-b530-d351f8f0a4f1\",\n \"customer_id\": \"a41c93d0-e45d-4d41-b46c-f781a02019f5\",\n \"total\": 12,\n \"meta\": {\n \"tax\": 2,\n \"subtotal\": 10,\n \"lineItems\": [\n {\n \"id\": \"optional-fm-catalog-item-id\",\n \"item\": \"Demo Item\",\n \"details\": \"this is a regular demo item\",\n \"quantity\": 1,\n \"price\": 10\n }\n ]\n },\n \"status\": \"SENT\",\n \"sent_at\": \"2016-05-09 17:10:43\",\n \"viewed_at\": null,\n \"paid_at\": null,\n \"url\": \"http://127.0.0.1:5477/#/bill/\",\n \"deleted_at\": null,\n \"created_at\": \"2016-05-09 17:10:37\",\n \"updated_at\": \"2016-05-09 17:10:43\",\n \"customer\": {\n \"id\": \"a41c93d0-e45d-4d41-b46c-f781a02019f5\",\n \"firstname\": \"Jason\",\n \"lastname\": \"Mann\",\n \"company\": \"CIA\",\n \"email\": \"JasonGuy@CIA.com\",\n \"phone\": \"1234567898\",\n \"address_1\": \"123 Rite Way\",\n \"address_2\": \"Unit 12\",\n \"address_city\": \"Orlando\",\n \"address_state\": \"FL\",\n \"address_zip\": \"32801\",\n \"notes\": \"\",\n \"options\": \"\",\n \"created_at\": \"2016-04-26 13:55:21\",\n \"updated_at\": \"2016-04-26 13:55:21\",\n \"deleted_at\": null,\n \"payment_attempt_failed\": false,\n \"payment_attempt_message\": \"\",\n \"gravatar\": \"//www.gravatar.com/avatar/1b91155f027795b2d36a08b1e5e8e9df\"\n },\n \"user\": {\n \"id\": \"7c30a7f6-eabc-4355-b530-d351f8f0a4f1\",\n \"system_admin\": true,\n \"name\": \"DANIEL WALKER\",\n \"email\": \"contact@example.com\",\n \"created_at\": \"2016-04-12 13:52:26\",\n \"updated_at\": \"2016-04-25 16:46:42\",\n \"deleted_at\": null,\n \"gravatar\": \"//www.gravatar.com/avatar/772cbf95746d7da86789cc3634c46ba8\"\n },\n \"child_transactions\": [],\n \"merchant\": {\n \"id\": \"dee75215-b3bc-4e44-9bc5-75d0fb498b61\",\n \"mid\": \"520000294774\",\n \"status\": \"ACTIVE\",\n \"subdomain\": \"demo\",\n \"company_name\": \"Stax\",\n \"contact_name\": \"Stax\",\n \"contact_email\": \"contact@example.com\",\n \"contact_phone\": \"8555503288\",\n \"address_1\": \"25 Wall Street\",\n \"address_2\": \"Suite 1\",\n \"address_city\": \"Orlando\",\n \"address_state\": \"FL\",\n \"address_zip\": \"32801\",\n \"hosted_payments_token\": \"gfdbfed\",\n \"currency\": [\n \"USD\"\n ],\n \"branding\": \"https://s3-us-west-2.amazonaws.com/fattpaydocuments/avatars/0624acc8-c0be-45dc-a153-134da1990218.jpeg\",\n \"options\": {\n \"hosted_payments_success_note\": \"Thank you for your payment! It's gladly appreciated!\",\n \"hosted_payments_url_long\": \"http://localhost.app:5477/#/pay/t___-_\",\n \"hosted_payments_url_short\": \"http://bit.ly/1K34yKV\",\n \"hosted_payments_note\": \"Thank you for your payment\"\n },\n \"notes\": \"\",\n \"gateway_type\": null,\n \"gateway_name\": null,\n \"vendor_keys\": {},\n \"created_at\": \"2016-04-12 13:52:26\",\n \"updated_at\": \"2016-04-27 15:12:51\",\n \"deleted_at\": null\n }\n}" } }, "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "4bbd1a64-7472-44ed-afef-02b82d3eae24" }, "merchant_id": { "type": "string", "example": "dee75215-b3bc-4e44-9bc5-75d0fb498b61" }, "user_id": { "type": "string", "example": "7c30a7f6-eabc-4355-b530-d351f8f0a4f1" }, "customer_id": { "type": "string", "example": "a41c93d0-e45d-4d41-b46c-f781a02019f5" }, "total": { "type": "integer", "example": 12, "default": 0 }, "meta": { "type": "object", "properties": { "tax": { "type": "integer", "example": 2, "default": 0 }, "subtotal": { "type": "integer", "example": 10, "default": 0 }, "lineItems": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "optional-fm-catalog-item-id" }, "item": { "type": "string", "example": "Demo Item" }, "details": { "type": "string", "example": "this is a regular demo item" }, "quantity": { "type": "integer", "example": 1, "default": 0 }, "price": { "type": "integer", "example": 10, "default": 0 } } } } } }, "status": { "type": "string", "example": "SENT" }, "sent_at": { "type": "string", "example": "2016-05-09 17:10:43" }, "viewed_at": {}, "paid_at": {}, "url": { "type": "string", "example": "http://127.0.0.1:5477/#/bill/" }, "deleted_at": {}, "created_at": { "type": "string", "example": "2016-05-09 17:10:37" }, "updated_at": { "type": "string", "example": "2016-05-09 17:10:43" }, "customer": { "type": "object", "properties": { "id": { "type": "string", "example": "a41c93d0-e45d-4d41-b46c-f781a02019f5" }, "firstname": { "type": "string", "example": "Jason" }, "lastname": { "type": "string", "example": "Mann" }, "company": { "type": "string", "example": "CIA" }, "email": { "type": "string", "example": "JasonGuy@CIA.com" }, "phone": { "type": "string", "example": "1234567898" }, "address_1": { "type": "string", "example": "123 Rite Way" }, "address_2": { "type": "string", "example": "Unit 12" }, "address_city": { "type": "string", "example": "Orlando" }, "address_state": { "type": "string", "example": "FL" }, "address_zip": { "type": "string", "example": "32801" }, "notes": { "type": "string", "example": "" }, "options": { "type": "string", "example": "" }, "created_at": { "type": "string", "example": "2016-04-26 13:55:21" }, "updated_at": { "type": "string", "example": "2016-04-26 13:55:21" }, "deleted_at": {}, "payment_attempt_failed": { "type": "boolean", "example": false, "default": true }, "payment_attempt_message": { "type": "string", "example": "" }, "gravatar": { "type": "string", "example": "//www.gravatar.com/avatar/1b91155f027795b2d36a08b1e5e8e9df" } } }, "user": { "type": "object", "properties": { "id": { "type": "string", "example": "7c30a7f6-eabc-4355-b530-d351f8f0a4f1" }, "system_admin": { "type": "boolean", "example": true, "default": true }, "name": { "type": "string", "example": "DANIEL WALKER" }, "email": { "type": "string", "example": "contact@example.com" }, "created_at": { "type": "string", "example": "2016-04-12 13:52:26" }, "updated_at": { "type": "string", "example": "2016-04-25 16:46:42" }, "deleted_at": {}, "gravatar": { "type": "string", "example": "//www.gravatar.com/avatar/772cbf95746d7da86789cc3634c46ba8" } } }, "child_transactions": { "type": "array" }, "merchant": { "type": "object", "properties": { "id": { "type": "string", "example": "dee75215-b3bc-4e44-9bc5-75d0fb498b61" }, "mid": { "type": "string", "example": "520000294774" }, "status": { "type": "string", "example": "ACTIVE" }, "subdomain": { "type": "string", "example": "demo" }, "company_name": { "type": "string", "example": "Stax" }, "contact_name": { "type": "string", "example": "Stax" }, "contact_email": { "type": "string", "example": "contact@example.com" }, "contact_phone": { "type": "string", "example": "8555503288" }, "address_1": { "type": "string", "example": "25 Wall Street" }, "address_2": { "type": "string", "example": "Suite 1" }, "address_city": { "type": "string", "example": "Orlando" }, "address_state": { "type": "string", "example": "FL" }, "address_zip": { "type": "string", "example": "32801" }, "hosted_payments_token": { "type": "string", "example": "gfdbfed" }, "currency": { "type": "array", "items": { "type": "string", "example": "USD" } }, "branding": { "type": "string", "example": "https://s3-us-west-2.amazonaws.com/fattpaydocuments/avatars/0624acc8-c0be-45dc-a153-134da1990218.jpeg" }, "options": { "type": "object", "properties": { "hosted_payments_success_note": { "type": "string", "example": "Thank you for your payment! It's gladly appreciated!" }, "hosted_payments_url_long": { "type": "string", "example": "http://localhost.app:5477/#/pay/t___-_" }, "hosted_payments_url_short": { "type": "string", "example": "http://bit.ly/1K34yKV" }, "hosted_payments_note": { "type": "string", "example": "Thank you for your payment" } } }, "notes": { "type": "string", "example": "" }, "gateway_type": {}, "gateway_name": {}, "vendor_keys": { "type": "object", "properties": {} }, "created_at": { "type": "string", "example": "2016-04-12 13:52:26" }, "updated_at": { "type": "string", "example": "2016-04-27 15:12:51" }, "deleted_at": {} } } } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"id\": [\n \"Invoice could not be found\"\n ]\n}" } }, "schema": { "type": "object", "properties": { "id": { "type": "array", "items": { "type": "string", "example": "Invoice could not be found" } } } } } } } }, "deprecated": false } }, "/invoice/{id}/send/sms": { "put": { "summary": "Send an Invoice via SMS", "description": "Sends the invoice to the customer's phone number and other CC phone numbers.", "operationId": "send-an-invoice-via-sms", "parameters": [ { "name": "id", "in": "path", "description": "The id of the invoice that should be sent", "schema": { "type": "string" }, "required": true }, { "name": "message", "in": "query", "description": "Message which will show in the sms message", "schema": { "type": "string" } }, { "name": "phone", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"id\": \"4bbd1a64-7472-44ed-afef-02b82d3eae24\",\n \"merchant_id\": \"dee75215-b3bc-4e44-9bc5-75d0fb498b61\",\n \"user_id\": \"7c30a7f6-eabc-4355-b530-d351f8f0a4f1\",\n \"customer_id\": \"a41c93d0-e45d-4d41-b46c-f781a02019f5\",\n \"total\": 12,\n \"meta\": {\n \"tax\": 2,\n \"subtotal\": 10,\n \"lineItems\": [\n {\n \"id\": \"optional-fm-catalog-item-id\",\n \"item\": \"Demo Item\",\n \"details\": \"this is a regular demo item\",\n \"quantity\": 1,\n \"price\": 10\n }\n ]\n },\n \"status\": \"SENT\",\n \"sent_at\": \"2016-05-09 17:10:43\",\n \"viewed_at\": null,\n \"paid_at\": null,\n \"url\": \"http://127.0.0.1:5477/#/bill/\",\n \"deleted_at\": null,\n \"created_at\": \"2016-05-09 17:10:37\",\n \"updated_at\": \"2016-05-09 17:10:43\",\n \"customer\": {\n \"id\": \"a41c93d0-e45d-4d41-b46c-f781a02019f5\",\n \"firstname\": \"Jason\",\n \"lastname\": \"Mann\",\n \"company\": \"CIA\",\n \"email\": \"JasonGuy@CIA.com\",\n \"phone\": \"1234567898\",\n \"address_1\": \"123 Rite Way\",\n \"address_2\": \"Unit 12\",\n \"address_city\": \"Orlando\",\n \"address_state\": \"FL\",\n \"address_zip\": \"32801\",\n \"notes\": \"\",\n \"options\": \"\",\n \"created_at\": \"2016-04-26 13:55:21\",\n \"updated_at\": \"2016-04-26 13:55:21\",\n \"deleted_at\": null,\n \"payment_attempt_failed\": false,\n \"payment_attempt_message\": \"\",\n \"gravatar\": \"//www.gravatar.com/avatar/1b91155f027795b2d36a08b1e5e8e9df\"\n },\n \"user\": {\n \"id\": \"7c30a7f6-eabc-4355-b530-d351f8f0a4f1\",\n \"system_admin\": true,\n \"name\": \"DANIEL WALKER\",\n \"email\": \"contact@example.com\",\n \"created_at\": \"2016-04-12 13:52:26\",\n \"updated_at\": \"2016-04-25 16:46:42\",\n \"deleted_at\": null,\n \"gravatar\": \"//www.gravatar.com/avatar/772cbf95746d7da86789cc3634c46ba8\"\n },\n \"child_transactions\": [],\n \"merchant\": {\n \"id\": \"dee75215-b3bc-4e44-9bc5-75d0fb498b61\",\n \"mid\": \"520000294774\",\n \"status\": \"ACTIVE\",\n \"subdomain\": \"demo\",\n \"company_name\": \"Stax\",\n \"contact_name\": \"Stax\",\n \"contact_email\": \"contact@example.com\",\n \"contact_phone\": \"8555503288\",\n \"address_1\": \"25 Wall Street\",\n \"address_2\": \"Suite 1\",\n \"address_city\": \"Orlando\",\n \"address_state\": \"FL\",\n \"address_zip\": \"32801\",\n \"hosted_payments_token\": \"gfdbfed\",\n \"currency\": [\n \"USD\"\n ],\n \"branding\": \"https://s3-us-west-2.amazonaws.com/fattpaydocuments/avatars/0624acc8-c0be-45dc-a153-134da1990218.jpeg\",\n \"options\": {\n \"hosted_payments_success_note\": \"Thank you for your payment! It's gladly appreciated!\",\n \"hosted_payments_url_long\": \"http://localhost.app:5477/#/pay/t___-_\",\n \"hosted_payments_url_short\": \"http://bit.ly/1K34yKV\",\n \"hosted_payments_note\": \"Thank you for your payment\"\n },\n \"notes\": \"\",\n \"gateway_type\": null,\n \"gateway_name\": null,\n \"vendor_keys\": {},\n \"created_at\": \"2016-04-12 13:52:26\",\n \"updated_at\": \"2016-04-27 15:12:51\",\n \"deleted_at\": null\n }\n}" } }, "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "4bbd1a64-7472-44ed-afef-02b82d3eae24" }, "merchant_id": { "type": "string", "example": "dee75215-b3bc-4e44-9bc5-75d0fb498b61" }, "user_id": { "type": "string", "example": "7c30a7f6-eabc-4355-b530-d351f8f0a4f1" }, "customer_id": { "type": "string", "example": "a41c93d0-e45d-4d41-b46c-f781a02019f5" }, "total": { "type": "integer", "example": 12, "default": 0 }, "meta": { "type": "object", "properties": { "tax": { "type": "integer", "example": 2, "default": 0 }, "subtotal": { "type": "integer", "example": 10, "default": 0 }, "lineItems": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "optional-fm-catalog-item-id" }, "item": { "type": "string", "example": "Demo Item" }, "details": { "type": "string", "example": "this is a regular demo item" }, "quantity": { "type": "integer", "example": 1, "default": 0 }, "price": { "type": "integer", "example": 10, "default": 0 } } } } } }, "status": { "type": "string", "example": "SENT" }, "sent_at": { "type": "string", "example": "2016-05-09 17:10:43" }, "viewed_at": {}, "paid_at": {}, "url": { "type": "string", "example": "http://127.0.0.1:5477/#/bill/" }, "deleted_at": {}, "created_at": { "type": "string", "example": "2016-05-09 17:10:37" }, "updated_at": { "type": "string", "example": "2016-05-09 17:10:43" }, "customer": { "type": "object", "properties": { "id": { "type": "string", "example": "a41c93d0-e45d-4d41-b46c-f781a02019f5" }, "firstname": { "type": "string", "example": "Jason" }, "lastname": { "type": "string", "example": "Mann" }, "company": { "type": "string", "example": "CIA" }, "email": { "type": "string", "example": "JasonGuy@CIA.com" }, "phone": { "type": "string", "example": "1234567898" }, "address_1": { "type": "string", "example": "123 Rite Way" }, "address_2": { "type": "string", "example": "Unit 12" }, "address_city": { "type": "string", "example": "Orlando" }, "address_state": { "type": "string", "example": "FL" }, "address_zip": { "type": "string", "example": "32801" }, "notes": { "type": "string", "example": "" }, "options": { "type": "string", "example": "" }, "created_at": { "type": "string", "example": "2016-04-26 13:55:21" }, "updated_at": { "type": "string", "example": "2016-04-26 13:55:21" }, "deleted_at": {}, "payment_attempt_failed": { "type": "boolean", "example": false, "default": true }, "payment_attempt_message": { "type": "string", "example": "" }, "gravatar": { "type": "string", "example": "//www.gravatar.com/avatar/1b91155f027795b2d36a08b1e5e8e9df" } } }, "user": { "type": "object", "properties": { "id": { "type": "string", "example": "7c30a7f6-eabc-4355-b530-d351f8f0a4f1" }, "system_admin": { "type": "boolean", "example": true, "default": true }, "name": { "type": "string", "example": "DANIEL WALKER" }, "email": { "type": "string", "example": "contact@example.com" }, "created_at": { "type": "string", "example": "2016-04-12 13:52:26" }, "updated_at": { "type": "string", "example": "2016-04-25 16:46:42" }, "deleted_at": {}, "gravatar": { "type": "string", "example": "//www.gravatar.com/avatar/772cbf95746d7da86789cc3634c46ba8" } } }, "child_transactions": { "type": "array" }, "merchant": { "type": "object", "properties": { "id": { "type": "string", "example": "dee75215-b3bc-4e44-9bc5-75d0fb498b61" }, "mid": { "type": "string", "example": "520000294774" }, "status": { "type": "string", "example": "ACTIVE" }, "subdomain": { "type": "string", "example": "demo" }, "company_name": { "type": "string", "example": "Stax" }, "contact_name": { "type": "string", "example": "Stax" }, "contact_email": { "type": "string", "example": "contact@example.com" }, "contact_phone": { "type": "string", "example": "8555503288" }, "address_1": { "type": "string", "example": "25 Wall Street" }, "address_2": { "type": "string", "example": "Suite 1" }, "address_city": { "type": "string", "example": "Orlando" }, "address_state": { "type": "string", "example": "FL" }, "address_zip": { "type": "string", "example": "32801" }, "hosted_payments_token": { "type": "string", "example": "gfdbfed" }, "currency": { "type": "array", "items": { "type": "string", "example": "USD" } }, "branding": { "type": "string", "example": "https://s3-us-west-2.amazonaws.com/fattpaydocuments/avatars/0624acc8-c0be-45dc-a153-134da1990218.jpeg" }, "options": { "type": "object", "properties": { "hosted_payments_success_note": { "type": "string", "example": "Thank you for your payment! It's gladly appreciated!" }, "hosted_payments_url_long": { "type": "string", "example": "http://localhost.app:5477/#/pay/t___-_" }, "hosted_payments_url_short": { "type": "string", "example": "http://bit.ly/1K34yKV" }, "hosted_payments_note": { "type": "string", "example": "Thank you for your payment" } } }, "notes": { "type": "string", "example": "" }, "gateway_type": {}, "gateway_name": {}, "vendor_keys": { "type": "object", "properties": {} }, "created_at": { "type": "string", "example": "2016-04-12 13:52:26" }, "updated_at": { "type": "string", "example": "2016-04-27 15:12:51" }, "deleted_at": {} } } } } } } }, "422": { "description": "422", "content": { "application/json": { "examples": { "Result": { "value": "[\n {\n \"id\": [\n \"Invoice could not be found\"\n ]\n },\n {\n \"phoneNumber\": \"111111111111111\",\n \"status\": \"failure\",\n \"message\": \"please contact your customer for a valid phone number to use.\"\n }\n]" } }, "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "array", "items": { "type": "string", "example": "Invoice could not be found" } } } } } } } } }, "deprecated": false } }, "/payment_method/{payment_method_id}/external_vault": { "post": { "summary": "Share a payment method with a third party", "description": "Make a copy of an existing Stax Payment Method in an external gateway", "operationId": "share-a-payment-method-with-a-third-party", "parameters": [ { "name": "payment_method_id", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "gateway_token", "in": "query", "description": "corresponds to a valid third party gateway token. This will be provided to you through Partner Success", "schema": { "type": "string" } } ], "responses": { "201": { "description": "201", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"0\": {\n \"transaction\": {\n \"created_at\": \"2022-05-09T11:31:24Z\",\n \"currency_code\": null,\n \"updated_at\": \"2022-05-09T11:31:24Z\",\n \"succeeded\": true,\n \"token\": \"IDZJzXNXkqiLk3dQY5LecxarSMp\",\n \"state\": \"succeeded\",\n \"gateway_specific_fields\": null,\n \"gateway_specific_response_fields\": {\n \"provider\": {}\n },\n \"transaction_type\": \"Store\",\n \"third_party_token\": null,\n \"gateway_transaction_id\": \"cus_LeoRJx05gH5FnG|card_1KxUoCBkOJcrLi5mLgUkB7Zu\",\n \"gateway_latency_ms\": 668,\n \"message_key\": \"messages.transaction_succeeded\",\n \"message\": \"Succeeded!\",\n \"gateway_token\": \"237c78vnYCN201Ib0ZAEzlZ4d0l\",\n \"gateway_type\": \"third party gateway\",\n \"payment_method\": {\n \"token\": \"KVVQGbZgCzwMnhptyDNnhtyAk27\",\n \"created_at\": \"2022-05-09T11:31:24Z\",\n \"updated_at\": \"2022-05-09T11:31:24Z\",\n \"gateway_type\": \"third_party_gateway\",\n \"storage_state\": \"retained\",\n \"metadata\": null,\n \"third_party_token\": \"cus_LeoRJx05gH5FnG|card_1KxUoCBkOJcrLi5mLgUkB7Zu\",\n \"payment_method_type\": \"third_party_token\",\n \"errors\": []\n },\n \"basis_payment_method\": {\n \"token\": \"KQYeXq7dKFA37x29rSrj4gvPSSV\",\n \"created_at\": \"2022-03-21T15:13:46Z\",\n \"updated_at\": \"2022-05-09T11:31:24Z\",\n \"email\": null,\n \"data\": null,\n \"storage_state\": \"retained\",\n \"test\": true,\n \"metadata\": null,\n \"callback_url\": null,\n \"last_four_digits\": \"1111\",\n \"first_six_digits\": \"411111\",\n \"card_type\": \"visa\",\n \"first_name\": \"Jimiy\",\n \"last_name\": \"Test\",\n \"month\": 12,\n \"year\": 2022,\n \"address1\": null,\n \"address2\": null,\n \"city\": null,\n \"state\": null,\n \"zip\": null,\n \"country\": null,\n \"phone_number\": null,\n \"company\": null,\n \"full_name\": \"Jimiy Test\",\n \"eligible_for_card_updater\": true,\n \"shipping_address1\": null,\n \"shipping_address2\": null,\n \"shipping_city\": null,\n \"shipping_state\": null,\n \"shipping_zip\": null,\n \"shipping_country\": null,\n \"shipping_phone_number\": null,\n \"issuer_identification_number\": \"41111111\",\n \"payment_method_type\": \"credit_card\",\n \"errors\": [],\n \"fingerprint\": \"e3cef43464fc832f6e04f187df25af497994\",\n \"verification_value\": \"\",\n \"number\": \"XXXX-XXXX-XXXX-1111\"\n },\n \"response\": {\n \"success\": true,\n \"message\": \"Transaction approved\",\n \"avs_code\": null,\n \"avs_message\": null,\n \"cvv_code\": null,\n \"cvv_message\": null,\n \"pending\": false,\n \"result_unknown\": false,\n \"error_code\": null,\n \"error_detail\": null,\n \"cancelled\": false,\n \"fraud_review\": null,\n \"created_at\": \"2022-05-09T11:31:24Z\",\n \"updated_at\": \"2022-05-09T11:31:24Z\"\n }\n }\n },\n \"success\": [\n \"payment method successfully submitted\"\n ]\n}" } }, "schema": { "type": "object", "properties": { "0": { "type": "object", "properties": { "transaction": { "type": "object", "properties": { "created_at": { "type": "string", "example": "2022-05-09T11:31:24Z" }, "currency_code": {}, "updated_at": { "type": "string", "example": "2022-05-09T11:31:24Z" }, "succeeded": { "type": "boolean", "example": true, "default": true }, "token": { "type": "string", "example": "IDZJzXNXkqiLk3dQY5LecxarSMp" }, "state": { "type": "string", "example": "succeeded" }, "gateway_specific_fields": {}, "gateway_specific_response_fields": { "type": "object", "properties": { "provider": { "type": "object", "properties": {} } } }, "transaction_type": { "type": "string", "example": "Store" }, "third_party_token": {}, "gateway_transaction_id": { "type": "string", "example": "cus_LeoRJx05gH5FnG|card_1KxUoCBkOJcrLi5mLgUkB7Zu" }, "gateway_latency_ms": { "type": "integer", "example": 668, "default": 0 }, "message_key": { "type": "string", "example": "messages.transaction_succeeded" }, "message": { "type": "string", "example": "Succeeded!" }, "gateway_token": { "type": "string", "example": "237c78vnYCN201Ib0ZAEzlZ4d0l" }, "gateway_type": { "type": "string", "example": "third party gateway" }, "payment_method": { "type": "object", "properties": { "token": { "type": "string", "example": "KVVQGbZgCzwMnhptyDNnhtyAk27" }, "created_at": { "type": "string", "example": "2022-05-09T11:31:24Z" }, "updated_at": { "type": "string", "example": "2022-05-09T11:31:24Z" }, "gateway_type": { "type": "string", "example": "third_party_gateway" }, "storage_state": { "type": "string", "example": "retained" }, "metadata": {}, "third_party_token": { "type": "string", "example": "cus_LeoRJx05gH5FnG|card_1KxUoCBkOJcrLi5mLgUkB7Zu" }, "payment_method_type": { "type": "string", "example": "third_party_token" }, "errors": { "type": "array" } } }, "basis_payment_method": { "type": "object", "properties": { "token": { "type": "string", "example": "KQYeXq7dKFA37x29rSrj4gvPSSV" }, "created_at": { "type": "string", "example": "2022-03-21T15:13:46Z" }, "updated_at": { "type": "string", "example": "2022-05-09T11:31:24Z" }, "email": {}, "data": {}, "storage_state": { "type": "string", "example": "retained" }, "test": { "type": "boolean", "example": true, "default": true }, "metadata": {}, "callback_url": {}, "last_four_digits": { "type": "string", "example": "1111" }, "first_six_digits": { "type": "string", "example": "411111" }, "card_type": { "type": "string", "example": "visa" }, "first_name": { "type": "string", "example": "Jimiy" }, "last_name": { "type": "string", "example": "Test" }, "month": { "type": "integer", "example": 12, "default": 0 }, "year": { "type": "integer", "example": 2022, "default": 0 }, "address1": {}, "address2": {}, "city": {}, "state": {}, "zip": {}, "country": {}, "phone_number": {}, "company": {}, "full_name": { "type": "string", "example": "Jimiy Test" }, "eligible_for_card_updater": { "type": "boolean", "example": true, "default": true }, "shipping_address1": {}, "shipping_address2": {}, "shipping_city": {}, "shipping_state": {}, "shipping_zip": {}, "shipping_country": {}, "shipping_phone_number": {}, "issuer_identification_number": { "type": "string", "example": "41111111" }, "payment_method_type": { "type": "string", "example": "credit_card" }, "errors": { "type": "array" }, "fingerprint": { "type": "string", "example": "e3cef43464fc832f6e04f187df25af497994" }, "verification_value": { "type": "string", "example": "" }, "number": { "type": "string", "example": "XXXX-XXXX-XXXX-1111" } } }, "response": { "type": "object", "properties": { "success": { "type": "boolean", "example": true, "default": true }, "message": { "type": "string", "example": "Transaction approved" }, "avs_code": {}, "avs_message": {}, "cvv_code": {}, "cvv_message": {}, "pending": { "type": "boolean", "example": false, "default": true }, "result_unknown": { "type": "boolean", "example": false, "default": true }, "error_code": {}, "error_detail": {}, "cancelled": { "type": "boolean", "example": false, "default": true }, "fraud_review": {}, "created_at": { "type": "string", "example": "2022-05-09T11:31:24Z" }, "updated_at": { "type": "string", "example": "2022-05-09T11:31:24Z" } } } } } } }, "success": { "type": "array", "items": { "type": "string", "example": "payment method successfully submitted" } } } } } } }, "422": { "description": "422", "content": { "application/json": { "examples": { "No Payment Method Found": { "value": "{\n \"error\": [\n \"no payment method found.\"\n ]\n}" } }, "schema": { "type": "object", "properties": { "error": { "type": "array", "items": { "type": "string", "example": "no payment method found." } } } } } } } }, "deprecated": false } }, "/transaction/{id}/receipt-sms": { "put": { "summary": "SMS Transaction Receipt", "description": "", "operationId": "sms-transaction-receipt", "parameters": [ { "name": "id", "in": "path", "description": "The id of the transaction that should be sent", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "ccSMS": { "type": "array", "description": "List of phone numbers", "items": { "type": "string" } } } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"id\": \"184ef996-de5e-41a8-b139-4ba595426053\",\n \"invoice_id\": \"2230adc8-a755-4a26-95b5-a54a4b8aa0ad\",\n \"reference_id\": \"\",\n \"recurring_transaction_id\": \"\",\n \"auth_id\": null,\n \"type\": \"charge\",\n \"source\": null,\n \"is_merchant_present\": true,\n \"merchant_id\": \"a61d78cc-cde9-44ac-8a18-30c39be05879\",\n \"user_id\": \"2d089742-6aca-462d-8db3-c2966e1f9e68\",\n \"customer_id\": \"0f553deb-5dbd-4dca-9bef-743c4bc2809f\",\n \"payment_method_id\": \"giftcard\",\n \"is_manual\": true,\n \"success\": true,\n \"message\": null,\n \"meta\": {\n \"update_inventory\": true,\n \"taxOverride\": false,\n \"isBulkInvoice\": false,\n \"taxRate\": 0,\n \"tax\": 0,\n \"subtotal\": 55,\n \"memo\": \"\",\n \"lineItems\": [\n {\n \"id\": \"generated-id-0630-32fe-649d-cf6c-e38b\",\n \"item\": \"\",\n \"details\": \"\",\n \"quantity\": 1,\n \"price\": \"55\"\n }\n ],\n \"reference\": 1872,\n \"check_number\": null,\n \"driver_license\": null,\n \"driver_license_state\": null,\n \"payment_phone\": null,\n \"payment_note\": null\n },\n \"total\": 55,\n \"method\": \"giftcard\",\n \"pre_auth\": false,\n \"is_captured\": 1,\n \"last_four\": null,\n \"interchange_code\": \"\",\n \"interchange_fee\": null,\n \"batch_id\": \"\",\n \"batched_at\": \"2018-10-02 10:53:09\",\n \"emv_response\": \"\",\n \"avs_response\": \"\",\n \"cvv_response\": \"\",\n \"pos_entry\": \"\",\n \"pos_salesperson\": \"\",\n \"receipt_email_at\": \"2018-10-02 14:47:08\",\n \"receipt_sms_at\": \"2018-10-02 14:53:09\",\n \"created_at\": \"2018-07-23 18:21:42\",\n \"updated_at\": \"2018-10-02 14:53:09\",\n \"total_refunded\": 0,\n \"is_refundable\": true,\n \"is_voided\": false,\n \"is_voidable\": true,\n \"currency\": \"USD\",\n \"schedule_id\": null,\n \"child_captures\": [],\n \"parent_auth\": null,\n \"customer\": {\n \"id\": \"0f553deb-5dbd-4dca-9bef-743c4bc2809f\",\n \"firstname\": \"Elizabeth\",\n \"lastname\": \"Jones\",\n \"company\": \"Liz's Lemonade\",\n \"email\": \"contact@example.com\",\n \"cc_emails\": null,\n \"cc_sms\": null,\n \"phone\": \"\",\n \"address_1\": \"\",\n \"address_2\": \"\",\n \"address_city\": \"\",\n \"address_state\": \"\",\n \"address_zip\": \"\",\n \"address_country\": \"\",\n \"notes\": \"\",\n \"reference\": \"\",\n \"options\": null,\n \"created_at\": \"2016-10-09 11:04:35\",\n \"updated_at\": \"2018-08-14 13:09:21\",\n \"deleted_at\": null,\n \"allow_invoice_credit_card_payments\": true,\n \"gravatar\": \"//www.gravatar.com/avatar/45357c125af15b6df8864a71a653bea2\"\n },\n \"child_transactions\": [],\n \"files\": [],\n \"payment_method\": {\n \"id\": \"giftcard\",\n \"customer_id\": \"\",\n \"merchant_id\": \"\",\n \"user_id\": \"\",\n \"nickname\": \"GIFT CARD\",\n \"has_cvv\": 0,\n \"is_default\": 0,\n \"method\": \"giftcard\",\n \"person_name\": null,\n \"card_type\": null,\n \"card_last_four\": null,\n \"card_exp\": null,\n \"bank_name\": null,\n \"bank_type\": null,\n \"bank_holder_type\": null,\n \"address_1\": null,\n \"address_2\": null,\n \"address_city\": null,\n \"address_state\": null,\n \"address_zip\": null,\n \"address_country\": null,\n \"purged_at\": null,\n \"deleted_at\": null,\n \"created_at\": \"2018-06-05 16:45:43\",\n \"updated_at\": \"2018-06-05 16:45:43\",\n \"card_exp_datetime\": [],\n \"is_usable_in_vt\": false,\n \"customer\": {\n \"id\": \"\",\n \"firstname\": \"\",\n \"lastname\": \"\",\n \"company\": \"\",\n \"email\": \"\",\n \"cc_emails\": null,\n \"cc_sms\": null,\n \"phone\": \"\",\n \"address_1\": \"\",\n \"address_2\": \"\",\n \"address_city\": \"\",\n \"address_state\": \"\",\n \"address_zip\": \"\",\n \"address_country\": \"\",\n \"notes\": null,\n \"reference\": \"\",\n \"options\": null,\n \"created_at\": null,\n \"updated_at\": null,\n \"deleted_at\": null,\n \"allow_invoice_credit_card_payments\": true,\n \"gravatar\": false\n }\n },\n \"user\": {\n \"id\": \"2d089742-6aca-462d-8db3-c2966e1f9e68\",\n \"system_admin\": true,\n \"name\": \"Morty Junior\",\n \"email\": \"contact@example.com\",\n \"email_verification_sent_at\": \"2018-09-26 18:24:21\",\n \"email_verified_at\": \"2016-05-11 17:13:33\",\n \"is_api_key\": false,\n \"acknowledgments\": {\n \"signedApplication\": true,\n \"editedOnboardingInformation\": false,\n \"tutorial\": true,\n \"godviewWelcome\": true\n },\n \"created_at\": \"2016-05-18 14:11:46\",\n \"updated_at\": \"2018-09-26 18:24:21\",\n \"deleted_at\": null,\n \"gravatar\": \"//www.gravatar.com/avatar/772cbf95746d7da86789cc3634c46ba8\",\n \"team_admin\": null,\n \"team_enabled\": null,\n \"team_role\": null,\n \"merchant_options\": [],\n \"is_default\": false\n }\n}" } }, "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "184ef996-de5e-41a8-b139-4ba595426053" }, "invoice_id": { "type": "string", "example": "2230adc8-a755-4a26-95b5-a54a4b8aa0ad" }, "reference_id": { "type": "string", "example": "" }, "recurring_transaction_id": { "type": "string", "example": "" }, "auth_id": {}, "type": { "type": "string", "example": "charge" }, "source": {}, "is_merchant_present": { "type": "boolean", "example": true, "default": true }, "merchant_id": { "type": "string", "example": "a61d78cc-cde9-44ac-8a18-30c39be05879" }, "user_id": { "type": "string", "example": "2d089742-6aca-462d-8db3-c2966e1f9e68" }, "customer_id": { "type": "string", "example": "0f553deb-5dbd-4dca-9bef-743c4bc2809f" }, "payment_method_id": { "type": "string", "example": "giftcard" }, "is_manual": { "type": "boolean", "example": true, "default": true }, "success": { "type": "boolean", "example": true, "default": true }, "message": {}, "meta": { "type": "object", "properties": { "update_inventory": { "type": "boolean", "example": true, "default": true }, "taxOverride": { "type": "boolean", "example": false, "default": true }, "isBulkInvoice": { "type": "boolean", "example": false, "default": true }, "taxRate": { "type": "integer", "example": 0, "default": 0 }, "tax": { "type": "integer", "example": 0, "default": 0 }, "subtotal": { "type": "integer", "example": 55, "default": 0 }, "memo": { "type": "string", "example": "" }, "lineItems": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "generated-id-0630-32fe-649d-cf6c-e38b" }, "item": { "type": "string", "example": "" }, "details": { "type": "string", "example": "" }, "quantity": { "type": "integer", "example": 1, "default": 0 }, "price": { "type": "string", "example": "55" } } } }, "reference": { "type": "integer", "example": 1872, "default": 0 }, "check_number": {}, "driver_license": {}, "driver_license_state": {}, "payment_phone": {}, "payment_note": {} } }, "total": { "type": "integer", "example": 55, "default": 0 }, "method": { "type": "string", "example": "giftcard" }, "pre_auth": { "type": "boolean", "example": false, "default": true }, "is_captured": { "type": "integer", "example": 1, "default": 0 }, "last_four": {}, "interchange_code": { "type": "string", "example": "" }, "interchange_fee": {}, "batch_id": { "type": "string", "example": "" }, "batched_at": { "type": "string", "example": "2018-10-02 10:53:09" }, "emv_response": { "type": "string", "example": "" }, "avs_response": { "type": "string", "example": "" }, "cvv_response": { "type": "string", "example": "" }, "pos_entry": { "type": "string", "example": "" }, "pos_salesperson": { "type": "string", "example": "" }, "receipt_email_at": { "type": "string", "example": "2018-10-02 14:47:08" }, "receipt_sms_at": { "type": "string", "example": "2018-10-02 14:53:09" }, "created_at": { "type": "string", "example": "2018-07-23 18:21:42" }, "updated_at": { "type": "string", "example": "2018-10-02 14:53:09" }, "total_refunded": { "type": "integer", "example": 0, "default": 0 }, "is_refundable": { "type": "boolean", "example": true, "default": true }, "is_voided": { "type": "boolean", "example": false, "default": true }, "is_voidable": { "type": "boolean", "example": true, "default": true }, "currency": { "type": "string", "example": "USD" }, "schedule_id": {}, "child_captures": { "type": "array" }, "parent_auth": {}, "customer": { "type": "object", "properties": { "id": { "type": "string", "example": "0f553deb-5dbd-4dca-9bef-743c4bc2809f" }, "firstname": { "type": "string", "example": "Elizabeth" }, "lastname": { "type": "string", "example": "Jones" }, "company": { "type": "string", "example": "Liz's Lemonade" }, "email": { "type": "string", "example": "contact@example.com" }, "cc_emails": {}, "cc_sms": {}, "phone": { "type": "string", "example": "" }, "address_1": { "type": "string", "example": "" }, "address_2": { "type": "string", "example": "" }, "address_city": { "type": "string", "example": "" }, "address_state": { "type": "string", "example": "" }, "address_zip": { "type": "string", "example": "" }, "address_country": { "type": "string", "example": "" }, "notes": { "type": "string", "example": "" }, "reference": { "type": "string", "example": "" }, "options": {}, "created_at": { "type": "string", "example": "2016-10-09 11:04:35" }, "updated_at": { "type": "string", "example": "2018-08-14 13:09:21" }, "deleted_at": {}, "allow_invoice_credit_card_payments": { "type": "boolean", "example": true, "default": true }, "gravatar": { "type": "string", "example": "//www.gravatar.com/avatar/45357c125af15b6df8864a71a653bea2" } } }, "child_transactions": { "type": "array" }, "files": { "type": "array" }, "payment_method": { "type": "object", "properties": { "id": { "type": "string", "example": "giftcard" }, "customer_id": { "type": "string", "example": "" }, "merchant_id": { "type": "string", "example": "" }, "user_id": { "type": "string", "example": "" }, "nickname": { "type": "string", "example": "GIFT CARD" }, "has_cvv": { "type": "integer", "example": 0, "default": 0 }, "is_default": { "type": "integer", "example": 0, "default": 0 }, "method": { "type": "string", "example": "giftcard" }, "person_name": {}, "card_type": {}, "card_last_four": {}, "card_exp": {}, "bank_name": {}, "bank_type": {}, "bank_holder_type": {}, "address_1": {}, "address_2": {}, "address_city": {}, "address_state": {}, "address_zip": {}, "address_country": {}, "purged_at": {}, "deleted_at": {}, "created_at": { "type": "string", "example": "2018-06-05 16:45:43" }, "updated_at": { "type": "string", "example": "2018-06-05 16:45:43" }, "card_exp_datetime": { "type": "array" }, "is_usable_in_vt": { "type": "boolean", "example": false, "default": true }, "customer": { "type": "object", "properties": { "id": { "type": "string", "example": "" }, "firstname": { "type": "string", "example": "" }, "lastname": { "type": "string", "example": "" }, "company": { "type": "string", "example": "" }, "email": { "type": "string", "example": "" }, "cc_emails": {}, "cc_sms": {}, "phone": { "type": "string", "example": "" }, "address_1": { "type": "string", "example": "" }, "address_2": { "type": "string", "example": "" }, "address_city": { "type": "string", "example": "" }, "address_state": { "type": "string", "example": "" }, "address_zip": { "type": "string", "example": "" }, "address_country": { "type": "string", "example": "" }, "notes": {}, "reference": { "type": "string", "example": "" }, "options": {}, "created_at": {}, "updated_at": {}, "deleted_at": {}, "allow_invoice_credit_card_payments": { "type": "boolean", "example": true, "default": true }, "gravatar": { "type": "boolean", "example": false, "default": true } } } } }, "user": { "type": "object", "properties": { "id": { "type": "string", "example": "2d089742-6aca-462d-8db3-c2966e1f9e68" }, "system_admin": { "type": "boolean", "example": true, "default": true }, "name": { "type": "string", "example": "Morty Junior" }, "email": { "type": "string", "example": "contact@example.com" }, "email_verification_sent_at": { "type": "string", "example": "2018-09-26 18:24:21" }, "email_verified_at": { "type": "string", "example": "2016-05-11 17:13:33" }, "is_api_key": { "type": "boolean", "example": false, "default": true }, "acknowledgments": { "type": "object", "properties": { "signedApplication": { "type": "boolean", "example": true, "default": true }, "editedOnboardingInformation": { "type": "boolean", "example": false, "default": true }, "tutorial": { "type": "boolean", "example": true, "default": true }, "godviewWelcome": { "type": "boolean", "example": true, "default": true } } }, "created_at": { "type": "string", "example": "2016-05-18 14:11:46" }, "updated_at": { "type": "string", "example": "2018-09-26 18:24:21" }, "deleted_at": {}, "gravatar": { "type": "string", "example": "//www.gravatar.com/avatar/772cbf95746d7da86789cc3634c46ba8" }, "team_admin": {}, "team_enabled": {}, "team_role": {}, "merchant_options": { "type": "array" }, "is_default": { "type": "boolean", "example": false, "default": true } } } } } } } }, "422": { "description": "422", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"id\": [\n \"Transaction could not be found\"\n ]\n}" } }, "schema": { "type": "object", "properties": { "id": { "type": "array", "items": { "type": "string", "example": "Transaction could not be found" } } } } } } } }, "deprecated": false } }, "/underwriting/dispute/{disputeId}/submit": { "post": { "summary": "Submit Dispute Evidence Files for Review", "description": "This route handles requests to send all of a dispute's associated evidence files for review.", "operationId": "submit-dispute-evidence-files-for-review", "parameters": [ { "name": "disputeId", "in": "path", "description": "A unique identifier of the dispute.", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"id\": \"07ad9751-443c-11ea-8e3f-0242ac140002\",\n \"transaction_id\": \"000e8694-d259-47ee-8fa1-bc0667e705a5\",\n \"merchant_id\": \"merchant1\",\n \"reason\": \"FRAUD\",\n \"amount\": 8888.88,\n \"status\": \"EVIDENCE_UPLOADED\",\n \"respond_by\": \"2020-01-20T23:48:03.000Z\",\n \"created_at\": \"2020-01-08T23:48:03.000Z\",\n \"updated_at\": \"2020-01-08T23:48:03.000Z\"\n}" } }, "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "07ad9751-443c-11ea-8e3f-0242ac140002" }, "transaction_id": { "type": "string", "example": "000e8694-d259-47ee-8fa1-bc0667e705a5" }, "merchant_id": { "type": "string", "example": "merchant1" }, "reason": { "type": "string", "example": "FRAUD" }, "amount": { "type": "number", "example": 8888.88, "default": 0 }, "status": { "type": "string", "example": "EVIDENCE_UPLOADED" }, "respond_by": { "type": "string", "example": "2020-01-20T23:48:03.000Z" }, "created_at": { "type": "string", "example": "2020-01-08T23:48:03.000Z" }, "updated_at": { "type": "string", "example": "2020-01-08T23:48:03.000Z" } } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "\n{\n \"status\": 400,\n \"message\": \"No associated evidence files found for dispute 'disputeID1234'. Ensure your dispute ID value is correct, or please upload evidence files prior to submitting dispute.\"\n}" } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "example": 400, "default": 0 }, "message": { "type": "string", "example": "No associated evidence files found for dispute 'disputeID1234'. Ensure your dispute ID value is correct, or please upload evidence files prior to submitting dispute." } } } } } } }, "deprecated": false } }, "/query/statement/v3/surcharges": { "get": { "summary": "Surcharging", "description": "", "operationId": "surcharging-1", "parameters": [ { "name": "startDate", "in": "query", "required": true, "description": "YYYY-MM-DD", "schema": { "type": "string", "default": "" } }, { "name": "endDate", "in": "query", "required": true, "description": "YYYY-MM-DD", "schema": { "type": "string", "default": "" } } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": " \"data\": [\n {\n \"card_type\": \"mastercard\",\n \"sales_amount\": 0,\n \"surcharges_amount\": 0,\n \"surcharges_count\": 0\n }\n ],\n \"summary\": {\n \"sales_amount\": 0,\n \"surcharges_amount\": 0,\n \"surcharges_count\": 0\n }{} \"data\": [\n {\n \"card_type\": \"mastercard\",\n \"sales_amount\": 0,\n \"surcharges_amount\": 0,\n \"surcharges_count\": 0\n }\n ],\n \"summary\": {\n \"sales_amount\": 0,\n \"surcharges_amount\": 0,\n \"surcharges_count\": 0\n }" } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "{}" } }, "schema": { "type": "object", "properties": {} } } } } }, "deprecated": false } }, "/team/option/branding": { "post": { "summary": "Team Branding", "description": "", "operationId": "team-branding", "parameters": [ { "name": "name", "in": "query", "description": "An optional nickname for the uploaded photo.", "schema": { "type": "string" } }, { "name": "image", "in": "query", "description": "PNG or JPEG image file", "schema": { "type": "string", "format": "binary", "default": "logo.png" } } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"id\": \"aa7766b2-242f-43b9-9476-3c9018f0ce52\",\n \"mid\": \"\",\n \"status\": \"PENDING\",\n \"subdomain\": \"\",\n \"company_name\": \"Stax\",\n \"contact_name\": \"Stax\",\n \"contact_email\": \"contact@example.com\",\n \"contact_phone\": \"8555503288\",\n \"address_1\": \"25 Wall Street\",\n \"address_2\": \"Suite 1\",\n \"address_city\": \"Orlando\",\n \"address_state\": \"FL\",\n \"address_zip\": \"32801\",\n \"hosted_payments_token\": null,\n \"currency\": [\n \"USD\"\n ],\n \"plan\": {\n \"id\": \"f92fee2b-fdae-4474-988c-c8f2df92772a\",\n \"merchant_id\": \"aa7766b2-242f-43b9-9476-3c9018f0ce52\",\n \"user_id\": \"b58d7eee-e68d-4d12-a1f8-62f5e71382ae\",\n \"name\": null,\n \"created_at\": \"2017-05-15 18:41:25\",\n \"updated_at\": \"2017-05-15 18:41:25\"\n },\n \"options\": null,\n \"gateway_type\": null,\n \"processor\": \"\",\n \"product_type\": \"\",\n \"welcome_email_sent_at\": null,\n \"created_at\": \"2017-05-15 17:02:37\",\n \"updated_at\": \"2017-05-15 18:41:25\",\n \"deleted_at\": null,\n \"gateway_name\": null,\n \"branding\": {\n \"id\": \"81218dbb-74ad-480e-958e-839ced6e6962\",\n \"merchant_id\": \"aa7766b2-242f-43b9-9476-3c9018f0ce52\",\n \"user_id\": \"b58d7eee-e68d-4d12-a1f8-62f5e71382ae\",\n \"name\": \"Bugu the Catu\",\n \"public_url\": \"https://s3-us-west-2.amazonaws.com/fattpaydocuments/branding/81218dbb-74ad-480e-958e-839ced6e6962.png\",\n \"tag\": \"branding\",\n \"meta\": {\n \"filesize_bytes\": 109524,\n \"filesize\": \"1.1 kB\",\n \"extension\": \"png\",\n \"size\": {\n \"width\": 537,\n \"height\": 512\n },\n \"mime\": \"image/png\"\n },\n \"created_at\": \"2017-05-15 19:15:53\",\n \"updated_at\": \"2017-05-15 19:15:56\",\n \"deleted_at\": null\n },\n \"allow_ach\": false\n}" } }, "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "aa7766b2-242f-43b9-9476-3c9018f0ce52" }, "mid": { "type": "string", "example": "" }, "status": { "type": "string", "example": "PENDING" }, "subdomain": { "type": "string", "example": "" }, "company_name": { "type": "string", "example": "Stax" }, "contact_name": { "type": "string", "example": "Stax" }, "contact_email": { "type": "string", "example": "contact@example.com" }, "contact_phone": { "type": "string", "example": "8555503288" }, "address_1": { "type": "string", "example": "25 Wall Street" }, "address_2": { "type": "string", "example": "Suite 1" }, "address_city": { "type": "string", "example": "Orlando" }, "address_state": { "type": "string", "example": "FL" }, "address_zip": { "type": "string", "example": "32801" }, "hosted_payments_token": {}, "currency": { "type": "array", "items": { "type": "string", "example": "USD" } }, "plan": { "type": "object", "properties": { "id": { "type": "string", "example": "f92fee2b-fdae-4474-988c-c8f2df92772a" }, "merchant_id": { "type": "string", "example": "aa7766b2-242f-43b9-9476-3c9018f0ce52" }, "user_id": { "type": "string", "example": "b58d7eee-e68d-4d12-a1f8-62f5e71382ae" }, "name": {}, "created_at": { "type": "string", "example": "2017-05-15 18:41:25" }, "updated_at": { "type": "string", "example": "2017-05-15 18:41:25" } } }, "options": {}, "gateway_type": {}, "processor": { "type": "string", "example": "" }, "product_type": { "type": "string", "example": "" }, "welcome_email_sent_at": {}, "created_at": { "type": "string", "example": "2017-05-15 17:02:37" }, "updated_at": { "type": "string", "example": "2017-05-15 18:41:25" }, "deleted_at": {}, "gateway_name": {}, "branding": { "type": "object", "properties": { "id": { "type": "string", "example": "81218dbb-74ad-480e-958e-839ced6e6962" }, "merchant_id": { "type": "string", "example": "aa7766b2-242f-43b9-9476-3c9018f0ce52" }, "user_id": { "type": "string", "example": "b58d7eee-e68d-4d12-a1f8-62f5e71382ae" }, "name": { "type": "string", "example": "Bugu the Catu" }, "public_url": { "type": "string", "example": "https://s3-us-west-2.amazonaws.com/fattpaydocuments/branding/81218dbb-74ad-480e-958e-839ced6e6962.png" }, "tag": { "type": "string", "example": "branding" }, "meta": { "type": "object", "properties": { "filesize_bytes": { "type": "integer", "example": 109524, "default": 0 }, "filesize": { "type": "string", "example": "1.1 kB" }, "extension": { "type": "string", "example": "png" }, "size": { "type": "object", "properties": { "width": { "type": "integer", "example": 537, "default": 0 }, "height": { "type": "integer", "example": 512, "default": 0 } } }, "mime": { "type": "string", "example": "image/png" } } }, "created_at": { "type": "string", "example": "2017-05-15 19:15:53" }, "updated_at": { "type": "string", "example": "2017-05-15 19:15:56" }, "deleted_at": {} } }, "allow_ach": { "type": "boolean", "example": false, "default": true } } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"image\": [\n \"The image field is required.\"\n ]\n}" } }, "schema": { "type": "object", "properties": { "image": { "type": "array", "items": { "type": "string", "example": "The image field is required." } } } } } } } }, "deprecated": false } }, "/query/statistics/teamSummary": { "get": { "summary": "Team Summary", "description": "Returns a list of stats about the current team.", "operationId": "team-summary", "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"charge_count_success\": 3,\n \"refund_count_success\": 0,\n \"charge_count_fail\": 1,\n \"invoice_count\": 56,\n \"scheduled_invoice_count\": 0,\n \"customer_count\": 222,\n \"user_count\": 11,\n \"file_count\": 3\n}" } }, "schema": { "type": "object", "properties": { "charge_count_success": { "type": "integer", "example": 3, "default": 0 }, "refund_count_success": { "type": "integer", "example": 0, "default": 0 }, "charge_count_fail": { "type": "integer", "example": 1, "default": 0 }, "invoice_count": { "type": "integer", "example": 56, "default": 0 }, "scheduled_invoice_count": { "type": "integer", "example": 0, "default": 0 }, "customer_count": { "type": "integer", "example": 222, "default": 0 }, "user_count": { "type": "integer", "example": 11, "default": 0 }, "file_count": { "type": "integer", "example": 3, "default": 0 } } } } } } }, "deprecated": false } }, "/terminal/tokenize": { "post": { "summary": "Tokenize", "description": "Requests the terminal to securely read a card and create a stored payment method (token) attached to the specified customer for future card-not-present use.", "security": [ { "ApiKeyAuth": [] } ], "operationId": "tokenize", "parameters": [], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"payment_method_id\": ,\n \"customer_id\": ,\n \"success\": true,\n \"type\": \"tokenize\",\n \"cancelled\": false,\n \"gatewayStatus\": 200,\n \"gatewayStatusText\": \"OK\"\n}" } } } } } }, "deprecated": false, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "customerId": { "type": "string", "required": true, "description": "The id of the customer to attach the newly created tokenized payment method to." }, "register": { "type": "string", "required": true, "description": "The id of the register performing this operation." }, "tokenize": { "type": "boolean", "required": true, "description": "This value must be true." } }, "required": [ "register", "tokenize", "customerId" ] } } } } } }, "/query/payment-links/{id}/update-stats": { "put": { "summary": "Update A Payment Link's Stats", "description": "Modify the sales statistics of an existing payment link, including updating the total sales and transaction count.", "operationId": "update-a-payment-links-stats", "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "total" ], "properties": { "total": { "type": "number", "description": "The total amount made from the single transaction.", "format": "float" } } } } } }, "responses": { "201": { "description": "201", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"status\": 200,\n \"message\": \"Payment Link Updated\",\n \"body\": {\n \"total\": 300\n }\n}" } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "example": 200, "default": 0 }, "message": { "type": "string", "example": "Payment Link Updated" }, "body": { "type": "object", "properties": { "total": { "type": "integer", "example": 300, "default": 0 } } } } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "{}" } }, "schema": { "type": "object", "properties": {} } } } } }, "deprecated": false } }, "/transaction/{id}/": { "put": { "summary": "Update a Transaction", "description": "Update specific fields of a manually created transaction.", "operationId": "update-a-transactions-information", "parameters": [ { "name": "id", "in": "path", "description": "The transaction ID.", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "customer_id": { "type": "string", "description": "If a customer is associated with the transaction, this will bind them to it." }, "invoice_id": { "type": "string", "description": "The given invoice ID for the transaction." } } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"id\": \"6f49149d-69a1-48e6-bec5-d63eb5816118\",\n \"invoice_id\": \"\",\n \"reference_id\": \"\",\n \"recurring_transaction_id\": \"\",\n \"type\": \"charge\",\n \"source\": null,\n \"merchant_id\": \"dd36b936-1eb7-4ece-bebc-b514c6a36ebd\",\n \"user_id\": \"41e60252-4f23-48de-a64f-e5a1e8a9359c\",\n \"customer_id\": \"d45ee88c-8b27-4be8-8d81-77dda1b81826\",\n \"payment_method_id\": \"129520d1-3844-45fd-a0b1-afb66bcdc74c\",\n \"is_manual\": null,\n \"success\": true,\n \"message\": null,\n \"meta\": {\n \"tax\": 0,\n \"subtotal\": 2,\n \"lineItems\": [\n {\n \"id\": \"optional-fm-catalog-item-id\",\n \"item\": \"Demo Item\",\n \"details\": \"this is a regular demo item\",\n \"quantity\": 1,\n \"price\": 2\n }\n ]\n },\n \"total\": 1,\n \"method\": \"card\",\n \"pre_auth\": false,\n \"last_four\": \"1111\",\n \"receipt_email_at\": null,\n \"receipt_sms_at\": null,\n \"created_at\": \"2017-05-17 19:57:08\",\n \"updated_at\": \"2017-05-17 19:57:08\",\n \"total_refunded\": null,\n \"is_refundable\": false,\n \"is_voided\": false,\n \"is_voidable\": true,\n \"currency\": \"USD\",\n \"schedule_id\": null,\n \"customer\": {\n \"id\": \"d45ee88c-8b27-4be8-8d81-77dda1b81826\",\n \"firstname\": \"John\",\n \"lastname\": \"Smith\",\n \"company\": \"ABC INC\",\n \"email\": \"demo@abc.com\",\n \"cc_emails\": [\n \"demo1@abc.com\",\n \"demo2@abc.com\"\n ],\n \"phone\": \"1234567898\",\n \"address_1\": \"123 Rite Way\",\n \"address_2\": \"Unit 12\",\n \"address_city\": \"Orlando\",\n \"address_state\": \"FL\",\n \"address_zip\": \"32801\",\n \"address_country\": \"USA\",\n \"notes\": null,\n \"reference\": \"BARTLE\",\n \"options\": \"\",\n \"created_at\": \"2017-05-08 19:22:51\",\n \"updated_at\": \"2017-05-08 19:23:46\",\n \"deleted_at\": null,\n \"gravatar\": \"//www.gravatar.com/avatar/fe3e929dd80f1653c3a4b82812660061\"\n },\n \"child_transactions\": [],\n \"files\": [],\n \"payment_method\": {\n \"id\": \"129520d1-3844-45fd-a0b1-afb66bcdc74c\",\n \"customer_id\": \"d45ee88c-8b27-4be8-8d81-77dda1b81826\",\n \"merchant_id\": \"dd36b936-1eb7-4ece-bebc-b514c6a36ebd\",\n \"user_id\": \"41e60252-4f23-48de-a64f-e5a1e8a9359c\",\n \"nickname\": \"VISA: Steven Smith Jr. (ending in: 1111)\",\n \"is_default\": 1,\n \"method\": \"card\",\n \"person_name\": \"Steven Smith Jr.\",\n \"card_type\": \"visa\",\n \"card_last_four\": \"1111\",\n \"card_exp\": \"042019\",\n \"bank_name\": null,\n \"bank_type\": null,\n \"bank_holder_type\": null,\n \"address_1\": null,\n \"address_2\": null,\n \"address_city\": null,\n \"address_state\": null,\n \"address_zip\": \"32944\",\n \"address_country\": \"USA\",\n \"purged_at\": null,\n \"deleted_at\": null,\n \"created_at\": \"2017-05-17 19:56:59\",\n \"updated_at\": \"2017-05-17 19:56:59\",\n \"card_exp_datetime\": \"2019-04-30 23:59:59\",\n \"customer\": {\n \"id\": \"d45ee88c-8b27-4be8-8d81-77dda1b81826\",\n \"firstname\": \"John\",\n \"lastname\": \"Smith\",\n \"company\": \"ABC INC\",\n \"email\": \"demo@abc.com\",\n \"cc_emails\": [\n \"demo1@abc.com\",\n \"demo2@abc.com\"\n ],\n \"phone\": \"1234567898\",\n \"address_1\": \"123 Rite Way\",\n \"address_2\": \"Unit 12\",\n \"address_city\": \"Orlando\",\n \"address_state\": \"FL\",\n \"address_zip\": \"32801\",\n \"address_country\": \"USA\",\n \"notes\": null,\n \"reference\": \"BARTLE\",\n \"options\": \"\",\n \"created_at\": \"2017-05-08 19:22:51\",\n \"updated_at\": \"2017-05-08 19:23:46\",\n \"deleted_at\": null,\n \"gravatar\": \"//www.gravatar.com/avatar/fe3e929dd80f1653c3a4b82812660061\"\n }\n },\n \"user\": {\n \"id\": \"41e60252-4f23-48de-a64f-e5a1e8a9359c\",\n \"system_admin\": true,\n \"name\": \"Benji\",\n \"email\": \"contact@example.com\",\n \"email_verification_sent_at\": \"2016-12-01 16:18:46\",\n \"email_verified_at\": \"2016-12-01 16:18:46\",\n \"is_api_key\": false,\n \"created_at\": \"2016-12-01 16:18:46\",\n \"updated_at\": \"2017-01-27 20:10:53\",\n \"deleted_at\": null,\n \"gravatar\": \"//www.gravatar.com/avatar/772cbf95746d7da86789cc3634c46ba8\",\n \"team_admin\": null,\n \"team_enabled\": null,\n \"team_role\": null,\n \"merchant_options\": [],\n \"is_portal\": false\n }\n}\n" } }, "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "6f49149d-69a1-48e6-bec5-d63eb5816118" }, "invoice_id": { "type": "string", "example": "" }, "reference_id": { "type": "string", "example": "" }, "recurring_transaction_id": { "type": "string", "example": "" }, "type": { "type": "string", "example": "charge" }, "source": {}, "merchant_id": { "type": "string", "example": "dd36b936-1eb7-4ece-bebc-b514c6a36ebd" }, "user_id": { "type": "string", "example": "41e60252-4f23-48de-a64f-e5a1e8a9359c" }, "customer_id": { "type": "string", "example": "d45ee88c-8b27-4be8-8d81-77dda1b81826" }, "payment_method_id": { "type": "string", "example": "129520d1-3844-45fd-a0b1-afb66bcdc74c" }, "is_manual": {}, "success": { "type": "boolean", "example": true, "default": true }, "message": {}, "meta": { "type": "object", "properties": { "tax": { "type": "integer", "example": 0, "default": 0 }, "subtotal": { "type": "integer", "example": 2, "default": 0 }, "lineItems": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "optional-fm-catalog-item-id" }, "item": { "type": "string", "example": "Demo Item" }, "details": { "type": "string", "example": "this is a regular demo item" }, "quantity": { "type": "integer", "example": 1, "default": 0 }, "price": { "type": "integer", "example": 2, "default": 0 } } } } } }, "total": { "type": "integer", "example": 1, "default": 0 }, "method": { "type": "string", "example": "card" }, "pre_auth": { "type": "boolean", "example": false, "default": true }, "last_four": { "type": "string", "example": "1111" }, "receipt_email_at": {}, "receipt_sms_at": {}, "created_at": { "type": "string", "example": "2017-05-17 19:57:08" }, "updated_at": { "type": "string", "example": "2017-05-17 19:57:08" }, "total_refunded": {}, "is_refundable": { "type": "boolean", "example": false, "default": true }, "is_voided": { "type": "boolean", "example": false, "default": true }, "is_voidable": { "type": "boolean", "example": true, "default": true }, "currency": { "type": "string", "example": "USD" }, "schedule_id": {}, "customer": { "type": "object", "properties": { "id": { "type": "string", "example": "d45ee88c-8b27-4be8-8d81-77dda1b81826" }, "firstname": { "type": "string", "example": "John" }, "lastname": { "type": "string", "example": "Smith" }, "company": { "type": "string", "example": "ABC INC" }, "email": { "type": "string", "example": "demo@abc.com" }, "cc_emails": { "type": "array", "items": { "type": "string", "example": "demo1@abc.com" } }, "phone": { "type": "string", "example": "1234567898" }, "address_1": { "type": "string", "example": "123 Rite Way" }, "address_2": { "type": "string", "example": "Unit 12" }, "address_city": { "type": "string", "example": "Orlando" }, "address_state": { "type": "string", "example": "FL" }, "address_zip": { "type": "string", "example": "32801" }, "address_country": { "type": "string", "example": "USA" }, "notes": {}, "reference": { "type": "string", "example": "BARTLE" }, "options": { "type": "string", "example": "" }, "created_at": { "type": "string", "example": "2017-05-08 19:22:51" }, "updated_at": { "type": "string", "example": "2017-05-08 19:23:46" }, "deleted_at": {}, "gravatar": { "type": "string", "example": "//www.gravatar.com/avatar/fe3e929dd80f1653c3a4b82812660061" } } }, "child_transactions": { "type": "array" }, "files": { "type": "array" }, "payment_method": { "type": "object", "properties": { "id": { "type": "string", "example": "129520d1-3844-45fd-a0b1-afb66bcdc74c" }, "customer_id": { "type": "string", "example": "d45ee88c-8b27-4be8-8d81-77dda1b81826" }, "merchant_id": { "type": "string", "example": "dd36b936-1eb7-4ece-bebc-b514c6a36ebd" }, "user_id": { "type": "string", "example": "41e60252-4f23-48de-a64f-e5a1e8a9359c" }, "nickname": { "type": "string", "example": "VISA: Steven Smith Jr. (ending in: 1111)" }, "is_default": { "type": "integer", "example": 1, "default": 0 }, "method": { "type": "string", "example": "card" }, "person_name": { "type": "string", "example": "Steven Smith Jr." }, "card_type": { "type": "string", "example": "visa" }, "card_last_four": { "type": "string", "example": "1111" }, "card_exp": { "type": "string", "example": "042019" }, "bank_name": {}, "bank_type": {}, "bank_holder_type": {}, "address_1": {}, "address_2": {}, "address_city": {}, "address_state": {}, "address_zip": { "type": "string", "example": "32944" }, "address_country": { "type": "string", "example": "USA" }, "purged_at": {}, "deleted_at": {}, "created_at": { "type": "string", "example": "2017-05-17 19:56:59" }, "updated_at": { "type": "string", "example": "2017-05-17 19:56:59" }, "card_exp_datetime": { "type": "string", "example": "2019-04-30 23:59:59" }, "customer": { "type": "object", "properties": { "id": { "type": "string", "example": "d45ee88c-8b27-4be8-8d81-77dda1b81826" }, "firstname": { "type": "string", "example": "John" }, "lastname": { "type": "string", "example": "Smith" }, "company": { "type": "string", "example": "ABC INC" }, "email": { "type": "string", "example": "demo@abc.com" }, "cc_emails": { "type": "array", "items": { "type": "string", "example": "demo1@abc.com" } }, "phone": { "type": "string", "example": "1234567898" }, "address_1": { "type": "string", "example": "123 Rite Way" }, "address_2": { "type": "string", "example": "Unit 12" }, "address_city": { "type": "string", "example": "Orlando" }, "address_state": { "type": "string", "example": "FL" }, "address_zip": { "type": "string", "example": "32801" }, "address_country": { "type": "string", "example": "USA" }, "notes": {}, "reference": { "type": "string", "example": "BARTLE" }, "options": { "type": "string", "example": "" }, "created_at": { "type": "string", "example": "2017-05-08 19:22:51" }, "updated_at": { "type": "string", "example": "2017-05-08 19:23:46" }, "deleted_at": {}, "gravatar": { "type": "string", "example": "//www.gravatar.com/avatar/fe3e929dd80f1653c3a4b82812660061" } } } } }, "user": { "type": "object", "properties": { "id": { "type": "string", "example": "41e60252-4f23-48de-a64f-e5a1e8a9359c" }, "system_admin": { "type": "boolean", "example": true, "default": true }, "name": { "type": "string", "example": "Benji" }, "email": { "type": "string", "example": "contact@example.com" }, "email_verification_sent_at": { "type": "string", "example": "2016-12-01 16:18:46" }, "email_verified_at": { "type": "string", "example": "2016-12-01 16:18:46" }, "is_api_key": { "type": "boolean", "example": false, "default": true }, "created_at": { "type": "string", "example": "2016-12-01 16:18:46" }, "updated_at": { "type": "string", "example": "2017-01-27 20:10:53" }, "deleted_at": {}, "gravatar": { "type": "string", "example": "//www.gravatar.com/avatar/772cbf95746d7da86789cc3634c46ba8" }, "team_admin": {}, "team_enabled": {}, "team_role": {}, "merchant_options": { "type": "array" }, "is_portal": { "type": "boolean", "example": false, "default": true } } } } } } } }, "422": { "description": "422", "content": { "application/json": { "examples": { "immutable": { "value": "{\n \"id\": [\n \"this transaction is immutable\"\n ]\n}" }, "Result": { "value": "{\n \"ccEmails.0\": [\n \"The ccEmails.0 must be a valid email address.\"\n ]\n}" } }, "schema": { "oneOf": [ { "title": "immutable", "type": "object", "properties": { "id": { "type": "array", "items": { "type": "string", "example": "this transaction is immutable" } } } }, { "type": "object", "properties": { "ccEmails.0": { "type": "array", "items": { "type": "string", "example": "The ccEmails.0 must be a valid email address." } } } } ] } } } } }, "deprecated": false } }, "/file/dispute": { "post": { "summary": "Upload Evidence for Dispute", "description": "This route handles requests to upload evidence files associated with a merchant's dispute.", "operationId": "upload-evidence-for-dispute", "parameters": [], "responses": { "201": { "description": "201", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"merchant_id\": \"merchant1\",\n \"user_id\": \"user1\",\n \"name\": \"receipt evidence\",\n \"tag\": \"dispute\",\n \"id\": \"b268c536-ba18-49da-83fa-914511f590f7\",\n \"updated_at\": \"2020-01-24 18:46:49\",\n \"created_at\": \"2020-01-24 18:46:48\",\n \"path\": \"dispute/b268c536-ba18-49da-83fa-914511f590f7.png\",\n \"public_url\": \"https://contractors-dev-bucket.s3.us-west-2.amazonaws.com/dispute/b268c536-ba18-49da-83fa-914511f590f7.png\",\n \"meta\": {\n \"filesize_bytes\": 7640,\n \"filesize\": \"0.08 kB\",\n \"extension\": \"png\",\n \"size\": {\n \"width\": 698,\n \"height\": 165\n },\n \"mime\": \"image/png\"\n }\n}" } }, "schema": { "type": "object", "properties": { "merchant_id": { "type": "string", "example": "merchant1" }, "user_id": { "type": "string", "example": "user1" }, "name": { "type": "string", "example": "receipt evidence" }, "tag": { "type": "string", "example": "dispute" }, "id": { "type": "string", "example": "b268c536-ba18-49da-83fa-914511f590f7" }, "updated_at": { "type": "string", "example": "2020-01-24 18:46:49" }, "created_at": { "type": "string", "example": "2020-01-24 18:46:48" }, "path": { "type": "string", "example": "dispute/b268c536-ba18-49da-83fa-914511f590f7.png" }, "public_url": { "type": "string", "example": "https://contractors-dev-bucket.s3.us-west-2.amazonaws.com/dispute/b268c536-ba18-49da-83fa-914511f590f7.png" }, "meta": { "type": "object", "properties": { "filesize_bytes": { "type": "integer", "example": 7640, "default": 0 }, "filesize": { "type": "string", "example": "0.08 kB" }, "extension": { "type": "string", "example": "png" }, "size": { "type": "object", "properties": { "width": { "type": "integer", "example": 698, "default": 0 }, "height": { "type": "integer", "example": 165, "default": 0 } } }, "mime": { "type": "string", "example": "image/png" } } } } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"error\": ['This dispute has passed the respond by date. No new documents can be uploaded at this time.'],\n}" } } } } } }, "deprecated": false, "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "dispute_id": { "type": "string", "description": "The id of the dispute to associate with this evidence file." }, "name": { "type": "string", "description": "The name value to assign to this evidence file." }, "file": { "type": "string", "format": "binary", "description": "The evidence file. It must be less than 10MB, must have one of the following extensions: .jpeg, .pdf, .png, or .tiff." } }, "required": [ "dispute_id", "name", "file" ] } } } } } }, "/verify": { "post": { "summary": "Verify A Payment Method", "description": "", "operationId": "verify-a-payment-method", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "total", "payment_method_id" ], "properties": { "total": { "type": "number", "description": "A float that is required and will be the amount a customer is charged", "format": "float" }, "payment_method_id": { "type": "string", "description": "An existing payment_method_id within Stax." }, "meta": { "properties": { "subtotal": { "type": "string" }, "tax": { "type": "string" }, "memo": { "type": "string" }, "reference": { "type": "string" }, " lineItems": { "properties": { "price": { "type": "string", "description": "Can contain any json object" }, "quantity": { "type": "string" }, "item": { "type": "string", "description": "Name of line item" }, "details": { "type": "string", "description": "Description of line item" }, "id": { "type": "string" } }, "required": [ "price", "quantity", "item", "details" ], "type": "object" } }, "required": [], "type": "object", "description": "Meta can contain any json object" } } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"id\": \"2f2c2b7f-ae85-45af-8120-f05c242cedfe\",\n \"invoice_id\": \"\",\n \"reference_id\": \"\",\n \"recurring_transaction_id\": \"\",\n \"type\": \"pre_auth\",\n \"source\": null,\n \"merchant_id\": \"dd36b936-1eb7-4ece-bebc-b514c6a36ebd\",\n \"user_id\": \"b58d7eee-e68d-4d12-a1f8-62f5e71382ae\",\n \"customer_id\": \"d45ee88c-8b27-4be8-8d81-77dda1b81826\",\n \"payment_method_id\": \"d3050b19-77d9-44ac-9851-b1d1680a7684\",\n \"is_manual\": null,\n \"success\": true,\n \"message\": null,\n \"meta\": {\n \"tax\": 2,\n \"subtotal\": 10\n },\n \"total\": 1,\n \"method\": \"card\",\n \"pre_auth\": true,\n \"last_four\": \"1111\",\n \"receipt_email_at\": null,\n \"receipt_sms_at\": null,\n \"created_at\": \"2017-05-08 20:24:28\",\n \"updated_at\": \"2017-05-08 20:24:28\",\n \"total_refunded\": null,\n \"is_refundable\": false,\n \"is_voided\": true,\n \"is_voidable\": false,\n \"schedule_id\": null,\n \"customer\": {\n \"id\": \"d45ee88c-8b27-4be8-8d81-77dda1b81826\",\n \"firstname\": \"John\",\n \"lastname\": \"Smith\",\n \"company\": \"ABC INC\",\n \"email\": \"demo@abc.com\",\n \"cc_emails\": [\n \"demo1@abc.com\",\n \"demo2@abc.com\"\n ],\n \"phone\": \"1234567898\",\n \"address_1\": \"123 Rite Way\",\n \"address_2\": \"Unit 12\",\n \"address_city\": \"Orlando\",\n \"address_state\": \"FL\",\n \"address_zip\": \"32801\",\n \"address_country\": \"USA\",\n \"notes\": null,\n \"reference\": \"BARTLE\",\n \"options\": \"\",\n \"created_at\": \"2017-05-08 19:22:51\",\n \"updated_at\": \"2017-05-08 19:23:46\",\n \"deleted_at\": null,\n \"gravatar\": \"//www.gravatar.com/avatar/fe3e929dd80f1653c3a4b82812660061\"\n },\n \"child_transactions\": [\n {\n \"id\": \"612bc846-39b2-4e83-9795-34cd0c6abcff\",\n \"invoice_id\": \"\",\n \"reference_id\": \"2f2c2b7f-ae85-45af-8120-f05c242cedfe\",\n \"recurring_transaction_id\": \"\",\n \"type\": \"void\",\n \"source\": null,\n \"merchant_id\": \"dd36b936-1eb7-4ece-bebc-b514c6a36ebd\",\n \"user_id\": \"b58d7eee-e68d-4d12-a1f8-62f5e71382ae\",\n \"customer_id\": \"d45ee88c-8b27-4be8-8d81-77dda1b81826\",\n \"payment_method_id\": \"d3050b19-77d9-44ac-9851-b1d1680a7684\",\n \"is_manual\": null,\n \"success\": true,\n \"message\": null,\n \"meta\": {\n \"tax\": 2,\n \"subtotal\": 10\n },\n \"total\": 1,\n \"method\": \"card\",\n \"pre_auth\": false,\n \"last_four\": \"1111\",\n \"receipt_email_at\": null,\n \"receipt_sms_at\": null,\n \"created_at\": \"2017-05-08 20:24:29\",\n \"updated_at\": \"2017-05-08 20:24:29\",\n \"total_refunded\": null,\n \"is_refundable\": false,\n \"is_voided\": null,\n \"is_voidable\": false,\n \"schedule_id\": null,\n \"customer\": {\n \"id\": \"d45ee88c-8b27-4be8-8d81-77dda1b81826\",\n \"firstname\": \"John\",\n \"lastname\": \"Smith\",\n \"company\": \"ABC INC\",\n \"email\": \"demo@abc.com\",\n \"cc_emails\": [\n \"demo1@abc.com\",\n \"demo2@abc.com\"\n ],\n \"phone\": \"1234567898\",\n \"address_1\": \"123 Rite Way\",\n \"address_2\": \"Unit 12\",\n \"address_city\": \"Orlando\",\n \"address_state\": \"FL\",\n \"address_zip\": \"32801\",\n \"address_country\": \"USA\",\n \"notes\": null,\n \"reference\": \"BARTLE\",\n \"options\": \"\",\n \"created_at\": \"2017-05-08 19:22:51\",\n \"updated_at\": \"2017-05-08 19:23:46\",\n \"deleted_at\": null,\n \"gravatar\": \"//www.gravatar.com/avatar/fe3e929dd80f1653c3a4b82812660061\"\n },\n \"child_transactions\": [],\n \"files\": [],\n \"payment_method\": {\n \"id\": \"d3050b19-77d9-44ac-9851-b1d1680a7684\",\n \"customer_id\": \"d45ee88c-8b27-4be8-8d81-77dda1b81826\",\n \"merchant_id\": \"dd36b936-1eb7-4ece-bebc-b514c6a36ebd\",\n \"user_id\": \"b58d7eee-e68d-4d12-a1f8-62f5e71382ae\",\n \"nickname\": \"VISA: Steven Smith Jr. (ending in: 1111)\",\n \"is_default\": 1,\n \"method\": \"card\",\n \"person_name\": \"Steven Smith Jr.\",\n \"card_type\": \"visa\",\n \"card_last_four\": \"1111\",\n \"card_exp\": \"042019\",\n \"bank_name\": null,\n \"bank_type\": null,\n \"bank_holder_type\": null,\n \"address_1\": null,\n \"address_2\": null,\n \"address_city\": null,\n \"address_state\": null,\n \"address_zip\": \"32944\",\n \"address_country\": \"USA\",\n \"purged_at\": null,\n \"deleted_at\": null,\n \"created_at\": \"2017-05-08 19:41:03\",\n \"updated_at\": \"2017-05-08 19:41:03\",\n \"card_exp_datetime\": \"2019-04-30 23:59:59\",\n \"customer\": {\n \"id\": \"d45ee88c-8b27-4be8-8d81-77dda1b81826\",\n \"firstname\": \"John\",\n \"lastname\": \"Smith\",\n \"company\": \"ABC INC\",\n \"email\": \"demo@abc.com\",\n \"cc_emails\": [\n \"demo1@abc.com\",\n \"demo2@abc.com\"\n ],\n \"phone\": \"1234567898\",\n \"address_1\": \"123 Rite Way\",\n \"address_2\": \"Unit 12\",\n \"address_city\": \"Orlando\",\n \"address_state\": \"FL\",\n \"address_zip\": \"32801\",\n \"address_country\": \"USA\",\n \"notes\": null,\n \"reference\": \"BARTLE\",\n \"options\": \"\",\n \"created_at\": \"2017-05-08 19:22:51\",\n \"updated_at\": \"2017-05-08 19:23:46\",\n \"deleted_at\": null,\n \"gravatar\": \"//www.gravatar.com/avatar/fe3e929dd80f1653c3a4b82812660061\"\n }\n },\n \"user\": {\n \"id\": \"b58d7eee-e68d-4d12-a1f8-62f5e71382ae\",\n \"system_admin\": false,\n \"name\": \"Demo\",\n \"email\": \"contact@example.com\",\n \"email_verification_sent_at\": \"2017-03-29 15:27:19\",\n \"email_verified_at\": \"2017-03-29 15:27:21\",\n \"is_api_key\": false,\n \"created_at\": \"2017-01-11 21:44:02\",\n \"updated_at\": \"2017-04-24 15:41:58\",\n \"deleted_at\": null,\n \"gravatar\": \"//www.gravatar.com/avatar/157965dea7cd2f44e349382d1d791650\",\n \"team_admin\": null,\n \"team_enabled\": null,\n \"team_role\": null\n }\n }\n ],\n \"files\": [],\n \"payment_method\": {\n \"id\": \"d3050b19-77d9-44ac-9851-b1d1680a7684\",\n \"customer_id\": \"d45ee88c-8b27-4be8-8d81-77dda1b81826\",\n \"merchant_id\": \"dd36b936-1eb7-4ece-bebc-b514c6a36ebd\",\n \"user_id\": \"b58d7eee-e68d-4d12-a1f8-62f5e71382ae\",\n \"nickname\": \"VISA: Steven Smith Jr. (ending in: 1111)\",\n \"is_default\": 1,\n \"method\": \"card\",\n \"person_name\": \"Steven Smith Jr.\",\n \"card_type\": \"visa\",\n \"card_last_four\": \"1111\",\n \"card_exp\": \"042019\",\n \"bank_name\": null,\n \"bank_type\": null,\n \"bank_holder_type\": null,\n \"address_1\": null,\n \"address_2\": null,\n \"address_city\": null,\n \"address_state\": null,\n \"address_zip\": \"32944\",\n \"address_country\": \"USA\",\n \"purged_at\": null,\n \"deleted_at\": null,\n \"created_at\": \"2017-05-08 19:41:03\",\n \"updated_at\": \"2017-05-08 19:41:03\",\n \"card_exp_datetime\": \"2019-04-30 23:59:59\",\n \"customer\": {\n \"id\": \"d45ee88c-8b27-4be8-8d81-77dda1b81826\",\n \"firstname\": \"John\",\n \"lastname\": \"Smith\",\n \"company\": \"ABC INC\",\n \"email\": \"demo@abc.com\",\n \"cc_emails\": [\n \"demo1@abc.com\",\n \"demo2@abc.com\"\n ],\n \"phone\": \"1234567898\",\n \"address_1\": \"123 Rite Way\",\n \"address_2\": \"Unit 12\",\n \"address_city\": \"Orlando\",\n \"address_state\": \"FL\",\n \"address_zip\": \"32801\",\n \"address_country\": \"USA\",\n \"notes\": null,\n \"reference\": \"BARTLE\",\n \"options\": \"\",\n \"created_at\": \"2017-05-08 19:22:51\",\n \"updated_at\": \"2017-05-08 19:23:46\",\n \"deleted_at\": null,\n \"gravatar\": \"//www.gravatar.com/avatar/fe3e929dd80f1653c3a4b82812660061\"\n }\n },\n \"user\": {\n \"id\": \"b58d7eee-e68d-4d12-a1f8-62f5e71382ae\",\n \"system_admin\": false,\n \"name\": \"Demo\",\n \"email\": \"contact@example.com\",\n \"email_verification_sent_at\": \"2017-03-29 15:27:19\",\n \"email_verified_at\": \"2017-03-29 15:27:21\",\n \"is_api_key\": false,\n \"created_at\": \"2017-01-11 21:44:02\",\n \"updated_at\": \"2017-04-24 15:41:58\",\n \"deleted_at\": null,\n \"gravatar\": \"//www.gravatar.com/avatar/157965dea7cd2f44e349382d1d791650\",\n \"team_admin\": null,\n \"team_enabled\": null,\n \"team_role\": null\n }\n}" } }, "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "2f2c2b7f-ae85-45af-8120-f05c242cedfe" }, "invoice_id": { "type": "string", "example": "" }, "reference_id": { "type": "string", "example": "" }, "recurring_transaction_id": { "type": "string", "example": "" }, "type": { "type": "string", "example": "pre_auth" }, "source": {}, "merchant_id": { "type": "string", "example": "dd36b936-1eb7-4ece-bebc-b514c6a36ebd" }, "user_id": { "type": "string", "example": "b58d7eee-e68d-4d12-a1f8-62f5e71382ae" }, "customer_id": { "type": "string", "example": "d45ee88c-8b27-4be8-8d81-77dda1b81826" }, "payment_method_id": { "type": "string", "example": "d3050b19-77d9-44ac-9851-b1d1680a7684" }, "is_manual": {}, "success": { "type": "boolean", "example": true, "default": true }, "message": {}, "meta": { "type": "object", "properties": { "tax": { "type": "integer", "example": 2, "default": 0 }, "subtotal": { "type": "integer", "example": 10, "default": 0 } } }, "total": { "type": "integer", "example": 1, "default": 0 }, "method": { "type": "string", "example": "card" }, "pre_auth": { "type": "boolean", "example": true, "default": true }, "last_four": { "type": "string", "example": "1111" }, "receipt_email_at": {}, "receipt_sms_at": {}, "created_at": { "type": "string", "example": "2017-05-08 20:24:28" }, "updated_at": { "type": "string", "example": "2017-05-08 20:24:28" }, "total_refunded": {}, "is_refundable": { "type": "boolean", "example": false, "default": true }, "is_voided": { "type": "boolean", "example": true, "default": true }, "is_voidable": { "type": "boolean", "example": false, "default": true }, "schedule_id": {}, "customer": { "type": "object", "properties": { "id": { "type": "string", "example": "d45ee88c-8b27-4be8-8d81-77dda1b81826" }, "firstname": { "type": "string", "example": "John" }, "lastname": { "type": "string", "example": "Smith" }, "company": { "type": "string", "example": "ABC INC" }, "email": { "type": "string", "example": "demo@abc.com" }, "cc_emails": { "type": "array", "items": { "type": "string", "example": "demo1@abc.com" } }, "phone": { "type": "string", "example": "1234567898" }, "address_1": { "type": "string", "example": "123 Rite Way" }, "address_2": { "type": "string", "example": "Unit 12" }, "address_city": { "type": "string", "example": "Orlando" }, "address_state": { "type": "string", "example": "FL" }, "address_zip": { "type": "string", "example": "32801" }, "address_country": { "type": "string", "example": "USA" }, "notes": {}, "reference": { "type": "string", "example": "BARTLE" }, "options": { "type": "string", "example": "" }, "created_at": { "type": "string", "example": "2017-05-08 19:22:51" }, "updated_at": { "type": "string", "example": "2017-05-08 19:23:46" }, "deleted_at": {}, "gravatar": { "type": "string", "example": "//www.gravatar.com/avatar/fe3e929dd80f1653c3a4b82812660061" } } }, "child_transactions": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "612bc846-39b2-4e83-9795-34cd0c6abcff" }, "invoice_id": { "type": "string", "example": "" }, "reference_id": { "type": "string", "example": "2f2c2b7f-ae85-45af-8120-f05c242cedfe" }, "recurring_transaction_id": { "type": "string", "example": "" }, "type": { "type": "string", "example": "void" }, "source": {}, "merchant_id": { "type": "string", "example": "dd36b936-1eb7-4ece-bebc-b514c6a36ebd" }, "user_id": { "type": "string", "example": "b58d7eee-e68d-4d12-a1f8-62f5e71382ae" }, "customer_id": { "type": "string", "example": "d45ee88c-8b27-4be8-8d81-77dda1b81826" }, "payment_method_id": { "type": "string", "example": "d3050b19-77d9-44ac-9851-b1d1680a7684" }, "is_manual": {}, "success": { "type": "boolean", "example": true, "default": true }, "message": {}, "meta": { "type": "object", "properties": { "tax": { "type": "integer", "example": 2, "default": 0 }, "subtotal": { "type": "integer", "example": 10, "default": 0 } } }, "total": { "type": "integer", "example": 1, "default": 0 }, "method": { "type": "string", "example": "card" }, "pre_auth": { "type": "boolean", "example": false, "default": true }, "last_four": { "type": "string", "example": "1111" }, "receipt_email_at": {}, "receipt_sms_at": {}, "created_at": { "type": "string", "example": "2017-05-08 20:24:29" }, "updated_at": { "type": "string", "example": "2017-05-08 20:24:29" }, "total_refunded": {}, "is_refundable": { "type": "boolean", "example": false, "default": true }, "is_voided": {}, "is_voidable": { "type": "boolean", "example": false, "default": true }, "schedule_id": {}, "customer": { "type": "object", "properties": { "id": { "type": "string", "example": "d45ee88c-8b27-4be8-8d81-77dda1b81826" }, "firstname": { "type": "string", "example": "John" }, "lastname": { "type": "string", "example": "Smith" }, "company": { "type": "string", "example": "ABC INC" }, "email": { "type": "string", "example": "demo@abc.com" }, "cc_emails": { "type": "array", "items": { "type": "string", "example": "demo1@abc.com" } }, "phone": { "type": "string", "example": "1234567898" }, "address_1": { "type": "string", "example": "123 Rite Way" }, "address_2": { "type": "string", "example": "Unit 12" }, "address_city": { "type": "string", "example": "Orlando" }, "address_state": { "type": "string", "example": "FL" }, "address_zip": { "type": "string", "example": "32801" }, "address_country": { "type": "string", "example": "USA" }, "notes": {}, "reference": { "type": "string", "example": "BARTLE" }, "options": { "type": "string", "example": "" }, "created_at": { "type": "string", "example": "2017-05-08 19:22:51" }, "updated_at": { "type": "string", "example": "2017-05-08 19:23:46" }, "deleted_at": {}, "gravatar": { "type": "string", "example": "//www.gravatar.com/avatar/fe3e929dd80f1653c3a4b82812660061" } } }, "child_transactions": { "type": "array" }, "files": { "type": "array" }, "payment_method": { "type": "object", "properties": { "id": { "type": "string", "example": "d3050b19-77d9-44ac-9851-b1d1680a7684" }, "customer_id": { "type": "string", "example": "d45ee88c-8b27-4be8-8d81-77dda1b81826" }, "merchant_id": { "type": "string", "example": "dd36b936-1eb7-4ece-bebc-b514c6a36ebd" }, "user_id": { "type": "string", "example": "b58d7eee-e68d-4d12-a1f8-62f5e71382ae" }, "nickname": { "type": "string", "example": "VISA: Steven Smith Jr. (ending in: 1111)" }, "is_default": { "type": "integer", "example": 1, "default": 0 }, "method": { "type": "string", "example": "card" }, "person_name": { "type": "string", "example": "Steven Smith Jr." }, "card_type": { "type": "string", "example": "visa" }, "card_last_four": { "type": "string", "example": "1111" }, "card_exp": { "type": "string", "example": "042019" }, "bank_name": {}, "bank_type": {}, "bank_holder_type": {}, "address_1": {}, "address_2": {}, "address_city": {}, "address_state": {}, "address_zip": { "type": "string", "example": "32944" }, "address_country": { "type": "string", "example": "USA" }, "purged_at": {}, "deleted_at": {}, "created_at": { "type": "string", "example": "2017-05-08 19:41:03" }, "updated_at": { "type": "string", "example": "2017-05-08 19:41:03" }, "card_exp_datetime": { "type": "string", "example": "2019-04-30 23:59:59" }, "customer": { "type": "object", "properties": { "id": { "type": "string", "example": "d45ee88c-8b27-4be8-8d81-77dda1b81826" }, "firstname": { "type": "string", "example": "John" }, "lastname": { "type": "string", "example": "Smith" }, "company": { "type": "string", "example": "ABC INC" }, "email": { "type": "string", "example": "demo@abc.com" }, "cc_emails": { "type": "array", "items": { "type": "string", "example": "demo1@abc.com" } }, "phone": { "type": "string", "example": "1234567898" }, "address_1": { "type": "string", "example": "123 Rite Way" }, "address_2": { "type": "string", "example": "Unit 12" }, "address_city": { "type": "string", "example": "Orlando" }, "address_state": { "type": "string", "example": "FL" }, "address_zip": { "type": "string", "example": "32801" }, "address_country": { "type": "string", "example": "USA" }, "notes": {}, "reference": { "type": "string", "example": "BARTLE" }, "options": { "type": "string", "example": "" }, "created_at": { "type": "string", "example": "2017-05-08 19:22:51" }, "updated_at": { "type": "string", "example": "2017-05-08 19:23:46" }, "deleted_at": {}, "gravatar": { "type": "string", "example": "//www.gravatar.com/avatar/fe3e929dd80f1653c3a4b82812660061" } } } } }, "user": { "type": "object", "properties": { "id": { "type": "string", "example": "b58d7eee-e68d-4d12-a1f8-62f5e71382ae" }, "system_admin": { "type": "boolean", "example": false, "default": true }, "name": { "type": "string", "example": "Demo" }, "email": { "type": "string", "example": "contact@example.com" }, "email_verification_sent_at": { "type": "string", "example": "2017-03-29 15:27:19" }, "email_verified_at": { "type": "string", "example": "2017-03-29 15:27:21" }, "is_api_key": { "type": "boolean", "example": false, "default": true }, "created_at": { "type": "string", "example": "2017-01-11 21:44:02" }, "updated_at": { "type": "string", "example": "2017-04-24 15:41:58" }, "deleted_at": {}, "gravatar": { "type": "string", "example": "//www.gravatar.com/avatar/157965dea7cd2f44e349382d1d791650" }, "team_admin": {}, "team_enabled": {}, "team_role": {} } } } } }, "files": { "type": "array" }, "payment_method": { "type": "object", "properties": { "id": { "type": "string", "example": "d3050b19-77d9-44ac-9851-b1d1680a7684" }, "customer_id": { "type": "string", "example": "d45ee88c-8b27-4be8-8d81-77dda1b81826" }, "merchant_id": { "type": "string", "example": "dd36b936-1eb7-4ece-bebc-b514c6a36ebd" }, "user_id": { "type": "string", "example": "b58d7eee-e68d-4d12-a1f8-62f5e71382ae" }, "nickname": { "type": "string", "example": "VISA: Steven Smith Jr. (ending in: 1111)" }, "is_default": { "type": "integer", "example": 1, "default": 0 }, "method": { "type": "string", "example": "card" }, "person_name": { "type": "string", "example": "Steven Smith Jr." }, "card_type": { "type": "string", "example": "visa" }, "card_last_four": { "type": "string", "example": "1111" }, "card_exp": { "type": "string", "example": "042019" }, "bank_name": {}, "bank_type": {}, "bank_holder_type": {}, "address_1": {}, "address_2": {}, "address_city": {}, "address_state": {}, "address_zip": { "type": "string", "example": "32944" }, "address_country": { "type": "string", "example": "USA" }, "purged_at": {}, "deleted_at": {}, "created_at": { "type": "string", "example": "2017-05-08 19:41:03" }, "updated_at": { "type": "string", "example": "2017-05-08 19:41:03" }, "card_exp_datetime": { "type": "string", "example": "2019-04-30 23:59:59" }, "customer": { "type": "object", "properties": { "id": { "type": "string", "example": "d45ee88c-8b27-4be8-8d81-77dda1b81826" }, "firstname": { "type": "string", "example": "John" }, "lastname": { "type": "string", "example": "Smith" }, "company": { "type": "string", "example": "ABC INC" }, "email": { "type": "string", "example": "demo@abc.com" }, "cc_emails": { "type": "array", "items": { "type": "string", "example": "demo1@abc.com" } }, "phone": { "type": "string", "example": "1234567898" }, "address_1": { "type": "string", "example": "123 Rite Way" }, "address_2": { "type": "string", "example": "Unit 12" }, "address_city": { "type": "string", "example": "Orlando" }, "address_state": { "type": "string", "example": "FL" }, "address_zip": { "type": "string", "example": "32801" }, "address_country": { "type": "string", "example": "USA" }, "notes": {}, "reference": { "type": "string", "example": "BARTLE" }, "options": { "type": "string", "example": "" }, "created_at": { "type": "string", "example": "2017-05-08 19:22:51" }, "updated_at": { "type": "string", "example": "2017-05-08 19:23:46" }, "deleted_at": {}, "gravatar": { "type": "string", "example": "//www.gravatar.com/avatar/fe3e929dd80f1653c3a4b82812660061" } } } } }, "user": { "type": "object", "properties": { "id": { "type": "string", "example": "b58d7eee-e68d-4d12-a1f8-62f5e71382ae" }, "system_admin": { "type": "boolean", "example": false, "default": true }, "name": { "type": "string", "example": "Demo" }, "email": { "type": "string", "example": "contact@example.com" }, "email_verification_sent_at": { "type": "string", "example": "2017-03-29 15:27:19" }, "email_verified_at": { "type": "string", "example": "2017-03-29 15:27:21" }, "is_api_key": { "type": "boolean", "example": false, "default": true }, "created_at": { "type": "string", "example": "2017-01-11 21:44:02" }, "updated_at": { "type": "string", "example": "2017-04-24 15:41:58" }, "deleted_at": {}, "gravatar": { "type": "string", "example": "//www.gravatar.com/avatar/157965dea7cd2f44e349382d1d791650" }, "team_admin": {}, "team_enabled": {}, "team_role": {} } } } } } } }, "422": { "description": "422", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"payment_method_id\": [\n \"The selected payment method id is invalid.\"\n ],\n \"total\": [\n \"The total field is required.\"\n ],\n \"meta\": [\n \"The meta field is required.\"\n ]\n}" } }, "schema": { "type": "object", "properties": { "payment_method_id": { "type": "array", "items": { "type": "string", "example": "The selected payment method id is invalid." } }, "total": { "type": "array", "items": { "type": "string", "example": "The total field is required." } }, "meta": { "type": "array", "items": { "type": "string", "example": "The meta field is required." } } } } } } } }, "deprecated": false } }, "/self/verify/{token}": { "get": { "summary": "Verify E-mail Token", "description": "Check if the token is valid.", "operationId": "verify-e-mail-token", "parameters": [ { "name": "token", "in": "path", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"email_verification\": [\n \"The user is verified\"\n ]\n}" } }, "schema": { "type": "object", "properties": { "email_verification": { "type": "array", "items": { "type": "string", "example": "The user is verified" } } } } } } }, "404": { "description": "404", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"email_verification\": [\n \"The user cannot be found\"\n ]\n}" } }, "schema": { "type": "object", "properties": { "email_verification": { "type": "array", "items": { "type": "string", "example": "The user cannot be found" } } } } } } } }, "deprecated": false } }, "/transaction/{id}/void-or-refund": { "post": { "summary": "Void or Refund Transaction", "description": "Void or refund a transaction based on its current status", "operationId": "void-or-refund-transaction", "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "total", "in": "query", "required": false, "schema": { "type": "number" } } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"id\": \"ba9bf00c-c54d-48f8-8400-902cb3aacd21\",\n \"invoice_id\": \"\",\n \"reference_id\": \"\",\n \"recurring_transaction_id\": \"\",\n \"type\": \"charge\",\n \"source\": null,\n \"merchant_id\": \"dd36b936-1eb7-4ece-bebc-b514c6a36ebd\",\n \"user_id\": \"41e60252-4f23-48de-a64f-e5a1e8a9359c\",\n \"customer_id\": \"d45ee88c-8b27-4be8-8d81-77dda1b81826\",\n \"payment_method_id\": \"129520d1-3844-45fd-a0b1-afb66bcdc74c\",\n \"is_manual\": null,\n \"success\": true,\n \"message\": null,\n \"meta\": {\n \"tax\": 2,\n \"subtotal\": 10\n },\n \"total\": 1,\n \"method\": \"card\",\n \"pre_auth\": false,\n \"last_four\": \"1111\",\n \"receipt_email_at\": \"2017-05-19 14:40:31\",\n \"receipt_sms_at\": null,\n \"created_at\": \"2017-05-19 13:50:44\",\n \"updated_at\": \"2017-05-19 14:40:31\",\n \"total_refunded\": null,\n \"is_refundable\": false,\n \"is_voided\": true,\n \"is_voidable\": false,\n \"schedule_id\": null,\n \"customer\": {\n \"id\": \"d45ee88c-8b27-4be8-8d81-77dda1b81826\",\n \"firstname\": \"John\",\n \"lastname\": \"Smith\",\n \"company\": \"ABC INC\",\n \"email\": \"demo@abc.com\",\n \"cc_emails\": [\n \"demo1@abc.com\",\n \"demo2@abc.com\"\n ],\n \"phone\": \"1234567898\",\n \"address_1\": \"123 Rite Way\",\n \"address_2\": \"Unit 12\",\n \"address_city\": \"Orlando\",\n \"address_state\": \"FL\",\n \"address_zip\": \"32801\",\n \"address_country\": \"USA\",\n \"notes\": null,\n \"reference\": \"BARTLE\",\n \"options\": \"\",\n \"created_at\": \"2017-05-08 19:22:51\",\n \"updated_at\": \"2017-05-08 19:23:46\",\n \"deleted_at\": null,\n \"gravatar\": \"//www.gravatar.com/avatar/fe3e929dd80f1653c3a4b82812660061\"\n },\n \"child_transactions\": [\n {\n \"id\": \"04497525-565c-4169-bb6d-5a4df399d255\",\n \"invoice_id\": \"\",\n \"reference_id\": \"ba9bf00c-c54d-48f8-8400-902cb3aacd21\",\n \"recurring_transaction_id\": \"\",\n \"type\": \"void\",\n \"source\": null,\n \"merchant_id\": \"dd36b936-1eb7-4ece-bebc-b514c6a36ebd\",\n \"user_id\": \"41e60252-4f23-48de-a64f-e5a1e8a9359c\",\n \"customer_id\": \"d45ee88c-8b27-4be8-8d81-77dda1b81826\",\n \"payment_method_id\": \"129520d1-3844-45fd-a0b1-afb66bcdc74c\",\n \"is_manual\": null,\n \"success\": true,\n \"message\": null,\n \"meta\": {\n \"tax\": 2,\n \"subtotal\": 10\n },\n \"total\": 1,\n \"method\": \"card\",\n \"pre_auth\": false,\n \"last_four\": \"1111\",\n \"receipt_email_at\": null,\n \"receipt_sms_at\": null,\n \"created_at\": \"2017-05-19 15:11:32\",\n \"updated_at\": \"2017-05-19 15:11:32\",\n \"total_refunded\": null,\n \"is_refundable\": false,\n \"is_voided\": null,\n \"is_voidable\": false,\n \"schedule_id\": null,\n \"customer\": {\n \"id\": \"d45ee88c-8b27-4be8-8d81-77dda1b81826\",\n \"firstname\": \"John\",\n \"lastname\": \"Smith\",\n \"company\": \"ABC INC\",\n \"email\": \"demo@abc.com\",\n \"cc_emails\": [\n \"demo1@abc.com\",\n \"demo2@abc.com\"\n ],\n \"phone\": \"1234567898\",\n \"address_1\": \"123 Rite Way\",\n \"address_2\": \"Unit 12\",\n \"address_city\": \"Orlando\",\n \"address_state\": \"FL\",\n \"address_zip\": \"32801\",\n \"address_country\": \"USA\",\n \"notes\": null,\n \"reference\": \"BARTLE\",\n \"options\": \"\",\n \"created_at\": \"2017-05-08 19:22:51\",\n \"updated_at\": \"2017-05-08 19:23:46\",\n \"deleted_at\": null,\n \"gravatar\": \"//www.gravatar.com/avatar/fe3e929dd80f1653c3a4b82812660061\"\n },\n \"child_transactions\": [],\n \"files\": [],\n \"payment_method\": {\n \"id\": \"129520d1-3844-45fd-a0b1-afb66bcdc74c\",\n \"customer_id\": \"d45ee88c-8b27-4be8-8d81-77dda1b81826\",\n \"merchant_id\": \"dd36b936-1eb7-4ece-bebc-b514c6a36ebd\",\n \"user_id\": \"41e60252-4f23-48de-a64f-e5a1e8a9359c\",\n \"nickname\": \"VISA: Steven Smith Jr. (ending in: 1111)\",\n \"is_default\": 1,\n \"method\": \"card\",\n \"person_name\": \"Steven Smith Jr.\",\n \"card_type\": \"visa\",\n \"card_last_four\": \"1111\",\n \"card_exp\": \"042019\",\n \"bank_name\": null,\n \"bank_type\": null,\n \"bank_holder_type\": null,\n \"address_1\": null,\n \"address_2\": null,\n \"address_city\": null,\n \"address_state\": null,\n \"address_zip\": \"32944\",\n \"address_country\": \"USA\",\n \"purged_at\": null,\n \"deleted_at\": null,\n \"created_at\": \"2017-05-17 19:56:59\",\n \"updated_at\": \"2017-05-17 19:56:59\",\n \"card_exp_datetime\": \"2019-04-30 23:59:59\",\n \"customer\": {\n \"id\": \"d45ee88c-8b27-4be8-8d81-77dda1b81826\",\n \"firstname\": \"John\",\n \"lastname\": \"Smith\",\n \"company\": \"ABC INC\",\n \"email\": \"demo@abc.com\",\n \"cc_emails\": [\n \"demo1@abc.com\",\n \"demo2@abc.com\"\n ],\n \"phone\": \"1234567898\",\n \"address_1\": \"123 Rite Way\",\n \"address_2\": \"Unit 12\",\n \"address_city\": \"Orlando\",\n \"address_state\": \"FL\",\n \"address_zip\": \"32801\",\n \"address_country\": \"USA\",\n \"notes\": null,\n \"reference\": \"BARTLE\",\n \"options\": \"\",\n \"created_at\": \"2017-05-08 19:22:51\",\n \"updated_at\": \"2017-05-08 19:23:46\",\n \"deleted_at\": null,\n \"gravatar\": \"//www.gravatar.com/avatar/fe3e929dd80f1653c3a4b82812660061\"\n }\n },\n \"user\": {\n \"id\": \"41e60252-4f23-48de-a64f-e5a1e8a9359c\",\n \"system_admin\": true,\n \"name\": \"Benji\",\n \"email\": \"contact@example.com\",\n \"email_verification_sent_at\": \"2016-12-01 16:18:46\",\n \"email_verified_at\": \"2016-12-01 16:18:46\",\n \"is_api_key\": false,\n \"created_at\": \"2016-12-01 16:18:46\",\n \"updated_at\": \"2017-01-27 20:10:53\",\n \"deleted_at\": null,\n \"gravatar\": \"//www.gravatar.com/avatar/772cbf95746d7da86789cc3634c46ba8\",\n \"team_admin\": null,\n \"team_enabled\": null,\n \"team_role\": null,\n \"merchant_options\": [],\n \"is_portal\": false\n }\n }\n ],\n \"files\": [],\n \"payment_method\": {\n \"id\": \"129520d1-3844-45fd-a0b1-afb66bcdc74c\",\n \"customer_id\": \"d45ee88c-8b27-4be8-8d81-77dda1b81826\",\n \"merchant_id\": \"dd36b936-1eb7-4ece-bebc-b514c6a36ebd\",\n \"user_id\": \"41e60252-4f23-48de-a64f-e5a1e8a9359c\",\n \"nickname\": \"VISA: Steven Smith Jr. (ending in: 1111)\",\n \"is_default\": 1,\n \"method\": \"card\",\n \"person_name\": \"Steven Smith Jr.\",\n \"card_type\": \"visa\",\n \"card_last_four\": \"1111\",\n \"card_exp\": \"042019\",\n \"bank_name\": null,\n \"bank_type\": null,\n \"bank_holder_type\": null,\n \"address_1\": null,\n \"address_2\": null,\n \"address_city\": null,\n \"address_state\": null,\n \"address_zip\": \"32944\",\n \"address_country\": \"USA\",\n \"purged_at\": null,\n \"deleted_at\": null,\n \"created_at\": \"2017-05-17 19:56:59\",\n \"updated_at\": \"2017-05-17 19:56:59\",\n \"card_exp_datetime\": \"2019-04-30 23:59:59\",\n \"customer\": {\n \"id\": \"d45ee88c-8b27-4be8-8d81-77dda1b81826\",\n \"firstname\": \"John\",\n \"lastname\": \"Smith\",\n \"company\": \"ABC INC\",\n \"email\": \"demo@abc.com\",\n \"cc_emails\": [\n \"demo1@abc.com\",\n \"demo2@abc.com\"\n ],\n \"phone\": \"1234567898\",\n \"address_1\": \"123 Rite Way\",\n \"address_2\": \"Unit 12\",\n \"address_city\": \"Orlando\",\n \"address_state\": \"FL\",\n \"address_zip\": \"32801\",\n \"address_country\": \"USA\",\n \"notes\": null,\n \"reference\": \"BARTLE\",\n \"options\": \"\",\n \"created_at\": \"2017-05-08 19:22:51\",\n \"updated_at\": \"2017-05-08 19:23:46\",\n \"deleted_at\": null,\n \"gravatar\": \"//www.gravatar.com/avatar/fe3e929dd80f1653c3a4b82812660061\"\n }\n },\n \"user\": {\n \"id\": \"41e60252-4f23-48de-a64f-e5a1e8a9359c\",\n \"system_admin\": true,\n \"name\": \"Benji\",\n \"email\": \"contact@example.com\",\n \"email_verification_sent_at\": \"2016-12-01 16:18:46\",\n \"email_verified_at\": \"2016-12-01 16:18:46\",\n \"is_api_key\": false,\n \"created_at\": \"2016-12-01 16:18:46\",\n \"updated_at\": \"2017-01-27 20:10:53\",\n \"deleted_at\": null,\n \"gravatar\": \"//www.gravatar.com/avatar/772cbf95746d7da86789cc3634c46ba8\",\n \"team_admin\": null,\n \"team_enabled\": null,\n \"team_role\": null,\n \"merchant_options\": [],\n \"is_portal\": false\n }\n}" } }, "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "ba9bf00c-c54d-48f8-8400-902cb3aacd21" }, "invoice_id": { "type": "string", "example": "" }, "reference_id": { "type": "string", "example": "" }, "recurring_transaction_id": { "type": "string", "example": "" }, "type": { "type": "string", "example": "charge" }, "source": {}, "merchant_id": { "type": "string", "example": "dd36b936-1eb7-4ece-bebc-b514c6a36ebd" }, "user_id": { "type": "string", "example": "41e60252-4f23-48de-a64f-e5a1e8a9359c" }, "customer_id": { "type": "string", "example": "d45ee88c-8b27-4be8-8d81-77dda1b81826" }, "payment_method_id": { "type": "string", "example": "129520d1-3844-45fd-a0b1-afb66bcdc74c" }, "is_manual": {}, "success": { "type": "boolean", "example": true, "default": true }, "message": {}, "meta": { "type": "object", "properties": { "tax": { "type": "number", "example": 2, "default": 0 }, "subtotal": { "type": "number", "example": 10, "default": 0 } } }, "total": { "type": "number", "example": 1, "default": 0 }, "method": { "type": "string", "example": "card" }, "pre_auth": { "type": "boolean", "example": false, "default": true }, "last_four": { "type": "string", "example": "1111" }, "receipt_email_at": { "type": "string", "example": "2017-05-19 14:40:31" }, "receipt_sms_at": {}, "created_at": { "type": "string", "example": "2017-05-19 13:50:44" }, "updated_at": { "type": "string", "example": "2017-05-19 14:40:31" }, "total_refunded": { "type": "number" }, "is_refundable": { "type": "boolean", "example": false, "default": true }, "is_voided": { "type": "boolean", "example": true, "default": true }, "is_voidable": { "type": "boolean", "example": false, "default": true }, "schedule_id": {}, "customer": { "type": "object", "properties": { "id": { "type": "string", "example": "d45ee88c-8b27-4be8-8d81-77dda1b81826" }, "firstname": { "type": "string", "example": "John" }, "lastname": { "type": "string", "example": "Smith" }, "company": { "type": "string", "example": "ABC INC" }, "email": { "type": "string", "example": "demo@abc.com" }, "cc_emails": { "type": "array", "items": { "type": "string", "example": "demo1@abc.com" } }, "phone": { "type": "string", "example": "1234567898" }, "address_1": { "type": "string", "example": "123 Rite Way" }, "address_2": { "type": "string", "example": "Unit 12" }, "address_city": { "type": "string", "example": "Orlando" }, "address_state": { "type": "string", "example": "FL" }, "address_zip": { "type": "string", "example": "32801" }, "address_country": { "type": "string", "example": "USA" }, "notes": {}, "reference": { "type": "string", "example": "BARTLE" }, "options": { "type": "string", "example": "" }, "created_at": { "type": "string", "example": "2017-05-08 19:22:51" }, "updated_at": { "type": "string", "example": "2017-05-08 19:23:46" }, "deleted_at": {}, "gravatar": { "type": "string", "example": "//www.gravatar.com/avatar/fe3e929dd80f1653c3a4b82812660061" } } }, "child_transactions": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "04497525-565c-4169-bb6d-5a4df399d255" }, "invoice_id": { "type": "string", "example": "" }, "reference_id": { "type": "string", "example": "ba9bf00c-c54d-48f8-8400-902cb3aacd21" }, "recurring_transaction_id": { "type": "string", "example": "" }, "type": { "type": "string", "example": "void" }, "source": {}, "merchant_id": { "type": "string", "example": "dd36b936-1eb7-4ece-bebc-b514c6a36ebd" }, "user_id": { "type": "string", "example": "41e60252-4f23-48de-a64f-e5a1e8a9359c" }, "customer_id": { "type": "string", "example": "d45ee88c-8b27-4be8-8d81-77dda1b81826" }, "payment_method_id": { "type": "string", "example": "129520d1-3844-45fd-a0b1-afb66bcdc74c" }, "is_manual": {}, "success": { "type": "boolean", "example": true, "default": true }, "message": {}, "meta": { "type": "object", "properties": { "tax": { "type": "integer", "example": 2, "default": 0 }, "subtotal": { "type": "integer", "example": 10, "default": 0 } } }, "total": { "type": "integer", "example": 1, "default": 0 }, "method": { "type": "string", "example": "card" }, "pre_auth": { "type": "boolean", "example": false, "default": true }, "last_four": { "type": "string", "example": "1111" }, "receipt_email_at": {}, "receipt_sms_at": {}, "created_at": { "type": "string", "example": "2017-05-19 15:11:32" }, "updated_at": { "type": "string", "example": "2017-05-19 15:11:32" }, "total_refunded": {}, "is_refundable": { "type": "boolean", "example": false, "default": true }, "is_voided": {}, "is_voidable": { "type": "boolean", "example": false, "default": true }, "schedule_id": {}, "customer": { "type": "object", "properties": { "id": { "type": "string", "example": "d45ee88c-8b27-4be8-8d81-77dda1b81826" }, "firstname": { "type": "string", "example": "John" }, "lastname": { "type": "string", "example": "Smith" }, "company": { "type": "string", "example": "ABC INC" }, "email": { "type": "string", "example": "demo@abc.com" }, "cc_emails": { "type": "array", "items": { "type": "string", "example": "demo1@abc.com" } }, "phone": { "type": "string", "example": "1234567898" }, "address_1": { "type": "string", "example": "123 Rite Way" }, "address_2": { "type": "string", "example": "Unit 12" }, "address_city": { "type": "string", "example": "Orlando" }, "address_state": { "type": "string", "example": "FL" }, "address_zip": { "type": "string", "example": "32801" }, "address_country": { "type": "string", "example": "USA" }, "notes": {}, "reference": { "type": "string", "example": "BARTLE" }, "options": { "type": "string", "example": "" }, "created_at": { "type": "string", "example": "2017-05-08 19:22:51" }, "updated_at": { "type": "string", "example": "2017-05-08 19:23:46" }, "deleted_at": {}, "gravatar": { "type": "string", "example": "//www.gravatar.com/avatar/fe3e929dd80f1653c3a4b82812660061" } } }, "child_transactions": { "type": "array" }, "files": { "type": "array" }, "payment_method": { "type": "object", "properties": { "id": { "type": "string", "example": "129520d1-3844-45fd-a0b1-afb66bcdc74c" }, "customer_id": { "type": "string", "example": "d45ee88c-8b27-4be8-8d81-77dda1b81826" }, "merchant_id": { "type": "string", "example": "dd36b936-1eb7-4ece-bebc-b514c6a36ebd" }, "user_id": { "type": "string", "example": "41e60252-4f23-48de-a64f-e5a1e8a9359c" }, "nickname": { "type": "string", "example": "VISA: Steven Smith Jr. (ending in: 1111)" }, "is_default": { "type": "integer", "example": 1, "default": 0 }, "method": { "type": "string", "example": "card" }, "person_name": { "type": "string", "example": "Steven Smith Jr." }, "card_type": { "type": "string", "example": "visa" }, "card_last_four": { "type": "string", "example": "1111" }, "card_exp": { "type": "string", "example": "042019" }, "bank_name": {}, "bank_type": {}, "bank_holder_type": {}, "address_1": {}, "address_2": {}, "address_city": {}, "address_state": {}, "address_zip": { "type": "string", "example": "32944" }, "address_country": { "type": "string", "example": "USA" }, "purged_at": {}, "deleted_at": {}, "created_at": { "type": "string", "example": "2017-05-17 19:56:59" }, "updated_at": { "type": "string", "example": "2017-05-17 19:56:59" }, "card_exp_datetime": { "type": "string", "example": "2019-04-30 23:59:59" }, "customer": { "type": "object", "properties": { "id": { "type": "string", "example": "d45ee88c-8b27-4be8-8d81-77dda1b81826" }, "firstname": { "type": "string", "example": "John" }, "lastname": { "type": "string", "example": "Smith" }, "company": { "type": "string", "example": "ABC INC" }, "email": { "type": "string", "example": "demo@abc.com" }, "cc_emails": { "type": "array", "items": { "type": "string", "example": "demo1@abc.com" } }, "phone": { "type": "string", "example": "1234567898" }, "address_1": { "type": "string", "example": "123 Rite Way" }, "address_2": { "type": "string", "example": "Unit 12" }, "address_city": { "type": "string", "example": "Orlando" }, "address_state": { "type": "string", "example": "FL" }, "address_zip": { "type": "string", "example": "32801" }, "address_country": { "type": "string", "example": "USA" }, "notes": {}, "reference": { "type": "string", "example": "BARTLE" }, "options": { "type": "string", "example": "" }, "created_at": { "type": "string", "example": "2017-05-08 19:22:51" }, "updated_at": { "type": "string", "example": "2017-05-08 19:23:46" }, "deleted_at": {}, "gravatar": { "type": "string", "example": "//www.gravatar.com/avatar/fe3e929dd80f1653c3a4b82812660061" } } } } }, "user": { "type": "object", "properties": { "id": { "type": "string", "example": "41e60252-4f23-48de-a64f-e5a1e8a9359c" }, "system_admin": { "type": "boolean", "example": true, "default": true }, "name": { "type": "string", "example": "Benji" }, "email": { "type": "string", "example": "contact@example.com" }, "email_verification_sent_at": { "type": "string", "example": "2016-12-01 16:18:46" }, "email_verified_at": { "type": "string", "example": "2016-12-01 16:18:46" }, "is_api_key": { "type": "boolean", "example": false, "default": true }, "created_at": { "type": "string", "example": "2016-12-01 16:18:46" }, "updated_at": { "type": "string", "example": "2017-01-27 20:10:53" }, "deleted_at": {}, "gravatar": { "type": "string", "example": "//www.gravatar.com/avatar/772cbf95746d7da86789cc3634c46ba8" }, "team_admin": {}, "team_enabled": {}, "team_role": {}, "merchant_options": { "type": "array" }, "is_portal": { "type": "boolean", "example": false, "default": true } } } } } }, "files": { "type": "array" }, "payment_method": { "type": "object", "properties": { "id": { "type": "string", "example": "129520d1-3844-45fd-a0b1-afb66bcdc74c" }, "customer_id": { "type": "string", "example": "d45ee88c-8b27-4be8-8d81-77dda1b81826" }, "merchant_id": { "type": "string", "example": "dd36b936-1eb7-4ece-bebc-b514c6a36ebd" }, "user_id": { "type": "string", "example": "41e60252-4f23-48de-a64f-e5a1e8a9359c" }, "nickname": { "type": "string", "example": "VISA: Steven Smith Jr. (ending in: 1111)" }, "is_default": { "type": "integer", "example": 1, "default": 0 }, "method": { "type": "string", "example": "card" }, "person_name": { "type": "string", "example": "Steven Smith Jr." }, "card_type": { "type": "string", "example": "visa" }, "card_last_four": { "type": "string", "example": "1111" }, "card_exp": { "type": "string", "example": "042019" }, "bank_name": {}, "bank_type": {}, "bank_holder_type": {}, "address_1": {}, "address_2": {}, "address_city": {}, "address_state": {}, "address_zip": { "type": "string", "example": "32944" }, "address_country": { "type": "string", "example": "USA" }, "purged_at": {}, "deleted_at": {}, "created_at": { "type": "string", "example": "2017-05-17 19:56:59" }, "updated_at": { "type": "string", "example": "2017-05-17 19:56:59" }, "card_exp_datetime": { "type": "string", "example": "2019-04-30 23:59:59" }, "customer": { "type": "object", "properties": { "id": { "type": "string", "example": "d45ee88c-8b27-4be8-8d81-77dda1b81826" }, "firstname": { "type": "string", "example": "John" }, "lastname": { "type": "string", "example": "Smith" }, "company": { "type": "string", "example": "ABC INC" }, "email": { "type": "string", "example": "demo@abc.com" }, "cc_emails": { "type": "array", "items": { "type": "string", "example": "demo1@abc.com" } }, "phone": { "type": "string", "example": "1234567898" }, "address_1": { "type": "string", "example": "123 Rite Way" }, "address_2": { "type": "string", "example": "Unit 12" }, "address_city": { "type": "string", "example": "Orlando" }, "address_state": { "type": "string", "example": "FL" }, "address_zip": { "type": "string", "example": "32801" }, "address_country": { "type": "string", "example": "USA" }, "notes": {}, "reference": { "type": "string", "example": "BARTLE" }, "options": { "type": "string", "example": "" }, "created_at": { "type": "string", "example": "2017-05-08 19:22:51" }, "updated_at": { "type": "string", "example": "2017-05-08 19:23:46" }, "deleted_at": {}, "gravatar": { "type": "string", "example": "//www.gravatar.com/avatar/fe3e929dd80f1653c3a4b82812660061" } } } } }, "user": { "type": "object", "properties": { "id": { "type": "string", "example": "41e60252-4f23-48de-a64f-e5a1e8a9359c" }, "system_admin": { "type": "boolean", "example": true, "default": true }, "name": { "type": "string", "example": "Benji" }, "email": { "type": "string", "example": "contact@example.com" }, "email_verification_sent_at": { "type": "string", "example": "2016-12-01 16:18:46" }, "email_verified_at": { "type": "string", "example": "2016-12-01 16:18:46" }, "is_api_key": { "type": "boolean", "example": false, "default": true }, "created_at": { "type": "string", "example": "2016-12-01 16:18:46" }, "updated_at": { "type": "string", "example": "2017-01-27 20:10:53" }, "deleted_at": {}, "gravatar": { "type": "string", "example": "//www.gravatar.com/avatar/772cbf95746d7da86789cc3634c46ba8" }, "team_admin": {}, "team_enabled": {}, "team_role": {}, "merchant_options": { "type": "array" }, "is_portal": { "type": "boolean", "example": false, "default": true } } } } } } } }, "422": { "description": "422", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"total\": [\n \"The transaction has already been voided.\"\n ],\n \"total\": [\n \"Only full refunds are allowed to be attempted before 12AM EST.\n ],\n\"type\": [\n \"The transaction to refund must be a successful auth, charge, credit, or capture.\"\n ]\n}" } } } } } }, "deprecated": false } }, "/terminal/void-or-refund": { "post": { "summary": "Void/Refund", "description": "Attempts to void a card-present transaction if still in its open batch window; otherwise performs a refund.", "operationId": "void-refund", "parameters": [], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"id\": \"4be11b7e-21cb-4c9e-ba8f-5e173d13d7b7\",\n \"invoice_id\": \"\",\n \"reference_id\": \"5114aea7-5c7f-40ab-8a62-84f239e4b2b1\",\n \"recurring_transaction_id\": \"\",\n \"auth_id\": null,\n \"type\": \"refund\",\n \"source\": \"terminalservice.dejavoo\",\n \"is_merchant_present\": true,\n \"merchant_id\": \"27fad5e4-0210-4c91-9596-417b0ea0dbb1\",\n \"user_id\": \"dbc85118-3309-4129-b966-0108c0fb18a0\",\n \"customer_id\": \"2a503ed1-99ea-4b35-a30a-605253f7c05a\",\n \"payment_method_id\": \"bf1aee65-dad9-4b74-8800-a75e435e3e7b\",\n \"is_manual\": true,\n \"success\": true,\n \"message\": \"\",\n \"meta\": {\n \"lineItems\": [\n {\n \"item\": \"\",\n \"details\": \"\",\n \"quantity\": 1,\n \"price\": \"0.01\"\n }\n ],\n \"subtotal\": 0.01,\n \"tax\": 0,\n \"taxRate\": 10,\n \"isBulkInvoice\": false,\n \"taxOverride\": false,\n \"update_inventory\": true,\n \"reference\": 2477,\n \"RegisterId\": 3594291,\n \"ResultCode\": 0,\n \"RespMSG\": \"Approved Offline\",\n \"Message\": \"Approved\",\n \"AuthCode\": 145599,\n \"PNRef\": 810618212223,\n \"PaymentType\": \"Credit\",\n \"TransType\": \"Return\",\n \"SN\": 118816524647,\n \"ExtData\": {\n \"Amount\": \"0.01\",\n \"InvNum\": \"10\",\n \"CardType\": \"VISA\",\n \"BatchNum\": \"56\",\n \"Tip\": \"0.00\",\n \"CashBack\": \"0.00\",\n \"Fee\": \"0.00\",\n \"AcntLast4\": \"0281\",\n \"Name\": \"YOU/A GIFT FOR\",\n \"SVC\": \"0.00\",\n \"TotalAmt\": \"0.01\",\n \"DISC\": \"0.00\",\n \"Donation\": \"0.00\",\n \"SHFee\": \"0.00\",\n \"RwdPoints\": \"0\",\n \"RwdBalance\": \"0\",\n \"RwdIssued\": \"\",\n \"EBTFSLedgerBalance\": \"\",\n \"EBTFSAvailBalance\": \"\",\n \"EBTFSBeginBalance\": \"\",\n \"EBTCashLedgerBalance\": \"\",\n \"EBTCashAvailBalance\": \"\",\n \"EBTCashBeginBalance\": \"\",\n \"RewardCode\": \"\",\n \"AcqRefData\": \"\",\n \"ProcessData\": \"\",\n \"RefNo\": \"\",\n \"RewardQR\": \"\",\n \"Language\": \"English\",\n \"EntryType\": \"Swipe\",\n \"table_num\": \"0\",\n \"clerk_id\": \"\",\n \"ticket_num\": \"\",\n \"ControlNum\": \"\",\n \"TaxCity\": \"0.00\",\n \"TaxState\": \"0.00\",\n \"Cust1\": \"\",\n \"Cust1Value\": \"\",\n \"Cust2\": \"\",\n \"Cust2Value\": \"\",\n \"Cust3\": \"\",\n \"Cust3Value\": \"\",\n \"AcntFirst4\": \"4941\"\n },\n \"CVMResult\": 2,\n \"cancelled\": false,\n \"gatewayStatus\": 200,\n \"gatewayStatusText\": \"OK\",\n \"printReceipt\": \"Both\",\n \"paymentType\": \"Credit\",\n \"type\": \"refund\",\n \"registerId\": \"4f1b-f10a\",\n \"registerStatusPort\": \"3594291\",\n \"registerNickname\": \"Tech Area Z8 (3594291)\",\n \"registerSerial\": \"124124\",\n \"registerType\": \"dejavoo\"\n },\n \"total\": 0.01,\n \"method\": \"card\",\n \"pre_auth\": false,\n \"is_captured\": 0,\n \"last_four\": \"5114\",\n \"interchange_code\": \"\",\n \"interchange_fee\": null,\n \"batch_id\": \"\",\n \"batched_at\": \"2018-04-16 19:09:37\",\n \"emv_response\": \"\",\n \"avs_response\": \"\",\n \"cvv_response\": \"\",\n \"pos_entry\": \"\",\n \"pos_salesperson\": \"\",\n \"receipt_email_at\": null,\n \"receipt_sms_at\": null,\n \"created_at\": \"2018-04-16 19:09:37\",\n \"updated_at\": \"2018-04-16 19:09:37\",\n \"total_refunded\": 0,\n \"is_refundable\": false,\n \"is_voided\": false,\n \"is_voidable\": false,\n \"schedule_id\": null,\n \"child_captures\": [],\n \"parent_auth\": null,\n \"customer\": {\n \"id\": \"2a503ed1-99ea-4b35-a30a-605253f7c05a\",\n \"firstname\": \"A\",\n \"lastname\": \"Customer\",\n \"company\": \"\",\n \"email\": \"\",\n \"cc_emails\": [],\n \"cc_sms\": null,\n \"phone\": \"\",\n \"address_1\": \"\",\n \"address_2\": \"\",\n \"address_city\": \"\",\n \"address_state\": \"\",\n \"address_zip\": \"\",\n \"address_country\": \"USA\",\n \"notes\": \"\",\n \"reference\": \"\",\n \"options\": \"\",\n \"created_at\": \"2018-02-23 22:32:19\",\n \"updated_at\": \"2018-02-23 22:32:19\",\n \"deleted_at\": null,\n \"allow_invoice_credit_card_payments\": true,\n \"gravatar\": false\n },\n \"child_transactions\": [],\n \"files\": [],\n \"payment_method\": {\n \"id\": \"bf1aee65-dad9-4b74-8800-a75e435e3e7b\",\n \"customer_id\": \"2a503ed1-99ea-4b35-a30a-605253f7c05a\",\n \"merchant_id\": \"27fad5e4-0210-4c91-9596-417b0ea0dbb1\",\n \"user_id\": \"dbc85118-3309-4129-b966-0108c0fb18a0\",\n \"nickname\": \"VISA: YOU/A GIFT FOR (ending in: 0281)\",\n \"has_cvv\": 0,\n \"is_default\": 1,\n \"method\": \"card\",\n \"person_name\": \"YOU/A GIFT FOR\",\n \"card_type\": \"visa\",\n \"card_last_four\": \"0281\",\n \"card_exp\": \"992099\",\n \"bank_name\": null,\n \"bank_type\": null,\n \"bank_holder_type\": null,\n \"address_1\": null,\n \"address_2\": null,\n \"address_city\": null,\n \"address_state\": null,\n \"address_zip\": \"\",\n \"address_country\": \"\",\n \"purged_at\": null,\n \"deleted_at\": null,\n \"created_at\": \"2018-04-16 19:09:36\",\n \"updated_at\": \"2018-04-16 19:09:36\",\n \"card_exp_datetime\": \"2107-03-31 23:59:59\",\n \"customer\": {\n \"id\": \"2a503ed1-99ea-4b35-a30a-605253f7c05a\",\n \"firstname\": \"A\",\n \"lastname\": \"Customer\",\n \"company\": \"\",\n \"email\": \"\",\n \"cc_emails\": [],\n \"cc_sms\": null,\n \"phone\": \"\",\n \"address_1\": \"\",\n \"address_2\": \"\",\n \"address_city\": \"\",\n \"address_state\": \"\",\n \"address_zip\": \"\",\n \"address_country\": \"USA\",\n \"notes\": \"\",\n \"reference\": \"\",\n \"options\": \"\",\n \"created_at\": \"2018-02-23 22:32:19\",\n \"updated_at\": \"2018-02-23 22:32:19\",\n \"deleted_at\": null,\n \"allow_invoice_credit_card_payments\": true,\n \"gravatar\": false\n }\n },\n \"user\": {\n \"id\": \"dbc85118-3309-4129-b966-0108c0fb18a0\",\n \"system_admin\": true,\n \"name\": \"David Johnson\",\n \"email\": \"demo1@abc.com\",\n \"email_verification_sent_at\": \"2017-05-16 17:35:16\",\n \"email_verified_at\": \"2017-05-16 17:35:33\",\n \"is_api_key\": false,\n \"acknowledgments\": {\n \"tutorial\": true,\n \"godviewWelcome\": true\n },\n \"created_at\": \"2016-05-12 15:57:19\",\n \"updated_at\": \"2018-04-16 18:08:55\",\n \"deleted_at\": null,\n \"gravatar\": \"//www.gravatar.com/avatar/1cd5aef1d36d07e495abb73061f857d4\",\n \"team_admin\": null,\n \"team_enabled\": null,\n \"team_role\": null,\n \"merchant_options\": [],\n \"is_portal\": false\n }\n}" } }, "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "4be11b7e-21cb-4c9e-ba8f-5e173d13d7b7" }, "invoice_id": { "type": "string", "example": "" }, "reference_id": { "type": "string", "example": "5114aea7-5c7f-40ab-8a62-84f239e4b2b1" }, "recurring_transaction_id": { "type": "string", "example": "" }, "auth_id": {}, "type": { "type": "string", "example": "refund" }, "source": { "type": "string", "example": "terminalservice.dejavoo" }, "is_merchant_present": { "type": "boolean", "example": true, "default": true }, "merchant_id": { "type": "string", "example": "27fad5e4-0210-4c91-9596-417b0ea0dbb1" }, "user_id": { "type": "string", "example": "dbc85118-3309-4129-b966-0108c0fb18a0" }, "customer_id": { "type": "string", "example": "2a503ed1-99ea-4b35-a30a-605253f7c05a" }, "payment_method_id": { "type": "string", "example": "bf1aee65-dad9-4b74-8800-a75e435e3e7b" }, "is_manual": { "type": "boolean", "example": true, "default": true }, "success": { "type": "boolean", "example": true, "default": true }, "message": { "type": "string", "example": "" }, "meta": { "type": "object", "properties": { "lineItems": { "type": "array", "items": { "type": "object", "properties": { "item": { "type": "string", "example": "" }, "details": { "type": "string", "example": "" }, "quantity": { "type": "integer", "example": 1, "default": 0 }, "price": { "type": "string", "example": "0.01" } } } }, "subtotal": { "type": "number", "example": 0.01, "default": 0 }, "tax": { "type": "integer", "example": 0, "default": 0 }, "taxRate": { "type": "integer", "example": 10, "default": 0 }, "isBulkInvoice": { "type": "boolean", "example": false, "default": true }, "taxOverride": { "type": "boolean", "example": false, "default": true }, "update_inventory": { "type": "boolean", "example": true, "default": true }, "reference": { "type": "integer", "example": 2477, "default": 0 }, "RegisterId": { "type": "integer", "example": 3594291, "default": 0 }, "ResultCode": { "type": "integer", "example": 0, "default": 0 }, "RespMSG": { "type": "string", "example": "Approved Offline" }, "Message": { "type": "string", "example": "Approved" }, "AuthCode": { "type": "integer", "example": 145599, "default": 0 }, "PNRef": { "type": "integer", "example": 810618212223, "default": 0 }, "PaymentType": { "type": "string", "example": "Credit" }, "TransType": { "type": "string", "example": "Return" }, "SN": { "type": "integer", "example": 118816524647, "default": 0 }, "ExtData": { "type": "object", "properties": { "Amount": { "type": "string", "example": "0.01" }, "InvNum": { "type": "string", "example": "10" }, "CardType": { "type": "string", "example": "VISA" }, "BatchNum": { "type": "string", "example": "56" }, "Tip": { "type": "string", "example": "0.00" }, "CashBack": { "type": "string", "example": "0.00" }, "Fee": { "type": "string", "example": "0.00" }, "AcntLast4": { "type": "string", "example": "0281" }, "Name": { "type": "string", "example": "YOU/A GIFT FOR" }, "SVC": { "type": "string", "example": "0.00" }, "TotalAmt": { "type": "string", "example": "0.01" }, "DISC": { "type": "string", "example": "0.00" }, "Donation": { "type": "string", "example": "0.00" }, "SHFee": { "type": "string", "example": "0.00" }, "RwdPoints": { "type": "string", "example": "0" }, "RwdBalance": { "type": "string", "example": "0" }, "RwdIssued": { "type": "string", "example": "" }, "EBTFSLedgerBalance": { "type": "string", "example": "" }, "EBTFSAvailBalance": { "type": "string", "example": "" }, "EBTFSBeginBalance": { "type": "string", "example": "" }, "EBTCashLedgerBalance": { "type": "string", "example": "" }, "EBTCashAvailBalance": { "type": "string", "example": "" }, "EBTCashBeginBalance": { "type": "string", "example": "" }, "RewardCode": { "type": "string", "example": "" }, "AcqRefData": { "type": "string", "example": "" }, "ProcessData": { "type": "string", "example": "" }, "RefNo": { "type": "string", "example": "" }, "RewardQR": { "type": "string", "example": "" }, "Language": { "type": "string", "example": "English" }, "EntryType": { "type": "string", "example": "Swipe" }, "table_num": { "type": "string", "example": "0" }, "clerk_id": { "type": "string", "example": "" }, "ticket_num": { "type": "string", "example": "" }, "ControlNum": { "type": "string", "example": "" }, "TaxCity": { "type": "string", "example": "0.00" }, "TaxState": { "type": "string", "example": "0.00" }, "Cust1": { "type": "string", "example": "" }, "Cust1Value": { "type": "string", "example": "" }, "Cust2": { "type": "string", "example": "" }, "Cust2Value": { "type": "string", "example": "" }, "Cust3": { "type": "string", "example": "" }, "Cust3Value": { "type": "string", "example": "" }, "AcntFirst4": { "type": "string", "example": "4941" } } }, "CVMResult": { "type": "integer", "example": 2, "default": 0 }, "cancelled": { "type": "boolean", "example": false, "default": true }, "gatewayStatus": { "type": "integer", "example": 200, "default": 0 }, "gatewayStatusText": { "type": "string", "example": "OK" }, "printReceipt": { "type": "string", "example": "Both" }, "paymentType": { "type": "string", "example": "Credit" }, "type": { "type": "string", "example": "refund" }, "registerId": { "type": "string", "example": "4f1b-f10a" }, "registerStatusPort": { "type": "string", "example": "3594291" }, "registerNickname": { "type": "string", "example": "Tech Area Z8 (3594291)" }, "registerSerial": { "type": "string", "example": "124124" }, "registerType": { "type": "string", "example": "dejavoo" } } }, "total": { "type": "number", "example": 0.01, "default": 0 }, "method": { "type": "string", "example": "card" }, "pre_auth": { "type": "boolean", "example": false, "default": true }, "is_captured": { "type": "integer", "example": 0, "default": 0 }, "last_four": { "type": "string", "example": "5114" }, "interchange_code": { "type": "string", "example": "" }, "interchange_fee": {}, "batch_id": { "type": "string", "example": "" }, "batched_at": { "type": "string", "example": "2018-04-16 19:09:37" }, "emv_response": { "type": "string", "example": "" }, "avs_response": { "type": "string", "example": "" }, "cvv_response": { "type": "string", "example": "" }, "pos_entry": { "type": "string", "example": "" }, "pos_salesperson": { "type": "string", "example": "" }, "receipt_email_at": {}, "receipt_sms_at": {}, "created_at": { "type": "string", "example": "2018-04-16 19:09:37" }, "updated_at": { "type": "string", "example": "2018-04-16 19:09:37" }, "total_refunded": { "type": "integer", "example": 0, "default": 0 }, "is_refundable": { "type": "boolean", "example": false, "default": true }, "is_voided": { "type": "boolean", "example": false, "default": true }, "is_voidable": { "type": "boolean", "example": false, "default": true }, "schedule_id": {}, "child_captures": { "type": "array" }, "parent_auth": {}, "customer": { "type": "object", "properties": { "id": { "type": "string", "example": "2a503ed1-99ea-4b35-a30a-605253f7c05a" }, "firstname": { "type": "string", "example": "A" }, "lastname": { "type": "string", "example": "Customer" }, "company": { "type": "string", "example": "" }, "email": { "type": "string", "example": "" }, "cc_emails": { "type": "array" }, "cc_sms": {}, "phone": { "type": "string", "example": "" }, "address_1": { "type": "string", "example": "" }, "address_2": { "type": "string", "example": "" }, "address_city": { "type": "string", "example": "" }, "address_state": { "type": "string", "example": "" }, "address_zip": { "type": "string", "example": "" }, "address_country": { "type": "string", "example": "USA" }, "notes": { "type": "string", "example": "" }, "reference": { "type": "string", "example": "" }, "options": { "type": "string", "example": "" }, "created_at": { "type": "string", "example": "2018-02-23 22:32:19" }, "updated_at": { "type": "string", "example": "2018-02-23 22:32:19" }, "deleted_at": {}, "allow_invoice_credit_card_payments": { "type": "boolean", "example": true, "default": true }, "gravatar": { "type": "boolean", "example": false, "default": true } } }, "child_transactions": { "type": "array" }, "files": { "type": "array" }, "payment_method": { "type": "object", "properties": { "id": { "type": "string", "example": "bf1aee65-dad9-4b74-8800-a75e435e3e7b" }, "customer_id": { "type": "string", "example": "2a503ed1-99ea-4b35-a30a-605253f7c05a" }, "merchant_id": { "type": "string", "example": "27fad5e4-0210-4c91-9596-417b0ea0dbb1" }, "user_id": { "type": "string", "example": "dbc85118-3309-4129-b966-0108c0fb18a0" }, "nickname": { "type": "string", "example": "VISA: YOU/A GIFT FOR (ending in: 0281)" }, "has_cvv": { "type": "integer", "example": 0, "default": 0 }, "is_default": { "type": "integer", "example": 1, "default": 0 }, "method": { "type": "string", "example": "card" }, "person_name": { "type": "string", "example": "YOU/A GIFT FOR" }, "card_type": { "type": "string", "example": "visa" }, "card_last_four": { "type": "string", "example": "0281" }, "card_exp": { "type": "string", "example": "992099" }, "bank_name": {}, "bank_type": {}, "bank_holder_type": {}, "address_1": {}, "address_2": {}, "address_city": {}, "address_state": {}, "address_zip": { "type": "string", "example": "" }, "address_country": { "type": "string", "example": "" }, "purged_at": {}, "deleted_at": {}, "created_at": { "type": "string", "example": "2018-04-16 19:09:36" }, "updated_at": { "type": "string", "example": "2018-04-16 19:09:36" }, "card_exp_datetime": { "type": "string", "example": "2107-03-31 23:59:59" }, "customer": { "type": "object", "properties": { "id": { "type": "string", "example": "2a503ed1-99ea-4b35-a30a-605253f7c05a" }, "firstname": { "type": "string", "example": "A" }, "lastname": { "type": "string", "example": "Customer" }, "company": { "type": "string", "example": "" }, "email": { "type": "string", "example": "" }, "cc_emails": { "type": "array" }, "cc_sms": {}, "phone": { "type": "string", "example": "" }, "address_1": { "type": "string", "example": "" }, "address_2": { "type": "string", "example": "" }, "address_city": { "type": "string", "example": "" }, "address_state": { "type": "string", "example": "" }, "address_zip": { "type": "string", "example": "" }, "address_country": { "type": "string", "example": "USA" }, "notes": { "type": "string", "example": "" }, "reference": { "type": "string", "example": "" }, "options": { "type": "string", "example": "" }, "created_at": { "type": "string", "example": "2018-02-23 22:32:19" }, "updated_at": { "type": "string", "example": "2018-02-23 22:32:19" }, "deleted_at": {}, "allow_invoice_credit_card_payments": { "type": "boolean", "example": true, "default": true }, "gravatar": { "type": "boolean", "example": false, "default": true } } } } }, "user": { "type": "object", "properties": { "id": { "type": "string", "example": "dbc85118-3309-4129-b966-0108c0fb18a0" }, "system_admin": { "type": "boolean", "example": true, "default": true }, "name": { "type": "string", "example": "David Johnson" }, "email": { "type": "string", "example": "demo1@abc.com" }, "email_verification_sent_at": { "type": "string", "example": "2017-05-16 17:35:16" }, "email_verified_at": { "type": "string", "example": "2017-05-16 17:35:33" }, "is_api_key": { "type": "boolean", "example": false, "default": true }, "acknowledgments": { "type": "object", "properties": { "tutorial": { "type": "boolean", "example": true, "default": true }, "godviewWelcome": { "type": "boolean", "example": true, "default": true } } }, "created_at": { "type": "string", "example": "2016-05-12 15:57:19" }, "updated_at": { "type": "string", "example": "2018-04-16 18:08:55" }, "deleted_at": {}, "gravatar": { "type": "string", "example": "//www.gravatar.com/avatar/1cd5aef1d36d07e495abb73061f857d4" }, "team_admin": {}, "team_enabled": {}, "team_role": {}, "merchant_options": { "type": "array" }, "is_portal": { "type": "boolean", "example": false, "default": true } } } } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"success\": false,\n \"message\": \"User Cancelled\",\n \"gatewayStatus\": 200,\n \"gatewayStatusText\": \"OK\",\n \"cancelled\": true,\n \"status\": 400\n}" } }, "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false, "default": true }, "message": { "type": "string", "example": "User Cancelled" }, "gatewayStatus": { "type": "integer", "example": 200, "default": 0 }, "gatewayStatusText": { "type": "string", "example": "OK" }, "cancelled": { "type": "boolean", "example": true, "default": true }, "status": { "type": "integer", "example": 400, "default": 0 } } } } } }, "422": { "description": "422", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"validation\": \"register not found\",\n \"status\": 422,\n \"message\": \"Validation Error\"\n}" } }, "schema": { "type": "object", "properties": { "validation": { "type": "string", "example": "register not found" }, "status": { "type": "integer", "example": 422, "default": 0 }, "message": { "type": "string", "example": "Validation Error" } } } } } } }, "deprecated": false, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "number", "description": "(Min: 0.01) Limits the amount that can be voided or refunded. If total is not present, then the full transaction amount will be reversed.", "format": "float" }, "meta": { "type": "string", "format": "json", "description": "i.e. {\"tax\":2,\"subtotal\":10} can contain any json objectwill be blindly stored and returned during a GET operation.values in meta may also appear in an email receipt if the template calls for it.the Stax front-end uses subtotal, tax, memo, lineItems = []." }, "printReceipt": { "type": "string", "enum": [ "Both", "Merchant", "Customer", "No" ], "description": "Possible values: No, Merchant, Customer, Both. Defaults to Both.", "default": "Both" }, "paymentType": { "type": "string", "enum": [ "Credit", "Debit", "Check", "Gift", "Loyalty" ], "description": "Possible values: Credit, Debit, Check, Gift, Loyalty. Defaults to Credit.", "default": "Credit" }, "transactionId": { "type": "string", "required": true, "description": "The id of the transaction being voided or refunded. This endpoint will automatically determine whether to void or refund based on batch timing (typically 8pm EST). Before batch settlement, a void will be executed; after settlement, a refund will be executed." }, "register": { "type": "string", "description": "The id of the register performing this operation. This should be the 'id' value returned by GET /terminal/register. For refunds, register is optional as the card will be present. For voids, register is optional but if provided must match the register used for the original transaction." } }, "required": [ "register", "total", "transactionId" ] } } } } } }, "/transaction/{id}/void": { "post": { "summary": "Void Transaction", "description": "Sets a transaction to void, ending the transaction before it's processed.", "operationId": "void-transaction", "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"id\": \"ba9bf00c-c54d-48f8-8400-902cb3aacd21\",\n \"invoice_id\": \"\",\n \"reference_id\": \"\",\n \"recurring_transaction_id\": \"\",\n \"type\": \"charge\",\n \"source\": null,\n \"merchant_id\": \"dd36b936-1eb7-4ece-bebc-b514c6a36ebd\",\n \"user_id\": \"41e60252-4f23-48de-a64f-e5a1e8a9359c\",\n \"customer_id\": \"d45ee88c-8b27-4be8-8d81-77dda1b81826\",\n \"payment_method_id\": \"129520d1-3844-45fd-a0b1-afb66bcdc74c\",\n \"is_manual\": null,\n \"success\": true,\n \"message\": null,\n \"meta\": {\n \"tax\": 2,\n \"subtotal\": 10\n },\n \"total\": 1,\n \"method\": \"card\",\n \"pre_auth\": false,\n \"last_four\": \"1111\",\n \"receipt_email_at\": \"2017-05-19 14:40:31\",\n \"receipt_sms_at\": null,\n \"created_at\": \"2017-05-19 13:50:44\",\n \"updated_at\": \"2017-05-19 14:40:31\",\n \"total_refunded\": null,\n \"is_refundable\": false,\n \"is_voided\": true,\n \"is_voidable\": false,\n \"schedule_id\": null,\n \"customer\": {\n \"id\": \"d45ee88c-8b27-4be8-8d81-77dda1b81826\",\n \"firstname\": \"John\",\n \"lastname\": \"Smith\",\n \"company\": \"ABC INC\",\n \"email\": \"demo@abc.com\",\n \"cc_emails\": [\n \"demo1@abc.com\",\n \"demo2@abc.com\"\n ],\n \"phone\": \"1234567898\",\n \"address_1\": \"123 Rite Way\",\n \"address_2\": \"Unit 12\",\n \"address_city\": \"Orlando\",\n \"address_state\": \"FL\",\n \"address_zip\": \"32801\",\n \"address_country\": \"USA\",\n \"notes\": null,\n \"reference\": \"BARTLE\",\n \"options\": \"\",\n \"created_at\": \"2017-05-08 19:22:51\",\n \"updated_at\": \"2017-05-08 19:23:46\",\n \"deleted_at\": null,\n \"gravatar\": \"//www.gravatar.com/avatar/fe3e929dd80f1653c3a4b82812660061\"\n },\n \"child_transactions\": [\n {\n \"id\": \"04497525-565c-4169-bb6d-5a4df399d255\",\n \"invoice_id\": \"\",\n \"reference_id\": \"ba9bf00c-c54d-48f8-8400-902cb3aacd21\",\n \"recurring_transaction_id\": \"\",\n \"type\": \"void\",\n \"source\": null,\n \"merchant_id\": \"dd36b936-1eb7-4ece-bebc-b514c6a36ebd\",\n \"user_id\": \"41e60252-4f23-48de-a64f-e5a1e8a9359c\",\n \"customer_id\": \"d45ee88c-8b27-4be8-8d81-77dda1b81826\",\n \"payment_method_id\": \"129520d1-3844-45fd-a0b1-afb66bcdc74c\",\n \"is_manual\": null,\n \"success\": true,\n \"message\": null,\n \"meta\": {\n \"tax\": 2,\n \"subtotal\": 10\n },\n \"total\": 1,\n \"method\": \"card\",\n \"pre_auth\": false,\n \"last_four\": \"1111\",\n \"receipt_email_at\": null,\n \"receipt_sms_at\": null,\n \"created_at\": \"2017-05-19 15:11:32\",\n \"updated_at\": \"2017-05-19 15:11:32\",\n \"total_refunded\": null,\n \"is_refundable\": false,\n \"is_voided\": null,\n \"is_voidable\": false,\n \"schedule_id\": null,\n \"customer\": {\n \"id\": \"d45ee88c-8b27-4be8-8d81-77dda1b81826\",\n \"firstname\": \"John\",\n \"lastname\": \"Smith\",\n \"company\": \"ABC INC\",\n \"email\": \"demo@abc.com\",\n \"cc_emails\": [\n \"demo1@abc.com\",\n \"demo2@abc.com\"\n ],\n \"phone\": \"1234567898\",\n \"address_1\": \"123 Rite Way\",\n \"address_2\": \"Unit 12\",\n \"address_city\": \"Orlando\",\n \"address_state\": \"FL\",\n \"address_zip\": \"32801\",\n \"address_country\": \"USA\",\n \"notes\": null,\n \"reference\": \"BARTLE\",\n \"options\": \"\",\n \"created_at\": \"2017-05-08 19:22:51\",\n \"updated_at\": \"2017-05-08 19:23:46\",\n \"deleted_at\": null,\n \"gravatar\": \"//www.gravatar.com/avatar/fe3e929dd80f1653c3a4b82812660061\"\n },\n \"child_transactions\": [],\n \"files\": [],\n \"payment_method\": {\n \"id\": \"129520d1-3844-45fd-a0b1-afb66bcdc74c\",\n \"customer_id\": \"d45ee88c-8b27-4be8-8d81-77dda1b81826\",\n \"merchant_id\": \"dd36b936-1eb7-4ece-bebc-b514c6a36ebd\",\n \"user_id\": \"41e60252-4f23-48de-a64f-e5a1e8a9359c\",\n \"nickname\": \"VISA: Steven Smith Jr. (ending in: 1111)\",\n \"is_default\": 1,\n \"method\": \"card\",\n \"person_name\": \"Steven Smith Jr.\",\n \"card_type\": \"visa\",\n \"card_last_four\": \"1111\",\n \"card_exp\": \"042019\",\n \"bank_name\": null,\n \"bank_type\": null,\n \"bank_holder_type\": null,\n \"address_1\": null,\n \"address_2\": null,\n \"address_city\": null,\n \"address_state\": null,\n \"address_zip\": \"32944\",\n \"address_country\": \"USA\",\n \"purged_at\": null,\n \"deleted_at\": null,\n \"created_at\": \"2017-05-17 19:56:59\",\n \"updated_at\": \"2017-05-17 19:56:59\",\n \"card_exp_datetime\": \"2019-04-30 23:59:59\",\n \"customer\": {\n \"id\": \"d45ee88c-8b27-4be8-8d81-77dda1b81826\",\n \"firstname\": \"John\",\n \"lastname\": \"Smith\",\n \"company\": \"ABC INC\",\n \"email\": \"demo@abc.com\",\n \"cc_emails\": [\n \"demo1@abc.com\",\n \"demo2@abc.com\"\n ],\n \"phone\": \"1234567898\",\n \"address_1\": \"123 Rite Way\",\n \"address_2\": \"Unit 12\",\n \"address_city\": \"Orlando\",\n \"address_state\": \"FL\",\n \"address_zip\": \"32801\",\n \"address_country\": \"USA\",\n \"notes\": null,\n \"reference\": \"BARTLE\",\n \"options\": \"\",\n \"created_at\": \"2017-05-08 19:22:51\",\n \"updated_at\": \"2017-05-08 19:23:46\",\n \"deleted_at\": null,\n \"gravatar\": \"//www.gravatar.com/avatar/fe3e929dd80f1653c3a4b82812660061\"\n }\n },\n \"user\": {\n \"id\": \"41e60252-4f23-48de-a64f-e5a1e8a9359c\",\n \"system_admin\": true,\n \"name\": \"Benji\",\n \"email\": \"contact@example.com\",\n \"email_verification_sent_at\": \"2016-12-01 16:18:46\",\n \"email_verified_at\": \"2016-12-01 16:18:46\",\n \"is_api_key\": false,\n \"created_at\": \"2016-12-01 16:18:46\",\n \"updated_at\": \"2017-01-27 20:10:53\",\n \"deleted_at\": null,\n \"gravatar\": \"//www.gravatar.com/avatar/772cbf95746d7da86789cc3634c46ba8\",\n \"team_admin\": null,\n \"team_enabled\": null,\n \"team_role\": null,\n \"merchant_options\": [],\n \"is_portal\": false\n }\n }\n ],\n \"files\": [],\n \"payment_method\": {\n \"id\": \"129520d1-3844-45fd-a0b1-afb66bcdc74c\",\n \"customer_id\": \"d45ee88c-8b27-4be8-8d81-77dda1b81826\",\n \"merchant_id\": \"dd36b936-1eb7-4ece-bebc-b514c6a36ebd\",\n \"user_id\": \"41e60252-4f23-48de-a64f-e5a1e8a9359c\",\n \"nickname\": \"VISA: Steven Smith Jr. (ending in: 1111)\",\n \"is_default\": 1,\n \"method\": \"card\",\n \"person_name\": \"Steven Smith Jr.\",\n \"card_type\": \"visa\",\n \"card_last_four\": \"1111\",\n \"card_exp\": \"042019\",\n \"bank_name\": null,\n \"bank_type\": null,\n \"bank_holder_type\": null,\n \"address_1\": null,\n \"address_2\": null,\n \"address_city\": null,\n \"address_state\": null,\n \"address_zip\": \"32944\",\n \"address_country\": \"USA\",\n \"purged_at\": null,\n \"deleted_at\": null,\n \"created_at\": \"2017-05-17 19:56:59\",\n \"updated_at\": \"2017-05-17 19:56:59\",\n \"card_exp_datetime\": \"2019-04-30 23:59:59\",\n \"customer\": {\n \"id\": \"d45ee88c-8b27-4be8-8d81-77dda1b81826\",\n \"firstname\": \"John\",\n \"lastname\": \"Smith\",\n \"company\": \"ABC INC\",\n \"email\": \"demo@abc.com\",\n \"cc_emails\": [\n \"demo1@abc.com\",\n \"demo2@abc.com\"\n ],\n \"phone\": \"1234567898\",\n \"address_1\": \"123 Rite Way\",\n \"address_2\": \"Unit 12\",\n \"address_city\": \"Orlando\",\n \"address_state\": \"FL\",\n \"address_zip\": \"32801\",\n \"address_country\": \"USA\",\n \"notes\": null,\n \"reference\": \"BARTLE\",\n \"options\": \"\",\n \"created_at\": \"2017-05-08 19:22:51\",\n \"updated_at\": \"2017-05-08 19:23:46\",\n \"deleted_at\": null,\n \"gravatar\": \"//www.gravatar.com/avatar/fe3e929dd80f1653c3a4b82812660061\"\n }\n },\n \"user\": {\n \"id\": \"41e60252-4f23-48de-a64f-e5a1e8a9359c\",\n \"system_admin\": true,\n \"name\": \"Benji\",\n \"email\": \"contact@example.com\",\n \"email_verification_sent_at\": \"2016-12-01 16:18:46\",\n \"email_verified_at\": \"2016-12-01 16:18:46\",\n \"is_api_key\": false,\n \"created_at\": \"2016-12-01 16:18:46\",\n \"updated_at\": \"2017-01-27 20:10:53\",\n \"deleted_at\": null,\n \"gravatar\": \"//www.gravatar.com/avatar/772cbf95746d7da86789cc3634c46ba8\",\n \"team_admin\": null,\n \"team_enabled\": null,\n \"team_role\": null,\n \"merchant_options\": [],\n \"is_portal\": false\n }\n}" } }, "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "ba9bf00c-c54d-48f8-8400-902cb3aacd21" }, "invoice_id": { "type": "string", "example": "" }, "reference_id": { "type": "string", "example": "" }, "recurring_transaction_id": { "type": "string", "example": "" }, "type": { "type": "string", "example": "charge" }, "source": {}, "merchant_id": { "type": "string", "example": "dd36b936-1eb7-4ece-bebc-b514c6a36ebd" }, "user_id": { "type": "string", "example": "41e60252-4f23-48de-a64f-e5a1e8a9359c" }, "customer_id": { "type": "string", "example": "d45ee88c-8b27-4be8-8d81-77dda1b81826" }, "payment_method_id": { "type": "string", "example": "129520d1-3844-45fd-a0b1-afb66bcdc74c" }, "is_manual": {}, "success": { "type": "boolean", "example": true, "default": true }, "message": {}, "meta": { "type": "object", "properties": { "tax": { "type": "integer", "example": 2, "default": 0 }, "subtotal": { "type": "integer", "example": 10, "default": 0 } } }, "total": { "type": "integer", "example": 1, "default": 0 }, "method": { "type": "string", "example": "card" }, "pre_auth": { "type": "boolean", "example": false, "default": true }, "last_four": { "type": "string", "example": "1111" }, "receipt_email_at": { "type": "string", "example": "2017-05-19 14:40:31" }, "receipt_sms_at": {}, "created_at": { "type": "string", "example": "2017-05-19 13:50:44" }, "updated_at": { "type": "string", "example": "2017-05-19 14:40:31" }, "total_refunded": {}, "is_refundable": { "type": "boolean", "example": false, "default": true }, "is_voided": { "type": "boolean", "example": true, "default": true }, "is_voidable": { "type": "boolean", "example": false, "default": true }, "schedule_id": {}, "customer": { "type": "object", "properties": { "id": { "type": "string", "example": "d45ee88c-8b27-4be8-8d81-77dda1b81826" }, "firstname": { "type": "string", "example": "John" }, "lastname": { "type": "string", "example": "Smith" }, "company": { "type": "string", "example": "ABC INC" }, "email": { "type": "string", "example": "demo@abc.com" }, "cc_emails": { "type": "array", "items": { "type": "string", "example": "demo1@abc.com" } }, "phone": { "type": "string", "example": "1234567898" }, "address_1": { "type": "string", "example": "123 Rite Way" }, "address_2": { "type": "string", "example": "Unit 12" }, "address_city": { "type": "string", "example": "Orlando" }, "address_state": { "type": "string", "example": "FL" }, "address_zip": { "type": "string", "example": "32801" }, "address_country": { "type": "string", "example": "USA" }, "notes": {}, "reference": { "type": "string", "example": "BARTLE" }, "options": { "type": "string", "example": "" }, "created_at": { "type": "string", "example": "2017-05-08 19:22:51" }, "updated_at": { "type": "string", "example": "2017-05-08 19:23:46" }, "deleted_at": {}, "gravatar": { "type": "string", "example": "//www.gravatar.com/avatar/fe3e929dd80f1653c3a4b82812660061" } } }, "child_transactions": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "04497525-565c-4169-bb6d-5a4df399d255" }, "invoice_id": { "type": "string", "example": "" }, "reference_id": { "type": "string", "example": "ba9bf00c-c54d-48f8-8400-902cb3aacd21" }, "recurring_transaction_id": { "type": "string", "example": "" }, "type": { "type": "string", "example": "void" }, "source": {}, "merchant_id": { "type": "string", "example": "dd36b936-1eb7-4ece-bebc-b514c6a36ebd" }, "user_id": { "type": "string", "example": "41e60252-4f23-48de-a64f-e5a1e8a9359c" }, "customer_id": { "type": "string", "example": "d45ee88c-8b27-4be8-8d81-77dda1b81826" }, "payment_method_id": { "type": "string", "example": "129520d1-3844-45fd-a0b1-afb66bcdc74c" }, "is_manual": {}, "success": { "type": "boolean", "example": true, "default": true }, "message": {}, "meta": { "type": "object", "properties": { "tax": { "type": "integer", "example": 2, "default": 0 }, "subtotal": { "type": "integer", "example": 10, "default": 0 } } }, "total": { "type": "integer", "example": 1, "default": 0 }, "method": { "type": "string", "example": "card" }, "pre_auth": { "type": "boolean", "example": false, "default": true }, "last_four": { "type": "string", "example": "1111" }, "receipt_email_at": {}, "receipt_sms_at": {}, "created_at": { "type": "string", "example": "2017-05-19 15:11:32" }, "updated_at": { "type": "string", "example": "2017-05-19 15:11:32" }, "total_refunded": {}, "is_refundable": { "type": "boolean", "example": false, "default": true }, "is_voided": {}, "is_voidable": { "type": "boolean", "example": false, "default": true }, "schedule_id": {}, "customer": { "type": "object", "properties": { "id": { "type": "string", "example": "d45ee88c-8b27-4be8-8d81-77dda1b81826" }, "firstname": { "type": "string", "example": "John" }, "lastname": { "type": "string", "example": "Smith" }, "company": { "type": "string", "example": "ABC INC" }, "email": { "type": "string", "example": "demo@abc.com" }, "cc_emails": { "type": "array", "items": { "type": "string", "example": "demo1@abc.com" } }, "phone": { "type": "string", "example": "1234567898" }, "address_1": { "type": "string", "example": "123 Rite Way" }, "address_2": { "type": "string", "example": "Unit 12" }, "address_city": { "type": "string", "example": "Orlando" }, "address_state": { "type": "string", "example": "FL" }, "address_zip": { "type": "string", "example": "32801" }, "address_country": { "type": "string", "example": "USA" }, "notes": {}, "reference": { "type": "string", "example": "BARTLE" }, "options": { "type": "string", "example": "" }, "created_at": { "type": "string", "example": "2017-05-08 19:22:51" }, "updated_at": { "type": "string", "example": "2017-05-08 19:23:46" }, "deleted_at": {}, "gravatar": { "type": "string", "example": "//www.gravatar.com/avatar/fe3e929dd80f1653c3a4b82812660061" } } }, "child_transactions": { "type": "array" }, "files": { "type": "array" }, "payment_method": { "type": "object", "properties": { "id": { "type": "string", "example": "129520d1-3844-45fd-a0b1-afb66bcdc74c" }, "customer_id": { "type": "string", "example": "d45ee88c-8b27-4be8-8d81-77dda1b81826" }, "merchant_id": { "type": "string", "example": "dd36b936-1eb7-4ece-bebc-b514c6a36ebd" }, "user_id": { "type": "string", "example": "41e60252-4f23-48de-a64f-e5a1e8a9359c" }, "nickname": { "type": "string", "example": "VISA: Steven Smith Jr. (ending in: 1111)" }, "is_default": { "type": "integer", "example": 1, "default": 0 }, "method": { "type": "string", "example": "card" }, "person_name": { "type": "string", "example": "Steven Smith Jr." }, "card_type": { "type": "string", "example": "visa" }, "card_last_four": { "type": "string", "example": "1111" }, "card_exp": { "type": "string", "example": "042019" }, "bank_name": {}, "bank_type": {}, "bank_holder_type": {}, "address_1": {}, "address_2": {}, "address_city": {}, "address_state": {}, "address_zip": { "type": "string", "example": "32944" }, "address_country": { "type": "string", "example": "USA" }, "purged_at": {}, "deleted_at": {}, "created_at": { "type": "string", "example": "2017-05-17 19:56:59" }, "updated_at": { "type": "string", "example": "2017-05-17 19:56:59" }, "card_exp_datetime": { "type": "string", "example": "2019-04-30 23:59:59" }, "customer": { "type": "object", "properties": { "id": { "type": "string", "example": "d45ee88c-8b27-4be8-8d81-77dda1b81826" }, "firstname": { "type": "string", "example": "John" }, "lastname": { "type": "string", "example": "Smith" }, "company": { "type": "string", "example": "ABC INC" }, "email": { "type": "string", "example": "demo@abc.com" }, "cc_emails": { "type": "array", "items": { "type": "string", "example": "demo1@abc.com" } }, "phone": { "type": "string", "example": "1234567898" }, "address_1": { "type": "string", "example": "123 Rite Way" }, "address_2": { "type": "string", "example": "Unit 12" }, "address_city": { "type": "string", "example": "Orlando" }, "address_state": { "type": "string", "example": "FL" }, "address_zip": { "type": "string", "example": "32801" }, "address_country": { "type": "string", "example": "USA" }, "notes": {}, "reference": { "type": "string", "example": "BARTLE" }, "options": { "type": "string", "example": "" }, "created_at": { "type": "string", "example": "2017-05-08 19:22:51" }, "updated_at": { "type": "string", "example": "2017-05-08 19:23:46" }, "deleted_at": {}, "gravatar": { "type": "string", "example": "//www.gravatar.com/avatar/fe3e929dd80f1653c3a4b82812660061" } } } } }, "user": { "type": "object", "properties": { "id": { "type": "string", "example": "41e60252-4f23-48de-a64f-e5a1e8a9359c" }, "system_admin": { "type": "boolean", "example": true, "default": true }, "name": { "type": "string", "example": "Benji" }, "email": { "type": "string", "example": "contact@example.com" }, "email_verification_sent_at": { "type": "string", "example": "2016-12-01 16:18:46" }, "email_verified_at": { "type": "string", "example": "2016-12-01 16:18:46" }, "is_api_key": { "type": "boolean", "example": false, "default": true }, "created_at": { "type": "string", "example": "2016-12-01 16:18:46" }, "updated_at": { "type": "string", "example": "2017-01-27 20:10:53" }, "deleted_at": {}, "gravatar": { "type": "string", "example": "//www.gravatar.com/avatar/772cbf95746d7da86789cc3634c46ba8" }, "team_admin": {}, "team_enabled": {}, "team_role": {}, "merchant_options": { "type": "array" }, "is_portal": { "type": "boolean", "example": false, "default": true } } } } } }, "files": { "type": "array" }, "payment_method": { "type": "object", "properties": { "id": { "type": "string", "example": "129520d1-3844-45fd-a0b1-afb66bcdc74c" }, "customer_id": { "type": "string", "example": "d45ee88c-8b27-4be8-8d81-77dda1b81826" }, "merchant_id": { "type": "string", "example": "dd36b936-1eb7-4ece-bebc-b514c6a36ebd" }, "user_id": { "type": "string", "example": "41e60252-4f23-48de-a64f-e5a1e8a9359c" }, "nickname": { "type": "string", "example": "VISA: Steven Smith Jr. (ending in: 1111)" }, "is_default": { "type": "integer", "example": 1, "default": 0 }, "method": { "type": "string", "example": "card" }, "person_name": { "type": "string", "example": "Steven Smith Jr." }, "card_type": { "type": "string", "example": "visa" }, "card_last_four": { "type": "string", "example": "1111" }, "card_exp": { "type": "string", "example": "042019" }, "bank_name": {}, "bank_type": {}, "bank_holder_type": {}, "address_1": {}, "address_2": {}, "address_city": {}, "address_state": {}, "address_zip": { "type": "string", "example": "32944" }, "address_country": { "type": "string", "example": "USA" }, "purged_at": {}, "deleted_at": {}, "created_at": { "type": "string", "example": "2017-05-17 19:56:59" }, "updated_at": { "type": "string", "example": "2017-05-17 19:56:59" }, "card_exp_datetime": { "type": "string", "example": "2019-04-30 23:59:59" }, "customer": { "type": "object", "properties": { "id": { "type": "string", "example": "d45ee88c-8b27-4be8-8d81-77dda1b81826" }, "firstname": { "type": "string", "example": "John" }, "lastname": { "type": "string", "example": "Smith" }, "company": { "type": "string", "example": "ABC INC" }, "email": { "type": "string", "example": "demo@abc.com" }, "cc_emails": { "type": "array", "items": { "type": "string", "example": "demo1@abc.com" } }, "phone": { "type": "string", "example": "1234567898" }, "address_1": { "type": "string", "example": "123 Rite Way" }, "address_2": { "type": "string", "example": "Unit 12" }, "address_city": { "type": "string", "example": "Orlando" }, "address_state": { "type": "string", "example": "FL" }, "address_zip": { "type": "string", "example": "32801" }, "address_country": { "type": "string", "example": "USA" }, "notes": {}, "reference": { "type": "string", "example": "BARTLE" }, "options": { "type": "string", "example": "" }, "created_at": { "type": "string", "example": "2017-05-08 19:22:51" }, "updated_at": { "type": "string", "example": "2017-05-08 19:23:46" }, "deleted_at": {}, "gravatar": { "type": "string", "example": "//www.gravatar.com/avatar/fe3e929dd80f1653c3a4b82812660061" } } } } }, "user": { "type": "object", "properties": { "id": { "type": "string", "example": "41e60252-4f23-48de-a64f-e5a1e8a9359c" }, "system_admin": { "type": "boolean", "example": true, "default": true }, "name": { "type": "string", "example": "Benji" }, "email": { "type": "string", "example": "contact@example.com" }, "email_verification_sent_at": { "type": "string", "example": "2016-12-01 16:18:46" }, "email_verified_at": { "type": "string", "example": "2016-12-01 16:18:46" }, "is_api_key": { "type": "boolean", "example": false, "default": true }, "created_at": { "type": "string", "example": "2016-12-01 16:18:46" }, "updated_at": { "type": "string", "example": "2017-01-27 20:10:53" }, "deleted_at": {}, "gravatar": { "type": "string", "example": "//www.gravatar.com/avatar/772cbf95746d7da86789cc3634c46ba8" }, "team_admin": {}, "team_enabled": {}, "team_role": {}, "merchant_options": { "type": "array" }, "is_portal": { "type": "boolean", "example": false, "default": true } } } } } } } }, "422": { "description": "422", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"total\": [\n \"The transaction has already been voided.\"\n ]\n}" } }, "schema": { "type": "object", "properties": { "total": { "type": "array", "items": { "type": "string", "example": "The transaction has already been voided." } } } } } } } }, "deprecated": false } }, "/terminal/void": { "post": { "summary": "Void", "description": "Voids a card-present transaction that has not yet batched (open batch reversal).", "operationId": "void", "parameters": [], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"id\": \"4be11b7e-21cb-4c9e-ba8f-5e173d13d7b7\",\n \"invoice_id\": \"\",\n \"reference_id\": \"5114aea7-5c7f-40ab-8a62-84f239e4b2b1\",\n \"recurring_transaction_id\": \"\",\n \"auth_id\": null,\n \"type\": \"refund\",\n \"source\": \"terminalservice.dejavoo\",\n \"is_merchant_present\": true,\n \"merchant_id\": \"27fad5e4-0210-4c91-9596-417b0ea0dbb1\",\n \"user_id\": \"dbc85118-3309-4129-b966-0108c0fb18a0\",\n \"customer_id\": \"2a503ed1-99ea-4b35-a30a-605253f7c05a\",\n \"payment_method_id\": \"bf1aee65-dad9-4b74-8800-a75e435e3e7b\",\n \"is_manual\": true,\n \"success\": true,\n \"message\": \"\",\n \"meta\": {\n \"lineItems\": [\n {\n \"item\": \"\",\n \"details\": \"\",\n \"quantity\": 1,\n \"price\": \"0.01\"\n }\n ],\n \"subtotal\": 0.01,\n \"tax\": 0,\n \"taxRate\": 10,\n \"isBulkInvoice\": false,\n \"taxOverride\": false,\n \"update_inventory\": true,\n \"reference\": 2477,\n \"RegisterId\": 3594291,\n \"ResultCode\": 0,\n \"RespMSG\": \"Approved Offline\",\n \"Message\": \"Approved\",\n \"AuthCode\": 145599,\n \"PNRef\": 810618212223,\n \"PaymentType\": \"Credit\",\n \"TransType\": \"Return\",\n \"SN\": 118816524647,\n \"ExtData\": {\n \"Amount\": \"0.01\",\n \"InvNum\": \"10\",\n \"CardType\": \"VISA\",\n \"BatchNum\": \"56\",\n \"Tip\": \"0.00\",\n \"CashBack\": \"0.00\",\n \"Fee\": \"0.00\",\n \"AcntLast4\": \"0281\",\n \"Name\": \"YOU/A GIFT FOR\",\n \"SVC\": \"0.00\",\n \"TotalAmt\": \"0.01\",\n \"DISC\": \"0.00\",\n \"Donation\": \"0.00\",\n \"SHFee\": \"0.00\",\n \"RwdPoints\": \"0\",\n \"RwdBalance\": \"0\",\n \"RwdIssued\": \"\",\n \"EBTFSLedgerBalance\": \"\",\n \"EBTFSAvailBalance\": \"\",\n \"EBTFSBeginBalance\": \"\",\n \"EBTCashLedgerBalance\": \"\",\n \"EBTCashAvailBalance\": \"\",\n \"EBTCashBeginBalance\": \"\",\n \"RewardCode\": \"\",\n \"AcqRefData\": \"\",\n \"ProcessData\": \"\",\n \"RefNo\": \"\",\n \"RewardQR\": \"\",\n \"Language\": \"English\",\n \"EntryType\": \"Swipe\",\n \"table_num\": \"0\",\n \"clerk_id\": \"\",\n \"ticket_num\": \"\",\n \"ControlNum\": \"\",\n \"TaxCity\": \"0.00\",\n \"TaxState\": \"0.00\",\n \"Cust1\": \"\",\n \"Cust1Value\": \"\",\n \"Cust2\": \"\",\n \"Cust2Value\": \"\",\n \"Cust3\": \"\",\n \"Cust3Value\": \"\",\n \"AcntFirst4\": \"4941\"\n },\n \"CVMResult\": 2,\n \"cancelled\": false,\n \"gatewayStatus\": 200,\n \"gatewayStatusText\": \"OK\",\n \"printReceipt\": \"Both\",\n \"paymentType\": \"Credit\",\n \"type\": \"refund\",\n \"registerId\": \"4f1b-f10a\",\n \"registerStatusPort\": \"3594291\",\n \"registerNickname\": \"Tech Area Z8 (3594291)\",\n \"registerSerial\": \"124124\",\n \"registerType\": \"dejavoo\"\n },\n \"total\": 0.01,\n \"method\": \"card\",\n \"pre_auth\": false,\n \"is_captured\": 0,\n \"last_four\": \"5114\",\n \"interchange_code\": \"\",\n \"interchange_fee\": null,\n \"batch_id\": \"\",\n \"batched_at\": \"2018-04-16 19:09:37\",\n \"emv_response\": \"\",\n \"avs_response\": \"\",\n \"cvv_response\": \"\",\n \"pos_entry\": \"\",\n \"pos_salesperson\": \"\",\n \"receipt_email_at\": null,\n \"receipt_sms_at\": null,\n \"created_at\": \"2018-04-16 19:09:37\",\n \"updated_at\": \"2018-04-16 19:09:37\",\n \"total_refunded\": 0,\n \"is_refundable\": false,\n \"is_voided\": false,\n \"is_voidable\": false,\n \"schedule_id\": null,\n \"child_captures\": [],\n \"parent_auth\": null,\n \"customer\": {\n \"id\": \"2a503ed1-99ea-4b35-a30a-605253f7c05a\",\n \"firstname\": \"A\",\n \"lastname\": \"Customer\",\n \"company\": \"\",\n \"email\": \"\",\n \"cc_emails\": [],\n \"cc_sms\": null,\n \"phone\": \"\",\n \"address_1\": \"\",\n \"address_2\": \"\",\n \"address_city\": \"\",\n \"address_state\": \"\",\n \"address_zip\": \"\",\n \"address_country\": \"USA\",\n \"notes\": \"\",\n \"reference\": \"\",\n \"options\": \"\",\n \"created_at\": \"2018-02-23 22:32:19\",\n \"updated_at\": \"2018-02-23 22:32:19\",\n \"deleted_at\": null,\n \"allow_invoice_credit_card_payments\": true,\n \"gravatar\": false\n },\n \"child_transactions\": [],\n \"files\": [],\n \"payment_method\": {\n \"id\": \"bf1aee65-dad9-4b74-8800-a75e435e3e7b\",\n \"customer_id\": \"2a503ed1-99ea-4b35-a30a-605253f7c05a\",\n \"merchant_id\": \"27fad5e4-0210-4c91-9596-417b0ea0dbb1\",\n \"user_id\": \"dbc85118-3309-4129-b966-0108c0fb18a0\",\n \"nickname\": \"VISA: YOU/A GIFT FOR (ending in: 0281)\",\n \"has_cvv\": 0,\n \"is_default\": 1,\n \"method\": \"card\",\n \"person_name\": \"YOU/A GIFT FOR\",\n \"card_type\": \"visa\",\n \"card_last_four\": \"0281\",\n \"card_exp\": \"992099\",\n \"bank_name\": null,\n \"bank_type\": null,\n \"bank_holder_type\": null,\n \"address_1\": null,\n \"address_2\": null,\n \"address_city\": null,\n \"address_state\": null,\n \"address_zip\": \"\",\n \"address_country\": \"\",\n \"purged_at\": null,\n \"deleted_at\": null,\n \"created_at\": \"2018-04-16 19:09:36\",\n \"updated_at\": \"2018-04-16 19:09:36\",\n \"card_exp_datetime\": \"2107-03-31 23:59:59\",\n \"customer\": {\n \"id\": \"2a503ed1-99ea-4b35-a30a-605253f7c05a\",\n \"firstname\": \"A\",\n \"lastname\": \"Customer\",\n \"company\": \"\",\n \"email\": \"\",\n \"cc_emails\": [],\n \"cc_sms\": null,\n \"phone\": \"\",\n \"address_1\": \"\",\n \"address_2\": \"\",\n \"address_city\": \"\",\n \"address_state\": \"\",\n \"address_zip\": \"\",\n \"address_country\": \"USA\",\n \"notes\": \"\",\n \"reference\": \"\",\n \"options\": \"\",\n \"created_at\": \"2018-02-23 22:32:19\",\n \"updated_at\": \"2018-02-23 22:32:19\",\n \"deleted_at\": null,\n \"allow_invoice_credit_card_payments\": true,\n \"gravatar\": false\n }\n },\n \"user\": {\n \"id\": \"dbc85118-3309-4129-b966-0108c0fb18a0\",\n \"system_admin\": true,\n \"name\": \"David Johnson\",\n \"email\": \"demo1@abc.com\",\n \"email_verification_sent_at\": \"2017-05-16 17:35:16\",\n \"email_verified_at\": \"2017-05-16 17:35:33\",\n \"is_api_key\": false,\n \"acknowledgments\": {\n \"tutorial\": true,\n \"godviewWelcome\": true\n },\n \"created_at\": \"2016-05-12 15:57:19\",\n \"updated_at\": \"2018-04-16 18:08:55\",\n \"deleted_at\": null,\n \"gravatar\": \"//www.gravatar.com/avatar/1cd5aef1d36d07e495abb73061f857d4\",\n \"team_admin\": null,\n \"team_enabled\": null,\n \"team_role\": null,\n \"merchant_options\": [],\n \"is_portal\": false\n }\n}" } }, "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "4be11b7e-21cb-4c9e-ba8f-5e173d13d7b7" }, "invoice_id": { "type": "string", "example": "" }, "reference_id": { "type": "string", "example": "5114aea7-5c7f-40ab-8a62-84f239e4b2b1" }, "recurring_transaction_id": { "type": "string", "example": "" }, "auth_id": {}, "type": { "type": "string", "example": "refund" }, "source": { "type": "string", "example": "terminalservice.dejavoo" }, "is_merchant_present": { "type": "boolean", "example": true, "default": true }, "merchant_id": { "type": "string", "example": "27fad5e4-0210-4c91-9596-417b0ea0dbb1" }, "user_id": { "type": "string", "example": "dbc85118-3309-4129-b966-0108c0fb18a0" }, "customer_id": { "type": "string", "example": "2a503ed1-99ea-4b35-a30a-605253f7c05a" }, "payment_method_id": { "type": "string", "example": "bf1aee65-dad9-4b74-8800-a75e435e3e7b" }, "is_manual": { "type": "boolean", "example": true, "default": true }, "success": { "type": "boolean", "example": true, "default": true }, "message": { "type": "string", "example": "" }, "meta": { "type": "object", "properties": { "lineItems": { "type": "array", "items": { "type": "object", "properties": { "item": { "type": "string", "example": "" }, "details": { "type": "string", "example": "" }, "quantity": { "type": "integer", "example": 1, "default": 0 }, "price": { "type": "string", "example": "0.01" } } } }, "subtotal": { "type": "number", "example": 0.01, "default": 0 }, "tax": { "type": "integer", "example": 0, "default": 0 }, "taxRate": { "type": "integer", "example": 10, "default": 0 }, "isBulkInvoice": { "type": "boolean", "example": false, "default": true }, "taxOverride": { "type": "boolean", "example": false, "default": true }, "update_inventory": { "type": "boolean", "example": true, "default": true }, "reference": { "type": "integer", "example": 2477, "default": 0 }, "RegisterId": { "type": "integer", "example": 3594291, "default": 0 }, "ResultCode": { "type": "integer", "example": 0, "default": 0 }, "RespMSG": { "type": "string", "example": "Approved Offline" }, "Message": { "type": "string", "example": "Approved" }, "AuthCode": { "type": "integer", "example": 145599, "default": 0 }, "PNRef": { "type": "integer", "example": 810618212223, "default": 0 }, "PaymentType": { "type": "string", "example": "Credit" }, "TransType": { "type": "string", "example": "Return" }, "SN": { "type": "integer", "example": 118816524647, "default": 0 }, "ExtData": { "type": "object", "properties": { "Amount": { "type": "string", "example": "0.01" }, "InvNum": { "type": "string", "example": "10" }, "CardType": { "type": "string", "example": "VISA" }, "BatchNum": { "type": "string", "example": "56" }, "Tip": { "type": "string", "example": "0.00" }, "CashBack": { "type": "string", "example": "0.00" }, "Fee": { "type": "string", "example": "0.00" }, "AcntLast4": { "type": "string", "example": "0281" }, "Name": { "type": "string", "example": "YOU/A GIFT FOR" }, "SVC": { "type": "string", "example": "0.00" }, "TotalAmt": { "type": "string", "example": "0.01" }, "DISC": { "type": "string", "example": "0.00" }, "Donation": { "type": "string", "example": "0.00" }, "SHFee": { "type": "string", "example": "0.00" }, "RwdPoints": { "type": "string", "example": "0" }, "RwdBalance": { "type": "string", "example": "0" }, "RwdIssued": { "type": "string", "example": "" }, "EBTFSLedgerBalance": { "type": "string", "example": "" }, "EBTFSAvailBalance": { "type": "string", "example": "" }, "EBTFSBeginBalance": { "type": "string", "example": "" }, "EBTCashLedgerBalance": { "type": "string", "example": "" }, "EBTCashAvailBalance": { "type": "string", "example": "" }, "EBTCashBeginBalance": { "type": "string", "example": "" }, "RewardCode": { "type": "string", "example": "" }, "AcqRefData": { "type": "string", "example": "" }, "ProcessData": { "type": "string", "example": "" }, "RefNo": { "type": "string", "example": "" }, "RewardQR": { "type": "string", "example": "" }, "Language": { "type": "string", "example": "English" }, "EntryType": { "type": "string", "example": "Swipe" }, "table_num": { "type": "string", "example": "0" }, "clerk_id": { "type": "string", "example": "" }, "ticket_num": { "type": "string", "example": "" }, "ControlNum": { "type": "string", "example": "" }, "TaxCity": { "type": "string", "example": "0.00" }, "TaxState": { "type": "string", "example": "0.00" }, "Cust1": { "type": "string", "example": "" }, "Cust1Value": { "type": "string", "example": "" }, "Cust2": { "type": "string", "example": "" }, "Cust2Value": { "type": "string", "example": "" }, "Cust3": { "type": "string", "example": "" }, "Cust3Value": { "type": "string", "example": "" }, "AcntFirst4": { "type": "string", "example": "4941" } } }, "CVMResult": { "type": "integer", "example": 2, "default": 0 }, "cancelled": { "type": "boolean", "example": false, "default": true }, "gatewayStatus": { "type": "integer", "example": 200, "default": 0 }, "gatewayStatusText": { "type": "string", "example": "OK" }, "printReceipt": { "type": "string", "example": "Both" }, "paymentType": { "type": "string", "example": "Credit" }, "type": { "type": "string", "example": "refund" }, "registerId": { "type": "string", "example": "4f1b-f10a" }, "registerStatusPort": { "type": "string", "example": "3594291" }, "registerNickname": { "type": "string", "example": "Tech Area Z8 (3594291)" }, "registerSerial": { "type": "string", "example": "124124" }, "registerType": { "type": "string", "example": "dejavoo" } } }, "total": { "type": "number", "example": 0.01, "default": 0 }, "method": { "type": "string", "example": "card" }, "pre_auth": { "type": "boolean", "example": false, "default": true }, "is_captured": { "type": "integer", "example": 0, "default": 0 }, "last_four": { "type": "string", "example": "5114" }, "interchange_code": { "type": "string", "example": "" }, "interchange_fee": {}, "batch_id": { "type": "string", "example": "" }, "batched_at": { "type": "string", "example": "2018-04-16 19:09:37" }, "emv_response": { "type": "string", "example": "" }, "avs_response": { "type": "string", "example": "" }, "cvv_response": { "type": "string", "example": "" }, "pos_entry": { "type": "string", "example": "" }, "pos_salesperson": { "type": "string", "example": "" }, "receipt_email_at": {}, "receipt_sms_at": {}, "created_at": { "type": "string", "example": "2018-04-16 19:09:37" }, "updated_at": { "type": "string", "example": "2018-04-16 19:09:37" }, "total_refunded": { "type": "integer", "example": 0, "default": 0 }, "is_refundable": { "type": "boolean", "example": false, "default": true }, "is_voided": { "type": "boolean", "example": false, "default": true }, "is_voidable": { "type": "boolean", "example": false, "default": true }, "schedule_id": {}, "child_captures": { "type": "array" }, "parent_auth": {}, "customer": { "type": "object", "properties": { "id": { "type": "string", "example": "2a503ed1-99ea-4b35-a30a-605253f7c05a" }, "firstname": { "type": "string", "example": "A" }, "lastname": { "type": "string", "example": "Customer" }, "company": { "type": "string", "example": "" }, "email": { "type": "string", "example": "" }, "cc_emails": { "type": "array" }, "cc_sms": {}, "phone": { "type": "string", "example": "" }, "address_1": { "type": "string", "example": "" }, "address_2": { "type": "string", "example": "" }, "address_city": { "type": "string", "example": "" }, "address_state": { "type": "string", "example": "" }, "address_zip": { "type": "string", "example": "" }, "address_country": { "type": "string", "example": "USA" }, "notes": { "type": "string", "example": "" }, "reference": { "type": "string", "example": "" }, "options": { "type": "string", "example": "" }, "created_at": { "type": "string", "example": "2018-02-23 22:32:19" }, "updated_at": { "type": "string", "example": "2018-02-23 22:32:19" }, "deleted_at": {}, "allow_invoice_credit_card_payments": { "type": "boolean", "example": true, "default": true }, "gravatar": { "type": "boolean", "example": false, "default": true } } }, "child_transactions": { "type": "array" }, "files": { "type": "array" }, "payment_method": { "type": "object", "properties": { "id": { "type": "string", "example": "bf1aee65-dad9-4b74-8800-a75e435e3e7b" }, "customer_id": { "type": "string", "example": "2a503ed1-99ea-4b35-a30a-605253f7c05a" }, "merchant_id": { "type": "string", "example": "27fad5e4-0210-4c91-9596-417b0ea0dbb1" }, "user_id": { "type": "string", "example": "dbc85118-3309-4129-b966-0108c0fb18a0" }, "nickname": { "type": "string", "example": "VISA: YOU/A GIFT FOR (ending in: 0281)" }, "has_cvv": { "type": "integer", "example": 0, "default": 0 }, "is_default": { "type": "integer", "example": 1, "default": 0 }, "method": { "type": "string", "example": "card" }, "person_name": { "type": "string", "example": "YOU/A GIFT FOR" }, "card_type": { "type": "string", "example": "visa" }, "card_last_four": { "type": "string", "example": "0281" }, "card_exp": { "type": "string", "example": "992099" }, "bank_name": {}, "bank_type": {}, "bank_holder_type": {}, "address_1": {}, "address_2": {}, "address_city": {}, "address_state": {}, "address_zip": { "type": "string", "example": "" }, "address_country": { "type": "string", "example": "" }, "purged_at": {}, "deleted_at": {}, "created_at": { "type": "string", "example": "2018-04-16 19:09:36" }, "updated_at": { "type": "string", "example": "2018-04-16 19:09:36" }, "card_exp_datetime": { "type": "string", "example": "2107-03-31 23:59:59" }, "customer": { "type": "object", "properties": { "id": { "type": "string", "example": "2a503ed1-99ea-4b35-a30a-605253f7c05a" }, "firstname": { "type": "string", "example": "A" }, "lastname": { "type": "string", "example": "Customer" }, "company": { "type": "string", "example": "" }, "email": { "type": "string", "example": "" }, "cc_emails": { "type": "array" }, "cc_sms": {}, "phone": { "type": "string", "example": "" }, "address_1": { "type": "string", "example": "" }, "address_2": { "type": "string", "example": "" }, "address_city": { "type": "string", "example": "" }, "address_state": { "type": "string", "example": "" }, "address_zip": { "type": "string", "example": "" }, "address_country": { "type": "string", "example": "USA" }, "notes": { "type": "string", "example": "" }, "reference": { "type": "string", "example": "" }, "options": { "type": "string", "example": "" }, "created_at": { "type": "string", "example": "2018-02-23 22:32:19" }, "updated_at": { "type": "string", "example": "2018-02-23 22:32:19" }, "deleted_at": {}, "allow_invoice_credit_card_payments": { "type": "boolean", "example": true, "default": true }, "gravatar": { "type": "boolean", "example": false, "default": true } } } } }, "user": { "type": "object", "properties": { "id": { "type": "string", "example": "dbc85118-3309-4129-b966-0108c0fb18a0" }, "system_admin": { "type": "boolean", "example": true, "default": true }, "name": { "type": "string", "example": "David Johnson" }, "email": { "type": "string", "example": "demo1@abc.com" }, "email_verification_sent_at": { "type": "string", "example": "2017-05-16 17:35:16" }, "email_verified_at": { "type": "string", "example": "2017-05-16 17:35:33" }, "is_api_key": { "type": "boolean", "example": false, "default": true }, "acknowledgments": { "type": "object", "properties": { "tutorial": { "type": "boolean", "example": true, "default": true }, "godviewWelcome": { "type": "boolean", "example": true, "default": true } } }, "created_at": { "type": "string", "example": "2016-05-12 15:57:19" }, "updated_at": { "type": "string", "example": "2018-04-16 18:08:55" }, "deleted_at": {}, "gravatar": { "type": "string", "example": "//www.gravatar.com/avatar/1cd5aef1d36d07e495abb73061f857d4" }, "team_admin": {}, "team_enabled": {}, "team_role": {}, "merchant_options": { "type": "array" }, "is_portal": { "type": "boolean", "example": false, "default": true } } } } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"success\": false,\n \"message\": \"User Cancelled\",\n \"gatewayStatus\": 200,\n \"gatewayStatusText\": \"OK\",\n \"cancelled\": true,\n \"status\": 400\n}" } }, "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false, "default": true }, "message": { "type": "string", "example": "User Cancelled" }, "gatewayStatus": { "type": "integer", "example": 200, "default": 0 }, "gatewayStatusText": { "type": "string", "example": "OK" }, "cancelled": { "type": "boolean", "example": true, "default": true }, "status": { "type": "integer", "example": 400, "default": 0 } } } } } }, "422": { "description": "422", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"validation\": \"register not found\",\n \"status\": 422,\n \"message\": \"Validation Error\"\n}" } }, "schema": { "type": "object", "properties": { "validation": { "type": "string", "example": "register not found" }, "status": { "type": "integer", "example": 422, "default": 0 }, "message": { "type": "string", "example": "Validation Error" } } } } } } }, "deprecated": false, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "number", "format": "float", "required": true, "description": "(Min: 0.01) The amount of the void. This endpoint should only be used if you are certain the transaction has NOT BEEN batched (still in open batch). For most use cases, use POST /terminal/void-or-refund instead, which will automatically determine whether to void or refund based on batch timing (typically 8pm EST)." }, "meta": { "type": "string", "format": "json", "required": true, "description": "(required, json literal) i.e. {\"tax\":2,\"subtotal\":10} can contain any json object. Will be blindly stored and returned during a GET operation. Values in meta may also appear in an email receipt if the template calls for it. The Stax front-end uses subtotal, tax, memo, lineItems = []." }, "printReceipt": { "type": "string", "enum": [ "Both", "Customer", "Merchant", "No" ], "default": "Both", "description": "Possible values: No, Merchant, Customer, Both. Defaults to Both." }, "paymentType": { "type": "string", "enum": [ "Credit", "Debit", "Check", "Gift", "Loyalty" ], "default": "Credit", "description": "Possible values: Credit, Debit, Check, Gift, Loyalty. Defaults to Credit." }, "customerId": { "type": "string", "description": "The id of the customer attributed to this credit." }, "invoiceId": { "type": "string", "description": "The id of the invoice attributed to this charge." }, "register": { "type": "string", "required": true, "description": "The id of the register performing this operation. This should be the 'id' value returned by GET /terminal/register, not the serial or status_port. The register must match the register used for the original transaction." } }, "required": [ "total", "register" ] } } } } } }, "/query/statement/v3/volumes/card-type": { "get": { "summary": "Volumes by card type", "description": "", "operationId": "volumes-by-card-type", "parameters": [ { "name": "startDate", "in": "query", "required": true, "description": "YYYY-MM-DD", "schema": { "type": "string", "default": "" } }, { "name": "endDate", "in": "query", "required": true, "description": "YYYY-MM-DD", "schema": { "type": "string", "default": "" } } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"data\": [\n {\n \"is_card_present\": 0,\n \"card_brand\": \"visa\",\n \"bin_type\": \"DEBIT\",\n \"rate\": 3.36,\n \"total_charges\": 16521.52,\n \"use_count\": 34,\n \"rate_fees\": 555.12,\n \"per_transaction_fees\": 10.2,\n \"interchange_fees_amount\": 0,\n \"total_fees\": 565.32\n },\n {\n \"is_card_present\": 0,\n \"card_brand\": \"ACH\",\n \"bin_type\": \"ACH\",\n \"rate\": 1,\n \"total_charges\": 64845.81,\n \"use_count\": 49,\n \"rate_fees\": 298.31,\n \"per_transaction_fees\": 0,\n \"interchange_fees_amount\": 0,\n \"total_fees\": 298.31\n },\n {\n \"is_card_present\": 0,\n \"card_brand\": \"visa\",\n \"bin_type\": \"CREDIT\",\n \"rate\": 3.36,\n \"total_charges\": 146266.33,\n \"use_count\": 92,\n \"rate_fees\": 4914.54,\n \"per_transaction_fees\": 27.6,\n \"interchange_fees_amount\": 0,\n \"total_fees\": 4942.14\n },\n {\n \"is_card_present\": 0,\n \"card_brand\": \"mastercard\",\n \"bin_type\": \"DEBIT\",\n \"rate\": 3.36,\n \"total_charges\": 27726.12,\n \"use_count\": 21,\n \"rate_fees\": 931.57,\n \"per_transaction_fees\": 6.3,\n \"interchange_fees_amount\": 0,\n \"total_fees\": 937.87\n },\n {\n \"is_card_present\": 0,\n \"card_brand\": \"mastercard\",\n \"bin_type\": \"CREDIT\",\n \"rate\": 3.36,\n \"total_charges\": 17690.57,\n \"use_count\": 26,\n \"rate_fees\": 594.39,\n \"per_transaction_fees\": 7.8,\n \"interchange_fees_amount\": 0,\n \"total_fees\": 602.19\n },\n {\n \"is_card_present\": 0,\n \"card_brand\": \"discover\",\n \"bin_type\": \"CREDIT\",\n \"rate\": 3.36,\n \"total_charges\": 5829,\n \"use_count\": 4,\n \"rate_fees\": 195.86,\n \"per_transaction_fees\": 1.2,\n \"interchange_fees_amount\": 0,\n \"total_fees\": 197.06\n },\n {\n \"is_card_present\": 0,\n \"card_brand\": \"amex\",\n \"bin_type\": \"CREDIT\",\n \"rate\": 3.92,\n \"total_charges\": 21639.96,\n \"use_count\": 13,\n \"rate_fees\": 848.28,\n \"per_transaction_fees\": 3.9,\n \"interchange_fees_amount\": 0,\n \"total_fees\": 852.18\n }\n ],\n \"summary\": {\n \"total_charges\": 300519.31,\n \"use_count\": 239,\n \"rate_fees\": 8338.07,\n \"per_transaction_fees\": 57,\n \"interchange_fees_amount\": 0,\n \"total_fees\": 8395.07\n }\n}" } }, "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "is_card_present": { "type": "integer", "example": 0, "default": 0 }, "card_brand": { "type": "string", "example": "visa" }, "bin_type": { "type": "string", "example": "DEBIT" }, "rate": { "type": "number", "example": 3.36, "default": 0 }, "total_charges": { "type": "number", "example": 16521.52, "default": 0 }, "use_count": { "type": "integer", "example": 34, "default": 0 }, "rate_fees": { "type": "number", "example": 555.12, "default": 0 }, "per_transaction_fees": { "type": "number", "example": 10.2, "default": 0 }, "interchange_fees_amount": { "type": "integer", "example": 0, "default": 0 }, "total_fees": { "type": "number", "example": 565.32, "default": 0 } } } }, "summary": { "type": "object", "properties": { "total_charges": { "type": "number", "example": 300519.31, "default": 0 }, "use_count": { "type": "integer", "example": 239, "default": 0 }, "rate_fees": { "type": "number", "example": 8338.07, "default": 0 }, "per_transaction_fees": { "type": "integer", "example": 57, "default": 0 }, "interchange_fees_amount": { "type": "integer", "example": 0, "default": 0 }, "total_fees": { "type": "number", "example": 8395.07, "default": 0 } } } } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "{}" } }, "schema": { "type": "object", "properties": {} } } } } }, "deprecated": false } } } }