cashfree-pg 3.2.0 → 4.0.2
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 +642 -341
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +158 -172
- package/dist/api.js +392 -81
- package/dist/base.d.ts +1 -1
- package/dist/base.js +1 -1
- package/dist/common.d.ts +1 -1
- package/dist/common.js +1 -1
- package/dist/configuration.d.ts +1 -1
- package/dist/configuration.js +1 -1
- package/dist/esm/api.d.ts +158 -172
- package/dist/esm/api.js +392 -81
- package/dist/esm/base.d.ts +1 -1
- package/dist/esm/base.js +1 -1
- package/dist/esm/common.d.ts +1 -1
- package/dist/esm/common.js +1 -1
- package/dist/esm/configuration.d.ts +1 -1
- package/dist/esm/configuration.js +1 -1
- package/dist/esm/index.d.ts +1 -1
- package/dist/esm/index.js +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.js +1 -1
- package/index.ts +1 -1
- package/package.json +1 -1
package/base.ts
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Cashfree Payment Gateway APIs
|
|
5
5
|
* Cashfree\'s Payment Gateway APIs provide developers with a streamlined pathway to integrate advanced payment processing capabilities into their applications, platforms and websites.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document:
|
|
7
|
+
* The version of the OpenAPI document: 2023-08-01
|
|
8
8
|
* Contact: developers@cashfree.com
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/common.ts
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Cashfree Payment Gateway APIs
|
|
5
5
|
* Cashfree\'s Payment Gateway APIs provide developers with a streamlined pathway to integrate advanced payment processing capabilities into their applications, platforms and websites.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document:
|
|
7
|
+
* The version of the OpenAPI document: 2023-08-01
|
|
8
8
|
* Contact: developers@cashfree.com
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/configuration.ts
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Cashfree Payment Gateway APIs
|
|
5
5
|
* Cashfree\'s Payment Gateway APIs provide developers with a streamlined pathway to integrate advanced payment processing capabilities into their applications, platforms and websites.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document:
|
|
7
|
+
* The version of the OpenAPI document: 2023-08-01
|
|
8
8
|
* Contact: developers@cashfree.com
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/api.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Cashfree Payment Gateway APIs
|
|
3
3
|
* Cashfree\'s Payment Gateway APIs provide developers with a streamlined pathway to integrate advanced payment processing capabilities into their applications, platforms and websites.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document:
|
|
5
|
+
* The version of the OpenAPI document: 2023-08-01
|
|
6
6
|
* Contact: developers@cashfree.com
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -702,6 +702,31 @@ export declare const CashbackDetailsCashbackTypeEnum: {
|
|
|
702
702
|
readonly UNKNOWN_DEFAULT_OPEN_API: "11184809";
|
|
703
703
|
};
|
|
704
704
|
export type CashbackDetailsCashbackTypeEnum = typeof CashbackDetailsCashbackTypeEnum[keyof typeof CashbackDetailsCashbackTypeEnum];
|
|
705
|
+
/**
|
|
706
|
+
* Request body to create a customer at cashfree
|
|
707
|
+
* @export
|
|
708
|
+
* @interface CreateCustomerRequest
|
|
709
|
+
*/
|
|
710
|
+
export interface CreateCustomerRequest {
|
|
711
|
+
/**
|
|
712
|
+
* Customer Phone Number
|
|
713
|
+
* @type {string}
|
|
714
|
+
* @memberof CreateCustomerRequest
|
|
715
|
+
*/
|
|
716
|
+
'customer_phone': string;
|
|
717
|
+
/**
|
|
718
|
+
* Customer Email
|
|
719
|
+
* @type {string}
|
|
720
|
+
* @memberof CreateCustomerRequest
|
|
721
|
+
*/
|
|
722
|
+
'customer_email'?: string;
|
|
723
|
+
/**
|
|
724
|
+
* Customer Name
|
|
725
|
+
* @type {string}
|
|
726
|
+
* @memberof CreateCustomerRequest
|
|
727
|
+
*/
|
|
728
|
+
'customer_name'?: string;
|
|
729
|
+
}
|
|
705
730
|
/**
|
|
706
731
|
* Request paramenters for link creation
|
|
707
732
|
* @export
|
|
@@ -778,10 +803,10 @@ export interface CreateLinkRequest {
|
|
|
778
803
|
};
|
|
779
804
|
/**
|
|
780
805
|
*
|
|
781
|
-
* @type {
|
|
806
|
+
* @type {LinkMetaResponseEntity}
|
|
782
807
|
* @memberof CreateLinkRequest
|
|
783
808
|
*/
|
|
784
|
-
'link_meta'?:
|
|
809
|
+
'link_meta'?: LinkMetaResponseEntity;
|
|
785
810
|
}
|
|
786
811
|
/**
|
|
787
812
|
* create offer backend request object
|
|
@@ -959,16 +984,16 @@ export interface CreateTerminalRequestTerminalMeta {
|
|
|
959
984
|
export interface CreateTerminalTransactionRequest {
|
|
960
985
|
/**
|
|
961
986
|
* cashfree order ID that was returned while creating an order.
|
|
962
|
-
* @type {
|
|
987
|
+
* @type {string}
|
|
963
988
|
* @memberof CreateTerminalTransactionRequest
|
|
964
989
|
*/
|
|
965
|
-
'cf_order_id':
|
|
990
|
+
'cf_order_id': string;
|
|
966
991
|
/**
|
|
967
992
|
* cashfree terminal id. this is a required parameter when you do not provide the terminal phone number.
|
|
968
|
-
* @type {
|
|
993
|
+
* @type {string}
|
|
969
994
|
* @memberof CreateTerminalTransactionRequest
|
|
970
995
|
*/
|
|
971
|
-
'cf_terminal_id'?:
|
|
996
|
+
'cf_terminal_id'?: string;
|
|
972
997
|
/**
|
|
973
998
|
* mention the payment method used for the transaction. possible values - QR_CODE, LINK.
|
|
974
999
|
* @type {string}
|
|
@@ -1079,6 +1104,12 @@ export interface CustomerDetails {
|
|
|
1079
1104
|
* @memberof CustomerDetails
|
|
1080
1105
|
*/
|
|
1081
1106
|
'customer_bank_code'?: number;
|
|
1107
|
+
/**
|
|
1108
|
+
* Customer identifier at Cashfree. You will get this when you create/get customer
|
|
1109
|
+
* @type {string}
|
|
1110
|
+
* @memberof CustomerDetails
|
|
1111
|
+
*/
|
|
1112
|
+
'customer_uid'?: string;
|
|
1082
1113
|
}
|
|
1083
1114
|
/**
|
|
1084
1115
|
* Details of the customer for whom eligibility is being checked.
|
|
@@ -1093,6 +1124,37 @@ export interface CustomerDetailsCardlessEMI {
|
|
|
1093
1124
|
*/
|
|
1094
1125
|
'customer_phone': string;
|
|
1095
1126
|
}
|
|
1127
|
+
/**
|
|
1128
|
+
* The complete customer entity
|
|
1129
|
+
* @export
|
|
1130
|
+
* @interface CustomerEntity
|
|
1131
|
+
*/
|
|
1132
|
+
export interface CustomerEntity {
|
|
1133
|
+
/**
|
|
1134
|
+
* unique id generated by cashfree for your customer
|
|
1135
|
+
* @type {string}
|
|
1136
|
+
* @memberof CustomerEntity
|
|
1137
|
+
*/
|
|
1138
|
+
'customer_uid'?: string;
|
|
1139
|
+
/**
|
|
1140
|
+
* Customer Phone Number
|
|
1141
|
+
* @type {string}
|
|
1142
|
+
* @memberof CustomerEntity
|
|
1143
|
+
*/
|
|
1144
|
+
'customer_phone'?: string;
|
|
1145
|
+
/**
|
|
1146
|
+
* Customer Email
|
|
1147
|
+
* @type {string}
|
|
1148
|
+
* @memberof CustomerEntity
|
|
1149
|
+
*/
|
|
1150
|
+
'customer_email'?: string;
|
|
1151
|
+
/**
|
|
1152
|
+
* Customer Name
|
|
1153
|
+
* @type {string}
|
|
1154
|
+
* @memberof CustomerEntity
|
|
1155
|
+
*/
|
|
1156
|
+
'customer_name'?: string;
|
|
1157
|
+
}
|
|
1096
1158
|
/**
|
|
1097
1159
|
* detils of the discount object of offer
|
|
1098
1160
|
* @export
|
|
@@ -1526,10 +1588,10 @@ export interface FetchSettlementsRequest {
|
|
|
1526
1588
|
export interface FetchSettlementsRequestFilters {
|
|
1527
1589
|
/**
|
|
1528
1590
|
* List of settlement IDs for which you want the settlement reconciliation details.
|
|
1529
|
-
* @type {Array<
|
|
1591
|
+
* @type {Array<string>}
|
|
1530
1592
|
* @memberof FetchSettlementsRequestFilters
|
|
1531
1593
|
*/
|
|
1532
|
-
'cf_settlement_ids'?: Array<
|
|
1594
|
+
'cf_settlement_ids'?: Array<string>;
|
|
1533
1595
|
/**
|
|
1534
1596
|
* List of settlement UTRs for which you want the settlement reconciliation details.
|
|
1535
1597
|
* @type {Array<string>}
|
|
@@ -1785,10 +1847,10 @@ export interface LinkCustomerDetailsEntity {
|
|
|
1785
1847
|
export interface LinkEntity {
|
|
1786
1848
|
/**
|
|
1787
1849
|
*
|
|
1788
|
-
* @type {
|
|
1850
|
+
* @type {string}
|
|
1789
1851
|
* @memberof LinkEntity
|
|
1790
1852
|
*/
|
|
1791
|
-
'cf_link_id'?:
|
|
1853
|
+
'cf_link_id'?: string;
|
|
1792
1854
|
/**
|
|
1793
1855
|
*
|
|
1794
1856
|
* @type {string}
|
|
@@ -1850,13 +1912,11 @@ export interface LinkEntity {
|
|
|
1850
1912
|
*/
|
|
1851
1913
|
'customer_details'?: LinkCustomerDetailsEntity;
|
|
1852
1914
|
/**
|
|
1853
|
-
*
|
|
1854
|
-
* @type {
|
|
1915
|
+
*
|
|
1916
|
+
* @type {LinkMetaResponseEntity}
|
|
1855
1917
|
* @memberof LinkEntity
|
|
1856
1918
|
*/
|
|
1857
|
-
'link_meta'?:
|
|
1858
|
-
[key: string]: string;
|
|
1859
|
-
};
|
|
1919
|
+
'link_meta'?: LinkMetaResponseEntity;
|
|
1860
1920
|
/**
|
|
1861
1921
|
*
|
|
1862
1922
|
* @type {string}
|
|
@@ -1893,31 +1953,31 @@ export interface LinkEntity {
|
|
|
1893
1953
|
/**
|
|
1894
1954
|
* Payment link meta information object
|
|
1895
1955
|
* @export
|
|
1896
|
-
* @interface
|
|
1956
|
+
* @interface LinkMetaResponseEntity
|
|
1897
1957
|
*/
|
|
1898
|
-
export interface
|
|
1958
|
+
export interface LinkMetaResponseEntity {
|
|
1899
1959
|
/**
|
|
1900
1960
|
* Notification URL for server-server communication. It should be an https URL.
|
|
1901
1961
|
* @type {string}
|
|
1902
|
-
* @memberof
|
|
1962
|
+
* @memberof LinkMetaResponseEntity
|
|
1903
1963
|
*/
|
|
1904
1964
|
'notify_url'?: string;
|
|
1905
1965
|
/**
|
|
1906
1966
|
* If \"true\", link will directly open UPI Intent flow on mobile, and normal link flow elsewhere
|
|
1907
1967
|
* @type {boolean}
|
|
1908
|
-
* @memberof
|
|
1968
|
+
* @memberof LinkMetaResponseEntity
|
|
1909
1969
|
*/
|
|
1910
1970
|
'upi_intent'?: boolean;
|
|
1911
1971
|
/**
|
|
1912
1972
|
* The URL to which user will be redirected to after the payment is done on the link. Maximum length: 250.
|
|
1913
1973
|
* @type {string}
|
|
1914
|
-
* @memberof
|
|
1974
|
+
* @memberof LinkMetaResponseEntity
|
|
1915
1975
|
*/
|
|
1916
1976
|
'return_url'?: string;
|
|
1917
1977
|
/**
|
|
1918
1978
|
* Allowed payment modes for this link. Pass comma-separated values among following options - \"cc\", \"dc\", \"ccc\", \"ppc\", \"nb\", \"upi\", \"paypal\", \"app\". Leave it blank to show all available payment methods
|
|
1919
1979
|
* @type {string}
|
|
1920
|
-
* @memberof
|
|
1980
|
+
* @memberof LinkMetaResponseEntity
|
|
1921
1981
|
*/
|
|
1922
1982
|
'payment_methods'?: string;
|
|
1923
1983
|
}
|
|
@@ -2270,12 +2330,6 @@ export interface OfferValidations {
|
|
|
2270
2330
|
* @memberof OfferValidations
|
|
2271
2331
|
*/
|
|
2272
2332
|
'payment_method': OfferValidationsPaymentMethod;
|
|
2273
|
-
/**
|
|
2274
|
-
* Maximum amount of Offer that can be availed.
|
|
2275
|
-
* @type {number}
|
|
2276
|
-
* @memberof OfferValidations
|
|
2277
|
-
*/
|
|
2278
|
-
'max_allowed': number;
|
|
2279
2333
|
}
|
|
2280
2334
|
/**
|
|
2281
2335
|
* @type OfferValidationsPaymentMethod
|
|
@@ -2303,10 +2357,10 @@ export interface OfferWallet {
|
|
|
2303
2357
|
export interface OrderAuthenticateEntity {
|
|
2304
2358
|
/**
|
|
2305
2359
|
* The payment id for which this request was sent
|
|
2306
|
-
* @type {
|
|
2360
|
+
* @type {string}
|
|
2307
2361
|
* @memberof OrderAuthenticateEntity
|
|
2308
2362
|
*/
|
|
2309
|
-
'cf_payment_id'?:
|
|
2363
|
+
'cf_payment_id'?: string;
|
|
2310
2364
|
/**
|
|
2311
2365
|
* The action that was invoked for this request.
|
|
2312
2366
|
* @type {string}
|
|
@@ -2414,10 +2468,10 @@ export type OrderCreateRefundRequestRefundSpeedEnum = typeof OrderCreateRefundRe
|
|
|
2414
2468
|
export interface OrderEntity {
|
|
2415
2469
|
/**
|
|
2416
2470
|
* unique id generated by cashfree for your order
|
|
2417
|
-
* @type {
|
|
2471
|
+
* @type {string}
|
|
2418
2472
|
* @memberof OrderEntity
|
|
2419
2473
|
*/
|
|
2420
|
-
'cf_order_id'?:
|
|
2474
|
+
'cf_order_id'?: string;
|
|
2421
2475
|
/**
|
|
2422
2476
|
* order_id sent during the api request
|
|
2423
2477
|
* @type {string}
|
|
@@ -2443,7 +2497,7 @@ export interface OrderEntity {
|
|
|
2443
2497
|
*/
|
|
2444
2498
|
'order_amount'?: number;
|
|
2445
2499
|
/**
|
|
2446
|
-
* Possible values are - `ACTIVE`: Order does not have a sucessful transaction yet - `PAID`: Order is PAID with one successful transaction - `EXPIRED`: Order was not PAID and not it has expired. No transaction can be initiated for an EXPIRED order.
|
|
2500
|
+
* Possible values are - `ACTIVE`: Order does not have a sucessful transaction yet - `PAID`: Order is PAID with one successful transaction - `EXPIRED`: Order was not PAID and not it has expired. No transaction can be initiated for an EXPIRED order. `TERMINATED`: Order terminated `TERMINATION_REQUESTED`: Order termination requested
|
|
2447
2501
|
* @type {string}
|
|
2448
2502
|
* @memberof OrderEntity
|
|
2449
2503
|
*/
|
|
@@ -2490,24 +2544,6 @@ export interface OrderEntity {
|
|
|
2490
2544
|
* @memberof OrderEntity
|
|
2491
2545
|
*/
|
|
2492
2546
|
'order_meta'?: OrderMeta;
|
|
2493
|
-
/**
|
|
2494
|
-
*
|
|
2495
|
-
* @type {PaymentURLObject}
|
|
2496
|
-
* @memberof OrderEntity
|
|
2497
|
-
*/
|
|
2498
|
-
'payments'?: PaymentURLObject;
|
|
2499
|
-
/**
|
|
2500
|
-
*
|
|
2501
|
-
* @type {SettlementURLObject}
|
|
2502
|
-
* @memberof OrderEntity
|
|
2503
|
-
*/
|
|
2504
|
-
'settlements'?: SettlementURLObject;
|
|
2505
|
-
/**
|
|
2506
|
-
*
|
|
2507
|
-
* @type {RefundURLObject}
|
|
2508
|
-
* @memberof OrderEntity
|
|
2509
|
-
*/
|
|
2510
|
-
'refunds'?: RefundURLObject;
|
|
2511
2547
|
/**
|
|
2512
2548
|
* Custom Tags in thr form of {\"key\":\"value\"} which can be passed for an order. A maximum of 10 tags can be added
|
|
2513
2549
|
* @type {{ [key: string]: string; }}
|
|
@@ -2524,7 +2560,7 @@ export interface OrderEntity {
|
|
|
2524
2560
|
*/
|
|
2525
2561
|
export interface OrderMeta {
|
|
2526
2562
|
/**
|
|
2527
|
-
* The URL to which user will be redirected to after the payment on bank OTP page. Maximum length: 250.
|
|
2563
|
+
* The URL to which user will be redirected to after the payment on bank OTP page. Maximum length: 250. We suggest to keep context of order_id in your return_url so that you can identify the order when customer lands on your page. Example of return_url format could be https://example.com/return?order_id=myOrderId
|
|
2528
2564
|
* @type {string}
|
|
2529
2565
|
* @memberof OrderMeta
|
|
2530
2566
|
*/
|
|
@@ -2587,10 +2623,10 @@ export interface PayOrderEntity {
|
|
|
2587
2623
|
'payment_amount'?: number;
|
|
2588
2624
|
/**
|
|
2589
2625
|
* Payment identifier created by Cashfree
|
|
2590
|
-
* @type {
|
|
2626
|
+
* @type {string}
|
|
2591
2627
|
* @memberof PayOrderEntity
|
|
2592
2628
|
*/
|
|
2593
|
-
'cf_payment_id'?:
|
|
2629
|
+
'cf_payment_id'?: string;
|
|
2594
2630
|
/**
|
|
2595
2631
|
* One of [\"upi\", \"netbanking\", \"card\", \"app\", \"cardless_emi\", \"paylater\", \"banktransfer\"]
|
|
2596
2632
|
* @type {string}
|
|
@@ -2762,10 +2798,10 @@ export interface PaylaterPaymentMethod {
|
|
|
2762
2798
|
export interface PaymentEntity {
|
|
2763
2799
|
/**
|
|
2764
2800
|
*
|
|
2765
|
-
* @type {
|
|
2801
|
+
* @type {string}
|
|
2766
2802
|
* @memberof PaymentEntity
|
|
2767
2803
|
*/
|
|
2768
|
-
'cf_payment_id'?:
|
|
2804
|
+
'cf_payment_id'?: string;
|
|
2769
2805
|
/**
|
|
2770
2806
|
*
|
|
2771
2807
|
* @type {string}
|
|
@@ -2931,10 +2967,10 @@ export interface PaymentLinkCustomerDetails {
|
|
|
2931
2967
|
export interface PaymentLinkOrderEntity {
|
|
2932
2968
|
/**
|
|
2933
2969
|
* unique id generated by cashfree for your order
|
|
2934
|
-
* @type {
|
|
2970
|
+
* @type {string}
|
|
2935
2971
|
* @memberof PaymentLinkOrderEntity
|
|
2936
2972
|
*/
|
|
2937
|
-
'cf_order_id'?:
|
|
2973
|
+
'cf_order_id'?: string;
|
|
2938
2974
|
/**
|
|
2939
2975
|
* link id of the order
|
|
2940
2976
|
* @type {string}
|
|
@@ -3013,24 +3049,6 @@ export interface PaymentLinkOrderEntity {
|
|
|
3013
3049
|
* @memberof PaymentLinkOrderEntity
|
|
3014
3050
|
*/
|
|
3015
3051
|
'order_meta'?: OrderMeta;
|
|
3016
|
-
/**
|
|
3017
|
-
*
|
|
3018
|
-
* @type {PaymentURLObject}
|
|
3019
|
-
* @memberof PaymentLinkOrderEntity
|
|
3020
|
-
*/
|
|
3021
|
-
'payments'?: PaymentURLObject;
|
|
3022
|
-
/**
|
|
3023
|
-
*
|
|
3024
|
-
* @type {SettlementURLObject}
|
|
3025
|
-
* @memberof PaymentLinkOrderEntity
|
|
3026
|
-
*/
|
|
3027
|
-
'settlements'?: SettlementURLObject;
|
|
3028
|
-
/**
|
|
3029
|
-
*
|
|
3030
|
-
* @type {RefundURLObject}
|
|
3031
|
-
* @memberof PaymentLinkOrderEntity
|
|
3032
|
-
*/
|
|
3033
|
-
'refunds'?: RefundURLObject;
|
|
3034
3052
|
/**
|
|
3035
3053
|
* Custom Tags in thr form of {\"key\":\"value\"} which can be passed for an order. A maximum of 10 tags can be added
|
|
3036
3054
|
* @type {{ [key: string]: string; }}
|
|
@@ -3227,7 +3245,7 @@ export interface PaymentMethodUPIInPaymentsEntity {
|
|
|
3227
3245
|
'upi_id'?: string;
|
|
3228
3246
|
}
|
|
3229
3247
|
/**
|
|
3230
|
-
* Filter for
|
|
3248
|
+
* Filter for Payment Methods
|
|
3231
3249
|
* @export
|
|
3232
3250
|
* @interface PaymentMethodsFilters
|
|
3233
3251
|
*/
|
|
@@ -3289,19 +3307,6 @@ export interface PaymentModeDetails {
|
|
|
3289
3307
|
*/
|
|
3290
3308
|
'code'?: number;
|
|
3291
3309
|
}
|
|
3292
|
-
/**
|
|
3293
|
-
* URL for payment retrieval for an order
|
|
3294
|
-
* @export
|
|
3295
|
-
* @interface PaymentURLObject
|
|
3296
|
-
*/
|
|
3297
|
-
export interface PaymentURLObject {
|
|
3298
|
-
/**
|
|
3299
|
-
*
|
|
3300
|
-
* @type {string}
|
|
3301
|
-
* @memberof PaymentURLObject
|
|
3302
|
-
*/
|
|
3303
|
-
'url'?: string;
|
|
3304
|
-
}
|
|
3305
3310
|
/**
|
|
3306
3311
|
* payment webhook object
|
|
3307
3312
|
* @export
|
|
@@ -3691,16 +3696,16 @@ export interface ReconEntityDataInner {
|
|
|
3691
3696
|
'payment_service_tax'?: number;
|
|
3692
3697
|
/**
|
|
3693
3698
|
* Cashfree Payments unique ID to identify a payment.
|
|
3694
|
-
* @type {
|
|
3699
|
+
* @type {string}
|
|
3695
3700
|
* @memberof ReconEntityDataInner
|
|
3696
3701
|
*/
|
|
3697
|
-
'cf_payment_id'?:
|
|
3702
|
+
'cf_payment_id'?: string;
|
|
3698
3703
|
/**
|
|
3699
3704
|
* Unique ID to identify the settlement.
|
|
3700
|
-
* @type {
|
|
3705
|
+
* @type {string}
|
|
3701
3706
|
* @memberof ReconEntityDataInner
|
|
3702
3707
|
*/
|
|
3703
|
-
'cf_settlement_id'?:
|
|
3708
|
+
'cf_settlement_id'?: string;
|
|
3704
3709
|
/**
|
|
3705
3710
|
* Date and time when the settlement was processed.
|
|
3706
3711
|
* @type {string}
|
|
@@ -3866,10 +3871,10 @@ export interface ReconEntityDataInner {
|
|
|
3866
3871
|
export interface RefundEntity {
|
|
3867
3872
|
/**
|
|
3868
3873
|
* Cashfree Payments ID of the payment for which refund is initiated
|
|
3869
|
-
* @type {
|
|
3874
|
+
* @type {string}
|
|
3870
3875
|
* @memberof RefundEntity
|
|
3871
3876
|
*/
|
|
3872
|
-
'cf_payment_id'?:
|
|
3877
|
+
'cf_payment_id'?: string;
|
|
3873
3878
|
/**
|
|
3874
3879
|
* Cashfree Payments ID for a refund
|
|
3875
3880
|
* @type {string}
|
|
@@ -4036,19 +4041,6 @@ export interface RefundSpeed {
|
|
|
4036
4041
|
*/
|
|
4037
4042
|
'message'?: string;
|
|
4038
4043
|
}
|
|
4039
|
-
/**
|
|
4040
|
-
* URL to get refunds for order
|
|
4041
|
-
* @export
|
|
4042
|
-
* @interface RefundURLObject
|
|
4043
|
-
*/
|
|
4044
|
-
export interface RefundURLObject {
|
|
4045
|
-
/**
|
|
4046
|
-
*
|
|
4047
|
-
* @type {string}
|
|
4048
|
-
* @memberof RefundURLObject
|
|
4049
|
-
*/
|
|
4050
|
-
'url'?: string;
|
|
4051
|
-
}
|
|
4052
4044
|
/**
|
|
4053
4045
|
* refund webhook object
|
|
4054
4046
|
* @export
|
|
@@ -4132,16 +4124,16 @@ export interface SavedInstrumentMeta {
|
|
|
4132
4124
|
export interface SettlementEntity {
|
|
4133
4125
|
/**
|
|
4134
4126
|
*
|
|
4135
|
-
* @type {
|
|
4127
|
+
* @type {string}
|
|
4136
4128
|
* @memberof SettlementEntity
|
|
4137
4129
|
*/
|
|
4138
|
-
'cf_payment_id'?:
|
|
4130
|
+
'cf_payment_id'?: string;
|
|
4139
4131
|
/**
|
|
4140
4132
|
*
|
|
4141
|
-
* @type {
|
|
4133
|
+
* @type {string}
|
|
4142
4134
|
* @memberof SettlementEntity
|
|
4143
4135
|
*/
|
|
4144
|
-
'cf_settlement_id'?:
|
|
4136
|
+
'cf_settlement_id'?: string;
|
|
4145
4137
|
/**
|
|
4146
4138
|
*
|
|
4147
4139
|
* @type {string}
|
|
@@ -4229,41 +4221,10 @@ export interface SettlementFetchReconRequest {
|
|
|
4229
4221
|
'pagination': FetchSettlementsRequestPagination;
|
|
4230
4222
|
/**
|
|
4231
4223
|
*
|
|
4232
|
-
* @type {
|
|
4224
|
+
* @type {FetchSettlementsRequestFilters}
|
|
4233
4225
|
* @memberof SettlementFetchReconRequest
|
|
4234
4226
|
*/
|
|
4235
|
-
'filters':
|
|
4236
|
-
}
|
|
4237
|
-
/**
|
|
4238
|
-
* Specify either the Settlement ID, Settlement UTR, or start date and end date to fetch the settlement details.
|
|
4239
|
-
* @export
|
|
4240
|
-
* @interface SettlementFetchReconRequestFilters
|
|
4241
|
-
*/
|
|
4242
|
-
export interface SettlementFetchReconRequestFilters {
|
|
4243
|
-
/**
|
|
4244
|
-
* List of settlement IDs for which you want the settlement reconciliation details.
|
|
4245
|
-
* @type {Array<number>}
|
|
4246
|
-
* @memberof SettlementFetchReconRequestFilters
|
|
4247
|
-
*/
|
|
4248
|
-
'cf_settlement_ids'?: Array<number>;
|
|
4249
|
-
/**
|
|
4250
|
-
* List of settlement UTRs for which you want the settlement reconciliation details.
|
|
4251
|
-
* @type {Array<string>}
|
|
4252
|
-
* @memberof SettlementFetchReconRequestFilters
|
|
4253
|
-
*/
|
|
4254
|
-
'settlement_utrs'?: Array<string>;
|
|
4255
|
-
/**
|
|
4256
|
-
* Specify the start date from when you want the settlement reconciliation details.
|
|
4257
|
-
* @type {string}
|
|
4258
|
-
* @memberof SettlementFetchReconRequestFilters
|
|
4259
|
-
*/
|
|
4260
|
-
'start_date'?: string;
|
|
4261
|
-
/**
|
|
4262
|
-
* Specify the end date till when you want the settlement reconciliation details.
|
|
4263
|
-
* @type {string}
|
|
4264
|
-
* @memberof SettlementFetchReconRequestFilters
|
|
4265
|
-
*/
|
|
4266
|
-
'end_date'?: string;
|
|
4227
|
+
'filters': FetchSettlementsRequestFilters;
|
|
4267
4228
|
}
|
|
4268
4229
|
/**
|
|
4269
4230
|
* Recon object for settlement
|
|
@@ -4412,16 +4373,16 @@ export interface SettlementReconEntityDataInner {
|
|
|
4412
4373
|
'payment_service_tax'?: number;
|
|
4413
4374
|
/**
|
|
4414
4375
|
* Cashfree Payments unique ID to identify a payment.
|
|
4415
|
-
* @type {
|
|
4376
|
+
* @type {string}
|
|
4416
4377
|
* @memberof SettlementReconEntityDataInner
|
|
4417
4378
|
*/
|
|
4418
|
-
'cf_payment_id'?:
|
|
4379
|
+
'cf_payment_id'?: string;
|
|
4419
4380
|
/**
|
|
4420
4381
|
* Unique ID to identify the settlement.
|
|
4421
|
-
* @type {
|
|
4382
|
+
* @type {string}
|
|
4422
4383
|
* @memberof SettlementReconEntityDataInner
|
|
4423
4384
|
*/
|
|
4424
|
-
'cf_settlement_id'?:
|
|
4385
|
+
'cf_settlement_id'?: string;
|
|
4425
4386
|
/**
|
|
4426
4387
|
* Date and time when the settlement was processed.
|
|
4427
4388
|
* @type {string}
|
|
@@ -4507,19 +4468,6 @@ export interface SettlementReconEntityDataInner {
|
|
|
4507
4468
|
*/
|
|
4508
4469
|
'adjustment_remarks'?: string;
|
|
4509
4470
|
}
|
|
4510
|
-
/**
|
|
4511
|
-
* Settlement URL object
|
|
4512
|
-
* @export
|
|
4513
|
-
* @interface SettlementURLObject
|
|
4514
|
-
*/
|
|
4515
|
-
export interface SettlementURLObject {
|
|
4516
|
-
/**
|
|
4517
|
-
*
|
|
4518
|
-
* @type {string}
|
|
4519
|
-
* @memberof SettlementURLObject
|
|
4520
|
-
*/
|
|
4521
|
-
'url'?: string;
|
|
4522
|
-
}
|
|
4523
4471
|
/**
|
|
4524
4472
|
* Settlement webhook object
|
|
4525
4473
|
* @export
|
|
@@ -4572,10 +4520,10 @@ export interface TerminalDetails {
|
|
|
4572
4520
|
'added_on'?: string;
|
|
4573
4521
|
/**
|
|
4574
4522
|
* cashfree terminal id
|
|
4575
|
-
* @type {
|
|
4523
|
+
* @type {string}
|
|
4576
4524
|
* @memberof TerminalDetails
|
|
4577
4525
|
*/
|
|
4578
|
-
'cf_terminal_id'?:
|
|
4526
|
+
'cf_terminal_id'?: string;
|
|
4579
4527
|
/**
|
|
4580
4528
|
* last instant when this terminal was updated
|
|
4581
4529
|
* @type {string}
|
|
@@ -4712,10 +4660,10 @@ export interface TerminalEntity {
|
|
|
4712
4660
|
export interface TerminalTransactionEntity {
|
|
4713
4661
|
/**
|
|
4714
4662
|
*
|
|
4715
|
-
* @type {
|
|
4663
|
+
* @type {string}
|
|
4716
4664
|
* @memberof TerminalTransactionEntity
|
|
4717
4665
|
*/
|
|
4718
|
-
'cf_payment_id'?:
|
|
4666
|
+
'cf_payment_id'?: string;
|
|
4719
4667
|
/**
|
|
4720
4668
|
*
|
|
4721
4669
|
* @type {number}
|
|
@@ -4747,6 +4695,19 @@ export interface TerminalTransactionEntity {
|
|
|
4747
4695
|
*/
|
|
4748
4696
|
'timeout'?: string;
|
|
4749
4697
|
}
|
|
4698
|
+
/**
|
|
4699
|
+
* Request to terminate an active order at Cashfree
|
|
4700
|
+
* @export
|
|
4701
|
+
* @interface TerminateOrderRequest
|
|
4702
|
+
*/
|
|
4703
|
+
export interface TerminateOrderRequest {
|
|
4704
|
+
/**
|
|
4705
|
+
* To terminate an order, pass order_status as \"TERMINATE\". Please note, order might not be terminated - confirm with the order_status in response. \"TERMINATION_REQUESTED\" states that the request is recieved and we are working on it. If the order terminates successfully, status will change to \"TERMINATED\". Incase there\'s any active transaction which moved to success - order might not get terminated.
|
|
4706
|
+
* @type {string}
|
|
4707
|
+
* @memberof TerminateOrderRequest
|
|
4708
|
+
*/
|
|
4709
|
+
'order_status': string;
|
|
4710
|
+
}
|
|
4750
4711
|
/**
|
|
4751
4712
|
* object when you are using preauth in UPI in order pay
|
|
4752
4713
|
* @export
|
|
@@ -4918,9 +4879,21 @@ export declare class Cashfree {
|
|
|
4918
4879
|
* @throws {Error}
|
|
4919
4880
|
*/
|
|
4920
4881
|
static PGVerifyWebhookSignature(signature: string, rawBody: string, timestamp: string): PGWebhookEvent;
|
|
4882
|
+
/**
|
|
4883
|
+
* Create Customer at Cashfree
|
|
4884
|
+
* @summary Create Customer at Cashfree
|
|
4885
|
+
* @param {string} x_api_version API version to be used. Format is in YYYY-MM-DD
|
|
4886
|
+
* @param {CreateCustomerRequest} CreateCustomerRequest Request to create a new customer at Cashfree
|
|
4887
|
+
* @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
|
|
4888
|
+
* @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.
|
|
4889
|
+
* @param {*} [options] Override http request option.
|
|
4890
|
+
* @throws {RequiredError}
|
|
4891
|
+
* @memberof CustomersApi
|
|
4892
|
+
*/
|
|
4893
|
+
static PGCreateCustomer(x_api_version: string, CreateCustomerRequest: CreateCustomerRequest, x_request_id?: string, x_idempotency_key?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CustomerEntity, any>>;
|
|
4921
4894
|
/**
|
|
4922
4895
|
* Use this API to get eligible Cardless EMI Payment Methods available for a customer on an order basis their phone number.
|
|
4923
|
-
* @summary Get Eligible Cardless EMI
|
|
4896
|
+
* @summary Get Eligible Cardless EMI Payment Methods for a customer on an order
|
|
4924
4897
|
* @param {string} x_api_version API version to be used. Format is in YYYY-MM-DD
|
|
4925
4898
|
* @param {EligibilityFetchCardlessEMIRequest} EligibilityFetchCardlessEMIRequest Request Body to get eligible cardless emi options for a customer and order
|
|
4926
4899
|
* @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
|
|
@@ -4932,7 +4905,7 @@ export declare class Cashfree {
|
|
|
4932
4905
|
static PGEligibilityFetchCardlessEMI(x_api_version: string, EligibilityFetchCardlessEMIRequest: EligibilityFetchCardlessEMIRequest, x_request_id?: string, x_idempotency_key?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<EligibilityCardlessEMIEntity[], any>>;
|
|
4933
4906
|
/**
|
|
4934
4907
|
* Use this API to get eligible offers for an order_id or order amount.
|
|
4935
|
-
* @summary Get Eligible Offers
|
|
4908
|
+
* @summary Get Eligible Offers for an Order
|
|
4936
4909
|
* @param {string} x_api_version API version to be used. Format is in YYYY-MM-DD
|
|
4937
4910
|
* @param {EligibilityFetchOffersRequest} EligibilityFetchOffersRequest Request Body to get eligible offers for a customer and order
|
|
4938
4911
|
* @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
|
|
@@ -4944,7 +4917,7 @@ export declare class Cashfree {
|
|
|
4944
4917
|
static PGEligibilityFetchOffers(x_api_version: string, EligibilityFetchOffersRequest: EligibilityFetchOffersRequest, x_request_id?: string, x_idempotency_key?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<EligibilityOfferEntity[], any>>;
|
|
4945
4918
|
/**
|
|
4946
4919
|
* Use this API to get eligible Paylater Payment Methods for a customer on an order.
|
|
4947
|
-
* @summary Get Eligible Paylater
|
|
4920
|
+
* @summary Get Eligible Paylater for a customer on an order
|
|
4948
4921
|
* @param {string} x_api_version API version to be used. Format is in YYYY-MM-DD
|
|
4949
4922
|
* @param {EligibilityFetchPaylaterRequest} EligibilityFetchPaylaterRequest Request Body to get eligible paylater options for a customer and order
|
|
4950
4923
|
* @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
|
|
@@ -4956,7 +4929,7 @@ export declare class Cashfree {
|
|
|
4956
4929
|
static PGEligibilityFetchPaylater(x_api_version: string, EligibilityFetchPaylaterRequest: EligibilityFetchPaylaterRequest, x_request_id?: string, x_idempotency_key?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<EligibilityPaylaterEntity[], any>>;
|
|
4957
4930
|
/**
|
|
4958
4931
|
* Use this API to get eligible Payment Methods
|
|
4959
|
-
* @summary Get
|
|
4932
|
+
* @summary Get eligible Payment Methods
|
|
4960
4933
|
* @param {string} x_api_version API version to be used. Format is in YYYY-MM-DD
|
|
4961
4934
|
* @param {EligibilityFetchPaymentMethodsRequest} EligibilityFetchPaymentMethodsRequest Request Body to get eligible payment methods for an account and order
|
|
4962
4935
|
* @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
|
|
@@ -5014,6 +4987,19 @@ export declare class Cashfree {
|
|
|
5014
4987
|
* @memberof OrdersApi
|
|
5015
4988
|
*/
|
|
5016
4989
|
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>>;
|
|
4990
|
+
/**
|
|
4991
|
+
* Use this API to terminate the order that was created at Cashfree\'s using the `order_id`.
|
|
4992
|
+
* @summary Terminate Order
|
|
4993
|
+
* @param {string} x_api_version API version to be used. Format is in YYYY-MM-DD
|
|
4994
|
+
* @param {string} order_id The id which uniquely identifies your order
|
|
4995
|
+
* @param {TerminateOrderRequest} TerminateOrderRequest Request body to terminate an order at cashfree
|
|
4996
|
+
* @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
|
|
4997
|
+
* @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.
|
|
4998
|
+
* @param {*} [options] Override http request option.
|
|
4999
|
+
* @throws {RequiredError}
|
|
5000
|
+
* @memberof OrdersApi
|
|
5001
|
+
*/
|
|
5002
|
+
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>>;
|
|
5017
5003
|
/**
|
|
5018
5004
|
* - Use this API to get the payment gateway reconciliation details with date range. - It will have events for your payment account
|
|
5019
5005
|
* @summary PG Reconciliation
|
|
@@ -5231,7 +5217,7 @@ export declare class Cashfree {
|
|
|
5231
5217
|
static SposCreateTerminal(x_api_version: string, CreateTerminalRequest: CreateTerminalRequest, x_request_id?: string, x_idempotency_key?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<TerminalEntity, any>>;
|
|
5232
5218
|
/**
|
|
5233
5219
|
* 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.
|
|
5234
|
-
* @summary Create Terminal
|
|
5220
|
+
* @summary Create Terminal Transaction
|
|
5235
5221
|
* @param {string} x_api_version API version to be used. Format is in YYYY-MM-DD
|
|
5236
5222
|
* @param {CreateTerminalTransactionRequest} CreateTerminalTransactionRequest Request body to create a terminal transaction
|
|
5237
5223
|
* @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
|