@gofynd/fdk-client-javascript 3.3.3 → 3.3.6
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -1
- package/package.json +1 -1
- package/sdk/application/Cart/CartApplicationClient.d.ts +30 -30
- package/sdk/application/Cart/CartApplicationClient.js +30 -30
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +30 -30
- package/sdk/application/Catalog/CatalogApplicationClient.js +30 -30
- package/sdk/application/Common/CommonApplicationClient.d.ts +2 -2
- package/sdk/application/Common/CommonApplicationClient.js +2 -2
- package/sdk/application/Communication/CommunicationApplicationClient.d.ts +3 -3
- package/sdk/application/Communication/CommunicationApplicationClient.js +3 -3
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +16 -16
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +16 -16
- package/sdk/application/Content/ContentApplicationClient.d.ts +24 -24
- package/sdk/application/Content/ContentApplicationClient.js +24 -24
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +3 -3
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +3 -3
- package/sdk/application/Finance/FinanceApplicationClient.d.ts +2 -2
- package/sdk/application/Finance/FinanceApplicationClient.js +2 -2
- package/sdk/application/Lead/LeadApplicationClient.d.ts +5 -5
- package/sdk/application/Lead/LeadApplicationClient.js +5 -5
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +9 -9
- package/sdk/application/Logistic/LogisticApplicationClient.js +9 -9
- package/sdk/application/Order/OrderApplicationClient.d.ts +12 -12
- package/sdk/application/Order/OrderApplicationClient.js +12 -12
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +46 -46
- package/sdk/application/Payment/PaymentApplicationClient.js +46 -46
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +7 -7
- package/sdk/application/Rewards/RewardsApplicationClient.js +7 -7
- package/sdk/application/Share/ShareApplicationClient.d.ts +7 -7
- package/sdk/application/Share/ShareApplicationClient.js +7 -7
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +4 -4
- package/sdk/application/Theme/ThemeApplicationClient.js +4 -4
- package/sdk/application/User/UserApplicationClient.d.ts +47 -47
- package/sdk/application/User/UserApplicationClient.js +47 -47
- package/sdk/application/Webhook/WebhookApplicationClient.d.ts +1 -1
- package/sdk/application/Webhook/WebhookApplicationClient.js +1 -1
- package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +6 -6
- package/sdk/partner/FileStorage/FileStoragePartnerClient.js +6 -6
- package/sdk/partner/Lead/LeadPartnerClient.d.ts +7 -7
- package/sdk/partner/Lead/LeadPartnerClient.js +7 -7
- package/sdk/partner/Lead/LeadPartnerModel.d.ts +2 -2
- package/sdk/partner/Lead/LeadPartnerModel.js +1 -1
- package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +25 -25
- package/sdk/partner/Logistics/LogisticsPartnerClient.js +25 -25
- package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +57 -3
- package/sdk/partner/Logistics/LogisticsPartnerModel.js +40 -1
- package/sdk/partner/Theme/ThemePartnerClient.d.ts +24 -24
- package/sdk/partner/Theme/ThemePartnerClient.js +24 -24
- package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +10 -10
- package/sdk/partner/Webhook/WebhookPartnerClient.js +10 -10
- package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +2 -2
- package/sdk/partner/Webhook/WebhookPartnerModel.js +1 -1
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.d.ts +3 -3
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.js +3 -3
- package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +2 -2
- package/sdk/platform/Analytics/AnalyticsPlatformModel.js +1 -1
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +1 -1
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +1 -1
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +5 -5
- package/sdk/platform/Billing/BillingPlatformClient.js +5 -5
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +62 -62
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +62 -62
- package/sdk/platform/Cart/CartPlatformModel.d.ts +62 -3
- package/sdk/platform/Cart/CartPlatformModel.js +33 -1
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +66 -66
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +66 -66
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +89 -82
- package/sdk/platform/Catalog/CatalogPlatformClient.js +121 -85
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +61 -3
- package/sdk/platform/Catalog/CatalogPlatformModel.js +42 -1
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +46 -5
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +21 -4
- package/sdk/platform/Common/CommonPlatformClient.d.ts +2 -2
- package/sdk/platform/Common/CommonPlatformClient.js +2 -2
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +67 -67
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +67 -67
- package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +1 -1
- package/sdk/platform/Communication/CommunicationPlatformClient.js +1 -1
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +2 -2
- package/sdk/platform/Communication/CommunicationPlatformModel.js +1 -1
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +14 -14
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +14 -14
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +2 -2
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +1 -1
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +32 -32
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +32 -32
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +11 -11
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +11 -11
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +2 -2
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +1 -1
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +107 -107
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +107 -107
- package/sdk/platform/Content/ContentPlatformClient.d.ts +40 -40
- package/sdk/platform/Content/ContentPlatformClient.js +40 -40
- package/sdk/platform/Content/ContentPlatformModel.d.ts +2 -2
- package/sdk/platform/Content/ContentPlatformModel.js +1 -1
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +11 -11
- package/sdk/platform/Discount/DiscountPlatformClient.js +11 -11
- package/sdk/platform/Discount/DiscountPlatformModel.d.ts +2 -2
- package/sdk/platform/Discount/DiscountPlatformModel.js +1 -1
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +4 -4
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +4 -4
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +6 -6
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +6 -6
- package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +10 -10
- package/sdk/platform/Lead/LeadPlatformApplicationClient.js +10 -10
- package/sdk/platform/Lead/LeadPlatformClient.d.ts +9 -9
- package/sdk/platform/Lead/LeadPlatformClient.js +9 -9
- package/sdk/platform/Lead/LeadPlatformModel.d.ts +2 -2
- package/sdk/platform/Lead/LeadPlatformModel.js +1 -1
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +5 -5
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +5 -5
- package/sdk/platform/Order/OrderPlatformClient.d.ts +58 -58
- package/sdk/platform/Order/OrderPlatformClient.js +58 -58
- package/sdk/platform/Order/OrderPlatformModel.d.ts +9 -9
- package/sdk/platform/Order/OrderPlatformModel.js +6 -6
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +2 -2
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +2 -2
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +51 -51
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +51 -51
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +10 -10
- package/sdk/platform/Payment/PaymentPlatformClient.js +10 -10
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +85 -3
- package/sdk/platform/Payment/PaymentPlatformModel.js +49 -1
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +12 -12
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +12 -12
- package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +2 -2
- package/sdk/platform/Rewards/RewardsPlatformModel.js +1 -1
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +38 -38
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +38 -38
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +28 -28
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +28 -28
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +59 -3
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +42 -1
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +5 -5
- package/sdk/platform/Share/SharePlatformApplicationClient.js +5 -5
- package/sdk/platform/Share/SharePlatformModel.d.ts +2 -2
- package/sdk/platform/Share/SharePlatformModel.js +1 -1
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +22 -22
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +22 -22
- package/sdk/platform/Theme/ThemePlatformClient.d.ts +4 -4
- package/sdk/platform/Theme/ThemePlatformClient.js +4 -4
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +34 -34
- package/sdk/platform/User/UserPlatformApplicationClient.js +34 -34
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +9 -9
- package/sdk/platform/Webhook/WebhookPlatformClient.js +9 -9
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +2 -2
- package/sdk/platform/Webhook/WebhookPlatformModel.js +1 -1
- package/sdk/public/Catalog/CatalogPublicClient.d.ts +1 -1
- package/sdk/public/Catalog/CatalogPublicClient.js +1 -1
- package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +2 -2
- package/sdk/public/Configuration/ConfigurationPublicClient.js +2 -2
- package/sdk/public/Content/ContentPublicClient.d.ts +14 -14
- package/sdk/public/Content/ContentPublicClient.js +14 -14
- package/sdk/public/Partner/PartnerPublicClient.d.ts +1 -1
- package/sdk/public/Partner/PartnerPublicClient.js +1 -1
- package/sdk/public/Webhook/WebhookPublicClient.d.ts +5 -5
- package/sdk/public/Webhook/WebhookPublicClient.js +5 -5
|
@@ -11,7 +11,7 @@ declare class Partner {
|
|
|
11
11
|
* Success response
|
|
12
12
|
* @name addProxyPath
|
|
13
13
|
* @summary: Create extension proxy
|
|
14
|
-
* @description: Extension proxy can be used to call extension API from storefront and make extension API integration seamless. - Check out [method documentation](https://
|
|
14
|
+
* @description: Extension proxy can be used to call extension API from storefront and make extension API integration seamless. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/partner/addProxyPath/).
|
|
15
15
|
*/
|
|
16
16
|
addProxyPath({ extensionId, body, requestHeaders }?: PartnerPlatformApplicationValidator.AddProxyPathParam, { responseHeaders }?: object): Promise<PartnerPlatformModel.ExtensionProxyPathCreation>;
|
|
17
17
|
/**
|
|
@@ -22,7 +22,7 @@ declare class Partner {
|
|
|
22
22
|
* Success response
|
|
23
23
|
* @name removeProxyPath
|
|
24
24
|
* @summary: Remove extension proxy
|
|
25
|
-
* @description: Remove the proxy which are created earlier for the extension. - Check out [method documentation](https://
|
|
25
|
+
* @description: Remove the proxy which are created earlier for the extension. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/partner/removeProxyPath/).
|
|
26
26
|
*/
|
|
27
27
|
removeProxyPath({ extensionId, attachedPath, requestHeaders }?: PartnerPlatformApplicationValidator.RemoveProxyPathParam, { responseHeaders }?: object): Promise<PartnerPlatformModel.ExtensionProxyPathDelete>;
|
|
28
28
|
}
|
|
@@ -23,7 +23,7 @@ class Partner {
|
|
|
23
23
|
* Success response
|
|
24
24
|
* @name addProxyPath
|
|
25
25
|
* @summary: Create extension proxy
|
|
26
|
-
* @description: Extension proxy can be used to call extension API from storefront and make extension API integration seamless. - Check out [method documentation](https://
|
|
26
|
+
* @description: Extension proxy can be used to call extension API from storefront and make extension API integration seamless. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/partner/addProxyPath/).
|
|
27
27
|
*/
|
|
28
28
|
async addProxyPath(
|
|
29
29
|
{ extensionId, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -105,7 +105,7 @@ class Partner {
|
|
|
105
105
|
* Success response
|
|
106
106
|
* @name removeProxyPath
|
|
107
107
|
* @summary: Remove extension proxy
|
|
108
|
-
* @description: Remove the proxy which are created earlier for the extension. - Check out [method documentation](https://
|
|
108
|
+
* @description: Remove the proxy which are created earlier for the extension. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/partner/removeProxyPath/).
|
|
109
109
|
*/
|
|
110
110
|
async removeProxyPath(
|
|
111
111
|
{ extensionId, attachedPath, requestHeaders } = { requestHeaders: {} },
|
|
@@ -10,7 +10,7 @@ declare class Payment {
|
|
|
10
10
|
* @returns {Promise<PaymentPlatformModel.EdcDeviceUpdateDetails>} - Success response
|
|
11
11
|
* @name addEdcDevice
|
|
12
12
|
* @summary: Create an EDC device
|
|
13
|
-
* @description: Registration and addition of a new EDC device to the system - Check out [method documentation](https://
|
|
13
|
+
* @description: Registration and addition of a new EDC device to the system - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/payment/addEdcDevice/).
|
|
14
14
|
*/
|
|
15
15
|
addEdcDevice({ terminalUniqueIdentifier, body, requestHeaders }?: PaymentPlatformApplicationValidator.AddEdcDeviceParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.EdcDeviceUpdateDetails>;
|
|
16
16
|
/**
|
|
@@ -22,7 +22,7 @@ declare class Payment {
|
|
|
22
22
|
* @returns {Promise<PaymentPlatformModel.RefundAccountDetails>} - Success response
|
|
23
23
|
* @name addRefundBankAccountUsingOTP
|
|
24
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://
|
|
25
|
+
* @description: The addition of a bank account specifically for refunds, employing OTP verification for security - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/payment/addRefundBankAccountUsingOTP/).
|
|
26
26
|
*/
|
|
27
27
|
addRefundBankAccountUsingOTP({ body, requestHeaders }?: PaymentPlatformApplicationValidator.AddRefundBankAccountUsingOTPParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.RefundAccountDetails>;
|
|
28
28
|
/**
|
|
@@ -35,7 +35,7 @@ declare class Payment {
|
|
|
35
35
|
* Success response
|
|
36
36
|
* @name cancelPaymentLink
|
|
37
37
|
* @summary: Cancel payment link
|
|
38
|
-
* @description: Deactivate and cancel a payment link. - Check out [method documentation](https://
|
|
38
|
+
* @description: Deactivate and cancel a payment link. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/payment/cancelPaymentLink/).
|
|
39
39
|
*/
|
|
40
40
|
cancelPaymentLink({ body, requestHeaders }?: PaymentPlatformApplicationValidator.CancelPaymentLinkParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.CancelPaymentLinkDetails>;
|
|
41
41
|
/**
|
|
@@ -48,7 +48,7 @@ declare class Payment {
|
|
|
48
48
|
* Success response
|
|
49
49
|
* @name checkAndUpdatePaymentStatus
|
|
50
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://
|
|
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://docs.fynd.com/partners/commerce/sdk/platform/payment/checkAndUpdatePaymentStatus/).
|
|
52
52
|
*/
|
|
53
53
|
checkAndUpdatePaymentStatus({ body, requestHeaders }?: PaymentPlatformApplicationValidator.CheckAndUpdatePaymentStatusParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.PaymentStatusUpdateDetails>;
|
|
54
54
|
/**
|
|
@@ -59,7 +59,7 @@ declare class Payment {
|
|
|
59
59
|
* Success response
|
|
60
60
|
* @name confirmPayment
|
|
61
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://
|
|
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://docs.fynd.com/partners/commerce/sdk/platform/payment/confirmPayment/).
|
|
63
63
|
*/
|
|
64
64
|
confirmPayment({ body, requestHeaders }?: PaymentPlatformApplicationValidator.ConfirmPaymentParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.PaymentConfirmationDetails>;
|
|
65
65
|
/**
|
|
@@ -71,7 +71,7 @@ declare class Payment {
|
|
|
71
71
|
* @returns {Promise<PaymentPlatformModel.RefundPriorityDetails>} - Success response
|
|
72
72
|
* @name createMerchantRefundPriority
|
|
73
73
|
* @summary: Create merchant refund priority
|
|
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://
|
|
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://docs.fynd.com/partners/commerce/sdk/platform/payment/createMerchantRefundPriority/).
|
|
75
75
|
*/
|
|
76
76
|
createMerchantRefundPriority({ configType, body, requestHeaders }?: PaymentPlatformApplicationValidator.CreateMerchantRefundPriorityParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.RefundPriorityDetails>;
|
|
77
77
|
/**
|
|
@@ -84,7 +84,7 @@ declare class Payment {
|
|
|
84
84
|
* Success response
|
|
85
85
|
* @name createPaymentLink
|
|
86
86
|
* @summary: Create payment link
|
|
87
|
-
* @description: Generate a payment link for accepting payments. - Check out [method documentation](https://
|
|
87
|
+
* @description: Generate a payment link for accepting payments. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/payment/createPaymentLink/).
|
|
88
88
|
*/
|
|
89
89
|
createPaymentLink({ body, requestHeaders }?: PaymentPlatformApplicationValidator.CreatePaymentLinkParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.CreatePaymentLinkDetails>;
|
|
90
90
|
/**
|
|
@@ -96,7 +96,7 @@ declare class Payment {
|
|
|
96
96
|
* @returns {Promise<PaymentPlatformModel.PaymentOrderDetails>} - Success response
|
|
97
97
|
* @name createPaymentOrder
|
|
98
98
|
* @summary: Create Order
|
|
99
|
-
* @description: Create an order and payment on the aggregator side - Check out [method documentation](https://
|
|
99
|
+
* @description: Create an order and payment on the aggregator side - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/payment/createPaymentOrder/).
|
|
100
100
|
*/
|
|
101
101
|
createPaymentOrder({ body, requestHeaders }?: PaymentPlatformApplicationValidator.CreatePaymentOrderParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.PaymentOrderDetails>;
|
|
102
102
|
/**
|
|
@@ -110,7 +110,7 @@ declare class Payment {
|
|
|
110
110
|
*
|
|
111
111
|
* @name edcAggregatorsAndModelList
|
|
112
112
|
* @summary: EDC aggregators and model list
|
|
113
|
-
* @description: Retrieve a list of EDC (Electronic Data Capture) aggregators and models. - Check out [method documentation](https://
|
|
113
|
+
* @description: Retrieve a list of EDC (Electronic Data Capture) aggregators and models. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/payment/edcAggregatorsAndModelList/).
|
|
114
114
|
*/
|
|
115
115
|
edcAggregatorsAndModelList({ requestHeaders }?: any, { responseHeaders }?: object): Promise<PaymentPlatformModel.EdcAggregatorAndModelListDetails>;
|
|
116
116
|
/**
|
|
@@ -120,7 +120,7 @@ declare class Payment {
|
|
|
120
120
|
* @returns {Promise<PaymentPlatformModel.EdcDeviceListDetails>} - Success response
|
|
121
121
|
* @name edcDeviceList
|
|
122
122
|
* @summary: List EDC devices
|
|
123
|
-
* @description: Retrieves a list of available Electronic Data Capture (EDC) devices. - Check out [method documentation](https://
|
|
123
|
+
* @description: Retrieves a list of available Electronic Data Capture (EDC) devices. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/payment/edcDeviceList/).
|
|
124
124
|
*/
|
|
125
125
|
edcDeviceList({ pageNo, pageSize, isActive, storeId, deviceTag, requestHeaders }?: PaymentPlatformApplicationValidator.EdcDeviceListParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.EdcDeviceListDetails>;
|
|
126
126
|
/**
|
|
@@ -130,7 +130,7 @@ declare class Payment {
|
|
|
130
130
|
* @returns {Promise<PaymentPlatformModel.EdcDeviceStatsDetails>} - Success response
|
|
131
131
|
* @name edcDeviceStats
|
|
132
132
|
* @summary: EDC device stats
|
|
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://
|
|
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://docs.fynd.com/partners/commerce/sdk/platform/payment/edcDeviceStats/).
|
|
134
134
|
*/
|
|
135
135
|
edcDeviceStats({ requestHeaders }?: any, { responseHeaders }?: object): Promise<PaymentPlatformModel.EdcDeviceStatsDetails>;
|
|
136
136
|
/**
|
|
@@ -142,7 +142,7 @@ declare class Payment {
|
|
|
142
142
|
* @returns {Promise<PaymentPlatformModel.RefundAccountDetails>} - Success response
|
|
143
143
|
* @name getBankAccountDetailsOpenAPI
|
|
144
144
|
* @summary: Get bank account details
|
|
145
|
-
* @description: Retrieve bank account information - Check out [method documentation](https://
|
|
145
|
+
* @description: Retrieve bank account information - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/payment/getBankAccountDetailsOpenAPI/).
|
|
146
146
|
*/
|
|
147
147
|
getBankAccountDetailsOpenAPI({ orderId, requestHash, requestHeaders }?: PaymentPlatformApplicationValidator.GetBankAccountDetailsOpenAPIParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.RefundAccountDetails>;
|
|
148
148
|
/**
|
|
@@ -155,7 +155,7 @@ declare class Payment {
|
|
|
155
155
|
* Success response
|
|
156
156
|
* @name getBrandPaymentGatewayConfig
|
|
157
157
|
* @summary: Get secrets for brand payment gateway
|
|
158
|
-
* @description: Retrieve configuration settings like key, secret, webhook url, merchant salt for brand payment gateways. - Check out [method documentation](https://
|
|
158
|
+
* @description: Retrieve configuration settings like key, secret, webhook url, merchant salt for brand payment gateways. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/payment/getBrandPaymentGatewayConfig/).
|
|
159
159
|
*/
|
|
160
160
|
getBrandPaymentGatewayConfig({ aggregator, configType, requestHeaders }?: PaymentPlatformApplicationValidator.GetBrandPaymentGatewayConfigParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.PaymentGatewayConfigDetails>;
|
|
161
161
|
/**
|
|
@@ -165,7 +165,7 @@ declare class Payment {
|
|
|
165
165
|
* @returns {Promise<PaymentPlatformModel.EdcDeviceDetails>} - Success response
|
|
166
166
|
* @name getEdcDevice
|
|
167
167
|
* @summary: Get an EDC device
|
|
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://
|
|
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://docs.fynd.com/partners/commerce/sdk/platform/payment/getEdcDevice/).
|
|
169
169
|
*/
|
|
170
170
|
getEdcDevice({ terminalUniqueIdentifier, requestHeaders }?: PaymentPlatformApplicationValidator.GetEdcDeviceParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.EdcDeviceDetails>;
|
|
171
171
|
/**
|
|
@@ -178,7 +178,7 @@ declare class Payment {
|
|
|
178
178
|
* Success response
|
|
179
179
|
* @name getMerchantAggregatorAppVersion
|
|
180
180
|
* @summary: Get app version for Aggregator
|
|
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://
|
|
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://docs.fynd.com/partners/commerce/sdk/platform/payment/getMerchantAggregatorAppVersion/).
|
|
182
182
|
*/
|
|
183
183
|
getMerchantAggregatorAppVersion({ aggregatorId, businessUnit, device, paymentModeId, subPaymentMode, requestHeaders, }?: PaymentPlatformApplicationValidator.GetMerchantAggregatorAppVersionParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.AggregatorVersionDetails>;
|
|
184
184
|
/**
|
|
@@ -191,7 +191,7 @@ declare class Payment {
|
|
|
191
191
|
* Success response
|
|
192
192
|
* @name getMerchantAggregatorPaymentModeDetails
|
|
193
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://
|
|
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://docs.fynd.com/partners/commerce/sdk/platform/payment/getMerchantAggregatorPaymentModeDetails/).
|
|
195
195
|
*/
|
|
196
196
|
getMerchantAggregatorPaymentModeDetails({ aggregatorId, businessUnit, device, requestHeaders }?: PaymentPlatformApplicationValidator.GetMerchantAggregatorPaymentModeDetailsParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.PlatformPaymentModeDetails>;
|
|
197
197
|
/**
|
|
@@ -204,7 +204,7 @@ declare class Payment {
|
|
|
204
204
|
* Success response
|
|
205
205
|
* @name getMerchantPaymentOption
|
|
206
206
|
* @summary: Get merchant payment option
|
|
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://
|
|
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://docs.fynd.com/partners/commerce/sdk/platform/payment/getMerchantPaymentOption/).
|
|
208
208
|
*/
|
|
209
209
|
getMerchantPaymentOption({ requestHeaders }?: any, { responseHeaders }?: object): Promise<PaymentPlatformModel.PlatformPaymentModeDetails>;
|
|
210
210
|
/**
|
|
@@ -216,7 +216,7 @@ declare class Payment {
|
|
|
216
216
|
* @returns {Promise<PaymentPlatformModel.RefundPriorityDetails>} - Success response
|
|
217
217
|
* @name getMerchantRefundPriority
|
|
218
218
|
* @summary: Get merchant refund priority
|
|
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://
|
|
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://docs.fynd.com/partners/commerce/sdk/platform/payment/getMerchantRefundPriority/).
|
|
220
220
|
*/
|
|
221
221
|
getMerchantRefundPriority({ configType, requestHeaders }?: PaymentPlatformApplicationValidator.GetMerchantRefundPriorityParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.RefundPriorityDetails>;
|
|
222
222
|
/**
|
|
@@ -229,7 +229,7 @@ declare class Payment {
|
|
|
229
229
|
* Success response
|
|
230
230
|
* @name getPGConfigAggregators
|
|
231
231
|
* @summary: Get merchant aggregator payment mode
|
|
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://
|
|
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://docs.fynd.com/partners/commerce/sdk/platform/payment/getPGConfigAggregators/).
|
|
233
233
|
*/
|
|
234
234
|
getPGConfigAggregators({ requestHeaders }?: any, { responseHeaders }?: object): Promise<PaymentPlatformModel.PlatformPaymentModeDetails>;
|
|
235
235
|
/**
|
|
@@ -241,7 +241,7 @@ declare class Payment {
|
|
|
241
241
|
* @returns {Promise<PaymentPlatformModel.GetPaymentCodeDetails>} - Success response
|
|
242
242
|
* @name getPaymentCodeOption
|
|
243
243
|
* @summary: Get payment mode codes
|
|
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://
|
|
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://docs.fynd.com/partners/commerce/sdk/platform/payment/getPaymentCodeOption/).
|
|
245
245
|
*/
|
|
246
246
|
getPaymentCodeOption({ requestHeaders }?: any, { responseHeaders }?: object): Promise<PaymentPlatformModel.GetPaymentCodeDetails>;
|
|
247
247
|
/**
|
|
@@ -251,7 +251,7 @@ declare class Payment {
|
|
|
251
251
|
* @returns {Promise<PaymentPlatformModel.GetPaymentLinkDetails>} - Success response
|
|
252
252
|
* @name getPaymentLink
|
|
253
253
|
* @summary: Get payment link
|
|
254
|
-
* @description: Retrieve a payment link for making payments. - Check out [method documentation](https://
|
|
254
|
+
* @description: Retrieve a payment link for making payments. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/payment/getPaymentLink/).
|
|
255
255
|
*/
|
|
256
256
|
getPaymentLink({ paymentLinkId, requestHeaders }?: PaymentPlatformApplicationValidator.GetPaymentLinkParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.GetPaymentLinkDetails>;
|
|
257
257
|
/**
|
|
@@ -264,7 +264,7 @@ declare class Payment {
|
|
|
264
264
|
* Success response
|
|
265
265
|
* @name getPaymentModeControlRoutes
|
|
266
266
|
* @summary: Get offline/advance payment mode
|
|
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://
|
|
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://docs.fynd.com/partners/commerce/sdk/platform/payment/getPaymentModeControlRoutes/).
|
|
268
268
|
*/
|
|
269
269
|
getPaymentModeControlRoutes({ mode, requestHeaders }?: PaymentPlatformApplicationValidator.GetPaymentModeControlRoutesParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.PlatformPaymentModeDetails>;
|
|
270
270
|
/**
|
|
@@ -278,7 +278,7 @@ declare class Payment {
|
|
|
278
278
|
*
|
|
279
279
|
* @name getPaymentModeCustomConfig
|
|
280
280
|
* @summary: Get advance payment custom configurations
|
|
281
|
-
* @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://
|
|
281
|
+
* @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://docs.fynd.com/partners/commerce/sdk/platform/payment/getPaymentModeCustomConfig/).
|
|
282
282
|
*/
|
|
283
283
|
getPaymentModeCustomConfig({ mode, requestHeaders }?: PaymentPlatformApplicationValidator.GetPaymentModeCustomConfigParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.PaymentCustomConfigResponseSchema>;
|
|
284
284
|
/**
|
|
@@ -290,7 +290,7 @@ declare class Payment {
|
|
|
290
290
|
* @returns {Promise<PaymentPlatformModel.PaymentOptionsDetails>} - Success response
|
|
291
291
|
* @name getPaymentModeRoutes
|
|
292
292
|
* @summary: Get payment modes
|
|
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://
|
|
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://docs.fynd.com/partners/commerce/sdk/platform/payment/getPaymentModeRoutes/).
|
|
294
294
|
*/
|
|
295
295
|
getPaymentModeRoutes({ refresh, requestType, orderId, shipmentId, amount, requestHeaders }?: PaymentPlatformApplicationValidator.GetPaymentModeRoutesParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.PaymentOptionsDetails>;
|
|
296
296
|
/**
|
|
@@ -303,7 +303,7 @@ declare class Payment {
|
|
|
303
303
|
* Success response
|
|
304
304
|
* @name getPaymentSession
|
|
305
305
|
* @summary: Get payment session
|
|
306
|
-
* @description: Allows users to fetch the payment session details associated with a given order ID or transaction ID - Check out [method documentation](https://
|
|
306
|
+
* @description: Allows users to fetch the payment session details associated with a given order ID or transaction ID - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/payment/getPaymentSession/).
|
|
307
307
|
*/
|
|
308
308
|
getPaymentSession({ gid, lineItem, requestHeaders }?: PaymentPlatformApplicationValidator.GetPaymentSessionParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.PaymentSessionFetchDetails>;
|
|
309
309
|
/**
|
|
@@ -315,7 +315,7 @@ declare class Payment {
|
|
|
315
315
|
* @returns {Promise<PaymentPlatformModel.PaymentModeRouteDetails>} - Success response
|
|
316
316
|
* @name getPosPaymentModeRoutes
|
|
317
317
|
* @summary: List POS payment modes
|
|
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://
|
|
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://docs.fynd.com/partners/commerce/sdk/platform/payment/getPosPaymentModeRoutes/).
|
|
319
319
|
*/
|
|
320
320
|
getPosPaymentModeRoutes({ amount, pincode, orderType, xOrderingSource, cartId, checkoutMode, refresh, orderId, cardReference, userDetails, displaySplit, advancePayment, shipmentId, customerId, requestHeaders, }?: PaymentPlatformApplicationValidator.GetPosPaymentModeRoutesParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.PaymentModeRouteDetails>;
|
|
321
321
|
/**
|
|
@@ -328,7 +328,7 @@ declare class Payment {
|
|
|
328
328
|
* Success response
|
|
329
329
|
* @name getUserBeneficiaries
|
|
330
330
|
* @summary: Get user beneficiaries
|
|
331
|
-
* @description: Retrieves information about beneficiaries associated with the user for processing refunds, based on the provided order ID - Check out [method documentation](https://
|
|
331
|
+
* @description: Retrieves information about beneficiaries associated with the user for processing refunds, based on the provided order ID - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/payment/getUserBeneficiaries/).
|
|
332
332
|
*/
|
|
333
333
|
getUserBeneficiaries({ orderId, requestHeaders }?: PaymentPlatformApplicationValidator.GetUserBeneficiariesParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.OrderBeneficiaryFetchResults>;
|
|
334
334
|
/**
|
|
@@ -340,7 +340,7 @@ declare class Payment {
|
|
|
340
340
|
* @returns {Promise<PaymentPlatformModel.GetUserCODLimitDetails>} - Success response
|
|
341
341
|
* @name getUserCODlimitRoutes
|
|
342
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://
|
|
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://docs.fynd.com/partners/commerce/sdk/platform/payment/getUserCODlimitRoutes/).
|
|
344
344
|
*/
|
|
345
345
|
getUserCODlimitRoutes({ merchantUserId, mobileNo, requestHeaders }?: PaymentPlatformApplicationValidator.GetUserCODlimitRoutesParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.GetUserCODLimitDetails>;
|
|
346
346
|
/**
|
|
@@ -353,7 +353,7 @@ declare class Payment {
|
|
|
353
353
|
* Success response
|
|
354
354
|
* @name getUserOrderBeneficiaries
|
|
355
355
|
* @summary: Get user order beneficiaries
|
|
356
|
-
* @description: Retrieve beneficiary details like bank name , ifsc code , branch name associated with a specific order for refund processing - Check out [method documentation](https://
|
|
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://docs.fynd.com/partners/commerce/sdk/platform/payment/getUserOrderBeneficiaries/).
|
|
357
357
|
*/
|
|
358
358
|
getUserOrderBeneficiaries({ orderId, requestHeaders }?: PaymentPlatformApplicationValidator.GetUserOrderBeneficiariesParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.OrderBeneficiaryFetchResults>;
|
|
359
359
|
/**
|
|
@@ -366,7 +366,7 @@ declare class Payment {
|
|
|
366
366
|
* Success response
|
|
367
367
|
* @name initialisePayment
|
|
368
368
|
* @summary: Start payment process
|
|
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://
|
|
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://docs.fynd.com/partners/commerce/sdk/platform/payment/initialisePayment/).
|
|
370
370
|
*/
|
|
371
371
|
initialisePayment({ body, requestHeaders }?: PaymentPlatformApplicationValidator.InitialisePaymentParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.PaymentInitializationDetails>;
|
|
372
372
|
/**
|
|
@@ -379,7 +379,7 @@ declare class Payment {
|
|
|
379
379
|
* Success response
|
|
380
380
|
* @name merchantOnBoarding
|
|
381
381
|
* @summary: Merchant onboarding for BNPL
|
|
382
|
-
* @description: Initiate the merchant onboarding process for Buy Now Pay Later (BNPL). - Check out [method documentation](https://
|
|
382
|
+
* @description: Initiate the merchant onboarding process for Buy Now Pay Later (BNPL). - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/payment/merchantOnBoarding/).
|
|
383
383
|
*/
|
|
384
384
|
merchantOnBoarding({ body, requestHeaders }?: PaymentPlatformApplicationValidator.MerchantOnBoardingParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.MerchantOnBoardingDetails>;
|
|
385
385
|
/**
|
|
@@ -389,7 +389,7 @@ declare class Payment {
|
|
|
389
389
|
* @returns {Promise<PaymentPlatformModel.GetOauthUrlDetails>} - Success response
|
|
390
390
|
* @name oauthGetUrl
|
|
391
391
|
* @summary: Get OAuth URL
|
|
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://
|
|
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://docs.fynd.com/partners/commerce/sdk/platform/payment/oauthGetUrl/).
|
|
393
393
|
*/
|
|
394
394
|
oauthGetUrl({ aggregator, successRedirectUrl, failureRedirectUrl, requestHeaders }?: PaymentPlatformApplicationValidator.OauthGetUrlParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.GetOauthUrlDetails>;
|
|
395
395
|
/**
|
|
@@ -402,7 +402,7 @@ declare class Payment {
|
|
|
402
402
|
* Success response
|
|
403
403
|
* @name patchMerchantAggregatorPaymentModeDetails
|
|
404
404
|
* @summary: Update merchant aggregator payment mode
|
|
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://
|
|
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://docs.fynd.com/partners/commerce/sdk/platform/payment/patchMerchantAggregatorPaymentModeDetails/).
|
|
406
406
|
*/
|
|
407
407
|
patchMerchantAggregatorPaymentModeDetails({ aggregatorId, body, requestHeaders }?: PaymentPlatformApplicationValidator.PatchMerchantAggregatorPaymentModeDetailsParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.PlatformPaymentModeDetails>;
|
|
408
408
|
/**
|
|
@@ -415,7 +415,7 @@ declare class Payment {
|
|
|
415
415
|
* Success response
|
|
416
416
|
* @name patchMerchantPaymentOption
|
|
417
417
|
* @summary: Update payment gateways and payment mode
|
|
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://
|
|
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://docs.fynd.com/partners/commerce/sdk/platform/payment/patchMerchantPaymentOption/).
|
|
419
419
|
*/
|
|
420
420
|
patchMerchantPaymentOption({ body, requestHeaders }?: PaymentPlatformApplicationValidator.PatchMerchantPaymentOptionParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.PlatformPaymentModeDetails>;
|
|
421
421
|
/**
|
|
@@ -428,7 +428,7 @@ declare class Payment {
|
|
|
428
428
|
* Success response
|
|
429
429
|
* @name patchMerchantPaymentOptionVersion
|
|
430
430
|
* @summary: Update app version for Aggrgator
|
|
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://
|
|
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://docs.fynd.com/partners/commerce/sdk/platform/payment/patchMerchantPaymentOptionVersion/).
|
|
432
432
|
*/
|
|
433
433
|
patchMerchantPaymentOptionVersion({ aggregatorId, body, requestHeaders }?: PaymentPlatformApplicationValidator.PatchMerchantPaymentOptionVersionParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.PlatformPaymentModeDetails>;
|
|
434
434
|
/**
|
|
@@ -442,7 +442,7 @@ declare class Payment {
|
|
|
442
442
|
*
|
|
443
443
|
* @name paymentStatusBulk
|
|
444
444
|
* @summary: Retrieve status of multiple payments in bulk
|
|
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://
|
|
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://docs.fynd.com/partners/commerce/sdk/platform/payment/paymentStatusBulk/).
|
|
446
446
|
*/
|
|
447
447
|
paymentStatusBulk({ body, requestHeaders }?: PaymentPlatformApplicationValidator.PaymentStatusBulkParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.PaymentStatusBulkHandlerDetails>;
|
|
448
448
|
/**
|
|
@@ -455,7 +455,7 @@ declare class Payment {
|
|
|
455
455
|
* Success response
|
|
456
456
|
* @name pollingPaymentLink
|
|
457
457
|
* @summary: Poll status of payment link
|
|
458
|
-
* @description: Periodically checks the status of a payment link to monitor for any updates or changes.retrieve real-time information about the payment link's current status, such as whether it has been processed, cancelled, or expired. - Check out [method documentation](https://
|
|
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://docs.fynd.com/partners/commerce/sdk/platform/payment/pollingPaymentLink/).
|
|
459
459
|
*/
|
|
460
460
|
pollingPaymentLink({ paymentLinkId, requestHeaders }?: PaymentPlatformApplicationValidator.PollingPaymentLinkParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.PollingPaymentLinkDetails>;
|
|
461
461
|
/**
|
|
@@ -465,7 +465,7 @@ declare class Payment {
|
|
|
465
465
|
* @returns {Promise<PaymentPlatformModel.RepaymentDetails>} - Success response
|
|
466
466
|
* @name repaymentDetails
|
|
467
467
|
* @summary: Repayment details for BNPL
|
|
468
|
-
* @description: Retrieve repayment details for Buy Now Pay Later (BNPL) payment - Check out [method documentation](https://
|
|
468
|
+
* @description: Retrieve repayment details for Buy Now Pay Later (BNPL) payment - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/payment/repaymentDetails/).
|
|
469
469
|
*/
|
|
470
470
|
repaymentDetails({ body, requestHeaders }?: PaymentPlatformApplicationValidator.RepaymentDetailsParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.RepaymentDetails>;
|
|
471
471
|
/**
|
|
@@ -478,7 +478,7 @@ declare class Payment {
|
|
|
478
478
|
* Success response
|
|
479
479
|
* @name resendOrCancelPayment
|
|
480
480
|
* @summary: Resend or cancel payment
|
|
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://
|
|
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://docs.fynd.com/partners/commerce/sdk/platform/payment/resendOrCancelPayment/).
|
|
482
482
|
*/
|
|
483
483
|
resendOrCancelPayment({ body, requestHeaders }?: PaymentPlatformApplicationValidator.ResendOrCancelPaymentParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.ResendOrCancelPaymentDetails>;
|
|
484
484
|
/**
|
|
@@ -491,7 +491,7 @@ declare class Payment {
|
|
|
491
491
|
* Success response
|
|
492
492
|
* @name resendPaymentLink
|
|
493
493
|
* @summary: Resend payment link
|
|
494
|
-
* @description: Resends an existing payment link to the user to complete the payment. - Check out [method documentation](https://
|
|
494
|
+
* @description: Resends an existing payment link to the user to complete the payment. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/payment/resendPaymentLink/).
|
|
495
495
|
*/
|
|
496
496
|
resendPaymentLink({ body, requestHeaders }?: PaymentPlatformApplicationValidator.ResendPaymentLinkParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.ResendPaymentLinkDetails>;
|
|
497
497
|
/**
|
|
@@ -501,7 +501,7 @@ declare class Payment {
|
|
|
501
501
|
* @returns {Promise<PaymentPlatformModel.RevokeOAuthToken>} - Success response
|
|
502
502
|
* @name revokeOauthToken
|
|
503
503
|
* @summary: Revoke OAuth token
|
|
504
|
-
* @description: Revoke the creds for payment aggregator razropay. - Check out [method documentation](https://
|
|
504
|
+
* @description: Revoke the creds for payment aggregator razropay. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/payment/revokeOauthToken/).
|
|
505
505
|
*/
|
|
506
506
|
revokeOauthToken({ aggregator, requestHeaders }?: PaymentPlatformApplicationValidator.RevokeOauthTokenParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.RevokeOAuthToken>;
|
|
507
507
|
/**
|
|
@@ -514,7 +514,7 @@ declare class Payment {
|
|
|
514
514
|
* Success response
|
|
515
515
|
* @name saveBrandPaymentGatewayConfig
|
|
516
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://
|
|
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://docs.fynd.com/partners/commerce/sdk/platform/payment/saveBrandPaymentGatewayConfig/).
|
|
518
518
|
*/
|
|
519
519
|
saveBrandPaymentGatewayConfig({ body, requestHeaders }?: PaymentPlatformApplicationValidator.SaveBrandPaymentGatewayConfigParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.PaymentGatewayToBeReviewed>;
|
|
520
520
|
/**
|
|
@@ -527,7 +527,7 @@ declare class Payment {
|
|
|
527
527
|
* Success response
|
|
528
528
|
* @name setMerchantModeControlRoutes
|
|
529
529
|
* @summary: Update offline payment mode
|
|
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://
|
|
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://docs.fynd.com/partners/commerce/sdk/platform/payment/setMerchantModeControlRoutes/).
|
|
531
531
|
*/
|
|
532
532
|
setMerchantModeControlRoutes({ mode, body, requestHeaders }?: PaymentPlatformApplicationValidator.SetMerchantModeControlRoutesParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.PlatformPaymentModeDetails>;
|
|
533
533
|
/**
|
|
@@ -541,7 +541,7 @@ declare class Payment {
|
|
|
541
541
|
*
|
|
542
542
|
* @name setPaymentModeCustomConfig
|
|
543
543
|
* @summary: Update advance payment custom configurations
|
|
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://
|
|
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://docs.fynd.com/partners/commerce/sdk/platform/payment/setPaymentModeCustomConfig/).
|
|
545
545
|
*/
|
|
546
546
|
setPaymentModeCustomConfig({ mode, body, requestHeaders }?: PaymentPlatformApplicationValidator.SetPaymentModeCustomConfigParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.PaymentCustomConfigResponseSchema>;
|
|
547
547
|
/**
|
|
@@ -553,7 +553,7 @@ declare class Payment {
|
|
|
553
553
|
* @returns {Promise<PaymentPlatformModel.SetCODOptionDetails>} - Success response
|
|
554
554
|
* @name setUserCODlimitRoutes
|
|
555
555
|
* @summary: Set user COD
|
|
556
|
-
* @description: This allows access to seller to enable disable cod of specific user - Check out [method documentation](https://
|
|
556
|
+
* @description: This allows access to seller to enable disable cod of specific user - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/payment/setUserCODlimitRoutes/).
|
|
557
557
|
*/
|
|
558
558
|
setUserCODlimitRoutes({ body, requestHeaders }?: PaymentPlatformApplicationValidator.SetUserCODlimitRoutesParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.SetCODOptionDetails>;
|
|
559
559
|
/**
|
|
@@ -563,7 +563,7 @@ declare class Payment {
|
|
|
563
563
|
* @returns {Promise<PaymentPlatformModel.EdcDeviceAddDetails>} - Success response
|
|
564
564
|
* @name updateEdcDevice
|
|
565
565
|
* @summary: Update EDC device
|
|
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://
|
|
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://docs.fynd.com/partners/commerce/sdk/platform/payment/updateEdcDevice/).
|
|
567
567
|
*/
|
|
568
568
|
updateEdcDevice({ body, requestHeaders }?: PaymentPlatformApplicationValidator.UpdateEdcDeviceParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.EdcDeviceAddDetails>;
|
|
569
569
|
/**
|
|
@@ -575,7 +575,7 @@ declare class Payment {
|
|
|
575
575
|
* @returns {Promise<PaymentPlatformModel.RefundPriorityDetails>} - Success response
|
|
576
576
|
* @name updateMerchantRefundPriority
|
|
577
577
|
* @summary: Update merchant refund priority
|
|
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://
|
|
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://docs.fynd.com/partners/commerce/sdk/platform/payment/updateMerchantRefundPriority/).
|
|
579
579
|
*/
|
|
580
580
|
updateMerchantRefundPriority({ configType, body, requestHeaders }?: PaymentPlatformApplicationValidator.UpdateMerchantRefundPriorityParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.RefundPriorityDetails>;
|
|
581
581
|
/**
|
|
@@ -588,7 +588,7 @@ declare class Payment {
|
|
|
588
588
|
* Success response
|
|
589
589
|
* @name updatePaymentSession
|
|
590
590
|
* @summary: Update payment session
|
|
591
|
-
* @description: Update the details of a payment session associated with a given order ID or transaction ID. - Check out [method documentation](https://
|
|
591
|
+
* @description: Update the details of a payment session associated with a given order ID or transaction ID. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/payment/updatePaymentSession/).
|
|
592
592
|
*/
|
|
593
593
|
updatePaymentSession({ gid, body, requestHeaders }?: PaymentPlatformApplicationValidator.UpdatePaymentSessionParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.PaymentSessionPutDetails>;
|
|
594
594
|
/**
|
|
@@ -600,7 +600,7 @@ declare class Payment {
|
|
|
600
600
|
* @returns {Promise<PaymentPlatformModel.RefundSessionDetails>} - Success response
|
|
601
601
|
* @name updateRefundSession
|
|
602
602
|
* @summary: Update refund session
|
|
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://
|
|
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://docs.fynd.com/partners/commerce/sdk/platform/payment/updateRefundSession/).
|
|
604
604
|
*/
|
|
605
605
|
updateRefundSession({ gid, requestId, body, requestHeaders }?: PaymentPlatformApplicationValidator.UpdateRefundSessionParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.RefundSessionDetails>;
|
|
606
606
|
/**
|
|
@@ -613,7 +613,7 @@ declare class Payment {
|
|
|
613
613
|
* Success response
|
|
614
614
|
* @name validateCustomerAndCreditSummary
|
|
615
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://
|
|
616
|
+
* @description: Verify if the user is eligible for payment and also show credit summary if activated. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/payment/validateCustomerAndCreditSummary/).
|
|
617
617
|
*/
|
|
618
618
|
validateCustomerAndCreditSummary({ body, requestHeaders }?: PaymentPlatformApplicationValidator.ValidateCustomerAndCreditSummaryParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.ValidateCustomerCreditSchema>;
|
|
619
619
|
/**
|
|
@@ -625,7 +625,7 @@ declare class Payment {
|
|
|
625
625
|
* @returns {Promise<PaymentPlatformModel.ValidateCustomerDetails>} - Success response
|
|
626
626
|
* @name verifyCustomerForPayment
|
|
627
627
|
* @summary: Validate customer for paylater
|
|
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://
|
|
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://docs.fynd.com/partners/commerce/sdk/platform/payment/verifyCustomerForPayment/).
|
|
629
629
|
*/
|
|
630
630
|
verifyCustomerForPayment({ body, requestHeaders }?: PaymentPlatformApplicationValidator.VerifyCustomerForPaymentParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.ValidateCustomerDetails>;
|
|
631
631
|
}
|