Skip to main content
POST
Open a Stripe onramp session
Opens the onramp session that the rest of the flow runs against. Returns Stripe’s session_id for the client SDK’s performCheckout, plus a Calm order_id to poll at Get a Stripe onramp order.

Authorizations

x-calm-publishable-key
string
header
required

Publishable key identifying the calling app.

Body

application/json
crypto_customer_id
string
required
Minimum string length: 1
destination_chain
enum<number>
required
Available options:
1,
8453,
999,
1337,
4326,
143,
137,
42161
destination_token
enum<string>
required
Available options:
USDC,
USDm,
AUSD,
USDC.e
payment_token
string
required
Minimum string length: 1
wallet
string
required
Pattern: ^0x[a-fA-F0-9]{40}$
destination_amount
string
Pattern: ^\d+(\.\d+)?$
source_amount
string
Pattern: ^\d+(\.\d+)?$
source_currency
string
default:USD
Allowed value: "USD"

Response

The opened onramp session.

destination_amount
string | null
required
order_id
string
required
quote_expires_at
number | null
required
session_id
string
required
source_amount
string | null
required
status
string
required