@binance/fiat 3.0.1 → 4.0.0

package/dist/index.d.mts

@@ -1,6 +1,110 @@
 import { RestApiResponse, ConfigurationRestAPI } from '@binance/common';
 export { BadRequestError, ConnectorClientError, FIAT_REST_API_PROD_URL, ForbiddenError, NetworkError, NotFoundError, RateLimitBanError, RequiredError, ServerError, TooManyRequestsError, UnauthorizedError } from '@binance/common';
 
+/**
+ * Binance Fiat REST API
+ *
+ * OpenAPI Specification for the Binance Fiat REST API
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface DepositResponseData
+ */
+interface DepositResponseData {
+    /**
+     *
+     * @type {string}
+     * @memberof DepositResponseData
+     */
+    orderId?: string;
+}
+
+/**
+ * Binance Fiat REST API
+ *
+ * OpenAPI Specification for the Binance Fiat REST API
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+/**
+ *
+ * @export
+ * @interface DepositResponse
+ */
+interface DepositResponse {
+    /**
+     *
+     * @type {string}
+     * @memberof DepositResponse
+     */
+    code?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof DepositResponse
+     */
+    message?: string;
+    /**
+     *
+     * @type {DepositResponseData}
+     * @memberof DepositResponse
+     */
+    data?: DepositResponseData;
+}
+
+/**
+ * Binance Fiat REST API
+ *
+ * OpenAPI Specification for the Binance Fiat REST API
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+/**
+ *
+ * @export
+ * @interface FiatWithdrawResponse
+ */
+interface FiatWithdrawResponse {
+    /**
+     *
+     * @type {string}
+     * @memberof FiatWithdrawResponse
+     */
+    code?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof FiatWithdrawResponse
+     */
+    message?: string;
+    /**
+     *
+     * @type {DepositResponseData}
+     * @memberof FiatWithdrawResponse
+     */
+    data?: DepositResponseData;
+}
+
 /**
  * Binance Fiat REST API
  *
@@ -263,6 +367,113 @@ interface GetFiatPaymentsHistoryResponse {
     success?: boolean;
 }
 
+/**
+ * Binance Fiat REST API
+ *
+ * OpenAPI Specification for the Binance Fiat REST API
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface GetOrderDetailResponseData
+ */
+interface GetOrderDetailResponseData {
+    /**
+     *
+     * @type {string}
+     * @memberof GetOrderDetailResponseData
+     */
+    orderId?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof GetOrderDetailResponseData
+     */
+    orderStatus?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof GetOrderDetailResponseData
+     */
+    amount?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof GetOrderDetailResponseData
+     */
+    fee?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof GetOrderDetailResponseData
+     */
+    fiatCurrency?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof GetOrderDetailResponseData
+     */
+    errorCode?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof GetOrderDetailResponseData
+     */
+    errorMessage?: string;
+    /**
+     *
+     * @type {object}
+     * @memberof GetOrderDetailResponseData
+     */
+    ext?: object;
+}
+
+/**
+ * Binance Fiat REST API
+ *
+ * OpenAPI Specification for the Binance Fiat REST API
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+/**
+ *
+ * @export
+ * @interface GetOrderDetailResponse
+ */
+interface GetOrderDetailResponse {
+    /**
+     *
+     * @type {string}
+     * @memberof GetOrderDetailResponse
+     */
+    code?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof GetOrderDetailResponse
+     */
+    message?: string;
+    /**
+     *
+     * @type {GetOrderDetailResponseData}
+     * @memberof GetOrderDetailResponse
+     */
+    data?: GetOrderDetailResponseData;
+}
+
 /**
  * Binance Fiat REST API
  *
@@ -281,6 +492,24 @@ interface GetFiatPaymentsHistoryResponse {
  * @interface FiatApi
  */
 interface FiatApiInterface {
+    /**
+     * Submit withdraw request, in this version, we only support BRL withdrawal via bank_transfer.
+     *
+     * 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.
+     *
+     * Before calling this api, please make sure you have already completed your KYC or KYB, and already activated your fiat service on our website.
+     *
+     * you need to bind your bank account on web/app before using the corresponding account number
+     *
+     * Weight: 45000
+     *
+     * @summary Fiat Withdraw(WITHDRAW)
+     * @param {FiatWithdrawRequest} requestParameters Request parameters.
+     *
+     * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError}
+     * @memberof FiatApiInterface
+     */
+    fiatWithdraw(requestParameters?: FiatWithdrawRequest): Promise<RestApiResponse<FiatWithdrawResponse>>;
     /**
      * Get Fiat Deposit/Withdraw History
      *
@@ -314,6 +543,32 @@ interface FiatApiInterface {
      * @memberof FiatApiInterface
      */
     getFiatPaymentsHistory(requestParameters: GetFiatPaymentsHistoryRequest): Promise<RestApiResponse<GetFiatPaymentsHistoryResponse>>;
+    /**
+     * Get Order Detail
+     *
+     * Before calling this api, please make sure you have already completed your KYC or KYB, and already activated your fiat service on our website.
+     *
+     * Weight: 45000
+     *
+     * @summary Get Order Detail(USER_DATA)
+     * @param {GetOrderDetailRequest} requestParameters Request parameters.
+     *
+     * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError}
+     * @memberof FiatApiInterface
+     */
+    getOrderDetail(requestParameters: GetOrderDetailRequest): Promise<RestApiResponse<GetOrderDetailResponse>>;
+}
+/**
+ * Request parameters for fiatWithdraw operation in FiatApi.
+ * @interface FiatWithdrawRequest
+ */
+interface FiatWithdrawRequest {
+    /**
+     *
+     * @type {number | bigint}
+     * @memberof FiatApiFiatWithdraw
+     */
+    readonly recvWindow?: number | bigint;
 }
 /**
  * Request parameters for getFiatDepositWithdrawHistory operation in FiatApi.
@@ -399,6 +654,24 @@ interface GetFiatPaymentsHistoryRequest {
      */
     readonly recvWindow?: number | bigint;
 }
+/**
+ * Request parameters for getOrderDetail operation in FiatApi.
+ * @interface GetOrderDetailRequest
+ */
+interface GetOrderDetailRequest {
+    /**
+     * order id retrieved from the api call of withdrawal
+     * @type {string}
+     * @memberof FiatApiGetOrderDetail
+     */
+    readonly orderId: string;
+    /**
+     *
+     * @type {number | bigint}
+     * @memberof FiatApiGetOrderDetail
+     */
+    readonly recvWindow?: number | bigint;
+}
 /**
  * FiatApi - object-oriented interface
  * @class FiatApi
@@ -407,6 +680,25 @@ declare class FiatApi implements FiatApiInterface {
     private readonly configuration;
     private localVarAxiosParamCreator;
     constructor(configuration: ConfigurationRestAPI);
+    /**
+     * Submit withdraw request, in this version, we only support BRL withdrawal via bank_transfer.
+     *
+     * 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.
+     *
+     * Before calling this api, please make sure you have already completed your KYC or KYB, and already activated your fiat service on our website.
+     *
+     * you need to bind your bank account on web/app before using the corresponding account number
+     *
+     * Weight: 45000
+     *
+     * @summary Fiat Withdraw(WITHDRAW)
+     * @param {FiatWithdrawRequest} requestParameters Request parameters.
+     * @returns {Promise<RestApiResponse<FiatWithdrawResponse>>}
+     * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError}
+     * @memberof FiatApi
+     * @see {@link https://developers.binance.com/docs/fiat/rest-api/Fiat-Withdraw Binance API Documentation}
+     */
+    fiatWithdraw(requestParameters?: FiatWithdrawRequest): Promise<RestApiResponse<FiatWithdrawResponse>>;
     /**
      * Get Fiat Deposit/Withdraw History
      *
@@ -442,6 +734,21 @@ declare class FiatApi implements FiatApiInterface {
      * @see {@link https://developers.binance.com/docs/fiat/rest-api/Get-Fiat-Payments-History Binance API Documentation}
      */
     getFiatPaymentsHistory(requestParameters: GetFiatPaymentsHistoryRequest): Promise<RestApiResponse<GetFiatPaymentsHistoryResponse>>;
+    /**
+     * Get Order Detail
+     *
+     * Before calling this api, please make sure you have already completed your KYC or KYB, and already activated your fiat service on our website.
+     *
+     * Weight: 45000
+     *
+     * @summary Get Order Detail(USER_DATA)
+     * @param {GetOrderDetailRequest} requestParameters Request parameters.
+     * @returns {Promise<RestApiResponse<GetOrderDetailResponse>>}
+     * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError}
+     * @memberof FiatApi
+     * @see {@link https://developers.binance.com/docs/fiat/rest-api/Get-Order-Detail Binance API Documentation}
+     */
+    getOrderDetail(requestParameters: GetOrderDetailRequest): Promise<RestApiResponse<GetOrderDetailResponse>>;
 }
 
 /**
@@ -479,6 +786,25 @@ declare class RestAPI {
      * @returns A promise resolving to the response data object.
      */
     sendSignedRequest<T>(endpoint: string, method: 'GET' | 'POST' | 'DELETE' | 'PUT' | 'PATCH', params?: Record<string, unknown>): Promise<RestApiResponse<T>>;
+    /**
+     * Submit withdraw request, in this version, we only support BRL withdrawal via bank_transfer.
+     *
+     * 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.
+     *
+     * Before calling this api, please make sure you have already completed your KYC or KYB, and already activated your fiat service on our website.
+     *
+     * you need to bind your bank account on web/app before using the corresponding account number
+     *
+     * Weight: 45000
+     *
+     * @summary Fiat Withdraw(WITHDRAW)
+     * @param {FiatWithdrawRequest} requestParameters Request parameters.
+     *
+     * @returns {Promise<RestApiResponse<FiatWithdrawResponse>>}
+     * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError}
+     * @see {@link https://developers.binance.com/docs/fiat/rest-api/Fiat-Withdraw Binance API Documentation}
+     */
+    fiatWithdraw(requestParameters?: FiatWithdrawRequest): Promise<RestApiResponse<FiatWithdrawResponse>>;
     /**
      * Get Fiat Deposit/Withdraw History
      *
@@ -514,6 +840,21 @@ declare class RestAPI {
      * @see {@link https://developers.binance.com/docs/fiat/rest-api/Get-Fiat-Payments-History Binance API Documentation}
      */
     getFiatPaymentsHistory(requestParameters: GetFiatPaymentsHistoryRequest): Promise<RestApiResponse<GetFiatPaymentsHistoryResponse>>;
+    /**
+     * Get Order Detail
+     *
+     * Before calling this api, please make sure you have already completed your KYC or KYB, and already activated your fiat service on our website.
+     *
+     * Weight: 45000
+     *
+     * @summary Get Order Detail(USER_DATA)
+     * @param {GetOrderDetailRequest} requestParameters Request parameters.
+     *
+     * @returns {Promise<RestApiResponse<GetOrderDetailResponse>>}
+     * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError}
+     * @see {@link https://developers.binance.com/docs/fiat/rest-api/Get-Order-Detail Binance API Documentation}
+     */
+    getOrderDetail(requestParameters: GetOrderDetailRequest): Promise<RestApiResponse<GetOrderDetailResponse>>;
 }
 
 /**
@@ -529,19 +870,26 @@ declare class RestAPI {
  * Do not edit the class manually.
  */
 
+type index_DepositResponse = DepositResponse;
+type index_DepositResponseData = DepositResponseData;
 type index_FiatApi = FiatApi;
 declare const index_FiatApi: typeof FiatApi;
 type index_FiatApiInterface = FiatApiInterface;
+type index_FiatWithdrawRequest = FiatWithdrawRequest;
+type index_FiatWithdrawResponse = FiatWithdrawResponse;
 type index_GetFiatDepositWithdrawHistoryRequest = GetFiatDepositWithdrawHistoryRequest;
 type index_GetFiatDepositWithdrawHistoryResponse = GetFiatDepositWithdrawHistoryResponse;
 type index_GetFiatDepositWithdrawHistoryResponseDataInner = GetFiatDepositWithdrawHistoryResponseDataInner;
 type index_GetFiatPaymentsHistoryRequest = GetFiatPaymentsHistoryRequest;
 type index_GetFiatPaymentsHistoryResponse = GetFiatPaymentsHistoryResponse;
 type index_GetFiatPaymentsHistoryResponseDataInner = GetFiatPaymentsHistoryResponseDataInner;
+type index_GetOrderDetailRequest = GetOrderDetailRequest;
+type index_GetOrderDetailResponse = GetOrderDetailResponse;
+type index_GetOrderDetailResponseData = GetOrderDetailResponseData;
 type index_RestAPI = RestAPI;
 declare const index_RestAPI: typeof RestAPI;
 declare namespace index {
-  export { index_FiatApi as FiatApi, type index_FiatApiInterface as FiatApiInterface, type index_GetFiatDepositWithdrawHistoryRequest as GetFiatDepositWithdrawHistoryRequest, type index_GetFiatDepositWithdrawHistoryResponse as GetFiatDepositWithdrawHistoryResponse, type index_GetFiatDepositWithdrawHistoryResponseDataInner as GetFiatDepositWithdrawHistoryResponseDataInner, type index_GetFiatPaymentsHistoryRequest as GetFiatPaymentsHistoryRequest, type index_GetFiatPaymentsHistoryResponse as GetFiatPaymentsHistoryResponse, type index_GetFiatPaymentsHistoryResponseDataInner as GetFiatPaymentsHistoryResponseDataInner, index_RestAPI as RestAPI };
+  export { type index_DepositResponse as DepositResponse, type index_DepositResponseData as DepositResponseData, index_FiatApi as FiatApi, type index_FiatApiInterface as FiatApiInterface, type index_FiatWithdrawRequest as FiatWithdrawRequest, type index_FiatWithdrawResponse as FiatWithdrawResponse, type index_GetFiatDepositWithdrawHistoryRequest as GetFiatDepositWithdrawHistoryRequest, type index_GetFiatDepositWithdrawHistoryResponse as GetFiatDepositWithdrawHistoryResponse, type index_GetFiatDepositWithdrawHistoryResponseDataInner as GetFiatDepositWithdrawHistoryResponseDataInner, type index_GetFiatPaymentsHistoryRequest as GetFiatPaymentsHistoryRequest, type index_GetFiatPaymentsHistoryResponse as GetFiatPaymentsHistoryResponse, type index_GetFiatPaymentsHistoryResponseDataInner as GetFiatPaymentsHistoryResponseDataInner, type index_GetOrderDetailRequest as GetOrderDetailRequest, type index_GetOrderDetailResponse as GetOrderDetailResponse, type index_GetOrderDetailResponseData as GetOrderDetailResponseData, index_RestAPI as RestAPI };
 }
 
 interface ConfigurationFiat {