@gofynd/fdk-client-javascript 1.4.15-beta.1 → 1.4.15-beta.11

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