@gofynd/fdk-client-javascript 1.4.2-beta.7 → 1.4.4
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 -10
- package/application.d.ts +3 -3
- package/common.d.ts +3 -3
- package/index.d.ts +15 -15
- package/package.json +5 -3
- package/partner.d.ts +3 -3
- package/platform.d.ts +3 -3
- package/public.d.ts +2 -2
- package/sdk/application/ApplicationAPIClient.d.ts +1 -1
- package/sdk/application/ApplicationAPIClient.js +0 -1
- package/sdk/application/ApplicationClient.d.ts +17 -17
- package/sdk/application/ApplicationConfig.d.ts +3 -3
- package/sdk/application/Cart/CartApplicationClient.d.ts +58 -58
- package/sdk/application/Cart/CartApplicationClient.js +56 -56
- package/sdk/application/Cart/CartApplicationValidator.d.ts +1 -1
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +72 -72
- package/sdk/application/Catalog/CatalogApplicationClient.js +69 -69
- package/sdk/application/Common/CommonApplicationClient.d.ts +6 -6
- package/sdk/application/Common/CommonApplicationClient.js +4 -4
- package/sdk/application/Communication/CommunicationApplicationClient.d.ts +8 -8
- package/sdk/application/Communication/CommunicationApplicationClient.js +6 -6
- package/sdk/application/Communication/CommunicationApplicationValidator.d.ts +1 -1
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +34 -34
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +32 -32
- package/sdk/application/Configuration/ConfigurationApplicationValidator.d.ts +1 -1
- package/sdk/application/Content/ContentApplicationClient.d.ts +48 -48
- package/sdk/application/Content/ContentApplicationClient.js +45 -45
- package/sdk/application/Content/ContentApplicationModel.d.ts +18 -18
- package/sdk/application/Content/ContentApplicationModel.js +26 -26
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +7 -7
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +15 -9
- package/sdk/application/FileStorage/FileStorageApplicationValidator.d.ts +1 -1
- package/sdk/application/Lead/LeadApplicationClient.d.ts +12 -12
- package/sdk/application/Lead/LeadApplicationClient.js +10 -10
- package/sdk/application/Lead/LeadApplicationModel.d.ts +64 -77
- package/sdk/application/Lead/LeadApplicationModel.js +42 -52
- package/sdk/application/Lead/LeadApplicationValidator.d.ts +1 -1
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +24 -24
- package/sdk/application/Logistic/LogisticApplicationClient.js +22 -22
- package/sdk/application/Logistic/LogisticApplicationValidator.d.ts +1 -1
- package/sdk/application/Order/OrderApplicationClient.d.ts +19 -30
- package/sdk/application/Order/OrderApplicationClient.js +17 -97
- package/sdk/application/Order/OrderApplicationValidator.d.ts +2 -16
- package/sdk/application/Order/OrderApplicationValidator.js +0 -13
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +91 -91
- package/sdk/application/Payment/PaymentApplicationClient.js +94 -94
- package/sdk/application/Payment/PaymentApplicationModel.d.ts +5 -2
- package/sdk/application/Payment/PaymentApplicationModel.js +4 -2
- package/sdk/application/Payment/PaymentApplicationValidator.d.ts +6 -6
- package/sdk/application/Payment/PaymentApplicationValidator.js +3 -3
- package/sdk/application/PosCart/PosCartApplicationClient.d.ts +29 -29
- package/sdk/application/PosCart/PosCartApplicationClient.js +27 -27
- package/sdk/application/PosCart/PosCartApplicationValidator.d.ts +1 -1
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +9 -9
- package/sdk/application/Rewards/RewardsApplicationClient.js +7 -7
- package/sdk/application/Rewards/RewardsApplicationValidator.d.ts +1 -1
- package/sdk/application/Share/ShareApplicationClient.d.ts +9 -9
- package/sdk/application/Share/ShareApplicationClient.js +7 -7
- package/sdk/application/Share/ShareApplicationModel.d.ts +2 -0
- package/sdk/application/Share/ShareApplicationModel.js +2 -0
- package/sdk/application/Share/ShareApplicationValidator.d.ts +1 -1
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +10 -10
- package/sdk/application/Theme/ThemeApplicationClient.js +8 -8
- package/sdk/application/Theme/ThemeApplicationModel.d.ts +25 -32
- package/sdk/application/Theme/ThemeApplicationModel.js +30 -40
- package/sdk/application/User/UserApplicationClient.d.ts +76 -76
- package/sdk/application/User/UserApplicationClient.js +74 -74
- package/sdk/application/User/UserApplicationModel.d.ts +44 -13
- package/sdk/application/User/UserApplicationModel.js +17 -13
- package/sdk/application/User/UserApplicationValidator.d.ts +1 -1
- package/sdk/application/index.d.ts +18 -18
- package/sdk/common/AxiosHelper.d.ts +1 -1
- package/sdk/common/AxiosHelper.js +38 -17
- package/sdk/common/Clickstream.js +22 -16
- package/sdk/common/curlHelper.js +1 -3
- package/sdk/common/utils.d.ts +15 -0
- package/sdk/common/utils.js +30 -0
- package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +3 -3
- package/sdk/partner/FileStorage/FileStoragePartnerClient.js +2 -2
- package/sdk/partner/Lead/LeadPartnerClient.d.ts +3 -3
- package/sdk/partner/Lead/LeadPartnerClient.js +1 -1
- package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +5 -5
- package/sdk/partner/Logistics/LogisticsPartnerClient.js +4 -4
- package/sdk/partner/OAuthClient.d.ts +4 -4
- package/sdk/partner/PartnerAPIClient.d.ts +1 -1
- package/sdk/partner/PartnerAPIClient.js +0 -1
- package/sdk/partner/PartnerClient.d.ts +6 -6
- package/sdk/partner/PartnerConfig.d.ts +4 -4
- package/sdk/partner/Theme/ThemePartnerClient.d.ts +20 -20
- package/sdk/partner/Theme/ThemePartnerClient.js +19 -19
- package/sdk/partner/Theme/ThemePartnerModel.d.ts +25 -32
- package/sdk/partner/Theme/ThemePartnerModel.js +30 -40
- package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +3 -3
- package/sdk/partner/Webhook/WebhookPartnerClient.js +2 -2
- package/sdk/partner/index.d.ts +7 -7
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +8 -8
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +6 -6
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +1 -1
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +25 -25
- package/sdk/platform/Billing/BillingPlatformClient.js +23 -23
- package/sdk/platform/Billing/BillingPlatformValidator.d.ts +1 -1
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +115 -115
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +113 -113
- package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +1 -1
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +147 -146
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +146 -145
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +1 -1
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +156 -156
- package/sdk/platform/Catalog/CatalogPlatformClient.js +153 -153
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +65 -28
- package/sdk/platform/Catalog/CatalogPlatformModel.js +68 -36
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +1 -1
- package/sdk/platform/Common/CommonPlatformClient.d.ts +5 -5
- package/sdk/platform/Common/CommonPlatformClient.js +3 -3
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +133 -133
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +131 -131
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +1 -1
- package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +4 -4
- package/sdk/platform/Communication/CommunicationPlatformClient.js +2 -2
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +12 -0
- package/sdk/platform/Communication/CommunicationPlatformModel.js +12 -0
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +28 -28
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +25 -25
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +2 -0
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +2 -0
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +1 -1
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +52 -52
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +50 -50
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +1 -1
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +31 -31
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +29 -29
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +1 -1
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +128 -128
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +131 -131
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +5 -5
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +4 -4
- package/sdk/platform/Content/ContentPlatformClient.d.ts +33 -33
- package/sdk/platform/Content/ContentPlatformClient.js +37 -37
- package/sdk/platform/Content/ContentPlatformModel.d.ts +18 -18
- package/sdk/platform/Content/ContentPlatformModel.js +26 -26
- package/sdk/platform/Content/ContentPlatformValidator.d.ts +5 -5
- package/sdk/platform/Content/ContentPlatformValidator.js +4 -4
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +24 -24
- package/sdk/platform/Discount/DiscountPlatformClient.js +22 -22
- package/sdk/platform/Discount/DiscountPlatformValidator.d.ts +1 -1
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +24 -23
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +32 -25
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +1 -1
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +15 -15
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +28 -19
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +12 -1
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +16 -2
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +1 -1
- package/sdk/platform/Finance/FinancePlatformClient.d.ts +30 -30
- package/sdk/platform/Finance/FinancePlatformClient.js +28 -28
- package/sdk/platform/Finance/FinancePlatformValidator.d.ts +1 -1
- package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +19 -19
- package/sdk/platform/Lead/LeadPlatformApplicationClient.js +17 -17
- package/sdk/platform/Lead/LeadPlatformApplicationValidator.d.ts +1 -1
- package/sdk/platform/Lead/LeadPlatformClient.d.ts +20 -20
- package/sdk/platform/Lead/LeadPlatformClient.js +18 -18
- package/sdk/platform/Lead/LeadPlatformModel.d.ts +62 -77
- package/sdk/platform/Lead/LeadPlatformModel.js +40 -52
- package/sdk/platform/Lead/LeadPlatformValidator.d.ts +1 -1
- package/sdk/platform/OAuthClient.d.ts +3 -3
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +12 -12
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +10 -10
- package/sdk/platform/Order/OrderPlatformClient.d.ts +111 -122
- package/sdk/platform/Order/OrderPlatformClient.js +109 -204
- package/sdk/platform/Order/OrderPlatformModel.d.ts +18 -2
- package/sdk/platform/Order/OrderPlatformModel.js +12 -2
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +2 -34
- package/sdk/platform/Order/OrderPlatformValidator.js +0 -20
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +6 -6
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +4 -4
- package/sdk/platform/Partner/PartnerPlatformApplicationValidator.d.ts +1 -1
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +97 -97
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +95 -95
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +1 -1
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +13 -13
- package/sdk/platform/Payment/PaymentPlatformClient.js +11 -11
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +7 -0
- package/sdk/platform/Payment/PaymentPlatformModel.js +3 -0
- package/sdk/platform/Payment/PaymentPlatformValidator.d.ts +1 -1
- package/sdk/platform/PlatformAPIClient.d.ts +1 -1
- package/sdk/platform/PlatformAPIClient.js +0 -1
- package/sdk/platform/PlatformApplicationClient.d.ts +16 -16
- package/sdk/platform/PlatformClient.d.ts +19 -21
- package/sdk/platform/PlatformClient.js +0 -4
- package/sdk/platform/PlatformConfig.d.ts +4 -4
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +14 -14
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +12 -12
- package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.d.ts +1 -1
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +42 -42
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +40 -40
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +1 -1
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +55 -54
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +53 -52
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +2 -2
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +4 -2
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +1 -1
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +7 -7
- package/sdk/platform/Share/SharePlatformApplicationClient.js +5 -5
- package/sdk/platform/Share/SharePlatformApplicationValidator.d.ts +1 -1
- package/sdk/platform/Share/SharePlatformModel.d.ts +4 -0
- package/sdk/platform/Share/SharePlatformModel.js +4 -0
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +42 -112
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +40 -597
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +2 -101
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +0 -92
- package/sdk/platform/Theme/ThemePlatformClient.d.ts +8 -8
- package/sdk/platform/Theme/ThemePlatformClient.js +6 -6
- package/sdk/platform/Theme/ThemePlatformModel.d.ts +25 -32
- package/sdk/platform/Theme/ThemePlatformModel.js +30 -40
- package/sdk/platform/Theme/ThemePlatformValidator.d.ts +1 -1
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +37 -37
- package/sdk/platform/User/UserPlatformApplicationClient.js +35 -35
- package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +1 -1
- package/sdk/platform/User/UserPlatformModel.d.ts +48 -13
- package/sdk/platform/User/UserPlatformModel.js +21 -13
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +20 -19
- package/sdk/platform/Webhook/WebhookPlatformClient.js +18 -17
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +2 -2
- package/sdk/platform/Webhook/WebhookPlatformModel.js +1 -1
- package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +1 -1
- package/sdk/platform/index.d.ts +24 -25
- package/sdk/platform/index.js +0 -2
- package/sdk/public/Billing/BillingPublicClient.d.ts +3 -3
- package/sdk/public/Billing/BillingPublicClient.js +4 -4
- package/sdk/public/Billing/BillingPublicValidator.d.ts +2 -2
- package/sdk/public/Billing/BillingPublicValidator.js +2 -2
- package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +3 -3
- package/sdk/public/Configuration/ConfigurationPublicClient.js +1 -1
- package/sdk/public/Content/ContentPublicClient.d.ts +2 -2
- package/sdk/public/Content/ContentPublicValidator.d.ts +2 -2
- package/sdk/public/Content/ContentPublicValidator.js +3 -3
- package/sdk/public/Inventory/InventoryPublicClient.d.ts +2 -2
- package/sdk/public/Inventory/InventoryPublicModel.d.ts +8 -8
- package/sdk/public/Inventory/InventoryPublicModel.js +8 -8
- package/sdk/public/Inventory/InventoryPublicValidator.d.ts +1 -1
- package/sdk/public/Partner/PartnerPublicClient.d.ts +3 -3
- package/sdk/public/Partner/PartnerPublicClient.js +1 -1
- package/sdk/public/PublicAPIClient.d.ts +1 -1
- package/sdk/public/PublicClient.d.ts +7 -7
- package/sdk/public/Webhook/WebhookPublicClient.d.ts +4 -4
- package/sdk/public/Webhook/WebhookPublicClient.js +2 -2
- package/sdk/public/Webhook/WebhookPublicValidator.d.ts +1 -1
- package/sdk/public/index.d.ts +8 -8
- package/sdk/platform/Inventory/InventoryPlatformClient.d.ts +0 -152
- package/sdk/platform/Inventory/InventoryPlatformClient.js +0 -1017
- package/sdk/platform/Inventory/InventoryPlatformModel.d.ts +0 -1355
- package/sdk/platform/Inventory/InventoryPlatformModel.js +0 -1544
- package/sdk/platform/Inventory/InventoryPlatformValidator.d.ts +0 -171
- package/sdk/platform/Inventory/InventoryPlatformValidator.js +0 -159
|
@@ -9,8 +9,8 @@ declare class Payment {
|
|
|
9
9
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
10
10
|
* @returns {Promise<PaymentPlatformModel.EdcDeviceUpdateResponse>} - Success response
|
|
11
11
|
* @name addEdcDevice
|
|
12
|
-
* @summary:
|
|
13
|
-
* @description:
|
|
12
|
+
* @summary: Create an EDC device
|
|
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
15
|
addEdcDevice({ terminalUniqueIdentifier, body, requestHeaders }?: PaymentPlatformApplicationValidator.AddEdcDeviceParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.EdcDeviceUpdateResponse>;
|
|
16
16
|
/**
|
|
@@ -21,8 +21,8 @@ declare class Payment {
|
|
|
21
21
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
22
22
|
* @returns {Promise<PaymentPlatformModel.RefundAccountResponse>} - Success response
|
|
23
23
|
* @name addRefundBankAccountUsingOTP
|
|
24
|
-
* @summary:
|
|
25
|
-
* @description:
|
|
24
|
+
* @summary: Create refund account
|
|
25
|
+
* @description: The addition of a bank account specifically for refunds, employing OTP verification for security - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/addRefundBankAccountUsingOTP/).
|
|
26
26
|
*/
|
|
27
27
|
addRefundBankAccountUsingOTP({ body, requestHeaders }?: PaymentPlatformApplicationValidator.AddRefundBankAccountUsingOTPParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.RefundAccountResponse>;
|
|
28
28
|
/**
|
|
@@ -34,7 +34,7 @@ declare class Payment {
|
|
|
34
34
|
* @returns {Promise<PaymentPlatformModel.CancelPaymentLinkResponse>} -
|
|
35
35
|
* Success response
|
|
36
36
|
* @name cancelPaymentLink
|
|
37
|
-
* @summary: Cancel payment link
|
|
37
|
+
* @summary: Cancel payment link
|
|
38
38
|
* @description: Deactivate and cancel a payment link. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/cancelPaymentLink/).
|
|
39
39
|
*/
|
|
40
40
|
cancelPaymentLink({ body, requestHeaders }?: PaymentPlatformApplicationValidator.CancelPaymentLinkParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.CancelPaymentLinkResponse>;
|
|
@@ -47,8 +47,8 @@ declare class Payment {
|
|
|
47
47
|
* @returns {Promise<PaymentPlatformModel.PaymentStatusUpdateResponse>} -
|
|
48
48
|
* Success response
|
|
49
49
|
* @name checkAndUpdatePaymentStatus
|
|
50
|
-
* @summary:
|
|
51
|
-
* @description:
|
|
50
|
+
* @summary: Poll and update payment status
|
|
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/).
|
|
52
52
|
*/
|
|
53
53
|
checkAndUpdatePaymentStatus({ body, requestHeaders }?: PaymentPlatformApplicationValidator.CheckAndUpdatePaymentStatusParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.PaymentStatusUpdateResponse>;
|
|
54
54
|
/**
|
|
@@ -58,8 +58,8 @@ declare class Payment {
|
|
|
58
58
|
* @returns {Promise<PaymentPlatformModel.PaymentConfirmationResponse>} -
|
|
59
59
|
* Success response
|
|
60
60
|
* @name confirmPayment
|
|
61
|
-
* @summary:
|
|
62
|
-
* @description:
|
|
61
|
+
* @summary: Payment confirmation
|
|
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/).
|
|
63
63
|
*/
|
|
64
64
|
confirmPayment({ body, requestHeaders }?: PaymentPlatformApplicationValidator.ConfirmPaymentParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.PaymentConfirmationResponse>;
|
|
65
65
|
/**
|
|
@@ -72,8 +72,8 @@ declare class Payment {
|
|
|
72
72
|
* - Success response
|
|
73
73
|
*
|
|
74
74
|
* @name createMerchantRefundPriority
|
|
75
|
-
* @summary:
|
|
76
|
-
* @description:
|
|
75
|
+
* @summary: Create merchant refund priority
|
|
76
|
+
* @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/).
|
|
77
77
|
*/
|
|
78
78
|
createMerchantRefundPriority({ configType, body, requestHeaders }?: PaymentPlatformApplicationValidator.CreateMerchantRefundPriorityParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.RefundPriorityResponseSerializer>;
|
|
79
79
|
/**
|
|
@@ -85,8 +85,8 @@ declare class Payment {
|
|
|
85
85
|
* @returns {Promise<PaymentPlatformModel.CreatePaymentLinkResponse>} -
|
|
86
86
|
* Success response
|
|
87
87
|
* @name createPaymentLink
|
|
88
|
-
* @summary: Create payment link
|
|
89
|
-
* @description: Generate a
|
|
88
|
+
* @summary: Create payment link
|
|
89
|
+
* @description: Generate a payment link for accepting payments. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/createPaymentLink/).
|
|
90
90
|
*/
|
|
91
91
|
createPaymentLink({ body, requestHeaders }?: PaymentPlatformApplicationValidator.CreatePaymentLinkParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.CreatePaymentLinkResponse>;
|
|
92
92
|
/**
|
|
@@ -98,7 +98,7 @@ declare class Payment {
|
|
|
98
98
|
* @returns {Promise<PaymentPlatformModel.PaymentOrderResponse>} - Success response
|
|
99
99
|
* @name createPaymentOrder
|
|
100
100
|
* @summary: Create Order
|
|
101
|
-
* @description:
|
|
101
|
+
* @description: Create an order and payment on the aggregator side - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/createPaymentOrder/).
|
|
102
102
|
*/
|
|
103
103
|
createPaymentOrder({ body, requestHeaders }?: PaymentPlatformApplicationValidator.CreatePaymentOrderParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.PaymentOrderResponse>;
|
|
104
104
|
/**
|
|
@@ -111,7 +111,7 @@ declare class Payment {
|
|
|
111
111
|
* - Success response
|
|
112
112
|
*
|
|
113
113
|
* @name edcAggregatorsAndModelList
|
|
114
|
-
* @summary: EDC aggregators and model list
|
|
114
|
+
* @summary: EDC aggregators and model list
|
|
115
115
|
* @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/).
|
|
116
116
|
*/
|
|
117
117
|
edcAggregatorsAndModelList({ requestHeaders }?: any, { responseHeaders }?: object): Promise<PaymentPlatformModel.EdcAggregatorAndModelListResponse>;
|
|
@@ -121,8 +121,8 @@ declare class Payment {
|
|
|
121
121
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
122
122
|
* @returns {Promise<PaymentPlatformModel.EdcDeviceListResponse>} - Success response
|
|
123
123
|
* @name edcDeviceList
|
|
124
|
-
* @summary: EDC
|
|
125
|
-
* @description:
|
|
124
|
+
* @summary: List EDC devices
|
|
125
|
+
* @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/).
|
|
126
126
|
*/
|
|
127
127
|
edcDeviceList({ pageNo, pageSize, isActive, storeId, deviceTag, requestHeaders }?: PaymentPlatformApplicationValidator.EdcDeviceListParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.EdcDeviceListResponse>;
|
|
128
128
|
/**
|
|
@@ -131,8 +131,8 @@ declare class Payment {
|
|
|
131
131
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
132
132
|
* @returns {Promise<PaymentPlatformModel.EdcDeviceStatsResponse>} - Success response
|
|
133
133
|
* @name edcDeviceStats
|
|
134
|
-
* @summary: EDC device stats
|
|
135
|
-
* @description:
|
|
134
|
+
* @summary: EDC device stats
|
|
135
|
+
* @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/).
|
|
136
136
|
*/
|
|
137
137
|
edcDeviceStats({ requestHeaders }?: any, { responseHeaders }?: object): Promise<PaymentPlatformModel.EdcDeviceStatsResponse>;
|
|
138
138
|
/**
|
|
@@ -143,8 +143,8 @@ declare class Payment {
|
|
|
143
143
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
144
144
|
* @returns {Promise<PaymentPlatformModel.RefundAccountResponse>} - Success response
|
|
145
145
|
* @name getBankAccountDetailsOpenAPI
|
|
146
|
-
* @summary: Get bank account details
|
|
147
|
-
* @description: Retrieve bank account information
|
|
146
|
+
* @summary: Get bank account details
|
|
147
|
+
* @description: Retrieve bank account information - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/getBankAccountDetailsOpenAPI/).
|
|
148
148
|
*/
|
|
149
149
|
getBankAccountDetailsOpenAPI({ orderId, requestHash, requestHeaders }?: PaymentPlatformApplicationValidator.GetBankAccountDetailsOpenAPIParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.RefundAccountResponse>;
|
|
150
150
|
/**
|
|
@@ -156,8 +156,8 @@ declare class Payment {
|
|
|
156
156
|
* @returns {Promise<PaymentPlatformModel.PaymentGatewayConfigResponse>} -
|
|
157
157
|
* Success response
|
|
158
158
|
* @name getBrandPaymentGatewayConfig
|
|
159
|
-
* @summary: Get brand payment gateway
|
|
160
|
-
* @description: Retrieve configuration settings for brand payment gateways. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/getBrandPaymentGatewayConfig/).
|
|
159
|
+
* @summary: Get secrets for brand payment gateway
|
|
160
|
+
* @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/).
|
|
161
161
|
*/
|
|
162
162
|
getBrandPaymentGatewayConfig({ aggregator, configType, requestHeaders }?: PaymentPlatformApplicationValidator.GetBrandPaymentGatewayConfigParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.PaymentGatewayConfigResponse>;
|
|
163
163
|
/**
|
|
@@ -167,8 +167,8 @@ declare class Payment {
|
|
|
167
167
|
* @returns {Promise<PaymentPlatformModel.EdcDeviceDetailsResponse>} -
|
|
168
168
|
* Success response
|
|
169
169
|
* @name getEdcDevice
|
|
170
|
-
* @summary: Get EDC device
|
|
171
|
-
* @description: Retrieve detailed information
|
|
170
|
+
* @summary: Get an EDC device
|
|
171
|
+
* @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/).
|
|
172
172
|
*/
|
|
173
173
|
getEdcDevice({ terminalUniqueIdentifier, requestHeaders }?: PaymentPlatformApplicationValidator.GetEdcDeviceParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.EdcDeviceDetailsResponse>;
|
|
174
174
|
/**
|
|
@@ -180,8 +180,8 @@ declare class Payment {
|
|
|
180
180
|
* @returns {Promise<PaymentPlatformModel.AggregatorVersionResponse>} -
|
|
181
181
|
* Success response
|
|
182
182
|
* @name getMerchantAggregatorAppVersion
|
|
183
|
-
* @summary: Get app version
|
|
184
|
-
* @description:
|
|
183
|
+
* @summary: Get app version for Aggregator
|
|
184
|
+
* @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/).
|
|
185
185
|
*/
|
|
186
186
|
getMerchantAggregatorAppVersion({ aggregatorId, businessUnit, device, paymentModeId, subPaymentMode, requestHeaders, }?: PaymentPlatformApplicationValidator.GetMerchantAggregatorAppVersionParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.AggregatorVersionResponse>;
|
|
187
187
|
/**
|
|
@@ -193,8 +193,8 @@ declare class Payment {
|
|
|
193
193
|
* @returns {Promise<PaymentPlatformModel.PlatformPaymentModeResponse>} -
|
|
194
194
|
* Success response
|
|
195
195
|
* @name getMerchantAggregatorPaymentModeDetails
|
|
196
|
-
* @summary: Get merchant aggregator payment mode
|
|
197
|
-
* @description:
|
|
196
|
+
* @summary: Get merchant aggregator and their payment mode
|
|
197
|
+
* @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/).
|
|
198
198
|
*/
|
|
199
199
|
getMerchantAggregatorPaymentModeDetails({ aggregatorId, businessUnit, device, requestHeaders }?: PaymentPlatformApplicationValidator.GetMerchantAggregatorPaymentModeDetailsParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.PlatformPaymentModeResponse>;
|
|
200
200
|
/**
|
|
@@ -207,7 +207,7 @@ declare class Payment {
|
|
|
207
207
|
* Success response
|
|
208
208
|
* @name getMerchantPaymentOption
|
|
209
209
|
* @summary: Get merchant payment option
|
|
210
|
-
* @description: Retrieve
|
|
210
|
+
* @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/).
|
|
211
211
|
*/
|
|
212
212
|
getMerchantPaymentOption({ requestHeaders }?: any, { responseHeaders }?: object): Promise<PaymentPlatformModel.PlatformPaymentModeResponse>;
|
|
213
213
|
/**
|
|
@@ -221,7 +221,7 @@ declare class Payment {
|
|
|
221
221
|
*
|
|
222
222
|
* @name getMerchantRefundPriority
|
|
223
223
|
* @summary: Get merchant refund priority
|
|
224
|
-
* @description:
|
|
224
|
+
* @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/).
|
|
225
225
|
*/
|
|
226
226
|
getMerchantRefundPriority({ configType, requestHeaders }?: PaymentPlatformApplicationValidator.GetMerchantRefundPriorityParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.RefundPriorityResponseSerializer>;
|
|
227
227
|
/**
|
|
@@ -233,8 +233,8 @@ declare class Payment {
|
|
|
233
233
|
* @returns {Promise<PaymentPlatformModel.PlatformPaymentModeResponse>} -
|
|
234
234
|
* Success response
|
|
235
235
|
* @name getPGConfigAggregators
|
|
236
|
-
* @summary: Get
|
|
237
|
-
* @description:
|
|
236
|
+
* @summary: Get merchant aggregator payment mode
|
|
237
|
+
* @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/).
|
|
238
238
|
*/
|
|
239
239
|
getPGConfigAggregators({ requestHeaders }?: any, { responseHeaders }?: object): Promise<PaymentPlatformModel.PlatformPaymentModeResponse>;
|
|
240
240
|
/**
|
|
@@ -245,8 +245,8 @@ declare class Payment {
|
|
|
245
245
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
246
246
|
* @returns {Promise<PaymentPlatformModel.GetPaymentCodeResponse>} - Success response
|
|
247
247
|
* @name getPaymentCodeOption
|
|
248
|
-
* @summary: Get payment mode
|
|
249
|
-
* @description:
|
|
248
|
+
* @summary: Get payment mode codes
|
|
249
|
+
* @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/).
|
|
250
250
|
*/
|
|
251
251
|
getPaymentCodeOption({ requestHeaders }?: any, { responseHeaders }?: object): Promise<PaymentPlatformModel.GetPaymentCodeResponse>;
|
|
252
252
|
/**
|
|
@@ -255,8 +255,8 @@ declare class Payment {
|
|
|
255
255
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
256
256
|
* @returns {Promise<PaymentPlatformModel.GetPaymentLinkResponse>} - Success response
|
|
257
257
|
* @name getPaymentLink
|
|
258
|
-
* @summary: Get payment link
|
|
259
|
-
* @description: Retrieve a link for making payments. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/getPaymentLink/).
|
|
258
|
+
* @summary: Get payment link
|
|
259
|
+
* @description: Retrieve a payment link for making payments. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/getPaymentLink/).
|
|
260
260
|
*/
|
|
261
261
|
getPaymentLink({ paymentLinkId, requestHeaders }?: PaymentPlatformApplicationValidator.GetPaymentLinkParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.GetPaymentLinkResponse>;
|
|
262
262
|
/**
|
|
@@ -268,8 +268,8 @@ declare class Payment {
|
|
|
268
268
|
* @returns {Promise<PaymentPlatformModel.PlatformPaymentModeResponse>} -
|
|
269
269
|
* Success response
|
|
270
270
|
* @name getPaymentModeControlRoutes
|
|
271
|
-
* @summary: Get
|
|
272
|
-
* @description:
|
|
271
|
+
* @summary: Get offline/advance payment mode
|
|
272
|
+
* @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/).
|
|
273
273
|
*/
|
|
274
274
|
getPaymentModeControlRoutes({ mode, requestHeaders }?: PaymentPlatformApplicationValidator.GetPaymentModeControlRoutesParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.PlatformPaymentModeResponse>;
|
|
275
275
|
/**
|
|
@@ -282,8 +282,8 @@ declare class Payment {
|
|
|
282
282
|
* - Success response
|
|
283
283
|
*
|
|
284
284
|
* @name getPaymentModeCustomConfig
|
|
285
|
-
* @summary: Get
|
|
286
|
-
* @description:
|
|
285
|
+
* @summary: Get advance payment custom configurations
|
|
286
|
+
* @description: Merchants to fetch detailed information regarding advance payment custom configurations tailored to their specific business needs. merchants can access settings such as customer restrictions, available payment modes for both pre-order and post-order transactions - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/getPaymentModeCustomConfig/).
|
|
287
287
|
*/
|
|
288
288
|
getPaymentModeCustomConfig({ mode, requestHeaders }?: PaymentPlatformApplicationValidator.GetPaymentModeCustomConfigParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.PaymentCustomConfigResponseSchema>;
|
|
289
289
|
/**
|
|
@@ -294,8 +294,8 @@ declare class Payment {
|
|
|
294
294
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
295
295
|
* @returns {Promise<PaymentPlatformModel.PaymentOptionsResponse>} - Success response
|
|
296
296
|
* @name getPaymentModeRoutes
|
|
297
|
-
* @summary: Get payment
|
|
298
|
-
* @description:
|
|
297
|
+
* @summary: Get payment modes
|
|
298
|
+
* @description: Available payment methods on the payment page, specifying the aggregator for each option, such as 'Netbanking powered by Juspay' and 'Card powered by Razorpay'. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/getPaymentModeRoutes/).
|
|
299
299
|
*/
|
|
300
300
|
getPaymentModeRoutes({ refresh, requestType, orderId, shipmentId, requestHeaders }?: PaymentPlatformApplicationValidator.GetPaymentModeRoutesParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.PaymentOptionsResponse>;
|
|
301
301
|
/**
|
|
@@ -307,8 +307,8 @@ declare class Payment {
|
|
|
307
307
|
* @returns {Promise<PaymentPlatformModel.PaymentSessionSerializer>} -
|
|
308
308
|
* Success response
|
|
309
309
|
* @name getPaymentSession
|
|
310
|
-
* @summary:
|
|
311
|
-
* @description:
|
|
310
|
+
* @summary: Get payment session
|
|
311
|
+
* @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/).
|
|
312
312
|
*/
|
|
313
313
|
getPaymentSession({ gid, lineItem, requestHeaders }?: PaymentPlatformApplicationValidator.GetPaymentSessionParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.PaymentSessionSerializer>;
|
|
314
314
|
/**
|
|
@@ -320,8 +320,8 @@ declare class Payment {
|
|
|
320
320
|
* @returns {Promise<PaymentPlatformModel.PaymentModeRouteResponse>} -
|
|
321
321
|
* Success response
|
|
322
322
|
* @name getPosPaymentModeRoutes
|
|
323
|
-
* @summary:
|
|
324
|
-
* @description:
|
|
323
|
+
* @summary: List POS payment modes
|
|
324
|
+
* @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/).
|
|
325
325
|
*/
|
|
326
326
|
getPosPaymentModeRoutes({ amount, pincode, orderType, cartId, checkoutMode, refresh, orderId, cardReference, userDetails, displaySplit, advancePayment, shipmentId, requestHeaders, }?: PaymentPlatformApplicationValidator.GetPosPaymentModeRoutesParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.PaymentModeRouteResponse>;
|
|
327
327
|
/**
|
|
@@ -333,8 +333,8 @@ declare class Payment {
|
|
|
333
333
|
* @returns {Promise<PaymentPlatformModel.OrderBeneficiaryResponse>} -
|
|
334
334
|
* Success response
|
|
335
335
|
* @name getUserBeneficiaries
|
|
336
|
-
* @summary: Get user beneficiaries
|
|
337
|
-
* @description:
|
|
336
|
+
* @summary: Get user beneficiaries
|
|
337
|
+
* @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/).
|
|
338
338
|
*/
|
|
339
339
|
getUserBeneficiaries({ orderId, requestHeaders }?: PaymentPlatformApplicationValidator.GetUserBeneficiariesParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.OrderBeneficiaryResponse>;
|
|
340
340
|
/**
|
|
@@ -345,8 +345,8 @@ declare class Payment {
|
|
|
345
345
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
346
346
|
* @returns {Promise<PaymentPlatformModel.GetUserCODLimitResponse>} - Success response
|
|
347
347
|
* @name getUserCODlimitRoutes
|
|
348
|
-
* @summary: Get user COD
|
|
349
|
-
* @description: Retrieve
|
|
348
|
+
* @summary: Get user COD
|
|
349
|
+
* @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/).
|
|
350
350
|
*/
|
|
351
351
|
getUserCODlimitRoutes({ merchantUserId, mobileNo, requestHeaders }?: PaymentPlatformApplicationValidator.GetUserCODlimitRoutesParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.GetUserCODLimitResponse>;
|
|
352
352
|
/**
|
|
@@ -358,8 +358,8 @@ declare class Payment {
|
|
|
358
358
|
* @returns {Promise<PaymentPlatformModel.OrderBeneficiaryResponse>} -
|
|
359
359
|
* Success response
|
|
360
360
|
* @name getUserOrderBeneficiaries
|
|
361
|
-
* @summary: Get user order beneficiaries
|
|
362
|
-
* @description: Retrieve
|
|
361
|
+
* @summary: Get user order beneficiaries
|
|
362
|
+
* @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/).
|
|
363
363
|
*/
|
|
364
364
|
getUserOrderBeneficiaries({ orderId, requestHeaders }?: PaymentPlatformApplicationValidator.GetUserOrderBeneficiariesParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.OrderBeneficiaryResponse>;
|
|
365
365
|
/**
|
|
@@ -371,8 +371,8 @@ declare class Payment {
|
|
|
371
371
|
* @returns {Promise<PaymentPlatformModel.PaymentInitializationResponse>} -
|
|
372
372
|
* Success response
|
|
373
373
|
* @name initialisePayment
|
|
374
|
-
* @summary:
|
|
375
|
-
* @description:
|
|
374
|
+
* @summary: Start payment process
|
|
375
|
+
* @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/).
|
|
376
376
|
*/
|
|
377
377
|
initialisePayment({ body, requestHeaders }?: PaymentPlatformApplicationValidator.InitialisePaymentParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.PaymentInitializationResponse>;
|
|
378
378
|
/**
|
|
@@ -384,8 +384,8 @@ declare class Payment {
|
|
|
384
384
|
* @returns {Promise<PaymentPlatformModel.MerchantOnBoardingResponse>} -
|
|
385
385
|
* Success response
|
|
386
386
|
* @name merchantOnBoarding
|
|
387
|
-
* @summary: Merchant onboarding for BNPL
|
|
388
|
-
* @description: Initiate the onboarding process for
|
|
387
|
+
* @summary: Merchant onboarding for BNPL
|
|
388
|
+
* @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/).
|
|
389
389
|
*/
|
|
390
390
|
merchantOnBoarding({ body, requestHeaders }?: PaymentPlatformApplicationValidator.MerchantOnBoardingParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.MerchantOnBoardingResponse>;
|
|
391
391
|
/**
|
|
@@ -394,8 +394,8 @@ declare class Payment {
|
|
|
394
394
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
395
395
|
* @returns {Promise<PaymentPlatformModel.GetOauthUrlResponse>} - Success response
|
|
396
396
|
* @name oauthGetUrl
|
|
397
|
-
* @summary: Get OAuth URL
|
|
398
|
-
* @description:
|
|
397
|
+
* @summary: Get OAuth URL
|
|
398
|
+
* @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/).
|
|
399
399
|
*/
|
|
400
400
|
oauthGetUrl({ aggregator, successRedirectUrl, failureRedirectUrl, requestHeaders }?: PaymentPlatformApplicationValidator.OauthGetUrlParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.GetOauthUrlResponse>;
|
|
401
401
|
/**
|
|
@@ -407,8 +407,8 @@ declare class Payment {
|
|
|
407
407
|
* @returns {Promise<PaymentPlatformModel.PlatformPaymentModeResponse>} -
|
|
408
408
|
* Success response
|
|
409
409
|
* @name patchMerchantAggregatorPaymentModeDetails
|
|
410
|
-
* @summary:
|
|
411
|
-
* @description:
|
|
410
|
+
* @summary: Update merchant aggregator payment mode
|
|
411
|
+
* @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/).
|
|
412
412
|
*/
|
|
413
413
|
patchMerchantAggregatorPaymentModeDetails({ aggregatorId, body, requestHeaders }?: PaymentPlatformApplicationValidator.PatchMerchantAggregatorPaymentModeDetailsParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.PlatformPaymentModeResponse>;
|
|
414
414
|
/**
|
|
@@ -420,8 +420,8 @@ declare class Payment {
|
|
|
420
420
|
* @returns {Promise<PaymentPlatformModel.PlatformPaymentModeResponse>} -
|
|
421
421
|
* Success response
|
|
422
422
|
* @name patchMerchantPaymentOption
|
|
423
|
-
* @summary:
|
|
424
|
-
* @description:
|
|
423
|
+
* @summary: Update payment gateways and payment mode
|
|
424
|
+
* @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/).
|
|
425
425
|
*/
|
|
426
426
|
patchMerchantPaymentOption({ body, requestHeaders }?: PaymentPlatformApplicationValidator.PatchMerchantPaymentOptionParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.PlatformPaymentModeResponse>;
|
|
427
427
|
/**
|
|
@@ -433,8 +433,8 @@ declare class Payment {
|
|
|
433
433
|
* @returns {Promise<PaymentPlatformModel.PlatformPaymentModeResponse>} -
|
|
434
434
|
* Success response
|
|
435
435
|
* @name patchMerchantPaymentOptionVersion
|
|
436
|
-
* @summary: Update app version
|
|
437
|
-
* @description:
|
|
436
|
+
* @summary: Update app version for Aggrgator
|
|
437
|
+
* @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/).
|
|
438
438
|
*/
|
|
439
439
|
patchMerchantPaymentOptionVersion({ aggregatorId, body, requestHeaders }?: PaymentPlatformApplicationValidator.PatchMerchantPaymentOptionVersionParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.PlatformPaymentModeResponse>;
|
|
440
440
|
/**
|
|
@@ -447,8 +447,8 @@ declare class Payment {
|
|
|
447
447
|
* - Success response
|
|
448
448
|
*
|
|
449
449
|
* @name paymentStatusBulk
|
|
450
|
-
* @summary:
|
|
451
|
-
* @description: Retrieve
|
|
450
|
+
* @summary: Retrieve status of multiple payments in bulk
|
|
451
|
+
* @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/).
|
|
452
452
|
*/
|
|
453
453
|
paymentStatusBulk({ body, requestHeaders }?: PaymentPlatformApplicationValidator.PaymentStatusBulkParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.PaymentStatusBulkHandlerResponse>;
|
|
454
454
|
/**
|
|
@@ -460,8 +460,8 @@ declare class Payment {
|
|
|
460
460
|
* @returns {Promise<PaymentPlatformModel.PollingPaymentLinkResponse>} -
|
|
461
461
|
* Success response
|
|
462
462
|
* @name pollingPaymentLink
|
|
463
|
-
* @summary:
|
|
464
|
-
* @description:
|
|
463
|
+
* @summary: Poll status of payment link
|
|
464
|
+
* @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/).
|
|
465
465
|
*/
|
|
466
466
|
pollingPaymentLink({ paymentLinkId, requestHeaders }?: PaymentPlatformApplicationValidator.PollingPaymentLinkParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.PollingPaymentLinkResponse>;
|
|
467
467
|
/**
|
|
@@ -470,8 +470,8 @@ declare class Payment {
|
|
|
470
470
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
471
471
|
* @returns {Promise<PaymentPlatformModel.RepaymentResponse>} - Success response
|
|
472
472
|
* @name repaymentDetails
|
|
473
|
-
* @summary: Repayment details for BNPL
|
|
474
|
-
* @description: Retrieve
|
|
473
|
+
* @summary: Repayment details for BNPL
|
|
474
|
+
* @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/).
|
|
475
475
|
*/
|
|
476
476
|
repaymentDetails({ body, requestHeaders }?: PaymentPlatformApplicationValidator.RepaymentDetailsParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.RepaymentResponse>;
|
|
477
477
|
/**
|
|
@@ -483,8 +483,8 @@ declare class Payment {
|
|
|
483
483
|
* @returns {Promise<PaymentPlatformModel.ResendOrCancelPaymentResponse>} -
|
|
484
484
|
* Success response
|
|
485
485
|
* @name resendOrCancelPayment
|
|
486
|
-
* @summary: Resend or cancel payment
|
|
487
|
-
* @description:
|
|
486
|
+
* @summary: Resend or cancel payment
|
|
487
|
+
* @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/).
|
|
488
488
|
*/
|
|
489
489
|
resendOrCancelPayment({ body, requestHeaders }?: PaymentPlatformApplicationValidator.ResendOrCancelPaymentParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.ResendOrCancelPaymentResponse>;
|
|
490
490
|
/**
|
|
@@ -496,8 +496,8 @@ declare class Payment {
|
|
|
496
496
|
* @returns {Promise<PaymentPlatformModel.ResendPaymentLinkResponse>} -
|
|
497
497
|
* Success response
|
|
498
498
|
* @name resendPaymentLink
|
|
499
|
-
* @summary: Resend payment link
|
|
500
|
-
* @description:
|
|
499
|
+
* @summary: Resend payment link
|
|
500
|
+
* @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/).
|
|
501
501
|
*/
|
|
502
502
|
resendPaymentLink({ body, requestHeaders }?: PaymentPlatformApplicationValidator.ResendPaymentLinkParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.ResendPaymentLinkResponse>;
|
|
503
503
|
/**
|
|
@@ -506,8 +506,8 @@ declare class Payment {
|
|
|
506
506
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
507
507
|
* @returns {Promise<PaymentPlatformModel.RevokeOAuthToken>} - Success response
|
|
508
508
|
* @name revokeOauthToken
|
|
509
|
-
* @summary: Revoke OAuth token
|
|
510
|
-
* @description:
|
|
509
|
+
* @summary: Revoke OAuth token
|
|
510
|
+
* @description: Revoke the creds for payment aggregator razropay. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/revokeOauthToken/).
|
|
511
511
|
*/
|
|
512
512
|
revokeOauthToken({ aggregator, requestHeaders }?: PaymentPlatformApplicationValidator.RevokeOauthTokenParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.RevokeOAuthToken>;
|
|
513
513
|
/**
|
|
@@ -519,8 +519,8 @@ declare class Payment {
|
|
|
519
519
|
* @returns {Promise<PaymentPlatformModel.PaymentGatewayToBeReviewed>} -
|
|
520
520
|
* Success response
|
|
521
521
|
* @name saveBrandPaymentGatewayConfig
|
|
522
|
-
* @summary: Save brand payment gateway config
|
|
523
|
-
* @description: Store and update configuration settings for brand payment gateways. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/saveBrandPaymentGatewayConfig/).
|
|
522
|
+
* @summary: Save brand payment gateway config
|
|
523
|
+
* @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/).
|
|
524
524
|
*/
|
|
525
525
|
saveBrandPaymentGatewayConfig({ body, requestHeaders }?: PaymentPlatformApplicationValidator.SaveBrandPaymentGatewayConfigParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.PaymentGatewayToBeReviewed>;
|
|
526
526
|
/**
|
|
@@ -532,8 +532,8 @@ declare class Payment {
|
|
|
532
532
|
* @returns {Promise<PaymentPlatformModel.PlatformPaymentModeResponse>} -
|
|
533
533
|
* Success response
|
|
534
534
|
* @name setMerchantModeControlRoutes
|
|
535
|
-
* @summary: Update offline payment mode
|
|
536
|
-
* @description:
|
|
535
|
+
* @summary: Update offline payment mode
|
|
536
|
+
* @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/).
|
|
537
537
|
*/
|
|
538
538
|
setMerchantModeControlRoutes({ mode, body, requestHeaders }?: PaymentPlatformApplicationValidator.SetMerchantModeControlRoutesParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.PlatformPaymentModeResponse>;
|
|
539
539
|
/**
|
|
@@ -546,8 +546,8 @@ declare class Payment {
|
|
|
546
546
|
* - Success response
|
|
547
547
|
*
|
|
548
548
|
* @name setPaymentModeCustomConfig
|
|
549
|
-
* @summary: Update
|
|
550
|
-
* @description:
|
|
549
|
+
* @summary: Update advance payment custom configurations
|
|
550
|
+
* @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/).
|
|
551
551
|
*/
|
|
552
552
|
setPaymentModeCustomConfig({ mode, body, requestHeaders }?: PaymentPlatformApplicationValidator.SetPaymentModeCustomConfigParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.PaymentCustomConfigResponseSchema>;
|
|
553
553
|
/**
|
|
@@ -558,8 +558,8 @@ declare class Payment {
|
|
|
558
558
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
559
559
|
* @returns {Promise<PaymentPlatformModel.SetCODOptionResponse>} - Success response
|
|
560
560
|
* @name setUserCODlimitRoutes
|
|
561
|
-
* @summary: Set user COD
|
|
562
|
-
* @description:
|
|
561
|
+
* @summary: Set user COD
|
|
562
|
+
* @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/).
|
|
563
563
|
*/
|
|
564
564
|
setUserCODlimitRoutes({ body, requestHeaders }?: PaymentPlatformApplicationValidator.SetUserCODlimitRoutesParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.SetCODOptionResponse>;
|
|
565
565
|
/**
|
|
@@ -568,8 +568,8 @@ declare class Payment {
|
|
|
568
568
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
569
569
|
* @returns {Promise<PaymentPlatformModel.EdcDeviceAddResponse>} - Success response
|
|
570
570
|
* @name updateEdcDevice
|
|
571
|
-
* @summary: Update EDC device
|
|
572
|
-
* @description:
|
|
571
|
+
* @summary: Update EDC device
|
|
572
|
+
* @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/).
|
|
573
573
|
*/
|
|
574
574
|
updateEdcDevice({ body, requestHeaders }?: PaymentPlatformApplicationValidator.UpdateEdcDeviceParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.EdcDeviceAddResponse>;
|
|
575
575
|
/**
|
|
@@ -582,8 +582,8 @@ declare class Payment {
|
|
|
582
582
|
* - Success response
|
|
583
583
|
*
|
|
584
584
|
* @name updateMerchantRefundPriority
|
|
585
|
-
* @summary:
|
|
586
|
-
* @description:
|
|
585
|
+
* @summary: Update merchant refund priority
|
|
586
|
+
* @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/).
|
|
587
587
|
*/
|
|
588
588
|
updateMerchantRefundPriority({ configType, body, requestHeaders }?: PaymentPlatformApplicationValidator.UpdateMerchantRefundPriorityParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.RefundPriorityResponseSerializer>;
|
|
589
589
|
/**
|
|
@@ -596,8 +596,8 @@ declare class Payment {
|
|
|
596
596
|
* - Success response
|
|
597
597
|
*
|
|
598
598
|
* @name updatePaymentSession
|
|
599
|
-
* @summary: Update payment session
|
|
600
|
-
* @description:
|
|
599
|
+
* @summary: Update payment session
|
|
600
|
+
* @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/).
|
|
601
601
|
*/
|
|
602
602
|
updatePaymentSession({ gid, body, requestHeaders }?: PaymentPlatformApplicationValidator.UpdatePaymentSessionParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.PaymentSessionResponseSerializer>;
|
|
603
603
|
/**
|
|
@@ -610,8 +610,8 @@ declare class Payment {
|
|
|
610
610
|
* - Success response
|
|
611
611
|
*
|
|
612
612
|
* @name updateRefundSession
|
|
613
|
-
* @summary: Update refund session
|
|
614
|
-
* @description:
|
|
613
|
+
* @summary: Update refund session
|
|
614
|
+
* @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/).
|
|
615
615
|
*/
|
|
616
616
|
updateRefundSession({ gid, requestId, body, requestHeaders }?: PaymentPlatformApplicationValidator.UpdateRefundSessionParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.RefundSessionResponseSerializer>;
|
|
617
617
|
/**
|
|
@@ -623,10 +623,10 @@ declare class Payment {
|
|
|
623
623
|
* @returns {Promise<PaymentPlatformModel.ValidateCustomerResponse>} -
|
|
624
624
|
* Success response
|
|
625
625
|
* @name verifyCustomerForPayment
|
|
626
|
-
* @summary:
|
|
627
|
-
* @description:
|
|
626
|
+
* @summary: Validate customer for paylater
|
|
627
|
+
* @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/).
|
|
628
628
|
*/
|
|
629
629
|
verifyCustomerForPayment({ body, requestHeaders }?: PaymentPlatformApplicationValidator.VerifyCustomerForPaymentParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.ValidateCustomerResponse>;
|
|
630
630
|
}
|
|
631
|
-
import PaymentPlatformApplicationValidator = require("
|
|
632
|
-
import PaymentPlatformModel = require("
|
|
631
|
+
import PaymentPlatformApplicationValidator = require("sdk/output/javascript/code/sdk/platform/Payment/PaymentPlatformApplicationValidator");
|
|
632
|
+
import PaymentPlatformModel = require("sdk/output/javascript/code/sdk/platform/Payment/PaymentPlatformModel");
|