Base URLs
Authentication
Authenticate by including your Project Identify Token in theX-API-Key header:
Endpoint Groups
The API is organized into three groups:x402 Settlement
Facilitator endpoints for the x402 payment flow. The SDKs call these under the hood.Merchant
For UCP and ACP merchants. Call these from your server to build your discovery profile and prepare checkout sessions. Each protocol has its own handlers and payment-requirements endpoint.The generic
/api/v2/merchant/payment-profile and /api/v2/merchant/checkout-prepare endpoints still work but are deprecated aliases of the UCP endpoints above. Use the protocol-split endpoints for new integrations.Gateway
Public endpoints serving the UCP handler reference. No authentication required.
See Endpoints for full request/response documentation.
Request Format
- Content-Type:
application/json - All request bodies are JSON
- Standard HTTP methods:
GET,POST
Error Format
Errors follow the RFC 7807 Problem Details format:
When rate limited, the API returns 429 Too Many Requests. Back off and retry after the reset time.
SDKs
For most integrations, use a server-side SDK instead of calling the API directly. The SDKs handle authentication, x402 protocol flow, payment verification, and type safety:TypeScript
Express, NestJS, Next.js, Fastify, and more
Python
FastAPI, Flask, Django
Java
Servlet-based applications