سفارشات در API Quickex: ایجاد و مدیریت

GET

public-info

Endpoint URL

https://quickex.io/api/v1/orders/public-info

Documentation

اطلاعات عمومی مربوط به یک سفارش (عملیات مبادله) را بر اساس آدرس مقصد برمی‌گرداند.
پاسخ شامل جزئیات واریز/برداشت، جفت معاملاتی، پارامترهای نرخ اعلام‌شده، رویدادهای سفارش و غیره است.

URL

https://quickex.io/api/v1/orders/public-info

پارامترهای درخواست (Query)

پارامتر	نوع	الزامی	توضیح
`destinationAddress`	string	بله	آدرس مقصدی که به سفارش پیوند داده شده است. برای جستجوی سفارش استفاده می‌شود.

نمونه درخواست (cURL)

curl -X GET \
  'https://quickex.io/api/v1/orders/public-info?destinationAddress=0xdeadbeef' \
  -H 'Accept: application/json'

نمونه پاسخ (موفق)

{
  "orderId": 1234,
  "legacyOrderId": "QX-0001234",
  "pair": {
    "instrumentFrom": { "currencyTitle": "USDT", "networkTitle": "TRC20" },
    "instrumentTo":   { "currencyTitle": "BTC",  "networkTitle": "BTC"   }
  },
  "deposits": [
    {
      "createdAt": "2025-08-22T05:51:30.993Z",
      "instrument": { "currencyTitle": "USDT", "networkTitle": "TRC20" },
      "amount": "1000.1",
      "confirmations": 0,
      "txId": "0xdeadc0dedeadbeef",
      "depositAddress": "0xdeadc0de",
      "isPending": true
    }
  ],
  "withdrawals": [
    {
      "createdAt": "2025-08-22T05:51:30.993Z",
      "instrument": { "currencyTitle": "USDT", "networkTitle": "TRC20" },
      "amount": "1000.1",
      "networkFee": "1.1",
      "txId": "0xdeadc0dedeadbeef"
    }
  ],
  "rateMode": "FLOATING",
  "claimedDepositAmount": "10.01",
  "amountToGet": "10.01",
  "completed": false,
  "userEmail": "test@example.com",
  "destinationAddress": "0xdeadbeef"
}

پاسخ‌ها

کد	بدنه	توضیح
`200 OK`	JSON با اطلاعات سفارش	سفارش پیدا شد و بازگردانده شد.
`400 Bad Request`	`{"status":"ERR_VALIDATION","message":"Validation Exception", ...}`	خطای اعتبارسنجی (برای مثال، اگر `destinationAddress` موجود نباشد یا نامعتبر باشد).
`5xx`	—	خطای داخلی سرور.

نکات

این متد فقط داده‌های عمومی سفارش را برمی‌گرداند؛ جزئیات خصوصی در دسترس نیست.

اگر سفارش هنوز ایجاد نشده باشد یا از طریق آدرس قابل یافتن نباشد، خطای اعتبارسنجی یا نتیجهٔ خالی برگردانده می‌شود.

ساختار بخش‌های deposits/withdrawals و فیلدهای کمکی بسته به وضعیت سفارش و تأمین‌کنندهٔ نقدینگی می‌تواند متفاوت باشد.

Code Sample

Response Example

{
  "deposits": [
    {
      "createdAt": "2025-08-22T05:51:30.993Z",
      "instrument": {
        "currencyTitle": "USDT",
        "networkTitle": "TRC20"
      },
      "amount": "1000.1",
      "confirmations": 0,
      "txId": "0xdeadc0dedeadbeef",
      "depositAddress": "0xdeadc0de",
      "isPending": true,
      "id": 0,
      "counterPartyAddress": "0xdeadc0dedeadbeef"
    }
  ],
  "withdrawals": [
    {
      "createdAt": "2025-08-22T05:51:30.993Z",
      "instrument": {
        "currencyTitle": "USDT",
        "networkTitle": "TRC20"
      },
      "amount": "1000.1",
      "networkFee": "1.1",
      "txId": "0xdeadc0dedeadbeef"
    }
  ],
  "depositAddress": {
    "orderId": 0,
    "liquidityProviderTitle": "QUICKEX_BUSINESS_ACCOUNT",
    "instrument": {
      "currencyTitle": "USDT",
      "networkTitle": "TRC20"
    },
    "depositAddress": "0xdeadc0de",
    "depositAddressMemo": "string",
    "redirectUrl": "string"
  },
  "orderId": 0,
  "legacyOrderId": "string",
  "pair": {
    "instrumentFrom": {
      "currencyTitle": "USDT",
      "networkTitle": "TRC20"
    },
    "instrumentTo": {
      "currencyTitle": "USDT",
      "networkTitle": "TRC20"
    }
  },
  "createdAt": "2025-08-22T05:51:30.994Z",
  "claimedDepositAmount": "10.01",
  "amountToGet": "10.01",
  "claimedPublicRate": {
    "price": "1000.1",
    "quotes": {
      "sellQuote": {
        "baseValue": "1000.1",
        "quoteValue": "1000.1"
      },
      "buyQuote": {
        "baseValue": "1000.1",
        "quoteValue": "1000.1"
      }
    },
    "updatedAt": "2025-08-22T05:51:30.994Z",
    "liquidityProviderPublicCode": "formulae",
    "claimedAmountToReceive": "0.01",
    "finalNetworkFeeAmount": "0.01",
    "platformFee_Absolute": "0.01",
    "fixedRate_maxAmount": "1000.000",
    "fixedRate_maxTimeMinutes": 1,
    "fixedRate_maxRateVolatilityPercent": "1000.000"
  },
  "claimedNetworkFee": "10.01",
  "KYCFormLink": "string",
  "orderEvents": [
    {
      "kind": "TRACKING_STARTED",
      "createdAt": "2025-08-22T05:51:30.994Z"
    }
  ],
  "userEmail": "test@example.com",
  "rateMode": "FLOATING",
  "destinationAddress": "0xdeadbeef",
  "destinationAddressMemo": "0xdeadbeef",
  "completed": false,
  "possibleCashbackAmountUSDT": "500.00",
  "redirectUrl": "https://payments.mercuryo.io/"
}

Try it out

POST

set-email

Endpoint URL

/api/v1/orders/public/set-email

Documentation

یک نشانی ایمیل را به سفارش موجود (عملیات مبادله) اختصاص می‌دهد. ایمیل برای ارسال اعلان‌های وضعیت سفارش و ارتباط با پشتیبانی استفاده می‌شود.

URL

https://quickex.io/api/v1/orders/public/set-email

نیاز به احراز هویت

خیر (روش عمومی برای یک سفارش موجود).

سرآیندها (Headers)

Accept: application/json
Content-Type: application/json

بدنهٔ درخواست (JSON)

فیلد	نوع	الزامی	توضیح
`orderId`	number	بله	شناسهٔ سفارشی که باید ایمیل به آن متصل شود.
`userEmail`	string (email)	بله	نشانی ایمیل کاربر برای دریافت اعلان‌ها.

{
  "orderId": 123456,
  "userEmail": "user@example.com"
}

نمونهٔ درخواست (cURL)

curl -X POST \
  'https://quickex.io/api/v1/orders/public/set-email' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
    "orderId": 123456,
    "userEmail": "user@example.com"
  }'

پاسخ‌ها

کد	بدنه	توضیح
`200 OK`	JSON شامل اطلاعات عمومی سفارش (از جمله `userEmail`)	ایمیل با موفقیت به سفارش متصل شد.
`400 Bad Request`	`{"status":"ERR_VALIDATION","message":"Validation Exception", ...}`	خطای اعتبارسنجی (برای مثال، اگر `userEmail` یک نشانی ایمیل معتبر نباشد).
`5xx`	—	خطای داخلی سرور.

نکات

پیش از فراخوانی، از مشخص‌بودن یک orderId معتبر مربوط به یک سفارش موجود مطمئن شوید.

userEmail باید یک نشانی ایمیل معتبر باشد (نمونهٔ خطا: userEmail must be an email).

در صورت موفقیت، پاسخ شامل اطلاعات عمومی فعلی سفارش است که در آن فیلد userEmail نشانی اختصاص‌داده‌شده را در بر خواهد داشت.

Code Sample

Response Example

{
  "deposits": [
    {
      "createdAt": "2025-08-22T06:03:09.050Z",
      "instrument": {
        "currencyTitle": "USDT",
        "networkTitle": "TRC20"
      },
      "amount": "1000.1",
      "confirmations": 0,
      "txId": "0xdeadc0dedeadbeef",
      "depositAddress": "0xdeadc0de",
      "isPending": true,
      "id": 0,
      "counterPartyAddress": "0xdeadc0dedeadbeef"
    }
  ],
  "withdrawals": [
    {
      "createdAt": "2025-08-22T06:03:09.050Z",
      "instrument": {
        "currencyTitle": "USDT",
        "networkTitle": "TRC20"
      },
      "amount": "1000.1",
      "networkFee": "1.1",
      "txId": "0xdeadc0dedeadbeef"
    }
  ],
  "depositAddress": {
    "orderId": 0,
    "liquidityProviderTitle": "QUICKEX_BUSINESS_ACCOUNT",
    "instrument": {
      "currencyTitle": "USDT",
      "networkTitle": "TRC20"
    },
    "depositAddress": "0xdeadc0de",
    "depositAddressMemo": "string",
    "redirectUrl": "string"
  },
  "orderId": 0,
  "legacyOrderId": "string",
  "pair": {
    "instrumentFrom": {
      "currencyTitle": "USDT",
      "networkTitle": "TRC20"
    },
    "instrumentTo": {
      "currencyTitle": "USDT",
      "networkTitle": "TRC20"
    }
  },
  "createdAt": "2025-08-22T06:03:09.050Z",
  "claimedDepositAmount": "10.01",
  "amountToGet": "10.01",
  "claimedPublicRate": {
    "price": "1000.1",
    "quotes": {
      "sellQuote": {
        "baseValue": "1000.1",
        "quoteValue": "1000.1"
      },
      "buyQuote": {
        "baseValue": "1000.1",
        "quoteValue": "1000.1"
      }
    },
    "updatedAt": "2025-08-22T06:03:09.050Z",
    "liquidityProviderPublicCode": "formulae",
    "claimedAmountToReceive": "0.01",
    "finalNetworkFeeAmount": "0.01",
    "platformFee_Absolute": "0.01",
    "fixedRate_maxAmount": "1000.000",
    "fixedRate_maxTimeMinutes": 1,
    "fixedRate_maxRateVolatilityPercent": "1000.000"
  },
  "claimedNetworkFee": "10.01",
  "KYCFormLink": "string",
  "orderEvents": [
    {
      "kind": "TRACKING_STARTED",
      "createdAt": "2025-08-22T06:03:09.050Z"
    }
  ],
  "userEmail": "test@example.com",
  "rateMode": "FLOATING",
  "destinationAddress": "0xdeadbeef",
  "destinationAddressMemo": "0xdeadbeef",
  "completed": false,
  "possibleCashbackAmountUSDT": "500.00",
  "redirectUrl": "https://payments.mercuryo.io/"
}

Try it out

GET

latest

Endpoint URL

https://quickex.io/api/v1/orders/public/latest

Documentation

Code Sample

Response Example

[
  {
    "createdAt": "2025-08-22T05:43:01.000Z",
    "instrumentFrom": {
      "currencyTitle": "BNB",
      "networkTitle": "BEP20",
      "okexCurrency": {
        "okexCurrencyFriendlyTitle": "BNB",
        "currencyLogoLink": "https://s2.coinmarketcap.com/static/img/coins/64x64/1839.png"
      }
    },
    "instrumentTo": {
      "currencyTitle": "SOL",
      "networkTitle": "SOL",
      "okexCurrency": {
        "okexCurrencyFriendlyTitle": "SOL",
        "currencyLogoLink": "https://static.coinall.ltd/cdn/oksupport/asset/currency/icon/sol.png"
      }
    },
    "amountFrom": "0.1809",
    "amountTo": "0.82480169"
  },
  {
    "createdAt": "2025-08-22T05:37:01.000Z",
    "instrumentFrom": {
      "currencyTitle": "BNB",
      "networkTitle": "BEP20",
      "okexCurrency": {
        "okexCurrencyFriendlyTitle": "BNB",
        "currencyLogoLink": "https://s2.coinmarketcap.com/static/img/coins/64x64/1839.png"
      }
    },
    "instrumentTo": {
      "currencyTitle": "SOL",
      "networkTitle": "SOL",
      "okexCurrency": {
        "okexCurrencyFriendlyTitle": "SOL",
        "currencyLogoLink": "https://static.coinall.ltd/cdn/oksupport/asset/currency/icon/sol.png"
      }
    },
    "amountFrom": "0.2012",
    "amountTo": "0.91833564"
  },
  {
    "createdAt": "2025-08-22T05:33:04.000Z",
    "instrumentFrom": {
      "currencyTitle": "BTC",
      "networkTitle": "BTC",
      "okexCurrency": {
        "okexCurrencyFriendlyTitle": "BTC",
        "currencyLogoLink": "https://static.coinall.ltd/cdn/oksupport/asset/currency/icon/btc20230419112752.png"
      }
    },
    "instrumentTo": {
      "currencyTitle": "ATOM",
      "networkTitle": "ATOM",
      "okexCurrency": {
        "okexCurrencyFriendlyTitle": "ATOM",
        "currencyLogoLink": "https://static.coinall.ltd/cdn/oksupport/asset/currency/icon/atom.png"
      }
    },
    "amountFrom": "0.12827865",
    "amountTo": "3149.690556"
  },
  {
    "createdAt": "2025-08-22T05:29:03.000Z",
    "instrumentFrom": {
      "currencyTitle": "BTC",
      "networkTitle": "BTC",
      "okexCurrency": {
        "okexCurrencyFriendlyTitle": "BTC",
        "currencyLogoLink": "https://static.coinall.ltd/cdn/oksupport/asset/currency/icon/btc20230419112752.png"
      }
    },
    "instrumentTo": {
      "currencyTitle": "USDT",
      "networkTitle": "TRC20",
      "okexCurrency": {
        "okexCurrencyFriendlyTitle": "USDT",
        "currencyLogoLink": "https://static.coinall.ltd/cdn/oksupport/asset/currency/icon/usdt20230419113051.png"
      }
    },
    "amountFrom": "0.00478498",
    "amountTo": "563.455834"
  },
  {
    "createdAt": "2025-08-22T05:22:03.000Z",
    "instrumentFrom": {
      "currencyTitle": "ETH",
      "networkTitle": "ETH",
      "okexCurrency": {
        "okexCurrencyFriendlyTitle": "Ethereum",
        "currencyLogoLink": "https://static.coinall.ltd/cdn/oksupport/asset/currency/icon/eth20230419112854.png"
      }
    },
    "instrumentTo": {
      "currencyTitle": "BNB",
      "networkTitle": "BEP20",
      "okexCurrency": {
        "okexCurrencyFriendlyTitle": "BNB",
        "currencyLogoLink": "https://s2.coinmarketcap.com/static/img/coins/64x64/1839.png"
      }
    },
    "amountFrom": "0.59",
    "amountTo": "2.77157716"
  }
]

Try it out

POST

accept-rate-mode-change

Endpoint URL

https://quickex.io/api/v1/orders/public/accept-rate-mode-change

Documentation

تأیید «تغییر حالت نرخ» برای یک سفارش. این اقدام زمانی استفاده می‌شود که سفارش با نرخ ثابت ایجاد شده باشد اما در جریان فرایند تبادل به نرخ شناور تغییر کرده باشد (برای نمونه به‌دلیل عبور از محدودیت‌ها یا نوسان شدید).
این متد به کاربر اجازه می‌دهد حالت جدید را بپذیرد و پردازش سفارش ادامه یابد.

URL

https://quickex.io/api/v1/orders/public/accept-rate-mode-change

هدرها

Accept: application/json
Content-Type: application/json

بدنهٔ درخواست (JSON)

فیلد	نوع	الزامی	توضیحات
`orderId`	number	بله	شناسهٔ سفارشی که باید تغییر حالت نرخ آن تأیید شود.
`destinationAddress`	string	بله	آدرس مقصدِ مرتبط با سفارش (برای راستی‌آزماییِ اضافی استفاده می‌شود).

{
  "orderId": 123456,
  "destinationAddress": "0xdeadbeef"
}

نمونهٔ درخواست (cURL)

curl -X POST \
  'https://quickex.io/api/v1/orders/public/accept-rate-mode-change' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
    "orderId": 123456,
    "destinationAddress": "0xdeadbeef"
  }'

پاسخ‌ها

کد	توضیح
`201 Created`	تغییر حالت نرخ تأیید شد و سفارش به پردازش ادامه می‌دهد.
`404 Not Found`	سفارش یافت نشد (`{"status":"ERR_NOT_FOUND","message":"Order not found"}`).
`400 Bad Request`	خطای اعتبارسنجی (برای نمونه، داده‌های ورودی نامعتبر).
`5xx`	خطای داخلی سرور.

نکات

این متد فقط زمانی فراخوانی می‌شود که سفارش حالت نرخ را تغییر داده باشد (برای مثال از ثابت به شناور).

بدون تأیید، پردازش سفارش معلق می‌شود.

در صورت موفقیت، پاسخ با وضعیت 201 بازگردانده می‌شود و پردازش سفارش ادامه می‌یابد.

Code Sample

Try it out

POST

request-refund

Endpoint URL

https://quickex.io/api/v1/orders/public/request-refund

Documentation

درخواست بازپرداخت برای یک سفارش. زمانی استفاده می‌شود که مبادله نهایی نشده باشد یا زمانی که وجوه باید به کاربر بازگردانده شود.
برای موفقیت، مبلغ بازپرداخت و آدرس بازپرداخت باید مشخص شوند.

URL

https://quickex.io/api/v1/orders/public/request-refund

هدرها

Accept: application/json
Content-Type: application/json

بدنهٔ درخواست (JSON)

فیلد	نوع	الزامی	توضیحات
`orderId`	number	بله	شناسهٔ سفارشی که برای آن درخواست بازپرداخت شده است.
`destinationAddress`	string	بله	آدرس مقصدی که در سفارش اولیه درج شده است (برای راستی‌آزماییِ اضافی استفاده می‌شود).
`refundAmount`	string	بله	مبلغی که باید به کاربر بازگردانده شود.
`refundAddress`	string	بله	آدرس کیف پول کاربر که وجوه به آن بازگردانده می‌شود.
`claimedNetworkFee`	string	خیر	میزان کارمزد شبکه‌ای که کاربر می‌پذیرد برای بازپرداخت پرداخت کند.

{
  "orderId": 123456,
  "destinationAddress": "0xdeadbeef",
  "refundAmount": "10.00",
  "refundAddress": "0xuserrefundwallet",
  "claimedNetworkFee": "0.50"
}

نمونهٔ درخواست (cURL)

curl -X POST \
  'https://quickex.io/api/v1/orders/public/request-refund' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
    "orderId": 123456,
    "destinationAddress": "0xdeadbeef",
    "refundAmount": "10.00",
    "refundAddress": "0xuserrefundwallet",
    "claimedNetworkFee": "0.50"
  }'

پاسخ‌ها

کد	توضیح
`201 Created`	درخواست بازپرداخت پذیرفته شد و پردازش خواهد شد.
`404 Not Found`	سفارش یافت نشد (`{"status":"ERR_NOT_FOUND","message":"Order not found"}`).
`400 Bad Request`	خطای اعتبارسنجی (مثلاً مبلغ بازپرداخت کمتر از حداقل مجاز است یا `refundAddress` نامعتبر است).
`5xx`	خطای داخلی سرور.

نکات

این متد فقط برای سفارش‌هایی استفاده می‌شود که امکان نهایی‌سازی آن‌ها وجود ندارد.

بازپرداخت به آدرسی که در refundAddress آمده انجام می‌شود، پس از کسر کارمزدهای شبکهٔ قابل اعمال.

پس از ارسال، ممکن است بازپرداخت به بررسی دستی توسط تیم پشتیبانی نیاز داشته باشد.

Code Sample

Try it out

GET

order-refund-info

پارامتر	نوع	الزامی	توضیحات
`orderId`	string	بله	شناسهٔ سفارشی که باید داده‌های بازپرداخت آن بازیابی شود.

کد	توضیح
`200 OK`	یک JSON شامل اطلاعات بازپرداخت (مبلغ، آدرس، وضعیت، کارمزدها) برمی‌گرداند.
`400 Bad Request`	خطای اعتبارسنجی یا داده‌های نامعتبر سفارش (`{"status":"ERR_BAD_REQUEST","message":"Unknown liquidity provider title: ..."}`).
`404 Not Found`	سفارش یافت نشد.
`5xx`	خطای داخلی سرور.

GET

public/list

Endpoint URL

https://quickex.io/api/v1/orders/public/list

Documentation

فهرست سفارش‌های مرتبط با کاربرِ در حال احراز هویت را برمی‌گرداند.
پاسخ شامل جزئیات واریزها، برداشت‌ها، تنظیمات جفت معاملاتی، وضعیت سفارش و اطلاعات دیگر است.

URL

https://quickex.io/api/v1/orders/public/list

نیازمند احراز هویت

بله — باید یک access_token معتبر در هدر ارائه شود.

هدرها

Accept: application/json
access_token = YOUR_TOKEN

پارامترها

ندارد

نمونهٔ درخواست (cURL)

curl -X GET \
  'https://quickex.io/api/v1/orders/public/list' \
  -H 'Accept: application/json' \
  --cookie "access_token=YOUR_TOKEN"

نمونهٔ پاسخ (200)

[
  {
    "orderId": 123,
    "pair": {
      "instrumentFrom": { "currencyTitle": "USDT", "networkTitle": "TRC20" },
      "instrumentTo":   { "currencyTitle": "BTC",  "networkTitle": "BTC"   }
    },
    "deposits": [
      {
        "createdAt": "2025-08-26T09:55:46.101Z",
        "instrument": { "currencyTitle": "USDT", "networkTitle": "TRC20" },
        "amount": "1000.1",
        "confirmations": 0,
        "txId": "0xdeadc0dedeadbeef",
        "depositAddress": "0xdeadc0de",
        "isPending": true
      }
    ],
    "withdrawals": [
      {
        "createdAt": "2025-08-26T09:55:46.101Z",
        "instrument": { "currencyTitle": "BTC", "networkTitle": "BTC" },
        "amount": "0.025",
        "txId": "0xbtcdeadbeef"
      }
    ],
    "status": "PENDING",
    "createdAt": "2025-08-26T09:55:46.101Z"
  }
]

پاسخ‌ها

کد	توضیح
`200 OK`	یک آرایه از سفارش‌های کاربر را برمی‌گرداند.
`401 Unauthorized`	`access_token` موجود نیست یا نامعتبر است.
`5xx`	خطای سرور هنگام پردازش درخواست.

نکات

این متد فقط سفارش‌هایی را برمی‌گرداند که توسط کاربرِ فعلاً احرازشده ایجاد شده‌اند.

برای دریافت اطلاعات عمومی دربارهٔ یک سفارش خاص، از متد /api/v1/orders/public-info استفاده کنید.

توصیه می‌شود داده‌های سفارش را در سمت کاربر کش کنید تا تعداد درخواست‌ها کاهش یابد.

Code Sample

Try it out

POST

/api/v1/orders/public/create

Endpoint URL

https://quickex.io/api/v1/orders/public/create

Documentation

یک سفارش مبادلهٔ جدید ایجاد می‌کند.
این متد پارامترهای جفت معاملاتی (ارزهای ارسال و دریافت)، مبلغ، آدرس‌های کاربر، همچنین داده‌های اضافی
(نرخ، کارمزدها، پارامترهای افیلیت) را می‌پذیرد. پاسخ یک شیء سفارش با جزئیات واریزها و برداشت‌ها برمی‌گرداند.

URL

https://quickex.io/api/v1/orders/public/create

احراز هویت

هدر B2B-Bearer-Token برای یکپارچه‌سازی‌های B2B الزامی است (نمونه: -H "B2B-Bearer-Token: TOKEN").
برای سناریوهای کاربری، می‌توان از access_token به‌صورت کوکی استفاده کرد.

هدرها

Accept: application/json
Content-Type: application/json
B2B-Bearer-Token: <TOKEN>

بدنهٔ درخواست (JSON)

{
  "instrumentFrom": { "currencyTitle": "USDT", "networkTitle": "TRC20" },
  "instrumentTo":   { "currencyTitle": "LTC",  "networkTitle": "LTC"   },
  "destinationAddress": "MWYK4uQXFvWc1Bj1CPACyX5HTQxUUpRZ2e",
  "refundAddress": "TFe5tdqSy8CMGMDVHPJHLTK8hrAL6ddUpD",
  "claimedDepositAmount": "3300",
  "claimedPublicRate": {
    "price": "0.014271620139287839394",
    "updatedAt": "2024-02-13T14:43:12.983Z",
    "claimedAmountToReceive": "47.09634645964987"
  },
  "claimedNetworkFee": "0.001",
  "userEmail": "test@example.com",
  "referrerId": "aff_some-affiliate-id",
  "markupAffiliateId": "aff_some-affiliate-id",
  "rateMode": "FLOATING",
  "browserFingerprint": "string",
  "markup": "0.01",
  "locale": "en"
}

نمونهٔ درخواست (cURL)

curl -X POST \
  'https://quickex.io/api/v1/orders/public/create' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'B2B-Bearer-Token: YOUR TOKEN' \
  -d '{
    "instrumentFrom": { "currencyTitle": "USDT", "networkTitle": "TRC20" },
    "instrumentTo":   { "currencyTitle": "LTC",  "networkTitle": "LTC"   },
    "destinationAddress": "MWYK4uQXFvWc1Bj1CPACyX5HTQxUUpRZ2e",
    "refundAddress": "TFe5tdqSy8CMGMDVHPJHLTK8hrAL6ddUpD",
    "claimedDepositAmount": "3300",
    "claimedPublicRate": {
      "price": "0.014271620139287839394",
      "updatedAt": "2024-02-13T14:43:12.983Z",
      "claimedAmountToReceive": "47.09634645964987"
    },
    "claimedNetworkFee": "0.001",
    "userEmail": "test@example.com",
    "rateMode": "FLOATING",
    "browserFingerprint": "string",
    "markup": "0.01",
    "locale": "en"
  }'

نمونهٔ پاسخ (200)

{
  "orderId": 9876,
  "deposits": [
    {
      "createdAt": "2025-08-26T10:08:06.203Z",
      "instrument": { "currencyTitle": "USDT", "networkTitle": "TRC20" },
      "amount": "3300",
      "depositAddress": "0xdeadc0de",
      "txId": null,
      "isPending": true
    }
  ],
  "withdrawals": [],
  "pair": {
    "instrumentFrom": { "currencyTitle": "USDT", "networkTitle": "TRC20" },
    "instrumentTo":   { "currencyTitle": "LTC",  "networkTitle": "LTC"   }
  },
  "rateMode": "FLOATING",
  "userEmail": "test@example.com",
  "status": "CREATED",
  "createdAt": "2025-08-26T10:08:06.203Z"
}

پاسخ‌ها

کد	توضیح
`200 OK`	سفارش با موفقیت ایجاد شد؛ شیء سفارش برگردانده می‌شود.
`401 Unauthorized`	هدر `B2B-Bearer-Token` یا کوکی `access_token` موجود نیست یا نامعتبر است.
`422 Unprocessable Entity`	خطای اعتبارسنجی در داده‌های ورودی (برای نمونه، مبلغ بسیار کم است).
`501`	خطای سرور («data is not iterable»).

نکات

توصیه می‌شود پیش از ایجاد سفارش، نرخ را از مسیر /api/v1/rates/public/one بازیابی کنید.

اگر rateMode=FIXED مشخص شود، نرخ برای مدت محدودی قفل خواهد شد.

پارامترهای referrerId و markupAffiliateId برای یکپارچه‌سازی‌های افیلیت استفاده می‌شوند.

اگر هنوز وجوه ارسال نشده باشد، پاسخ می‌تواند شامل آرایهٔ خالیِ withdrawals باشد.

Code Sample

Response Example

{
  "deposits": [
    {
      "createdAt": "2025-11-21T09:26:08.476Z",
      "instrument": {
        "currencyTitle": "USDT",
        "networkTitle": "TRC20"
      },
      "amount": "1000.1",
      "confirmations": 0,
      "txId": "0xdeadc0dedeadbeef",
      "depositAddress": "0xdeadc0de",
      "isPending": true,
      "id": 0,
      "counterPartyAddress": "0xdeadc0dedeadbeef"
    }
  ],
  "withdrawals": [
    {
      "createdAt": "2025-11-21T09:26:08.476Z",
      "instrument": {
        "currencyTitle": "USDT",
        "networkTitle": "TRC20"
      },
      "amount": "1000.1",
      "networkFee": "1.1",
      "txId": "0xdeadc0dedeadbeef"
    }
  ],
  "depositAddress": {
    "orderId": 0,
    "liquidityProviderTitle": "QUICKEX_BUSINESS_ACCOUNT",
    "instrument": {
      "currencyTitle": "USDT",
      "networkTitle": "TRC20"
    },
    "depositAddress": "0xdeadc0de",
    "depositAddressMemo": "string",
    "redirectUrl": "string"
  },
  "orderId": 0,
  "userId": 0,
  "legacyOrderId": "string",
  "pair": {
    "instrumentFrom": {
      "currencyTitle": "USDT",
      "networkTitle": "TRC20"
    },
    "instrumentTo": {
      "currencyTitle": "USDT",
      "networkTitle": "TRC20"
    }
  },
  "createdAt": "2025-11-21T09:26:08.476Z",
  "claimedDepositAmount": "10.01",
  "amountToGet": "10.01",
  "claimedPublicRate": {
    "price": "1000.1",
    "quotes": {
      "sellQuote": {
        "baseValue": "1000.1",
        "quoteValue": "1000.1"
      },
      "buyQuote": {
        "baseValue": "1000.1",
        "quoteValue": "1000.1"
      }
    },
    "updatedAt": "2025-11-21T09:26:08.476Z",
    "liquidityProviderPublicCode": "formulae",
    "claimedAmountToReceive": "0.01",
    "finalNetworkFeeAmount": "0.01",
    "platformFee_Absolute": "0.01",
    "fixedRate_maxAmount": "1000.000",
    "fixedRate_maxTimeMinutes": 1,
    "fixedRate_maxRateVolatilityPercent": "1000.000"
  },
  "claimedNetworkFee": "10.01",
  "KYCFormLink": "string",
  "orderEvents": [
    {
      "kind": "TRACKING_STARTED",
      "createdAt": "2025-11-21T09:26:08.476Z"
    }
  ],
  "userEmail": "test@example.com",
  "rateMode": "FLOATING",
  "destinationAddress": "0xdeadbeef",
  "destinationAddressMemo": "0xdeadbeef",
  "completed": false,
  "possibleCashbackAmountUSDT": "500.00",
  "redirectUrl": "https://payments.mercuryo.io/",
  "minConfirmationsToTrade": 3,
  "minConfirmationsToWithdraw": 3
}

API V1 Orders

Documentation

URL

پارامترهای درخواست (Query)

نمونه درخواست (cURL)

نمونه پاسخ (موفق)

پاسخ‌ها

نکات

Code Sample

Response Example

Try it out

Headers

Documentation

URL

نیاز به احراز هویت

سرآیندها (Headers)

بدنهٔ درخواست (JSON)

نمونهٔ درخواست (cURL)

پاسخ‌ها

نکات

Code Sample

Response Example

Try it out

Request Body

Headers

Documentation

پارامترها

نمونهٔ درخواست

نمونهٔ پاسخ (200)

نکات

Code Sample

Response Example

Try it out

Headers

Documentation

URL

هدرها

بدنهٔ درخواست (JSON)

نمونهٔ درخواست (cURL)

پاسخ‌ها

نکات

Code Sample

Try it out

Request Body

Headers

Documentation

URL

هدرها

بدنهٔ درخواست (JSON)

نمونهٔ درخواست (cURL)

پاسخ‌ها

نکات

Code Sample

Try it out

Request Body

Headers

Documentation

URL

پارامترهای درخواست (query)

پاسخ‌ها

نکات

Code Sample

Try it out

Headers

Documentation

URL

نیازمند احراز هویت

هدرها

پارامترها

نمونهٔ درخواست (cURL)

نمونهٔ پاسخ (200)

پاسخ‌ها

نکات

Code Sample

Try it out

Headers

Documentation

URL

احراز هویت

هدرها