Skip to main content

CreateOrderDTO

charge_feecharge fee (string)required

The amount you charge your customers

Default value: 0.00
Example: 0.00
tipstips (string)

Additional tips to be paid by customers

Default value: 0.00
Example: 0.00
currencycurrency code (string)required

currency code, eg HKD

reference_numberyour side unique number (string)required

your side unique number

due_datedue date (string)

If this date is exceeded, the order will be automatically voided

Example: 2024-01-01
notenote (string)

Note information for the order, needs to be less than 255 characters

line_items object[]

If you wish to display additional line item information

  • Array [
  • uuiduuid (string)

    UUID V4

    purchasable_typePurchasableType (string)required

    Possible values: [RearTips, Charge, Listing]

    purchasable_idstring

    just for purchaseable_type = Listing

    pricestringrequired
    quantitystringrequired
    totalstringrequired
    labelProduct Name (string)

    Product Name

  • ]
  • callback_urlstring<url>

    The address of the backend webhook

    Example: https://yourservicemain/yourpath
    redirect_urlstring<url>

    The redirection address after the payment link is completed

    Example: https://yourservicemain/yourwebpage
    is_only_pre_authboolean
    Default value: false
    CreateOrderDTO
    {
    "charge_fee": "0.00",
    "tips": "0.00",
    "currency": "string",
    "reference_number": "string",
    "due_date": "2024-01-01",
    "note": "string",
    "line_items": [
    {
    "uuid": "string",
    "purchasable_type": "RearTips",
    "purchasable_id": "string",
    "price": "string",
    "quantity": "string",
    "total": "string",
    "label": "string"
    }
    ],
    "callback_url": "https://yourservicemain/yourpath",
    "redirect_url": "https://yourservicemain/yourwebpage",
    "is_only_pre_auth": false
    }