Generate a fresh sale/checkout from this page (iCount generate_sale equivalent)

Authorization

X-Api-Key<token>

Business API key, e.g. vuz_ab12cdef... Created via Settings → Integrations → API Keys. Unlike partner keys, a public API key's STRING does not encode its environment — isolation instead comes from a completely separate sandbox database: a key minted on the Sandbox server (above) only ever reads/writes sandbox data and can never see or affect production, regardless of what the key looks like.

In: header

Path Parameters

pageId*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

items?array<>

Explicit cart for this sale

description?string

Single-line description (used with sum when items is omitted)

sum?number

Single-line amount (used with description when items is omitted)

xOrderId?string

Merchant's external order id (echoed back, stored on the checkout)

successUrl?string

Override the success redirect URL for this sale only

failureUrl?string

Override the failure redirect URL for this sale only

cancelUrl?string

Override the cancel redirect URL for this sale only

customer?

Pre-fill customer details for this sale

metadata?

Merchant passthrough metadata for this sale (webhooks-automation plan §1.1). Merged over the page's own default metadata (this sale wins on key collision), threaded onto the issued document + outbound webhook events. Max 12 keys, key ≤40 chars, scalar values ≤500 chars, total ≤8KB.

expiresInMinutes?number

Per-sale checkout TTL override, in minutes (bounds 5..43200 / 30 days). Defaults to page.defaultSaleTtlMinutes, else 120 (one-time) / 20160 (recurring).

Range5 <= value <= 43200

payerFields?

Pre-answered values for the page's payerFieldsConfig custom fields (the API caller already knows them). Unknown keys (not present in payerFieldsConfig) are rejected. The payer-facing form then hides any pre-filled required fields.

Response Body

`application/json`

curl -X POST "https://example.com/payment-pages/string/sales" \  -H "Content-Type: application/json" \  -d '{}'

{  "saleUniqId": "chk_9f2a1c3e4b5d",  "saleUrl": "string"}