Introduction

Heron provides a single API for building cross-border payment workflows across supported fiat and crypto rails. Use it to onboard customers, discover available routes, request quotes, create transfers, and reconcile the result.

Heron normalizes the customer-facing workflow while preserving the rail, provider, and compliance details needed to operate each payment. Availability is environment-specific, so use GET /v1/rails and the provider catalog as the source of truth instead of hardcoding coverage.

Core concepts

• Entities hold the KYC or KYB information used to onboard an individual or business.
• Provider connections track onboarding and readiness for the providers an entity uses.
• Fiat accounts and crypto wallets are saved transfer destinations.
• Quotes compare the available execution options for an amount and route.
• Transfers bind a quote option to a destination and track execution through a normalized lifecycle.
• Customer webhooks notify your systems when transfers, transfer legs, or provider onboarding states change.
• Reports produce versioned CSV or ISO 20022 exports for reconciliation.

A typical integration

1. Create an API key and keep sandbox and production credentials separate.
2. Create or select an entity, then complete the requirements for the providers it needs.
3. Discover an active rail and save the destination account or wallet.
4. Request quotes and select an unexpired quote option.
5. Create the transfer with an idempotency key.
6. Follow transfer updates by webhook and retrieve reports for reconciliation.

Start with Getting Started, then use the focused guides for identity onboarding, quotes, and transfers.