Core Concepts

How Bluerails Works: The Flow

Get Started 🚀

Welcome to Bluerails: Stablecoin infrastructure for global payments and treasury.

Introduction

Bluerails

Understanding Organizations: The top-level container for your resources in Bluerails.

Organizations

Accounts hold asset balances and facilitate transactions within your Bluerails Organization.

Accounts

Understanding Payins: How funds flow into your Bluerails Accounts.

Payins (Inbound)

Understanding Payouts: How funds flow out from your Bluerails Accounts.

Payouts (Outbound)

Authenticating your requests to the Bluerails API using your Organization ID and API Key.

Authentication

Handling paginated results in the Bluerails API using cursor-based pagination.

Pagination

Creates a new financial account in your organization.

Accounts serve as containers for tracking balances and processing transactions.
Each account can be classified as PRIMARY or SECONDARY, with only one PRIMARY
account allowed per organization. The account purpose helps organize funds
according to their intended use (operating, revenue, tax, etc.).

New accounts are created with ACTIVE status by default and can immediately
receive funds and process transactions.

Create Account

Retrieves detailed information about a specific account.

Returns the complete account object including its current status, classification,
purpose, and any associated metadata. Use this to verify account details before
initiating transactions or to check account status.

Get Account

Lists all accounts in your organization with pagination support.

Returns a paginated list of all accounts, sorted by creation date (newest first).
Use this to display account overviews, build account selectors, or audit your
account structure. Results include both active and inactive accounts.

List Accounts

Updates an existing account's properties.

Modify account details such as name, description, classification, or metadata.
Note that some properties like account status and purpose cannot be changed
through this endpoint. Changing classification from SECONDARY to PRIMARY will
fail if a PRIMARY account already exists.

Update Account

Get Payin

List Payments

Create a stablecoin payout to withdraw funds to an external blockchain address.

This endpoint initiates a stablecoin withdrawal from your account to any valid
blockchain address. You can fund the payout in two ways:

1. **Direct funding**: Specify the exact amount and asset to send
- Example: Send exactly 100 USDC_SOL to a Solana address

The payout will be processed on the specified blockchain network and you'll receive
a transaction signature once it's broadcast. The payout status will update as it
gets confirmed on-chain.

```

Create Stablecoin Payout

Accept a quote and create the corresponding payout.

Executes a previously fetched quote to create a payout with the locked-in exchange rate.
The quote must be valid (not expired) and unused. Once accepted, the conversion happens
at the quoted rate regardless of market movements.

For crypto payouts, you'll need to provide the destination address and chain.
For fiat payouts, you'll need to provide the beneficiary details.

Accept Quote

Get detailed information about a specific payout.

Retrieve complete details for a single payout including its current status,
transaction details, fees, and any method-specific information. For stablecoin payouts,
this includes blockchain transaction signatures and confirmation counts.

Use this endpoint to track payout progress, verify completion, or investigate issues.

Get Payout

Get a quote for currency exchange to prepare a payout.

Request a real-time quote to convert between currencies before initiating a payout.
The quote will lock in an exchange rate for a limited time period (typically 30 seconds)
and can be used to create a payout with predictable conversion amounts.

Quotes are essential when you need to:
- Convert crypto to fiat (e.g., USDC to INR or PHP)
- Display exact amounts to users before confirmation
- Ensure rate consistency between quote and execution

Get Quote

List all payouts for your organization with pagination.

Retrieve a paginated list of all payouts, sorted by creation date (newest first).
Use pagination parameters to navigate through large result sets. Results can be
filtered by various criteria including status, method, date range, and more.

Each payout in the response includes its current status, amounts, and relevant
details based on the payout method (crypto or fiat).

Introduction

Core Concepts

API Fundamentals

Account

Payins

Payouts

​Core Concepts

Organizations

Accounts

Payins (Inbound)

Payouts (Outbound)

​How Bluerails Works: The Flow

​Get Started 🚀

Core Concepts

How Bluerails Works: The Flow

Get Started 🚀