forked from fireblocks/fireblocks-network-link
-
Notifications
You must be signed in to change notification settings - Fork 1
/
openapi.yaml
1353 lines (1332 loc) · 45.2 KB
/
openapi.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
openapi: 3.0.0
info:
title: Fireblocks Network Link for Account Linking Partners
version: "0.9.6"
contact:
email: support@fireblocks.com
license:
name: Apache 2.0
url: 'http://www.apache.org/licenses/LICENSE-2.0.html'
x-logo:
url: 'https://drive.google.com/uc?id=1sseKokeIoh7hnUpV8skWYF_VzncF3slT'
altText: 'Fireblocks logo'
description:
$ref: "./DESCRIPTION.md"
servers:
- url: 'https://fireblocks.your-3rd-party-domain.com/'
paths:
/v1/accounts:
get:
summary: Fetches list of all accounts, and the balances within them.
description: >
In case the 3rd party supports an account type but the account doesn't
contain any balance, it is expected the "balances"
field to be an empty array.
operationId: GET /accounts
parameters:
- name: X-FBAPI-KEY
in: header
required: true
schema:
$ref: '#/components/schemas/X-FBAPI-KEY'
- name: X-FBAPI-TIMESTAMP
in: header
required: true
schema:
$ref: '#/components/schemas/X-FBAPI-TIMESTAMP'
- name: X-FBAPI-SIGNATURE
in: header
required: true
schema:
$ref: '#/components/schemas/X-FBAPI-SIGNATURE'
- name: X-FBAPI-NONCE
in: header
required: true
schema:
$ref: '#/components/schemas/X-FBAPI-NONCE'
responses:
'200':
description: Success
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Balance'
'400':
description: Return custom error and error code here.
'401':
description: Unauthorized. Either API details are missing or invalid
'403':
description: Forbidden- You do not have access to the requested resource.
'415':
description: Unsupported media type. You need to use application/json.
'500':
description: Exchange internal error.
/v1/depositAddress:
get:
summary: Fetch the deposit address for a coinSymbol and network
description: >
Fireblocks will first check if a deposit wallet address exists using this endpoint.
If one does not exist, then a new address will be created using the `POST /v1/depositAddress` endpoint.
operationId: GET /depositAddress
parameters:
- name: X-FBAPI-KEY
in: header
required: true
schema:
$ref: '#/components/schemas/X-FBAPI-KEY'
- name: X-FBAPI-TIMESTAMP
in: header
required: true
schema:
$ref: '#/components/schemas/X-FBAPI-TIMESTAMP'
- name: X-FBAPI-SIGNATURE
in: header
required: true
schema:
$ref: '#/components/schemas/X-FBAPI-SIGNATURE'
- name: X-FBAPI-NONCE
in: header
required: true
schema:
$ref: '#/components/schemas/X-FBAPI-NONCE'
- name: accountType
in: query
required: true
description: >
The account type to return the deposit address from.
The API will fill the fundableAccountType here.
schema:
$ref : '#/components/schemas/Account_Type'
- name: coinSymbol
in: query
required: true
example: "USDT"
schema:
type: string
- name: network
in: query
required: true
schema:
oneOf:
- $ref: '#/components/schemas/Mainnet_Networks'
- $ref: '#/components/schemas/Testnet_Networks'
responses:
'200':
description: successful operation
content:
application/json:
schema:
type: object
required: [depositAddress]
properties:
depositAddress:
type: string
description: "The address of the deposit address. If not found, it will be empty."
example: "0xb794f5ea0ba39494ce839613fffba74279579268"
depositAddressTag:
type: string
description: "A destination tag/memo to include for supported coins (e.g. XLM, XRP etc')"
example: "63163621"
nullable: true
'400':
description: Return custom error and error code here.
'401':
description: Unauthorized. Either API details are missing or invalid
'403':
description: Forbidden- You do not have access to the requested resource.
'404':
description: Account ID or Account Type not found or supported.
'415':
description: Unsupported media type. You need to use application/json.
'500':
description: Exchange internal error.
post:
summary: Create a new deposit address for a given coinSymbol and network
operationId: POST /depositAddress
parameters:
- name: X-FBAPI-KEY
in: header
required: true
schema:
$ref: '#/components/schemas/X-FBAPI-KEY'
- name: X-FBAPI-TIMESTAMP
in: header
required: true
schema:
$ref: '#/components/schemas/X-FBAPI-TIMESTAMP'
- name: X-FBAPI-SIGNATURE
in: header
required: true
schema:
$ref: '#/components/schemas/X-FBAPI-SIGNATURE'
- name: X-FBAPI-NONCE
in: header
required: true
schema:
$ref: '#/components/schemas/X-FBAPI-NONCE'
requestBody:
required: true
content:
application/json:
schema:
type: object
description: "Deposit address details to be created."
required:
- accountType
- coinSymbol
- network
properties:
accountType:
description: >
The account type to create the deposit address for.
The API will fill the fundableAccountType here.
$ref : '#/components/schemas/Account_Type'
coinSymbol:
example: "USDT"
type: string
network:
oneOf:
- $ref: '#/components/schemas/Mainnet_Networks'
- $ref: '#/components/schemas/Testnet_Networks'
responses:
'200':
description: successful operation
content:
application/json:
schema:
type: object
required: [depositAddress]
properties:
depositAddress:
type: string
description: "The address of the deposit address. If not found, it will be empty."
example: "0xb794f5ea0ba39494ce839613fffba74279579268"
depositAddressTag:
type: string
description: "A destination tag/memo to include for supported coins (e.g. XLM, XRP etc')"
example: "63163621"
nullable: true
'400':
description: Return custom error and error code here.
'401':
description: Unauthorized. Either API details are missing or invalid
'403':
description: Forbidden- You do not have access to the requested resource.
'404':
description: Account ID or Account Type not found or supported.
'415':
description: Unsupported media type. You need to use application/json.
'500':
description: Exchange internal error.
/v1/withdrawalFee:
get:
summary: Fetch the estimated transaction fee required for an external withdrawal
operationId: GET /withdrawalFee
parameters:
- name: X-FBAPI-KEY
in: header
required: true
schema:
$ref: '#/components/schemas/X-FBAPI-KEY'
- name: X-FBAPI-TIMESTAMP
in: header
required: true
schema:
$ref: '#/components/schemas/X-FBAPI-TIMESTAMP'
- name: X-FBAPI-SIGNATURE
in: header
required: true
schema:
$ref: '#/components/schemas/X-FBAPI-SIGNATURE'
- name: X-FBAPI-NONCE
in: header
required: true
schema:
$ref: '#/components/schemas/X-FBAPI-NONCE'
- name: transferAmount
in: query
required: true
schema:
type: string
- name: coinSymbol
in: query
required: true
schema:
type: string
- name: network
in: query
required: true
schema:
oneOf:
- $ref: '#/components/schemas/Mainnet_Networks'
- $ref: '#/components/schemas/Testnet_Networks'
responses:
'200':
description: successful operation
content:
application/json:
schema:
type: object
required: [feeAmount]
properties:
feeAmount:
type: string
example: "0.23823"
'400':
description: Return custom error and error code here.
'401':
description: Unauthorized. Either API details are missing or invalid
'403':
description: Forbidden- You do not have access to the requested resource.
'415':
description: Unsupported media type. You need to use application/json.
'500':
description: Exchange internal error.
/v1/withdraw:
post:
summary: Initiate a withdrawal from the 3rd party wallet to an external wallet address
operationId: POST /withdraw
parameters:
- name: X-FBAPI-KEY
in: header
required: true
schema:
$ref: '#/components/schemas/X-FBAPI-KEY'
- name: X-FBAPI-TIMESTAMP
in: header
required: true
schema:
$ref: '#/components/schemas/X-FBAPI-TIMESTAMP'
- name: X-FBAPI-SIGNATURE
in: header
required: true
schema:
$ref: '#/components/schemas/X-FBAPI-SIGNATURE'
- name: X-FBAPI-NONCE
in: header
required: true
schema:
$ref: '#/components/schemas/X-FBAPI-NONCE'
requestBody:
required: true
content:
application/json:
schema:
type: object
description: Withdrawal request to be submitted.
required:
- accountType
- toAddress
- coinSymbol
- network
- amount
- isGross
- isSettlementTx
properties:
accountType:
$ref : '#/components/schemas/Account_Type'
toAddress:
example: "bc1qs95ej87htkfy5786anzwh8sz3gmzvqh2d2uey2"
type: string
description: >
The destination address of the withdraw.
The `toAddress` and `tag` fields will be masked if configured on the registration of the third party,
by default `NONE` is selected - meaning they're not masked.
Masking options: `NONE`, `SHA256`, `SHA3_256`, `SHA512`
tag:
description: >
A 'tag' or 'memo', if required by the network.
The `toAddress` and `tag` fields will be masked if configured on the registration of the third party,
by default `NONE` is selected - meaning they're not masked.
Masking options: `NONE`, `SHA256`, `SHA3_256`, `SHA512`
type: string
nullable: true
example: null
coinSymbol:
example: "ETH"
type: string
network:
oneOf:
- $ref: '#/components/schemas/Mainnet_Networks'
- $ref: '#/components/schemas/Testnet_Networks'
amount:
example: "0.0010597"
type: string
isGross:
example: "true"
description: >
Is the amount sent a gross amount? (Includes gas fees if necessary, and service fees)
Can be either `"true"` or `"false"`.
type: string
maxFee:
example: "0.00001616"
description: The service fee charged for withdrawal
type: string
nullable: true
isSettlementTx:
example: "false"
description: >
If the third party service supports off-exchange, and this transaction was created in a settlement flow,
this flag will be true.
Can be either `"true"` or `"false"`.
type: string
responses:
'200':
description: successful operation
content:
application/json:
schema:
type: object
required: [transactionID]
properties:
transactionID:
type: string
description: "The requested transaction ID to process."
example: "3e8374383acce78d38be7fe9"
'400':
description: Return custom error and error code here.
'401':
description: Unauthorized. Either API details are missing or invalid
'403':
description: Forbidden- You do not have access to the requested resource.
'404':
description: Account ID or Account Type not found or supported.
'415':
description: Unsupported media type. You need to use application/json.
'429':
description: Rate limit reached
'500':
description: Exchange internal error.
/v1/transactionByID:
get:
summary: Fetch the status of a given transaction ID
operationId: GET /transactionByID
parameters:
- name: X-FBAPI-KEY
in: header
required: true
schema:
$ref: '#/components/schemas/X-FBAPI-KEY'
- name: X-FBAPI-TIMESTAMP
in: header
required: true
schema:
$ref: '#/components/schemas/X-FBAPI-TIMESTAMP'
- name: X-FBAPI-SIGNATURE
in: header
required: true
schema:
$ref: '#/components/schemas/X-FBAPI-SIGNATURE'
- name: X-FBAPI-NONCE
in: header
required: true
schema:
$ref: '#/components/schemas/X-FBAPI-NONCE'
- name: transactionID
in: query
required: true
schema:
type: string
responses:
'200':
description: >
Successful operation.
content:
application/json:
schema:
oneOf:
- type: object
title: "Transaction found"
description: Transaction details result from the 3rd party.
required: [transactionID, status, txHash, amount, serviceFee, coinSymbol, network, direction, timestamp]
properties:
transactionID:
type: string
example: "46bas218d9h21uhib4i1u2h"
status:
$ref: '#/components/schemas/Status_Found'
txHash:
type: string
example: "44e25bc0ed840f9bf0e58d6227db15192d5b89e79ba4304da16b09703f68ceaf"
amount:
type: string
description: "The net amount of the transaction"
example: "1.1"
serviceFee:
type: string
example: "0.000000031"
coinSymbol:
type: string
example: "ETH"
network:
oneOf:
- $ref: '#/components/schemas/Mainnet_Networks'
- $ref: '#/components/schemas/Testnet_Networks'
direction:
$ref: '#/components/schemas/Direction_for_Withdraw'
timestamp:
type: number
format: UNIX-timestamp-epoch
description: "Milliseconds"
example: 1546658861000
- type: object
title: "Transaction not found"
description: Transaction details not found.
required:
- status
properties:
status:
$ref: '#/components/schemas/Status_Not_Found'
'400':
description: Return custom error and error code here.
'401':
description: Unauthorized. Either API details are missing or invalid
'403':
description: Forbidden- You do not have access to the requested resource.
'415':
description: Unsupported media type. You need to use application/json.
'500':
description: Exchange internal error.
/v1/transactionByHash:
get:
summary: Fetch the status of a given <txHash, network> pair
operationId: GET /transationByHash
parameters:
- name: X-FBAPI-KEY
in: header
required: true
schema:
$ref: '#/components/schemas/X-FBAPI-KEY'
- name: X-FBAPI-TIMESTAMP
in: header
required: true
schema:
$ref: '#/components/schemas/X-FBAPI-TIMESTAMP'
- name: X-FBAPI-SIGNATURE
in: header
required: true
schema:
$ref: '#/components/schemas/X-FBAPI-SIGNATURE'
- name: X-FBAPI-NONCE
in: header
required: true
schema:
$ref: '#/components/schemas/X-FBAPI-NONCE'
- name: txHash
in: query
description: "The requested TxHash to query. Could be intrinsic but could also not be."
required: true
schema:
type: string
- name: network
in: query
required: true
schema:
oneOf:
- $ref: '#/components/schemas/Mainnet_Networks'
- $ref: '#/components/schemas/Testnet_Networks'
responses:
'200':
description: >
Successful operation.
content:
application/json:
schema:
oneOf:
- type: object
title: "Transaction found"
description: Transaction details result from the 3rd party.
required: [transactionID, status, txHash, amount, serviceFee, coinSymbol, network, direction, timestamp]
properties:
transactionID:
type: string
example: "46bas218d9h21uhib4i1u2h"
status:
$ref: '#/components/schemas/Status_Found'
txHash:
type: string
example: "44e25bc0ed840f9bf0e58d6227db15192d5b89e79ba4304da16b09703f68ceaf"
amount:
type: string
description: "The net amount of the transaction"
example: "1.1"
serviceFee:
type: string
example: "0.000000031"
coinSymbol:
type: string
example: "ETH"
network:
oneOf:
- $ref: '#/components/schemas/Mainnet_Networks'
- $ref: '#/components/schemas/Testnet_Networks'
direction:
$ref: '#/components/schemas/Direction_for_Deposit'
timestamp:
type: number
format: UNIX-timestamp-epoch
description: "Milliseconds"
example: 1546658861000
- type: object
title: "Transaction not found"
description: Transaction details not found.
required:
- status
properties:
status:
$ref: '#/components/schemas/Status_Not_Found'
'400':
description: Return custom error and error code here.
'401':
description: Unauthorized. Either API details are missing or invalid
'403':
description: Forbidden- You do not have access to the requested resource.
'415':
description: Unsupported media type. You need to use application/json.
'500':
description: Exchange internal error.
/v1/transactionHistory:
get:
summary: Fetch the history of all transactions
operationId: GET /transactionHistory
parameters:
- name: X-FBAPI-KEY
in: header
required: true
schema:
$ref: '#/components/schemas/X-FBAPI-KEY'
- name: X-FBAPI-TIMESTAMP
in: header
required: true
schema:
$ref: '#/components/schemas/X-FBAPI-TIMESTAMP'
- name: X-FBAPI-SIGNATURE
in: header
required: true
schema:
$ref: '#/components/schemas/X-FBAPI-SIGNATURE'
- name: X-FBAPI-NONCE
in: header
required: true
schema:
$ref: '#/components/schemas/X-FBAPI-NONCE'
- name: fromDate
in: query
required: true
schema:
type: string
format: UNIX-timestamp-epoch
description: "Milliseconds"
example: "1546658861000"
- name: toDate
in: query
required: true
schema:
type: string
format: UNIX-timestamp-epoch
description: "Milliseconds"
example: "1546658865000"
- name: pageSize
in: query
description: "Number of entries per page size in response"
required: true
schema:
type: number
minimum: 1
example: 500
- name: pageCursor
in: query
required: false
description: "If not specified, return the first page. Otherwise, return the page the cursor points to."
schema:
type: string
nullable: true
example: null
- name: isSubTransfer
in: query
required: true
description: "If this is a sub-account tranfer, either subMainTransfer or subaccountTransfer."
schema:
type: string
example: false
- name: direction
in: query
required: false
nullable: true
description: "If this isn't a sub-transfer, will specify the direction of the transaction to query."
schema:
$ref: '#/components/schemas/NullableDirection'
- name: coinSymbol
in: query
required: true
example: "USDT"
schema:
type: string
- name: network
in: query
required: true
description: "If isSubTransfer is true, this value could be null. Otherwise, it will be specified."
schema:
oneOf:
- nullable: true
- $ref: '#/components/schemas/Mainnet_Networks'
- $ref: '#/components/schemas/Testnet_Networks'
responses:
'200':
description: successful operation
content:
application/json:
schema:
type: object
required: [transactions]
properties:
nextPageCursor:
type: string
nullable: true
example: null
description: "If not present, refers to the last possible page. Otherwise refers to the next page."
transactions:
type: array
items:
type: object
description: "Transaction details result from the 3rd party."
required: [transactionID, status, txHash, amount, serviceFee, coinSymbol, network, direction, timestamp]
properties:
transactionID:
type: string
example: "46bas218d9h21uhib4i1u2h"
status:
$ref: '#/components/schemas/Status_Found'
txHash:
type: string
example: "44e25bc0ed840f9bf0e58d6227db15192d5b89e79ba4304da16b09703f68ceaf"
amount:
type: string
description: "The net amount of the transaction"
example: "1.1"
serviceFee:
type: string
example: "0.000000031"
coinSymbol:
type: string
example: "ETH"
network:
description: "If isSubTransfer was true, this value could be null. Otherwise it's required."
oneOf:
- nullable: true
- $ref: '#/components/schemas/Mainnet_Networks'
- $ref: '#/components/schemas/Testnet_Networks'
example: "Ethereum"
direction:
$ref: '#/components/schemas/Direction_for_Deposit'
timestamp:
type: number
format: UNIX-timestamp-epoch
description: "In Milliseconds. The timestamp on the creation of the transaction."
example: 1546658861000
'400':
description: Return custom error and error code here.
'401':
description: Unauthorized. Either API details are missing or invalid
'403':
description: Forbidden- You do not have access to the requested resource.
'415':
description: Unsupported media type. You need to use application/json.
'500':
description: Exchange internal error.
/v1/supportedAssets:
get:
summary: Fetch the assets supported by the exchanges
description: >
*NOTE*: If the third party is a sandbox third party, only coinClass=`BASE` assets will be supported.
operationId: GET /supportedAssets
parameters:
- name: X-FBAPI-KEY
in: header
required: true
schema:
$ref: '#/components/schemas/X-FBAPI-KEY'
- name: X-FBAPI-TIMESTAMP
in: header
required: true
schema:
$ref: '#/components/schemas/X-FBAPI-TIMESTAMP'
- name: X-FBAPI-SIGNATURE
in: header
required: true
schema:
$ref: '#/components/schemas/X-FBAPI-SIGNATURE'
- name: X-FBAPI-NONCE
in: header
required: true
schema:
$ref: '#/components/schemas/X-FBAPI-NONCE'
responses:
'200':
description: successful operation
content:
application/json:
schema:
type: array
items:
type: object
required: [coinSymbol, network, coinClass]
properties:
coinSymbol:
type: string
example: "USDT"
network:
oneOf:
- $ref: '#/components/schemas/Mainnet_Networks'
- $ref: '#/components/schemas/Testnet_Networks'
coinClass:
$ref: '#/components/schemas/Coin_Class'
identifiers:
type: array
nullable: true
description: >
The identifier(s) for asset types that are created by a smart contract (ERC20, BEP20, etc'), could be a contractAddress for example.
Some tokens require multiple identifiers (for example, XLM).
The order of the identifiers is via heirarchy (for example, XLM has on it's first identifier the contractAddress and the second the contractAddressSpecifier)
items:
type: string
example: "0xdAC17F958D2ee523a2206206994597C13D831ec7"
'400':
description: Return custom error and error code here.
'401':
description: Unauthorized. Either API details are missing or invalid
'403':
description: Forbidden- You do not have access to the requested resource.
'415':
description: Unsupported media type. You need to use application/json.
'500':
description: Exchange internal error.
/v1/subMainTransfer:
post:
summary: Initiate a transfer between an internal sub-account and the main-account
operationId: GET /subMainTransfer
parameters:
- name: X-FBAPI-KEY
in: header
required: true
schema:
$ref: '#/components/schemas/X-FBAPI-KEY'
- name: X-FBAPI-TIMESTAMP
in: header
required: true
schema:
$ref: '#/components/schemas/X-FBAPI-TIMESTAMP'
- name: X-FBAPI-SIGNATURE
in: header
required: true
schema:
$ref: '#/components/schemas/X-FBAPI-SIGNATURE'
- name: X-FBAPI-NONCE
in: header
required: true
schema:
$ref: '#/components/schemas/X-FBAPI-NONCE'
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- subAccountID
- direction
- coinSymbol
- amount
properties:
subAccountID:
example: "1164fbab-1968-441d-848c-4cbe5ced4328"
type: string
direction:
$ref: '#/components/schemas/Direction_for_Sub_Main_transfer'
coinSymbol:
example: "USDT"
type: string
amount:
example: "7.3"
type: string
responses:
'200':
description: successful operation
content:
application/json:
schema:
type: object
required:
- completed
properties:
completed:
type: boolean
example: true
description: "If true, the transaction will be completed instantly, else /transactionHistory will be invoked until completion."
transactionID:
type: string
nullable: true
example: "3e8374383acce78d38be7fe9"
'400':
description: Return custom error and error code here.
'401':
description: Unauthorized. Either API details are missing or invalid
'403':
description: Forbidden- You do not have access to the requested resource.
'404':
description: Account ID or Account Type not found or supported.
'415':
description: Unsupported media type. You need to use application/json.
'429':
description: Rate limit reached
'500':
description: Exchange internal error.
/v1/subaccountsTransfer:
post:
summary: Initiate a transfer between an two sub-accounts
operationId: GET /subaccountsTransfer
parameters:
- name: X-FBAPI-KEY
in: header
required: true
schema:
$ref: '#/components/schemas/X-FBAPI-KEY'
- name: X-FBAPI-TIMESTAMP
in: header
required: true
schema:
$ref: '#/components/schemas/X-FBAPI-TIMESTAMP'
- name: X-FBAPI-SIGNATURE
in: header
required: true
schema:
$ref: '#/components/schemas/X-FBAPI-SIGNATURE'
- name: X-FBAPI-NONCE
in: header
required: true
schema:
$ref: '#/components/schemas/X-FBAPI-NONCE'
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- srcSubAccountID
- dstSubAccountID
- coinSymbol
- amount
properties:
srcSubAccountID:
example: "81690809-5eb9-48be-8eb5-6af17131d7dc"
type: string
dstSubAccountID:
example: "d6eba9e6-b867-4f9b-9353-ceb7a2db9311"
type: string
coinSymbol:
example: "BTC"
type: string
amount:
example: "0.03"
type: string
responses:
'200':
description: successful operation
content:
application/json:
schema:
type: object
required:
- completed
properties:
completed:
type: boolean
example: true
description: "If true, the transaction will be completed instantly, else /transactionHistory will be invoked until completion."
transactionID:
type: string
nullable: true
example: "3e8374383acce78d38be7fe9"
'400':
description: Return custom error and error code here.
'401':
description: Unauthorized. Either API details are missing or invalid
'403':
description: Forbidden- You do not have access to the requested resource.
'404':
description: Account ID or Account Type not found or supported.
'415':
description: Unsupported media type. You need to use application/json.
'429':
description: Rate limit reached
'500':
description: Exchange internal error.
/v1/internalTransfer:
post:
summary: Initiate a transfer from one internal account to another, eg. TRADING to MARGIN
operationId: GET /internalTransfer
parameters:
- name: X-FBAPI-KEY
in: header
required: true
schema:
$ref: '#/components/schemas/X-FBAPI-KEY'
- name: X-FBAPI-TIMESTAMP
in: header
required: true
schema:
$ref: '#/components/schemas/X-FBAPI-TIMESTAMP'
- name: X-FBAPI-SIGNATURE
in: header
required: true
schema:
$ref: '#/components/schemas/X-FBAPI-SIGNATURE'