@gofynd/fdk-client-javascript 3.1.0-beta.1 → 3.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -1
- package/package.json +2 -2
- package/sdk/application/ApplicationClient.d.ts +2 -0
- package/sdk/application/ApplicationClient.js +2 -0
- package/sdk/application/Cart/CartApplicationClient.d.ts +81 -101
- package/sdk/application/Cart/CartApplicationClient.js +173 -511
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +110 -110
- package/sdk/application/Catalog/CatalogApplicationClient.js +214 -447
- package/sdk/application/Common/CommonApplicationClient.d.ts +4 -4
- package/sdk/application/Common/CommonApplicationClient.js +4 -19
- package/sdk/application/Communication/CommunicationApplicationClient.d.ts +3 -43
- package/sdk/application/Communication/CommunicationApplicationClient.js +4 -214
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +41 -54
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +39 -192
- package/sdk/application/Content/ContentApplicationClient.d.ts +61 -61
- package/sdk/application/Content/ContentApplicationClient.js +183 -366
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +2 -2
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +11 -30
- package/sdk/application/Finance/FinanceApplicationClient.d.ts +29 -0
- package/sdk/application/Finance/FinanceApplicationClient.js +111 -0
- package/sdk/application/Lead/LeadApplicationClient.d.ts +6 -6
- package/sdk/application/Lead/LeadApplicationClient.js +24 -55
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +28 -117
- package/sdk/application/Logistic/LogisticApplicationClient.js +99 -492
- package/sdk/application/Order/OrderApplicationClient.d.ts +31 -51
- package/sdk/application/Order/OrderApplicationClient.js +89 -293
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +108 -218
- package/sdk/application/Payment/PaymentApplicationClient.js +100 -1081
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +14 -14
- package/sdk/application/Rewards/RewardsApplicationClient.js +13 -66
- package/sdk/application/Share/ShareApplicationClient.d.ts +11 -11
- package/sdk/application/Share/ShareApplicationClient.js +35 -89
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +5 -25
- package/sdk/application/Theme/ThemeApplicationClient.js +24 -150
- package/sdk/application/User/UserApplicationClient.d.ts +23 -13
- package/sdk/application/User/UserApplicationClient.js +49 -407
- package/sdk/application/Webhook/WebhookApplicationClient.d.ts +4 -4
- package/sdk/application/Webhook/WebhookApplicationClient.js +4 -11
- package/sdk/common/Utility.d.ts +1 -1
- package/sdk/common/Utility.js +10 -7
- package/sdk/common/Validator.d.ts +1 -0
- package/sdk/common/Validator.js +20 -0
- package/sdk/common/utils.d.ts +0 -1
- package/sdk/common/utils.js +0 -14
- package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +10 -54
- package/sdk/partner/FileStorage/FileStoragePartnerClient.js +32 -364
- package/sdk/partner/FileStorage/FileStoragePartnerModel.d.ts +54 -1
- package/sdk/partner/FileStorage/FileStoragePartnerModel.js +43 -0
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.d.ts +1 -5
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.js +4 -35
- package/sdk/partner/Lead/LeadPartnerClient.d.ts +5 -5
- package/sdk/partner/Lead/LeadPartnerClient.js +4 -4
- package/sdk/partner/Lead/LeadPartnerModel.d.ts +52 -98
- package/sdk/partner/Lead/LeadPartnerModel.js +76 -100
- package/sdk/partner/Lead/LeadPartnerValidator.js +1 -1
- package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +172 -41
- package/sdk/partner/Logistics/LogisticsPartnerClient.js +1222 -85
- package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +1921 -297
- package/sdk/partner/Logistics/LogisticsPartnerModel.js +973 -258
- package/sdk/partner/Logistics/LogisticsPartnerValidator.d.ts +13 -1
- package/sdk/partner/Logistics/LogisticsPartnerValidator.js +148 -16
- package/sdk/partner/PartnerClient.d.ts +0 -6
- package/sdk/partner/PartnerClient.js +0 -9
- package/sdk/partner/Theme/ThemePartnerClient.d.ts +21 -63
- package/sdk/partner/Theme/ThemePartnerClient.js +67 -392
- package/sdk/partner/Theme/ThemePartnerModel.d.ts +72 -104
- package/sdk/partner/Theme/ThemePartnerModel.js +75 -101
- package/sdk/partner/Theme/ThemePartnerValidator.d.ts +1 -5
- package/sdk/partner/Theme/ThemePartnerValidator.js +12 -42
- package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +18 -18
- package/sdk/partner/Webhook/WebhookPartnerClient.js +18 -18
- package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +673 -189
- package/sdk/partner/Webhook/WebhookPartnerModel.js +270 -159
- package/sdk/partner/Webhook/WebhookPartnerValidator.js +3 -3
- package/sdk/partner/index.d.ts +0 -3
- package/sdk/partner/index.js +0 -6
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.d.ts +4 -1
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.js +1 -1
- package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +3 -3
- package/sdk/platform/Analytics/AnalyticsPlatformModel.js +3 -3
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +2 -32
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +3 -243
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +49 -145
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +20 -171
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +1 -39
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.js +0 -35
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +12 -12
- package/sdk/platform/Billing/BillingPlatformClient.js +15 -15
- package/sdk/platform/Billing/BillingPlatformModel.d.ts +443 -388
- package/sdk/platform/Billing/BillingPlatformModel.js +280 -263
- package/sdk/platform/Billing/BillingPlatformValidator.d.ts +16 -18
- package/sdk/platform/Billing/BillingPlatformValidator.js +8 -9
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +172 -251
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +577 -648
- package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +270 -165
- package/sdk/platform/Cart/CartPlatformApplicationValidator.js +192 -108
- package/sdk/platform/Cart/CartPlatformModel.d.ts +4554 -3154
- package/sdk/platform/Cart/CartPlatformModel.js +1935 -2854
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +380 -976
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +2004 -6464
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +161 -1082
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +80 -884
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +568 -325
- package/sdk/platform/Catalog/CatalogPlatformClient.js +1560 -1162
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +9772 -7871
- package/sdk/platform/Catalog/CatalogPlatformModel.js +6978 -9516
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +231 -240
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +180 -188
- package/sdk/platform/Common/CommonPlatformClient.d.ts +6 -5
- package/sdk/platform/Common/CommonPlatformClient.js +6 -5
- package/sdk/platform/Common/CommonPlatformModel.d.ts +19 -25
- package/sdk/platform/Common/CommonPlatformModel.js +11 -14
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +240 -376
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +589 -874
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +139 -170
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +126 -145
- package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +3 -56
- package/sdk/platform/Communication/CommunicationPlatformClient.js +4 -307
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +330 -502
- package/sdk/platform/Communication/CommunicationPlatformModel.js +376 -610
- package/sdk/platform/Communication/CommunicationPlatformValidator.d.ts +3 -62
- package/sdk/platform/Communication/CommunicationPlatformValidator.js +2 -48
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +72 -100
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +88 -146
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +270 -241
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +248 -226
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +20 -31
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +20 -25
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +117 -332
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +409 -1470
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +55 -158
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +41 -163
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +65 -142
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +103 -568
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +562 -1289
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +368 -1037
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +34 -80
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +24 -79
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +302 -248
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +1292 -773
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +330 -218
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +325 -208
- package/sdk/platform/Content/ContentPlatformClient.d.ts +279 -118
- package/sdk/platform/Content/ContentPlatformClient.js +1617 -492
- package/sdk/platform/Content/ContentPlatformModel.d.ts +2391 -924
- package/sdk/platform/Content/ContentPlatformModel.js +1314 -970
- package/sdk/platform/Content/ContentPlatformValidator.d.ts +272 -134
- package/sdk/platform/Content/ContentPlatformValidator.js +295 -118
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +53 -43
- package/sdk/platform/Discount/DiscountPlatformClient.js +53 -43
- package/sdk/platform/Discount/DiscountPlatformModel.d.ts +383 -110
- package/sdk/platform/Discount/DiscountPlatformModel.js +117 -108
- package/sdk/platform/Discount/DiscountPlatformValidator.d.ts +56 -36
- package/sdk/platform/Discount/DiscountPlatformValidator.js +29 -19
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +4 -163
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +4 -1078
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +5 -141
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +4 -177
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +8 -8
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +8 -8
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +30 -1123
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +24 -1135
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +6 -6
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.js +6 -6
- 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 +24 -4
- package/sdk/platform/Lead/LeadPlatformClient.js +160 -4
- package/sdk/platform/Lead/LeadPlatformModel.d.ts +60 -140
- package/sdk/platform/Lead/LeadPlatformModel.js +81 -162
- package/sdk/platform/Lead/LeadPlatformValidator.d.ts +29 -3
- package/sdk/platform/Lead/LeadPlatformValidator.js +28 -2
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +19 -98
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +27 -662
- package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +91 -118
- package/sdk/platform/Order/OrderPlatformApplicationValidator.js +32 -127
- package/sdk/platform/Order/OrderPlatformClient.d.ts +406 -403
- package/sdk/platform/Order/OrderPlatformClient.js +1200 -1343
- package/sdk/platform/Order/OrderPlatformModel.d.ts +8665 -4505
- package/sdk/platform/Order/OrderPlatformModel.js +4088 -3601
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +666 -442
- package/sdk/platform/Order/OrderPlatformValidator.js +353 -312
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +6 -4
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +9 -7
- package/sdk/platform/Partner/PartnerPlatformModel.d.ts +67 -19
- package/sdk/platform/Partner/PartnerPlatformModel.js +26 -17
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +135 -382
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +937 -2452
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +100 -306
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +74 -305
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +56 -66
- package/sdk/platform/Payment/PaymentPlatformClient.js +124 -269
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +1307 -3536
- package/sdk/platform/Payment/PaymentPlatformModel.js +1389 -3692
- package/sdk/platform/Payment/PaymentPlatformValidator.d.ts +35 -64
- package/sdk/platform/Payment/PaymentPlatformValidator.js +34 -60
- package/sdk/platform/PlatformClient.d.ts +0 -2
- package/sdk/platform/PlatformClient.js +0 -4
- 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 +12 -12
- package/sdk/platform/Rewards/RewardsPlatformModel.js +10 -10
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +64 -136
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +111 -521
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +75 -117
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +50 -105
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +160 -149
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +766 -545
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +6196 -3978
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +3181 -3895
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +294 -220
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +205 -149
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +16 -4
- package/sdk/platform/Share/SharePlatformApplicationClient.js +86 -8
- package/sdk/platform/Share/SharePlatformApplicationValidator.d.ts +23 -6
- package/sdk/platform/Share/SharePlatformApplicationValidator.js +16 -3
- package/sdk/platform/Share/SharePlatformModel.d.ts +53 -9
- package/sdk/platform/Share/SharePlatformModel.js +45 -5
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +17 -37
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +66 -204
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +25 -26
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +20 -31
- package/sdk/platform/Theme/ThemePlatformClient.d.ts +8 -18
- package/sdk/platform/Theme/ThemePlatformClient.js +8 -85
- package/sdk/platform/Theme/ThemePlatformModel.d.ts +17 -425
- package/sdk/platform/Theme/ThemePlatformModel.js +23 -329
- package/sdk/platform/Theme/ThemePlatformValidator.d.ts +3 -7
- package/sdk/platform/Theme/ThemePlatformValidator.js +2 -9
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +81 -18
- package/sdk/platform/User/UserPlatformApplicationClient.js +491 -27
- package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +126 -10
- package/sdk/platform/User/UserPlatformApplicationValidator.js +92 -7
- package/sdk/platform/User/UserPlatformModel.d.ts +317 -218
- package/sdk/platform/User/UserPlatformModel.js +253 -210
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +25 -78
- package/sdk/platform/Webhook/WebhookPlatformClient.js +75 -470
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +813 -426
- package/sdk/platform/Webhook/WebhookPlatformModel.js +446 -395
- package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +10 -55
- package/sdk/platform/Webhook/WebhookPlatformValidator.js +12 -72
- package/sdk/platform/index.d.ts +0 -1
- package/sdk/platform/index.js +0 -2
- package/sdk/public/Catalog/CatalogPublicClient.d.ts +22 -0
- package/sdk/public/Catalog/CatalogPublicClient.js +133 -0
- package/sdk/public/Catalog/CatalogPublicModel.d.ts +158 -0
- package/sdk/public/Catalog/CatalogPublicModel.js +116 -0
- package/sdk/public/Catalog/CatalogPublicValidator.d.ts +55 -0
- package/sdk/public/Catalog/CatalogPublicValidator.js +35 -0
- package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +4 -14
- package/sdk/public/Configuration/ConfigurationPublicClient.js +10 -113
- package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +46 -114
- package/sdk/public/Configuration/ConfigurationPublicModel.js +32 -117
- package/sdk/public/Configuration/ConfigurationPublicValidator.d.ts +1 -11
- package/sdk/public/Configuration/ConfigurationPublicValidator.js +0 -12
- package/sdk/public/Content/ContentPublicClient.d.ts +36 -25
- package/sdk/public/Content/ContentPublicClient.js +254 -280
- package/sdk/public/Content/ContentPublicModel.d.ts +151 -38
- package/sdk/public/Content/ContentPublicModel.js +98 -44
- package/sdk/public/Content/ContentPublicValidator.d.ts +18 -17
- package/sdk/public/Content/ContentPublicValidator.js +26 -19
- package/sdk/public/Partner/PartnerPublicClient.d.ts +1 -1
- package/sdk/public/Partner/PartnerPublicClient.js +6 -11
- package/sdk/public/Partner/PartnerPublicModel.d.ts +248 -72
- package/sdk/public/Partner/PartnerPublicModel.js +81 -71
- package/sdk/public/Partner/PartnerPublicValidator.d.ts +2 -2
- package/sdk/public/Partner/PartnerPublicValidator.js +1 -1
- package/sdk/public/PublicClient.d.ts +2 -0
- package/sdk/public/PublicClient.js +4 -0
- package/sdk/public/Webhook/WebhookPublicClient.d.ts +8 -8
- package/sdk/public/Webhook/WebhookPublicClient.js +9 -48
- package/sdk/public/Webhook/WebhookPublicModel.d.ts +215 -67
- package/sdk/public/Webhook/WebhookPublicModel.js +66 -61
- package/sdk/public/Webhook/WebhookPublicValidator.d.ts +4 -4
- package/sdk/public/Webhook/WebhookPublicValidator.js +4 -4
- package/sdk/public/index.d.ts +1 -0
- package/sdk/public/index.js +2 -0
- package/sdk/partner/Authorization/AuthorizationPartnerClient.d.ts +0 -66
- package/sdk/partner/Authorization/AuthorizationPartnerClient.js +0 -431
- package/sdk/partner/Authorization/AuthorizationPartnerModel.d.ts +0 -231
- package/sdk/partner/Authorization/AuthorizationPartnerModel.js +0 -152
- package/sdk/partner/Authorization/AuthorizationPartnerValidator.d.ts +0 -8
- package/sdk/partner/Authorization/AuthorizationPartnerValidator.js +0 -39
- package/sdk/partner/Catalog/CatalogPartnerClient.d.ts +0 -26
- package/sdk/partner/Catalog/CatalogPartnerClient.js +0 -173
- package/sdk/partner/Catalog/CatalogPartnerModel.d.ts +0 -238
- package/sdk/partner/Catalog/CatalogPartnerModel.js +0 -248
- package/sdk/partner/Catalog/CatalogPartnerValidator.d.ts +0 -5
- package/sdk/partner/Catalog/CatalogPartnerValidator.js +0 -19
- package/sdk/partner/Payment/PaymentPartnerClient.d.ts +0 -116
- package/sdk/partner/Payment/PaymentPartnerClient.js +0 -857
- package/sdk/partner/Payment/PaymentPartnerModel.d.ts +0 -388
- package/sdk/partner/Payment/PaymentPartnerModel.js +0 -442
- package/sdk/partner/Payment/PaymentPartnerValidator.d.ts +0 -14
- package/sdk/partner/Payment/PaymentPartnerValidator.js +0 -74
- package/sdk/platform/Finance/FinancePlatformClient.d.ts +0 -320
- package/sdk/platform/Finance/FinancePlatformClient.js +0 -2333
- package/sdk/platform/Finance/FinancePlatformModel.d.ts +0 -2895
- package/sdk/platform/Finance/FinancePlatformModel.js +0 -2150
- package/sdk/platform/Finance/FinancePlatformValidator.d.ts +0 -284
- package/sdk/platform/Finance/FinancePlatformValidator.js +0 -354
|
@@ -7,372 +7,266 @@ 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.EdcDeviceUpdateDetails>} - 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.
|
|
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>;
|
|
15
|
+
addEdcDevice({ terminalUniqueIdentifier, body, requestHeaders }?: PaymentPlatformApplicationValidator.AddEdcDeviceParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.EdcDeviceUpdateDetails>;
|
|
28
16
|
/**
|
|
29
17
|
* @param {PaymentPlatformApplicationValidator.AddRefundBankAccountUsingOTPParam} arg
|
|
30
18
|
* - Arg object
|
|
31
19
|
*
|
|
32
20
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
33
21
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
34
|
-
* @returns {Promise<PaymentPlatformModel.
|
|
22
|
+
* @returns {Promise<PaymentPlatformModel.RefundAccountDetails>} - Success response
|
|
35
23
|
* @name addRefundBankAccountUsingOTP
|
|
36
24
|
* @summary: Create refund account
|
|
37
|
-
* @description: The addition of a bank account specifically for refunds, employing OTP verification for security -
|
|
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/).
|
|
38
26
|
*/
|
|
39
|
-
addRefundBankAccountUsingOTP({ body, requestHeaders }?: PaymentPlatformApplicationValidator.AddRefundBankAccountUsingOTPParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.
|
|
27
|
+
addRefundBankAccountUsingOTP({ body, requestHeaders }?: PaymentPlatformApplicationValidator.AddRefundBankAccountUsingOTPParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.RefundAccountDetails>;
|
|
40
28
|
/**
|
|
41
29
|
* @param {PaymentPlatformApplicationValidator.CancelPaymentLinkParam} arg
|
|
42
30
|
* - Arg object
|
|
43
31
|
*
|
|
44
32
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
45
33
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
46
|
-
* @returns {Promise<PaymentPlatformModel.
|
|
34
|
+
* @returns {Promise<PaymentPlatformModel.CancelPaymentLinkDetails>} -
|
|
47
35
|
* Success response
|
|
48
36
|
* @name cancelPaymentLink
|
|
49
|
-
* @summary: Cancel payment link
|
|
37
|
+
* @summary: Cancel payment link
|
|
50
38
|
* @description: Deactivate and cancel a payment link. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/cancelPaymentLink/).
|
|
51
39
|
*/
|
|
52
|
-
cancelPaymentLink({ body, requestHeaders }?: PaymentPlatformApplicationValidator.CancelPaymentLinkParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.
|
|
40
|
+
cancelPaymentLink({ body, requestHeaders }?: PaymentPlatformApplicationValidator.CancelPaymentLinkParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.CancelPaymentLinkDetails>;
|
|
53
41
|
/**
|
|
54
42
|
* @param {PaymentPlatformApplicationValidator.CheckAndUpdatePaymentStatusParam} arg
|
|
55
43
|
* - Arg object
|
|
56
44
|
*
|
|
57
45
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
58
46
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
59
|
-
* @returns {Promise<PaymentPlatformModel.
|
|
47
|
+
* @returns {Promise<PaymentPlatformModel.PaymentStatusUpdateDetails>} -
|
|
60
48
|
* Success response
|
|
61
49
|
* @name checkAndUpdatePaymentStatus
|
|
62
|
-
* @summary:
|
|
50
|
+
* @summary: Poll and update payment status
|
|
63
51
|
* @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/).
|
|
64
52
|
*/
|
|
65
|
-
checkAndUpdatePaymentStatus({ body, requestHeaders }?: PaymentPlatformApplicationValidator.CheckAndUpdatePaymentStatusParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.
|
|
53
|
+
checkAndUpdatePaymentStatus({ body, requestHeaders }?: PaymentPlatformApplicationValidator.CheckAndUpdatePaymentStatusParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.PaymentStatusUpdateDetails>;
|
|
66
54
|
/**
|
|
67
55
|
* @param {PaymentPlatformApplicationValidator.ConfirmPaymentParam} arg - Arg object
|
|
68
56
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
69
57
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
70
|
-
* @returns {Promise<PaymentPlatformModel.
|
|
58
|
+
* @returns {Promise<PaymentPlatformModel.PaymentConfirmationDetails>} -
|
|
71
59
|
* Success response
|
|
72
60
|
* @name confirmPayment
|
|
73
61
|
* @summary: Payment confirmation
|
|
74
62
|
* @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/).
|
|
75
63
|
*/
|
|
76
|
-
confirmPayment({ body, requestHeaders }?: PaymentPlatformApplicationValidator.ConfirmPaymentParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.
|
|
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>;
|
|
64
|
+
confirmPayment({ body, requestHeaders }?: PaymentPlatformApplicationValidator.ConfirmPaymentParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.PaymentConfirmationDetails>;
|
|
103
65
|
/**
|
|
104
66
|
* @param {PaymentPlatformApplicationValidator.CreateMerchantRefundPriorityParam} arg
|
|
105
67
|
* - Arg object
|
|
106
68
|
*
|
|
107
69
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
108
70
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
109
|
-
* @returns {Promise<PaymentPlatformModel.
|
|
110
|
-
* - Success response
|
|
111
|
-
*
|
|
71
|
+
* @returns {Promise<PaymentPlatformModel.RefundPriorityDetails>} - Success response
|
|
112
72
|
* @name createMerchantRefundPriority
|
|
113
73
|
* @summary: Create merchant refund priority
|
|
114
74
|
* @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/).
|
|
115
75
|
*/
|
|
116
|
-
createMerchantRefundPriority({ configType,
|
|
76
|
+
createMerchantRefundPriority({ configType, body, requestHeaders }?: PaymentPlatformApplicationValidator.CreateMerchantRefundPriorityParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.RefundPriorityDetails>;
|
|
117
77
|
/**
|
|
118
78
|
* @param {PaymentPlatformApplicationValidator.CreatePaymentLinkParam} arg
|
|
119
79
|
* - Arg object
|
|
120
80
|
*
|
|
121
81
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
122
82
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
123
|
-
* @returns {Promise<PaymentPlatformModel.
|
|
83
|
+
* @returns {Promise<PaymentPlatformModel.CreatePaymentLinkDetails>} -
|
|
124
84
|
* Success response
|
|
125
85
|
* @name createPaymentLink
|
|
126
|
-
* @summary: Create payment link
|
|
86
|
+
* @summary: Create payment link
|
|
127
87
|
* @description: Generate a payment link for accepting payments. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/createPaymentLink/).
|
|
128
88
|
*/
|
|
129
|
-
createPaymentLink({ body, requestHeaders }?: PaymentPlatformApplicationValidator.CreatePaymentLinkParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.
|
|
89
|
+
createPaymentLink({ body, requestHeaders }?: PaymentPlatformApplicationValidator.CreatePaymentLinkParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.CreatePaymentLinkDetails>;
|
|
130
90
|
/**
|
|
131
91
|
* @param {PaymentPlatformApplicationValidator.CreatePaymentOrderParam} arg
|
|
132
92
|
* - Arg object
|
|
133
93
|
*
|
|
134
94
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
135
95
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
136
|
-
* @returns {Promise<PaymentPlatformModel.
|
|
96
|
+
* @returns {Promise<PaymentPlatformModel.PaymentOrderDetails>} - Success response
|
|
137
97
|
* @name createPaymentOrder
|
|
138
98
|
* @summary: Create Order
|
|
139
99
|
* @description: Create an order and payment on the aggregator side - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/createPaymentOrder/).
|
|
140
100
|
*/
|
|
141
|
-
createPaymentOrder({ body, requestHeaders }?: PaymentPlatformApplicationValidator.CreatePaymentOrderParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.
|
|
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>;
|
|
101
|
+
createPaymentOrder({ body, requestHeaders }?: PaymentPlatformApplicationValidator.CreatePaymentOrderParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.PaymentOrderDetails>;
|
|
155
102
|
/**
|
|
156
103
|
* @param {PaymentPlatformApplicationValidator.EdcAggregatorsAndModelListParam} arg
|
|
157
104
|
* - Arg object
|
|
158
105
|
*
|
|
159
106
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
160
107
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
161
|
-
* @returns {Promise<PaymentPlatformModel.
|
|
108
|
+
* @returns {Promise<PaymentPlatformModel.EdcAggregatorAndModelListDetails>}
|
|
162
109
|
* - Success response
|
|
163
110
|
*
|
|
164
111
|
* @name edcAggregatorsAndModelList
|
|
165
|
-
* @summary: EDC aggregators and model list
|
|
112
|
+
* @summary: EDC aggregators and model list
|
|
166
113
|
* @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/).
|
|
167
114
|
*/
|
|
168
|
-
edcAggregatorsAndModelList({ requestHeaders }?: any, { responseHeaders }?: object): Promise<PaymentPlatformModel.
|
|
115
|
+
edcAggregatorsAndModelList({ requestHeaders }?: any, { responseHeaders }?: object): Promise<PaymentPlatformModel.EdcAggregatorAndModelListDetails>;
|
|
169
116
|
/**
|
|
170
117
|
* @param {PaymentPlatformApplicationValidator.EdcDeviceListParam} arg - Arg object
|
|
171
118
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
172
119
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
173
|
-
* @returns {Promise<PaymentPlatformModel.
|
|
120
|
+
* @returns {Promise<PaymentPlatformModel.EdcDeviceListDetails>} - Success response
|
|
174
121
|
* @name edcDeviceList
|
|
175
122
|
* @summary: List EDC devices
|
|
176
123
|
* @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/).
|
|
177
124
|
*/
|
|
178
|
-
edcDeviceList({ pageNo, pageSize, isActive, storeId, deviceTag, requestHeaders }?: PaymentPlatformApplicationValidator.EdcDeviceListParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.
|
|
125
|
+
edcDeviceList({ pageNo, pageSize, isActive, storeId, deviceTag, requestHeaders }?: PaymentPlatformApplicationValidator.EdcDeviceListParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.EdcDeviceListDetails>;
|
|
179
126
|
/**
|
|
180
127
|
* @param {PaymentPlatformApplicationValidator.EdcDeviceStatsParam} arg - Arg object
|
|
181
128
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
182
129
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
183
|
-
* @returns {Promise<PaymentPlatformModel.
|
|
130
|
+
* @returns {Promise<PaymentPlatformModel.EdcDeviceStatsDetails>} - Success response
|
|
184
131
|
* @name edcDeviceStats
|
|
185
|
-
* @summary: EDC device stats
|
|
132
|
+
* @summary: EDC device stats
|
|
186
133
|
* @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/).
|
|
187
134
|
*/
|
|
188
|
-
edcDeviceStats({ requestHeaders }?: any, { responseHeaders }?: object): Promise<PaymentPlatformModel.
|
|
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>;
|
|
135
|
+
edcDeviceStats({ requestHeaders }?: any, { responseHeaders }?: object): Promise<PaymentPlatformModel.EdcDeviceStatsDetails>;
|
|
215
136
|
/**
|
|
216
137
|
* @param {PaymentPlatformApplicationValidator.GetBankAccountDetailsOpenAPIParam} arg
|
|
217
138
|
* - Arg object
|
|
218
139
|
*
|
|
219
140
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
220
141
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
221
|
-
* @returns {Promise<PaymentPlatformModel.
|
|
222
|
-
* Success response
|
|
142
|
+
* @returns {Promise<PaymentPlatformModel.RefundAccountDetails>} - Success response
|
|
223
143
|
* @name getBankAccountDetailsOpenAPI
|
|
224
144
|
* @summary: Get bank account details
|
|
225
|
-
* @description: Retrieve bank account information
|
|
145
|
+
* @description: Retrieve bank account information - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/getBankAccountDetailsOpenAPI/).
|
|
226
146
|
*/
|
|
227
|
-
getBankAccountDetailsOpenAPI({ orderId, requestHash, requestHeaders }?: PaymentPlatformApplicationValidator.GetBankAccountDetailsOpenAPIParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.
|
|
147
|
+
getBankAccountDetailsOpenAPI({ orderId, requestHash, requestHeaders }?: PaymentPlatformApplicationValidator.GetBankAccountDetailsOpenAPIParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.RefundAccountDetails>;
|
|
228
148
|
/**
|
|
229
149
|
* @param {PaymentPlatformApplicationValidator.GetBrandPaymentGatewayConfigParam} arg
|
|
230
150
|
* - Arg object
|
|
231
151
|
*
|
|
232
152
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
233
153
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
234
|
-
* @returns {Promise<PaymentPlatformModel.
|
|
154
|
+
* @returns {Promise<PaymentPlatformModel.PaymentGatewayConfigDetails>} -
|
|
235
155
|
* Success response
|
|
236
156
|
* @name getBrandPaymentGatewayConfig
|
|
237
157
|
* @summary: Get secrets for brand payment gateway
|
|
238
158
|
* @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/).
|
|
239
159
|
*/
|
|
240
|
-
getBrandPaymentGatewayConfig({ aggregator, configType, requestHeaders }?: PaymentPlatformApplicationValidator.GetBrandPaymentGatewayConfigParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.
|
|
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>;
|
|
160
|
+
getBrandPaymentGatewayConfig({ aggregator, configType, requestHeaders }?: PaymentPlatformApplicationValidator.GetBrandPaymentGatewayConfigParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.PaymentGatewayConfigDetails>;
|
|
251
161
|
/**
|
|
252
162
|
* @param {PaymentPlatformApplicationValidator.GetEdcDeviceParam} arg - Arg object
|
|
253
163
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
254
164
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
255
|
-
* @returns {Promise<PaymentPlatformModel.
|
|
256
|
-
* Success response
|
|
165
|
+
* @returns {Promise<PaymentPlatformModel.EdcDeviceDetails>} - Success response
|
|
257
166
|
* @name getEdcDevice
|
|
258
167
|
* @summary: Get an EDC device
|
|
259
168
|
* @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/).
|
|
260
169
|
*/
|
|
261
|
-
getEdcDevice({ terminalUniqueIdentifier, requestHeaders }?: PaymentPlatformApplicationValidator.GetEdcDeviceParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.
|
|
170
|
+
getEdcDevice({ terminalUniqueIdentifier, requestHeaders }?: PaymentPlatformApplicationValidator.GetEdcDeviceParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.EdcDeviceDetails>;
|
|
262
171
|
/**
|
|
263
172
|
* @param {PaymentPlatformApplicationValidator.GetMerchantAggregatorAppVersionParam} arg
|
|
264
173
|
* - Arg object
|
|
265
174
|
*
|
|
266
175
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
267
176
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
268
|
-
* @returns {Promise<PaymentPlatformModel.
|
|
177
|
+
* @returns {Promise<PaymentPlatformModel.AggregatorVersionDetails>} -
|
|
269
178
|
* Success response
|
|
270
179
|
* @name getMerchantAggregatorAppVersion
|
|
271
180
|
* @summary: Get app version for Aggregator
|
|
272
181
|
* @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/).
|
|
273
182
|
*/
|
|
274
|
-
getMerchantAggregatorAppVersion({ aggregatorId, businessUnit, device, paymentModeId, subPaymentMode, requestHeaders, }?: PaymentPlatformApplicationValidator.GetMerchantAggregatorAppVersionParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.
|
|
183
|
+
getMerchantAggregatorAppVersion({ aggregatorId, businessUnit, device, paymentModeId, subPaymentMode, requestHeaders, }?: PaymentPlatformApplicationValidator.GetMerchantAggregatorAppVersionParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.AggregatorVersionDetails>;
|
|
275
184
|
/**
|
|
276
185
|
* @param {PaymentPlatformApplicationValidator.GetMerchantAggregatorPaymentModeDetailsParam} arg
|
|
277
186
|
* - Arg object
|
|
278
187
|
*
|
|
279
188
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
280
189
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
281
|
-
* @returns {Promise<PaymentPlatformModel.
|
|
282
|
-
*
|
|
283
|
-
*
|
|
190
|
+
* @returns {Promise<PaymentPlatformModel.PlatformPaymentModeDetails>} -
|
|
191
|
+
* Success response
|
|
284
192
|
* @name getMerchantAggregatorPaymentModeDetails
|
|
285
|
-
* @summary: Get merchant aggregator payment mode
|
|
286
|
-
* @description:
|
|
193
|
+
* @summary: Get merchant aggregator and their payment mode
|
|
194
|
+
* @description: Get available payment gateways and payment mode and it's sub payment mode details like for razorpay their active/inactive payment modes netbanking , wallet, upi are shown. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/getMerchantAggregatorPaymentModeDetails/).
|
|
287
195
|
*/
|
|
288
|
-
getMerchantAggregatorPaymentModeDetails({ aggregatorId, businessUnit, device, requestHeaders }?: PaymentPlatformApplicationValidator.GetMerchantAggregatorPaymentModeDetailsParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.
|
|
196
|
+
getMerchantAggregatorPaymentModeDetails({ aggregatorId, businessUnit, device, requestHeaders }?: PaymentPlatformApplicationValidator.GetMerchantAggregatorPaymentModeDetailsParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.PlatformPaymentModeDetails>;
|
|
289
197
|
/**
|
|
290
198
|
* @param {PaymentPlatformApplicationValidator.GetMerchantPaymentOptionParam} arg
|
|
291
199
|
* - Arg object
|
|
292
200
|
*
|
|
293
201
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
294
202
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
295
|
-
* @returns {Promise<PaymentPlatformModel.
|
|
296
|
-
*
|
|
297
|
-
*
|
|
203
|
+
* @returns {Promise<PaymentPlatformModel.PlatformPaymentModeDetails>} -
|
|
204
|
+
* Success response
|
|
298
205
|
* @name getMerchantPaymentOption
|
|
299
206
|
* @summary: Get merchant payment option
|
|
300
207
|
* @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/).
|
|
301
208
|
*/
|
|
302
|
-
getMerchantPaymentOption({
|
|
209
|
+
getMerchantPaymentOption({ requestHeaders }?: any, { responseHeaders }?: object): Promise<PaymentPlatformModel.PlatformPaymentModeDetails>;
|
|
303
210
|
/**
|
|
304
211
|
* @param {PaymentPlatformApplicationValidator.GetMerchantRefundPriorityParam} arg
|
|
305
212
|
* - Arg object
|
|
306
213
|
*
|
|
307
214
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
308
215
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
309
|
-
* @returns {Promise<PaymentPlatformModel.
|
|
310
|
-
* - Success response
|
|
311
|
-
*
|
|
216
|
+
* @returns {Promise<PaymentPlatformModel.RefundPriorityDetails>} - Success response
|
|
312
217
|
* @name getMerchantRefundPriority
|
|
313
218
|
* @summary: Get merchant refund priority
|
|
314
219
|
* @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/).
|
|
315
220
|
*/
|
|
316
|
-
getMerchantRefundPriority({ configType,
|
|
221
|
+
getMerchantRefundPriority({ configType, requestHeaders }?: PaymentPlatformApplicationValidator.GetMerchantRefundPriorityParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.RefundPriorityDetails>;
|
|
317
222
|
/**
|
|
318
223
|
* @param {PaymentPlatformApplicationValidator.GetPGConfigAggregatorsParam} arg
|
|
319
224
|
* - Arg object
|
|
320
225
|
*
|
|
321
226
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
322
227
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
323
|
-
* @returns {Promise<PaymentPlatformModel.
|
|
228
|
+
* @returns {Promise<PaymentPlatformModel.PlatformPaymentModeDetails>} -
|
|
324
229
|
* Success response
|
|
325
230
|
* @name getPGConfigAggregators
|
|
326
231
|
* @summary: Get merchant aggregator payment mode
|
|
327
232
|
* @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/).
|
|
328
233
|
*/
|
|
329
|
-
getPGConfigAggregators({ requestHeaders }?: any, { responseHeaders }?: object): Promise<PaymentPlatformModel.
|
|
234
|
+
getPGConfigAggregators({ requestHeaders }?: any, { responseHeaders }?: object): Promise<PaymentPlatformModel.PlatformPaymentModeDetails>;
|
|
330
235
|
/**
|
|
331
236
|
* @param {PaymentPlatformApplicationValidator.GetPaymentCodeOptionParam} arg
|
|
332
237
|
* - Arg object
|
|
333
238
|
*
|
|
334
239
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
335
240
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
336
|
-
* @returns {Promise<PaymentPlatformModel.
|
|
241
|
+
* @returns {Promise<PaymentPlatformModel.GetPaymentCodeDetails>} - Success response
|
|
337
242
|
* @name getPaymentCodeOption
|
|
338
243
|
* @summary: Get payment mode codes
|
|
339
244
|
* @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/).
|
|
340
245
|
*/
|
|
341
|
-
getPaymentCodeOption({ requestHeaders }?: any, { responseHeaders }?: object): Promise<PaymentPlatformModel.
|
|
246
|
+
getPaymentCodeOption({ requestHeaders }?: any, { responseHeaders }?: object): Promise<PaymentPlatformModel.GetPaymentCodeDetails>;
|
|
342
247
|
/**
|
|
343
248
|
* @param {PaymentPlatformApplicationValidator.GetPaymentLinkParam} arg - Arg object
|
|
344
249
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
345
250
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
346
|
-
* @returns {Promise<PaymentPlatformModel.
|
|
251
|
+
* @returns {Promise<PaymentPlatformModel.GetPaymentLinkDetails>} - Success response
|
|
347
252
|
* @name getPaymentLink
|
|
348
253
|
* @summary: Get payment link
|
|
349
|
-
* @description: Retrieve a payment link for making payments -
|
|
254
|
+
* @description: Retrieve a payment link for making payments. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/getPaymentLink/).
|
|
350
255
|
*/
|
|
351
|
-
getPaymentLink({ paymentLinkId, requestHeaders }?: PaymentPlatformApplicationValidator.GetPaymentLinkParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.
|
|
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>;
|
|
256
|
+
getPaymentLink({ paymentLinkId, requestHeaders }?: PaymentPlatformApplicationValidator.GetPaymentLinkParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.GetPaymentLinkDetails>;
|
|
362
257
|
/**
|
|
363
258
|
* @param {PaymentPlatformApplicationValidator.GetPaymentModeControlRoutesParam} arg
|
|
364
259
|
* - Arg object
|
|
365
260
|
*
|
|
366
261
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
367
262
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
368
|
-
* @returns {Promise<PaymentPlatformModel.
|
|
369
|
-
*
|
|
370
|
-
*
|
|
263
|
+
* @returns {Promise<PaymentPlatformModel.PlatformPaymentModeDetails>} -
|
|
264
|
+
* Success response
|
|
371
265
|
* @name getPaymentModeControlRoutes
|
|
372
266
|
* @summary: Get offline/advance payment mode
|
|
373
267
|
* @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/).
|
|
374
268
|
*/
|
|
375
|
-
getPaymentModeControlRoutes({ mode, requestHeaders }?: PaymentPlatformApplicationValidator.GetPaymentModeControlRoutesParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.
|
|
269
|
+
getPaymentModeControlRoutes({ mode, requestHeaders }?: PaymentPlatformApplicationValidator.GetPaymentModeControlRoutesParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.PlatformPaymentModeDetails>;
|
|
376
270
|
/**
|
|
377
271
|
* @param {PaymentPlatformApplicationValidator.GetPaymentModeCustomConfigParam} arg
|
|
378
272
|
* - Arg object
|
|
@@ -393,302 +287,221 @@ declare class Payment {
|
|
|
393
287
|
*
|
|
394
288
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
395
289
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
396
|
-
* @returns {Promise<PaymentPlatformModel.
|
|
290
|
+
* @returns {Promise<PaymentPlatformModel.PaymentOptionsDetails>} - Success response
|
|
397
291
|
* @name getPaymentModeRoutes
|
|
398
292
|
* @summary: Get payment modes
|
|
399
|
-
* @description:
|
|
293
|
+
* @description: Get 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/).
|
|
400
294
|
*/
|
|
401
|
-
getPaymentModeRoutes({ refresh,
|
|
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>;
|
|
295
|
+
getPaymentModeRoutes({ refresh, requestType, orderId, shipmentId, amount, requestHeaders }?: PaymentPlatformApplicationValidator.GetPaymentModeRoutesParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.PaymentOptionsDetails>;
|
|
414
296
|
/**
|
|
415
297
|
* @param {PaymentPlatformApplicationValidator.GetPaymentSessionParam} arg
|
|
416
298
|
* - Arg object
|
|
417
299
|
*
|
|
418
300
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
419
301
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
420
|
-
* @returns {Promise<PaymentPlatformModel.
|
|
302
|
+
* @returns {Promise<PaymentPlatformModel.PaymentSessionFetchDetails>} -
|
|
421
303
|
* Success response
|
|
422
304
|
* @name getPaymentSession
|
|
423
305
|
* @summary: Get payment session
|
|
424
306
|
* @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/).
|
|
425
307
|
*/
|
|
426
|
-
getPaymentSession({ gid, lineItem, requestHeaders }?: PaymentPlatformApplicationValidator.GetPaymentSessionParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.
|
|
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>;
|
|
308
|
+
getPaymentSession({ gid, lineItem, requestHeaders }?: PaymentPlatformApplicationValidator.GetPaymentSessionParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.PaymentSessionFetchDetails>;
|
|
440
309
|
/**
|
|
441
310
|
* @param {PaymentPlatformApplicationValidator.GetPosPaymentModeRoutesParam} arg
|
|
442
311
|
* - Arg object
|
|
443
312
|
*
|
|
444
313
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
445
314
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
446
|
-
* @returns {Promise<PaymentPlatformModel.
|
|
447
|
-
* Success response
|
|
315
|
+
* @returns {Promise<PaymentPlatformModel.PaymentModeRouteDetails>} - Success response
|
|
448
316
|
* @name getPosPaymentModeRoutes
|
|
449
317
|
* @summary: List POS payment modes
|
|
450
|
-
* @description:
|
|
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/).
|
|
318
|
+
* @description: Available payment methods on the payment page for POS, specifying the aggregator for each option, such as 'CARD powered by Juspay' and 'QR powered by Razorpay'. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/getPosPaymentModeRoutes/).
|
|
478
319
|
*/
|
|
479
|
-
|
|
320
|
+
getPosPaymentModeRoutes({ amount, pincode, orderType, xOrderingSource, cartId, checkoutMode, refresh, orderId, cardReference, userDetails, displaySplit, advancePayment, shipmentId, requestHeaders, }?: PaymentPlatformApplicationValidator.GetPosPaymentModeRoutesParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.PaymentModeRouteDetails>;
|
|
480
321
|
/**
|
|
481
322
|
* @param {PaymentPlatformApplicationValidator.GetUserBeneficiariesParam} arg
|
|
482
323
|
* - Arg object
|
|
483
324
|
*
|
|
484
325
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
485
326
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
486
|
-
* @returns {Promise<PaymentPlatformModel.
|
|
327
|
+
* @returns {Promise<PaymentPlatformModel.OrderBeneficiaryFetchResults>} -
|
|
487
328
|
* Success response
|
|
488
329
|
* @name getUserBeneficiaries
|
|
489
|
-
* @summary: Get user beneficiaries
|
|
330
|
+
* @summary: Get user beneficiaries
|
|
490
331
|
* @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/).
|
|
491
332
|
*/
|
|
492
|
-
getUserBeneficiaries({ orderId, requestHeaders }?: PaymentPlatformApplicationValidator.GetUserBeneficiariesParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.
|
|
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>;
|
|
333
|
+
getUserBeneficiaries({ orderId, requestHeaders }?: PaymentPlatformApplicationValidator.GetUserBeneficiariesParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.OrderBeneficiaryFetchResults>;
|
|
507
334
|
/**
|
|
508
335
|
* @param {PaymentPlatformApplicationValidator.GetUserCODlimitRoutesParam} arg
|
|
509
336
|
* - Arg object
|
|
510
337
|
*
|
|
511
338
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
512
339
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
513
|
-
* @returns {Promise<PaymentPlatformModel.
|
|
340
|
+
* @returns {Promise<PaymentPlatformModel.GetUserCODLimitDetails>} - Success response
|
|
514
341
|
* @name getUserCODlimitRoutes
|
|
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
|
|
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 - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/getUserCODlimitRoutes/).
|
|
517
344
|
*/
|
|
518
|
-
getUserCODlimitRoutes({ merchantUserId, mobileNo, requestHeaders }?: PaymentPlatformApplicationValidator.GetUserCODlimitRoutesParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.
|
|
345
|
+
getUserCODlimitRoutes({ merchantUserId, mobileNo, requestHeaders }?: PaymentPlatformApplicationValidator.GetUserCODlimitRoutesParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.GetUserCODLimitDetails>;
|
|
519
346
|
/**
|
|
520
347
|
* @param {PaymentPlatformApplicationValidator.GetUserOrderBeneficiariesParam} arg
|
|
521
348
|
* - Arg object
|
|
522
349
|
*
|
|
523
350
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
524
351
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
525
|
-
* @returns {Promise<PaymentPlatformModel.
|
|
352
|
+
* @returns {Promise<PaymentPlatformModel.OrderBeneficiaryFetchResults>} -
|
|
526
353
|
* Success response
|
|
527
354
|
* @name getUserOrderBeneficiaries
|
|
528
355
|
* @summary: Get user order beneficiaries
|
|
529
|
-
* @description: Retrieve beneficiary details like bank name , ifsc code , branch name associated with a specific order for refund processing
|
|
356
|
+
* @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/).
|
|
530
357
|
*/
|
|
531
|
-
getUserOrderBeneficiaries({ orderId, requestHeaders }?: PaymentPlatformApplicationValidator.GetUserOrderBeneficiariesParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.
|
|
358
|
+
getUserOrderBeneficiaries({ orderId, requestHeaders }?: PaymentPlatformApplicationValidator.GetUserOrderBeneficiariesParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.OrderBeneficiaryFetchResults>;
|
|
532
359
|
/**
|
|
533
360
|
* @param {PaymentPlatformApplicationValidator.InitialisePaymentParam} arg
|
|
534
361
|
* - Arg object
|
|
535
362
|
*
|
|
536
363
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
537
364
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
538
|
-
* @returns {Promise<PaymentPlatformModel.
|
|
365
|
+
* @returns {Promise<PaymentPlatformModel.PaymentInitializationDetails>} -
|
|
539
366
|
* Success response
|
|
540
367
|
* @name initialisePayment
|
|
541
368
|
* @summary: Start payment process
|
|
542
369
|
* @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/).
|
|
543
370
|
*/
|
|
544
|
-
initialisePayment({ body, requestHeaders }?: PaymentPlatformApplicationValidator.InitialisePaymentParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.
|
|
371
|
+
initialisePayment({ body, requestHeaders }?: PaymentPlatformApplicationValidator.InitialisePaymentParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.PaymentInitializationDetails>;
|
|
545
372
|
/**
|
|
546
373
|
* @param {PaymentPlatformApplicationValidator.MerchantOnBoardingParam} arg
|
|
547
374
|
* - Arg object
|
|
548
375
|
*
|
|
549
376
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
550
377
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
551
|
-
* @returns {Promise<PaymentPlatformModel.
|
|
378
|
+
* @returns {Promise<PaymentPlatformModel.MerchantOnBoardingDetails>} -
|
|
552
379
|
* Success response
|
|
553
380
|
* @name merchantOnBoarding
|
|
554
|
-
* @summary: Merchant onboarding for BNPL
|
|
381
|
+
* @summary: Merchant onboarding for BNPL
|
|
555
382
|
* @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/).
|
|
556
383
|
*/
|
|
557
|
-
merchantOnBoarding({ body, requestHeaders }?: PaymentPlatformApplicationValidator.MerchantOnBoardingParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.
|
|
384
|
+
merchantOnBoarding({ body, requestHeaders }?: PaymentPlatformApplicationValidator.MerchantOnBoardingParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.MerchantOnBoardingDetails>;
|
|
558
385
|
/**
|
|
559
386
|
* @param {PaymentPlatformApplicationValidator.OauthGetUrlParam} arg - Arg object
|
|
560
387
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
561
388
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
562
|
-
* @returns {Promise<PaymentPlatformModel.
|
|
389
|
+
* @returns {Promise<PaymentPlatformModel.GetOauthUrlDetails>} - Success response
|
|
563
390
|
* @name oauthGetUrl
|
|
564
|
-
* @summary: Get OAuth URL
|
|
391
|
+
* @summary: Get OAuth URL
|
|
565
392
|
* @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/).
|
|
566
393
|
*/
|
|
567
|
-
oauthGetUrl({ aggregator, successRedirectUrl, failureRedirectUrl, requestHeaders }?: PaymentPlatformApplicationValidator.OauthGetUrlParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.
|
|
394
|
+
oauthGetUrl({ aggregator, successRedirectUrl, failureRedirectUrl, requestHeaders }?: PaymentPlatformApplicationValidator.OauthGetUrlParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.GetOauthUrlDetails>;
|
|
568
395
|
/**
|
|
569
396
|
* @param {PaymentPlatformApplicationValidator.PatchMerchantAggregatorPaymentModeDetailsParam} arg
|
|
570
397
|
* - Arg object
|
|
571
398
|
*
|
|
572
399
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
573
400
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
574
|
-
* @returns {Promise<PaymentPlatformModel.
|
|
401
|
+
* @returns {Promise<PaymentPlatformModel.PlatformPaymentModeDetails>} -
|
|
575
402
|
* Success response
|
|
576
403
|
* @name patchMerchantAggregatorPaymentModeDetails
|
|
577
404
|
* @summary: Update merchant aggregator payment mode
|
|
578
405
|
* @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/).
|
|
579
406
|
*/
|
|
580
|
-
patchMerchantAggregatorPaymentModeDetails({ aggregatorId, body, requestHeaders }?: PaymentPlatformApplicationValidator.PatchMerchantAggregatorPaymentModeDetailsParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.
|
|
407
|
+
patchMerchantAggregatorPaymentModeDetails({ aggregatorId, body, requestHeaders }?: PaymentPlatformApplicationValidator.PatchMerchantAggregatorPaymentModeDetailsParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.PlatformPaymentModeDetails>;
|
|
581
408
|
/**
|
|
582
409
|
* @param {PaymentPlatformApplicationValidator.PatchMerchantPaymentOptionParam} arg
|
|
583
410
|
* - Arg object
|
|
584
411
|
*
|
|
585
412
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
586
413
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
587
|
-
* @returns {Promise<PaymentPlatformModel.
|
|
588
|
-
*
|
|
589
|
-
*
|
|
414
|
+
* @returns {Promise<PaymentPlatformModel.PlatformPaymentModeDetails>} -
|
|
415
|
+
* Success response
|
|
590
416
|
* @name patchMerchantPaymentOption
|
|
591
417
|
* @summary: Update payment gateways and payment mode
|
|
592
418
|
* @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/).
|
|
593
419
|
*/
|
|
594
|
-
patchMerchantPaymentOption({ body, requestHeaders }?: PaymentPlatformApplicationValidator.PatchMerchantPaymentOptionParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.
|
|
420
|
+
patchMerchantPaymentOption({ body, requestHeaders }?: PaymentPlatformApplicationValidator.PatchMerchantPaymentOptionParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.PlatformPaymentModeDetails>;
|
|
595
421
|
/**
|
|
596
422
|
* @param {PaymentPlatformApplicationValidator.PatchMerchantPaymentOptionVersionParam} arg
|
|
597
423
|
* - Arg object
|
|
598
424
|
*
|
|
599
425
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
600
426
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
601
|
-
* @returns {Promise<PaymentPlatformModel.
|
|
427
|
+
* @returns {Promise<PaymentPlatformModel.PlatformPaymentModeDetails>} -
|
|
602
428
|
* Success response
|
|
603
429
|
* @name patchMerchantPaymentOptionVersion
|
|
604
|
-
* @summary: Update app version
|
|
430
|
+
* @summary: Update app version for Aggrgator
|
|
605
431
|
* @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/).
|
|
606
432
|
*/
|
|
607
|
-
patchMerchantPaymentOptionVersion({ aggregatorId, body, requestHeaders }?: PaymentPlatformApplicationValidator.PatchMerchantPaymentOptionVersionParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.
|
|
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>;
|
|
433
|
+
patchMerchantPaymentOptionVersion({ aggregatorId, body, requestHeaders }?: PaymentPlatformApplicationValidator.PatchMerchantPaymentOptionVersionParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.PlatformPaymentModeDetails>;
|
|
621
434
|
/**
|
|
622
435
|
* @param {PaymentPlatformApplicationValidator.PaymentStatusBulkParam} arg
|
|
623
436
|
* - Arg object
|
|
624
437
|
*
|
|
625
438
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
626
439
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
627
|
-
* @returns {Promise<PaymentPlatformModel.
|
|
440
|
+
* @returns {Promise<PaymentPlatformModel.PaymentStatusBulkHandlerDetails>}
|
|
628
441
|
* - Success response
|
|
629
442
|
*
|
|
630
443
|
* @name paymentStatusBulk
|
|
631
444
|
* @summary: Retrieve status of multiple payments in bulk
|
|
632
445
|
* @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/).
|
|
633
446
|
*/
|
|
634
|
-
paymentStatusBulk({ body, requestHeaders }?: PaymentPlatformApplicationValidator.PaymentStatusBulkParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.
|
|
447
|
+
paymentStatusBulk({ body, requestHeaders }?: PaymentPlatformApplicationValidator.PaymentStatusBulkParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.PaymentStatusBulkHandlerDetails>;
|
|
635
448
|
/**
|
|
636
449
|
* @param {PaymentPlatformApplicationValidator.PollingPaymentLinkParam} arg
|
|
637
450
|
* - Arg object
|
|
638
451
|
*
|
|
639
452
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
640
453
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
641
|
-
* @returns {Promise<PaymentPlatformModel.
|
|
454
|
+
* @returns {Promise<PaymentPlatformModel.PollingPaymentLinkDetails>} -
|
|
642
455
|
* Success response
|
|
643
456
|
* @name pollingPaymentLink
|
|
644
457
|
* @summary: Poll status of payment link
|
|
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
|
|
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. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/pollingPaymentLink/).
|
|
646
459
|
*/
|
|
647
|
-
pollingPaymentLink({ paymentLinkId, requestHeaders }?: PaymentPlatformApplicationValidator.PollingPaymentLinkParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.
|
|
460
|
+
pollingPaymentLink({ paymentLinkId, requestHeaders }?: PaymentPlatformApplicationValidator.PollingPaymentLinkParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.PollingPaymentLinkDetails>;
|
|
648
461
|
/**
|
|
649
462
|
* @param {PaymentPlatformApplicationValidator.RepaymentDetailsParam} arg - Arg object
|
|
650
463
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
651
464
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
652
|
-
* @returns {Promise<PaymentPlatformModel.
|
|
465
|
+
* @returns {Promise<PaymentPlatformModel.RepaymentDetails>} - Success response
|
|
653
466
|
* @name repaymentDetails
|
|
654
|
-
* @summary: Repayment details for BNPL
|
|
467
|
+
* @summary: Repayment details for BNPL
|
|
655
468
|
* @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/).
|
|
656
469
|
*/
|
|
657
|
-
repaymentDetails({ body, requestHeaders }?: PaymentPlatformApplicationValidator.RepaymentDetailsParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.
|
|
470
|
+
repaymentDetails({ body, requestHeaders }?: PaymentPlatformApplicationValidator.RepaymentDetailsParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.RepaymentDetails>;
|
|
658
471
|
/**
|
|
659
472
|
* @param {PaymentPlatformApplicationValidator.ResendOrCancelPaymentParam} arg
|
|
660
473
|
* - Arg object
|
|
661
474
|
*
|
|
662
475
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
663
476
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
664
|
-
* @returns {Promise<PaymentPlatformModel.
|
|
477
|
+
* @returns {Promise<PaymentPlatformModel.ResendOrCancelPaymentDetails>} -
|
|
665
478
|
* Success response
|
|
666
479
|
* @name resendOrCancelPayment
|
|
667
|
-
* @summary: Resend or cancel payment
|
|
480
|
+
* @summary: Resend or cancel payment
|
|
668
481
|
* @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/).
|
|
669
482
|
*/
|
|
670
|
-
resendOrCancelPayment({ body, requestHeaders }?: PaymentPlatformApplicationValidator.ResendOrCancelPaymentParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.
|
|
483
|
+
resendOrCancelPayment({ body, requestHeaders }?: PaymentPlatformApplicationValidator.ResendOrCancelPaymentParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.ResendOrCancelPaymentDetails>;
|
|
671
484
|
/**
|
|
672
485
|
* @param {PaymentPlatformApplicationValidator.ResendPaymentLinkParam} arg
|
|
673
486
|
* - Arg object
|
|
674
487
|
*
|
|
675
488
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
676
489
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
677
|
-
* @returns {Promise<PaymentPlatformModel.
|
|
490
|
+
* @returns {Promise<PaymentPlatformModel.ResendPaymentLinkDetails>} -
|
|
678
491
|
* Success response
|
|
679
492
|
* @name resendPaymentLink
|
|
680
493
|
* @summary: Resend payment link
|
|
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/).
|
|
494
|
+
* @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/).
|
|
682
495
|
*/
|
|
683
|
-
resendPaymentLink({ body, requestHeaders }?: PaymentPlatformApplicationValidator.ResendPaymentLinkParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.
|
|
496
|
+
resendPaymentLink({ body, requestHeaders }?: PaymentPlatformApplicationValidator.ResendPaymentLinkParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.ResendPaymentLinkDetails>;
|
|
684
497
|
/**
|
|
685
498
|
* @param {PaymentPlatformApplicationValidator.RevokeOauthTokenParam} arg - Arg object
|
|
686
499
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
687
500
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
688
501
|
* @returns {Promise<PaymentPlatformModel.RevokeOAuthToken>} - Success response
|
|
689
502
|
* @name revokeOauthToken
|
|
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/).
|
|
503
|
+
* @summary: Revoke OAuth token
|
|
504
|
+
* @description: Revoke the creds for payment aggregator razropay. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/revokeOauthToken/).
|
|
692
505
|
*/
|
|
693
506
|
revokeOauthToken({ aggregator, requestHeaders }?: PaymentPlatformApplicationValidator.RevokeOauthTokenParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.RevokeOAuthToken>;
|
|
694
507
|
/**
|
|
@@ -700,8 +513,8 @@ declare class Payment {
|
|
|
700
513
|
* @returns {Promise<PaymentPlatformModel.PaymentGatewayToBeReviewed>} -
|
|
701
514
|
* Success response
|
|
702
515
|
* @name 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. -
|
|
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/).
|
|
705
518
|
*/
|
|
706
519
|
saveBrandPaymentGatewayConfig({ body, requestHeaders }?: PaymentPlatformApplicationValidator.SaveBrandPaymentGatewayConfigParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.PaymentGatewayToBeReviewed>;
|
|
707
520
|
/**
|
|
@@ -710,14 +523,13 @@ declare class Payment {
|
|
|
710
523
|
*
|
|
711
524
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
712
525
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
713
|
-
* @returns {Promise<PaymentPlatformModel.
|
|
714
|
-
*
|
|
715
|
-
*
|
|
526
|
+
* @returns {Promise<PaymentPlatformModel.PlatformPaymentModeDetails>} -
|
|
527
|
+
* Success response
|
|
716
528
|
* @name setMerchantModeControlRoutes
|
|
717
529
|
* @summary: Update offline payment mode
|
|
718
|
-
* @description: Update
|
|
530
|
+
* @description: Update offline payment mode details for the merchant like update for cod offline payment mode get user level cod limit, order level cod limit, cod charge, enable/disable device for cod. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/setMerchantModeControlRoutes/).
|
|
719
531
|
*/
|
|
720
|
-
setMerchantModeControlRoutes({ mode, body, requestHeaders }?: PaymentPlatformApplicationValidator.SetMerchantModeControlRoutesParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.
|
|
532
|
+
setMerchantModeControlRoutes({ mode, body, requestHeaders }?: PaymentPlatformApplicationValidator.SetMerchantModeControlRoutesParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.PlatformPaymentModeDetails>;
|
|
721
533
|
/**
|
|
722
534
|
* @param {PaymentPlatformApplicationValidator.SetPaymentModeCustomConfigParam} arg
|
|
723
535
|
* - Arg object
|
|
@@ -732,149 +544,90 @@ declare class Payment {
|
|
|
732
544
|
* @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/).
|
|
733
545
|
*/
|
|
734
546
|
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>;
|
|
747
547
|
/**
|
|
748
548
|
* @param {PaymentPlatformApplicationValidator.SetUserCODlimitRoutesParam} arg
|
|
749
549
|
* - Arg object
|
|
750
550
|
*
|
|
751
551
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
752
552
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
753
|
-
* @returns {Promise<PaymentPlatformModel.
|
|
553
|
+
* @returns {Promise<PaymentPlatformModel.SetCODOptionDetails>} - Success response
|
|
754
554
|
* @name setUserCODlimitRoutes
|
|
755
555
|
* @summary: Set user COD
|
|
756
556
|
* @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/).
|
|
757
557
|
*/
|
|
758
|
-
setUserCODlimitRoutes({ body, requestHeaders }?: PaymentPlatformApplicationValidator.SetUserCODlimitRoutesParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.
|
|
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>;
|
|
558
|
+
setUserCODlimitRoutes({ body, requestHeaders }?: PaymentPlatformApplicationValidator.SetUserCODlimitRoutesParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.SetCODOptionDetails>;
|
|
786
559
|
/**
|
|
787
560
|
* @param {PaymentPlatformApplicationValidator.UpdateEdcDeviceParam} arg - Arg object
|
|
788
561
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
789
562
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
790
|
-
* @returns {Promise<PaymentPlatformModel.
|
|
563
|
+
* @returns {Promise<PaymentPlatformModel.EdcDeviceAddDetails>} - Success response
|
|
791
564
|
* @name updateEdcDevice
|
|
792
|
-
* @summary: Update EDC device
|
|
565
|
+
* @summary: Update EDC device
|
|
793
566
|
* @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/).
|
|
794
567
|
*/
|
|
795
|
-
updateEdcDevice({ body, requestHeaders }?: PaymentPlatformApplicationValidator.UpdateEdcDeviceParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.
|
|
568
|
+
updateEdcDevice({ body, requestHeaders }?: PaymentPlatformApplicationValidator.UpdateEdcDeviceParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.EdcDeviceAddDetails>;
|
|
796
569
|
/**
|
|
797
570
|
* @param {PaymentPlatformApplicationValidator.UpdateMerchantRefundPriorityParam} arg
|
|
798
571
|
* - Arg object
|
|
799
572
|
*
|
|
800
573
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
801
574
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
802
|
-
* @returns {Promise<PaymentPlatformModel.
|
|
803
|
-
* - Success response
|
|
804
|
-
*
|
|
575
|
+
* @returns {Promise<PaymentPlatformModel.RefundPriorityDetails>} - Success response
|
|
805
576
|
* @name updateMerchantRefundPriority
|
|
806
577
|
* @summary: Update merchant refund priority
|
|
807
578
|
* @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/).
|
|
808
579
|
*/
|
|
809
|
-
updateMerchantRefundPriority({ configType,
|
|
580
|
+
updateMerchantRefundPriority({ configType, body, requestHeaders }?: PaymentPlatformApplicationValidator.UpdateMerchantRefundPriorityParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.RefundPriorityDetails>;
|
|
810
581
|
/**
|
|
811
582
|
* @param {PaymentPlatformApplicationValidator.UpdatePaymentSessionParam} arg
|
|
812
583
|
* - Arg object
|
|
813
584
|
*
|
|
814
585
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
815
586
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
816
|
-
* @returns {Promise<PaymentPlatformModel.
|
|
817
|
-
*
|
|
818
|
-
*
|
|
587
|
+
* @returns {Promise<PaymentPlatformModel.PaymentSessionPutDetails>} -
|
|
588
|
+
* Success response
|
|
819
589
|
* @name updatePaymentSession
|
|
820
|
-
* @summary: Update payment session
|
|
590
|
+
* @summary: Update payment session
|
|
821
591
|
* @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/).
|
|
822
592
|
*/
|
|
823
|
-
updatePaymentSession({ gid, body, requestHeaders }?: PaymentPlatformApplicationValidator.UpdatePaymentSessionParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.
|
|
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>;
|
|
593
|
+
updatePaymentSession({ gid, body, requestHeaders }?: PaymentPlatformApplicationValidator.UpdatePaymentSessionParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.PaymentSessionPutDetails>;
|
|
837
594
|
/**
|
|
838
595
|
* @param {PaymentPlatformApplicationValidator.UpdateRefundSessionParam} arg
|
|
839
596
|
* - Arg object
|
|
840
597
|
*
|
|
841
598
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
842
599
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
843
|
-
* @returns {Promise<PaymentPlatformModel.
|
|
844
|
-
* - Success response
|
|
845
|
-
*
|
|
600
|
+
* @returns {Promise<PaymentPlatformModel.RefundSessionDetails>} - Success response
|
|
846
601
|
* @name updateRefundSession
|
|
847
602
|
* @summary: Update refund session
|
|
848
603
|
* @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/).
|
|
849
604
|
*/
|
|
850
|
-
updateRefundSession({ gid, requestId, body, requestHeaders }?: PaymentPlatformApplicationValidator.UpdateRefundSessionParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.
|
|
605
|
+
updateRefundSession({ gid, requestId, body, requestHeaders }?: PaymentPlatformApplicationValidator.UpdateRefundSessionParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.RefundSessionDetails>;
|
|
851
606
|
/**
|
|
852
|
-
* @param {PaymentPlatformApplicationValidator.
|
|
607
|
+
* @param {PaymentPlatformApplicationValidator.ValidateCustomerAndCreditSummaryParam} arg
|
|
853
608
|
* - Arg object
|
|
854
609
|
*
|
|
855
610
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
856
611
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
857
|
-
* @returns {Promise<PaymentPlatformModel.
|
|
858
|
-
*
|
|
859
|
-
*
|
|
860
|
-
* @
|
|
861
|
-
* @
|
|
862
|
-
* @description: Validate UPI ID and IFSC code - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/validateBeneficiaryAddress/).
|
|
612
|
+
* @returns {Promise<PaymentPlatformModel.ValidateCustomerCreditSchema>} -
|
|
613
|
+
* Success response
|
|
614
|
+
* @name validateCustomerAndCreditSummary
|
|
615
|
+
* @summary: Verify payment customer and show credit summary
|
|
616
|
+
* @description: Verify if the user is eligible for payment and also show credit summary if activated. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/validateCustomerAndCreditSummary/).
|
|
863
617
|
*/
|
|
864
|
-
|
|
618
|
+
validateCustomerAndCreditSummary({ body, requestHeaders }?: PaymentPlatformApplicationValidator.ValidateCustomerAndCreditSummaryParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.ValidateCustomerCreditSchema>;
|
|
865
619
|
/**
|
|
866
620
|
* @param {PaymentPlatformApplicationValidator.VerifyCustomerForPaymentParam} arg
|
|
867
621
|
* - Arg object
|
|
868
622
|
*
|
|
869
623
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
870
624
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
871
|
-
* @returns {Promise<PaymentPlatformModel.
|
|
872
|
-
* Success response
|
|
625
|
+
* @returns {Promise<PaymentPlatformModel.ValidateCustomerDetails>} - Success response
|
|
873
626
|
* @name verifyCustomerForPayment
|
|
874
627
|
* @summary: Validate customer for paylater
|
|
875
628
|
* @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/).
|
|
876
629
|
*/
|
|
877
|
-
verifyCustomerForPayment({ body, requestHeaders }?: PaymentPlatformApplicationValidator.VerifyCustomerForPaymentParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.
|
|
630
|
+
verifyCustomerForPayment({ body, requestHeaders }?: PaymentPlatformApplicationValidator.VerifyCustomerForPaymentParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.ValidateCustomerDetails>;
|
|
878
631
|
}
|
|
879
632
|
import PaymentPlatformApplicationValidator = require("./PaymentPlatformApplicationValidator");
|
|
880
633
|
import PaymentPlatformModel = require("./PaymentPlatformModel");
|