Create a hosted checkout session
create_checkout_sessionCreate a CoinVello hosted checkout session (an invoice plus a payment page at pay.coinvello.com). Redirect the customer to the returned url. Amounts are decimal strings. currency is an ISO code (USD, EUR...) or an asset id to price in crypto. Fulfil orders from the invoice.paid webhook, never from the redirect.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| tax | No | The tax portion of the sale as you computed it, in the invoice currency and included in `amount` (e.g. {"amount":"7.98","rate":"0.19","label":"VAT 19%","jurisdiction":"DE"}); copied to the records and exports. jurisdiction is a code you choose, never anything about the payer. | |
| amount | Yes | Total to charge, e.g. "49.99". | |
| locale | No | ||
| branding | No | ||
| currency | Yes | ISO 4217 code such as USD/EUR/GBP, or an asset id such as btc:bitcoin. | |
| customer | No | ||
| metadata | No | Up to 50 string key/value pairs returned on the object and in webhooks. | |
| order_id | No | Your order reference; indexed and searchable. | |
| cancel_url | No | ||
| expires_in | No | Seconds until expiry (default 1800). | |
| line_items | No | ||
| description | No | ||
| redirect_on | No | When the hosted page redirects to success_url (default confirming). | |
| success_url | Yes | Where the hosted page sends the customer after payment. | |
| collect_email | No | ||
| accepted_assets | No | Assets the customer may pay with; defaults to all assets with an enabled wallet. | |
| idempotency_key | No | Stable key per order so retries do not create duplicate sessions, e.g. order-123-checkout. |