@gofynd/fdk-client-javascript 1.3.11-beta.7 → 1.3.11-beta.8
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 +1 -1
- package/sdk/application/Cart/CartApplicationClient.js +5 -3
- package/sdk/application/Cart/CartApplicationModel.d.ts +107 -1
- package/sdk/application/Cart/CartApplicationModel.js +74 -0
- package/sdk/application/Cart/CartApplicationValidator.d.ts +4 -0
- package/sdk/application/Cart/CartApplicationValidator.js +4 -0
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +3 -6
- package/sdk/application/Catalog/CatalogApplicationClient.js +7 -20
- package/sdk/application/Catalog/CatalogApplicationModel.d.ts +2 -2
- package/sdk/application/Catalog/CatalogApplicationModel.js +2 -2
- package/sdk/application/Catalog/CatalogApplicationValidator.d.ts +0 -14
- package/sdk/application/Catalog/CatalogApplicationValidator.js +0 -6
- package/sdk/application/Configuration/ConfigurationApplicationModel.d.ts +183 -49
- package/sdk/application/Configuration/ConfigurationApplicationModel.js +173 -31
- package/sdk/application/Content/ContentApplicationClient.d.ts +36 -0
- package/sdk/application/Content/ContentApplicationClient.js +246 -0
- package/sdk/application/Content/ContentApplicationModel.d.ts +208 -1
- package/sdk/application/Content/ContentApplicationModel.js +252 -0
- package/sdk/application/Content/ContentApplicationValidator.d.ts +40 -1
- package/sdk/application/Content/ContentApplicationValidator.js +41 -0
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +67 -0
- package/sdk/application/Logistic/LogisticApplicationClient.js +547 -0
- package/sdk/application/Logistic/LogisticApplicationModel.d.ts +456 -1
- package/sdk/application/Logistic/LogisticApplicationModel.js +488 -0
- package/sdk/application/Logistic/LogisticApplicationValidator.d.ts +211 -1
- package/sdk/application/Logistic/LogisticApplicationValidator.js +131 -0
- package/sdk/application/Order/OrderApplicationClient.d.ts +3 -3
- package/sdk/application/Order/OrderApplicationClient.js +32 -8
- package/sdk/application/Order/OrderApplicationModel.d.ts +6 -0
- package/sdk/application/Order/OrderApplicationModel.js +6 -0
- package/sdk/application/Order/OrderApplicationValidator.d.ts +20 -0
- package/sdk/application/Order/OrderApplicationValidator.js +8 -0
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +46 -2
- package/sdk/application/Payment/PaymentApplicationClient.js +341 -10
- package/sdk/application/Payment/PaymentApplicationModel.d.ts +493 -186
- package/sdk/application/Payment/PaymentApplicationModel.js +341 -70
- package/sdk/application/Payment/PaymentApplicationValidator.d.ts +59 -14
- package/sdk/application/Payment/PaymentApplicationValidator.js +64 -10
- package/sdk/application/PosCart/PosCartApplicationModel.d.ts +34 -1
- package/sdk/application/PosCart/PosCartApplicationModel.js +24 -0
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +1 -1
- package/sdk/application/Theme/ThemeApplicationClient.js +7 -3
- package/sdk/application/Theme/ThemeApplicationModel.d.ts +222 -36
- package/sdk/application/Theme/ThemeApplicationModel.js +322 -26
- package/sdk/application/Theme/ThemeApplicationValidator.d.ts +10 -0
- package/sdk/application/Theme/ThemeApplicationValidator.js +4 -0
- package/sdk/application/User/UserApplicationClient.d.ts +33 -0
- package/sdk/application/User/UserApplicationClient.js +239 -0
- package/sdk/application/User/UserApplicationModel.d.ts +28 -13
- package/sdk/application/User/UserApplicationModel.js +36 -12
- package/sdk/application/User/UserApplicationValidator.d.ts +34 -1
- package/sdk/application/User/UserApplicationValidator.js +36 -0
- package/sdk/partner/Lead/LeadPartnerClient.d.ts +125 -0
- package/sdk/partner/Lead/LeadPartnerClient.js +785 -0
- package/sdk/partner/Lead/LeadPartnerModel.d.ts +1127 -0
- package/sdk/partner/Lead/LeadPartnerModel.js +896 -0
- package/sdk/partner/Lead/LeadPartnerValidator.d.ts +12 -0
- package/sdk/partner/Lead/LeadPartnerValidator.js +67 -0
- package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +155 -0
- package/sdk/partner/Logistics/LogisticsPartnerClient.js +1195 -0
- package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +372 -0
- package/sdk/partner/Logistics/LogisticsPartnerModel.js +442 -0
- package/sdk/partner/Logistics/LogisticsPartnerValidator.d.ts +16 -0
- package/sdk/partner/Logistics/LogisticsPartnerValidator.js +123 -0
- package/sdk/partner/PartnerClient.d.ts +6 -0
- package/sdk/partner/PartnerClient.js +9 -0
- package/sdk/partner/Theme/ThemePartnerClient.d.ts +10 -0
- package/sdk/partner/Theme/ThemePartnerClient.js +80 -0
- package/sdk/partner/Theme/ThemePartnerModel.d.ts +100 -43
- package/sdk/partner/Theme/ThemePartnerModel.js +74 -30
- package/sdk/partner/Theme/ThemePartnerValidator.d.ts +1 -0
- package/sdk/partner/Theme/ThemePartnerValidator.js +9 -0
- package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +99 -0
- package/sdk/partner/Webhook/WebhookPartnerClient.js +753 -0
- package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +566 -0
- package/sdk/partner/Webhook/WebhookPartnerModel.js +583 -0
- package/sdk/partner/Webhook/WebhookPartnerValidator.d.ts +12 -0
- package/sdk/partner/Webhook/WebhookPartnerValidator.js +74 -0
- package/sdk/partner/index.d.ts +3 -0
- package/sdk/partner/index.js +6 -0
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +2 -2
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +11 -1
- package/sdk/platform/Billing/BillingPlatformClient.js +110 -3
- package/sdk/platform/Billing/BillingPlatformModel.d.ts +67 -1
- package/sdk/platform/Billing/BillingPlatformModel.js +78 -0
- package/sdk/platform/Billing/BillingPlatformValidator.d.ts +43 -4
- package/sdk/platform/Billing/BillingPlatformValidator.js +29 -2
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +1 -1
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +7 -1
- package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +4 -0
- package/sdk/platform/Cart/CartPlatformApplicationValidator.js +4 -0
- package/sdk/platform/Cart/CartPlatformModel.d.ts +100 -5
- package/sdk/platform/Cart/CartPlatformModel.js +71 -4
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +15 -11
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +52 -21
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +27 -0
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +11 -0
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +26 -4
- package/sdk/platform/Catalog/CatalogPlatformClient.js +173 -7
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +304 -1
- package/sdk/platform/Catalog/CatalogPlatformModel.js +335 -0
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +31 -3
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +27 -2
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +138 -36
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +739 -57
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +128 -3
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +111 -1
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +150 -1
- package/sdk/platform/Communication/CommunicationPlatformModel.js +172 -0
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +8 -2
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +32 -4
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +38 -9
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +42 -8
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +14 -0
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +6 -0
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +8 -8
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +4 -4
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +371 -132
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +288 -77
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +2 -2
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +2 -2
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +391 -0
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +3630 -1059
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +342 -1
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +401 -0
- package/sdk/platform/Content/ContentPlatformClient.d.ts +277 -0
- package/sdk/platform/Content/ContentPlatformClient.js +2000 -0
- package/sdk/platform/Content/ContentPlatformModel.d.ts +1094 -1
- package/sdk/platform/Content/ContentPlatformModel.js +1356 -46
- package/sdk/platform/Content/ContentPlatformValidator.d.ts +238 -0
- package/sdk/platform/Content/ContentPlatformValidator.js +310 -0
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +2 -2
- package/sdk/platform/Discount/DiscountPlatformClient.js +2 -2
- package/sdk/platform/Discount/DiscountPlatformModel.d.ts +96 -13
- package/sdk/platform/Discount/DiscountPlatformModel.js +104 -12
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +16 -6
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +117 -8
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +55 -4
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +39 -2
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +16 -5
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +18 -4
- package/sdk/platform/Finance/FinancePlatformClient.d.ts +33 -0
- package/sdk/platform/Finance/FinancePlatformClient.js +240 -0
- package/sdk/platform/Finance/FinancePlatformModel.d.ts +151 -5
- package/sdk/platform/Finance/FinancePlatformModel.js +190 -4
- package/sdk/platform/Finance/FinancePlatformValidator.d.ts +38 -1
- package/sdk/platform/Finance/FinancePlatformValidator.js +38 -0
- package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +38 -28
- package/sdk/platform/Lead/LeadPlatformApplicationClient.js +137 -56
- package/sdk/platform/Lead/LeadPlatformApplicationValidator.d.ts +41 -29
- package/sdk/platform/Lead/LeadPlatformApplicationValidator.js +33 -21
- package/sdk/platform/Lead/LeadPlatformModel.d.ts +12 -3
- package/sdk/platform/Lead/LeadPlatformModel.js +16 -2
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +23 -1
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +178 -1
- package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +39 -1
- package/sdk/platform/Order/OrderPlatformApplicationValidator.js +32 -0
- package/sdk/platform/Order/OrderPlatformClient.d.ts +202 -31
- package/sdk/platform/Order/OrderPlatformClient.js +2010 -586
- package/sdk/platform/Order/OrderPlatformModel.d.ts +1032 -470
- package/sdk/platform/Order/OrderPlatformModel.js +1187 -534
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +318 -35
- package/sdk/platform/Order/OrderPlatformValidator.js +292 -29
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +119 -13
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +749 -39
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +143 -7
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +133 -6
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +1 -1
- package/sdk/platform/Payment/PaymentPlatformClient.js +1 -1
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +996 -134
- package/sdk/platform/Payment/PaymentPlatformModel.js +721 -58
- package/sdk/platform/PlatformApplicationClient.d.ts +2 -2
- package/sdk/platform/PlatformApplicationClient.js +4 -4
- package/sdk/platform/PlatformClient.d.ts +4 -2
- package/sdk/platform/PlatformClient.js +8 -4
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +142 -66
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +645 -147
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +131 -63
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +126 -47
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +217 -105
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +1136 -347
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +912 -313
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +1071 -355
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +382 -133
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +266 -102
- package/sdk/platform/Theme/ThemePlatformClient.d.ts +11 -1
- package/sdk/platform/Theme/ThemePlatformClient.js +87 -3
- package/sdk/platform/Theme/ThemePlatformModel.d.ts +333 -47
- package/sdk/platform/Theme/ThemePlatformModel.js +395 -35
- package/sdk/platform/Theme/ThemePlatformValidator.d.ts +28 -4
- package/sdk/platform/Theme/ThemePlatformValidator.js +21 -2
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +116 -1
- package/sdk/platform/User/UserPlatformApplicationClient.js +931 -85
- package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +224 -7
- package/sdk/platform/User/UserPlatformApplicationValidator.js +173 -5
- package/sdk/platform/User/UserPlatformModel.d.ts +344 -7
- package/sdk/platform/User/UserPlatformModel.js +256 -5
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +47 -39
- package/sdk/platform/Webhook/WebhookPlatformClient.js +63 -61
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +264 -156
- package/sdk/platform/Webhook/WebhookPlatformModel.js +276 -153
- package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +7 -10
- package/sdk/platform/Webhook/WebhookPlatformValidator.js +6 -6
- package/sdk/platform/index.d.ts +1 -1
- package/sdk/platform/index.js +2 -2
- package/sdk/public/Billing/BillingPublicClient.d.ts +23 -0
- package/sdk/public/Billing/BillingPublicClient.js +116 -0
- package/sdk/public/Billing/BillingPublicModel.d.ts +92 -0
- package/sdk/public/Billing/BillingPublicModel.js +96 -0
- package/sdk/public/Billing/BillingPublicValidator.d.ts +18 -0
- package/sdk/public/Billing/BillingPublicValidator.js +19 -0
- package/sdk/public/Content/ContentPublicClient.d.ts +22 -0
- package/sdk/public/Content/ContentPublicClient.js +114 -0
- package/sdk/public/Content/ContentPublicModel.d.ts +53 -0
- package/sdk/public/Content/ContentPublicModel.js +60 -0
- package/sdk/public/Content/ContentPublicValidator.d.ts +18 -0
- package/sdk/public/Content/ContentPublicValidator.js +19 -0
- package/sdk/public/PublicClient.d.ts +4 -0
- package/sdk/public/PublicClient.js +8 -0
- package/sdk/public/Webhook/WebhookPublicClient.d.ts +33 -0
- package/sdk/public/Webhook/WebhookPublicClient.js +242 -0
- package/sdk/public/Webhook/WebhookPublicModel.d.ts +147 -1
- package/sdk/public/Webhook/WebhookPublicModel.js +177 -1
- package/sdk/public/Webhook/WebhookPublicValidator.d.ts +23 -1
- package/sdk/public/Webhook/WebhookPublicValidator.js +31 -0
- package/sdk/public/index.d.ts +2 -0
- package/sdk/public/index.js +4 -0
|
@@ -7,10 +7,11 @@ export = PaymentPlatformModel;
|
|
|
7
7
|
/**
|
|
8
8
|
* @typedef AddressDetail
|
|
9
9
|
* @property {string} address - Address details
|
|
10
|
-
* @property {string} address_type - Address type e.g. home, office
|
|
10
|
+
* @property {string} [address_type] - Address type e.g. home, office
|
|
11
11
|
* @property {string} area - Area details
|
|
12
12
|
* @property {string} area_code - Customer pin/zip code
|
|
13
|
-
* @property {string} area_code_slug - Area slug code, use pin
|
|
13
|
+
* @property {string} area_code_slug - Area slug code, use pin or zip code if
|
|
14
|
+
* not available
|
|
14
15
|
* @property {string} city - City name
|
|
15
16
|
* @property {string} country - Country name
|
|
16
17
|
* @property {string} country_iso_code - Country's code name e.g. `IN`, `GB`
|
|
@@ -26,6 +27,63 @@ export = PaymentPlatformModel;
|
|
|
26
27
|
* @property {string} state - State of the customer
|
|
27
28
|
* @property {Object[]} [tags] - Optional address tag
|
|
28
29
|
*/
|
|
30
|
+
/**
|
|
31
|
+
* @typedef AdvanceObject
|
|
32
|
+
* @property {string[]} [all_prepayment_type] - All available types of prepayment
|
|
33
|
+
* @property {boolean} [allow_custom_advance_amount] - Is custom advance amount allowed?
|
|
34
|
+
* @property {number} [amount] - Amount for Payment Breakdown
|
|
35
|
+
* @property {string} [cancellation_type] - Type of cancellation
|
|
36
|
+
* @property {string} [description] - The description for Advance Payment (user
|
|
37
|
+
* configured)
|
|
38
|
+
* @property {string} [display_name] - The display name for Advance payment
|
|
39
|
+
* @property {boolean} [is_active] - Is Advance Payment active
|
|
40
|
+
* @property {string} [prepayment_type] - Type of prepayment value
|
|
41
|
+
* @property {number} [prepayment_value] - Value for prepayment in advance payment
|
|
42
|
+
* @property {number} [refund_time_limit] - Time limit for processing refund
|
|
43
|
+
* @property {string} [time_unit] - Time unit for refunds
|
|
44
|
+
*/
|
|
45
|
+
/**
|
|
46
|
+
* @typedef AdvancePaymentObject
|
|
47
|
+
* @property {AdvanceObject} [advance]
|
|
48
|
+
* @property {string} [display_name] - Display name for Advance Payment Mode
|
|
49
|
+
* @property {number} [display_priority] - Display Priority for Payment Option
|
|
50
|
+
* @property {PaymentModeList[]} [list] - Payment mode
|
|
51
|
+
* @property {string} [name] - Name of Advance Payment Mode
|
|
52
|
+
* @property {number} [payment_mode_id] - Payment Mode ID for Advance Payment Option
|
|
53
|
+
* @property {SplitObject} [split]
|
|
54
|
+
*/
|
|
55
|
+
/**
|
|
56
|
+
* @typedef AggregatorControlRequest
|
|
57
|
+
* @property {string} [business_unit] - Business unit
|
|
58
|
+
* @property {string} [device] - Device name
|
|
59
|
+
* @property {Object[]} [items] - List of item details with respect to payment_mode
|
|
60
|
+
* @property {AggregatorVersionRequestSchema} [version]
|
|
61
|
+
*/
|
|
62
|
+
/**
|
|
63
|
+
* @typedef AggregatorRoute
|
|
64
|
+
* @property {string} [api_link] - Api_link
|
|
65
|
+
* @property {Object} [data] - Data
|
|
66
|
+
* @property {string} [payment_flow] - Payment_flow
|
|
67
|
+
* @property {string} [payment_flow_data] - Payment_flow_data
|
|
68
|
+
*/
|
|
69
|
+
/**
|
|
70
|
+
* @typedef AggregatorVersionItemSchema
|
|
71
|
+
* @property {string} [is_equal_to]
|
|
72
|
+
* @property {string} [is_greater_than]
|
|
73
|
+
* @property {string} [is_less_than]
|
|
74
|
+
*/
|
|
75
|
+
/**
|
|
76
|
+
* @typedef AggregatorVersionRequestSchema
|
|
77
|
+
* @property {string} [is_equal_to]
|
|
78
|
+
* @property {string} [is_greater_than]
|
|
79
|
+
* @property {string} [is_less_than]
|
|
80
|
+
*/
|
|
81
|
+
/**
|
|
82
|
+
* @typedef AggregatorVersionResponse
|
|
83
|
+
* @property {AggregatorVersionItemSchema} [items]
|
|
84
|
+
* @property {string} message - Message
|
|
85
|
+
* @property {boolean} success - Successful or failure
|
|
86
|
+
*/
|
|
29
87
|
/**
|
|
30
88
|
* @typedef BankDetailsForOTP
|
|
31
89
|
* @property {string} account_holder
|
|
@@ -44,6 +102,13 @@ export = PaymentPlatformModel;
|
|
|
44
102
|
* @property {number} status_code - HTTP status code
|
|
45
103
|
* @property {boolean} success - Successful or failure
|
|
46
104
|
*/
|
|
105
|
+
/**
|
|
106
|
+
* @typedef CartDetailsSerializer
|
|
107
|
+
* @property {Object[]} articles - List of articles that are added in cart
|
|
108
|
+
* @property {number} cart_value - Total cart value i.e. amount to be paid
|
|
109
|
+
* @property {Object} items - Items that are added in cart
|
|
110
|
+
* @property {number} [total_quantity] - Total number of items in cart
|
|
111
|
+
*/
|
|
47
112
|
/**
|
|
48
113
|
* @typedef CODChargesLimitsResponse
|
|
49
114
|
* @property {number} [cod_charge] - Cod charges to be applied on order.
|
|
@@ -70,15 +135,15 @@ export = PaymentPlatformModel;
|
|
|
70
135
|
* @property {string} [assign_card_id]
|
|
71
136
|
* @property {string} cart_id
|
|
72
137
|
* @property {string} checkout_mode
|
|
73
|
-
* @property {string} pincode
|
|
74
138
|
*/
|
|
75
139
|
/**
|
|
76
140
|
* @typedef CreatePaymentLinkRequest
|
|
77
141
|
* @property {number} amount - Total value of order
|
|
142
|
+
* @property {string} [country_phone_code] - Phone country code for complete mobile number
|
|
78
143
|
* @property {string} [description] - Merchant order id
|
|
79
144
|
* @property {string} email - Email to which the payment link is to be sent
|
|
80
145
|
* @property {string} external_order_id - Merchant order id
|
|
81
|
-
* @property {CreatePaymentLinkMeta} meta
|
|
146
|
+
* @property {CreatePaymentLinkMeta} meta
|
|
82
147
|
* @property {string} mobile_number - Mobile number to which the payment link is
|
|
83
148
|
* to be sent
|
|
84
149
|
*/
|
|
@@ -131,24 +196,24 @@ export = PaymentPlatformModel;
|
|
|
131
196
|
*/
|
|
132
197
|
/**
|
|
133
198
|
* @typedef EdcDeviceAddResponse
|
|
134
|
-
* @property {EdcDevice} data
|
|
199
|
+
* @property {EdcDevice} data
|
|
135
200
|
* @property {boolean} success - Response is successful or not
|
|
136
201
|
*/
|
|
137
202
|
/**
|
|
138
203
|
* @typedef EdcDeviceDetailsResponse
|
|
139
|
-
* @property {EdcDevice} data
|
|
204
|
+
* @property {EdcDevice} data
|
|
140
205
|
* @property {boolean} success - Response is successful or not
|
|
141
206
|
*/
|
|
142
207
|
/**
|
|
143
208
|
* @typedef EdcDeviceListResponse
|
|
144
209
|
* @property {EdcDevice[]} items - List of all edc mapped to the application
|
|
145
210
|
* options with their Details.
|
|
146
|
-
* @property {Page} page
|
|
211
|
+
* @property {Page} page
|
|
147
212
|
* @property {boolean} success - Response is successful or not
|
|
148
213
|
*/
|
|
149
214
|
/**
|
|
150
215
|
* @typedef EdcDeviceStatsResponse
|
|
151
|
-
* @property {StatisticsData} statistics
|
|
216
|
+
* @property {StatisticsData} statistics
|
|
152
217
|
* @property {boolean} success - Response is successful or not
|
|
153
218
|
*/
|
|
154
219
|
/**
|
|
@@ -195,11 +260,16 @@ export = PaymentPlatformModel;
|
|
|
195
260
|
*/
|
|
196
261
|
/**
|
|
197
262
|
* @typedef ErrorResponse
|
|
198
|
-
* @property {
|
|
263
|
+
* @property {ErrorDescription} [error]
|
|
199
264
|
* @property {string} message - Message
|
|
200
265
|
* @property {number} status_code - HTTP status code
|
|
201
266
|
* @property {boolean} success - Successful or failure
|
|
202
267
|
*/
|
|
268
|
+
/**
|
|
269
|
+
* @typedef FromConfig
|
|
270
|
+
* @property {string} business_unit - Business unit name
|
|
271
|
+
* @property {string} device - Device name
|
|
272
|
+
*/
|
|
203
273
|
/**
|
|
204
274
|
* @typedef GetOauthUrlResponse
|
|
205
275
|
* @property {boolean} success - Response is successful or not
|
|
@@ -207,11 +277,11 @@ export = PaymentPlatformModel;
|
|
|
207
277
|
*/
|
|
208
278
|
/**
|
|
209
279
|
* @typedef GetPaymentCode
|
|
210
|
-
* @property {PaymentCode} method_code
|
|
280
|
+
* @property {PaymentCode} method_code
|
|
211
281
|
*/
|
|
212
282
|
/**
|
|
213
283
|
* @typedef GetPaymentCodeResponse
|
|
214
|
-
* @property {GetPaymentCode} data
|
|
284
|
+
* @property {GetPaymentCode} data
|
|
215
285
|
* @property {boolean} success - Response is successful or not.
|
|
216
286
|
*/
|
|
217
287
|
/**
|
|
@@ -229,7 +299,7 @@ export = PaymentPlatformModel;
|
|
|
229
299
|
/**
|
|
230
300
|
* @typedef GetUserCODLimitResponse
|
|
231
301
|
* @property {boolean} success - Response is successful or not
|
|
232
|
-
* @property {CODdata} user_cod_data
|
|
302
|
+
* @property {CODdata} user_cod_data
|
|
233
303
|
*/
|
|
234
304
|
/**
|
|
235
305
|
* @typedef HttpErrorCodeAndResponse
|
|
@@ -246,7 +316,7 @@ export = PaymentPlatformModel;
|
|
|
246
316
|
* @typedef IntentApp
|
|
247
317
|
* @property {string} [code] - Code
|
|
248
318
|
* @property {string} [display_name] - Display_name
|
|
249
|
-
* @property {
|
|
319
|
+
* @property {PaymentModeLogo} [logos]
|
|
250
320
|
* @property {string} [package_name] - Package_name
|
|
251
321
|
*/
|
|
252
322
|
/**
|
|
@@ -257,7 +327,7 @@ export = PaymentPlatformModel;
|
|
|
257
327
|
/**
|
|
258
328
|
* @typedef LinkStatus
|
|
259
329
|
* @property {string} message - Message
|
|
260
|
-
* @property {
|
|
330
|
+
* @property {string} status - Link action status
|
|
261
331
|
*/
|
|
262
332
|
/**
|
|
263
333
|
* @typedef MerchantOnBoardingRequest
|
|
@@ -265,24 +335,24 @@ export = PaymentPlatformModel;
|
|
|
265
335
|
* @property {string} app_id - Application id
|
|
266
336
|
* @property {string} credit_line_id - Merchant ID at Ajiodhan's end
|
|
267
337
|
* @property {string} status - Status
|
|
268
|
-
* @property {string} user_id - Deadlock
|
|
338
|
+
* @property {string} user_id - Deadlock or Grimlock user id
|
|
269
339
|
*/
|
|
270
340
|
/**
|
|
271
341
|
* @typedef MerchantOnBoardingResponse
|
|
272
342
|
* @property {Object} data
|
|
273
343
|
* @property {boolean} success - Success/Failure of the transaction
|
|
274
344
|
*/
|
|
345
|
+
/**
|
|
346
|
+
* @typedef MerchantPaymentModeRequest
|
|
347
|
+
* @property {string} business_unit - Business unit
|
|
348
|
+
* @property {Object} device - List of devices and its activation status
|
|
349
|
+
* @property {Object[]} items - List of item details with respect to payment_mode
|
|
350
|
+
*/
|
|
275
351
|
/**
|
|
276
352
|
* @typedef MerchnatPaymentModeRequest
|
|
277
353
|
* @property {Object} [offline] - Details to be updated for online payment configuration.
|
|
278
354
|
* @property {Object} [online] - Details to be updated for offline payment configuration.
|
|
279
355
|
*/
|
|
280
|
-
/**
|
|
281
|
-
* @typedef MerchnatPaymentModeResponse
|
|
282
|
-
* @property {Object[]} [items] - List of all aggregator and payment mode details.
|
|
283
|
-
* @property {string} [message] - Message
|
|
284
|
-
* @property {boolean} success - Response is successful or not.
|
|
285
|
-
*/
|
|
286
356
|
/**
|
|
287
357
|
* @typedef MultiTenderPaymentMeta
|
|
288
358
|
* @property {string} [current_status]
|
|
@@ -355,7 +425,7 @@ export = PaymentPlatformModel;
|
|
|
355
425
|
*/
|
|
356
426
|
/**
|
|
357
427
|
* @typedef PaymentCode
|
|
358
|
-
* @property {Code} codes
|
|
428
|
+
* @property {Code} codes
|
|
359
429
|
* @property {string} name - Name of payment name
|
|
360
430
|
* @property {string} networks - Payment networks
|
|
361
431
|
* @property {string} types - Type of payment mode
|
|
@@ -371,10 +441,100 @@ export = PaymentPlatformModel;
|
|
|
371
441
|
* @property {string} order_id - Unique order id
|
|
372
442
|
* @property {boolean} success - Payment confirmation updated or not.
|
|
373
443
|
*/
|
|
444
|
+
/**
|
|
445
|
+
* @typedef PaymentCustomConfigCustomerRequestSchema
|
|
446
|
+
* @property {number[]} [groups] - Customer groups.
|
|
447
|
+
* @property {string} restriction - Customer restriction type.
|
|
448
|
+
*/
|
|
449
|
+
/**
|
|
450
|
+
* @typedef PaymentCustomConfigCustomerSchema
|
|
451
|
+
* @property {number[]} [groups] - Customer groups.
|
|
452
|
+
* @property {string} restriction - Customer restriction type.
|
|
453
|
+
* @property {string[]} [types] - Customer types.
|
|
454
|
+
*/
|
|
455
|
+
/**
|
|
456
|
+
* @typedef PaymentCustomConfigDetailsRequestSchema
|
|
457
|
+
* @property {PaymentCustomConfigCustomerRequestSchema} customer
|
|
458
|
+
* @property {number} min_order_value - The minimum order value for the store
|
|
459
|
+
* @property {PaymentCustomConfigModeSchema} payment_mode
|
|
460
|
+
*/
|
|
461
|
+
/**
|
|
462
|
+
* @typedef PaymentCustomConfigDetailsSchema
|
|
463
|
+
* @property {PaymentCustomConfigCustomerSchema} customer
|
|
464
|
+
* @property {number} min_order_value - The minimum order value for the store
|
|
465
|
+
* @property {PaymentCustomConfigModeSchema} payment_mode
|
|
466
|
+
*/
|
|
467
|
+
/**
|
|
468
|
+
* @typedef PaymentCustomConfigModeSchema
|
|
469
|
+
* @property {boolean} available - Indicates whether the payment mode is available.
|
|
470
|
+
* @property {string[]} [post_order] - Payment modes available for post-order.
|
|
471
|
+
* @property {string[]} [pre_order] - Payment modes available for pre-order.
|
|
472
|
+
*/
|
|
473
|
+
/**
|
|
474
|
+
* @typedef PaymentCustomConfigRequestSchema
|
|
475
|
+
* @property {string} business_unit - The business unit to which the store belongs.
|
|
476
|
+
* @property {PaymentCustomConfigDetailsRequestSchema[]} items
|
|
477
|
+
*/
|
|
478
|
+
/**
|
|
479
|
+
* @typedef PaymentCustomConfigResponseSchema
|
|
480
|
+
* @property {PaymentModeCustomConfigSchema[]} items
|
|
481
|
+
* @property {string} message
|
|
482
|
+
* @property {boolean} success
|
|
483
|
+
*/
|
|
484
|
+
/**
|
|
485
|
+
* @typedef PaymentDetailsSerializer
|
|
486
|
+
* @property {string} [aggregator_customer_id] - Unique customer id generated by
|
|
487
|
+
* payment gateway, not required for standard checkout.
|
|
488
|
+
* @property {string} [aggregator_order_id] - Unique order id or payment request
|
|
489
|
+
* id generated by payment gateway
|
|
490
|
+
* @property {number} amount - Amount paid.
|
|
491
|
+
* @property {number} amount_captured - Amount which is captured or credited to
|
|
492
|
+
* merchant account
|
|
493
|
+
* @property {number} [amount_refunded]
|
|
494
|
+
* @property {string} [cancel_url] - Cancel url sent by Fynd platform at the
|
|
495
|
+
* time of payment creation
|
|
496
|
+
* @property {boolean} [captured] - Whether the payment is captured (credited to
|
|
497
|
+
* merchant account) by payment gateway.
|
|
498
|
+
* @property {string} [created] - Timestamp in epoch
|
|
499
|
+
* @property {string} currency - Currency of the payment.
|
|
500
|
+
* @property {string} g_user_id - Global user identifier - unique user id
|
|
501
|
+
* generated by Fynd platform
|
|
502
|
+
* @property {string} gid - Global identifier of the entity (e.g. order, cart
|
|
503
|
+
* etc.) against which payment_session was initiated. This is generated by
|
|
504
|
+
* Fynd payments platform and is unique.
|
|
505
|
+
* @property {string} [kind] - Optional kind of purchase/payment - one time
|
|
506
|
+
* payment (sale) or subcription. defaults to sale.
|
|
507
|
+
* @property {string} [locale] - User's locale
|
|
508
|
+
* @property {string} [merchant_locale] - Merchant's locale
|
|
509
|
+
* @property {Object} [meta] - Metadata
|
|
510
|
+
* @property {string} mode - Test or live, test mode uses test credentials so
|
|
511
|
+
* that actual payment is not created.
|
|
512
|
+
* @property {string} [payment_id] - Unique transaction id generated by payment gateway
|
|
513
|
+
* @property {Object[]} payment_methods - Method of payment
|
|
514
|
+
* @property {string} status - Stautus of the payment
|
|
515
|
+
* @property {string} [success_url] - Success url sent by Fynd platform at the
|
|
516
|
+
* time of payment creation
|
|
517
|
+
*/
|
|
518
|
+
/**
|
|
519
|
+
* @typedef PaymentFlow
|
|
520
|
+
* @property {AggregatorRoute} [ajiodhan]
|
|
521
|
+
* @property {AggregatorRoute} [bqr_razorpay]
|
|
522
|
+
* @property {AggregatorRoute} [ccavenue]
|
|
523
|
+
* @property {AggregatorRoute} [epaylater]
|
|
524
|
+
* @property {AggregatorRoute} [fynd]
|
|
525
|
+
* @property {AggregatorRoute} [jiopay]
|
|
526
|
+
* @property {AggregatorRoute} [juspay]
|
|
527
|
+
* @property {AggregatorRoute} [mswipe]
|
|
528
|
+
* @property {AggregatorRoute} [payubiz]
|
|
529
|
+
* @property {AggregatorRoute} [razorpay]
|
|
530
|
+
* @property {AggregatorRoute} [rupifi]
|
|
531
|
+
* @property {AggregatorRoute} [simpl]
|
|
532
|
+
* @property {AggregatorRoute} [stripe]
|
|
533
|
+
*/
|
|
374
534
|
/**
|
|
375
535
|
* @typedef PaymentGatewayConfig
|
|
376
536
|
* @property {string} config_type - Config Type of the aggregator
|
|
377
|
-
* @property {boolean} [is_active] - Enable
|
|
537
|
+
* @property {boolean} [is_active] - Enable or Disable Flag
|
|
378
538
|
* @property {string} key - Api key of the payment aggregator
|
|
379
539
|
* @property {string} merchant_salt - Merchant key of the payment aggregator
|
|
380
540
|
* @property {string} secret - Secret Key of the payment aggregator
|
|
@@ -383,7 +543,7 @@ export = PaymentPlatformModel;
|
|
|
383
543
|
* @typedef PaymentGatewayConfigRequest
|
|
384
544
|
* @property {PaymentGatewayConfig} [aggregator_name]
|
|
385
545
|
* @property {string} app_id - Application Id to which Payment config Mapped
|
|
386
|
-
* @property {boolean} [is_active] - Enable
|
|
546
|
+
* @property {boolean} [is_active] - Enable or Disable Flag
|
|
387
547
|
*/
|
|
388
548
|
/**
|
|
389
549
|
* @typedef PaymentGatewayConfigResponse
|
|
@@ -436,6 +596,18 @@ export = PaymentPlatformModel;
|
|
|
436
596
|
* @property {string} [virtual_id] - Payment virtual address.
|
|
437
597
|
* @property {string} [vpa] - Customer vpa address
|
|
438
598
|
*/
|
|
599
|
+
/**
|
|
600
|
+
* @typedef PaymentMethodsMetaOrder
|
|
601
|
+
* @property {string} merchant_code - Merchant code
|
|
602
|
+
* @property {string} payment_gateway - Payment gateway name
|
|
603
|
+
* @property {string} payment_identifier - Payment identifier
|
|
604
|
+
*/
|
|
605
|
+
/**
|
|
606
|
+
* @typedef PaymentModeCustomConfigSchema
|
|
607
|
+
* @property {string} business_unit - The business unit to which the store belongs.
|
|
608
|
+
* @property {PaymentCustomConfigDetailsSchema} custom_config
|
|
609
|
+
* @property {string} display_name - The display name of the store.
|
|
610
|
+
*/
|
|
439
611
|
/**
|
|
440
612
|
* @typedef PaymentModeList
|
|
441
613
|
* @property {string} aggregator_name - Aggregator_name
|
|
@@ -467,11 +639,11 @@ export = PaymentPlatformModel;
|
|
|
467
639
|
* Intent_app_error_dict_list
|
|
468
640
|
* @property {string[]} [intent_app_error_list] - Intent_app_error_list
|
|
469
641
|
* @property {boolean} [intent_flow] - Intent_flow
|
|
470
|
-
* @property {
|
|
642
|
+
* @property {PaymentModeLogo} [logo_url]
|
|
471
643
|
* @property {string} [merchant_code] - Merchant code
|
|
472
644
|
* @property {string} [name] - Name
|
|
473
645
|
* @property {string} [nickname] - Nickname
|
|
474
|
-
* @property {
|
|
646
|
+
* @property {ProductCODData} [product_cod_data]
|
|
475
647
|
* @property {number} [remaining_limit] - Remaining limit
|
|
476
648
|
* @property {number} [retry_count] - Retry_count
|
|
477
649
|
* @property {number} [timeout] - Timeout
|
|
@@ -481,6 +653,13 @@ export = PaymentPlatformModel;
|
|
|
481
653
|
* @property {string} large - Large
|
|
482
654
|
* @property {string} small - Smalll
|
|
483
655
|
*/
|
|
656
|
+
/**
|
|
657
|
+
* @typedef PaymentModeRouteResponse
|
|
658
|
+
* @property {AdvancePaymentObject[]} [advance_payment] - Advance Payment Array
|
|
659
|
+
* @property {Object} [payment_breakup] - Payment Breakup for advance payment
|
|
660
|
+
* @property {PaymentOptionAndFlow} payment_options
|
|
661
|
+
* @property {boolean} success - Response is successful or not
|
|
662
|
+
*/
|
|
484
663
|
/**
|
|
485
664
|
* @typedef PaymentObjectListSerializer
|
|
486
665
|
* @property {Object} [aggregator_payment_object]
|
|
@@ -502,15 +681,58 @@ export = PaymentPlatformModel;
|
|
|
502
681
|
* @property {string} refunded_by
|
|
503
682
|
* @property {Object} user_object
|
|
504
683
|
*/
|
|
684
|
+
/**
|
|
685
|
+
* @typedef PaymentOptionAndFlow
|
|
686
|
+
* @property {PaymentFlow} payment_flows
|
|
687
|
+
* @property {RootPaymentMode[]} payment_option - Payment options
|
|
688
|
+
*/
|
|
505
689
|
/**
|
|
506
690
|
* @typedef PaymentOptions
|
|
507
691
|
* @property {RootPaymentMode[]} payment_option - Payment options
|
|
508
692
|
*/
|
|
509
693
|
/**
|
|
510
694
|
* @typedef PaymentOptionsResponse
|
|
511
|
-
* @property {
|
|
695
|
+
* @property {Object} [payment_breakup] - Payment Breakup for advance payment
|
|
696
|
+
* @property {PaymentOptions} payment_options
|
|
512
697
|
* @property {boolean} success - Response is successful or not
|
|
513
698
|
*/
|
|
699
|
+
/**
|
|
700
|
+
* @typedef PaymentOrderData
|
|
701
|
+
* @property {string} [aggregator] - Aggregator name
|
|
702
|
+
* @property {number} [amount] - Amount
|
|
703
|
+
* @property {string} [callback_url] - Callback url for aggregator
|
|
704
|
+
* @property {string} [contact] - Mobile number
|
|
705
|
+
* @property {string} [currency] - Currency
|
|
706
|
+
* @property {string} [customer_id] - Aggregator customer id
|
|
707
|
+
* @property {string} [email] - Email
|
|
708
|
+
* @property {string} [merchant_order_id] - Merchant order id
|
|
709
|
+
* @property {string} [method] - Method
|
|
710
|
+
* @property {string} [order_id] - Aggregator order id
|
|
711
|
+
*/
|
|
712
|
+
/**
|
|
713
|
+
* @typedef PaymentOrderMethods
|
|
714
|
+
* @property {number} amount - Amount to be collected
|
|
715
|
+
* @property {PaymentMethodsMetaOrder} meta
|
|
716
|
+
* @property {string} mode - Payment mode
|
|
717
|
+
* @property {string} name - Payment mode name
|
|
718
|
+
* @property {string} [payment] - Payment type i.e. Required / Blocked
|
|
719
|
+
*/
|
|
720
|
+
/**
|
|
721
|
+
* @typedef PaymentOrderRequest
|
|
722
|
+
* @property {string} order_id - Order id
|
|
723
|
+
* @property {PaymentOrderMethods[]} [payment_methods]
|
|
724
|
+
* @property {string} [shipment_id] - Shipment_id
|
|
725
|
+
*/
|
|
726
|
+
/**
|
|
727
|
+
* @typedef PaymentOrderResponse
|
|
728
|
+
* @property {string} [callback_url] - Callback url for aggregator
|
|
729
|
+
* @property {PaymentOrderData} [data]
|
|
730
|
+
* @property {string} message - Message
|
|
731
|
+
* @property {string} [order_id] - Merchant order id
|
|
732
|
+
* @property {string} [payment_confirm_url] - Payment confirm url for aggregator
|
|
733
|
+
* @property {number} status_code - HTTP status code
|
|
734
|
+
* @property {boolean} success - Successful or failure
|
|
735
|
+
*/
|
|
514
736
|
/**
|
|
515
737
|
* @typedef PaymentSessionDetail
|
|
516
738
|
* @property {string} [aggregator_customer_id] - Unique customer id generated by
|
|
@@ -533,10 +755,11 @@ export = PaymentPlatformModel;
|
|
|
533
755
|
* @property {string} gid - Global identifier of the entity (e.g. order, cart
|
|
534
756
|
* etc.) against which payment_session was initiated. This is generated by
|
|
535
757
|
* Fynd payments platform and is unique.
|
|
536
|
-
* @property {string} [kind] - Optional kind of purchase
|
|
758
|
+
* @property {string} [kind] - Optional kind of purchase or payment - one time
|
|
537
759
|
* payment (sale) or subcription. defaults to sale.
|
|
538
760
|
* @property {string} [locale] - User's locale
|
|
539
761
|
* @property {string} [merchant_locale] - Merchant's locale
|
|
762
|
+
* @property {Object} [meta] - Metadata
|
|
540
763
|
* @property {string} mode - Test or live, test mode uses test credentials so
|
|
541
764
|
* that actual payment is not created.
|
|
542
765
|
* @property {string} payment_id - Unique transaction id generated by payment gateway
|
|
@@ -569,6 +792,18 @@ export = PaymentPlatformModel;
|
|
|
569
792
|
* @property {string} status - Status of the payment.
|
|
570
793
|
* @property {number} total_amount - Amount paid.
|
|
571
794
|
*/
|
|
795
|
+
/**
|
|
796
|
+
* @typedef PaymentSessionSerializer
|
|
797
|
+
* @property {CartDetailsSerializer} [cart_details]
|
|
798
|
+
* @property {string} [currency] - The currency of the payment.
|
|
799
|
+
* @property {string} gid - Global identifier of the entity (e.g. order, cart
|
|
800
|
+
* etc.) against which payment_session was initiated. This is generated by
|
|
801
|
+
* Fynd payments platform and is unique.
|
|
802
|
+
* @property {Object} payment_details - Object of payment details
|
|
803
|
+
* @property {RefundDetailsSerializer[]} refund_details - Object of refund details
|
|
804
|
+
* @property {string} status - The status of the payment session.
|
|
805
|
+
* @property {number} total_amount - Total amount to be paid
|
|
806
|
+
*/
|
|
572
807
|
/**
|
|
573
808
|
* @typedef PaymentStatusBulkHandlerRequest
|
|
574
809
|
* @property {string[]} merchant_order_id - List of order ids
|
|
@@ -612,10 +847,10 @@ export = PaymentPlatformModel;
|
|
|
612
847
|
*/
|
|
613
848
|
/**
|
|
614
849
|
* @typedef Payout
|
|
615
|
-
* @property {PayoutCustomer} customers
|
|
850
|
+
* @property {PayoutCustomer} customers
|
|
616
851
|
* @property {boolean} is_active - Enable/DIsable Flag Payout
|
|
617
852
|
* @property {boolean} is_default - Default or not
|
|
618
|
-
* @property {PayoutMoreAttributes} more_attributes
|
|
853
|
+
* @property {PayoutMoreAttributes} more_attributes
|
|
619
854
|
* @property {PayoutAggregator[]} [payouts_aggregators]
|
|
620
855
|
* @property {string} transfer_type - Transafer type
|
|
621
856
|
* @property {string} unique_transfer_no - Display priority of the payment mode
|
|
@@ -651,7 +886,7 @@ export = PaymentPlatformModel;
|
|
|
651
886
|
* @typedef PayoutMoreAttributes
|
|
652
887
|
* @property {string} [account_holder] - Account Holder Name
|
|
653
888
|
* @property {string} [account_no] - Account Number
|
|
654
|
-
* @property {string} [account_type] - Account Type Saving
|
|
889
|
+
* @property {string} [account_type] - Account Type Saving or Current
|
|
655
890
|
* @property {string} [bank_name] - Name of Bank
|
|
656
891
|
* @property {string} [branch_name] - Branch Name
|
|
657
892
|
* @property {string} [city] - City
|
|
@@ -662,8 +897,8 @@ export = PaymentPlatformModel;
|
|
|
662
897
|
/**
|
|
663
898
|
* @typedef PayoutRequest
|
|
664
899
|
* @property {string} aggregator - Aggregator Name
|
|
665
|
-
* @property {PayoutBankDetails} bank_details
|
|
666
|
-
* @property {boolean} is_active - Enable
|
|
900
|
+
* @property {PayoutBankDetails} bank_details
|
|
901
|
+
* @property {boolean} is_active - Enable or Disable Flag Payout
|
|
667
902
|
* @property {string} transfer_type - Transafer type
|
|
668
903
|
* @property {string} unique_external_id - Unique Id of Payout
|
|
669
904
|
* @property {Object} users - Payout users object
|
|
@@ -673,7 +908,7 @@ export = PaymentPlatformModel;
|
|
|
673
908
|
* @property {string} aggregator - Aggregator Name
|
|
674
909
|
* @property {Object} bank_details - Payout bank_details object
|
|
675
910
|
* @property {boolean} created - Created flag
|
|
676
|
-
* @property {boolean} is_active - Enable
|
|
911
|
+
* @property {boolean} is_active - Enable or DIsable Flag Payout
|
|
677
912
|
* @property {string} payment_status - Status of payment
|
|
678
913
|
* @property {Object} payouts - Payout object
|
|
679
914
|
* @property {boolean} success - Response is successful or not
|
|
@@ -686,6 +921,17 @@ export = PaymentPlatformModel;
|
|
|
686
921
|
* @property {Payout[]} items - Contains list of PayoutSchema
|
|
687
922
|
* @property {boolean} success - Response is successful or not
|
|
688
923
|
*/
|
|
924
|
+
/**
|
|
925
|
+
* @typedef PlatformPaymentModeCopyConfigRequest
|
|
926
|
+
* @property {FromConfig} from_config
|
|
927
|
+
* @property {ToConfig} to_config
|
|
928
|
+
*/
|
|
929
|
+
/**
|
|
930
|
+
* @typedef PlatformPaymentModeResponse
|
|
931
|
+
* @property {Object[]} [items] - List of all aggregator and payment mode details.
|
|
932
|
+
* @property {string} [message] - Message
|
|
933
|
+
* @property {boolean} success - Response is successful or not.
|
|
934
|
+
*/
|
|
689
935
|
/**
|
|
690
936
|
* @typedef PollingPaymentLinkResponse
|
|
691
937
|
* @property {string} [aggregator_name] - Aggregator name
|
|
@@ -701,7 +947,7 @@ export = PaymentPlatformModel;
|
|
|
701
947
|
*/
|
|
702
948
|
/**
|
|
703
949
|
* @typedef ProductCODData
|
|
704
|
-
* @property {
|
|
950
|
+
* @property {CODChargesLimitsResponse} [cod_charges]
|
|
705
951
|
* @property {Object} [items] - Item id with its cod availability.
|
|
706
952
|
*/
|
|
707
953
|
/**
|
|
@@ -711,6 +957,15 @@ export = PaymentPlatformModel;
|
|
|
711
957
|
* @property {string} message - Response message
|
|
712
958
|
* @property {boolean} success - Success or failure flag.
|
|
713
959
|
*/
|
|
960
|
+
/**
|
|
961
|
+
* @typedef RefundDetailsSerializer
|
|
962
|
+
* @property {number} amount - Refunded amount
|
|
963
|
+
* @property {string} created - Timestamp in epoch.
|
|
964
|
+
* @property {string} currency - The currency of the payment.
|
|
965
|
+
* @property {string} refund_utr - Unique refund utr generated by payment gateway.
|
|
966
|
+
* @property {string} request_id - Refund request id, unique id generated by Fynd platform
|
|
967
|
+
* @property {string} status - The status of the refund.
|
|
968
|
+
*/
|
|
714
969
|
/**
|
|
715
970
|
* @typedef RefundPriorityRequestSerializer
|
|
716
971
|
* @property {boolean} apportion - Apportion refund to multiple sources
|
|
@@ -744,9 +999,11 @@ export = PaymentPlatformModel;
|
|
|
744
999
|
/**
|
|
745
1000
|
* @typedef RefundSessionRequestSerializer
|
|
746
1001
|
* @property {string} currency - The currency of the payment.
|
|
1002
|
+
* @property {ErrorDescription} [error]
|
|
747
1003
|
* @property {string} gid - Global identifier of the entity (e.g. order, cart
|
|
748
1004
|
* etc.) against which payment_session was initiated. This is generated by
|
|
749
1005
|
* Fynd payments platform and is unique.
|
|
1006
|
+
* @property {string} [message] - The status of the refund.
|
|
750
1007
|
* @property {Object} [meta] - Meta
|
|
751
1008
|
* @property {PaymentSessionDetail} payment_details - Details of the payment
|
|
752
1009
|
* @property {RefundSessionDetail[]} [refund_details] - Details of the refund
|
|
@@ -803,7 +1060,7 @@ export = PaymentPlatformModel;
|
|
|
803
1060
|
*/
|
|
804
1061
|
/**
|
|
805
1062
|
* @typedef ResendOrCancelPaymentResponse
|
|
806
|
-
* @property {LinkStatus} data
|
|
1063
|
+
* @property {LinkStatus} data
|
|
807
1064
|
* @property {boolean} success - Response is successful or not.
|
|
808
1065
|
*/
|
|
809
1066
|
/**
|
|
@@ -851,6 +1108,12 @@ export = PaymentPlatformModel;
|
|
|
851
1108
|
* @property {string} message - Message
|
|
852
1109
|
* @property {boolean} success - Response is successful or not
|
|
853
1110
|
*/
|
|
1111
|
+
/**
|
|
1112
|
+
* @typedef SplitObject
|
|
1113
|
+
* @property {number} [amount_remaining] - Amount pending to be paid
|
|
1114
|
+
* @property {number} [splits_remaining] - Number of splits remaining
|
|
1115
|
+
* @property {number} [total_number_of_splits] - Maximum amount of splits allowed
|
|
1116
|
+
*/
|
|
854
1117
|
/**
|
|
855
1118
|
* @typedef StatisticsData
|
|
856
1119
|
* @property {number} active_device_count - No of active devices
|
|
@@ -867,16 +1130,21 @@ export = PaymentPlatformModel;
|
|
|
867
1130
|
* @property {Object[]} data - Subscription Payment Method Object
|
|
868
1131
|
* @property {boolean} success - Response is successful or not
|
|
869
1132
|
*/
|
|
1133
|
+
/**
|
|
1134
|
+
* @typedef ToConfig
|
|
1135
|
+
* @property {string} business_unit - Business unit name
|
|
1136
|
+
* @property {Object[]} device - Device name to copy the config to
|
|
1137
|
+
*/
|
|
870
1138
|
/**
|
|
871
1139
|
* @typedef UpdatePayoutRequest
|
|
872
|
-
* @property {boolean} is_active - Enable
|
|
873
|
-
* @property {boolean} is_default - Enable
|
|
1140
|
+
* @property {boolean} is_active - Enable or Disable Flag Payout
|
|
1141
|
+
* @property {boolean} is_default - Enable or Disable Default Payout
|
|
874
1142
|
* @property {string} unique_external_id - Unique Id of Payout
|
|
875
1143
|
*/
|
|
876
1144
|
/**
|
|
877
1145
|
* @typedef UpdatePayoutResponse
|
|
878
|
-
* @property {boolean} is_active - Enable
|
|
879
|
-
* @property {boolean} is_default - Enable
|
|
1146
|
+
* @property {boolean} is_active - Enable or DIsable Flag Payout
|
|
1147
|
+
* @property {boolean} is_default - Enable or Disable Default Payout
|
|
880
1148
|
* @property {boolean} success - Response is successful or not
|
|
881
1149
|
*/
|
|
882
1150
|
/**
|
|
@@ -899,7 +1167,7 @@ export = PaymentPlatformModel;
|
|
|
899
1167
|
declare class PaymentPlatformModel {
|
|
900
1168
|
}
|
|
901
1169
|
declare namespace PaymentPlatformModel {
|
|
902
|
-
export { AddBeneficiaryDetailsOTPRequest, AddressDetail, BankDetailsForOTP, CancelOrResendPaymentLinkRequest, CancelPaymentLinkResponse, CODChargesLimitsResponse, CODdata, Code, CreatePaymentLinkMeta, CreatePaymentLinkRequest, CreatePaymentLinkResponse, DeletePayoutResponse, DeleteSubscriptionPaymentMethodResponse, EdcAddRequest, EdcAggregatorAndModelListResponse, EdcDevice, EdcDeviceAddResponse, EdcDeviceDetailsResponse, EdcDeviceListResponse, EdcDeviceStatsResponse, EdcDeviceUpdateResponse, EdcModelData, EdcUpdateRequest, ErrorCodeAndDescription, ErrorCodeDescription, ErrorDescription, ErrorResponse, GetOauthUrlResponse, GetPaymentCode, GetPaymentCodeResponse, GetPaymentLinkResponse, GetUserCODLimitResponse, HttpErrorCodeAndResponse, IfscCodeResponse, IntentApp, IntentAppErrorList, LinkStatus, MerchantOnBoardingRequest, MerchantOnBoardingResponse,
|
|
1170
|
+
export { AddBeneficiaryDetailsOTPRequest, AddressDetail, AdvanceObject, AdvancePaymentObject, AggregatorControlRequest, AggregatorRoute, AggregatorVersionItemSchema, AggregatorVersionRequestSchema, AggregatorVersionResponse, BankDetailsForOTP, CancelOrResendPaymentLinkRequest, CancelPaymentLinkResponse, CartDetailsSerializer, CODChargesLimitsResponse, CODdata, Code, CreatePaymentLinkMeta, CreatePaymentLinkRequest, CreatePaymentLinkResponse, DeletePayoutResponse, DeleteSubscriptionPaymentMethodResponse, EdcAddRequest, EdcAggregatorAndModelListResponse, EdcDevice, EdcDeviceAddResponse, EdcDeviceDetailsResponse, EdcDeviceListResponse, EdcDeviceStatsResponse, EdcDeviceUpdateResponse, EdcModelData, EdcUpdateRequest, ErrorCodeAndDescription, ErrorCodeDescription, ErrorDescription, ErrorResponse, FromConfig, GetOauthUrlResponse, GetPaymentCode, GetPaymentCodeResponse, GetPaymentLinkResponse, GetUserCODLimitResponse, HttpErrorCodeAndResponse, IfscCodeResponse, IntentApp, IntentAppErrorList, LinkStatus, MerchantOnBoardingRequest, MerchantOnBoardingResponse, MerchantPaymentModeRequest, MerchnatPaymentModeRequest, MultiTenderPaymentMeta, MultiTenderPaymentMethod, NotFoundResourceError, OrderBeneficiaryDetails, OrderBeneficiaryResponse, OrderDetail, Page, PaymentCode, PaymentConfirmationRequest, PaymentConfirmationResponse, PaymentCustomConfigCustomerRequestSchema, PaymentCustomConfigCustomerSchema, PaymentCustomConfigDetailsRequestSchema, PaymentCustomConfigDetailsSchema, PaymentCustomConfigModeSchema, PaymentCustomConfigRequestSchema, PaymentCustomConfigResponseSchema, PaymentDetailsSerializer, PaymentFlow, PaymentGatewayConfig, PaymentGatewayConfigRequest, PaymentGatewayConfigResponse, PaymentGatewayToBeReviewed, PaymentInitializationRequest, PaymentInitializationResponse, PaymentMethodsMetaOrder, PaymentModeCustomConfigSchema, PaymentModeList, PaymentModeLogo, PaymentModeRouteResponse, PaymentObjectListSerializer, PaymentOptionAndFlow, PaymentOptions, PaymentOptionsResponse, PaymentOrderData, PaymentOrderMethods, PaymentOrderRequest, PaymentOrderResponse, PaymentSessionDetail, PaymentSessionRequestSerializer, PaymentSessionResponseSerializer, PaymentSessionSerializer, PaymentStatusBulkHandlerRequest, PaymentStatusBulkHandlerResponse, PaymentStatusObject, PaymentStatusUpdateRequest, PaymentStatusUpdateResponse, Payout, PayoutAggregator, PayoutBankDetails, PayoutCustomer, PayoutMoreAttributes, PayoutRequest, PayoutResponse, PayoutsResponse, PlatformPaymentModeCopyConfigRequest, PlatformPaymentModeResponse, PollingPaymentLinkResponse, ProductCODData, RefundAccountResponse, RefundDetailsSerializer, RefundPriorityRequestSerializer, RefundPriorityResponseSerializer, RefundSessionDetail, RefundSessionRequestSerializer, RefundSessionResponseSerializer, RefundSourcesPriority, RepaymentDetailsSerialiserPayAll, RepaymentRequestDetails, RepaymentResponse, ResendOrCancelPaymentRequest, ResendOrCancelPaymentResponse, ResendPaymentLinkResponse, RevokeOAuthToken, RootPaymentMode, SaveSubscriptionSetupIntentRequest, SaveSubscriptionSetupIntentResponse, SetCODForUserRequest, SetCODOptionResponse, SplitObject, StatisticsData, SubscriptionConfigResponse, SubscriptionPaymentMethodResponse, ToConfig, UpdatePayoutRequest, UpdatePayoutResponse, ValidateCustomerRequest, ValidateCustomerResponse };
|
|
903
1171
|
}
|
|
904
1172
|
/** @returns {AddBeneficiaryDetailsOTPRequest} */
|
|
905
1173
|
declare function AddBeneficiaryDetailsOTPRequest(): AddBeneficiaryDetailsOTPRequest;
|
|
@@ -917,7 +1185,7 @@ type AddressDetail = {
|
|
|
917
1185
|
/**
|
|
918
1186
|
* - Address type e.g. home, office
|
|
919
1187
|
*/
|
|
920
|
-
address_type
|
|
1188
|
+
address_type?: string;
|
|
921
1189
|
/**
|
|
922
1190
|
* - Area details
|
|
923
1191
|
*/
|
|
@@ -927,7 +1195,8 @@ type AddressDetail = {
|
|
|
927
1195
|
*/
|
|
928
1196
|
area_code: string;
|
|
929
1197
|
/**
|
|
930
|
-
* - Area slug code, use pin
|
|
1198
|
+
* - Area slug code, use pin or zip code if
|
|
1199
|
+
* not available
|
|
931
1200
|
*/
|
|
932
1201
|
area_code_slug: string;
|
|
933
1202
|
/**
|
|
@@ -987,6 +1256,145 @@ type AddressDetail = {
|
|
|
987
1256
|
*/
|
|
988
1257
|
tags?: any[];
|
|
989
1258
|
};
|
|
1259
|
+
/** @returns {AdvanceObject} */
|
|
1260
|
+
declare function AdvanceObject(): AdvanceObject;
|
|
1261
|
+
type AdvanceObject = {
|
|
1262
|
+
/**
|
|
1263
|
+
* - All available types of prepayment
|
|
1264
|
+
*/
|
|
1265
|
+
all_prepayment_type?: string[];
|
|
1266
|
+
/**
|
|
1267
|
+
* - Is custom advance amount allowed?
|
|
1268
|
+
*/
|
|
1269
|
+
allow_custom_advance_amount?: boolean;
|
|
1270
|
+
/**
|
|
1271
|
+
* - Amount for Payment Breakdown
|
|
1272
|
+
*/
|
|
1273
|
+
amount?: number;
|
|
1274
|
+
/**
|
|
1275
|
+
* - Type of cancellation
|
|
1276
|
+
*/
|
|
1277
|
+
cancellation_type?: string;
|
|
1278
|
+
/**
|
|
1279
|
+
* - The description for Advance Payment (user
|
|
1280
|
+
* configured)
|
|
1281
|
+
*/
|
|
1282
|
+
description?: string;
|
|
1283
|
+
/**
|
|
1284
|
+
* - The display name for Advance payment
|
|
1285
|
+
*/
|
|
1286
|
+
display_name?: string;
|
|
1287
|
+
/**
|
|
1288
|
+
* - Is Advance Payment active
|
|
1289
|
+
*/
|
|
1290
|
+
is_active?: boolean;
|
|
1291
|
+
/**
|
|
1292
|
+
* - Type of prepayment value
|
|
1293
|
+
*/
|
|
1294
|
+
prepayment_type?: string;
|
|
1295
|
+
/**
|
|
1296
|
+
* - Value for prepayment in advance payment
|
|
1297
|
+
*/
|
|
1298
|
+
prepayment_value?: number;
|
|
1299
|
+
/**
|
|
1300
|
+
* - Time limit for processing refund
|
|
1301
|
+
*/
|
|
1302
|
+
refund_time_limit?: number;
|
|
1303
|
+
/**
|
|
1304
|
+
* - Time unit for refunds
|
|
1305
|
+
*/
|
|
1306
|
+
time_unit?: string;
|
|
1307
|
+
};
|
|
1308
|
+
/** @returns {AdvancePaymentObject} */
|
|
1309
|
+
declare function AdvancePaymentObject(): AdvancePaymentObject;
|
|
1310
|
+
type AdvancePaymentObject = {
|
|
1311
|
+
advance?: AdvanceObject;
|
|
1312
|
+
/**
|
|
1313
|
+
* - Display name for Advance Payment Mode
|
|
1314
|
+
*/
|
|
1315
|
+
display_name?: string;
|
|
1316
|
+
/**
|
|
1317
|
+
* - Display Priority for Payment Option
|
|
1318
|
+
*/
|
|
1319
|
+
display_priority?: number;
|
|
1320
|
+
/**
|
|
1321
|
+
* - Payment mode
|
|
1322
|
+
*/
|
|
1323
|
+
list?: PaymentModeList[];
|
|
1324
|
+
/**
|
|
1325
|
+
* - Name of Advance Payment Mode
|
|
1326
|
+
*/
|
|
1327
|
+
name?: string;
|
|
1328
|
+
/**
|
|
1329
|
+
* - Payment Mode ID for Advance Payment Option
|
|
1330
|
+
*/
|
|
1331
|
+
payment_mode_id?: number;
|
|
1332
|
+
split?: SplitObject;
|
|
1333
|
+
};
|
|
1334
|
+
/** @returns {AggregatorControlRequest} */
|
|
1335
|
+
declare function AggregatorControlRequest(): AggregatorControlRequest;
|
|
1336
|
+
type AggregatorControlRequest = {
|
|
1337
|
+
/**
|
|
1338
|
+
* - Business unit
|
|
1339
|
+
*/
|
|
1340
|
+
business_unit?: string;
|
|
1341
|
+
/**
|
|
1342
|
+
* - Device name
|
|
1343
|
+
*/
|
|
1344
|
+
device?: string;
|
|
1345
|
+
/**
|
|
1346
|
+
* - List of item details with respect to payment_mode
|
|
1347
|
+
*/
|
|
1348
|
+
items?: any[];
|
|
1349
|
+
version?: AggregatorVersionRequestSchema;
|
|
1350
|
+
};
|
|
1351
|
+
/** @returns {AggregatorRoute} */
|
|
1352
|
+
declare function AggregatorRoute(): AggregatorRoute;
|
|
1353
|
+
type AggregatorRoute = {
|
|
1354
|
+
/**
|
|
1355
|
+
* - Api_link
|
|
1356
|
+
*/
|
|
1357
|
+
api_link?: string;
|
|
1358
|
+
/**
|
|
1359
|
+
* - Data
|
|
1360
|
+
*/
|
|
1361
|
+
data?: any;
|
|
1362
|
+
/**
|
|
1363
|
+
* - Payment_flow
|
|
1364
|
+
*/
|
|
1365
|
+
payment_flow?: string;
|
|
1366
|
+
/**
|
|
1367
|
+
* - Payment_flow_data
|
|
1368
|
+
*/
|
|
1369
|
+
payment_flow_data?: string;
|
|
1370
|
+
};
|
|
1371
|
+
/** @returns {AggregatorVersionItemSchema} */
|
|
1372
|
+
declare function AggregatorVersionItemSchema(): AggregatorVersionItemSchema;
|
|
1373
|
+
type AggregatorVersionItemSchema = {
|
|
1374
|
+
is_equal_to?: string;
|
|
1375
|
+
is_greater_than?: string;
|
|
1376
|
+
is_less_than?: string;
|
|
1377
|
+
};
|
|
1378
|
+
/** @returns {AggregatorVersionRequestSchema} */
|
|
1379
|
+
declare function AggregatorVersionRequestSchema(): AggregatorVersionRequestSchema;
|
|
1380
|
+
type AggregatorVersionRequestSchema = {
|
|
1381
|
+
is_equal_to?: string;
|
|
1382
|
+
is_greater_than?: string;
|
|
1383
|
+
is_less_than?: string;
|
|
1384
|
+
};
|
|
1385
|
+
/** @returns {AggregatorVersionResponse} */
|
|
1386
|
+
declare function AggregatorVersionResponse(): AggregatorVersionResponse;
|
|
1387
|
+
type AggregatorVersionResponse = {
|
|
1388
|
+
items?: AggregatorVersionItemSchema;
|
|
1389
|
+
/**
|
|
1390
|
+
* - Message
|
|
1391
|
+
*/
|
|
1392
|
+
message: string;
|
|
1393
|
+
/**
|
|
1394
|
+
* - Successful or failure
|
|
1395
|
+
*/
|
|
1396
|
+
success: boolean;
|
|
1397
|
+
};
|
|
990
1398
|
/** @returns {BankDetailsForOTP} */
|
|
991
1399
|
declare function BankDetailsForOTP(): BankDetailsForOTP;
|
|
992
1400
|
type BankDetailsForOTP = {
|
|
@@ -1020,6 +1428,26 @@ type CancelPaymentLinkResponse = {
|
|
|
1020
1428
|
*/
|
|
1021
1429
|
success: boolean;
|
|
1022
1430
|
};
|
|
1431
|
+
/** @returns {CartDetailsSerializer} */
|
|
1432
|
+
declare function CartDetailsSerializer(): CartDetailsSerializer;
|
|
1433
|
+
type CartDetailsSerializer = {
|
|
1434
|
+
/**
|
|
1435
|
+
* - List of articles that are added in cart
|
|
1436
|
+
*/
|
|
1437
|
+
articles: any[];
|
|
1438
|
+
/**
|
|
1439
|
+
* - Total cart value i.e. amount to be paid
|
|
1440
|
+
*/
|
|
1441
|
+
cart_value: number;
|
|
1442
|
+
/**
|
|
1443
|
+
* - Items that are added in cart
|
|
1444
|
+
*/
|
|
1445
|
+
items: any;
|
|
1446
|
+
/**
|
|
1447
|
+
* - Total number of items in cart
|
|
1448
|
+
*/
|
|
1449
|
+
total_quantity?: number;
|
|
1450
|
+
};
|
|
1023
1451
|
/** @returns {CODChargesLimitsResponse} */
|
|
1024
1452
|
declare function CODChargesLimitsResponse(): CODChargesLimitsResponse;
|
|
1025
1453
|
type CODChargesLimitsResponse = {
|
|
@@ -1083,7 +1511,6 @@ type CreatePaymentLinkMeta = {
|
|
|
1083
1511
|
assign_card_id?: string;
|
|
1084
1512
|
cart_id: string;
|
|
1085
1513
|
checkout_mode: string;
|
|
1086
|
-
pincode: string;
|
|
1087
1514
|
};
|
|
1088
1515
|
/** @returns {CreatePaymentLinkRequest} */
|
|
1089
1516
|
declare function CreatePaymentLinkRequest(): CreatePaymentLinkRequest;
|
|
@@ -1092,6 +1519,10 @@ type CreatePaymentLinkRequest = {
|
|
|
1092
1519
|
* - Total value of order
|
|
1093
1520
|
*/
|
|
1094
1521
|
amount: number;
|
|
1522
|
+
/**
|
|
1523
|
+
* - Phone country code for complete mobile number
|
|
1524
|
+
*/
|
|
1525
|
+
country_phone_code?: string;
|
|
1095
1526
|
/**
|
|
1096
1527
|
* - Merchant order id
|
|
1097
1528
|
*/
|
|
@@ -1104,9 +1535,6 @@ type CreatePaymentLinkRequest = {
|
|
|
1104
1535
|
* - Merchant order id
|
|
1105
1536
|
*/
|
|
1106
1537
|
external_order_id: string;
|
|
1107
|
-
/**
|
|
1108
|
-
* - Meta
|
|
1109
|
-
*/
|
|
1110
1538
|
meta: CreatePaymentLinkMeta;
|
|
1111
1539
|
/**
|
|
1112
1540
|
* - Mobile number to which the payment link is
|
|
@@ -1251,9 +1679,6 @@ type EdcDevice = {
|
|
|
1251
1679
|
/** @returns {EdcDeviceAddResponse} */
|
|
1252
1680
|
declare function EdcDeviceAddResponse(): EdcDeviceAddResponse;
|
|
1253
1681
|
type EdcDeviceAddResponse = {
|
|
1254
|
-
/**
|
|
1255
|
-
* - Details of the EDC Device that is added
|
|
1256
|
-
*/
|
|
1257
1682
|
data: EdcDevice;
|
|
1258
1683
|
/**
|
|
1259
1684
|
* - Response is successful or not
|
|
@@ -1263,9 +1688,6 @@ type EdcDeviceAddResponse = {
|
|
|
1263
1688
|
/** @returns {EdcDeviceDetailsResponse} */
|
|
1264
1689
|
declare function EdcDeviceDetailsResponse(): EdcDeviceDetailsResponse;
|
|
1265
1690
|
type EdcDeviceDetailsResponse = {
|
|
1266
|
-
/**
|
|
1267
|
-
* - Details of one EDC Device
|
|
1268
|
-
*/
|
|
1269
1691
|
data: EdcDevice;
|
|
1270
1692
|
/**
|
|
1271
1693
|
* - Response is successful or not
|
|
@@ -1280,9 +1702,6 @@ type EdcDeviceListResponse = {
|
|
|
1280
1702
|
* options with their Details.
|
|
1281
1703
|
*/
|
|
1282
1704
|
items: EdcDevice[];
|
|
1283
|
-
/**
|
|
1284
|
-
* - Pagination Response
|
|
1285
|
-
*/
|
|
1286
1705
|
page: Page;
|
|
1287
1706
|
/**
|
|
1288
1707
|
* - Response is successful or not
|
|
@@ -1292,9 +1711,6 @@ type EdcDeviceListResponse = {
|
|
|
1292
1711
|
/** @returns {EdcDeviceStatsResponse} */
|
|
1293
1712
|
declare function EdcDeviceStatsResponse(): EdcDeviceStatsResponse;
|
|
1294
1713
|
type EdcDeviceStatsResponse = {
|
|
1295
|
-
/**
|
|
1296
|
-
* - Message
|
|
1297
|
-
*/
|
|
1298
1714
|
statistics: StatisticsData;
|
|
1299
1715
|
/**
|
|
1300
1716
|
* - Response is successful or not
|
|
@@ -1424,7 +1840,7 @@ type ErrorDescription = {
|
|
|
1424
1840
|
/** @returns {ErrorResponse} */
|
|
1425
1841
|
declare function ErrorResponse(): ErrorResponse;
|
|
1426
1842
|
type ErrorResponse = {
|
|
1427
|
-
error?:
|
|
1843
|
+
error?: ErrorDescription;
|
|
1428
1844
|
/**
|
|
1429
1845
|
* - Message
|
|
1430
1846
|
*/
|
|
@@ -1438,6 +1854,18 @@ type ErrorResponse = {
|
|
|
1438
1854
|
*/
|
|
1439
1855
|
success: boolean;
|
|
1440
1856
|
};
|
|
1857
|
+
/** @returns {FromConfig} */
|
|
1858
|
+
declare function FromConfig(): FromConfig;
|
|
1859
|
+
type FromConfig = {
|
|
1860
|
+
/**
|
|
1861
|
+
* - Business unit name
|
|
1862
|
+
*/
|
|
1863
|
+
business_unit: string;
|
|
1864
|
+
/**
|
|
1865
|
+
* - Device name
|
|
1866
|
+
*/
|
|
1867
|
+
device: string;
|
|
1868
|
+
};
|
|
1441
1869
|
/** @returns {GetOauthUrlResponse} */
|
|
1442
1870
|
declare function GetOauthUrlResponse(): GetOauthUrlResponse;
|
|
1443
1871
|
type GetOauthUrlResponse = {
|
|
@@ -1453,17 +1881,11 @@ type GetOauthUrlResponse = {
|
|
|
1453
1881
|
/** @returns {GetPaymentCode} */
|
|
1454
1882
|
declare function GetPaymentCode(): GetPaymentCode;
|
|
1455
1883
|
type GetPaymentCode = {
|
|
1456
|
-
/**
|
|
1457
|
-
* - Payment method code
|
|
1458
|
-
*/
|
|
1459
1884
|
method_code: PaymentCode;
|
|
1460
1885
|
};
|
|
1461
1886
|
/** @returns {GetPaymentCodeResponse} */
|
|
1462
1887
|
declare function GetPaymentCodeResponse(): GetPaymentCodeResponse;
|
|
1463
1888
|
type GetPaymentCodeResponse = {
|
|
1464
|
-
/**
|
|
1465
|
-
* - Data about Payment Code.
|
|
1466
|
-
*/
|
|
1467
1889
|
data: GetPaymentCode;
|
|
1468
1890
|
/**
|
|
1469
1891
|
* - Response is successful or not.
|
|
@@ -1517,9 +1939,6 @@ type GetUserCODLimitResponse = {
|
|
|
1517
1939
|
* - Response is successful or not
|
|
1518
1940
|
*/
|
|
1519
1941
|
success: boolean;
|
|
1520
|
-
/**
|
|
1521
|
-
* - User COD Data
|
|
1522
|
-
*/
|
|
1523
1942
|
user_cod_data: CODdata;
|
|
1524
1943
|
};
|
|
1525
1944
|
/** @returns {HttpErrorCodeAndResponse} */
|
|
@@ -1558,10 +1977,7 @@ type IntentApp = {
|
|
|
1558
1977
|
* - Display_name
|
|
1559
1978
|
*/
|
|
1560
1979
|
display_name?: string;
|
|
1561
|
-
|
|
1562
|
-
* - Logos
|
|
1563
|
-
*/
|
|
1564
|
-
logos?: any;
|
|
1980
|
+
logos?: PaymentModeLogo;
|
|
1565
1981
|
/**
|
|
1566
1982
|
* - Package_name
|
|
1567
1983
|
*/
|
|
@@ -1589,7 +2005,7 @@ type LinkStatus = {
|
|
|
1589
2005
|
/**
|
|
1590
2006
|
* - Link action status
|
|
1591
2007
|
*/
|
|
1592
|
-
status:
|
|
2008
|
+
status: string;
|
|
1593
2009
|
};
|
|
1594
2010
|
/** @returns {MerchantOnBoardingRequest} */
|
|
1595
2011
|
declare function MerchantOnBoardingRequest(): MerchantOnBoardingRequest;
|
|
@@ -1611,7 +2027,7 @@ type MerchantOnBoardingRequest = {
|
|
|
1611
2027
|
*/
|
|
1612
2028
|
status: string;
|
|
1613
2029
|
/**
|
|
1614
|
-
* - Deadlock
|
|
2030
|
+
* - Deadlock or Grimlock user id
|
|
1615
2031
|
*/
|
|
1616
2032
|
user_id: string;
|
|
1617
2033
|
};
|
|
@@ -1624,6 +2040,22 @@ type MerchantOnBoardingResponse = {
|
|
|
1624
2040
|
*/
|
|
1625
2041
|
success: boolean;
|
|
1626
2042
|
};
|
|
2043
|
+
/** @returns {MerchantPaymentModeRequest} */
|
|
2044
|
+
declare function MerchantPaymentModeRequest(): MerchantPaymentModeRequest;
|
|
2045
|
+
type MerchantPaymentModeRequest = {
|
|
2046
|
+
/**
|
|
2047
|
+
* - Business unit
|
|
2048
|
+
*/
|
|
2049
|
+
business_unit: string;
|
|
2050
|
+
/**
|
|
2051
|
+
* - List of devices and its activation status
|
|
2052
|
+
*/
|
|
2053
|
+
device: any;
|
|
2054
|
+
/**
|
|
2055
|
+
* - List of item details with respect to payment_mode
|
|
2056
|
+
*/
|
|
2057
|
+
items: any[];
|
|
2058
|
+
};
|
|
1627
2059
|
/** @returns {MerchnatPaymentModeRequest} */
|
|
1628
2060
|
declare function MerchnatPaymentModeRequest(): MerchnatPaymentModeRequest;
|
|
1629
2061
|
type MerchnatPaymentModeRequest = {
|
|
@@ -1636,22 +2068,6 @@ type MerchnatPaymentModeRequest = {
|
|
|
1636
2068
|
*/
|
|
1637
2069
|
online?: any;
|
|
1638
2070
|
};
|
|
1639
|
-
/** @returns {MerchnatPaymentModeResponse} */
|
|
1640
|
-
declare function MerchnatPaymentModeResponse(): MerchnatPaymentModeResponse;
|
|
1641
|
-
type MerchnatPaymentModeResponse = {
|
|
1642
|
-
/**
|
|
1643
|
-
* - List of all aggregator and payment mode details.
|
|
1644
|
-
*/
|
|
1645
|
-
items?: any[];
|
|
1646
|
-
/**
|
|
1647
|
-
* - Message
|
|
1648
|
-
*/
|
|
1649
|
-
message?: string;
|
|
1650
|
-
/**
|
|
1651
|
-
* - Response is successful or not.
|
|
1652
|
-
*/
|
|
1653
|
-
success: boolean;
|
|
1654
|
-
};
|
|
1655
2071
|
/** @returns {MultiTenderPaymentMeta} */
|
|
1656
2072
|
declare function MultiTenderPaymentMeta(): MultiTenderPaymentMeta;
|
|
1657
2073
|
type MultiTenderPaymentMeta = {
|
|
@@ -1828,9 +2244,6 @@ type Page = {
|
|
|
1828
2244
|
/** @returns {PaymentCode} */
|
|
1829
2245
|
declare function PaymentCode(): PaymentCode;
|
|
1830
2246
|
type PaymentCode = {
|
|
1831
|
-
/**
|
|
1832
|
-
* - List of dict that contains payment method data
|
|
1833
|
-
*/
|
|
1834
2247
|
codes: Code;
|
|
1835
2248
|
/**
|
|
1836
2249
|
* - Name of payment name
|
|
@@ -1870,15 +2283,204 @@ type PaymentConfirmationResponse = {
|
|
|
1870
2283
|
*/
|
|
1871
2284
|
success: boolean;
|
|
1872
2285
|
};
|
|
1873
|
-
/** @returns {
|
|
1874
|
-
declare function
|
|
1875
|
-
type
|
|
2286
|
+
/** @returns {PaymentCustomConfigCustomerRequestSchema} */
|
|
2287
|
+
declare function PaymentCustomConfigCustomerRequestSchema(): PaymentCustomConfigCustomerRequestSchema;
|
|
2288
|
+
type PaymentCustomConfigCustomerRequestSchema = {
|
|
1876
2289
|
/**
|
|
1877
|
-
* -
|
|
2290
|
+
* - Customer groups.
|
|
1878
2291
|
*/
|
|
1879
|
-
|
|
2292
|
+
groups?: number[];
|
|
1880
2293
|
/**
|
|
1881
|
-
* -
|
|
2294
|
+
* - Customer restriction type.
|
|
2295
|
+
*/
|
|
2296
|
+
restriction: string;
|
|
2297
|
+
};
|
|
2298
|
+
/** @returns {PaymentCustomConfigCustomerSchema} */
|
|
2299
|
+
declare function PaymentCustomConfigCustomerSchema(): PaymentCustomConfigCustomerSchema;
|
|
2300
|
+
type PaymentCustomConfigCustomerSchema = {
|
|
2301
|
+
/**
|
|
2302
|
+
* - Customer groups.
|
|
2303
|
+
*/
|
|
2304
|
+
groups?: number[];
|
|
2305
|
+
/**
|
|
2306
|
+
* - Customer restriction type.
|
|
2307
|
+
*/
|
|
2308
|
+
restriction: string;
|
|
2309
|
+
/**
|
|
2310
|
+
* - Customer types.
|
|
2311
|
+
*/
|
|
2312
|
+
types?: string[];
|
|
2313
|
+
};
|
|
2314
|
+
/** @returns {PaymentCustomConfigDetailsRequestSchema} */
|
|
2315
|
+
declare function PaymentCustomConfigDetailsRequestSchema(): PaymentCustomConfigDetailsRequestSchema;
|
|
2316
|
+
type PaymentCustomConfigDetailsRequestSchema = {
|
|
2317
|
+
customer: PaymentCustomConfigCustomerRequestSchema;
|
|
2318
|
+
/**
|
|
2319
|
+
* - The minimum order value for the store
|
|
2320
|
+
*/
|
|
2321
|
+
min_order_value: number;
|
|
2322
|
+
payment_mode: PaymentCustomConfigModeSchema;
|
|
2323
|
+
};
|
|
2324
|
+
/** @returns {PaymentCustomConfigDetailsSchema} */
|
|
2325
|
+
declare function PaymentCustomConfigDetailsSchema(): PaymentCustomConfigDetailsSchema;
|
|
2326
|
+
type PaymentCustomConfigDetailsSchema = {
|
|
2327
|
+
customer: PaymentCustomConfigCustomerSchema;
|
|
2328
|
+
/**
|
|
2329
|
+
* - The minimum order value for the store
|
|
2330
|
+
*/
|
|
2331
|
+
min_order_value: number;
|
|
2332
|
+
payment_mode: PaymentCustomConfigModeSchema;
|
|
2333
|
+
};
|
|
2334
|
+
/** @returns {PaymentCustomConfigModeSchema} */
|
|
2335
|
+
declare function PaymentCustomConfigModeSchema(): PaymentCustomConfigModeSchema;
|
|
2336
|
+
type PaymentCustomConfigModeSchema = {
|
|
2337
|
+
/**
|
|
2338
|
+
* - Indicates whether the payment mode is available.
|
|
2339
|
+
*/
|
|
2340
|
+
available: boolean;
|
|
2341
|
+
/**
|
|
2342
|
+
* - Payment modes available for post-order.
|
|
2343
|
+
*/
|
|
2344
|
+
post_order?: string[];
|
|
2345
|
+
/**
|
|
2346
|
+
* - Payment modes available for pre-order.
|
|
2347
|
+
*/
|
|
2348
|
+
pre_order?: string[];
|
|
2349
|
+
};
|
|
2350
|
+
/** @returns {PaymentCustomConfigRequestSchema} */
|
|
2351
|
+
declare function PaymentCustomConfigRequestSchema(): PaymentCustomConfigRequestSchema;
|
|
2352
|
+
type PaymentCustomConfigRequestSchema = {
|
|
2353
|
+
/**
|
|
2354
|
+
* - The business unit to which the store belongs.
|
|
2355
|
+
*/
|
|
2356
|
+
business_unit: string;
|
|
2357
|
+
items: PaymentCustomConfigDetailsRequestSchema[];
|
|
2358
|
+
};
|
|
2359
|
+
/** @returns {PaymentCustomConfigResponseSchema} */
|
|
2360
|
+
declare function PaymentCustomConfigResponseSchema(): PaymentCustomConfigResponseSchema;
|
|
2361
|
+
type PaymentCustomConfigResponseSchema = {
|
|
2362
|
+
items: PaymentModeCustomConfigSchema[];
|
|
2363
|
+
message: string;
|
|
2364
|
+
success: boolean;
|
|
2365
|
+
};
|
|
2366
|
+
/** @returns {PaymentDetailsSerializer} */
|
|
2367
|
+
declare function PaymentDetailsSerializer(): PaymentDetailsSerializer;
|
|
2368
|
+
type PaymentDetailsSerializer = {
|
|
2369
|
+
/**
|
|
2370
|
+
* - Unique customer id generated by
|
|
2371
|
+
* payment gateway, not required for standard checkout.
|
|
2372
|
+
*/
|
|
2373
|
+
aggregator_customer_id?: string;
|
|
2374
|
+
/**
|
|
2375
|
+
* - Unique order id or payment request
|
|
2376
|
+
* id generated by payment gateway
|
|
2377
|
+
*/
|
|
2378
|
+
aggregator_order_id?: string;
|
|
2379
|
+
/**
|
|
2380
|
+
* - Amount paid.
|
|
2381
|
+
*/
|
|
2382
|
+
amount: number;
|
|
2383
|
+
/**
|
|
2384
|
+
* - Amount which is captured or credited to
|
|
2385
|
+
* merchant account
|
|
2386
|
+
*/
|
|
2387
|
+
amount_captured: number;
|
|
2388
|
+
amount_refunded?: number;
|
|
2389
|
+
/**
|
|
2390
|
+
* - Cancel url sent by Fynd platform at the
|
|
2391
|
+
* time of payment creation
|
|
2392
|
+
*/
|
|
2393
|
+
cancel_url?: string;
|
|
2394
|
+
/**
|
|
2395
|
+
* - Whether the payment is captured (credited to
|
|
2396
|
+
* merchant account) by payment gateway.
|
|
2397
|
+
*/
|
|
2398
|
+
captured?: boolean;
|
|
2399
|
+
/**
|
|
2400
|
+
* - Timestamp in epoch
|
|
2401
|
+
*/
|
|
2402
|
+
created?: string;
|
|
2403
|
+
/**
|
|
2404
|
+
* - Currency of the payment.
|
|
2405
|
+
*/
|
|
2406
|
+
currency: string;
|
|
2407
|
+
/**
|
|
2408
|
+
* - Global user identifier - unique user id
|
|
2409
|
+
* generated by Fynd platform
|
|
2410
|
+
*/
|
|
2411
|
+
g_user_id: string;
|
|
2412
|
+
/**
|
|
2413
|
+
* - Global identifier of the entity (e.g. order, cart
|
|
2414
|
+
* etc.) against which payment_session was initiated. This is generated by
|
|
2415
|
+
* Fynd payments platform and is unique.
|
|
2416
|
+
*/
|
|
2417
|
+
gid: string;
|
|
2418
|
+
/**
|
|
2419
|
+
* - Optional kind of purchase/payment - one time
|
|
2420
|
+
* payment (sale) or subcription. defaults to sale.
|
|
2421
|
+
*/
|
|
2422
|
+
kind?: string;
|
|
2423
|
+
/**
|
|
2424
|
+
* - User's locale
|
|
2425
|
+
*/
|
|
2426
|
+
locale?: string;
|
|
2427
|
+
/**
|
|
2428
|
+
* - Merchant's locale
|
|
2429
|
+
*/
|
|
2430
|
+
merchant_locale?: string;
|
|
2431
|
+
/**
|
|
2432
|
+
* - Metadata
|
|
2433
|
+
*/
|
|
2434
|
+
meta?: any;
|
|
2435
|
+
/**
|
|
2436
|
+
* - Test or live, test mode uses test credentials so
|
|
2437
|
+
* that actual payment is not created.
|
|
2438
|
+
*/
|
|
2439
|
+
mode: string;
|
|
2440
|
+
/**
|
|
2441
|
+
* - Unique transaction id generated by payment gateway
|
|
2442
|
+
*/
|
|
2443
|
+
payment_id?: string;
|
|
2444
|
+
/**
|
|
2445
|
+
* - Method of payment
|
|
2446
|
+
*/
|
|
2447
|
+
payment_methods: any[];
|
|
2448
|
+
/**
|
|
2449
|
+
* - Stautus of the payment
|
|
2450
|
+
*/
|
|
2451
|
+
status: string;
|
|
2452
|
+
/**
|
|
2453
|
+
* - Success url sent by Fynd platform at the
|
|
2454
|
+
* time of payment creation
|
|
2455
|
+
*/
|
|
2456
|
+
success_url?: string;
|
|
2457
|
+
};
|
|
2458
|
+
/** @returns {PaymentFlow} */
|
|
2459
|
+
declare function PaymentFlow(): PaymentFlow;
|
|
2460
|
+
type PaymentFlow = {
|
|
2461
|
+
ajiodhan?: AggregatorRoute;
|
|
2462
|
+
bqr_razorpay?: AggregatorRoute;
|
|
2463
|
+
ccavenue?: AggregatorRoute;
|
|
2464
|
+
epaylater?: AggregatorRoute;
|
|
2465
|
+
fynd?: AggregatorRoute;
|
|
2466
|
+
jiopay?: AggregatorRoute;
|
|
2467
|
+
juspay?: AggregatorRoute;
|
|
2468
|
+
mswipe?: AggregatorRoute;
|
|
2469
|
+
payubiz?: AggregatorRoute;
|
|
2470
|
+
razorpay?: AggregatorRoute;
|
|
2471
|
+
rupifi?: AggregatorRoute;
|
|
2472
|
+
simpl?: AggregatorRoute;
|
|
2473
|
+
stripe?: AggregatorRoute;
|
|
2474
|
+
};
|
|
2475
|
+
/** @returns {PaymentGatewayConfig} */
|
|
2476
|
+
declare function PaymentGatewayConfig(): PaymentGatewayConfig;
|
|
2477
|
+
type PaymentGatewayConfig = {
|
|
2478
|
+
/**
|
|
2479
|
+
* - Config Type of the aggregator
|
|
2480
|
+
*/
|
|
2481
|
+
config_type: string;
|
|
2482
|
+
/**
|
|
2483
|
+
* - Enable or Disable Flag
|
|
1882
2484
|
*/
|
|
1883
2485
|
is_active?: boolean;
|
|
1884
2486
|
/**
|
|
@@ -1903,7 +2505,7 @@ type PaymentGatewayConfigRequest = {
|
|
|
1903
2505
|
*/
|
|
1904
2506
|
app_id: string;
|
|
1905
2507
|
/**
|
|
1906
|
-
* - Enable
|
|
2508
|
+
* - Enable or Disable Flag
|
|
1907
2509
|
*/
|
|
1908
2510
|
is_active?: boolean;
|
|
1909
2511
|
};
|
|
@@ -2076,6 +2678,35 @@ type PaymentInitializationResponse = {
|
|
|
2076
2678
|
*/
|
|
2077
2679
|
vpa?: string;
|
|
2078
2680
|
};
|
|
2681
|
+
/** @returns {PaymentMethodsMetaOrder} */
|
|
2682
|
+
declare function PaymentMethodsMetaOrder(): PaymentMethodsMetaOrder;
|
|
2683
|
+
type PaymentMethodsMetaOrder = {
|
|
2684
|
+
/**
|
|
2685
|
+
* - Merchant code
|
|
2686
|
+
*/
|
|
2687
|
+
merchant_code: string;
|
|
2688
|
+
/**
|
|
2689
|
+
* - Payment gateway name
|
|
2690
|
+
*/
|
|
2691
|
+
payment_gateway: string;
|
|
2692
|
+
/**
|
|
2693
|
+
* - Payment identifier
|
|
2694
|
+
*/
|
|
2695
|
+
payment_identifier: string;
|
|
2696
|
+
};
|
|
2697
|
+
/** @returns {PaymentModeCustomConfigSchema} */
|
|
2698
|
+
declare function PaymentModeCustomConfigSchema(): PaymentModeCustomConfigSchema;
|
|
2699
|
+
type PaymentModeCustomConfigSchema = {
|
|
2700
|
+
/**
|
|
2701
|
+
* - The business unit to which the store belongs.
|
|
2702
|
+
*/
|
|
2703
|
+
business_unit: string;
|
|
2704
|
+
custom_config: PaymentCustomConfigDetailsSchema;
|
|
2705
|
+
/**
|
|
2706
|
+
* - The display name of the store.
|
|
2707
|
+
*/
|
|
2708
|
+
display_name: string;
|
|
2709
|
+
};
|
|
2079
2710
|
/** @returns {PaymentModeList} */
|
|
2080
2711
|
declare function PaymentModeList(): PaymentModeList;
|
|
2081
2712
|
type PaymentModeList = {
|
|
@@ -2189,10 +2820,7 @@ type PaymentModeList = {
|
|
|
2189
2820
|
* - Intent_flow
|
|
2190
2821
|
*/
|
|
2191
2822
|
intent_flow?: boolean;
|
|
2192
|
-
|
|
2193
|
-
* - Logo
|
|
2194
|
-
*/
|
|
2195
|
-
logo_url?: any;
|
|
2823
|
+
logo_url?: PaymentModeLogo;
|
|
2196
2824
|
/**
|
|
2197
2825
|
* - Merchant code
|
|
2198
2826
|
*/
|
|
@@ -2205,10 +2833,7 @@ type PaymentModeList = {
|
|
|
2205
2833
|
* - Nickname
|
|
2206
2834
|
*/
|
|
2207
2835
|
nickname?: string;
|
|
2208
|
-
|
|
2209
|
-
* - Product cod configurations.
|
|
2210
|
-
*/
|
|
2211
|
-
product_cod_data?: any;
|
|
2836
|
+
product_cod_data?: ProductCODData;
|
|
2212
2837
|
/**
|
|
2213
2838
|
* - Remaining limit
|
|
2214
2839
|
*/
|
|
@@ -2234,6 +2859,23 @@ type PaymentModeLogo = {
|
|
|
2234
2859
|
*/
|
|
2235
2860
|
small: string;
|
|
2236
2861
|
};
|
|
2862
|
+
/** @returns {PaymentModeRouteResponse} */
|
|
2863
|
+
declare function PaymentModeRouteResponse(): PaymentModeRouteResponse;
|
|
2864
|
+
type PaymentModeRouteResponse = {
|
|
2865
|
+
/**
|
|
2866
|
+
* - Advance Payment Array
|
|
2867
|
+
*/
|
|
2868
|
+
advance_payment?: AdvancePaymentObject[];
|
|
2869
|
+
/**
|
|
2870
|
+
* - Payment Breakup for advance payment
|
|
2871
|
+
*/
|
|
2872
|
+
payment_breakup?: any;
|
|
2873
|
+
payment_options: PaymentOptionAndFlow;
|
|
2874
|
+
/**
|
|
2875
|
+
* - Response is successful or not
|
|
2876
|
+
*/
|
|
2877
|
+
success: boolean;
|
|
2878
|
+
};
|
|
2237
2879
|
/** @returns {PaymentObjectListSerializer} */
|
|
2238
2880
|
declare function PaymentObjectListSerializer(): PaymentObjectListSerializer;
|
|
2239
2881
|
type PaymentObjectListSerializer = {
|
|
@@ -2256,6 +2898,15 @@ type PaymentObjectListSerializer = {
|
|
|
2256
2898
|
refunded_by: string;
|
|
2257
2899
|
user_object: any;
|
|
2258
2900
|
};
|
|
2901
|
+
/** @returns {PaymentOptionAndFlow} */
|
|
2902
|
+
declare function PaymentOptionAndFlow(): PaymentOptionAndFlow;
|
|
2903
|
+
type PaymentOptionAndFlow = {
|
|
2904
|
+
payment_flows: PaymentFlow;
|
|
2905
|
+
/**
|
|
2906
|
+
* - Payment options
|
|
2907
|
+
*/
|
|
2908
|
+
payment_option: RootPaymentMode[];
|
|
2909
|
+
};
|
|
2259
2910
|
/** @returns {PaymentOptions} */
|
|
2260
2911
|
declare function PaymentOptions(): PaymentOptions;
|
|
2261
2912
|
type PaymentOptions = {
|
|
@@ -2268,14 +2919,122 @@ type PaymentOptions = {
|
|
|
2268
2919
|
declare function PaymentOptionsResponse(): PaymentOptionsResponse;
|
|
2269
2920
|
type PaymentOptionsResponse = {
|
|
2270
2921
|
/**
|
|
2271
|
-
* - Payment
|
|
2922
|
+
* - Payment Breakup for advance payment
|
|
2272
2923
|
*/
|
|
2924
|
+
payment_breakup?: any;
|
|
2273
2925
|
payment_options: PaymentOptions;
|
|
2274
2926
|
/**
|
|
2275
2927
|
* - Response is successful or not
|
|
2276
2928
|
*/
|
|
2277
2929
|
success: boolean;
|
|
2278
2930
|
};
|
|
2931
|
+
/** @returns {PaymentOrderData} */
|
|
2932
|
+
declare function PaymentOrderData(): PaymentOrderData;
|
|
2933
|
+
type PaymentOrderData = {
|
|
2934
|
+
/**
|
|
2935
|
+
* - Aggregator name
|
|
2936
|
+
*/
|
|
2937
|
+
aggregator?: string;
|
|
2938
|
+
/**
|
|
2939
|
+
* - Amount
|
|
2940
|
+
*/
|
|
2941
|
+
amount?: number;
|
|
2942
|
+
/**
|
|
2943
|
+
* - Callback url for aggregator
|
|
2944
|
+
*/
|
|
2945
|
+
callback_url?: string;
|
|
2946
|
+
/**
|
|
2947
|
+
* - Mobile number
|
|
2948
|
+
*/
|
|
2949
|
+
contact?: string;
|
|
2950
|
+
/**
|
|
2951
|
+
* - Currency
|
|
2952
|
+
*/
|
|
2953
|
+
currency?: string;
|
|
2954
|
+
/**
|
|
2955
|
+
* - Aggregator customer id
|
|
2956
|
+
*/
|
|
2957
|
+
customer_id?: string;
|
|
2958
|
+
/**
|
|
2959
|
+
* - Email
|
|
2960
|
+
*/
|
|
2961
|
+
email?: string;
|
|
2962
|
+
/**
|
|
2963
|
+
* - Merchant order id
|
|
2964
|
+
*/
|
|
2965
|
+
merchant_order_id?: string;
|
|
2966
|
+
/**
|
|
2967
|
+
* - Method
|
|
2968
|
+
*/
|
|
2969
|
+
method?: string;
|
|
2970
|
+
/**
|
|
2971
|
+
* - Aggregator order id
|
|
2972
|
+
*/
|
|
2973
|
+
order_id?: string;
|
|
2974
|
+
};
|
|
2975
|
+
/** @returns {PaymentOrderMethods} */
|
|
2976
|
+
declare function PaymentOrderMethods(): PaymentOrderMethods;
|
|
2977
|
+
type PaymentOrderMethods = {
|
|
2978
|
+
/**
|
|
2979
|
+
* - Amount to be collected
|
|
2980
|
+
*/
|
|
2981
|
+
amount: number;
|
|
2982
|
+
meta: PaymentMethodsMetaOrder;
|
|
2983
|
+
/**
|
|
2984
|
+
* - Payment mode
|
|
2985
|
+
*/
|
|
2986
|
+
mode: string;
|
|
2987
|
+
/**
|
|
2988
|
+
* - Payment mode name
|
|
2989
|
+
*/
|
|
2990
|
+
name: string;
|
|
2991
|
+
/**
|
|
2992
|
+
* - Payment type i.e. Required / Blocked
|
|
2993
|
+
*/
|
|
2994
|
+
payment?: string;
|
|
2995
|
+
};
|
|
2996
|
+
/** @returns {PaymentOrderRequest} */
|
|
2997
|
+
declare function PaymentOrderRequest(): PaymentOrderRequest;
|
|
2998
|
+
type PaymentOrderRequest = {
|
|
2999
|
+
/**
|
|
3000
|
+
* - Order id
|
|
3001
|
+
*/
|
|
3002
|
+
order_id: string;
|
|
3003
|
+
payment_methods?: PaymentOrderMethods[];
|
|
3004
|
+
/**
|
|
3005
|
+
* - Shipment_id
|
|
3006
|
+
*/
|
|
3007
|
+
shipment_id?: string;
|
|
3008
|
+
};
|
|
3009
|
+
/** @returns {PaymentOrderResponse} */
|
|
3010
|
+
declare function PaymentOrderResponse(): PaymentOrderResponse;
|
|
3011
|
+
type PaymentOrderResponse = {
|
|
3012
|
+
/**
|
|
3013
|
+
* - Callback url for aggregator
|
|
3014
|
+
*/
|
|
3015
|
+
callback_url?: string;
|
|
3016
|
+
data?: PaymentOrderData;
|
|
3017
|
+
/**
|
|
3018
|
+
* - Message
|
|
3019
|
+
*/
|
|
3020
|
+
message: string;
|
|
3021
|
+
/**
|
|
3022
|
+
* - Merchant order id
|
|
3023
|
+
*/
|
|
3024
|
+
order_id?: string;
|
|
3025
|
+
/**
|
|
3026
|
+
* - Payment confirm url for aggregator
|
|
3027
|
+
*/
|
|
3028
|
+
payment_confirm_url?: string;
|
|
3029
|
+
/**
|
|
3030
|
+
* - HTTP status code
|
|
3031
|
+
*/
|
|
3032
|
+
status_code: number;
|
|
3033
|
+
/**
|
|
3034
|
+
* - Successful or failure
|
|
3035
|
+
*/
|
|
3036
|
+
success: boolean;
|
|
3037
|
+
};
|
|
2279
3038
|
/** @returns {PaymentSessionDetail} */
|
|
2280
3039
|
declare function PaymentSessionDetail(): PaymentSessionDetail;
|
|
2281
3040
|
type PaymentSessionDetail = {
|
|
@@ -2333,7 +3092,7 @@ type PaymentSessionDetail = {
|
|
|
2333
3092
|
*/
|
|
2334
3093
|
gid: string;
|
|
2335
3094
|
/**
|
|
2336
|
-
* - Optional kind of purchase
|
|
3095
|
+
* - Optional kind of purchase or payment - one time
|
|
2337
3096
|
* payment (sale) or subcription. defaults to sale.
|
|
2338
3097
|
*/
|
|
2339
3098
|
kind?: string;
|
|
@@ -2345,6 +3104,10 @@ type PaymentSessionDetail = {
|
|
|
2345
3104
|
* - Merchant's locale
|
|
2346
3105
|
*/
|
|
2347
3106
|
merchant_locale?: string;
|
|
3107
|
+
/**
|
|
3108
|
+
* - Metadata
|
|
3109
|
+
*/
|
|
3110
|
+
meta?: any;
|
|
2348
3111
|
/**
|
|
2349
3112
|
* - Test or live, test mode uses test credentials so
|
|
2350
3113
|
* that actual payment is not created.
|
|
@@ -2433,6 +3196,37 @@ type PaymentSessionResponseSerializer = {
|
|
|
2433
3196
|
*/
|
|
2434
3197
|
total_amount: number;
|
|
2435
3198
|
};
|
|
3199
|
+
/** @returns {PaymentSessionSerializer} */
|
|
3200
|
+
declare function PaymentSessionSerializer(): PaymentSessionSerializer;
|
|
3201
|
+
type PaymentSessionSerializer = {
|
|
3202
|
+
cart_details?: CartDetailsSerializer;
|
|
3203
|
+
/**
|
|
3204
|
+
* - The currency of the payment.
|
|
3205
|
+
*/
|
|
3206
|
+
currency?: string;
|
|
3207
|
+
/**
|
|
3208
|
+
* - Global identifier of the entity (e.g. order, cart
|
|
3209
|
+
* etc.) against which payment_session was initiated. This is generated by
|
|
3210
|
+
* Fynd payments platform and is unique.
|
|
3211
|
+
*/
|
|
3212
|
+
gid: string;
|
|
3213
|
+
/**
|
|
3214
|
+
* - Object of payment details
|
|
3215
|
+
*/
|
|
3216
|
+
payment_details: any;
|
|
3217
|
+
/**
|
|
3218
|
+
* - Object of refund details
|
|
3219
|
+
*/
|
|
3220
|
+
refund_details: RefundDetailsSerializer[];
|
|
3221
|
+
/**
|
|
3222
|
+
* - The status of the payment session.
|
|
3223
|
+
*/
|
|
3224
|
+
status: string;
|
|
3225
|
+
/**
|
|
3226
|
+
* - Total amount to be paid
|
|
3227
|
+
*/
|
|
3228
|
+
total_amount: number;
|
|
3229
|
+
};
|
|
2436
3230
|
/** @returns {PaymentStatusBulkHandlerRequest} */
|
|
2437
3231
|
declare function PaymentStatusBulkHandlerRequest(): PaymentStatusBulkHandlerRequest;
|
|
2438
3232
|
type PaymentStatusBulkHandlerRequest = {
|
|
@@ -2539,9 +3333,6 @@ type PaymentStatusUpdateResponse = {
|
|
|
2539
3333
|
/** @returns {Payout} */
|
|
2540
3334
|
declare function Payout(): Payout;
|
|
2541
3335
|
type Payout = {
|
|
2542
|
-
/**
|
|
2543
|
-
* - Customers details object
|
|
2544
|
-
*/
|
|
2545
3336
|
customers: PayoutCustomer;
|
|
2546
3337
|
/**
|
|
2547
3338
|
* - Enable/DIsable Flag Payout
|
|
@@ -2551,9 +3342,6 @@ type Payout = {
|
|
|
2551
3342
|
* - Default or not
|
|
2552
3343
|
*/
|
|
2553
3344
|
is_default: boolean;
|
|
2554
|
-
/**
|
|
2555
|
-
* - Bank details object
|
|
2556
|
-
*/
|
|
2557
3345
|
more_attributes: PayoutMoreAttributes;
|
|
2558
3346
|
payouts_aggregators?: PayoutAggregator[];
|
|
2559
3347
|
/**
|
|
@@ -2631,7 +3419,7 @@ type PayoutMoreAttributes = {
|
|
|
2631
3419
|
*/
|
|
2632
3420
|
account_no?: string;
|
|
2633
3421
|
/**
|
|
2634
|
-
* - Account Type Saving
|
|
3422
|
+
* - Account Type Saving or Current
|
|
2635
3423
|
*/
|
|
2636
3424
|
account_type?: string;
|
|
2637
3425
|
/**
|
|
@@ -2666,12 +3454,9 @@ type PayoutRequest = {
|
|
|
2666
3454
|
* - Aggregator Name
|
|
2667
3455
|
*/
|
|
2668
3456
|
aggregator: string;
|
|
2669
|
-
/**
|
|
2670
|
-
* - Payout bank details object
|
|
2671
|
-
*/
|
|
2672
3457
|
bank_details: PayoutBankDetails;
|
|
2673
3458
|
/**
|
|
2674
|
-
* - Enable
|
|
3459
|
+
* - Enable or Disable Flag Payout
|
|
2675
3460
|
*/
|
|
2676
3461
|
is_active: boolean;
|
|
2677
3462
|
/**
|
|
@@ -2703,7 +3488,7 @@ type PayoutResponse = {
|
|
|
2703
3488
|
*/
|
|
2704
3489
|
created: boolean;
|
|
2705
3490
|
/**
|
|
2706
|
-
* - Enable
|
|
3491
|
+
* - Enable or DIsable Flag Payout
|
|
2707
3492
|
*/
|
|
2708
3493
|
is_active: boolean;
|
|
2709
3494
|
/**
|
|
@@ -2743,6 +3528,28 @@ type PayoutsResponse = {
|
|
|
2743
3528
|
*/
|
|
2744
3529
|
success: boolean;
|
|
2745
3530
|
};
|
|
3531
|
+
/** @returns {PlatformPaymentModeCopyConfigRequest} */
|
|
3532
|
+
declare function PlatformPaymentModeCopyConfigRequest(): PlatformPaymentModeCopyConfigRequest;
|
|
3533
|
+
type PlatformPaymentModeCopyConfigRequest = {
|
|
3534
|
+
from_config: FromConfig;
|
|
3535
|
+
to_config: ToConfig;
|
|
3536
|
+
};
|
|
3537
|
+
/** @returns {PlatformPaymentModeResponse} */
|
|
3538
|
+
declare function PlatformPaymentModeResponse(): PlatformPaymentModeResponse;
|
|
3539
|
+
type PlatformPaymentModeResponse = {
|
|
3540
|
+
/**
|
|
3541
|
+
* - List of all aggregator and payment mode details.
|
|
3542
|
+
*/
|
|
3543
|
+
items?: any[];
|
|
3544
|
+
/**
|
|
3545
|
+
* - Message
|
|
3546
|
+
*/
|
|
3547
|
+
message?: string;
|
|
3548
|
+
/**
|
|
3549
|
+
* - Response is successful or not.
|
|
3550
|
+
*/
|
|
3551
|
+
success: boolean;
|
|
3552
|
+
};
|
|
2746
3553
|
/** @returns {PollingPaymentLinkResponse} */
|
|
2747
3554
|
declare function PollingPaymentLinkResponse(): PollingPaymentLinkResponse;
|
|
2748
3555
|
type PollingPaymentLinkResponse = {
|
|
@@ -2790,10 +3597,7 @@ type PollingPaymentLinkResponse = {
|
|
|
2790
3597
|
/** @returns {ProductCODData} */
|
|
2791
3598
|
declare function ProductCODData(): ProductCODData;
|
|
2792
3599
|
type ProductCODData = {
|
|
2793
|
-
|
|
2794
|
-
* - Cod charges and its allowed limits.
|
|
2795
|
-
*/
|
|
2796
|
-
cod_charges?: any;
|
|
3600
|
+
cod_charges?: CODChargesLimitsResponse;
|
|
2797
3601
|
/**
|
|
2798
3602
|
* - Item id with its cod availability.
|
|
2799
3603
|
*/
|
|
@@ -2816,6 +3620,34 @@ type RefundAccountResponse = {
|
|
|
2816
3620
|
*/
|
|
2817
3621
|
success: boolean;
|
|
2818
3622
|
};
|
|
3623
|
+
/** @returns {RefundDetailsSerializer} */
|
|
3624
|
+
declare function RefundDetailsSerializer(): RefundDetailsSerializer;
|
|
3625
|
+
type RefundDetailsSerializer = {
|
|
3626
|
+
/**
|
|
3627
|
+
* - Refunded amount
|
|
3628
|
+
*/
|
|
3629
|
+
amount: number;
|
|
3630
|
+
/**
|
|
3631
|
+
* - Timestamp in epoch.
|
|
3632
|
+
*/
|
|
3633
|
+
created: string;
|
|
3634
|
+
/**
|
|
3635
|
+
* - The currency of the payment.
|
|
3636
|
+
*/
|
|
3637
|
+
currency: string;
|
|
3638
|
+
/**
|
|
3639
|
+
* - Unique refund utr generated by payment gateway.
|
|
3640
|
+
*/
|
|
3641
|
+
refund_utr: string;
|
|
3642
|
+
/**
|
|
3643
|
+
* - Refund request id, unique id generated by Fynd platform
|
|
3644
|
+
*/
|
|
3645
|
+
request_id: string;
|
|
3646
|
+
/**
|
|
3647
|
+
* - The status of the refund.
|
|
3648
|
+
*/
|
|
3649
|
+
status: string;
|
|
3650
|
+
};
|
|
2819
3651
|
/** @returns {RefundPriorityRequestSerializer} */
|
|
2820
3652
|
declare function RefundPriorityRequestSerializer(): RefundPriorityRequestSerializer;
|
|
2821
3653
|
type RefundPriorityRequestSerializer = {
|
|
@@ -2913,12 +3745,17 @@ type RefundSessionRequestSerializer = {
|
|
|
2913
3745
|
* - The currency of the payment.
|
|
2914
3746
|
*/
|
|
2915
3747
|
currency: string;
|
|
3748
|
+
error?: ErrorDescription;
|
|
2916
3749
|
/**
|
|
2917
3750
|
* - Global identifier of the entity (e.g. order, cart
|
|
2918
3751
|
* etc.) against which payment_session was initiated. This is generated by
|
|
2919
3752
|
* Fynd payments platform and is unique.
|
|
2920
3753
|
*/
|
|
2921
3754
|
gid: string;
|
|
3755
|
+
/**
|
|
3756
|
+
* - The status of the refund.
|
|
3757
|
+
*/
|
|
3758
|
+
message?: string;
|
|
2922
3759
|
/**
|
|
2923
3760
|
* - Meta
|
|
2924
3761
|
*/
|
|
@@ -3075,9 +3912,6 @@ type ResendOrCancelPaymentRequest = {
|
|
|
3075
3912
|
/** @returns {ResendOrCancelPaymentResponse} */
|
|
3076
3913
|
declare function ResendOrCancelPaymentResponse(): ResendOrCancelPaymentResponse;
|
|
3077
3914
|
type ResendOrCancelPaymentResponse = {
|
|
3078
|
-
/**
|
|
3079
|
-
* - Data about link action status.
|
|
3080
|
-
*/
|
|
3081
3915
|
data: LinkStatus;
|
|
3082
3916
|
/**
|
|
3083
3917
|
* - Response is successful or not.
|
|
@@ -3205,6 +4039,22 @@ type SetCODOptionResponse = {
|
|
|
3205
4039
|
*/
|
|
3206
4040
|
success: boolean;
|
|
3207
4041
|
};
|
|
4042
|
+
/** @returns {SplitObject} */
|
|
4043
|
+
declare function SplitObject(): SplitObject;
|
|
4044
|
+
type SplitObject = {
|
|
4045
|
+
/**
|
|
4046
|
+
* - Amount pending to be paid
|
|
4047
|
+
*/
|
|
4048
|
+
amount_remaining?: number;
|
|
4049
|
+
/**
|
|
4050
|
+
* - Number of splits remaining
|
|
4051
|
+
*/
|
|
4052
|
+
splits_remaining?: number;
|
|
4053
|
+
/**
|
|
4054
|
+
* - Maximum amount of splits allowed
|
|
4055
|
+
*/
|
|
4056
|
+
total_number_of_splits?: number;
|
|
4057
|
+
};
|
|
3208
4058
|
/** @returns {StatisticsData} */
|
|
3209
4059
|
declare function StatisticsData(): StatisticsData;
|
|
3210
4060
|
type StatisticsData = {
|
|
@@ -3245,15 +4095,27 @@ type SubscriptionPaymentMethodResponse = {
|
|
|
3245
4095
|
*/
|
|
3246
4096
|
success: boolean;
|
|
3247
4097
|
};
|
|
4098
|
+
/** @returns {ToConfig} */
|
|
4099
|
+
declare function ToConfig(): ToConfig;
|
|
4100
|
+
type ToConfig = {
|
|
4101
|
+
/**
|
|
4102
|
+
* - Business unit name
|
|
4103
|
+
*/
|
|
4104
|
+
business_unit: string;
|
|
4105
|
+
/**
|
|
4106
|
+
* - Device name to copy the config to
|
|
4107
|
+
*/
|
|
4108
|
+
device: any[];
|
|
4109
|
+
};
|
|
3248
4110
|
/** @returns {UpdatePayoutRequest} */
|
|
3249
4111
|
declare function UpdatePayoutRequest(): UpdatePayoutRequest;
|
|
3250
4112
|
type UpdatePayoutRequest = {
|
|
3251
4113
|
/**
|
|
3252
|
-
* - Enable
|
|
4114
|
+
* - Enable or Disable Flag Payout
|
|
3253
4115
|
*/
|
|
3254
4116
|
is_active: boolean;
|
|
3255
4117
|
/**
|
|
3256
|
-
* - Enable
|
|
4118
|
+
* - Enable or Disable Default Payout
|
|
3257
4119
|
*/
|
|
3258
4120
|
is_default: boolean;
|
|
3259
4121
|
/**
|
|
@@ -3265,11 +4127,11 @@ type UpdatePayoutRequest = {
|
|
|
3265
4127
|
declare function UpdatePayoutResponse(): UpdatePayoutResponse;
|
|
3266
4128
|
type UpdatePayoutResponse = {
|
|
3267
4129
|
/**
|
|
3268
|
-
* - Enable
|
|
4130
|
+
* - Enable or DIsable Flag Payout
|
|
3269
4131
|
*/
|
|
3270
4132
|
is_active: boolean;
|
|
3271
4133
|
/**
|
|
3272
|
-
* - Enable
|
|
4134
|
+
* - Enable or Disable Default Payout
|
|
3273
4135
|
*/
|
|
3274
4136
|
is_default: boolean;
|
|
3275
4137
|
/**
|