Skip to main content
GET
Get a Stripe onramp order
The settlement status of one onramp order, scoped to the wallet in the path. Poll it after checkout until the order reaches a terminal state.

Authorizations

x-calm-publishable-key
string
header
required

Publishable key identifying the calling app.

Path Parameters

id
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Query Parameters

wallet
string
required
Pattern: ^0x[a-fA-F0-9]{40}$

Response

The onramp order.

address
string
required
Pattern: ^0x[a-fA-F0-9]{40}$
created_at
string<date-time>
required
destination_amount
string | null
required
destination_chain
integer
required

Chain id. Currently 1, 8453, 999, 1337, 4326, 143, 137, 42161 — additive; tolerate unknown values.

Required range: -9007199254740991 <= x <= 9007199254740991
destination_currency
string
required
destination_network
string
required
id
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
source_amount
string | null
required
source_currency
string
required
status
enum<string>
required
Available options:
initialized,
requires_payment,
fulfillment_processing,
fulfillment_complete,
rejected,
error