Skip to content
LogoLogo

Getting Started

Use BLOX APIs to build applications that use MYRC. Integrate Wallet, Onramp, and Payout into your platform.

To start with working code, follow the product guides: Wallet · Onramp · Payout.

API products

First call in 5 minutes

Get API credentials

To enable API key access for your account (sandbox and production), contact the BLOX team. Register a signing public key with your API key.

Authenticate

  • API Key: the blox-api-key header (or Authorization: Bearer)
  • Request Signature: RFC 9421, for POST/PUT/PATCH/DELETE

Read requests need only the API key. For write requests, refer to Request Signing.

Call health

{
  "success": true,
  "message": "API key is valid",
  "account": {
    "id": "c741a292-5682-4b75-8f49-ebd87e7785a1",
    "name": "Your Business Name",
    "type": "BUSINESS",
    "status": "ACTIVE"
  }
}

For the base URLs and the chains, refer to Environments.

Typical flows

ProductFlow
OnrampCreate a checkout → the customer pays → get the result from a webhook event or a status request
WalletCreate a token transfer or a fiat withdrawal → send GET with its ID until the status changes
PayoutSend a top-up to your prefund balance → create a payout → get the result from a webhook event or a status request

For Mermaid sequence diagrams and step-by-step instructions, refer to Integration Flows.

Next

For LLMs & agents

Machine-readable documentation for coding agents and chat tools:

  • /llms.txt — an index of all pages, with a one-line description of each page
  • /llms-full.txt — the full documentation in one markdown file
  • Raw markdown for each page under /assets/md/, at the path of the page with .md added (for example, /assets/md/api/getting-started.md). You can also use Copy as Markdown on each page.

Support