@binance/fiat 7.0.1 → 8.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.ts CHANGED
@@ -3,11 +3,11 @@ import { BadRequestError, ConfigurationRestAPI, ConnectorClientError, FIAT_REST_
3
3
  //#region rolldown:runtime
4
4
 
5
5
  //#endregion
6
- //#region src/rest-api/types/account-info.d.ts
6
+ //#region src/rest-api/types/deposit-response-data.d.ts
7
7
  /**
8
- * Binance Fiat REST API
8
+ * Fiat REST API
9
9
  *
10
- * OpenAPI Specification for the Binance Fiat REST API
10
+ * Query Binance fiat deposit and withdrawal history.
11
11
  *
12
12
  * The version of the OpenAPI document: 1.0.0
13
13
  *
@@ -19,40 +19,49 @@ import { BadRequestError, ConfigurationRestAPI, ConnectorClientError, FIAT_REST_
19
19
  /**
20
20
  *
21
21
  * @export
22
- * @interface AccountInfo
22
+ * @interface DepositResponseData
23
23
  */
24
- interface AccountInfo {
24
+ interface DepositResponseData {
25
25
  /**
26
26
  *
27
27
  * @type {string}
28
- * @memberof AccountInfo
28
+ * @memberof DepositResponseData
29
29
  */
30
- accountNumber?: string;
30
+ orderId?: string;
31
+ }
32
+ //#endregion
33
+ //#region src/rest-api/types/deposit-response.d.ts
34
+ /**
35
+ *
36
+ * @export
37
+ * @interface DepositResponse
38
+ */
39
+ interface DepositResponse {
31
40
  /**
32
41
  *
33
42
  * @type {string}
34
- * @memberof AccountInfo
43
+ * @memberof DepositResponse
35
44
  */
36
- agency?: string;
45
+ code?: string;
37
46
  /**
38
47
  *
39
48
  * @type {string}
40
- * @memberof AccountInfo
49
+ * @memberof DepositResponse
41
50
  */
42
- bankCodeForPix?: string;
51
+ message?: string;
43
52
  /**
44
53
  *
45
- * @type {string}
46
- * @memberof AccountInfo
54
+ * @type {DepositResponseData}
55
+ * @memberof DepositResponse
47
56
  */
48
- accountType?: string;
57
+ data?: DepositResponseData;
49
58
  }
50
59
  //#endregion
51
- //#region src/rest-api/types/deposit-response-data.d.ts
60
+ //#region src/rest-api/types/fiat-withdraw-request-account-info.d.ts
52
61
  /**
53
- * Binance Fiat REST API
62
+ * Fiat REST API
54
63
  *
55
- * OpenAPI Specification for the Binance Fiat REST API
64
+ * Query Binance fiat deposit and withdrawal history.
56
65
  *
57
66
  * The version of the OpenAPI document: 1.0.0
58
67
  *
@@ -62,44 +71,35 @@ interface AccountInfo {
62
71
  * Do not edit the class manually.
63
72
  */
64
73
  /**
65
- *
74
+ * withdraw account info
66
75
  * @export
67
- * @interface DepositResponseData
76
+ * @interface FiatWithdrawRequestAccountInfo
68
77
  */
69
- interface DepositResponseData {
78
+ interface FiatWithdrawRequestAccountInfo {
70
79
  /**
71
- *
80
+ * Your destination bank account number is required to receive the withdrawal. In Argentina, this will be your CBU/CVU; in Mexico, it will be your CLABE.
72
81
  * @type {string}
73
- * @memberof DepositResponseData
82
+ * @memberof FiatWithdrawRequestAccountInfo
74
83
  */
75
- orderId?: string;
76
- }
77
- //#endregion
78
- //#region src/rest-api/types/deposit-response.d.ts
79
- /**
80
- *
81
- * @export
82
- * @interface DepositResponse
83
- */
84
- interface DepositResponse {
84
+ accountNumber: string;
85
85
  /**
86
- *
86
+ * Bank agency code. If contains a hyphen (e.g. `123-4`), enter `123` only.
87
87
  * @type {string}
88
- * @memberof DepositResponse
88
+ * @memberof FiatWithdrawRequestAccountInfo
89
89
  */
90
- code?: string;
90
+ agency?: string;
91
91
  /**
92
- *
92
+ * Bank code used for PIX routing.
93
93
  * @type {string}
94
- * @memberof DepositResponse
94
+ * @memberof FiatWithdrawRequestAccountInfo
95
95
  */
96
- message?: string;
96
+ bankCodeForPix?: string;
97
97
  /**
98
- *
99
- * @type {DepositResponseData}
100
- * @memberof DepositResponse
98
+ * Account type, e.g. `current` (Checking Account), `saving` (Savings Account), etc.
99
+ * @type {string}
100
+ * @memberof FiatWithdrawRequestAccountInfo
101
101
  */
102
- data?: DepositResponseData;
102
+ accountType?: string;
103
103
  }
104
104
  //#endregion
105
105
  //#region src/rest-api/types/fiat-withdraw-response.d.ts
@@ -131,9 +131,9 @@ interface FiatWithdrawResponse {
131
131
  //#endregion
132
132
  //#region src/rest-api/types/get-fiat-deposit-withdraw-history-response-data-inner.d.ts
133
133
  /**
134
- * Binance Fiat REST API
134
+ * Fiat REST API
135
135
  *
136
- * OpenAPI Specification for the Binance Fiat REST API
136
+ * Query Binance fiat deposit and withdrawal history.
137
137
  *
138
138
  * The version of the OpenAPI document: 1.0.0
139
139
  *
@@ -185,7 +185,7 @@ interface GetFiatDepositWithdrawHistoryResponseDataInner {
185
185
  */
186
186
  method?: string;
187
187
  /**
188
- *
188
+ * Processing, Failed, Successful, Finished, Refunding, Refunded, Refund Failed, Order Partial Credit Stopped
189
189
  * @type {string}
190
190
  * @memberof GetFiatDepositWithdrawHistoryResponseDataInner
191
191
  */
@@ -245,9 +245,9 @@ interface GetFiatDepositWithdrawHistoryResponse {
245
245
  //#endregion
246
246
  //#region src/rest-api/types/get-fiat-payments-history-response-data-inner.d.ts
247
247
  /**
248
- * Binance Fiat REST API
248
+ * Fiat REST API
249
249
  *
250
- * OpenAPI Specification for the Binance Fiat REST API
250
+ * Query Binance fiat deposit and withdrawal history.
251
251
  *
252
252
  * The version of the OpenAPI document: 1.0.0
253
253
  *
@@ -371,9 +371,9 @@ interface GetFiatPaymentsHistoryResponse {
371
371
  //#endregion
372
372
  //#region src/rest-api/types/get-order-detail-response-data.d.ts
373
373
  /**
374
- * Binance Fiat REST API
374
+ * Fiat REST API
375
375
  *
376
- * OpenAPI Specification for the Binance Fiat REST API
376
+ * Query Binance fiat deposit and withdrawal history.
377
377
  *
378
378
  * The version of the OpenAPI document: 1.0.0
379
379
  *
@@ -465,382 +465,408 @@ interface GetOrderDetailResponse {
465
465
  data?: GetOrderDetailResponseData;
466
466
  }
467
467
  //#endregion
468
- //#region src/rest-api/modules/fiat-api.d.ts
468
+ //#region src/rest-api/modules/api.d.ts
469
469
  /**
470
- * FiatApi - interface
471
- * @interface FiatApi
470
+ * Api - interface
471
+ * @interface Api
472
472
  */
473
- interface FiatApiInterface {
473
+ interface ApiInterface {
474
474
  /**
475
475
  * Submit deposit request, in this version, we only support BRL deposit via pix.
476
476
  *
477
- *
478
- *
479
477
  * For BRL deposit via pix, you need to place an order before making a transfer from your bank.
480
478
  *
481
- * Before calling this api, please make sure you have already completed your KYC or KYB, and already activated your fiat service on our website.
479
+ * Before calling this api, please make sure you have already completed your KYC or KYB, and already activated your
480
+ * fiat service on our website.
481
+ *
482
+ * Weight(UID): 45000
482
483
  *
483
- * `timestamp`, `signature` and `recvWindow` are sent as query-string parameters, while the business fields (`currency`, `apiPaymentMethod`, `amount`, `ext`) are sent in the JSON request body with `Content-Type: application/json`.
484
+ * Security Type: TRADE
484
485
  *
485
- * Weight: 45000
486
+ * Notes:
487
+ * - `timestamp`, `signature` and `recvWindow` are sent as query-string parameters, while the business fields (`currency`, `apiPaymentMethod`, `amount`, `ext`) are sent in the JSON request body with `Content-Type: application/json`.
486
488
  *
487
- * @summary Deposit(TRADE)
489
+ * @summary Deposit (TRADE)
488
490
  * @param {DepositRequest} requestParameters Request parameters.
489
491
  *
490
492
  * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError}
491
- * @memberof FiatApiInterface
493
+ * @memberof ApiInterface
492
494
  */
493
495
  deposit(requestParameters: DepositRequest): Promise<RestApiResponse<DepositResponse>>;
494
496
  /**
495
497
  * Submit withdraw request, in this version, we support BRL,ARS,MXN withdrawal via bank_transfer.
496
498
  *
497
- * You need to call this api first, and call query order detail api in a loop to get the status of the order until this order is successful.
499
+ * You need to call this api first, and call query order detail api in a loop to get the status of the order until
500
+ * this order is successful.
498
501
  *
499
- * Before calling this API, please ensure you have completed your KYC or KYB, activated your fiat service, and verified your destination bank account on our website.
502
+ * Before calling this api, please make sure you have already completed your KYC or KYB, and already activated your
503
+ * fiat service on our website.
500
504
  *
501
- * you need to bind your bank account on web/app before using the corresponding account number
505
+ * Weight(UID): 45000
502
506
  *
503
- * Weight: 45000
507
+ * Security Type: TRADE
504
508
  *
505
- * @summary Fiat Withdraw(WITHDRAW)
509
+ * @summary Fiat Withdraw (TRADE)
506
510
  * @param {FiatWithdrawRequest} requestParameters Request parameters.
507
511
  *
508
512
  * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError}
509
- * @memberof FiatApiInterface
513
+ * @memberof ApiInterface
510
514
  */
511
515
  fiatWithdraw(requestParameters: FiatWithdrawRequest): Promise<RestApiResponse<FiatWithdrawResponse>>;
512
516
  /**
513
517
  * Get Fiat Deposit/Withdraw History
514
518
  *
515
- * If beginTime and endTime are not sent, the recent 30-day data will be returned.
519
+ * Weight(UID): 45000
516
520
  *
517
- * Weight: 45000
521
+ * Security Type: USER_DATA
522
+ *
523
+ * Notes:
524
+ * - If `beginTime` and `endTime` are not sent, recent 30-day data is returned.
518
525
  *
519
526
  * @summary Get Fiat Deposit/Withdraw History (USER_DATA)
520
527
  * @param {GetFiatDepositWithdrawHistoryRequest} requestParameters Request parameters.
521
528
  *
522
529
  * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError}
523
- * @memberof FiatApiInterface
530
+ * @memberof ApiInterface
524
531
  */
525
532
  getFiatDepositWithdrawHistory(requestParameters: GetFiatDepositWithdrawHistoryRequest): Promise<RestApiResponse<GetFiatDepositWithdrawHistoryResponse>>;
526
533
  /**
527
- * Get Fiat Deposit/Withdraw History
534
+ * Get Fiat Payments History
535
+ *
536
+ * Weight(IP): 1
528
537
  *
529
- * If beginTime and endTime are not sent, the recent 30-day data will be returned.
530
- * paymentMethod: Only when requesting payments history for buy (transactionType=0), response contains paymentMethod representing the way of purchase. Now we have:
531
- * Cash Balance
532
- * Credit Card
533
- * Online Banking
534
- * Bank Transfer
538
+ * Security Type: USER_DATA
535
539
  *
536
- * Weight: 1
540
+ * Notes:
541
+ * - If `beginTime` and `endTime` are not sent, recent 30-day data is returned.
542
+ * - `paymentMethod` is returned only when querying buy history (`transactionType=0`).
543
+ * - Supported payment methods: `Cash Balance`, `Credit Card`, `Online Banking`, `Bank Transfer`.
537
544
  *
538
545
  * @summary Get Fiat Payments History (USER_DATA)
539
546
  * @param {GetFiatPaymentsHistoryRequest} requestParameters Request parameters.
540
547
  *
541
548
  * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError}
542
- * @memberof FiatApiInterface
549
+ * @memberof ApiInterface
543
550
  */
544
551
  getFiatPaymentsHistory(requestParameters: GetFiatPaymentsHistoryRequest): Promise<RestApiResponse<GetFiatPaymentsHistoryResponse>>;
545
552
  /**
546
553
  * Get Order Detail
547
554
  *
548
- * Before calling this api, please make sure you have already completed your KYC or KYB, and already activated your fiat service on our website.
555
+ * Before calling this api, please make sure you have already completed your KYC or KYB, and already activated your
556
+ * fiat service on our website.
549
557
  *
550
- * Weight: 1
558
+ * Weight(IP): 1
551
559
  *
552
- * @summary Get Order Detail(USER_DATA)
560
+ * Security Type: USER_DATA
561
+ *
562
+ * @summary Get Order Detail (USER_DATA)
553
563
  * @param {GetOrderDetailRequest} requestParameters Request parameters.
554
564
  *
555
565
  * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError}
556
- * @memberof FiatApiInterface
566
+ * @memberof ApiInterface
557
567
  */
558
568
  getOrderDetail(requestParameters: GetOrderDetailRequest): Promise<RestApiResponse<GetOrderDetailResponse>>;
559
569
  }
560
570
  /**
561
- * Request parameters for deposit operation in FiatApi.
571
+ * Request parameters for deposit operation in Api.
562
572
  * @interface DepositRequest
563
573
  */
564
574
  interface DepositRequest {
565
575
  /**
566
576
  *
567
577
  * @type {string}
568
- * @memberof FiatApiDeposit
578
+ * @memberof ApiDeposit
569
579
  */
570
580
  readonly currency: string;
571
581
  /**
572
- *
582
+ * payment method; current supported: pix
573
583
  * @type {string}
574
- * @memberof FiatApiDeposit
584
+ * @memberof ApiDeposit
575
585
  */
576
- readonly apiPaymentMethod: string;
586
+ readonly apiPaymentMethod: DepositApiPaymentMethodEnum;
577
587
  /**
578
- *
579
- * @type {number | bigint}
580
- * @memberof FiatApiDeposit
588
+ * deposit amount
589
+ * @type {string}
590
+ * @memberof ApiDeposit
581
591
  */
582
- readonly amount: number | bigint;
592
+ readonly amount: string;
583
593
  /**
584
- *
594
+ * Request validity window in milliseconds
585
595
  * @type {number | bigint}
586
- * @memberof FiatApiDeposit
596
+ * @memberof ApiDeposit
587
597
  */
588
598
  readonly recvWindow?: number | bigint;
589
599
  /**
590
600
  *
591
601
  * @type {object}
592
- * @memberof FiatApiDeposit
602
+ * @memberof ApiDeposit
593
603
  */
594
604
  readonly ext?: object;
595
605
  }
596
606
  /**
597
- * Request parameters for fiatWithdraw operation in FiatApi.
607
+ * Request parameters for fiatWithdraw operation in Api.
598
608
  * @interface FiatWithdrawRequest
599
609
  */
600
610
  interface FiatWithdrawRequest {
601
611
  /**
602
- *
612
+ * Fiat currency, such as BRL, ARS, MXN
603
613
  * @type {string}
604
- * @memberof FiatApiFiatWithdraw
614
+ * @memberof ApiFiatWithdraw
605
615
  */
606
616
  readonly currency: string;
607
617
  /**
608
- *
618
+ * payment method; current supported: bank_transfer
609
619
  * @type {string}
610
- * @memberof FiatApiFiatWithdraw
620
+ * @memberof ApiFiatWithdraw
611
621
  */
612
- readonly apiPaymentMethod: string;
622
+ readonly apiPaymentMethod: FiatWithdrawApiPaymentMethodEnum;
613
623
  /**
614
- *
624
+ * withdraw amount
615
625
  * @type {number | bigint}
616
- * @memberof FiatApiFiatWithdraw
626
+ * @memberof ApiFiatWithdraw
617
627
  */
618
628
  readonly amount: number | bigint;
619
629
  /**
620
630
  *
621
- * @type {AccountInfo}
622
- * @memberof FiatApiFiatWithdraw
631
+ * @type {FiatWithdrawRequestAccountInfo}
632
+ * @memberof ApiFiatWithdraw
623
633
  */
624
- readonly accountInfo: AccountInfo;
634
+ readonly accountInfo: FiatWithdrawRequestAccountInfo;
625
635
  /**
626
- *
636
+ * Request validity window in milliseconds
627
637
  * @type {number | bigint}
628
- * @memberof FiatApiFiatWithdraw
638
+ * @memberof ApiFiatWithdraw
629
639
  */
630
640
  readonly recvWindow?: number | bigint;
631
641
  /**
632
642
  *
633
643
  * @type {object}
634
- * @memberof FiatApiFiatWithdraw
644
+ * @memberof ApiFiatWithdraw
635
645
  */
636
646
  readonly ext?: object;
637
647
  }
638
648
  /**
639
- * Request parameters for getFiatDepositWithdrawHistory operation in FiatApi.
649
+ * Request parameters for getFiatDepositWithdrawHistory operation in Api.
640
650
  * @interface GetFiatDepositWithdrawHistoryRequest
641
651
  */
642
652
  interface GetFiatDepositWithdrawHistoryRequest {
643
653
  /**
644
- * 0-buy,1-sell
654
+ * 0: deposit, 1: withdraw
645
655
  * @type {string}
646
- * @memberof FiatApiGetFiatDepositWithdrawHistory
656
+ * @memberof ApiGetFiatDepositWithdrawHistory
647
657
  */
648
658
  readonly transactionType: string;
649
659
  /**
650
660
  *
651
661
  * @type {number | bigint}
652
- * @memberof FiatApiGetFiatDepositWithdrawHistory
662
+ * @memberof ApiGetFiatDepositWithdrawHistory
653
663
  */
654
664
  readonly beginTime?: number | bigint;
655
665
  /**
656
666
  *
657
667
  * @type {number | bigint}
658
- * @memberof FiatApiGetFiatDepositWithdrawHistory
668
+ * @memberof ApiGetFiatDepositWithdrawHistory
659
669
  */
660
670
  readonly endTime?: number | bigint;
661
671
  /**
662
- * default 1
672
+ *
663
673
  * @type {number | bigint}
664
- * @memberof FiatApiGetFiatDepositWithdrawHistory
674
+ * @memberof ApiGetFiatDepositWithdrawHistory
665
675
  */
666
676
  readonly page?: number | bigint;
667
677
  /**
668
- * default 100, max 500
678
+ *
669
679
  * @type {number | bigint}
670
- * @memberof FiatApiGetFiatDepositWithdrawHistory
680
+ * @memberof ApiGetFiatDepositWithdrawHistory
671
681
  */
672
682
  readonly rows?: number | bigint;
673
683
  /**
674
684
  *
675
685
  * @type {number | bigint}
676
- * @memberof FiatApiGetFiatDepositWithdrawHistory
686
+ * @memberof ApiGetFiatDepositWithdrawHistory
677
687
  */
678
688
  readonly recvWindow?: number | bigint;
679
689
  }
680
690
  /**
681
- * Request parameters for getFiatPaymentsHistory operation in FiatApi.
691
+ * Request parameters for getFiatPaymentsHistory operation in Api.
682
692
  * @interface GetFiatPaymentsHistoryRequest
683
693
  */
684
694
  interface GetFiatPaymentsHistoryRequest {
685
695
  /**
686
- * 0-buy,1-sell
696
+ * 0: buy, 1: sell
687
697
  * @type {string}
688
- * @memberof FiatApiGetFiatPaymentsHistory
698
+ * @memberof ApiGetFiatPaymentsHistory
689
699
  */
690
700
  readonly transactionType: string;
691
701
  /**
692
702
  *
693
703
  * @type {number | bigint}
694
- * @memberof FiatApiGetFiatPaymentsHistory
704
+ * @memberof ApiGetFiatPaymentsHistory
695
705
  */
696
706
  readonly beginTime?: number | bigint;
697
707
  /**
698
708
  *
699
709
  * @type {number | bigint}
700
- * @memberof FiatApiGetFiatPaymentsHistory
710
+ * @memberof ApiGetFiatPaymentsHistory
701
711
  */
702
712
  readonly endTime?: number | bigint;
703
713
  /**
704
- * default 1
714
+ *
705
715
  * @type {number | bigint}
706
- * @memberof FiatApiGetFiatPaymentsHistory
716
+ * @memberof ApiGetFiatPaymentsHistory
707
717
  */
708
718
  readonly page?: number | bigint;
709
719
  /**
710
- * default 100, max 500
720
+ *
711
721
  * @type {number | bigint}
712
- * @memberof FiatApiGetFiatPaymentsHistory
722
+ * @memberof ApiGetFiatPaymentsHistory
713
723
  */
714
724
  readonly rows?: number | bigint;
715
725
  /**
716
726
  *
717
727
  * @type {number | bigint}
718
- * @memberof FiatApiGetFiatPaymentsHistory
728
+ * @memberof ApiGetFiatPaymentsHistory
719
729
  */
720
730
  readonly recvWindow?: number | bigint;
721
731
  }
722
732
  /**
723
- * Request parameters for getOrderDetail operation in FiatApi.
733
+ * Request parameters for getOrderDetail operation in Api.
724
734
  * @interface GetOrderDetailRequest
725
735
  */
726
736
  interface GetOrderDetailRequest {
727
737
  /**
728
- * order id retrieved from the api call of withdrawal
738
+ * Order ID retrieved from the withdrawal API
729
739
  * @type {string}
730
- * @memberof FiatApiGetOrderDetail
740
+ * @memberof ApiGetOrderDetail
731
741
  */
732
742
  readonly orderNo: string;
733
743
  /**
734
744
  *
735
745
  * @type {number | bigint}
736
- * @memberof FiatApiGetOrderDetail
746
+ * @memberof ApiGetOrderDetail
737
747
  */
738
748
  readonly recvWindow?: number | bigint;
739
749
  }
740
750
  /**
741
- * FiatApi - object-oriented interface
742
- * @class FiatApi
751
+ * Api - object-oriented interface
752
+ * @class Api
743
753
  */
744
- declare class FiatApi implements FiatApiInterface {
754
+ declare class Api implements ApiInterface {
745
755
  private readonly configuration;
746
756
  private localVarAxiosParamCreator;
747
757
  constructor(configuration: ConfigurationRestAPI);
748
758
  /**
749
759
  * Submit deposit request, in this version, we only support BRL deposit via pix.
750
760
  *
751
- *
752
- *
753
761
  * For BRL deposit via pix, you need to place an order before making a transfer from your bank.
754
762
  *
755
- * Before calling this api, please make sure you have already completed your KYC or KYB, and already activated your fiat service on our website.
763
+ * Before calling this api, please make sure you have already completed your KYC or KYB, and already activated your
764
+ * fiat service on our website.
756
765
  *
757
- * `timestamp`, `signature` and `recvWindow` are sent as query-string parameters, while the business fields (`currency`, `apiPaymentMethod`, `amount`, `ext`) are sent in the JSON request body with `Content-Type: application/json`.
766
+ * Weight(UID): 45000
758
767
  *
759
- * Weight: 45000
768
+ * Security Type: TRADE
760
769
  *
761
- * @summary Deposit(TRADE)
770
+ * Notes:
771
+ * - `timestamp`, `signature` and `recvWindow` are sent as query-string parameters, while the business fields (`currency`, `apiPaymentMethod`, `amount`, `ext`) are sent in the JSON request body with `Content-Type: application/json`.
772
+ *
773
+ * @summary Deposit (TRADE)
762
774
  * @param {DepositRequest} requestParameters Request parameters.
763
775
  * @returns {Promise<RestApiResponse<DepositResponse>>}
764
776
  * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError}
765
- * @memberof FiatApi
766
- * @see {@link https://developers.binance.com/docs/fiat/rest-api/Fiat-Deposit Binance API Documentation}
777
+ * @memberof Api
778
+ * @see {@link https://developers.binance.com/en/docs/catalog/investment-and-services-fiat/api/rest-api/~#deposit Binance API Documentation}
767
779
  */
768
780
  deposit(requestParameters: DepositRequest): Promise<RestApiResponse<DepositResponse>>;
769
781
  /**
770
782
  * Submit withdraw request, in this version, we support BRL,ARS,MXN withdrawal via bank_transfer.
771
783
  *
772
- * You need to call this api first, and call query order detail api in a loop to get the status of the order until this order is successful.
784
+ * You need to call this api first, and call query order detail api in a loop to get the status of the order until
785
+ * this order is successful.
773
786
  *
774
- * Before calling this API, please ensure you have completed your KYC or KYB, activated your fiat service, and verified your destination bank account on our website.
787
+ * Before calling this api, please make sure you have already completed your KYC or KYB, and already activated your
788
+ * fiat service on our website.
775
789
  *
776
- * you need to bind your bank account on web/app before using the corresponding account number
790
+ * Weight(UID): 45000
777
791
  *
778
- * Weight: 45000
792
+ * Security Type: TRADE
779
793
  *
780
- * @summary Fiat Withdraw(WITHDRAW)
794
+ * @summary Fiat Withdraw (TRADE)
781
795
  * @param {FiatWithdrawRequest} requestParameters Request parameters.
782
796
  * @returns {Promise<RestApiResponse<FiatWithdrawResponse>>}
783
797
  * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError}
784
- * @memberof FiatApi
785
- * @see {@link https://developers.binance.com/docs/fiat/rest-api/Fiat-Withdraw Binance API Documentation}
798
+ * @memberof Api
799
+ * @see {@link https://developers.binance.com/en/docs/catalog/investment-and-services-fiat/api/rest-api/~#fiat-withdraw Binance API Documentation}
786
800
  */
787
801
  fiatWithdraw(requestParameters: FiatWithdrawRequest): Promise<RestApiResponse<FiatWithdrawResponse>>;
788
802
  /**
789
803
  * Get Fiat Deposit/Withdraw History
790
804
  *
791
- * If beginTime and endTime are not sent, the recent 30-day data will be returned.
805
+ * Weight(UID): 45000
806
+ *
807
+ * Security Type: USER_DATA
792
808
  *
793
- * Weight: 45000
809
+ * Notes:
810
+ * - If `beginTime` and `endTime` are not sent, recent 30-day data is returned.
794
811
  *
795
812
  * @summary Get Fiat Deposit/Withdraw History (USER_DATA)
796
813
  * @param {GetFiatDepositWithdrawHistoryRequest} requestParameters Request parameters.
797
814
  * @returns {Promise<RestApiResponse<GetFiatDepositWithdrawHistoryResponse>>}
798
815
  * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError}
799
- * @memberof FiatApi
800
- * @see {@link https://developers.binance.com/docs/fiat/rest-api/Get-Fiat-Deposit-Withdraw-History Binance API Documentation}
816
+ * @memberof Api
817
+ * @see {@link https://developers.binance.com/en/docs/catalog/investment-and-services-fiat/api/rest-api/~#get-fiat-deposit-withdraw-history Binance API Documentation}
801
818
  */
802
819
  getFiatDepositWithdrawHistory(requestParameters: GetFiatDepositWithdrawHistoryRequest): Promise<RestApiResponse<GetFiatDepositWithdrawHistoryResponse>>;
803
820
  /**
804
- * Get Fiat Deposit/Withdraw History
821
+ * Get Fiat Payments History
805
822
  *
806
- * If beginTime and endTime are not sent, the recent 30-day data will be returned.
807
- * paymentMethod: Only when requesting payments history for buy (transactionType=0), response contains paymentMethod representing the way of purchase. Now we have:
808
- * Cash Balance
809
- * Credit Card
810
- * Online Banking
811
- * Bank Transfer
823
+ * Weight(IP): 1
812
824
  *
813
- * Weight: 1
825
+ * Security Type: USER_DATA
826
+ *
827
+ * Notes:
828
+ * - If `beginTime` and `endTime` are not sent, recent 30-day data is returned.
829
+ * - `paymentMethod` is returned only when querying buy history (`transactionType=0`).
830
+ * - Supported payment methods: `Cash Balance`, `Credit Card`, `Online Banking`, `Bank Transfer`.
814
831
  *
815
832
  * @summary Get Fiat Payments History (USER_DATA)
816
833
  * @param {GetFiatPaymentsHistoryRequest} requestParameters Request parameters.
817
834
  * @returns {Promise<RestApiResponse<GetFiatPaymentsHistoryResponse>>}
818
835
  * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError}
819
- * @memberof FiatApi
820
- * @see {@link https://developers.binance.com/docs/fiat/rest-api/Get-Fiat-Payments-History Binance API Documentation}
836
+ * @memberof Api
837
+ * @see {@link https://developers.binance.com/en/docs/catalog/investment-and-services-fiat/api/rest-api/~#get-fiat-payments-history Binance API Documentation}
821
838
  */
822
839
  getFiatPaymentsHistory(requestParameters: GetFiatPaymentsHistoryRequest): Promise<RestApiResponse<GetFiatPaymentsHistoryResponse>>;
823
840
  /**
824
841
  * Get Order Detail
825
842
  *
826
- * Before calling this api, please make sure you have already completed your KYC or KYB, and already activated your fiat service on our website.
843
+ * Before calling this api, please make sure you have already completed your KYC or KYB, and already activated your
844
+ * fiat service on our website.
845
+ *
846
+ * Weight(IP): 1
827
847
  *
828
- * Weight: 1
848
+ * Security Type: USER_DATA
829
849
  *
830
- * @summary Get Order Detail(USER_DATA)
850
+ * @summary Get Order Detail (USER_DATA)
831
851
  * @param {GetOrderDetailRequest} requestParameters Request parameters.
832
852
  * @returns {Promise<RestApiResponse<GetOrderDetailResponse>>}
833
853
  * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError}
834
- * @memberof FiatApi
835
- * @see {@link https://developers.binance.com/docs/fiat/rest-api/Get-Order-Detail Binance API Documentation}
854
+ * @memberof Api
855
+ * @see {@link https://developers.binance.com/en/docs/catalog/investment-and-services-fiat/api/rest-api/~#get-order-detail Binance API Documentation}
836
856
  */
837
857
  getOrderDetail(requestParameters: GetOrderDetailRequest): Promise<RestApiResponse<GetOrderDetailResponse>>;
838
858
  }
859
+ declare enum DepositApiPaymentMethodEnum {
860
+ pix = "pix",
861
+ }
862
+ declare enum FiatWithdrawApiPaymentMethodEnum {
863
+ bank_transfer = "bank_transfer",
864
+ }
839
865
  //#endregion
840
866
  //#region src/rest-api/rest-api.d.ts
841
867
  declare class RestAPI {
842
868
  private configuration;
843
- private fiatApi;
869
+ private api;
844
870
  constructor(configuration: ConfigurationRestAPI);
845
871
  /**
846
872
  * Generic function to send a request.
@@ -865,96 +891,106 @@ declare class RestAPI {
865
891
  /**
866
892
  * Submit deposit request, in this version, we only support BRL deposit via pix.
867
893
  *
868
- *
869
- *
870
894
  * For BRL deposit via pix, you need to place an order before making a transfer from your bank.
871
895
  *
872
- * Before calling this api, please make sure you have already completed your KYC or KYB, and already activated your fiat service on our website.
896
+ * Before calling this api, please make sure you have already completed your KYC or KYB, and already activated your
897
+ * fiat service on our website.
873
898
  *
874
- * `timestamp`, `signature` and `recvWindow` are sent as query-string parameters, while the business fields (`currency`, `apiPaymentMethod`, `amount`, `ext`) are sent in the JSON request body with `Content-Type: application/json`.
899
+ * Weight(UID): 45000
875
900
  *
876
- * Weight: 45000
901
+ * Security Type: TRADE
877
902
  *
878
- * @summary Deposit(TRADE)
903
+ * Notes:
904
+ * - `timestamp`, `signature` and `recvWindow` are sent as query-string parameters, while the business fields (`currency`, `apiPaymentMethod`, `amount`, `ext`) are sent in the JSON request body with `Content-Type: application/json`.
905
+ *
906
+ * @summary Deposit (TRADE)
879
907
  * @param {DepositRequest} requestParameters Request parameters.
880
908
  *
881
909
  * @returns {Promise<RestApiResponse<DepositResponse>>}
882
910
  * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError}
883
- * @see {@link https://developers.binance.com/docs/fiat/rest-api/Fiat-Deposit Binance API Documentation}
911
+ * @see {@link https://developers.binance.com/en/docs/catalog/investment-and-services-fiat/api/rest-api/~#deposit Binance API Documentation}
884
912
  */
885
913
  deposit(requestParameters: DepositRequest): Promise<RestApiResponse<DepositResponse>>;
886
914
  /**
887
915
  * Submit withdraw request, in this version, we support BRL,ARS,MXN withdrawal via bank_transfer.
888
916
  *
889
- * You need to call this api first, and call query order detail api in a loop to get the status of the order until this order is successful.
917
+ * You need to call this api first, and call query order detail api in a loop to get the status of the order until
918
+ * this order is successful.
890
919
  *
891
- * Before calling this API, please ensure you have completed your KYC or KYB, activated your fiat service, and verified your destination bank account on our website.
920
+ * Before calling this api, please make sure you have already completed your KYC or KYB, and already activated your
921
+ * fiat service on our website.
892
922
  *
893
- * you need to bind your bank account on web/app before using the corresponding account number
923
+ * Weight(UID): 45000
894
924
  *
895
- * Weight: 45000
925
+ * Security Type: TRADE
896
926
  *
897
- * @summary Fiat Withdraw(WITHDRAW)
927
+ * @summary Fiat Withdraw (TRADE)
898
928
  * @param {FiatWithdrawRequest} requestParameters Request parameters.
899
929
  *
900
930
  * @returns {Promise<RestApiResponse<FiatWithdrawResponse>>}
901
931
  * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError}
902
- * @see {@link https://developers.binance.com/docs/fiat/rest-api/Fiat-Withdraw Binance API Documentation}
932
+ * @see {@link https://developers.binance.com/en/docs/catalog/investment-and-services-fiat/api/rest-api/~#fiat-withdraw Binance API Documentation}
903
933
  */
904
934
  fiatWithdraw(requestParameters: FiatWithdrawRequest): Promise<RestApiResponse<FiatWithdrawResponse>>;
905
935
  /**
906
936
  * Get Fiat Deposit/Withdraw History
907
937
  *
908
- * If beginTime and endTime are not sent, the recent 30-day data will be returned.
938
+ * Weight(UID): 45000
939
+ *
940
+ * Security Type: USER_DATA
909
941
  *
910
- * Weight: 45000
942
+ * Notes:
943
+ * - If `beginTime` and `endTime` are not sent, recent 30-day data is returned.
911
944
  *
912
945
  * @summary Get Fiat Deposit/Withdraw History (USER_DATA)
913
946
  * @param {GetFiatDepositWithdrawHistoryRequest} requestParameters Request parameters.
914
947
  *
915
948
  * @returns {Promise<RestApiResponse<GetFiatDepositWithdrawHistoryResponse>>}
916
949
  * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError}
917
- * @see {@link https://developers.binance.com/docs/fiat/rest-api/Get-Fiat-Deposit-Withdraw-History Binance API Documentation}
950
+ * @see {@link https://developers.binance.com/en/docs/catalog/investment-and-services-fiat/api/rest-api/~#get-fiat-deposit-withdraw-history Binance API Documentation}
918
951
  */
919
952
  getFiatDepositWithdrawHistory(requestParameters: GetFiatDepositWithdrawHistoryRequest): Promise<RestApiResponse<GetFiatDepositWithdrawHistoryResponse>>;
920
953
  /**
921
- * Get Fiat Deposit/Withdraw History
954
+ * Get Fiat Payments History
922
955
  *
923
- * If beginTime and endTime are not sent, the recent 30-day data will be returned.
924
- * paymentMethod: Only when requesting payments history for buy (transactionType=0), response contains paymentMethod representing the way of purchase. Now we have:
925
- * Cash Balance
926
- * Credit Card
927
- * Online Banking
928
- * Bank Transfer
956
+ * Weight(IP): 1
929
957
  *
930
- * Weight: 1
958
+ * Security Type: USER_DATA
959
+ *
960
+ * Notes:
961
+ * - If `beginTime` and `endTime` are not sent, recent 30-day data is returned.
962
+ * - `paymentMethod` is returned only when querying buy history (`transactionType=0`).
963
+ * - Supported payment methods: `Cash Balance`, `Credit Card`, `Online Banking`, `Bank Transfer`.
931
964
  *
932
965
  * @summary Get Fiat Payments History (USER_DATA)
933
966
  * @param {GetFiatPaymentsHistoryRequest} requestParameters Request parameters.
934
967
  *
935
968
  * @returns {Promise<RestApiResponse<GetFiatPaymentsHistoryResponse>>}
936
969
  * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError}
937
- * @see {@link https://developers.binance.com/docs/fiat/rest-api/Get-Fiat-Payments-History Binance API Documentation}
970
+ * @see {@link https://developers.binance.com/en/docs/catalog/investment-and-services-fiat/api/rest-api/~#get-fiat-payments-history Binance API Documentation}
938
971
  */
939
972
  getFiatPaymentsHistory(requestParameters: GetFiatPaymentsHistoryRequest): Promise<RestApiResponse<GetFiatPaymentsHistoryResponse>>;
940
973
  /**
941
974
  * Get Order Detail
942
975
  *
943
- * Before calling this api, please make sure you have already completed your KYC or KYB, and already activated your fiat service on our website.
976
+ * Before calling this api, please make sure you have already completed your KYC or KYB, and already activated your
977
+ * fiat service on our website.
978
+ *
979
+ * Weight(IP): 1
944
980
  *
945
- * Weight: 1
981
+ * Security Type: USER_DATA
946
982
  *
947
- * @summary Get Order Detail(USER_DATA)
983
+ * @summary Get Order Detail (USER_DATA)
948
984
  * @param {GetOrderDetailRequest} requestParameters Request parameters.
949
985
  *
950
986
  * @returns {Promise<RestApiResponse<GetOrderDetailResponse>>}
951
987
  * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError}
952
- * @see {@link https://developers.binance.com/docs/fiat/rest-api/Get-Order-Detail Binance API Documentation}
988
+ * @see {@link https://developers.binance.com/en/docs/catalog/investment-and-services-fiat/api/rest-api/~#get-order-detail Binance API Documentation}
953
989
  */
954
990
  getOrderDetail(requestParameters: GetOrderDetailRequest): Promise<RestApiResponse<GetOrderDetailResponse>>;
955
991
  }
956
992
  declare namespace index_d_exports {
957
- export { AccountInfo, DepositRequest, DepositResponse, DepositResponseData, FiatApi, FiatApiInterface, FiatWithdrawRequest, FiatWithdrawResponse, GetFiatDepositWithdrawHistoryRequest, GetFiatDepositWithdrawHistoryResponse, GetFiatDepositWithdrawHistoryResponseDataInner, GetFiatPaymentsHistoryRequest, GetFiatPaymentsHistoryResponse, GetFiatPaymentsHistoryResponseDataInner, GetOrderDetailRequest, GetOrderDetailResponse, GetOrderDetailResponseData, RestAPI };
993
+ export { Api, ApiInterface, DepositApiPaymentMethodEnum, DepositRequest, DepositResponse, DepositResponseData, FiatWithdrawApiPaymentMethodEnum, FiatWithdrawRequest, FiatWithdrawRequestAccountInfo, FiatWithdrawResponse, GetFiatDepositWithdrawHistoryRequest, GetFiatDepositWithdrawHistoryResponse, GetFiatDepositWithdrawHistoryResponseDataInner, GetFiatPaymentsHistoryRequest, GetFiatPaymentsHistoryResponse, GetFiatPaymentsHistoryResponseDataInner, GetOrderDetailRequest, GetOrderDetailResponse, GetOrderDetailResponseData, RestAPI };
958
994
  }
959
995
  //#endregion
960
996
  //#region src/fiat.d.ts