Skip to main content
POST
Start a card checkout
Opens the purchase and returns both the hosted card URL to render and the order to poll. Amount, currency, payment method and country are locked in before the buyer sees the page, so it opens on the payment step. Poll Get a card order for settlement.

Authorizations

x-calm-publishable-key
string
header
required

Publishable key identifying the calling app.

Body

application/json
amount
string
required
Pattern: ^\d{1,12}(\.\d{1,8})?$
country
string
required
Pattern: ^[A-Z]{2}$
currency
enum<string>
required
Available options:
USD,
GBP,
EUR
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_method
string
required
Pattern: ^[a-z0-9-]{2,32}$
wallet
string
required
Pattern: ^0x[a-fA-F0-9]{40}$
trade_type
enum<string>
default:EXACT_INPUT
Available options:
EXACT_INPUT,
EXACT_OUTPUT

Response

The started card checkout.

order_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)$
url
string<uri>
required