API reference

HTTP API#

For HTTP Sellers — REST-style integration with the Broker. When a Buyer requests a protected resource, the Seller service returns HTTP 402 to trigger payment; the Buyer signs and replays the request, and the Seller uses these endpoints to verify the signature and settle on-chain.

Differences from the Agent API:

  • Trigger model: HTTP API is triggered by a 402 response; the Agent API delivers the payment link over a messaging channel (XMTP / Telegram / Discord, etc.).
  • Authentication model: All HTTP API endpoints require an API Key (OK-ACCESS-* headers); the Agent API's buyer-side endpoints (fetch detail / submit credential / query status) are publicly accessible.
  • Settlement path: Identical to the Agent API — EIP-3009 transferWithAuthorization underneath.

Sub-pages#

Payment methodStatusReference
One-time payment✅ AvailableOne-time Payment API
Batch payment✅ AvailableBatch Payment API
Pay-as-you-goComing soonPay-as-you-go API

Next#

Innehållsförteckning