@binance/pay 5.0.1 → 5.0.3

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.
Files changed (8) hide show
  1. package/dist/chunk.mjs +13 -0
  2. package/dist/index.d.mts +442 -535
  3. package/dist/index.d.ts +444 -536
  4. package/dist/index.js +301 -320
  5. package/dist/index.js.map +1 -1
  6. package/dist/index.mjs +222 -305
  7. package/dist/index.mjs.map +1 -1
  8. package/package.json +4 -4
package/dist/index.d.mts CHANGED
@@ -1,5 +1,6 @@
1
- import { RestApiResponse, ConfigurationRestAPI } from '@binance/common';
2
- export { BadRequestError, ConnectorClientError, ForbiddenError, NetworkError, NotFoundError, PAY_REST_API_PROD_URL, RateLimitBanError, RequiredError, ServerError, TooManyRequestsError, UnauthorizedError } from '@binance/common';
1
+ import { BadRequestError, ConfigurationRestAPI, ConnectorClientError, ForbiddenError, NetworkError, NotFoundError, PAY_REST_API_PROD_URL, RateLimitBanError, RequiredError, RestApiResponse, ServerError, TooManyRequestsError, UnauthorizedError } from "@binance/common";
2
+
3
+ //#region src/rest-api/types/get-pay-trade-history-response-data-inner-funds-detail-inner-wallet-asset-cost-inner.d.ts
3
4
 
4
5
  /**
5
6
  * Binance Pay REST API
@@ -19,32 +20,21 @@ export { BadRequestError, ConnectorClientError, ForbiddenError, NetworkError, No
19
20
  * @interface GetPayTradeHistoryResponseDataInnerFundsDetailInnerWalletAssetCostInner
20
21
  */
21
22
  interface GetPayTradeHistoryResponseDataInnerFundsDetailInnerWalletAssetCostInner {
22
- /**
23
- *
24
- * @type {string}
25
- * @memberof GetPayTradeHistoryResponseDataInnerFundsDetailInnerWalletAssetCostInner
26
- */
27
- '1'?: string;
28
- /**
29
- *
30
- * @type {string}
31
- * @memberof GetPayTradeHistoryResponseDataInnerFundsDetailInnerWalletAssetCostInner
32
- */
33
- '2'?: string;
23
+ /**
24
+ *
25
+ * @type {string}
26
+ * @memberof GetPayTradeHistoryResponseDataInnerFundsDetailInnerWalletAssetCostInner
27
+ */
28
+ '1'?: string;
29
+ /**
30
+ *
31
+ * @type {string}
32
+ * @memberof GetPayTradeHistoryResponseDataInnerFundsDetailInnerWalletAssetCostInner
33
+ */
34
+ '2'?: string;
34
35
  }
35
-
36
- /**
37
- * Binance Pay REST API
38
- *
39
- * OpenAPI Specification for the Binance Pay REST API
40
- *
41
- * The version of the OpenAPI document: 1.0.0
42
- *
43
- *
44
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
45
- * https://openapi-generator.tech
46
- * Do not edit the class manually.
47
- */
36
+ //#endregion
37
+ //#region src/rest-api/types/get-pay-trade-history-response-data-inner-funds-detail-inner.d.ts
48
38
 
49
39
  /**
50
40
  *
@@ -52,26 +42,27 @@ interface GetPayTradeHistoryResponseDataInnerFundsDetailInnerWalletAssetCostInne
52
42
  * @interface GetPayTradeHistoryResponseDataInnerFundsDetailInner
53
43
  */
54
44
  interface GetPayTradeHistoryResponseDataInnerFundsDetailInner {
55
- /**
56
- *
57
- * @type {string}
58
- * @memberof GetPayTradeHistoryResponseDataInnerFundsDetailInner
59
- */
60
- currency?: string;
61
- /**
62
- *
63
- * @type {string}
64
- * @memberof GetPayTradeHistoryResponseDataInnerFundsDetailInner
65
- */
66
- amount?: string;
67
- /**
68
- *
69
- * @type {Array<GetPayTradeHistoryResponseDataInnerFundsDetailInnerWalletAssetCostInner>}
70
- * @memberof GetPayTradeHistoryResponseDataInnerFundsDetailInner
71
- */
72
- walletAssetCost?: Array<GetPayTradeHistoryResponseDataInnerFundsDetailInnerWalletAssetCostInner>;
45
+ /**
46
+ *
47
+ * @type {string}
48
+ * @memberof GetPayTradeHistoryResponseDataInnerFundsDetailInner
49
+ */
50
+ currency?: string;
51
+ /**
52
+ *
53
+ * @type {string}
54
+ * @memberof GetPayTradeHistoryResponseDataInnerFundsDetailInner
55
+ */
56
+ amount?: string;
57
+ /**
58
+ *
59
+ * @type {Array<GetPayTradeHistoryResponseDataInnerFundsDetailInnerWalletAssetCostInner>}
60
+ * @memberof GetPayTradeHistoryResponseDataInnerFundsDetailInner
61
+ */
62
+ walletAssetCost?: Array<GetPayTradeHistoryResponseDataInnerFundsDetailInnerWalletAssetCostInner>;
73
63
  }
74
-
64
+ //#endregion
65
+ //#region src/rest-api/types/get-pay-trade-history-response-data-inner-payer-info.d.ts
75
66
  /**
76
67
  * Binance Pay REST API
77
68
  *
@@ -90,26 +81,27 @@ interface GetPayTradeHistoryResponseDataInnerFundsDetailInner {
90
81
  * @interface GetPayTradeHistoryResponseDataInnerPayerInfo
91
82
  */
92
83
  interface GetPayTradeHistoryResponseDataInnerPayerInfo {
93
- /**
94
- *
95
- * @type {string}
96
- * @memberof GetPayTradeHistoryResponseDataInnerPayerInfo
97
- */
98
- name?: string;
99
- /**
100
- *
101
- * @type {string}
102
- * @memberof GetPayTradeHistoryResponseDataInnerPayerInfo
103
- */
104
- type?: string;
105
- /**
106
- *
107
- * @type {string}
108
- * @memberof GetPayTradeHistoryResponseDataInnerPayerInfo
109
- */
110
- binanceId?: string;
84
+ /**
85
+ *
86
+ * @type {string}
87
+ * @memberof GetPayTradeHistoryResponseDataInnerPayerInfo
88
+ */
89
+ name?: string;
90
+ /**
91
+ *
92
+ * @type {string}
93
+ * @memberof GetPayTradeHistoryResponseDataInnerPayerInfo
94
+ */
95
+ type?: string;
96
+ /**
97
+ *
98
+ * @type {string}
99
+ * @memberof GetPayTradeHistoryResponseDataInnerPayerInfo
100
+ */
101
+ binanceId?: string;
111
102
  }
112
-
103
+ //#endregion
104
+ //#region src/rest-api/types/get-pay-trade-history-response-data-inner-receiver-info-extend.d.ts
113
105
  /**
114
106
  * Binance Pay REST API
115
107
  *
@@ -128,520 +120,435 @@ interface GetPayTradeHistoryResponseDataInnerPayerInfo {
128
120
  * @interface GetPayTradeHistoryResponseDataInnerReceiverInfoExtend
129
121
  */
130
122
  interface GetPayTradeHistoryResponseDataInnerReceiverInfoExtend {
131
- /**
132
- *
133
- * @type {string}
134
- * @memberof GetPayTradeHistoryResponseDataInnerReceiverInfoExtend
135
- */
136
- institutionName?: string;
137
- /**
138
- *
139
- * @type {string}
140
- * @memberof GetPayTradeHistoryResponseDataInnerReceiverInfoExtend
141
- */
142
- cardNumber?: string;
143
- /**
144
- *
145
- * @type {string}
146
- * @memberof GetPayTradeHistoryResponseDataInnerReceiverInfoExtend
147
- */
148
- digitalWalletId?: string;
123
+ /**
124
+ *
125
+ * @type {string}
126
+ * @memberof GetPayTradeHistoryResponseDataInnerReceiverInfoExtend
127
+ */
128
+ institutionName?: string;
129
+ /**
130
+ *
131
+ * @type {string}
132
+ * @memberof GetPayTradeHistoryResponseDataInnerReceiverInfoExtend
133
+ */
134
+ cardNumber?: string;
135
+ /**
136
+ *
137
+ * @type {string}
138
+ * @memberof GetPayTradeHistoryResponseDataInnerReceiverInfoExtend
139
+ */
140
+ digitalWalletId?: string;
149
141
  }
150
-
151
- /**
152
- * Binance Pay REST API
153
- *
154
- * OpenAPI Specification for the Binance Pay REST API
155
- *
156
- * The version of the OpenAPI document: 1.0.0
157
- *
158
- *
159
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
160
- * https://openapi-generator.tech
161
- * Do not edit the class manually.
162
- */
163
-
142
+ //#endregion
143
+ //#region src/rest-api/types/get-pay-trade-history-response-data-inner-receiver-info.d.ts
164
144
  /**
165
145
  *
166
146
  * @export
167
147
  * @interface GetPayTradeHistoryResponseDataInnerReceiverInfo
168
148
  */
169
149
  interface GetPayTradeHistoryResponseDataInnerReceiverInfo {
170
- /**
171
- *
172
- * @type {string}
173
- * @memberof GetPayTradeHistoryResponseDataInnerReceiverInfo
174
- */
175
- name?: string;
176
- /**
177
- *
178
- * @type {string}
179
- * @memberof GetPayTradeHistoryResponseDataInnerReceiverInfo
180
- */
181
- type?: string;
182
- /**
183
- *
184
- * @type {string}
185
- * @memberof GetPayTradeHistoryResponseDataInnerReceiverInfo
186
- */
187
- email?: string;
188
- /**
189
- *
190
- * @type {string}
191
- * @memberof GetPayTradeHistoryResponseDataInnerReceiverInfo
192
- */
193
- binanceId?: string;
194
- /**
195
- *
196
- * @type {string}
197
- * @memberof GetPayTradeHistoryResponseDataInnerReceiverInfo
198
- */
199
- accountId?: string;
200
- /**
201
- *
202
- * @type {string}
203
- * @memberof GetPayTradeHistoryResponseDataInnerReceiverInfo
204
- */
205
- countryCode?: string;
206
- /**
207
- *
208
- * @type {string}
209
- * @memberof GetPayTradeHistoryResponseDataInnerReceiverInfo
210
- */
211
- phoneNumber?: string;
212
- /**
213
- *
214
- * @type {string}
215
- * @memberof GetPayTradeHistoryResponseDataInnerReceiverInfo
216
- */
217
- mobileCode?: string;
218
- /**
219
- *
220
- * @type {GetPayTradeHistoryResponseDataInnerReceiverInfoExtend}
221
- * @memberof GetPayTradeHistoryResponseDataInnerReceiverInfo
222
- */
223
- extend?: GetPayTradeHistoryResponseDataInnerReceiverInfoExtend;
150
+ /**
151
+ *
152
+ * @type {string}
153
+ * @memberof GetPayTradeHistoryResponseDataInnerReceiverInfo
154
+ */
155
+ name?: string;
156
+ /**
157
+ *
158
+ * @type {string}
159
+ * @memberof GetPayTradeHistoryResponseDataInnerReceiverInfo
160
+ */
161
+ type?: string;
162
+ /**
163
+ *
164
+ * @type {string}
165
+ * @memberof GetPayTradeHistoryResponseDataInnerReceiverInfo
166
+ */
167
+ email?: string;
168
+ /**
169
+ *
170
+ * @type {string}
171
+ * @memberof GetPayTradeHistoryResponseDataInnerReceiverInfo
172
+ */
173
+ binanceId?: string;
174
+ /**
175
+ *
176
+ * @type {string}
177
+ * @memberof GetPayTradeHistoryResponseDataInnerReceiverInfo
178
+ */
179
+ accountId?: string;
180
+ /**
181
+ *
182
+ * @type {string}
183
+ * @memberof GetPayTradeHistoryResponseDataInnerReceiverInfo
184
+ */
185
+ countryCode?: string;
186
+ /**
187
+ *
188
+ * @type {string}
189
+ * @memberof GetPayTradeHistoryResponseDataInnerReceiverInfo
190
+ */
191
+ phoneNumber?: string;
192
+ /**
193
+ *
194
+ * @type {string}
195
+ * @memberof GetPayTradeHistoryResponseDataInnerReceiverInfo
196
+ */
197
+ mobileCode?: string;
198
+ /**
199
+ *
200
+ * @type {GetPayTradeHistoryResponseDataInnerReceiverInfoExtend}
201
+ * @memberof GetPayTradeHistoryResponseDataInnerReceiverInfo
202
+ */
203
+ extend?: GetPayTradeHistoryResponseDataInnerReceiverInfoExtend;
224
204
  }
225
-
226
- /**
227
- * Binance Pay REST API
228
- *
229
- * OpenAPI Specification for the Binance Pay REST API
230
- *
231
- * The version of the OpenAPI document: 1.0.0
232
- *
233
- *
234
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
235
- * https://openapi-generator.tech
236
- * Do not edit the class manually.
237
- */
238
-
205
+ //#endregion
206
+ //#region src/rest-api/types/get-pay-trade-history-response-data-inner.d.ts
239
207
  /**
240
208
  *
241
209
  * @export
242
210
  * @interface GetPayTradeHistoryResponseDataInner
243
211
  */
244
212
  interface GetPayTradeHistoryResponseDataInner {
245
- /**
246
- *
247
- * @type {string}
248
- * @memberof GetPayTradeHistoryResponseDataInner
249
- */
250
- orderType?: string;
251
- /**
252
- *
253
- * @type {string}
254
- * @memberof GetPayTradeHistoryResponseDataInner
255
- */
256
- transactionId?: string;
257
- /**
258
- *
259
- * @type {number | bigint}
260
- * @memberof GetPayTradeHistoryResponseDataInner
261
- */
262
- transactionTime?: number | bigint;
263
- /**
264
- *
265
- * @type {string}
266
- * @memberof GetPayTradeHistoryResponseDataInner
267
- */
268
- amount?: string;
269
- /**
270
- *
271
- * @type {string}
272
- * @memberof GetPayTradeHistoryResponseDataInner
273
- */
274
- currency?: string;
275
- /**
276
- *
277
- * @type {number | bigint}
278
- * @memberof GetPayTradeHistoryResponseDataInner
279
- */
280
- walletType?: number | bigint;
281
- /**
282
- *
283
- * @type {Array<number>}
284
- * @memberof GetPayTradeHistoryResponseDataInner
285
- */
286
- walletTypes?: Array<number>;
287
- /**
288
- *
289
- * @type {Array<GetPayTradeHistoryResponseDataInnerFundsDetailInner>}
290
- * @memberof GetPayTradeHistoryResponseDataInner
291
- */
292
- fundsDetail?: Array<GetPayTradeHistoryResponseDataInnerFundsDetailInner>;
293
- /**
294
- *
295
- * @type {GetPayTradeHistoryResponseDataInnerPayerInfo}
296
- * @memberof GetPayTradeHistoryResponseDataInner
297
- */
298
- payerInfo?: GetPayTradeHistoryResponseDataInnerPayerInfo;
299
- /**
300
- *
301
- * @type {GetPayTradeHistoryResponseDataInnerReceiverInfo}
302
- * @memberof GetPayTradeHistoryResponseDataInner
303
- */
304
- receiverInfo?: GetPayTradeHistoryResponseDataInnerReceiverInfo;
213
+ /**
214
+ *
215
+ * @type {string}
216
+ * @memberof GetPayTradeHistoryResponseDataInner
217
+ */
218
+ orderType?: string;
219
+ /**
220
+ *
221
+ * @type {string}
222
+ * @memberof GetPayTradeHistoryResponseDataInner
223
+ */
224
+ transactionId?: string;
225
+ /**
226
+ *
227
+ * @type {number | bigint}
228
+ * @memberof GetPayTradeHistoryResponseDataInner
229
+ */
230
+ transactionTime?: number | bigint;
231
+ /**
232
+ *
233
+ * @type {string}
234
+ * @memberof GetPayTradeHistoryResponseDataInner
235
+ */
236
+ amount?: string;
237
+ /**
238
+ *
239
+ * @type {string}
240
+ * @memberof GetPayTradeHistoryResponseDataInner
241
+ */
242
+ currency?: string;
243
+ /**
244
+ *
245
+ * @type {number | bigint}
246
+ * @memberof GetPayTradeHistoryResponseDataInner
247
+ */
248
+ walletType?: number | bigint;
249
+ /**
250
+ *
251
+ * @type {Array<number>}
252
+ * @memberof GetPayTradeHistoryResponseDataInner
253
+ */
254
+ walletTypes?: Array<number>;
255
+ /**
256
+ *
257
+ * @type {Array<GetPayTradeHistoryResponseDataInnerFundsDetailInner>}
258
+ * @memberof GetPayTradeHistoryResponseDataInner
259
+ */
260
+ fundsDetail?: Array<GetPayTradeHistoryResponseDataInnerFundsDetailInner>;
261
+ /**
262
+ *
263
+ * @type {GetPayTradeHistoryResponseDataInnerPayerInfo}
264
+ * @memberof GetPayTradeHistoryResponseDataInner
265
+ */
266
+ payerInfo?: GetPayTradeHistoryResponseDataInnerPayerInfo;
267
+ /**
268
+ *
269
+ * @type {GetPayTradeHistoryResponseDataInnerReceiverInfo}
270
+ * @memberof GetPayTradeHistoryResponseDataInner
271
+ */
272
+ receiverInfo?: GetPayTradeHistoryResponseDataInnerReceiverInfo;
305
273
  }
306
-
307
- /**
308
- * Binance Pay REST API
309
- *
310
- * OpenAPI Specification for the Binance Pay REST API
311
- *
312
- * The version of the OpenAPI document: 1.0.0
313
- *
314
- *
315
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
316
- * https://openapi-generator.tech
317
- * Do not edit the class manually.
318
- */
319
-
274
+ //#endregion
275
+ //#region src/rest-api/types/get-pay-trade-history-response.d.ts
320
276
  /**
321
277
  *
322
278
  * @export
323
279
  * @interface GetPayTradeHistoryResponse
324
280
  */
325
281
  interface GetPayTradeHistoryResponse {
326
- /**
327
- *
328
- * @type {string}
329
- * @memberof GetPayTradeHistoryResponse
330
- */
331
- code?: string;
332
- /**
333
- *
334
- * @type {string}
335
- * @memberof GetPayTradeHistoryResponse
336
- */
337
- message?: string;
338
- /**
339
- *
340
- * @type {Array<GetPayTradeHistoryResponseDataInner>}
341
- * @memberof GetPayTradeHistoryResponse
342
- */
343
- data?: Array<GetPayTradeHistoryResponseDataInner>;
344
- /**
345
- *
346
- * @type {boolean}
347
- * @memberof GetPayTradeHistoryResponse
348
- */
349
- success?: boolean;
282
+ /**
283
+ *
284
+ * @type {string}
285
+ * @memberof GetPayTradeHistoryResponse
286
+ */
287
+ code?: string;
288
+ /**
289
+ *
290
+ * @type {string}
291
+ * @memberof GetPayTradeHistoryResponse
292
+ */
293
+ message?: string;
294
+ /**
295
+ *
296
+ * @type {Array<GetPayTradeHistoryResponseDataInner>}
297
+ * @memberof GetPayTradeHistoryResponse
298
+ */
299
+ data?: Array<GetPayTradeHistoryResponseDataInner>;
300
+ /**
301
+ *
302
+ * @type {boolean}
303
+ * @memberof GetPayTradeHistoryResponse
304
+ */
305
+ success?: boolean;
350
306
  }
351
-
352
- /**
353
- * Binance Pay REST API
354
- *
355
- * OpenAPI Specification for the Binance Pay REST API
356
- *
357
- * The version of the OpenAPI document: 1.0.0
358
- *
359
- *
360
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
361
- * https://openapi-generator.tech
362
- * Do not edit the class manually.
363
- */
364
-
307
+ //#endregion
308
+ //#region src/rest-api/modules/pay-api.d.ts
365
309
  /**
366
310
  * PayApi - interface
367
311
  * @interface PayApi
368
312
  */
369
313
  interface PayApiInterface {
370
- /**
371
- * Get Pay Trade History
372
- *
373
- * If startTime and endTime are not sent, the recent 90 days' data will be returned.
374
- * The max interval between startTime and endTime is 90 days.
375
- * Support for querying orders within the last 18 months.
376
- * For payerInfo and receiverInfo，there are different return values in different orderTypes.
377
- * Sender's perspective when orderType is C2C
378
- * payerInfo : binanceId
379
- * receiverInfo : name, binanceId/accountId/email/countryCode/phoneNumber/mobileCode (based on user input)
380
- * Receiver's perspective when orderType is C2C
381
- * payerInfo : name
382
- * receiverInfo : binanceId
383
- * Sender's perspective when orderType is CRYPTO_BOX
384
- * payerInfo : binanceId
385
- * receiverInfo : name(the value is always "Crypto Box")
386
- * Receiver's perspective when orderType is CRYPTO_BOX
387
- * payerInfo : name
388
- * receiverInfo : binanceId
389
- * Sender's perspective when orderType is PAY
390
- * payerInfo : binanceId
391
- * receiverInfo : name
392
- * Receiver's perspective when orderType is PAY
393
- * payerInfo : name
394
- * receiverInfo : binanceId, name
395
- * Sender's perspective when orderType is PAY_REFUND
396
- * payerInfo : binanceId, name
397
- * receiverInfo : name, accountId
398
- * Receiver's perspective when orderType is PAY_REFUND
399
- * payerInfo : name
400
- * receiverInfo : binanceId
401
- * Sender's perspective when orderType is PAYOUT
402
- * payerInfo : binanceId, name
403
- * receiverInfo : name, accountId
404
- * Receiver's perspective when orderType is PAYOUT
405
- * payerInfo : name
406
- * receiverInfo : binanceId
407
- * Receiver's perspective when orderType is CRYPTO_BOX_RF
408
- * payerInfo : name(the value is always "Crypto Box")
409
- * receiverInfo : binanceId
410
- * Sender's perspective when orderType is REMITTANCE
411
- * payerInfo : binanceId
412
- * receiverInfo : name, institutionName, cardNumber, digitalWalletId
413
- *
414
- * Weight: 3000
415
- *
416
- * @summary Get Pay Trade History
417
- * @param {GetPayTradeHistoryRequest} requestParameters Request parameters.
418
- *
419
- * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError}
420
- * @memberof PayApiInterface
421
- */
422
- getPayTradeHistory(requestParameters?: GetPayTradeHistoryRequest): Promise<RestApiResponse<GetPayTradeHistoryResponse>>;
314
+ /**
315
+ * Get Pay Trade History
316
+ *
317
+ * If startTime and endTime are not sent, the recent 90 days' data will be returned.
318
+ * The max interval between startTime and endTime is 90 days.
319
+ * Support for querying orders within the last 18 months.
320
+ * For payerInfo and receiverInfo，there are different return values in different orderTypes.
321
+ * Sender's perspective when orderType is C2C
322
+ * payerInfo : binanceId
323
+ * receiverInfo : name, binanceId/accountId/email/countryCode/phoneNumber/mobileCode (based on user input)
324
+ * Receiver's perspective when orderType is C2C
325
+ * payerInfo : name
326
+ * receiverInfo : binanceId
327
+ * Sender's perspective when orderType is CRYPTO_BOX
328
+ * payerInfo : binanceId
329
+ * receiverInfo : name(the value is always "Crypto Box")
330
+ * Receiver's perspective when orderType is CRYPTO_BOX
331
+ * payerInfo : name
332
+ * receiverInfo : binanceId
333
+ * Sender's perspective when orderType is PAY
334
+ * payerInfo : binanceId
335
+ * receiverInfo : name
336
+ * Receiver's perspective when orderType is PAY
337
+ * payerInfo : name
338
+ * receiverInfo : binanceId, name
339
+ * Sender's perspective when orderType is PAY_REFUND
340
+ * payerInfo : binanceId, name
341
+ * receiverInfo : name, accountId
342
+ * Receiver's perspective when orderType is PAY_REFUND
343
+ * payerInfo : name
344
+ * receiverInfo : binanceId
345
+ * Sender's perspective when orderType is PAYOUT
346
+ * payerInfo : binanceId, name
347
+ * receiverInfo : name, accountId
348
+ * Receiver's perspective when orderType is PAYOUT
349
+ * payerInfo : name
350
+ * receiverInfo : binanceId
351
+ * Receiver's perspective when orderType is CRYPTO_BOX_RF
352
+ * payerInfo : name(the value is always "Crypto Box")
353
+ * receiverInfo : binanceId
354
+ * Sender's perspective when orderType is REMITTANCE
355
+ * payerInfo : binanceId
356
+ * receiverInfo : name, institutionName, cardNumber, digitalWalletId
357
+ *
358
+ * Weight: 3000
359
+ *
360
+ * @summary Get Pay Trade History
361
+ * @param {GetPayTradeHistoryRequest} requestParameters Request parameters.
362
+ *
363
+ * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError}
364
+ * @memberof PayApiInterface
365
+ */
366
+ getPayTradeHistory(requestParameters?: GetPayTradeHistoryRequest): Promise<RestApiResponse<GetPayTradeHistoryResponse>>;
423
367
  }
424
368
  /**
425
369
  * Request parameters for getPayTradeHistory operation in PayApi.
426
370
  * @interface GetPayTradeHistoryRequest
427
371
  */
428
372
  interface GetPayTradeHistoryRequest {
429
- /**
430
- *
431
- * @type {number | bigint}
432
- * @memberof PayApiGetPayTradeHistory
433
- */
434
- readonly startTime?: number | bigint;
435
- /**
436
- *
437
- * @type {number | bigint}
438
- * @memberof PayApiGetPayTradeHistory
439
- */
440
- readonly endTime?: number | bigint;
441
- /**
442
- * default 100, max 100
443
- * @type {number | bigint}
444
- * @memberof PayApiGetPayTradeHistory
445
- */
446
- readonly limit?: number | bigint;
447
- /**
448
- *
449
- * @type {number | bigint}
450
- * @memberof PayApiGetPayTradeHistory
451
- */
452
- readonly recvWindow?: number | bigint;
373
+ /**
374
+ *
375
+ * @type {number | bigint}
376
+ * @memberof PayApiGetPayTradeHistory
377
+ */
378
+ readonly startTime?: number | bigint;
379
+ /**
380
+ *
381
+ * @type {number | bigint}
382
+ * @memberof PayApiGetPayTradeHistory
383
+ */
384
+ readonly endTime?: number | bigint;
385
+ /**
386
+ * default 100, max 100
387
+ * @type {number | bigint}
388
+ * @memberof PayApiGetPayTradeHistory
389
+ */
390
+ readonly limit?: number | bigint;
391
+ /**
392
+ *
393
+ * @type {number | bigint}
394
+ * @memberof PayApiGetPayTradeHistory
395
+ */
396
+ readonly recvWindow?: number | bigint;
453
397
  }
454
398
  /**
455
399
  * PayApi - object-oriented interface
456
400
  * @class PayApi
457
401
  */
458
402
  declare class PayApi implements PayApiInterface {
459
- private readonly configuration;
460
- private localVarAxiosParamCreator;
461
- constructor(configuration: ConfigurationRestAPI);
462
- /**
463
- * Get Pay Trade History
464
- *
465
- * If startTime and endTime are not sent, the recent 90 days' data will be returned.
466
- * The max interval between startTime and endTime is 90 days.
467
- * Support for querying orders within the last 18 months.
468
- * For payerInfo and receiverInfo，there are different return values in different orderTypes.
469
- * Sender's perspective when orderType is C2C
470
- * payerInfo : binanceId
471
- * receiverInfo : name, binanceId/accountId/email/countryCode/phoneNumber/mobileCode (based on user input)
472
- * Receiver's perspective when orderType is C2C
473
- * payerInfo : name
474
- * receiverInfo : binanceId
475
- * Sender's perspective when orderType is CRYPTO_BOX
476
- * payerInfo : binanceId
477
- * receiverInfo : name(the value is always "Crypto Box")
478
- * Receiver's perspective when orderType is CRYPTO_BOX
479
- * payerInfo : name
480
- * receiverInfo : binanceId
481
- * Sender's perspective when orderType is PAY
482
- * payerInfo : binanceId
483
- * receiverInfo : name
484
- * Receiver's perspective when orderType is PAY
485
- * payerInfo : name
486
- * receiverInfo : binanceId, name
487
- * Sender's perspective when orderType is PAY_REFUND
488
- * payerInfo : binanceId, name
489
- * receiverInfo : name, accountId
490
- * Receiver's perspective when orderType is PAY_REFUND
491
- * payerInfo : name
492
- * receiverInfo : binanceId
493
- * Sender's perspective when orderType is PAYOUT
494
- * payerInfo : binanceId, name
495
- * receiverInfo : name, accountId
496
- * Receiver's perspective when orderType is PAYOUT
497
- * payerInfo : name
498
- * receiverInfo : binanceId
499
- * Receiver's perspective when orderType is CRYPTO_BOX_RF
500
- * payerInfo : name(the value is always "Crypto Box")
501
- * receiverInfo : binanceId
502
- * Sender's perspective when orderType is REMITTANCE
503
- * payerInfo : binanceId
504
- * receiverInfo : name, institutionName, cardNumber, digitalWalletId
505
- *
506
- * Weight: 3000
507
- *
508
- * @summary Get Pay Trade History
509
- * @param {GetPayTradeHistoryRequest} requestParameters Request parameters.
510
- * @returns {Promise<RestApiResponse<GetPayTradeHistoryResponse>>}
511
- * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError}
512
- * @memberof PayApi
513
- * @see {@link https://developers.binance.com/docs/pay/rest-api/Get-Pay-Trade-History Binance API Documentation}
514
- */
515
- getPayTradeHistory(requestParameters?: GetPayTradeHistoryRequest): Promise<RestApiResponse<GetPayTradeHistoryResponse>>;
403
+ private readonly configuration;
404
+ private localVarAxiosParamCreator;
405
+ constructor(configuration: ConfigurationRestAPI);
406
+ /**
407
+ * Get Pay Trade History
408
+ *
409
+ * If startTime and endTime are not sent, the recent 90 days' data will be returned.
410
+ * The max interval between startTime and endTime is 90 days.
411
+ * Support for querying orders within the last 18 months.
412
+ * For payerInfo and receiverInfo，there are different return values in different orderTypes.
413
+ * Sender's perspective when orderType is C2C
414
+ * payerInfo : binanceId
415
+ * receiverInfo : name, binanceId/accountId/email/countryCode/phoneNumber/mobileCode (based on user input)
416
+ * Receiver's perspective when orderType is C2C
417
+ * payerInfo : name
418
+ * receiverInfo : binanceId
419
+ * Sender's perspective when orderType is CRYPTO_BOX
420
+ * payerInfo : binanceId
421
+ * receiverInfo : name(the value is always "Crypto Box")
422
+ * Receiver's perspective when orderType is CRYPTO_BOX
423
+ * payerInfo : name
424
+ * receiverInfo : binanceId
425
+ * Sender's perspective when orderType is PAY
426
+ * payerInfo : binanceId
427
+ * receiverInfo : name
428
+ * Receiver's perspective when orderType is PAY
429
+ * payerInfo : name
430
+ * receiverInfo : binanceId, name
431
+ * Sender's perspective when orderType is PAY_REFUND
432
+ * payerInfo : binanceId, name
433
+ * receiverInfo : name, accountId
434
+ * Receiver's perspective when orderType is PAY_REFUND
435
+ * payerInfo : name
436
+ * receiverInfo : binanceId
437
+ * Sender's perspective when orderType is PAYOUT
438
+ * payerInfo : binanceId, name
439
+ * receiverInfo : name, accountId
440
+ * Receiver's perspective when orderType is PAYOUT
441
+ * payerInfo : name
442
+ * receiverInfo : binanceId
443
+ * Receiver's perspective when orderType is CRYPTO_BOX_RF
444
+ * payerInfo : name(the value is always "Crypto Box")
445
+ * receiverInfo : binanceId
446
+ * Sender's perspective when orderType is REMITTANCE
447
+ * payerInfo : binanceId
448
+ * receiverInfo : name, institutionName, cardNumber, digitalWalletId
449
+ *
450
+ * Weight: 3000
451
+ *
452
+ * @summary Get Pay Trade History
453
+ * @param {GetPayTradeHistoryRequest} requestParameters Request parameters.
454
+ * @returns {Promise<RestApiResponse<GetPayTradeHistoryResponse>>}
455
+ * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError}
456
+ * @memberof PayApi
457
+ * @see {@link https://developers.binance.com/docs/pay/rest-api/Get-Pay-Trade-History Binance API Documentation}
458
+ */
459
+ getPayTradeHistory(requestParameters?: GetPayTradeHistoryRequest): Promise<RestApiResponse<GetPayTradeHistoryResponse>>;
516
460
  }
517
-
518
- /**
519
- * Binance Pay REST API
520
- *
521
- * OpenAPI Specification for the Binance Pay REST API
522
- *
523
- * The version of the OpenAPI document: 1.0.0
524
- *
525
- *
526
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
527
- * https://openapi-generator.tech
528
- * Do not edit the class manually.
529
- */
530
-
461
+ //#endregion
462
+ //#region src/rest-api/rest-api.d.ts
531
463
  declare class RestAPI {
532
- private configuration;
533
- private payApi;
534
- constructor(configuration: ConfigurationRestAPI);
535
- /**
536
- * Generic function to send a request.
537
- * @param endpoint - The API endpoint to call.
538
- * @param method - HTTP method to use (GET, POST, DELETE, etc.).
539
- * @param params - Query parameters for the request.
540
- *
541
- * @returns A promise resolving to the response data object.
542
- */
543
- sendRequest<T>(endpoint: string, method: 'GET' | 'POST' | 'DELETE' | 'PUT' | 'PATCH', params?: Record<string, unknown>): Promise<RestApiResponse<T>>;
544
- /**
545
- * Generic function to send a signed request.
546
- * @param endpoint - The API endpoint to call.
547
- * @param method - HTTP method to use (GET, POST, DELETE, etc.).
548
- * @param params - Query parameters for the request.
549
- *
550
- * @returns A promise resolving to the response data object.
551
- */
552
- sendSignedRequest<T>(endpoint: string, method: 'GET' | 'POST' | 'DELETE' | 'PUT' | 'PATCH', params?: Record<string, unknown>): Promise<RestApiResponse<T>>;
553
- /**
554
- * Get Pay Trade History
555
- *
556
- * If startTime and endTime are not sent, the recent 90 days' data will be returned.
557
- * The max interval between startTime and endTime is 90 days.
558
- * Support for querying orders within the last 18 months.
559
- * For payerInfo and receiverInfo，there are different return values in different orderTypes.
560
- * Sender's perspective when orderType is C2C
561
- * payerInfo : binanceId
562
- * receiverInfo : name, binanceId/accountId/email/countryCode/phoneNumber/mobileCode (based on user input)
563
- * Receiver's perspective when orderType is C2C
564
- * payerInfo : name
565
- * receiverInfo : binanceId
566
- * Sender's perspective when orderType is CRYPTO_BOX
567
- * payerInfo : binanceId
568
- * receiverInfo : name(the value is always "Crypto Box")
569
- * Receiver's perspective when orderType is CRYPTO_BOX
570
- * payerInfo : name
571
- * receiverInfo : binanceId
572
- * Sender's perspective when orderType is PAY
573
- * payerInfo : binanceId
574
- * receiverInfo : name
575
- * Receiver's perspective when orderType is PAY
576
- * payerInfo : name
577
- * receiverInfo : binanceId, name
578
- * Sender's perspective when orderType is PAY_REFUND
579
- * payerInfo : binanceId, name
580
- * receiverInfo : name, accountId
581
- * Receiver's perspective when orderType is PAY_REFUND
582
- * payerInfo : name
583
- * receiverInfo : binanceId
584
- * Sender's perspective when orderType is PAYOUT
585
- * payerInfo : binanceId, name
586
- * receiverInfo : name, accountId
587
- * Receiver's perspective when orderType is PAYOUT
588
- * payerInfo : name
589
- * receiverInfo : binanceId
590
- * Receiver's perspective when orderType is CRYPTO_BOX_RF
591
- * payerInfo : name(the value is always "Crypto Box")
592
- * receiverInfo : binanceId
593
- * Sender's perspective when orderType is REMITTANCE
594
- * payerInfo : binanceId
595
- * receiverInfo : name, institutionName, cardNumber, digitalWalletId
596
- *
597
- * Weight: 3000
598
- *
599
- * @summary Get Pay Trade History
600
- * @param {GetPayTradeHistoryRequest} requestParameters Request parameters.
601
- *
602
- * @returns {Promise<RestApiResponse<GetPayTradeHistoryResponse>>}
603
- * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError}
604
- * @see {@link https://developers.binance.com/docs/pay/rest-api/Get-Pay-Trade-History Binance API Documentation}
605
- */
606
- getPayTradeHistory(requestParameters?: GetPayTradeHistoryRequest): Promise<RestApiResponse<GetPayTradeHistoryResponse>>;
464
+ private configuration;
465
+ private payApi;
466
+ constructor(configuration: ConfigurationRestAPI);
467
+ /**
468
+ * Generic function to send a request.
469
+ * @param endpoint - The API endpoint to call.
470
+ * @param method - HTTP method to use (GET, POST, DELETE, etc.).
471
+ * @param params - Query parameters for the request.
472
+ *
473
+ * @returns A promise resolving to the response data object.
474
+ */
475
+ sendRequest<T>(endpoint: string, method: 'GET' | 'POST' | 'DELETE' | 'PUT' | 'PATCH', params?: Record<string, unknown>): Promise<RestApiResponse<T>>;
476
+ /**
477
+ * Generic function to send a signed request.
478
+ * @param endpoint - The API endpoint to call.
479
+ * @param method - HTTP method to use (GET, POST, DELETE, etc.).
480
+ * @param params - Query parameters for the request.
481
+ *
482
+ * @returns A promise resolving to the response data object.
483
+ */
484
+ sendSignedRequest<T>(endpoint: string, method: 'GET' | 'POST' | 'DELETE' | 'PUT' | 'PATCH', params?: Record<string, unknown>): Promise<RestApiResponse<T>>;
485
+ /**
486
+ * Get Pay Trade History
487
+ *
488
+ * If startTime and endTime are not sent, the recent 90 days' data will be returned.
489
+ * The max interval between startTime and endTime is 90 days.
490
+ * Support for querying orders within the last 18 months.
491
+ * For payerInfo and receiverInfo，there are different return values in different orderTypes.
492
+ * Sender's perspective when orderType is C2C
493
+ * payerInfo : binanceId
494
+ * receiverInfo : name, binanceId/accountId/email/countryCode/phoneNumber/mobileCode (based on user input)
495
+ * Receiver's perspective when orderType is C2C
496
+ * payerInfo : name
497
+ * receiverInfo : binanceId
498
+ * Sender's perspective when orderType is CRYPTO_BOX
499
+ * payerInfo : binanceId
500
+ * receiverInfo : name(the value is always "Crypto Box")
501
+ * Receiver's perspective when orderType is CRYPTO_BOX
502
+ * payerInfo : name
503
+ * receiverInfo : binanceId
504
+ * Sender's perspective when orderType is PAY
505
+ * payerInfo : binanceId
506
+ * receiverInfo : name
507
+ * Receiver's perspective when orderType is PAY
508
+ * payerInfo : name
509
+ * receiverInfo : binanceId, name
510
+ * Sender's perspective when orderType is PAY_REFUND
511
+ * payerInfo : binanceId, name
512
+ * receiverInfo : name, accountId
513
+ * Receiver's perspective when orderType is PAY_REFUND
514
+ * payerInfo : name
515
+ * receiverInfo : binanceId
516
+ * Sender's perspective when orderType is PAYOUT
517
+ * payerInfo : binanceId, name
518
+ * receiverInfo : name, accountId
519
+ * Receiver's perspective when orderType is PAYOUT
520
+ * payerInfo : name
521
+ * receiverInfo : binanceId
522
+ * Receiver's perspective when orderType is CRYPTO_BOX_RF
523
+ * payerInfo : name(the value is always "Crypto Box")
524
+ * receiverInfo : binanceId
525
+ * Sender's perspective when orderType is REMITTANCE
526
+ * payerInfo : binanceId
527
+ * receiverInfo : name, institutionName, cardNumber, digitalWalletId
528
+ *
529
+ * Weight: 3000
530
+ *
531
+ * @summary Get Pay Trade History
532
+ * @param {GetPayTradeHistoryRequest} requestParameters Request parameters.
533
+ *
534
+ * @returns {Promise<RestApiResponse<GetPayTradeHistoryResponse>>}
535
+ * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError}
536
+ * @see {@link https://developers.binance.com/docs/pay/rest-api/Get-Pay-Trade-History Binance API Documentation}
537
+ */
538
+ getPayTradeHistory(requestParameters?: GetPayTradeHistoryRequest): Promise<RestApiResponse<GetPayTradeHistoryResponse>>;
607
539
  }
608
-
609
- /**
610
- * Binance Pay REST API
611
- *
612
- * OpenAPI Specification for the Binance Pay REST API
613
- *
614
- * The version of the OpenAPI document: 1.0.0
615
- *
616
- *
617
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
618
- * https://openapi-generator.tech
619
- * Do not edit the class manually.
620
- */
621
-
622
- type index_GetPayTradeHistoryRequest = GetPayTradeHistoryRequest;
623
- type index_GetPayTradeHistoryResponse = GetPayTradeHistoryResponse;
624
- type index_GetPayTradeHistoryResponseDataInner = GetPayTradeHistoryResponseDataInner;
625
- type index_GetPayTradeHistoryResponseDataInnerFundsDetailInner = GetPayTradeHistoryResponseDataInnerFundsDetailInner;
626
- type index_GetPayTradeHistoryResponseDataInnerFundsDetailInnerWalletAssetCostInner = GetPayTradeHistoryResponseDataInnerFundsDetailInnerWalletAssetCostInner;
627
- type index_GetPayTradeHistoryResponseDataInnerPayerInfo = GetPayTradeHistoryResponseDataInnerPayerInfo;
628
- type index_GetPayTradeHistoryResponseDataInnerReceiverInfo = GetPayTradeHistoryResponseDataInnerReceiverInfo;
629
- type index_GetPayTradeHistoryResponseDataInnerReceiverInfoExtend = GetPayTradeHistoryResponseDataInnerReceiverInfoExtend;
630
- type index_PayApi = PayApi;
631
- declare const index_PayApi: typeof PayApi;
632
- type index_PayApiInterface = PayApiInterface;
633
- type index_RestAPI = RestAPI;
634
- declare const index_RestAPI: typeof RestAPI;
635
- declare namespace index {
636
- 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 };
540
+ declare namespace index_d_exports {
541
+ export { GetPayTradeHistoryRequest, GetPayTradeHistoryResponse, GetPayTradeHistoryResponseDataInner, GetPayTradeHistoryResponseDataInnerFundsDetailInner, GetPayTradeHistoryResponseDataInnerFundsDetailInnerWalletAssetCostInner, GetPayTradeHistoryResponseDataInnerPayerInfo, GetPayTradeHistoryResponseDataInnerReceiverInfo, GetPayTradeHistoryResponseDataInnerReceiverInfoExtend, PayApi, PayApiInterface, RestAPI };
637
542
  }
638
-
543
+ //#endregion
544
+ //#region src/pay.d.ts
639
545
  interface ConfigurationPay {
640
- configurationRestAPI?: ConfigurationRestAPI;
546
+ configurationRestAPI?: ConfigurationRestAPI;
641
547
  }
642
548
  declare class Pay {
643
- restAPI: RestAPI;
644
- constructor(config: ConfigurationPay);
549
+ restAPI: RestAPI;
550
+ constructor(config: ConfigurationPay);
645
551
  }
646
-
647
- export { type ConfigurationPay, Pay, index as PayRestAPI };
552
+ //#endregion
553
+ export { BadRequestError, type ConfigurationPay, ConnectorClientError, ForbiddenError, NetworkError, NotFoundError, PAY_REST_API_PROD_URL, Pay, index_d_exports as PayRestAPI, RateLimitBanError, RequiredError, ServerError, TooManyRequestsError, UnauthorizedError };
554
+ //# sourceMappingURL=index.d.mts.map