canonical: https://jentic.com/apis/stedi.com/stedi-payers

# Stedi Payers

stedi.com/stedi-payers-api version 2024-04-01. The API exposes 4 endpoints secured with apiKey authentication.

## For AI agents

Programmatically getpayerrecord, listpayerrecords. Covers 4 operations with apiKey authentication.

## Scope

Does not handle communications, crm, or developer tools - use for payments only.

## Capabilities

- GetPayerRecord
- ListPayerRecords
- SearchPayers
- Query and filter Stedi Payers records by parameters
- Monitor Stedi Payers operational status and events

## Use cases

### Payments Operations

Use the Stedi Payers to perform payments operations programmatically. The API provides 4 endpoints covering core functionality including getpayerrecord, listpayerrecords, listpayerrecordscsv.

Example prompt: Call GET `/payer/{stediId}` to getpayerrecord

### Automated Payer Management

Automate payer operations by combining multiple Stedi Payers endpoints. Agents can listpayerrecords and then listpayerrecordscsv in a single workflow.

Example prompt: Call GET /payers to listpayerrecords, then verify the result

### AI Agent Integration via Jentic

AI agents discover and call Stedi Payers 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 apiKey tokens manually.

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

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| GET | `/payer/{stediId}` | GetPayerRecord |
| GET | `/payers` | ListPayerRecords |
| GET | `/payers/csv` | ListPayerRecordsCsv |
| GET | `/payers/search` | SearchPayers |

## Key resources

- **Payer** — Operations for payer
- **Payers** — Operations for payers

## Why Jentic

- **Setup:** Wiring Stedi Payers by hand means handling its API-key auth in the Authorization header, targeting the US payers host at payers.us.stedi.com, and paging the payer directory yourself. Through Jentic you install once, import Stedi Payers from the API Directory, store the API key once, and your agent calls it.
- **Permission scoping:** Stedi Payers puts the payer id in the URL path (`/payer/{stediId}`), so a rule can pin your agent to reading a single payer record. You choose the operations it may call, so the bulk payer list, search, and CSV export are not included unless you add them.
- **Credential handling:** Your Stedi Payers API key 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 'look up a payer by id' or 'search for a healthcare payer', and Jentic returns the matching Stedi Payers operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Stripe** — Alternative payments API
- **Adyen** — Alternative payments API
- **Square** — Complementary payments API
- **Paypal** — Complementary payments API

## FAQ

### What authentication does the Stedi Payers use?

The Stedi Payers uses an API key passed in the `Authorization` header. 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 getpayerrecord with the Stedi Payers?

Yes. Use the GET `/payer/{stediId}` endpoint. The API returns structured JSON responses that agents can parse and act on directly.

### What are the rate limits for the Stedi Payers?

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 getpayerrecord through Jentic?

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

### How many endpoints does the Stedi Payers have?

The Stedi Payers exposes 4 endpoints covering payer, payers operations.

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

Yes. Jentic One is self-hosted by you, so your own rules decide which Stedi Payers operations and credentials the agent may use. Because the payer id sits in the URL path at GET `/payer/{stediId}`, you can pin the agent to reading a single payer record. You pick the operations it may call, so the bulk payer list at GET /payers, the search at GET `/payers/search`, and the CSV export at GET `/payers/csv` stay off limits unless you add them.