cashfree-pg 4.3.10 → 5.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/README.md CHANGED
@@ -21,6 +21,49 @@ npm i cashfree-pg
21
21
  ```
22
22
  ### Configuration
23
23
 
24
+ ## Version >=5
25
+
26
+ ```javascript
27
+ import { Cashfree } from "cashfree-pg";
28
+
29
+ var cashfree = new Cashfree(Cashfree.SANDBOX, "<x-client-id>", "<x-client-secret>")
30
+ ```
31
+
32
+ Generate your API keys (x-client-id , x-client-secret) from [Cashfree Merchant Dashboard](https://merchant.cashfree.com/merchants/login)
33
+
34
+ ### Basic Usage
35
+ Create Order
36
+ ```javascript
37
+ var request = {
38
+ "order_amount": 1,
39
+ "order_currency": "INR",
40
+ "order_id": "order_34692745",
41
+ "customer_details": {
42
+ "customer_id": "walterwNrcMi",
43
+ "customer_phone": "9999999999"
44
+ },
45
+ "order_meta": {
46
+ "return_url": "https://www.cashfree.com/devstudio/preview/pg/web/checkout?order_id={order_id}"
47
+ }
48
+ };
49
+ Cashfree.PGCreateOrder(request).then((response) => {
50
+ console.log('Order Created successfully:',response.data)
51
+ }).catch((error) => {
52
+ console.error('Error:', error.response.data.message);
53
+ });
54
+ ```
55
+
56
+ Get Order
57
+ ```javascript
58
+ Cashfree.PGFetchOrder("<order_id>").then((response) => {
59
+ console.log('Order fetched successfully:', response.data);
60
+ }).catch((error) => {
61
+ console.error('Error:', error.response.data.message);
62
+ });
63
+ ```
64
+
65
+ ## Version <5
66
+
24
67
  ```javascript
25
68
  import { Cashfree } from "cashfree-pg";
26
69
 
@@ -46,7 +89,7 @@ var request = {
46
89
  "return_url": "https://www.cashfree.com/devstudio/preview/pg/web/checkout?order_id={order_id}"
47
90
  }
48
91
  };
49
- Cashfree.PGCreateOrder("2022-09-01", request).then((response) => {
92
+ Cashfree.PGCreateOrder("2023-08-01", request).then((response) => {
50
93
  console.log('Order Created successfully:',response.data)
51
94
  }).catch((error) => {
52
95
  console.error('Error:', error.response.data.message);
@@ -55,7 +98,7 @@ Cashfree.PGCreateOrder("2022-09-01", request).then((response) => {
55
98
 
56
99
  Get Order
57
100
  ```javascript
58
- Cashfree.PGFetchOrder("2022-09-01", "<order_id>").then((response) => {
101
+ Cashfree.PGFetchOrder("2023-08-01", "<order_id>").then((response) => {
59
102
  console.log('Order fetched successfully:', response.data);
60
103
  }).catch((error) => {
61
104
  console.error('Error:', error.response.data.message);