@gofynd/fdk-client-javascript 1.1.6 → 1.2.0

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 (321) hide show
  1. package/README.md +12 -0
  2. package/index.js +0 -3
  3. package/package.json +1 -1
  4. package/sdk/application/ApplicationAPIClient.d.ts +15 -1
  5. package/sdk/application/ApplicationAPIClient.js +8 -1
  6. package/sdk/application/ApplicationClient.d.ts +37 -6
  7. package/sdk/application/ApplicationClient.js +31 -0
  8. package/sdk/application/ApplicationConfig.d.ts +52 -12
  9. package/sdk/application/ApplicationConfig.js +37 -2
  10. package/sdk/application/ApplicationModels.d.ts +46 -1
  11. package/sdk/application/ApplicationModels.js +18 -0
  12. package/sdk/application/Cart/CartApplicationClient.d.ts +172 -357
  13. package/sdk/application/Cart/CartApplicationClient.js +620 -483
  14. package/sdk/application/Cart/CartApplicationModel.d.ts +2054 -96
  15. package/sdk/application/Cart/CartApplicationModel.js +1224 -93
  16. package/sdk/application/Cart/CartApplicationValidator.d.ts +508 -30
  17. package/sdk/application/Cart/CartApplicationValidator.js +270 -15
  18. package/sdk/application/Catalog/CatalogApplicationClient.d.ts +234 -413
  19. package/sdk/application/Catalog/CatalogApplicationClient.js +777 -630
  20. package/sdk/application/Catalog/CatalogApplicationModel.d.ts +2218 -117
  21. package/sdk/application/Catalog/CatalogApplicationModel.js +1499 -170
  22. package/sdk/application/Catalog/CatalogApplicationValidator.d.ts +798 -31
  23. package/sdk/application/Catalog/CatalogApplicationValidator.js +318 -3
  24. package/sdk/application/Common/CommonApplicationClient.d.ts +14 -21
  25. package/sdk/application/Common/CommonApplicationClient.js +50 -33
  26. package/sdk/application/Common/CommonApplicationModel.d.ts +448 -19
  27. package/sdk/application/Common/CommonApplicationModel.js +224 -16
  28. package/sdk/application/Common/CommonApplicationValidator.d.ts +42 -4
  29. package/sdk/application/Common/CommonApplicationValidator.js +21 -3
  30. package/sdk/application/Communication/CommunicationApplicationClient.d.ts +25 -18
  31. package/sdk/application/Communication/CommunicationApplicationClient.js +74 -47
  32. package/sdk/application/Communication/CommunicationApplicationModel.d.ts +190 -14
  33. package/sdk/application/Communication/CommunicationApplicationModel.js +124 -7
  34. package/sdk/application/Communication/CommunicationApplicationValidator.d.ts +27 -4
  35. package/sdk/application/Communication/CommunicationApplicationValidator.js +21 -5
  36. package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +113 -112
  37. package/sdk/application/Configuration/ConfigurationApplicationClient.js +381 -260
  38. package/sdk/application/Configuration/ConfigurationApplicationModel.d.ts +2453 -110
  39. package/sdk/application/Configuration/ConfigurationApplicationModel.js +1254 -108
  40. package/sdk/application/Configuration/ConfigurationApplicationValidator.d.ts +160 -8
  41. package/sdk/application/Configuration/ConfigurationApplicationValidator.js +88 -4
  42. package/sdk/application/Content/ContentApplicationClient.d.ts +120 -138
  43. package/sdk/application/Content/ContentApplicationClient.js +409 -277
  44. package/sdk/application/Content/ContentApplicationModel.d.ts +1627 -105
  45. package/sdk/application/Content/ContentApplicationModel.js +1202 -109
  46. package/sdk/application/Content/ContentApplicationValidator.d.ts +214 -12
  47. package/sdk/application/Content/ContentApplicationValidator.js +113 -3
  48. package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +20 -29
  49. package/sdk/application/FileStorage/FileStorageApplicationClient.js +68 -47
  50. package/sdk/application/FileStorage/FileStorageApplicationModel.d.ts +299 -20
  51. package/sdk/application/FileStorage/FileStorageApplicationModel.js +209 -16
  52. package/sdk/application/FileStorage/FileStorageApplicationValidator.d.ts +55 -5
  53. package/sdk/application/FileStorage/FileStorageApplicationValidator.js +33 -6
  54. package/sdk/application/Lead/LeadApplicationClient.d.ts +50 -53
  55. package/sdk/application/Lead/LeadApplicationClient.js +169 -103
  56. package/sdk/application/Lead/LeadApplicationModel.d.ts +1405 -54
  57. package/sdk/application/Lead/LeadApplicationModel.js +619 -73
  58. package/sdk/application/Lead/LeadApplicationValidator.d.ts +91 -9
  59. package/sdk/application/Lead/LeadApplicationValidator.js +51 -6
  60. package/sdk/application/Logistic/LogisticApplicationClient.d.ts +34 -33
  61. package/sdk/application/Logistic/LogisticApplicationClient.js +110 -73
  62. package/sdk/application/Logistic/LogisticApplicationModel.d.ts +399 -28
  63. package/sdk/application/Logistic/LogisticApplicationModel.js +293 -24
  64. package/sdk/application/Logistic/LogisticApplicationValidator.d.ts +48 -6
  65. package/sdk/application/Logistic/LogisticApplicationValidator.js +34 -6
  66. package/sdk/application/Order/OrderApplicationClient.d.ts +81 -133
  67. package/sdk/application/Order/OrderApplicationClient.js +297 -217
  68. package/sdk/application/Order/OrderApplicationModel.d.ts +1101 -66
  69. package/sdk/application/Order/OrderApplicationModel.js +776 -57
  70. package/sdk/application/Order/OrderApplicationValidator.d.ts +249 -14
  71. package/sdk/application/Order/OrderApplicationValidator.js +114 -5
  72. package/sdk/application/Payment/PaymentApplicationClient.d.ts +341 -356
  73. package/sdk/application/Payment/PaymentApplicationClient.js +1077 -703
  74. package/sdk/application/Payment/PaymentApplicationModel.d.ts +3125 -99
  75. package/sdk/application/Payment/PaymentApplicationModel.js +1158 -62
  76. package/sdk/application/Payment/PaymentApplicationValidator.d.ts +494 -41
  77. package/sdk/application/Payment/PaymentApplicationValidator.js +297 -25
  78. package/sdk/application/PosCart/PosCartApplicationClient.d.ts +178 -350
  79. package/sdk/application/PosCart/PosCartApplicationClient.js +636 -491
  80. package/sdk/application/PosCart/PosCartApplicationModel.d.ts +1823 -89
  81. package/sdk/application/PosCart/PosCartApplicationModel.js +1117 -85
  82. package/sdk/application/PosCart/PosCartApplicationValidator.d.ts +480 -29
  83. package/sdk/application/PosCart/PosCartApplicationValidator.js +262 -15
  84. package/sdk/application/Rewards/RewardsApplicationClient.d.ts +49 -47
  85. package/sdk/application/Rewards/RewardsApplicationClient.js +160 -102
  86. package/sdk/application/Rewards/RewardsApplicationModel.d.ts +343 -22
  87. package/sdk/application/Rewards/RewardsApplicationModel.js +230 -15
  88. package/sdk/application/Rewards/RewardsApplicationValidator.d.ts +70 -7
  89. package/sdk/application/Rewards/RewardsApplicationValidator.js +45 -6
  90. package/sdk/application/Share/ShareApplicationClient.d.ts +44 -50
  91. package/sdk/application/Share/ShareApplicationClient.js +165 -97
  92. package/sdk/application/Share/ShareApplicationModel.d.ts +230 -15
  93. package/sdk/application/Share/ShareApplicationModel.js +154 -16
  94. package/sdk/application/Share/ShareApplicationValidator.d.ts +86 -8
  95. package/sdk/application/Share/ShareApplicationValidator.js +48 -4
  96. package/sdk/application/Theme/ThemeApplicationClient.d.ts +25 -27
  97. package/sdk/application/Theme/ThemeApplicationClient.js +83 -54
  98. package/sdk/application/Theme/ThemeApplicationModel.d.ts +621 -48
  99. package/sdk/application/Theme/ThemeApplicationModel.js +464 -40
  100. package/sdk/application/Theme/ThemeApplicationValidator.d.ts +49 -5
  101. package/sdk/application/Theme/ThemeApplicationValidator.js +26 -3
  102. package/sdk/application/User/UserApplicationClient.d.ts +219 -303
  103. package/sdk/application/User/UserApplicationClient.js +819 -522
  104. package/sdk/application/User/UserApplicationModel.d.ts +1390 -101
  105. package/sdk/application/User/UserApplicationModel.js +983 -44
  106. package/sdk/application/User/UserApplicationValidator.d.ts +457 -33
  107. package/sdk/application/User/UserApplicationValidator.js +265 -31
  108. package/sdk/common/AxiosHelper.js +8 -2
  109. package/sdk/common/Paginator.d.ts +27 -12
  110. package/sdk/common/Paginator.js +15 -0
  111. package/sdk/common/RequestSigner.js +0 -1
  112. package/sdk/partner/PartnerAPIClient.d.ts +15 -1
  113. package/sdk/partner/PartnerAPIClient.js +8 -1
  114. package/sdk/partner/PartnerClient.d.ts +20 -3
  115. package/sdk/partner/PartnerClient.js +17 -0
  116. package/sdk/partner/PartnerConfig.d.ts +40 -14
  117. package/sdk/partner/PartnerConfig.js +31 -6
  118. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +26 -25
  119. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +82 -53
  120. package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +202 -17
  121. package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +139 -10
  122. package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +42 -5
  123. package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.js +26 -4
  124. package/sdk/platform/Billing/BillingPlatformClient.d.ts +88 -97
  125. package/sdk/platform/Billing/BillingPlatformClient.js +310 -191
  126. package/sdk/platform/Billing/BillingPlatformModel.d.ts +1211 -68
  127. package/sdk/platform/Billing/BillingPlatformModel.js +824 -59
  128. package/sdk/platform/Billing/BillingPlatformValidator.d.ts +153 -12
  129. package/sdk/platform/Billing/BillingPlatformValidator.js +87 -8
  130. package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +392 -634
  131. package/sdk/platform/Cart/CartPlatformApplicationClient.js +1480 -957
  132. package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +827 -57
  133. package/sdk/platform/Cart/CartPlatformApplicationValidator.js +492 -34
  134. package/sdk/platform/Cart/CartPlatformModel.d.ts +3639 -175
  135. package/sdk/platform/Cart/CartPlatformModel.js +2368 -212
  136. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +438 -615
  137. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +1449 -984
  138. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +1081 -49
  139. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +482 -23
  140. package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +573 -824
  141. package/sdk/platform/Catalog/CatalogPlatformClient.js +1773 -1264
  142. package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +6871 -326
  143. package/sdk/platform/Catalog/CatalogPlatformModel.js +4215 -349
  144. package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +1331 -71
  145. package/sdk/platform/Catalog/CatalogPlatformValidator.js +611 -30
  146. package/sdk/platform/Common/CommonPlatformClient.d.ts +14 -21
  147. package/sdk/platform/Common/CommonPlatformClient.js +48 -33
  148. package/sdk/platform/Common/CommonPlatformModel.d.ts +448 -19
  149. package/sdk/platform/Common/CommonPlatformModel.js +224 -16
  150. package/sdk/platform/Common/CommonPlatformValidator.d.ts +42 -4
  151. package/sdk/platform/Common/CommonPlatformValidator.js +21 -3
  152. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +457 -279
  153. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +1423 -553
  154. package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +581 -42
  155. package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +294 -22
  156. package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +18 -5
  157. package/sdk/platform/Communication/CommunicationPlatformClient.js +58 -19
  158. package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +1630 -102
  159. package/sdk/platform/Communication/CommunicationPlatformModel.js +1150 -85
  160. package/sdk/platform/Communication/CommunicationPlatformValidator.d.ts +16 -3
  161. package/sdk/platform/Communication/CommunicationPlatformValidator.js +11 -3
  162. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +102 -111
  163. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +321 -225
  164. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +830 -43
  165. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +612 -78
  166. package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +180 -13
  167. package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +98 -10
  168. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +232 -212
  169. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +737 -438
  170. package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +293 -22
  171. package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +184 -17
  172. package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +166 -178
  173. package/sdk/platform/Configuration/ConfigurationPlatformClient.js +519 -310
  174. package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +4504 -188
  175. package/sdk/platform/Configuration/ConfigurationPlatformModel.js +2242 -204
  176. package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +332 -19
  177. package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +153 -10
  178. package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +495 -560
  179. package/sdk/platform/Content/ContentPlatformApplicationClient.js +1777 -987
  180. package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +872 -62
  181. package/sdk/platform/Content/ContentPlatformApplicationValidator.js +487 -35
  182. package/sdk/platform/Content/ContentPlatformModel.d.ts +1661 -108
  183. package/sdk/platform/Content/ContentPlatformModel.js +1217 -113
  184. package/sdk/platform/Discount/DiscountPlatformClient.d.ts +67 -101
  185. package/sdk/platform/Discount/DiscountPlatformClient.js +240 -176
  186. package/sdk/platform/Discount/DiscountPlatformModel.d.ts +242 -15
  187. package/sdk/platform/Discount/DiscountPlatformModel.js +162 -10
  188. package/sdk/platform/Discount/DiscountPlatformValidator.d.ts +185 -13
  189. package/sdk/platform/Discount/DiscountPlatformValidator.js +88 -8
  190. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +32 -41
  191. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +106 -74
  192. package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +77 -6
  193. package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +41 -6
  194. package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +39 -54
  195. package/sdk/platform/FileStorage/FileStoragePlatformClient.js +124 -99
  196. package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +299 -20
  197. package/sdk/platform/FileStorage/FileStoragePlatformModel.js +207 -16
  198. package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +98 -8
  199. package/sdk/platform/FileStorage/FileStoragePlatformValidator.js +54 -7
  200. package/sdk/platform/Finance/FinancePlatformClient.d.ts +85 -91
  201. package/sdk/platform/Finance/FinancePlatformClient.js +272 -180
  202. package/sdk/platform/Finance/FinancePlatformModel.d.ts +619 -50
  203. package/sdk/platform/Finance/FinancePlatformModel.js +458 -30
  204. package/sdk/platform/Finance/FinancePlatformValidator.d.ts +123 -15
  205. package/sdk/platform/Finance/FinancePlatformValidator.js +95 -16
  206. package/sdk/platform/Inventory/InventoryPlatformClient.d.ts +99 -97
  207. package/sdk/platform/Inventory/InventoryPlatformClient.js +288 -199
  208. package/sdk/platform/Inventory/InventoryPlatformModel.d.ts +1354 -61
  209. package/sdk/platform/Inventory/InventoryPlatformModel.js +916 -83
  210. package/sdk/platform/Inventory/InventoryPlatformValidator.d.ts +168 -12
  211. package/sdk/platform/Inventory/InventoryPlatformValidator.js +82 -6
  212. package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +86 -106
  213. package/sdk/platform/Lead/LeadPlatformApplicationClient.js +326 -186
  214. package/sdk/platform/Lead/LeadPlatformApplicationValidator.d.ts +180 -14
  215. package/sdk/platform/Lead/LeadPlatformApplicationValidator.js +94 -9
  216. package/sdk/platform/Lead/LeadPlatformClient.d.ts +75 -101
  217. package/sdk/platform/Lead/LeadPlatformClient.js +240 -174
  218. package/sdk/platform/Lead/LeadPlatformModel.d.ts +1403 -54
  219. package/sdk/platform/Lead/LeadPlatformModel.js +618 -73
  220. package/sdk/platform/Lead/LeadPlatformValidator.d.ts +173 -12
  221. package/sdk/platform/Lead/LeadPlatformValidator.js +85 -8
  222. package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +18 -14
  223. package/sdk/platform/Order/OrderPlatformApplicationClient.js +56 -29
  224. package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +26 -4
  225. package/sdk/platform/Order/OrderPlatformApplicationValidator.js +16 -3
  226. package/sdk/platform/Order/OrderPlatformClient.d.ts +343 -556
  227. package/sdk/platform/Order/OrderPlatformClient.js +969 -762
  228. package/sdk/platform/Order/OrderPlatformModel.d.ts +4967 -247
  229. package/sdk/platform/Order/OrderPlatformModel.js +3249 -259
  230. package/sdk/platform/Order/OrderPlatformValidator.d.ts +758 -37
  231. package/sdk/platform/Order/OrderPlatformValidator.js +351 -22
  232. package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +28 -36
  233. package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +103 -59
  234. package/sdk/platform/Partner/PartnerPlatformApplicationValidator.d.ts +66 -6
  235. package/sdk/platform/Partner/PartnerPlatformApplicationValidator.js +32 -4
  236. package/sdk/platform/Partner/PartnerPlatformClient.d.ts +68 -107
  237. package/sdk/platform/Partner/PartnerPlatformClient.js +253 -174
  238. package/sdk/platform/Partner/PartnerPlatformModel.d.ts +767 -45
  239. package/sdk/platform/Partner/PartnerPlatformModel.js +524 -41
  240. package/sdk/platform/Partner/PartnerPlatformValidator.d.ts +207 -13
  241. package/sdk/platform/Partner/PartnerPlatformValidator.js +87 -5
  242. package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +255 -260
  243. package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +860 -504
  244. package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +348 -30
  245. package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +221 -19
  246. package/sdk/platform/Payment/PaymentPlatformClient.d.ts +73 -73
  247. package/sdk/platform/Payment/PaymentPlatformClient.js +238 -154
  248. package/sdk/platform/Payment/PaymentPlatformModel.d.ts +2658 -93
  249. package/sdk/platform/Payment/PaymentPlatformModel.js +1035 -36
  250. package/sdk/platform/Payment/PaymentPlatformValidator.d.ts +111 -11
  251. package/sdk/platform/Payment/PaymentPlatformValidator.js +68 -7
  252. package/sdk/platform/PlatformAPIClient.d.ts +16 -1
  253. package/sdk/platform/PlatformAPIClient.js +9 -1
  254. package/sdk/platform/PlatformApplicationClient.d.ts +22 -1798
  255. package/sdk/platform/PlatformApplicationClient.js +17 -1899
  256. package/sdk/platform/PlatformClient.d.ts +29 -12579
  257. package/sdk/platform/PlatformClient.js +26 -15085
  258. package/sdk/platform/PlatformConfig.d.ts +37 -11
  259. package/sdk/platform/PlatformConfig.js +32 -6
  260. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +80 -92
  261. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +307 -177
  262. package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.d.ts +149 -12
  263. package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.js +82 -8
  264. package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +371 -23
  265. package/sdk/platform/Rewards/RewardsPlatformModel.js +246 -16
  266. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +120 -89
  267. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +349 -201
  268. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +128 -12
  269. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +85 -11
  270. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +148 -178
  271. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +454 -329
  272. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +1399 -96
  273. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +1022 -71
  274. package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +280 -18
  275. package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +134 -11
  276. package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +38 -47
  277. package/sdk/platform/Share/SharePlatformApplicationClient.js +137 -73
  278. package/sdk/platform/Share/SharePlatformApplicationValidator.d.ts +87 -7
  279. package/sdk/platform/Share/SharePlatformApplicationValidator.js +42 -5
  280. package/sdk/platform/Share/SharePlatformModel.d.ts +250 -16
  281. package/sdk/platform/Share/SharePlatformModel.js +165 -17
  282. package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +149 -183
  283. package/sdk/platform/Theme/ThemePlatformApplicationClient.js +579 -330
  284. package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +308 -24
  285. package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +162 -10
  286. package/sdk/platform/Theme/ThemePlatformModel.d.ts +621 -48
  287. package/sdk/platform/Theme/ThemePlatformModel.js +464 -40
  288. package/sdk/platform/User/UserPlatformApplicationClient.d.ts +119 -151
  289. package/sdk/platform/User/UserPlatformApplicationClient.js +411 -244
  290. package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +235 -18
  291. package/sdk/platform/User/UserPlatformApplicationValidator.js +126 -12
  292. package/sdk/platform/User/UserPlatformModel.d.ts +1390 -101
  293. package/sdk/platform/User/UserPlatformModel.js +983 -44
  294. package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +38 -47
  295. package/sdk/platform/Webhook/WebhookPlatformClient.js +137 -87
  296. package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +242 -16
  297. package/sdk/platform/Webhook/WebhookPlatformModel.js +167 -18
  298. package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +83 -7
  299. package/sdk/platform/Webhook/WebhookPlatformValidator.js +43 -5
  300. package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +14 -21
  301. package/sdk/public/Configuration/ConfigurationPublicClient.js +46 -33
  302. package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +473 -19
  303. package/sdk/public/Configuration/ConfigurationPublicModel.js +224 -16
  304. package/sdk/public/Configuration/ConfigurationPublicValidator.d.ts +42 -4
  305. package/sdk/public/Configuration/ConfigurationPublicValidator.js +21 -3
  306. package/sdk/public/Inventory/InventoryPublicClient.d.ts +48 -48
  307. package/sdk/public/Inventory/InventoryPublicClient.js +146 -98
  308. package/sdk/public/Inventory/InventoryPublicModel.d.ts +392 -21
  309. package/sdk/public/Inventory/InventoryPublicModel.js +267 -27
  310. package/sdk/public/Inventory/InventoryPublicValidator.d.ts +90 -8
  311. package/sdk/public/Inventory/InventoryPublicValidator.js +44 -4
  312. package/sdk/public/PublicClient.d.ts +19 -3
  313. package/sdk/public/PublicClient.js +16 -0
  314. package/sdk/public/PublicConfig.d.ts +27 -6
  315. package/sdk/public/PublicConfig.js +17 -1
  316. package/sdk/public/Webhook/WebhookPublicClient.d.ts +13 -11
  317. package/sdk/public/Webhook/WebhookPublicClient.js +42 -27
  318. package/sdk/public/Webhook/WebhookPublicModel.d.ts +242 -16
  319. package/sdk/public/Webhook/WebhookPublicModel.js +167 -18
  320. package/sdk/public/Webhook/WebhookPublicValidator.d.ts +18 -3
  321. package/sdk/public/Webhook/WebhookPublicValidator.js +14 -4
@@ -1,100 +1,3126 @@
1
- export = PaymentModel;
2
- declare class PaymentModel {
3
- static ActiveCardPaymentGatewayResponse(): any;
4
- static AddBeneficiaryDetailsOTPRequest(): any;
5
- static AddBeneficiaryDetailsRequest(): any;
6
- static AddBeneficiaryViaOtpVerificationRequest(): any;
7
- static AddBeneficiaryViaOtpVerificationResponse(): any;
8
- static AggregatorConfigDetail(): any;
9
- static AggregatorRoute(): any;
10
- static AggregatorsConfigDetailResponse(): any;
11
- static AttachCardRequest(): any;
12
- static AttachCardsResponse(): any;
13
- static BalanceDetails(): any;
14
- static BankDetailsForOTP(): any;
15
- static BeneficiaryModeDetails(): any;
16
- static BusinessDetails(): any;
17
- static CancelOrResendPaymentLinkRequest(): any;
18
- static CancelPaymentLinkResponse(): any;
19
- static Card(): any;
20
- static CardDetails(): any;
21
- static CardDetailsResponse(): any;
22
- static CardPaymentGateway(): any;
23
- static ChargeCustomerRequest(): any;
24
- static ChargeCustomerResponse(): any;
25
- static CheckCreditResponse(): any;
26
- static CreateOrderUserData(): any;
27
- static CreateOrderUserPaymentMethods(): any;
28
- static CreateOrderUserRequest(): any;
29
- static CreateOrderUserResponse(): any;
30
- static CreatePaymentLinkMeta(): any;
31
- static CreatePaymentLinkRequest(): any;
32
- static CreatePaymentLinkResponse(): any;
33
- static CreditDetail(): any;
34
- static CreditSummary(): any;
35
- static CustomerCreditSummaryResponse(): any;
36
- static CustomerOnboardingRequest(): any;
37
- static CustomerOnboardingResponse(): any;
38
- static DeleteCardsResponse(): any;
39
- static DeletehCardRequest(): any;
40
- static DeviceDetails(): any;
41
- static EpaylaterBannerData(): any;
42
- static EpaylaterBannerResponse(): any;
43
- static ErrorCodeAndDescription(): any;
44
- static ErrorCodeDescription(): any;
45
- static ErrorDescription(): any;
46
- static ErrorResponse(): any;
47
- static GetPaymentLinkResponse(): any;
48
- static HttpErrorCodeAndResponse(): any;
49
- static IfscCodeResponse(): any;
50
- static IntentApp(): any;
51
- static IntentAppErrorList(): any;
52
- static KYCAddress(): any;
53
- static LinkStatus(): any;
54
- static ListCardsResponse(): any;
55
- static MarketplaceInfo(): any;
56
- static NotFoundResourceError(): any;
57
- static OnboardSummary(): any;
58
- static OrderBeneficiaryDetails(): any;
59
- static OrderBeneficiaryResponse(): any;
60
- static OutstandingOrderDetailsResponse(): any;
61
- static PaidOrderDetailsResponse(): any;
62
- static PaymentFlow(): any;
63
- static PaymentInitializationRequest(): any;
64
- static PaymentInitializationResponse(): any;
65
- static PaymentMethodsMeta(): any;
66
- static PaymentModeList(): any;
67
- static PaymentModeLogo(): any;
68
- static PaymentModeRouteResponse(): any;
69
- static PaymentOptionAndFlow(): any;
70
- static PaymentStatusUpdateRequest(): any;
71
- static PaymentStatusUpdateResponse(): any;
72
- static PollingPaymentLinkResponse(): any;
73
- static RedirectToAggregatorResponse(): any;
74
- static RedirectURL(): any;
75
- static RefundAccountResponse(): any;
76
- static renderHTMLRequest(): any;
77
- static renderHTMLResponse(): any;
78
- static ResendOrCancelPaymentRequest(): any;
79
- static ResendOrCancelPaymentResponse(): any;
80
- static ResendPaymentLinkResponse(): any;
81
- static RootPaymentMode(): any;
82
- static RupifiBannerData(): any;
83
- static RupifiBannerResponse(): any;
84
- static SetDefaultBeneficiaryRequest(): any;
85
- static SetDefaultBeneficiaryResponse(): any;
86
- static TransferItemsDetails(): any;
87
- static TransferModeDetails(): any;
88
- static TransferModeResponse(): any;
89
- static UpdateRefundTransferModeRequest(): any;
90
- static UpdateRefundTransferModeResponse(): any;
91
- static UserPersonalInfoInDetails(): any;
92
- static ValidateCustomerRequest(): any;
93
- static ValidateCustomerResponse(): any;
94
- static ValidateUPI(): any;
95
- static ValidateVPARequest(): any;
96
- static ValidateVPAResponse(): any;
97
- static WalletOtpRequest(): any;
98
- static WalletOtpResponse(): any;
99
- static WrongOtpError(): any;
1
+ export = PaymentApplicationModel;
2
+ /**
3
+ * @typedef ActiveCardPaymentGatewayResponse
4
+ * @property {CardPaymentGateway} cards - Card's payment gateway with customer id.
5
+ * @property {string} message - Human readable message.
6
+ * @property {boolean} success - Response is successful or not.
7
+ */
8
+ /**
9
+ * @typedef AddBeneficiaryDetailsOTPRequest
10
+ * @property {BankDetailsForOTP} details
11
+ * @property {string} order_id
12
+ */
13
+ /**
14
+ * @typedef AddBeneficiaryDetailsRequest
15
+ * @property {boolean} delights - True if beneficiary to be added by delights or
16
+ * False if by User
17
+ * @property {BeneficiaryModeDetails} details - Beneficiary bank details
18
+ * @property {string} order_id - Merchant Order Id
19
+ * @property {string} [otp]
20
+ * @property {string} [request_id]
21
+ * @property {string} shipment_id - Shipment Id of the respective Merchant Order Id
22
+ * @property {string} transfer_mode - Transfer Mode of the Beneficiary to be added
23
+ */
24
+ /**
25
+ * @typedef AddBeneficiaryViaOtpVerificationRequest
26
+ * @property {string} hash_key - Hash key of the beneficiary Id
27
+ * @property {string} otp - Otp sent to the given Mobile No
28
+ * @property {string} request_id - Request Id sent in
29
+ */
30
+ /**
31
+ * @typedef AddBeneficiaryViaOtpVerificationResponse
32
+ * @property {string} message - Aggregator Response of beneficicary
33
+ * @property {boolean} [success] - Response is successful or not
34
+ */
35
+ /**
36
+ * @typedef AggregatorConfigDetail
37
+ * @property {string} [api] - Payment gateway api endpoint
38
+ * @property {string} config_type - Fynd or self payment gateway
39
+ * @property {string} key - Payment gateway api key
40
+ * @property {string} [merchant_id] - Unique merchant id
41
+ * @property {string} [merchant_key] - Unique merchant key
42
+ * @property {string} [pin] - Masked pin
43
+ * @property {boolean} [sdk] - SDK
44
+ * @property {string} secret - Masked payment gateway api secret
45
+ * @property {string} [user_id] - Registered User id
46
+ * @property {string} [verify_api] - Payment gateway verify payment api endpoint
47
+ */
48
+ /**
49
+ * @typedef AggregatorRoute
50
+ * @property {string} [api_link] - Api_link
51
+ * @property {Object} [data] - Data
52
+ * @property {string} [payment_flow] - Payment_flow
53
+ * @property {string} [payment_flow_data] - Payment_flow_data
54
+ */
55
+ /**
56
+ * @typedef AggregatorsConfigDetailResponse
57
+ * @property {AggregatorConfigDetail} [ccavenue]
58
+ * @property {string} env - Environment i.e Live or Test
59
+ * @property {AggregatorConfigDetail} [juspay]
60
+ * @property {AggregatorConfigDetail} [mswipe]
61
+ * @property {AggregatorConfigDetail} [payumoney]
62
+ * @property {AggregatorConfigDetail} [razorpay]
63
+ * @property {AggregatorConfigDetail} [rupifi]
64
+ * @property {AggregatorConfigDetail} [simpl]
65
+ * @property {AggregatorConfigDetail} [stripe]
66
+ * @property {boolean} success
67
+ */
68
+ /**
69
+ * @typedef AttachCardRequest
70
+ * @property {string} card_id - Card token of payment gateway.
71
+ * @property {string} [name_on_card]
72
+ * @property {string} [nickname]
73
+ * @property {boolean} [refresh] - Refresh cache flag.
74
+ */
75
+ /**
76
+ * @typedef AttachCardsResponse
77
+ * @property {Object} data - List of cards of customer.
78
+ * @property {string} [message] - Human readable message.
79
+ * @property {boolean} success - Response is successful or not.
80
+ */
81
+ /**
82
+ * @typedef BalanceDetails
83
+ * @property {string} [currency] - Currency Code
84
+ * @property {string} [formatted_value] - Formated Amount with currency symbol
85
+ * @property {number} [value] - Payment amount
86
+ */
87
+ /**
88
+ * @typedef BankDetailsForOTP
89
+ * @property {string} account_holder
90
+ * @property {string} account_no
91
+ * @property {string} bank_name
92
+ * @property {string} branch_name
93
+ * @property {string} ifsc_code
94
+ */
95
+ /**
96
+ * @typedef BeneficiaryModeDetails
97
+ * @property {string} account_holder - Name of the Account Holder
98
+ * @property {string} account_no - Account NUmber of the Account Holder
99
+ * @property {string} [address] - Address of the User
100
+ * @property {string} bank_name - Bank Name of the Account
101
+ * @property {string} branch_name - Branch Name of the Account
102
+ * @property {string} [comment] - Remarks added by The user
103
+ * @property {string} email - Email of the Account Holder
104
+ * @property {string} ifsc_code - Ifsc Code of the Account
105
+ * @property {string} mobile - Moblie Number of the User
106
+ * @property {string} [vpa]
107
+ * @property {string} [wallet]
108
+ */
109
+ /**
110
+ * @typedef BusinessDetails
111
+ * @property {KYCAddress} [address] - Address details
112
+ * @property {string} [business_ownership_type] - Business Ownershipp type(e.g Rented)
113
+ * @property {string} [business_type] - Business Type
114
+ * @property {string} [entity_type] - Busineess Entity Type
115
+ * @property {string} [fda] - Driver License
116
+ * @property {string} [fssai] - FDA License Number
117
+ * @property {string} [gstin] - GSTIN Number
118
+ * @property {string} [name] - Business Name
119
+ * @property {string} [pan] - Pan Number
120
+ * @property {Object} [shop_and_establishment] - Shop Establishment
121
+ * @property {string} [vintage] - Vintage
122
+ */
123
+ /**
124
+ * @typedef CancelOrResendPaymentLinkRequest
125
+ * @property {string} payment_link_id - Unique id of payment link
126
+ */
127
+ /**
128
+ * @typedef CancelPaymentLinkResponse
129
+ * @property {string} message - Message
130
+ * @property {number} status_code - HTTP status code
131
+ * @property {boolean} success - Successful or failure
132
+ */
133
+ /**
134
+ * @typedef Card
135
+ * @property {string} aggregator_name - Aggregator_name
136
+ * @property {string} [card_brand] - Card_brand
137
+ * @property {string} [card_brand_image] - Card_brand_image
138
+ * @property {string} [card_fingerprint] - Card_fingerprint
139
+ * @property {string} [card_id] - Card_id
140
+ * @property {string} [card_isin] - Card_isin
141
+ * @property {string} [card_issuer] - Card_issuer
142
+ * @property {string} [card_name] - Card_name
143
+ * @property {string} [card_number] - Card_number
144
+ * @property {string} [card_reference] - Card_reference
145
+ * @property {string} [card_token] - Card_token
146
+ * @property {string} [card_type] - Card_type
147
+ * @property {boolean} [compliant_with_tokenisation_guidelines] - If card is
148
+ * tokenised or not
149
+ * @property {number} [exp_month] - Exp_month
150
+ * @property {number} [exp_year] - Exp_year
151
+ * @property {boolean} [expired] - Expired
152
+ * @property {string} [nickname] - Nickname
153
+ */
154
+ /**
155
+ * @typedef CardDetails
156
+ * @property {string} bank - Bank name
157
+ * @property {string} bank_code - Bank Code
158
+ * @property {string} card_brand - Card brand like VISA/RUPAY
159
+ * @property {string} [card_exp_month] - Card Expire Month
160
+ * @property {string} [card_exp_year] - Card Expire Year
161
+ * @property {string} card_object - Card bin or Card refrence
162
+ * @property {string} card_sub_type - Card Sub type
163
+ * @property {string} [card_token] - Card Token
164
+ * @property {string} country - Country Name
165
+ * @property {string} extended_card_type - Extended Card Type
166
+ * @property {string} id - Id
167
+ * @property {boolean} is_domestic_card - Is card domestic or international
168
+ * @property {string} [name_on_card] - Name on Card
169
+ * @property {boolean} status - Status
170
+ * @property {string} type - Card Type Credit/Debit
171
+ * @property {string} [user] - Customer/User ID
172
+ */
173
+ /**
174
+ * @typedef CardDetailsResponse
175
+ * @property {CardDetails} data - Saved Card Details
176
+ * @property {boolean} success - Response is successful or not.
177
+ */
178
+ /**
179
+ * @typedef CardPaymentGateway
180
+ * @property {string} aggregator - Payment gateway name.
181
+ * @property {string} [api] - Payment gateway CARD api endpoint
182
+ * @property {string} [customer_id] - Payment gateway customer id.
183
+ */
184
+ /**
185
+ * @typedef ChargeCustomerRequest
186
+ * @property {string} aggregator - Payment gateway name i.e Simpl, Mswipe
187
+ * @property {number} amount - Chargable amount of order.
188
+ * @property {string} order_id - Unique order id.
189
+ * @property {string} [transaction_token] - Transaction token of payment gateway.
190
+ * @property {boolean} [verified] - Already Verified flag from payment gateway i.e Mswipe
191
+ */
192
+ /**
193
+ * @typedef ChargeCustomerResponse
194
+ * @property {string} aggregator - Payment gateway name i.e Simpl, Mswipe
195
+ * @property {string} [cart_id] - Cart id of customer
196
+ * @property {string} [delivery_address_id] - Delivery adddress id of customer
197
+ * @property {string} message - Human readable message.
198
+ * @property {string} order_id - Unique order id.
199
+ * @property {string} status - Status of charged payment.
200
+ * @property {boolean} success - Response is successful or not.
201
+ */
202
+ /**
203
+ * @typedef CheckCreditResponse
204
+ * @property {CreditDetail} data - Credit summary of user.
205
+ * @property {boolean} success - Operation is successful or not.
206
+ */
207
+ /**
208
+ * @typedef CreateOrderUserData
209
+ * @property {string} [aggregator] - Aggregator name
210
+ * @property {number} [amount] - Amount
211
+ * @property {string} [callback_url] - Callback url for aggregator
212
+ * @property {string} [contact] - Mobile number
213
+ * @property {string} [currency] - Currency
214
+ * @property {string} [customer_id] - Aggregator customer id
215
+ * @property {string} [email] - Email
216
+ * @property {string} [merchant_order_id] - Merchant order id
217
+ * @property {string} [method] - Method
218
+ * @property {string} [order_id] - Aggregator order id
219
+ */
220
+ /**
221
+ * @typedef CreateOrderUserPaymentMethods
222
+ * @property {PaymentMethodsMeta} meta - Meta
223
+ * @property {string} mode - Payment mode
224
+ * @property {string} name - Payment mode name
225
+ */
226
+ /**
227
+ * @typedef CreateOrderUserRequest
228
+ * @property {string} currency - Currency
229
+ * @property {string} failure_callback_url - Failure page url
230
+ * @property {Object} [meta] - Meta
231
+ * @property {string} payment_link_id - Unique id of payment link
232
+ * @property {CreateOrderUserPaymentMethods} payment_methods - Payment method details
233
+ * @property {string} success_callback_url - Success page url
234
+ */
235
+ /**
236
+ * @typedef CreateOrderUserResponse
237
+ * @property {string} [callback_url] - Callback url for aggregator
238
+ * @property {CreateOrderUserData} [data]
239
+ * @property {string} message - Message
240
+ * @property {string} [order_id] - Merchant order id
241
+ * @property {string} [payment_confirm_url] - Payment confirm url for aggregator
242
+ * @property {number} status_code - HTTP status code
243
+ * @property {boolean} success - Successful or failure
244
+ */
245
+ /**
246
+ * @typedef CreatePaymentLinkMeta
247
+ * @property {string} amount
248
+ * @property {string} [assign_card_id]
249
+ * @property {string} cart_id
250
+ * @property {string} checkout_mode
251
+ * @property {string} pincode
252
+ */
253
+ /**
254
+ * @typedef CreatePaymentLinkRequest
255
+ * @property {number} amount - Total value of order
256
+ * @property {string} [description] - Merchant order id
257
+ * @property {string} email - Email to which the payment link is to be sent
258
+ * @property {string} external_order_id - Merchant order id
259
+ * @property {CreatePaymentLinkMeta} meta - Meta
260
+ * @property {string} mobile_number - Mobile number to which the payment link is
261
+ * to be sent
262
+ */
263
+ /**
264
+ * @typedef CreatePaymentLinkResponse
265
+ * @property {string} message - Message
266
+ * @property {string} [payment_link_id] - Unique id of payment link
267
+ * @property {string} [payment_link_url] - Url of payment link
268
+ * @property {number} [polling_timeout] - Polling request timeout
269
+ * @property {number} status_code - HTTP status code
270
+ * @property {boolean} success - Successful or failure
271
+ */
272
+ /**
273
+ * @typedef CreditDetail
274
+ * @property {boolean} is_registered - User is registered with aggregator or not.
275
+ * @property {string} signup_url - URL to which the user may redirect.
276
+ * @property {boolean} status - Operation is successful or not.
277
+ */
278
+ /**
279
+ * @typedef CreditSummary
280
+ * @property {BalanceDetails} [amount_available] - Credit summary of user.
281
+ * @property {BalanceDetails} [balance] - Credit summary of user.
282
+ * @property {string} [buyer_status] - Status from Credit aggregator's end
283
+ * @property {string} [credit_line_id] - ID at Credit aggregator's end
284
+ * @property {string} [merchant_customer_ref_id] - Unique aggregator customer id
285
+ * @property {string} [status] - Customer Credit status
286
+ * @property {string} [status_message] - Message to customer
287
+ */
288
+ /**
289
+ * @typedef CustomerCreditSummaryResponse
290
+ * @property {CreditSummary} [data] - Credit summary of user.
291
+ * @property {boolean} success - Payment confirmation updated or not.
292
+ */
293
+ /**
294
+ * @typedef CustomerOnboardingRequest
295
+ * @property {string} aggregator - Aggregator Name
296
+ * @property {BusinessDetails} [business_info] - Business summary.
297
+ * @property {DeviceDetails} [device] - Device Details.
298
+ * @property {MarketplaceInfo} [marketplace_info] - Market Place info.
299
+ * @property {string} [mcc] - Mcc
300
+ * @property {UserPersonalInfoInDetails} personal_info - Credit summary of user.
301
+ * @property {string} source - CallbackURL
302
+ */
303
+ /**
304
+ * @typedef CustomerOnboardingResponse
305
+ * @property {OnboardSummary} data - Redirect URL.
306
+ * @property {boolean} success - Status updated or not.
307
+ */
308
+ /**
309
+ * @typedef DeleteCardsResponse
310
+ * @property {string} [message] - Human readable message.
311
+ * @property {boolean} success - Response is successful or not.
312
+ */
313
+ /**
314
+ * @typedef DeletehCardRequest
315
+ * @property {string} card_id - Card token of payment gateway.
316
+ */
317
+ /**
318
+ * @typedef DeviceDetails
319
+ * @property {string} [device_make] - Device maker
320
+ * @property {string} [device_model] - Device Model
321
+ * @property {string} [device_type] - Device Type(E.g. Mobile)
322
+ * @property {string} [identification_number] - IP
323
+ * @property {string} [identifier_type] - Static value = ip
324
+ * @property {string} [os] - OS Name
325
+ * @property {string} [os_version] - OS Version
326
+ */
327
+ /**
328
+ * @typedef EpaylaterBannerData
329
+ * @property {boolean} display - Need to display banner or not
330
+ * @property {string} [message] - EPayLater message
331
+ * @property {string} [status] - Epaylater KYC status
332
+ */
333
+ /**
334
+ * @typedef EpaylaterBannerResponse
335
+ * @property {EpaylaterBannerData} data - Epaylater KYC banner details.
336
+ * @property {boolean} success - Successful or not.
337
+ */
338
+ /**
339
+ * @typedef ErrorCodeAndDescription
340
+ * @property {string} code - Error descrption code.
341
+ * @property {string} description - Error human understandable description.
342
+ */
343
+ /**
344
+ * @typedef ErrorCodeDescription
345
+ * @property {string} code - Error descrption code.
346
+ * @property {string} description - Error human understandable description.
347
+ * @property {boolean} success - Response is successful or not
348
+ */
349
+ /**
350
+ * @typedef ErrorDescription
351
+ * @property {number} [amount] - Amount paid
352
+ * @property {boolean} [cancelled] - Payment link is cancelled or not
353
+ * @property {boolean} [expired] - Payment link expired or not
354
+ * @property {boolean} [invalid_id] - Payment link id is valid or not
355
+ * @property {string} [merchant_name] - Name of merchant that created payment link
356
+ * @property {string} [merchant_order_id] - Order id
357
+ * @property {string} [msg] - Message
358
+ * @property {string} [payment_transaction_id] - Payment transaction id
359
+ */
360
+ /**
361
+ * @typedef ErrorResponse
362
+ * @property {ErrorDescription} [error]
363
+ * @property {string} message - Message
364
+ * @property {number} status_code - HTTP status code
365
+ * @property {boolean} success - Successful or failure
366
+ */
367
+ /**
368
+ * @typedef GetPaymentLinkResponse
369
+ * @property {number} [amount] - Total value of order
370
+ * @property {string} [external_order_id] - Merchant order id
371
+ * @property {string} [merchant_name] - Merchant name
372
+ * @property {string} message - Message
373
+ * @property {string} [payment_link_current_status] - Status of payment link
374
+ * @property {string} [payment_link_url] - Url of payment link
375
+ * @property {number} [polling_timeout] - Polling request timeout
376
+ * @property {number} status_code - HTTP status code
377
+ * @property {boolean} success - Successful or failure
378
+ */
379
+ /**
380
+ * @typedef HttpErrorCodeAndResponse
381
+ * @property {ErrorCodeAndDescription} error
382
+ * @property {boolean} success - Response is successful or not
383
+ */
384
+ /**
385
+ * @typedef IfscCodeResponse
386
+ * @property {string} bank_name - Bank Name Of Account
387
+ * @property {string} branch_name - Branch Name Of Account
388
+ * @property {boolean} [success] - Response is successful or not
389
+ */
390
+ /**
391
+ * @typedef IntentApp
392
+ * @property {string} [code] - Code
393
+ * @property {string} [display_name] - Display_name
394
+ * @property {PaymentModeLogo} [logos] - Logos
395
+ * @property {string} [package_name] - Package_name
396
+ */
397
+ /**
398
+ * @typedef IntentAppErrorList
399
+ * @property {string} [code] - Code
400
+ * @property {string} [package_name] - Package_name
401
+ */
402
+ /**
403
+ * @typedef KYCAddress
404
+ * @property {string} addressline1 - Address Line 1
405
+ * @property {string} [addressline2] - Address Line 2
406
+ * @property {string} city - City
407
+ * @property {string} [land_mark] - Land Mark
408
+ * @property {string} [ownership_type] - Address Owner Type
409
+ * @property {string} pincode - Pincode
410
+ * @property {string} state - State
411
+ */
412
+ /**
413
+ * @typedef LinkStatus
414
+ * @property {string} message - Message
415
+ * @property {boolean} status - Link action status
416
+ */
417
+ /**
418
+ * @typedef ListCardsResponse
419
+ * @property {Card[]} [data] - List of cards of customer.
420
+ * @property {string} message - Human readable message.
421
+ * @property {boolean} success - Response is successful or not.
422
+ */
423
+ /**
424
+ * @typedef MarketplaceInfo
425
+ * @property {string} [date_of_joining] - Date of joining
426
+ * @property {string} membership_id - Merchant id
427
+ * @property {string} name - Name of store
428
+ */
429
+ /**
430
+ * @typedef NotFoundResourceError
431
+ * @property {string} code - Bad Request Data
432
+ * @property {string} description - Not Found
433
+ * @property {boolean} success - Response is successful or not
434
+ */
435
+ /**
436
+ * @typedef OnboardSummary
437
+ * @property {string} redirect_url - URL to which the user may redirect.
438
+ * @property {Object} session - User Session
439
+ * @property {boolean} status - Operation Status
440
+ */
441
+ /**
442
+ * @typedef OrderBeneficiaryDetails
443
+ * @property {string} account_holder - Account Holder Name
444
+ * @property {string} account_no - Account Number
445
+ * @property {string} address - Address of User
446
+ * @property {string} bank_name - Bank Name Of Account
447
+ * @property {string} beneficiary_id - Benenficiary Id
448
+ * @property {string} [branch_name] - Branch Name Of Account
449
+ * @property {string} [comment] - Remarks
450
+ * @property {string} created_on - Creation Date of Beneficiary
451
+ * @property {string} [delights_user_name] - User Id Who filled the Beneficiary
452
+ * @property {string} display_name - Display Name Of Account
453
+ * @property {string} email - EMail of User
454
+ * @property {number} id -
455
+ * @property {string} ifsc_code - Ifsc Code Of Account
456
+ * @property {boolean} is_active - Boolean Flag whether Beneficiary set or not
457
+ * @property {string} [mobile] - MObile no of User
458
+ * @property {string} modified_on - MOdification Date of Beneficiary
459
+ * @property {string} subtitle - SHort Title Of Account
460
+ * @property {string} title - Title Of Account
461
+ * @property {string} transfer_mode - Transfer Mode Of Account
462
+ */
463
+ /**
464
+ * @typedef OrderBeneficiaryResponse
465
+ * @property {OrderBeneficiaryDetails[]} [beneficiaries] - All Beneficiaries Of An Order
466
+ * @property {boolean} [show_beneficiary_details] - Show beneficiary details or not.
467
+ */
468
+ /**
469
+ * @typedef OutstandingOrderDetailsResponse
470
+ * @property {Object[]} [data] - Dict containing the outstanding order details
471
+ * @property {string} [message] - Message
472
+ * @property {number} status_code - HTTP Status code
473
+ * @property {boolean} success - Response is successful or not.
474
+ */
475
+ /**
476
+ * @typedef PaidOrderDetailsResponse
477
+ * @property {Object[]} [data] - Dict containing the paid order details
478
+ * @property {string} [message] - Message
479
+ * @property {number} status_code - HTTP Status code
480
+ * @property {boolean} success - Response is successful or not.
481
+ */
482
+ /**
483
+ * @typedef PaymentFlow
484
+ * @property {AggregatorRoute} [ajiodhan] - Ajiodhan
485
+ * @property {AggregatorRoute} [bqr_razorpay] - BQR_Razorpay
486
+ * @property {AggregatorRoute} [ccavenue] - Ccavenue
487
+ * @property {AggregatorRoute} [epaylater] - Epaylater
488
+ * @property {AggregatorRoute} [fynd] - Fynd
489
+ * @property {AggregatorRoute} [jiopay] - Jiopay
490
+ * @property {AggregatorRoute} [juspay] - Juspay
491
+ * @property {AggregatorRoute} [mswipe] - Mswipe
492
+ * @property {AggregatorRoute} [payubiz] - Payubiz
493
+ * @property {AggregatorRoute} [razorpay] - Razorpay
494
+ * @property {AggregatorRoute} [rupifi] - Rupifi
495
+ * @property {AggregatorRoute} [simpl] - Simpl
496
+ * @property {AggregatorRoute} [stripe] - Stripe
497
+ * @property {AggregatorRoute} [upi_razorpay] - UPI_Razorpay
498
+ */
499
+ /**
500
+ * @typedef PaymentInitializationRequest
501
+ * @property {string} aggregator - Payment gateway name
502
+ * @property {number} amount - Payable amount.
503
+ * @property {string} contact - Customer valid mobile number
504
+ * @property {string} currency - Currency code.
505
+ * @property {string} customer_id - Payment gateway customer id.
506
+ * @property {string} [device_id] - EDC machine Unique Identifier
507
+ * @property {string} email - Customer valid email
508
+ * @property {string} merchant_order_id - Unique fynd order id
509
+ * @property {string} method - Payment method
510
+ * @property {string} order_id - Payment gateway order id
511
+ * @property {string} [razorpay_payment_id] - Payment gateway payment id
512
+ * @property {number} [timeout] - Payment polling timeout if not recieved response
513
+ * @property {string} [vpa] - Customer vpa address
514
+ */
515
+ /**
516
+ * @typedef PaymentInitializationResponse
517
+ * @property {string} aggregator - Payment gateway name
518
+ * @property {string} [aggregator_order_id] - Payment order id
519
+ * @property {number} [amount] - Payable amount.
520
+ * @property {string} [bqr_image] - Bharath qr image url.
521
+ * @property {string} [currency] - Currency code.
522
+ * @property {string} [customer_id] - Payment gateway customer id.
523
+ * @property {string} [device_id] - EDC machine Unique Identifier
524
+ * @property {string} merchant_order_id - Order id
525
+ * @property {string} method - Payment method
526
+ * @property {string} polling_url - Polling url.
527
+ * @property {string} [razorpay_payment_id] - Payment id.
528
+ * @property {string} [status] - Status of payment.
529
+ * @property {boolean} success - Response is successful or not.
530
+ * @property {number} [timeout] - Timeout.
531
+ * @property {string} [upi_poll_url] - UPI poll url.
532
+ * @property {string} [virtual_id] - Payment virtual address.
533
+ * @property {string} [vpa] - Customer vpa address
534
+ */
535
+ /**
536
+ * @typedef PaymentMethodsMeta
537
+ * @property {string} merchant_code - Merchant code
538
+ * @property {string} payment_gateway - Payment gateway name
539
+ * @property {string} payment_identifier - Payment identifier
540
+ */
541
+ /**
542
+ * @typedef PaymentModeList
543
+ * @property {string} aggregator_name - Aggregator_name
544
+ * @property {string} [card_brand] - Card_brand
545
+ * @property {string} [card_brand_image] - Card_brand_image
546
+ * @property {string} [card_fingerprint] - Card_fingerprint
547
+ * @property {string} [card_id] - Card_id
548
+ * @property {string} [card_isin] - Card_isin
549
+ * @property {string} [card_issuer] - Card_issuer
550
+ * @property {string} [card_name] - Card_name
551
+ * @property {string} [card_number] - Card_number
552
+ * @property {string} [card_reference] - Card_reference
553
+ * @property {string} [card_token] - Card_token
554
+ * @property {string} [card_type] - Card_type
555
+ * @property {number} [cod_limit] - Cod limit
556
+ * @property {number} [cod_limit_per_order] - Cod limit per order
557
+ * @property {string} [code] - Code
558
+ * @property {boolean} [compliant_with_tokenisation_guidelines] - If card is
559
+ * tokenised or not
560
+ * @property {string} [display_name] - Display name
561
+ * @property {number} [display_priority] - Dispaly Priority
562
+ * @property {number} [exp_month] - Exp_month
563
+ * @property {number} [exp_year] - Exp_year
564
+ * @property {boolean} [expired] - Expired
565
+ * @property {string} [fynd_vpa] - Fynd_vpa
566
+ * @property {IntentApp[]} [intent_app] - Intent_app
567
+ * @property {IntentAppErrorList[]} [intent_app_error_dict_list] -
568
+ * Intent_app_error_dict_list
569
+ * @property {string[]} [intent_app_error_list] - Intent_app_error_list
570
+ * @property {boolean} [intent_flow] - Intent_flow
571
+ * @property {PaymentModeLogo} [logo_url] - Logo
572
+ * @property {string} [merchant_code] - Merchant code
573
+ * @property {string} [name] - Name
574
+ * @property {string} [nickname] - Nickname
575
+ * @property {number} [remaining_limit] - Remaining limit
576
+ * @property {number} [retry_count] - Retry_count
577
+ * @property {number} [timeout] - Timeout
578
+ */
579
+ /**
580
+ * @typedef PaymentModeLogo
581
+ * @property {string} large - Large
582
+ * @property {string} small - Smalll
583
+ */
584
+ /**
585
+ * @typedef PaymentModeRouteResponse
586
+ * @property {PaymentOptionAndFlow} payment_options - Payment_options
587
+ * @property {boolean} success - Response is successful or not
588
+ */
589
+ /**
590
+ * @typedef PaymentOptionAndFlow
591
+ * @property {PaymentFlow} payment_flows - Payment_flows
592
+ * @property {RootPaymentMode[]} payment_option - Payment options
593
+ */
594
+ /**
595
+ * @typedef PaymentStatusUpdateRequest
596
+ * @property {string} aggregator - Payment gateway name
597
+ * @property {number} amount - Payable amount.
598
+ * @property {string} contact - Customer valid mobile number
599
+ * @property {string} currency - Currency code.
600
+ * @property {string} customer_id - Payment gateway customer id.
601
+ * @property {string} [device_id] - EDC machine Unique Identifier
602
+ * @property {string} email - Customer valid email
603
+ * @property {string} merchant_order_id - Unique fynd order id
604
+ * @property {string} merchant_transaction_id - Unique fynd transaction id
605
+ * @property {string} method - Payment method
606
+ * @property {string} order_id - Payment gateway order id
607
+ * @property {string} status - Status of payment.
608
+ * @property {string} [vpa] - Customer vpa address
609
+ */
610
+ /**
611
+ * @typedef PaymentStatusUpdateResponse
612
+ * @property {string} aggregator_name - Payment gateway name
613
+ * @property {string} [redirect_url] - Redirect url
614
+ * @property {boolean} retry - Response is successful or not.
615
+ * @property {string} status - Payment status
616
+ * @property {boolean} [success] - Response is successful or not
617
+ */
618
+ /**
619
+ * @typedef PollingPaymentLinkResponse
620
+ * @property {string} [aggregator_name] - Aggregator name
621
+ * @property {number} [amount] - Amount
622
+ * @property {number} [http_status] - HTTP status code
623
+ * @property {string} [message] - Message
624
+ * @property {string} [order_id] - Fynd order id
625
+ * @property {string} [payment_link_id] - Payment link id
626
+ * @property {string} [redirect_url] - Url to redirect to
627
+ * @property {string} [status] - Status of payment link
628
+ * @property {number} [status_code] - HTTP status code
629
+ * @property {boolean} [success] - Successful or failure
630
+ */
631
+ /**
632
+ * @typedef RedirectToAggregatorResponse
633
+ * @property {RedirectURL} data - Redirect URL.
634
+ * @property {boolean} success - Status updated or not.
635
+ */
636
+ /**
637
+ * @typedef RedirectURL
638
+ * @property {string} signup_url - URL to which the user may redirect.
639
+ * @property {boolean} status - Aggregator's Operation is successful or not.
640
+ */
641
+ /**
642
+ * @typedef RefundAccountResponse
643
+ * @property {Object} [data] - Refund account data.
644
+ * @property {boolean} [is_verified_flag]
645
+ * @property {string} message - Response message
646
+ * @property {boolean} success - Success or failure flag.
647
+ */
648
+ /**
649
+ * @typedef renderHTMLRequest
650
+ * @property {string} base64_html - Base64 encoded html string
651
+ * @property {string} [returntype] - Return Type of API
652
+ */
653
+ /**
654
+ * @typedef renderHTMLResponse
655
+ * @property {string} html - HTML string
656
+ */
657
+ /**
658
+ * @typedef ResendOrCancelPaymentRequest
659
+ * @property {string} [device_id] - EDC machine Unique Identifier
660
+ * @property {string} order_id - Unique order id
661
+ * @property {string} request_type - Either resend or cancel
662
+ */
663
+ /**
664
+ * @typedef ResendOrCancelPaymentResponse
665
+ * @property {LinkStatus} data - Data about link action status.
666
+ * @property {boolean} success - Response is successful or not.
667
+ */
668
+ /**
669
+ * @typedef ResendPaymentLinkResponse
670
+ * @property {string} message - Message
671
+ * @property {number} [polling_timeout] - Polling request timeout
672
+ * @property {number} status_code - HTTP status code
673
+ * @property {boolean} success - Successful or failure
674
+ */
675
+ /**
676
+ * @typedef RootPaymentMode
677
+ * @property {boolean} [add_card_enabled] - Annonymous card flag
678
+ * @property {string} [aggregator_name] - Dispaly Priority
679
+ * @property {boolean} [anonymous_enable] - Annonymous card flag
680
+ * @property {string} display_name - Payment mode display name
681
+ * @property {number} display_priority - Dispaly Priority
682
+ * @property {boolean} [is_pay_by_card_pl] - This flag will be true in case of
683
+ * Payment link payment through card
684
+ * @property {PaymentModeList[]} [list] - Payment mode
685
+ * @property {string} name - Payment mode name
686
+ * @property {boolean} [save_card] - Card save or not
687
+ */
688
+ /**
689
+ * @typedef RupifiBannerData
690
+ * @property {string} [kyc_url] - Rupifi KYC banner url.
691
+ * @property {string} [status] - Rupifi KYC status
692
+ */
693
+ /**
694
+ * @typedef RupifiBannerResponse
695
+ * @property {RupifiBannerData} data - Rupifi KYC banner details.
696
+ * @property {boolean} success - Successful or not.
697
+ */
698
+ /**
699
+ * @typedef SetDefaultBeneficiaryRequest
700
+ * @property {string} beneficiary_id - Beneficiary Hash Id of the beneficiary added
701
+ * @property {string} order_id - Merchant Order Id
702
+ */
703
+ /**
704
+ * @typedef SetDefaultBeneficiaryResponse
705
+ * @property {boolean} is_beneficiary_set - Boolean Flag whether Beneficiary set or not
706
+ * @property {boolean} [success] - Response is successful or not
707
+ */
708
+ /**
709
+ * @typedef TransferItemsDetails
710
+ * @property {string} [display_name] - Beneficiary Display Name
711
+ * @property {number} id -
712
+ * @property {string} logo_large - Beneficiary large Logo
713
+ * @property {string} logo_small - Beneficiary small Logo
714
+ * @property {string} name - Beneficiary Name
715
+ */
716
+ /**
717
+ * @typedef TransferModeDetails
718
+ * @property {string} display_name - Beneficiary Mode Name
719
+ * @property {TransferItemsDetails[]} [items] - Beneficiary Mode Items
720
+ */
721
+ /**
722
+ * @typedef TransferModeResponse
723
+ * @property {TransferModeDetails[]} data - Response Object
724
+ */
725
+ /**
726
+ * @typedef UpdateRefundTransferModeRequest
727
+ * @property {boolean} enable - True for enabling the Transfer Mode
728
+ * @property {string} transfer_mode - Transfer Mode of the Beneficiary to be added
729
+ */
730
+ /**
731
+ * @typedef UpdateRefundTransferModeResponse
732
+ * @property {boolean} [success] - Response is successful or not
733
+ */
734
+ /**
735
+ * @typedef UserPersonalInfoInDetails
736
+ * @property {KYCAddress} address_as_per_id - Address details
737
+ * @property {string} dob - DOB
738
+ * @property {string} [driving_license] - Driver License
739
+ * @property {string} [email] - Email
740
+ * @property {boolean} email_verified - Is Email Verified or not
741
+ * @property {string} [fathers_name] - Father's Name
742
+ * @property {string} first_name - First Name
743
+ * @property {string} [gender] - Gender
744
+ * @property {string} [last_name] - Last Name
745
+ * @property {string} [middle_name] - Middle Name
746
+ * @property {boolean} mobile_verified - Is Mobile Verified or not
747
+ * @property {string} [mothers_name] - Mother's Name
748
+ * @property {string} [pan] - Pan Number
749
+ * @property {string} [passport] - Passport
750
+ * @property {string} phone - Email
751
+ * @property {string} [voter_id] - Voter ID Number
752
+ */
753
+ /**
754
+ * @typedef ValidateCustomerRequest
755
+ * @property {string} aggregator - Payment gateway name in camel case i.e Simpl, Rupifi
756
+ * @property {Object} [billing_address] - Extra meta fields.
757
+ * @property {Object} [delivery_address] - Extra meta fields.
758
+ * @property {Object} [merchant_params] - Extra meta fields.
759
+ * @property {Object[]} [order_items] - Extra meta fields.
760
+ * @property {string} [payload] - Hashed payload string.
761
+ * @property {string} phone_number - User mobile number without country code.
762
+ * @property {number} transaction_amount_in_paise - Payable amount in paise
763
+ */
764
+ /**
765
+ * @typedef ValidateCustomerResponse
766
+ * @property {Object} data - Payment gateway response data
767
+ * @property {string} message - Error or success message.
768
+ * @property {boolean} success - Response is successful or not
769
+ */
770
+ /**
771
+ * @typedef ValidateUPI
772
+ * @property {string} customer_name - Customer Bank
773
+ * @property {boolean} is_valid - Boolean is true or false.
774
+ * @property {string} status - VALID or INVALID
775
+ * @property {string} upi_vpa - UPI ID
776
+ */
777
+ /**
778
+ * @typedef ValidateVPARequest
779
+ * @property {string} upi_vpa - UPI ID
780
+ */
781
+ /**
782
+ * @typedef ValidateVPAResponse
783
+ * @property {ValidateUPI} data - Data about UPI ID validate.
784
+ * @property {boolean} success - Response is successful or not.
785
+ */
786
+ /**
787
+ * @typedef WalletOtpRequest
788
+ * @property {string} country_code - Country Code of the Mobile Number
789
+ * @property {string} mobile - Wallet Moblie Number of the User
790
+ */
791
+ /**
792
+ * @typedef WalletOtpResponse
793
+ * @property {string} is_verified_flag - Boolean Flag whether OTP Validation is
794
+ * already done or not
795
+ * @property {string} request_id - Request id
796
+ * @property {boolean} [success] - Response is successful or not
797
+ */
798
+ /**
799
+ * @typedef WrongOtpError
800
+ * @property {string} description - Wrong OTP Code
801
+ * @property {boolean} is_verified_flag - Vefified flag.
802
+ * @property {string} success - Response is successful or not
803
+ */
804
+ declare class PaymentApplicationModel {
100
805
  }
806
+ declare namespace PaymentApplicationModel {
807
+ export { ActiveCardPaymentGatewayResponse, AddBeneficiaryDetailsOTPRequest, AddBeneficiaryDetailsRequest, AddBeneficiaryViaOtpVerificationRequest, AddBeneficiaryViaOtpVerificationResponse, AggregatorConfigDetail, AggregatorRoute, AggregatorsConfigDetailResponse, AttachCardRequest, AttachCardsResponse, BalanceDetails, BankDetailsForOTP, BeneficiaryModeDetails, BusinessDetails, CancelOrResendPaymentLinkRequest, CancelPaymentLinkResponse, Card, CardDetails, CardDetailsResponse, CardPaymentGateway, ChargeCustomerRequest, ChargeCustomerResponse, CheckCreditResponse, CreateOrderUserData, CreateOrderUserPaymentMethods, CreateOrderUserRequest, CreateOrderUserResponse, CreatePaymentLinkMeta, CreatePaymentLinkRequest, CreatePaymentLinkResponse, CreditDetail, CreditSummary, CustomerCreditSummaryResponse, CustomerOnboardingRequest, CustomerOnboardingResponse, DeleteCardsResponse, DeletehCardRequest, DeviceDetails, EpaylaterBannerData, EpaylaterBannerResponse, ErrorCodeAndDescription, ErrorCodeDescription, ErrorDescription, ErrorResponse, GetPaymentLinkResponse, HttpErrorCodeAndResponse, IfscCodeResponse, IntentApp, IntentAppErrorList, KYCAddress, LinkStatus, ListCardsResponse, MarketplaceInfo, NotFoundResourceError, OnboardSummary, OrderBeneficiaryDetails, OrderBeneficiaryResponse, OutstandingOrderDetailsResponse, PaidOrderDetailsResponse, PaymentFlow, PaymentInitializationRequest, PaymentInitializationResponse, PaymentMethodsMeta, PaymentModeList, PaymentModeLogo, PaymentModeRouteResponse, PaymentOptionAndFlow, PaymentStatusUpdateRequest, PaymentStatusUpdateResponse, PollingPaymentLinkResponse, RedirectToAggregatorResponse, RedirectURL, RefundAccountResponse, renderHTMLRequest, renderHTMLResponse, ResendOrCancelPaymentRequest, ResendOrCancelPaymentResponse, ResendPaymentLinkResponse, RootPaymentMode, RupifiBannerData, RupifiBannerResponse, SetDefaultBeneficiaryRequest, SetDefaultBeneficiaryResponse, TransferItemsDetails, TransferModeDetails, TransferModeResponse, UpdateRefundTransferModeRequest, UpdateRefundTransferModeResponse, UserPersonalInfoInDetails, ValidateCustomerRequest, ValidateCustomerResponse, ValidateUPI, ValidateVPARequest, ValidateVPAResponse, WalletOtpRequest, WalletOtpResponse, WrongOtpError };
808
+ }
809
+ /** @returns {ActiveCardPaymentGatewayResponse} */
810
+ declare function ActiveCardPaymentGatewayResponse(): ActiveCardPaymentGatewayResponse;
811
+ type ActiveCardPaymentGatewayResponse = {
812
+ /**
813
+ * - Card's payment gateway with customer id.
814
+ */
815
+ cards: CardPaymentGateway;
816
+ /**
817
+ * - Human readable message.
818
+ */
819
+ message: string;
820
+ /**
821
+ * - Response is successful or not.
822
+ */
823
+ success: boolean;
824
+ };
825
+ /** @returns {AddBeneficiaryDetailsOTPRequest} */
826
+ declare function AddBeneficiaryDetailsOTPRequest(): AddBeneficiaryDetailsOTPRequest;
827
+ type AddBeneficiaryDetailsOTPRequest = {
828
+ details: BankDetailsForOTP;
829
+ order_id: string;
830
+ };
831
+ /** @returns {AddBeneficiaryDetailsRequest} */
832
+ declare function AddBeneficiaryDetailsRequest(): AddBeneficiaryDetailsRequest;
833
+ type AddBeneficiaryDetailsRequest = {
834
+ /**
835
+ * - True if beneficiary to be added by delights or
836
+ * False if by User
837
+ */
838
+ delights: boolean;
839
+ /**
840
+ * - Beneficiary bank details
841
+ */
842
+ details: BeneficiaryModeDetails;
843
+ /**
844
+ * - Merchant Order Id
845
+ */
846
+ order_id: string;
847
+ otp?: string;
848
+ request_id?: string;
849
+ /**
850
+ * - Shipment Id of the respective Merchant Order Id
851
+ */
852
+ shipment_id: string;
853
+ /**
854
+ * - Transfer Mode of the Beneficiary to be added
855
+ */
856
+ transfer_mode: string;
857
+ };
858
+ /** @returns {AddBeneficiaryViaOtpVerificationRequest} */
859
+ declare function AddBeneficiaryViaOtpVerificationRequest(): AddBeneficiaryViaOtpVerificationRequest;
860
+ type AddBeneficiaryViaOtpVerificationRequest = {
861
+ /**
862
+ * - Hash key of the beneficiary Id
863
+ */
864
+ hash_key: string;
865
+ /**
866
+ * - Otp sent to the given Mobile No
867
+ */
868
+ otp: string;
869
+ /**
870
+ * - Request Id sent in
871
+ */
872
+ request_id: string;
873
+ };
874
+ /** @returns {AddBeneficiaryViaOtpVerificationResponse} */
875
+ declare function AddBeneficiaryViaOtpVerificationResponse(): AddBeneficiaryViaOtpVerificationResponse;
876
+ type AddBeneficiaryViaOtpVerificationResponse = {
877
+ /**
878
+ * - Aggregator Response of beneficicary
879
+ */
880
+ message: string;
881
+ /**
882
+ * - Response is successful or not
883
+ */
884
+ success?: boolean;
885
+ };
886
+ /** @returns {AggregatorConfigDetail} */
887
+ declare function AggregatorConfigDetail(): AggregatorConfigDetail;
888
+ type AggregatorConfigDetail = {
889
+ /**
890
+ * - Payment gateway api endpoint
891
+ */
892
+ api?: string;
893
+ /**
894
+ * - Fynd or self payment gateway
895
+ */
896
+ config_type: string;
897
+ /**
898
+ * - Payment gateway api key
899
+ */
900
+ key: string;
901
+ /**
902
+ * - Unique merchant id
903
+ */
904
+ merchant_id?: string;
905
+ /**
906
+ * - Unique merchant key
907
+ */
908
+ merchant_key?: string;
909
+ /**
910
+ * - Masked pin
911
+ */
912
+ pin?: string;
913
+ /**
914
+ * - SDK
915
+ */
916
+ sdk?: boolean;
917
+ /**
918
+ * - Masked payment gateway api secret
919
+ */
920
+ secret: string;
921
+ /**
922
+ * - Registered User id
923
+ */
924
+ user_id?: string;
925
+ /**
926
+ * - Payment gateway verify payment api endpoint
927
+ */
928
+ verify_api?: string;
929
+ };
930
+ /** @returns {AggregatorRoute} */
931
+ declare function AggregatorRoute(): AggregatorRoute;
932
+ type AggregatorRoute = {
933
+ /**
934
+ * - Api_link
935
+ */
936
+ api_link?: string;
937
+ /**
938
+ * - Data
939
+ */
940
+ data?: any;
941
+ /**
942
+ * - Payment_flow
943
+ */
944
+ payment_flow?: string;
945
+ /**
946
+ * - Payment_flow_data
947
+ */
948
+ payment_flow_data?: string;
949
+ };
950
+ /** @returns {AggregatorsConfigDetailResponse} */
951
+ declare function AggregatorsConfigDetailResponse(): AggregatorsConfigDetailResponse;
952
+ type AggregatorsConfigDetailResponse = {
953
+ ccavenue?: AggregatorConfigDetail;
954
+ /**
955
+ * - Environment i.e Live or Test
956
+ */
957
+ env: string;
958
+ juspay?: AggregatorConfigDetail;
959
+ mswipe?: AggregatorConfigDetail;
960
+ payumoney?: AggregatorConfigDetail;
961
+ razorpay?: AggregatorConfigDetail;
962
+ rupifi?: AggregatorConfigDetail;
963
+ simpl?: AggregatorConfigDetail;
964
+ stripe?: AggregatorConfigDetail;
965
+ success: boolean;
966
+ };
967
+ /** @returns {AttachCardRequest} */
968
+ declare function AttachCardRequest(): AttachCardRequest;
969
+ type AttachCardRequest = {
970
+ /**
971
+ * - Card token of payment gateway.
972
+ */
973
+ card_id: string;
974
+ name_on_card?: string;
975
+ nickname?: string;
976
+ /**
977
+ * - Refresh cache flag.
978
+ */
979
+ refresh?: boolean;
980
+ };
981
+ /** @returns {AttachCardsResponse} */
982
+ declare function AttachCardsResponse(): AttachCardsResponse;
983
+ type AttachCardsResponse = {
984
+ /**
985
+ * - List of cards of customer.
986
+ */
987
+ data: any;
988
+ /**
989
+ * - Human readable message.
990
+ */
991
+ message?: string;
992
+ /**
993
+ * - Response is successful or not.
994
+ */
995
+ success: boolean;
996
+ };
997
+ /** @returns {BalanceDetails} */
998
+ declare function BalanceDetails(): BalanceDetails;
999
+ type BalanceDetails = {
1000
+ /**
1001
+ * - Currency Code
1002
+ */
1003
+ currency?: string;
1004
+ /**
1005
+ * - Formated Amount with currency symbol
1006
+ */
1007
+ formatted_value?: string;
1008
+ /**
1009
+ * - Payment amount
1010
+ */
1011
+ value?: number;
1012
+ };
1013
+ /** @returns {BankDetailsForOTP} */
1014
+ declare function BankDetailsForOTP(): BankDetailsForOTP;
1015
+ type BankDetailsForOTP = {
1016
+ account_holder: string;
1017
+ account_no: string;
1018
+ bank_name: string;
1019
+ branch_name: string;
1020
+ ifsc_code: string;
1021
+ };
1022
+ /** @returns {BeneficiaryModeDetails} */
1023
+ declare function BeneficiaryModeDetails(): BeneficiaryModeDetails;
1024
+ type BeneficiaryModeDetails = {
1025
+ /**
1026
+ * - Name of the Account Holder
1027
+ */
1028
+ account_holder: string;
1029
+ /**
1030
+ * - Account NUmber of the Account Holder
1031
+ */
1032
+ account_no: string;
1033
+ /**
1034
+ * - Address of the User
1035
+ */
1036
+ address?: string;
1037
+ /**
1038
+ * - Bank Name of the Account
1039
+ */
1040
+ bank_name: string;
1041
+ /**
1042
+ * - Branch Name of the Account
1043
+ */
1044
+ branch_name: string;
1045
+ /**
1046
+ * - Remarks added by The user
1047
+ */
1048
+ comment?: string;
1049
+ /**
1050
+ * - Email of the Account Holder
1051
+ */
1052
+ email: string;
1053
+ /**
1054
+ * - Ifsc Code of the Account
1055
+ */
1056
+ ifsc_code: string;
1057
+ /**
1058
+ * - Moblie Number of the User
1059
+ */
1060
+ mobile: string;
1061
+ vpa?: string;
1062
+ wallet?: string;
1063
+ };
1064
+ /** @returns {BusinessDetails} */
1065
+ declare function BusinessDetails(): BusinessDetails;
1066
+ type BusinessDetails = {
1067
+ /**
1068
+ * - Address details
1069
+ */
1070
+ address?: KYCAddress;
1071
+ /**
1072
+ * - Business Ownershipp type(e.g Rented)
1073
+ */
1074
+ business_ownership_type?: string;
1075
+ /**
1076
+ * - Business Type
1077
+ */
1078
+ business_type?: string;
1079
+ /**
1080
+ * - Busineess Entity Type
1081
+ */
1082
+ entity_type?: string;
1083
+ /**
1084
+ * - Driver License
1085
+ */
1086
+ fda?: string;
1087
+ /**
1088
+ * - FDA License Number
1089
+ */
1090
+ fssai?: string;
1091
+ /**
1092
+ * - GSTIN Number
1093
+ */
1094
+ gstin?: string;
1095
+ /**
1096
+ * - Business Name
1097
+ */
1098
+ name?: string;
1099
+ /**
1100
+ * - Pan Number
1101
+ */
1102
+ pan?: string;
1103
+ /**
1104
+ * - Shop Establishment
1105
+ */
1106
+ shop_and_establishment?: any;
1107
+ /**
1108
+ * - Vintage
1109
+ */
1110
+ vintage?: string;
1111
+ };
1112
+ /** @returns {CancelOrResendPaymentLinkRequest} */
1113
+ declare function CancelOrResendPaymentLinkRequest(): CancelOrResendPaymentLinkRequest;
1114
+ type CancelOrResendPaymentLinkRequest = {
1115
+ /**
1116
+ * - Unique id of payment link
1117
+ */
1118
+ payment_link_id: string;
1119
+ };
1120
+ /** @returns {CancelPaymentLinkResponse} */
1121
+ declare function CancelPaymentLinkResponse(): CancelPaymentLinkResponse;
1122
+ type CancelPaymentLinkResponse = {
1123
+ /**
1124
+ * - Message
1125
+ */
1126
+ message: string;
1127
+ /**
1128
+ * - HTTP status code
1129
+ */
1130
+ status_code: number;
1131
+ /**
1132
+ * - Successful or failure
1133
+ */
1134
+ success: boolean;
1135
+ };
1136
+ /** @returns {Card} */
1137
+ declare function Card(): Card;
1138
+ type Card = {
1139
+ /**
1140
+ * - Aggregator_name
1141
+ */
1142
+ aggregator_name: string;
1143
+ /**
1144
+ * - Card_brand
1145
+ */
1146
+ card_brand?: string;
1147
+ /**
1148
+ * - Card_brand_image
1149
+ */
1150
+ card_brand_image?: string;
1151
+ /**
1152
+ * - Card_fingerprint
1153
+ */
1154
+ card_fingerprint?: string;
1155
+ /**
1156
+ * - Card_id
1157
+ */
1158
+ card_id?: string;
1159
+ /**
1160
+ * - Card_isin
1161
+ */
1162
+ card_isin?: string;
1163
+ /**
1164
+ * - Card_issuer
1165
+ */
1166
+ card_issuer?: string;
1167
+ /**
1168
+ * - Card_name
1169
+ */
1170
+ card_name?: string;
1171
+ /**
1172
+ * - Card_number
1173
+ */
1174
+ card_number?: string;
1175
+ /**
1176
+ * - Card_reference
1177
+ */
1178
+ card_reference?: string;
1179
+ /**
1180
+ * - Card_token
1181
+ */
1182
+ card_token?: string;
1183
+ /**
1184
+ * - Card_type
1185
+ */
1186
+ card_type?: string;
1187
+ /**
1188
+ * - If card is
1189
+ * tokenised or not
1190
+ */
1191
+ compliant_with_tokenisation_guidelines?: boolean;
1192
+ /**
1193
+ * - Exp_month
1194
+ */
1195
+ exp_month?: number;
1196
+ /**
1197
+ * - Exp_year
1198
+ */
1199
+ exp_year?: number;
1200
+ /**
1201
+ * - Expired
1202
+ */
1203
+ expired?: boolean;
1204
+ /**
1205
+ * - Nickname
1206
+ */
1207
+ nickname?: string;
1208
+ };
1209
+ /** @returns {CardDetails} */
1210
+ declare function CardDetails(): CardDetails;
1211
+ type CardDetails = {
1212
+ /**
1213
+ * - Bank name
1214
+ */
1215
+ bank: string;
1216
+ /**
1217
+ * - Bank Code
1218
+ */
1219
+ bank_code: string;
1220
+ /**
1221
+ * - Card brand like VISA/RUPAY
1222
+ */
1223
+ card_brand: string;
1224
+ /**
1225
+ * - Card Expire Month
1226
+ */
1227
+ card_exp_month?: string;
1228
+ /**
1229
+ * - Card Expire Year
1230
+ */
1231
+ card_exp_year?: string;
1232
+ /**
1233
+ * - Card bin or Card refrence
1234
+ */
1235
+ card_object: string;
1236
+ /**
1237
+ * - Card Sub type
1238
+ */
1239
+ card_sub_type: string;
1240
+ /**
1241
+ * - Card Token
1242
+ */
1243
+ card_token?: string;
1244
+ /**
1245
+ * - Country Name
1246
+ */
1247
+ country: string;
1248
+ /**
1249
+ * - Extended Card Type
1250
+ */
1251
+ extended_card_type: string;
1252
+ /**
1253
+ * - Id
1254
+ */
1255
+ id: string;
1256
+ /**
1257
+ * - Is card domestic or international
1258
+ */
1259
+ is_domestic_card: boolean;
1260
+ /**
1261
+ * - Name on Card
1262
+ */
1263
+ name_on_card?: string;
1264
+ /**
1265
+ * - Status
1266
+ */
1267
+ status: boolean;
1268
+ /**
1269
+ * - Card Type Credit/Debit
1270
+ */
1271
+ type: string;
1272
+ /**
1273
+ * - Customer/User ID
1274
+ */
1275
+ user?: string;
1276
+ };
1277
+ /** @returns {CardDetailsResponse} */
1278
+ declare function CardDetailsResponse(): CardDetailsResponse;
1279
+ type CardDetailsResponse = {
1280
+ /**
1281
+ * - Saved Card Details
1282
+ */
1283
+ data: CardDetails;
1284
+ /**
1285
+ * - Response is successful or not.
1286
+ */
1287
+ success: boolean;
1288
+ };
1289
+ /** @returns {CardPaymentGateway} */
1290
+ declare function CardPaymentGateway(): CardPaymentGateway;
1291
+ type CardPaymentGateway = {
1292
+ /**
1293
+ * - Payment gateway name.
1294
+ */
1295
+ aggregator: string;
1296
+ /**
1297
+ * - Payment gateway CARD api endpoint
1298
+ */
1299
+ api?: string;
1300
+ /**
1301
+ * - Payment gateway customer id.
1302
+ */
1303
+ customer_id?: string;
1304
+ };
1305
+ /** @returns {ChargeCustomerRequest} */
1306
+ declare function ChargeCustomerRequest(): ChargeCustomerRequest;
1307
+ type ChargeCustomerRequest = {
1308
+ /**
1309
+ * - Payment gateway name i.e Simpl, Mswipe
1310
+ */
1311
+ aggregator: string;
1312
+ /**
1313
+ * - Chargable amount of order.
1314
+ */
1315
+ amount: number;
1316
+ /**
1317
+ * - Unique order id.
1318
+ */
1319
+ order_id: string;
1320
+ /**
1321
+ * - Transaction token of payment gateway.
1322
+ */
1323
+ transaction_token?: string;
1324
+ /**
1325
+ * - Already Verified flag from payment gateway i.e Mswipe
1326
+ */
1327
+ verified?: boolean;
1328
+ };
1329
+ /** @returns {ChargeCustomerResponse} */
1330
+ declare function ChargeCustomerResponse(): ChargeCustomerResponse;
1331
+ type ChargeCustomerResponse = {
1332
+ /**
1333
+ * - Payment gateway name i.e Simpl, Mswipe
1334
+ */
1335
+ aggregator: string;
1336
+ /**
1337
+ * - Cart id of customer
1338
+ */
1339
+ cart_id?: string;
1340
+ /**
1341
+ * - Delivery adddress id of customer
1342
+ */
1343
+ delivery_address_id?: string;
1344
+ /**
1345
+ * - Human readable message.
1346
+ */
1347
+ message: string;
1348
+ /**
1349
+ * - Unique order id.
1350
+ */
1351
+ order_id: string;
1352
+ /**
1353
+ * - Status of charged payment.
1354
+ */
1355
+ status: string;
1356
+ /**
1357
+ * - Response is successful or not.
1358
+ */
1359
+ success: boolean;
1360
+ };
1361
+ /** @returns {CheckCreditResponse} */
1362
+ declare function CheckCreditResponse(): CheckCreditResponse;
1363
+ type CheckCreditResponse = {
1364
+ /**
1365
+ * - Credit summary of user.
1366
+ */
1367
+ data: CreditDetail;
1368
+ /**
1369
+ * - Operation is successful or not.
1370
+ */
1371
+ success: boolean;
1372
+ };
1373
+ /** @returns {CreateOrderUserData} */
1374
+ declare function CreateOrderUserData(): CreateOrderUserData;
1375
+ type CreateOrderUserData = {
1376
+ /**
1377
+ * - Aggregator name
1378
+ */
1379
+ aggregator?: string;
1380
+ /**
1381
+ * - Amount
1382
+ */
1383
+ amount?: number;
1384
+ /**
1385
+ * - Callback url for aggregator
1386
+ */
1387
+ callback_url?: string;
1388
+ /**
1389
+ * - Mobile number
1390
+ */
1391
+ contact?: string;
1392
+ /**
1393
+ * - Currency
1394
+ */
1395
+ currency?: string;
1396
+ /**
1397
+ * - Aggregator customer id
1398
+ */
1399
+ customer_id?: string;
1400
+ /**
1401
+ * - Email
1402
+ */
1403
+ email?: string;
1404
+ /**
1405
+ * - Merchant order id
1406
+ */
1407
+ merchant_order_id?: string;
1408
+ /**
1409
+ * - Method
1410
+ */
1411
+ method?: string;
1412
+ /**
1413
+ * - Aggregator order id
1414
+ */
1415
+ order_id?: string;
1416
+ };
1417
+ /** @returns {CreateOrderUserPaymentMethods} */
1418
+ declare function CreateOrderUserPaymentMethods(): CreateOrderUserPaymentMethods;
1419
+ type CreateOrderUserPaymentMethods = {
1420
+ /**
1421
+ * - Meta
1422
+ */
1423
+ meta: PaymentMethodsMeta;
1424
+ /**
1425
+ * - Payment mode
1426
+ */
1427
+ mode: string;
1428
+ /**
1429
+ * - Payment mode name
1430
+ */
1431
+ name: string;
1432
+ };
1433
+ /** @returns {CreateOrderUserRequest} */
1434
+ declare function CreateOrderUserRequest(): CreateOrderUserRequest;
1435
+ type CreateOrderUserRequest = {
1436
+ /**
1437
+ * - Currency
1438
+ */
1439
+ currency: string;
1440
+ /**
1441
+ * - Failure page url
1442
+ */
1443
+ failure_callback_url: string;
1444
+ /**
1445
+ * - Meta
1446
+ */
1447
+ meta?: any;
1448
+ /**
1449
+ * - Unique id of payment link
1450
+ */
1451
+ payment_link_id: string;
1452
+ /**
1453
+ * - Payment method details
1454
+ */
1455
+ payment_methods: CreateOrderUserPaymentMethods;
1456
+ /**
1457
+ * - Success page url
1458
+ */
1459
+ success_callback_url: string;
1460
+ };
1461
+ /** @returns {CreateOrderUserResponse} */
1462
+ declare function CreateOrderUserResponse(): CreateOrderUserResponse;
1463
+ type CreateOrderUserResponse = {
1464
+ /**
1465
+ * - Callback url for aggregator
1466
+ */
1467
+ callback_url?: string;
1468
+ data?: CreateOrderUserData;
1469
+ /**
1470
+ * - Message
1471
+ */
1472
+ message: string;
1473
+ /**
1474
+ * - Merchant order id
1475
+ */
1476
+ order_id?: string;
1477
+ /**
1478
+ * - Payment confirm url for aggregator
1479
+ */
1480
+ payment_confirm_url?: string;
1481
+ /**
1482
+ * - HTTP status code
1483
+ */
1484
+ status_code: number;
1485
+ /**
1486
+ * - Successful or failure
1487
+ */
1488
+ success: boolean;
1489
+ };
1490
+ /** @returns {CreatePaymentLinkMeta} */
1491
+ declare function CreatePaymentLinkMeta(): CreatePaymentLinkMeta;
1492
+ type CreatePaymentLinkMeta = {
1493
+ amount: string;
1494
+ assign_card_id?: string;
1495
+ cart_id: string;
1496
+ checkout_mode: string;
1497
+ pincode: string;
1498
+ };
1499
+ /** @returns {CreatePaymentLinkRequest} */
1500
+ declare function CreatePaymentLinkRequest(): CreatePaymentLinkRequest;
1501
+ type CreatePaymentLinkRequest = {
1502
+ /**
1503
+ * - Total value of order
1504
+ */
1505
+ amount: number;
1506
+ /**
1507
+ * - Merchant order id
1508
+ */
1509
+ description?: string;
1510
+ /**
1511
+ * - Email to which the payment link is to be sent
1512
+ */
1513
+ email: string;
1514
+ /**
1515
+ * - Merchant order id
1516
+ */
1517
+ external_order_id: string;
1518
+ /**
1519
+ * - Meta
1520
+ */
1521
+ meta: CreatePaymentLinkMeta;
1522
+ /**
1523
+ * - Mobile number to which the payment link is
1524
+ * to be sent
1525
+ */
1526
+ mobile_number: string;
1527
+ };
1528
+ /** @returns {CreatePaymentLinkResponse} */
1529
+ declare function CreatePaymentLinkResponse(): CreatePaymentLinkResponse;
1530
+ type CreatePaymentLinkResponse = {
1531
+ /**
1532
+ * - Message
1533
+ */
1534
+ message: string;
1535
+ /**
1536
+ * - Unique id of payment link
1537
+ */
1538
+ payment_link_id?: string;
1539
+ /**
1540
+ * - Url of payment link
1541
+ */
1542
+ payment_link_url?: string;
1543
+ /**
1544
+ * - Polling request timeout
1545
+ */
1546
+ polling_timeout?: number;
1547
+ /**
1548
+ * - HTTP status code
1549
+ */
1550
+ status_code: number;
1551
+ /**
1552
+ * - Successful or failure
1553
+ */
1554
+ success: boolean;
1555
+ };
1556
+ /** @returns {CreditDetail} */
1557
+ declare function CreditDetail(): CreditDetail;
1558
+ type CreditDetail = {
1559
+ /**
1560
+ * - User is registered with aggregator or not.
1561
+ */
1562
+ is_registered: boolean;
1563
+ /**
1564
+ * - URL to which the user may redirect.
1565
+ */
1566
+ signup_url: string;
1567
+ /**
1568
+ * - Operation is successful or not.
1569
+ */
1570
+ status: boolean;
1571
+ };
1572
+ /** @returns {CreditSummary} */
1573
+ declare function CreditSummary(): CreditSummary;
1574
+ type CreditSummary = {
1575
+ /**
1576
+ * - Credit summary of user.
1577
+ */
1578
+ amount_available?: BalanceDetails;
1579
+ /**
1580
+ * - Credit summary of user.
1581
+ */
1582
+ balance?: BalanceDetails;
1583
+ /**
1584
+ * - Status from Credit aggregator's end
1585
+ */
1586
+ buyer_status?: string;
1587
+ /**
1588
+ * - ID at Credit aggregator's end
1589
+ */
1590
+ credit_line_id?: string;
1591
+ /**
1592
+ * - Unique aggregator customer id
1593
+ */
1594
+ merchant_customer_ref_id?: string;
1595
+ /**
1596
+ * - Customer Credit status
1597
+ */
1598
+ status?: string;
1599
+ /**
1600
+ * - Message to customer
1601
+ */
1602
+ status_message?: string;
1603
+ };
1604
+ /** @returns {CustomerCreditSummaryResponse} */
1605
+ declare function CustomerCreditSummaryResponse(): CustomerCreditSummaryResponse;
1606
+ type CustomerCreditSummaryResponse = {
1607
+ /**
1608
+ * - Credit summary of user.
1609
+ */
1610
+ data?: CreditSummary;
1611
+ /**
1612
+ * - Payment confirmation updated or not.
1613
+ */
1614
+ success: boolean;
1615
+ };
1616
+ /** @returns {CustomerOnboardingRequest} */
1617
+ declare function CustomerOnboardingRequest(): CustomerOnboardingRequest;
1618
+ type CustomerOnboardingRequest = {
1619
+ /**
1620
+ * - Aggregator Name
1621
+ */
1622
+ aggregator: string;
1623
+ /**
1624
+ * - Business summary.
1625
+ */
1626
+ business_info?: BusinessDetails;
1627
+ /**
1628
+ * - Device Details.
1629
+ */
1630
+ device?: DeviceDetails;
1631
+ /**
1632
+ * - Market Place info.
1633
+ */
1634
+ marketplace_info?: MarketplaceInfo;
1635
+ /**
1636
+ * - Mcc
1637
+ */
1638
+ mcc?: string;
1639
+ /**
1640
+ * - Credit summary of user.
1641
+ */
1642
+ personal_info: UserPersonalInfoInDetails;
1643
+ /**
1644
+ * - CallbackURL
1645
+ */
1646
+ source: string;
1647
+ };
1648
+ /** @returns {CustomerOnboardingResponse} */
1649
+ declare function CustomerOnboardingResponse(): CustomerOnboardingResponse;
1650
+ type CustomerOnboardingResponse = {
1651
+ /**
1652
+ * - Redirect URL.
1653
+ */
1654
+ data: OnboardSummary;
1655
+ /**
1656
+ * - Status updated or not.
1657
+ */
1658
+ success: boolean;
1659
+ };
1660
+ /** @returns {DeleteCardsResponse} */
1661
+ declare function DeleteCardsResponse(): DeleteCardsResponse;
1662
+ type DeleteCardsResponse = {
1663
+ /**
1664
+ * - Human readable message.
1665
+ */
1666
+ message?: string;
1667
+ /**
1668
+ * - Response is successful or not.
1669
+ */
1670
+ success: boolean;
1671
+ };
1672
+ /** @returns {DeletehCardRequest} */
1673
+ declare function DeletehCardRequest(): DeletehCardRequest;
1674
+ type DeletehCardRequest = {
1675
+ /**
1676
+ * - Card token of payment gateway.
1677
+ */
1678
+ card_id: string;
1679
+ };
1680
+ /** @returns {DeviceDetails} */
1681
+ declare function DeviceDetails(): DeviceDetails;
1682
+ type DeviceDetails = {
1683
+ /**
1684
+ * - Device maker
1685
+ */
1686
+ device_make?: string;
1687
+ /**
1688
+ * - Device Model
1689
+ */
1690
+ device_model?: string;
1691
+ /**
1692
+ * - Device Type(E.g. Mobile)
1693
+ */
1694
+ device_type?: string;
1695
+ /**
1696
+ * - IP
1697
+ */
1698
+ identification_number?: string;
1699
+ /**
1700
+ * - Static value = ip
1701
+ */
1702
+ identifier_type?: string;
1703
+ /**
1704
+ * - OS Name
1705
+ */
1706
+ os?: string;
1707
+ /**
1708
+ * - OS Version
1709
+ */
1710
+ os_version?: string;
1711
+ };
1712
+ /** @returns {EpaylaterBannerData} */
1713
+ declare function EpaylaterBannerData(): EpaylaterBannerData;
1714
+ type EpaylaterBannerData = {
1715
+ /**
1716
+ * - Need to display banner or not
1717
+ */
1718
+ display: boolean;
1719
+ /**
1720
+ * - EPayLater message
1721
+ */
1722
+ message?: string;
1723
+ /**
1724
+ * - Epaylater KYC status
1725
+ */
1726
+ status?: string;
1727
+ };
1728
+ /** @returns {EpaylaterBannerResponse} */
1729
+ declare function EpaylaterBannerResponse(): EpaylaterBannerResponse;
1730
+ type EpaylaterBannerResponse = {
1731
+ /**
1732
+ * - Epaylater KYC banner details.
1733
+ */
1734
+ data: EpaylaterBannerData;
1735
+ /**
1736
+ * - Successful or not.
1737
+ */
1738
+ success: boolean;
1739
+ };
1740
+ /** @returns {ErrorCodeAndDescription} */
1741
+ declare function ErrorCodeAndDescription(): ErrorCodeAndDescription;
1742
+ type ErrorCodeAndDescription = {
1743
+ /**
1744
+ * - Error descrption code.
1745
+ */
1746
+ code: string;
1747
+ /**
1748
+ * - Error human understandable description.
1749
+ */
1750
+ description: string;
1751
+ };
1752
+ /** @returns {ErrorCodeDescription} */
1753
+ declare function ErrorCodeDescription(): ErrorCodeDescription;
1754
+ type ErrorCodeDescription = {
1755
+ /**
1756
+ * - Error descrption code.
1757
+ */
1758
+ code: string;
1759
+ /**
1760
+ * - Error human understandable description.
1761
+ */
1762
+ description: string;
1763
+ /**
1764
+ * - Response is successful or not
1765
+ */
1766
+ success: boolean;
1767
+ };
1768
+ /** @returns {ErrorDescription} */
1769
+ declare function ErrorDescription(): ErrorDescription;
1770
+ type ErrorDescription = {
1771
+ /**
1772
+ * - Amount paid
1773
+ */
1774
+ amount?: number;
1775
+ /**
1776
+ * - Payment link is cancelled or not
1777
+ */
1778
+ cancelled?: boolean;
1779
+ /**
1780
+ * - Payment link expired or not
1781
+ */
1782
+ expired?: boolean;
1783
+ /**
1784
+ * - Payment link id is valid or not
1785
+ */
1786
+ invalid_id?: boolean;
1787
+ /**
1788
+ * - Name of merchant that created payment link
1789
+ */
1790
+ merchant_name?: string;
1791
+ /**
1792
+ * - Order id
1793
+ */
1794
+ merchant_order_id?: string;
1795
+ /**
1796
+ * - Message
1797
+ */
1798
+ msg?: string;
1799
+ /**
1800
+ * - Payment transaction id
1801
+ */
1802
+ payment_transaction_id?: string;
1803
+ };
1804
+ /** @returns {ErrorResponse} */
1805
+ declare function ErrorResponse(): ErrorResponse;
1806
+ type ErrorResponse = {
1807
+ error?: ErrorDescription;
1808
+ /**
1809
+ * - Message
1810
+ */
1811
+ message: string;
1812
+ /**
1813
+ * - HTTP status code
1814
+ */
1815
+ status_code: number;
1816
+ /**
1817
+ * - Successful or failure
1818
+ */
1819
+ success: boolean;
1820
+ };
1821
+ /** @returns {GetPaymentLinkResponse} */
1822
+ declare function GetPaymentLinkResponse(): GetPaymentLinkResponse;
1823
+ type GetPaymentLinkResponse = {
1824
+ /**
1825
+ * - Total value of order
1826
+ */
1827
+ amount?: number;
1828
+ /**
1829
+ * - Merchant order id
1830
+ */
1831
+ external_order_id?: string;
1832
+ /**
1833
+ * - Merchant name
1834
+ */
1835
+ merchant_name?: string;
1836
+ /**
1837
+ * - Message
1838
+ */
1839
+ message: string;
1840
+ /**
1841
+ * - Status of payment link
1842
+ */
1843
+ payment_link_current_status?: string;
1844
+ /**
1845
+ * - Url of payment link
1846
+ */
1847
+ payment_link_url?: string;
1848
+ /**
1849
+ * - Polling request timeout
1850
+ */
1851
+ polling_timeout?: number;
1852
+ /**
1853
+ * - HTTP status code
1854
+ */
1855
+ status_code: number;
1856
+ /**
1857
+ * - Successful or failure
1858
+ */
1859
+ success: boolean;
1860
+ };
1861
+ /** @returns {HttpErrorCodeAndResponse} */
1862
+ declare function HttpErrorCodeAndResponse(): HttpErrorCodeAndResponse;
1863
+ type HttpErrorCodeAndResponse = {
1864
+ error: ErrorCodeAndDescription;
1865
+ /**
1866
+ * - Response is successful or not
1867
+ */
1868
+ success: boolean;
1869
+ };
1870
+ /** @returns {IfscCodeResponse} */
1871
+ declare function IfscCodeResponse(): IfscCodeResponse;
1872
+ type IfscCodeResponse = {
1873
+ /**
1874
+ * - Bank Name Of Account
1875
+ */
1876
+ bank_name: string;
1877
+ /**
1878
+ * - Branch Name Of Account
1879
+ */
1880
+ branch_name: string;
1881
+ /**
1882
+ * - Response is successful or not
1883
+ */
1884
+ success?: boolean;
1885
+ };
1886
+ /** @returns {IntentApp} */
1887
+ declare function IntentApp(): IntentApp;
1888
+ type IntentApp = {
1889
+ /**
1890
+ * - Code
1891
+ */
1892
+ code?: string;
1893
+ /**
1894
+ * - Display_name
1895
+ */
1896
+ display_name?: string;
1897
+ /**
1898
+ * - Logos
1899
+ */
1900
+ logos?: PaymentModeLogo;
1901
+ /**
1902
+ * - Package_name
1903
+ */
1904
+ package_name?: string;
1905
+ };
1906
+ /** @returns {IntentAppErrorList} */
1907
+ declare function IntentAppErrorList(): IntentAppErrorList;
1908
+ type IntentAppErrorList = {
1909
+ /**
1910
+ * - Code
1911
+ */
1912
+ code?: string;
1913
+ /**
1914
+ * - Package_name
1915
+ */
1916
+ package_name?: string;
1917
+ };
1918
+ /** @returns {KYCAddress} */
1919
+ declare function KYCAddress(): KYCAddress;
1920
+ type KYCAddress = {
1921
+ /**
1922
+ * - Address Line 1
1923
+ */
1924
+ addressline1: string;
1925
+ /**
1926
+ * - Address Line 2
1927
+ */
1928
+ addressline2?: string;
1929
+ /**
1930
+ * - City
1931
+ */
1932
+ city: string;
1933
+ /**
1934
+ * - Land Mark
1935
+ */
1936
+ land_mark?: string;
1937
+ /**
1938
+ * - Address Owner Type
1939
+ */
1940
+ ownership_type?: string;
1941
+ /**
1942
+ * - Pincode
1943
+ */
1944
+ pincode: string;
1945
+ /**
1946
+ * - State
1947
+ */
1948
+ state: string;
1949
+ };
1950
+ /** @returns {LinkStatus} */
1951
+ declare function LinkStatus(): LinkStatus;
1952
+ type LinkStatus = {
1953
+ /**
1954
+ * - Message
1955
+ */
1956
+ message: string;
1957
+ /**
1958
+ * - Link action status
1959
+ */
1960
+ status: boolean;
1961
+ };
1962
+ /** @returns {ListCardsResponse} */
1963
+ declare function ListCardsResponse(): ListCardsResponse;
1964
+ type ListCardsResponse = {
1965
+ /**
1966
+ * - List of cards of customer.
1967
+ */
1968
+ data?: Card[];
1969
+ /**
1970
+ * - Human readable message.
1971
+ */
1972
+ message: string;
1973
+ /**
1974
+ * - Response is successful or not.
1975
+ */
1976
+ success: boolean;
1977
+ };
1978
+ /** @returns {MarketplaceInfo} */
1979
+ declare function MarketplaceInfo(): MarketplaceInfo;
1980
+ type MarketplaceInfo = {
1981
+ /**
1982
+ * - Date of joining
1983
+ */
1984
+ date_of_joining?: string;
1985
+ /**
1986
+ * - Merchant id
1987
+ */
1988
+ membership_id: string;
1989
+ /**
1990
+ * - Name of store
1991
+ */
1992
+ name: string;
1993
+ };
1994
+ /** @returns {NotFoundResourceError} */
1995
+ declare function NotFoundResourceError(): NotFoundResourceError;
1996
+ type NotFoundResourceError = {
1997
+ /**
1998
+ * - Bad Request Data
1999
+ */
2000
+ code: string;
2001
+ /**
2002
+ * - Not Found
2003
+ */
2004
+ description: string;
2005
+ /**
2006
+ * - Response is successful or not
2007
+ */
2008
+ success: boolean;
2009
+ };
2010
+ /** @returns {OnboardSummary} */
2011
+ declare function OnboardSummary(): OnboardSummary;
2012
+ type OnboardSummary = {
2013
+ /**
2014
+ * - URL to which the user may redirect.
2015
+ */
2016
+ redirect_url: string;
2017
+ /**
2018
+ * - User Session
2019
+ */
2020
+ session: any;
2021
+ /**
2022
+ * - Operation Status
2023
+ */
2024
+ status: boolean;
2025
+ };
2026
+ /** @returns {OrderBeneficiaryDetails} */
2027
+ declare function OrderBeneficiaryDetails(): OrderBeneficiaryDetails;
2028
+ type OrderBeneficiaryDetails = {
2029
+ /**
2030
+ * - Account Holder Name
2031
+ */
2032
+ account_holder: string;
2033
+ /**
2034
+ * - Account Number
2035
+ */
2036
+ account_no: string;
2037
+ /**
2038
+ * - Address of User
2039
+ */
2040
+ address: string;
2041
+ /**
2042
+ * - Bank Name Of Account
2043
+ */
2044
+ bank_name: string;
2045
+ /**
2046
+ * - Benenficiary Id
2047
+ */
2048
+ beneficiary_id: string;
2049
+ /**
2050
+ * - Branch Name Of Account
2051
+ */
2052
+ branch_name?: string;
2053
+ /**
2054
+ * - Remarks
2055
+ */
2056
+ comment?: string;
2057
+ /**
2058
+ * - Creation Date of Beneficiary
2059
+ */
2060
+ created_on: string;
2061
+ /**
2062
+ * - User Id Who filled the Beneficiary
2063
+ */
2064
+ delights_user_name?: string;
2065
+ /**
2066
+ * - Display Name Of Account
2067
+ */
2068
+ display_name: string;
2069
+ /**
2070
+ * - EMail of User
2071
+ */
2072
+ email: string;
2073
+ /**
2074
+ * -
2075
+ */
2076
+ id: number;
2077
+ /**
2078
+ * - Ifsc Code Of Account
2079
+ */
2080
+ ifsc_code: string;
2081
+ /**
2082
+ * - Boolean Flag whether Beneficiary set or not
2083
+ */
2084
+ is_active: boolean;
2085
+ /**
2086
+ * - MObile no of User
2087
+ */
2088
+ mobile?: string;
2089
+ /**
2090
+ * - MOdification Date of Beneficiary
2091
+ */
2092
+ modified_on: string;
2093
+ /**
2094
+ * - SHort Title Of Account
2095
+ */
2096
+ subtitle: string;
2097
+ /**
2098
+ * - Title Of Account
2099
+ */
2100
+ title: string;
2101
+ /**
2102
+ * - Transfer Mode Of Account
2103
+ */
2104
+ transfer_mode: string;
2105
+ };
2106
+ /** @returns {OrderBeneficiaryResponse} */
2107
+ declare function OrderBeneficiaryResponse(): OrderBeneficiaryResponse;
2108
+ type OrderBeneficiaryResponse = {
2109
+ /**
2110
+ * - All Beneficiaries Of An Order
2111
+ */
2112
+ beneficiaries?: OrderBeneficiaryDetails[];
2113
+ /**
2114
+ * - Show beneficiary details or not.
2115
+ */
2116
+ show_beneficiary_details?: boolean;
2117
+ };
2118
+ /** @returns {OutstandingOrderDetailsResponse} */
2119
+ declare function OutstandingOrderDetailsResponse(): OutstandingOrderDetailsResponse;
2120
+ type OutstandingOrderDetailsResponse = {
2121
+ /**
2122
+ * - Dict containing the outstanding order details
2123
+ */
2124
+ data?: any[];
2125
+ /**
2126
+ * - Message
2127
+ */
2128
+ message?: string;
2129
+ /**
2130
+ * - HTTP Status code
2131
+ */
2132
+ status_code: number;
2133
+ /**
2134
+ * - Response is successful or not.
2135
+ */
2136
+ success: boolean;
2137
+ };
2138
+ /** @returns {PaidOrderDetailsResponse} */
2139
+ declare function PaidOrderDetailsResponse(): PaidOrderDetailsResponse;
2140
+ type PaidOrderDetailsResponse = {
2141
+ /**
2142
+ * - Dict containing the paid order details
2143
+ */
2144
+ data?: any[];
2145
+ /**
2146
+ * - Message
2147
+ */
2148
+ message?: string;
2149
+ /**
2150
+ * - HTTP Status code
2151
+ */
2152
+ status_code: number;
2153
+ /**
2154
+ * - Response is successful or not.
2155
+ */
2156
+ success: boolean;
2157
+ };
2158
+ /** @returns {PaymentFlow} */
2159
+ declare function PaymentFlow(): PaymentFlow;
2160
+ type PaymentFlow = {
2161
+ /**
2162
+ * - Ajiodhan
2163
+ */
2164
+ ajiodhan?: AggregatorRoute;
2165
+ /**
2166
+ * - BQR_Razorpay
2167
+ */
2168
+ bqr_razorpay?: AggregatorRoute;
2169
+ /**
2170
+ * - Ccavenue
2171
+ */
2172
+ ccavenue?: AggregatorRoute;
2173
+ /**
2174
+ * - Epaylater
2175
+ */
2176
+ epaylater?: AggregatorRoute;
2177
+ /**
2178
+ * - Fynd
2179
+ */
2180
+ fynd?: AggregatorRoute;
2181
+ /**
2182
+ * - Jiopay
2183
+ */
2184
+ jiopay?: AggregatorRoute;
2185
+ /**
2186
+ * - Juspay
2187
+ */
2188
+ juspay?: AggregatorRoute;
2189
+ /**
2190
+ * - Mswipe
2191
+ */
2192
+ mswipe?: AggregatorRoute;
2193
+ /**
2194
+ * - Payubiz
2195
+ */
2196
+ payubiz?: AggregatorRoute;
2197
+ /**
2198
+ * - Razorpay
2199
+ */
2200
+ razorpay?: AggregatorRoute;
2201
+ /**
2202
+ * - Rupifi
2203
+ */
2204
+ rupifi?: AggregatorRoute;
2205
+ /**
2206
+ * - Simpl
2207
+ */
2208
+ simpl?: AggregatorRoute;
2209
+ /**
2210
+ * - Stripe
2211
+ */
2212
+ stripe?: AggregatorRoute;
2213
+ /**
2214
+ * - UPI_Razorpay
2215
+ */
2216
+ upi_razorpay?: AggregatorRoute;
2217
+ };
2218
+ /** @returns {PaymentInitializationRequest} */
2219
+ declare function PaymentInitializationRequest(): PaymentInitializationRequest;
2220
+ type PaymentInitializationRequest = {
2221
+ /**
2222
+ * - Payment gateway name
2223
+ */
2224
+ aggregator: string;
2225
+ /**
2226
+ * - Payable amount.
2227
+ */
2228
+ amount: number;
2229
+ /**
2230
+ * - Customer valid mobile number
2231
+ */
2232
+ contact: string;
2233
+ /**
2234
+ * - Currency code.
2235
+ */
2236
+ currency: string;
2237
+ /**
2238
+ * - Payment gateway customer id.
2239
+ */
2240
+ customer_id: string;
2241
+ /**
2242
+ * - EDC machine Unique Identifier
2243
+ */
2244
+ device_id?: string;
2245
+ /**
2246
+ * - Customer valid email
2247
+ */
2248
+ email: string;
2249
+ /**
2250
+ * - Unique fynd order id
2251
+ */
2252
+ merchant_order_id: string;
2253
+ /**
2254
+ * - Payment method
2255
+ */
2256
+ method: string;
2257
+ /**
2258
+ * - Payment gateway order id
2259
+ */
2260
+ order_id: string;
2261
+ /**
2262
+ * - Payment gateway payment id
2263
+ */
2264
+ razorpay_payment_id?: string;
2265
+ /**
2266
+ * - Payment polling timeout if not recieved response
2267
+ */
2268
+ timeout?: number;
2269
+ /**
2270
+ * - Customer vpa address
2271
+ */
2272
+ vpa?: string;
2273
+ };
2274
+ /** @returns {PaymentInitializationResponse} */
2275
+ declare function PaymentInitializationResponse(): PaymentInitializationResponse;
2276
+ type PaymentInitializationResponse = {
2277
+ /**
2278
+ * - Payment gateway name
2279
+ */
2280
+ aggregator: string;
2281
+ /**
2282
+ * - Payment order id
2283
+ */
2284
+ aggregator_order_id?: string;
2285
+ /**
2286
+ * - Payable amount.
2287
+ */
2288
+ amount?: number;
2289
+ /**
2290
+ * - Bharath qr image url.
2291
+ */
2292
+ bqr_image?: string;
2293
+ /**
2294
+ * - Currency code.
2295
+ */
2296
+ currency?: string;
2297
+ /**
2298
+ * - Payment gateway customer id.
2299
+ */
2300
+ customer_id?: string;
2301
+ /**
2302
+ * - EDC machine Unique Identifier
2303
+ */
2304
+ device_id?: string;
2305
+ /**
2306
+ * - Order id
2307
+ */
2308
+ merchant_order_id: string;
2309
+ /**
2310
+ * - Payment method
2311
+ */
2312
+ method: string;
2313
+ /**
2314
+ * - Polling url.
2315
+ */
2316
+ polling_url: string;
2317
+ /**
2318
+ * - Payment id.
2319
+ */
2320
+ razorpay_payment_id?: string;
2321
+ /**
2322
+ * - Status of payment.
2323
+ */
2324
+ status?: string;
2325
+ /**
2326
+ * - Response is successful or not.
2327
+ */
2328
+ success: boolean;
2329
+ /**
2330
+ * - Timeout.
2331
+ */
2332
+ timeout?: number;
2333
+ /**
2334
+ * - UPI poll url.
2335
+ */
2336
+ upi_poll_url?: string;
2337
+ /**
2338
+ * - Payment virtual address.
2339
+ */
2340
+ virtual_id?: string;
2341
+ /**
2342
+ * - Customer vpa address
2343
+ */
2344
+ vpa?: string;
2345
+ };
2346
+ /** @returns {PaymentMethodsMeta} */
2347
+ declare function PaymentMethodsMeta(): PaymentMethodsMeta;
2348
+ type PaymentMethodsMeta = {
2349
+ /**
2350
+ * - Merchant code
2351
+ */
2352
+ merchant_code: string;
2353
+ /**
2354
+ * - Payment gateway name
2355
+ */
2356
+ payment_gateway: string;
2357
+ /**
2358
+ * - Payment identifier
2359
+ */
2360
+ payment_identifier: string;
2361
+ };
2362
+ /** @returns {PaymentModeList} */
2363
+ declare function PaymentModeList(): PaymentModeList;
2364
+ type PaymentModeList = {
2365
+ /**
2366
+ * - Aggregator_name
2367
+ */
2368
+ aggregator_name: string;
2369
+ /**
2370
+ * - Card_brand
2371
+ */
2372
+ card_brand?: string;
2373
+ /**
2374
+ * - Card_brand_image
2375
+ */
2376
+ card_brand_image?: string;
2377
+ /**
2378
+ * - Card_fingerprint
2379
+ */
2380
+ card_fingerprint?: string;
2381
+ /**
2382
+ * - Card_id
2383
+ */
2384
+ card_id?: string;
2385
+ /**
2386
+ * - Card_isin
2387
+ */
2388
+ card_isin?: string;
2389
+ /**
2390
+ * - Card_issuer
2391
+ */
2392
+ card_issuer?: string;
2393
+ /**
2394
+ * - Card_name
2395
+ */
2396
+ card_name?: string;
2397
+ /**
2398
+ * - Card_number
2399
+ */
2400
+ card_number?: string;
2401
+ /**
2402
+ * - Card_reference
2403
+ */
2404
+ card_reference?: string;
2405
+ /**
2406
+ * - Card_token
2407
+ */
2408
+ card_token?: string;
2409
+ /**
2410
+ * - Card_type
2411
+ */
2412
+ card_type?: string;
2413
+ /**
2414
+ * - Cod limit
2415
+ */
2416
+ cod_limit?: number;
2417
+ /**
2418
+ * - Cod limit per order
2419
+ */
2420
+ cod_limit_per_order?: number;
2421
+ /**
2422
+ * - Code
2423
+ */
2424
+ code?: string;
2425
+ /**
2426
+ * - If card is
2427
+ * tokenised or not
2428
+ */
2429
+ compliant_with_tokenisation_guidelines?: boolean;
2430
+ /**
2431
+ * - Display name
2432
+ */
2433
+ display_name?: string;
2434
+ /**
2435
+ * - Dispaly Priority
2436
+ */
2437
+ display_priority?: number;
2438
+ /**
2439
+ * - Exp_month
2440
+ */
2441
+ exp_month?: number;
2442
+ /**
2443
+ * - Exp_year
2444
+ */
2445
+ exp_year?: number;
2446
+ /**
2447
+ * - Expired
2448
+ */
2449
+ expired?: boolean;
2450
+ /**
2451
+ * - Fynd_vpa
2452
+ */
2453
+ fynd_vpa?: string;
2454
+ /**
2455
+ * - Intent_app
2456
+ */
2457
+ intent_app?: IntentApp[];
2458
+ /**
2459
+ * -
2460
+ * Intent_app_error_dict_list
2461
+ */
2462
+ intent_app_error_dict_list?: IntentAppErrorList[];
2463
+ /**
2464
+ * - Intent_app_error_list
2465
+ */
2466
+ intent_app_error_list?: string[];
2467
+ /**
2468
+ * - Intent_flow
2469
+ */
2470
+ intent_flow?: boolean;
2471
+ /**
2472
+ * - Logo
2473
+ */
2474
+ logo_url?: PaymentModeLogo;
2475
+ /**
2476
+ * - Merchant code
2477
+ */
2478
+ merchant_code?: string;
2479
+ /**
2480
+ * - Name
2481
+ */
2482
+ name?: string;
2483
+ /**
2484
+ * - Nickname
2485
+ */
2486
+ nickname?: string;
2487
+ /**
2488
+ * - Remaining limit
2489
+ */
2490
+ remaining_limit?: number;
2491
+ /**
2492
+ * - Retry_count
2493
+ */
2494
+ retry_count?: number;
2495
+ /**
2496
+ * - Timeout
2497
+ */
2498
+ timeout?: number;
2499
+ };
2500
+ /** @returns {PaymentModeLogo} */
2501
+ declare function PaymentModeLogo(): PaymentModeLogo;
2502
+ type PaymentModeLogo = {
2503
+ /**
2504
+ * - Large
2505
+ */
2506
+ large: string;
2507
+ /**
2508
+ * - Smalll
2509
+ */
2510
+ small: string;
2511
+ };
2512
+ /** @returns {PaymentModeRouteResponse} */
2513
+ declare function PaymentModeRouteResponse(): PaymentModeRouteResponse;
2514
+ type PaymentModeRouteResponse = {
2515
+ /**
2516
+ * - Payment_options
2517
+ */
2518
+ payment_options: PaymentOptionAndFlow;
2519
+ /**
2520
+ * - Response is successful or not
2521
+ */
2522
+ success: boolean;
2523
+ };
2524
+ /** @returns {PaymentOptionAndFlow} */
2525
+ declare function PaymentOptionAndFlow(): PaymentOptionAndFlow;
2526
+ type PaymentOptionAndFlow = {
2527
+ /**
2528
+ * - Payment_flows
2529
+ */
2530
+ payment_flows: PaymentFlow;
2531
+ /**
2532
+ * - Payment options
2533
+ */
2534
+ payment_option: RootPaymentMode[];
2535
+ };
2536
+ /** @returns {PaymentStatusUpdateRequest} */
2537
+ declare function PaymentStatusUpdateRequest(): PaymentStatusUpdateRequest;
2538
+ type PaymentStatusUpdateRequest = {
2539
+ /**
2540
+ * - Payment gateway name
2541
+ */
2542
+ aggregator: string;
2543
+ /**
2544
+ * - Payable amount.
2545
+ */
2546
+ amount: number;
2547
+ /**
2548
+ * - Customer valid mobile number
2549
+ */
2550
+ contact: string;
2551
+ /**
2552
+ * - Currency code.
2553
+ */
2554
+ currency: string;
2555
+ /**
2556
+ * - Payment gateway customer id.
2557
+ */
2558
+ customer_id: string;
2559
+ /**
2560
+ * - EDC machine Unique Identifier
2561
+ */
2562
+ device_id?: string;
2563
+ /**
2564
+ * - Customer valid email
2565
+ */
2566
+ email: string;
2567
+ /**
2568
+ * - Unique fynd order id
2569
+ */
2570
+ merchant_order_id: string;
2571
+ /**
2572
+ * - Unique fynd transaction id
2573
+ */
2574
+ merchant_transaction_id: string;
2575
+ /**
2576
+ * - Payment method
2577
+ */
2578
+ method: string;
2579
+ /**
2580
+ * - Payment gateway order id
2581
+ */
2582
+ order_id: string;
2583
+ /**
2584
+ * - Status of payment.
2585
+ */
2586
+ status: string;
2587
+ /**
2588
+ * - Customer vpa address
2589
+ */
2590
+ vpa?: string;
2591
+ };
2592
+ /** @returns {PaymentStatusUpdateResponse} */
2593
+ declare function PaymentStatusUpdateResponse(): PaymentStatusUpdateResponse;
2594
+ type PaymentStatusUpdateResponse = {
2595
+ /**
2596
+ * - Payment gateway name
2597
+ */
2598
+ aggregator_name: string;
2599
+ /**
2600
+ * - Redirect url
2601
+ */
2602
+ redirect_url?: string;
2603
+ /**
2604
+ * - Response is successful or not.
2605
+ */
2606
+ retry: boolean;
2607
+ /**
2608
+ * - Payment status
2609
+ */
2610
+ status: string;
2611
+ /**
2612
+ * - Response is successful or not
2613
+ */
2614
+ success?: boolean;
2615
+ };
2616
+ /** @returns {PollingPaymentLinkResponse} */
2617
+ declare function PollingPaymentLinkResponse(): PollingPaymentLinkResponse;
2618
+ type PollingPaymentLinkResponse = {
2619
+ /**
2620
+ * - Aggregator name
2621
+ */
2622
+ aggregator_name?: string;
2623
+ /**
2624
+ * - Amount
2625
+ */
2626
+ amount?: number;
2627
+ /**
2628
+ * - HTTP status code
2629
+ */
2630
+ http_status?: number;
2631
+ /**
2632
+ * - Message
2633
+ */
2634
+ message?: string;
2635
+ /**
2636
+ * - Fynd order id
2637
+ */
2638
+ order_id?: string;
2639
+ /**
2640
+ * - Payment link id
2641
+ */
2642
+ payment_link_id?: string;
2643
+ /**
2644
+ * - Url to redirect to
2645
+ */
2646
+ redirect_url?: string;
2647
+ /**
2648
+ * - Status of payment link
2649
+ */
2650
+ status?: string;
2651
+ /**
2652
+ * - HTTP status code
2653
+ */
2654
+ status_code?: number;
2655
+ /**
2656
+ * - Successful or failure
2657
+ */
2658
+ success?: boolean;
2659
+ };
2660
+ /** @returns {RedirectToAggregatorResponse} */
2661
+ declare function RedirectToAggregatorResponse(): RedirectToAggregatorResponse;
2662
+ type RedirectToAggregatorResponse = {
2663
+ /**
2664
+ * - Redirect URL.
2665
+ */
2666
+ data: RedirectURL;
2667
+ /**
2668
+ * - Status updated or not.
2669
+ */
2670
+ success: boolean;
2671
+ };
2672
+ /** @returns {RedirectURL} */
2673
+ declare function RedirectURL(): RedirectURL;
2674
+ type RedirectURL = {
2675
+ /**
2676
+ * - URL to which the user may redirect.
2677
+ */
2678
+ signup_url: string;
2679
+ /**
2680
+ * - Aggregator's Operation is successful or not.
2681
+ */
2682
+ status: boolean;
2683
+ };
2684
+ /** @returns {RefundAccountResponse} */
2685
+ declare function RefundAccountResponse(): RefundAccountResponse;
2686
+ type RefundAccountResponse = {
2687
+ /**
2688
+ * - Refund account data.
2689
+ */
2690
+ data?: any;
2691
+ is_verified_flag?: boolean;
2692
+ /**
2693
+ * - Response message
2694
+ */
2695
+ message: string;
2696
+ /**
2697
+ * - Success or failure flag.
2698
+ */
2699
+ success: boolean;
2700
+ };
2701
+ /** @returns {renderHTMLRequest} */
2702
+ declare function renderHTMLRequest(): renderHTMLRequest;
2703
+ type renderHTMLRequest = {
2704
+ /**
2705
+ * - Base64 encoded html string
2706
+ */
2707
+ base64_html: string;
2708
+ /**
2709
+ * - Return Type of API
2710
+ */
2711
+ returntype?: string;
2712
+ };
2713
+ /** @returns {renderHTMLResponse} */
2714
+ declare function renderHTMLResponse(): renderHTMLResponse;
2715
+ type renderHTMLResponse = {
2716
+ /**
2717
+ * - HTML string
2718
+ */
2719
+ html: string;
2720
+ };
2721
+ /** @returns {ResendOrCancelPaymentRequest} */
2722
+ declare function ResendOrCancelPaymentRequest(): ResendOrCancelPaymentRequest;
2723
+ type ResendOrCancelPaymentRequest = {
2724
+ /**
2725
+ * - EDC machine Unique Identifier
2726
+ */
2727
+ device_id?: string;
2728
+ /**
2729
+ * - Unique order id
2730
+ */
2731
+ order_id: string;
2732
+ /**
2733
+ * - Either resend or cancel
2734
+ */
2735
+ request_type: string;
2736
+ };
2737
+ /** @returns {ResendOrCancelPaymentResponse} */
2738
+ declare function ResendOrCancelPaymentResponse(): ResendOrCancelPaymentResponse;
2739
+ type ResendOrCancelPaymentResponse = {
2740
+ /**
2741
+ * - Data about link action status.
2742
+ */
2743
+ data: LinkStatus;
2744
+ /**
2745
+ * - Response is successful or not.
2746
+ */
2747
+ success: boolean;
2748
+ };
2749
+ /** @returns {ResendPaymentLinkResponse} */
2750
+ declare function ResendPaymentLinkResponse(): ResendPaymentLinkResponse;
2751
+ type ResendPaymentLinkResponse = {
2752
+ /**
2753
+ * - Message
2754
+ */
2755
+ message: string;
2756
+ /**
2757
+ * - Polling request timeout
2758
+ */
2759
+ polling_timeout?: number;
2760
+ /**
2761
+ * - HTTP status code
2762
+ */
2763
+ status_code: number;
2764
+ /**
2765
+ * - Successful or failure
2766
+ */
2767
+ success: boolean;
2768
+ };
2769
+ /** @returns {RootPaymentMode} */
2770
+ declare function RootPaymentMode(): RootPaymentMode;
2771
+ type RootPaymentMode = {
2772
+ /**
2773
+ * - Annonymous card flag
2774
+ */
2775
+ add_card_enabled?: boolean;
2776
+ /**
2777
+ * - Dispaly Priority
2778
+ */
2779
+ aggregator_name?: string;
2780
+ /**
2781
+ * - Annonymous card flag
2782
+ */
2783
+ anonymous_enable?: boolean;
2784
+ /**
2785
+ * - Payment mode display name
2786
+ */
2787
+ display_name: string;
2788
+ /**
2789
+ * - Dispaly Priority
2790
+ */
2791
+ display_priority: number;
2792
+ /**
2793
+ * - This flag will be true in case of
2794
+ * Payment link payment through card
2795
+ */
2796
+ is_pay_by_card_pl?: boolean;
2797
+ /**
2798
+ * - Payment mode
2799
+ */
2800
+ list?: PaymentModeList[];
2801
+ /**
2802
+ * - Payment mode name
2803
+ */
2804
+ name: string;
2805
+ /**
2806
+ * - Card save or not
2807
+ */
2808
+ save_card?: boolean;
2809
+ };
2810
+ /** @returns {RupifiBannerData} */
2811
+ declare function RupifiBannerData(): RupifiBannerData;
2812
+ type RupifiBannerData = {
2813
+ /**
2814
+ * - Rupifi KYC banner url.
2815
+ */
2816
+ kyc_url?: string;
2817
+ /**
2818
+ * - Rupifi KYC status
2819
+ */
2820
+ status?: string;
2821
+ };
2822
+ /** @returns {RupifiBannerResponse} */
2823
+ declare function RupifiBannerResponse(): RupifiBannerResponse;
2824
+ type RupifiBannerResponse = {
2825
+ /**
2826
+ * - Rupifi KYC banner details.
2827
+ */
2828
+ data: RupifiBannerData;
2829
+ /**
2830
+ * - Successful or not.
2831
+ */
2832
+ success: boolean;
2833
+ };
2834
+ /** @returns {SetDefaultBeneficiaryRequest} */
2835
+ declare function SetDefaultBeneficiaryRequest(): SetDefaultBeneficiaryRequest;
2836
+ type SetDefaultBeneficiaryRequest = {
2837
+ /**
2838
+ * - Beneficiary Hash Id of the beneficiary added
2839
+ */
2840
+ beneficiary_id: string;
2841
+ /**
2842
+ * - Merchant Order Id
2843
+ */
2844
+ order_id: string;
2845
+ };
2846
+ /** @returns {SetDefaultBeneficiaryResponse} */
2847
+ declare function SetDefaultBeneficiaryResponse(): SetDefaultBeneficiaryResponse;
2848
+ type SetDefaultBeneficiaryResponse = {
2849
+ /**
2850
+ * - Boolean Flag whether Beneficiary set or not
2851
+ */
2852
+ is_beneficiary_set: boolean;
2853
+ /**
2854
+ * - Response is successful or not
2855
+ */
2856
+ success?: boolean;
2857
+ };
2858
+ /** @returns {TransferItemsDetails} */
2859
+ declare function TransferItemsDetails(): TransferItemsDetails;
2860
+ type TransferItemsDetails = {
2861
+ /**
2862
+ * - Beneficiary Display Name
2863
+ */
2864
+ display_name?: string;
2865
+ /**
2866
+ * -
2867
+ */
2868
+ id: number;
2869
+ /**
2870
+ * - Beneficiary large Logo
2871
+ */
2872
+ logo_large: string;
2873
+ /**
2874
+ * - Beneficiary small Logo
2875
+ */
2876
+ logo_small: string;
2877
+ /**
2878
+ * - Beneficiary Name
2879
+ */
2880
+ name: string;
2881
+ };
2882
+ /** @returns {TransferModeDetails} */
2883
+ declare function TransferModeDetails(): TransferModeDetails;
2884
+ type TransferModeDetails = {
2885
+ /**
2886
+ * - Beneficiary Mode Name
2887
+ */
2888
+ display_name: string;
2889
+ /**
2890
+ * - Beneficiary Mode Items
2891
+ */
2892
+ items?: TransferItemsDetails[];
2893
+ };
2894
+ /** @returns {TransferModeResponse} */
2895
+ declare function TransferModeResponse(): TransferModeResponse;
2896
+ type TransferModeResponse = {
2897
+ /**
2898
+ * - Response Object
2899
+ */
2900
+ data: TransferModeDetails[];
2901
+ };
2902
+ /** @returns {UpdateRefundTransferModeRequest} */
2903
+ declare function UpdateRefundTransferModeRequest(): UpdateRefundTransferModeRequest;
2904
+ type UpdateRefundTransferModeRequest = {
2905
+ /**
2906
+ * - True for enabling the Transfer Mode
2907
+ */
2908
+ enable: boolean;
2909
+ /**
2910
+ * - Transfer Mode of the Beneficiary to be added
2911
+ */
2912
+ transfer_mode: string;
2913
+ };
2914
+ /** @returns {UpdateRefundTransferModeResponse} */
2915
+ declare function UpdateRefundTransferModeResponse(): UpdateRefundTransferModeResponse;
2916
+ type UpdateRefundTransferModeResponse = {
2917
+ /**
2918
+ * - Response is successful or not
2919
+ */
2920
+ success?: boolean;
2921
+ };
2922
+ /** @returns {UserPersonalInfoInDetails} */
2923
+ declare function UserPersonalInfoInDetails(): UserPersonalInfoInDetails;
2924
+ type UserPersonalInfoInDetails = {
2925
+ /**
2926
+ * - Address details
2927
+ */
2928
+ address_as_per_id: KYCAddress;
2929
+ /**
2930
+ * - DOB
2931
+ */
2932
+ dob: string;
2933
+ /**
2934
+ * - Driver License
2935
+ */
2936
+ driving_license?: string;
2937
+ /**
2938
+ * - Email
2939
+ */
2940
+ email?: string;
2941
+ /**
2942
+ * - Is Email Verified or not
2943
+ */
2944
+ email_verified: boolean;
2945
+ /**
2946
+ * - Father's Name
2947
+ */
2948
+ fathers_name?: string;
2949
+ /**
2950
+ * - First Name
2951
+ */
2952
+ first_name: string;
2953
+ /**
2954
+ * - Gender
2955
+ */
2956
+ gender?: string;
2957
+ /**
2958
+ * - Last Name
2959
+ */
2960
+ last_name?: string;
2961
+ /**
2962
+ * - Middle Name
2963
+ */
2964
+ middle_name?: string;
2965
+ /**
2966
+ * - Is Mobile Verified or not
2967
+ */
2968
+ mobile_verified: boolean;
2969
+ /**
2970
+ * - Mother's Name
2971
+ */
2972
+ mothers_name?: string;
2973
+ /**
2974
+ * - Pan Number
2975
+ */
2976
+ pan?: string;
2977
+ /**
2978
+ * - Passport
2979
+ */
2980
+ passport?: string;
2981
+ /**
2982
+ * - Email
2983
+ */
2984
+ phone: string;
2985
+ /**
2986
+ * - Voter ID Number
2987
+ */
2988
+ voter_id?: string;
2989
+ };
2990
+ /** @returns {ValidateCustomerRequest} */
2991
+ declare function ValidateCustomerRequest(): ValidateCustomerRequest;
2992
+ type ValidateCustomerRequest = {
2993
+ /**
2994
+ * - Payment gateway name in camel case i.e Simpl, Rupifi
2995
+ */
2996
+ aggregator: string;
2997
+ /**
2998
+ * - Extra meta fields.
2999
+ */
3000
+ billing_address?: any;
3001
+ /**
3002
+ * - Extra meta fields.
3003
+ */
3004
+ delivery_address?: any;
3005
+ /**
3006
+ * - Extra meta fields.
3007
+ */
3008
+ merchant_params?: any;
3009
+ /**
3010
+ * - Extra meta fields.
3011
+ */
3012
+ order_items?: any[];
3013
+ /**
3014
+ * - Hashed payload string.
3015
+ */
3016
+ payload?: string;
3017
+ /**
3018
+ * - User mobile number without country code.
3019
+ */
3020
+ phone_number: string;
3021
+ /**
3022
+ * - Payable amount in paise
3023
+ */
3024
+ transaction_amount_in_paise: number;
3025
+ };
3026
+ /** @returns {ValidateCustomerResponse} */
3027
+ declare function ValidateCustomerResponse(): ValidateCustomerResponse;
3028
+ type ValidateCustomerResponse = {
3029
+ /**
3030
+ * - Payment gateway response data
3031
+ */
3032
+ data: any;
3033
+ /**
3034
+ * - Error or success message.
3035
+ */
3036
+ message: string;
3037
+ /**
3038
+ * - Response is successful or not
3039
+ */
3040
+ success: boolean;
3041
+ };
3042
+ /** @returns {ValidateUPI} */
3043
+ declare function ValidateUPI(): ValidateUPI;
3044
+ type ValidateUPI = {
3045
+ /**
3046
+ * - Customer Bank
3047
+ */
3048
+ customer_name: string;
3049
+ /**
3050
+ * - Boolean is true or false.
3051
+ */
3052
+ is_valid: boolean;
3053
+ /**
3054
+ * - VALID or INVALID
3055
+ */
3056
+ status: string;
3057
+ /**
3058
+ * - UPI ID
3059
+ */
3060
+ upi_vpa: string;
3061
+ };
3062
+ /** @returns {ValidateVPARequest} */
3063
+ declare function ValidateVPARequest(): ValidateVPARequest;
3064
+ type ValidateVPARequest = {
3065
+ /**
3066
+ * - UPI ID
3067
+ */
3068
+ upi_vpa: string;
3069
+ };
3070
+ /** @returns {ValidateVPAResponse} */
3071
+ declare function ValidateVPAResponse(): ValidateVPAResponse;
3072
+ type ValidateVPAResponse = {
3073
+ /**
3074
+ * - Data about UPI ID validate.
3075
+ */
3076
+ data: ValidateUPI;
3077
+ /**
3078
+ * - Response is successful or not.
3079
+ */
3080
+ success: boolean;
3081
+ };
3082
+ /** @returns {WalletOtpRequest} */
3083
+ declare function WalletOtpRequest(): WalletOtpRequest;
3084
+ type WalletOtpRequest = {
3085
+ /**
3086
+ * - Country Code of the Mobile Number
3087
+ */
3088
+ country_code: string;
3089
+ /**
3090
+ * - Wallet Moblie Number of the User
3091
+ */
3092
+ mobile: string;
3093
+ };
3094
+ /** @returns {WalletOtpResponse} */
3095
+ declare function WalletOtpResponse(): WalletOtpResponse;
3096
+ type WalletOtpResponse = {
3097
+ /**
3098
+ * - Boolean Flag whether OTP Validation is
3099
+ * already done or not
3100
+ */
3101
+ is_verified_flag: string;
3102
+ /**
3103
+ * - Request id
3104
+ */
3105
+ request_id: string;
3106
+ /**
3107
+ * - Response is successful or not
3108
+ */
3109
+ success?: boolean;
3110
+ };
3111
+ /** @returns {WrongOtpError} */
3112
+ declare function WrongOtpError(): WrongOtpError;
3113
+ type WrongOtpError = {
3114
+ /**
3115
+ * - Wrong OTP Code
3116
+ */
3117
+ description: string;
3118
+ /**
3119
+ * - Vefified flag.
3120
+ */
3121
+ is_verified_flag: boolean;
3122
+ /**
3123
+ * - Response is successful or not
3124
+ */
3125
+ success: string;
3126
+ };