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