API Reference#
Use API Reference when you need one exact method per page, but still want a reading surface that feels like the rest of the portal instead of a generated Swagger clone. This layer keeps navigation organized by family first and method second, while the raw generated API remains available only as a fallback artifact outside the primary navigation.
Families#
A
Auth
Issue and inspect access credentials before any tenant-scoped control-plane call begins.
A
Me
Me method surfaces in the tenant-facing API.
A
Enterprises
Read or admit the enterprise perimeter that owns tenant topology, governance, and downstream operating surfaces.
A
Master Accounts
Inspect the enterprise-owned financial boundary that anchors tenant-wide liquidity before downstream distribution starts.
S
Commercial Agreements
Commercial Agreements method surfaces in the tenant-facing API.
D
Clients
Create and manage downstream clients that operate beneath the enterprise perimeter.
D
Client Accounts
Create and manage financial-account surfaces owned by individual clients.
S
Users
Create, inspect, and manage human actors that operate inside the tenant perimeter.
S
Service Accounts
Provision backend execution identities and rotate or revoke their credentials over time.
S
Roles
Define reusable capability bundles that can later be assigned to human or service actors.
S
Role Assignments
Grant or revoke role bindings across the topology and inspect how access is attached.
S
Identity Providers
Manage external identity-provider bindings that federate users into the tenant perimeter.
S
Capabilities
Inspect the capability vocabulary and override capability posture where the API allows it.
S
Policies
Create and manage the policy surface that constrains governed execution.
L
Action Tokens
Issue short-lived action tokens for delegated approval and governed follow-up actions.
S
Approvals
Inspect approval work, resolve approval decisions, and discover eligible approvers.
S
Balances
Inspect current balance views across enterprise and client-owned account boundaries.
L
Deposits
Inspect deposit operations and their execution state through a tenant-facing read model.
D
Deposit Instructions
Inspect deposit instruction surfaces that tell callers how to route inbound funds.
D
Funding Endpoints
Provision and inspect funding endpoint surfaces used for inbound liquidity flows.
S
Payment Methods
Create and manage payment-method records used to initiate rail-specific flows.
S
Payout Methods
Create and manage payout-method records used for outbound execution surfaces.
D
Crypto Networks
Create and manage crypto-network records that constrain supported chain routing.
L
Conversion Pairs
Conversion Pairs method surfaces in the tenant-facing API.
D
Webhook Subscriptions
Webhook Subscriptions method surfaces in the tenant-facing API.
D
Events
Inspect the event log that mirrors execution and governance state changes over time.
L
Withdrawals
Create, inspect, and cancel withdrawal operations where the public surface allows it.
D
Withdrawal Destinations
Create and manage outbound destinations used by withdrawal execution flows.
L
Internal Transfers
Move liquidity between account references and inspect transfer lifecycle state.
L
Conversions
Create, inspect, preview, and cancel conversion operations across supported assets.
L
Fee Previews
Calculate fee previews before execution so the caller can inspect expected charges.
L
Prices
Read indicative pricing surfaces used before a conversion or rate-sensitive operation.
S
User Invitations
User Invitations method surfaces in the tenant-facing API.
L
On-ramp Sessions
On-ramp Sessions method surfaces in the tenant-facing API.
L
Off-ramp Sessions
Off-ramp Sessions method surfaces in the tenant-facing API.
R
Operations Activity Exports
Operations Activity Exports method surfaces in the tenant-facing API.
A
User Action Audit Entries
User Action Audit Entries method surfaces in the tenant-facing API.
A
User Action Audit Exports
User Action Audit Exports method surfaces in the tenant-facing API.