Every API here is available over the APIs.io API and to AI agents over MCP.
openapi: 3.2.0
info:
title: stax-api Merchant API
version: '0.1'
servers:
- url: https://apiprod.fattlabs.com/
security:
- ApiKeyAuth: []
tags:
- name: Merchant
paths:
/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: []
tags:
- Merchant
/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: []
tags:
- Merchant
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_p
# --- truncated at 32 KB (168 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/stax/refs/heads/main/openapi/stax-merchant-api-openapi.yml