Generating Java SDK.

README.md

@@ -18,14 +18,14 @@ Try out our interactive guides at [Cashfree Dev Studio](https://www.cashfree.com
 ### Installation
 * Gradle Project
 ```bash
-implementation `com.cashfree.pg.java:cashfree_pg:4.1.4`
+implementation `com.cashfree.pg.java:cashfree_pg:4.2.0`
 ```
 * Maven Project
 ```bash
 <dependency>
   <groupId>com.cashfree.pg.java</groupId>
   <artifactId>cashfree_pg</artifactId>
-  <version>4.1.4</version>
+  <version>4.2.0</version>
   <scope>compile</scope>
 </dependency>
 <dependency>
@@ -80,4 +80,4 @@ try {
 
 ## Licence
 
-Apache Licensed. See [LICENSE.md](LICENSE.md) for more details.
+Apache Licensed. See [LICENSE.md](LICENSE.md) for more details

build.gradle

@@ -6,7 +6,7 @@ apply plugin: 'maven-publish'
 apply plugin: 'signing'
 
 group = 'com.cashfree.pg.java'
-version = '4.1.4'
+version = '4.2.0'
 
 buildscript {
     repositories {
@@ -116,7 +116,7 @@ if(hasProperty('target') && target == 'android') {
 
                 groupId 'com.cashfree.pg.java'
                 artifactId 'cashfree_pg'
-                version '4.1.4'
+                version '4.2.0'
 
                 from components.java
 

build.sbt

@@ -2,7 +2,7 @@ lazy val root = (project in file(".")).
   settings(
     organization := "com.cashfree.pg.java",
     name := "cashfree_pg",
-    version := "4.1.4",
+    version := "4.2.0",
     scalaVersion := "2.11.4",
     scalacOptions ++= Seq("-feature"),
     javacOptions in compile ++= Seq("-Xlint:deprecation"),

docs/AuthorizationDetails.md

@@ -0,0 +1,20 @@
+
+
+# AuthorizationDetails
+
+Details of the authorization done for the subscription. Returned in Get subscription and auth payments.
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**authorizationAmount** | **BigDecimal** | Authorization amount for the auth payment. |  [optional] |
+|**authorizationAmountRefund** | **Boolean** | Indicates whether the authorization amount should be refunded to the customer automatically. Merchants can use this field to specify if the authorized funds should be returned to the customer after authorization of the subscription. |  [optional] |
+|**authorizationReference** | **String** | Authorization reference. UMN for UPI, UMRN for EMandate/Physical Mandate and Enrollment ID for cards. |  [optional] |
+|**authorizationTime** | **String** | Authorization time. |  [optional] |
+|**authorizationStatus** | **String** | Status of the authorization. |  [optional] |
+|**paymentId** | **String** | A unique ID passed by merchant for identifying the transaction. |  [optional] |
+|**paymentMethod** | **String** | Payment method used for the authorization. |  [optional] |
+
+
+

docs/Card.md

@@ -17,7 +17,7 @@ Card Payment method
 |**instrumentId** | **String** | instrument id of saved card. Required only to make payment using saved instrument. |  [optional] |
 |**cryptogram** | **String** | cryptogram received from card network. Required only for tokenized card transactions. |  [optional] |
 |**tokenRequestorId** | **String** | TRID issued by card networks. Required only for tokenized card transactions. |  [optional] |
-|**tokenReferenceId** | **String** | Token Reference Id provided by Diners for Guest Checkout Token.  Required only for Diners cards.  |  [optional] |
+|**tokenReferenceId** | **String** | Token Reference Id provided by Diners for Guest Checkout Token.  Required only for Diners cards. |  [optional] |
 |**tokenType** | [**TokenTypeEnum**](#TokenTypeEnum) |  |  [optional] |
 |**cardDisplay** | **String** | last 4 digits of original card number. Required only for tokenized card transactions. |  [optional] |
 |**cardAlias** | **String** | Card alias as returned by Cashfree Vault API. |  [optional] |

docs/CardlessEMI.md

@@ -9,7 +9,7 @@ Request body for cardless emi payment method
 | Name | Type | Description | Notes |
 |------------ | ------------- | ------------- | -------------|
 |**channel** | **String** | The channel for cardless EMI is always `link` |  [optional] |
-|**provider** | [**ProviderEnum**](#ProviderEnum) | One of [`flexmoney`, `zestmoney`, `hdfc`, `icici`, `cashe`, `idfc`, `kotak`] |  [optional] |
+|**provider** | [**ProviderEnum**](#ProviderEnum) | One of [`flexmoney`, `zestmoney`, `hdfc`, `icici`, `cashe`, `idfc`, `kotak`, `snapmint`, `bharatx`] |  [optional] |
 |**phone** | **String** | Customers phone number for this payment instrument. If the customer is not eligible you will receive a 400 error with type as 'invalid_request_error' and code as 'invalid_request_error' |  [optional] |
 |**emiTenure** | **Integer** | EMI tenure for the selected provider. This is mandatory when provider is one of [`hdfc`, `icici`, `cashe`, `idfc`, `kotak`] |  [optional] |
 
@@ -26,6 +26,8 @@ Request body for cardless emi payment method
 | CASHE | "cashe" |
 | IDFC | "idfc" |
 | KOTAK | "kotak" |
+| SNAPMINT | "snapmint" |
+| BHARATX | "bharatx" |
 | UNKNOWN_DEFAULT_OPEN_API | "unknown_default_open_api" |
 
 

docs/CreateOrderSettlementRequestBody.md

@@ -0,0 +1,15 @@
+
+
+# CreateOrderSettlementRequestBody
+
+Create Order Settlement Object
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**orderId** | **String** | OrderId of the order. |  |
+|**metaData** | [**CreateOrderSettlementRequestBodyMetaData**](CreateOrderSettlementRequestBodyMetaData.md) |  |  |
+
+
+

docs/CreateOrderSettlementRequestBodyMetaData.md

@@ -0,0 +1,14 @@
+
+
+# CreateOrderSettlementRequestBodyMetaData
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**cbriksId** | **String** | Meta data cbricks ID to be used for reporting purpose. |  [optional] |
+|**settlementDate** | **LocalDate** | Requested Settlement Date. |  [optional] |
+
+
+

docs/CreatePlanRequest.md

@@ -0,0 +1,23 @@
+
+
+# CreatePlanRequest
+
+Request body to create a plan.
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**planId** | **String** | Unique ID to identify the plan. Only alpha-numerics, dot, hyphen and underscore allowed. |  |
+|**planName** | **String** | Name of the plan. |  |
+|**planType** | **String** | Type of the plan. Possible values - PERIODIC, ON_DEMAND. |  |
+|**planCurrency** | **String** | Currency of the plan. |  [optional] |
+|**planRecurringAmount** | **BigDecimal** | Recurring amount for the plan. Required for PERIODIC plan_type. |  [optional] |
+|**planMaxAmount** | **BigDecimal** | Maximum amount for the plan. |  |
+|**planMaxCycles** | **Integer** | Maximum number of payment cycles for the plan. |  [optional] |
+|**planIntervals** | **Integer** | Number of billing cycles between charges. For instance, if set to 2 and the interval type is 'week', the service will be billed every 2 weeks. Similarly, if set to 3 and the interval type is 'month', the service will be billed every 3 months. Required for PERIODIC plan_type. |  [optional] |
+|**planIntervalType** | **String** | Interval type for the plan. Possible values - DAY, WEEK, MONTH, YEAR. |  [optional] |
+|**planNote** | **String** | Note for the plan. |  [optional] |
+
+
+

docs/CreateSubscriptionPaymentAuthResponse.md

@@ -0,0 +1,23 @@
+
+
+# CreateSubscriptionPaymentAuthResponse
+
+The response returned in Get, Create or Manage Subscription Payment APIs.
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**cfPaymentId** | **String** | Cashfree subscription payment reference number |  [optional] |
+|**cfSubscriptionId** | **String** | Cashfree subscription reference number |  [optional] |
+|**failureDetails** | [**CreateSubscriptionPaymentAuthResponseFailureDetails**](CreateSubscriptionPaymentAuthResponseFailureDetails.md) |  |  [optional] |
+|**paymentAmount** | **BigDecimal** | The charge amount of the payment. |  [optional] |
+|**paymentId** | **String** | A unique ID passed by merchant for identifying the transaction. |  [optional] |
+|**paymentInitiatedDate** | **String** | The date on which the payment was initiated. |  [optional] |
+|**paymentStatus** | **String** | Status of the payment. |  [optional] |
+|**paymentType** | **String** | Payment type. Can be AUTH or CHARGE. |  [optional] |
+|**subscriptionId** | **String** | A unique ID passed by merchant for identifying the subscription. |  [optional] |
+|**paymentMethod** | **String** | Payment method used for the authorization. |  [optional] |
+
+
+

docs/CreateSubscriptionPaymentAuthResponseFailureDetails.md

@@ -0,0 +1,13 @@
+
+
+# CreateSubscriptionPaymentAuthResponseFailureDetails
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**failureReason** | **String** | Failure reason of the payment if the payment_status is failed. |  [optional] |
+
+
+

docs/CreateSubscriptionPaymentChargeResponse.md

@@ -0,0 +1,23 @@
+
+
+# CreateSubscriptionPaymentChargeResponse
+
+The response returned in Get, Create or Manage Subscription Payment APIs.
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**cfPaymentId** | **String** | Cashfree subscription payment reference number |  [optional] |
+|**cfSubscriptionId** | **String** | Cashfree subscription reference number |  [optional] |
+|**failureDetails** | [**CreateSubscriptionPaymentAuthResponseFailureDetails**](CreateSubscriptionPaymentAuthResponseFailureDetails.md) |  |  [optional] |
+|**paymentAmount** | **BigDecimal** | The charge amount of the payment. |  [optional] |
+|**paymentId** | **String** | A unique ID passed by merchant for identifying the transaction. |  [optional] |
+|**paymentInitiatedDate** | **String** | The date on which the payment was initiated. |  [optional] |
+|**paymentStatus** | **String** | Status of the payment. |  [optional] |
+|**paymentType** | **String** | Payment type. Can be AUTH or CHARGE. |  [optional] |
+|**subscriptionId** | **String** | A unique ID passed by merchant for identifying the subscription. |  [optional] |
+|**paymentMethod** | **String** | Payment method used for the authorization. |  [optional] |
+
+
+

docs/CreateSubscriptionPaymentRequest.md

@@ -0,0 +1,21 @@
+
+
+# CreateSubscriptionPaymentRequest
+
+The request to be passed for the create subscription payment API.
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**subscriptionId** | **String** | A unique ID passed by merchant for identifying the subscription. |  |
+|**subscriptionSessionId** | **String** | Session ID for the subscription. Required only for Auth. |  [optional] |
+|**paymentId** | **String** | A unique ID passed by merchant for identifying the subscription payment. |  |
+|**paymentAmount** | **BigDecimal** | The charge amount of the payment. Required in case of charge. |  [optional] |
+|**paymentScheduleDate** | **String** | The date on which the payment is scheduled to be processed. Required for UPI and CARD payment modes. |  [optional] |
+|**paymentRemarks** | **String** | Payment remarks. |  [optional] |
+|**paymentType** | **String** | Payment type. Can be AUTH or CHARGE. |  |
+|**paymentMethod** | **Object** | Payment method. Can be one of [\"upi\", \"enach\", \"pnach\", \"card\"] |  [optional] |
+
+
+

docs/CreateSubscriptionRefundRequest.md

@@ -0,0 +1,20 @@
+
+
+# CreateSubscriptionRefundRequest
+
+Request body to create a subscription refund.
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**subscriptionId** | **String** | A unique ID passed by merchant for identifying the subscription. |  |
+|**paymentId** | **String** | A unique ID passed by merchant for identifying the transaction. |  [optional] |
+|**cfPaymentId** | **String** | Cashfree subscription payment reference number. |  [optional] |
+|**refundId** | **String** | A unique ID passed by merchant for identifying the refund. |  |
+|**refundAmount** | **BigDecimal** | The amount to be refunded. Can be partial or full amount of the payment. |  |
+|**refundNote** | **String** | Refund note. |  [optional] |
+|**refundSpeed** | **String** | Refund speed. Can be INSTANT or STANDARD. UPI supports only STANDARD refunds, Enach and Pnach supports only INSTANT refunds. |  [optional] |
+
+
+

docs/CreateSubscriptionRequest.md

@@ -0,0 +1,23 @@
+
+
+# CreateSubscriptionRequest
+
+Request body to create a new subscription.
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**subscriptionId** | **String** | A unique ID for the subscription. It can include alphanumeric characters, underscore, dot, hyphen, and space. Maximum characters allowed is 250. |  |
+|**customerDetails** | [**SubscriptionCustomerDetails**](SubscriptionCustomerDetails.md) |  |  |
+|**planDetails** | [**CreateSubscriptionRequestPlanDetails**](CreateSubscriptionRequestPlanDetails.md) |  |  |
+|**authorizationDetails** | [**CreateSubscriptionRequestAuthorizationDetails**](CreateSubscriptionRequestAuthorizationDetails.md) |  |  [optional] |
+|**subscriptionMeta** | [**CreateSubscriptionRequestSubscriptionMeta**](CreateSubscriptionRequestSubscriptionMeta.md) |  |  [optional] |
+|**subscriptionExpiryTime** | **String** | Expiry date for the subscription. |  [optional] |
+|**subscriptionFirstChargeTime** | **String** | Time at which the first charge will be made for the subscription after authorization. Applicable only for PERIODIC plans. |  [optional] |
+|**subscriptionNote** | **String** | Note for the subscription. |  [optional] |
+|**subscriptionTags** | **Object** | Tags for the subscription. |  [optional] |
+|**subscriptionPaymentSplits** | [**List<SubscriptionPaymentSplitItem>**](SubscriptionPaymentSplitItem.md) | Payment splits for the subscription. |  [optional] |
+
+
+

docs/CreateSubscriptionRequestAuthorizationDetails.md

@@ -0,0 +1,14 @@
+
+
+# CreateSubscriptionRequestAuthorizationDetails
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**authorizationAmount** | **BigDecimal** | Authorization amount for the auth payment. |  [optional] |
+|**authorizationAmountRefund** | **Boolean** | Indicates whether the authorization amount should be refunded to the customer automatically. Merchants can use this field to specify if the authorized funds should be returned to the customer after authorization of the subscription. |  [optional] |
+
+
+

docs/CreateSubscriptionRequestPlanDetails.md

@@ -0,0 +1,22 @@
+
+
+# CreateSubscriptionRequestPlanDetails
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**planId** | **String** | The unique identifier used to create plan. You only need to pass this field if you had already created plan. Otherwise use the other fields here to define the plan. |  [optional] |
+|**planName** | **String** | Specify plan name for easy reference. |  [optional] |
+|**planType** | **String** | Possible values ON_DEMAND or PERIODIC. PERIODIC - Payments are triggered automatically at fixed intervals defined by the merchant. ON_DEMAND - Merchant needs to trigger/charge the customer explicitly with the required amount. |  [optional] |
+|**planCurrency** | **String** | INR by default. |  [optional] |
+|**planAmount** | **BigDecimal** | The amount to be charged for PERIODIC plan. This is a conditional parameter, only required for PERIODIC plans. |  [optional] |
+|**planMaxAmount** | **BigDecimal** | This is the maximum amount that can be charged on a subscription. |  [optional] |
+|**planMaxCycles** | **Integer** | Maximum number of debits set for the plan. The subscription will automatically change to COMPLETED status once this limit is reached. |  [optional] |
+|**planIntervals** | **Integer** | Number of intervals of intervalType between every subscription payment. For example, to charge a customer bi-weekly use intervalType as “week” and intervals as 2. Required for PERIODIC plan. The default value is 1. |  [optional] |
+|**planIntervalType** | **String** | The type of interval for a PERIODIC plan like DAY, WEEK, MONTH, or YEAR. This is a conditional parameter only applicable for PERIODIC plans. |  [optional] |
+|**planNote** | **String** | Note for the plan. |  [optional] |
+
+
+

docs/CreateSubscriptionRequestSubscriptionMeta.md

@@ -0,0 +1,14 @@
+
+
+# CreateSubscriptionRequestSubscriptionMeta
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**returnUrl** | **String** | The url to redirect after checkout. |  [optional] |
+|**notificationChannel** | **List<String>** | Notification channel for the subscription. SMS, EMAIL are possible values. |  [optional] |
+
+
+

docs/CreateTerminalTransactionRequest.md

@@ -12,6 +12,7 @@ Request body to create a terminal transaction
 |**cfTerminalId** | **String** | cashfree terminal id. this is a required parameter when you do not provide the terminal phone number. |  [optional] |
 |**paymentMethod** | **String** | mention the payment method used for the transaction. possible values - QR_CODE, LINK. |  |
 |**terminalPhoneNo** | **String** | agent mobile number assigned to the terminal. this is a required parameter when you do not provide the cf_terminal_id. |  [optional] |
+|**addInvoice** | **Boolean** | make it true to have request be sent to create a Dynamic GST QR Code. |  [optional] |
 
 
 

docs/CreateVendorRequest.md

@@ -15,7 +15,7 @@ Create Vendor Request
 |**phone** | **String** | Specify the beneficiaries phone number to be updated. Phone number registered in India (only digits, 8 - 12 characters after excluding +91). |  |
 |**verifyAccount** | **Boolean** | Specify if the vendor bank account details should be verified. Possible values: true or false |  [optional] |
 |**dashboardAccess** | **Boolean** | Update if the vendor will have dashboard access or not. Possible values are: true or false |  [optional] |
-|**scheduleOption** | **BigDecimal** | Specify the settlement cycle to be updated. View the settlement cycle details from the \"Settlement Cycles Supported\" table. If no schedule option is configured, the settlement cycle ID \"1\" will be in effect. Select \"8\" or \"9\" if you want to schedule instant vendor settlements. |  [optional] |
+|**scheduleOption** | **BigDecimal** | Specify the settlement cycle to be updated. View the settlement cycle details from the \"Settlement Cycles Supported\" table.  If no schedule option is configured, the settlement cycle ID \"1\" will be in effect. Select \"8\" or \"9\" if you want to schedule instant vendor settlements. |  [optional] |
 |**bank** | [**List<BankDetails>**](BankDetails.md) | Specify the vendor bank account details to be updated. |  [optional] |
 |**upi** | [**List<UpiDetails>**](UpiDetails.md) | Updated beneficiary upi vpa. Alphanumeric, dot (.), hyphen (-), at sign (@), and underscore allowed (100 character limit). Note: underscore and dot (.) gets accepted before and after @, but hyphen (-) is only accepted before @ sign. |  [optional] |
 |**kycDetails** | [**List<KycDetails>**](KycDetails.md) | Specify the kyc details that should be updated. |  |

docs/CustomerDetails.md

@@ -2,13 +2,13 @@
 
 # CustomerDetails
 
-The customer details that are necessary. Note that you can pass dummy details if your use case does not require the customer details.
+The customer details that are necessary.
 
 ## Properties
 
 | Name | Type | Description | Notes |
 |------------ | ------------- | ------------- | -------------|
-|**customerId** | **String** | A unique identifier for the customer. Use alphanumeric values only. |  [optional] |
+|**customerId** | **String** | A unique identifier for the customer. Use alphanumeric values only. |  |
 |**customerEmail** | **String** | Customer email address. |  [optional] |
 |**customerPhone** | **String** | Customer phone number. |  |
 |**customerName** | **String** | Name of the customer. |  [optional] |