Stax

Stax Query API

The Query API from Stax — 14 operation(s) for query.

Documentation GitHub OpenAPI

Operations 17

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

GET /query/statement/v3/ach-rejects Report ACH rejections for a date range · ACH Rejections #

Ask an LLM

“Which ACH payments were rejected or returned on my statement last month?”

“Can I see bank-payment rejects between two dates?”

Tell an agent

Show my ACH rejects from {startDate} to {endDate}.

Pull the ACH rejection statement section for {startDate} through {endDate}.

GET /query/statement/v3/volumes/card-processing Report card processing volume · Card Processing #

Ask an LLM

“How much card processing volume did I run over a period?”

“What does my statement show for card processing volumes this quarter?”

Tell an agent

Show card processing volume from {startDate} to {endDate}.

Get the card-processing volumes statement for {startDate} to {endDate}.

POST /query/payment-links Create a payment link · Create a Payment Link #

Ask an LLM

“Can I generate a shareable link that customers use to pay me?”

“Is it possible to create a payment link where the customer chooses the amount?”

Tell an agent

Create a payment link called {common_name} for {amount} at {url}.

Make a variable-amount payment link named {common_name} pointing to {url}.

GET /query/payment-links List payment links · List And Filter All Payment Links #

Ask an LLM

“Which payment links have I created for my merchant account?”

“Can I list only the payment links that are still active?”

Tell an agent

List all my payment links.

Show payment links where active is {active}, sorted by {sort}.

GET /query/statement/v3/daily-sales Report daily sales, fees and surcharges · Daily Sales #

Ask an LLM

“What were my total sales for each day of last week?”

“Can I see fees and surcharges broken down per day on my statement?”

Tell an agent

Show my daily sales from {startDate} to {endDate}.

Break down sales, fees and surcharges by day between {startDate} and {endDate}.

DELETE /query/payment-links/{id} Delete a payment link · Delete a Payment Link #

Ask an LLM

“Can I permanently remove a payment link from my account?”

“What happens when a payment link is deleted rather than deactivated?”

Tell an agent destructive · confirm first

Delete payment link {id}.

Permanently remove payment link {id}.

GET /query/payment-links/{id} Get a payment link's details · Get A Payment Link's Information #

Ask an LLM

“What amount, name and metadata does a specific payment link have?”

“Can I look up the full record for one payment link?”

Tell an agent

Get payment link {id}.

Show the full details and metadata of payment link {id}.

PUT /query/payment-links/{id} Update or deactivate a payment link · Update (or Deactivate) a Payment Link #

Ask an LLM

“Can I turn off a payment link without deleting it?”

“Is it possible to reactivate a payment link I deactivated earlier?”

Tell an agent

Set payment link {id} ({common_name}, {url}) active to {active}.

Change payment link {id} to charge {amount}, keeping name {common_name} and URL {url}.

GET /query/statement/v3/disputes Report disputes on the statement · Disputes #

Ask an LLM

“Which chargebacks appear on my statement for a given period?”

“Can I get the disputes section of my monthly statement?”

Tell an agent

Show statement disputes from {startDate} to {endDate}.

Pull the chargeback statement report for {startDate} through {endDate}.

GET /query/payment-links/{id}/is-active Check if a payment link is active · Get A Payment Link's Active Status #

Ask an LLM

“Is a particular payment link still accepting payments?”

“Can I check a payment link's active flag without loading all of its details?”

Tell an agent

Check whether payment link {id} is active.

Tell me if payment link {id} is live or inactive.

GET /query/depositDetail Get the detail of a deposit batch · Get Details of Specific Deposit #

Ask an LLM

“Which transactions made up a particular deposit to my bank account?”

“Can I see granular detail for one deposit batch in my timezone?”

Tell an agent

Show the detail of deposit batch {batchId} between {startDate} and {endDate}.

Break down deposit details from {startDate} to {endDate} in timezone {timezone}.

GET /query/deposit List deposits · Get List of Deposits #

Ask an LLM

“What deposits did I receive in my bank account over the last month?”

“Can I list deposits by batch date for a date range?”

Tell an agent

List my deposits from {startDate} to {endDate}.

Show deposits batched between {startDate} and {endDate} using UTC offset {timeZoneOffset}.

GET /query/statement/v3/adjustments Report refunds and adjustments · Refund and Adjustments #

Ask an LLM

“What refunds and adjustments hit my statement this month?”

“Can I pull statement adjustments for a custom date range?”

Tell an agent

Show refunds and adjustments from {startDate} to {endDate}.

Get the statement adjustments section for {startDate} through {endDate}.

GET /query/statement/v3/surcharges Report surcharges collected · Surcharging #

Ask an LLM

“How much did I collect in credit card surcharges over a period?”

“Can I see the surcharging section of my statement?”

Tell an agent

Show surcharges collected from {startDate} to {endDate}.

Pull my statement surcharging report for {startDate} to {endDate}.

GET /query/statistics/teamSummary Get summary stats for my team · Team Summary #

Ask an LLM

“What are the headline statistics for my merchant team?”

“Is there a quick summary of my team's activity numbers?”

Tell an agent

Show my team summary stats.

Get the current team's statistics overview.

PUT /query/payment-links/{id}/update-stats Update a payment link's sales stats · Update A Payment Link's Stats #

Ask an LLM

“Can I correct the total sales recorded against a payment link?”

“Is it possible to adjust a payment link's transaction statistics?”

Tell an agent

Set payment link {id}'s total sales to {total}.

Update the sales stats of payment link {id} with a total of {total}.

GET /query/statement/v3/volumes/card-type Report volume by card brand · Volumes by card type #

Ask an LLM

“How is my processing volume split between Visa, Mastercard and other card brands?”

“Can I see volumes broken out by card type for a date range?”

Tell an agent

Show volume by card type from {startDate} to {endDate}.

Break down card brand volumes between {startDate} and {endDate}.

Stax Query API

Operations 17

Documentation

Specifications

Other Resources

Work with this as data

MCP server

Tools for apis

Call it yourself

Get an API key

OpenAPI Specification