# Relayer.fi ## Docs - [Endpoints](https://docs.relayer.fi/agent/endpoints.md): Reference card for the Agent Kit API surface - [Flow Guide](https://docs.relayer.fi/agent/flow-guide.md): Create-agent → fund → sign → x402-pay lifecycle - [Getting Started](https://docs.relayer.fi/agent/getting-started.md): From zero to running agent — sign up, activate the Agent Kit module, provision your first agent, install the SDK, and ship - [Agent Kit](https://docs.relayer.fi/agent/overview.md): Budget-enforced AI agents that can sign transactions and pay for on-chain resources - [SDK Reference](https://docs.relayer.fi/agent/sdk.md): Exhaustive reference for @relayerfi/agent-sdk — classes, methods, events, errors - [Generate metadata for Crosschain Bridge application](https://docs.relayer.fi/api-reference/action:-builders/generate-metadata-for-crosschain-bridge-application.md): Creates metadata configuration for bridging assets between different blockchain networks. - [Generate metadata for Crosschain Transfer application](https://docs.relayer.fi/api-reference/action:-builders/generate-metadata-for-crosschain-transfer-application.md): Creates metadata configuration for transferring native tokens across different blockchain networks. Converts native currency from source chain to native currency on destination chain (e.g., AVAX -> ETH, AVAX -> MATIC). - [Generate metadata for Native Token Transfer application](https://docs.relayer.fi/api-reference/action:-builders/generate-metadata-for-native-token-transfer-application.md): Creates metadata configuration for transferring native tokens (like AVAX, ETH, MATIC) on a single blockchain network. - [Generate metadata for Swap application](https://docs.relayer.fi/api-reference/action:-builders/generate-metadata-for-swap-application.md): Creates metadata configuration for a token swap application. Currently supports LFJ and Pangolin protocols. The generated metadata can be used to create widgets for token swaps on supported blockchain networks. - [Get the Directory data](https://docs.relayer.fi/api-reference/action:-directory/get-the-directory-data.md): > **Auth: public.** No authentication required. - [Retrieve protocol token list for a chain](https://docs.relayer.fi/api-reference/action:-tokens/retrieve-protocol-token-list-for-a-chain.md): Returns the token list for a given protocol on a specific chain. Use 'all' for the chain parameter to fetch tokens on every supported chain. - [Batch ingest agent events (up to 100)](https://docs.relayer.fi/api-reference/agents/batch-ingest-agent-events-up-to-100.md): > **Auth: agent HMAC.** Called by the agent SDK at runtime with `x-agent-id`, `x-agent-auth`, `x-request-timestamp` headers. **Not callable from backend ApiKey.** See [Authentication → Agent HMAC](/get-started/authentication). - [Get agent budget state (HMAC or API key)](https://docs.relayer.fi/api-reference/agents/get-agent-budget-state-hmac-or-api-key.md): > **Auth: agent HMAC or API key.** Accepts the agent's own HMAC credentials (runtime self-call) **or** the integrator's ApiKey (backend query on the agent's behalf). - [Get agent details](https://docs.relayer.fi/api-reference/agents/get-agent-details.md) - [Get agent status and kill-switch state (HMAC or API key)](https://docs.relayer.fi/api-reference/agents/get-agent-status-and-kill-switch-state-hmac-or-api-key.md): > **Auth: agent HMAC or API key.** Accepts the agent's own HMAC credentials (runtime self-call) **or** the integrator's ApiKey (backend query on the agent's behalf). - [Get agent wallet balance with budget context (HMAC or API key)](https://docs.relayer.fi/api-reference/agents/get-agent-wallet-balance-with-budget-context-hmac-or-api-key.md): > **Auth: agent HMAC or API key.** Accepts the agent's own HMAC credentials (runtime self-call) **or** the integrator's ApiKey (backend query on the agent's behalf). - [List all agents for the integrator](https://docs.relayer.fi/api-reference/agents/list-all-agents-for-the-integrator.md) - [Pause an agent (reversible)](https://docs.relayer.fi/api-reference/agents/pause-an-agent-reversible.md) - [Resume a paused agent](https://docs.relayer.fi/api-reference/agents/resume-a-paused-agent.md) - [Sign a Solana transaction for an agent](https://docs.relayer.fi/api-reference/agents/sign-a-solana-transaction-for-an-agent.md): > **Auth: agent HMAC.** Called by the agent SDK at runtime with `x-agent-id`, `x-agent-auth`, `x-request-timestamp` headers. **Not callable from backend ApiKey.** See [Authentication → Agent HMAC](/get-started/authentication). - [Widget Actions — overview](https://docs.relayer.fi/api-reference/flows/actions-intro.md): The metadata + catalog endpoints that power the Widget Kit. Use these to configure widget instances dynamically and discover what protocols/tokens are supported. - [Pay for an x402-gated resource](https://docs.relayer.fi/api-reference/flows/agent-x402-pay.md): The agent pays for a remote resource that requires USDC via the x402 protocol. Budget-checked, kill-switch-gated, atomically enforced. - [Set up a payout account — Step 1](https://docs.relayer.fi/api-reference/flows/payout-setup.md): Step 1 of the 2-step payout account setup. Creates a crypto withdrawal address linked to a recipient's bank account. - [Set up a payout account — Step 2](https://docs.relayer.fi/api-reference/flows/payout-virtual-account.md): Step 2 of the 2-step payout setup. Creates a fiat virtual account (CLABE) tied to the withdrawal address. - [API Reference](https://docs.relayer.fi/api-reference/introduction.md): REST endpoints for backend integration. Interactive playground, 17 languages, sandbox + production. - [Execute a fiat payment](https://docs.relayer.fi/api-reference/payout:-accounts/execute-a-fiat-payment.md): Creates a pending fiat payment record. Automatically provisions a liquidation address and virtual account if they do not exist for this beneficiary/currency pair. - [Get a payment quote (MXN → USD)](https://docs.relayer.fi/api-reference/payout:-accounts/get-a-payment-quote-mxn-→-usd.md): Returns an estimated exchange rate and fee breakdown. Rates update every ~30 seconds — this is not a locked quote. - [Get payment status by reference](https://docs.relayer.fi/api-reference/payout:-accounts/get-payment-status-by-reference.md) - [List all payments for the authenticated integrator](https://docs.relayer.fi/api-reference/payout:-accounts/list-all-payments-for-the-authenticated-integrator.md): Returns all fiat payments sorted by newest first, with beneficiary name. - [Create or get a deposit account (idempotent)](https://docs.relayer.fi/api-reference/payout:-on-ramp/create-or-get-a-deposit-account-idempotent.md): Idempotent on (integrator_id, wallet_id, source_currency, destination_currency). Returns the existing deposit account if one matches, otherwise provisions a Bridge Virtual Account whose destination = the requested wallet and persists the result. Per ONR-04 + Phase 11 polish (multi-stablecoin). - [Get a single deposit account by id](https://docs.relayer.fi/api-reference/payout:-on-ramp/get-a-single-deposit-account-by-id.md): Returns the full deposit account record (including source_deposit_instructions). Used by the form to re-hydrate the drawer when the user lands on /apps?flow=onramp&deposit_account=. Cross-tenant ids surface 404. - [Get an on-ramp quote (fiat → stablecoin)](https://docs.relayer.fi/api-reference/payout:-on-ramp/get-an-on-ramp-quote-fiat-→-stablecoin.md): Returns the live exchange rate from Bridge plus the developer_fee_percent applied to the conversion. Bridge's 0.75% commercial fee is BAKED INTO sell_rate (per Bridge docs); this endpoint surfaces the developer fee separately so it can be displayed transparently to the end user. Public — no auth req… - [List lifecycle events for a deposit account](https://docs.relayer.fi/api-reference/payout:-on-ramp/list-lifecycle-events-for-a-deposit-account.md): Returns normalized lifecycle events for the deposit account, ordered by occurred_at ASC (oldest first). Events are sourced from the existing bridge-webhook ingestion (virtual_account.activity). Cross-tenant ids surface 404. Per ONR-05. - [List my deposit accounts](https://docs.relayer.fi/api-reference/payout:-on-ramp/list-my-deposit-accounts.md): Returns every deposit account scoped to the calling integrator, newest first. Lets the form render a "Recent deposits" surface so users can return to any prior VA and copy instructions again. Cross-tenant isolation enforced by integrator_id filter at the service layer. - [Broadcast a raw signed transaction](https://docs.relayer.fi/api-reference/transactions/broadcast-a-raw-signed-transaction.md): Broadcasts a raw signed transaction directly to the blockchain without saving it. Use this for transactions signed outside of this API. - [Broadcast a signed transaction](https://docs.relayer.fi/api-reference/transactions/broadcast-a-signed-transaction.md): Broadcasts a previously signed transaction to the blockchain. Only transactions belonging to the integrator can be broadcasted. The transaction must be in pending status and not expired. - [Cancel a pending transaction](https://docs.relayer.fi/api-reference/transactions/cancel-a-pending-transaction.md): Cancels a pending transaction. Only pending transactions can be cancelled. Only transactions belonging to the integrator can be cancelled. - [Get broadcast status](https://docs.relayer.fi/api-reference/transactions/get-broadcast-status.md): Retrieves the status of a broadcasted transaction including confirmations. Only transactions belonging to the integrator can be accessed. - [Get signed transaction details](https://docs.relayer.fi/api-reference/transactions/get-signed-transaction-details.md): Retrieves details of a signed transaction. Only transactions belonging to the integrator can be accessed. - [List signed transactions](https://docs.relayer.fi/api-reference/transactions/list-signed-transactions.md): Lists signed transactions for the integrator. Can be filtered by status. - [List transactions awaiting passkey signature](https://docs.relayer.fi/api-reference/transactions/list-transactions-awaiting-passkey-signature.md): Returns transactions with awaiting_signature status for the integrator. These are transactions that have been prepared (or approved) and are waiting for the integrator to sign with their passkey. - [Retry broadcasting a failed transaction](https://docs.relayer.fi/api-reference/transactions/retry-broadcasting-a-failed-transaction.md): Retries broadcasting a transaction that previously failed. Only failed transactions can be retried. Only transactions belonging to the integrator can be retried. - [AI Assistants](https://docs.relayer.fi/get-started/ai-assistants.md): Connect Relayer docs to Claude Code, Cursor, ChatGPT, and any MCP-compatible tool - [Authentication](https://docs.relayer.fi/get-started/authentication.md): Three auth modes — API key for your backend, HMAC for agents, session JWT for the dashboard - [Changelog](https://docs.relayer.fi/get-started/changelog.md): Release history for the Relayer API - [What is Relayer?](https://docs.relayer.fi/get-started/overview.md): Self-custodial stablecoin infrastructure — built for the operators of today and the agents of tomorrow - [Quickstart](https://docs.relayer.fi/get-started/quickstart.md): Make your first API call in under 5 minutes - [SDKs](https://docs.relayer.fi/get-started/sdks.md): Published TypeScript/React packages for the Relayer platform — what each one does and when to use it. - [Payout Endpoints](https://docs.relayer.fi/payout/endpoints.md): Accounts (virtual accounts, payments), on-ramp, off-ramp, recipients, and orders reference - [Payout Flow Guide](https://docs.relayer.fi/payout/flow-guide.md): Execute an end-to-end fiat payout — from recipient onboarding to bank settlement - [Payout Kit](https://docs.relayer.fi/payout/overview.md): Fiat on/off-ramp — virtual accounts, recipient management, and settlement - [Architecture Overview](https://docs.relayer.fi/shared/architecture.md): How Relayer Kits relate to each other and to your application - [Auth & Custody Model](https://docs.relayer.fi/shared/auth-model.md): Self-custodial guarantee + two dimensions of choice (key holder × pre-authorization scope). Read this before designing your integration. - [Error Reference](https://docs.relayer.fi/shared/error-reference.md): HTTP status codes, error response format, common business errors, and retry guidance - [Glossary](https://docs.relayer.fi/shared/glossary.md): Domain terminology for Relayer and crypto B2B infrastructure - [Signing Endpoints](https://docs.relayer.fi/signing/endpoints.md): Wallet management, transaction prepare/confirm, passkeys, recovery, policies, and approval flows - [Signing Flow Guide](https://docs.relayer.fi/signing/flow-guide.md): Register a passkey, create a wallet, sign a transaction, and broadcast — using the prepare/confirm pattern - [Signing Kit](https://docs.relayer.fi/signing/overview.md): Self-custodial wallets, transaction prepare/confirm, and passkey-based signing - [Installation](https://docs.relayer.fi/widget/installation.md): Install @relayerfi/widget-kit-react and configure providers for Passkey Signing or Metadata Mode integration - [Integration Guide](https://docs.relayer.fi/widget/integration.md): Integrate widgets using Passkey Signing (passkey) or Metadata Mode (bring your own wallet) — with examples for Swap, Transfer, and Crosschain - [Widget Kit](https://docs.relayer.fi/widget/overview.md): Embed self-custodial blockchain widgets — Swap, Transfer, Bridge — with hosted passkey signing or your own wallet stack - [Relayer SDK](https://docs.relayer.fi/widget/sdk.md): TypeScript SDK for building blockchain action metadata — works identically in both Passkey Signing and Metadata Mode ## OpenAPI Specs - [openapi](https://docs.relayer.fi/api-reference/openapi.json) ## Optional - [Website](https://relayer.fi) - [GitHub](https://github.com/relayerfi)