@gofynd/fdk-client-javascript 1.0.1 → 1.0.3
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/documentation/application/CART.md +5934 -4502
- package/documentation/application/CATALOG.md +6338 -7245
- package/documentation/application/COMMON.md +95 -222
- package/documentation/application/COMMUNICATION.md +106 -186
- package/documentation/application/CONFIGURATION.md +903 -1597
- package/documentation/application/CONTENT.md +562 -1270
- package/documentation/application/FILESTORAGE.md +84 -220
- package/documentation/application/LEAD.md +314 -660
- package/documentation/application/LOGISTIC.md +229 -305
- package/documentation/application/ORDER.md +642 -1137
- package/documentation/application/PAYMENT.md +2285 -3031
- package/documentation/application/POSCART.md +6079 -4642
- package/documentation/application/REWARDS.md +94 -248
- package/documentation/application/SHARE.md +152 -250
- package/documentation/application/THEME.md +952 -1235
- package/documentation/application/USER.md +1228 -1765
- package/documentation/platform/ANALYTICS.md +207 -349
- package/documentation/platform/AUDITTRAIL.md +121 -204
- package/documentation/platform/BILLING.md +865 -1376
- package/documentation/platform/CART.md +2814 -3662
- package/documentation/platform/CATALOG.md +15266 -17619
- package/documentation/platform/COMMON.md +95 -222
- package/documentation/platform/COMMUNICATION.md +1632 -2380
- package/documentation/platform/COMPANYPROFILE.md +572 -957
- package/documentation/platform/CONFIGURATION.md +3050 -4073
- package/documentation/platform/CONTENT.md +3509 -4121
- package/documentation/platform/DISCOUNT.md +140 -236
- package/documentation/platform/FILESTORAGE.md +187 -323
- package/documentation/platform/INVENTORY.md +268 -911
- package/documentation/platform/LEAD.md +2195 -2541
- package/documentation/platform/ORDER.md +3750 -5636
- package/documentation/platform/PARTNER.md +9 -36
- package/documentation/platform/PAYMENT.md +903 -1213
- package/documentation/platform/REWARDS.md +183 -347
- package/documentation/platform/SHARE.md +120 -213
- package/documentation/platform/THEME.md +12956 -13239
- package/documentation/platform/USER.md +975 -1120
- package/documentation/platform/WEBHOOK.md +78 -184
- package/documentation/public/CONFIGURATION.md +95 -222
- package/documentation/public/INVENTORY.md +100 -282
- package/documentation/public/WEBHOOK.md +27 -133
- package/package.json +1 -1
- package/sdk/application/ApplicationConfig.js +1 -1
- package/sdk/application/Cart/CartApplicationClient.d.ts +243 -243
- package/sdk/application/Cart/CartApplicationClient.js +1058 -547
- package/sdk/application/Cart/CartApplicationModel.d.ts +64 -63
- package/sdk/application/Cart/CartApplicationModel.js +489 -886
- package/sdk/application/Cart/CartApplicationValidator.d.ts +17 -17
- package/sdk/application/Cart/CartApplicationValidator.js +98 -98
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +358 -358
- package/sdk/application/Catalog/CatalogApplicationClient.js +1545 -949
- package/sdk/application/Catalog/CatalogApplicationModel.d.ts +90 -90
- package/sdk/application/Catalog/CatalogApplicationModel.js +692 -1258
- package/sdk/application/Catalog/CatalogApplicationValidator.d.ts +19 -19
- package/sdk/application/Catalog/CatalogApplicationValidator.js +110 -110
- package/sdk/application/Common/CommonApplicationClient.d.ts +13 -13
- package/sdk/application/Common/CommonApplicationClient.js +76 -36
- package/sdk/application/Common/CommonApplicationModel.d.ts +12 -12
- package/sdk/application/Common/CommonApplicationModel.js +83 -160
- package/sdk/application/Common/CommonApplicationValidator.d.ts +1 -1
- package/sdk/application/Common/CommonApplicationValidator.js +6 -6
- package/sdk/application/Communication/CommunicationApplicationClient.d.ts +11 -11
- package/sdk/application/Communication/CommunicationApplicationClient.js +92 -31
- package/sdk/application/Communication/CommunicationApplicationModel.d.ts +6 -6
- package/sdk/application/Communication/CommunicationApplicationModel.js +38 -83
- package/sdk/application/Communication/CommunicationApplicationValidator.d.ts +1 -1
- package/sdk/application/Communication/CommunicationApplicationValidator.js +4 -4
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +116 -116
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +638 -312
- package/sdk/application/Configuration/ConfigurationApplicationModel.d.ts +85 -85
- package/sdk/application/Configuration/ConfigurationApplicationModel.js +480 -851
- package/sdk/application/Configuration/ConfigurationApplicationValidator.d.ts +8 -8
- package/sdk/application/Configuration/ConfigurationApplicationValidator.js +33 -33
- package/sdk/application/Content/ContentApplicationClient.d.ts +67 -67
- package/sdk/application/Content/ContentApplicationClient.js +581 -213
- package/sdk/application/Content/ContentApplicationModel.d.ts +76 -75
- package/sdk/application/Content/ContentApplicationModel.js +468 -875
- package/sdk/application/Content/ContentApplicationValidator.d.ts +5 -5
- package/sdk/application/Content/ContentApplicationValidator.js +24 -24
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +25 -25
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +121 -59
- package/sdk/application/FileStorage/FileStorageApplicationModel.d.ts +13 -13
- package/sdk/application/FileStorage/FileStorageApplicationModel.js +86 -169
- package/sdk/application/FileStorage/FileStorageApplicationValidator.d.ts +1 -1
- package/sdk/application/FileStorage/FileStorageApplicationValidator.js +7 -7
- package/sdk/application/Lead/LeadApplicationClient.d.ts +24 -24
- package/sdk/application/Lead/LeadApplicationClient.js +230 -96
- package/sdk/application/Lead/LeadApplicationModel.d.ts +35 -35
- package/sdk/application/Lead/LeadApplicationModel.js +267 -474
- package/sdk/application/Lead/LeadApplicationValidator.d.ts +2 -2
- package/sdk/application/Lead/LeadApplicationValidator.js +11 -11
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +30 -19
- package/sdk/application/Logistic/LogisticApplicationClient.js +196 -47
- package/sdk/application/Logistic/LogisticApplicationModel.d.ts +17 -14
- package/sdk/application/Logistic/LogisticApplicationModel.js +133 -201
- package/sdk/application/Logistic/LogisticApplicationValidator.d.ts +3 -2
- package/sdk/application/Logistic/LogisticApplicationValidator.js +14 -8
- package/sdk/application/Order/OrderApplicationClient.d.ts +86 -86
- package/sdk/application/Order/OrderApplicationClient.js +448 -215
- package/sdk/application/Order/OrderApplicationModel.d.ts +50 -50
- package/sdk/application/Order/OrderApplicationModel.js +357 -661
- package/sdk/application/Order/OrderApplicationValidator.d.ts +7 -7
- package/sdk/application/Order/OrderApplicationValidator.js +28 -28
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +318 -318
- package/sdk/application/Payment/PaymentApplicationClient.js +1525 -750
- package/sdk/application/Payment/PaymentApplicationModel.d.ts +72 -72
- package/sdk/application/Payment/PaymentApplicationModel.js +565 -1033
- package/sdk/application/Payment/PaymentApplicationValidator.d.ts +28 -28
- package/sdk/application/Payment/PaymentApplicationValidator.js +107 -107
- package/sdk/application/PosCart/PosCartApplicationClient.d.ts +254 -254
- package/sdk/application/PosCart/PosCartApplicationClient.js +1137 -606
- package/sdk/application/PosCart/PosCartApplicationModel.d.ts +61 -60
- package/sdk/application/PosCart/PosCartApplicationModel.js +477 -873
- package/sdk/application/PosCart/PosCartApplicationValidator.d.ts +18 -18
- package/sdk/application/PosCart/PosCartApplicationValidator.js +103 -103
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +27 -27
- package/sdk/application/Rewards/RewardsApplicationClient.js +253 -113
- package/sdk/application/Rewards/RewardsApplicationModel.d.ts +14 -14
- package/sdk/application/Rewards/RewardsApplicationModel.js +96 -191
- package/sdk/application/Rewards/RewardsApplicationValidator.d.ts +3 -3
- package/sdk/application/Rewards/RewardsApplicationValidator.js +12 -12
- package/sdk/application/Share/ShareApplicationClient.d.ts +37 -37
- package/sdk/application/Share/ShareApplicationClient.js +221 -96
- package/sdk/application/Share/ShareApplicationModel.d.ts +8 -8
- package/sdk/application/Share/ShareApplicationModel.js +63 -123
- package/sdk/application/Share/ShareApplicationValidator.d.ts +4 -4
- package/sdk/application/Share/ShareApplicationValidator.js +12 -12
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +8 -8
- package/sdk/application/Theme/ThemeApplicationClient.js +115 -37
- package/sdk/application/Theme/ThemeApplicationModel.d.ts +34 -34
- package/sdk/application/Theme/ThemeApplicationModel.js +190 -336
- package/sdk/application/Theme/ThemeApplicationValidator.d.ts +1 -1
- package/sdk/application/Theme/ThemeApplicationValidator.js +4 -4
- package/sdk/application/User/UserApplicationClient.d.ts +280 -280
- package/sdk/application/User/UserApplicationClient.js +1201 -543
- package/sdk/application/User/UserApplicationModel.d.ts +79 -72
- package/sdk/application/User/UserApplicationModel.js +440 -689
- package/sdk/application/User/UserApplicationValidator.d.ts +24 -24
- package/sdk/application/User/UserApplicationValidator.js +89 -89
- package/sdk/common/AxiosHelper.js +1 -1
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.d.ts +55 -47
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.js +308 -151
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.d.ts +6 -6
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.js +20 -20
- package/sdk/platform/Analytics/AnalyticsPlatformClient.d.ts +8 -4
- package/sdk/platform/Analytics/AnalyticsPlatformClient.js +103 -16
- package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +11 -11
- package/sdk/platform/Analytics/AnalyticsPlatformModel.js +95 -178
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +16 -12
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +131 -44
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +10 -10
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +50 -89
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +1 -1
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.js +6 -6
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +68 -56
- package/sdk/platform/Billing/BillingPlatformClient.js +416 -171
- package/sdk/platform/Billing/BillingPlatformModel.d.ts +40 -40
- package/sdk/platform/Billing/BillingPlatformModel.js +342 -668
- package/sdk/platform/Billing/BillingPlatformValidator.d.ts +8 -8
- package/sdk/platform/Billing/BillingPlatformValidator.js +25 -25
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +176 -159
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +837 -500
- package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +11 -11
- package/sdk/platform/Cart/CartPlatformApplicationValidator.js +63 -63
- package/sdk/platform/Cart/CartPlatformModel.d.ts +86 -85
- package/sdk/platform/Cart/CartPlatformModel.js +677 -1211
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +582 -529
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +2642 -1533
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +40 -40
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +175 -175
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +708 -590
- package/sdk/platform/Catalog/CatalogPlatformClient.js +3103 -1362
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +293 -284
- package/sdk/platform/Catalog/CatalogPlatformModel.js +2149 -3660
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +66 -64
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +235 -216
- package/sdk/platform/Common/CommonPlatformClient.d.ts +14 -12
- package/sdk/platform/Common/CommonPlatformClient.js +80 -37
- package/sdk/platform/Common/CommonPlatformModel.d.ts +12 -12
- package/sdk/platform/Common/CommonPlatformModel.js +83 -160
- package/sdk/platform/Common/CommonPlatformValidator.d.ts +1 -1
- package/sdk/platform/Common/CommonPlatformValidator.js +6 -6
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +333 -293
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +1687 -855
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +30 -30
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +87 -87
- package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +2 -1
- package/sdk/platform/Communication/CommunicationPlatformClient.js +28 -4
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +67 -67
- package/sdk/platform/Communication/CommunicationPlatformModel.js +522 -974
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +70 -57
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +463 -182
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +28 -28
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +294 -557
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +7 -7
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +24 -24
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +175 -137
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +1168 -521
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +22 -21
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +69 -63
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +137 -119
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +691 -316
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +148 -146
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +854 -1508
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +9 -9
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +38 -38
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +542 -461
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +2600 -1160
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +50 -49
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +159 -152
- package/sdk/platform/Content/ContentPlatformModel.d.ts +79 -75
- package/sdk/platform/Content/ContentPlatformModel.js +486 -867
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +72 -61
- package/sdk/platform/Discount/DiscountPlatformClient.js +424 -198
- package/sdk/platform/Discount/DiscountPlatformModel.d.ts +7 -7
- package/sdk/platform/Discount/DiscountPlatformModel.js +60 -121
- package/sdk/platform/Discount/DiscountPlatformValidator.d.ts +6 -6
- package/sdk/platform/Discount/DiscountPlatformValidator.js +29 -29
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +26 -22
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +145 -59
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +1 -1
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +8 -8
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +58 -52
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +240 -114
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +13 -13
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +86 -169
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +3 -3
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.js +11 -11
- package/sdk/platform/Inventory/InventoryPlatformClient.d.ts +76 -63
- package/sdk/platform/Inventory/InventoryPlatformClient.js +461 -197
- package/sdk/platform/Inventory/InventoryPlatformModel.d.ts +30 -30
- package/sdk/platform/Inventory/InventoryPlatformModel.js +497 -964
- package/sdk/platform/Inventory/InventoryPlatformValidator.d.ts +7 -7
- package/sdk/platform/Inventory/InventoryPlatformValidator.js +28 -28
- package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +84 -71
- package/sdk/platform/Lead/LeadPlatformApplicationClient.js +441 -182
- package/sdk/platform/Lead/LeadPlatformApplicationValidator.d.ts +7 -7
- package/sdk/platform/Lead/LeadPlatformApplicationValidator.js +28 -28
- package/sdk/platform/Lead/LeadPlatformClient.d.ts +86 -75
- package/sdk/platform/Lead/LeadPlatformClient.js +434 -212
- package/sdk/platform/Lead/LeadPlatformModel.d.ts +35 -35
- package/sdk/platform/Lead/LeadPlatformModel.js +267 -474
- package/sdk/platform/Lead/LeadPlatformValidator.d.ts +6 -6
- package/sdk/platform/Lead/LeadPlatformValidator.js +24 -24
- package/sdk/platform/OAuthClient.js +8 -8
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +14 -11
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +113 -49
- package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +1 -1
- package/sdk/platform/Order/OrderPlatformApplicationValidator.js +6 -6
- package/sdk/platform/Order/OrderPlatformClient.d.ts +367 -315
- package/sdk/platform/Order/OrderPlatformClient.js +1775 -893
- package/sdk/platform/Order/OrderPlatformModel.d.ts +198 -192
- package/sdk/platform/Order/OrderPlatformModel.js +1591 -2822
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +32 -32
- package/sdk/platform/Order/OrderPlatformValidator.js +160 -155
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +4 -2
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +52 -8
- package/sdk/platform/Partner/PartnerPlatformModel.js +6 -22
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +65 -54
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +395 -164
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +6 -6
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +23 -23
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +55 -45
- package/sdk/platform/Payment/PaymentPlatformClient.js +362 -147
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +27 -27
- package/sdk/platform/Payment/PaymentPlatformModel.js +220 -408
- package/sdk/platform/Payment/PaymentPlatformValidator.d.ts +4 -4
- package/sdk/platform/Payment/PaymentPlatformValidator.js +21 -21
- package/sdk/platform/PlatformApplicationClient.d.ts +1496 -10153
- package/sdk/platform/PlatformApplicationClient.js +1584 -13691
- package/sdk/platform/PlatformClient.d.ts +7918 -7666
- package/sdk/platform/PlatformClient.js +8701 -9926
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +91 -78
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +507 -253
- package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.d.ts +8 -8
- package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.js +34 -34
- package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +15 -15
- package/sdk/platform/Rewards/RewardsPlatformModel.js +92 -194
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +16 -12
- package/sdk/platform/Share/SharePlatformApplicationClient.js +130 -52
- package/sdk/platform/Share/SharePlatformApplicationValidator.d.ts +1 -1
- package/sdk/platform/Share/SharePlatformApplicationValidator.js +6 -6
- package/sdk/platform/Share/SharePlatformModel.d.ts +8 -8
- package/sdk/platform/Share/SharePlatformModel.js +60 -118
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +148 -124
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +770 -295
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +15 -15
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +44 -44
- package/sdk/platform/Theme/ThemePlatformModel.d.ts +34 -34
- package/sdk/platform/Theme/ThemePlatformModel.js +190 -336
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +146 -67
- package/sdk/platform/User/UserPlatformApplicationClient.js +742 -155
- package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +12 -7
- package/sdk/platform/User/UserPlatformApplicationValidator.js +61 -23
- package/sdk/platform/User/UserPlatformModel.d.ts +79 -72
- package/sdk/platform/User/UserPlatformModel.js +440 -689
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +35 -29
- package/sdk/platform/Webhook/WebhookPlatformClient.js +218 -91
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +7 -7
- package/sdk/platform/Webhook/WebhookPlatformModel.js +68 -136
- package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +3 -3
- package/sdk/platform/Webhook/WebhookPlatformValidator.js +14 -14
- package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +13 -13
- package/sdk/public/Configuration/ConfigurationPublicClient.js +81 -38
- package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +12 -12
- package/sdk/public/Configuration/ConfigurationPublicModel.js +85 -162
- package/sdk/public/Configuration/ConfigurationPublicValidator.d.ts +1 -1
- package/sdk/public/Configuration/ConfigurationPublicValidator.js +6 -6
- package/sdk/public/Inventory/InventoryPublicClient.d.ts +34 -34
- package/sdk/public/Inventory/InventoryPublicClient.js +228 -105
- package/sdk/public/Inventory/InventoryPublicModel.d.ts +10 -10
- package/sdk/public/Inventory/InventoryPublicModel.js +119 -245
- package/sdk/public/Inventory/InventoryPublicValidator.d.ts +3 -3
- package/sdk/public/Inventory/InventoryPublicValidator.js +15 -15
- package/sdk/public/Webhook/WebhookPublicClient.js +51 -10
- package/sdk/public/Webhook/WebhookPublicModel.d.ts +7 -7
- package/sdk/public/Webhook/WebhookPublicModel.js +68 -136
- package/tests/application/catalog.spec.js +7 -0
|
@@ -8,27 +8,27 @@
|
|
|
8
8
|
## Payment Methods
|
|
9
9
|
Collect payment through many payment gateway i.e Stripe, Razorpay, Juspay etc.into Fynd or Self account
|
|
10
10
|
|
|
11
|
-
* [getBrandPaymentGatewayConfig](#getbrandpaymentgatewayconfig)
|
|
12
|
-
* [saveBrandPaymentGatewayConfig](#savebrandpaymentgatewayconfig)
|
|
13
|
-
* [updateBrandPaymentGatewayConfig](#updatebrandpaymentgatewayconfig)
|
|
14
|
-
* [getPaymentModeRoutes](#getpaymentmoderoutes)
|
|
15
|
-
* [getAllPayouts](#getallpayouts)
|
|
16
|
-
* [savePayout](#savepayout)
|
|
17
|
-
* [updatePayout](#updatepayout)
|
|
18
11
|
* [activateAndDectivatePayout](#activateanddectivatepayout)
|
|
12
|
+
* [addRefundBankAccountUsingOTP](#addrefundbankaccountusingotp)
|
|
13
|
+
* [confirmPayment](#confirmpayment)
|
|
19
14
|
* [deletePayout](#deletepayout)
|
|
20
|
-
* [getSubscriptionPaymentMethod](#getsubscriptionpaymentmethod)
|
|
21
15
|
* [deleteSubscriptionPaymentMethod](#deletesubscriptionpaymentmethod)
|
|
22
|
-
* [
|
|
23
|
-
* [saveSubscriptionSetupIntent](#savesubscriptionsetupintent)
|
|
16
|
+
* [getAllPayouts](#getallpayouts)
|
|
24
17
|
* [getBankAccountDetailsOpenAPI](#getbankaccountdetailsopenapi)
|
|
25
|
-
* [
|
|
26
|
-
* [
|
|
27
|
-
* [
|
|
18
|
+
* [getBrandPaymentGatewayConfig](#getbrandpaymentgatewayconfig)
|
|
19
|
+
* [getPaymentModeRoutes](#getpaymentmoderoutes)
|
|
20
|
+
* [getSubscriptionConfig](#getsubscriptionconfig)
|
|
21
|
+
* [getSubscriptionPaymentMethod](#getsubscriptionpaymentmethod)
|
|
28
22
|
* [getUserBeneficiaries](#getuserbeneficiaries)
|
|
29
|
-
* [confirmPayment](#confirmpayment)
|
|
30
23
|
* [getUserCODlimitRoutes](#getusercodlimitroutes)
|
|
24
|
+
* [getUserOrderBeneficiaries](#getuserorderbeneficiaries)
|
|
25
|
+
* [saveBrandPaymentGatewayConfig](#savebrandpaymentgatewayconfig)
|
|
26
|
+
* [savePayout](#savepayout)
|
|
27
|
+
* [saveSubscriptionSetupIntent](#savesubscriptionsetupintent)
|
|
31
28
|
* [setUserCODlimitRoutes](#setusercodlimitroutes)
|
|
29
|
+
* [updateBrandPaymentGatewayConfig](#updatebrandpaymentgatewayconfig)
|
|
30
|
+
* [updatePayout](#updatepayout)
|
|
31
|
+
* [verifyIfscCode](#verifyifsccode)
|
|
32
32
|
|
|
33
33
|
|
|
34
34
|
|
|
@@ -37,34 +37,41 @@ Collect payment through many payment gateway i.e Stripe, Razorpay, Juspay etc.in
|
|
|
37
37
|
|
|
38
38
|
|
|
39
39
|
|
|
40
|
-
###
|
|
41
|
-
|
|
40
|
+
### activateAndDectivatePayout
|
|
41
|
+
Partial Update Payout
|
|
42
42
|
|
|
43
43
|
|
|
44
44
|
|
|
45
45
|
```javascript
|
|
46
46
|
// Promise
|
|
47
|
-
const promise = client.
|
|
47
|
+
const promise = client.payment.activateAndDectivatePayout({ uniqueTransferNo : value,
|
|
48
|
+
body : value });
|
|
48
49
|
|
|
49
50
|
// Async/Await
|
|
50
|
-
const data = await client.
|
|
51
|
+
const data = await client.payment.activateAndDectivatePayout({ uniqueTransferNo : value,
|
|
52
|
+
body : value });
|
|
51
53
|
```
|
|
52
54
|
|
|
53
55
|
|
|
54
56
|
|
|
55
57
|
|
|
56
58
|
|
|
59
|
+
| Argument | Type | Required | Description |
|
|
60
|
+
| --------- | ----- | -------- | ----------- |
|
|
61
|
+
| uniqueTransferNo | string | yes | Unique transfer id |
|
|
62
|
+
| body | [UpdatePayoutRequest](#UpdatePayoutRequest) | yes | Request body |
|
|
63
|
+
|
|
57
64
|
|
|
58
|
-
|
|
65
|
+
Partial Update Payout
|
|
59
66
|
|
|
60
67
|
*Returned Response:*
|
|
61
68
|
|
|
62
69
|
|
|
63
70
|
|
|
64
71
|
|
|
65
|
-
[
|
|
72
|
+
[UpdatePayoutResponse](#UpdatePayoutResponse)
|
|
66
73
|
|
|
67
|
-
|
|
74
|
+
save payout response object
|
|
68
75
|
|
|
69
76
|
|
|
70
77
|
|
|
@@ -75,121 +82,8 @@ Refund Transfer Mode
|
|
|
75
82
|
```json
|
|
76
83
|
{
|
|
77
84
|
"success": true,
|
|
78
|
-
"
|
|
79
|
-
"
|
|
80
|
-
"excluded_fields": [
|
|
81
|
-
"config_type",
|
|
82
|
-
"aggregator"
|
|
83
|
-
],
|
|
84
|
-
"display_fields": [
|
|
85
|
-
"logo",
|
|
86
|
-
"display"
|
|
87
|
-
],
|
|
88
|
-
"aggregators": [
|
|
89
|
-
{
|
|
90
|
-
"key": "rrroooouuurrrrdddd",
|
|
91
|
-
"secret": "yyyyooo",
|
|
92
|
-
"is_active": false,
|
|
93
|
-
"config_type": "",
|
|
94
|
-
"merchant_key": "vvvvvvvvddd",
|
|
95
|
-
"aggregator": "juspay",
|
|
96
|
-
"display": {
|
|
97
|
-
"link": "",
|
|
98
|
-
"text": "Review in under process. Please wait while process completed or contact us for any further query.",
|
|
99
|
-
"description": "Juspay is not a Payment Gateway (like Citrus, CCAvenue, PayU) but it works with any gateway or aggregator with zero interference in the Merchant-PG relations.",
|
|
100
|
-
"reviewed": false
|
|
101
|
-
},
|
|
102
|
-
"logo": "https://hdn-1.fynd.com/payment/juspay-pg-logo.jpg"
|
|
103
|
-
},
|
|
104
|
-
{
|
|
105
|
-
"key": "",
|
|
106
|
-
"pin": "",
|
|
107
|
-
"secret": "",
|
|
108
|
-
"user_id": "",
|
|
109
|
-
"is_active": false,
|
|
110
|
-
"config_type": "",
|
|
111
|
-
"merchant_id": "",
|
|
112
|
-
"aggregator": "mswipe",
|
|
113
|
-
"display": {
|
|
114
|
-
"link": "",
|
|
115
|
-
"text": "Submitted request to be reviewed before going live. Please contact us for any further query.",
|
|
116
|
-
"description": "Mswipe card swipe machines are safe and secure and accepts all debit & credit cards."
|
|
117
|
-
},
|
|
118
|
-
"logo": "https://hdn-1.fynd.com/payment/mswipe-pg-logo.png"
|
|
119
|
-
},
|
|
120
|
-
{
|
|
121
|
-
"key": "tttyyyyyy",
|
|
122
|
-
"secret": "rerrrrrrrr",
|
|
123
|
-
"is_active": false,
|
|
124
|
-
"config_type": "",
|
|
125
|
-
"merchant_salt": "qqqqq",
|
|
126
|
-
"aggregator": "payumoney",
|
|
127
|
-
"display": {
|
|
128
|
-
"link": "",
|
|
129
|
-
"text": "Review in under process. Please wait while process completed or contact us for any further query.",
|
|
130
|
-
"description": "PayUmoney supports wide range of options for making online payments via wallets, UPI, cards, and netbanking.",
|
|
131
|
-
"reviewed": false
|
|
132
|
-
},
|
|
133
|
-
"logo": "https://hdn-1.fynd.com/payment/payu_logo_large.png"
|
|
134
|
-
},
|
|
135
|
-
{
|
|
136
|
-
"key": "test",
|
|
137
|
-
"secret": "test",
|
|
138
|
-
"is_active": true,
|
|
139
|
-
"config_type": "self",
|
|
140
|
-
"webhook_secret": "test",
|
|
141
|
-
"aggregator": "razorpay",
|
|
142
|
-
"display": {
|
|
143
|
-
"link": "",
|
|
144
|
-
"text": "Well done, You payment gateway successfully lived. Collect your payment at your end.",
|
|
145
|
-
"description": "Razorpay is a payments platform which accept online payments via Credit Card, Debit Card, Net banking, UPI, BharatQR and Wallets.",
|
|
146
|
-
"reviewed": true
|
|
147
|
-
},
|
|
148
|
-
"logo": "https://hdn-1.fynd.com/payment/razorpay-pg-logo.jpg"
|
|
149
|
-
},
|
|
150
|
-
{
|
|
151
|
-
"key": "",
|
|
152
|
-
"secret": "",
|
|
153
|
-
"is_active": false,
|
|
154
|
-
"config_type": "",
|
|
155
|
-
"aggregator": "rupifi",
|
|
156
|
-
"display": {
|
|
157
|
-
"link": "",
|
|
158
|
-
"text": "Submitted request to be reviewed before going live. Please contact us for any further query.",
|
|
159
|
-
"description": "Rupifi enables businesses to avail credits and allows a 'Buy now, Pay later' system for making transactions and purchases."
|
|
160
|
-
},
|
|
161
|
-
"logo": "https://hdn-1.fynd.com/payment/Rupifi.png"
|
|
162
|
-
},
|
|
163
|
-
{
|
|
164
|
-
"key": "12345",
|
|
165
|
-
"secret": "12345",
|
|
166
|
-
"is_active": false,
|
|
167
|
-
"config_type": "",
|
|
168
|
-
"aggregator": "simpl",
|
|
169
|
-
"display": {
|
|
170
|
-
"link": "",
|
|
171
|
-
"text": "Review in under process. Please wait while process completed or contact us for any further query.",
|
|
172
|
-
"description": "Simpl is a Pay Later payment method.",
|
|
173
|
-
"reviewed": false
|
|
174
|
-
},
|
|
175
|
-
"logo": "https://hdn-1.fynd.com/payment/simpl-pg-logo.jpg"
|
|
176
|
-
},
|
|
177
|
-
{
|
|
178
|
-
"key": "",
|
|
179
|
-
"secret": "",
|
|
180
|
-
"is_active": false,
|
|
181
|
-
"product_id": "",
|
|
182
|
-
"config_type": "",
|
|
183
|
-
"webhook_secret": "",
|
|
184
|
-
"aggregator": "stripe",
|
|
185
|
-
"display": {
|
|
186
|
-
"link": "",
|
|
187
|
-
"text": "Submitted request to be reviewed before going live. Please contact us for any further query.",
|
|
188
|
-
"description": "Stripe is a payment processor that supports online payments, credit cards, recurring subscriptions and direct payouts to bank accounts."
|
|
189
|
-
},
|
|
190
|
-
"logo": "https://hdn-1.fynd.com/payment/Stripe.png"
|
|
191
|
-
}
|
|
192
|
-
]
|
|
85
|
+
"is_default": true,
|
|
86
|
+
"is_active": true
|
|
193
87
|
}
|
|
194
88
|
```
|
|
195
89
|
</details>
|
|
@@ -205,17 +99,17 @@ Refund Transfer Mode
|
|
|
205
99
|
---
|
|
206
100
|
|
|
207
101
|
|
|
208
|
-
###
|
|
209
|
-
Save
|
|
102
|
+
### addRefundBankAccountUsingOTP
|
|
103
|
+
Save bank details for cancelled/returned order
|
|
210
104
|
|
|
211
105
|
|
|
212
106
|
|
|
213
107
|
```javascript
|
|
214
108
|
// Promise
|
|
215
|
-
const promise = client.application("<APPLICATION_ID>").payment.
|
|
109
|
+
const promise = client.application("<APPLICATION_ID>").payment.addRefundBankAccountUsingOTP({ body : value });
|
|
216
110
|
|
|
217
111
|
// Async/Await
|
|
218
|
-
const data = await client.application("<APPLICATION_ID>").payment.
|
|
112
|
+
const data = await client.application("<APPLICATION_ID>").payment.addRefundBankAccountUsingOTP({ body : value });
|
|
219
113
|
```
|
|
220
114
|
|
|
221
115
|
|
|
@@ -224,19 +118,19 @@ const data = await client.application("<APPLICATION_ID>").payment.saveBrandPayme
|
|
|
224
118
|
|
|
225
119
|
| Argument | Type | Required | Description |
|
|
226
120
|
| --------- | ----- | -------- | ----------- |
|
|
227
|
-
| body | [
|
|
121
|
+
| body | [AddBeneficiaryDetailsOTPRequest](#AddBeneficiaryDetailsOTPRequest) | yes | Request body |
|
|
228
122
|
|
|
229
123
|
|
|
230
|
-
|
|
124
|
+
Use this API to save bank details for returned/cancelled order to refund amount in his account.
|
|
231
125
|
|
|
232
126
|
*Returned Response:*
|
|
233
127
|
|
|
234
128
|
|
|
235
129
|
|
|
236
130
|
|
|
237
|
-
[
|
|
131
|
+
[RefundAccountResponse](#RefundAccountResponse)
|
|
238
132
|
|
|
239
|
-
|
|
133
|
+
Success
|
|
240
134
|
|
|
241
135
|
|
|
242
136
|
|
|
@@ -247,9 +141,9 @@ Save Config Secret For Brand Payment Gateway Success Response.
|
|
|
247
141
|
```json
|
|
248
142
|
{
|
|
249
143
|
"success": true,
|
|
250
|
-
"
|
|
251
|
-
|
|
252
|
-
|
|
144
|
+
"message": "Account successfully created",
|
|
145
|
+
"data": {},
|
|
146
|
+
"is_verified_flag": true
|
|
253
147
|
}
|
|
254
148
|
```
|
|
255
149
|
</details>
|
|
@@ -265,17 +159,17 @@ Save Config Secret For Brand Payment Gateway Success Response.
|
|
|
265
159
|
---
|
|
266
160
|
|
|
267
161
|
|
|
268
|
-
###
|
|
269
|
-
|
|
162
|
+
### confirmPayment
|
|
163
|
+
Confirm payment after successful payment from payment gateway
|
|
270
164
|
|
|
271
165
|
|
|
272
166
|
|
|
273
167
|
```javascript
|
|
274
168
|
// Promise
|
|
275
|
-
const promise = client.application("<APPLICATION_ID>").payment.
|
|
169
|
+
const promise = client.application("<APPLICATION_ID>").payment.confirmPayment({ body : value });
|
|
276
170
|
|
|
277
171
|
// Async/Await
|
|
278
|
-
const data = await client.application("<APPLICATION_ID>").payment.
|
|
172
|
+
const data = await client.application("<APPLICATION_ID>").payment.confirmPayment({ body : value });
|
|
279
173
|
```
|
|
280
174
|
|
|
281
175
|
|
|
@@ -284,19 +178,19 @@ const data = await client.application("<APPLICATION_ID>").payment.updateBrandPay
|
|
|
284
178
|
|
|
285
179
|
| Argument | Type | Required | Description |
|
|
286
180
|
| --------- | ----- | -------- | ----------- |
|
|
287
|
-
| body | [
|
|
181
|
+
| body | [PaymentConfirmationRequest](#PaymentConfirmationRequest) | yes | Request body |
|
|
288
182
|
|
|
289
183
|
|
|
290
|
-
|
|
184
|
+
Use this API to confirm payment after payment gateway accepted payment.
|
|
291
185
|
|
|
292
186
|
*Returned Response:*
|
|
293
187
|
|
|
294
188
|
|
|
295
189
|
|
|
296
190
|
|
|
297
|
-
[
|
|
191
|
+
[PaymentConfirmationResponse](#PaymentConfirmationResponse)
|
|
298
192
|
|
|
299
|
-
|
|
193
|
+
Success. Returns the status of payment. Check the example shown below or refer `PaymentConfirmationResponseSchema` for more details.
|
|
300
194
|
|
|
301
195
|
|
|
302
196
|
|
|
@@ -307,9 +201,8 @@ Save Config Secret For Brand Payment Gateway Success Response.
|
|
|
307
201
|
```json
|
|
308
202
|
{
|
|
309
203
|
"success": true,
|
|
310
|
-
"
|
|
311
|
-
|
|
312
|
-
]
|
|
204
|
+
"message": "Payment Successful",
|
|
205
|
+
"order_id": "FY60F90AEF01FF43E878"
|
|
313
206
|
}
|
|
314
207
|
```
|
|
315
208
|
</details>
|
|
@@ -325,19 +218,17 @@ Save Config Secret For Brand Payment Gateway Success Response.
|
|
|
325
218
|
---
|
|
326
219
|
|
|
327
220
|
|
|
328
|
-
###
|
|
329
|
-
|
|
221
|
+
### deletePayout
|
|
222
|
+
Delete Payout
|
|
330
223
|
|
|
331
224
|
|
|
332
225
|
|
|
333
226
|
```javascript
|
|
334
227
|
// Promise
|
|
335
|
-
const promise = client.
|
|
336
|
-
requestType : value });
|
|
228
|
+
const promise = client.payment.deletePayout({ uniqueTransferNo : value });
|
|
337
229
|
|
|
338
230
|
// Async/Await
|
|
339
|
-
const data = await client.
|
|
340
|
-
requestType : value });
|
|
231
|
+
const data = await client.payment.deletePayout({ uniqueTransferNo : value });
|
|
341
232
|
```
|
|
342
233
|
|
|
343
234
|
|
|
@@ -346,21 +237,20 @@ const data = await client.application("<APPLICATION_ID>").payment.getPaymentMode
|
|
|
346
237
|
|
|
347
238
|
| Argument | Type | Required | Description |
|
|
348
239
|
| --------- | ----- | -------- | ----------- |
|
|
349
|
-
|
|
|
350
|
-
| requestType | string | yes | |
|
|
240
|
+
| uniqueTransferNo | string | yes | Unique transfer id |
|
|
351
241
|
|
|
352
242
|
|
|
353
243
|
|
|
354
|
-
|
|
244
|
+
Delete Payout
|
|
355
245
|
|
|
356
246
|
*Returned Response:*
|
|
357
247
|
|
|
358
248
|
|
|
359
249
|
|
|
360
250
|
|
|
361
|
-
[
|
|
251
|
+
[DeletePayoutResponse](#DeletePayoutResponse)
|
|
362
252
|
|
|
363
|
-
|
|
253
|
+
delete payout response object
|
|
364
254
|
|
|
365
255
|
|
|
366
256
|
|
|
@@ -370,34 +260,515 @@ Success
|
|
|
370
260
|
|
|
371
261
|
```json
|
|
372
262
|
{
|
|
373
|
-
"success": true
|
|
374
|
-
|
|
375
|
-
|
|
376
|
-
|
|
377
|
-
|
|
378
|
-
|
|
379
|
-
|
|
380
|
-
|
|
381
|
-
|
|
382
|
-
|
|
383
|
-
|
|
384
|
-
|
|
385
|
-
|
|
386
|
-
|
|
387
|
-
|
|
388
|
-
|
|
389
|
-
|
|
390
|
-
|
|
391
|
-
|
|
392
|
-
|
|
393
|
-
|
|
394
|
-
|
|
395
|
-
|
|
396
|
-
|
|
397
|
-
|
|
398
|
-
|
|
399
|
-
|
|
400
|
-
|
|
263
|
+
"success": true
|
|
264
|
+
}
|
|
265
|
+
```
|
|
266
|
+
</details>
|
|
267
|
+
|
|
268
|
+
|
|
269
|
+
|
|
270
|
+
|
|
271
|
+
|
|
272
|
+
|
|
273
|
+
|
|
274
|
+
|
|
275
|
+
|
|
276
|
+
---
|
|
277
|
+
|
|
278
|
+
|
|
279
|
+
### deleteSubscriptionPaymentMethod
|
|
280
|
+
Delete Subscription Payment Method
|
|
281
|
+
|
|
282
|
+
|
|
283
|
+
|
|
284
|
+
```javascript
|
|
285
|
+
// Promise
|
|
286
|
+
const promise = client.payment.deleteSubscriptionPaymentMethod({ uniqueExternalId : value,
|
|
287
|
+
paymentMethodId : value });
|
|
288
|
+
|
|
289
|
+
// Async/Await
|
|
290
|
+
const data = await client.payment.deleteSubscriptionPaymentMethod({ uniqueExternalId : value,
|
|
291
|
+
paymentMethodId : value });
|
|
292
|
+
```
|
|
293
|
+
|
|
294
|
+
|
|
295
|
+
|
|
296
|
+
|
|
297
|
+
|
|
298
|
+
| Argument | Type | Required | Description |
|
|
299
|
+
| --------- | ----- | -------- | ----------- |
|
|
300
|
+
| uniqueExternalId | string | yes | |
|
|
301
|
+
| paymentMethodId | string | yes | |
|
|
302
|
+
|
|
303
|
+
|
|
304
|
+
|
|
305
|
+
Uses this api to Delete Subscription Payment Method
|
|
306
|
+
|
|
307
|
+
*Returned Response:*
|
|
308
|
+
|
|
309
|
+
|
|
310
|
+
|
|
311
|
+
|
|
312
|
+
[DeleteSubscriptionPaymentMethodResponse](#DeleteSubscriptionPaymentMethodResponse)
|
|
313
|
+
|
|
314
|
+
Delete Subscription Payment Method Response.
|
|
315
|
+
|
|
316
|
+
|
|
317
|
+
|
|
318
|
+
|
|
319
|
+
<details>
|
|
320
|
+
<summary><i> Example:</i></summary>
|
|
321
|
+
|
|
322
|
+
```json
|
|
323
|
+
{
|
|
324
|
+
"success": true
|
|
325
|
+
}
|
|
326
|
+
```
|
|
327
|
+
</details>
|
|
328
|
+
|
|
329
|
+
|
|
330
|
+
|
|
331
|
+
|
|
332
|
+
|
|
333
|
+
|
|
334
|
+
|
|
335
|
+
|
|
336
|
+
|
|
337
|
+
---
|
|
338
|
+
|
|
339
|
+
|
|
340
|
+
### getAllPayouts
|
|
341
|
+
Get All Payouts
|
|
342
|
+
|
|
343
|
+
|
|
344
|
+
|
|
345
|
+
```javascript
|
|
346
|
+
// Promise
|
|
347
|
+
const promise = client.payment.getAllPayouts({ uniqueExternalId : value });
|
|
348
|
+
|
|
349
|
+
// Async/Await
|
|
350
|
+
const data = await client.payment.getAllPayouts({ uniqueExternalId : value });
|
|
351
|
+
```
|
|
352
|
+
|
|
353
|
+
|
|
354
|
+
|
|
355
|
+
|
|
356
|
+
|
|
357
|
+
| Argument | Type | Required | Description |
|
|
358
|
+
| --------- | ----- | -------- | ----------- |
|
|
359
|
+
| uniqueExternalId | string | no | Fetch payouts using unique external id |
|
|
360
|
+
|
|
361
|
+
|
|
362
|
+
|
|
363
|
+
Get All Payouts
|
|
364
|
+
|
|
365
|
+
*Returned Response:*
|
|
366
|
+
|
|
367
|
+
|
|
368
|
+
|
|
369
|
+
|
|
370
|
+
[PayoutsResponse](#PayoutsResponse)
|
|
371
|
+
|
|
372
|
+
payouts response object
|
|
373
|
+
|
|
374
|
+
|
|
375
|
+
|
|
376
|
+
|
|
377
|
+
<details>
|
|
378
|
+
<summary><i> Example:</i></summary>
|
|
379
|
+
|
|
380
|
+
```json
|
|
381
|
+
[
|
|
382
|
+
{
|
|
383
|
+
"unique_transfer_no": "d2ff79fcd3459831864824da8c9d7e5f",
|
|
384
|
+
"more_attributes": {
|
|
385
|
+
"city": "",
|
|
386
|
+
"state": "",
|
|
387
|
+
"country": "",
|
|
388
|
+
"bank_name": "YES",
|
|
389
|
+
"ifsc_code": "IFSCYES101",
|
|
390
|
+
"account_no": "9876541234",
|
|
391
|
+
"branch_name": "Mumbai",
|
|
392
|
+
"account_type": "current",
|
|
393
|
+
"account_holder": "Vikas Kumar"
|
|
394
|
+
},
|
|
395
|
+
"transfer_type": "bank",
|
|
396
|
+
"is_default": true,
|
|
397
|
+
"is_active": true,
|
|
398
|
+
"customers": {
|
|
399
|
+
"id": 2,
|
|
400
|
+
"name": "reliance retail",
|
|
401
|
+
"mobile": "1234567890",
|
|
402
|
+
"email": "reliance@gmail.com",
|
|
403
|
+
"unique_external_id": "company:1"
|
|
404
|
+
},
|
|
405
|
+
"payouts_aggregators": [
|
|
406
|
+
{
|
|
407
|
+
"payout_details_id": 888,
|
|
408
|
+
"aggregator_id": 3,
|
|
409
|
+
"aggregator_fund_id": null
|
|
410
|
+
}
|
|
411
|
+
]
|
|
412
|
+
},
|
|
413
|
+
{
|
|
414
|
+
"unique_transfer_no": "e388c1c5df4933fa01f6da9f92595589",
|
|
415
|
+
"more_attributes": {
|
|
416
|
+
"city": "",
|
|
417
|
+
"state": "",
|
|
418
|
+
"country": "",
|
|
419
|
+
"bank_name": "SBI",
|
|
420
|
+
"ifsc_code": "SBIN0011513",
|
|
421
|
+
"account_no": "9876543210",
|
|
422
|
+
"branch_name": "Mumbai",
|
|
423
|
+
"account_type": "saving",
|
|
424
|
+
"account_holder": "Vikas Kumar"
|
|
425
|
+
},
|
|
426
|
+
"transfer_type": "bank",
|
|
427
|
+
"is_default": false,
|
|
428
|
+
"is_active": true,
|
|
429
|
+
"customers": {
|
|
430
|
+
"id": 2,
|
|
431
|
+
"name": "reliance retail",
|
|
432
|
+
"mobile": "1234567890",
|
|
433
|
+
"email": "reliance@gmail.com",
|
|
434
|
+
"unique_external_id": "company:1"
|
|
435
|
+
},
|
|
436
|
+
"payouts_aggregators": [
|
|
437
|
+
{
|
|
438
|
+
"payout_details_id": 891,
|
|
439
|
+
"aggregator_id": 3,
|
|
440
|
+
"aggregator_fund_id": null
|
|
441
|
+
}
|
|
442
|
+
]
|
|
443
|
+
}
|
|
444
|
+
]
|
|
445
|
+
```
|
|
446
|
+
</details>
|
|
447
|
+
|
|
448
|
+
|
|
449
|
+
|
|
450
|
+
|
|
451
|
+
|
|
452
|
+
|
|
453
|
+
|
|
454
|
+
|
|
455
|
+
|
|
456
|
+
---
|
|
457
|
+
|
|
458
|
+
|
|
459
|
+
### getBankAccountDetailsOpenAPI
|
|
460
|
+
Get bank details
|
|
461
|
+
|
|
462
|
+
|
|
463
|
+
|
|
464
|
+
```javascript
|
|
465
|
+
// Promise
|
|
466
|
+
const promise = client.application("<APPLICATION_ID>").payment.getBankAccountDetailsOpenAPI({ orderId : value,
|
|
467
|
+
requestHash : value });
|
|
468
|
+
|
|
469
|
+
// Async/Await
|
|
470
|
+
const data = await client.application("<APPLICATION_ID>").payment.getBankAccountDetailsOpenAPI({ orderId : value,
|
|
471
|
+
requestHash : value });
|
|
472
|
+
```
|
|
473
|
+
|
|
474
|
+
|
|
475
|
+
|
|
476
|
+
|
|
477
|
+
|
|
478
|
+
| Argument | Type | Required | Description |
|
|
479
|
+
| --------- | ----- | -------- | ----------- |
|
|
480
|
+
| orderId | string | yes | |
|
|
481
|
+
| requestHash | string | no | |
|
|
482
|
+
|
|
483
|
+
|
|
484
|
+
|
|
485
|
+
Use this API to get saved bank details for returned/cancelled order using order id.
|
|
486
|
+
|
|
487
|
+
*Returned Response:*
|
|
488
|
+
|
|
489
|
+
|
|
490
|
+
|
|
491
|
+
|
|
492
|
+
[RefundAccountResponse](#RefundAccountResponse)
|
|
493
|
+
|
|
494
|
+
Success
|
|
495
|
+
|
|
496
|
+
|
|
497
|
+
|
|
498
|
+
|
|
499
|
+
<details>
|
|
500
|
+
<summary><i> Example:</i></summary>
|
|
501
|
+
|
|
502
|
+
```json
|
|
503
|
+
{
|
|
504
|
+
"success": true,
|
|
505
|
+
"data": {
|
|
506
|
+
"account_no": "XXXX-XXXX-6682",
|
|
507
|
+
"ifsc_code": "SBIEXAMPLE001",
|
|
508
|
+
"email": "loremipsum@example.com",
|
|
509
|
+
"address": "1773 Monroe Street",
|
|
510
|
+
"bank_name": "SBI",
|
|
511
|
+
"branch_name": "HOUSTON",
|
|
512
|
+
"comment": "Lorem Ipsum",
|
|
513
|
+
"account_holder": "Leslie Rice",
|
|
514
|
+
"mobile": "0987654321"
|
|
515
|
+
}
|
|
516
|
+
}
|
|
517
|
+
```
|
|
518
|
+
</details>
|
|
519
|
+
|
|
520
|
+
|
|
521
|
+
|
|
522
|
+
|
|
523
|
+
|
|
524
|
+
|
|
525
|
+
|
|
526
|
+
|
|
527
|
+
|
|
528
|
+
---
|
|
529
|
+
|
|
530
|
+
|
|
531
|
+
### getBrandPaymentGatewayConfig
|
|
532
|
+
Get All Brand Payment Gateway Config Secret
|
|
533
|
+
|
|
534
|
+
|
|
535
|
+
|
|
536
|
+
```javascript
|
|
537
|
+
// Promise
|
|
538
|
+
const promise = client.application("<APPLICATION_ID>").payment.getBrandPaymentGatewayConfig();
|
|
539
|
+
|
|
540
|
+
// Async/Await
|
|
541
|
+
const data = await client.application("<APPLICATION_ID>").payment.getBrandPaymentGatewayConfig();
|
|
542
|
+
```
|
|
543
|
+
|
|
544
|
+
|
|
545
|
+
|
|
546
|
+
|
|
547
|
+
|
|
548
|
+
|
|
549
|
+
Get All Brand Payment Gateway Config Secret
|
|
550
|
+
|
|
551
|
+
*Returned Response:*
|
|
552
|
+
|
|
553
|
+
|
|
554
|
+
|
|
555
|
+
|
|
556
|
+
[PaymentGatewayConfigResponse](#PaymentGatewayConfigResponse)
|
|
557
|
+
|
|
558
|
+
Refund Transfer Mode
|
|
559
|
+
|
|
560
|
+
|
|
561
|
+
|
|
562
|
+
|
|
563
|
+
<details>
|
|
564
|
+
<summary><i> Example:</i></summary>
|
|
565
|
+
|
|
566
|
+
```json
|
|
567
|
+
{
|
|
568
|
+
"success": true,
|
|
569
|
+
"created": true,
|
|
570
|
+
"app_id": "000000000000000000000004",
|
|
571
|
+
"excluded_fields": [
|
|
572
|
+
"config_type",
|
|
573
|
+
"aggregator"
|
|
574
|
+
],
|
|
575
|
+
"display_fields": [
|
|
576
|
+
"logo",
|
|
577
|
+
"display"
|
|
578
|
+
],
|
|
579
|
+
"aggregators": [
|
|
580
|
+
{
|
|
581
|
+
"key": "rrroooouuurrrrdddd",
|
|
582
|
+
"secret": "yyyyooo",
|
|
583
|
+
"is_active": false,
|
|
584
|
+
"config_type": "",
|
|
585
|
+
"merchant_key": "vvvvvvvvddd",
|
|
586
|
+
"aggregator": "juspay",
|
|
587
|
+
"display": {
|
|
588
|
+
"link": "",
|
|
589
|
+
"text": "Review in under process. Please wait while process completed or contact us for any further query.",
|
|
590
|
+
"description": "Juspay is not a Payment Gateway (like Citrus, CCAvenue, PayU) but it works with any gateway or aggregator with zero interference in the Merchant-PG relations.",
|
|
591
|
+
"reviewed": false
|
|
592
|
+
},
|
|
593
|
+
"logo": "https://hdn-1.fynd.com/payment/juspay-pg-logo.jpg"
|
|
594
|
+
},
|
|
595
|
+
{
|
|
596
|
+
"key": "",
|
|
597
|
+
"pin": "",
|
|
598
|
+
"secret": "",
|
|
599
|
+
"user_id": "",
|
|
600
|
+
"is_active": false,
|
|
601
|
+
"config_type": "",
|
|
602
|
+
"merchant_id": "",
|
|
603
|
+
"aggregator": "mswipe",
|
|
604
|
+
"display": {
|
|
605
|
+
"link": "",
|
|
606
|
+
"text": "Submitted request to be reviewed before going live. Please contact us for any further query.",
|
|
607
|
+
"description": "Mswipe card swipe machines are safe and secure and accepts all debit & credit cards."
|
|
608
|
+
},
|
|
609
|
+
"logo": "https://hdn-1.fynd.com/payment/mswipe-pg-logo.png"
|
|
610
|
+
},
|
|
611
|
+
{
|
|
612
|
+
"key": "tttyyyyyy",
|
|
613
|
+
"secret": "rerrrrrrrr",
|
|
614
|
+
"is_active": false,
|
|
615
|
+
"config_type": "",
|
|
616
|
+
"merchant_salt": "qqqqq",
|
|
617
|
+
"aggregator": "payumoney",
|
|
618
|
+
"display": {
|
|
619
|
+
"link": "",
|
|
620
|
+
"text": "Review in under process. Please wait while process completed or contact us for any further query.",
|
|
621
|
+
"description": "PayUmoney supports wide range of options for making online payments via wallets, UPI, cards, and netbanking.",
|
|
622
|
+
"reviewed": false
|
|
623
|
+
},
|
|
624
|
+
"logo": "https://hdn-1.fynd.com/payment/payu_logo_large.png"
|
|
625
|
+
},
|
|
626
|
+
{
|
|
627
|
+
"key": "test",
|
|
628
|
+
"secret": "test",
|
|
629
|
+
"is_active": true,
|
|
630
|
+
"config_type": "self",
|
|
631
|
+
"webhook_secret": "test",
|
|
632
|
+
"aggregator": "razorpay",
|
|
633
|
+
"display": {
|
|
634
|
+
"link": "",
|
|
635
|
+
"text": "Well done, You payment gateway successfully lived. Collect your payment at your end.",
|
|
636
|
+
"description": "Razorpay is a payments platform which accept online payments via Credit Card, Debit Card, Net banking, UPI, BharatQR and Wallets.",
|
|
637
|
+
"reviewed": true
|
|
638
|
+
},
|
|
639
|
+
"logo": "https://hdn-1.fynd.com/payment/razorpay-pg-logo.jpg"
|
|
640
|
+
},
|
|
641
|
+
{
|
|
642
|
+
"key": "",
|
|
643
|
+
"secret": "",
|
|
644
|
+
"is_active": false,
|
|
645
|
+
"config_type": "",
|
|
646
|
+
"aggregator": "rupifi",
|
|
647
|
+
"display": {
|
|
648
|
+
"link": "",
|
|
649
|
+
"text": "Submitted request to be reviewed before going live. Please contact us for any further query.",
|
|
650
|
+
"description": "Rupifi enables businesses to avail credits and allows a 'Buy now, Pay later' system for making transactions and purchases."
|
|
651
|
+
},
|
|
652
|
+
"logo": "https://hdn-1.fynd.com/payment/Rupifi.png"
|
|
653
|
+
},
|
|
654
|
+
{
|
|
655
|
+
"key": "12345",
|
|
656
|
+
"secret": "12345",
|
|
657
|
+
"is_active": false,
|
|
658
|
+
"config_type": "",
|
|
659
|
+
"aggregator": "simpl",
|
|
660
|
+
"display": {
|
|
661
|
+
"link": "",
|
|
662
|
+
"text": "Review in under process. Please wait while process completed or contact us for any further query.",
|
|
663
|
+
"description": "Simpl is a Pay Later payment method.",
|
|
664
|
+
"reviewed": false
|
|
665
|
+
},
|
|
666
|
+
"logo": "https://hdn-1.fynd.com/payment/simpl-pg-logo.jpg"
|
|
667
|
+
},
|
|
668
|
+
{
|
|
669
|
+
"key": "",
|
|
670
|
+
"secret": "",
|
|
671
|
+
"is_active": false,
|
|
672
|
+
"product_id": "",
|
|
673
|
+
"config_type": "",
|
|
674
|
+
"webhook_secret": "",
|
|
675
|
+
"aggregator": "stripe",
|
|
676
|
+
"display": {
|
|
677
|
+
"link": "",
|
|
678
|
+
"text": "Submitted request to be reviewed before going live. Please contact us for any further query.",
|
|
679
|
+
"description": "Stripe is a payment processor that supports online payments, credit cards, recurring subscriptions and direct payouts to bank accounts."
|
|
680
|
+
},
|
|
681
|
+
"logo": "https://hdn-1.fynd.com/payment/Stripe.png"
|
|
682
|
+
}
|
|
683
|
+
]
|
|
684
|
+
}
|
|
685
|
+
```
|
|
686
|
+
</details>
|
|
687
|
+
|
|
688
|
+
|
|
689
|
+
|
|
690
|
+
|
|
691
|
+
|
|
692
|
+
|
|
693
|
+
|
|
694
|
+
|
|
695
|
+
|
|
696
|
+
---
|
|
697
|
+
|
|
698
|
+
|
|
699
|
+
### getPaymentModeRoutes
|
|
700
|
+
Get All Valid Payment Options
|
|
701
|
+
|
|
702
|
+
|
|
703
|
+
|
|
704
|
+
```javascript
|
|
705
|
+
// Promise
|
|
706
|
+
const promise = client.application("<APPLICATION_ID>").payment.getPaymentModeRoutes({ refresh : value,
|
|
707
|
+
requestType : value });
|
|
708
|
+
|
|
709
|
+
// Async/Await
|
|
710
|
+
const data = await client.application("<APPLICATION_ID>").payment.getPaymentModeRoutes({ refresh : value,
|
|
711
|
+
requestType : value });
|
|
712
|
+
```
|
|
713
|
+
|
|
714
|
+
|
|
715
|
+
|
|
716
|
+
|
|
717
|
+
|
|
718
|
+
| Argument | Type | Required | Description |
|
|
719
|
+
| --------- | ----- | -------- | ----------- |
|
|
720
|
+
| refresh | boolean | yes | |
|
|
721
|
+
| requestType | string | yes | |
|
|
722
|
+
|
|
723
|
+
|
|
724
|
+
|
|
725
|
+
Use this API to get Get All Valid Payment Options for making payment
|
|
726
|
+
|
|
727
|
+
*Returned Response:*
|
|
728
|
+
|
|
729
|
+
|
|
730
|
+
|
|
731
|
+
|
|
732
|
+
[PaymentOptionsResponse](#PaymentOptionsResponse)
|
|
733
|
+
|
|
734
|
+
Success
|
|
735
|
+
|
|
736
|
+
|
|
737
|
+
|
|
738
|
+
|
|
739
|
+
<details>
|
|
740
|
+
<summary><i> Example:</i></summary>
|
|
741
|
+
|
|
742
|
+
```json
|
|
743
|
+
{
|
|
744
|
+
"success": true,
|
|
745
|
+
"payment_options": {
|
|
746
|
+
"payment_option": [
|
|
747
|
+
{
|
|
748
|
+
"name": "CARD",
|
|
749
|
+
"display_priority": 2,
|
|
750
|
+
"payment_mode_id": 2,
|
|
751
|
+
"display_name": "Card",
|
|
752
|
+
"list": [],
|
|
753
|
+
"anonymous_enable": true,
|
|
754
|
+
"aggregator_name": "Razorpay",
|
|
755
|
+
"add_card_enabled": false,
|
|
756
|
+
"save_card": true,
|
|
757
|
+
"types": [],
|
|
758
|
+
"networks": [],
|
|
759
|
+
"banks": []
|
|
760
|
+
},
|
|
761
|
+
{
|
|
762
|
+
"name": "NB",
|
|
763
|
+
"display_priority": 3,
|
|
764
|
+
"payment_mode_id": 3,
|
|
765
|
+
"display_name": "Net Banking",
|
|
766
|
+
"list": [
|
|
767
|
+
{
|
|
768
|
+
"aggregator_name": "Razorpay",
|
|
769
|
+
"name": "ICICI Bank",
|
|
770
|
+
"code": "ICIC",
|
|
771
|
+
"bank_name": "ICICI Bank",
|
|
401
772
|
"bank_code": "ICIC",
|
|
402
773
|
"url": "https://hdn-1.fynd.com/payment/NB_ICICI.png",
|
|
403
774
|
"logo_url": {
|
|
@@ -1490,364 +1861,38 @@ Success
|
|
|
1490
1861
|
}
|
|
1491
1862
|
]
|
|
1492
1863
|
},
|
|
1493
|
-
{
|
|
1494
|
-
"name": "PL",
|
|
1495
|
-
"display_priority": 21,
|
|
1496
|
-
"display_name": "Pay Later",
|
|
1497
|
-
"list": [
|
|
1498
|
-
{
|
|
1499
|
-
"aggregator_name": "Simpl",
|
|
1500
|
-
"name": "Simpl",
|
|
1501
|
-
"display_name": "Simpl",
|
|
1502
|
-
"code": "SIMPL",
|
|
1503
|
-
"merchant_code": "SIMPL",
|
|
1504
|
-
"logo": "https://hdn-1.fynd.com/payment/simpl_logo.png",
|
|
1505
|
-
"logo_url": {
|
|
1506
|
-
"small": "https://hdn-1.fynd.com/payment/simpl_logo.png",
|
|
1507
|
-
"large": "https://hdn-1.fynd.com/payment/simpl_logo.png"
|
|
1508
|
-
}
|
|
1509
|
-
},
|
|
1510
|
-
{
|
|
1511
|
-
"aggregator_name": "Rupifi",
|
|
1512
|
-
"name": "RUPIFIPG",
|
|
1513
|
-
"display_name": "Pay using Rupifi",
|
|
1514
|
-
"code": "RUPIFIPG",
|
|
1515
|
-
"logo_url": {
|
|
1516
|
-
"large": "https://hdn-1.fynd.com/payment/Rupifi.png",
|
|
1517
|
-
"small": "https://hdn-1.fynd.com/payment/Rupifi.png"
|
|
1518
|
-
},
|
|
1519
|
-
"merchant_code": "RUPIFIPG"
|
|
1520
|
-
}
|
|
1521
|
-
]
|
|
1522
|
-
}
|
|
1523
|
-
]
|
|
1524
|
-
}
|
|
1525
|
-
}
|
|
1526
|
-
```
|
|
1527
|
-
</details>
|
|
1528
|
-
|
|
1529
|
-
|
|
1530
|
-
|
|
1531
|
-
|
|
1532
|
-
|
|
1533
|
-
|
|
1534
|
-
|
|
1535
|
-
|
|
1536
|
-
|
|
1537
|
-
---
|
|
1538
|
-
|
|
1539
|
-
|
|
1540
|
-
### getAllPayouts
|
|
1541
|
-
Get All Payouts
|
|
1542
|
-
|
|
1543
|
-
|
|
1544
|
-
|
|
1545
|
-
```javascript
|
|
1546
|
-
// Promise
|
|
1547
|
-
const promise = client.payment.getAllPayouts({ uniqueExternalId : value });
|
|
1548
|
-
|
|
1549
|
-
// Async/Await
|
|
1550
|
-
const data = await client.payment.getAllPayouts({ uniqueExternalId : value });
|
|
1551
|
-
```
|
|
1552
|
-
|
|
1553
|
-
|
|
1554
|
-
|
|
1555
|
-
|
|
1556
|
-
|
|
1557
|
-
| Argument | Type | Required | Description |
|
|
1558
|
-
| --------- | ----- | -------- | ----------- |
|
|
1559
|
-
| uniqueExternalId | string | no | Fetch payouts using unique external id |
|
|
1560
|
-
|
|
1561
|
-
|
|
1562
|
-
|
|
1563
|
-
Get All Payouts
|
|
1564
|
-
|
|
1565
|
-
*Returned Response:*
|
|
1566
|
-
|
|
1567
|
-
|
|
1568
|
-
|
|
1569
|
-
|
|
1570
|
-
[PayoutsResponse](#PayoutsResponse)
|
|
1571
|
-
|
|
1572
|
-
payouts response object
|
|
1573
|
-
|
|
1574
|
-
|
|
1575
|
-
|
|
1576
|
-
|
|
1577
|
-
<details>
|
|
1578
|
-
<summary><i> Example:</i></summary>
|
|
1579
|
-
|
|
1580
|
-
```json
|
|
1581
|
-
[
|
|
1582
|
-
{
|
|
1583
|
-
"unique_transfer_no": "d2ff79fcd3459831864824da8c9d7e5f",
|
|
1584
|
-
"more_attributes": {
|
|
1585
|
-
"city": "",
|
|
1586
|
-
"state": "",
|
|
1587
|
-
"country": "",
|
|
1588
|
-
"bank_name": "YES",
|
|
1589
|
-
"ifsc_code": "IFSCYES101",
|
|
1590
|
-
"account_no": "9876541234",
|
|
1591
|
-
"branch_name": "Mumbai",
|
|
1592
|
-
"account_type": "current",
|
|
1593
|
-
"account_holder": "Vikas Kumar"
|
|
1594
|
-
},
|
|
1595
|
-
"transfer_type": "bank",
|
|
1596
|
-
"is_default": true,
|
|
1597
|
-
"is_active": true,
|
|
1598
|
-
"customers": {
|
|
1599
|
-
"id": 2,
|
|
1600
|
-
"name": "reliance retail",
|
|
1601
|
-
"mobile": "1234567890",
|
|
1602
|
-
"email": "reliance@gmail.com",
|
|
1603
|
-
"unique_external_id": "company:1"
|
|
1604
|
-
},
|
|
1605
|
-
"payouts_aggregators": [
|
|
1606
|
-
{
|
|
1607
|
-
"payout_details_id": 888,
|
|
1608
|
-
"aggregator_id": 3,
|
|
1609
|
-
"aggregator_fund_id": null
|
|
1610
|
-
}
|
|
1611
|
-
]
|
|
1612
|
-
},
|
|
1613
|
-
{
|
|
1614
|
-
"unique_transfer_no": "e388c1c5df4933fa01f6da9f92595589",
|
|
1615
|
-
"more_attributes": {
|
|
1616
|
-
"city": "",
|
|
1617
|
-
"state": "",
|
|
1618
|
-
"country": "",
|
|
1619
|
-
"bank_name": "SBI",
|
|
1620
|
-
"ifsc_code": "SBIN0011513",
|
|
1621
|
-
"account_no": "9876543210",
|
|
1622
|
-
"branch_name": "Mumbai",
|
|
1623
|
-
"account_type": "saving",
|
|
1624
|
-
"account_holder": "Vikas Kumar"
|
|
1625
|
-
},
|
|
1626
|
-
"transfer_type": "bank",
|
|
1627
|
-
"is_default": false,
|
|
1628
|
-
"is_active": true,
|
|
1629
|
-
"customers": {
|
|
1630
|
-
"id": 2,
|
|
1631
|
-
"name": "reliance retail",
|
|
1632
|
-
"mobile": "1234567890",
|
|
1633
|
-
"email": "reliance@gmail.com",
|
|
1634
|
-
"unique_external_id": "company:1"
|
|
1635
|
-
},
|
|
1636
|
-
"payouts_aggregators": [
|
|
1637
|
-
{
|
|
1638
|
-
"payout_details_id": 891,
|
|
1639
|
-
"aggregator_id": 3,
|
|
1640
|
-
"aggregator_fund_id": null
|
|
1864
|
+
{
|
|
1865
|
+
"name": "PL",
|
|
1866
|
+
"display_priority": 21,
|
|
1867
|
+
"display_name": "Pay Later",
|
|
1868
|
+
"list": [
|
|
1869
|
+
{
|
|
1870
|
+
"aggregator_name": "Simpl",
|
|
1871
|
+
"name": "Simpl",
|
|
1872
|
+
"display_name": "Simpl",
|
|
1873
|
+
"code": "SIMPL",
|
|
1874
|
+
"merchant_code": "SIMPL",
|
|
1875
|
+
"logo": "https://hdn-1.fynd.com/payment/simpl_logo.png",
|
|
1876
|
+
"logo_url": {
|
|
1877
|
+
"small": "https://hdn-1.fynd.com/payment/simpl_logo.png",
|
|
1878
|
+
"large": "https://hdn-1.fynd.com/payment/simpl_logo.png"
|
|
1879
|
+
}
|
|
1880
|
+
},
|
|
1881
|
+
{
|
|
1882
|
+
"aggregator_name": "Rupifi",
|
|
1883
|
+
"name": "RUPIFIPG",
|
|
1884
|
+
"display_name": "Pay using Rupifi",
|
|
1885
|
+
"code": "RUPIFIPG",
|
|
1886
|
+
"logo_url": {
|
|
1887
|
+
"large": "https://hdn-1.fynd.com/payment/Rupifi.png",
|
|
1888
|
+
"small": "https://hdn-1.fynd.com/payment/Rupifi.png"
|
|
1889
|
+
},
|
|
1890
|
+
"merchant_code": "RUPIFIPG"
|
|
1891
|
+
}
|
|
1892
|
+
]
|
|
1641
1893
|
}
|
|
1642
1894
|
]
|
|
1643
1895
|
}
|
|
1644
|
-
]
|
|
1645
|
-
```
|
|
1646
|
-
</details>
|
|
1647
|
-
|
|
1648
|
-
|
|
1649
|
-
|
|
1650
|
-
|
|
1651
|
-
|
|
1652
|
-
|
|
1653
|
-
|
|
1654
|
-
|
|
1655
|
-
|
|
1656
|
-
---
|
|
1657
|
-
|
|
1658
|
-
|
|
1659
|
-
### savePayout
|
|
1660
|
-
Save Payout
|
|
1661
|
-
|
|
1662
|
-
|
|
1663
|
-
|
|
1664
|
-
```javascript
|
|
1665
|
-
// Promise
|
|
1666
|
-
const promise = client.payment.savePayout({ body : value });
|
|
1667
|
-
|
|
1668
|
-
// Async/Await
|
|
1669
|
-
const data = await client.payment.savePayout({ body : value });
|
|
1670
|
-
```
|
|
1671
|
-
|
|
1672
|
-
|
|
1673
|
-
|
|
1674
|
-
|
|
1675
|
-
|
|
1676
|
-
| Argument | Type | Required | Description |
|
|
1677
|
-
| --------- | ----- | -------- | ----------- |
|
|
1678
|
-
| body | [PayoutRequest](#PayoutRequest) | yes | Request body |
|
|
1679
|
-
|
|
1680
|
-
|
|
1681
|
-
Save Payout
|
|
1682
|
-
|
|
1683
|
-
*Returned Response:*
|
|
1684
|
-
|
|
1685
|
-
|
|
1686
|
-
|
|
1687
|
-
|
|
1688
|
-
[PayoutResponse](#PayoutResponse)
|
|
1689
|
-
|
|
1690
|
-
save payout response object
|
|
1691
|
-
|
|
1692
|
-
|
|
1693
|
-
|
|
1694
|
-
|
|
1695
|
-
<details>
|
|
1696
|
-
<summary><i> Example:</i></summary>
|
|
1697
|
-
|
|
1698
|
-
```json
|
|
1699
|
-
{
|
|
1700
|
-
"success": true,
|
|
1701
|
-
"is_active": true,
|
|
1702
|
-
"bank_details": {
|
|
1703
|
-
"account_type": "saving",
|
|
1704
|
-
"account_holder": "Vikas Kumar",
|
|
1705
|
-
"branch_name": "Mumbai",
|
|
1706
|
-
"country": "",
|
|
1707
|
-
"ifsc_code": "SBIN0011513",
|
|
1708
|
-
"account_no": "9876543210",
|
|
1709
|
-
"city": "",
|
|
1710
|
-
"state": "",
|
|
1711
|
-
"bank_name": "SBI"
|
|
1712
|
-
},
|
|
1713
|
-
"unique_transfer_no": "e388c1c5df4933fa01f6da9f92595589",
|
|
1714
|
-
"users": {
|
|
1715
|
-
"name": "reliance retail",
|
|
1716
|
-
"unique_external_id": "company:1",
|
|
1717
|
-
"mobile": "1234567890",
|
|
1718
|
-
"email": "reliance@gmail.com"
|
|
1719
|
-
},
|
|
1720
|
-
"aggregator": "Razorpay",
|
|
1721
|
-
"transfer_type": "bank",
|
|
1722
|
-
"created": true,
|
|
1723
|
-
"payouts": {
|
|
1724
|
-
"aggregator_fund_id": null
|
|
1725
|
-
},
|
|
1726
|
-
"payment_status": "payout_initiated"
|
|
1727
|
-
}
|
|
1728
|
-
```
|
|
1729
|
-
</details>
|
|
1730
|
-
|
|
1731
|
-
|
|
1732
|
-
|
|
1733
|
-
|
|
1734
|
-
|
|
1735
|
-
|
|
1736
|
-
|
|
1737
|
-
|
|
1738
|
-
|
|
1739
|
-
---
|
|
1740
|
-
|
|
1741
|
-
|
|
1742
|
-
### updatePayout
|
|
1743
|
-
Update Payout
|
|
1744
|
-
|
|
1745
|
-
|
|
1746
|
-
|
|
1747
|
-
```javascript
|
|
1748
|
-
// Promise
|
|
1749
|
-
const promise = client.payment.updatePayout({ uniqueTransferNo : value,
|
|
1750
|
-
body : value });
|
|
1751
|
-
|
|
1752
|
-
// Async/Await
|
|
1753
|
-
const data = await client.payment.updatePayout({ uniqueTransferNo : value,
|
|
1754
|
-
body : value });
|
|
1755
|
-
```
|
|
1756
|
-
|
|
1757
|
-
|
|
1758
|
-
|
|
1759
|
-
|
|
1760
|
-
|
|
1761
|
-
| Argument | Type | Required | Description |
|
|
1762
|
-
| --------- | ----- | -------- | ----------- |
|
|
1763
|
-
| uniqueTransferNo | string | yes | Unique transfer id |
|
|
1764
|
-
| body | [PayoutRequest](#PayoutRequest) | yes | Request body |
|
|
1765
|
-
|
|
1766
|
-
|
|
1767
|
-
Update Payout
|
|
1768
|
-
|
|
1769
|
-
*Returned Response:*
|
|
1770
|
-
|
|
1771
|
-
|
|
1772
|
-
|
|
1773
|
-
|
|
1774
|
-
[UpdatePayoutResponse](#UpdatePayoutResponse)
|
|
1775
|
-
|
|
1776
|
-
save payout response object
|
|
1777
|
-
|
|
1778
|
-
|
|
1779
|
-
|
|
1780
|
-
|
|
1781
|
-
<details>
|
|
1782
|
-
<summary><i> Example:</i></summary>
|
|
1783
|
-
|
|
1784
|
-
```json
|
|
1785
|
-
{
|
|
1786
|
-
"success": true,
|
|
1787
|
-
"is_default": true,
|
|
1788
|
-
"is_active": true
|
|
1789
|
-
}
|
|
1790
|
-
```
|
|
1791
|
-
</details>
|
|
1792
|
-
|
|
1793
|
-
|
|
1794
|
-
|
|
1795
|
-
|
|
1796
|
-
|
|
1797
|
-
|
|
1798
|
-
|
|
1799
|
-
|
|
1800
|
-
|
|
1801
|
-
---
|
|
1802
|
-
|
|
1803
|
-
|
|
1804
|
-
### activateAndDectivatePayout
|
|
1805
|
-
Partial Update Payout
|
|
1806
|
-
|
|
1807
|
-
|
|
1808
|
-
|
|
1809
|
-
```javascript
|
|
1810
|
-
// Promise
|
|
1811
|
-
const promise = client.payment.activateAndDectivatePayout({ uniqueTransferNo : value,
|
|
1812
|
-
body : value });
|
|
1813
|
-
|
|
1814
|
-
// Async/Await
|
|
1815
|
-
const data = await client.payment.activateAndDectivatePayout({ uniqueTransferNo : value,
|
|
1816
|
-
body : value });
|
|
1817
|
-
```
|
|
1818
|
-
|
|
1819
|
-
|
|
1820
|
-
|
|
1821
|
-
|
|
1822
|
-
|
|
1823
|
-
| Argument | Type | Required | Description |
|
|
1824
|
-
| --------- | ----- | -------- | ----------- |
|
|
1825
|
-
| uniqueTransferNo | string | yes | Unique transfer id |
|
|
1826
|
-
| body | [UpdatePayoutRequest](#UpdatePayoutRequest) | yes | Request body |
|
|
1827
|
-
|
|
1828
|
-
|
|
1829
|
-
Partial Update Payout
|
|
1830
|
-
|
|
1831
|
-
*Returned Response:*
|
|
1832
|
-
|
|
1833
|
-
|
|
1834
|
-
|
|
1835
|
-
|
|
1836
|
-
[UpdatePayoutResponse](#UpdatePayoutResponse)
|
|
1837
|
-
|
|
1838
|
-
save payout response object
|
|
1839
|
-
|
|
1840
|
-
|
|
1841
|
-
|
|
1842
|
-
|
|
1843
|
-
<details>
|
|
1844
|
-
<summary><i> Example:</i></summary>
|
|
1845
|
-
|
|
1846
|
-
```json
|
|
1847
|
-
{
|
|
1848
|
-
"success": true,
|
|
1849
|
-
"is_default": true,
|
|
1850
|
-
"is_active": true
|
|
1851
1896
|
}
|
|
1852
1897
|
```
|
|
1853
1898
|
</details>
|
|
@@ -1863,39 +1908,34 @@ save payout response object
|
|
|
1863
1908
|
---
|
|
1864
1909
|
|
|
1865
1910
|
|
|
1866
|
-
###
|
|
1867
|
-
|
|
1911
|
+
### getSubscriptionConfig
|
|
1912
|
+
List Subscription Config
|
|
1868
1913
|
|
|
1869
1914
|
|
|
1870
1915
|
|
|
1871
1916
|
```javascript
|
|
1872
1917
|
// Promise
|
|
1873
|
-
const promise = client.payment.
|
|
1918
|
+
const promise = client.payment.getSubscriptionConfig();
|
|
1874
1919
|
|
|
1875
1920
|
// Async/Await
|
|
1876
|
-
const data = await client.payment.
|
|
1921
|
+
const data = await client.payment.getSubscriptionConfig();
|
|
1877
1922
|
```
|
|
1878
1923
|
|
|
1879
1924
|
|
|
1880
1925
|
|
|
1881
1926
|
|
|
1882
1927
|
|
|
1883
|
-
| Argument | Type | Required | Description |
|
|
1884
|
-
| --------- | ----- | -------- | ----------- |
|
|
1885
|
-
| uniqueTransferNo | string | yes | Unique transfer id |
|
|
1886
|
-
|
|
1887
|
-
|
|
1888
1928
|
|
|
1889
|
-
|
|
1929
|
+
Get all Subscription Config details
|
|
1890
1930
|
|
|
1891
1931
|
*Returned Response:*
|
|
1892
1932
|
|
|
1893
1933
|
|
|
1894
1934
|
|
|
1895
1935
|
|
|
1896
|
-
[
|
|
1936
|
+
[SubscriptionConfigResponse](#SubscriptionConfigResponse)
|
|
1897
1937
|
|
|
1898
|
-
|
|
1938
|
+
List Subscription Config Response
|
|
1899
1939
|
|
|
1900
1940
|
|
|
1901
1941
|
|
|
@@ -1905,7 +1945,11 @@ delete payout response object
|
|
|
1905
1945
|
|
|
1906
1946
|
```json
|
|
1907
1947
|
{
|
|
1908
|
-
"success": true
|
|
1948
|
+
"success": true,
|
|
1949
|
+
"aggregator": "stripe",
|
|
1950
|
+
"config": {
|
|
1951
|
+
"public_key": "pk_test_lHBf12TZLa5"
|
|
1952
|
+
}
|
|
1909
1953
|
}
|
|
1910
1954
|
```
|
|
1911
1955
|
</details>
|
|
@@ -2105,19 +2149,17 @@ List Subscription Payment Method Response
|
|
|
2105
2149
|
---
|
|
2106
2150
|
|
|
2107
2151
|
|
|
2108
|
-
###
|
|
2109
|
-
|
|
2152
|
+
### getUserBeneficiaries
|
|
2153
|
+
List User Beneficiary
|
|
2110
2154
|
|
|
2111
2155
|
|
|
2112
2156
|
|
|
2113
2157
|
```javascript
|
|
2114
2158
|
// Promise
|
|
2115
|
-
const promise = client.payment.
|
|
2116
|
-
paymentMethodId : value });
|
|
2159
|
+
const promise = client.application("<APPLICATION_ID>").payment.getUserBeneficiaries({ orderId : value });
|
|
2117
2160
|
|
|
2118
2161
|
// Async/Await
|
|
2119
|
-
const data = await client.payment.
|
|
2120
|
-
paymentMethodId : value });
|
|
2162
|
+
const data = await client.application("<APPLICATION_ID>").payment.getUserBeneficiaries({ orderId : value });
|
|
2121
2163
|
```
|
|
2122
2164
|
|
|
2123
2165
|
|
|
@@ -2126,74 +2168,20 @@ const data = await client.payment.deleteSubscriptionPaymentMethod({ uniqueExter
|
|
|
2126
2168
|
|
|
2127
2169
|
| Argument | Type | Required | Description |
|
|
2128
2170
|
| --------- | ----- | -------- | ----------- |
|
|
2129
|
-
|
|
|
2130
|
-
| paymentMethodId | string | yes | |
|
|
2131
|
-
|
|
2132
|
-
|
|
2133
|
-
|
|
2134
|
-
Uses this api to Delete Subscription Payment Method
|
|
2135
|
-
|
|
2136
|
-
*Returned Response:*
|
|
2137
|
-
|
|
2138
|
-
|
|
2139
|
-
|
|
2140
|
-
|
|
2141
|
-
[DeleteSubscriptionPaymentMethodResponse](#DeleteSubscriptionPaymentMethodResponse)
|
|
2142
|
-
|
|
2143
|
-
Delete Subscription Payment Method Response.
|
|
2144
|
-
|
|
2145
|
-
|
|
2146
|
-
|
|
2147
|
-
|
|
2148
|
-
<details>
|
|
2149
|
-
<summary><i> Example:</i></summary>
|
|
2150
|
-
|
|
2151
|
-
```json
|
|
2152
|
-
{
|
|
2153
|
-
"success": true
|
|
2154
|
-
}
|
|
2155
|
-
```
|
|
2156
|
-
</details>
|
|
2157
|
-
|
|
2158
|
-
|
|
2159
|
-
|
|
2160
|
-
|
|
2161
|
-
|
|
2162
|
-
|
|
2163
|
-
|
|
2164
|
-
|
|
2165
|
-
|
|
2166
|
-
---
|
|
2167
|
-
|
|
2168
|
-
|
|
2169
|
-
### getSubscriptionConfig
|
|
2170
|
-
List Subscription Config
|
|
2171
|
-
|
|
2172
|
-
|
|
2173
|
-
|
|
2174
|
-
```javascript
|
|
2175
|
-
// Promise
|
|
2176
|
-
const promise = client.payment.getSubscriptionConfig();
|
|
2177
|
-
|
|
2178
|
-
// Async/Await
|
|
2179
|
-
const data = await client.payment.getSubscriptionConfig();
|
|
2180
|
-
```
|
|
2181
|
-
|
|
2182
|
-
|
|
2183
|
-
|
|
2171
|
+
| orderId | string | yes | |
|
|
2184
2172
|
|
|
2185
2173
|
|
|
2186
2174
|
|
|
2187
|
-
Get all
|
|
2175
|
+
Get all active beneficiary details added by the user for refund
|
|
2188
2176
|
|
|
2189
2177
|
*Returned Response:*
|
|
2190
2178
|
|
|
2191
2179
|
|
|
2192
2180
|
|
|
2193
2181
|
|
|
2194
|
-
[
|
|
2182
|
+
[OrderBeneficiaryResponse](#OrderBeneficiaryResponse)
|
|
2195
2183
|
|
|
2196
|
-
List
|
|
2184
|
+
List User Beneficiary
|
|
2197
2185
|
|
|
2198
2186
|
|
|
2199
2187
|
|
|
@@ -2203,11 +2191,30 @@ List Subscription Config Response
|
|
|
2203
2191
|
|
|
2204
2192
|
```json
|
|
2205
2193
|
{
|
|
2206
|
-
"
|
|
2207
|
-
|
|
2208
|
-
|
|
2209
|
-
|
|
2210
|
-
|
|
2194
|
+
"beneficiaries": [
|
|
2195
|
+
{
|
|
2196
|
+
"id": 221,
|
|
2197
|
+
"beneficiary_id": "0f7e44a922df352c05c5f73cb40ba115",
|
|
2198
|
+
"bank_name": "State Bank of India",
|
|
2199
|
+
"branch_name": "State Bank of India",
|
|
2200
|
+
"account_holder": "SHASHI TEST",
|
|
2201
|
+
"account_no": "1234567891",
|
|
2202
|
+
"ifsc_code": "SBIN0005611",
|
|
2203
|
+
"mobile": "9112042174",
|
|
2204
|
+
"email": "payment@gofynd.com",
|
|
2205
|
+
"address": "204A",
|
|
2206
|
+
"comment": "",
|
|
2207
|
+
"is_active": null,
|
|
2208
|
+
"created_on": "2020-06-29 12:38:39",
|
|
2209
|
+
"modified_on": "2020-06-29 12:38:39",
|
|
2210
|
+
"display_name": "BANK",
|
|
2211
|
+
"transfer_mode": "bank",
|
|
2212
|
+
"title": "Bank Account",
|
|
2213
|
+
"subtitle": "1234567891",
|
|
2214
|
+
"delights_user_name": null
|
|
2215
|
+
}
|
|
2216
|
+
],
|
|
2217
|
+
"show_beneficiary_details": false
|
|
2211
2218
|
}
|
|
2212
2219
|
```
|
|
2213
2220
|
</details>
|
|
@@ -2223,17 +2230,19 @@ List Subscription Config Response
|
|
|
2223
2230
|
---
|
|
2224
2231
|
|
|
2225
2232
|
|
|
2226
|
-
###
|
|
2227
|
-
|
|
2233
|
+
### getUserCODlimitRoutes
|
|
2234
|
+
Get COD limit for user
|
|
2228
2235
|
|
|
2229
2236
|
|
|
2230
2237
|
|
|
2231
2238
|
```javascript
|
|
2232
2239
|
// Promise
|
|
2233
|
-
const promise = client.payment.
|
|
2240
|
+
const promise = client.application("<APPLICATION_ID>").payment.getUserCODlimitRoutes({ merchantUserId : value,
|
|
2241
|
+
mobileNo : value });
|
|
2234
2242
|
|
|
2235
2243
|
// Async/Await
|
|
2236
|
-
const data = await client.payment.
|
|
2244
|
+
const data = await client.application("<APPLICATION_ID>").payment.getUserCODlimitRoutes({ merchantUserId : value,
|
|
2245
|
+
mobileNo : value });
|
|
2237
2246
|
```
|
|
2238
2247
|
|
|
2239
2248
|
|
|
@@ -2241,20 +2250,22 @@ const data = await client.payment.saveSubscriptionSetupIntent({ body : value })
|
|
|
2241
2250
|
|
|
2242
2251
|
|
|
2243
2252
|
| Argument | Type | Required | Description |
|
|
2244
|
-
| --------- | ----- | -------- | ----------- |
|
|
2245
|
-
|
|
|
2253
|
+
| --------- | ----- | -------- | ----------- |
|
|
2254
|
+
| merchantUserId | string | yes | |
|
|
2255
|
+
| mobileNo | string | yes | |
|
|
2246
2256
|
|
|
2247
2257
|
|
|
2248
|
-
|
|
2258
|
+
|
|
2259
|
+
Use this API to get user cod limit and reamining limit for the payment
|
|
2249
2260
|
|
|
2250
2261
|
*Returned Response:*
|
|
2251
2262
|
|
|
2252
2263
|
|
|
2253
2264
|
|
|
2254
2265
|
|
|
2255
|
-
[
|
|
2266
|
+
[GetUserCODLimitResponse](#GetUserCODLimitResponse)
|
|
2256
2267
|
|
|
2257
|
-
|
|
2268
|
+
Success. Returns user cod limit , remaining limit and usage of user for COD. Check the example shown below or refer `GetUserCODLimitResponseSchema` for more details.
|
|
2258
2269
|
|
|
2259
2270
|
|
|
2260
2271
|
|
|
@@ -2265,12 +2276,13 @@ Save Subscription Setup Intent Response.
|
|
|
2265
2276
|
```json
|
|
2266
2277
|
{
|
|
2267
2278
|
"success": true,
|
|
2268
|
-
"
|
|
2269
|
-
"
|
|
2270
|
-
"
|
|
2271
|
-
"
|
|
2272
|
-
"
|
|
2273
|
-
"
|
|
2279
|
+
"user_cod_data": {
|
|
2280
|
+
"is_active": true,
|
|
2281
|
+
"user_id": 5,
|
|
2282
|
+
"usages": 1000,
|
|
2283
|
+
"limit": 10000,
|
|
2284
|
+
"remaining_limit": 9000,
|
|
2285
|
+
"merchant_user_id": "5e199e6998cfe1776f1385dc"
|
|
2274
2286
|
}
|
|
2275
2287
|
}
|
|
2276
2288
|
```
|
|
@@ -2287,19 +2299,17 @@ Save Subscription Setup Intent Response.
|
|
|
2287
2299
|
---
|
|
2288
2300
|
|
|
2289
2301
|
|
|
2290
|
-
###
|
|
2291
|
-
|
|
2302
|
+
### getUserOrderBeneficiaries
|
|
2303
|
+
List Order Beneficiary
|
|
2292
2304
|
|
|
2293
2305
|
|
|
2294
2306
|
|
|
2295
2307
|
```javascript
|
|
2296
2308
|
// Promise
|
|
2297
|
-
const promise = client.application("<APPLICATION_ID>").payment.
|
|
2298
|
-
requestHash : value });
|
|
2309
|
+
const promise = client.application("<APPLICATION_ID>").payment.getUserOrderBeneficiaries({ orderId : value });
|
|
2299
2310
|
|
|
2300
2311
|
// Async/Await
|
|
2301
|
-
const data = await client.application("<APPLICATION_ID>").payment.
|
|
2302
|
-
requestHash : value });
|
|
2312
|
+
const data = await client.application("<APPLICATION_ID>").payment.getUserOrderBeneficiaries({ orderId : value });
|
|
2303
2313
|
```
|
|
2304
2314
|
|
|
2305
2315
|
|
|
@@ -2308,21 +2318,20 @@ const data = await client.application("<APPLICATION_ID>").payment.getBankAccount
|
|
|
2308
2318
|
|
|
2309
2319
|
| Argument | Type | Required | Description |
|
|
2310
2320
|
| --------- | ----- | -------- | ----------- |
|
|
2311
|
-
| orderId | string | yes | |
|
|
2312
|
-
| requestHash | string | no | |
|
|
2321
|
+
| orderId | string | yes | |
|
|
2313
2322
|
|
|
2314
2323
|
|
|
2315
2324
|
|
|
2316
|
-
|
|
2325
|
+
Get all active beneficiary details added by the user for refund
|
|
2317
2326
|
|
|
2318
2327
|
*Returned Response:*
|
|
2319
2328
|
|
|
2320
2329
|
|
|
2321
2330
|
|
|
2322
2331
|
|
|
2323
|
-
[
|
|
2332
|
+
[OrderBeneficiaryResponse](#OrderBeneficiaryResponse)
|
|
2324
2333
|
|
|
2325
|
-
|
|
2334
|
+
List Order Beneficiary
|
|
2326
2335
|
|
|
2327
2336
|
|
|
2328
2337
|
|
|
@@ -2332,18 +2341,29 @@ Success
|
|
|
2332
2341
|
|
|
2333
2342
|
```json
|
|
2334
2343
|
{
|
|
2335
|
-
"
|
|
2336
|
-
|
|
2337
|
-
|
|
2338
|
-
|
|
2339
|
-
|
|
2340
|
-
|
|
2341
|
-
|
|
2342
|
-
|
|
2343
|
-
|
|
2344
|
-
|
|
2345
|
-
|
|
2346
|
-
|
|
2344
|
+
"beneficiaries": [
|
|
2345
|
+
{
|
|
2346
|
+
"id": 3695,
|
|
2347
|
+
"beneficiary_id": "4c86dd56e634a4c6a8fb51d195bc7b83",
|
|
2348
|
+
"bank_name": "State Bank of India",
|
|
2349
|
+
"branch_name": "BHOGAT",
|
|
2350
|
+
"account_holder": "PRAKASH TEST",
|
|
2351
|
+
"account_no": "3566342455454",
|
|
2352
|
+
"ifsc_code": "SBIN0014982",
|
|
2353
|
+
"mobile": "7819064010",
|
|
2354
|
+
"email": "prakashtest@gmail.com",
|
|
2355
|
+
"address": "49A, Dabhi seri, jodhpur, kalyanpur",
|
|
2356
|
+
"comment": "COD Refund",
|
|
2357
|
+
"is_active": null,
|
|
2358
|
+
"created_on": "2021-01-22 11:31:02",
|
|
2359
|
+
"modified_on": "2021-01-22 11:31:02",
|
|
2360
|
+
"display_name": "BANK",
|
|
2361
|
+
"transfer_mode": "bank",
|
|
2362
|
+
"title": "Bank Account",
|
|
2363
|
+
"subtitle": "35663423659",
|
|
2364
|
+
"delights_user_name": "shreeniwas_24x7_gmail_com_45978_16624463"
|
|
2365
|
+
}
|
|
2366
|
+
]
|
|
2347
2367
|
}
|
|
2348
2368
|
```
|
|
2349
2369
|
</details>
|
|
@@ -2359,17 +2379,17 @@ Success
|
|
|
2359
2379
|
---
|
|
2360
2380
|
|
|
2361
2381
|
|
|
2362
|
-
###
|
|
2363
|
-
Save
|
|
2382
|
+
### saveBrandPaymentGatewayConfig
|
|
2383
|
+
Save Config Secret For Brand Payment Gateway
|
|
2364
2384
|
|
|
2365
2385
|
|
|
2366
2386
|
|
|
2367
2387
|
```javascript
|
|
2368
2388
|
// Promise
|
|
2369
|
-
const promise = client.application("<APPLICATION_ID>").payment.
|
|
2389
|
+
const promise = client.application("<APPLICATION_ID>").payment.saveBrandPaymentGatewayConfig({ body : value });
|
|
2370
2390
|
|
|
2371
2391
|
// Async/Await
|
|
2372
|
-
const data = await client.application("<APPLICATION_ID>").payment.
|
|
2392
|
+
const data = await client.application("<APPLICATION_ID>").payment.saveBrandPaymentGatewayConfig({ body : value });
|
|
2373
2393
|
```
|
|
2374
2394
|
|
|
2375
2395
|
|
|
@@ -2378,19 +2398,19 @@ const data = await client.application("<APPLICATION_ID>").payment.addRefundBankA
|
|
|
2378
2398
|
|
|
2379
2399
|
| Argument | Type | Required | Description |
|
|
2380
2400
|
| --------- | ----- | -------- | ----------- |
|
|
2381
|
-
| body | [
|
|
2401
|
+
| body | [PaymentGatewayConfigRequest](#PaymentGatewayConfigRequest) | yes | Request body |
|
|
2382
2402
|
|
|
2383
2403
|
|
|
2384
|
-
|
|
2404
|
+
Save Config Secret For Brand Payment Gateway
|
|
2385
2405
|
|
|
2386
2406
|
*Returned Response:*
|
|
2387
2407
|
|
|
2388
2408
|
|
|
2389
2409
|
|
|
2390
2410
|
|
|
2391
|
-
[
|
|
2411
|
+
[PaymentGatewayToBeReviewed](#PaymentGatewayToBeReviewed)
|
|
2392
2412
|
|
|
2393
|
-
Success
|
|
2413
|
+
Save Config Secret For Brand Payment Gateway Success Response.
|
|
2394
2414
|
|
|
2395
2415
|
|
|
2396
2416
|
|
|
@@ -2401,9 +2421,9 @@ Success
|
|
|
2401
2421
|
```json
|
|
2402
2422
|
{
|
|
2403
2423
|
"success": true,
|
|
2404
|
-
"
|
|
2405
|
-
|
|
2406
|
-
|
|
2424
|
+
"aggregators": [
|
|
2425
|
+
"razorpay"
|
|
2426
|
+
]
|
|
2407
2427
|
}
|
|
2408
2428
|
```
|
|
2409
2429
|
</details>
|
|
@@ -2419,17 +2439,17 @@ Success
|
|
|
2419
2439
|
---
|
|
2420
2440
|
|
|
2421
2441
|
|
|
2422
|
-
###
|
|
2423
|
-
|
|
2442
|
+
### savePayout
|
|
2443
|
+
Save Payout
|
|
2424
2444
|
|
|
2425
2445
|
|
|
2426
2446
|
|
|
2427
2447
|
```javascript
|
|
2428
2448
|
// Promise
|
|
2429
|
-
const promise = client.payment.
|
|
2449
|
+
const promise = client.payment.savePayout({ body : value });
|
|
2430
2450
|
|
|
2431
2451
|
// Async/Await
|
|
2432
|
-
const data = await client.payment.
|
|
2452
|
+
const data = await client.payment.savePayout({ body : value });
|
|
2433
2453
|
```
|
|
2434
2454
|
|
|
2435
2455
|
|
|
@@ -2437,21 +2457,20 @@ const data = await client.payment.verifyIfscCode({ ifscCode : value });
|
|
|
2437
2457
|
|
|
2438
2458
|
|
|
2439
2459
|
| Argument | Type | Required | Description |
|
|
2440
|
-
| --------- | ----- | -------- | ----------- |
|
|
2441
|
-
|
|
|
2442
|
-
|
|
2460
|
+
| --------- | ----- | -------- | ----------- |
|
|
2461
|
+
| body | [PayoutRequest](#PayoutRequest) | yes | Request body |
|
|
2443
2462
|
|
|
2444
2463
|
|
|
2445
|
-
|
|
2464
|
+
Save Payout
|
|
2446
2465
|
|
|
2447
2466
|
*Returned Response:*
|
|
2448
2467
|
|
|
2449
2468
|
|
|
2450
2469
|
|
|
2451
2470
|
|
|
2452
|
-
[
|
|
2471
|
+
[PayoutResponse](#PayoutResponse)
|
|
2453
2472
|
|
|
2454
|
-
|
|
2473
|
+
save payout response object
|
|
2455
2474
|
|
|
2456
2475
|
|
|
2457
2476
|
|
|
@@ -2461,25 +2480,33 @@ Bank details on correct Ifsc Code
|
|
|
2461
2480
|
|
|
2462
2481
|
```json
|
|
2463
2482
|
{
|
|
2464
|
-
"
|
|
2465
|
-
"
|
|
2466
|
-
"
|
|
2467
|
-
|
|
2468
|
-
|
|
2469
|
-
|
|
2470
|
-
|
|
2471
|
-
|
|
2472
|
-
|
|
2473
|
-
|
|
2474
|
-
|
|
2475
|
-
|
|
2476
|
-
|
|
2477
|
-
"
|
|
2478
|
-
"
|
|
2479
|
-
|
|
2480
|
-
|
|
2481
|
-
|
|
2482
|
-
|
|
2483
|
+
"success": true,
|
|
2484
|
+
"is_active": true,
|
|
2485
|
+
"bank_details": {
|
|
2486
|
+
"account_type": "saving",
|
|
2487
|
+
"account_holder": "Vikas Kumar",
|
|
2488
|
+
"branch_name": "Mumbai",
|
|
2489
|
+
"country": "",
|
|
2490
|
+
"ifsc_code": "SBIN0011513",
|
|
2491
|
+
"account_no": "9876543210",
|
|
2492
|
+
"city": "",
|
|
2493
|
+
"state": "",
|
|
2494
|
+
"bank_name": "SBI"
|
|
2495
|
+
},
|
|
2496
|
+
"unique_transfer_no": "e388c1c5df4933fa01f6da9f92595589",
|
|
2497
|
+
"users": {
|
|
2498
|
+
"name": "reliance retail",
|
|
2499
|
+
"unique_external_id": "company:1",
|
|
2500
|
+
"mobile": "1234567890",
|
|
2501
|
+
"email": "reliance@gmail.com"
|
|
2502
|
+
},
|
|
2503
|
+
"aggregator": "Razorpay",
|
|
2504
|
+
"transfer_type": "bank",
|
|
2505
|
+
"created": true,
|
|
2506
|
+
"payouts": {
|
|
2507
|
+
"aggregator_fund_id": null
|
|
2508
|
+
},
|
|
2509
|
+
"payment_status": "payout_initiated"
|
|
2483
2510
|
}
|
|
2484
2511
|
```
|
|
2485
2512
|
</details>
|
|
@@ -2495,17 +2522,17 @@ Bank details on correct Ifsc Code
|
|
|
2495
2522
|
---
|
|
2496
2523
|
|
|
2497
2524
|
|
|
2498
|
-
###
|
|
2499
|
-
|
|
2525
|
+
### saveSubscriptionSetupIntent
|
|
2526
|
+
Save Subscription Setup Intent
|
|
2500
2527
|
|
|
2501
2528
|
|
|
2502
2529
|
|
|
2503
2530
|
```javascript
|
|
2504
2531
|
// Promise
|
|
2505
|
-
const promise = client.
|
|
2532
|
+
const promise = client.payment.saveSubscriptionSetupIntent({ body : value });
|
|
2506
2533
|
|
|
2507
2534
|
// Async/Await
|
|
2508
|
-
const data = await client.
|
|
2535
|
+
const data = await client.payment.saveSubscriptionSetupIntent({ body : value });
|
|
2509
2536
|
```
|
|
2510
2537
|
|
|
2511
2538
|
|
|
@@ -2513,21 +2540,20 @@ const data = await client.application("<APPLICATION_ID>").payment.getUserOrderBe
|
|
|
2513
2540
|
|
|
2514
2541
|
|
|
2515
2542
|
| Argument | Type | Required | Description |
|
|
2516
|
-
| --------- | ----- | -------- | ----------- |
|
|
2517
|
-
|
|
|
2518
|
-
|
|
2543
|
+
| --------- | ----- | -------- | ----------- |
|
|
2544
|
+
| body | [SaveSubscriptionSetupIntentRequest](#SaveSubscriptionSetupIntentRequest) | yes | Request body |
|
|
2519
2545
|
|
|
2520
2546
|
|
|
2521
|
-
|
|
2547
|
+
Uses this api to Save Subscription Setup Intent
|
|
2522
2548
|
|
|
2523
2549
|
*Returned Response:*
|
|
2524
2550
|
|
|
2525
2551
|
|
|
2526
2552
|
|
|
2527
2553
|
|
|
2528
|
-
[
|
|
2554
|
+
[SaveSubscriptionSetupIntentResponse](#SaveSubscriptionSetupIntentResponse)
|
|
2529
2555
|
|
|
2530
|
-
|
|
2556
|
+
Save Subscription Setup Intent Response.
|
|
2531
2557
|
|
|
2532
2558
|
|
|
2533
2559
|
|
|
@@ -2537,29 +2563,14 @@ List Order Beneficiary
|
|
|
2537
2563
|
|
|
2538
2564
|
```json
|
|
2539
2565
|
{
|
|
2540
|
-
"
|
|
2541
|
-
|
|
2542
|
-
|
|
2543
|
-
|
|
2544
|
-
|
|
2545
|
-
|
|
2546
|
-
|
|
2547
|
-
|
|
2548
|
-
"ifsc_code": "SBIN0014982",
|
|
2549
|
-
"mobile": "7819064010",
|
|
2550
|
-
"email": "prakashtest@gmail.com",
|
|
2551
|
-
"address": "49A, Dabhi seri, jodhpur, kalyanpur",
|
|
2552
|
-
"comment": "COD Refund",
|
|
2553
|
-
"is_active": null,
|
|
2554
|
-
"created_on": "2021-01-22 11:31:02",
|
|
2555
|
-
"modified_on": "2021-01-22 11:31:02",
|
|
2556
|
-
"display_name": "BANK",
|
|
2557
|
-
"transfer_mode": "bank",
|
|
2558
|
-
"title": "Bank Account",
|
|
2559
|
-
"subtitle": "35663423659",
|
|
2560
|
-
"delights_user_name": "shreeniwas_24x7_gmail_com_45978_16624463"
|
|
2561
|
-
}
|
|
2562
|
-
]
|
|
2566
|
+
"success": true,
|
|
2567
|
+
"data": {
|
|
2568
|
+
"id": "test",
|
|
2569
|
+
"object": "test",
|
|
2570
|
+
"client_secret": "test",
|
|
2571
|
+
"customer": "test",
|
|
2572
|
+
"status": "requires_payment_method"
|
|
2573
|
+
}
|
|
2563
2574
|
}
|
|
2564
2575
|
```
|
|
2565
2576
|
</details>
|
|
@@ -2575,17 +2586,17 @@ List Order Beneficiary
|
|
|
2575
2586
|
---
|
|
2576
2587
|
|
|
2577
2588
|
|
|
2578
|
-
###
|
|
2579
|
-
|
|
2589
|
+
### setUserCODlimitRoutes
|
|
2590
|
+
Set COD option for user for payment
|
|
2580
2591
|
|
|
2581
2592
|
|
|
2582
2593
|
|
|
2583
2594
|
```javascript
|
|
2584
2595
|
// Promise
|
|
2585
|
-
const promise = client.application("<APPLICATION_ID>").payment.
|
|
2596
|
+
const promise = client.application("<APPLICATION_ID>").payment.setUserCODlimitRoutes({ body : value });
|
|
2586
2597
|
|
|
2587
2598
|
// Async/Await
|
|
2588
|
-
const data = await client.application("<APPLICATION_ID>").payment.
|
|
2599
|
+
const data = await client.application("<APPLICATION_ID>").payment.setUserCODlimitRoutes({ body : value });
|
|
2589
2600
|
```
|
|
2590
2601
|
|
|
2591
2602
|
|
|
@@ -2593,21 +2604,20 @@ const data = await client.application("<APPLICATION_ID>").payment.getUserBenefic
|
|
|
2593
2604
|
|
|
2594
2605
|
|
|
2595
2606
|
| Argument | Type | Required | Description |
|
|
2596
|
-
| --------- | ----- | -------- | ----------- |
|
|
2597
|
-
|
|
|
2598
|
-
|
|
2607
|
+
| --------- | ----- | -------- | ----------- |
|
|
2608
|
+
| body | [SetCODForUserRequest](#SetCODForUserRequest) | yes | Request body |
|
|
2599
2609
|
|
|
2600
2610
|
|
|
2601
|
-
|
|
2611
|
+
Use this API to set cod option as true or false for the payment
|
|
2602
2612
|
|
|
2603
2613
|
*Returned Response:*
|
|
2604
2614
|
|
|
2605
2615
|
|
|
2606
2616
|
|
|
2607
2617
|
|
|
2608
|
-
[
|
|
2618
|
+
[SetCODOptionResponse](#SetCODOptionResponse)
|
|
2609
2619
|
|
|
2610
|
-
|
|
2620
|
+
Success. Returns true/false for user cod option for payment. Check the example shown below or refer `GetUserCODLimitResponseSchema` for more details.
|
|
2611
2621
|
|
|
2612
2622
|
|
|
2613
2623
|
|
|
@@ -2617,30 +2627,8 @@ List User Beneficiary
|
|
|
2617
2627
|
|
|
2618
2628
|
```json
|
|
2619
2629
|
{
|
|
2620
|
-
"
|
|
2621
|
-
|
|
2622
|
-
"id": 221,
|
|
2623
|
-
"beneficiary_id": "0f7e44a922df352c05c5f73cb40ba115",
|
|
2624
|
-
"bank_name": "State Bank of India",
|
|
2625
|
-
"branch_name": "State Bank of India",
|
|
2626
|
-
"account_holder": "SHASHI TEST",
|
|
2627
|
-
"account_no": "1234567891",
|
|
2628
|
-
"ifsc_code": "SBIN0005611",
|
|
2629
|
-
"mobile": "9112042174",
|
|
2630
|
-
"email": "payment@gofynd.com",
|
|
2631
|
-
"address": "204A",
|
|
2632
|
-
"comment": "",
|
|
2633
|
-
"is_active": null,
|
|
2634
|
-
"created_on": "2020-06-29 12:38:39",
|
|
2635
|
-
"modified_on": "2020-06-29 12:38:39",
|
|
2636
|
-
"display_name": "BANK",
|
|
2637
|
-
"transfer_mode": "bank",
|
|
2638
|
-
"title": "Bank Account",
|
|
2639
|
-
"subtitle": "1234567891",
|
|
2640
|
-
"delights_user_name": null
|
|
2641
|
-
}
|
|
2642
|
-
],
|
|
2643
|
-
"show_beneficiary_details": false
|
|
2630
|
+
"success": true,
|
|
2631
|
+
"message": "COD option for user {} is set to {}"
|
|
2644
2632
|
}
|
|
2645
2633
|
```
|
|
2646
2634
|
</details>
|
|
@@ -2656,17 +2644,17 @@ List User Beneficiary
|
|
|
2656
2644
|
---
|
|
2657
2645
|
|
|
2658
2646
|
|
|
2659
|
-
###
|
|
2660
|
-
|
|
2647
|
+
### updateBrandPaymentGatewayConfig
|
|
2648
|
+
Save Config Secret For Brand Payment Gateway
|
|
2661
2649
|
|
|
2662
2650
|
|
|
2663
2651
|
|
|
2664
2652
|
```javascript
|
|
2665
2653
|
// Promise
|
|
2666
|
-
const promise = client.application("<APPLICATION_ID>").payment.
|
|
2654
|
+
const promise = client.application("<APPLICATION_ID>").payment.updateBrandPaymentGatewayConfig({ body : value });
|
|
2667
2655
|
|
|
2668
2656
|
// Async/Await
|
|
2669
|
-
const data = await client.application("<APPLICATION_ID>").payment.
|
|
2657
|
+
const data = await client.application("<APPLICATION_ID>").payment.updateBrandPaymentGatewayConfig({ body : value });
|
|
2670
2658
|
```
|
|
2671
2659
|
|
|
2672
2660
|
|
|
@@ -2675,19 +2663,19 @@ const data = await client.application("<APPLICATION_ID>").payment.confirmPayment
|
|
|
2675
2663
|
|
|
2676
2664
|
| Argument | Type | Required | Description |
|
|
2677
2665
|
| --------- | ----- | -------- | ----------- |
|
|
2678
|
-
| body | [
|
|
2666
|
+
| body | [PaymentGatewayConfigRequest](#PaymentGatewayConfigRequest) | yes | Request body |
|
|
2679
2667
|
|
|
2680
2668
|
|
|
2681
|
-
|
|
2669
|
+
Save Config Secret For Brand Payment Gateway
|
|
2682
2670
|
|
|
2683
2671
|
*Returned Response:*
|
|
2684
2672
|
|
|
2685
2673
|
|
|
2686
2674
|
|
|
2687
2675
|
|
|
2688
|
-
[
|
|
2676
|
+
[PaymentGatewayToBeReviewed](#PaymentGatewayToBeReviewed)
|
|
2689
2677
|
|
|
2690
|
-
|
|
2678
|
+
Save Config Secret For Brand Payment Gateway Success Response.
|
|
2691
2679
|
|
|
2692
2680
|
|
|
2693
2681
|
|
|
@@ -2698,8 +2686,9 @@ Success. Returns the status of payment. Check the example shown below or refer `
|
|
|
2698
2686
|
```json
|
|
2699
2687
|
{
|
|
2700
2688
|
"success": true,
|
|
2701
|
-
"
|
|
2702
|
-
|
|
2689
|
+
"aggregators": [
|
|
2690
|
+
"razorpay"
|
|
2691
|
+
]
|
|
2703
2692
|
}
|
|
2704
2693
|
```
|
|
2705
2694
|
</details>
|
|
@@ -2715,19 +2704,19 @@ Success. Returns the status of payment. Check the example shown below or refer `
|
|
|
2715
2704
|
---
|
|
2716
2705
|
|
|
2717
2706
|
|
|
2718
|
-
###
|
|
2719
|
-
|
|
2707
|
+
### updatePayout
|
|
2708
|
+
Update Payout
|
|
2720
2709
|
|
|
2721
2710
|
|
|
2722
2711
|
|
|
2723
2712
|
```javascript
|
|
2724
2713
|
// Promise
|
|
2725
|
-
const promise = client.
|
|
2726
|
-
|
|
2714
|
+
const promise = client.payment.updatePayout({ uniqueTransferNo : value,
|
|
2715
|
+
body : value });
|
|
2727
2716
|
|
|
2728
2717
|
// Async/Await
|
|
2729
|
-
const data = await client.
|
|
2730
|
-
|
|
2718
|
+
const data = await client.payment.updatePayout({ uniqueTransferNo : value,
|
|
2719
|
+
body : value });
|
|
2731
2720
|
```
|
|
2732
2721
|
|
|
2733
2722
|
|
|
@@ -2736,21 +2725,20 @@ const data = await client.application("<APPLICATION_ID>").payment.getUserCODlimi
|
|
|
2736
2725
|
|
|
2737
2726
|
| Argument | Type | Required | Description |
|
|
2738
2727
|
| --------- | ----- | -------- | ----------- |
|
|
2739
|
-
|
|
|
2740
|
-
|
|
|
2741
|
-
|
|
2728
|
+
| uniqueTransferNo | string | yes | Unique transfer id |
|
|
2729
|
+
| body | [PayoutRequest](#PayoutRequest) | yes | Request body |
|
|
2742
2730
|
|
|
2743
2731
|
|
|
2744
|
-
|
|
2732
|
+
Update Payout
|
|
2745
2733
|
|
|
2746
2734
|
*Returned Response:*
|
|
2747
2735
|
|
|
2748
2736
|
|
|
2749
2737
|
|
|
2750
2738
|
|
|
2751
|
-
[
|
|
2739
|
+
[UpdatePayoutResponse](#UpdatePayoutResponse)
|
|
2752
2740
|
|
|
2753
|
-
|
|
2741
|
+
save payout response object
|
|
2754
2742
|
|
|
2755
2743
|
|
|
2756
2744
|
|
|
@@ -2761,14 +2749,8 @@ Success. Returns user cod limit , remaining limit and usage of user for COD. Che
|
|
|
2761
2749
|
```json
|
|
2762
2750
|
{
|
|
2763
2751
|
"success": true,
|
|
2764
|
-
"
|
|
2765
|
-
|
|
2766
|
-
"user_id": 5,
|
|
2767
|
-
"usages": 1000,
|
|
2768
|
-
"limit": 10000,
|
|
2769
|
-
"remaining_limit": 9000,
|
|
2770
|
-
"merchant_user_id": "5e199e6998cfe1776f1385dc"
|
|
2771
|
-
}
|
|
2752
|
+
"is_default": true,
|
|
2753
|
+
"is_active": true
|
|
2772
2754
|
}
|
|
2773
2755
|
```
|
|
2774
2756
|
</details>
|
|
@@ -2784,17 +2766,17 @@ Success. Returns user cod limit , remaining limit and usage of user for COD. Che
|
|
|
2784
2766
|
---
|
|
2785
2767
|
|
|
2786
2768
|
|
|
2787
|
-
###
|
|
2788
|
-
|
|
2769
|
+
### verifyIfscCode
|
|
2770
|
+
Ifsc Code Verification
|
|
2789
2771
|
|
|
2790
2772
|
|
|
2791
2773
|
|
|
2792
2774
|
```javascript
|
|
2793
2775
|
// Promise
|
|
2794
|
-
const promise = client.
|
|
2776
|
+
const promise = client.payment.verifyIfscCode({ ifscCode : value });
|
|
2795
2777
|
|
|
2796
2778
|
// Async/Await
|
|
2797
|
-
const data = await client.
|
|
2779
|
+
const data = await client.payment.verifyIfscCode({ ifscCode : value });
|
|
2798
2780
|
```
|
|
2799
2781
|
|
|
2800
2782
|
|
|
@@ -2802,20 +2784,21 @@ const data = await client.application("<APPLICATION_ID>").payment.setUserCODlimi
|
|
|
2802
2784
|
|
|
2803
2785
|
|
|
2804
2786
|
| Argument | Type | Required | Description |
|
|
2805
|
-
| --------- | ----- | -------- | ----------- |
|
|
2806
|
-
|
|
|
2787
|
+
| --------- | ----- | -------- | ----------- |
|
|
2788
|
+
| ifscCode | string | no | |
|
|
2807
2789
|
|
|
2808
2790
|
|
|
2809
|
-
|
|
2791
|
+
|
|
2792
|
+
Get True/False for correct IFSC Code for adding bank details for refund
|
|
2810
2793
|
|
|
2811
2794
|
*Returned Response:*
|
|
2812
2795
|
|
|
2813
2796
|
|
|
2814
2797
|
|
|
2815
2798
|
|
|
2816
|
-
[
|
|
2799
|
+
[IfscCodeResponse](#IfscCodeResponse)
|
|
2817
2800
|
|
|
2818
|
-
|
|
2801
|
+
Bank details on correct Ifsc Code
|
|
2819
2802
|
|
|
2820
2803
|
|
|
2821
2804
|
|
|
@@ -2825,8 +2808,25 @@ Success. Returns true/false for user cod option for payment. Check the example s
|
|
|
2825
2808
|
|
|
2826
2809
|
```json
|
|
2827
2810
|
{
|
|
2828
|
-
"
|
|
2829
|
-
"
|
|
2811
|
+
"branch_name": "MANPUR",
|
|
2812
|
+
"bank_name": "GAYA",
|
|
2813
|
+
"BRANCH": "MANPUR",
|
|
2814
|
+
"CENTRE": "GAYA",
|
|
2815
|
+
"DISTRICT": "GAYA",
|
|
2816
|
+
"STATE": "BIHAR",
|
|
2817
|
+
"ADDRESS": "POBUNIYADGANJBIHAR",
|
|
2818
|
+
"CONTACT": "00",
|
|
2819
|
+
"MICR": "816002103",
|
|
2820
|
+
"UPI": true,
|
|
2821
|
+
"RTGS": true,
|
|
2822
|
+
"CITY": "GAYA",
|
|
2823
|
+
"NEFT": true,
|
|
2824
|
+
"IMPS": true,
|
|
2825
|
+
"SWIFT": "",
|
|
2826
|
+
"BANK": "State Bank of India",
|
|
2827
|
+
"BANKCODE": "SBIN",
|
|
2828
|
+
"IFSC": "SBIN0005611",
|
|
2829
|
+
"success": true
|
|
2830
2830
|
}
|
|
2831
2831
|
```
|
|
2832
2832
|
</details>
|
|
@@ -2845,601 +2845,291 @@ Success. Returns true/false for user cod option for payment. Check the example s
|
|
|
2845
2845
|
|
|
2846
2846
|
### Schemas
|
|
2847
2847
|
|
|
2848
|
-
|
|
2849
|
-
|
|
2850
|
-
#### [PaymentGatewayConfigResponse](#PaymentGatewayConfigResponse)
|
|
2848
|
+
|
|
2849
|
+
#### [AddBeneficiaryDetailsOTPRequest](#AddBeneficiaryDetailsOTPRequest)
|
|
2851
2850
|
|
|
2852
2851
|
| Properties | Type | Nullable | Description |
|
|
2853
|
-
| ---------- | ---- | -------- | ----------- |
|
|
2854
|
-
| excluded_fields | [string] | yes | List of all excluded options with their Details. |
|
|
2855
|
-
| created | boolean | yes | Response is created or not |
|
|
2856
|
-
| aggregators | [string] | no | List of all speceific Payment options with their Details. |
|
|
2857
|
-
| success | boolean | yes | Response is successful or not |
|
|
2858
|
-
| app_id | string | yes | Application Id to which Payment config Mapped |
|
|
2859
|
-
| display_fields | [string] | yes | List of all included options with their Details. |
|
|
2852
|
+
| ---------- | ---- | -------- | ----------- || details | [BankDetailsForOTP](#BankDetailsForOTP) | yes | || order_id | string | yes | |
|
|
2860
2853
|
|
|
2861
2854
|
---
|
|
2862
2855
|
|
|
2863
|
-
|
|
2864
|
-
|
|
2865
|
-
|
|
2866
|
-
#### [ErrorCodeDescription](#ErrorCodeDescription)
|
|
2856
|
+
#### [BankDetailsForOTP](#BankDetailsForOTP)
|
|
2867
2857
|
|
|
2868
2858
|
| Properties | Type | Nullable | Description |
|
|
2869
|
-
| ---------- | ---- | -------- | ----------- |
|
|
2870
|
-
| code | string | yes | Error descrption code. |
|
|
2871
|
-
| description | string | yes | Error human understandable description. |
|
|
2872
|
-
| success | boolean | yes | Response is successful or not |
|
|
2859
|
+
| ---------- | ---- | -------- | ----------- || account_holder | string | yes | || account_no | string | yes | || bank_name | string | yes | || branch_name | string | yes | || ifsc_code | string | yes | |
|
|
2873
2860
|
|
|
2874
2861
|
---
|
|
2875
2862
|
|
|
2876
|
-
|
|
2877
|
-
|
|
2878
|
-
|
|
2879
|
-
#### [PaymentGatewayConfig](#PaymentGatewayConfig)
|
|
2863
|
+
#### [CODdata](#CODdata)
|
|
2880
2864
|
|
|
2881
2865
|
| Properties | Type | Nullable | Description |
|
|
2882
|
-
| ---------- | ---- | -------- | ----------- |
|
|
2883
|
-
| secret | string | yes | Secret Key of the payment aggregator |
|
|
2884
|
-
| config_type | string | yes | Config Type of the aggregator |
|
|
2885
|
-
| key | string | yes | Api key of the payment aggregator |
|
|
2886
|
-
| merchant_salt | string | yes | Merchant key of the payment aggregator |
|
|
2887
|
-
| is_active | boolean | no | Enable/ Disable Flag |
|
|
2866
|
+
| ---------- | ---- | -------- | ----------- || is_active | boolean | yes | || limit | number | yes | || remaining_limit | number | yes | || usages | number | yes | || user_id | string | yes | |
|
|
2888
2867
|
|
|
2889
2868
|
---
|
|
2890
2869
|
|
|
2891
|
-
|
|
2892
|
-
|
|
2893
|
-
|
|
2894
|
-
#### [PaymentGatewayConfigRequest](#PaymentGatewayConfigRequest)
|
|
2870
|
+
#### [DeletePayoutResponse](#DeletePayoutResponse)
|
|
2895
2871
|
|
|
2896
2872
|
| Properties | Type | Nullable | Description |
|
|
2897
|
-
| ---------- | ---- | -------- | ----------- |
|
|
2898
|
-
| aggregator_name | [PaymentGatewayConfig](#PaymentGatewayConfig) | no | |
|
|
2899
|
-
| is_active | boolean | no | Enable/ Disable Flag |
|
|
2900
|
-
| app_id | string | yes | Application Id to which Payment config Mapped |
|
|
2873
|
+
| ---------- | ---- | -------- | ----------- || success | boolean | yes | |
|
|
2901
2874
|
|
|
2902
2875
|
---
|
|
2903
2876
|
|
|
2904
|
-
|
|
2905
|
-
|
|
2906
|
-
|
|
2907
|
-
#### [PaymentGatewayToBeReviewed](#PaymentGatewayToBeReviewed)
|
|
2877
|
+
#### [DeleteSubscriptionPaymentMethodResponse](#DeleteSubscriptionPaymentMethodResponse)
|
|
2908
2878
|
|
|
2909
2879
|
| Properties | Type | Nullable | Description |
|
|
2910
|
-
| ---------- | ---- | -------- | ----------- |
|
|
2911
|
-
| aggregator | [string] | yes | List of added payment gateway |
|
|
2912
|
-
| success | boolean | yes | Response is successful or not |
|
|
2880
|
+
| ---------- | ---- | -------- | ----------- || success | boolean | yes | |
|
|
2913
2881
|
|
|
2914
2882
|
---
|
|
2915
2883
|
|
|
2916
|
-
|
|
2917
|
-
|
|
2918
|
-
|
|
2919
|
-
#### [ErrorCodeAndDescription](#ErrorCodeAndDescription)
|
|
2884
|
+
#### [ErrorCodeAndDescription](#ErrorCodeAndDescription)
|
|
2920
2885
|
|
|
2921
2886
|
| Properties | Type | Nullable | Description |
|
|
2922
|
-
| ---------- | ---- | -------- | ----------- |
|
|
2923
|
-
| code | string | yes | Error descrption code. |
|
|
2924
|
-
| description | string | yes | Error human understandable description. |
|
|
2887
|
+
| ---------- | ---- | -------- | ----------- || code | string | yes | || description | string | yes | |
|
|
2925
2888
|
|
|
2926
2889
|
---
|
|
2927
2890
|
|
|
2928
|
-
|
|
2929
|
-
|
|
2930
|
-
|
|
2931
|
-
#### [HttpErrorCodeAndResponse](#HttpErrorCodeAndResponse)
|
|
2891
|
+
#### [ErrorCodeDescription](#ErrorCodeDescription)
|
|
2932
2892
|
|
|
2933
2893
|
| Properties | Type | Nullable | Description |
|
|
2934
|
-
| ---------- | ---- | -------- | ----------- |
|
|
2935
|
-
| error | [ErrorCodeAndDescription](#ErrorCodeAndDescription) | yes | |
|
|
2936
|
-
| success | boolean | yes | Response is successful or not |
|
|
2894
|
+
| ---------- | ---- | -------- | ----------- || code | string | yes | || description | string | yes | || success | boolean | yes | |
|
|
2937
2895
|
|
|
2938
2896
|
---
|
|
2939
2897
|
|
|
2940
|
-
|
|
2941
|
-
|
|
2942
|
-
|
|
2943
|
-
#### [PaymentModeLogo](#PaymentModeLogo)
|
|
2898
|
+
#### [GetUserCODLimitResponse](#GetUserCODLimitResponse)
|
|
2944
2899
|
|
|
2945
2900
|
| Properties | Type | Nullable | Description |
|
|
2946
|
-
| ---------- | ---- | -------- | ----------- |
|
|
2947
|
-
| small | string | yes | smalll |
|
|
2948
|
-
| large | string | yes | large |
|
|
2901
|
+
| ---------- | ---- | -------- | ----------- || success | boolean | yes | || user_cod_data | [CODdata](#CODdata) | yes | |
|
|
2949
2902
|
|
|
2950
2903
|
---
|
|
2951
2904
|
|
|
2952
|
-
|
|
2953
|
-
|
|
2954
|
-
|
|
2955
|
-
#### [IntentApp](#IntentApp)
|
|
2905
|
+
#### [HttpErrorCodeAndResponse](#HttpErrorCodeAndResponse)
|
|
2956
2906
|
|
|
2957
2907
|
| Properties | Type | Nullable | Description |
|
|
2958
|
-
| ---------- | ---- | -------- | ----------- |
|
|
2959
|
-
| code | string | no | code |
|
|
2960
|
-
| logos | [PaymentModeLogo](#PaymentModeLogo) | no | logos |
|
|
2961
|
-
| package_name | string | no | package_name |
|
|
2962
|
-
| display_name | string | no | display_name |
|
|
2908
|
+
| ---------- | ---- | -------- | ----------- || error | [ErrorCodeAndDescription](#ErrorCodeAndDescription) | yes | || success | boolean | yes | |
|
|
2963
2909
|
|
|
2964
2910
|
---
|
|
2965
2911
|
|
|
2966
|
-
|
|
2967
|
-
|
|
2968
|
-
|
|
2969
|
-
#### [IntentAppErrorList](#IntentAppErrorList)
|
|
2912
|
+
#### [IfscCodeResponse](#IfscCodeResponse)
|
|
2970
2913
|
|
|
2971
2914
|
| Properties | Type | Nullable | Description |
|
|
2972
|
-
| ---------- | ---- | -------- | ----------- |
|
|
2973
|
-
| code | string | no | code |
|
|
2974
|
-
| package_name | string | no | package_name |
|
|
2915
|
+
| ---------- | ---- | -------- | ----------- || bank_name | string | yes | || branch_name | string | yes | || success | boolean | no | |
|
|
2975
2916
|
|
|
2976
2917
|
---
|
|
2977
2918
|
|
|
2978
|
-
|
|
2979
|
-
|
|
2980
|
-
|
|
2981
|
-
#### [PaymentModeList](#PaymentModeList)
|
|
2919
|
+
#### [IntentApp](#IntentApp)
|
|
2982
2920
|
|
|
2983
2921
|
| Properties | Type | Nullable | Description |
|
|
2984
|
-
| ---------- | ---- | -------- | ----------- |
|
|
2985
|
-
| merchant_code | string | no | merchant code |
|
|
2986
|
-
| card_token | string | no | card_token |
|
|
2987
|
-
| nickname | string | no | nickname |
|
|
2988
|
-
| intent_app | [[IntentApp](#IntentApp)] | no | intent_app |
|
|
2989
|
-
| timeout | number | no | timeout |
|
|
2990
|
-
| card_isin | string | no | card_isin |
|
|
2991
|
-
| intent_flow | boolean | no | intent_flow |
|
|
2992
|
-
| cod_limit_per_order | number | no | Cod limit per order |
|
|
2993
|
-
| intent_app_error_dict_list | [[IntentAppErrorList](#IntentAppErrorList)] | no | intent_app_error_dict_list |
|
|
2994
|
-
| cod_limit | number | no | cod limit |
|
|
2995
|
-
| expired | boolean | no | expired |
|
|
2996
|
-
| exp_year | number | no | exp_year |
|
|
2997
|
-
| retry_count | number | no | retry_count |
|
|
2998
|
-
| card_number | string | no | card_number |
|
|
2999
|
-
| card_name | string | no | card_name |
|
|
3000
|
-
| card_brand | string | no | card_brand |
|
|
3001
|
-
| compliant_with_tokenisation_guidelines | boolean | no | If card is tokenised or not |
|
|
3002
|
-
| code | string | no | code |
|
|
3003
|
-
| aggregator_name | string | yes | aggregator_name |
|
|
3004
|
-
| card_fingerprint | string | no | card_fingerprint |
|
|
3005
|
-
| card_reference | string | no | card_reference |
|
|
3006
|
-
| card_issuer | string | no | card_issuer |
|
|
3007
|
-
| exp_month | number | no | exp_month |
|
|
3008
|
-
| card_type | string | no | card_type |
|
|
3009
|
-
| intent_app_error_list | [string] | no | intent_app_error_list |
|
|
3010
|
-
| card_brand_image | string | no | card_brand_image |
|
|
3011
|
-
| display_priority | number | no | Dispaly Priority |
|
|
3012
|
-
| remaining_limit | number | no | Remaining limit |
|
|
3013
|
-
| display_name | string | no | display name |
|
|
3014
|
-
| fynd_vpa | string | no | fynd_vpa |
|
|
3015
|
-
| logo_url | [PaymentModeLogo](#PaymentModeLogo) | no | Logo |
|
|
3016
|
-
| name | string | no | name |
|
|
3017
|
-
| card_id | string | no | card_id |
|
|
2922
|
+
| ---------- | ---- | -------- | ----------- || code | string | no | || display_name | string | no | || logos | [PaymentModeLogo](#PaymentModeLogo) | no | || package_name | string | no | |
|
|
3018
2923
|
|
|
3019
2924
|
---
|
|
3020
2925
|
|
|
3021
|
-
|
|
3022
|
-
|
|
3023
|
-
|
|
3024
|
-
#### [RootPaymentMode](#RootPaymentMode)
|
|
2926
|
+
#### [IntentAppErrorList](#IntentAppErrorList)
|
|
3025
2927
|
|
|
3026
2928
|
| Properties | Type | Nullable | Description |
|
|
3027
|
-
| ---------- | ---- | -------- | ----------- |
|
|
3028
|
-
| add_card_enabled | boolean | no | Annonymous card flag |
|
|
3029
|
-
| display_priority | number | yes | Dispaly Priority |
|
|
3030
|
-
| anonymous_enable | boolean | no | Annonymous card flag |
|
|
3031
|
-
| save_card | boolean | no | Card save or not |
|
|
3032
|
-
| display_name | string | yes | Payment mode display name |
|
|
3033
|
-
| aggregator_name | string | no | Dispaly Priority |
|
|
3034
|
-
| name | string | yes | Payment mode name |
|
|
3035
|
-
| is_pay_by_card_pl | boolean | no | This flag will be true in case of Payment link payment through card |
|
|
3036
|
-
| list | [[PaymentModeList](#PaymentModeList)] | no | Payment mode |
|
|
2929
|
+
| ---------- | ---- | -------- | ----------- || code | string | no | || package_name | string | no | |
|
|
3037
2930
|
|
|
3038
2931
|
---
|
|
3039
2932
|
|
|
3040
|
-
|
|
3041
|
-
|
|
3042
|
-
|
|
3043
|
-
#### [PaymentOptions](#PaymentOptions)
|
|
2933
|
+
#### [MultiTenderPaymentMeta](#MultiTenderPaymentMeta)
|
|
3044
2934
|
|
|
3045
2935
|
| Properties | Type | Nullable | Description |
|
|
3046
|
-
| ---------- | ---- | -------- | ----------- |
|
|
3047
|
-
| payment_option | [[RootPaymentMode](#RootPaymentMode)] | yes | Payment options |
|
|
2936
|
+
| ---------- | ---- | -------- | ----------- || current_status | string | no | || extra_meta | string | no | || order_id | string | no | || payment_gateway | string | no | || payment_id | string | no | |
|
|
3048
2937
|
|
|
3049
2938
|
---
|
|
3050
2939
|
|
|
3051
|
-
|
|
3052
|
-
|
|
3053
|
-
|
|
3054
|
-
#### [PaymentOptionsResponse](#PaymentOptionsResponse)
|
|
2940
|
+
#### [MultiTenderPaymentMethod](#MultiTenderPaymentMethod)
|
|
3055
2941
|
|
|
3056
2942
|
| Properties | Type | Nullable | Description |
|
|
3057
|
-
| ---------- | ---- | -------- | ----------- |
|
|
3058
|
-
| payment_options | [PaymentOptions](#PaymentOptions) | yes | Payment options |
|
|
3059
|
-
| success | boolean | yes | Response is successful or not |
|
|
2943
|
+
| ---------- | ---- | -------- | ----------- || amount | number | yes | || meta | [MultiTenderPaymentMeta](#MultiTenderPaymentMeta) | no | || mode | string | yes | || name | string | no | |
|
|
3060
2944
|
|
|
3061
2945
|
---
|
|
3062
2946
|
|
|
3063
|
-
|
|
3064
|
-
|
|
3065
|
-
|
|
3066
|
-
#### [PayoutsResponse](#PayoutsResponse)
|
|
2947
|
+
#### [NotFoundResourceError](#NotFoundResourceError)
|
|
3067
2948
|
|
|
3068
2949
|
| Properties | Type | Nullable | Description |
|
|
3069
|
-
| ---------- | ---- | -------- | ----------- |
|
|
3070
|
-
| is_default | boolean | yes | default or not |
|
|
3071
|
-
| transfer_type | string | yes | transafer type |
|
|
3072
|
-
| customers | string | yes | customers details object |
|
|
3073
|
-
| more_attributes | string | yes | bank details object |
|
|
3074
|
-
| unique_transfer_no | string | yes | display priority of the payment mode |
|
|
3075
|
-
| is_active | boolean | yes | Enable/DIsable Flag Payout |
|
|
3076
|
-
| payouts_aggregators | [string] | yes | payout aggregator object |
|
|
2950
|
+
| ---------- | ---- | -------- | ----------- || code | string | yes | || description | string | yes | || success | boolean | yes | |
|
|
3077
2951
|
|
|
3078
2952
|
---
|
|
3079
2953
|
|
|
3080
|
-
|
|
3081
|
-
|
|
3082
|
-
|
|
3083
|
-
#### [PayoutBankDetails](#PayoutBankDetails)
|
|
2954
|
+
#### [OrderBeneficiaryDetails](#OrderBeneficiaryDetails)
|
|
3084
2955
|
|
|
3085
2956
|
| Properties | Type | Nullable | Description |
|
|
3086
|
-
| ---------- | ---- | -------- | ----------- |
|
|
3087
|
-
| account_type | string | yes | |
|
|
3088
|
-
| city | string | no | |
|
|
3089
|
-
| country | string | no | |
|
|
3090
|
-
| account_holder | string | no | |
|
|
3091
|
-
| state | string | no | |
|
|
3092
|
-
| account_no | string | no | |
|
|
3093
|
-
| pincode | number | no | |
|
|
3094
|
-
| branch_name | string | no | |
|
|
3095
|
-
| ifsc_code | string | yes | |
|
|
3096
|
-
| bank_name | string | no | |
|
|
2957
|
+
| ---------- | ---- | -------- | ----------- || account_holder | string | yes | || account_no | string | yes | || address | string | yes | || bank_name | string | yes | || beneficiary_id | string | yes | || branch_name | string | no | || comment | string | no | || created_on | string | yes | || delights_user_name | string | no | || display_name | string | yes | || email | string | yes | || id | number | yes | || ifsc_code | string | yes | || is_active | boolean | yes | || mobile | string | no | || modified_on | string | yes | || subtitle | string | yes | || title | string | yes | || transfer_mode | string | yes | |
|
|
3097
2958
|
|
|
3098
2959
|
---
|
|
3099
2960
|
|
|
3100
|
-
|
|
3101
|
-
|
|
3102
|
-
|
|
3103
|
-
#### [PayoutRequest](#PayoutRequest)
|
|
2961
|
+
#### [OrderBeneficiaryResponse](#OrderBeneficiaryResponse)
|
|
3104
2962
|
|
|
3105
2963
|
| Properties | Type | Nullable | Description |
|
|
3106
|
-
| ---------- | ---- | -------- | ----------- |
|
|
3107
|
-
| unique_external_id | string | yes | Unique Id of Payout |
|
|
3108
|
-
| users | string | yes | payout users object |
|
|
3109
|
-
| transfer_type | string | yes | transafer type |
|
|
3110
|
-
| aggregator | string | yes | Aggregator Name |
|
|
3111
|
-
| bank_details | [PayoutBankDetails](#PayoutBankDetails) | yes | payout bank details object |
|
|
3112
|
-
| is_active | boolean | yes | Enable/Disable Flag Payout |
|
|
2964
|
+
| ---------- | ---- | -------- | ----------- || beneficiaries | [[OrderBeneficiaryDetails](#OrderBeneficiaryDetails)] | no | || show_beneficiary_details | boolean | no | |
|
|
3113
2965
|
|
|
3114
2966
|
---
|
|
3115
2967
|
|
|
3116
|
-
|
|
3117
|
-
|
|
3118
|
-
|
|
3119
|
-
#### [PayoutResponse](#PayoutResponse)
|
|
2968
|
+
#### [PaymentConfirmationRequest](#PaymentConfirmationRequest)
|
|
3120
2969
|
|
|
3121
2970
|
| Properties | Type | Nullable | Description |
|
|
3122
|
-
| ---------- | ---- | -------- | ----------- |
|
|
3123
|
-
| payment_status | string | yes | status of payment |
|
|
3124
|
-
| payouts | string | yes | payout object |
|
|
3125
|
-
| users | string | yes | users details object |
|
|
3126
|
-
| transfer_type | string | yes | transfer type |
|
|
3127
|
-
| created | boolean | yes | created flag |
|
|
3128
|
-
| aggregator | string | yes | Aggregator Name |
|
|
3129
|
-
| unique_transfer_no | string | yes | unique transfer no |
|
|
3130
|
-
| bank_details | string | yes | payout bank_details object |
|
|
3131
|
-
| is_active | boolean | yes | Enable/DIsable Flag Payout |
|
|
3132
|
-
| success | boolean | yes | Response is successful or not |
|
|
2971
|
+
| ---------- | ---- | -------- | ----------- || order_id | string | yes | || payment_methods | [[MultiTenderPaymentMethod](#MultiTenderPaymentMethod)] | yes | |
|
|
3133
2972
|
|
|
3134
2973
|
---
|
|
3135
2974
|
|
|
3136
|
-
|
|
3137
|
-
|
|
3138
|
-
|
|
3139
|
-
#### [UpdatePayoutResponse](#UpdatePayoutResponse)
|
|
2975
|
+
#### [PaymentConfirmationResponse](#PaymentConfirmationResponse)
|
|
3140
2976
|
|
|
3141
2977
|
| Properties | Type | Nullable | Description |
|
|
3142
|
-
| ---------- | ---- | -------- | ----------- |
|
|
3143
|
-
| is_default | boolean | yes | Enable/Disable Default Payout |
|
|
3144
|
-
| is_active | boolean | yes | Enable/DIsable Flag Payout |
|
|
3145
|
-
| success | boolean | yes | Response is successful or not |
|
|
2978
|
+
| ---------- | ---- | -------- | ----------- || message | string | yes | || order_id | string | yes | || success | boolean | yes | |
|
|
3146
2979
|
|
|
3147
2980
|
---
|
|
3148
2981
|
|
|
3149
|
-
|
|
3150
|
-
|
|
3151
|
-
|
|
3152
|
-
#### [UpdatePayoutRequest](#UpdatePayoutRequest)
|
|
2982
|
+
#### [PaymentGatewayConfig](#PaymentGatewayConfig)
|
|
3153
2983
|
|
|
3154
2984
|
| Properties | Type | Nullable | Description |
|
|
3155
|
-
| ---------- | ---- | -------- | ----------- |
|
|
3156
|
-
| unique_external_id | string | yes | Unique Id of Payout |
|
|
3157
|
-
| is_default | boolean | yes | Enable/Disable Default Payout |
|
|
3158
|
-
| is_active | boolean | yes | Enable/Disable Flag Payout |
|
|
2985
|
+
| ---------- | ---- | -------- | ----------- || config_type | string | yes | || is_active | boolean | no | || key | string | yes | || merchant_salt | string | yes | || secret | string | yes | |
|
|
3159
2986
|
|
|
3160
2987
|
---
|
|
3161
2988
|
|
|
3162
|
-
|
|
3163
|
-
|
|
3164
|
-
|
|
3165
|
-
#### [DeletePayoutResponse](#DeletePayoutResponse)
|
|
2989
|
+
#### [PaymentGatewayConfigRequest](#PaymentGatewayConfigRequest)
|
|
3166
2990
|
|
|
3167
2991
|
| Properties | Type | Nullable | Description |
|
|
3168
|
-
| ---------- | ---- | -------- | ----------- |
|
|
3169
|
-
| success | boolean | yes | Response is successful or not |
|
|
2992
|
+
| ---------- | ---- | -------- | ----------- || aggregator_name | [PaymentGatewayConfig](#PaymentGatewayConfig) | no | || app_id | string | yes | || is_active | boolean | no | |
|
|
3170
2993
|
|
|
3171
2994
|
---
|
|
3172
2995
|
|
|
3173
|
-
|
|
3174
|
-
|
|
3175
|
-
|
|
3176
|
-
#### [SubscriptionPaymentMethodResponse](#SubscriptionPaymentMethodResponse)
|
|
2996
|
+
#### [PaymentGatewayConfigResponse](#PaymentGatewayConfigResponse)
|
|
3177
2997
|
|
|
3178
2998
|
| Properties | Type | Nullable | Description |
|
|
3179
|
-
| ---------- | ---- | -------- | ----------- |
|
|
3180
|
-
| data | [string] | yes | Subscription Payment Method Object |
|
|
3181
|
-
| success | boolean | yes | Response is successful or not |
|
|
2999
|
+
| ---------- | ---- | -------- | ----------- || aggregators | [string] | no | || app_id | string | yes | || created | boolean | yes | || display_fields | [string] | yes | || excluded_fields | [string] | yes | || success | boolean | yes | |
|
|
3182
3000
|
|
|
3183
3001
|
---
|
|
3184
3002
|
|
|
3185
|
-
|
|
3186
|
-
|
|
3187
|
-
|
|
3188
|
-
#### [DeleteSubscriptionPaymentMethodResponse](#DeleteSubscriptionPaymentMethodResponse)
|
|
3003
|
+
#### [PaymentGatewayToBeReviewed](#PaymentGatewayToBeReviewed)
|
|
3189
3004
|
|
|
3190
3005
|
| Properties | Type | Nullable | Description |
|
|
3191
|
-
| ---------- | ---- | -------- | ----------- |
|
|
3192
|
-
| success | boolean | yes | Success or failure. |
|
|
3006
|
+
| ---------- | ---- | -------- | ----------- || aggregator | [string] | yes | || success | boolean | yes | |
|
|
3193
3007
|
|
|
3194
3008
|
---
|
|
3195
3009
|
|
|
3196
|
-
|
|
3197
|
-
|
|
3198
|
-
|
|
3199
|
-
#### [SubscriptionConfigResponse](#SubscriptionConfigResponse)
|
|
3010
|
+
#### [PaymentModeList](#PaymentModeList)
|
|
3200
3011
|
|
|
3201
3012
|
| Properties | Type | Nullable | Description |
|
|
3202
|
-
| ---------- | ---- | -------- | ----------- |
|
|
3203
|
-
| aggregator | string | yes | Aggregator Name |
|
|
3204
|
-
| config | string | yes | Aggregator Config |
|
|
3205
|
-
| success | boolean | yes | Response is successful or not |
|
|
3013
|
+
| ---------- | ---- | -------- | ----------- || aggregator_name | string | yes | || card_brand | string | no | || card_brand_image | string | no | || card_fingerprint | string | no | || card_id | string | no | || card_isin | string | no | || card_issuer | string | no | || card_name | string | no | || card_number | string | no | || card_reference | string | no | || card_token | string | no | || card_type | string | no | || cod_limit | number | no | || cod_limit_per_order | number | no | || code | string | no | || compliant_with_tokenisation_guidelines | boolean | no | || display_name | string | no | || display_priority | number | no | || exp_month | number | no | || exp_year | number | no | || expired | boolean | no | || fynd_vpa | string | no | || intent_app | [[IntentApp](#IntentApp)] | no | || intent_app_error_dict_list | [[IntentAppErrorList](#IntentAppErrorList)] | no | || intent_app_error_list | [string] | no | || intent_flow | boolean | no | || logo_url | [PaymentModeLogo](#PaymentModeLogo) | no | || merchant_code | string | no | || name | string | no | || nickname | string | no | || remaining_limit | number | no | || retry_count | number | no | || timeout | number | no | |
|
|
3206
3014
|
|
|
3207
3015
|
---
|
|
3208
3016
|
|
|
3209
|
-
|
|
3210
|
-
|
|
3211
|
-
|
|
3212
|
-
#### [SaveSubscriptionSetupIntentRequest](#SaveSubscriptionSetupIntentRequest)
|
|
3017
|
+
#### [PaymentModeLogo](#PaymentModeLogo)
|
|
3213
3018
|
|
|
3214
3019
|
| Properties | Type | Nullable | Description |
|
|
3215
|
-
| ---------- | ---- | -------- | ----------- |
|
|
3216
|
-
| unique_external_id | string | yes | Unique id i.e company:id |
|
|
3020
|
+
| ---------- | ---- | -------- | ----------- || large | string | yes | || small | string | yes | |
|
|
3217
3021
|
|
|
3218
3022
|
---
|
|
3219
3023
|
|
|
3220
|
-
|
|
3221
|
-
|
|
3222
|
-
|
|
3223
|
-
#### [SaveSubscriptionSetupIntentResponse](#SaveSubscriptionSetupIntentResponse)
|
|
3024
|
+
#### [PaymentOptions](#PaymentOptions)
|
|
3224
3025
|
|
|
3225
3026
|
| Properties | Type | Nullable | Description |
|
|
3226
|
-
| ---------- | ---- | -------- | ----------- |
|
|
3227
|
-
| data | string | yes | Subscription Payment Method Object |
|
|
3228
|
-
| success | boolean | yes | Response is successful or not |
|
|
3027
|
+
| ---------- | ---- | -------- | ----------- || payment_option | [[RootPaymentMode](#RootPaymentMode)] | yes | |
|
|
3229
3028
|
|
|
3230
3029
|
---
|
|
3231
3030
|
|
|
3232
|
-
|
|
3233
|
-
|
|
3234
|
-
|
|
3235
|
-
#### [RefundAccountResponse](#RefundAccountResponse)
|
|
3031
|
+
#### [PaymentOptionsResponse](#PaymentOptionsResponse)
|
|
3236
3032
|
|
|
3237
3033
|
| Properties | Type | Nullable | Description |
|
|
3238
|
-
| ---------- | ---- | -------- | ----------- |
|
|
3239
|
-
| is_verified_flag | boolean | no | |
|
|
3240
|
-
| message | string | yes | Response message |
|
|
3241
|
-
| data | string | no | Refund account data. |
|
|
3242
|
-
| success | boolean | yes | Success or failure flag. |
|
|
3034
|
+
| ---------- | ---- | -------- | ----------- || payment_options | [PaymentOptions](#PaymentOptions) | yes | || success | boolean | yes | |
|
|
3243
3035
|
|
|
3244
3036
|
---
|
|
3245
3037
|
|
|
3246
|
-
|
|
3247
|
-
|
|
3248
|
-
|
|
3249
|
-
#### [NotFoundResourceError](#NotFoundResourceError)
|
|
3038
|
+
#### [PayoutBankDetails](#PayoutBankDetails)
|
|
3250
3039
|
|
|
3251
3040
|
| Properties | Type | Nullable | Description |
|
|
3252
|
-
| ---------- | ---- | -------- | ----------- |
|
|
3253
|
-
| code | string | yes | Bad Request Data |
|
|
3254
|
-
| description | string | yes | Not Found |
|
|
3255
|
-
| success | boolean | yes | Response is successful or not |
|
|
3041
|
+
| ---------- | ---- | -------- | ----------- || account_holder | string | no | || account_no | string | no | || account_type | string | yes | || bank_name | string | no | || branch_name | string | no | || city | string | no | || country | string | no | || ifsc_code | string | yes | || pincode | number | no | || state | string | no | |
|
|
3256
3042
|
|
|
3257
3043
|
---
|
|
3258
3044
|
|
|
3259
|
-
|
|
3260
|
-
|
|
3261
|
-
|
|
3262
|
-
#### [BankDetailsForOTP](#BankDetailsForOTP)
|
|
3045
|
+
#### [PayoutRequest](#PayoutRequest)
|
|
3263
3046
|
|
|
3264
3047
|
| Properties | Type | Nullable | Description |
|
|
3265
|
-
| ---------- | ---- | -------- | ----------- |
|
|
3266
|
-
| account_holder | string | yes | |
|
|
3267
|
-
| account_no | string | yes | |
|
|
3268
|
-
| branch_name | string | yes | |
|
|
3269
|
-
| ifsc_code | string | yes | |
|
|
3270
|
-
| bank_name | string | yes | |
|
|
3048
|
+
| ---------- | ---- | -------- | ----------- || aggregator | string | yes | || bank_details | [PayoutBankDetails](#PayoutBankDetails) | yes | || is_active | boolean | yes | || transfer_type | string | yes | || unique_external_id | string | yes | || users | string | yes | |
|
|
3271
3049
|
|
|
3272
3050
|
---
|
|
3273
3051
|
|
|
3274
|
-
|
|
3275
|
-
|
|
3276
|
-
|
|
3277
|
-
#### [AddBeneficiaryDetailsOTPRequest](#AddBeneficiaryDetailsOTPRequest)
|
|
3052
|
+
#### [PayoutResponse](#PayoutResponse)
|
|
3278
3053
|
|
|
3279
3054
|
| Properties | Type | Nullable | Description |
|
|
3280
|
-
| ---------- | ---- | -------- | ----------- |
|
|
3281
|
-
| details | [BankDetailsForOTP](#BankDetailsForOTP) | yes | |
|
|
3282
|
-
| order_id | string | yes | |
|
|
3055
|
+
| ---------- | ---- | -------- | ----------- || aggregator | string | yes | || bank_details | string | yes | || created | boolean | yes | || is_active | boolean | yes | || payment_status | string | yes | || payouts | string | yes | || success | boolean | yes | || transfer_type | string | yes | || unique_transfer_no | string | yes | || users | string | yes | |
|
|
3283
3056
|
|
|
3284
3057
|
---
|
|
3285
3058
|
|
|
3286
|
-
|
|
3287
|
-
|
|
3288
|
-
|
|
3289
|
-
#### [IfscCodeResponse](#IfscCodeResponse)
|
|
3059
|
+
#### [PayoutsResponse](#PayoutsResponse)
|
|
3290
3060
|
|
|
3291
3061
|
| Properties | Type | Nullable | Description |
|
|
3292
|
-
| ---------- | ---- | -------- | ----------- |
|
|
3293
|
-
| bank_name | string | yes | Bank Name Of Account |
|
|
3294
|
-
| branch_name | string | yes | Branch Name Of Account |
|
|
3295
|
-
| success | boolean | no | Response is successful or not |
|
|
3062
|
+
| ---------- | ---- | -------- | ----------- || customers | string | yes | || is_active | boolean | yes | || is_default | boolean | yes | || more_attributes | string | yes | || payouts_aggregators | [string] | yes | || transfer_type | string | yes | || unique_transfer_no | string | yes | |
|
|
3296
3063
|
|
|
3297
3064
|
---
|
|
3298
3065
|
|
|
3299
|
-
|
|
3300
|
-
|
|
3301
|
-
|
|
3302
|
-
#### [OrderBeneficiaryDetails](#OrderBeneficiaryDetails)
|
|
3066
|
+
#### [RefundAccountResponse](#RefundAccountResponse)
|
|
3303
3067
|
|
|
3304
3068
|
| Properties | Type | Nullable | Description |
|
|
3305
|
-
| ---------- | ---- | -------- | ----------- |
|
|
3306
|
-
| title | string | yes | Title Of Account |
|
|
3307
|
-
| email | string | yes | EMail of User |
|
|
3308
|
-
| beneficiary_id | string | yes | Benenficiary Id |
|
|
3309
|
-
| id | number | yes | |
|
|
3310
|
-
| delights_user_name | string | no | User Id Who filled the Beneficiary |
|
|
3311
|
-
| transfer_mode | string | yes | Transfer Mode Of Account |
|
|
3312
|
-
| mobile | string | no | MObile no of User |
|
|
3313
|
-
| comment | string | no | Remarks |
|
|
3314
|
-
| account_no | string | yes | Account Number |
|
|
3315
|
-
| ifsc_code | string | yes | Ifsc Code Of Account |
|
|
3316
|
-
| subtitle | string | yes | SHort Title Of Account |
|
|
3317
|
-
| account_holder | string | yes | Account Holder Name |
|
|
3318
|
-
| created_on | string | yes | Creation Date of Beneficiary |
|
|
3319
|
-
| display_name | string | yes | Display Name Of Account |
|
|
3320
|
-
| address | string | yes | Address of User |
|
|
3321
|
-
| modified_on | string | yes | MOdification Date of Beneficiary |
|
|
3322
|
-
| branch_name | string | no | Branch Name Of Account |
|
|
3323
|
-
| is_active | boolean | yes | Boolean Flag whether Beneficiary set or not |
|
|
3324
|
-
| bank_name | string | yes | Bank Name Of Account |
|
|
3069
|
+
| ---------- | ---- | -------- | ----------- || data | string | no | || is_verified_flag | boolean | no | || message | string | yes | || success | boolean | yes | |
|
|
3325
3070
|
|
|
3326
3071
|
---
|
|
3327
3072
|
|
|
3328
|
-
|
|
3329
|
-
|
|
3330
|
-
|
|
3331
|
-
#### [OrderBeneficiaryResponse](#OrderBeneficiaryResponse)
|
|
3073
|
+
#### [RootPaymentMode](#RootPaymentMode)
|
|
3332
3074
|
|
|
3333
3075
|
| Properties | Type | Nullable | Description |
|
|
3334
|
-
| ---------- | ---- | -------- | ----------- |
|
|
3335
|
-
| show_beneficiary_details | boolean | no | Show beneficiary details or not. |
|
|
3336
|
-
| beneficiaries | [[OrderBeneficiaryDetails](#OrderBeneficiaryDetails)] | no | All Beneficiaries Of An Order |
|
|
3076
|
+
| ---------- | ---- | -------- | ----------- || add_card_enabled | boolean | no | || aggregator_name | string | no | || anonymous_enable | boolean | no | || display_name | string | yes | || display_priority | number | yes | || is_pay_by_card_pl | boolean | no | || list | [[PaymentModeList](#PaymentModeList)] | no | || name | string | yes | || save_card | boolean | no | |
|
|
3337
3077
|
|
|
3338
3078
|
---
|
|
3339
3079
|
|
|
3340
|
-
|
|
3341
|
-
|
|
3342
|
-
|
|
3343
|
-
#### [MultiTenderPaymentMeta](#MultiTenderPaymentMeta)
|
|
3080
|
+
#### [SaveSubscriptionSetupIntentRequest](#SaveSubscriptionSetupIntentRequest)
|
|
3344
3081
|
|
|
3345
3082
|
| Properties | Type | Nullable | Description |
|
|
3346
|
-
| ---------- | ---- | -------- | ----------- |
|
|
3347
|
-
| extra_meta | string | no | |
|
|
3348
|
-
| order_id | string | no | |
|
|
3349
|
-
| payment_id | string | no | |
|
|
3350
|
-
| current_status | string | no | |
|
|
3351
|
-
| payment_gateway | string | no | |
|
|
3083
|
+
| ---------- | ---- | -------- | ----------- || unique_external_id | string | yes | |
|
|
3352
3084
|
|
|
3353
3085
|
---
|
|
3354
3086
|
|
|
3355
|
-
|
|
3356
|
-
|
|
3357
|
-
|
|
3358
|
-
#### [MultiTenderPaymentMethod](#MultiTenderPaymentMethod)
|
|
3087
|
+
#### [SaveSubscriptionSetupIntentResponse](#SaveSubscriptionSetupIntentResponse)
|
|
3359
3088
|
|
|
3360
3089
|
| Properties | Type | Nullable | Description |
|
|
3361
|
-
| ---------- | ---- | -------- | ----------- |
|
|
3362
|
-
| name | string | no | Payment mode name |
|
|
3363
|
-
| meta | [MultiTenderPaymentMeta](#MultiTenderPaymentMeta) | no | |
|
|
3364
|
-
| amount | number | yes | Payment amount |
|
|
3365
|
-
| mode | string | yes | |
|
|
3090
|
+
| ---------- | ---- | -------- | ----------- || data | string | yes | || success | boolean | yes | |
|
|
3366
3091
|
|
|
3367
3092
|
---
|
|
3368
3093
|
|
|
3369
|
-
|
|
3370
|
-
|
|
3371
|
-
|
|
3372
|
-
#### [PaymentConfirmationRequest](#PaymentConfirmationRequest)
|
|
3094
|
+
#### [SetCODForUserRequest](#SetCODForUserRequest)
|
|
3373
3095
|
|
|
3374
3096
|
| Properties | Type | Nullable | Description |
|
|
3375
|
-
| ---------- | ---- | -------- | ----------- |
|
|
3376
|
-
| payment_methods | [[MultiTenderPaymentMethod](#MultiTenderPaymentMethod)] | yes | |
|
|
3377
|
-
| order_id | string | yes | Unique order id |
|
|
3097
|
+
| ---------- | ---- | -------- | ----------- || is_active | boolean | yes | || merchant_user_id | string | yes | || mobileno | string | yes | |
|
|
3378
3098
|
|
|
3379
3099
|
---
|
|
3380
3100
|
|
|
3381
|
-
|
|
3382
|
-
|
|
3383
|
-
|
|
3384
|
-
#### [PaymentConfirmationResponse](#PaymentConfirmationResponse)
|
|
3101
|
+
#### [SetCODOptionResponse](#SetCODOptionResponse)
|
|
3385
3102
|
|
|
3386
3103
|
| Properties | Type | Nullable | Description |
|
|
3387
|
-
| ---------- | ---- | -------- | ----------- |
|
|
3388
|
-
| order_id | string | yes | Unique order id |
|
|
3389
|
-
| message | string | yes | Message |
|
|
3390
|
-
| success | boolean | yes | Payment confirmation updated or not. |
|
|
3104
|
+
| ---------- | ---- | -------- | ----------- || message | string | yes | || success | boolean | yes | |
|
|
3391
3105
|
|
|
3392
3106
|
---
|
|
3393
3107
|
|
|
3394
|
-
|
|
3395
|
-
|
|
3396
|
-
|
|
3397
|
-
#### [CODdata](#CODdata)
|
|
3108
|
+
#### [SubscriptionConfigResponse](#SubscriptionConfigResponse)
|
|
3398
3109
|
|
|
3399
3110
|
| Properties | Type | Nullable | Description |
|
|
3400
|
-
| ---------- | ---- | -------- | ----------- |
|
|
3401
|
-
| user_id | string | yes | Payment mode name |
|
|
3402
|
-
| usages | number | yes | Used COD limit from the user Limit |
|
|
3403
|
-
| remaining_limit | number | yes | Remaining Limit for COD of User |
|
|
3404
|
-
| is_active | boolean | yes | COD option is active or not |
|
|
3405
|
-
| limit | number | yes | Total Limit of user |
|
|
3111
|
+
| ---------- | ---- | -------- | ----------- || aggregator | string | yes | || config | string | yes | || success | boolean | yes | |
|
|
3406
3112
|
|
|
3407
3113
|
---
|
|
3408
3114
|
|
|
3409
|
-
|
|
3410
|
-
|
|
3411
|
-
|
|
3412
|
-
#### [GetUserCODLimitResponse](#GetUserCODLimitResponse)
|
|
3115
|
+
#### [SubscriptionPaymentMethodResponse](#SubscriptionPaymentMethodResponse)
|
|
3413
3116
|
|
|
3414
3117
|
| Properties | Type | Nullable | Description |
|
|
3415
|
-
| ---------- | ---- | -------- | ----------- |
|
|
3416
|
-
| user_cod_data | [CODdata](#CODdata) | yes | User COD Data |
|
|
3417
|
-
| success | boolean | yes | Response is successful or not |
|
|
3118
|
+
| ---------- | ---- | -------- | ----------- || data | [string] | yes | || success | boolean | yes | |
|
|
3418
3119
|
|
|
3419
3120
|
---
|
|
3420
3121
|
|
|
3421
|
-
|
|
3422
|
-
|
|
3423
|
-
|
|
3424
|
-
#### [SetCODForUserRequest](#SetCODForUserRequest)
|
|
3122
|
+
#### [UpdatePayoutRequest](#UpdatePayoutRequest)
|
|
3425
3123
|
|
|
3426
3124
|
| Properties | Type | Nullable | Description |
|
|
3427
|
-
| ---------- | ---- | -------- | ----------- |
|
|
3428
|
-
| mobileno | string | yes | Mobile No. of User |
|
|
3429
|
-
| merchant_user_id | string | yes | Merchant User id |
|
|
3430
|
-
| is_active | boolean | yes | either true or false |
|
|
3125
|
+
| ---------- | ---- | -------- | ----------- || is_active | boolean | yes | || is_default | boolean | yes | || unique_external_id | string | yes | |
|
|
3431
3126
|
|
|
3432
3127
|
---
|
|
3433
3128
|
|
|
3434
|
-
|
|
3435
|
-
|
|
3436
|
-
|
|
3437
|
-
#### [SetCODOptionResponse](#SetCODOptionResponse)
|
|
3129
|
+
#### [UpdatePayoutResponse](#UpdatePayoutResponse)
|
|
3438
3130
|
|
|
3439
3131
|
| Properties | Type | Nullable | Description |
|
|
3440
|
-
| ---------- | ---- | -------- | ----------- |
|
|
3441
|
-
| message | string | yes | Message |
|
|
3442
|
-
| success | boolean | yes | Response is successful or not |
|
|
3132
|
+
| ---------- | ---- | -------- | ----------- || is_active | boolean | yes | || is_default | boolean | yes | || success | boolean | yes | |
|
|
3443
3133
|
|
|
3444
3134
|
---
|
|
3445
3135
|
|