Skip to main content
POST
Create a fiat order

Authorizations

x-api-key
string
header
required

Soft-auth read routes accept x-api-key with a publishable or partner key; money-moving routes require a secret partner key in Authorization: Bearer.

Body

application/json
srcAmount
string
required

Fiat amount to spend (decimal string).

Example:

"100"

srcCurrency
string
required

Fiat currency code (ISO 4217).

Example:

"USD"

dstCurrency
string
required

Destination crypto asset symbol.

Example:

"USDC"

dstChain
string
required

Destination chain code, as used by the fiat provider. Read the supported set from the onramp config endpoint rather than assuming it matches a chain id.

Example:

"base"

walletAddress
string
required

Payer wallet address (required for checkout).

Example:

"0x…"

paymentMode
string

Payment method code.

Example:

"card"

email
string

Payer email, forwarded to the hosted KYC flow. Never stored by Hypermid.

returnUrl
string

Post-payment return URL. Only honoured when its origin is in ONRAMP_RETURN_ORIGINS; otherwise the default is used (open-redirect guard).

Response

201 - undefined