CreateCheckoutSessionDto

reference
Type: string
required

Your own reference, and the handle you will find this by. Required: we never invent one, because a reference we made up is not one you can reconcile against.
allowed_rails
Type: array of "crypto" or "fiat"enum

Restrict how the payer may pay. Omit to offer everything.
amount
Type: number

What to charge, in USD. Omit it and the line items are added up instead; send both and they must agree.
cancel_url
Type: string

Where a payer who gives up is returned to.
collect
Type: array of stringenum

Details to ask the payer for, on top of whatever the rail already needs. A mobile-money payer is asked for their number either way.

values
emailphonenamebilling_address
currency
Type: string

Display currency. Settlement is always USD.
customer_id
Type: string

The customer this is for, if you already hold one.
expires_at
Type: string

When the session stops accepting payment. Defaults to 24 hours, which is long enough for somebody to finish a bank transfer tomorrow morning.
line_items
Type:

What the payer is buying, shown on the page. Display only — we do not price, tax or ship them.

Properties: 3
metadata
Type: object

Arbitrary key/value data you control.
success_url
Type: string

Where the payer lands once they have paid. {CHECKOUT_SESSION_ID} is replaced, so your page can read the result without waiting for the webhook.
title
Type: string

Shown to the payer as the headline.