@gofynd/fdk-client-javascript 1.4.15-beta.13 → 1.4.15-beta.15
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.
- package/README.md +23 -26
- package/package.json +5 -1
- package/sdk/application/ApplicationClient.d.ts +5 -6
- package/sdk/application/ApplicationClient.js +24 -20
- package/sdk/application/Cart/CartApplicationClient.d.ts +133 -83
- package/sdk/application/Cart/CartApplicationClient.js +444 -76
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +132 -114
- package/sdk/application/Catalog/CatalogApplicationClient.js +209 -126
- package/sdk/application/Common/CommonApplicationClient.d.ts +4 -4
- package/sdk/application/Common/CommonApplicationClient.js +4 -4
- package/sdk/application/Communication/CommunicationApplicationClient.d.ts +3 -3
- package/sdk/application/Communication/CommunicationApplicationClient.js +3 -3
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +58 -36
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +73 -29
- package/sdk/application/Content/ContentApplicationClient.d.ts +95 -66
- package/sdk/application/Content/ContentApplicationClient.js +274 -111
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +11 -11
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +10 -10
- package/sdk/application/Finance/FinanceApplicationClient.d.ts +29 -0
- package/sdk/application/Finance/FinanceApplicationClient.js +111 -0
- package/sdk/application/Lead/LeadApplicationClient.d.ts +7 -7
- package/sdk/application/Lead/LeadApplicationClient.js +6 -6
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +37 -57
- package/sdk/application/Logistic/LogisticApplicationClient.js +117 -180
- package/sdk/application/Order/OrderApplicationClient.d.ts +63 -21
- package/sdk/application/Order/OrderApplicationClient.js +217 -17
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +179 -149
- package/sdk/application/Payment/PaymentApplicationClient.js +301 -167
- package/sdk/application/Share/ShareApplicationClient.d.ts +7 -7
- package/sdk/application/Share/ShareApplicationClient.js +7 -7
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +7 -7
- package/sdk/application/Theme/ThemeApplicationClient.js +10 -6
- package/sdk/application/User/UserApplicationClient.d.ts +103 -53
- package/sdk/application/User/UserApplicationClient.js +308 -49
- package/sdk/common/AxiosHelper.js +11 -4
- package/sdk/common/Constant.d.ts +27 -4
- package/sdk/common/Constant.js +33 -6
- package/sdk/common/utils.d.ts +10 -0
- package/sdk/common/utils.js +24 -3
- package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +46 -16
- package/sdk/partner/FileStorage/FileStoragePartnerClient.js +266 -40
- package/sdk/partner/FileStorage/FileStoragePartnerModel.d.ts +163 -19
- package/sdk/partner/FileStorage/FileStoragePartnerModel.js +158 -14
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.d.ts +5 -2
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.js +23 -7
- package/sdk/partner/Lead/LeadPartnerClient.d.ts +9 -9
- package/sdk/partner/Lead/LeadPartnerClient.js +9 -9
- package/sdk/partner/Lead/LeadPartnerModel.d.ts +14 -9
- package/sdk/partner/Lead/LeadPartnerModel.js +19 -17
- package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +264 -49
- package/sdk/partner/Logistics/LogisticsPartnerClient.js +2116 -252
- package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +2256 -258
- package/sdk/partner/Logistics/LogisticsPartnerModel.js +1187 -230
- package/sdk/partner/Logistics/LogisticsPartnerValidator.d.ts +21 -1
- package/sdk/partner/Logistics/LogisticsPartnerValidator.js +218 -13
- package/sdk/partner/PartnerClient.d.ts +5 -2
- package/sdk/partner/PartnerClient.js +21 -7
- package/sdk/partner/Theme/ThemePartnerClient.d.ts +32 -34
- package/sdk/partner/Theme/ThemePartnerClient.js +42 -44
- package/sdk/partner/Theme/ThemePartnerModel.d.ts +142 -43
- package/sdk/partner/Theme/ThemePartnerModel.js +129 -44
- package/sdk/partner/Theme/ThemePartnerValidator.js +4 -4
- package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +83 -27
- package/sdk/partner/Webhook/WebhookPartnerClient.js +446 -27
- package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +920 -185
- package/sdk/partner/Webhook/WebhookPartnerModel.js +462 -154
- package/sdk/partner/Webhook/WebhookPartnerValidator.d.ts +5 -0
- package/sdk/partner/Webhook/WebhookPartnerValidator.js +41 -3
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.d.ts +8 -7
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.js +17 -11
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.d.ts +4 -1
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.js +1 -1
- package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +68 -13
- package/sdk/platform/Analytics/AnalyticsPlatformModel.js +44 -6
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +3 -33
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +4 -244
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +49 -145
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +20 -171
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +1 -39
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.js +0 -35
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +15 -15
- package/sdk/platform/Billing/BillingPlatformClient.js +18 -18
- package/sdk/platform/Billing/BillingPlatformModel.d.ts +443 -388
- package/sdk/platform/Billing/BillingPlatformModel.js +280 -263
- package/sdk/platform/Billing/BillingPlatformValidator.d.ts +16 -18
- package/sdk/platform/Billing/BillingPlatformValidator.js +8 -9
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +266 -203
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +1446 -500
- package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +729 -100
- package/sdk/platform/Cart/CartPlatformApplicationValidator.js +446 -82
- package/sdk/platform/Cart/CartPlatformModel.d.ts +6927 -1396
- package/sdk/platform/Cart/CartPlatformModel.js +3065 -1316
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +433 -248
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +1662 -559
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +464 -159
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +304 -87
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +383 -234
- package/sdk/platform/Catalog/CatalogPlatformClient.js +2475 -1557
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +9571 -2674
- package/sdk/platform/Catalog/CatalogPlatformModel.js +5081 -2019
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +364 -117
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +281 -104
- package/sdk/platform/Common/CommonPlatformClient.d.ts +5 -4
- package/sdk/platform/Common/CommonPlatformClient.js +6 -5
- package/sdk/platform/Common/CommonPlatformModel.d.ts +36 -25
- package/sdk/platform/Common/CommonPlatformModel.js +25 -14
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +80 -153
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +102 -541
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +36 -49
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +20 -60
- package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +1 -1
- package/sdk/platform/Communication/CommunicationPlatformClient.js +1 -1
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +189 -43
- package/sdk/platform/Communication/CommunicationPlatformModel.js +165 -42
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +58 -81
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +68 -116
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +291 -249
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +243 -234
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +12 -12
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +12 -12
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +78 -65
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +101 -88
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +20 -20
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +19 -19
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +68 -34
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +174 -41
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +667 -244
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +474 -155
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +37 -9
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +27 -8
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +366 -280
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +1435 -753
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +323 -223
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +335 -205
- package/sdk/platform/Content/ContentPlatformClient.d.ts +304 -106
- package/sdk/platform/Content/ContentPlatformClient.js +1842 -450
- package/sdk/platform/Content/ContentPlatformModel.d.ts +2582 -566
- package/sdk/platform/Content/ContentPlatformModel.js +1426 -558
- package/sdk/platform/Content/ContentPlatformValidator.d.ts +293 -114
- package/sdk/platform/Content/ContentPlatformValidator.js +328 -101
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +59 -23
- package/sdk/platform/Discount/DiscountPlatformClient.js +84 -23
- package/sdk/platform/Discount/DiscountPlatformModel.d.ts +403 -110
- package/sdk/platform/Discount/DiscountPlatformModel.js +121 -107
- package/sdk/platform/Discount/DiscountPlatformValidator.d.ts +56 -36
- package/sdk/platform/Discount/DiscountPlatformValidator.js +29 -19
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +12 -110
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +14 -684
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +5 -94
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +4 -115
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +20 -20
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +22 -22
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +90 -920
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +53 -949
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +6 -6
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.js +6 -6
- package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +10 -10
- package/sdk/platform/Lead/LeadPlatformApplicationClient.js +10 -10
- package/sdk/platform/Lead/LeadPlatformClient.d.ts +11 -11
- package/sdk/platform/Lead/LeadPlatformClient.js +11 -11
- package/sdk/platform/Lead/LeadPlatformModel.d.ts +14 -9
- package/sdk/platform/Lead/LeadPlatformModel.js +20 -18
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +56 -9
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +340 -10
- package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +128 -24
- package/sdk/platform/Order/OrderPlatformApplicationValidator.js +81 -19
- package/sdk/platform/Order/OrderPlatformClient.d.ts +517 -160
- package/sdk/platform/Order/OrderPlatformClient.js +1623 -384
- package/sdk/platform/Order/OrderPlatformModel.d.ts +10372 -1587
- package/sdk/platform/Order/OrderPlatformModel.js +5726 -1512
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +539 -123
- package/sdk/platform/Order/OrderPlatformValidator.js +323 -92
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +8 -6
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +11 -9
- package/sdk/platform/Partner/PartnerPlatformApplicationValidator.d.ts +6 -4
- package/sdk/platform/Partner/PartnerPlatformApplicationValidator.js +3 -2
- package/sdk/platform/Partner/PartnerPlatformModel.d.ts +77 -25
- package/sdk/platform/Partner/PartnerPlatformModel.js +32 -21
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +144 -219
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +307 -796
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +86 -121
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +80 -138
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +30 -30
- package/sdk/platform/Payment/PaymentPlatformClient.js +30 -30
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +901 -761
- package/sdk/platform/Payment/PaymentPlatformModel.js +663 -583
- package/sdk/platform/Payment/PaymentPlatformValidator.d.ts +8 -8
- package/sdk/platform/Payment/PaymentPlatformValidator.js +8 -8
- package/sdk/platform/PlatformApplicationClient.d.ts +0 -2
- package/sdk/platform/PlatformApplicationClient.js +0 -4
- package/sdk/platform/PlatformClient.d.ts +5 -4
- package/sdk/platform/PlatformClient.js +32 -22
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +526 -69
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +3337 -337
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +603 -38
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +529 -32
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +184 -133
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +780 -491
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +9408 -1666
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +5720 -1765
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +257 -180
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +185 -127
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +7 -7
- package/sdk/platform/Share/SharePlatformApplicationClient.js +7 -7
- package/sdk/platform/Share/SharePlatformModel.d.ts +45 -9
- package/sdk/platform/Share/SharePlatformModel.js +31 -6
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +26 -26
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +38 -29
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +18 -3
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +10 -2
- package/sdk/platform/Theme/ThemePlatformClient.d.ts +4 -4
- package/sdk/platform/Theme/ThemePlatformClient.js +4 -4
- package/sdk/platform/Theme/ThemePlatformModel.d.ts +103 -17
- package/sdk/platform/Theme/ThemePlatformModel.js +92 -23
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +167 -45
- package/sdk/platform/User/UserPlatformApplicationClient.js +950 -67
- package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +189 -3
- package/sdk/platform/User/UserPlatformApplicationValidator.js +157 -3
- package/sdk/platform/User/UserPlatformModel.d.ts +880 -47
- package/sdk/platform/User/UserPlatformModel.js +607 -46
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +33 -86
- package/sdk/platform/Webhook/WebhookPlatformClient.js +79 -474
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +861 -422
- package/sdk/platform/Webhook/WebhookPlatformModel.js +469 -391
- package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +10 -55
- package/sdk/platform/Webhook/WebhookPlatformValidator.js +12 -72
- package/sdk/platform/index.d.ts +0 -2
- package/sdk/platform/index.js +0 -4
- package/sdk/public/Catalog/CatalogPublicClient.d.ts +22 -0
- package/sdk/public/Catalog/CatalogPublicClient.js +133 -0
- package/sdk/public/Catalog/CatalogPublicModel.d.ts +158 -0
- package/sdk/public/Catalog/CatalogPublicModel.js +116 -0
- package/sdk/public/Catalog/CatalogPublicValidator.d.ts +55 -0
- package/sdk/public/Catalog/CatalogPublicValidator.js +35 -0
- package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +5 -4
- package/sdk/public/Configuration/ConfigurationPublicClient.js +9 -8
- package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +41 -21
- package/sdk/public/Configuration/ConfigurationPublicModel.js +28 -12
- package/sdk/public/Content/ContentPublicClient.d.ts +145 -2
- package/sdk/public/Content/ContentPublicClient.js +1067 -17
- package/sdk/public/Content/ContentPublicModel.d.ts +704 -3
- package/sdk/public/Content/ContentPublicModel.js +751 -3
- package/sdk/public/Content/ContentPublicValidator.d.ts +94 -3
- package/sdk/public/Content/ContentPublicValidator.js +119 -2
- package/sdk/public/Partner/PartnerPublicClient.d.ts +1 -1
- package/sdk/public/Partner/PartnerPublicClient.js +1 -1
- package/sdk/public/Partner/PartnerPublicModel.d.ts +248 -72
- package/sdk/public/Partner/PartnerPublicModel.js +81 -71
- package/sdk/public/Partner/PartnerPublicValidator.d.ts +2 -2
- package/sdk/public/Partner/PartnerPublicValidator.js +1 -1
- package/sdk/public/PublicClient.d.ts +5 -2
- package/sdk/public/PublicClient.js +16 -6
- package/sdk/public/Webhook/WebhookPublicClient.d.ts +13 -13
- package/sdk/public/Webhook/WebhookPublicClient.js +13 -13
- package/sdk/public/Webhook/WebhookPublicModel.d.ts +249 -67
- package/sdk/public/Webhook/WebhookPublicModel.js +81 -61
- package/sdk/public/Webhook/WebhookPublicValidator.d.ts +4 -4
- package/sdk/public/Webhook/WebhookPublicValidator.js +4 -4
- package/sdk/public/index.d.ts +1 -0
- package/sdk/public/index.js +2 -0
- package/utility.d.ts +3 -0
- package/utility.js +7 -0
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +0 -79
- package/sdk/application/Rewards/RewardsApplicationClient.js +0 -315
- package/sdk/application/Webhook/WebhookApplicationClient.d.ts +0 -19
- package/sdk/application/Webhook/WebhookApplicationClient.js +0 -72
- package/sdk/platform/Finance/FinancePlatformClient.d.ts +0 -320
- package/sdk/platform/Finance/FinancePlatformClient.js +0 -2333
- package/sdk/platform/Finance/FinancePlatformModel.d.ts +0 -2890
- package/sdk/platform/Finance/FinancePlatformModel.js +0 -2148
- package/sdk/platform/Finance/FinancePlatformValidator.d.ts +0 -284
- package/sdk/platform/Finance/FinancePlatformValidator.js +0 -354
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +0 -136
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +0 -976
- package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.d.ts +0 -152
- package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.js +0 -157
- package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +0 -382
- package/sdk/platform/Rewards/RewardsPlatformModel.js +0 -408
|
@@ -1,6 +1,21 @@
|
|
|
1
1
|
export = PaymentPlatformModel;
|
|
2
2
|
/**
|
|
3
|
-
* @typedef
|
|
3
|
+
* @typedef AggregatorToken
|
|
4
|
+
* @property {number} payment_mode_id - Payment mode identifier Supported values are:
|
|
5
|
+
*
|
|
6
|
+
* - **4**: Wallet
|
|
7
|
+
* - **3**: Net Banking
|
|
8
|
+
* - **2**: Card
|
|
9
|
+
* - **1**: Pay Later
|
|
10
|
+
*
|
|
11
|
+
* @property {string} sub_payment_mode_code - Sub-payment method code
|
|
12
|
+
* @property {string} token - Token value to be saved for the aggregator
|
|
13
|
+
* @property {string} status - Status of the token verification
|
|
14
|
+
* @property {boolean} is_active - Enable or Disable Flag
|
|
15
|
+
* @property {string} domain - Name of domain
|
|
16
|
+
*/
|
|
17
|
+
/**
|
|
18
|
+
* @typedef PaymentGatewayConfigDetails
|
|
4
19
|
* @property {Object[]} [aggregators] - List of all config specific to the
|
|
5
20
|
* aggregator with their Details.
|
|
6
21
|
* @property {string} app_id - Application Id to which Payment config Mapped
|
|
@@ -25,7 +40,7 @@ export = PaymentPlatformModel;
|
|
|
25
40
|
* payment aggregator for the merchant.
|
|
26
41
|
*/
|
|
27
42
|
/**
|
|
28
|
-
* @typedef
|
|
43
|
+
* @typedef PaymentGatewayConfigCreation
|
|
29
44
|
* @property {string} app_id - Application Id to which Payment config Mapped
|
|
30
45
|
* @property {boolean} [is_active] - Enable or Disable Flag
|
|
31
46
|
* @property {PaymentGatewayConfig} [aggregator_name]
|
|
@@ -41,7 +56,7 @@ export = PaymentPlatformModel;
|
|
|
41
56
|
* @property {string} code - Error descrption code.
|
|
42
57
|
*/
|
|
43
58
|
/**
|
|
44
|
-
* @typedef
|
|
59
|
+
* @typedef HttpErrorDetails
|
|
45
60
|
* @property {ErrorCodeAndDescription} error
|
|
46
61
|
* @property {boolean} success - Response is successful or not
|
|
47
62
|
*/
|
|
@@ -53,10 +68,10 @@ export = PaymentPlatformModel;
|
|
|
53
68
|
/**
|
|
54
69
|
* @typedef ProductCODData
|
|
55
70
|
* @property {Object} [items] - Item id with its cod availability.
|
|
56
|
-
* @property {
|
|
71
|
+
* @property {CODChargesLimitsDetails} [cod_charges]
|
|
57
72
|
*/
|
|
58
73
|
/**
|
|
59
|
-
* @typedef
|
|
74
|
+
* @typedef CODChargesLimitsDetails
|
|
60
75
|
* @property {number} [max_cart_value] - Max allowed cart value for cod order.
|
|
61
76
|
* @property {number} [min_cart_value] - Min allowed cart value for cod order.
|
|
62
77
|
* @property {number} [cod_charge] - Cod charges to be applied on order.
|
|
@@ -112,6 +127,15 @@ export = PaymentPlatformModel;
|
|
|
112
127
|
* @property {number} [exp_year] - Exp_year
|
|
113
128
|
* @property {string} [name] - Name
|
|
114
129
|
* @property {string[]} [intent_app_error_list] - Intent_app_error_list
|
|
130
|
+
* @property {PaymentConfirmationElement[]} [payment_confirmation_elements] -
|
|
131
|
+
* List of additional fields required to confirm the payment, such as
|
|
132
|
+
* transaction ID or receipt image.
|
|
133
|
+
*/
|
|
134
|
+
/**
|
|
135
|
+
* @typedef PaymentConfirmationElement
|
|
136
|
+
* @property {boolean} [is_required]
|
|
137
|
+
* @property {string} [display_label]
|
|
138
|
+
* @property {string} [slug]
|
|
115
139
|
*/
|
|
116
140
|
/**
|
|
117
141
|
* @typedef RootPaymentMode
|
|
@@ -148,17 +172,11 @@ export = PaymentPlatformModel;
|
|
|
148
172
|
* @typedef PaymentFlow
|
|
149
173
|
* @property {AggregatorRoute} [bqr_razorpay]
|
|
150
174
|
* @property {AggregatorRoute} [fynd]
|
|
151
|
-
* @property {AggregatorRoute} [epaylater]
|
|
152
175
|
* @property {AggregatorRoute} [razorpay]
|
|
153
176
|
* @property {AggregatorRoute} [juspay]
|
|
154
|
-
* @property {AggregatorRoute} [ajiodhan]
|
|
155
177
|
* @property {AggregatorRoute} [simpl]
|
|
156
|
-
* @property {AggregatorRoute} [rupifi]
|
|
157
|
-
* @property {AggregatorRoute} [mswipe]
|
|
158
|
-
* @property {AggregatorRoute} [stripe]
|
|
159
178
|
* @property {AggregatorRoute} [ccavenue]
|
|
160
179
|
* @property {AggregatorRoute} [payubiz]
|
|
161
|
-
* @property {AggregatorRoute} [jiopay]
|
|
162
180
|
*/
|
|
163
181
|
/**
|
|
164
182
|
* @typedef PaymentOptionAndFlow
|
|
@@ -198,14 +216,14 @@ export = PaymentPlatformModel;
|
|
|
198
216
|
* @property {AdvanceObject} [advance]
|
|
199
217
|
*/
|
|
200
218
|
/**
|
|
201
|
-
* @typedef
|
|
219
|
+
* @typedef PaymentModeRouteDetails
|
|
202
220
|
* @property {PaymentOptionAndFlow} payment_options
|
|
203
221
|
* @property {boolean} success - Response is successful or not
|
|
204
222
|
* @property {Object} [payment_breakup] - Payment Breakup for advance payment
|
|
205
223
|
* @property {AdvancePaymentObject[]} [advance_payment] - Advance Payment Array
|
|
206
224
|
*/
|
|
207
225
|
/**
|
|
208
|
-
* @typedef
|
|
226
|
+
* @typedef PaymentOptionsDetails
|
|
209
227
|
* @property {PaymentOptions} payment_options
|
|
210
228
|
* @property {boolean} success - Response is successful or not
|
|
211
229
|
* @property {Object} [payment_breakup] - Payment Breakup for advance payment
|
|
@@ -247,7 +265,7 @@ export = PaymentPlatformModel;
|
|
|
247
265
|
* @property {string} transfer_type - Transafer type
|
|
248
266
|
*/
|
|
249
267
|
/**
|
|
250
|
-
* @typedef
|
|
268
|
+
* @typedef PayoutsDetails
|
|
251
269
|
* @property {boolean} success - Response is successful or not
|
|
252
270
|
* @property {Payout[]} items - Contains list of PayoutSchema
|
|
253
271
|
*/
|
|
@@ -265,7 +283,7 @@ export = PaymentPlatformModel;
|
|
|
265
283
|
* @property {number} [pincode]
|
|
266
284
|
*/
|
|
267
285
|
/**
|
|
268
|
-
* @typedef
|
|
286
|
+
* @typedef PayoutCreation
|
|
269
287
|
* @property {string} aggregator - Aggregator Name
|
|
270
288
|
* @property {Object} users - Payout users object
|
|
271
289
|
* @property {string} unique_external_id - Unique Id of Payout
|
|
@@ -274,7 +292,7 @@ export = PaymentPlatformModel;
|
|
|
274
292
|
* @property {string} transfer_type - Transafer type
|
|
275
293
|
*/
|
|
276
294
|
/**
|
|
277
|
-
* @typedef
|
|
295
|
+
* @typedef PayoutDetails
|
|
278
296
|
* @property {string} payment_status - Status of payment
|
|
279
297
|
* @property {Object} users - Users details object
|
|
280
298
|
* @property {string} aggregator - Aggregator Name
|
|
@@ -287,47 +305,47 @@ export = PaymentPlatformModel;
|
|
|
287
305
|
* @property {Object} payouts - Payout object
|
|
288
306
|
*/
|
|
289
307
|
/**
|
|
290
|
-
* @typedef
|
|
308
|
+
* @typedef UpdatePayoutDetails
|
|
291
309
|
* @property {boolean} is_default - Enable or Disable Default Payout
|
|
292
310
|
* @property {boolean} is_active - Enable or DIsable Flag Payout
|
|
293
311
|
* @property {boolean} success - Response is successful or not
|
|
294
312
|
*/
|
|
295
313
|
/**
|
|
296
|
-
* @typedef
|
|
314
|
+
* @typedef UpdatePayoutCreation
|
|
297
315
|
* @property {boolean} is_default - Enable or Disable Default Payout
|
|
298
316
|
* @property {boolean} is_active - Enable or Disable Flag Payout
|
|
299
317
|
* @property {string} unique_external_id - Unique Id of Payout
|
|
300
318
|
*/
|
|
301
319
|
/**
|
|
302
|
-
* @typedef
|
|
320
|
+
* @typedef DeletePayoutDetails
|
|
303
321
|
* @property {boolean} success - Response is successful or not
|
|
304
322
|
*/
|
|
305
323
|
/**
|
|
306
|
-
* @typedef
|
|
324
|
+
* @typedef SubscriptionPaymentMethodDetails
|
|
307
325
|
* @property {Object[]} data - Subscription Payment Method Object
|
|
308
326
|
* @property {boolean} success - Response is successful or not
|
|
309
327
|
*/
|
|
310
328
|
/**
|
|
311
|
-
* @typedef
|
|
329
|
+
* @typedef DeleteSubscriptionPaymentMethodDetails
|
|
312
330
|
* @property {boolean} success - Success or failure.
|
|
313
331
|
*/
|
|
314
332
|
/**
|
|
315
|
-
* @typedef
|
|
333
|
+
* @typedef SubscriptionConfigDetails
|
|
316
334
|
* @property {string} aggregator - Aggregator Name
|
|
317
335
|
* @property {Object} config - Aggregator Config
|
|
318
336
|
* @property {boolean} success - Response is successful or not
|
|
319
337
|
*/
|
|
320
338
|
/**
|
|
321
|
-
* @typedef
|
|
339
|
+
* @typedef SaveSubscriptionSetupIntentCreation
|
|
322
340
|
* @property {string} unique_external_id - Unique id i.e company:id
|
|
323
341
|
*/
|
|
324
342
|
/**
|
|
325
|
-
* @typedef
|
|
343
|
+
* @typedef SaveSubscriptionSetupIntentDetails
|
|
326
344
|
* @property {Object} data - Subscription Payment Method Object
|
|
327
345
|
* @property {boolean} success - Response is successful or not
|
|
328
346
|
*/
|
|
329
347
|
/**
|
|
330
|
-
* @typedef
|
|
348
|
+
* @typedef RefundAccountDetails
|
|
331
349
|
* @property {boolean} [is_verified_flag] - Account is verified or not
|
|
332
350
|
* @property {string} [message] - Response message
|
|
333
351
|
* @property {Object} data - Refund account data.
|
|
@@ -341,19 +359,21 @@ export = PaymentPlatformModel;
|
|
|
341
359
|
*/
|
|
342
360
|
/**
|
|
343
361
|
* @typedef BankDetailsForOTP
|
|
344
|
-
* @property {string} ifsc_code - IFSC code of account
|
|
345
|
-
* @property {string} account_no - Account number
|
|
346
|
-
* @property {string} branch_name - Branch name of account
|
|
347
|
-
* @property {string} bank_name - Bank name of account
|
|
348
|
-
* @property {string} account_holder - Accountg holder name of account
|
|
362
|
+
* @property {string} [ifsc_code] - IFSC code of account
|
|
363
|
+
* @property {string} [account_no] - Account number
|
|
364
|
+
* @property {string} [branch_name] - Branch name of account
|
|
365
|
+
* @property {string} [bank_name] - Bank name of account
|
|
366
|
+
* @property {string} [account_holder] - Accountg holder name of account
|
|
367
|
+
* @property {string} [upi] - UPI ID of account holder
|
|
349
368
|
*/
|
|
350
369
|
/**
|
|
351
|
-
* @typedef
|
|
370
|
+
* @typedef AddBeneficiaryDetailsOTPCreation
|
|
352
371
|
* @property {string} order_id - Order_id for which account will be added
|
|
372
|
+
* @property {string} [shipment_id] - Shipment_id for which account will be added
|
|
353
373
|
* @property {BankDetailsForOTP} details
|
|
354
374
|
*/
|
|
355
375
|
/**
|
|
356
|
-
* @typedef
|
|
376
|
+
* @typedef IfscCodeDetails
|
|
357
377
|
* @property {string} branch_name - Branch Name Of Account
|
|
358
378
|
* @property {boolean} [success] - Response is successful or not
|
|
359
379
|
* @property {string} bank_name - Bank Name Of Account
|
|
@@ -381,7 +401,7 @@ export = PaymentPlatformModel;
|
|
|
381
401
|
* @property {string} [mobile] - MObile no of User
|
|
382
402
|
*/
|
|
383
403
|
/**
|
|
384
|
-
* @typedef
|
|
404
|
+
* @typedef OrderBeneficiaryFetchResults
|
|
385
405
|
* @property {OrderBeneficiaryDetails[]} [beneficiaries] - All Beneficiaries Of An Order
|
|
386
406
|
* @property {boolean} [show_beneficiary_details] - Show beneficiary details or not.
|
|
387
407
|
*/
|
|
@@ -407,12 +427,12 @@ export = PaymentPlatformModel;
|
|
|
407
427
|
* @property {string} mode - Payment mode short code
|
|
408
428
|
*/
|
|
409
429
|
/**
|
|
410
|
-
* @typedef
|
|
430
|
+
* @typedef PaymentConfirmationCreation
|
|
411
431
|
* @property {string} order_id - Unique order id
|
|
412
432
|
* @property {MultiTenderPaymentMethod[]} payment_methods
|
|
413
433
|
*/
|
|
414
434
|
/**
|
|
415
|
-
* @typedef
|
|
435
|
+
* @typedef PaymentConfirmationDetails
|
|
416
436
|
* @property {string} order_id - Unique order id
|
|
417
437
|
* @property {string} message - Message
|
|
418
438
|
* @property {boolean} success - Payment confirmation updated or not.
|
|
@@ -440,118 +460,31 @@ export = PaymentPlatformModel;
|
|
|
440
460
|
* @property {CODLimitConfig} limit
|
|
441
461
|
*/
|
|
442
462
|
/**
|
|
443
|
-
* @typedef
|
|
463
|
+
* @typedef GetUserBULimitResponseSchema
|
|
444
464
|
* @property {string} business_unit - COD limit business unit
|
|
445
465
|
* @property {string} display_name - Display name for cod limit
|
|
446
466
|
* @property {CODPaymentLimitConfig} config
|
|
447
467
|
*/
|
|
448
468
|
/**
|
|
449
|
-
* @typedef
|
|
450
|
-
* @property {
|
|
469
|
+
* @typedef GetUserCODLimitDetails
|
|
470
|
+
* @property {GetUserBULimitResponseSchema[]} items
|
|
451
471
|
* @property {boolean} success - Response is successful or not
|
|
452
472
|
* @property {string} [message] - Message for cod limit
|
|
453
473
|
*/
|
|
454
474
|
/**
|
|
455
|
-
* @typedef
|
|
475
|
+
* @typedef SetCODForUserCreation
|
|
456
476
|
* @property {string} [business_unit] - Business unit
|
|
457
477
|
* @property {string} mobileno - Mobile No. of User
|
|
458
478
|
* @property {boolean} is_active - Either true or false
|
|
459
479
|
* @property {string} merchant_user_id - Merchant User id
|
|
460
480
|
*/
|
|
461
481
|
/**
|
|
462
|
-
* @typedef
|
|
482
|
+
* @typedef SetCODOptionDetails
|
|
463
483
|
* @property {string} message - Message
|
|
464
484
|
* @property {boolean} success - Response is successful or not
|
|
465
485
|
*/
|
|
466
486
|
/**
|
|
467
|
-
* @typedef
|
|
468
|
-
* @property {string} aggregator - Name of aggregator
|
|
469
|
-
* @property {number} aggregator_id - ID of aggregator
|
|
470
|
-
* @property {string[]} models - List of string of edc models
|
|
471
|
-
*/
|
|
472
|
-
/**
|
|
473
|
-
* @typedef EdcAggregatorAndModelListResponse
|
|
474
|
-
* @property {EdcModelData[]} data - List of aggregators and their edc models
|
|
475
|
-
* @property {boolean} success - Response is successful or not
|
|
476
|
-
*/
|
|
477
|
-
/**
|
|
478
|
-
* @typedef StatisticsData
|
|
479
|
-
* @property {number} inactive_device_count - No of inactive devices
|
|
480
|
-
* @property {number} active_device_count - No of active devices
|
|
481
|
-
*/
|
|
482
|
-
/**
|
|
483
|
-
* @typedef EdcDeviceStatsResponse
|
|
484
|
-
* @property {StatisticsData} statistics
|
|
485
|
-
* @property {boolean} success - Response is successful or not
|
|
486
|
-
*/
|
|
487
|
-
/**
|
|
488
|
-
* @typedef EdcAddRequest
|
|
489
|
-
* @property {string} edc_model - Model of the edc machine
|
|
490
|
-
* @property {number} store_id - Store at which devices is to used
|
|
491
|
-
* @property {number} aggregator_id - Aggregator which will accept payment
|
|
492
|
-
* @property {string} edc_device_serial_no - Serial number or imei of EDC device
|
|
493
|
-
* @property {string} terminal_serial_no - Device serial number of
|
|
494
|
-
* terminal(android tablet)
|
|
495
|
-
* @property {string} [device_tag] - Device tag of edc device to identify it
|
|
496
|
-
*/
|
|
497
|
-
/**
|
|
498
|
-
* @typedef EdcDevice
|
|
499
|
-
* @property {string} [edc_model] - Name of the model
|
|
500
|
-
* @property {number} store_id - Store at which devices is to used
|
|
501
|
-
* @property {number} aggregator_id - Aggregator which will accept payment
|
|
502
|
-
* @property {string} terminal_unique_identifier - Genearated unique value for edc device
|
|
503
|
-
* @property {string} edc_device_serial_no - Serial number of EDC device
|
|
504
|
-
* @property {boolean} is_active - State whether device is active or inactive
|
|
505
|
-
* @property {string} [aggregator_name] - Name of the corresponding aggregator
|
|
506
|
-
* @property {string} terminal_serial_no - Device serial number of
|
|
507
|
-
* terminal(android tablet)
|
|
508
|
-
* @property {string} [merchant_store_pos_code] - This is provided by pinelabs
|
|
509
|
-
* @property {string} device_tag - Device tag of edc device to identify it
|
|
510
|
-
* @property {string} application_id - Application ID
|
|
511
|
-
*/
|
|
512
|
-
/**
|
|
513
|
-
* @typedef EdcDeviceAddResponse
|
|
514
|
-
* @property {EdcDevice} data
|
|
515
|
-
* @property {boolean} success - Response is successful or not
|
|
516
|
-
*/
|
|
517
|
-
/**
|
|
518
|
-
* @typedef EdcDeviceDetailsResponse
|
|
519
|
-
* @property {EdcDevice} data
|
|
520
|
-
* @property {boolean} success - Response is successful or not
|
|
521
|
-
*/
|
|
522
|
-
/**
|
|
523
|
-
* @typedef EdcUpdateRequest
|
|
524
|
-
* @property {string} [edc_model] - Model of the edc machine
|
|
525
|
-
* @property {number} [store_id] - Store at which devices is to used
|
|
526
|
-
* @property {number} [aggregator_id] - Aggregator which will accept payment
|
|
527
|
-
* @property {string} [edc_device_serial_no] - Serial number or imei of EDC device
|
|
528
|
-
* @property {boolean} [is_active] - State whether device is active or inactive
|
|
529
|
-
* @property {string} [merchant_store_pos_code] - This is provided by pinelabs
|
|
530
|
-
* @property {string} [device_tag] - Device tag of edc device to identify it
|
|
531
|
-
*/
|
|
532
|
-
/**
|
|
533
|
-
* @typedef EdcDeviceUpdateResponse
|
|
534
|
-
* @property {boolean} success - Response is successful or not
|
|
535
|
-
*/
|
|
536
|
-
/**
|
|
537
|
-
* @typedef Page
|
|
538
|
-
* @property {number} [item_total] - The total number of items on the page.
|
|
539
|
-
* @property {string} [next_id] - The identifier for the next page.
|
|
540
|
-
* @property {boolean} [has_previous] - Indicates whether there is a previous page.
|
|
541
|
-
* @property {boolean} [has_next] - Indicates whether there is a next page.
|
|
542
|
-
* @property {number} [current] - The current page number.
|
|
543
|
-
* @property {string} type - The type of the page, such as 'PageType'.
|
|
544
|
-
* @property {number} [size] - The number of items per page.
|
|
545
|
-
*/
|
|
546
|
-
/**
|
|
547
|
-
* @typedef EdcDeviceListResponse
|
|
548
|
-
* @property {EdcDevice[]} items - List of all edc mapped to the application
|
|
549
|
-
* options with their Details.
|
|
550
|
-
* @property {Page} page
|
|
551
|
-
* @property {boolean} success - Response is successful or not
|
|
552
|
-
*/
|
|
553
|
-
/**
|
|
554
|
-
* @typedef PaymentInitializationRequest
|
|
487
|
+
* @typedef PaymentInitializationCreation
|
|
555
488
|
* @property {string} [razorpay_payment_id] - Payment gateway payment id
|
|
556
489
|
* @property {string} [device_id] - EDC machine Unique Identifier
|
|
557
490
|
* @property {string} email - Customer valid email
|
|
@@ -567,7 +500,7 @@ export = PaymentPlatformModel;
|
|
|
567
500
|
* @property {string} method - Payment method
|
|
568
501
|
*/
|
|
569
502
|
/**
|
|
570
|
-
* @typedef
|
|
503
|
+
* @typedef PaymentInitializationDetails
|
|
571
504
|
* @property {string} [razorpay_payment_id] - Payment id.
|
|
572
505
|
* @property {string} [device_id] - EDC machine Unique Identifier
|
|
573
506
|
* @property {string} [upi_poll_url] - UPI poll url.
|
|
@@ -587,7 +520,7 @@ export = PaymentPlatformModel;
|
|
|
587
520
|
* @property {string} method - Payment method
|
|
588
521
|
*/
|
|
589
522
|
/**
|
|
590
|
-
* @typedef
|
|
523
|
+
* @typedef PaymentStatusUpdateCreation
|
|
591
524
|
* @property {string} [device_id] - EDC machine Unique Identifier
|
|
592
525
|
* @property {string} email - Customer valid email
|
|
593
526
|
* @property {string} customer_id - Payment gateway customer id.
|
|
@@ -603,7 +536,7 @@ export = PaymentPlatformModel;
|
|
|
603
536
|
* @property {string} merchant_transaction_id - Unique fynd transaction id
|
|
604
537
|
*/
|
|
605
538
|
/**
|
|
606
|
-
* @typedef
|
|
539
|
+
* @typedef PaymentStatusUpdateDetails
|
|
607
540
|
* @property {string} [redirect_url] - Redirect url
|
|
608
541
|
* @property {boolean} retry - Response is successful or not.
|
|
609
542
|
* @property {boolean} [success] - Response is successful or not
|
|
@@ -611,7 +544,7 @@ export = PaymentPlatformModel;
|
|
|
611
544
|
* @property {string} aggregator_name - Payment gateway name
|
|
612
545
|
*/
|
|
613
546
|
/**
|
|
614
|
-
* @typedef
|
|
547
|
+
* @typedef ResendOrCancelPaymentCreation
|
|
615
548
|
* @property {string} order_id - Unique order id
|
|
616
549
|
* @property {string} [device_id] - EDC machine Unique Identifier
|
|
617
550
|
* @property {string} request_type - Either resend or cancel
|
|
@@ -624,16 +557,16 @@ export = PaymentPlatformModel;
|
|
|
624
557
|
* status of payment link.
|
|
625
558
|
*/
|
|
626
559
|
/**
|
|
627
|
-
* @typedef
|
|
560
|
+
* @typedef ResendOrCancelPaymentDetails
|
|
628
561
|
* @property {LinkStatus} data
|
|
629
562
|
* @property {boolean} success - Response is successful or not.
|
|
630
563
|
*/
|
|
631
564
|
/**
|
|
632
|
-
* @typedef
|
|
565
|
+
* @typedef PaymentStatusBulkHandlerCreation
|
|
633
566
|
* @property {string[]} merchant_order_id - List of order ids
|
|
634
567
|
*/
|
|
635
568
|
/**
|
|
636
|
-
* @typedef
|
|
569
|
+
* @typedef PaymentObjectList
|
|
637
570
|
* @property {Object} user_object
|
|
638
571
|
* @property {string} modified_on
|
|
639
572
|
* @property {string} collected_by
|
|
@@ -656,10 +589,10 @@ export = PaymentPlatformModel;
|
|
|
656
589
|
/**
|
|
657
590
|
* @typedef PaymentStatusObject
|
|
658
591
|
* @property {string} merchant_order_id
|
|
659
|
-
* @property {
|
|
592
|
+
* @property {PaymentObjectList[]} [payment_object_list]
|
|
660
593
|
*/
|
|
661
594
|
/**
|
|
662
|
-
* @typedef
|
|
595
|
+
* @typedef PaymentStatusBulkHandlerDetails
|
|
663
596
|
* @property {number} [count]
|
|
664
597
|
* @property {PaymentStatusObject[]} [data]
|
|
665
598
|
* @property {string} success
|
|
@@ -667,7 +600,7 @@ export = PaymentPlatformModel;
|
|
|
667
600
|
* @property {number} status
|
|
668
601
|
*/
|
|
669
602
|
/**
|
|
670
|
-
* @typedef
|
|
603
|
+
* @typedef GetOauthUrlDetails
|
|
671
604
|
* @property {string} url - The url to call for authenticating
|
|
672
605
|
* @property {boolean} success - Response is successful or not
|
|
673
606
|
*/
|
|
@@ -677,46 +610,7 @@ export = PaymentPlatformModel;
|
|
|
677
610
|
* @property {boolean} success - Response is successful or not
|
|
678
611
|
*/
|
|
679
612
|
/**
|
|
680
|
-
* @typedef
|
|
681
|
-
* @property {string} fwd_shipment_id - Purchase Shipment Id
|
|
682
|
-
* @property {string} aggregator - Name of Payment Gateway
|
|
683
|
-
* @property {string} current_status - Status
|
|
684
|
-
* @property {string} merchant_order_id - Merchant's Order Id
|
|
685
|
-
* @property {number} amount - Amount to paid back
|
|
686
|
-
* @property {string} payment_mode - Payment Mode
|
|
687
|
-
* @property {number} outstanding_details_id - Outstanding details ID
|
|
688
|
-
* @property {string} aggregator_transaction_id - Unique Id for the transaction
|
|
689
|
-
* @property {string} aggregator_order_id - Id of payment gateway
|
|
690
|
-
* @property {string} payment_mode_identifier - Payment Mode Id
|
|
691
|
-
*/
|
|
692
|
-
/**
|
|
693
|
-
* @typedef RepaymentDetailsSerialiserPayAll
|
|
694
|
-
* @property {number} total_amount - Total amount
|
|
695
|
-
* @property {string} extension_order_id - Order id created in extension
|
|
696
|
-
* @property {string} aggregator_transaction_id - Unique Id for the transaction
|
|
697
|
-
* @property {string} aggregator_order_id - Id of payment gateway
|
|
698
|
-
* @property {RepaymentRequestDetails[]} [shipment_details]
|
|
699
|
-
*/
|
|
700
|
-
/**
|
|
701
|
-
* @typedef RepaymentResponse
|
|
702
|
-
* @property {Object} data
|
|
703
|
-
* @property {boolean} success - Success/Failure of the transaction
|
|
704
|
-
*/
|
|
705
|
-
/**
|
|
706
|
-
* @typedef MerchantOnBoardingRequest
|
|
707
|
-
* @property {string} credit_line_id - Merchant ID at Ajiodhan's end
|
|
708
|
-
* @property {string} aggregator - Payment aggregator name
|
|
709
|
-
* @property {string} app_id - Application id
|
|
710
|
-
* @property {string} user_id - Deadlock or Grimlock user id
|
|
711
|
-
* @property {string} status - Status
|
|
712
|
-
*/
|
|
713
|
-
/**
|
|
714
|
-
* @typedef MerchantOnBoardingResponse
|
|
715
|
-
* @property {Object} data
|
|
716
|
-
* @property {boolean} success - Success/Failure of the transaction
|
|
717
|
-
*/
|
|
718
|
-
/**
|
|
719
|
-
* @typedef ValidateCustomerRequest
|
|
613
|
+
* @typedef ValidateCustomerCreation
|
|
720
614
|
* @property {string} phone_number - User mobile number without country code.
|
|
721
615
|
* @property {string} aggregator - Payment gateway name in camel case i.e Simpl, Rupifi
|
|
722
616
|
* @property {string} [payload] - Hashed payload string.
|
|
@@ -727,13 +621,13 @@ export = PaymentPlatformModel;
|
|
|
727
621
|
* @property {Object} [billing_address] - Extra meta fields.
|
|
728
622
|
*/
|
|
729
623
|
/**
|
|
730
|
-
* @typedef
|
|
624
|
+
* @typedef ValidateCustomerDetails
|
|
731
625
|
* @property {string} message - Error or success message.
|
|
732
626
|
* @property {Object} [data] - Payment gateway response data
|
|
733
627
|
* @property {boolean} success - Response is successful or not
|
|
734
628
|
*/
|
|
735
629
|
/**
|
|
736
|
-
* @typedef
|
|
630
|
+
* @typedef GetPaymentLinkDetails
|
|
737
631
|
* @property {string} message - Message
|
|
738
632
|
* @property {number} status_code - HTTP status code
|
|
739
633
|
* @property {number} [amount] - Total value of order
|
|
@@ -757,7 +651,7 @@ export = PaymentPlatformModel;
|
|
|
757
651
|
* @property {boolean} [cancelled] - Payment link is cancelled or not
|
|
758
652
|
*/
|
|
759
653
|
/**
|
|
760
|
-
* @typedef
|
|
654
|
+
* @typedef ErrorDetails
|
|
761
655
|
* @property {number} status_code - HTTP status code
|
|
762
656
|
* @property {ErrorDescription} [error]
|
|
763
657
|
* @property {string} message - Message
|
|
@@ -772,7 +666,7 @@ export = PaymentPlatformModel;
|
|
|
772
666
|
* to be done via payment link
|
|
773
667
|
*/
|
|
774
668
|
/**
|
|
775
|
-
* @typedef
|
|
669
|
+
* @typedef CreatePaymentLinkCreation
|
|
776
670
|
* @property {string} email - Email to which the payment link is to be sent
|
|
777
671
|
* @property {number} amount - Total value of order
|
|
778
672
|
* @property {string} mobile_number - Mobile number to which the payment link is
|
|
@@ -781,9 +675,15 @@ export = PaymentPlatformModel;
|
|
|
781
675
|
* @property {string} [description] - Merchant order id
|
|
782
676
|
* @property {CreatePaymentLinkMeta} meta
|
|
783
677
|
* @property {string} external_order_id - Merchant order id
|
|
678
|
+
* @property {string} [success_redirection_url] - URL to which the user will be
|
|
679
|
+
* redirected after a successful payment.
|
|
680
|
+
* @property {string} [failure_redirection_url] - URL to which the user will be
|
|
681
|
+
* redirected if the payment fails.
|
|
682
|
+
* @property {boolean} [send_communication] - Flag indicating whether to send
|
|
683
|
+
* communications (e.g., SMS or email) for the payment link
|
|
784
684
|
*/
|
|
785
685
|
/**
|
|
786
|
-
* @typedef
|
|
686
|
+
* @typedef CreatePaymentLinkDetails
|
|
787
687
|
* @property {string} message - Message
|
|
788
688
|
* @property {number} status_code - HTTP status code
|
|
789
689
|
* @property {string} [payment_link_url] - Url of payment link
|
|
@@ -792,7 +692,7 @@ export = PaymentPlatformModel;
|
|
|
792
692
|
* @property {string} [payment_link_id] - Unique id of payment link
|
|
793
693
|
*/
|
|
794
694
|
/**
|
|
795
|
-
* @typedef
|
|
695
|
+
* @typedef PollingPaymentLinkDetails
|
|
796
696
|
* @property {string} [message] - Message
|
|
797
697
|
* @property {number} [http_status] - HTTP status code
|
|
798
698
|
* @property {number} [status_code] - HTTP status code
|
|
@@ -805,18 +705,18 @@ export = PaymentPlatformModel;
|
|
|
805
705
|
* @property {string} [aggregator_name] - Aggregator name
|
|
806
706
|
*/
|
|
807
707
|
/**
|
|
808
|
-
* @typedef
|
|
708
|
+
* @typedef CancelOrResendPaymentLinkCreation
|
|
809
709
|
* @property {string} payment_link_id - Unique id of payment link
|
|
810
710
|
*/
|
|
811
711
|
/**
|
|
812
|
-
* @typedef
|
|
712
|
+
* @typedef ResendPaymentLinkDetails
|
|
813
713
|
* @property {number} status_code - HTTP status code
|
|
814
714
|
* @property {string} message - Message
|
|
815
715
|
* @property {number} [polling_timeout] - Polling request timeout
|
|
816
716
|
* @property {boolean} success - Successful or failure
|
|
817
717
|
*/
|
|
818
718
|
/**
|
|
819
|
-
* @typedef
|
|
719
|
+
* @typedef CancelPaymentLinkDetails
|
|
820
720
|
* @property {number} status_code - HTTP status code
|
|
821
721
|
* @property {string} message - Message
|
|
822
722
|
* @property {boolean} success - Successful or failure
|
|
@@ -839,21 +739,126 @@ export = PaymentPlatformModel;
|
|
|
839
739
|
* @property {PaymentCode} method_code
|
|
840
740
|
*/
|
|
841
741
|
/**
|
|
842
|
-
* @typedef
|
|
742
|
+
* @typedef GetPaymentCodeDetails
|
|
843
743
|
* @property {GetPaymentCode} data
|
|
844
744
|
* @property {boolean} success - Response is successful or not.
|
|
845
745
|
*/
|
|
846
746
|
/**
|
|
847
|
-
* @typedef
|
|
747
|
+
* @typedef PlatformPaymentModeDetails
|
|
848
748
|
* @property {string} [message] - Message
|
|
849
749
|
* @property {Object[]} [items] - List of all aggregator and payment mode details.
|
|
850
750
|
* @property {boolean} success - Response is successful or not.
|
|
851
751
|
*/
|
|
852
752
|
/**
|
|
853
|
-
* @typedef
|
|
753
|
+
* @typedef PaymentModeConfig
|
|
754
|
+
* @property {string} [business_unit] - Business unit for which the configuration applies.
|
|
755
|
+
* @property {string} [device] - Device type for which the configuration applies.
|
|
756
|
+
* @property {boolean} [is_active] - Indicates if the payment configuration is
|
|
757
|
+
* currently active.
|
|
758
|
+
* @property {PaymentModeItems[]} [items] - List of payment modes available for
|
|
759
|
+
* the given business unit and device. This list is dynamic and can contain
|
|
760
|
+
* one or more payment modes.
|
|
761
|
+
*/
|
|
762
|
+
/**
|
|
763
|
+
* @typedef PaymentModeItems
|
|
764
|
+
* @property {number} [id] - Unique identifier for the payment mode.
|
|
765
|
+
* @property {string} [name] - Display name of the payment mode.
|
|
766
|
+
* @property {string} [short_code] - Short code for the payment mode.
|
|
767
|
+
* @property {LogoSet} [logos]
|
|
768
|
+
* @property {boolean} [is_active] - Indicates if this payment mode is active in
|
|
769
|
+
* the system.
|
|
770
|
+
* @property {SubPaymentMode[]} [sub_payment_mode] - Dynamic list of sub-payment
|
|
771
|
+
* modes under this payment mode.
|
|
772
|
+
* @property {boolean} [is_active_at_pg] - Indicates if this payment mode is
|
|
773
|
+
* active at the payment gateway (PG) side.
|
|
774
|
+
* @property {Object} [fulfillment_options] - Fulfillment options applicable for
|
|
775
|
+
* these payment modes. Keys are option slugs and values indicate whether the
|
|
776
|
+
* option is enabled.
|
|
777
|
+
*/
|
|
778
|
+
/**
|
|
779
|
+
* @typedef SubPaymentMode
|
|
780
|
+
* @property {string} [code] - Unique code of the sub-payment mode.
|
|
781
|
+
* @property {boolean} [is_active] - Indicates if this sub-payment mode is
|
|
782
|
+
* active in the system.
|
|
783
|
+
* @property {number} [priority] - Priority used for ordering in UI. Lower
|
|
784
|
+
* numbers can represent higher priority, depending on implementation.
|
|
785
|
+
* @property {LogoSet} [logos]
|
|
786
|
+
* @property {string} [name] - Human-readable name of the sub-payment mode.
|
|
787
|
+
* @property {boolean} [is_active_at_pg] - Indicates if this sub-payment mode is
|
|
788
|
+
* active at the payment gateway (PG) side.
|
|
789
|
+
*/
|
|
790
|
+
/**
|
|
791
|
+
* @typedef LogoSet
|
|
792
|
+
* @property {string} [large] - URL of the large-sized logo.
|
|
793
|
+
* @property {string} [small] - URL of the small-sized logo.
|
|
794
|
+
*/
|
|
795
|
+
/**
|
|
796
|
+
* @typedef PlatformLogoSet
|
|
797
|
+
* @property {string} [large] - URL of the large-sized logo.
|
|
798
|
+
* @property {string} [small] - URL of the small-sized logo.
|
|
799
|
+
*/
|
|
800
|
+
/**
|
|
801
|
+
* @typedef PlatformConfigPaymentModeDetails
|
|
802
|
+
* @property {string} [business_unit] - Business unit for which the
|
|
803
|
+
* configuration applies (e.g. "storefront", "pos").
|
|
804
|
+
* @property {string} [device] - Device or channel for which the configuration
|
|
805
|
+
* applies (e.g. "desktop", "android", "ios").
|
|
806
|
+
* @property {Object} [fulfillment_options] - Fulfillment options applicable for
|
|
807
|
+
* these payment modes. Keys are option slugs (e.g. "self-pickup", "delivery")
|
|
808
|
+
* and values indicate whether the option is enabled.
|
|
809
|
+
* @property {boolean} [is_active] - Overall active status for this aggregator
|
|
810
|
+
* payment configuration for the given application and device.
|
|
811
|
+
* @property {PlatformPaymentModeItem[]} [items] - List of payment modes and
|
|
812
|
+
* their configuration.
|
|
813
|
+
*/
|
|
814
|
+
/**
|
|
815
|
+
* @typedef PlatformPaymentModeItem
|
|
816
|
+
* @property {number} [id] - Unique identifier of the payment mode.
|
|
817
|
+
* @property {string} [name] - Human readable name of the payment mode.
|
|
818
|
+
* @property {string} [short_code] - Short code representing the payment mode.
|
|
819
|
+
* @property {PlatformLogoSet} [logos]
|
|
820
|
+
* @property {boolean} [is_active] - Indicates if the payment mode is enabled on
|
|
821
|
+
* the platform.
|
|
822
|
+
* @property {boolean} [is_active_at_pg] - Indicates if the payment mode is
|
|
823
|
+
* active at the payment gateway.
|
|
824
|
+
* @property {PlatformSubPaymentMode[]} [sub_payment_mode] - List of sub payment
|
|
825
|
+
* modes (e.g. card networks like VISA, MASTERCARD).
|
|
826
|
+
*/
|
|
827
|
+
/**
|
|
828
|
+
* @typedef PlatformSubPaymentMode
|
|
829
|
+
* @property {string} [code] - Code of the sub payment mode (e.g. "VISA", "AMEX").
|
|
830
|
+
* @property {string} [name] - Human readable name of the sub payment mode.
|
|
831
|
+
* @property {boolean} [is_active] - Indicates if the sub payment mode is enabled.
|
|
832
|
+
* @property {boolean} [is_active_at_pg] - Indicates if the sub payment mode is
|
|
833
|
+
* active at payment gateway.
|
|
834
|
+
* @property {number} [priority] - Display priority for the sub payment mode.
|
|
835
|
+
* Lower numbers indicate higher priority.
|
|
836
|
+
* @property {PlatformLogoSet} [logos]
|
|
837
|
+
*/
|
|
838
|
+
/**
|
|
839
|
+
* @typedef MerchnatPaymentModeCreation
|
|
854
840
|
* @property {Object} [offline] - Details to be updated for online payment configuration.
|
|
855
841
|
* @property {Object} [online] - Details to be updated for offline payment configuration.
|
|
856
842
|
*/
|
|
843
|
+
/**
|
|
844
|
+
* @typedef SkuDetails
|
|
845
|
+
* @property {string} [identifier] - SKU identifier of the offer
|
|
846
|
+
* @property {string} [sku_id] - Unique SKU identifier (example: GTIN, variant ID)
|
|
847
|
+
* @property {string} [sku_name] - Display name of the SKU
|
|
848
|
+
*/
|
|
849
|
+
/**
|
|
850
|
+
* @typedef AppliedOffer
|
|
851
|
+
* @property {boolean} [is_mop] - Whether the offer is a mop or not. MOP is a
|
|
852
|
+
* discount that is applied on the total order value.
|
|
853
|
+
* @property {string} [offer_type] - Type of offer. It can be either a bank or
|
|
854
|
+
* brand offer.
|
|
855
|
+
* @property {string} [offer_id] - Unique identifier for the offer.
|
|
856
|
+
* @property {string} [description] - Description of the offer.
|
|
857
|
+
* @property {number} [amount] - Amount of the offer in paise. (Example: ₹1 = 100 paise)
|
|
858
|
+
* @property {Object} [meta] - Extra meta data specific to extension
|
|
859
|
+
* @property {SkuDetails[]} [sku_details] - List of sku details for which the
|
|
860
|
+
* offer is applicable. This is applicable only for brand offers.
|
|
861
|
+
*/
|
|
857
862
|
/**
|
|
858
863
|
* @typedef OrderDetail
|
|
859
864
|
* @property {string} gid - Global identifier of the entity (e.g. order, cart
|
|
@@ -865,6 +870,7 @@ export = PaymentPlatformModel;
|
|
|
865
870
|
* @property {Object} aggregator_order_details - Aggregator order details
|
|
866
871
|
* generated by the payment gateway.
|
|
867
872
|
* @property {string} aggregator - Name of the payment gateway aggregator.
|
|
873
|
+
* @property {AppliedOffer[]} [applied_offers] - List of offers applied on the order.
|
|
868
874
|
*/
|
|
869
875
|
/**
|
|
870
876
|
* @typedef AddressDetail
|
|
@@ -889,6 +895,12 @@ export = PaymentPlatformModel;
|
|
|
889
895
|
* @property {string} city - City name
|
|
890
896
|
* @property {Object[]} [tags] - Optional address tag
|
|
891
897
|
*/
|
|
898
|
+
/**
|
|
899
|
+
* @typedef ReasonDetail
|
|
900
|
+
* @property {string} [code] - The code indicating the type of reason.
|
|
901
|
+
* @property {string} [description] - A detailed description of the payment
|
|
902
|
+
* reason or error.
|
|
903
|
+
*/
|
|
892
904
|
/**
|
|
893
905
|
* @typedef PaymentSessionDetail
|
|
894
906
|
* @property {string} payment_id - Unique transaction id generated by payment gateway
|
|
@@ -925,9 +937,10 @@ export = PaymentPlatformModel;
|
|
|
925
937
|
* merchant account) by payment gateway.
|
|
926
938
|
* @property {Object} [meta] - Extra meta data specific to extension
|
|
927
939
|
* @property {string} status - Status of the payment
|
|
940
|
+
* @property {ReasonDetail} [reason]
|
|
928
941
|
*/
|
|
929
942
|
/**
|
|
930
|
-
* @typedef
|
|
943
|
+
* @typedef PaymentSessionCreation
|
|
931
944
|
* @property {Object} [meta] - Extra meta data specific to extensions
|
|
932
945
|
* @property {string} gid - Global identifier of the entity (e.g. order, cart
|
|
933
946
|
* etc.) against which payment_session was initiated. This is generated by
|
|
@@ -942,7 +955,7 @@ export = PaymentPlatformModel;
|
|
|
942
955
|
* @property {string} [source] - Source of payment update session
|
|
943
956
|
*/
|
|
944
957
|
/**
|
|
945
|
-
* @typedef
|
|
958
|
+
* @typedef PaymentSessionPutDetails
|
|
946
959
|
* @property {string} gid - Global identifier of the entity (e.g. order, cart
|
|
947
960
|
* etc.) against which payment_session was initiated. This is generated by
|
|
948
961
|
* Fynd payments platform and is unique.
|
|
@@ -971,7 +984,7 @@ export = PaymentPlatformModel;
|
|
|
971
984
|
* @property {string} [balance_transaction] - Balance transaction.
|
|
972
985
|
*/
|
|
973
986
|
/**
|
|
974
|
-
* @typedef
|
|
987
|
+
* @typedef RefundSessionCreation
|
|
975
988
|
* @property {Object} [meta] - Meta
|
|
976
989
|
* @property {string} gid - Global identifier of the entity (e.g. order, cart
|
|
977
990
|
* etc.) against which payment_session was initiated. This is generated by
|
|
@@ -986,7 +999,7 @@ export = PaymentPlatformModel;
|
|
|
986
999
|
* @property {string} checksum - Checksum to verify payload
|
|
987
1000
|
*/
|
|
988
1001
|
/**
|
|
989
|
-
* @typedef
|
|
1002
|
+
* @typedef RefundSessionDetails
|
|
990
1003
|
* @property {string} gid - Global identifier of the entity (e.g. order, cart
|
|
991
1004
|
* etc.) against which payment_session was initiated. This is generated by
|
|
992
1005
|
* Fynd payments platform and is unique.
|
|
@@ -996,7 +1009,7 @@ export = PaymentPlatformModel;
|
|
|
996
1009
|
* @property {number} total_refund_amount - The total amount refunded.
|
|
997
1010
|
*/
|
|
998
1011
|
/**
|
|
999
|
-
* @typedef
|
|
1012
|
+
* @typedef PaymentDetails
|
|
1000
1013
|
* @property {Object[]} payment_methods - List of payment methods
|
|
1001
1014
|
* @property {string} gid - Global identifier of the entity (e.g. order, cart
|
|
1002
1015
|
* etc.) against which payment_session was initiated. This is generated by
|
|
@@ -1031,7 +1044,7 @@ export = PaymentPlatformModel;
|
|
|
1031
1044
|
* id generated by payment gateway
|
|
1032
1045
|
*/
|
|
1033
1046
|
/**
|
|
1034
|
-
* @typedef
|
|
1047
|
+
* @typedef CartDetails
|
|
1035
1048
|
* @property {Object} items - Items that are added in cart
|
|
1036
1049
|
* @property {Object[]} articles - List of articles that are added in cart
|
|
1037
1050
|
* @property {number} cart_value - Total cart value i.e. amount to be paid
|
|
@@ -1040,7 +1053,7 @@ export = PaymentPlatformModel;
|
|
|
1040
1053
|
* retrieve custom data fields to cart items.
|
|
1041
1054
|
*/
|
|
1042
1055
|
/**
|
|
1043
|
-
* @typedef
|
|
1056
|
+
* @typedef RefundDetails
|
|
1044
1057
|
* @property {number} amount - Refunded amount
|
|
1045
1058
|
* @property {string} currency - The currency of the payment.
|
|
1046
1059
|
* @property {string} request_id - Refund request id, unique id generated by Fynd platform
|
|
@@ -1049,7 +1062,7 @@ export = PaymentPlatformModel;
|
|
|
1049
1062
|
* @property {string} refund_utr - Unique refund utr generated by payment gateway.
|
|
1050
1063
|
*/
|
|
1051
1064
|
/**
|
|
1052
|
-
* @typedef
|
|
1065
|
+
* @typedef PaymentSessionFetchDetails
|
|
1053
1066
|
* @property {Object} payment_details - Object of payment details
|
|
1054
1067
|
* @property {string} [currency] - The currency of the payment.
|
|
1055
1068
|
* @property {string} status - The status of the payment session.
|
|
@@ -1057,8 +1070,8 @@ export = PaymentPlatformModel;
|
|
|
1057
1070
|
* @property {string} gid - Global identifier of the entity (e.g. order, cart
|
|
1058
1071
|
* etc.) against which payment_session was initiated. This is generated by
|
|
1059
1072
|
* Fynd payments platform and is unique.
|
|
1060
|
-
* @property {
|
|
1061
|
-
* @property {
|
|
1073
|
+
* @property {CartDetails} [cart_details]
|
|
1074
|
+
* @property {RefundDetails[]} refund_details - Object of refund details
|
|
1062
1075
|
*/
|
|
1063
1076
|
/**
|
|
1064
1077
|
* @typedef RefundSourcesPriority
|
|
@@ -1067,7 +1080,7 @@ export = PaymentPlatformModel;
|
|
|
1067
1080
|
* @property {string} source - Source of refund
|
|
1068
1081
|
*/
|
|
1069
1082
|
/**
|
|
1070
|
-
* @typedef
|
|
1083
|
+
* @typedef RefundPriorityDetails
|
|
1071
1084
|
* @property {string} configuration - Configuration for merchant or customer
|
|
1072
1085
|
* @property {boolean} success - Success
|
|
1073
1086
|
* @property {boolean} apportion - Apportion refund to multiple sources
|
|
@@ -1075,12 +1088,12 @@ export = PaymentPlatformModel;
|
|
|
1075
1088
|
* @property {string} [message] - Message
|
|
1076
1089
|
*/
|
|
1077
1090
|
/**
|
|
1078
|
-
* @typedef
|
|
1091
|
+
* @typedef RefundPriorityCreation
|
|
1079
1092
|
* @property {boolean} apportion - Apportion refund to multiple sources
|
|
1080
1093
|
* @property {RefundSourcesPriority[]} refund_sources_priority - Refund sources priority
|
|
1081
1094
|
*/
|
|
1082
1095
|
/**
|
|
1083
|
-
* @typedef
|
|
1096
|
+
* @typedef MerchantPaymentModeCreation
|
|
1084
1097
|
* @property {string} business_unit - Business unit
|
|
1085
1098
|
* @property {Object[]} items - List of item details with respect to payment_mode
|
|
1086
1099
|
* @property {Object} device - List of devices and its activation status
|
|
@@ -1096,7 +1109,7 @@ export = PaymentPlatformModel;
|
|
|
1096
1109
|
* @property {string} business_unit - Business unit name
|
|
1097
1110
|
*/
|
|
1098
1111
|
/**
|
|
1099
|
-
* @typedef
|
|
1112
|
+
* @typedef PlatformPaymentModeCopyConfigCreation
|
|
1100
1113
|
* @property {FromConfig} from_config
|
|
1101
1114
|
* @property {ToConfig} to_config
|
|
1102
1115
|
*/
|
|
@@ -1115,7 +1128,7 @@ export = PaymentPlatformModel;
|
|
|
1115
1128
|
* @property {string} name - Payment mode name
|
|
1116
1129
|
*/
|
|
1117
1130
|
/**
|
|
1118
|
-
* @typedef
|
|
1131
|
+
* @typedef PaymentOrderCreation
|
|
1119
1132
|
* @property {string} order_id - Order id
|
|
1120
1133
|
* @property {PaymentOrderMethods[]} [payment_methods]
|
|
1121
1134
|
* @property {string} [shipment_id] - Shipment_id
|
|
@@ -1134,7 +1147,7 @@ export = PaymentPlatformModel;
|
|
|
1134
1147
|
* @property {string} [merchant_order_id] - Merchant order id
|
|
1135
1148
|
*/
|
|
1136
1149
|
/**
|
|
1137
|
-
* @typedef
|
|
1150
|
+
* @typedef PaymentOrderDetails
|
|
1138
1151
|
* @property {string} message - Message
|
|
1139
1152
|
* @property {boolean} success - Successful or failure
|
|
1140
1153
|
* @property {string} [payment_confirm_url] - Payment confirm url for aggregator
|
|
@@ -1150,7 +1163,7 @@ export = PaymentPlatformModel;
|
|
|
1150
1163
|
* @property {string} [is_greater_than]
|
|
1151
1164
|
*/
|
|
1152
1165
|
/**
|
|
1153
|
-
* @typedef
|
|
1166
|
+
* @typedef AggregatorVersionDetails
|
|
1154
1167
|
* @property {string} message - Message
|
|
1155
1168
|
* @property {boolean} success - Successful or failure
|
|
1156
1169
|
* @property {AggregatorVersionItemSchema} [items]
|
|
@@ -1162,7 +1175,7 @@ export = PaymentPlatformModel;
|
|
|
1162
1175
|
* @property {string} [is_greater_than]
|
|
1163
1176
|
*/
|
|
1164
1177
|
/**
|
|
1165
|
-
* @typedef
|
|
1178
|
+
* @typedef PatchAggregatorControl
|
|
1166
1179
|
* @property {string} [business_unit] - Business unit
|
|
1167
1180
|
* @property {Object[]} [items] - List of item details with respect to payment_mode
|
|
1168
1181
|
* @property {string} [device] - Device name
|
|
@@ -1214,14 +1227,86 @@ export = PaymentPlatformModel;
|
|
|
1214
1227
|
* @property {string} message
|
|
1215
1228
|
* @property {PaymentModeCustomConfigSchema[]} items
|
|
1216
1229
|
*/
|
|
1230
|
+
/**
|
|
1231
|
+
* @typedef CustomerValidationSchema
|
|
1232
|
+
* @property {string} aggregator - Aggregator name of the payment gateway.
|
|
1233
|
+
* @property {number} transaction_amount - Payable amount
|
|
1234
|
+
* @property {string} [cart_id] - Unique identifier for the shopping cart.
|
|
1235
|
+
* @property {string} [user_id] - The unique identifier of the user.
|
|
1236
|
+
*/
|
|
1237
|
+
/**
|
|
1238
|
+
* @typedef UserCreditSchema
|
|
1239
|
+
* @property {number} amount - The monetary value, which can represent available
|
|
1240
|
+
* balance, redeemed balance, or hold amount, depending on the context.
|
|
1241
|
+
* @property {string} currency - The currency code (e.g., INR, USD).
|
|
1242
|
+
* @property {string} [unique_id] - A unique identifier for the payment transaction.
|
|
1243
|
+
*/
|
|
1244
|
+
/**
|
|
1245
|
+
* @typedef CreditAccountSummary
|
|
1246
|
+
* @property {string} account_id - Unique identifier associated with the
|
|
1247
|
+
* customer's account
|
|
1248
|
+
* @property {string} status - Current state of the account, indicating whether
|
|
1249
|
+
* it is ACTIVE, INACTIVE, or UNREGISTERED.
|
|
1250
|
+
* @property {UserCreditSchema} [redeemable_balance]
|
|
1251
|
+
* @property {UserCreditSchema} [available_balance]
|
|
1252
|
+
* @property {UserCreditSchema[]} [amount_on_hold]
|
|
1253
|
+
*/
|
|
1254
|
+
/**
|
|
1255
|
+
* @typedef ValidateCustomerCreditSchema
|
|
1256
|
+
* @property {boolean} success - Successful or failure of API
|
|
1257
|
+
* @property {boolean} is_eligible - The customer is eligible to make a transaction or not
|
|
1258
|
+
* @property {boolean} [is_applied] - Credit is applied to the user's account or not
|
|
1259
|
+
* @property {string} message - Detailed message about the user credt eligibility.
|
|
1260
|
+
* @property {string} [cart_id] - Unique identifier for the shopping cart.
|
|
1261
|
+
* @property {CreditAccountSummary} [account]
|
|
1262
|
+
*/
|
|
1263
|
+
/**
|
|
1264
|
+
* @typedef OperationResponseSchema
|
|
1265
|
+
* @property {boolean} success - Indicates if the operation was successful
|
|
1266
|
+
* @property {string} [message] - Optional message providing additional
|
|
1267
|
+
* information about the operation
|
|
1268
|
+
*/
|
|
1217
1269
|
declare class PaymentPlatformModel {
|
|
1218
1270
|
}
|
|
1219
1271
|
declare namespace PaymentPlatformModel {
|
|
1220
|
-
export {
|
|
1272
|
+
export { AggregatorToken, PaymentGatewayConfigDetails, ErrorCodeDescription, PaymentGatewayConfig, PaymentGatewayConfigCreation, PaymentGatewayToBeReviewed, ErrorCodeAndDescription, HttpErrorDetails, IntentAppErrorList, ProductCODData, CODChargesLimitsDetails, PaymentModeLogo, IntentApp, PaymentModeList, PaymentConfirmationElement, RootPaymentMode, PaymentOptions, AggregatorRoute, PaymentDefaultSelection, PaymentFlow, PaymentOptionAndFlow, AdvanceObject, SplitObject, AdvancePaymentObject, PaymentModeRouteDetails, PaymentOptionsDetails, PayoutCustomer, PayoutMoreAttributes, PayoutAggregator, Payout, PayoutsDetails, PayoutBankDetails, PayoutCreation, PayoutDetails, UpdatePayoutDetails, UpdatePayoutCreation, DeletePayoutDetails, SubscriptionPaymentMethodDetails, DeleteSubscriptionPaymentMethodDetails, SubscriptionConfigDetails, SaveSubscriptionSetupIntentCreation, SaveSubscriptionSetupIntentDetails, RefundAccountDetails, NotFoundResourceError, BankDetailsForOTP, AddBeneficiaryDetailsOTPCreation, IfscCodeDetails, OrderBeneficiaryDetails, OrderBeneficiaryFetchResults, MultiTenderPaymentMeta, MultiTenderPaymentMethod, PaymentConfirmationCreation, PaymentConfirmationDetails, CODdata, CODLimitConfig, CODPaymentLimitConfig, GetUserBULimitResponseSchema, GetUserCODLimitDetails, SetCODForUserCreation, SetCODOptionDetails, PaymentInitializationCreation, PaymentInitializationDetails, PaymentStatusUpdateCreation, PaymentStatusUpdateDetails, ResendOrCancelPaymentCreation, LinkStatus, ResendOrCancelPaymentDetails, PaymentStatusBulkHandlerCreation, PaymentObjectList, PaymentStatusObject, PaymentStatusBulkHandlerDetails, GetOauthUrlDetails, RevokeOAuthToken, ValidateCustomerCreation, ValidateCustomerDetails, GetPaymentLinkDetails, ErrorDescription, ErrorDetails, CreatePaymentLinkMeta, CreatePaymentLinkCreation, CreatePaymentLinkDetails, PollingPaymentLinkDetails, CancelOrResendPaymentLinkCreation, ResendPaymentLinkDetails, CancelPaymentLinkDetails, Code, PaymentCode, GetPaymentCode, GetPaymentCodeDetails, PlatformPaymentModeDetails, PaymentModeConfig, PaymentModeItems, SubPaymentMode, LogoSet, PlatformLogoSet, PlatformConfigPaymentModeDetails, PlatformPaymentModeItem, PlatformSubPaymentMode, MerchnatPaymentModeCreation, SkuDetails, AppliedOffer, OrderDetail, AddressDetail, ReasonDetail, PaymentSessionDetail, PaymentSessionCreation, PaymentSessionPutDetails, RefundSessionDetail, RefundSessionCreation, RefundSessionDetails, PaymentDetails, CartDetails, RefundDetails, PaymentSessionFetchDetails, RefundSourcesPriority, RefundPriorityDetails, RefundPriorityCreation, MerchantPaymentModeCreation, FromConfig, ToConfig, PlatformPaymentModeCopyConfigCreation, PaymentMethodsMetaOrder, PaymentOrderMethods, PaymentOrderCreation, PaymentOrderData, PaymentOrderDetails, AggregatorVersionItemSchema, AggregatorVersionDetails, AggregatorVersionRequestSchema, PatchAggregatorControl, PaymentModeCustomConfigSchema, PaymentCustomConfigDetailsSchema, PaymentCustomConfigCustomerSchema, PaymentCustomConfigModeSchema, PaymentCustomConfigDetailsRequestSchema, PaymentCustomConfigCustomerRequestSchema, PaymentCustomConfigRequestSchema, PaymentCustomConfigResponseSchema, CustomerValidationSchema, UserCreditSchema, CreditAccountSummary, ValidateCustomerCreditSchema, OperationResponseSchema };
|
|
1221
1273
|
}
|
|
1222
|
-
/** @returns {
|
|
1223
|
-
declare function
|
|
1224
|
-
type
|
|
1274
|
+
/** @returns {AggregatorToken} */
|
|
1275
|
+
declare function AggregatorToken(): AggregatorToken;
|
|
1276
|
+
type AggregatorToken = {
|
|
1277
|
+
/**
|
|
1278
|
+
* - Payment mode identifier Supported values are:
|
|
1279
|
+
*
|
|
1280
|
+
* - **4**: Wallet
|
|
1281
|
+
* - **3**: Net Banking
|
|
1282
|
+
* - **2**: Card
|
|
1283
|
+
* - **1**: Pay Later
|
|
1284
|
+
*/
|
|
1285
|
+
payment_mode_id: number;
|
|
1286
|
+
/**
|
|
1287
|
+
* - Sub-payment method code
|
|
1288
|
+
*/
|
|
1289
|
+
sub_payment_mode_code: string;
|
|
1290
|
+
/**
|
|
1291
|
+
* - Token value to be saved for the aggregator
|
|
1292
|
+
*/
|
|
1293
|
+
token: string;
|
|
1294
|
+
/**
|
|
1295
|
+
* - Status of the token verification
|
|
1296
|
+
*/
|
|
1297
|
+
status: string;
|
|
1298
|
+
/**
|
|
1299
|
+
* - Enable or Disable Flag
|
|
1300
|
+
*/
|
|
1301
|
+
is_active: boolean;
|
|
1302
|
+
/**
|
|
1303
|
+
* - Name of domain
|
|
1304
|
+
*/
|
|
1305
|
+
domain: string;
|
|
1306
|
+
};
|
|
1307
|
+
/** @returns {PaymentGatewayConfigDetails} */
|
|
1308
|
+
declare function PaymentGatewayConfigDetails(): PaymentGatewayConfigDetails;
|
|
1309
|
+
type PaymentGatewayConfigDetails = {
|
|
1225
1310
|
/**
|
|
1226
1311
|
* - List of all config specific to the
|
|
1227
1312
|
* aggregator with their Details.
|
|
@@ -1289,9 +1374,9 @@ type PaymentGatewayConfig = {
|
|
|
1289
1374
|
*/
|
|
1290
1375
|
merchant_salt: string;
|
|
1291
1376
|
};
|
|
1292
|
-
/** @returns {
|
|
1293
|
-
declare function
|
|
1294
|
-
type
|
|
1377
|
+
/** @returns {PaymentGatewayConfigCreation} */
|
|
1378
|
+
declare function PaymentGatewayConfigCreation(): PaymentGatewayConfigCreation;
|
|
1379
|
+
type PaymentGatewayConfigCreation = {
|
|
1295
1380
|
/**
|
|
1296
1381
|
* - Application Id to which Payment config Mapped
|
|
1297
1382
|
*/
|
|
@@ -1326,9 +1411,9 @@ type ErrorCodeAndDescription = {
|
|
|
1326
1411
|
*/
|
|
1327
1412
|
code: string;
|
|
1328
1413
|
};
|
|
1329
|
-
/** @returns {
|
|
1330
|
-
declare function
|
|
1331
|
-
type
|
|
1414
|
+
/** @returns {HttpErrorDetails} */
|
|
1415
|
+
declare function HttpErrorDetails(): HttpErrorDetails;
|
|
1416
|
+
type HttpErrorDetails = {
|
|
1332
1417
|
error: ErrorCodeAndDescription;
|
|
1333
1418
|
/**
|
|
1334
1419
|
* - Response is successful or not
|
|
@@ -1354,11 +1439,11 @@ type ProductCODData = {
|
|
|
1354
1439
|
* - Item id with its cod availability.
|
|
1355
1440
|
*/
|
|
1356
1441
|
items?: any;
|
|
1357
|
-
cod_charges?:
|
|
1442
|
+
cod_charges?: CODChargesLimitsDetails;
|
|
1358
1443
|
};
|
|
1359
|
-
/** @returns {
|
|
1360
|
-
declare function
|
|
1361
|
-
type
|
|
1444
|
+
/** @returns {CODChargesLimitsDetails} */
|
|
1445
|
+
declare function CODChargesLimitsDetails(): CODChargesLimitsDetails;
|
|
1446
|
+
type CODChargesLimitsDetails = {
|
|
1362
1447
|
/**
|
|
1363
1448
|
* - Max allowed cart value for cod order.
|
|
1364
1449
|
*/
|
|
@@ -1540,6 +1625,19 @@ type PaymentModeList = {
|
|
|
1540
1625
|
* - Intent_app_error_list
|
|
1541
1626
|
*/
|
|
1542
1627
|
intent_app_error_list?: string[];
|
|
1628
|
+
/**
|
|
1629
|
+
* -
|
|
1630
|
+
* List of additional fields required to confirm the payment, such as
|
|
1631
|
+
* transaction ID or receipt image.
|
|
1632
|
+
*/
|
|
1633
|
+
payment_confirmation_elements?: PaymentConfirmationElement[];
|
|
1634
|
+
};
|
|
1635
|
+
/** @returns {PaymentConfirmationElement} */
|
|
1636
|
+
declare function PaymentConfirmationElement(): PaymentConfirmationElement;
|
|
1637
|
+
type PaymentConfirmationElement = {
|
|
1638
|
+
is_required?: boolean;
|
|
1639
|
+
display_label?: string;
|
|
1640
|
+
slug?: string;
|
|
1543
1641
|
};
|
|
1544
1642
|
/** @returns {RootPaymentMode} */
|
|
1545
1643
|
declare function RootPaymentMode(): RootPaymentMode;
|
|
@@ -1632,17 +1730,11 @@ declare function PaymentFlow(): PaymentFlow;
|
|
|
1632
1730
|
type PaymentFlow = {
|
|
1633
1731
|
bqr_razorpay?: AggregatorRoute;
|
|
1634
1732
|
fynd?: AggregatorRoute;
|
|
1635
|
-
epaylater?: AggregatorRoute;
|
|
1636
1733
|
razorpay?: AggregatorRoute;
|
|
1637
1734
|
juspay?: AggregatorRoute;
|
|
1638
|
-
ajiodhan?: AggregatorRoute;
|
|
1639
1735
|
simpl?: AggregatorRoute;
|
|
1640
|
-
rupifi?: AggregatorRoute;
|
|
1641
|
-
mswipe?: AggregatorRoute;
|
|
1642
|
-
stripe?: AggregatorRoute;
|
|
1643
1736
|
ccavenue?: AggregatorRoute;
|
|
1644
1737
|
payubiz?: AggregatorRoute;
|
|
1645
|
-
jiopay?: AggregatorRoute;
|
|
1646
1738
|
};
|
|
1647
1739
|
/** @returns {PaymentOptionAndFlow} */
|
|
1648
1740
|
declare function PaymentOptionAndFlow(): PaymentOptionAndFlow;
|
|
@@ -1745,9 +1837,9 @@ type AdvancePaymentObject = {
|
|
|
1745
1837
|
split?: SplitObject;
|
|
1746
1838
|
advance?: AdvanceObject;
|
|
1747
1839
|
};
|
|
1748
|
-
/** @returns {
|
|
1749
|
-
declare function
|
|
1750
|
-
type
|
|
1840
|
+
/** @returns {PaymentModeRouteDetails} */
|
|
1841
|
+
declare function PaymentModeRouteDetails(): PaymentModeRouteDetails;
|
|
1842
|
+
type PaymentModeRouteDetails = {
|
|
1751
1843
|
payment_options: PaymentOptionAndFlow;
|
|
1752
1844
|
/**
|
|
1753
1845
|
* - Response is successful or not
|
|
@@ -1762,9 +1854,9 @@ type PaymentModeRouteResponse = {
|
|
|
1762
1854
|
*/
|
|
1763
1855
|
advance_payment?: AdvancePaymentObject[];
|
|
1764
1856
|
};
|
|
1765
|
-
/** @returns {
|
|
1766
|
-
declare function
|
|
1767
|
-
type
|
|
1857
|
+
/** @returns {PaymentOptionsDetails} */
|
|
1858
|
+
declare function PaymentOptionsDetails(): PaymentOptionsDetails;
|
|
1859
|
+
type PaymentOptionsDetails = {
|
|
1768
1860
|
payment_options: PaymentOptions;
|
|
1769
1861
|
/**
|
|
1770
1862
|
* - Response is successful or not
|
|
@@ -1878,9 +1970,9 @@ type Payout = {
|
|
|
1878
1970
|
*/
|
|
1879
1971
|
transfer_type: string;
|
|
1880
1972
|
};
|
|
1881
|
-
/** @returns {
|
|
1882
|
-
declare function
|
|
1883
|
-
type
|
|
1973
|
+
/** @returns {PayoutsDetails} */
|
|
1974
|
+
declare function PayoutsDetails(): PayoutsDetails;
|
|
1975
|
+
type PayoutsDetails = {
|
|
1884
1976
|
/**
|
|
1885
1977
|
* - Response is successful or not
|
|
1886
1978
|
*/
|
|
@@ -1904,9 +1996,9 @@ type PayoutBankDetails = {
|
|
|
1904
1996
|
branch_name?: string;
|
|
1905
1997
|
pincode?: number;
|
|
1906
1998
|
};
|
|
1907
|
-
/** @returns {
|
|
1908
|
-
declare function
|
|
1909
|
-
type
|
|
1999
|
+
/** @returns {PayoutCreation} */
|
|
2000
|
+
declare function PayoutCreation(): PayoutCreation;
|
|
2001
|
+
type PayoutCreation = {
|
|
1910
2002
|
/**
|
|
1911
2003
|
* - Aggregator Name
|
|
1912
2004
|
*/
|
|
@@ -1929,9 +2021,9 @@ type PayoutRequest = {
|
|
|
1929
2021
|
*/
|
|
1930
2022
|
transfer_type: string;
|
|
1931
2023
|
};
|
|
1932
|
-
/** @returns {
|
|
1933
|
-
declare function
|
|
1934
|
-
type
|
|
2024
|
+
/** @returns {PayoutDetails} */
|
|
2025
|
+
declare function PayoutDetails(): PayoutDetails;
|
|
2026
|
+
type PayoutDetails = {
|
|
1935
2027
|
/**
|
|
1936
2028
|
* - Status of payment
|
|
1937
2029
|
*/
|
|
@@ -1973,9 +2065,9 @@ type PayoutResponse = {
|
|
|
1973
2065
|
*/
|
|
1974
2066
|
payouts: any;
|
|
1975
2067
|
};
|
|
1976
|
-
/** @returns {
|
|
1977
|
-
declare function
|
|
1978
|
-
type
|
|
2068
|
+
/** @returns {UpdatePayoutDetails} */
|
|
2069
|
+
declare function UpdatePayoutDetails(): UpdatePayoutDetails;
|
|
2070
|
+
type UpdatePayoutDetails = {
|
|
1979
2071
|
/**
|
|
1980
2072
|
* - Enable or Disable Default Payout
|
|
1981
2073
|
*/
|
|
@@ -1989,9 +2081,9 @@ type UpdatePayoutResponse = {
|
|
|
1989
2081
|
*/
|
|
1990
2082
|
success: boolean;
|
|
1991
2083
|
};
|
|
1992
|
-
/** @returns {
|
|
1993
|
-
declare function
|
|
1994
|
-
type
|
|
2084
|
+
/** @returns {UpdatePayoutCreation} */
|
|
2085
|
+
declare function UpdatePayoutCreation(): UpdatePayoutCreation;
|
|
2086
|
+
type UpdatePayoutCreation = {
|
|
1995
2087
|
/**
|
|
1996
2088
|
* - Enable or Disable Default Payout
|
|
1997
2089
|
*/
|
|
@@ -2005,17 +2097,17 @@ type UpdatePayoutRequest = {
|
|
|
2005
2097
|
*/
|
|
2006
2098
|
unique_external_id: string;
|
|
2007
2099
|
};
|
|
2008
|
-
/** @returns {
|
|
2009
|
-
declare function
|
|
2010
|
-
type
|
|
2100
|
+
/** @returns {DeletePayoutDetails} */
|
|
2101
|
+
declare function DeletePayoutDetails(): DeletePayoutDetails;
|
|
2102
|
+
type DeletePayoutDetails = {
|
|
2011
2103
|
/**
|
|
2012
2104
|
* - Response is successful or not
|
|
2013
2105
|
*/
|
|
2014
2106
|
success: boolean;
|
|
2015
2107
|
};
|
|
2016
|
-
/** @returns {
|
|
2017
|
-
declare function
|
|
2018
|
-
type
|
|
2108
|
+
/** @returns {SubscriptionPaymentMethodDetails} */
|
|
2109
|
+
declare function SubscriptionPaymentMethodDetails(): SubscriptionPaymentMethodDetails;
|
|
2110
|
+
type SubscriptionPaymentMethodDetails = {
|
|
2019
2111
|
/**
|
|
2020
2112
|
* - Subscription Payment Method Object
|
|
2021
2113
|
*/
|
|
@@ -2025,17 +2117,17 @@ type SubscriptionPaymentMethodResponse = {
|
|
|
2025
2117
|
*/
|
|
2026
2118
|
success: boolean;
|
|
2027
2119
|
};
|
|
2028
|
-
/** @returns {
|
|
2029
|
-
declare function
|
|
2030
|
-
type
|
|
2120
|
+
/** @returns {DeleteSubscriptionPaymentMethodDetails} */
|
|
2121
|
+
declare function DeleteSubscriptionPaymentMethodDetails(): DeleteSubscriptionPaymentMethodDetails;
|
|
2122
|
+
type DeleteSubscriptionPaymentMethodDetails = {
|
|
2031
2123
|
/**
|
|
2032
2124
|
* - Success or failure.
|
|
2033
2125
|
*/
|
|
2034
2126
|
success: boolean;
|
|
2035
2127
|
};
|
|
2036
|
-
/** @returns {
|
|
2037
|
-
declare function
|
|
2038
|
-
type
|
|
2128
|
+
/** @returns {SubscriptionConfigDetails} */
|
|
2129
|
+
declare function SubscriptionConfigDetails(): SubscriptionConfigDetails;
|
|
2130
|
+
type SubscriptionConfigDetails = {
|
|
2039
2131
|
/**
|
|
2040
2132
|
* - Aggregator Name
|
|
2041
2133
|
*/
|
|
@@ -2049,17 +2141,17 @@ type SubscriptionConfigResponse = {
|
|
|
2049
2141
|
*/
|
|
2050
2142
|
success: boolean;
|
|
2051
2143
|
};
|
|
2052
|
-
/** @returns {
|
|
2053
|
-
declare function
|
|
2054
|
-
type
|
|
2144
|
+
/** @returns {SaveSubscriptionSetupIntentCreation} */
|
|
2145
|
+
declare function SaveSubscriptionSetupIntentCreation(): SaveSubscriptionSetupIntentCreation;
|
|
2146
|
+
type SaveSubscriptionSetupIntentCreation = {
|
|
2055
2147
|
/**
|
|
2056
2148
|
* - Unique id i.e company:id
|
|
2057
2149
|
*/
|
|
2058
2150
|
unique_external_id: string;
|
|
2059
2151
|
};
|
|
2060
|
-
/** @returns {
|
|
2061
|
-
declare function
|
|
2062
|
-
type
|
|
2152
|
+
/** @returns {SaveSubscriptionSetupIntentDetails} */
|
|
2153
|
+
declare function SaveSubscriptionSetupIntentDetails(): SaveSubscriptionSetupIntentDetails;
|
|
2154
|
+
type SaveSubscriptionSetupIntentDetails = {
|
|
2063
2155
|
/**
|
|
2064
2156
|
* - Subscription Payment Method Object
|
|
2065
2157
|
*/
|
|
@@ -2069,9 +2161,9 @@ type SaveSubscriptionSetupIntentResponse = {
|
|
|
2069
2161
|
*/
|
|
2070
2162
|
success: boolean;
|
|
2071
2163
|
};
|
|
2072
|
-
/** @returns {
|
|
2073
|
-
declare function
|
|
2074
|
-
type
|
|
2164
|
+
/** @returns {RefundAccountDetails} */
|
|
2165
|
+
declare function RefundAccountDetails(): RefundAccountDetails;
|
|
2166
|
+
type RefundAccountDetails = {
|
|
2075
2167
|
/**
|
|
2076
2168
|
* - Account is verified or not
|
|
2077
2169
|
*/
|
|
@@ -2111,36 +2203,44 @@ type BankDetailsForOTP = {
|
|
|
2111
2203
|
/**
|
|
2112
2204
|
* - IFSC code of account
|
|
2113
2205
|
*/
|
|
2114
|
-
ifsc_code
|
|
2206
|
+
ifsc_code?: string;
|
|
2115
2207
|
/**
|
|
2116
2208
|
* - Account number
|
|
2117
2209
|
*/
|
|
2118
|
-
account_no
|
|
2210
|
+
account_no?: string;
|
|
2119
2211
|
/**
|
|
2120
2212
|
* - Branch name of account
|
|
2121
2213
|
*/
|
|
2122
|
-
branch_name
|
|
2214
|
+
branch_name?: string;
|
|
2123
2215
|
/**
|
|
2124
2216
|
* - Bank name of account
|
|
2125
2217
|
*/
|
|
2126
|
-
bank_name
|
|
2218
|
+
bank_name?: string;
|
|
2127
2219
|
/**
|
|
2128
2220
|
* - Accountg holder name of account
|
|
2129
2221
|
*/
|
|
2130
|
-
account_holder
|
|
2222
|
+
account_holder?: string;
|
|
2223
|
+
/**
|
|
2224
|
+
* - UPI ID of account holder
|
|
2225
|
+
*/
|
|
2226
|
+
upi?: string;
|
|
2131
2227
|
};
|
|
2132
|
-
/** @returns {
|
|
2133
|
-
declare function
|
|
2134
|
-
type
|
|
2228
|
+
/** @returns {AddBeneficiaryDetailsOTPCreation} */
|
|
2229
|
+
declare function AddBeneficiaryDetailsOTPCreation(): AddBeneficiaryDetailsOTPCreation;
|
|
2230
|
+
type AddBeneficiaryDetailsOTPCreation = {
|
|
2135
2231
|
/**
|
|
2136
2232
|
* - Order_id for which account will be added
|
|
2137
2233
|
*/
|
|
2138
2234
|
order_id: string;
|
|
2235
|
+
/**
|
|
2236
|
+
* - Shipment_id for which account will be added
|
|
2237
|
+
*/
|
|
2238
|
+
shipment_id?: string;
|
|
2139
2239
|
details: BankDetailsForOTP;
|
|
2140
2240
|
};
|
|
2141
|
-
/** @returns {
|
|
2142
|
-
declare function
|
|
2143
|
-
type
|
|
2241
|
+
/** @returns {IfscCodeDetails} */
|
|
2242
|
+
declare function IfscCodeDetails(): IfscCodeDetails;
|
|
2243
|
+
type IfscCodeDetails = {
|
|
2144
2244
|
/**
|
|
2145
2245
|
* - Branch Name Of Account
|
|
2146
2246
|
*/
|
|
@@ -2234,9 +2334,9 @@ type OrderBeneficiaryDetails = {
|
|
|
2234
2334
|
*/
|
|
2235
2335
|
mobile?: string;
|
|
2236
2336
|
};
|
|
2237
|
-
/** @returns {
|
|
2238
|
-
declare function
|
|
2239
|
-
type
|
|
2337
|
+
/** @returns {OrderBeneficiaryFetchResults} */
|
|
2338
|
+
declare function OrderBeneficiaryFetchResults(): OrderBeneficiaryFetchResults;
|
|
2339
|
+
type OrderBeneficiaryFetchResults = {
|
|
2240
2340
|
/**
|
|
2241
2341
|
* - All Beneficiaries Of An Order
|
|
2242
2342
|
*/
|
|
@@ -2296,18 +2396,18 @@ type MultiTenderPaymentMethod = {
|
|
|
2296
2396
|
*/
|
|
2297
2397
|
mode: string;
|
|
2298
2398
|
};
|
|
2299
|
-
/** @returns {
|
|
2300
|
-
declare function
|
|
2301
|
-
type
|
|
2399
|
+
/** @returns {PaymentConfirmationCreation} */
|
|
2400
|
+
declare function PaymentConfirmationCreation(): PaymentConfirmationCreation;
|
|
2401
|
+
type PaymentConfirmationCreation = {
|
|
2302
2402
|
/**
|
|
2303
2403
|
* - Unique order id
|
|
2304
2404
|
*/
|
|
2305
2405
|
order_id: string;
|
|
2306
2406
|
payment_methods: MultiTenderPaymentMethod[];
|
|
2307
2407
|
};
|
|
2308
|
-
/** @returns {
|
|
2309
|
-
declare function
|
|
2310
|
-
type
|
|
2408
|
+
/** @returns {PaymentConfirmationDetails} */
|
|
2409
|
+
declare function PaymentConfirmationDetails(): PaymentConfirmationDetails;
|
|
2410
|
+
type PaymentConfirmationDetails = {
|
|
2311
2411
|
/**
|
|
2312
2412
|
* - Unique order id
|
|
2313
2413
|
*/
|
|
@@ -2382,9 +2482,9 @@ type CODPaymentLimitConfig = {
|
|
|
2382
2482
|
remaining_limit: number;
|
|
2383
2483
|
limit: CODLimitConfig;
|
|
2384
2484
|
};
|
|
2385
|
-
/** @returns {
|
|
2386
|
-
declare function
|
|
2387
|
-
type
|
|
2485
|
+
/** @returns {GetUserBULimitResponseSchema} */
|
|
2486
|
+
declare function GetUserBULimitResponseSchema(): GetUserBULimitResponseSchema;
|
|
2487
|
+
type GetUserBULimitResponseSchema = {
|
|
2388
2488
|
/**
|
|
2389
2489
|
* - COD limit business unit
|
|
2390
2490
|
*/
|
|
@@ -2395,10 +2495,10 @@ type GetUserBULimitResponse = {
|
|
|
2395
2495
|
display_name: string;
|
|
2396
2496
|
config: CODPaymentLimitConfig;
|
|
2397
2497
|
};
|
|
2398
|
-
/** @returns {
|
|
2399
|
-
declare function
|
|
2400
|
-
type
|
|
2401
|
-
items:
|
|
2498
|
+
/** @returns {GetUserCODLimitDetails} */
|
|
2499
|
+
declare function GetUserCODLimitDetails(): GetUserCODLimitDetails;
|
|
2500
|
+
type GetUserCODLimitDetails = {
|
|
2501
|
+
items: GetUserBULimitResponseSchema[];
|
|
2402
2502
|
/**
|
|
2403
2503
|
* - Response is successful or not
|
|
2404
2504
|
*/
|
|
@@ -2408,9 +2508,9 @@ type GetUserCODLimitResponse = {
|
|
|
2408
2508
|
*/
|
|
2409
2509
|
message?: string;
|
|
2410
2510
|
};
|
|
2411
|
-
/** @returns {
|
|
2412
|
-
declare function
|
|
2413
|
-
type
|
|
2511
|
+
/** @returns {SetCODForUserCreation} */
|
|
2512
|
+
declare function SetCODForUserCreation(): SetCODForUserCreation;
|
|
2513
|
+
type SetCODForUserCreation = {
|
|
2414
2514
|
/**
|
|
2415
2515
|
* - Business unit
|
|
2416
2516
|
*/
|
|
@@ -2428,9 +2528,9 @@ type SetCODForUserRequest = {
|
|
|
2428
2528
|
*/
|
|
2429
2529
|
merchant_user_id: string;
|
|
2430
2530
|
};
|
|
2431
|
-
/** @returns {
|
|
2432
|
-
declare function
|
|
2433
|
-
type
|
|
2531
|
+
/** @returns {SetCODOptionDetails} */
|
|
2532
|
+
declare function SetCODOptionDetails(): SetCODOptionDetails;
|
|
2533
|
+
type SetCODOptionDetails = {
|
|
2434
2534
|
/**
|
|
2435
2535
|
* - Message
|
|
2436
2536
|
*/
|
|
@@ -2440,240 +2540,9 @@ type SetCODOptionResponse = {
|
|
|
2440
2540
|
*/
|
|
2441
2541
|
success: boolean;
|
|
2442
2542
|
};
|
|
2443
|
-
/** @returns {
|
|
2444
|
-
declare function
|
|
2445
|
-
type
|
|
2446
|
-
/**
|
|
2447
|
-
* - Name of aggregator
|
|
2448
|
-
*/
|
|
2449
|
-
aggregator: string;
|
|
2450
|
-
/**
|
|
2451
|
-
* - ID of aggregator
|
|
2452
|
-
*/
|
|
2453
|
-
aggregator_id: number;
|
|
2454
|
-
/**
|
|
2455
|
-
* - List of string of edc models
|
|
2456
|
-
*/
|
|
2457
|
-
models: string[];
|
|
2458
|
-
};
|
|
2459
|
-
/** @returns {EdcAggregatorAndModelListResponse} */
|
|
2460
|
-
declare function EdcAggregatorAndModelListResponse(): EdcAggregatorAndModelListResponse;
|
|
2461
|
-
type EdcAggregatorAndModelListResponse = {
|
|
2462
|
-
/**
|
|
2463
|
-
* - List of aggregators and their edc models
|
|
2464
|
-
*/
|
|
2465
|
-
data: EdcModelData[];
|
|
2466
|
-
/**
|
|
2467
|
-
* - Response is successful or not
|
|
2468
|
-
*/
|
|
2469
|
-
success: boolean;
|
|
2470
|
-
};
|
|
2471
|
-
/** @returns {StatisticsData} */
|
|
2472
|
-
declare function StatisticsData(): StatisticsData;
|
|
2473
|
-
type StatisticsData = {
|
|
2474
|
-
/**
|
|
2475
|
-
* - No of inactive devices
|
|
2476
|
-
*/
|
|
2477
|
-
inactive_device_count: number;
|
|
2478
|
-
/**
|
|
2479
|
-
* - No of active devices
|
|
2480
|
-
*/
|
|
2481
|
-
active_device_count: number;
|
|
2482
|
-
};
|
|
2483
|
-
/** @returns {EdcDeviceStatsResponse} */
|
|
2484
|
-
declare function EdcDeviceStatsResponse(): EdcDeviceStatsResponse;
|
|
2485
|
-
type EdcDeviceStatsResponse = {
|
|
2486
|
-
statistics: StatisticsData;
|
|
2487
|
-
/**
|
|
2488
|
-
* - Response is successful or not
|
|
2489
|
-
*/
|
|
2490
|
-
success: boolean;
|
|
2491
|
-
};
|
|
2492
|
-
/** @returns {EdcAddRequest} */
|
|
2493
|
-
declare function EdcAddRequest(): EdcAddRequest;
|
|
2494
|
-
type EdcAddRequest = {
|
|
2495
|
-
/**
|
|
2496
|
-
* - Model of the edc machine
|
|
2497
|
-
*/
|
|
2498
|
-
edc_model: string;
|
|
2499
|
-
/**
|
|
2500
|
-
* - Store at which devices is to used
|
|
2501
|
-
*/
|
|
2502
|
-
store_id: number;
|
|
2503
|
-
/**
|
|
2504
|
-
* - Aggregator which will accept payment
|
|
2505
|
-
*/
|
|
2506
|
-
aggregator_id: number;
|
|
2507
|
-
/**
|
|
2508
|
-
* - Serial number or imei of EDC device
|
|
2509
|
-
*/
|
|
2510
|
-
edc_device_serial_no: string;
|
|
2511
|
-
/**
|
|
2512
|
-
* - Device serial number of
|
|
2513
|
-
* terminal(android tablet)
|
|
2514
|
-
*/
|
|
2515
|
-
terminal_serial_no: string;
|
|
2516
|
-
/**
|
|
2517
|
-
* - Device tag of edc device to identify it
|
|
2518
|
-
*/
|
|
2519
|
-
device_tag?: string;
|
|
2520
|
-
};
|
|
2521
|
-
/** @returns {EdcDevice} */
|
|
2522
|
-
declare function EdcDevice(): EdcDevice;
|
|
2523
|
-
type EdcDevice = {
|
|
2524
|
-
/**
|
|
2525
|
-
* - Name of the model
|
|
2526
|
-
*/
|
|
2527
|
-
edc_model?: string;
|
|
2528
|
-
/**
|
|
2529
|
-
* - Store at which devices is to used
|
|
2530
|
-
*/
|
|
2531
|
-
store_id: number;
|
|
2532
|
-
/**
|
|
2533
|
-
* - Aggregator which will accept payment
|
|
2534
|
-
*/
|
|
2535
|
-
aggregator_id: number;
|
|
2536
|
-
/**
|
|
2537
|
-
* - Genearated unique value for edc device
|
|
2538
|
-
*/
|
|
2539
|
-
terminal_unique_identifier: string;
|
|
2540
|
-
/**
|
|
2541
|
-
* - Serial number of EDC device
|
|
2542
|
-
*/
|
|
2543
|
-
edc_device_serial_no: string;
|
|
2544
|
-
/**
|
|
2545
|
-
* - State whether device is active or inactive
|
|
2546
|
-
*/
|
|
2547
|
-
is_active: boolean;
|
|
2548
|
-
/**
|
|
2549
|
-
* - Name of the corresponding aggregator
|
|
2550
|
-
*/
|
|
2551
|
-
aggregator_name?: string;
|
|
2552
|
-
/**
|
|
2553
|
-
* - Device serial number of
|
|
2554
|
-
* terminal(android tablet)
|
|
2555
|
-
*/
|
|
2556
|
-
terminal_serial_no: string;
|
|
2557
|
-
/**
|
|
2558
|
-
* - This is provided by pinelabs
|
|
2559
|
-
*/
|
|
2560
|
-
merchant_store_pos_code?: string;
|
|
2561
|
-
/**
|
|
2562
|
-
* - Device tag of edc device to identify it
|
|
2563
|
-
*/
|
|
2564
|
-
device_tag: string;
|
|
2565
|
-
/**
|
|
2566
|
-
* - Application ID
|
|
2567
|
-
*/
|
|
2568
|
-
application_id: string;
|
|
2569
|
-
};
|
|
2570
|
-
/** @returns {EdcDeviceAddResponse} */
|
|
2571
|
-
declare function EdcDeviceAddResponse(): EdcDeviceAddResponse;
|
|
2572
|
-
type EdcDeviceAddResponse = {
|
|
2573
|
-
data: EdcDevice;
|
|
2574
|
-
/**
|
|
2575
|
-
* - Response is successful or not
|
|
2576
|
-
*/
|
|
2577
|
-
success: boolean;
|
|
2578
|
-
};
|
|
2579
|
-
/** @returns {EdcDeviceDetailsResponse} */
|
|
2580
|
-
declare function EdcDeviceDetailsResponse(): EdcDeviceDetailsResponse;
|
|
2581
|
-
type EdcDeviceDetailsResponse = {
|
|
2582
|
-
data: EdcDevice;
|
|
2583
|
-
/**
|
|
2584
|
-
* - Response is successful or not
|
|
2585
|
-
*/
|
|
2586
|
-
success: boolean;
|
|
2587
|
-
};
|
|
2588
|
-
/** @returns {EdcUpdateRequest} */
|
|
2589
|
-
declare function EdcUpdateRequest(): EdcUpdateRequest;
|
|
2590
|
-
type EdcUpdateRequest = {
|
|
2591
|
-
/**
|
|
2592
|
-
* - Model of the edc machine
|
|
2593
|
-
*/
|
|
2594
|
-
edc_model?: string;
|
|
2595
|
-
/**
|
|
2596
|
-
* - Store at which devices is to used
|
|
2597
|
-
*/
|
|
2598
|
-
store_id?: number;
|
|
2599
|
-
/**
|
|
2600
|
-
* - Aggregator which will accept payment
|
|
2601
|
-
*/
|
|
2602
|
-
aggregator_id?: number;
|
|
2603
|
-
/**
|
|
2604
|
-
* - Serial number or imei of EDC device
|
|
2605
|
-
*/
|
|
2606
|
-
edc_device_serial_no?: string;
|
|
2607
|
-
/**
|
|
2608
|
-
* - State whether device is active or inactive
|
|
2609
|
-
*/
|
|
2610
|
-
is_active?: boolean;
|
|
2611
|
-
/**
|
|
2612
|
-
* - This is provided by pinelabs
|
|
2613
|
-
*/
|
|
2614
|
-
merchant_store_pos_code?: string;
|
|
2615
|
-
/**
|
|
2616
|
-
* - Device tag of edc device to identify it
|
|
2617
|
-
*/
|
|
2618
|
-
device_tag?: string;
|
|
2619
|
-
};
|
|
2620
|
-
/** @returns {EdcDeviceUpdateResponse} */
|
|
2621
|
-
declare function EdcDeviceUpdateResponse(): EdcDeviceUpdateResponse;
|
|
2622
|
-
type EdcDeviceUpdateResponse = {
|
|
2623
|
-
/**
|
|
2624
|
-
* - Response is successful or not
|
|
2625
|
-
*/
|
|
2626
|
-
success: boolean;
|
|
2627
|
-
};
|
|
2628
|
-
/** @returns {Page} */
|
|
2629
|
-
declare function Page(): Page;
|
|
2630
|
-
type Page = {
|
|
2631
|
-
/**
|
|
2632
|
-
* - The total number of items on the page.
|
|
2633
|
-
*/
|
|
2634
|
-
item_total?: number;
|
|
2635
|
-
/**
|
|
2636
|
-
* - The identifier for the next page.
|
|
2637
|
-
*/
|
|
2638
|
-
next_id?: string;
|
|
2639
|
-
/**
|
|
2640
|
-
* - Indicates whether there is a previous page.
|
|
2641
|
-
*/
|
|
2642
|
-
has_previous?: boolean;
|
|
2643
|
-
/**
|
|
2644
|
-
* - Indicates whether there is a next page.
|
|
2645
|
-
*/
|
|
2646
|
-
has_next?: boolean;
|
|
2647
|
-
/**
|
|
2648
|
-
* - The current page number.
|
|
2649
|
-
*/
|
|
2650
|
-
current?: number;
|
|
2651
|
-
/**
|
|
2652
|
-
* - The type of the page, such as 'PageType'.
|
|
2653
|
-
*/
|
|
2654
|
-
type: string;
|
|
2655
|
-
/**
|
|
2656
|
-
* - The number of items per page.
|
|
2657
|
-
*/
|
|
2658
|
-
size?: number;
|
|
2659
|
-
};
|
|
2660
|
-
/** @returns {EdcDeviceListResponse} */
|
|
2661
|
-
declare function EdcDeviceListResponse(): EdcDeviceListResponse;
|
|
2662
|
-
type EdcDeviceListResponse = {
|
|
2663
|
-
/**
|
|
2664
|
-
* - List of all edc mapped to the application
|
|
2665
|
-
* options with their Details.
|
|
2666
|
-
*/
|
|
2667
|
-
items: EdcDevice[];
|
|
2668
|
-
page: Page;
|
|
2669
|
-
/**
|
|
2670
|
-
* - Response is successful or not
|
|
2671
|
-
*/
|
|
2672
|
-
success: boolean;
|
|
2673
|
-
};
|
|
2674
|
-
/** @returns {PaymentInitializationRequest} */
|
|
2675
|
-
declare function PaymentInitializationRequest(): PaymentInitializationRequest;
|
|
2676
|
-
type PaymentInitializationRequest = {
|
|
2543
|
+
/** @returns {PaymentInitializationCreation} */
|
|
2544
|
+
declare function PaymentInitializationCreation(): PaymentInitializationCreation;
|
|
2545
|
+
type PaymentInitializationCreation = {
|
|
2677
2546
|
/**
|
|
2678
2547
|
* - Payment gateway payment id
|
|
2679
2548
|
*/
|
|
@@ -2727,9 +2596,9 @@ type PaymentInitializationRequest = {
|
|
|
2727
2596
|
*/
|
|
2728
2597
|
method: string;
|
|
2729
2598
|
};
|
|
2730
|
-
/** @returns {
|
|
2731
|
-
declare function
|
|
2732
|
-
type
|
|
2599
|
+
/** @returns {PaymentInitializationDetails} */
|
|
2600
|
+
declare function PaymentInitializationDetails(): PaymentInitializationDetails;
|
|
2601
|
+
type PaymentInitializationDetails = {
|
|
2733
2602
|
/**
|
|
2734
2603
|
* - Payment id.
|
|
2735
2604
|
*/
|
|
@@ -2799,9 +2668,9 @@ type PaymentInitializationResponse = {
|
|
|
2799
2668
|
*/
|
|
2800
2669
|
method: string;
|
|
2801
2670
|
};
|
|
2802
|
-
/** @returns {
|
|
2803
|
-
declare function
|
|
2804
|
-
type
|
|
2671
|
+
/** @returns {PaymentStatusUpdateCreation} */
|
|
2672
|
+
declare function PaymentStatusUpdateCreation(): PaymentStatusUpdateCreation;
|
|
2673
|
+
type PaymentStatusUpdateCreation = {
|
|
2805
2674
|
/**
|
|
2806
2675
|
* - EDC machine Unique Identifier
|
|
2807
2676
|
*/
|
|
@@ -2855,9 +2724,9 @@ type PaymentStatusUpdateRequest = {
|
|
|
2855
2724
|
*/
|
|
2856
2725
|
merchant_transaction_id: string;
|
|
2857
2726
|
};
|
|
2858
|
-
/** @returns {
|
|
2859
|
-
declare function
|
|
2860
|
-
type
|
|
2727
|
+
/** @returns {PaymentStatusUpdateDetails} */
|
|
2728
|
+
declare function PaymentStatusUpdateDetails(): PaymentStatusUpdateDetails;
|
|
2729
|
+
type PaymentStatusUpdateDetails = {
|
|
2861
2730
|
/**
|
|
2862
2731
|
* - Redirect url
|
|
2863
2732
|
*/
|
|
@@ -2879,9 +2748,9 @@ type PaymentStatusUpdateResponse = {
|
|
|
2879
2748
|
*/
|
|
2880
2749
|
aggregator_name: string;
|
|
2881
2750
|
};
|
|
2882
|
-
/** @returns {
|
|
2883
|
-
declare function
|
|
2884
|
-
type
|
|
2751
|
+
/** @returns {ResendOrCancelPaymentCreation} */
|
|
2752
|
+
declare function ResendOrCancelPaymentCreation(): ResendOrCancelPaymentCreation;
|
|
2753
|
+
type ResendOrCancelPaymentCreation = {
|
|
2885
2754
|
/**
|
|
2886
2755
|
* - Unique order id
|
|
2887
2756
|
*/
|
|
@@ -2912,26 +2781,26 @@ type LinkStatus = {
|
|
|
2912
2781
|
*/
|
|
2913
2782
|
is_payment_done?: boolean;
|
|
2914
2783
|
};
|
|
2915
|
-
/** @returns {
|
|
2916
|
-
declare function
|
|
2917
|
-
type
|
|
2784
|
+
/** @returns {ResendOrCancelPaymentDetails} */
|
|
2785
|
+
declare function ResendOrCancelPaymentDetails(): ResendOrCancelPaymentDetails;
|
|
2786
|
+
type ResendOrCancelPaymentDetails = {
|
|
2918
2787
|
data: LinkStatus;
|
|
2919
2788
|
/**
|
|
2920
2789
|
* - Response is successful or not.
|
|
2921
2790
|
*/
|
|
2922
2791
|
success: boolean;
|
|
2923
2792
|
};
|
|
2924
|
-
/** @returns {
|
|
2925
|
-
declare function
|
|
2926
|
-
type
|
|
2793
|
+
/** @returns {PaymentStatusBulkHandlerCreation} */
|
|
2794
|
+
declare function PaymentStatusBulkHandlerCreation(): PaymentStatusBulkHandlerCreation;
|
|
2795
|
+
type PaymentStatusBulkHandlerCreation = {
|
|
2927
2796
|
/**
|
|
2928
2797
|
* - List of order ids
|
|
2929
2798
|
*/
|
|
2930
2799
|
merchant_order_id: string[];
|
|
2931
2800
|
};
|
|
2932
|
-
/** @returns {
|
|
2933
|
-
declare function
|
|
2934
|
-
type
|
|
2801
|
+
/** @returns {PaymentObjectList} */
|
|
2802
|
+
declare function PaymentObjectList(): PaymentObjectList;
|
|
2803
|
+
type PaymentObjectList = {
|
|
2935
2804
|
user_object: any;
|
|
2936
2805
|
modified_on: string;
|
|
2937
2806
|
collected_by: string;
|
|
@@ -2955,20 +2824,20 @@ type PaymentObjectListSerializer = {
|
|
|
2955
2824
|
declare function PaymentStatusObject(): PaymentStatusObject;
|
|
2956
2825
|
type PaymentStatusObject = {
|
|
2957
2826
|
merchant_order_id: string;
|
|
2958
|
-
payment_object_list?:
|
|
2827
|
+
payment_object_list?: PaymentObjectList[];
|
|
2959
2828
|
};
|
|
2960
|
-
/** @returns {
|
|
2961
|
-
declare function
|
|
2962
|
-
type
|
|
2829
|
+
/** @returns {PaymentStatusBulkHandlerDetails} */
|
|
2830
|
+
declare function PaymentStatusBulkHandlerDetails(): PaymentStatusBulkHandlerDetails;
|
|
2831
|
+
type PaymentStatusBulkHandlerDetails = {
|
|
2963
2832
|
count?: number;
|
|
2964
2833
|
data?: PaymentStatusObject[];
|
|
2965
2834
|
success: string;
|
|
2966
2835
|
error?: string;
|
|
2967
2836
|
status: number;
|
|
2968
2837
|
};
|
|
2969
|
-
/** @returns {
|
|
2970
|
-
declare function
|
|
2971
|
-
type
|
|
2838
|
+
/** @returns {GetOauthUrlDetails} */
|
|
2839
|
+
declare function GetOauthUrlDetails(): GetOauthUrlDetails;
|
|
2840
|
+
type GetOauthUrlDetails = {
|
|
2972
2841
|
/**
|
|
2973
2842
|
* - The url to call for authenticating
|
|
2974
2843
|
*/
|
|
@@ -2990,116 +2859,9 @@ type RevokeOAuthToken = {
|
|
|
2990
2859
|
*/
|
|
2991
2860
|
success: boolean;
|
|
2992
2861
|
};
|
|
2993
|
-
/** @returns {
|
|
2994
|
-
declare function
|
|
2995
|
-
type
|
|
2996
|
-
/**
|
|
2997
|
-
* - Purchase Shipment Id
|
|
2998
|
-
*/
|
|
2999
|
-
fwd_shipment_id: string;
|
|
3000
|
-
/**
|
|
3001
|
-
* - Name of Payment Gateway
|
|
3002
|
-
*/
|
|
3003
|
-
aggregator: string;
|
|
3004
|
-
/**
|
|
3005
|
-
* - Status
|
|
3006
|
-
*/
|
|
3007
|
-
current_status: string;
|
|
3008
|
-
/**
|
|
3009
|
-
* - Merchant's Order Id
|
|
3010
|
-
*/
|
|
3011
|
-
merchant_order_id: string;
|
|
3012
|
-
/**
|
|
3013
|
-
* - Amount to paid back
|
|
3014
|
-
*/
|
|
3015
|
-
amount: number;
|
|
3016
|
-
/**
|
|
3017
|
-
* - Payment Mode
|
|
3018
|
-
*/
|
|
3019
|
-
payment_mode: string;
|
|
3020
|
-
/**
|
|
3021
|
-
* - Outstanding details ID
|
|
3022
|
-
*/
|
|
3023
|
-
outstanding_details_id: number;
|
|
3024
|
-
/**
|
|
3025
|
-
* - Unique Id for the transaction
|
|
3026
|
-
*/
|
|
3027
|
-
aggregator_transaction_id: string;
|
|
3028
|
-
/**
|
|
3029
|
-
* - Id of payment gateway
|
|
3030
|
-
*/
|
|
3031
|
-
aggregator_order_id: string;
|
|
3032
|
-
/**
|
|
3033
|
-
* - Payment Mode Id
|
|
3034
|
-
*/
|
|
3035
|
-
payment_mode_identifier: string;
|
|
3036
|
-
};
|
|
3037
|
-
/** @returns {RepaymentDetailsSerialiserPayAll} */
|
|
3038
|
-
declare function RepaymentDetailsSerialiserPayAll(): RepaymentDetailsSerialiserPayAll;
|
|
3039
|
-
type RepaymentDetailsSerialiserPayAll = {
|
|
3040
|
-
/**
|
|
3041
|
-
* - Total amount
|
|
3042
|
-
*/
|
|
3043
|
-
total_amount: number;
|
|
3044
|
-
/**
|
|
3045
|
-
* - Order id created in extension
|
|
3046
|
-
*/
|
|
3047
|
-
extension_order_id: string;
|
|
3048
|
-
/**
|
|
3049
|
-
* - Unique Id for the transaction
|
|
3050
|
-
*/
|
|
3051
|
-
aggregator_transaction_id: string;
|
|
3052
|
-
/**
|
|
3053
|
-
* - Id of payment gateway
|
|
3054
|
-
*/
|
|
3055
|
-
aggregator_order_id: string;
|
|
3056
|
-
shipment_details?: RepaymentRequestDetails[];
|
|
3057
|
-
};
|
|
3058
|
-
/** @returns {RepaymentResponse} */
|
|
3059
|
-
declare function RepaymentResponse(): RepaymentResponse;
|
|
3060
|
-
type RepaymentResponse = {
|
|
3061
|
-
data: any;
|
|
3062
|
-
/**
|
|
3063
|
-
* - Success/Failure of the transaction
|
|
3064
|
-
*/
|
|
3065
|
-
success: boolean;
|
|
3066
|
-
};
|
|
3067
|
-
/** @returns {MerchantOnBoardingRequest} */
|
|
3068
|
-
declare function MerchantOnBoardingRequest(): MerchantOnBoardingRequest;
|
|
3069
|
-
type MerchantOnBoardingRequest = {
|
|
3070
|
-
/**
|
|
3071
|
-
* - Merchant ID at Ajiodhan's end
|
|
3072
|
-
*/
|
|
3073
|
-
credit_line_id: string;
|
|
3074
|
-
/**
|
|
3075
|
-
* - Payment aggregator name
|
|
3076
|
-
*/
|
|
3077
|
-
aggregator: string;
|
|
3078
|
-
/**
|
|
3079
|
-
* - Application id
|
|
3080
|
-
*/
|
|
3081
|
-
app_id: string;
|
|
3082
|
-
/**
|
|
3083
|
-
* - Deadlock or Grimlock user id
|
|
3084
|
-
*/
|
|
3085
|
-
user_id: string;
|
|
3086
|
-
/**
|
|
3087
|
-
* - Status
|
|
3088
|
-
*/
|
|
3089
|
-
status: string;
|
|
3090
|
-
};
|
|
3091
|
-
/** @returns {MerchantOnBoardingResponse} */
|
|
3092
|
-
declare function MerchantOnBoardingResponse(): MerchantOnBoardingResponse;
|
|
3093
|
-
type MerchantOnBoardingResponse = {
|
|
3094
|
-
data: any;
|
|
3095
|
-
/**
|
|
3096
|
-
* - Success/Failure of the transaction
|
|
3097
|
-
*/
|
|
3098
|
-
success: boolean;
|
|
3099
|
-
};
|
|
3100
|
-
/** @returns {ValidateCustomerRequest} */
|
|
3101
|
-
declare function ValidateCustomerRequest(): ValidateCustomerRequest;
|
|
3102
|
-
type ValidateCustomerRequest = {
|
|
2862
|
+
/** @returns {ValidateCustomerCreation} */
|
|
2863
|
+
declare function ValidateCustomerCreation(): ValidateCustomerCreation;
|
|
2864
|
+
type ValidateCustomerCreation = {
|
|
3103
2865
|
/**
|
|
3104
2866
|
* - User mobile number without country code.
|
|
3105
2867
|
*/
|
|
@@ -3133,9 +2895,9 @@ type ValidateCustomerRequest = {
|
|
|
3133
2895
|
*/
|
|
3134
2896
|
billing_address?: any;
|
|
3135
2897
|
};
|
|
3136
|
-
/** @returns {
|
|
3137
|
-
declare function
|
|
3138
|
-
type
|
|
2898
|
+
/** @returns {ValidateCustomerDetails} */
|
|
2899
|
+
declare function ValidateCustomerDetails(): ValidateCustomerDetails;
|
|
2900
|
+
type ValidateCustomerDetails = {
|
|
3139
2901
|
/**
|
|
3140
2902
|
* - Error or success message.
|
|
3141
2903
|
*/
|
|
@@ -3149,9 +2911,9 @@ type ValidateCustomerResponse = {
|
|
|
3149
2911
|
*/
|
|
3150
2912
|
success: boolean;
|
|
3151
2913
|
};
|
|
3152
|
-
/** @returns {
|
|
3153
|
-
declare function
|
|
3154
|
-
type
|
|
2914
|
+
/** @returns {GetPaymentLinkDetails} */
|
|
2915
|
+
declare function GetPaymentLinkDetails(): GetPaymentLinkDetails;
|
|
2916
|
+
type GetPaymentLinkDetails = {
|
|
3155
2917
|
/**
|
|
3156
2918
|
* - Message
|
|
3157
2919
|
*/
|
|
@@ -3226,9 +2988,9 @@ type ErrorDescription = {
|
|
|
3226
2988
|
*/
|
|
3227
2989
|
cancelled?: boolean;
|
|
3228
2990
|
};
|
|
3229
|
-
/** @returns {
|
|
3230
|
-
declare function
|
|
3231
|
-
type
|
|
2991
|
+
/** @returns {ErrorDetails} */
|
|
2992
|
+
declare function ErrorDetails(): ErrorDetails;
|
|
2993
|
+
type ErrorDetails = {
|
|
3232
2994
|
/**
|
|
3233
2995
|
* - HTTP status code
|
|
3234
2996
|
*/
|
|
@@ -3264,9 +3026,9 @@ type CreatePaymentLinkMeta = {
|
|
|
3264
3026
|
*/
|
|
3265
3027
|
assign_card_id?: string;
|
|
3266
3028
|
};
|
|
3267
|
-
/** @returns {
|
|
3268
|
-
declare function
|
|
3269
|
-
type
|
|
3029
|
+
/** @returns {CreatePaymentLinkCreation} */
|
|
3030
|
+
declare function CreatePaymentLinkCreation(): CreatePaymentLinkCreation;
|
|
3031
|
+
type CreatePaymentLinkCreation = {
|
|
3270
3032
|
/**
|
|
3271
3033
|
* - Email to which the payment link is to be sent
|
|
3272
3034
|
*/
|
|
@@ -3293,10 +3055,25 @@ type CreatePaymentLinkRequest = {
|
|
|
3293
3055
|
* - Merchant order id
|
|
3294
3056
|
*/
|
|
3295
3057
|
external_order_id: string;
|
|
3058
|
+
/**
|
|
3059
|
+
* - URL to which the user will be
|
|
3060
|
+
* redirected after a successful payment.
|
|
3061
|
+
*/
|
|
3062
|
+
success_redirection_url?: string;
|
|
3063
|
+
/**
|
|
3064
|
+
* - URL to which the user will be
|
|
3065
|
+
* redirected if the payment fails.
|
|
3066
|
+
*/
|
|
3067
|
+
failure_redirection_url?: string;
|
|
3068
|
+
/**
|
|
3069
|
+
* - Flag indicating whether to send
|
|
3070
|
+
* communications (e.g., SMS or email) for the payment link
|
|
3071
|
+
*/
|
|
3072
|
+
send_communication?: boolean;
|
|
3296
3073
|
};
|
|
3297
|
-
/** @returns {
|
|
3298
|
-
declare function
|
|
3299
|
-
type
|
|
3074
|
+
/** @returns {CreatePaymentLinkDetails} */
|
|
3075
|
+
declare function CreatePaymentLinkDetails(): CreatePaymentLinkDetails;
|
|
3076
|
+
type CreatePaymentLinkDetails = {
|
|
3300
3077
|
/**
|
|
3301
3078
|
* - Message
|
|
3302
3079
|
*/
|
|
@@ -3322,9 +3099,9 @@ type CreatePaymentLinkResponse = {
|
|
|
3322
3099
|
*/
|
|
3323
3100
|
payment_link_id?: string;
|
|
3324
3101
|
};
|
|
3325
|
-
/** @returns {
|
|
3326
|
-
declare function
|
|
3327
|
-
type
|
|
3102
|
+
/** @returns {PollingPaymentLinkDetails} */
|
|
3103
|
+
declare function PollingPaymentLinkDetails(): PollingPaymentLinkDetails;
|
|
3104
|
+
type PollingPaymentLinkDetails = {
|
|
3328
3105
|
/**
|
|
3329
3106
|
* - Message
|
|
3330
3107
|
*/
|
|
@@ -3366,17 +3143,17 @@ type PollingPaymentLinkResponse = {
|
|
|
3366
3143
|
*/
|
|
3367
3144
|
aggregator_name?: string;
|
|
3368
3145
|
};
|
|
3369
|
-
/** @returns {
|
|
3370
|
-
declare function
|
|
3371
|
-
type
|
|
3146
|
+
/** @returns {CancelOrResendPaymentLinkCreation} */
|
|
3147
|
+
declare function CancelOrResendPaymentLinkCreation(): CancelOrResendPaymentLinkCreation;
|
|
3148
|
+
type CancelOrResendPaymentLinkCreation = {
|
|
3372
3149
|
/**
|
|
3373
3150
|
* - Unique id of payment link
|
|
3374
3151
|
*/
|
|
3375
3152
|
payment_link_id: string;
|
|
3376
3153
|
};
|
|
3377
|
-
/** @returns {
|
|
3378
|
-
declare function
|
|
3379
|
-
type
|
|
3154
|
+
/** @returns {ResendPaymentLinkDetails} */
|
|
3155
|
+
declare function ResendPaymentLinkDetails(): ResendPaymentLinkDetails;
|
|
3156
|
+
type ResendPaymentLinkDetails = {
|
|
3380
3157
|
/**
|
|
3381
3158
|
* - HTTP status code
|
|
3382
3159
|
*/
|
|
@@ -3394,9 +3171,9 @@ type ResendPaymentLinkResponse = {
|
|
|
3394
3171
|
*/
|
|
3395
3172
|
success: boolean;
|
|
3396
3173
|
};
|
|
3397
|
-
/** @returns {
|
|
3398
|
-
declare function
|
|
3399
|
-
type
|
|
3174
|
+
/** @returns {CancelPaymentLinkDetails} */
|
|
3175
|
+
declare function CancelPaymentLinkDetails(): CancelPaymentLinkDetails;
|
|
3176
|
+
type CancelPaymentLinkDetails = {
|
|
3400
3177
|
/**
|
|
3401
3178
|
* - HTTP status code
|
|
3402
3179
|
*/
|
|
@@ -3448,18 +3225,18 @@ declare function GetPaymentCode(): GetPaymentCode;
|
|
|
3448
3225
|
type GetPaymentCode = {
|
|
3449
3226
|
method_code: PaymentCode;
|
|
3450
3227
|
};
|
|
3451
|
-
/** @returns {
|
|
3452
|
-
declare function
|
|
3453
|
-
type
|
|
3228
|
+
/** @returns {GetPaymentCodeDetails} */
|
|
3229
|
+
declare function GetPaymentCodeDetails(): GetPaymentCodeDetails;
|
|
3230
|
+
type GetPaymentCodeDetails = {
|
|
3454
3231
|
data: GetPaymentCode;
|
|
3455
3232
|
/**
|
|
3456
3233
|
* - Response is successful or not.
|
|
3457
3234
|
*/
|
|
3458
3235
|
success: boolean;
|
|
3459
3236
|
};
|
|
3460
|
-
/** @returns {
|
|
3461
|
-
declare function
|
|
3462
|
-
type
|
|
3237
|
+
/** @returns {PlatformPaymentModeDetails} */
|
|
3238
|
+
declare function PlatformPaymentModeDetails(): PlatformPaymentModeDetails;
|
|
3239
|
+
type PlatformPaymentModeDetails = {
|
|
3463
3240
|
/**
|
|
3464
3241
|
* - Message
|
|
3465
3242
|
*/
|
|
@@ -3473,9 +3250,211 @@ type PlatformPaymentModeResponse = {
|
|
|
3473
3250
|
*/
|
|
3474
3251
|
success: boolean;
|
|
3475
3252
|
};
|
|
3476
|
-
/** @returns {
|
|
3477
|
-
declare function
|
|
3478
|
-
type
|
|
3253
|
+
/** @returns {PaymentModeConfig} */
|
|
3254
|
+
declare function PaymentModeConfig(): PaymentModeConfig;
|
|
3255
|
+
type PaymentModeConfig = {
|
|
3256
|
+
/**
|
|
3257
|
+
* - Business unit for which the configuration applies.
|
|
3258
|
+
*/
|
|
3259
|
+
business_unit?: string;
|
|
3260
|
+
/**
|
|
3261
|
+
* - Device type for which the configuration applies.
|
|
3262
|
+
*/
|
|
3263
|
+
device?: string;
|
|
3264
|
+
/**
|
|
3265
|
+
* - Indicates if the payment configuration is
|
|
3266
|
+
* currently active.
|
|
3267
|
+
*/
|
|
3268
|
+
is_active?: boolean;
|
|
3269
|
+
/**
|
|
3270
|
+
* - List of payment modes available for
|
|
3271
|
+
* the given business unit and device. This list is dynamic and can contain
|
|
3272
|
+
* one or more payment modes.
|
|
3273
|
+
*/
|
|
3274
|
+
items?: PaymentModeItems[];
|
|
3275
|
+
};
|
|
3276
|
+
/** @returns {PaymentModeItems} */
|
|
3277
|
+
declare function PaymentModeItems(): PaymentModeItems;
|
|
3278
|
+
type PaymentModeItems = {
|
|
3279
|
+
/**
|
|
3280
|
+
* - Unique identifier for the payment mode.
|
|
3281
|
+
*/
|
|
3282
|
+
id?: number;
|
|
3283
|
+
/**
|
|
3284
|
+
* - Display name of the payment mode.
|
|
3285
|
+
*/
|
|
3286
|
+
name?: string;
|
|
3287
|
+
/**
|
|
3288
|
+
* - Short code for the payment mode.
|
|
3289
|
+
*/
|
|
3290
|
+
short_code?: string;
|
|
3291
|
+
logos?: LogoSet;
|
|
3292
|
+
/**
|
|
3293
|
+
* - Indicates if this payment mode is active in
|
|
3294
|
+
* the system.
|
|
3295
|
+
*/
|
|
3296
|
+
is_active?: boolean;
|
|
3297
|
+
/**
|
|
3298
|
+
* - Dynamic list of sub-payment
|
|
3299
|
+
* modes under this payment mode.
|
|
3300
|
+
*/
|
|
3301
|
+
sub_payment_mode?: SubPaymentMode[];
|
|
3302
|
+
/**
|
|
3303
|
+
* - Indicates if this payment mode is
|
|
3304
|
+
* active at the payment gateway (PG) side.
|
|
3305
|
+
*/
|
|
3306
|
+
is_active_at_pg?: boolean;
|
|
3307
|
+
/**
|
|
3308
|
+
* - Fulfillment options applicable for
|
|
3309
|
+
* these payment modes. Keys are option slugs and values indicate whether the
|
|
3310
|
+
* option is enabled.
|
|
3311
|
+
*/
|
|
3312
|
+
fulfillment_options?: any;
|
|
3313
|
+
};
|
|
3314
|
+
/** @returns {SubPaymentMode} */
|
|
3315
|
+
declare function SubPaymentMode(): SubPaymentMode;
|
|
3316
|
+
type SubPaymentMode = {
|
|
3317
|
+
/**
|
|
3318
|
+
* - Unique code of the sub-payment mode.
|
|
3319
|
+
*/
|
|
3320
|
+
code?: string;
|
|
3321
|
+
/**
|
|
3322
|
+
* - Indicates if this sub-payment mode is
|
|
3323
|
+
* active in the system.
|
|
3324
|
+
*/
|
|
3325
|
+
is_active?: boolean;
|
|
3326
|
+
/**
|
|
3327
|
+
* - Priority used for ordering in UI. Lower
|
|
3328
|
+
* numbers can represent higher priority, depending on implementation.
|
|
3329
|
+
*/
|
|
3330
|
+
priority?: number;
|
|
3331
|
+
logos?: LogoSet;
|
|
3332
|
+
/**
|
|
3333
|
+
* - Human-readable name of the sub-payment mode.
|
|
3334
|
+
*/
|
|
3335
|
+
name?: string;
|
|
3336
|
+
/**
|
|
3337
|
+
* - Indicates if this sub-payment mode is
|
|
3338
|
+
* active at the payment gateway (PG) side.
|
|
3339
|
+
*/
|
|
3340
|
+
is_active_at_pg?: boolean;
|
|
3341
|
+
};
|
|
3342
|
+
/** @returns {LogoSet} */
|
|
3343
|
+
declare function LogoSet(): LogoSet;
|
|
3344
|
+
type LogoSet = {
|
|
3345
|
+
/**
|
|
3346
|
+
* - URL of the large-sized logo.
|
|
3347
|
+
*/
|
|
3348
|
+
large?: string;
|
|
3349
|
+
/**
|
|
3350
|
+
* - URL of the small-sized logo.
|
|
3351
|
+
*/
|
|
3352
|
+
small?: string;
|
|
3353
|
+
};
|
|
3354
|
+
/** @returns {PlatformLogoSet} */
|
|
3355
|
+
declare function PlatformLogoSet(): PlatformLogoSet;
|
|
3356
|
+
type PlatformLogoSet = {
|
|
3357
|
+
/**
|
|
3358
|
+
* - URL of the large-sized logo.
|
|
3359
|
+
*/
|
|
3360
|
+
large?: string;
|
|
3361
|
+
/**
|
|
3362
|
+
* - URL of the small-sized logo.
|
|
3363
|
+
*/
|
|
3364
|
+
small?: string;
|
|
3365
|
+
};
|
|
3366
|
+
/** @returns {PlatformConfigPaymentModeDetails} */
|
|
3367
|
+
declare function PlatformConfigPaymentModeDetails(): PlatformConfigPaymentModeDetails;
|
|
3368
|
+
type PlatformConfigPaymentModeDetails = {
|
|
3369
|
+
/**
|
|
3370
|
+
* - Business unit for which the
|
|
3371
|
+
* configuration applies (e.g. "storefront", "pos").
|
|
3372
|
+
*/
|
|
3373
|
+
business_unit?: string;
|
|
3374
|
+
/**
|
|
3375
|
+
* - Device or channel for which the configuration
|
|
3376
|
+
* applies (e.g. "desktop", "android", "ios").
|
|
3377
|
+
*/
|
|
3378
|
+
device?: string;
|
|
3379
|
+
/**
|
|
3380
|
+
* - Fulfillment options applicable for
|
|
3381
|
+
* these payment modes. Keys are option slugs (e.g. "self-pickup", "delivery")
|
|
3382
|
+
* and values indicate whether the option is enabled.
|
|
3383
|
+
*/
|
|
3384
|
+
fulfillment_options?: any;
|
|
3385
|
+
/**
|
|
3386
|
+
* - Overall active status for this aggregator
|
|
3387
|
+
* payment configuration for the given application and device.
|
|
3388
|
+
*/
|
|
3389
|
+
is_active?: boolean;
|
|
3390
|
+
/**
|
|
3391
|
+
* - List of payment modes and
|
|
3392
|
+
* their configuration.
|
|
3393
|
+
*/
|
|
3394
|
+
items?: PlatformPaymentModeItem[];
|
|
3395
|
+
};
|
|
3396
|
+
/** @returns {PlatformPaymentModeItem} */
|
|
3397
|
+
declare function PlatformPaymentModeItem(): PlatformPaymentModeItem;
|
|
3398
|
+
type PlatformPaymentModeItem = {
|
|
3399
|
+
/**
|
|
3400
|
+
* - Unique identifier of the payment mode.
|
|
3401
|
+
*/
|
|
3402
|
+
id?: number;
|
|
3403
|
+
/**
|
|
3404
|
+
* - Human readable name of the payment mode.
|
|
3405
|
+
*/
|
|
3406
|
+
name?: string;
|
|
3407
|
+
/**
|
|
3408
|
+
* - Short code representing the payment mode.
|
|
3409
|
+
*/
|
|
3410
|
+
short_code?: string;
|
|
3411
|
+
logos?: PlatformLogoSet;
|
|
3412
|
+
/**
|
|
3413
|
+
* - Indicates if the payment mode is enabled on
|
|
3414
|
+
* the platform.
|
|
3415
|
+
*/
|
|
3416
|
+
is_active?: boolean;
|
|
3417
|
+
/**
|
|
3418
|
+
* - Indicates if the payment mode is
|
|
3419
|
+
* active at the payment gateway.
|
|
3420
|
+
*/
|
|
3421
|
+
is_active_at_pg?: boolean;
|
|
3422
|
+
/**
|
|
3423
|
+
* - List of sub payment
|
|
3424
|
+
* modes (e.g. card networks like VISA, MASTERCARD).
|
|
3425
|
+
*/
|
|
3426
|
+
sub_payment_mode?: PlatformSubPaymentMode[];
|
|
3427
|
+
};
|
|
3428
|
+
/** @returns {PlatformSubPaymentMode} */
|
|
3429
|
+
declare function PlatformSubPaymentMode(): PlatformSubPaymentMode;
|
|
3430
|
+
type PlatformSubPaymentMode = {
|
|
3431
|
+
/**
|
|
3432
|
+
* - Code of the sub payment mode (e.g. "VISA", "AMEX").
|
|
3433
|
+
*/
|
|
3434
|
+
code?: string;
|
|
3435
|
+
/**
|
|
3436
|
+
* - Human readable name of the sub payment mode.
|
|
3437
|
+
*/
|
|
3438
|
+
name?: string;
|
|
3439
|
+
/**
|
|
3440
|
+
* - Indicates if the sub payment mode is enabled.
|
|
3441
|
+
*/
|
|
3442
|
+
is_active?: boolean;
|
|
3443
|
+
/**
|
|
3444
|
+
* - Indicates if the sub payment mode is
|
|
3445
|
+
* active at payment gateway.
|
|
3446
|
+
*/
|
|
3447
|
+
is_active_at_pg?: boolean;
|
|
3448
|
+
/**
|
|
3449
|
+
* - Display priority for the sub payment mode.
|
|
3450
|
+
* Lower numbers indicate higher priority.
|
|
3451
|
+
*/
|
|
3452
|
+
priority?: number;
|
|
3453
|
+
logos?: PlatformLogoSet;
|
|
3454
|
+
};
|
|
3455
|
+
/** @returns {MerchnatPaymentModeCreation} */
|
|
3456
|
+
declare function MerchnatPaymentModeCreation(): MerchnatPaymentModeCreation;
|
|
3457
|
+
type MerchnatPaymentModeCreation = {
|
|
3479
3458
|
/**
|
|
3480
3459
|
* - Details to be updated for online payment configuration.
|
|
3481
3460
|
*/
|
|
@@ -3485,6 +3464,57 @@ type MerchnatPaymentModeRequest = {
|
|
|
3485
3464
|
*/
|
|
3486
3465
|
online?: any;
|
|
3487
3466
|
};
|
|
3467
|
+
/** @returns {SkuDetails} */
|
|
3468
|
+
declare function SkuDetails(): SkuDetails;
|
|
3469
|
+
type SkuDetails = {
|
|
3470
|
+
/**
|
|
3471
|
+
* - SKU identifier of the offer
|
|
3472
|
+
*/
|
|
3473
|
+
identifier?: string;
|
|
3474
|
+
/**
|
|
3475
|
+
* - Unique SKU identifier (example: GTIN, variant ID)
|
|
3476
|
+
*/
|
|
3477
|
+
sku_id?: string;
|
|
3478
|
+
/**
|
|
3479
|
+
* - Display name of the SKU
|
|
3480
|
+
*/
|
|
3481
|
+
sku_name?: string;
|
|
3482
|
+
};
|
|
3483
|
+
/** @returns {AppliedOffer} */
|
|
3484
|
+
declare function AppliedOffer(): AppliedOffer;
|
|
3485
|
+
type AppliedOffer = {
|
|
3486
|
+
/**
|
|
3487
|
+
* - Whether the offer is a mop or not. MOP is a
|
|
3488
|
+
* discount that is applied on the total order value.
|
|
3489
|
+
*/
|
|
3490
|
+
is_mop?: boolean;
|
|
3491
|
+
/**
|
|
3492
|
+
* - Type of offer. It can be either a bank or
|
|
3493
|
+
* brand offer.
|
|
3494
|
+
*/
|
|
3495
|
+
offer_type?: string;
|
|
3496
|
+
/**
|
|
3497
|
+
* - Unique identifier for the offer.
|
|
3498
|
+
*/
|
|
3499
|
+
offer_id?: string;
|
|
3500
|
+
/**
|
|
3501
|
+
* - Description of the offer.
|
|
3502
|
+
*/
|
|
3503
|
+
description?: string;
|
|
3504
|
+
/**
|
|
3505
|
+
* - Amount of the offer in paise. (Example: ₹1 = 100 paise)
|
|
3506
|
+
*/
|
|
3507
|
+
amount?: number;
|
|
3508
|
+
/**
|
|
3509
|
+
* - Extra meta data specific to extension
|
|
3510
|
+
*/
|
|
3511
|
+
meta?: any;
|
|
3512
|
+
/**
|
|
3513
|
+
* - List of sku details for which the
|
|
3514
|
+
* offer is applicable. This is applicable only for brand offers.
|
|
3515
|
+
*/
|
|
3516
|
+
sku_details?: SkuDetails[];
|
|
3517
|
+
};
|
|
3488
3518
|
/** @returns {OrderDetail} */
|
|
3489
3519
|
declare function OrderDetail(): OrderDetail;
|
|
3490
3520
|
type OrderDetail = {
|
|
@@ -3515,6 +3545,10 @@ type OrderDetail = {
|
|
|
3515
3545
|
* - Name of the payment gateway aggregator.
|
|
3516
3546
|
*/
|
|
3517
3547
|
aggregator: string;
|
|
3548
|
+
/**
|
|
3549
|
+
* - List of offers applied on the order.
|
|
3550
|
+
*/
|
|
3551
|
+
applied_offers?: AppliedOffer[];
|
|
3518
3552
|
};
|
|
3519
3553
|
/** @returns {AddressDetail} */
|
|
3520
3554
|
declare function AddressDetail(): AddressDetail;
|
|
@@ -3597,6 +3631,19 @@ type AddressDetail = {
|
|
|
3597
3631
|
*/
|
|
3598
3632
|
tags?: any[];
|
|
3599
3633
|
};
|
|
3634
|
+
/** @returns {ReasonDetail} */
|
|
3635
|
+
declare function ReasonDetail(): ReasonDetail;
|
|
3636
|
+
type ReasonDetail = {
|
|
3637
|
+
/**
|
|
3638
|
+
* - The code indicating the type of reason.
|
|
3639
|
+
*/
|
|
3640
|
+
code?: string;
|
|
3641
|
+
/**
|
|
3642
|
+
* - A detailed description of the payment
|
|
3643
|
+
* reason or error.
|
|
3644
|
+
*/
|
|
3645
|
+
description?: string;
|
|
3646
|
+
};
|
|
3600
3647
|
/** @returns {PaymentSessionDetail} */
|
|
3601
3648
|
declare function PaymentSessionDetail(): PaymentSessionDetail;
|
|
3602
3649
|
type PaymentSessionDetail = {
|
|
@@ -3700,10 +3747,11 @@ type PaymentSessionDetail = {
|
|
|
3700
3747
|
* - Status of the payment
|
|
3701
3748
|
*/
|
|
3702
3749
|
status: string;
|
|
3750
|
+
reason?: ReasonDetail;
|
|
3703
3751
|
};
|
|
3704
|
-
/** @returns {
|
|
3705
|
-
declare function
|
|
3706
|
-
type
|
|
3752
|
+
/** @returns {PaymentSessionCreation} */
|
|
3753
|
+
declare function PaymentSessionCreation(): PaymentSessionCreation;
|
|
3754
|
+
type PaymentSessionCreation = {
|
|
3707
3755
|
/**
|
|
3708
3756
|
* - Extra meta data specific to extensions
|
|
3709
3757
|
*/
|
|
@@ -3744,9 +3792,9 @@ type PaymentSessionRequestSerializer = {
|
|
|
3744
3792
|
*/
|
|
3745
3793
|
source?: string;
|
|
3746
3794
|
};
|
|
3747
|
-
/** @returns {
|
|
3748
|
-
declare function
|
|
3749
|
-
type
|
|
3795
|
+
/** @returns {PaymentSessionPutDetails} */
|
|
3796
|
+
declare function PaymentSessionPutDetails(): PaymentSessionPutDetails;
|
|
3797
|
+
type PaymentSessionPutDetails = {
|
|
3750
3798
|
/**
|
|
3751
3799
|
* - Global identifier of the entity (e.g. order, cart
|
|
3752
3800
|
* etc.) against which payment_session was initiated. This is generated by
|
|
@@ -3829,9 +3877,9 @@ type RefundSessionDetail = {
|
|
|
3829
3877
|
*/
|
|
3830
3878
|
balance_transaction?: string;
|
|
3831
3879
|
};
|
|
3832
|
-
/** @returns {
|
|
3833
|
-
declare function
|
|
3834
|
-
type
|
|
3880
|
+
/** @returns {RefundSessionCreation} */
|
|
3881
|
+
declare function RefundSessionCreation(): RefundSessionCreation;
|
|
3882
|
+
type RefundSessionCreation = {
|
|
3835
3883
|
/**
|
|
3836
3884
|
* - Meta
|
|
3837
3885
|
*/
|
|
@@ -3872,9 +3920,9 @@ type RefundSessionRequestSerializer = {
|
|
|
3872
3920
|
*/
|
|
3873
3921
|
checksum: string;
|
|
3874
3922
|
};
|
|
3875
|
-
/** @returns {
|
|
3876
|
-
declare function
|
|
3877
|
-
type
|
|
3923
|
+
/** @returns {RefundSessionDetails} */
|
|
3924
|
+
declare function RefundSessionDetails(): RefundSessionDetails;
|
|
3925
|
+
type RefundSessionDetails = {
|
|
3878
3926
|
/**
|
|
3879
3927
|
* - Global identifier of the entity (e.g. order, cart
|
|
3880
3928
|
* etc.) against which payment_session was initiated. This is generated by
|
|
@@ -3898,9 +3946,9 @@ type RefundSessionResponseSerializer = {
|
|
|
3898
3946
|
*/
|
|
3899
3947
|
total_refund_amount: number;
|
|
3900
3948
|
};
|
|
3901
|
-
/** @returns {
|
|
3902
|
-
declare function
|
|
3903
|
-
type
|
|
3949
|
+
/** @returns {PaymentDetails} */
|
|
3950
|
+
declare function PaymentDetails(): PaymentDetails;
|
|
3951
|
+
type PaymentDetails = {
|
|
3904
3952
|
/**
|
|
3905
3953
|
* - List of payment methods
|
|
3906
3954
|
*/
|
|
@@ -3994,9 +4042,9 @@ type PaymentDetailsSerializer = {
|
|
|
3994
4042
|
*/
|
|
3995
4043
|
aggregator_order_id?: string;
|
|
3996
4044
|
};
|
|
3997
|
-
/** @returns {
|
|
3998
|
-
declare function
|
|
3999
|
-
type
|
|
4045
|
+
/** @returns {CartDetails} */
|
|
4046
|
+
declare function CartDetails(): CartDetails;
|
|
4047
|
+
type CartDetails = {
|
|
4000
4048
|
/**
|
|
4001
4049
|
* - Items that are added in cart
|
|
4002
4050
|
*/
|
|
@@ -4019,9 +4067,9 @@ type CartDetailsSerializer = {
|
|
|
4019
4067
|
*/
|
|
4020
4068
|
custom_cart_meta?: any;
|
|
4021
4069
|
};
|
|
4022
|
-
/** @returns {
|
|
4023
|
-
declare function
|
|
4024
|
-
type
|
|
4070
|
+
/** @returns {RefundDetails} */
|
|
4071
|
+
declare function RefundDetails(): RefundDetails;
|
|
4072
|
+
type RefundDetails = {
|
|
4025
4073
|
/**
|
|
4026
4074
|
* - Refunded amount
|
|
4027
4075
|
*/
|
|
@@ -4047,9 +4095,9 @@ type RefundDetailsSerializer = {
|
|
|
4047
4095
|
*/
|
|
4048
4096
|
refund_utr: string;
|
|
4049
4097
|
};
|
|
4050
|
-
/** @returns {
|
|
4051
|
-
declare function
|
|
4052
|
-
type
|
|
4098
|
+
/** @returns {PaymentSessionFetchDetails} */
|
|
4099
|
+
declare function PaymentSessionFetchDetails(): PaymentSessionFetchDetails;
|
|
4100
|
+
type PaymentSessionFetchDetails = {
|
|
4053
4101
|
/**
|
|
4054
4102
|
* - Object of payment details
|
|
4055
4103
|
*/
|
|
@@ -4072,11 +4120,11 @@ type PaymentSessionSerializer = {
|
|
|
4072
4120
|
* Fynd payments platform and is unique.
|
|
4073
4121
|
*/
|
|
4074
4122
|
gid: string;
|
|
4075
|
-
cart_details?:
|
|
4123
|
+
cart_details?: CartDetails;
|
|
4076
4124
|
/**
|
|
4077
4125
|
* - Object of refund details
|
|
4078
4126
|
*/
|
|
4079
|
-
refund_details:
|
|
4127
|
+
refund_details: RefundDetails[];
|
|
4080
4128
|
};
|
|
4081
4129
|
/** @returns {RefundSourcesPriority} */
|
|
4082
4130
|
declare function RefundSourcesPriority(): RefundSourcesPriority;
|
|
@@ -4094,9 +4142,9 @@ type RefundSourcesPriority = {
|
|
|
4094
4142
|
*/
|
|
4095
4143
|
source: string;
|
|
4096
4144
|
};
|
|
4097
|
-
/** @returns {
|
|
4098
|
-
declare function
|
|
4099
|
-
type
|
|
4145
|
+
/** @returns {RefundPriorityDetails} */
|
|
4146
|
+
declare function RefundPriorityDetails(): RefundPriorityDetails;
|
|
4147
|
+
type RefundPriorityDetails = {
|
|
4100
4148
|
/**
|
|
4101
4149
|
* - Configuration for merchant or customer
|
|
4102
4150
|
*/
|
|
@@ -4118,9 +4166,9 @@ type RefundPriorityResponseSerializer = {
|
|
|
4118
4166
|
*/
|
|
4119
4167
|
message?: string;
|
|
4120
4168
|
};
|
|
4121
|
-
/** @returns {
|
|
4122
|
-
declare function
|
|
4123
|
-
type
|
|
4169
|
+
/** @returns {RefundPriorityCreation} */
|
|
4170
|
+
declare function RefundPriorityCreation(): RefundPriorityCreation;
|
|
4171
|
+
type RefundPriorityCreation = {
|
|
4124
4172
|
/**
|
|
4125
4173
|
* - Apportion refund to multiple sources
|
|
4126
4174
|
*/
|
|
@@ -4130,9 +4178,9 @@ type RefundPriorityRequestSerializer = {
|
|
|
4130
4178
|
*/
|
|
4131
4179
|
refund_sources_priority: RefundSourcesPriority[];
|
|
4132
4180
|
};
|
|
4133
|
-
/** @returns {
|
|
4134
|
-
declare function
|
|
4135
|
-
type
|
|
4181
|
+
/** @returns {MerchantPaymentModeCreation} */
|
|
4182
|
+
declare function MerchantPaymentModeCreation(): MerchantPaymentModeCreation;
|
|
4183
|
+
type MerchantPaymentModeCreation = {
|
|
4136
4184
|
/**
|
|
4137
4185
|
* - Business unit
|
|
4138
4186
|
*/
|
|
@@ -4170,9 +4218,9 @@ type ToConfig = {
|
|
|
4170
4218
|
*/
|
|
4171
4219
|
business_unit: string;
|
|
4172
4220
|
};
|
|
4173
|
-
/** @returns {
|
|
4174
|
-
declare function
|
|
4175
|
-
type
|
|
4221
|
+
/** @returns {PlatformPaymentModeCopyConfigCreation} */
|
|
4222
|
+
declare function PlatformPaymentModeCopyConfigCreation(): PlatformPaymentModeCopyConfigCreation;
|
|
4223
|
+
type PlatformPaymentModeCopyConfigCreation = {
|
|
4176
4224
|
from_config: FromConfig;
|
|
4177
4225
|
to_config: ToConfig;
|
|
4178
4226
|
};
|
|
@@ -4213,9 +4261,9 @@ type PaymentOrderMethods = {
|
|
|
4213
4261
|
*/
|
|
4214
4262
|
name: string;
|
|
4215
4263
|
};
|
|
4216
|
-
/** @returns {
|
|
4217
|
-
declare function
|
|
4218
|
-
type
|
|
4264
|
+
/** @returns {PaymentOrderCreation} */
|
|
4265
|
+
declare function PaymentOrderCreation(): PaymentOrderCreation;
|
|
4266
|
+
type PaymentOrderCreation = {
|
|
4219
4267
|
/**
|
|
4220
4268
|
* - Order id
|
|
4221
4269
|
*/
|
|
@@ -4270,9 +4318,9 @@ type PaymentOrderData = {
|
|
|
4270
4318
|
*/
|
|
4271
4319
|
merchant_order_id?: string;
|
|
4272
4320
|
};
|
|
4273
|
-
/** @returns {
|
|
4274
|
-
declare function
|
|
4275
|
-
type
|
|
4321
|
+
/** @returns {PaymentOrderDetails} */
|
|
4322
|
+
declare function PaymentOrderDetails(): PaymentOrderDetails;
|
|
4323
|
+
type PaymentOrderDetails = {
|
|
4276
4324
|
/**
|
|
4277
4325
|
* - Message
|
|
4278
4326
|
*/
|
|
@@ -4306,9 +4354,9 @@ type AggregatorVersionItemSchema = {
|
|
|
4306
4354
|
is_less_than?: string;
|
|
4307
4355
|
is_greater_than?: string;
|
|
4308
4356
|
};
|
|
4309
|
-
/** @returns {
|
|
4310
|
-
declare function
|
|
4311
|
-
type
|
|
4357
|
+
/** @returns {AggregatorVersionDetails} */
|
|
4358
|
+
declare function AggregatorVersionDetails(): AggregatorVersionDetails;
|
|
4359
|
+
type AggregatorVersionDetails = {
|
|
4312
4360
|
/**
|
|
4313
4361
|
* - Message
|
|
4314
4362
|
*/
|
|
@@ -4326,9 +4374,9 @@ type AggregatorVersionRequestSchema = {
|
|
|
4326
4374
|
is_less_than?: string;
|
|
4327
4375
|
is_greater_than?: string;
|
|
4328
4376
|
};
|
|
4329
|
-
/** @returns {
|
|
4330
|
-
declare function
|
|
4331
|
-
type
|
|
4377
|
+
/** @returns {PatchAggregatorControl} */
|
|
4378
|
+
declare function PatchAggregatorControl(): PatchAggregatorControl;
|
|
4379
|
+
type PatchAggregatorControl = {
|
|
4332
4380
|
/**
|
|
4333
4381
|
* - Business unit
|
|
4334
4382
|
*/
|
|
@@ -4436,3 +4484,95 @@ type PaymentCustomConfigResponseSchema = {
|
|
|
4436
4484
|
message: string;
|
|
4437
4485
|
items: PaymentModeCustomConfigSchema[];
|
|
4438
4486
|
};
|
|
4487
|
+
/** @returns {CustomerValidationSchema} */
|
|
4488
|
+
declare function CustomerValidationSchema(): CustomerValidationSchema;
|
|
4489
|
+
type CustomerValidationSchema = {
|
|
4490
|
+
/**
|
|
4491
|
+
* - Aggregator name of the payment gateway.
|
|
4492
|
+
*/
|
|
4493
|
+
aggregator: string;
|
|
4494
|
+
/**
|
|
4495
|
+
* - Payable amount
|
|
4496
|
+
*/
|
|
4497
|
+
transaction_amount: number;
|
|
4498
|
+
/**
|
|
4499
|
+
* - Unique identifier for the shopping cart.
|
|
4500
|
+
*/
|
|
4501
|
+
cart_id?: string;
|
|
4502
|
+
/**
|
|
4503
|
+
* - The unique identifier of the user.
|
|
4504
|
+
*/
|
|
4505
|
+
user_id?: string;
|
|
4506
|
+
};
|
|
4507
|
+
/** @returns {UserCreditSchema} */
|
|
4508
|
+
declare function UserCreditSchema(): UserCreditSchema;
|
|
4509
|
+
type UserCreditSchema = {
|
|
4510
|
+
/**
|
|
4511
|
+
* - The monetary value, which can represent available
|
|
4512
|
+
* balance, redeemed balance, or hold amount, depending on the context.
|
|
4513
|
+
*/
|
|
4514
|
+
amount: number;
|
|
4515
|
+
/**
|
|
4516
|
+
* - The currency code (e.g., INR, USD).
|
|
4517
|
+
*/
|
|
4518
|
+
currency: string;
|
|
4519
|
+
/**
|
|
4520
|
+
* - A unique identifier for the payment transaction.
|
|
4521
|
+
*/
|
|
4522
|
+
unique_id?: string;
|
|
4523
|
+
};
|
|
4524
|
+
/** @returns {CreditAccountSummary} */
|
|
4525
|
+
declare function CreditAccountSummary(): CreditAccountSummary;
|
|
4526
|
+
type CreditAccountSummary = {
|
|
4527
|
+
/**
|
|
4528
|
+
* - Unique identifier associated with the
|
|
4529
|
+
* customer's account
|
|
4530
|
+
*/
|
|
4531
|
+
account_id: string;
|
|
4532
|
+
/**
|
|
4533
|
+
* - Current state of the account, indicating whether
|
|
4534
|
+
* it is ACTIVE, INACTIVE, or UNREGISTERED.
|
|
4535
|
+
*/
|
|
4536
|
+
status: string;
|
|
4537
|
+
redeemable_balance?: UserCreditSchema;
|
|
4538
|
+
available_balance?: UserCreditSchema;
|
|
4539
|
+
amount_on_hold?: UserCreditSchema[];
|
|
4540
|
+
};
|
|
4541
|
+
/** @returns {ValidateCustomerCreditSchema} */
|
|
4542
|
+
declare function ValidateCustomerCreditSchema(): ValidateCustomerCreditSchema;
|
|
4543
|
+
type ValidateCustomerCreditSchema = {
|
|
4544
|
+
/**
|
|
4545
|
+
* - Successful or failure of API
|
|
4546
|
+
*/
|
|
4547
|
+
success: boolean;
|
|
4548
|
+
/**
|
|
4549
|
+
* - The customer is eligible to make a transaction or not
|
|
4550
|
+
*/
|
|
4551
|
+
is_eligible: boolean;
|
|
4552
|
+
/**
|
|
4553
|
+
* - Credit is applied to the user's account or not
|
|
4554
|
+
*/
|
|
4555
|
+
is_applied?: boolean;
|
|
4556
|
+
/**
|
|
4557
|
+
* - Detailed message about the user credt eligibility.
|
|
4558
|
+
*/
|
|
4559
|
+
message: string;
|
|
4560
|
+
/**
|
|
4561
|
+
* - Unique identifier for the shopping cart.
|
|
4562
|
+
*/
|
|
4563
|
+
cart_id?: string;
|
|
4564
|
+
account?: CreditAccountSummary;
|
|
4565
|
+
};
|
|
4566
|
+
/** @returns {OperationResponseSchema} */
|
|
4567
|
+
declare function OperationResponseSchema(): OperationResponseSchema;
|
|
4568
|
+
type OperationResponseSchema = {
|
|
4569
|
+
/**
|
|
4570
|
+
* - Indicates if the operation was successful
|
|
4571
|
+
*/
|
|
4572
|
+
success: boolean;
|
|
4573
|
+
/**
|
|
4574
|
+
* - Optional message providing additional
|
|
4575
|
+
* information about the operation
|
|
4576
|
+
*/
|
|
4577
|
+
message?: string;
|
|
4578
|
+
};
|