Skip to main content

OrderCreateRequest

checkOnlyCheckonly

If true, performs a DTU validation (quote + provider check) without creating an order.

Default value: false
orders object[]required

Single order (exactly one item).

Possible values: >= 1, <= 1

  • Array [
    • amountCurrencyCode object

    Optional currency code for interpreting the amount field in DTU open range requests (e.g. RUB, KZT, UAH). When set, the backend converts the entered amount to USD and rounds USD up to the provider min/step.

    anyOf
    string
    denominationIdDenominationidrequired

    Item/denomination id from GET /services catalog.

    fields object[]

    Extra fields required by some products. For DTU orders, account_reference is typically required.

  • Array [
    • keyKeyrequired

    Field key (e.g. account_reference for DTU orders).

    valueValuerequired

    Field value.

  • ]
    • isLongOrderIslongorder

    If true, places a long order (may be delivered asynchronously). Applicable only for ordersType=shop. Use isLongOrder / minQtyToLongOrder from the catalog to decide when it is allowed.

    Default value: false
    quantityQuantity

    Quantity to purchase.

    Possible values: >= 1

    Default value: 1
  • ]
    • ordersTypeOrderstyperequired

    Order type. shop returns voucher codes, dtu performs direct top-up and returns DTU attributes, esim returns the supplier's eSIM activation payload (qrCodeText, iccid, ...) under result.esim, steam-gift places a Steam Gift order (requires quoteToken; delivery snapshot under result.steamGift). Feature-gated and default-off — returns HTTP 404 when disabled.

    Possible values: [shop, dtu, esim, steam-gift]

    quoteToken object

    Signed short-lived price quote from POST /steam-gifts/quotes (Public-API wrapper around the upstream token; larger than the upstream 4096 limit because of JWT embedding). Required for ordersType=steam-gift. Upstream re-validates the quote on create; sender region is chosen server-side.

    anyOf
    string

    Possible values: >= 32 characters and <= 16384 characters

    referenceId object

    Partner-provided idempotency key. Must be unique within your account. Required for purchases (checkOnly=false). Optional for DTU checks (checkOnly=true). Can be used as a filter in GET /orders?referenceId=....

    anyOf
    string

    Possible values: non-empty and <= 40 characters

    OrderCreateRequest
    {
      "checkOnly": false,
      "orders": [
        {
          "amountCurrencyCode": "string",
          "denominationId": "string",
          "fields": [
            {
              "key": "string",
              "value": "string"
            }
          ],
          "isLongOrder": false,
          "quantity": 1
        }
      ],
      "ordersType": "shop",
      "quoteToken": "string",
      "referenceId": "string"
    }