@binance/pay/dist/index.d.mts

Official Binance Pay Connector - A lightweight library that provides a convenient interface to Binance's Pay REST API.

import { BadRequestError, ConfigurationRestAPI, ConnectorClientError, ForbiddenError, NetworkError, NotFoundError, PAY_REST_API_PROD_URL, RateLimitBanError, RequiredError, RestApiResponse, ServerError, TooManyRequestsError, UnauthorizedError } from "@binance/common";

//#region src/rest-api/types/get-pay-trade-history-response-data-inner-funds-detail-inner-wallet-asset-cost-inner.d.ts

/**
 * Binance Pay REST API
 *
 * OpenAPI Specification for the Binance Pay 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 GetPayTradeHistoryResponseDataInnerFundsDetailInnerWalletAssetCostInner
 */
interface GetPayTradeHistoryResponseDataInnerFundsDetailInnerWalletAssetCostInner {
  /**
   *
   * @type {string}
   * @memberof GetPayTradeHistoryResponseDataInnerFundsDetailInnerWalletAssetCostInner
   */
  '1'?: string;
  /**
   *
   * @type {string}
   * @memberof GetPayTradeHistoryResponseDataInnerFundsDetailInnerWalletAssetCostInner
   */
  '2'?: string;
}
//#endregion
//#region src/rest-api/types/get-pay-trade-history-response-data-inner-funds-detail-inner.d.ts

/**
 *
 * @export
 * @interface GetPayTradeHistoryResponseDataInnerFundsDetailInner
 */
interface GetPayTradeHistoryResponseDataInnerFundsDetailInner {
  /**
   *
   * @type {string}
   * @memberof GetPayTradeHistoryResponseDataInnerFundsDetailInner
   */
  currency?: string;
  /**
   *
   * @type {string}
   * @memberof GetPayTradeHistoryResponseDataInnerFundsDetailInner
   */
  amount?: string;
  /**
   *
   * @type {Array<GetPayTradeHistoryResponseDataInnerFundsDetailInnerWalletAssetCostInner>}
   * @memberof GetPayTradeHistoryResponseDataInnerFundsDetailInner
   */
  walletAssetCost?: Array<GetPayTradeHistoryResponseDataInnerFundsDetailInnerWalletAssetCostInner>;
}
//#endregion
//#region src/rest-api/types/get-pay-trade-history-response-data-inner-payer-info.d.ts
/**
 * Binance Pay REST API
 *
 * OpenAPI Specification for the Binance Pay 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 GetPayTradeHistoryResponseDataInnerPayerInfo
 */
interface GetPayTradeHistoryResponseDataInnerPayerInfo {
  /**
   *
   * @type {string}
   * @memberof GetPayTradeHistoryResponseDataInnerPayerInfo
   */
  name?: string;
  /**
   *
   * @type {string}
   * @memberof GetPayTradeHistoryResponseDataInnerPayerInfo
   */
  type?: string;
  /**
   *
   * @type {string}
   * @memberof GetPayTradeHistoryResponseDataInnerPayerInfo
   */
  binanceId?: string;
}
//#endregion
//#region src/rest-api/types/get-pay-trade-history-response-data-inner-receiver-info-extend.d.ts
/**
 * Binance Pay REST API
 *
 * OpenAPI Specification for the Binance Pay 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 GetPayTradeHistoryResponseDataInnerReceiverInfoExtend
 */
interface GetPayTradeHistoryResponseDataInnerReceiverInfoExtend {
  /**
   *
   * @type {string}
   * @memberof GetPayTradeHistoryResponseDataInnerReceiverInfoExtend
   */
  institutionName?: string;
  /**
   *
   * @type {string}
   * @memberof GetPayTradeHistoryResponseDataInnerReceiverInfoExtend
   */
  cardNumber?: string;
  /**
   *
   * @type {string}
   * @memberof GetPayTradeHistoryResponseDataInnerReceiverInfoExtend
   */
  digitalWalletId?: string;
}
//#endregion
//#region src/rest-api/types/get-pay-trade-history-response-data-inner-receiver-info.d.ts
/**
 *
 * @export
 * @interface GetPayTradeHistoryResponseDataInnerReceiverInfo
 */
interface GetPayTradeHistoryResponseDataInnerReceiverInfo {
  /**
   *
   * @type {string}
   * @memberof GetPayTradeHistoryResponseDataInnerReceiverInfo
   */
  name?: string;
  /**
   *
   * @type {string}
   * @memberof GetPayTradeHistoryResponseDataInnerReceiverInfo
   */
  type?: string;
  /**
   *
   * @type {string}
   * @memberof GetPayTradeHistoryResponseDataInnerReceiverInfo
   */
  email?: string;
  /**
   *
   * @type {string}
   * @memberof GetPayTradeHistoryResponseDataInnerReceiverInfo
   */
  binanceId?: string;
  /**
   *
   * @type {string}
   * @memberof GetPayTradeHistoryResponseDataInnerReceiverInfo
   */
  accountId?: string;
  /**
   *
   * @type {string}
   * @memberof GetPayTradeHistoryResponseDataInnerReceiverInfo
   */
  countryCode?: string;
  /**
   *
   * @type {string}
   * @memberof GetPayTradeHistoryResponseDataInnerReceiverInfo
   */
  phoneNumber?: string;
  /**
   *
   * @type {string}
   * @memberof GetPayTradeHistoryResponseDataInnerReceiverInfo
   */
  mobileCode?: string;
  /**
   *
   * @type {GetPayTradeHistoryResponseDataInnerReceiverInfoExtend}
   * @memberof GetPayTradeHistoryResponseDataInnerReceiverInfo
   */
  extend?: GetPayTradeHistoryResponseDataInnerReceiverInfoExtend;
}
//#endregion
//#region src/rest-api/types/get-pay-trade-history-response-data-inner.d.ts
/**
 *
 * @export
 * @interface GetPayTradeHistoryResponseDataInner
 */
interface GetPayTradeHistoryResponseDataInner {
  /**
   *
   * @type {string}
   * @memberof GetPayTradeHistoryResponseDataInner
   */
  orderType?: string;
  /**
   *
   * @type {string}
   * @memberof GetPayTradeHistoryResponseDataInner
   */
  transactionId?: string;
  /**
   *
   * @type {number | bigint}
   * @memberof GetPayTradeHistoryResponseDataInner
   */
  transactionTime?: number | bigint;
  /**
   *
   * @type {string}
   * @memberof GetPayTradeHistoryResponseDataInner
   */
  amount?: string;
  /**
   *
   * @type {string}
   * @memberof GetPayTradeHistoryResponseDataInner
   */
  currency?: string;
  /**
   *
   * @type {number | bigint}
   * @memberof GetPayTradeHistoryResponseDataInner
   */
  walletType?: number | bigint;
  /**
   *
   * @type {Array<number>}
   * @memberof GetPayTradeHistoryResponseDataInner
   */
  walletTypes?: Array<number>;
  /**
   *
   * @type {Array<GetPayTradeHistoryResponseDataInnerFundsDetailInner>}
   * @memberof GetPayTradeHistoryResponseDataInner
   */
  fundsDetail?: Array<GetPayTradeHistoryResponseDataInnerFundsDetailInner>;
  /**
   *
   * @type {GetPayTradeHistoryResponseDataInnerPayerInfo}
   * @memberof GetPayTradeHistoryResponseDataInner
   */
  payerInfo?: GetPayTradeHistoryResponseDataInnerPayerInfo;
  /**
   *
   * @type {GetPayTradeHistoryResponseDataInnerReceiverInfo}
   * @memberof GetPayTradeHistoryResponseDataInner
   */
  receiverInfo?: GetPayTradeHistoryResponseDataInnerReceiverInfo;
}
//#endregion
//#region src/rest-api/types/get-pay-trade-history-response.d.ts
/**
 *
 * @export
 * @interface GetPayTradeHistoryResponse
 */
interface GetPayTradeHistoryResponse {
  /**
   *
   * @type {string}
   * @memberof GetPayTradeHistoryResponse
   */
  code?: string;
  /**
   *
   * @type {string}
   * @memberof GetPayTradeHistoryResponse
   */
  message?: string;
  /**
   *
   * @type {Array<GetPayTradeHistoryResponseDataInner>}
   * @memberof GetPayTradeHistoryResponse
   */
  data?: Array<GetPayTradeHistoryResponseDataInner>;
  /**
   *
   * @type {boolean}
   * @memberof GetPayTradeHistoryResponse
   */
  success?: boolean;
}
//#endregion
//#region src/rest-api/modules/pay-api.d.ts
/**
 * PayApi - interface
 * @interface PayApi
 */
interface PayApiInterface {
  /**
   * Get Pay Trade History
   *
   * If startTime and endTime are not sent, the recent 90 days' data will be returned.
   * The max interval between startTime and endTime is 90 days.
   * Support for querying orders within the last 18 months.
   * For payerInfo and receiverInfo，there are different return values in different orderTypes.
   * Sender's perspective when orderType is C2C
   * payerInfo : binanceId
   * receiverInfo : name, binanceId/accountId/email/countryCode/phoneNumber/mobileCode (based on user input)
   * Receiver's perspective when orderType is C2C
   * payerInfo : name
   * receiverInfo : binanceId
   * Sender's perspective when orderType is CRYPTO_BOX
   * payerInfo : binanceId
   * receiverInfo : name(the value is always "Crypto Box")
   * Receiver's perspective when orderType is CRYPTO_BOX
   * payerInfo : name
   * receiverInfo : binanceId
   * Sender's perspective when orderType is PAY
   * payerInfo : binanceId
   * receiverInfo : name
   * Receiver's perspective when orderType is PAY
   * payerInfo : name
   * receiverInfo : binanceId, name
   * Sender's perspective when orderType is PAY_REFUND
   * payerInfo : binanceId, name
   * receiverInfo : name, accountId
   * Receiver's perspective when orderType is PAY_REFUND
   * payerInfo : name
   * receiverInfo :  binanceId
   * Sender's perspective when orderType is PAYOUT
   * payerInfo : binanceId, name
   * receiverInfo : name, accountId
   * Receiver's perspective when orderType is PAYOUT
   * payerInfo : name
   * receiverInfo :  binanceId
   * Receiver's perspective when orderType is CRYPTO_BOX_RF
   * payerInfo : name(the value is always "Crypto Box")
   * receiverInfo : binanceId
   * Sender's perspective when orderType is REMITTANCE
   * payerInfo : binanceId
   * receiverInfo : name, institutionName, cardNumber, digitalWalletId
   *
   * Weight: 3000
   *
   * @summary Get Pay Trade History
   * @param {GetPayTradeHistoryRequest} requestParameters Request parameters.
   *
   * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError}
   * @memberof PayApiInterface
   */
  getPayTradeHistory(requestParameters?: GetPayTradeHistoryRequest): Promise<RestApiResponse<GetPayTradeHistoryResponse>>;
}
/**
 * Request parameters for getPayTradeHistory operation in PayApi.
 * @interface GetPayTradeHistoryRequest
 */
interface GetPayTradeHistoryRequest {
  /**
   *
   * @type {number | bigint}
   * @memberof PayApiGetPayTradeHistory
   */
  readonly startTime?: number | bigint;
  /**
   *
   * @type {number | bigint}
   * @memberof PayApiGetPayTradeHistory
   */
  readonly endTime?: number | bigint;
  /**
   * default 100, max 100
   * @type {number | bigint}
   * @memberof PayApiGetPayTradeHistory
   */
  readonly limit?: number | bigint;
  /**
   *
   * @type {number | bigint}
   * @memberof PayApiGetPayTradeHistory
   */
  readonly recvWindow?: number | bigint;
}
/**
 * PayApi - object-oriented interface
 * @class PayApi
 */
declare class PayApi implements PayApiInterface {
  private readonly configuration;
  private localVarAxiosParamCreator;
  constructor(configuration: ConfigurationRestAPI);
  /**
   * Get Pay Trade History
   *
   * If startTime and endTime are not sent, the recent 90 days' data will be returned.
   * The max interval between startTime and endTime is 90 days.
   * Support for querying orders within the last 18 months.
   * For payerInfo and receiverInfo，there are different return values in different orderTypes.
   * Sender's perspective when orderType is C2C
   * payerInfo : binanceId
   * receiverInfo : name, binanceId/accountId/email/countryCode/phoneNumber/mobileCode (based on user input)
   * Receiver's perspective when orderType is C2C
   * payerInfo : name
   * receiverInfo : binanceId
   * Sender's perspective when orderType is CRYPTO_BOX
   * payerInfo : binanceId
   * receiverInfo : name(the value is always "Crypto Box")
   * Receiver's perspective when orderType is CRYPTO_BOX
   * payerInfo : name
   * receiverInfo : binanceId
   * Sender's perspective when orderType is PAY
   * payerInfo : binanceId
   * receiverInfo : name
   * Receiver's perspective when orderType is PAY
   * payerInfo : name
   * receiverInfo : binanceId, name
   * Sender's perspective when orderType is PAY_REFUND
   * payerInfo : binanceId, name
   * receiverInfo : name, accountId
   * Receiver's perspective when orderType is PAY_REFUND
   * payerInfo : name
   * receiverInfo :  binanceId
   * Sender's perspective when orderType is PAYOUT
   * payerInfo : binanceId, name
   * receiverInfo : name, accountId
   * Receiver's perspective when orderType is PAYOUT
   * payerInfo : name
   * receiverInfo :  binanceId
   * Receiver's perspective when orderType is CRYPTO_BOX_RF
   * payerInfo : name(the value is always "Crypto Box")
   * receiverInfo : binanceId
   * Sender's perspective when orderType is REMITTANCE
   * payerInfo : binanceId
   * receiverInfo : name, institutionName, cardNumber, digitalWalletId
   *
   * Weight: 3000
   *
   * @summary Get Pay Trade History
   * @param {GetPayTradeHistoryRequest} requestParameters Request parameters.
   * @returns {Promise<RestApiResponse<GetPayTradeHistoryResponse>>}
   * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError}
   * @memberof PayApi
   * @see {@link https://developers.binance.com/docs/pay/rest-api/Get-Pay-Trade-History Binance API Documentation}
   */
  getPayTradeHistory(requestParameters?: GetPayTradeHistoryRequest): Promise<RestApiResponse<GetPayTradeHistoryResponse>>;
}
//#endregion
//#region src/rest-api/rest-api.d.ts
declare class RestAPI {
  private configuration;
  private payApi;
  constructor(configuration: ConfigurationRestAPI);
  /**
   * Generic function to send a request.
   * @param endpoint - The API endpoint to call.
   * @param method - HTTP method to use (GET, POST, DELETE, etc.).
   * @param queryParams - Query parameters for the request.
   * @param bodyParams - Body parameters for the request.
   *
   * @returns A promise resolving to the response data object.
   */
  sendRequest<T>(endpoint: string, method: 'GET' | 'POST' | 'DELETE' | 'PUT' | 'PATCH', queryParams?: Record<string, unknown>, bodyParams?: Record<string, unknown>): Promise<RestApiResponse<T>>;
  /**
   * Generic function to send a signed request.
   * @param endpoint - The API endpoint to call.
   * @param method - HTTP method to use (GET, POST, DELETE, etc.).
   * @param queryParams - Query parameters for the request.
   * @param bodyParams - Body parameters for the request.
   *
   * @returns A promise resolving to the response data object.
   */
  sendSignedRequest<T>(endpoint: string, method: 'GET' | 'POST' | 'DELETE' | 'PUT' | 'PATCH', queryParams?: Record<string, unknown>, bodyParams?: Record<string, unknown>): Promise<RestApiResponse<T>>;
  /**
   * Get Pay Trade History
   *
   * If startTime and endTime are not sent, the recent 90 days' data will be returned.
   * The max interval between startTime and endTime is 90 days.
   * Support for querying orders within the last 18 months.
   * For payerInfo and receiverInfo，there are different return values in different orderTypes.
   * Sender's perspective when orderType is C2C
   * payerInfo : binanceId
   * receiverInfo : name, binanceId/accountId/email/countryCode/phoneNumber/mobileCode (based on user input)
   * Receiver's perspective when orderType is C2C
   * payerInfo : name
   * receiverInfo : binanceId
   * Sender's perspective when orderType is CRYPTO_BOX
   * payerInfo : binanceId
   * receiverInfo : name(the value is always "Crypto Box")
   * Receiver's perspective when orderType is CRYPTO_BOX
   * payerInfo : name
   * receiverInfo : binanceId
   * Sender's perspective when orderType is PAY
   * payerInfo : binanceId
   * receiverInfo : name
   * Receiver's perspective when orderType is PAY
   * payerInfo : name
   * receiverInfo : binanceId, name
   * Sender's perspective when orderType is PAY_REFUND
   * payerInfo : binanceId, name
   * receiverInfo : name, accountId
   * Receiver's perspective when orderType is PAY_REFUND
   * payerInfo : name
   * receiverInfo :  binanceId
   * Sender's perspective when orderType is PAYOUT
   * payerInfo : binanceId, name
   * receiverInfo : name, accountId
   * Receiver's perspective when orderType is PAYOUT
   * payerInfo : name
   * receiverInfo :  binanceId
   * Receiver's perspective when orderType is CRYPTO_BOX_RF
   * payerInfo : name(the value is always "Crypto Box")
   * receiverInfo : binanceId
   * Sender's perspective when orderType is REMITTANCE
   * payerInfo : binanceId
   * receiverInfo : name, institutionName, cardNumber, digitalWalletId
   *
   * Weight: 3000
   *
   * @summary Get Pay Trade History
   * @param {GetPayTradeHistoryRequest} requestParameters Request parameters.
   *
   * @returns {Promise<RestApiResponse<GetPayTradeHistoryResponse>>}
   * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError}
   * @see {@link https://developers.binance.com/docs/pay/rest-api/Get-Pay-Trade-History Binance API Documentation}
   */
  getPayTradeHistory(requestParameters?: GetPayTradeHistoryRequest): Promise<RestApiResponse<GetPayTradeHistoryResponse>>;
}
declare namespace index_d_exports {
  export { GetPayTradeHistoryRequest, GetPayTradeHistoryResponse, GetPayTradeHistoryResponseDataInner, GetPayTradeHistoryResponseDataInnerFundsDetailInner, GetPayTradeHistoryResponseDataInnerFundsDetailInnerWalletAssetCostInner, GetPayTradeHistoryResponseDataInnerPayerInfo, GetPayTradeHistoryResponseDataInnerReceiverInfo, GetPayTradeHistoryResponseDataInnerReceiverInfoExtend, PayApi, PayApiInterface, RestAPI };
}
//#endregion
//#region src/pay.d.ts
interface ConfigurationPay {
  configurationRestAPI?: ConfigurationRestAPI;
}
declare class Pay {
  restAPI: RestAPI;
  constructor(config: ConfigurationPay);
}
//#endregion
export { BadRequestError, type ConfigurationPay, ConnectorClientError, ForbiddenError, NetworkError, NotFoundError, PAY_REST_API_PROD_URL, Pay, index_d_exports as PayRestAPI, RateLimitBanError, RequiredError, ServerError, TooManyRequestsError, UnauthorizedError };
//# sourceMappingURL=index.d.mts.map