@boostengine/collections 1.0.0 → 1.1.1
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 +63 -83
- package/bin/cli.cjs +49 -0
- package/collections/cashfree.collection.json +651 -0
- package/collections/delhivery.collection.json +270 -0
- package/collections/easyecom.collection.json +84 -82
- package/collections/paytm.collection.json +161 -0
- package/collections/phonepe.collection.json +359 -0
- package/collections/razorpay.collection.json +527 -90
- package/collections/shiprocket.collection.json +490 -0
- package/collections/shopify.collection.json +351 -0
- package/collections/stripe.collection.json +322 -0
- package/dist/index.cjs +602 -66
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.mts +16 -2
- package/dist/index.d.ts +16 -2
- package/dist/index.mjs +602 -66
- package/dist/index.mjs.map +1 -1
- package/environments/cashfree.env.json +67 -0
- package/environments/delhivery.env.json +31 -0
- package/environments/paytm.env.json +49 -0
- package/environments/phonepe.env.json +85 -0
- package/environments/razorpay.env.json +12 -0
- package/environments/shiprocket.env.json +61 -0
- package/environments/shopify.env.json +31 -0
- package/environments/stripe.env.json +31 -0
- package/package.json +22 -3
|
@@ -0,0 +1,651 @@
|
|
|
1
|
+
{
|
|
2
|
+
"info": {
|
|
3
|
+
"_postman_id": "cf123456-7890-4abc-def1-234567890123",
|
|
4
|
+
"name": "Cashfree Full Payments & Payouts API Suite",
|
|
5
|
+
"description": "Exhaustive Enterprise Postman Collection for Cashfree PG & Banking v2023-08-01 (Orders, Seamless UPI/Cards, Payment Links, Subscriptions, Bank/UPI Verification, Payouts, Refunds, Settlements, Webhooks). Includes auto-chaining test scripts.",
|
|
6
|
+
"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
|
|
7
|
+
},
|
|
8
|
+
"auth": {
|
|
9
|
+
"type": "noauth"
|
|
10
|
+
},
|
|
11
|
+
"item": [
|
|
12
|
+
{
|
|
13
|
+
"name": "1. Orders API (Checkout & Drop-in)",
|
|
14
|
+
"description": "Create, fetch, and manage customer checkout orders in Cashfree PG.",
|
|
15
|
+
"item": [
|
|
16
|
+
{
|
|
17
|
+
"name": "Create Order (with Session ID)",
|
|
18
|
+
"event": [
|
|
19
|
+
{
|
|
20
|
+
"listen": "test",
|
|
21
|
+
"script": {
|
|
22
|
+
"exec": [
|
|
23
|
+
"var jsonData = pm.response.json();",
|
|
24
|
+
"if (jsonData && jsonData.order_id) {",
|
|
25
|
+
" pm.environment.set('cashfree_order_id', jsonData.order_id);",
|
|
26
|
+
" pm.environment.set('payment_session_id', jsonData.payment_session_id);",
|
|
27
|
+
" console.log('Saved order_id: ' + jsonData.order_id + ', session_id: ' + jsonData.payment_session_id);",
|
|
28
|
+
"}"
|
|
29
|
+
],
|
|
30
|
+
"type": "text/javascript"
|
|
31
|
+
}
|
|
32
|
+
}
|
|
33
|
+
],
|
|
34
|
+
"request": {
|
|
35
|
+
"method": "POST",
|
|
36
|
+
"header": [
|
|
37
|
+
{ "key": "x-client-id", "value": "{{cashfree_app_id}}" },
|
|
38
|
+
{ "key": "x-client-secret", "value": "{{cashfree_secret_key}}" },
|
|
39
|
+
{ "key": "x-api-version", "value": "2023-08-01" },
|
|
40
|
+
{ "key": "Content-Type", "value": "application/json" }
|
|
41
|
+
],
|
|
42
|
+
"body": {
|
|
43
|
+
"mode": "raw",
|
|
44
|
+
"raw": "{\n \"order_id\": \"order_cf_{{$timestamp}}\",\n \"order_amount\": 1499.00,\n \"order_currency\": \"INR\",\n \"customer_details\": {\n \"customer_id\": \"cust_{{$timestamp}}\",\n \"customer_name\": \"Aman Sharma\",\n \"customer_email\": \"aman@example.com\",\n \"customer_phone\": \"9876543210\"\n },\n \"order_meta\": {\n \"return_url\": \"https://yourstore.com/order-confirmed?order_id={order_id}\",\n \"notify_url\": \"{{local_webhook_url}}\",\n \"payment_methods\": \"cc,dc,upi,nb\"\n },\n \"order_note\": \"Boost Engine eCommerce Checkout\"\n}"
|
|
45
|
+
},
|
|
46
|
+
"url": {
|
|
47
|
+
"raw": "{{cashfree_base_url}}/orders",
|
|
48
|
+
"host": ["{{cashfree_base_url}}"],
|
|
49
|
+
"path": ["orders"]
|
|
50
|
+
},
|
|
51
|
+
"description": "Creates an order and returns payment_session_id for Cashfree Drop-in UI or Native SDK checkout."
|
|
52
|
+
}
|
|
53
|
+
},
|
|
54
|
+
{
|
|
55
|
+
"name": "Get Order Details",
|
|
56
|
+
"request": {
|
|
57
|
+
"method": "GET",
|
|
58
|
+
"header": [
|
|
59
|
+
{ "key": "x-client-id", "value": "{{cashfree_app_id}}" },
|
|
60
|
+
{ "key": "x-client-secret", "value": "{{cashfree_secret_key}}" },
|
|
61
|
+
{ "key": "x-api-version", "value": "2023-08-01" }
|
|
62
|
+
],
|
|
63
|
+
"url": {
|
|
64
|
+
"raw": "{{cashfree_base_url}}/orders/{{cashfree_order_id}}",
|
|
65
|
+
"host": ["{{cashfree_base_url}}"],
|
|
66
|
+
"path": ["orders", "{{cashfree_order_id}}"]
|
|
67
|
+
},
|
|
68
|
+
"description": "Retrieves the status of an order (PAID, ACTIVE, EXPIRED)."
|
|
69
|
+
}
|
|
70
|
+
},
|
|
71
|
+
{
|
|
72
|
+
"name": "Terminate / Cancel Order",
|
|
73
|
+
"request": {
|
|
74
|
+
"method": "PATCH",
|
|
75
|
+
"header": [
|
|
76
|
+
{ "key": "x-client-id", "value": "{{cashfree_app_id}}" },
|
|
77
|
+
{ "key": "x-client-secret", "value": "{{cashfree_secret_key}}" },
|
|
78
|
+
{ "key": "x-api-version", "value": "2023-08-01" },
|
|
79
|
+
{ "key": "Content-Type", "value": "application/json" }
|
|
80
|
+
],
|
|
81
|
+
"body": {
|
|
82
|
+
"mode": "raw",
|
|
83
|
+
"raw": "{\n \"order_status\": \"TERMINATED\"\n}"
|
|
84
|
+
},
|
|
85
|
+
"url": {
|
|
86
|
+
"raw": "{{cashfree_base_url}}/orders/{{cashfree_order_id}}",
|
|
87
|
+
"host": ["{{cashfree_base_url}}"],
|
|
88
|
+
"path": ["orders", "{{cashfree_order_id}}"]
|
|
89
|
+
},
|
|
90
|
+
"description": "Terminates an active order so that no more payments can be made against it."
|
|
91
|
+
}
|
|
92
|
+
},
|
|
93
|
+
{
|
|
94
|
+
"name": "Fetch Order Settlements",
|
|
95
|
+
"request": {
|
|
96
|
+
"method": "GET",
|
|
97
|
+
"header": [
|
|
98
|
+
{ "key": "x-client-id", "value": "{{cashfree_app_id}}" },
|
|
99
|
+
{ "key": "x-client-secret", "value": "{{cashfree_secret_key}}" },
|
|
100
|
+
{ "key": "x-api-version", "value": "2023-08-01" }
|
|
101
|
+
],
|
|
102
|
+
"url": {
|
|
103
|
+
"raw": "{{cashfree_base_url}}/orders/{{cashfree_order_id}}/settlements",
|
|
104
|
+
"host": ["{{cashfree_base_url}}"],
|
|
105
|
+
"path": ["orders", "{{cashfree_order_id}}", "settlements"]
|
|
106
|
+
},
|
|
107
|
+
"description": "Retrieves settlement breakdown, MDR charges, and bank transfer reference for an order."
|
|
108
|
+
}
|
|
109
|
+
}
|
|
110
|
+
]
|
|
111
|
+
},
|
|
112
|
+
{
|
|
113
|
+
"name": "2. Seamless / Direct Payments API",
|
|
114
|
+
"description": "Direct S2S checkout without redirecting to hosted page (UPI Intent, UPI Collect, Cards, Netbanking).",
|
|
115
|
+
"item": [
|
|
116
|
+
{
|
|
117
|
+
"name": "Pay Order - UPI Intent (GPay, PhonePe, Paytm)",
|
|
118
|
+
"request": {
|
|
119
|
+
"method": "POST",
|
|
120
|
+
"header": [
|
|
121
|
+
{ "key": "x-client-id", "value": "{{cashfree_app_id}}" },
|
|
122
|
+
{ "key": "x-client-secret", "value": "{{cashfree_secret_key}}" },
|
|
123
|
+
{ "key": "x-api-version", "value": "2023-08-01" },
|
|
124
|
+
{ "key": "Content-Type", "value": "application/json" }
|
|
125
|
+
],
|
|
126
|
+
"body": {
|
|
127
|
+
"mode": "raw",
|
|
128
|
+
"raw": "{\n \"payment_session_id\": \"{{payment_session_id}}\",\n \"payment_method\": {\n \"upi\": {\n \"channel\": \"intent\"\n }\n }\n}"
|
|
129
|
+
},
|
|
130
|
+
"url": {
|
|
131
|
+
"raw": "{{cashfree_base_url}}/orders/sessions",
|
|
132
|
+
"host": ["{{cashfree_base_url}}"],
|
|
133
|
+
"path": ["orders", "sessions"]
|
|
134
|
+
},
|
|
135
|
+
"description": "Returns deep link / intent URI for mobile app checkouts (GPay, PhonePe, Paytm)."
|
|
136
|
+
}
|
|
137
|
+
},
|
|
138
|
+
{
|
|
139
|
+
"name": "Pay Order - UPI Collect (Enter VPA)",
|
|
140
|
+
"request": {
|
|
141
|
+
"method": "POST",
|
|
142
|
+
"header": [
|
|
143
|
+
{ "key": "x-client-id", "value": "{{cashfree_app_id}}" },
|
|
144
|
+
{ "key": "x-client-secret", "value": "{{cashfree_secret_key}}" },
|
|
145
|
+
{ "key": "x-api-version", "value": "2023-08-01" },
|
|
146
|
+
{ "key": "Content-Type", "value": "application/json" }
|
|
147
|
+
],
|
|
148
|
+
"body": {
|
|
149
|
+
"mode": "raw",
|
|
150
|
+
"raw": "{\n \"payment_session_id\": \"{{payment_session_id}}\",\n \"payment_method\": {\n \"upi\": {\n \"channel\": \"collect\",\n \"upi_id\": \"testsuccess@gocash\"\n }\n }\n}"
|
|
151
|
+
},
|
|
152
|
+
"url": {
|
|
153
|
+
"raw": "{{cashfree_base_url}}/orders/sessions",
|
|
154
|
+
"host": ["{{cashfree_base_url}}"],
|
|
155
|
+
"path": ["orders", "sessions"]
|
|
156
|
+
},
|
|
157
|
+
"description": "Sends UPI collect request directly to customer's UPI app."
|
|
158
|
+
}
|
|
159
|
+
},
|
|
160
|
+
{
|
|
161
|
+
"name": "Pay Order - Netbanking",
|
|
162
|
+
"request": {
|
|
163
|
+
"method": "POST",
|
|
164
|
+
"header": [
|
|
165
|
+
{ "key": "x-client-id", "value": "{{cashfree_app_id}}" },
|
|
166
|
+
{ "key": "x-client-secret", "value": "{{cashfree_secret_key}}" },
|
|
167
|
+
{ "key": "x-api-version", "value": "2023-08-01" },
|
|
168
|
+
{ "key": "Content-Type", "value": "application/json" }
|
|
169
|
+
],
|
|
170
|
+
"body": {
|
|
171
|
+
"mode": "raw",
|
|
172
|
+
"raw": "{\n \"payment_session_id\": \"{{payment_session_id}}\",\n \"payment_method\": {\n \"netbanking\": {\n \"channel\": \"link\",\n \"netbanking_bank_code\": 3003\n }\n }\n}"
|
|
173
|
+
},
|
|
174
|
+
"url": {
|
|
175
|
+
"raw": "{{cashfree_base_url}}/orders/sessions",
|
|
176
|
+
"host": ["{{cashfree_base_url}}"],
|
|
177
|
+
"path": ["orders", "sessions"]
|
|
178
|
+
},
|
|
179
|
+
"description": "Directly routes customer to bank netbanking portal (e.g. 3003 = HDFC, 3022 = ICICI, 3044 = SBI)."
|
|
180
|
+
}
|
|
181
|
+
}
|
|
182
|
+
]
|
|
183
|
+
},
|
|
184
|
+
{
|
|
185
|
+
"name": "3. Payments & Transactions API",
|
|
186
|
+
"description": "Fetch payments, details, and submit headless OTPs.",
|
|
187
|
+
"item": [
|
|
188
|
+
{
|
|
189
|
+
"name": "Fetch Payments for an Order",
|
|
190
|
+
"request": {
|
|
191
|
+
"method": "GET",
|
|
192
|
+
"header": [
|
|
193
|
+
{ "key": "x-client-id", "value": "{{cashfree_app_id}}" },
|
|
194
|
+
{ "key": "x-client-secret", "value": "{{cashfree_secret_key}}" },
|
|
195
|
+
{ "key": "x-api-version", "value": "2023-08-01" }
|
|
196
|
+
],
|
|
197
|
+
"url": {
|
|
198
|
+
"raw": "{{cashfree_base_url}}/orders/{{cashfree_order_id}}/payments",
|
|
199
|
+
"host": ["{{cashfree_base_url}}"],
|
|
200
|
+
"path": ["orders", "{{cashfree_order_id}}", "payments"]
|
|
201
|
+
},
|
|
202
|
+
"description": "Retrieves payment attempts with bank reference IDs, payment methods, and timestamps."
|
|
203
|
+
}
|
|
204
|
+
},
|
|
205
|
+
{
|
|
206
|
+
"name": "Get Payment by CF Payment ID",
|
|
207
|
+
"request": {
|
|
208
|
+
"method": "GET",
|
|
209
|
+
"header": [
|
|
210
|
+
{ "key": "x-client-id", "value": "{{cashfree_app_id}}" },
|
|
211
|
+
{ "key": "x-client-secret", "value": "{{cashfree_secret_key}}" },
|
|
212
|
+
{ "key": "x-api-version", "value": "2023-08-01" }
|
|
213
|
+
],
|
|
214
|
+
"url": {
|
|
215
|
+
"raw": "{{cashfree_base_url}}/orders/{{cashfree_order_id}}/payments/{{cf_payment_id}}",
|
|
216
|
+
"host": ["{{cashfree_base_url}}"],
|
|
217
|
+
"path": ["orders", "{{cashfree_order_id}}", "payments", "{{cf_payment_id}}"]
|
|
218
|
+
},
|
|
219
|
+
"description": "Fetches a specific transaction attempt."
|
|
220
|
+
}
|
|
221
|
+
},
|
|
222
|
+
{
|
|
223
|
+
"name": "Submit Headless Card OTP",
|
|
224
|
+
"request": {
|
|
225
|
+
"method": "POST",
|
|
226
|
+
"header": [
|
|
227
|
+
{ "key": "x-client-id", "value": "{{cashfree_app_id}}" },
|
|
228
|
+
{ "key": "x-client-secret", "value": "{{cashfree_secret_key}}" },
|
|
229
|
+
{ "key": "x-api-version", "value": "2023-08-01" },
|
|
230
|
+
{ "key": "Content-Type", "value": "application/json" }
|
|
231
|
+
],
|
|
232
|
+
"body": {
|
|
233
|
+
"mode": "raw",
|
|
234
|
+
"raw": "{\n \"action\": \"SUBMIT_OTP\",\n \"otp\": \"123456\"\n}"
|
|
235
|
+
},
|
|
236
|
+
"url": {
|
|
237
|
+
"raw": "{{cashfree_base_url}}/orders/{{cashfree_order_id}}/payments/{{cf_payment_id}}/otp",
|
|
238
|
+
"host": ["{{cashfree_base_url}}"],
|
|
239
|
+
"path": ["orders", "{{cashfree_order_id}}", "payments", "{{cf_payment_id}}", "otp"]
|
|
240
|
+
},
|
|
241
|
+
"description": "Submits bank OTP directly for headless custom card checkout experiences."
|
|
242
|
+
}
|
|
243
|
+
}
|
|
244
|
+
]
|
|
245
|
+
},
|
|
246
|
+
{
|
|
247
|
+
"name": "4. Payment Links API",
|
|
248
|
+
"description": "Generate dynamic payment links with SMS/Email/WhatsApp reminders.",
|
|
249
|
+
"item": [
|
|
250
|
+
{
|
|
251
|
+
"name": "Create Payment Link",
|
|
252
|
+
"event": [
|
|
253
|
+
{
|
|
254
|
+
"listen": "test",
|
|
255
|
+
"script": {
|
|
256
|
+
"exec": [
|
|
257
|
+
"var jsonData = pm.response.json();",
|
|
258
|
+
"if (jsonData && jsonData.link_id) {",
|
|
259
|
+
" pm.environment.set('cashfree_link_id', jsonData.link_id);",
|
|
260
|
+
"}"
|
|
261
|
+
],
|
|
262
|
+
"type": "text/javascript"
|
|
263
|
+
}
|
|
264
|
+
}
|
|
265
|
+
],
|
|
266
|
+
"request": {
|
|
267
|
+
"method": "POST",
|
|
268
|
+
"header": [
|
|
269
|
+
{ "key": "x-client-id", "value": "{{cashfree_app_id}}" },
|
|
270
|
+
{ "key": "x-client-secret", "value": "{{cashfree_secret_key}}" },
|
|
271
|
+
{ "key": "x-api-version", "value": "2023-08-01" },
|
|
272
|
+
{ "key": "Content-Type", "value": "application/json" }
|
|
273
|
+
],
|
|
274
|
+
"body": {
|
|
275
|
+
"mode": "raw",
|
|
276
|
+
"raw": "{\n \"link_id\": \"link_cf_{{$timestamp}}\",\n \"link_amount\": 1499.00,\n \"link_currency\": \"INR\",\n \"link_purpose\": \"Boost Engine Order #9821\",\n \"customer_details\": {\n \"customer_name\": \"Aman Sharma\",\n \"customer_email\": \"aman@example.com\",\n \"customer_phone\": \"9876543210\"\n },\n \"link_notify\": {\n \"send_sms\": true,\n \"send_email\": true\n }\n}"
|
|
277
|
+
},
|
|
278
|
+
"url": {
|
|
279
|
+
"raw": "{{cashfree_base_url}}/links",
|
|
280
|
+
"host": ["{{cashfree_base_url}}"],
|
|
281
|
+
"path": ["links"]
|
|
282
|
+
},
|
|
283
|
+
"description": "Generates a hosted payment link with SMS/Email notifications."
|
|
284
|
+
}
|
|
285
|
+
},
|
|
286
|
+
{
|
|
287
|
+
"name": "Get Payment Link Details",
|
|
288
|
+
"request": {
|
|
289
|
+
"method": "GET",
|
|
290
|
+
"header": [
|
|
291
|
+
{ "key": "x-client-id", "value": "{{cashfree_app_id}}" },
|
|
292
|
+
{ "key": "x-client-secret", "value": "{{cashfree_secret_key}}" },
|
|
293
|
+
{ "key": "x-api-version", "value": "2023-08-01" }
|
|
294
|
+
],
|
|
295
|
+
"url": {
|
|
296
|
+
"raw": "{{cashfree_base_url}}/links/{{cashfree_link_id}}",
|
|
297
|
+
"host": ["{{cashfree_base_url}}"],
|
|
298
|
+
"path": ["links", "{{cashfree_link_id}}"]
|
|
299
|
+
},
|
|
300
|
+
"description": "Fetches status of the payment link."
|
|
301
|
+
}
|
|
302
|
+
},
|
|
303
|
+
{
|
|
304
|
+
"name": "Cancel Payment Link",
|
|
305
|
+
"request": {
|
|
306
|
+
"method": "POST",
|
|
307
|
+
"header": [
|
|
308
|
+
{ "key": "x-client-id", "value": "{{cashfree_app_id}}" },
|
|
309
|
+
{ "key": "x-client-secret", "value": "{{cashfree_secret_key}}" },
|
|
310
|
+
{ "key": "x-api-version", "value": "2023-08-01" }
|
|
311
|
+
],
|
|
312
|
+
"url": {
|
|
313
|
+
"raw": "{{cashfree_base_url}}/links/{{cashfree_link_id}}/cancel",
|
|
314
|
+
"host": ["{{cashfree_base_url}}"],
|
|
315
|
+
"path": ["links", "{{cashfree_link_id}}", "cancel"]
|
|
316
|
+
},
|
|
317
|
+
"description": "Cancels an active payment link."
|
|
318
|
+
}
|
|
319
|
+
}
|
|
320
|
+
]
|
|
321
|
+
},
|
|
322
|
+
{
|
|
323
|
+
"name": "5. Verification Suite (KYC & Bank / UPI Verify)",
|
|
324
|
+
"description": "Cashfree Verification Suite for vendor / customer bank account, UPI, and PAN verification.",
|
|
325
|
+
"item": [
|
|
326
|
+
{
|
|
327
|
+
"name": "Verify Bank Account (Penny Drop)",
|
|
328
|
+
"request": {
|
|
329
|
+
"method": "POST",
|
|
330
|
+
"header": [
|
|
331
|
+
{ "key": "x-client-id", "value": "{{cashfree_app_id}}" },
|
|
332
|
+
{ "key": "x-client-secret", "value": "{{cashfree_secret_key}}" },
|
|
333
|
+
{ "key": "Content-Type", "value": "application/json" }
|
|
334
|
+
],
|
|
335
|
+
"body": {
|
|
336
|
+
"mode": "raw",
|
|
337
|
+
"raw": "{\n \"bank_account\": \"001101524321\",\n \"ifsc\": \"HDFC0000001\",\n \"name\": \"Aman Sharma\",\n \"phone\": \"9876543210\"\n}"
|
|
338
|
+
},
|
|
339
|
+
"url": {
|
|
340
|
+
"raw": "https://api.cashfree.com/verification/bank-account/sync",
|
|
341
|
+
"protocol": "https",
|
|
342
|
+
"host": ["api", "cashfree", "com"],
|
|
343
|
+
"path": ["verification", "bank-account", "sync"]
|
|
344
|
+
},
|
|
345
|
+
"description": "Performs instant penny-drop verification and returns registered account holder name."
|
|
346
|
+
}
|
|
347
|
+
},
|
|
348
|
+
{
|
|
349
|
+
"name": "Verify UPI VPA ID",
|
|
350
|
+
"request": {
|
|
351
|
+
"method": "POST",
|
|
352
|
+
"header": [
|
|
353
|
+
{ "key": "x-client-id", "value": "{{cashfree_app_id}}" },
|
|
354
|
+
{ "key": "x-client-secret", "value": "{{cashfree_secret_key}}" },
|
|
355
|
+
{ "key": "Content-Type", "value": "application/json" }
|
|
356
|
+
],
|
|
357
|
+
"body": {
|
|
358
|
+
"mode": "raw",
|
|
359
|
+
"raw": "{\n \"vpa\": \"aman@oksbi\",\n \"name\": \"Aman Sharma\"\n}"
|
|
360
|
+
},
|
|
361
|
+
"url": {
|
|
362
|
+
"raw": "https://api.cashfree.com/verification/upi",
|
|
363
|
+
"protocol": "https",
|
|
364
|
+
"host": ["api", "cashfree", "com"],
|
|
365
|
+
"path": ["verification", "upi"]
|
|
366
|
+
},
|
|
367
|
+
"description": "Validates UPI ID existence and checks if VPA is active and matches customer name."
|
|
368
|
+
}
|
|
369
|
+
},
|
|
370
|
+
{
|
|
371
|
+
"name": "Verify PAN Card",
|
|
372
|
+
"request": {
|
|
373
|
+
"method": "POST",
|
|
374
|
+
"header": [
|
|
375
|
+
{ "key": "x-client-id", "value": "{{cashfree_app_id}}" },
|
|
376
|
+
{ "key": "x-client-secret", "value": "{{cashfree_secret_key}}" },
|
|
377
|
+
{ "key": "Content-Type", "value": "application/json" }
|
|
378
|
+
],
|
|
379
|
+
"body": {
|
|
380
|
+
"mode": "raw",
|
|
381
|
+
"raw": "{\n \"pan\": \"ABCDE1234F\",\n \"name\": \"Aman Sharma\"\n}"
|
|
382
|
+
},
|
|
383
|
+
"url": {
|
|
384
|
+
"raw": "https://api.cashfree.com/verification/pan",
|
|
385
|
+
"protocol": "https",
|
|
386
|
+
"host": ["api", "cashfree", "com"],
|
|
387
|
+
"path": ["verification", "pan"]
|
|
388
|
+
},
|
|
389
|
+
"description": "Verifies PAN card authenticity and registered tax name with NSDL."
|
|
390
|
+
}
|
|
391
|
+
}
|
|
392
|
+
]
|
|
393
|
+
},
|
|
394
|
+
{
|
|
395
|
+
"name": "6. Payouts & Disbursals API",
|
|
396
|
+
"description": "Instant vendor, affiliate, and refund disbursals via IMPS / NEFT / UPI.",
|
|
397
|
+
"item": [
|
|
398
|
+
{
|
|
399
|
+
"name": "Add Beneficiary",
|
|
400
|
+
"request": {
|
|
401
|
+
"method": "POST",
|
|
402
|
+
"header": [
|
|
403
|
+
{ "key": "Authorization", "value": "Bearer {{cashfree_payout_token}}" },
|
|
404
|
+
{ "key": "Content-Type", "value": "application/json" }
|
|
405
|
+
],
|
|
406
|
+
"body": {
|
|
407
|
+
"mode": "raw",
|
|
408
|
+
"raw": "{\n \"beneId\": \"bene_{{$timestamp}}\",\n \"name\": \"Aman Sharma\",\n \"email\": \"aman@example.com\",\n \"phone\": \"9876543210\",\n \"bankAccount\": \"001101524321\",\n \"ifsc\": \"HDFC0000001\",\n \"address1\": \"Skyline Residency\"\n}"
|
|
409
|
+
},
|
|
410
|
+
"url": {
|
|
411
|
+
"raw": "https://payout-api.cashfree.com/payout/v1/addBeneficiary",
|
|
412
|
+
"protocol": "https",
|
|
413
|
+
"host": ["payout-api", "cashfree", "com"],
|
|
414
|
+
"path": ["payout", "v1", "addBeneficiary"]
|
|
415
|
+
},
|
|
416
|
+
"description": "Registers a beneficiary for instant payouts."
|
|
417
|
+
}
|
|
418
|
+
},
|
|
419
|
+
{
|
|
420
|
+
"name": "Request Instant Transfer / Payout",
|
|
421
|
+
"request": {
|
|
422
|
+
"method": "POST",
|
|
423
|
+
"header": [
|
|
424
|
+
{ "key": "Authorization", "value": "Bearer {{cashfree_payout_token}}" },
|
|
425
|
+
{ "key": "Content-Type", "value": "application/json" }
|
|
426
|
+
],
|
|
427
|
+
"body": {
|
|
428
|
+
"mode": "raw",
|
|
429
|
+
"raw": "{\n \"beneId\": \"bene_12345\",\n \"amount\": \"1500.00\",\n \"transferId\": \"trans_{{$timestamp}}\",\n \"transferMode\": \"imps\",\n \"remarks\": \"Boost Engine Affiliate Payout\"\n}"
|
|
430
|
+
},
|
|
431
|
+
"url": {
|
|
432
|
+
"raw": "https://payout-api.cashfree.com/payout/v1/requestTransfer",
|
|
433
|
+
"protocol": "https",
|
|
434
|
+
"host": ["payout-api", "cashfree", "com"],
|
|
435
|
+
"path": ["payout", "v1", "requestTransfer"]
|
|
436
|
+
},
|
|
437
|
+
"description": "Disburses funds instantly to beneficiary bank account via IMPS/UPI/NEFT."
|
|
438
|
+
}
|
|
439
|
+
},
|
|
440
|
+
{
|
|
441
|
+
"name": "Get Transfer Status",
|
|
442
|
+
"request": {
|
|
443
|
+
"method": "GET",
|
|
444
|
+
"header": [
|
|
445
|
+
{ "key": "Authorization", "value": "Bearer {{cashfree_payout_token}}" }
|
|
446
|
+
],
|
|
447
|
+
"url": {
|
|
448
|
+
"raw": "https://payout-api.cashfree.com/payout/v1/getTransferStatus?transferId=trans_12345",
|
|
449
|
+
"protocol": "https",
|
|
450
|
+
"host": ["payout-api", "cashfree", "com"],
|
|
451
|
+
"path": ["payout", "v1", "getTransferStatus"],
|
|
452
|
+
"query": [
|
|
453
|
+
{ "key": "transferId", "value": "trans_12345" }
|
|
454
|
+
]
|
|
455
|
+
},
|
|
456
|
+
"description": "Checks status of payout transfer (SUCCESS, PENDING, REVERSED)."
|
|
457
|
+
}
|
|
458
|
+
}
|
|
459
|
+
]
|
|
460
|
+
},
|
|
461
|
+
{
|
|
462
|
+
"name": "7. Refunds API",
|
|
463
|
+
"description": "Trigger instant and standard refund requests.",
|
|
464
|
+
"item": [
|
|
465
|
+
{
|
|
466
|
+
"name": "Create Refund",
|
|
467
|
+
"event": [
|
|
468
|
+
{
|
|
469
|
+
"listen": "test",
|
|
470
|
+
"script": {
|
|
471
|
+
"exec": [
|
|
472
|
+
"var jsonData = pm.response.json();",
|
|
473
|
+
"if (jsonData && jsonData.refund_id) {",
|
|
474
|
+
" pm.environment.set('cashfree_refund_id', jsonData.refund_id);",
|
|
475
|
+
"}"
|
|
476
|
+
],
|
|
477
|
+
"type": "text/javascript"
|
|
478
|
+
}
|
|
479
|
+
}
|
|
480
|
+
],
|
|
481
|
+
"request": {
|
|
482
|
+
"method": "POST",
|
|
483
|
+
"header": [
|
|
484
|
+
{ "key": "x-client-id", "value": "{{cashfree_app_id}}" },
|
|
485
|
+
{ "key": "x-client-secret", "value": "{{cashfree_secret_key}}" },
|
|
486
|
+
{ "key": "x-api-version", "value": "2023-08-01" },
|
|
487
|
+
{ "key": "Content-Type", "value": "application/json" }
|
|
488
|
+
],
|
|
489
|
+
"body": {
|
|
490
|
+
"mode": "raw",
|
|
491
|
+
"raw": "{\n \"refund_id\": \"rfnd_cf_{{$timestamp}}\",\n \"refund_amount\": 1499.00,\n \"refund_note\": \"Customer requested order cancellation\"\n}"
|
|
492
|
+
},
|
|
493
|
+
"url": {
|
|
494
|
+
"raw": "{{cashfree_base_url}}/orders/{{cashfree_order_id}}/refunds",
|
|
495
|
+
"host": ["{{cashfree_base_url}}"],
|
|
496
|
+
"path": ["orders", "{{cashfree_order_id}}", "refunds"]
|
|
497
|
+
},
|
|
498
|
+
"description": "Processes a refund for a paid order."
|
|
499
|
+
}
|
|
500
|
+
},
|
|
501
|
+
{
|
|
502
|
+
"name": "Fetch Refund by ID",
|
|
503
|
+
"request": {
|
|
504
|
+
"method": "GET",
|
|
505
|
+
"header": [
|
|
506
|
+
{ "key": "x-client-id", "value": "{{cashfree_app_id}}" },
|
|
507
|
+
{ "key": "x-client-secret", "value": "{{cashfree_secret_key}}" },
|
|
508
|
+
{ "key": "x-api-version", "value": "2023-08-01" }
|
|
509
|
+
],
|
|
510
|
+
"url": {
|
|
511
|
+
"raw": "{{cashfree_base_url}}/orders/{{cashfree_order_id}}/refunds/{{cashfree_refund_id}}",
|
|
512
|
+
"host": ["{{cashfree_base_url}}"],
|
|
513
|
+
"path": ["orders", "{{cashfree_order_id}}", "refunds", "{{cashfree_refund_id}}"]
|
|
514
|
+
},
|
|
515
|
+
"description": "Queries the refund status (SUCCESS, PENDING, CANCELLED)."
|
|
516
|
+
}
|
|
517
|
+
},
|
|
518
|
+
{
|
|
519
|
+
"name": "List All Refunds for an Order",
|
|
520
|
+
"request": {
|
|
521
|
+
"method": "GET",
|
|
522
|
+
"header": [
|
|
523
|
+
{ "key": "x-client-id", "value": "{{cashfree_app_id}}" },
|
|
524
|
+
{ "key": "x-client-secret", "value": "{{cashfree_secret_key}}" },
|
|
525
|
+
{ "key": "x-api-version", "value": "2023-08-01" }
|
|
526
|
+
],
|
|
527
|
+
"url": {
|
|
528
|
+
"raw": "{{cashfree_base_url}}/orders/{{cashfree_order_id}}/refunds",
|
|
529
|
+
"host": ["{{cashfree_base_url}}"],
|
|
530
|
+
"path": ["orders", "{{cashfree_order_id}}", "refunds"]
|
|
531
|
+
},
|
|
532
|
+
"description": "Lists all partial/full refunds created for the order."
|
|
533
|
+
}
|
|
534
|
+
}
|
|
535
|
+
]
|
|
536
|
+
},
|
|
537
|
+
{
|
|
538
|
+
"name": "8. Subscriptions & Recurring API",
|
|
539
|
+
"description": "Recurring mandates and subscription billing.",
|
|
540
|
+
"item": [
|
|
541
|
+
{
|
|
542
|
+
"name": "Create Subscription Plan",
|
|
543
|
+
"request": {
|
|
544
|
+
"method": "POST",
|
|
545
|
+
"header": [
|
|
546
|
+
{ "key": "x-client-id", "value": "{{cashfree_app_id}}" },
|
|
547
|
+
{ "key": "x-client-secret", "value": "{{cashfree_secret_key}}" },
|
|
548
|
+
{ "key": "x-api-version", "value": "2023-08-01" },
|
|
549
|
+
{ "key": "Content-Type", "value": "application/json" }
|
|
550
|
+
],
|
|
551
|
+
"body": {
|
|
552
|
+
"mode": "raw",
|
|
553
|
+
"raw": "{\n \"plan_id\": \"plan_monthly_coffee_{{$timestamp}}\",\n \"plan_name\": \"Monthly Coffee Club\",\n \"plan_type\": \"PERIODIC\",\n \"plan_currency\": \"INR\",\n \"plan_recurring_amount\": 999.00,\n \"plan_max_amount\": 2000.00,\n \"plan_intervals\": 1,\n \"plan_interval_type\": \"MONTH\"\n}"
|
|
554
|
+
},
|
|
555
|
+
"url": {
|
|
556
|
+
"raw": "{{cashfree_base_url}}/subscription-plans",
|
|
557
|
+
"host": ["{{cashfree_base_url}}"],
|
|
558
|
+
"path": ["subscription-plans"]
|
|
559
|
+
},
|
|
560
|
+
"description": "Creates a recurring billing plan for UPI Autopay / eNACH / Card mandate."
|
|
561
|
+
}
|
|
562
|
+
},
|
|
563
|
+
{
|
|
564
|
+
"name": "Create Subscription",
|
|
565
|
+
"request": {
|
|
566
|
+
"method": "POST",
|
|
567
|
+
"header": [
|
|
568
|
+
{ "key": "x-client-id", "value": "{{cashfree_app_id}}" },
|
|
569
|
+
{ "key": "x-client-secret", "value": "{{cashfree_secret_key}}" },
|
|
570
|
+
{ "key": "x-api-version", "value": "2023-08-01" },
|
|
571
|
+
{ "key": "Content-Type", "value": "application/json" }
|
|
572
|
+
],
|
|
573
|
+
"body": {
|
|
574
|
+
"mode": "raw",
|
|
575
|
+
"raw": "{\n \"subscription_id\": \"sub_cf_{{$timestamp}}\",\n \"plan_id\": \"plan_monthly_coffee_123\",\n \"customer_details\": {\n \"customer_name\": \"Aman Sharma\",\n \"customer_email\": \"aman@example.com\",\n \"customer_phone\": \"9876543210\"\n },\n \"subscription_expiry_time\": \"2027-12-31T23:59:59+05:30\"\n}"
|
|
576
|
+
},
|
|
577
|
+
"url": {
|
|
578
|
+
"raw": "{{cashfree_base_url}}/subscriptions",
|
|
579
|
+
"host": ["{{cashfree_base_url}}"],
|
|
580
|
+
"path": ["subscriptions"]
|
|
581
|
+
},
|
|
582
|
+
"description": "Initializes a subscription for a customer to authorize mandate."
|
|
583
|
+
}
|
|
584
|
+
}
|
|
585
|
+
]
|
|
586
|
+
},
|
|
587
|
+
{
|
|
588
|
+
"name": "9. Webhooks Simulator",
|
|
589
|
+
"description": "Ready-to-fire simulated Cashfree webhooks for testing local servers and background workers.",
|
|
590
|
+
"item": [
|
|
591
|
+
{
|
|
592
|
+
"name": "Webhook: PAYMENT_SUCCESS_WEBHOOK",
|
|
593
|
+
"request": {
|
|
594
|
+
"method": "POST",
|
|
595
|
+
"header": [
|
|
596
|
+
{ "key": "Content-Type", "value": "application/json" },
|
|
597
|
+
{ "key": "x-webhook-signature", "value": "{{computed_webhook_signature}}" }
|
|
598
|
+
],
|
|
599
|
+
"body": {
|
|
600
|
+
"mode": "raw",
|
|
601
|
+
"raw": "{\n \"data\": {\n \"order\": {\n \"order_id\": \"order_cf_001\",\n \"order_amount\": 1499.00,\n \"order_currency\": \"INR\"\n },\n \"payment\": {\n \"cf_payment_id\": 109283719,\n \"payment_status\": \"SUCCESS\",\n \"payment_amount\": 1499.00,\n \"payment_currency\": \"INR\",\n \"payment_message\": \"Transaction successful\",\n \"payment_time\": \"2026-09-08T18:30:00+05:30\",\n \"bank_reference\": \"UPI-9821739218\",\n \"payment_method\": {\n \"upi\": {\n \"channel\": null,\n \"upi_id\": \"success@upi\"\n }\n }\n },\n \"customer_details\": {\n \"customer_name\": \"Aman Sharma\",\n \"customer_id\": \"cust_boost_01\",\n \"customer_email\": \"aman@example.com\",\n \"customer_phone\": \"9876543210\"\n }\n },\n \"event_time\": \"2026-09-08T18:30:05+05:30\",\n \"type\": \"PAYMENT_SUCCESS_WEBHOOK\"\n}"
|
|
602
|
+
},
|
|
603
|
+
"url": {
|
|
604
|
+
"raw": "{{local_webhook_url}}",
|
|
605
|
+
"host": ["{{local_webhook_url}}"]
|
|
606
|
+
},
|
|
607
|
+
"description": "Simulates PAYMENT_SUCCESS_WEBHOOK event."
|
|
608
|
+
}
|
|
609
|
+
},
|
|
610
|
+
{
|
|
611
|
+
"name": "Webhook: PAYMENT_FAILED_WEBHOOK",
|
|
612
|
+
"request": {
|
|
613
|
+
"method": "POST",
|
|
614
|
+
"header": [
|
|
615
|
+
{ "key": "Content-Type", "value": "application/json" },
|
|
616
|
+
{ "key": "x-webhook-signature", "value": "{{computed_webhook_signature}}" }
|
|
617
|
+
],
|
|
618
|
+
"body": {
|
|
619
|
+
"mode": "raw",
|
|
620
|
+
"raw": "{\n \"data\": {\n \"order\": {\n \"order_id\": \"order_cf_001\",\n \"order_amount\": 1499.00,\n \"order_currency\": \"INR\"\n },\n \"payment\": {\n \"cf_payment_id\": 109283720,\n \"payment_status\": \"FAILED\",\n \"payment_amount\": 1499.00,\n \"payment_message\": \"Bank declined transaction due to insufficient funds\"\n }\n },\n \"type\": \"PAYMENT_FAILED_WEBHOOK\"\n}"
|
|
621
|
+
},
|
|
622
|
+
"url": {
|
|
623
|
+
"raw": "{{local_webhook_url}}",
|
|
624
|
+
"host": ["{{local_webhook_url}}"]
|
|
625
|
+
},
|
|
626
|
+
"description": "Simulates PAYMENT_FAILED_WEBHOOK event."
|
|
627
|
+
}
|
|
628
|
+
},
|
|
629
|
+
{
|
|
630
|
+
"name": "Webhook: REFUND_STATUS_WEBHOOK",
|
|
631
|
+
"request": {
|
|
632
|
+
"method": "POST",
|
|
633
|
+
"header": [
|
|
634
|
+
{ "key": "Content-Type", "value": "application/json" },
|
|
635
|
+
{ "key": "x-webhook-signature", "value": "{{computed_webhook_signature}}" }
|
|
636
|
+
],
|
|
637
|
+
"body": {
|
|
638
|
+
"mode": "raw",
|
|
639
|
+
"raw": "{\n \"data\": {\n \"refund\": {\n \"cf_payment_id\": 109283719,\n \"cf_refund_id\": 8821921,\n \"order_id\": \"order_cf_001\",\n \"refund_id\": \"rfnd_cf_001\",\n \"refund_amount\": 1499.00,\n \"refund_status\": \"SUCCESS\",\n \"refund_arn\": \"ARN1928374619\"\n }\n },\n \"event_time\": \"2026-09-08T18:35:00+05:30\",\n \"type\": \"REFUND_STATUS_WEBHOOK\"\n}"
|
|
640
|
+
},
|
|
641
|
+
"url": {
|
|
642
|
+
"raw": "{{local_webhook_url}}",
|
|
643
|
+
"host": ["{{local_webhook_url}}"]
|
|
644
|
+
},
|
|
645
|
+
"description": "Simulates REFUND_STATUS_WEBHOOK event."
|
|
646
|
+
}
|
|
647
|
+
}
|
|
648
|
+
]
|
|
649
|
+
}
|
|
650
|
+
]
|
|
651
|
+
}
|