API Reference · Overview#
Onchain OS Payment APIs are split by service shape into two groups — HTTP and Agent. Pick the shape first, then drill into the sub-API for your payment method.
How to choose#
| Service shape | Who it's for | Trigger model | Entry |
|---|---|---|---|
| HTTP | You have a RESTful service and want to embed payment capability | Buyer requests a protected resource → Seller returns HTTP 402 → Buyer signs and replays | HTTP API |
| Agent | Both you and your customer are Agents, coordinating over a messaging channel | Seller drops a payment link into a messaging channel (XMTP / Telegram / Discord, etc.) → Buyer signs and writes back | Agent API |
Both shapes share the same on-chain settlement path (EIP-3009
transferWithAuthorization); the differences are in trigger model and authentication model.
HTTP API#
| Payment method | Status | Reference |
|---|---|---|
| One-time payment | ✅ Available | One-time Payment API |
| Batch payment | ✅ Available | Batch Payment API |
| Pay-as-you-go | 🔜 Coming soon | Pay-as-you-go API |
Agent API#
Agent Buyer and Agent Seller share the same API surface.
| Payment method | Status | Reference |
|---|---|---|
| One-time payment | ✅ Available | One-time Payment API |
| Batch payment | 🔜 Coming soon | — |
| Pay-as-you-go | 🔜 Coming soon | — |
| Escrow payment | 🔜 Coming soon | — |
Next#
Table of contents