@binance/pay 6.0.3 → 7.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.d.mts CHANGED
@@ -1,11 +1,11 @@
1
1
  import { BadRequestError, ConfigurationRestAPI, ConnectorClientError, ForbiddenError, NetworkError, NotFoundError, PAY_REST_API_PROD_URL, RateLimitBanError, RequiredError, RestApiResponse, ServerError, TooManyRequestsError, UnauthorizedError } from "@binance/common";
2
2
 
3
- //#region src/rest-api/types/get-pay-trade-history-response-data-inner-funds-detail-inner-wallet-asset-cost.d.ts
3
+ //#region src/rest-api/types/get-pay-trade-history-response-data-inner-funds-detail-inner.d.ts
4
4
 
5
5
  /**
6
6
  * Binance Pay REST API
7
7
  *
8
- * OpenAPI Specification for the Binance Pay REST API
8
+ * Query Binance Pay transaction history.
9
9
  *
10
10
  * The version of the OpenAPI document: 1.0.0
11
11
  *
@@ -14,28 +14,6 @@ import { BadRequestError, ConfigurationRestAPI, ConnectorClientError, ForbiddenE
14
14
  * https://openapi-generator.tech
15
15
  * Do not edit the class manually.
16
16
  */
17
- /**
18
- *
19
- * @export
20
- * @interface GetPayTradeHistoryResponseDataInnerFundsDetailInnerWalletAssetCost
21
- */
22
- interface GetPayTradeHistoryResponseDataInnerFundsDetailInnerWalletAssetCost {
23
- /**
24
- *
25
- * @type {string}
26
- * @memberof GetPayTradeHistoryResponseDataInnerFundsDetailInnerWalletAssetCost
27
- */
28
- '1'?: string;
29
- /**
30
- *
31
- * @type {string}
32
- * @memberof GetPayTradeHistoryResponseDataInnerFundsDetailInnerWalletAssetCost
33
- */
34
- '2'?: string;
35
- }
36
- //#endregion
37
- //#region src/rest-api/types/get-pay-trade-history-response-data-inner-funds-detail-inner.d.ts
38
-
39
17
  /**
40
18
  *
41
19
  * @export
@@ -43,30 +21,32 @@ interface GetPayTradeHistoryResponseDataInnerFundsDetailInnerWalletAssetCost {
43
21
  */
44
22
  interface GetPayTradeHistoryResponseDataInnerFundsDetailInner {
45
23
  /**
46
- *
24
+ * Asset.
47
25
  * @type {string}
48
26
  * @memberof GetPayTradeHistoryResponseDataInnerFundsDetailInner
49
27
  */
50
28
  currency?: string;
51
29
  /**
52
- *
30
+ * Asset amount.
53
31
  * @type {string}
54
32
  * @memberof GetPayTradeHistoryResponseDataInnerFundsDetailInner
55
33
  */
56
34
  amount?: string;
57
35
  /**
58
- *
59
- * @type {GetPayTradeHistoryResponseDataInnerFundsDetailInnerWalletAssetCost}
36
+ * Asset cost details per wallet type. Keys are wallet type IDs (e.g. \"1\", \"2\"), values are cost amounts.
37
+ * @type {{ [key: string]: string | undefined; }}
60
38
  * @memberof GetPayTradeHistoryResponseDataInnerFundsDetailInner
61
39
  */
62
- walletAssetCost?: GetPayTradeHistoryResponseDataInnerFundsDetailInnerWalletAssetCost;
40
+ walletAssetCost?: {
41
+ [key: string]: string | undefined;
42
+ };
63
43
  }
64
44
  //#endregion
65
45
  //#region src/rest-api/types/get-pay-trade-history-response-data-inner-payer-info.d.ts
66
46
  /**
67
47
  * Binance Pay REST API
68
48
  *
69
- * OpenAPI Specification for the Binance Pay REST API
49
+ * Query Binance Pay transaction history.
70
50
  *
71
51
  * The version of the OpenAPI document: 1.0.0
72
52
  *
@@ -82,19 +62,19 @@ interface GetPayTradeHistoryResponseDataInnerFundsDetailInner {
82
62
  */
83
63
  interface GetPayTradeHistoryResponseDataInnerPayerInfo {
84
64
  /**
85
- *
65
+ * Nickname or merchant name.
86
66
  * @type {string}
87
67
  * @memberof GetPayTradeHistoryResponseDataInnerPayerInfo
88
68
  */
89
69
  name?: string;
90
70
  /**
91
- *
71
+ * Account type: USER for personal, MERCHANT for merchant.
92
72
  * @type {string}
93
73
  * @memberof GetPayTradeHistoryResponseDataInnerPayerInfo
94
74
  */
95
75
  type?: string;
96
76
  /**
97
- *
77
+ * Binance UID.
98
78
  * @type {string}
99
79
  * @memberof GetPayTradeHistoryResponseDataInnerPayerInfo
100
80
  */
@@ -105,7 +85,7 @@ interface GetPayTradeHistoryResponseDataInnerPayerInfo {
105
85
  /**
106
86
  * Binance Pay REST API
107
87
  *
108
- * OpenAPI Specification for the Binance Pay REST API
88
+ * Query Binance Pay transaction history.
109
89
  *
110
90
  * The version of the OpenAPI document: 1.0.0
111
91
  *
@@ -115,25 +95,25 @@ interface GetPayTradeHistoryResponseDataInnerPayerInfo {
115
95
  * Do not edit the class manually.
116
96
  */
117
97
  /**
118
- *
98
+ * Extension fields.
119
99
  * @export
120
100
  * @interface GetPayTradeHistoryResponseDataInnerReceiverInfoExtend
121
101
  */
122
102
  interface GetPayTradeHistoryResponseDataInnerReceiverInfoExtend {
123
103
  /**
124
- *
104
+ * Bank name or digital wallet name.
125
105
  * @type {string}
126
106
  * @memberof GetPayTradeHistoryResponseDataInnerReceiverInfoExtend
127
107
  */
128
108
  institutionName?: string;
129
109
  /**
130
- *
110
+ * Card number.
131
111
  * @type {string}
132
112
  * @memberof GetPayTradeHistoryResponseDataInnerReceiverInfoExtend
133
113
  */
134
114
  cardNumber?: string;
135
115
  /**
136
- *
116
+ * Digital wallet ID.
137
117
  * @type {string}
138
118
  * @memberof GetPayTradeHistoryResponseDataInnerReceiverInfoExtend
139
119
  */
@@ -148,49 +128,49 @@ interface GetPayTradeHistoryResponseDataInnerReceiverInfoExtend {
148
128
  */
149
129
  interface GetPayTradeHistoryResponseDataInnerReceiverInfo {
150
130
  /**
151
- *
131
+ * Nickname or merchant name.
152
132
  * @type {string}
153
133
  * @memberof GetPayTradeHistoryResponseDataInnerReceiverInfo
154
134
  */
155
135
  name?: string;
156
136
  /**
157
- *
137
+ * Account type: USER for personal, MERCHANT for merchant.
158
138
  * @type {string}
159
139
  * @memberof GetPayTradeHistoryResponseDataInnerReceiverInfo
160
140
  */
161
141
  type?: string;
162
142
  /**
163
- *
143
+ * Email.
164
144
  * @type {string}
165
145
  * @memberof GetPayTradeHistoryResponseDataInnerReceiverInfo
166
146
  */
167
147
  email?: string;
168
148
  /**
169
- *
149
+ * Binance UID.
170
150
  * @type {string}
171
151
  * @memberof GetPayTradeHistoryResponseDataInnerReceiverInfo
172
152
  */
173
153
  binanceId?: string;
174
154
  /**
175
- *
155
+ * Binance Pay ID.
176
156
  * @type {string}
177
157
  * @memberof GetPayTradeHistoryResponseDataInnerReceiverInfo
178
158
  */
179
159
  accountId?: string;
180
160
  /**
181
- *
161
+ * International area code.
182
162
  * @type {string}
183
163
  * @memberof GetPayTradeHistoryResponseDataInnerReceiverInfo
184
164
  */
185
165
  countryCode?: string;
186
166
  /**
187
- *
167
+ * Phone number.
188
168
  * @type {string}
189
169
  * @memberof GetPayTradeHistoryResponseDataInnerReceiverInfo
190
170
  */
191
171
  phoneNumber?: string;
192
172
  /**
193
- *
173
+ * Country code.
194
174
  * @type {string}
195
175
  * @memberof GetPayTradeHistoryResponseDataInnerReceiverInfo
196
176
  */
@@ -211,49 +191,49 @@ interface GetPayTradeHistoryResponseDataInnerReceiverInfo {
211
191
  */
212
192
  interface GetPayTradeHistoryResponseDataInner {
213
193
  /**
214
- *
194
+ * Order type. Enum: PAY, PAY_REFUND, C2C, CRYPTO_BOX, CRYPTO_BOX_RF, C2C_HOLDING, C2C_HOLDING_RF, PAYOUT, REMITTANCE.
215
195
  * @type {string}
216
196
  * @memberof GetPayTradeHistoryResponseDataInner
217
197
  */
218
198
  orderType?: string;
219
199
  /**
220
- *
200
+ * Transaction ID.
221
201
  * @type {string}
222
202
  * @memberof GetPayTradeHistoryResponseDataInner
223
203
  */
224
204
  transactionId?: string;
225
205
  /**
226
- *
206
+ * Trade timestamp.
227
207
  * @type {number | bigint}
228
208
  * @memberof GetPayTradeHistoryResponseDataInner
229
209
  */
230
210
  transactionTime?: number | bigint;
231
211
  /**
232
- *
212
+ * Order amount (up to 8 decimal places). Positive means income; negative means expenditure.
233
213
  * @type {string}
234
214
  * @memberof GetPayTradeHistoryResponseDataInner
235
215
  */
236
216
  amount?: string;
237
217
  /**
238
- *
218
+ * Order asset.
239
219
  * @type {string}
240
220
  * @memberof GetPayTradeHistoryResponseDataInner
241
221
  */
242
222
  currency?: string;
243
223
  /**
244
- *
224
+ * Main wallet type: 1=funding wallet, 2=spot wallet, 3=fiat wallet, 4 or 6=card payment, 5=earn wallet.
245
225
  * @type {number | bigint}
246
226
  * @memberof GetPayTradeHistoryResponseDataInner
247
227
  */
248
228
  walletType?: number | bigint;
249
229
  /**
250
- *
230
+ * Array format of wallet types. Multiple values may appear for combined payments.
251
231
  * @type {Array<number>}
252
232
  * @memberof GetPayTradeHistoryResponseDataInner
253
233
  */
254
234
  walletTypes?: Array<number>;
255
235
  /**
256
- *
236
+ * Funds usage details.
257
237
  * @type {Array<GetPayTradeHistoryResponseDataInnerFundsDetailInner>}
258
238
  * @memberof GetPayTradeHistoryResponseDataInner
259
239
  */
@@ -305,156 +285,110 @@ interface GetPayTradeHistoryResponse {
305
285
  success?: boolean;
306
286
  }
307
287
  //#endregion
308
- //#region src/rest-api/modules/pay-api.d.ts
288
+ //#region src/rest-api/modules/api.d.ts
309
289
  /**
310
- * PayApi - interface
311
- * @interface PayApi
290
+ * Api - interface
291
+ * @interface Api
312
292
  */
313
- interface PayApiInterface {
293
+ interface ApiInterface {
314
294
  /**
315
295
  * Get Pay Trade History
316
296
  *
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
297
+ * Weight(UID): 3000
298
+ *
299
+ * Notes:
300
+ * - If `startTime` and `endTime` are not sent, the recent 90 days' data will be returned.
301
+ * - The max interval between `startTime` and `endTime` is 90 days.
302
+ * - Support for querying orders within the last 18 months.
303
+ * - `payerInfo` and `receiverInfo` return different fields in different `orderType` values:
304
+ * - C2C sender: `payerInfo=binanceId`; `receiverInfo=name, binanceId/accountId/email/countryCode/phoneNumber/mobileCode` (based on user input).
305
+ * - C2C receiver: `payerInfo=name`; `receiverInfo=binanceId`.
306
+ * - CRYPTO_BOX sender: `payerInfo=binanceId`; `receiverInfo=name` (always `"Crypto Box"`).
307
+ * - CRYPTO_BOX receiver: `payerInfo=name`; `receiverInfo=binanceId`.
308
+ * - PAY sender: `payerInfo=binanceId`; `receiverInfo=name`.
309
+ * - PAY receiver: `payerInfo=name`; `receiverInfo=binanceId, name`.
310
+ * - PAY_REFUND sender: `payerInfo=binanceId, name`; `receiverInfo=name, accountId`.
311
+ * - PAY_REFUND receiver: `payerInfo=name`; `receiverInfo=binanceId`.
312
+ * - PAYOUT sender: `payerInfo=binanceId, name`; `receiverInfo=name, accountId`.
313
+ * - PAYOUT receiver: `payerInfo=name`; `receiverInfo=binanceId`.
314
+ * - CRYPTO_BOX_RF receiver: `payerInfo=name` (always `"Crypto Box"`); `receiverInfo=binanceId`.
315
+ * - REMITTANCE sender: `payerInfo=binanceId`; `receiverInfo=name, institutionName, cardNumber, digitalWalletId`.
359
316
  *
360
317
  * @summary Get Pay Trade History
361
318
  * @param {GetPayTradeHistoryRequest} requestParameters Request parameters.
362
319
  *
363
320
  * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError}
364
- * @memberof PayApiInterface
321
+ * @memberof ApiInterface
365
322
  */
366
323
  getPayTradeHistory(requestParameters?: GetPayTradeHistoryRequest): Promise<RestApiResponse<GetPayTradeHistoryResponse>>;
367
324
  }
368
325
  /**
369
- * Request parameters for getPayTradeHistory operation in PayApi.
326
+ * Request parameters for getPayTradeHistory operation in Api.
370
327
  * @interface GetPayTradeHistoryRequest
371
328
  */
372
329
  interface GetPayTradeHistoryRequest {
373
330
  /**
374
- *
331
+ * Start time in milliseconds.
375
332
  * @type {number | bigint}
376
- * @memberof PayApiGetPayTradeHistory
333
+ * @memberof ApiGetPayTradeHistory
377
334
  */
378
335
  readonly startTime?: number | bigint;
379
336
  /**
380
- *
337
+ * End time in milliseconds.
381
338
  * @type {number | bigint}
382
- * @memberof PayApiGetPayTradeHistory
339
+ * @memberof ApiGetPayTradeHistory
383
340
  */
384
341
  readonly endTime?: number | bigint;
385
342
  /**
386
- * default 100, max 100
343
+ * Number of records to return.
387
344
  * @type {number | bigint}
388
- * @memberof PayApiGetPayTradeHistory
345
+ * @memberof ApiGetPayTradeHistory
389
346
  */
390
347
  readonly limit?: number | bigint;
391
348
  /**
392
- *
349
+ * Request validity window in milliseconds.
393
350
  * @type {number | bigint}
394
- * @memberof PayApiGetPayTradeHistory
351
+ * @memberof ApiGetPayTradeHistory
395
352
  */
396
353
  readonly recvWindow?: number | bigint;
397
354
  }
398
355
  /**
399
- * PayApi - object-oriented interface
400
- * @class PayApi
356
+ * Api - object-oriented interface
357
+ * @class Api
401
358
  */
402
- declare class PayApi implements PayApiInterface {
359
+ declare class Api implements ApiInterface {
403
360
  private readonly configuration;
404
361
  private localVarAxiosParamCreator;
405
362
  constructor(configuration: ConfigurationRestAPI);
406
363
  /**
407
364
  * Get Pay Trade History
408
365
  *
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
366
+ * Weight(UID): 3000
367
+ *
368
+ * Notes:
369
+ * - If `startTime` and `endTime` are not sent, the recent 90 days' data will be returned.
370
+ * - The max interval between `startTime` and `endTime` is 90 days.
371
+ * - Support for querying orders within the last 18 months.
372
+ * - `payerInfo` and `receiverInfo` return different fields in different `orderType` values:
373
+ * - C2C sender: `payerInfo=binanceId`; `receiverInfo=name, binanceId/accountId/email/countryCode/phoneNumber/mobileCode` (based on user input).
374
+ * - C2C receiver: `payerInfo=name`; `receiverInfo=binanceId`.
375
+ * - CRYPTO_BOX sender: `payerInfo=binanceId`; `receiverInfo=name` (always `"Crypto Box"`).
376
+ * - CRYPTO_BOX receiver: `payerInfo=name`; `receiverInfo=binanceId`.
377
+ * - PAY sender: `payerInfo=binanceId`; `receiverInfo=name`.
378
+ * - PAY receiver: `payerInfo=name`; `receiverInfo=binanceId, name`.
379
+ * - PAY_REFUND sender: `payerInfo=binanceId, name`; `receiverInfo=name, accountId`.
380
+ * - PAY_REFUND receiver: `payerInfo=name`; `receiverInfo=binanceId`.
381
+ * - PAYOUT sender: `payerInfo=binanceId, name`; `receiverInfo=name, accountId`.
382
+ * - PAYOUT receiver: `payerInfo=name`; `receiverInfo=binanceId`.
383
+ * - CRYPTO_BOX_RF receiver: `payerInfo=name` (always `"Crypto Box"`); `receiverInfo=binanceId`.
384
+ * - REMITTANCE sender: `payerInfo=binanceId`; `receiverInfo=name, institutionName, cardNumber, digitalWalletId`.
451
385
  *
452
386
  * @summary Get Pay Trade History
453
387
  * @param {GetPayTradeHistoryRequest} requestParameters Request parameters.
454
388
  * @returns {Promise<RestApiResponse<GetPayTradeHistoryResponse>>}
455
389
  * @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}
390
+ * @memberof Api
391
+ * @see {@link https://developers.binance.com/en/docs/catalog/investment-and-services-pay/api/rest-api/~#get-pay-trade-history Binance API Documentation}
458
392
  */
459
393
  getPayTradeHistory(requestParameters?: GetPayTradeHistoryRequest): Promise<RestApiResponse<GetPayTradeHistoryResponse>>;
460
394
  }
@@ -462,7 +396,7 @@ declare class PayApi implements PayApiInterface {
462
396
  //#region src/rest-api/rest-api.d.ts
463
397
  declare class RestAPI {
464
398
  private configuration;
465
- private payApi;
399
+ private api;
466
400
  constructor(configuration: ConfigurationRestAPI);
467
401
  /**
468
402
  * Generic function to send a request.
@@ -487,60 +421,37 @@ declare class RestAPI {
487
421
  /**
488
422
  * Get Pay Trade History
489
423
  *
490
- * If startTime and endTime are not sent, the recent 90 days' data will be returned.
491
- * The max interval between startTime and endTime is 90 days.
492
- * Support for querying orders within the last 18 months.
493
- * For payerInfo and receiverInfo,there are different return values in different orderTypes.
494
- * Sender's perspective when orderType is C2C
495
- * payerInfo : binanceId
496
- * receiverInfo : name, binanceId/accountId/email/countryCode/phoneNumber/mobileCode (based on user input)
497
- * Receiver's perspective when orderType is C2C
498
- * payerInfo : name
499
- * receiverInfo : binanceId
500
- * Sender's perspective when orderType is CRYPTO_BOX
501
- * payerInfo : binanceId
502
- * receiverInfo : name(the value is always "Crypto Box")
503
- * Receiver's perspective when orderType is CRYPTO_BOX
504
- * payerInfo : name
505
- * receiverInfo : binanceId
506
- * Sender's perspective when orderType is PAY
507
- * payerInfo : binanceId
508
- * receiverInfo : name
509
- * Receiver's perspective when orderType is PAY
510
- * payerInfo : name
511
- * receiverInfo : binanceId, name
512
- * Sender's perspective when orderType is PAY_REFUND
513
- * payerInfo : binanceId, name
514
- * receiverInfo : name, accountId
515
- * Receiver's perspective when orderType is PAY_REFUND
516
- * payerInfo : name
517
- * receiverInfo : binanceId
518
- * Sender's perspective when orderType is PAYOUT
519
- * payerInfo : binanceId, name
520
- * receiverInfo : name, accountId
521
- * Receiver's perspective when orderType is PAYOUT
522
- * payerInfo : name
523
- * receiverInfo : binanceId
524
- * Receiver's perspective when orderType is CRYPTO_BOX_RF
525
- * payerInfo : name(the value is always "Crypto Box")
526
- * receiverInfo : binanceId
527
- * Sender's perspective when orderType is REMITTANCE
528
- * payerInfo : binanceId
529
- * receiverInfo : name, institutionName, cardNumber, digitalWalletId
530
- *
531
- * Weight: 3000
424
+ * Weight(UID): 3000
425
+ *
426
+ * Notes:
427
+ * - If `startTime` and `endTime` are not sent, the recent 90 days' data will be returned.
428
+ * - The max interval between `startTime` and `endTime` is 90 days.
429
+ * - Support for querying orders within the last 18 months.
430
+ * - `payerInfo` and `receiverInfo` return different fields in different `orderType` values:
431
+ * - C2C sender: `payerInfo=binanceId`; `receiverInfo=name, binanceId/accountId/email/countryCode/phoneNumber/mobileCode` (based on user input).
432
+ * - C2C receiver: `payerInfo=name`; `receiverInfo=binanceId`.
433
+ * - CRYPTO_BOX sender: `payerInfo=binanceId`; `receiverInfo=name` (always `"Crypto Box"`).
434
+ * - CRYPTO_BOX receiver: `payerInfo=name`; `receiverInfo=binanceId`.
435
+ * - PAY sender: `payerInfo=binanceId`; `receiverInfo=name`.
436
+ * - PAY receiver: `payerInfo=name`; `receiverInfo=binanceId, name`.
437
+ * - PAY_REFUND sender: `payerInfo=binanceId, name`; `receiverInfo=name, accountId`.
438
+ * - PAY_REFUND receiver: `payerInfo=name`; `receiverInfo=binanceId`.
439
+ * - PAYOUT sender: `payerInfo=binanceId, name`; `receiverInfo=name, accountId`.
440
+ * - PAYOUT receiver: `payerInfo=name`; `receiverInfo=binanceId`.
441
+ * - CRYPTO_BOX_RF receiver: `payerInfo=name` (always `"Crypto Box"`); `receiverInfo=binanceId`.
442
+ * - REMITTANCE sender: `payerInfo=binanceId`; `receiverInfo=name, institutionName, cardNumber, digitalWalletId`.
532
443
  *
533
444
  * @summary Get Pay Trade History
534
445
  * @param {GetPayTradeHistoryRequest} requestParameters Request parameters.
535
446
  *
536
447
  * @returns {Promise<RestApiResponse<GetPayTradeHistoryResponse>>}
537
448
  * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError}
538
- * @see {@link https://developers.binance.com/docs/pay/rest-api/Get-Pay-Trade-History Binance API Documentation}
449
+ * @see {@link https://developers.binance.com/en/docs/catalog/investment-and-services-pay/api/rest-api/~#get-pay-trade-history Binance API Documentation}
539
450
  */
540
451
  getPayTradeHistory(requestParameters?: GetPayTradeHistoryRequest): Promise<RestApiResponse<GetPayTradeHistoryResponse>>;
541
452
  }
542
453
  declare namespace index_d_exports {
543
- export { GetPayTradeHistoryRequest, GetPayTradeHistoryResponse, GetPayTradeHistoryResponseDataInner, GetPayTradeHistoryResponseDataInnerFundsDetailInner, GetPayTradeHistoryResponseDataInnerFundsDetailInnerWalletAssetCost, GetPayTradeHistoryResponseDataInnerPayerInfo, GetPayTradeHistoryResponseDataInnerReceiverInfo, GetPayTradeHistoryResponseDataInnerReceiverInfoExtend, PayApi, PayApiInterface, RestAPI };
454
+ export { Api, ApiInterface, GetPayTradeHistoryRequest, GetPayTradeHistoryResponse, GetPayTradeHistoryResponseDataInner, GetPayTradeHistoryResponseDataInnerFundsDetailInner, GetPayTradeHistoryResponseDataInnerPayerInfo, GetPayTradeHistoryResponseDataInnerReceiverInfo, GetPayTradeHistoryResponseDataInnerReceiverInfoExtend, RestAPI };
544
455
  }
545
456
  //#endregion
546
457
  //#region src/pay.d.ts