@gofynd/fdk-client-javascript 1.4.14 → 1.4.15-beta.10

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 (326) hide show
  1. package/README.md +2 -2
  2. package/application.d.ts +1 -2
  3. package/application.js +2 -3
  4. package/index.d.ts +1 -2
  5. package/index.js +7 -1
  6. package/package.json +2 -3
  7. package/sdk/application/ApplicationClient.d.ts +0 -2
  8. package/sdk/application/ApplicationClient.js +0 -20
  9. package/sdk/application/Cart/CartApplicationClient.d.ts +55 -97
  10. package/sdk/application/Cart/CartApplicationClient.js +60 -1262
  11. package/sdk/application/Catalog/CatalogApplicationClient.d.ts +80 -162
  12. package/sdk/application/Catalog/CatalogApplicationClient.js +148 -1313
  13. package/sdk/application/Common/CommonApplicationClient.d.ts +4 -9
  14. package/sdk/application/Common/CommonApplicationClient.js +5 -90
  15. package/sdk/application/Communication/CommunicationApplicationClient.d.ts +6 -19
  16. package/sdk/application/Communication/CommunicationApplicationClient.js +6 -145
  17. package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +32 -80
  18. package/sdk/application/Configuration/ConfigurationApplicationClient.js +31 -725
  19. package/sdk/application/Content/ContentApplicationClient.d.ts +63 -85
  20. package/sdk/application/Content/ContentApplicationClient.js +126 -942
  21. package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +11 -15
  22. package/sdk/application/FileStorage/FileStorageApplicationClient.js +26 -130
  23. package/sdk/application/Lead/LeadApplicationClient.d.ts +10 -17
  24. package/sdk/application/Lead/LeadApplicationClient.js +32 -201
  25. package/sdk/application/Logistic/LogisticApplicationClient.d.ts +22 -62
  26. package/sdk/application/Logistic/LogisticApplicationClient.js +51 -647
  27. package/sdk/application/Order/OrderApplicationClient.d.ts +22 -56
  28. package/sdk/application/Order/OrderApplicationClient.js +86 -555
  29. package/sdk/application/Payment/PaymentApplicationClient.d.ts +92 -209
  30. package/sdk/application/Payment/PaymentApplicationClient.js +57 -2099
  31. package/sdk/application/Rewards/RewardsApplicationClient.d.ts +15 -26
  32. package/sdk/application/Rewards/RewardsApplicationClient.js +17 -303
  33. package/sdk/application/Share/ShareApplicationClient.d.ts +14 -24
  34. package/sdk/application/Share/ShareApplicationClient.js +34 -294
  35. package/sdk/application/Theme/ThemeApplicationClient.d.ts +8 -14
  36. package/sdk/application/Theme/ThemeApplicationClient.js +30 -166
  37. package/sdk/application/User/UserApplicationClient.d.ts +87 -138
  38. package/sdk/application/User/UserApplicationClient.js +47 -1817
  39. package/sdk/application/Webhook/WebhookApplicationClient.d.ts +4 -7
  40. package/sdk/application/Webhook/WebhookApplicationClient.js +6 -49
  41. package/sdk/application/index.d.ts +0 -19
  42. package/sdk/application/index.js +0 -35
  43. package/sdk/common/Utility.d.ts +1 -1
  44. package/sdk/common/Utility.js +10 -7
  45. package/sdk/common/Validator.d.ts +1 -0
  46. package/sdk/common/Validator.js +20 -0
  47. package/sdk/common/utils.d.ts +0 -1
  48. package/sdk/common/utils.js +0 -14
  49. package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +12 -86
  50. package/sdk/partner/FileStorage/FileStoragePartnerClient.js +24 -582
  51. package/sdk/partner/FileStorage/FileStoragePartnerModel.d.ts +21 -116
  52. package/sdk/partner/FileStorage/FileStoragePartnerModel.js +16 -121
  53. package/sdk/partner/FileStorage/FileStoragePartnerValidator.d.ts +1 -8
  54. package/sdk/partner/FileStorage/FileStoragePartnerValidator.js +4 -51
  55. package/sdk/partner/Lead/LeadPartnerClient.d.ts +2 -2
  56. package/sdk/partner/Lead/LeadPartnerClient.js +2 -2
  57. package/sdk/partner/Lead/LeadPartnerModel.d.ts +5 -5
  58. package/sdk/partner/Lead/LeadPartnerModel.js +15 -15
  59. package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +20 -126
  60. package/sdk/partner/Logistics/LogisticsPartnerClient.js +20 -970
  61. package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +85 -767
  62. package/sdk/partner/Logistics/LogisticsPartnerModel.js +76 -429
  63. package/sdk/partner/Logistics/LogisticsPartnerValidator.d.ts +0 -10
  64. package/sdk/partner/Logistics/LogisticsPartnerValidator.js +6 -120
  65. package/sdk/partner/OAuthClient.js +1 -0
  66. package/sdk/partner/Theme/ThemePartnerClient.d.ts +10 -8
  67. package/sdk/partner/Theme/ThemePartnerClient.js +16 -14
  68. package/sdk/partner/Theme/ThemePartnerModel.d.ts +39 -135
  69. package/sdk/partner/Theme/ThemePartnerModel.js +38 -114
  70. package/sdk/partner/Theme/ThemePartnerValidator.js +4 -4
  71. package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +18 -28
  72. package/sdk/partner/Webhook/WebhookPartnerClient.js +18 -103
  73. package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +179 -612
  74. package/sdk/partner/Webhook/WebhookPartnerModel.js +150 -253
  75. package/sdk/partner/Webhook/WebhookPartnerValidator.d.ts +0 -1
  76. package/sdk/partner/Webhook/WebhookPartnerValidator.js +3 -11
  77. package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.d.ts +4 -5
  78. package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.js +8 -14
  79. package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +9 -59
  80. package/sdk/platform/Analytics/AnalyticsPlatformModel.js +4 -40
  81. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +32 -2
  82. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +243 -3
  83. package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +130 -11
  84. package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +152 -12
  85. package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +39 -1
  86. package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.js +35 -0
  87. package/sdk/platform/Billing/BillingPlatformClient.d.ts +12 -12
  88. package/sdk/platform/Billing/BillingPlatformClient.js +15 -15
  89. package/sdk/platform/Billing/BillingPlatformModel.d.ts +388 -443
  90. package/sdk/platform/Billing/BillingPlatformModel.js +263 -280
  91. package/sdk/platform/Billing/BillingPlatformValidator.d.ts +18 -16
  92. package/sdk/platform/Billing/BillingPlatformValidator.js +9 -8
  93. package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +103 -134
  94. package/sdk/platform/Cart/CartPlatformApplicationClient.js +112 -407
  95. package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +65 -111
  96. package/sdk/platform/Cart/CartPlatformApplicationValidator.js +44 -106
  97. package/sdk/platform/Cart/CartPlatformModel.d.ts +1328 -4975
  98. package/sdk/platform/Cart/CartPlatformModel.js +1229 -1922
  99. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +183 -208
  100. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +358 -383
  101. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +126 -122
  102. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +68 -66
  103. package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +118 -141
  104. package/sdk/platform/Catalog/CatalogPlatformClient.js +170 -193
  105. package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +1744 -1501
  106. package/sdk/platform/Catalog/CatalogPlatformModel.js +1211 -1383
  107. package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +18 -18
  108. package/sdk/platform/Catalog/CatalogPlatformValidator.js +18 -18
  109. package/sdk/platform/Common/CommonPlatformClient.d.ts +2 -3
  110. package/sdk/platform/Common/CommonPlatformClient.js +2 -3
  111. package/sdk/platform/Common/CommonPlatformModel.d.ts +9 -9
  112. package/sdk/platform/Common/CommonPlatformModel.js +6 -6
  113. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +17 -16
  114. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +17 -16
  115. package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +8 -8
  116. package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +8 -8
  117. package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +33 -43
  118. package/sdk/platform/Communication/CommunicationPlatformModel.js +34 -38
  119. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +42 -46
  120. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +43 -47
  121. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +223 -223
  122. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +212 -210
  123. package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +12 -12
  124. package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +12 -12
  125. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +33 -46
  126. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +54 -67
  127. package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +18 -18
  128. package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +18 -18
  129. package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +24 -45
  130. package/sdk/platform/Configuration/ConfigurationPlatformClient.js +30 -134
  131. package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +138 -283
  132. package/sdk/platform/Configuration/ConfigurationPlatformModel.js +100 -219
  133. package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +9 -37
  134. package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +8 -27
  135. package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +141 -124
  136. package/sdk/platform/Content/ContentPlatformApplicationClient.js +422 -449
  137. package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +141 -179
  138. package/sdk/platform/Content/ContentPlatformApplicationValidator.js +130 -168
  139. package/sdk/platform/Content/ContentPlatformClient.d.ts +106 -142
  140. package/sdk/platform/Content/ContentPlatformClient.js +336 -523
  141. package/sdk/platform/Content/ContentPlatformModel.d.ts +395 -1241
  142. package/sdk/platform/Content/ContentPlatformModel.js +390 -521
  143. package/sdk/platform/Content/ContentPlatformValidator.d.ts +117 -168
  144. package/sdk/platform/Content/ContentPlatformValidator.js +108 -162
  145. package/sdk/platform/Discount/DiscountPlatformClient.d.ts +12 -14
  146. package/sdk/platform/Discount/DiscountPlatformClient.js +12 -14
  147. package/sdk/platform/Discount/DiscountPlatformModel.d.ts +13 -13
  148. package/sdk/platform/Discount/DiscountPlatformModel.js +12 -12
  149. package/sdk/platform/Discount/DiscountPlatformValidator.d.ts +2 -2
  150. package/sdk/platform/Discount/DiscountPlatformValidator.js +2 -2
  151. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +39 -95
  152. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +63 -462
  153. package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +15 -62
  154. package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +13 -75
  155. package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +22 -20
  156. package/sdk/platform/FileStorage/FileStoragePlatformClient.js +24 -21
  157. package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +116 -370
  158. package/sdk/platform/FileStorage/FileStoragePlatformModel.js +104 -313
  159. package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +6 -6
  160. package/sdk/platform/FileStorage/FileStoragePlatformValidator.js +6 -6
  161. package/sdk/platform/Finance/FinancePlatformClient.d.ts +320 -0
  162. package/sdk/platform/Finance/FinancePlatformClient.js +2333 -0
  163. package/sdk/platform/Finance/FinancePlatformModel.d.ts +2890 -0
  164. package/sdk/platform/Finance/FinancePlatformModel.js +2148 -0
  165. package/sdk/platform/Finance/FinancePlatformValidator.d.ts +284 -0
  166. package/sdk/platform/Finance/FinancePlatformValidator.js +354 -0
  167. package/sdk/platform/Lead/LeadPlatformClient.d.ts +2 -2
  168. package/sdk/platform/Lead/LeadPlatformClient.js +2 -2
  169. package/sdk/platform/Lead/LeadPlatformModel.d.ts +5 -5
  170. package/sdk/platform/Lead/LeadPlatformModel.js +16 -16
  171. package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +4 -25
  172. package/sdk/platform/Order/OrderPlatformApplicationClient.js +5 -175
  173. package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +4 -52
  174. package/sdk/platform/Order/OrderPlatformApplicationValidator.js +3 -34
  175. package/sdk/platform/Order/OrderPlatformClient.d.ts +103 -174
  176. package/sdk/platform/Order/OrderPlatformClient.js +275 -528
  177. package/sdk/platform/Order/OrderPlatformModel.d.ts +3078 -5449
  178. package/sdk/platform/Order/OrderPlatformModel.js +1659 -3501
  179. package/sdk/platform/Order/OrderPlatformValidator.d.ts +219 -234
  180. package/sdk/platform/Order/OrderPlatformValidator.js +118 -146
  181. package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +4 -6
  182. package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +7 -9
  183. package/sdk/platform/Partner/PartnerPlatformModel.d.ts +9 -9
  184. package/sdk/platform/Partner/PartnerPlatformModel.js +8 -8
  185. package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +106 -94
  186. package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +146 -131
  187. package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +93 -64
  188. package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +70 -62
  189. package/sdk/platform/Payment/PaymentPlatformClient.d.ts +20 -20
  190. package/sdk/platform/Payment/PaymentPlatformClient.js +20 -20
  191. package/sdk/platform/Payment/PaymentPlatformModel.d.ts +507 -386
  192. package/sdk/platform/Payment/PaymentPlatformModel.js +376 -323
  193. package/sdk/platform/Payment/PaymentPlatformValidator.d.ts +10 -10
  194. package/sdk/platform/Payment/PaymentPlatformValidator.js +10 -10
  195. package/sdk/platform/PlatformClient.d.ts +2 -0
  196. package/sdk/platform/PlatformClient.js +4 -0
  197. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +2 -2
  198. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +2 -2
  199. package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.d.ts +2 -2
  200. package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.js +2 -2
  201. package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +9 -9
  202. package/sdk/platform/Rewards/RewardsPlatformModel.js +8 -8
  203. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +35 -45
  204. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +38 -117
  205. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +13 -22
  206. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +12 -24
  207. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +46 -40
  208. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +68 -62
  209. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +396 -620
  210. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +326 -501
  211. package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +11 -11
  212. package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +10 -10
  213. package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +2 -2
  214. package/sdk/platform/Share/SharePlatformApplicationClient.js +2 -2
  215. package/sdk/platform/Share/SharePlatformModel.d.ts +5 -36
  216. package/sdk/platform/Share/SharePlatformModel.js +4 -27
  217. package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +3 -3
  218. package/sdk/platform/Theme/ThemePlatformApplicationClient.js +4 -8
  219. package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +0 -5
  220. package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +0 -2
  221. package/sdk/platform/Theme/ThemePlatformModel.d.ts +13 -76
  222. package/sdk/platform/Theme/ThemePlatformModel.js +17 -57
  223. package/sdk/platform/User/UserPlatformApplicationClient.d.ts +12 -12
  224. package/sdk/platform/User/UserPlatformApplicationClient.js +12 -12
  225. package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +2 -2
  226. package/sdk/platform/User/UserPlatformApplicationValidator.js +2 -2
  227. package/sdk/platform/User/UserPlatformModel.d.ts +21 -21
  228. package/sdk/platform/User/UserPlatformModel.js +23 -23
  229. package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +78 -25
  230. package/sdk/platform/Webhook/WebhookPlatformClient.js +470 -75
  231. package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +427 -720
  232. package/sdk/platform/Webhook/WebhookPlatformModel.js +386 -410
  233. package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +55 -10
  234. package/sdk/platform/Webhook/WebhookPlatformValidator.js +72 -12
  235. package/sdk/platform/index.d.ts +1 -0
  236. package/sdk/platform/index.js +2 -0
  237. package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +2 -3
  238. package/sdk/public/Configuration/ConfigurationPublicClient.js +10 -8
  239. package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +9 -9
  240. package/sdk/public/Configuration/ConfigurationPublicModel.js +6 -6
  241. package/sdk/public/Content/ContentPublicClient.d.ts +2 -112
  242. package/sdk/public/Content/ContentPublicClient.js +19 -793
  243. package/sdk/public/Content/ContentPublicModel.d.ts +3 -549
  244. package/sdk/public/Content/ContentPublicModel.js +3 -649
  245. package/sdk/public/Content/ContentPublicValidator.d.ts +3 -69
  246. package/sdk/public/Content/ContentPublicValidator.js +2 -88
  247. package/sdk/public/Partner/PartnerPublicClient.d.ts +1 -1
  248. package/sdk/public/Partner/PartnerPublicClient.js +14 -2
  249. package/sdk/public/Webhook/WebhookPublicClient.d.ts +8 -8
  250. package/sdk/public/Webhook/WebhookPublicClient.js +13 -10
  251. package/sdk/public/Webhook/WebhookPublicModel.d.ts +21 -21
  252. package/sdk/public/Webhook/WebhookPublicModel.js +15 -15
  253. package/sdk/public/Webhook/WebhookPublicValidator.d.ts +4 -4
  254. package/sdk/public/Webhook/WebhookPublicValidator.js +4 -4
  255. package/sdk/application/Cart/CartApplicationModel.d.ts +0 -4340
  256. package/sdk/application/Cart/CartApplicationModel.js +0 -2718
  257. package/sdk/application/Cart/CartApplicationValidator.d.ts +0 -788
  258. package/sdk/application/Cart/CartApplicationValidator.js +0 -546
  259. package/sdk/application/Catalog/CatalogApplicationModel.d.ts +0 -3909
  260. package/sdk/application/Catalog/CatalogApplicationModel.js +0 -2667
  261. package/sdk/application/Catalog/CatalogApplicationValidator.d.ts +0 -791
  262. package/sdk/application/Catalog/CatalogApplicationValidator.js +0 -551
  263. package/sdk/application/Common/CommonApplicationModel.d.ts +0 -449
  264. package/sdk/application/Common/CommonApplicationModel.js +0 -308
  265. package/sdk/application/Common/CommonApplicationValidator.d.ts +0 -46
  266. package/sdk/application/Common/CommonApplicationValidator.js +0 -38
  267. package/sdk/application/Communication/CommunicationApplicationModel.d.ts +0 -293
  268. package/sdk/application/Communication/CommunicationApplicationModel.js +0 -201
  269. package/sdk/application/Communication/CommunicationApplicationValidator.d.ts +0 -29
  270. package/sdk/application/Communication/CommunicationApplicationValidator.js +0 -38
  271. package/sdk/application/Configuration/ConfigurationApplicationModel.d.ts +0 -2544
  272. package/sdk/application/Configuration/ConfigurationApplicationModel.js +0 -1875
  273. package/sdk/application/Configuration/ConfigurationApplicationValidator.d.ts +0 -179
  274. package/sdk/application/Configuration/ConfigurationApplicationValidator.js +0 -176
  275. package/sdk/application/Content/ContentApplicationModel.d.ts +0 -2189
  276. package/sdk/application/Content/ContentApplicationModel.js +0 -1640
  277. package/sdk/application/Content/ContentApplicationValidator.d.ts +0 -290
  278. package/sdk/application/Content/ContentApplicationValidator.js +0 -269
  279. package/sdk/application/FileStorage/FileStorageApplicationModel.d.ts +0 -270
  280. package/sdk/application/FileStorage/FileStorageApplicationModel.js +0 -188
  281. package/sdk/application/FileStorage/FileStorageApplicationValidator.d.ts +0 -56
  282. package/sdk/application/FileStorage/FileStorageApplicationValidator.js +0 -53
  283. package/sdk/application/Finance/FinanceApplicationClient.d.ts +0 -36
  284. package/sdk/application/Finance/FinanceApplicationClient.js +0 -202
  285. package/sdk/application/Finance/FinanceApplicationModel.d.ts +0 -289
  286. package/sdk/application/Finance/FinanceApplicationModel.js +0 -208
  287. package/sdk/application/Finance/FinanceApplicationValidator.d.ts +0 -25
  288. package/sdk/application/Finance/FinanceApplicationValidator.js +0 -31
  289. package/sdk/application/Lead/LeadApplicationModel.d.ts +0 -590
  290. package/sdk/application/Lead/LeadApplicationModel.js +0 -480
  291. package/sdk/application/Lead/LeadApplicationValidator.d.ts +0 -68
  292. package/sdk/application/Lead/LeadApplicationValidator.js +0 -71
  293. package/sdk/application/Logistic/LogisticApplicationModel.d.ts +0 -2034
  294. package/sdk/application/Logistic/LogisticApplicationModel.js +0 -1391
  295. package/sdk/application/Logistic/LogisticApplicationValidator.d.ts +0 -299
  296. package/sdk/application/Logistic/LogisticApplicationValidator.js +0 -224
  297. package/sdk/application/Order/OrderApplicationModel.d.ts +0 -2612
  298. package/sdk/application/Order/OrderApplicationModel.js +0 -1669
  299. package/sdk/application/Order/OrderApplicationValidator.d.ts +0 -279
  300. package/sdk/application/Order/OrderApplicationValidator.js +0 -210
  301. package/sdk/application/Payment/PaymentApplicationModel.d.ts +0 -4062
  302. package/sdk/application/Payment/PaymentApplicationModel.js +0 -2632
  303. package/sdk/application/Payment/PaymentApplicationValidator.d.ts +0 -576
  304. package/sdk/application/Payment/PaymentApplicationValidator.js +0 -594
  305. package/sdk/application/Rewards/RewardsApplicationModel.d.ts +0 -365
  306. package/sdk/application/Rewards/RewardsApplicationModel.js +0 -396
  307. package/sdk/application/Rewards/RewardsApplicationValidator.d.ts +0 -73
  308. package/sdk/application/Rewards/RewardsApplicationValidator.js +0 -84
  309. package/sdk/application/Share/ShareApplicationModel.d.ts +0 -339
  310. package/sdk/application/Share/ShareApplicationModel.js +0 -234
  311. package/sdk/application/Share/ShareApplicationValidator.d.ts +0 -90
  312. package/sdk/application/Share/ShareApplicationValidator.js +0 -91
  313. package/sdk/application/Theme/ThemeApplicationModel.d.ts +0 -1744
  314. package/sdk/application/Theme/ThemeApplicationModel.js +0 -1446
  315. package/sdk/application/Theme/ThemeApplicationValidator.d.ts +0 -79
  316. package/sdk/application/Theme/ThemeApplicationValidator.js +0 -65
  317. package/sdk/application/User/UserApplicationModel.d.ts +0 -1943
  318. package/sdk/application/User/UserApplicationModel.js +0 -1382
  319. package/sdk/application/User/UserApplicationValidator.d.ts +0 -560
  320. package/sdk/application/User/UserApplicationValidator.js +0 -573
  321. package/sdk/application/Webhook/WebhookApplicationModel.d.ts +0 -54
  322. package/sdk/application/Webhook/WebhookApplicationModel.js +0 -48
  323. package/sdk/application/Webhook/WebhookApplicationValidator.d.ts +0 -16
  324. package/sdk/application/Webhook/WebhookApplicationValidator.js +0 -19
  325. package/sdk/common/Clickstream.d.ts +0 -1
  326. package/sdk/common/Clickstream.js +0 -464
@@ -1,4062 +0,0 @@
1
- export = PaymentApplicationModel;
2
- /**
3
- * @typedef AggregatorConfigDetail
4
- * @property {boolean} [sdk] - SDK details.
5
- * @property {string} secret - Masked payment gateway api secret.
6
- * @property {string} [api] - Payment gateway api endpoint.
7
- * @property {string} [pin] - Masked pin.
8
- * @property {string} config_type - Fynd or self payment gateway.
9
- * @property {string} [merchant_key] - Unique merchant key.
10
- * @property {string} [verify_api] - Payment gateway verify payment api endpoint.
11
- * @property {string} key - Payment gateway api key.
12
- * @property {string} [user_id] - Registered User id.
13
- * @property {string} [merchant_id] - Unique merchant id.
14
- */
15
- /**
16
- * @typedef AggregatorsConfigDetail
17
- * @property {boolean} success - Api response was successful or not.
18
- * @property {AggregatorConfigDetail} [razorpay]
19
- * @property {AggregatorConfigDetail} [juspay]
20
- * @property {AggregatorConfigDetail} [simpl]
21
- * @property {AggregatorConfigDetail} [payumoney]
22
- * @property {AggregatorConfigDetail} [rupifi]
23
- * @property {AggregatorConfigDetail} [mswipe]
24
- * @property {AggregatorConfigDetail} [stripe]
25
- * @property {AggregatorConfigDetail} [ccavenue]
26
- * @property {string} env - Environment i.e Live or Test.
27
- */
28
- /**
29
- * @typedef ErrorCodeAndDescription
30
- * @property {string} code - Error description code.
31
- * @property {string} description - Error human understandable description.
32
- */
33
- /**
34
- * @typedef HttpErrorCodeDetails
35
- * @property {ErrorCodeAndDescription} [error]
36
- * @property {boolean} success - Response is successful or not.
37
- */
38
- /**
39
- * @typedef AttachCard
40
- * @property {string} [nickname] - Nickname of the card holder.
41
- * @property {boolean} [refresh] - Refresh cache flag.
42
- * @property {string} card_id - Card token of payment gateway.
43
- * @property {string} [name_on_card] - Name of the card holder.
44
- */
45
- /**
46
- * @typedef AttachCardsDetails
47
- * @property {Object} data - List of cards of customer.
48
- * @property {boolean} success - Response is successful or not.
49
- * @property {string} [message] - Human readable message.
50
- */
51
- /**
52
- * @typedef CardPaymentGateway
53
- * @property {string} [api] - Payment gateway CARD api endpoint.
54
- * @property {string} aggregator - Payment gateway name.
55
- * @property {string} [customer_id] - Payment gateway customer id.
56
- */
57
- /**
58
- * @typedef ActiveCardPaymentGatewayDetails
59
- * @property {CardPaymentGateway} cards
60
- * @property {boolean} success - Response is successful or not.
61
- * @property {string} message - Human readable message.
62
- */
63
- /**
64
- * @typedef Card
65
- * @property {string} [card_number] - Card number mentioned on the card.
66
- * @property {string} [card_name] - Name mentioned on the card.
67
- * @property {string} [card_type] - Type of the card.
68
- * @property {string} [card_brand_image] - Brand image on the card.
69
- * @property {string} [card_reference] - Card reference.
70
- * @property {string} [card_issuer] - Issuer of the card.
71
- * @property {string} [card_brand] - Brand of the card.
72
- * @property {boolean} [expired] - Card expiry.
73
- * @property {boolean} [compliant_with_tokenisation_guidelines] - Whether card
74
- * is tokenized or not.
75
- * @property {string} [card_isin] - International Securities Identification
76
- * Number for the card.
77
- * @property {number} [exp_year] - Card's expiration year.
78
- * @property {string} [nickname] - User-defined name for the card.
79
- * @property {string} aggregator_name - Name of the payment aggregator.
80
- * @property {string} [card_fingerprint] - Unique fingerprint of the card for
81
- * identification.
82
- * @property {string} [card_token] - Encrypted token representing the card.
83
- * @property {number} [exp_month] - Card's expiration month.
84
- * @property {string} [card_id] - Unique identifier for the card within the system.
85
- */
86
- /**
87
- * @typedef ListCardsDetails
88
- * @property {Card[]} [data] - List of cards of customer.
89
- * @property {boolean} success - Response is successful or not.
90
- * @property {string} message - Human readable message.
91
- */
92
- /**
93
- * @typedef DeleteCard
94
- * @property {string} card_id - Card token of payment gateway.
95
- */
96
- /**
97
- * @typedef DeleteCardsDetails
98
- * @property {boolean} success - Response is successful or not.
99
- * @property {string} [message] - Human readable message.
100
- */
101
- /**
102
- * @typedef ValidateCustomer
103
- * @property {string} aggregator - Payment gateway name in camelcase i.e Simple, Rupifi.
104
- * @property {number} transaction_amount_in_paise - Payable amount in paise.
105
- * @property {string} phone_number - User mobile number without country code.
106
- * @property {Object} [billing_address] - Extra meta fields.
107
- * @property {Object[]} [order_items] - Extra meta fields.
108
- * @property {string} [payload] - Hashed payload string.
109
- * @property {Object} [merchant_params] - Extra meta fields.
110
- * @property {Object} [delivery_address] - Extra meta fields.
111
- */
112
- /**
113
- * @typedef ValidateCustomerDetails
114
- * @property {Object} [data] - Payment gateway response data.
115
- * @property {boolean} success - Response is successful or not.
116
- * @property {string} message - Error or success message.
117
- */
118
- /**
119
- * @typedef ChargeCustomer
120
- * @property {boolean} [verified] - Already Verified flag from payment gateway i.e Mswipe.
121
- * @property {string} aggregator - Payment gateway name i.e Simpl, Mswipe.
122
- * @property {string} order_id - Unique order id.
123
- * @property {string} [transaction_token] - Transaction token of payment gateway.
124
- * @property {number} amount - Chargeable amount of order.
125
- */
126
- /**
127
- * @typedef ChargeCustomerDetails
128
- * @property {string} status - Status of charged payment.
129
- * @property {string} [cart_id] - Cart id of customer.
130
- * @property {boolean} success - Response is successful or not.
131
- * @property {string} aggregator - Payment gateway name i.e Simpl, Mswipe.
132
- * @property {string} message - Human readable message.
133
- * @property {string} order_id - Unique order id.
134
- * @property {string} [delivery_address_id] - Delivery address id of customer.
135
- */
136
- /**
137
- * @typedef PaymentInitialization
138
- * @property {string} [razorpay_payment_id] - Payment gateway payment id.
139
- * @property {string} method - Payment method.
140
- * @property {string} [device_id] - EDC machine Unique Identifier.
141
- * @property {string} aggregator - Payment gateway name.
142
- * @property {string} customer_id - Payment gateway customer id.
143
- * @property {string} contact - Customer valid mobile number.
144
- * @property {string} merchant_order_id - Unique fynd order id.
145
- * @property {string} [vpa] - Customer vpa address.
146
- * @property {string} order_id - Payment gateway order id.
147
- * @property {string} currency - Currency code.
148
- * @property {number} [timeout] - Payment polling timeout if not received response.
149
- * @property {number} amount - Payable amount.
150
- * @property {string} email - Customer valid email.
151
- */
152
- /**
153
- * @typedef PaymentInitializationDetails
154
- * @property {string} [status] - Status of payment.
155
- * @property {string} [razorpay_payment_id] - Payment id.
156
- * @property {string} [aggregator_order_id] - Payment order id.
157
- * @property {string} method - Payment method.
158
- * @property {boolean} success - Response is successful or not.
159
- * @property {string} [upi_poll_url] - UPI poll url.
160
- * @property {string} [virtual_id] - Payment virtual address.
161
- * @property {string} [device_id] - EDC machine Unique Identifier.
162
- * @property {string} polling_url - Polling url.
163
- * @property {string} aggregator - Payment gateway name.
164
- * @property {string} merchant_order_id - Order id.
165
- * @property {string} [customer_id] - Payment gateway customer id.
166
- * @property {string} [vpa] - Customer vpa address.
167
- * @property {string} [currency] - Currency code.
168
- * @property {number} [timeout] - Timeout.
169
- * @property {number} [amount] - Payable amount.
170
- * @property {string} [bqr_image] - Bharat qr image url.
171
- */
172
- /**
173
- * @typedef PaymentStatusUpdate
174
- * @property {string} status - Status of payment.
175
- * @property {string} [merchant_transaction_id] - Unique fynd transaction id.
176
- * @property {string} method - Payment method.
177
- * @property {string} [device_id] - EDC machine Unique Identifier.
178
- * @property {string} aggregator - Payment gateway name.
179
- * @property {string} [customer_id] - Payment gateway customer id.
180
- * @property {string} [contact] - Customer valid mobile number.
181
- * @property {string} merchant_order_id - Unique fynd order id.
182
- * @property {string} [vpa] - Customer vpa address.
183
- * @property {string} order_id - Payment gateway order id.
184
- * @property {string} [currency] - Currency code.
185
- * @property {number} [amount] - Payable amount.
186
- * @property {string} [email] - Customer valid email.
187
- */
188
- /**
189
- * @typedef PaymentStatusUpdateDetails
190
- * @property {string} status - Payment status.
191
- * @property {boolean} [success] - Response is successful or not.
192
- * @property {boolean} retry - Response is successful or not.
193
- * @property {string} [redirect_url] - Redirect url.
194
- * @property {string} aggregator_name - Payment gateway name.
195
- */
196
- /**
197
- * @typedef IntentAppErrorList
198
- * @property {string} [code] - Code of the intent App.
199
- * @property {string} [package_name] - Package Name of the intent App.
200
- */
201
- /**
202
- * @typedef PaymentModeLogo
203
- * @property {string} large - Large Logo.
204
- * @property {string} small - Small Logo.
205
- */
206
- /**
207
- * @typedef IntentApp
208
- * @property {string} [code] - Code of the intent App.
209
- * @property {string} [package_name] - Package Name of the intent App.
210
- * @property {PaymentModeLogo} [logos]
211
- * @property {string} [display_name] - Display Name of the intent App.
212
- */
213
- /**
214
- * @typedef PaymentModeList
215
- * @property {string} [card_number] - Card number mentioned on the card.
216
- * @property {string} [merchant_code] - Unique code identifying the merchant.
217
- * @property {string} [card_reference] - Reference identifier for the card.
218
- * @property {string} [card_issuer] - Issuing bank or institution of the card.
219
- * @property {boolean} [compliant_with_tokenisation_guidelines] - Indicates
220
- * compliance with tokenization guidelines.
221
- * @property {string} [code] - General code for identifying a transaction or status.
222
- * @property {number} [cod_limit] - Limit for Cash on Delivery (COD) transactions.
223
- * @property {boolean} [intent_flow] - Flow or process intended for the transaction.
224
- * @property {string} [fynd_vpa] - Virtual Payment Address (VPA) used by Fynd.
225
- * @property {IntentAppErrorList[]} [intent_app_error_dict_list] - List of error
226
- * dictionaries related to intent app.
227
- * @property {string} aggregator_name - Name of the payment aggregator.
228
- * @property {string} [card_fingerprint] - Unique fingerprint of the card for
229
- * identification.
230
- * @property {string[]} [intent_app_error_list] - List of errors associated with
231
- * the intent app.
232
- * @property {IntentApp[]} [intent_app] - Application intended for handling the
233
- * transaction.
234
- * @property {boolean} [expired] - Indicates whether the card is expired.
235
- * @property {number} [retry_count] - Number of retry attempts.
236
- * @property {number} [exp_year] - Card's expiration year.
237
- * @property {number} [exp_month] - Card's expiration month.
238
- * @property {string} [card_id] - Unique identifier for the card within the system.
239
- * @property {number} [remaining_limit] - Remaining available limit on the card.
240
- * @property {number} [display_priority] - Priority of display in the user interface.
241
- * @property {string} [card_brand] - Brand of the card (e.g., Visa, MasterCard).
242
- * @property {number} [cod_limit_per_order] - Maximum limit per order for COD
243
- * transactions.
244
- * @property {PaymentModeLogo} [logo_url]
245
- * @property {string} [nickname] - User-defined name for the card.
246
- * @property {string} [card_name] - Name printed on the card.
247
- * @property {string} [card_type] - Type of the card (e.g., debit, credit).
248
- * @property {string} [card_brand_image] - Image representing the card brand.
249
- * @property {string} [display_name] - Display name for the card in the user interface.
250
- * @property {string} [card_isin] - International Securities Identification
251
- * Number for the card.
252
- * @property {number} [timeout] - Timeout duration for transactions.
253
- * @property {string} [card_token] - Encrypted token representing the card.
254
- * @property {string} [name] - User's name.
255
- * @property {Object} [meta] - Payment methods meta.
256
- */
257
- /**
258
- * @typedef RootPaymentMode
259
- * @property {boolean} [is_pay_by_card_pl] - This flag will be true in case of
260
- * Payment link payment through card.
261
- * @property {boolean} [add_card_enabled] - Anonymous card flag.
262
- * @property {number} display_priority - Display Priority.
263
- * @property {string} display_name - Payment mode display name.
264
- * @property {PaymentModeList[]} [list] - Payment mode.
265
- * @property {boolean} [save_card] - Card save or not.
266
- * @property {string} [aggregator_name] - Display Priority.
267
- * @property {string} name - Payment mode name.
268
- * @property {boolean} [anonymous_enable] - Anonymous card flag.
269
- */
270
- /**
271
- * @typedef AggregatorRoute
272
- * @property {Object} [data] - Details about aggregator route.
273
- * @property {Object} [payment_flow_data] - Payment_flow_data.
274
- * @property {string} [payment_flow] - Payment_flow.
275
- * @property {string} [api_link] - API link of the aggregator.
276
- */
277
- /**
278
- * @typedef PaymentDefaultSelection
279
- * @property {string} [mode] - Default Selection Payment Mode.
280
- * @property {string} [identifier] - Identifier for Payment Mode.
281
- * @property {boolean} [skip] - Decide if the default payment mode will skip the
282
- * payment options page altogether or just be preferred on the Frontend.
283
- */
284
- /**
285
- * @typedef PaymentFlow
286
- * @property {AggregatorRoute} [bqr_razorpay]
287
- * @property {AggregatorRoute} [fynd]
288
- * @property {AggregatorRoute} [epaylater]
289
- * @property {AggregatorRoute} [razorpay]
290
- * @property {AggregatorRoute} [juspay]
291
- * @property {AggregatorRoute} [ajiodhan]
292
- * @property {AggregatorRoute} [simpl]
293
- * @property {AggregatorRoute} [rupifi]
294
- * @property {AggregatorRoute} [mswipe]
295
- * @property {AggregatorRoute} [stripe]
296
- * @property {AggregatorRoute} [ccavenue]
297
- * @property {AggregatorRoute} [payubiz]
298
- * @property {AggregatorRoute} [jiopay]
299
- * @property {AggregatorRoute} [upi_razorpay]
300
- */
301
- /**
302
- * @typedef PaymentOptionAndFlow
303
- * @property {RootPaymentMode[]} payment_option - Payment options.
304
- * @property {PaymentFlow} payment_flows
305
- * @property {PaymentDefaultSelection} [payment_default_selection]
306
- */
307
- /**
308
- * @typedef AdvanceObject
309
- * @property {boolean} [is_active] - Is Advance Payment active.
310
- * @property {number} [amount] - Amount for Payment Breakdown.
311
- * @property {string} [time_unit] - Time unit for refunds.
312
- * @property {string} [description] - The description for Advance Payment (user
313
- * configured).
314
- * @property {string} [display_name] - The display name for Advance payment.
315
- * @property {string} [prepayment_type] - Type of prepayment value.
316
- * @property {number} [prepayment_value] - Value for prepayment in advance payment.
317
- * @property {string} [cancellation_type] - Type of cancellation.
318
- * @property {number} [refund_time_limit] - Time limit for processing refund.
319
- * @property {string[]} [all_prepayment_type] - All available types of prepayment.
320
- * @property {boolean} [allow_custom_advance_amount] - Is custom advance amount allowed?.
321
- */
322
- /**
323
- * @typedef SplitObject
324
- * @property {number} [total_number_of_splits] - Maximum amount of splits allowed.
325
- * @property {number} [splits_remaining] - Number of splits remaining.
326
- * @property {number} [amount_remaining] - Amount pending to be paid.
327
- */
328
- /**
329
- * @typedef AdvancePaymentObject
330
- * @property {string} [name] - Name of Advance Payment Mode.
331
- * @property {number} [display_priority] - Display Priority for Payment Option.
332
- * @property {number} [payment_mode_id] - Payment Mode ID for Advance Payment Option.
333
- * @property {string} [display_name] - Display name for Advance Payment Mode.
334
- * @property {PaymentModeList[]} [list] - Payment mode.
335
- * @property {SplitObject} [split]
336
- * @property {AdvanceObject} [advance]
337
- */
338
- /**
339
- * @typedef PaymentModeRouteDetails
340
- * @property {PaymentOptionAndFlow} payment_options
341
- * @property {boolean} success - Response is successful or not.
342
- * @property {Object} [payment_breakup] - Payment Breakup for advance payment.
343
- * @property {AdvancePaymentObject[]} [advance_payment] - Advance Payment Array.
344
- */
345
- /**
346
- * @typedef WalletLinkRequestSchema
347
- * @property {string} aggregator - Aggregator Name.
348
- * @property {string} mobile - Mobile Number for Wallet.
349
- * @property {string} wallet_code - Wallet Code.
350
- */
351
- /**
352
- * @typedef WalletVerifyRequestSchema
353
- * @property {string} aggregator - Aggregator Name.
354
- * @property {string} link_token - Token for wallet linking.
355
- * @property {number} otp - OTP received for wallet linking.
356
- */
357
- /**
358
- * @typedef WalletDelinkRequestSchema
359
- * @property {string} aggregator - Aggregator Name.
360
- * @property {string} wallet_code - Wallet Code.
361
- */
362
- /**
363
- * @typedef WalletResponseSchema
364
- * @property {Object} data - Response received from aggregator.
365
- * @property {boolean} success - Success/Failure of the API call.
366
- */
367
- /**
368
- * @typedef RupifiBannerData
369
- * @property {string} [status] - Rupifi KYC status.
370
- * @property {string} [kyc_url] - Rupifi KYC banner url.
371
- */
372
- /**
373
- * @typedef RupifiBannerDetails
374
- * @property {RupifiBannerData} data
375
- * @property {boolean} success - Successful or not.
376
- */
377
- /**
378
- * @typedef EpaylaterBannerData
379
- * @property {string} [status] - Epaylater KYC status.
380
- * @property {string} [message] - EPayLater message.
381
- * @property {boolean} display - Need to display banner or not.
382
- */
383
- /**
384
- * @typedef EpaylaterBannerDetails
385
- * @property {EpaylaterBannerData} data
386
- * @property {boolean} success - Successful or not.
387
- */
388
- /**
389
- * @typedef ResendOrCancelPayment
390
- * @property {string} order_id - Unique order id.
391
- * @property {string} [device_id] - EDC machine Unique Identifier.
392
- * @property {string} request_type - Either resend or cancel.
393
- */
394
- /**
395
- * @typedef LinkStatus
396
- * @property {string} status - Link action status.
397
- * @property {string} message - Message.
398
- * @property {boolean} [is_payment_done] - This key specifies payment done
399
- * status of payment link.
400
- */
401
- /**
402
- * @typedef ResendOrCancelPaymentDetails
403
- * @property {LinkStatus} data
404
- * @property {boolean} success - Response is successful or not.
405
- */
406
- /**
407
- * @typedef RenderHTML
408
- * @property {string} [returntype] - Return Type of API.
409
- * @property {string} base64_html - Base64 encoded html string.
410
- */
411
- /**
412
- * @typedef RenderHTMLDetails
413
- * @property {string} html - HTML string.
414
- */
415
- /**
416
- * @typedef ValidateVPA
417
- * @property {string} upi_vpa - UPI ID.
418
- * @property {string} [aggregator] - Aggregator slug.
419
- */
420
- /**
421
- * @typedef ValidateUPI
422
- * @property {string} status - VALID or INVALID.
423
- * @property {string} customer_name - Customer Bank.
424
- * @property {boolean} is_valid - Boolean is true or false.
425
- * @property {string} upi_vpa - UPI ID.
426
- */
427
- /**
428
- * @typedef ValidateVPADetails
429
- * @property {ValidateUPI} data
430
- * @property {boolean} success - Response is successful or not.
431
- */
432
- /**
433
- * @typedef CardDetails
434
- * @property {boolean} status - Current status of the card.
435
- * @property {string} country - Country where the card was issued.
436
- * @property {string} bank_code - Code identifying the bank.
437
- * @property {string} id - Unique identifier for the record.
438
- * @property {string} [card_exp_year] - Card's expiration year.
439
- * @property {string} card_brand - Brand of the card (e.g., Visa, MasterCard).
440
- * @property {string} type - General type of the card (e.g., debit, credit).
441
- * @property {string} card_sub_type - Sub-type of the card (e.g., Platinum, Gold).
442
- * @property {boolean} is_domestic_card - Indicates whether the card is domestic.
443
- * @property {string} [name_on_card] - Name of the cardholder.
444
- * @property {string} [card_exp_month] - Card's expiration month.
445
- * @property {string} extended_card_type - Extended type of the card, providing
446
- * more specific classification.
447
- * @property {string} card_object - Object representation of the card.
448
- * @property {string} [card_token] - Encrypted token representing the card.
449
- * @property {string} [user] - User associated with the card.
450
- * @property {string} bank - Bank associated with the card.
451
- */
452
- /**
453
- * @typedef CardDetailsFetchedDetails
454
- * @property {CardDetails} data
455
- * @property {boolean} success - Response is successful or not.
456
- */
457
- /**
458
- * @typedef TransferItemsDetails
459
- * @property {number} id - Id of the transfer item.
460
- * @property {string} [display_name] - Beneficiary Display Name.
461
- * @property {string} logo_large - Beneficiary large Logo.
462
- * @property {string} logo_small - Beneficiary small Logo.
463
- * @property {string} name - Beneficiary Name.
464
- */
465
- /**
466
- * @typedef TransferModeDetails
467
- * @property {TransferItemsDetails[]} [items] - Beneficiary Mode Items.
468
- * @property {string} display_name - Beneficiary Mode Name.
469
- */
470
- /**
471
- * @typedef TransferModeFetchDetails
472
- * @property {TransferModeDetails[]} data - Response Object.
473
- */
474
- /**
475
- * @typedef UpdateRefundTransferMode
476
- * @property {boolean} enable - True for enabling the Transfer Mode.
477
- * @property {string} transfer_mode - Transfer Mode of the Beneficiary to be added.
478
- */
479
- /**
480
- * @typedef RefundTransferModeUpdateDetails
481
- * @property {boolean} [success] - Response is successful or not.
482
- */
483
- /**
484
- * @typedef OrderBeneficiaryDetails
485
- * @property {string} modified_on - Modification Date of Beneficiary.
486
- * @property {string} account_no - Account Number.
487
- * @property {string} [mobile] - MObile no of User.
488
- * @property {string} bank_name - Bank Name Of Account.
489
- * @property {string} ifsc_code - Ifsc Code Of Account.
490
- * @property {boolean} is_active - Boolean Flag whether Beneficiary set or not.
491
- * @property {string} beneficiary_id - Beneficiary Id.
492
- * @property {string} account_holder - Account Holder Name.
493
- * @property {string} email - EMail of User.
494
- * @property {string} [delights_user_name] - User Id Who filled the Beneficiary.
495
- * @property {number} id - Id of the Order Beneficiary.
496
- * @property {string} transfer_mode - Transfer Mode Of Account.
497
- * @property {string} [branch_name] - Branch Name Of Account.
498
- * @property {string} created_on - Creation Date of Beneficiary.
499
- * @property {string} subtitle - SHort Title Of Account.
500
- * @property {string} [comment] - Remarks.
501
- * @property {string} address - Address of User.
502
- * @property {string} title - Title Of Account.
503
- * @property {string} display_name - Display Name Of Account.
504
- */
505
- /**
506
- * @typedef OrderBeneficiaryFetchDetails
507
- * @property {boolean} [show_beneficiary_details] - Show beneficiary details or not.
508
- * @property {OrderBeneficiaryDetails[]} [beneficiaries] - All Beneficiaries Of An Order.
509
- */
510
- /**
511
- * @typedef NotFoundResourceError
512
- * @property {string} code - Bad Request Data.
513
- * @property {string} description - Not Found.
514
- * @property {boolean} success - Response is successful or not.
515
- */
516
- /**
517
- * @typedef IfscCodeDetails
518
- * @property {string} branch_name - Branch Name Of Account.
519
- * @property {boolean} [success] - Response is successful or not.
520
- * @property {string} bank_name - Bank Name Of Account.
521
- */
522
- /**
523
- * @typedef ErrorCodeDescription
524
- * @property {string} code - Error description code.
525
- * @property {string} description - Error human understandable description.
526
- * @property {boolean} success - Response is successful or not.
527
- */
528
- /**
529
- * @typedef AddBeneficiaryViaOtpVerification
530
- * @property {string} request_id - Request id.
531
- * @property {string} hash_key - Hash key of the beneficiary Id.
532
- * @property {string} otp - Otp sent to the given Mobile No.
533
- */
534
- /**
535
- * @typedef AddBeneficiaryViaOtpVerificationDetails
536
- * @property {boolean} [success] - Response is successful or not.
537
- * @property {string} message - Aggregator Response of beneficiary.
538
- */
539
- /**
540
- * @typedef WrongOtpError
541
- * @property {boolean} is_verified_flag - Verified flag.
542
- * @property {string} description - Wrong OTP Code.
543
- * @property {string} success - Response is successful or not.
544
- */
545
- /**
546
- * @typedef BeneficiaryModeDetails
547
- * @property {string} account_no - Account Number of the Account Holder.
548
- * @property {string} [address] - Address of the User.
549
- * @property {string} mobile - Mobile Number of the User.
550
- * @property {string} bank_name - Bank Name of the Account.
551
- * @property {string} [comment] - Remarks added by The user.
552
- * @property {string} ifsc_code - Ifsc Code of the Account.
553
- * @property {string} [vpa] - VPA of the Account.
554
- * @property {string} branch_name - Branch Name of the Account.
555
- * @property {string} account_holder - Name of the Account Holder.
556
- * @property {string} [wallet] - Wallet of the Account.
557
- * @property {string} email - Email of the Account Holder.
558
- */
559
- /**
560
- * @typedef AddBeneficiaryDetails
561
- * @property {boolean} delights - True if beneficiary to be added by delights or
562
- * False if by User.
563
- * @property {string} shipment_id - Shipment Id of the respective Merchant Order Id.
564
- * @property {BeneficiaryModeDetails} details
565
- * @property {string} [otp] - OTP received by customer.
566
- * @property {string} order_id - Merchant Order Id.
567
- * @property {string} transfer_mode - Transfer Mode of the Beneficiary to be added.
568
- * @property {string} [request_id] - Request Id for add benificiary request.
569
- */
570
- /**
571
- * @typedef RefundAccountDetails
572
- * @property {boolean} [is_verified_flag] - Flag for verification of refund.
573
- * @property {Object} [data] - Refund account data.
574
- * @property {boolean} success - Success or failure flag.
575
- * @property {string} message - Response message.
576
- */
577
- /**
578
- * @typedef BankDetailsForOTP
579
- * @property {string} account_no - Account number of the holder.
580
- * @property {string} bank_name - Name of the bank.
581
- * @property {string} ifsc_code - IFSC code of the bank.
582
- * @property {string} branch_name - Branch name of the bank.
583
- * @property {string} account_holder - Name of the account holder.
584
- */
585
- /**
586
- * @typedef AddBeneficiaryDetailsOTP
587
- * @property {string} order_id - Unique identifier for an order.
588
- * @property {BankDetailsForOTP} details
589
- */
590
- /**
591
- * @typedef WalletOtp
592
- * @property {string} country_code - Country Code of the Mobile Number.
593
- * @property {string} mobile - Wallet Mobile Number of the User.
594
- */
595
- /**
596
- * @typedef WalletOtpDetails
597
- * @property {string} request_id - Request Id for wallet otp request.
598
- * @property {string} is_verified_flag - Boolean Flag whether OTP Validation is
599
- * already done or not.
600
- * @property {boolean} [success] - Response is successful or not.
601
- */
602
- /**
603
- * @typedef SetDefaultBeneficiary
604
- * @property {string} order_id - Merchant Order Id.
605
- * @property {string} beneficiary_id - Beneficiary Hash Id of the beneficiary added.
606
- */
607
- /**
608
- * @typedef SetDefaultBeneficiaryDetails
609
- * @property {boolean} is_beneficiary_set - Boolean Flag whether Beneficiary set or not.
610
- * @property {boolean} [success] - Response is successful or not.
611
- */
612
- /**
613
- * @typedef GetPaymentLinkDetails
614
- * @property {number} status_code - HTTP status code.
615
- * @property {string} [payment_link_current_status] - Status of payment link.
616
- * @property {boolean} success - Successful or failure.
617
- * @property {number} [polling_timeout] - Polling request timeout.
618
- * @property {string} [payment_link_url] - Url of payment link.
619
- * @property {string} [external_order_id] - Merchant order id.
620
- * @property {string} message - Detailed message.
621
- * @property {string} [merchant_name] - Merchant name.
622
- * @property {number} [amount] - Total value of order.
623
- */
624
- /**
625
- * @typedef ErrorDescription
626
- * @property {string} [payment_transaction_id] - Payment transaction id.
627
- * @property {boolean} [expired] - Payment link expired or not.
628
- * @property {string} [merchant_order_id] - Merchant Order Id.
629
- * @property {string} [merchant_name] - Name of merchant that created payment link.
630
- * @property {string} [msg] - Detailed message.
631
- * @property {boolean} [cancelled] - Payment link is cancelled or not.
632
- * @property {number} [amount] - Amount paid.
633
- * @property {boolean} [invalid_id] - Payment link id is valid or not.
634
- */
635
- /**
636
- * @typedef ErrorDetails
637
- * @property {number} status_code - HTTP status code.
638
- * @property {ErrorDescription} [error]
639
- * @property {string} message - Detailed message.
640
- * @property {boolean} success - Successful or failure.
641
- */
642
- /**
643
- * @typedef CreatePaymentLinkMeta
644
- * @property {string} cart_id - Unique identifier for the shopping cart.
645
- * @property {string} checkout_mode - Mode of checkout process (e.g., guest,
646
- * registered user).
647
- * @property {string} [assign_card_id] - Identifier for the card assigned to the
648
- * transaction.
649
- * @property {string} amount - Total amount for the transaction.
650
- */
651
- /**
652
- * @typedef CreatePaymentLink
653
- * @property {string} [description] - Merchant order id.
654
- * @property {string} external_order_id - Merchant order id.
655
- * @property {string} mobile_number - Mobile number to which the payment link is
656
- * to be sent.
657
- * @property {number} amount - Total value of order.
658
- * @property {CreatePaymentLinkMeta} meta
659
- * @property {string} email - Email to which the payment link is to be sent.
660
- * @property {string} [success_redirection_url] - URL to which the user will be
661
- * redirected after a successful payment.
662
- * @property {string} [failure_redirection_url] - URL to which the user will be
663
- * redirected if the payment fails.
664
- */
665
- /**
666
- * @typedef CreatePaymentLinkDetails
667
- * @property {number} status_code - HTTP status code.
668
- * @property {boolean} success - Successful or failure.
669
- * @property {number} [polling_timeout] - Polling request timeout.
670
- * @property {string} [payment_link_url] - Url of payment link.
671
- * @property {string} message - Detailed message.
672
- * @property {string} [payment_link_id] - Unique id of payment link.
673
- */
674
- /**
675
- * @typedef CancelOrResendPaymentLink
676
- * @property {string} payment_link_id - Unique id of payment link.
677
- */
678
- /**
679
- * @typedef ResendPaymentLinkDetails
680
- * @property {number} status_code - HTTP status code.
681
- * @property {number} [polling_timeout] - Polling request timeout.
682
- * @property {boolean} success - Successful or failure.
683
- * @property {string} message - Detailed message.
684
- */
685
- /**
686
- * @typedef CancelPaymentLinkDetails
687
- * @property {number} status_code - HTTP status code.
688
- * @property {boolean} success - Successful or failure.
689
- * @property {string} message - Detailed message.
690
- */
691
- /**
692
- * @typedef PollingPaymentLinkDetails
693
- * @property {string} [status] - Status of payment link.
694
- * @property {number} [status_code] - HTTP status code.
695
- * @property {boolean} [success] - Successful or failure.
696
- * @property {number} [http_status] - HTTP status code.
697
- * @property {string} [message] - Detailed message.
698
- * @property {string} [order_id] - Fynd order id.
699
- * @property {string} [redirect_url] - Url to redirect to.
700
- * @property {string} [payment_link_id] - Payment link id.
701
- * @property {string} [aggregator_name] - Aggregator name.
702
- * @property {number} [amount] - Total amount for the transaction.
703
- */
704
- /**
705
- * @typedef PaymentMethodsMeta
706
- * @property {string} merchant_code - Merchant code.
707
- * @property {string} payment_gateway - Payment gateway name.
708
- * @property {string} payment_identifier - Payment identifier.
709
- */
710
- /**
711
- * @typedef CreateOrderUserPaymentMethods
712
- * @property {string} name - Payment mode name.
713
- * @property {string} mode - Payment mode.
714
- * @property {PaymentMethodsMeta} meta
715
- */
716
- /**
717
- * @typedef CreateOrderUser
718
- * @property {string} currency - Currency of the transaction.
719
- * @property {string} payment_link_id - Unique id of payment link.
720
- * @property {CreateOrderUserPaymentMethods} payment_methods
721
- * @property {Object} [meta] - Meta details.
722
- */
723
- /**
724
- * @typedef CreateOrderUserData
725
- * @property {string} [method] - Method details.
726
- * @property {string} [aggregator] - Aggregator name.
727
- * @property {string} [customer_id] - Aggregator customer id.
728
- * @property {string} [contact] - Mobile number.
729
- * @property {string} [merchant_order_id] - Merchant order id.
730
- * @property {string} [order_id] - Aggregator order id.
731
- * @property {string} [currency] - Currency of the transaction.
732
- * @property {string} [callback_url] - Callback url for aggregator.
733
- * @property {number} [amount] - Total amount for the transaction.
734
- * @property {string} [email] - Email.
735
- */
736
- /**
737
- * @typedef CreateOrderUserDetails
738
- * @property {number} status_code - HTTP status code.
739
- * @property {boolean} success - Successful or failure.
740
- * @property {CreateOrderUserData} [data]
741
- * @property {string} message - Detailed message.
742
- * @property {string} [order_id] - Merchant order id.
743
- * @property {string} [callback_url] - Callback url for aggregator.
744
- * @property {string} [payment_confirm_url] - Payment confirm url for aggregator.
745
- */
746
- /**
747
- * @typedef BalanceDetails
748
- * @property {string} [formatted_value] - Formatted Amount with currency symbol.
749
- * @property {string} [currency] - Currency Code.
750
- * @property {number} [value] - Payment amount.
751
- */
752
- /**
753
- * @typedef CreditSummary
754
- * @property {BalanceDetails} [total_due_amount]
755
- * @property {string} [status] - Customer Credit status.
756
- * @property {BalanceDetails} [limit]
757
- * @property {string} [credit_line_id] - ID at Credit aggregator end.
758
- * @property {BalanceDetails} [amount_available]
759
- * @property {BalanceDetails} [due_amount]
760
- * @property {string} [due_date] - Due date for repayment.
761
- * @property {BalanceDetails} [balance]
762
- * @property {string} [status_message] - Message to customer.
763
- * @property {string} [repayment_url] - Url for repayment.
764
- * @property {string} [soa_url] - Statement of accounts. Show payment history.
765
- * @property {boolean} [is_eligible_for_txn] - Eligibility flag to complete transaction.
766
- * @property {string} [merchant_customer_ref_id] - Unique aggregator customer id.
767
- * @property {string} [buyer_status] - Status from Credit aggregator end.
768
- * @property {string} [activation_url] - Url for activation.
769
- */
770
- /**
771
- * @typedef CustomerCreditSummaryDetails
772
- * @property {CreditSummary} [data]
773
- * @property {boolean} success - Payment confirmation updated or not.
774
- */
775
- /**
776
- * @typedef RedirectURL
777
- * @property {boolean} status - Aggregator Operation is successful or not.
778
- * @property {string} signup_url - URL to which the user may redirect.
779
- */
780
- /**
781
- * @typedef RedirectToAggregatorDetails
782
- * @property {RedirectURL} data
783
- * @property {boolean} success - Status updated or not.
784
- */
785
- /**
786
- * @typedef CreditDetail
787
- * @property {boolean} status - Operation is successful or not.
788
- * @property {boolean} is_registered - User is registered with aggregator or not.
789
- * @property {string} signup_url - URL to which the user may redirect.
790
- */
791
- /**
792
- * @typedef CheckCreditDetails
793
- * @property {CreditDetail} data
794
- * @property {boolean} success - Operation is successful or not.
795
- */
796
- /**
797
- * @typedef KYCAddress
798
- * @property {string} city - City of the KYC address.
799
- * @property {string} [addressline2] - Second line of the address.
800
- * @property {string} state - State of the KYC address.
801
- * @property {string} [ownership_type] - Type of ownership for the address
802
- * (e.g., rented, owned).
803
- * @property {string} pincode - Postal code of the address.
804
- * @property {string} [land_mark] - Landmark near the address.
805
- * @property {string} addressline1 - First line of the address.
806
- */
807
- /**
808
- * @typedef UserPersonalInfoInDetails
809
- * @property {string} first_name - First name of the individual.
810
- * @property {string} [voter_id] - Voter ID number.
811
- * @property {string} [gender] - Gender of the individual.
812
- * @property {string} dob - Date of birth of the individual.
813
- * @property {string} [passport] - Passport number.
814
- * @property {string} [fathers_name] - Father's name.
815
- * @property {string} [mothers_name] - Mother's name.
816
- * @property {string} [middle_name] - Middle name of the individual.
817
- * @property {string} [last_name] - Last name of the individual.
818
- * @property {string} [pan] - Permanent Account Number (PAN).
819
- * @property {string} [driving_license] - Driving license number.
820
- * @property {boolean} email_verified - Indicates whether the email is verified.
821
- * @property {KYCAddress} address_as_per_id
822
- * @property {boolean} mobile_verified - Indicates whether the mobile number is verified.
823
- * @property {string} phone - Phone number.
824
- * @property {string} [email] - Email address.
825
- */
826
- /**
827
- * @typedef MarketplaceInfo
828
- * @property {string} [date_of_joining] - Date of joining.
829
- * @property {string} name - Name of store.
830
- * @property {string} membership_id - Merchant id.
831
- */
832
- /**
833
- * @typedef BusinessDetails
834
- * @property {string} [business_ownership_type] - Type of business ownership
835
- * (e.g., sole proprietorship, partnership).
836
- * @property {string} [vintage] - Age or duration of the business.
837
- * @property {string} [gstin] - Goods and Services Tax Identification Number.
838
- * @property {string} [pan] - Permanent Account Number of the business.
839
- * @property {string} [entity_type] - Type of legal entity (e.g., corporation, LLC).
840
- * @property {Object} [shop_and_establishment] - Shop and Establishment
841
- * registration details.
842
- * @property {string} [fssai] - Food Safety and Standards Authority of India
843
- * registration number.
844
- * @property {string} [fda] - Food and Drug Administration registration number.
845
- * @property {string} [business_type] - Type of business (e.g., retail, wholesale).
846
- * @property {string} [name] - Name of the business.
847
- * @property {KYCAddress} [address]
848
- */
849
- /**
850
- * @typedef DeviceDetails
851
- * @property {string} [identification_number] - IP.
852
- * @property {string} [identifier_type] - Static value = ip.
853
- * @property {string} [device_model] - Device Model.
854
- * @property {string} [device_make] - Device maker.
855
- * @property {string} [device_type] - Device Type(E.g. Mobile).
856
- * @property {string} [os] - OS Name.
857
- * @property {string} [os_version] - OS Version.
858
- */
859
- /**
860
- * @typedef CustomerOnboarding
861
- * @property {UserPersonalInfoInDetails} [personal_info]
862
- * @property {string} [mcc] - Merchant Category Code, indicating the type of business.
863
- * @property {string} aggregator - Payment aggregator handling the transaction.
864
- * @property {MarketplaceInfo} [marketplace_info]
865
- * @property {string} source - Callback url.
866
- * @property {BusinessDetails} [business_info]
867
- * @property {DeviceDetails} [device]
868
- */
869
- /**
870
- * @typedef OnboardSummary
871
- * @property {string} [redirect_url] - URL to which the user may redirect.
872
- * @property {Object} [session] - User Session.
873
- * @property {boolean} status - Transaction status.
874
- * @property {string} [status_remark] - Description of status.
875
- * @property {boolean} [is_eligible_for_txn] - Whether is eligible for transaction.
876
- * @property {string} [merchant_customer_ref_id] - Rupifi customer ID.
877
- * @property {string} [activation_url] - Url for activation.
878
- */
879
- /**
880
- * @typedef CustomerOnboardingDetails
881
- * @property {OnboardSummary} data
882
- * @property {boolean} success - Status updated or not.
883
- */
884
- /**
885
- * @typedef OutstandingOrderDetails
886
- * @property {number} status_code - HTTP status code.
887
- * @property {Object[]} [data] - Dict containing the outstanding order details.
888
- * @property {boolean} success - Response is successful or not.
889
- * @property {string} [message] - Message.
890
- */
891
- /**
892
- * @typedef PaidOrderDetails
893
- * @property {number} status_code - HTTP status code.
894
- * @property {Object[]} [data] - Dict containing the paid order details.
895
- * @property {boolean} success - Response is successful or not.
896
- * @property {string} [message] - Message.
897
- */
898
- /**
899
- * @typedef DeleteRefundAccountDetails
900
- * @property {boolean} success - Success/Failure of the deleted beneficiary.
901
- * @property {string} message - Message.
902
- */
903
- /**
904
- * @typedef RefundOptionsDetails
905
- * @property {string} display_name - Refund option display name.
906
- * @property {number} id - Refund ID. It will be unique identifier.
907
- * @property {boolean} [is_active] - Refund option is active or not.
908
- * @property {string} name - Refund option name.
909
- */
910
- /**
911
- * @typedef RefundOptions
912
- * @property {RefundOptionsDetails} items - List of all refund options.
913
- */
914
- /**
915
- * @typedef OfflineRefundOptions
916
- * @property {RefundOptionsDetails} items - List of all refund options.
917
- * @property {string[]} payment_modes - List of all offline payment options. MOP
918
- * Code value.
919
- */
920
- /**
921
- * @typedef RefundOptionDetails
922
- * @property {OfflineRefundOptions} offline_refund_options - Available offline
923
- * refund options data.
924
- * @property {boolean} success - Success/Failure Of response.
925
- * @property {RefundOptions} refund_options - Available refund options data.
926
- */
927
- /**
928
- * @typedef SelectedRefundOptionDetails
929
- * @property {Object} transfer_mode - Selected transfer mode for given shipment.
930
- * @property {string} shipment_id - ID of the shipment.
931
- * @property {string} message - Detailed message.
932
- * @property {boolean} success - Whether refund is successful or not.
933
- */
934
- /**
935
- * @typedef WalletBeneficiaryDetails
936
- * @property {string} beneficiary_id - Beneficiary Id.
937
- * @property {string} modified_on - MOdification Date of Beneficiary.
938
- * @property {string} display_name - Display Name Of Account.
939
- * @property {number} id - Id of the wallet beneficiary.
940
- * @property {string} subtitle - SHort Title Of Account.
941
- * @property {string} transfer_mode - Transfer Mode Of Account.
942
- * @property {string} [mobile] - MObile no of User.
943
- * @property {boolean} is_active - Boolean Flag whether Beneficiary set or not.
944
- * @property {string} created_on - Creation Date of Beneficiary.
945
- * @property {string} address - Address of User.
946
- * @property {string} title - Title Of Account.
947
- * @property {string} wallet_address - Bank Name Of Account.
948
- * @property {string} [comment] - Remarks.
949
- * @property {string} [wallet] - Branch Name Of Account.
950
- * @property {string} email - EMail of User.
951
- * @property {string} [delights_user_name] - User Id Who filled the Beneficiary.
952
- */
953
- /**
954
- * @typedef UpiBeneficiaryDetails
955
- * @property {string} beneficiary_id - Beneficiary Id.
956
- * @property {string} modified_on - MOdification Date of Beneficiary.
957
- * @property {string} display_name - Display Name Of Account.
958
- * @property {number} id - Id of the upi beneficiary.
959
- * @property {string} subtitle - SHort Title Of Account.
960
- * @property {string} transfer_mode - Transfer Mode Of Account.
961
- * @property {string} [vpa] - Branch Name Of Account.
962
- * @property {string} [mobile] - Mobile no of User.
963
- * @property {string} vpa_address - Bank Name Of Account.
964
- * @property {string} created_on - Creation Date of Beneficiary.
965
- * @property {string} address - Address of User.
966
- * @property {string} title - Title Of Account.
967
- * @property {string} [comment] - Remarks.
968
- * @property {boolean} is_active - Boolean Flag whether Beneficiary set or not.
969
- * @property {string} email - EMail of User.
970
- * @property {string} [delights_user_name] - User Id Who filled the Beneficiary.
971
- */
972
- /**
973
- * @typedef BeneficiaryRefundOptions
974
- * @property {OrderBeneficiaryDetails} [bank] - List of all add bank beneficiary details.
975
- * @property {WalletBeneficiaryDetails} [wallet] - List of all add Wallet
976
- * beneficiary details.
977
- * @property {UpiBeneficiaryDetails} [upi] - List of all add UPI beneficiary details.
978
- */
979
- /**
980
- * @typedef OrderBeneficiaryDetailsSchemaV2
981
- * @property {boolean} show_beneficiary_details - Show Beneficiary details on UI or not.
982
- * @property {BeneficiaryRefundOptions} data - Beneficiary Data for Bank
983
- * account, UPI and Wallets.
984
- * @property {Object} limit - Max Limit for adding bank account, UPI and wallet.
985
- */
986
- /**
987
- * @typedef ValidateValidateAddress
988
- * @property {string} [ifsc_code] - IFSC Code.
989
- * @property {string} [upi_vpa] - VPA Address.
990
- * @property {string} [aggregator] - Aggregator Name.
991
- */
992
- /**
993
- * @typedef VPADetails
994
- * @property {boolean} is_valid - Is VPA valid or not.
995
- * @property {string} upi_vpa - VPA address.
996
- * @property {string} status - VPA validation message.
997
- * @property {string} customer_name - VPA Customer Name.
998
- */
999
- /**
1000
- * @typedef ValidateValidateAddressDetails
1001
- * @property {VPADetails} [upi] - UPI validation details.
1002
- * @property {boolean} success - Whether address validation is successful or not.
1003
- * @property {Object} [ifsc] - IFSC details response data.
1004
- */
1005
- /**
1006
- * @typedef PaymentMethodsMetaOrder
1007
- * @property {string} merchant_code - Merchant code.
1008
- * @property {string} payment_gateway - Payment gateway name.
1009
- * @property {string} payment_identifier - Payment identifier.
1010
- */
1011
- /**
1012
- * @typedef PaymentOrderMethods
1013
- * @property {number} amount - Amount to be collected.
1014
- * @property {string} [payment] - Payment type i.e. Required / Blocked.
1015
- * @property {string} mode - Payment mode.
1016
- * @property {PaymentMethodsMetaOrder} meta
1017
- * @property {string} name - Payment mode name.
1018
- */
1019
- /**
1020
- * @typedef PaymentOrder
1021
- * @property {PaymentOrderMethods[]} [payment_methods] - All payment methods for order.
1022
- * @property {string} order_id - Order id.
1023
- * @property {string} [shipment_id] - Shipment_id.
1024
- */
1025
- /**
1026
- * @typedef PaymentOrderData
1027
- * @property {number} [amount] - Amount.
1028
- * @property {string} [aggregator] - Aggregator name.
1029
- * @property {string} [callback_url] - Callback url for aggregator.
1030
- * @property {string} [order_id] - Aggregator order id.
1031
- * @property {string} [customer_id] - Aggregator customer id.
1032
- * @property {string} [merchant_order_id] - Merchant order id.
1033
- * @property {string} [currency] - Currency used for the order.
1034
- * @property {string} [email] - Email address of the customer.
1035
- * @property {string} [contact] - Contact number of the customer.
1036
- * @property {string} [method] - Method of payment or delivery for the order.
1037
- */
1038
- /**
1039
- * @typedef PaymentOrderDetails
1040
- * @property {string} [payment_confirm_url] - Payment confirm url for aggregator.
1041
- * @property {string} [callback_url] - Callback url for aggregator.
1042
- * @property {string} [order_id] - Merchant order id.
1043
- * @property {boolean} [success] - Successful or failure.
1044
- * @property {number} status_code - HTTP status code.
1045
- * @property {PaymentOrderData} [data]
1046
- * @property {string} message - Detailed message.
1047
- */
1048
- /**
1049
- * @typedef ShipmentRefund
1050
- * @property {string} shipment_id - Shipment Id of the respective Merchant Order Id.
1051
- * @property {string} order_id - Merchant Order Id.
1052
- * @property {string} transfer_mode - Transfer Mode of the Beneficiary to be added.
1053
- * @property {string} [beneficiary_id] - Beneficiary Hash Id of the beneficiary added.
1054
- */
1055
- /**
1056
- * @typedef ShipmentRefundDetail
1057
- * @property {string} shipment_id - ID of the shipment.
1058
- * @property {string} order_id - ID of an order.
1059
- * @property {string} transfer_mode - Mode of transfer for the shipment refund
1060
- * (e.g., bank transfer, digital wallet).
1061
- * @property {string} beneficiary_id - Unique identifier for the beneficiary
1062
- * receiving the refund.
1063
- */
1064
- /**
1065
- * @typedef ShipmentRefundDetails
1066
- * @property {ShipmentRefundDetail} data - Selected Shipment refund option details.
1067
- * @property {boolean} success - Successful or not.
1068
- * @property {string} message - Detailed message.
1069
- */
1070
- declare class PaymentApplicationModel {
1071
- }
1072
- declare namespace PaymentApplicationModel {
1073
- export { AggregatorConfigDetail, AggregatorsConfigDetail, ErrorCodeAndDescription, HttpErrorCodeDetails, AttachCard, AttachCardsDetails, CardPaymentGateway, ActiveCardPaymentGatewayDetails, Card, ListCardsDetails, DeleteCard, DeleteCardsDetails, ValidateCustomer, ValidateCustomerDetails, ChargeCustomer, ChargeCustomerDetails, PaymentInitialization, PaymentInitializationDetails, PaymentStatusUpdate, PaymentStatusUpdateDetails, IntentAppErrorList, PaymentModeLogo, IntentApp, PaymentModeList, RootPaymentMode, AggregatorRoute, PaymentDefaultSelection, PaymentFlow, PaymentOptionAndFlow, AdvanceObject, SplitObject, AdvancePaymentObject, PaymentModeRouteDetails, WalletLinkRequestSchema, WalletVerifyRequestSchema, WalletDelinkRequestSchema, WalletResponseSchema, RupifiBannerData, RupifiBannerDetails, EpaylaterBannerData, EpaylaterBannerDetails, ResendOrCancelPayment, LinkStatus, ResendOrCancelPaymentDetails, RenderHTML, RenderHTMLDetails, ValidateVPA, ValidateUPI, ValidateVPADetails, CardDetails, CardDetailsFetchedDetails, TransferItemsDetails, TransferModeDetails, TransferModeFetchDetails, UpdateRefundTransferMode, RefundTransferModeUpdateDetails, OrderBeneficiaryDetails, OrderBeneficiaryFetchDetails, NotFoundResourceError, IfscCodeDetails, ErrorCodeDescription, AddBeneficiaryViaOtpVerification, AddBeneficiaryViaOtpVerificationDetails, WrongOtpError, BeneficiaryModeDetails, AddBeneficiaryDetails, RefundAccountDetails, BankDetailsForOTP, AddBeneficiaryDetailsOTP, WalletOtp, WalletOtpDetails, SetDefaultBeneficiary, SetDefaultBeneficiaryDetails, GetPaymentLinkDetails, ErrorDescription, ErrorDetails, CreatePaymentLinkMeta, CreatePaymentLink, CreatePaymentLinkDetails, CancelOrResendPaymentLink, ResendPaymentLinkDetails, CancelPaymentLinkDetails, PollingPaymentLinkDetails, PaymentMethodsMeta, CreateOrderUserPaymentMethods, CreateOrderUser, CreateOrderUserData, CreateOrderUserDetails, BalanceDetails, CreditSummary, CustomerCreditSummaryDetails, RedirectURL, RedirectToAggregatorDetails, CreditDetail, CheckCreditDetails, KYCAddress, UserPersonalInfoInDetails, MarketplaceInfo, BusinessDetails, DeviceDetails, CustomerOnboarding, OnboardSummary, CustomerOnboardingDetails, OutstandingOrderDetails, PaidOrderDetails, DeleteRefundAccountDetails, RefundOptionsDetails, RefundOptions, OfflineRefundOptions, RefundOptionDetails, SelectedRefundOptionDetails, WalletBeneficiaryDetails, UpiBeneficiaryDetails, BeneficiaryRefundOptions, OrderBeneficiaryDetailsSchemaV2, ValidateValidateAddress, VPADetails, ValidateValidateAddressDetails, PaymentMethodsMetaOrder, PaymentOrderMethods, PaymentOrder, PaymentOrderData, PaymentOrderDetails, ShipmentRefund, ShipmentRefundDetail, ShipmentRefundDetails };
1074
- }
1075
- /** @returns {AggregatorConfigDetail} */
1076
- declare function AggregatorConfigDetail(): AggregatorConfigDetail;
1077
- type AggregatorConfigDetail = {
1078
- /**
1079
- * - SDK details.
1080
- */
1081
- sdk?: boolean;
1082
- /**
1083
- * - Masked payment gateway api secret.
1084
- */
1085
- secret: string;
1086
- /**
1087
- * - Payment gateway api endpoint.
1088
- */
1089
- api?: string;
1090
- /**
1091
- * - Masked pin.
1092
- */
1093
- pin?: string;
1094
- /**
1095
- * - Fynd or self payment gateway.
1096
- */
1097
- config_type: string;
1098
- /**
1099
- * - Unique merchant key.
1100
- */
1101
- merchant_key?: string;
1102
- /**
1103
- * - Payment gateway verify payment api endpoint.
1104
- */
1105
- verify_api?: string;
1106
- /**
1107
- * - Payment gateway api key.
1108
- */
1109
- key: string;
1110
- /**
1111
- * - Registered User id.
1112
- */
1113
- user_id?: string;
1114
- /**
1115
- * - Unique merchant id.
1116
- */
1117
- merchant_id?: string;
1118
- };
1119
- /** @returns {AggregatorsConfigDetail} */
1120
- declare function AggregatorsConfigDetail(): AggregatorsConfigDetail;
1121
- type AggregatorsConfigDetail = {
1122
- /**
1123
- * - Api response was successful or not.
1124
- */
1125
- success: boolean;
1126
- razorpay?: AggregatorConfigDetail;
1127
- juspay?: AggregatorConfigDetail;
1128
- simpl?: AggregatorConfigDetail;
1129
- payumoney?: AggregatorConfigDetail;
1130
- rupifi?: AggregatorConfigDetail;
1131
- mswipe?: AggregatorConfigDetail;
1132
- stripe?: AggregatorConfigDetail;
1133
- ccavenue?: AggregatorConfigDetail;
1134
- /**
1135
- * - Environment i.e Live or Test.
1136
- */
1137
- env: string;
1138
- };
1139
- /** @returns {ErrorCodeAndDescription} */
1140
- declare function ErrorCodeAndDescription(): ErrorCodeAndDescription;
1141
- type ErrorCodeAndDescription = {
1142
- /**
1143
- * - Error description code.
1144
- */
1145
- code: string;
1146
- /**
1147
- * - Error human understandable description.
1148
- */
1149
- description: string;
1150
- };
1151
- /** @returns {HttpErrorCodeDetails} */
1152
- declare function HttpErrorCodeDetails(): HttpErrorCodeDetails;
1153
- type HttpErrorCodeDetails = {
1154
- error?: ErrorCodeAndDescription;
1155
- /**
1156
- * - Response is successful or not.
1157
- */
1158
- success: boolean;
1159
- };
1160
- /** @returns {AttachCard} */
1161
- declare function AttachCard(): AttachCard;
1162
- type AttachCard = {
1163
- /**
1164
- * - Nickname of the card holder.
1165
- */
1166
- nickname?: string;
1167
- /**
1168
- * - Refresh cache flag.
1169
- */
1170
- refresh?: boolean;
1171
- /**
1172
- * - Card token of payment gateway.
1173
- */
1174
- card_id: string;
1175
- /**
1176
- * - Name of the card holder.
1177
- */
1178
- name_on_card?: string;
1179
- };
1180
- /** @returns {AttachCardsDetails} */
1181
- declare function AttachCardsDetails(): AttachCardsDetails;
1182
- type AttachCardsDetails = {
1183
- /**
1184
- * - List of cards of customer.
1185
- */
1186
- data: any;
1187
- /**
1188
- * - Response is successful or not.
1189
- */
1190
- success: boolean;
1191
- /**
1192
- * - Human readable message.
1193
- */
1194
- message?: string;
1195
- };
1196
- /** @returns {CardPaymentGateway} */
1197
- declare function CardPaymentGateway(): CardPaymentGateway;
1198
- type CardPaymentGateway = {
1199
- /**
1200
- * - Payment gateway CARD api endpoint.
1201
- */
1202
- api?: string;
1203
- /**
1204
- * - Payment gateway name.
1205
- */
1206
- aggregator: string;
1207
- /**
1208
- * - Payment gateway customer id.
1209
- */
1210
- customer_id?: string;
1211
- };
1212
- /** @returns {ActiveCardPaymentGatewayDetails} */
1213
- declare function ActiveCardPaymentGatewayDetails(): ActiveCardPaymentGatewayDetails;
1214
- type ActiveCardPaymentGatewayDetails = {
1215
- cards: CardPaymentGateway;
1216
- /**
1217
- * - Response is successful or not.
1218
- */
1219
- success: boolean;
1220
- /**
1221
- * - Human readable message.
1222
- */
1223
- message: string;
1224
- };
1225
- /** @returns {Card} */
1226
- declare function Card(): Card;
1227
- type Card = {
1228
- /**
1229
- * - Card number mentioned on the card.
1230
- */
1231
- card_number?: string;
1232
- /**
1233
- * - Name mentioned on the card.
1234
- */
1235
- card_name?: string;
1236
- /**
1237
- * - Type of the card.
1238
- */
1239
- card_type?: string;
1240
- /**
1241
- * - Brand image on the card.
1242
- */
1243
- card_brand_image?: string;
1244
- /**
1245
- * - Card reference.
1246
- */
1247
- card_reference?: string;
1248
- /**
1249
- * - Issuer of the card.
1250
- */
1251
- card_issuer?: string;
1252
- /**
1253
- * - Brand of the card.
1254
- */
1255
- card_brand?: string;
1256
- /**
1257
- * - Card expiry.
1258
- */
1259
- expired?: boolean;
1260
- /**
1261
- * - Whether card
1262
- * is tokenized or not.
1263
- */
1264
- compliant_with_tokenisation_guidelines?: boolean;
1265
- /**
1266
- * - International Securities Identification
1267
- * Number for the card.
1268
- */
1269
- card_isin?: string;
1270
- /**
1271
- * - Card's expiration year.
1272
- */
1273
- exp_year?: number;
1274
- /**
1275
- * - User-defined name for the card.
1276
- */
1277
- nickname?: string;
1278
- /**
1279
- * - Name of the payment aggregator.
1280
- */
1281
- aggregator_name: string;
1282
- /**
1283
- * - Unique fingerprint of the card for
1284
- * identification.
1285
- */
1286
- card_fingerprint?: string;
1287
- /**
1288
- * - Encrypted token representing the card.
1289
- */
1290
- card_token?: string;
1291
- /**
1292
- * - Card's expiration month.
1293
- */
1294
- exp_month?: number;
1295
- /**
1296
- * - Unique identifier for the card within the system.
1297
- */
1298
- card_id?: string;
1299
- };
1300
- /** @returns {ListCardsDetails} */
1301
- declare function ListCardsDetails(): ListCardsDetails;
1302
- type ListCardsDetails = {
1303
- /**
1304
- * - List of cards of customer.
1305
- */
1306
- data?: Card[];
1307
- /**
1308
- * - Response is successful or not.
1309
- */
1310
- success: boolean;
1311
- /**
1312
- * - Human readable message.
1313
- */
1314
- message: string;
1315
- };
1316
- /** @returns {DeleteCard} */
1317
- declare function DeleteCard(): DeleteCard;
1318
- type DeleteCard = {
1319
- /**
1320
- * - Card token of payment gateway.
1321
- */
1322
- card_id: string;
1323
- };
1324
- /** @returns {DeleteCardsDetails} */
1325
- declare function DeleteCardsDetails(): DeleteCardsDetails;
1326
- type DeleteCardsDetails = {
1327
- /**
1328
- * - Response is successful or not.
1329
- */
1330
- success: boolean;
1331
- /**
1332
- * - Human readable message.
1333
- */
1334
- message?: string;
1335
- };
1336
- /** @returns {ValidateCustomer} */
1337
- declare function ValidateCustomer(): ValidateCustomer;
1338
- type ValidateCustomer = {
1339
- /**
1340
- * - Payment gateway name in camelcase i.e Simple, Rupifi.
1341
- */
1342
- aggregator: string;
1343
- /**
1344
- * - Payable amount in paise.
1345
- */
1346
- transaction_amount_in_paise: number;
1347
- /**
1348
- * - User mobile number without country code.
1349
- */
1350
- phone_number: string;
1351
- /**
1352
- * - Extra meta fields.
1353
- */
1354
- billing_address?: any;
1355
- /**
1356
- * - Extra meta fields.
1357
- */
1358
- order_items?: any[];
1359
- /**
1360
- * - Hashed payload string.
1361
- */
1362
- payload?: string;
1363
- /**
1364
- * - Extra meta fields.
1365
- */
1366
- merchant_params?: any;
1367
- /**
1368
- * - Extra meta fields.
1369
- */
1370
- delivery_address?: any;
1371
- };
1372
- /** @returns {ValidateCustomerDetails} */
1373
- declare function ValidateCustomerDetails(): ValidateCustomerDetails;
1374
- type ValidateCustomerDetails = {
1375
- /**
1376
- * - Payment gateway response data.
1377
- */
1378
- data?: any;
1379
- /**
1380
- * - Response is successful or not.
1381
- */
1382
- success: boolean;
1383
- /**
1384
- * - Error or success message.
1385
- */
1386
- message: string;
1387
- };
1388
- /** @returns {ChargeCustomer} */
1389
- declare function ChargeCustomer(): ChargeCustomer;
1390
- type ChargeCustomer = {
1391
- /**
1392
- * - Already Verified flag from payment gateway i.e Mswipe.
1393
- */
1394
- verified?: boolean;
1395
- /**
1396
- * - Payment gateway name i.e Simpl, Mswipe.
1397
- */
1398
- aggregator: string;
1399
- /**
1400
- * - Unique order id.
1401
- */
1402
- order_id: string;
1403
- /**
1404
- * - Transaction token of payment gateway.
1405
- */
1406
- transaction_token?: string;
1407
- /**
1408
- * - Chargeable amount of order.
1409
- */
1410
- amount: number;
1411
- };
1412
- /** @returns {ChargeCustomerDetails} */
1413
- declare function ChargeCustomerDetails(): ChargeCustomerDetails;
1414
- type ChargeCustomerDetails = {
1415
- /**
1416
- * - Status of charged payment.
1417
- */
1418
- status: string;
1419
- /**
1420
- * - Cart id of customer.
1421
- */
1422
- cart_id?: string;
1423
- /**
1424
- * - Response is successful or not.
1425
- */
1426
- success: boolean;
1427
- /**
1428
- * - Payment gateway name i.e Simpl, Mswipe.
1429
- */
1430
- aggregator: string;
1431
- /**
1432
- * - Human readable message.
1433
- */
1434
- message: string;
1435
- /**
1436
- * - Unique order id.
1437
- */
1438
- order_id: string;
1439
- /**
1440
- * - Delivery address id of customer.
1441
- */
1442
- delivery_address_id?: string;
1443
- };
1444
- /** @returns {PaymentInitialization} */
1445
- declare function PaymentInitialization(): PaymentInitialization;
1446
- type PaymentInitialization = {
1447
- /**
1448
- * - Payment gateway payment id.
1449
- */
1450
- razorpay_payment_id?: string;
1451
- /**
1452
- * - Payment method.
1453
- */
1454
- method: string;
1455
- /**
1456
- * - EDC machine Unique Identifier.
1457
- */
1458
- device_id?: string;
1459
- /**
1460
- * - Payment gateway name.
1461
- */
1462
- aggregator: string;
1463
- /**
1464
- * - Payment gateway customer id.
1465
- */
1466
- customer_id: string;
1467
- /**
1468
- * - Customer valid mobile number.
1469
- */
1470
- contact: string;
1471
- /**
1472
- * - Unique fynd order id.
1473
- */
1474
- merchant_order_id: string;
1475
- /**
1476
- * - Customer vpa address.
1477
- */
1478
- vpa?: string;
1479
- /**
1480
- * - Payment gateway order id.
1481
- */
1482
- order_id: string;
1483
- /**
1484
- * - Currency code.
1485
- */
1486
- currency: string;
1487
- /**
1488
- * - Payment polling timeout if not received response.
1489
- */
1490
- timeout?: number;
1491
- /**
1492
- * - Payable amount.
1493
- */
1494
- amount: number;
1495
- /**
1496
- * - Customer valid email.
1497
- */
1498
- email: string;
1499
- };
1500
- /** @returns {PaymentInitializationDetails} */
1501
- declare function PaymentInitializationDetails(): PaymentInitializationDetails;
1502
- type PaymentInitializationDetails = {
1503
- /**
1504
- * - Status of payment.
1505
- */
1506
- status?: string;
1507
- /**
1508
- * - Payment id.
1509
- */
1510
- razorpay_payment_id?: string;
1511
- /**
1512
- * - Payment order id.
1513
- */
1514
- aggregator_order_id?: string;
1515
- /**
1516
- * - Payment method.
1517
- */
1518
- method: string;
1519
- /**
1520
- * - Response is successful or not.
1521
- */
1522
- success: boolean;
1523
- /**
1524
- * - UPI poll url.
1525
- */
1526
- upi_poll_url?: string;
1527
- /**
1528
- * - Payment virtual address.
1529
- */
1530
- virtual_id?: string;
1531
- /**
1532
- * - EDC machine Unique Identifier.
1533
- */
1534
- device_id?: string;
1535
- /**
1536
- * - Polling url.
1537
- */
1538
- polling_url: string;
1539
- /**
1540
- * - Payment gateway name.
1541
- */
1542
- aggregator: string;
1543
- /**
1544
- * - Order id.
1545
- */
1546
- merchant_order_id: string;
1547
- /**
1548
- * - Payment gateway customer id.
1549
- */
1550
- customer_id?: string;
1551
- /**
1552
- * - Customer vpa address.
1553
- */
1554
- vpa?: string;
1555
- /**
1556
- * - Currency code.
1557
- */
1558
- currency?: string;
1559
- /**
1560
- * - Timeout.
1561
- */
1562
- timeout?: number;
1563
- /**
1564
- * - Payable amount.
1565
- */
1566
- amount?: number;
1567
- /**
1568
- * - Bharat qr image url.
1569
- */
1570
- bqr_image?: string;
1571
- };
1572
- /** @returns {PaymentStatusUpdate} */
1573
- declare function PaymentStatusUpdate(): PaymentStatusUpdate;
1574
- type PaymentStatusUpdate = {
1575
- /**
1576
- * - Status of payment.
1577
- */
1578
- status: string;
1579
- /**
1580
- * - Unique fynd transaction id.
1581
- */
1582
- merchant_transaction_id?: string;
1583
- /**
1584
- * - Payment method.
1585
- */
1586
- method: string;
1587
- /**
1588
- * - EDC machine Unique Identifier.
1589
- */
1590
- device_id?: string;
1591
- /**
1592
- * - Payment gateway name.
1593
- */
1594
- aggregator: string;
1595
- /**
1596
- * - Payment gateway customer id.
1597
- */
1598
- customer_id?: string;
1599
- /**
1600
- * - Customer valid mobile number.
1601
- */
1602
- contact?: string;
1603
- /**
1604
- * - Unique fynd order id.
1605
- */
1606
- merchant_order_id: string;
1607
- /**
1608
- * - Customer vpa address.
1609
- */
1610
- vpa?: string;
1611
- /**
1612
- * - Payment gateway order id.
1613
- */
1614
- order_id: string;
1615
- /**
1616
- * - Currency code.
1617
- */
1618
- currency?: string;
1619
- /**
1620
- * - Payable amount.
1621
- */
1622
- amount?: number;
1623
- /**
1624
- * - Customer valid email.
1625
- */
1626
- email?: string;
1627
- };
1628
- /** @returns {PaymentStatusUpdateDetails} */
1629
- declare function PaymentStatusUpdateDetails(): PaymentStatusUpdateDetails;
1630
- type PaymentStatusUpdateDetails = {
1631
- /**
1632
- * - Payment status.
1633
- */
1634
- status: string;
1635
- /**
1636
- * - Response is successful or not.
1637
- */
1638
- success?: boolean;
1639
- /**
1640
- * - Response is successful or not.
1641
- */
1642
- retry: boolean;
1643
- /**
1644
- * - Redirect url.
1645
- */
1646
- redirect_url?: string;
1647
- /**
1648
- * - Payment gateway name.
1649
- */
1650
- aggregator_name: string;
1651
- };
1652
- /** @returns {IntentAppErrorList} */
1653
- declare function IntentAppErrorList(): IntentAppErrorList;
1654
- type IntentAppErrorList = {
1655
- /**
1656
- * - Code of the intent App.
1657
- */
1658
- code?: string;
1659
- /**
1660
- * - Package Name of the intent App.
1661
- */
1662
- package_name?: string;
1663
- };
1664
- /** @returns {PaymentModeLogo} */
1665
- declare function PaymentModeLogo(): PaymentModeLogo;
1666
- type PaymentModeLogo = {
1667
- /**
1668
- * - Large Logo.
1669
- */
1670
- large: string;
1671
- /**
1672
- * - Small Logo.
1673
- */
1674
- small: string;
1675
- };
1676
- /** @returns {IntentApp} */
1677
- declare function IntentApp(): IntentApp;
1678
- type IntentApp = {
1679
- /**
1680
- * - Code of the intent App.
1681
- */
1682
- code?: string;
1683
- /**
1684
- * - Package Name of the intent App.
1685
- */
1686
- package_name?: string;
1687
- logos?: PaymentModeLogo;
1688
- /**
1689
- * - Display Name of the intent App.
1690
- */
1691
- display_name?: string;
1692
- };
1693
- /** @returns {PaymentModeList} */
1694
- declare function PaymentModeList(): PaymentModeList;
1695
- type PaymentModeList = {
1696
- /**
1697
- * - Card number mentioned on the card.
1698
- */
1699
- card_number?: string;
1700
- /**
1701
- * - Unique code identifying the merchant.
1702
- */
1703
- merchant_code?: string;
1704
- /**
1705
- * - Reference identifier for the card.
1706
- */
1707
- card_reference?: string;
1708
- /**
1709
- * - Issuing bank or institution of the card.
1710
- */
1711
- card_issuer?: string;
1712
- /**
1713
- * - Indicates
1714
- * compliance with tokenization guidelines.
1715
- */
1716
- compliant_with_tokenisation_guidelines?: boolean;
1717
- /**
1718
- * - General code for identifying a transaction or status.
1719
- */
1720
- code?: string;
1721
- /**
1722
- * - Limit for Cash on Delivery (COD) transactions.
1723
- */
1724
- cod_limit?: number;
1725
- /**
1726
- * - Flow or process intended for the transaction.
1727
- */
1728
- intent_flow?: boolean;
1729
- /**
1730
- * - Virtual Payment Address (VPA) used by Fynd.
1731
- */
1732
- fynd_vpa?: string;
1733
- /**
1734
- * - List of error
1735
- * dictionaries related to intent app.
1736
- */
1737
- intent_app_error_dict_list?: IntentAppErrorList[];
1738
- /**
1739
- * - Name of the payment aggregator.
1740
- */
1741
- aggregator_name: string;
1742
- /**
1743
- * - Unique fingerprint of the card for
1744
- * identification.
1745
- */
1746
- card_fingerprint?: string;
1747
- /**
1748
- * - List of errors associated with
1749
- * the intent app.
1750
- */
1751
- intent_app_error_list?: string[];
1752
- /**
1753
- * - Application intended for handling the
1754
- * transaction.
1755
- */
1756
- intent_app?: IntentApp[];
1757
- /**
1758
- * - Indicates whether the card is expired.
1759
- */
1760
- expired?: boolean;
1761
- /**
1762
- * - Number of retry attempts.
1763
- */
1764
- retry_count?: number;
1765
- /**
1766
- * - Card's expiration year.
1767
- */
1768
- exp_year?: number;
1769
- /**
1770
- * - Card's expiration month.
1771
- */
1772
- exp_month?: number;
1773
- /**
1774
- * - Unique identifier for the card within the system.
1775
- */
1776
- card_id?: string;
1777
- /**
1778
- * - Remaining available limit on the card.
1779
- */
1780
- remaining_limit?: number;
1781
- /**
1782
- * - Priority of display in the user interface.
1783
- */
1784
- display_priority?: number;
1785
- /**
1786
- * - Brand of the card (e.g., Visa, MasterCard).
1787
- */
1788
- card_brand?: string;
1789
- /**
1790
- * - Maximum limit per order for COD
1791
- * transactions.
1792
- */
1793
- cod_limit_per_order?: number;
1794
- logo_url?: PaymentModeLogo;
1795
- /**
1796
- * - User-defined name for the card.
1797
- */
1798
- nickname?: string;
1799
- /**
1800
- * - Name printed on the card.
1801
- */
1802
- card_name?: string;
1803
- /**
1804
- * - Type of the card (e.g., debit, credit).
1805
- */
1806
- card_type?: string;
1807
- /**
1808
- * - Image representing the card brand.
1809
- */
1810
- card_brand_image?: string;
1811
- /**
1812
- * - Display name for the card in the user interface.
1813
- */
1814
- display_name?: string;
1815
- /**
1816
- * - International Securities Identification
1817
- * Number for the card.
1818
- */
1819
- card_isin?: string;
1820
- /**
1821
- * - Timeout duration for transactions.
1822
- */
1823
- timeout?: number;
1824
- /**
1825
- * - Encrypted token representing the card.
1826
- */
1827
- card_token?: string;
1828
- /**
1829
- * - User's name.
1830
- */
1831
- name?: string;
1832
- /**
1833
- * - Payment methods meta.
1834
- */
1835
- meta?: any;
1836
- };
1837
- /** @returns {RootPaymentMode} */
1838
- declare function RootPaymentMode(): RootPaymentMode;
1839
- type RootPaymentMode = {
1840
- /**
1841
- * - This flag will be true in case of
1842
- * Payment link payment through card.
1843
- */
1844
- is_pay_by_card_pl?: boolean;
1845
- /**
1846
- * - Anonymous card flag.
1847
- */
1848
- add_card_enabled?: boolean;
1849
- /**
1850
- * - Display Priority.
1851
- */
1852
- display_priority: number;
1853
- /**
1854
- * - Payment mode display name.
1855
- */
1856
- display_name: string;
1857
- /**
1858
- * - Payment mode.
1859
- */
1860
- list?: PaymentModeList[];
1861
- /**
1862
- * - Card save or not.
1863
- */
1864
- save_card?: boolean;
1865
- /**
1866
- * - Display Priority.
1867
- */
1868
- aggregator_name?: string;
1869
- /**
1870
- * - Payment mode name.
1871
- */
1872
- name: string;
1873
- /**
1874
- * - Anonymous card flag.
1875
- */
1876
- anonymous_enable?: boolean;
1877
- };
1878
- /** @returns {AggregatorRoute} */
1879
- declare function AggregatorRoute(): AggregatorRoute;
1880
- type AggregatorRoute = {
1881
- /**
1882
- * - Details about aggregator route.
1883
- */
1884
- data?: any;
1885
- /**
1886
- * - Payment_flow_data.
1887
- */
1888
- payment_flow_data?: any;
1889
- /**
1890
- * - Payment_flow.
1891
- */
1892
- payment_flow?: string;
1893
- /**
1894
- * - API link of the aggregator.
1895
- */
1896
- api_link?: string;
1897
- };
1898
- /** @returns {PaymentDefaultSelection} */
1899
- declare function PaymentDefaultSelection(): PaymentDefaultSelection;
1900
- type PaymentDefaultSelection = {
1901
- /**
1902
- * - Default Selection Payment Mode.
1903
- */
1904
- mode?: string;
1905
- /**
1906
- * - Identifier for Payment Mode.
1907
- */
1908
- identifier?: string;
1909
- /**
1910
- * - Decide if the default payment mode will skip the
1911
- * payment options page altogether or just be preferred on the Frontend.
1912
- */
1913
- skip?: boolean;
1914
- };
1915
- /** @returns {PaymentFlow} */
1916
- declare function PaymentFlow(): PaymentFlow;
1917
- type PaymentFlow = {
1918
- bqr_razorpay?: AggregatorRoute;
1919
- fynd?: AggregatorRoute;
1920
- epaylater?: AggregatorRoute;
1921
- razorpay?: AggregatorRoute;
1922
- juspay?: AggregatorRoute;
1923
- ajiodhan?: AggregatorRoute;
1924
- simpl?: AggregatorRoute;
1925
- rupifi?: AggregatorRoute;
1926
- mswipe?: AggregatorRoute;
1927
- stripe?: AggregatorRoute;
1928
- ccavenue?: AggregatorRoute;
1929
- payubiz?: AggregatorRoute;
1930
- jiopay?: AggregatorRoute;
1931
- upi_razorpay?: AggregatorRoute;
1932
- };
1933
- /** @returns {PaymentOptionAndFlow} */
1934
- declare function PaymentOptionAndFlow(): PaymentOptionAndFlow;
1935
- type PaymentOptionAndFlow = {
1936
- /**
1937
- * - Payment options.
1938
- */
1939
- payment_option: RootPaymentMode[];
1940
- payment_flows: PaymentFlow;
1941
- payment_default_selection?: PaymentDefaultSelection;
1942
- };
1943
- /** @returns {AdvanceObject} */
1944
- declare function AdvanceObject(): AdvanceObject;
1945
- type AdvanceObject = {
1946
- /**
1947
- * - Is Advance Payment active.
1948
- */
1949
- is_active?: boolean;
1950
- /**
1951
- * - Amount for Payment Breakdown.
1952
- */
1953
- amount?: number;
1954
- /**
1955
- * - Time unit for refunds.
1956
- */
1957
- time_unit?: string;
1958
- /**
1959
- * - The description for Advance Payment (user
1960
- * configured).
1961
- */
1962
- description?: string;
1963
- /**
1964
- * - The display name for Advance payment.
1965
- */
1966
- display_name?: string;
1967
- /**
1968
- * - Type of prepayment value.
1969
- */
1970
- prepayment_type?: string;
1971
- /**
1972
- * - Value for prepayment in advance payment.
1973
- */
1974
- prepayment_value?: number;
1975
- /**
1976
- * - Type of cancellation.
1977
- */
1978
- cancellation_type?: string;
1979
- /**
1980
- * - Time limit for processing refund.
1981
- */
1982
- refund_time_limit?: number;
1983
- /**
1984
- * - All available types of prepayment.
1985
- */
1986
- all_prepayment_type?: string[];
1987
- /**
1988
- * - Is custom advance amount allowed?.
1989
- */
1990
- allow_custom_advance_amount?: boolean;
1991
- };
1992
- /** @returns {SplitObject} */
1993
- declare function SplitObject(): SplitObject;
1994
- type SplitObject = {
1995
- /**
1996
- * - Maximum amount of splits allowed.
1997
- */
1998
- total_number_of_splits?: number;
1999
- /**
2000
- * - Number of splits remaining.
2001
- */
2002
- splits_remaining?: number;
2003
- /**
2004
- * - Amount pending to be paid.
2005
- */
2006
- amount_remaining?: number;
2007
- };
2008
- /** @returns {AdvancePaymentObject} */
2009
- declare function AdvancePaymentObject(): AdvancePaymentObject;
2010
- type AdvancePaymentObject = {
2011
- /**
2012
- * - Name of Advance Payment Mode.
2013
- */
2014
- name?: string;
2015
- /**
2016
- * - Display Priority for Payment Option.
2017
- */
2018
- display_priority?: number;
2019
- /**
2020
- * - Payment Mode ID for Advance Payment Option.
2021
- */
2022
- payment_mode_id?: number;
2023
- /**
2024
- * - Display name for Advance Payment Mode.
2025
- */
2026
- display_name?: string;
2027
- /**
2028
- * - Payment mode.
2029
- */
2030
- list?: PaymentModeList[];
2031
- split?: SplitObject;
2032
- advance?: AdvanceObject;
2033
- };
2034
- /** @returns {PaymentModeRouteDetails} */
2035
- declare function PaymentModeRouteDetails(): PaymentModeRouteDetails;
2036
- type PaymentModeRouteDetails = {
2037
- payment_options: PaymentOptionAndFlow;
2038
- /**
2039
- * - Response is successful or not.
2040
- */
2041
- success: boolean;
2042
- /**
2043
- * - Payment Breakup for advance payment.
2044
- */
2045
- payment_breakup?: any;
2046
- /**
2047
- * - Advance Payment Array.
2048
- */
2049
- advance_payment?: AdvancePaymentObject[];
2050
- };
2051
- /** @returns {WalletLinkRequestSchema} */
2052
- declare function WalletLinkRequestSchema(): WalletLinkRequestSchema;
2053
- type WalletLinkRequestSchema = {
2054
- /**
2055
- * - Aggregator Name.
2056
- */
2057
- aggregator: string;
2058
- /**
2059
- * - Mobile Number for Wallet.
2060
- */
2061
- mobile: string;
2062
- /**
2063
- * - Wallet Code.
2064
- */
2065
- wallet_code: string;
2066
- };
2067
- /** @returns {WalletVerifyRequestSchema} */
2068
- declare function WalletVerifyRequestSchema(): WalletVerifyRequestSchema;
2069
- type WalletVerifyRequestSchema = {
2070
- /**
2071
- * - Aggregator Name.
2072
- */
2073
- aggregator: string;
2074
- /**
2075
- * - Token for wallet linking.
2076
- */
2077
- link_token: string;
2078
- /**
2079
- * - OTP received for wallet linking.
2080
- */
2081
- otp: number;
2082
- };
2083
- /** @returns {WalletDelinkRequestSchema} */
2084
- declare function WalletDelinkRequestSchema(): WalletDelinkRequestSchema;
2085
- type WalletDelinkRequestSchema = {
2086
- /**
2087
- * - Aggregator Name.
2088
- */
2089
- aggregator: string;
2090
- /**
2091
- * - Wallet Code.
2092
- */
2093
- wallet_code: string;
2094
- };
2095
- /** @returns {WalletResponseSchema} */
2096
- declare function WalletResponseSchema(): WalletResponseSchema;
2097
- type WalletResponseSchema = {
2098
- /**
2099
- * - Response received from aggregator.
2100
- */
2101
- data: any;
2102
- /**
2103
- * - Success/Failure of the API call.
2104
- */
2105
- success: boolean;
2106
- };
2107
- /** @returns {RupifiBannerData} */
2108
- declare function RupifiBannerData(): RupifiBannerData;
2109
- type RupifiBannerData = {
2110
- /**
2111
- * - Rupifi KYC status.
2112
- */
2113
- status?: string;
2114
- /**
2115
- * - Rupifi KYC banner url.
2116
- */
2117
- kyc_url?: string;
2118
- };
2119
- /** @returns {RupifiBannerDetails} */
2120
- declare function RupifiBannerDetails(): RupifiBannerDetails;
2121
- type RupifiBannerDetails = {
2122
- data: RupifiBannerData;
2123
- /**
2124
- * - Successful or not.
2125
- */
2126
- success: boolean;
2127
- };
2128
- /** @returns {EpaylaterBannerData} */
2129
- declare function EpaylaterBannerData(): EpaylaterBannerData;
2130
- type EpaylaterBannerData = {
2131
- /**
2132
- * - Epaylater KYC status.
2133
- */
2134
- status?: string;
2135
- /**
2136
- * - EPayLater message.
2137
- */
2138
- message?: string;
2139
- /**
2140
- * - Need to display banner or not.
2141
- */
2142
- display: boolean;
2143
- };
2144
- /** @returns {EpaylaterBannerDetails} */
2145
- declare function EpaylaterBannerDetails(): EpaylaterBannerDetails;
2146
- type EpaylaterBannerDetails = {
2147
- data: EpaylaterBannerData;
2148
- /**
2149
- * - Successful or not.
2150
- */
2151
- success: boolean;
2152
- };
2153
- /** @returns {ResendOrCancelPayment} */
2154
- declare function ResendOrCancelPayment(): ResendOrCancelPayment;
2155
- type ResendOrCancelPayment = {
2156
- /**
2157
- * - Unique order id.
2158
- */
2159
- order_id: string;
2160
- /**
2161
- * - EDC machine Unique Identifier.
2162
- */
2163
- device_id?: string;
2164
- /**
2165
- * - Either resend or cancel.
2166
- */
2167
- request_type: string;
2168
- };
2169
- /** @returns {LinkStatus} */
2170
- declare function LinkStatus(): LinkStatus;
2171
- type LinkStatus = {
2172
- /**
2173
- * - Link action status.
2174
- */
2175
- status: string;
2176
- /**
2177
- * - Message.
2178
- */
2179
- message: string;
2180
- /**
2181
- * - This key specifies payment done
2182
- * status of payment link.
2183
- */
2184
- is_payment_done?: boolean;
2185
- };
2186
- /** @returns {ResendOrCancelPaymentDetails} */
2187
- declare function ResendOrCancelPaymentDetails(): ResendOrCancelPaymentDetails;
2188
- type ResendOrCancelPaymentDetails = {
2189
- data: LinkStatus;
2190
- /**
2191
- * - Response is successful or not.
2192
- */
2193
- success: boolean;
2194
- };
2195
- /** @returns {RenderHTML} */
2196
- declare function RenderHTML(): RenderHTML;
2197
- type RenderHTML = {
2198
- /**
2199
- * - Return Type of API.
2200
- */
2201
- returntype?: string;
2202
- /**
2203
- * - Base64 encoded html string.
2204
- */
2205
- base64_html: string;
2206
- };
2207
- /** @returns {RenderHTMLDetails} */
2208
- declare function RenderHTMLDetails(): RenderHTMLDetails;
2209
- type RenderHTMLDetails = {
2210
- /**
2211
- * - HTML string.
2212
- */
2213
- html: string;
2214
- };
2215
- /** @returns {ValidateVPA} */
2216
- declare function ValidateVPA(): ValidateVPA;
2217
- type ValidateVPA = {
2218
- /**
2219
- * - UPI ID.
2220
- */
2221
- upi_vpa: string;
2222
- /**
2223
- * - Aggregator slug.
2224
- */
2225
- aggregator?: string;
2226
- };
2227
- /** @returns {ValidateUPI} */
2228
- declare function ValidateUPI(): ValidateUPI;
2229
- type ValidateUPI = {
2230
- /**
2231
- * - VALID or INVALID.
2232
- */
2233
- status: string;
2234
- /**
2235
- * - Customer Bank.
2236
- */
2237
- customer_name: string;
2238
- /**
2239
- * - Boolean is true or false.
2240
- */
2241
- is_valid: boolean;
2242
- /**
2243
- * - UPI ID.
2244
- */
2245
- upi_vpa: string;
2246
- };
2247
- /** @returns {ValidateVPADetails} */
2248
- declare function ValidateVPADetails(): ValidateVPADetails;
2249
- type ValidateVPADetails = {
2250
- data: ValidateUPI;
2251
- /**
2252
- * - Response is successful or not.
2253
- */
2254
- success: boolean;
2255
- };
2256
- /** @returns {CardDetails} */
2257
- declare function CardDetails(): CardDetails;
2258
- type CardDetails = {
2259
- /**
2260
- * - Current status of the card.
2261
- */
2262
- status: boolean;
2263
- /**
2264
- * - Country where the card was issued.
2265
- */
2266
- country: string;
2267
- /**
2268
- * - Code identifying the bank.
2269
- */
2270
- bank_code: string;
2271
- /**
2272
- * - Unique identifier for the record.
2273
- */
2274
- id: string;
2275
- /**
2276
- * - Card's expiration year.
2277
- */
2278
- card_exp_year?: string;
2279
- /**
2280
- * - Brand of the card (e.g., Visa, MasterCard).
2281
- */
2282
- card_brand: string;
2283
- /**
2284
- * - General type of the card (e.g., debit, credit).
2285
- */
2286
- type: string;
2287
- /**
2288
- * - Sub-type of the card (e.g., Platinum, Gold).
2289
- */
2290
- card_sub_type: string;
2291
- /**
2292
- * - Indicates whether the card is domestic.
2293
- */
2294
- is_domestic_card: boolean;
2295
- /**
2296
- * - Name of the cardholder.
2297
- */
2298
- name_on_card?: string;
2299
- /**
2300
- * - Card's expiration month.
2301
- */
2302
- card_exp_month?: string;
2303
- /**
2304
- * - Extended type of the card, providing
2305
- * more specific classification.
2306
- */
2307
- extended_card_type: string;
2308
- /**
2309
- * - Object representation of the card.
2310
- */
2311
- card_object: string;
2312
- /**
2313
- * - Encrypted token representing the card.
2314
- */
2315
- card_token?: string;
2316
- /**
2317
- * - User associated with the card.
2318
- */
2319
- user?: string;
2320
- /**
2321
- * - Bank associated with the card.
2322
- */
2323
- bank: string;
2324
- };
2325
- /** @returns {CardDetailsFetchedDetails} */
2326
- declare function CardDetailsFetchedDetails(): CardDetailsFetchedDetails;
2327
- type CardDetailsFetchedDetails = {
2328
- data: CardDetails;
2329
- /**
2330
- * - Response is successful or not.
2331
- */
2332
- success: boolean;
2333
- };
2334
- /** @returns {TransferItemsDetails} */
2335
- declare function TransferItemsDetails(): TransferItemsDetails;
2336
- type TransferItemsDetails = {
2337
- /**
2338
- * - Id of the transfer item.
2339
- */
2340
- id: number;
2341
- /**
2342
- * - Beneficiary Display Name.
2343
- */
2344
- display_name?: string;
2345
- /**
2346
- * - Beneficiary large Logo.
2347
- */
2348
- logo_large: string;
2349
- /**
2350
- * - Beneficiary small Logo.
2351
- */
2352
- logo_small: string;
2353
- /**
2354
- * - Beneficiary Name.
2355
- */
2356
- name: string;
2357
- };
2358
- /** @returns {TransferModeDetails} */
2359
- declare function TransferModeDetails(): TransferModeDetails;
2360
- type TransferModeDetails = {
2361
- /**
2362
- * - Beneficiary Mode Items.
2363
- */
2364
- items?: TransferItemsDetails[];
2365
- /**
2366
- * - Beneficiary Mode Name.
2367
- */
2368
- display_name: string;
2369
- };
2370
- /** @returns {TransferModeFetchDetails} */
2371
- declare function TransferModeFetchDetails(): TransferModeFetchDetails;
2372
- type TransferModeFetchDetails = {
2373
- /**
2374
- * - Response Object.
2375
- */
2376
- data: TransferModeDetails[];
2377
- };
2378
- /** @returns {UpdateRefundTransferMode} */
2379
- declare function UpdateRefundTransferMode(): UpdateRefundTransferMode;
2380
- type UpdateRefundTransferMode = {
2381
- /**
2382
- * - True for enabling the Transfer Mode.
2383
- */
2384
- enable: boolean;
2385
- /**
2386
- * - Transfer Mode of the Beneficiary to be added.
2387
- */
2388
- transfer_mode: string;
2389
- };
2390
- /** @returns {RefundTransferModeUpdateDetails} */
2391
- declare function RefundTransferModeUpdateDetails(): RefundTransferModeUpdateDetails;
2392
- type RefundTransferModeUpdateDetails = {
2393
- /**
2394
- * - Response is successful or not.
2395
- */
2396
- success?: boolean;
2397
- };
2398
- /** @returns {OrderBeneficiaryDetails} */
2399
- declare function OrderBeneficiaryDetails(): OrderBeneficiaryDetails;
2400
- type OrderBeneficiaryDetails = {
2401
- /**
2402
- * - Modification Date of Beneficiary.
2403
- */
2404
- modified_on: string;
2405
- /**
2406
- * - Account Number.
2407
- */
2408
- account_no: string;
2409
- /**
2410
- * - MObile no of User.
2411
- */
2412
- mobile?: string;
2413
- /**
2414
- * - Bank Name Of Account.
2415
- */
2416
- bank_name: string;
2417
- /**
2418
- * - Ifsc Code Of Account.
2419
- */
2420
- ifsc_code: string;
2421
- /**
2422
- * - Boolean Flag whether Beneficiary set or not.
2423
- */
2424
- is_active: boolean;
2425
- /**
2426
- * - Beneficiary Id.
2427
- */
2428
- beneficiary_id: string;
2429
- /**
2430
- * - Account Holder Name.
2431
- */
2432
- account_holder: string;
2433
- /**
2434
- * - EMail of User.
2435
- */
2436
- email: string;
2437
- /**
2438
- * - User Id Who filled the Beneficiary.
2439
- */
2440
- delights_user_name?: string;
2441
- /**
2442
- * - Id of the Order Beneficiary.
2443
- */
2444
- id: number;
2445
- /**
2446
- * - Transfer Mode Of Account.
2447
- */
2448
- transfer_mode: string;
2449
- /**
2450
- * - Branch Name Of Account.
2451
- */
2452
- branch_name?: string;
2453
- /**
2454
- * - Creation Date of Beneficiary.
2455
- */
2456
- created_on: string;
2457
- /**
2458
- * - SHort Title Of Account.
2459
- */
2460
- subtitle: string;
2461
- /**
2462
- * - Remarks.
2463
- */
2464
- comment?: string;
2465
- /**
2466
- * - Address of User.
2467
- */
2468
- address: string;
2469
- /**
2470
- * - Title Of Account.
2471
- */
2472
- title: string;
2473
- /**
2474
- * - Display Name Of Account.
2475
- */
2476
- display_name: string;
2477
- };
2478
- /** @returns {OrderBeneficiaryFetchDetails} */
2479
- declare function OrderBeneficiaryFetchDetails(): OrderBeneficiaryFetchDetails;
2480
- type OrderBeneficiaryFetchDetails = {
2481
- /**
2482
- * - Show beneficiary details or not.
2483
- */
2484
- show_beneficiary_details?: boolean;
2485
- /**
2486
- * - All Beneficiaries Of An Order.
2487
- */
2488
- beneficiaries?: OrderBeneficiaryDetails[];
2489
- };
2490
- /** @returns {NotFoundResourceError} */
2491
- declare function NotFoundResourceError(): NotFoundResourceError;
2492
- type NotFoundResourceError = {
2493
- /**
2494
- * - Bad Request Data.
2495
- */
2496
- code: string;
2497
- /**
2498
- * - Not Found.
2499
- */
2500
- description: string;
2501
- /**
2502
- * - Response is successful or not.
2503
- */
2504
- success: boolean;
2505
- };
2506
- /** @returns {IfscCodeDetails} */
2507
- declare function IfscCodeDetails(): IfscCodeDetails;
2508
- type IfscCodeDetails = {
2509
- /**
2510
- * - Branch Name Of Account.
2511
- */
2512
- branch_name: string;
2513
- /**
2514
- * - Response is successful or not.
2515
- */
2516
- success?: boolean;
2517
- /**
2518
- * - Bank Name Of Account.
2519
- */
2520
- bank_name: string;
2521
- };
2522
- /** @returns {ErrorCodeDescription} */
2523
- declare function ErrorCodeDescription(): ErrorCodeDescription;
2524
- type ErrorCodeDescription = {
2525
- /**
2526
- * - Error description code.
2527
- */
2528
- code: string;
2529
- /**
2530
- * - Error human understandable description.
2531
- */
2532
- description: string;
2533
- /**
2534
- * - Response is successful or not.
2535
- */
2536
- success: boolean;
2537
- };
2538
- /** @returns {AddBeneficiaryViaOtpVerification} */
2539
- declare function AddBeneficiaryViaOtpVerification(): AddBeneficiaryViaOtpVerification;
2540
- type AddBeneficiaryViaOtpVerification = {
2541
- /**
2542
- * - Request id.
2543
- */
2544
- request_id: string;
2545
- /**
2546
- * - Hash key of the beneficiary Id.
2547
- */
2548
- hash_key: string;
2549
- /**
2550
- * - Otp sent to the given Mobile No.
2551
- */
2552
- otp: string;
2553
- };
2554
- /** @returns {AddBeneficiaryViaOtpVerificationDetails} */
2555
- declare function AddBeneficiaryViaOtpVerificationDetails(): AddBeneficiaryViaOtpVerificationDetails;
2556
- type AddBeneficiaryViaOtpVerificationDetails = {
2557
- /**
2558
- * - Response is successful or not.
2559
- */
2560
- success?: boolean;
2561
- /**
2562
- * - Aggregator Response of beneficiary.
2563
- */
2564
- message: string;
2565
- };
2566
- /** @returns {WrongOtpError} */
2567
- declare function WrongOtpError(): WrongOtpError;
2568
- type WrongOtpError = {
2569
- /**
2570
- * - Verified flag.
2571
- */
2572
- is_verified_flag: boolean;
2573
- /**
2574
- * - Wrong OTP Code.
2575
- */
2576
- description: string;
2577
- /**
2578
- * - Response is successful or not.
2579
- */
2580
- success: string;
2581
- };
2582
- /** @returns {BeneficiaryModeDetails} */
2583
- declare function BeneficiaryModeDetails(): BeneficiaryModeDetails;
2584
- type BeneficiaryModeDetails = {
2585
- /**
2586
- * - Account Number of the Account Holder.
2587
- */
2588
- account_no: string;
2589
- /**
2590
- * - Address of the User.
2591
- */
2592
- address?: string;
2593
- /**
2594
- * - Mobile Number of the User.
2595
- */
2596
- mobile: string;
2597
- /**
2598
- * - Bank Name of the Account.
2599
- */
2600
- bank_name: string;
2601
- /**
2602
- * - Remarks added by The user.
2603
- */
2604
- comment?: string;
2605
- /**
2606
- * - Ifsc Code of the Account.
2607
- */
2608
- ifsc_code: string;
2609
- /**
2610
- * - VPA of the Account.
2611
- */
2612
- vpa?: string;
2613
- /**
2614
- * - Branch Name of the Account.
2615
- */
2616
- branch_name: string;
2617
- /**
2618
- * - Name of the Account Holder.
2619
- */
2620
- account_holder: string;
2621
- /**
2622
- * - Wallet of the Account.
2623
- */
2624
- wallet?: string;
2625
- /**
2626
- * - Email of the Account Holder.
2627
- */
2628
- email: string;
2629
- };
2630
- /** @returns {AddBeneficiaryDetails} */
2631
- declare function AddBeneficiaryDetails(): AddBeneficiaryDetails;
2632
- type AddBeneficiaryDetails = {
2633
- /**
2634
- * - True if beneficiary to be added by delights or
2635
- * False if by User.
2636
- */
2637
- delights: boolean;
2638
- /**
2639
- * - Shipment Id of the respective Merchant Order Id.
2640
- */
2641
- shipment_id: string;
2642
- details: BeneficiaryModeDetails;
2643
- /**
2644
- * - OTP received by customer.
2645
- */
2646
- otp?: string;
2647
- /**
2648
- * - Merchant Order Id.
2649
- */
2650
- order_id: string;
2651
- /**
2652
- * - Transfer Mode of the Beneficiary to be added.
2653
- */
2654
- transfer_mode: string;
2655
- /**
2656
- * - Request Id for add benificiary request.
2657
- */
2658
- request_id?: string;
2659
- };
2660
- /** @returns {RefundAccountDetails} */
2661
- declare function RefundAccountDetails(): RefundAccountDetails;
2662
- type RefundAccountDetails = {
2663
- /**
2664
- * - Flag for verification of refund.
2665
- */
2666
- is_verified_flag?: boolean;
2667
- /**
2668
- * - Refund account data.
2669
- */
2670
- data?: any;
2671
- /**
2672
- * - Success or failure flag.
2673
- */
2674
- success: boolean;
2675
- /**
2676
- * - Response message.
2677
- */
2678
- message: string;
2679
- };
2680
- /** @returns {BankDetailsForOTP} */
2681
- declare function BankDetailsForOTP(): BankDetailsForOTP;
2682
- type BankDetailsForOTP = {
2683
- /**
2684
- * - Account number of the holder.
2685
- */
2686
- account_no: string;
2687
- /**
2688
- * - Name of the bank.
2689
- */
2690
- bank_name: string;
2691
- /**
2692
- * - IFSC code of the bank.
2693
- */
2694
- ifsc_code: string;
2695
- /**
2696
- * - Branch name of the bank.
2697
- */
2698
- branch_name: string;
2699
- /**
2700
- * - Name of the account holder.
2701
- */
2702
- account_holder: string;
2703
- };
2704
- /** @returns {AddBeneficiaryDetailsOTP} */
2705
- declare function AddBeneficiaryDetailsOTP(): AddBeneficiaryDetailsOTP;
2706
- type AddBeneficiaryDetailsOTP = {
2707
- /**
2708
- * - Unique identifier for an order.
2709
- */
2710
- order_id: string;
2711
- details: BankDetailsForOTP;
2712
- };
2713
- /** @returns {WalletOtp} */
2714
- declare function WalletOtp(): WalletOtp;
2715
- type WalletOtp = {
2716
- /**
2717
- * - Country Code of the Mobile Number.
2718
- */
2719
- country_code: string;
2720
- /**
2721
- * - Wallet Mobile Number of the User.
2722
- */
2723
- mobile: string;
2724
- };
2725
- /** @returns {WalletOtpDetails} */
2726
- declare function WalletOtpDetails(): WalletOtpDetails;
2727
- type WalletOtpDetails = {
2728
- /**
2729
- * - Request Id for wallet otp request.
2730
- */
2731
- request_id: string;
2732
- /**
2733
- * - Boolean Flag whether OTP Validation is
2734
- * already done or not.
2735
- */
2736
- is_verified_flag: string;
2737
- /**
2738
- * - Response is successful or not.
2739
- */
2740
- success?: boolean;
2741
- };
2742
- /** @returns {SetDefaultBeneficiary} */
2743
- declare function SetDefaultBeneficiary(): SetDefaultBeneficiary;
2744
- type SetDefaultBeneficiary = {
2745
- /**
2746
- * - Merchant Order Id.
2747
- */
2748
- order_id: string;
2749
- /**
2750
- * - Beneficiary Hash Id of the beneficiary added.
2751
- */
2752
- beneficiary_id: string;
2753
- };
2754
- /** @returns {SetDefaultBeneficiaryDetails} */
2755
- declare function SetDefaultBeneficiaryDetails(): SetDefaultBeneficiaryDetails;
2756
- type SetDefaultBeneficiaryDetails = {
2757
- /**
2758
- * - Boolean Flag whether Beneficiary set or not.
2759
- */
2760
- is_beneficiary_set: boolean;
2761
- /**
2762
- * - Response is successful or not.
2763
- */
2764
- success?: boolean;
2765
- };
2766
- /** @returns {GetPaymentLinkDetails} */
2767
- declare function GetPaymentLinkDetails(): GetPaymentLinkDetails;
2768
- type GetPaymentLinkDetails = {
2769
- /**
2770
- * - HTTP status code.
2771
- */
2772
- status_code: number;
2773
- /**
2774
- * - Status of payment link.
2775
- */
2776
- payment_link_current_status?: string;
2777
- /**
2778
- * - Successful or failure.
2779
- */
2780
- success: boolean;
2781
- /**
2782
- * - Polling request timeout.
2783
- */
2784
- polling_timeout?: number;
2785
- /**
2786
- * - Url of payment link.
2787
- */
2788
- payment_link_url?: string;
2789
- /**
2790
- * - Merchant order id.
2791
- */
2792
- external_order_id?: string;
2793
- /**
2794
- * - Detailed message.
2795
- */
2796
- message: string;
2797
- /**
2798
- * - Merchant name.
2799
- */
2800
- merchant_name?: string;
2801
- /**
2802
- * - Total value of order.
2803
- */
2804
- amount?: number;
2805
- };
2806
- /** @returns {ErrorDescription} */
2807
- declare function ErrorDescription(): ErrorDescription;
2808
- type ErrorDescription = {
2809
- /**
2810
- * - Payment transaction id.
2811
- */
2812
- payment_transaction_id?: string;
2813
- /**
2814
- * - Payment link expired or not.
2815
- */
2816
- expired?: boolean;
2817
- /**
2818
- * - Merchant Order Id.
2819
- */
2820
- merchant_order_id?: string;
2821
- /**
2822
- * - Name of merchant that created payment link.
2823
- */
2824
- merchant_name?: string;
2825
- /**
2826
- * - Detailed message.
2827
- */
2828
- msg?: string;
2829
- /**
2830
- * - Payment link is cancelled or not.
2831
- */
2832
- cancelled?: boolean;
2833
- /**
2834
- * - Amount paid.
2835
- */
2836
- amount?: number;
2837
- /**
2838
- * - Payment link id is valid or not.
2839
- */
2840
- invalid_id?: boolean;
2841
- };
2842
- /** @returns {ErrorDetails} */
2843
- declare function ErrorDetails(): ErrorDetails;
2844
- type ErrorDetails = {
2845
- /**
2846
- * - HTTP status code.
2847
- */
2848
- status_code: number;
2849
- error?: ErrorDescription;
2850
- /**
2851
- * - Detailed message.
2852
- */
2853
- message: string;
2854
- /**
2855
- * - Successful or failure.
2856
- */
2857
- success: boolean;
2858
- };
2859
- /** @returns {CreatePaymentLinkMeta} */
2860
- declare function CreatePaymentLinkMeta(): CreatePaymentLinkMeta;
2861
- type CreatePaymentLinkMeta = {
2862
- /**
2863
- * - Unique identifier for the shopping cart.
2864
- */
2865
- cart_id: string;
2866
- /**
2867
- * - Mode of checkout process (e.g., guest,
2868
- * registered user).
2869
- */
2870
- checkout_mode: string;
2871
- /**
2872
- * - Identifier for the card assigned to the
2873
- * transaction.
2874
- */
2875
- assign_card_id?: string;
2876
- /**
2877
- * - Total amount for the transaction.
2878
- */
2879
- amount: string;
2880
- };
2881
- /** @returns {CreatePaymentLink} */
2882
- declare function CreatePaymentLink(): CreatePaymentLink;
2883
- type CreatePaymentLink = {
2884
- /**
2885
- * - Merchant order id.
2886
- */
2887
- description?: string;
2888
- /**
2889
- * - Merchant order id.
2890
- */
2891
- external_order_id: string;
2892
- /**
2893
- * - Mobile number to which the payment link is
2894
- * to be sent.
2895
- */
2896
- mobile_number: string;
2897
- /**
2898
- * - Total value of order.
2899
- */
2900
- amount: number;
2901
- meta: CreatePaymentLinkMeta;
2902
- /**
2903
- * - Email to which the payment link is to be sent.
2904
- */
2905
- email: string;
2906
- /**
2907
- * - URL to which the user will be
2908
- * redirected after a successful payment.
2909
- */
2910
- success_redirection_url?: string;
2911
- /**
2912
- * - URL to which the user will be
2913
- * redirected if the payment fails.
2914
- */
2915
- failure_redirection_url?: string;
2916
- };
2917
- /** @returns {CreatePaymentLinkDetails} */
2918
- declare function CreatePaymentLinkDetails(): CreatePaymentLinkDetails;
2919
- type CreatePaymentLinkDetails = {
2920
- /**
2921
- * - HTTP status code.
2922
- */
2923
- status_code: number;
2924
- /**
2925
- * - Successful or failure.
2926
- */
2927
- success: boolean;
2928
- /**
2929
- * - Polling request timeout.
2930
- */
2931
- polling_timeout?: number;
2932
- /**
2933
- * - Url of payment link.
2934
- */
2935
- payment_link_url?: string;
2936
- /**
2937
- * - Detailed message.
2938
- */
2939
- message: string;
2940
- /**
2941
- * - Unique id of payment link.
2942
- */
2943
- payment_link_id?: string;
2944
- };
2945
- /** @returns {CancelOrResendPaymentLink} */
2946
- declare function CancelOrResendPaymentLink(): CancelOrResendPaymentLink;
2947
- type CancelOrResendPaymentLink = {
2948
- /**
2949
- * - Unique id of payment link.
2950
- */
2951
- payment_link_id: string;
2952
- };
2953
- /** @returns {ResendPaymentLinkDetails} */
2954
- declare function ResendPaymentLinkDetails(): ResendPaymentLinkDetails;
2955
- type ResendPaymentLinkDetails = {
2956
- /**
2957
- * - HTTP status code.
2958
- */
2959
- status_code: number;
2960
- /**
2961
- * - Polling request timeout.
2962
- */
2963
- polling_timeout?: number;
2964
- /**
2965
- * - Successful or failure.
2966
- */
2967
- success: boolean;
2968
- /**
2969
- * - Detailed message.
2970
- */
2971
- message: string;
2972
- };
2973
- /** @returns {CancelPaymentLinkDetails} */
2974
- declare function CancelPaymentLinkDetails(): CancelPaymentLinkDetails;
2975
- type CancelPaymentLinkDetails = {
2976
- /**
2977
- * - HTTP status code.
2978
- */
2979
- status_code: number;
2980
- /**
2981
- * - Successful or failure.
2982
- */
2983
- success: boolean;
2984
- /**
2985
- * - Detailed message.
2986
- */
2987
- message: string;
2988
- };
2989
- /** @returns {PollingPaymentLinkDetails} */
2990
- declare function PollingPaymentLinkDetails(): PollingPaymentLinkDetails;
2991
- type PollingPaymentLinkDetails = {
2992
- /**
2993
- * - Status of payment link.
2994
- */
2995
- status?: string;
2996
- /**
2997
- * - HTTP status code.
2998
- */
2999
- status_code?: number;
3000
- /**
3001
- * - Successful or failure.
3002
- */
3003
- success?: boolean;
3004
- /**
3005
- * - HTTP status code.
3006
- */
3007
- http_status?: number;
3008
- /**
3009
- * - Detailed message.
3010
- */
3011
- message?: string;
3012
- /**
3013
- * - Fynd order id.
3014
- */
3015
- order_id?: string;
3016
- /**
3017
- * - Url to redirect to.
3018
- */
3019
- redirect_url?: string;
3020
- /**
3021
- * - Payment link id.
3022
- */
3023
- payment_link_id?: string;
3024
- /**
3025
- * - Aggregator name.
3026
- */
3027
- aggregator_name?: string;
3028
- /**
3029
- * - Total amount for the transaction.
3030
- */
3031
- amount?: number;
3032
- };
3033
- /** @returns {PaymentMethodsMeta} */
3034
- declare function PaymentMethodsMeta(): PaymentMethodsMeta;
3035
- type PaymentMethodsMeta = {
3036
- /**
3037
- * - Merchant code.
3038
- */
3039
- merchant_code: string;
3040
- /**
3041
- * - Payment gateway name.
3042
- */
3043
- payment_gateway: string;
3044
- /**
3045
- * - Payment identifier.
3046
- */
3047
- payment_identifier: string;
3048
- };
3049
- /** @returns {CreateOrderUserPaymentMethods} */
3050
- declare function CreateOrderUserPaymentMethods(): CreateOrderUserPaymentMethods;
3051
- type CreateOrderUserPaymentMethods = {
3052
- /**
3053
- * - Payment mode name.
3054
- */
3055
- name: string;
3056
- /**
3057
- * - Payment mode.
3058
- */
3059
- mode: string;
3060
- meta: PaymentMethodsMeta;
3061
- };
3062
- /** @returns {CreateOrderUser} */
3063
- declare function CreateOrderUser(): CreateOrderUser;
3064
- type CreateOrderUser = {
3065
- /**
3066
- * - Currency of the transaction.
3067
- */
3068
- currency: string;
3069
- /**
3070
- * - Unique id of payment link.
3071
- */
3072
- payment_link_id: string;
3073
- payment_methods: CreateOrderUserPaymentMethods;
3074
- /**
3075
- * - Meta details.
3076
- */
3077
- meta?: any;
3078
- };
3079
- /** @returns {CreateOrderUserData} */
3080
- declare function CreateOrderUserData(): CreateOrderUserData;
3081
- type CreateOrderUserData = {
3082
- /**
3083
- * - Method details.
3084
- */
3085
- method?: string;
3086
- /**
3087
- * - Aggregator name.
3088
- */
3089
- aggregator?: string;
3090
- /**
3091
- * - Aggregator customer id.
3092
- */
3093
- customer_id?: string;
3094
- /**
3095
- * - Mobile number.
3096
- */
3097
- contact?: string;
3098
- /**
3099
- * - Merchant order id.
3100
- */
3101
- merchant_order_id?: string;
3102
- /**
3103
- * - Aggregator order id.
3104
- */
3105
- order_id?: string;
3106
- /**
3107
- * - Currency of the transaction.
3108
- */
3109
- currency?: string;
3110
- /**
3111
- * - Callback url for aggregator.
3112
- */
3113
- callback_url?: string;
3114
- /**
3115
- * - Total amount for the transaction.
3116
- */
3117
- amount?: number;
3118
- /**
3119
- * - Email.
3120
- */
3121
- email?: string;
3122
- };
3123
- /** @returns {CreateOrderUserDetails} */
3124
- declare function CreateOrderUserDetails(): CreateOrderUserDetails;
3125
- type CreateOrderUserDetails = {
3126
- /**
3127
- * - HTTP status code.
3128
- */
3129
- status_code: number;
3130
- /**
3131
- * - Successful or failure.
3132
- */
3133
- success: boolean;
3134
- data?: CreateOrderUserData;
3135
- /**
3136
- * - Detailed message.
3137
- */
3138
- message: string;
3139
- /**
3140
- * - Merchant order id.
3141
- */
3142
- order_id?: string;
3143
- /**
3144
- * - Callback url for aggregator.
3145
- */
3146
- callback_url?: string;
3147
- /**
3148
- * - Payment confirm url for aggregator.
3149
- */
3150
- payment_confirm_url?: string;
3151
- };
3152
- /** @returns {BalanceDetails} */
3153
- declare function BalanceDetails(): BalanceDetails;
3154
- type BalanceDetails = {
3155
- /**
3156
- * - Formatted Amount with currency symbol.
3157
- */
3158
- formatted_value?: string;
3159
- /**
3160
- * - Currency Code.
3161
- */
3162
- currency?: string;
3163
- /**
3164
- * - Payment amount.
3165
- */
3166
- value?: number;
3167
- };
3168
- /** @returns {CreditSummary} */
3169
- declare function CreditSummary(): CreditSummary;
3170
- type CreditSummary = {
3171
- total_due_amount?: BalanceDetails;
3172
- /**
3173
- * - Customer Credit status.
3174
- */
3175
- status?: string;
3176
- limit?: BalanceDetails;
3177
- /**
3178
- * - ID at Credit aggregator end.
3179
- */
3180
- credit_line_id?: string;
3181
- amount_available?: BalanceDetails;
3182
- due_amount?: BalanceDetails;
3183
- /**
3184
- * - Due date for repayment.
3185
- */
3186
- due_date?: string;
3187
- balance?: BalanceDetails;
3188
- /**
3189
- * - Message to customer.
3190
- */
3191
- status_message?: string;
3192
- /**
3193
- * - Url for repayment.
3194
- */
3195
- repayment_url?: string;
3196
- /**
3197
- * - Statement of accounts. Show payment history.
3198
- */
3199
- soa_url?: string;
3200
- /**
3201
- * - Eligibility flag to complete transaction.
3202
- */
3203
- is_eligible_for_txn?: boolean;
3204
- /**
3205
- * - Unique aggregator customer id.
3206
- */
3207
- merchant_customer_ref_id?: string;
3208
- /**
3209
- * - Status from Credit aggregator end.
3210
- */
3211
- buyer_status?: string;
3212
- /**
3213
- * - Url for activation.
3214
- */
3215
- activation_url?: string;
3216
- };
3217
- /** @returns {CustomerCreditSummaryDetails} */
3218
- declare function CustomerCreditSummaryDetails(): CustomerCreditSummaryDetails;
3219
- type CustomerCreditSummaryDetails = {
3220
- data?: CreditSummary;
3221
- /**
3222
- * - Payment confirmation updated or not.
3223
- */
3224
- success: boolean;
3225
- };
3226
- /** @returns {RedirectURL} */
3227
- declare function RedirectURL(): RedirectURL;
3228
- type RedirectURL = {
3229
- /**
3230
- * - Aggregator Operation is successful or not.
3231
- */
3232
- status: boolean;
3233
- /**
3234
- * - URL to which the user may redirect.
3235
- */
3236
- signup_url: string;
3237
- };
3238
- /** @returns {RedirectToAggregatorDetails} */
3239
- declare function RedirectToAggregatorDetails(): RedirectToAggregatorDetails;
3240
- type RedirectToAggregatorDetails = {
3241
- data: RedirectURL;
3242
- /**
3243
- * - Status updated or not.
3244
- */
3245
- success: boolean;
3246
- };
3247
- /** @returns {CreditDetail} */
3248
- declare function CreditDetail(): CreditDetail;
3249
- type CreditDetail = {
3250
- /**
3251
- * - Operation is successful or not.
3252
- */
3253
- status: boolean;
3254
- /**
3255
- * - User is registered with aggregator or not.
3256
- */
3257
- is_registered: boolean;
3258
- /**
3259
- * - URL to which the user may redirect.
3260
- */
3261
- signup_url: string;
3262
- };
3263
- /** @returns {CheckCreditDetails} */
3264
- declare function CheckCreditDetails(): CheckCreditDetails;
3265
- type CheckCreditDetails = {
3266
- data: CreditDetail;
3267
- /**
3268
- * - Operation is successful or not.
3269
- */
3270
- success: boolean;
3271
- };
3272
- /** @returns {KYCAddress} */
3273
- declare function KYCAddress(): KYCAddress;
3274
- type KYCAddress = {
3275
- /**
3276
- * - City of the KYC address.
3277
- */
3278
- city: string;
3279
- /**
3280
- * - Second line of the address.
3281
- */
3282
- addressline2?: string;
3283
- /**
3284
- * - State of the KYC address.
3285
- */
3286
- state: string;
3287
- /**
3288
- * - Type of ownership for the address
3289
- * (e.g., rented, owned).
3290
- */
3291
- ownership_type?: string;
3292
- /**
3293
- * - Postal code of the address.
3294
- */
3295
- pincode: string;
3296
- /**
3297
- * - Landmark near the address.
3298
- */
3299
- land_mark?: string;
3300
- /**
3301
- * - First line of the address.
3302
- */
3303
- addressline1: string;
3304
- };
3305
- /** @returns {UserPersonalInfoInDetails} */
3306
- declare function UserPersonalInfoInDetails(): UserPersonalInfoInDetails;
3307
- type UserPersonalInfoInDetails = {
3308
- /**
3309
- * - First name of the individual.
3310
- */
3311
- first_name: string;
3312
- /**
3313
- * - Voter ID number.
3314
- */
3315
- voter_id?: string;
3316
- /**
3317
- * - Gender of the individual.
3318
- */
3319
- gender?: string;
3320
- /**
3321
- * - Date of birth of the individual.
3322
- */
3323
- dob: string;
3324
- /**
3325
- * - Passport number.
3326
- */
3327
- passport?: string;
3328
- /**
3329
- * - Father's name.
3330
- */
3331
- fathers_name?: string;
3332
- /**
3333
- * - Mother's name.
3334
- */
3335
- mothers_name?: string;
3336
- /**
3337
- * - Middle name of the individual.
3338
- */
3339
- middle_name?: string;
3340
- /**
3341
- * - Last name of the individual.
3342
- */
3343
- last_name?: string;
3344
- /**
3345
- * - Permanent Account Number (PAN).
3346
- */
3347
- pan?: string;
3348
- /**
3349
- * - Driving license number.
3350
- */
3351
- driving_license?: string;
3352
- /**
3353
- * - Indicates whether the email is verified.
3354
- */
3355
- email_verified: boolean;
3356
- address_as_per_id: KYCAddress;
3357
- /**
3358
- * - Indicates whether the mobile number is verified.
3359
- */
3360
- mobile_verified: boolean;
3361
- /**
3362
- * - Phone number.
3363
- */
3364
- phone: string;
3365
- /**
3366
- * - Email address.
3367
- */
3368
- email?: string;
3369
- };
3370
- /** @returns {MarketplaceInfo} */
3371
- declare function MarketplaceInfo(): MarketplaceInfo;
3372
- type MarketplaceInfo = {
3373
- /**
3374
- * - Date of joining.
3375
- */
3376
- date_of_joining?: string;
3377
- /**
3378
- * - Name of store.
3379
- */
3380
- name: string;
3381
- /**
3382
- * - Merchant id.
3383
- */
3384
- membership_id: string;
3385
- };
3386
- /** @returns {BusinessDetails} */
3387
- declare function BusinessDetails(): BusinessDetails;
3388
- type BusinessDetails = {
3389
- /**
3390
- * - Type of business ownership
3391
- * (e.g., sole proprietorship, partnership).
3392
- */
3393
- business_ownership_type?: string;
3394
- /**
3395
- * - Age or duration of the business.
3396
- */
3397
- vintage?: string;
3398
- /**
3399
- * - Goods and Services Tax Identification Number.
3400
- */
3401
- gstin?: string;
3402
- /**
3403
- * - Permanent Account Number of the business.
3404
- */
3405
- pan?: string;
3406
- /**
3407
- * - Type of legal entity (e.g., corporation, LLC).
3408
- */
3409
- entity_type?: string;
3410
- /**
3411
- * - Shop and Establishment
3412
- * registration details.
3413
- */
3414
- shop_and_establishment?: any;
3415
- /**
3416
- * - Food Safety and Standards Authority of India
3417
- * registration number.
3418
- */
3419
- fssai?: string;
3420
- /**
3421
- * - Food and Drug Administration registration number.
3422
- */
3423
- fda?: string;
3424
- /**
3425
- * - Type of business (e.g., retail, wholesale).
3426
- */
3427
- business_type?: string;
3428
- /**
3429
- * - Name of the business.
3430
- */
3431
- name?: string;
3432
- address?: KYCAddress;
3433
- };
3434
- /** @returns {DeviceDetails} */
3435
- declare function DeviceDetails(): DeviceDetails;
3436
- type DeviceDetails = {
3437
- /**
3438
- * - IP.
3439
- */
3440
- identification_number?: string;
3441
- /**
3442
- * - Static value = ip.
3443
- */
3444
- identifier_type?: string;
3445
- /**
3446
- * - Device Model.
3447
- */
3448
- device_model?: string;
3449
- /**
3450
- * - Device maker.
3451
- */
3452
- device_make?: string;
3453
- /**
3454
- * - Device Type(E.g. Mobile).
3455
- */
3456
- device_type?: string;
3457
- /**
3458
- * - OS Name.
3459
- */
3460
- os?: string;
3461
- /**
3462
- * - OS Version.
3463
- */
3464
- os_version?: string;
3465
- };
3466
- /** @returns {CustomerOnboarding} */
3467
- declare function CustomerOnboarding(): CustomerOnboarding;
3468
- type CustomerOnboarding = {
3469
- personal_info?: UserPersonalInfoInDetails;
3470
- /**
3471
- * - Merchant Category Code, indicating the type of business.
3472
- */
3473
- mcc?: string;
3474
- /**
3475
- * - Payment aggregator handling the transaction.
3476
- */
3477
- aggregator: string;
3478
- marketplace_info?: MarketplaceInfo;
3479
- /**
3480
- * - Callback url.
3481
- */
3482
- source: string;
3483
- business_info?: BusinessDetails;
3484
- device?: DeviceDetails;
3485
- };
3486
- /** @returns {OnboardSummary} */
3487
- declare function OnboardSummary(): OnboardSummary;
3488
- type OnboardSummary = {
3489
- /**
3490
- * - URL to which the user may redirect.
3491
- */
3492
- redirect_url?: string;
3493
- /**
3494
- * - User Session.
3495
- */
3496
- session?: any;
3497
- /**
3498
- * - Transaction status.
3499
- */
3500
- status: boolean;
3501
- /**
3502
- * - Description of status.
3503
- */
3504
- status_remark?: string;
3505
- /**
3506
- * - Whether is eligible for transaction.
3507
- */
3508
- is_eligible_for_txn?: boolean;
3509
- /**
3510
- * - Rupifi customer ID.
3511
- */
3512
- merchant_customer_ref_id?: string;
3513
- /**
3514
- * - Url for activation.
3515
- */
3516
- activation_url?: string;
3517
- };
3518
- /** @returns {CustomerOnboardingDetails} */
3519
- declare function CustomerOnboardingDetails(): CustomerOnboardingDetails;
3520
- type CustomerOnboardingDetails = {
3521
- data: OnboardSummary;
3522
- /**
3523
- * - Status updated or not.
3524
- */
3525
- success: boolean;
3526
- };
3527
- /** @returns {OutstandingOrderDetails} */
3528
- declare function OutstandingOrderDetails(): OutstandingOrderDetails;
3529
- type OutstandingOrderDetails = {
3530
- /**
3531
- * - HTTP status code.
3532
- */
3533
- status_code: number;
3534
- /**
3535
- * - Dict containing the outstanding order details.
3536
- */
3537
- data?: any[];
3538
- /**
3539
- * - Response is successful or not.
3540
- */
3541
- success: boolean;
3542
- /**
3543
- * - Message.
3544
- */
3545
- message?: string;
3546
- };
3547
- /** @returns {PaidOrderDetails} */
3548
- declare function PaidOrderDetails(): PaidOrderDetails;
3549
- type PaidOrderDetails = {
3550
- /**
3551
- * - HTTP status code.
3552
- */
3553
- status_code: number;
3554
- /**
3555
- * - Dict containing the paid order details.
3556
- */
3557
- data?: any[];
3558
- /**
3559
- * - Response is successful or not.
3560
- */
3561
- success: boolean;
3562
- /**
3563
- * - Message.
3564
- */
3565
- message?: string;
3566
- };
3567
- /** @returns {DeleteRefundAccountDetails} */
3568
- declare function DeleteRefundAccountDetails(): DeleteRefundAccountDetails;
3569
- type DeleteRefundAccountDetails = {
3570
- /**
3571
- * - Success/Failure of the deleted beneficiary.
3572
- */
3573
- success: boolean;
3574
- /**
3575
- * - Message.
3576
- */
3577
- message: string;
3578
- };
3579
- /** @returns {RefundOptionsDetails} */
3580
- declare function RefundOptionsDetails(): RefundOptionsDetails;
3581
- type RefundOptionsDetails = {
3582
- /**
3583
- * - Refund option display name.
3584
- */
3585
- display_name: string;
3586
- /**
3587
- * - Refund ID. It will be unique identifier.
3588
- */
3589
- id: number;
3590
- /**
3591
- * - Refund option is active or not.
3592
- */
3593
- is_active?: boolean;
3594
- /**
3595
- * - Refund option name.
3596
- */
3597
- name: string;
3598
- };
3599
- /** @returns {RefundOptions} */
3600
- declare function RefundOptions(): RefundOptions;
3601
- type RefundOptions = {
3602
- /**
3603
- * - List of all refund options.
3604
- */
3605
- items: RefundOptionsDetails;
3606
- };
3607
- /** @returns {OfflineRefundOptions} */
3608
- declare function OfflineRefundOptions(): OfflineRefundOptions;
3609
- type OfflineRefundOptions = {
3610
- /**
3611
- * - List of all refund options.
3612
- */
3613
- items: RefundOptionsDetails;
3614
- /**
3615
- * - List of all offline payment options. MOP
3616
- * Code value.
3617
- */
3618
- payment_modes: string[];
3619
- };
3620
- /** @returns {RefundOptionDetails} */
3621
- declare function RefundOptionDetails(): RefundOptionDetails;
3622
- type RefundOptionDetails = {
3623
- /**
3624
- * - Available offline
3625
- * refund options data.
3626
- */
3627
- offline_refund_options: OfflineRefundOptions;
3628
- /**
3629
- * - Success/Failure Of response.
3630
- */
3631
- success: boolean;
3632
- /**
3633
- * - Available refund options data.
3634
- */
3635
- refund_options: RefundOptions;
3636
- };
3637
- /** @returns {SelectedRefundOptionDetails} */
3638
- declare function SelectedRefundOptionDetails(): SelectedRefundOptionDetails;
3639
- type SelectedRefundOptionDetails = {
3640
- /**
3641
- * - Selected transfer mode for given shipment.
3642
- */
3643
- transfer_mode: any;
3644
- /**
3645
- * - ID of the shipment.
3646
- */
3647
- shipment_id: string;
3648
- /**
3649
- * - Detailed message.
3650
- */
3651
- message: string;
3652
- /**
3653
- * - Whether refund is successful or not.
3654
- */
3655
- success: boolean;
3656
- };
3657
- /** @returns {WalletBeneficiaryDetails} */
3658
- declare function WalletBeneficiaryDetails(): WalletBeneficiaryDetails;
3659
- type WalletBeneficiaryDetails = {
3660
- /**
3661
- * - Beneficiary Id.
3662
- */
3663
- beneficiary_id: string;
3664
- /**
3665
- * - MOdification Date of Beneficiary.
3666
- */
3667
- modified_on: string;
3668
- /**
3669
- * - Display Name Of Account.
3670
- */
3671
- display_name: string;
3672
- /**
3673
- * - Id of the wallet beneficiary.
3674
- */
3675
- id: number;
3676
- /**
3677
- * - SHort Title Of Account.
3678
- */
3679
- subtitle: string;
3680
- /**
3681
- * - Transfer Mode Of Account.
3682
- */
3683
- transfer_mode: string;
3684
- /**
3685
- * - MObile no of User.
3686
- */
3687
- mobile?: string;
3688
- /**
3689
- * - Boolean Flag whether Beneficiary set or not.
3690
- */
3691
- is_active: boolean;
3692
- /**
3693
- * - Creation Date of Beneficiary.
3694
- */
3695
- created_on: string;
3696
- /**
3697
- * - Address of User.
3698
- */
3699
- address: string;
3700
- /**
3701
- * - Title Of Account.
3702
- */
3703
- title: string;
3704
- /**
3705
- * - Bank Name Of Account.
3706
- */
3707
- wallet_address: string;
3708
- /**
3709
- * - Remarks.
3710
- */
3711
- comment?: string;
3712
- /**
3713
- * - Branch Name Of Account.
3714
- */
3715
- wallet?: string;
3716
- /**
3717
- * - EMail of User.
3718
- */
3719
- email: string;
3720
- /**
3721
- * - User Id Who filled the Beneficiary.
3722
- */
3723
- delights_user_name?: string;
3724
- };
3725
- /** @returns {UpiBeneficiaryDetails} */
3726
- declare function UpiBeneficiaryDetails(): UpiBeneficiaryDetails;
3727
- type UpiBeneficiaryDetails = {
3728
- /**
3729
- * - Beneficiary Id.
3730
- */
3731
- beneficiary_id: string;
3732
- /**
3733
- * - MOdification Date of Beneficiary.
3734
- */
3735
- modified_on: string;
3736
- /**
3737
- * - Display Name Of Account.
3738
- */
3739
- display_name: string;
3740
- /**
3741
- * - Id of the upi beneficiary.
3742
- */
3743
- id: number;
3744
- /**
3745
- * - SHort Title Of Account.
3746
- */
3747
- subtitle: string;
3748
- /**
3749
- * - Transfer Mode Of Account.
3750
- */
3751
- transfer_mode: string;
3752
- /**
3753
- * - Branch Name Of Account.
3754
- */
3755
- vpa?: string;
3756
- /**
3757
- * - Mobile no of User.
3758
- */
3759
- mobile?: string;
3760
- /**
3761
- * - Bank Name Of Account.
3762
- */
3763
- vpa_address: string;
3764
- /**
3765
- * - Creation Date of Beneficiary.
3766
- */
3767
- created_on: string;
3768
- /**
3769
- * - Address of User.
3770
- */
3771
- address: string;
3772
- /**
3773
- * - Title Of Account.
3774
- */
3775
- title: string;
3776
- /**
3777
- * - Remarks.
3778
- */
3779
- comment?: string;
3780
- /**
3781
- * - Boolean Flag whether Beneficiary set or not.
3782
- */
3783
- is_active: boolean;
3784
- /**
3785
- * - EMail of User.
3786
- */
3787
- email: string;
3788
- /**
3789
- * - User Id Who filled the Beneficiary.
3790
- */
3791
- delights_user_name?: string;
3792
- };
3793
- /** @returns {BeneficiaryRefundOptions} */
3794
- declare function BeneficiaryRefundOptions(): BeneficiaryRefundOptions;
3795
- type BeneficiaryRefundOptions = {
3796
- /**
3797
- * - List of all add bank beneficiary details.
3798
- */
3799
- bank?: OrderBeneficiaryDetails;
3800
- /**
3801
- * - List of all add Wallet
3802
- * beneficiary details.
3803
- */
3804
- wallet?: WalletBeneficiaryDetails;
3805
- /**
3806
- * - List of all add UPI beneficiary details.
3807
- */
3808
- upi?: UpiBeneficiaryDetails;
3809
- };
3810
- /** @returns {OrderBeneficiaryDetailsSchemaV2} */
3811
- declare function OrderBeneficiaryDetailsSchemaV2(): OrderBeneficiaryDetailsSchemaV2;
3812
- type OrderBeneficiaryDetailsSchemaV2 = {
3813
- /**
3814
- * - Show Beneficiary details on UI or not.
3815
- */
3816
- show_beneficiary_details: boolean;
3817
- /**
3818
- * - Beneficiary Data for Bank
3819
- * account, UPI and Wallets.
3820
- */
3821
- data: BeneficiaryRefundOptions;
3822
- /**
3823
- * - Max Limit for adding bank account, UPI and wallet.
3824
- */
3825
- limit: any;
3826
- };
3827
- /** @returns {ValidateValidateAddress} */
3828
- declare function ValidateValidateAddress(): ValidateValidateAddress;
3829
- type ValidateValidateAddress = {
3830
- /**
3831
- * - IFSC Code.
3832
- */
3833
- ifsc_code?: string;
3834
- /**
3835
- * - VPA Address.
3836
- */
3837
- upi_vpa?: string;
3838
- /**
3839
- * - Aggregator Name.
3840
- */
3841
- aggregator?: string;
3842
- };
3843
- /** @returns {VPADetails} */
3844
- declare function VPADetails(): VPADetails;
3845
- type VPADetails = {
3846
- /**
3847
- * - Is VPA valid or not.
3848
- */
3849
- is_valid: boolean;
3850
- /**
3851
- * - VPA address.
3852
- */
3853
- upi_vpa: string;
3854
- /**
3855
- * - VPA validation message.
3856
- */
3857
- status: string;
3858
- /**
3859
- * - VPA Customer Name.
3860
- */
3861
- customer_name: string;
3862
- };
3863
- /** @returns {ValidateValidateAddressDetails} */
3864
- declare function ValidateValidateAddressDetails(): ValidateValidateAddressDetails;
3865
- type ValidateValidateAddressDetails = {
3866
- /**
3867
- * - UPI validation details.
3868
- */
3869
- upi?: VPADetails;
3870
- /**
3871
- * - Whether address validation is successful or not.
3872
- */
3873
- success: boolean;
3874
- /**
3875
- * - IFSC details response data.
3876
- */
3877
- ifsc?: any;
3878
- };
3879
- /** @returns {PaymentMethodsMetaOrder} */
3880
- declare function PaymentMethodsMetaOrder(): PaymentMethodsMetaOrder;
3881
- type PaymentMethodsMetaOrder = {
3882
- /**
3883
- * - Merchant code.
3884
- */
3885
- merchant_code: string;
3886
- /**
3887
- * - Payment gateway name.
3888
- */
3889
- payment_gateway: string;
3890
- /**
3891
- * - Payment identifier.
3892
- */
3893
- payment_identifier: string;
3894
- };
3895
- /** @returns {PaymentOrderMethods} */
3896
- declare function PaymentOrderMethods(): PaymentOrderMethods;
3897
- type PaymentOrderMethods = {
3898
- /**
3899
- * - Amount to be collected.
3900
- */
3901
- amount: number;
3902
- /**
3903
- * - Payment type i.e. Required / Blocked.
3904
- */
3905
- payment?: string;
3906
- /**
3907
- * - Payment mode.
3908
- */
3909
- mode: string;
3910
- meta: PaymentMethodsMetaOrder;
3911
- /**
3912
- * - Payment mode name.
3913
- */
3914
- name: string;
3915
- };
3916
- /** @returns {PaymentOrder} */
3917
- declare function PaymentOrder(): PaymentOrder;
3918
- type PaymentOrder = {
3919
- /**
3920
- * - All payment methods for order.
3921
- */
3922
- payment_methods?: PaymentOrderMethods[];
3923
- /**
3924
- * - Order id.
3925
- */
3926
- order_id: string;
3927
- /**
3928
- * - Shipment_id.
3929
- */
3930
- shipment_id?: string;
3931
- };
3932
- /** @returns {PaymentOrderData} */
3933
- declare function PaymentOrderData(): PaymentOrderData;
3934
- type PaymentOrderData = {
3935
- /**
3936
- * - Amount.
3937
- */
3938
- amount?: number;
3939
- /**
3940
- * - Aggregator name.
3941
- */
3942
- aggregator?: string;
3943
- /**
3944
- * - Callback url for aggregator.
3945
- */
3946
- callback_url?: string;
3947
- /**
3948
- * - Aggregator order id.
3949
- */
3950
- order_id?: string;
3951
- /**
3952
- * - Aggregator customer id.
3953
- */
3954
- customer_id?: string;
3955
- /**
3956
- * - Merchant order id.
3957
- */
3958
- merchant_order_id?: string;
3959
- /**
3960
- * - Currency used for the order.
3961
- */
3962
- currency?: string;
3963
- /**
3964
- * - Email address of the customer.
3965
- */
3966
- email?: string;
3967
- /**
3968
- * - Contact number of the customer.
3969
- */
3970
- contact?: string;
3971
- /**
3972
- * - Method of payment or delivery for the order.
3973
- */
3974
- method?: string;
3975
- };
3976
- /** @returns {PaymentOrderDetails} */
3977
- declare function PaymentOrderDetails(): PaymentOrderDetails;
3978
- type PaymentOrderDetails = {
3979
- /**
3980
- * - Payment confirm url for aggregator.
3981
- */
3982
- payment_confirm_url?: string;
3983
- /**
3984
- * - Callback url for aggregator.
3985
- */
3986
- callback_url?: string;
3987
- /**
3988
- * - Merchant order id.
3989
- */
3990
- order_id?: string;
3991
- /**
3992
- * - Successful or failure.
3993
- */
3994
- success?: boolean;
3995
- /**
3996
- * - HTTP status code.
3997
- */
3998
- status_code: number;
3999
- data?: PaymentOrderData;
4000
- /**
4001
- * - Detailed message.
4002
- */
4003
- message: string;
4004
- };
4005
- /** @returns {ShipmentRefund} */
4006
- declare function ShipmentRefund(): ShipmentRefund;
4007
- type ShipmentRefund = {
4008
- /**
4009
- * - Shipment Id of the respective Merchant Order Id.
4010
- */
4011
- shipment_id: string;
4012
- /**
4013
- * - Merchant Order Id.
4014
- */
4015
- order_id: string;
4016
- /**
4017
- * - Transfer Mode of the Beneficiary to be added.
4018
- */
4019
- transfer_mode: string;
4020
- /**
4021
- * - Beneficiary Hash Id of the beneficiary added.
4022
- */
4023
- beneficiary_id?: string;
4024
- };
4025
- /** @returns {ShipmentRefundDetail} */
4026
- declare function ShipmentRefundDetail(): ShipmentRefundDetail;
4027
- type ShipmentRefundDetail = {
4028
- /**
4029
- * - ID of the shipment.
4030
- */
4031
- shipment_id: string;
4032
- /**
4033
- * - ID of an order.
4034
- */
4035
- order_id: string;
4036
- /**
4037
- * - Mode of transfer for the shipment refund
4038
- * (e.g., bank transfer, digital wallet).
4039
- */
4040
- transfer_mode: string;
4041
- /**
4042
- * - Unique identifier for the beneficiary
4043
- * receiving the refund.
4044
- */
4045
- beneficiary_id: string;
4046
- };
4047
- /** @returns {ShipmentRefundDetails} */
4048
- declare function ShipmentRefundDetails(): ShipmentRefundDetails;
4049
- type ShipmentRefundDetails = {
4050
- /**
4051
- * - Selected Shipment refund option details.
4052
- */
4053
- data: ShipmentRefundDetail;
4054
- /**
4055
- * - Successful or not.
4056
- */
4057
- success: boolean;
4058
- /**
4059
- * - Detailed message.
4060
- */
4061
- message: string;
4062
- };