Skip to content
Navigation

CreateOrderRequest

Fields

  • product_id
    string
    required

    Sellable variant UUID: use the id returned by the products endpoint.

    For sandbox keys, this selects the static response scenario:

    • 018f0000-0000-7000-8000-000000000001 (sandbox-success-voucher): Static sandbox product that returns a fulfilled voucher order. Poll it with order_id 1CAYVN8V9qVvrLwnnSZsPE.
    • 018f0000-0000-7000-8000-000000000002 (sandbox-wallet-topup-required): Static sandbox product that returns an action-required wallet order. Poll it with order_id 1CAYVN8V9qVvrLwnnSZsPF.
    • 018f0000-0000-7000-8000-000000000003 (sandbox-merchant-attention-required): Static sandbox product that returns a fulfillment action-required order. Poll it with order_id 1CAYVN8V9qVvrLwnnSZsPG.
    • 018f0000-0000-7000-8000-000000000004 (sandbox-manual-review-required): Static sandbox product that returns a manual-review action-required order. Poll it with order_id 1CAYVN8V9qVvrLwnnSZsPH.
    • 018f0000-0000-7000-8000-000000000005 (sandbox-failed-order): Static sandbox product that returns a failed fulfillment response. Poll it with order_id 1CAYVN8V9qVvrLwnnSZsPJ.
    format: uuid
  • quantity
    integer
    required
    minimum: 1
  • merchant_order_ref
    optional
    string
    or null

    Optional store-scoped merchant order reference. Reusing the same value for the same store returns 409 merchant_order_ref_already_used and does not create another order. If you lose the create response, pass this value as {id} when polling order status.

    maxLength: 128
  • recipient
    optional
    object

    For voucher products, name/email/mobile are optional delivery details. For top-ups, send every canonical key advertised in recipient_fields by the catalog. PUBG normally requires player_id; Mobile Legends requires player_id and zone_id. Other products may require region_id or arbitrary configured safe keys. Send values as nonblank strings to preserve leading zeros. Missing and unconfigured fields return 422 validation_failed before order creation or fulfillment. Never substitute provider-specific keys such as userId or account_id unless that exact canonical key is configured on the Product.

    • name
      optional
      string
    • email
      optional
      string
      format: email
    • mobile
      optional
      string
    • player_id
      optional
      string
    • zone_id
      optional
      string
    • server_id
      optional
      string
    • region_id
      optional
      string
    • account_tag
      optional
      string
  • webhook_url
    optional
    string
    or null

    Optional HTTPS callback URL for this order.

    format: uri

Type to search…

↑↓ navigate↵ selectEsc close