Skip to main content
This tab is the endpoints: what each call takes, what it returns, and a playground to try it with your own key. Every endpoint page is generated from the API’s own OpenAPI document at /openapi.json, so a page cannot describe a call the API does not make. How the products work, the order of calls and what to credit on are in Documentation.

Base URL

Every example in this reference uses $RHEON_API as the base, and every endpoint lives under /v1.

Authentication

Every call takes your API key as a Bearer token. The header, and what a refusal looks like, are on Authentication.

Configuration

What your key may use: products, chains, tokens, the execution ceiling, and the card and bank corridors this deployment runs. Read it before your first call: GET /v1/config.

Reference lists

Countries, currencies, statuses, limits, payment methods and rates, served from the API so you never keep a copy. Why they come first: Rheon API. First endpoint: Countries.

Crypto deposits

Quote a cross-chain stablecoin deposit, build the unsigned transaction for the user’s wallet, poll it by receipt. Production on this deployment: real routes, real money once the user signs. The flow: Crypto deposits. First endpoint: Quote a deposit.

Cards

On-ramp: quote, verify the buyer, start the purchase on a hosted card page, poll it to settlement. Off-ramp: quote, create and poll a payout to a card the user holds. Provider sandbox on this deployment. The flow: On/off ramps with cards. First endpoint: Quote a card payment.

Bank transfers

On-ramp: onboard the user, send them through consent, poll until the money lands, or take a one-off deposit. Off-ramp: quote, create and poll a bank payout. Provider sandbox on this deployment. The flow: On-ramp and Off-ramp. First endpoint: Onboard a bank-transfer user.

Virtual accounts

Open permanent bank details bound to a wallet, read, update and list them, pay out from one. Provider sandbox on this deployment; whether read-back answers is stated by readBack in GET /v1/config. The flow: Virtual accounts. First endpoint: Open a virtual account.

Apple Pay

A payment method on the hosted card page, not an endpoint: the four card calls are unchanged and nothing in your request says Apple Pay. The flow: Apple Pay. Endpoint it rides on: Start a card purchase.

Orders

Every crypto deposit is an order with an id of ours; ask about it with that id, and report the signed transaction against it. The rule: Transaction statuses. First endpoint: What happened to my order.

Sandbox test calls

Two calls that exist only on sandbox deployments: simulate a bank pay-in to a virtual account, and force an identity-check result. The guide: Sandbox. First endpoint: Simulate a bank pay-in.

Health

GET /health answers { "ok": true } when the service is up, with no key and no rate limit. Use it for uptime checks.