Skip to main content
POST
Start a crypto top-up

Authorizations

Authorization
string
header
required

Dashboard JWT token from Clerk

Headers

Idempotency-Key
string

Stripe-style idempotency token. Pass a stable, client-generated value (1-255 chars) to dedupe retries on transient timeouts. The same key+credential+path replays the original response for 24h on 2xx (5min on 4xx, 30s on 5xx). Returns 409 if a concurrent request with the same key is already in flight; replayed responses include the Idempotency-Replay: true response header.

Required string length: 1 - 255
X-Test-Mode
enum<string>

Sandbox opt-in for Clerk-session-authenticated requests. Set to true to route the call through the test-mode pipeline: no real provider delivery, no credits deducted, response meta.test_mode: true. Ignored for live API keys (dv_live_sk_*) — server-to-server clients must use a test-prefixed key (dv_test_sk_*) to exercise sandbox. Test-prefixed keys unconditionally enable sandbox regardless of this header.

Available options:
true,
false

Body

application/json
amount
integer
required

Top-up amount in USD cents (minimum $1.00; e.g. 5000 = $50.00). The wallet ceiling per top-up mirrors the card top-up cap.

Required range: x >= 100
successUrl
string<uri>
required

URL the provider redirects to on payment confirmation (e.g. https://orbit.devotel.io/billing?crypto=success). Must use a trusted Orbit origin (orbit.devotel.io).

cancelUrl
string<uri>
required

URL the provider redirects to when the customer closes the invoice (e.g. https://orbit.devotel.io/billing?crypto=cancelled). Must use a trusted Orbit origin (orbit.devotel.io).

currency
enum<string>
default:usd

Invoice currency. Only usd is supported while the wallet ledger is USD-only.

Available options:
usd

Response

The created crypto top-up intent — intentId (pass to GET /billing/crypto-topup/{intentId}/status to follow the payment) and checkoutUrl (the hosted invoice URL to redirect the customer to) — in the standard { data, meta } envelope.

The created crypto top-up intent — intentId (pass to GET /billing/crypto-topup/{intentId}/status to follow the payment) and checkoutUrl (the hosted invoice URL to redirect the customer to) — in the standard { data, meta } envelope.