@gofynd/fdk-client-javascript 1.4.13 → 1.4.15-beta.1

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.
@@ -1,13 +1,13 @@
1
1
  export = PaymentPlatformModel;
2
2
  /**
3
3
  * @typedef PaymentGatewayConfigResponse
4
- * @property {Object[]} [aggregators] - List of all speceific Payment options
5
- * with their Details.
4
+ * @property {Object[]} [aggregators] - List of all config specific to the
5
+ * aggregator with their Details.
6
6
  * @property {string} app_id - Application Id to which Payment config Mapped
7
- * @property {string[]} excluded_fields - List of all excluded options with their Details.
7
+ * @property {string[]} excluded_fields - List of all excluded config with their Details.
8
8
  * @property {boolean} success - Response is successful or not
9
9
  * @property {boolean} created - Response is created or not
10
- * @property {string[]} display_fields - List of all included options with their Details.
10
+ * @property {string[]} display_fields - List of all display related configs, i.e. logo
11
11
  */
12
12
  /**
13
13
  * @typedef ErrorCodeDescription
@@ -21,7 +21,8 @@ export = PaymentPlatformModel;
21
21
  * @property {string} config_type - Config Type of the aggregator
22
22
  * @property {boolean} [is_active] - Enable or Disable Flag
23
23
  * @property {string} key - Api key of the payment aggregator
24
- * @property {string} merchant_salt - Merchant key of the payment aggregator
24
+ * @property {string} merchant_salt - The secret key or token provided by the
25
+ * payment aggregator for the merchant.
25
26
  */
26
27
  /**
27
28
  * @typedef PaymentGatewayConfigRequest
@@ -162,7 +163,7 @@ export = PaymentPlatformModel;
162
163
  /**
163
164
  * @typedef PaymentOptionAndFlow
164
165
  * @property {RootPaymentMode[]} payment_option - Payment options
165
- * @property {PaymentFlow} payment_flows
166
+ * @property {PaymentFlow} [payment_flows]
166
167
  * @property {PaymentDefaultSelection} [payment_default_selection]
167
168
  */
168
169
  /**
@@ -327,9 +328,9 @@ export = PaymentPlatformModel;
327
328
  */
328
329
  /**
329
330
  * @typedef RefundAccountResponse
330
- * @property {boolean} [is_verified_flag]
331
- * @property {string} message - Response message
332
- * @property {Object} [data] - Refund account data.
331
+ * @property {boolean} [is_verified_flag] - Account is verified or not
332
+ * @property {string} [message] - Response message
333
+ * @property {Object} data - Refund account data.
333
334
  * @property {boolean} success - Success or failure flag.
334
335
  */
335
336
  /**
@@ -340,15 +341,15 @@ export = PaymentPlatformModel;
340
341
  */
341
342
  /**
342
343
  * @typedef BankDetailsForOTP
343
- * @property {string} ifsc_code
344
- * @property {string} account_no
345
- * @property {string} branch_name
346
- * @property {string} bank_name
347
- * @property {string} account_holder
344
+ * @property {string} ifsc_code - IFSC code of account
345
+ * @property {string} account_no - Account number
346
+ * @property {string} branch_name - Branch name of account
347
+ * @property {string} bank_name - Bank name of account
348
+ * @property {string} account_holder - Accountg holder name of account
348
349
  */
349
350
  /**
350
351
  * @typedef AddBeneficiaryDetailsOTPRequest
351
- * @property {string} order_id
352
+ * @property {string} order_id - Order_id for which account will be added
352
353
  * @property {BankDetailsForOTP} details
353
354
  */
354
355
  /**
@@ -369,11 +370,11 @@ export = PaymentPlatformModel;
369
370
  * @property {string} display_name - Display Name Of Account
370
371
  * @property {string} [delights_user_name] - User Id Who filled the Beneficiary
371
372
  * @property {string} transfer_mode - Transfer Mode Of Account
372
- * @property {string} email - EMail of User
373
+ * @property {string} email - Email of User
373
374
  * @property {boolean} is_active - Boolean Flag whether Beneficiary set or not
374
375
  * @property {string} [branch_name] - Branch Name Of Account
375
376
  * @property {string} address - Address of User
376
- * @property {string} modified_on - MOdification Date of Beneficiary
377
+ * @property {string} modified_on - Modification Date of Beneficiary
377
378
  * @property {string} beneficiary_id - Benenficiary Id
378
379
  * @property {string} account_no - Account Number
379
380
  * @property {string} bank_name - Bank Name Of Account
@@ -386,7 +387,7 @@ export = PaymentPlatformModel;
386
387
  */
387
388
  /**
388
389
  * @typedef MultiTenderPaymentMeta
389
- * @property {Object} [extra_meta]
390
+ * @property {Object} [extra_meta] - Key value pair for extra data related to payment mode
390
391
  * @property {string} [order_id] - Fynd Platform order ID
391
392
  * @property {string} [payment_id] - A unique identifier associated with a
392
393
  * specific payment transaction
@@ -403,7 +404,7 @@ export = PaymentPlatformModel;
403
404
  * @property {string} [name] - Payment mode name
404
405
  * @property {MultiTenderPaymentMeta} [meta]
405
406
  * @property {number} amount - Payment amount
406
- * @property {string} mode
407
+ * @property {string} mode - Payment mode short code
407
408
  */
408
409
  /**
409
410
  * @typedef PaymentConfirmationRequest
@@ -424,10 +425,31 @@ export = PaymentPlatformModel;
424
425
  * @property {number} limit - Total Limit of user
425
426
  * @property {number} usages - Used COD limit from the user Limit
426
427
  */
428
+ /**
429
+ * @typedef CODLimitConfig
430
+ * @property {number} storefront - Limit for storefront
431
+ * @property {number} pos - Limit for pos
432
+ */
433
+ /**
434
+ * @typedef CODPaymentLimitConfig
435
+ * @property {boolean} is_active - Boolean flag to show the status
436
+ * @property {number} usages - Used cod limit
437
+ * @property {number} user_id - User_id
438
+ * @property {string} merchant_user_id - Merchant_user_id
439
+ * @property {number} remaining_limit - Remaining COD limit
440
+ * @property {CODLimitConfig} limit
441
+ */
442
+ /**
443
+ * @typedef GetUserBULimitResponse
444
+ * @property {string} business_unit - COD limit business unit
445
+ * @property {string} display_name - Display name for cod limit
446
+ * @property {CODPaymentLimitConfig} config
447
+ */
427
448
  /**
428
449
  * @typedef GetUserCODLimitResponse
429
- * @property {CODdata} user_cod_data
450
+ * @property {GetUserBULimitResponse[]} items
430
451
  * @property {boolean} success - Response is successful or not
452
+ * @property {string} [message] - Message for cod limit
431
453
  */
432
454
  /**
433
455
  * @typedef SetCODForUserRequest
@@ -719,7 +741,8 @@ export = PaymentPlatformModel;
719
741
  * @property {string} [payment_link_url] - Url of payment link
720
742
  * @property {string} [payment_link_current_status] - Status of payment link
721
743
  * @property {string} [external_order_id] - Merchant order id
722
- * @property {number} [polling_timeout] - Polling request timeout
744
+ * @property {number} [polling_timeout] - Polling request timeout, perform
745
+ * polling till timeout elapsed or payment status is success/failure
723
746
  * @property {boolean} success - Successful or failure
724
747
  */
725
748
  /**
@@ -742,10 +765,11 @@ export = PaymentPlatformModel;
742
765
  */
743
766
  /**
744
767
  * @typedef CreatePaymentLinkMeta
745
- * @property {string} cart_id
746
- * @property {string} checkout_mode
747
- * @property {string} amount
748
- * @property {string} [assign_card_id]
768
+ * @property {string} cart_id - Cart id for which payment link needs to be generated.
769
+ * @property {string} checkout_mode - Checkout mode for the payment link i.e. self
770
+ * @property {string} amount - Payment link amount to be paid by the customer
771
+ * @property {string} [assign_card_id] - Assigned card id against which payment
772
+ * to be done via payment link
749
773
  */
750
774
  /**
751
775
  * @typedef CreatePaymentLinkRequest
@@ -876,7 +900,8 @@ export = PaymentPlatformModel;
876
900
  * @property {AddressDetail} [shipping_address] - Shipping address
877
901
  * @property {number} amount_captured - Amount which is captured or credited to
878
902
  * merchant account
879
- * @property {number} [amount_refunded]
903
+ * @property {number} [amount_refunded] - Amount refunded or credited back to
904
+ * customer accout
880
905
  * @property {string} [aggregator_customer_id] - Unique customer id generated by
881
906
  * payment gateway, not required for standard checkout.
882
907
  * @property {string} cancel_url - Cancel url sent by Fynd platform at the time
@@ -898,12 +923,12 @@ export = PaymentPlatformModel;
898
923
  * @property {AddressDetail} [billing_address] - Billing address
899
924
  * @property {boolean} [captured] - Whether the payment is captured (credited to
900
925
  * merchant account) by payment gateway.
901
- * @property {Object} [meta] - Metadata
902
- * @property {string} status - Stautus of the payment
926
+ * @property {Object} [meta] - Extra meta data specific to extension
927
+ * @property {string} status - Status of the payment
903
928
  */
904
929
  /**
905
930
  * @typedef PaymentSessionRequestSerializer
906
- * @property {Object} [meta] - Meta
931
+ * @property {Object} [meta] - Extra meta data specific to extensions
907
932
  * @property {string} gid - Global identifier of the entity (e.g. order, cart
908
933
  * etc.) against which payment_session was initiated. This is generated by
909
934
  * Fynd payments platform and is unique.
@@ -914,6 +939,7 @@ export = PaymentPlatformModel;
914
939
  * the schema `PaymentSessionDetail`.
915
940
  * @property {number} total_amount - Amount paid.
916
941
  * @property {string} checksum - Checksum to verify the payload
942
+ * @property {string} [source] - Source of payment update session
917
943
  */
918
944
  /**
919
945
  * @typedef PaymentSessionResponseSerializer
@@ -971,33 +997,34 @@ export = PaymentPlatformModel;
971
997
  */
972
998
  /**
973
999
  * @typedef PaymentDetailsSerializer
974
- * @property {Object[]} payment_methods - Method of payment
1000
+ * @property {Object[]} payment_methods - List of payment methods
975
1001
  * @property {string} gid - Global identifier of the entity (e.g. order, cart
976
1002
  * etc.) against which payment_session was initiated. This is generated by
977
1003
  * Fynd payments platform and is unique.
978
- * @property {number} [amount_refunded]
1004
+ * @property {number} [amount_refunded] - Already refunded amount for the given
1005
+ * gid (global identifier for the order).
979
1006
  * @property {string} currency - Currency of the payment.
980
1007
  * @property {string} mode - Test or live, test mode uses test credentials so
981
1008
  * that actual payment is not created.
982
- * @property {string} [merchant_locale] - Merchant's locale
983
- * @property {Object} [meta] - Metadata
1009
+ * @property {string} [merchant_locale] - Merchant's locale (language) i.e. en
1010
+ * @property {Object} [meta] - Extra meta data related to the payment methods
984
1011
  * @property {string} [kind] - Optional kind of purchase/payment - one time
985
1012
  * payment (sale) or subcription. defaults to sale.
986
1013
  * @property {string} [success_url] - Success url sent by Fynd platform at the
987
1014
  * time of payment creation
988
- * @property {string} status - Stautus of the payment
1015
+ * @property {string} status - Status of the payment
989
1016
  * @property {boolean} [captured] - Whether the payment is captured (credited to
990
1017
  * merchant account) by payment gateway.
991
1018
  * @property {string} [payment_id] - Unique transaction id generated by payment gateway
992
1019
  * @property {string} g_user_id - Global user identifier - unique user id
993
1020
  * generated by Fynd platform
994
- * @property {string} [locale] - User's locale
1021
+ * @property {string} [locale] - User's locale (language), i.e. en
995
1022
  * @property {string} [cancel_url] - Cancel url sent by Fynd platform at the
996
- * time of payment creation
1023
+ * time of payment creation, redirect on payment cancellation
997
1024
  * @property {string} [created] - Timestamp in epoch
998
1025
  * @property {number} amount_captured - Amount which is captured or credited to
999
1026
  * merchant account
1000
- * @property {number} amount - Amount paid.
1027
+ * @property {number} amount - Amount paid for the order.
1001
1028
  * @property {string} [aggregator_customer_id] - Unique customer id generated by
1002
1029
  * payment gateway, not required for standard checkout.
1003
1030
  * @property {string} [aggregator_order_id] - Unique order id or payment request
@@ -1190,14 +1217,14 @@ export = PaymentPlatformModel;
1190
1217
  declare class PaymentPlatformModel {
1191
1218
  }
1192
1219
  declare namespace PaymentPlatformModel {
1193
- export { PaymentGatewayConfigResponse, ErrorCodeDescription, PaymentGatewayConfig, PaymentGatewayConfigRequest, PaymentGatewayToBeReviewed, ErrorCodeAndDescription, HttpErrorCodeAndResponse, IntentAppErrorList, ProductCODData, CODChargesLimitsResponse, PaymentModeLogo, IntentApp, PaymentModeList, RootPaymentMode, PaymentOptions, AggregatorRoute, PaymentDefaultSelection, PaymentFlow, PaymentOptionAndFlow, AdvanceObject, SplitObject, AdvancePaymentObject, PaymentModeRouteResponse, PaymentOptionsResponse, PayoutCustomer, PayoutMoreAttributes, PayoutAggregator, Payout, PayoutsResponse, PayoutBankDetails, PayoutRequest, PayoutResponse, UpdatePayoutResponse, UpdatePayoutRequest, DeletePayoutResponse, SubscriptionPaymentMethodResponse, DeleteSubscriptionPaymentMethodResponse, SubscriptionConfigResponse, SaveSubscriptionSetupIntentRequest, SaveSubscriptionSetupIntentResponse, RefundAccountResponse, NotFoundResourceError, BankDetailsForOTP, AddBeneficiaryDetailsOTPRequest, IfscCodeResponse, OrderBeneficiaryDetails, OrderBeneficiaryResponse, MultiTenderPaymentMeta, MultiTenderPaymentMethod, PaymentConfirmationRequest, PaymentConfirmationResponse, CODdata, GetUserCODLimitResponse, SetCODForUserRequest, SetCODOptionResponse, EdcModelData, EdcAggregatorAndModelListResponse, StatisticsData, EdcDeviceStatsResponse, EdcAddRequest, EdcDevice, EdcDeviceAddResponse, EdcDeviceDetailsResponse, EdcUpdateRequest, EdcDeviceUpdateResponse, Page, EdcDeviceListResponse, PaymentInitializationRequest, PaymentInitializationResponse, PaymentStatusUpdateRequest, PaymentStatusUpdateResponse, ResendOrCancelPaymentRequest, LinkStatus, ResendOrCancelPaymentResponse, PaymentStatusBulkHandlerRequest, PaymentObjectListSerializer, PaymentStatusObject, PaymentStatusBulkHandlerResponse, GetOauthUrlResponse, RevokeOAuthToken, RepaymentRequestDetails, RepaymentDetailsSerialiserPayAll, RepaymentResponse, MerchantOnBoardingRequest, MerchantOnBoardingResponse, ValidateCustomerRequest, ValidateCustomerResponse, GetPaymentLinkResponse, ErrorDescription, ErrorResponse, CreatePaymentLinkMeta, CreatePaymentLinkRequest, CreatePaymentLinkResponse, PollingPaymentLinkResponse, CancelOrResendPaymentLinkRequest, ResendPaymentLinkResponse, CancelPaymentLinkResponse, Code, PaymentCode, GetPaymentCode, GetPaymentCodeResponse, PlatformPaymentModeResponse, MerchnatPaymentModeRequest, OrderDetail, AddressDetail, PaymentSessionDetail, PaymentSessionRequestSerializer, PaymentSessionResponseSerializer, RefundSessionDetail, RefundSessionRequestSerializer, RefundSessionResponseSerializer, PaymentDetailsSerializer, CartDetailsSerializer, RefundDetailsSerializer, PaymentSessionSerializer, RefundSourcesPriority, RefundPriorityResponseSerializer, RefundPriorityRequestSerializer, MerchantPaymentModeRequest, FromConfig, ToConfig, PlatformPaymentModeCopyConfigRequest, PaymentMethodsMetaOrder, PaymentOrderMethods, PaymentOrderRequest, PaymentOrderData, PaymentOrderResponse, AggregatorVersionItemSchema, AggregatorVersionResponse, AggregatorVersionRequestSchema, AggregatorControlRequest, PaymentModeCustomConfigSchema, PaymentCustomConfigDetailsSchema, PaymentCustomConfigCustomerSchema, PaymentCustomConfigModeSchema, PaymentCustomConfigDetailsRequestSchema, PaymentCustomConfigCustomerRequestSchema, PaymentCustomConfigRequestSchema, PaymentCustomConfigResponseSchema };
1220
+ export { PaymentGatewayConfigResponse, ErrorCodeDescription, PaymentGatewayConfig, PaymentGatewayConfigRequest, PaymentGatewayToBeReviewed, ErrorCodeAndDescription, HttpErrorCodeAndResponse, IntentAppErrorList, ProductCODData, CODChargesLimitsResponse, PaymentModeLogo, IntentApp, PaymentModeList, RootPaymentMode, PaymentOptions, AggregatorRoute, PaymentDefaultSelection, PaymentFlow, PaymentOptionAndFlow, AdvanceObject, SplitObject, AdvancePaymentObject, PaymentModeRouteResponse, PaymentOptionsResponse, PayoutCustomer, PayoutMoreAttributes, PayoutAggregator, Payout, PayoutsResponse, PayoutBankDetails, PayoutRequest, PayoutResponse, UpdatePayoutResponse, UpdatePayoutRequest, DeletePayoutResponse, SubscriptionPaymentMethodResponse, DeleteSubscriptionPaymentMethodResponse, SubscriptionConfigResponse, SaveSubscriptionSetupIntentRequest, SaveSubscriptionSetupIntentResponse, RefundAccountResponse, NotFoundResourceError, BankDetailsForOTP, AddBeneficiaryDetailsOTPRequest, IfscCodeResponse, OrderBeneficiaryDetails, OrderBeneficiaryResponse, MultiTenderPaymentMeta, MultiTenderPaymentMethod, PaymentConfirmationRequest, PaymentConfirmationResponse, CODdata, CODLimitConfig, CODPaymentLimitConfig, GetUserBULimitResponse, GetUserCODLimitResponse, SetCODForUserRequest, SetCODOptionResponse, EdcModelData, EdcAggregatorAndModelListResponse, StatisticsData, EdcDeviceStatsResponse, EdcAddRequest, EdcDevice, EdcDeviceAddResponse, EdcDeviceDetailsResponse, EdcUpdateRequest, EdcDeviceUpdateResponse, Page, EdcDeviceListResponse, PaymentInitializationRequest, PaymentInitializationResponse, PaymentStatusUpdateRequest, PaymentStatusUpdateResponse, ResendOrCancelPaymentRequest, LinkStatus, ResendOrCancelPaymentResponse, PaymentStatusBulkHandlerRequest, PaymentObjectListSerializer, PaymentStatusObject, PaymentStatusBulkHandlerResponse, GetOauthUrlResponse, RevokeOAuthToken, RepaymentRequestDetails, RepaymentDetailsSerialiserPayAll, RepaymentResponse, MerchantOnBoardingRequest, MerchantOnBoardingResponse, ValidateCustomerRequest, ValidateCustomerResponse, GetPaymentLinkResponse, ErrorDescription, ErrorResponse, CreatePaymentLinkMeta, CreatePaymentLinkRequest, CreatePaymentLinkResponse, PollingPaymentLinkResponse, CancelOrResendPaymentLinkRequest, ResendPaymentLinkResponse, CancelPaymentLinkResponse, Code, PaymentCode, GetPaymentCode, GetPaymentCodeResponse, PlatformPaymentModeResponse, MerchnatPaymentModeRequest, OrderDetail, AddressDetail, PaymentSessionDetail, PaymentSessionRequestSerializer, PaymentSessionResponseSerializer, RefundSessionDetail, RefundSessionRequestSerializer, RefundSessionResponseSerializer, PaymentDetailsSerializer, CartDetailsSerializer, RefundDetailsSerializer, PaymentSessionSerializer, RefundSourcesPriority, RefundPriorityResponseSerializer, RefundPriorityRequestSerializer, MerchantPaymentModeRequest, FromConfig, ToConfig, PlatformPaymentModeCopyConfigRequest, PaymentMethodsMetaOrder, PaymentOrderMethods, PaymentOrderRequest, PaymentOrderData, PaymentOrderResponse, AggregatorVersionItemSchema, AggregatorVersionResponse, AggregatorVersionRequestSchema, AggregatorControlRequest, PaymentModeCustomConfigSchema, PaymentCustomConfigDetailsSchema, PaymentCustomConfigCustomerSchema, PaymentCustomConfigModeSchema, PaymentCustomConfigDetailsRequestSchema, PaymentCustomConfigCustomerRequestSchema, PaymentCustomConfigRequestSchema, PaymentCustomConfigResponseSchema };
1194
1221
  }
1195
1222
  /** @returns {PaymentGatewayConfigResponse} */
1196
1223
  declare function PaymentGatewayConfigResponse(): PaymentGatewayConfigResponse;
1197
1224
  type PaymentGatewayConfigResponse = {
1198
1225
  /**
1199
- * - List of all speceific Payment options
1200
- * with their Details.
1226
+ * - List of all config specific to the
1227
+ * aggregator with their Details.
1201
1228
  */
1202
1229
  aggregators?: any[];
1203
1230
  /**
@@ -1205,7 +1232,7 @@ type PaymentGatewayConfigResponse = {
1205
1232
  */
1206
1233
  app_id: string;
1207
1234
  /**
1208
- * - List of all excluded options with their Details.
1235
+ * - List of all excluded config with their Details.
1209
1236
  */
1210
1237
  excluded_fields: string[];
1211
1238
  /**
@@ -1217,7 +1244,7 @@ type PaymentGatewayConfigResponse = {
1217
1244
  */
1218
1245
  created: boolean;
1219
1246
  /**
1220
- * - List of all included options with their Details.
1247
+ * - List of all display related configs, i.e. logo
1221
1248
  */
1222
1249
  display_fields: string[];
1223
1250
  };
@@ -1257,7 +1284,8 @@ type PaymentGatewayConfig = {
1257
1284
  */
1258
1285
  key: string;
1259
1286
  /**
1260
- * - Merchant key of the payment aggregator
1287
+ * - The secret key or token provided by the
1288
+ * payment aggregator for the merchant.
1261
1289
  */
1262
1290
  merchant_salt: string;
1263
1291
  };
@@ -1623,7 +1651,7 @@ type PaymentOptionAndFlow = {
1623
1651
  * - Payment options
1624
1652
  */
1625
1653
  payment_option: RootPaymentMode[];
1626
- payment_flows: PaymentFlow;
1654
+ payment_flows?: PaymentFlow;
1627
1655
  payment_default_selection?: PaymentDefaultSelection;
1628
1656
  };
1629
1657
  /** @returns {AdvanceObject} */
@@ -2044,15 +2072,18 @@ type SaveSubscriptionSetupIntentResponse = {
2044
2072
  /** @returns {RefundAccountResponse} */
2045
2073
  declare function RefundAccountResponse(): RefundAccountResponse;
2046
2074
  type RefundAccountResponse = {
2075
+ /**
2076
+ * - Account is verified or not
2077
+ */
2047
2078
  is_verified_flag?: boolean;
2048
2079
  /**
2049
2080
  * - Response message
2050
2081
  */
2051
- message: string;
2082
+ message?: string;
2052
2083
  /**
2053
2084
  * - Refund account data.
2054
2085
  */
2055
- data?: any;
2086
+ data: any;
2056
2087
  /**
2057
2088
  * - Success or failure flag.
2058
2089
  */
@@ -2077,15 +2108,33 @@ type NotFoundResourceError = {
2077
2108
  /** @returns {BankDetailsForOTP} */
2078
2109
  declare function BankDetailsForOTP(): BankDetailsForOTP;
2079
2110
  type BankDetailsForOTP = {
2111
+ /**
2112
+ * - IFSC code of account
2113
+ */
2080
2114
  ifsc_code: string;
2115
+ /**
2116
+ * - Account number
2117
+ */
2081
2118
  account_no: string;
2119
+ /**
2120
+ * - Branch name of account
2121
+ */
2082
2122
  branch_name: string;
2123
+ /**
2124
+ * - Bank name of account
2125
+ */
2083
2126
  bank_name: string;
2127
+ /**
2128
+ * - Accountg holder name of account
2129
+ */
2084
2130
  account_holder: string;
2085
2131
  };
2086
2132
  /** @returns {AddBeneficiaryDetailsOTPRequest} */
2087
2133
  declare function AddBeneficiaryDetailsOTPRequest(): AddBeneficiaryDetailsOTPRequest;
2088
2134
  type AddBeneficiaryDetailsOTPRequest = {
2135
+ /**
2136
+ * - Order_id for which account will be added
2137
+ */
2089
2138
  order_id: string;
2090
2139
  details: BankDetailsForOTP;
2091
2140
  };
@@ -2149,7 +2198,7 @@ type OrderBeneficiaryDetails = {
2149
2198
  */
2150
2199
  transfer_mode: string;
2151
2200
  /**
2152
- * - EMail of User
2201
+ * - Email of User
2153
2202
  */
2154
2203
  email: string;
2155
2204
  /**
@@ -2165,7 +2214,7 @@ type OrderBeneficiaryDetails = {
2165
2214
  */
2166
2215
  address: string;
2167
2216
  /**
2168
- * - MOdification Date of Beneficiary
2217
+ * - Modification Date of Beneficiary
2169
2218
  */
2170
2219
  modified_on: string;
2171
2220
  /**
@@ -2200,6 +2249,9 @@ type OrderBeneficiaryResponse = {
2200
2249
  /** @returns {MultiTenderPaymentMeta} */
2201
2250
  declare function MultiTenderPaymentMeta(): MultiTenderPaymentMeta;
2202
2251
  type MultiTenderPaymentMeta = {
2252
+ /**
2253
+ * - Key value pair for extra data related to payment mode
2254
+ */
2203
2255
  extra_meta?: any;
2204
2256
  /**
2205
2257
  * - Fynd Platform order ID
@@ -2239,6 +2291,9 @@ type MultiTenderPaymentMethod = {
2239
2291
  * - Payment amount
2240
2292
  */
2241
2293
  amount: number;
2294
+ /**
2295
+ * - Payment mode short code
2296
+ */
2242
2297
  mode: string;
2243
2298
  };
2244
2299
  /** @returns {PaymentConfirmationRequest} */
@@ -2290,14 +2345,68 @@ type CODdata = {
2290
2345
  */
2291
2346
  usages: number;
2292
2347
  };
2348
+ /** @returns {CODLimitConfig} */
2349
+ declare function CODLimitConfig(): CODLimitConfig;
2350
+ type CODLimitConfig = {
2351
+ /**
2352
+ * - Limit for storefront
2353
+ */
2354
+ storefront: number;
2355
+ /**
2356
+ * - Limit for pos
2357
+ */
2358
+ pos: number;
2359
+ };
2360
+ /** @returns {CODPaymentLimitConfig} */
2361
+ declare function CODPaymentLimitConfig(): CODPaymentLimitConfig;
2362
+ type CODPaymentLimitConfig = {
2363
+ /**
2364
+ * - Boolean flag to show the status
2365
+ */
2366
+ is_active: boolean;
2367
+ /**
2368
+ * - Used cod limit
2369
+ */
2370
+ usages: number;
2371
+ /**
2372
+ * - User_id
2373
+ */
2374
+ user_id: number;
2375
+ /**
2376
+ * - Merchant_user_id
2377
+ */
2378
+ merchant_user_id: string;
2379
+ /**
2380
+ * - Remaining COD limit
2381
+ */
2382
+ remaining_limit: number;
2383
+ limit: CODLimitConfig;
2384
+ };
2385
+ /** @returns {GetUserBULimitResponse} */
2386
+ declare function GetUserBULimitResponse(): GetUserBULimitResponse;
2387
+ type GetUserBULimitResponse = {
2388
+ /**
2389
+ * - COD limit business unit
2390
+ */
2391
+ business_unit: string;
2392
+ /**
2393
+ * - Display name for cod limit
2394
+ */
2395
+ display_name: string;
2396
+ config: CODPaymentLimitConfig;
2397
+ };
2293
2398
  /** @returns {GetUserCODLimitResponse} */
2294
2399
  declare function GetUserCODLimitResponse(): GetUserCODLimitResponse;
2295
2400
  type GetUserCODLimitResponse = {
2296
- user_cod_data: CODdata;
2401
+ items: GetUserBULimitResponse[];
2297
2402
  /**
2298
2403
  * - Response is successful or not
2299
2404
  */
2300
2405
  success: boolean;
2406
+ /**
2407
+ * - Message for cod limit
2408
+ */
2409
+ message?: string;
2301
2410
  };
2302
2411
  /** @returns {SetCODForUserRequest} */
2303
2412
  declare function SetCODForUserRequest(): SetCODForUserRequest;
@@ -3072,7 +3181,8 @@ type GetPaymentLinkResponse = {
3072
3181
  */
3073
3182
  external_order_id?: string;
3074
3183
  /**
3075
- * - Polling request timeout
3184
+ * - Polling request timeout, perform
3185
+ * polling till timeout elapsed or payment status is success/failure
3076
3186
  */
3077
3187
  polling_timeout?: number;
3078
3188
  /**
@@ -3136,9 +3246,22 @@ type ErrorResponse = {
3136
3246
  /** @returns {CreatePaymentLinkMeta} */
3137
3247
  declare function CreatePaymentLinkMeta(): CreatePaymentLinkMeta;
3138
3248
  type CreatePaymentLinkMeta = {
3249
+ /**
3250
+ * - Cart id for which payment link needs to be generated.
3251
+ */
3139
3252
  cart_id: string;
3253
+ /**
3254
+ * - Checkout mode for the payment link i.e. self
3255
+ */
3140
3256
  checkout_mode: string;
3257
+ /**
3258
+ * - Payment link amount to be paid by the customer
3259
+ */
3141
3260
  amount: string;
3261
+ /**
3262
+ * - Assigned card id against which payment
3263
+ * to be done via payment link
3264
+ */
3142
3265
  assign_card_id?: string;
3143
3266
  };
3144
3267
  /** @returns {CreatePaymentLinkRequest} */
@@ -3504,6 +3627,10 @@ type PaymentSessionDetail = {
3504
3627
  * merchant account
3505
3628
  */
3506
3629
  amount_captured: number;
3630
+ /**
3631
+ * - Amount refunded or credited back to
3632
+ * customer accout
3633
+ */
3507
3634
  amount_refunded?: number;
3508
3635
  /**
3509
3636
  * - Unique customer id generated by
@@ -3566,11 +3693,11 @@ type PaymentSessionDetail = {
3566
3693
  */
3567
3694
  captured?: boolean;
3568
3695
  /**
3569
- * - Metadata
3696
+ * - Extra meta data specific to extension
3570
3697
  */
3571
3698
  meta?: any;
3572
3699
  /**
3573
- * - Stautus of the payment
3700
+ * - Status of the payment
3574
3701
  */
3575
3702
  status: string;
3576
3703
  };
@@ -3578,7 +3705,7 @@ type PaymentSessionDetail = {
3578
3705
  declare function PaymentSessionRequestSerializer(): PaymentSessionRequestSerializer;
3579
3706
  type PaymentSessionRequestSerializer = {
3580
3707
  /**
3581
- * - Meta
3708
+ * - Extra meta data specific to extensions
3582
3709
  */
3583
3710
  meta?: any;
3584
3711
  /**
@@ -3612,6 +3739,10 @@ type PaymentSessionRequestSerializer = {
3612
3739
  * - Checksum to verify the payload
3613
3740
  */
3614
3741
  checksum: string;
3742
+ /**
3743
+ * - Source of payment update session
3744
+ */
3745
+ source?: string;
3615
3746
  };
3616
3747
  /** @returns {PaymentSessionResponseSerializer} */
3617
3748
  declare function PaymentSessionResponseSerializer(): PaymentSessionResponseSerializer;
@@ -3771,7 +3902,7 @@ type RefundSessionResponseSerializer = {
3771
3902
  declare function PaymentDetailsSerializer(): PaymentDetailsSerializer;
3772
3903
  type PaymentDetailsSerializer = {
3773
3904
  /**
3774
- * - Method of payment
3905
+ * - List of payment methods
3775
3906
  */
3776
3907
  payment_methods: any[];
3777
3908
  /**
@@ -3780,6 +3911,10 @@ type PaymentDetailsSerializer = {
3780
3911
  * Fynd payments platform and is unique.
3781
3912
  */
3782
3913
  gid: string;
3914
+ /**
3915
+ * - Already refunded amount for the given
3916
+ * gid (global identifier for the order).
3917
+ */
3783
3918
  amount_refunded?: number;
3784
3919
  /**
3785
3920
  * - Currency of the payment.
@@ -3791,11 +3926,11 @@ type PaymentDetailsSerializer = {
3791
3926
  */
3792
3927
  mode: string;
3793
3928
  /**
3794
- * - Merchant's locale
3929
+ * - Merchant's locale (language) i.e. en
3795
3930
  */
3796
3931
  merchant_locale?: string;
3797
3932
  /**
3798
- * - Metadata
3933
+ * - Extra meta data related to the payment methods
3799
3934
  */
3800
3935
  meta?: any;
3801
3936
  /**
@@ -3809,7 +3944,7 @@ type PaymentDetailsSerializer = {
3809
3944
  */
3810
3945
  success_url?: string;
3811
3946
  /**
3812
- * - Stautus of the payment
3947
+ * - Status of the payment
3813
3948
  */
3814
3949
  status: string;
3815
3950
  /**
@@ -3827,12 +3962,12 @@ type PaymentDetailsSerializer = {
3827
3962
  */
3828
3963
  g_user_id: string;
3829
3964
  /**
3830
- * - User's locale
3965
+ * - User's locale (language), i.e. en
3831
3966
  */
3832
3967
  locale?: string;
3833
3968
  /**
3834
3969
  * - Cancel url sent by Fynd platform at the
3835
- * time of payment creation
3970
+ * time of payment creation, redirect on payment cancellation
3836
3971
  */
3837
3972
  cancel_url?: string;
3838
3973
  /**
@@ -3845,7 +3980,7 @@ type PaymentDetailsSerializer = {
3845
3980
  */
3846
3981
  amount_captured: number;
3847
3982
  /**
3848
- * - Amount paid.
3983
+ * - Amount paid for the order.
3849
3984
  */
3850
3985
  amount: number;
3851
3986
  /**