بخش orders شامل متدهایی برای ایجاد یک سفارش جدید و افزودن ایمیل کاربر به یک سفارش موجود است.
با استفاده از متدهای موجود، میتوانید از طریق ایجاد سفارش یک فرایند تبادل را آغاز کنید و همچنین یک آدرس ایمیل اضافه کنید تا اعلانهای مربوط به وضعیت سفارش به آن ارسال شود.
Documentation
توضیحات کلی
این اندپوینت به شما امکان میدهد ایمیل یک کاربر را به سفارشی که قبلاً ایجاد شده است، متصل کنید. پس از فراخوانی این متد، فیلد userEmail در سفارش با آدرس وارد شده مقداردهی میشود و اعلانهای مربوط به تغییر وضعیت تراکنش به آن ایمیل ارسال خواهد شد.
پارامترها
هدرها (Headers)
| نام | ضروری | توضیحات |
|---|---|---|
X-Api-Public-Key |
بله | کلید عمومی API شما برای احراز هویت درخواست. |
X-Api-Timestamp |
بله | Timestamp در فرمت UNIX (میلیثانیه). برای جلوگیری از حملات تکراری استفاده میشود. |
X-Api-Signature |
بله | امضای HMAC کل بدنه درخواست، تولید شده با کلید مخفی شما. |
بدنه درخواست (JSON)
| فیلد | نوع | ضروری | توضیحات |
|---|---|---|---|
orderId |
number | بله | شناسه سفارش موجود. |
userEmail |
string | بله | آدرس ایمیل برای دریافت اعلانها. |
نمونه درخواست
curl -X POST 'https://quickex.io/api/v2/orders/public/set-email' \
-H 'accept: application/json' \
-H 'Content-Type: application/json' \
-H 'X-Api-Public-Key: yourPublicKey' \
-H 'X-Api-Timestamp: 1691397292905' \
-H 'X-Api-Signature: yourHmacSignature' \
-d '{
"orderId": 12345,
"userEmail": "user@example.com"
}'
پاسخهای ممکن
200 OK — ایمیل با موفقیت افزوده شد.
403 ERR_FORBIDDEN — هدرهای ضروری وجود ندارند یا امضا نادرست است:
{
"status": "ERR_FORBIDDEN",
"message": "Header params is missed!"
}
موارد استفاده
یک شریک ادغامکننده Quickex را در برنامه خود وارد میکند و میخواهد بلافاصله پس از ایجاد سفارش، اعلانهای ایمیل را فعال کند:
- کاربر از طریق
/api/v2/orders/public/createسفارش ایجاد میکند. - پس از دریافت
orderId، متد/api/v2/orders/public/set-emailبرای ثبت ایمیل فراخوانی میشود. - هنگام واریز یا برداشت وجه، Quickex اعلانها را به
userEmailمشخصشده ارسال میکند.
Code Sample
curl -X 'GET' \
'https://quickex.io/api/v2/orders?order=asc' \
-H 'accept: application/json' \
-H 'X-Api-Public-Key: {YOUR_PUBLIC_KEY}' \
-H 'X-Api-Timestamp: {UNIX_MS_TIMESTAMP}' \
-H 'X-Api-Signature: {SIGNATURE}' \Response Example
[
{
"orderId": 2096,
"destinationAddress": "rMZiLhMHDKHSD9mMurzvixQGKFsDNLLP1",
"createdAt": "2024-11-21T09:57:37.536Z",
"updatedAt": "2024-11-21T09:57:37.536Z",
"destinationAddressMemo": null,
"refundAddress": null,
"refundAddressMemo": null,
"claimedDepositAmount": "11905.4",
"claimedNetworkFee": "0.25",
"amountToGet": "2000.535980286546",
"amountToGetUSDT": "0",
"amountToWithdrawFact": "0",
"amountToWithdrawFactUSDT": "0",
"instrumentFromCurrencyTitle": "TRX",
"instrumentFromNetworkTitle": "TRX",
"instrumentToCurrencyTitle": "XRP",
"instrumentToNetworkTitle": "XRP",
"ip": "165.22.73.162",
"geoCode": "DE",
"markup": "0",
"userEmail": "qa@support.quickex.io",
"completed": false,
"state": "created"
},
{
"orderId": 2097,
"destinationAddress": "rMZiLhMHDKHSD9mMurzvixQGKFsDNLLP1",
"createdAt": "2024-11-21T09:57:56.849Z",
"updatedAt": "2024-11-21T09:57:56.849Z",
"destinationAddressMemo": null,
"refundAddress": null,
"refundAddressMemo": null,
"claimedDepositAmount": "500",
"claimedNetworkFee": "0.25",
"amountToGet": "88.201060256891",
"amountToGetUSDT": "0",
"amountToWithdrawFact": "0",
"amountToWithdrawFactUSDT": "0",
"instrumentFromCurrencyTitle": "TRX",
"instrumentFromNetworkTitle": "TRX",
"instrumentToCurrencyTitle": "XRP",
"instrumentToNetworkTitle": "XRP",
"ip": "165.22.73.162",
"geoCode": "DE",
"markup": "0",
"userEmail": "qa@support.quickex.io",
"completed": false,
"state": "created"
},
{
"orderId": 3038,
"destinationAddress": "TFjfHBiDcL6B5S5W8g9b6gU2tbvnTR52ya",
"createdAt": "2025-04-28T13:15:03.006Z",
"updatedAt": "2025-07-22T10:36:58.557Z",
"destinationAddressMemo": null,
"refundAddress": null,
"refundAddressMemo": null,
"claimedDepositAmount": "0.034268",
"claimedNetworkFee": "1.5",
"amountToGet": "3263.05",
"amountToGetUSDT": "3263.058154",
"amountToWithdrawFact": "0",
"amountToWithdrawFactUSDT": "0",
"instrumentFromCurrencyTitle": "BTC",
"instrumentFromNetworkTitle": "BTC",
"instrumentToCurrencyTitle": "USDT",
"instrumentToNetworkTitle": "TRC20",
"ip": "45.76.90.73",
"geoCode": "DE",
"markup": "0",
"userEmail": "qa@support.quickex.io",
"completed": false,
"state": "created"
},
{
"orderId": 3172,
"destinationAddress": "TPjT9p6UK5omA19h1QuYf4HbWvB9CukMzx",
"createdAt": "2025-11-25T07:52:52.871Z",
"updatedAt": "2025-11-27T11:34:19.690Z",
"destinationAddressMemo": null,
"refundAddress": null,
"refundAddressMemo": null,
"claimedDepositAmount": "52",
"claimedNetworkFee": "2.054188275293",
"amountToGet": "419.2",
"amountToGetUSDT": "114.402051690569",
"amountToWithdrawFact": "417.825363",
"amountToWithdrawFactUSDT": "114.0245415627",
"instrumentFromCurrencyTitle": "XRP",
"instrumentFromNetworkTitle": "XRP",
"instrumentToCurrencyTitle": "TRX",
"instrumentToNetworkTitle": "TRX",
"ip": "77.246.100.22",
"geoCode": "NL",
"markup": "0",
"userEmail": "qa@support.quickex.io",
"completed": true,
"state": "withdraw"
},
{
"orderId": 3192,
"destinationAddress": "15vvDFQFksUS4r1cYxmjZuTVVUzWZSJauuUapg7Xjhgtkwqy",
"createdAt": "2025-12-02T14:11:15.985Z",
"updatedAt": "2025-12-02T14:11:16.107Z",
"destinationAddressMemo": null,
"refundAddress": "UQCGxjLy3msAFWG4r310Sk_rOz27QWRy252fdLMWJAMQJvSE",
"refundAddressMemo": null,
"claimedDepositAmount": "3300",
"claimedNetworkFee": "0.14",
"amountToGet": "2363.663",
"amountToGetUSDT": "4999.384629917638",
"amountToWithdrawFact": "0",
"amountToWithdrawFactUSDT": "0",
"instrumentFromCurrencyTitle": "TON",
"instrumentFromNetworkTitle": "TON",
"instrumentToCurrencyTitle": "DOT",
"instrumentToNetworkTitle": "DOT",
"ip": "77.246.100.22",
"geoCode": "NL",
"markup": "0",
"userEmail": null,
"completed": false,
"state": "created"
},
{
"orderId": 3193,
"destinationAddress": "15vvDFQFksUS4r1cYxmjZuTVVUzWZSJauuUapg7Xjhgtkwqy",
"createdAt": "2025-12-02T14:14:34.356Z",
"updatedAt": "2025-12-02T14:14:34.557Z",
"destinationAddressMemo": null,
"refundAddress": "UQCGxjLy3msAFWG4r310Sk_rOz27QWRy252fdLMWJAMQJvSE",
"refundAddressMemo": null,
"claimedDepositAmount": "73",
"claimedNetworkFee": "0.14",
"amountToGet": "52.235",
"amountToGetUSDT": "110.556162356583",
"amountToWithdrawFact": "0",
"amountToWithdrawFactUSDT": "0",
"instrumentFromCurrencyTitle": "TON",
"instrumentFromNetworkTitle": "TON",
"instrumentToCurrencyTitle": "DOT",
"instrumentToNetworkTitle": "DOT",
"ip": "77.246.100.22",
"geoCode": "NL",
"markup": "0",
"userEmail": null,
"completed": false,
"state": "created"
}
]Try it out
Leave empty to use default
Query Parameters
Request Body
Headers
Documentation
توضیحات کلی
این اندپوینت یک سفارش جدید برای تبادل ارز دیجیتال ایجاد میکند. اطلاعات کامل سفارش را برمیگرداند: آدرسهای واریز و برداشت، پارامترهای نرخ، رویدادها و URLهای لازم برای پردازش بعدی.
پارامترها
هدرها (Headers)
| نام | الزامی | توضیحات |
|---|---|---|
B2B-Bearer-Token |
بله | توکن Bearer برای احراز هویت از طریق Mercuryo. |
X-Api-Public-Key |
بله | کلید عمومی API شما. |
X-Api-Timestamp |
بله | Timestamp در فرمت UNIX (میلیثانیه). |
X-Api-Signature |
بله | امضای HMAC بدنه درخواست که با کلید مخفی شما تولید شده است. |
بدنه درخواست (JSON)
| فیلد | نوع | الزامی | توضیحات |
|---|---|---|---|
instrumentFrom |
object | بله | ارز و شبکه مبدأ (currencyTitle / networkTitle). |
instrumentTo |
object | بله | ارز و شبکه مقصد. |
destinationAddress |
string | بله | آدرسی برای دریافت دارایی پس از تبادل. |
destinationAddressMemo |
string | خیر | Memo یا تگ اختیاری برای آدرس مقصد. |
refundAddress |
string | بله | آدرس برای بازپرداخت در صورت خطا در تبادل. |
refundAddressMemo |
string | خیر | Memo یا تگ برای آدرس بازپرداخت. |
claimedDepositAmount |
string | بله | مقداری که کاربر قصد واریز آن را دارد. |
claimedPublicRate |
object | خیر | جزئیات نرخ ادعاشده: قیمت، زمان بهروزرسانی و مقدار مورد انتظار برای دریافت. |
claimedNetworkFee |
string | خیر | کارمزد شبکه اعلامشده. |
userEmail |
string | خیر | ایمیل برای اعلانها. |
legacyOrderId |
string | خیر | شناسه سفارش خارجی از سیستم قدیمی. |
referrerId |
string | خیر | شناسه معرف برای برنامه همکاری. |
markupAffiliateId |
string | خیر | شناسه افیلیت برای تخصیص مارکآپ. |
rateMode |
string | خیر | نوع نرخ: FLOATING یا FIXED. |
utmData |
object | خیر | پارامترهای UTM برای تحلیل. |
browserFingerprint |
string | خیر | اثر انگشت مرورگر برای جلوگیری از تقلب. |
markup |
string | خیر | درصد مارکآپ. |
mercuryoBearerToken |
string | خیر | توکن Mercuryo برای یکپارچگی اضافی. |
locale |
string | خیر | زبان پاسخ (مثلاً en، ru). |
نمونه درخواست
curl -X POST 'https://quickex.io/api/v2/orders/public/create' \
-H 'accept: application/json' \
-H 'B2B-Bearer-Token: yourMercuryoToken' \
-H 'X-Api-Public-Key: yourPublicKey' \
-H 'X-Api-Timestamp: 1691397873000' \
-H 'X-Api-Signature: yourHmacSignature' \
-H 'Content-Type: application/json' \
-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",
"referrerId": "aff_some-affiliate-id",
"markupAffiliateId": "aff_some-affiliate-id",
"rateMode": "FLOATING",
"markup": "0.01",
"mercuryoBearerToken": "string",
"locale": "ru"
}'
پاسخهای ممکن
200 OK — سفارش با موفقیت ایجاد شد؛ شیء کامل سفارش بازگردانده میشود.
401 ERR_UNAUTHORIZED — توکنها یا کلیدها وجود ندارند یا نامعتبر هستند:
{
"status": "ERR_UNAUTHORIZED",
"message": "Unauthorized"
}
مورد استفاده
یک پلتفرم شریک میخواهد هنگام پرداخت کاربر از طریق Mercuryo، سفارشها را بهطور خودکار ایجاد کند.
پس از احراز هویت، Mercuryo یک B2B-Bearer-Token ارائه میدهد و سپس پلتفرم دادههای تبادل را مونتاژ کرده و این اندپوینت را برای ایجاد سفارش در Quickex فراخوانی میکند.
Code Sample
curl -X 'POST' \
'https://quickex.io/api/v2/orders/public/create' \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-H 'X-Api-Public-Key: {YOUR_PUBLIC_KEY}' \
-H 'X-Api-Timestamp: {UNIX_MS_TIMESTAMP}' \
-H 'X-Api-Signature: {SIGNATURE}' \
-d '{
"instrumentFrom": { "currencyTitle": "USDT", "networkTitle": "TRC20" },
"instrumentTo": { "currencyTitle": "LTC", "networkTitle": "LTC" },
"destinationAddress": "MWYK4uQXFvWc1Bj1CPACyX5HTQxUUpRZ2e",
"destinationAddressMemo": null,
"refundAddress": "TFe5tdqSy8CMGMDVHPJHLTK8hrAL6ddUpD",
"refundAddressMemo": null,
"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",
"utmData": {},
"browserFingerprint": "string",
"markup": "0.01",
"mercuryoBearerToken": "string",
"locale": "string"
}'Response Example
{
"deposits": [
{
"createdAt": "2025-12-02T08:52:08.178Z",
"instrument": {
"currencyTitle": "USDT",
"networkTitle": "TRC20"
},
"amount": "1000.1",
"confirmations": 0,
"txId": "0xdeadc0dedeadbeef",
"depositAddress": "0xdeadc0de",
"isPending": true,
"id": 0,
"counterPartyAddress": "0xdeadc0dedeadbeef"
}
],
"withdrawals": [
{
"createdAt": "2025-12-02T08:52:08.178Z",
"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-12-02T08:52:08.179Z",
"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-12-02T08:52:08.179Z",
"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-12-02T08:52:08.179Z"
}
],
"userEmail": "test@example.com",
"rateMode": "FLOATING",
"destinationAddress": "0xdeadbeef",
"destinationAddressMemo": "0xdeadbeef",
"completed": false,
"possibleCashbackAmountUSDT": "500.00",
"redirectUrl": "https://payments.mercuryo.io/",
"minConfirmationsToTrade": 3,
"minConfirmationsToWithdraw": 3
}Try it out
Leave empty to use default
Request Body
Headers
Documentation
نمای کلی
این متد به شما امکان میدهد برای سفارشی عمومی که قبلاً ایجاد شده است، یک ایمیل تنظیم کنید.
از این متد زمانی استفاده میشود که سفارش در درخواست /api/v2/orders/public/create بدون فیلد userEmail ایجاد شده باشد، اما بعداً نیاز باشد یک ایمیل به آن متصل شود (بهعنوان مثال برای اینکه کاربر بتواند اعلانهای مربوط به وضعیت سفارش را دریافت کند).
> مهم: ایمیل را میتوان فقط یکبار تنظیم کرد. اگر سفارش از قبل دارای فیلد userEmail باشد، از طریق این متد امکان تغییر آن وجود ندارد.
درخواست HTTP
Method: POST
URL: https://quickex.io/api/v2/orders/public/set-email
نمونه درخواست
curl -X 'POST' \ 'https://quickex.io/api/v2/orders/public/set-email' \ -H 'accept: application/json' \ -H 'X-Api-Public-Key: {YOUR_PUBLIC_KEY}' \ -H 'X-Api-Timestamp: {UNIX_MS_TIMESTAMP}' \ -H 'X-Api-Signature: {SIGNATURE}' \ -H 'Content-Type: application/json' \ -d '{ "orderId": 3038, "userEmail": "QA@quickex.com" }'
هدرها (Headers)
| هدر | الزامی | توضیحات |
|---|---|---|
Accept |
بله | مقدار پیشنهادی: application/json. |
Content-Type |
بله | application/json. |
X-Api-Public-Key |
بله | کلید عمومی API شما. |
X-Api-Timestamp |
بله | برچسب زمانی (معمولاً زمان یونیکس بر حسب میلیثانیه) که در امضا استفاده میشود. |
X-Api-Signature |
بله | امضای درخواست (HMAC SHA256 مطابق طرح API نسخه ۲). |
پارامترهای درخواست
پارامترهای بدنه (Body Parameters)
{ "orderId": 3038, "userEmail": "QA@quickex.com" }
| فیلد | نوع | الزامی | توضیحات |
|---|---|---|---|
orderId |
number | بله | شناسه سفارشی که میخواهید برای آن ایمیل تنظیم کنید. |
userEmail |
string | بله | ایمیل کاربر که به سفارش متصل شده و برای اعلانها استفاده خواهد شد. |
محدودیتها: اگر برای این سفارش از قبل فیلد userEmail تنظیم شده باشد، این متد خطای 403 ERR_FORBIDDEN برمیگرداند.
قالب پاسخ (Response Format)
اگر درخواست با موفقیت انجام شود، این متد یک شیء JSON از سفارش برمیگرداند که مشابه پاسخ متدهای POST /api/v2/orders/public/create و GET /api/v2/orders/info است، با این تفاوت که فیلد userEmail در آن مقداردهی شده است.
نمونه پاسخ
{ "deposits": [ { "createdAt": "2025-12-02T09:31:46.246Z", "instrument": { "currencyTitle": "USDT", "networkTitle": "TRC20" }, "amount": "1000.1", "confirmations": 0, "txId": "0xdeadc0dedeadbeef", "depositAddress": "0xdeadc0de", "isPending": true, "id": 0, "counterPartyAddress": "0xdeadc0dedeadbeef" } ], "withdrawals": [ { "createdAt": "2025-12-02T09:31:46.246Z", "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-12-02T09:31:46.246Z", "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-12-02T09:31:46.246Z", "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-12-02T09:31:46.246Z" } ], "userEmail": "QA@example.com", "rateMode": "FLOATING", "destinationAddress": "0xdeadbeef", "destinationAddressMemo": "0xdeadbeef", "completed": false, "possibleCashbackAmountUSDT": "500.00", "redirectUrl": "https://payments.mercuryo.io/", "minConfirmationsToTrade": 3, "minConfirmationsToWithdraw": 3 }
نکتهی کلیدی: فیلد userEmail متصل به سفارش در پاسخ مقداردهی شده خواهد بود.
خطاها (Errors)
403 ERR_FORBIDDEN — ایمیل از قبل تنظیم شده است
{ "status": "ERR_FORBIDDEN", "message": "Order.userEmail already set and can not be modified" }
این خطا زمانی برگردانده میشود که تلاش کنید ایمیل سفارشی را تغییر دهید که فیلد userEmail آن از قبل تنظیم شده است (چه در زمان ایجاد سفارش و چه در یک فراخوانی قبلی set-email).
چه کار باید کرد:
- برای سفارشهایی که از قبل ایمیل دارند، امکان تغییر ایمیل وجود ندارد.
موارد استفادهی ممکن
- افزودن ایمیل برای سفارشهایی که به صورت ناشناس ایجاد شدهاند (برای مثال، از طریق ویجتی که فیلد ایمیل در آن اجباری نیست).
Code Sample
curl -X 'POST' \
'https://quickex.io/api/v2/orders/public/set-email' \
-H 'accept: application/json' \
-H 'X-Api-Public-Key: {YOUR_PUBLIC_KEY}' \
-H 'X-Api-Timestamp: {UNIX_MS_TIMESTAMP}' \
-H 'X-Api-Signature: {SIGNATURE}'
-H 'Content-Type: application/json' \
-d '{
"orderId": 3038,
"userEmail": "QA@quickex.com"
}'Response Example
{
"deposits": [
{
"createdAt": "2025-12-02T09:31:46.246Z",
"instrument": {
"currencyTitle": "USDT",
"networkTitle": "TRC20"
},
"amount": "1000.1",
"confirmations": 0,
"txId": "0xdeadc0dedeadbeef",
"depositAddress": "0xdeadc0de",
"isPending": true,
"id": 0,
"counterPartyAddress": "0xdeadc0dedeadbeef"
}
],
"withdrawals": [
{
"createdAt": "2025-12-02T09:31:46.246Z",
"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-12-02T09:31:46.246Z",
"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-12-02T09:31:46.246Z",
"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-12-02T09:31:46.246Z"
}
],
"userEmail": "QA@example.com",
"rateMode": "FLOATING",
"destinationAddress": "0xdeadbeef",
"destinationAddressMemo": "0xdeadbeef",
"completed": false,
"possibleCashbackAmountUSDT": "500.00",
"redirectUrl": "https://payments.mercuryo.io/",
"minConfirmationsToTrade": 3,
"minConfirmationsToWithdraw": 3
}Try it out
Leave empty to use default
Headers
Documentation
نمای کلی
این متد اطلاعات دقیق مربوط به یک سفارش مشخص را بر اساس orderId برمیگرداند.
برخلاف لیست سفارشها (GET /api/v2/orders)، این متد تمام دادههای مرتبط با سفارش انتخابشده را ارائه میکند:
جفت کامل ابزارها همراه با پارامترها، نرخ قفلشده (claimedPublicRate)،
حداقل/حداکثر تأییدیهها، تاریخچه رویدادها (orderEvents)، آدرس واریز،
همچنین اطلاعات مربوط به کشبک احتمالی یا اعتبارهای ریفرال و وضعیت تکمیل شدن.
دسترسی به سفارشها با کلید API فعلی محدود میشود — شما فقط میتوانید سفارشهایی را مشاهده کنید که
با استفاده از X-Api-Public-Key شما ایجاد شدهاند.
درخواست HTTP
متد: GET
URL: https://quickex.io/api/v2/orders/public-info
نمونه درخواست
curl -X 'GET' \
'https://quickex.io/api/v2/orders/public-info?orderId=3038' \
-H 'accept: application/json' \
-H 'X-Api-Public-Key: {YOUR_PUBLIC_KEY}' \
-H 'X-Api-Timestamp: {UNIX_MS_TIMESTAMP}' \
-H 'X-Api-Signature: {SIGNATURE}'
هدرها
| هدر | الزامی | توضیحات |
|---|---|---|
| Accept | بله | مقدار پیشنهادی: application/json. |
| X-Api-Public-Key | بله | کلید عمومی API شما. |
| X-Api-Timestamp | بله | تایماستمپ (معمولاً UNIX بر حسب میلیثانیه) که در امضا لحاظ میشود. |
| X-Api-Signature | بله | امضای درخواست (HMAC SHA256 مطابق با طرح API v2). |
پارامترهای درخواست
پارامترهای Query
| پارامتر | نوع | الزامی | توضیحات |
|---|---|---|---|
| orderId | int | بله | شناسه سفارشی که اطلاعات آن درخواست میشود. |
فرمت پاسخ
این متد یک آبجکت JSON شامل اطلاعات کامل سفارش را برمیگرداند.
نمونه پاسخ
{
"orderId": 174059,
"legacyOrderId": "602184da-5881-408e-bffa-3562702d7d3e",
"pair": {
"instrumentFrom": {
"currencyTitle": "XRP",
"networkTitle": "XRP",
"precisionDecimals": 2,
"slug": "xrp",
"liquidityProviderCurrencies": [
{
"minConfirmationsToTrade": 12,
"minConfirmationsToWithdraw": 12
}
]
},
"instrumentTo": {
"currencyTitle": "TRX",
"networkTitle": "TRX",
"precisionDecimals": 2,
"slug": "trx",
"liquidityProviderCurrencies": [
{
"minConfirmationsToTrade": 3,
"minConfirmationsToWithdraw": 3
}
]
}
},
"createdAt": "2025-12-15T14:38:40.523Z",
"instrumentFromCurrencyTitle": "XRP",
"instrumentFromNetworkTitle": "XRP",
"instrumentToCurrencyTitle": "TRX",
"instrumentToNetworkTitle": "TRX",
"feeMode": "FIXED",
"userId": 2382,
"userEmail": "sam.white@support.example.io",
"isPlatformEmail": false,
"refundAddress": "rNFSruW9B1NwVoGgUMmfwXbruWMp8Mgv3K",
"refundAddressMemo": null,
"destinationAddress": "TWRW8YiZtjW7JkYxxzuPrN9fQzoDK5FHgm",
"destinationAddressMemo": null,
"claimedNetworkFee": "1.987665024814",
"rateMode": "FIXED",
"claimedDepositAmount": "57",
"amountToGet": "393.07",
"platformFee": "3.86",
"redirectUrl": null,
"orderEvents": [
{
"createdAt": "2025-12-15T14:42:43.317Z",
"kind": "WITHDRAWAL_COMPLETED"
},
{
"createdAt": "2025-12-15T14:41:54.109Z",
"kind": "FUNDS_WITHDRAWAL_START"
},
{
"createdAt": "2025-12-15T14:41:00.379Z",
"kind": "DEPOSIT_REGISTERED"
},
{
"createdAt": "2025-12-15T14:39:58.760Z",
"kind": "INCOMING_FUNDS_DETECTED"
},
{
"createdAt": "2025-12-15T14:38:41.642Z",
"kind": "CREATION_END"
}
],
"depositAddress": {
"instrument": {
"currencyTitle": "XRP",
"networkTitle": "XRP"
},
"depositAddress": "rwXnv8BfEHi7WmkLXZ6ChcWX9hMnSsTMNK",
"depositAddressMemo": "2097040307"
},
"deposits": [
{
"id": 50958,
"counterPartyAddress": null,
"createdAt": "2025-12-15T14:39:45.000Z",
"instrument": {
"currencyTitle": "XRP",
"networkTitle": "XRP"
},
"amount": "57",
"amountUSDT": "112.40742",
"txId": "DEA15CCF7AF04799A090298CB06D78DD177B3B518BED9C9DE8A0A5B717CCDBE7",
"confirmations": 12,
"depositAddress": {
"instrument": {
"currencyTitle": "XRP",
"networkTitle": "XRP"
},
"depositAddress": "rwXnv8BfEHi7WmkLXZ6ChcWX9hMnSsTMNK",
"depositAddressMemo": "2097040307"
},
"isPending": false
}
],
"withdrawals": [
{
"instrument": {
"currencyTitle": "TRX",
"networkTitle": "TRC20"
},
"amount": "393.07",
"txId": "39dc5802a931da0613f687087397e812dd6c0aa0b9041124d76e864e37bd1e09",
"createdAt": "2025-12-15T14:41:58.926Z",
"networkFee": "1.98"
}
],
"KYCFormLink": null,
"liquidityProviderPublicCode": "hat",
"possibleRefferalAccrualAmount": "0.78",
"possibleCashbackAmountUSDT": "0.22",
"actualCashbackAmountUSDT": "0.22",
"claimedPublicRate": {
"claimedAmountToReceive": "393.07",
"finalNetworkFeeAmount": "1.9876650248138958",
"platformFee_Absolute": null,
"price": "7.000992555831266",
"quotes": {
"sellQuote": {
"baseValue": "0.2821",
"quoteValue": "1.9453930016929823"
},
"buyQuote": {
"baseValue": "1.97499",
"quoteValue": "0.2777753832835882"
}
},
"updatedAt": "2025-12-15T14:38:36.201Z",
"instrumentFrom": {
"currencyTitle": "XRP",
"networkTitle": "XRP",
"precisionDecimals": 2,
"slug": "xrp",
"liquidityProviderCurrencies": [
{
"minConfirmationsToTrade": 12,
"minConfirmationsToWithdraw": 12
}
]
},
"instrumentTo": {
"currencyTitle": "TRX",
"networkTitle": "TRX",
"precisionDecimals": 2,
"slug": "trx",
"liquidityProviderCurrencies": [
{
"minConfirmationsToTrade": 3,
"minConfirmationsToWithdraw": 3
}
]
}
},
"completed": true,
"minConfirmationsToTrade": 12,
"minConfirmationsToWithdraw": 12
}
شرح فیلدهای پاسخ
در ادامه، فیلدهای اصلی پاسخ آمدهاند. برخی ساختارهای تو در تو (برای مثال instrumentFrom / instrumentTo) ساختاری مشابه آبجکتهای متدهای /instruments و /rates دارند.
اطلاعات عمومی سفارش
| فیلد | نوع | توضیحات |
|---|---|---|
| orderId | number | شناسه یکتای سفارش در سیستم Quickex. |
| legacyOrderId | string | شناسه سفارش در سیستم قدیمی (در صورت استفاده برای مهاجرت/سازگاری). |
| createdAt | string | زمان ایجاد سفارش (ISO8601). |
| instrumentFromCurrencyTitle | string | کد ارز مبدا (مثلاً BTC). |
| instrumentFromNetworkTitle | string | شبکه مبدا (مثلاً BTC). |
| instrumentToCurrencyTitle | string | کد ارز مقصد (مثلاً USDT). |
| instrumentToNetworkTitle | string | شبکه مقصد (مثلاً TRC20). |
| feeMode | string | حالت کارمزد سفارش: • FLOATING – کارمزد میتواند بسته به شرایط شبکه یا نوع بازار تغییر کند.• FIXED – کارمزد در زمان ایجاد سفارش ثابت میشود. |
| rateMode | string | حالت نرخ: • FIXED – نرخ هنگام ایجاد سفارش قفل میشود؛ مقدار دریافتی تغییر نمیکند.• FLOATING – نرخ میتواند تا پایان سفارش نوسان کند؛ مقدار دریافتی مطابق شرایط فعلی بازار بهروزرسانی میشود. |
| claimedDepositAmount | string | مقدار واریزی که هنگام ایجاد سفارش استفاده شده است. |
| amountToGet | string | مقداری که کاربر باید در این سفارش دریافت کند. |
| claimedNetworkFee | string | کارمزد شبکه که در محاسبه سفارش لحاظ شده است. |
| platformFee | string | کارمزد پلتفرم. |
| redirectUrl | string | URL برای ریدایرکت به سرویس خارجی. |
| completed | boolean | شاخص تکمیل سفارش: true — تبادل تکمیل شده، false — در حال پردازش. |
| minConfirmationsToTrade | number | حداقل تأییدیهها برای اینکه واریز برای تبادل قابل استفاده باشد. |
| minConfirmationsToWithdraw | number | حداقل تأییدیههای لازم برای برداشت. |
جفت ابزارها (pair)
"pair": {
"instrumentFrom": {
"currencyTitle": "XRP",
"networkTitle": "XRP",
"precisionDecimals": 2,
"slug": "xrp",
"liquidityProviderCurrencies": [
{
"minConfirmationsToTrade": 12,
"minConfirmationsToWithdraw": 12
}
]
},
"instrumentTo": {
"currencyTitle": "TRX",
"networkTitle": "TRX",
"precisionDecimals": 2,
"slug": "trx",
"liquidityProviderCurrencies": [
{
"minConfirmationsToTrade": 3,
"minConfirmationsToWithdraw": 3
}
]
}
},
| فیلد | نوع | توضیحات |
|---|---|---|
| instrumentFrom | object | ابزار مبدا: ارزی که کاربر ارسال میکند. |
| instrumentFrom.currencyTitle | string | کد ارز ابزار مبدا (مثلاً XRP). |
| instrumentFrom.networkTitle | string | شبکه بلاکچین ابزار مبدا. |
| instrumentFrom.precisionDecimals | number | تعداد رقم اعشار پشتیبانیشده برای مقادیر. |
| instrumentFrom.slug | string | شناسه داخلی ارز. |
| instrumentFrom.liquidityProviderCurrencies | array | تنظیمات ارائهدهنده نقدینگی برای این ارز و شبکه. |
| instrumentFrom.liquidityProviderCurrencies.minConfirmationsToTrade | number | حداقل تأییدیهها برای استفاده از واریز در تبادل. |
| instrumentFrom.liquidityProviderCurrencies.minConfirmationsToWithdraw | number | حداقل تأییدیهها پیش از اجازه برداشت. |
| instrumentTo | object | ابزار مقصد: ارزی که کاربر دریافت میکند. |
| instrumentTo.currencyTitle | string | کد ارز ابزار مقصد (مثلاً TRX). |
| instrumentTo.networkTitle | string | شبکه بلاکچین ابزار مقصد. |
| instrumentTo.precisionDecimals | number | تعداد رقم اعشار پشتیبانیشده برای مقادیر. |
| instrumentTo.slug | string | شناسه داخلی ارز. |
| instrumentTo.liquidityProviderCurrencies | array | تنظیمات ارائهدهنده نقدینگی برای این ارز و شبکه. |
| instrumentTo.liquidityProviderCurrencies.minConfirmationsToTrade | number | حداقل تأییدیهها قبل از اینکه وجوه قابل تبادل باشند. |
| instrumentTo.liquidityProviderCurrencies.minConfirmationsToWithdraw | number | حداقل تأییدیهها قبل از اینکه وجوه قابل برداشت باشند. |
موارد استفاده ممکن
- دریافت جزئیات کامل یک سفارش مشخص برای نمایش تاریخچه کامل تراکنشها، وضعیت و دادههای مالی مرتبط در حساب کاربر/داشبورد شریک، یا برای اهداف تطبیق و ممیزی.
Code Sample
curl -X 'GET' \
'https://quickex.io/api/v2/orders/info?orderId=3038' \
-H 'accept: application/json' \
-H 'X-Api-Public-Key: {YOUR_PUBLIC_KEY}' \
-H 'X-Api-Timestamp: {UNIX_MS_TIMESTAMP}' \
-H 'X-Api-Signature: {SIGNATURE}'Response Example
{
"orderId": 3038,
"legacyOrderId": "4602ddf9-e516-4c3a-9146-7bc748edd89b",
"pair": {
"instrumentFrom": {
"currencyTitle": "BTC",
"networkTitle": "BTC",
"precisionDecimals": 7,
"slug": "btc",
"liquidityProviderCurrencies": [
{
"minConfirmationsToTrade": 3,
"minConfirmationsToWithdraw": 3
}
]
},
"instrumentTo": {
"currencyTitle": "USDT",
"networkTitle": "TRC20",
"precisionDecimals": 5,
"slug": "usdttrc20",
"liquidityProviderCurrencies": [
{
"minConfirmationsToTrade": 3,
"minConfirmationsToWithdraw": 3
}
]
}
},
"createdAt": "2025-04-28T13:15:03.006Z",
"instrumentFromCurrencyTitle": "BTC",
"instrumentFromNetworkTitle": "BTC",
"instrumentToCurrencyTitle": "USDT",
"instrumentToNetworkTitle": "TRC20",
"feeMode": "FLOATING",
"userId": 229,
"userEmail": "qa@support.quickex.io",
"isPlatformEmail": false,
"refundAddress": null,
"refundAddressMemo": null,
"destinationAddress": "TFjfHBiDcL6B5S5W8g9b6gU2tbvnTR52ya",
"destinationAddressMemo": null,
"claimedNetworkFee": "1.5",
"rateMode": "FLOATING",
"claimedDepositAmount": "0.034268",
"amountToGet": "3263.05",
"platformFee": null,
"redirectUrl": null,
"orderEvents": [
{
"createdAt": "2025-04-28T13:15:03.021Z",
"kind": "CREATION_END"
}
],
"depositAddress": {
"instrument": {
"currencyTitle": "BTC",
"networkTitle": "BTC"
},
"depositAddress": "3LpR1ZKEVysoi6sxFqoGtB49638RsxzKSh",
"depositAddressMemo": null
},
"deposits": [],
"withdrawals": [],
"KYCFormLink": null,
"liquidityProviderPublicCode": "hat",
"possibleRefferalAccrualAmount": "3.01",
"possibleCashbackAmountUSDT": "0",
"actualCashbackAmountUSDT": null,
"claimedPublicRate": {
"claimedAmountToReceive": "3259.38",
"finalNetworkFeeAmount": "1.5",
"price": "95158.1",
"quotes": {
"sellQuote": {
"baseValue": "1",
"quoteValue": "95114.32743505127"
},
"buyQuote": {
"baseValue": "95158",
"quoteValue": "0.9995400016924599"
}
},
"updatedAt": "2025-04-28T13:11:30.251Z",
"instrumentFrom": {
"currencyTitle": "BTC",
"networkTitle": "BTC",
"precisionDecimals": 7,
"slug": "btc",
"liquidityProviderCurrencies": [
{
"minConfirmationsToTrade": 3,
"minConfirmationsToWithdraw": 3
}
]
},
"instrumentTo": {
"currencyTitle": "USDT",
"networkTitle": "TRC20",
"precisionDecimals": 5,
"slug": "usdttrc20",
"liquidityProviderCurrencies": [
{
"minConfirmationsToTrade": 3,
"minConfirmationsToWithdraw": 3
}
]
}
},
"completed": false,
"minConfirmationsToTrade": 3,
"minConfirmationsToWithdraw": 3
}Try it out
Leave empty to use default
Query Parameters
Headers
Documentation
تغییر حالت نرخ (rate mode) برای یک سفارش را تأیید میکند. این متد در مواردی استفاده میشود که سفارش با نرخ ثابت ایجاد شده باشد،
اما در طول فرایند تبادل به نرخ شناور تغییر کرده باشد (برای مثال، به دلیل عبور از محدودیتها یا نوسان زیاد).
این متد به کاربر اجازه میدهد حالت جدید را بپذیرد و پردازش سفارش را ادامه دهد.
URL
https://quickex.io/api/v2/orders/public/accept-rate-mode-change
Headers
Accept: application/jsonContent-Type: application/json
Request Body (JSON)
| فیلد | نوع | الزامی | توضیحات |
|---|---|---|---|
orderId |
number | بله | شناسه سفارشی که برای آن لازم است تغییر حالت نرخ تأیید شود. |
destinationAddress |
string | بله | آدرس مقصد مرتبط با سفارش (بهعنوان بررسی اضافی استفاده میشود). |
{
"orderId": 123456,
"destinationAddress": "0xdeadbeef"
}
Request Example (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"
}'
Responses
| کد | توضیحات |
|---|---|
201 Created |
تغییر حالت نرخ تأیید شد و پردازش سفارش ادامه پیدا میکند. |
404 Not Found |
سفارش پیدا نشد ({"status":"ERR_NOT_FOUND","message":"Order not found"}). |
400 Bad Request |
خطای اعتبارسنجی (برای مثال، دادههای ورودی نامعتبر). |
5xx |
خطای داخلی سرور. |
Notes
- این متد فقط زمانی فراخوانی میشود که سفارش حالت نرخ خود را تغییر داده باشد (برای مثال، از FIXED به FLOATING).
- بدون تأیید، پردازش سفارش متوقف خواهد شد.
- در صورت موفقیت، پاسخ وضعیت 201 را برمیگرداند و سفارش وارد وضعیت ادامه پردازش میشود.
Code Sample
curl -X 'POST' \
'https://quickex.io/api/v1/orders/public/accept-rate-mode-change' \
-H 'accept: */*' \
-H 'Content-Type: application/json' \
-d '{
"orderId": {},
"destinationAddress": "string"
}'Try it out
Leave empty to use default
Request Body
Headers
Documentation
درخواست بازپرداخت برای یک سفارش را ثبت میکند. در شرایطی استفاده میشود که تبادل تکمیل نشده باشد یا لازم باشد وجوه به کاربر بازگردانده شود.
برای موفقیت، باید مبلغ بازپرداخت و آدرس بازپرداخت مشخص شوند.
URL
https://quickex.io/api/v2/orders/public/request-refund
Headers
Accept: application/jsonContent-Type: application/json
Request Body (JSON)
| فیلد | نوع | الزامی | توضیحات |
|---|---|---|---|
orderId |
number | بله | شناسه سفارشی که برای آن بازپرداخت درخواست میشود. |
destinationAddress |
string | بله | آدرس مقصدی که در سفارش اولیه مشخص شده است (بهعنوان بررسی اضافی استفاده میشود). |
refundAmount |
string | بله | مبلغی که باید به کاربر بازپرداخت شود. |
refundAddress |
string | بله | آدرس کیف پول کاربر که وجوه به آن بازپرداخت خواهد شد. |
claimedNetworkFee |
string | خیر | مبلغ کارمزد شبکهای که کاربر موافقت میکند برای بازپرداخت پرداخت کند. |
{
"orderId": 123456,
"destinationAddress": "0xdeadbeef",
"refundAmount": "10.00",
"refundAddress": "0xuserrefundwallet",
"claimedNetworkFee": "0.50"
}
Request Example (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"
}'
Responses
| کد | توضیحات |
|---|---|
201 Created |
درخواست بازپرداخت پذیرفته شد و پردازش خواهد شد. |
404 Not Found |
سفارش پیدا نشد ({"status":"ERR_NOT_FOUND","message":"Order not found"}). |
400 Bad Request |
خطای اعتبارسنجی (برای مثال، مبلغ بازپرداخت کمتر از حداقل مجاز یا refundAddress نامعتبر). |
5xx |
خطای داخلی سرور. |
Notes
- این متد فقط برای سفارشهایی استفاده میشود که قابل تکمیل نیستند.
- بازپرداخت به آدرس مشخصشده در
refundAddressانجام میشود، منهای هرگونه کارمزد شبکه قابل اعمال.- پس از ارسال، بازپرداخت ممکن است نیازمند بررسی دستی توسط تیم پشتیبانی باشد.
Code Sample
curl -X 'POST' \
'https://quickex.io/api/v1/orders/public/request-refund' \
-H 'accept: */*' \
-H 'Content-Type: application/json' \
-d '{
"orderId": {},
"destinationAddress": "string",
"refundAmount": "10.00",
"refundAddress": "string",
"claimedNetworkFee": "10.00"
}'Try it out
Leave empty to use default
Request Body
Headers
Documentation
اطلاعات بازپرداخت را برای یک سفارش مشخص برمیگرداند.
پس از ایجاد درخواست بازپرداخت برای بررسی جزئیات (مبلغ، آدرس بازپرداخت، وضعیت) استفاده میشود.
URL
https://quickex.io/api/v2/orders/order-refund-info
Request Parameters (Query)
| پارامتر | نوع | الزامی | توضیحات |
|---|---|---|---|
orderId |
string | بله | شناسه سفارشی که باید دادههای بازپرداخت آن دریافت شود. |
curl -X GET \
'https://quickex.io/api/v1/orders/order-refund-info?orderId=1234' \
-H 'Accept: application/json'
Responses
| کد | توضیحات |
|---|---|
200 OK |
یک JSON با اطلاعات بازپرداخت برمیگرداند (مبلغ، آدرس، وضعیت، کارمزدها). |
400 Bad Request |
خطای اعتبارسنجی یا دادههای سفارش نامعتبر ({"status":"ERR_BAD_REQUEST","message":"Unknown liquidity provider title: ..."}). |
404 Not Found |
سفارش پیدا نشد. |
5xx |
خطای داخلی سرور. |
Notes
- این متد فقط برای سفارشهایی داده برمیگرداند که برای آنها بازپرداخت آغاز شده باشد.
- در پاسخ موفق
200، JSON ممکن است شامل مبلغ بازپرداخت، آدرس بازپرداخت و کارمزدهای شبکه باشد.- برای خطاهای اعتبارسنجی (
400)، سرور علت را در فیلدmessageارائه میکند.
Code Sample
curl -X 'GET' \
'https://quickex.io/api/v1/orders/order-refund-info?orderId={YOUR_ORDERID}' \
-H 'accept: */*'Try it out
Leave empty to use default