How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Stax

Stax API

The Stax REST API (published as "stax-api") exposes 133 operations across 101 paths at https://apiprod.fattlabs.com — the Merchant API for payments, payment methods, customers, invoices, payment links, catalog, terminals, transactions and webhooks, and the Partner API for merchant creation, enrollment, registration data, API-key issuance, disputes and partner-brand webhooks. Authentication is a bearer API key; sandbox and live keys use the same base URL.

Documentation Provider Profile APIs.io OpenAPI GitHub

This API exposes 133 operations across 101 paths. It is described by OpenAPI 3.1.0, at version 0.1.

Requests are made against a single base URL, https://apiprod.fattlabs.com/.

133 operations 101 paths 0 schemas 12 DELETE54 GET44 POST23 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
0.1
Base URL
https://apiprod.fattlabs.com
Authentication
HTTP Bearer, HTTP Bearer, HTTP Bearer
Resource Areas
1

Authentication & Security 3

Stax API declares 3 security schemes for authenticating requests. It accepts HTTP bearer tokens (JWT) (ApiKeyAuth). It accepts HTTP bearer tokens (JWT) (PartnerApiKey). It accepts HTTP bearer tokens (JWT) (EphemeralAuth). By default, every request must be authenticated.

  • ApiKeyAuth — API key for merchant-level operations. Provides access to merchant-specific endpoints including transactions, payments, customer management, and merchant accou…
  • PartnerApiKey — Partner-level API key with elevated privileges. Grants access to all partner operations including merchant management, portfolio oversight, reporting across mu…
  • EphemeralAuth — Temporary authentication token with limited lifespan. Used for short-term access to specific operations, typically generated for secure one-time actions or tim…

Paths & Operations 133

Across 101 paths, the API surfaces 133 operations — 12 DELETE, 54 GET, 44 POST, 23 PUT. Each is listed below with its method, path, parameters, and response codes.

Operations 133
GET
/query/statement/v3/ach-rejects
ACH Rejections
ach-rejections 2 params → 200400
POST
/file
post_file body → 200
GET
/file
get_file → 200
POST
/merchant/{id}/registration/file
Add File to Merchant Registration
add-file-to-merchant-registration 1 param body → 200422
PUT
/team/options
Add/Update Team Settings
addupdate-team-settings → 200
PUT
/team/option/advanced_customizations
post_teamoptionadvanced_customizations body → 200
POST
/transaction/{transactionid}/capture
Capture a Pre-Auth Transaction
capture-a-pre-auth-transaction 1 param body → 200422
GET
/query/statement/v3/volumes/card-processing
Card Processing
card-processing 2 params → 200400
POST
/charge
Charge a Payment Method
charge-a-payment-method body → 200422
POST
/terminal/charge/queue
Charge (Queue)
charge-queue body → 200
POST
/terminal/charge
Charge
charge body → 200
GET
/self/exists
Check if E-Mail Exists
check-if-e-mail-exists 1 param → 200400
POST
/merchant
Create a Merchant
create-a-merchant body → 200422
GET
/merchant
Get all Merchants
get-all-merchants 15 params → 200
POST
/merchant/{id}/apikey
Create a New API Key for Merchant
create-a-new-api-key-for-merchant 1 param body → 200400
GET
/merchant/{id}/apikey
List API Keys for Merchant
list-api-keys-for-merchant 1 param → 200400
POST
/team/user
Create a New Team Member
create-a-new-team-member 8 params → 200401422
GET
/team/user
Find the Merchant Team's Users
find-the-merchant-teams-users → 200
POST
/query/payment-links
Create a Payment Link
create-a-payment-link body → 201500
GET
/query/payment-links
List And Filter All Payment Links
list-and-filter-all-payment-links 4 params → 200
POST
/payment-method
Create a Bank Payment Method
create-a-payment-method-copy 1 param body → 200400
GET
/payment-method
Get all Payment Methods for a Merchant
get-all-payment-methods-for-a-merchant 6 params → 200422
POST
/payment-method/
Create a Card Payment Method
create-a-payment-method body → 200400
POST
/invoice/schedule/
Create a Scheduled Invoice
createScheduledInvoice body → 201400422500
POST
/team
Create a Team
create-a-team 9 params → 200422
PUT
/team
Edit Your Merchant Team's Info
edit-your-merchant-teams-info 9 params → 200
POST
/self
Create a User Account - Self Registration
create-a-user-account-self-registration 5 params → 200422
GET
/self
Get User and Team's Info
get-self-and-teams-info → 200401
PUT
/self
Update Your User Info
update-your-user-info → 200400
POST
/invoice
Create an Invoice
create-an-invoice body → 200422
GET
/invoice
Get All Invoices
get-all-invoices 9 params → 200
POST
/item
Create a Catalog Item
create-catalog-item body → 200422
GET
/item
Retrieve All Catalog Items
retrieve-all-catalog-items 11 params → 200422
POST
/customer
Create Customer
create-customer body → 200422
GET
/customer
Find all Customer
find-all-customers 18 params → 200
POST
/webhook
Create a Webhook for All User's Merchants
create-new-webhook-for-all-of-my-users-merchants 2 params → 200422
GET
/webhook
Get All Webhooks
get-all-webhooks 2 params → 200
POST
/webhookadmin/webhook/brand
Create Partner Level Webhook for your brand
create-partner-level-webhook-for-your-brand body → 200422
GET
/webhookadmin/webhook/brand
Get all Partner Level Webhooks for your brand
get-all-partner-level-webhooks-for-your-brand → 200
POST
/credit
Credit A Payment Method
credit-a-payment-method body → 200422
POST
/terminal/credit
Credit
credit body → 200400422
GET
/query/statement/v3/daily-sales
Daily Sales
daily-sales 2 params → 200400
PUT
/item/{id}/decrement
Decrement Item's Stock
decrement-items-stock 2 params → 200400
DELETE
/item/{id}
Delete a Catalog Item
delete-a-catalog-item 1 param → 200400
GET
/item/{id}
Retrieve an Item by ID
retrieve-an-item-by-id 1 param → 200422
PUT
/item/{id}
Update an Item
update-an-item 1 param body → 200422
DELETE
/customer/{id}
Delete a Customer
delete-a-customer 1 param → 200422
GET
/customer/{id}
Get a Customer's Information
get-a-customers-information 1 param → 200404
PUT
/customer/{id}
Update Customer Information
update-customer-info 1 param body → 200422
DELETE
/file{id}
delete_file{id} 1 param → 200
DELETE
/webhookadmin/webhook/brand/{webhook_id}
Delete a Partner Level Webhook for your brand
delete-a-partner-level-webhook-for-your-brand 1 param → 200
GET
/webhookadmin/webhook/brand/{webhook_id}
Get a specific Partner Level Webhook for your brand
get-a-specific-partner-level-webhook-for-your-brand 1 param → 200400
DELETE
/query/payment-links/{id}
Delete a Payment Link
delete-a-payment-link 1 param → 200
GET
/query/payment-links/{id}
Get A Payment Link's Information
get-a-payment-links-information 1 param → 200
PUT
/query/payment-links/{id}
Update (or Deactivate) a Payment Link
update-a-payment-link 1 param body → 201500
DELETE
/payment-method/{id}
Delete a Payment Method
delete-a-payment-method 1 param → 200422
GET
/payment-method/{id}
Get a Payment Method By ID
get-a-payment-method-by-id 1 param → 200422
PUT
/payment-method/{id}
Update a Payment Method
update-a-payment-method 17 params → 200422
DELETE
/invoice/{id}
Delete an Invoice
delete-an-invoice 1 param → 200422
GET
/invoice/{id}
Get an Invoice
get-an-invoice 2 params → 200400422
PUT
/invoice/{id}
Update an Invoice
update-an-invoice 2 params → 200422
DELETE
/file/dispute/{evidenceFileId}
Delete Evidence for Dispute
delete-evidence-for-dispute 1 param → 200
DELETE
/merchant/{id}/registration/file/{file_id}
Delete File from Merchant Registration
delete-file-from-merchant-registration 2 params → 200422
DELETE
/invoice/schedule/{id}
Delete an Invoice Schedule
delete-invoice-schedule 1 param → 200
PUT
/invoice/schedule/{id}
Edit an Invoice Schedule
editInvoiceSchedule 1 param body → 200400422500
GET
/query/statement/v3/disputes
Disputes
disputes 2 params → 200400
PUT
/transaction/{id}/receipt/email
E-Mail Transaction Receipt
e-mail-transaction-receipt 1 param body → 200422
PUT
/file/{id}
put_file{id} 1 param body → 200
GET
/file/{id}
get_file{id} 1 param → 200
POST
/admin/enroll
Enroll a Merchant
enroll-a-merchant body → 200422
GET
/ephemeral
Ephemeral Authentication Tokens
ephemeral-authentication-tokens-1 2 params → 200422
GET
/file/{tag}
get_file{tag} 1 param → 200
GET
/query/payment-links/{id}/is-active
Get A Payment Link's Active Status
get-a-payment-links-active-status 1 param → 200
GET
/transaction/{id}/related
Get a Related Transaction
get-a-related-transaction 1 param → 200400
GET
/transaction/{id}/funding
Get a Transaction's Funding Instructions
get-a-transactions-funding-instructions 1 param → 200404
GET
/transaction/{id}
Get a Transaction's Information
get-a-transactions-information 1 param → 200422
GET
/terminal/register
Get all devices
get-all-devices → 200
GET
/customer/{customerId}/payment-method
Get all Payment Methods for a Customer
get-all-payment-methods-for-a-customer 1 param → 200422
GET
/query/depositDetail
Get Details of Specific Deposit
get-detail-of-specific-deposit 5 params → 200400
GET
/query/deposit
Get List of Deposits
get-list-of-deposits 4 params → 200400
GET
/merchant/{merchant_id}
Get Merchant by ID
get-merchant-by-id 1 param → 200400
GET
/merchant/{id}/registration
Get Merchant Registration Data
get-merchant-registration-data 1 param → 200422
PUT
/merchant/{id}/registration
Update Merchant Registration Data
update-merchant-registration-data 1 param body → 200422
GET
/underwriting/merchant/{id}/registration/documents
Get Registration Documents
get-registration-documents 7 params → 200401
PUT
/team/user/{id}
Update Team Member's Information
get-team-members-information-copy 1 param → 200401404
GET
/team/user/{id}
Get Team Member's Information
get-team-members-information 1 param → 200404
GET
/team/registration
Get Team Registration Data
get-team-registration-data → 200400
PUT
/team/registration
Update Team Registration Data
update-team-registration-data 59 params → 200400
GET
/terminal/{registerId}/status/{transactionId}
Get Transaction Status
get-transaction-status 2 params → 200400
DELETE
/webhook/{id}
Delete a Webhook
delete-a-webhook 1 param → 200422
PUT
/item/{id}/increment
Increment Item's Stock
increment-items-stock 2 params → 200422
POST
/forgot
Initiate Password Reset
initiate-password-reset 2 params → 200422
POST
/merchant/{merchant_id}/user/{user_id}
Link Existing User to Merchant
link-existing-user-to-merchant 4 params → 200401
DELETE
/merchant/{merchant_id}/user/{user_id}
Unlink User from Merchant
unlink-user-from-merchant 2 params → 200401422
GET
/transaction
List and Filter All Transactions
list-and-filter-all-transactions 18 params → 200422
GET
/team/apikey
List API Keys
list-api-keys → 200
GET
/underwriting/disputes/{merchantId}
List Disputes for a Merchant
list-disputes-copy 10 params → 200
GET
/underwriting/disputes
List Disputes
list-disputes 9 params → 200
POST
/invoice/{id}/pay/{method}
Mark an Invoice Paid in Cash or Check
mark-an-invoice-paid-in-cash-or-check 9 params → 200404422
POST
/invoice/{id}/pay
Pay an Invoice
pay-an-invoice 6 params → 200422
POST
/terminal/print
Print
print body → 200
POST
/terminal/promptChoice
get_terminalpromptChoice body → 200
POST
/terminal/promptInput
Prompt (Input)
prompt-input body → 200
POST
/terminal/prompt/signature
Prompt (Signature)
prompt-signature body → 200
GET
/query/statement/v3/adjustments
Refund and Adjustments
refund-and-adjustments 2 params → 200400
POST
/transaction/{id}/refund
Refund Transaction
refund-transaction 1 param body → 200400
POST
/terminal/refund
Refund
refund body → 200400422
PUT
/self/verify/resend
Resend Verification E-Mail
resend-verification-e-mail → 200400
POST
/reset/{token}
Reset Password
reset-password 3 params → 200400
GET
/reset/{token}
Verify Password Reset Token
verify-password-reset-token 1 param → 200404422
GET
/item/code
Retrieve All Item Codes
retrieve-all-item-codes → 200400
GET
/invoice/schedule
Retrieve All Scheduled Invoices
retrieve-all-scheduled-invoices 3 params → 200400
GET
/underwriting/terms-and-conditions/{id}
Retrieve Terms and Conditions
retrieve-terms-and-conditions 1 param → 200400
GET
/surcharge/review
Review a Transaction's Surcharge Information
review-a-transactions-surcharge-information 2 params → 200
PUT
/invoice/{id}/send/email
Send an Invoice via Email
send-an-invoice-via-email 1 param body → 200400
PUT
/invoice/{id}/send/sms
Send an Invoice via SMS
send-an-invoice-via-sms 3 params → 200422
POST
/payment_method/{payment_method_id}/external_vault
Share a payment method with a third party
share-a-payment-method-with-a-third-party 2 params → 201422
PUT
/transaction/{id}/receipt-sms
SMS Transaction Receipt
sms-transaction-receipt 1 param body → 200422
POST
/underwriting/dispute/{disputeId}/submit
Submit Dispute Evidence Files for Review
submit-dispute-evidence-files-for-review 1 param → 200400
GET
/query/statement/v3/surcharges
Surcharging
surcharging-1 2 params → 200400
POST
/team/option/branding
Team Branding
team-branding 2 params → 200400
GET
/query/statistics/teamSummary
Team Summary
team-summary → 200
POST
/terminal/tokenize
Tokenize
tokenize body → 200
PUT
/query/payment-links/{id}/update-stats
Update A Payment Link's Stats
update-a-payment-links-stats 1 param body → 201400
PUT
/transaction/{id}/
Update a Transaction
update-a-transactions-information 1 param body → 200422
POST
/file/dispute
Upload Evidence for Dispute
upload-evidence-for-dispute body → 201400
POST
/verify
Verify A Payment Method
verify-a-payment-method body → 200422
GET
/self/verify/{token}
Verify E-mail Token
verify-e-mail-token 1 param → 200404
POST
/transaction/{id}/void-or-refund
Void or Refund Transaction
void-or-refund-transaction 2 params → 200422
POST
/terminal/void-or-refund
Void/Refund
void-refund body → 200400422
POST
/transaction/{id}/void
Void Transaction
void-transaction 1 param → 200422
POST
/terminal/void
Void
void body → 200400422
GET
/query/statement/v3/volumes/card-type
Volumes by card type
volumes-by-card-type 2 params → 200400

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

stax-api-openapi.json Raw ↑
#Payments#Invoicing#Merchant Onboarding#Webhook#Terminals
← Back to S APIs
API Details
ID
stax:stax-api
Base URL
https://apiprod.fattlabs.com
Docs
https://docs.staxpayments.com/reference/overview
Provider
Stax
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=stax-stax-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/stax-stax-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Stax API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.