@gofynd/fdk-client-javascript 1.0.0 → 1.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (104) hide show
  1. package/documentation/application/CATALOG.md +371 -371
  2. package/documentation/application/ORDER.md +272 -272
  3. package/documentation/application/PAYMENT.md +269 -269
  4. package/documentation/platform/CATALOG.md +1678 -1664
  5. package/documentation/platform/COMPANYPROFILE.md +201 -201
  6. package/documentation/platform/ORDER.md +1442 -1323
  7. package/documentation/platform/PAYMENT.md +88 -88
  8. package/index.js +7 -1
  9. package/package.json +1 -1
  10. package/sdk/application/Cart/CartApplicationClient.js +302 -0
  11. package/sdk/application/Cart/CartApplicationValidator.js +1 -0
  12. package/sdk/application/Catalog/CatalogApplicationClient.js +378 -0
  13. package/sdk/application/Catalog/CatalogApplicationModel.d.ts +17 -17
  14. package/sdk/application/Catalog/CatalogApplicationModel.js +500 -500
  15. package/sdk/application/Catalog/CatalogApplicationValidator.js +1 -0
  16. package/sdk/application/Common/CommonApplicationClient.js +22 -0
  17. package/sdk/application/Common/CommonApplicationValidator.js +1 -0
  18. package/sdk/application/Communication/CommunicationApplicationClient.js +41 -0
  19. package/sdk/application/Communication/CommunicationApplicationValidator.js +1 -0
  20. package/sdk/application/Configuration/ConfigurationApplicationClient.js +200 -0
  21. package/sdk/application/Configuration/ConfigurationApplicationValidator.js +1 -0
  22. package/sdk/application/Content/ContentApplicationClient.js +215 -0
  23. package/sdk/application/Content/ContentApplicationValidator.js +1 -0
  24. package/sdk/application/FileStorage/FileStorageApplicationClient.js +33 -0
  25. package/sdk/application/FileStorage/FileStorageApplicationValidator.js +1 -0
  26. package/sdk/application/Lead/LeadApplicationClient.js +81 -0
  27. package/sdk/application/Lead/LeadApplicationValidator.js +1 -0
  28. package/sdk/application/Logistic/LogisticApplicationClient.js +44 -0
  29. package/sdk/application/Logistic/LogisticApplicationValidator.js +1 -0
  30. package/sdk/application/Order/OrderApplicationClient.js +146 -0
  31. package/sdk/application/Order/OrderApplicationModel.d.ts +20 -20
  32. package/sdk/application/Order/OrderApplicationModel.js +329 -329
  33. package/sdk/application/Order/OrderApplicationValidator.js +1 -0
  34. package/sdk/application/Payment/PaymentApplicationClient.js +528 -0
  35. package/sdk/application/Payment/PaymentApplicationModel.d.ts +5 -5
  36. package/sdk/application/Payment/PaymentApplicationModel.js +391 -391
  37. package/sdk/application/Payment/PaymentApplicationValidator.js +1 -0
  38. package/sdk/application/PosCart/PosCartApplicationClient.js +329 -0
  39. package/sdk/application/PosCart/PosCartApplicationValidator.js +1 -0
  40. package/sdk/application/Rewards/RewardsApplicationClient.js +81 -0
  41. package/sdk/application/Rewards/RewardsApplicationValidator.js +1 -0
  42. package/sdk/application/Share/ShareApplicationClient.js +87 -0
  43. package/sdk/application/Share/ShareApplicationValidator.js +1 -0
  44. package/sdk/application/Theme/ThemeApplicationClient.js +44 -0
  45. package/sdk/application/Theme/ThemeApplicationValidator.js +1 -0
  46. package/sdk/application/User/UserApplicationClient.js +405 -0
  47. package/sdk/application/User/UserApplicationValidator.js +1 -0
  48. package/sdk/common/AxiosHelper.js +1 -1
  49. package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.js +114 -0
  50. package/sdk/platform/Analytics/AnalyticsPlatformClient.js +58 -0
  51. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +46 -0
  52. package/sdk/platform/Billing/BillingPlatformClient.js +160 -0
  53. package/sdk/platform/Cart/CartPlatformApplicationClient.js +246 -0
  54. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +29 -29
  55. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +839 -48
  56. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +3 -3
  57. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +9 -9
  58. package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +54 -54
  59. package/sdk/platform/Catalog/CatalogPlatformClient.js +1149 -96
  60. package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +58 -57
  61. package/sdk/platform/Catalog/CatalogPlatformModel.js +1626 -1614
  62. package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +6 -6
  63. package/sdk/platform/Catalog/CatalogPlatformValidator.js +20 -20
  64. package/sdk/platform/Common/CommonPlatformClient.js +26 -0
  65. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +587 -0
  66. package/sdk/platform/Communication/CommunicationPlatformClient.js +15 -0
  67. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +179 -0
  68. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +11 -11
  69. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +269 -269
  70. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +382 -0
  71. package/sdk/platform/Configuration/ConfigurationPlatformClient.js +282 -0
  72. package/sdk/platform/Content/ContentPlatformApplicationClient.js +866 -0
  73. package/sdk/platform/Discount/DiscountPlatformClient.js +152 -0
  74. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +54 -0
  75. package/sdk/platform/FileStorage/FileStoragePlatformClient.js +76 -0
  76. package/sdk/platform/Inventory/InventoryPlatformClient.js +161 -0
  77. package/sdk/platform/Lead/LeadPlatformApplicationClient.js +162 -0
  78. package/sdk/platform/Lead/LeadPlatformClient.js +140 -0
  79. package/sdk/platform/Order/OrderPlatformApplicationClient.js +55 -0
  80. package/sdk/platform/Order/OrderPlatformClient.d.ts +15 -6
  81. package/sdk/platform/Order/OrderPlatformClient.js +674 -15
  82. package/sdk/platform/Order/OrderPlatformModel.d.ts +67 -60
  83. package/sdk/platform/Order/OrderPlatformModel.js +1559 -1623
  84. package/sdk/platform/Order/OrderPlatformValidator.d.ts +2 -1
  85. package/sdk/platform/Order/OrderPlatformValidator.js +10 -4
  86. package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +26 -0
  87. package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +165 -0
  88. package/sdk/platform/Payment/PaymentPlatformClient.js +139 -0
  89. package/sdk/platform/Payment/PaymentPlatformModel.js +137 -137
  90. package/sdk/platform/PlatformApplicationClient.d.ts +2217 -2243
  91. package/sdk/platform/PlatformApplicationClient.js +2514 -2524
  92. package/sdk/platform/PlatformClient.d.ts +2217 -2243
  93. package/sdk/platform/PlatformClient.js +2514 -2524
  94. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +169 -0
  95. package/sdk/platform/Share/SharePlatformApplicationClient.js +53 -0
  96. package/sdk/platform/Theme/ThemePlatformApplicationClient.js +293 -0
  97. package/sdk/platform/User/UserPlatformApplicationClient.js +145 -0
  98. package/sdk/platform/Webhook/WebhookPlatformClient.js +90 -0
  99. package/sdk/public/Configuration/ConfigurationPublicClient.js +25 -0
  100. package/sdk/public/Configuration/ConfigurationPublicValidator.js +3 -1
  101. package/sdk/public/Inventory/InventoryPublicClient.js +75 -0
  102. package/sdk/public/Inventory/InventoryPublicValidator.js +3 -1
  103. package/sdk/public/Webhook/WebhookPublicClient.js +29 -0
  104. package/sdk/public/Webhook/WebhookPublicValidator.js +3 -1
@@ -3824,16 +3824,16 @@ Success. Returns the status of payment. Check the example shown below or refer `
3824
3824
 
3825
3825
  | Properties | Type | Nullable | Description |
3826
3826
  | ---------- | ---- | -------- | ----------- |
3827
- | config_type | string | yes | Fynd or self payment gateway |
3828
- | key | string | yes | Payment gateway api key |
3829
- | verify_api | string | no | Payment gateway verify payment api endpoint |
3830
3827
  | pin | string | no | Masked pin |
3831
- | secret | string | yes | Masked payment gateway api secret |
3832
3828
  | merchant_id | string | no | Unique merchant id |
3829
+ | secret | string | yes | Masked payment gateway api secret |
3833
3830
  | user_id | string | no | Registered User id |
3834
3831
  | sdk | boolean | no | SDK |
3835
3832
  | api | string | no | Payment gateway api endpoint |
3836
3833
  | merchant_key | string | no | Unique merchant key |
3834
+ | config_type | string | yes | Fynd or self payment gateway |
3835
+ | key | string | yes | Payment gateway api key |
3836
+ | verify_api | string | no | Payment gateway verify payment api endpoint |
3837
3837
 
3838
3838
  ---
3839
3839
 
@@ -3844,16 +3844,16 @@ Success. Returns the status of payment. Check the example shown below or refer `
3844
3844
 
3845
3845
  | Properties | Type | Nullable | Description |
3846
3846
  | ---------- | ---- | -------- | ----------- |
3847
+ | razorpay | [AggregatorConfigDetail](#AggregatorConfigDetail) | no | |
3847
3848
  | env | string | yes | Environment i.e Live or Test |
3848
- | ccavenue | [AggregatorConfigDetail](#AggregatorConfigDetail) | no | |
3849
- | juspay | [AggregatorConfigDetail](#AggregatorConfigDetail) | no | |
3849
+ | success | boolean | yes | |
3850
+ | rupifi | [AggregatorConfigDetail](#AggregatorConfigDetail) | no | |
3850
3851
  | mswipe | [AggregatorConfigDetail](#AggregatorConfigDetail) | no | |
3851
- | razorpay | [AggregatorConfigDetail](#AggregatorConfigDetail) | no | |
3852
- | simpl | [AggregatorConfigDetail](#AggregatorConfigDetail) | no | |
3853
3852
  | payumoney | [AggregatorConfigDetail](#AggregatorConfigDetail) | no | |
3853
+ | juspay | [AggregatorConfigDetail](#AggregatorConfigDetail) | no | |
3854
+ | simpl | [AggregatorConfigDetail](#AggregatorConfigDetail) | no | |
3854
3855
  | stripe | [AggregatorConfigDetail](#AggregatorConfigDetail) | no | |
3855
- | success | boolean | yes | |
3856
- | rupifi | [AggregatorConfigDetail](#AggregatorConfigDetail) | no | |
3856
+ | ccavenue | [AggregatorConfigDetail](#AggregatorConfigDetail) | no | |
3857
3857
 
3858
3858
  ---
3859
3859
 
@@ -3876,8 +3876,8 @@ Success. Returns the status of payment. Check the example shown below or refer `
3876
3876
 
3877
3877
  | Properties | Type | Nullable | Description |
3878
3878
  | ---------- | ---- | -------- | ----------- |
3879
- | success | boolean | yes | Response is successful or not |
3880
3879
  | error | [ErrorCodeAndDescription](#ErrorCodeAndDescription) | yes | |
3880
+ | success | boolean | yes | Response is successful or not |
3881
3881
 
3882
3882
  ---
3883
3883
 
@@ -3889,8 +3889,8 @@ Success. Returns the status of payment. Check the example shown below or refer `
3889
3889
  | Properties | Type | Nullable | Description |
3890
3890
  | ---------- | ---- | -------- | ----------- |
3891
3891
  | card_id | string | yes | Card token of payment gateway. |
3892
- | nickname | string | no | |
3893
3892
  | name_on_card | string | no | |
3893
+ | nickname | string | no | |
3894
3894
  | refresh | boolean | no | Refresh cache flag. |
3895
3895
 
3896
3896
  ---
@@ -3903,8 +3903,8 @@ Success. Returns the status of payment. Check the example shown below or refer `
3903
3903
  | Properties | Type | Nullable | Description |
3904
3904
  | ---------- | ---- | -------- | ----------- |
3905
3905
  | data | string | yes | List of cards of customer. |
3906
- | success | boolean | yes | Response is successful or not. |
3907
3906
  | message | string | no | Human readable message. |
3907
+ | success | boolean | yes | Response is successful or not. |
3908
3908
 
3909
3909
  ---
3910
3910
 
@@ -3929,8 +3929,8 @@ Success. Returns the status of payment. Check the example shown below or refer `
3929
3929
  | Properties | Type | Nullable | Description |
3930
3930
  | ---------- | ---- | -------- | ----------- |
3931
3931
  | cards | [CardPaymentGateway](#CardPaymentGateway) | yes | Card's payment gateway with customer id. |
3932
- | success | boolean | yes | Response is successful or not. |
3933
3932
  | message | string | yes | Human readable message. |
3933
+ | success | boolean | yes | Response is successful or not. |
3934
3934
 
3935
3935
  ---
3936
3936
 
@@ -3941,23 +3941,23 @@ Success. Returns the status of payment. Check the example shown below or refer `
3941
3941
 
3942
3942
  | Properties | Type | Nullable | Description |
3943
3943
  | ---------- | ---- | -------- | ----------- |
3944
- | card_reference | string | no | card_reference |
3945
- | card_fingerprint | string | no | card_fingerprint |
3946
3944
  | card_isin | string | no | card_isin |
3947
- | card_brand | string | no | card_brand |
3948
- | compliant_with_tokenisation_guidelines | boolean | no | If card is tokenised or not |
3949
3945
  | exp_year | number | no | exp_year |
3950
- | aggregator_name | string | yes | aggregator_name |
3951
- | card_issuer | string | no | card_issuer |
3946
+ | compliant_with_tokenisation_guidelines | boolean | no | If card is tokenised or not |
3952
3947
  | nickname | string | no | nickname |
3953
- | card_token | string | no | card_token |
3954
- | card_name | string | no | card_name |
3955
3948
  | expired | boolean | no | expired |
3956
- | exp_month | number | no | exp_month |
3949
+ | card_reference | string | no | card_reference |
3950
+ | card_fingerprint | string | no | card_fingerprint |
3957
3951
  | card_brand_image | string | no | card_brand_image |
3952
+ | aggregator_name | string | yes | aggregator_name |
3953
+ | card_token | string | no | card_token |
3958
3954
  | card_number | string | no | card_number |
3959
- | card_id | string | no | card_id |
3960
3955
  | card_type | string | no | card_type |
3956
+ | card_issuer | string | no | card_issuer |
3957
+ | card_brand | string | no | card_brand |
3958
+ | exp_month | number | no | exp_month |
3959
+ | card_id | string | no | card_id |
3960
+ | card_name | string | no | card_name |
3961
3961
 
3962
3962
  ---
3963
3963
 
@@ -3969,8 +3969,8 @@ Success. Returns the status of payment. Check the example shown below or refer `
3969
3969
  | Properties | Type | Nullable | Description |
3970
3970
  | ---------- | ---- | -------- | ----------- |
3971
3971
  | data | [[Card](#Card)] | no | List of cards of customer. |
3972
- | success | boolean | yes | Response is successful or not. |
3973
3972
  | message | string | yes | Human readable message. |
3973
+ | success | boolean | yes | Response is successful or not. |
3974
3974
 
3975
3975
  ---
3976
3976
 
@@ -3992,8 +3992,8 @@ Success. Returns the status of payment. Check the example shown below or refer `
3992
3992
 
3993
3993
  | Properties | Type | Nullable | Description |
3994
3994
  | ---------- | ---- | -------- | ----------- |
3995
- | success | boolean | yes | Response is successful or not. |
3996
3995
  | message | string | no | Human readable message. |
3996
+ | success | boolean | yes | Response is successful or not. |
3997
3997
 
3998
3998
  ---
3999
3999
 
@@ -4004,14 +4004,14 @@ Success. Returns the status of payment. Check the example shown below or refer `
4004
4004
 
4005
4005
  | Properties | Type | Nullable | Description |
4006
4006
  | ---------- | ---- | -------- | ----------- |
4007
- | merchant_params | string | no | Extra meta fields. |
4008
- | transaction_amount_in_paise | number | yes | Payable amount in paise |
4007
+ | order_items | [string] | no | Extra meta fields. |
4009
4008
  | phone_number | string | yes | User mobile number without country code. |
4010
- | aggregator | string | yes | Payment gateway name in camel case i.e Simpl, Rupifi |
4011
- | billing_address | string | no | Extra meta fields. |
4009
+ | merchant_params | string | no | Extra meta fields. |
4012
4010
  | payload | string | no | Hashed payload string. |
4013
- | order_items | [string] | no | Extra meta fields. |
4014
4011
  | delivery_address | string | no | Extra meta fields. |
4012
+ | aggregator | string | yes | Payment gateway name in camel case i.e Simpl, Rupifi |
4013
+ | transaction_amount_in_paise | number | yes | Payable amount in paise |
4014
+ | billing_address | string | no | Extra meta fields. |
4015
4015
 
4016
4016
  ---
4017
4017
 
@@ -4023,8 +4023,8 @@ Success. Returns the status of payment. Check the example shown below or refer `
4023
4023
  | Properties | Type | Nullable | Description |
4024
4024
  | ---------- | ---- | -------- | ----------- |
4025
4025
  | data | string | yes | Payment gateway response data |
4026
- | success | boolean | yes | Response is successful or not |
4027
4026
  | message | string | yes | Error or success message. |
4027
+ | success | boolean | yes | Response is successful or not |
4028
4028
 
4029
4029
  ---
4030
4030
 
@@ -4035,11 +4035,11 @@ Success. Returns the status of payment. Check the example shown below or refer `
4035
4035
 
4036
4036
  | Properties | Type | Nullable | Description |
4037
4037
  | ---------- | ---- | -------- | ----------- |
4038
- | transaction_token | string | no | Transaction token of payment gateway. |
4039
- | aggregator | string | yes | Payment gateway name i.e Simpl, Mswipe |
4040
- | order_id | string | yes | Unique order id. |
4041
4038
  | verified | boolean | no | Already Verified flag from payment gateway i.e Mswipe |
4042
4039
  | amount | number | yes | Chargable amount of order. |
4040
+ | order_id | string | yes | Unique order id. |
4041
+ | transaction_token | string | no | Transaction token of payment gateway. |
4042
+ | aggregator | string | yes | Payment gateway name i.e Simpl, Mswipe |
4043
4043
 
4044
4044
  ---
4045
4045
 
@@ -4050,13 +4050,13 @@ Success. Returns the status of payment. Check the example shown below or refer `
4050
4050
 
4051
4051
  | Properties | Type | Nullable | Description |
4052
4052
  | ---------- | ---- | -------- | ----------- |
4053
- | aggregator | string | yes | Payment gateway name i.e Simpl, Mswipe |
4054
- | order_id | string | yes | Unique order id. |
4053
+ | status | string | yes | Status of charged payment. |
4054
+ | success | boolean | yes | Response is successful or not. |
4055
+ | delivery_address_id | string | no | Delivery adddress id of customer |
4055
4056
  | message | string | yes | Human readable message. |
4057
+ | order_id | string | yes | Unique order id. |
4056
4058
  | cart_id | string | no | Cart id of customer |
4057
- | delivery_address_id | string | no | Delivery adddress id of customer |
4058
- | success | boolean | yes | Response is successful or not. |
4059
- | status | string | yes | Status of charged payment. |
4059
+ | aggregator | string | yes | Payment gateway name i.e Simpl, Mswipe |
4060
4060
 
4061
4061
  ---
4062
4062
 
@@ -4067,18 +4067,18 @@ Success. Returns the status of payment. Check the example shown below or refer `
4067
4067
 
4068
4068
  | Properties | Type | Nullable | Description |
4069
4069
  | ---------- | ---- | -------- | ----------- |
4070
- | email | string | yes | Customer valid email |
4071
- | vpa | string | no | Customer vpa address |
4072
- | aggregator | string | yes | Payment gateway name |
4073
- | merchant_order_id | string | yes | Unique fynd order id |
4074
- | order_id | string | yes | Payment gateway order id |
4075
- | currency | string | yes | Currency code. |
4076
4070
  | timeout | number | no | Payment polling timeout if not recieved response |
4077
- | contact | string | yes | Customer valid mobile number |
4078
- | amount | number | yes | Payable amount. |
4079
4071
  | customer_id | string | yes | Payment gateway customer id. |
4080
4072
  | method | string | yes | Payment method |
4073
+ | vpa | string | no | Customer vpa address |
4074
+ | merchant_order_id | string | yes | Unique fynd order id |
4075
+ | amount | number | yes | Payable amount. |
4076
+ | email | string | yes | Customer valid email |
4077
+ | currency | string | yes | Currency code. |
4078
+ | order_id | string | yes | Payment gateway order id |
4081
4079
  | razorpay_payment_id | string | no | Payment gateway payment id |
4080
+ | aggregator | string | yes | Payment gateway name |
4081
+ | contact | string | yes | Customer valid mobile number |
4082
4082
 
4083
4083
  ---
4084
4084
 
@@ -4089,22 +4089,22 @@ Success. Returns the status of payment. Check the example shown below or refer `
4089
4089
 
4090
4090
  | Properties | Type | Nullable | Description |
4091
4091
  | ---------- | ---- | -------- | ----------- |
4092
+ | customer_id | string | no | Payment gateway customer id. |
4093
+ | status | string | no | Status of payment. |
4094
+ | method | string | yes | Payment method |
4092
4095
  | vpa | string | no | Customer vpa address |
4093
- | polling_url | string | yes | Polling url. |
4094
4096
  | upi_poll_url | string | no | UPI poll url. |
4097
+ | success | boolean | yes | Response is successful or not. |
4095
4098
  | merchant_order_id | string | yes | order id |
4096
- | aggregator | string | yes | Payment gateway name |
4099
+ | aggregator_order_id | string | no | Payment order id |
4100
+ | amount | number | no | Payable amount. |
4101
+ | timeout | number | no | timeout. |
4102
+ | bqr_image | string | no | Bharath qr image url. |
4097
4103
  | virtual_id | string | no | Payment virtual address. |
4098
4104
  | currency | string | no | Currency code. |
4099
- | timeout | number | no | timeout. |
4100
- | amount | number | no | Payable amount. |
4101
- | aggregator_order_id | string | no | Payment order id |
4105
+ | polling_url | string | yes | Polling url. |
4102
4106
  | razorpay_payment_id | string | no | Payment id. |
4103
- | customer_id | string | no | Payment gateway customer id. |
4104
- | success | boolean | yes | Response is successful or not. |
4105
- | bqr_image | string | no | Bharath qr image url. |
4106
- | status | string | no | Status of payment. |
4107
- | method | string | yes | Payment method |
4107
+ | aggregator | string | yes | Payment gateway name |
4108
4108
 
4109
4109
  ---
4110
4110
 
@@ -4115,17 +4115,17 @@ Success. Returns the status of payment. Check the example shown below or refer `
4115
4115
 
4116
4116
  | Properties | Type | Nullable | Description |
4117
4117
  | ---------- | ---- | -------- | ----------- |
4118
- | email | string | yes | Customer valid email |
4118
+ | customer_id | string | yes | Payment gateway customer id. |
4119
+ | status | string | yes | Status of payment. |
4120
+ | method | string | yes | Payment method |
4119
4121
  | vpa | string | yes | Customer vpa address |
4120
- | aggregator | string | yes | Payment gateway name |
4121
4122
  | merchant_order_id | string | yes | Unique fynd order id |
4122
- | order_id | string | yes | Payment gateway order id |
4123
+ | amount | number | yes | Payable amount. |
4124
+ | email | string | yes | Customer valid email |
4123
4125
  | currency | string | yes | Currency code. |
4126
+ | order_id | string | yes | Payment gateway order id |
4127
+ | aggregator | string | yes | Payment gateway name |
4124
4128
  | contact | string | yes | Customer valid mobile number |
4125
- | amount | number | yes | Payable amount. |
4126
- | customer_id | string | yes | Payment gateway customer id. |
4127
- | status | string | yes | Status of payment. |
4128
- | method | string | yes | Payment method |
4129
4129
 
4130
4130
  ---
4131
4131
 
@@ -4136,48 +4136,23 @@ Success. Returns the status of payment. Check the example shown below or refer `
4136
4136
 
4137
4137
  | Properties | Type | Nullable | Description |
4138
4138
  | ---------- | ---- | -------- | ----------- |
4139
- | retry | boolean | yes | Response is successful or not. |
4140
- | aggregator_name | string | yes | Payment gateway name |
4139
+ | status | string | yes | Payment status |
4141
4140
  | redirect_url | string | no | Redirect url |
4142
4141
  | success | boolean | no | Response is successful or not |
4143
- | status | string | yes | Payment status |
4144
-
4145
- ---
4146
-
4147
-
4148
-
4149
-
4150
- #### [AggregatorRoute](#AggregatorRoute)
4151
-
4152
- | Properties | Type | Nullable | Description |
4153
- | ---------- | ---- | -------- | ----------- |
4154
- | payment_flow | string | no | payment_flow |
4155
- | data | string | no | Data |
4156
- | api_link | string | no | api_link |
4157
- | payment_flow_data | string | no | payment_flow_data |
4142
+ | aggregator_name | string | yes | Payment gateway name |
4143
+ | retry | boolean | yes | Response is successful or not. |
4158
4144
 
4159
4145
  ---
4160
4146
 
4161
4147
 
4162
4148
 
4163
4149
 
4164
- #### [PaymentFlow](#PaymentFlow)
4150
+ #### [IntentAppErrorList](#IntentAppErrorList)
4165
4151
 
4166
4152
  | Properties | Type | Nullable | Description |
4167
4153
  | ---------- | ---- | -------- | ----------- |
4168
- | fynd | [AggregatorRoute](#AggregatorRoute) | no | Fynd |
4169
- | bqr_razorpay | [AggregatorRoute](#AggregatorRoute) | no | BQR_Razorpay |
4170
- | juspay | [AggregatorRoute](#AggregatorRoute) | no | Juspay |
4171
- | ccavenue | [AggregatorRoute](#AggregatorRoute) | no | Ccavenue |
4172
- | jiopay | [AggregatorRoute](#AggregatorRoute) | no | Jiopay |
4173
- | mswipe | [AggregatorRoute](#AggregatorRoute) | no | mswipe |
4174
- | upi_razorpay | [AggregatorRoute](#AggregatorRoute) | no | UPI_Razorpay |
4175
- | razorpay | [AggregatorRoute](#AggregatorRoute) | no | Razorpay |
4176
- | simpl | [AggregatorRoute](#AggregatorRoute) | no | simpl |
4177
- | epaylater | [AggregatorRoute](#AggregatorRoute) | no | Epaylater |
4178
- | stripe | [AggregatorRoute](#AggregatorRoute) | no | Stripe |
4179
- | rupifi | [AggregatorRoute](#AggregatorRoute) | no | Rupifi |
4180
- | payubiz | [AggregatorRoute](#AggregatorRoute) | no | Payubiz |
4154
+ | code | string | no | code |
4155
+ | package_name | string | no | package_name |
4181
4156
 
4182
4157
  ---
4183
4158
 
@@ -4200,20 +4175,8 @@ Success. Returns the status of payment. Check the example shown below or refer `
4200
4175
 
4201
4176
  | Properties | Type | Nullable | Description |
4202
4177
  | ---------- | ---- | -------- | ----------- |
4203
- | code | string | no | code |
4204
- | display_name | string | no | display_name |
4205
4178
  | logos | [PaymentModeLogo](#PaymentModeLogo) | no | logos |
4206
- | package_name | string | no | package_name |
4207
-
4208
- ---
4209
-
4210
-
4211
-
4212
-
4213
- #### [IntentAppErrorList](#IntentAppErrorList)
4214
-
4215
- | Properties | Type | Nullable | Description |
4216
- | ---------- | ---- | -------- | ----------- |
4179
+ | display_name | string | no | display_name |
4217
4180
  | code | string | no | code |
4218
4181
  | package_name | string | no | package_name |
4219
4182
 
@@ -4226,39 +4189,39 @@ Success. Returns the status of payment. Check the example shown below or refer `
4226
4189
 
4227
4190
  | Properties | Type | Nullable | Description |
4228
4191
  | ---------- | ---- | -------- | ----------- |
4192
+ | card_number | string | no | card_number |
4193
+ | display_name | string | no | display name |
4229
4194
  | card_issuer | string | no | card_issuer |
4230
- | aggregator_name | string | yes | aggregator_name |
4231
- | card_name | string | no | card_name |
4232
- | expired | boolean | no | expired |
4233
- | name | string | no | name |
4234
- | exp_month | number | no | exp_month |
4235
- | timeout | number | no | timeout |
4236
4195
  | card_brand | string | no | card_brand |
4237
- | card_id | string | no | card_id |
4238
- | intent_app | [[IntentApp](#IntentApp)] | no | intent_app |
4196
+ | intent_flow | boolean | no | intent_flow |
4197
+ | exp_month | number | no | exp_month |
4239
4198
  | intent_app_error_dict_list | [[IntentAppErrorList](#IntentAppErrorList)] | no | intent_app_error_dict_list |
4240
- | retry_count | number | no | retry_count |
4241
4199
  | exp_year | number | no | exp_year |
4242
- | display_priority | number | no | Dispaly Priority |
4243
- | card_token | string | no | card_token |
4244
- | fynd_vpa | string | no | fynd_vpa |
4245
- | cod_limit_per_order | number | no | Cod limit per order |
4246
- | cod_limit | number | no | cod limit |
4247
- | card_type | string | no | card_type |
4248
- | display_name | string | no | display name |
4249
- | card_reference | string | no | card_reference |
4250
- | card_isin | string | no | card_isin |
4251
4200
  | compliant_with_tokenisation_guidelines | boolean | no | If card is tokenised or not |
4201
+ | retry_count | number | no | retry_count |
4252
4202
  | card_brand_image | string | no | card_brand_image |
4253
- | code | string | no | code |
4254
- | card_fingerprint | string | no | card_fingerprint |
4255
- | intent_flow | boolean | no | intent_flow |
4203
+ | card_type | string | no | card_type |
4256
4204
  | logo_url | [PaymentModeLogo](#PaymentModeLogo) | no | Logo |
4257
- | nickname | string | no | nickname |
4205
+ | cod_limit | number | no | cod limit |
4206
+ | code | string | no | code |
4207
+ | timeout | number | no | timeout |
4258
4208
  | merchant_code | string | no | merchant code |
4209
+ | nickname | string | no | nickname |
4210
+ | aggregator_name | string | yes | aggregator_name |
4211
+ | fynd_vpa | string | no | fynd_vpa |
4212
+ | card_id | string | no | card_id |
4213
+ | cod_limit_per_order | number | no | Cod limit per order |
4214
+ | intent_app | [[IntentApp](#IntentApp)] | no | intent_app |
4215
+ | card_isin | string | no | card_isin |
4259
4216
  | remaining_limit | number | no | Remaining limit |
4260
- | card_number | string | no | card_number |
4217
+ | expired | boolean | no | expired |
4218
+ | card_reference | string | no | card_reference |
4219
+ | card_fingerprint | string | no | card_fingerprint |
4261
4220
  | intent_app_error_list | [string] | no | intent_app_error_list |
4221
+ | card_token | string | no | card_token |
4222
+ | display_priority | number | no | Dispaly Priority |
4223
+ | name | string | no | name |
4224
+ | card_name | string | no | card_name |
4262
4225
 
4263
4226
  ---
4264
4227
 
@@ -4269,15 +4232,52 @@ Success. Returns the status of payment. Check the example shown below or refer `
4269
4232
 
4270
4233
  | Properties | Type | Nullable | Description |
4271
4234
  | ---------- | ---- | -------- | ----------- |
4235
+ | is_pay_by_card_pl | boolean | no | This flag will be true in case of Payment link payment through card |
4236
+ | aggregator_name | string | no | Dispaly Priority |
4272
4237
  | display_name | string | yes | Payment mode display name |
4273
4238
  | save_card | boolean | no | Card save or not |
4274
- | add_card_enabled | boolean | no | Annonymous card flag |
4275
- | aggregator_name | string | no | Dispaly Priority |
4276
4239
  | display_priority | number | yes | Dispaly Priority |
4277
4240
  | list | [[PaymentModeList](#PaymentModeList)] | no | Payment mode |
4278
- | name | string | yes | Payment mode name |
4279
- | is_pay_by_card_pl | boolean | no | This flag will be true in case of Payment link payment through card |
4280
4241
  | anonymous_enable | boolean | no | Annonymous card flag |
4242
+ | name | string | yes | Payment mode name |
4243
+ | add_card_enabled | boolean | no | Annonymous card flag |
4244
+
4245
+ ---
4246
+
4247
+
4248
+
4249
+
4250
+ #### [AggregatorRoute](#AggregatorRoute)
4251
+
4252
+ | Properties | Type | Nullable | Description |
4253
+ | ---------- | ---- | -------- | ----------- |
4254
+ | data | string | no | Data |
4255
+ | api_link | string | no | api_link |
4256
+ | payment_flow_data | string | no | payment_flow_data |
4257
+ | payment_flow | string | no | payment_flow |
4258
+
4259
+ ---
4260
+
4261
+
4262
+
4263
+
4264
+ #### [PaymentFlow](#PaymentFlow)
4265
+
4266
+ | Properties | Type | Nullable | Description |
4267
+ | ---------- | ---- | -------- | ----------- |
4268
+ | razorpay | [AggregatorRoute](#AggregatorRoute) | no | Razorpay |
4269
+ | epaylater | [AggregatorRoute](#AggregatorRoute) | no | Epaylater |
4270
+ | jiopay | [AggregatorRoute](#AggregatorRoute) | no | Jiopay |
4271
+ | fynd | [AggregatorRoute](#AggregatorRoute) | no | Fynd |
4272
+ | rupifi | [AggregatorRoute](#AggregatorRoute) | no | Rupifi |
4273
+ | mswipe | [AggregatorRoute](#AggregatorRoute) | no | mswipe |
4274
+ | bqr_razorpay | [AggregatorRoute](#AggregatorRoute) | no | BQR_Razorpay |
4275
+ | juspay | [AggregatorRoute](#AggregatorRoute) | no | Juspay |
4276
+ | simpl | [AggregatorRoute](#AggregatorRoute) | no | simpl |
4277
+ | stripe | [AggregatorRoute](#AggregatorRoute) | no | Stripe |
4278
+ | ccavenue | [AggregatorRoute](#AggregatorRoute) | no | Ccavenue |
4279
+ | upi_razorpay | [AggregatorRoute](#AggregatorRoute) | no | UPI_Razorpay |
4280
+ | payubiz | [AggregatorRoute](#AggregatorRoute) | no | Payubiz |
4281
4281
 
4282
4282
  ---
4283
4283
 
@@ -4288,8 +4288,8 @@ Success. Returns the status of payment. Check the example shown below or refer `
4288
4288
 
4289
4289
  | Properties | Type | Nullable | Description |
4290
4290
  | ---------- | ---- | -------- | ----------- |
4291
- | payment_flows | [PaymentFlow](#PaymentFlow) | yes | payment_flows |
4292
4291
  | payment_option | [[RootPaymentMode](#RootPaymentMode)] | yes | Payment options |
4292
+ | payment_flows | [PaymentFlow](#PaymentFlow) | yes | payment_flows |
4293
4293
 
4294
4294
  ---
4295
4295
 
@@ -4336,9 +4336,9 @@ Success. Returns the status of payment. Check the example shown below or refer `
4336
4336
 
4337
4337
  | Properties | Type | Nullable | Description |
4338
4338
  | ---------- | ---- | -------- | ----------- |
4339
+ | display | boolean | yes | Need to display banner or not |
4339
4340
  | message | string | no | ePayLater message |
4340
4341
  | status | string | no | Epaylater KYC status |
4341
- | display | boolean | yes | Need to display banner or not |
4342
4342
 
4343
4343
  ---
4344
4344
 
@@ -4432,8 +4432,8 @@ Success. Returns the status of payment. Check the example shown below or refer `
4432
4432
  | Properties | Type | Nullable | Description |
4433
4433
  | ---------- | ---- | -------- | ----------- |
4434
4434
  | upi_vpa | string | yes | UPI ID |
4435
- | customer_name | string | yes | Customer Bank |
4436
4435
  | status | string | yes | VALID or INVALID |
4436
+ | customer_name | string | yes | Customer Bank |
4437
4437
  | is_valid | boolean | yes | boolean is true or false. |
4438
4438
 
4439
4439
  ---
@@ -4459,9 +4459,9 @@ Success. Returns the status of payment. Check the example shown below or refer `
4459
4459
  | ---------- | ---- | -------- | ----------- |
4460
4460
  | id | number | yes | |
4461
4461
  | display_name | string | no | Beneficiary Display Name |
4462
- | name | string | yes | Beneficiary Name |
4463
4462
  | logo_small | string | yes | Beneficiary small Logo |
4464
4463
  | logo_large | string | yes | Beneficiary large Logo |
4464
+ | name | string | yes | Beneficiary Name |
4465
4465
 
4466
4466
  ---
4467
4467
 
@@ -4472,8 +4472,8 @@ Success. Returns the status of payment. Check the example shown below or refer `
4472
4472
 
4473
4473
  | Properties | Type | Nullable | Description |
4474
4474
  | ---------- | ---- | -------- | ----------- |
4475
- | display_name | string | yes | Beneficiary Mode Name |
4476
4475
  | items | [[TransferItemsDetails](#TransferItemsDetails)] | no | Beneficiary Mode Items |
4476
+ | display_name | string | yes | Beneficiary Mode Name |
4477
4477
 
4478
4478
  ---
4479
4479
 
@@ -4495,8 +4495,8 @@ Success. Returns the status of payment. Check the example shown below or refer `
4495
4495
 
4496
4496
  | Properties | Type | Nullable | Description |
4497
4497
  | ---------- | ---- | -------- | ----------- |
4498
- | enable | boolean | yes | True for enabling the Transfer Mode |
4499
4498
  | transfer_mode | string | yes | Transfer Mode of the Beneficiary to be added |
4499
+ | enable | boolean | yes | True for enabling the Transfer Mode |
4500
4500
 
4501
4501
  ---
4502
4502
 
@@ -4518,25 +4518,25 @@ Success. Returns the status of payment. Check the example shown below or refer `
4518
4518
 
4519
4519
  | Properties | Type | Nullable | Description |
4520
4520
  | ---------- | ---- | -------- | ----------- |
4521
- | account_holder | string | yes | Account Holder Name |
4522
- | bank_name | string | yes | Bank Name Of Account |
4523
- | modified_on | string | yes | MOdification Date of Beneficiary |
4524
4521
  | address | string | yes | Address of User |
4525
- | ifsc_code | string | yes | Ifsc Code Of Account |
4526
- | account_no | string | yes | Account Number |
4527
- | branch_name | string | no | Branch Name Of Account |
4528
4522
  | email | string | yes | EMail of User |
4529
- | subtitle | string | yes | SHort Title Of Account |
4530
- | created_on | string | yes | Creation Date of Beneficiary |
4531
- | transfer_mode | string | yes | Transfer Mode Of Account |
4532
- | id | number | yes | |
4533
4523
  | display_name | string | yes | Display Name Of Account |
4524
+ | account_holder | string | yes | Account Holder Name |
4534
4525
  | delights_user_name | string | no | User Id Who filled the Beneficiary |
4535
- | is_active | boolean | yes | Boolean Flag whether Beneficiary set or not |
4526
+ | created_on | string | yes | Creation Date of Beneficiary |
4536
4527
  | beneficiary_id | string | yes | Benenficiary Id |
4528
+ | id | number | yes | |
4537
4529
  | title | string | yes | Title Of Account |
4538
4530
  | mobile | string | no | MObile no of User |
4531
+ | modified_on | string | yes | MOdification Date of Beneficiary |
4539
4532
  | comment | string | no | Remarks |
4533
+ | subtitle | string | yes | SHort Title Of Account |
4534
+ | transfer_mode | string | yes | Transfer Mode Of Account |
4535
+ | bank_name | string | yes | Bank Name Of Account |
4536
+ | is_active | boolean | yes | Boolean Flag whether Beneficiary set or not |
4537
+ | ifsc_code | string | yes | Ifsc Code Of Account |
4538
+ | branch_name | string | no | Branch Name Of Account |
4539
+ | account_no | string | yes | Account Number |
4540
4540
 
4541
4541
  ---
4542
4542
 
@@ -4547,8 +4547,8 @@ Success. Returns the status of payment. Check the example shown below or refer `
4547
4547
 
4548
4548
  | Properties | Type | Nullable | Description |
4549
4549
  | ---------- | ---- | -------- | ----------- |
4550
- | show_beneficiary_details | boolean | no | Show beneficiary details or not. |
4551
4550
  | beneficiaries | [[OrderBeneficiaryDetails](#OrderBeneficiaryDetails)] | no | All Beneficiaries Of An Order |
4551
+ | show_beneficiary_details | boolean | no | Show beneficiary details or not. |
4552
4552
 
4553
4553
  ---
4554
4554
 
@@ -4559,9 +4559,9 @@ Success. Returns the status of payment. Check the example shown below or refer `
4559
4559
 
4560
4560
  | Properties | Type | Nullable | Description |
4561
4561
  | ---------- | ---- | -------- | ----------- |
4562
+ | success | boolean | yes | Response is successful or not |
4562
4563
  | code | string | yes | Bad Request Data |
4563
4564
  | description | string | yes | Not Found |
4564
- | success | boolean | yes | Response is successful or not |
4565
4565
 
4566
4566
  ---
4567
4567
 
@@ -4572,9 +4572,9 @@ Success. Returns the status of payment. Check the example shown below or refer `
4572
4572
 
4573
4573
  | Properties | Type | Nullable | Description |
4574
4574
  | ---------- | ---- | -------- | ----------- |
4575
+ | branch_name | string | yes | Branch Name Of Account |
4575
4576
  | bank_name | string | yes | Bank Name Of Account |
4576
4577
  | success | boolean | no | Response is successful or not |
4577
- | branch_name | string | yes | Branch Name Of Account |
4578
4578
 
4579
4579
  ---
4580
4580
 
@@ -4585,9 +4585,9 @@ Success. Returns the status of payment. Check the example shown below or refer `
4585
4585
 
4586
4586
  | Properties | Type | Nullable | Description |
4587
4587
  | ---------- | ---- | -------- | ----------- |
4588
+ | success | boolean | yes | Response is successful or not |
4588
4589
  | code | string | yes | Error descrption code. |
4589
4590
  | description | string | yes | Error human understandable description. |
4590
- | success | boolean | yes | Response is successful or not |
4591
4591
 
4592
4592
  ---
4593
4593
 
@@ -4598,9 +4598,9 @@ Success. Returns the status of payment. Check the example shown below or refer `
4598
4598
 
4599
4599
  | Properties | Type | Nullable | Description |
4600
4600
  | ---------- | ---- | -------- | ----------- |
4601
- | otp | string | yes | Otp sent to the given Mobile No |
4602
4601
  | hash_key | string | yes | Hash key of the beneficiary Id |
4603
4602
  | request_id | string | yes | Request Id sent in |
4603
+ | otp | string | yes | Otp sent to the given Mobile No |
4604
4604
 
4605
4605
  ---
4606
4606
 
@@ -4611,8 +4611,8 @@ Success. Returns the status of payment. Check the example shown below or refer `
4611
4611
 
4612
4612
  | Properties | Type | Nullable | Description |
4613
4613
  | ---------- | ---- | -------- | ----------- |
4614
- | success | boolean | no | Response is successful or not |
4615
4614
  | message | string | yes | Aggregator Response of beneficicary |
4615
+ | success | boolean | no | Response is successful or not |
4616
4616
 
4617
4617
  ---
4618
4618
 
@@ -4623,9 +4623,9 @@ Success. Returns the status of payment. Check the example shown below or refer `
4623
4623
 
4624
4624
  | Properties | Type | Nullable | Description |
4625
4625
  | ---------- | ---- | -------- | ----------- |
4626
- | description | string | yes | Wrong OTP Code |
4627
- | success | string | yes | Response is successful or not |
4628
4626
  | is_verified_flag | boolean | yes | Vefified flag. |
4627
+ | success | string | yes | Response is successful or not |
4628
+ | description | string | yes | Wrong OTP Code |
4629
4629
 
4630
4630
  ---
4631
4631
 
@@ -4636,17 +4636,17 @@ Success. Returns the status of payment. Check the example shown below or refer `
4636
4636
 
4637
4637
  | Properties | Type | Nullable | Description |
4638
4638
  | ---------- | ---- | -------- | ----------- |
4639
+ | vpa | string | no | |
4640
+ | address | string | no | Address of the User |
4641
+ | bank_name | string | yes | Bank Name of the Account |
4639
4642
  | email | string | yes | Email of the Account Holder |
4643
+ | account_holder | string | yes | Name of the Account Holder |
4640
4644
  | mobile | string | yes | Moblie Number of the User |
4641
4645
  | ifsc_code | string | yes | Ifsc Code of the Account |
4642
- | account_holder | string | yes | Name of the Account Holder |
4643
- | bank_name | string | yes | Bank Name of the Account |
4644
- | account_no | string | yes | Account NUmber of the Account Holder |
4645
4646
  | wallet | string | no | |
4646
- | address | string | no | Address of the User |
4647
4647
  | comment | string | no | Remarks added by The user |
4648
- | vpa | string | no | |
4649
4648
  | branch_name | string | yes | Branch Name of the Account |
4649
+ | account_no | string | yes | Account NUmber of the Account Holder |
4650
4650
 
4651
4651
  ---
4652
4652
 
@@ -4658,12 +4658,12 @@ Success. Returns the status of payment. Check the example shown below or refer `
4658
4658
  | Properties | Type | Nullable | Description |
4659
4659
  | ---------- | ---- | -------- | ----------- |
4660
4660
  | shipment_id | string | yes | Shipment Id of the respective Merchant Order Id |
4661
- | order_id | string | yes | Merchant Order Id |
4662
- | transfer_mode | string | yes | Transfer Mode of the Beneficiary to be added |
4663
- | otp | string | no | |
4664
4661
  | request_id | string | no | |
4662
+ | order_id | string | yes | Merchant Order Id |
4665
4663
  | delights | boolean | yes | True if beneficiary to be added by delights or False if by User |
4666
4664
  | details | [BeneficiaryModeDetails](#BeneficiaryModeDetails) | yes | Beneficiary bank details |
4665
+ | transfer_mode | string | yes | Transfer Mode of the Beneficiary to be added |
4666
+ | otp | string | no | |
4667
4667
 
4668
4668
  ---
4669
4669
 
@@ -4674,10 +4674,10 @@ Success. Returns the status of payment. Check the example shown below or refer `
4674
4674
 
4675
4675
  | Properties | Type | Nullable | Description |
4676
4676
  | ---------- | ---- | -------- | ----------- |
4677
+ | is_verified_flag | boolean | no | |
4677
4678
  | data | string | no | Refund account data. |
4678
- | success | boolean | yes | Success or failure flag. |
4679
4679
  | message | string | yes | Response message |
4680
- | is_verified_flag | boolean | no | |
4680
+ | success | boolean | yes | Success or failure flag. |
4681
4681
 
4682
4682
  ---
4683
4683
 
@@ -4688,11 +4688,11 @@ Success. Returns the status of payment. Check the example shown below or refer `
4688
4688
 
4689
4689
  | Properties | Type | Nullable | Description |
4690
4690
  | ---------- | ---- | -------- | ----------- |
4691
- | account_holder | string | yes | |
4692
4691
  | bank_name | string | yes | |
4693
- | account_no | string | yes | |
4692
+ | account_holder | string | yes | |
4694
4693
  | ifsc_code | string | yes | |
4695
4694
  | branch_name | string | yes | |
4695
+ | account_no | string | yes | |
4696
4696
 
4697
4697
  ---
4698
4698
 
@@ -4727,9 +4727,9 @@ Success. Returns the status of payment. Check the example shown below or refer `
4727
4727
 
4728
4728
  | Properties | Type | Nullable | Description |
4729
4729
  | ---------- | ---- | -------- | ----------- |
4730
+ | is_verified_flag | string | yes | Boolean Flag whether OTP Validation is already done or not |
4730
4731
  | success | boolean | no | Response is successful or not |
4731
4732
  | request_id | string | yes | request id |
4732
- | is_verified_flag | string | yes | Boolean Flag whether OTP Validation is already done or not |
4733
4733
 
4734
4734
  ---
4735
4735
 
@@ -4765,14 +4765,14 @@ Success. Returns the status of payment. Check the example shown below or refer `
4765
4765
  | Properties | Type | Nullable | Description |
4766
4766
  | ---------- | ---- | -------- | ----------- |
4767
4767
  | payment_link_url | string | no | Url of payment link |
4768
- | polling_timeout | number | no | Polling request timeout |
4769
- | external_order_id | string | no | Merchant order id |
4770
- | payment_link_current_status | string | no | Status of payment link |
4771
- | status_code | number | yes | HTTP status code |
4772
- | amount | number | no | Total value of order |
4773
- | merchant_name | string | no | Merchant name |
4774
4768
  | success | boolean | yes | Successful or failure |
4769
+ | amount | number | no | Total value of order |
4770
+ | payment_link_current_status | string | no | Status of payment link |
4775
4771
  | message | string | yes | Message |
4772
+ | merchant_name | string | no | Merchant name |
4773
+ | external_order_id | string | no | Merchant order id |
4774
+ | status_code | number | yes | HTTP status code |
4775
+ | polling_timeout | number | no | Polling request timeout |
4776
4776
 
4777
4777
  ---
4778
4778
 
@@ -4783,12 +4783,12 @@ Success. Returns the status of payment. Check the example shown below or refer `
4783
4783
 
4784
4784
  | Properties | Type | Nullable | Description |
4785
4785
  | ---------- | ---- | -------- | ----------- |
4786
- | merchant_order_id | string | no | Order id |
4787
4786
  | payment_transaction_id | string | no | Payment transaction id |
4788
4787
  | expired | boolean | no | Payment link expired or not |
4789
- | merchant_name | string | no | Name of merchant that created payment link |
4788
+ | merchant_order_id | string | no | Order id |
4790
4789
  | amount | number | no | Amount paid |
4791
4790
  | msg | string | no | Message |
4791
+ | merchant_name | string | no | Name of merchant that created payment link |
4792
4792
  | cancelled | boolean | no | Payment link is cancelled or not |
4793
4793
  | invalid_id | boolean | no | Payment link id is valid or not |
4794
4794
 
@@ -4802,9 +4802,9 @@ Success. Returns the status of payment. Check the example shown below or refer `
4802
4802
  | Properties | Type | Nullable | Description |
4803
4803
  | ---------- | ---- | -------- | ----------- |
4804
4804
  | error | [ErrorDescription](#ErrorDescription) | no | |
4805
- | success | boolean | yes | Successful or failure |
4806
4805
  | status_code | number | yes | HTTP status code |
4807
4806
  | message | string | yes | Message |
4807
+ | success | boolean | yes | Successful or failure |
4808
4808
 
4809
4809
  ---
4810
4810
 
@@ -4815,11 +4815,11 @@ Success. Returns the status of payment. Check the example shown below or refer `
4815
4815
 
4816
4816
  | Properties | Type | Nullable | Description |
4817
4817
  | ---------- | ---- | -------- | ----------- |
4818
+ | amount | string | yes | |
4819
+ | pincode | string | yes | |
4818
4820
  | checkout_mode | string | yes | |
4819
4821
  | cart_id | string | yes | |
4820
4822
  | assign_card_id | string | no | |
4821
- | amount | string | yes | |
4822
- | pincode | string | yes | |
4823
4823
 
4824
4824
  ---
4825
4825
 
@@ -4830,12 +4830,12 @@ Success. Returns the status of payment. Check the example shown below or refer `
4830
4830
 
4831
4831
  | Properties | Type | Nullable | Description |
4832
4832
  | ---------- | ---- | -------- | ----------- |
4833
+ | mobile_number | string | yes | Mobile number to which the payment link is to be sent |
4834
+ | amount | number | yes | Total value of order |
4833
4835
  | email | string | yes | Email to which the payment link is to be sent |
4834
- | external_order_id | string | yes | Merchant order id |
4835
4836
  | meta | [CreatePaymentLinkMeta](#CreatePaymentLinkMeta) | yes | Meta |
4837
+ | external_order_id | string | yes | Merchant order id |
4836
4838
  | description | string | no | Merchant order id |
4837
- | amount | number | yes | Total value of order |
4838
- | mobile_number | string | yes | Mobile number to which the payment link is to be sent |
4839
4839
 
4840
4840
  ---
4841
4841
 
@@ -4847,11 +4847,11 @@ Success. Returns the status of payment. Check the example shown below or refer `
4847
4847
  | Properties | Type | Nullable | Description |
4848
4848
  | ---------- | ---- | -------- | ----------- |
4849
4849
  | payment_link_url | string | no | Url of payment link |
4850
- | polling_timeout | number | no | Polling request timeout |
4851
- | status_code | number | yes | HTTP status code |
4852
- | payment_link_id | string | no | Unique id of payment link |
4853
4850
  | success | boolean | yes | Successful or failure |
4854
4851
  | message | string | yes | Message |
4852
+ | status_code | number | yes | HTTP status code |
4853
+ | polling_timeout | number | no | Polling request timeout |
4854
+ | payment_link_id | string | no | Unique id of payment link |
4855
4855
 
4856
4856
  ---
4857
4857
 
@@ -4873,10 +4873,10 @@ Success. Returns the status of payment. Check the example shown below or refer `
4873
4873
 
4874
4874
  | Properties | Type | Nullable | Description |
4875
4875
  | ---------- | ---- | -------- | ----------- |
4876
- | success | boolean | yes | Successful or failure |
4877
4876
  | polling_timeout | number | no | Polling request timeout |
4878
4877
  | status_code | number | yes | HTTP status code |
4879
4878
  | message | string | yes | Message |
4879
+ | success | boolean | yes | Successful or failure |
4880
4880
 
4881
4881
  ---
4882
4882
 
@@ -4887,9 +4887,9 @@ Success. Returns the status of payment. Check the example shown below or refer `
4887
4887
 
4888
4888
  | Properties | Type | Nullable | Description |
4889
4889
  | ---------- | ---- | -------- | ----------- |
4890
- | success | boolean | yes | Successful or failure |
4891
4890
  | status_code | number | yes | HTTP status code |
4892
4891
  | message | string | yes | Message |
4892
+ | success | boolean | yes | Successful or failure |
4893
4893
 
4894
4894
  ---
4895
4895
 
@@ -4900,16 +4900,16 @@ Success. Returns the status of payment. Check the example shown below or refer `
4900
4900
 
4901
4901
  | Properties | Type | Nullable | Description |
4902
4902
  | ---------- | ---- | -------- | ----------- |
4903
- | order_id | string | no | Fynd order id |
4904
- | http_status | number | no | HTTP status code |
4905
- | aggregator_name | string | no | Aggregator name |
4903
+ | status | string | no | Status of payment link |
4904
+ | redirect_url | string | no | Url to redirect to |
4906
4905
  | success | boolean | no | Successful or failure |
4907
- | status_code | number | no | HTTP status code |
4908
4906
  | amount | number | no | Amount |
4909
- | redirect_url | string | no | Url to redirect to |
4910
- | payment_link_id | string | no | Payment link id |
4907
+ | aggregator_name | string | no | Aggregator name |
4911
4908
  | message | string | no | Message |
4912
- | status | string | no | Status of payment link |
4909
+ | http_status | number | no | HTTP status code |
4910
+ | order_id | string | no | Fynd order id |
4911
+ | status_code | number | no | HTTP status code |
4912
+ | payment_link_id | string | no | Payment link id |
4913
4913
 
4914
4914
  ---
4915
4915
 
@@ -4920,9 +4920,9 @@ Success. Returns the status of payment. Check the example shown below or refer `
4920
4920
 
4921
4921
  | Properties | Type | Nullable | Description |
4922
4922
  | ---------- | ---- | -------- | ----------- |
4923
+ | merchant_code | string | yes | Merchant code |
4923
4924
  | payment_identifier | string | yes | Payment identifier |
4924
4925
  | payment_gateway | string | yes | Payment gateway name |
4925
- | merchant_code | string | yes | Merchant code |
4926
4926
 
4927
4927
  ---
4928
4928
 
@@ -4933,8 +4933,8 @@ Success. Returns the status of payment. Check the example shown below or refer `
4933
4933
 
4934
4934
  | Properties | Type | Nullable | Description |
4935
4935
  | ---------- | ---- | -------- | ----------- |
4936
- | meta | [PaymentMethodsMeta](#PaymentMethodsMeta) | yes | Meta |
4937
4936
  | name | string | yes | Payment mode name |
4937
+ | meta | [PaymentMethodsMeta](#PaymentMethodsMeta) | yes | Meta |
4938
4938
  | mode | string | yes | Payment mode |
4939
4939
 
4940
4940
  ---
@@ -4946,11 +4946,11 @@ Success. Returns the status of payment. Check the example shown below or refer `
4946
4946
 
4947
4947
  | Properties | Type | Nullable | Description |
4948
4948
  | ---------- | ---- | -------- | ----------- |
4949
- | payment_methods | [CreateOrderUserPaymentMethods](#CreateOrderUserPaymentMethods) | yes | Payment method details |
4950
- | success_callback_url | string | yes | Success page url |
4951
4949
  | failure_callback_url | string | yes | Failure page url |
4952
- | meta | string | no | Meta |
4950
+ | success_callback_url | string | yes | Success page url |
4953
4951
  | currency | string | yes | Currency |
4952
+ | meta | string | no | Meta |
4953
+ | payment_methods | [CreateOrderUserPaymentMethods](#CreateOrderUserPaymentMethods) | yes | Payment method details |
4954
4954
  | payment_link_id | string | yes | Unique id of payment link |
4955
4955
 
4956
4956
  ---
@@ -4962,16 +4962,16 @@ Success. Returns the status of payment. Check the example shown below or refer `
4962
4962
 
4963
4963
  | Properties | Type | Nullable | Description |
4964
4964
  | ---------- | ---- | -------- | ----------- |
4965
- | email | string | no | Email |
4966
- | aggregator | string | no | Aggregator name |
4965
+ | customer_id | string | no | Aggregator customer id |
4966
+ | method | string | no | Method |
4967
4967
  | merchant_order_id | string | no | Merchant order id |
4968
- | order_id | string | no | Aggregator order id |
4969
- | currency | string | no | Currency |
4970
- | contact | string | no | Mobile number |
4971
4968
  | amount | number | no | Amount |
4972
- | customer_id | string | no | Aggregator customer id |
4969
+ | email | string | no | Email |
4973
4970
  | callback_url | string | no | Callback url for aggregator |
4974
- | method | string | no | Method |
4971
+ | currency | string | no | Currency |
4972
+ | order_id | string | no | Aggregator order id |
4973
+ | aggregator | string | no | Aggregator name |
4974
+ | contact | string | no | Mobile number |
4975
4975
 
4976
4976
  ---
4977
4977
 
@@ -4983,12 +4983,12 @@ Success. Returns the status of payment. Check the example shown below or refer `
4983
4983
  | Properties | Type | Nullable | Description |
4984
4984
  | ---------- | ---- | -------- | ----------- |
4985
4985
  | payment_confirm_url | string | no | Payment confirm url for aggregator |
4986
+ | success | boolean | yes | Successful or failure |
4987
+ | data | [CreateOrderUserData](#CreateOrderUserData) | no | |
4986
4988
  | message | string | yes | Message |
4989
+ | callback_url | string | no | Callback url for aggregator |
4987
4990
  | order_id | string | no | Merchant order id |
4988
4991
  | status_code | number | yes | HTTP status code |
4989
- | data | [CreateOrderUserData](#CreateOrderUserData) | no | |
4990
- | success | boolean | yes | Successful or failure |
4991
- | callback_url | string | no | Callback url for aggregator |
4992
4992
 
4993
4993
  ---
4994
4994
 
@@ -5012,10 +5012,10 @@ Success. Returns the status of payment. Check the example shown below or refer `
5012
5012
 
5013
5013
  | Properties | Type | Nullable | Description |
5014
5014
  | ---------- | ---- | -------- | ----------- |
5015
- | balance | [BalanceDetails](#BalanceDetails) | no | Credit summary of user. |
5016
- | status_message | string | yes | message to customer |
5017
5015
  | status | string | yes | Customer Credit status |
5018
5016
  | merchant_customer_ref_id | string | yes | Unique aggregator customer id |
5017
+ | status_message | string | yes | message to customer |
5018
+ | balance | [BalanceDetails](#BalanceDetails) | no | Credit summary of user. |
5019
5019
 
5020
5020
  ---
5021
5021
 
@@ -5038,8 +5038,8 @@ Success. Returns the status of payment. Check the example shown below or refer `
5038
5038
 
5039
5039
  | Properties | Type | Nullable | Description |
5040
5040
  | ---------- | ---- | -------- | ----------- |
5041
- | signup_url | string | yes | URL to which the user may redirect. |
5042
5041
  | status | boolean | yes | Aggregator's Operation is successful or not. |
5042
+ | signup_url | string | yes | URL to which the user may redirect. |
5043
5043
 
5044
5044
  ---
5045
5045
 
@@ -5062,9 +5062,9 @@ Success. Returns the status of payment. Check the example shown below or refer `
5062
5062
 
5063
5063
  | Properties | Type | Nullable | Description |
5064
5064
  | ---------- | ---- | -------- | ----------- |
5065
+ | status | boolean | yes | Operation is successful or not. |
5065
5066
  | signup_url | string | yes | URL to which the user may redirect. |
5066
5067
  | is_registered | boolean | yes | User is registered with aggregator or not. |
5067
- | status | boolean | yes | Operation is successful or not. |
5068
5068
 
5069
5069
  ---
5070
5070
 
@@ -5087,90 +5087,90 @@ Success. Returns the status of payment. Check the example shown below or refer `
5087
5087
 
5088
5088
  | Properties | Type | Nullable | Description |
5089
5089
  | ---------- | ---- | -------- | ----------- |
5090
- | city | string | yes | City |
5091
- | ownership_type | string | no | Address Owner Type |
5092
- | state | string | yes | State |
5093
- | land_mark | string | no | Land Mark |
5094
- | addressline2 | string | no | Address Line 2 |
5095
5090
  | addressline1 | string | yes | Address Line 1 |
5091
+ | addressline2 | string | no | Address Line 2 |
5092
+ | ownership_type | string | no | Address Owner Type |
5093
+ | city | string | yes | City |
5096
5094
  | pincode | string | yes | Pincode |
5095
+ | land_mark | string | no | Land Mark |
5096
+ | state | string | yes | State |
5097
5097
 
5098
5098
  ---
5099
5099
 
5100
5100
 
5101
5101
 
5102
5102
 
5103
- #### [UserPersonalInfoInDetails](#UserPersonalInfoInDetails)
5103
+ #### [BusinessDetails](#BusinessDetails)
5104
5104
 
5105
5105
  | Properties | Type | Nullable | Description |
5106
5106
  | ---------- | ---- | -------- | ----------- |
5107
- | email | string | no | Email |
5108
- | phone | string | yes | Email |
5109
- | middle_name | string | no | middle Name |
5110
- | fathers_name | string | no | Father's Name |
5111
- | passport | string | no | Passport |
5112
- | driving_license | string | no | Driver License |
5113
- | first_name | string | yes | First Name |
5114
- | voter_id | string | no | Voter ID Number |
5115
- | dob | string | yes | DOB |
5116
- | gender | string | no | Gender |
5117
- | last_name | string | no | Last Name |
5107
+ | fda | string | no | Driver License |
5108
+ | address | [KYCAddress](#KYCAddress) | no | Address details |
5109
+ | fssai | string | no | FDA License Number |
5110
+ | business_type | string | no | Business Type |
5111
+ | vintage | string | no | Vintage |
5118
5112
  | pan | string | no | Pan Number |
5119
- | mothers_name | string | no | Mother's Name |
5120
- | email_verified | boolean | yes | Is Email Verified or not |
5121
- | mobile_verified | boolean | yes | Is Mobile Verified or not |
5122
- | address_as_per_id | [KYCAddress](#KYCAddress) | yes | Address details |
5113
+ | gstin | string | no | GSTIN Number |
5114
+ | shop_and_establishment | string | no | Shop Establishment |
5115
+ | name | string | no | Business Name |
5116
+ | business_ownership_type | string | no | business Ownershipp type(e.g Rented) |
5117
+ | entity_type | string | no | Busineess Entity Type |
5123
5118
 
5124
5119
  ---
5125
5120
 
5126
5121
 
5127
5122
 
5128
5123
 
5129
- #### [DeviceDetails](#DeviceDetails)
5124
+ #### [UserPersonalInfoInDetails](#UserPersonalInfoInDetails)
5130
5125
 
5131
5126
  | Properties | Type | Nullable | Description |
5132
5127
  | ---------- | ---- | -------- | ----------- |
5133
- | device_make | string | no | Device maker |
5134
- | device_type | string | no | Device Type(E.g. Mobile) |
5135
- | os | string | no | OS Name |
5136
- | os_version | string | no | OS Version |
5137
- | device_model | string | no | Device Model |
5138
- | identifier_type | string | no | Static value = ip |
5139
- | identification_number | string | no | IP |
5128
+ | phone | string | yes | Email |
5129
+ | mothers_name | string | no | Mother's Name |
5130
+ | email_verified | boolean | yes | Is Email Verified or not |
5131
+ | fathers_name | string | no | Father's Name |
5132
+ | mobile_verified | boolean | yes | Is Mobile Verified or not |
5133
+ | last_name | string | no | Last Name |
5134
+ | email | string | no | Email |
5135
+ | passport | string | no | Passport |
5136
+ | dob | string | yes | DOB |
5137
+ | pan | string | no | Pan Number |
5138
+ | driving_license | string | no | Driver License |
5139
+ | middle_name | string | no | middle Name |
5140
+ | address_as_per_id | [KYCAddress](#KYCAddress) | yes | Address details |
5141
+ | voter_id | string | no | Voter ID Number |
5142
+ | gender | string | no | Gender |
5143
+ | first_name | string | yes | First Name |
5140
5144
 
5141
5145
  ---
5142
5146
 
5143
5147
 
5144
5148
 
5145
5149
 
5146
- #### [BusinessDetails](#BusinessDetails)
5150
+ #### [MarketplaceInfo](#MarketplaceInfo)
5147
5151
 
5148
5152
  | Properties | Type | Nullable | Description |
5149
5153
  | ---------- | ---- | -------- | ----------- |
5150
- | fssai | string | no | FDA License Number |
5151
- | gstin | string | no | GSTIN Number |
5152
- | fda | string | no | Driver License |
5153
- | business_ownership_type | string | no | business Ownershipp type(e.g Rented) |
5154
- | vintage | string | no | Vintage |
5155
- | name | string | no | Business Name |
5156
- | business_type | string | no | Business Type |
5157
- | entity_type | string | no | Busineess Entity Type |
5158
- | pan | string | no | Pan Number |
5159
- | address | [KYCAddress](#KYCAddress) | no | Address details |
5160
- | shop_and_establishment | string | no | Shop Establishment |
5154
+ | name | string | yes | Name of store |
5155
+ | date_of_joining | string | no | Date of joining |
5156
+ | membership_id | string | yes | merchant id |
5161
5157
 
5162
5158
  ---
5163
5159
 
5164
5160
 
5165
5161
 
5166
5162
 
5167
- #### [MarketplaceInfo](#MarketplaceInfo)
5163
+ #### [DeviceDetails](#DeviceDetails)
5168
5164
 
5169
5165
  | Properties | Type | Nullable | Description |
5170
5166
  | ---------- | ---- | -------- | ----------- |
5171
- | name | string | yes | Name of store |
5172
- | date_of_joining | string | no | Date of joining |
5173
- | membership_id | string | yes | merchant id |
5167
+ | device_make | string | no | Device maker |
5168
+ | os_version | string | no | OS Version |
5169
+ | device_type | string | no | Device Type(E.g. Mobile) |
5170
+ | device_model | string | no | Device Model |
5171
+ | identification_number | string | no | IP |
5172
+ | identifier_type | string | no | Static value = ip |
5173
+ | os | string | no | OS Name |
5174
5174
 
5175
5175
  ---
5176
5176
 
@@ -5181,13 +5181,13 @@ Success. Returns the status of payment. Check the example shown below or refer `
5181
5181
 
5182
5182
  | Properties | Type | Nullable | Description |
5183
5183
  | ---------- | ---- | -------- | ----------- |
5184
- | aggregator | string | yes | Aggregator Name |
5184
+ | business_info | [BusinessDetails](#BusinessDetails) | no | Business summary. |
5185
5185
  | personal_info | [UserPersonalInfoInDetails](#UserPersonalInfoInDetails) | yes | Credit summary of user. |
5186
+ | marketplace_info | [MarketplaceInfo](#MarketplaceInfo) | no | Market Place info. |
5186
5187
  | mcc | string | no | Mcc |
5187
- | device | [DeviceDetails](#DeviceDetails) | no | Device Details. |
5188
- | business_info | [BusinessDetails](#BusinessDetails) | no | Business summary. |
5189
5188
  | source | string | yes | callbackURL |
5190
- | marketplace_info | [MarketplaceInfo](#MarketplaceInfo) | no | Market Place info. |
5189
+ | device | [DeviceDetails](#DeviceDetails) | no | Device Details. |
5190
+ | aggregator | string | yes | Aggregator Name |
5191
5191
 
5192
5192
  ---
5193
5193
 
@@ -5198,8 +5198,8 @@ Success. Returns the status of payment. Check the example shown below or refer `
5198
5198
 
5199
5199
  | Properties | Type | Nullable | Description |
5200
5200
  | ---------- | ---- | -------- | ----------- |
5201
- | redirect_url | string | yes | URL to which the user may redirect. |
5202
5201
  | session | string | yes | User Session |
5202
+ | redirect_url | string | yes | URL to which the user may redirect. |
5203
5203
  | status | boolean | yes | Operation Status |
5204
5204
 
5205
5205
  ---