cashfree-pg 4.2.0 → 4.2.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/api.ts +426 -307
- package/dist/api.d.ts +277 -164
- package/dist/api.js +150 -144
- package/dist/esm/api.d.ts +277 -164
- package/dist/esm/api.js +150 -144
- package/package.json +1 -1
package/dist/api.d.ts
CHANGED
|
@@ -1264,206 +1264,291 @@ export interface CreatePlanRequest {
|
|
|
1264
1264
|
'plan_note'?: string;
|
|
1265
1265
|
}
|
|
1266
1266
|
/**
|
|
1267
|
-
* The
|
|
1267
|
+
* The request to be passed for the create subscription payment API.
|
|
1268
1268
|
* @export
|
|
1269
|
-
* @interface
|
|
1269
|
+
* @interface CreateSubscriptionPaymentRequest
|
|
1270
1270
|
*/
|
|
1271
|
-
export interface
|
|
1271
|
+
export interface CreateSubscriptionPaymentRequest {
|
|
1272
1272
|
/**
|
|
1273
|
-
*
|
|
1273
|
+
* A unique ID passed by merchant for identifying the subscription.
|
|
1274
1274
|
* @type {string}
|
|
1275
|
-
* @memberof
|
|
1275
|
+
* @memberof CreateSubscriptionPaymentRequest
|
|
1276
1276
|
*/
|
|
1277
|
-
'
|
|
1277
|
+
'subscription_id': string;
|
|
1278
1278
|
/**
|
|
1279
|
-
*
|
|
1279
|
+
* Session ID for the subscription. Required only for Auth.
|
|
1280
1280
|
* @type {string}
|
|
1281
|
-
* @memberof
|
|
1281
|
+
* @memberof CreateSubscriptionPaymentRequest
|
|
1282
1282
|
*/
|
|
1283
|
-
'
|
|
1283
|
+
'subscription_session_id'?: string;
|
|
1284
1284
|
/**
|
|
1285
|
-
*
|
|
1286
|
-
* @type {
|
|
1287
|
-
* @memberof
|
|
1285
|
+
* A unique ID passed by merchant for identifying the subscription payment.
|
|
1286
|
+
* @type {string}
|
|
1287
|
+
* @memberof CreateSubscriptionPaymentRequest
|
|
1288
1288
|
*/
|
|
1289
|
-
'
|
|
1289
|
+
'payment_id': string;
|
|
1290
1290
|
/**
|
|
1291
|
-
* The charge amount of the payment.
|
|
1291
|
+
* The charge amount of the payment. Required in case of charge.
|
|
1292
1292
|
* @type {number}
|
|
1293
|
-
* @memberof
|
|
1293
|
+
* @memberof CreateSubscriptionPaymentRequest
|
|
1294
1294
|
*/
|
|
1295
1295
|
'payment_amount'?: number;
|
|
1296
1296
|
/**
|
|
1297
|
-
*
|
|
1297
|
+
* The date on which the payment is scheduled to be processed. Required for UPI and CARD payment modes.
|
|
1298
1298
|
* @type {string}
|
|
1299
|
-
* @memberof
|
|
1299
|
+
* @memberof CreateSubscriptionPaymentRequest
|
|
1300
1300
|
*/
|
|
1301
|
-
'
|
|
1301
|
+
'payment_schedule_date'?: string;
|
|
1302
1302
|
/**
|
|
1303
|
-
*
|
|
1303
|
+
* Payment remarks.
|
|
1304
1304
|
* @type {string}
|
|
1305
|
-
* @memberof
|
|
1305
|
+
* @memberof CreateSubscriptionPaymentRequest
|
|
1306
1306
|
*/
|
|
1307
|
-
'
|
|
1307
|
+
'payment_remarks'?: string;
|
|
1308
1308
|
/**
|
|
1309
|
-
*
|
|
1309
|
+
* Payment type. Can be AUTH or CHARGE.
|
|
1310
1310
|
* @type {string}
|
|
1311
|
-
* @memberof
|
|
1311
|
+
* @memberof CreateSubscriptionPaymentRequest
|
|
1312
1312
|
*/
|
|
1313
|
-
'
|
|
1313
|
+
'payment_type': string;
|
|
1314
1314
|
/**
|
|
1315
|
-
*
|
|
1315
|
+
*
|
|
1316
|
+
* @type {CreateSubscriptionPaymentRequestPaymentMethod}
|
|
1317
|
+
* @memberof CreateSubscriptionPaymentRequest
|
|
1318
|
+
*/
|
|
1319
|
+
'payment_method'?: CreateSubscriptionPaymentRequestPaymentMethod;
|
|
1320
|
+
}
|
|
1321
|
+
/**
|
|
1322
|
+
* payment method card.
|
|
1323
|
+
* @export
|
|
1324
|
+
* @interface CreateSubscriptionPaymentRequestCard
|
|
1325
|
+
*/
|
|
1326
|
+
export interface CreateSubscriptionPaymentRequestCard {
|
|
1327
|
+
/**
|
|
1328
|
+
* Channel. can be link
|
|
1316
1329
|
* @type {string}
|
|
1317
|
-
* @memberof
|
|
1330
|
+
* @memberof CreateSubscriptionPaymentRequestCard
|
|
1318
1331
|
*/
|
|
1319
|
-
'
|
|
1332
|
+
'channel'?: string;
|
|
1320
1333
|
/**
|
|
1321
|
-
*
|
|
1334
|
+
* Card number
|
|
1322
1335
|
* @type {string}
|
|
1323
|
-
* @memberof
|
|
1336
|
+
* @memberof CreateSubscriptionPaymentRequestCard
|
|
1324
1337
|
*/
|
|
1325
|
-
'
|
|
1338
|
+
'card_number'?: string;
|
|
1326
1339
|
/**
|
|
1327
|
-
*
|
|
1340
|
+
* Card holder name
|
|
1328
1341
|
* @type {string}
|
|
1329
|
-
* @memberof
|
|
1342
|
+
* @memberof CreateSubscriptionPaymentRequestCard
|
|
1330
1343
|
*/
|
|
1331
|
-
'
|
|
1332
|
-
}
|
|
1333
|
-
/**
|
|
1334
|
-
*
|
|
1335
|
-
* @export
|
|
1336
|
-
* @interface CreateSubscriptionPaymentAuthResponseFailureDetails
|
|
1337
|
-
*/
|
|
1338
|
-
export interface CreateSubscriptionPaymentAuthResponseFailureDetails {
|
|
1344
|
+
'card_holder_name'?: string;
|
|
1339
1345
|
/**
|
|
1340
|
-
*
|
|
1346
|
+
* Card expiry month
|
|
1341
1347
|
* @type {string}
|
|
1342
|
-
* @memberof
|
|
1348
|
+
* @memberof CreateSubscriptionPaymentRequestCard
|
|
1343
1349
|
*/
|
|
1344
|
-
'
|
|
1345
|
-
}
|
|
1346
|
-
/**
|
|
1347
|
-
* The response returned in Get, Create or Manage Subscription Payment APIs.
|
|
1348
|
-
* @export
|
|
1349
|
-
* @interface CreateSubscriptionPaymentChargeResponse
|
|
1350
|
-
*/
|
|
1351
|
-
export interface CreateSubscriptionPaymentChargeResponse {
|
|
1350
|
+
'card_expiry_mm'?: string;
|
|
1352
1351
|
/**
|
|
1353
|
-
*
|
|
1352
|
+
* Card expiry year
|
|
1354
1353
|
* @type {string}
|
|
1355
|
-
* @memberof
|
|
1354
|
+
* @memberof CreateSubscriptionPaymentRequestCard
|
|
1356
1355
|
*/
|
|
1357
|
-
'
|
|
1356
|
+
'card_expiry_yy'?: string;
|
|
1358
1357
|
/**
|
|
1359
|
-
*
|
|
1358
|
+
* Card CVV
|
|
1360
1359
|
* @type {string}
|
|
1361
|
-
* @memberof
|
|
1360
|
+
* @memberof CreateSubscriptionPaymentRequestCard
|
|
1362
1361
|
*/
|
|
1363
|
-
'
|
|
1362
|
+
'card_cvv'?: string;
|
|
1364
1363
|
/**
|
|
1365
|
-
*
|
|
1366
|
-
* @type {
|
|
1367
|
-
* @memberof
|
|
1364
|
+
* Card network
|
|
1365
|
+
* @type {string}
|
|
1366
|
+
* @memberof CreateSubscriptionPaymentRequestCard
|
|
1368
1367
|
*/
|
|
1369
|
-
'
|
|
1368
|
+
'card_network'?: string;
|
|
1370
1369
|
/**
|
|
1371
|
-
*
|
|
1372
|
-
* @type {
|
|
1373
|
-
* @memberof
|
|
1370
|
+
* Card type
|
|
1371
|
+
* @type {string}
|
|
1372
|
+
* @memberof CreateSubscriptionPaymentRequestCard
|
|
1374
1373
|
*/
|
|
1375
|
-
'
|
|
1374
|
+
'card_type'?: string;
|
|
1375
|
+
}
|
|
1376
|
+
/**
|
|
1377
|
+
* payment method enach.
|
|
1378
|
+
* @export
|
|
1379
|
+
* @interface CreateSubscriptionPaymentRequestEnack
|
|
1380
|
+
*/
|
|
1381
|
+
export interface CreateSubscriptionPaymentRequestEnack {
|
|
1376
1382
|
/**
|
|
1377
|
-
*
|
|
1383
|
+
* Channel. can be link
|
|
1378
1384
|
* @type {string}
|
|
1379
|
-
* @memberof
|
|
1385
|
+
* @memberof CreateSubscriptionPaymentRequestEnack
|
|
1380
1386
|
*/
|
|
1381
|
-
'
|
|
1387
|
+
'channel'?: string;
|
|
1382
1388
|
/**
|
|
1383
|
-
*
|
|
1389
|
+
* Authentication mode. can be debit_card, aadhaar, or net_banking
|
|
1384
1390
|
* @type {string}
|
|
1385
|
-
* @memberof
|
|
1391
|
+
* @memberof CreateSubscriptionPaymentRequestEnack
|
|
1386
1392
|
*/
|
|
1387
|
-
'
|
|
1393
|
+
'auth_mode'?: string;
|
|
1388
1394
|
/**
|
|
1389
|
-
*
|
|
1395
|
+
* Account holder name
|
|
1390
1396
|
* @type {string}
|
|
1391
|
-
* @memberof
|
|
1397
|
+
* @memberof CreateSubscriptionPaymentRequestEnack
|
|
1392
1398
|
*/
|
|
1393
|
-
'
|
|
1399
|
+
'account_holder_name'?: string;
|
|
1394
1400
|
/**
|
|
1395
|
-
*
|
|
1401
|
+
* Account number
|
|
1396
1402
|
* @type {string}
|
|
1397
|
-
* @memberof
|
|
1403
|
+
* @memberof CreateSubscriptionPaymentRequestEnack
|
|
1398
1404
|
*/
|
|
1399
|
-
'
|
|
1405
|
+
'account_number'?: string;
|
|
1400
1406
|
/**
|
|
1401
|
-
*
|
|
1407
|
+
* Account bank code (required without AccountIFSC)
|
|
1402
1408
|
* @type {string}
|
|
1403
|
-
* @memberof
|
|
1409
|
+
* @memberof CreateSubscriptionPaymentRequestEnack
|
|
1404
1410
|
*/
|
|
1405
|
-
'
|
|
1411
|
+
'account_bank_code'?: string;
|
|
1406
1412
|
/**
|
|
1407
|
-
*
|
|
1413
|
+
* Account type
|
|
1408
1414
|
* @type {string}
|
|
1409
|
-
* @memberof
|
|
1415
|
+
* @memberof CreateSubscriptionPaymentRequestEnack
|
|
1410
1416
|
*/
|
|
1411
|
-
'
|
|
1417
|
+
'account_type'?: string;
|
|
1418
|
+
/**
|
|
1419
|
+
* Account IFSC
|
|
1420
|
+
* @type {string}
|
|
1421
|
+
* @memberof CreateSubscriptionPaymentRequestEnack
|
|
1422
|
+
*/
|
|
1423
|
+
'account_ifsc'?: string;
|
|
1412
1424
|
}
|
|
1413
1425
|
/**
|
|
1414
|
-
*
|
|
1426
|
+
* @type CreateSubscriptionPaymentRequestPaymentMethod
|
|
1427
|
+
* Payment method. Can be one of [\"upi\", \"enach\", \"pnach\", \"card\"]
|
|
1415
1428
|
* @export
|
|
1416
|
-
* @interface CreateSubscriptionPaymentRequest
|
|
1417
1429
|
*/
|
|
1418
|
-
export
|
|
1430
|
+
export type CreateSubscriptionPaymentRequestPaymentMethod = CreateSubscriptionPaymentRequestCard | CreateSubscriptionPaymentRequestEnack | CreateSubscriptionPaymentRequestPnach | CreateSubscriptonPaymentRequestUpi;
|
|
1431
|
+
/**
|
|
1432
|
+
* payment method pnach.
|
|
1433
|
+
* @export
|
|
1434
|
+
* @interface CreateSubscriptionPaymentRequestPnach
|
|
1435
|
+
*/
|
|
1436
|
+
export interface CreateSubscriptionPaymentRequestPnach {
|
|
1419
1437
|
/**
|
|
1420
|
-
*
|
|
1438
|
+
* Channel. can be post
|
|
1421
1439
|
* @type {string}
|
|
1422
|
-
* @memberof
|
|
1440
|
+
* @memberof CreateSubscriptionPaymentRequestPnach
|
|
1423
1441
|
*/
|
|
1424
|
-
'
|
|
1442
|
+
'channel'?: string;
|
|
1425
1443
|
/**
|
|
1426
|
-
*
|
|
1444
|
+
* Account holder name
|
|
1427
1445
|
* @type {string}
|
|
1428
|
-
* @memberof
|
|
1446
|
+
* @memberof CreateSubscriptionPaymentRequestPnach
|
|
1429
1447
|
*/
|
|
1430
|
-
'
|
|
1448
|
+
'account_holder_name'?: string;
|
|
1431
1449
|
/**
|
|
1432
|
-
*
|
|
1450
|
+
* Account number
|
|
1433
1451
|
* @type {string}
|
|
1434
|
-
* @memberof
|
|
1452
|
+
* @memberof CreateSubscriptionPaymentRequestPnach
|
|
1435
1453
|
*/
|
|
1436
|
-
'
|
|
1454
|
+
'account_number'?: string;
|
|
1437
1455
|
/**
|
|
1438
|
-
*
|
|
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
|
+
}
|
|
1486
|
+
/**
|
|
1487
|
+
* The response returned is Create Subscription Auth or Charge APIs.
|
|
1488
|
+
* @export
|
|
1489
|
+
* @interface CreateSubscriptionPaymentResponse
|
|
1490
|
+
*/
|
|
1491
|
+
export interface CreateSubscriptionPaymentResponse {
|
|
1492
|
+
/**
|
|
1493
|
+
* Cashfree subscription payment reference number
|
|
1494
|
+
* @type {string}
|
|
1495
|
+
* @memberof CreateSubscriptionPaymentResponse
|
|
1496
|
+
*/
|
|
1497
|
+
'cf_payment_id'?: string;
|
|
1498
|
+
/**
|
|
1499
|
+
*
|
|
1500
|
+
* @type {SubscriptionPaymentEntityFailureDetails}
|
|
1501
|
+
* @memberof CreateSubscriptionPaymentResponse
|
|
1502
|
+
*/
|
|
1503
|
+
'failure_details'?: SubscriptionPaymentEntityFailureDetails;
|
|
1504
|
+
/**
|
|
1505
|
+
* The charge amount of the payment.
|
|
1439
1506
|
* @type {number}
|
|
1440
|
-
* @memberof
|
|
1507
|
+
* @memberof CreateSubscriptionPaymentResponse
|
|
1441
1508
|
*/
|
|
1442
1509
|
'payment_amount'?: number;
|
|
1443
1510
|
/**
|
|
1444
|
-
*
|
|
1511
|
+
* A unique ID passed by merchant for identifying the transaction.
|
|
1445
1512
|
* @type {string}
|
|
1446
|
-
* @memberof
|
|
1513
|
+
* @memberof CreateSubscriptionPaymentResponse
|
|
1447
1514
|
*/
|
|
1448
|
-
'
|
|
1515
|
+
'payment_id'?: string;
|
|
1449
1516
|
/**
|
|
1450
|
-
*
|
|
1517
|
+
* The date on which the payment was initiated.
|
|
1451
1518
|
* @type {string}
|
|
1452
|
-
* @memberof
|
|
1519
|
+
* @memberof CreateSubscriptionPaymentResponse
|
|
1453
1520
|
*/
|
|
1454
|
-
'
|
|
1521
|
+
'payment_initiated_date'?: string;
|
|
1522
|
+
/**
|
|
1523
|
+
* Status of the payment.
|
|
1524
|
+
* @type {string}
|
|
1525
|
+
* @memberof CreateSubscriptionPaymentResponse
|
|
1526
|
+
*/
|
|
1527
|
+
'payment_status'?: string;
|
|
1455
1528
|
/**
|
|
1456
1529
|
* Payment type. Can be AUTH or CHARGE.
|
|
1457
1530
|
* @type {string}
|
|
1458
|
-
* @memberof
|
|
1531
|
+
* @memberof CreateSubscriptionPaymentResponse
|
|
1459
1532
|
*/
|
|
1460
|
-
'payment_type'
|
|
1533
|
+
'payment_type'?: string;
|
|
1461
1534
|
/**
|
|
1462
|
-
*
|
|
1535
|
+
* A unique ID passed by merchant for identifying the subscription.
|
|
1536
|
+
* @type {string}
|
|
1537
|
+
* @memberof CreateSubscriptionPaymentResponse
|
|
1538
|
+
*/
|
|
1539
|
+
'subscription_id'?: string;
|
|
1540
|
+
/**
|
|
1541
|
+
* Contains a payload for auth app links in case of AUTH. For charge, the payload is empty.
|
|
1463
1542
|
* @type {object}
|
|
1464
|
-
* @memberof
|
|
1543
|
+
* @memberof CreateSubscriptionPaymentResponse
|
|
1465
1544
|
*/
|
|
1466
|
-
'
|
|
1545
|
+
'data'?: object;
|
|
1546
|
+
/**
|
|
1547
|
+
* Payment method used for the authorization.
|
|
1548
|
+
* @type {string}
|
|
1549
|
+
* @memberof CreateSubscriptionPaymentResponse
|
|
1550
|
+
*/
|
|
1551
|
+
'payment_method'?: string;
|
|
1467
1552
|
}
|
|
1468
1553
|
/**
|
|
1469
1554
|
* Request body to create a subscription refund.
|
|
@@ -1686,6 +1771,25 @@ export interface CreateSubscriptionRequestSubscriptionMeta {
|
|
|
1686
1771
|
*/
|
|
1687
1772
|
'notification_channel'?: Array<string>;
|
|
1688
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
|
+
}
|
|
1689
1793
|
/**
|
|
1690
1794
|
* Request body to create a terminal
|
|
1691
1795
|
* @export
|
|
@@ -1840,7 +1944,7 @@ export interface CreateVendorRequest {
|
|
|
1840
1944
|
*/
|
|
1841
1945
|
'dashboard_access'?: boolean;
|
|
1842
1946
|
/**
|
|
1843
|
-
* Specify the settlement cycle to be updated. View the settlement cycle details from the \"Settlement Cycles Supported\" table.
|
|
1947
|
+
* Specify the settlement cycle to be updated. View the settlement cycle details from the \"Settlement Cycles Supported\" table. If no schedule option is configured, the settlement cycle ID \"1\" will be in effect. Select \"8\" or \"9\" if you want to schedule instant vendor settlements.
|
|
1844
1948
|
* @type {number}
|
|
1845
1949
|
* @memberof CreateVendorRequest
|
|
1846
1950
|
*/
|
|
@@ -1987,7 +2091,7 @@ export interface CryptogramEntity {
|
|
|
1987
2091
|
'card_display'?: string;
|
|
1988
2092
|
}
|
|
1989
2093
|
/**
|
|
1990
|
-
* The customer details that are necessary.
|
|
2094
|
+
* The customer details that are necessary. Note that you can pass dummy details if your use case does not require the customer details.
|
|
1991
2095
|
* @export
|
|
1992
2096
|
* @interface CustomerDetails
|
|
1993
2097
|
*/
|
|
@@ -6665,11 +6769,6 @@ export interface StaticSplitResponseSchemeInner {
|
|
|
6665
6769
|
*/
|
|
6666
6770
|
'percentage'?: string;
|
|
6667
6771
|
}
|
|
6668
|
-
/**
|
|
6669
|
-
* @type SubsCreatePayment200Response
|
|
6670
|
-
* @export
|
|
6671
|
-
*/
|
|
6672
|
-
export type SubsCreatePayment200Response = CreateSubscriptionPaymentAuthResponse | CreateSubscriptionPaymentChargeResponse;
|
|
6673
6772
|
/**
|
|
6674
6773
|
* Bank details object
|
|
6675
6774
|
* @export
|
|
@@ -6938,10 +7037,10 @@ export interface SubscriptionPaymentEntity {
|
|
|
6938
7037
|
'cf_order_id'?: string;
|
|
6939
7038
|
/**
|
|
6940
7039
|
*
|
|
6941
|
-
* @type {
|
|
7040
|
+
* @type {SubscriptionPaymentEntityFailureDetails}
|
|
6942
7041
|
* @memberof SubscriptionPaymentEntity
|
|
6943
7042
|
*/
|
|
6944
|
-
'failure_details'?:
|
|
7043
|
+
'failure_details'?: SubscriptionPaymentEntityFailureDetails;
|
|
6945
7044
|
/**
|
|
6946
7045
|
* The charge amount of the payment.
|
|
6947
7046
|
* @type {number}
|
|
@@ -6997,6 +7096,19 @@ export interface SubscriptionPaymentEntity {
|
|
|
6997
7096
|
*/
|
|
6998
7097
|
'subscription_id'?: string;
|
|
6999
7098
|
}
|
|
7099
|
+
/**
|
|
7100
|
+
*
|
|
7101
|
+
* @export
|
|
7102
|
+
* @interface SubscriptionPaymentEntityFailureDetails
|
|
7103
|
+
*/
|
|
7104
|
+
export interface SubscriptionPaymentEntityFailureDetails {
|
|
7105
|
+
/**
|
|
7106
|
+
* Failure reason of the payment if the payment_status is failed.
|
|
7107
|
+
* @type {string}
|
|
7108
|
+
* @memberof SubscriptionPaymentEntityFailureDetails
|
|
7109
|
+
*/
|
|
7110
|
+
'failure_reason'?: string;
|
|
7111
|
+
}
|
|
7000
7112
|
/**
|
|
7001
7113
|
* Get/Create Subscription Payment Refund Response
|
|
7002
7114
|
* @export
|
|
@@ -7678,7 +7790,7 @@ export interface UpdateVendorRequest {
|
|
|
7678
7790
|
*/
|
|
7679
7791
|
'dashboard_access'?: boolean;
|
|
7680
7792
|
/**
|
|
7681
|
-
* Specify the settlement cycle to be updated. View the settlement cycle details from the \"Settlement Cycles Supported\" table.
|
|
7793
|
+
* Specify the settlement cycle to be updated. View the settlement cycle details from the \"Settlement Cycles Supported\" table. If no schedule option is configured, the settlement cycle ID \"1\" will be in effect. Select \"8\" or \"9\" if you want to schedule instant vendor settlements.
|
|
7682
7794
|
* @type {number}
|
|
7683
7795
|
* @memberof UpdateVendorRequest
|
|
7684
7796
|
*/
|
|
@@ -7806,47 +7918,10 @@ export interface UpdateVendorResponse {
|
|
|
7806
7918
|
'bank_details'?: string;
|
|
7807
7919
|
/**
|
|
7808
7920
|
*
|
|
7809
|
-
* @type {Array<
|
|
7921
|
+
* @type {Array<VendorEntityRelatedDocsInner>}
|
|
7810
7922
|
* @memberof UpdateVendorResponse
|
|
7811
7923
|
*/
|
|
7812
|
-
'related_docs'?: Array<
|
|
7813
|
-
}
|
|
7814
|
-
/**
|
|
7815
|
-
*
|
|
7816
|
-
* @export
|
|
7817
|
-
* @interface UpdateVendorResponseRelatedDocsInner
|
|
7818
|
-
*/
|
|
7819
|
-
export interface UpdateVendorResponseRelatedDocsInner {
|
|
7820
|
-
/**
|
|
7821
|
-
*
|
|
7822
|
-
* @type {string}
|
|
7823
|
-
* @memberof UpdateVendorResponseRelatedDocsInner
|
|
7824
|
-
*/
|
|
7825
|
-
'vendor_id'?: string;
|
|
7826
|
-
/**
|
|
7827
|
-
*
|
|
7828
|
-
* @type {string}
|
|
7829
|
-
* @memberof UpdateVendorResponseRelatedDocsInner
|
|
7830
|
-
*/
|
|
7831
|
-
'doc_type'?: string;
|
|
7832
|
-
/**
|
|
7833
|
-
*
|
|
7834
|
-
* @type {string}
|
|
7835
|
-
* @memberof UpdateVendorResponseRelatedDocsInner
|
|
7836
|
-
*/
|
|
7837
|
-
'doc_value'?: string;
|
|
7838
|
-
/**
|
|
7839
|
-
*
|
|
7840
|
-
* @type {string}
|
|
7841
|
-
* @memberof UpdateVendorResponseRelatedDocsInner
|
|
7842
|
-
*/
|
|
7843
|
-
'status'?: string;
|
|
7844
|
-
/**
|
|
7845
|
-
*
|
|
7846
|
-
* @type {string}
|
|
7847
|
-
* @memberof UpdateVendorResponseRelatedDocsInner
|
|
7848
|
-
*/
|
|
7849
|
-
'remarks'?: string;
|
|
7924
|
+
'related_docs'?: Array<VendorEntityRelatedDocsInner>;
|
|
7850
7925
|
}
|
|
7851
7926
|
/**
|
|
7852
7927
|
* UPI collect payment method object
|
|
@@ -8130,10 +8205,10 @@ export interface VendorDocumentDownloadResponse {
|
|
|
8130
8205
|
export interface VendorDocumentsResponse {
|
|
8131
8206
|
/**
|
|
8132
8207
|
*
|
|
8133
|
-
* @type {Array<
|
|
8208
|
+
* @type {Array<VendorEntityRelatedDocsInner>}
|
|
8134
8209
|
* @memberof VendorDocumentsResponse
|
|
8135
8210
|
*/
|
|
8136
|
-
'documents'?: Array<
|
|
8211
|
+
'documents'?: Array<VendorEntityRelatedDocsInner>;
|
|
8137
8212
|
}
|
|
8138
8213
|
/**
|
|
8139
8214
|
* Vendor entity object
|
|
@@ -8227,10 +8302,47 @@ export interface VendorEntity {
|
|
|
8227
8302
|
'remarks'?: string;
|
|
8228
8303
|
/**
|
|
8229
8304
|
*
|
|
8230
|
-
* @type {Array<
|
|
8305
|
+
* @type {Array<VendorEntityRelatedDocsInner>}
|
|
8231
8306
|
* @memberof VendorEntity
|
|
8232
8307
|
*/
|
|
8233
|
-
'related_docs'?: Array<
|
|
8308
|
+
'related_docs'?: Array<VendorEntityRelatedDocsInner>;
|
|
8309
|
+
}
|
|
8310
|
+
/**
|
|
8311
|
+
*
|
|
8312
|
+
* @export
|
|
8313
|
+
* @interface VendorEntityRelatedDocsInner
|
|
8314
|
+
*/
|
|
8315
|
+
export interface VendorEntityRelatedDocsInner {
|
|
8316
|
+
/**
|
|
8317
|
+
*
|
|
8318
|
+
* @type {string}
|
|
8319
|
+
* @memberof VendorEntityRelatedDocsInner
|
|
8320
|
+
*/
|
|
8321
|
+
'vendor_id'?: string;
|
|
8322
|
+
/**
|
|
8323
|
+
*
|
|
8324
|
+
* @type {string}
|
|
8325
|
+
* @memberof VendorEntityRelatedDocsInner
|
|
8326
|
+
*/
|
|
8327
|
+
'doc_type'?: string;
|
|
8328
|
+
/**
|
|
8329
|
+
*
|
|
8330
|
+
* @type {string}
|
|
8331
|
+
* @memberof VendorEntityRelatedDocsInner
|
|
8332
|
+
*/
|
|
8333
|
+
'doc_value'?: string;
|
|
8334
|
+
/**
|
|
8335
|
+
*
|
|
8336
|
+
* @type {string}
|
|
8337
|
+
* @memberof VendorEntityRelatedDocsInner
|
|
8338
|
+
*/
|
|
8339
|
+
'status'?: string;
|
|
8340
|
+
/**
|
|
8341
|
+
*
|
|
8342
|
+
* @type {string}
|
|
8343
|
+
* @memberof VendorEntityRelatedDocsInner
|
|
8344
|
+
*/
|
|
8345
|
+
'remarks'?: string;
|
|
8234
8346
|
}
|
|
8235
8347
|
/**
|
|
8236
8348
|
* Use to split order when cashfree\'s Easy Split is enabled for your account.
|
|
@@ -8653,11 +8765,12 @@ export declare class Cashfree {
|
|
|
8653
8765
|
* @param {string} link_id The payment link ID for which you want to view the details.
|
|
8654
8766
|
* @param {string} [x_request_id] Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree
|
|
8655
8767
|
* @param {string} [x_idempotency_key] An idempotency key is a unique identifier you include with your API call. If the request fails or times out, you can safely retry it using the same key to avoid duplicate actions.
|
|
8768
|
+
* @param {string} [status] Mention What is status of orders you want to fetch, default is PAID. Possible value: ALL, PAID
|
|
8656
8769
|
* @param {*} [options] Override http request option.
|
|
8657
8770
|
* @throws {RequiredError}
|
|
8658
8771
|
* @memberof PaymentLinksApi
|
|
8659
8772
|
*/
|
|
8660
|
-
static PGLinkFetchOrders(x_api_version: string, link_id: string, x_request_id?: string, x_idempotency_key?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PaymentLinkOrderEntity[], any>>;
|
|
8773
|
+
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>>;
|
|
8661
8774
|
/**
|
|
8662
8775
|
* Use this API to capture or void a preauthorized payment
|
|
8663
8776
|
* @summary Preauthorization
|
|
@@ -8947,7 +9060,7 @@ export declare class Cashfree {
|
|
|
8947
9060
|
* @throws {RequiredError}
|
|
8948
9061
|
* @memberof SubscriptionApi
|
|
8949
9062
|
*/
|
|
8950
|
-
static SubsCreatePayment(x_api_version: string, CreateSubscriptionPaymentRequest: CreateSubscriptionPaymentRequest, x_request_id?: string, x_idempotency_key?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
9063
|
+
static SubsCreatePayment(x_api_version: string, CreateSubscriptionPaymentRequest: CreateSubscriptionPaymentRequest, x_request_id?: string, x_idempotency_key?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateSubscriptionPaymentResponse, any>>;
|
|
8951
9064
|
/**
|
|
8952
9065
|
* 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.
|
|
8953
9066
|
* @summary Create a plan.
|
|
@@ -9076,7 +9189,7 @@ export declare class Cashfree {
|
|
|
9076
9189
|
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>>;
|
|
9077
9190
|
/**
|
|
9078
9191
|
* Use this API to upload Physical Nach for Physical Nach Authorization.
|
|
9079
|
-
* @summary
|
|
9192
|
+
* @summary API to upload Physical Nach for Physical Nach Authorization.
|
|
9080
9193
|
* @param {string} x_api_version API version to be used. Format is in YYYY-MM-DD
|
|
9081
9194
|
* @param {string} payment_id Provide the PaymentId using which the payment was created.
|
|
9082
9195
|
* @param {File} file Select the .jpg file that should be uploaded or provide the path of that file. You cannot upload a file that is more than 1MB in size.
|
|
@@ -9091,7 +9204,7 @@ export declare class Cashfree {
|
|
|
9091
9204
|
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>>;
|
|
9092
9205
|
/**
|
|
9093
9206
|
* Use this API to check if a payment method is enabled for your account.
|
|
9094
|
-
* @summary
|
|
9207
|
+
* @summary API to get all the payment method details available for subscription payments.
|
|
9095
9208
|
* @param {string} x_api_version API version to be used. Format is in YYYY-MM-DD
|
|
9096
9209
|
* @param {SubscriptionEligibilityRequest} SubscriptionEligibilityRequest Request body to fetch subscription eligibile payment method details.
|
|
9097
9210
|
* @param {string} [x_request_id] Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree
|