Stax

Stax Merchant API

The Merchant API from Stax — 7 operation(s) for merchant.

Documentation GitHub OpenAPI

Operations 11

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

POST /merchant/{id}/registration/file Upload a file to a merchant's registration · Add File to Merchant Registration #

Ask an LLM

“Can I attach a voided check or ID document to a merchant's onboarding registration?”

“Is it possible to link an uploaded file to a specific registration document requirement?”

Tell an agent

Upload {file} named {name} to the registration of merchant {id}.

Attach {file} as {name} to merchant {id}'s registration document {registration_document_id}.

POST /merchant Create a merchant · Create a Merchant #

Ask an LLM

“How do I create a new merchant account on its own, without a user or registration?”

“Can I set the currency and reference when creating a merchant?”

Tell an agent

Create a merchant for {company_name} with contact {contact_name} at {contact_email}.

Create merchant {company_name} using currency {currency} and reference {reference}.

GET /merchant List and filter merchants · Get all Merchants #

Ask an LLM

“Which merchants do I manage, and what status is each in?”

“Can I find merchants that are on a risk hold?”

Tell an agent

List all of my merchants.

Find merchants whose company name is {company_name}.

POST /merchant/{id}/apikey Create an API key for a merchant · Create a New API Key for Merchant #

Ask an LLM

“Can I generate a new API key on behalf of a merchant I manage?”

“Is it possible to give a new merchant API key a name and team role?”

Tell an agent

Generate a new API key for merchant {id}.

Create an API key named {name} with role {team_role} for merchant {id}.

GET /merchant/{id}/apikey List a merchant's API keys · List API Keys for Merchant #

Ask an LLM

“Which API keys exist for one of my merchants?”

“Can I audit the API keys issued to a particular merchant account?”

Tell an agent

List the API keys for merchant {id}.

Show every API key issued to merchant {id}.

DELETE /merchant/{id}/registration/file/{file_id} Remove a file from a merchant's registration · Delete File from Merchant Registration #

Ask an LLM

“Can I delete a wrong document uploaded to a merchant's onboarding registration?”

“What happens if I remove a registration file from a merchant?”

Tell an agent destructive · confirm first

Delete file {file_id} from merchant {id}'s registration.

Remove registration file {file_id} for merchant {id}.

GET /merchant/{merchant_id} Get a merchant · Get Merchant by ID #

Ask an LLM

“What details does Stax hold for one specific merchant account?”

“Can I look up a merchant's status and contact info by ID?”

Tell an agent

Get merchant {merchant_id}.

Show the status and contact details of merchant {merchant_id}.

GET /merchant/{id}/registration Get a merchant's registration data · Get Merchant Registration Data #

Ask an LLM

“What onboarding information has a merchant submitted for underwriting?”

“Can I review the business and bank details on a merchant's registration?”

Tell an agent

Get the registration data for merchant {id}.

Show the underwriting registration details merchant {id} submitted.

PUT /merchant/{id}/registration Update a merchant's registration data · Update Merchant Registration Data #

Ask an LLM

“Can I fill in a merchant's business legal name and tax ID for onboarding?”

“Is it possible to update the bank account a merchant registered with?”

Tell an agent

Set merchant {id}'s registration legal name to {business_legal_name} and tax ID to {business_tax_id}.

Update merchant {id}'s registration bank routing {bank_routing_number} and account {bank_account_number}.

POST /merchant/{merchant_id}/user/{user_id} Link an existing user to a merchant · **Link Existing User to Merchant #

Ask an LLM

“Can I give an existing Stax user access to another merchant account?”

“Is it possible to make a linked user the merchant admin or their default merchant?”

Tell an agent

Link user {user_id} to merchant {merchant_id}.

Link user {user_id} to merchant {merchant_id} as merchant admin: {merchant_admin}.

DELETE /merchant/{merchant_id}/user/{user_id} Unlink a user from a merchant · **Unlink User from Merchant #

Ask an LLM

“Can I revoke a user's access to one merchant account without deleting the user?”

“What does unlinking a user from a merchant do?”

Tell an agent destructive · confirm first

Unlink user {user_id} from merchant {merchant_id}.

Remove user {user_id}'s access to merchant {merchant_id}.

Stax Merchant API

Operations 11

Documentation

Specifications

Other Resources

Work with this as data

MCP server

Tools for apis

Call it yourself

Get an API key

OpenAPI Specification