@binance/pay
Version:
Official Binance Pay Connector - A lightweight library that provides a convenient interface to Binance's Pay REST API.
653 lines (633 loc) • 21.6 kB
TypeScript
import { RestApiResponse, ConfigurationRestAPI } from '@binance/common';
export { BadRequestError, ConnectorClientError, ForbiddenError, NetworkError, NotFoundError, PAY_REST_API_PROD_URL, RateLimitBanError, RequiredError, ServerError, TooManyRequestsError, UnauthorizedError } from '@binance/common';
/**
* 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;
}
/**
* 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 GetPayTradeHistoryResponseDataInnerFundsDetailInner
*/
interface GetPayTradeHistoryResponseDataInnerFundsDetailInner {
/**
*
* @type {string}
* @memberof GetPayTradeHistoryResponseDataInnerFundsDetailInner
*/
currency?: string;
/**
*
* @type {string}
* @memberof GetPayTradeHistoryResponseDataInnerFundsDetailInner
*/
amount?: string;
/**
*
* @type {Array<GetPayTradeHistoryResponseDataInnerFundsDetailInnerWalletAssetCostInner>}
* @memberof GetPayTradeHistoryResponseDataInnerFundsDetailInner
*/
walletAssetCost?: Array<GetPayTradeHistoryResponseDataInnerFundsDetailInnerWalletAssetCostInner>;
}
/**
* 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;
/**
*
* @type {string}
* @memberof GetPayTradeHistoryResponseDataInnerPayerInfo
*/
accountId?: string;
}
/**
* 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;
}
/**
* 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 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;
}
/**
* 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 GetPayTradeHistoryResponseDataInner
*/
interface GetPayTradeHistoryResponseDataInner {
/**
*
* @type {string}
* @memberof GetPayTradeHistoryResponseDataInner
*/
orderType?: string;
/**
*
* @type {string}
* @memberof GetPayTradeHistoryResponseDataInner
*/
transactionId?: string;
/**
*
* @type {number}
* @memberof GetPayTradeHistoryResponseDataInner
*/
transactionTime?: number;
/**
*
* @type {string}
* @memberof GetPayTradeHistoryResponseDataInner
*/
amount?: string;
/**
*
* @type {string}
* @memberof GetPayTradeHistoryResponseDataInner
*/
currency?: string;
/**
*
* @type {number}
* @memberof GetPayTradeHistoryResponseDataInner
*/
walletType?: number;
/**
*
* @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;
}
/**
* 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 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;
}
/**
* 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.
*/
/**
* 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, accountId
* 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, accountId
* receiverInfo : binanceId
* Sender's perspective when orderType is PAY
* payerInfo : binanceId
* receiverInfo : name
* Receiver's perspective when orderType is PAY
* payerInfo : name, accountId
* 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}
* @memberof PayApiGetPayTradeHistory
*/
readonly startTime?: number;
/**
*
* @type {number}
* @memberof PayApiGetPayTradeHistory
*/
readonly endTime?: number;
/**
* default 100, max 100
* @type {number}
* @memberof PayApiGetPayTradeHistory
*/
readonly limit?: number;
/**
*
* @type {number}
* @memberof PayApiGetPayTradeHistory
*/
readonly recvWindow?: number;
}
/**
* 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, accountId
* 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, accountId
* receiverInfo : binanceId
* Sender's perspective when orderType is PAY
* payerInfo : binanceId
* receiverInfo : name
* Receiver's perspective when orderType is PAY
* payerInfo : name, accountId
* 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>>;
}
/**
* 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.
*/
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 params - Query parameters for the request.
*
* @returns A promise resolving to the response data object.
*/
sendRequest<T>(endpoint: string, method: 'GET' | 'POST' | 'DELETE' | 'PUT' | 'PATCH', params?: 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 params - Query parameters for the request.
*
* @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>>;
/**
* 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, accountId
* 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, accountId
* receiverInfo : binanceId
* Sender's perspective when orderType is PAY
* payerInfo : binanceId
* receiverInfo : name
* Receiver's perspective when orderType is PAY
* payerInfo : name, accountId
* 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>>;
}
/**
* 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.
*/
type index_GetPayTradeHistoryRequest = GetPayTradeHistoryRequest;
type index_GetPayTradeHistoryResponse = GetPayTradeHistoryResponse;
type index_GetPayTradeHistoryResponseDataInner = GetPayTradeHistoryResponseDataInner;
type index_GetPayTradeHistoryResponseDataInnerFundsDetailInner = GetPayTradeHistoryResponseDataInnerFundsDetailInner;
type index_GetPayTradeHistoryResponseDataInnerFundsDetailInnerWalletAssetCostInner = GetPayTradeHistoryResponseDataInnerFundsDetailInnerWalletAssetCostInner;
type index_GetPayTradeHistoryResponseDataInnerPayerInfo = GetPayTradeHistoryResponseDataInnerPayerInfo;
type index_GetPayTradeHistoryResponseDataInnerReceiverInfo = GetPayTradeHistoryResponseDataInnerReceiverInfo;
type index_GetPayTradeHistoryResponseDataInnerReceiverInfoExtend = GetPayTradeHistoryResponseDataInnerReceiverInfoExtend;
type index_PayApi = PayApi;
declare const index_PayApi: typeof PayApi;
type index_PayApiInterface = PayApiInterface;
type index_RestAPI = RestAPI;
declare const index_RestAPI: typeof RestAPI;
declare namespace index {
export { type index_GetPayTradeHistoryRequest as GetPayTradeHistoryRequest, type index_GetPayTradeHistoryResponse as GetPayTradeHistoryResponse, type index_GetPayTradeHistoryResponseDataInner as GetPayTradeHistoryResponseDataInner, type index_GetPayTradeHistoryResponseDataInnerFundsDetailInner as GetPayTradeHistoryResponseDataInnerFundsDetailInner, type index_GetPayTradeHistoryResponseDataInnerFundsDetailInnerWalletAssetCostInner as GetPayTradeHistoryResponseDataInnerFundsDetailInnerWalletAssetCostInner, type index_GetPayTradeHistoryResponseDataInnerPayerInfo as GetPayTradeHistoryResponseDataInnerPayerInfo, type index_GetPayTradeHistoryResponseDataInnerReceiverInfo as GetPayTradeHistoryResponseDataInnerReceiverInfo, type index_GetPayTradeHistoryResponseDataInnerReceiverInfoExtend as GetPayTradeHistoryResponseDataInnerReceiverInfoExtend, index_PayApi as PayApi, type index_PayApiInterface as PayApiInterface, index_RestAPI as RestAPI };
}
interface ConfigurationPay {
configurationRestAPI?: ConfigurationRestAPI;
}
declare class Pay {
restAPI: RestAPI;
constructor(config: ConfigurationPay);
}
export { type ConfigurationPay, Pay, index as PayRestAPI };