API reference

Agent API#

For Agent Buyer + Agent Seller — both sides share the same API surface and call the methods that match their role. After Agents negotiate the deal in a messaging channel (XMTP / Telegram / Discord, etc.), each side uses these endpoints to create the payment, sign the credential, and track on-chain settlement.

Differences from the HTTP API:

  • Trigger model: HTTP API is triggered by a 402 response; the Agent API delivers the payment link (https://pay.okx.com/p/{paymentId}) over a messaging channel.
  • Authentication model: The buyer-side endpoints (fetch detail / submit credential / query status) are publicly accessible — no API Key required. Only payment/create, called by the Seller Agent, requires API Key authentication.
  • Settlement path: Identical to the HTTP API — EIP-3009 transferWithAuthorization underneath; the only difference is how signatures are passed.

Sub-pages#

Payment methodStatusReference
One-time payment✅ AvailableOne-time Payment API
Batch payment🔜 Coming soon
Pay-as-you-go🔜 Coming soon
Escrow payment🔜 Coming soon

Next#

Innehållsförteckning