cashfree-pg 4.2.2 → 4.3.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/api.ts +12044 -3803
- package/common.ts +33 -1
- package/dist/api.d.ts +257 -183
- package/dist/api.js +10686 -3349
- package/dist/common.d.ts +6 -0
- package/dist/common.js +35 -1
- package/dist/esm/api.d.ts +257 -183
- package/dist/esm/api.js +10685 -3349
- package/dist/esm/common.d.ts +6 -0
- package/dist/esm/common.js +33 -0
- package/package.json +1 -1
package/dist/api.d.ts
CHANGED
|
@@ -528,61 +528,6 @@ export interface BanktransferPaymentMethod {
|
|
|
528
528
|
*/
|
|
529
529
|
'banktransfer': Banktransfer;
|
|
530
530
|
}
|
|
531
|
-
/**
|
|
532
|
-
* payment method card.
|
|
533
|
-
* @export
|
|
534
|
-
* @interface CARD
|
|
535
|
-
*/
|
|
536
|
-
export interface CARD {
|
|
537
|
-
/**
|
|
538
|
-
* Channel. can be link
|
|
539
|
-
* @type {string}
|
|
540
|
-
* @memberof CARD
|
|
541
|
-
*/
|
|
542
|
-
'channel'?: string;
|
|
543
|
-
/**
|
|
544
|
-
* Card number
|
|
545
|
-
* @type {string}
|
|
546
|
-
* @memberof CARD
|
|
547
|
-
*/
|
|
548
|
-
'card_number'?: string;
|
|
549
|
-
/**
|
|
550
|
-
* Card holder name
|
|
551
|
-
* @type {string}
|
|
552
|
-
* @memberof CARD
|
|
553
|
-
*/
|
|
554
|
-
'card_holder_name'?: string;
|
|
555
|
-
/**
|
|
556
|
-
* Card expiry month
|
|
557
|
-
* @type {string}
|
|
558
|
-
* @memberof CARD
|
|
559
|
-
*/
|
|
560
|
-
'card_expiry_mm'?: string;
|
|
561
|
-
/**
|
|
562
|
-
* Card expiry year
|
|
563
|
-
* @type {string}
|
|
564
|
-
* @memberof CARD
|
|
565
|
-
*/
|
|
566
|
-
'card_expiry_yy'?: string;
|
|
567
|
-
/**
|
|
568
|
-
* Card CVV
|
|
569
|
-
* @type {string}
|
|
570
|
-
* @memberof CARD
|
|
571
|
-
*/
|
|
572
|
-
'card_cvv'?: string;
|
|
573
|
-
/**
|
|
574
|
-
* Card network
|
|
575
|
-
* @type {string}
|
|
576
|
-
* @memberof CARD
|
|
577
|
-
*/
|
|
578
|
-
'card_network'?: string;
|
|
579
|
-
/**
|
|
580
|
-
* Card type
|
|
581
|
-
* @type {string}
|
|
582
|
-
* @memberof CARD
|
|
583
|
-
*/
|
|
584
|
-
'card_type'?: string;
|
|
585
|
-
}
|
|
586
531
|
/**
|
|
587
532
|
* Card Payment method
|
|
588
533
|
* @export
|
|
@@ -1373,12 +1318,171 @@ export interface CreateSubscriptionPaymentRequest {
|
|
|
1373
1318
|
*/
|
|
1374
1319
|
'payment_method'?: CreateSubscriptionPaymentRequestPaymentMethod;
|
|
1375
1320
|
}
|
|
1321
|
+
/**
|
|
1322
|
+
* payment method card.
|
|
1323
|
+
* @export
|
|
1324
|
+
* @interface CreateSubscriptionPaymentRequestCard
|
|
1325
|
+
*/
|
|
1326
|
+
export interface CreateSubscriptionPaymentRequestCard {
|
|
1327
|
+
/**
|
|
1328
|
+
* Channel. can be link
|
|
1329
|
+
* @type {string}
|
|
1330
|
+
* @memberof CreateSubscriptionPaymentRequestCard
|
|
1331
|
+
*/
|
|
1332
|
+
'channel'?: string;
|
|
1333
|
+
/**
|
|
1334
|
+
* Card number
|
|
1335
|
+
* @type {string}
|
|
1336
|
+
* @memberof CreateSubscriptionPaymentRequestCard
|
|
1337
|
+
*/
|
|
1338
|
+
'card_number'?: string;
|
|
1339
|
+
/**
|
|
1340
|
+
* Card holder name
|
|
1341
|
+
* @type {string}
|
|
1342
|
+
* @memberof CreateSubscriptionPaymentRequestCard
|
|
1343
|
+
*/
|
|
1344
|
+
'card_holder_name'?: string;
|
|
1345
|
+
/**
|
|
1346
|
+
* Card expiry month
|
|
1347
|
+
* @type {string}
|
|
1348
|
+
* @memberof CreateSubscriptionPaymentRequestCard
|
|
1349
|
+
*/
|
|
1350
|
+
'card_expiry_mm'?: string;
|
|
1351
|
+
/**
|
|
1352
|
+
* Card expiry year
|
|
1353
|
+
* @type {string}
|
|
1354
|
+
* @memberof CreateSubscriptionPaymentRequestCard
|
|
1355
|
+
*/
|
|
1356
|
+
'card_expiry_yy'?: string;
|
|
1357
|
+
/**
|
|
1358
|
+
* Card CVV
|
|
1359
|
+
* @type {string}
|
|
1360
|
+
* @memberof CreateSubscriptionPaymentRequestCard
|
|
1361
|
+
*/
|
|
1362
|
+
'card_cvv'?: string;
|
|
1363
|
+
/**
|
|
1364
|
+
* Card network
|
|
1365
|
+
* @type {string}
|
|
1366
|
+
* @memberof CreateSubscriptionPaymentRequestCard
|
|
1367
|
+
*/
|
|
1368
|
+
'card_network'?: string;
|
|
1369
|
+
/**
|
|
1370
|
+
* Card type
|
|
1371
|
+
* @type {string}
|
|
1372
|
+
* @memberof CreateSubscriptionPaymentRequestCard
|
|
1373
|
+
*/
|
|
1374
|
+
'card_type'?: string;
|
|
1375
|
+
}
|
|
1376
|
+
/**
|
|
1377
|
+
* payment method enach.
|
|
1378
|
+
* @export
|
|
1379
|
+
* @interface CreateSubscriptionPaymentRequestEnack
|
|
1380
|
+
*/
|
|
1381
|
+
export interface CreateSubscriptionPaymentRequestEnack {
|
|
1382
|
+
/**
|
|
1383
|
+
* Channel. can be link
|
|
1384
|
+
* @type {string}
|
|
1385
|
+
* @memberof CreateSubscriptionPaymentRequestEnack
|
|
1386
|
+
*/
|
|
1387
|
+
'channel'?: string;
|
|
1388
|
+
/**
|
|
1389
|
+
* Authentication mode. can be debit_card, aadhaar, or net_banking
|
|
1390
|
+
* @type {string}
|
|
1391
|
+
* @memberof CreateSubscriptionPaymentRequestEnack
|
|
1392
|
+
*/
|
|
1393
|
+
'auth_mode'?: string;
|
|
1394
|
+
/**
|
|
1395
|
+
* Account holder name
|
|
1396
|
+
* @type {string}
|
|
1397
|
+
* @memberof CreateSubscriptionPaymentRequestEnack
|
|
1398
|
+
*/
|
|
1399
|
+
'account_holder_name'?: string;
|
|
1400
|
+
/**
|
|
1401
|
+
* Account number
|
|
1402
|
+
* @type {string}
|
|
1403
|
+
* @memberof CreateSubscriptionPaymentRequestEnack
|
|
1404
|
+
*/
|
|
1405
|
+
'account_number'?: string;
|
|
1406
|
+
/**
|
|
1407
|
+
* Account bank code (required without AccountIFSC)
|
|
1408
|
+
* @type {string}
|
|
1409
|
+
* @memberof CreateSubscriptionPaymentRequestEnack
|
|
1410
|
+
*/
|
|
1411
|
+
'account_bank_code'?: string;
|
|
1412
|
+
/**
|
|
1413
|
+
* Account type
|
|
1414
|
+
* @type {string}
|
|
1415
|
+
* @memberof CreateSubscriptionPaymentRequestEnack
|
|
1416
|
+
*/
|
|
1417
|
+
'account_type'?: string;
|
|
1418
|
+
/**
|
|
1419
|
+
* Account IFSC
|
|
1420
|
+
* @type {string}
|
|
1421
|
+
* @memberof CreateSubscriptionPaymentRequestEnack
|
|
1422
|
+
*/
|
|
1423
|
+
'account_ifsc'?: string;
|
|
1424
|
+
}
|
|
1376
1425
|
/**
|
|
1377
1426
|
* @type CreateSubscriptionPaymentRequestPaymentMethod
|
|
1378
1427
|
* Payment method. Can be one of [\"upi\", \"enach\", \"pnach\", \"card\"]
|
|
1379
1428
|
* @export
|
|
1380
1429
|
*/
|
|
1381
|
-
export type CreateSubscriptionPaymentRequestPaymentMethod =
|
|
1430
|
+
export type CreateSubscriptionPaymentRequestPaymentMethod = CreateSubscriptionPaymentRequestCard | CreateSubscriptionPaymentRequestEnack | CreateSubscriptionPaymentRequestPnach | CreateSubscriptonPaymentRequestUpi;
|
|
1431
|
+
/**
|
|
1432
|
+
* payment method pnach.
|
|
1433
|
+
* @export
|
|
1434
|
+
* @interface CreateSubscriptionPaymentRequestPnach
|
|
1435
|
+
*/
|
|
1436
|
+
export interface CreateSubscriptionPaymentRequestPnach {
|
|
1437
|
+
/**
|
|
1438
|
+
* Channel. can be post
|
|
1439
|
+
* @type {string}
|
|
1440
|
+
* @memberof CreateSubscriptionPaymentRequestPnach
|
|
1441
|
+
*/
|
|
1442
|
+
'channel'?: string;
|
|
1443
|
+
/**
|
|
1444
|
+
* Account holder name
|
|
1445
|
+
* @type {string}
|
|
1446
|
+
* @memberof CreateSubscriptionPaymentRequestPnach
|
|
1447
|
+
*/
|
|
1448
|
+
'account_holder_name'?: string;
|
|
1449
|
+
/**
|
|
1450
|
+
* Account number
|
|
1451
|
+
* @type {string}
|
|
1452
|
+
* @memberof CreateSubscriptionPaymentRequestPnach
|
|
1453
|
+
*/
|
|
1454
|
+
'account_number'?: string;
|
|
1455
|
+
/**
|
|
1456
|
+
* Account bank code
|
|
1457
|
+
* @type {string}
|
|
1458
|
+
* @memberof CreateSubscriptionPaymentRequestPnach
|
|
1459
|
+
*/
|
|
1460
|
+
'account_bank_code'?: string;
|
|
1461
|
+
/**
|
|
1462
|
+
* Account type
|
|
1463
|
+
* @type {string}
|
|
1464
|
+
* @memberof CreateSubscriptionPaymentRequestPnach
|
|
1465
|
+
*/
|
|
1466
|
+
'account_type'?: string;
|
|
1467
|
+
/**
|
|
1468
|
+
* Account IFSC
|
|
1469
|
+
* @type {string}
|
|
1470
|
+
* @memberof CreateSubscriptionPaymentRequestPnach
|
|
1471
|
+
*/
|
|
1472
|
+
'account_ifsc'?: string;
|
|
1473
|
+
/**
|
|
1474
|
+
* Mandate creation date
|
|
1475
|
+
* @type {string}
|
|
1476
|
+
* @memberof CreateSubscriptionPaymentRequestPnach
|
|
1477
|
+
*/
|
|
1478
|
+
'mandate_creation_date'?: string;
|
|
1479
|
+
/**
|
|
1480
|
+
* Mandate start date
|
|
1481
|
+
* @type {string}
|
|
1482
|
+
* @memberof CreateSubscriptionPaymentRequestPnach
|
|
1483
|
+
*/
|
|
1484
|
+
'mandate_start_date'?: string;
|
|
1485
|
+
}
|
|
1382
1486
|
/**
|
|
1383
1487
|
* The response returned is Create Subscription Auth or Charge APIs.
|
|
1384
1488
|
* @export
|
|
@@ -1667,6 +1771,25 @@ export interface CreateSubscriptionRequestSubscriptionMeta {
|
|
|
1667
1771
|
*/
|
|
1668
1772
|
'notification_channel'?: Array<string>;
|
|
1669
1773
|
}
|
|
1774
|
+
/**
|
|
1775
|
+
* payment method upi.
|
|
1776
|
+
* @export
|
|
1777
|
+
* @interface CreateSubscriptonPaymentRequestUpi
|
|
1778
|
+
*/
|
|
1779
|
+
export interface CreateSubscriptonPaymentRequestUpi {
|
|
1780
|
+
/**
|
|
1781
|
+
*
|
|
1782
|
+
* @type {string}
|
|
1783
|
+
* @memberof CreateSubscriptonPaymentRequestUpi
|
|
1784
|
+
*/
|
|
1785
|
+
'upi_id'?: string;
|
|
1786
|
+
/**
|
|
1787
|
+
* Channel. can be link, qrcode, or collect
|
|
1788
|
+
* @type {string}
|
|
1789
|
+
* @memberof CreateSubscriptonPaymentRequestUpi
|
|
1790
|
+
*/
|
|
1791
|
+
'channel'?: string;
|
|
1792
|
+
}
|
|
1670
1793
|
/**
|
|
1671
1794
|
* Request body to create a terminal
|
|
1672
1795
|
* @export
|
|
@@ -2220,55 +2343,6 @@ export interface EMIPlansArray {
|
|
|
2220
2343
|
*/
|
|
2221
2344
|
'total_amount'?: number;
|
|
2222
2345
|
}
|
|
2223
|
-
/**
|
|
2224
|
-
* payment method enach.
|
|
2225
|
-
* @export
|
|
2226
|
-
* @interface ENACH
|
|
2227
|
-
*/
|
|
2228
|
-
export interface ENACH {
|
|
2229
|
-
/**
|
|
2230
|
-
* Channel. can be link
|
|
2231
|
-
* @type {string}
|
|
2232
|
-
* @memberof ENACH
|
|
2233
|
-
*/
|
|
2234
|
-
'channel'?: string;
|
|
2235
|
-
/**
|
|
2236
|
-
* Authentication mode. can be debit_card, aadhaar, or net_banking
|
|
2237
|
-
* @type {string}
|
|
2238
|
-
* @memberof ENACH
|
|
2239
|
-
*/
|
|
2240
|
-
'auth_mode'?: string;
|
|
2241
|
-
/**
|
|
2242
|
-
* Account holder name
|
|
2243
|
-
* @type {string}
|
|
2244
|
-
* @memberof ENACH
|
|
2245
|
-
*/
|
|
2246
|
-
'account_holder_name'?: string;
|
|
2247
|
-
/**
|
|
2248
|
-
* Account number
|
|
2249
|
-
* @type {string}
|
|
2250
|
-
* @memberof ENACH
|
|
2251
|
-
*/
|
|
2252
|
-
'account_number'?: string;
|
|
2253
|
-
/**
|
|
2254
|
-
* Account bank code (required without AccountIFSC)
|
|
2255
|
-
* @type {string}
|
|
2256
|
-
* @memberof ENACH
|
|
2257
|
-
*/
|
|
2258
|
-
'account_bank_code'?: string;
|
|
2259
|
-
/**
|
|
2260
|
-
* Account type
|
|
2261
|
-
* @type {string}
|
|
2262
|
-
* @memberof ENACH
|
|
2263
|
-
*/
|
|
2264
|
-
'account_type'?: string;
|
|
2265
|
-
/**
|
|
2266
|
-
* Account IFSC
|
|
2267
|
-
* @type {string}
|
|
2268
|
-
* @memberof ENACH
|
|
2269
|
-
*/
|
|
2270
|
-
'account_ifsc'?: string;
|
|
2271
|
-
}
|
|
2272
2346
|
/**
|
|
2273
2347
|
* ES Order Recon Request
|
|
2274
2348
|
* @export
|
|
@@ -4280,61 +4354,6 @@ export interface OrderPayData {
|
|
|
4280
4354
|
*/
|
|
4281
4355
|
'method'?: string;
|
|
4282
4356
|
}
|
|
4283
|
-
/**
|
|
4284
|
-
* payment method pnach.
|
|
4285
|
-
* @export
|
|
4286
|
-
* @interface PNACH
|
|
4287
|
-
*/
|
|
4288
|
-
export interface PNACH {
|
|
4289
|
-
/**
|
|
4290
|
-
* Channel. can be post
|
|
4291
|
-
* @type {string}
|
|
4292
|
-
* @memberof PNACH
|
|
4293
|
-
*/
|
|
4294
|
-
'channel'?: string;
|
|
4295
|
-
/**
|
|
4296
|
-
* Account holder name
|
|
4297
|
-
* @type {string}
|
|
4298
|
-
* @memberof PNACH
|
|
4299
|
-
*/
|
|
4300
|
-
'account_holder_name'?: string;
|
|
4301
|
-
/**
|
|
4302
|
-
* Account number
|
|
4303
|
-
* @type {string}
|
|
4304
|
-
* @memberof PNACH
|
|
4305
|
-
*/
|
|
4306
|
-
'account_number'?: string;
|
|
4307
|
-
/**
|
|
4308
|
-
* Account bank code
|
|
4309
|
-
* @type {string}
|
|
4310
|
-
* @memberof PNACH
|
|
4311
|
-
*/
|
|
4312
|
-
'account_bank_code'?: string;
|
|
4313
|
-
/**
|
|
4314
|
-
* Account type
|
|
4315
|
-
* @type {string}
|
|
4316
|
-
* @memberof PNACH
|
|
4317
|
-
*/
|
|
4318
|
-
'account_type'?: string;
|
|
4319
|
-
/**
|
|
4320
|
-
* Account IFSC
|
|
4321
|
-
* @type {string}
|
|
4322
|
-
* @memberof PNACH
|
|
4323
|
-
*/
|
|
4324
|
-
'account_ifsc'?: string;
|
|
4325
|
-
/**
|
|
4326
|
-
* Mandate creation date
|
|
4327
|
-
* @type {string}
|
|
4328
|
-
* @memberof PNACH
|
|
4329
|
-
*/
|
|
4330
|
-
'mandate_creation_date'?: string;
|
|
4331
|
-
/**
|
|
4332
|
-
* Mandate start date
|
|
4333
|
-
* @type {string}
|
|
4334
|
-
* @memberof PNACH
|
|
4335
|
-
*/
|
|
4336
|
-
'mandate_start_date'?: string;
|
|
4337
|
-
}
|
|
4338
4357
|
/**
|
|
4339
4358
|
* Order Pay response once you create a transaction for that order
|
|
4340
4359
|
* @export
|
|
@@ -7305,10 +7324,10 @@ export interface TerminalEntity {
|
|
|
7305
7324
|
'terminal_status'?: string;
|
|
7306
7325
|
/**
|
|
7307
7326
|
*
|
|
7308
|
-
* @type {
|
|
7327
|
+
* @type {CreateTerminalRequestTerminalMeta}
|
|
7309
7328
|
* @memberof TerminalEntity
|
|
7310
7329
|
*/
|
|
7311
|
-
'terminal_meta'?:
|
|
7330
|
+
'terminal_meta'?: CreateTerminalRequestTerminalMeta;
|
|
7312
7331
|
}
|
|
7313
7332
|
/**
|
|
7314
7333
|
* terminal payment entity full object
|
|
@@ -7554,25 +7573,6 @@ export interface TransferDetailsTagsInner {
|
|
|
7554
7573
|
*/
|
|
7555
7574
|
'size'?: number;
|
|
7556
7575
|
}
|
|
7557
|
-
/**
|
|
7558
|
-
* payment method upi.
|
|
7559
|
-
* @export
|
|
7560
|
-
* @interface UPI
|
|
7561
|
-
*/
|
|
7562
|
-
export interface UPI {
|
|
7563
|
-
/**
|
|
7564
|
-
*
|
|
7565
|
-
* @type {string}
|
|
7566
|
-
* @memberof UPI
|
|
7567
|
-
*/
|
|
7568
|
-
'upi_id'?: string;
|
|
7569
|
-
/**
|
|
7570
|
-
* Channel. can be link, qrcode, or collect
|
|
7571
|
-
* @type {string}
|
|
7572
|
-
* @memberof UPI
|
|
7573
|
-
*/
|
|
7574
|
-
'channel'?: string;
|
|
7575
|
-
}
|
|
7576
7576
|
/**
|
|
7577
7577
|
* object when you are using preauth in UPI in order pay
|
|
7578
7578
|
* @export
|
|
@@ -7685,10 +7685,10 @@ export interface UpdateTerminalEntity {
|
|
|
7685
7685
|
'terminal_status'?: string;
|
|
7686
7686
|
/**
|
|
7687
7687
|
*
|
|
7688
|
-
* @type {
|
|
7688
|
+
* @type {CreateTerminalRequestTerminalMeta}
|
|
7689
7689
|
* @memberof UpdateTerminalEntity
|
|
7690
7690
|
*/
|
|
7691
|
-
'terminal_meta'?:
|
|
7691
|
+
'terminal_meta'?: CreateTerminalRequestTerminalMeta;
|
|
7692
7692
|
}
|
|
7693
7693
|
/**
|
|
7694
7694
|
* Request body to update terminal details.
|
|
@@ -8414,6 +8414,14 @@ export declare class PGWebhookEvent {
|
|
|
8414
8414
|
object: any;
|
|
8415
8415
|
constructor(type: string, rawBody: string, object: any);
|
|
8416
8416
|
}
|
|
8417
|
+
export declare class CashfreeConfiguration {
|
|
8418
|
+
XClientId?: string;
|
|
8419
|
+
XClientSecret?: string;
|
|
8420
|
+
XPartnerKey?: string;
|
|
8421
|
+
XClientSignature?: string;
|
|
8422
|
+
XPartnerMerchantId?: string;
|
|
8423
|
+
constructor(XClientId: string, XClientSecret: string, XPartnerKey: string, XClientSignature: string, XPartnerMerchantId: string);
|
|
8424
|
+
}
|
|
8417
8425
|
export declare class Cashfree {
|
|
8418
8426
|
static axios: AxiosInstance;
|
|
8419
8427
|
static basePath: string;
|
|
@@ -8447,6 +8455,7 @@ export declare class Cashfree {
|
|
|
8447
8455
|
* @memberof CustomersApi
|
|
8448
8456
|
*/
|
|
8449
8457
|
static PGCreateCustomer(x_api_version: string, CreateCustomerRequest: CreateCustomerRequest, x_request_id?: string, x_idempotency_key?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CustomerEntity, any>>;
|
|
8458
|
+
static PGCreateCustomerWithConfiguration(cashfreeConfiguration: CashfreeConfiguration, x_api_version: string, CreateCustomerRequest: CreateCustomerRequest, x_request_id?: string, x_idempotency_key?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CustomerEntity, any>>;
|
|
8450
8459
|
/**
|
|
8451
8460
|
* The Create On Demand Transfer API will create a new on-demand request either from to the merchant or from to the vendor.
|
|
8452
8461
|
* @summary Create On Demand Transfer
|
|
@@ -8460,6 +8469,7 @@ export declare class Cashfree {
|
|
|
8460
8469
|
* @memberof EasySplitApi
|
|
8461
8470
|
*/
|
|
8462
8471
|
static PGESCreateOnDemandTransfer(x_api_version: string, vendor_id: string, x_request_id?: string, x_idempotency_key?: string, AdjustVendorBalanceRequest?: AdjustVendorBalanceRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<AdjustVendorBalanceResponse, any>>;
|
|
8472
|
+
static PGESCreateOnDemandTransferWithConfiguration(cashfreeConfiguration: CashfreeConfiguration, x_api_version: string, vendor_id: string, x_request_id?: string, x_idempotency_key?: string, AdjustVendorBalanceRequest?: AdjustVendorBalanceRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<AdjustVendorBalanceResponse, any>>;
|
|
8463
8473
|
/**
|
|
8464
8474
|
* Use this API to create a new vendor to your EasySplit account along with the KYC details. Provide KYC details such as account_type, business_type, gst, cin, pan, passport number and so on.
|
|
8465
8475
|
* @summary Create vendor
|
|
@@ -8472,6 +8482,7 @@ export declare class Cashfree {
|
|
|
8472
8482
|
* @memberof EasySplitApi
|
|
8473
8483
|
*/
|
|
8474
8484
|
static PGESCreateVendors(x_api_version: string, x_request_id?: string, x_idempotency_key?: string, CreateVendorRequest?: CreateVendorRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateVendorResponse, any>>;
|
|
8485
|
+
static PGESCreateVendorsWithConfiguration(cashfreeConfiguration: CashfreeConfiguration, x_api_version: string, x_request_id?: string, x_idempotency_key?: string, CreateVendorRequest?: CreateVendorRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateVendorResponse, any>>;
|
|
8475
8486
|
/**
|
|
8476
8487
|
* Use this API to download the uploaded KYC documents of that particular vendor. Provide the document type. Click the link from the sample request to download the KYC document.
|
|
8477
8488
|
* @summary Download Vendor Documents
|
|
@@ -8485,6 +8496,7 @@ export declare class Cashfree {
|
|
|
8485
8496
|
* @memberof EasySplitApi
|
|
8486
8497
|
*/
|
|
8487
8498
|
static PGESDownloadVendorsDocs(x_api_version: string, doc_type: string, vendor_id: string, x_request_id?: string, x_idempotency_key?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<VendorDocumentDownloadResponse, any>>;
|
|
8499
|
+
static PGESDownloadVendorsDocsWithConfiguration(cashfreeConfiguration: CashfreeConfiguration, x_api_version: string, doc_type: string, vendor_id: string, x_request_id?: string, x_idempotency_key?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<VendorDocumentDownloadResponse, any>>;
|
|
8488
8500
|
/**
|
|
8489
8501
|
* Use this API to get the details of a specific vendor associated with your Easy Split account.
|
|
8490
8502
|
* @summary Get Vendor All Details
|
|
@@ -8497,6 +8509,7 @@ export declare class Cashfree {
|
|
|
8497
8509
|
* @memberof EasySplitApi
|
|
8498
8510
|
*/
|
|
8499
8511
|
static PGESFetchVendors(x_api_version: string, vendor_id: string, x_request_id?: string, x_idempotency_key?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<VendorEntity, any>>;
|
|
8512
|
+
static PGESFetchVendorsWithConfiguration(cashfreeConfiguration: CashfreeConfiguration, x_api_version: string, vendor_id: string, x_request_id?: string, x_idempotency_key?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<VendorEntity, any>>;
|
|
8500
8513
|
/**
|
|
8501
8514
|
* This API fetches the available amount with the merchant, vendor, and the unsettled amount for the merchant as well as the vendor.
|
|
8502
8515
|
* @summary Get On Demand Balance
|
|
@@ -8509,6 +8522,7 @@ export declare class Cashfree {
|
|
|
8509
8522
|
* @memberof EasySplitApi
|
|
8510
8523
|
*/
|
|
8511
8524
|
static PGESGetVendorBalance(x_api_version: string, vendor_id: string, x_request_id?: string, x_idempotency_key?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<VendorBalance, any>>;
|
|
8525
|
+
static PGESGetVendorBalanceWithConfiguration(cashfreeConfiguration: CashfreeConfiguration, x_api_version: string, vendor_id: string, x_request_id?: string, x_idempotency_key?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<VendorBalance, any>>;
|
|
8512
8526
|
/**
|
|
8513
8527
|
* This API returns the applicable service charge and service tax for a vendor balance transfer, based on the provided amount and rate type.
|
|
8514
8528
|
* @summary Get Vendor Balance Transfer Charges
|
|
@@ -8522,6 +8536,7 @@ export declare class Cashfree {
|
|
|
8522
8536
|
* @memberof EasySplitApi
|
|
8523
8537
|
*/
|
|
8524
8538
|
static PGESGetVendorBalanceTransferCharges(x_api_version: string, amount: number, rate_type: string, x_request_id?: string, x_idempotency_key?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<VendorBalanceTransferCharges, any>>;
|
|
8539
|
+
static PGESGetVendorBalanceTransferChargesWithConfiguration(cashfreeConfiguration: CashfreeConfiguration, x_api_version: string, amount: number, rate_type: string, x_request_id?: string, x_idempotency_key?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<VendorBalanceTransferCharges, any>>;
|
|
8525
8540
|
/**
|
|
8526
8541
|
* Use this API to fetch the details of all the KYC details of a particular vendor.
|
|
8527
8542
|
* @summary Get Vendor All Documents Status
|
|
@@ -8534,6 +8549,7 @@ export declare class Cashfree {
|
|
|
8534
8549
|
* @memberof EasySplitApi
|
|
8535
8550
|
*/
|
|
8536
8551
|
static PGESGetVendorsDocs(x_api_version: string, vendor_id: string, x_request_id?: string, x_idempotency_key?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<VendorDocumentsResponse, any>>;
|
|
8552
|
+
static PGESGetVendorsDocsWithConfiguration(cashfreeConfiguration: CashfreeConfiguration, x_api_version: string, vendor_id: string, x_request_id?: string, x_idempotency_key?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<VendorDocumentsResponse, any>>;
|
|
8537
8553
|
/**
|
|
8538
8554
|
* Use this API to get all the split details, settled and unsettled transactions details of each vendor who were part of a particular order by providing order Id or start date and end date.
|
|
8539
8555
|
* @summary Get Split and Settlement Details by OrderID v2.0
|
|
@@ -8546,6 +8562,7 @@ export declare class Cashfree {
|
|
|
8546
8562
|
* @memberof EasySplitApi
|
|
8547
8563
|
*/
|
|
8548
8564
|
static PGESOrderRecon(x_api_version: string, x_request_id?: string, x_idempotency_key?: string, ESOrderReconRequest?: ESOrderReconRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ESOrderReconResponse, any>>;
|
|
8565
|
+
static PGESOrderReconWithConfiguration(cashfreeConfiguration: CashfreeConfiguration, x_api_version: string, x_request_id?: string, x_idempotency_key?: string, ESOrderReconRequest?: ESOrderReconRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ESOrderReconResponse, any>>;
|
|
8549
8566
|
/**
|
|
8550
8567
|
* Use this API to edit the existing vendor details added to your EasySplit account. You can edit vendor details such as name, email, phone number, upi details, and any of the KYC details.
|
|
8551
8568
|
* @summary Update vendor Details
|
|
@@ -8559,6 +8576,7 @@ export declare class Cashfree {
|
|
|
8559
8576
|
* @memberof EasySplitApi
|
|
8560
8577
|
*/
|
|
8561
8578
|
static PGESUpdateVendors(x_api_version: string, vendor_id: string, x_request_id?: string, x_idempotency_key?: string, UpdateVendorRequest?: UpdateVendorRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdateVendorResponse, any>>;
|
|
8579
|
+
static PGESUpdateVendorsWithConfiguration(cashfreeConfiguration: CashfreeConfiguration, x_api_version: string, vendor_id: string, x_request_id?: string, x_idempotency_key?: string, UpdateVendorRequest?: UpdateVendorRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdateVendorResponse, any>>;
|
|
8562
8580
|
/**
|
|
8563
8581
|
* Use this API to upload KYC documents of a specific vendor.
|
|
8564
8582
|
* @summary Upload Vendor Docs
|
|
@@ -8574,6 +8592,7 @@ export declare class Cashfree {
|
|
|
8574
8592
|
* @memberof EasySplitApi
|
|
8575
8593
|
*/
|
|
8576
8594
|
static PGESUploadVendorsDocs(x_api_version: string, vendor_id: string, x_request_id?: string, x_idempotency_key?: string, doc_type?: string, doc_value?: string, file?: File, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UploadVendorDocumentsResponse, any>>;
|
|
8595
|
+
static PGESUploadVendorsDocsWithConfiguration(cashfreeConfiguration: CashfreeConfiguration, x_api_version: string, vendor_id: string, x_request_id?: string, x_idempotency_key?: string, doc_type?: string, doc_value?: string, file?: File, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UploadVendorDocumentsResponse, any>>;
|
|
8577
8596
|
/**
|
|
8578
8597
|
* Split After Payment API splits the payments to vendors after successful payment from the customers.
|
|
8579
8598
|
* @summary Split After Payment
|
|
@@ -8587,6 +8606,7 @@ export declare class Cashfree {
|
|
|
8587
8606
|
* @memberof EasySplitApi
|
|
8588
8607
|
*/
|
|
8589
8608
|
static PGOrderSplitAfterPayment(x_api_version: string, order_id: string, x_request_id?: string, x_idempotency_key?: string, SplitAfterPaymentRequest?: SplitAfterPaymentRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SplitAfterPaymentResponse, any>>;
|
|
8609
|
+
static PGOrderSplitAfterPaymentWithConfiguration(cashfreeConfiguration: CashfreeConfiguration, x_api_version: string, order_id: string, x_request_id?: string, x_idempotency_key?: string, SplitAfterPaymentRequest?: SplitAfterPaymentRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SplitAfterPaymentResponse, any>>;
|
|
8590
8610
|
/**
|
|
8591
8611
|
* This API will create a static split scheme wherein you can define the split type and the vendor-wise split percentage.
|
|
8592
8612
|
* @summary Create Static Split Configuration
|
|
@@ -8599,6 +8619,7 @@ export declare class Cashfree {
|
|
|
8599
8619
|
* @memberof EasySplitApi
|
|
8600
8620
|
*/
|
|
8601
8621
|
static PGOrderStaticSplit(x_api_version: string, x_request_id?: string, x_idempotency_key?: string, StaticSplitRequest?: StaticSplitRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<StaticSplitResponse, any>>;
|
|
8622
|
+
static PGOrderStaticSplitWithConfiguration(cashfreeConfiguration: CashfreeConfiguration, x_api_version: string, x_request_id?: string, x_idempotency_key?: string, StaticSplitRequest?: StaticSplitRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<StaticSplitResponse, any>>;
|
|
8602
8623
|
/**
|
|
8603
8624
|
* Use this API to get eligible Cardless EMI Payment Methods available for a customer on an order basis their phone number.
|
|
8604
8625
|
* @summary Get Eligible Cardless EMI Payment Methods for a customer on an order
|
|
@@ -8611,6 +8632,7 @@ export declare class Cashfree {
|
|
|
8611
8632
|
* @memberof EligibilityApi
|
|
8612
8633
|
*/
|
|
8613
8634
|
static PGEligibilityFetchCardlessEMI(x_api_version: string, EligibilityFetchCardlessEMIRequest: EligibilityFetchCardlessEMIRequest, x_request_id?: string, x_idempotency_key?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<EligibilityCardlessEMIEntity[], any>>;
|
|
8635
|
+
static PGEligibilityFetchCardlessEMIWithConfiguration(cashfreeConfiguration: CashfreeConfiguration, x_api_version: string, EligibilityFetchCardlessEMIRequest: EligibilityFetchCardlessEMIRequest, x_request_id?: string, x_idempotency_key?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<EligibilityCardlessEMIEntity[], any>>;
|
|
8614
8636
|
/**
|
|
8615
8637
|
* Use this API to get eligible offers for an order_id or order amount.
|
|
8616
8638
|
* @summary Get Eligible Offers for an Order
|
|
@@ -8623,6 +8645,7 @@ export declare class Cashfree {
|
|
|
8623
8645
|
* @memberof EligibilityApi
|
|
8624
8646
|
*/
|
|
8625
8647
|
static PGEligibilityFetchOffers(x_api_version: string, EligibilityFetchOffersRequest: EligibilityFetchOffersRequest, x_request_id?: string, x_idempotency_key?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<EligibilityOfferEntity[], any>>;
|
|
8648
|
+
static PGEligibilityFetchOffersWithConfiguration(cashfreeConfiguration: CashfreeConfiguration, x_api_version: string, EligibilityFetchOffersRequest: EligibilityFetchOffersRequest, x_request_id?: string, x_idempotency_key?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<EligibilityOfferEntity[], any>>;
|
|
8626
8649
|
/**
|
|
8627
8650
|
* Use this API to get eligible Paylater Payment Methods for a customer on an order.
|
|
8628
8651
|
* @summary Get Eligible Paylater for a customer on an order
|
|
@@ -8635,6 +8658,7 @@ export declare class Cashfree {
|
|
|
8635
8658
|
* @memberof EligibilityApi
|
|
8636
8659
|
*/
|
|
8637
8660
|
static PGEligibilityFetchPaylater(x_api_version: string, EligibilityFetchPaylaterRequest: EligibilityFetchPaylaterRequest, x_request_id?: string, x_idempotency_key?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<EligibilityPaylaterEntity[], any>>;
|
|
8661
|
+
static PGEligibilityFetchPaylaterWithConfiguration(cashfreeConfiguration: CashfreeConfiguration, x_api_version: string, EligibilityFetchPaylaterRequest: EligibilityFetchPaylaterRequest, x_request_id?: string, x_idempotency_key?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<EligibilityPaylaterEntity[], any>>;
|
|
8638
8662
|
/**
|
|
8639
8663
|
* Use this API to get eligible Payment Methods
|
|
8640
8664
|
* @summary Get eligible Payment Methods
|
|
@@ -8647,6 +8671,7 @@ export declare class Cashfree {
|
|
|
8647
8671
|
* @memberof EligibilityApi
|
|
8648
8672
|
*/
|
|
8649
8673
|
static PGEligibilityFetchPaymentMethods(x_api_version: string, EligibilityFetchPaymentMethodsRequest: EligibilityFetchPaymentMethodsRequest, x_request_id?: string, x_idempotency_key?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<EligibilityPaymentMethodsEntity[], any>>;
|
|
8674
|
+
static PGEligibilityFetchPaymentMethodsWithConfiguration(cashfreeConfiguration: CashfreeConfiguration, x_api_version: string, EligibilityFetchPaymentMethodsRequest: EligibilityFetchPaymentMethodsRequest, x_request_id?: string, x_idempotency_key?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<EligibilityPaymentMethodsEntity[], any>>;
|
|
8650
8675
|
/**
|
|
8651
8676
|
* Use this API to create offers with Cashfree from your backend
|
|
8652
8677
|
* @summary Create Offer
|
|
@@ -8659,6 +8684,7 @@ export declare class Cashfree {
|
|
|
8659
8684
|
* @memberof OffersApi
|
|
8660
8685
|
*/
|
|
8661
8686
|
static PGCreateOffer(x_api_version: string, CreateOfferRequest: CreateOfferRequest, x_request_id?: string, x_idempotency_key?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<OfferEntity, any>>;
|
|
8687
|
+
static PGCreateOfferWithConfiguration(cashfreeConfiguration: CashfreeConfiguration, x_api_version: string, CreateOfferRequest: CreateOfferRequest, x_request_id?: string, x_idempotency_key?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<OfferEntity, any>>;
|
|
8662
8688
|
/**
|
|
8663
8689
|
* Use this API to get offer by offer_id
|
|
8664
8690
|
* @summary Get Offer by ID
|
|
@@ -8671,6 +8697,7 @@ export declare class Cashfree {
|
|
|
8671
8697
|
* @memberof OffersApi
|
|
8672
8698
|
*/
|
|
8673
8699
|
static PGFetchOffer(x_api_version: string, offer_id: string, x_request_id?: string, x_idempotency_key?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<OfferEntity, any>>;
|
|
8700
|
+
static PGFetchOfferWithConfiguration(cashfreeConfiguration: CashfreeConfiguration, x_api_version: string, offer_id: string, x_request_id?: string, x_idempotency_key?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<OfferEntity, any>>;
|
|
8674
8701
|
/**
|
|
8675
8702
|
* ### Order An order is an entity which has a amount and currency associated with it. It is something for which you want to collect payment for. Use this API to create orders with Cashfree from your backend to get a `payment_sessions_id`. You can use the `payment_sessions_id` to create a transaction for the order.
|
|
8676
8703
|
* @summary Create Order
|
|
@@ -8683,6 +8710,7 @@ export declare class Cashfree {
|
|
|
8683
8710
|
* @memberof OrdersApi
|
|
8684
8711
|
*/
|
|
8685
8712
|
static PGCreateOrder(x_api_version: string, CreateOrderRequest: CreateOrderRequest, x_request_id?: string, x_idempotency_key?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<OrderEntity, any>>;
|
|
8713
|
+
static PGCreateOrderWithConfiguration(cashfreeConfiguration: CashfreeConfiguration, x_api_version: string, CreateOrderRequest: CreateOrderRequest, x_request_id?: string, x_idempotency_key?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<OrderEntity, any>>;
|
|
8686
8714
|
/**
|
|
8687
8715
|
* Use this API to fetch the order that was created at Cashfree\'s using the `order_id`. ## When to use this API - To check the status of your order - Once the order is PAID - Once your customer returns to `return_url`
|
|
8688
8716
|
* @summary Get Order
|
|
@@ -8695,6 +8723,7 @@ export declare class Cashfree {
|
|
|
8695
8723
|
* @memberof OrdersApi
|
|
8696
8724
|
*/
|
|
8697
8725
|
static PGFetchOrder(x_api_version: string, order_id: string, x_request_id?: string, x_idempotency_key?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<OrderEntity, any>>;
|
|
8726
|
+
static PGFetchOrderWithConfiguration(cashfreeConfiguration: CashfreeConfiguration, x_api_version: string, order_id: string, x_request_id?: string, x_idempotency_key?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<OrderEntity, any>>;
|
|
8698
8727
|
/**
|
|
8699
8728
|
* Use this API to terminate the order that was created at Cashfree\'s using the `order_id`.
|
|
8700
8729
|
* @summary Terminate Order
|
|
@@ -8708,6 +8737,7 @@ export declare class Cashfree {
|
|
|
8708
8737
|
* @memberof OrdersApi
|
|
8709
8738
|
*/
|
|
8710
8739
|
static PGTerminateOrder(x_api_version: string, order_id: string, TerminateOrderRequest: TerminateOrderRequest, x_request_id?: string, x_idempotency_key?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<OrderEntity, any>>;
|
|
8740
|
+
static PGTerminateOrderWithConfiguration(cashfreeConfiguration: CashfreeConfiguration, x_api_version: string, order_id: string, TerminateOrderRequest: TerminateOrderRequest, x_request_id?: string, x_idempotency_key?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<OrderEntity, any>>;
|
|
8711
8741
|
/**
|
|
8712
8742
|
* - Use this API to get the payment gateway reconciliation details with date range. - It will have events for your payment account
|
|
8713
8743
|
* @summary PG Reconciliation
|
|
@@ -8722,6 +8752,7 @@ export declare class Cashfree {
|
|
|
8722
8752
|
* @memberof PGReconciliationApi
|
|
8723
8753
|
*/
|
|
8724
8754
|
static PGFetchRecon(x_api_version: string, FetchReconRequest: FetchReconRequest, Content_Type?: string, x_request_id?: string, x_idempotency_key?: string, Accept?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ReconEntity, any>>;
|
|
8755
|
+
static PGFetchReconWithConfiguration(cashfreeConfiguration: CashfreeConfiguration, x_api_version: string, FetchReconRequest: FetchReconRequest, Content_Type?: string, x_request_id?: string, x_idempotency_key?: string, Accept?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ReconEntity, any>>;
|
|
8725
8756
|
/**
|
|
8726
8757
|
* Use this API to cancel a payment link. No further payments can be done against a cancelled link. Only a link in ACTIVE status can be cancelled.
|
|
8727
8758
|
* @summary Cancel Payment Link
|
|
@@ -8734,6 +8765,7 @@ export declare class Cashfree {
|
|
|
8734
8765
|
* @memberof PaymentLinksApi
|
|
8735
8766
|
*/
|
|
8736
8767
|
static PGCancelLink(x_api_version: string, link_id: string, x_request_id?: string, x_idempotency_key?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<LinkEntity, any>>;
|
|
8768
|
+
static PGCancelLinkWithConfiguration(cashfreeConfiguration: CashfreeConfiguration, x_api_version: string, link_id: string, x_request_id?: string, x_idempotency_key?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<LinkEntity, any>>;
|
|
8737
8769
|
/**
|
|
8738
8770
|
* Use this API to create a new payment link. The created payment link url will be available in the API response parameter link_url.
|
|
8739
8771
|
* @summary Create Payment Link
|
|
@@ -8746,6 +8778,7 @@ export declare class Cashfree {
|
|
|
8746
8778
|
* @memberof PaymentLinksApi
|
|
8747
8779
|
*/
|
|
8748
8780
|
static PGCreateLink(x_api_version: string, CreateLinkRequest: CreateLinkRequest, x_request_id?: string, x_idempotency_key?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<LinkEntity, any>>;
|
|
8781
|
+
static PGCreateLinkWithConfiguration(cashfreeConfiguration: CashfreeConfiguration, x_api_version: string, CreateLinkRequest: CreateLinkRequest, x_request_id?: string, x_idempotency_key?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<LinkEntity, any>>;
|
|
8749
8782
|
/**
|
|
8750
8783
|
* Use this API to view all details and status of a payment link.
|
|
8751
8784
|
* @summary Fetch Payment Link Details
|
|
@@ -8758,6 +8791,7 @@ export declare class Cashfree {
|
|
|
8758
8791
|
* @memberof PaymentLinksApi
|
|
8759
8792
|
*/
|
|
8760
8793
|
static PGFetchLink(x_api_version: string, link_id: string, x_request_id?: string, x_idempotency_key?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<LinkEntity, any>>;
|
|
8794
|
+
static PGFetchLinkWithConfiguration(cashfreeConfiguration: CashfreeConfiguration, x_api_version: string, link_id: string, x_request_id?: string, x_idempotency_key?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<LinkEntity, any>>;
|
|
8761
8795
|
/**
|
|
8762
8796
|
* Use this API to view all order details for a payment link.
|
|
8763
8797
|
* @summary Get Orders for a Payment Link
|
|
@@ -8771,6 +8805,7 @@ export declare class Cashfree {
|
|
|
8771
8805
|
* @memberof PaymentLinksApi
|
|
8772
8806
|
*/
|
|
8773
8807
|
static PGLinkFetchOrders(x_api_version: string, link_id: string, x_request_id?: string, x_idempotency_key?: string, status?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PaymentLinkOrderEntity[], any>>;
|
|
8808
|
+
static PGLinkFetchOrdersWithConfiguration(cashfreeConfiguration: CashfreeConfiguration, x_api_version: string, link_id: string, x_request_id?: string, x_idempotency_key?: string, status?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PaymentLinkOrderEntity[], any>>;
|
|
8774
8809
|
/**
|
|
8775
8810
|
* Use this API to capture or void a preauthorized payment
|
|
8776
8811
|
* @summary Preauthorization
|
|
@@ -8784,6 +8819,7 @@ export declare class Cashfree {
|
|
|
8784
8819
|
* @memberof PaymentsApi
|
|
8785
8820
|
*/
|
|
8786
8821
|
static PGAuthorizeOrder(x_api_version: string, order_id: string, AuthorizeOrderRequest: AuthorizeOrderRequest, x_request_id?: string, x_idempotency_key?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PaymentEntity, any>>;
|
|
8822
|
+
static PGAuthorizeOrderWithConfiguration(cashfreeConfiguration: CashfreeConfiguration, x_api_version: string, order_id: string, AuthorizeOrderRequest: AuthorizeOrderRequest, x_request_id?: string, x_idempotency_key?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PaymentEntity, any>>;
|
|
8787
8823
|
/**
|
|
8788
8824
|
* If you accept OTP on your own page, you can use the below API to send OTP to Cashfree.
|
|
8789
8825
|
* @summary Submit or Resend OTP
|
|
@@ -8797,6 +8833,7 @@ export declare class Cashfree {
|
|
|
8797
8833
|
* @memberof PaymentsApi
|
|
8798
8834
|
*/
|
|
8799
8835
|
static PGOrderAuthenticatePayment(x_api_version: string, cf_payment_id: string, OrderAuthenticatePaymentRequest: OrderAuthenticatePaymentRequest, x_request_id?: string, x_idempotency_key?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<OrderAuthenticateEntity, any>>;
|
|
8836
|
+
static PGOrderAuthenticatePaymentWithConfiguration(cashfreeConfiguration: CashfreeConfiguration, x_api_version: string, cf_payment_id: string, OrderAuthenticatePaymentRequest: OrderAuthenticatePaymentRequest, x_request_id?: string, x_idempotency_key?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<OrderAuthenticateEntity, any>>;
|
|
8800
8837
|
/**
|
|
8801
8838
|
* Use this API to view payment details of an order for a payment ID.
|
|
8802
8839
|
* @summary Get Payment by ID
|
|
@@ -8810,6 +8847,7 @@ export declare class Cashfree {
|
|
|
8810
8847
|
* @memberof PaymentsApi
|
|
8811
8848
|
*/
|
|
8812
8849
|
static PGOrderFetchPayment(x_api_version: string, order_id: string, cf_payment_id: string, x_request_id?: string, x_idempotency_key?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PaymentEntity, any>>;
|
|
8850
|
+
static PGOrderFetchPaymentWithConfiguration(cashfreeConfiguration: CashfreeConfiguration, x_api_version: string, order_id: string, cf_payment_id: string, x_request_id?: string, x_idempotency_key?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PaymentEntity, any>>;
|
|
8813
8851
|
/**
|
|
8814
8852
|
* Use this API to view all payment details for an order.
|
|
8815
8853
|
* @summary Get Payments for an Order
|
|
@@ -8822,6 +8860,7 @@ export declare class Cashfree {
|
|
|
8822
8860
|
* @memberof PaymentsApi
|
|
8823
8861
|
*/
|
|
8824
8862
|
static PGOrderFetchPayments(x_api_version: string, order_id: string, x_request_id?: string, x_idempotency_key?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PaymentEntity[], any>>;
|
|
8863
|
+
static PGOrderFetchPaymentsWithConfiguration(cashfreeConfiguration: CashfreeConfiguration, x_api_version: string, order_id: string, x_request_id?: string, x_idempotency_key?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PaymentEntity[], any>>;
|
|
8825
8864
|
/**
|
|
8826
8865
|
* Use this API when you have already created the orders and want Cashfree to process the payment. To use this API S2S flag needs to be enabled from the backend. In case you want to use the cards payment option the PCI DSS flag is required, for more information send an email to \"care@cashfree.com\".
|
|
8827
8866
|
* @summary Order Pay
|
|
@@ -8834,6 +8873,7 @@ export declare class Cashfree {
|
|
|
8834
8873
|
* @memberof PaymentsApi
|
|
8835
8874
|
*/
|
|
8836
8875
|
static PGPayOrder(x_api_version: string, PayOrderRequest: PayOrderRequest, x_request_id?: string, x_idempotency_key?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PayOrderEntity, any>>;
|
|
8876
|
+
static PGPayOrderWithConfiguration(cashfreeConfiguration: CashfreeConfiguration, x_api_version: string, PayOrderRequest: PayOrderRequest, x_request_id?: string, x_idempotency_key?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PayOrderEntity, any>>;
|
|
8837
8877
|
/**
|
|
8838
8878
|
* Use this API to initiate refunds.
|
|
8839
8879
|
* @summary Create Refund
|
|
@@ -8847,6 +8887,7 @@ export declare class Cashfree {
|
|
|
8847
8887
|
* @memberof RefundsApi
|
|
8848
8888
|
*/
|
|
8849
8889
|
static PGOrderCreateRefund(x_api_version: string, order_id: string, OrderCreateRefundRequest: OrderCreateRefundRequest, x_request_id?: string, x_idempotency_key?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<RefundEntity, any>>;
|
|
8890
|
+
static PGOrderCreateRefundWithConfiguration(cashfreeConfiguration: CashfreeConfiguration, x_api_version: string, order_id: string, OrderCreateRefundRequest: OrderCreateRefundRequest, x_request_id?: string, x_idempotency_key?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<RefundEntity, any>>;
|
|
8850
8891
|
/**
|
|
8851
8892
|
* Use this API to fetch a specific refund processed on your Cashfree Account.
|
|
8852
8893
|
* @summary Get Refund
|
|
@@ -8860,6 +8901,7 @@ export declare class Cashfree {
|
|
|
8860
8901
|
* @memberof RefundsApi
|
|
8861
8902
|
*/
|
|
8862
8903
|
static PGOrderFetchRefund(x_api_version: string, order_id: string, refund_id: string, x_request_id?: string, x_idempotency_key?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<RefundEntity, any>>;
|
|
8904
|
+
static PGOrderFetchRefundWithConfiguration(cashfreeConfiguration: CashfreeConfiguration, x_api_version: string, order_id: string, refund_id: string, x_request_id?: string, x_idempotency_key?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<RefundEntity, any>>;
|
|
8863
8905
|
/**
|
|
8864
8906
|
* Use this API to fetch all refunds processed against an order.
|
|
8865
8907
|
* @summary Get All Refunds for an Order
|
|
@@ -8872,6 +8914,7 @@ export declare class Cashfree {
|
|
|
8872
8914
|
* @memberof RefundsApi
|
|
8873
8915
|
*/
|
|
8874
8916
|
static PGOrderFetchRefunds(x_api_version: string, order_id: string, x_request_id?: string, x_idempotency_key?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<RefundEntity[], any>>;
|
|
8917
|
+
static PGOrderFetchRefundsWithConfiguration(cashfreeConfiguration: CashfreeConfiguration, x_api_version: string, order_id: string, x_request_id?: string, x_idempotency_key?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<RefundEntity[], any>>;
|
|
8875
8918
|
/**
|
|
8876
8919
|
* Use this API to get all settlement details by specifying the settlement ID, settlement UTR or date range.
|
|
8877
8920
|
* @summary Get All Settlements
|
|
@@ -8886,6 +8929,7 @@ export declare class Cashfree {
|
|
|
8886
8929
|
* @memberof SettlementReconciliationApi
|
|
8887
8930
|
*/
|
|
8888
8931
|
static PGFetchSettlements(x_api_version: string, FetchSettlementsRequest: FetchSettlementsRequest, Content_Type?: string, x_request_id?: string, x_idempotency_key?: string, Accept?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SettlementEntity, any>>;
|
|
8932
|
+
static PGFetchSettlementsWithConfiguration(cashfreeConfiguration: CashfreeConfiguration, x_api_version: string, FetchSettlementsRequest: FetchSettlementsRequest, Content_Type?: string, x_request_id?: string, x_idempotency_key?: string, Accept?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SettlementEntity, any>>;
|
|
8889
8933
|
/**
|
|
8890
8934
|
* - Use this API to get settlement reconciliation details using Settlement ID, settlement UTR or date range. - This API will return events for the settlement IDs you want
|
|
8891
8935
|
* @summary Settlement Reconciliation
|
|
@@ -8900,6 +8944,7 @@ export declare class Cashfree {
|
|
|
8900
8944
|
* @memberof SettlementReconciliationApi
|
|
8901
8945
|
*/
|
|
8902
8946
|
static PGSettlementFetchRecon(x_api_version: string, SettlementFetchReconRequest: SettlementFetchReconRequest, Content_Type?: string, x_request_id?: string, x_idempotency_key?: string, Accept?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SettlementReconEntity, any>>;
|
|
8947
|
+
static PGSettlementFetchReconWithConfiguration(cashfreeConfiguration: CashfreeConfiguration, x_api_version: string, SettlementFetchReconRequest: SettlementFetchReconRequest, Content_Type?: string, x_request_id?: string, x_idempotency_key?: string, Accept?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SettlementReconEntity, any>>;
|
|
8903
8948
|
/**
|
|
8904
8949
|
* Use this API to pass the CBRICS ID to Cashfree and mark an order for settlement.
|
|
8905
8950
|
* @summary Mark Order For Settlement
|
|
@@ -8912,6 +8957,7 @@ export declare class Cashfree {
|
|
|
8912
8957
|
* @memberof SettlementsApi
|
|
8913
8958
|
*/
|
|
8914
8959
|
static MarkForSettlement(x_api_version: string, x_request_id?: string, x_idempotency_key?: string, CreateOrderSettlementRequestBody?: CreateOrderSettlementRequestBody, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any>>;
|
|
8960
|
+
static MarkForSettlementWithConfiguration(cashfreeConfiguration: CashfreeConfiguration, x_api_version: string, x_request_id?: string, x_idempotency_key?: string, CreateOrderSettlementRequestBody?: CreateOrderSettlementRequestBody, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any>>;
|
|
8915
8961
|
/**
|
|
8916
8962
|
* Use this API to view all the settlements of a particular order.
|
|
8917
8963
|
* @summary Get Settlements by Order ID
|
|
@@ -8924,6 +8970,7 @@ export declare class Cashfree {
|
|
|
8924
8970
|
* @memberof SettlementsApi
|
|
8925
8971
|
*/
|
|
8926
8972
|
static PGOrderFetchSettlement(x_api_version: string, order_id: string, x_request_id?: string, x_idempotency_key?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SettlementEntity, any>>;
|
|
8973
|
+
static PGOrderFetchSettlementWithConfiguration(cashfreeConfiguration: CashfreeConfiguration, x_api_version: string, order_id: string, x_request_id?: string, x_idempotency_key?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SettlementEntity, any>>;
|
|
8927
8974
|
/**
|
|
8928
8975
|
* Use this API to fetch simulated payment details.
|
|
8929
8976
|
* @summary Fetch Simulation
|
|
@@ -8936,6 +8983,7 @@ export declare class Cashfree {
|
|
|
8936
8983
|
* @memberof SimulationApi
|
|
8937
8984
|
*/
|
|
8938
8985
|
static PGFetchSimulation(x_api_version: string, simulation_id: string, x_request_id?: string, x_idempotency_key?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SimulationResponse, any>>;
|
|
8986
|
+
static PGFetchSimulationWithConfiguration(cashfreeConfiguration: CashfreeConfiguration, x_api_version: string, simulation_id: string, x_request_id?: string, x_idempotency_key?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SimulationResponse, any>>;
|
|
8939
8987
|
/**
|
|
8940
8988
|
* Use this API to simulate payment. To use this API you should first create an order using the Create Order API. Also, you need to create a payment with the same order.
|
|
8941
8989
|
* @summary Simulate Payment
|
|
@@ -8948,6 +8996,7 @@ export declare class Cashfree {
|
|
|
8948
8996
|
* @memberof SimulationApi
|
|
8949
8997
|
*/
|
|
8950
8998
|
static PGSimulatePayment(x_api_version: string, SimulateRequest: SimulateRequest, x_request_id?: string, x_idempotency_key?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SimulationResponse, any>>;
|
|
8999
|
+
static PGSimulatePaymentWithConfiguration(cashfreeConfiguration: CashfreeConfiguration, x_api_version: string, SimulateRequest: SimulateRequest, x_request_id?: string, x_idempotency_key?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SimulationResponse, any>>;
|
|
8951
9000
|
/**
|
|
8952
9001
|
* Use this API to create new terminals to use softPOS.
|
|
8953
9002
|
* @summary Create Terminal
|
|
@@ -8960,6 +9009,7 @@ export declare class Cashfree {
|
|
|
8960
9009
|
* @memberof SoftPOSApi
|
|
8961
9010
|
*/
|
|
8962
9011
|
static SposCreateTerminal(x_api_version: string, CreateTerminalRequest: CreateTerminalRequest, x_request_id?: string, x_idempotency_key?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<TerminalEntity, any>>;
|
|
9012
|
+
static SposCreateTerminalWithConfiguration(cashfreeConfiguration: CashfreeConfiguration, x_api_version: string, CreateTerminalRequest: CreateTerminalRequest, x_request_id?: string, x_idempotency_key?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<TerminalEntity, any>>;
|
|
8963
9013
|
/**
|
|
8964
9014
|
* Use this API to create a new terminal transaction. To use this API you should first create an order using the Create Order API. Also, you need to enter the terminal details while creating the order and pass the same terminal information while creating a transaction using the below mentioned API.
|
|
8965
9015
|
* @summary Create Terminal Transaction
|
|
@@ -8972,6 +9022,7 @@ export declare class Cashfree {
|
|
|
8972
9022
|
* @memberof SoftPOSApi
|
|
8973
9023
|
*/
|
|
8974
9024
|
static SposCreateTerminalTransaction(x_api_version: string, CreateTerminalTransactionRequest: CreateTerminalTransactionRequest, x_request_id?: string, x_idempotency_key?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<TerminalTransactionEntity, any>>;
|
|
9025
|
+
static SposCreateTerminalTransactionWithConfiguration(cashfreeConfiguration: CashfreeConfiguration, x_api_version: string, CreateTerminalTransactionRequest: CreateTerminalTransactionRequest, x_request_id?: string, x_idempotency_key?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<TerminalTransactionEntity, any>>;
|
|
8975
9026
|
/**
|
|
8976
9027
|
* Use this API to view all details of a terminal.
|
|
8977
9028
|
* @summary Get Terminal Status using Phone Number
|
|
@@ -8984,6 +9035,7 @@ export declare class Cashfree {
|
|
|
8984
9035
|
* @memberof SoftPOSApi
|
|
8985
9036
|
*/
|
|
8986
9037
|
static SposFetchTerminal(x_api_version: string, terminal_phone_no: string, x_request_id?: string, x_idempotency_key?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<TerminalEntity, any>>;
|
|
9038
|
+
static SposFetchTerminalWithConfiguration(cashfreeConfiguration: CashfreeConfiguration, x_api_version: string, terminal_phone_no: string, x_request_id?: string, x_idempotency_key?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<TerminalEntity, any>>;
|
|
8987
9039
|
/**
|
|
8988
9040
|
* You can fetch all the StaticQRs corresponding to given terminal id or phone number. Provide either the terminal_phone_no or terminal_id in the request.
|
|
8989
9041
|
* @summary Fetch Terminal QR Codes
|
|
@@ -8997,6 +9049,7 @@ export declare class Cashfree {
|
|
|
8997
9049
|
* @memberof SoftPOSApi
|
|
8998
9050
|
*/
|
|
8999
9051
|
static SposFetchTerminalQRCodes(x_api_version: string, terminal_phone_no: string, cf_terminal_id: string, x_request_id?: string, x_idempotency_key?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<FetchTerminalQRCodesEntity[], any>>;
|
|
9052
|
+
static SposFetchTerminalQRCodesWithConfiguration(cashfreeConfiguration: CashfreeConfiguration, x_api_version: string, terminal_phone_no: string, cf_terminal_id: string, x_request_id?: string, x_idempotency_key?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<FetchTerminalQRCodesEntity[], any>>;
|
|
9000
9053
|
/**
|
|
9001
9054
|
* Use this API to get terminal transaction.
|
|
9002
9055
|
* @summary Get Terminal Transaction
|
|
@@ -9010,6 +9063,7 @@ export declare class Cashfree {
|
|
|
9010
9063
|
* @memberof SoftPOSApi
|
|
9011
9064
|
*/
|
|
9012
9065
|
static SposFetchTerminalTransaction(x_api_version: string, utr: string, cf_terminal_id: string, x_request_id?: string, x_idempotency_key?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<TerminalPaymentEntity, any>>;
|
|
9066
|
+
static SposFetchTerminalTransactionWithConfiguration(cashfreeConfiguration: CashfreeConfiguration, x_api_version: string, utr: string, cf_terminal_id: string, x_request_id?: string, x_idempotency_key?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<TerminalPaymentEntity, any>>;
|
|
9013
9067
|
/**
|
|
9014
9068
|
* Use this API to update the terminal details. Email, Phone Number, and Terminal Meta are updatable for \"Storefront\". Only account status change is possible in case of \"Agent\".
|
|
9015
9069
|
* @summary Update Terminal
|
|
@@ -9023,6 +9077,7 @@ export declare class Cashfree {
|
|
|
9023
9077
|
* @memberof SoftPOSApi
|
|
9024
9078
|
*/
|
|
9025
9079
|
static SposUpdateTerminal(x_api_version: string, cf_terminal_id: string, UpdateTerminalRequest: UpdateTerminalRequest, x_request_id?: string, x_idempotency_key?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdateTerminalEntity[], any>>;
|
|
9080
|
+
static SposUpdateTerminalWithConfiguration(cashfreeConfiguration: CashfreeConfiguration, x_api_version: string, cf_terminal_id: string, UpdateTerminalRequest: UpdateTerminalRequest, x_request_id?: string, x_idempotency_key?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdateTerminalEntity[], any>>;
|
|
9026
9081
|
/**
|
|
9027
9082
|
* Use this API to update the terminal status.
|
|
9028
9083
|
* @summary Update Terminal Status
|
|
@@ -9036,6 +9091,7 @@ export declare class Cashfree {
|
|
|
9036
9091
|
* @memberof SoftPOSApi
|
|
9037
9092
|
*/
|
|
9038
9093
|
static SposUpdateTerminalStatus(x_api_version: string, cf_terminal_id: string, UpdateTerminalStatusRequest: UpdateTerminalStatusRequest, x_request_id?: string, x_idempotency_key?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdateTerminalEntity[], any>>;
|
|
9094
|
+
static SposUpdateTerminalStatusWithConfiguration(cashfreeConfiguration: CashfreeConfiguration, x_api_version: string, cf_terminal_id: string, UpdateTerminalStatusRequest: UpdateTerminalStatusRequest, x_request_id?: string, x_idempotency_key?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdateTerminalEntity[], any>>;
|
|
9039
9095
|
/**
|
|
9040
9096
|
* Use this API to upload the terminal documents.
|
|
9041
9097
|
* @summary Upload Terminal Docs
|
|
@@ -9049,6 +9105,7 @@ export declare class Cashfree {
|
|
|
9049
9105
|
* @memberof SoftPOSApi
|
|
9050
9106
|
*/
|
|
9051
9107
|
static SposUploadTerminalDocs(x_api_version: string, cf_terminal_id: string, UploadTerminalDocs: UploadTerminalDocs, x_request_id?: string, x_idempotency_key?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UploadTerminalDocsEntity[], any>>;
|
|
9108
|
+
static SposUploadTerminalDocsWithConfiguration(cashfreeConfiguration: CashfreeConfiguration, x_api_version: string, cf_terminal_id: string, UploadTerminalDocs: UploadTerminalDocs, x_request_id?: string, x_idempotency_key?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UploadTerminalDocsEntity[], any>>;
|
|
9052
9109
|
/**
|
|
9053
9110
|
* Use this API to create an auth or to raise a charge .
|
|
9054
9111
|
* @summary Raise a charge or create an auth.
|
|
@@ -9061,6 +9118,7 @@ export declare class Cashfree {
|
|
|
9061
9118
|
* @memberof SubscriptionApi
|
|
9062
9119
|
*/
|
|
9063
9120
|
static SubsCreatePayment(x_api_version: string, CreateSubscriptionPaymentRequest: CreateSubscriptionPaymentRequest, x_request_id?: string, x_idempotency_key?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateSubscriptionPaymentResponse, any>>;
|
|
9121
|
+
static SubsCreatePaymentWithConfiguration(cashfreeConfiguration: CashfreeConfiguration, x_api_version: string, CreateSubscriptionPaymentRequest: CreateSubscriptionPaymentRequest, x_request_id?: string, x_idempotency_key?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateSubscriptionPaymentResponse, any>>;
|
|
9064
9122
|
/**
|
|
9065
9123
|
* A plan allows your customer to identify the features you offer along with your pricing. You can create plans as per the pricing you support for your services. For each plan, you can set a pre-decided frequency and amount with which they’ll be charged. Example: Netflix Plans - Premium, Basic, Standard, Mobile. Each plan differs and caters for a particular set of audiences.
|
|
9066
9124
|
* @summary Create a plan.
|
|
@@ -9073,6 +9131,7 @@ export declare class Cashfree {
|
|
|
9073
9131
|
* @memberof SubscriptionApi
|
|
9074
9132
|
*/
|
|
9075
9133
|
static SubsCreatePlan(x_api_version: string, CreatePlanRequest: CreatePlanRequest, x_request_id?: string, x_idempotency_key?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PlanEntity, any>>;
|
|
9134
|
+
static SubsCreatePlanWithConfiguration(cashfreeConfiguration: CashfreeConfiguration, x_api_version: string, CreatePlanRequest: CreatePlanRequest, x_request_id?: string, x_idempotency_key?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PlanEntity, any>>;
|
|
9076
9135
|
/**
|
|
9077
9136
|
* This API allows you to create refund on a successful payment. Refund amount can be partial or the full amount of the payment.
|
|
9078
9137
|
* @summary Create a refund.
|
|
@@ -9086,6 +9145,7 @@ export declare class Cashfree {
|
|
|
9086
9145
|
* @memberof SubscriptionApi
|
|
9087
9146
|
*/
|
|
9088
9147
|
static SubsCreateRefund(x_api_version: string, subscription_id: string, CreateSubscriptionRefundRequest: CreateSubscriptionRefundRequest, x_request_id?: string, x_idempotency_key?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SubscriptionPaymentRefundEntity, any>>;
|
|
9148
|
+
static SubsCreateRefundWithConfiguration(cashfreeConfiguration: CashfreeConfiguration, x_api_version: string, subscription_id: string, CreateSubscriptionRefundRequest: CreateSubscriptionRefundRequest, x_request_id?: string, x_idempotency_key?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SubscriptionPaymentRefundEntity, any>>;
|
|
9089
9149
|
/**
|
|
9090
9150
|
* Use this API to create a new subscription.
|
|
9091
9151
|
* @summary Create Subscription
|
|
@@ -9098,6 +9158,7 @@ export declare class Cashfree {
|
|
|
9098
9158
|
* @memberof SubscriptionApi
|
|
9099
9159
|
*/
|
|
9100
9160
|
static SubsCreateSubscription(x_api_version: string, CreateSubscriptionRequest: CreateSubscriptionRequest, x_request_id?: string, x_idempotency_key?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SubscriptionEntity, any>>;
|
|
9161
|
+
static SubsCreateSubscriptionWithConfiguration(cashfreeConfiguration: CashfreeConfiguration, x_api_version: string, CreateSubscriptionRequest: CreateSubscriptionRequest, x_request_id?: string, x_idempotency_key?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SubscriptionEntity, any>>;
|
|
9101
9162
|
/**
|
|
9102
9163
|
* Use this API to fetch plan details.
|
|
9103
9164
|
* @summary Fetch Plan
|
|
@@ -9110,6 +9171,7 @@ export declare class Cashfree {
|
|
|
9110
9171
|
* @memberof SubscriptionApi
|
|
9111
9172
|
*/
|
|
9112
9173
|
static SubsFetchPlan(x_api_version: string, plan_id: string, x_request_id?: string, x_idempotency_key?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PlanEntity, any>>;
|
|
9174
|
+
static SubsFetchPlanWithConfiguration(cashfreeConfiguration: CashfreeConfiguration, x_api_version: string, plan_id: string, x_request_id?: string, x_idempotency_key?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PlanEntity, any>>;
|
|
9113
9175
|
/**
|
|
9114
9176
|
* Use this API to fetch subscription details.
|
|
9115
9177
|
* @summary Fetch Subscription
|
|
@@ -9122,6 +9184,7 @@ export declare class Cashfree {
|
|
|
9122
9184
|
* @memberof SubscriptionApi
|
|
9123
9185
|
*/
|
|
9124
9186
|
static SubsFetchSubscription(x_api_version: string, subscription_id: string, x_request_id?: string, x_idempotency_key?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SubscriptionEntity, any>>;
|
|
9187
|
+
static SubsFetchSubscriptionWithConfiguration(cashfreeConfiguration: CashfreeConfiguration, x_api_version: string, subscription_id: string, x_request_id?: string, x_idempotency_key?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SubscriptionEntity, any>>;
|
|
9125
9188
|
/**
|
|
9126
9189
|
* Use this API to fetch details of a single payment of a subscription.
|
|
9127
9190
|
* @summary Fetch details of a single payment.
|
|
@@ -9135,6 +9198,7 @@ export declare class Cashfree {
|
|
|
9135
9198
|
* @memberof SubscriptionApi
|
|
9136
9199
|
*/
|
|
9137
9200
|
static SubsFetchSubscriptionPayment(x_api_version: string, subscription_id: string, payment_id: string, x_request_id?: string, x_idempotency_key?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SubscriptionPaymentEntity, any>>;
|
|
9201
|
+
static SubsFetchSubscriptionPaymentWithConfiguration(cashfreeConfiguration: CashfreeConfiguration, x_api_version: string, subscription_id: string, payment_id: string, x_request_id?: string, x_idempotency_key?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SubscriptionPaymentEntity, any>>;
|
|
9138
9202
|
/**
|
|
9139
9203
|
* Use this API to fetch all payments of a subscription.
|
|
9140
9204
|
* @summary Fetch details of all payments of a subscription.
|
|
@@ -9147,6 +9211,7 @@ export declare class Cashfree {
|
|
|
9147
9211
|
* @memberof SubscriptionApi
|
|
9148
9212
|
*/
|
|
9149
9213
|
static SubsFetchSubscriptionPayments(x_api_version: string, subscription_id: string, x_request_id?: string, x_idempotency_key?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SubscriptionPaymentEntity[], any>>;
|
|
9214
|
+
static SubsFetchSubscriptionPaymentsWithConfiguration(cashfreeConfiguration: CashfreeConfiguration, x_api_version: string, subscription_id: string, x_request_id?: string, x_idempotency_key?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SubscriptionPaymentEntity[], any>>;
|
|
9150
9215
|
/**
|
|
9151
9216
|
* Use this API to fetch details of a refund of a subscription payment.
|
|
9152
9217
|
* @summary Fetch details of a refund.
|
|
@@ -9160,6 +9225,7 @@ export declare class Cashfree {
|
|
|
9160
9225
|
* @memberof SubscriptionApi
|
|
9161
9226
|
*/
|
|
9162
9227
|
static SubsFetchSubscriptionRefund(x_api_version: string, subscription_id: string, refund_id: string, x_request_id?: string, x_idempotency_key?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SubscriptionPaymentRefundEntity, any>>;
|
|
9228
|
+
static SubsFetchSubscriptionRefundWithConfiguration(cashfreeConfiguration: CashfreeConfiguration, x_api_version: string, subscription_id: string, refund_id: string, x_request_id?: string, x_idempotency_key?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SubscriptionPaymentRefundEntity, any>>;
|
|
9163
9229
|
/**
|
|
9164
9230
|
* Use this API to manage a subscription. You can cancel, pause, activate or change the plan of a subscription.
|
|
9165
9231
|
* @summary Manage a subscription.
|
|
@@ -9173,6 +9239,7 @@ export declare class Cashfree {
|
|
|
9173
9239
|
* @memberof SubscriptionApi
|
|
9174
9240
|
*/
|
|
9175
9241
|
static SubsManageSubscription(x_api_version: string, subscription_id: string, ManageSubscriptionRequest: ManageSubscriptionRequest, x_request_id?: string, x_idempotency_key?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SubscriptionEntity, any>>;
|
|
9242
|
+
static SubsManageSubscriptionWithConfiguration(cashfreeConfiguration: CashfreeConfiguration, x_api_version: string, subscription_id: string, ManageSubscriptionRequest: ManageSubscriptionRequest, x_request_id?: string, x_idempotency_key?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SubscriptionEntity, any>>;
|
|
9176
9243
|
/**
|
|
9177
9244
|
* Use this API to manage a payment of a subscription. A payment can be cancelled or retried with this API.
|
|
9178
9245
|
* @summary Manage a single payment.
|
|
@@ -9187,6 +9254,7 @@ export declare class Cashfree {
|
|
|
9187
9254
|
* @memberof SubscriptionApi
|
|
9188
9255
|
*/
|
|
9189
9256
|
static SubsManageSubscriptionPayment(x_api_version: string, subscription_id: string, payment_id: string, ManageSubscriptionPaymentRequest: ManageSubscriptionPaymentRequest, x_request_id?: string, x_idempotency_key?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SubscriptionPaymentEntity, any>>;
|
|
9257
|
+
static SubsManageSubscriptionPaymentWithConfiguration(cashfreeConfiguration: CashfreeConfiguration, x_api_version: string, subscription_id: string, payment_id: string, ManageSubscriptionPaymentRequest: ManageSubscriptionPaymentRequest, x_request_id?: string, x_idempotency_key?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SubscriptionPaymentEntity, any>>;
|
|
9190
9258
|
/**
|
|
9191
9259
|
* Use this API to upload Physical Nach for Physical Nach Authorization.
|
|
9192
9260
|
* @summary API to upload Physical Nach for Physical Nach Authorization.
|
|
@@ -9202,6 +9270,7 @@ export declare class Cashfree {
|
|
|
9202
9270
|
* @memberof SubscriptionApi
|
|
9203
9271
|
*/
|
|
9204
9272
|
static SubscriptionDocumentUpload(x_api_version: string, payment_id: string, file: File, payment_id2: string, action: string, x_request_id?: string, x_idempotency_key?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UploadPnachImageResponse, any>>;
|
|
9273
|
+
static SubscriptionDocumentUploadWithConfiguration(cashfreeConfiguration: CashfreeConfiguration, x_api_version: string, payment_id: string, file: File, payment_id2: string, action: string, x_request_id?: string, x_idempotency_key?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UploadPnachImageResponse, any>>;
|
|
9205
9274
|
/**
|
|
9206
9275
|
* Use this API to check if a payment method is enabled for your account.
|
|
9207
9276
|
* @summary API to get all the payment method details available for subscription payments.
|
|
@@ -9214,6 +9283,7 @@ export declare class Cashfree {
|
|
|
9214
9283
|
* @memberof SubscriptionApi
|
|
9215
9284
|
*/
|
|
9216
9285
|
static SubscriptionEligibility(x_api_version: string, SubscriptionEligibilityRequest: SubscriptionEligibilityRequest, x_request_id?: string, x_idempotency_key?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SubscriptionEligibilityResponse, any>>;
|
|
9286
|
+
static SubscriptionEligibilityWithConfiguration(cashfreeConfiguration: CashfreeConfiguration, x_api_version: string, SubscriptionEligibilityRequest: SubscriptionEligibilityRequest, x_request_id?: string, x_idempotency_key?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SubscriptionEligibilityResponse, any>>;
|
|
9217
9287
|
/**
|
|
9218
9288
|
* Use this API to delete a saved card instrument for a customer_id and instrument_id
|
|
9219
9289
|
* @summary Delete Saved Card Instrument
|
|
@@ -9227,6 +9297,7 @@ export declare class Cashfree {
|
|
|
9227
9297
|
* @memberof TokenVaultApi
|
|
9228
9298
|
*/
|
|
9229
9299
|
static PGCustomerDeleteInstrument(x_api_version: string, customer_id: string, instrument_id: string, x_request_id?: string, x_idempotency_key?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<InstrumentEntity, any>>;
|
|
9300
|
+
static PGCustomerDeleteInstrumentWithConfiguration(cashfreeConfiguration: CashfreeConfiguration, x_api_version: string, customer_id: string, instrument_id: string, x_request_id?: string, x_idempotency_key?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<InstrumentEntity, any>>;
|
|
9230
9301
|
/**
|
|
9231
9302
|
* Use this API to fetch a single specific saved card for a customer_id by it\'s instrument_id
|
|
9232
9303
|
* @summary Fetch Specific Saved Card Instrument
|
|
@@ -9240,6 +9311,7 @@ export declare class Cashfree {
|
|
|
9240
9311
|
* @memberof TokenVaultApi
|
|
9241
9312
|
*/
|
|
9242
9313
|
static PGCustomerFetchInstrument(x_api_version: string, customer_id: string, instrument_id: string, x_request_id?: string, x_idempotency_key?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<InstrumentEntity, any>>;
|
|
9314
|
+
static PGCustomerFetchInstrumentWithConfiguration(cashfreeConfiguration: CashfreeConfiguration, x_api_version: string, customer_id: string, instrument_id: string, x_request_id?: string, x_idempotency_key?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<InstrumentEntity, any>>;
|
|
9243
9315
|
/**
|
|
9244
9316
|
* Use this API to fetch saved cards for a customer_id
|
|
9245
9317
|
* @summary Fetch All Saved Card Instrument
|
|
@@ -9253,6 +9325,7 @@ export declare class Cashfree {
|
|
|
9253
9325
|
* @memberof TokenVaultApi
|
|
9254
9326
|
*/
|
|
9255
9327
|
static PGCustomerFetchInstruments(x_api_version: string, customer_id: string, instrument_type: PGCustomerFetchInstrumentsInstrumentTypeEnum, x_request_id?: string, x_idempotency_key?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<InstrumentEntity[], any>>;
|
|
9328
|
+
static PGCustomerFetchInstrumentsWithConfiguration(cashfreeConfiguration: CashfreeConfiguration, x_api_version: string, customer_id: string, instrument_type: PGCustomerFetchInstrumentsInstrumentTypeEnum, x_request_id?: string, x_idempotency_key?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<InstrumentEntity[], any>>;
|
|
9256
9329
|
/**
|
|
9257
9330
|
* Use this API To get the card network token, token expiry and cryptogram for a saved card instrument using instrument id
|
|
9258
9331
|
* @summary Fetch cryptogram for a saved card instrument
|
|
@@ -9266,5 +9339,6 @@ export declare class Cashfree {
|
|
|
9266
9339
|
* @memberof TokenVaultApi
|
|
9267
9340
|
*/
|
|
9268
9341
|
static PGCustomerInstrumentsFetchCryptogram(x_api_version: string, customer_id: string, instrument_id: string, x_request_id?: string, x_idempotency_key?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CryptogramEntity, any>>;
|
|
9342
|
+
static PGCustomerInstrumentsFetchCryptogramWithConfiguration(cashfreeConfiguration: CashfreeConfiguration, x_api_version: string, customer_id: string, instrument_id: string, x_request_id?: string, x_idempotency_key?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CryptogramEntity, any>>;
|
|
9269
9343
|
}
|
|
9270
9344
|
export {};
|