@gofynd/fdk-client-javascript 1.4.8-beta.2 → 1.4.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 +26 -1
- package/package.json +2 -2
- package/sdk/application/ApplicationClient.d.ts +8 -0
- package/sdk/application/ApplicationClient.js +14 -0
- package/sdk/application/Cart/CartApplicationClient.d.ts +20 -20
- package/sdk/application/Cart/CartApplicationClient.js +20 -20
- package/sdk/application/Cart/CartApplicationModel.d.ts +2446 -664
- package/sdk/application/Cart/CartApplicationModel.js +783 -552
- package/sdk/application/Cart/CartApplicationValidator.d.ts +268 -194
- package/sdk/application/Cart/CartApplicationValidator.js +100 -114
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +53 -53
- package/sdk/application/Catalog/CatalogApplicationClient.js +53 -53
- package/sdk/application/Catalog/CatalogApplicationModel.d.ts +2012 -503
- package/sdk/application/Catalog/CatalogApplicationModel.js +603 -453
- package/sdk/application/Catalog/CatalogApplicationValidator.d.ts +64 -64
- package/sdk/application/Catalog/CatalogApplicationValidator.js +32 -32
- package/sdk/application/Common/CommonApplicationClient.d.ts +2 -2
- package/sdk/application/Common/CommonApplicationClient.js +2 -2
- package/sdk/application/Common/CommonApplicationModel.d.ts +170 -90
- package/sdk/application/Common/CommonApplicationModel.js +59 -58
- package/sdk/application/Common/CommonApplicationValidator.d.ts +8 -5
- package/sdk/application/Common/CommonApplicationValidator.js +3 -3
- package/sdk/application/Communication/CommunicationApplicationClient.d.ts +2 -2
- package/sdk/application/Communication/CommunicationApplicationClient.js +2 -2
- package/sdk/application/Communication/CommunicationApplicationModel.d.ts +170 -35
- package/sdk/application/Communication/CommunicationApplicationModel.js +54 -33
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +15 -15
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +15 -15
- package/sdk/application/Configuration/ConfigurationApplicationModel.d.ts +624 -443
- package/sdk/application/Configuration/ConfigurationApplicationModel.js +259 -248
- package/sdk/application/Configuration/ConfigurationApplicationValidator.d.ts +32 -24
- package/sdk/application/Configuration/ConfigurationApplicationValidator.js +14 -13
- package/sdk/application/Content/ContentApplicationClient.d.ts +16 -16
- package/sdk/application/Content/ContentApplicationClient.js +16 -16
- package/sdk/application/Content/ContentApplicationModel.d.ts +1206 -281
- package/sdk/application/Content/ContentApplicationModel.js +342 -276
- package/sdk/application/Content/ContentApplicationValidator.d.ts +28 -17
- package/sdk/application/Content/ContentApplicationValidator.js +11 -10
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +3 -3
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +3 -3
- package/sdk/application/FileStorage/FileStorageApplicationModel.d.ts +146 -37
- package/sdk/application/FileStorage/FileStorageApplicationModel.js +38 -36
- package/sdk/application/Lead/LeadApplicationClient.d.ts +3 -3
- package/sdk/application/Lead/LeadApplicationClient.js +3 -3
- package/sdk/application/Lead/LeadApplicationModel.d.ts +195 -134
- package/sdk/application/Lead/LeadApplicationModel.js +110 -67
- package/sdk/application/Lead/LeadApplicationValidator.d.ts +8 -8
- package/sdk/application/Lead/LeadApplicationValidator.js +4 -4
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +10 -10
- package/sdk/application/Logistic/LogisticApplicationClient.js +10 -10
- package/sdk/application/Logistic/LogisticApplicationModel.d.ts +1039 -221
- package/sdk/application/Logistic/LogisticApplicationModel.js +342 -199
- package/sdk/application/Logistic/LogisticApplicationValidator.d.ts +76 -82
- package/sdk/application/Logistic/LogisticApplicationValidator.js +38 -41
- package/sdk/application/Order/OrderApplicationClient.d.ts +10 -10
- package/sdk/application/Order/OrderApplicationClient.js +10 -10
- package/sdk/application/Order/OrderApplicationModel.d.ts +1401 -324
- package/sdk/application/Order/OrderApplicationModel.js +392 -316
- package/sdk/application/Order/OrderApplicationValidator.d.ts +32 -30
- package/sdk/application/Order/OrderApplicationValidator.js +15 -14
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +43 -43
- package/sdk/application/Payment/PaymentApplicationClient.js +43 -43
- package/sdk/application/Payment/PaymentApplicationModel.d.ts +1111 -1022
- package/sdk/application/Payment/PaymentApplicationModel.js +537 -521
- package/sdk/application/Payment/PaymentApplicationValidator.d.ts +82 -49
- package/sdk/application/Payment/PaymentApplicationValidator.js +30 -30
- package/sdk/application/Rewards/RewardsApplicationModel.d.ts +28 -7
- package/sdk/application/Rewards/RewardsApplicationModel.js +7 -7
- package/sdk/application/Share/ShareApplicationModel.d.ts +178 -38
- package/sdk/application/Share/ShareApplicationModel.js +53 -37
- package/sdk/application/Share/ShareApplicationValidator.d.ts +4 -2
- package/sdk/application/Share/ShareApplicationValidator.js +2 -1
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +4 -4
- package/sdk/application/Theme/ThemeApplicationClient.js +14 -8
- package/sdk/application/Theme/ThemeApplicationModel.d.ts +528 -287
- package/sdk/application/Theme/ThemeApplicationModel.js +208 -172
- package/sdk/application/Theme/ThemeApplicationValidator.d.ts +17 -12
- package/sdk/application/Theme/ThemeApplicationValidator.js +8 -6
- package/sdk/application/User/UserApplicationClient.d.ts +36 -36
- package/sdk/application/User/UserApplicationClient.js +36 -36
- package/sdk/application/User/UserApplicationModel.d.ts +1062 -255
- package/sdk/application/User/UserApplicationModel.js +298 -244
- package/sdk/application/User/UserApplicationValidator.d.ts +80 -80
- package/sdk/application/User/UserApplicationValidator.js +40 -40
- package/sdk/application/Webhook/WebhookApplicationClient.d.ts +1 -1
- package/sdk/application/Webhook/WebhookApplicationClient.js +1 -1
- package/sdk/application/Webhook/WebhookApplicationModel.d.ts +20 -5
- package/sdk/application/Webhook/WebhookApplicationModel.js +5 -5
- package/sdk/common/Clickstream.js +95 -15
- package/sdk/common/Constant.d.ts +9 -0
- package/sdk/common/Constant.js +11 -0
- package/sdk/common/Utility.js +19 -0
- package/sdk/common/utils.js +8 -1
- package/sdk/partner/Lead/LeadPartnerModel.d.ts +28 -7
- package/sdk/partner/Lead/LeadPartnerModel.js +7 -7
- package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +75 -8
- package/sdk/partner/Logistics/LogisticsPartnerModel.js +59 -7
- package/sdk/partner/Logistics/LogisticsPartnerValidator.js +2 -2
- package/sdk/partner/PartnerClient.d.ts +8 -0
- package/sdk/partner/PartnerClient.js +14 -0
- package/sdk/partner/Theme/ThemePartnerClient.d.ts +20 -0
- package/sdk/partner/Theme/ThemePartnerClient.js +158 -0
- package/sdk/partner/Theme/ThemePartnerModel.d.ts +45 -6
- package/sdk/partner/Theme/ThemePartnerModel.js +33 -4
- package/sdk/partner/Theme/ThemePartnerValidator.d.ts +2 -0
- package/sdk/partner/Theme/ThemePartnerValidator.js +14 -0
- package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +28 -7
- package/sdk/partner/Webhook/WebhookPartnerModel.js +7 -7
- package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +28 -7
- package/sdk/platform/Analytics/AnalyticsPlatformModel.js +7 -7
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +21 -10
- package/sdk/platform/Billing/BillingPlatformClient.js +167 -83
- package/sdk/platform/Billing/BillingPlatformModel.d.ts +2849 -565
- package/sdk/platform/Billing/BillingPlatformModel.js +935 -556
- package/sdk/platform/Billing/BillingPlatformValidator.d.ts +30 -14
- package/sdk/platform/Billing/BillingPlatformValidator.js +31 -16
- package/sdk/platform/Cart/CartPlatformModel.d.ts +28 -7
- package/sdk/platform/Cart/CartPlatformModel.js +8 -8
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +1 -1
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +20 -0
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +37 -0
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +16 -0
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +12 -2
- package/sdk/platform/Catalog/CatalogPlatformClient.js +41 -1
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +46 -12
- package/sdk/platform/Catalog/CatalogPlatformModel.js +14 -11
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +40 -0
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +17 -0
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +28 -7
- package/sdk/platform/Communication/CommunicationPlatformModel.js +7 -7
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +28 -7
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +7 -7
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +0 -97
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +77 -782
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +24 -701
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +7 -539
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +1 -183
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +0 -134
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +0 -10
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +0 -79
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +1 -15
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +0 -13
- package/sdk/platform/Content/ContentPlatformModel.d.ts +60 -17
- package/sdk/platform/Content/ContentPlatformModel.js +30 -15
- package/sdk/platform/Discount/DiscountPlatformModel.d.ts +28 -7
- package/sdk/platform/Discount/DiscountPlatformModel.js +7 -7
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +127 -25
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +37 -25
- package/sdk/platform/Finance/FinancePlatformClient.d.ts +30 -30
- package/sdk/platform/Finance/FinancePlatformClient.js +30 -30
- package/sdk/platform/Finance/FinancePlatformModel.d.ts +1601 -348
- package/sdk/platform/Finance/FinancePlatformModel.js +488 -352
- package/sdk/platform/Lead/LeadPlatformModel.d.ts +28 -7
- package/sdk/platform/Lead/LeadPlatformModel.js +7 -7
- package/sdk/platform/Order/OrderPlatformClient.d.ts +22 -0
- package/sdk/platform/Order/OrderPlatformClient.js +165 -0
- package/sdk/platform/Order/OrderPlatformModel.d.ts +631 -39
- package/sdk/platform/Order/OrderPlatformModel.js +367 -41
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +32 -1
- package/sdk/platform/Order/OrderPlatformValidator.js +28 -0
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +30 -9
- package/sdk/platform/Payment/PaymentPlatformModel.js +9 -9
- package/sdk/platform/PlatformClient.d.ts +8 -0
- package/sdk/platform/PlatformClient.js +14 -0
- package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +28 -7
- package/sdk/platform/Rewards/RewardsPlatformModel.js +7 -7
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +12 -9
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +12 -9
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +1 -1
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +4 -4
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +139 -22
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +98 -21
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +4 -4
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +4 -4
- package/sdk/platform/Share/SharePlatformModel.d.ts +28 -7
- package/sdk/platform/Share/SharePlatformModel.js +7 -7
- package/sdk/platform/Theme/ThemePlatformModel.d.ts +18 -5
- package/sdk/platform/Theme/ThemePlatformModel.js +7 -4
- package/sdk/platform/User/UserPlatformModel.d.ts +18 -20
- package/sdk/platform/User/UserPlatformModel.js +9 -11
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +54 -33
- package/sdk/platform/Webhook/WebhookPlatformModel.js +33 -33
- package/sdk/public/Billing/BillingPublicClient.d.ts +11 -0
- package/sdk/public/Billing/BillingPublicClient.js +80 -0
- package/sdk/public/Billing/BillingPublicModel.d.ts +584 -99
- package/sdk/public/Billing/BillingPublicModel.js +252 -87
- package/sdk/public/Billing/BillingPublicValidator.d.ts +10 -1
- package/sdk/public/Billing/BillingPublicValidator.js +12 -0
- package/sdk/public/PublicClient.d.ts +0 -2
- package/sdk/public/PublicClient.js +0 -4
- package/sdk/public/index.d.ts +0 -1
- package/sdk/public/index.js +0 -2
- package/sdk/public/Inventory/InventoryPublicClient.d.ts +0 -87
- package/sdk/public/Inventory/InventoryPublicClient.js +0 -529
- package/sdk/public/Inventory/InventoryPublicModel.d.ts +0 -393
- package/sdk/public/Inventory/InventoryPublicModel.js +0 -448
- package/sdk/public/Inventory/InventoryPublicValidator.d.ts +0 -91
- package/sdk/public/Inventory/InventoryPublicValidator.js +0 -85
|
@@ -1,20 +1,20 @@
|
|
|
1
1
|
export = PaymentApplicationModel;
|
|
2
2
|
/**
|
|
3
3
|
* @typedef AggregatorConfigDetail
|
|
4
|
-
* @property {boolean} [sdk] - SDK
|
|
5
|
-
* @property {string} secret - Masked payment gateway api secret
|
|
6
|
-
* @property {string} [api] - Payment gateway api endpoint
|
|
7
|
-
* @property {string} [pin] - Masked pin
|
|
8
|
-
* @property {string} config_type - Fynd or self payment gateway
|
|
9
|
-
* @property {string} [merchant_key] - Unique merchant key
|
|
10
|
-
* @property {string} [verify_api] - Payment gateway verify payment api endpoint
|
|
11
|
-
* @property {string} key - Payment gateway api key
|
|
12
|
-
* @property {string} [user_id] - Registered User id
|
|
13
|
-
* @property {string} [merchant_id] - Unique merchant id
|
|
4
|
+
* @property {boolean} [sdk] - SDK details.
|
|
5
|
+
* @property {string} secret - Masked payment gateway api secret.
|
|
6
|
+
* @property {string} [api] - Payment gateway api endpoint.
|
|
7
|
+
* @property {string} [pin] - Masked pin.
|
|
8
|
+
* @property {string} config_type - Fynd or self payment gateway.
|
|
9
|
+
* @property {string} [merchant_key] - Unique merchant key.
|
|
10
|
+
* @property {string} [verify_api] - Payment gateway verify payment api endpoint.
|
|
11
|
+
* @property {string} key - Payment gateway api key.
|
|
12
|
+
* @property {string} [user_id] - Registered User id.
|
|
13
|
+
* @property {string} [merchant_id] - Unique merchant id.
|
|
14
14
|
*/
|
|
15
15
|
/**
|
|
16
16
|
* @typedef AggregatorsConfigDetailResponse
|
|
17
|
-
* @property {boolean} success
|
|
17
|
+
* @property {boolean} success - Api response was successful or not.
|
|
18
18
|
* @property {AggregatorConfigDetail} [razorpay]
|
|
19
19
|
* @property {AggregatorConfigDetail} [juspay]
|
|
20
20
|
* @property {AggregatorConfigDetail} [simpl]
|
|
@@ -23,24 +23,24 @@ export = PaymentApplicationModel;
|
|
|
23
23
|
* @property {AggregatorConfigDetail} [mswipe]
|
|
24
24
|
* @property {AggregatorConfigDetail} [stripe]
|
|
25
25
|
* @property {AggregatorConfigDetail} [ccavenue]
|
|
26
|
-
* @property {string} env - Environment i.e Live or Test
|
|
26
|
+
* @property {string} env - Environment i.e Live or Test.
|
|
27
27
|
*/
|
|
28
28
|
/**
|
|
29
29
|
* @typedef ErrorCodeAndDescription
|
|
30
|
-
* @property {string} code - Error
|
|
30
|
+
* @property {string} code - Error description code.
|
|
31
31
|
* @property {string} description - Error human understandable description.
|
|
32
32
|
*/
|
|
33
33
|
/**
|
|
34
34
|
* @typedef HttpErrorCodeAndResponse
|
|
35
35
|
* @property {ErrorCodeAndDescription} [error]
|
|
36
|
-
* @property {boolean} success - Response is successful or not
|
|
36
|
+
* @property {boolean} success - Response is successful or not.
|
|
37
37
|
*/
|
|
38
38
|
/**
|
|
39
39
|
* @typedef AttachCardRequest
|
|
40
|
-
* @property {string} [nickname]
|
|
40
|
+
* @property {string} [nickname] - Nickname of the card holder.
|
|
41
41
|
* @property {boolean} [refresh] - Refresh cache flag.
|
|
42
42
|
* @property {string} card_id - Card token of payment gateway.
|
|
43
|
-
* @property {string} [name_on_card]
|
|
43
|
+
* @property {string} [name_on_card] - Name of the card holder.
|
|
44
44
|
*/
|
|
45
45
|
/**
|
|
46
46
|
* @typedef AttachCardsResponse
|
|
@@ -50,7 +50,7 @@ export = PaymentApplicationModel;
|
|
|
50
50
|
*/
|
|
51
51
|
/**
|
|
52
52
|
* @typedef CardPaymentGateway
|
|
53
|
-
* @property {string} [api] - Payment gateway CARD api endpoint
|
|
53
|
+
* @property {string} [api] - Payment gateway CARD api endpoint.
|
|
54
54
|
* @property {string} aggregator - Payment gateway name.
|
|
55
55
|
* @property {string} [customer_id] - Payment gateway customer id.
|
|
56
56
|
*/
|
|
@@ -62,24 +62,26 @@ export = PaymentApplicationModel;
|
|
|
62
62
|
*/
|
|
63
63
|
/**
|
|
64
64
|
* @typedef Card
|
|
65
|
-
* @property {string} [card_number] -
|
|
66
|
-
* @property {string} [card_name] -
|
|
67
|
-
* @property {string} [card_type] -
|
|
68
|
-
* @property {string} [card_brand_image] -
|
|
69
|
-
* @property {string} [card_reference] -
|
|
70
|
-
* @property {string} [card_issuer] -
|
|
71
|
-
* @property {string} [card_brand] -
|
|
72
|
-
* @property {boolean} [expired] -
|
|
73
|
-
* @property {boolean} [compliant_with_tokenisation_guidelines] -
|
|
74
|
-
*
|
|
75
|
-
* @property {string} [card_isin] -
|
|
76
|
-
*
|
|
77
|
-
* @property {
|
|
78
|
-
* @property {string}
|
|
79
|
-
* @property {string}
|
|
80
|
-
* @property {string} [
|
|
81
|
-
*
|
|
82
|
-
* @property {string} [
|
|
65
|
+
* @property {string} [card_number] - Card number mentioned on the card.
|
|
66
|
+
* @property {string} [card_name] - Name mentioned on the card.
|
|
67
|
+
* @property {string} [card_type] - Type of the card.
|
|
68
|
+
* @property {string} [card_brand_image] - Brand image on the card.
|
|
69
|
+
* @property {string} [card_reference] - Card reference.
|
|
70
|
+
* @property {string} [card_issuer] - Issuer of the card.
|
|
71
|
+
* @property {string} [card_brand] - Brand of the card.
|
|
72
|
+
* @property {boolean} [expired] - Card expiry.
|
|
73
|
+
* @property {boolean} [compliant_with_tokenisation_guidelines] - Whether card
|
|
74
|
+
* is tokenized or not.
|
|
75
|
+
* @property {string} [card_isin] - International Securities Identification
|
|
76
|
+
* Number for the card.
|
|
77
|
+
* @property {number} [exp_year] - Card's expiration year.
|
|
78
|
+
* @property {string} [nickname] - User-defined name for the card.
|
|
79
|
+
* @property {string} aggregator_name - Name of the payment aggregator.
|
|
80
|
+
* @property {string} [card_fingerprint] - Unique fingerprint of the card for
|
|
81
|
+
* identification.
|
|
82
|
+
* @property {string} [card_token] - Encrypted token representing the card.
|
|
83
|
+
* @property {number} [exp_month] - Card's expiration month.
|
|
84
|
+
* @property {string} [card_id] - Unique identifier for the card within the system.
|
|
83
85
|
*/
|
|
84
86
|
/**
|
|
85
87
|
* @typedef ListCardsResponse
|
|
@@ -98,8 +100,8 @@ export = PaymentApplicationModel;
|
|
|
98
100
|
*/
|
|
99
101
|
/**
|
|
100
102
|
* @typedef ValidateCustomerRequest
|
|
101
|
-
* @property {string} aggregator - Payment gateway name in
|
|
102
|
-
* @property {number} transaction_amount_in_paise - Payable amount in paise
|
|
103
|
+
* @property {string} aggregator - Payment gateway name in camelcase i.e Simple, Rupifi.
|
|
104
|
+
* @property {number} transaction_amount_in_paise - Payable amount in paise.
|
|
103
105
|
* @property {string} phone_number - User mobile number without country code.
|
|
104
106
|
* @property {Object} [billing_address] - Extra meta fields.
|
|
105
107
|
* @property {Object[]} [order_items] - Extra meta fields.
|
|
@@ -109,170 +111,175 @@ export = PaymentApplicationModel;
|
|
|
109
111
|
*/
|
|
110
112
|
/**
|
|
111
113
|
* @typedef ValidateCustomerResponse
|
|
112
|
-
* @property {Object} data - Payment gateway response data
|
|
113
|
-
* @property {boolean} success - Response is successful or not
|
|
114
|
+
* @property {Object} [data] - Payment gateway response data.
|
|
115
|
+
* @property {boolean} success - Response is successful or not.
|
|
114
116
|
* @property {string} message - Error or success message.
|
|
115
117
|
*/
|
|
116
118
|
/**
|
|
117
119
|
* @typedef ChargeCustomerRequest
|
|
118
|
-
* @property {boolean} [verified] - Already Verified flag from payment gateway i.e Mswipe
|
|
119
|
-
* @property {string} aggregator - Payment gateway name i.e Simpl, Mswipe
|
|
120
|
+
* @property {boolean} [verified] - Already Verified flag from payment gateway i.e Mswipe.
|
|
121
|
+
* @property {string} aggregator - Payment gateway name i.e Simpl, Mswipe.
|
|
120
122
|
* @property {string} order_id - Unique order id.
|
|
121
123
|
* @property {string} [transaction_token] - Transaction token of payment gateway.
|
|
122
|
-
* @property {number} amount -
|
|
124
|
+
* @property {number} amount - Chargeable amount of order.
|
|
123
125
|
*/
|
|
124
126
|
/**
|
|
125
127
|
* @typedef ChargeCustomerResponse
|
|
126
128
|
* @property {string} status - Status of charged payment.
|
|
127
|
-
* @property {string} [cart_id] - Cart id of customer
|
|
129
|
+
* @property {string} [cart_id] - Cart id of customer.
|
|
128
130
|
* @property {boolean} success - Response is successful or not.
|
|
129
|
-
* @property {string} aggregator - Payment gateway name i.e Simpl, Mswipe
|
|
131
|
+
* @property {string} aggregator - Payment gateway name i.e Simpl, Mswipe.
|
|
130
132
|
* @property {string} message - Human readable message.
|
|
131
133
|
* @property {string} order_id - Unique order id.
|
|
132
|
-
* @property {string} [delivery_address_id] - Delivery
|
|
134
|
+
* @property {string} [delivery_address_id] - Delivery address id of customer.
|
|
133
135
|
*/
|
|
134
136
|
/**
|
|
135
137
|
* @typedef PaymentInitializationRequest
|
|
136
|
-
* @property {string} [razorpay_payment_id] - Payment gateway payment id
|
|
137
|
-
* @property {string} method - Payment method
|
|
138
|
-
* @property {string} [device_id] - EDC machine Unique Identifier
|
|
139
|
-
* @property {string} aggregator - Payment gateway name
|
|
138
|
+
* @property {string} [razorpay_payment_id] - Payment gateway payment id.
|
|
139
|
+
* @property {string} method - Payment method.
|
|
140
|
+
* @property {string} [device_id] - EDC machine Unique Identifier.
|
|
141
|
+
* @property {string} aggregator - Payment gateway name.
|
|
140
142
|
* @property {string} customer_id - Payment gateway customer id.
|
|
141
|
-
* @property {string} contact - Customer valid mobile number
|
|
142
|
-
* @property {string} merchant_order_id - Unique fynd order id
|
|
143
|
-
* @property {string} [vpa] - Customer vpa address
|
|
144
|
-
* @property {string} order_id - Payment gateway order id
|
|
143
|
+
* @property {string} contact - Customer valid mobile number.
|
|
144
|
+
* @property {string} merchant_order_id - Unique fynd order id.
|
|
145
|
+
* @property {string} [vpa] - Customer vpa address.
|
|
146
|
+
* @property {string} order_id - Payment gateway order id.
|
|
145
147
|
* @property {string} currency - Currency code.
|
|
146
|
-
* @property {number} [timeout] - Payment polling timeout if not
|
|
148
|
+
* @property {number} [timeout] - Payment polling timeout if not received response.
|
|
147
149
|
* @property {number} amount - Payable amount.
|
|
148
|
-
* @property {string} email - Customer valid email
|
|
150
|
+
* @property {string} email - Customer valid email.
|
|
149
151
|
*/
|
|
150
152
|
/**
|
|
151
153
|
* @typedef PaymentInitializationResponse
|
|
152
154
|
* @property {string} [status] - Status of payment.
|
|
153
155
|
* @property {string} [razorpay_payment_id] - Payment id.
|
|
154
|
-
* @property {string} [aggregator_order_id] - Payment order id
|
|
155
|
-
* @property {string} method - Payment method
|
|
156
|
+
* @property {string} [aggregator_order_id] - Payment order id.
|
|
157
|
+
* @property {string} method - Payment method.
|
|
156
158
|
* @property {boolean} success - Response is successful or not.
|
|
157
159
|
* @property {string} [upi_poll_url] - UPI poll url.
|
|
158
160
|
* @property {string} [virtual_id] - Payment virtual address.
|
|
159
|
-
* @property {string} [device_id] - EDC machine Unique Identifier
|
|
161
|
+
* @property {string} [device_id] - EDC machine Unique Identifier.
|
|
160
162
|
* @property {string} polling_url - Polling url.
|
|
161
|
-
* @property {string} aggregator - Payment gateway name
|
|
162
|
-
* @property {string} merchant_order_id - Order id
|
|
163
|
+
* @property {string} aggregator - Payment gateway name.
|
|
164
|
+
* @property {string} merchant_order_id - Order id.
|
|
163
165
|
* @property {string} [customer_id] - Payment gateway customer id.
|
|
164
|
-
* @property {string} [vpa] - Customer vpa address
|
|
166
|
+
* @property {string} [vpa] - Customer vpa address.
|
|
165
167
|
* @property {string} [currency] - Currency code.
|
|
166
168
|
* @property {number} [timeout] - Timeout.
|
|
167
169
|
* @property {number} [amount] - Payable amount.
|
|
168
|
-
* @property {string} [bqr_image] -
|
|
170
|
+
* @property {string} [bqr_image] - Bharat qr image url.
|
|
169
171
|
*/
|
|
170
172
|
/**
|
|
171
173
|
* @typedef PaymentStatusUpdateRequest
|
|
172
174
|
* @property {string} [status] - Status of payment.
|
|
173
|
-
* @property {string} [merchant_transaction_id] - Unique fynd transaction id
|
|
174
|
-
* @property {string} method - Payment method
|
|
175
|
-
* @property {string} [device_id] - EDC machine Unique Identifier
|
|
176
|
-
* @property {string} aggregator - Payment gateway name
|
|
175
|
+
* @property {string} [merchant_transaction_id] - Unique fynd transaction id.
|
|
176
|
+
* @property {string} method - Payment method.
|
|
177
|
+
* @property {string} [device_id] - EDC machine Unique Identifier.
|
|
178
|
+
* @property {string} aggregator - Payment gateway name.
|
|
177
179
|
* @property {string} [customer_id] - Payment gateway customer id.
|
|
178
|
-
* @property {string} [contact] - Customer valid mobile number
|
|
179
|
-
* @property {string} merchant_order_id - Unique fynd order id
|
|
180
|
-
* @property {string} [vpa] - Customer vpa address
|
|
181
|
-
* @property {string} [order_id] - Payment gateway order id
|
|
180
|
+
* @property {string} [contact] - Customer valid mobile number.
|
|
181
|
+
* @property {string} merchant_order_id - Unique fynd order id.
|
|
182
|
+
* @property {string} [vpa] - Customer vpa address.
|
|
183
|
+
* @property {string} [order_id] - Payment gateway order id.
|
|
182
184
|
* @property {string} [currency] - Currency code.
|
|
183
185
|
* @property {number} [amount] - Payable amount.
|
|
184
|
-
* @property {string} [email] - Customer valid email
|
|
186
|
+
* @property {string} [email] - Customer valid email.
|
|
185
187
|
*/
|
|
186
188
|
/**
|
|
187
189
|
* @typedef PaymentStatusUpdateResponse
|
|
188
|
-
* @property {string} status - Payment status
|
|
189
|
-
* @property {boolean} [success] - Response is successful or not
|
|
190
|
+
* @property {string} status - Payment status.
|
|
191
|
+
* @property {boolean} [success] - Response is successful or not.
|
|
190
192
|
* @property {boolean} retry - Response is successful or not.
|
|
191
|
-
* @property {string} [redirect_url] - Redirect url
|
|
192
|
-
* @property {string} aggregator_name - Payment gateway name
|
|
193
|
+
* @property {string} [redirect_url] - Redirect url.
|
|
194
|
+
* @property {string} aggregator_name - Payment gateway name.
|
|
193
195
|
*/
|
|
194
196
|
/**
|
|
195
197
|
* @typedef IntentAppErrorList
|
|
196
|
-
* @property {string} [code] - Code
|
|
197
|
-
* @property {string} [package_name] -
|
|
198
|
+
* @property {string} [code] - Code of the intent App.
|
|
199
|
+
* @property {string} [package_name] - Package Name of the intent App.
|
|
198
200
|
*/
|
|
199
201
|
/**
|
|
200
202
|
* @typedef PaymentModeLogo
|
|
201
|
-
* @property {string} large - Large
|
|
202
|
-
* @property {string} small -
|
|
203
|
+
* @property {string} large - Large Logo.
|
|
204
|
+
* @property {string} small - Small Logo.
|
|
203
205
|
*/
|
|
204
206
|
/**
|
|
205
207
|
* @typedef IntentApp
|
|
206
|
-
* @property {string} [code] - Code
|
|
207
|
-
* @property {string} [package_name] -
|
|
208
|
+
* @property {string} [code] - Code of the intent App.
|
|
209
|
+
* @property {string} [package_name] - Package Name of the intent App.
|
|
208
210
|
* @property {PaymentModeLogo} [logos]
|
|
209
|
-
* @property {string} [display_name] -
|
|
211
|
+
* @property {string} [display_name] - Display Name of the intent App.
|
|
210
212
|
*/
|
|
211
213
|
/**
|
|
212
214
|
* @typedef PaymentModeList
|
|
213
|
-
* @property {string} [card_number] -
|
|
214
|
-
* @property {string} [merchant_code] -
|
|
215
|
-
* @property {string} [card_reference] -
|
|
216
|
-
* @property {string} [card_issuer] -
|
|
217
|
-
* @property {boolean} [compliant_with_tokenisation_guidelines] -
|
|
218
|
-
*
|
|
219
|
-
* @property {string} [code] -
|
|
220
|
-
* @property {number} [cod_limit] -
|
|
221
|
-
* @property {boolean} [intent_flow] -
|
|
222
|
-
* @property {string} [fynd_vpa] -
|
|
223
|
-
* @property {IntentAppErrorList[]} [intent_app_error_dict_list] -
|
|
224
|
-
*
|
|
225
|
-
* @property {string} aggregator_name -
|
|
226
|
-
* @property {string} [card_fingerprint] -
|
|
227
|
-
*
|
|
228
|
-
* @property {
|
|
229
|
-
*
|
|
230
|
-
* @property {
|
|
231
|
-
*
|
|
232
|
-
* @property {
|
|
233
|
-
* @property {
|
|
234
|
-
* @property {number} [
|
|
235
|
-
* @property {number} [
|
|
236
|
-
* @property {string} [
|
|
237
|
-
* @property {number} [
|
|
215
|
+
* @property {string} [card_number] - Card number mentioned on the card.
|
|
216
|
+
* @property {string} [merchant_code] - Unique code identifying the merchant.
|
|
217
|
+
* @property {string} [card_reference] - Reference identifier for the card.
|
|
218
|
+
* @property {string} [card_issuer] - Issuing bank or institution of the card.
|
|
219
|
+
* @property {boolean} [compliant_with_tokenisation_guidelines] - Indicates
|
|
220
|
+
* compliance with tokenization guidelines.
|
|
221
|
+
* @property {string} [code] - General code for identifying a transaction or status.
|
|
222
|
+
* @property {number} [cod_limit] - Limit for Cash on Delivery (COD) transactions.
|
|
223
|
+
* @property {boolean} [intent_flow] - Flow or process intended for the transaction.
|
|
224
|
+
* @property {string} [fynd_vpa] - Virtual Payment Address (VPA) used by Fynd.
|
|
225
|
+
* @property {IntentAppErrorList[]} [intent_app_error_dict_list] - List of error
|
|
226
|
+
* dictionaries related to intent app.
|
|
227
|
+
* @property {string} aggregator_name - Name of the payment aggregator.
|
|
228
|
+
* @property {string} [card_fingerprint] - Unique fingerprint of the card for
|
|
229
|
+
* identification.
|
|
230
|
+
* @property {string[]} [intent_app_error_list] - List of errors associated with
|
|
231
|
+
* the intent app.
|
|
232
|
+
* @property {IntentApp[]} [intent_app] - Application intended for handling the
|
|
233
|
+
* transaction.
|
|
234
|
+
* @property {boolean} [expired] - Indicates whether the card is expired.
|
|
235
|
+
* @property {number} [retry_count] - Number of retry attempts.
|
|
236
|
+
* @property {number} [exp_year] - Card's expiration year.
|
|
237
|
+
* @property {number} [exp_month] - Card's expiration month.
|
|
238
|
+
* @property {string} [card_id] - Unique identifier for the card within the system.
|
|
239
|
+
* @property {number} [remaining_limit] - Remaining available limit on the card.
|
|
240
|
+
* @property {number} [display_priority] - Priority of display in the user interface.
|
|
241
|
+
* @property {string} [card_brand] - Brand of the card (e.g., Visa, MasterCard).
|
|
242
|
+
* @property {number} [cod_limit_per_order] - Maximum limit per order for COD
|
|
243
|
+
* transactions.
|
|
238
244
|
* @property {PaymentModeLogo} [logo_url]
|
|
239
|
-
* @property {string} [nickname] -
|
|
240
|
-
* @property {string} [card_name] -
|
|
241
|
-
* @property {string} [card_type] -
|
|
242
|
-
* @property {string} [card_brand_image] -
|
|
243
|
-
* @property {string} [display_name] - Display name
|
|
244
|
-
* @property {string} [card_isin] -
|
|
245
|
-
*
|
|
246
|
-
* @property {
|
|
247
|
-
* @property {string} [
|
|
248
|
-
* @property {
|
|
245
|
+
* @property {string} [nickname] - User-defined name for the card.
|
|
246
|
+
* @property {string} [card_name] - Name printed on the card.
|
|
247
|
+
* @property {string} [card_type] - Type of the card (e.g., debit, credit).
|
|
248
|
+
* @property {string} [card_brand_image] - Image representing the card brand.
|
|
249
|
+
* @property {string} [display_name] - Display name for the card in the user interface.
|
|
250
|
+
* @property {string} [card_isin] - International Securities Identification
|
|
251
|
+
* Number for the card.
|
|
252
|
+
* @property {number} [timeout] - Timeout duration for transactions.
|
|
253
|
+
* @property {string} [card_token] - Encrypted token representing the card.
|
|
254
|
+
* @property {string} [name] - User's name.
|
|
255
|
+
* @property {Object} [meta] - Payment methods meta.
|
|
249
256
|
*/
|
|
250
257
|
/**
|
|
251
258
|
* @typedef RootPaymentMode
|
|
252
259
|
* @property {boolean} [is_pay_by_card_pl] - This flag will be true in case of
|
|
253
|
-
* Payment link payment through card
|
|
254
|
-
* @property {boolean} [add_card_enabled] -
|
|
255
|
-
* @property {number} display_priority -
|
|
256
|
-
* @property {string} display_name - Payment mode display name
|
|
257
|
-
* @property {PaymentModeList[]} [list] - Payment mode
|
|
258
|
-
* @property {boolean} [save_card] - Card save or not
|
|
259
|
-
* @property {string} [aggregator_name] -
|
|
260
|
-
* @property {string} name - Payment mode name
|
|
261
|
-
* @property {boolean} [anonymous_enable] -
|
|
260
|
+
* Payment link payment through card.
|
|
261
|
+
* @property {boolean} [add_card_enabled] - Anonymous card flag.
|
|
262
|
+
* @property {number} display_priority - Display Priority.
|
|
263
|
+
* @property {string} display_name - Payment mode display name.
|
|
264
|
+
* @property {PaymentModeList[]} [list] - Payment mode.
|
|
265
|
+
* @property {boolean} [save_card] - Card save or not.
|
|
266
|
+
* @property {string} [aggregator_name] - Display Priority.
|
|
267
|
+
* @property {string} name - Payment mode name.
|
|
268
|
+
* @property {boolean} [anonymous_enable] - Anonymous card flag.
|
|
262
269
|
*/
|
|
263
270
|
/**
|
|
264
271
|
* @typedef AggregatorRoute
|
|
265
|
-
* @property {Object} [data] -
|
|
266
|
-
* @property {Object} [payment_flow_data] - Payment_flow_data
|
|
267
|
-
* @property {string} [payment_flow] - Payment_flow
|
|
268
|
-
* @property {string} [api_link] -
|
|
272
|
+
* @property {Object} [data] - Details about aggregator route.
|
|
273
|
+
* @property {Object} [payment_flow_data] - Payment_flow_data.
|
|
274
|
+
* @property {string} [payment_flow] - Payment_flow.
|
|
275
|
+
* @property {string} [api_link] - API link of the aggregator.
|
|
269
276
|
*/
|
|
270
277
|
/**
|
|
271
278
|
* @typedef PaymentDefaultSelection
|
|
272
|
-
* @property {string} [mode] - Default Selection Payment Mode
|
|
273
|
-
* @property {string} [identifier] - Identifier for Payment Mode
|
|
279
|
+
* @property {string} [mode] - Default Selection Payment Mode.
|
|
280
|
+
* @property {string} [identifier] - Identifier for Payment Mode.
|
|
274
281
|
* @property {boolean} [skip] - Decide if the default payment mode will skip the
|
|
275
|
-
* payment options page altogether or just be preferred on the Frontend
|
|
282
|
+
* payment options page altogether or just be preferred on the Frontend.
|
|
276
283
|
*/
|
|
277
284
|
/**
|
|
278
285
|
* @typedef PaymentFlow
|
|
@@ -293,73 +300,73 @@ export = PaymentApplicationModel;
|
|
|
293
300
|
*/
|
|
294
301
|
/**
|
|
295
302
|
* @typedef PaymentOptionAndFlow
|
|
296
|
-
* @property {RootPaymentMode[]} payment_option - Payment options
|
|
303
|
+
* @property {RootPaymentMode[]} payment_option - Payment options.
|
|
297
304
|
* @property {PaymentFlow} payment_flows
|
|
298
305
|
* @property {PaymentDefaultSelection} [payment_default_selection]
|
|
299
306
|
*/
|
|
300
307
|
/**
|
|
301
308
|
* @typedef AdvanceObject
|
|
302
|
-
* @property {boolean} [is_active] - Is Advance Payment active
|
|
303
|
-
* @property {number} [amount] - Amount for Payment Breakdown
|
|
304
|
-
* @property {string} [time_unit] - Time unit for refunds
|
|
309
|
+
* @property {boolean} [is_active] - Is Advance Payment active.
|
|
310
|
+
* @property {number} [amount] - Amount for Payment Breakdown.
|
|
311
|
+
* @property {string} [time_unit] - Time unit for refunds.
|
|
305
312
|
* @property {string} [description] - The description for Advance Payment (user
|
|
306
|
-
* configured)
|
|
307
|
-
* @property {string} [display_name] - The display name for Advance payment
|
|
308
|
-
* @property {string} [prepayment_type] - Type of prepayment value
|
|
309
|
-
* @property {number} [prepayment_value] - Value for prepayment in advance payment
|
|
310
|
-
* @property {string} [cancellation_type] - Type of cancellation
|
|
311
|
-
* @property {number} [refund_time_limit] - Time limit for processing refund
|
|
312
|
-
* @property {string[]} [all_prepayment_type] - All available types of prepayment
|
|
313
|
-
* @property {boolean} [allow_custom_advance_amount] - Is custom advance amount allowed
|
|
313
|
+
* configured).
|
|
314
|
+
* @property {string} [display_name] - The display name for Advance payment.
|
|
315
|
+
* @property {string} [prepayment_type] - Type of prepayment value.
|
|
316
|
+
* @property {number} [prepayment_value] - Value for prepayment in advance payment.
|
|
317
|
+
* @property {string} [cancellation_type] - Type of cancellation.
|
|
318
|
+
* @property {number} [refund_time_limit] - Time limit for processing refund.
|
|
319
|
+
* @property {string[]} [all_prepayment_type] - All available types of prepayment.
|
|
320
|
+
* @property {boolean} [allow_custom_advance_amount] - Is custom advance amount allowed?.
|
|
314
321
|
*/
|
|
315
322
|
/**
|
|
316
323
|
* @typedef SplitObject
|
|
317
|
-
* @property {number} [total_number_of_splits] - Maximum amount of splits allowed
|
|
318
|
-
* @property {number} [splits_remaining] - Number of splits remaining
|
|
319
|
-
* @property {number} [amount_remaining] - Amount pending to be paid
|
|
324
|
+
* @property {number} [total_number_of_splits] - Maximum amount of splits allowed.
|
|
325
|
+
* @property {number} [splits_remaining] - Number of splits remaining.
|
|
326
|
+
* @property {number} [amount_remaining] - Amount pending to be paid.
|
|
320
327
|
*/
|
|
321
328
|
/**
|
|
322
329
|
* @typedef AdvancePaymentObject
|
|
323
|
-
* @property {string} [name] - Name of Advance Payment Mode
|
|
324
|
-
* @property {number} [display_priority] - Display Priority for Payment Option
|
|
325
|
-
* @property {number} [payment_mode_id] - Payment Mode ID for Advance Payment Option
|
|
326
|
-
* @property {string} [display_name] - Display name for Advance Payment Mode
|
|
327
|
-
* @property {PaymentModeList[]} [list] - Payment mode
|
|
330
|
+
* @property {string} [name] - Name of Advance Payment Mode.
|
|
331
|
+
* @property {number} [display_priority] - Display Priority for Payment Option.
|
|
332
|
+
* @property {number} [payment_mode_id] - Payment Mode ID for Advance Payment Option.
|
|
333
|
+
* @property {string} [display_name] - Display name for Advance Payment Mode.
|
|
334
|
+
* @property {PaymentModeList[]} [list] - Payment mode.
|
|
328
335
|
* @property {SplitObject} [split]
|
|
329
336
|
* @property {AdvanceObject} [advance]
|
|
330
337
|
*/
|
|
331
338
|
/**
|
|
332
339
|
* @typedef PaymentModeRouteResponse
|
|
333
340
|
* @property {PaymentOptionAndFlow} payment_options
|
|
334
|
-
* @property {boolean} success - Response is successful or not
|
|
335
|
-
* @property {Object} [payment_breakup] - Payment Breakup for advance payment
|
|
336
|
-
* @property {AdvancePaymentObject[]} [advance_payment] - Advance Payment Array
|
|
341
|
+
* @property {boolean} success - Response is successful or not.
|
|
342
|
+
* @property {Object} [payment_breakup] - Payment Breakup for advance payment.
|
|
343
|
+
* @property {AdvancePaymentObject[]} [advance_payment] - Advance Payment Array.
|
|
337
344
|
*/
|
|
338
345
|
/**
|
|
339
346
|
* @typedef WalletLinkRequestSchema
|
|
340
|
-
* @property {string} aggregator - Aggregator Name
|
|
341
|
-
* @property {string} mobile - Mobile Number for Wallet
|
|
342
|
-
* @property {string} wallet_code - Wallet Code
|
|
347
|
+
* @property {string} aggregator - Aggregator Name.
|
|
348
|
+
* @property {string} mobile - Mobile Number for Wallet.
|
|
349
|
+
* @property {string} wallet_code - Wallet Code.
|
|
343
350
|
*/
|
|
344
351
|
/**
|
|
345
352
|
* @typedef WalletVerifyRequestSchema
|
|
346
|
-
* @property {string} aggregator - Aggregator Name
|
|
347
|
-
* @property {string} link_token - Token for wallet linking
|
|
348
|
-
* @property {number} otp - OTP received for wallet linking
|
|
353
|
+
* @property {string} aggregator - Aggregator Name.
|
|
354
|
+
* @property {string} link_token - Token for wallet linking.
|
|
355
|
+
* @property {number} otp - OTP received for wallet linking.
|
|
349
356
|
*/
|
|
350
357
|
/**
|
|
351
358
|
* @typedef WalletDelinkRequestSchema
|
|
352
|
-
* @property {string} aggregator - Aggregator Name
|
|
353
|
-
* @property {string} wallet_code - Wallet Code
|
|
359
|
+
* @property {string} aggregator - Aggregator Name.
|
|
360
|
+
* @property {string} wallet_code - Wallet Code.
|
|
354
361
|
*/
|
|
355
362
|
/**
|
|
356
363
|
* @typedef WalletResponseSchema
|
|
357
|
-
* @property {Object} data - Response received from aggregator
|
|
358
|
-
* @property {boolean} success - Success/Failure of the API call
|
|
364
|
+
* @property {Object} data - Response received from aggregator.
|
|
365
|
+
* @property {boolean} success - Success/Failure of the API call.
|
|
359
366
|
*/
|
|
360
367
|
/**
|
|
361
368
|
* @typedef RupifiBannerData
|
|
362
|
-
* @property {string} [status] - Rupifi KYC status
|
|
369
|
+
* @property {string} [status] - Rupifi KYC status.
|
|
363
370
|
* @property {string} [kyc_url] - Rupifi KYC banner url.
|
|
364
371
|
*/
|
|
365
372
|
/**
|
|
@@ -369,9 +376,9 @@ export = PaymentApplicationModel;
|
|
|
369
376
|
*/
|
|
370
377
|
/**
|
|
371
378
|
* @typedef EpaylaterBannerData
|
|
372
|
-
* @property {string} [status] - Epaylater KYC status
|
|
373
|
-
* @property {string} [message] - EPayLater message
|
|
374
|
-
* @property {boolean} display - Need to display banner or not
|
|
379
|
+
* @property {string} [status] - Epaylater KYC status.
|
|
380
|
+
* @property {string} [message] - EPayLater message.
|
|
381
|
+
* @property {boolean} display - Need to display banner or not.
|
|
375
382
|
*/
|
|
376
383
|
/**
|
|
377
384
|
* @typedef EpaylaterBannerResponse
|
|
@@ -380,14 +387,14 @@ export = PaymentApplicationModel;
|
|
|
380
387
|
*/
|
|
381
388
|
/**
|
|
382
389
|
* @typedef ResendOrCancelPaymentRequest
|
|
383
|
-
* @property {string} order_id - Unique order id
|
|
384
|
-
* @property {string} [device_id] - EDC machine Unique Identifier
|
|
385
|
-
* @property {string} request_type - Either resend or cancel
|
|
390
|
+
* @property {string} order_id - Unique order id.
|
|
391
|
+
* @property {string} [device_id] - EDC machine Unique Identifier.
|
|
392
|
+
* @property {string} request_type - Either resend or cancel.
|
|
386
393
|
*/
|
|
387
394
|
/**
|
|
388
395
|
* @typedef LinkStatus
|
|
389
|
-
* @property {string} status - Link action status
|
|
390
|
-
* @property {string} message - Message
|
|
396
|
+
* @property {string} status - Link action status.
|
|
397
|
+
* @property {string} message - Message.
|
|
391
398
|
* @property {boolean} [is_payment_done] - This key specifies payment done
|
|
392
399
|
* status of payment link.
|
|
393
400
|
*/
|
|
@@ -398,24 +405,24 @@ export = PaymentApplicationModel;
|
|
|
398
405
|
*/
|
|
399
406
|
/**
|
|
400
407
|
* @typedef renderHTMLRequest
|
|
401
|
-
* @property {string} [returntype] - Return Type of API
|
|
402
|
-
* @property {string} base64_html - Base64 encoded html string
|
|
408
|
+
* @property {string} [returntype] - Return Type of API.
|
|
409
|
+
* @property {string} base64_html - Base64 encoded html string.
|
|
403
410
|
*/
|
|
404
411
|
/**
|
|
405
412
|
* @typedef renderHTMLResponse
|
|
406
|
-
* @property {string} html - HTML string
|
|
413
|
+
* @property {string} html - HTML string.
|
|
407
414
|
*/
|
|
408
415
|
/**
|
|
409
416
|
* @typedef ValidateVPARequest
|
|
410
|
-
* @property {string} upi_vpa - UPI ID
|
|
411
|
-
* @property {string} [aggregator] - Aggregator slug
|
|
417
|
+
* @property {string} upi_vpa - UPI ID.
|
|
418
|
+
* @property {string} [aggregator] - Aggregator slug.
|
|
412
419
|
*/
|
|
413
420
|
/**
|
|
414
421
|
* @typedef ValidateUPI
|
|
415
|
-
* @property {string} status - VALID or INVALID
|
|
416
|
-
* @property {string} customer_name - Customer Bank
|
|
422
|
+
* @property {string} status - VALID or INVALID.
|
|
423
|
+
* @property {string} customer_name - Customer Bank.
|
|
417
424
|
* @property {boolean} is_valid - Boolean is true or false.
|
|
418
|
-
* @property {string} upi_vpa - UPI ID
|
|
425
|
+
* @property {string} upi_vpa - UPI ID.
|
|
419
426
|
*/
|
|
420
427
|
/**
|
|
421
428
|
* @typedef ValidateVPAResponse
|
|
@@ -424,22 +431,23 @@ export = PaymentApplicationModel;
|
|
|
424
431
|
*/
|
|
425
432
|
/**
|
|
426
433
|
* @typedef CardDetails
|
|
427
|
-
* @property {boolean} status -
|
|
428
|
-
* @property {string} country - Country
|
|
429
|
-
* @property {string} bank_code -
|
|
430
|
-
* @property {string} id -
|
|
431
|
-
* @property {string} [card_exp_year] - Card
|
|
432
|
-
* @property {string} card_brand -
|
|
433
|
-
* @property {string} type -
|
|
434
|
-
* @property {string} card_sub_type -
|
|
435
|
-
* @property {boolean} is_domestic_card -
|
|
436
|
-
* @property {string} [name_on_card] - Name
|
|
437
|
-
* @property {string} [card_exp_month] - Card
|
|
438
|
-
* @property {string} extended_card_type - Extended
|
|
439
|
-
*
|
|
440
|
-
* @property {string}
|
|
441
|
-
* @property {string} [
|
|
442
|
-
* @property {string}
|
|
434
|
+
* @property {boolean} status - Current status of the card.
|
|
435
|
+
* @property {string} country - Country where the card was issued.
|
|
436
|
+
* @property {string} bank_code - Code identifying the bank.
|
|
437
|
+
* @property {string} id - Unique identifier for the record.
|
|
438
|
+
* @property {string} [card_exp_year] - Card's expiration year.
|
|
439
|
+
* @property {string} card_brand - Brand of the card (e.g., Visa, MasterCard).
|
|
440
|
+
* @property {string} type - General type of the card (e.g., debit, credit).
|
|
441
|
+
* @property {string} card_sub_type - Sub-type of the card (e.g., Platinum, Gold).
|
|
442
|
+
* @property {boolean} is_domestic_card - Indicates whether the card is domestic.
|
|
443
|
+
* @property {string} [name_on_card] - Name of the cardholder.
|
|
444
|
+
* @property {string} [card_exp_month] - Card's expiration month.
|
|
445
|
+
* @property {string} extended_card_type - Extended type of the card, providing
|
|
446
|
+
* more specific classification.
|
|
447
|
+
* @property {string} card_object - Object representation of the card.
|
|
448
|
+
* @property {string} [card_token] - Encrypted token representing the card.
|
|
449
|
+
* @property {string} [user] - User associated with the card.
|
|
450
|
+
* @property {string} bank - Bank associated with the card.
|
|
443
451
|
*/
|
|
444
452
|
/**
|
|
445
453
|
* @typedef CardDetailsResponse
|
|
@@ -448,312 +456,314 @@ export = PaymentApplicationModel;
|
|
|
448
456
|
*/
|
|
449
457
|
/**
|
|
450
458
|
* @typedef TransferItemsDetails
|
|
451
|
-
* @property {number} id -
|
|
452
|
-
* @property {string} [display_name] - Beneficiary Display Name
|
|
453
|
-
* @property {string} logo_large - Beneficiary large Logo
|
|
454
|
-
* @property {string} logo_small - Beneficiary small Logo
|
|
455
|
-
* @property {string} name - Beneficiary Name
|
|
459
|
+
* @property {number} id - Id of the transfer item.
|
|
460
|
+
* @property {string} [display_name] - Beneficiary Display Name.
|
|
461
|
+
* @property {string} logo_large - Beneficiary large Logo.
|
|
462
|
+
* @property {string} logo_small - Beneficiary small Logo.
|
|
463
|
+
* @property {string} name - Beneficiary Name.
|
|
456
464
|
*/
|
|
457
465
|
/**
|
|
458
466
|
* @typedef TransferModeDetails
|
|
459
|
-
* @property {TransferItemsDetails[]} [items] - Beneficiary Mode Items
|
|
460
|
-
* @property {string} display_name - Beneficiary Mode Name
|
|
467
|
+
* @property {TransferItemsDetails[]} [items] - Beneficiary Mode Items.
|
|
468
|
+
* @property {string} display_name - Beneficiary Mode Name.
|
|
461
469
|
*/
|
|
462
470
|
/**
|
|
463
471
|
* @typedef TransferModeResponse
|
|
464
|
-
* @property {TransferModeDetails[]} data - Response Object
|
|
472
|
+
* @property {TransferModeDetails[]} data - Response Object.
|
|
465
473
|
*/
|
|
466
474
|
/**
|
|
467
475
|
* @typedef UpdateRefundTransferModeRequest
|
|
468
|
-
* @property {boolean} enable - True for enabling the Transfer Mode
|
|
469
|
-
* @property {string} transfer_mode - Transfer Mode of the Beneficiary to be added
|
|
476
|
+
* @property {boolean} enable - True for enabling the Transfer Mode.
|
|
477
|
+
* @property {string} transfer_mode - Transfer Mode of the Beneficiary to be added.
|
|
470
478
|
*/
|
|
471
479
|
/**
|
|
472
480
|
* @typedef UpdateRefundTransferModeResponse
|
|
473
|
-
* @property {boolean} [success] - Response is successful or not
|
|
481
|
+
* @property {boolean} [success] - Response is successful or not.
|
|
474
482
|
*/
|
|
475
483
|
/**
|
|
476
484
|
* @typedef OrderBeneficiaryDetails
|
|
477
|
-
* @property {string} modified_on - MOdification Date of Beneficiary
|
|
478
|
-
* @property {string} account_no - Account Number
|
|
479
|
-
* @property {string} [mobile] - MObile no of User
|
|
480
|
-
* @property {string} bank_name - Bank Name Of Account
|
|
481
|
-
* @property {string} ifsc_code - Ifsc Code Of Account
|
|
482
|
-
* @property {boolean} is_active - Boolean Flag whether Beneficiary set or not
|
|
483
|
-
* @property {string} beneficiary_id -
|
|
484
|
-
* @property {string} account_holder - Account Holder Name
|
|
485
|
-
* @property {string} email - EMail of User
|
|
486
|
-
* @property {string} [delights_user_name] - User Id Who filled the Beneficiary
|
|
487
|
-
* @property {number} id -
|
|
488
|
-
* @property {string} transfer_mode - Transfer Mode Of Account
|
|
489
|
-
* @property {string} [branch_name] - Branch Name Of Account
|
|
490
|
-
* @property {string} created_on - Creation Date of Beneficiary
|
|
491
|
-
* @property {string} subtitle - SHort Title Of Account
|
|
492
|
-
* @property {string} [comment] - Remarks
|
|
493
|
-
* @property {string} address - Address of User
|
|
494
|
-
* @property {string} title - Title Of Account
|
|
495
|
-
* @property {string} display_name - Display Name Of Account
|
|
485
|
+
* @property {string} modified_on - MOdification Date of Beneficiary.
|
|
486
|
+
* @property {string} account_no - Account Number.
|
|
487
|
+
* @property {string} [mobile] - MObile no of User.
|
|
488
|
+
* @property {string} bank_name - Bank Name Of Account.
|
|
489
|
+
* @property {string} ifsc_code - Ifsc Code Of Account.
|
|
490
|
+
* @property {boolean} is_active - Boolean Flag whether Beneficiary set or not.
|
|
491
|
+
* @property {string} beneficiary_id - Beneficiary Id.
|
|
492
|
+
* @property {string} account_holder - Account Holder Name.
|
|
493
|
+
* @property {string} email - EMail of User.
|
|
494
|
+
* @property {string} [delights_user_name] - User Id Who filled the Beneficiary.
|
|
495
|
+
* @property {number} id - Id of the Order Beneficiary.
|
|
496
|
+
* @property {string} transfer_mode - Transfer Mode Of Account.
|
|
497
|
+
* @property {string} [branch_name] - Branch Name Of Account.
|
|
498
|
+
* @property {string} created_on - Creation Date of Beneficiary.
|
|
499
|
+
* @property {string} subtitle - SHort Title Of Account.
|
|
500
|
+
* @property {string} [comment] - Remarks.
|
|
501
|
+
* @property {string} address - Address of User.
|
|
502
|
+
* @property {string} title - Title Of Account.
|
|
503
|
+
* @property {string} display_name - Display Name Of Account.
|
|
496
504
|
*/
|
|
497
505
|
/**
|
|
498
506
|
* @typedef OrderBeneficiaryResponse
|
|
499
507
|
* @property {boolean} [show_beneficiary_details] - Show beneficiary details or not.
|
|
500
|
-
* @property {OrderBeneficiaryDetails[]} [beneficiaries] - All Beneficiaries Of An Order
|
|
508
|
+
* @property {OrderBeneficiaryDetails[]} [beneficiaries] - All Beneficiaries Of An Order.
|
|
501
509
|
*/
|
|
502
510
|
/**
|
|
503
511
|
* @typedef NotFoundResourceError
|
|
504
|
-
* @property {string} code - Bad Request Data
|
|
505
|
-
* @property {string} description - Not Found
|
|
506
|
-
* @property {boolean} success - Response is successful or not
|
|
512
|
+
* @property {string} code - Bad Request Data.
|
|
513
|
+
* @property {string} description - Not Found.
|
|
514
|
+
* @property {boolean} success - Response is successful or not.
|
|
507
515
|
*/
|
|
508
516
|
/**
|
|
509
517
|
* @typedef IfscCodeResponse
|
|
510
|
-
* @property {string} branch_name - Branch Name Of Account
|
|
511
|
-
* @property {boolean} [success] - Response is successful or not
|
|
512
|
-
* @property {string} bank_name - Bank Name Of Account
|
|
518
|
+
* @property {string} branch_name - Branch Name Of Account.
|
|
519
|
+
* @property {boolean} [success] - Response is successful or not.
|
|
520
|
+
* @property {string} bank_name - Bank Name Of Account.
|
|
513
521
|
*/
|
|
514
522
|
/**
|
|
515
523
|
* @typedef ErrorCodeDescription
|
|
516
|
-
* @property {string} code - Error
|
|
524
|
+
* @property {string} code - Error description code.
|
|
517
525
|
* @property {string} description - Error human understandable description.
|
|
518
|
-
* @property {boolean} success - Response is successful or not
|
|
526
|
+
* @property {boolean} success - Response is successful or not.
|
|
519
527
|
*/
|
|
520
528
|
/**
|
|
521
529
|
* @typedef AddBeneficiaryViaOtpVerificationRequest
|
|
522
|
-
* @property {string} request_id - Request
|
|
523
|
-
* @property {string} hash_key - Hash key of the beneficiary Id
|
|
524
|
-
* @property {string} otp - Otp sent to the given Mobile No
|
|
530
|
+
* @property {string} request_id - Request id.
|
|
531
|
+
* @property {string} hash_key - Hash key of the beneficiary Id.
|
|
532
|
+
* @property {string} otp - Otp sent to the given Mobile No.
|
|
525
533
|
*/
|
|
526
534
|
/**
|
|
527
535
|
* @typedef AddBeneficiaryViaOtpVerificationResponse
|
|
528
|
-
* @property {boolean} [success] - Response is successful or not
|
|
529
|
-
* @property {string} message - Aggregator Response of
|
|
536
|
+
* @property {boolean} [success] - Response is successful or not.
|
|
537
|
+
* @property {string} message - Aggregator Response of beneficiary.
|
|
530
538
|
*/
|
|
531
539
|
/**
|
|
532
540
|
* @typedef WrongOtpError
|
|
533
|
-
* @property {boolean} is_verified_flag -
|
|
534
|
-
* @property {string} description - Wrong OTP Code
|
|
535
|
-
* @property {string} success - Response is successful or not
|
|
541
|
+
* @property {boolean} is_verified_flag - Verified flag.
|
|
542
|
+
* @property {string} description - Wrong OTP Code.
|
|
543
|
+
* @property {string} success - Response is successful or not.
|
|
536
544
|
*/
|
|
537
545
|
/**
|
|
538
546
|
* @typedef BeneficiaryModeDetails
|
|
539
|
-
* @property {string} account_no - Account
|
|
540
|
-
* @property {string} [address] - Address of the User
|
|
541
|
-
* @property {string} mobile -
|
|
542
|
-
* @property {string} bank_name - Bank Name of the Account
|
|
543
|
-
* @property {string} [comment] - Remarks added by The user
|
|
544
|
-
* @property {string} ifsc_code - Ifsc Code of the Account
|
|
545
|
-
* @property {string} [vpa]
|
|
546
|
-
* @property {string} branch_name - Branch Name of the Account
|
|
547
|
-
* @property {string} account_holder - Name of the Account Holder
|
|
548
|
-
* @property {string} [wallet]
|
|
549
|
-
* @property {string} email - Email of the Account Holder
|
|
547
|
+
* @property {string} account_no - Account Number of the Account Holder.
|
|
548
|
+
* @property {string} [address] - Address of the User.
|
|
549
|
+
* @property {string} mobile - Mobile Number of the User.
|
|
550
|
+
* @property {string} bank_name - Bank Name of the Account.
|
|
551
|
+
* @property {string} [comment] - Remarks added by The user.
|
|
552
|
+
* @property {string} ifsc_code - Ifsc Code of the Account.
|
|
553
|
+
* @property {string} [vpa] - VPA of the Account.
|
|
554
|
+
* @property {string} branch_name - Branch Name of the Account.
|
|
555
|
+
* @property {string} account_holder - Name of the Account Holder.
|
|
556
|
+
* @property {string} [wallet] - Wallet of the Account.
|
|
557
|
+
* @property {string} email - Email of the Account Holder.
|
|
550
558
|
*/
|
|
551
559
|
/**
|
|
552
560
|
* @typedef AddBeneficiaryDetailsRequest
|
|
553
561
|
* @property {boolean} delights - True if beneficiary to be added by delights or
|
|
554
|
-
* False if by User
|
|
555
|
-
* @property {string} shipment_id - Shipment Id of the respective Merchant Order Id
|
|
562
|
+
* False if by User.
|
|
563
|
+
* @property {string} shipment_id - Shipment Id of the respective Merchant Order Id.
|
|
556
564
|
* @property {BeneficiaryModeDetails} details
|
|
557
|
-
* @property {string} [otp]
|
|
558
|
-
* @property {string} order_id - Merchant Order Id
|
|
559
|
-
* @property {string} transfer_mode - Transfer Mode of the Beneficiary to be added
|
|
560
|
-
* @property {string} [request_id]
|
|
565
|
+
* @property {string} [otp] - OTP received by customer.
|
|
566
|
+
* @property {string} order_id - Merchant Order Id.
|
|
567
|
+
* @property {string} transfer_mode - Transfer Mode of the Beneficiary to be added.
|
|
568
|
+
* @property {string} [request_id] - Request Id for add benificiary request.
|
|
561
569
|
*/
|
|
562
570
|
/**
|
|
563
571
|
* @typedef RefundAccountResponse
|
|
564
|
-
* @property {boolean} [is_verified_flag]
|
|
572
|
+
* @property {boolean} [is_verified_flag] - Flag for verification of refund.
|
|
565
573
|
* @property {Object} [data] - Refund account data.
|
|
566
574
|
* @property {boolean} success - Success or failure flag.
|
|
567
|
-
* @property {string} message - Response message
|
|
575
|
+
* @property {string} message - Response message.
|
|
568
576
|
*/
|
|
569
577
|
/**
|
|
570
578
|
* @typedef BankDetailsForOTP
|
|
571
|
-
* @property {string} account_no
|
|
572
|
-
* @property {string} bank_name
|
|
573
|
-
* @property {string} ifsc_code
|
|
574
|
-
* @property {string} branch_name
|
|
575
|
-
* @property {string} account_holder
|
|
579
|
+
* @property {string} account_no - Account number of the holder.
|
|
580
|
+
* @property {string} bank_name - Name of the bank.
|
|
581
|
+
* @property {string} ifsc_code - IFSC code of the bank.
|
|
582
|
+
* @property {string} branch_name - Branch name of the bank.
|
|
583
|
+
* @property {string} account_holder - Name of the account holder.
|
|
576
584
|
*/
|
|
577
585
|
/**
|
|
578
586
|
* @typedef AddBeneficiaryDetailsOTPRequest
|
|
579
|
-
* @property {string} order_id
|
|
587
|
+
* @property {string} order_id - Unique identifier for an order.
|
|
580
588
|
* @property {BankDetailsForOTP} details
|
|
581
589
|
*/
|
|
582
590
|
/**
|
|
583
591
|
* @typedef WalletOtpRequest
|
|
584
|
-
* @property {string} country_code - Country Code of the Mobile Number
|
|
585
|
-
* @property {string} mobile - Wallet
|
|
592
|
+
* @property {string} country_code - Country Code of the Mobile Number.
|
|
593
|
+
* @property {string} mobile - Wallet Mobile Number of the User.
|
|
586
594
|
*/
|
|
587
595
|
/**
|
|
588
596
|
* @typedef WalletOtpResponse
|
|
589
|
-
* @property {string} request_id - Request
|
|
597
|
+
* @property {string} request_id - Request Id for wallet otp request.
|
|
590
598
|
* @property {string} is_verified_flag - Boolean Flag whether OTP Validation is
|
|
591
|
-
* already done or not
|
|
592
|
-
* @property {boolean} [success] - Response is successful or not
|
|
599
|
+
* already done or not.
|
|
600
|
+
* @property {boolean} [success] - Response is successful or not.
|
|
593
601
|
*/
|
|
594
602
|
/**
|
|
595
603
|
* @typedef SetDefaultBeneficiaryRequest
|
|
596
|
-
* @property {string} order_id - Merchant Order Id
|
|
597
|
-
* @property {string} beneficiary_id - Beneficiary Hash Id of the beneficiary added
|
|
604
|
+
* @property {string} order_id - Merchant Order Id.
|
|
605
|
+
* @property {string} beneficiary_id - Beneficiary Hash Id of the beneficiary added.
|
|
598
606
|
*/
|
|
599
607
|
/**
|
|
600
608
|
* @typedef SetDefaultBeneficiaryResponse
|
|
601
|
-
* @property {boolean} is_beneficiary_set - Boolean Flag whether Beneficiary set or not
|
|
602
|
-
* @property {boolean} [success] - Response is successful or not
|
|
609
|
+
* @property {boolean} is_beneficiary_set - Boolean Flag whether Beneficiary set or not.
|
|
610
|
+
* @property {boolean} [success] - Response is successful or not.
|
|
603
611
|
*/
|
|
604
612
|
/**
|
|
605
613
|
* @typedef GetPaymentLinkResponse
|
|
606
|
-
* @property {number} status_code - HTTP status code
|
|
607
|
-
* @property {string} [payment_link_current_status] - Status of payment link
|
|
608
|
-
* @property {boolean} success - Successful or failure
|
|
609
|
-
* @property {number} [polling_timeout] - Polling request timeout
|
|
610
|
-
* @property {string} [payment_link_url] - Url of payment link
|
|
611
|
-
* @property {string} [external_order_id] - Merchant order id
|
|
612
|
-
* @property {string} message -
|
|
613
|
-
* @property {string} [merchant_name] - Merchant name
|
|
614
|
-
* @property {number} [amount] - Total value of order
|
|
614
|
+
* @property {number} status_code - HTTP status code.
|
|
615
|
+
* @property {string} [payment_link_current_status] - Status of payment link.
|
|
616
|
+
* @property {boolean} success - Successful or failure.
|
|
617
|
+
* @property {number} [polling_timeout] - Polling request timeout.
|
|
618
|
+
* @property {string} [payment_link_url] - Url of payment link.
|
|
619
|
+
* @property {string} [external_order_id] - Merchant order id.
|
|
620
|
+
* @property {string} message - Detailed message.
|
|
621
|
+
* @property {string} [merchant_name] - Merchant name.
|
|
622
|
+
* @property {number} [amount] - Total value of order.
|
|
615
623
|
*/
|
|
616
624
|
/**
|
|
617
625
|
* @typedef ErrorDescription
|
|
618
|
-
* @property {string} [payment_transaction_id] - Payment transaction id
|
|
619
|
-
* @property {boolean} [expired] - Payment link expired or not
|
|
620
|
-
* @property {string} [merchant_order_id] - Order
|
|
621
|
-
* @property {string} [merchant_name] - Name of merchant that created payment link
|
|
622
|
-
* @property {string} [msg] -
|
|
623
|
-
* @property {boolean} [cancelled] - Payment link is cancelled or not
|
|
624
|
-
* @property {number} [amount] - Amount paid
|
|
625
|
-
* @property {boolean} [invalid_id] - Payment link id is valid or not
|
|
626
|
+
* @property {string} [payment_transaction_id] - Payment transaction id.
|
|
627
|
+
* @property {boolean} [expired] - Payment link expired or not.
|
|
628
|
+
* @property {string} [merchant_order_id] - Merchant Order Id.
|
|
629
|
+
* @property {string} [merchant_name] - Name of merchant that created payment link.
|
|
630
|
+
* @property {string} [msg] - Detailed message.
|
|
631
|
+
* @property {boolean} [cancelled] - Payment link is cancelled or not.
|
|
632
|
+
* @property {number} [amount] - Amount paid.
|
|
633
|
+
* @property {boolean} [invalid_id] - Payment link id is valid or not.
|
|
626
634
|
*/
|
|
627
635
|
/**
|
|
628
636
|
* @typedef ErrorResponse
|
|
629
|
-
* @property {number} status_code - HTTP status code
|
|
637
|
+
* @property {number} status_code - HTTP status code.
|
|
630
638
|
* @property {ErrorDescription} [error]
|
|
631
|
-
* @property {string} message -
|
|
632
|
-
* @property {boolean} success - Successful or failure
|
|
639
|
+
* @property {string} message - Detailed message.
|
|
640
|
+
* @property {boolean} success - Successful or failure.
|
|
633
641
|
*/
|
|
634
642
|
/**
|
|
635
643
|
* @typedef CreatePaymentLinkMeta
|
|
636
|
-
* @property {string} cart_id
|
|
637
|
-
* @property {string} checkout_mode
|
|
638
|
-
*
|
|
639
|
-
* @property {string}
|
|
644
|
+
* @property {string} cart_id - Unique identifier for the shopping cart.
|
|
645
|
+
* @property {string} checkout_mode - Mode of checkout process (e.g., guest,
|
|
646
|
+
* registered user).
|
|
647
|
+
* @property {string} [assign_card_id] - Identifier for the card assigned to the
|
|
648
|
+
* transaction.
|
|
649
|
+
* @property {string} amount - Total amount for the transaction.
|
|
640
650
|
*/
|
|
641
651
|
/**
|
|
642
652
|
* @typedef CreatePaymentLinkRequest
|
|
643
|
-
* @property {string} [description] - Merchant order id
|
|
644
|
-
* @property {string} external_order_id - Merchant order id
|
|
653
|
+
* @property {string} [description] - Merchant order id.
|
|
654
|
+
* @property {string} external_order_id - Merchant order id.
|
|
645
655
|
* @property {string} mobile_number - Mobile number to which the payment link is
|
|
646
|
-
* to be sent
|
|
647
|
-
* @property {number} amount - Total value of order
|
|
656
|
+
* to be sent.
|
|
657
|
+
* @property {number} amount - Total value of order.
|
|
648
658
|
* @property {CreatePaymentLinkMeta} meta
|
|
649
|
-
* @property {string} email - Email to which the payment link is to be sent
|
|
659
|
+
* @property {string} email - Email to which the payment link is to be sent.
|
|
650
660
|
*/
|
|
651
661
|
/**
|
|
652
662
|
* @typedef CreatePaymentLinkResponse
|
|
653
|
-
* @property {number} status_code - HTTP status code
|
|
654
|
-
* @property {boolean} success - Successful or failure
|
|
655
|
-
* @property {number} [polling_timeout] - Polling request timeout
|
|
656
|
-
* @property {string} [payment_link_url] - Url of payment link
|
|
657
|
-
* @property {string} message -
|
|
658
|
-
* @property {string} [payment_link_id] - Unique id of payment link
|
|
663
|
+
* @property {number} status_code - HTTP status code.
|
|
664
|
+
* @property {boolean} success - Successful or failure.
|
|
665
|
+
* @property {number} [polling_timeout] - Polling request timeout.
|
|
666
|
+
* @property {string} [payment_link_url] - Url of payment link.
|
|
667
|
+
* @property {string} message - Detailed message.
|
|
668
|
+
* @property {string} [payment_link_id] - Unique id of payment link.
|
|
659
669
|
*/
|
|
660
670
|
/**
|
|
661
671
|
* @typedef CancelOrResendPaymentLinkRequest
|
|
662
|
-
* @property {string} payment_link_id - Unique id of payment link
|
|
672
|
+
* @property {string} payment_link_id - Unique id of payment link.
|
|
663
673
|
*/
|
|
664
674
|
/**
|
|
665
675
|
* @typedef ResendPaymentLinkResponse
|
|
666
|
-
* @property {number} status_code - HTTP status code
|
|
667
|
-
* @property {number} [polling_timeout] - Polling request timeout
|
|
668
|
-
* @property {boolean} success - Successful or failure
|
|
669
|
-
* @property {string} message -
|
|
676
|
+
* @property {number} status_code - HTTP status code.
|
|
677
|
+
* @property {number} [polling_timeout] - Polling request timeout.
|
|
678
|
+
* @property {boolean} success - Successful or failure.
|
|
679
|
+
* @property {string} message - Detailed message.
|
|
670
680
|
*/
|
|
671
681
|
/**
|
|
672
682
|
* @typedef CancelPaymentLinkResponse
|
|
673
|
-
* @property {number} status_code - HTTP status code
|
|
674
|
-
* @property {boolean} success - Successful or failure
|
|
675
|
-
* @property {string} message -
|
|
683
|
+
* @property {number} status_code - HTTP status code.
|
|
684
|
+
* @property {boolean} success - Successful or failure.
|
|
685
|
+
* @property {string} message - Detailed message.
|
|
676
686
|
*/
|
|
677
687
|
/**
|
|
678
688
|
* @typedef PollingPaymentLinkResponse
|
|
679
|
-
* @property {string} [status] - Status of payment link
|
|
680
|
-
* @property {number} [status_code] - HTTP status code
|
|
681
|
-
* @property {boolean} [success] - Successful or failure
|
|
682
|
-
* @property {number} [http_status] - HTTP status code
|
|
683
|
-
* @property {string} [message] -
|
|
684
|
-
* @property {string} [order_id] - Fynd order id
|
|
685
|
-
* @property {string} [redirect_url] - Url to redirect to
|
|
686
|
-
* @property {string} [payment_link_id] - Payment link id
|
|
687
|
-
* @property {string} [aggregator_name] - Aggregator name
|
|
688
|
-
* @property {number} [amount] -
|
|
689
|
+
* @property {string} [status] - Status of payment link.
|
|
690
|
+
* @property {number} [status_code] - HTTP status code.
|
|
691
|
+
* @property {boolean} [success] - Successful or failure.
|
|
692
|
+
* @property {number} [http_status] - HTTP status code.
|
|
693
|
+
* @property {string} [message] - Detailed message.
|
|
694
|
+
* @property {string} [order_id] - Fynd order id.
|
|
695
|
+
* @property {string} [redirect_url] - Url to redirect to.
|
|
696
|
+
* @property {string} [payment_link_id] - Payment link id.
|
|
697
|
+
* @property {string} [aggregator_name] - Aggregator name.
|
|
698
|
+
* @property {number} [amount] - Total amount for the transaction.
|
|
689
699
|
*/
|
|
690
700
|
/**
|
|
691
701
|
* @typedef PaymentMethodsMeta
|
|
692
|
-
* @property {string} merchant_code - Merchant code
|
|
693
|
-
* @property {string} payment_gateway - Payment gateway name
|
|
694
|
-
* @property {string} payment_identifier - Payment identifier
|
|
702
|
+
* @property {string} merchant_code - Merchant code.
|
|
703
|
+
* @property {string} payment_gateway - Payment gateway name.
|
|
704
|
+
* @property {string} payment_identifier - Payment identifier.
|
|
695
705
|
*/
|
|
696
706
|
/**
|
|
697
707
|
* @typedef CreateOrderUserPaymentMethods
|
|
698
|
-
* @property {string} name - Payment mode name
|
|
699
|
-
* @property {string} mode - Payment mode
|
|
708
|
+
* @property {string} name - Payment mode name.
|
|
709
|
+
* @property {string} mode - Payment mode.
|
|
700
710
|
* @property {PaymentMethodsMeta} meta
|
|
701
711
|
*/
|
|
702
712
|
/**
|
|
703
713
|
* @typedef CreateOrderUserRequest
|
|
704
|
-
* @property {string} failure_callback_url - Failure page url
|
|
705
|
-
* @property {string} currency - Currency
|
|
706
|
-
* @property {string} payment_link_id - Unique id of payment link
|
|
714
|
+
* @property {string} failure_callback_url - Failure page url.
|
|
715
|
+
* @property {string} currency - Currency of the transaction.
|
|
716
|
+
* @property {string} payment_link_id - Unique id of payment link.
|
|
707
717
|
* @property {CreateOrderUserPaymentMethods} payment_methods
|
|
708
|
-
* @property {string} success_callback_url - Success page url
|
|
709
|
-
* @property {Object} [meta] - Meta
|
|
718
|
+
* @property {string} success_callback_url - Success page url.
|
|
719
|
+
* @property {Object} [meta] - Meta details.
|
|
710
720
|
*/
|
|
711
721
|
/**
|
|
712
722
|
* @typedef CreateOrderUserData
|
|
713
|
-
* @property {string} [method] - Method
|
|
714
|
-
* @property {string} [aggregator] - Aggregator name
|
|
715
|
-
* @property {string} [customer_id] - Aggregator customer id
|
|
716
|
-
* @property {string} [contact] - Mobile number
|
|
717
|
-
* @property {string} [merchant_order_id] - Merchant order id
|
|
718
|
-
* @property {string} [order_id] - Aggregator order id
|
|
719
|
-
* @property {string} [currency] - Currency
|
|
720
|
-
* @property {string} [callback_url] - Callback url for aggregator
|
|
721
|
-
* @property {number} [amount] -
|
|
722
|
-
* @property {string} [email] - Email
|
|
723
|
+
* @property {string} [method] - Method details.
|
|
724
|
+
* @property {string} [aggregator] - Aggregator name.
|
|
725
|
+
* @property {string} [customer_id] - Aggregator customer id.
|
|
726
|
+
* @property {string} [contact] - Mobile number.
|
|
727
|
+
* @property {string} [merchant_order_id] - Merchant order id.
|
|
728
|
+
* @property {string} [order_id] - Aggregator order id.
|
|
729
|
+
* @property {string} [currency] - Currency of the transaction.
|
|
730
|
+
* @property {string} [callback_url] - Callback url for aggregator.
|
|
731
|
+
* @property {number} [amount] - Total amount for the transaction.
|
|
732
|
+
* @property {string} [email] - Email.
|
|
723
733
|
*/
|
|
724
734
|
/**
|
|
725
735
|
* @typedef CreateOrderUserResponse
|
|
726
|
-
* @property {number} status_code - HTTP status code
|
|
727
|
-
* @property {boolean} success - Successful or failure
|
|
736
|
+
* @property {number} status_code - HTTP status code.
|
|
737
|
+
* @property {boolean} success - Successful or failure.
|
|
728
738
|
* @property {CreateOrderUserData} [data]
|
|
729
|
-
* @property {string} message -
|
|
730
|
-
* @property {string} [order_id] - Merchant order id
|
|
731
|
-
* @property {string} [callback_url] - Callback url for aggregator
|
|
732
|
-
* @property {string} [payment_confirm_url] - Payment confirm url for aggregator
|
|
739
|
+
* @property {string} message - Detailed message.
|
|
740
|
+
* @property {string} [order_id] - Merchant order id.
|
|
741
|
+
* @property {string} [callback_url] - Callback url for aggregator.
|
|
742
|
+
* @property {string} [payment_confirm_url] - Payment confirm url for aggregator.
|
|
733
743
|
*/
|
|
734
744
|
/**
|
|
735
745
|
* @typedef BalanceDetails
|
|
736
|
-
* @property {string} [formatted_value] -
|
|
737
|
-
* @property {string} [currency] - Currency Code
|
|
738
|
-
* @property {number} [value] - Payment amount
|
|
746
|
+
* @property {string} [formatted_value] - Formatted Amount with currency symbol.
|
|
747
|
+
* @property {string} [currency] - Currency Code.
|
|
748
|
+
* @property {number} [value] - Payment amount.
|
|
739
749
|
*/
|
|
740
750
|
/**
|
|
741
751
|
* @typedef CreditSummary
|
|
742
752
|
* @property {BalanceDetails} [total_due_amount]
|
|
743
|
-
* @property {string} [status] - Customer Credit status
|
|
753
|
+
* @property {string} [status] - Customer Credit status.
|
|
744
754
|
* @property {BalanceDetails} [limit]
|
|
745
|
-
* @property {string} [credit_line_id] - ID at Credit aggregator
|
|
755
|
+
* @property {string} [credit_line_id] - ID at Credit aggregator end.
|
|
746
756
|
* @property {BalanceDetails} [amount_available]
|
|
747
757
|
* @property {BalanceDetails} [due_amount]
|
|
748
|
-
* @property {string} [due_date] - Due date for repayment
|
|
758
|
+
* @property {string} [due_date] - Due date for repayment.
|
|
749
759
|
* @property {BalanceDetails} [balance]
|
|
750
|
-
* @property {string} [status_message] - Message to customer
|
|
751
|
-
* @property {string} [repayment_url] - Url for repayment
|
|
760
|
+
* @property {string} [status_message] - Message to customer.
|
|
761
|
+
* @property {string} [repayment_url] - Url for repayment.
|
|
752
762
|
* @property {string} [soa_url] - Statement of accounts. Show payment history.
|
|
753
|
-
* @property {boolean} [is_eligible_for_txn] -
|
|
754
|
-
* @property {string} [merchant_customer_ref_id] - Unique aggregator customer id
|
|
755
|
-
* @property {string} [buyer_status] - Status from Credit aggregator
|
|
756
|
-
* @property {string} [activation_url] - Url for activation
|
|
763
|
+
* @property {boolean} [is_eligible_for_txn] - Eligibility flag to complete transaction.
|
|
764
|
+
* @property {string} [merchant_customer_ref_id] - Unique aggregator customer id.
|
|
765
|
+
* @property {string} [buyer_status] - Status from Credit aggregator end.
|
|
766
|
+
* @property {string} [activation_url] - Url for activation.
|
|
757
767
|
*/
|
|
758
768
|
/**
|
|
759
769
|
* @typedef CustomerCreditSummaryResponse
|
|
@@ -762,7 +772,7 @@ export = PaymentApplicationModel;
|
|
|
762
772
|
*/
|
|
763
773
|
/**
|
|
764
774
|
* @typedef RedirectURL
|
|
765
|
-
* @property {boolean} status - Aggregator
|
|
775
|
+
* @property {boolean} status - Aggregator Operation is successful or not.
|
|
766
776
|
* @property {string} signup_url - URL to which the user may redirect.
|
|
767
777
|
*/
|
|
768
778
|
/**
|
|
@@ -783,82 +793,86 @@ export = PaymentApplicationModel;
|
|
|
783
793
|
*/
|
|
784
794
|
/**
|
|
785
795
|
* @typedef KYCAddress
|
|
786
|
-
* @property {string} city - City
|
|
787
|
-
* @property {string} [addressline2] -
|
|
788
|
-
* @property {string} state - State
|
|
789
|
-
* @property {string} [ownership_type] -
|
|
790
|
-
*
|
|
791
|
-
* @property {string}
|
|
792
|
-
* @property {string}
|
|
796
|
+
* @property {string} city - City of the KYC address.
|
|
797
|
+
* @property {string} [addressline2] - Second line of the address.
|
|
798
|
+
* @property {string} state - State of the KYC address.
|
|
799
|
+
* @property {string} [ownership_type] - Type of ownership for the address
|
|
800
|
+
* (e.g., rented, owned).
|
|
801
|
+
* @property {string} pincode - Postal code of the address.
|
|
802
|
+
* @property {string} [land_mark] - Landmark near the address.
|
|
803
|
+
* @property {string} addressline1 - First line of the address.
|
|
793
804
|
*/
|
|
794
805
|
/**
|
|
795
806
|
* @typedef UserPersonalInfoInDetails
|
|
796
|
-
* @property {string} first_name - First
|
|
797
|
-
* @property {string} [voter_id] - Voter ID
|
|
798
|
-
* @property {string} [gender] - Gender
|
|
799
|
-
* @property {string} dob -
|
|
800
|
-
* @property {string} [passport] - Passport
|
|
801
|
-
* @property {string} [fathers_name] - Father's
|
|
802
|
-
* @property {string} [mothers_name] - Mother's
|
|
803
|
-
* @property {string} [middle_name] - Middle
|
|
804
|
-
* @property {string} [last_name] - Last
|
|
805
|
-
* @property {string} [pan] -
|
|
806
|
-
* @property {string} [driving_license] -
|
|
807
|
-
* @property {boolean} email_verified -
|
|
807
|
+
* @property {string} first_name - First name of the individual.
|
|
808
|
+
* @property {string} [voter_id] - Voter ID number.
|
|
809
|
+
* @property {string} [gender] - Gender of the individual.
|
|
810
|
+
* @property {string} dob - Date of birth of the individual.
|
|
811
|
+
* @property {string} [passport] - Passport number.
|
|
812
|
+
* @property {string} [fathers_name] - Father's name.
|
|
813
|
+
* @property {string} [mothers_name] - Mother's name.
|
|
814
|
+
* @property {string} [middle_name] - Middle name of the individual.
|
|
815
|
+
* @property {string} [last_name] - Last name of the individual.
|
|
816
|
+
* @property {string} [pan] - Permanent Account Number (PAN).
|
|
817
|
+
* @property {string} [driving_license] - Driving license number.
|
|
818
|
+
* @property {boolean} email_verified - Indicates whether the email is verified.
|
|
808
819
|
* @property {KYCAddress} address_as_per_id
|
|
809
|
-
* @property {boolean} mobile_verified -
|
|
810
|
-
* @property {string} phone -
|
|
811
|
-
* @property {string} [email] - Email
|
|
820
|
+
* @property {boolean} mobile_verified - Indicates whether the mobile number is verified.
|
|
821
|
+
* @property {string} phone - Phone number.
|
|
822
|
+
* @property {string} [email] - Email address.
|
|
812
823
|
*/
|
|
813
824
|
/**
|
|
814
825
|
* @typedef MarketplaceInfo
|
|
815
|
-
* @property {string} [date_of_joining] - Date of joining
|
|
816
|
-
* @property {string} name - Name of store
|
|
817
|
-
* @property {string} membership_id - Merchant id
|
|
826
|
+
* @property {string} [date_of_joining] - Date of joining.
|
|
827
|
+
* @property {string} name - Name of store.
|
|
828
|
+
* @property {string} membership_id - Merchant id.
|
|
818
829
|
*/
|
|
819
830
|
/**
|
|
820
831
|
* @typedef BusinessDetails
|
|
821
|
-
* @property {string} [business_ownership_type] -
|
|
822
|
-
*
|
|
823
|
-
* @property {string} [
|
|
824
|
-
* @property {string} [
|
|
825
|
-
* @property {string} [
|
|
826
|
-
* @property {
|
|
827
|
-
* @property {
|
|
828
|
-
*
|
|
829
|
-
* @property {string} [
|
|
830
|
-
*
|
|
832
|
+
* @property {string} [business_ownership_type] - Type of business ownership
|
|
833
|
+
* (e.g., sole proprietorship, partnership).
|
|
834
|
+
* @property {string} [vintage] - Age or duration of the business.
|
|
835
|
+
* @property {string} [gstin] - Goods and Services Tax Identification Number.
|
|
836
|
+
* @property {string} [pan] - Permanent Account Number of the business.
|
|
837
|
+
* @property {string} [entity_type] - Type of legal entity (e.g., corporation, LLC).
|
|
838
|
+
* @property {Object} [shop_and_establishment] - Shop and Establishment
|
|
839
|
+
* registration details.
|
|
840
|
+
* @property {string} [fssai] - Food Safety and Standards Authority of India
|
|
841
|
+
* registration number.
|
|
842
|
+
* @property {string} [fda] - Food and Drug Administration registration number.
|
|
843
|
+
* @property {string} [business_type] - Type of business (e.g., retail, wholesale).
|
|
844
|
+
* @property {string} [name] - Name of the business.
|
|
831
845
|
* @property {KYCAddress} [address]
|
|
832
846
|
*/
|
|
833
847
|
/**
|
|
834
848
|
* @typedef DeviceDetails
|
|
835
|
-
* @property {string} [identification_number] - IP
|
|
836
|
-
* @property {string} [identifier_type] - Static value = ip
|
|
837
|
-
* @property {string} [device_model] - Device Model
|
|
838
|
-
* @property {string} [device_make] - Device maker
|
|
839
|
-
* @property {string} [device_type] - Device Type(E.g. Mobile)
|
|
840
|
-
* @property {string} [os] - OS Name
|
|
841
|
-
* @property {string} [os_version] - OS Version
|
|
849
|
+
* @property {string} [identification_number] - IP.
|
|
850
|
+
* @property {string} [identifier_type] - Static value = ip.
|
|
851
|
+
* @property {string} [device_model] - Device Model.
|
|
852
|
+
* @property {string} [device_make] - Device maker.
|
|
853
|
+
* @property {string} [device_type] - Device Type(E.g. Mobile).
|
|
854
|
+
* @property {string} [os] - OS Name.
|
|
855
|
+
* @property {string} [os_version] - OS Version.
|
|
842
856
|
*/
|
|
843
857
|
/**
|
|
844
858
|
* @typedef CustomerOnboardingRequest
|
|
845
859
|
* @property {UserPersonalInfoInDetails} [personal_info]
|
|
846
|
-
* @property {string} [mcc] -
|
|
847
|
-
* @property {string} aggregator -
|
|
860
|
+
* @property {string} [mcc] - Merchant Category Code, indicating the type of business.
|
|
861
|
+
* @property {string} aggregator - Payment aggregator handling the transaction.
|
|
848
862
|
* @property {MarketplaceInfo} [marketplace_info]
|
|
849
|
-
* @property {string} source -
|
|
863
|
+
* @property {string} source - Callback url.
|
|
850
864
|
* @property {BusinessDetails} [business_info]
|
|
851
865
|
* @property {DeviceDetails} [device]
|
|
852
866
|
*/
|
|
853
867
|
/**
|
|
854
868
|
* @typedef OnboardSummary
|
|
855
869
|
* @property {string} [redirect_url] - URL to which the user may redirect.
|
|
856
|
-
* @property {Object} [session] - User Session
|
|
857
|
-
* @property {boolean} status - Transaction status
|
|
858
|
-
* @property {string} [status_remark] -
|
|
859
|
-
* @property {boolean} [is_eligible_for_txn] - Whether is eligible for transaction
|
|
860
|
-
* @property {string} [merchant_customer_ref_id] - Rupifi customer ID
|
|
861
|
-
* @property {string} [activation_url] - Url for activation
|
|
870
|
+
* @property {Object} [session] - User Session.
|
|
871
|
+
* @property {boolean} status - Transaction status.
|
|
872
|
+
* @property {string} [status_remark] - Description of status.
|
|
873
|
+
* @property {boolean} [is_eligible_for_txn] - Whether is eligible for transaction.
|
|
874
|
+
* @property {string} [merchant_customer_ref_id] - Rupifi customer ID.
|
|
875
|
+
* @property {string} [activation_url] - Url for activation.
|
|
862
876
|
*/
|
|
863
877
|
/**
|
|
864
878
|
* @typedef CustomerOnboardingResponse
|
|
@@ -867,29 +881,29 @@ export = PaymentApplicationModel;
|
|
|
867
881
|
*/
|
|
868
882
|
/**
|
|
869
883
|
* @typedef OutstandingOrderDetailsResponse
|
|
870
|
-
* @property {number} status_code - HTTP Status code
|
|
871
|
-
* @property {Object[]} [data] - Dict containing the outstanding order details
|
|
884
|
+
* @property {number} status_code - HTTP Status code.
|
|
885
|
+
* @property {Object[]} [data] - Dict containing the outstanding order details.
|
|
872
886
|
* @property {boolean} success - Response is successful or not.
|
|
873
|
-
* @property {string} [message] - Message
|
|
887
|
+
* @property {string} [message] - Message.
|
|
874
888
|
*/
|
|
875
889
|
/**
|
|
876
890
|
* @typedef PaidOrderDetailsResponse
|
|
877
|
-
* @property {number} status_code - HTTP Status code
|
|
878
|
-
* @property {Object[]} [data] - Dict containing the paid order details
|
|
891
|
+
* @property {number} status_code - HTTP Status code.
|
|
892
|
+
* @property {Object[]} [data] - Dict containing the paid order details.
|
|
879
893
|
* @property {boolean} success - Response is successful or not.
|
|
880
|
-
* @property {string} [message] - Message
|
|
894
|
+
* @property {string} [message] - Message.
|
|
881
895
|
*/
|
|
882
896
|
/**
|
|
883
897
|
* @typedef DeleteRefundAccountResponse
|
|
884
|
-
* @property {boolean} success - Success/Failure of the deleted beneficiary
|
|
885
|
-
* @property {string} message - Message
|
|
898
|
+
* @property {boolean} success - Success/Failure of the deleted beneficiary.
|
|
899
|
+
* @property {string} message - Message.
|
|
886
900
|
*/
|
|
887
901
|
/**
|
|
888
902
|
* @typedef RefundOptionsDetails
|
|
889
|
-
* @property {string} display_name - Refund option display name
|
|
890
|
-
* @property {number} id - Refund ID. It will be unique identifier
|
|
891
|
-
* @property {boolean} [is_active] - Refund option is active or not
|
|
892
|
-
* @property {string} name - Refund option name
|
|
903
|
+
* @property {string} display_name - Refund option display name.
|
|
904
|
+
* @property {number} id - Refund ID. It will be unique identifier.
|
|
905
|
+
* @property {boolean} [is_active] - Refund option is active or not.
|
|
906
|
+
* @property {string} name - Refund option name.
|
|
893
907
|
*/
|
|
894
908
|
/**
|
|
895
909
|
* @typedef RefundOptions
|
|
@@ -899,59 +913,59 @@ export = PaymentApplicationModel;
|
|
|
899
913
|
* @typedef OfflineRefundOptions
|
|
900
914
|
* @property {RefundOptionsDetails} items - List of all refund options.
|
|
901
915
|
* @property {string[]} payment_modes - List of all offline payment options. MOP
|
|
902
|
-
* Code value
|
|
916
|
+
* Code value.
|
|
903
917
|
*/
|
|
904
918
|
/**
|
|
905
919
|
* @typedef RefundOptionResponse
|
|
906
920
|
* @property {OfflineRefundOptions} offline_refund_options - Available offline
|
|
907
|
-
* refund options data
|
|
908
|
-
* @property {boolean} success - Success/Failure Of response
|
|
909
|
-
* @property {RefundOptions} refund_options - Available refund options data
|
|
921
|
+
* refund options data.
|
|
922
|
+
* @property {boolean} success - Success/Failure Of response.
|
|
923
|
+
* @property {RefundOptions} refund_options - Available refund options data.
|
|
910
924
|
*/
|
|
911
925
|
/**
|
|
912
926
|
* @typedef SelectedRefundOptionResponse
|
|
913
|
-
* @property {Object} transfer_mode - Selected transfer mode for given shipment
|
|
914
|
-
* @property {string} shipment_id -
|
|
915
|
-
* @property {string} message -
|
|
916
|
-
* @property {boolean} success -
|
|
927
|
+
* @property {Object} transfer_mode - Selected transfer mode for given shipment.
|
|
928
|
+
* @property {string} shipment_id - ID of the shipment.
|
|
929
|
+
* @property {string} message - Detailed message.
|
|
930
|
+
* @property {boolean} success - Whether refund is successful or not.
|
|
917
931
|
*/
|
|
918
932
|
/**
|
|
919
933
|
* @typedef WalletBeneficiaryDetails
|
|
920
|
-
* @property {string} beneficiary_id -
|
|
921
|
-
* @property {string} modified_on - MOdification Date of Beneficiary
|
|
922
|
-
* @property {string} display_name - Display Name Of Account
|
|
923
|
-
* @property {number} id -
|
|
924
|
-
* @property {string} subtitle - SHort Title Of Account
|
|
925
|
-
* @property {string} transfer_mode - Transfer Mode Of Account
|
|
926
|
-
* @property {string} [mobile] - MObile no of User
|
|
927
|
-
* @property {boolean} is_active - Boolean Flag whether Beneficiary set or not
|
|
928
|
-
* @property {string} created_on - Creation Date of Beneficiary
|
|
929
|
-
* @property {string} address - Address of User
|
|
930
|
-
* @property {string} title - Title Of Account
|
|
931
|
-
* @property {string} wallet_address - Bank Name Of Account
|
|
932
|
-
* @property {string} [comment] - Remarks
|
|
933
|
-
* @property {string} [wallet] - Branch Name Of Account
|
|
934
|
-
* @property {string} email - EMail of User
|
|
935
|
-
* @property {string} [delights_user_name] - User Id Who filled the Beneficiary
|
|
934
|
+
* @property {string} beneficiary_id - Beneficiary Id.
|
|
935
|
+
* @property {string} modified_on - MOdification Date of Beneficiary.
|
|
936
|
+
* @property {string} display_name - Display Name Of Account.
|
|
937
|
+
* @property {number} id - Id of the wallet beneficiary.
|
|
938
|
+
* @property {string} subtitle - SHort Title Of Account.
|
|
939
|
+
* @property {string} transfer_mode - Transfer Mode Of Account.
|
|
940
|
+
* @property {string} [mobile] - MObile no of User.
|
|
941
|
+
* @property {boolean} is_active - Boolean Flag whether Beneficiary set or not.
|
|
942
|
+
* @property {string} created_on - Creation Date of Beneficiary.
|
|
943
|
+
* @property {string} address - Address of User.
|
|
944
|
+
* @property {string} title - Title Of Account.
|
|
945
|
+
* @property {string} wallet_address - Bank Name Of Account.
|
|
946
|
+
* @property {string} [comment] - Remarks.
|
|
947
|
+
* @property {string} [wallet] - Branch Name Of Account.
|
|
948
|
+
* @property {string} email - EMail of User.
|
|
949
|
+
* @property {string} [delights_user_name] - User Id Who filled the Beneficiary.
|
|
936
950
|
*/
|
|
937
951
|
/**
|
|
938
952
|
* @typedef UpiBeneficiaryDetails
|
|
939
|
-
* @property {string} beneficiary_id -
|
|
940
|
-
* @property {string} modified_on - MOdification Date of Beneficiary
|
|
941
|
-
* @property {string} display_name - Display Name Of Account
|
|
942
|
-
* @property {number} id -
|
|
943
|
-
* @property {string} subtitle - SHort Title Of Account
|
|
944
|
-
* @property {string} transfer_mode - Transfer Mode Of Account
|
|
945
|
-
* @property {string} [vpa] - Branch Name Of Account
|
|
946
|
-
* @property {string} [mobile] - Mobile no of User
|
|
947
|
-
* @property {string} vpa_address - Bank Name Of Account
|
|
948
|
-
* @property {string} created_on - Creation Date of Beneficiary
|
|
949
|
-
* @property {string} address - Address of User
|
|
950
|
-
* @property {string} title - Title Of Account
|
|
951
|
-
* @property {string} [comment] - Remarks
|
|
952
|
-
* @property {boolean} is_active - Boolean Flag whether Beneficiary set or not
|
|
953
|
-
* @property {string} email - EMail of User
|
|
954
|
-
* @property {string} [delights_user_name] - User Id Who filled the Beneficiary
|
|
953
|
+
* @property {string} beneficiary_id - Beneficiary Id.
|
|
954
|
+
* @property {string} modified_on - MOdification Date of Beneficiary.
|
|
955
|
+
* @property {string} display_name - Display Name Of Account.
|
|
956
|
+
* @property {number} id - Id of the upi beneficiary.
|
|
957
|
+
* @property {string} subtitle - SHort Title Of Account.
|
|
958
|
+
* @property {string} transfer_mode - Transfer Mode Of Account.
|
|
959
|
+
* @property {string} [vpa] - Branch Name Of Account.
|
|
960
|
+
* @property {string} [mobile] - Mobile no of User.
|
|
961
|
+
* @property {string} vpa_address - Bank Name Of Account.
|
|
962
|
+
* @property {string} created_on - Creation Date of Beneficiary.
|
|
963
|
+
* @property {string} address - Address of User.
|
|
964
|
+
* @property {string} title - Title Of Account.
|
|
965
|
+
* @property {string} [comment] - Remarks.
|
|
966
|
+
* @property {boolean} is_active - Boolean Flag whether Beneficiary set or not.
|
|
967
|
+
* @property {string} email - EMail of User.
|
|
968
|
+
* @property {string} [delights_user_name] - User Id Who filled the Beneficiary.
|
|
955
969
|
*/
|
|
956
970
|
/**
|
|
957
971
|
* @typedef BeneficiaryRefundOptions
|
|
@@ -965,89 +979,91 @@ export = PaymentApplicationModel;
|
|
|
965
979
|
* @property {boolean} show_beneficiary_details - Show Beneficiary details on UI or not.
|
|
966
980
|
* @property {BeneficiaryRefundOptions} data - Beneficiary Data for Bank
|
|
967
981
|
* account, UPI and Wallets.
|
|
968
|
-
* @property {Object} limit - Max Limit for adding bank account, UPI and wallet
|
|
982
|
+
* @property {Object} limit - Max Limit for adding bank account, UPI and wallet.
|
|
969
983
|
*/
|
|
970
984
|
/**
|
|
971
985
|
* @typedef ValidateValidateAddressRequest
|
|
972
|
-
* @property {string} [ifsc_code] - IFSC Code
|
|
973
|
-
* @property {string} [upi_vpa] - VPA Address
|
|
974
|
-
* @property {string} [aggregator] - Aggregator Name
|
|
986
|
+
* @property {string} [ifsc_code] - IFSC Code.
|
|
987
|
+
* @property {string} [upi_vpa] - VPA Address.
|
|
988
|
+
* @property {string} [aggregator] - Aggregator Name.
|
|
975
989
|
*/
|
|
976
990
|
/**
|
|
977
991
|
* @typedef VPADetails
|
|
978
|
-
* @property {boolean} is_valid - Is VPA valid or not
|
|
979
|
-
* @property {string} upi_vpa - VPA address
|
|
980
|
-
* @property {string} status - VPA validation message
|
|
981
|
-
* @property {string} customer_name - VPA Customer Name
|
|
992
|
+
* @property {boolean} is_valid - Is VPA valid or not.
|
|
993
|
+
* @property {string} upi_vpa - VPA address.
|
|
994
|
+
* @property {string} status - VPA validation message.
|
|
995
|
+
* @property {string} customer_name - VPA Customer Name.
|
|
982
996
|
*/
|
|
983
997
|
/**
|
|
984
998
|
* @typedef ValidateValidateAddressResponse
|
|
985
999
|
* @property {VPADetails} [upi] - UPI validation details.
|
|
986
|
-
* @property {boolean} success -
|
|
987
|
-
* @property {Object} [ifsc] - IFSC details response data
|
|
1000
|
+
* @property {boolean} success - Whether address validation is successful or not.
|
|
1001
|
+
* @property {Object} [ifsc] - IFSC details response data.
|
|
988
1002
|
*/
|
|
989
1003
|
/**
|
|
990
1004
|
* @typedef PaymentMethodsMetaOrder
|
|
991
|
-
* @property {string} merchant_code - Merchant code
|
|
992
|
-
* @property {string} payment_gateway - Payment gateway name
|
|
993
|
-
* @property {string} payment_identifier - Payment identifier
|
|
1005
|
+
* @property {string} merchant_code - Merchant code.
|
|
1006
|
+
* @property {string} payment_gateway - Payment gateway name.
|
|
1007
|
+
* @property {string} payment_identifier - Payment identifier.
|
|
994
1008
|
*/
|
|
995
1009
|
/**
|
|
996
1010
|
* @typedef PaymentOrderMethods
|
|
997
|
-
* @property {number} amount - Amount to be collected
|
|
998
|
-
* @property {string} [payment] - Payment type i.e. Required / Blocked
|
|
999
|
-
* @property {string} mode - Payment mode
|
|
1011
|
+
* @property {number} amount - Amount to be collected.
|
|
1012
|
+
* @property {string} [payment] - Payment type i.e. Required / Blocked.
|
|
1013
|
+
* @property {string} mode - Payment mode.
|
|
1000
1014
|
* @property {PaymentMethodsMetaOrder} meta
|
|
1001
|
-
* @property {string} name - Payment mode name
|
|
1015
|
+
* @property {string} name - Payment mode name.
|
|
1002
1016
|
*/
|
|
1003
1017
|
/**
|
|
1004
1018
|
* @typedef PaymentOrderRequest
|
|
1005
|
-
* @property {PaymentOrderMethods[]} [payment_methods]
|
|
1006
|
-
* @property {string} order_id - Order id
|
|
1007
|
-
* @property {string} [shipment_id] - Shipment_id
|
|
1019
|
+
* @property {PaymentOrderMethods[]} [payment_methods] - All payment methods for order.
|
|
1020
|
+
* @property {string} order_id - Order id.
|
|
1021
|
+
* @property {string} [shipment_id] - Shipment_id.
|
|
1008
1022
|
*/
|
|
1009
1023
|
/**
|
|
1010
1024
|
* @typedef PaymentOrderData
|
|
1011
|
-
* @property {number} [amount] - Amount
|
|
1012
|
-
* @property {string} [aggregator] - Aggregator name
|
|
1013
|
-
* @property {string} [callback_url] - Callback url for aggregator
|
|
1014
|
-
* @property {string} [order_id] - Aggregator order id
|
|
1015
|
-
* @property {string} [customer_id] - Aggregator customer id
|
|
1016
|
-
* @property {string} [merchant_order_id] - Merchant order id
|
|
1017
|
-
* @property {string} [currency] - Currency
|
|
1018
|
-
* @property {string} [email] - Email
|
|
1019
|
-
* @property {string} [contact] -
|
|
1020
|
-
* @property {string} [method] - Method
|
|
1025
|
+
* @property {number} [amount] - Amount.
|
|
1026
|
+
* @property {string} [aggregator] - Aggregator name.
|
|
1027
|
+
* @property {string} [callback_url] - Callback url for aggregator.
|
|
1028
|
+
* @property {string} [order_id] - Aggregator order id.
|
|
1029
|
+
* @property {string} [customer_id] - Aggregator customer id.
|
|
1030
|
+
* @property {string} [merchant_order_id] - Merchant order id.
|
|
1031
|
+
* @property {string} [currency] - Currency used for the order.
|
|
1032
|
+
* @property {string} [email] - Email address of the customer.
|
|
1033
|
+
* @property {string} [contact] - Contact number of the customer.
|
|
1034
|
+
* @property {string} [method] - Method of payment or delivery for the order.
|
|
1021
1035
|
*/
|
|
1022
1036
|
/**
|
|
1023
1037
|
* @typedef PaymentOrderResponse
|
|
1024
|
-
* @property {string} [payment_confirm_url] - Payment confirm url for aggregator
|
|
1025
|
-
* @property {string} [callback_url] - Callback url for aggregator
|
|
1026
|
-
* @property {string} [order_id] - Merchant order id
|
|
1027
|
-
* @property {boolean} [success] - Successful or failure
|
|
1028
|
-
* @property {number} status_code - HTTP status code
|
|
1038
|
+
* @property {string} [payment_confirm_url] - Payment confirm url for aggregator.
|
|
1039
|
+
* @property {string} [callback_url] - Callback url for aggregator.
|
|
1040
|
+
* @property {string} [order_id] - Merchant order id.
|
|
1041
|
+
* @property {boolean} [success] - Successful or failure.
|
|
1042
|
+
* @property {number} status_code - HTTP status code.
|
|
1029
1043
|
* @property {PaymentOrderData} [data]
|
|
1030
|
-
* @property {string} message -
|
|
1044
|
+
* @property {string} message - Detailed message.
|
|
1031
1045
|
*/
|
|
1032
1046
|
/**
|
|
1033
1047
|
* @typedef ShipmentRefundRequest
|
|
1034
|
-
* @property {string} shipment_id - Shipment Id of the respective Merchant Order Id
|
|
1035
|
-
* @property {string} order_id - Merchant Order Id
|
|
1036
|
-
* @property {string} transfer_mode - Transfer Mode of the Beneficiary to be added
|
|
1037
|
-
* @property {string} [beneficiary_id] - Beneficiary Hash Id of the beneficiary added
|
|
1048
|
+
* @property {string} shipment_id - Shipment Id of the respective Merchant Order Id.
|
|
1049
|
+
* @property {string} order_id - Merchant Order Id.
|
|
1050
|
+
* @property {string} transfer_mode - Transfer Mode of the Beneficiary to be added.
|
|
1051
|
+
* @property {string} [beneficiary_id] - Beneficiary Hash Id of the beneficiary added.
|
|
1038
1052
|
*/
|
|
1039
1053
|
/**
|
|
1040
1054
|
* @typedef ShipmentRefundDetail
|
|
1041
|
-
* @property {string} shipment_id -
|
|
1042
|
-
* @property {string} order_id -
|
|
1043
|
-
* @property {string} transfer_mode -
|
|
1044
|
-
*
|
|
1055
|
+
* @property {string} shipment_id - ID of the shipment.
|
|
1056
|
+
* @property {string} order_id - ID of an order.
|
|
1057
|
+
* @property {string} transfer_mode - Mode of transfer for the shipment refund
|
|
1058
|
+
* (e.g., bank transfer, digital wallet).
|
|
1059
|
+
* @property {string} beneficiary_id - Unique identifier for the beneficiary
|
|
1060
|
+
* receiving the refund.
|
|
1045
1061
|
*/
|
|
1046
1062
|
/**
|
|
1047
1063
|
* @typedef ShipmentRefundResponse
|
|
1048
1064
|
* @property {ShipmentRefundDetail} data - Selected Shipment refund option details.
|
|
1049
1065
|
* @property {boolean} success - Successful or not.
|
|
1050
|
-
* @property {string} message -
|
|
1066
|
+
* @property {string} message - Detailed message.
|
|
1051
1067
|
*/
|
|
1052
1068
|
declare class PaymentApplicationModel {
|
|
1053
1069
|
}
|
|
@@ -1058,49 +1074,52 @@ declare namespace PaymentApplicationModel {
|
|
|
1058
1074
|
declare function AggregatorConfigDetail(): AggregatorConfigDetail;
|
|
1059
1075
|
type AggregatorConfigDetail = {
|
|
1060
1076
|
/**
|
|
1061
|
-
* - SDK
|
|
1077
|
+
* - SDK details.
|
|
1062
1078
|
*/
|
|
1063
1079
|
sdk?: boolean;
|
|
1064
1080
|
/**
|
|
1065
|
-
* - Masked payment gateway api secret
|
|
1081
|
+
* - Masked payment gateway api secret.
|
|
1066
1082
|
*/
|
|
1067
1083
|
secret: string;
|
|
1068
1084
|
/**
|
|
1069
|
-
* - Payment gateway api endpoint
|
|
1085
|
+
* - Payment gateway api endpoint.
|
|
1070
1086
|
*/
|
|
1071
1087
|
api?: string;
|
|
1072
1088
|
/**
|
|
1073
|
-
* - Masked pin
|
|
1089
|
+
* - Masked pin.
|
|
1074
1090
|
*/
|
|
1075
1091
|
pin?: string;
|
|
1076
1092
|
/**
|
|
1077
|
-
* - Fynd or self payment gateway
|
|
1093
|
+
* - Fynd or self payment gateway.
|
|
1078
1094
|
*/
|
|
1079
1095
|
config_type: string;
|
|
1080
1096
|
/**
|
|
1081
|
-
* - Unique merchant key
|
|
1097
|
+
* - Unique merchant key.
|
|
1082
1098
|
*/
|
|
1083
1099
|
merchant_key?: string;
|
|
1084
1100
|
/**
|
|
1085
|
-
* - Payment gateway verify payment api endpoint
|
|
1101
|
+
* - Payment gateway verify payment api endpoint.
|
|
1086
1102
|
*/
|
|
1087
1103
|
verify_api?: string;
|
|
1088
1104
|
/**
|
|
1089
|
-
* - Payment gateway api key
|
|
1105
|
+
* - Payment gateway api key.
|
|
1090
1106
|
*/
|
|
1091
1107
|
key: string;
|
|
1092
1108
|
/**
|
|
1093
|
-
* - Registered User id
|
|
1109
|
+
* - Registered User id.
|
|
1094
1110
|
*/
|
|
1095
1111
|
user_id?: string;
|
|
1096
1112
|
/**
|
|
1097
|
-
* - Unique merchant id
|
|
1113
|
+
* - Unique merchant id.
|
|
1098
1114
|
*/
|
|
1099
1115
|
merchant_id?: string;
|
|
1100
1116
|
};
|
|
1101
1117
|
/** @returns {AggregatorsConfigDetailResponse} */
|
|
1102
1118
|
declare function AggregatorsConfigDetailResponse(): AggregatorsConfigDetailResponse;
|
|
1103
1119
|
type AggregatorsConfigDetailResponse = {
|
|
1120
|
+
/**
|
|
1121
|
+
* - Api response was successful or not.
|
|
1122
|
+
*/
|
|
1104
1123
|
success: boolean;
|
|
1105
1124
|
razorpay?: AggregatorConfigDetail;
|
|
1106
1125
|
juspay?: AggregatorConfigDetail;
|
|
@@ -1111,7 +1130,7 @@ type AggregatorsConfigDetailResponse = {
|
|
|
1111
1130
|
stripe?: AggregatorConfigDetail;
|
|
1112
1131
|
ccavenue?: AggregatorConfigDetail;
|
|
1113
1132
|
/**
|
|
1114
|
-
* - Environment i.e Live or Test
|
|
1133
|
+
* - Environment i.e Live or Test.
|
|
1115
1134
|
*/
|
|
1116
1135
|
env: string;
|
|
1117
1136
|
};
|
|
@@ -1119,7 +1138,7 @@ type AggregatorsConfigDetailResponse = {
|
|
|
1119
1138
|
declare function ErrorCodeAndDescription(): ErrorCodeAndDescription;
|
|
1120
1139
|
type ErrorCodeAndDescription = {
|
|
1121
1140
|
/**
|
|
1122
|
-
* - Error
|
|
1141
|
+
* - Error description code.
|
|
1123
1142
|
*/
|
|
1124
1143
|
code: string;
|
|
1125
1144
|
/**
|
|
@@ -1132,13 +1151,16 @@ declare function HttpErrorCodeAndResponse(): HttpErrorCodeAndResponse;
|
|
|
1132
1151
|
type HttpErrorCodeAndResponse = {
|
|
1133
1152
|
error?: ErrorCodeAndDescription;
|
|
1134
1153
|
/**
|
|
1135
|
-
* - Response is successful or not
|
|
1154
|
+
* - Response is successful or not.
|
|
1136
1155
|
*/
|
|
1137
1156
|
success: boolean;
|
|
1138
1157
|
};
|
|
1139
1158
|
/** @returns {AttachCardRequest} */
|
|
1140
1159
|
declare function AttachCardRequest(): AttachCardRequest;
|
|
1141
1160
|
type AttachCardRequest = {
|
|
1161
|
+
/**
|
|
1162
|
+
* - Nickname of the card holder.
|
|
1163
|
+
*/
|
|
1142
1164
|
nickname?: string;
|
|
1143
1165
|
/**
|
|
1144
1166
|
* - Refresh cache flag.
|
|
@@ -1148,6 +1170,9 @@ type AttachCardRequest = {
|
|
|
1148
1170
|
* - Card token of payment gateway.
|
|
1149
1171
|
*/
|
|
1150
1172
|
card_id: string;
|
|
1173
|
+
/**
|
|
1174
|
+
* - Name of the card holder.
|
|
1175
|
+
*/
|
|
1151
1176
|
name_on_card?: string;
|
|
1152
1177
|
};
|
|
1153
1178
|
/** @returns {AttachCardsResponse} */
|
|
@@ -1170,7 +1195,7 @@ type AttachCardsResponse = {
|
|
|
1170
1195
|
declare function CardPaymentGateway(): CardPaymentGateway;
|
|
1171
1196
|
type CardPaymentGateway = {
|
|
1172
1197
|
/**
|
|
1173
|
-
* - Payment gateway CARD api endpoint
|
|
1198
|
+
* - Payment gateway CARD api endpoint.
|
|
1174
1199
|
*/
|
|
1175
1200
|
api?: string;
|
|
1176
1201
|
/**
|
|
@@ -1199,72 +1224,74 @@ type ActiveCardPaymentGatewayResponse = {
|
|
|
1199
1224
|
declare function Card(): Card;
|
|
1200
1225
|
type Card = {
|
|
1201
1226
|
/**
|
|
1202
|
-
* -
|
|
1227
|
+
* - Card number mentioned on the card.
|
|
1203
1228
|
*/
|
|
1204
1229
|
card_number?: string;
|
|
1205
1230
|
/**
|
|
1206
|
-
* -
|
|
1231
|
+
* - Name mentioned on the card.
|
|
1207
1232
|
*/
|
|
1208
1233
|
card_name?: string;
|
|
1209
1234
|
/**
|
|
1210
|
-
* -
|
|
1235
|
+
* - Type of the card.
|
|
1211
1236
|
*/
|
|
1212
1237
|
card_type?: string;
|
|
1213
1238
|
/**
|
|
1214
|
-
* -
|
|
1239
|
+
* - Brand image on the card.
|
|
1215
1240
|
*/
|
|
1216
1241
|
card_brand_image?: string;
|
|
1217
1242
|
/**
|
|
1218
|
-
* -
|
|
1243
|
+
* - Card reference.
|
|
1219
1244
|
*/
|
|
1220
1245
|
card_reference?: string;
|
|
1221
1246
|
/**
|
|
1222
|
-
* -
|
|
1247
|
+
* - Issuer of the card.
|
|
1223
1248
|
*/
|
|
1224
1249
|
card_issuer?: string;
|
|
1225
1250
|
/**
|
|
1226
|
-
* -
|
|
1251
|
+
* - Brand of the card.
|
|
1227
1252
|
*/
|
|
1228
1253
|
card_brand?: string;
|
|
1229
1254
|
/**
|
|
1230
|
-
* -
|
|
1255
|
+
* - Card expiry.
|
|
1231
1256
|
*/
|
|
1232
1257
|
expired?: boolean;
|
|
1233
1258
|
/**
|
|
1234
|
-
* -
|
|
1235
|
-
*
|
|
1259
|
+
* - Whether card
|
|
1260
|
+
* is tokenized or not.
|
|
1236
1261
|
*/
|
|
1237
1262
|
compliant_with_tokenisation_guidelines?: boolean;
|
|
1238
1263
|
/**
|
|
1239
|
-
* -
|
|
1264
|
+
* - International Securities Identification
|
|
1265
|
+
* Number for the card.
|
|
1240
1266
|
*/
|
|
1241
1267
|
card_isin?: string;
|
|
1242
1268
|
/**
|
|
1243
|
-
* -
|
|
1269
|
+
* - Card's expiration year.
|
|
1244
1270
|
*/
|
|
1245
1271
|
exp_year?: number;
|
|
1246
1272
|
/**
|
|
1247
|
-
* -
|
|
1273
|
+
* - User-defined name for the card.
|
|
1248
1274
|
*/
|
|
1249
1275
|
nickname?: string;
|
|
1250
1276
|
/**
|
|
1251
|
-
* -
|
|
1277
|
+
* - Name of the payment aggregator.
|
|
1252
1278
|
*/
|
|
1253
1279
|
aggregator_name: string;
|
|
1254
1280
|
/**
|
|
1255
|
-
* -
|
|
1281
|
+
* - Unique fingerprint of the card for
|
|
1282
|
+
* identification.
|
|
1256
1283
|
*/
|
|
1257
1284
|
card_fingerprint?: string;
|
|
1258
1285
|
/**
|
|
1259
|
-
* -
|
|
1286
|
+
* - Encrypted token representing the card.
|
|
1260
1287
|
*/
|
|
1261
1288
|
card_token?: string;
|
|
1262
1289
|
/**
|
|
1263
|
-
* -
|
|
1290
|
+
* - Card's expiration month.
|
|
1264
1291
|
*/
|
|
1265
1292
|
exp_month?: number;
|
|
1266
1293
|
/**
|
|
1267
|
-
* -
|
|
1294
|
+
* - Unique identifier for the card within the system.
|
|
1268
1295
|
*/
|
|
1269
1296
|
card_id?: string;
|
|
1270
1297
|
};
|
|
@@ -1308,11 +1335,11 @@ type DeleteCardsResponse = {
|
|
|
1308
1335
|
declare function ValidateCustomerRequest(): ValidateCustomerRequest;
|
|
1309
1336
|
type ValidateCustomerRequest = {
|
|
1310
1337
|
/**
|
|
1311
|
-
* - Payment gateway name in
|
|
1338
|
+
* - Payment gateway name in camelcase i.e Simple, Rupifi.
|
|
1312
1339
|
*/
|
|
1313
1340
|
aggregator: string;
|
|
1314
1341
|
/**
|
|
1315
|
-
* - Payable amount in paise
|
|
1342
|
+
* - Payable amount in paise.
|
|
1316
1343
|
*/
|
|
1317
1344
|
transaction_amount_in_paise: number;
|
|
1318
1345
|
/**
|
|
@@ -1344,11 +1371,11 @@ type ValidateCustomerRequest = {
|
|
|
1344
1371
|
declare function ValidateCustomerResponse(): ValidateCustomerResponse;
|
|
1345
1372
|
type ValidateCustomerResponse = {
|
|
1346
1373
|
/**
|
|
1347
|
-
* - Payment gateway response data
|
|
1374
|
+
* - Payment gateway response data.
|
|
1348
1375
|
*/
|
|
1349
|
-
data
|
|
1376
|
+
data?: any;
|
|
1350
1377
|
/**
|
|
1351
|
-
* - Response is successful or not
|
|
1378
|
+
* - Response is successful or not.
|
|
1352
1379
|
*/
|
|
1353
1380
|
success: boolean;
|
|
1354
1381
|
/**
|
|
@@ -1360,11 +1387,11 @@ type ValidateCustomerResponse = {
|
|
|
1360
1387
|
declare function ChargeCustomerRequest(): ChargeCustomerRequest;
|
|
1361
1388
|
type ChargeCustomerRequest = {
|
|
1362
1389
|
/**
|
|
1363
|
-
* - Already Verified flag from payment gateway i.e Mswipe
|
|
1390
|
+
* - Already Verified flag from payment gateway i.e Mswipe.
|
|
1364
1391
|
*/
|
|
1365
1392
|
verified?: boolean;
|
|
1366
1393
|
/**
|
|
1367
|
-
* - Payment gateway name i.e Simpl, Mswipe
|
|
1394
|
+
* - Payment gateway name i.e Simpl, Mswipe.
|
|
1368
1395
|
*/
|
|
1369
1396
|
aggregator: string;
|
|
1370
1397
|
/**
|
|
@@ -1376,7 +1403,7 @@ type ChargeCustomerRequest = {
|
|
|
1376
1403
|
*/
|
|
1377
1404
|
transaction_token?: string;
|
|
1378
1405
|
/**
|
|
1379
|
-
* -
|
|
1406
|
+
* - Chargeable amount of order.
|
|
1380
1407
|
*/
|
|
1381
1408
|
amount: number;
|
|
1382
1409
|
};
|
|
@@ -1388,7 +1415,7 @@ type ChargeCustomerResponse = {
|
|
|
1388
1415
|
*/
|
|
1389
1416
|
status: string;
|
|
1390
1417
|
/**
|
|
1391
|
-
* - Cart id of customer
|
|
1418
|
+
* - Cart id of customer.
|
|
1392
1419
|
*/
|
|
1393
1420
|
cart_id?: string;
|
|
1394
1421
|
/**
|
|
@@ -1396,7 +1423,7 @@ type ChargeCustomerResponse = {
|
|
|
1396
1423
|
*/
|
|
1397
1424
|
success: boolean;
|
|
1398
1425
|
/**
|
|
1399
|
-
* - Payment gateway name i.e Simpl, Mswipe
|
|
1426
|
+
* - Payment gateway name i.e Simpl, Mswipe.
|
|
1400
1427
|
*/
|
|
1401
1428
|
aggregator: string;
|
|
1402
1429
|
/**
|
|
@@ -1408,7 +1435,7 @@ type ChargeCustomerResponse = {
|
|
|
1408
1435
|
*/
|
|
1409
1436
|
order_id: string;
|
|
1410
1437
|
/**
|
|
1411
|
-
* - Delivery
|
|
1438
|
+
* - Delivery address id of customer.
|
|
1412
1439
|
*/
|
|
1413
1440
|
delivery_address_id?: string;
|
|
1414
1441
|
};
|
|
@@ -1416,19 +1443,19 @@ type ChargeCustomerResponse = {
|
|
|
1416
1443
|
declare function PaymentInitializationRequest(): PaymentInitializationRequest;
|
|
1417
1444
|
type PaymentInitializationRequest = {
|
|
1418
1445
|
/**
|
|
1419
|
-
* - Payment gateway payment id
|
|
1446
|
+
* - Payment gateway payment id.
|
|
1420
1447
|
*/
|
|
1421
1448
|
razorpay_payment_id?: string;
|
|
1422
1449
|
/**
|
|
1423
|
-
* - Payment method
|
|
1450
|
+
* - Payment method.
|
|
1424
1451
|
*/
|
|
1425
1452
|
method: string;
|
|
1426
1453
|
/**
|
|
1427
|
-
* - EDC machine Unique Identifier
|
|
1454
|
+
* - EDC machine Unique Identifier.
|
|
1428
1455
|
*/
|
|
1429
1456
|
device_id?: string;
|
|
1430
1457
|
/**
|
|
1431
|
-
* - Payment gateway name
|
|
1458
|
+
* - Payment gateway name.
|
|
1432
1459
|
*/
|
|
1433
1460
|
aggregator: string;
|
|
1434
1461
|
/**
|
|
@@ -1436,19 +1463,19 @@ type PaymentInitializationRequest = {
|
|
|
1436
1463
|
*/
|
|
1437
1464
|
customer_id: string;
|
|
1438
1465
|
/**
|
|
1439
|
-
* - Customer valid mobile number
|
|
1466
|
+
* - Customer valid mobile number.
|
|
1440
1467
|
*/
|
|
1441
1468
|
contact: string;
|
|
1442
1469
|
/**
|
|
1443
|
-
* - Unique fynd order id
|
|
1470
|
+
* - Unique fynd order id.
|
|
1444
1471
|
*/
|
|
1445
1472
|
merchant_order_id: string;
|
|
1446
1473
|
/**
|
|
1447
|
-
* - Customer vpa address
|
|
1474
|
+
* - Customer vpa address.
|
|
1448
1475
|
*/
|
|
1449
1476
|
vpa?: string;
|
|
1450
1477
|
/**
|
|
1451
|
-
* - Payment gateway order id
|
|
1478
|
+
* - Payment gateway order id.
|
|
1452
1479
|
*/
|
|
1453
1480
|
order_id: string;
|
|
1454
1481
|
/**
|
|
@@ -1456,7 +1483,7 @@ type PaymentInitializationRequest = {
|
|
|
1456
1483
|
*/
|
|
1457
1484
|
currency: string;
|
|
1458
1485
|
/**
|
|
1459
|
-
* - Payment polling timeout if not
|
|
1486
|
+
* - Payment polling timeout if not received response.
|
|
1460
1487
|
*/
|
|
1461
1488
|
timeout?: number;
|
|
1462
1489
|
/**
|
|
@@ -1464,7 +1491,7 @@ type PaymentInitializationRequest = {
|
|
|
1464
1491
|
*/
|
|
1465
1492
|
amount: number;
|
|
1466
1493
|
/**
|
|
1467
|
-
* - Customer valid email
|
|
1494
|
+
* - Customer valid email.
|
|
1468
1495
|
*/
|
|
1469
1496
|
email: string;
|
|
1470
1497
|
};
|
|
@@ -1480,11 +1507,11 @@ type PaymentInitializationResponse = {
|
|
|
1480
1507
|
*/
|
|
1481
1508
|
razorpay_payment_id?: string;
|
|
1482
1509
|
/**
|
|
1483
|
-
* - Payment order id
|
|
1510
|
+
* - Payment order id.
|
|
1484
1511
|
*/
|
|
1485
1512
|
aggregator_order_id?: string;
|
|
1486
1513
|
/**
|
|
1487
|
-
* - Payment method
|
|
1514
|
+
* - Payment method.
|
|
1488
1515
|
*/
|
|
1489
1516
|
method: string;
|
|
1490
1517
|
/**
|
|
@@ -1500,7 +1527,7 @@ type PaymentInitializationResponse = {
|
|
|
1500
1527
|
*/
|
|
1501
1528
|
virtual_id?: string;
|
|
1502
1529
|
/**
|
|
1503
|
-
* - EDC machine Unique Identifier
|
|
1530
|
+
* - EDC machine Unique Identifier.
|
|
1504
1531
|
*/
|
|
1505
1532
|
device_id?: string;
|
|
1506
1533
|
/**
|
|
@@ -1508,11 +1535,11 @@ type PaymentInitializationResponse = {
|
|
|
1508
1535
|
*/
|
|
1509
1536
|
polling_url: string;
|
|
1510
1537
|
/**
|
|
1511
|
-
* - Payment gateway name
|
|
1538
|
+
* - Payment gateway name.
|
|
1512
1539
|
*/
|
|
1513
1540
|
aggregator: string;
|
|
1514
1541
|
/**
|
|
1515
|
-
* - Order id
|
|
1542
|
+
* - Order id.
|
|
1516
1543
|
*/
|
|
1517
1544
|
merchant_order_id: string;
|
|
1518
1545
|
/**
|
|
@@ -1520,7 +1547,7 @@ type PaymentInitializationResponse = {
|
|
|
1520
1547
|
*/
|
|
1521
1548
|
customer_id?: string;
|
|
1522
1549
|
/**
|
|
1523
|
-
* - Customer vpa address
|
|
1550
|
+
* - Customer vpa address.
|
|
1524
1551
|
*/
|
|
1525
1552
|
vpa?: string;
|
|
1526
1553
|
/**
|
|
@@ -1536,7 +1563,7 @@ type PaymentInitializationResponse = {
|
|
|
1536
1563
|
*/
|
|
1537
1564
|
amount?: number;
|
|
1538
1565
|
/**
|
|
1539
|
-
* -
|
|
1566
|
+
* - Bharat qr image url.
|
|
1540
1567
|
*/
|
|
1541
1568
|
bqr_image?: string;
|
|
1542
1569
|
};
|
|
@@ -1548,19 +1575,19 @@ type PaymentStatusUpdateRequest = {
|
|
|
1548
1575
|
*/
|
|
1549
1576
|
status?: string;
|
|
1550
1577
|
/**
|
|
1551
|
-
* - Unique fynd transaction id
|
|
1578
|
+
* - Unique fynd transaction id.
|
|
1552
1579
|
*/
|
|
1553
1580
|
merchant_transaction_id?: string;
|
|
1554
1581
|
/**
|
|
1555
|
-
* - Payment method
|
|
1582
|
+
* - Payment method.
|
|
1556
1583
|
*/
|
|
1557
1584
|
method: string;
|
|
1558
1585
|
/**
|
|
1559
|
-
* - EDC machine Unique Identifier
|
|
1586
|
+
* - EDC machine Unique Identifier.
|
|
1560
1587
|
*/
|
|
1561
1588
|
device_id?: string;
|
|
1562
1589
|
/**
|
|
1563
|
-
* - Payment gateway name
|
|
1590
|
+
* - Payment gateway name.
|
|
1564
1591
|
*/
|
|
1565
1592
|
aggregator: string;
|
|
1566
1593
|
/**
|
|
@@ -1568,19 +1595,19 @@ type PaymentStatusUpdateRequest = {
|
|
|
1568
1595
|
*/
|
|
1569
1596
|
customer_id?: string;
|
|
1570
1597
|
/**
|
|
1571
|
-
* - Customer valid mobile number
|
|
1598
|
+
* - Customer valid mobile number.
|
|
1572
1599
|
*/
|
|
1573
1600
|
contact?: string;
|
|
1574
1601
|
/**
|
|
1575
|
-
* - Unique fynd order id
|
|
1602
|
+
* - Unique fynd order id.
|
|
1576
1603
|
*/
|
|
1577
1604
|
merchant_order_id: string;
|
|
1578
1605
|
/**
|
|
1579
|
-
* - Customer vpa address
|
|
1606
|
+
* - Customer vpa address.
|
|
1580
1607
|
*/
|
|
1581
1608
|
vpa?: string;
|
|
1582
1609
|
/**
|
|
1583
|
-
* - Payment gateway order id
|
|
1610
|
+
* - Payment gateway order id.
|
|
1584
1611
|
*/
|
|
1585
1612
|
order_id?: string;
|
|
1586
1613
|
/**
|
|
@@ -1592,7 +1619,7 @@ type PaymentStatusUpdateRequest = {
|
|
|
1592
1619
|
*/
|
|
1593
1620
|
amount?: number;
|
|
1594
1621
|
/**
|
|
1595
|
-
* - Customer valid email
|
|
1622
|
+
* - Customer valid email.
|
|
1596
1623
|
*/
|
|
1597
1624
|
email?: string;
|
|
1598
1625
|
};
|
|
@@ -1600,11 +1627,11 @@ type PaymentStatusUpdateRequest = {
|
|
|
1600
1627
|
declare function PaymentStatusUpdateResponse(): PaymentStatusUpdateResponse;
|
|
1601
1628
|
type PaymentStatusUpdateResponse = {
|
|
1602
1629
|
/**
|
|
1603
|
-
* - Payment status
|
|
1630
|
+
* - Payment status.
|
|
1604
1631
|
*/
|
|
1605
1632
|
status: string;
|
|
1606
1633
|
/**
|
|
1607
|
-
* - Response is successful or not
|
|
1634
|
+
* - Response is successful or not.
|
|
1608
1635
|
*/
|
|
1609
1636
|
success?: boolean;
|
|
1610
1637
|
/**
|
|
@@ -1612,11 +1639,11 @@ type PaymentStatusUpdateResponse = {
|
|
|
1612
1639
|
*/
|
|
1613
1640
|
retry: boolean;
|
|
1614
1641
|
/**
|
|
1615
|
-
* - Redirect url
|
|
1642
|
+
* - Redirect url.
|
|
1616
1643
|
*/
|
|
1617
1644
|
redirect_url?: string;
|
|
1618
1645
|
/**
|
|
1619
|
-
* - Payment gateway name
|
|
1646
|
+
* - Payment gateway name.
|
|
1620
1647
|
*/
|
|
1621
1648
|
aggregator_name: string;
|
|
1622
1649
|
};
|
|
@@ -1624,11 +1651,11 @@ type PaymentStatusUpdateResponse = {
|
|
|
1624
1651
|
declare function IntentAppErrorList(): IntentAppErrorList;
|
|
1625
1652
|
type IntentAppErrorList = {
|
|
1626
1653
|
/**
|
|
1627
|
-
* - Code
|
|
1654
|
+
* - Code of the intent App.
|
|
1628
1655
|
*/
|
|
1629
1656
|
code?: string;
|
|
1630
1657
|
/**
|
|
1631
|
-
* -
|
|
1658
|
+
* - Package Name of the intent App.
|
|
1632
1659
|
*/
|
|
1633
1660
|
package_name?: string;
|
|
1634
1661
|
};
|
|
@@ -1636,11 +1663,11 @@ type IntentAppErrorList = {
|
|
|
1636
1663
|
declare function PaymentModeLogo(): PaymentModeLogo;
|
|
1637
1664
|
type PaymentModeLogo = {
|
|
1638
1665
|
/**
|
|
1639
|
-
* - Large
|
|
1666
|
+
* - Large Logo.
|
|
1640
1667
|
*/
|
|
1641
1668
|
large: string;
|
|
1642
1669
|
/**
|
|
1643
|
-
* -
|
|
1670
|
+
* - Small Logo.
|
|
1644
1671
|
*/
|
|
1645
1672
|
small: string;
|
|
1646
1673
|
};
|
|
@@ -1648,16 +1675,16 @@ type PaymentModeLogo = {
|
|
|
1648
1675
|
declare function IntentApp(): IntentApp;
|
|
1649
1676
|
type IntentApp = {
|
|
1650
1677
|
/**
|
|
1651
|
-
* - Code
|
|
1678
|
+
* - Code of the intent App.
|
|
1652
1679
|
*/
|
|
1653
1680
|
code?: string;
|
|
1654
1681
|
/**
|
|
1655
|
-
* -
|
|
1682
|
+
* - Package Name of the intent App.
|
|
1656
1683
|
*/
|
|
1657
1684
|
package_name?: string;
|
|
1658
1685
|
logos?: PaymentModeLogo;
|
|
1659
1686
|
/**
|
|
1660
|
-
* -
|
|
1687
|
+
* - Display Name of the intent App.
|
|
1661
1688
|
*/
|
|
1662
1689
|
display_name?: string;
|
|
1663
1690
|
};
|
|
@@ -1665,138 +1692,143 @@ type IntentApp = {
|
|
|
1665
1692
|
declare function PaymentModeList(): PaymentModeList;
|
|
1666
1693
|
type PaymentModeList = {
|
|
1667
1694
|
/**
|
|
1668
|
-
* -
|
|
1695
|
+
* - Card number mentioned on the card.
|
|
1669
1696
|
*/
|
|
1670
1697
|
card_number?: string;
|
|
1671
1698
|
/**
|
|
1672
|
-
* -
|
|
1699
|
+
* - Unique code identifying the merchant.
|
|
1673
1700
|
*/
|
|
1674
1701
|
merchant_code?: string;
|
|
1675
1702
|
/**
|
|
1676
|
-
* -
|
|
1703
|
+
* - Reference identifier for the card.
|
|
1677
1704
|
*/
|
|
1678
1705
|
card_reference?: string;
|
|
1679
1706
|
/**
|
|
1680
|
-
* -
|
|
1707
|
+
* - Issuing bank or institution of the card.
|
|
1681
1708
|
*/
|
|
1682
1709
|
card_issuer?: string;
|
|
1683
1710
|
/**
|
|
1684
|
-
* -
|
|
1685
|
-
*
|
|
1711
|
+
* - Indicates
|
|
1712
|
+
* compliance with tokenization guidelines.
|
|
1686
1713
|
*/
|
|
1687
1714
|
compliant_with_tokenisation_guidelines?: boolean;
|
|
1688
1715
|
/**
|
|
1689
|
-
* -
|
|
1716
|
+
* - General code for identifying a transaction or status.
|
|
1690
1717
|
*/
|
|
1691
1718
|
code?: string;
|
|
1692
1719
|
/**
|
|
1693
|
-
* -
|
|
1720
|
+
* - Limit for Cash on Delivery (COD) transactions.
|
|
1694
1721
|
*/
|
|
1695
1722
|
cod_limit?: number;
|
|
1696
1723
|
/**
|
|
1697
|
-
* -
|
|
1724
|
+
* - Flow or process intended for the transaction.
|
|
1698
1725
|
*/
|
|
1699
1726
|
intent_flow?: boolean;
|
|
1700
1727
|
/**
|
|
1701
|
-
* -
|
|
1728
|
+
* - Virtual Payment Address (VPA) used by Fynd.
|
|
1702
1729
|
*/
|
|
1703
1730
|
fynd_vpa?: string;
|
|
1704
1731
|
/**
|
|
1705
|
-
* -
|
|
1706
|
-
*
|
|
1732
|
+
* - List of error
|
|
1733
|
+
* dictionaries related to intent app.
|
|
1707
1734
|
*/
|
|
1708
1735
|
intent_app_error_dict_list?: IntentAppErrorList[];
|
|
1709
1736
|
/**
|
|
1710
|
-
* -
|
|
1737
|
+
* - Name of the payment aggregator.
|
|
1711
1738
|
*/
|
|
1712
1739
|
aggregator_name: string;
|
|
1713
1740
|
/**
|
|
1714
|
-
* -
|
|
1741
|
+
* - Unique fingerprint of the card for
|
|
1742
|
+
* identification.
|
|
1715
1743
|
*/
|
|
1716
1744
|
card_fingerprint?: string;
|
|
1717
1745
|
/**
|
|
1718
|
-
* -
|
|
1746
|
+
* - List of errors associated with
|
|
1747
|
+
* the intent app.
|
|
1719
1748
|
*/
|
|
1720
1749
|
intent_app_error_list?: string[];
|
|
1721
1750
|
/**
|
|
1722
|
-
* -
|
|
1751
|
+
* - Application intended for handling the
|
|
1752
|
+
* transaction.
|
|
1723
1753
|
*/
|
|
1724
1754
|
intent_app?: IntentApp[];
|
|
1725
1755
|
/**
|
|
1726
|
-
* -
|
|
1756
|
+
* - Indicates whether the card is expired.
|
|
1727
1757
|
*/
|
|
1728
1758
|
expired?: boolean;
|
|
1729
1759
|
/**
|
|
1730
|
-
* -
|
|
1760
|
+
* - Number of retry attempts.
|
|
1731
1761
|
*/
|
|
1732
1762
|
retry_count?: number;
|
|
1733
1763
|
/**
|
|
1734
|
-
* -
|
|
1764
|
+
* - Card's expiration year.
|
|
1735
1765
|
*/
|
|
1736
1766
|
exp_year?: number;
|
|
1737
1767
|
/**
|
|
1738
|
-
* -
|
|
1768
|
+
* - Card's expiration month.
|
|
1739
1769
|
*/
|
|
1740
1770
|
exp_month?: number;
|
|
1741
1771
|
/**
|
|
1742
|
-
* -
|
|
1772
|
+
* - Unique identifier for the card within the system.
|
|
1743
1773
|
*/
|
|
1744
1774
|
card_id?: string;
|
|
1745
1775
|
/**
|
|
1746
|
-
* - Remaining limit
|
|
1776
|
+
* - Remaining available limit on the card.
|
|
1747
1777
|
*/
|
|
1748
1778
|
remaining_limit?: number;
|
|
1749
1779
|
/**
|
|
1750
|
-
* -
|
|
1780
|
+
* - Priority of display in the user interface.
|
|
1751
1781
|
*/
|
|
1752
1782
|
display_priority?: number;
|
|
1753
1783
|
/**
|
|
1754
|
-
* -
|
|
1784
|
+
* - Brand of the card (e.g., Visa, MasterCard).
|
|
1755
1785
|
*/
|
|
1756
1786
|
card_brand?: string;
|
|
1757
1787
|
/**
|
|
1758
|
-
* -
|
|
1788
|
+
* - Maximum limit per order for COD
|
|
1789
|
+
* transactions.
|
|
1759
1790
|
*/
|
|
1760
1791
|
cod_limit_per_order?: number;
|
|
1761
1792
|
logo_url?: PaymentModeLogo;
|
|
1762
1793
|
/**
|
|
1763
|
-
* -
|
|
1794
|
+
* - User-defined name for the card.
|
|
1764
1795
|
*/
|
|
1765
1796
|
nickname?: string;
|
|
1766
1797
|
/**
|
|
1767
|
-
* -
|
|
1798
|
+
* - Name printed on the card.
|
|
1768
1799
|
*/
|
|
1769
1800
|
card_name?: string;
|
|
1770
1801
|
/**
|
|
1771
|
-
* -
|
|
1802
|
+
* - Type of the card (e.g., debit, credit).
|
|
1772
1803
|
*/
|
|
1773
1804
|
card_type?: string;
|
|
1774
1805
|
/**
|
|
1775
|
-
* -
|
|
1806
|
+
* - Image representing the card brand.
|
|
1776
1807
|
*/
|
|
1777
1808
|
card_brand_image?: string;
|
|
1778
1809
|
/**
|
|
1779
|
-
* - Display name
|
|
1810
|
+
* - Display name for the card in the user interface.
|
|
1780
1811
|
*/
|
|
1781
1812
|
display_name?: string;
|
|
1782
1813
|
/**
|
|
1783
|
-
* -
|
|
1814
|
+
* - International Securities Identification
|
|
1815
|
+
* Number for the card.
|
|
1784
1816
|
*/
|
|
1785
1817
|
card_isin?: string;
|
|
1786
1818
|
/**
|
|
1787
|
-
* - Timeout
|
|
1819
|
+
* - Timeout duration for transactions.
|
|
1788
1820
|
*/
|
|
1789
1821
|
timeout?: number;
|
|
1790
1822
|
/**
|
|
1791
|
-
* -
|
|
1823
|
+
* - Encrypted token representing the card.
|
|
1792
1824
|
*/
|
|
1793
1825
|
card_token?: string;
|
|
1794
1826
|
/**
|
|
1795
|
-
* -
|
|
1827
|
+
* - User's name.
|
|
1796
1828
|
*/
|
|
1797
1829
|
name?: string;
|
|
1798
1830
|
/**
|
|
1799
|
-
* - Payment methods meta
|
|
1831
|
+
* - Payment methods meta.
|
|
1800
1832
|
*/
|
|
1801
1833
|
meta?: any;
|
|
1802
1834
|
};
|
|
@@ -1805,39 +1837,39 @@ declare function RootPaymentMode(): RootPaymentMode;
|
|
|
1805
1837
|
type RootPaymentMode = {
|
|
1806
1838
|
/**
|
|
1807
1839
|
* - This flag will be true in case of
|
|
1808
|
-
* Payment link payment through card
|
|
1840
|
+
* Payment link payment through card.
|
|
1809
1841
|
*/
|
|
1810
1842
|
is_pay_by_card_pl?: boolean;
|
|
1811
1843
|
/**
|
|
1812
|
-
* -
|
|
1844
|
+
* - Anonymous card flag.
|
|
1813
1845
|
*/
|
|
1814
1846
|
add_card_enabled?: boolean;
|
|
1815
1847
|
/**
|
|
1816
|
-
* -
|
|
1848
|
+
* - Display Priority.
|
|
1817
1849
|
*/
|
|
1818
1850
|
display_priority: number;
|
|
1819
1851
|
/**
|
|
1820
|
-
* - Payment mode display name
|
|
1852
|
+
* - Payment mode display name.
|
|
1821
1853
|
*/
|
|
1822
1854
|
display_name: string;
|
|
1823
1855
|
/**
|
|
1824
|
-
* - Payment mode
|
|
1856
|
+
* - Payment mode.
|
|
1825
1857
|
*/
|
|
1826
1858
|
list?: PaymentModeList[];
|
|
1827
1859
|
/**
|
|
1828
|
-
* - Card save or not
|
|
1860
|
+
* - Card save or not.
|
|
1829
1861
|
*/
|
|
1830
1862
|
save_card?: boolean;
|
|
1831
1863
|
/**
|
|
1832
|
-
* -
|
|
1864
|
+
* - Display Priority.
|
|
1833
1865
|
*/
|
|
1834
1866
|
aggregator_name?: string;
|
|
1835
1867
|
/**
|
|
1836
|
-
* - Payment mode name
|
|
1868
|
+
* - Payment mode name.
|
|
1837
1869
|
*/
|
|
1838
1870
|
name: string;
|
|
1839
1871
|
/**
|
|
1840
|
-
* -
|
|
1872
|
+
* - Anonymous card flag.
|
|
1841
1873
|
*/
|
|
1842
1874
|
anonymous_enable?: boolean;
|
|
1843
1875
|
};
|
|
@@ -1845,19 +1877,19 @@ type RootPaymentMode = {
|
|
|
1845
1877
|
declare function AggregatorRoute(): AggregatorRoute;
|
|
1846
1878
|
type AggregatorRoute = {
|
|
1847
1879
|
/**
|
|
1848
|
-
* -
|
|
1880
|
+
* - Details about aggregator route.
|
|
1849
1881
|
*/
|
|
1850
1882
|
data?: any;
|
|
1851
1883
|
/**
|
|
1852
|
-
* - Payment_flow_data
|
|
1884
|
+
* - Payment_flow_data.
|
|
1853
1885
|
*/
|
|
1854
1886
|
payment_flow_data?: any;
|
|
1855
1887
|
/**
|
|
1856
|
-
* - Payment_flow
|
|
1888
|
+
* - Payment_flow.
|
|
1857
1889
|
*/
|
|
1858
1890
|
payment_flow?: string;
|
|
1859
1891
|
/**
|
|
1860
|
-
* -
|
|
1892
|
+
* - API link of the aggregator.
|
|
1861
1893
|
*/
|
|
1862
1894
|
api_link?: string;
|
|
1863
1895
|
};
|
|
@@ -1865,16 +1897,16 @@ type AggregatorRoute = {
|
|
|
1865
1897
|
declare function PaymentDefaultSelection(): PaymentDefaultSelection;
|
|
1866
1898
|
type PaymentDefaultSelection = {
|
|
1867
1899
|
/**
|
|
1868
|
-
* - Default Selection Payment Mode
|
|
1900
|
+
* - Default Selection Payment Mode.
|
|
1869
1901
|
*/
|
|
1870
1902
|
mode?: string;
|
|
1871
1903
|
/**
|
|
1872
|
-
* - Identifier for Payment Mode
|
|
1904
|
+
* - Identifier for Payment Mode.
|
|
1873
1905
|
*/
|
|
1874
1906
|
identifier?: string;
|
|
1875
1907
|
/**
|
|
1876
1908
|
* - Decide if the default payment mode will skip the
|
|
1877
|
-
* payment options page altogether or just be preferred on the Frontend
|
|
1909
|
+
* payment options page altogether or just be preferred on the Frontend.
|
|
1878
1910
|
*/
|
|
1879
1911
|
skip?: boolean;
|
|
1880
1912
|
};
|
|
@@ -1900,7 +1932,7 @@ type PaymentFlow = {
|
|
|
1900
1932
|
declare function PaymentOptionAndFlow(): PaymentOptionAndFlow;
|
|
1901
1933
|
type PaymentOptionAndFlow = {
|
|
1902
1934
|
/**
|
|
1903
|
-
* - Payment options
|
|
1935
|
+
* - Payment options.
|
|
1904
1936
|
*/
|
|
1905
1937
|
payment_option: RootPaymentMode[];
|
|
1906
1938
|
payment_flows: PaymentFlow;
|
|
@@ -1910,48 +1942,48 @@ type PaymentOptionAndFlow = {
|
|
|
1910
1942
|
declare function AdvanceObject(): AdvanceObject;
|
|
1911
1943
|
type AdvanceObject = {
|
|
1912
1944
|
/**
|
|
1913
|
-
* - Is Advance Payment active
|
|
1945
|
+
* - Is Advance Payment active.
|
|
1914
1946
|
*/
|
|
1915
1947
|
is_active?: boolean;
|
|
1916
1948
|
/**
|
|
1917
|
-
* - Amount for Payment Breakdown
|
|
1949
|
+
* - Amount for Payment Breakdown.
|
|
1918
1950
|
*/
|
|
1919
1951
|
amount?: number;
|
|
1920
1952
|
/**
|
|
1921
|
-
* - Time unit for refunds
|
|
1953
|
+
* - Time unit for refunds.
|
|
1922
1954
|
*/
|
|
1923
1955
|
time_unit?: string;
|
|
1924
1956
|
/**
|
|
1925
1957
|
* - The description for Advance Payment (user
|
|
1926
|
-
* configured)
|
|
1958
|
+
* configured).
|
|
1927
1959
|
*/
|
|
1928
1960
|
description?: string;
|
|
1929
1961
|
/**
|
|
1930
|
-
* - The display name for Advance payment
|
|
1962
|
+
* - The display name for Advance payment.
|
|
1931
1963
|
*/
|
|
1932
1964
|
display_name?: string;
|
|
1933
1965
|
/**
|
|
1934
|
-
* - Type of prepayment value
|
|
1966
|
+
* - Type of prepayment value.
|
|
1935
1967
|
*/
|
|
1936
1968
|
prepayment_type?: string;
|
|
1937
1969
|
/**
|
|
1938
|
-
* - Value for prepayment in advance payment
|
|
1970
|
+
* - Value for prepayment in advance payment.
|
|
1939
1971
|
*/
|
|
1940
1972
|
prepayment_value?: number;
|
|
1941
1973
|
/**
|
|
1942
|
-
* - Type of cancellation
|
|
1974
|
+
* - Type of cancellation.
|
|
1943
1975
|
*/
|
|
1944
1976
|
cancellation_type?: string;
|
|
1945
1977
|
/**
|
|
1946
|
-
* - Time limit for processing refund
|
|
1978
|
+
* - Time limit for processing refund.
|
|
1947
1979
|
*/
|
|
1948
1980
|
refund_time_limit?: number;
|
|
1949
1981
|
/**
|
|
1950
|
-
* - All available types of prepayment
|
|
1982
|
+
* - All available types of prepayment.
|
|
1951
1983
|
*/
|
|
1952
1984
|
all_prepayment_type?: string[];
|
|
1953
1985
|
/**
|
|
1954
|
-
* - Is custom advance amount allowed
|
|
1986
|
+
* - Is custom advance amount allowed?.
|
|
1955
1987
|
*/
|
|
1956
1988
|
allow_custom_advance_amount?: boolean;
|
|
1957
1989
|
};
|
|
@@ -1959,15 +1991,15 @@ type AdvanceObject = {
|
|
|
1959
1991
|
declare function SplitObject(): SplitObject;
|
|
1960
1992
|
type SplitObject = {
|
|
1961
1993
|
/**
|
|
1962
|
-
* - Maximum amount of splits allowed
|
|
1994
|
+
* - Maximum amount of splits allowed.
|
|
1963
1995
|
*/
|
|
1964
1996
|
total_number_of_splits?: number;
|
|
1965
1997
|
/**
|
|
1966
|
-
* - Number of splits remaining
|
|
1998
|
+
* - Number of splits remaining.
|
|
1967
1999
|
*/
|
|
1968
2000
|
splits_remaining?: number;
|
|
1969
2001
|
/**
|
|
1970
|
-
* - Amount pending to be paid
|
|
2002
|
+
* - Amount pending to be paid.
|
|
1971
2003
|
*/
|
|
1972
2004
|
amount_remaining?: number;
|
|
1973
2005
|
};
|
|
@@ -1975,23 +2007,23 @@ type SplitObject = {
|
|
|
1975
2007
|
declare function AdvancePaymentObject(): AdvancePaymentObject;
|
|
1976
2008
|
type AdvancePaymentObject = {
|
|
1977
2009
|
/**
|
|
1978
|
-
* - Name of Advance Payment Mode
|
|
2010
|
+
* - Name of Advance Payment Mode.
|
|
1979
2011
|
*/
|
|
1980
2012
|
name?: string;
|
|
1981
2013
|
/**
|
|
1982
|
-
* - Display Priority for Payment Option
|
|
2014
|
+
* - Display Priority for Payment Option.
|
|
1983
2015
|
*/
|
|
1984
2016
|
display_priority?: number;
|
|
1985
2017
|
/**
|
|
1986
|
-
* - Payment Mode ID for Advance Payment Option
|
|
2018
|
+
* - Payment Mode ID for Advance Payment Option.
|
|
1987
2019
|
*/
|
|
1988
2020
|
payment_mode_id?: number;
|
|
1989
2021
|
/**
|
|
1990
|
-
* - Display name for Advance Payment Mode
|
|
2022
|
+
* - Display name for Advance Payment Mode.
|
|
1991
2023
|
*/
|
|
1992
2024
|
display_name?: string;
|
|
1993
2025
|
/**
|
|
1994
|
-
* - Payment mode
|
|
2026
|
+
* - Payment mode.
|
|
1995
2027
|
*/
|
|
1996
2028
|
list?: PaymentModeList[];
|
|
1997
2029
|
split?: SplitObject;
|
|
@@ -2002,15 +2034,15 @@ declare function PaymentModeRouteResponse(): PaymentModeRouteResponse;
|
|
|
2002
2034
|
type PaymentModeRouteResponse = {
|
|
2003
2035
|
payment_options: PaymentOptionAndFlow;
|
|
2004
2036
|
/**
|
|
2005
|
-
* - Response is successful or not
|
|
2037
|
+
* - Response is successful or not.
|
|
2006
2038
|
*/
|
|
2007
2039
|
success: boolean;
|
|
2008
2040
|
/**
|
|
2009
|
-
* - Payment Breakup for advance payment
|
|
2041
|
+
* - Payment Breakup for advance payment.
|
|
2010
2042
|
*/
|
|
2011
2043
|
payment_breakup?: any;
|
|
2012
2044
|
/**
|
|
2013
|
-
* - Advance Payment Array
|
|
2045
|
+
* - Advance Payment Array.
|
|
2014
2046
|
*/
|
|
2015
2047
|
advance_payment?: AdvancePaymentObject[];
|
|
2016
2048
|
};
|
|
@@ -2018,15 +2050,15 @@ type PaymentModeRouteResponse = {
|
|
|
2018
2050
|
declare function WalletLinkRequestSchema(): WalletLinkRequestSchema;
|
|
2019
2051
|
type WalletLinkRequestSchema = {
|
|
2020
2052
|
/**
|
|
2021
|
-
* - Aggregator Name
|
|
2053
|
+
* - Aggregator Name.
|
|
2022
2054
|
*/
|
|
2023
2055
|
aggregator: string;
|
|
2024
2056
|
/**
|
|
2025
|
-
* - Mobile Number for Wallet
|
|
2057
|
+
* - Mobile Number for Wallet.
|
|
2026
2058
|
*/
|
|
2027
2059
|
mobile: string;
|
|
2028
2060
|
/**
|
|
2029
|
-
* - Wallet Code
|
|
2061
|
+
* - Wallet Code.
|
|
2030
2062
|
*/
|
|
2031
2063
|
wallet_code: string;
|
|
2032
2064
|
};
|
|
@@ -2034,15 +2066,15 @@ type WalletLinkRequestSchema = {
|
|
|
2034
2066
|
declare function WalletVerifyRequestSchema(): WalletVerifyRequestSchema;
|
|
2035
2067
|
type WalletVerifyRequestSchema = {
|
|
2036
2068
|
/**
|
|
2037
|
-
* - Aggregator Name
|
|
2069
|
+
* - Aggregator Name.
|
|
2038
2070
|
*/
|
|
2039
2071
|
aggregator: string;
|
|
2040
2072
|
/**
|
|
2041
|
-
* - Token for wallet linking
|
|
2073
|
+
* - Token for wallet linking.
|
|
2042
2074
|
*/
|
|
2043
2075
|
link_token: string;
|
|
2044
2076
|
/**
|
|
2045
|
-
* - OTP received for wallet linking
|
|
2077
|
+
* - OTP received for wallet linking.
|
|
2046
2078
|
*/
|
|
2047
2079
|
otp: number;
|
|
2048
2080
|
};
|
|
@@ -2050,11 +2082,11 @@ type WalletVerifyRequestSchema = {
|
|
|
2050
2082
|
declare function WalletDelinkRequestSchema(): WalletDelinkRequestSchema;
|
|
2051
2083
|
type WalletDelinkRequestSchema = {
|
|
2052
2084
|
/**
|
|
2053
|
-
* - Aggregator Name
|
|
2085
|
+
* - Aggregator Name.
|
|
2054
2086
|
*/
|
|
2055
2087
|
aggregator: string;
|
|
2056
2088
|
/**
|
|
2057
|
-
* - Wallet Code
|
|
2089
|
+
* - Wallet Code.
|
|
2058
2090
|
*/
|
|
2059
2091
|
wallet_code: string;
|
|
2060
2092
|
};
|
|
@@ -2062,11 +2094,11 @@ type WalletDelinkRequestSchema = {
|
|
|
2062
2094
|
declare function WalletResponseSchema(): WalletResponseSchema;
|
|
2063
2095
|
type WalletResponseSchema = {
|
|
2064
2096
|
/**
|
|
2065
|
-
* - Response received from aggregator
|
|
2097
|
+
* - Response received from aggregator.
|
|
2066
2098
|
*/
|
|
2067
2099
|
data: any;
|
|
2068
2100
|
/**
|
|
2069
|
-
* - Success/Failure of the API call
|
|
2101
|
+
* - Success/Failure of the API call.
|
|
2070
2102
|
*/
|
|
2071
2103
|
success: boolean;
|
|
2072
2104
|
};
|
|
@@ -2074,7 +2106,7 @@ type WalletResponseSchema = {
|
|
|
2074
2106
|
declare function RupifiBannerData(): RupifiBannerData;
|
|
2075
2107
|
type RupifiBannerData = {
|
|
2076
2108
|
/**
|
|
2077
|
-
* - Rupifi KYC status
|
|
2109
|
+
* - Rupifi KYC status.
|
|
2078
2110
|
*/
|
|
2079
2111
|
status?: string;
|
|
2080
2112
|
/**
|
|
@@ -2095,15 +2127,15 @@ type RupifiBannerResponse = {
|
|
|
2095
2127
|
declare function EpaylaterBannerData(): EpaylaterBannerData;
|
|
2096
2128
|
type EpaylaterBannerData = {
|
|
2097
2129
|
/**
|
|
2098
|
-
* - Epaylater KYC status
|
|
2130
|
+
* - Epaylater KYC status.
|
|
2099
2131
|
*/
|
|
2100
2132
|
status?: string;
|
|
2101
2133
|
/**
|
|
2102
|
-
* - EPayLater message
|
|
2134
|
+
* - EPayLater message.
|
|
2103
2135
|
*/
|
|
2104
2136
|
message?: string;
|
|
2105
2137
|
/**
|
|
2106
|
-
* - Need to display banner or not
|
|
2138
|
+
* - Need to display banner or not.
|
|
2107
2139
|
*/
|
|
2108
2140
|
display: boolean;
|
|
2109
2141
|
};
|
|
@@ -2120,15 +2152,15 @@ type EpaylaterBannerResponse = {
|
|
|
2120
2152
|
declare function ResendOrCancelPaymentRequest(): ResendOrCancelPaymentRequest;
|
|
2121
2153
|
type ResendOrCancelPaymentRequest = {
|
|
2122
2154
|
/**
|
|
2123
|
-
* - Unique order id
|
|
2155
|
+
* - Unique order id.
|
|
2124
2156
|
*/
|
|
2125
2157
|
order_id: string;
|
|
2126
2158
|
/**
|
|
2127
|
-
* - EDC machine Unique Identifier
|
|
2159
|
+
* - EDC machine Unique Identifier.
|
|
2128
2160
|
*/
|
|
2129
2161
|
device_id?: string;
|
|
2130
2162
|
/**
|
|
2131
|
-
* - Either resend or cancel
|
|
2163
|
+
* - Either resend or cancel.
|
|
2132
2164
|
*/
|
|
2133
2165
|
request_type: string;
|
|
2134
2166
|
};
|
|
@@ -2136,11 +2168,11 @@ type ResendOrCancelPaymentRequest = {
|
|
|
2136
2168
|
declare function LinkStatus(): LinkStatus;
|
|
2137
2169
|
type LinkStatus = {
|
|
2138
2170
|
/**
|
|
2139
|
-
* - Link action status
|
|
2171
|
+
* - Link action status.
|
|
2140
2172
|
*/
|
|
2141
2173
|
status: string;
|
|
2142
2174
|
/**
|
|
2143
|
-
* - Message
|
|
2175
|
+
* - Message.
|
|
2144
2176
|
*/
|
|
2145
2177
|
message: string;
|
|
2146
2178
|
/**
|
|
@@ -2162,11 +2194,11 @@ type ResendOrCancelPaymentResponse = {
|
|
|
2162
2194
|
declare function renderHTMLRequest(): renderHTMLRequest;
|
|
2163
2195
|
type renderHTMLRequest = {
|
|
2164
2196
|
/**
|
|
2165
|
-
* - Return Type of API
|
|
2197
|
+
* - Return Type of API.
|
|
2166
2198
|
*/
|
|
2167
2199
|
returntype?: string;
|
|
2168
2200
|
/**
|
|
2169
|
-
* - Base64 encoded html string
|
|
2201
|
+
* - Base64 encoded html string.
|
|
2170
2202
|
*/
|
|
2171
2203
|
base64_html: string;
|
|
2172
2204
|
};
|
|
@@ -2174,7 +2206,7 @@ type renderHTMLRequest = {
|
|
|
2174
2206
|
declare function renderHTMLResponse(): renderHTMLResponse;
|
|
2175
2207
|
type renderHTMLResponse = {
|
|
2176
2208
|
/**
|
|
2177
|
-
* - HTML string
|
|
2209
|
+
* - HTML string.
|
|
2178
2210
|
*/
|
|
2179
2211
|
html: string;
|
|
2180
2212
|
};
|
|
@@ -2182,11 +2214,11 @@ type renderHTMLResponse = {
|
|
|
2182
2214
|
declare function ValidateVPARequest(): ValidateVPARequest;
|
|
2183
2215
|
type ValidateVPARequest = {
|
|
2184
2216
|
/**
|
|
2185
|
-
* - UPI ID
|
|
2217
|
+
* - UPI ID.
|
|
2186
2218
|
*/
|
|
2187
2219
|
upi_vpa: string;
|
|
2188
2220
|
/**
|
|
2189
|
-
* - Aggregator slug
|
|
2221
|
+
* - Aggregator slug.
|
|
2190
2222
|
*/
|
|
2191
2223
|
aggregator?: string;
|
|
2192
2224
|
};
|
|
@@ -2194,11 +2226,11 @@ type ValidateVPARequest = {
|
|
|
2194
2226
|
declare function ValidateUPI(): ValidateUPI;
|
|
2195
2227
|
type ValidateUPI = {
|
|
2196
2228
|
/**
|
|
2197
|
-
* - VALID or INVALID
|
|
2229
|
+
* - VALID or INVALID.
|
|
2198
2230
|
*/
|
|
2199
2231
|
status: string;
|
|
2200
2232
|
/**
|
|
2201
|
-
* - Customer Bank
|
|
2233
|
+
* - Customer Bank.
|
|
2202
2234
|
*/
|
|
2203
2235
|
customer_name: string;
|
|
2204
2236
|
/**
|
|
@@ -2206,7 +2238,7 @@ type ValidateUPI = {
|
|
|
2206
2238
|
*/
|
|
2207
2239
|
is_valid: boolean;
|
|
2208
2240
|
/**
|
|
2209
|
-
* - UPI ID
|
|
2241
|
+
* - UPI ID.
|
|
2210
2242
|
*/
|
|
2211
2243
|
upi_vpa: string;
|
|
2212
2244
|
};
|
|
@@ -2223,67 +2255,68 @@ type ValidateVPAResponse = {
|
|
|
2223
2255
|
declare function CardDetails(): CardDetails;
|
|
2224
2256
|
type CardDetails = {
|
|
2225
2257
|
/**
|
|
2226
|
-
* -
|
|
2258
|
+
* - Current status of the card.
|
|
2227
2259
|
*/
|
|
2228
2260
|
status: boolean;
|
|
2229
2261
|
/**
|
|
2230
|
-
* - Country
|
|
2262
|
+
* - Country where the card was issued.
|
|
2231
2263
|
*/
|
|
2232
2264
|
country: string;
|
|
2233
2265
|
/**
|
|
2234
|
-
* -
|
|
2266
|
+
* - Code identifying the bank.
|
|
2235
2267
|
*/
|
|
2236
2268
|
bank_code: string;
|
|
2237
2269
|
/**
|
|
2238
|
-
* -
|
|
2270
|
+
* - Unique identifier for the record.
|
|
2239
2271
|
*/
|
|
2240
2272
|
id: string;
|
|
2241
2273
|
/**
|
|
2242
|
-
* - Card
|
|
2274
|
+
* - Card's expiration year.
|
|
2243
2275
|
*/
|
|
2244
2276
|
card_exp_year?: string;
|
|
2245
2277
|
/**
|
|
2246
|
-
* -
|
|
2278
|
+
* - Brand of the card (e.g., Visa, MasterCard).
|
|
2247
2279
|
*/
|
|
2248
2280
|
card_brand: string;
|
|
2249
2281
|
/**
|
|
2250
|
-
* -
|
|
2282
|
+
* - General type of the card (e.g., debit, credit).
|
|
2251
2283
|
*/
|
|
2252
2284
|
type: string;
|
|
2253
2285
|
/**
|
|
2254
|
-
* -
|
|
2286
|
+
* - Sub-type of the card (e.g., Platinum, Gold).
|
|
2255
2287
|
*/
|
|
2256
2288
|
card_sub_type: string;
|
|
2257
2289
|
/**
|
|
2258
|
-
* -
|
|
2290
|
+
* - Indicates whether the card is domestic.
|
|
2259
2291
|
*/
|
|
2260
2292
|
is_domestic_card: boolean;
|
|
2261
2293
|
/**
|
|
2262
|
-
* - Name
|
|
2294
|
+
* - Name of the cardholder.
|
|
2263
2295
|
*/
|
|
2264
2296
|
name_on_card?: string;
|
|
2265
2297
|
/**
|
|
2266
|
-
* - Card
|
|
2298
|
+
* - Card's expiration month.
|
|
2267
2299
|
*/
|
|
2268
2300
|
card_exp_month?: string;
|
|
2269
2301
|
/**
|
|
2270
|
-
* - Extended
|
|
2302
|
+
* - Extended type of the card, providing
|
|
2303
|
+
* more specific classification.
|
|
2271
2304
|
*/
|
|
2272
2305
|
extended_card_type: string;
|
|
2273
2306
|
/**
|
|
2274
|
-
* -
|
|
2307
|
+
* - Object representation of the card.
|
|
2275
2308
|
*/
|
|
2276
2309
|
card_object: string;
|
|
2277
2310
|
/**
|
|
2278
|
-
* -
|
|
2311
|
+
* - Encrypted token representing the card.
|
|
2279
2312
|
*/
|
|
2280
2313
|
card_token?: string;
|
|
2281
2314
|
/**
|
|
2282
|
-
* -
|
|
2315
|
+
* - User associated with the card.
|
|
2283
2316
|
*/
|
|
2284
2317
|
user?: string;
|
|
2285
2318
|
/**
|
|
2286
|
-
* - Bank
|
|
2319
|
+
* - Bank associated with the card.
|
|
2287
2320
|
*/
|
|
2288
2321
|
bank: string;
|
|
2289
2322
|
};
|
|
@@ -2300,23 +2333,23 @@ type CardDetailsResponse = {
|
|
|
2300
2333
|
declare function TransferItemsDetails(): TransferItemsDetails;
|
|
2301
2334
|
type TransferItemsDetails = {
|
|
2302
2335
|
/**
|
|
2303
|
-
* -
|
|
2336
|
+
* - Id of the transfer item.
|
|
2304
2337
|
*/
|
|
2305
2338
|
id: number;
|
|
2306
2339
|
/**
|
|
2307
|
-
* - Beneficiary Display Name
|
|
2340
|
+
* - Beneficiary Display Name.
|
|
2308
2341
|
*/
|
|
2309
2342
|
display_name?: string;
|
|
2310
2343
|
/**
|
|
2311
|
-
* - Beneficiary large Logo
|
|
2344
|
+
* - Beneficiary large Logo.
|
|
2312
2345
|
*/
|
|
2313
2346
|
logo_large: string;
|
|
2314
2347
|
/**
|
|
2315
|
-
* - Beneficiary small Logo
|
|
2348
|
+
* - Beneficiary small Logo.
|
|
2316
2349
|
*/
|
|
2317
2350
|
logo_small: string;
|
|
2318
2351
|
/**
|
|
2319
|
-
* - Beneficiary Name
|
|
2352
|
+
* - Beneficiary Name.
|
|
2320
2353
|
*/
|
|
2321
2354
|
name: string;
|
|
2322
2355
|
};
|
|
@@ -2324,11 +2357,11 @@ type TransferItemsDetails = {
|
|
|
2324
2357
|
declare function TransferModeDetails(): TransferModeDetails;
|
|
2325
2358
|
type TransferModeDetails = {
|
|
2326
2359
|
/**
|
|
2327
|
-
* - Beneficiary Mode Items
|
|
2360
|
+
* - Beneficiary Mode Items.
|
|
2328
2361
|
*/
|
|
2329
2362
|
items?: TransferItemsDetails[];
|
|
2330
2363
|
/**
|
|
2331
|
-
* - Beneficiary Mode Name
|
|
2364
|
+
* - Beneficiary Mode Name.
|
|
2332
2365
|
*/
|
|
2333
2366
|
display_name: string;
|
|
2334
2367
|
};
|
|
@@ -2336,7 +2369,7 @@ type TransferModeDetails = {
|
|
|
2336
2369
|
declare function TransferModeResponse(): TransferModeResponse;
|
|
2337
2370
|
type TransferModeResponse = {
|
|
2338
2371
|
/**
|
|
2339
|
-
* - Response Object
|
|
2372
|
+
* - Response Object.
|
|
2340
2373
|
*/
|
|
2341
2374
|
data: TransferModeDetails[];
|
|
2342
2375
|
};
|
|
@@ -2344,11 +2377,11 @@ type TransferModeResponse = {
|
|
|
2344
2377
|
declare function UpdateRefundTransferModeRequest(): UpdateRefundTransferModeRequest;
|
|
2345
2378
|
type UpdateRefundTransferModeRequest = {
|
|
2346
2379
|
/**
|
|
2347
|
-
* - True for enabling the Transfer Mode
|
|
2380
|
+
* - True for enabling the Transfer Mode.
|
|
2348
2381
|
*/
|
|
2349
2382
|
enable: boolean;
|
|
2350
2383
|
/**
|
|
2351
|
-
* - Transfer Mode of the Beneficiary to be added
|
|
2384
|
+
* - Transfer Mode of the Beneficiary to be added.
|
|
2352
2385
|
*/
|
|
2353
2386
|
transfer_mode: string;
|
|
2354
2387
|
};
|
|
@@ -2356,7 +2389,7 @@ type UpdateRefundTransferModeRequest = {
|
|
|
2356
2389
|
declare function UpdateRefundTransferModeResponse(): UpdateRefundTransferModeResponse;
|
|
2357
2390
|
type UpdateRefundTransferModeResponse = {
|
|
2358
2391
|
/**
|
|
2359
|
-
* - Response is successful or not
|
|
2392
|
+
* - Response is successful or not.
|
|
2360
2393
|
*/
|
|
2361
2394
|
success?: boolean;
|
|
2362
2395
|
};
|
|
@@ -2364,79 +2397,79 @@ type UpdateRefundTransferModeResponse = {
|
|
|
2364
2397
|
declare function OrderBeneficiaryDetails(): OrderBeneficiaryDetails;
|
|
2365
2398
|
type OrderBeneficiaryDetails = {
|
|
2366
2399
|
/**
|
|
2367
|
-
* - MOdification Date of Beneficiary
|
|
2400
|
+
* - MOdification Date of Beneficiary.
|
|
2368
2401
|
*/
|
|
2369
2402
|
modified_on: string;
|
|
2370
2403
|
/**
|
|
2371
|
-
* - Account Number
|
|
2404
|
+
* - Account Number.
|
|
2372
2405
|
*/
|
|
2373
2406
|
account_no: string;
|
|
2374
2407
|
/**
|
|
2375
|
-
* - MObile no of User
|
|
2408
|
+
* - MObile no of User.
|
|
2376
2409
|
*/
|
|
2377
2410
|
mobile?: string;
|
|
2378
2411
|
/**
|
|
2379
|
-
* - Bank Name Of Account
|
|
2412
|
+
* - Bank Name Of Account.
|
|
2380
2413
|
*/
|
|
2381
2414
|
bank_name: string;
|
|
2382
2415
|
/**
|
|
2383
|
-
* - Ifsc Code Of Account
|
|
2416
|
+
* - Ifsc Code Of Account.
|
|
2384
2417
|
*/
|
|
2385
2418
|
ifsc_code: string;
|
|
2386
2419
|
/**
|
|
2387
|
-
* - Boolean Flag whether Beneficiary set or not
|
|
2420
|
+
* - Boolean Flag whether Beneficiary set or not.
|
|
2388
2421
|
*/
|
|
2389
2422
|
is_active: boolean;
|
|
2390
2423
|
/**
|
|
2391
|
-
* -
|
|
2424
|
+
* - Beneficiary Id.
|
|
2392
2425
|
*/
|
|
2393
2426
|
beneficiary_id: string;
|
|
2394
2427
|
/**
|
|
2395
|
-
* - Account Holder Name
|
|
2428
|
+
* - Account Holder Name.
|
|
2396
2429
|
*/
|
|
2397
2430
|
account_holder: string;
|
|
2398
2431
|
/**
|
|
2399
|
-
* - EMail of User
|
|
2432
|
+
* - EMail of User.
|
|
2400
2433
|
*/
|
|
2401
2434
|
email: string;
|
|
2402
2435
|
/**
|
|
2403
|
-
* - User Id Who filled the Beneficiary
|
|
2436
|
+
* - User Id Who filled the Beneficiary.
|
|
2404
2437
|
*/
|
|
2405
2438
|
delights_user_name?: string;
|
|
2406
2439
|
/**
|
|
2407
|
-
* -
|
|
2440
|
+
* - Id of the Order Beneficiary.
|
|
2408
2441
|
*/
|
|
2409
2442
|
id: number;
|
|
2410
2443
|
/**
|
|
2411
|
-
* - Transfer Mode Of Account
|
|
2444
|
+
* - Transfer Mode Of Account.
|
|
2412
2445
|
*/
|
|
2413
2446
|
transfer_mode: string;
|
|
2414
2447
|
/**
|
|
2415
|
-
* - Branch Name Of Account
|
|
2448
|
+
* - Branch Name Of Account.
|
|
2416
2449
|
*/
|
|
2417
2450
|
branch_name?: string;
|
|
2418
2451
|
/**
|
|
2419
|
-
* - Creation Date of Beneficiary
|
|
2452
|
+
* - Creation Date of Beneficiary.
|
|
2420
2453
|
*/
|
|
2421
2454
|
created_on: string;
|
|
2422
2455
|
/**
|
|
2423
|
-
* - SHort Title Of Account
|
|
2456
|
+
* - SHort Title Of Account.
|
|
2424
2457
|
*/
|
|
2425
2458
|
subtitle: string;
|
|
2426
2459
|
/**
|
|
2427
|
-
* - Remarks
|
|
2460
|
+
* - Remarks.
|
|
2428
2461
|
*/
|
|
2429
2462
|
comment?: string;
|
|
2430
2463
|
/**
|
|
2431
|
-
* - Address of User
|
|
2464
|
+
* - Address of User.
|
|
2432
2465
|
*/
|
|
2433
2466
|
address: string;
|
|
2434
2467
|
/**
|
|
2435
|
-
* - Title Of Account
|
|
2468
|
+
* - Title Of Account.
|
|
2436
2469
|
*/
|
|
2437
2470
|
title: string;
|
|
2438
2471
|
/**
|
|
2439
|
-
* - Display Name Of Account
|
|
2472
|
+
* - Display Name Of Account.
|
|
2440
2473
|
*/
|
|
2441
2474
|
display_name: string;
|
|
2442
2475
|
};
|
|
@@ -2448,7 +2481,7 @@ type OrderBeneficiaryResponse = {
|
|
|
2448
2481
|
*/
|
|
2449
2482
|
show_beneficiary_details?: boolean;
|
|
2450
2483
|
/**
|
|
2451
|
-
* - All Beneficiaries Of An Order
|
|
2484
|
+
* - All Beneficiaries Of An Order.
|
|
2452
2485
|
*/
|
|
2453
2486
|
beneficiaries?: OrderBeneficiaryDetails[];
|
|
2454
2487
|
};
|
|
@@ -2456,15 +2489,15 @@ type OrderBeneficiaryResponse = {
|
|
|
2456
2489
|
declare function NotFoundResourceError(): NotFoundResourceError;
|
|
2457
2490
|
type NotFoundResourceError = {
|
|
2458
2491
|
/**
|
|
2459
|
-
* - Bad Request Data
|
|
2492
|
+
* - Bad Request Data.
|
|
2460
2493
|
*/
|
|
2461
2494
|
code: string;
|
|
2462
2495
|
/**
|
|
2463
|
-
* - Not Found
|
|
2496
|
+
* - Not Found.
|
|
2464
2497
|
*/
|
|
2465
2498
|
description: string;
|
|
2466
2499
|
/**
|
|
2467
|
-
* - Response is successful or not
|
|
2500
|
+
* - Response is successful or not.
|
|
2468
2501
|
*/
|
|
2469
2502
|
success: boolean;
|
|
2470
2503
|
};
|
|
@@ -2472,15 +2505,15 @@ type NotFoundResourceError = {
|
|
|
2472
2505
|
declare function IfscCodeResponse(): IfscCodeResponse;
|
|
2473
2506
|
type IfscCodeResponse = {
|
|
2474
2507
|
/**
|
|
2475
|
-
* - Branch Name Of Account
|
|
2508
|
+
* - Branch Name Of Account.
|
|
2476
2509
|
*/
|
|
2477
2510
|
branch_name: string;
|
|
2478
2511
|
/**
|
|
2479
|
-
* - Response is successful or not
|
|
2512
|
+
* - Response is successful or not.
|
|
2480
2513
|
*/
|
|
2481
2514
|
success?: boolean;
|
|
2482
2515
|
/**
|
|
2483
|
-
* - Bank Name Of Account
|
|
2516
|
+
* - Bank Name Of Account.
|
|
2484
2517
|
*/
|
|
2485
2518
|
bank_name: string;
|
|
2486
2519
|
};
|
|
@@ -2488,7 +2521,7 @@ type IfscCodeResponse = {
|
|
|
2488
2521
|
declare function ErrorCodeDescription(): ErrorCodeDescription;
|
|
2489
2522
|
type ErrorCodeDescription = {
|
|
2490
2523
|
/**
|
|
2491
|
-
* - Error
|
|
2524
|
+
* - Error description code.
|
|
2492
2525
|
*/
|
|
2493
2526
|
code: string;
|
|
2494
2527
|
/**
|
|
@@ -2496,7 +2529,7 @@ type ErrorCodeDescription = {
|
|
|
2496
2529
|
*/
|
|
2497
2530
|
description: string;
|
|
2498
2531
|
/**
|
|
2499
|
-
* - Response is successful or not
|
|
2532
|
+
* - Response is successful or not.
|
|
2500
2533
|
*/
|
|
2501
2534
|
success: boolean;
|
|
2502
2535
|
};
|
|
@@ -2504,15 +2537,15 @@ type ErrorCodeDescription = {
|
|
|
2504
2537
|
declare function AddBeneficiaryViaOtpVerificationRequest(): AddBeneficiaryViaOtpVerificationRequest;
|
|
2505
2538
|
type AddBeneficiaryViaOtpVerificationRequest = {
|
|
2506
2539
|
/**
|
|
2507
|
-
* - Request
|
|
2540
|
+
* - Request id.
|
|
2508
2541
|
*/
|
|
2509
2542
|
request_id: string;
|
|
2510
2543
|
/**
|
|
2511
|
-
* - Hash key of the beneficiary Id
|
|
2544
|
+
* - Hash key of the beneficiary Id.
|
|
2512
2545
|
*/
|
|
2513
2546
|
hash_key: string;
|
|
2514
2547
|
/**
|
|
2515
|
-
* - Otp sent to the given Mobile No
|
|
2548
|
+
* - Otp sent to the given Mobile No.
|
|
2516
2549
|
*/
|
|
2517
2550
|
otp: string;
|
|
2518
2551
|
};
|
|
@@ -2520,11 +2553,11 @@ type AddBeneficiaryViaOtpVerificationRequest = {
|
|
|
2520
2553
|
declare function AddBeneficiaryViaOtpVerificationResponse(): AddBeneficiaryViaOtpVerificationResponse;
|
|
2521
2554
|
type AddBeneficiaryViaOtpVerificationResponse = {
|
|
2522
2555
|
/**
|
|
2523
|
-
* - Response is successful or not
|
|
2556
|
+
* - Response is successful or not.
|
|
2524
2557
|
*/
|
|
2525
2558
|
success?: boolean;
|
|
2526
2559
|
/**
|
|
2527
|
-
* - Aggregator Response of
|
|
2560
|
+
* - Aggregator Response of beneficiary.
|
|
2528
2561
|
*/
|
|
2529
2562
|
message: string;
|
|
2530
2563
|
};
|
|
@@ -2532,15 +2565,15 @@ type AddBeneficiaryViaOtpVerificationResponse = {
|
|
|
2532
2565
|
declare function WrongOtpError(): WrongOtpError;
|
|
2533
2566
|
type WrongOtpError = {
|
|
2534
2567
|
/**
|
|
2535
|
-
* -
|
|
2568
|
+
* - Verified flag.
|
|
2536
2569
|
*/
|
|
2537
2570
|
is_verified_flag: boolean;
|
|
2538
2571
|
/**
|
|
2539
|
-
* - Wrong OTP Code
|
|
2572
|
+
* - Wrong OTP Code.
|
|
2540
2573
|
*/
|
|
2541
2574
|
description: string;
|
|
2542
2575
|
/**
|
|
2543
|
-
* - Response is successful or not
|
|
2576
|
+
* - Response is successful or not.
|
|
2544
2577
|
*/
|
|
2545
2578
|
success: string;
|
|
2546
2579
|
};
|
|
@@ -2548,41 +2581,47 @@ type WrongOtpError = {
|
|
|
2548
2581
|
declare function BeneficiaryModeDetails(): BeneficiaryModeDetails;
|
|
2549
2582
|
type BeneficiaryModeDetails = {
|
|
2550
2583
|
/**
|
|
2551
|
-
* - Account
|
|
2584
|
+
* - Account Number of the Account Holder.
|
|
2552
2585
|
*/
|
|
2553
2586
|
account_no: string;
|
|
2554
2587
|
/**
|
|
2555
|
-
* - Address of the User
|
|
2588
|
+
* - Address of the User.
|
|
2556
2589
|
*/
|
|
2557
2590
|
address?: string;
|
|
2558
2591
|
/**
|
|
2559
|
-
* -
|
|
2592
|
+
* - Mobile Number of the User.
|
|
2560
2593
|
*/
|
|
2561
2594
|
mobile: string;
|
|
2562
2595
|
/**
|
|
2563
|
-
* - Bank Name of the Account
|
|
2596
|
+
* - Bank Name of the Account.
|
|
2564
2597
|
*/
|
|
2565
2598
|
bank_name: string;
|
|
2566
2599
|
/**
|
|
2567
|
-
* - Remarks added by The user
|
|
2600
|
+
* - Remarks added by The user.
|
|
2568
2601
|
*/
|
|
2569
2602
|
comment?: string;
|
|
2570
2603
|
/**
|
|
2571
|
-
* - Ifsc Code of the Account
|
|
2604
|
+
* - Ifsc Code of the Account.
|
|
2572
2605
|
*/
|
|
2573
2606
|
ifsc_code: string;
|
|
2607
|
+
/**
|
|
2608
|
+
* - VPA of the Account.
|
|
2609
|
+
*/
|
|
2574
2610
|
vpa?: string;
|
|
2575
2611
|
/**
|
|
2576
|
-
* - Branch Name of the Account
|
|
2612
|
+
* - Branch Name of the Account.
|
|
2577
2613
|
*/
|
|
2578
2614
|
branch_name: string;
|
|
2579
2615
|
/**
|
|
2580
|
-
* - Name of the Account Holder
|
|
2616
|
+
* - Name of the Account Holder.
|
|
2581
2617
|
*/
|
|
2582
2618
|
account_holder: string;
|
|
2619
|
+
/**
|
|
2620
|
+
* - Wallet of the Account.
|
|
2621
|
+
*/
|
|
2583
2622
|
wallet?: string;
|
|
2584
2623
|
/**
|
|
2585
|
-
* - Email of the Account Holder
|
|
2624
|
+
* - Email of the Account Holder.
|
|
2586
2625
|
*/
|
|
2587
2626
|
email: string;
|
|
2588
2627
|
};
|
|
@@ -2591,28 +2630,37 @@ declare function AddBeneficiaryDetailsRequest(): AddBeneficiaryDetailsRequest;
|
|
|
2591
2630
|
type AddBeneficiaryDetailsRequest = {
|
|
2592
2631
|
/**
|
|
2593
2632
|
* - True if beneficiary to be added by delights or
|
|
2594
|
-
* False if by User
|
|
2633
|
+
* False if by User.
|
|
2595
2634
|
*/
|
|
2596
2635
|
delights: boolean;
|
|
2597
2636
|
/**
|
|
2598
|
-
* - Shipment Id of the respective Merchant Order Id
|
|
2637
|
+
* - Shipment Id of the respective Merchant Order Id.
|
|
2599
2638
|
*/
|
|
2600
2639
|
shipment_id: string;
|
|
2601
2640
|
details: BeneficiaryModeDetails;
|
|
2641
|
+
/**
|
|
2642
|
+
* - OTP received by customer.
|
|
2643
|
+
*/
|
|
2602
2644
|
otp?: string;
|
|
2603
2645
|
/**
|
|
2604
|
-
* - Merchant Order Id
|
|
2646
|
+
* - Merchant Order Id.
|
|
2605
2647
|
*/
|
|
2606
2648
|
order_id: string;
|
|
2607
2649
|
/**
|
|
2608
|
-
* - Transfer Mode of the Beneficiary to be added
|
|
2650
|
+
* - Transfer Mode of the Beneficiary to be added.
|
|
2609
2651
|
*/
|
|
2610
2652
|
transfer_mode: string;
|
|
2653
|
+
/**
|
|
2654
|
+
* - Request Id for add benificiary request.
|
|
2655
|
+
*/
|
|
2611
2656
|
request_id?: string;
|
|
2612
2657
|
};
|
|
2613
2658
|
/** @returns {RefundAccountResponse} */
|
|
2614
2659
|
declare function RefundAccountResponse(): RefundAccountResponse;
|
|
2615
2660
|
type RefundAccountResponse = {
|
|
2661
|
+
/**
|
|
2662
|
+
* - Flag for verification of refund.
|
|
2663
|
+
*/
|
|
2616
2664
|
is_verified_flag?: boolean;
|
|
2617
2665
|
/**
|
|
2618
2666
|
* - Refund account data.
|
|
@@ -2623,22 +2671,40 @@ type RefundAccountResponse = {
|
|
|
2623
2671
|
*/
|
|
2624
2672
|
success: boolean;
|
|
2625
2673
|
/**
|
|
2626
|
-
* - Response message
|
|
2674
|
+
* - Response message.
|
|
2627
2675
|
*/
|
|
2628
2676
|
message: string;
|
|
2629
2677
|
};
|
|
2630
2678
|
/** @returns {BankDetailsForOTP} */
|
|
2631
2679
|
declare function BankDetailsForOTP(): BankDetailsForOTP;
|
|
2632
2680
|
type BankDetailsForOTP = {
|
|
2681
|
+
/**
|
|
2682
|
+
* - Account number of the holder.
|
|
2683
|
+
*/
|
|
2633
2684
|
account_no: string;
|
|
2685
|
+
/**
|
|
2686
|
+
* - Name of the bank.
|
|
2687
|
+
*/
|
|
2634
2688
|
bank_name: string;
|
|
2689
|
+
/**
|
|
2690
|
+
* - IFSC code of the bank.
|
|
2691
|
+
*/
|
|
2635
2692
|
ifsc_code: string;
|
|
2693
|
+
/**
|
|
2694
|
+
* - Branch name of the bank.
|
|
2695
|
+
*/
|
|
2636
2696
|
branch_name: string;
|
|
2697
|
+
/**
|
|
2698
|
+
* - Name of the account holder.
|
|
2699
|
+
*/
|
|
2637
2700
|
account_holder: string;
|
|
2638
2701
|
};
|
|
2639
2702
|
/** @returns {AddBeneficiaryDetailsOTPRequest} */
|
|
2640
2703
|
declare function AddBeneficiaryDetailsOTPRequest(): AddBeneficiaryDetailsOTPRequest;
|
|
2641
2704
|
type AddBeneficiaryDetailsOTPRequest = {
|
|
2705
|
+
/**
|
|
2706
|
+
* - Unique identifier for an order.
|
|
2707
|
+
*/
|
|
2642
2708
|
order_id: string;
|
|
2643
2709
|
details: BankDetailsForOTP;
|
|
2644
2710
|
};
|
|
@@ -2646,11 +2712,11 @@ type AddBeneficiaryDetailsOTPRequest = {
|
|
|
2646
2712
|
declare function WalletOtpRequest(): WalletOtpRequest;
|
|
2647
2713
|
type WalletOtpRequest = {
|
|
2648
2714
|
/**
|
|
2649
|
-
* - Country Code of the Mobile Number
|
|
2715
|
+
* - Country Code of the Mobile Number.
|
|
2650
2716
|
*/
|
|
2651
2717
|
country_code: string;
|
|
2652
2718
|
/**
|
|
2653
|
-
* - Wallet
|
|
2719
|
+
* - Wallet Mobile Number of the User.
|
|
2654
2720
|
*/
|
|
2655
2721
|
mobile: string;
|
|
2656
2722
|
};
|
|
@@ -2658,16 +2724,16 @@ type WalletOtpRequest = {
|
|
|
2658
2724
|
declare function WalletOtpResponse(): WalletOtpResponse;
|
|
2659
2725
|
type WalletOtpResponse = {
|
|
2660
2726
|
/**
|
|
2661
|
-
* - Request
|
|
2727
|
+
* - Request Id for wallet otp request.
|
|
2662
2728
|
*/
|
|
2663
2729
|
request_id: string;
|
|
2664
2730
|
/**
|
|
2665
2731
|
* - Boolean Flag whether OTP Validation is
|
|
2666
|
-
* already done or not
|
|
2732
|
+
* already done or not.
|
|
2667
2733
|
*/
|
|
2668
2734
|
is_verified_flag: string;
|
|
2669
2735
|
/**
|
|
2670
|
-
* - Response is successful or not
|
|
2736
|
+
* - Response is successful or not.
|
|
2671
2737
|
*/
|
|
2672
2738
|
success?: boolean;
|
|
2673
2739
|
};
|
|
@@ -2675,11 +2741,11 @@ type WalletOtpResponse = {
|
|
|
2675
2741
|
declare function SetDefaultBeneficiaryRequest(): SetDefaultBeneficiaryRequest;
|
|
2676
2742
|
type SetDefaultBeneficiaryRequest = {
|
|
2677
2743
|
/**
|
|
2678
|
-
* - Merchant Order Id
|
|
2744
|
+
* - Merchant Order Id.
|
|
2679
2745
|
*/
|
|
2680
2746
|
order_id: string;
|
|
2681
2747
|
/**
|
|
2682
|
-
* - Beneficiary Hash Id of the beneficiary added
|
|
2748
|
+
* - Beneficiary Hash Id of the beneficiary added.
|
|
2683
2749
|
*/
|
|
2684
2750
|
beneficiary_id: string;
|
|
2685
2751
|
};
|
|
@@ -2687,11 +2753,11 @@ type SetDefaultBeneficiaryRequest = {
|
|
|
2687
2753
|
declare function SetDefaultBeneficiaryResponse(): SetDefaultBeneficiaryResponse;
|
|
2688
2754
|
type SetDefaultBeneficiaryResponse = {
|
|
2689
2755
|
/**
|
|
2690
|
-
* - Boolean Flag whether Beneficiary set or not
|
|
2756
|
+
* - Boolean Flag whether Beneficiary set or not.
|
|
2691
2757
|
*/
|
|
2692
2758
|
is_beneficiary_set: boolean;
|
|
2693
2759
|
/**
|
|
2694
|
-
* - Response is successful or not
|
|
2760
|
+
* - Response is successful or not.
|
|
2695
2761
|
*/
|
|
2696
2762
|
success?: boolean;
|
|
2697
2763
|
};
|
|
@@ -2699,39 +2765,39 @@ type SetDefaultBeneficiaryResponse = {
|
|
|
2699
2765
|
declare function GetPaymentLinkResponse(): GetPaymentLinkResponse;
|
|
2700
2766
|
type GetPaymentLinkResponse = {
|
|
2701
2767
|
/**
|
|
2702
|
-
* - HTTP status code
|
|
2768
|
+
* - HTTP status code.
|
|
2703
2769
|
*/
|
|
2704
2770
|
status_code: number;
|
|
2705
2771
|
/**
|
|
2706
|
-
* - Status of payment link
|
|
2772
|
+
* - Status of payment link.
|
|
2707
2773
|
*/
|
|
2708
2774
|
payment_link_current_status?: string;
|
|
2709
2775
|
/**
|
|
2710
|
-
* - Successful or failure
|
|
2776
|
+
* - Successful or failure.
|
|
2711
2777
|
*/
|
|
2712
2778
|
success: boolean;
|
|
2713
2779
|
/**
|
|
2714
|
-
* - Polling request timeout
|
|
2780
|
+
* - Polling request timeout.
|
|
2715
2781
|
*/
|
|
2716
2782
|
polling_timeout?: number;
|
|
2717
2783
|
/**
|
|
2718
|
-
* - Url of payment link
|
|
2784
|
+
* - Url of payment link.
|
|
2719
2785
|
*/
|
|
2720
2786
|
payment_link_url?: string;
|
|
2721
2787
|
/**
|
|
2722
|
-
* - Merchant order id
|
|
2788
|
+
* - Merchant order id.
|
|
2723
2789
|
*/
|
|
2724
2790
|
external_order_id?: string;
|
|
2725
2791
|
/**
|
|
2726
|
-
* -
|
|
2792
|
+
* - Detailed message.
|
|
2727
2793
|
*/
|
|
2728
2794
|
message: string;
|
|
2729
2795
|
/**
|
|
2730
|
-
* - Merchant name
|
|
2796
|
+
* - Merchant name.
|
|
2731
2797
|
*/
|
|
2732
2798
|
merchant_name?: string;
|
|
2733
2799
|
/**
|
|
2734
|
-
* - Total value of order
|
|
2800
|
+
* - Total value of order.
|
|
2735
2801
|
*/
|
|
2736
2802
|
amount?: number;
|
|
2737
2803
|
};
|
|
@@ -2739,35 +2805,35 @@ type GetPaymentLinkResponse = {
|
|
|
2739
2805
|
declare function ErrorDescription(): ErrorDescription;
|
|
2740
2806
|
type ErrorDescription = {
|
|
2741
2807
|
/**
|
|
2742
|
-
* - Payment transaction id
|
|
2808
|
+
* - Payment transaction id.
|
|
2743
2809
|
*/
|
|
2744
2810
|
payment_transaction_id?: string;
|
|
2745
2811
|
/**
|
|
2746
|
-
* - Payment link expired or not
|
|
2812
|
+
* - Payment link expired or not.
|
|
2747
2813
|
*/
|
|
2748
2814
|
expired?: boolean;
|
|
2749
2815
|
/**
|
|
2750
|
-
* - Order
|
|
2816
|
+
* - Merchant Order Id.
|
|
2751
2817
|
*/
|
|
2752
2818
|
merchant_order_id?: string;
|
|
2753
2819
|
/**
|
|
2754
|
-
* - Name of merchant that created payment link
|
|
2820
|
+
* - Name of merchant that created payment link.
|
|
2755
2821
|
*/
|
|
2756
2822
|
merchant_name?: string;
|
|
2757
2823
|
/**
|
|
2758
|
-
* -
|
|
2824
|
+
* - Detailed message.
|
|
2759
2825
|
*/
|
|
2760
2826
|
msg?: string;
|
|
2761
2827
|
/**
|
|
2762
|
-
* - Payment link is cancelled or not
|
|
2828
|
+
* - Payment link is cancelled or not.
|
|
2763
2829
|
*/
|
|
2764
2830
|
cancelled?: boolean;
|
|
2765
2831
|
/**
|
|
2766
|
-
* - Amount paid
|
|
2832
|
+
* - Amount paid.
|
|
2767
2833
|
*/
|
|
2768
2834
|
amount?: number;
|
|
2769
2835
|
/**
|
|
2770
|
-
* - Payment link id is valid or not
|
|
2836
|
+
* - Payment link id is valid or not.
|
|
2771
2837
|
*/
|
|
2772
2838
|
invalid_id?: boolean;
|
|
2773
2839
|
};
|
|
@@ -2775,50 +2841,64 @@ type ErrorDescription = {
|
|
|
2775
2841
|
declare function ErrorResponse(): ErrorResponse;
|
|
2776
2842
|
type ErrorResponse = {
|
|
2777
2843
|
/**
|
|
2778
|
-
* - HTTP status code
|
|
2844
|
+
* - HTTP status code.
|
|
2779
2845
|
*/
|
|
2780
2846
|
status_code: number;
|
|
2781
2847
|
error?: ErrorDescription;
|
|
2782
2848
|
/**
|
|
2783
|
-
* -
|
|
2849
|
+
* - Detailed message.
|
|
2784
2850
|
*/
|
|
2785
2851
|
message: string;
|
|
2786
2852
|
/**
|
|
2787
|
-
* - Successful or failure
|
|
2853
|
+
* - Successful or failure.
|
|
2788
2854
|
*/
|
|
2789
2855
|
success: boolean;
|
|
2790
2856
|
};
|
|
2791
2857
|
/** @returns {CreatePaymentLinkMeta} */
|
|
2792
2858
|
declare function CreatePaymentLinkMeta(): CreatePaymentLinkMeta;
|
|
2793
2859
|
type CreatePaymentLinkMeta = {
|
|
2860
|
+
/**
|
|
2861
|
+
* - Unique identifier for the shopping cart.
|
|
2862
|
+
*/
|
|
2794
2863
|
cart_id: string;
|
|
2864
|
+
/**
|
|
2865
|
+
* - Mode of checkout process (e.g., guest,
|
|
2866
|
+
* registered user).
|
|
2867
|
+
*/
|
|
2795
2868
|
checkout_mode: string;
|
|
2869
|
+
/**
|
|
2870
|
+
* - Identifier for the card assigned to the
|
|
2871
|
+
* transaction.
|
|
2872
|
+
*/
|
|
2796
2873
|
assign_card_id?: string;
|
|
2874
|
+
/**
|
|
2875
|
+
* - Total amount for the transaction.
|
|
2876
|
+
*/
|
|
2797
2877
|
amount: string;
|
|
2798
2878
|
};
|
|
2799
2879
|
/** @returns {CreatePaymentLinkRequest} */
|
|
2800
2880
|
declare function CreatePaymentLinkRequest(): CreatePaymentLinkRequest;
|
|
2801
2881
|
type CreatePaymentLinkRequest = {
|
|
2802
2882
|
/**
|
|
2803
|
-
* - Merchant order id
|
|
2883
|
+
* - Merchant order id.
|
|
2804
2884
|
*/
|
|
2805
2885
|
description?: string;
|
|
2806
2886
|
/**
|
|
2807
|
-
* - Merchant order id
|
|
2887
|
+
* - Merchant order id.
|
|
2808
2888
|
*/
|
|
2809
2889
|
external_order_id: string;
|
|
2810
2890
|
/**
|
|
2811
2891
|
* - Mobile number to which the payment link is
|
|
2812
|
-
* to be sent
|
|
2892
|
+
* to be sent.
|
|
2813
2893
|
*/
|
|
2814
2894
|
mobile_number: string;
|
|
2815
2895
|
/**
|
|
2816
|
-
* - Total value of order
|
|
2896
|
+
* - Total value of order.
|
|
2817
2897
|
*/
|
|
2818
2898
|
amount: number;
|
|
2819
2899
|
meta: CreatePaymentLinkMeta;
|
|
2820
2900
|
/**
|
|
2821
|
-
* - Email to which the payment link is to be sent
|
|
2901
|
+
* - Email to which the payment link is to be sent.
|
|
2822
2902
|
*/
|
|
2823
2903
|
email: string;
|
|
2824
2904
|
};
|
|
@@ -2826,27 +2906,27 @@ type CreatePaymentLinkRequest = {
|
|
|
2826
2906
|
declare function CreatePaymentLinkResponse(): CreatePaymentLinkResponse;
|
|
2827
2907
|
type CreatePaymentLinkResponse = {
|
|
2828
2908
|
/**
|
|
2829
|
-
* - HTTP status code
|
|
2909
|
+
* - HTTP status code.
|
|
2830
2910
|
*/
|
|
2831
2911
|
status_code: number;
|
|
2832
2912
|
/**
|
|
2833
|
-
* - Successful or failure
|
|
2913
|
+
* - Successful or failure.
|
|
2834
2914
|
*/
|
|
2835
2915
|
success: boolean;
|
|
2836
2916
|
/**
|
|
2837
|
-
* - Polling request timeout
|
|
2917
|
+
* - Polling request timeout.
|
|
2838
2918
|
*/
|
|
2839
2919
|
polling_timeout?: number;
|
|
2840
2920
|
/**
|
|
2841
|
-
* - Url of payment link
|
|
2921
|
+
* - Url of payment link.
|
|
2842
2922
|
*/
|
|
2843
2923
|
payment_link_url?: string;
|
|
2844
2924
|
/**
|
|
2845
|
-
* -
|
|
2925
|
+
* - Detailed message.
|
|
2846
2926
|
*/
|
|
2847
2927
|
message: string;
|
|
2848
2928
|
/**
|
|
2849
|
-
* - Unique id of payment link
|
|
2929
|
+
* - Unique id of payment link.
|
|
2850
2930
|
*/
|
|
2851
2931
|
payment_link_id?: string;
|
|
2852
2932
|
};
|
|
@@ -2854,7 +2934,7 @@ type CreatePaymentLinkResponse = {
|
|
|
2854
2934
|
declare function CancelOrResendPaymentLinkRequest(): CancelOrResendPaymentLinkRequest;
|
|
2855
2935
|
type CancelOrResendPaymentLinkRequest = {
|
|
2856
2936
|
/**
|
|
2857
|
-
* - Unique id of payment link
|
|
2937
|
+
* - Unique id of payment link.
|
|
2858
2938
|
*/
|
|
2859
2939
|
payment_link_id: string;
|
|
2860
2940
|
};
|
|
@@ -2862,19 +2942,19 @@ type CancelOrResendPaymentLinkRequest = {
|
|
|
2862
2942
|
declare function ResendPaymentLinkResponse(): ResendPaymentLinkResponse;
|
|
2863
2943
|
type ResendPaymentLinkResponse = {
|
|
2864
2944
|
/**
|
|
2865
|
-
* - HTTP status code
|
|
2945
|
+
* - HTTP status code.
|
|
2866
2946
|
*/
|
|
2867
2947
|
status_code: number;
|
|
2868
2948
|
/**
|
|
2869
|
-
* - Polling request timeout
|
|
2949
|
+
* - Polling request timeout.
|
|
2870
2950
|
*/
|
|
2871
2951
|
polling_timeout?: number;
|
|
2872
2952
|
/**
|
|
2873
|
-
* - Successful or failure
|
|
2953
|
+
* - Successful or failure.
|
|
2874
2954
|
*/
|
|
2875
2955
|
success: boolean;
|
|
2876
2956
|
/**
|
|
2877
|
-
* -
|
|
2957
|
+
* - Detailed message.
|
|
2878
2958
|
*/
|
|
2879
2959
|
message: string;
|
|
2880
2960
|
};
|
|
@@ -2882,15 +2962,15 @@ type ResendPaymentLinkResponse = {
|
|
|
2882
2962
|
declare function CancelPaymentLinkResponse(): CancelPaymentLinkResponse;
|
|
2883
2963
|
type CancelPaymentLinkResponse = {
|
|
2884
2964
|
/**
|
|
2885
|
-
* - HTTP status code
|
|
2965
|
+
* - HTTP status code.
|
|
2886
2966
|
*/
|
|
2887
2967
|
status_code: number;
|
|
2888
2968
|
/**
|
|
2889
|
-
* - Successful or failure
|
|
2969
|
+
* - Successful or failure.
|
|
2890
2970
|
*/
|
|
2891
2971
|
success: boolean;
|
|
2892
2972
|
/**
|
|
2893
|
-
* -
|
|
2973
|
+
* - Detailed message.
|
|
2894
2974
|
*/
|
|
2895
2975
|
message: string;
|
|
2896
2976
|
};
|
|
@@ -2898,43 +2978,43 @@ type CancelPaymentLinkResponse = {
|
|
|
2898
2978
|
declare function PollingPaymentLinkResponse(): PollingPaymentLinkResponse;
|
|
2899
2979
|
type PollingPaymentLinkResponse = {
|
|
2900
2980
|
/**
|
|
2901
|
-
* - Status of payment link
|
|
2981
|
+
* - Status of payment link.
|
|
2902
2982
|
*/
|
|
2903
2983
|
status?: string;
|
|
2904
2984
|
/**
|
|
2905
|
-
* - HTTP status code
|
|
2985
|
+
* - HTTP status code.
|
|
2906
2986
|
*/
|
|
2907
2987
|
status_code?: number;
|
|
2908
2988
|
/**
|
|
2909
|
-
* - Successful or failure
|
|
2989
|
+
* - Successful or failure.
|
|
2910
2990
|
*/
|
|
2911
2991
|
success?: boolean;
|
|
2912
2992
|
/**
|
|
2913
|
-
* - HTTP status code
|
|
2993
|
+
* - HTTP status code.
|
|
2914
2994
|
*/
|
|
2915
2995
|
http_status?: number;
|
|
2916
2996
|
/**
|
|
2917
|
-
* -
|
|
2997
|
+
* - Detailed message.
|
|
2918
2998
|
*/
|
|
2919
2999
|
message?: string;
|
|
2920
3000
|
/**
|
|
2921
|
-
* - Fynd order id
|
|
3001
|
+
* - Fynd order id.
|
|
2922
3002
|
*/
|
|
2923
3003
|
order_id?: string;
|
|
2924
3004
|
/**
|
|
2925
|
-
* - Url to redirect to
|
|
3005
|
+
* - Url to redirect to.
|
|
2926
3006
|
*/
|
|
2927
3007
|
redirect_url?: string;
|
|
2928
3008
|
/**
|
|
2929
|
-
* - Payment link id
|
|
3009
|
+
* - Payment link id.
|
|
2930
3010
|
*/
|
|
2931
3011
|
payment_link_id?: string;
|
|
2932
3012
|
/**
|
|
2933
|
-
* - Aggregator name
|
|
3013
|
+
* - Aggregator name.
|
|
2934
3014
|
*/
|
|
2935
3015
|
aggregator_name?: string;
|
|
2936
3016
|
/**
|
|
2937
|
-
* -
|
|
3017
|
+
* - Total amount for the transaction.
|
|
2938
3018
|
*/
|
|
2939
3019
|
amount?: number;
|
|
2940
3020
|
};
|
|
@@ -2942,15 +3022,15 @@ type PollingPaymentLinkResponse = {
|
|
|
2942
3022
|
declare function PaymentMethodsMeta(): PaymentMethodsMeta;
|
|
2943
3023
|
type PaymentMethodsMeta = {
|
|
2944
3024
|
/**
|
|
2945
|
-
* - Merchant code
|
|
3025
|
+
* - Merchant code.
|
|
2946
3026
|
*/
|
|
2947
3027
|
merchant_code: string;
|
|
2948
3028
|
/**
|
|
2949
|
-
* - Payment gateway name
|
|
3029
|
+
* - Payment gateway name.
|
|
2950
3030
|
*/
|
|
2951
3031
|
payment_gateway: string;
|
|
2952
3032
|
/**
|
|
2953
|
-
* - Payment identifier
|
|
3033
|
+
* - Payment identifier.
|
|
2954
3034
|
*/
|
|
2955
3035
|
payment_identifier: string;
|
|
2956
3036
|
};
|
|
@@ -2958,11 +3038,11 @@ type PaymentMethodsMeta = {
|
|
|
2958
3038
|
declare function CreateOrderUserPaymentMethods(): CreateOrderUserPaymentMethods;
|
|
2959
3039
|
type CreateOrderUserPaymentMethods = {
|
|
2960
3040
|
/**
|
|
2961
|
-
* - Payment mode name
|
|
3041
|
+
* - Payment mode name.
|
|
2962
3042
|
*/
|
|
2963
3043
|
name: string;
|
|
2964
3044
|
/**
|
|
2965
|
-
* - Payment mode
|
|
3045
|
+
* - Payment mode.
|
|
2966
3046
|
*/
|
|
2967
3047
|
mode: string;
|
|
2968
3048
|
meta: PaymentMethodsMeta;
|
|
@@ -2971,24 +3051,24 @@ type CreateOrderUserPaymentMethods = {
|
|
|
2971
3051
|
declare function CreateOrderUserRequest(): CreateOrderUserRequest;
|
|
2972
3052
|
type CreateOrderUserRequest = {
|
|
2973
3053
|
/**
|
|
2974
|
-
* - Failure page url
|
|
3054
|
+
* - Failure page url.
|
|
2975
3055
|
*/
|
|
2976
3056
|
failure_callback_url: string;
|
|
2977
3057
|
/**
|
|
2978
|
-
* - Currency
|
|
3058
|
+
* - Currency of the transaction.
|
|
2979
3059
|
*/
|
|
2980
3060
|
currency: string;
|
|
2981
3061
|
/**
|
|
2982
|
-
* - Unique id of payment link
|
|
3062
|
+
* - Unique id of payment link.
|
|
2983
3063
|
*/
|
|
2984
3064
|
payment_link_id: string;
|
|
2985
3065
|
payment_methods: CreateOrderUserPaymentMethods;
|
|
2986
3066
|
/**
|
|
2987
|
-
* - Success page url
|
|
3067
|
+
* - Success page url.
|
|
2988
3068
|
*/
|
|
2989
3069
|
success_callback_url: string;
|
|
2990
3070
|
/**
|
|
2991
|
-
* - Meta
|
|
3071
|
+
* - Meta details.
|
|
2992
3072
|
*/
|
|
2993
3073
|
meta?: any;
|
|
2994
3074
|
};
|
|
@@ -2996,43 +3076,43 @@ type CreateOrderUserRequest = {
|
|
|
2996
3076
|
declare function CreateOrderUserData(): CreateOrderUserData;
|
|
2997
3077
|
type CreateOrderUserData = {
|
|
2998
3078
|
/**
|
|
2999
|
-
* - Method
|
|
3079
|
+
* - Method details.
|
|
3000
3080
|
*/
|
|
3001
3081
|
method?: string;
|
|
3002
3082
|
/**
|
|
3003
|
-
* - Aggregator name
|
|
3083
|
+
* - Aggregator name.
|
|
3004
3084
|
*/
|
|
3005
3085
|
aggregator?: string;
|
|
3006
3086
|
/**
|
|
3007
|
-
* - Aggregator customer id
|
|
3087
|
+
* - Aggregator customer id.
|
|
3008
3088
|
*/
|
|
3009
3089
|
customer_id?: string;
|
|
3010
3090
|
/**
|
|
3011
|
-
* - Mobile number
|
|
3091
|
+
* - Mobile number.
|
|
3012
3092
|
*/
|
|
3013
3093
|
contact?: string;
|
|
3014
3094
|
/**
|
|
3015
|
-
* - Merchant order id
|
|
3095
|
+
* - Merchant order id.
|
|
3016
3096
|
*/
|
|
3017
3097
|
merchant_order_id?: string;
|
|
3018
3098
|
/**
|
|
3019
|
-
* - Aggregator order id
|
|
3099
|
+
* - Aggregator order id.
|
|
3020
3100
|
*/
|
|
3021
3101
|
order_id?: string;
|
|
3022
3102
|
/**
|
|
3023
|
-
* - Currency
|
|
3103
|
+
* - Currency of the transaction.
|
|
3024
3104
|
*/
|
|
3025
3105
|
currency?: string;
|
|
3026
3106
|
/**
|
|
3027
|
-
* - Callback url for aggregator
|
|
3107
|
+
* - Callback url for aggregator.
|
|
3028
3108
|
*/
|
|
3029
3109
|
callback_url?: string;
|
|
3030
3110
|
/**
|
|
3031
|
-
* -
|
|
3111
|
+
* - Total amount for the transaction.
|
|
3032
3112
|
*/
|
|
3033
3113
|
amount?: number;
|
|
3034
3114
|
/**
|
|
3035
|
-
* - Email
|
|
3115
|
+
* - Email.
|
|
3036
3116
|
*/
|
|
3037
3117
|
email?: string;
|
|
3038
3118
|
};
|
|
@@ -3040,28 +3120,28 @@ type CreateOrderUserData = {
|
|
|
3040
3120
|
declare function CreateOrderUserResponse(): CreateOrderUserResponse;
|
|
3041
3121
|
type CreateOrderUserResponse = {
|
|
3042
3122
|
/**
|
|
3043
|
-
* - HTTP status code
|
|
3123
|
+
* - HTTP status code.
|
|
3044
3124
|
*/
|
|
3045
3125
|
status_code: number;
|
|
3046
3126
|
/**
|
|
3047
|
-
* - Successful or failure
|
|
3127
|
+
* - Successful or failure.
|
|
3048
3128
|
*/
|
|
3049
3129
|
success: boolean;
|
|
3050
3130
|
data?: CreateOrderUserData;
|
|
3051
3131
|
/**
|
|
3052
|
-
* -
|
|
3132
|
+
* - Detailed message.
|
|
3053
3133
|
*/
|
|
3054
3134
|
message: string;
|
|
3055
3135
|
/**
|
|
3056
|
-
* - Merchant order id
|
|
3136
|
+
* - Merchant order id.
|
|
3057
3137
|
*/
|
|
3058
3138
|
order_id?: string;
|
|
3059
3139
|
/**
|
|
3060
|
-
* - Callback url for aggregator
|
|
3140
|
+
* - Callback url for aggregator.
|
|
3061
3141
|
*/
|
|
3062
3142
|
callback_url?: string;
|
|
3063
3143
|
/**
|
|
3064
|
-
* - Payment confirm url for aggregator
|
|
3144
|
+
* - Payment confirm url for aggregator.
|
|
3065
3145
|
*/
|
|
3066
3146
|
payment_confirm_url?: string;
|
|
3067
3147
|
};
|
|
@@ -3069,15 +3149,15 @@ type CreateOrderUserResponse = {
|
|
|
3069
3149
|
declare function BalanceDetails(): BalanceDetails;
|
|
3070
3150
|
type BalanceDetails = {
|
|
3071
3151
|
/**
|
|
3072
|
-
* -
|
|
3152
|
+
* - Formatted Amount with currency symbol.
|
|
3073
3153
|
*/
|
|
3074
3154
|
formatted_value?: string;
|
|
3075
3155
|
/**
|
|
3076
|
-
* - Currency Code
|
|
3156
|
+
* - Currency Code.
|
|
3077
3157
|
*/
|
|
3078
3158
|
currency?: string;
|
|
3079
3159
|
/**
|
|
3080
|
-
* - Payment amount
|
|
3160
|
+
* - Payment amount.
|
|
3081
3161
|
*/
|
|
3082
3162
|
value?: number;
|
|
3083
3163
|
};
|
|
@@ -3086,27 +3166,27 @@ declare function CreditSummary(): CreditSummary;
|
|
|
3086
3166
|
type CreditSummary = {
|
|
3087
3167
|
total_due_amount?: BalanceDetails;
|
|
3088
3168
|
/**
|
|
3089
|
-
* - Customer Credit status
|
|
3169
|
+
* - Customer Credit status.
|
|
3090
3170
|
*/
|
|
3091
3171
|
status?: string;
|
|
3092
3172
|
limit?: BalanceDetails;
|
|
3093
3173
|
/**
|
|
3094
|
-
* - ID at Credit aggregator
|
|
3174
|
+
* - ID at Credit aggregator end.
|
|
3095
3175
|
*/
|
|
3096
3176
|
credit_line_id?: string;
|
|
3097
3177
|
amount_available?: BalanceDetails;
|
|
3098
3178
|
due_amount?: BalanceDetails;
|
|
3099
3179
|
/**
|
|
3100
|
-
* - Due date for repayment
|
|
3180
|
+
* - Due date for repayment.
|
|
3101
3181
|
*/
|
|
3102
3182
|
due_date?: string;
|
|
3103
3183
|
balance?: BalanceDetails;
|
|
3104
3184
|
/**
|
|
3105
|
-
* - Message to customer
|
|
3185
|
+
* - Message to customer.
|
|
3106
3186
|
*/
|
|
3107
3187
|
status_message?: string;
|
|
3108
3188
|
/**
|
|
3109
|
-
* - Url for repayment
|
|
3189
|
+
* - Url for repayment.
|
|
3110
3190
|
*/
|
|
3111
3191
|
repayment_url?: string;
|
|
3112
3192
|
/**
|
|
@@ -3114,19 +3194,19 @@ type CreditSummary = {
|
|
|
3114
3194
|
*/
|
|
3115
3195
|
soa_url?: string;
|
|
3116
3196
|
/**
|
|
3117
|
-
* -
|
|
3197
|
+
* - Eligibility flag to complete transaction.
|
|
3118
3198
|
*/
|
|
3119
3199
|
is_eligible_for_txn?: boolean;
|
|
3120
3200
|
/**
|
|
3121
|
-
* - Unique aggregator customer id
|
|
3201
|
+
* - Unique aggregator customer id.
|
|
3122
3202
|
*/
|
|
3123
3203
|
merchant_customer_ref_id?: string;
|
|
3124
3204
|
/**
|
|
3125
|
-
* - Status from Credit aggregator
|
|
3205
|
+
* - Status from Credit aggregator end.
|
|
3126
3206
|
*/
|
|
3127
3207
|
buyer_status?: string;
|
|
3128
3208
|
/**
|
|
3129
|
-
* - Url for activation
|
|
3209
|
+
* - Url for activation.
|
|
3130
3210
|
*/
|
|
3131
3211
|
activation_url?: string;
|
|
3132
3212
|
};
|
|
@@ -3143,7 +3223,7 @@ type CustomerCreditSummaryResponse = {
|
|
|
3143
3223
|
declare function RedirectURL(): RedirectURL;
|
|
3144
3224
|
type RedirectURL = {
|
|
3145
3225
|
/**
|
|
3146
|
-
* - Aggregator
|
|
3226
|
+
* - Aggregator Operation is successful or not.
|
|
3147
3227
|
*/
|
|
3148
3228
|
status: boolean;
|
|
3149
3229
|
/**
|
|
@@ -3189,31 +3269,32 @@ type CheckCreditResponse = {
|
|
|
3189
3269
|
declare function KYCAddress(): KYCAddress;
|
|
3190
3270
|
type KYCAddress = {
|
|
3191
3271
|
/**
|
|
3192
|
-
* - City
|
|
3272
|
+
* - City of the KYC address.
|
|
3193
3273
|
*/
|
|
3194
3274
|
city: string;
|
|
3195
3275
|
/**
|
|
3196
|
-
* -
|
|
3276
|
+
* - Second line of the address.
|
|
3197
3277
|
*/
|
|
3198
3278
|
addressline2?: string;
|
|
3199
3279
|
/**
|
|
3200
|
-
* - State
|
|
3280
|
+
* - State of the KYC address.
|
|
3201
3281
|
*/
|
|
3202
3282
|
state: string;
|
|
3203
3283
|
/**
|
|
3204
|
-
* -
|
|
3284
|
+
* - Type of ownership for the address
|
|
3285
|
+
* (e.g., rented, owned).
|
|
3205
3286
|
*/
|
|
3206
3287
|
ownership_type?: string;
|
|
3207
3288
|
/**
|
|
3208
|
-
* -
|
|
3289
|
+
* - Postal code of the address.
|
|
3209
3290
|
*/
|
|
3210
3291
|
pincode: string;
|
|
3211
3292
|
/**
|
|
3212
|
-
* -
|
|
3293
|
+
* - Landmark near the address.
|
|
3213
3294
|
*/
|
|
3214
3295
|
land_mark?: string;
|
|
3215
3296
|
/**
|
|
3216
|
-
* -
|
|
3297
|
+
* - First line of the address.
|
|
3217
3298
|
*/
|
|
3218
3299
|
addressline1: string;
|
|
3219
3300
|
};
|
|
@@ -3221,64 +3302,64 @@ type KYCAddress = {
|
|
|
3221
3302
|
declare function UserPersonalInfoInDetails(): UserPersonalInfoInDetails;
|
|
3222
3303
|
type UserPersonalInfoInDetails = {
|
|
3223
3304
|
/**
|
|
3224
|
-
* - First
|
|
3305
|
+
* - First name of the individual.
|
|
3225
3306
|
*/
|
|
3226
3307
|
first_name: string;
|
|
3227
3308
|
/**
|
|
3228
|
-
* - Voter ID
|
|
3309
|
+
* - Voter ID number.
|
|
3229
3310
|
*/
|
|
3230
3311
|
voter_id?: string;
|
|
3231
3312
|
/**
|
|
3232
|
-
* - Gender
|
|
3313
|
+
* - Gender of the individual.
|
|
3233
3314
|
*/
|
|
3234
3315
|
gender?: string;
|
|
3235
3316
|
/**
|
|
3236
|
-
* -
|
|
3317
|
+
* - Date of birth of the individual.
|
|
3237
3318
|
*/
|
|
3238
3319
|
dob: string;
|
|
3239
3320
|
/**
|
|
3240
|
-
* - Passport
|
|
3321
|
+
* - Passport number.
|
|
3241
3322
|
*/
|
|
3242
3323
|
passport?: string;
|
|
3243
3324
|
/**
|
|
3244
|
-
* - Father's
|
|
3325
|
+
* - Father's name.
|
|
3245
3326
|
*/
|
|
3246
3327
|
fathers_name?: string;
|
|
3247
3328
|
/**
|
|
3248
|
-
* - Mother's
|
|
3329
|
+
* - Mother's name.
|
|
3249
3330
|
*/
|
|
3250
3331
|
mothers_name?: string;
|
|
3251
3332
|
/**
|
|
3252
|
-
* - Middle
|
|
3333
|
+
* - Middle name of the individual.
|
|
3253
3334
|
*/
|
|
3254
3335
|
middle_name?: string;
|
|
3255
3336
|
/**
|
|
3256
|
-
* - Last
|
|
3337
|
+
* - Last name of the individual.
|
|
3257
3338
|
*/
|
|
3258
3339
|
last_name?: string;
|
|
3259
3340
|
/**
|
|
3260
|
-
* -
|
|
3341
|
+
* - Permanent Account Number (PAN).
|
|
3261
3342
|
*/
|
|
3262
3343
|
pan?: string;
|
|
3263
3344
|
/**
|
|
3264
|
-
* -
|
|
3345
|
+
* - Driving license number.
|
|
3265
3346
|
*/
|
|
3266
3347
|
driving_license?: string;
|
|
3267
3348
|
/**
|
|
3268
|
-
* -
|
|
3349
|
+
* - Indicates whether the email is verified.
|
|
3269
3350
|
*/
|
|
3270
3351
|
email_verified: boolean;
|
|
3271
3352
|
address_as_per_id: KYCAddress;
|
|
3272
3353
|
/**
|
|
3273
|
-
* -
|
|
3354
|
+
* - Indicates whether the mobile number is verified.
|
|
3274
3355
|
*/
|
|
3275
3356
|
mobile_verified: boolean;
|
|
3276
3357
|
/**
|
|
3277
|
-
* -
|
|
3358
|
+
* - Phone number.
|
|
3278
3359
|
*/
|
|
3279
3360
|
phone: string;
|
|
3280
3361
|
/**
|
|
3281
|
-
* - Email
|
|
3362
|
+
* - Email address.
|
|
3282
3363
|
*/
|
|
3283
3364
|
email?: string;
|
|
3284
3365
|
};
|
|
@@ -3286,15 +3367,15 @@ type UserPersonalInfoInDetails = {
|
|
|
3286
3367
|
declare function MarketplaceInfo(): MarketplaceInfo;
|
|
3287
3368
|
type MarketplaceInfo = {
|
|
3288
3369
|
/**
|
|
3289
|
-
* - Date of joining
|
|
3370
|
+
* - Date of joining.
|
|
3290
3371
|
*/
|
|
3291
3372
|
date_of_joining?: string;
|
|
3292
3373
|
/**
|
|
3293
|
-
* - Name of store
|
|
3374
|
+
* - Name of store.
|
|
3294
3375
|
*/
|
|
3295
3376
|
name: string;
|
|
3296
3377
|
/**
|
|
3297
|
-
* - Merchant id
|
|
3378
|
+
* - Merchant id.
|
|
3298
3379
|
*/
|
|
3299
3380
|
membership_id: string;
|
|
3300
3381
|
};
|
|
@@ -3302,43 +3383,46 @@ type MarketplaceInfo = {
|
|
|
3302
3383
|
declare function BusinessDetails(): BusinessDetails;
|
|
3303
3384
|
type BusinessDetails = {
|
|
3304
3385
|
/**
|
|
3305
|
-
* -
|
|
3386
|
+
* - Type of business ownership
|
|
3387
|
+
* (e.g., sole proprietorship, partnership).
|
|
3306
3388
|
*/
|
|
3307
3389
|
business_ownership_type?: string;
|
|
3308
3390
|
/**
|
|
3309
|
-
* -
|
|
3391
|
+
* - Age or duration of the business.
|
|
3310
3392
|
*/
|
|
3311
3393
|
vintage?: string;
|
|
3312
3394
|
/**
|
|
3313
|
-
* -
|
|
3395
|
+
* - Goods and Services Tax Identification Number.
|
|
3314
3396
|
*/
|
|
3315
3397
|
gstin?: string;
|
|
3316
3398
|
/**
|
|
3317
|
-
* -
|
|
3399
|
+
* - Permanent Account Number of the business.
|
|
3318
3400
|
*/
|
|
3319
3401
|
pan?: string;
|
|
3320
3402
|
/**
|
|
3321
|
-
* -
|
|
3403
|
+
* - Type of legal entity (e.g., corporation, LLC).
|
|
3322
3404
|
*/
|
|
3323
3405
|
entity_type?: string;
|
|
3324
3406
|
/**
|
|
3325
|
-
* - Shop Establishment
|
|
3407
|
+
* - Shop and Establishment
|
|
3408
|
+
* registration details.
|
|
3326
3409
|
*/
|
|
3327
3410
|
shop_and_establishment?: any;
|
|
3328
3411
|
/**
|
|
3329
|
-
* -
|
|
3412
|
+
* - Food Safety and Standards Authority of India
|
|
3413
|
+
* registration number.
|
|
3330
3414
|
*/
|
|
3331
3415
|
fssai?: string;
|
|
3332
3416
|
/**
|
|
3333
|
-
* -
|
|
3417
|
+
* - Food and Drug Administration registration number.
|
|
3334
3418
|
*/
|
|
3335
3419
|
fda?: string;
|
|
3336
3420
|
/**
|
|
3337
|
-
* -
|
|
3421
|
+
* - Type of business (e.g., retail, wholesale).
|
|
3338
3422
|
*/
|
|
3339
3423
|
business_type?: string;
|
|
3340
3424
|
/**
|
|
3341
|
-
* -
|
|
3425
|
+
* - Name of the business.
|
|
3342
3426
|
*/
|
|
3343
3427
|
name?: string;
|
|
3344
3428
|
address?: KYCAddress;
|
|
@@ -3347,31 +3431,31 @@ type BusinessDetails = {
|
|
|
3347
3431
|
declare function DeviceDetails(): DeviceDetails;
|
|
3348
3432
|
type DeviceDetails = {
|
|
3349
3433
|
/**
|
|
3350
|
-
* - IP
|
|
3434
|
+
* - IP.
|
|
3351
3435
|
*/
|
|
3352
3436
|
identification_number?: string;
|
|
3353
3437
|
/**
|
|
3354
|
-
* - Static value = ip
|
|
3438
|
+
* - Static value = ip.
|
|
3355
3439
|
*/
|
|
3356
3440
|
identifier_type?: string;
|
|
3357
3441
|
/**
|
|
3358
|
-
* - Device Model
|
|
3442
|
+
* - Device Model.
|
|
3359
3443
|
*/
|
|
3360
3444
|
device_model?: string;
|
|
3361
3445
|
/**
|
|
3362
|
-
* - Device maker
|
|
3446
|
+
* - Device maker.
|
|
3363
3447
|
*/
|
|
3364
3448
|
device_make?: string;
|
|
3365
3449
|
/**
|
|
3366
|
-
* - Device Type(E.g. Mobile)
|
|
3450
|
+
* - Device Type(E.g. Mobile).
|
|
3367
3451
|
*/
|
|
3368
3452
|
device_type?: string;
|
|
3369
3453
|
/**
|
|
3370
|
-
* - OS Name
|
|
3454
|
+
* - OS Name.
|
|
3371
3455
|
*/
|
|
3372
3456
|
os?: string;
|
|
3373
3457
|
/**
|
|
3374
|
-
* - OS Version
|
|
3458
|
+
* - OS Version.
|
|
3375
3459
|
*/
|
|
3376
3460
|
os_version?: string;
|
|
3377
3461
|
};
|
|
@@ -3380,16 +3464,16 @@ declare function CustomerOnboardingRequest(): CustomerOnboardingRequest;
|
|
|
3380
3464
|
type CustomerOnboardingRequest = {
|
|
3381
3465
|
personal_info?: UserPersonalInfoInDetails;
|
|
3382
3466
|
/**
|
|
3383
|
-
* -
|
|
3467
|
+
* - Merchant Category Code, indicating the type of business.
|
|
3384
3468
|
*/
|
|
3385
3469
|
mcc?: string;
|
|
3386
3470
|
/**
|
|
3387
|
-
* -
|
|
3471
|
+
* - Payment aggregator handling the transaction.
|
|
3388
3472
|
*/
|
|
3389
3473
|
aggregator: string;
|
|
3390
3474
|
marketplace_info?: MarketplaceInfo;
|
|
3391
3475
|
/**
|
|
3392
|
-
* -
|
|
3476
|
+
* - Callback url.
|
|
3393
3477
|
*/
|
|
3394
3478
|
source: string;
|
|
3395
3479
|
business_info?: BusinessDetails;
|
|
@@ -3403,27 +3487,27 @@ type OnboardSummary = {
|
|
|
3403
3487
|
*/
|
|
3404
3488
|
redirect_url?: string;
|
|
3405
3489
|
/**
|
|
3406
|
-
* - User Session
|
|
3490
|
+
* - User Session.
|
|
3407
3491
|
*/
|
|
3408
3492
|
session?: any;
|
|
3409
3493
|
/**
|
|
3410
|
-
* - Transaction status
|
|
3494
|
+
* - Transaction status.
|
|
3411
3495
|
*/
|
|
3412
3496
|
status: boolean;
|
|
3413
3497
|
/**
|
|
3414
|
-
* -
|
|
3498
|
+
* - Description of status.
|
|
3415
3499
|
*/
|
|
3416
3500
|
status_remark?: string;
|
|
3417
3501
|
/**
|
|
3418
|
-
* - Whether is eligible for transaction
|
|
3502
|
+
* - Whether is eligible for transaction.
|
|
3419
3503
|
*/
|
|
3420
3504
|
is_eligible_for_txn?: boolean;
|
|
3421
3505
|
/**
|
|
3422
|
-
* - Rupifi customer ID
|
|
3506
|
+
* - Rupifi customer ID.
|
|
3423
3507
|
*/
|
|
3424
3508
|
merchant_customer_ref_id?: string;
|
|
3425
3509
|
/**
|
|
3426
|
-
* - Url for activation
|
|
3510
|
+
* - Url for activation.
|
|
3427
3511
|
*/
|
|
3428
3512
|
activation_url?: string;
|
|
3429
3513
|
};
|
|
@@ -3440,11 +3524,11 @@ type CustomerOnboardingResponse = {
|
|
|
3440
3524
|
declare function OutstandingOrderDetailsResponse(): OutstandingOrderDetailsResponse;
|
|
3441
3525
|
type OutstandingOrderDetailsResponse = {
|
|
3442
3526
|
/**
|
|
3443
|
-
* - HTTP Status code
|
|
3527
|
+
* - HTTP Status code.
|
|
3444
3528
|
*/
|
|
3445
3529
|
status_code: number;
|
|
3446
3530
|
/**
|
|
3447
|
-
* - Dict containing the outstanding order details
|
|
3531
|
+
* - Dict containing the outstanding order details.
|
|
3448
3532
|
*/
|
|
3449
3533
|
data?: any[];
|
|
3450
3534
|
/**
|
|
@@ -3452,7 +3536,7 @@ type OutstandingOrderDetailsResponse = {
|
|
|
3452
3536
|
*/
|
|
3453
3537
|
success: boolean;
|
|
3454
3538
|
/**
|
|
3455
|
-
* - Message
|
|
3539
|
+
* - Message.
|
|
3456
3540
|
*/
|
|
3457
3541
|
message?: string;
|
|
3458
3542
|
};
|
|
@@ -3460,11 +3544,11 @@ type OutstandingOrderDetailsResponse = {
|
|
|
3460
3544
|
declare function PaidOrderDetailsResponse(): PaidOrderDetailsResponse;
|
|
3461
3545
|
type PaidOrderDetailsResponse = {
|
|
3462
3546
|
/**
|
|
3463
|
-
* - HTTP Status code
|
|
3547
|
+
* - HTTP Status code.
|
|
3464
3548
|
*/
|
|
3465
3549
|
status_code: number;
|
|
3466
3550
|
/**
|
|
3467
|
-
* - Dict containing the paid order details
|
|
3551
|
+
* - Dict containing the paid order details.
|
|
3468
3552
|
*/
|
|
3469
3553
|
data?: any[];
|
|
3470
3554
|
/**
|
|
@@ -3472,7 +3556,7 @@ type PaidOrderDetailsResponse = {
|
|
|
3472
3556
|
*/
|
|
3473
3557
|
success: boolean;
|
|
3474
3558
|
/**
|
|
3475
|
-
* - Message
|
|
3559
|
+
* - Message.
|
|
3476
3560
|
*/
|
|
3477
3561
|
message?: string;
|
|
3478
3562
|
};
|
|
@@ -3480,11 +3564,11 @@ type PaidOrderDetailsResponse = {
|
|
|
3480
3564
|
declare function DeleteRefundAccountResponse(): DeleteRefundAccountResponse;
|
|
3481
3565
|
type DeleteRefundAccountResponse = {
|
|
3482
3566
|
/**
|
|
3483
|
-
* - Success/Failure of the deleted beneficiary
|
|
3567
|
+
* - Success/Failure of the deleted beneficiary.
|
|
3484
3568
|
*/
|
|
3485
3569
|
success: boolean;
|
|
3486
3570
|
/**
|
|
3487
|
-
* - Message
|
|
3571
|
+
* - Message.
|
|
3488
3572
|
*/
|
|
3489
3573
|
message: string;
|
|
3490
3574
|
};
|
|
@@ -3492,19 +3576,19 @@ type DeleteRefundAccountResponse = {
|
|
|
3492
3576
|
declare function RefundOptionsDetails(): RefundOptionsDetails;
|
|
3493
3577
|
type RefundOptionsDetails = {
|
|
3494
3578
|
/**
|
|
3495
|
-
* - Refund option display name
|
|
3579
|
+
* - Refund option display name.
|
|
3496
3580
|
*/
|
|
3497
3581
|
display_name: string;
|
|
3498
3582
|
/**
|
|
3499
|
-
* - Refund ID. It will be unique identifier
|
|
3583
|
+
* - Refund ID. It will be unique identifier.
|
|
3500
3584
|
*/
|
|
3501
3585
|
id: number;
|
|
3502
3586
|
/**
|
|
3503
|
-
* - Refund option is active or not
|
|
3587
|
+
* - Refund option is active or not.
|
|
3504
3588
|
*/
|
|
3505
3589
|
is_active?: boolean;
|
|
3506
3590
|
/**
|
|
3507
|
-
* - Refund option name
|
|
3591
|
+
* - Refund option name.
|
|
3508
3592
|
*/
|
|
3509
3593
|
name: string;
|
|
3510
3594
|
};
|
|
@@ -3525,7 +3609,7 @@ type OfflineRefundOptions = {
|
|
|
3525
3609
|
items: RefundOptionsDetails;
|
|
3526
3610
|
/**
|
|
3527
3611
|
* - List of all offline payment options. MOP
|
|
3528
|
-
* Code value
|
|
3612
|
+
* Code value.
|
|
3529
3613
|
*/
|
|
3530
3614
|
payment_modes: string[];
|
|
3531
3615
|
};
|
|
@@ -3534,15 +3618,15 @@ declare function RefundOptionResponse(): RefundOptionResponse;
|
|
|
3534
3618
|
type RefundOptionResponse = {
|
|
3535
3619
|
/**
|
|
3536
3620
|
* - Available offline
|
|
3537
|
-
* refund options data
|
|
3621
|
+
* refund options data.
|
|
3538
3622
|
*/
|
|
3539
3623
|
offline_refund_options: OfflineRefundOptions;
|
|
3540
3624
|
/**
|
|
3541
|
-
* - Success/Failure Of response
|
|
3625
|
+
* - Success/Failure Of response.
|
|
3542
3626
|
*/
|
|
3543
3627
|
success: boolean;
|
|
3544
3628
|
/**
|
|
3545
|
-
* - Available refund options data
|
|
3629
|
+
* - Available refund options data.
|
|
3546
3630
|
*/
|
|
3547
3631
|
refund_options: RefundOptions;
|
|
3548
3632
|
};
|
|
@@ -3550,19 +3634,19 @@ type RefundOptionResponse = {
|
|
|
3550
3634
|
declare function SelectedRefundOptionResponse(): SelectedRefundOptionResponse;
|
|
3551
3635
|
type SelectedRefundOptionResponse = {
|
|
3552
3636
|
/**
|
|
3553
|
-
* - Selected transfer mode for given shipment
|
|
3637
|
+
* - Selected transfer mode for given shipment.
|
|
3554
3638
|
*/
|
|
3555
3639
|
transfer_mode: any;
|
|
3556
3640
|
/**
|
|
3557
|
-
* -
|
|
3641
|
+
* - ID of the shipment.
|
|
3558
3642
|
*/
|
|
3559
3643
|
shipment_id: string;
|
|
3560
3644
|
/**
|
|
3561
|
-
* -
|
|
3645
|
+
* - Detailed message.
|
|
3562
3646
|
*/
|
|
3563
3647
|
message: string;
|
|
3564
3648
|
/**
|
|
3565
|
-
* -
|
|
3649
|
+
* - Whether refund is successful or not.
|
|
3566
3650
|
*/
|
|
3567
3651
|
success: boolean;
|
|
3568
3652
|
};
|
|
@@ -3570,67 +3654,67 @@ type SelectedRefundOptionResponse = {
|
|
|
3570
3654
|
declare function WalletBeneficiaryDetails(): WalletBeneficiaryDetails;
|
|
3571
3655
|
type WalletBeneficiaryDetails = {
|
|
3572
3656
|
/**
|
|
3573
|
-
* -
|
|
3657
|
+
* - Beneficiary Id.
|
|
3574
3658
|
*/
|
|
3575
3659
|
beneficiary_id: string;
|
|
3576
3660
|
/**
|
|
3577
|
-
* - MOdification Date of Beneficiary
|
|
3661
|
+
* - MOdification Date of Beneficiary.
|
|
3578
3662
|
*/
|
|
3579
3663
|
modified_on: string;
|
|
3580
3664
|
/**
|
|
3581
|
-
* - Display Name Of Account
|
|
3665
|
+
* - Display Name Of Account.
|
|
3582
3666
|
*/
|
|
3583
3667
|
display_name: string;
|
|
3584
3668
|
/**
|
|
3585
|
-
* -
|
|
3669
|
+
* - Id of the wallet beneficiary.
|
|
3586
3670
|
*/
|
|
3587
3671
|
id: number;
|
|
3588
3672
|
/**
|
|
3589
|
-
* - SHort Title Of Account
|
|
3673
|
+
* - SHort Title Of Account.
|
|
3590
3674
|
*/
|
|
3591
3675
|
subtitle: string;
|
|
3592
3676
|
/**
|
|
3593
|
-
* - Transfer Mode Of Account
|
|
3677
|
+
* - Transfer Mode Of Account.
|
|
3594
3678
|
*/
|
|
3595
3679
|
transfer_mode: string;
|
|
3596
3680
|
/**
|
|
3597
|
-
* - MObile no of User
|
|
3681
|
+
* - MObile no of User.
|
|
3598
3682
|
*/
|
|
3599
3683
|
mobile?: string;
|
|
3600
3684
|
/**
|
|
3601
|
-
* - Boolean Flag whether Beneficiary set or not
|
|
3685
|
+
* - Boolean Flag whether Beneficiary set or not.
|
|
3602
3686
|
*/
|
|
3603
3687
|
is_active: boolean;
|
|
3604
3688
|
/**
|
|
3605
|
-
* - Creation Date of Beneficiary
|
|
3689
|
+
* - Creation Date of Beneficiary.
|
|
3606
3690
|
*/
|
|
3607
3691
|
created_on: string;
|
|
3608
3692
|
/**
|
|
3609
|
-
* - Address of User
|
|
3693
|
+
* - Address of User.
|
|
3610
3694
|
*/
|
|
3611
3695
|
address: string;
|
|
3612
3696
|
/**
|
|
3613
|
-
* - Title Of Account
|
|
3697
|
+
* - Title Of Account.
|
|
3614
3698
|
*/
|
|
3615
3699
|
title: string;
|
|
3616
3700
|
/**
|
|
3617
|
-
* - Bank Name Of Account
|
|
3701
|
+
* - Bank Name Of Account.
|
|
3618
3702
|
*/
|
|
3619
3703
|
wallet_address: string;
|
|
3620
3704
|
/**
|
|
3621
|
-
* - Remarks
|
|
3705
|
+
* - Remarks.
|
|
3622
3706
|
*/
|
|
3623
3707
|
comment?: string;
|
|
3624
3708
|
/**
|
|
3625
|
-
* - Branch Name Of Account
|
|
3709
|
+
* - Branch Name Of Account.
|
|
3626
3710
|
*/
|
|
3627
3711
|
wallet?: string;
|
|
3628
3712
|
/**
|
|
3629
|
-
* - EMail of User
|
|
3713
|
+
* - EMail of User.
|
|
3630
3714
|
*/
|
|
3631
3715
|
email: string;
|
|
3632
3716
|
/**
|
|
3633
|
-
* - User Id Who filled the Beneficiary
|
|
3717
|
+
* - User Id Who filled the Beneficiary.
|
|
3634
3718
|
*/
|
|
3635
3719
|
delights_user_name?: string;
|
|
3636
3720
|
};
|
|
@@ -3638,67 +3722,67 @@ type WalletBeneficiaryDetails = {
|
|
|
3638
3722
|
declare function UpiBeneficiaryDetails(): UpiBeneficiaryDetails;
|
|
3639
3723
|
type UpiBeneficiaryDetails = {
|
|
3640
3724
|
/**
|
|
3641
|
-
* -
|
|
3725
|
+
* - Beneficiary Id.
|
|
3642
3726
|
*/
|
|
3643
3727
|
beneficiary_id: string;
|
|
3644
3728
|
/**
|
|
3645
|
-
* - MOdification Date of Beneficiary
|
|
3729
|
+
* - MOdification Date of Beneficiary.
|
|
3646
3730
|
*/
|
|
3647
3731
|
modified_on: string;
|
|
3648
3732
|
/**
|
|
3649
|
-
* - Display Name Of Account
|
|
3733
|
+
* - Display Name Of Account.
|
|
3650
3734
|
*/
|
|
3651
3735
|
display_name: string;
|
|
3652
3736
|
/**
|
|
3653
|
-
* -
|
|
3737
|
+
* - Id of the upi beneficiary.
|
|
3654
3738
|
*/
|
|
3655
3739
|
id: number;
|
|
3656
3740
|
/**
|
|
3657
|
-
* - SHort Title Of Account
|
|
3741
|
+
* - SHort Title Of Account.
|
|
3658
3742
|
*/
|
|
3659
3743
|
subtitle: string;
|
|
3660
3744
|
/**
|
|
3661
|
-
* - Transfer Mode Of Account
|
|
3745
|
+
* - Transfer Mode Of Account.
|
|
3662
3746
|
*/
|
|
3663
3747
|
transfer_mode: string;
|
|
3664
3748
|
/**
|
|
3665
|
-
* - Branch Name Of Account
|
|
3749
|
+
* - Branch Name Of Account.
|
|
3666
3750
|
*/
|
|
3667
3751
|
vpa?: string;
|
|
3668
3752
|
/**
|
|
3669
|
-
* - Mobile no of User
|
|
3753
|
+
* - Mobile no of User.
|
|
3670
3754
|
*/
|
|
3671
3755
|
mobile?: string;
|
|
3672
3756
|
/**
|
|
3673
|
-
* - Bank Name Of Account
|
|
3757
|
+
* - Bank Name Of Account.
|
|
3674
3758
|
*/
|
|
3675
3759
|
vpa_address: string;
|
|
3676
3760
|
/**
|
|
3677
|
-
* - Creation Date of Beneficiary
|
|
3761
|
+
* - Creation Date of Beneficiary.
|
|
3678
3762
|
*/
|
|
3679
3763
|
created_on: string;
|
|
3680
3764
|
/**
|
|
3681
|
-
* - Address of User
|
|
3765
|
+
* - Address of User.
|
|
3682
3766
|
*/
|
|
3683
3767
|
address: string;
|
|
3684
3768
|
/**
|
|
3685
|
-
* - Title Of Account
|
|
3769
|
+
* - Title Of Account.
|
|
3686
3770
|
*/
|
|
3687
3771
|
title: string;
|
|
3688
3772
|
/**
|
|
3689
|
-
* - Remarks
|
|
3773
|
+
* - Remarks.
|
|
3690
3774
|
*/
|
|
3691
3775
|
comment?: string;
|
|
3692
3776
|
/**
|
|
3693
|
-
* - Boolean Flag whether Beneficiary set or not
|
|
3777
|
+
* - Boolean Flag whether Beneficiary set or not.
|
|
3694
3778
|
*/
|
|
3695
3779
|
is_active: boolean;
|
|
3696
3780
|
/**
|
|
3697
|
-
* - EMail of User
|
|
3781
|
+
* - EMail of User.
|
|
3698
3782
|
*/
|
|
3699
3783
|
email: string;
|
|
3700
3784
|
/**
|
|
3701
|
-
* - User Id Who filled the Beneficiary
|
|
3785
|
+
* - User Id Who filled the Beneficiary.
|
|
3702
3786
|
*/
|
|
3703
3787
|
delights_user_name?: string;
|
|
3704
3788
|
};
|
|
@@ -3732,7 +3816,7 @@ type OrderBeneficiaryResponseSchemaV2 = {
|
|
|
3732
3816
|
*/
|
|
3733
3817
|
data: BeneficiaryRefundOptions;
|
|
3734
3818
|
/**
|
|
3735
|
-
* - Max Limit for adding bank account, UPI and wallet
|
|
3819
|
+
* - Max Limit for adding bank account, UPI and wallet.
|
|
3736
3820
|
*/
|
|
3737
3821
|
limit: any;
|
|
3738
3822
|
};
|
|
@@ -3740,15 +3824,15 @@ type OrderBeneficiaryResponseSchemaV2 = {
|
|
|
3740
3824
|
declare function ValidateValidateAddressRequest(): ValidateValidateAddressRequest;
|
|
3741
3825
|
type ValidateValidateAddressRequest = {
|
|
3742
3826
|
/**
|
|
3743
|
-
* - IFSC Code
|
|
3827
|
+
* - IFSC Code.
|
|
3744
3828
|
*/
|
|
3745
3829
|
ifsc_code?: string;
|
|
3746
3830
|
/**
|
|
3747
|
-
* - VPA Address
|
|
3831
|
+
* - VPA Address.
|
|
3748
3832
|
*/
|
|
3749
3833
|
upi_vpa?: string;
|
|
3750
3834
|
/**
|
|
3751
|
-
* - Aggregator Name
|
|
3835
|
+
* - Aggregator Name.
|
|
3752
3836
|
*/
|
|
3753
3837
|
aggregator?: string;
|
|
3754
3838
|
};
|
|
@@ -3756,19 +3840,19 @@ type ValidateValidateAddressRequest = {
|
|
|
3756
3840
|
declare function VPADetails(): VPADetails;
|
|
3757
3841
|
type VPADetails = {
|
|
3758
3842
|
/**
|
|
3759
|
-
* - Is VPA valid or not
|
|
3843
|
+
* - Is VPA valid or not.
|
|
3760
3844
|
*/
|
|
3761
3845
|
is_valid: boolean;
|
|
3762
3846
|
/**
|
|
3763
|
-
* - VPA address
|
|
3847
|
+
* - VPA address.
|
|
3764
3848
|
*/
|
|
3765
3849
|
upi_vpa: string;
|
|
3766
3850
|
/**
|
|
3767
|
-
* - VPA validation message
|
|
3851
|
+
* - VPA validation message.
|
|
3768
3852
|
*/
|
|
3769
3853
|
status: string;
|
|
3770
3854
|
/**
|
|
3771
|
-
* - VPA Customer Name
|
|
3855
|
+
* - VPA Customer Name.
|
|
3772
3856
|
*/
|
|
3773
3857
|
customer_name: string;
|
|
3774
3858
|
};
|
|
@@ -3780,11 +3864,11 @@ type ValidateValidateAddressResponse = {
|
|
|
3780
3864
|
*/
|
|
3781
3865
|
upi?: VPADetails;
|
|
3782
3866
|
/**
|
|
3783
|
-
* -
|
|
3867
|
+
* - Whether address validation is successful or not.
|
|
3784
3868
|
*/
|
|
3785
3869
|
success: boolean;
|
|
3786
3870
|
/**
|
|
3787
|
-
* - IFSC details response data
|
|
3871
|
+
* - IFSC details response data.
|
|
3788
3872
|
*/
|
|
3789
3873
|
ifsc?: any;
|
|
3790
3874
|
};
|
|
@@ -3792,15 +3876,15 @@ type ValidateValidateAddressResponse = {
|
|
|
3792
3876
|
declare function PaymentMethodsMetaOrder(): PaymentMethodsMetaOrder;
|
|
3793
3877
|
type PaymentMethodsMetaOrder = {
|
|
3794
3878
|
/**
|
|
3795
|
-
* - Merchant code
|
|
3879
|
+
* - Merchant code.
|
|
3796
3880
|
*/
|
|
3797
3881
|
merchant_code: string;
|
|
3798
3882
|
/**
|
|
3799
|
-
* - Payment gateway name
|
|
3883
|
+
* - Payment gateway name.
|
|
3800
3884
|
*/
|
|
3801
3885
|
payment_gateway: string;
|
|
3802
3886
|
/**
|
|
3803
|
-
* - Payment identifier
|
|
3887
|
+
* - Payment identifier.
|
|
3804
3888
|
*/
|
|
3805
3889
|
payment_identifier: string;
|
|
3806
3890
|
};
|
|
@@ -3808,33 +3892,36 @@ type PaymentMethodsMetaOrder = {
|
|
|
3808
3892
|
declare function PaymentOrderMethods(): PaymentOrderMethods;
|
|
3809
3893
|
type PaymentOrderMethods = {
|
|
3810
3894
|
/**
|
|
3811
|
-
* - Amount to be collected
|
|
3895
|
+
* - Amount to be collected.
|
|
3812
3896
|
*/
|
|
3813
3897
|
amount: number;
|
|
3814
3898
|
/**
|
|
3815
|
-
* - Payment type i.e. Required / Blocked
|
|
3899
|
+
* - Payment type i.e. Required / Blocked.
|
|
3816
3900
|
*/
|
|
3817
3901
|
payment?: string;
|
|
3818
3902
|
/**
|
|
3819
|
-
* - Payment mode
|
|
3903
|
+
* - Payment mode.
|
|
3820
3904
|
*/
|
|
3821
3905
|
mode: string;
|
|
3822
3906
|
meta: PaymentMethodsMetaOrder;
|
|
3823
3907
|
/**
|
|
3824
|
-
* - Payment mode name
|
|
3908
|
+
* - Payment mode name.
|
|
3825
3909
|
*/
|
|
3826
3910
|
name: string;
|
|
3827
3911
|
};
|
|
3828
3912
|
/** @returns {PaymentOrderRequest} */
|
|
3829
3913
|
declare function PaymentOrderRequest(): PaymentOrderRequest;
|
|
3830
3914
|
type PaymentOrderRequest = {
|
|
3915
|
+
/**
|
|
3916
|
+
* - All payment methods for order.
|
|
3917
|
+
*/
|
|
3831
3918
|
payment_methods?: PaymentOrderMethods[];
|
|
3832
3919
|
/**
|
|
3833
|
-
* - Order id
|
|
3920
|
+
* - Order id.
|
|
3834
3921
|
*/
|
|
3835
3922
|
order_id: string;
|
|
3836
3923
|
/**
|
|
3837
|
-
* - Shipment_id
|
|
3924
|
+
* - Shipment_id.
|
|
3838
3925
|
*/
|
|
3839
3926
|
shipment_id?: string;
|
|
3840
3927
|
};
|
|
@@ -3842,43 +3929,43 @@ type PaymentOrderRequest = {
|
|
|
3842
3929
|
declare function PaymentOrderData(): PaymentOrderData;
|
|
3843
3930
|
type PaymentOrderData = {
|
|
3844
3931
|
/**
|
|
3845
|
-
* - Amount
|
|
3932
|
+
* - Amount.
|
|
3846
3933
|
*/
|
|
3847
3934
|
amount?: number;
|
|
3848
3935
|
/**
|
|
3849
|
-
* - Aggregator name
|
|
3936
|
+
* - Aggregator name.
|
|
3850
3937
|
*/
|
|
3851
3938
|
aggregator?: string;
|
|
3852
3939
|
/**
|
|
3853
|
-
* - Callback url for aggregator
|
|
3940
|
+
* - Callback url for aggregator.
|
|
3854
3941
|
*/
|
|
3855
3942
|
callback_url?: string;
|
|
3856
3943
|
/**
|
|
3857
|
-
* - Aggregator order id
|
|
3944
|
+
* - Aggregator order id.
|
|
3858
3945
|
*/
|
|
3859
3946
|
order_id?: string;
|
|
3860
3947
|
/**
|
|
3861
|
-
* - Aggregator customer id
|
|
3948
|
+
* - Aggregator customer id.
|
|
3862
3949
|
*/
|
|
3863
3950
|
customer_id?: string;
|
|
3864
3951
|
/**
|
|
3865
|
-
* - Merchant order id
|
|
3952
|
+
* - Merchant order id.
|
|
3866
3953
|
*/
|
|
3867
3954
|
merchant_order_id?: string;
|
|
3868
3955
|
/**
|
|
3869
|
-
* - Currency
|
|
3956
|
+
* - Currency used for the order.
|
|
3870
3957
|
*/
|
|
3871
3958
|
currency?: string;
|
|
3872
3959
|
/**
|
|
3873
|
-
* - Email
|
|
3960
|
+
* - Email address of the customer.
|
|
3874
3961
|
*/
|
|
3875
3962
|
email?: string;
|
|
3876
3963
|
/**
|
|
3877
|
-
* -
|
|
3964
|
+
* - Contact number of the customer.
|
|
3878
3965
|
*/
|
|
3879
3966
|
contact?: string;
|
|
3880
3967
|
/**
|
|
3881
|
-
* - Method
|
|
3968
|
+
* - Method of payment or delivery for the order.
|
|
3882
3969
|
*/
|
|
3883
3970
|
method?: string;
|
|
3884
3971
|
};
|
|
@@ -3886,28 +3973,28 @@ type PaymentOrderData = {
|
|
|
3886
3973
|
declare function PaymentOrderResponse(): PaymentOrderResponse;
|
|
3887
3974
|
type PaymentOrderResponse = {
|
|
3888
3975
|
/**
|
|
3889
|
-
* - Payment confirm url for aggregator
|
|
3976
|
+
* - Payment confirm url for aggregator.
|
|
3890
3977
|
*/
|
|
3891
3978
|
payment_confirm_url?: string;
|
|
3892
3979
|
/**
|
|
3893
|
-
* - Callback url for aggregator
|
|
3980
|
+
* - Callback url for aggregator.
|
|
3894
3981
|
*/
|
|
3895
3982
|
callback_url?: string;
|
|
3896
3983
|
/**
|
|
3897
|
-
* - Merchant order id
|
|
3984
|
+
* - Merchant order id.
|
|
3898
3985
|
*/
|
|
3899
3986
|
order_id?: string;
|
|
3900
3987
|
/**
|
|
3901
|
-
* - Successful or failure
|
|
3988
|
+
* - Successful or failure.
|
|
3902
3989
|
*/
|
|
3903
3990
|
success?: boolean;
|
|
3904
3991
|
/**
|
|
3905
|
-
* - HTTP status code
|
|
3992
|
+
* - HTTP status code.
|
|
3906
3993
|
*/
|
|
3907
3994
|
status_code: number;
|
|
3908
3995
|
data?: PaymentOrderData;
|
|
3909
3996
|
/**
|
|
3910
|
-
* -
|
|
3997
|
+
* - Detailed message.
|
|
3911
3998
|
*/
|
|
3912
3999
|
message: string;
|
|
3913
4000
|
};
|
|
@@ -3915,19 +4002,19 @@ type PaymentOrderResponse = {
|
|
|
3915
4002
|
declare function ShipmentRefundRequest(): ShipmentRefundRequest;
|
|
3916
4003
|
type ShipmentRefundRequest = {
|
|
3917
4004
|
/**
|
|
3918
|
-
* - Shipment Id of the respective Merchant Order Id
|
|
4005
|
+
* - Shipment Id of the respective Merchant Order Id.
|
|
3919
4006
|
*/
|
|
3920
4007
|
shipment_id: string;
|
|
3921
4008
|
/**
|
|
3922
|
-
* - Merchant Order Id
|
|
4009
|
+
* - Merchant Order Id.
|
|
3923
4010
|
*/
|
|
3924
4011
|
order_id: string;
|
|
3925
4012
|
/**
|
|
3926
|
-
* - Transfer Mode of the Beneficiary to be added
|
|
4013
|
+
* - Transfer Mode of the Beneficiary to be added.
|
|
3927
4014
|
*/
|
|
3928
4015
|
transfer_mode: string;
|
|
3929
4016
|
/**
|
|
3930
|
-
* - Beneficiary Hash Id of the beneficiary added
|
|
4017
|
+
* - Beneficiary Hash Id of the beneficiary added.
|
|
3931
4018
|
*/
|
|
3932
4019
|
beneficiary_id?: string;
|
|
3933
4020
|
};
|
|
@@ -3935,19 +4022,21 @@ type ShipmentRefundRequest = {
|
|
|
3935
4022
|
declare function ShipmentRefundDetail(): ShipmentRefundDetail;
|
|
3936
4023
|
type ShipmentRefundDetail = {
|
|
3937
4024
|
/**
|
|
3938
|
-
* -
|
|
4025
|
+
* - ID of the shipment.
|
|
3939
4026
|
*/
|
|
3940
4027
|
shipment_id: string;
|
|
3941
4028
|
/**
|
|
3942
|
-
* -
|
|
4029
|
+
* - ID of an order.
|
|
3943
4030
|
*/
|
|
3944
4031
|
order_id: string;
|
|
3945
4032
|
/**
|
|
3946
|
-
* -
|
|
4033
|
+
* - Mode of transfer for the shipment refund
|
|
4034
|
+
* (e.g., bank transfer, digital wallet).
|
|
3947
4035
|
*/
|
|
3948
4036
|
transfer_mode: string;
|
|
3949
4037
|
/**
|
|
3950
|
-
* -
|
|
4038
|
+
* - Unique identifier for the beneficiary
|
|
4039
|
+
* receiving the refund.
|
|
3951
4040
|
*/
|
|
3952
4041
|
beneficiary_id: string;
|
|
3953
4042
|
};
|
|
@@ -3963,7 +4052,7 @@ type ShipmentRefundResponse = {
|
|
|
3963
4052
|
*/
|
|
3964
4053
|
success: boolean;
|
|
3965
4054
|
/**
|
|
3966
|
-
* -
|
|
4055
|
+
* - Detailed message.
|
|
3967
4056
|
*/
|
|
3968
4057
|
message: string;
|
|
3969
4058
|
};
|