Skip to main content
POST
Start a payment attempt

Path Parameters

id
string
required
Pattern: ^[1-9A-HJ-NP-Za-km-z]{21,22}$

Body

application/json
paymentMethod
enum<string>
required
Available options:
sol,
usdc_solana,
eth_base,
usdc_base,
usdt_base,
eth,
usdc_ethereum,
usdt_ethereum,
matic,
usdc_polygon,
usdt_polygon,
bnb,
usdt_bnb

Response

The checkout, with the new activeAttempt.

type
string
required
Allowed value: "order"
id
string
required

Public short id — the value that appears in checkout links.

storeId
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)$
status
enum<string>
required
Available options:
pending,
completed,
partial,
expired
priceAmount
string
required

Fiat amount as a decimal string, e.g. "9.99". Never a number.

priceCurrency
enum<string>
required
Available options:
usd,
eur
successUrl
string | null
required
cancelUrl
string | null
required
expiresAt
string<date-time>
required

ISO-8601 timestamp in UTC.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
completedAt
string<date-time> | null
required

ISO-8601 timestamp in UTC.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
items
object[]
required
hasCustomerEmail
boolean
required
store
object
required
activeAttempt
object | null
required