@gofynd/fdk-client-javascript 1.0.3 → 1.0.4

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.
Files changed (175) hide show
  1. package/README.md +31 -2
  2. package/index.d.ts +4 -4
  3. package/index.js +9 -10
  4. package/package.json +14 -14
  5. package/sdk/APIClient.d.ts +11 -0
  6. package/sdk/APIClient.js +35 -0
  7. package/sdk/Client.d.ts +6 -0
  8. package/sdk/Client.js +17 -0
  9. package/sdk/Config.d.ts +9 -0
  10. package/sdk/Config.js +17 -0
  11. package/sdk/application/Cart/CartApplicationClient.js +29 -28
  12. package/sdk/application/Cart/CartApplicationModel.js +3 -1
  13. package/sdk/application/Catalog/CatalogApplicationClient.js +43 -42
  14. package/sdk/application/Catalog/CatalogApplicationModel.js +1 -1
  15. package/sdk/application/Common/CommonApplicationClient.js +5 -4
  16. package/sdk/application/Communication/CommunicationApplicationClient.js +6 -5
  17. package/sdk/application/Configuration/ConfigurationApplicationClient.js +21 -20
  18. package/sdk/application/Content/ContentApplicationClient.js +26 -25
  19. package/sdk/application/Content/ContentApplicationModel.js +1 -0
  20. package/sdk/application/FileStorage/FileStorageApplicationClient.js +6 -5
  21. package/sdk/application/Lead/LeadApplicationClient.js +10 -9
  22. package/sdk/application/Logistic/LogisticApplicationClient.d.ts +1 -3
  23. package/sdk/application/Logistic/LogisticApplicationClient.js +11 -12
  24. package/sdk/application/Logistic/LogisticApplicationValidator.js +0 -1
  25. package/sdk/application/Order/OrderApplicationClient.js +15 -14
  26. package/sdk/application/Order/OrderApplicationModel.js +9 -0
  27. package/sdk/application/Payment/PaymentApplicationClient.js +42 -41
  28. package/sdk/application/PosCart/PosCartApplicationClient.js +30 -29
  29. package/sdk/application/PosCart/PosCartApplicationModel.js +3 -1
  30. package/sdk/application/Rewards/RewardsApplicationClient.js +11 -10
  31. package/sdk/application/Share/ShareApplicationClient.js +10 -9
  32. package/sdk/application/Theme/ThemeApplicationClient.js +7 -6
  33. package/sdk/application/User/UserApplicationClient.js +38 -37
  34. package/sdk/common/AxiosHelper.js +17 -6
  35. package/sdk/constructUrl.d.ts +5 -0
  36. package/sdk/constructUrl.js +13 -0
  37. package/sdk/index.d.ts +3 -0
  38. package/sdk/index.js +5 -0
  39. package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.js +3 -1
  40. package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.js +1 -1
  41. package/sdk/platform/Analytics/AnalyticsPlatformClient.js +5 -4
  42. package/sdk/platform/Analytics/AnalyticsPlatformValidator.js +1 -0
  43. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +3 -2
  44. package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.js +1 -0
  45. package/sdk/platform/Billing/BillingPlatformClient.js +3 -2
  46. package/sdk/platform/Billing/BillingPlatformValidator.js +1 -0
  47. package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +27 -0
  48. package/sdk/platform/Cart/CartPlatformApplicationClient.js +177 -1
  49. package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +3 -0
  50. package/sdk/platform/Cart/CartPlatformApplicationValidator.js +17 -1
  51. package/sdk/platform/Cart/CartPlatformModel.js +7 -3
  52. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +3 -1
  53. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +1 -1
  54. package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +2 -2
  55. package/sdk/platform/Catalog/CatalogPlatformClient.js +6 -9
  56. package/sdk/platform/Catalog/CatalogPlatformModel.js +7 -7
  57. package/sdk/platform/Catalog/CatalogPlatformValidator.js +2 -1
  58. package/sdk/platform/Common/CommonPlatformClient.js +7 -18
  59. package/sdk/platform/Common/CommonPlatformValidator.js +1 -0
  60. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +3 -1
  61. package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +1 -1
  62. package/sdk/platform/Communication/CommunicationPlatformClient.js +4 -3
  63. package/sdk/platform/Communication/CommunicationPlatformValidator.js +1 -0
  64. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +5 -4
  65. package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +1 -0
  66. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +3 -1
  67. package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +1 -1
  68. package/sdk/platform/Configuration/ConfigurationPlatformClient.js +9 -8
  69. package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +1 -0
  70. package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +0 -10
  71. package/sdk/platform/Content/ContentPlatformApplicationClient.js +3 -62
  72. package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +0 -1
  73. package/sdk/platform/Content/ContentPlatformApplicationValidator.js +1 -7
  74. package/sdk/platform/Content/ContentPlatformModel.js +1 -0
  75. package/sdk/platform/Discount/DiscountPlatformClient.js +3 -2
  76. package/sdk/platform/Discount/DiscountPlatformValidator.js +1 -0
  77. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +3 -3
  78. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +27 -5
  79. package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +1 -1
  80. package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +3 -3
  81. package/sdk/platform/FileStorage/FileStoragePlatformClient.js +28 -6
  82. package/sdk/platform/FileStorage/FileStoragePlatformValidator.js +1 -0
  83. package/sdk/platform/Inventory/InventoryPlatformClient.js +3 -2
  84. package/sdk/platform/Inventory/InventoryPlatformValidator.js +1 -0
  85. package/sdk/platform/Lead/LeadPlatformApplicationClient.js +3 -1
  86. package/sdk/platform/Lead/LeadPlatformApplicationValidator.js +1 -1
  87. package/sdk/platform/Lead/LeadPlatformClient.js +4 -3
  88. package/sdk/platform/Lead/LeadPlatformValidator.js +1 -0
  89. package/sdk/platform/Order/OrderPlatformApplicationClient.js +3 -1
  90. package/sdk/platform/Order/OrderPlatformApplicationValidator.js +1 -1
  91. package/sdk/platform/Order/OrderPlatformClient.d.ts +1 -1
  92. package/sdk/platform/Order/OrderPlatformClient.js +16 -3
  93. package/sdk/platform/Order/OrderPlatformModel.js +1 -0
  94. package/sdk/platform/Order/OrderPlatformValidator.js +1 -0
  95. package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +3 -1
  96. package/sdk/platform/Partner/PartnerPlatformApplicationValidator.js +1 -1
  97. package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +1 -1
  98. package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +14 -14
  99. package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +1 -1
  100. package/sdk/platform/Payment/PaymentPlatformClient.js +3 -2
  101. package/sdk/platform/Payment/PaymentPlatformValidator.js +1 -0
  102. package/sdk/platform/PlatformClient.d.ts +13 -9
  103. package/sdk/platform/PlatformClient.js +13 -9
  104. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +4 -4
  105. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +36 -17
  106. package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.js +1 -1
  107. package/sdk/platform/Share/SharePlatformApplicationClient.js +3 -1
  108. package/sdk/platform/Share/SharePlatformApplicationValidator.js +1 -1
  109. package/sdk/platform/Theme/ThemePlatformApplicationClient.js +3 -1
  110. package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +1 -1
  111. package/sdk/platform/User/UserPlatformApplicationClient.js +3 -1
  112. package/sdk/platform/User/UserPlatformApplicationValidator.js +1 -1
  113. package/sdk/platform/Webhook/WebhookPlatformClient.js +3 -2
  114. package/sdk/platform/Webhook/WebhookPlatformValidator.js +1 -0
  115. package/sdk/public/Configuration/ConfigurationPublicClient.js +2 -0
  116. package/sdk/public/Inventory/InventoryPublicClient.js +2 -0
  117. package/sdk/public/Webhook/WebhookPublicClient.js +2 -0
  118. package/.github/workflows/on_create_release.yml +0 -23
  119. package/.github/workflows/on_merge_main.yml +0 -38
  120. package/.github/workflows/on_pull_request.yml +0 -35
  121. package/.prettierrc +0 -5
  122. package/documentation/application/CART.md +0 -8771
  123. package/documentation/application/CATALOG.md +0 -8690
  124. package/documentation/application/COMMON.md +0 -325
  125. package/documentation/application/COMMUNICATION.md +0 -387
  126. package/documentation/application/CONFIGURATION.md +0 -2212
  127. package/documentation/application/CONTENT.md +0 -2629
  128. package/documentation/application/FILESTORAGE.md +0 -442
  129. package/documentation/application/LEAD.md +0 -1549
  130. package/documentation/application/LOGISTIC.md +0 -689
  131. package/documentation/application/ORDER.md +0 -2937
  132. package/documentation/application/PAYMENT.md +0 -4475
  133. package/documentation/application/POSCART.md +0 -9375
  134. package/documentation/application/README.md +0 -21
  135. package/documentation/application/REWARDS.md +0 -554
  136. package/documentation/application/SHARE.md +0 -635
  137. package/documentation/application/THEME.md +0 -5517
  138. package/documentation/application/USER.md +0 -3798
  139. package/documentation/platform/ANALYTICS.md +0 -1012
  140. package/documentation/platform/AUDITTRAIL.md +0 -493
  141. package/documentation/platform/BILLING.md +0 -1889
  142. package/documentation/platform/CART.md +0 -4711
  143. package/documentation/platform/CATALOG.md +0 -20522
  144. package/documentation/platform/COMMON.md +0 -325
  145. package/documentation/platform/COMMUNICATION.md +0 -4970
  146. package/documentation/platform/COMPANYPROFILE.md +0 -1646
  147. package/documentation/platform/CONFIGURATION.md +0 -6316
  148. package/documentation/platform/CONTENT.md +0 -8364
  149. package/documentation/platform/DISCOUNT.md +0 -767
  150. package/documentation/platform/FILESTORAGE.md +0 -945
  151. package/documentation/platform/INVENTORY.md +0 -1136
  152. package/documentation/platform/LEAD.md +0 -4394
  153. package/documentation/platform/ORDER.md +0 -6525
  154. package/documentation/platform/PARTNER.md +0 -193
  155. package/documentation/platform/PAYMENT.md +0 -3138
  156. package/documentation/platform/README.md +0 -27
  157. package/documentation/platform/REWARDS.md +0 -919
  158. package/documentation/platform/SHARE.md +0 -513
  159. package/documentation/platform/THEME.md +0 -35446
  160. package/documentation/platform/USER.md +0 -2174
  161. package/documentation/platform/WEBHOOK.md +0 -485
  162. package/documentation/public/CONFIGURATION.md +0 -325
  163. package/documentation/public/INVENTORY.md +0 -508
  164. package/documentation/public/WEBHOOK.md +0 -246
  165. package/jest.config.d.ts +0 -4
  166. package/jest.config.js +0 -6
  167. package/tests/application/catalog.spec.js +0 -54
  168. package/tests/common/action-url.spec.js +0 -35
  169. package/tests/common/schema/action-url.json +0 -178
  170. package/tests/common/schema/url-action.json +0 -683
  171. package/tests/common/url-action.spec.js +0 -48
  172. package/tests/helpers/cookie.helper.js +0 -31
  173. package/tests/helpers/oauth.helper.js +0 -43
  174. package/tests/platform/catalog.spec.js +0 -49
  175. package/tests/public/location.spec.js +0 -39
@@ -1,3138 +0,0 @@
1
-
2
-
3
-
4
-
5
-
6
- ##### [Back to Platform docs](./README.md)
7
-
8
- ## Payment Methods
9
- Collect payment through many payment gateway i.e Stripe, Razorpay, Juspay etc.into Fynd or Self account
10
-
11
- * [activateAndDectivatePayout](#activateanddectivatepayout)
12
- * [addRefundBankAccountUsingOTP](#addrefundbankaccountusingotp)
13
- * [confirmPayment](#confirmpayment)
14
- * [deletePayout](#deletepayout)
15
- * [deleteSubscriptionPaymentMethod](#deletesubscriptionpaymentmethod)
16
- * [getAllPayouts](#getallpayouts)
17
- * [getBankAccountDetailsOpenAPI](#getbankaccountdetailsopenapi)
18
- * [getBrandPaymentGatewayConfig](#getbrandpaymentgatewayconfig)
19
- * [getPaymentModeRoutes](#getpaymentmoderoutes)
20
- * [getSubscriptionConfig](#getsubscriptionconfig)
21
- * [getSubscriptionPaymentMethod](#getsubscriptionpaymentmethod)
22
- * [getUserBeneficiaries](#getuserbeneficiaries)
23
- * [getUserCODlimitRoutes](#getusercodlimitroutes)
24
- * [getUserOrderBeneficiaries](#getuserorderbeneficiaries)
25
- * [saveBrandPaymentGatewayConfig](#savebrandpaymentgatewayconfig)
26
- * [savePayout](#savepayout)
27
- * [saveSubscriptionSetupIntent](#savesubscriptionsetupintent)
28
- * [setUserCODlimitRoutes](#setusercodlimitroutes)
29
- * [updateBrandPaymentGatewayConfig](#updatebrandpaymentgatewayconfig)
30
- * [updatePayout](#updatepayout)
31
- * [verifyIfscCode](#verifyifsccode)
32
-
33
-
34
-
35
- ## Methods with example and description
36
-
37
-
38
-
39
-
40
- ### activateAndDectivatePayout
41
- Partial Update Payout
42
-
43
-
44
-
45
- ```javascript
46
- // Promise
47
- const promise = client.payment.activateAndDectivatePayout({ uniqueTransferNo : value,
48
- body : value });
49
-
50
- // Async/Await
51
- const data = await client.payment.activateAndDectivatePayout({ uniqueTransferNo : value,
52
- body : value });
53
- ```
54
-
55
-
56
-
57
-
58
-
59
- | Argument | Type | Required | Description |
60
- | --------- | ----- | -------- | ----------- |
61
- | uniqueTransferNo | string | yes | Unique transfer id |
62
- | body | [UpdatePayoutRequest](#UpdatePayoutRequest) | yes | Request body |
63
-
64
-
65
- Partial Update Payout
66
-
67
- *Returned Response:*
68
-
69
-
70
-
71
-
72
- [UpdatePayoutResponse](#UpdatePayoutResponse)
73
-
74
- save payout response object
75
-
76
-
77
-
78
-
79
- <details>
80
- <summary><i>&nbsp; Example:</i></summary>
81
-
82
- ```json
83
- {
84
- "success": true,
85
- "is_default": true,
86
- "is_active": true
87
- }
88
- ```
89
- </details>
90
-
91
-
92
-
93
-
94
-
95
-
96
-
97
-
98
-
99
- ---
100
-
101
-
102
- ### addRefundBankAccountUsingOTP
103
- Save bank details for cancelled/returned order
104
-
105
-
106
-
107
- ```javascript
108
- // Promise
109
- const promise = client.application("<APPLICATION_ID>").payment.addRefundBankAccountUsingOTP({ body : value });
110
-
111
- // Async/Await
112
- const data = await client.application("<APPLICATION_ID>").payment.addRefundBankAccountUsingOTP({ body : value });
113
- ```
114
-
115
-
116
-
117
-
118
-
119
- | Argument | Type | Required | Description |
120
- | --------- | ----- | -------- | ----------- |
121
- | body | [AddBeneficiaryDetailsOTPRequest](#AddBeneficiaryDetailsOTPRequest) | yes | Request body |
122
-
123
-
124
- Use this API to save bank details for returned/cancelled order to refund amount in his account.
125
-
126
- *Returned Response:*
127
-
128
-
129
-
130
-
131
- [RefundAccountResponse](#RefundAccountResponse)
132
-
133
- Success
134
-
135
-
136
-
137
-
138
- <details>
139
- <summary><i>&nbsp; Example:</i></summary>
140
-
141
- ```json
142
- {
143
- "success": true,
144
- "message": "Account successfully created",
145
- "data": {},
146
- "is_verified_flag": true
147
- }
148
- ```
149
- </details>
150
-
151
-
152
-
153
-
154
-
155
-
156
-
157
-
158
-
159
- ---
160
-
161
-
162
- ### confirmPayment
163
- Confirm payment after successful payment from payment gateway
164
-
165
-
166
-
167
- ```javascript
168
- // Promise
169
- const promise = client.application("<APPLICATION_ID>").payment.confirmPayment({ body : value });
170
-
171
- // Async/Await
172
- const data = await client.application("<APPLICATION_ID>").payment.confirmPayment({ body : value });
173
- ```
174
-
175
-
176
-
177
-
178
-
179
- | Argument | Type | Required | Description |
180
- | --------- | ----- | -------- | ----------- |
181
- | body | [PaymentConfirmationRequest](#PaymentConfirmationRequest) | yes | Request body |
182
-
183
-
184
- Use this API to confirm payment after payment gateway accepted payment.
185
-
186
- *Returned Response:*
187
-
188
-
189
-
190
-
191
- [PaymentConfirmationResponse](#PaymentConfirmationResponse)
192
-
193
- Success. Returns the status of payment. Check the example shown below or refer `PaymentConfirmationResponseSchema` for more details.
194
-
195
-
196
-
197
-
198
- <details>
199
- <summary><i>&nbsp; Example:</i></summary>
200
-
201
- ```json
202
- {
203
- "success": true,
204
- "message": "Payment Successful",
205
- "order_id": "FY60F90AEF01FF43E878"
206
- }
207
- ```
208
- </details>
209
-
210
-
211
-
212
-
213
-
214
-
215
-
216
-
217
-
218
- ---
219
-
220
-
221
- ### deletePayout
222
- Delete Payout
223
-
224
-
225
-
226
- ```javascript
227
- // Promise
228
- const promise = client.payment.deletePayout({ uniqueTransferNo : value });
229
-
230
- // Async/Await
231
- const data = await client.payment.deletePayout({ uniqueTransferNo : value });
232
- ```
233
-
234
-
235
-
236
-
237
-
238
- | Argument | Type | Required | Description |
239
- | --------- | ----- | -------- | ----------- |
240
- | uniqueTransferNo | string | yes | Unique transfer id |
241
-
242
-
243
-
244
- Delete Payout
245
-
246
- *Returned Response:*
247
-
248
-
249
-
250
-
251
- [DeletePayoutResponse](#DeletePayoutResponse)
252
-
253
- delete payout response object
254
-
255
-
256
-
257
-
258
- <details>
259
- <summary><i>&nbsp; Example:</i></summary>
260
-
261
- ```json
262
- {
263
- "success": true
264
- }
265
- ```
266
- </details>
267
-
268
-
269
-
270
-
271
-
272
-
273
-
274
-
275
-
276
- ---
277
-
278
-
279
- ### deleteSubscriptionPaymentMethod
280
- Delete Subscription Payment Method
281
-
282
-
283
-
284
- ```javascript
285
- // Promise
286
- const promise = client.payment.deleteSubscriptionPaymentMethod({ uniqueExternalId : value,
287
- paymentMethodId : value });
288
-
289
- // Async/Await
290
- const data = await client.payment.deleteSubscriptionPaymentMethod({ uniqueExternalId : value,
291
- paymentMethodId : value });
292
- ```
293
-
294
-
295
-
296
-
297
-
298
- | Argument | Type | Required | Description |
299
- | --------- | ----- | -------- | ----------- |
300
- | uniqueExternalId | string | yes | |
301
- | paymentMethodId | string | yes | |
302
-
303
-
304
-
305
- Uses this api to Delete Subscription Payment Method
306
-
307
- *Returned Response:*
308
-
309
-
310
-
311
-
312
- [DeleteSubscriptionPaymentMethodResponse](#DeleteSubscriptionPaymentMethodResponse)
313
-
314
- Delete Subscription Payment Method Response.
315
-
316
-
317
-
318
-
319
- <details>
320
- <summary><i>&nbsp; Example:</i></summary>
321
-
322
- ```json
323
- {
324
- "success": true
325
- }
326
- ```
327
- </details>
328
-
329
-
330
-
331
-
332
-
333
-
334
-
335
-
336
-
337
- ---
338
-
339
-
340
- ### getAllPayouts
341
- Get All Payouts
342
-
343
-
344
-
345
- ```javascript
346
- // Promise
347
- const promise = client.payment.getAllPayouts({ uniqueExternalId : value });
348
-
349
- // Async/Await
350
- const data = await client.payment.getAllPayouts({ uniqueExternalId : value });
351
- ```
352
-
353
-
354
-
355
-
356
-
357
- | Argument | Type | Required | Description |
358
- | --------- | ----- | -------- | ----------- |
359
- | uniqueExternalId | string | no | Fetch payouts using unique external id |
360
-
361
-
362
-
363
- Get All Payouts
364
-
365
- *Returned Response:*
366
-
367
-
368
-
369
-
370
- [PayoutsResponse](#PayoutsResponse)
371
-
372
- payouts response object
373
-
374
-
375
-
376
-
377
- <details>
378
- <summary><i>&nbsp; Example:</i></summary>
379
-
380
- ```json
381
- [
382
- {
383
- "unique_transfer_no": "d2ff79fcd3459831864824da8c9d7e5f",
384
- "more_attributes": {
385
- "city": "",
386
- "state": "",
387
- "country": "",
388
- "bank_name": "YES",
389
- "ifsc_code": "IFSCYES101",
390
- "account_no": "9876541234",
391
- "branch_name": "Mumbai",
392
- "account_type": "current",
393
- "account_holder": "Vikas Kumar"
394
- },
395
- "transfer_type": "bank",
396
- "is_default": true,
397
- "is_active": true,
398
- "customers": {
399
- "id": 2,
400
- "name": "reliance retail",
401
- "mobile": "1234567890",
402
- "email": "reliance@gmail.com",
403
- "unique_external_id": "company:1"
404
- },
405
- "payouts_aggregators": [
406
- {
407
- "payout_details_id": 888,
408
- "aggregator_id": 3,
409
- "aggregator_fund_id": null
410
- }
411
- ]
412
- },
413
- {
414
- "unique_transfer_no": "e388c1c5df4933fa01f6da9f92595589",
415
- "more_attributes": {
416
- "city": "",
417
- "state": "",
418
- "country": "",
419
- "bank_name": "SBI",
420
- "ifsc_code": "SBIN0011513",
421
- "account_no": "9876543210",
422
- "branch_name": "Mumbai",
423
- "account_type": "saving",
424
- "account_holder": "Vikas Kumar"
425
- },
426
- "transfer_type": "bank",
427
- "is_default": false,
428
- "is_active": true,
429
- "customers": {
430
- "id": 2,
431
- "name": "reliance retail",
432
- "mobile": "1234567890",
433
- "email": "reliance@gmail.com",
434
- "unique_external_id": "company:1"
435
- },
436
- "payouts_aggregators": [
437
- {
438
- "payout_details_id": 891,
439
- "aggregator_id": 3,
440
- "aggregator_fund_id": null
441
- }
442
- ]
443
- }
444
- ]
445
- ```
446
- </details>
447
-
448
-
449
-
450
-
451
-
452
-
453
-
454
-
455
-
456
- ---
457
-
458
-
459
- ### getBankAccountDetailsOpenAPI
460
- Get bank details
461
-
462
-
463
-
464
- ```javascript
465
- // Promise
466
- const promise = client.application("<APPLICATION_ID>").payment.getBankAccountDetailsOpenAPI({ orderId : value,
467
- requestHash : value });
468
-
469
- // Async/Await
470
- const data = await client.application("<APPLICATION_ID>").payment.getBankAccountDetailsOpenAPI({ orderId : value,
471
- requestHash : value });
472
- ```
473
-
474
-
475
-
476
-
477
-
478
- | Argument | Type | Required | Description |
479
- | --------- | ----- | -------- | ----------- |
480
- | orderId | string | yes | |
481
- | requestHash | string | no | |
482
-
483
-
484
-
485
- Use this API to get saved bank details for returned/cancelled order using order id.
486
-
487
- *Returned Response:*
488
-
489
-
490
-
491
-
492
- [RefundAccountResponse](#RefundAccountResponse)
493
-
494
- Success
495
-
496
-
497
-
498
-
499
- <details>
500
- <summary><i>&nbsp; Example:</i></summary>
501
-
502
- ```json
503
- {
504
- "success": true,
505
- "data": {
506
- "account_no": "XXXX-XXXX-6682",
507
- "ifsc_code": "SBIEXAMPLE001",
508
- "email": "loremipsum@example.com",
509
- "address": "1773 Monroe Street",
510
- "bank_name": "SBI",
511
- "branch_name": "HOUSTON",
512
- "comment": "Lorem Ipsum",
513
- "account_holder": "Leslie Rice",
514
- "mobile": "0987654321"
515
- }
516
- }
517
- ```
518
- </details>
519
-
520
-
521
-
522
-
523
-
524
-
525
-
526
-
527
-
528
- ---
529
-
530
-
531
- ### getBrandPaymentGatewayConfig
532
- Get All Brand Payment Gateway Config Secret
533
-
534
-
535
-
536
- ```javascript
537
- // Promise
538
- const promise = client.application("<APPLICATION_ID>").payment.getBrandPaymentGatewayConfig();
539
-
540
- // Async/Await
541
- const data = await client.application("<APPLICATION_ID>").payment.getBrandPaymentGatewayConfig();
542
- ```
543
-
544
-
545
-
546
-
547
-
548
-
549
- Get All Brand Payment Gateway Config Secret
550
-
551
- *Returned Response:*
552
-
553
-
554
-
555
-
556
- [PaymentGatewayConfigResponse](#PaymentGatewayConfigResponse)
557
-
558
- Refund Transfer Mode
559
-
560
-
561
-
562
-
563
- <details>
564
- <summary><i>&nbsp; Example:</i></summary>
565
-
566
- ```json
567
- {
568
- "success": true,
569
- "created": true,
570
- "app_id": "000000000000000000000004",
571
- "excluded_fields": [
572
- "config_type",
573
- "aggregator"
574
- ],
575
- "display_fields": [
576
- "logo",
577
- "display"
578
- ],
579
- "aggregators": [
580
- {
581
- "key": "rrroooouuurrrrdddd",
582
- "secret": "yyyyooo",
583
- "is_active": false,
584
- "config_type": "",
585
- "merchant_key": "vvvvvvvvddd",
586
- "aggregator": "juspay",
587
- "display": {
588
- "link": "",
589
- "text": "Review in under process. Please wait while process completed or contact us for any further query.",
590
- "description": "Juspay is not a Payment Gateway (like Citrus, CCAvenue, PayU) but it works with any gateway or aggregator with zero interference in the Merchant-PG relations.",
591
- "reviewed": false
592
- },
593
- "logo": "https://hdn-1.fynd.com/payment/juspay-pg-logo.jpg"
594
- },
595
- {
596
- "key": "",
597
- "pin": "",
598
- "secret": "",
599
- "user_id": "",
600
- "is_active": false,
601
- "config_type": "",
602
- "merchant_id": "",
603
- "aggregator": "mswipe",
604
- "display": {
605
- "link": "",
606
- "text": "Submitted request to be reviewed before going live. Please contact us for any further query.",
607
- "description": "Mswipe card swipe machines are safe and secure and accepts all debit & credit cards."
608
- },
609
- "logo": "https://hdn-1.fynd.com/payment/mswipe-pg-logo.png"
610
- },
611
- {
612
- "key": "tttyyyyyy",
613
- "secret": "rerrrrrrrr",
614
- "is_active": false,
615
- "config_type": "",
616
- "merchant_salt": "qqqqq",
617
- "aggregator": "payumoney",
618
- "display": {
619
- "link": "",
620
- "text": "Review in under process. Please wait while process completed or contact us for any further query.",
621
- "description": "PayUmoney supports wide range of options for making online payments via wallets, UPI, cards, and netbanking.",
622
- "reviewed": false
623
- },
624
- "logo": "https://hdn-1.fynd.com/payment/payu_logo_large.png"
625
- },
626
- {
627
- "key": "test",
628
- "secret": "test",
629
- "is_active": true,
630
- "config_type": "self",
631
- "webhook_secret": "test",
632
- "aggregator": "razorpay",
633
- "display": {
634
- "link": "",
635
- "text": "Well done, You payment gateway successfully lived. Collect your payment at your end.",
636
- "description": "Razorpay is a payments platform which accept online payments via Credit Card, Debit Card, Net banking, UPI, BharatQR and Wallets.",
637
- "reviewed": true
638
- },
639
- "logo": "https://hdn-1.fynd.com/payment/razorpay-pg-logo.jpg"
640
- },
641
- {
642
- "key": "",
643
- "secret": "",
644
- "is_active": false,
645
- "config_type": "",
646
- "aggregator": "rupifi",
647
- "display": {
648
- "link": "",
649
- "text": "Submitted request to be reviewed before going live. Please contact us for any further query.",
650
- "description": "Rupifi enables businesses to avail credits and allows a 'Buy now, Pay later' system for making transactions and purchases."
651
- },
652
- "logo": "https://hdn-1.fynd.com/payment/Rupifi.png"
653
- },
654
- {
655
- "key": "12345",
656
- "secret": "12345",
657
- "is_active": false,
658
- "config_type": "",
659
- "aggregator": "simpl",
660
- "display": {
661
- "link": "",
662
- "text": "Review in under process. Please wait while process completed or contact us for any further query.",
663
- "description": "Simpl is a Pay Later payment method.",
664
- "reviewed": false
665
- },
666
- "logo": "https://hdn-1.fynd.com/payment/simpl-pg-logo.jpg"
667
- },
668
- {
669
- "key": "",
670
- "secret": "",
671
- "is_active": false,
672
- "product_id": "",
673
- "config_type": "",
674
- "webhook_secret": "",
675
- "aggregator": "stripe",
676
- "display": {
677
- "link": "",
678
- "text": "Submitted request to be reviewed before going live. Please contact us for any further query.",
679
- "description": "Stripe is a payment processor that supports online payments, credit cards, recurring subscriptions and direct payouts to bank accounts."
680
- },
681
- "logo": "https://hdn-1.fynd.com/payment/Stripe.png"
682
- }
683
- ]
684
- }
685
- ```
686
- </details>
687
-
688
-
689
-
690
-
691
-
692
-
693
-
694
-
695
-
696
- ---
697
-
698
-
699
- ### getPaymentModeRoutes
700
- Get All Valid Payment Options
701
-
702
-
703
-
704
- ```javascript
705
- // Promise
706
- const promise = client.application("<APPLICATION_ID>").payment.getPaymentModeRoutes({ refresh : value,
707
- requestType : value });
708
-
709
- // Async/Await
710
- const data = await client.application("<APPLICATION_ID>").payment.getPaymentModeRoutes({ refresh : value,
711
- requestType : value });
712
- ```
713
-
714
-
715
-
716
-
717
-
718
- | Argument | Type | Required | Description |
719
- | --------- | ----- | -------- | ----------- |
720
- | refresh | boolean | yes | |
721
- | requestType | string | yes | |
722
-
723
-
724
-
725
- Use this API to get Get All Valid Payment Options for making payment
726
-
727
- *Returned Response:*
728
-
729
-
730
-
731
-
732
- [PaymentOptionsResponse](#PaymentOptionsResponse)
733
-
734
- Success
735
-
736
-
737
-
738
-
739
- <details>
740
- <summary><i>&nbsp; Example:</i></summary>
741
-
742
- ```json
743
- {
744
- "success": true,
745
- "payment_options": {
746
- "payment_option": [
747
- {
748
- "name": "CARD",
749
- "display_priority": 2,
750
- "payment_mode_id": 2,
751
- "display_name": "Card",
752
- "list": [],
753
- "anonymous_enable": true,
754
- "aggregator_name": "Razorpay",
755
- "add_card_enabled": false,
756
- "save_card": true,
757
- "types": [],
758
- "networks": [],
759
- "banks": []
760
- },
761
- {
762
- "name": "NB",
763
- "display_priority": 3,
764
- "payment_mode_id": 3,
765
- "display_name": "Net Banking",
766
- "list": [
767
- {
768
- "aggregator_name": "Razorpay",
769
- "name": "ICICI Bank",
770
- "code": "ICIC",
771
- "bank_name": "ICICI Bank",
772
- "bank_code": "ICIC",
773
- "url": "https://hdn-1.fynd.com/payment/NB_ICICI.png",
774
- "logo_url": {
775
- "small": "https://hdn-1.fynd.com/payment/NB_ICICI.png",
776
- "large": "https://hdn-1.fynd.com/payment/NB_ICICI.png"
777
- },
778
- "merchant_code": "NB_ICICI",
779
- "display_priority": 1,
780
- "display_name": "ICICI Bank"
781
- },
782
- {
783
- "aggregator_name": "Razorpay",
784
- "name": "HDFC Bank",
785
- "code": "HDFC",
786
- "bank_name": "HDFC Bank",
787
- "bank_code": "HDFC",
788
- "url": "https://hdn-1.fynd.com/payment/NB_HDFC.png",
789
- "logo_url": {
790
- "small": "https://hdn-1.fynd.com/payment/NB_HDFC.png",
791
- "large": "https://hdn-1.fynd.com/payment/NB_HDFC.png"
792
- },
793
- "merchant_code": "NB_HDFC",
794
- "display_priority": 2,
795
- "display_name": "HDFC Bank"
796
- },
797
- {
798
- "aggregator_name": "Razorpay",
799
- "name": "Axis Bank",
800
- "code": "UTIB",
801
- "bank_name": "Axis Bank",
802
- "bank_code": "UTIB",
803
- "url": "https://hdn-1.fynd.com/payment/NB_AXIS.png",
804
- "logo_url": {
805
- "small": "https://hdn-1.fynd.com/payment/NB_AXIS.png",
806
- "large": "https://hdn-1.fynd.com/payment/NB_AXIS.png"
807
- },
808
- "merchant_code": "NB_AXIS",
809
- "display_priority": 3,
810
- "display_name": "Axis Bank"
811
- },
812
- {
813
- "aggregator_name": "Razorpay",
814
- "name": "State Bank of India",
815
- "code": "SBIN",
816
- "bank_name": "State Bank of India",
817
- "bank_code": "SBIN",
818
- "url": "https://hdn-1.fynd.com/payment/NB_SBI.png",
819
- "logo_url": {
820
- "small": "https://hdn-1.fynd.com/payment/NB_SBI.png",
821
- "large": "https://hdn-1.fynd.com/payment/NB_SBI.png"
822
- },
823
- "merchant_code": "NB_SBI",
824
- "display_priority": 4,
825
- "display_name": "State Bank of India"
826
- },
827
- {
828
- "aggregator_name": "Razorpay",
829
- "name": "Kotak Mahindra Bank",
830
- "code": "KKBK",
831
- "bank_name": "Kotak Mahindra Bank",
832
- "bank_code": "KKBK",
833
- "url": "https://hdn-1.fynd.com/payment/NB_KOTAK.png",
834
- "logo_url": {
835
- "small": "https://hdn-1.fynd.com/payment/NB_KOTAK.png",
836
- "large": "https://hdn-1.fynd.com/payment/NB_KOTAK.png"
837
- },
838
- "merchant_code": "NB_KOTAK",
839
- "display_priority": 5,
840
- "display_name": "Kotak Mahindra Bank"
841
- },
842
- {
843
- "aggregator_name": "Razorpay",
844
- "name": "Indusind Bank",
845
- "code": "INDB",
846
- "bank_name": "Indusind Bank",
847
- "bank_code": "INDB",
848
- "url": "https://hdn-1.fynd.com/payment/NB_INDUS.png",
849
- "logo_url": {
850
- "small": "https://hdn-1.fynd.com/payment/NB_INDUS.png",
851
- "large": "https://hdn-1.fynd.com/payment/NB_INDUS.png"
852
- },
853
- "merchant_code": "INDB",
854
- "display_priority": 6,
855
- "display_name": "Indusind Bank"
856
- },
857
- {
858
- "aggregator_name": "Razorpay",
859
- "name": "City Union Bank",
860
- "code": "CIUB",
861
- "bank_name": "City Union Bank",
862
- "bank_code": "CIUB",
863
- "url": "https://hdn-1.fynd.com/payment/NB_generic.png",
864
- "logo_url": {
865
- "small": "https://hdn-1.fynd.com/payment/NB_generic.png",
866
- "large": "https://hdn-1.fynd.com/payment/NB_generic.png"
867
- },
868
- "merchant_code": "NB_CUB",
869
- "display_priority": 9,
870
- "display_name": "City Union Bank"
871
- },
872
- {
873
- "aggregator_name": "Razorpay",
874
- "name": "Catholic Syrian Bank",
875
- "code": "CSBK",
876
- "bank_name": "Catholic Syrian Bank",
877
- "bank_code": "CSBK",
878
- "url": "https://hdn-1.fynd.com/payment/NB_generic.png",
879
- "logo_url": {
880
- "small": "https://hdn-1.fynd.com/payment/NB_generic.png",
881
- "large": "https://hdn-1.fynd.com/payment/NB_generic.png"
882
- },
883
- "merchant_code": "CSBK",
884
- "display_priority": 11,
885
- "display_name": "Catholic Syrian Bank"
886
- },
887
- {
888
- "aggregator_name": "Razorpay",
889
- "name": "State Bank of Hyderabad",
890
- "code": "SBHY",
891
- "bank_name": "State Bank of Hyderabad",
892
- "bank_code": "SBHY",
893
- "url": "https://hdn-1.fynd.com/payment/NB_generic.png",
894
- "logo_url": {
895
- "small": "https://hdn-1.fynd.com/payment/NB_generic.png",
896
- "large": "https://hdn-1.fynd.com/payment/NB_generic.png"
897
- },
898
- "merchant_code": "NB_SBH",
899
- "display_priority": 12,
900
- "display_name": "State Bank of Hyderabad"
901
- },
902
- {
903
- "aggregator_name": "Razorpay",
904
- "name": "Allahabad Bank",
905
- "code": "ALLA",
906
- "bank_name": "Allahabad Bank",
907
- "bank_code": "ALLA",
908
- "url": "https://hdn-1.fynd.com/payment/NB_generic.png",
909
- "logo_url": {
910
- "small": "https://hdn-1.fynd.com/payment/NB_generic.png",
911
- "large": "https://hdn-1.fynd.com/payment/NB_generic.png"
912
- },
913
- "merchant_code": "ALLA",
914
- "display_priority": 15,
915
- "display_name": "Allahabad Bank"
916
- },
917
- {
918
- "aggregator_name": "Razorpay",
919
- "name": "Syndicate Bank",
920
- "code": "SYNB",
921
- "bank_name": "Syndicate Bank",
922
- "bank_code": "SYNB",
923
- "url": "https://hdn-1.fynd.com/payment/NB_generic.png",
924
- "logo_url": {
925
- "small": "https://hdn-1.fynd.com/payment/NB_generic.png",
926
- "large": "https://hdn-1.fynd.com/payment/NB_generic.png"
927
- },
928
- "merchant_code": "SYNB",
929
- "display_priority": 17,
930
- "display_name": "Syndicate Bank"
931
- },
932
- {
933
- "aggregator_name": "Razorpay",
934
- "name": "Corporation Bank",
935
- "code": "CORP",
936
- "bank_name": "Corporation Bank",
937
- "bank_code": "CORP",
938
- "url": "https://hdn-1.fynd.com/payment/NB_generic.png",
939
- "logo_url": {
940
- "small": "https://hdn-1.fynd.com/payment/NB_generic.png",
941
- "large": "https://hdn-1.fynd.com/payment/NB_generic.png"
942
- },
943
- "merchant_code": "NB_CORP",
944
- "display_priority": 18,
945
- "display_name": "Corporation Bank"
946
- },
947
- {
948
- "aggregator_name": "Razorpay",
949
- "name": "Punjab National Bank - Corporate Banking",
950
- "code": "PUNB_C",
951
- "bank_name": "Punjab National Bank - Corporate Banking",
952
- "bank_code": "PUNB_C",
953
- "url": "https://hdn-1.fynd.com/payment/NB_generic.png",
954
- "logo_url": {
955
- "small": "https://hdn-1.fynd.com/payment/NB_generic.png",
956
- "large": "https://hdn-1.fynd.com/payment/NB_generic.png"
957
- },
958
- "merchant_code": "PUNB_C",
959
- "display_priority": 19,
960
- "display_name": "Punjab National Bank - Corporate Banking"
961
- },
962
- {
963
- "aggregator_name": "Razorpay",
964
- "name": "Canara Bank",
965
- "code": "CNRB",
966
- "bank_name": "Canara Bank",
967
- "bank_code": "CNRB",
968
- "url": "https://hdn-1.fynd.com/payment/NB_generic.png",
969
- "logo_url": {
970
- "small": "https://hdn-1.fynd.com/payment/NB_generic.png",
971
- "large": "https://hdn-1.fynd.com/payment/NB_generic.png"
972
- },
973
- "merchant_code": "NB_CANR",
974
- "display_priority": 20,
975
- "display_name": "Canara Bank"
976
- },
977
- {
978
- "aggregator_name": "Razorpay",
979
- "name": "Saraswat Co-operative Bank",
980
- "code": "SRCB",
981
- "bank_name": "Saraswat Co-operative Bank",
982
- "bank_code": "SRCB",
983
- "url": "https://hdn-1.fynd.com/payment/NB_generic.png",
984
- "logo_url": {
985
- "small": "https://hdn-1.fynd.com/payment/NB_generic.png",
986
- "large": "https://hdn-1.fynd.com/payment/NB_generic.png"
987
- },
988
- "merchant_code": "SRCB",
989
- "display_priority": 21,
990
- "display_name": "Saraswat Co-operative Bank"
991
- },
992
- {
993
- "aggregator_name": "Razorpay",
994
- "name": "Deutsche Bank",
995
- "code": "DEUT",
996
- "bank_name": "Deutsche Bank",
997
- "bank_code": "DEUT",
998
- "url": "https://hdn-1.fynd.com/payment/NB_generic.png",
999
- "logo_url": {
1000
- "small": "https://hdn-1.fynd.com/payment/NB_generic.png",
1001
- "large": "https://hdn-1.fynd.com/payment/NB_generic.png"
1002
- },
1003
- "merchant_code": "NB_DEUT",
1004
- "display_priority": 22,
1005
- "display_name": "Deutsche Bank"
1006
- },
1007
- {
1008
- "aggregator_name": "Razorpay",
1009
- "name": "Dhanlaxmi Bank",
1010
- "code": "DLXB",
1011
- "bank_name": "Dhanlaxmi Bank",
1012
- "bank_code": "DLXB",
1013
- "url": "https://hdn-1.fynd.com/payment/NB_generic.png",
1014
- "logo_url": {
1015
- "small": "https://hdn-1.fynd.com/payment/NB_generic.png",
1016
- "large": "https://hdn-1.fynd.com/payment/NB_generic.png"
1017
- },
1018
- "merchant_code": "DLXB",
1019
- "display_priority": 24,
1020
- "display_name": "Dhanlaxmi Bank"
1021
- },
1022
- {
1023
- "aggregator_name": "Razorpay",
1024
- "name": "Oriental Bank of Commerce",
1025
- "code": "ORBC",
1026
- "bank_name": "Oriental Bank of Commerce",
1027
- "bank_code": "ORBC",
1028
- "url": "https://hdn-1.fynd.com/payment/NB_generic.png",
1029
- "logo_url": {
1030
- "small": "https://hdn-1.fynd.com/payment/NB_generic.png",
1031
- "large": "https://hdn-1.fynd.com/payment/NB_generic.png"
1032
- },
1033
- "merchant_code": "ORBC",
1034
- "display_priority": 25,
1035
- "display_name": "Oriental Bank of Commerce"
1036
- },
1037
- {
1038
- "aggregator_name": "Razorpay",
1039
- "name": "Punjab National Bank - Retail Banking",
1040
- "code": "PUNB_R",
1041
- "bank_name": "Punjab National Bank - Retail Banking",
1042
- "bank_code": "PUNB_R",
1043
- "url": "https://hdn-1.fynd.com/payment/NB_generic.png",
1044
- "logo_url": {
1045
- "small": "https://hdn-1.fynd.com/payment/NB_generic.png",
1046
- "large": "https://hdn-1.fynd.com/payment/NB_generic.png"
1047
- },
1048
- "merchant_code": "PUNB_R",
1049
- "display_priority": 26,
1050
- "display_name": "Punjab National Bank - Retail Banking"
1051
- },
1052
- {
1053
- "aggregator_name": "Razorpay",
1054
- "name": "State Bank of Bikaner and Jaipur",
1055
- "code": "SBBJ",
1056
- "bank_name": "State Bank of Bikaner and Jaipur",
1057
- "bank_code": "SBBJ",
1058
- "url": "https://hdn-1.fynd.com/payment/NB_generic.png",
1059
- "logo_url": {
1060
- "small": "https://hdn-1.fynd.com/payment/NB_generic.png",
1061
- "large": "https://hdn-1.fynd.com/payment/NB_generic.png"
1062
- },
1063
- "merchant_code": "NB_SBBJ",
1064
- "display_priority": 27,
1065
- "display_name": "State Bank of Bikaner and Jaipur"
1066
- },
1067
- {
1068
- "aggregator_name": "Razorpay",
1069
- "name": "Indian Overseas Bank",
1070
- "code": "IOBA",
1071
- "bank_name": "Indian Overseas Bank",
1072
- "bank_code": "IOBA",
1073
- "url": "https://hdn-1.fynd.com/payment/NB_generic.png",
1074
- "logo_url": {
1075
- "small": "https://hdn-1.fynd.com/payment/NB_generic.png",
1076
- "large": "https://hdn-1.fynd.com/payment/NB_generic.png"
1077
- },
1078
- "merchant_code": "NB_IOB",
1079
- "display_priority": 28,
1080
- "display_name": "Indian Overseas Bank"
1081
- },
1082
- {
1083
- "aggregator_name": "Razorpay",
1084
- "name": "State Bank of Travancore",
1085
- "code": "SBTR",
1086
- "bank_name": "State Bank of Travancore",
1087
- "bank_code": "SBTR",
1088
- "url": "https://hdn-1.fynd.com/payment/NB_generic.png",
1089
- "logo_url": {
1090
- "small": "https://hdn-1.fynd.com/payment/NB_generic.png",
1091
- "large": "https://hdn-1.fynd.com/payment/NB_generic.png"
1092
- },
1093
- "merchant_code": "NB_SBT",
1094
- "display_priority": 29,
1095
- "display_name": "State Bank of Travancore"
1096
- },
1097
- {
1098
- "aggregator_name": "Razorpay",
1099
- "name": "Airtel Payments Bank",
1100
- "code": "AIRP",
1101
- "bank_name": "Airtel Payments Bank",
1102
- "bank_code": "AIRP",
1103
- "url": "https://hdn-1.fynd.com/payment/NB_generic.png",
1104
- "logo_url": {
1105
- "small": "https://hdn-1.fynd.com/payment/NB_generic.png",
1106
- "large": "https://hdn-1.fynd.com/payment/NB_generic.png"
1107
- },
1108
- "merchant_code": "AIRP",
1109
- "display_priority": 30,
1110
- "display_name": "Airtel Payments Bank"
1111
- },
1112
- {
1113
- "aggregator_name": "Razorpay",
1114
- "name": "Development Bank of Singapore",
1115
- "code": "DBSS",
1116
- "bank_name": "Development Bank of Singapore",
1117
- "bank_code": "DBSS",
1118
- "url": "https://hdn-1.fynd.com/payment/NB_generic.png",
1119
- "logo_url": {
1120
- "small": "https://hdn-1.fynd.com/payment/NB_generic.png",
1121
- "large": "https://hdn-1.fynd.com/payment/NB_generic.png"
1122
- },
1123
- "merchant_code": "DBSS",
1124
- "display_priority": 31,
1125
- "display_name": "Development Bank of Singapore"
1126
- },
1127
- {
1128
- "aggregator_name": "Razorpay",
1129
- "name": "Vijaya Bank",
1130
- "code": "VIJB",
1131
- "bank_name": "Vijaya Bank",
1132
- "bank_code": "VIJB",
1133
- "url": "https://hdn-1.fynd.com/payment/NB_generic.png",
1134
- "logo_url": {
1135
- "small": "https://hdn-1.fynd.com/payment/NB_generic.png",
1136
- "large": "https://hdn-1.fynd.com/payment/NB_generic.png"
1137
- },
1138
- "merchant_code": "NB_VJYB",
1139
- "display_priority": 32,
1140
- "display_name": "Vijaya Bank"
1141
- },
1142
- {
1143
- "aggregator_name": "Razorpay",
1144
- "name": "NKGSB Co-operative Bank",
1145
- "code": "NKGS",
1146
- "bank_name": "NKGSB Co-operative Bank",
1147
- "bank_code": "NKGS",
1148
- "url": "https://hdn-1.fynd.com/payment/NB_generic.png",
1149
- "logo_url": {
1150
- "small": "https://hdn-1.fynd.com/payment/NB_generic.png",
1151
- "large": "https://hdn-1.fynd.com/payment/NB_generic.png"
1152
- },
1153
- "merchant_code": "NKGS",
1154
- "display_priority": 33,
1155
- "display_name": "NKGSB Co-operative Bank"
1156
- },
1157
- {
1158
- "aggregator_name": "Razorpay",
1159
- "name": "RBL Bank",
1160
- "code": "RATN",
1161
- "bank_name": "RBL Bank",
1162
- "bank_code": "RATN",
1163
- "url": "https://hdn-1.fynd.com/payment/NB_generic.png",
1164
- "logo_url": {
1165
- "small": "https://hdn-1.fynd.com/payment/NB_generic.png",
1166
- "large": "https://hdn-1.fynd.com/payment/NB_generic.png"
1167
- },
1168
- "merchant_code": "RATN",
1169
- "display_priority": 35,
1170
- "display_name": "RBL Bank"
1171
- },
1172
- {
1173
- "aggregator_name": "Razorpay",
1174
- "name": "Bank of Baroda - Retail Banking",
1175
- "code": "BARB_R",
1176
- "bank_name": "Bank of Baroda - Retail Banking",
1177
- "bank_code": "BARB_R",
1178
- "url": "https://hdn-1.fynd.com/payment/NB_generic.png",
1179
- "logo_url": {
1180
- "small": "https://hdn-1.fynd.com/payment/NB_generic.png",
1181
- "large": "https://hdn-1.fynd.com/payment/NB_generic.png"
1182
- },
1183
- "merchant_code": "BARB_R",
1184
- "display_priority": 36,
1185
- "display_name": "Bank of Baroda - Retail Banking"
1186
- },
1187
- {
1188
- "aggregator_name": "Razorpay",
1189
- "name": "Karnataka Bank",
1190
- "code": "KARB",
1191
- "bank_name": "Karnataka Bank",
1192
- "bank_code": "KARB",
1193
- "url": "https://hdn-1.fynd.com/payment/NB_generic.png",
1194
- "logo_url": {
1195
- "small": "https://hdn-1.fynd.com/payment/NB_generic.png",
1196
- "large": "https://hdn-1.fynd.com/payment/NB_generic.png"
1197
- },
1198
- "merchant_code": "NB_KARN",
1199
- "display_priority": 37,
1200
- "display_name": "Karnataka Bank"
1201
- },
1202
- {
1203
- "aggregator_name": "Razorpay",
1204
- "name": "Tamilnadu State Apex Co-operative Bank",
1205
- "code": "TNSC",
1206
- "bank_name": "Tamilnadu State Apex Co-operative Bank",
1207
- "bank_code": "TNSC",
1208
- "url": "https://hdn-1.fynd.com/payment/NB_generic.png",
1209
- "logo_url": {
1210
- "small": "https://hdn-1.fynd.com/payment/NB_generic.png",
1211
- "large": "https://hdn-1.fynd.com/payment/NB_generic.png"
1212
- },
1213
- "merchant_code": "TNSC",
1214
- "display_priority": 38,
1215
- "display_name": "Tamilnadu State Apex Co-operative Bank"
1216
- },
1217
- {
1218
- "aggregator_name": "Razorpay",
1219
- "name": "Tamilnadu Mercantile Bank",
1220
- "code": "TMBL",
1221
- "bank_name": "Tamilnadu Mercantile Bank",
1222
- "bank_code": "TMBL",
1223
- "url": "https://hdn-1.fynd.com/payment/NB_generic.png",
1224
- "logo_url": {
1225
- "small": "https://hdn-1.fynd.com/payment/NB_generic.png",
1226
- "large": "https://hdn-1.fynd.com/payment/NB_generic.png"
1227
- },
1228
- "merchant_code": "TMBL",
1229
- "display_priority": 40,
1230
- "display_name": "Tamilnadu Mercantile Bank"
1231
- },
1232
- {
1233
- "aggregator_name": "Razorpay",
1234
- "name": "Lakshmi Vilas Bank - Retail Banking",
1235
- "code": "LAVB_R",
1236
- "bank_name": "Lakshmi Vilas Bank - Retail Banking",
1237
- "bank_code": "LAVB_R",
1238
- "url": "https://hdn-1.fynd.com/payment/NB_generic.png",
1239
- "logo_url": {
1240
- "small": "https://hdn-1.fynd.com/payment/NB_generic.png",
1241
- "large": "https://hdn-1.fynd.com/payment/NB_generic.png"
1242
- },
1243
- "merchant_code": "LAVB_R",
1244
- "display_priority": 42,
1245
- "display_name": "Lakshmi Vilas Bank - Retail Banking"
1246
- },
1247
- {
1248
- "aggregator_name": "Razorpay",
1249
- "name": "Dena Bank",
1250
- "code": "BKDN",
1251
- "bank_name": "Dena Bank",
1252
- "bank_code": "BKDN",
1253
- "url": "https://hdn-1.fynd.com/payment/NB_generic.png",
1254
- "logo_url": {
1255
- "small": "https://hdn-1.fynd.com/payment/NB_generic.png",
1256
- "large": "https://hdn-1.fynd.com/payment/NB_generic.png"
1257
- },
1258
- "merchant_code": "BKDN",
1259
- "display_priority": 43,
1260
- "display_name": "Dena Bank"
1261
- },
1262
- {
1263
- "aggregator_name": "Razorpay",
1264
- "name": "Federal Bank",
1265
- "code": "FDRL",
1266
- "bank_name": "Federal Bank",
1267
- "bank_code": "FDRL",
1268
- "url": "https://hdn-1.fynd.com/payment/NB_generic.png",
1269
- "logo_url": {
1270
- "small": "https://hdn-1.fynd.com/payment/NB_generic.png",
1271
- "large": "https://hdn-1.fynd.com/payment/NB_generic.png"
1272
- },
1273
- "merchant_code": "NB_FED",
1274
- "display_priority": 44,
1275
- "display_name": "Federal Bank"
1276
- },
1277
- {
1278
- "aggregator_name": "Razorpay",
1279
- "name": "Indian Bank",
1280
- "code": "IDIB",
1281
- "bank_name": "Indian Bank",
1282
- "bank_code": "IDIB",
1283
- "url": "https://hdn-1.fynd.com/payment/NB_generic.png",
1284
- "logo_url": {
1285
- "small": "https://hdn-1.fynd.com/payment/NB_generic.png",
1286
- "large": "https://hdn-1.fynd.com/payment/NB_generic.png"
1287
- },
1288
- "merchant_code": "NB_INDB",
1289
- "display_priority": 45,
1290
- "display_name": "Indian Bank"
1291
- },
1292
- {
1293
- "aggregator_name": "Razorpay",
1294
- "name": "South Indian Bank",
1295
- "code": "SIBL",
1296
- "bank_name": "South Indian Bank",
1297
- "bank_code": "SIBL",
1298
- "url": "https://hdn-1.fynd.com/payment/NB_generic.png",
1299
- "logo_url": {
1300
- "small": "https://hdn-1.fynd.com/payment/NB_generic.png",
1301
- "large": "https://hdn-1.fynd.com/payment/NB_generic.png"
1302
- },
1303
- "merchant_code": "NB_SOIB",
1304
- "display_priority": 46,
1305
- "display_name": "South Indian Bank"
1306
- },
1307
- {
1308
- "aggregator_name": "Razorpay",
1309
- "name": "IDBI",
1310
- "code": "IBKL",
1311
- "bank_name": "IDBI",
1312
- "bank_code": "IBKL",
1313
- "url": "https://hdn-1.fynd.com/payment/NB_generic.png",
1314
- "logo_url": {
1315
- "small": "https://hdn-1.fynd.com/payment/NB_generic.png",
1316
- "large": "https://hdn-1.fynd.com/payment/NB_generic.png"
1317
- },
1318
- "merchant_code": "IBKL",
1319
- "display_priority": 49,
1320
- "display_name": "IDBI"
1321
- },
1322
- {
1323
- "aggregator_name": "Razorpay",
1324
- "name": "Karur Vysya Bank",
1325
- "code": "KVBL",
1326
- "bank_name": "Karur Vysya Bank",
1327
- "bank_code": "KVBL",
1328
- "url": "https://hdn-1.fynd.com/payment/NB_generic.png",
1329
- "logo_url": {
1330
- "small": "https://hdn-1.fynd.com/payment/NB_generic.png",
1331
- "large": "https://hdn-1.fynd.com/payment/NB_generic.png"
1332
- },
1333
- "merchant_code": "NB_KVB",
1334
- "display_priority": 50,
1335
- "display_name": "Karur Vysya Bank"
1336
- },
1337
- {
1338
- "aggregator_name": "Razorpay",
1339
- "name": "Punjab & Sind Bank",
1340
- "code": "PSIB",
1341
- "bank_name": "Punjab & Sind Bank",
1342
- "bank_code": "PSIB",
1343
- "url": "https://hdn-1.fynd.com/payment/NB_generic.png",
1344
- "logo_url": {
1345
- "small": "https://hdn-1.fynd.com/payment/NB_generic.png",
1346
- "large": "https://hdn-1.fynd.com/payment/NB_generic.png"
1347
- },
1348
- "merchant_code": "PSIB",
1349
- "display_priority": 52,
1350
- "display_name": "Punjab & Sind Bank"
1351
- },
1352
- {
1353
- "aggregator_name": "Razorpay",
1354
- "name": "UCO Bank",
1355
- "code": "UCBA",
1356
- "bank_name": "UCO Bank",
1357
- "bank_code": "UCBA",
1358
- "url": "https://hdn-1.fynd.com/payment/NB_generic.png",
1359
- "logo_url": {
1360
- "small": "https://hdn-1.fynd.com/payment/NB_generic.png",
1361
- "large": "https://hdn-1.fynd.com/payment/NB_generic.png"
1362
- },
1363
- "merchant_code": "UCBA",
1364
- "display_priority": 53,
1365
- "display_name": "UCO Bank"
1366
- },
1367
- {
1368
- "aggregator_name": "Razorpay",
1369
- "name": "Bank of Bahrein and Kuwait",
1370
- "code": "BBKM",
1371
- "bank_name": "Bank of Bahrein and Kuwait",
1372
- "bank_code": "BBKM",
1373
- "url": "https://hdn-1.fynd.com/payment/NB_generic.png",
1374
- "logo_url": {
1375
- "small": "https://hdn-1.fynd.com/payment/NB_generic.png",
1376
- "large": "https://hdn-1.fynd.com/payment/NB_generic.png"
1377
- },
1378
- "merchant_code": "BBKM",
1379
- "display_priority": 54,
1380
- "display_name": "Bank of Bahrein and Kuwait"
1381
- },
1382
- {
1383
- "aggregator_name": "Razorpay",
1384
- "name": "Yes Bank",
1385
- "code": "YESB",
1386
- "bank_name": "Yes Bank",
1387
- "bank_code": "YESB",
1388
- "url": "https://hdn-1.fynd.com/payment/NB_generic.png",
1389
- "logo_url": {
1390
- "small": "https://hdn-1.fynd.com/payment/NB_generic.png",
1391
- "large": "https://hdn-1.fynd.com/payment/NB_generic.png"
1392
- },
1393
- "merchant_code": "NB_YESB",
1394
- "display_priority": 55,
1395
- "display_name": "Yes Bank"
1396
- },
1397
- {
1398
- "aggregator_name": "Razorpay",
1399
- "name": "Punjab & Maharashtra Co-operative Bank",
1400
- "code": "PMCB",
1401
- "bank_name": "Punjab & Maharashtra Co-operative Bank",
1402
- "bank_code": "PMCB",
1403
- "url": "https://hdn-1.fynd.com/payment/NB_generic.png",
1404
- "logo_url": {
1405
- "small": "https://hdn-1.fynd.com/payment/NB_generic.png",
1406
- "large": "https://hdn-1.fynd.com/payment/NB_generic.png"
1407
- },
1408
- "merchant_code": "PMCB",
1409
- "display_priority": 56,
1410
- "display_name": "Punjab & Maharashtra Co-operative Bank"
1411
- },
1412
- {
1413
- "aggregator_name": "Razorpay",
1414
- "name": "Bank of India",
1415
- "code": "BKID",
1416
- "bank_name": "Bank of India",
1417
- "bank_code": "BKID",
1418
- "url": "https://hdn-1.fynd.com/payment/NB_generic.png",
1419
- "logo_url": {
1420
- "small": "https://hdn-1.fynd.com/payment/NB_generic.png",
1421
- "large": "https://hdn-1.fynd.com/payment/NB_generic.png"
1422
- },
1423
- "merchant_code": "NB_BOI",
1424
- "display_priority": 57,
1425
- "display_name": "Bank of India"
1426
- },
1427
- {
1428
- "aggregator_name": "Razorpay",
1429
- "name": "Bank of Maharashtra",
1430
- "code": "MAHB",
1431
- "bank_name": "Bank of Maharashtra",
1432
- "bank_code": "MAHB",
1433
- "url": "https://hdn-1.fynd.com/payment/NB_generic.png",
1434
- "logo_url": {
1435
- "small": "https://hdn-1.fynd.com/payment/NB_generic.png",
1436
- "large": "https://hdn-1.fynd.com/payment/NB_generic.png"
1437
- },
1438
- "merchant_code": "NB_BOM",
1439
- "display_priority": 58,
1440
- "display_name": "Bank of Maharashtra"
1441
- },
1442
- {
1443
- "aggregator_name": "Razorpay",
1444
- "name": "IDFC Bank",
1445
- "code": "IDFB",
1446
- "bank_name": "IDFC Bank",
1447
- "bank_code": "IDFB",
1448
- "url": "https://hdn-1.fynd.com/payment/NB_generic.png",
1449
- "logo_url": {
1450
- "small": "https://hdn-1.fynd.com/payment/NB_generic.png",
1451
- "large": "https://hdn-1.fynd.com/payment/NB_generic.png"
1452
- },
1453
- "merchant_code": "IDFB",
1454
- "display_priority": 59,
1455
- "display_name": "IDFC Bank"
1456
- },
1457
- {
1458
- "aggregator_name": "Razorpay",
1459
- "name": "Janata Sahakari Bank (Pune)",
1460
- "code": "JSBP",
1461
- "bank_name": "Janata Sahakari Bank (Pune)",
1462
- "bank_code": "JSBP",
1463
- "url": "https://hdn-1.fynd.com/payment/NB_generic.png",
1464
- "logo_url": {
1465
- "small": "https://hdn-1.fynd.com/payment/NB_generic.png",
1466
- "large": "https://hdn-1.fynd.com/payment/NB_generic.png"
1467
- },
1468
- "merchant_code": "JSBP",
1469
- "display_priority": 60,
1470
- "display_name": "Janata Sahakari Bank (Pune)"
1471
- },
1472
- {
1473
- "aggregator_name": "Razorpay",
1474
- "name": "Shamrao Vithal Co-operative Bank",
1475
- "code": "SVCB",
1476
- "bank_name": "Shamrao Vithal Co-operative Bank",
1477
- "bank_code": "SVCB",
1478
- "url": "https://hdn-1.fynd.com/payment/NB_generic.png",
1479
- "logo_url": {
1480
- "small": "https://hdn-1.fynd.com/payment/NB_generic.png",
1481
- "large": "https://hdn-1.fynd.com/payment/NB_generic.png"
1482
- },
1483
- "merchant_code": "SVCB",
1484
- "display_priority": 61,
1485
- "display_name": "Shamrao Vithal Co-operative Bank"
1486
- },
1487
- {
1488
- "aggregator_name": "Razorpay",
1489
- "name": "Cosmos Co-operative Bank",
1490
- "code": "COSB",
1491
- "bank_name": "Cosmos Co-operative Bank",
1492
- "bank_code": "COSB",
1493
- "url": "https://hdn-1.fynd.com/payment/NB_generic.png",
1494
- "logo_url": {
1495
- "small": "https://hdn-1.fynd.com/payment/NB_generic.png",
1496
- "large": "https://hdn-1.fynd.com/payment/NB_generic.png"
1497
- },
1498
- "merchant_code": "COSB",
1499
- "display_priority": 62,
1500
- "display_name": "Cosmos Co-operative Bank"
1501
- },
1502
- {
1503
- "aggregator_name": "Razorpay",
1504
- "name": "State Bank of Mysore",
1505
- "code": "SBMY",
1506
- "bank_name": "State Bank of Mysore",
1507
- "bank_code": "SBMY",
1508
- "url": "https://hdn-1.fynd.com/payment/NB_generic.png",
1509
- "logo_url": {
1510
- "small": "https://hdn-1.fynd.com/payment/NB_generic.png",
1511
- "large": "https://hdn-1.fynd.com/payment/NB_generic.png"
1512
- },
1513
- "merchant_code": "NB_SBM",
1514
- "display_priority": 63,
1515
- "display_name": "State Bank of Mysore"
1516
- },
1517
- {
1518
- "aggregator_name": "Razorpay",
1519
- "name": "Andhra Bank",
1520
- "code": "ANDB",
1521
- "bank_name": "Andhra Bank",
1522
- "bank_code": "ANDB",
1523
- "url": "https://hdn-1.fynd.com/payment/NB_generic.png",
1524
- "logo_url": {
1525
- "small": "https://hdn-1.fynd.com/payment/NB_generic.png",
1526
- "large": "https://hdn-1.fynd.com/payment/NB_generic.png"
1527
- },
1528
- "merchant_code": "ANDB",
1529
- "display_priority": 65,
1530
- "display_name": "Andhra Bank"
1531
- },
1532
- {
1533
- "aggregator_name": "Razorpay",
1534
- "name": "Jammu and Kashmir Bank",
1535
- "code": "JAKA",
1536
- "bank_name": "Jammu and Kashmir Bank",
1537
- "bank_code": "JAKA",
1538
- "url": "https://hdn-1.fynd.com/payment/NB_generic.png",
1539
- "logo_url": {
1540
- "small": "https://hdn-1.fynd.com/payment/NB_generic.png",
1541
- "large": "https://hdn-1.fynd.com/payment/NB_generic.png"
1542
- },
1543
- "merchant_code": "NB_JNK",
1544
- "display_priority": 66,
1545
- "display_name": "Jammu and Kashmir Bank"
1546
- },
1547
- {
1548
- "aggregator_name": "Razorpay",
1549
- "name": "United Bank of India",
1550
- "code": "UTBI",
1551
- "bank_name": "United Bank of India",
1552
- "bank_code": "UTBI",
1553
- "url": "https://hdn-1.fynd.com/payment/NB_generic.png",
1554
- "logo_url": {
1555
- "small": "https://hdn-1.fynd.com/payment/NB_generic.png",
1556
- "large": "https://hdn-1.fynd.com/payment/NB_generic.png"
1557
- },
1558
- "merchant_code": "UTBI",
1559
- "display_priority": 67,
1560
- "display_name": "United Bank of India"
1561
- },
1562
- {
1563
- "aggregator_name": "Razorpay",
1564
- "name": "Lakshmi Vilas Bank - Corporate Banking",
1565
- "code": "LAVB_C",
1566
- "bank_name": "Lakshmi Vilas Bank - Corporate Banking",
1567
- "bank_code": "LAVB_C",
1568
- "url": "https://hdn-1.fynd.com/payment/NB_generic.png",
1569
- "logo_url": {
1570
- "small": "https://hdn-1.fynd.com/payment/NB_generic.png",
1571
- "large": "https://hdn-1.fynd.com/payment/NB_generic.png"
1572
- },
1573
- "merchant_code": "LAVB_C",
1574
- "display_priority": 69,
1575
- "display_name": "Lakshmi Vilas Bank - Corporate Banking"
1576
- },
1577
- {
1578
- "aggregator_name": "Razorpay",
1579
- "name": "State Bank of Patiala",
1580
- "code": "STBP",
1581
- "bank_name": "State Bank of Patiala",
1582
- "bank_code": "STBP",
1583
- "url": "https://hdn-1.fynd.com/payment/NB_generic.png",
1584
- "logo_url": {
1585
- "small": "https://hdn-1.fynd.com/payment/NB_generic.png",
1586
- "large": "https://hdn-1.fynd.com/payment/NB_generic.png"
1587
- },
1588
- "merchant_code": "NB_SBP",
1589
- "display_priority": 70,
1590
- "display_name": "State Bank of Patiala"
1591
- },
1592
- {
1593
- "aggregator_name": "Razorpay",
1594
- "name": "DCB Bank",
1595
- "code": "DCBL",
1596
- "bank_name": "DCB Bank",
1597
- "bank_code": "DCBL",
1598
- "url": "https://hdn-1.fynd.com/payment/NB_generic.png",
1599
- "logo_url": {
1600
- "small": "https://hdn-1.fynd.com/payment/NB_generic.png",
1601
- "large": "https://hdn-1.fynd.com/payment/NB_generic.png"
1602
- },
1603
- "merchant_code": "DCBL",
1604
- "display_priority": 71,
1605
- "display_name": "DCB Bank"
1606
- },
1607
- {
1608
- "aggregator_name": "Razorpay",
1609
- "name": "Union Bank of India",
1610
- "code": "UBIN",
1611
- "bank_name": "Union Bank of India",
1612
- "bank_code": "UBIN",
1613
- "url": "https://hdn-1.fynd.com/payment/NB_generic.png",
1614
- "logo_url": {
1615
- "small": "https://hdn-1.fynd.com/payment/NB_generic.png",
1616
- "large": "https://hdn-1.fynd.com/payment/NB_generic.png"
1617
- },
1618
- "merchant_code": "NB_UBI",
1619
- "display_priority": 73,
1620
- "display_name": "Union Bank of India"
1621
- },
1622
- {
1623
- "aggregator_name": "Razorpay",
1624
- "name": "Standard Chartered Bank",
1625
- "code": "SCBL",
1626
- "bank_name": "Standard Chartered Bank",
1627
- "bank_code": "SCBL",
1628
- "url": "https://hdn-1.fynd.com/payment/NB_generic.png",
1629
- "logo_url": {
1630
- "small": "https://hdn-1.fynd.com/payment/NB_generic.png",
1631
- "large": "https://hdn-1.fynd.com/payment/NB_generic.png"
1632
- },
1633
- "merchant_code": "SCBL",
1634
- "display_priority": 74,
1635
- "display_name": "Standard Chartered Bank"
1636
- }
1637
- ]
1638
- },
1639
- {
1640
- "name": "WL",
1641
- "display_priority": 4,
1642
- "payment_mode_id": 4,
1643
- "display_name": "Wallet",
1644
- "list": [
1645
- {
1646
- "wallet_name": "Paytm",
1647
- "wallet_code": "paytm",
1648
- "name": "Paytm",
1649
- "display_name": "Paytm",
1650
- "code": "PAYTM",
1651
- "wallet_id": 4,
1652
- "merchant_code": "PAYTM",
1653
- "logo_url": {
1654
- "small": "https://hdn-1.fynd.com/payment/paytm_logo_small.png",
1655
- "large": "https://hdn-1.fynd.com/payment/paytm_logo_large.png"
1656
- },
1657
- "aggregator_name": "Juspay",
1658
- "display_priority": 1
1659
- },
1660
- {
1661
- "wallet_name": "Mobikwik",
1662
- "wallet_code": "mobikwik",
1663
- "name": "Mobikwik",
1664
- "display_name": "Mobikwik",
1665
- "code": "MOBIKWIK",
1666
- "wallet_id": 5,
1667
- "merchant_code": "MOBIKWIK",
1668
- "logo_url": {
1669
- "small": "https://hdn-1.fynd.com/payment/mobikwik_logo_small.png",
1670
- "large": "https://hdn-1.fynd.com/payment/mobikwik_logo_small.png"
1671
- },
1672
- "aggregator_name": "Juspay",
1673
- "display_priority": 3
1674
- },
1675
- {
1676
- "wallet_name": "Ola Money",
1677
- "wallet_code": "olamoney",
1678
- "name": "Ola Money",
1679
- "display_name": "Ola Money",
1680
- "code": "OLAMONEY",
1681
- "wallet_id": 6,
1682
- "merchant_code": "OLAMONEY",
1683
- "logo_url": {
1684
- "small": "https://hdn-1.fynd.com/payment/olamoney.png",
1685
- "large": "https://hdn-1.fynd.com/payment/olamoney.png"
1686
- },
1687
- "aggregator_name": "Razorpay",
1688
- "display_priority": 4
1689
- },
1690
- {
1691
- "wallet_name": "Amazon Pay",
1692
- "wallet_code": "amazonpay",
1693
- "name": "Amazon Pay",
1694
- "display_name": "Amazon Pay",
1695
- "code": "AMAZONPAY",
1696
- "wallet_id": 10,
1697
- "merchant_code": "AMAZONPAY",
1698
- "logo_url": {
1699
- "small": "https://hdn-1.fynd.com/payment/amazon-pay.png",
1700
- "large": "https://hdn-1.fynd.com/payment/amazon-pay.png"
1701
- },
1702
- "aggregator_name": "Razorpay",
1703
- "display_priority": 9
1704
- },
1705
- {
1706
- "wallet_name": "PayPal",
1707
- "wallet_code": "paypal",
1708
- "name": "PayPal",
1709
- "display_name": "PayPal",
1710
- "code": "PAYPAL",
1711
- "wallet_id": 11,
1712
- "merchant_code": "PAYPAL",
1713
- "logo_url": {
1714
- "small": "https://hdn-1.fynd.com/payment/paypal.jpg",
1715
- "large": "https://hdn-1.fynd.com/payment/paypal.jpg "
1716
- },
1717
- "aggregator_name": "Razorpay",
1718
- "display_priority": 10
1719
- }
1720
- ]
1721
- },
1722
- {
1723
- "name": "UPI",
1724
- "display_priority": 9,
1725
- "payment_mode_id": 7,
1726
- "display_name": "UPI",
1727
- "list": [
1728
- {
1729
- "aggregator_name": "Razorpay",
1730
- "name": "UPI",
1731
- "display_name": "BHIM UPI",
1732
- "code": "UPI",
1733
- "logo_url": {
1734
- "large": "https://hdn-1.fynd.com/payment/upi_150x100.png",
1735
- "small": "https://hdn-1.fynd.com/payment/upi_100x78.png"
1736
- },
1737
- "merchant_code": "UPI",
1738
- "timeout": 240,
1739
- "retry_count": 0,
1740
- "fynd_vpa": "shopsense.rzp@hdfcbank",
1741
- "intent_flow": true,
1742
- "intent_app": [
1743
- {
1744
- "code": "google_pay",
1745
- "display_name": "Google Pay",
1746
- "package_name": "com.google.android.apps.nbu.paisa.user",
1747
- "logos": {
1748
- "small": "https://hdn-1.fynd.com/payment/upi-google-pay.png",
1749
- "large": "https://hdn-1.fynd.com/payment/upi-google-pay.png"
1750
- }
1751
- }
1752
- ],
1753
- "intent_app_error_list": [
1754
- "com.csam.icici.bank.imobile",
1755
- "in.org.npci.upiapp",
1756
- "com.whatsapp"
1757
- ],
1758
- "intent_app_error_dict_list": [
1759
- {
1760
- "package_name": "com.csam.icici.bank.imobile",
1761
- "code": "icici"
1762
- },
1763
- {
1764
- "package_name": "in.org.npci.upiapp",
1765
- "code": "upiapp"
1766
- },
1767
- {
1768
- "package_name": "com.whatsapp",
1769
- "code": "whatsapp"
1770
- }
1771
- ]
1772
- }
1773
- ]
1774
- },
1775
- {
1776
- "name": "EMI",
1777
- "display_priority": 18,
1778
- "payment_mode_id": 19,
1779
- "display_name": "Easy EMI",
1780
- "list": [
1781
- {
1782
- "aggregator_name": "Razorpay",
1783
- "name": "EMI",
1784
- "display_name": "Easy EMI",
1785
- "code": "EMI",
1786
- "logo_url": {
1787
- "large": "https://hdn-1.fynd.com/payment/Pos+Logo.png",
1788
- "small": "https://hdn-1.fynd.com/payment/Pos+Logo.png"
1789
- },
1790
- "merchant_code": "EMI"
1791
- }
1792
- ]
1793
- },
1794
- {
1795
- "name": "JUSPAYPG",
1796
- "display_priority": 18,
1797
- "payment_mode_id": 23,
1798
- "display_name": "Pay Using Juspay",
1799
- "list": [
1800
- {
1801
- "aggregator_name": "Juspay",
1802
- "name": "JUSPAYPG",
1803
- "display_name": "Pay Using Juspay",
1804
- "code": "JUSPAYPG",
1805
- "logo_url": {
1806
- "large": "https://hdn-1.fynd.com/payment/netbanking.png",
1807
- "small": "https://hdn-1.fynd.com/payment/netbanking.png"
1808
- },
1809
- "merchant_code": "JUSPAYPG"
1810
- }
1811
- ]
1812
- },
1813
- {
1814
- "name": "PG_PAYMENT",
1815
- "display_priority": 20,
1816
- "display_name": "Other payment gateway",
1817
- "list": [
1818
- {
1819
- "aggregator_name": "Stripe",
1820
- "name": "STRIPEPG",
1821
- "display_name": "Pay using Stripe",
1822
- "code": "STRIPEPG",
1823
- "logo_url": {
1824
- "large": "https://hdn-1.fynd.com/payment/Pos+Logo.png",
1825
- "small": "https://hdn-1.fynd.com/payment/Pos+Logo.png"
1826
- },
1827
- "merchant_code": "STRIPEPG"
1828
- },
1829
- {
1830
- "aggregator_name": "Ccavenue",
1831
- "name": "CCAVENUEPG",
1832
- "display_name": "Pay using Ccavenue",
1833
- "code": "CCAVENUEPG",
1834
- "logo_url": {
1835
- "large": "https://hdn-1.fynd.com/payment/Pos+Logo.png",
1836
- "small": "https://hdn-1.fynd.com/payment/Pos+Logo.png"
1837
- },
1838
- "merchant_code": "CCAVENUEPG"
1839
- },
1840
- {
1841
- "aggregator_name": "Payumoney",
1842
- "name": "PAYUMONEYPG",
1843
- "display_name": "Pay using Payumoney",
1844
- "code": "PAYUMONEYPG",
1845
- "logo_url": {
1846
- "large": "https://fynd-obscuro-media-new.s3.amazonaws.com/payment/payu_logo_large.png",
1847
- "small": "https://fynd-obscuro-media-new.s3.amazonaws.com/payment/payu_logo_small.png"
1848
- },
1849
- "merchant_code": "PAYUMONEYPG"
1850
- },
1851
- {
1852
- "aggregator_name": "Payubiz",
1853
- "name": "PAYUBIZPG",
1854
- "display_name": "Pay using Payubiz",
1855
- "code": "PAYUBIZPG",
1856
- "logo_url": {
1857
- "large": "https://hdn-1.fynd.com/payment/payu.png",
1858
- "small": "https://hdn-1.fynd.com/payment/payu.png"
1859
- },
1860
- "merchant_code": "PAYUBIZPG"
1861
- }
1862
- ]
1863
- },
1864
- {
1865
- "name": "PL",
1866
- "display_priority": 21,
1867
- "display_name": "Pay Later",
1868
- "list": [
1869
- {
1870
- "aggregator_name": "Simpl",
1871
- "name": "Simpl",
1872
- "display_name": "Simpl",
1873
- "code": "SIMPL",
1874
- "merchant_code": "SIMPL",
1875
- "logo": "https://hdn-1.fynd.com/payment/simpl_logo.png",
1876
- "logo_url": {
1877
- "small": "https://hdn-1.fynd.com/payment/simpl_logo.png",
1878
- "large": "https://hdn-1.fynd.com/payment/simpl_logo.png"
1879
- }
1880
- },
1881
- {
1882
- "aggregator_name": "Rupifi",
1883
- "name": "RUPIFIPG",
1884
- "display_name": "Pay using Rupifi",
1885
- "code": "RUPIFIPG",
1886
- "logo_url": {
1887
- "large": "https://hdn-1.fynd.com/payment/Rupifi.png",
1888
- "small": "https://hdn-1.fynd.com/payment/Rupifi.png"
1889
- },
1890
- "merchant_code": "RUPIFIPG"
1891
- }
1892
- ]
1893
- }
1894
- ]
1895
- }
1896
- }
1897
- ```
1898
- </details>
1899
-
1900
-
1901
-
1902
-
1903
-
1904
-
1905
-
1906
-
1907
-
1908
- ---
1909
-
1910
-
1911
- ### getSubscriptionConfig
1912
- List Subscription Config
1913
-
1914
-
1915
-
1916
- ```javascript
1917
- // Promise
1918
- const promise = client.payment.getSubscriptionConfig();
1919
-
1920
- // Async/Await
1921
- const data = await client.payment.getSubscriptionConfig();
1922
- ```
1923
-
1924
-
1925
-
1926
-
1927
-
1928
-
1929
- Get all Subscription Config details
1930
-
1931
- *Returned Response:*
1932
-
1933
-
1934
-
1935
-
1936
- [SubscriptionConfigResponse](#SubscriptionConfigResponse)
1937
-
1938
- List Subscription Config Response
1939
-
1940
-
1941
-
1942
-
1943
- <details>
1944
- <summary><i>&nbsp; Example:</i></summary>
1945
-
1946
- ```json
1947
- {
1948
- "success": true,
1949
- "aggregator": "stripe",
1950
- "config": {
1951
- "public_key": "pk_test_lHBf12TZLa5"
1952
- }
1953
- }
1954
- ```
1955
- </details>
1956
-
1957
-
1958
-
1959
-
1960
-
1961
-
1962
-
1963
-
1964
-
1965
- ---
1966
-
1967
-
1968
- ### getSubscriptionPaymentMethod
1969
- List Subscription Payment Method
1970
-
1971
-
1972
-
1973
- ```javascript
1974
- // Promise
1975
- const promise = client.payment.getSubscriptionPaymentMethod({ uniqueExternalId : value });
1976
-
1977
- // Async/Await
1978
- const data = await client.payment.getSubscriptionPaymentMethod({ uniqueExternalId : value });
1979
- ```
1980
-
1981
-
1982
-
1983
-
1984
-
1985
- | Argument | Type | Required | Description |
1986
- | --------- | ----- | -------- | ----------- |
1987
- | uniqueExternalId | string | no | Unique external id |
1988
-
1989
-
1990
-
1991
- Get all Subscription Payment Method
1992
-
1993
- *Returned Response:*
1994
-
1995
-
1996
-
1997
-
1998
- [SubscriptionPaymentMethodResponse](#SubscriptionPaymentMethodResponse)
1999
-
2000
- List Subscription Payment Method Response
2001
-
2002
-
2003
-
2004
-
2005
- <details>
2006
- <summary><i>&nbsp; Example:</i></summary>
2007
-
2008
- ```json
2009
- {
2010
- "success": true,
2011
- "data": [
2012
- {
2013
- "id": 68,
2014
- "type": "card",
2015
- "pg_payment_method_id": "pm_1H8HyIJ1ZTFIN1aD5eDOL4nU",
2016
- "data": {
2017
- "brand": "visa",
2018
- "last4": "4242",
2019
- "checks": {
2020
- "cvc_check": "pass",
2021
- "address_line1_check": null,
2022
- "address_postal_code_check": null
2023
- },
2024
- "wallet": null,
2025
- "country": "US",
2026
- "funding": "credit",
2027
- "exp_year": 2044,
2028
- "networks": {
2029
- "available": [
2030
- "visa"
2031
- ],
2032
- "preferred": null
2033
- },
2034
- "exp_month": 12,
2035
- "fingerprint": "0aror24meTf8iYfw",
2036
- "generated_from": null,
2037
- "three_d_secure_usage": {
2038
- "supported": true
2039
- }
2040
- },
2041
- "is_default": false
2042
- },
2043
- {
2044
- "id": 81,
2045
- "type": "card",
2046
- "pg_payment_method_id": "pm_1Hc7tMJ1ZTFIN1aDCvMIIBeT",
2047
- "data": {
2048
- "brand": "visa",
2049
- "last4": "4242",
2050
- "checks": {
2051
- "cvc_check": "pass",
2052
- "address_line1_check": null,
2053
- "address_postal_code_check": null
2054
- },
2055
- "wallet": null,
2056
- "country": "US",
2057
- "funding": "credit",
2058
- "exp_year": 2020,
2059
- "networks": {
2060
- "available": [
2061
- "visa"
2062
- ],
2063
- "preferred": null
2064
- },
2065
- "exp_month": 11,
2066
- "fingerprint": "0aror24meTf8iYfw",
2067
- "generated_from": null,
2068
- "three_d_secure_usage": {
2069
- "supported": true
2070
- }
2071
- },
2072
- "is_default": true
2073
- },
2074
- {
2075
- "id": 93,
2076
- "type": "card",
2077
- "pg_payment_method_id": "pm_1HvddjJ1ZTFIN1aDgebQvuyi",
2078
- "data": {
2079
- "brand": "visa",
2080
- "last4": "4242",
2081
- "checks": {
2082
- "cvc_check": "pass",
2083
- "address_line1_check": "pass",
2084
- "address_postal_code_check": "pass"
2085
- },
2086
- "wallet": null,
2087
- "country": "US",
2088
- "funding": "credit",
2089
- "exp_year": 2022,
2090
- "networks": {
2091
- "available": [
2092
- "visa"
2093
- ],
2094
- "preferred": null
2095
- },
2096
- "exp_month": 11,
2097
- "fingerprint": "0aror24meTf8iYfw",
2098
- "generated_from": null,
2099
- "three_d_secure_usage": {
2100
- "supported": true
2101
- }
2102
- },
2103
- "is_default": false
2104
- },
2105
- {
2106
- "id": 98,
2107
- "type": "card",
2108
- "pg_payment_method_id": "pm_1IJDF0J1ZTFIN1aDnJFi4i2v",
2109
- "data": {
2110
- "brand": "visa",
2111
- "last4": "1111",
2112
- "checks": {
2113
- "cvc_check": "pass",
2114
- "address_line1_check": "pass",
2115
- "address_postal_code_check": "pass"
2116
- },
2117
- "wallet": null,
2118
- "country": "US",
2119
- "funding": "credit",
2120
- "exp_year": 2025,
2121
- "networks": {
2122
- "available": [
2123
- "visa"
2124
- ],
2125
- "preferred": null
2126
- },
2127
- "exp_month": 11,
2128
- "fingerprint": "ZtDTGycouUEup4Q4",
2129
- "generated_from": null,
2130
- "three_d_secure_usage": {
2131
- "supported": true
2132
- }
2133
- },
2134
- "is_default": false
2135
- }
2136
- ]
2137
- }
2138
- ```
2139
- </details>
2140
-
2141
-
2142
-
2143
-
2144
-
2145
-
2146
-
2147
-
2148
-
2149
- ---
2150
-
2151
-
2152
- ### getUserBeneficiaries
2153
- List User Beneficiary
2154
-
2155
-
2156
-
2157
- ```javascript
2158
- // Promise
2159
- const promise = client.application("<APPLICATION_ID>").payment.getUserBeneficiaries({ orderId : value });
2160
-
2161
- // Async/Await
2162
- const data = await client.application("<APPLICATION_ID>").payment.getUserBeneficiaries({ orderId : value });
2163
- ```
2164
-
2165
-
2166
-
2167
-
2168
-
2169
- | Argument | Type | Required | Description |
2170
- | --------- | ----- | -------- | ----------- |
2171
- | orderId | string | yes | |
2172
-
2173
-
2174
-
2175
- Get all active beneficiary details added by the user for refund
2176
-
2177
- *Returned Response:*
2178
-
2179
-
2180
-
2181
-
2182
- [OrderBeneficiaryResponse](#OrderBeneficiaryResponse)
2183
-
2184
- List User Beneficiary
2185
-
2186
-
2187
-
2188
-
2189
- <details>
2190
- <summary><i>&nbsp; Example:</i></summary>
2191
-
2192
- ```json
2193
- {
2194
- "beneficiaries": [
2195
- {
2196
- "id": 221,
2197
- "beneficiary_id": "0f7e44a922df352c05c5f73cb40ba115",
2198
- "bank_name": "State Bank of India",
2199
- "branch_name": "State Bank of India",
2200
- "account_holder": "SHASHI TEST",
2201
- "account_no": "1234567891",
2202
- "ifsc_code": "SBIN0005611",
2203
- "mobile": "9112042174",
2204
- "email": "payment@gofynd.com",
2205
- "address": "204A",
2206
- "comment": "",
2207
- "is_active": null,
2208
- "created_on": "2020-06-29 12:38:39",
2209
- "modified_on": "2020-06-29 12:38:39",
2210
- "display_name": "BANK",
2211
- "transfer_mode": "bank",
2212
- "title": "Bank Account",
2213
- "subtitle": "1234567891",
2214
- "delights_user_name": null
2215
- }
2216
- ],
2217
- "show_beneficiary_details": false
2218
- }
2219
- ```
2220
- </details>
2221
-
2222
-
2223
-
2224
-
2225
-
2226
-
2227
-
2228
-
2229
-
2230
- ---
2231
-
2232
-
2233
- ### getUserCODlimitRoutes
2234
- Get COD limit for user
2235
-
2236
-
2237
-
2238
- ```javascript
2239
- // Promise
2240
- const promise = client.application("<APPLICATION_ID>").payment.getUserCODlimitRoutes({ merchantUserId : value,
2241
- mobileNo : value });
2242
-
2243
- // Async/Await
2244
- const data = await client.application("<APPLICATION_ID>").payment.getUserCODlimitRoutes({ merchantUserId : value,
2245
- mobileNo : value });
2246
- ```
2247
-
2248
-
2249
-
2250
-
2251
-
2252
- | Argument | Type | Required | Description |
2253
- | --------- | ----- | -------- | ----------- |
2254
- | merchantUserId | string | yes | |
2255
- | mobileNo | string | yes | |
2256
-
2257
-
2258
-
2259
- Use this API to get user cod limit and reamining limit for the payment
2260
-
2261
- *Returned Response:*
2262
-
2263
-
2264
-
2265
-
2266
- [GetUserCODLimitResponse](#GetUserCODLimitResponse)
2267
-
2268
- Success. Returns user cod limit , remaining limit and usage of user for COD. Check the example shown below or refer `GetUserCODLimitResponseSchema` for more details.
2269
-
2270
-
2271
-
2272
-
2273
- <details>
2274
- <summary><i>&nbsp; Example:</i></summary>
2275
-
2276
- ```json
2277
- {
2278
- "success": true,
2279
- "user_cod_data": {
2280
- "is_active": true,
2281
- "user_id": 5,
2282
- "usages": 1000,
2283
- "limit": 10000,
2284
- "remaining_limit": 9000,
2285
- "merchant_user_id": "5e199e6998cfe1776f1385dc"
2286
- }
2287
- }
2288
- ```
2289
- </details>
2290
-
2291
-
2292
-
2293
-
2294
-
2295
-
2296
-
2297
-
2298
-
2299
- ---
2300
-
2301
-
2302
- ### getUserOrderBeneficiaries
2303
- List Order Beneficiary
2304
-
2305
-
2306
-
2307
- ```javascript
2308
- // Promise
2309
- const promise = client.application("<APPLICATION_ID>").payment.getUserOrderBeneficiaries({ orderId : value });
2310
-
2311
- // Async/Await
2312
- const data = await client.application("<APPLICATION_ID>").payment.getUserOrderBeneficiaries({ orderId : value });
2313
- ```
2314
-
2315
-
2316
-
2317
-
2318
-
2319
- | Argument | Type | Required | Description |
2320
- | --------- | ----- | -------- | ----------- |
2321
- | orderId | string | yes | |
2322
-
2323
-
2324
-
2325
- Get all active beneficiary details added by the user for refund
2326
-
2327
- *Returned Response:*
2328
-
2329
-
2330
-
2331
-
2332
- [OrderBeneficiaryResponse](#OrderBeneficiaryResponse)
2333
-
2334
- List Order Beneficiary
2335
-
2336
-
2337
-
2338
-
2339
- <details>
2340
- <summary><i>&nbsp; Example:</i></summary>
2341
-
2342
- ```json
2343
- {
2344
- "beneficiaries": [
2345
- {
2346
- "id": 3695,
2347
- "beneficiary_id": "4c86dd56e634a4c6a8fb51d195bc7b83",
2348
- "bank_name": "State Bank of India",
2349
- "branch_name": "BHOGAT",
2350
- "account_holder": "PRAKASH TEST",
2351
- "account_no": "3566342455454",
2352
- "ifsc_code": "SBIN0014982",
2353
- "mobile": "7819064010",
2354
- "email": "prakashtest@gmail.com",
2355
- "address": "49A, Dabhi seri, jodhpur, kalyanpur",
2356
- "comment": "COD Refund",
2357
- "is_active": null,
2358
- "created_on": "2021-01-22 11:31:02",
2359
- "modified_on": "2021-01-22 11:31:02",
2360
- "display_name": "BANK",
2361
- "transfer_mode": "bank",
2362
- "title": "Bank Account",
2363
- "subtitle": "35663423659",
2364
- "delights_user_name": "shreeniwas_24x7_gmail_com_45978_16624463"
2365
- }
2366
- ]
2367
- }
2368
- ```
2369
- </details>
2370
-
2371
-
2372
-
2373
-
2374
-
2375
-
2376
-
2377
-
2378
-
2379
- ---
2380
-
2381
-
2382
- ### saveBrandPaymentGatewayConfig
2383
- Save Config Secret For Brand Payment Gateway
2384
-
2385
-
2386
-
2387
- ```javascript
2388
- // Promise
2389
- const promise = client.application("<APPLICATION_ID>").payment.saveBrandPaymentGatewayConfig({ body : value });
2390
-
2391
- // Async/Await
2392
- const data = await client.application("<APPLICATION_ID>").payment.saveBrandPaymentGatewayConfig({ body : value });
2393
- ```
2394
-
2395
-
2396
-
2397
-
2398
-
2399
- | Argument | Type | Required | Description |
2400
- | --------- | ----- | -------- | ----------- |
2401
- | body | [PaymentGatewayConfigRequest](#PaymentGatewayConfigRequest) | yes | Request body |
2402
-
2403
-
2404
- Save Config Secret For Brand Payment Gateway
2405
-
2406
- *Returned Response:*
2407
-
2408
-
2409
-
2410
-
2411
- [PaymentGatewayToBeReviewed](#PaymentGatewayToBeReviewed)
2412
-
2413
- Save Config Secret For Brand Payment Gateway Success Response.
2414
-
2415
-
2416
-
2417
-
2418
- <details>
2419
- <summary><i>&nbsp; Example:</i></summary>
2420
-
2421
- ```json
2422
- {
2423
- "success": true,
2424
- "aggregators": [
2425
- "razorpay"
2426
- ]
2427
- }
2428
- ```
2429
- </details>
2430
-
2431
-
2432
-
2433
-
2434
-
2435
-
2436
-
2437
-
2438
-
2439
- ---
2440
-
2441
-
2442
- ### savePayout
2443
- Save Payout
2444
-
2445
-
2446
-
2447
- ```javascript
2448
- // Promise
2449
- const promise = client.payment.savePayout({ body : value });
2450
-
2451
- // Async/Await
2452
- const data = await client.payment.savePayout({ body : value });
2453
- ```
2454
-
2455
-
2456
-
2457
-
2458
-
2459
- | Argument | Type | Required | Description |
2460
- | --------- | ----- | -------- | ----------- |
2461
- | body | [PayoutRequest](#PayoutRequest) | yes | Request body |
2462
-
2463
-
2464
- Save Payout
2465
-
2466
- *Returned Response:*
2467
-
2468
-
2469
-
2470
-
2471
- [PayoutResponse](#PayoutResponse)
2472
-
2473
- save payout response object
2474
-
2475
-
2476
-
2477
-
2478
- <details>
2479
- <summary><i>&nbsp; Example:</i></summary>
2480
-
2481
- ```json
2482
- {
2483
- "success": true,
2484
- "is_active": true,
2485
- "bank_details": {
2486
- "account_type": "saving",
2487
- "account_holder": "Vikas Kumar",
2488
- "branch_name": "Mumbai",
2489
- "country": "",
2490
- "ifsc_code": "SBIN0011513",
2491
- "account_no": "9876543210",
2492
- "city": "",
2493
- "state": "",
2494
- "bank_name": "SBI"
2495
- },
2496
- "unique_transfer_no": "e388c1c5df4933fa01f6da9f92595589",
2497
- "users": {
2498
- "name": "reliance retail",
2499
- "unique_external_id": "company:1",
2500
- "mobile": "1234567890",
2501
- "email": "reliance@gmail.com"
2502
- },
2503
- "aggregator": "Razorpay",
2504
- "transfer_type": "bank",
2505
- "created": true,
2506
- "payouts": {
2507
- "aggregator_fund_id": null
2508
- },
2509
- "payment_status": "payout_initiated"
2510
- }
2511
- ```
2512
- </details>
2513
-
2514
-
2515
-
2516
-
2517
-
2518
-
2519
-
2520
-
2521
-
2522
- ---
2523
-
2524
-
2525
- ### saveSubscriptionSetupIntent
2526
- Save Subscription Setup Intent
2527
-
2528
-
2529
-
2530
- ```javascript
2531
- // Promise
2532
- const promise = client.payment.saveSubscriptionSetupIntent({ body : value });
2533
-
2534
- // Async/Await
2535
- const data = await client.payment.saveSubscriptionSetupIntent({ body : value });
2536
- ```
2537
-
2538
-
2539
-
2540
-
2541
-
2542
- | Argument | Type | Required | Description |
2543
- | --------- | ----- | -------- | ----------- |
2544
- | body | [SaveSubscriptionSetupIntentRequest](#SaveSubscriptionSetupIntentRequest) | yes | Request body |
2545
-
2546
-
2547
- Uses this api to Save Subscription Setup Intent
2548
-
2549
- *Returned Response:*
2550
-
2551
-
2552
-
2553
-
2554
- [SaveSubscriptionSetupIntentResponse](#SaveSubscriptionSetupIntentResponse)
2555
-
2556
- Save Subscription Setup Intent Response.
2557
-
2558
-
2559
-
2560
-
2561
- <details>
2562
- <summary><i>&nbsp; Example:</i></summary>
2563
-
2564
- ```json
2565
- {
2566
- "success": true,
2567
- "data": {
2568
- "id": "test",
2569
- "object": "test",
2570
- "client_secret": "test",
2571
- "customer": "test",
2572
- "status": "requires_payment_method"
2573
- }
2574
- }
2575
- ```
2576
- </details>
2577
-
2578
-
2579
-
2580
-
2581
-
2582
-
2583
-
2584
-
2585
-
2586
- ---
2587
-
2588
-
2589
- ### setUserCODlimitRoutes
2590
- Set COD option for user for payment
2591
-
2592
-
2593
-
2594
- ```javascript
2595
- // Promise
2596
- const promise = client.application("<APPLICATION_ID>").payment.setUserCODlimitRoutes({ body : value });
2597
-
2598
- // Async/Await
2599
- const data = await client.application("<APPLICATION_ID>").payment.setUserCODlimitRoutes({ body : value });
2600
- ```
2601
-
2602
-
2603
-
2604
-
2605
-
2606
- | Argument | Type | Required | Description |
2607
- | --------- | ----- | -------- | ----------- |
2608
- | body | [SetCODForUserRequest](#SetCODForUserRequest) | yes | Request body |
2609
-
2610
-
2611
- Use this API to set cod option as true or false for the payment
2612
-
2613
- *Returned Response:*
2614
-
2615
-
2616
-
2617
-
2618
- [SetCODOptionResponse](#SetCODOptionResponse)
2619
-
2620
- Success. Returns true/false for user cod option for payment. Check the example shown below or refer `GetUserCODLimitResponseSchema` for more details.
2621
-
2622
-
2623
-
2624
-
2625
- <details>
2626
- <summary><i>&nbsp; Example:</i></summary>
2627
-
2628
- ```json
2629
- {
2630
- "success": true,
2631
- "message": "COD option for user {} is set to {}"
2632
- }
2633
- ```
2634
- </details>
2635
-
2636
-
2637
-
2638
-
2639
-
2640
-
2641
-
2642
-
2643
-
2644
- ---
2645
-
2646
-
2647
- ### updateBrandPaymentGatewayConfig
2648
- Save Config Secret For Brand Payment Gateway
2649
-
2650
-
2651
-
2652
- ```javascript
2653
- // Promise
2654
- const promise = client.application("<APPLICATION_ID>").payment.updateBrandPaymentGatewayConfig({ body : value });
2655
-
2656
- // Async/Await
2657
- const data = await client.application("<APPLICATION_ID>").payment.updateBrandPaymentGatewayConfig({ body : value });
2658
- ```
2659
-
2660
-
2661
-
2662
-
2663
-
2664
- | Argument | Type | Required | Description |
2665
- | --------- | ----- | -------- | ----------- |
2666
- | body | [PaymentGatewayConfigRequest](#PaymentGatewayConfigRequest) | yes | Request body |
2667
-
2668
-
2669
- Save Config Secret For Brand Payment Gateway
2670
-
2671
- *Returned Response:*
2672
-
2673
-
2674
-
2675
-
2676
- [PaymentGatewayToBeReviewed](#PaymentGatewayToBeReviewed)
2677
-
2678
- Save Config Secret For Brand Payment Gateway Success Response.
2679
-
2680
-
2681
-
2682
-
2683
- <details>
2684
- <summary><i>&nbsp; Example:</i></summary>
2685
-
2686
- ```json
2687
- {
2688
- "success": true,
2689
- "aggregators": [
2690
- "razorpay"
2691
- ]
2692
- }
2693
- ```
2694
- </details>
2695
-
2696
-
2697
-
2698
-
2699
-
2700
-
2701
-
2702
-
2703
-
2704
- ---
2705
-
2706
-
2707
- ### updatePayout
2708
- Update Payout
2709
-
2710
-
2711
-
2712
- ```javascript
2713
- // Promise
2714
- const promise = client.payment.updatePayout({ uniqueTransferNo : value,
2715
- body : value });
2716
-
2717
- // Async/Await
2718
- const data = await client.payment.updatePayout({ uniqueTransferNo : value,
2719
- body : value });
2720
- ```
2721
-
2722
-
2723
-
2724
-
2725
-
2726
- | Argument | Type | Required | Description |
2727
- | --------- | ----- | -------- | ----------- |
2728
- | uniqueTransferNo | string | yes | Unique transfer id |
2729
- | body | [PayoutRequest](#PayoutRequest) | yes | Request body |
2730
-
2731
-
2732
- Update Payout
2733
-
2734
- *Returned Response:*
2735
-
2736
-
2737
-
2738
-
2739
- [UpdatePayoutResponse](#UpdatePayoutResponse)
2740
-
2741
- save payout response object
2742
-
2743
-
2744
-
2745
-
2746
- <details>
2747
- <summary><i>&nbsp; Example:</i></summary>
2748
-
2749
- ```json
2750
- {
2751
- "success": true,
2752
- "is_default": true,
2753
- "is_active": true
2754
- }
2755
- ```
2756
- </details>
2757
-
2758
-
2759
-
2760
-
2761
-
2762
-
2763
-
2764
-
2765
-
2766
- ---
2767
-
2768
-
2769
- ### verifyIfscCode
2770
- Ifsc Code Verification
2771
-
2772
-
2773
-
2774
- ```javascript
2775
- // Promise
2776
- const promise = client.payment.verifyIfscCode({ ifscCode : value });
2777
-
2778
- // Async/Await
2779
- const data = await client.payment.verifyIfscCode({ ifscCode : value });
2780
- ```
2781
-
2782
-
2783
-
2784
-
2785
-
2786
- | Argument | Type | Required | Description |
2787
- | --------- | ----- | -------- | ----------- |
2788
- | ifscCode | string | no | |
2789
-
2790
-
2791
-
2792
- Get True/False for correct IFSC Code for adding bank details for refund
2793
-
2794
- *Returned Response:*
2795
-
2796
-
2797
-
2798
-
2799
- [IfscCodeResponse](#IfscCodeResponse)
2800
-
2801
- Bank details on correct Ifsc Code
2802
-
2803
-
2804
-
2805
-
2806
- <details>
2807
- <summary><i>&nbsp; Example:</i></summary>
2808
-
2809
- ```json
2810
- {
2811
- "branch_name": "MANPUR",
2812
- "bank_name": "GAYA",
2813
- "BRANCH": "MANPUR",
2814
- "CENTRE": "GAYA",
2815
- "DISTRICT": "GAYA",
2816
- "STATE": "BIHAR",
2817
- "ADDRESS": "POBUNIYADGANJBIHAR",
2818
- "CONTACT": "00",
2819
- "MICR": "816002103",
2820
- "UPI": true,
2821
- "RTGS": true,
2822
- "CITY": "GAYA",
2823
- "NEFT": true,
2824
- "IMPS": true,
2825
- "SWIFT": "",
2826
- "BANK": "State Bank of India",
2827
- "BANKCODE": "SBIN",
2828
- "IFSC": "SBIN0005611",
2829
- "success": true
2830
- }
2831
- ```
2832
- </details>
2833
-
2834
-
2835
-
2836
-
2837
-
2838
-
2839
-
2840
-
2841
-
2842
- ---
2843
-
2844
-
2845
-
2846
- ### Schemas
2847
-
2848
-
2849
- #### [AddBeneficiaryDetailsOTPRequest](#AddBeneficiaryDetailsOTPRequest)
2850
-
2851
- | Properties | Type | Nullable | Description |
2852
- | ---------- | ---- | -------- | ----------- || details | [BankDetailsForOTP](#BankDetailsForOTP) | yes | || order_id | string | yes | |
2853
-
2854
- ---
2855
-
2856
- #### [BankDetailsForOTP](#BankDetailsForOTP)
2857
-
2858
- | Properties | Type | Nullable | Description |
2859
- | ---------- | ---- | -------- | ----------- || account_holder | string | yes | || account_no | string | yes | || bank_name | string | yes | || branch_name | string | yes | || ifsc_code | string | yes | |
2860
-
2861
- ---
2862
-
2863
- #### [CODdata](#CODdata)
2864
-
2865
- | Properties | Type | Nullable | Description |
2866
- | ---------- | ---- | -------- | ----------- || is_active | boolean | yes | || limit | number | yes | || remaining_limit | number | yes | || usages | number | yes | || user_id | string | yes | |
2867
-
2868
- ---
2869
-
2870
- #### [DeletePayoutResponse](#DeletePayoutResponse)
2871
-
2872
- | Properties | Type | Nullable | Description |
2873
- | ---------- | ---- | -------- | ----------- || success | boolean | yes | |
2874
-
2875
- ---
2876
-
2877
- #### [DeleteSubscriptionPaymentMethodResponse](#DeleteSubscriptionPaymentMethodResponse)
2878
-
2879
- | Properties | Type | Nullable | Description |
2880
- | ---------- | ---- | -------- | ----------- || success | boolean | yes | |
2881
-
2882
- ---
2883
-
2884
- #### [ErrorCodeAndDescription](#ErrorCodeAndDescription)
2885
-
2886
- | Properties | Type | Nullable | Description |
2887
- | ---------- | ---- | -------- | ----------- || code | string | yes | || description | string | yes | |
2888
-
2889
- ---
2890
-
2891
- #### [ErrorCodeDescription](#ErrorCodeDescription)
2892
-
2893
- | Properties | Type | Nullable | Description |
2894
- | ---------- | ---- | -------- | ----------- || code | string | yes | || description | string | yes | || success | boolean | yes | |
2895
-
2896
- ---
2897
-
2898
- #### [GetUserCODLimitResponse](#GetUserCODLimitResponse)
2899
-
2900
- | Properties | Type | Nullable | Description |
2901
- | ---------- | ---- | -------- | ----------- || success | boolean | yes | || user_cod_data | [CODdata](#CODdata) | yes | |
2902
-
2903
- ---
2904
-
2905
- #### [HttpErrorCodeAndResponse](#HttpErrorCodeAndResponse)
2906
-
2907
- | Properties | Type | Nullable | Description |
2908
- | ---------- | ---- | -------- | ----------- || error | [ErrorCodeAndDescription](#ErrorCodeAndDescription) | yes | || success | boolean | yes | |
2909
-
2910
- ---
2911
-
2912
- #### [IfscCodeResponse](#IfscCodeResponse)
2913
-
2914
- | Properties | Type | Nullable | Description |
2915
- | ---------- | ---- | -------- | ----------- || bank_name | string | yes | || branch_name | string | yes | || success | boolean | no | |
2916
-
2917
- ---
2918
-
2919
- #### [IntentApp](#IntentApp)
2920
-
2921
- | Properties | Type | Nullable | Description |
2922
- | ---------- | ---- | -------- | ----------- || code | string | no | || display_name | string | no | || logos | [PaymentModeLogo](#PaymentModeLogo) | no | || package_name | string | no | |
2923
-
2924
- ---
2925
-
2926
- #### [IntentAppErrorList](#IntentAppErrorList)
2927
-
2928
- | Properties | Type | Nullable | Description |
2929
- | ---------- | ---- | -------- | ----------- || code | string | no | || package_name | string | no | |
2930
-
2931
- ---
2932
-
2933
- #### [MultiTenderPaymentMeta](#MultiTenderPaymentMeta)
2934
-
2935
- | Properties | Type | Nullable | Description |
2936
- | ---------- | ---- | -------- | ----------- || current_status | string | no | || extra_meta | string | no | || order_id | string | no | || payment_gateway | string | no | || payment_id | string | no | |
2937
-
2938
- ---
2939
-
2940
- #### [MultiTenderPaymentMethod](#MultiTenderPaymentMethod)
2941
-
2942
- | Properties | Type | Nullable | Description |
2943
- | ---------- | ---- | -------- | ----------- || amount | number | yes | || meta | [MultiTenderPaymentMeta](#MultiTenderPaymentMeta) | no | || mode | string | yes | || name | string | no | |
2944
-
2945
- ---
2946
-
2947
- #### [NotFoundResourceError](#NotFoundResourceError)
2948
-
2949
- | Properties | Type | Nullable | Description |
2950
- | ---------- | ---- | -------- | ----------- || code | string | yes | || description | string | yes | || success | boolean | yes | |
2951
-
2952
- ---
2953
-
2954
- #### [OrderBeneficiaryDetails](#OrderBeneficiaryDetails)
2955
-
2956
- | Properties | Type | Nullable | Description |
2957
- | ---------- | ---- | -------- | ----------- || account_holder | string | yes | || account_no | string | yes | || address | string | yes | || bank_name | string | yes | || beneficiary_id | string | yes | || branch_name | string | no | || comment | string | no | || created_on | string | yes | || delights_user_name | string | no | || display_name | string | yes | || email | string | yes | || id | number | yes | || ifsc_code | string | yes | || is_active | boolean | yes | || mobile | string | no | || modified_on | string | yes | || subtitle | string | yes | || title | string | yes | || transfer_mode | string | yes | |
2958
-
2959
- ---
2960
-
2961
- #### [OrderBeneficiaryResponse](#OrderBeneficiaryResponse)
2962
-
2963
- | Properties | Type | Nullable | Description |
2964
- | ---------- | ---- | -------- | ----------- || beneficiaries | [[OrderBeneficiaryDetails](#OrderBeneficiaryDetails)] | no | || show_beneficiary_details | boolean | no | |
2965
-
2966
- ---
2967
-
2968
- #### [PaymentConfirmationRequest](#PaymentConfirmationRequest)
2969
-
2970
- | Properties | Type | Nullable | Description |
2971
- | ---------- | ---- | -------- | ----------- || order_id | string | yes | || payment_methods | [[MultiTenderPaymentMethod](#MultiTenderPaymentMethod)] | yes | |
2972
-
2973
- ---
2974
-
2975
- #### [PaymentConfirmationResponse](#PaymentConfirmationResponse)
2976
-
2977
- | Properties | Type | Nullable | Description |
2978
- | ---------- | ---- | -------- | ----------- || message | string | yes | || order_id | string | yes | || success | boolean | yes | |
2979
-
2980
- ---
2981
-
2982
- #### [PaymentGatewayConfig](#PaymentGatewayConfig)
2983
-
2984
- | Properties | Type | Nullable | Description |
2985
- | ---------- | ---- | -------- | ----------- || config_type | string | yes | || is_active | boolean | no | || key | string | yes | || merchant_salt | string | yes | || secret | string | yes | |
2986
-
2987
- ---
2988
-
2989
- #### [PaymentGatewayConfigRequest](#PaymentGatewayConfigRequest)
2990
-
2991
- | Properties | Type | Nullable | Description |
2992
- | ---------- | ---- | -------- | ----------- || aggregator_name | [PaymentGatewayConfig](#PaymentGatewayConfig) | no | || app_id | string | yes | || is_active | boolean | no | |
2993
-
2994
- ---
2995
-
2996
- #### [PaymentGatewayConfigResponse](#PaymentGatewayConfigResponse)
2997
-
2998
- | Properties | Type | Nullable | Description |
2999
- | ---------- | ---- | -------- | ----------- || aggregators | [string] | no | || app_id | string | yes | || created | boolean | yes | || display_fields | [string] | yes | || excluded_fields | [string] | yes | || success | boolean | yes | |
3000
-
3001
- ---
3002
-
3003
- #### [PaymentGatewayToBeReviewed](#PaymentGatewayToBeReviewed)
3004
-
3005
- | Properties | Type | Nullable | Description |
3006
- | ---------- | ---- | -------- | ----------- || aggregator | [string] | yes | || success | boolean | yes | |
3007
-
3008
- ---
3009
-
3010
- #### [PaymentModeList](#PaymentModeList)
3011
-
3012
- | Properties | Type | Nullable | Description |
3013
- | ---------- | ---- | -------- | ----------- || aggregator_name | string | yes | || card_brand | string | no | || card_brand_image | string | no | || card_fingerprint | string | no | || card_id | string | no | || card_isin | string | no | || card_issuer | string | no | || card_name | string | no | || card_number | string | no | || card_reference | string | no | || card_token | string | no | || card_type | string | no | || cod_limit | number | no | || cod_limit_per_order | number | no | || code | string | no | || compliant_with_tokenisation_guidelines | boolean | no | || display_name | string | no | || display_priority | number | no | || exp_month | number | no | || exp_year | number | no | || expired | boolean | no | || fynd_vpa | string | no | || intent_app | [[IntentApp](#IntentApp)] | no | || intent_app_error_dict_list | [[IntentAppErrorList](#IntentAppErrorList)] | no | || intent_app_error_list | [string] | no | || intent_flow | boolean | no | || logo_url | [PaymentModeLogo](#PaymentModeLogo) | no | || merchant_code | string | no | || name | string | no | || nickname | string | no | || remaining_limit | number | no | || retry_count | number | no | || timeout | number | no | |
3014
-
3015
- ---
3016
-
3017
- #### [PaymentModeLogo](#PaymentModeLogo)
3018
-
3019
- | Properties | Type | Nullable | Description |
3020
- | ---------- | ---- | -------- | ----------- || large | string | yes | || small | string | yes | |
3021
-
3022
- ---
3023
-
3024
- #### [PaymentOptions](#PaymentOptions)
3025
-
3026
- | Properties | Type | Nullable | Description |
3027
- | ---------- | ---- | -------- | ----------- || payment_option | [[RootPaymentMode](#RootPaymentMode)] | yes | |
3028
-
3029
- ---
3030
-
3031
- #### [PaymentOptionsResponse](#PaymentOptionsResponse)
3032
-
3033
- | Properties | Type | Nullable | Description |
3034
- | ---------- | ---- | -------- | ----------- || payment_options | [PaymentOptions](#PaymentOptions) | yes | || success | boolean | yes | |
3035
-
3036
- ---
3037
-
3038
- #### [PayoutBankDetails](#PayoutBankDetails)
3039
-
3040
- | Properties | Type | Nullable | Description |
3041
- | ---------- | ---- | -------- | ----------- || account_holder | string | no | || account_no | string | no | || account_type | string | yes | || bank_name | string | no | || branch_name | string | no | || city | string | no | || country | string | no | || ifsc_code | string | yes | || pincode | number | no | || state | string | no | |
3042
-
3043
- ---
3044
-
3045
- #### [PayoutRequest](#PayoutRequest)
3046
-
3047
- | Properties | Type | Nullable | Description |
3048
- | ---------- | ---- | -------- | ----------- || aggregator | string | yes | || bank_details | [PayoutBankDetails](#PayoutBankDetails) | yes | || is_active | boolean | yes | || transfer_type | string | yes | || unique_external_id | string | yes | || users | string | yes | |
3049
-
3050
- ---
3051
-
3052
- #### [PayoutResponse](#PayoutResponse)
3053
-
3054
- | Properties | Type | Nullable | Description |
3055
- | ---------- | ---- | -------- | ----------- || aggregator | string | yes | || bank_details | string | yes | || created | boolean | yes | || is_active | boolean | yes | || payment_status | string | yes | || payouts | string | yes | || success | boolean | yes | || transfer_type | string | yes | || unique_transfer_no | string | yes | || users | string | yes | |
3056
-
3057
- ---
3058
-
3059
- #### [PayoutsResponse](#PayoutsResponse)
3060
-
3061
- | Properties | Type | Nullable | Description |
3062
- | ---------- | ---- | -------- | ----------- || customers | string | yes | || is_active | boolean | yes | || is_default | boolean | yes | || more_attributes | string | yes | || payouts_aggregators | [string] | yes | || transfer_type | string | yes | || unique_transfer_no | string | yes | |
3063
-
3064
- ---
3065
-
3066
- #### [RefundAccountResponse](#RefundAccountResponse)
3067
-
3068
- | Properties | Type | Nullable | Description |
3069
- | ---------- | ---- | -------- | ----------- || data | string | no | || is_verified_flag | boolean | no | || message | string | yes | || success | boolean | yes | |
3070
-
3071
- ---
3072
-
3073
- #### [RootPaymentMode](#RootPaymentMode)
3074
-
3075
- | Properties | Type | Nullable | Description |
3076
- | ---------- | ---- | -------- | ----------- || add_card_enabled | boolean | no | || aggregator_name | string | no | || anonymous_enable | boolean | no | || display_name | string | yes | || display_priority | number | yes | || is_pay_by_card_pl | boolean | no | || list | [[PaymentModeList](#PaymentModeList)] | no | || name | string | yes | || save_card | boolean | no | |
3077
-
3078
- ---
3079
-
3080
- #### [SaveSubscriptionSetupIntentRequest](#SaveSubscriptionSetupIntentRequest)
3081
-
3082
- | Properties | Type | Nullable | Description |
3083
- | ---------- | ---- | -------- | ----------- || unique_external_id | string | yes | |
3084
-
3085
- ---
3086
-
3087
- #### [SaveSubscriptionSetupIntentResponse](#SaveSubscriptionSetupIntentResponse)
3088
-
3089
- | Properties | Type | Nullable | Description |
3090
- | ---------- | ---- | -------- | ----------- || data | string | yes | || success | boolean | yes | |
3091
-
3092
- ---
3093
-
3094
- #### [SetCODForUserRequest](#SetCODForUserRequest)
3095
-
3096
- | Properties | Type | Nullable | Description |
3097
- | ---------- | ---- | -------- | ----------- || is_active | boolean | yes | || merchant_user_id | string | yes | || mobileno | string | yes | |
3098
-
3099
- ---
3100
-
3101
- #### [SetCODOptionResponse](#SetCODOptionResponse)
3102
-
3103
- | Properties | Type | Nullable | Description |
3104
- | ---------- | ---- | -------- | ----------- || message | string | yes | || success | boolean | yes | |
3105
-
3106
- ---
3107
-
3108
- #### [SubscriptionConfigResponse](#SubscriptionConfigResponse)
3109
-
3110
- | Properties | Type | Nullable | Description |
3111
- | ---------- | ---- | -------- | ----------- || aggregator | string | yes | || config | string | yes | || success | boolean | yes | |
3112
-
3113
- ---
3114
-
3115
- #### [SubscriptionPaymentMethodResponse](#SubscriptionPaymentMethodResponse)
3116
-
3117
- | Properties | Type | Nullable | Description |
3118
- | ---------- | ---- | -------- | ----------- || data | [string] | yes | || success | boolean | yes | |
3119
-
3120
- ---
3121
-
3122
- #### [UpdatePayoutRequest](#UpdatePayoutRequest)
3123
-
3124
- | Properties | Type | Nullable | Description |
3125
- | ---------- | ---- | -------- | ----------- || is_active | boolean | yes | || is_default | boolean | yes | || unique_external_id | string | yes | |
3126
-
3127
- ---
3128
-
3129
- #### [UpdatePayoutResponse](#UpdatePayoutResponse)
3130
-
3131
- | Properties | Type | Nullable | Description |
3132
- | ---------- | ---- | -------- | ----------- || is_active | boolean | yes | || is_default | boolean | yes | || success | boolean | yes | |
3133
-
3134
- ---
3135
-
3136
-
3137
-
3138
-