# OrcaRail

> OrcaRail is a developer-friendly crypto payment gateway for accepting stablecoin payments (USDC, USDT, and more) across multiple blockchain networks. It provides a standard REST API, hosted pay pages, webhook notifications, recurring subscriptions with auto-charge, and an official Node.js SDK.

Important notes:

- OrcaRail is a crypto payment gateway — it is **not** a traditional fiat payment processor
- All amounts are denominated in stablecoins on supported blockchain networks (EVM chains, Solana, and more)
- The primary payment object is the **Payment Intent** — create, confirm, redirect the customer, then handle webhook events
- Authentication uses **API Key + Secret** (Basic Auth) for server-to-server requests, or **Bearer Token (JWT)** for user-authenticated requests
- The official Node.js SDK is [`@orcarail/node`](https://www.npmjs.com/package/@orcarail/node)
- The API base URL is `https://api.orcarail.com`
- The dashboard is at `https://app.orcarail.com`

## Getting Started

- [Getting Started](https://docs.orcarail.com/docs/getting-started): Create an account, set up an organization, create API keys, and make your first payment
- [Build with AI](https://docs.orcarail.com/docs/building-with-ai): Use AI agents and LLMs to help build your OrcaRail integration

## Payment Intents

- [Payment Intents Overview](https://docs.orcarail.com/docs/payment-intents/overview): Learn how payment intents work — create, confirm, redirect, and receive webhooks
- [Create a Payment Intent](https://docs.orcarail.com/docs/payment-intents/create): Create a new payment intent with amount, currency, token, and network
- [Confirm a Payment Intent](https://docs.orcarail.com/docs/payment-intents/confirm): Confirm a payment intent to get the hosted pay redirect URL
- [Retrieve a Payment Intent](https://docs.orcarail.com/docs/payment-intents/retrieve): Fetch the current status of a payment intent
- [Update a Payment Intent](https://docs.orcarail.com/docs/payment-intents/update): Modify a payment intent before confirmation

## Subscriptions

- [Subscriptions Overview](https://docs.orcarail.com/docs/subscriptions/overview): Recurring crypto payments with fixed intervals, trials, and auto-charge
- [Create a Subscription](https://docs.orcarail.com/docs/subscriptions/create-subscription): Set up a new recurring payment subscription
- [Manage Subscriptions](https://docs.orcarail.com/docs/subscriptions/manage-subscriptions): Update, pause, cancel, and resume subscriptions
- [Auto-Charge](https://docs.orcarail.com/docs/subscriptions/auto-charge): Automatic periodic pulls after payer approval on EVM and Solana
- [Subscription Webhooks](https://docs.orcarail.com/docs/subscriptions/webhooks): Events for subscription lifecycle changes
- [Subscription SDK](https://docs.orcarail.com/docs/subscriptions/sdk): SDK methods for managing subscriptions
- [Trials](https://docs.orcarail.com/docs/subscriptions/trials): Set up free trial periods before charging

## Webhooks

- [Webhooks Overview](https://docs.orcarail.com/docs/webhooks/overview): Real-time notifications for payment and subscription events
- [Webhook Configuration](https://docs.orcarail.com/docs/webhooks/configuration): Configure webhook endpoints per API key
- [Webhook Events](https://docs.orcarail.com/docs/webhooks/events): Complete list of webhook event types and payloads
- [Webhook Signatures](https://docs.orcarail.com/docs/webhooks/signatures): Verify webhook authenticity using HMAC signatures

## Authentication

- [Authentication Overview](https://docs.orcarail.com/docs/authentication/overview): Supported authentication methods
- [API Keys](https://docs.orcarail.com/docs/authentication/api-keys): Create and manage API keys for server-to-server requests
- [Bearer Tokens](https://docs.orcarail.com/docs/authentication/bearer-tokens): JWT-based authentication for user-authenticated requests

## Integration

- [Node.js SDK](https://docs.orcarail.com/docs/integration/node-sdk): Install and use the official `@orcarail/node` SDK
- [Node.js SDK API Reference](https://docs.orcarail.com/docs/integration/node-sdk-api-reference): Complete SDK method reference

## Fees & Limits

- [Fees & Limits Overview](https://docs.orcarail.com/docs/fees-and-limits/overview): Pricing tiers for hosted and self-hosted deployments
- [Fees](https://docs.orcarail.com/docs/fees-and-limits/fees): Transaction fees and optional line items
- [Payment Minimums](https://docs.orcarail.com/docs/fees-and-limits/payment-minimums): Minimum payment amounts per network
- [Withdrawal Minimums](https://docs.orcarail.com/docs/fees-and-limits/withdrawal-minimums): Minimum withdrawal thresholds

## Reference

- [Multichain Overview](https://docs.orcarail.com/docs/reference/multichain): Supported blockchain networks and chain-type configuration
- [Networks and Tokens](https://docs.orcarail.com/docs/reference/networks-and-tokens): Live lists of supported networks, tokens, and addresses

## Withdrawals

- [Withdrawal Strategy](https://docs.orcarail.com/docs/withdrawals/strategy): Configure withdrawal addresses and strategies
- [Gas & Fees](https://docs.orcarail.com/docs/withdrawals/gas-and-fees): Gas funding and fee management for withdrawals

## API Reference

- [Payment Intents API](https://docs.orcarail.com/docs/api-reference/payment-intents): Create, confirm, retrieve, and list payment intents
- [Payments API](https://docs.orcarail.com/docs/api-reference/payments): Query completed payments
- [Pay API](https://docs.orcarail.com/docs/api-reference/pay): Hosted pay page and pay-by-slug endpoints
- [Dashboard API](https://docs.orcarail.com/docs/api-reference/dashboard): Dashboard data endpoints
- [Withdrawals API](https://docs.orcarail.com/docs/api-reference/withdrawals): Manage merchant withdrawals
- [Price API](https://docs.orcarail.com/docs/api-reference/price): Token price and conversion endpoints
- [Webhooks API](https://docs.orcarail.com/docs/api-reference/webhooks): Webhook configuration and delivery logs
- [API Keys API](https://docs.orcarail.com/docs/api-reference/api-keys): Manage API keys programmatically
- [Authentication API](https://docs.orcarail.com/docs/api-reference/authentication): Login, register, and token management

## Examples

- [Demo App](https://docs.orcarail.com/docs/examples/demo): Full integration example with source code on GitHub

## Optional

- [GitHub Repository](https://github.com/orcarail/orcarail)
- [npm Package](https://www.npmjs.com/package/@orcarail/node)
- [Support](mailto:support@orcarail.com)