Stax

Stax Terminal API

The Terminal API from Stax — 13 operation(s) for terminal.

GitHub OpenAPI

Operations 13

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 /terminal/charge/queue Queue a card-present sale on a terminal · Charge (Queue) #
Ask an LLM
“Can I stage a terminal sale while the device is busy with another customer?”
“Is there a way to line up several card-present charges on one register during a rush?”
Tell an agent
Queue a {total} card-present sale on register {register}.
Stage a queued {total} terminal sale on register {register} for invoice {invoiceId}.
POST /terminal/charge Run a card-present sale on a terminal now · Charge #
Ask an LLM
“How do I take an in-person card payment on a paired terminal?”
“Can the terminal prompt the customer for a tip during an immediate sale?”
Tell an agent
Charge {total} on terminal register {register} right now.
Start an immediate {total} sale on register {register} with a tip prompt: {promptTipInput}.
POST /terminal/credit Give a standalone credit on a terminal · Credit #
Ask an LLM
“Can I return money to a customer at the terminal without an original sale?”
“Does a general credit on the terminal work if my gateway does not support it?”
Tell an agent
Issue a standalone {total} credit on register {register}.
Give customer {customerId} a general credit of {total} at register {register}.
GET /terminal/register List terminal devices · Get all devices #
Ask an LLM
“Which Wi-Fi card terminals are connected to my merchant account?”
“What register IDs can I send in-person payments to?”
Tell an agent
List all my terminal devices.
Show the registers paired with my account.
GET /terminal/{registerId}/status/{transactionId} Check a terminal transaction's status · Get Transaction Status #
Ask an LLM
“Did the customer finish paying on the terminal yet?”
“Can I poll the live status of a card-present transaction I started?”
Tell an agent
Check status of transaction {transactionId} on register {registerId}.
Poll register {registerId} for the result of terminal transaction {transactionId}.
POST /terminal/print Print a custom message on a terminal · Print #
Ask an LLM
“Can I print a custom note or receipt add-on from the card terminal's printer?”
“Is it possible to print multiple lines of text on a register?”
Tell an agent
Print {message} on register {register}.
Send this receipt supplement to the printer on register {register}: {message}.
POST /terminal/promptChoice Prompt a multiple-choice question on a terminal · Get terminalprompt choice #
Ask an LLM
“Can I show the customer a list of options to pick from on the terminal screen?”
“Is it possible to put a title above a choice prompt on the device?”
Tell an agent
Show choices {choices} on register {register}.
Ask the customer on register {register} to pick one of {choices} under the title {title}.
POST /terminal/promptInput Prompt for free-text input on a terminal · Prompt (Input) #
Ask an LLM
“Can the terminal ask for a table number or PO reference typed in by the customer?”
“Is it possible to collect free-form text on the card reader screen?”
Tell an agent
Prompt for text input on register {register}.
Ask for free-form entry titled {title} on register {register}.
POST /terminal/prompt/signature Capture a signature on a terminal · Prompt (Signature) #
Ask an LLM
“Can I collect a customer's signature on the card terminal?”
“When would a terminal need to capture a digital signature for a sale?”
Tell an agent
Capture a signature on register {register}.
Ask the customer to sign on the screen of register {register}.
POST /terminal/refund Refund a sale by re-presenting the card · Refund #
Ask an LLM
“Can I refund an in-person sale by having the customer tap or insert their card again?”
“What do I need to do a card-present refund of a prior transaction?”
Tell an agent destructive · confirm first
Refund {total} of transaction {transactionId} with the card present on register {register}.
Run a card-present refund for sale {transactionId} of {total} at register {register}.
POST /terminal/tokenize Save a card from the terminal to a customer · Tokenize #
Ask an LLM
“Can I read a card on the terminal and store it for future online charges?”
“Is it possible to attach a card swiped at the counter to a customer profile?”
Tell an agent
Tokenize a card on register {register} for customer {customerId} with tokenize {tokenize}.
Read and save a card at register {register} to customer {customerId}, tokenize set to {tokenize}.
POST /terminal/void-or-refund Void a terminal sale or refund it if batched · Void/Refund #
Ask an LLM
“Can I reverse an in-person sale without knowing whether it has batched yet?”
“What happens to a terminal transaction that's past the open batch when I try to cancel it?”
Tell an agent destructive · confirm first
Void or refund terminal transaction {transactionId} for {total} on register {register}.
Reverse card-present sale {transactionId} ({total}) at register {register}, voiding if still open.
POST /terminal/void Void an unbatched terminal sale · Void #
Ask an LLM
“Can I cancel an in-person card sale before it settles in the batch?”
“Is a terminal void only possible while the transaction is still in the open batch?”
Tell an agent destructive · confirm first
Void the {total} open-batch terminal sale on register {register}.
Void the unbatched {total} card-present charge for invoice {invoiceId} on register {register}.

Documentation

📖
Documentation
https://docs.staxpayments.com/
📖
APIReference
https://docs.staxpayments.com/reference/overview

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/stax/refs/heads/main/openapi/stax-terminal-api-openapi.yml

Other Resources

🔗
Examples
https://raw.githubusercontent.com/api-evangelist/stax/refs/heads/main/examples/stax-api-examples.yml
🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/stax/refs/heads/main/data-model/stax-data-model.yml
🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/stax/refs/heads/main/errors/stax-problem-types.yml
🔗
Webhooks
https://raw.githubusercontent.com/api-evangelist/stax/refs/heads/main/asyncapi/stax-webhooks.yml
🔗
AgenticAccess
https://raw.githubusercontent.com/api-evangelist/stax/refs/heads/main/agentic-access/stax-agentic-access.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/stax:stax-terminal-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

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

OpenAPI Specification

stax-terminal-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: stax-api Terminal API
  version: '0.1'
servers:
- url: https://apiprod.fattlabs.com/
security:
- ApiKeyAuth: []
tags:


# --- truncated at 32 KB (182 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/stax/refs/heads/main/openapi/stax-terminal-api-openapi.yml