For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Dashboard
DocsAPI Reference
DocsAPI Reference
    • End Points
  • PARTNER
    • GETGet Orders
    • GETGet Order By ID
    • GETGet Webhooks
    • POSTRefresh Access Token
    • POSTCreate Widget URL
  • COUNTRIES
    • GETGet Countries
  • CURRENCIES
    • GETGet Crypto Currencies
    • GETGet Fiat Currencies
    • GETGet Price
    • GETVerify Wallet Address
  • TRANSAK WHITELABEL API
    • End Points
Dashboard
LogoLogo
PARTNER

Get Orders

||View as Markdown|
GET
https://api-stg.transak.com/partners/api/v2/orders
GET
/partners/api/v2/orders
$curl https://api-stg.transak.com/partners/api/v2/orders \
> -H "access-token: "
1{
2 "meta": {
3 "filter": {
4 "productsAvailed": [
5 "BUY"
6 ],
7 "status": [
8 "COMPLETED"
9 ]
10 },
11 "sortOrder": "desc",
12 "startDate": "2024-04-01",
13 "endDate": "2024-05-01",
14 "limit": 100,
15 "skip": 0,
16 "totalCount": 12
17 },
18 "data": [
19 {
20 "_id": "7d8e0655-728e-458c-9c15-b3e9f2aa66ed",
21 "walletAddress": "0x12d8885...e0F0BF",
22 "createdAt": "2024-04-23T14:41:14.063Z",
23 "status": "COMPLETED",
24 "fiatCurrency": "GBP",
25 "cryptoCurrency": "ETH",
26 "isBuyOrSell": "BUY",
27 "fiatAmount": 50,
28 "amountPaid": 50,
29 "paymentOptionId": "gbp_bank_transfer",
30 "network": "ethereum",
31 "quoteId": "4015367c-3636-4ea1-a4a9-f583608ad3b5",
32 "userId": "aebd10cb-0f51-4152-b98d-708602cf26",
33 "dispute": false,
34 "ipAddress": "35.177.158.9",
35 "walletLink": "https://sepolia.etherscan.io/address/0x12d888.......5e0F0BF",
36 "orderProcessingType": "NORMAL",
37 "addressAdditionalData": false,
38 "appVersionName": "staging-api",
39 "conversionPrice": 0.0003803236484877352,
40 "cryptoAmount": 0.01596979,
41 "totalFeeInFiat": 8.01,
42 "totalfeeDecimal": 0.1602,
43 "fiatAmountInUsd": 62.17,
44 "countryCode": "FR",
45 "referenceCode": 393693,
46 "liquidityProvider": "MODULR",
47 "paymentTnxId": "A2100C5B5K_T2100AEP4M",
48 "paymentdateTime": "2024-04-23T14:41:18.000Z",
49 "isFirstOrder": true,
50 "updatedAt": "2024-04-23T14:41:21.638Z",
51 "exchangeId": "binance",
52 "transactionHash": "DUMMY_TX_ID",
53 "transactionLink": "https://sepolia.etherscan.io/tx/DUMMY_TX_ID",
54 "partnerFeeInUsd": "1.24",
55 "partnerFeeDecimal": 0.02,
56 "completedAt": "2024-04-23T14:41:50.278Z"
57 },
58 {
59 "_id": "94a81424-387a-4760-b37d-812d671a3cee",
60 "walletAddress": "0xad50...e22916f9c",
61 "createdAt": "2024-04-23T14:33:17.899Z",
62 "status": "COMPLETED",
63 "fiatCurrency": "GBP",
64 "cryptoCurrency": "ETH",
65 "isBuyOrSell": "BUY",
66 "fiatAmount": 50,
67 "amountPaid": 50,
68 "paymentOptionId": "gbp_bank_transfer",
69 "network": "ethereum",
70 "quoteId": "654e9c79-84d2-497a-8fec-85f2634365e0",
71 "userId": "ada1b65c-3233-4f01-9786-9097d93b3039",
72 "dispute": false,
73 "ipAddress": "35.177.158.9",
74 "walletLink": "https://sepolia.etherscan.io/address/0xad50...5E3FB12",
75 "orderProcessingType": "NORMAL",
76 "addressAdditionalData": false,
77 "appVersionName": "staging-api",
78 "conversionPrice": 0.0003811828571428571,
79 "cryptoAmount": 0.01600968,
80 "totalFeeInFiat": 8,
81 "totalfeeDecimal": 0.16,
82 "fiatAmountInUsd": 62.17,
83 "countryCode": "FR",
84 "referenceCode": 720473,
85 "liquidityProvider": "MODULR",
86 "paymentTnxId": "A2100C59XH_T2100AEP1W",
87 "paymentdateTime": "2024-04-23T14:33:22.000Z",
88 "isFirstOrder": false,
89 "updatedAt": "2024-04-23T14:33:26.715Z",
90 "exchangeId": "binance",
91 "transactionHash": "DUMMY_TX_ID",
92 "transactionLink": "https://sepolia.etherscan.io/tx/DUMMY_TX_ID",
93 "partnerFeeInUsd": "1.24",
94 "partnerFeeDecimal": 0.02,
95 "completedAt": "2024-04-23T14:33:48.297Z"
96 },
97 {
98 "_id": "c49e3630-56ae-40f1-a9ca-12d6cc65b487",
99 "walletAddress": "0xad50...e22916f45",
100 "createdAt": "2024-04-23T13:42:55.884Z",
101 "status": "COMPLETED",
102 "fiatCurrency": "GBP",
103 "cryptoCurrency": "ETH",
104 "isBuyOrSell": "BUY",
105 "fiatAmount": 50,
106 "amountPaid": 50,
107 "paymentOptionId": "gbp_bank_transfer",
108 "network": "ethereum",
109 "quoteId": "9250de68-a51b-4177-afa2-6acbd1e9f937",
110 "userId": "ada1b65c-3233-4f01-9786-9097d93b3039",
111 "dispute": false,
112 "ipAddress": "35.177.158.9",
113 "walletLink": "https://sepolia.etherscan.io/address/0xad50e...45E3FB12",
114 "orderProcessingType": "NORMAL",
115 "addressAdditionalData": false,
116 "appVersionName": "staging-api",
117 "conversionPrice": 0.00038612903992395436,
118 "cryptoAmount": 0.01624831,
119 "totalFeeInFiat": 7.92,
120 "totalfeeDecimal": 0.15839999999999999,
121 "fiatAmountInUsd": 61.94,
122 "countryCode": "FR",
123 "referenceCode": 720473,
124 "liquidityProvider": "MODULR",
125 "paymentTnxId": "A2100C59XH_T2100AENNA",
126 "paymentdateTime": "2024-04-23T13:43:00.000Z",
127 "isFirstOrder": true,
128 "updatedAt": "2024-04-23T13:43:08.429Z",
129 "exchangeId": "binance",
130 "transactionHash": "DUMMY_TX_ID",
131 "transactionLink": "https://sepolia.etherscan.io/tx/DUMMY_TX_ID",
132 "partnerFeeInUsd": "1.24",
133 "partnerFeeDecimal": 0.02,
134 "completedAt": "2024-04-23T13:43:14.954Z"
135 },
136 {
137 "_id": "78ca7b6b-6cd9-4eac-a39f-4a49f8d8b99b",
138 "walletAddress": "0xds...3FB12",
139 "createdAt": "2024-04-23T12:54:12.571Z",
140 "status": "COMPLETED",
141 "fiatCurrency": "GBP",
142 "cryptoCurrency": "ETH",
143 "isBuyOrSell": "BUY",
144 "fiatAmount": 50,
145 "amountPaid": 50,
146 "paymentOptionId": "credit_debit_card",
147 "network": "ethereum",
148 "quoteId": "4249cdaf-2cb9-4f9e-bc3e-83cf40a9897a",
149 "userId": "243a8ce2-9cc6-41a9-aaeb-b0deeb0b19a3",
150 "dispute": false,
151 "ipAddress": "35.177.158.9",
152 "walletLink": "https://sepolia.etherscan.io/address/0xad...45E3FB12",
153 "orderProcessingType": "NORMAL",
154 "addressAdditionalData": false,
155 "appVersionName": "staging-api",
156 "conversionPrice": 0.0003855444857496902,
157 "cryptoAmount": 0.01555672,
158 "totalFeeInFiat": 9.65,
159 "totalfeeDecimal": 0.193,
160 "fiatAmountInUsd": 62.02,
161 "countryCode": "IN",
162 "referenceCode": 204115,
163 "liquidityProvider": "CHECKOUT",
164 "paymentTnxId": "6627af75b6fc7f773eca785d",
165 "paymentdateTime": "2024-04-23T12:55:18.132088Z",
166 "isFirstOrder": false,
167 "updatedAt": "2024-04-23T12:55:29.473Z",
168 "exchangeId": "binance",
169 "transactionHash": "DUMMY_TX_ID",
170 "transactionLink": "https://sepolia.etherscan.io/tx/DUMMY_TX_ID",
171 "partnerFeeInUsd": "1.24",
172 "partnerFeeDecimal": 0.02,
173 "completedAt": "2024-04-23T12:55:43.238Z"
174 },
175 {
176 "_id": "daad83b3-d2f7-44fa-aefa-7e39b230ad32",
177 "walletAddress": "0x9200...806FAc8b9",
178 "createdAt": "2024-04-23T12:47:08.507Z",
179 "status": "COMPLETED",
180 "fiatCurrency": "EUR",
181 "cryptoCurrency": "ETH",
182 "isBuyOrSell": "BUY",
183 "fiatAmount": 50,
184 "amountPaid": 50,
185 "paymentOptionId": "sepa_bank_transfer",
186 "network": "ethereum",
187 "quoteId": "d1c54f13-e4a0-4b0e-a03e-1aacc7d4d675",
188 "userId": "243a8ce2-9cc6-41a9-aaeb-b0deeb0b19a3",
189 "dispute": false,
190 "ipAddress": "35.177.158.9",
191 "walletLink": "https://sepolia.etherscan.io/address/0x9200...269C5029D",
192 "orderProcessingType": "NORMAL",
193 "addressAdditionalData": false,
194 "appVersionName": "staging-api",
195 "conversionPrice": 0.0003339083839611179,
196 "cryptoAmount": 0.01374033,
197 "totalFeeInFiat": 8.85,
198 "totalfeeDecimal": 0.177,
199 "fiatAmountInUsd": 53.38,
200 "countryCode": "IN",
201 "referenceCode": 204115,
202 "liquidityProvider": "MODULR",
203 "paymentTnxId": "A2100C59RN_T2100AEMJS",
204 "paymentdateTime": "2024-04-23T12:47:12.000Z",
205 "isFirstOrder": false,
206 "updatedAt": "2024-04-23T12:47:13.968Z",
207 "exchangeId": "binance",
208 "transactionHash": "DUMMY_TX_ID",
209 "transactionLink": "https://sepolia.etherscan.io/tx/DUMMY_TX_ID",
210 "partnerFeeInUsd": "1.07",
211 "partnerFeeDecimal": 0.02,
212 "completedAt": "2024-04-23T12:47:41.889Z"
213 },
214 {
215 "_id": "b4b0e9e6-756f-4962-8919-f76e35d86dfc",
216 "walletAddress": "0x9200...806FAc8b9",
217 "createdAt": "2024-04-23T12:45:40.590Z",
218 "status": "COMPLETED",
219 "fiatCurrency": "GBP",
220 "cryptoCurrency": "ETH",
221 "isBuyOrSell": "BUY",
222 "fiatAmount": 50,
223 "amountPaid": 50,
224 "paymentOptionId": "gbp_bank_transfer",
225 "network": "ethereum",
226 "quoteId": "1c7a5fa4-abeb-4f66-a60b-f3d85f0bf19f",
227 "userId": "243a8ce2-9cc6-41a9-aaeb-b0deeb0b19a3",
228 "dispute": false,
229 "ipAddress": "35.177.158.9",
230 "walletLink": "https://sepolia.etherscan.io/address/0x9200...91269C5029D",
231 "orderProcessingType": "NORMAL",
232 "addressAdditionalData": false,
233 "appVersionName": "staging-api",
234 "conversionPrice": 0.0003876173396674584,
235 "cryptoAmount": 0.01631869,
236 "totalFeeInFiat": 7.9,
237 "totalfeeDecimal": 0.158,
238 "fiatAmountInUsd": 62.02,
239 "countryCode": "IN",
240 "referenceCode": 204115,
241 "liquidityProvider": "MODULR",
242 "paymentTnxId": "A2100BT8BW_T2100AEMH3",
243 "paymentdateTime": "2024-04-23T12:45:45.000Z",
244 "isFirstOrder": false,
245 "updatedAt": "2024-04-23T12:45:51.501Z",
246 "exchangeId": "binance",
247 "transactionHash": "DUMMY_TX_ID",
248 "transactionLink": "https://sepolia.etherscan.io/tx/DUMMY_TX_ID",
249 "partnerFeeInUsd": "1.24",
250 "partnerFeeDecimal": 0.02,
251 "completedAt": "2024-04-23T12:46:10.492Z"
252 },
253 {
254 "_id": "64c629f9-23b5-41ac-a5a8-387adbe6c3b3",
255 "walletAddress": "0x2b3e...2Bf12e8f6",
256 "createdAt": "2024-04-23T11:48:43.912Z",
257 "status": "COMPLETED",
258 "fiatCurrency": "GBP",
259 "cryptoCurrency": "ETH",
260 "isBuyOrSell": "BUY",
261 "fiatAmount": 50,
262 "amountPaid": 50,
263 "paymentOptionId": "gbp_bank_transfer",
264 "network": "ethereum",
265 "quoteId": "14e5c7a0-506a-4186-af00-58aa3a0c276c",
266 "userId": "2aade80a-5a3e-45a1-bd31-dad575edd1a6",
267 "dispute": false,
268 "ipAddress": "35.177.158.9",
269 "walletLink": "https://sepolia.etherscan.io/address/0x2b3e2...1c49A",
270 "orderProcessingType": "NORMAL",
271 "addressAdditionalData": false,
272 "appVersionName": "staging-api",
273 "conversionPrice": 0.00038747695961995244,
274 "cryptoAmount": 0.01631278,
275 "totalFeeInFiat": 7.9,
276 "totalfeeDecimal": 0.158,
277 "fiatAmountInUsd": 61.75,
278 "countryCode": "FR",
279 "referenceCode": 225911,
280 "liquidityProvider": "MODULR",
281 "paymentTnxId": "A2100C59KF_T2100AEM1D",
282 "paymentdateTime": "2024-04-23T11:48:48.000Z",
283 "isFirstOrder": true,
284 "updatedAt": "2024-04-23T11:48:55.412Z",
285 "exchangeId": "binance",
286 "transactionHash": "DUMMY_TX_ID",
287 "transactionLink": "https://sepolia.etherscan.io/tx/DUMMY_TX_ID",
288 "partnerFeeInUsd": "1.24",
289 "partnerFeeDecimal": 0.02,
290 "completedAt": "2024-04-23T11:49:08.424Z"
291 },
292 {
293 "_id": "9d77e3c8-3e95-455c-b39c-68238357b194",
294 "walletAddress": "0x12d8...885e0F0BFc",
295 "createdAt": "2024-04-22T14:44:32.881Z",
296 "status": "COMPLETED",
297 "fiatCurrency": "GBP",
298 "cryptoCurrency": "ETH",
299 "isBuyOrSell": "BUY",
300 "fiatAmount": 50,
301 "amountPaid": 50,
302 "paymentOptionId": "gbp_bank_transfer",
303 "network": "ethereum",
304 "quoteId": "31ffcae4-7c0b-4b3d-b872-51ae8d1881c0",
305 "userId": "5757cb49-ac08-4b1d-bd95-bd664f39147d",
306 "dispute": false,
307 "ipAddress": "35.177.158.9",
308 "walletLink": "https://sepolia.etherscan.io/address/0x12d8885...B86EE9ae",
309 "orderProcessingType": "NORMAL",
310 "addressAdditionalData": false,
311 "appVersionName": "staging-api",
312 "conversionPrice": 0.00038269633507853406,
313 "cryptoAmount": 0.0160809,
314 "totalFeeInFiat": 7.98,
315 "totalfeeDecimal": 0.15960000000000002,
316 "fiatAmountInUsd": 61.57,
317 "countryCode": "FR",
318 "referenceCode": 408601,
319 "liquidityProvider": "MODULR",
320 "paymentTnxId": "A2100C56ML_T2100AEBCK",
321 "paymentdateTime": "2024-04-22T14:44:37.000Z",
322 "isFirstOrder": true,
323 "updatedAt": "2024-04-22T14:44:42.950Z",
324 "exchangeId": "binance",
325 "transactionHash": "DUMMY_TX_ID",
326 "transactionLink": "https://sepolia.etherscan.io/tx/DUMMY_TX_ID",
327 "partnerFeeInUsd": "1.23",
328 "partnerFeeDecimal": 0.02,
329 "completedAt": "2024-04-22T14:44:55.539Z"
330 },
331 {
332 "_id": "d7e7fd61-7fc7-4068-a153-ee8a1dfe4fdf",
333 "walletAddress": "0xD902...d7eBF7bc",
334 "createdAt": "2024-04-22T10:16:37.108Z",
335 "status": "COMPLETED",
336 "fiatCurrency": "GBP",
337 "cryptoCurrency": "ETH",
338 "isBuyOrSell": "BUY",
339 "fiatAmount": 50,
340 "amountPaid": 50,
341 "paymentOptionId": "gbp_bank_transfer",
342 "network": "ethereum",
343 "quoteId": "dee3b1b4-edfb-42ce-8cc9-bf9d3f178fd1",
344 "userId": "00045b17-ba25-4bb7-8663-b51f40a32b20",
345 "dispute": false,
346 "ipAddress": "35.177.158.9",
347 "walletLink": "https://sepolia.etherscan.io/address/0xD902d...30EBeBEFeE",
348 "orderProcessingType": "NORMAL",
349 "addressAdditionalData": false,
350 "appVersionName": "staging-api",
351 "conversionPrice": 0.0003813564285714285,
352 "cryptoAmount": 0.01601697,
353 "totalFeeInFiat": 8,
354 "totalfeeDecimal": 0.16,
355 "fiatAmountInUsd": 61.71,
356 "countryCode": "IN",
357 "referenceCode": 378858,
358 "liquidityProvider": "MODULR",
359 "paymentTnxId": "A2100BZ9VR_T2100AE8G6",
360 "paymentdateTime": "2024-04-22T10:16:41.000Z",
361 "isFirstOrder": false,
362 "updatedAt": "2024-04-22T10:16:51.814Z",
363 "exchangeId": "binance",
364 "transactionHash": "DUMMY_TX_ID",
365 "transactionLink": "https://sepolia.etherscan.io/tx/DUMMY_TX_ID",
366 "partnerFeeInUsd": "1.23",
367 "partnerFeeDecimal": 0.02,
368 "completedAt": "2024-04-22T10:17:18.799Z"
369 },
370 {
371 "_id": "c9bd48c8-c728-4ee5-a567-df0de2b9fc42",
372 "walletAddress": "0x7f9...19D266f242",
373 "createdAt": "2024-04-22T07:49:36.718Z",
374 "status": "COMPLETED",
375 "fiatCurrency": "GBP",
376 "cryptoCurrency": "VET",
377 "isBuyOrSell": "BUY",
378 "fiatAmount": 300,
379 "amountPaid": 300,
380 "paymentOptionId": "gbp_bank_transfer",
381 "network": "vechain",
382 "quoteId": "32d0df8a-eb5c-475b-b78e-4dd8d39a5d17",
383 "userId": "243a8ce2-9cc6-41a9-aaeb-b0deeb0b19a3",
384 "dispute": false,
385 "ipAddress": "35.177.158.9",
386 "walletLink": "https://explore-testnet.vechain.org/accounts/0x7f919...0075c4d",
387 "orderProcessingType": "NORMAL",
388 "addressAdditionalData": false,
389 "appVersionName": "staging-api",
390 "conversionPrice": 29.249132093630774,
391 "cryptoAmount": 8509.45,
392 "totalFeeInFiat": 9.07,
393 "totalfeeDecimal": 0.030233333333333334,
394 "fiatAmountInUsd": 371.42,
395 "countryCode": "IN",
396 "referenceCode": 204115,
397 "liquidityProvider": "MODULR",
398 "paymentTnxId": "A2100BT8BW_T2100AE6JW",
399 "paymentdateTime": "2024-04-22T07:49:41.000Z",
400 "isFirstOrder": false,
401 "updatedAt": "2024-04-22T07:49:52.637Z",
402 "exchangeId": "binance",
403 "transactionHash": "DUMMY_TX_ID",
404 "transactionLink": "https://explore-testnet.vechain.org/transactions/DUMMY_TX_ID",
405 "partnerFeeInUsd": "7.43",
406 "partnerFeeDecimal": 0.02,
407 "completedAt": "2024-04-22T07:50:13.803Z"
408 },
409 {
410 "_id": "4246b2f2-20c3-41e1-a561-abe1d4d141a4",
411 "walletAddress": "0x27...8ad753",
412 "createdAt": "2024-04-10T10:28:39.488Z",
413 "status": "COMPLETED",
414 "fiatCurrency": "GBP",
415 "cryptoCurrency": "ETH",
416 "isBuyOrSell": "BUY",
417 "fiatAmount": 50,
418 "amountPaid": 50,
419 "paymentOptionId": "gbp_bank_transfer",
420 "network": "ethereum",
421 "quoteId": "22fe073a-13ba-4d22-b69e-5fe4a3e1ab34",
422 "userId": "00045b17-ba25-4bb7-8663-b51f40a32b20",
423 "dispute": false,
424 "ipAddress": "35.177.158.9",
425 "walletLink": "https://sepolia.etherscan.io/address/0x27...72D508",
426 "orderProcessingType": "NORMAL",
427 "addressAdditionalData": false,
428 "appVersionName": "staging-api",
429 "conversionPrice": 0.0003604613856468836,
430 "cryptoAmount": 0.01451578,
431 "totalFeeInFiat": 9.73,
432 "totalfeeDecimal": 0.1946,
433 "fiatAmountInUsd": 63.46,
434 "countryCode": "IN",
435 "referenceCode": 378858,
436 "liquidityProvider": "MODULR",
437 "paymentTnxId": "A2100BZ9VR_T2100AAR3Q",
438 "paymentdateTime": "2024-04-10T10:28:44.000Z",
439 "isFirstOrder": false,
440 "updatedAt": "2024-04-10T10:28:53.936Z",
441 "exchangeId": "binance",
442 "transactionHash": "DUMMY_TX_ID",
443 "transactionLink": "https://sepolia.etherscan.io/tx/DUMMY_TX_ID",
444 "partnerFeeInUsd": "1.27",
445 "partnerFeeDecimal": 0.02,
446 "completedAt": "2024-04-10T10:29:10.562Z"
447 },
448 {
449 "_id": "fab7a792-5733-4c5b-a6a5-08e35a48b864",
450 "walletAddress": "0x278...ad7537a557",
451 "createdAt": "2024-04-03T08:43:21.374Z",
452 "status": "COMPLETED",
453 "fiatCurrency": "GBP",
454 "cryptoCurrency": "ETH",
455 "isBuyOrSell": "BUY",
456 "fiatAmount": 75,
457 "amountPaid": 75,
458 "paymentOptionId": "gbp_bank_transfer",
459 "network": "ethereum",
460 "quoteId": "26d52265-5310-4c12-ab2b-9d943fec4948",
461 "userId": "00045b17-ba25-4bb7-8663-b51f40a32b20",
462 "dispute": false,
463 "ipAddress": "35.177.158.9",
464 "walletLink": "https://sepolia.etherscan.io/address/0x27...D508",
465 "orderProcessingType": "NORMAL",
466 "addressAdditionalData": false,
467 "appVersionName": "staging-api",
468 "conversionPrice": 0.0003731234272973403,
469 "cryptoAmount": 0.02342842,
470 "totalFeeInFiat": 12.21,
471 "totalfeeDecimal": 0.1628,
472 "fiatAmountInUsd": 94.28,
473 "countryCode": "IN",
474 "referenceCode": 378858,
475 "liquidityProvider": "MODULR",
476 "paymentTnxId": "A2100BZ9VR_T2100A8ZD9",
477 "paymentdateTime": "2024-04-03T08:43:28.000Z",
478 "isFirstOrder": false,
479 "updatedAt": "2024-04-03T08:43:33.214Z",
480 "exchangeId": "binance",
481 "transactionHash": "DUMMY_TX_ID",
482 "transactionLink": "https://sepolia.etherscan.io/tx/DUMMY_TX_ID",
483 "partnerFeeInUsd": "4.71",
484 "partnerFeeDecimal": 0.05,
485 "completedAt": "2024-04-03T08:43:42.985Z"
486 }
487 ]
488}
This is the partner API for fetching orders. Filtering: `Get Orders` supports filters such as `filter[status]`, `filter[sortOrder]`, `filter[walletAddress]`, and `filter[productsAvailed]`, plus exact match on `filter[partnerOrderId]`. `filter[productsAvailed]` must be passed as a JSON-encoded array string such as `["BUY"]` or `["SELL"]`. Pagination: Respect `limit` and `skip` to avoid large responses.
Was this page helpful?
Previous

Getting Started

Next

Get Order By ID

Built with

This is the partner API for fetching orders.

Filtering: Get Orders supports filters such as filter[status], filter[sortOrder], filter[walletAddress], and filter[productsAvailed], plus exact match on filter[partnerOrderId].

filter[productsAvailed] must be passed as a JSON-encoded array string such as ["BUY"] or ["SELL"].

Pagination: Respect limit and skip to avoid large responses.

Headers

access-tokenstringRequired

Your Partner Access Token. Please refer here for a tutorial on generating your access token.

Query parameters

limitintegerOptionalDefaults to 100
limits the number of records returned.
skipintegerOptionalDefaults to 0
skip omits the specified number of returned records
startDatestringOptional

startDate in YYYY-MM-DD format. Default to 90 days prior to current date

endDatestringOptional

endDate in YYYY-MM-DD format. Defaults to current date

filter[productsAvailed]stringOptionalDefaults to ["BUY"]

JSON-encoded array string for products availed, for example ["BUY"] or ["SELL"]

filter[status]stringOptionalDefaults to COMPLETED
order status filter
filter[sortOrder]stringOptional

sort order by which you want your orders either desc or asc

filter[walletAddress]stringOptional

filter orders based on a wallet address. Note: Returns BUY orders only

filter[partnerOrderId]stringOptional
filter orders based on a partnerOrderId parameter

Response

Orders fetched successfully
metaobject
datalist of objects

Errors

400
Bad Request Error
401
Unauthorized Error