لغو سفارش

در صورتی که وضعیت سفارش شما هنوز FINISHED نشده باشد. به عبارت دیگر درصورتی که سفارش شما به‌طور کامل اجرا نشده باشد و یا قسمتی از آن اجرا شده باشد. شما میتوانید سفارش خود را با API زیر لغو کنید.
توجه داشته باشید که Client-Order-id خود را باید به عنوان path-variable ارسال کنید.

curl -i -X DELETE \
  'https://api.wallex.ir/v1/account/orders/{client_id}' \
  -H 'x-api-key: YOUR_API_KEY_HERE'
Response
application/json
{ "message": "string", "result": { "active": true, "clientOrderId": "string", "created_at": "string", "executedPercent": 0, "executedPrice": "string", "executedQty": "string", "executedSum": "string", "fee": "string", "fills": [], "origQty": "string", "price": "string", "side": "string", "status": "string", "stopPrice": "string", "stopPriceCondition": "string", "sum": "string", "symbol": "string", "transactTime": 0, "type": "string", "updated_at": "string" }, "success": true }

توضیحات Path-Variable

برای فراخوانی این API باید Client-Order-id خود را به عنوان path-variable در مسیر API ارسال کنید :

Example

"test-clientId"

Data Type

String

Required/Optional

Required

Definition

عبارت Client-order-id یک عبارت یکتا میباشد که در زمان ساخت سفارش در Response-Body ارسال میشود. جهت آشنایی برای گرفتن Client-order-id به قسمت ثبت سفارش مراجعه کنید.

توضیحات Response-Body

{
  "message": "پیام پاسخ از سرور (مثلا موفقیت یا خطا)",
  "result": {
    "active": "وضعیت فعال بودن سفارش",
    "clientOrderId": "شناسه سفارش اختصاصی مشتری",
    "created_at": "زمان ایجاد سفارش (مثلا به صورت رشته تاریخ)",
    "executedPercent": "درصد اجراشده از سفارش شما",
    "executedPrice": "قیمت اجرا شده سفارش",
    "executedQty": "مقدار اجرا شده از سفارش",
    "executedSum": "مجموع مقدار اجرا شده ",
    "fee": "هزینه انجام سفارش",
    "fills": [
      {
        "fee": "کارمزد هر معامله",
        "feeAsset" :" کارمزد به چه ارزی پرداخت شده",
        "feeCoefficient": "ضریب هزینه معامله",
        "isBuyer": "وضعیت خرید با فروش بودن سفارش",
        "makerFeeCoefficient": "ضریب کارمزد میکر",
        "price": "قیمت معامله",
        "quantity": "مقدار معامله شده",
        "sum": "مجموع معامله",
        "symbol": "نماد معامله",
        "takerFeeCoefficient": "ضریب کارمزد  ",
        "timestamp": "زمان معامله"
      }
    ],
    "origQty": "مقدار اصلی سفارش ثبت شده",
    "price": "قیمت ثبت شده سفارش",
    "side": "سمت سفارش: خرید یا فروش",
    "status": "وضعیت سفارش (مثلا فعال، لغو شده، تکمیل شده)",
    "stopPrice": "قیمت توقف",
    "stopPriceCondition": "شرط فعال‌سازی قیمت توقف",
    "sum": "مجموع کل سفارش ",
    "symbol": " نماد معاملاتی سفارش",
    "transactTime": 0,
    "type": " نوع سفارش ",
    "updated_at": "زمان آخرین به‌روزرسانی سفارش"
  },
  "success": true
}