@gofynd/fdk-client-javascript 1.6.3 → 3.0.0-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 +113 -93
- package/sdk/application/Cart/CartApplicationClient.js +270 -139
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +110 -110
- package/sdk/application/Catalog/CatalogApplicationClient.js +122 -138
- package/sdk/application/Common/CommonApplicationClient.d.ts +4 -4
- package/sdk/application/Common/CommonApplicationClient.js +3 -3
- package/sdk/application/Communication/CommunicationApplicationClient.d.ts +43 -3
- package/sdk/application/Communication/CommunicationApplicationClient.js +190 -3
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +71 -36
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +103 -29
- package/sdk/application/Content/ContentApplicationClient.d.ts +51 -21
- package/sdk/application/Content/ContentApplicationClient.js +197 -36
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +6 -6
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +3 -3
- package/sdk/application/Lead/LeadApplicationClient.d.ts +3 -3
- package/sdk/application/Lead/LeadApplicationClient.js +3 -3
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +79 -64
- package/sdk/application/Logistic/LogisticApplicationClient.js +246 -264
- package/sdk/application/Order/OrderApplicationClient.d.ts +44 -24
- package/sdk/application/Order/OrderApplicationClient.js +140 -21
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +211 -111
- package/sdk/application/Payment/PaymentApplicationClient.js +610 -109
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +13 -13
- package/sdk/application/Rewards/RewardsApplicationClient.js +7 -7
- package/sdk/application/Share/ShareApplicationClient.d.ts +7 -7
- package/sdk/application/Share/ShareApplicationClient.js +14 -14
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +23 -3
- package/sdk/application/Theme/ThemeApplicationClient.js +103 -5
- package/sdk/application/User/UserApplicationClient.d.ts +13 -23
- package/sdk/application/User/UserApplicationClient.js +9 -57
- package/sdk/application/Webhook/WebhookApplicationClient.d.ts +4 -4
- package/sdk/application/Webhook/WebhookApplicationClient.js +3 -3
- package/sdk/partner/Authorization/AuthorizationPartnerClient.d.ts +66 -0
- package/sdk/partner/Authorization/AuthorizationPartnerClient.js +431 -0
- package/sdk/partner/Authorization/AuthorizationPartnerModel.d.ts +231 -0
- package/sdk/partner/Authorization/AuthorizationPartnerModel.js +152 -0
- package/sdk/partner/Authorization/AuthorizationPartnerValidator.d.ts +8 -0
- package/sdk/partner/Authorization/AuthorizationPartnerValidator.js +39 -0
- package/sdk/partner/Catalog/CatalogPartnerClient.d.ts +26 -0
- package/sdk/partner/Catalog/CatalogPartnerClient.js +173 -0
- package/sdk/partner/Catalog/CatalogPartnerModel.d.ts +238 -0
- package/sdk/partner/Catalog/CatalogPartnerModel.js +248 -0
- package/sdk/partner/Catalog/CatalogPartnerValidator.d.ts +5 -0
- package/sdk/partner/Catalog/CatalogPartnerValidator.js +19 -0
- package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +12 -22
- package/sdk/partner/FileStorage/FileStoragePartnerClient.js +12 -87
- package/sdk/partner/FileStorage/FileStoragePartnerModel.d.ts +33 -99
- package/sdk/partner/FileStorage/FileStoragePartnerModel.js +25 -84
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.d.ts +0 -1
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.js +4 -10
- package/sdk/partner/Lead/LeadPartnerClient.d.ts +5 -5
- package/sdk/partner/Lead/LeadPartnerClient.js +4 -4
- package/sdk/partner/Lead/LeadPartnerModel.d.ts +100 -49
- package/sdk/partner/Lead/LeadPartnerModel.js +100 -74
- package/sdk/partner/Lead/LeadPartnerValidator.js +1 -1
- package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +33 -160
- package/sdk/partner/Logistics/LogisticsPartnerClient.js +66 -1180
- package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +288 -1685
- package/sdk/partner/Logistics/LogisticsPartnerModel.js +226 -824
- package/sdk/partner/Logistics/LogisticsPartnerValidator.d.ts +1 -13
- package/sdk/partner/Logistics/LogisticsPartnerValidator.js +14 -141
- package/sdk/partner/PartnerClient.d.ts +6 -0
- package/sdk/partner/PartnerClient.js +9 -0
- package/sdk/partner/Payment/PaymentPartnerClient.d.ts +116 -0
- package/sdk/partner/Payment/PaymentPartnerClient.js +857 -0
- package/sdk/partner/Payment/PaymentPartnerModel.d.ts +388 -0
- package/sdk/partner/Payment/PaymentPartnerModel.js +442 -0
- package/sdk/partner/Payment/PaymentPartnerValidator.d.ts +14 -0
- package/sdk/partner/Payment/PaymentPartnerValidator.js +74 -0
- package/sdk/partner/Theme/ThemePartnerClient.d.ts +63 -21
- package/sdk/partner/Theme/ThemePartnerClient.js +396 -71
- package/sdk/partner/Theme/ThemePartnerModel.d.ts +104 -72
- package/sdk/partner/Theme/ThemePartnerModel.js +101 -75
- package/sdk/partner/Theme/ThemePartnerValidator.d.ts +5 -1
- package/sdk/partner/Theme/ThemePartnerValidator.js +42 -12
- package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +18 -18
- package/sdk/partner/Webhook/WebhookPartnerClient.js +18 -18
- package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +191 -612
- package/sdk/partner/Webhook/WebhookPartnerModel.js +159 -234
- package/sdk/partner/Webhook/WebhookPartnerValidator.js +3 -3
- package/sdk/partner/index.d.ts +3 -0
- package/sdk/partner/index.js +6 -0
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.d.ts +1 -4
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.js +1 -1
- package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +5 -0
- package/sdk/platform/Analytics/AnalyticsPlatformModel.js +3 -1
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +32 -2
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +243 -3
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +145 -49
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +171 -20
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +39 -1
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.js +35 -0
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +406 -15
- package/sdk/platform/Billing/BillingPlatformClient.js +3214 -76
- package/sdk/platform/Billing/BillingPlatformModel.d.ts +3798 -459
- package/sdk/platform/Billing/BillingPlatformModel.js +2577 -342
- package/sdk/platform/Billing/BillingPlatformValidator.d.ts +465 -24
- package/sdk/platform/Billing/BillingPlatformValidator.js +490 -14
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +284 -205
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +671 -553
- package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +165 -165
- package/sdk/platform/Cart/CartPlatformApplicationValidator.js +108 -132
- package/sdk/platform/Cart/CartPlatformModel.d.ts +3136 -4788
- package/sdk/platform/Cart/CartPlatformModel.js +2850 -2031
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +1015 -419
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +6450 -2010
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +1121 -230
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +919 -127
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +372 -574
- package/sdk/platform/Catalog/CatalogPlatformClient.js +1238 -1317
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +8351 -9825
- package/sdk/platform/Catalog/CatalogPlatformModel.js +9662 -6881
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +288 -235
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +241 -183
- package/sdk/platform/Common/CommonPlatformClient.d.ts +5 -6
- package/sdk/platform/Common/CommonPlatformClient.js +5 -6
- package/sdk/platform/Common/CommonPlatformModel.d.ts +9 -9
- package/sdk/platform/Common/CommonPlatformModel.js +6 -6
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +374 -234
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +875 -583
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +170 -139
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +145 -126
- package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +56 -3
- package/sdk/platform/Communication/CommunicationPlatformClient.js +307 -4
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +424 -252
- package/sdk/platform/Communication/CommunicationPlatformModel.js +540 -320
- package/sdk/platform/Communication/CommunicationPlatformValidator.d.ts +62 -3
- package/sdk/platform/Communication/CommunicationPlatformValidator.js +48 -2
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +68 -99
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +84 -140
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +238 -256
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +222 -244
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +20 -20
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +20 -20
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +333 -118
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +1470 -409
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +158 -55
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +163 -41
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +151 -61
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +595 -101
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +1199 -462
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +1008 -321
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +80 -34
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +79 -24
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +253 -140
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +1087 -458
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +221 -178
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +220 -157
- package/sdk/platform/Content/ContentPlatformClient.d.ts +124 -123
- package/sdk/platform/Content/ContentPlatformClient.js +459 -379
- package/sdk/platform/Content/ContentPlatformModel.d.ts +833 -1307
- package/sdk/platform/Content/ContentPlatformModel.js +893 -582
- package/sdk/platform/Content/ContentPlatformValidator.d.ts +140 -150
- package/sdk/platform/Content/ContentPlatformValidator.js +131 -135
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +60 -36
- package/sdk/platform/Discount/DiscountPlatformClient.js +85 -36
- package/sdk/platform/Discount/DiscountPlatformModel.d.ts +46 -47
- package/sdk/platform/Discount/DiscountPlatformModel.js +42 -46
- package/sdk/platform/Discount/DiscountPlatformValidator.d.ts +2 -2
- package/sdk/platform/Discount/DiscountPlatformValidator.js +2 -2
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +18 -15
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +24 -22
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +4 -4
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +4 -4
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +8 -8
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +8 -8
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +75 -86
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +60 -74
- 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 +2895 -0
- package/sdk/platform/Finance/FinancePlatformModel.js +2150 -0
- package/sdk/platform/Finance/FinancePlatformValidator.d.ts +284 -0
- package/sdk/platform/Finance/FinancePlatformValidator.js +354 -0
- package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +17 -17
- package/sdk/platform/Lead/LeadPlatformApplicationClient.js +33 -33
- package/sdk/platform/Lead/LeadPlatformApplicationValidator.d.ts +19 -19
- package/sdk/platform/Lead/LeadPlatformApplicationValidator.js +14 -14
- package/sdk/platform/Lead/LeadPlatformClient.d.ts +4 -24
- package/sdk/platform/Lead/LeadPlatformClient.js +4 -160
- package/sdk/platform/Lead/LeadPlatformModel.d.ts +142 -57
- package/sdk/platform/Lead/LeadPlatformModel.js +162 -79
- package/sdk/platform/Lead/LeadPlatformValidator.d.ts +3 -29
- package/sdk/platform/Lead/LeadPlatformValidator.js +2 -28
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +94 -25
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +600 -57
- package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +115 -115
- package/sdk/platform/Order/OrderPlatformApplicationValidator.js +120 -43
- package/sdk/platform/Order/OrderPlatformClient.d.ts +502 -293
- package/sdk/platform/Order/OrderPlatformClient.js +1466 -913
- package/sdk/platform/Order/OrderPlatformModel.d.ts +4111 -9093
- package/sdk/platform/Order/OrderPlatformModel.js +3202 -4230
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +445 -612
- package/sdk/platform/Order/OrderPlatformValidator.js +316 -326
- 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 +7 -7
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +382 -135
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +2453 -935
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +306 -93
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +305 -70
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +66 -56
- package/sdk/platform/Payment/PaymentPlatformClient.js +269 -124
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +3525 -1313
- package/sdk/platform/Payment/PaymentPlatformModel.js +3813 -1511
- package/sdk/platform/Payment/PaymentPlatformValidator.d.ts +64 -35
- package/sdk/platform/Payment/PaymentPlatformValidator.js +60 -34
- 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 +14 -9
- package/sdk/platform/Rewards/RewardsPlatformModel.js +10 -8
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +344 -56
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +2180 -302
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +380 -54
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +336 -37
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +127 -213
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +538 -1306
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +3429 -2979
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +3642 -1785
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +218 -392
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +151 -290
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +4 -16
- package/sdk/platform/Share/SharePlatformApplicationClient.js +8 -86
- package/sdk/platform/Share/SharePlatformApplicationValidator.d.ts +6 -23
- package/sdk/platform/Share/SharePlatformApplicationValidator.js +3 -16
- package/sdk/platform/Share/SharePlatformModel.d.ts +6 -50
- package/sdk/platform/Share/SharePlatformModel.js +3 -43
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +26 -4
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +157 -10
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +21 -10
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +23 -6
- package/sdk/platform/Theme/ThemePlatformClient.d.ts +18 -8
- package/sdk/platform/Theme/ThemePlatformClient.js +85 -8
- package/sdk/platform/Theme/ThemePlatformModel.d.ts +425 -17
- package/sdk/platform/Theme/ThemePlatformModel.js +329 -23
- package/sdk/platform/Theme/ThemePlatformValidator.d.ts +7 -3
- package/sdk/platform/Theme/ThemePlatformValidator.js +9 -2
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +22 -12
- package/sdk/platform/User/UserPlatformApplicationClient.js +91 -12
- package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +15 -3
- package/sdk/platform/User/UserPlatformApplicationValidator.js +14 -2
- package/sdk/platform/User/UserPlatformModel.d.ts +223 -59
- package/sdk/platform/User/UserPlatformModel.js +204 -65
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +78 -25
- package/sdk/platform/Webhook/WebhookPlatformClient.js +470 -75
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +434 -758
- package/sdk/platform/Webhook/WebhookPlatformModel.js +395 -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/Billing/BillingPublicClient.d.ts +56 -0
- package/sdk/public/Billing/BillingPublicClient.js +397 -0
- package/sdk/public/Billing/BillingPublicModel.d.ts +919 -0
- package/sdk/public/Billing/BillingPublicModel.js +560 -0
- package/sdk/public/Billing/BillingPublicValidator.d.ts +43 -0
- package/sdk/public/Billing/BillingPublicValidator.js +50 -0
- package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +14 -4
- package/sdk/public/Configuration/ConfigurationPublicClient.js +97 -9
- package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +102 -40
- package/sdk/public/Configuration/ConfigurationPublicModel.js +111 -29
- package/sdk/public/Configuration/ConfigurationPublicValidator.d.ts +11 -1
- package/sdk/public/Configuration/ConfigurationPublicValidator.js +12 -0
- package/sdk/public/Content/ContentPublicClient.d.ts +22 -0
- package/sdk/public/Content/ContentPublicClient.js +183 -0
- package/sdk/public/Content/ContentPublicModel.d.ts +38 -1
- package/sdk/public/Content/ContentPublicModel.js +47 -1
- package/sdk/public/Content/ContentPublicValidator.d.ts +17 -1
- package/sdk/public/Content/ContentPublicValidator.js +19 -0
- package/sdk/public/PublicClient.d.ts +2 -2
- package/sdk/public/PublicClient.js +2 -2
- package/sdk/public/Webhook/WebhookPublicClient.d.ts +8 -8
- package/sdk/public/Webhook/WebhookPublicClient.js +8 -8
- package/sdk/public/Webhook/WebhookPublicModel.d.ts +67 -215
- package/sdk/public/Webhook/WebhookPublicModel.js +61 -66
- package/sdk/public/Webhook/WebhookPublicValidator.d.ts +4 -4
- package/sdk/public/Webhook/WebhookPublicValidator.js +4 -4
- package/sdk/public/index.d.ts +1 -1
- package/sdk/public/index.js +1 -1
- package/sdk/application/Finance/FinanceApplicationClient.d.ts +0 -29
- package/sdk/application/Finance/FinanceApplicationClient.js +0 -126
- package/sdk/public/Catalog/CatalogPublicClient.d.ts +0 -22
- package/sdk/public/Catalog/CatalogPublicClient.js +0 -138
- package/sdk/public/Catalog/CatalogPublicModel.d.ts +0 -155
- package/sdk/public/Catalog/CatalogPublicModel.js +0 -116
- package/sdk/public/Catalog/CatalogPublicValidator.d.ts +0 -55
- package/sdk/public/Catalog/CatalogPublicValidator.js +0 -35
|
@@ -7,266 +7,372 @@ declare class Payment {
|
|
|
7
7
|
* @param {PaymentPlatformApplicationValidator.AddEdcDeviceParam} arg - Arg object
|
|
8
8
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
9
9
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
10
|
-
* @returns {Promise<PaymentPlatformModel.
|
|
10
|
+
* @returns {Promise<PaymentPlatformModel.EdcDeviceUpdateResponse>} - Success response
|
|
11
11
|
* @name addEdcDevice
|
|
12
12
|
* @summary: Create an EDC device
|
|
13
13
|
* @description: Registration and addition of a new EDC device to the system - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/addEdcDevice/).
|
|
14
14
|
*/
|
|
15
|
-
addEdcDevice({ terminalUniqueIdentifier, body, requestHeaders }?: PaymentPlatformApplicationValidator.AddEdcDeviceParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.
|
|
15
|
+
addEdcDevice({ terminalUniqueIdentifier, body, requestHeaders }?: PaymentPlatformApplicationValidator.AddEdcDeviceParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.EdcDeviceUpdateResponse>;
|
|
16
|
+
/**
|
|
17
|
+
* @param {PaymentPlatformApplicationValidator.AddRefundBankAccountParam} arg
|
|
18
|
+
* - Arg object
|
|
19
|
+
*
|
|
20
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
21
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
22
|
+
* @returns {Promise<PaymentPlatformModel.RefundAccountResponse>} - Success response
|
|
23
|
+
* @name addRefundBankAccount
|
|
24
|
+
* @summary: Save bank details for cancelled/returned order
|
|
25
|
+
* @description: save bank details for returned/cancelled order to refund amount in his account. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/addRefundBankAccount/).
|
|
26
|
+
*/
|
|
27
|
+
addRefundBankAccount({ body, requestHeaders }?: PaymentPlatformApplicationValidator.AddRefundBankAccountParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.RefundAccountResponse>;
|
|
16
28
|
/**
|
|
17
29
|
* @param {PaymentPlatformApplicationValidator.AddRefundBankAccountUsingOTPParam} arg
|
|
18
30
|
* - Arg object
|
|
19
31
|
*
|
|
20
32
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
21
33
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
22
|
-
* @returns {Promise<PaymentPlatformModel.
|
|
34
|
+
* @returns {Promise<PaymentPlatformModel.RefundAccountResponse>} - Success response
|
|
23
35
|
* @name addRefundBankAccountUsingOTP
|
|
24
36
|
* @summary: Create refund account
|
|
25
|
-
* @description: The addition of a bank account specifically for refunds, employing OTP verification for security - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/addRefundBankAccountUsingOTP/).
|
|
37
|
+
* @description: The addition of a bank account specifically for refunds, employing OTP verification for security - Payment - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/addRefundBankAccountUsingOTP/).
|
|
26
38
|
*/
|
|
27
|
-
addRefundBankAccountUsingOTP({ body, requestHeaders }?: PaymentPlatformApplicationValidator.AddRefundBankAccountUsingOTPParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.
|
|
39
|
+
addRefundBankAccountUsingOTP({ body, requestHeaders }?: PaymentPlatformApplicationValidator.AddRefundBankAccountUsingOTPParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.RefundAccountResponse>;
|
|
28
40
|
/**
|
|
29
41
|
* @param {PaymentPlatformApplicationValidator.CancelPaymentLinkParam} arg
|
|
30
42
|
* - Arg object
|
|
31
43
|
*
|
|
32
44
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
33
45
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
34
|
-
* @returns {Promise<PaymentPlatformModel.
|
|
46
|
+
* @returns {Promise<PaymentPlatformModel.CancelPaymentLinkResponse>} -
|
|
35
47
|
* Success response
|
|
36
48
|
* @name cancelPaymentLink
|
|
37
|
-
* @summary: Cancel payment link
|
|
49
|
+
* @summary: Cancel payment link.
|
|
38
50
|
* @description: Deactivate and cancel a payment link. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/cancelPaymentLink/).
|
|
39
51
|
*/
|
|
40
|
-
cancelPaymentLink({ body, requestHeaders }?: PaymentPlatformApplicationValidator.CancelPaymentLinkParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.
|
|
52
|
+
cancelPaymentLink({ body, requestHeaders }?: PaymentPlatformApplicationValidator.CancelPaymentLinkParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.CancelPaymentLinkResponse>;
|
|
41
53
|
/**
|
|
42
54
|
* @param {PaymentPlatformApplicationValidator.CheckAndUpdatePaymentStatusParam} arg
|
|
43
55
|
* - Arg object
|
|
44
56
|
*
|
|
45
57
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
46
58
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
47
|
-
* @returns {Promise<PaymentPlatformModel.
|
|
59
|
+
* @returns {Promise<PaymentPlatformModel.PaymentStatusUpdateResponse>} -
|
|
48
60
|
* Success response
|
|
49
61
|
* @name checkAndUpdatePaymentStatus
|
|
50
|
-
* @summary:
|
|
62
|
+
* @summary: Check and update payment status.
|
|
51
63
|
* @description: Polling process to confirm the payment status. It periodically checks and updates the current status of a payment, ensuring timely and accurate confirmation of payment transactions. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/checkAndUpdatePaymentStatus/).
|
|
52
64
|
*/
|
|
53
|
-
checkAndUpdatePaymentStatus({ body, requestHeaders }?: PaymentPlatformApplicationValidator.CheckAndUpdatePaymentStatusParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.
|
|
65
|
+
checkAndUpdatePaymentStatus({ body, requestHeaders }?: PaymentPlatformApplicationValidator.CheckAndUpdatePaymentStatusParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.PaymentStatusUpdateResponse>;
|
|
54
66
|
/**
|
|
55
67
|
* @param {PaymentPlatformApplicationValidator.ConfirmPaymentParam} arg - Arg object
|
|
56
68
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
57
69
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
58
|
-
* @returns {Promise<PaymentPlatformModel.
|
|
70
|
+
* @returns {Promise<PaymentPlatformModel.PaymentConfirmationResponse>} -
|
|
59
71
|
* Success response
|
|
60
72
|
* @name confirmPayment
|
|
61
73
|
* @summary: Payment confirmation
|
|
62
74
|
* @description: Authentication and confirmation of a payment.It requires details such as the order ID and payment methods in the request body to authenticate and confirm the payment. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/confirmPayment/).
|
|
63
75
|
*/
|
|
64
|
-
confirmPayment({ body, requestHeaders }?: PaymentPlatformApplicationValidator.ConfirmPaymentParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.
|
|
76
|
+
confirmPayment({ body, requestHeaders }?: PaymentPlatformApplicationValidator.ConfirmPaymentParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.PaymentConfirmationResponse>;
|
|
77
|
+
/**
|
|
78
|
+
* @param {PaymentPlatformApplicationValidator.CopyConfigAggPaymentModesParam} arg
|
|
79
|
+
* - Arg object
|
|
80
|
+
*
|
|
81
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
82
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
83
|
+
* @returns {Promise<PaymentPlatformModel.AggregatorConfigResponse>} -
|
|
84
|
+
* Success response
|
|
85
|
+
* @name copyConfigAggPaymentModes
|
|
86
|
+
* @summary: Copy aggregator config of onc device to another.
|
|
87
|
+
* @description: Copy aggregator config like Wallet, NB, paylater from one device of an aggregator like razorpay to another device. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/copyConfigAggPaymentModes/).
|
|
88
|
+
*/
|
|
89
|
+
copyConfigAggPaymentModes({ aggregatorId, body, requestHeaders }?: PaymentPlatformApplicationValidator.CopyConfigAggPaymentModesParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.AggregatorConfigResponse>;
|
|
90
|
+
/**
|
|
91
|
+
* @param {PaymentPlatformApplicationValidator.CopyConfigPaymentModesParam} arg
|
|
92
|
+
* - Arg object
|
|
93
|
+
*
|
|
94
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
95
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
96
|
+
* @returns {Promise<PaymentPlatformModel.AggregatorConfigResponse>} -
|
|
97
|
+
* Success response
|
|
98
|
+
* @name copyConfigPaymentModes
|
|
99
|
+
* @summary: Copy payment mode config of onc device to another.
|
|
100
|
+
* @description: Copy aggregator config like Wallet, NB, paylater from one device of an aggregator like razorpay to another device. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/copyConfigPaymentModes/).
|
|
101
|
+
*/
|
|
102
|
+
copyConfigPaymentModes({ body, requestHeaders }?: PaymentPlatformApplicationValidator.CopyConfigPaymentModesParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.AggregatorConfigResponse>;
|
|
65
103
|
/**
|
|
66
104
|
* @param {PaymentPlatformApplicationValidator.CreateMerchantRefundPriorityParam} arg
|
|
67
105
|
* - Arg object
|
|
68
106
|
*
|
|
69
107
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
70
108
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
71
|
-
* @returns {Promise<PaymentPlatformModel.
|
|
109
|
+
* @returns {Promise<PaymentPlatformModel.RefundPriorityResponseSerializer>}
|
|
110
|
+
* - Success response
|
|
111
|
+
*
|
|
72
112
|
* @name createMerchantRefundPriority
|
|
73
113
|
* @summary: Create merchant refund priority
|
|
74
114
|
* @description: Create merchant refund priority configurations, with the provided refund sources priority details, and return the status of the operation. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/createMerchantRefundPriority/).
|
|
75
115
|
*/
|
|
76
|
-
createMerchantRefundPriority({ configType, body, requestHeaders }?: PaymentPlatformApplicationValidator.CreateMerchantRefundPriorityParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.
|
|
116
|
+
createMerchantRefundPriority({ configType, businessUnit, body, requestHeaders }?: PaymentPlatformApplicationValidator.CreateMerchantRefundPriorityParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.RefundPriorityResponseSerializer>;
|
|
77
117
|
/**
|
|
78
118
|
* @param {PaymentPlatformApplicationValidator.CreatePaymentLinkParam} arg
|
|
79
119
|
* - Arg object
|
|
80
120
|
*
|
|
81
121
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
82
122
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
83
|
-
* @returns {Promise<PaymentPlatformModel.
|
|
123
|
+
* @returns {Promise<PaymentPlatformModel.CreatePaymentLinkResponse>} -
|
|
84
124
|
* Success response
|
|
85
125
|
* @name createPaymentLink
|
|
86
|
-
* @summary: Create payment link
|
|
126
|
+
* @summary: Create payment link.
|
|
87
127
|
* @description: Generate a payment link for accepting payments. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/createPaymentLink/).
|
|
88
128
|
*/
|
|
89
|
-
createPaymentLink({ body, requestHeaders }?: PaymentPlatformApplicationValidator.CreatePaymentLinkParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.
|
|
129
|
+
createPaymentLink({ body, requestHeaders }?: PaymentPlatformApplicationValidator.CreatePaymentLinkParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.CreatePaymentLinkResponse>;
|
|
90
130
|
/**
|
|
91
131
|
* @param {PaymentPlatformApplicationValidator.CreatePaymentOrderParam} arg
|
|
92
132
|
* - Arg object
|
|
93
133
|
*
|
|
94
134
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
95
135
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
96
|
-
* @returns {Promise<PaymentPlatformModel.
|
|
136
|
+
* @returns {Promise<PaymentPlatformModel.PaymentOrderResponse>} - Success response
|
|
97
137
|
* @name createPaymentOrder
|
|
98
138
|
* @summary: Create Order
|
|
99
139
|
* @description: Create an order and payment on the aggregator side - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/createPaymentOrder/).
|
|
100
140
|
*/
|
|
101
|
-
createPaymentOrder({ body, requestHeaders }?: PaymentPlatformApplicationValidator.CreatePaymentOrderParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.
|
|
141
|
+
createPaymentOrder({ body, requestHeaders }?: PaymentPlatformApplicationValidator.CreatePaymentOrderParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.PaymentOrderResponse>;
|
|
142
|
+
/**
|
|
143
|
+
* @param {PaymentPlatformApplicationValidator.DeleteBeneficiaryDetailsParam} arg
|
|
144
|
+
* - Arg object
|
|
145
|
+
*
|
|
146
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
147
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
148
|
+
* @returns {Promise<PaymentPlatformModel.DeleteRefundAccountResponse>} -
|
|
149
|
+
* Success response
|
|
150
|
+
* @name deleteBeneficiaryDetails
|
|
151
|
+
* @summary: Delete saved beneficiary details of customers
|
|
152
|
+
* @description: Delete the saved beneficiary details provided beneficiary Id. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/deleteBeneficiaryDetails/).
|
|
153
|
+
*/
|
|
154
|
+
deleteBeneficiaryDetails({ body, requestHeaders }?: PaymentPlatformApplicationValidator.DeleteBeneficiaryDetailsParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.DeleteRefundAccountResponse>;
|
|
102
155
|
/**
|
|
103
156
|
* @param {PaymentPlatformApplicationValidator.EdcAggregatorsAndModelListParam} arg
|
|
104
157
|
* - Arg object
|
|
105
158
|
*
|
|
106
159
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
107
160
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
108
|
-
* @returns {Promise<PaymentPlatformModel.
|
|
161
|
+
* @returns {Promise<PaymentPlatformModel.EdcAggregatorAndModelListResponse>}
|
|
109
162
|
* - Success response
|
|
110
163
|
*
|
|
111
164
|
* @name edcAggregatorsAndModelList
|
|
112
|
-
* @summary: EDC aggregators and model list
|
|
165
|
+
* @summary: EDC aggregators and model list.
|
|
113
166
|
* @description: Retrieve a list of EDC (Electronic Data Capture) aggregators and models. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/edcAggregatorsAndModelList/).
|
|
114
167
|
*/
|
|
115
|
-
edcAggregatorsAndModelList({ requestHeaders }?: any, { responseHeaders }?: object): Promise<PaymentPlatformModel.
|
|
168
|
+
edcAggregatorsAndModelList({ requestHeaders }?: any, { responseHeaders }?: object): Promise<PaymentPlatformModel.EdcAggregatorAndModelListResponse>;
|
|
116
169
|
/**
|
|
117
170
|
* @param {PaymentPlatformApplicationValidator.EdcDeviceListParam} arg - Arg object
|
|
118
171
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
119
172
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
120
|
-
* @returns {Promise<PaymentPlatformModel.
|
|
173
|
+
* @returns {Promise<PaymentPlatformModel.EdcDeviceListResponse>} - Success response
|
|
121
174
|
* @name edcDeviceList
|
|
122
175
|
* @summary: List EDC devices
|
|
123
176
|
* @description: Retrieves a list of available Electronic Data Capture (EDC) devices. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/edcDeviceList/).
|
|
124
177
|
*/
|
|
125
|
-
edcDeviceList({ pageNo, pageSize, isActive, storeId, deviceTag, requestHeaders }?: PaymentPlatformApplicationValidator.EdcDeviceListParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.
|
|
178
|
+
edcDeviceList({ pageNo, pageSize, isActive, storeId, deviceTag, requestHeaders }?: PaymentPlatformApplicationValidator.EdcDeviceListParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.EdcDeviceListResponse>;
|
|
126
179
|
/**
|
|
127
180
|
* @param {PaymentPlatformApplicationValidator.EdcDeviceStatsParam} arg - Arg object
|
|
128
181
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
129
182
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
130
|
-
* @returns {Promise<PaymentPlatformModel.
|
|
183
|
+
* @returns {Promise<PaymentPlatformModel.EdcDeviceStatsResponse>} - Success response
|
|
131
184
|
* @name edcDeviceStats
|
|
132
|
-
* @summary: EDC device stats
|
|
185
|
+
* @summary: EDC device stats.
|
|
133
186
|
* @description: Information about EDC (Electronic Data Capture) devices linked to a specific application within a company. It provides statistics such as the count of active and inactive devices. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/edcDeviceStats/).
|
|
134
187
|
*/
|
|
135
|
-
edcDeviceStats({ requestHeaders }?: any, { responseHeaders }?: object): Promise<PaymentPlatformModel.
|
|
188
|
+
edcDeviceStats({ requestHeaders }?: any, { responseHeaders }?: object): Promise<PaymentPlatformModel.EdcDeviceStatsResponse>;
|
|
189
|
+
/**
|
|
190
|
+
* @param {PaymentPlatformApplicationValidator.GetAggregatorCredentialParam} arg
|
|
191
|
+
* - Arg object
|
|
192
|
+
*
|
|
193
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
194
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
195
|
+
* @returns {Promise<PaymentPlatformModel.AggregatorCredentialResponse>} -
|
|
196
|
+
* Success response
|
|
197
|
+
* @name getAggregatorCredential
|
|
198
|
+
* @summary: API to get merchant refund priority
|
|
199
|
+
* @description: API to get merchant refund priority - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/getAggregatorCredential/).
|
|
200
|
+
*/
|
|
201
|
+
getAggregatorCredential({ aggregator, configType, requestHeaders }?: PaymentPlatformApplicationValidator.GetAggregatorCredentialParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.AggregatorCredentialResponse>;
|
|
202
|
+
/**
|
|
203
|
+
* @param {PaymentPlatformApplicationValidator.GetAggregatorCredentialHistoryParam} arg
|
|
204
|
+
* - Arg object
|
|
205
|
+
*
|
|
206
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
207
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
208
|
+
* @returns {Promise<PaymentPlatformModel.AggregatorHistoryResponse>} -
|
|
209
|
+
* Success response
|
|
210
|
+
* @name getAggregatorCredentialHistory
|
|
211
|
+
* @summary: Get merchant refund priority
|
|
212
|
+
* @description: Get merchant refund priority. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/getAggregatorCredentialHistory/).
|
|
213
|
+
*/
|
|
214
|
+
getAggregatorCredentialHistory({ aggregator, configType, requestHeaders }?: PaymentPlatformApplicationValidator.GetAggregatorCredentialHistoryParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.AggregatorHistoryResponse>;
|
|
136
215
|
/**
|
|
137
216
|
* @param {PaymentPlatformApplicationValidator.GetBankAccountDetailsOpenAPIParam} arg
|
|
138
217
|
* - Arg object
|
|
139
218
|
*
|
|
140
219
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
141
220
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
142
|
-
* @returns {Promise<PaymentPlatformModel.
|
|
221
|
+
* @returns {Promise<PaymentPlatformModel.GetRefundAccountResponse>} -
|
|
222
|
+
* Success response
|
|
143
223
|
* @name getBankAccountDetailsOpenAPI
|
|
144
224
|
* @summary: Get bank account details
|
|
145
|
-
* @description: Retrieve bank account information
|
|
225
|
+
* @description: Retrieve bank account information - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/getBankAccountDetailsOpenAPI/).
|
|
146
226
|
*/
|
|
147
|
-
getBankAccountDetailsOpenAPI({ orderId, requestHash, requestHeaders }?: PaymentPlatformApplicationValidator.GetBankAccountDetailsOpenAPIParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.
|
|
227
|
+
getBankAccountDetailsOpenAPI({ orderId, requestHash, requestHeaders }?: PaymentPlatformApplicationValidator.GetBankAccountDetailsOpenAPIParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.GetRefundAccountResponse>;
|
|
148
228
|
/**
|
|
149
229
|
* @param {PaymentPlatformApplicationValidator.GetBrandPaymentGatewayConfigParam} arg
|
|
150
230
|
* - Arg object
|
|
151
231
|
*
|
|
152
232
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
153
233
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
154
|
-
* @returns {Promise<PaymentPlatformModel.
|
|
234
|
+
* @returns {Promise<PaymentPlatformModel.PaymentGatewayConfigResponse>} -
|
|
155
235
|
* Success response
|
|
156
236
|
* @name getBrandPaymentGatewayConfig
|
|
157
237
|
* @summary: Get secrets for brand payment gateway
|
|
158
238
|
* @description: Retrieve configuration settings like key, secret, webhook url, merchant salt for brand payment gateways. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/getBrandPaymentGatewayConfig/).
|
|
159
239
|
*/
|
|
160
|
-
getBrandPaymentGatewayConfig({ aggregator, configType, requestHeaders }?: PaymentPlatformApplicationValidator.GetBrandPaymentGatewayConfigParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.
|
|
240
|
+
getBrandPaymentGatewayConfig({ aggregator, configType, requestHeaders }?: PaymentPlatformApplicationValidator.GetBrandPaymentGatewayConfigParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.PaymentGatewayConfigResponse>;
|
|
241
|
+
/**
|
|
242
|
+
* @param {PaymentPlatformApplicationValidator.GetDevicesParam} arg - Arg object
|
|
243
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
244
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
245
|
+
* @returns {Promise<PaymentPlatformModel.GetDeviceResponse>} - Success response
|
|
246
|
+
* @name getDevices
|
|
247
|
+
* @summary: Get all business units and it's devices.
|
|
248
|
+
* @description: Get all business units and it's devices. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/getDevices/).
|
|
249
|
+
*/
|
|
250
|
+
getDevices({ requestHeaders }?: any, { responseHeaders }?: object): Promise<PaymentPlatformModel.GetDeviceResponse>;
|
|
161
251
|
/**
|
|
162
252
|
* @param {PaymentPlatformApplicationValidator.GetEdcDeviceParam} arg - Arg object
|
|
163
253
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
164
254
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
165
|
-
* @returns {Promise<PaymentPlatformModel.
|
|
255
|
+
* @returns {Promise<PaymentPlatformModel.EdcDeviceDetailsResponse>} -
|
|
256
|
+
* Success response
|
|
166
257
|
* @name getEdcDevice
|
|
167
258
|
* @summary: Get an EDC device
|
|
168
259
|
* @description: Retrieve comprehensive details regarding an Electronic Data Capture (EDC) device associated with a particular terminal unique identifier within a company's application.Upon success, it returns the detailed information of the EDC device, including terminal serial number, EDC device serial number, merchant store POS code, store ID, aggregator ID and name, device tag, activation status, and EDC model. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/getEdcDevice/).
|
|
169
260
|
*/
|
|
170
|
-
getEdcDevice({ terminalUniqueIdentifier, requestHeaders }?: PaymentPlatformApplicationValidator.GetEdcDeviceParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.
|
|
261
|
+
getEdcDevice({ terminalUniqueIdentifier, requestHeaders }?: PaymentPlatformApplicationValidator.GetEdcDeviceParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.EdcDeviceDetailsResponse>;
|
|
171
262
|
/**
|
|
172
263
|
* @param {PaymentPlatformApplicationValidator.GetMerchantAggregatorAppVersionParam} arg
|
|
173
264
|
* - Arg object
|
|
174
265
|
*
|
|
175
266
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
176
267
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
177
|
-
* @returns {Promise<PaymentPlatformModel.
|
|
268
|
+
* @returns {Promise<PaymentPlatformModel.AggregatorVersionResponse>} -
|
|
178
269
|
* Success response
|
|
179
270
|
* @name getMerchantAggregatorAppVersion
|
|
180
271
|
* @summary: Get app version for Aggregator
|
|
181
272
|
* @description: Get app version required for Payment Mode or sub payment mode for an Aggregator.if merchant required any PG payment mode after certain version for mobile app. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/getMerchantAggregatorAppVersion/).
|
|
182
273
|
*/
|
|
183
|
-
getMerchantAggregatorAppVersion({ aggregatorId, businessUnit, device, paymentModeId, subPaymentMode, requestHeaders, }?: PaymentPlatformApplicationValidator.GetMerchantAggregatorAppVersionParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.
|
|
274
|
+
getMerchantAggregatorAppVersion({ aggregatorId, businessUnit, device, paymentModeId, subPaymentMode, requestHeaders, }?: PaymentPlatformApplicationValidator.GetMerchantAggregatorAppVersionParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.AggregatorVersionResponse>;
|
|
184
275
|
/**
|
|
185
276
|
* @param {PaymentPlatformApplicationValidator.GetMerchantAggregatorPaymentModeDetailsParam} arg
|
|
186
277
|
* - Arg object
|
|
187
278
|
*
|
|
188
279
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
189
280
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
190
|
-
* @returns {Promise<PaymentPlatformModel.
|
|
191
|
-
* Success response
|
|
281
|
+
* @returns {Promise<PaymentPlatformModel.AggregatorPlatformPaymentModeResponse>}
|
|
282
|
+
* - Success response
|
|
283
|
+
*
|
|
192
284
|
* @name getMerchantAggregatorPaymentModeDetails
|
|
193
|
-
* @summary: Get merchant aggregator
|
|
194
|
-
* @description:
|
|
285
|
+
* @summary: Get merchant aggregator payment mode details.
|
|
286
|
+
* @description: swagger not found. so operationId not found - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/getMerchantAggregatorPaymentModeDetails/).
|
|
195
287
|
*/
|
|
196
|
-
getMerchantAggregatorPaymentModeDetails({ aggregatorId, businessUnit, device, requestHeaders }?: PaymentPlatformApplicationValidator.GetMerchantAggregatorPaymentModeDetailsParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.
|
|
288
|
+
getMerchantAggregatorPaymentModeDetails({ aggregatorId, businessUnit, device, requestHeaders }?: PaymentPlatformApplicationValidator.GetMerchantAggregatorPaymentModeDetailsParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.AggregatorPlatformPaymentModeResponse>;
|
|
197
289
|
/**
|
|
198
290
|
* @param {PaymentPlatformApplicationValidator.GetMerchantPaymentOptionParam} arg
|
|
199
291
|
* - Arg object
|
|
200
292
|
*
|
|
201
293
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
202
294
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
203
|
-
* @returns {Promise<PaymentPlatformModel.
|
|
204
|
-
* Success response
|
|
295
|
+
* @returns {Promise<PaymentPlatformModel.PlatformOnlineOfflinePaymentResponse>}
|
|
296
|
+
* - Success response
|
|
297
|
+
*
|
|
205
298
|
* @name getMerchantPaymentOption
|
|
206
299
|
* @summary: Get merchant payment option
|
|
207
300
|
* @description: Retrieve available payment gateways and offline payment mode details for a merchant by providing company ID and application ID, returning a list of active payment gateways and their configurations, including online and offline options. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/getMerchantPaymentOption/).
|
|
208
301
|
*/
|
|
209
|
-
getMerchantPaymentOption({ requestHeaders }?:
|
|
302
|
+
getMerchantPaymentOption({ paymentOptionType, requestHeaders }?: PaymentPlatformApplicationValidator.GetMerchantPaymentOptionParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.PlatformOnlineOfflinePaymentResponse>;
|
|
210
303
|
/**
|
|
211
304
|
* @param {PaymentPlatformApplicationValidator.GetMerchantRefundPriorityParam} arg
|
|
212
305
|
* - Arg object
|
|
213
306
|
*
|
|
214
307
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
215
308
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
216
|
-
* @returns {Promise<PaymentPlatformModel.
|
|
309
|
+
* @returns {Promise<PaymentPlatformModel.RefundPriorityResponseSerializer>}
|
|
310
|
+
* - Success response
|
|
311
|
+
*
|
|
217
312
|
* @name getMerchantRefundPriority
|
|
218
313
|
* @summary: Get merchant refund priority
|
|
219
314
|
* @description: Retrieve merchant refund priority configurations, returning the status of the update and the refund sources priority with their descriptions and priorities. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/getMerchantRefundPriority/).
|
|
220
315
|
*/
|
|
221
|
-
getMerchantRefundPriority({ configType, requestHeaders }?: PaymentPlatformApplicationValidator.GetMerchantRefundPriorityParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.
|
|
316
|
+
getMerchantRefundPriority({ configType, businessUnit, requestHeaders }?: PaymentPlatformApplicationValidator.GetMerchantRefundPriorityParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.RefundPriorityResponseSerializer>;
|
|
222
317
|
/**
|
|
223
318
|
* @param {PaymentPlatformApplicationValidator.GetPGConfigAggregatorsParam} arg
|
|
224
319
|
* - Arg object
|
|
225
320
|
*
|
|
226
321
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
227
322
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
228
|
-
* @returns {Promise<PaymentPlatformModel.
|
|
323
|
+
* @returns {Promise<PaymentPlatformModel.AggregatorConfigResponse>} -
|
|
229
324
|
* Success response
|
|
230
325
|
* @name getPGConfigAggregators
|
|
231
326
|
* @summary: Get merchant aggregator payment mode
|
|
232
327
|
* @description: Get payment gateway and it's payment mode and it's sub payment mode details like for razorpay update active/inactive payment modes. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/getPGConfigAggregators/).
|
|
233
328
|
*/
|
|
234
|
-
getPGConfigAggregators({ requestHeaders }?: any, { responseHeaders }?: object): Promise<PaymentPlatformModel.
|
|
329
|
+
getPGConfigAggregators({ requestHeaders }?: any, { responseHeaders }?: object): Promise<PaymentPlatformModel.AggregatorConfigResponse>;
|
|
235
330
|
/**
|
|
236
331
|
* @param {PaymentPlatformApplicationValidator.GetPaymentCodeOptionParam} arg
|
|
237
332
|
* - Arg object
|
|
238
333
|
*
|
|
239
334
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
240
335
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
241
|
-
* @returns {Promise<PaymentPlatformModel.
|
|
336
|
+
* @returns {Promise<PaymentPlatformModel.GetPaymentCodeResponse>} - Success response
|
|
242
337
|
* @name getPaymentCodeOption
|
|
243
338
|
* @summary: Get payment mode codes
|
|
244
339
|
* @description: Enables users to retrieve options for payment codes.users can access information such as payment method names, networks, and associated codes, facilitating seamless integration and management of payment modes - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/getPaymentCodeOption/).
|
|
245
340
|
*/
|
|
246
|
-
getPaymentCodeOption({ requestHeaders }?: any, { responseHeaders }?: object): Promise<PaymentPlatformModel.
|
|
341
|
+
getPaymentCodeOption({ requestHeaders }?: any, { responseHeaders }?: object): Promise<PaymentPlatformModel.GetPaymentCodeResponse>;
|
|
247
342
|
/**
|
|
248
343
|
* @param {PaymentPlatformApplicationValidator.GetPaymentLinkParam} arg - Arg object
|
|
249
344
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
250
345
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
251
|
-
* @returns {Promise<PaymentPlatformModel.
|
|
346
|
+
* @returns {Promise<PaymentPlatformModel.GetPaymentLinkResponse>} - Success response
|
|
252
347
|
* @name getPaymentLink
|
|
253
348
|
* @summary: Get payment link
|
|
254
|
-
* @description: Retrieve a payment link for making payments
|
|
349
|
+
* @description: Retrieve a payment link for making payments - Payment - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/getPaymentLink/).
|
|
255
350
|
*/
|
|
256
|
-
getPaymentLink({ paymentLinkId, requestHeaders }?: PaymentPlatformApplicationValidator.GetPaymentLinkParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.
|
|
351
|
+
getPaymentLink({ paymentLinkId, requestHeaders }?: PaymentPlatformApplicationValidator.GetPaymentLinkParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.GetPaymentLinkResponse>;
|
|
352
|
+
/**
|
|
353
|
+
* @param {PaymentPlatformApplicationValidator.GetPaymentLinkIdParam} arg - Arg object
|
|
354
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
355
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
356
|
+
* @returns {Promise<PaymentPlatformModel.GetPaymentLinkResponse>} - Success response
|
|
357
|
+
* @name getPaymentLinkId
|
|
358
|
+
* @summary: Get payment link
|
|
359
|
+
* @description: get a payment link - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/getPaymentLinkId/).
|
|
360
|
+
*/
|
|
361
|
+
getPaymentLinkId({ id, paymentLinkId, requestHeaders }?: PaymentPlatformApplicationValidator.GetPaymentLinkIdParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.GetPaymentLinkResponse>;
|
|
257
362
|
/**
|
|
258
363
|
* @param {PaymentPlatformApplicationValidator.GetPaymentModeControlRoutesParam} arg
|
|
259
364
|
* - Arg object
|
|
260
365
|
*
|
|
261
366
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
262
367
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
263
|
-
* @returns {Promise<PaymentPlatformModel.
|
|
264
|
-
* Success response
|
|
368
|
+
* @returns {Promise<PaymentPlatformModel.PlatformOfflineAdvanceResponse>}
|
|
369
|
+
* - Success response
|
|
370
|
+
*
|
|
265
371
|
* @name getPaymentModeControlRoutes
|
|
266
372
|
* @summary: Get offline/advance payment mode
|
|
267
373
|
* @description: Get details of offline / advance payment mode like for cod offline payment mode get user level cod limit, order level cod limit, cod charge. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/getPaymentModeControlRoutes/).
|
|
268
374
|
*/
|
|
269
|
-
getPaymentModeControlRoutes({ mode, requestHeaders }?: PaymentPlatformApplicationValidator.GetPaymentModeControlRoutesParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.
|
|
375
|
+
getPaymentModeControlRoutes({ mode, requestHeaders }?: PaymentPlatformApplicationValidator.GetPaymentModeControlRoutesParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.PlatformOfflineAdvanceResponse>;
|
|
270
376
|
/**
|
|
271
377
|
* @param {PaymentPlatformApplicationValidator.GetPaymentModeCustomConfigParam} arg
|
|
272
378
|
* - Arg object
|
|
@@ -287,221 +393,302 @@ declare class Payment {
|
|
|
287
393
|
*
|
|
288
394
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
289
395
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
290
|
-
* @returns {Promise<PaymentPlatformModel.
|
|
396
|
+
* @returns {Promise<PaymentPlatformModel.PaymentOptionsResponse>} - Success response
|
|
291
397
|
* @name getPaymentModeRoutes
|
|
292
398
|
* @summary: Get payment modes
|
|
293
|
-
* @description:
|
|
399
|
+
* @description: Available payment methods on the payment page, specifying the aggregator for each option, such as 'Netbanking powered by Juspay' and 'Card powered by Razorpay'. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/getPaymentModeRoutes/).
|
|
294
400
|
*/
|
|
295
|
-
getPaymentModeRoutes({ refresh, requestType, orderId, shipmentId,
|
|
401
|
+
getPaymentModeRoutes({ refresh, amount, requestType, orderId, shipmentId, requestHeaders }?: PaymentPlatformApplicationValidator.GetPaymentModeRoutesParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.PaymentOptionsResponse>;
|
|
402
|
+
/**
|
|
403
|
+
* @param {PaymentPlatformApplicationValidator.GetPaymentModeSequencingParam} arg
|
|
404
|
+
* - Arg object
|
|
405
|
+
*
|
|
406
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
407
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
408
|
+
* @returns {Promise<PaymentPlatformModel.PaymentModeResponse>} - Success response
|
|
409
|
+
* @name getPaymentModeSequencing
|
|
410
|
+
* @summary: Get details for the active inactive payment modes for merchant
|
|
411
|
+
* @description: get details for the given payment modes and its sequencingfor merchant - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/getPaymentModeSequencing/).
|
|
412
|
+
*/
|
|
413
|
+
getPaymentModeSequencing({ businessUnit, device, requestHeaders }?: PaymentPlatformApplicationValidator.GetPaymentModeSequencingParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.PaymentModeResponse>;
|
|
296
414
|
/**
|
|
297
415
|
* @param {PaymentPlatformApplicationValidator.GetPaymentSessionParam} arg
|
|
298
416
|
* - Arg object
|
|
299
417
|
*
|
|
300
418
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
301
419
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
302
|
-
* @returns {Promise<PaymentPlatformModel.
|
|
420
|
+
* @returns {Promise<PaymentPlatformModel.GetPaymentSessionResponse>} -
|
|
303
421
|
* Success response
|
|
304
422
|
* @name getPaymentSession
|
|
305
423
|
* @summary: Get payment session
|
|
306
424
|
* @description: Allows users to fetch the payment session details associated with a given order ID or transaction ID - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/getPaymentSession/).
|
|
307
425
|
*/
|
|
308
|
-
getPaymentSession({ gid, lineItem, requestHeaders }?: PaymentPlatformApplicationValidator.GetPaymentSessionParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.
|
|
426
|
+
getPaymentSession({ gid, lineItem, requestHeaders }?: PaymentPlatformApplicationValidator.GetPaymentSessionParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.GetPaymentSessionResponse>;
|
|
427
|
+
/**
|
|
428
|
+
* @param {PaymentPlatformApplicationValidator.GetPennyDropValidationParam} arg
|
|
429
|
+
* - Arg object
|
|
430
|
+
*
|
|
431
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
432
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
433
|
+
* @returns {Promise<PaymentPlatformModel.PennyDropValidationResponse>} -
|
|
434
|
+
* Success response
|
|
435
|
+
* @name getPennyDropValidation
|
|
436
|
+
* @summary: pennydrop validation
|
|
437
|
+
* @description: get pennydrop validation for bank account - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/getPennyDropValidation/).
|
|
438
|
+
*/
|
|
439
|
+
getPennyDropValidation({ requestHeaders }?: any, { responseHeaders }?: object): Promise<PaymentPlatformModel.PennyDropValidationResponse>;
|
|
309
440
|
/**
|
|
310
441
|
* @param {PaymentPlatformApplicationValidator.GetPosPaymentModeRoutesParam} arg
|
|
311
442
|
* - Arg object
|
|
312
443
|
*
|
|
313
444
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
314
445
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
315
|
-
* @returns {Promise<PaymentPlatformModel.
|
|
446
|
+
* @returns {Promise<PaymentPlatformModel.PaymentModeRouteResponse>} -
|
|
447
|
+
* Success response
|
|
316
448
|
* @name getPosPaymentModeRoutes
|
|
317
449
|
* @summary: List POS payment modes
|
|
318
|
-
* @description:
|
|
450
|
+
* @description: Retrieve payment options and aggregator for point-of-sale (POS). - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/getPosPaymentModeRoutes/).
|
|
451
|
+
*/
|
|
452
|
+
getPosPaymentModeRoutes({ amount, pincode, orderType, cartId, checkoutMode, refresh, orderId, cardReference, userDetails, displaySplit, advancePayment, shipmentId, requestHeaders, }?: PaymentPlatformApplicationValidator.GetPosPaymentModeRoutesParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.PaymentModeRouteResponse>;
|
|
453
|
+
/**
|
|
454
|
+
* @param {PaymentPlatformApplicationValidator.GetSelectedRefundOptionParam} arg
|
|
455
|
+
* - Arg object
|
|
456
|
+
*
|
|
457
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
458
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
459
|
+
* @returns {Promise<PaymentPlatformModel.SelectedRefundOptionResponse>} -
|
|
460
|
+
* Success response
|
|
461
|
+
* @name getSelectedRefundOption
|
|
462
|
+
* @summary: get the selected refund options for shipment id
|
|
463
|
+
* @description: get the selected refund options for shipment id - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/getSelectedRefundOption/).
|
|
464
|
+
*/
|
|
465
|
+
getSelectedRefundOption({ shipmentId, orderId, requestHeaders }?: PaymentPlatformApplicationValidator.GetSelectedRefundOptionParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.SelectedRefundOptionResponse>;
|
|
466
|
+
/**
|
|
467
|
+
* @param {PaymentPlatformApplicationValidator.GetShipmentBeneficiaryParam} arg
|
|
468
|
+
* - Arg object
|
|
469
|
+
*
|
|
470
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
471
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
472
|
+
* @returns {Promise<PaymentPlatformModel.ShipmentBeneficiaryDetailsResponse>}
|
|
473
|
+
* - Success response
|
|
474
|
+
*
|
|
475
|
+
* @name getShipmentBeneficiary
|
|
476
|
+
* @summary: get beneficiary details
|
|
477
|
+
* @description: get beneficiary details - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/getShipmentBeneficiary/).
|
|
319
478
|
*/
|
|
320
|
-
|
|
479
|
+
getShipmentBeneficiary({ shipmentId, requestHeaders }?: PaymentPlatformApplicationValidator.GetShipmentBeneficiaryParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.ShipmentBeneficiaryDetailsResponse>;
|
|
321
480
|
/**
|
|
322
481
|
* @param {PaymentPlatformApplicationValidator.GetUserBeneficiariesParam} arg
|
|
323
482
|
* - Arg object
|
|
324
483
|
*
|
|
325
484
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
326
485
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
327
|
-
* @returns {Promise<PaymentPlatformModel.
|
|
486
|
+
* @returns {Promise<PaymentPlatformModel.OrderBeneficiaryResponse>} -
|
|
328
487
|
* Success response
|
|
329
488
|
* @name getUserBeneficiaries
|
|
330
|
-
* @summary: Get user beneficiaries
|
|
489
|
+
* @summary: Get user beneficiaries.
|
|
331
490
|
* @description: Retrieves information about beneficiaries associated with the user for processing refunds, based on the provided order ID - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/getUserBeneficiaries/).
|
|
332
491
|
*/
|
|
333
|
-
getUserBeneficiaries({ orderId, requestHeaders }?: PaymentPlatformApplicationValidator.GetUserBeneficiariesParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.
|
|
492
|
+
getUserBeneficiaries({ orderId, requestHeaders }?: PaymentPlatformApplicationValidator.GetUserBeneficiariesParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.OrderBeneficiaryResponse>;
|
|
493
|
+
/**
|
|
494
|
+
* @param {PaymentPlatformApplicationValidator.GetUserBeneficiariesDetailV2Param} arg
|
|
495
|
+
* - Arg object
|
|
496
|
+
*
|
|
497
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
498
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
499
|
+
* @returns {Promise<PaymentPlatformModel.OrderBeneficiaryResponseSchemaV2>}
|
|
500
|
+
* - Success response
|
|
501
|
+
*
|
|
502
|
+
* @name getUserBeneficiariesDetailV2
|
|
503
|
+
* @summary: Lists the beneficiary of a refund
|
|
504
|
+
* @description: get the details of all active beneficiary added by a user for refund. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/getUserBeneficiariesDetailV2/).
|
|
505
|
+
*/
|
|
506
|
+
getUserBeneficiariesDetailV2({ orderId, shipmentId, mop, requestHeaders }?: PaymentPlatformApplicationValidator.GetUserBeneficiariesDetailV2Param, { responseHeaders }?: object): Promise<PaymentPlatformModel.OrderBeneficiaryResponseSchemaV2>;
|
|
334
507
|
/**
|
|
335
508
|
* @param {PaymentPlatformApplicationValidator.GetUserCODlimitRoutesParam} arg
|
|
336
509
|
* - Arg object
|
|
337
510
|
*
|
|
338
511
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
339
512
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
340
|
-
* @returns {Promise<PaymentPlatformModel.
|
|
513
|
+
* @returns {Promise<PaymentPlatformModel.GetUserCODLimitResponse>} - Success response
|
|
341
514
|
* @name getUserCODlimitRoutes
|
|
342
|
-
* @summary: Get user COD
|
|
343
|
-
* @description: Retrieve user cod limt data of user i.e cod is active or not for user and remaining limit
|
|
515
|
+
* @summary: Get user COD.
|
|
516
|
+
* @description: Retrieve user cod limt data of user i.e cod is active or not for user and remaining limit - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/getUserCODlimitRoutes/).
|
|
344
517
|
*/
|
|
345
|
-
getUserCODlimitRoutes({ merchantUserId, mobileNo, requestHeaders }?: PaymentPlatformApplicationValidator.GetUserCODlimitRoutesParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.
|
|
518
|
+
getUserCODlimitRoutes({ merchantUserId, mobileNo, requestHeaders }?: PaymentPlatformApplicationValidator.GetUserCODlimitRoutesParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.GetUserCODLimitResponse>;
|
|
346
519
|
/**
|
|
347
520
|
* @param {PaymentPlatformApplicationValidator.GetUserOrderBeneficiariesParam} arg
|
|
348
521
|
* - Arg object
|
|
349
522
|
*
|
|
350
523
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
351
524
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
352
|
-
* @returns {Promise<PaymentPlatformModel.
|
|
525
|
+
* @returns {Promise<PaymentPlatformModel.OrderBeneficiaryResponse>} -
|
|
353
526
|
* Success response
|
|
354
527
|
* @name getUserOrderBeneficiaries
|
|
355
528
|
* @summary: Get user order beneficiaries
|
|
356
|
-
* @description: Retrieve beneficiary details like bank name , ifsc code , branch name associated with a specific order for refund processing
|
|
529
|
+
* @description: Retrieve beneficiary details like bank name , ifsc code , branch name associated with a specific order for refund processing - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/getUserOrderBeneficiaries/).
|
|
357
530
|
*/
|
|
358
|
-
getUserOrderBeneficiaries({ orderId, requestHeaders }?: PaymentPlatformApplicationValidator.GetUserOrderBeneficiariesParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.
|
|
531
|
+
getUserOrderBeneficiaries({ orderId, requestHeaders }?: PaymentPlatformApplicationValidator.GetUserOrderBeneficiariesParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.OrderBeneficiaryResponse>;
|
|
359
532
|
/**
|
|
360
533
|
* @param {PaymentPlatformApplicationValidator.InitialisePaymentParam} arg
|
|
361
534
|
* - Arg object
|
|
362
535
|
*
|
|
363
536
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
364
537
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
365
|
-
* @returns {Promise<PaymentPlatformModel.
|
|
538
|
+
* @returns {Promise<PaymentPlatformModel.PaymentInitializationResponse>} -
|
|
366
539
|
* Success response
|
|
367
540
|
* @name initialisePayment
|
|
368
541
|
* @summary: Start payment process
|
|
369
542
|
* @description: Initiates the payment procedure for an order.Upon successful initiation, it returns a details including the success status, aggregator information, payment method, status, merchant order ID aggregator order , polling URL, timeout, virtual ID, Razorpay payment ID, customer ID, and device ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/initialisePayment/).
|
|
370
543
|
*/
|
|
371
|
-
initialisePayment({ body, requestHeaders }?: PaymentPlatformApplicationValidator.InitialisePaymentParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.
|
|
544
|
+
initialisePayment({ body, requestHeaders }?: PaymentPlatformApplicationValidator.InitialisePaymentParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.PaymentInitializationResponse>;
|
|
372
545
|
/**
|
|
373
546
|
* @param {PaymentPlatformApplicationValidator.MerchantOnBoardingParam} arg
|
|
374
547
|
* - Arg object
|
|
375
548
|
*
|
|
376
549
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
377
550
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
378
|
-
* @returns {Promise<PaymentPlatformModel.
|
|
551
|
+
* @returns {Promise<PaymentPlatformModel.MerchantOnBoardingResponse>} -
|
|
379
552
|
* Success response
|
|
380
553
|
* @name merchantOnBoarding
|
|
381
|
-
* @summary: Merchant onboarding for BNPL
|
|
554
|
+
* @summary: Merchant onboarding for BNPL.
|
|
382
555
|
* @description: Initiate the merchant onboarding process for Buy Now Pay Later (BNPL). - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/merchantOnBoarding/).
|
|
383
556
|
*/
|
|
384
|
-
merchantOnBoarding({ body, requestHeaders }?: PaymentPlatformApplicationValidator.MerchantOnBoardingParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.
|
|
557
|
+
merchantOnBoarding({ body, requestHeaders }?: PaymentPlatformApplicationValidator.MerchantOnBoardingParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.MerchantOnBoardingResponse>;
|
|
385
558
|
/**
|
|
386
559
|
* @param {PaymentPlatformApplicationValidator.OauthGetUrlParam} arg - Arg object
|
|
387
560
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
388
561
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
389
|
-
* @returns {Promise<PaymentPlatformModel.
|
|
562
|
+
* @returns {Promise<PaymentPlatformModel.GetOauthUrlResponse>} - Success response
|
|
390
563
|
* @name oauthGetUrl
|
|
391
|
-
* @summary: Get OAuth URL
|
|
564
|
+
* @summary: Get OAuth URL.
|
|
392
565
|
* @description: This has been used when merchant is setup their razorpay payment gateway, they will redirect to razorpay site after submitting all their secrets for authetication. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/oauthGetUrl/).
|
|
393
566
|
*/
|
|
394
|
-
oauthGetUrl({ aggregator, successRedirectUrl, failureRedirectUrl, requestHeaders }?: PaymentPlatformApplicationValidator.OauthGetUrlParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.
|
|
567
|
+
oauthGetUrl({ aggregator, successRedirectUrl, failureRedirectUrl, requestHeaders }?: PaymentPlatformApplicationValidator.OauthGetUrlParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.GetOauthUrlResponse>;
|
|
395
568
|
/**
|
|
396
569
|
* @param {PaymentPlatformApplicationValidator.PatchMerchantAggregatorPaymentModeDetailsParam} arg
|
|
397
570
|
* - Arg object
|
|
398
571
|
*
|
|
399
572
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
400
573
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
401
|
-
* @returns {Promise<PaymentPlatformModel.
|
|
574
|
+
* @returns {Promise<PaymentPlatformModel.PlatformPaymentModeResponse>} -
|
|
402
575
|
* Success response
|
|
403
576
|
* @name patchMerchantAggregatorPaymentModeDetails
|
|
404
577
|
* @summary: Update merchant aggregator payment mode
|
|
405
578
|
* @description: update payment gateway and it's payment mode and it's sub payment mode details like for razorpay update active/inactive payment modes. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/patchMerchantAggregatorPaymentModeDetails/).
|
|
406
579
|
*/
|
|
407
|
-
patchMerchantAggregatorPaymentModeDetails({ aggregatorId, body, requestHeaders }?: PaymentPlatformApplicationValidator.PatchMerchantAggregatorPaymentModeDetailsParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.
|
|
580
|
+
patchMerchantAggregatorPaymentModeDetails({ aggregatorId, body, requestHeaders }?: PaymentPlatformApplicationValidator.PatchMerchantAggregatorPaymentModeDetailsParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.PlatformPaymentModeResponse>;
|
|
408
581
|
/**
|
|
409
582
|
* @param {PaymentPlatformApplicationValidator.PatchMerchantPaymentOptionParam} arg
|
|
410
583
|
* - Arg object
|
|
411
584
|
*
|
|
412
585
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
413
586
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
414
|
-
* @returns {Promise<PaymentPlatformModel.
|
|
415
|
-
* Success response
|
|
587
|
+
* @returns {Promise<PaymentPlatformModel.PatchPlatformOnlineOfflinePaymentResponse>}
|
|
588
|
+
* - Success response
|
|
589
|
+
*
|
|
416
590
|
* @name patchMerchantPaymentOption
|
|
417
591
|
* @summary: Update payment gateways and payment mode
|
|
418
592
|
* @description: Updated online/offline payment as active/inactive like disable offline payment mode will disable offline payment modes on checkout page on merchant's website - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/patchMerchantPaymentOption/).
|
|
419
593
|
*/
|
|
420
|
-
patchMerchantPaymentOption({ body, requestHeaders }?: PaymentPlatformApplicationValidator.PatchMerchantPaymentOptionParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.
|
|
594
|
+
patchMerchantPaymentOption({ body, requestHeaders }?: PaymentPlatformApplicationValidator.PatchMerchantPaymentOptionParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.PatchPlatformOnlineOfflinePaymentResponse>;
|
|
421
595
|
/**
|
|
422
596
|
* @param {PaymentPlatformApplicationValidator.PatchMerchantPaymentOptionVersionParam} arg
|
|
423
597
|
* - Arg object
|
|
424
598
|
*
|
|
425
599
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
426
600
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
427
|
-
* @returns {Promise<PaymentPlatformModel.
|
|
601
|
+
* @returns {Promise<PaymentPlatformModel.AggregatorConfigResponse>} -
|
|
428
602
|
* Success response
|
|
429
603
|
* @name patchMerchantPaymentOptionVersion
|
|
430
|
-
* @summary: Update app version for
|
|
604
|
+
* @summary: Update app version required for Aggregator.
|
|
431
605
|
* @description: Update app version required for Payment Mode or sub payment mode for an Aggregator.if merchant required any PG payment mode after certain version for mobile app. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/patchMerchantPaymentOptionVersion/).
|
|
432
606
|
*/
|
|
433
|
-
patchMerchantPaymentOptionVersion({ aggregatorId, body, requestHeaders }?: PaymentPlatformApplicationValidator.PatchMerchantPaymentOptionVersionParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.
|
|
607
|
+
patchMerchantPaymentOptionVersion({ aggregatorId, body, requestHeaders }?: PaymentPlatformApplicationValidator.PatchMerchantPaymentOptionVersionParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.AggregatorConfigResponse>;
|
|
608
|
+
/**
|
|
609
|
+
* @param {PaymentPlatformApplicationValidator.PatchPaymentModeSequencingParam} arg
|
|
610
|
+
* - Arg object
|
|
611
|
+
*
|
|
612
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
613
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
614
|
+
* @returns {Promise<PaymentPlatformModel.AggregatorConfigResponse>} -
|
|
615
|
+
* Success response
|
|
616
|
+
* @name patchPaymentModeSequencing
|
|
617
|
+
* @summary: Update sequencing of payment modes for the merchant
|
|
618
|
+
* @description: Update sequencing of payment modes for the merchant - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/patchPaymentModeSequencing/).
|
|
619
|
+
*/
|
|
620
|
+
patchPaymentModeSequencing({ body, requestHeaders }?: PaymentPlatformApplicationValidator.PatchPaymentModeSequencingParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.AggregatorConfigResponse>;
|
|
434
621
|
/**
|
|
435
622
|
* @param {PaymentPlatformApplicationValidator.PaymentStatusBulkParam} arg
|
|
436
623
|
* - Arg object
|
|
437
624
|
*
|
|
438
625
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
439
626
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
440
|
-
* @returns {Promise<PaymentPlatformModel.
|
|
627
|
+
* @returns {Promise<PaymentPlatformModel.PaymentStatusBulkHandlerResponse>}
|
|
441
628
|
* - Success response
|
|
442
629
|
*
|
|
443
630
|
* @name paymentStatusBulk
|
|
444
631
|
* @summary: Retrieve status of multiple payments in bulk
|
|
445
632
|
* @description: Retrieve status of multiple payments in bulk and returns the status of each payment along with associated details such as payment ID, amount, currency, status, payment mode, and payment gateway in the response - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/paymentStatusBulk/).
|
|
446
633
|
*/
|
|
447
|
-
paymentStatusBulk({ body, requestHeaders }?: PaymentPlatformApplicationValidator.PaymentStatusBulkParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.
|
|
634
|
+
paymentStatusBulk({ body, requestHeaders }?: PaymentPlatformApplicationValidator.PaymentStatusBulkParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.PaymentStatusBulkHandlerResponse>;
|
|
448
635
|
/**
|
|
449
636
|
* @param {PaymentPlatformApplicationValidator.PollingPaymentLinkParam} arg
|
|
450
637
|
* - Arg object
|
|
451
638
|
*
|
|
452
639
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
453
640
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
454
|
-
* @returns {Promise<PaymentPlatformModel.
|
|
641
|
+
* @returns {Promise<PaymentPlatformModel.PollingPaymentLinkResponse>} -
|
|
455
642
|
* Success response
|
|
456
643
|
* @name pollingPaymentLink
|
|
457
644
|
* @summary: Poll status of payment link
|
|
458
|
-
* @description: Periodically checks the status of a payment link to monitor for any updates or changes.retrieve real-time information about the payment link's current status, such as whether it has been processed, cancelled, or expired
|
|
645
|
+
* @description: Periodically checks the status of a payment link to monitor for any updates or changes.retrieve real-time information about the payment link's current status, such as whether it has been processed, cancelled, or expired - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/pollingPaymentLink/).
|
|
459
646
|
*/
|
|
460
|
-
pollingPaymentLink({ paymentLinkId, requestHeaders }?: PaymentPlatformApplicationValidator.PollingPaymentLinkParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.
|
|
647
|
+
pollingPaymentLink({ paymentLinkId, requestHeaders }?: PaymentPlatformApplicationValidator.PollingPaymentLinkParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.PollingPaymentLinkResponse>;
|
|
461
648
|
/**
|
|
462
649
|
* @param {PaymentPlatformApplicationValidator.RepaymentDetailsParam} arg - Arg object
|
|
463
650
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
464
651
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
465
|
-
* @returns {Promise<PaymentPlatformModel.
|
|
652
|
+
* @returns {Promise<PaymentPlatformModel.RepaymentResponse>} - Success response
|
|
466
653
|
* @name repaymentDetails
|
|
467
|
-
* @summary: Repayment details for BNPL
|
|
654
|
+
* @summary: Repayment details for BNPL.
|
|
468
655
|
* @description: Retrieve repayment details for Buy Now Pay Later (BNPL) payment - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/repaymentDetails/).
|
|
469
656
|
*/
|
|
470
|
-
repaymentDetails({ body, requestHeaders }?: PaymentPlatformApplicationValidator.RepaymentDetailsParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.
|
|
657
|
+
repaymentDetails({ body, requestHeaders }?: PaymentPlatformApplicationValidator.RepaymentDetailsParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.RepaymentResponse>;
|
|
471
658
|
/**
|
|
472
659
|
* @param {PaymentPlatformApplicationValidator.ResendOrCancelPaymentParam} arg
|
|
473
660
|
* - Arg object
|
|
474
661
|
*
|
|
475
662
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
476
663
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
477
|
-
* @returns {Promise<PaymentPlatformModel.
|
|
664
|
+
* @returns {Promise<PaymentPlatformModel.ResendOrCancelPaymentResponse>} -
|
|
478
665
|
* Success response
|
|
479
666
|
* @name resendOrCancelPayment
|
|
480
|
-
* @summary: Resend or cancel payment
|
|
667
|
+
* @summary: Resend or cancel payment.
|
|
481
668
|
* @description: Enable you to perform actions related to the resending and cancellation of payment links through SMS or EMAIL. resend or cancel payment link that have been initiated but may require modification or cancellation for various reasons, ensuring flexibility and control in payment processing. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/resendOrCancelPayment/).
|
|
482
669
|
*/
|
|
483
|
-
resendOrCancelPayment({ body, requestHeaders }?: PaymentPlatformApplicationValidator.ResendOrCancelPaymentParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.
|
|
670
|
+
resendOrCancelPayment({ body, requestHeaders }?: PaymentPlatformApplicationValidator.ResendOrCancelPaymentParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.ResendOrCancelPaymentResponse>;
|
|
484
671
|
/**
|
|
485
672
|
* @param {PaymentPlatformApplicationValidator.ResendPaymentLinkParam} arg
|
|
486
673
|
* - Arg object
|
|
487
674
|
*
|
|
488
675
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
489
676
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
490
|
-
* @returns {Promise<PaymentPlatformModel.
|
|
677
|
+
* @returns {Promise<PaymentPlatformModel.ResendPaymentLinkResponse>} -
|
|
491
678
|
* Success response
|
|
492
679
|
* @name resendPaymentLink
|
|
493
680
|
* @summary: Resend payment link
|
|
494
|
-
* @description: Resends an existing payment link to the user to complete the payment
|
|
681
|
+
* @description: Resends an existing payment link to the user to complete the payment - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/resendPaymentLink/).
|
|
495
682
|
*/
|
|
496
|
-
resendPaymentLink({ body, requestHeaders }?: PaymentPlatformApplicationValidator.ResendPaymentLinkParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.
|
|
683
|
+
resendPaymentLink({ body, requestHeaders }?: PaymentPlatformApplicationValidator.ResendPaymentLinkParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.ResendPaymentLinkResponse>;
|
|
497
684
|
/**
|
|
498
685
|
* @param {PaymentPlatformApplicationValidator.RevokeOauthTokenParam} arg - Arg object
|
|
499
686
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
500
687
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
501
688
|
* @returns {Promise<PaymentPlatformModel.RevokeOAuthToken>} - Success response
|
|
502
689
|
* @name revokeOauthToken
|
|
503
|
-
* @summary: Revoke OAuth token
|
|
504
|
-
* @description: Revoke the creds for payment aggregator
|
|
690
|
+
* @summary: Revoke OAuth token.
|
|
691
|
+
* @description: Revoke the creds for payment aggregator - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/revokeOauthToken/).
|
|
505
692
|
*/
|
|
506
693
|
revokeOauthToken({ aggregator, requestHeaders }?: PaymentPlatformApplicationValidator.RevokeOauthTokenParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.RevokeOAuthToken>;
|
|
507
694
|
/**
|
|
@@ -513,8 +700,8 @@ declare class Payment {
|
|
|
513
700
|
* @returns {Promise<PaymentPlatformModel.PaymentGatewayToBeReviewed>} -
|
|
514
701
|
* Success response
|
|
515
702
|
* @name saveBrandPaymentGatewayConfig
|
|
516
|
-
* @summary: Save brand payment gateway config
|
|
517
|
-
* @description: Store and update configuration settings for brand payment gateways i.e required for payment for a payment gateway like key, secret, merchant salt. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/saveBrandPaymentGatewayConfig/).
|
|
703
|
+
* @summary: Save brand payment gateway config.
|
|
704
|
+
* @description: Store and update configuration settings for brand payment gateways i.e required for payment for a payment gateway like key, secret, merchant salt. - Payment - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/saveBrandPaymentGatewayConfig/).
|
|
518
705
|
*/
|
|
519
706
|
saveBrandPaymentGatewayConfig({ body, requestHeaders }?: PaymentPlatformApplicationValidator.SaveBrandPaymentGatewayConfigParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.PaymentGatewayToBeReviewed>;
|
|
520
707
|
/**
|
|
@@ -523,13 +710,14 @@ declare class Payment {
|
|
|
523
710
|
*
|
|
524
711
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
525
712
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
526
|
-
* @returns {Promise<PaymentPlatformModel.
|
|
527
|
-
* Success response
|
|
713
|
+
* @returns {Promise<PaymentPlatformModel.PlatformOfflineAdvanceResponse>}
|
|
714
|
+
* - Success response
|
|
715
|
+
*
|
|
528
716
|
* @name setMerchantModeControlRoutes
|
|
529
717
|
* @summary: Update offline payment mode
|
|
530
|
-
* @description: Update
|
|
718
|
+
* @description: Update details of offline / advance payment mode like for cod offline payment mode get user level cod limit, order level cod limit, cod charge. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/setMerchantModeControlRoutes/).
|
|
531
719
|
*/
|
|
532
|
-
setMerchantModeControlRoutes({ mode, body, requestHeaders }?: PaymentPlatformApplicationValidator.SetMerchantModeControlRoutesParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.
|
|
720
|
+
setMerchantModeControlRoutes({ mode, body, requestHeaders }?: PaymentPlatformApplicationValidator.SetMerchantModeControlRoutesParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.PlatformOfflineAdvanceResponse>;
|
|
533
721
|
/**
|
|
534
722
|
* @param {PaymentPlatformApplicationValidator.SetPaymentModeCustomConfigParam} arg
|
|
535
723
|
* - Arg object
|
|
@@ -544,90 +732,149 @@ declare class Payment {
|
|
|
544
732
|
* @description: Allows merchants to modify specific details of advance payment custom configurations tailored to their business requirements. By providing the company ID, application ID, and payment mode, merchants can update settings such as minimum order value, customer restrictions, and available payment modes for both pre-order and post-order transactions - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/setPaymentModeCustomConfig/).
|
|
545
733
|
*/
|
|
546
734
|
setPaymentModeCustomConfig({ mode, body, requestHeaders }?: PaymentPlatformApplicationValidator.SetPaymentModeCustomConfigParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.PaymentCustomConfigResponseSchema>;
|
|
735
|
+
/**
|
|
736
|
+
* @param {PaymentPlatformApplicationValidator.SetRefundOptionforShipmentParam} arg
|
|
737
|
+
* - Arg object
|
|
738
|
+
*
|
|
739
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
740
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
741
|
+
* @returns {Promise<PaymentPlatformModel.ShipmentRefundResponse>} - Success response
|
|
742
|
+
* @name setRefundOptionforShipment
|
|
743
|
+
* @summary: Save refund source against shipment and order
|
|
744
|
+
* @description: Save refund source against shipment and order - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/setRefundOptionforShipment/).
|
|
745
|
+
*/
|
|
746
|
+
setRefundOptionforShipment({ body, requestHeaders }?: PaymentPlatformApplicationValidator.SetRefundOptionforShipmentParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.ShipmentRefundResponse>;
|
|
547
747
|
/**
|
|
548
748
|
* @param {PaymentPlatformApplicationValidator.SetUserCODlimitRoutesParam} arg
|
|
549
749
|
* - Arg object
|
|
550
750
|
*
|
|
551
751
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
552
752
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
553
|
-
* @returns {Promise<PaymentPlatformModel.
|
|
753
|
+
* @returns {Promise<PaymentPlatformModel.GetUserCODLimitResponse>} - Success response
|
|
554
754
|
* @name setUserCODlimitRoutes
|
|
555
755
|
* @summary: Set user COD
|
|
556
756
|
* @description: This allows access to seller to enable disable cod of specific user - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/setUserCODlimitRoutes/).
|
|
557
757
|
*/
|
|
558
|
-
setUserCODlimitRoutes({ body, requestHeaders }?: PaymentPlatformApplicationValidator.SetUserCODlimitRoutesParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.
|
|
758
|
+
setUserCODlimitRoutes({ body, requestHeaders }?: PaymentPlatformApplicationValidator.SetUserCODlimitRoutesParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.GetUserCODLimitResponse>;
|
|
759
|
+
/**
|
|
760
|
+
* @param {PaymentPlatformApplicationValidator.UpdateAggregatorCredentialParam} arg
|
|
761
|
+
* - Arg object
|
|
762
|
+
*
|
|
763
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
764
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
765
|
+
* @returns {Promise<PaymentPlatformModel.PatchAggregatorCredentialResponse>}
|
|
766
|
+
* - Success response
|
|
767
|
+
*
|
|
768
|
+
* @name updateAggregatorCredential
|
|
769
|
+
* @summary: Update Aggregator Credentials
|
|
770
|
+
* @description: - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/updateAggregatorCredential/).
|
|
771
|
+
*/
|
|
772
|
+
updateAggregatorCredential({ body, requestHeaders }?: PaymentPlatformApplicationValidator.UpdateAggregatorCredentialParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.PatchAggregatorCredentialResponse>;
|
|
773
|
+
/**
|
|
774
|
+
* @param {PaymentPlatformApplicationValidator.UpdateDefaultBeneficiaryParam} arg
|
|
775
|
+
* - Arg object
|
|
776
|
+
*
|
|
777
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
778
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
779
|
+
* @returns {Promise<PaymentPlatformModel.SetDefaultBeneficiaryResponse>} -
|
|
780
|
+
* Success response
|
|
781
|
+
* @name updateDefaultBeneficiary
|
|
782
|
+
* @summary: Set a default beneficiary for a refund
|
|
783
|
+
* @description: set a default beneficiary for getting a refund. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/updateDefaultBeneficiary/).
|
|
784
|
+
*/
|
|
785
|
+
updateDefaultBeneficiary({ body, requestHeaders }?: PaymentPlatformApplicationValidator.UpdateDefaultBeneficiaryParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.SetDefaultBeneficiaryResponse>;
|
|
559
786
|
/**
|
|
560
787
|
* @param {PaymentPlatformApplicationValidator.UpdateEdcDeviceParam} arg - Arg object
|
|
561
788
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
562
789
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
563
|
-
* @returns {Promise<PaymentPlatformModel.
|
|
790
|
+
* @returns {Promise<PaymentPlatformModel.EdcDeviceAddResponse>} - Success response
|
|
564
791
|
* @name updateEdcDevice
|
|
565
|
-
* @summary: Update EDC device
|
|
792
|
+
* @summary: Update EDC device.
|
|
566
793
|
* @description: Enables the modification of settings and details associated with an Electronic Data Capture (EDC) device linked to a specific application within a company. Upon success, it returns the updated information of the EDC device. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/updateEdcDevice/).
|
|
567
794
|
*/
|
|
568
|
-
updateEdcDevice({ body, requestHeaders }?: PaymentPlatformApplicationValidator.UpdateEdcDeviceParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.
|
|
795
|
+
updateEdcDevice({ body, requestHeaders }?: PaymentPlatformApplicationValidator.UpdateEdcDeviceParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.EdcDeviceAddResponse>;
|
|
569
796
|
/**
|
|
570
797
|
* @param {PaymentPlatformApplicationValidator.UpdateMerchantRefundPriorityParam} arg
|
|
571
798
|
* - Arg object
|
|
572
799
|
*
|
|
573
800
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
574
801
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
575
|
-
* @returns {Promise<PaymentPlatformModel.
|
|
802
|
+
* @returns {Promise<PaymentPlatformModel.RefundPriorityResponseSerializer>}
|
|
803
|
+
* - Success response
|
|
804
|
+
*
|
|
576
805
|
* @name updateMerchantRefundPriority
|
|
577
806
|
* @summary: Update merchant refund priority
|
|
578
807
|
* @description: Update merchant refund priority configurations, with the provided refund sources priority details, and return the status of the operation. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/updateMerchantRefundPriority/).
|
|
579
808
|
*/
|
|
580
|
-
updateMerchantRefundPriority({ configType, body, requestHeaders }?: PaymentPlatformApplicationValidator.UpdateMerchantRefundPriorityParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.
|
|
809
|
+
updateMerchantRefundPriority({ configType, businessUnit, body, requestHeaders }?: PaymentPlatformApplicationValidator.UpdateMerchantRefundPriorityParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.RefundPriorityResponseSerializer>;
|
|
581
810
|
/**
|
|
582
811
|
* @param {PaymentPlatformApplicationValidator.UpdatePaymentSessionParam} arg
|
|
583
812
|
* - Arg object
|
|
584
813
|
*
|
|
585
814
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
586
815
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
587
|
-
* @returns {Promise<PaymentPlatformModel.
|
|
588
|
-
* Success response
|
|
816
|
+
* @returns {Promise<PaymentPlatformModel.PaymentSessionResponseSerializer>}
|
|
817
|
+
* - Success response
|
|
818
|
+
*
|
|
589
819
|
* @name updatePaymentSession
|
|
590
|
-
* @summary: Update payment session
|
|
820
|
+
* @summary: Update payment session.
|
|
591
821
|
* @description: Update the details of a payment session associated with a given order ID or transaction ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/updatePaymentSession/).
|
|
592
822
|
*/
|
|
593
|
-
updatePaymentSession({ gid, body, requestHeaders }?: PaymentPlatformApplicationValidator.UpdatePaymentSessionParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.
|
|
823
|
+
updatePaymentSession({ gid, body, requestHeaders }?: PaymentPlatformApplicationValidator.UpdatePaymentSessionParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.PaymentSessionResponseSerializer>;
|
|
824
|
+
/**
|
|
825
|
+
* @param {PaymentPlatformApplicationValidator.UpdatePennyDropValidationParam} arg
|
|
826
|
+
* - Arg object
|
|
827
|
+
*
|
|
828
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
829
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
830
|
+
* @returns {Promise<PaymentPlatformModel.PennyDropValidationResponse>} -
|
|
831
|
+
* Success response
|
|
832
|
+
* @name updatePennyDropValidation
|
|
833
|
+
* @summary: update penny drop validation for application ID
|
|
834
|
+
* @description: update penny drop validation for application ID - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/updatePennyDropValidation/).
|
|
835
|
+
*/
|
|
836
|
+
updatePennyDropValidation({ body, requestHeaders }?: PaymentPlatformApplicationValidator.UpdatePennyDropValidationParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.PennyDropValidationResponse>;
|
|
594
837
|
/**
|
|
595
838
|
* @param {PaymentPlatformApplicationValidator.UpdateRefundSessionParam} arg
|
|
596
839
|
* - Arg object
|
|
597
840
|
*
|
|
598
841
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
599
842
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
600
|
-
* @returns {Promise<PaymentPlatformModel.
|
|
843
|
+
* @returns {Promise<PaymentPlatformModel.RefundSessionResponseSerializer>}
|
|
844
|
+
* - Success response
|
|
845
|
+
*
|
|
601
846
|
* @name updateRefundSession
|
|
602
847
|
* @summary: Update refund session
|
|
603
848
|
* @description: Allows users to update the details of a refund session associated with a specific global identifier (GID) and request ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/updateRefundSession/).
|
|
604
849
|
*/
|
|
605
|
-
updateRefundSession({ gid, requestId, body, requestHeaders }?: PaymentPlatformApplicationValidator.UpdateRefundSessionParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.
|
|
850
|
+
updateRefundSession({ gid, requestId, body, requestHeaders }?: PaymentPlatformApplicationValidator.UpdateRefundSessionParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.RefundSessionResponseSerializer>;
|
|
606
851
|
/**
|
|
607
|
-
* @param {PaymentPlatformApplicationValidator.
|
|
852
|
+
* @param {PaymentPlatformApplicationValidator.ValidateBeneficiaryAddressParam} arg
|
|
608
853
|
* - Arg object
|
|
609
854
|
*
|
|
610
855
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
611
856
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
612
|
-
* @returns {Promise<PaymentPlatformModel.
|
|
613
|
-
* Success response
|
|
614
|
-
*
|
|
615
|
-
* @
|
|
616
|
-
* @
|
|
857
|
+
* @returns {Promise<PaymentPlatformModel.ValidateValidateAddressResponse>}
|
|
858
|
+
* - Success response
|
|
859
|
+
*
|
|
860
|
+
* @name validateBeneficiaryAddress
|
|
861
|
+
* @summary: Validate UPI ID and IFSC code
|
|
862
|
+
* @description: Validate UPI ID and IFSC code - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/validateBeneficiaryAddress/).
|
|
617
863
|
*/
|
|
618
|
-
|
|
864
|
+
validateBeneficiaryAddress({ body, requestHeaders }?: PaymentPlatformApplicationValidator.ValidateBeneficiaryAddressParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.ValidateValidateAddressResponse>;
|
|
619
865
|
/**
|
|
620
866
|
* @param {PaymentPlatformApplicationValidator.VerifyCustomerForPaymentParam} arg
|
|
621
867
|
* - Arg object
|
|
622
868
|
*
|
|
623
869
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
624
870
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
625
|
-
* @returns {Promise<PaymentPlatformModel.
|
|
871
|
+
* @returns {Promise<PaymentPlatformModel.ValidateCustomerResponse>} -
|
|
872
|
+
* Success response
|
|
626
873
|
* @name verifyCustomerForPayment
|
|
627
874
|
* @summary: Validate customer for paylater
|
|
628
875
|
* @description: Verify whether the user is eligible for pay-later payment from the payment aggregator's side using the customer's phone number - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/verifyCustomerForPayment/).
|
|
629
876
|
*/
|
|
630
|
-
verifyCustomerForPayment({ body, requestHeaders }?: PaymentPlatformApplicationValidator.VerifyCustomerForPaymentParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.
|
|
877
|
+
verifyCustomerForPayment({ body, requestHeaders }?: PaymentPlatformApplicationValidator.VerifyCustomerForPaymentParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.ValidateCustomerResponse>;
|
|
631
878
|
}
|
|
632
879
|
import PaymentPlatformApplicationValidator = require("./PaymentPlatformApplicationValidator");
|
|
633
880
|
import PaymentPlatformModel = require("./PaymentPlatformModel");
|