@gofynd/fdk-client-javascript 1.4.14 → 1.4.15-beta.1
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 +1 -1
- package/package.json +1 -1
- package/sdk/application/ApplicationClient.d.ts +0 -2
- package/sdk/application/ApplicationClient.js +0 -2
- package/sdk/application/Cart/CartApplicationClient.d.ts +53 -60
- package/sdk/application/Cart/CartApplicationClient.js +53 -130
- package/sdk/application/Cart/CartApplicationModel.d.ts +143 -489
- package/sdk/application/Cart/CartApplicationModel.js +159 -380
- package/sdk/application/Cart/CartApplicationValidator.d.ts +19 -38
- package/sdk/application/Cart/CartApplicationValidator.js +18 -34
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +68 -88
- package/sdk/application/Catalog/CatalogApplicationClient.js +94 -114
- package/sdk/application/Catalog/CatalogApplicationModel.d.ts +142 -194
- package/sdk/application/Catalog/CatalogApplicationModel.js +133 -171
- package/sdk/application/Common/CommonApplicationClient.d.ts +2 -3
- package/sdk/application/Common/CommonApplicationClient.js +5 -6
- package/sdk/application/Common/CommonApplicationModel.d.ts +9 -9
- package/sdk/application/Common/CommonApplicationModel.js +6 -6
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +27 -34
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +27 -34
- package/sdk/application/Configuration/ConfigurationApplicationModel.d.ts +57 -45
- package/sdk/application/Configuration/ConfigurationApplicationModel.js +47 -35
- package/sdk/application/Configuration/ConfigurationApplicationValidator.d.ts +2 -2
- package/sdk/application/Configuration/ConfigurationApplicationValidator.js +2 -2
- package/sdk/application/Content/ContentApplicationClient.d.ts +33 -23
- package/sdk/application/Content/ContentApplicationClient.js +75 -54
- package/sdk/application/Content/ContentApplicationModel.d.ts +37 -93
- package/sdk/application/Content/ContentApplicationModel.js +32 -83
- package/sdk/application/Content/ContentApplicationValidator.d.ts +17 -23
- package/sdk/application/Content/ContentApplicationValidator.js +10 -15
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +8 -9
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +13 -14
- package/sdk/application/FileStorage/FileStorageApplicationModel.d.ts +25 -23
- package/sdk/application/FileStorage/FileStorageApplicationModel.js +18 -16
- package/sdk/application/FileStorage/FileStorageApplicationValidator.d.ts +6 -6
- package/sdk/application/FileStorage/FileStorageApplicationValidator.js +6 -6
- package/sdk/application/Lead/LeadApplicationClient.d.ts +3 -2
- package/sdk/application/Lead/LeadApplicationClient.js +3 -2
- package/sdk/application/Lead/LeadApplicationModel.d.ts +11 -11
- package/sdk/application/Lead/LeadApplicationModel.js +19 -19
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +16 -39
- package/sdk/application/Logistic/LogisticApplicationClient.js +21 -189
- package/sdk/application/Logistic/LogisticApplicationModel.d.ts +173 -532
- package/sdk/application/Logistic/LogisticApplicationModel.js +139 -409
- package/sdk/application/Logistic/LogisticApplicationValidator.d.ts +9 -54
- package/sdk/application/Logistic/LogisticApplicationValidator.js +8 -42
- package/sdk/application/Order/OrderApplicationClient.d.ts +10 -24
- package/sdk/application/Order/OrderApplicationClient.js +13 -96
- package/sdk/application/Order/OrderApplicationModel.d.ts +120 -436
- package/sdk/application/Order/OrderApplicationModel.js +81 -279
- package/sdk/application/Order/OrderApplicationValidator.d.ts +3 -17
- package/sdk/application/Order/OrderApplicationValidator.js +2 -15
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +99 -96
- package/sdk/application/Payment/PaymentApplicationClient.js +114 -111
- package/sdk/application/Payment/PaymentApplicationModel.d.ts +289 -293
- package/sdk/application/Payment/PaymentApplicationModel.js +241 -243
- package/sdk/application/Payment/PaymentApplicationValidator.d.ts +46 -46
- package/sdk/application/Payment/PaymentApplicationValidator.js +46 -46
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +16 -13
- package/sdk/application/Rewards/RewardsApplicationClient.js +22 -19
- package/sdk/application/Rewards/RewardsApplicationModel.d.ts +37 -37
- package/sdk/application/Rewards/RewardsApplicationModel.js +29 -29
- package/sdk/application/Rewards/RewardsApplicationValidator.d.ts +6 -6
- package/sdk/application/Rewards/RewardsApplicationValidator.js +6 -6
- package/sdk/application/Share/ShareApplicationModel.js +1 -1
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +2 -2
- package/sdk/application/Theme/ThemeApplicationClient.js +6 -8
- package/sdk/application/Theme/ThemeApplicationModel.d.ts +17 -48
- package/sdk/application/Theme/ThemeApplicationModel.js +22 -42
- package/sdk/application/Theme/ThemeApplicationValidator.d.ts +3 -16
- package/sdk/application/Theme/ThemeApplicationValidator.js +2 -9
- package/sdk/application/User/UserApplicationClient.d.ts +10 -10
- package/sdk/application/User/UserApplicationClient.js +10 -10
- package/sdk/application/User/UserApplicationModel.d.ts +17 -17
- package/sdk/application/User/UserApplicationModel.js +16 -16
- package/sdk/application/User/UserApplicationValidator.d.ts +2 -2
- package/sdk/application/User/UserApplicationValidator.js +2 -2
- package/sdk/application/Webhook/WebhookApplicationClient.d.ts +4 -4
- package/sdk/application/Webhook/WebhookApplicationClient.js +4 -4
- package/sdk/application/Webhook/WebhookApplicationModel.d.ts +9 -11
- package/sdk/application/Webhook/WebhookApplicationModel.js +6 -8
- package/sdk/application/Webhook/WebhookApplicationValidator.d.ts +2 -2
- package/sdk/application/Webhook/WebhookApplicationValidator.js +2 -2
- package/sdk/application/index.d.ts +0 -1
- package/sdk/application/index.js +0 -2
- package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +12 -86
- package/sdk/partner/FileStorage/FileStoragePartnerClient.js +24 -582
- package/sdk/partner/FileStorage/FileStoragePartnerModel.d.ts +19 -116
- package/sdk/partner/FileStorage/FileStoragePartnerModel.js +14 -121
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.d.ts +1 -8
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.js +4 -51
- package/sdk/partner/Lead/LeadPartnerClient.d.ts +2 -2
- package/sdk/partner/Lead/LeadPartnerClient.js +2 -2
- package/sdk/partner/Lead/LeadPartnerModel.d.ts +5 -5
- package/sdk/partner/Lead/LeadPartnerModel.js +15 -15
- package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +20 -126
- package/sdk/partner/Logistics/LogisticsPartnerClient.js +20 -970
- package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +85 -767
- package/sdk/partner/Logistics/LogisticsPartnerModel.js +76 -429
- package/sdk/partner/Logistics/LogisticsPartnerValidator.d.ts +0 -10
- package/sdk/partner/Logistics/LogisticsPartnerValidator.js +6 -120
- package/sdk/partner/Theme/ThemePartnerClient.d.ts +10 -8
- package/sdk/partner/Theme/ThemePartnerClient.js +16 -14
- package/sdk/partner/Theme/ThemePartnerModel.d.ts +37 -96
- package/sdk/partner/Theme/ThemePartnerModel.js +36 -90
- package/sdk/partner/Theme/ThemePartnerValidator.js +4 -4
- package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +18 -28
- package/sdk/partner/Webhook/WebhookPartnerClient.js +18 -103
- package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +179 -612
- package/sdk/partner/Webhook/WebhookPartnerModel.js +150 -253
- package/sdk/partner/Webhook/WebhookPartnerValidator.d.ts +0 -1
- package/sdk/partner/Webhook/WebhookPartnerValidator.js +3 -11
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.d.ts +4 -5
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.js +8 -14
- package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +9 -59
- package/sdk/platform/Analytics/AnalyticsPlatformModel.js +4 -40
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +32 -2
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +243 -3
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +130 -11
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +152 -12
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +39 -1
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.js +35 -0
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +12 -12
- package/sdk/platform/Billing/BillingPlatformClient.js +15 -15
- package/sdk/platform/Billing/BillingPlatformModel.d.ts +388 -443
- package/sdk/platform/Billing/BillingPlatformModel.js +263 -280
- package/sdk/platform/Billing/BillingPlatformValidator.d.ts +18 -16
- package/sdk/platform/Billing/BillingPlatformValidator.js +9 -8
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +103 -134
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +112 -407
- package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +65 -111
- package/sdk/platform/Cart/CartPlatformApplicationValidator.js +44 -106
- package/sdk/platform/Cart/CartPlatformModel.d.ts +1304 -4979
- package/sdk/platform/Cart/CartPlatformModel.js +1217 -1922
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +183 -208
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +358 -383
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +126 -122
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +68 -66
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +118 -141
- package/sdk/platform/Catalog/CatalogPlatformClient.js +170 -193
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +1751 -1501
- package/sdk/platform/Catalog/CatalogPlatformModel.js +1224 -1393
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +18 -18
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +18 -18
- package/sdk/platform/Common/CommonPlatformClient.d.ts +2 -3
- package/sdk/platform/Common/CommonPlatformClient.js +2 -3
- package/sdk/platform/Common/CommonPlatformModel.d.ts +9 -9
- package/sdk/platform/Common/CommonPlatformModel.js +6 -6
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +17 -16
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +17 -16
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +8 -8
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +8 -8
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +33 -43
- package/sdk/platform/Communication/CommunicationPlatformModel.js +34 -38
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +42 -46
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +43 -47
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +223 -223
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +212 -210
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +12 -12
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +12 -12
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +33 -46
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +54 -67
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +18 -18
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +18 -18
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +24 -45
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +30 -134
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +124 -283
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +94 -219
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +9 -37
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +8 -27
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +141 -124
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +422 -449
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +141 -179
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +130 -168
- package/sdk/platform/Content/ContentPlatformClient.d.ts +106 -142
- package/sdk/platform/Content/ContentPlatformClient.js +336 -523
- package/sdk/platform/Content/ContentPlatformModel.d.ts +395 -1241
- package/sdk/platform/Content/ContentPlatformModel.js +390 -521
- package/sdk/platform/Content/ContentPlatformValidator.d.ts +117 -168
- package/sdk/platform/Content/ContentPlatformValidator.js +108 -162
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +12 -14
- package/sdk/platform/Discount/DiscountPlatformClient.js +12 -14
- package/sdk/platform/Discount/DiscountPlatformModel.d.ts +13 -13
- package/sdk/platform/Discount/DiscountPlatformModel.js +12 -12
- package/sdk/platform/Discount/DiscountPlatformValidator.d.ts +2 -2
- package/sdk/platform/Discount/DiscountPlatformValidator.js +2 -2
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +36 -94
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +60 -462
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +15 -62
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +13 -75
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +19 -19
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +21 -21
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +101 -370
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +84 -313
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +6 -6
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.js +6 -6
- package/sdk/platform/Finance/FinancePlatformClient.d.ts +320 -0
- package/sdk/platform/Finance/FinancePlatformClient.js +2333 -0
- package/sdk/platform/Finance/FinancePlatformModel.d.ts +2890 -0
- package/sdk/platform/Finance/FinancePlatformModel.js +2148 -0
- package/sdk/platform/Finance/FinancePlatformValidator.d.ts +284 -0
- package/sdk/platform/Finance/FinancePlatformValidator.js +354 -0
- package/sdk/platform/Lead/LeadPlatformClient.d.ts +2 -2
- package/sdk/platform/Lead/LeadPlatformClient.js +2 -2
- package/sdk/platform/Lead/LeadPlatformModel.d.ts +5 -5
- package/sdk/platform/Lead/LeadPlatformModel.js +16 -16
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +4 -15
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +5 -83
- package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +4 -25
- package/sdk/platform/Order/OrderPlatformApplicationValidator.js +3 -16
- package/sdk/platform/Order/OrderPlatformClient.d.ts +97 -178
- package/sdk/platform/Order/OrderPlatformClient.js +245 -597
- package/sdk/platform/Order/OrderPlatformModel.d.ts +3071 -5449
- package/sdk/platform/Order/OrderPlatformModel.js +1656 -3501
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +190 -237
- package/sdk/platform/Order/OrderPlatformValidator.js +105 -153
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +4 -6
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +7 -9
- package/sdk/platform/Partner/PartnerPlatformModel.d.ts +9 -9
- package/sdk/platform/Partner/PartnerPlatformModel.js +8 -8
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +106 -94
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +146 -131
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +93 -64
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +70 -62
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +20 -20
- package/sdk/platform/Payment/PaymentPlatformClient.js +20 -20
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +507 -386
- package/sdk/platform/Payment/PaymentPlatformModel.js +376 -323
- package/sdk/platform/Payment/PaymentPlatformValidator.d.ts +10 -10
- package/sdk/platform/Payment/PaymentPlatformValidator.js +10 -10
- package/sdk/platform/PlatformClient.d.ts +2 -0
- package/sdk/platform/PlatformClient.js +4 -0
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +2 -2
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +2 -2
- package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.d.ts +2 -2
- package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.js +2 -2
- package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +9 -9
- package/sdk/platform/Rewards/RewardsPlatformModel.js +8 -8
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +35 -45
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +38 -117
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +13 -22
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +12 -24
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +46 -40
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +64 -58
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +341 -602
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +284 -483
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +8 -8
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +8 -8
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +2 -2
- package/sdk/platform/Share/SharePlatformApplicationClient.js +2 -2
- package/sdk/platform/Share/SharePlatformModel.d.ts +5 -36
- package/sdk/platform/Share/SharePlatformModel.js +4 -27
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +3 -3
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +4 -8
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +0 -5
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +0 -2
- package/sdk/platform/Theme/ThemePlatformModel.d.ts +11 -37
- package/sdk/platform/Theme/ThemePlatformModel.js +15 -33
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +12 -12
- package/sdk/platform/User/UserPlatformApplicationClient.js +12 -12
- package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +2 -2
- package/sdk/platform/User/UserPlatformApplicationValidator.js +2 -2
- package/sdk/platform/User/UserPlatformModel.d.ts +21 -21
- package/sdk/platform/User/UserPlatformModel.js +23 -23
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +78 -25
- package/sdk/platform/Webhook/WebhookPlatformClient.js +470 -75
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +427 -720
- package/sdk/platform/Webhook/WebhookPlatformModel.js +386 -410
- package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +55 -10
- package/sdk/platform/Webhook/WebhookPlatformValidator.js +72 -12
- package/sdk/platform/index.d.ts +1 -0
- package/sdk/platform/index.js +2 -0
- package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +2 -3
- package/sdk/public/Configuration/ConfigurationPublicClient.js +5 -6
- package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +9 -9
- package/sdk/public/Configuration/ConfigurationPublicModel.js +6 -6
- package/sdk/public/Content/ContentPublicClient.d.ts +2 -112
- package/sdk/public/Content/ContentPublicClient.js +5 -791
- package/sdk/public/Content/ContentPublicModel.d.ts +3 -549
- package/sdk/public/Content/ContentPublicModel.js +3 -649
- package/sdk/public/Content/ContentPublicValidator.d.ts +3 -69
- package/sdk/public/Content/ContentPublicValidator.js +2 -88
- package/sdk/public/Webhook/WebhookPublicClient.d.ts +8 -8
- package/sdk/public/Webhook/WebhookPublicClient.js +8 -8
- package/sdk/public/Webhook/WebhookPublicModel.d.ts +21 -21
- package/sdk/public/Webhook/WebhookPublicModel.js +15 -15
- package/sdk/public/Webhook/WebhookPublicValidator.d.ts +4 -4
- package/sdk/public/Webhook/WebhookPublicValidator.js +4 -4
- package/sdk/application/Finance/FinanceApplicationClient.d.ts +0 -36
- package/sdk/application/Finance/FinanceApplicationClient.js +0 -202
- package/sdk/application/Finance/FinanceApplicationModel.d.ts +0 -289
- package/sdk/application/Finance/FinanceApplicationModel.js +0 -208
- package/sdk/application/Finance/FinanceApplicationValidator.d.ts +0 -25
- package/sdk/application/Finance/FinanceApplicationValidator.js +0 -31
|
@@ -1,13 +1,13 @@
|
|
|
1
1
|
export = PaymentPlatformModel;
|
|
2
2
|
/**
|
|
3
|
-
* @typedef
|
|
4
|
-
* @property {Object[]} [aggregators] - List of all
|
|
5
|
-
* with their Details.
|
|
3
|
+
* @typedef PaymentGatewayConfigResponse
|
|
4
|
+
* @property {Object[]} [aggregators] - List of all config specific to the
|
|
5
|
+
* aggregator with their Details.
|
|
6
6
|
* @property {string} app_id - Application Id to which Payment config Mapped
|
|
7
|
-
* @property {string[]} excluded_fields - List of all excluded
|
|
7
|
+
* @property {string[]} excluded_fields - List of all excluded config with their Details.
|
|
8
8
|
* @property {boolean} success - Response is successful or not
|
|
9
9
|
* @property {boolean} created - Response is created or not
|
|
10
|
-
* @property {string[]} display_fields - List of all
|
|
10
|
+
* @property {string[]} display_fields - List of all display related configs, i.e. logo
|
|
11
11
|
*/
|
|
12
12
|
/**
|
|
13
13
|
* @typedef ErrorCodeDescription
|
|
@@ -21,10 +21,11 @@ export = PaymentPlatformModel;
|
|
|
21
21
|
* @property {string} config_type - Config Type of the aggregator
|
|
22
22
|
* @property {boolean} [is_active] - Enable or Disable Flag
|
|
23
23
|
* @property {string} key - Api key of the payment aggregator
|
|
24
|
-
* @property {string} merchant_salt -
|
|
24
|
+
* @property {string} merchant_salt - The secret key or token provided by the
|
|
25
|
+
* payment aggregator for the merchant.
|
|
25
26
|
*/
|
|
26
27
|
/**
|
|
27
|
-
* @typedef
|
|
28
|
+
* @typedef PaymentGatewayConfigRequest
|
|
28
29
|
* @property {string} app_id - Application Id to which Payment config Mapped
|
|
29
30
|
* @property {boolean} [is_active] - Enable or Disable Flag
|
|
30
31
|
* @property {PaymentGatewayConfig} [aggregator_name]
|
|
@@ -40,7 +41,7 @@ export = PaymentPlatformModel;
|
|
|
40
41
|
* @property {string} code - Error descrption code.
|
|
41
42
|
*/
|
|
42
43
|
/**
|
|
43
|
-
* @typedef
|
|
44
|
+
* @typedef HttpErrorCodeAndResponse
|
|
44
45
|
* @property {ErrorCodeAndDescription} error
|
|
45
46
|
* @property {boolean} success - Response is successful or not
|
|
46
47
|
*/
|
|
@@ -52,10 +53,10 @@ export = PaymentPlatformModel;
|
|
|
52
53
|
/**
|
|
53
54
|
* @typedef ProductCODData
|
|
54
55
|
* @property {Object} [items] - Item id with its cod availability.
|
|
55
|
-
* @property {
|
|
56
|
+
* @property {CODChargesLimitsResponse} [cod_charges]
|
|
56
57
|
*/
|
|
57
58
|
/**
|
|
58
|
-
* @typedef
|
|
59
|
+
* @typedef CODChargesLimitsResponse
|
|
59
60
|
* @property {number} [max_cart_value] - Max allowed cart value for cod order.
|
|
60
61
|
* @property {number} [min_cart_value] - Min allowed cart value for cod order.
|
|
61
62
|
* @property {number} [cod_charge] - Cod charges to be applied on order.
|
|
@@ -162,7 +163,7 @@ export = PaymentPlatformModel;
|
|
|
162
163
|
/**
|
|
163
164
|
* @typedef PaymentOptionAndFlow
|
|
164
165
|
* @property {RootPaymentMode[]} payment_option - Payment options
|
|
165
|
-
* @property {PaymentFlow} payment_flows
|
|
166
|
+
* @property {PaymentFlow} [payment_flows]
|
|
166
167
|
* @property {PaymentDefaultSelection} [payment_default_selection]
|
|
167
168
|
*/
|
|
168
169
|
/**
|
|
@@ -197,14 +198,14 @@ export = PaymentPlatformModel;
|
|
|
197
198
|
* @property {AdvanceObject} [advance]
|
|
198
199
|
*/
|
|
199
200
|
/**
|
|
200
|
-
* @typedef
|
|
201
|
+
* @typedef PaymentModeRouteResponse
|
|
201
202
|
* @property {PaymentOptionAndFlow} payment_options
|
|
202
203
|
* @property {boolean} success - Response is successful or not
|
|
203
204
|
* @property {Object} [payment_breakup] - Payment Breakup for advance payment
|
|
204
205
|
* @property {AdvancePaymentObject[]} [advance_payment] - Advance Payment Array
|
|
205
206
|
*/
|
|
206
207
|
/**
|
|
207
|
-
* @typedef
|
|
208
|
+
* @typedef PaymentOptionsResponse
|
|
208
209
|
* @property {PaymentOptions} payment_options
|
|
209
210
|
* @property {boolean} success - Response is successful or not
|
|
210
211
|
* @property {Object} [payment_breakup] - Payment Breakup for advance payment
|
|
@@ -246,7 +247,7 @@ export = PaymentPlatformModel;
|
|
|
246
247
|
* @property {string} transfer_type - Transafer type
|
|
247
248
|
*/
|
|
248
249
|
/**
|
|
249
|
-
* @typedef
|
|
250
|
+
* @typedef PayoutsResponse
|
|
250
251
|
* @property {boolean} success - Response is successful or not
|
|
251
252
|
* @property {Payout[]} items - Contains list of PayoutSchema
|
|
252
253
|
*/
|
|
@@ -264,7 +265,7 @@ export = PaymentPlatformModel;
|
|
|
264
265
|
* @property {number} [pincode]
|
|
265
266
|
*/
|
|
266
267
|
/**
|
|
267
|
-
* @typedef
|
|
268
|
+
* @typedef PayoutRequest
|
|
268
269
|
* @property {string} aggregator - Aggregator Name
|
|
269
270
|
* @property {Object} users - Payout users object
|
|
270
271
|
* @property {string} unique_external_id - Unique Id of Payout
|
|
@@ -273,7 +274,7 @@ export = PaymentPlatformModel;
|
|
|
273
274
|
* @property {string} transfer_type - Transafer type
|
|
274
275
|
*/
|
|
275
276
|
/**
|
|
276
|
-
* @typedef
|
|
277
|
+
* @typedef PayoutResponse
|
|
277
278
|
* @property {string} payment_status - Status of payment
|
|
278
279
|
* @property {Object} users - Users details object
|
|
279
280
|
* @property {string} aggregator - Aggregator Name
|
|
@@ -286,50 +287,50 @@ export = PaymentPlatformModel;
|
|
|
286
287
|
* @property {Object} payouts - Payout object
|
|
287
288
|
*/
|
|
288
289
|
/**
|
|
289
|
-
* @typedef
|
|
290
|
+
* @typedef UpdatePayoutResponse
|
|
290
291
|
* @property {boolean} is_default - Enable or Disable Default Payout
|
|
291
292
|
* @property {boolean} is_active - Enable or DIsable Flag Payout
|
|
292
293
|
* @property {boolean} success - Response is successful or not
|
|
293
294
|
*/
|
|
294
295
|
/**
|
|
295
|
-
* @typedef
|
|
296
|
+
* @typedef UpdatePayoutRequest
|
|
296
297
|
* @property {boolean} is_default - Enable or Disable Default Payout
|
|
297
298
|
* @property {boolean} is_active - Enable or Disable Flag Payout
|
|
298
299
|
* @property {string} unique_external_id - Unique Id of Payout
|
|
299
300
|
*/
|
|
300
301
|
/**
|
|
301
|
-
* @typedef
|
|
302
|
+
* @typedef DeletePayoutResponse
|
|
302
303
|
* @property {boolean} success - Response is successful or not
|
|
303
304
|
*/
|
|
304
305
|
/**
|
|
305
|
-
* @typedef
|
|
306
|
+
* @typedef SubscriptionPaymentMethodResponse
|
|
306
307
|
* @property {Object[]} data - Subscription Payment Method Object
|
|
307
308
|
* @property {boolean} success - Response is successful or not
|
|
308
309
|
*/
|
|
309
310
|
/**
|
|
310
|
-
* @typedef
|
|
311
|
+
* @typedef DeleteSubscriptionPaymentMethodResponse
|
|
311
312
|
* @property {boolean} success - Success or failure.
|
|
312
313
|
*/
|
|
313
314
|
/**
|
|
314
|
-
* @typedef
|
|
315
|
+
* @typedef SubscriptionConfigResponse
|
|
315
316
|
* @property {string} aggregator - Aggregator Name
|
|
316
317
|
* @property {Object} config - Aggregator Config
|
|
317
318
|
* @property {boolean} success - Response is successful or not
|
|
318
319
|
*/
|
|
319
320
|
/**
|
|
320
|
-
* @typedef
|
|
321
|
+
* @typedef SaveSubscriptionSetupIntentRequest
|
|
321
322
|
* @property {string} unique_external_id - Unique id i.e company:id
|
|
322
323
|
*/
|
|
323
324
|
/**
|
|
324
|
-
* @typedef
|
|
325
|
+
* @typedef SaveSubscriptionSetupIntentResponse
|
|
325
326
|
* @property {Object} data - Subscription Payment Method Object
|
|
326
327
|
* @property {boolean} success - Response is successful or not
|
|
327
328
|
*/
|
|
328
329
|
/**
|
|
329
|
-
* @typedef
|
|
330
|
-
* @property {boolean} [is_verified_flag]
|
|
331
|
-
* @property {string} message - Response message
|
|
332
|
-
* @property {Object}
|
|
330
|
+
* @typedef RefundAccountResponse
|
|
331
|
+
* @property {boolean} [is_verified_flag] - Account is verified or not
|
|
332
|
+
* @property {string} [message] - Response message
|
|
333
|
+
* @property {Object} data - Refund account data.
|
|
333
334
|
* @property {boolean} success - Success or failure flag.
|
|
334
335
|
*/
|
|
335
336
|
/**
|
|
@@ -340,19 +341,19 @@ export = PaymentPlatformModel;
|
|
|
340
341
|
*/
|
|
341
342
|
/**
|
|
342
343
|
* @typedef BankDetailsForOTP
|
|
343
|
-
* @property {string} ifsc_code
|
|
344
|
-
* @property {string} account_no
|
|
345
|
-
* @property {string} branch_name
|
|
346
|
-
* @property {string} bank_name
|
|
347
|
-
* @property {string} account_holder
|
|
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
|
|
348
349
|
*/
|
|
349
350
|
/**
|
|
350
|
-
* @typedef
|
|
351
|
-
* @property {string} order_id
|
|
351
|
+
* @typedef AddBeneficiaryDetailsOTPRequest
|
|
352
|
+
* @property {string} order_id - Order_id for which account will be added
|
|
352
353
|
* @property {BankDetailsForOTP} details
|
|
353
354
|
*/
|
|
354
355
|
/**
|
|
355
|
-
* @typedef
|
|
356
|
+
* @typedef IfscCodeResponse
|
|
356
357
|
* @property {string} branch_name - Branch Name Of Account
|
|
357
358
|
* @property {boolean} [success] - Response is successful or not
|
|
358
359
|
* @property {string} bank_name - Bank Name Of Account
|
|
@@ -369,24 +370,24 @@ export = PaymentPlatformModel;
|
|
|
369
370
|
* @property {string} display_name - Display Name Of Account
|
|
370
371
|
* @property {string} [delights_user_name] - User Id Who filled the Beneficiary
|
|
371
372
|
* @property {string} transfer_mode - Transfer Mode Of Account
|
|
372
|
-
* @property {string} email -
|
|
373
|
+
* @property {string} email - Email of User
|
|
373
374
|
* @property {boolean} is_active - Boolean Flag whether Beneficiary set or not
|
|
374
375
|
* @property {string} [branch_name] - Branch Name Of Account
|
|
375
376
|
* @property {string} address - Address of User
|
|
376
|
-
* @property {string} modified_on -
|
|
377
|
+
* @property {string} modified_on - Modification Date of Beneficiary
|
|
377
378
|
* @property {string} beneficiary_id - Benenficiary Id
|
|
378
379
|
* @property {string} account_no - Account Number
|
|
379
380
|
* @property {string} bank_name - Bank Name Of Account
|
|
380
381
|
* @property {string} [mobile] - MObile no of User
|
|
381
382
|
*/
|
|
382
383
|
/**
|
|
383
|
-
* @typedef
|
|
384
|
+
* @typedef OrderBeneficiaryResponse
|
|
384
385
|
* @property {OrderBeneficiaryDetails[]} [beneficiaries] - All Beneficiaries Of An Order
|
|
385
386
|
* @property {boolean} [show_beneficiary_details] - Show beneficiary details or not.
|
|
386
387
|
*/
|
|
387
388
|
/**
|
|
388
389
|
* @typedef MultiTenderPaymentMeta
|
|
389
|
-
* @property {Object} [extra_meta]
|
|
390
|
+
* @property {Object} [extra_meta] - Key value pair for extra data related to payment mode
|
|
390
391
|
* @property {string} [order_id] - Fynd Platform order ID
|
|
391
392
|
* @property {string} [payment_id] - A unique identifier associated with a
|
|
392
393
|
* specific payment transaction
|
|
@@ -403,15 +404,15 @@ export = PaymentPlatformModel;
|
|
|
403
404
|
* @property {string} [name] - Payment mode name
|
|
404
405
|
* @property {MultiTenderPaymentMeta} [meta]
|
|
405
406
|
* @property {number} amount - Payment amount
|
|
406
|
-
* @property {string} mode
|
|
407
|
+
* @property {string} mode - Payment mode short code
|
|
407
408
|
*/
|
|
408
409
|
/**
|
|
409
|
-
* @typedef
|
|
410
|
+
* @typedef PaymentConfirmationRequest
|
|
410
411
|
* @property {string} order_id - Unique order id
|
|
411
412
|
* @property {MultiTenderPaymentMethod[]} payment_methods
|
|
412
413
|
*/
|
|
413
414
|
/**
|
|
414
|
-
* @typedef
|
|
415
|
+
* @typedef PaymentConfirmationResponse
|
|
415
416
|
* @property {string} order_id - Unique order id
|
|
416
417
|
* @property {string} message - Message
|
|
417
418
|
* @property {boolean} success - Payment confirmation updated or not.
|
|
@@ -425,19 +426,40 @@ export = PaymentPlatformModel;
|
|
|
425
426
|
* @property {number} usages - Used COD limit from the user Limit
|
|
426
427
|
*/
|
|
427
428
|
/**
|
|
428
|
-
* @typedef
|
|
429
|
-
* @property {
|
|
429
|
+
* @typedef CODLimitConfig
|
|
430
|
+
* @property {number} storefront - Limit for storefront
|
|
431
|
+
* @property {number} pos - Limit for pos
|
|
432
|
+
*/
|
|
433
|
+
/**
|
|
434
|
+
* @typedef CODPaymentLimitConfig
|
|
435
|
+
* @property {boolean} is_active - Boolean flag to show the status
|
|
436
|
+
* @property {number} usages - Used cod limit
|
|
437
|
+
* @property {number} user_id - User_id
|
|
438
|
+
* @property {string} merchant_user_id - Merchant_user_id
|
|
439
|
+
* @property {number} remaining_limit - Remaining COD limit
|
|
440
|
+
* @property {CODLimitConfig} limit
|
|
441
|
+
*/
|
|
442
|
+
/**
|
|
443
|
+
* @typedef GetUserBULimitResponse
|
|
444
|
+
* @property {string} business_unit - COD limit business unit
|
|
445
|
+
* @property {string} display_name - Display name for cod limit
|
|
446
|
+
* @property {CODPaymentLimitConfig} config
|
|
447
|
+
*/
|
|
448
|
+
/**
|
|
449
|
+
* @typedef GetUserCODLimitResponse
|
|
450
|
+
* @property {GetUserBULimitResponse[]} items
|
|
430
451
|
* @property {boolean} success - Response is successful or not
|
|
452
|
+
* @property {string} [message] - Message for cod limit
|
|
431
453
|
*/
|
|
432
454
|
/**
|
|
433
|
-
* @typedef
|
|
455
|
+
* @typedef SetCODForUserRequest
|
|
434
456
|
* @property {string} [business_unit] - Business unit
|
|
435
457
|
* @property {string} mobileno - Mobile No. of User
|
|
436
458
|
* @property {boolean} is_active - Either true or false
|
|
437
459
|
* @property {string} merchant_user_id - Merchant User id
|
|
438
460
|
*/
|
|
439
461
|
/**
|
|
440
|
-
* @typedef
|
|
462
|
+
* @typedef SetCODOptionResponse
|
|
441
463
|
* @property {string} message - Message
|
|
442
464
|
* @property {boolean} success - Response is successful or not
|
|
443
465
|
*/
|
|
@@ -448,7 +470,7 @@ export = PaymentPlatformModel;
|
|
|
448
470
|
* @property {string[]} models - List of string of edc models
|
|
449
471
|
*/
|
|
450
472
|
/**
|
|
451
|
-
* @typedef
|
|
473
|
+
* @typedef EdcAggregatorAndModelListResponse
|
|
452
474
|
* @property {EdcModelData[]} data - List of aggregators and their edc models
|
|
453
475
|
* @property {boolean} success - Response is successful or not
|
|
454
476
|
*/
|
|
@@ -458,12 +480,12 @@ export = PaymentPlatformModel;
|
|
|
458
480
|
* @property {number} active_device_count - No of active devices
|
|
459
481
|
*/
|
|
460
482
|
/**
|
|
461
|
-
* @typedef
|
|
483
|
+
* @typedef EdcDeviceStatsResponse
|
|
462
484
|
* @property {StatisticsData} statistics
|
|
463
485
|
* @property {boolean} success - Response is successful or not
|
|
464
486
|
*/
|
|
465
487
|
/**
|
|
466
|
-
* @typedef
|
|
488
|
+
* @typedef EdcAddRequest
|
|
467
489
|
* @property {string} edc_model - Model of the edc machine
|
|
468
490
|
* @property {number} store_id - Store at which devices is to used
|
|
469
491
|
* @property {number} aggregator_id - Aggregator which will accept payment
|
|
@@ -488,17 +510,17 @@ export = PaymentPlatformModel;
|
|
|
488
510
|
* @property {string} application_id - Application ID
|
|
489
511
|
*/
|
|
490
512
|
/**
|
|
491
|
-
* @typedef
|
|
513
|
+
* @typedef EdcDeviceAddResponse
|
|
492
514
|
* @property {EdcDevice} data
|
|
493
515
|
* @property {boolean} success - Response is successful or not
|
|
494
516
|
*/
|
|
495
517
|
/**
|
|
496
|
-
* @typedef
|
|
518
|
+
* @typedef EdcDeviceDetailsResponse
|
|
497
519
|
* @property {EdcDevice} data
|
|
498
520
|
* @property {boolean} success - Response is successful or not
|
|
499
521
|
*/
|
|
500
522
|
/**
|
|
501
|
-
* @typedef
|
|
523
|
+
* @typedef EdcUpdateRequest
|
|
502
524
|
* @property {string} [edc_model] - Model of the edc machine
|
|
503
525
|
* @property {number} [store_id] - Store at which devices is to used
|
|
504
526
|
* @property {number} [aggregator_id] - Aggregator which will accept payment
|
|
@@ -508,7 +530,7 @@ export = PaymentPlatformModel;
|
|
|
508
530
|
* @property {string} [device_tag] - Device tag of edc device to identify it
|
|
509
531
|
*/
|
|
510
532
|
/**
|
|
511
|
-
* @typedef
|
|
533
|
+
* @typedef EdcDeviceUpdateResponse
|
|
512
534
|
* @property {boolean} success - Response is successful or not
|
|
513
535
|
*/
|
|
514
536
|
/**
|
|
@@ -522,14 +544,14 @@ export = PaymentPlatformModel;
|
|
|
522
544
|
* @property {number} [size] - The number of items per page.
|
|
523
545
|
*/
|
|
524
546
|
/**
|
|
525
|
-
* @typedef
|
|
547
|
+
* @typedef EdcDeviceListResponse
|
|
526
548
|
* @property {EdcDevice[]} items - List of all edc mapped to the application
|
|
527
549
|
* options with their Details.
|
|
528
550
|
* @property {Page} page
|
|
529
551
|
* @property {boolean} success - Response is successful or not
|
|
530
552
|
*/
|
|
531
553
|
/**
|
|
532
|
-
* @typedef
|
|
554
|
+
* @typedef PaymentInitializationRequest
|
|
533
555
|
* @property {string} [razorpay_payment_id] - Payment gateway payment id
|
|
534
556
|
* @property {string} [device_id] - EDC machine Unique Identifier
|
|
535
557
|
* @property {string} email - Customer valid email
|
|
@@ -545,7 +567,7 @@ export = PaymentPlatformModel;
|
|
|
545
567
|
* @property {string} method - Payment method
|
|
546
568
|
*/
|
|
547
569
|
/**
|
|
548
|
-
* @typedef
|
|
570
|
+
* @typedef PaymentInitializationResponse
|
|
549
571
|
* @property {string} [razorpay_payment_id] - Payment id.
|
|
550
572
|
* @property {string} [device_id] - EDC machine Unique Identifier
|
|
551
573
|
* @property {string} [upi_poll_url] - UPI poll url.
|
|
@@ -565,7 +587,7 @@ export = PaymentPlatformModel;
|
|
|
565
587
|
* @property {string} method - Payment method
|
|
566
588
|
*/
|
|
567
589
|
/**
|
|
568
|
-
* @typedef
|
|
590
|
+
* @typedef PaymentStatusUpdateRequest
|
|
569
591
|
* @property {string} [device_id] - EDC machine Unique Identifier
|
|
570
592
|
* @property {string} email - Customer valid email
|
|
571
593
|
* @property {string} customer_id - Payment gateway customer id.
|
|
@@ -581,7 +603,7 @@ export = PaymentPlatformModel;
|
|
|
581
603
|
* @property {string} merchant_transaction_id - Unique fynd transaction id
|
|
582
604
|
*/
|
|
583
605
|
/**
|
|
584
|
-
* @typedef
|
|
606
|
+
* @typedef PaymentStatusUpdateResponse
|
|
585
607
|
* @property {string} [redirect_url] - Redirect url
|
|
586
608
|
* @property {boolean} retry - Response is successful or not.
|
|
587
609
|
* @property {boolean} [success] - Response is successful or not
|
|
@@ -589,7 +611,7 @@ export = PaymentPlatformModel;
|
|
|
589
611
|
* @property {string} aggregator_name - Payment gateway name
|
|
590
612
|
*/
|
|
591
613
|
/**
|
|
592
|
-
* @typedef
|
|
614
|
+
* @typedef ResendOrCancelPaymentRequest
|
|
593
615
|
* @property {string} order_id - Unique order id
|
|
594
616
|
* @property {string} [device_id] - EDC machine Unique Identifier
|
|
595
617
|
* @property {string} request_type - Either resend or cancel
|
|
@@ -602,16 +624,16 @@ export = PaymentPlatformModel;
|
|
|
602
624
|
* status of payment link.
|
|
603
625
|
*/
|
|
604
626
|
/**
|
|
605
|
-
* @typedef
|
|
627
|
+
* @typedef ResendOrCancelPaymentResponse
|
|
606
628
|
* @property {LinkStatus} data
|
|
607
629
|
* @property {boolean} success - Response is successful or not.
|
|
608
630
|
*/
|
|
609
631
|
/**
|
|
610
|
-
* @typedef
|
|
632
|
+
* @typedef PaymentStatusBulkHandlerRequest
|
|
611
633
|
* @property {string[]} merchant_order_id - List of order ids
|
|
612
634
|
*/
|
|
613
635
|
/**
|
|
614
|
-
* @typedef
|
|
636
|
+
* @typedef PaymentObjectListSerializer
|
|
615
637
|
* @property {Object} user_object
|
|
616
638
|
* @property {string} modified_on
|
|
617
639
|
* @property {string} collected_by
|
|
@@ -634,10 +656,10 @@ export = PaymentPlatformModel;
|
|
|
634
656
|
/**
|
|
635
657
|
* @typedef PaymentStatusObject
|
|
636
658
|
* @property {string} merchant_order_id
|
|
637
|
-
* @property {
|
|
659
|
+
* @property {PaymentObjectListSerializer[]} [payment_object_list]
|
|
638
660
|
*/
|
|
639
661
|
/**
|
|
640
|
-
* @typedef
|
|
662
|
+
* @typedef PaymentStatusBulkHandlerResponse
|
|
641
663
|
* @property {number} [count]
|
|
642
664
|
* @property {PaymentStatusObject[]} [data]
|
|
643
665
|
* @property {string} success
|
|
@@ -645,7 +667,7 @@ export = PaymentPlatformModel;
|
|
|
645
667
|
* @property {number} status
|
|
646
668
|
*/
|
|
647
669
|
/**
|
|
648
|
-
* @typedef
|
|
670
|
+
* @typedef GetOauthUrlResponse
|
|
649
671
|
* @property {string} url - The url to call for authenticating
|
|
650
672
|
* @property {boolean} success - Response is successful or not
|
|
651
673
|
*/
|
|
@@ -676,12 +698,12 @@ export = PaymentPlatformModel;
|
|
|
676
698
|
* @property {RepaymentRequestDetails[]} [shipment_details]
|
|
677
699
|
*/
|
|
678
700
|
/**
|
|
679
|
-
* @typedef
|
|
701
|
+
* @typedef RepaymentResponse
|
|
680
702
|
* @property {Object} data
|
|
681
703
|
* @property {boolean} success - Success/Failure of the transaction
|
|
682
704
|
*/
|
|
683
705
|
/**
|
|
684
|
-
* @typedef
|
|
706
|
+
* @typedef MerchantOnBoardingRequest
|
|
685
707
|
* @property {string} credit_line_id - Merchant ID at Ajiodhan's end
|
|
686
708
|
* @property {string} aggregator - Payment aggregator name
|
|
687
709
|
* @property {string} app_id - Application id
|
|
@@ -689,12 +711,12 @@ export = PaymentPlatformModel;
|
|
|
689
711
|
* @property {string} status - Status
|
|
690
712
|
*/
|
|
691
713
|
/**
|
|
692
|
-
* @typedef
|
|
714
|
+
* @typedef MerchantOnBoardingResponse
|
|
693
715
|
* @property {Object} data
|
|
694
716
|
* @property {boolean} success - Success/Failure of the transaction
|
|
695
717
|
*/
|
|
696
718
|
/**
|
|
697
|
-
* @typedef
|
|
719
|
+
* @typedef ValidateCustomerRequest
|
|
698
720
|
* @property {string} phone_number - User mobile number without country code.
|
|
699
721
|
* @property {string} aggregator - Payment gateway name in camel case i.e Simpl, Rupifi
|
|
700
722
|
* @property {string} [payload] - Hashed payload string.
|
|
@@ -705,13 +727,13 @@ export = PaymentPlatformModel;
|
|
|
705
727
|
* @property {Object} [billing_address] - Extra meta fields.
|
|
706
728
|
*/
|
|
707
729
|
/**
|
|
708
|
-
* @typedef
|
|
730
|
+
* @typedef ValidateCustomerResponse
|
|
709
731
|
* @property {string} message - Error or success message.
|
|
710
732
|
* @property {Object} [data] - Payment gateway response data
|
|
711
733
|
* @property {boolean} success - Response is successful or not
|
|
712
734
|
*/
|
|
713
735
|
/**
|
|
714
|
-
* @typedef
|
|
736
|
+
* @typedef GetPaymentLinkResponse
|
|
715
737
|
* @property {string} message - Message
|
|
716
738
|
* @property {number} status_code - HTTP status code
|
|
717
739
|
* @property {number} [amount] - Total value of order
|
|
@@ -719,7 +741,8 @@ export = PaymentPlatformModel;
|
|
|
719
741
|
* @property {string} [payment_link_url] - Url of payment link
|
|
720
742
|
* @property {string} [payment_link_current_status] - Status of payment link
|
|
721
743
|
* @property {string} [external_order_id] - Merchant order id
|
|
722
|
-
* @property {number} [polling_timeout] - Polling request timeout
|
|
744
|
+
* @property {number} [polling_timeout] - Polling request timeout, perform
|
|
745
|
+
* polling till timeout elapsed or payment status is success/failure
|
|
723
746
|
* @property {boolean} success - Successful or failure
|
|
724
747
|
*/
|
|
725
748
|
/**
|
|
@@ -734,7 +757,7 @@ export = PaymentPlatformModel;
|
|
|
734
757
|
* @property {boolean} [cancelled] - Payment link is cancelled or not
|
|
735
758
|
*/
|
|
736
759
|
/**
|
|
737
|
-
* @typedef
|
|
760
|
+
* @typedef ErrorResponse
|
|
738
761
|
* @property {number} status_code - HTTP status code
|
|
739
762
|
* @property {ErrorDescription} [error]
|
|
740
763
|
* @property {string} message - Message
|
|
@@ -742,13 +765,14 @@ export = PaymentPlatformModel;
|
|
|
742
765
|
*/
|
|
743
766
|
/**
|
|
744
767
|
* @typedef CreatePaymentLinkMeta
|
|
745
|
-
* @property {string} cart_id
|
|
746
|
-
* @property {string} checkout_mode
|
|
747
|
-
* @property {string} amount
|
|
748
|
-
* @property {string} [assign_card_id]
|
|
768
|
+
* @property {string} cart_id - Cart id for which payment link needs to be generated.
|
|
769
|
+
* @property {string} checkout_mode - Checkout mode for the payment link i.e. self
|
|
770
|
+
* @property {string} amount - Payment link amount to be paid by the customer
|
|
771
|
+
* @property {string} [assign_card_id] - Assigned card id against which payment
|
|
772
|
+
* to be done via payment link
|
|
749
773
|
*/
|
|
750
774
|
/**
|
|
751
|
-
* @typedef
|
|
775
|
+
* @typedef CreatePaymentLinkRequest
|
|
752
776
|
* @property {string} email - Email to which the payment link is to be sent
|
|
753
777
|
* @property {number} amount - Total value of order
|
|
754
778
|
* @property {string} mobile_number - Mobile number to which the payment link is
|
|
@@ -757,13 +781,9 @@ export = PaymentPlatformModel;
|
|
|
757
781
|
* @property {string} [description] - Merchant order id
|
|
758
782
|
* @property {CreatePaymentLinkMeta} meta
|
|
759
783
|
* @property {string} external_order_id - Merchant order id
|
|
760
|
-
* @property {string} [success_redirection_url] - URL to which the user will be
|
|
761
|
-
* redirected after a successful payment.
|
|
762
|
-
* @property {string} [failure_redirection_url] - URL to which the user will be
|
|
763
|
-
* redirected if the payment fails.
|
|
764
784
|
*/
|
|
765
785
|
/**
|
|
766
|
-
* @typedef
|
|
786
|
+
* @typedef CreatePaymentLinkResponse
|
|
767
787
|
* @property {string} message - Message
|
|
768
788
|
* @property {number} status_code - HTTP status code
|
|
769
789
|
* @property {string} [payment_link_url] - Url of payment link
|
|
@@ -772,7 +792,7 @@ export = PaymentPlatformModel;
|
|
|
772
792
|
* @property {string} [payment_link_id] - Unique id of payment link
|
|
773
793
|
*/
|
|
774
794
|
/**
|
|
775
|
-
* @typedef
|
|
795
|
+
* @typedef PollingPaymentLinkResponse
|
|
776
796
|
* @property {string} [message] - Message
|
|
777
797
|
* @property {number} [http_status] - HTTP status code
|
|
778
798
|
* @property {number} [status_code] - HTTP status code
|
|
@@ -785,18 +805,18 @@ export = PaymentPlatformModel;
|
|
|
785
805
|
* @property {string} [aggregator_name] - Aggregator name
|
|
786
806
|
*/
|
|
787
807
|
/**
|
|
788
|
-
* @typedef
|
|
808
|
+
* @typedef CancelOrResendPaymentLinkRequest
|
|
789
809
|
* @property {string} payment_link_id - Unique id of payment link
|
|
790
810
|
*/
|
|
791
811
|
/**
|
|
792
|
-
* @typedef
|
|
812
|
+
* @typedef ResendPaymentLinkResponse
|
|
793
813
|
* @property {number} status_code - HTTP status code
|
|
794
814
|
* @property {string} message - Message
|
|
795
815
|
* @property {number} [polling_timeout] - Polling request timeout
|
|
796
816
|
* @property {boolean} success - Successful or failure
|
|
797
817
|
*/
|
|
798
818
|
/**
|
|
799
|
-
* @typedef
|
|
819
|
+
* @typedef CancelPaymentLinkResponse
|
|
800
820
|
* @property {number} status_code - HTTP status code
|
|
801
821
|
* @property {string} message - Message
|
|
802
822
|
* @property {boolean} success - Successful or failure
|
|
@@ -819,18 +839,18 @@ export = PaymentPlatformModel;
|
|
|
819
839
|
* @property {PaymentCode} method_code
|
|
820
840
|
*/
|
|
821
841
|
/**
|
|
822
|
-
* @typedef
|
|
842
|
+
* @typedef GetPaymentCodeResponse
|
|
823
843
|
* @property {GetPaymentCode} data
|
|
824
844
|
* @property {boolean} success - Response is successful or not.
|
|
825
845
|
*/
|
|
826
846
|
/**
|
|
827
|
-
* @typedef
|
|
847
|
+
* @typedef PlatformPaymentModeResponse
|
|
828
848
|
* @property {string} [message] - Message
|
|
829
849
|
* @property {Object[]} [items] - List of all aggregator and payment mode details.
|
|
830
850
|
* @property {boolean} success - Response is successful or not.
|
|
831
851
|
*/
|
|
832
852
|
/**
|
|
833
|
-
* @typedef
|
|
853
|
+
* @typedef MerchnatPaymentModeRequest
|
|
834
854
|
* @property {Object} [offline] - Details to be updated for online payment configuration.
|
|
835
855
|
* @property {Object} [online] - Details to be updated for offline payment configuration.
|
|
836
856
|
*/
|
|
@@ -880,7 +900,8 @@ export = PaymentPlatformModel;
|
|
|
880
900
|
* @property {AddressDetail} [shipping_address] - Shipping address
|
|
881
901
|
* @property {number} amount_captured - Amount which is captured or credited to
|
|
882
902
|
* merchant account
|
|
883
|
-
* @property {number} [amount_refunded]
|
|
903
|
+
* @property {number} [amount_refunded] - Amount refunded or credited back to
|
|
904
|
+
* customer accout
|
|
884
905
|
* @property {string} [aggregator_customer_id] - Unique customer id generated by
|
|
885
906
|
* payment gateway, not required for standard checkout.
|
|
886
907
|
* @property {string} cancel_url - Cancel url sent by Fynd platform at the time
|
|
@@ -902,12 +923,12 @@ export = PaymentPlatformModel;
|
|
|
902
923
|
* @property {AddressDetail} [billing_address] - Billing address
|
|
903
924
|
* @property {boolean} [captured] - Whether the payment is captured (credited to
|
|
904
925
|
* merchant account) by payment gateway.
|
|
905
|
-
* @property {Object} [meta] -
|
|
906
|
-
* @property {string} status -
|
|
926
|
+
* @property {Object} [meta] - Extra meta data specific to extension
|
|
927
|
+
* @property {string} status - Status of the payment
|
|
907
928
|
*/
|
|
908
929
|
/**
|
|
909
|
-
* @typedef
|
|
910
|
-
* @property {Object} [meta] -
|
|
930
|
+
* @typedef PaymentSessionRequestSerializer
|
|
931
|
+
* @property {Object} [meta] - Extra meta data specific to extensions
|
|
911
932
|
* @property {string} gid - Global identifier of the entity (e.g. order, cart
|
|
912
933
|
* etc.) against which payment_session was initiated. This is generated by
|
|
913
934
|
* Fynd payments platform and is unique.
|
|
@@ -918,9 +939,10 @@ export = PaymentPlatformModel;
|
|
|
918
939
|
* the schema `PaymentSessionDetail`.
|
|
919
940
|
* @property {number} total_amount - Amount paid.
|
|
920
941
|
* @property {string} checksum - Checksum to verify the payload
|
|
942
|
+
* @property {string} [source] - Source of payment update session
|
|
921
943
|
*/
|
|
922
944
|
/**
|
|
923
|
-
* @typedef
|
|
945
|
+
* @typedef PaymentSessionResponseSerializer
|
|
924
946
|
* @property {string} gid - Global identifier of the entity (e.g. order, cart
|
|
925
947
|
* etc.) against which payment_session was initiated. This is generated by
|
|
926
948
|
* Fynd payments platform and is unique.
|
|
@@ -949,7 +971,7 @@ export = PaymentPlatformModel;
|
|
|
949
971
|
* @property {string} [balance_transaction] - Balance transaction.
|
|
950
972
|
*/
|
|
951
973
|
/**
|
|
952
|
-
* @typedef
|
|
974
|
+
* @typedef RefundSessionRequestSerializer
|
|
953
975
|
* @property {Object} [meta] - Meta
|
|
954
976
|
* @property {string} gid - Global identifier of the entity (e.g. order, cart
|
|
955
977
|
* etc.) against which payment_session was initiated. This is generated by
|
|
@@ -964,7 +986,7 @@ export = PaymentPlatformModel;
|
|
|
964
986
|
* @property {string} checksum - Checksum to verify payload
|
|
965
987
|
*/
|
|
966
988
|
/**
|
|
967
|
-
* @typedef
|
|
989
|
+
* @typedef RefundSessionResponseSerializer
|
|
968
990
|
* @property {string} gid - Global identifier of the entity (e.g. order, cart
|
|
969
991
|
* etc.) against which payment_session was initiated. This is generated by
|
|
970
992
|
* Fynd payments platform and is unique.
|
|
@@ -974,41 +996,42 @@ export = PaymentPlatformModel;
|
|
|
974
996
|
* @property {number} total_refund_amount - The total amount refunded.
|
|
975
997
|
*/
|
|
976
998
|
/**
|
|
977
|
-
* @typedef
|
|
978
|
-
* @property {Object[]} payment_methods -
|
|
999
|
+
* @typedef PaymentDetailsSerializer
|
|
1000
|
+
* @property {Object[]} payment_methods - List of payment methods
|
|
979
1001
|
* @property {string} gid - Global identifier of the entity (e.g. order, cart
|
|
980
1002
|
* etc.) against which payment_session was initiated. This is generated by
|
|
981
1003
|
* Fynd payments platform and is unique.
|
|
982
|
-
* @property {number} [amount_refunded]
|
|
1004
|
+
* @property {number} [amount_refunded] - Already refunded amount for the given
|
|
1005
|
+
* gid (global identifier for the order).
|
|
983
1006
|
* @property {string} currency - Currency of the payment.
|
|
984
1007
|
* @property {string} mode - Test or live, test mode uses test credentials so
|
|
985
1008
|
* that actual payment is not created.
|
|
986
|
-
* @property {string} [merchant_locale] - Merchant's locale
|
|
987
|
-
* @property {Object} [meta] -
|
|
1009
|
+
* @property {string} [merchant_locale] - Merchant's locale (language) i.e. en
|
|
1010
|
+
* @property {Object} [meta] - Extra meta data related to the payment methods
|
|
988
1011
|
* @property {string} [kind] - Optional kind of purchase/payment - one time
|
|
989
1012
|
* payment (sale) or subcription. defaults to sale.
|
|
990
1013
|
* @property {string} [success_url] - Success url sent by Fynd platform at the
|
|
991
1014
|
* time of payment creation
|
|
992
|
-
* @property {string} status -
|
|
1015
|
+
* @property {string} status - Status of the payment
|
|
993
1016
|
* @property {boolean} [captured] - Whether the payment is captured (credited to
|
|
994
1017
|
* merchant account) by payment gateway.
|
|
995
1018
|
* @property {string} [payment_id] - Unique transaction id generated by payment gateway
|
|
996
1019
|
* @property {string} g_user_id - Global user identifier - unique user id
|
|
997
1020
|
* generated by Fynd platform
|
|
998
|
-
* @property {string} [locale] - User's locale
|
|
1021
|
+
* @property {string} [locale] - User's locale (language), i.e. en
|
|
999
1022
|
* @property {string} [cancel_url] - Cancel url sent by Fynd platform at the
|
|
1000
|
-
* time of payment creation
|
|
1023
|
+
* time of payment creation, redirect on payment cancellation
|
|
1001
1024
|
* @property {string} [created] - Timestamp in epoch
|
|
1002
1025
|
* @property {number} amount_captured - Amount which is captured or credited to
|
|
1003
1026
|
* merchant account
|
|
1004
|
-
* @property {number} amount - Amount paid.
|
|
1027
|
+
* @property {number} amount - Amount paid for the order.
|
|
1005
1028
|
* @property {string} [aggregator_customer_id] - Unique customer id generated by
|
|
1006
1029
|
* payment gateway, not required for standard checkout.
|
|
1007
1030
|
* @property {string} [aggregator_order_id] - Unique order id or payment request
|
|
1008
1031
|
* id generated by payment gateway
|
|
1009
1032
|
*/
|
|
1010
1033
|
/**
|
|
1011
|
-
* @typedef
|
|
1034
|
+
* @typedef CartDetailsSerializer
|
|
1012
1035
|
* @property {Object} items - Items that are added in cart
|
|
1013
1036
|
* @property {Object[]} articles - List of articles that are added in cart
|
|
1014
1037
|
* @property {number} cart_value - Total cart value i.e. amount to be paid
|
|
@@ -1017,7 +1040,7 @@ export = PaymentPlatformModel;
|
|
|
1017
1040
|
* retrieve custom data fields to cart items.
|
|
1018
1041
|
*/
|
|
1019
1042
|
/**
|
|
1020
|
-
* @typedef
|
|
1043
|
+
* @typedef RefundDetailsSerializer
|
|
1021
1044
|
* @property {number} amount - Refunded amount
|
|
1022
1045
|
* @property {string} currency - The currency of the payment.
|
|
1023
1046
|
* @property {string} request_id - Refund request id, unique id generated by Fynd platform
|
|
@@ -1026,7 +1049,7 @@ export = PaymentPlatformModel;
|
|
|
1026
1049
|
* @property {string} refund_utr - Unique refund utr generated by payment gateway.
|
|
1027
1050
|
*/
|
|
1028
1051
|
/**
|
|
1029
|
-
* @typedef
|
|
1052
|
+
* @typedef PaymentSessionSerializer
|
|
1030
1053
|
* @property {Object} payment_details - Object of payment details
|
|
1031
1054
|
* @property {string} [currency] - The currency of the payment.
|
|
1032
1055
|
* @property {string} status - The status of the payment session.
|
|
@@ -1034,8 +1057,8 @@ export = PaymentPlatformModel;
|
|
|
1034
1057
|
* @property {string} gid - Global identifier of the entity (e.g. order, cart
|
|
1035
1058
|
* etc.) against which payment_session was initiated. This is generated by
|
|
1036
1059
|
* Fynd payments platform and is unique.
|
|
1037
|
-
* @property {
|
|
1038
|
-
* @property {
|
|
1060
|
+
* @property {CartDetailsSerializer} [cart_details]
|
|
1061
|
+
* @property {RefundDetailsSerializer[]} refund_details - Object of refund details
|
|
1039
1062
|
*/
|
|
1040
1063
|
/**
|
|
1041
1064
|
* @typedef RefundSourcesPriority
|
|
@@ -1044,7 +1067,7 @@ export = PaymentPlatformModel;
|
|
|
1044
1067
|
* @property {string} source - Source of refund
|
|
1045
1068
|
*/
|
|
1046
1069
|
/**
|
|
1047
|
-
* @typedef
|
|
1070
|
+
* @typedef RefundPriorityResponseSerializer
|
|
1048
1071
|
* @property {string} configuration - Configuration for merchant or customer
|
|
1049
1072
|
* @property {boolean} success - Success
|
|
1050
1073
|
* @property {boolean} apportion - Apportion refund to multiple sources
|
|
@@ -1052,12 +1075,12 @@ export = PaymentPlatformModel;
|
|
|
1052
1075
|
* @property {string} [message] - Message
|
|
1053
1076
|
*/
|
|
1054
1077
|
/**
|
|
1055
|
-
* @typedef
|
|
1078
|
+
* @typedef RefundPriorityRequestSerializer
|
|
1056
1079
|
* @property {boolean} apportion - Apportion refund to multiple sources
|
|
1057
1080
|
* @property {RefundSourcesPriority[]} refund_sources_priority - Refund sources priority
|
|
1058
1081
|
*/
|
|
1059
1082
|
/**
|
|
1060
|
-
* @typedef
|
|
1083
|
+
* @typedef MerchantPaymentModeRequest
|
|
1061
1084
|
* @property {string} business_unit - Business unit
|
|
1062
1085
|
* @property {Object[]} items - List of item details with respect to payment_mode
|
|
1063
1086
|
* @property {Object} device - List of devices and its activation status
|
|
@@ -1073,7 +1096,7 @@ export = PaymentPlatformModel;
|
|
|
1073
1096
|
* @property {string} business_unit - Business unit name
|
|
1074
1097
|
*/
|
|
1075
1098
|
/**
|
|
1076
|
-
* @typedef
|
|
1099
|
+
* @typedef PlatformPaymentModeCopyConfigRequest
|
|
1077
1100
|
* @property {FromConfig} from_config
|
|
1078
1101
|
* @property {ToConfig} to_config
|
|
1079
1102
|
*/
|
|
@@ -1092,7 +1115,7 @@ export = PaymentPlatformModel;
|
|
|
1092
1115
|
* @property {string} name - Payment mode name
|
|
1093
1116
|
*/
|
|
1094
1117
|
/**
|
|
1095
|
-
* @typedef
|
|
1118
|
+
* @typedef PaymentOrderRequest
|
|
1096
1119
|
* @property {string} order_id - Order id
|
|
1097
1120
|
* @property {PaymentOrderMethods[]} [payment_methods]
|
|
1098
1121
|
* @property {string} [shipment_id] - Shipment_id
|
|
@@ -1111,7 +1134,7 @@ export = PaymentPlatformModel;
|
|
|
1111
1134
|
* @property {string} [merchant_order_id] - Merchant order id
|
|
1112
1135
|
*/
|
|
1113
1136
|
/**
|
|
1114
|
-
* @typedef
|
|
1137
|
+
* @typedef PaymentOrderResponse
|
|
1115
1138
|
* @property {string} message - Message
|
|
1116
1139
|
* @property {boolean} success - Successful or failure
|
|
1117
1140
|
* @property {string} [payment_confirm_url] - Payment confirm url for aggregator
|
|
@@ -1127,7 +1150,7 @@ export = PaymentPlatformModel;
|
|
|
1127
1150
|
* @property {string} [is_greater_than]
|
|
1128
1151
|
*/
|
|
1129
1152
|
/**
|
|
1130
|
-
* @typedef
|
|
1153
|
+
* @typedef AggregatorVersionResponse
|
|
1131
1154
|
* @property {string} message - Message
|
|
1132
1155
|
* @property {boolean} success - Successful or failure
|
|
1133
1156
|
* @property {AggregatorVersionItemSchema} [items]
|
|
@@ -1139,7 +1162,7 @@ export = PaymentPlatformModel;
|
|
|
1139
1162
|
* @property {string} [is_greater_than]
|
|
1140
1163
|
*/
|
|
1141
1164
|
/**
|
|
1142
|
-
* @typedef
|
|
1165
|
+
* @typedef AggregatorControlRequest
|
|
1143
1166
|
* @property {string} [business_unit] - Business unit
|
|
1144
1167
|
* @property {Object[]} [items] - List of item details with respect to payment_mode
|
|
1145
1168
|
* @property {string} [device] - Device name
|
|
@@ -1194,14 +1217,14 @@ export = PaymentPlatformModel;
|
|
|
1194
1217
|
declare class PaymentPlatformModel {
|
|
1195
1218
|
}
|
|
1196
1219
|
declare namespace PaymentPlatformModel {
|
|
1197
|
-
export {
|
|
1220
|
+
export { PaymentGatewayConfigResponse, ErrorCodeDescription, PaymentGatewayConfig, PaymentGatewayConfigRequest, PaymentGatewayToBeReviewed, ErrorCodeAndDescription, HttpErrorCodeAndResponse, IntentAppErrorList, ProductCODData, CODChargesLimitsResponse, PaymentModeLogo, IntentApp, PaymentModeList, RootPaymentMode, PaymentOptions, AggregatorRoute, PaymentDefaultSelection, PaymentFlow, PaymentOptionAndFlow, AdvanceObject, SplitObject, AdvancePaymentObject, PaymentModeRouteResponse, PaymentOptionsResponse, PayoutCustomer, PayoutMoreAttributes, PayoutAggregator, Payout, PayoutsResponse, PayoutBankDetails, PayoutRequest, PayoutResponse, UpdatePayoutResponse, UpdatePayoutRequest, DeletePayoutResponse, SubscriptionPaymentMethodResponse, DeleteSubscriptionPaymentMethodResponse, SubscriptionConfigResponse, SaveSubscriptionSetupIntentRequest, SaveSubscriptionSetupIntentResponse, RefundAccountResponse, NotFoundResourceError, BankDetailsForOTP, AddBeneficiaryDetailsOTPRequest, IfscCodeResponse, OrderBeneficiaryDetails, OrderBeneficiaryResponse, MultiTenderPaymentMeta, MultiTenderPaymentMethod, PaymentConfirmationRequest, PaymentConfirmationResponse, CODdata, CODLimitConfig, CODPaymentLimitConfig, GetUserBULimitResponse, GetUserCODLimitResponse, SetCODForUserRequest, SetCODOptionResponse, EdcModelData, EdcAggregatorAndModelListResponse, StatisticsData, EdcDeviceStatsResponse, EdcAddRequest, EdcDevice, EdcDeviceAddResponse, EdcDeviceDetailsResponse, EdcUpdateRequest, EdcDeviceUpdateResponse, Page, EdcDeviceListResponse, PaymentInitializationRequest, PaymentInitializationResponse, PaymentStatusUpdateRequest, PaymentStatusUpdateResponse, ResendOrCancelPaymentRequest, LinkStatus, ResendOrCancelPaymentResponse, PaymentStatusBulkHandlerRequest, PaymentObjectListSerializer, PaymentStatusObject, PaymentStatusBulkHandlerResponse, GetOauthUrlResponse, RevokeOAuthToken, RepaymentRequestDetails, RepaymentDetailsSerialiserPayAll, RepaymentResponse, MerchantOnBoardingRequest, MerchantOnBoardingResponse, ValidateCustomerRequest, ValidateCustomerResponse, GetPaymentLinkResponse, ErrorDescription, ErrorResponse, CreatePaymentLinkMeta, CreatePaymentLinkRequest, CreatePaymentLinkResponse, PollingPaymentLinkResponse, CancelOrResendPaymentLinkRequest, ResendPaymentLinkResponse, CancelPaymentLinkResponse, Code, PaymentCode, GetPaymentCode, GetPaymentCodeResponse, PlatformPaymentModeResponse, MerchnatPaymentModeRequest, OrderDetail, AddressDetail, PaymentSessionDetail, PaymentSessionRequestSerializer, PaymentSessionResponseSerializer, RefundSessionDetail, RefundSessionRequestSerializer, RefundSessionResponseSerializer, PaymentDetailsSerializer, CartDetailsSerializer, RefundDetailsSerializer, PaymentSessionSerializer, RefundSourcesPriority, RefundPriorityResponseSerializer, RefundPriorityRequestSerializer, MerchantPaymentModeRequest, FromConfig, ToConfig, PlatformPaymentModeCopyConfigRequest, PaymentMethodsMetaOrder, PaymentOrderMethods, PaymentOrderRequest, PaymentOrderData, PaymentOrderResponse, AggregatorVersionItemSchema, AggregatorVersionResponse, AggregatorVersionRequestSchema, AggregatorControlRequest, PaymentModeCustomConfigSchema, PaymentCustomConfigDetailsSchema, PaymentCustomConfigCustomerSchema, PaymentCustomConfigModeSchema, PaymentCustomConfigDetailsRequestSchema, PaymentCustomConfigCustomerRequestSchema, PaymentCustomConfigRequestSchema, PaymentCustomConfigResponseSchema };
|
|
1198
1221
|
}
|
|
1199
|
-
/** @returns {
|
|
1200
|
-
declare function
|
|
1201
|
-
type
|
|
1222
|
+
/** @returns {PaymentGatewayConfigResponse} */
|
|
1223
|
+
declare function PaymentGatewayConfigResponse(): PaymentGatewayConfigResponse;
|
|
1224
|
+
type PaymentGatewayConfigResponse = {
|
|
1202
1225
|
/**
|
|
1203
|
-
* - List of all
|
|
1204
|
-
* with their Details.
|
|
1226
|
+
* - List of all config specific to the
|
|
1227
|
+
* aggregator with their Details.
|
|
1205
1228
|
*/
|
|
1206
1229
|
aggregators?: any[];
|
|
1207
1230
|
/**
|
|
@@ -1209,7 +1232,7 @@ type PaymentGatewayConfigDetails = {
|
|
|
1209
1232
|
*/
|
|
1210
1233
|
app_id: string;
|
|
1211
1234
|
/**
|
|
1212
|
-
* - List of all excluded
|
|
1235
|
+
* - List of all excluded config with their Details.
|
|
1213
1236
|
*/
|
|
1214
1237
|
excluded_fields: string[];
|
|
1215
1238
|
/**
|
|
@@ -1221,7 +1244,7 @@ type PaymentGatewayConfigDetails = {
|
|
|
1221
1244
|
*/
|
|
1222
1245
|
created: boolean;
|
|
1223
1246
|
/**
|
|
1224
|
-
* - List of all
|
|
1247
|
+
* - List of all display related configs, i.e. logo
|
|
1225
1248
|
*/
|
|
1226
1249
|
display_fields: string[];
|
|
1227
1250
|
};
|
|
@@ -1261,13 +1284,14 @@ type PaymentGatewayConfig = {
|
|
|
1261
1284
|
*/
|
|
1262
1285
|
key: string;
|
|
1263
1286
|
/**
|
|
1264
|
-
* -
|
|
1287
|
+
* - The secret key or token provided by the
|
|
1288
|
+
* payment aggregator for the merchant.
|
|
1265
1289
|
*/
|
|
1266
1290
|
merchant_salt: string;
|
|
1267
1291
|
};
|
|
1268
|
-
/** @returns {
|
|
1269
|
-
declare function
|
|
1270
|
-
type
|
|
1292
|
+
/** @returns {PaymentGatewayConfigRequest} */
|
|
1293
|
+
declare function PaymentGatewayConfigRequest(): PaymentGatewayConfigRequest;
|
|
1294
|
+
type PaymentGatewayConfigRequest = {
|
|
1271
1295
|
/**
|
|
1272
1296
|
* - Application Id to which Payment config Mapped
|
|
1273
1297
|
*/
|
|
@@ -1302,9 +1326,9 @@ type ErrorCodeAndDescription = {
|
|
|
1302
1326
|
*/
|
|
1303
1327
|
code: string;
|
|
1304
1328
|
};
|
|
1305
|
-
/** @returns {
|
|
1306
|
-
declare function
|
|
1307
|
-
type
|
|
1329
|
+
/** @returns {HttpErrorCodeAndResponse} */
|
|
1330
|
+
declare function HttpErrorCodeAndResponse(): HttpErrorCodeAndResponse;
|
|
1331
|
+
type HttpErrorCodeAndResponse = {
|
|
1308
1332
|
error: ErrorCodeAndDescription;
|
|
1309
1333
|
/**
|
|
1310
1334
|
* - Response is successful or not
|
|
@@ -1330,11 +1354,11 @@ type ProductCODData = {
|
|
|
1330
1354
|
* - Item id with its cod availability.
|
|
1331
1355
|
*/
|
|
1332
1356
|
items?: any;
|
|
1333
|
-
cod_charges?:
|
|
1357
|
+
cod_charges?: CODChargesLimitsResponse;
|
|
1334
1358
|
};
|
|
1335
|
-
/** @returns {
|
|
1336
|
-
declare function
|
|
1337
|
-
type
|
|
1359
|
+
/** @returns {CODChargesLimitsResponse} */
|
|
1360
|
+
declare function CODChargesLimitsResponse(): CODChargesLimitsResponse;
|
|
1361
|
+
type CODChargesLimitsResponse = {
|
|
1338
1362
|
/**
|
|
1339
1363
|
* - Max allowed cart value for cod order.
|
|
1340
1364
|
*/
|
|
@@ -1627,7 +1651,7 @@ type PaymentOptionAndFlow = {
|
|
|
1627
1651
|
* - Payment options
|
|
1628
1652
|
*/
|
|
1629
1653
|
payment_option: RootPaymentMode[];
|
|
1630
|
-
payment_flows
|
|
1654
|
+
payment_flows?: PaymentFlow;
|
|
1631
1655
|
payment_default_selection?: PaymentDefaultSelection;
|
|
1632
1656
|
};
|
|
1633
1657
|
/** @returns {AdvanceObject} */
|
|
@@ -1721,9 +1745,9 @@ type AdvancePaymentObject = {
|
|
|
1721
1745
|
split?: SplitObject;
|
|
1722
1746
|
advance?: AdvanceObject;
|
|
1723
1747
|
};
|
|
1724
|
-
/** @returns {
|
|
1725
|
-
declare function
|
|
1726
|
-
type
|
|
1748
|
+
/** @returns {PaymentModeRouteResponse} */
|
|
1749
|
+
declare function PaymentModeRouteResponse(): PaymentModeRouteResponse;
|
|
1750
|
+
type PaymentModeRouteResponse = {
|
|
1727
1751
|
payment_options: PaymentOptionAndFlow;
|
|
1728
1752
|
/**
|
|
1729
1753
|
* - Response is successful or not
|
|
@@ -1738,9 +1762,9 @@ type PaymentModeRouteDetails = {
|
|
|
1738
1762
|
*/
|
|
1739
1763
|
advance_payment?: AdvancePaymentObject[];
|
|
1740
1764
|
};
|
|
1741
|
-
/** @returns {
|
|
1742
|
-
declare function
|
|
1743
|
-
type
|
|
1765
|
+
/** @returns {PaymentOptionsResponse} */
|
|
1766
|
+
declare function PaymentOptionsResponse(): PaymentOptionsResponse;
|
|
1767
|
+
type PaymentOptionsResponse = {
|
|
1744
1768
|
payment_options: PaymentOptions;
|
|
1745
1769
|
/**
|
|
1746
1770
|
* - Response is successful or not
|
|
@@ -1854,9 +1878,9 @@ type Payout = {
|
|
|
1854
1878
|
*/
|
|
1855
1879
|
transfer_type: string;
|
|
1856
1880
|
};
|
|
1857
|
-
/** @returns {
|
|
1858
|
-
declare function
|
|
1859
|
-
type
|
|
1881
|
+
/** @returns {PayoutsResponse} */
|
|
1882
|
+
declare function PayoutsResponse(): PayoutsResponse;
|
|
1883
|
+
type PayoutsResponse = {
|
|
1860
1884
|
/**
|
|
1861
1885
|
* - Response is successful or not
|
|
1862
1886
|
*/
|
|
@@ -1880,9 +1904,9 @@ type PayoutBankDetails = {
|
|
|
1880
1904
|
branch_name?: string;
|
|
1881
1905
|
pincode?: number;
|
|
1882
1906
|
};
|
|
1883
|
-
/** @returns {
|
|
1884
|
-
declare function
|
|
1885
|
-
type
|
|
1907
|
+
/** @returns {PayoutRequest} */
|
|
1908
|
+
declare function PayoutRequest(): PayoutRequest;
|
|
1909
|
+
type PayoutRequest = {
|
|
1886
1910
|
/**
|
|
1887
1911
|
* - Aggregator Name
|
|
1888
1912
|
*/
|
|
@@ -1905,9 +1929,9 @@ type PayoutCreation = {
|
|
|
1905
1929
|
*/
|
|
1906
1930
|
transfer_type: string;
|
|
1907
1931
|
};
|
|
1908
|
-
/** @returns {
|
|
1909
|
-
declare function
|
|
1910
|
-
type
|
|
1932
|
+
/** @returns {PayoutResponse} */
|
|
1933
|
+
declare function PayoutResponse(): PayoutResponse;
|
|
1934
|
+
type PayoutResponse = {
|
|
1911
1935
|
/**
|
|
1912
1936
|
* - Status of payment
|
|
1913
1937
|
*/
|
|
@@ -1949,9 +1973,9 @@ type PayoutDetails = {
|
|
|
1949
1973
|
*/
|
|
1950
1974
|
payouts: any;
|
|
1951
1975
|
};
|
|
1952
|
-
/** @returns {
|
|
1953
|
-
declare function
|
|
1954
|
-
type
|
|
1976
|
+
/** @returns {UpdatePayoutResponse} */
|
|
1977
|
+
declare function UpdatePayoutResponse(): UpdatePayoutResponse;
|
|
1978
|
+
type UpdatePayoutResponse = {
|
|
1955
1979
|
/**
|
|
1956
1980
|
* - Enable or Disable Default Payout
|
|
1957
1981
|
*/
|
|
@@ -1965,9 +1989,9 @@ type UpdatePayoutDetails = {
|
|
|
1965
1989
|
*/
|
|
1966
1990
|
success: boolean;
|
|
1967
1991
|
};
|
|
1968
|
-
/** @returns {
|
|
1969
|
-
declare function
|
|
1970
|
-
type
|
|
1992
|
+
/** @returns {UpdatePayoutRequest} */
|
|
1993
|
+
declare function UpdatePayoutRequest(): UpdatePayoutRequest;
|
|
1994
|
+
type UpdatePayoutRequest = {
|
|
1971
1995
|
/**
|
|
1972
1996
|
* - Enable or Disable Default Payout
|
|
1973
1997
|
*/
|
|
@@ -1981,17 +2005,17 @@ type UpdatePayoutCreation = {
|
|
|
1981
2005
|
*/
|
|
1982
2006
|
unique_external_id: string;
|
|
1983
2007
|
};
|
|
1984
|
-
/** @returns {
|
|
1985
|
-
declare function
|
|
1986
|
-
type
|
|
2008
|
+
/** @returns {DeletePayoutResponse} */
|
|
2009
|
+
declare function DeletePayoutResponse(): DeletePayoutResponse;
|
|
2010
|
+
type DeletePayoutResponse = {
|
|
1987
2011
|
/**
|
|
1988
2012
|
* - Response is successful or not
|
|
1989
2013
|
*/
|
|
1990
2014
|
success: boolean;
|
|
1991
2015
|
};
|
|
1992
|
-
/** @returns {
|
|
1993
|
-
declare function
|
|
1994
|
-
type
|
|
2016
|
+
/** @returns {SubscriptionPaymentMethodResponse} */
|
|
2017
|
+
declare function SubscriptionPaymentMethodResponse(): SubscriptionPaymentMethodResponse;
|
|
2018
|
+
type SubscriptionPaymentMethodResponse = {
|
|
1995
2019
|
/**
|
|
1996
2020
|
* - Subscription Payment Method Object
|
|
1997
2021
|
*/
|
|
@@ -2001,17 +2025,17 @@ type SubscriptionPaymentMethodDetails = {
|
|
|
2001
2025
|
*/
|
|
2002
2026
|
success: boolean;
|
|
2003
2027
|
};
|
|
2004
|
-
/** @returns {
|
|
2005
|
-
declare function
|
|
2006
|
-
type
|
|
2028
|
+
/** @returns {DeleteSubscriptionPaymentMethodResponse} */
|
|
2029
|
+
declare function DeleteSubscriptionPaymentMethodResponse(): DeleteSubscriptionPaymentMethodResponse;
|
|
2030
|
+
type DeleteSubscriptionPaymentMethodResponse = {
|
|
2007
2031
|
/**
|
|
2008
2032
|
* - Success or failure.
|
|
2009
2033
|
*/
|
|
2010
2034
|
success: boolean;
|
|
2011
2035
|
};
|
|
2012
|
-
/** @returns {
|
|
2013
|
-
declare function
|
|
2014
|
-
type
|
|
2036
|
+
/** @returns {SubscriptionConfigResponse} */
|
|
2037
|
+
declare function SubscriptionConfigResponse(): SubscriptionConfigResponse;
|
|
2038
|
+
type SubscriptionConfigResponse = {
|
|
2015
2039
|
/**
|
|
2016
2040
|
* - Aggregator Name
|
|
2017
2041
|
*/
|
|
@@ -2025,17 +2049,17 @@ type SubscriptionConfigDetails = {
|
|
|
2025
2049
|
*/
|
|
2026
2050
|
success: boolean;
|
|
2027
2051
|
};
|
|
2028
|
-
/** @returns {
|
|
2029
|
-
declare function
|
|
2030
|
-
type
|
|
2052
|
+
/** @returns {SaveSubscriptionSetupIntentRequest} */
|
|
2053
|
+
declare function SaveSubscriptionSetupIntentRequest(): SaveSubscriptionSetupIntentRequest;
|
|
2054
|
+
type SaveSubscriptionSetupIntentRequest = {
|
|
2031
2055
|
/**
|
|
2032
2056
|
* - Unique id i.e company:id
|
|
2033
2057
|
*/
|
|
2034
2058
|
unique_external_id: string;
|
|
2035
2059
|
};
|
|
2036
|
-
/** @returns {
|
|
2037
|
-
declare function
|
|
2038
|
-
type
|
|
2060
|
+
/** @returns {SaveSubscriptionSetupIntentResponse} */
|
|
2061
|
+
declare function SaveSubscriptionSetupIntentResponse(): SaveSubscriptionSetupIntentResponse;
|
|
2062
|
+
type SaveSubscriptionSetupIntentResponse = {
|
|
2039
2063
|
/**
|
|
2040
2064
|
* - Subscription Payment Method Object
|
|
2041
2065
|
*/
|
|
@@ -2045,18 +2069,21 @@ type SaveSubscriptionSetupIntentDetails = {
|
|
|
2045
2069
|
*/
|
|
2046
2070
|
success: boolean;
|
|
2047
2071
|
};
|
|
2048
|
-
/** @returns {
|
|
2049
|
-
declare function
|
|
2050
|
-
type
|
|
2072
|
+
/** @returns {RefundAccountResponse} */
|
|
2073
|
+
declare function RefundAccountResponse(): RefundAccountResponse;
|
|
2074
|
+
type RefundAccountResponse = {
|
|
2075
|
+
/**
|
|
2076
|
+
* - Account is verified or not
|
|
2077
|
+
*/
|
|
2051
2078
|
is_verified_flag?: boolean;
|
|
2052
2079
|
/**
|
|
2053
2080
|
* - Response message
|
|
2054
2081
|
*/
|
|
2055
|
-
message
|
|
2082
|
+
message?: string;
|
|
2056
2083
|
/**
|
|
2057
2084
|
* - Refund account data.
|
|
2058
2085
|
*/
|
|
2059
|
-
data
|
|
2086
|
+
data: any;
|
|
2060
2087
|
/**
|
|
2061
2088
|
* - Success or failure flag.
|
|
2062
2089
|
*/
|
|
@@ -2081,21 +2108,39 @@ type NotFoundResourceError = {
|
|
|
2081
2108
|
/** @returns {BankDetailsForOTP} */
|
|
2082
2109
|
declare function BankDetailsForOTP(): BankDetailsForOTP;
|
|
2083
2110
|
type BankDetailsForOTP = {
|
|
2111
|
+
/**
|
|
2112
|
+
* - IFSC code of account
|
|
2113
|
+
*/
|
|
2084
2114
|
ifsc_code: string;
|
|
2115
|
+
/**
|
|
2116
|
+
* - Account number
|
|
2117
|
+
*/
|
|
2085
2118
|
account_no: string;
|
|
2119
|
+
/**
|
|
2120
|
+
* - Branch name of account
|
|
2121
|
+
*/
|
|
2086
2122
|
branch_name: string;
|
|
2123
|
+
/**
|
|
2124
|
+
* - Bank name of account
|
|
2125
|
+
*/
|
|
2087
2126
|
bank_name: string;
|
|
2127
|
+
/**
|
|
2128
|
+
* - Accountg holder name of account
|
|
2129
|
+
*/
|
|
2088
2130
|
account_holder: string;
|
|
2089
2131
|
};
|
|
2090
|
-
/** @returns {
|
|
2091
|
-
declare function
|
|
2092
|
-
type
|
|
2132
|
+
/** @returns {AddBeneficiaryDetailsOTPRequest} */
|
|
2133
|
+
declare function AddBeneficiaryDetailsOTPRequest(): AddBeneficiaryDetailsOTPRequest;
|
|
2134
|
+
type AddBeneficiaryDetailsOTPRequest = {
|
|
2135
|
+
/**
|
|
2136
|
+
* - Order_id for which account will be added
|
|
2137
|
+
*/
|
|
2093
2138
|
order_id: string;
|
|
2094
2139
|
details: BankDetailsForOTP;
|
|
2095
2140
|
};
|
|
2096
|
-
/** @returns {
|
|
2097
|
-
declare function
|
|
2098
|
-
type
|
|
2141
|
+
/** @returns {IfscCodeResponse} */
|
|
2142
|
+
declare function IfscCodeResponse(): IfscCodeResponse;
|
|
2143
|
+
type IfscCodeResponse = {
|
|
2099
2144
|
/**
|
|
2100
2145
|
* - Branch Name Of Account
|
|
2101
2146
|
*/
|
|
@@ -2153,7 +2198,7 @@ type OrderBeneficiaryDetails = {
|
|
|
2153
2198
|
*/
|
|
2154
2199
|
transfer_mode: string;
|
|
2155
2200
|
/**
|
|
2156
|
-
* -
|
|
2201
|
+
* - Email of User
|
|
2157
2202
|
*/
|
|
2158
2203
|
email: string;
|
|
2159
2204
|
/**
|
|
@@ -2169,7 +2214,7 @@ type OrderBeneficiaryDetails = {
|
|
|
2169
2214
|
*/
|
|
2170
2215
|
address: string;
|
|
2171
2216
|
/**
|
|
2172
|
-
* -
|
|
2217
|
+
* - Modification Date of Beneficiary
|
|
2173
2218
|
*/
|
|
2174
2219
|
modified_on: string;
|
|
2175
2220
|
/**
|
|
@@ -2189,9 +2234,9 @@ type OrderBeneficiaryDetails = {
|
|
|
2189
2234
|
*/
|
|
2190
2235
|
mobile?: string;
|
|
2191
2236
|
};
|
|
2192
|
-
/** @returns {
|
|
2193
|
-
declare function
|
|
2194
|
-
type
|
|
2237
|
+
/** @returns {OrderBeneficiaryResponse} */
|
|
2238
|
+
declare function OrderBeneficiaryResponse(): OrderBeneficiaryResponse;
|
|
2239
|
+
type OrderBeneficiaryResponse = {
|
|
2195
2240
|
/**
|
|
2196
2241
|
* - All Beneficiaries Of An Order
|
|
2197
2242
|
*/
|
|
@@ -2204,6 +2249,9 @@ type OrderBeneficiaryFetchResults = {
|
|
|
2204
2249
|
/** @returns {MultiTenderPaymentMeta} */
|
|
2205
2250
|
declare function MultiTenderPaymentMeta(): MultiTenderPaymentMeta;
|
|
2206
2251
|
type MultiTenderPaymentMeta = {
|
|
2252
|
+
/**
|
|
2253
|
+
* - Key value pair for extra data related to payment mode
|
|
2254
|
+
*/
|
|
2207
2255
|
extra_meta?: any;
|
|
2208
2256
|
/**
|
|
2209
2257
|
* - Fynd Platform order ID
|
|
@@ -2243,20 +2291,23 @@ type MultiTenderPaymentMethod = {
|
|
|
2243
2291
|
* - Payment amount
|
|
2244
2292
|
*/
|
|
2245
2293
|
amount: number;
|
|
2294
|
+
/**
|
|
2295
|
+
* - Payment mode short code
|
|
2296
|
+
*/
|
|
2246
2297
|
mode: string;
|
|
2247
2298
|
};
|
|
2248
|
-
/** @returns {
|
|
2249
|
-
declare function
|
|
2250
|
-
type
|
|
2299
|
+
/** @returns {PaymentConfirmationRequest} */
|
|
2300
|
+
declare function PaymentConfirmationRequest(): PaymentConfirmationRequest;
|
|
2301
|
+
type PaymentConfirmationRequest = {
|
|
2251
2302
|
/**
|
|
2252
2303
|
* - Unique order id
|
|
2253
2304
|
*/
|
|
2254
2305
|
order_id: string;
|
|
2255
2306
|
payment_methods: MultiTenderPaymentMethod[];
|
|
2256
2307
|
};
|
|
2257
|
-
/** @returns {
|
|
2258
|
-
declare function
|
|
2259
|
-
type
|
|
2308
|
+
/** @returns {PaymentConfirmationResponse} */
|
|
2309
|
+
declare function PaymentConfirmationResponse(): PaymentConfirmationResponse;
|
|
2310
|
+
type PaymentConfirmationResponse = {
|
|
2260
2311
|
/**
|
|
2261
2312
|
* - Unique order id
|
|
2262
2313
|
*/
|
|
@@ -2294,18 +2345,72 @@ type CODdata = {
|
|
|
2294
2345
|
*/
|
|
2295
2346
|
usages: number;
|
|
2296
2347
|
};
|
|
2297
|
-
/** @returns {
|
|
2298
|
-
declare function
|
|
2299
|
-
type
|
|
2300
|
-
|
|
2348
|
+
/** @returns {CODLimitConfig} */
|
|
2349
|
+
declare function CODLimitConfig(): CODLimitConfig;
|
|
2350
|
+
type CODLimitConfig = {
|
|
2351
|
+
/**
|
|
2352
|
+
* - Limit for storefront
|
|
2353
|
+
*/
|
|
2354
|
+
storefront: number;
|
|
2355
|
+
/**
|
|
2356
|
+
* - Limit for pos
|
|
2357
|
+
*/
|
|
2358
|
+
pos: number;
|
|
2359
|
+
};
|
|
2360
|
+
/** @returns {CODPaymentLimitConfig} */
|
|
2361
|
+
declare function CODPaymentLimitConfig(): CODPaymentLimitConfig;
|
|
2362
|
+
type CODPaymentLimitConfig = {
|
|
2363
|
+
/**
|
|
2364
|
+
* - Boolean flag to show the status
|
|
2365
|
+
*/
|
|
2366
|
+
is_active: boolean;
|
|
2367
|
+
/**
|
|
2368
|
+
* - Used cod limit
|
|
2369
|
+
*/
|
|
2370
|
+
usages: number;
|
|
2371
|
+
/**
|
|
2372
|
+
* - User_id
|
|
2373
|
+
*/
|
|
2374
|
+
user_id: number;
|
|
2375
|
+
/**
|
|
2376
|
+
* - Merchant_user_id
|
|
2377
|
+
*/
|
|
2378
|
+
merchant_user_id: string;
|
|
2379
|
+
/**
|
|
2380
|
+
* - Remaining COD limit
|
|
2381
|
+
*/
|
|
2382
|
+
remaining_limit: number;
|
|
2383
|
+
limit: CODLimitConfig;
|
|
2384
|
+
};
|
|
2385
|
+
/** @returns {GetUserBULimitResponse} */
|
|
2386
|
+
declare function GetUserBULimitResponse(): GetUserBULimitResponse;
|
|
2387
|
+
type GetUserBULimitResponse = {
|
|
2388
|
+
/**
|
|
2389
|
+
* - COD limit business unit
|
|
2390
|
+
*/
|
|
2391
|
+
business_unit: string;
|
|
2392
|
+
/**
|
|
2393
|
+
* - Display name for cod limit
|
|
2394
|
+
*/
|
|
2395
|
+
display_name: string;
|
|
2396
|
+
config: CODPaymentLimitConfig;
|
|
2397
|
+
};
|
|
2398
|
+
/** @returns {GetUserCODLimitResponse} */
|
|
2399
|
+
declare function GetUserCODLimitResponse(): GetUserCODLimitResponse;
|
|
2400
|
+
type GetUserCODLimitResponse = {
|
|
2401
|
+
items: GetUserBULimitResponse[];
|
|
2301
2402
|
/**
|
|
2302
2403
|
* - Response is successful or not
|
|
2303
2404
|
*/
|
|
2304
2405
|
success: boolean;
|
|
2406
|
+
/**
|
|
2407
|
+
* - Message for cod limit
|
|
2408
|
+
*/
|
|
2409
|
+
message?: string;
|
|
2305
2410
|
};
|
|
2306
|
-
/** @returns {
|
|
2307
|
-
declare function
|
|
2308
|
-
type
|
|
2411
|
+
/** @returns {SetCODForUserRequest} */
|
|
2412
|
+
declare function SetCODForUserRequest(): SetCODForUserRequest;
|
|
2413
|
+
type SetCODForUserRequest = {
|
|
2309
2414
|
/**
|
|
2310
2415
|
* - Business unit
|
|
2311
2416
|
*/
|
|
@@ -2323,9 +2428,9 @@ type SetCODForUserCreation = {
|
|
|
2323
2428
|
*/
|
|
2324
2429
|
merchant_user_id: string;
|
|
2325
2430
|
};
|
|
2326
|
-
/** @returns {
|
|
2327
|
-
declare function
|
|
2328
|
-
type
|
|
2431
|
+
/** @returns {SetCODOptionResponse} */
|
|
2432
|
+
declare function SetCODOptionResponse(): SetCODOptionResponse;
|
|
2433
|
+
type SetCODOptionResponse = {
|
|
2329
2434
|
/**
|
|
2330
2435
|
* - Message
|
|
2331
2436
|
*/
|
|
@@ -2351,9 +2456,9 @@ type EdcModelData = {
|
|
|
2351
2456
|
*/
|
|
2352
2457
|
models: string[];
|
|
2353
2458
|
};
|
|
2354
|
-
/** @returns {
|
|
2355
|
-
declare function
|
|
2356
|
-
type
|
|
2459
|
+
/** @returns {EdcAggregatorAndModelListResponse} */
|
|
2460
|
+
declare function EdcAggregatorAndModelListResponse(): EdcAggregatorAndModelListResponse;
|
|
2461
|
+
type EdcAggregatorAndModelListResponse = {
|
|
2357
2462
|
/**
|
|
2358
2463
|
* - List of aggregators and their edc models
|
|
2359
2464
|
*/
|
|
@@ -2375,18 +2480,18 @@ type StatisticsData = {
|
|
|
2375
2480
|
*/
|
|
2376
2481
|
active_device_count: number;
|
|
2377
2482
|
};
|
|
2378
|
-
/** @returns {
|
|
2379
|
-
declare function
|
|
2380
|
-
type
|
|
2483
|
+
/** @returns {EdcDeviceStatsResponse} */
|
|
2484
|
+
declare function EdcDeviceStatsResponse(): EdcDeviceStatsResponse;
|
|
2485
|
+
type EdcDeviceStatsResponse = {
|
|
2381
2486
|
statistics: StatisticsData;
|
|
2382
2487
|
/**
|
|
2383
2488
|
* - Response is successful or not
|
|
2384
2489
|
*/
|
|
2385
2490
|
success: boolean;
|
|
2386
2491
|
};
|
|
2387
|
-
/** @returns {
|
|
2388
|
-
declare function
|
|
2389
|
-
type
|
|
2492
|
+
/** @returns {EdcAddRequest} */
|
|
2493
|
+
declare function EdcAddRequest(): EdcAddRequest;
|
|
2494
|
+
type EdcAddRequest = {
|
|
2390
2495
|
/**
|
|
2391
2496
|
* - Model of the edc machine
|
|
2392
2497
|
*/
|
|
@@ -2462,27 +2567,27 @@ type EdcDevice = {
|
|
|
2462
2567
|
*/
|
|
2463
2568
|
application_id: string;
|
|
2464
2569
|
};
|
|
2465
|
-
/** @returns {
|
|
2466
|
-
declare function
|
|
2467
|
-
type
|
|
2570
|
+
/** @returns {EdcDeviceAddResponse} */
|
|
2571
|
+
declare function EdcDeviceAddResponse(): EdcDeviceAddResponse;
|
|
2572
|
+
type EdcDeviceAddResponse = {
|
|
2468
2573
|
data: EdcDevice;
|
|
2469
2574
|
/**
|
|
2470
2575
|
* - Response is successful or not
|
|
2471
2576
|
*/
|
|
2472
2577
|
success: boolean;
|
|
2473
2578
|
};
|
|
2474
|
-
/** @returns {
|
|
2475
|
-
declare function
|
|
2476
|
-
type
|
|
2579
|
+
/** @returns {EdcDeviceDetailsResponse} */
|
|
2580
|
+
declare function EdcDeviceDetailsResponse(): EdcDeviceDetailsResponse;
|
|
2581
|
+
type EdcDeviceDetailsResponse = {
|
|
2477
2582
|
data: EdcDevice;
|
|
2478
2583
|
/**
|
|
2479
2584
|
* - Response is successful or not
|
|
2480
2585
|
*/
|
|
2481
2586
|
success: boolean;
|
|
2482
2587
|
};
|
|
2483
|
-
/** @returns {
|
|
2484
|
-
declare function
|
|
2485
|
-
type
|
|
2588
|
+
/** @returns {EdcUpdateRequest} */
|
|
2589
|
+
declare function EdcUpdateRequest(): EdcUpdateRequest;
|
|
2590
|
+
type EdcUpdateRequest = {
|
|
2486
2591
|
/**
|
|
2487
2592
|
* - Model of the edc machine
|
|
2488
2593
|
*/
|
|
@@ -2512,9 +2617,9 @@ type EdcUpdate = {
|
|
|
2512
2617
|
*/
|
|
2513
2618
|
device_tag?: string;
|
|
2514
2619
|
};
|
|
2515
|
-
/** @returns {
|
|
2516
|
-
declare function
|
|
2517
|
-
type
|
|
2620
|
+
/** @returns {EdcDeviceUpdateResponse} */
|
|
2621
|
+
declare function EdcDeviceUpdateResponse(): EdcDeviceUpdateResponse;
|
|
2622
|
+
type EdcDeviceUpdateResponse = {
|
|
2518
2623
|
/**
|
|
2519
2624
|
* - Response is successful or not
|
|
2520
2625
|
*/
|
|
@@ -2552,9 +2657,9 @@ type Page = {
|
|
|
2552
2657
|
*/
|
|
2553
2658
|
size?: number;
|
|
2554
2659
|
};
|
|
2555
|
-
/** @returns {
|
|
2556
|
-
declare function
|
|
2557
|
-
type
|
|
2660
|
+
/** @returns {EdcDeviceListResponse} */
|
|
2661
|
+
declare function EdcDeviceListResponse(): EdcDeviceListResponse;
|
|
2662
|
+
type EdcDeviceListResponse = {
|
|
2558
2663
|
/**
|
|
2559
2664
|
* - List of all edc mapped to the application
|
|
2560
2665
|
* options with their Details.
|
|
@@ -2566,9 +2671,9 @@ type EdcDeviceListDetails = {
|
|
|
2566
2671
|
*/
|
|
2567
2672
|
success: boolean;
|
|
2568
2673
|
};
|
|
2569
|
-
/** @returns {
|
|
2570
|
-
declare function
|
|
2571
|
-
type
|
|
2674
|
+
/** @returns {PaymentInitializationRequest} */
|
|
2675
|
+
declare function PaymentInitializationRequest(): PaymentInitializationRequest;
|
|
2676
|
+
type PaymentInitializationRequest = {
|
|
2572
2677
|
/**
|
|
2573
2678
|
* - Payment gateway payment id
|
|
2574
2679
|
*/
|
|
@@ -2622,9 +2727,9 @@ type PaymentInitializationCreation = {
|
|
|
2622
2727
|
*/
|
|
2623
2728
|
method: string;
|
|
2624
2729
|
};
|
|
2625
|
-
/** @returns {
|
|
2626
|
-
declare function
|
|
2627
|
-
type
|
|
2730
|
+
/** @returns {PaymentInitializationResponse} */
|
|
2731
|
+
declare function PaymentInitializationResponse(): PaymentInitializationResponse;
|
|
2732
|
+
type PaymentInitializationResponse = {
|
|
2628
2733
|
/**
|
|
2629
2734
|
* - Payment id.
|
|
2630
2735
|
*/
|
|
@@ -2694,9 +2799,9 @@ type PaymentInitializationDetails = {
|
|
|
2694
2799
|
*/
|
|
2695
2800
|
method: string;
|
|
2696
2801
|
};
|
|
2697
|
-
/** @returns {
|
|
2698
|
-
declare function
|
|
2699
|
-
type
|
|
2802
|
+
/** @returns {PaymentStatusUpdateRequest} */
|
|
2803
|
+
declare function PaymentStatusUpdateRequest(): PaymentStatusUpdateRequest;
|
|
2804
|
+
type PaymentStatusUpdateRequest = {
|
|
2700
2805
|
/**
|
|
2701
2806
|
* - EDC machine Unique Identifier
|
|
2702
2807
|
*/
|
|
@@ -2750,9 +2855,9 @@ type PaymentStatusUpdateCreation = {
|
|
|
2750
2855
|
*/
|
|
2751
2856
|
merchant_transaction_id: string;
|
|
2752
2857
|
};
|
|
2753
|
-
/** @returns {
|
|
2754
|
-
declare function
|
|
2755
|
-
type
|
|
2858
|
+
/** @returns {PaymentStatusUpdateResponse} */
|
|
2859
|
+
declare function PaymentStatusUpdateResponse(): PaymentStatusUpdateResponse;
|
|
2860
|
+
type PaymentStatusUpdateResponse = {
|
|
2756
2861
|
/**
|
|
2757
2862
|
* - Redirect url
|
|
2758
2863
|
*/
|
|
@@ -2774,9 +2879,9 @@ type PaymentStatusUpdateDetails = {
|
|
|
2774
2879
|
*/
|
|
2775
2880
|
aggregator_name: string;
|
|
2776
2881
|
};
|
|
2777
|
-
/** @returns {
|
|
2778
|
-
declare function
|
|
2779
|
-
type
|
|
2882
|
+
/** @returns {ResendOrCancelPaymentRequest} */
|
|
2883
|
+
declare function ResendOrCancelPaymentRequest(): ResendOrCancelPaymentRequest;
|
|
2884
|
+
type ResendOrCancelPaymentRequest = {
|
|
2780
2885
|
/**
|
|
2781
2886
|
* - Unique order id
|
|
2782
2887
|
*/
|
|
@@ -2807,26 +2912,26 @@ type LinkStatus = {
|
|
|
2807
2912
|
*/
|
|
2808
2913
|
is_payment_done?: boolean;
|
|
2809
2914
|
};
|
|
2810
|
-
/** @returns {
|
|
2811
|
-
declare function
|
|
2812
|
-
type
|
|
2915
|
+
/** @returns {ResendOrCancelPaymentResponse} */
|
|
2916
|
+
declare function ResendOrCancelPaymentResponse(): ResendOrCancelPaymentResponse;
|
|
2917
|
+
type ResendOrCancelPaymentResponse = {
|
|
2813
2918
|
data: LinkStatus;
|
|
2814
2919
|
/**
|
|
2815
2920
|
* - Response is successful or not.
|
|
2816
2921
|
*/
|
|
2817
2922
|
success: boolean;
|
|
2818
2923
|
};
|
|
2819
|
-
/** @returns {
|
|
2820
|
-
declare function
|
|
2821
|
-
type
|
|
2924
|
+
/** @returns {PaymentStatusBulkHandlerRequest} */
|
|
2925
|
+
declare function PaymentStatusBulkHandlerRequest(): PaymentStatusBulkHandlerRequest;
|
|
2926
|
+
type PaymentStatusBulkHandlerRequest = {
|
|
2822
2927
|
/**
|
|
2823
2928
|
* - List of order ids
|
|
2824
2929
|
*/
|
|
2825
2930
|
merchant_order_id: string[];
|
|
2826
2931
|
};
|
|
2827
|
-
/** @returns {
|
|
2828
|
-
declare function
|
|
2829
|
-
type
|
|
2932
|
+
/** @returns {PaymentObjectListSerializer} */
|
|
2933
|
+
declare function PaymentObjectListSerializer(): PaymentObjectListSerializer;
|
|
2934
|
+
type PaymentObjectListSerializer = {
|
|
2830
2935
|
user_object: any;
|
|
2831
2936
|
modified_on: string;
|
|
2832
2937
|
collected_by: string;
|
|
@@ -2850,20 +2955,20 @@ type PaymentObjectList = {
|
|
|
2850
2955
|
declare function PaymentStatusObject(): PaymentStatusObject;
|
|
2851
2956
|
type PaymentStatusObject = {
|
|
2852
2957
|
merchant_order_id: string;
|
|
2853
|
-
payment_object_list?:
|
|
2958
|
+
payment_object_list?: PaymentObjectListSerializer[];
|
|
2854
2959
|
};
|
|
2855
|
-
/** @returns {
|
|
2856
|
-
declare function
|
|
2857
|
-
type
|
|
2960
|
+
/** @returns {PaymentStatusBulkHandlerResponse} */
|
|
2961
|
+
declare function PaymentStatusBulkHandlerResponse(): PaymentStatusBulkHandlerResponse;
|
|
2962
|
+
type PaymentStatusBulkHandlerResponse = {
|
|
2858
2963
|
count?: number;
|
|
2859
2964
|
data?: PaymentStatusObject[];
|
|
2860
2965
|
success: string;
|
|
2861
2966
|
error?: string;
|
|
2862
2967
|
status: number;
|
|
2863
2968
|
};
|
|
2864
|
-
/** @returns {
|
|
2865
|
-
declare function
|
|
2866
|
-
type
|
|
2969
|
+
/** @returns {GetOauthUrlResponse} */
|
|
2970
|
+
declare function GetOauthUrlResponse(): GetOauthUrlResponse;
|
|
2971
|
+
type GetOauthUrlResponse = {
|
|
2867
2972
|
/**
|
|
2868
2973
|
* - The url to call for authenticating
|
|
2869
2974
|
*/
|
|
@@ -2950,18 +3055,18 @@ type RepaymentDetailsSerialiserPayAll = {
|
|
|
2950
3055
|
aggregator_order_id: string;
|
|
2951
3056
|
shipment_details?: RepaymentRequestDetails[];
|
|
2952
3057
|
};
|
|
2953
|
-
/** @returns {
|
|
2954
|
-
declare function
|
|
2955
|
-
type
|
|
3058
|
+
/** @returns {RepaymentResponse} */
|
|
3059
|
+
declare function RepaymentResponse(): RepaymentResponse;
|
|
3060
|
+
type RepaymentResponse = {
|
|
2956
3061
|
data: any;
|
|
2957
3062
|
/**
|
|
2958
3063
|
* - Success/Failure of the transaction
|
|
2959
3064
|
*/
|
|
2960
3065
|
success: boolean;
|
|
2961
3066
|
};
|
|
2962
|
-
/** @returns {
|
|
2963
|
-
declare function
|
|
2964
|
-
type
|
|
3067
|
+
/** @returns {MerchantOnBoardingRequest} */
|
|
3068
|
+
declare function MerchantOnBoardingRequest(): MerchantOnBoardingRequest;
|
|
3069
|
+
type MerchantOnBoardingRequest = {
|
|
2965
3070
|
/**
|
|
2966
3071
|
* - Merchant ID at Ajiodhan's end
|
|
2967
3072
|
*/
|
|
@@ -2983,18 +3088,18 @@ type MerchantOnBoardingCreation = {
|
|
|
2983
3088
|
*/
|
|
2984
3089
|
status: string;
|
|
2985
3090
|
};
|
|
2986
|
-
/** @returns {
|
|
2987
|
-
declare function
|
|
2988
|
-
type
|
|
3091
|
+
/** @returns {MerchantOnBoardingResponse} */
|
|
3092
|
+
declare function MerchantOnBoardingResponse(): MerchantOnBoardingResponse;
|
|
3093
|
+
type MerchantOnBoardingResponse = {
|
|
2989
3094
|
data: any;
|
|
2990
3095
|
/**
|
|
2991
3096
|
* - Success/Failure of the transaction
|
|
2992
3097
|
*/
|
|
2993
3098
|
success: boolean;
|
|
2994
3099
|
};
|
|
2995
|
-
/** @returns {
|
|
2996
|
-
declare function
|
|
2997
|
-
type
|
|
3100
|
+
/** @returns {ValidateCustomerRequest} */
|
|
3101
|
+
declare function ValidateCustomerRequest(): ValidateCustomerRequest;
|
|
3102
|
+
type ValidateCustomerRequest = {
|
|
2998
3103
|
/**
|
|
2999
3104
|
* - User mobile number without country code.
|
|
3000
3105
|
*/
|
|
@@ -3028,9 +3133,9 @@ type ValidateCustomerCreation = {
|
|
|
3028
3133
|
*/
|
|
3029
3134
|
billing_address?: any;
|
|
3030
3135
|
};
|
|
3031
|
-
/** @returns {
|
|
3032
|
-
declare function
|
|
3033
|
-
type
|
|
3136
|
+
/** @returns {ValidateCustomerResponse} */
|
|
3137
|
+
declare function ValidateCustomerResponse(): ValidateCustomerResponse;
|
|
3138
|
+
type ValidateCustomerResponse = {
|
|
3034
3139
|
/**
|
|
3035
3140
|
* - Error or success message.
|
|
3036
3141
|
*/
|
|
@@ -3044,9 +3149,9 @@ type ValidateCustomerDetails = {
|
|
|
3044
3149
|
*/
|
|
3045
3150
|
success: boolean;
|
|
3046
3151
|
};
|
|
3047
|
-
/** @returns {
|
|
3048
|
-
declare function
|
|
3049
|
-
type
|
|
3152
|
+
/** @returns {GetPaymentLinkResponse} */
|
|
3153
|
+
declare function GetPaymentLinkResponse(): GetPaymentLinkResponse;
|
|
3154
|
+
type GetPaymentLinkResponse = {
|
|
3050
3155
|
/**
|
|
3051
3156
|
* - Message
|
|
3052
3157
|
*/
|
|
@@ -3076,7 +3181,8 @@ type GetPaymentLinkDetails = {
|
|
|
3076
3181
|
*/
|
|
3077
3182
|
external_order_id?: string;
|
|
3078
3183
|
/**
|
|
3079
|
-
* - Polling request timeout
|
|
3184
|
+
* - Polling request timeout, perform
|
|
3185
|
+
* polling till timeout elapsed or payment status is success/failure
|
|
3080
3186
|
*/
|
|
3081
3187
|
polling_timeout?: number;
|
|
3082
3188
|
/**
|
|
@@ -3120,9 +3226,9 @@ type ErrorDescription = {
|
|
|
3120
3226
|
*/
|
|
3121
3227
|
cancelled?: boolean;
|
|
3122
3228
|
};
|
|
3123
|
-
/** @returns {
|
|
3124
|
-
declare function
|
|
3125
|
-
type
|
|
3229
|
+
/** @returns {ErrorResponse} */
|
|
3230
|
+
declare function ErrorResponse(): ErrorResponse;
|
|
3231
|
+
type ErrorResponse = {
|
|
3126
3232
|
/**
|
|
3127
3233
|
* - HTTP status code
|
|
3128
3234
|
*/
|
|
@@ -3140,14 +3246,27 @@ type ErrorDetails = {
|
|
|
3140
3246
|
/** @returns {CreatePaymentLinkMeta} */
|
|
3141
3247
|
declare function CreatePaymentLinkMeta(): CreatePaymentLinkMeta;
|
|
3142
3248
|
type CreatePaymentLinkMeta = {
|
|
3249
|
+
/**
|
|
3250
|
+
* - Cart id for which payment link needs to be generated.
|
|
3251
|
+
*/
|
|
3143
3252
|
cart_id: string;
|
|
3253
|
+
/**
|
|
3254
|
+
* - Checkout mode for the payment link i.e. self
|
|
3255
|
+
*/
|
|
3144
3256
|
checkout_mode: string;
|
|
3257
|
+
/**
|
|
3258
|
+
* - Payment link amount to be paid by the customer
|
|
3259
|
+
*/
|
|
3145
3260
|
amount: string;
|
|
3261
|
+
/**
|
|
3262
|
+
* - Assigned card id against which payment
|
|
3263
|
+
* to be done via payment link
|
|
3264
|
+
*/
|
|
3146
3265
|
assign_card_id?: string;
|
|
3147
3266
|
};
|
|
3148
|
-
/** @returns {
|
|
3149
|
-
declare function
|
|
3150
|
-
type
|
|
3267
|
+
/** @returns {CreatePaymentLinkRequest} */
|
|
3268
|
+
declare function CreatePaymentLinkRequest(): CreatePaymentLinkRequest;
|
|
3269
|
+
type CreatePaymentLinkRequest = {
|
|
3151
3270
|
/**
|
|
3152
3271
|
* - Email to which the payment link is to be sent
|
|
3153
3272
|
*/
|
|
@@ -3174,20 +3293,10 @@ type CreatePaymentLinkCreation = {
|
|
|
3174
3293
|
* - Merchant order id
|
|
3175
3294
|
*/
|
|
3176
3295
|
external_order_id: string;
|
|
3177
|
-
/**
|
|
3178
|
-
* - URL to which the user will be
|
|
3179
|
-
* redirected after a successful payment.
|
|
3180
|
-
*/
|
|
3181
|
-
success_redirection_url?: string;
|
|
3182
|
-
/**
|
|
3183
|
-
* - URL to which the user will be
|
|
3184
|
-
* redirected if the payment fails.
|
|
3185
|
-
*/
|
|
3186
|
-
failure_redirection_url?: string;
|
|
3187
3296
|
};
|
|
3188
|
-
/** @returns {
|
|
3189
|
-
declare function
|
|
3190
|
-
type
|
|
3297
|
+
/** @returns {CreatePaymentLinkResponse} */
|
|
3298
|
+
declare function CreatePaymentLinkResponse(): CreatePaymentLinkResponse;
|
|
3299
|
+
type CreatePaymentLinkResponse = {
|
|
3191
3300
|
/**
|
|
3192
3301
|
* - Message
|
|
3193
3302
|
*/
|
|
@@ -3213,9 +3322,9 @@ type CreatePaymentLinkDetails = {
|
|
|
3213
3322
|
*/
|
|
3214
3323
|
payment_link_id?: string;
|
|
3215
3324
|
};
|
|
3216
|
-
/** @returns {
|
|
3217
|
-
declare function
|
|
3218
|
-
type
|
|
3325
|
+
/** @returns {PollingPaymentLinkResponse} */
|
|
3326
|
+
declare function PollingPaymentLinkResponse(): PollingPaymentLinkResponse;
|
|
3327
|
+
type PollingPaymentLinkResponse = {
|
|
3219
3328
|
/**
|
|
3220
3329
|
* - Message
|
|
3221
3330
|
*/
|
|
@@ -3257,17 +3366,17 @@ type PollingPaymentLinkDetails = {
|
|
|
3257
3366
|
*/
|
|
3258
3367
|
aggregator_name?: string;
|
|
3259
3368
|
};
|
|
3260
|
-
/** @returns {
|
|
3261
|
-
declare function
|
|
3262
|
-
type
|
|
3369
|
+
/** @returns {CancelOrResendPaymentLinkRequest} */
|
|
3370
|
+
declare function CancelOrResendPaymentLinkRequest(): CancelOrResendPaymentLinkRequest;
|
|
3371
|
+
type CancelOrResendPaymentLinkRequest = {
|
|
3263
3372
|
/**
|
|
3264
3373
|
* - Unique id of payment link
|
|
3265
3374
|
*/
|
|
3266
3375
|
payment_link_id: string;
|
|
3267
3376
|
};
|
|
3268
|
-
/** @returns {
|
|
3269
|
-
declare function
|
|
3270
|
-
type
|
|
3377
|
+
/** @returns {ResendPaymentLinkResponse} */
|
|
3378
|
+
declare function ResendPaymentLinkResponse(): ResendPaymentLinkResponse;
|
|
3379
|
+
type ResendPaymentLinkResponse = {
|
|
3271
3380
|
/**
|
|
3272
3381
|
* - HTTP status code
|
|
3273
3382
|
*/
|
|
@@ -3285,9 +3394,9 @@ type ResendPaymentLinkDetails = {
|
|
|
3285
3394
|
*/
|
|
3286
3395
|
success: boolean;
|
|
3287
3396
|
};
|
|
3288
|
-
/** @returns {
|
|
3289
|
-
declare function
|
|
3290
|
-
type
|
|
3397
|
+
/** @returns {CancelPaymentLinkResponse} */
|
|
3398
|
+
declare function CancelPaymentLinkResponse(): CancelPaymentLinkResponse;
|
|
3399
|
+
type CancelPaymentLinkResponse = {
|
|
3291
3400
|
/**
|
|
3292
3401
|
* - HTTP status code
|
|
3293
3402
|
*/
|
|
@@ -3339,18 +3448,18 @@ declare function GetPaymentCode(): GetPaymentCode;
|
|
|
3339
3448
|
type GetPaymentCode = {
|
|
3340
3449
|
method_code: PaymentCode;
|
|
3341
3450
|
};
|
|
3342
|
-
/** @returns {
|
|
3343
|
-
declare function
|
|
3344
|
-
type
|
|
3451
|
+
/** @returns {GetPaymentCodeResponse} */
|
|
3452
|
+
declare function GetPaymentCodeResponse(): GetPaymentCodeResponse;
|
|
3453
|
+
type GetPaymentCodeResponse = {
|
|
3345
3454
|
data: GetPaymentCode;
|
|
3346
3455
|
/**
|
|
3347
3456
|
* - Response is successful or not.
|
|
3348
3457
|
*/
|
|
3349
3458
|
success: boolean;
|
|
3350
3459
|
};
|
|
3351
|
-
/** @returns {
|
|
3352
|
-
declare function
|
|
3353
|
-
type
|
|
3460
|
+
/** @returns {PlatformPaymentModeResponse} */
|
|
3461
|
+
declare function PlatformPaymentModeResponse(): PlatformPaymentModeResponse;
|
|
3462
|
+
type PlatformPaymentModeResponse = {
|
|
3354
3463
|
/**
|
|
3355
3464
|
* - Message
|
|
3356
3465
|
*/
|
|
@@ -3364,9 +3473,9 @@ type PlatformPaymentModeDetails = {
|
|
|
3364
3473
|
*/
|
|
3365
3474
|
success: boolean;
|
|
3366
3475
|
};
|
|
3367
|
-
/** @returns {
|
|
3368
|
-
declare function
|
|
3369
|
-
type
|
|
3476
|
+
/** @returns {MerchnatPaymentModeRequest} */
|
|
3477
|
+
declare function MerchnatPaymentModeRequest(): MerchnatPaymentModeRequest;
|
|
3478
|
+
type MerchnatPaymentModeRequest = {
|
|
3370
3479
|
/**
|
|
3371
3480
|
* - Details to be updated for online payment configuration.
|
|
3372
3481
|
*/
|
|
@@ -3518,6 +3627,10 @@ type PaymentSessionDetail = {
|
|
|
3518
3627
|
* merchant account
|
|
3519
3628
|
*/
|
|
3520
3629
|
amount_captured: number;
|
|
3630
|
+
/**
|
|
3631
|
+
* - Amount refunded or credited back to
|
|
3632
|
+
* customer accout
|
|
3633
|
+
*/
|
|
3521
3634
|
amount_refunded?: number;
|
|
3522
3635
|
/**
|
|
3523
3636
|
* - Unique customer id generated by
|
|
@@ -3580,19 +3693,19 @@ type PaymentSessionDetail = {
|
|
|
3580
3693
|
*/
|
|
3581
3694
|
captured?: boolean;
|
|
3582
3695
|
/**
|
|
3583
|
-
* -
|
|
3696
|
+
* - Extra meta data specific to extension
|
|
3584
3697
|
*/
|
|
3585
3698
|
meta?: any;
|
|
3586
3699
|
/**
|
|
3587
|
-
* -
|
|
3700
|
+
* - Status of the payment
|
|
3588
3701
|
*/
|
|
3589
3702
|
status: string;
|
|
3590
3703
|
};
|
|
3591
|
-
/** @returns {
|
|
3592
|
-
declare function
|
|
3593
|
-
type
|
|
3704
|
+
/** @returns {PaymentSessionRequestSerializer} */
|
|
3705
|
+
declare function PaymentSessionRequestSerializer(): PaymentSessionRequestSerializer;
|
|
3706
|
+
type PaymentSessionRequestSerializer = {
|
|
3594
3707
|
/**
|
|
3595
|
-
* -
|
|
3708
|
+
* - Extra meta data specific to extensions
|
|
3596
3709
|
*/
|
|
3597
3710
|
meta?: any;
|
|
3598
3711
|
/**
|
|
@@ -3626,10 +3739,14 @@ type PaymentSessionCreation = {
|
|
|
3626
3739
|
* - Checksum to verify the payload
|
|
3627
3740
|
*/
|
|
3628
3741
|
checksum: string;
|
|
3742
|
+
/**
|
|
3743
|
+
* - Source of payment update session
|
|
3744
|
+
*/
|
|
3745
|
+
source?: string;
|
|
3629
3746
|
};
|
|
3630
|
-
/** @returns {
|
|
3631
|
-
declare function
|
|
3632
|
-
type
|
|
3747
|
+
/** @returns {PaymentSessionResponseSerializer} */
|
|
3748
|
+
declare function PaymentSessionResponseSerializer(): PaymentSessionResponseSerializer;
|
|
3749
|
+
type PaymentSessionResponseSerializer = {
|
|
3633
3750
|
/**
|
|
3634
3751
|
* - Global identifier of the entity (e.g. order, cart
|
|
3635
3752
|
* etc.) against which payment_session was initiated. This is generated by
|
|
@@ -3712,9 +3829,9 @@ type RefundSessionDetail = {
|
|
|
3712
3829
|
*/
|
|
3713
3830
|
balance_transaction?: string;
|
|
3714
3831
|
};
|
|
3715
|
-
/** @returns {
|
|
3716
|
-
declare function
|
|
3717
|
-
type
|
|
3832
|
+
/** @returns {RefundSessionRequestSerializer} */
|
|
3833
|
+
declare function RefundSessionRequestSerializer(): RefundSessionRequestSerializer;
|
|
3834
|
+
type RefundSessionRequestSerializer = {
|
|
3718
3835
|
/**
|
|
3719
3836
|
* - Meta
|
|
3720
3837
|
*/
|
|
@@ -3755,9 +3872,9 @@ type RefundSessionCreation = {
|
|
|
3755
3872
|
*/
|
|
3756
3873
|
checksum: string;
|
|
3757
3874
|
};
|
|
3758
|
-
/** @returns {
|
|
3759
|
-
declare function
|
|
3760
|
-
type
|
|
3875
|
+
/** @returns {RefundSessionResponseSerializer} */
|
|
3876
|
+
declare function RefundSessionResponseSerializer(): RefundSessionResponseSerializer;
|
|
3877
|
+
type RefundSessionResponseSerializer = {
|
|
3761
3878
|
/**
|
|
3762
3879
|
* - Global identifier of the entity (e.g. order, cart
|
|
3763
3880
|
* etc.) against which payment_session was initiated. This is generated by
|
|
@@ -3781,11 +3898,11 @@ type RefundSessionDetails = {
|
|
|
3781
3898
|
*/
|
|
3782
3899
|
total_refund_amount: number;
|
|
3783
3900
|
};
|
|
3784
|
-
/** @returns {
|
|
3785
|
-
declare function
|
|
3786
|
-
type
|
|
3901
|
+
/** @returns {PaymentDetailsSerializer} */
|
|
3902
|
+
declare function PaymentDetailsSerializer(): PaymentDetailsSerializer;
|
|
3903
|
+
type PaymentDetailsSerializer = {
|
|
3787
3904
|
/**
|
|
3788
|
-
* -
|
|
3905
|
+
* - List of payment methods
|
|
3789
3906
|
*/
|
|
3790
3907
|
payment_methods: any[];
|
|
3791
3908
|
/**
|
|
@@ -3794,6 +3911,10 @@ type PaymentDetails = {
|
|
|
3794
3911
|
* Fynd payments platform and is unique.
|
|
3795
3912
|
*/
|
|
3796
3913
|
gid: string;
|
|
3914
|
+
/**
|
|
3915
|
+
* - Already refunded amount for the given
|
|
3916
|
+
* gid (global identifier for the order).
|
|
3917
|
+
*/
|
|
3797
3918
|
amount_refunded?: number;
|
|
3798
3919
|
/**
|
|
3799
3920
|
* - Currency of the payment.
|
|
@@ -3805,11 +3926,11 @@ type PaymentDetails = {
|
|
|
3805
3926
|
*/
|
|
3806
3927
|
mode: string;
|
|
3807
3928
|
/**
|
|
3808
|
-
* - Merchant's locale
|
|
3929
|
+
* - Merchant's locale (language) i.e. en
|
|
3809
3930
|
*/
|
|
3810
3931
|
merchant_locale?: string;
|
|
3811
3932
|
/**
|
|
3812
|
-
* -
|
|
3933
|
+
* - Extra meta data related to the payment methods
|
|
3813
3934
|
*/
|
|
3814
3935
|
meta?: any;
|
|
3815
3936
|
/**
|
|
@@ -3823,7 +3944,7 @@ type PaymentDetails = {
|
|
|
3823
3944
|
*/
|
|
3824
3945
|
success_url?: string;
|
|
3825
3946
|
/**
|
|
3826
|
-
* -
|
|
3947
|
+
* - Status of the payment
|
|
3827
3948
|
*/
|
|
3828
3949
|
status: string;
|
|
3829
3950
|
/**
|
|
@@ -3841,12 +3962,12 @@ type PaymentDetails = {
|
|
|
3841
3962
|
*/
|
|
3842
3963
|
g_user_id: string;
|
|
3843
3964
|
/**
|
|
3844
|
-
* - User's locale
|
|
3965
|
+
* - User's locale (language), i.e. en
|
|
3845
3966
|
*/
|
|
3846
3967
|
locale?: string;
|
|
3847
3968
|
/**
|
|
3848
3969
|
* - Cancel url sent by Fynd platform at the
|
|
3849
|
-
* time of payment creation
|
|
3970
|
+
* time of payment creation, redirect on payment cancellation
|
|
3850
3971
|
*/
|
|
3851
3972
|
cancel_url?: string;
|
|
3852
3973
|
/**
|
|
@@ -3859,7 +3980,7 @@ type PaymentDetails = {
|
|
|
3859
3980
|
*/
|
|
3860
3981
|
amount_captured: number;
|
|
3861
3982
|
/**
|
|
3862
|
-
* - Amount paid.
|
|
3983
|
+
* - Amount paid for the order.
|
|
3863
3984
|
*/
|
|
3864
3985
|
amount: number;
|
|
3865
3986
|
/**
|
|
@@ -3873,9 +3994,9 @@ type PaymentDetails = {
|
|
|
3873
3994
|
*/
|
|
3874
3995
|
aggregator_order_id?: string;
|
|
3875
3996
|
};
|
|
3876
|
-
/** @returns {
|
|
3877
|
-
declare function
|
|
3878
|
-
type
|
|
3997
|
+
/** @returns {CartDetailsSerializer} */
|
|
3998
|
+
declare function CartDetailsSerializer(): CartDetailsSerializer;
|
|
3999
|
+
type CartDetailsSerializer = {
|
|
3879
4000
|
/**
|
|
3880
4001
|
* - Items that are added in cart
|
|
3881
4002
|
*/
|
|
@@ -3898,9 +4019,9 @@ type CartDetails = {
|
|
|
3898
4019
|
*/
|
|
3899
4020
|
custom_cart_meta?: any;
|
|
3900
4021
|
};
|
|
3901
|
-
/** @returns {
|
|
3902
|
-
declare function
|
|
3903
|
-
type
|
|
4022
|
+
/** @returns {RefundDetailsSerializer} */
|
|
4023
|
+
declare function RefundDetailsSerializer(): RefundDetailsSerializer;
|
|
4024
|
+
type RefundDetailsSerializer = {
|
|
3904
4025
|
/**
|
|
3905
4026
|
* - Refunded amount
|
|
3906
4027
|
*/
|
|
@@ -3926,9 +4047,9 @@ type RefundDetails = {
|
|
|
3926
4047
|
*/
|
|
3927
4048
|
refund_utr: string;
|
|
3928
4049
|
};
|
|
3929
|
-
/** @returns {
|
|
3930
|
-
declare function
|
|
3931
|
-
type
|
|
4050
|
+
/** @returns {PaymentSessionSerializer} */
|
|
4051
|
+
declare function PaymentSessionSerializer(): PaymentSessionSerializer;
|
|
4052
|
+
type PaymentSessionSerializer = {
|
|
3932
4053
|
/**
|
|
3933
4054
|
* - Object of payment details
|
|
3934
4055
|
*/
|
|
@@ -3951,11 +4072,11 @@ type PaymentSessionFetchDetails = {
|
|
|
3951
4072
|
* Fynd payments platform and is unique.
|
|
3952
4073
|
*/
|
|
3953
4074
|
gid: string;
|
|
3954
|
-
cart_details?:
|
|
4075
|
+
cart_details?: CartDetailsSerializer;
|
|
3955
4076
|
/**
|
|
3956
4077
|
* - Object of refund details
|
|
3957
4078
|
*/
|
|
3958
|
-
refund_details:
|
|
4079
|
+
refund_details: RefundDetailsSerializer[];
|
|
3959
4080
|
};
|
|
3960
4081
|
/** @returns {RefundSourcesPriority} */
|
|
3961
4082
|
declare function RefundSourcesPriority(): RefundSourcesPriority;
|
|
@@ -3973,9 +4094,9 @@ type RefundSourcesPriority = {
|
|
|
3973
4094
|
*/
|
|
3974
4095
|
source: string;
|
|
3975
4096
|
};
|
|
3976
|
-
/** @returns {
|
|
3977
|
-
declare function
|
|
3978
|
-
type
|
|
4097
|
+
/** @returns {RefundPriorityResponseSerializer} */
|
|
4098
|
+
declare function RefundPriorityResponseSerializer(): RefundPriorityResponseSerializer;
|
|
4099
|
+
type RefundPriorityResponseSerializer = {
|
|
3979
4100
|
/**
|
|
3980
4101
|
* - Configuration for merchant or customer
|
|
3981
4102
|
*/
|
|
@@ -3997,9 +4118,9 @@ type RefundPriorityDetails = {
|
|
|
3997
4118
|
*/
|
|
3998
4119
|
message?: string;
|
|
3999
4120
|
};
|
|
4000
|
-
/** @returns {
|
|
4001
|
-
declare function
|
|
4002
|
-
type
|
|
4121
|
+
/** @returns {RefundPriorityRequestSerializer} */
|
|
4122
|
+
declare function RefundPriorityRequestSerializer(): RefundPriorityRequestSerializer;
|
|
4123
|
+
type RefundPriorityRequestSerializer = {
|
|
4003
4124
|
/**
|
|
4004
4125
|
* - Apportion refund to multiple sources
|
|
4005
4126
|
*/
|
|
@@ -4009,9 +4130,9 @@ type RefundPriorityCreation = {
|
|
|
4009
4130
|
*/
|
|
4010
4131
|
refund_sources_priority: RefundSourcesPriority[];
|
|
4011
4132
|
};
|
|
4012
|
-
/** @returns {
|
|
4013
|
-
declare function
|
|
4014
|
-
type
|
|
4133
|
+
/** @returns {MerchantPaymentModeRequest} */
|
|
4134
|
+
declare function MerchantPaymentModeRequest(): MerchantPaymentModeRequest;
|
|
4135
|
+
type MerchantPaymentModeRequest = {
|
|
4015
4136
|
/**
|
|
4016
4137
|
* - Business unit
|
|
4017
4138
|
*/
|
|
@@ -4049,9 +4170,9 @@ type ToConfig = {
|
|
|
4049
4170
|
*/
|
|
4050
4171
|
business_unit: string;
|
|
4051
4172
|
};
|
|
4052
|
-
/** @returns {
|
|
4053
|
-
declare function
|
|
4054
|
-
type
|
|
4173
|
+
/** @returns {PlatformPaymentModeCopyConfigRequest} */
|
|
4174
|
+
declare function PlatformPaymentModeCopyConfigRequest(): PlatformPaymentModeCopyConfigRequest;
|
|
4175
|
+
type PlatformPaymentModeCopyConfigRequest = {
|
|
4055
4176
|
from_config: FromConfig;
|
|
4056
4177
|
to_config: ToConfig;
|
|
4057
4178
|
};
|
|
@@ -4092,9 +4213,9 @@ type PaymentOrderMethods = {
|
|
|
4092
4213
|
*/
|
|
4093
4214
|
name: string;
|
|
4094
4215
|
};
|
|
4095
|
-
/** @returns {
|
|
4096
|
-
declare function
|
|
4097
|
-
type
|
|
4216
|
+
/** @returns {PaymentOrderRequest} */
|
|
4217
|
+
declare function PaymentOrderRequest(): PaymentOrderRequest;
|
|
4218
|
+
type PaymentOrderRequest = {
|
|
4098
4219
|
/**
|
|
4099
4220
|
* - Order id
|
|
4100
4221
|
*/
|
|
@@ -4149,9 +4270,9 @@ type PaymentOrderData = {
|
|
|
4149
4270
|
*/
|
|
4150
4271
|
merchant_order_id?: string;
|
|
4151
4272
|
};
|
|
4152
|
-
/** @returns {
|
|
4153
|
-
declare function
|
|
4154
|
-
type
|
|
4273
|
+
/** @returns {PaymentOrderResponse} */
|
|
4274
|
+
declare function PaymentOrderResponse(): PaymentOrderResponse;
|
|
4275
|
+
type PaymentOrderResponse = {
|
|
4155
4276
|
/**
|
|
4156
4277
|
* - Message
|
|
4157
4278
|
*/
|
|
@@ -4185,9 +4306,9 @@ type AggregatorVersionItemSchema = {
|
|
|
4185
4306
|
is_less_than?: string;
|
|
4186
4307
|
is_greater_than?: string;
|
|
4187
4308
|
};
|
|
4188
|
-
/** @returns {
|
|
4189
|
-
declare function
|
|
4190
|
-
type
|
|
4309
|
+
/** @returns {AggregatorVersionResponse} */
|
|
4310
|
+
declare function AggregatorVersionResponse(): AggregatorVersionResponse;
|
|
4311
|
+
type AggregatorVersionResponse = {
|
|
4191
4312
|
/**
|
|
4192
4313
|
* - Message
|
|
4193
4314
|
*/
|
|
@@ -4205,9 +4326,9 @@ type AggregatorVersionRequestSchema = {
|
|
|
4205
4326
|
is_less_than?: string;
|
|
4206
4327
|
is_greater_than?: string;
|
|
4207
4328
|
};
|
|
4208
|
-
/** @returns {
|
|
4209
|
-
declare function
|
|
4210
|
-
type
|
|
4329
|
+
/** @returns {AggregatorControlRequest} */
|
|
4330
|
+
declare function AggregatorControlRequest(): AggregatorControlRequest;
|
|
4331
|
+
type AggregatorControlRequest = {
|
|
4211
4332
|
/**
|
|
4212
4333
|
* - Business unit
|
|
4213
4334
|
*/
|