Audience
This file is for software that calls Atum’s public REST APIs: the Payment Gateway, the x402 Facilitator, and Veri-Fill. Humans integrating the same APIs should start at API Reference.Discover
Do not look for/.well-known/openid-configuration, /.well-known/oauth-authorization-server, or /.well-known/oauth-protected-resource on this host. Those documents are for OAuth-protected APIs. Atum’s hosted APIs are not OAuth-protected.
Use these documents instead:
How a call is authorized
There is no API key, bearer token, or authorization header on any Payment Gateway, x402 Facilitator, or Veri-Fill operation. Veri-Fill needs no credentials either; see Veri-Fill API.- Writes that move funds:
POST /v1/paymentscarries asender_authsignature that proves control of the funding account — build and sign it with the SDK or CLI; do not hand-roll the signature. x402/settleis called by the resource server with the payer’s signed credential; that credential’spaymentRequestincludessender_auth. See x402 Facilitator. - Reads (
/status,/resolve,/timeline,/v1/defaults, x402/supported, Veri-Fill) need no credentials. - Quote requests are not signed. Spend authorization is deferred to award time. See Get a price quote.
Identity is not a login
Atum ID is a signed fact attached to a payment or quote. It is not a username, not a session, and not permission to move funds. You can submit and settle without credentials. If you attach them, Atum verifies them. Know Your Agent is the separate question of who is answerable when software spends. Two signed grants (principal delegation + Atum recognition) are how that works. They are not a self-serve integration: there is no publicPOST /agent/identity, POST /agent/auth, or POST /oauth2/token on Atum.
Today, an agent that calls Atum either:
- Holds the signing key — the agent signs
sender_authand submits, the same way the CLI and examples do. Treat that key as a production signer. - Acts for a principal — the agent assembles the request; the principal’s signer completes it. Prepare-only.
Supported methods
What to call
- Confirm the gateway is reachable:
GET https://payment-gw.production-testnet.atum.xyz/v1/defaults(testnet) orGET https://payment-gw.production-mainnet.atum.xyz/v1/defaults(mainnet). See Endpoints. - Build and sign a payment with the SDK or CLI.
- Submit to
POST /v1/payments. Reuse the samerequest_idif you retry — see Idempotency. - If you are paying for or gating an HTTP resource, use Facilitated payments (x402) or Direct payments (MPP).
Next steps
API Reference
Shared conventions for the hosted REST APIs
Endpoints
Testnet and mainnet base URLs
Know Your Agent
Who is answerable when software spends
SDK quickstart
Build and sign a payment