Skip to main content

OrcaRail API Documentation

Welcome to the OrcaRail API documentation. OrcaRail provides a standard, developer-friendly API and SDKs for accepting crypto payments with stablecoins.

Quick Start​

  1. Open the Dashboard and sign up (or sign in); see Create an account.
  2. Create your first organization after sign-in. OrcaRail requires an organization before you can continue in the dashboard.
  3. Create API keys from Dashboard → API Keys.
  4. Use the Node.js SDK or PHP SDK, or try the demo.
  5. Create a Payment Intent to start accepting payments.

What is OrcaRail?​

OrcaRail enables you to accept crypto payments from your customers using stablecoins. With OrcaRail, you can:

  • ✅ Accept stablecoin payments (USDC, USDT, etc.)
  • ✅ Create payment intents with hosted pay
  • ✅ Receive real-time webhook notifications
  • ✅ Support multiple blockchain networks (multichain overview)
  • ✅ Run recurring billing with subscriptions, including auto-charge on EVM and Solana
  • ✅ Manage payments with a standard, friendly API and SDKs

Pricing: Hosted OrcaRail costs 0.5% of each completed transaction with 1,000 transactions free to start; self-hosted deployment has no software fee from us. Developer SDKs, MCP, and plugins are MIT; the hosted api / app / pay stack is not published as open source. Payment quotes can include separate optional line items (support, commission, bridge) — see Fees & limits.

Key Features​

Payment Intents​

Create Payment Intents to collect payments from your customers. The flow is simple:

  1. Create a Payment Intent
  2. Confirm it to get a redirect URL
  3. Redirect customers to hosted pay
  4. Receive webhook notifications

Learn more about Payment Intents →

Subscriptions​

Collect recurring crypto payments with OrcaRail's subscription API: fixed intervals, trials, payment links per cycle, or auto-charge (periodic pull after payer approval on EVM or Solana).

Subscriptions overview →

Multichain​

Accept on many networks, configure withdrawal addresses per chain type, and keep supported chains and tokens in sync with Relay. Live lists appear in Networks and tokens.

Multichain overview →

Webhooks​

Receive real-time notifications about payment events:

  • payment_intent.completed - Payment completed
  • payment_intent.processing - Payment processing
  • payment_intent.canceled - Payment canceled

Configure webhooks per API key and monitor delivery with webhook logs.

Learn more about Webhooks →

Authentication​

OrcaRail supports two authentication methods:

  • Bearer Tokens (JWT) - For user-authenticated requests
  • API Keys (Basic Auth) - For server-to-server requests

Learn more about Authentication →

Node.js SDK​

Integrate payments with the official SDK. Install from npm: @orcarail/node.

  • Create and confirm Payment Intents
  • Pay by slug
  • Verify webhook signatures and parse events

Node.js SDK guide →

PHP SDK​

Integrate payments from PHP 8.1+ with the official orcarail/orcarail-php Composer package.

  • One OrcaRailClient with lazy service properties
  • Payment Intents, subscriptions, pay by slug, catalog, and rates
  • Verify webhook signatures and parse events

PHP SDK guide →

MCP Server​

Connect AI coding agents — Claude Code, Cursor, Codex — with the official @orcarail/mcp Model Context Protocol server.

  • Create and confirm Payment Intents from your agent
  • Manage subscriptions, products, and prices
  • Look up exchange rates and hosted pay details (no credentials required for rates.* / pay.*)

MCP server guide →

Demo App​

Run the open-source demo to see a full flow: create intent, redirect to hosted pay, success page, and webhooks.

Demo app guide →

Getting Started​

New to OrcaRail? Start here:

Your first dashboard session requires creating an organization before you can create API keys.

  1. Getting Started - Create an account, create an organization, and create API keys
  2. Node.js SDK - Integrate with @orcarail/node, or the PHP SDK with orcarail/orcarail-php
  3. Demo app - Run the open-source demo (GitHub)
  4. Payment Intents Guide - Learn how to accept payments
  5. Webhooks Guide - Set up payment notifications
  6. Webhook Configuration - Configure webhooks for your API keys
  7. Subscriptions - Recurring payments and auto-charge
  8. Multichain - Networks, withdrawals, and Relay alignment
  9. API Reference - Complete API documentation

Need Help?​

Support​

For support, please contact us at [email protected] or visit our GitHub repository.