Docs · API

API reference

Resources, requests and responses.

Illustrative reference. Request access for the full specification.

Auth and accounts

POST /oauth2/token	Exchange a signed client assertion for a scoped access token.
GET /.well-known/jwks.json	Keys to verify tokens.
GET /v1/organizations/{organization_id}	Read an organization.
GET /v1/legal-entities/{legal_entity_id}	Read a legal entity.
GET /v1/merchant-accounts/{merchant_account_id}	Read a merchant account.
GET /v1/grants/{grant_id}	Read an access grant.

Payments

POST /v1/payments	Create a payment. Requires Idempotency-Key.
POST /v1/payments/{payment_id}/captures	Capture an authorized payment.
GET /v1/transactions	Search transactions by status.
GET /v1/tickets/{ticket_id}	Read a ticket: fee lines with rule citations, decision and event references.

Payouts, exports and events

POST /v1/cutoffs/preview	See what a cutoff change would do. Changes nothing.
POST /v1/exports/preview	Start an export job.
GET /v1/exports/{job_id}	Check an export job.
GET /v1/events	List events with cursor pagination.

Webhooks

GET /v1/webhooks/{webhook_id}/deliveries	List deliveries for an endpoint.
GET /v1/webhooks/{webhook_id}/deliveries/{delivery_id}/attempts	See every attempt, status and timing.
POST /v1/webhooks/{webhook_id}/deliveries/{delivery_id}/replays	Replay a delivery.

Example: price a payment before it runs

Agents use the quote_ticket tool (see MCP tools). It returns the fee lines and the perimeter decision that would apply, without submitting anything.

Illustrative example

{
  "tool": "quote_ticket",
  "input": {
    "amount": "0.02",
    "currency": "USD",
    "payee": "api.example-data.com"
  }
}

Illustrative example

{
  "lines": [
    {
      "label": "network",
      "amount": "0.0004",
      "rule": "rule:rail.stablecoin.fee@v1"
    }
  ],
  "perimeter": {
    "id": "per_01J9",
    "version": 3,
    "decision": "allow"
  }
}

Errors

Errors return a code, a message and, where a rule or perimeter caused it, the rule citation or perimeter version.