@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,4475 +0,0 @@
1
-
2
-
3
-
4
-
5
-
6
- ##### [Back to Application 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
- * [addBeneficiaryDetails](#addbeneficiarydetails)
12
- * [addRefundBankAccountUsingOTP](#addrefundbankaccountusingotp)
13
- * [attachCardToCustomer](#attachcardtocustomer)
14
- * [cancelPaymentLink](#cancelpaymentlink)
15
- * [checkAndUpdatePaymentStatus](#checkandupdatepaymentstatus)
16
- * [checkAndUpdatePaymentStatusPaymentLink](#checkandupdatepaymentstatuspaymentlink)
17
- * [checkCredit](#checkcredit)
18
- * [createOrderHandlerPaymentLink](#createorderhandlerpaymentlink)
19
- * [createPaymentLink](#createpaymentlink)
20
- * [customerCreditSummary](#customercreditsummary)
21
- * [customerOnboard](#customeronboard)
22
- * [deleteUserCard](#deleteusercard)
23
- * [enableOrDisableRefundTransferMode](#enableordisablerefundtransfermode)
24
- * [getActiveCardAggregator](#getactivecardaggregator)
25
- * [getActiveRefundTransferModes](#getactiverefundtransfermodes)
26
- * [getActiveUserCards](#getactiveusercards)
27
- * [getAggregatorsConfig](#getaggregatorsconfig)
28
- * [getEpaylaterBannerDetails](#getepaylaterbannerdetails)
29
- * [getOrderBeneficiariesDetail](#getorderbeneficiariesdetail)
30
- * [getPaymentLink](#getpaymentlink)
31
- * [getPaymentModeRoutes](#getpaymentmoderoutes)
32
- * [getPaymentModeRoutesPaymentLink](#getpaymentmoderoutespaymentlink)
33
- * [getPosPaymentModeRoutes](#getpospaymentmoderoutes)
34
- * [getRupifiBannerDetails](#getrupifibannerdetails)
35
- * [getUserBeneficiariesDetail](#getuserbeneficiariesdetail)
36
- * [initialisePayment](#initialisepayment)
37
- * [initialisePaymentPaymentLink](#initialisepaymentpaymentlink)
38
- * [pollingPaymentLink](#pollingpaymentlink)
39
- * [redirectToAggregator](#redirecttoaggregator)
40
- * [renderHTML](#renderhtml)
41
- * [resendOrCancelPayment](#resendorcancelpayment)
42
- * [resendPaymentLink](#resendpaymentlink)
43
- * [updateDefaultBeneficiary](#updatedefaultbeneficiary)
44
- * [validateVPA](#validatevpa)
45
- * [verifyAndChargePayment](#verifyandchargepayment)
46
- * [verifyCustomerForPayment](#verifycustomerforpayment)
47
- * [verifyIfscCode](#verifyifsccode)
48
- * [verifyOtpAndAddBeneficiaryForBank](#verifyotpandaddbeneficiaryforbank)
49
- * [verifyOtpAndAddBeneficiaryForWallet](#verifyotpandaddbeneficiaryforwallet)
50
-
51
-
52
-
53
- ## Methods with example and description
54
-
55
-
56
-
57
-
58
- ### addBeneficiaryDetails
59
- Save bank details for cancelled/returned order
60
-
61
-
62
-
63
- ```javascript
64
- // Promise
65
- const promise = payment.addBeneficiaryDetails({ body : value });
66
-
67
- // Async/Await
68
- const data = await payment.addBeneficiaryDetails({ body : value });
69
- ```
70
-
71
-
72
-
73
-
74
-
75
- | Argument | Type | Required | Description |
76
- | --------- | ----- | -------- | ----------- |
77
- | body | [AddBeneficiaryDetailsRequest](#AddBeneficiaryDetailsRequest) | yes | Request body |
78
-
79
-
80
- Use this API to save the bank details for a returned or cancelled order to refund the amount.
81
-
82
- *Returned Response:*
83
-
84
-
85
-
86
-
87
- [RefundAccountResponse](#RefundAccountResponse)
88
-
89
- Success. Shows whether the beneficiary details were saved to a returned/cancelled order or not.
90
-
91
-
92
-
93
-
94
- <details>
95
- <summary><i>&nbsp; Example:</i></summary>
96
-
97
- ```json
98
- {
99
- "success": true,
100
- "message": "Account successfully created",
101
- "data": {},
102
- "is_verified_flag": true
103
- }
104
- ```
105
- </details>
106
-
107
-
108
-
109
-
110
-
111
-
112
-
113
-
114
-
115
- ---
116
-
117
-
118
- ### addRefundBankAccountUsingOTP
119
- Save bank details for cancelled/returned order
120
-
121
-
122
-
123
- ```javascript
124
- // Promise
125
- const promise = payment.addRefundBankAccountUsingOTP({ body : value });
126
-
127
- // Async/Await
128
- const data = await payment.addRefundBankAccountUsingOTP({ body : value });
129
- ```
130
-
131
-
132
-
133
-
134
-
135
- | Argument | Type | Required | Description |
136
- | --------- | ----- | -------- | ----------- |
137
- | body | [AddBeneficiaryDetailsOTPRequest](#AddBeneficiaryDetailsOTPRequest) | yes | Request body |
138
-
139
-
140
- Use this API to save bank details for returned/cancelled order to refund amount in his account.
141
-
142
- *Returned Response:*
143
-
144
-
145
-
146
-
147
- [RefundAccountResponse](#RefundAccountResponse)
148
-
149
- Success. Shows whether the beneficiary details were saved to a returned/cancelled order or not.
150
-
151
-
152
-
153
-
154
- <details>
155
- <summary><i>&nbsp; Example:</i></summary>
156
-
157
- ```json
158
- {
159
- "success": true,
160
- "message": "Account successfully created",
161
- "data": {},
162
- "is_verified_flag": true
163
- }
164
- ```
165
- </details>
166
-
167
-
168
-
169
-
170
-
171
-
172
-
173
-
174
-
175
- ---
176
-
177
-
178
- ### attachCardToCustomer
179
- Attach a saved card to customer.
180
-
181
-
182
-
183
- ```javascript
184
- // Promise
185
- const promise = payment.attachCardToCustomer({ body : value });
186
-
187
- // Async/Await
188
- const data = await payment.attachCardToCustomer({ body : value });
189
- ```
190
-
191
-
192
-
193
-
194
-
195
- | Argument | Type | Required | Description |
196
- | --------- | ----- | -------- | ----------- |
197
- | body | [AttachCardRequest](#AttachCardRequest) | yes | Request body |
198
-
199
-
200
- Use this API to attach a customer's saved card at the payment gateway, such as Stripe, Juspay.
201
-
202
- *Returned Response:*
203
-
204
-
205
-
206
-
207
- [AttachCardsResponse](#AttachCardsResponse)
208
-
209
- Success. Check the example shown below or refer `AttachCardsResponse` for more details.
210
-
211
-
212
-
213
-
214
- <details>
215
- <summary><i>&nbsp; Example:</i></summary>
216
-
217
- ```json
218
- {
219
- "success": true,
220
- "message": "",
221
- "data": {
222
- "id": "pm_1IGQlvHY5NCLOJpYNTBP6WpY",
223
- "brand": "visa",
224
- "checks": {
225
- "address_line1_check": null,
226
- "address_postal_code_check": null,
227
- "cvc_check": "pass"
228
- },
229
- "country": "US",
230
- "exp_month": 11,
231
- "exp_year": 2025,
232
- "fingerprint": "poKWfSweJ0I5CvEA",
233
- "funding": "credit",
234
- "generated_from": null,
235
- "last4": "1111",
236
- "networks": {
237
- "available": [
238
- "visa"
239
- ],
240
- "preferred": null
241
- },
242
- "three_d_secure_usage": {
243
- "supported": true
244
- },
245
- "wallet": null
246
- }
247
- }
248
- ```
249
- </details>
250
-
251
-
252
-
253
-
254
-
255
-
256
-
257
-
258
-
259
- ---
260
-
261
-
262
- ### cancelPaymentLink
263
- Cancel payment link
264
-
265
-
266
-
267
- ```javascript
268
- // Promise
269
- const promise = payment.cancelPaymentLink({ body : value });
270
-
271
- // Async/Await
272
- const data = await payment.cancelPaymentLink({ body : value });
273
- ```
274
-
275
-
276
-
277
-
278
-
279
- | Argument | Type | Required | Description |
280
- | --------- | ----- | -------- | ----------- |
281
- | body | [CancelOrResendPaymentLinkRequest](#CancelOrResendPaymentLinkRequest) | yes | Request body |
282
-
283
-
284
- Use this API to cancel a payment link for the customer
285
-
286
- *Returned Response:*
287
-
288
-
289
-
290
-
291
- [CancelPaymentLinkResponse](#CancelPaymentLinkResponse)
292
-
293
- Success. Check the example shown below
294
-
295
-
296
-
297
-
298
- <details>
299
- <summary><i>&nbsp; Example:</i></summary>
300
-
301
- ```json
302
- {
303
- "success": true,
304
- "message": "Payment link cancelled",
305
- "status_code": 200
306
- }
307
- ```
308
- </details>
309
-
310
-
311
-
312
-
313
-
314
-
315
-
316
-
317
-
318
- ---
319
-
320
-
321
- ### checkAndUpdatePaymentStatus
322
- Performs continuous polling to check status of payment on the server
323
-
324
-
325
-
326
- ```javascript
327
- // Promise
328
- const promise = payment.checkAndUpdatePaymentStatus({ body : value });
329
-
330
- // Async/Await
331
- const data = await payment.checkAndUpdatePaymentStatus({ body : value });
332
- ```
333
-
334
-
335
-
336
-
337
-
338
- | Argument | Type | Required | Description |
339
- | --------- | ----- | -------- | ----------- |
340
- | body | [PaymentStatusUpdateRequest](#PaymentStatusUpdateRequest) | yes | Request body |
341
-
342
-
343
- Use this API to perform continuous polling at intervals to check the status of payment until timeout.
344
-
345
- *Returned Response:*
346
-
347
-
348
-
349
-
350
- [PaymentStatusUpdateResponse](#PaymentStatusUpdateResponse)
351
-
352
- Success. Returns the status of payment. Check the example shown below or refer `PaymentStatusUpdateResponse` for more details.
353
-
354
-
355
-
356
-
357
- <details>
358
- <summary><i>&nbsp; Example:</i></summary>
359
-
360
- ```json
361
- {
362
- "aggregator_name": "UPI_Razorpay",
363
- "status": "success",
364
- "retry": false
365
- }
366
- ```
367
- </details>
368
-
369
-
370
-
371
-
372
-
373
-
374
-
375
-
376
-
377
- ---
378
-
379
-
380
- ### checkAndUpdatePaymentStatusPaymentLink
381
- Performs continuous polling to check status of payment on the server
382
-
383
-
384
-
385
- ```javascript
386
- // Promise
387
- const promise = payment.checkAndUpdatePaymentStatusPaymentLink({ body : value });
388
-
389
- // Async/Await
390
- const data = await payment.checkAndUpdatePaymentStatusPaymentLink({ body : value });
391
- ```
392
-
393
-
394
-
395
-
396
-
397
- | Argument | Type | Required | Description |
398
- | --------- | ----- | -------- | ----------- |
399
- | body | [PaymentStatusUpdateRequest](#PaymentStatusUpdateRequest) | yes | Request body |
400
-
401
-
402
- Use this API to perform continuous polling at intervals to check the status of payment until timeout.
403
-
404
- *Returned Response:*
405
-
406
-
407
-
408
-
409
- [PaymentStatusUpdateResponse](#PaymentStatusUpdateResponse)
410
-
411
- Success. Returns the status of payment. Check the example shown below or refer `PaymentStatusUpdateResponse` for more details.
412
-
413
-
414
-
415
-
416
- <details>
417
- <summary><i>&nbsp; Example:</i></summary>
418
-
419
- ```json
420
- {
421
- "aggregator_name": "UPI_Razorpay",
422
- "status": "success",
423
- "retry": false
424
- }
425
- ```
426
- </details>
427
-
428
-
429
-
430
-
431
-
432
-
433
-
434
-
435
-
436
- ---
437
-
438
-
439
- ### checkCredit
440
- API to fetch the customer credit summary
441
-
442
-
443
-
444
- ```javascript
445
- // Promise
446
- const promise = payment.checkCredit({ aggregator : value });
447
-
448
- // Async/Await
449
- const data = await payment.checkCredit({ aggregator : value });
450
- ```
451
-
452
-
453
-
454
-
455
-
456
- | Argument | Type | Required | Description |
457
- | --------- | ----- | -------- | ----------- |
458
- | aggregator | string | no | |
459
-
460
-
461
-
462
- Use this API to fetch the customer credit summary.
463
-
464
- *Returned Response:*
465
-
466
-
467
-
468
-
469
- [CheckCreditResponse](#CheckCreditResponse)
470
-
471
- Success. Returns the status of payment. Check the example shown below or refer `CheckCreditResponseSchema` for more details.
472
-
473
-
474
-
475
-
476
- <details>
477
- <summary><i>&nbsp; Example:</i></summary>
478
-
479
- ```json
480
- {
481
- "success": true,
482
- "data": {
483
- "is_registered": false,
484
- "status": true,
485
- "signup_url": "https://merchant.epaylater.in"
486
- }
487
- }
488
- ```
489
- </details>
490
-
491
-
492
-
493
-
494
-
495
-
496
-
497
-
498
-
499
- ---
500
-
501
-
502
- ### createOrderHandlerPaymentLink
503
- Create Order user
504
-
505
-
506
-
507
- ```javascript
508
- // Promise
509
- const promise = payment.createOrderHandlerPaymentLink({ body : value });
510
-
511
- // Async/Await
512
- const data = await payment.createOrderHandlerPaymentLink({ body : value });
513
- ```
514
-
515
-
516
-
517
-
518
-
519
- | Argument | Type | Required | Description |
520
- | --------- | ----- | -------- | ----------- |
521
- | body | [CreateOrderUserRequest](#CreateOrderUserRequest) | yes | Request body |
522
-
523
-
524
- Use this API to create a order and payment on aggregator side
525
-
526
- *Returned Response:*
527
-
528
-
529
-
530
-
531
- [CreateOrderUserResponse](#CreateOrderUserResponse)
532
-
533
- Success. Check the example shown below
534
-
535
-
536
-
537
-
538
- <details>
539
- <summary><i>&nbsp; Example:</i></summary>
540
-
541
- ```json
542
- {
543
- "message": "",
544
- "success": true,
545
- "data": {
546
- "amount": 2190000,
547
- "order_id": "order_JeaZ5ryKO01rno",
548
- "email": "abc@example.com",
549
- "contact": "9999999999",
550
- "currency": "INR",
551
- "customer_id": "cust_CZgcLVGsGP8BUQ",
552
- "callback_url": "https://api.fyndx0.com/service/webhooks/payment/v1.0/callback/link/?razorpay_order_id=order_JeaZ5ryKO01rno",
553
- "method": "upi",
554
- "aggregator": "Razorpay",
555
- "merchant_order_id": "FY629EDC0980B6A8C1EA"
556
- },
557
- "callback_url": "https://api.fyndx0.com/service/webhooks/payment/v1.0/callback/link/?razorpay_order_id=order_JeaZ5ryKO01rno",
558
- "payment_confirm_url": "https://api.fyndx0.com/service/webhooks/payment/v1.0/callback/link/?razorpay_order_id=order_JeaZ5ryKO01rno",
559
- "order_id": "FY629EDC0980B6A8C1EA"
560
- }
561
- ```
562
- </details>
563
-
564
-
565
-
566
-
567
-
568
-
569
-
570
-
571
-
572
- ---
573
-
574
-
575
- ### createPaymentLink
576
- Create payment link
577
-
578
-
579
-
580
- ```javascript
581
- // Promise
582
- const promise = payment.createPaymentLink({ body : value });
583
-
584
- // Async/Await
585
- const data = await payment.createPaymentLink({ body : value });
586
- ```
587
-
588
-
589
-
590
-
591
-
592
- | Argument | Type | Required | Description |
593
- | --------- | ----- | -------- | ----------- |
594
- | body | [CreatePaymentLinkRequest](#CreatePaymentLinkRequest) | yes | Request body |
595
-
596
-
597
- Use this API to create a payment link for the customer
598
-
599
- *Returned Response:*
600
-
601
-
602
-
603
-
604
- [CreatePaymentLinkResponse](#CreatePaymentLinkResponse)
605
-
606
- Success. Check the example shown below
607
-
608
-
609
-
610
-
611
- <details>
612
- <summary><i>&nbsp; Example:</i></summary>
613
-
614
- ```json
615
- {
616
- "success": true,
617
- "message": "Payment link created",
618
- "status_code": 200,
619
- "payment_link_url": "https://api.fyndx0.de/service/application/payment/v1.0/payment/options/link/?id=96b15ea2014a76c8d2774783e239ce26&refresh=false",
620
- "payment_link_id": "96b15ea2014a76c8d2774783e239ce26",
621
- "polling_timeout": 480
622
- }
623
- ```
624
- </details>
625
-
626
-
627
-
628
-
629
-
630
-
631
-
632
-
633
-
634
- ---
635
-
636
-
637
- ### customerCreditSummary
638
- API to fetch the customer credit summary
639
-
640
-
641
-
642
- ```javascript
643
- // Promise
644
- const promise = payment.customerCreditSummary({ aggregator : value });
645
-
646
- // Async/Await
647
- const data = await payment.customerCreditSummary({ aggregator : value });
648
- ```
649
-
650
-
651
-
652
-
653
-
654
- | Argument | Type | Required | Description |
655
- | --------- | ----- | -------- | ----------- |
656
- | aggregator | string | no | |
657
-
658
-
659
-
660
- Use this API to fetch the customer credit summary.
661
-
662
- *Returned Response:*
663
-
664
-
665
-
666
-
667
- [CustomerCreditSummaryResponse](#CustomerCreditSummaryResponse)
668
-
669
- Success. Returns the status of payment. Check the example shown below or refer `CustomerCreditSummaryResponseSchema` for more details.
670
-
671
-
672
-
673
-
674
- <details>
675
- <summary><i>&nbsp; Example:</i></summary>
676
-
677
- ```json
678
- {
679
- "success": true,
680
- "data": {
681
- "merchant_customer_ref_id": "ABHI0002",
682
- "status": "Bill Due",
683
- "status_message": "Pay now to avoid interest charges",
684
- "balance": {
685
- "value": 87424,
686
- "formatted_value": "₹ 87,424.00",
687
- "currency": "INR"
688
- },
689
- "limit": {
690
- "value": 100000,
691
- "formatted_value": "₹ 100,000.00",
692
- "currency": "INR"
693
- },
694
- "due_amount": {
695
- "value": 12576,
696
- "formatted_value": "₹ 12,576.00",
697
- "currency": "INR"
698
- },
699
- "used_amount": {
700
- "value": 12576,
701
- "formatted_value": "₹ 12,576.00",
702
- "currency": "INR"
703
- },
704
- "due_date": "Oct 22 2021",
705
- "days_overdue": 123
706
- }
707
- }
708
- ```
709
- </details>
710
-
711
-
712
-
713
-
714
-
715
-
716
-
717
-
718
-
719
- ---
720
-
721
-
722
- ### customerOnboard
723
- API to fetch the customer credit summary
724
-
725
-
726
-
727
- ```javascript
728
- // Promise
729
- const promise = payment.customerOnboard({ body : value });
730
-
731
- // Async/Await
732
- const data = await payment.customerOnboard({ body : value });
733
- ```
734
-
735
-
736
-
737
-
738
-
739
- | Argument | Type | Required | Description |
740
- | --------- | ----- | -------- | ----------- |
741
- | body | [CustomerOnboardingRequest](#CustomerOnboardingRequest) | yes | Request body |
742
-
743
-
744
- Use this API to fetch the customer credit summary.
745
-
746
- *Returned Response:*
747
-
748
-
749
-
750
-
751
- [CustomerOnboardingResponse](#CustomerOnboardingResponse)
752
-
753
- Success. Returns the status of payment. Check the example shown below or refer `CustomerOnboardingResponseSchema` for more details.
754
-
755
-
756
-
757
-
758
- <details>
759
- <summary><i>&nbsp; Example:</i></summary>
760
-
761
- ```json
762
- {
763
- "success": true,
764
- "data": {
765
- "session": {
766
- "session_id": "109dae9a-9fe0-4277-979c-0bebb0136930"
767
- },
768
- "redirect_url": "https://retail-dev.epaylater.in?sessionId=109dae9a-9fe0-4277-979c-0bebb0136930",
769
- "status": true
770
- }
771
- }
772
- ```
773
- </details>
774
-
775
-
776
-
777
-
778
-
779
-
780
-
781
-
782
-
783
- ---
784
-
785
-
786
- ### deleteUserCard
787
- Delete a card
788
-
789
-
790
-
791
- ```javascript
792
- // Promise
793
- const promise = payment.deleteUserCard({ body : value });
794
-
795
- // Async/Await
796
- const data = await payment.deleteUserCard({ body : value });
797
- ```
798
-
799
-
800
-
801
-
802
-
803
- | Argument | Type | Required | Description |
804
- | --------- | ----- | -------- | ----------- |
805
- | body | [DeletehCardRequest](#DeletehCardRequest) | yes | Request body |
806
-
807
-
808
- Use this API to delete a card added by a user on the payment gateway and clear the cache.
809
-
810
- *Returned Response:*
811
-
812
-
813
-
814
-
815
- [DeleteCardsResponse](#DeleteCardsResponse)
816
-
817
- Success. Returns a success message if card is deleted.
818
-
819
-
820
-
821
-
822
- <details>
823
- <summary><i>&nbsp; Example:</i></summary>
824
-
825
- ```json
826
- {
827
- "success": true
828
- }
829
- ```
830
- </details>
831
-
832
-
833
-
834
-
835
-
836
-
837
-
838
-
839
-
840
- ---
841
-
842
-
843
- ### enableOrDisableRefundTransferMode
844
- Enable/Disable a mode for transferring a refund
845
-
846
-
847
-
848
- ```javascript
849
- // Promise
850
- const promise = payment.enableOrDisableRefundTransferMode({ body : value });
851
-
852
- // Async/Await
853
- const data = await payment.enableOrDisableRefundTransferMode({ body : value });
854
- ```
855
-
856
-
857
-
858
-
859
-
860
- | Argument | Type | Required | Description |
861
- | --------- | ----- | -------- | ----------- |
862
- | body | [UpdateRefundTransferModeRequest](#UpdateRefundTransferModeRequest) | yes | Request body |
863
-
864
-
865
- Activate or Deactivate Transfer Mode to collect Beneficiary Details for Refund
866
-
867
- *Returned Response:*
868
-
869
-
870
-
871
-
872
- [UpdateRefundTransferModeResponse](#UpdateRefundTransferModeResponse)
873
-
874
- Success. Shows whether the refund mode was successfully enabled or disabled.
875
-
876
-
877
-
878
-
879
- <details>
880
- <summary><i>&nbsp; Example:</i></summary>
881
-
882
- ```json
883
- {
884
- "success": true
885
- }
886
- ```
887
- </details>
888
-
889
-
890
-
891
-
892
-
893
-
894
-
895
-
896
-
897
- ---
898
-
899
-
900
- ### getActiveCardAggregator
901
- Fetch active payment gateway for card payments
902
-
903
-
904
-
905
- ```javascript
906
- // Promise
907
- const promise = payment.getActiveCardAggregator({ refresh : value });
908
-
909
- // Async/Await
910
- const data = await payment.getActiveCardAggregator({ refresh : value });
911
- ```
912
-
913
-
914
-
915
-
916
-
917
- | Argument | Type | Required | Description |
918
- | --------- | ----- | -------- | ----------- |
919
- | refresh | boolean | no | |
920
-
921
-
922
-
923
- Use this API to retrieve an active payment aggregator along with the Customer ID. This is applicable for cards payments only.
924
-
925
- *Returned Response:*
926
-
927
-
928
-
929
-
930
- [ActiveCardPaymentGatewayResponse](#ActiveCardPaymentGatewayResponse)
931
-
932
- Success. Returns an active payment gateway. Check the example shown below or refer `ActiveCardPaymentGatewayResponse` for more details.
933
-
934
-
935
-
936
-
937
- <details>
938
- <summary><i>&nbsp; Example:</i></summary>
939
-
940
- ```json
941
- {
942
- "success": true,
943
- "message": "",
944
- "cards": {
945
- "aggregator": "Stripe",
946
- "api": "https://www.example.com/cards/",
947
- "customer_id": "lorem_12345"
948
- }
949
- }
950
- ```
951
- </details>
952
-
953
-
954
-
955
-
956
-
957
-
958
-
959
-
960
-
961
- ---
962
-
963
-
964
- ### getActiveRefundTransferModes
965
- Lists the mode of refund
966
-
967
-
968
-
969
- ```javascript
970
- // Promise
971
- const promise = payment.getActiveRefundTransferModes();
972
-
973
- // Async/Await
974
- const data = await payment.getActiveRefundTransferModes();
975
- ```
976
-
977
-
978
-
979
-
980
-
981
-
982
- Use this API to retrieve eligible refund modes (such as Netbanking) and add the beneficiary details.
983
-
984
- *Returned Response:*
985
-
986
-
987
-
988
-
989
- [TransferModeResponse](#TransferModeResponse)
990
-
991
- Success. Shows the available refund mode to choose, e.g. Netbanking. Check the example shown below or refer `TransferModeResponse` for more details.
992
-
993
-
994
-
995
-
996
- <details>
997
- <summary><i>&nbsp; Example:</i></summary>
998
-
999
- ```json
1000
- {
1001
- "data": [
1002
- {
1003
- "display_name": "BANK",
1004
- "items": [
1005
- {
1006
- "id": 6,
1007
- "name": "bank",
1008
- "display_name": "BANK",
1009
- "logo_small": "https://hdn-1.fynd.com/payment/netbanking.png",
1010
- "logo_large": "https://hdn-1.fynd.com/payment/netbanking.png"
1011
- }
1012
- ]
1013
- }
1014
- ]
1015
- }
1016
- ```
1017
- </details>
1018
-
1019
-
1020
-
1021
-
1022
-
1023
-
1024
-
1025
-
1026
-
1027
- ---
1028
-
1029
-
1030
- ### getActiveUserCards
1031
- Fetch the list of cards saved by the user
1032
-
1033
-
1034
-
1035
- ```javascript
1036
- // Promise
1037
- const promise = payment.getActiveUserCards({ forceRefresh : value });
1038
-
1039
- // Async/Await
1040
- const data = await payment.getActiveUserCards({ forceRefresh : value });
1041
- ```
1042
-
1043
-
1044
-
1045
-
1046
-
1047
- | Argument | Type | Required | Description |
1048
- | --------- | ----- | -------- | ----------- |
1049
- | forceRefresh | boolean | no | |
1050
-
1051
-
1052
-
1053
- Use this API to retrieve a list of cards stored by user from an active payment gateway.
1054
-
1055
- *Returned Response:*
1056
-
1057
-
1058
-
1059
-
1060
- [ListCardsResponse](#ListCardsResponse)
1061
-
1062
- Success. Returns a list of cards saved by the user. Check the example shown below or refer `ListCardsResponse` for more details.
1063
-
1064
-
1065
-
1066
-
1067
- <details>
1068
- <summary><i>&nbsp; Example:</i></summary>
1069
-
1070
- ```json
1071
- {
1072
- "success": true,
1073
- "message": "Success",
1074
- "data": [
1075
- {
1076
- "aggregator_name": "Razorpay",
1077
- "card_id": "token_lorem_ipsum_001",
1078
- "card_token": "card_token_lorem_ipsum_001",
1079
- "card_reference": "ref_lorem_ipsum_001",
1080
- "card_number": "XXXX-XXXX-XXXX-1111",
1081
- "card_isin": "001",
1082
- "exp_year": 2025,
1083
- "exp_month": 5,
1084
- "card_type": "credit",
1085
- "card_issuer": "ICIC",
1086
- "card_brand": "VISA",
1087
- "nickname": "Visa",
1088
- "card_name": "Lorem Ipsum",
1089
- "expired": false,
1090
- "card_fingerprint": null,
1091
- "card_brand_image": "https://hdn-1.fynd.com/payment/visa.png",
1092
- "compliant_with_tokenisation_guidelines": true
1093
- }
1094
- ]
1095
- }
1096
- ```
1097
- </details>
1098
-
1099
-
1100
-
1101
-
1102
-
1103
-
1104
-
1105
-
1106
-
1107
- ---
1108
-
1109
-
1110
- ### getAggregatorsConfig
1111
- Get payment gateway keys
1112
-
1113
-
1114
-
1115
- ```javascript
1116
- // Promise
1117
- const promise = payment.getAggregatorsConfig({ xApiToken : value,
1118
- refresh : value });
1119
-
1120
- // Async/Await
1121
- const data = await payment.getAggregatorsConfig({ xApiToken : value,
1122
- refresh : value });
1123
- ```
1124
-
1125
-
1126
-
1127
-
1128
-
1129
- | Argument | Type | Required | Description |
1130
- | --------- | ----- | -------- | ----------- |
1131
- | xApiToken | string | no | Used for basic authentication. |
1132
- | refresh | boolean | no | This is a boolean value. Select `true` to remove temporary cache files on payment gateway and replace with the latest one. |
1133
-
1134
-
1135
-
1136
- Use this API to retrieve the payment gateway key, secrets, merchant, SDK/API details to complete a payment at front-end.
1137
-
1138
- *Returned Response:*
1139
-
1140
-
1141
-
1142
-
1143
- [AggregatorsConfigDetailResponse](#AggregatorsConfigDetailResponse)
1144
-
1145
- Success. Returns the keys of all payment gateways. Check the example shown below or refer `AggregatorsConfigDetailResponse` for more details.
1146
-
1147
-
1148
-
1149
-
1150
- <details>
1151
- <summary><i>&nbsp; Example:</i></summary>
1152
-
1153
- ```json
1154
- {
1155
- "simpl": {
1156
- "key": "bf9d0ff65ffe6e54223a871e733bbd1c",
1157
- "secret": "XXXX-XXXX-XXXX-XXXX",
1158
- "config_type": "fynd",
1159
- "sdk": true
1160
- },
1161
- "juspay": {
1162
- "key": "XXXX-XXXX-XXXX-XXXX",
1163
- "secret": "XXXX-XXXX-XXXX-XXXX",
1164
- "config_type": "fynd",
1165
- "merchant_key": "XXXX-XXXX-XXXX-XXXX",
1166
- "sdk": false,
1167
- "api": "https://api.juspay.in"
1168
- },
1169
- "mswipe": {
1170
- "key": "XXXX-XXXX-XXXX-XXXX",
1171
- "secret": "XXXX-XXXX-XXXX-XXXX",
1172
- "config_type": "fynd",
1173
- "merchant_id": "XXXX-XXXX-XXXX-XXXX",
1174
- "user_id": "XXXX-XXXX-XXXX-XXXX",
1175
- "pin": "XXXX-XXXX-XXXX-XXXX",
1176
- "sdk": true,
1177
- "verify_api": "https://www.mswipetech.com/verificationapi/api/VerificationApi/MswipeCardSaleVerificationApi"
1178
- },
1179
- "razorpay": {
1180
- "key": "XXXX-XXXX-XXXX-XXXX",
1181
- "secret": "XXXX-XXXX-XXXX-XXXX",
1182
- "config_type": "fynd",
1183
- "webhook_secret": "XXXX-XXXX-XXXX-XXXX",
1184
- "sdk": true,
1185
- "api": "https://api.razorpay.com/v1/",
1186
- "vpa": "XXXX-XXXX-XXXX-XXXX"
1187
- },
1188
- "success": true,
1189
- "env": "live"
1190
- }
1191
- ```
1192
- </details>
1193
-
1194
-
1195
-
1196
-
1197
-
1198
-
1199
-
1200
-
1201
-
1202
- ---
1203
-
1204
-
1205
- ### getEpaylaterBannerDetails
1206
- Get Epaylater Enabled
1207
-
1208
-
1209
-
1210
- ```javascript
1211
- // Promise
1212
- const promise = payment.getEpaylaterBannerDetails();
1213
-
1214
- // Async/Await
1215
- const data = await payment.getEpaylaterBannerDetails();
1216
- ```
1217
-
1218
-
1219
-
1220
-
1221
-
1222
-
1223
- Get Epaylater Enabled if user is tentatively approved by epaylater
1224
-
1225
- *Returned Response:*
1226
-
1227
-
1228
-
1229
-
1230
- [EpaylaterBannerResponse](#EpaylaterBannerResponse)
1231
-
1232
- Success. Return Epaylater Offer detail. Check the example shown below or refer `EpaylaterBannerResponseSchema` for more details. if `display=True`, then show banner otherwise do not show.
1233
-
1234
-
1235
-
1236
-
1237
- <details>
1238
- <summary><i>&nbsp; Examples:</i></summary>
1239
-
1240
-
1241
- <details>
1242
- <summary><i>&nbsp; User is registered successfully</i></summary>
1243
-
1244
- ```json
1245
- {
1246
- "value": {
1247
- "success": true,
1248
- "data": {
1249
- "display": false,
1250
- "message": "User is Active",
1251
- "status": "ACTIVE"
1252
- }
1253
- }
1254
- }
1255
- ```
1256
- </details>
1257
-
1258
- <details>
1259
- <summary><i>&nbsp; User is not registered or KYC not done or approval pending</i></summary>
1260
-
1261
- ```json
1262
- {
1263
- "value": {
1264
- "success": true,
1265
- "data": {
1266
- "display": true,
1267
- "message": "User is not registered",
1268
- "status": "NOT REGISTERED"
1269
- }
1270
- }
1271
- }
1272
- ```
1273
- </details>
1274
-
1275
- </details>
1276
-
1277
-
1278
-
1279
-
1280
-
1281
-
1282
-
1283
-
1284
-
1285
- ---
1286
-
1287
-
1288
- ### getOrderBeneficiariesDetail
1289
- Lists the beneficiary of a refund
1290
-
1291
-
1292
-
1293
- ```javascript
1294
- // Promise
1295
- const promise = payment.getOrderBeneficiariesDetail({ orderId : value });
1296
-
1297
- // Async/Await
1298
- const data = await payment.getOrderBeneficiariesDetail({ orderId : value });
1299
- ```
1300
-
1301
-
1302
-
1303
-
1304
-
1305
- | Argument | Type | Required | Description |
1306
- | --------- | ----- | -------- | ----------- |
1307
- | orderId | string | yes | A unique number used for identifying and tracking your orders. |
1308
-
1309
-
1310
-
1311
- Use this API to get the details of all active beneficiary added by a user for refund.
1312
-
1313
- *Returned Response:*
1314
-
1315
-
1316
-
1317
-
1318
- [OrderBeneficiaryResponse](#OrderBeneficiaryResponse)
1319
-
1320
- Success. Returns the details of the beneficiary getting a refund. Check the example shown below or refer `OrderBeneficiaryResponse` for more details.
1321
-
1322
-
1323
-
1324
-
1325
- <details>
1326
- <summary><i>&nbsp; Example:</i></summary>
1327
-
1328
- ```json
1329
- {
1330
- "beneficiaries": [
1331
- {
1332
- "id": 3695,
1333
- "beneficiary_id": "4c86dd56e634a4c6a8fb51d195bc7b83",
1334
- "bank_name": "State Bank of India",
1335
- "branch_name": "BHOGAT",
1336
- "account_holder": "PRAKASH TEST",
1337
- "account_no": "3566342455454",
1338
- "ifsc_code": "SBIN0014982",
1339
- "mobile": "7819064010",
1340
- "email": "prakashtest@gmail.com",
1341
- "address": "49A, Dabhi seri, jodhpur, kalyanpur",
1342
- "comment": "COD Refund",
1343
- "is_active": null,
1344
- "created_on": "2021-01-22 11:31:02",
1345
- "modified_on": "2021-01-22 11:31:02",
1346
- "display_name": "BANK",
1347
- "transfer_mode": "bank",
1348
- "title": "Bank Account",
1349
- "subtitle": "35663423659",
1350
- "delights_user_name": "shreeniwas_24x7_gmail_com_45978_16624463"
1351
- }
1352
- ]
1353
- }
1354
- ```
1355
- </details>
1356
-
1357
-
1358
-
1359
-
1360
-
1361
-
1362
-
1363
-
1364
-
1365
- ---
1366
-
1367
-
1368
- ### getPaymentLink
1369
- Get payment link
1370
-
1371
-
1372
-
1373
- ```javascript
1374
- // Promise
1375
- const promise = payment.getPaymentLink({ paymentLinkId : value });
1376
-
1377
- // Async/Await
1378
- const data = await payment.getPaymentLink({ paymentLinkId : value });
1379
- ```
1380
-
1381
-
1382
-
1383
-
1384
-
1385
- | Argument | Type | Required | Description |
1386
- | --------- | ----- | -------- | ----------- |
1387
- | paymentLinkId | string | no | |
1388
-
1389
-
1390
-
1391
- Use this API to get a payment link
1392
-
1393
- *Returned Response:*
1394
-
1395
-
1396
-
1397
-
1398
- [GetPaymentLinkResponse](#GetPaymentLinkResponse)
1399
-
1400
- Success. Check the example shown below
1401
-
1402
-
1403
-
1404
-
1405
- <details>
1406
- <summary><i>&nbsp; Example:</i></summary>
1407
-
1408
- ```json
1409
- {
1410
- "success": true,
1411
- "message": "Payment link",
1412
- "status_code": 200,
1413
- "payment_link_current_status": "resent",
1414
- "payment_link_url": "https://api.fyndx0.de/service/application/payment/v1.0/payment/options/link/?id=4adb4451720a82ee69a3c1c4cc9ab442&refresh=false",
1415
- "external_order_id": "FY62614DF9D5CF31D3D0",
1416
- "amount": 21900,
1417
- "merchant_name": "Fynd",
1418
- "polling_timeout": 1800
1419
- }
1420
- ```
1421
- </details>
1422
-
1423
-
1424
-
1425
-
1426
-
1427
-
1428
-
1429
-
1430
-
1431
- ---
1432
-
1433
-
1434
- ### getPaymentModeRoutes
1435
- Get applicable payment options
1436
-
1437
-
1438
-
1439
- ```javascript
1440
- // Promise
1441
- const promise = payment.getPaymentModeRoutes({ amount : value,
1442
- cartId : value,
1443
- pincode : value,
1444
- checkoutMode : value,
1445
- refresh : value,
1446
- cardReference : value,
1447
- userDetails : value });
1448
-
1449
- // Async/Await
1450
- const data = await payment.getPaymentModeRoutes({ amount : value,
1451
- cartId : value,
1452
- pincode : value,
1453
- checkoutMode : value,
1454
- refresh : value,
1455
- cardReference : value,
1456
- userDetails : value });
1457
- ```
1458
-
1459
-
1460
-
1461
-
1462
-
1463
- | Argument | Type | Required | Description |
1464
- | --------- | ----- | -------- | ----------- |
1465
- | amount | number | yes | Payable amount. |
1466
- | cartId | string | yes | Identifier of the cart. |
1467
- | pincode | string | yes | The PIN Code of the destination address, e.g. 400059 |
1468
- | checkoutMode | string | yes | Option to checkout for self or for others. |
1469
- | refresh | boolean | no | This is a boolean value. Select `true` to remove temporary cache files on payment gateway and replace with the latest one. |
1470
- | cardReference | string | no | Card reference id of user's debit or credit card. |
1471
- | userDetails | string | no | URIencoded JSON containing details of an anonymous user. |
1472
-
1473
-
1474
-
1475
- Use this API to get all valid payment options for doing a payment.
1476
-
1477
- *Returned Response:*
1478
-
1479
-
1480
-
1481
-
1482
- [PaymentModeRouteResponse](#PaymentModeRouteResponse)
1483
-
1484
- Success. Returns all available options for payment. Check the example shown below or refer `PaymentModeRouteResponse` for more details.
1485
-
1486
-
1487
-
1488
-
1489
- <details>
1490
- <summary><i>&nbsp; Example:</i></summary>
1491
-
1492
- ```json
1493
- {
1494
- "success": true,
1495
- "payment_options": {
1496
- "payment_option": [
1497
- {
1498
- "name": "COD",
1499
- "display_name": "Cash on Delivery",
1500
- "display_priority": 1,
1501
- "payment_mode_id": 11,
1502
- "aggregator_name": "Fynd",
1503
- "logo": "https://hdn-1.fynd.com/payment/cod.png",
1504
- "logo_url": {
1505
- "small": "https://hdn-1.fynd.com/payment/cod.png",
1506
- "large": "https://hdn-1.fynd.com/payment/cod.png"
1507
- },
1508
- "list": [
1509
- {
1510
- "cod_limit": 1000,
1511
- "remaining_limit": 100
1512
- }
1513
- ]
1514
- },
1515
- {
1516
- "name": "CARD",
1517
- "display_priority": 2,
1518
- "payment_mode_id": 2,
1519
- "display_name": "Card",
1520
- "list": [],
1521
- "anonymous_enable": true,
1522
- "aggregator_name": "Razorpay",
1523
- "add_card_enabled": false,
1524
- "save_card": true
1525
- },
1526
- {
1527
- "name": "NB",
1528
- "display_priority": 3,
1529
- "payment_mode_id": 3,
1530
- "display_name": "Net Banking",
1531
- "list": [
1532
- {
1533
- "aggregator_name": "Razorpay",
1534
- "name": "ICICI Bank",
1535
- "code": "ICIC",
1536
- "bank_name": "ICICI Bank",
1537
- "bank_code": "ICIC",
1538
- "url": "https://hdn-1.fynd.com/payment/NB_ICICI.png",
1539
- "logo_url": {
1540
- "small": "https://hdn-1.fynd.com/payment/NB_ICICI.png",
1541
- "large": "https://hdn-1.fynd.com/payment/NB_ICICI.png"
1542
- },
1543
- "merchant_code": "NB_ICICI",
1544
- "display_priority": 1,
1545
- "display_name": "ICICI Bank"
1546
- },
1547
- {
1548
- "aggregator_name": "Razorpay",
1549
- "name": "HDFC Bank",
1550
- "code": "HDFC",
1551
- "bank_name": "HDFC Bank",
1552
- "bank_code": "HDFC",
1553
- "url": "https://hdn-1.fynd.com/payment/NB_HDFC.png",
1554
- "logo_url": {
1555
- "small": "https://hdn-1.fynd.com/payment/NB_HDFC.png",
1556
- "large": "https://hdn-1.fynd.com/payment/NB_HDFC.png"
1557
- },
1558
- "merchant_code": "NB_HDFC",
1559
- "display_priority": 2,
1560
- "display_name": "HDFC Bank"
1561
- },
1562
- {
1563
- "aggregator_name": "Razorpay",
1564
- "name": "Axis Bank",
1565
- "code": "UTIB",
1566
- "bank_name": "Axis Bank",
1567
- "bank_code": "UTIB",
1568
- "url": "https://hdn-1.fynd.com/payment/NB_AXIS.png",
1569
- "logo_url": {
1570
- "small": "https://hdn-1.fynd.com/payment/NB_AXIS.png",
1571
- "large": "https://hdn-1.fynd.com/payment/NB_AXIS.png"
1572
- },
1573
- "merchant_code": "NB_AXIS",
1574
- "display_priority": 3,
1575
- "display_name": "Axis Bank"
1576
- },
1577
- {
1578
- "aggregator_name": "Razorpay",
1579
- "name": "State Bank of India",
1580
- "code": "SBIN",
1581
- "bank_name": "State Bank of India",
1582
- "bank_code": "SBIN",
1583
- "url": "https://hdn-1.fynd.com/payment/NB_SBI.png",
1584
- "logo_url": {
1585
- "small": "https://hdn-1.fynd.com/payment/NB_SBI.png",
1586
- "large": "https://hdn-1.fynd.com/payment/NB_SBI.png"
1587
- },
1588
- "merchant_code": "NB_SBI",
1589
- "display_priority": 4,
1590
- "display_name": "State Bank of India"
1591
- },
1592
- {
1593
- "aggregator_name": "Razorpay",
1594
- "name": "Kotak Mahindra Bank",
1595
- "code": "KKBK",
1596
- "bank_name": "Kotak Mahindra Bank",
1597
- "bank_code": "KKBK",
1598
- "url": "https://hdn-1.fynd.com/payment/NB_KOTAK.png",
1599
- "logo_url": {
1600
- "small": "https://hdn-1.fynd.com/payment/NB_KOTAK.png",
1601
- "large": "https://hdn-1.fynd.com/payment/NB_KOTAK.png"
1602
- },
1603
- "merchant_code": "NB_KOTAK",
1604
- "display_priority": 5,
1605
- "display_name": "Kotak Mahindra Bank"
1606
- },
1607
- {
1608
- "aggregator_name": "Razorpay",
1609
- "name": "Indusind Bank",
1610
- "code": "INDB",
1611
- "bank_name": "Indusind Bank",
1612
- "bank_code": "INDB",
1613
- "url": "https://hdn-1.fynd.com/payment/NB_INDUS.png",
1614
- "logo_url": {
1615
- "small": "https://hdn-1.fynd.com/payment/NB_INDUS.png",
1616
- "large": "https://hdn-1.fynd.com/payment/NB_INDUS.png"
1617
- },
1618
- "merchant_code": "INDB",
1619
- "display_priority": 6,
1620
- "display_name": "Indusind Bank"
1621
- },
1622
- {
1623
- "aggregator_name": "Razorpay",
1624
- "name": "City Union Bank",
1625
- "code": "CIUB",
1626
- "bank_name": "City Union Bank",
1627
- "bank_code": "CIUB",
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": "NB_CUB",
1634
- "display_priority": 9,
1635
- "display_name": "City Union Bank"
1636
- },
1637
- {
1638
- "aggregator_name": "Razorpay",
1639
- "name": "Catholic Syrian Bank",
1640
- "code": "CSBK",
1641
- "bank_name": "Catholic Syrian Bank",
1642
- "bank_code": "CSBK",
1643
- "url": "https://hdn-1.fynd.com/payment/NB_generic.png",
1644
- "logo_url": {
1645
- "small": "https://hdn-1.fynd.com/payment/NB_generic.png",
1646
- "large": "https://hdn-1.fynd.com/payment/NB_generic.png"
1647
- },
1648
- "merchant_code": "CSBK",
1649
- "display_priority": 11,
1650
- "display_name": "Catholic Syrian Bank"
1651
- },
1652
- {
1653
- "aggregator_name": "Razorpay",
1654
- "name": "State Bank of Hyderabad",
1655
- "code": "SBHY",
1656
- "bank_name": "State Bank of Hyderabad",
1657
- "bank_code": "SBHY",
1658
- "url": "https://hdn-1.fynd.com/payment/NB_generic.png",
1659
- "logo_url": {
1660
- "small": "https://hdn-1.fynd.com/payment/NB_generic.png",
1661
- "large": "https://hdn-1.fynd.com/payment/NB_generic.png"
1662
- },
1663
- "merchant_code": "NB_SBH",
1664
- "display_priority": 12,
1665
- "display_name": "State Bank of Hyderabad"
1666
- },
1667
- {
1668
- "aggregator_name": "Razorpay",
1669
- "name": "Allahabad Bank",
1670
- "code": "ALLA",
1671
- "bank_name": "Allahabad Bank",
1672
- "bank_code": "ALLA",
1673
- "url": "https://hdn-1.fynd.com/payment/NB_generic.png",
1674
- "logo_url": {
1675
- "small": "https://hdn-1.fynd.com/payment/NB_generic.png",
1676
- "large": "https://hdn-1.fynd.com/payment/NB_generic.png"
1677
- },
1678
- "merchant_code": "ALLA",
1679
- "display_priority": 15,
1680
- "display_name": "Allahabad Bank"
1681
- },
1682
- {
1683
- "aggregator_name": "Razorpay",
1684
- "name": "Syndicate Bank",
1685
- "code": "SYNB",
1686
- "bank_name": "Syndicate Bank",
1687
- "bank_code": "SYNB",
1688
- "url": "https://hdn-1.fynd.com/payment/NB_generic.png",
1689
- "logo_url": {
1690
- "small": "https://hdn-1.fynd.com/payment/NB_generic.png",
1691
- "large": "https://hdn-1.fynd.com/payment/NB_generic.png"
1692
- },
1693
- "merchant_code": "SYNB",
1694
- "display_priority": 17,
1695
- "display_name": "Syndicate Bank"
1696
- }
1697
- ]
1698
- },
1699
- {
1700
- "name": "WL",
1701
- "display_priority": 4,
1702
- "payment_mode_id": 4,
1703
- "display_name": "Wallet",
1704
- "list": [
1705
- {
1706
- "wallet_name": "Paytm",
1707
- "wallet_code": "paytm",
1708
- "name": "Paytm",
1709
- "display_name": "Paytm",
1710
- "code": "paytm",
1711
- "wallet_id": 4,
1712
- "merchant_code": "PAYTM",
1713
- "logo_url": {
1714
- "small": "https://hdn-1.fynd.com/payment/paytm_logo_small.png",
1715
- "large": "https://hdn-1.fynd.com/payment/paytm_logo_large.png"
1716
- },
1717
- "aggregator_name": "Juspay",
1718
- "display_priority": 1
1719
- },
1720
- {
1721
- "wallet_name": "Amazon Pay",
1722
- "wallet_code": "amazonpay",
1723
- "name": "Amazon Pay",
1724
- "display_name": "Amazon Pay",
1725
- "code": "amazonpay",
1726
- "wallet_id": 10,
1727
- "merchant_code": "AMAZONPAY",
1728
- "logo_url": {
1729
- "small": "https://hdn-1.fynd.com/payment/amazon-pay.png",
1730
- "large": "https://hdn-1.fynd.com/payment/amazon-pay.png"
1731
- },
1732
- "aggregator_name": "Razorpay",
1733
- "display_priority": 9
1734
- }
1735
- ]
1736
- },
1737
- {
1738
- "name": "UPI",
1739
- "display_priority": 9,
1740
- "payment_mode_id": 7,
1741
- "display_name": "UPI",
1742
- "list": [
1743
- {
1744
- "aggregator_name": "Razorpay",
1745
- "name": "UPI",
1746
- "display_name": "BHIM UPI",
1747
- "code": "UPI",
1748
- "logo_url": {
1749
- "small": "https://hdn-1.fynd.com/payment/upi_100x78.png",
1750
- "large": "https://hdn-1.fynd.com/payment/upi_150x100.png"
1751
- },
1752
- "merchant_code": "UPI",
1753
- "timeout": 310,
1754
- "retry_count": 0,
1755
- "fynd_vpa": "shopsense.rzp@hdfcbank",
1756
- "intent_flow": true,
1757
- "intent_app": [
1758
- {
1759
- "code": "google_pay",
1760
- "display_name": "Google Pay",
1761
- "package_name": "com.google.android.apps.nbu.paisa.user",
1762
- "logos": {
1763
- "small": "https://hdn-1.fynd.com/payment/upi-google-pay.png",
1764
- "large": "https://hdn-1.fynd.com/payment/upi-google-pay.png"
1765
- }
1766
- }
1767
- ],
1768
- "intent_app_error_list": [
1769
- "com.csam.icici.bank.imobile",
1770
- "in.org.npci.upiapp",
1771
- "com.whatsapp"
1772
- ],
1773
- "intent_app_error_dict_list": [
1774
- {
1775
- "package_name": "com.csam.icici.bank.imobile",
1776
- "code": "icici"
1777
- },
1778
- {
1779
- "package_name": "in.org.npci.upiapp",
1780
- "code": "upiapp"
1781
- },
1782
- {
1783
- "package_name": "com.whatsapp",
1784
- "code": "whatsapp"
1785
- }
1786
- ]
1787
- }
1788
- ]
1789
- },
1790
- {
1791
- "name": "JUSPAYPG",
1792
- "display_priority": 18,
1793
- "payment_mode_id": 24,
1794
- "display_name": "Pay Using Juspay",
1795
- "list": []
1796
- },
1797
- {
1798
- "name": "PL",
1799
- "display_priority": 21,
1800
- "display_name": "Pay Later",
1801
- "list": [
1802
- {
1803
- "aggregator_name": "Simpl",
1804
- "name": "Simpl",
1805
- "display_name": "Simpl",
1806
- "code": "simpl",
1807
- "merchant_code": "SIMPL",
1808
- "logo": "https://hdn-1.fynd.com/payment/simpl_logo.png",
1809
- "logo_url": {
1810
- "small": "https://hdn-1.fynd.com/payment/simpl_logo.png",
1811
- "large": "https://hdn-1.fynd.com/payment/simpl_logo.png"
1812
- }
1813
- },
1814
- {
1815
- "aggregator_name": "Potlee",
1816
- "name": "POTLEE",
1817
- "display_name": "Potlee",
1818
- "code": "POTLEE",
1819
- "merchant_code": "POTLEE",
1820
- "logo_url": {
1821
- "large": "https://hdn-1.fynd.com/payment/Potlee.png",
1822
- "small": "https://hdn-1.fynd.com/payment/Potlee.png"
1823
- }
1824
- }
1825
- ]
1826
- },
1827
- {
1828
- "name": "JIOPP",
1829
- "display_priority": 15,
1830
- "payment_mode_id": 15,
1831
- "display_name": "Jio Partner Pay",
1832
- "list": [
1833
- {
1834
- "aggregator_name": "Jio",
1835
- "name": "JioPP",
1836
- "display_name": "Jio Partner Pay",
1837
- "code": "JIOPP",
1838
- "logo_url": {
1839
- "large": "https://hdn-1.fynd.com/payment/Pos+Logo.png",
1840
- "small": "https://hdn-1.fynd.com/payment/Pos+Logo.png"
1841
- },
1842
- "merchant_code": "JIOPP"
1843
- }
1844
- ]
1845
- }
1846
- ],
1847
- "payment_flows": {
1848
- "simpl": {
1849
- "data": {
1850
- "gateway": {
1851
- "route": "simpl",
1852
- "entity": "sdk",
1853
- "is_customer_validation_required": true,
1854
- "cust_validation_url": "https://api.fyndx0.de/gringotts/api/v1/validate-customer/?app_id=000000000000000000000001",
1855
- "sdk": {
1856
- "config": {
1857
- "redirect": false,
1858
- "callback_url": null,
1859
- "action_url": "https://api.fyndx0.de/platform/payment/v2/external/payments/confirm/charge/?app_id=000000000000000000000001"
1860
- },
1861
- "data": {
1862
- "user_phone": "9999632145",
1863
- "user_email": "app@fynd.com"
1864
- }
1865
- },
1866
- "return_url": null
1867
- }
1868
- },
1869
- "api_link": "",
1870
- "payment_flow": "sdk",
1871
- "payment_flow_data": {
1872
- "is_customer_validation_required": true,
1873
- "cust_validation_url": "https://api.fyndx0.de/platform/payment/api/v1/validate-customer/?app_id=000000000000000000000001",
1874
- "config": {
1875
- "redirect": false,
1876
- "final_payment_action_url": "https://api.fyndx0.de/platform/payment/v2/external/payments/confirm/charge/?app_id=000000000000000000000001"
1877
- },
1878
- "data": {
1879
- "user_phone": null,
1880
- "user_email": null
1881
- },
1882
- "return_url": null
1883
- }
1884
- },
1885
- "potlee": {
1886
- "data": {
1887
- "gateway": {
1888
- "route": "potlee",
1889
- "entity": "api",
1890
- "is_customer_validation_required": true,
1891
- "cust_validation_url": "https://api.fyndx0.de/gringotts/api/v1/validate-customer/",
1892
- "return_url": null
1893
- },
1894
- "payment_flow_data": {
1895
- "is_customer_validation_required": true,
1896
- "cust_validation_url": "https://api.fyndx0.de/platform/payment/v2/external/payments/callback/",
1897
- "config": {
1898
- "redirect": true,
1899
- "final_payment_action_url": "https://api.fyndx0.de/platform/payment/v2/external/payments/callback/"
1900
- },
1901
- "return_url": null
1902
- }
1903
- },
1904
- "api_link": "",
1905
- "payment_flow": "api",
1906
- "payment_flow_data": {
1907
- "return_url": null,
1908
- "cust_validation_url": "https://api.fyndx0.de/gringotts/api/v1/validate-customer/",
1909
- "is_customer_validation_required": true
1910
- }
1911
- },
1912
- "mswipe": {
1913
- "data": {
1914
- "gateway": {
1915
- "sdk": {
1916
- "config": {
1917
- "redirect": false,
1918
- "action_url": "url",
1919
- "webhook_url": "url",
1920
- "timeout": 60
1921
- }
1922
- }
1923
- }
1924
- },
1925
- "api_link": "",
1926
- "payment_flow": "sdk"
1927
- },
1928
- "juspay": {
1929
- "data": {},
1930
- "api_link": "https://sandbox.juspay.in/txns",
1931
- "payment_flow": "api"
1932
- },
1933
- "razorpay": {
1934
- "data": {},
1935
- "api_link": "",
1936
- "payment_flow": "sdk"
1937
- },
1938
- "bqr_razorpay": {
1939
- "data": {},
1940
- "api_link": "https://api.fyndx0.de/platform/payment/v2/external/payments/request/?app_id=000000000000000000000001",
1941
- "payment_flow": "api"
1942
- },
1943
- "fynd": {
1944
- "data": {},
1945
- "api_link": "",
1946
- "payment_flow": "api"
1947
- },
1948
- "jio": {
1949
- "data": {},
1950
- "api_link": "",
1951
- "payment_flow": "api"
1952
- },
1953
- "stripe": {
1954
- "data": {},
1955
- "api_link": "",
1956
- "payment_flow": "sdk"
1957
- },
1958
- "ccavenue": {
1959
- "data": {},
1960
- "api_link": "",
1961
- "payment_flow": "sdk"
1962
- },
1963
- "payumoney": {
1964
- "data": {},
1965
- "api_link": "",
1966
- "payment_flow": "sdk"
1967
- },
1968
- "rupifi": {
1969
- "data": {},
1970
- "api_link": "",
1971
- "return_url": "",
1972
- "payment_flow": "api",
1973
- "cust_validation_url": "https://api.jiox0.de/gringotts/api/v1/validate-customer/",
1974
- "payment_flow_data": {
1975
- "is_customer_validation_required": true,
1976
- "cust_validation_url": "https://api.fyndx0.de/platform/payment/api/v1/validate-customer/?app_id=000000000000000000000001",
1977
- "config": {
1978
- "redirect": false,
1979
- "final_payment_action_url": "https://api.fyndx0.de/platform/payment/v2/external/payments/confirm/charge/?app_id=000000000000000000000001"
1980
- },
1981
- "data": {
1982
- "user_phone": null,
1983
- "user_email": null
1984
- },
1985
- "return_url": null
1986
- }
1987
- },
1988
- "jiopay": {
1989
- "api_link": "http://psp-mandate-merchant-sit.jiomoney.com:3003/pg",
1990
- "payment_flow": "api",
1991
- "data": {}
1992
- },
1993
- "epaylater": {
1994
- "data": {},
1995
- "api_link": "https://api-blackbox.epaylater.in/web/process-transaction/",
1996
- "payment_flow": "api"
1997
- },
1998
- "Jio": {
1999
- "data": {},
2000
- "api_link": "",
2001
- "payment_flow": "api"
2002
- }
2003
- }
2004
- }
2005
- }
2006
- ```
2007
- </details>
2008
-
2009
-
2010
-
2011
-
2012
-
2013
-
2014
-
2015
-
2016
-
2017
- ---
2018
-
2019
-
2020
- ### getPaymentModeRoutesPaymentLink
2021
- Get applicable payment options for payment link
2022
-
2023
-
2024
-
2025
- ```javascript
2026
- // Promise
2027
- const promise = payment.getPaymentModeRoutesPaymentLink({ paymentLinkId : value });
2028
-
2029
- // Async/Await
2030
- const data = await payment.getPaymentModeRoutesPaymentLink({ paymentLinkId : value });
2031
- ```
2032
-
2033
-
2034
-
2035
-
2036
-
2037
- | Argument | Type | Required | Description |
2038
- | --------- | ----- | -------- | ----------- |
2039
- | paymentLinkId | string | yes | Payment link id |
2040
-
2041
-
2042
-
2043
- Use this API to get all valid payment options for doing a payment through payment link
2044
-
2045
- *Returned Response:*
2046
-
2047
-
2048
-
2049
-
2050
- [PaymentModeRouteResponse](#PaymentModeRouteResponse)
2051
-
2052
- Success. Returns all available options for payment. Check the example shown below or refer `PaymentModeRouteResponse` for more details.
2053
-
2054
-
2055
-
2056
-
2057
- <details>
2058
- <summary><i>&nbsp; Example:</i></summary>
2059
-
2060
- ```json
2061
- {
2062
- "success": true,
2063
- "payment_options": {
2064
- "payment_option": [
2065
- {
2066
- "name": "CARD",
2067
- "display_priority": 2,
2068
- "payment_mode_id": 2,
2069
- "display_name": "Card",
2070
- "list": [],
2071
- "anonymous_enable": true,
2072
- "aggregator_name": "Razorpay",
2073
- "add_card_enabled": false,
2074
- "is_pay_by_card_pl": true
2075
- },
2076
- {
2077
- "name": "NB",
2078
- "display_priority": 3,
2079
- "payment_mode_id": 3,
2080
- "display_name": "Net Banking",
2081
- "list": [
2082
- {
2083
- "aggregator_name": "Razorpay",
2084
- "name": "ICICI Bank",
2085
- "code": "ICIC",
2086
- "bank_name": "ICICI Bank",
2087
- "bank_code": "ICIC",
2088
- "url": "https://hdn-1.fynd.com/payment/NB_ICICI.png",
2089
- "logo_url": {
2090
- "small": "https://hdn-1.fynd.com/payment/NB_ICICI.png",
2091
- "large": "https://hdn-1.fynd.com/payment/NB_ICICI.png"
2092
- },
2093
- "merchant_code": "NB_ICICI",
2094
- "display_priority": 1,
2095
- "display_name": "ICICI Bank"
2096
- },
2097
- {
2098
- "aggregator_name": "Razorpay",
2099
- "name": "HDFC Bank",
2100
- "code": "HDFC",
2101
- "bank_name": "HDFC Bank",
2102
- "bank_code": "HDFC",
2103
- "url": "https://hdn-1.fynd.com/payment/NB_HDFC.png",
2104
- "logo_url": {
2105
- "small": "https://hdn-1.fynd.com/payment/NB_HDFC.png",
2106
- "large": "https://hdn-1.fynd.com/payment/NB_HDFC.png"
2107
- },
2108
- "merchant_code": "NB_HDFC",
2109
- "display_priority": 2,
2110
- "display_name": "HDFC Bank"
2111
- },
2112
- {
2113
- "aggregator_name": "Razorpay",
2114
- "name": "Axis Bank",
2115
- "code": "UTIB",
2116
- "bank_name": "Axis Bank",
2117
- "bank_code": "UTIB",
2118
- "url": "https://hdn-1.fynd.com/payment/NB_AXIS.png",
2119
- "logo_url": {
2120
- "small": "https://hdn-1.fynd.com/payment/NB_AXIS.png",
2121
- "large": "https://hdn-1.fynd.com/payment/NB_AXIS.png"
2122
- },
2123
- "merchant_code": "NB_AXIS",
2124
- "display_priority": 3,
2125
- "display_name": "Axis Bank"
2126
- },
2127
- {
2128
- "aggregator_name": "Razorpay",
2129
- "name": "State Bank of India",
2130
- "code": "SBIN",
2131
- "bank_name": "State Bank of India",
2132
- "bank_code": "SBIN",
2133
- "url": "https://hdn-1.fynd.com/payment/NB_SBI.png",
2134
- "logo_url": {
2135
- "small": "https://hdn-1.fynd.com/payment/NB_SBI.png",
2136
- "large": "https://hdn-1.fynd.com/payment/NB_SBI.png"
2137
- },
2138
- "merchant_code": "NB_SBI",
2139
- "display_priority": 4,
2140
- "display_name": "State Bank of India"
2141
- },
2142
- {
2143
- "aggregator_name": "Razorpay",
2144
- "name": "Kotak Mahindra Bank",
2145
- "code": "KKBK",
2146
- "bank_name": "Kotak Mahindra Bank",
2147
- "bank_code": "KKBK",
2148
- "url": "https://hdn-1.fynd.com/payment/NB_KOTAK.png",
2149
- "logo_url": {
2150
- "small": "https://hdn-1.fynd.com/payment/NB_KOTAK.png",
2151
- "large": "https://hdn-1.fynd.com/payment/NB_KOTAK.png"
2152
- },
2153
- "merchant_code": "NB_KOTAK",
2154
- "display_priority": 5,
2155
- "display_name": "Kotak Mahindra Bank"
2156
- },
2157
- {
2158
- "aggregator_name": "Razorpay",
2159
- "name": "Indusind Bank",
2160
- "code": "INDB",
2161
- "bank_name": "Indusind Bank",
2162
- "bank_code": "INDB",
2163
- "url": "https://hdn-1.fynd.com/payment/NB_INDUS.png",
2164
- "logo_url": {
2165
- "small": "https://hdn-1.fynd.com/payment/NB_INDUS.png",
2166
- "large": "https://hdn-1.fynd.com/payment/NB_INDUS.png"
2167
- },
2168
- "merchant_code": "INDB",
2169
- "display_priority": 6,
2170
- "display_name": "Indusind Bank"
2171
- },
2172
- {
2173
- "aggregator_name": "Razorpay",
2174
- "name": "City Union Bank",
2175
- "code": "CIUB",
2176
- "bank_name": "City Union Bank",
2177
- "bank_code": "CIUB",
2178
- "url": "https://hdn-1.fynd.com/payment/NB_generic.png",
2179
- "logo_url": {
2180
- "small": "https://hdn-1.fynd.com/payment/NB_generic.png",
2181
- "large": "https://hdn-1.fynd.com/payment/NB_generic.png"
2182
- },
2183
- "merchant_code": "NB_CUB",
2184
- "display_priority": 9,
2185
- "display_name": "City Union Bank"
2186
- },
2187
- {
2188
- "aggregator_name": "Razorpay",
2189
- "name": "Catholic Syrian Bank",
2190
- "code": "CSBK",
2191
- "bank_name": "Catholic Syrian Bank",
2192
- "bank_code": "CSBK",
2193
- "url": "https://hdn-1.fynd.com/payment/NB_generic.png",
2194
- "logo_url": {
2195
- "small": "https://hdn-1.fynd.com/payment/NB_generic.png",
2196
- "large": "https://hdn-1.fynd.com/payment/NB_generic.png"
2197
- },
2198
- "merchant_code": "CSBK",
2199
- "display_priority": 11,
2200
- "display_name": "Catholic Syrian Bank"
2201
- },
2202
- {
2203
- "aggregator_name": "Razorpay",
2204
- "name": "State Bank of Hyderabad",
2205
- "code": "SBHY",
2206
- "bank_name": "State Bank of Hyderabad",
2207
- "bank_code": "SBHY",
2208
- "url": "https://hdn-1.fynd.com/payment/NB_generic.png",
2209
- "logo_url": {
2210
- "small": "https://hdn-1.fynd.com/payment/NB_generic.png",
2211
- "large": "https://hdn-1.fynd.com/payment/NB_generic.png"
2212
- },
2213
- "merchant_code": "NB_SBH",
2214
- "display_priority": 12,
2215
- "display_name": "State Bank of Hyderabad"
2216
- },
2217
- {
2218
- "aggregator_name": "Razorpay",
2219
- "name": "Allahabad Bank",
2220
- "code": "ALLA",
2221
- "bank_name": "Allahabad Bank",
2222
- "bank_code": "ALLA",
2223
- "url": "https://hdn-1.fynd.com/payment/NB_generic.png",
2224
- "logo_url": {
2225
- "small": "https://hdn-1.fynd.com/payment/NB_generic.png",
2226
- "large": "https://hdn-1.fynd.com/payment/NB_generic.png"
2227
- },
2228
- "merchant_code": "ALLA",
2229
- "display_priority": 15,
2230
- "display_name": "Allahabad Bank"
2231
- },
2232
- {
2233
- "aggregator_name": "Razorpay",
2234
- "name": "Syndicate Bank",
2235
- "code": "SYNB",
2236
- "bank_name": "Syndicate Bank",
2237
- "bank_code": "SYNB",
2238
- "url": "https://hdn-1.fynd.com/payment/NB_generic.png",
2239
- "logo_url": {
2240
- "small": "https://hdn-1.fynd.com/payment/NB_generic.png",
2241
- "large": "https://hdn-1.fynd.com/payment/NB_generic.png"
2242
- },
2243
- "merchant_code": "SYNB",
2244
- "display_priority": 17,
2245
- "display_name": "Syndicate Bank"
2246
- }
2247
- ]
2248
- },
2249
- {
2250
- "name": "WL",
2251
- "display_priority": 4,
2252
- "payment_mode_id": 4,
2253
- "display_name": "Wallet",
2254
- "list": [
2255
- {
2256
- "wallet_name": "Paytm",
2257
- "wallet_code": "paytm",
2258
- "name": "Paytm",
2259
- "display_name": "Paytm",
2260
- "code": "paytm",
2261
- "wallet_id": 4,
2262
- "merchant_code": "PAYTM",
2263
- "logo_url": {
2264
- "small": "https://hdn-1.fynd.com/payment/paytm_logo_small.png",
2265
- "large": "https://hdn-1.fynd.com/payment/paytm_logo_large.png"
2266
- },
2267
- "aggregator_name": "Juspay",
2268
- "display_priority": 1
2269
- },
2270
- {
2271
- "wallet_name": "Amazon Pay",
2272
- "wallet_code": "amazonpay",
2273
- "name": "Amazon Pay",
2274
- "display_name": "Amazon Pay",
2275
- "code": "amazonpay",
2276
- "wallet_id": 10,
2277
- "merchant_code": "AMAZONPAY",
2278
- "logo_url": {
2279
- "small": "https://hdn-1.fynd.com/payment/amazon-pay.png",
2280
- "large": "https://hdn-1.fynd.com/payment/amazon-pay.png"
2281
- },
2282
- "aggregator_name": "Razorpay",
2283
- "display_priority": 9
2284
- }
2285
- ]
2286
- },
2287
- {
2288
- "name": "UPI",
2289
- "display_priority": 9,
2290
- "payment_mode_id": 7,
2291
- "display_name": "UPI",
2292
- "list": [
2293
- {
2294
- "aggregator_name": "Razorpay",
2295
- "name": "UPI",
2296
- "display_name": "BHIM UPI",
2297
- "code": "UPI",
2298
- "logo_url": {
2299
- "small": "https://hdn-1.fynd.com/payment/upi_100x78.png",
2300
- "large": "https://hdn-1.fynd.com/payment/upi_150x100.png"
2301
- },
2302
- "merchant_code": "UPI",
2303
- "timeout": 310,
2304
- "retry_count": 0,
2305
- "fynd_vpa": "shopsense.rzp@hdfcbank",
2306
- "intent_flow": true,
2307
- "intent_app": [
2308
- {
2309
- "code": "google_pay",
2310
- "display_name": "Google Pay",
2311
- "logos": {
2312
- "small": "https://hdn-1.fynd.com/payment/upi-google-pay.png",
2313
- "large": "https://hdn-1.fynd.com/payment/upi-google-pay.png"
2314
- }
2315
- }
2316
- ],
2317
- "intent_app_error_list": [
2318
- "com.csam.icici.bank.imobile",
2319
- "in.org.npci.upiapp",
2320
- "com.whatsapp"
2321
- ]
2322
- }
2323
- ]
2324
- },
2325
- {
2326
- "name": "JUSPAYPG",
2327
- "display_priority": 18,
2328
- "payment_mode_id": 24,
2329
- "display_name": "Pay Using Juspay",
2330
- "list": []
2331
- },
2332
- {
2333
- "name": "PL",
2334
- "display_priority": 21,
2335
- "display_name": "Pay Later",
2336
- "list": [
2337
- {
2338
- "aggregator_name": "Simpl",
2339
- "name": "Simpl",
2340
- "display_name": "Simpl",
2341
- "code": "simpl",
2342
- "merchant_code": "SIMPL",
2343
- "logo": "https://hdn-1.fynd.com/payment/simpl_logo.png",
2344
- "logo_url": {
2345
- "small": "https://hdn-1.fynd.com/payment/simpl_logo.png",
2346
- "large": "https://hdn-1.fynd.com/payment/simpl_logo.png"
2347
- }
2348
- }
2349
- ]
2350
- }
2351
- ],
2352
- "payment_flows": {
2353
- "simpl": {
2354
- "data": {
2355
- "gateway": {
2356
- "route": "simpl",
2357
- "entity": "sdk",
2358
- "is_customer_validation_required": true,
2359
- "cust_validation_url": "https://api.fyndx0.de/gringotts/api/v1/validate-customer/?app_id=000000000000000000000001",
2360
- "sdk": {
2361
- "config": {
2362
- "redirect": false,
2363
- "callback_url": null,
2364
- "action_url": "https://api.fyndx0.de/platform/payment/v2/external/payments/confirm/charge/?app_id=000000000000000000000001"
2365
- },
2366
- "data": {
2367
- "user_phone": "9999632145",
2368
- "user_email": "app@fynd.com"
2369
- }
2370
- },
2371
- "return_url": null
2372
- }
2373
- },
2374
- "api_link": "",
2375
- "payment_flow": "sdk",
2376
- "payment_flow_data": {
2377
- "is_customer_validation_required": true,
2378
- "cust_validation_url": "https://api.fyndx0.de/platform/payment/api/v1/validate-customer/?app_id=000000000000000000000001",
2379
- "config": {
2380
- "redirect": false,
2381
- "final_payment_action_url": "https://api.fyndx0.de/platform/payment/v2/external/payments/confirm/charge/?app_id=000000000000000000000001"
2382
- },
2383
- "data": {
2384
- "user_phone": null,
2385
- "user_email": null
2386
- },
2387
- "return_url": null
2388
- }
2389
- },
2390
- "mswipe": {
2391
- "data": {
2392
- "gateway": {
2393
- "sdk": {
2394
- "config": {
2395
- "redirect": false,
2396
- "action_url": "url",
2397
- "webhook_url": "url",
2398
- "timeout": 60
2399
- }
2400
- }
2401
- }
2402
- },
2403
- "api_link": "",
2404
- "payment_flow": "sdk"
2405
- },
2406
- "juspay": {
2407
- "data": {},
2408
- "api_link": "https://sandbox.juspay.in/txns",
2409
- "payment_flow": "api"
2410
- },
2411
- "razorpay": {
2412
- "data": {},
2413
- "api_link": "",
2414
- "payment_flow": "sdk"
2415
- },
2416
- "bqr_razorpay": {
2417
- "data": {},
2418
- "api_link": "https://api.fyndx0.de/platform/payment/v2/external/payments/request/?app_id=000000000000000000000001",
2419
- "payment_flow": "api"
2420
- },
2421
- "fynd": {
2422
- "data": {},
2423
- "api_link": "",
2424
- "payment_flow": "api"
2425
- },
2426
- "jio": {
2427
- "data": {},
2428
- "api_link": "",
2429
- "payment_flow": "api"
2430
- },
2431
- "stripe": {
2432
- "data": {},
2433
- "api_link": "",
2434
- "payment_flow": "sdk"
2435
- },
2436
- "ccavenue": {
2437
- "data": {},
2438
- "api_link": "",
2439
- "payment_flow": "sdk"
2440
- },
2441
- "payumoney": {
2442
- "data": {},
2443
- "api_link": "",
2444
- "payment_flow": "sdk"
2445
- },
2446
- "rupifi": {
2447
- "data": {},
2448
- "api_link": "",
2449
- "return_url": "",
2450
- "payment_flow": "api",
2451
- "cust_validation_url": "https://api.jiox0.de/gringotts/api/v1/validate-customer/",
2452
- "payment_flow_data": {
2453
- "is_customer_validation_required": true,
2454
- "cust_validation_url": "https://api.fyndx0.de/platform/payment/api/v1/validate-customer/?app_id=000000000000000000000001",
2455
- "config": {
2456
- "redirect": false,
2457
- "final_payment_action_url": "https://api.fyndx0.de/platform/payment/v2/external/payments/confirm/charge/?app_id=000000000000000000000001"
2458
- },
2459
- "data": {
2460
- "user_phone": null,
2461
- "user_email": null
2462
- },
2463
- "return_url": null
2464
- }
2465
- }
2466
- }
2467
- }
2468
- }
2469
- ```
2470
- </details>
2471
-
2472
-
2473
-
2474
-
2475
-
2476
-
2477
-
2478
-
2479
-
2480
- ---
2481
-
2482
-
2483
- ### getPosPaymentModeRoutes
2484
- Get applicable payment options for Point-of-Sale (POS)
2485
-
2486
-
2487
-
2488
- ```javascript
2489
- // Promise
2490
- const promise = payment.getPosPaymentModeRoutes({ amount : value,
2491
- cartId : value,
2492
- pincode : value,
2493
- checkoutMode : value,
2494
- orderType : value,
2495
- refresh : value,
2496
- cardReference : value,
2497
- userDetails : value });
2498
-
2499
- // Async/Await
2500
- const data = await payment.getPosPaymentModeRoutes({ amount : value,
2501
- cartId : value,
2502
- pincode : value,
2503
- checkoutMode : value,
2504
- orderType : value,
2505
- refresh : value,
2506
- cardReference : value,
2507
- userDetails : value });
2508
- ```
2509
-
2510
-
2511
-
2512
-
2513
-
2514
- | Argument | Type | Required | Description |
2515
- | --------- | ----- | -------- | ----------- |
2516
- | amount | number | yes | Payable amount. |
2517
- | cartId | string | yes | Identifier of the cart. |
2518
- | pincode | string | yes | The PIN Code of the destination address, e.g. 400059 |
2519
- | checkoutMode | string | yes | Option to checkout for self or for others. |
2520
- | refresh | boolean | no | This is a boolean value. Select `true` to remove temporary cache files on payment gateway and replace with the latest one. |
2521
- | cardReference | string | no | Card reference id of user's debit or credit card. |
2522
- | orderType | string | yes | The order type of shipment * HomeDelivery - If the customer wants the order home-delivered * PickAtStore - If the customer wants the handover of an order at the store itself. |
2523
- | userDetails | string | no | URIencoded JSON containing details of an anonymous user. |
2524
-
2525
-
2526
-
2527
- Use this API to get all valid payment options for doing a payment in POS.
2528
-
2529
- *Returned Response:*
2530
-
2531
-
2532
-
2533
-
2534
- [PaymentModeRouteResponse](#PaymentModeRouteResponse)
2535
-
2536
- Success. Returns all available options for payment. Check the example shown below or refer `PaymentModeRouteResponse` for more details.
2537
-
2538
-
2539
-
2540
-
2541
- <details>
2542
- <summary><i>&nbsp; Example:</i></summary>
2543
-
2544
- ```json
2545
- {
2546
- "success": true,
2547
- "payment_options": {
2548
- "payment_option": [
2549
- {
2550
- "name": "CAS",
2551
- "display_priority": 21,
2552
- "payment_mode_id": 39,
2553
- "display_name": "Cash at Store",
2554
- "list": [
2555
- {
2556
- "aggregator_name": "Fynd",
2557
- "name": "CAS",
2558
- "display_name": "CASH",
2559
- "code": "CAS",
2560
- "logo_url": {
2561
- "large": "https://hdn-1.fynd.com/payment/cod.png",
2562
- "small": "https://hdn-1.fynd.com/payment/cod.png"
2563
- },
2564
- "merchant_code": "CAS"
2565
- }
2566
- ]
2567
- },
2568
- {
2569
- "name": "CSAS",
2570
- "display_priority": 21,
2571
- "payment_mode_id": 40,
2572
- "display_name": "Card Swiped at Store",
2573
- "list": [
2574
- {
2575
- "aggregator_name": "Fynd",
2576
- "name": "CSAS",
2577
- "display_name": "Card Swipe",
2578
- "code": "CSAS",
2579
- "logo_url": {
2580
- "large": "https://hdn-1.fynd.com/payment/cod.png",
2581
- "small": "https://hdn-1.fynd.com/payment/cod.png"
2582
- },
2583
- "merchant_code": "CSAS"
2584
- }
2585
- ]
2586
- },
2587
- {
2588
- "name": "UPI",
2589
- "display_priority": 9,
2590
- "payment_mode_id": 7,
2591
- "display_name": "UPI",
2592
- "list": [
2593
- {
2594
- "aggregator_name": "Razorpay",
2595
- "name": "UPI",
2596
- "display_name": "BHIM UPI",
2597
- "code": "UPI",
2598
- "logo_url": {
2599
- "small": "https://hdn-1.fynd.com/payment/upi_100x78.png",
2600
- "large": "https://hdn-1.fynd.com/payment/upi_150x100.png"
2601
- },
2602
- "merchant_code": "UPI",
2603
- "timeout": 240,
2604
- "retry_count": 0,
2605
- "fynd_vpa": "shopsense.rzp@hdfcbank",
2606
- "intent_flow": true,
2607
- "intent_app": [
2608
- {
2609
- "code": "google_pay",
2610
- "display_name": "Google Pay",
2611
- "package_name": "com.google.android.apps.nbu.paisa.user",
2612
- "logos": {
2613
- "small": "https://hdn-1.fynd.com/payment/upi-google-pay.png",
2614
- "large": "https://hdn-1.fynd.com/payment/upi-google-pay.png"
2615
- }
2616
- }
2617
- ],
2618
- "intent_app_error_list": [
2619
- "com.csam.icici.bank.imobile",
2620
- "in.org.npci.upiapp",
2621
- "com.whatsapp"
2622
- ],
2623
- "intent_app_error_dict_list": [
2624
- {
2625
- "package_name": "com.csam.icici.bank.imobile",
2626
- "code": "icici"
2627
- },
2628
- {
2629
- "package_name": "in.org.npci.upiapp",
2630
- "code": "upiapp"
2631
- },
2632
- {
2633
- "package_name": "com.whatsapp",
2634
- "code": "whatsapp"
2635
- }
2636
- ]
2637
- }
2638
- ]
2639
- }
2640
- ],
2641
- "payment_flows": {
2642
- "simpl": {
2643
- "data": {
2644
- "gateway": {
2645
- "route": "simpl",
2646
- "entity": "sdk",
2647
- "is_customer_validation_required": true,
2648
- "cust_validation_url": "https://api.fyndx0.de/gringotts/api/v1/validate-customer/?app_id=000000000000000000000001",
2649
- "sdk": {
2650
- "config": {
2651
- "redirect": false,
2652
- "callback_url": null,
2653
- "action_url": "https://api.fyndx0.de/platform/payment/v2/external/payments/confirm/charge/?app_id=000000000000000000000001"
2654
- },
2655
- "data": {
2656
- "user_phone": "9999632145",
2657
- "user_email": "app@fynd.com"
2658
- }
2659
- },
2660
- "return_url": null
2661
- }
2662
- },
2663
- "api_link": "",
2664
- "payment_flow": "sdk"
2665
- },
2666
- "juspay": {
2667
- "data": {},
2668
- "api_link": "https://sandbox.juspay.in/txns",
2669
- "payment_flow": "api"
2670
- },
2671
- "razorpay": {
2672
- "data": {},
2673
- "api_link": "",
2674
- "payment_flow": "sdk"
2675
- },
2676
- "upi_razorpay": {
2677
- "data": {},
2678
- "api_link": "https://api.fyndx0.de/platform/payment/v2/external/payments/request/?app_id=000000000000000000000001",
2679
- "payment_flow": "api"
2680
- },
2681
- "bqr_razorpay": {
2682
- "data": {},
2683
- "api_link": "https://api.fyndx0.de/platform/payment/v2/external/payments/request/?app_id=000000000000000000000001",
2684
- "payment_flow": "api"
2685
- },
2686
- "cashfree": {
2687
- "data": {},
2688
- "api_link": "",
2689
- "payment_flow": "api"
2690
- },
2691
- "fynd": {
2692
- "data": {},
2693
- "api_link": "",
2694
- "payment_flow": "api"
2695
- },
2696
- "jio": {
2697
- "data": {},
2698
- "api_link": "",
2699
- "payment_flow": "api"
2700
- },
2701
- "stripe": {
2702
- "data": {},
2703
- "api_link": "",
2704
- "payment_flow": "sdk"
2705
- },
2706
- "ccavenue": {
2707
- "data": {},
2708
- "api_link": "",
2709
- "payment_flow": "sdk"
2710
- },
2711
- "payumoney": {
2712
- "data": {},
2713
- "api_link": "",
2714
- "payment_flow": "sdk"
2715
- },
2716
- "rupifi": {
2717
- "data": {},
2718
- "api_link": "",
2719
- "return_url": "",
2720
- "payment_flow": "api",
2721
- "cust_validation_url": "https://api.jiox0.de/gringotts/api/v1/validate-customer/"
2722
- }
2723
- }
2724
- }
2725
- }
2726
- ```
2727
- </details>
2728
-
2729
-
2730
-
2731
-
2732
-
2733
-
2734
-
2735
-
2736
-
2737
- ---
2738
-
2739
-
2740
- ### getRupifiBannerDetails
2741
- Get CreditLine Offer
2742
-
2743
-
2744
-
2745
- ```javascript
2746
- // Promise
2747
- const promise = payment.getRupifiBannerDetails();
2748
-
2749
- // Async/Await
2750
- const data = await payment.getRupifiBannerDetails();
2751
- ```
2752
-
2753
-
2754
-
2755
-
2756
-
2757
-
2758
- Get CreditLine Offer if user is tentatively approved by rupifi
2759
-
2760
- *Returned Response:*
2761
-
2762
-
2763
-
2764
-
2765
- [RupifiBannerResponse](#RupifiBannerResponse)
2766
-
2767
- Success. Return CreditLine Offer detail. Check the example shown below or refer `RupifiBannerResponseSchema` for more details.
2768
-
2769
-
2770
-
2771
-
2772
- <details>
2773
- <summary><i>&nbsp; Example:</i></summary>
2774
-
2775
- ```json
2776
- {
2777
- "success": true,
2778
- "data": {
2779
- "kyc_url": "http://rupifi.kyc1.com/",
2780
- "status": "APPROVED"
2781
- }
2782
- }
2783
- ```
2784
- </details>
2785
-
2786
-
2787
-
2788
-
2789
-
2790
-
2791
-
2792
-
2793
-
2794
- ---
2795
-
2796
-
2797
- ### getUserBeneficiariesDetail
2798
- Lists the beneficiary of a refund
2799
-
2800
-
2801
-
2802
- ```javascript
2803
- // Promise
2804
- const promise = payment.getUserBeneficiariesDetail({ orderId : value });
2805
-
2806
- // Async/Await
2807
- const data = await payment.getUserBeneficiariesDetail({ orderId : value });
2808
- ```
2809
-
2810
-
2811
-
2812
-
2813
-
2814
- | Argument | Type | Required | Description |
2815
- | --------- | ----- | -------- | ----------- |
2816
- | orderId | string | yes | A unique number used for identifying and tracking your orders. |
2817
-
2818
-
2819
-
2820
- Use this API to get the details of all active beneficiary added by a user for refund.
2821
-
2822
- *Returned Response:*
2823
-
2824
-
2825
-
2826
-
2827
- [OrderBeneficiaryResponse](#OrderBeneficiaryResponse)
2828
-
2829
- Success. Returns the details of the beneficiary getting a refund. Check the example shown below or refer `OrderBeneficiaryResponse` for more details.
2830
-
2831
-
2832
-
2833
-
2834
- <details>
2835
- <summary><i>&nbsp; Example:</i></summary>
2836
-
2837
- ```json
2838
- {
2839
- "beneficiaries": [
2840
- {
2841
- "id": 221,
2842
- "beneficiary_id": "0f7e44a922df352c05c5f73cb40ba115",
2843
- "bank_name": "State Bank of India",
2844
- "branch_name": "State Bank of India",
2845
- "account_holder": "SHASHI TEST",
2846
- "account_no": "1234567891",
2847
- "ifsc_code": "SBIN0005611",
2848
- "mobile": "9112042174",
2849
- "email": "payment@gofynd.com",
2850
- "address": "204A",
2851
- "comment": "",
2852
- "is_active": null,
2853
- "created_on": "2020-06-29 12:38:39",
2854
- "modified_on": "2020-06-29 12:38:39",
2855
- "display_name": "BANK",
2856
- "transfer_mode": "bank",
2857
- "title": "Bank Account",
2858
- "subtitle": "1234567891",
2859
- "delights_user_name": null
2860
- }
2861
- ],
2862
- "show_beneficiary_details": false
2863
- }
2864
- ```
2865
- </details>
2866
-
2867
-
2868
-
2869
-
2870
-
2871
-
2872
-
2873
-
2874
-
2875
- ---
2876
-
2877
-
2878
- ### initialisePayment
2879
- Initialize a payment (server-to-server) for UPI and BharatQR
2880
-
2881
-
2882
-
2883
- ```javascript
2884
- // Promise
2885
- const promise = payment.initialisePayment({ body : value });
2886
-
2887
- // Async/Await
2888
- const data = await payment.initialisePayment({ body : value });
2889
- ```
2890
-
2891
-
2892
-
2893
-
2894
-
2895
- | Argument | Type | Required | Description |
2896
- | --------- | ----- | -------- | ----------- |
2897
- | body | [PaymentInitializationRequest](#PaymentInitializationRequest) | yes | Request body |
2898
-
2899
-
2900
- PUse this API to inititate payment using UPI, BharatQR, wherein the UPI requests are send to the app and QR code is displayed on the screen.
2901
-
2902
- *Returned Response:*
2903
-
2904
-
2905
-
2906
-
2907
- [PaymentInitializationResponse](#PaymentInitializationResponse)
2908
-
2909
- Success. Check the example shown below or refer `PaymentInitializationResponse` for more details.
2910
-
2911
-
2912
-
2913
-
2914
- <details>
2915
- <summary><i>&nbsp; Example:</i></summary>
2916
-
2917
- ```json
2918
- {
2919
- "success": true,
2920
- "aggregator": "UPI_Razorpay",
2921
- "method": "upi",
2922
- "status": "success",
2923
- "merchant_order_id": "FY000120000101",
2924
- "aggregator_order_id": "lorem_GX8W00p2ipsum",
2925
- "polling_url": "https://api.fynd.com/service/application/payment/v0.1/payments/confirm/polling/?app_id=000000000000000000000001",
2926
- "timeout": 240,
2927
- "virtual_id": null,
2928
- "razorpay_payment_id": "pay_dummy_001",
2929
- "customer_id": "cust_dummy_001"
2930
- }
2931
- ```
2932
- </details>
2933
-
2934
-
2935
-
2936
-
2937
-
2938
-
2939
-
2940
-
2941
-
2942
- ---
2943
-
2944
-
2945
- ### initialisePaymentPaymentLink
2946
- Initialize a payment (server-to-server) for UPI and BharatQR
2947
-
2948
-
2949
-
2950
- ```javascript
2951
- // Promise
2952
- const promise = payment.initialisePaymentPaymentLink({ body : value });
2953
-
2954
- // Async/Await
2955
- const data = await payment.initialisePaymentPaymentLink({ body : value });
2956
- ```
2957
-
2958
-
2959
-
2960
-
2961
-
2962
- | Argument | Type | Required | Description |
2963
- | --------- | ----- | -------- | ----------- |
2964
- | body | [PaymentInitializationRequest](#PaymentInitializationRequest) | yes | Request body |
2965
-
2966
-
2967
- Use this API to inititate payment using UPI, BharatQR, wherein the UPI requests are send to the app and QR code is displayed on the screen.
2968
-
2969
- *Returned Response:*
2970
-
2971
-
2972
-
2973
-
2974
- [PaymentInitializationResponse](#PaymentInitializationResponse)
2975
-
2976
- Success. Check the example shown below or refer `PaymentInitializationResponse` for more details.
2977
-
2978
-
2979
-
2980
-
2981
- <details>
2982
- <summary><i>&nbsp; Example:</i></summary>
2983
-
2984
- ```json
2985
- {
2986
- "success": true,
2987
- "aggregator": "UPI_Razorpay",
2988
- "method": "upi",
2989
- "status": "success",
2990
- "merchant_order_id": "FY000120000101",
2991
- "aggregator_order_id": "lorem_GX8W00p2ipsum",
2992
- "polling_url": "https://api.fynd.com/service/application/payment/v0.1/payments/confirm/polling/?app_id=000000000000000000000001",
2993
- "timeout": 240,
2994
- "virtual_id": null,
2995
- "razorpay_payment_id": "pay_dummy_001",
2996
- "customer_id": "cust_dummy_001"
2997
- }
2998
- ```
2999
- </details>
3000
-
3001
-
3002
-
3003
-
3004
-
3005
-
3006
-
3007
-
3008
-
3009
- ---
3010
-
3011
-
3012
- ### pollingPaymentLink
3013
- Used for polling if payment successful or not
3014
-
3015
-
3016
-
3017
- ```javascript
3018
- // Promise
3019
- const promise = payment.pollingPaymentLink({ paymentLinkId : value });
3020
-
3021
- // Async/Await
3022
- const data = await payment.pollingPaymentLink({ paymentLinkId : value });
3023
- ```
3024
-
3025
-
3026
-
3027
-
3028
-
3029
- | Argument | Type | Required | Description |
3030
- | --------- | ----- | -------- | ----------- |
3031
- | paymentLinkId | string | no | |
3032
-
3033
-
3034
-
3035
- Use this API to poll if payment through payment was successful or not
3036
-
3037
- *Returned Response:*
3038
-
3039
-
3040
-
3041
-
3042
- [PollingPaymentLinkResponse](#PollingPaymentLinkResponse)
3043
-
3044
- Success. Check the example shown below
3045
-
3046
-
3047
-
3048
-
3049
- <details>
3050
- <summary><i>&nbsp; Example:</i></summary>
3051
-
3052
- ```json
3053
- {
3054
- "aggregator_name": "Fynd",
3055
- "status": "complete",
3056
- "redirect_url": "https://api.fyndx0.de/service/application/order/v1.0/orders/?success=true&order_id=FY62B3FF87016F24A4E6&aggregator_name=Fynd&cart_id=412&delivery_address_id=136&billing_address_id=136",
3057
- "payment_link_id": "223d2a8df39a5dcdd8525498bee73199",
3058
- "amount": 21900,
3059
- "order_id": "FY62B3FF87016F24A4E6",
3060
- "status_code": 200
3061
- }
3062
- ```
3063
- </details>
3064
-
3065
-
3066
-
3067
-
3068
-
3069
-
3070
-
3071
-
3072
-
3073
- ---
3074
-
3075
-
3076
- ### redirectToAggregator
3077
- API to get the redirect url to redirect the user to aggregator's page
3078
-
3079
-
3080
-
3081
- ```javascript
3082
- // Promise
3083
- const promise = payment.redirectToAggregator({ source : value,
3084
- aggregator : value });
3085
-
3086
- // Async/Await
3087
- const data = await payment.redirectToAggregator({ source : value,
3088
- aggregator : value });
3089
- ```
3090
-
3091
-
3092
-
3093
-
3094
-
3095
- | Argument | Type | Required | Description |
3096
- | --------- | ----- | -------- | ----------- |
3097
- | source | string | no | This is a String value that contains callback URL as value. |
3098
- | aggregator | string | no | This is a String value that contains aggregator name as value. |
3099
-
3100
-
3101
-
3102
- Use this API to get the redirect url to redirect the user to aggregator's page
3103
-
3104
- *Returned Response:*
3105
-
3106
-
3107
-
3108
-
3109
- [RedirectToAggregatorResponse](#RedirectToAggregatorResponse)
3110
-
3111
- Success. Returns the status of payment. Check the example shown below or refer `RedirectToAggregatorResponseSchema` for more details.
3112
-
3113
-
3114
-
3115
-
3116
- <details>
3117
- <summary><i>&nbsp; Example:</i></summary>
3118
-
3119
- ```json
3120
- {
3121
- "success": true,
3122
- "data": {
3123
- "redirect_url": "https://api-blackbox.epaylater.in//marketplace/customer/transactions/v2?encryptedPayload=dpPuB2+kZ6NyIrg0eWAwk7TbF14502RkIARgullt3PGWMh7Ix0Tc720b6idZzXNxzwaA3BOi2DHUALpqSfOagra+i0wRIVc36O62fwPscQE=checksum=6F06AEAE2A3CBBC81457FB2287C4DEFCFC16DEA8F33482D682134D64E43E34C2merchantId=Sample1234567890redirectConfirmUrl=http://localhost:8000/",
3124
- "status": true
3125
- }
3126
- }
3127
- ```
3128
- </details>
3129
-
3130
-
3131
-
3132
-
3133
-
3134
-
3135
-
3136
-
3137
-
3138
- ---
3139
-
3140
-
3141
- ### renderHTML
3142
- Convert base64 string to HTML form
3143
-
3144
-
3145
-
3146
- ```javascript
3147
- // Promise
3148
- const promise = payment.renderHTML({ body : value });
3149
-
3150
- // Async/Await
3151
- const data = await payment.renderHTML({ body : value });
3152
- ```
3153
-
3154
-
3155
-
3156
-
3157
-
3158
- | Argument | Type | Required | Description |
3159
- | --------- | ----- | -------- | ----------- |
3160
- | body | [renderHTMLRequest](#renderHTMLRequest) | yes | Request body |
3161
-
3162
-
3163
- Use this API to decode base64 html form to plain HTML string.
3164
-
3165
- *Returned Response:*
3166
-
3167
-
3168
-
3169
-
3170
- [renderHTMLResponse](#renderHTMLResponse)
3171
-
3172
- Success and return HTML decoded text
3173
-
3174
-
3175
-
3176
-
3177
- <details>
3178
- <summary><i>&nbsp; Example:</i></summary>
3179
-
3180
- ```json
3181
- {
3182
- "html": "<html><body>Your HTML text</body></html>"
3183
- }
3184
- ```
3185
- </details>
3186
-
3187
-
3188
-
3189
-
3190
-
3191
-
3192
-
3193
-
3194
-
3195
- ---
3196
-
3197
-
3198
- ### resendOrCancelPayment
3199
- API to resend and cancel a payment link which was already generated.
3200
-
3201
-
3202
-
3203
- ```javascript
3204
- // Promise
3205
- const promise = payment.resendOrCancelPayment({ body : value });
3206
-
3207
- // Async/Await
3208
- const data = await payment.resendOrCancelPayment({ body : value });
3209
- ```
3210
-
3211
-
3212
-
3213
-
3214
-
3215
- | Argument | Type | Required | Description |
3216
- | --------- | ----- | -------- | ----------- |
3217
- | body | [ResendOrCancelPaymentRequest](#ResendOrCancelPaymentRequest) | yes | Request body |
3218
-
3219
-
3220
- Use this API to perform resend or cancel a payment link based on request payload.
3221
-
3222
- *Returned Response:*
3223
-
3224
-
3225
-
3226
-
3227
- [ResendOrCancelPaymentResponse](#ResendOrCancelPaymentResponse)
3228
-
3229
- Success. Returns the status of payment. Check the example shown below or refer `ResendOrCancelPaymentResponse` for more details.
3230
-
3231
-
3232
-
3233
-
3234
- <details>
3235
- <summary><i>&nbsp; Examples:</i></summary>
3236
-
3237
-
3238
- <details>
3239
- <summary><i>&nbsp; request_type is cancel</i></summary>
3240
-
3241
- ```json
3242
- {
3243
- "value": {
3244
- "success": true,
3245
- "data": {
3246
- "message": "Payment link Cancelled.",
3247
- "status": true
3248
- }
3249
- }
3250
- }
3251
- ```
3252
- </details>
3253
-
3254
- <details>
3255
- <summary><i>&nbsp; request_type is resend</i></summary>
3256
-
3257
- ```json
3258
- {
3259
- "value": {
3260
- "success": true,
3261
- "data": {
3262
- "message": "Notification triggered.",
3263
- "status": true
3264
- }
3265
- }
3266
- }
3267
- ```
3268
- </details>
3269
-
3270
- </details>
3271
-
3272
-
3273
-
3274
-
3275
-
3276
-
3277
-
3278
-
3279
-
3280
- ---
3281
-
3282
-
3283
- ### resendPaymentLink
3284
- Resend payment link
3285
-
3286
-
3287
-
3288
- ```javascript
3289
- // Promise
3290
- const promise = payment.resendPaymentLink({ body : value });
3291
-
3292
- // Async/Await
3293
- const data = await payment.resendPaymentLink({ body : value });
3294
- ```
3295
-
3296
-
3297
-
3298
-
3299
-
3300
- | Argument | Type | Required | Description |
3301
- | --------- | ----- | -------- | ----------- |
3302
- | body | [CancelOrResendPaymentLinkRequest](#CancelOrResendPaymentLinkRequest) | yes | Request body |
3303
-
3304
-
3305
- Use this API to resend a payment link for the customer
3306
-
3307
- *Returned Response:*
3308
-
3309
-
3310
-
3311
-
3312
- [ResendPaymentLinkResponse](#ResendPaymentLinkResponse)
3313
-
3314
- Success. Check the example shown below
3315
-
3316
-
3317
-
3318
-
3319
- <details>
3320
- <summary><i>&nbsp; Example:</i></summary>
3321
-
3322
- ```json
3323
- {
3324
- "success": true,
3325
- "message": "Payment link resent",
3326
- "status_code": 200,
3327
- "polling_timeout": 480
3328
- }
3329
- ```
3330
- </details>
3331
-
3332
-
3333
-
3334
-
3335
-
3336
-
3337
-
3338
-
3339
-
3340
- ---
3341
-
3342
-
3343
- ### updateDefaultBeneficiary
3344
- Set a default beneficiary for a refund
3345
-
3346
-
3347
-
3348
- ```javascript
3349
- // Promise
3350
- const promise = payment.updateDefaultBeneficiary({ body : value });
3351
-
3352
- // Async/Await
3353
- const data = await payment.updateDefaultBeneficiary({ body : value });
3354
- ```
3355
-
3356
-
3357
-
3358
-
3359
-
3360
- | Argument | Type | Required | Description |
3361
- | --------- | ----- | -------- | ----------- |
3362
- | body | [SetDefaultBeneficiaryRequest](#SetDefaultBeneficiaryRequest) | yes | Request body |
3363
-
3364
-
3365
- Use this API to set a default beneficiary for getting a refund.
3366
-
3367
- *Returned Response:*
3368
-
3369
-
3370
-
3371
-
3372
- [SetDefaultBeneficiaryResponse](#SetDefaultBeneficiaryResponse)
3373
-
3374
- Success. Check the example shown below or refer `SetDefaultBeneficiaryResponse` for more details.
3375
-
3376
-
3377
-
3378
-
3379
- <details>
3380
- <summary><i>&nbsp; Example:</i></summary>
3381
-
3382
- ```json
3383
- {
3384
- "success": true,
3385
- "is_beneficiary_set": true
3386
- }
3387
- ```
3388
- </details>
3389
-
3390
-
3391
-
3392
-
3393
-
3394
-
3395
-
3396
-
3397
-
3398
- ---
3399
-
3400
-
3401
- ### validateVPA
3402
- API to Validate UPI ID
3403
-
3404
-
3405
-
3406
- ```javascript
3407
- // Promise
3408
- const promise = payment.validateVPA({ body : value });
3409
-
3410
- // Async/Await
3411
- const data = await payment.validateVPA({ body : value });
3412
- ```
3413
-
3414
-
3415
-
3416
-
3417
-
3418
- | Argument | Type | Required | Description |
3419
- | --------- | ----- | -------- | ----------- |
3420
- | body | [ValidateVPARequest](#ValidateVPARequest) | yes | Request body |
3421
-
3422
-
3423
- API to Validate UPI ID
3424
-
3425
- *Returned Response:*
3426
-
3427
-
3428
-
3429
-
3430
- [ValidateVPAResponse](#ValidateVPAResponse)
3431
-
3432
- Success. Returns the status of payment. Check the example shown below or refer `ValidateVPAResponseSchema` for more details.
3433
-
3434
-
3435
-
3436
-
3437
- <details>
3438
- <summary><i>&nbsp; Example:</i></summary>
3439
-
3440
- ```json
3441
- {
3442
- "success": true,
3443
- "data": {
3444
- "upi_vpa": "success@razorpay",
3445
- "status": "VALID",
3446
- "is_valid": true,
3447
- "customer_name": "Verified"
3448
- }
3449
- }
3450
- ```
3451
- </details>
3452
-
3453
-
3454
-
3455
-
3456
-
3457
-
3458
-
3459
-
3460
-
3461
- ---
3462
-
3463
-
3464
- ### verifyAndChargePayment
3465
- Verify and charge payment
3466
-
3467
-
3468
-
3469
- ```javascript
3470
- // Promise
3471
- const promise = payment.verifyAndChargePayment({ body : value });
3472
-
3473
- // Async/Await
3474
- const data = await payment.verifyAndChargePayment({ body : value });
3475
- ```
3476
-
3477
-
3478
-
3479
-
3480
-
3481
- | Argument | Type | Required | Description |
3482
- | --------- | ----- | -------- | ----------- |
3483
- | body | [ChargeCustomerRequest](#ChargeCustomerRequest) | yes | Request body |
3484
-
3485
-
3486
- Use this API to verify and check the status of a payment transaction (server-to-server) made through aggregators like Simpl and Mswipe.
3487
-
3488
- *Returned Response:*
3489
-
3490
-
3491
-
3492
-
3493
- [ChargeCustomerResponse](#ChargeCustomerResponse)
3494
-
3495
- Success. Check the example shown below or refer `ChargeCustomerResponse` for more details.
3496
-
3497
-
3498
-
3499
-
3500
- <details>
3501
- <summary><i>&nbsp; Example:</i></summary>
3502
-
3503
- ```json
3504
- {
3505
- "success": true,
3506
- "message": "Payment Successful",
3507
- "status": "complete",
3508
- "order_id": "FY000000001000000101",
3509
- "aggregator": "Simpl",
3510
- "cart_id": "0000000",
3511
- "delivery_address_id": "0000000"
3512
- }
3513
- ```
3514
- </details>
3515
-
3516
-
3517
-
3518
-
3519
-
3520
-
3521
-
3522
-
3523
-
3524
- ---
3525
-
3526
-
3527
- ### verifyCustomerForPayment
3528
- Validate customer for payment
3529
-
3530
-
3531
-
3532
- ```javascript
3533
- // Promise
3534
- const promise = payment.verifyCustomerForPayment({ body : value });
3535
-
3536
- // Async/Await
3537
- const data = await payment.verifyCustomerForPayment({ body : value });
3538
- ```
3539
-
3540
-
3541
-
3542
-
3543
-
3544
- | Argument | Type | Required | Description |
3545
- | --------- | ----- | -------- | ----------- |
3546
- | body | [ValidateCustomerRequest](#ValidateCustomerRequest) | yes | Request body |
3547
-
3548
-
3549
- Use this API to check if the customer is eligible to use credit-line facilities such as Simpl Pay Later and Rupifi.
3550
-
3551
- *Returned Response:*
3552
-
3553
-
3554
-
3555
-
3556
- [ValidateCustomerResponse](#ValidateCustomerResponse)
3557
-
3558
- Success. Check the example shown below or refer `ValidateCustomerResponse` for more details.
3559
-
3560
-
3561
-
3562
-
3563
- <details>
3564
- <summary><i>&nbsp; Examples:</i></summary>
3565
-
3566
-
3567
- <details>
3568
- <summary><i>&nbsp; success is True i.e user is allowed</i></summary>
3569
-
3570
- ```json
3571
- {
3572
- "value": {
3573
- "success": true,
3574
- "message": "data fetched",
3575
- "data": {
3576
- "api_version": 2,
3577
- "data": {
3578
- "approved": true,
3579
- "button_text": "Buy Now, Pay Later",
3580
- "first_transaction": false
3581
- },
3582
- "aggregator": "Simpl"
3583
- }
3584
- }
3585
- }
3586
- ```
3587
- </details>
3588
-
3589
- <details>
3590
- <summary><i>&nbsp; success is True i.e user not allowed</i></summary>
3591
-
3592
- ```json
3593
- {
3594
- "value": {
3595
- "success": false,
3596
- "message": "data fetched",
3597
- "error": {
3598
- "api_version": 2,
3599
- "data": {
3600
- "approved": false,
3601
- "button_text": "Buy Now, Pay Later",
3602
- "first_transaction": false
3603
- },
3604
- "aggregator": "Simpl"
3605
- },
3606
- "data": {}
3607
- }
3608
- }
3609
- ```
3610
- </details>
3611
-
3612
- </details>
3613
-
3614
-
3615
-
3616
-
3617
-
3618
-
3619
-
3620
-
3621
-
3622
- ---
3623
-
3624
-
3625
- ### verifyIfscCode
3626
- Verify IFSC Code
3627
-
3628
-
3629
-
3630
- ```javascript
3631
- // Promise
3632
- const promise = payment.verifyIfscCode({ ifscCode : value });
3633
-
3634
- // Async/Await
3635
- const data = await payment.verifyIfscCode({ ifscCode : value });
3636
- ```
3637
-
3638
-
3639
-
3640
-
3641
-
3642
- | Argument | Type | Required | Description |
3643
- | --------- | ----- | -------- | ----------- |
3644
- | ifscCode | string | no | A 11-digit alphanumeric code that uniquely identifies a bank branch. |
3645
-
3646
-
3647
-
3648
- Use this API to check whether the 11-digit IFSC code is valid and to fetch the bank details for refund.
3649
-
3650
- *Returned Response:*
3651
-
3652
-
3653
-
3654
-
3655
- [IfscCodeResponse](#IfscCodeResponse)
3656
-
3657
- Success. Shows whether the IFSC code is valid, and returns the bank details. Check the example shown below or refer `IfscCodeResponse` for more details.
3658
-
3659
-
3660
-
3661
-
3662
- <details>
3663
- <summary><i>&nbsp; Example:</i></summary>
3664
-
3665
- ```json
3666
- {
3667
- "branch_name": "MANPUR",
3668
- "bank_name": "GAYA",
3669
- "BRANCH": "MANPUR",
3670
- "CENTRE": "GAYA",
3671
- "DISTRICT": "GAYA",
3672
- "STATE": "BIHAR",
3673
- "ADDRESS": "POBUNIYADGANJBIHAR",
3674
- "CONTACT": "00",
3675
- "MICR": "816002103",
3676
- "UPI": true,
3677
- "RTGS": true,
3678
- "CITY": "GAYA",
3679
- "NEFT": true,
3680
- "IMPS": true,
3681
- "SWIFT": "",
3682
- "BANK": "State Bank of India",
3683
- "BANKCODE": "SBIN",
3684
- "IFSC": "SBIN0005611",
3685
- "success": true
3686
- }
3687
- ```
3688
- </details>
3689
-
3690
-
3691
-
3692
-
3693
-
3694
-
3695
-
3696
-
3697
-
3698
- ---
3699
-
3700
-
3701
- ### verifyOtpAndAddBeneficiaryForBank
3702
- Verify the beneficiary details using OTP
3703
-
3704
-
3705
-
3706
- ```javascript
3707
- // Promise
3708
- const promise = payment.verifyOtpAndAddBeneficiaryForBank({ body : value });
3709
-
3710
- // Async/Await
3711
- const data = await payment.verifyOtpAndAddBeneficiaryForBank({ body : value });
3712
- ```
3713
-
3714
-
3715
-
3716
-
3717
-
3718
- | Argument | Type | Required | Description |
3719
- | --------- | ----- | -------- | ----------- |
3720
- | body | [AddBeneficiaryViaOtpVerificationRequest](#AddBeneficiaryViaOtpVerificationRequest) | yes | Request body |
3721
-
3722
-
3723
- Use this API to perform an OTP validation before saving the beneficiary details added for a refund.
3724
-
3725
- *Returned Response:*
3726
-
3727
-
3728
-
3729
-
3730
- [AddBeneficiaryViaOtpVerificationResponse](#AddBeneficiaryViaOtpVerificationResponse)
3731
-
3732
- Success. Check the example shown below or refer `AddBeneficiaryViaOtpVerificationRequest` for more details.
3733
-
3734
-
3735
-
3736
-
3737
- <details>
3738
- <summary><i>&nbsp; Example:</i></summary>
3739
-
3740
- ```json
3741
- {
3742
- "success": true,
3743
- "message": "Account successfully created"
3744
- }
3745
- ```
3746
- </details>
3747
-
3748
-
3749
-
3750
-
3751
-
3752
-
3753
-
3754
-
3755
-
3756
- ---
3757
-
3758
-
3759
- ### verifyOtpAndAddBeneficiaryForWallet
3760
- Send OTP on adding a wallet beneficiary
3761
-
3762
-
3763
-
3764
- ```javascript
3765
- // Promise
3766
- const promise = payment.verifyOtpAndAddBeneficiaryForWallet({ body : value });
3767
-
3768
- // Async/Await
3769
- const data = await payment.verifyOtpAndAddBeneficiaryForWallet({ body : value });
3770
- ```
3771
-
3772
-
3773
-
3774
-
3775
-
3776
- | Argument | Type | Required | Description |
3777
- | --------- | ----- | -------- | ----------- |
3778
- | body | [WalletOtpRequest](#WalletOtpRequest) | yes | Request body |
3779
-
3780
-
3781
- Use this API to send an OTP while adding a wallet beneficiary by mobile no. verification.
3782
-
3783
- *Returned Response:*
3784
-
3785
-
3786
-
3787
-
3788
- [WalletOtpResponse](#WalletOtpResponse)
3789
-
3790
- Success. Sends the OTP to the given mobile number. Check the example shown below or refer `WalletOtpResponse` for more details.
3791
-
3792
-
3793
-
3794
-
3795
- <details>
3796
- <summary><i>&nbsp; Example:</i></summary>
3797
-
3798
- ```json
3799
- {
3800
- "success": true,
3801
- "is_verified_flag": false,
3802
- "request_id": "c3ca6c13d490c885a125d106b45697b7"
3803
- }
3804
- ```
3805
- </details>
3806
-
3807
-
3808
-
3809
-
3810
-
3811
-
3812
-
3813
-
3814
-
3815
- ---
3816
-
3817
-
3818
-
3819
- ### Schemas
3820
-
3821
-
3822
- #### [ActiveCardPaymentGatewayResponse](#ActiveCardPaymentGatewayResponse)
3823
-
3824
- | Properties | Type | Nullable | Description |
3825
- | ---------- | ---- | -------- | ----------- || cards | [CardPaymentGateway](#CardPaymentGateway) | yes | || message | string | yes | || success | boolean | yes | |
3826
-
3827
- ---
3828
-
3829
- #### [AddBeneficiaryDetailsOTPRequest](#AddBeneficiaryDetailsOTPRequest)
3830
-
3831
- | Properties | Type | Nullable | Description |
3832
- | ---------- | ---- | -------- | ----------- || details | [BankDetailsForOTP](#BankDetailsForOTP) | yes | || order_id | string | yes | |
3833
-
3834
- ---
3835
-
3836
- #### [AddBeneficiaryDetailsRequest](#AddBeneficiaryDetailsRequest)
3837
-
3838
- | Properties | Type | Nullable | Description |
3839
- | ---------- | ---- | -------- | ----------- || delights | boolean | yes | || details | [BeneficiaryModeDetails](#BeneficiaryModeDetails) | yes | || order_id | string | yes | || otp | string | no | || request_id | string | no | || shipment_id | string | yes | || transfer_mode | string | yes | |
3840
-
3841
- ---
3842
-
3843
- #### [AddBeneficiaryViaOtpVerificationRequest](#AddBeneficiaryViaOtpVerificationRequest)
3844
-
3845
- | Properties | Type | Nullable | Description |
3846
- | ---------- | ---- | -------- | ----------- || hash_key | string | yes | || otp | string | yes | || request_id | string | yes | |
3847
-
3848
- ---
3849
-
3850
- #### [AddBeneficiaryViaOtpVerificationResponse](#AddBeneficiaryViaOtpVerificationResponse)
3851
-
3852
- | Properties | Type | Nullable | Description |
3853
- | ---------- | ---- | -------- | ----------- || message | string | yes | || success | boolean | no | |
3854
-
3855
- ---
3856
-
3857
- #### [AggregatorConfigDetail](#AggregatorConfigDetail)
3858
-
3859
- | Properties | Type | Nullable | Description |
3860
- | ---------- | ---- | -------- | ----------- || api | string | no | || config_type | string | yes | || key | string | yes | || merchant_id | string | no | || merchant_key | string | no | || pin | string | no | || sdk | boolean | no | || secret | string | yes | || user_id | string | no | || verify_api | string | no | |
3861
-
3862
- ---
3863
-
3864
- #### [AggregatorRoute](#AggregatorRoute)
3865
-
3866
- | Properties | Type | Nullable | Description |
3867
- | ---------- | ---- | -------- | ----------- || api_link | string | no | || data | string | no | || payment_flow | string | no | || payment_flow_data | string | no | |
3868
-
3869
- ---
3870
-
3871
- #### [AggregatorsConfigDetailResponse](#AggregatorsConfigDetailResponse)
3872
-
3873
- | Properties | Type | Nullable | Description |
3874
- | ---------- | ---- | -------- | ----------- || ccavenue | [AggregatorConfigDetail](#AggregatorConfigDetail) | no | || env | string | yes | || juspay | [AggregatorConfigDetail](#AggregatorConfigDetail) | no | || mswipe | [AggregatorConfigDetail](#AggregatorConfigDetail) | no | || payumoney | [AggregatorConfigDetail](#AggregatorConfigDetail) | no | || razorpay | [AggregatorConfigDetail](#AggregatorConfigDetail) | no | || rupifi | [AggregatorConfigDetail](#AggregatorConfigDetail) | no | || simpl | [AggregatorConfigDetail](#AggregatorConfigDetail) | no | || stripe | [AggregatorConfigDetail](#AggregatorConfigDetail) | no | || success | boolean | yes | |
3875
-
3876
- ---
3877
-
3878
- #### [AttachCardRequest](#AttachCardRequest)
3879
-
3880
- | Properties | Type | Nullable | Description |
3881
- | ---------- | ---- | -------- | ----------- || card_id | string | yes | || name_on_card | string | no | || nickname | string | no | || refresh | boolean | no | |
3882
-
3883
- ---
3884
-
3885
- #### [AttachCardsResponse](#AttachCardsResponse)
3886
-
3887
- | Properties | Type | Nullable | Description |
3888
- | ---------- | ---- | -------- | ----------- || data | string | yes | || message | string | no | || success | boolean | yes | |
3889
-
3890
- ---
3891
-
3892
- #### [BalanceDetails](#BalanceDetails)
3893
-
3894
- | Properties | Type | Nullable | Description |
3895
- | ---------- | ---- | -------- | ----------- || currency | string | yes | || formatted_value | string | yes | || value | number | yes | |
3896
-
3897
- ---
3898
-
3899
- #### [BankDetailsForOTP](#BankDetailsForOTP)
3900
-
3901
- | Properties | Type | Nullable | Description |
3902
- | ---------- | ---- | -------- | ----------- || account_holder | string | yes | || account_no | string | yes | || bank_name | string | yes | || branch_name | string | yes | || ifsc_code | string | yes | |
3903
-
3904
- ---
3905
-
3906
- #### [BeneficiaryModeDetails](#BeneficiaryModeDetails)
3907
-
3908
- | Properties | Type | Nullable | Description |
3909
- | ---------- | ---- | -------- | ----------- || account_holder | string | yes | || account_no | string | yes | || address | string | no | || bank_name | string | yes | || branch_name | string | yes | || comment | string | no | || email | string | yes | || ifsc_code | string | yes | || mobile | string | yes | || vpa | string | no | || wallet | string | no | |
3910
-
3911
- ---
3912
-
3913
- #### [BusinessDetails](#BusinessDetails)
3914
-
3915
- | Properties | Type | Nullable | Description |
3916
- | ---------- | ---- | -------- | ----------- || address | [KYCAddress](#KYCAddress) | no | || business_ownership_type | string | no | || business_type | string | no | || entity_type | string | no | || fda | string | no | || fssai | string | no | || gstin | string | no | || name | string | no | || pan | string | no | || shop_and_establishment | string | no | || vintage | string | no | |
3917
-
3918
- ---
3919
-
3920
- #### [CancelOrResendPaymentLinkRequest](#CancelOrResendPaymentLinkRequest)
3921
-
3922
- | Properties | Type | Nullable | Description |
3923
- | ---------- | ---- | -------- | ----------- || payment_link_id | string | yes | |
3924
-
3925
- ---
3926
-
3927
- #### [CancelPaymentLinkResponse](#CancelPaymentLinkResponse)
3928
-
3929
- | Properties | Type | Nullable | Description |
3930
- | ---------- | ---- | -------- | ----------- || message | string | yes | || status_code | number | yes | || success | boolean | yes | |
3931
-
3932
- ---
3933
-
3934
- #### [Card](#Card)
3935
-
3936
- | Properties | Type | Nullable | Description |
3937
- | ---------- | ---- | -------- | ----------- || 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 | || compliant_with_tokenisation_guidelines | boolean | no | || exp_month | number | no | || exp_year | number | no | || expired | boolean | no | || nickname | string | no | |
3938
-
3939
- ---
3940
-
3941
- #### [CardPaymentGateway](#CardPaymentGateway)
3942
-
3943
- | Properties | Type | Nullable | Description |
3944
- | ---------- | ---- | -------- | ----------- || aggregator | string | yes | || api | string | no | || customer_id | string | no | |
3945
-
3946
- ---
3947
-
3948
- #### [ChargeCustomerRequest](#ChargeCustomerRequest)
3949
-
3950
- | Properties | Type | Nullable | Description |
3951
- | ---------- | ---- | -------- | ----------- || aggregator | string | yes | || amount | number | yes | || order_id | string | yes | || transaction_token | string | no | || verified | boolean | no | |
3952
-
3953
- ---
3954
-
3955
- #### [ChargeCustomerResponse](#ChargeCustomerResponse)
3956
-
3957
- | Properties | Type | Nullable | Description |
3958
- | ---------- | ---- | -------- | ----------- || aggregator | string | yes | || cart_id | string | no | || delivery_address_id | string | no | || message | string | yes | || order_id | string | yes | || status | string | yes | || success | boolean | yes | |
3959
-
3960
- ---
3961
-
3962
- #### [CheckCreditResponse](#CheckCreditResponse)
3963
-
3964
- | Properties | Type | Nullable | Description |
3965
- | ---------- | ---- | -------- | ----------- || data | [CreditDetail](#CreditDetail) | yes | || success | boolean | yes | |
3966
-
3967
- ---
3968
-
3969
- #### [CreateOrderUserData](#CreateOrderUserData)
3970
-
3971
- | Properties | Type | Nullable | Description |
3972
- | ---------- | ---- | -------- | ----------- || aggregator | string | no | || amount | number | no | || callback_url | string | no | || contact | string | no | || currency | string | no | || customer_id | string | no | || email | string | no | || merchant_order_id | string | no | || method | string | no | || order_id | string | no | |
3973
-
3974
- ---
3975
-
3976
- #### [CreateOrderUserPaymentMethods](#CreateOrderUserPaymentMethods)
3977
-
3978
- | Properties | Type | Nullable | Description |
3979
- | ---------- | ---- | -------- | ----------- || meta | [PaymentMethodsMeta](#PaymentMethodsMeta) | yes | || mode | string | yes | || name | string | yes | |
3980
-
3981
- ---
3982
-
3983
- #### [CreateOrderUserRequest](#CreateOrderUserRequest)
3984
-
3985
- | Properties | Type | Nullable | Description |
3986
- | ---------- | ---- | -------- | ----------- || currency | string | yes | || failure_callback_url | string | yes | || meta | string | no | || payment_link_id | string | yes | || payment_methods | [CreateOrderUserPaymentMethods](#CreateOrderUserPaymentMethods) | yes | || success_callback_url | string | yes | |
3987
-
3988
- ---
3989
-
3990
- #### [CreateOrderUserResponse](#CreateOrderUserResponse)
3991
-
3992
- | Properties | Type | Nullable | Description |
3993
- | ---------- | ---- | -------- | ----------- || callback_url | string | no | || data | [CreateOrderUserData](#CreateOrderUserData) | no | || message | string | yes | || order_id | string | no | || payment_confirm_url | string | no | || status_code | number | yes | || success | boolean | yes | |
3994
-
3995
- ---
3996
-
3997
- #### [CreatePaymentLinkMeta](#CreatePaymentLinkMeta)
3998
-
3999
- | Properties | Type | Nullable | Description |
4000
- | ---------- | ---- | -------- | ----------- || amount | string | yes | || assign_card_id | string | no | || cart_id | string | yes | || checkout_mode | string | yes | || pincode | string | yes | |
4001
-
4002
- ---
4003
-
4004
- #### [CreatePaymentLinkRequest](#CreatePaymentLinkRequest)
4005
-
4006
- | Properties | Type | Nullable | Description |
4007
- | ---------- | ---- | -------- | ----------- || amount | number | yes | || description | string | no | || email | string | yes | || external_order_id | string | yes | || meta | [CreatePaymentLinkMeta](#CreatePaymentLinkMeta) | yes | || mobile_number | string | yes | |
4008
-
4009
- ---
4010
-
4011
- #### [CreatePaymentLinkResponse](#CreatePaymentLinkResponse)
4012
-
4013
- | Properties | Type | Nullable | Description |
4014
- | ---------- | ---- | -------- | ----------- || message | string | yes | || payment_link_id | string | no | || payment_link_url | string | no | || polling_timeout | number | no | || status_code | number | yes | || success | boolean | yes | |
4015
-
4016
- ---
4017
-
4018
- #### [CreditDetail](#CreditDetail)
4019
-
4020
- | Properties | Type | Nullable | Description |
4021
- | ---------- | ---- | -------- | ----------- || is_registered | boolean | yes | || signup_url | string | yes | || status | boolean | yes | |
4022
-
4023
- ---
4024
-
4025
- #### [CreditSummary](#CreditSummary)
4026
-
4027
- | Properties | Type | Nullable | Description |
4028
- | ---------- | ---- | -------- | ----------- || balance | [BalanceDetails](#BalanceDetails) | no | || merchant_customer_ref_id | string | yes | || status | string | yes | || status_message | string | yes | |
4029
-
4030
- ---
4031
-
4032
- #### [CustomerCreditSummaryResponse](#CustomerCreditSummaryResponse)
4033
-
4034
- | Properties | Type | Nullable | Description |
4035
- | ---------- | ---- | -------- | ----------- || data | [CreditSummary](#CreditSummary) | no | || success | boolean | yes | |
4036
-
4037
- ---
4038
-
4039
- #### [CustomerOnboardingRequest](#CustomerOnboardingRequest)
4040
-
4041
- | Properties | Type | Nullable | Description |
4042
- | ---------- | ---- | -------- | ----------- || aggregator | string | yes | || business_info | [BusinessDetails](#BusinessDetails) | no | || device | [DeviceDetails](#DeviceDetails) | no | || marketplace_info | [MarketplaceInfo](#MarketplaceInfo) | no | || mcc | string | no | || personal_info | [UserPersonalInfoInDetails](#UserPersonalInfoInDetails) | yes | || source | string | yes | |
4043
-
4044
- ---
4045
-
4046
- #### [CustomerOnboardingResponse](#CustomerOnboardingResponse)
4047
-
4048
- | Properties | Type | Nullable | Description |
4049
- | ---------- | ---- | -------- | ----------- || data | [OnboardSummary](#OnboardSummary) | yes | || success | boolean | yes | |
4050
-
4051
- ---
4052
-
4053
- #### [DeleteCardsResponse](#DeleteCardsResponse)
4054
-
4055
- | Properties | Type | Nullable | Description |
4056
- | ---------- | ---- | -------- | ----------- || message | string | no | || success | boolean | yes | |
4057
-
4058
- ---
4059
-
4060
- #### [DeletehCardRequest](#DeletehCardRequest)
4061
-
4062
- | Properties | Type | Nullable | Description |
4063
- | ---------- | ---- | -------- | ----------- || card_id | string | yes | |
4064
-
4065
- ---
4066
-
4067
- #### [DeviceDetails](#DeviceDetails)
4068
-
4069
- | Properties | Type | Nullable | Description |
4070
- | ---------- | ---- | -------- | ----------- || device_make | string | no | || device_model | string | no | || device_type | string | no | || identification_number | string | no | || identifier_type | string | no | || os | string | no | || os_version | string | no | |
4071
-
4072
- ---
4073
-
4074
- #### [EpaylaterBannerData](#EpaylaterBannerData)
4075
-
4076
- | Properties | Type | Nullable | Description |
4077
- | ---------- | ---- | -------- | ----------- || display | boolean | yes | || message | string | no | || status | string | no | |
4078
-
4079
- ---
4080
-
4081
- #### [EpaylaterBannerResponse](#EpaylaterBannerResponse)
4082
-
4083
- | Properties | Type | Nullable | Description |
4084
- | ---------- | ---- | -------- | ----------- || data | [EpaylaterBannerData](#EpaylaterBannerData) | yes | || success | boolean | yes | |
4085
-
4086
- ---
4087
-
4088
- #### [ErrorCodeAndDescription](#ErrorCodeAndDescription)
4089
-
4090
- | Properties | Type | Nullable | Description |
4091
- | ---------- | ---- | -------- | ----------- || code | string | yes | || description | string | yes | |
4092
-
4093
- ---
4094
-
4095
- #### [ErrorCodeDescription](#ErrorCodeDescription)
4096
-
4097
- | Properties | Type | Nullable | Description |
4098
- | ---------- | ---- | -------- | ----------- || code | string | yes | || description | string | yes | || success | boolean | yes | |
4099
-
4100
- ---
4101
-
4102
- #### [ErrorDescription](#ErrorDescription)
4103
-
4104
- | Properties | Type | Nullable | Description |
4105
- | ---------- | ---- | -------- | ----------- || amount | number | no | || cancelled | boolean | no | || expired | boolean | no | || invalid_id | boolean | no | || merchant_name | string | no | || merchant_order_id | string | no | || msg | string | no | || payment_transaction_id | string | no | |
4106
-
4107
- ---
4108
-
4109
- #### [ErrorResponse](#ErrorResponse)
4110
-
4111
- | Properties | Type | Nullable | Description |
4112
- | ---------- | ---- | -------- | ----------- || error | [ErrorDescription](#ErrorDescription) | no | || message | string | yes | || status_code | number | yes | || success | boolean | yes | |
4113
-
4114
- ---
4115
-
4116
- #### [GetPaymentLinkResponse](#GetPaymentLinkResponse)
4117
-
4118
- | Properties | Type | Nullable | Description |
4119
- | ---------- | ---- | -------- | ----------- || amount | number | no | || external_order_id | string | no | || merchant_name | string | no | || message | string | yes | || payment_link_current_status | string | no | || payment_link_url | string | no | || polling_timeout | number | no | || status_code | number | yes | || success | boolean | yes | |
4120
-
4121
- ---
4122
-
4123
- #### [HttpErrorCodeAndResponse](#HttpErrorCodeAndResponse)
4124
-
4125
- | Properties | Type | Nullable | Description |
4126
- | ---------- | ---- | -------- | ----------- || error | [ErrorCodeAndDescription](#ErrorCodeAndDescription) | yes | || success | boolean | yes | |
4127
-
4128
- ---
4129
-
4130
- #### [IfscCodeResponse](#IfscCodeResponse)
4131
-
4132
- | Properties | Type | Nullable | Description |
4133
- | ---------- | ---- | -------- | ----------- || bank_name | string | yes | || branch_name | string | yes | || success | boolean | no | |
4134
-
4135
- ---
4136
-
4137
- #### [IntentApp](#IntentApp)
4138
-
4139
- | Properties | Type | Nullable | Description |
4140
- | ---------- | ---- | -------- | ----------- || code | string | no | || display_name | string | no | || logos | [PaymentModeLogo](#PaymentModeLogo) | no | || package_name | string | no | |
4141
-
4142
- ---
4143
-
4144
- #### [IntentAppErrorList](#IntentAppErrorList)
4145
-
4146
- | Properties | Type | Nullable | Description |
4147
- | ---------- | ---- | -------- | ----------- || code | string | no | || package_name | string | no | |
4148
-
4149
- ---
4150
-
4151
- #### [KYCAddress](#KYCAddress)
4152
-
4153
- | Properties | Type | Nullable | Description |
4154
- | ---------- | ---- | -------- | ----------- || addressline1 | string | yes | || addressline2 | string | no | || city | string | yes | || land_mark | string | no | || ownership_type | string | no | || pincode | string | yes | || state | string | yes | |
4155
-
4156
- ---
4157
-
4158
- #### [LinkStatus](#LinkStatus)
4159
-
4160
- | Properties | Type | Nullable | Description |
4161
- | ---------- | ---- | -------- | ----------- || message | string | yes | || status | boolean | yes | |
4162
-
4163
- ---
4164
-
4165
- #### [ListCardsResponse](#ListCardsResponse)
4166
-
4167
- | Properties | Type | Nullable | Description |
4168
- | ---------- | ---- | -------- | ----------- || data | [[Card](#Card)] | no | || message | string | yes | || success | boolean | yes | |
4169
-
4170
- ---
4171
-
4172
- #### [MarketplaceInfo](#MarketplaceInfo)
4173
-
4174
- | Properties | Type | Nullable | Description |
4175
- | ---------- | ---- | -------- | ----------- || date_of_joining | string | no | || membership_id | string | yes | || name | string | yes | |
4176
-
4177
- ---
4178
-
4179
- #### [NotFoundResourceError](#NotFoundResourceError)
4180
-
4181
- | Properties | Type | Nullable | Description |
4182
- | ---------- | ---- | -------- | ----------- || code | string | yes | || description | string | yes | || success | boolean | yes | |
4183
-
4184
- ---
4185
-
4186
- #### [OnboardSummary](#OnboardSummary)
4187
-
4188
- | Properties | Type | Nullable | Description |
4189
- | ---------- | ---- | -------- | ----------- || redirect_url | string | yes | || session | string | yes | || status | boolean | yes | |
4190
-
4191
- ---
4192
-
4193
- #### [OrderBeneficiaryDetails](#OrderBeneficiaryDetails)
4194
-
4195
- | Properties | Type | Nullable | Description |
4196
- | ---------- | ---- | -------- | ----------- || 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 | |
4197
-
4198
- ---
4199
-
4200
- #### [OrderBeneficiaryResponse](#OrderBeneficiaryResponse)
4201
-
4202
- | Properties | Type | Nullable | Description |
4203
- | ---------- | ---- | -------- | ----------- || beneficiaries | [[OrderBeneficiaryDetails](#OrderBeneficiaryDetails)] | no | || show_beneficiary_details | boolean | no | |
4204
-
4205
- ---
4206
-
4207
- #### [PaymentFlow](#PaymentFlow)
4208
-
4209
- | Properties | Type | Nullable | Description |
4210
- | ---------- | ---- | -------- | ----------- || bqr_razorpay | [AggregatorRoute](#AggregatorRoute) | no | || ccavenue | [AggregatorRoute](#AggregatorRoute) | no | || epaylater | [AggregatorRoute](#AggregatorRoute) | no | || fynd | [AggregatorRoute](#AggregatorRoute) | no | || jiopay | [AggregatorRoute](#AggregatorRoute) | no | || juspay | [AggregatorRoute](#AggregatorRoute) | no | || mswipe | [AggregatorRoute](#AggregatorRoute) | no | || payubiz | [AggregatorRoute](#AggregatorRoute) | no | || razorpay | [AggregatorRoute](#AggregatorRoute) | no | || rupifi | [AggregatorRoute](#AggregatorRoute) | no | || simpl | [AggregatorRoute](#AggregatorRoute) | no | || stripe | [AggregatorRoute](#AggregatorRoute) | no | || upi_razorpay | [AggregatorRoute](#AggregatorRoute) | no | |
4211
-
4212
- ---
4213
-
4214
- #### [PaymentInitializationRequest](#PaymentInitializationRequest)
4215
-
4216
- | Properties | Type | Nullable | Description |
4217
- | ---------- | ---- | -------- | ----------- || aggregator | string | yes | || amount | number | yes | || contact | string | yes | || currency | string | yes | || customer_id | string | yes | || email | string | yes | || merchant_order_id | string | yes | || method | string | yes | || order_id | string | yes | || razorpay_payment_id | string | no | || timeout | number | no | || vpa | string | no | |
4218
-
4219
- ---
4220
-
4221
- #### [PaymentInitializationResponse](#PaymentInitializationResponse)
4222
-
4223
- | Properties | Type | Nullable | Description |
4224
- | ---------- | ---- | -------- | ----------- || aggregator | string | yes | || aggregator_order_id | string | no | || amount | number | no | || bqr_image | string | no | || currency | string | no | || customer_id | string | no | || merchant_order_id | string | yes | || method | string | yes | || polling_url | string | yes | || razorpay_payment_id | string | no | || status | string | no | || success | boolean | yes | || timeout | number | no | || upi_poll_url | string | no | || virtual_id | string | no | || vpa | string | no | |
4225
-
4226
- ---
4227
-
4228
- #### [PaymentMethodsMeta](#PaymentMethodsMeta)
4229
-
4230
- | Properties | Type | Nullable | Description |
4231
- | ---------- | ---- | -------- | ----------- || merchant_code | string | yes | || payment_gateway | string | yes | || payment_identifier | string | yes | |
4232
-
4233
- ---
4234
-
4235
- #### [PaymentModeList](#PaymentModeList)
4236
-
4237
- | Properties | Type | Nullable | Description |
4238
- | ---------- | ---- | -------- | ----------- || 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 | |
4239
-
4240
- ---
4241
-
4242
- #### [PaymentModeLogo](#PaymentModeLogo)
4243
-
4244
- | Properties | Type | Nullable | Description |
4245
- | ---------- | ---- | -------- | ----------- || large | string | yes | || small | string | yes | |
4246
-
4247
- ---
4248
-
4249
- #### [PaymentModeRouteResponse](#PaymentModeRouteResponse)
4250
-
4251
- | Properties | Type | Nullable | Description |
4252
- | ---------- | ---- | -------- | ----------- || payment_options | [PaymentOptionAndFlow](#PaymentOptionAndFlow) | yes | || success | boolean | yes | |
4253
-
4254
- ---
4255
-
4256
- #### [PaymentOptionAndFlow](#PaymentOptionAndFlow)
4257
-
4258
- | Properties | Type | Nullable | Description |
4259
- | ---------- | ---- | -------- | ----------- || payment_flows | [PaymentFlow](#PaymentFlow) | yes | || payment_option | [[RootPaymentMode](#RootPaymentMode)] | yes | |
4260
-
4261
- ---
4262
-
4263
- #### [PaymentStatusUpdateRequest](#PaymentStatusUpdateRequest)
4264
-
4265
- | Properties | Type | Nullable | Description |
4266
- | ---------- | ---- | -------- | ----------- || aggregator | string | yes | || amount | number | yes | || contact | string | yes | || currency | string | yes | || customer_id | string | yes | || email | string | yes | || merchant_order_id | string | yes | || method | string | yes | || order_id | string | yes | || status | string | yes | || vpa | string | yes | |
4267
-
4268
- ---
4269
-
4270
- #### [PaymentStatusUpdateResponse](#PaymentStatusUpdateResponse)
4271
-
4272
- | Properties | Type | Nullable | Description |
4273
- | ---------- | ---- | -------- | ----------- || aggregator_name | string | yes | || redirect_url | string | no | || retry | boolean | yes | || status | string | yes | || success | boolean | no | |
4274
-
4275
- ---
4276
-
4277
- #### [PollingPaymentLinkResponse](#PollingPaymentLinkResponse)
4278
-
4279
- | Properties | Type | Nullable | Description |
4280
- | ---------- | ---- | -------- | ----------- || aggregator_name | string | no | || amount | number | no | || http_status | number | no | || message | string | no | || order_id | string | no | || payment_link_id | string | no | || redirect_url | string | no | || status | string | no | || status_code | number | no | || success | boolean | no | |
4281
-
4282
- ---
4283
-
4284
- #### [RedirectToAggregatorResponse](#RedirectToAggregatorResponse)
4285
-
4286
- | Properties | Type | Nullable | Description |
4287
- | ---------- | ---- | -------- | ----------- || data | [RedirectURL](#RedirectURL) | yes | || success | boolean | yes | |
4288
-
4289
- ---
4290
-
4291
- #### [RedirectURL](#RedirectURL)
4292
-
4293
- | Properties | Type | Nullable | Description |
4294
- | ---------- | ---- | -------- | ----------- || signup_url | string | yes | || status | boolean | yes | |
4295
-
4296
- ---
4297
-
4298
- #### [RefundAccountResponse](#RefundAccountResponse)
4299
-
4300
- | Properties | Type | Nullable | Description |
4301
- | ---------- | ---- | -------- | ----------- || data | string | no | || is_verified_flag | boolean | no | || message | string | yes | || success | boolean | yes | |
4302
-
4303
- ---
4304
-
4305
- #### [renderHTMLRequest](#renderHTMLRequest)
4306
-
4307
- | Properties | Type | Nullable | Description |
4308
- | ---------- | ---- | -------- | ----------- || base64_html | string | yes | || returntype | string | no | |
4309
-
4310
- ---
4311
-
4312
- #### [renderHTMLResponse](#renderHTMLResponse)
4313
-
4314
- | Properties | Type | Nullable | Description |
4315
- | ---------- | ---- | -------- | ----------- || html | string | yes | |
4316
-
4317
- ---
4318
-
4319
- #### [ResendOrCancelPaymentRequest](#ResendOrCancelPaymentRequest)
4320
-
4321
- | Properties | Type | Nullable | Description |
4322
- | ---------- | ---- | -------- | ----------- || order_id | string | yes | || request_type | string | yes | |
4323
-
4324
- ---
4325
-
4326
- #### [ResendOrCancelPaymentResponse](#ResendOrCancelPaymentResponse)
4327
-
4328
- | Properties | Type | Nullable | Description |
4329
- | ---------- | ---- | -------- | ----------- || data | [LinkStatus](#LinkStatus) | yes | || success | boolean | yes | |
4330
-
4331
- ---
4332
-
4333
- #### [ResendPaymentLinkResponse](#ResendPaymentLinkResponse)
4334
-
4335
- | Properties | Type | Nullable | Description |
4336
- | ---------- | ---- | -------- | ----------- || message | string | yes | || polling_timeout | number | no | || status_code | number | yes | || success | boolean | yes | |
4337
-
4338
- ---
4339
-
4340
- #### [RootPaymentMode](#RootPaymentMode)
4341
-
4342
- | Properties | Type | Nullable | Description |
4343
- | ---------- | ---- | -------- | ----------- || 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 | |
4344
-
4345
- ---
4346
-
4347
- #### [RupifiBannerData](#RupifiBannerData)
4348
-
4349
- | Properties | Type | Nullable | Description |
4350
- | ---------- | ---- | -------- | ----------- || kyc_url | string | no | || status | string | no | |
4351
-
4352
- ---
4353
-
4354
- #### [RupifiBannerResponse](#RupifiBannerResponse)
4355
-
4356
- | Properties | Type | Nullable | Description |
4357
- | ---------- | ---- | -------- | ----------- || data | [RupifiBannerData](#RupifiBannerData) | yes | || success | boolean | yes | |
4358
-
4359
- ---
4360
-
4361
- #### [SetDefaultBeneficiaryRequest](#SetDefaultBeneficiaryRequest)
4362
-
4363
- | Properties | Type | Nullable | Description |
4364
- | ---------- | ---- | -------- | ----------- || beneficiary_id | string | yes | || order_id | string | yes | |
4365
-
4366
- ---
4367
-
4368
- #### [SetDefaultBeneficiaryResponse](#SetDefaultBeneficiaryResponse)
4369
-
4370
- | Properties | Type | Nullable | Description |
4371
- | ---------- | ---- | -------- | ----------- || is_beneficiary_set | boolean | yes | || success | boolean | no | |
4372
-
4373
- ---
4374
-
4375
- #### [TransferItemsDetails](#TransferItemsDetails)
4376
-
4377
- | Properties | Type | Nullable | Description |
4378
- | ---------- | ---- | -------- | ----------- || display_name | string | no | || id | number | yes | || logo_large | string | yes | || logo_small | string | yes | || name | string | yes | |
4379
-
4380
- ---
4381
-
4382
- #### [TransferModeDetails](#TransferModeDetails)
4383
-
4384
- | Properties | Type | Nullable | Description |
4385
- | ---------- | ---- | -------- | ----------- || display_name | string | yes | || items | [[TransferItemsDetails](#TransferItemsDetails)] | no | |
4386
-
4387
- ---
4388
-
4389
- #### [TransferModeResponse](#TransferModeResponse)
4390
-
4391
- | Properties | Type | Nullable | Description |
4392
- | ---------- | ---- | -------- | ----------- || data | [[TransferModeDetails](#TransferModeDetails)] | yes | |
4393
-
4394
- ---
4395
-
4396
- #### [UpdateRefundTransferModeRequest](#UpdateRefundTransferModeRequest)
4397
-
4398
- | Properties | Type | Nullable | Description |
4399
- | ---------- | ---- | -------- | ----------- || enable | boolean | yes | || transfer_mode | string | yes | |
4400
-
4401
- ---
4402
-
4403
- #### [UpdateRefundTransferModeResponse](#UpdateRefundTransferModeResponse)
4404
-
4405
- | Properties | Type | Nullable | Description |
4406
- | ---------- | ---- | -------- | ----------- || success | boolean | no | |
4407
-
4408
- ---
4409
-
4410
- #### [UserPersonalInfoInDetails](#UserPersonalInfoInDetails)
4411
-
4412
- | Properties | Type | Nullable | Description |
4413
- | ---------- | ---- | -------- | ----------- || address_as_per_id | [KYCAddress](#KYCAddress) | yes | || dob | string | yes | || driving_license | string | no | || email | string | no | || email_verified | boolean | yes | || fathers_name | string | no | || first_name | string | yes | || gender | string | no | || last_name | string | no | || middle_name | string | no | || mobile_verified | boolean | yes | || mothers_name | string | no | || pan | string | no | || passport | string | no | || phone | string | yes | || voter_id | string | no | |
4414
-
4415
- ---
4416
-
4417
- #### [ValidateCustomerRequest](#ValidateCustomerRequest)
4418
-
4419
- | Properties | Type | Nullable | Description |
4420
- | ---------- | ---- | -------- | ----------- || aggregator | string | yes | || billing_address | string | no | || delivery_address | string | no | || merchant_params | string | no | || order_items | [string] | no | || payload | string | no | || phone_number | string | yes | || transaction_amount_in_paise | number | yes | |
4421
-
4422
- ---
4423
-
4424
- #### [ValidateCustomerResponse](#ValidateCustomerResponse)
4425
-
4426
- | Properties | Type | Nullable | Description |
4427
- | ---------- | ---- | -------- | ----------- || data | string | yes | || message | string | yes | || success | boolean | yes | |
4428
-
4429
- ---
4430
-
4431
- #### [ValidateUPI](#ValidateUPI)
4432
-
4433
- | Properties | Type | Nullable | Description |
4434
- | ---------- | ---- | -------- | ----------- || customer_name | string | yes | || is_valid | boolean | yes | || status | string | yes | || upi_vpa | string | yes | |
4435
-
4436
- ---
4437
-
4438
- #### [ValidateVPARequest](#ValidateVPARequest)
4439
-
4440
- | Properties | Type | Nullable | Description |
4441
- | ---------- | ---- | -------- | ----------- || upi_vpa | string | yes | |
4442
-
4443
- ---
4444
-
4445
- #### [ValidateVPAResponse](#ValidateVPAResponse)
4446
-
4447
- | Properties | Type | Nullable | Description |
4448
- | ---------- | ---- | -------- | ----------- || data | [ValidateUPI](#ValidateUPI) | yes | || success | boolean | yes | |
4449
-
4450
- ---
4451
-
4452
- #### [WalletOtpRequest](#WalletOtpRequest)
4453
-
4454
- | Properties | Type | Nullable | Description |
4455
- | ---------- | ---- | -------- | ----------- || country_code | string | yes | || mobile | string | yes | |
4456
-
4457
- ---
4458
-
4459
- #### [WalletOtpResponse](#WalletOtpResponse)
4460
-
4461
- | Properties | Type | Nullable | Description |
4462
- | ---------- | ---- | -------- | ----------- || is_verified_flag | string | yes | || request_id | string | yes | || success | boolean | no | |
4463
-
4464
- ---
4465
-
4466
- #### [WrongOtpError](#WrongOtpError)
4467
-
4468
- | Properties | Type | Nullable | Description |
4469
- | ---------- | ---- | -------- | ----------- || description | string | yes | || is_verified_flag | boolean | yes | || success | string | yes | |
4470
-
4471
- ---
4472
-
4473
-
4474
-
4475
-