canonical: https://jentic.com/apis/stax.com/stax

# Stax API

stax.com/main version 1.0.0. The API exposes 122 endpoints.

## For AI agents

Programmatically enroll a merchant, create a merchant. Covers 122 operations.

## Scope

Does not handle payments, communications, or crm - use for finance and accounting only.

## Capabilities

- Enroll a Merchant
- Create a Merchant
- Get all Merchants
- List API Keys for Merchant
- Monitor Stax API operational status and events

## Use cases

### Finance and Accounting Operations

Use the Stax API to perform finance operations programmatically. The API provides 122 endpoints covering core functionality including enroll a merchant, create a merchant, get all merchants.

Example prompt: Call POST `/admin/enroll` to enroll a merchant

### Automated Admin Management

Automate admin operations by combining multiple Stax API endpoints. Agents can create a merchant and then get all merchants in a single workflow.

Example prompt: Call POST /merchant to create a merchant, then verify the result

### AI Agent Integration via Jentic

AI agents discover and call Stax API endpoints through Jentic without managing credentials directly. An agent searches for the required operation by intent, receives the matching endpoint schema, and executes the call with Jentic-managed authentication. This eliminates the need to read API documentation or handle none tokens manually.

Example prompt: Search Jentic for 'enroll a merchant', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | `/admin/enroll` | Enroll a Merchant |
| POST | `/merchant` | Create a Merchant |
| GET | `/merchant` | Get all Merchants |
| GET | `/merchant/merchant_id` | Get Merchant by ID |
| POST | `/merchant/{id}/apikey` | Create a New API Key for Merchant |
| GET | `/merchant/{id}/apikey` | List API Keys for Merchant |
| GET | `/merchant/{id}/registration` | Get Merchant Registration Data |
| PUT | `/merchant/{id}/registration` | Update Merchant Registration Data |

## Key resources

- **Admin** — Operations for admin
- **Charge** — Operations for charge
- **Credit** — Operations for credit
- **Customer** — Operations for customer
- **Ephemeral** — Operations for ephemeral

## Why Jentic

- **Setup:** Wiring the Stax API by hand means learning its request conventions, working through its large merchant and enrollment surface, and threading the merchant id through registration and API-key calls yourself. Through Jentic you install once, import the Stax API from the API Directory, store the credential once, and your agent calls it.
- **Permission scoping:** The Stax API puts the merchant id in the URL path (`/merchant/{id}/registration`, `/merchant/{id}/apikey`), so a rule can pin your agent to one merchant: it can read that merchant's registration and nothing else. You choose the operations it may call, so enrollment and API-key creation are not included unless you add them.
- **Credential handling:** Your Stax credential is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'enroll a merchant' or 'read a merchant's registration', and Jentic returns the matching Stax API operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Plaid** — Alternative finance API
- **Xero** — Alternative finance API

## FAQ

### What authentication does the Stax API use?

The Stax API uses no authentication. Through Jentic, these credentials are stored encrypted in your Jentic One instance and injected at execution time, so raw secrets never enter the agent context.

### Can I enroll a merchant with the Stax API?

Yes. Use the POST `/admin/enroll` endpoint. The API returns structured JSON responses that agents can parse and act on directly.

### What are the rate limits for the Stax API?

Rate limits are not specified in the OpenAPI spec. Check the vendor documentation for current limits. Through Jentic, rate limiting is handled automatically with retry logic built into the execution layer.

### How do I enroll a merchant through Jentic?

Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'enroll a merchant'. Jentic returns the matching Stax API operation with its input schema. Load the schema and execute the call - credentials are injected automatically.

### How many endpoints does the Stax API have?

The Stax API exposes 122 endpoints covering admin, charge, credit operations.

### Can I limit what my agent is allowed to do with the Stax API?

Yes. Because you run Jentic One yourself, self-hosted, your own rules decide which Stax API operations and credentials the agent may use. The Stax API carries the merchant id in the URL path, as in `/merchant/{id}/registration` and `/merchant/{id}/apikey`, so you can pin the agent to a single merchant and let it read only that merchant's registration. You choose the operations it may call, so merchant enrollment via POST `/admin/enroll` and API-key creation stay out of reach unless you explicitly grant them.