@gofynd/fdk-client-javascript 1.4.16-beta.4 → 1.4.16-beta.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -1
- package/package.json +1 -1
- package/sdk/application/ApplicationClient.d.ts +2 -0
- package/sdk/application/ApplicationClient.js +2 -0
- package/sdk/application/Cart/CartApplicationClient.d.ts +68 -48
- package/sdk/application/Cart/CartApplicationClient.js +118 -27
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +59 -58
- package/sdk/application/Catalog/CatalogApplicationClient.js +30 -29
- package/sdk/application/Common/CommonApplicationClient.d.ts +2 -2
- package/sdk/application/Common/CommonApplicationClient.js +1 -1
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +20 -20
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +10 -10
- package/sdk/application/Content/ContentApplicationClient.d.ts +51 -30
- package/sdk/application/Content/ContentApplicationClient.js +161 -56
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +9 -11
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +7 -10
- package/sdk/application/Finance/FinanceApplicationClient.d.ts +29 -0
- package/sdk/application/Finance/FinanceApplicationClient.js +111 -0
- package/sdk/application/Lead/LeadApplicationClient.d.ts +2 -2
- package/sdk/application/Lead/LeadApplicationClient.js +1 -1
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +35 -15
- package/sdk/application/Logistic/LogisticApplicationClient.js +101 -8
- package/sdk/application/Order/OrderApplicationClient.d.ts +22 -12
- package/sdk/application/Order/OrderApplicationClient.js +56 -8
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +87 -87
- package/sdk/application/Payment/PaymentApplicationClient.js +46 -46
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +13 -13
- package/sdk/application/Rewards/RewardsApplicationClient.js +7 -7
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +2 -2
- package/sdk/application/Theme/ThemeApplicationClient.js +4 -2
- package/sdk/application/User/UserApplicationClient.d.ts +10 -10
- package/sdk/application/User/UserApplicationClient.js +6 -6
- package/sdk/application/Webhook/WebhookApplicationClient.d.ts +4 -4
- package/sdk/application/Webhook/WebhookApplicationClient.js +3 -3
- package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +86 -12
- package/sdk/partner/FileStorage/FileStoragePartnerClient.js +582 -24
- package/sdk/partner/FileStorage/FileStoragePartnerModel.d.ts +116 -21
- package/sdk/partner/FileStorage/FileStoragePartnerModel.js +121 -16
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.d.ts +8 -1
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.js +51 -4
- package/sdk/partner/Lead/LeadPartnerClient.d.ts +2 -2
- package/sdk/partner/Lead/LeadPartnerClient.js +2 -2
- package/sdk/partner/Lead/LeadPartnerModel.d.ts +5 -5
- package/sdk/partner/Lead/LeadPartnerModel.js +15 -15
- package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +126 -20
- package/sdk/partner/Logistics/LogisticsPartnerClient.js +970 -20
- package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +1200 -167
- package/sdk/partner/Logistics/LogisticsPartnerModel.js +571 -160
- package/sdk/partner/Logistics/LogisticsPartnerValidator.d.ts +10 -0
- package/sdk/partner/Logistics/LogisticsPartnerValidator.js +121 -7
- package/sdk/partner/Theme/ThemePartnerClient.d.ts +8 -10
- package/sdk/partner/Theme/ThemePartnerClient.js +14 -16
- package/sdk/partner/Theme/ThemePartnerModel.d.ts +96 -37
- package/sdk/partner/Theme/ThemePartnerModel.js +90 -36
- package/sdk/partner/Theme/ThemePartnerValidator.js +4 -4
- package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +28 -18
- package/sdk/partner/Webhook/WebhookPartnerClient.js +103 -18
- package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +612 -179
- package/sdk/partner/Webhook/WebhookPartnerModel.js +253 -150
- package/sdk/partner/Webhook/WebhookPartnerValidator.d.ts +1 -0
- package/sdk/partner/Webhook/WebhookPartnerValidator.js +11 -3
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.d.ts +5 -4
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.js +14 -8
- package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +59 -9
- package/sdk/platform/Analytics/AnalyticsPlatformModel.js +40 -4
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +2 -32
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +3 -243
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +11 -130
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +12 -152
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +1 -39
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.js +0 -35
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +12 -12
- package/sdk/platform/Billing/BillingPlatformClient.js +15 -15
- package/sdk/platform/Billing/BillingPlatformModel.d.ts +443 -388
- package/sdk/platform/Billing/BillingPlatformModel.js +280 -263
- package/sdk/platform/Billing/BillingPlatformValidator.d.ts +16 -18
- package/sdk/platform/Billing/BillingPlatformValidator.js +8 -9
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +134 -103
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +419 -115
- package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +121 -65
- package/sdk/platform/Cart/CartPlatformApplicationValidator.js +109 -44
- package/sdk/platform/Cart/CartPlatformModel.d.ts +5070 -1296
- package/sdk/platform/Cart/CartPlatformModel.js +1992 -1217
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +209 -183
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +452 -395
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +185 -142
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +96 -78
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +154 -117
- package/sdk/platform/Catalog/CatalogPlatformClient.js +292 -172
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +6512 -1770
- package/sdk/platform/Catalog/CatalogPlatformModel.js +3228 -1687
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +72 -31
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +50 -24
- package/sdk/platform/Common/CommonPlatformClient.d.ts +3 -2
- package/sdk/platform/Common/CommonPlatformClient.js +3 -2
- package/sdk/platform/Common/CommonPlatformModel.d.ts +9 -9
- package/sdk/platform/Common/CommonPlatformModel.js +6 -6
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +16 -17
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +16 -17
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +8 -8
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +8 -8
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +43 -33
- package/sdk/platform/Communication/CommunicationPlatformModel.js +38 -34
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +46 -42
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +47 -43
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +223 -223
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +210 -212
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +12 -12
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +12 -12
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +46 -33
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +67 -54
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +18 -18
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +18 -18
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +45 -24
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +134 -30
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +283 -124
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +219 -94
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +37 -9
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +27 -8
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +204 -141
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +1076 -478
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +253 -141
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +256 -130
- package/sdk/platform/Content/ContentPlatformClient.d.ts +142 -106
- package/sdk/platform/Content/ContentPlatformClient.js +523 -336
- package/sdk/platform/Content/ContentPlatformModel.d.ts +1372 -400
- package/sdk/platform/Content/ContentPlatformModel.js +631 -394
- package/sdk/platform/Content/ContentPlatformValidator.d.ts +168 -117
- package/sdk/platform/Content/ContentPlatformValidator.js +162 -108
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +14 -12
- package/sdk/platform/Discount/DiscountPlatformClient.js +14 -12
- package/sdk/platform/Discount/DiscountPlatformModel.d.ts +13 -13
- package/sdk/platform/Discount/DiscountPlatformModel.js +12 -12
- package/sdk/platform/Discount/DiscountPlatformValidator.d.ts +2 -2
- package/sdk/platform/Discount/DiscountPlatformValidator.js +2 -2
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +95 -39
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +462 -63
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +62 -15
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +75 -13
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +20 -22
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +21 -24
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +370 -116
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +313 -104
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +6 -6
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.js +6 -6
- package/sdk/platform/Lead/LeadPlatformClient.d.ts +2 -2
- package/sdk/platform/Lead/LeadPlatformClient.js +2 -2
- package/sdk/platform/Lead/LeadPlatformModel.d.ts +5 -5
- package/sdk/platform/Lead/LeadPlatformModel.js +16 -16
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +17 -6
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +85 -7
- package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +95 -24
- package/sdk/platform/Order/OrderPlatformApplicationValidator.js +39 -19
- package/sdk/platform/Order/OrderPlatformClient.d.ts +153 -96
- package/sdk/platform/Order/OrderPlatformClient.js +416 -198
- package/sdk/platform/Order/OrderPlatformModel.d.ts +7607 -1267
- package/sdk/platform/Order/OrderPlatformModel.js +3929 -1269
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +270 -109
- package/sdk/platform/Order/OrderPlatformValidator.js +135 -77
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +6 -4
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +9 -7
- package/sdk/platform/Partner/PartnerPlatformModel.d.ts +9 -9
- package/sdk/platform/Partner/PartnerPlatformModel.js +8 -8
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +93 -105
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +129 -141
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +48 -48
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +48 -48
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +20 -20
- package/sdk/platform/Payment/PaymentPlatformClient.js +20 -20
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +333 -319
- package/sdk/platform/Payment/PaymentPlatformModel.js +288 -278
- package/sdk/platform/Payment/PaymentPlatformValidator.d.ts +8 -8
- package/sdk/platform/Payment/PaymentPlatformValidator.js +8 -8
- package/sdk/platform/PlatformClient.d.ts +0 -2
- package/sdk/platform/PlatformClient.js +0 -4
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +2 -2
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +2 -2
- package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.d.ts +2 -2
- package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.js +2 -2
- package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +9 -9
- package/sdk/platform/Rewards/RewardsPlatformModel.js +8 -8
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +46 -36
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +132 -41
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +46 -17
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +34 -14
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +40 -46
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +58 -64
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +1842 -609
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +886 -554
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +42 -46
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +26 -28
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +5 -5
- package/sdk/platform/Share/SharePlatformApplicationClient.js +9 -9
- package/sdk/platform/Share/SharePlatformApplicationValidator.d.ts +3 -6
- package/sdk/platform/Share/SharePlatformApplicationValidator.js +2 -2
- package/sdk/platform/Share/SharePlatformModel.d.ts +46 -7
- package/sdk/platform/Share/SharePlatformModel.js +31 -6
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +3 -3
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +8 -4
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +5 -0
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +2 -0
- package/sdk/platform/Theme/ThemePlatformModel.d.ts +37 -11
- package/sdk/platform/Theme/ThemePlatformModel.js +33 -15
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +12 -12
- package/sdk/platform/User/UserPlatformApplicationClient.js +12 -12
- package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +2 -2
- package/sdk/platform/User/UserPlatformApplicationValidator.js +2 -2
- package/sdk/platform/User/UserPlatformModel.d.ts +21 -21
- package/sdk/platform/User/UserPlatformModel.js +23 -23
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +25 -78
- package/sdk/platform/Webhook/WebhookPlatformClient.js +75 -470
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +720 -427
- package/sdk/platform/Webhook/WebhookPlatformModel.js +410 -386
- package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +10 -55
- package/sdk/platform/Webhook/WebhookPlatformValidator.js +12 -72
- package/sdk/platform/index.d.ts +0 -1
- package/sdk/platform/index.js +0 -2
- package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +3 -2
- package/sdk/public/Configuration/ConfigurationPublicClient.js +6 -5
- package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +9 -9
- package/sdk/public/Configuration/ConfigurationPublicModel.js +6 -6
- package/sdk/public/Content/ContentPublicClient.d.ts +112 -2
- package/sdk/public/Content/ContentPublicClient.js +810 -6
- package/sdk/public/Content/ContentPublicModel.d.ts +549 -3
- package/sdk/public/Content/ContentPublicModel.js +649 -3
- package/sdk/public/Content/ContentPublicValidator.d.ts +69 -3
- package/sdk/public/Content/ContentPublicValidator.js +88 -2
- package/sdk/public/Webhook/WebhookPublicClient.d.ts +8 -8
- package/sdk/public/Webhook/WebhookPublicClient.js +8 -8
- package/sdk/public/Webhook/WebhookPublicModel.d.ts +21 -21
- package/sdk/public/Webhook/WebhookPublicModel.js +15 -15
- package/sdk/public/Webhook/WebhookPublicValidator.d.ts +4 -4
- package/sdk/public/Webhook/WebhookPublicValidator.js +4 -4
- package/sdk/platform/Finance/FinancePlatformClient.d.ts +0 -320
- package/sdk/platform/Finance/FinancePlatformClient.js +0 -2333
- package/sdk/platform/Finance/FinancePlatformModel.d.ts +0 -2890
- package/sdk/platform/Finance/FinancePlatformModel.js +0 -2148
- package/sdk/platform/Finance/FinancePlatformValidator.d.ts +0 -284
- package/sdk/platform/Finance/FinancePlatformValidator.js +0 -354
|
@@ -7,271 +7,266 @@ declare class Payment {
|
|
|
7
7
|
* @param {PaymentPlatformApplicationValidator.AddEdcDeviceParam} arg - Arg object
|
|
8
8
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
9
9
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
10
|
-
* @returns {Promise<PaymentPlatformModel.
|
|
10
|
+
* @returns {Promise<PaymentPlatformModel.EdcDeviceUpdateDetails>} - Success response
|
|
11
11
|
* @name addEdcDevice
|
|
12
12
|
* @summary: Create an EDC device
|
|
13
13
|
* @description: Registration and addition of a new EDC device to the system - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/addEdcDevice/).
|
|
14
14
|
*/
|
|
15
|
-
addEdcDevice({ terminalUniqueIdentifier, body, requestHeaders }?: PaymentPlatformApplicationValidator.AddEdcDeviceParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.
|
|
15
|
+
addEdcDevice({ terminalUniqueIdentifier, body, requestHeaders }?: PaymentPlatformApplicationValidator.AddEdcDeviceParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.EdcDeviceUpdateDetails>;
|
|
16
16
|
/**
|
|
17
17
|
* @param {PaymentPlatformApplicationValidator.AddRefundBankAccountUsingOTPParam} arg
|
|
18
18
|
* - Arg object
|
|
19
19
|
*
|
|
20
20
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
21
21
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
22
|
-
* @returns {Promise<PaymentPlatformModel.
|
|
22
|
+
* @returns {Promise<PaymentPlatformModel.RefundAccountDetails>} - Success response
|
|
23
23
|
* @name addRefundBankAccountUsingOTP
|
|
24
24
|
* @summary: Create refund account
|
|
25
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
|
-
addRefundBankAccountUsingOTP({ body, requestHeaders }?: PaymentPlatformApplicationValidator.AddRefundBankAccountUsingOTPParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.
|
|
27
|
+
addRefundBankAccountUsingOTP({ body, requestHeaders }?: PaymentPlatformApplicationValidator.AddRefundBankAccountUsingOTPParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.RefundAccountDetails>;
|
|
28
28
|
/**
|
|
29
29
|
* @param {PaymentPlatformApplicationValidator.CancelPaymentLinkParam} arg
|
|
30
30
|
* - Arg object
|
|
31
31
|
*
|
|
32
32
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
33
33
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
34
|
-
* @returns {Promise<PaymentPlatformModel.
|
|
34
|
+
* @returns {Promise<PaymentPlatformModel.CancelPaymentLinkDetails>} -
|
|
35
35
|
* Success response
|
|
36
36
|
* @name cancelPaymentLink
|
|
37
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
|
-
cancelPaymentLink({ body, requestHeaders }?: PaymentPlatformApplicationValidator.CancelPaymentLinkParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.
|
|
40
|
+
cancelPaymentLink({ body, requestHeaders }?: PaymentPlatformApplicationValidator.CancelPaymentLinkParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.CancelPaymentLinkDetails>;
|
|
41
41
|
/**
|
|
42
42
|
* @param {PaymentPlatformApplicationValidator.CheckAndUpdatePaymentStatusParam} arg
|
|
43
43
|
* - Arg object
|
|
44
44
|
*
|
|
45
45
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
46
46
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
47
|
-
* @returns {Promise<PaymentPlatformModel.
|
|
47
|
+
* @returns {Promise<PaymentPlatformModel.PaymentStatusUpdateDetails>} -
|
|
48
48
|
* Success response
|
|
49
49
|
* @name checkAndUpdatePaymentStatus
|
|
50
50
|
* @summary: Poll and update payment status
|
|
51
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
|
-
checkAndUpdatePaymentStatus({ body, requestHeaders }?: PaymentPlatformApplicationValidator.CheckAndUpdatePaymentStatusParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.
|
|
53
|
+
checkAndUpdatePaymentStatus({ body, requestHeaders }?: PaymentPlatformApplicationValidator.CheckAndUpdatePaymentStatusParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.PaymentStatusUpdateDetails>;
|
|
54
54
|
/**
|
|
55
55
|
* @param {PaymentPlatformApplicationValidator.ConfirmPaymentParam} arg - Arg object
|
|
56
56
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
57
57
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
58
|
-
* @returns {Promise<PaymentPlatformModel.
|
|
58
|
+
* @returns {Promise<PaymentPlatformModel.PaymentConfirmationDetails>} -
|
|
59
59
|
* Success response
|
|
60
60
|
* @name confirmPayment
|
|
61
61
|
* @summary: Payment confirmation
|
|
62
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
|
-
confirmPayment({ body, requestHeaders }?: PaymentPlatformApplicationValidator.ConfirmPaymentParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.
|
|
64
|
+
confirmPayment({ body, requestHeaders }?: PaymentPlatformApplicationValidator.ConfirmPaymentParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.PaymentConfirmationDetails>;
|
|
65
65
|
/**
|
|
66
66
|
* @param {PaymentPlatformApplicationValidator.CreateMerchantRefundPriorityParam} arg
|
|
67
67
|
* - Arg object
|
|
68
68
|
*
|
|
69
69
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
70
70
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
71
|
-
* @returns {Promise<PaymentPlatformModel.
|
|
72
|
-
* - Success response
|
|
73
|
-
*
|
|
71
|
+
* @returns {Promise<PaymentPlatformModel.RefundPriorityDetails>} - Success response
|
|
74
72
|
* @name createMerchantRefundPriority
|
|
75
73
|
* @summary: Create merchant refund priority
|
|
76
74
|
* @description: Create merchant refund priority configurations, with the provided refund sources priority details, and return the status of the operation. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/createMerchantRefundPriority/).
|
|
77
75
|
*/
|
|
78
|
-
createMerchantRefundPriority({ configType, body, requestHeaders }?: PaymentPlatformApplicationValidator.CreateMerchantRefundPriorityParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.
|
|
76
|
+
createMerchantRefundPriority({ configType, body, requestHeaders }?: PaymentPlatformApplicationValidator.CreateMerchantRefundPriorityParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.RefundPriorityDetails>;
|
|
79
77
|
/**
|
|
80
78
|
* @param {PaymentPlatformApplicationValidator.CreatePaymentLinkParam} arg
|
|
81
79
|
* - Arg object
|
|
82
80
|
*
|
|
83
81
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
84
82
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
85
|
-
* @returns {Promise<PaymentPlatformModel.
|
|
83
|
+
* @returns {Promise<PaymentPlatformModel.CreatePaymentLinkDetails>} -
|
|
86
84
|
* Success response
|
|
87
85
|
* @name createPaymentLink
|
|
88
86
|
* @summary: Create payment link
|
|
89
87
|
* @description: Generate a payment link for accepting payments. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/createPaymentLink/).
|
|
90
88
|
*/
|
|
91
|
-
createPaymentLink({ body, requestHeaders }?: PaymentPlatformApplicationValidator.CreatePaymentLinkParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.
|
|
89
|
+
createPaymentLink({ body, requestHeaders }?: PaymentPlatformApplicationValidator.CreatePaymentLinkParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.CreatePaymentLinkDetails>;
|
|
92
90
|
/**
|
|
93
91
|
* @param {PaymentPlatformApplicationValidator.CreatePaymentOrderParam} arg
|
|
94
92
|
* - Arg object
|
|
95
93
|
*
|
|
96
94
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
97
95
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
98
|
-
* @returns {Promise<PaymentPlatformModel.
|
|
96
|
+
* @returns {Promise<PaymentPlatformModel.PaymentOrderDetails>} - Success response
|
|
99
97
|
* @name createPaymentOrder
|
|
100
98
|
* @summary: Create Order
|
|
101
99
|
* @description: Create an order and payment on the aggregator side - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/createPaymentOrder/).
|
|
102
100
|
*/
|
|
103
|
-
createPaymentOrder({ body, requestHeaders }?: PaymentPlatformApplicationValidator.CreatePaymentOrderParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.
|
|
101
|
+
createPaymentOrder({ body, requestHeaders }?: PaymentPlatformApplicationValidator.CreatePaymentOrderParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.PaymentOrderDetails>;
|
|
104
102
|
/**
|
|
105
103
|
* @param {PaymentPlatformApplicationValidator.EdcAggregatorsAndModelListParam} arg
|
|
106
104
|
* - Arg object
|
|
107
105
|
*
|
|
108
106
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
109
107
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
110
|
-
* @returns {Promise<PaymentPlatformModel.
|
|
108
|
+
* @returns {Promise<PaymentPlatformModel.EdcAggregatorAndModelListDetails>}
|
|
111
109
|
* - Success response
|
|
112
110
|
*
|
|
113
111
|
* @name edcAggregatorsAndModelList
|
|
114
112
|
* @summary: EDC aggregators and model list
|
|
115
113
|
* @description: Retrieve a list of EDC (Electronic Data Capture) aggregators and models. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/edcAggregatorsAndModelList/).
|
|
116
114
|
*/
|
|
117
|
-
edcAggregatorsAndModelList({ requestHeaders }?: any, { responseHeaders }?: object): Promise<PaymentPlatformModel.
|
|
115
|
+
edcAggregatorsAndModelList({ requestHeaders }?: any, { responseHeaders }?: object): Promise<PaymentPlatformModel.EdcAggregatorAndModelListDetails>;
|
|
118
116
|
/**
|
|
119
117
|
* @param {PaymentPlatformApplicationValidator.EdcDeviceListParam} arg - Arg object
|
|
120
118
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
121
119
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
122
|
-
* @returns {Promise<PaymentPlatformModel.
|
|
120
|
+
* @returns {Promise<PaymentPlatformModel.EdcDeviceListDetails>} - Success response
|
|
123
121
|
* @name edcDeviceList
|
|
124
122
|
* @summary: List EDC devices
|
|
125
123
|
* @description: Retrieves a list of available Electronic Data Capture (EDC) devices. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/edcDeviceList/).
|
|
126
124
|
*/
|
|
127
|
-
edcDeviceList({ pageNo, pageSize, isActive, storeId, deviceTag, requestHeaders }?: PaymentPlatformApplicationValidator.EdcDeviceListParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.
|
|
125
|
+
edcDeviceList({ pageNo, pageSize, isActive, storeId, deviceTag, requestHeaders }?: PaymentPlatformApplicationValidator.EdcDeviceListParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.EdcDeviceListDetails>;
|
|
128
126
|
/**
|
|
129
127
|
* @param {PaymentPlatformApplicationValidator.EdcDeviceStatsParam} arg - Arg object
|
|
130
128
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
131
129
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
132
|
-
* @returns {Promise<PaymentPlatformModel.
|
|
130
|
+
* @returns {Promise<PaymentPlatformModel.EdcDeviceStatsDetails>} - Success response
|
|
133
131
|
* @name edcDeviceStats
|
|
134
132
|
* @summary: EDC device stats
|
|
135
133
|
* @description: Information about EDC (Electronic Data Capture) devices linked to a specific application within a company. It provides statistics such as the count of active and inactive devices. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/edcDeviceStats/).
|
|
136
134
|
*/
|
|
137
|
-
edcDeviceStats({ requestHeaders }?: any, { responseHeaders }?: object): Promise<PaymentPlatformModel.
|
|
135
|
+
edcDeviceStats({ requestHeaders }?: any, { responseHeaders }?: object): Promise<PaymentPlatformModel.EdcDeviceStatsDetails>;
|
|
138
136
|
/**
|
|
139
137
|
* @param {PaymentPlatformApplicationValidator.GetBankAccountDetailsOpenAPIParam} arg
|
|
140
138
|
* - Arg object
|
|
141
139
|
*
|
|
142
140
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
143
141
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
144
|
-
* @returns {Promise<PaymentPlatformModel.
|
|
142
|
+
* @returns {Promise<PaymentPlatformModel.RefundAccountDetails>} - Success response
|
|
145
143
|
* @name getBankAccountDetailsOpenAPI
|
|
146
144
|
* @summary: Get bank account details
|
|
147
145
|
* @description: Retrieve bank account information - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/getBankAccountDetailsOpenAPI/).
|
|
148
146
|
*/
|
|
149
|
-
getBankAccountDetailsOpenAPI({ orderId, requestHash, requestHeaders }?: PaymentPlatformApplicationValidator.GetBankAccountDetailsOpenAPIParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.
|
|
147
|
+
getBankAccountDetailsOpenAPI({ orderId, requestHash, requestHeaders }?: PaymentPlatformApplicationValidator.GetBankAccountDetailsOpenAPIParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.RefundAccountDetails>;
|
|
150
148
|
/**
|
|
151
149
|
* @param {PaymentPlatformApplicationValidator.GetBrandPaymentGatewayConfigParam} arg
|
|
152
150
|
* - Arg object
|
|
153
151
|
*
|
|
154
152
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
155
153
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
156
|
-
* @returns {Promise<PaymentPlatformModel.
|
|
154
|
+
* @returns {Promise<PaymentPlatformModel.PaymentGatewayConfigDetails>} -
|
|
157
155
|
* Success response
|
|
158
156
|
* @name getBrandPaymentGatewayConfig
|
|
159
157
|
* @summary: Get secrets for brand payment gateway
|
|
160
158
|
* @description: Retrieve configuration settings like key, secret, webhook url, merchant salt for brand payment gateways. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/getBrandPaymentGatewayConfig/).
|
|
161
159
|
*/
|
|
162
|
-
getBrandPaymentGatewayConfig({ aggregator, configType, requestHeaders }?: PaymentPlatformApplicationValidator.GetBrandPaymentGatewayConfigParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.
|
|
160
|
+
getBrandPaymentGatewayConfig({ aggregator, configType, requestHeaders }?: PaymentPlatformApplicationValidator.GetBrandPaymentGatewayConfigParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.PaymentGatewayConfigDetails>;
|
|
163
161
|
/**
|
|
164
162
|
* @param {PaymentPlatformApplicationValidator.GetEdcDeviceParam} arg - Arg object
|
|
165
163
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
166
164
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
167
|
-
* @returns {Promise<PaymentPlatformModel.
|
|
168
|
-
* Success response
|
|
165
|
+
* @returns {Promise<PaymentPlatformModel.EdcDeviceDetails>} - Success response
|
|
169
166
|
* @name getEdcDevice
|
|
170
167
|
* @summary: Get an EDC device
|
|
171
168
|
* @description: Retrieve comprehensive details regarding an Electronic Data Capture (EDC) device associated with a particular terminal unique identifier within a company's application.Upon success, it returns the detailed information of the EDC device, including terminal serial number, EDC device serial number, merchant store POS code, store ID, aggregator ID and name, device tag, activation status, and EDC model. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/getEdcDevice/).
|
|
172
169
|
*/
|
|
173
|
-
getEdcDevice({ terminalUniqueIdentifier, requestHeaders }?: PaymentPlatformApplicationValidator.GetEdcDeviceParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.
|
|
170
|
+
getEdcDevice({ terminalUniqueIdentifier, requestHeaders }?: PaymentPlatformApplicationValidator.GetEdcDeviceParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.EdcDeviceDetails>;
|
|
174
171
|
/**
|
|
175
172
|
* @param {PaymentPlatformApplicationValidator.GetMerchantAggregatorAppVersionParam} arg
|
|
176
173
|
* - Arg object
|
|
177
174
|
*
|
|
178
175
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
179
176
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
180
|
-
* @returns {Promise<PaymentPlatformModel.
|
|
177
|
+
* @returns {Promise<PaymentPlatformModel.AggregatorVersionDetails>} -
|
|
181
178
|
* Success response
|
|
182
179
|
* @name getMerchantAggregatorAppVersion
|
|
183
180
|
* @summary: Get app version for Aggregator
|
|
184
181
|
* @description: Get app version required for Payment Mode or sub payment mode for an Aggregator.if merchant required any PG payment mode after certain version for mobile app. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/getMerchantAggregatorAppVersion/).
|
|
185
182
|
*/
|
|
186
|
-
getMerchantAggregatorAppVersion({ aggregatorId, businessUnit, device, paymentModeId, subPaymentMode, requestHeaders, }?: PaymentPlatformApplicationValidator.GetMerchantAggregatorAppVersionParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.
|
|
183
|
+
getMerchantAggregatorAppVersion({ aggregatorId, businessUnit, device, paymentModeId, subPaymentMode, requestHeaders, }?: PaymentPlatformApplicationValidator.GetMerchantAggregatorAppVersionParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.AggregatorVersionDetails>;
|
|
187
184
|
/**
|
|
188
185
|
* @param {PaymentPlatformApplicationValidator.GetMerchantAggregatorPaymentModeDetailsParam} arg
|
|
189
186
|
* - Arg object
|
|
190
187
|
*
|
|
191
188
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
192
189
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
193
|
-
* @returns {Promise<PaymentPlatformModel.
|
|
190
|
+
* @returns {Promise<PaymentPlatformModel.PlatformPaymentModeDetails>} -
|
|
194
191
|
* Success response
|
|
195
192
|
* @name getMerchantAggregatorPaymentModeDetails
|
|
196
193
|
* @summary: Get merchant aggregator and their payment mode
|
|
197
194
|
* @description: Get available payment gateways and payment mode and it's sub payment mode details like for razorpay their active/inactive payment modes netbanking , wallet, upi are shown. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/getMerchantAggregatorPaymentModeDetails/).
|
|
198
195
|
*/
|
|
199
|
-
getMerchantAggregatorPaymentModeDetails({ aggregatorId, businessUnit, device, requestHeaders }?: PaymentPlatformApplicationValidator.GetMerchantAggregatorPaymentModeDetailsParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.
|
|
196
|
+
getMerchantAggregatorPaymentModeDetails({ aggregatorId, businessUnit, device, requestHeaders }?: PaymentPlatformApplicationValidator.GetMerchantAggregatorPaymentModeDetailsParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.PlatformPaymentModeDetails>;
|
|
200
197
|
/**
|
|
201
198
|
* @param {PaymentPlatformApplicationValidator.GetMerchantPaymentOptionParam} arg
|
|
202
199
|
* - Arg object
|
|
203
200
|
*
|
|
204
201
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
205
202
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
206
|
-
* @returns {Promise<PaymentPlatformModel.
|
|
203
|
+
* @returns {Promise<PaymentPlatformModel.PlatformPaymentModeDetails>} -
|
|
207
204
|
* Success response
|
|
208
205
|
* @name getMerchantPaymentOption
|
|
209
206
|
* @summary: Get merchant payment option
|
|
210
207
|
* @description: Retrieve available payment gateways and offline payment mode details for a merchant by providing company ID and application ID, returning a list of active payment gateways and their configurations, including online and offline options. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/getMerchantPaymentOption/).
|
|
211
208
|
*/
|
|
212
|
-
getMerchantPaymentOption({ requestHeaders }?: any, { responseHeaders }?: object): Promise<PaymentPlatformModel.
|
|
209
|
+
getMerchantPaymentOption({ requestHeaders }?: any, { responseHeaders }?: object): Promise<PaymentPlatformModel.PlatformPaymentModeDetails>;
|
|
213
210
|
/**
|
|
214
211
|
* @param {PaymentPlatformApplicationValidator.GetMerchantRefundPriorityParam} arg
|
|
215
212
|
* - Arg object
|
|
216
213
|
*
|
|
217
214
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
218
215
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
219
|
-
* @returns {Promise<PaymentPlatformModel.
|
|
220
|
-
* - Success response
|
|
221
|
-
*
|
|
216
|
+
* @returns {Promise<PaymentPlatformModel.RefundPriorityDetails>} - Success response
|
|
222
217
|
* @name getMerchantRefundPriority
|
|
223
218
|
* @summary: Get merchant refund priority
|
|
224
219
|
* @description: Retrieve merchant refund priority configurations, returning the status of the update and the refund sources priority with their descriptions and priorities. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/getMerchantRefundPriority/).
|
|
225
220
|
*/
|
|
226
|
-
getMerchantRefundPriority({ configType, requestHeaders }?: PaymentPlatformApplicationValidator.GetMerchantRefundPriorityParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.
|
|
221
|
+
getMerchantRefundPriority({ configType, requestHeaders }?: PaymentPlatformApplicationValidator.GetMerchantRefundPriorityParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.RefundPriorityDetails>;
|
|
227
222
|
/**
|
|
228
223
|
* @param {PaymentPlatformApplicationValidator.GetPGConfigAggregatorsParam} arg
|
|
229
224
|
* - Arg object
|
|
230
225
|
*
|
|
231
226
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
232
227
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
233
|
-
* @returns {Promise<PaymentPlatformModel.
|
|
228
|
+
* @returns {Promise<PaymentPlatformModel.PlatformPaymentModeDetails>} -
|
|
234
229
|
* Success response
|
|
235
230
|
* @name getPGConfigAggregators
|
|
236
231
|
* @summary: Get merchant aggregator payment mode
|
|
237
232
|
* @description: Get payment gateway and it's payment mode and it's sub payment mode details like for razorpay update active/inactive payment modes. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/getPGConfigAggregators/).
|
|
238
233
|
*/
|
|
239
|
-
getPGConfigAggregators({ requestHeaders }?: any, { responseHeaders }?: object): Promise<PaymentPlatformModel.
|
|
234
|
+
getPGConfigAggregators({ requestHeaders }?: any, { responseHeaders }?: object): Promise<PaymentPlatformModel.PlatformPaymentModeDetails>;
|
|
240
235
|
/**
|
|
241
236
|
* @param {PaymentPlatformApplicationValidator.GetPaymentCodeOptionParam} arg
|
|
242
237
|
* - Arg object
|
|
243
238
|
*
|
|
244
239
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
245
240
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
246
|
-
* @returns {Promise<PaymentPlatformModel.
|
|
241
|
+
* @returns {Promise<PaymentPlatformModel.GetPaymentCodeDetails>} - Success response
|
|
247
242
|
* @name getPaymentCodeOption
|
|
248
243
|
* @summary: Get payment mode codes
|
|
249
244
|
* @description: Enables users to retrieve options for payment codes.users can access information such as payment method names, networks, and associated codes, facilitating seamless integration and management of payment modes - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/getPaymentCodeOption/).
|
|
250
245
|
*/
|
|
251
|
-
getPaymentCodeOption({ requestHeaders }?: any, { responseHeaders }?: object): Promise<PaymentPlatformModel.
|
|
246
|
+
getPaymentCodeOption({ requestHeaders }?: any, { responseHeaders }?: object): Promise<PaymentPlatformModel.GetPaymentCodeDetails>;
|
|
252
247
|
/**
|
|
253
248
|
* @param {PaymentPlatformApplicationValidator.GetPaymentLinkParam} arg - Arg object
|
|
254
249
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
255
250
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
256
|
-
* @returns {Promise<PaymentPlatformModel.
|
|
251
|
+
* @returns {Promise<PaymentPlatformModel.GetPaymentLinkDetails>} - Success response
|
|
257
252
|
* @name getPaymentLink
|
|
258
253
|
* @summary: Get payment link
|
|
259
254
|
* @description: Retrieve a payment link for making payments. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/getPaymentLink/).
|
|
260
255
|
*/
|
|
261
|
-
getPaymentLink({ paymentLinkId, requestHeaders }?: PaymentPlatformApplicationValidator.GetPaymentLinkParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.
|
|
256
|
+
getPaymentLink({ paymentLinkId, requestHeaders }?: PaymentPlatformApplicationValidator.GetPaymentLinkParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.GetPaymentLinkDetails>;
|
|
262
257
|
/**
|
|
263
258
|
* @param {PaymentPlatformApplicationValidator.GetPaymentModeControlRoutesParam} arg
|
|
264
259
|
* - Arg object
|
|
265
260
|
*
|
|
266
261
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
267
262
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
268
|
-
* @returns {Promise<PaymentPlatformModel.
|
|
263
|
+
* @returns {Promise<PaymentPlatformModel.PlatformPaymentModeDetails>} -
|
|
269
264
|
* Success response
|
|
270
265
|
* @name getPaymentModeControlRoutes
|
|
271
266
|
* @summary: Get offline/advance payment mode
|
|
272
267
|
* @description: Get details of offline / advance payment mode like for cod offline payment mode get user level cod limit, order level cod limit, cod charge. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/getPaymentModeControlRoutes/).
|
|
273
268
|
*/
|
|
274
|
-
getPaymentModeControlRoutes({ mode, requestHeaders }?: PaymentPlatformApplicationValidator.GetPaymentModeControlRoutesParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.
|
|
269
|
+
getPaymentModeControlRoutes({ mode, requestHeaders }?: PaymentPlatformApplicationValidator.GetPaymentModeControlRoutesParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.PlatformPaymentModeDetails>;
|
|
275
270
|
/**
|
|
276
271
|
* @param {PaymentPlatformApplicationValidator.GetPaymentModeCustomConfigParam} arg
|
|
277
272
|
* - Arg object
|
|
@@ -292,214 +287,213 @@ declare class Payment {
|
|
|
292
287
|
*
|
|
293
288
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
294
289
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
295
|
-
* @returns {Promise<PaymentPlatformModel.
|
|
290
|
+
* @returns {Promise<PaymentPlatformModel.PaymentOptionsDetails>} - Success response
|
|
296
291
|
* @name getPaymentModeRoutes
|
|
297
292
|
* @summary: Get payment modes
|
|
298
293
|
* @description: Get available payment methods on the payment page, specifying the aggregator for each option, such as 'Netbanking powered by Juspay' and 'Card powered by Razorpay'. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/getPaymentModeRoutes/).
|
|
299
294
|
*/
|
|
300
|
-
getPaymentModeRoutes({ refresh, requestType, orderId, shipmentId, amount, requestHeaders }?: PaymentPlatformApplicationValidator.GetPaymentModeRoutesParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.
|
|
295
|
+
getPaymentModeRoutes({ refresh, requestType, orderId, shipmentId, amount, requestHeaders }?: PaymentPlatformApplicationValidator.GetPaymentModeRoutesParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.PaymentOptionsDetails>;
|
|
301
296
|
/**
|
|
302
297
|
* @param {PaymentPlatformApplicationValidator.GetPaymentSessionParam} arg
|
|
303
298
|
* - Arg object
|
|
304
299
|
*
|
|
305
300
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
306
301
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
307
|
-
* @returns {Promise<PaymentPlatformModel.
|
|
302
|
+
* @returns {Promise<PaymentPlatformModel.PaymentSessionFetchDetails>} -
|
|
308
303
|
* Success response
|
|
309
304
|
* @name getPaymentSession
|
|
310
305
|
* @summary: Get payment session
|
|
311
306
|
* @description: Allows users to fetch the payment session details associated with a given order ID or transaction ID - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/getPaymentSession/).
|
|
312
307
|
*/
|
|
313
|
-
getPaymentSession({ gid, lineItem, requestHeaders }?: PaymentPlatformApplicationValidator.GetPaymentSessionParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.
|
|
308
|
+
getPaymentSession({ gid, lineItem, requestHeaders }?: PaymentPlatformApplicationValidator.GetPaymentSessionParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.PaymentSessionFetchDetails>;
|
|
314
309
|
/**
|
|
315
310
|
* @param {PaymentPlatformApplicationValidator.GetPosPaymentModeRoutesParam} arg
|
|
316
311
|
* - Arg object
|
|
317
312
|
*
|
|
318
313
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
319
314
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
320
|
-
* @returns {Promise<PaymentPlatformModel.
|
|
321
|
-
* Success response
|
|
315
|
+
* @returns {Promise<PaymentPlatformModel.PaymentModeRouteDetails>} - Success response
|
|
322
316
|
* @name getPosPaymentModeRoutes
|
|
323
317
|
* @summary: List POS payment modes
|
|
324
318
|
* @description: Available payment methods on the payment page for POS, specifying the aggregator for each option, such as 'CARD powered by Juspay' and 'QR powered by Razorpay'. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/getPosPaymentModeRoutes/).
|
|
325
319
|
*/
|
|
326
|
-
getPosPaymentModeRoutes({ amount, pincode, orderType, cartId, checkoutMode, refresh, orderId, cardReference, userDetails, displaySplit, advancePayment, shipmentId, requestHeaders, }?: PaymentPlatformApplicationValidator.GetPosPaymentModeRoutesParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.
|
|
320
|
+
getPosPaymentModeRoutes({ amount, pincode, orderType, cartId, checkoutMode, refresh, orderId, cardReference, userDetails, displaySplit, advancePayment, shipmentId, requestHeaders, }?: PaymentPlatformApplicationValidator.GetPosPaymentModeRoutesParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.PaymentModeRouteDetails>;
|
|
327
321
|
/**
|
|
328
322
|
* @param {PaymentPlatformApplicationValidator.GetUserBeneficiariesParam} arg
|
|
329
323
|
* - Arg object
|
|
330
324
|
*
|
|
331
325
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
332
326
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
333
|
-
* @returns {Promise<PaymentPlatformModel.
|
|
327
|
+
* @returns {Promise<PaymentPlatformModel.OrderBeneficiaryFetchResults>} -
|
|
334
328
|
* Success response
|
|
335
329
|
* @name getUserBeneficiaries
|
|
336
330
|
* @summary: Get user beneficiaries
|
|
337
331
|
* @description: Retrieves information about beneficiaries associated with the user for processing refunds, based on the provided order ID - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/getUserBeneficiaries/).
|
|
338
332
|
*/
|
|
339
|
-
getUserBeneficiaries({ orderId, requestHeaders }?: PaymentPlatformApplicationValidator.GetUserBeneficiariesParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.
|
|
333
|
+
getUserBeneficiaries({ orderId, requestHeaders }?: PaymentPlatformApplicationValidator.GetUserBeneficiariesParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.OrderBeneficiaryFetchResults>;
|
|
340
334
|
/**
|
|
341
335
|
* @param {PaymentPlatformApplicationValidator.GetUserCODlimitRoutesParam} arg
|
|
342
336
|
* - Arg object
|
|
343
337
|
*
|
|
344
338
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
345
339
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
346
|
-
* @returns {Promise<PaymentPlatformModel.
|
|
340
|
+
* @returns {Promise<PaymentPlatformModel.GetUserCODLimitDetails>} - Success response
|
|
347
341
|
* @name getUserCODlimitRoutes
|
|
348
342
|
* @summary: Get user COD
|
|
349
343
|
* @description: Retrieve user cod limt data of user i.e cod is active or not for user and remaining limit - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/getUserCODlimitRoutes/).
|
|
350
344
|
*/
|
|
351
|
-
getUserCODlimitRoutes({ merchantUserId, mobileNo, requestHeaders }?: PaymentPlatformApplicationValidator.GetUserCODlimitRoutesParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.
|
|
345
|
+
getUserCODlimitRoutes({ merchantUserId, mobileNo, requestHeaders }?: PaymentPlatformApplicationValidator.GetUserCODlimitRoutesParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.GetUserCODLimitDetails>;
|
|
352
346
|
/**
|
|
353
347
|
* @param {PaymentPlatformApplicationValidator.GetUserOrderBeneficiariesParam} arg
|
|
354
348
|
* - Arg object
|
|
355
349
|
*
|
|
356
350
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
357
351
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
358
|
-
* @returns {Promise<PaymentPlatformModel.
|
|
352
|
+
* @returns {Promise<PaymentPlatformModel.OrderBeneficiaryFetchResults>} -
|
|
359
353
|
* Success response
|
|
360
354
|
* @name getUserOrderBeneficiaries
|
|
361
355
|
* @summary: Get user order beneficiaries
|
|
362
356
|
* @description: Retrieve beneficiary details like bank name , ifsc code , branch name associated with a specific order for refund processing - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/getUserOrderBeneficiaries/).
|
|
363
357
|
*/
|
|
364
|
-
getUserOrderBeneficiaries({ orderId, requestHeaders }?: PaymentPlatformApplicationValidator.GetUserOrderBeneficiariesParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.
|
|
358
|
+
getUserOrderBeneficiaries({ orderId, requestHeaders }?: PaymentPlatformApplicationValidator.GetUserOrderBeneficiariesParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.OrderBeneficiaryFetchResults>;
|
|
365
359
|
/**
|
|
366
360
|
* @param {PaymentPlatformApplicationValidator.InitialisePaymentParam} arg
|
|
367
361
|
* - Arg object
|
|
368
362
|
*
|
|
369
363
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
370
364
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
371
|
-
* @returns {Promise<PaymentPlatformModel.
|
|
365
|
+
* @returns {Promise<PaymentPlatformModel.PaymentInitializationDetails>} -
|
|
372
366
|
* Success response
|
|
373
367
|
* @name initialisePayment
|
|
374
368
|
* @summary: Start payment process
|
|
375
369
|
* @description: Initiates the payment procedure for an order.Upon successful initiation, it returns a details including the success status, aggregator information, payment method, status, merchant order ID aggregator order , polling URL, timeout, virtual ID, Razorpay payment ID, customer ID, and device ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/initialisePayment/).
|
|
376
370
|
*/
|
|
377
|
-
initialisePayment({ body, requestHeaders }?: PaymentPlatformApplicationValidator.InitialisePaymentParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.
|
|
371
|
+
initialisePayment({ body, requestHeaders }?: PaymentPlatformApplicationValidator.InitialisePaymentParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.PaymentInitializationDetails>;
|
|
378
372
|
/**
|
|
379
373
|
* @param {PaymentPlatformApplicationValidator.MerchantOnBoardingParam} arg
|
|
380
374
|
* - Arg object
|
|
381
375
|
*
|
|
382
376
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
383
377
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
384
|
-
* @returns {Promise<PaymentPlatformModel.
|
|
378
|
+
* @returns {Promise<PaymentPlatformModel.MerchantOnBoardingDetails>} -
|
|
385
379
|
* Success response
|
|
386
380
|
* @name merchantOnBoarding
|
|
387
381
|
* @summary: Merchant onboarding for BNPL
|
|
388
382
|
* @description: Initiate the merchant onboarding process for Buy Now Pay Later (BNPL). - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/merchantOnBoarding/).
|
|
389
383
|
*/
|
|
390
|
-
merchantOnBoarding({ body, requestHeaders }?: PaymentPlatformApplicationValidator.MerchantOnBoardingParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.
|
|
384
|
+
merchantOnBoarding({ body, requestHeaders }?: PaymentPlatformApplicationValidator.MerchantOnBoardingParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.MerchantOnBoardingDetails>;
|
|
391
385
|
/**
|
|
392
386
|
* @param {PaymentPlatformApplicationValidator.OauthGetUrlParam} arg - Arg object
|
|
393
387
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
394
388
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
395
|
-
* @returns {Promise<PaymentPlatformModel.
|
|
389
|
+
* @returns {Promise<PaymentPlatformModel.GetOauthUrlDetails>} - Success response
|
|
396
390
|
* @name oauthGetUrl
|
|
397
391
|
* @summary: Get OAuth URL
|
|
398
392
|
* @description: This has been used when merchant is setup their razorpay payment gateway, they will redirect to razorpay site after submitting all their secrets for authetication. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/oauthGetUrl/).
|
|
399
393
|
*/
|
|
400
|
-
oauthGetUrl({ aggregator, successRedirectUrl, failureRedirectUrl, requestHeaders }?: PaymentPlatformApplicationValidator.OauthGetUrlParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.
|
|
394
|
+
oauthGetUrl({ aggregator, successRedirectUrl, failureRedirectUrl, requestHeaders }?: PaymentPlatformApplicationValidator.OauthGetUrlParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.GetOauthUrlDetails>;
|
|
401
395
|
/**
|
|
402
396
|
* @param {PaymentPlatformApplicationValidator.PatchMerchantAggregatorPaymentModeDetailsParam} arg
|
|
403
397
|
* - Arg object
|
|
404
398
|
*
|
|
405
399
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
406
400
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
407
|
-
* @returns {Promise<PaymentPlatformModel.
|
|
401
|
+
* @returns {Promise<PaymentPlatformModel.PlatformPaymentModeDetails>} -
|
|
408
402
|
* Success response
|
|
409
403
|
* @name patchMerchantAggregatorPaymentModeDetails
|
|
410
404
|
* @summary: Update merchant aggregator payment mode
|
|
411
405
|
* @description: update payment gateway and it's payment mode and it's sub payment mode details like for razorpay update active/inactive payment modes. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/patchMerchantAggregatorPaymentModeDetails/).
|
|
412
406
|
*/
|
|
413
|
-
patchMerchantAggregatorPaymentModeDetails({ aggregatorId, body, requestHeaders }?: PaymentPlatformApplicationValidator.PatchMerchantAggregatorPaymentModeDetailsParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.
|
|
407
|
+
patchMerchantAggregatorPaymentModeDetails({ aggregatorId, body, requestHeaders }?: PaymentPlatformApplicationValidator.PatchMerchantAggregatorPaymentModeDetailsParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.PlatformPaymentModeDetails>;
|
|
414
408
|
/**
|
|
415
409
|
* @param {PaymentPlatformApplicationValidator.PatchMerchantPaymentOptionParam} arg
|
|
416
410
|
* - Arg object
|
|
417
411
|
*
|
|
418
412
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
419
413
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
420
|
-
* @returns {Promise<PaymentPlatformModel.
|
|
414
|
+
* @returns {Promise<PaymentPlatformModel.PlatformPaymentModeDetails>} -
|
|
421
415
|
* Success response
|
|
422
416
|
* @name patchMerchantPaymentOption
|
|
423
417
|
* @summary: Update payment gateways and payment mode
|
|
424
418
|
* @description: Updated online/offline payment as active/inactive like disable offline payment mode will disable offline payment modes on checkout page on merchant's website - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/patchMerchantPaymentOption/).
|
|
425
419
|
*/
|
|
426
|
-
patchMerchantPaymentOption({ body, requestHeaders }?: PaymentPlatformApplicationValidator.PatchMerchantPaymentOptionParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.
|
|
420
|
+
patchMerchantPaymentOption({ body, requestHeaders }?: PaymentPlatformApplicationValidator.PatchMerchantPaymentOptionParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.PlatformPaymentModeDetails>;
|
|
427
421
|
/**
|
|
428
422
|
* @param {PaymentPlatformApplicationValidator.PatchMerchantPaymentOptionVersionParam} arg
|
|
429
423
|
* - Arg object
|
|
430
424
|
*
|
|
431
425
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
432
426
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
433
|
-
* @returns {Promise<PaymentPlatformModel.
|
|
427
|
+
* @returns {Promise<PaymentPlatformModel.PlatformPaymentModeDetails>} -
|
|
434
428
|
* Success response
|
|
435
429
|
* @name patchMerchantPaymentOptionVersion
|
|
436
430
|
* @summary: Update app version for Aggrgator
|
|
437
431
|
* @description: Update app version required for Payment Mode or sub payment mode for an Aggregator.if merchant required any PG payment mode after certain version for mobile app. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/patchMerchantPaymentOptionVersion/).
|
|
438
432
|
*/
|
|
439
|
-
patchMerchantPaymentOptionVersion({ aggregatorId, body, requestHeaders }?: PaymentPlatformApplicationValidator.PatchMerchantPaymentOptionVersionParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.
|
|
433
|
+
patchMerchantPaymentOptionVersion({ aggregatorId, body, requestHeaders }?: PaymentPlatformApplicationValidator.PatchMerchantPaymentOptionVersionParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.PlatformPaymentModeDetails>;
|
|
440
434
|
/**
|
|
441
435
|
* @param {PaymentPlatformApplicationValidator.PaymentStatusBulkParam} arg
|
|
442
436
|
* - Arg object
|
|
443
437
|
*
|
|
444
438
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
445
439
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
446
|
-
* @returns {Promise<PaymentPlatformModel.
|
|
440
|
+
* @returns {Promise<PaymentPlatformModel.PaymentStatusBulkHandlerDetails>}
|
|
447
441
|
* - Success response
|
|
448
442
|
*
|
|
449
443
|
* @name paymentStatusBulk
|
|
450
444
|
* @summary: Retrieve status of multiple payments in bulk
|
|
451
445
|
* @description: Retrieve status of multiple payments in bulk and returns the status of each payment along with associated details such as payment ID, amount, currency, status, payment mode, and payment gateway in the response - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/paymentStatusBulk/).
|
|
452
446
|
*/
|
|
453
|
-
paymentStatusBulk({ body, requestHeaders }?: PaymentPlatformApplicationValidator.PaymentStatusBulkParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.
|
|
447
|
+
paymentStatusBulk({ body, requestHeaders }?: PaymentPlatformApplicationValidator.PaymentStatusBulkParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.PaymentStatusBulkHandlerDetails>;
|
|
454
448
|
/**
|
|
455
449
|
* @param {PaymentPlatformApplicationValidator.PollingPaymentLinkParam} arg
|
|
456
450
|
* - Arg object
|
|
457
451
|
*
|
|
458
452
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
459
453
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
460
|
-
* @returns {Promise<PaymentPlatformModel.
|
|
454
|
+
* @returns {Promise<PaymentPlatformModel.PollingPaymentLinkDetails>} -
|
|
461
455
|
* Success response
|
|
462
456
|
* @name pollingPaymentLink
|
|
463
457
|
* @summary: Poll status of payment link
|
|
464
458
|
* @description: Periodically checks the status of a payment link to monitor for any updates or changes.retrieve real-time information about the payment link's current status, such as whether it has been processed, cancelled, or expired. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/pollingPaymentLink/).
|
|
465
459
|
*/
|
|
466
|
-
pollingPaymentLink({ paymentLinkId, requestHeaders }?: PaymentPlatformApplicationValidator.PollingPaymentLinkParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.
|
|
460
|
+
pollingPaymentLink({ paymentLinkId, requestHeaders }?: PaymentPlatformApplicationValidator.PollingPaymentLinkParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.PollingPaymentLinkDetails>;
|
|
467
461
|
/**
|
|
468
462
|
* @param {PaymentPlatformApplicationValidator.RepaymentDetailsParam} arg - Arg object
|
|
469
463
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
470
464
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
471
|
-
* @returns {Promise<PaymentPlatformModel.
|
|
465
|
+
* @returns {Promise<PaymentPlatformModel.RepaymentDetails>} - Success response
|
|
472
466
|
* @name repaymentDetails
|
|
473
467
|
* @summary: Repayment details for BNPL
|
|
474
468
|
* @description: Retrieve repayment details for Buy Now Pay Later (BNPL) payment - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/repaymentDetails/).
|
|
475
469
|
*/
|
|
476
|
-
repaymentDetails({ body, requestHeaders }?: PaymentPlatformApplicationValidator.RepaymentDetailsParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.
|
|
470
|
+
repaymentDetails({ body, requestHeaders }?: PaymentPlatformApplicationValidator.RepaymentDetailsParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.RepaymentDetails>;
|
|
477
471
|
/**
|
|
478
472
|
* @param {PaymentPlatformApplicationValidator.ResendOrCancelPaymentParam} arg
|
|
479
473
|
* - Arg object
|
|
480
474
|
*
|
|
481
475
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
482
476
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
483
|
-
* @returns {Promise<PaymentPlatformModel.
|
|
477
|
+
* @returns {Promise<PaymentPlatformModel.ResendOrCancelPaymentDetails>} -
|
|
484
478
|
* Success response
|
|
485
479
|
* @name resendOrCancelPayment
|
|
486
480
|
* @summary: Resend or cancel payment
|
|
487
481
|
* @description: Enable you to perform actions related to the resending and cancellation of payment links through SMS or EMAIL. resend or cancel payment link that have been initiated but may require modification or cancellation for various reasons, ensuring flexibility and control in payment processing. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/resendOrCancelPayment/).
|
|
488
482
|
*/
|
|
489
|
-
resendOrCancelPayment({ body, requestHeaders }?: PaymentPlatformApplicationValidator.ResendOrCancelPaymentParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.
|
|
483
|
+
resendOrCancelPayment({ body, requestHeaders }?: PaymentPlatformApplicationValidator.ResendOrCancelPaymentParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.ResendOrCancelPaymentDetails>;
|
|
490
484
|
/**
|
|
491
485
|
* @param {PaymentPlatformApplicationValidator.ResendPaymentLinkParam} arg
|
|
492
486
|
* - Arg object
|
|
493
487
|
*
|
|
494
488
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
495
489
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
496
|
-
* @returns {Promise<PaymentPlatformModel.
|
|
490
|
+
* @returns {Promise<PaymentPlatformModel.ResendPaymentLinkDetails>} -
|
|
497
491
|
* Success response
|
|
498
492
|
* @name resendPaymentLink
|
|
499
493
|
* @summary: Resend payment link
|
|
500
494
|
* @description: Resends an existing payment link to the user to complete the payment. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/resendPaymentLink/).
|
|
501
495
|
*/
|
|
502
|
-
resendPaymentLink({ body, requestHeaders }?: PaymentPlatformApplicationValidator.ResendPaymentLinkParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.
|
|
496
|
+
resendPaymentLink({ body, requestHeaders }?: PaymentPlatformApplicationValidator.ResendPaymentLinkParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.ResendPaymentLinkDetails>;
|
|
503
497
|
/**
|
|
504
498
|
* @param {PaymentPlatformApplicationValidator.RevokeOauthTokenParam} arg - Arg object
|
|
505
499
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -529,13 +523,13 @@ declare class Payment {
|
|
|
529
523
|
*
|
|
530
524
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
531
525
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
532
|
-
* @returns {Promise<PaymentPlatformModel.
|
|
526
|
+
* @returns {Promise<PaymentPlatformModel.PlatformPaymentModeDetails>} -
|
|
533
527
|
* Success response
|
|
534
528
|
* @name setMerchantModeControlRoutes
|
|
535
529
|
* @summary: Update offline payment mode
|
|
536
530
|
* @description: Update offline payment mode details for the merchant like update for cod offline payment mode get user level cod limit, order level cod limit, cod charge, enable/disable device for cod. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/setMerchantModeControlRoutes/).
|
|
537
531
|
*/
|
|
538
|
-
setMerchantModeControlRoutes({ mode, body, requestHeaders }?: PaymentPlatformApplicationValidator.SetMerchantModeControlRoutesParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.
|
|
532
|
+
setMerchantModeControlRoutes({ mode, body, requestHeaders }?: PaymentPlatformApplicationValidator.SetMerchantModeControlRoutesParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.PlatformPaymentModeDetails>;
|
|
539
533
|
/**
|
|
540
534
|
* @param {PaymentPlatformApplicationValidator.SetPaymentModeCustomConfigParam} arg
|
|
541
535
|
* - Arg object
|
|
@@ -556,77 +550,71 @@ declare class Payment {
|
|
|
556
550
|
*
|
|
557
551
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
558
552
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
559
|
-
* @returns {Promise<PaymentPlatformModel.
|
|
553
|
+
* @returns {Promise<PaymentPlatformModel.SetCODOptionDetails>} - Success response
|
|
560
554
|
* @name setUserCODlimitRoutes
|
|
561
555
|
* @summary: Set user COD
|
|
562
556
|
* @description: This allows access to seller to enable disable cod of specific user - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/setUserCODlimitRoutes/).
|
|
563
557
|
*/
|
|
564
|
-
setUserCODlimitRoutes({ body, requestHeaders }?: PaymentPlatformApplicationValidator.SetUserCODlimitRoutesParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.
|
|
558
|
+
setUserCODlimitRoutes({ body, requestHeaders }?: PaymentPlatformApplicationValidator.SetUserCODlimitRoutesParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.SetCODOptionDetails>;
|
|
565
559
|
/**
|
|
566
560
|
* @param {PaymentPlatformApplicationValidator.UpdateEdcDeviceParam} arg - Arg object
|
|
567
561
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
568
562
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
569
|
-
* @returns {Promise<PaymentPlatformModel.
|
|
563
|
+
* @returns {Promise<PaymentPlatformModel.EdcDeviceAddDetails>} - Success response
|
|
570
564
|
* @name updateEdcDevice
|
|
571
565
|
* @summary: Update EDC device
|
|
572
566
|
* @description: Enables the modification of settings and details associated with an Electronic Data Capture (EDC) device linked to a specific application within a company. Upon success, it returns the updated information of the EDC device. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/updateEdcDevice/).
|
|
573
567
|
*/
|
|
574
|
-
updateEdcDevice({ body, requestHeaders }?: PaymentPlatformApplicationValidator.UpdateEdcDeviceParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.
|
|
568
|
+
updateEdcDevice({ body, requestHeaders }?: PaymentPlatformApplicationValidator.UpdateEdcDeviceParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.EdcDeviceAddDetails>;
|
|
575
569
|
/**
|
|
576
570
|
* @param {PaymentPlatformApplicationValidator.UpdateMerchantRefundPriorityParam} arg
|
|
577
571
|
* - Arg object
|
|
578
572
|
*
|
|
579
573
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
580
574
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
581
|
-
* @returns {Promise<PaymentPlatformModel.
|
|
582
|
-
* - Success response
|
|
583
|
-
*
|
|
575
|
+
* @returns {Promise<PaymentPlatformModel.RefundPriorityDetails>} - Success response
|
|
584
576
|
* @name updateMerchantRefundPriority
|
|
585
577
|
* @summary: Update merchant refund priority
|
|
586
578
|
* @description: Update merchant refund priority configurations, with the provided refund sources priority details, and return the status of the operation. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/updateMerchantRefundPriority/).
|
|
587
579
|
*/
|
|
588
|
-
updateMerchantRefundPriority({ configType, body, requestHeaders }?: PaymentPlatformApplicationValidator.UpdateMerchantRefundPriorityParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.
|
|
580
|
+
updateMerchantRefundPriority({ configType, body, requestHeaders }?: PaymentPlatformApplicationValidator.UpdateMerchantRefundPriorityParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.RefundPriorityDetails>;
|
|
589
581
|
/**
|
|
590
582
|
* @param {PaymentPlatformApplicationValidator.UpdatePaymentSessionParam} arg
|
|
591
583
|
* - Arg object
|
|
592
584
|
*
|
|
593
585
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
594
586
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
595
|
-
* @returns {Promise<PaymentPlatformModel.
|
|
596
|
-
*
|
|
597
|
-
*
|
|
587
|
+
* @returns {Promise<PaymentPlatformModel.PaymentSessionPutDetails>} -
|
|
588
|
+
* Success response
|
|
598
589
|
* @name updatePaymentSession
|
|
599
590
|
* @summary: Update payment session
|
|
600
591
|
* @description: Update the details of a payment session associated with a given order ID or transaction ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/updatePaymentSession/).
|
|
601
592
|
*/
|
|
602
|
-
updatePaymentSession({ gid, body, requestHeaders }?: PaymentPlatformApplicationValidator.UpdatePaymentSessionParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.
|
|
593
|
+
updatePaymentSession({ gid, body, requestHeaders }?: PaymentPlatformApplicationValidator.UpdatePaymentSessionParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.PaymentSessionPutDetails>;
|
|
603
594
|
/**
|
|
604
595
|
* @param {PaymentPlatformApplicationValidator.UpdateRefundSessionParam} arg
|
|
605
596
|
* - Arg object
|
|
606
597
|
*
|
|
607
598
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
608
599
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
609
|
-
* @returns {Promise<PaymentPlatformModel.
|
|
610
|
-
* - Success response
|
|
611
|
-
*
|
|
600
|
+
* @returns {Promise<PaymentPlatformModel.RefundSessionDetails>} - Success response
|
|
612
601
|
* @name updateRefundSession
|
|
613
602
|
* @summary: Update refund session
|
|
614
603
|
* @description: Allows users to update the details of a refund session associated with a specific global identifier (GID) and request ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/updateRefundSession/).
|
|
615
604
|
*/
|
|
616
|
-
updateRefundSession({ gid, requestId, body, requestHeaders }?: PaymentPlatformApplicationValidator.UpdateRefundSessionParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.
|
|
605
|
+
updateRefundSession({ gid, requestId, body, requestHeaders }?: PaymentPlatformApplicationValidator.UpdateRefundSessionParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.RefundSessionDetails>;
|
|
617
606
|
/**
|
|
618
607
|
* @param {PaymentPlatformApplicationValidator.VerifyCustomerForPaymentParam} arg
|
|
619
608
|
* - Arg object
|
|
620
609
|
*
|
|
621
610
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
622
611
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
623
|
-
* @returns {Promise<PaymentPlatformModel.
|
|
624
|
-
* Success response
|
|
612
|
+
* @returns {Promise<PaymentPlatformModel.ValidateCustomerDetails>} - Success response
|
|
625
613
|
* @name verifyCustomerForPayment
|
|
626
614
|
* @summary: Validate customer for paylater
|
|
627
615
|
* @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
616
|
*/
|
|
629
|
-
verifyCustomerForPayment({ body, requestHeaders }?: PaymentPlatformApplicationValidator.VerifyCustomerForPaymentParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.
|
|
617
|
+
verifyCustomerForPayment({ body, requestHeaders }?: PaymentPlatformApplicationValidator.VerifyCustomerForPaymentParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.ValidateCustomerDetails>;
|
|
630
618
|
}
|
|
631
619
|
import PaymentPlatformApplicationValidator = require("./PaymentPlatformApplicationValidator");
|
|
632
620
|
import PaymentPlatformModel = require("./PaymentPlatformModel");
|