Skip to main content
You are an agent. Atum’s hosted APIs do not use OAuth, OpenID Connect, or API keys. There is no agent registration endpoint and no access token to mint. A payment authorizes itself. Read this file, then follow the linked owner pages — do not invent an OAuth or signup flow.

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/payments carries a sender_auth signature that proves control of the funding account — build and sign it with the SDK or CLI; do not hand-roll the signature. x402 /settle is called by the resource server with the payer’s signed credential; that credential’s paymentRequest includes sender_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.
Full field shapes are on the endpoint pages. The convention those APIs share is on API Reference.

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 public POST /agent/identity, POST /agent/auth, or POST /oauth2/token on Atum. Today, an agent that calls Atum either:
  1. Holds the signing key — the agent signs sender_auth and submits, the same way the CLI and examples do. Treat that key as a production signer.
  2. Acts for a principal — the agent assembles the request; the principal’s signer completes it. Prepare-only.
See Agentic payouts.

Supported methods

What to call

  1. Confirm the gateway is reachable: GET https://payment-gw.production-testnet.atum.xyz/v1/defaults (testnet) or GET https://payment-gw.production-mainnet.atum.xyz/v1/defaults (mainnet). See Endpoints.
  2. Build and sign a payment with the SDK or CLI.
  3. Submit to POST /v1/payments. Reuse the same request_id if you retry — see Idempotency.
  4. 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