@binance/pay 1.0.0

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.mjs ADDED
@@ -0,0 +1,319 @@
1
+ var __defProp = Object.defineProperty;
2
+ var __export = (target, all) => {
3
+ for (var name2 in all)
4
+ __defProp(target, name2, { get: all[name2], enumerable: true });
5
+ };
6
+
7
+ // src/pay.ts
8
+ import { platform, arch } from "os";
9
+ import { ConfigurationRestAPI as ConfigurationRestAPI3, PAY_REST_API_PROD_URL } from "@binance/common";
10
+
11
+ // package.json
12
+ var name = "@binance/pay";
13
+ var version = "1.0.0";
14
+
15
+ // src/rest-api/index.ts
16
+ var rest_api_exports = {};
17
+ __export(rest_api_exports, {
18
+ PayApi: () => PayApi,
19
+ RestAPI: () => RestAPI
20
+ });
21
+
22
+ // src/rest-api/modules/pay-api.ts
23
+ import {
24
+ sendRequest
25
+ } from "@binance/common";
26
+ var PayApiAxiosParamCreator = function(configuration) {
27
+ return {
28
+ /**
29
+ * Get Pay Trade History
30
+ *
31
+ * If startTime and endTime are not sent, the recent 90 days' data will be returned.
32
+ * The max interval between startTime and endTime is 90 days.
33
+ * Support for querying orders within the last 18 months.
34
+ * For payerInfo and receiverInfo,there are different return values in different orderTypes.
35
+ * Sender's perspective when orderType is C2C
36
+ * payerInfo : binanceId
37
+ * receiverInfo : name, binanceId/accountId/email/countryCode/phoneNumber/mobileCode (based on user input)
38
+ * Receiver's perspective when orderType is C2C
39
+ * payerInfo : name, accountId
40
+ * receiverInfo : binanceId
41
+ * Sender's perspective when orderType is CRYPTO_BOX
42
+ * payerInfo : binanceId
43
+ * receiverInfo : name(the value is always "Crypto Box")
44
+ * Receiver's perspective when orderType is CRYPTO_BOX
45
+ * payerInfo : name, accountId
46
+ * receiverInfo : binanceId
47
+ * Sender's perspective when orderType is PAY
48
+ * payerInfo : binanceId
49
+ * receiverInfo : name
50
+ * Receiver's perspective when orderType is PAY
51
+ * payerInfo : name, accountId
52
+ * receiverInfo : binanceId, name
53
+ * Sender's perspective when orderType is PAY_REFUND
54
+ * payerInfo : binanceId, name
55
+ * receiverInfo : name, accountId
56
+ * Receiver's perspective when orderType is PAY_REFUND
57
+ * payerInfo : name
58
+ * receiverInfo : binanceId
59
+ * Sender's perspective when orderType is PAYOUT
60
+ * payerInfo : binanceId, name
61
+ * receiverInfo : name, accountId
62
+ * Receiver's perspective when orderType is PAYOUT
63
+ * payerInfo : name
64
+ * receiverInfo : binanceId
65
+ * Receiver's perspective when orderType is CRYPTO_BOX_RF
66
+ * payerInfo : name(the value is always "Crypto Box")
67
+ * receiverInfo : binanceId
68
+ * Sender's perspective when orderType is REMITTANCE
69
+ * payerInfo : binanceId
70
+ * receiverInfo : name, institutionName, cardNumber, digitalWalletId
71
+ *
72
+ * Weight: 3000
73
+ *
74
+ * @summary Get Pay Trade History
75
+ * @param {number} [startTime]
76
+ * @param {number} [endTime]
77
+ * @param {number} [limit] default 100, max 100
78
+ * @param {number} [recvWindow]
79
+ *
80
+ * @throws {RequiredError}
81
+ */
82
+ getPayTradeHistory: async (startTime, endTime, limit, recvWindow) => {
83
+ const localVarQueryParameter = {};
84
+ if (startTime !== void 0 && startTime !== null) {
85
+ localVarQueryParameter["startTime"] = startTime;
86
+ }
87
+ if (endTime !== void 0 && endTime !== null) {
88
+ localVarQueryParameter["endTime"] = endTime;
89
+ }
90
+ if (limit !== void 0 && limit !== null) {
91
+ localVarQueryParameter["limit"] = limit;
92
+ }
93
+ if (recvWindow !== void 0 && recvWindow !== null) {
94
+ localVarQueryParameter["recvWindow"] = recvWindow;
95
+ }
96
+ let _timeUnit;
97
+ if ("timeUnit" in configuration)
98
+ _timeUnit = configuration.timeUnit;
99
+ return {
100
+ endpoint: "/sapi/v1/pay/transactions",
101
+ method: "GET",
102
+ params: localVarQueryParameter,
103
+ timeUnit: _timeUnit
104
+ };
105
+ }
106
+ };
107
+ };
108
+ var PayApi = class {
109
+ constructor(configuration) {
110
+ this.configuration = configuration;
111
+ this.localVarAxiosParamCreator = PayApiAxiosParamCreator(configuration);
112
+ }
113
+ /**
114
+ * Get Pay Trade History
115
+ *
116
+ * If startTime and endTime are not sent, the recent 90 days' data will be returned.
117
+ * The max interval between startTime and endTime is 90 days.
118
+ * Support for querying orders within the last 18 months.
119
+ * For payerInfo and receiverInfo,there are different return values in different orderTypes.
120
+ * Sender's perspective when orderType is C2C
121
+ * payerInfo : binanceId
122
+ * receiverInfo : name, binanceId/accountId/email/countryCode/phoneNumber/mobileCode (based on user input)
123
+ * Receiver's perspective when orderType is C2C
124
+ * payerInfo : name, accountId
125
+ * receiverInfo : binanceId
126
+ * Sender's perspective when orderType is CRYPTO_BOX
127
+ * payerInfo : binanceId
128
+ * receiverInfo : name(the value is always "Crypto Box")
129
+ * Receiver's perspective when orderType is CRYPTO_BOX
130
+ * payerInfo : name, accountId
131
+ * receiverInfo : binanceId
132
+ * Sender's perspective when orderType is PAY
133
+ * payerInfo : binanceId
134
+ * receiverInfo : name
135
+ * Receiver's perspective when orderType is PAY
136
+ * payerInfo : name, accountId
137
+ * receiverInfo : binanceId, name
138
+ * Sender's perspective when orderType is PAY_REFUND
139
+ * payerInfo : binanceId, name
140
+ * receiverInfo : name, accountId
141
+ * Receiver's perspective when orderType is PAY_REFUND
142
+ * payerInfo : name
143
+ * receiverInfo : binanceId
144
+ * Sender's perspective when orderType is PAYOUT
145
+ * payerInfo : binanceId, name
146
+ * receiverInfo : name, accountId
147
+ * Receiver's perspective when orderType is PAYOUT
148
+ * payerInfo : name
149
+ * receiverInfo : binanceId
150
+ * Receiver's perspective when orderType is CRYPTO_BOX_RF
151
+ * payerInfo : name(the value is always "Crypto Box")
152
+ * receiverInfo : binanceId
153
+ * Sender's perspective when orderType is REMITTANCE
154
+ * payerInfo : binanceId
155
+ * receiverInfo : name, institutionName, cardNumber, digitalWalletId
156
+ *
157
+ * Weight: 3000
158
+ *
159
+ * @summary Get Pay Trade History
160
+ * @param {GetPayTradeHistoryRequest} requestParameters Request parameters.
161
+ * @returns {Promise<RestApiResponse<GetPayTradeHistoryResponse>>}
162
+ * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError}
163
+ * @memberof PayApi
164
+ * @see {@link https://developers.binance.com/docs/pay/rest-api/Get-Pay-Trade-History Binance API Documentation}
165
+ */
166
+ async getPayTradeHistory(requestParameters = {}) {
167
+ const localVarAxiosArgs = await this.localVarAxiosParamCreator.getPayTradeHistory(
168
+ requestParameters?.startTime,
169
+ requestParameters?.endTime,
170
+ requestParameters?.limit,
171
+ requestParameters?.recvWindow
172
+ );
173
+ return sendRequest(
174
+ this.configuration,
175
+ localVarAxiosArgs.endpoint,
176
+ localVarAxiosArgs.method,
177
+ localVarAxiosArgs.params,
178
+ localVarAxiosArgs?.timeUnit,
179
+ { isSigned: false }
180
+ );
181
+ }
182
+ };
183
+
184
+ // src/rest-api/rest-api.ts
185
+ import { sendRequest as sendRequest2 } from "@binance/common";
186
+ var RestAPI = class {
187
+ constructor(configuration) {
188
+ this.configuration = configuration;
189
+ this.payApi = new PayApi(configuration);
190
+ }
191
+ /**
192
+ * Generic function to send a request.
193
+ * @param endpoint - The API endpoint to call.
194
+ * @param method - HTTP method to use (GET, POST, DELETE, etc.).
195
+ * @param params - Query parameters for the request.
196
+ *
197
+ * @returns A promise resolving to the response data object.
198
+ */
199
+ sendRequest(endpoint, method, params = {}) {
200
+ return sendRequest2(this.configuration, endpoint, method, params, void 0);
201
+ }
202
+ /**
203
+ * Generic function to send a signed request.
204
+ * @param endpoint - The API endpoint to call.
205
+ * @param method - HTTP method to use (GET, POST, DELETE, etc.).
206
+ * @param params - Query parameters for the request.
207
+ *
208
+ * @returns A promise resolving to the response data object.
209
+ */
210
+ sendSignedRequest(endpoint, method, params = {}) {
211
+ return sendRequest2(this.configuration, endpoint, method, params, void 0, {
212
+ isSigned: true
213
+ });
214
+ }
215
+ /**
216
+ * Get Pay Trade History
217
+ *
218
+ * If startTime and endTime are not sent, the recent 90 days' data will be returned.
219
+ * The max interval between startTime and endTime is 90 days.
220
+ * Support for querying orders within the last 18 months.
221
+ * For payerInfo and receiverInfo,there are different return values in different orderTypes.
222
+ * Sender's perspective when orderType is C2C
223
+ * payerInfo : binanceId
224
+ * receiverInfo : name, binanceId/accountId/email/countryCode/phoneNumber/mobileCode (based on user input)
225
+ * Receiver's perspective when orderType is C2C
226
+ * payerInfo : name, accountId
227
+ * receiverInfo : binanceId
228
+ * Sender's perspective when orderType is CRYPTO_BOX
229
+ * payerInfo : binanceId
230
+ * receiverInfo : name(the value is always "Crypto Box")
231
+ * Receiver's perspective when orderType is CRYPTO_BOX
232
+ * payerInfo : name, accountId
233
+ * receiverInfo : binanceId
234
+ * Sender's perspective when orderType is PAY
235
+ * payerInfo : binanceId
236
+ * receiverInfo : name
237
+ * Receiver's perspective when orderType is PAY
238
+ * payerInfo : name, accountId
239
+ * receiverInfo : binanceId, name
240
+ * Sender's perspective when orderType is PAY_REFUND
241
+ * payerInfo : binanceId, name
242
+ * receiverInfo : name, accountId
243
+ * Receiver's perspective when orderType is PAY_REFUND
244
+ * payerInfo : name
245
+ * receiverInfo : binanceId
246
+ * Sender's perspective when orderType is PAYOUT
247
+ * payerInfo : binanceId, name
248
+ * receiverInfo : name, accountId
249
+ * Receiver's perspective when orderType is PAYOUT
250
+ * payerInfo : name
251
+ * receiverInfo : binanceId
252
+ * Receiver's perspective when orderType is CRYPTO_BOX_RF
253
+ * payerInfo : name(the value is always "Crypto Box")
254
+ * receiverInfo : binanceId
255
+ * Sender's perspective when orderType is REMITTANCE
256
+ * payerInfo : binanceId
257
+ * receiverInfo : name, institutionName, cardNumber, digitalWalletId
258
+ *
259
+ * Weight: 3000
260
+ *
261
+ * @summary Get Pay Trade History
262
+ * @param {GetPayTradeHistoryRequest} requestParameters Request parameters.
263
+ * @returns {Promise<RestApiResponse<GetPayTradeHistoryResponse>>}
264
+ * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError}
265
+ * @see {@link https://developers.binance.com/docs/pay/rest-api/Get-Pay-Trade-History Binance API Documentation}
266
+ */
267
+ getPayTradeHistory(requestParameters = {}) {
268
+ return this.payApi.getPayTradeHistory(requestParameters);
269
+ }
270
+ };
271
+
272
+ // src/pay.ts
273
+ var Pay = class {
274
+ constructor(config) {
275
+ if (config?.configurationRestAPI) {
276
+ const configRestAPI = new ConfigurationRestAPI3(config.configurationRestAPI);
277
+ configRestAPI.basePath = configRestAPI.basePath || PAY_REST_API_PROD_URL;
278
+ configRestAPI.baseOptions = configRestAPI.baseOptions || {};
279
+ configRestAPI.baseOptions.headers = {
280
+ ...configRestAPI.baseOptions.headers || {},
281
+ "User-Agent": `${name}/${version} (Node.js/${process.version}; ${platform()}; ${arch()})`
282
+ };
283
+ this.restAPI = new RestAPI(configRestAPI);
284
+ }
285
+ }
286
+ };
287
+
288
+ // src/index.ts
289
+ import {
290
+ PAY_REST_API_PROD_URL as PAY_REST_API_PROD_URL2,
291
+ PAY_REST_API_TESTNET_URL,
292
+ ConnectorClientError,
293
+ RequiredError,
294
+ UnauthorizedError,
295
+ ForbiddenError,
296
+ TooManyRequestsError,
297
+ RateLimitBanError,
298
+ ServerError,
299
+ NetworkError,
300
+ NotFoundError,
301
+ BadRequestError
302
+ } from "@binance/common";
303
+ export {
304
+ BadRequestError,
305
+ ConnectorClientError,
306
+ ForbiddenError,
307
+ NetworkError,
308
+ NotFoundError,
309
+ PAY_REST_API_PROD_URL2 as PAY_REST_API_PROD_URL,
310
+ PAY_REST_API_TESTNET_URL,
311
+ Pay,
312
+ rest_api_exports as PayRestAPI,
313
+ RateLimitBanError,
314
+ RequiredError,
315
+ ServerError,
316
+ TooManyRequestsError,
317
+ UnauthorizedError
318
+ };
319
+ //# sourceMappingURL=index.mjs.map
@@ -0,0 +1 @@
1
+ {"version":3,"sources":["../src/pay.ts","../package.json","../src/rest-api/index.ts","../src/rest-api/modules/pay-api.ts","../src/rest-api/rest-api.ts","../src/index.ts"],"sourcesContent":["import { platform, arch } from 'os';\nimport { ConfigurationRestAPI, PAY_REST_API_PROD_URL } from '@binance/common';\nimport { name, version } from '../package.json';\nimport { RestAPI } from './rest-api';\n\nexport interface ConfigurationPay {\n configurationRestAPI?: ConfigurationRestAPI;\n}\n\nexport class Pay {\n public restAPI!: RestAPI;\n\n constructor(config: ConfigurationPay) {\n if (config?.configurationRestAPI) {\n const configRestAPI = new ConfigurationRestAPI(config.configurationRestAPI);\n configRestAPI.basePath = configRestAPI.basePath || PAY_REST_API_PROD_URL;\n configRestAPI.baseOptions = configRestAPI.baseOptions || {};\n configRestAPI.baseOptions.headers = {\n ...(configRestAPI.baseOptions.headers || {}),\n 'User-Agent': `${name}/${version} (Node.js/${process.version}; ${platform()}; ${arch()})`,\n };\n this.restAPI = new RestAPI(configRestAPI);\n }\n }\n}\n","{\n \"name\": \"@binance/pay\",\n \"description\": \"Official Binance Pay Connector - A lightweight library that provides a convenient interface to Binance's Pay REST API.\",\n \"version\": \"1.0.0\",\n \"main\": \"./dist/index.js\",\n \"module\": \"./dist/index.mjs\",\n \"types\": \"./dist/index.d.ts\",\n \"scripts\": {\n \"prepublishOnly\": \"npm run build\",\n \"build\": \"tsup\",\n \"typecheck\": \"tsc --noEmit\",\n \"clean\": \"rm -rf dist\",\n \"test\": \"npx jest --maxWorkers=4 --bail\",\n \"test:watch\": \"npx jest --watch\",\n \"format\": \"npx prettier --ignore-path .prettierignore --write .\",\n \"lint\": \"npx eslint '**/*.ts' --fix\"\n },\n \"keywords\": [\n \"Binance\",\n \"API\",\n \"Simple Earn\",\n \"Connector\",\n \"REST\",\n \"Trading\"\n ],\n \"author\": \"Binance\",\n \"license\": \"MIT\",\n \"repository\": {\n \"type\": \"git\",\n \"url\": \"https://github.com/binance/binance-connector-js.git\"\n },\n \"bugs\": {\n \"url\": \"https://github.com/binance/binance-connector-js/issues\"\n },\n \"homepage\": \"https://github.com/binance/binance-connector-js#readme\",\n \"files\": [\n \"dist\"\n ],\n \"devDependencies\": {\n \"@types/jest\": \"^29.5.4\",\n \"@types/node\": \"^20.17.24\",\n \"eslint\": \"8.57.0\",\n \"jest\": \"^29.6.4\",\n \"prettier\": \"^3.3.3\",\n \"ts-jest\": \"^29.1.1\",\n \"ts-node\": \"^10.9.1\",\n \"tsup\": \"^7.2.0\",\n \"typescript\": \"^5.7.2\",\n \"typescript-eslint\": \"^8.24.0\"\n },\n \"dependencies\": {\n \"@binance/common\": \"1.0.0\",\n \"axios\": \"^1.7.4\"\n }\n}\n","/**\n * Binance Public Pay REST API\n *\n * OpenAPI Specification for the Binance Public Pay REST API\n *\n * The version of the OpenAPI document: 1.0.0\n *\n *\n * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).\n * https://openapi-generator.tech\n * Do not edit the class manually.\n */\n\nexport * from './types';\nexport * from './modules';\nexport * from './rest-api';\n","/**\n * Binance Public Pay REST API\n *\n * OpenAPI Specification for the Binance Public Pay REST API\n *\n * The version of the OpenAPI document: 1.0.0\n *\n *\n * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).\n * https://openapi-generator.tech\n * Do not edit the class manually.\n */\n\nimport {\n ConfigurationRestAPI,\n TimeUnit,\n RestApiResponse,\n sendRequest,\n type RequestArgs,\n} from '@binance/common';\nimport type { GetPayTradeHistoryResponse } from '../types';\n\n/**\n * PayApi - axios parameter creator\n */\nconst PayApiAxiosParamCreator = function (configuration: ConfigurationRestAPI) {\n return {\n /**\n * Get Pay Trade History\n *\n * If startTime and endTime are not sent, the recent 90 days' data will be returned.\n * The max interval between startTime and endTime is 90 days.\n * Support for querying orders within the last 18 months.\n * For payerInfo and receiverInfo,there are different return values in different orderTypes.\n * Sender's perspective when orderType is C2C\n * payerInfo : binanceId\n * receiverInfo : name, binanceId/accountId/email/countryCode/phoneNumber/mobileCode (based on user input)\n * Receiver's perspective when orderType is C2C\n * payerInfo : name, accountId\n * receiverInfo : binanceId\n * Sender's perspective when orderType is CRYPTO_BOX\n * payerInfo : binanceId\n * receiverInfo : name(the value is always \"Crypto Box\")\n * Receiver's perspective when orderType is CRYPTO_BOX\n * payerInfo : name, accountId\n * receiverInfo : binanceId\n * Sender's perspective when orderType is PAY\n * payerInfo : binanceId\n * receiverInfo : name\n * Receiver's perspective when orderType is PAY\n * payerInfo : name, accountId\n * receiverInfo : binanceId, name\n * Sender's perspective when orderType is PAY_REFUND\n * payerInfo : binanceId, name\n * receiverInfo : name, accountId\n * Receiver's perspective when orderType is PAY_REFUND\n * payerInfo : name\n * receiverInfo : binanceId\n * Sender's perspective when orderType is PAYOUT\n * payerInfo : binanceId, name\n * receiverInfo : name, accountId\n * Receiver's perspective when orderType is PAYOUT\n * payerInfo : name\n * receiverInfo : binanceId\n * Receiver's perspective when orderType is CRYPTO_BOX_RF\n * payerInfo : name(the value is always \"Crypto Box\")\n * receiverInfo : binanceId\n * Sender's perspective when orderType is REMITTANCE\n * payerInfo : binanceId\n * receiverInfo : name, institutionName, cardNumber, digitalWalletId\n *\n * Weight: 3000\n *\n * @summary Get Pay Trade History\n * @param {number} [startTime]\n * @param {number} [endTime]\n * @param {number} [limit] default 100, max 100\n * @param {number} [recvWindow]\n *\n * @throws {RequiredError}\n */\n getPayTradeHistory: async (\n startTime?: number,\n endTime?: number,\n limit?: number,\n recvWindow?: number\n ): Promise<RequestArgs> => {\n const localVarQueryParameter: Record<string, unknown> = {};\n\n if (startTime !== undefined && startTime !== null) {\n localVarQueryParameter['startTime'] = startTime;\n }\n\n if (endTime !== undefined && endTime !== null) {\n localVarQueryParameter['endTime'] = endTime;\n }\n\n if (limit !== undefined && limit !== null) {\n localVarQueryParameter['limit'] = limit;\n }\n\n if (recvWindow !== undefined && recvWindow !== null) {\n localVarQueryParameter['recvWindow'] = recvWindow;\n }\n\n let _timeUnit: TimeUnit | undefined;\n if ('timeUnit' in configuration) _timeUnit = configuration.timeUnit as TimeUnit;\n\n return {\n endpoint: '/sapi/v1/pay/transactions',\n method: 'GET',\n params: localVarQueryParameter,\n timeUnit: _timeUnit,\n };\n },\n };\n};\n\n/**\n * PayApi - interface\n * @interface PayApi\n */\nexport interface PayApiInterface {\n /**\n * Get Pay Trade History\n *\n * If startTime and endTime are not sent, the recent 90 days' data will be returned.\n * The max interval between startTime and endTime is 90 days.\n * Support for querying orders within the last 18 months.\n * For payerInfo and receiverInfo,there are different return values in different orderTypes.\n * Sender's perspective when orderType is C2C\n * payerInfo : binanceId\n * receiverInfo : name, binanceId/accountId/email/countryCode/phoneNumber/mobileCode (based on user input)\n * Receiver's perspective when orderType is C2C\n * payerInfo : name, accountId\n * receiverInfo : binanceId\n * Sender's perspective when orderType is CRYPTO_BOX\n * payerInfo : binanceId\n * receiverInfo : name(the value is always \"Crypto Box\")\n * Receiver's perspective when orderType is CRYPTO_BOX\n * payerInfo : name, accountId\n * receiverInfo : binanceId\n * Sender's perspective when orderType is PAY\n * payerInfo : binanceId\n * receiverInfo : name\n * Receiver's perspective when orderType is PAY\n * payerInfo : name, accountId\n * receiverInfo : binanceId, name\n * Sender's perspective when orderType is PAY_REFUND\n * payerInfo : binanceId, name\n * receiverInfo : name, accountId\n * Receiver's perspective when orderType is PAY_REFUND\n * payerInfo : name\n * receiverInfo : binanceId\n * Sender's perspective when orderType is PAYOUT\n * payerInfo : binanceId, name\n * receiverInfo : name, accountId\n * Receiver's perspective when orderType is PAYOUT\n * payerInfo : name\n * receiverInfo : binanceId\n * Receiver's perspective when orderType is CRYPTO_BOX_RF\n * payerInfo : name(the value is always \"Crypto Box\")\n * receiverInfo : binanceId\n * Sender's perspective when orderType is REMITTANCE\n * payerInfo : binanceId\n * receiverInfo : name, institutionName, cardNumber, digitalWalletId\n *\n * Weight: 3000\n *\n * @summary Get Pay Trade History\n * @param {GetPayTradeHistoryRequest} requestParameters Request parameters.\n *\n * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError}\n * @memberof PayApiInterface\n */\n getPayTradeHistory(\n requestParameters?: GetPayTradeHistoryRequest\n ): Promise<RestApiResponse<GetPayTradeHistoryResponse>>;\n}\n\n/**\n * Request parameters for getPayTradeHistory operation in PayApi.\n * @interface GetPayTradeHistoryRequest\n */\nexport interface GetPayTradeHistoryRequest {\n /**\n *\n * @type {number}\n * @memberof PayApiGetPayTradeHistory\n */\n readonly startTime?: number;\n\n /**\n *\n * @type {number}\n * @memberof PayApiGetPayTradeHistory\n */\n readonly endTime?: number;\n\n /**\n * default 100, max 100\n * @type {number}\n * @memberof PayApiGetPayTradeHistory\n */\n readonly limit?: number;\n\n /**\n *\n * @type {number}\n * @memberof PayApiGetPayTradeHistory\n */\n readonly recvWindow?: number;\n}\n\n/**\n * PayApi - object-oriented interface\n * @class PayApi\n */\nexport class PayApi implements PayApiInterface {\n private readonly configuration: ConfigurationRestAPI;\n private localVarAxiosParamCreator;\n\n constructor(configuration: ConfigurationRestAPI) {\n this.configuration = configuration;\n this.localVarAxiosParamCreator = PayApiAxiosParamCreator(configuration);\n }\n\n /**\n * Get Pay Trade History\n *\n * If startTime and endTime are not sent, the recent 90 days' data will be returned.\n * The max interval between startTime and endTime is 90 days.\n * Support for querying orders within the last 18 months.\n * For payerInfo and receiverInfo,there are different return values in different orderTypes.\n * Sender's perspective when orderType is C2C\n * payerInfo : binanceId\n * receiverInfo : name, binanceId/accountId/email/countryCode/phoneNumber/mobileCode (based on user input)\n * Receiver's perspective when orderType is C2C\n * payerInfo : name, accountId\n * receiverInfo : binanceId\n * Sender's perspective when orderType is CRYPTO_BOX\n * payerInfo : binanceId\n * receiverInfo : name(the value is always \"Crypto Box\")\n * Receiver's perspective when orderType is CRYPTO_BOX\n * payerInfo : name, accountId\n * receiverInfo : binanceId\n * Sender's perspective when orderType is PAY\n * payerInfo : binanceId\n * receiverInfo : name\n * Receiver's perspective when orderType is PAY\n * payerInfo : name, accountId\n * receiverInfo : binanceId, name\n * Sender's perspective when orderType is PAY_REFUND\n * payerInfo : binanceId, name\n * receiverInfo : name, accountId\n * Receiver's perspective when orderType is PAY_REFUND\n * payerInfo : name\n * receiverInfo : binanceId\n * Sender's perspective when orderType is PAYOUT\n * payerInfo : binanceId, name\n * receiverInfo : name, accountId\n * Receiver's perspective when orderType is PAYOUT\n * payerInfo : name\n * receiverInfo : binanceId\n * Receiver's perspective when orderType is CRYPTO_BOX_RF\n * payerInfo : name(the value is always \"Crypto Box\")\n * receiverInfo : binanceId\n * Sender's perspective when orderType is REMITTANCE\n * payerInfo : binanceId\n * receiverInfo : name, institutionName, cardNumber, digitalWalletId\n *\n * Weight: 3000\n *\n * @summary Get Pay Trade History\n * @param {GetPayTradeHistoryRequest} requestParameters Request parameters.\n * @returns {Promise<RestApiResponse<GetPayTradeHistoryResponse>>}\n * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError}\n * @memberof PayApi\n * @see {@link https://developers.binance.com/docs/pay/rest-api/Get-Pay-Trade-History Binance API Documentation}\n */\n public async getPayTradeHistory(\n requestParameters: GetPayTradeHistoryRequest = {}\n ): Promise<RestApiResponse<GetPayTradeHistoryResponse>> {\n const localVarAxiosArgs = await this.localVarAxiosParamCreator.getPayTradeHistory(\n requestParameters?.startTime,\n requestParameters?.endTime,\n requestParameters?.limit,\n requestParameters?.recvWindow\n );\n return sendRequest<GetPayTradeHistoryResponse>(\n this.configuration,\n localVarAxiosArgs.endpoint,\n localVarAxiosArgs.method,\n localVarAxiosArgs.params,\n localVarAxiosArgs?.timeUnit,\n { isSigned: false }\n );\n }\n}\n","/**\n * Binance Public Pay REST API\n *\n * OpenAPI Specification for the Binance Public Pay REST API\n *\n * The version of the OpenAPI document: 1.0.0\n *\n *\n * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).\n * https://openapi-generator.tech\n * Do not edit the class manually.\n */\n\nimport { ConfigurationRestAPI, RestApiResponse, sendRequest } from '@binance/common';\nimport { PayApi } from './modules/pay-api';\n\nimport type { GetPayTradeHistoryRequest } from './modules/pay-api';\n\nimport type { GetPayTradeHistoryResponse } from './types';\n\nexport class RestAPI {\n private configuration: ConfigurationRestAPI;\n private payApi: PayApi;\n\n constructor(configuration: ConfigurationRestAPI) {\n this.configuration = configuration;\n this.payApi = new PayApi(configuration);\n }\n\n /**\n * Generic function to send a request.\n * @param endpoint - The API endpoint to call.\n * @param method - HTTP method to use (GET, POST, DELETE, etc.).\n * @param params - Query parameters for the request.\n *\n * @returns A promise resolving to the response data object.\n */\n sendRequest<T>(\n endpoint: string,\n method: 'GET' | 'POST' | 'DELETE' | 'PUT' | 'PATCH',\n params: Record<string, unknown> = {}\n ): Promise<RestApiResponse<T>> {\n return sendRequest<T>(this.configuration, endpoint, method, params, undefined);\n }\n\n /**\n * Generic function to send a signed request.\n * @param endpoint - The API endpoint to call.\n * @param method - HTTP method to use (GET, POST, DELETE, etc.).\n * @param params - Query parameters for the request.\n *\n * @returns A promise resolving to the response data object.\n */\n sendSignedRequest<T>(\n endpoint: string,\n method: 'GET' | 'POST' | 'DELETE' | 'PUT' | 'PATCH',\n params: Record<string, unknown> = {}\n ): Promise<RestApiResponse<T>> {\n return sendRequest<T>(this.configuration, endpoint, method, params, undefined, {\n isSigned: true,\n });\n }\n\n /**\n * Get Pay Trade History\n *\n * If startTime and endTime are not sent, the recent 90 days' data will be returned.\n * The max interval between startTime and endTime is 90 days.\n * Support for querying orders within the last 18 months.\n * For payerInfo and receiverInfo,there are different return values in different orderTypes.\n * Sender's perspective when orderType is C2C\n * payerInfo : binanceId\n * receiverInfo : name, binanceId/accountId/email/countryCode/phoneNumber/mobileCode (based on user input)\n * Receiver's perspective when orderType is C2C\n * payerInfo : name, accountId\n * receiverInfo : binanceId\n * Sender's perspective when orderType is CRYPTO_BOX\n * payerInfo : binanceId\n * receiverInfo : name(the value is always \"Crypto Box\")\n * Receiver's perspective when orderType is CRYPTO_BOX\n * payerInfo : name, accountId\n * receiverInfo : binanceId\n * Sender's perspective when orderType is PAY\n * payerInfo : binanceId\n * receiverInfo : name\n * Receiver's perspective when orderType is PAY\n * payerInfo : name, accountId\n * receiverInfo : binanceId, name\n * Sender's perspective when orderType is PAY_REFUND\n * payerInfo : binanceId, name\n * receiverInfo : name, accountId\n * Receiver's perspective when orderType is PAY_REFUND\n * payerInfo : name\n * receiverInfo : binanceId\n * Sender's perspective when orderType is PAYOUT\n * payerInfo : binanceId, name\n * receiverInfo : name, accountId\n * Receiver's perspective when orderType is PAYOUT\n * payerInfo : name\n * receiverInfo : binanceId\n * Receiver's perspective when orderType is CRYPTO_BOX_RF\n * payerInfo : name(the value is always \"Crypto Box\")\n * receiverInfo : binanceId\n * Sender's perspective when orderType is REMITTANCE\n * payerInfo : binanceId\n * receiverInfo : name, institutionName, cardNumber, digitalWalletId\n *\n * Weight: 3000\n *\n * @summary Get Pay Trade History\n * @param {GetPayTradeHistoryRequest} requestParameters Request parameters.\n * @returns {Promise<RestApiResponse<GetPayTradeHistoryResponse>>}\n * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError}\n * @see {@link https://developers.binance.com/docs/pay/rest-api/Get-Pay-Trade-History Binance API Documentation}\n */\n getPayTradeHistory(\n requestParameters: GetPayTradeHistoryRequest = {}\n ): Promise<RestApiResponse<GetPayTradeHistoryResponse>> {\n return this.payApi.getPayTradeHistory(requestParameters);\n }\n}\n","export { Pay, ConfigurationPay } from './pay';\nexport * as PayRestAPI from './rest-api';\n\nexport {\n PAY_REST_API_PROD_URL,\n PAY_REST_API_TESTNET_URL,\n ConnectorClientError,\n RequiredError,\n UnauthorizedError,\n ForbiddenError,\n TooManyRequestsError,\n RateLimitBanError,\n ServerError,\n NetworkError,\n NotFoundError,\n BadRequestError,\n} from '@binance/common';\n"],"mappings":";;;;;;;AAAA,SAAS,UAAU,YAAY;AAC/B,SAAS,wBAAAA,uBAAsB,6BAA6B;;;ACAxD,WAAQ;AAER,cAAW;;;ACHf;AAAA;AAAA;AAAA;AAAA;;;ACaA;AAAA,EAII;AAAA,OAEG;AAMP,IAAM,0BAA0B,SAAU,eAAqC;AAC3E,SAAO;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAuDH,oBAAoB,OAChB,WACA,SACA,OACA,eACuB;AACvB,YAAM,yBAAkD,CAAC;AAEzD,UAAI,cAAc,UAAa,cAAc,MAAM;AAC/C,+BAAuB,WAAW,IAAI;AAAA,MAC1C;AAEA,UAAI,YAAY,UAAa,YAAY,MAAM;AAC3C,+BAAuB,SAAS,IAAI;AAAA,MACxC;AAEA,UAAI,UAAU,UAAa,UAAU,MAAM;AACvC,+BAAuB,OAAO,IAAI;AAAA,MACtC;AAEA,UAAI,eAAe,UAAa,eAAe,MAAM;AACjD,+BAAuB,YAAY,IAAI;AAAA,MAC3C;AAEA,UAAI;AACJ,UAAI,cAAc;AAAe,oBAAY,cAAc;AAE3D,aAAO;AAAA,QACH,UAAU;AAAA,QACV,QAAQ;AAAA,QACR,QAAQ;AAAA,QACR,UAAU;AAAA,MACd;AAAA,IACJ;AAAA,EACJ;AACJ;AAsGO,IAAM,SAAN,MAAwC;AAAA,EAI3C,YAAY,eAAqC;AAC7C,SAAK,gBAAgB;AACrB,SAAK,4BAA4B,wBAAwB,aAAa;AAAA,EAC1E;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAuDA,MAAa,mBACT,oBAA+C,CAAC,GACI;AACpD,UAAM,oBAAoB,MAAM,KAAK,0BAA0B;AAAA,MAC3D,mBAAmB;AAAA,MACnB,mBAAmB;AAAA,MACnB,mBAAmB;AAAA,MACnB,mBAAmB;AAAA,IACvB;AACA,WAAO;AAAA,MACH,KAAK;AAAA,MACL,kBAAkB;AAAA,MAClB,kBAAkB;AAAA,MAClB,kBAAkB;AAAA,MAClB,mBAAmB;AAAA,MACnB,EAAE,UAAU,MAAM;AAAA,IACtB;AAAA,EACJ;AACJ;;;AC7RA,SAAgD,eAAAC,oBAAmB;AAO5D,IAAM,UAAN,MAAc;AAAA,EAIjB,YAAY,eAAqC;AAC7C,SAAK,gBAAgB;AACrB,SAAK,SAAS,IAAI,OAAO,aAAa;AAAA,EAC1C;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUA,YACI,UACA,QACA,SAAkC,CAAC,GACR;AAC3B,WAAOC,aAAe,KAAK,eAAe,UAAU,QAAQ,QAAQ,MAAS;AAAA,EACjF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUA,kBACI,UACA,QACA,SAAkC,CAAC,GACR;AAC3B,WAAOA,aAAe,KAAK,eAAe,UAAU,QAAQ,QAAQ,QAAW;AAAA,MAC3E,UAAU;AAAA,IACd,CAAC;AAAA,EACL;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAsDA,mBACI,oBAA+C,CAAC,GACI;AACpD,WAAO,KAAK,OAAO,mBAAmB,iBAAiB;AAAA,EAC3D;AACJ;;;AJ/GO,IAAM,MAAN,MAAU;AAAA,EAGb,YAAY,QAA0B;AAClC,QAAI,QAAQ,sBAAsB;AAC9B,YAAM,gBAAgB,IAAIC,sBAAqB,OAAO,oBAAoB;AAC1E,oBAAc,WAAW,cAAc,YAAY;AACnD,oBAAc,cAAc,cAAc,eAAe,CAAC;AAC1D,oBAAc,YAAY,UAAU;AAAA,QAChC,GAAI,cAAc,YAAY,WAAW,CAAC;AAAA,QAC1C,cAAc,GAAG,IAAI,IAAI,OAAO,aAAa,QAAQ,OAAO,KAAK,SAAS,CAAC,KAAK,KAAK,CAAC;AAAA,MAC1F;AACA,WAAK,UAAU,IAAI,QAAQ,aAAa;AAAA,IAC5C;AAAA,EACJ;AACJ;;;AKrBA;AAAA,EACI,yBAAAC;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,OACG;","names":["ConfigurationRestAPI","sendRequest","sendRequest","ConfigurationRestAPI","PAY_REST_API_PROD_URL"]}
package/package.json ADDED
@@ -0,0 +1,55 @@
1
+ {
2
+ "name": "@binance/pay",
3
+ "description": "Official Binance Pay Connector - A lightweight library that provides a convenient interface to Binance's Pay REST API.",
4
+ "version": "1.0.0",
5
+ "main": "./dist/index.js",
6
+ "module": "./dist/index.mjs",
7
+ "types": "./dist/index.d.ts",
8
+ "scripts": {
9
+ "prepublishOnly": "npm run build",
10
+ "build": "tsup",
11
+ "typecheck": "tsc --noEmit",
12
+ "clean": "rm -rf dist",
13
+ "test": "npx jest --maxWorkers=4 --bail",
14
+ "test:watch": "npx jest --watch",
15
+ "format": "npx prettier --ignore-path .prettierignore --write .",
16
+ "lint": "npx eslint '**/*.ts' --fix"
17
+ },
18
+ "keywords": [
19
+ "Binance",
20
+ "API",
21
+ "Simple Earn",
22
+ "Connector",
23
+ "REST",
24
+ "Trading"
25
+ ],
26
+ "author": "Binance",
27
+ "license": "MIT",
28
+ "repository": {
29
+ "type": "git",
30
+ "url": "https://github.com/binance/binance-connector-js.git"
31
+ },
32
+ "bugs": {
33
+ "url": "https://github.com/binance/binance-connector-js/issues"
34
+ },
35
+ "homepage": "https://github.com/binance/binance-connector-js#readme",
36
+ "files": [
37
+ "dist"
38
+ ],
39
+ "devDependencies": {
40
+ "@types/jest": "^29.5.4",
41
+ "@types/node": "^20.17.24",
42
+ "eslint": "8.57.0",
43
+ "jest": "^29.6.4",
44
+ "prettier": "^3.3.3",
45
+ "ts-jest": "^29.1.1",
46
+ "ts-node": "^10.9.1",
47
+ "tsup": "^7.2.0",
48
+ "typescript": "^5.7.2",
49
+ "typescript-eslint": "^8.24.0"
50
+ },
51
+ "dependencies": {
52
+ "@binance/common": "1.0.0",
53
+ "axios": "^1.7.4"
54
+ }
55
+ }