Skip to main content

CreateIframeSessionRequest

amountinteger<int64>required

Possible values: >= 1 and <= 99999999

cancelUrlstringnullable
currencystringrequired

Possible values: non-empty

descriptionstringnullable
lineItems object[]nullable
  • Array [
    • categoryCodestringnullable

    Tax-provider category code, matched against configured category tax rules.

    descriptionstringnullable
    namestringnullable
    priceIdstringnullable

    Catalog price identifier. The line is charged and stored at this price's unitAmount.

    quantityinteger<int32>

    Possible values: >= 1

    taxAmountinteger<int64>nullable

    Exact line tax in minor units, required only in PRECOMPUTED mode. Not a per-unit amount.

    Possible values: >= 0

    taxablebooleannullable

    Whether a custom line is taxable. Catalog tax treatment is authoritative.

    unitPriceinteger<int64>nullable

    Unit price in minor currency units for a custom line without priceId. Must not be sent with priceId; catalog lines are charged at the catalog price.

    Possible values: >= 0

  • ]
    • locationIdstring
    merchantIdstring
    successUrlstringnullable
    taxModeCheckoutTaxMode

    Possible values: [AUTOMATIC, PRECOMPUTED]

    theme objectnullable
    property name*string
    totalTaxinteger<int64>nullable

    Possible values: >= 0

    CreateIframeSessionRequest
    {
      "amount": 0,
      "cancelUrl": "string",
      "currency": "string",
      "description": "string",
      "lineItems": [
        {
          "categoryCode": "string",
          "description": "string",
          "name": "string",
          "priceId": "string",
          "quantity": 0,
          "taxAmount": 0,
          "taxable": true,
          "unitPrice": 0
        }
      ],
      "locationId": "string",
      "merchantId": "string",
      "successUrl": "string",
      "taxMode": "AUTOMATIC",
      "theme": {},
      "totalTax": 0
    }