chargebee 2.28.0 → 2.30.0

package/types/resources/Transaction.d.ts

@@ -38,7 +38,7 @@ declare module 'chargebee' {
     payment_source_id?:string;
     
     /**
-      * @description The payment method of this transaction \* unionpay - Unionpay \* bank_transfer - Bank Transfer \* paypal_express_checkout - Paypal Express Checkout \* other - Payment Methods other than the above types \* upi - upi \* ach_credit - ACH Credit \* sepa_credit - SEPA Credit \* check - Check \* card - Card \* amazon_payments - Amazon Payments \* ideal - IDEAL \* chargeback - Only applicable for a transaction of [type](transactions#transaction_type) = `refund`. This value is set by Chargebee when an automated [chargeback](https://www.chargebee.com/docs/chargeback.html#chargeback-process) occurs. You can also set this explicitly when [recording a refund](transactions#record_an_offline_refund). \* google_pay - Google Pay \* netbanking_emandates - netbanking_emandates \* direct_debit - Direct Debit \* dotpay - Dotpay \* alipay - Alipay \* sofort - Sofort \* apple_pay - Apple Pay \* giropay - giropay \* wechat_pay - WeChat Pay \* cash - Cash \* bancontact - Bancontact
+      * @description The payment method of this transaction \* unionpay - Unionpay \* upi - upi \* check - Check \* custom - Custom \* amazon_payments - Amazon Payments \* boleto - boleto \* direct_debit - Direct Debit \* apple_pay - Apple Pay \* wechat_pay - WeChat Pay \* bancontact - Bancontact \* bank_transfer - Bank Transfer \* paypal_express_checkout - Paypal Express Checkout \* other - Payment Methods other than the above types \* ach_credit - ACH Credit \* sepa_credit - SEPA Credit \* card - Card \* ideal - IDEAL \* chargeback - Only applicable for a transaction of [type](transactions#transaction_type) = `refund`. This value is set by Chargebee when an automated [chargeback](https://www.chargebee.com/docs/chargeback.html#chargeback-process) occurs. You can also set this explicitly when [recording a refund](transactions#record_an_offline_refund). \* google_pay - Google Pay \* netbanking_emandates - netbanking_emandates \* dotpay - Dotpay \* alipay - Alipay \* sofort - Sofort \* giropay - giropay \* cash - Cash
 
       */
     
@@ -52,14 +52,14 @@ declare module 'chargebee' {
     reference_number?:string;
     
     /**
-      * @description Gateway through which this transaction was done. Applicable only for 'Card' Payment Method \* bluesnap - BlueSnap is a payment gateway. \* tco - 2Checkout is a payment gateway. \* bluepay - BluePay is a payment gateway. \* paypal_express_checkout - PayPal Express Checkout is a payment gateway. \* paypal_payflow_pro - PayPal Payflow Pro is a payment gateway. \* razorpay - Razorpay is a fast growing payment service provider in India working with all leading banks and support for major local payment methods including Netbanking, UPI etc. \* global_payments - Global Payments is a payment service provider. \* not_applicable - Indicates that payment gateway is not applicable for this resource. \* checkout_com - Checkout.com is a payment gateway. \* adyen - Adyen is a payment gateway. \* braintree - Braintree is a payment gateway. \* nmi - NMI is a payment gateway. \* worldpay - WorldPay is a payment gateway \* moneris_us - Moneris USA is a payment gateway. \* pin - Pin is a payment gateway \* authorize_net - Authorize.net is a payment gateway \* stripe - Stripe is a payment gateway. \* moneris - Moneris is a payment gateway. \* chargebee - Chargebee test gateway. \* cybersource - CyberSource is a payment gateway. \* first_data_global - First Data Global Gateway Virtual Terminal Account \* exact - Exact Payments is a payment gateway. \* eway - eWAY Account is a payment gateway. \* amazon_payments - Amazon Payments is a payment service provider. \* quickbooks - Intuit QuickBooks Payments gateway \* wepay - WePay is a payment gateway. \* wirecard - WireCard Account is a payment service provider. \* chargebee_payments - Chargebee Payments gateway \* sage_pay - Sage Pay is a payment gateway. \* elavon - Elavon Virtual Merchant is a payment solution. \* paypal_pro - PayPal Pro Account is a payment gateway. \* orbital - Chase Paymentech(Orbital) is a payment gateway. \* paypal - PayPal Commerce is a payment gateway. \* beanstream - Bambora(formerly known as Beanstream) is a payment gateway. \* hdfc - HDFC Account is a payment gateway. \* ingenico_direct - Worldline Online Payments is a payment gateway. \* ogone - Ingenico ePayments (formerly known as Ogone) is a payment gateway. \* migs - MasterCard Internet Gateway Service payment gateway. \* vantiv - Vantiv is a payment gateway. \* eway_rapid - eWAY Rapid is a payment gateway. \* gocardless - GoCardless is a payment service provider. \* mollie - Mollie is a payment gateway. \* paymill - PAYMILL is a payment gateway. \* balanced_payments - Balanced is a payment gateway
+      * @description Gateway through which this transaction was done. Applicable only for 'Card' Payment Method \* bluesnap - BlueSnap is a payment gateway. \* tco - 2Checkout is a payment gateway. \* razorpay - Razorpay is a fast growing payment service provider in India working with all leading banks and support for major local payment methods including Netbanking, UPI etc. \* checkout_com - Checkout.com is a payment gateway. \* adyen - Adyen is a payment gateway. \* braintree - Braintree is a payment gateway. \* moneris_us - Moneris USA is a payment gateway. \* pin - Pin is a payment gateway \* moneris - Moneris is a payment gateway. \* chargebee - Chargebee test gateway. \* cybersource - CyberSource is a payment gateway. \* ecentric - Ecentric provides a seamless payment processing service in South Africa specializing on omnichannel capabilities. \* first_data_global - First Data Global Gateway Virtual Terminal Account \* exact - Exact Payments is a payment gateway. \* eway - eWAY Account is a payment gateway. \* amazon_payments - Amazon Payments is a payment service provider. \* sage_pay - Sage Pay is a payment gateway. \* elavon - Elavon Virtual Merchant is a payment solution. \* orbital - Chase Paymentech(Orbital) is a payment gateway. \* beanstream - Bambora(formerly known as Beanstream) is a payment gateway. \* hdfc - HDFC Account is a payment gateway. \* bank_of_america - Bank of America Gateway \* gocardless - GoCardless is a payment service provider. \* paymill - PAYMILL is a payment gateway. \* balanced_payments - Balanced is a payment gateway \* bluepay - BluePay is a payment gateway. \* paypal_express_checkout - PayPal Express Checkout is a payment gateway. \* paypal_payflow_pro - PayPal Payflow Pro is a payment gateway. \* global_payments - Global Payments is a payment service provider. \* not_applicable - Indicates that payment gateway is not applicable for this resource. \* nmi - NMI is a payment gateway. \* worldpay - WorldPay is a payment gateway \* authorize_net - Authorize.net is a payment gateway \* stripe - Stripe is a payment gateway. \* metrics_global - Metrics global is a leading payment service provider providing unified payment services in the US. \* windcave - Windcave provides an end to end payment processing solution in ANZ and other leading global markets. \* quickbooks - Intuit QuickBooks Payments gateway \* wepay - WePay is a payment gateway. \* wirecard - WireCard Account is a payment service provider. \* chargebee_payments - Chargebee Payments gateway \* paypal_pro - PayPal Pro Account is a payment gateway. \* paypal - PayPal Commerce is a payment gateway. \* ingenico_direct - Worldline Online Payments is a payment gateway. \* ogone - Ingenico ePayments (formerly known as Ogone) is a payment gateway. \* migs - MasterCard Internet Gateway Service payment gateway. \* vantiv - Vantiv is a payment gateway. \* eway_rapid - eWAY Rapid is a payment gateway. \* mollie - Mollie is a payment gateway.
 
       */
     
     gateway:Gateway;
     
     /**
-      * @description Type of the transaction. \* refund - The transaction represents a refund of [amount](transactions#transaction_amount) to the customer's [payment_source](payment_sources). \* authorization - The transaction represents an authorization for capturing the [amount](transactions#transaction_amount) from the customer's [payment_source](payment_sources). \* payment_reversal - Indicates a reversal transaction. \* payment - The transaction represents capture of [amount](transactions#transaction_amount) from the customer's [payment_source](payment_sources).
+      * @description Type of the transaction. \* authorization - The transaction represents an authorization for capturing the [amount](transactions#transaction_amount) from the customer's [payment_source](payment_sources). \* payment - The transaction represents capture of [amount](transactions#transaction_amount) from the customer's [payment_source](payment_sources). \* refund - The transaction represents a refund of [amount](transactions#transaction_amount) to the customer's [payment_source](payment_sources). \* payment_reversal - Indicates a reversal transaction.
 
       */
     
@@ -108,21 +108,21 @@ declare module 'chargebee' {
     id_at_gateway?:string;
     
     /**
-      * @description The status of this transaction. \* in_progress - Transaction is being processed by the gateway. This typically happens for [direct debit transactions](https://www.chargebee.com/docs/direct-debit-payments.html) or, in case of cards, refund transactions. Such transactions can take 2-7 days to complete, depending on the gateway and payment method. \* timeout - Transaction failed because of Gateway not accepting the connection. \* failure - Transaction failed. Refer the 'error_code' and 'error_text' fields to know the reason for failure \* success - The transaction is successful. \* voided - The transaction got voided or authorization expired at gateway. \* needs_attention - Connection with Gateway got terminated abruptly. So, status of this transaction needs to be resolved manually
+      * @description The status of this transaction. \* in_progress - Transaction is being processed by the gateway. This typically happens for [direct debit transactions](https://www.chargebee.com/docs/direct-debit-payments.html) or, in case of cards, refund transactions. Such transactions can take 2-7 days to complete, depending on the gateway and payment method. \* timeout - Transaction failed because of Gateway not accepting the connection. \* success - The transaction is successful. \* voided - The transaction got voided or authorization expired at gateway. \* needs_attention - Connection with Gateway got terminated abruptly. So, status of this transaction needs to be resolved manually \* failure - Transaction failed. Refer the 'error_code' and 'error_text' fields to know the reason for failure
 
       */
     
     status?:'in_progress' | 'success' | 'failure' | 'voided' | 'timeout' | 'needs_attention';
     
     /**
-      * @description Indicates whether or not the transaction has been identified as fraudulent. \* fraudulent - The transaction has been marked as fraudulent \* suspicious - The transaction has been identified as potentially fraudulent by the gateway \* safe - The transaction has been marked as safe
+      * @description Indicates whether or not the transaction has been identified as fraudulent. \* suspicious - The transaction has been identified as potentially fraudulent by the gateway \* safe - The transaction has been marked as safe \* fraudulent - The transaction has been marked as fraudulent
 
       */
     
     fraud_flag?:'safe' | 'suspicious' | 'fraudulent';
     
     /**
-      * @description Marker for on-session payments (3DS). null indicates 'merchant'. \* customer - Customer initiated 3DS payment \* merchant - Payment initiated on stored payment method by the merchant
+      * @description Marker for on-session payments (3DS). null indicates 'merchant'. \* merchant - Payment initiated on stored payment method by the merchant \* customer - Customer initiated 3DS payment
 
       */
     
@@ -306,39 +306,39 @@ declare module 'chargebee' {
   export namespace Transaction {
     export class TransactionResource {  
       /**
-        * @description Records a refund made offline. Applicable only for `transaction`s of [type](transactions#transaction_type) = `payment`.
+        * @description Authorizes a specific amount in customer's Credit card, which can be collected within a span of time. Read more on authorization and capture [here](https://www.chargebee.com/docs/stripe.html#auth-and-capture).
 
         */
       
-      record_refund(transaction_id:string, input:RecordRefundInputParam):ChargebeeRequest<RecordRefundResponse>;
+      create_authorization(input:CreateAuthorizationInputParam):ChargebeeRequest<CreateAuthorizationResponse>;
        
       /**
-        * @description Lists all the transactions.
+        * @description This API voids the specific authorization transaction in order to release the blocked funds from the customer&#x27;s card. Voiding an already captured or voided transaction is not possible.
 
         */
       
-      list(input?:ListInputParam):ChargebeeRequest<ListResponse>;
+      void_transaction(transaction_id:string):ChargebeeRequest<VoidTransactionResponse>;
        
       /**
-        * @description This API voids the specific authorization transaction in order to release the blocked funds from the customer&#x27;s card. Voiding an already captured or voided transaction is not possible.
+        * @description Records a refund made offline. Applicable only for &#x60;transaction&#x60;s of [type](transactions#transaction_type) &#x3D; &#x60;payment&#x60;.
 
         */
       
-      void_transaction(transaction_id:string):ChargebeeRequest<VoidTransactionResponse>;
+      record_refund(transaction_id:string, input:RecordRefundInputParam):ChargebeeRequest<RecordRefundResponse>;
        
       /**
-        * @description Authorizes a specific amount in customer&#x27;s Credit card, which can be collected within a span of time. Read more on authorization and capture [here](https://www.chargebee.com/docs/stripe.html#auth-and-capture).
+        * @description Refunds an online payment. Applicable only for &#x60;transaction&#x60;s of [type](transactions#transaction_type) &#x3D; &#x60;payment&#x60;. You can only refund a &#x60;transaction&#x60; whose [status](transactions#transaction_status)&#x60; &#x60; is &#x60;success&#x60;.
 
         */
       
-      create_authorization(input:CreateAuthorizationInputParam):ChargebeeRequest<CreateAuthorizationResponse>;
+      refund(transaction_id:string, input?:RefundInputParam):ChargebeeRequest<RefundResponse>;
        
       /**
-        * @description Retrieve a transaction identified by its unique id.
+        * @description Lists all the transactions.
 
         */
       
-      retrieve(transaction_id:string):ChargebeeRequest<RetrieveResponse>;
+      list(input?:ListInputParam):ChargebeeRequest<ListResponse>;
        
       /**
         * @description Retrieves the payments for an invoice with the recent ones on top. This returns all the payment attempts(manual \&amp; automatic) made for this invoice.
@@ -347,20 +347,57 @@ declare module 'chargebee' {
       
       payments_for_invoice(invoice_id:string, input?:PaymentsForInvoiceInputParam):ChargebeeRequest<PaymentsForInvoiceResponse>;
        
+      /**
+        * @description Retrieve a transaction identified by its unique id.
+
+        */
+      
+      retrieve(transaction_id:string):ChargebeeRequest<RetrieveResponse>;
+       
       /**
         * @description This API deletes an offline transaction. However, to delete an offline transaction all payment allocations associated with the transaction must be removed.
 
         */
       
       delete_offline_transaction(transaction_id:string, input?:DeleteOfflineTransactionInputParam):ChargebeeRequest<DeleteOfflineTransactionResponse>;
+    }
+    export interface CreateAuthorizationResponse {  
+       transaction:Transaction;
+    }
+    export interface CreateAuthorizationInputParam {
        
       /**
-        * @description Refunds an online payment. Applicable only for &#x60;transaction&#x60;s of [type](transactions#transaction_type) &#x3D; &#x60;payment&#x60;. You can only refund a &#x60;transaction&#x60; whose [status](transactions#transaction_status)&#x60; &#x60; is &#x60;success&#x60;.
+        * @description Identifier of the customer.
 
         */
-      
-      refund(transaction_id:string, input?:RefundInputParam):ChargebeeRequest<RefundResponse>;
+       
+      customer_id:string;
+       
+      /**
+        * @description Payment source to be used for authorizing the transaction.
+
+        */
+       
+      payment_source_id?:string;
+       
+      /**
+        * @description The currency code (ISO 4217 format) of the transaction amount.
+
+        */
+       
+      currency_code?:string;
+       
+      /**
+        * @description The amount to be blocked.
+
+        */
+       
+      amount:number;
+    }
+    export interface VoidTransactionResponse {  
+       transaction:Transaction;
     }
+    
     export interface RecordRefundResponse {  
        transaction:Transaction;
     }
@@ -374,7 +411,7 @@ declare module 'chargebee' {
       amount?:number;
        
       /**
-        * @description The payment method used to make the refund. \* card - Card \* alipay - Alipay \* sofort - Sofort \* play_store - Play Store \* upi - upi \* ach_credit - ACH Credit \* amazon_payments - Amazon Payments \* apple_pay - Apple Pay \* ideal - IDEAL \* giropay - giropay \* chargeback - Only applicable for a transaction of [type](transactions#transaction_type) &#x3D; &#x60;refund&#x60;. This value is set by Chargebee when an automated [chargeback](https://www.chargebee.com/docs/chargeback.html#chargeback-process) occurs. You can also set this explicitly when [recording a refund](transactions#record_an_offline_refund). \* wechat_pay - WeChat Pay \* sepa_credit - SEPA Credit \* google_pay - Google Pay \* cash - Cash \* netbanking_emandates - netbanking_emandates \* unionpay - Unionpay \* bancontact - Bancontact \* bank_transfer - Bank Transfer \* paypal_express_checkout - Paypal Express Checkout \* app_store - App Store \* check - Check \* direct_debit - Direct Debit \* dotpay - Dotpay \* other - Payment Methods other than the above types
+        * @description The payment method used to make the refund. \* card - Card \* alipay - Alipay \* sofort - Sofort \* play_store - Play Store \* custom - Custom \* upi - upi \* ach_credit - ACH Credit \* amazon_payments - Amazon Payments \* apple_pay - Apple Pay \* ideal - IDEAL \* giropay - giropay \* boleto - boleto \* chargeback - Only applicable for a transaction of [type](transactions#transaction_type) &#x3D; &#x60;refund&#x60;. This value is set by Chargebee when an automated [chargeback](https://www.chargebee.com/docs/chargeback.html#chargeback-process) occurs. You can also set this explicitly when [recording a refund](transactions#record_an_offline_refund). \* wechat_pay - WeChat Pay \* sepa_credit - SEPA Credit \* google_pay - Google Pay \* cash - Cash \* netbanking_emandates - netbanking_emandates \* unionpay - Unionpay \* bancontact - Bancontact \* bank_transfer - Bank Transfer \* paypal_express_checkout - Paypal Express Checkout \* app_store - App Store \* check - Check \* direct_debit - Direct Debit \* dotpay - Dotpay \* other - Payment Methods other than the above types
 
         */
        
@@ -401,6 +438,25 @@ declare module 'chargebee' {
        
       comment?:string;
     }
+    export interface RefundResponse {  
+       transaction:Transaction;
+    }
+    export interface RefundInputParam {
+       
+      /**
+        * @description The amount to be refunded. Must not exceed [amount_unused](transactions#transaction_amount_unused). If not passed then all of [amount_unused](transactions#transaction_amount_unused) is refunded.
+
+        */
+       
+      amount?:number;
+       
+      /**
+        * @description Remarks, if any, on the refund.
+
+        */
+       
+      comment?:string;
+    }
     export interface ListResponse {  
       /**
         * @description Lists all the transactions.
@@ -419,126 +475,126 @@ declare module 'chargebee' {
     export interface ListInputParam {
       [key : string]: any;  
       /**
-        * @description The number of resources to be returned.
+        * @description Lists all the transactions.
 
         */
         
       limit?:number;
        
       /**
-        * @description Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set \&#x60;offset\&#x60; to the value of \&#x60;next_offset\&#x60; obtained in the previous iteration of the API call.
+        * @description Lists all the transactions.
 
         */
         
       offset?:string;
        
       /**
-        * @description Indicates whether to include deleted objects in the list. The deleted objects have the attribute \&#x60;deleted\&#x60; as \&#x60;true\&#x60;.
+        * @description Lists all the transactions.
 
         */
         
       include_deleted?:boolean;
        
       /**
-        * @description Uniquely identifies the transaction.
+        * @description Lists all the transactions.
 
         */
         
       id?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string};
        
       /**
-        * @description Identifier of the customer for which this transaction is made
+        * @description Lists all the transactions.
 
         */
         
       customer_id?:{in?:string,is?:string,is_not?:string,is_present?:'true' | 'false',not_in?:string,starts_with?:string};
        
       /**
-        * @description Identifier of the subscription for which this transaction is made.
+        * @description Lists all the transactions.
 
         */
         
       subscription_id?:{in?:string,is?:string,is_not?:string,is_present?:'true' | 'false',not_in?:string,starts_with?:string};
        
       /**
-        * @description To filter based on Transaction payment source id.
+        * @description Lists all the transactions.
 
         */
         
       payment_source_id?:{in?:string,is?:string,is_not?:string,is_present?:'true' | 'false',not_in?:string,starts_with?:string};
        
       /**
-        * @description The payment method of this transaction
+        * @description Lists all the transactions.
 
         */
         
-      payment_method?:{in?:string,is?:'other' | 'netbanking_emandates' | 'ach_credit' | 'dotpay' | 'boleto' | 'direct_debit' | 'chargeback' | 'wechat_pay' | 'cash' | 'giropay' | 'bank_transfer' | 'alipay' | 'ideal' | 'google_pay' | 'custom' | 'unionpay' | 'check' | 'sofort' | 'amazon_payments' | 'upi' | 'apple_pay' | 'bancontact' | 'paypal_express_checkout' | 'sepa_credit' | 'card',is_not?:'other' | 'netbanking_emandates' | 'ach_credit' | 'dotpay' | 'boleto' | 'direct_debit' | 'chargeback' | 'wechat_pay' | 'cash' | 'giropay' | 'bank_transfer' | 'alipay' | 'ideal' | 'google_pay' | 'custom' | 'unionpay' | 'check' | 'sofort' | 'amazon_payments' | 'upi' | 'apple_pay' | 'bancontact' | 'paypal_express_checkout' | 'sepa_credit' | 'card',not_in?:string};
+      payment_method?:{in?:string,is?:'other' | 'netbanking_emandates' | 'ach_credit' | 'dotpay' | 'boleto' | 'direct_debit' | 'chargeback' | 'wechat_pay' | 'pay_to' | 'cash' | 'giropay' | 'bank_transfer' | 'alipay' | 'ideal' | 'sepa_instant_transfer' | 'google_pay' | 'custom' | 'unionpay' | 'check' | 'faster_payments' | 'sofort' | 'amazon_payments' | 'upi' | 'venmo' | 'apple_pay' | 'bancontact' | 'paypal_express_checkout' | 'sepa_credit' | 'card',is_not?:'other' | 'netbanking_emandates' | 'ach_credit' | 'dotpay' | 'boleto' | 'direct_debit' | 'chargeback' | 'wechat_pay' | 'pay_to' | 'cash' | 'giropay' | 'bank_transfer' | 'alipay' | 'ideal' | 'sepa_instant_transfer' | 'google_pay' | 'custom' | 'unionpay' | 'check' | 'faster_payments' | 'sofort' | 'amazon_payments' | 'upi' | 'venmo' | 'apple_pay' | 'bancontact' | 'paypal_express_checkout' | 'sepa_credit' | 'card',not_in?:string};
        
       /**
-        * @description Gateway through which this transaction was done. Applicable only for &#x27;Card&#x27; Payment Method
+        * @description Lists all the transactions.
 
         */
         
-      gateway?:{in?:string,is?:'bluepay' | 'beanstream' | 'elavon' | 'orbital' | 'hdfc' | 'nmi' | 'moneris' | 'metrics_global' | 'pin' | 'stripe' | 'quickbooks' | 'razorpay' | 'eway_rapid' | 'balanced_payments' | 'ecentric' | 'wepay' | 'chargebee_payments' | 'bank_of_america' | 'braintree' | 'first_data_global' | 'paypal_express_checkout' | 'ingenico_direct' | 'moneris_us' | 'exact' | 'migs' | 'checkout_com' | 'not_applicable' | 'paypal_pro' | 'ogone' | 'eway' | 'gocardless' | 'global_payments' | 'paymill' | 'adyen' | 'paypal' | 'chargebee' | 'authorize_net' | 'tco' | 'bluesnap' | 'windcave' | 'paypal_payflow_pro' | 'amazon_payments' | 'mollie' | 'cybersource' | 'wirecard' | 'sage_pay' | 'vantiv' | 'worldpay',is_not?:'bluepay' | 'beanstream' | 'elavon' | 'orbital' | 'hdfc' | 'nmi' | 'moneris' | 'metrics_global' | 'pin' | 'stripe' | 'quickbooks' | 'razorpay' | 'eway_rapid' | 'balanced_payments' | 'ecentric' | 'wepay' | 'chargebee_payments' | 'bank_of_america' | 'braintree' | 'first_data_global' | 'paypal_express_checkout' | 'ingenico_direct' | 'moneris_us' | 'exact' | 'migs' | 'checkout_com' | 'not_applicable' | 'paypal_pro' | 'ogone' | 'eway' | 'gocardless' | 'global_payments' | 'paymill' | 'adyen' | 'paypal' | 'chargebee' | 'authorize_net' | 'tco' | 'bluesnap' | 'windcave' | 'paypal_payflow_pro' | 'amazon_payments' | 'mollie' | 'cybersource' | 'wirecard' | 'sage_pay' | 'vantiv' | 'worldpay',not_in?:string};
+      gateway?:{in?:string,is?:'bluepay' | 'beanstream' | 'elavon' | 'orbital' | 'hdfc' | 'nmi' | 'moneris' | 'metrics_global' | 'ebanx' | 'pin' | 'stripe' | 'quickbooks' | 'razorpay' | 'eway_rapid' | 'balanced_payments' | 'ecentric' | 'wepay' | 'chargebee_payments' | 'bank_of_america' | 'braintree' | 'first_data_global' | 'paypal_express_checkout' | 'ingenico_direct' | 'moneris_us' | 'exact' | 'migs' | 'checkout_com' | 'not_applicable' | 'paypal_pro' | 'ogone' | 'eway' | 'gocardless' | 'global_payments' | 'paymill' | 'adyen' | 'paypal' | 'chargebee' | 'authorize_net' | 'tco' | 'bluesnap' | 'windcave' | 'paypal_payflow_pro' | 'amazon_payments' | 'mollie' | 'cybersource' | 'wirecard' | 'sage_pay' | 'vantiv' | 'worldpay' | 'pay_com',is_not?:'bluepay' | 'beanstream' | 'elavon' | 'orbital' | 'hdfc' | 'nmi' | 'moneris' | 'metrics_global' | 'ebanx' | 'pin' | 'stripe' | 'quickbooks' | 'razorpay' | 'eway_rapid' | 'balanced_payments' | 'ecentric' | 'wepay' | 'chargebee_payments' | 'bank_of_america' | 'braintree' | 'first_data_global' | 'paypal_express_checkout' | 'ingenico_direct' | 'moneris_us' | 'exact' | 'migs' | 'checkout_com' | 'not_applicable' | 'paypal_pro' | 'ogone' | 'eway' | 'gocardless' | 'global_payments' | 'paymill' | 'adyen' | 'paypal' | 'chargebee' | 'authorize_net' | 'tco' | 'bluesnap' | 'windcave' | 'paypal_payflow_pro' | 'amazon_payments' | 'mollie' | 'cybersource' | 'wirecard' | 'sage_pay' | 'vantiv' | 'worldpay' | 'pay_com',not_in?:string};
        
       /**
-        * @description The gateway account used for this transaction
+        * @description Lists all the transactions.
 
         */
         
       gateway_account_id?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string};
        
       /**
-        * @description The id with which this transaction is referred in gateway.
+        * @description Lists all the transactions.
 
         */
         
       id_at_gateway?:{is?:string,is_not?:string,starts_with?:string};
        
       /**
-        * @description The reference number for this transaction. For example, the check number when [payment_method](transactions#transaction_payment_method) &#x3D; &#x60;check&#x60;.
+        * @description Lists all the transactions.
 
         */
         
       reference_number?:{is?:string,is_not?:string,is_present?:'true' | 'false',starts_with?:string};
        
       /**
-        * @description Type of the transaction.
+        * @description Lists all the transactions.
 
         */
         
       type?:{in?:string,is?:'authorization' | 'payment_reversal' | 'payment' | 'refund',is_not?:'authorization' | 'payment_reversal' | 'payment' | 'refund',not_in?:string};
        
       /**
-        * @description Indicates when this transaction occurred.
+        * @description Lists all the transactions.
 
         */
         
       date?:{after?:string,before?:string,between?:string,on?:string};
        
       /**
-        * @description Amount for this transaction.
+        * @description Lists all the transactions.
 
         */
         
       amount?:{between?:string,gt?:string,gte?:string,is?:string,is_not?:string,lt?:string,lte?:string};
        
       /**
-        * @description To filter based on transaction&#x27;s unused authorized/blocked amount.
+        * @description Lists all the transactions.
 
         */
         
       amount_capturable?:{between?:string,gt?:string,gte?:string,is?:string,is_not?:string,lt?:string,lte?:string};
        
       /**
-        * @description The status of this transaction.
+        * @description Lists all the transactions.
 
         */
         
       status?:{in?:string,is?:'in_progress' | 'success' | 'failure' | 'voided' | 'timeout' | 'needs_attention',is_not?:'in_progress' | 'success' | 'failure' | 'voided' | 'timeout' | 'needs_attention',not_in?:string};
        
       /**
-        * @description To filter based on &#x60;updated_at&#x60;. This attribute will be present only if the resource has been updated after 2016-09-28. It is advisable when using this filter, to pass the &#x60;sort_by&#x60; input parameter as &#x60;updated_at&#x60; for a faster response.
+        * @description Lists all the transactions.
 
         */
         
@@ -551,47 +607,6 @@ declare module 'chargebee' {
         
       sort_by?:{asc?:'date' | 'updated_at',desc?:'date' | 'updated_at'};
     }
-    export interface VoidTransactionResponse {  
-       transaction:Transaction;
-    }
-    
-    export interface CreateAuthorizationResponse {  
-       transaction:Transaction;
-    }
-    export interface CreateAuthorizationInputParam {
-       
-      /**
-        * @description Identifier of the customer.
-
-        */
-       
-      customer_id:string;
-       
-      /**
-        * @description Payment source to be used for authorizing the transaction.
-
-        */
-       
-      payment_source_id?:string;
-       
-      /**
-        * @description The currency code (ISO 4217 format) of the transaction amount.
-
-        */
-       
-      currency_code?:string;
-       
-      /**
-        * @description The amount to be blocked.
-
-        */
-       
-      amount:number;
-    }
-    export interface RetrieveResponse {  
-       transaction:Transaction;
-    }
-    
     export interface PaymentsForInvoiceResponse {  
       /**
         * @description Retrieves the payments for an invoice with the recent ones on top. This returns all the payment attempts(manual \&amp; automatic) made for this invoice.
@@ -610,19 +625,23 @@ declare module 'chargebee' {
     export interface PaymentsForInvoiceInputParam {
       [key : string]: any;  
       /**
-        * @description The number of resources to be returned.
+        * @description Retrieves the payments for an invoice with the recent ones on top. This returns all the payment attempts(manual \&amp; automatic) made for this invoice.
 
         */
         
       limit?:number;
        
       /**
-        * @description Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set \&#x60;offset\&#x60; to the value of \&#x60;next_offset\&#x60; obtained in the previous iteration of the API call.
+        * @description Retrieves the payments for an invoice with the recent ones on top. This returns all the payment attempts(manual \&amp; automatic) made for this invoice.
 
         */
         
       offset?:string;
     }
+    export interface RetrieveResponse {  
+       transaction:Transaction;
+    }
+    
     export interface DeleteOfflineTransactionResponse {  
        transaction:Transaction;
     }
@@ -635,73 +654,171 @@ declare module 'chargebee' {
        
       comment?:string;
     }
-    export interface RefundResponse {  
-       transaction:Transaction;
-    }
-    export interface RefundInputParam {
-       
-      /**
-        * @description The amount to be refunded. Must not exceed [amount_unused](transactions#transaction_amount_unused). If not passed then all of [amount_unused](transactions#transaction_amount_unused) is refunded.
+    export interface InvoiceTransaction {  
+         /**
+          * @description Identifier for the invoice.
 
-        */
+          */
        
-      amount?:number;
+      invoice_id:string;
        
-      /**
-        * @description Remarks, if any, on the refund.
+         /**
+          * @description The transaction amount applied to this invoice
 
-        */
+          */
        
-      comment?:string;
-    }
-    export interface InvoiceTransaction {  
-      invoice_id?:string;
+      applied_amount:number;
        
-      applied_amount?:number;
+         /**
+          * @description Timestamp at which the transaction is applied.
+
+          */
+       
+      applied_at:number;
        
-      applied_at?:number;
+         /**
+          * @description The date this invoice is issued.
+
+          */
        
       invoice_date?:number;
        
+         /**
+          * @description Total amount of the invoice
+
+          */
+       
       invoice_total?:number;
        
-      invoice_status?:'pending' | 'paid' | 'voided' | 'not_paid' | 'posted' | 'payment_due';
+         /**
+          * @description Current status of this invoice. \* pending -  
+The [invoice](/docs/api/invoices?prod_cat_ver&#x3D;2#invoice_status) is yet to be closed (sent for payment collection). An invoice is generated with this &#x60;status&#x60; when it has line items that belong to items that are &#x60;metered&#x60; or when the &#x60;subscription.create_pending_invoices&#x60;attribute is set to &#x60;true&#x60;.  
+The [invoice](/docs/api/invoices?prod_cat_ver&#x3D;1#invoice_status) is yet to be closed (sent for payment collection). All invoices are generated with this &#x60;status&#x60; when [Metered Billing](https://www.chargebee.com/docs/1.0/metered_billing.html) is enabled for the site. \* voided - Indicates a voided invoice. \* payment_due - Indicates the payment is not yet collected and is being retried as per retry settings. \* paid - Indicates a paid invoice. \* posted - Indicates the payment is not yet collected and will be in this state till the due date to indicate the due period \* not_paid - Indicates the payment is not made and all attempts to collect is failed.
+
+          */
+       
+      invoice_status:'pending' | 'paid' | 'voided' | 'not_paid' | 'posted' | 'payment_due';
     }
     export interface CreditNoteTransaction {  
-      cn_id?:string;
+         /**
+          * @description Identifier for the credit-notes.
+
+          */
+       
+      cn_id:string;
        
-      applied_amount?:number;
+         /**
+          * @description The transaction amount applied to this invoice
+
+          */
        
-      applied_at?:number;
+      applied_amount:number;
+       
+         /**
+          * @description Timestamp at which the transaction is applied.
+
+          */
+       
+      applied_at:number;
+       
+         /**
+          * @description Credit note reason code. Deprecated use the cn_create_reason_code parameter instead \* service_unsatisfactory - Service Unsatisfactory \* other - Can be set when none of the above reason codes are applicable \* subscription_cancellation - This reason will be set automatically for Credit Notes created during cancel subscription operation \* fraudulent - FRAUDULENT \* order_change - Order Change \* subscription_pause - This reason will be automatically set to credit notes created during pause/resume subscription operation. \* write_off - This reason will be set automatically for the Credit Notes created during invoice [Write Off](https://www.chargebee.com/docs/invoice-operations.html#write-off) operation. \* subscription_change - This reason will be set automatically for Credit Notes created during Change Subscription operation when [proration](https://www.chargebee.com/docs/proration.html) is enabled \* chargeback - Can be set when you are recording your customer Chargebacks \* waiver - Waiver \* order_cancellation - Order Cancellation \* product_unsatisfactory - Product Unsatisfactory
+
+          */
        
       cn_reason_code?:'other' | 'product_unsatisfactory' | 'subscription_pause' | 'order_cancellation' | 'service_unsatisfactory' | 'subscription_cancellation' | 'chargeback' | 'order_change' | 'write_off' | 'waiver' | 'subscription_change' | 'fraudulent';
        
+         /**
+          * @description Credit note reason code
+
+          */
+       
       cn_create_reason_code?:string;
        
+         /**
+          * @description The date this credit note is created.
+
+          */
+       
       cn_date?:number;
        
+         /**
+          * @description Total amount of the credit note
+
+          */
+       
       cn_total?:number;
        
-      cn_status?:'refund_due' | 'adjusted' | 'refunded' | 'voided';
+         /**
+          * @description The status of this Credit Note. \* voided - When the Credit Note has been cancelled. \* refund_due - When the credits are yet to be used, or have been partially used. \* refunded - When the entire credits (Credit Note amount) have been used (i.e either allocated to invoices or refunded). \* adjusted - When the Credit Note has been adjusted against an invoice.
+
+          */
+       
+      cn_status:'refund_due' | 'adjusted' | 'refunded' | 'voided';
        
-      cn_reference_invoice_id?:string;
+         /**
+          * @description The invoice number. Acts as a identifier for invoice and typically generated sequentially.
+
+          */
+       
+      cn_reference_invoice_id:string;
     }
     export interface TxnRefundsAndReversal {  
-      txn_id?:string;
+         /**
+          * @description Uniquely identifies the transaction.
+
+          */
        
-      txn_status?:'in_progress' | 'success' | 'failure' | 'voided' | 'timeout' | 'needs_attention';
+      txn_id:string;
        
-      txn_date?:number;
+         /**
+          * @description The status of this transaction. \* needs_attention - Connection with Gateway got terminated abruptly. So, status of this transaction needs to be resolved manually \* voided - The transaction got voided or authorization expired at gateway. \* timeout - Transaction failed because of Gateway not accepting the connection. \* success - The transaction is successful. \* failure - Transaction failed. Refer the &#x27;error_code&#x27; and &#x27;error_text&#x27; fields to know the reason for failure \* in_progress - Transaction is being processed by the gateway. This typically happens for [direct debit transactions](https://www.chargebee.com/docs/direct-debit-payments.html) or, in case of cards, refund transactions. Such transactions can take 2-7 days to complete, depending on the gateway and payment method.
+
+          */
+       
+      txn_status:'in_progress' | 'success' | 'failure' | 'voided' | 'timeout' | 'needs_attention';
        
-      txn_amount?:number;
+         /**
+          * @description Indicates when this refund occured.
+
+          */
+       
+      txn_date:number;
+       
+         /**
+          * @description Amount of this refund transaction.
+
+          */
+       
+      txn_amount:number;
     }
     export interface LinkedPayment {  
-      id?:string;
+         /**
+          * @description Uniquely identifies the transaction.
+
+          */
+       
+      id:string;
+       
+         /**
+          * @description The status of this transaction. \* needs_attention - Connection with Gateway got terminated abruptly. So, status of this transaction needs to be resolved manually \* success - The transaction is successful. \* voided - The transaction got voided or authorization expired at gateway. \* in_progress - Transaction is being processed by the gateway. This typically happens for [direct debit transactions](https://www.chargebee.com/docs/direct-debit-payments.html) or, in case of cards, refund transactions. Such transactions can take 2-7 days to complete, depending on the gateway and payment method. \* failure - Transaction failed. Refer the &#x27;error_code&#x27; and &#x27;error_text&#x27; fields to know the reason for failure \* timeout - Transaction failed because of Gateway not accepting the connection.
+
+          */
        
       status?:'in_progress' | 'success' | 'failure' | 'voided' | 'timeout' | 'needs_attention';
        
+         /**
+          * @description Amount for this transaction.
+
+          */
+       
       amount?:number;
        
+         /**
+          * @description Indicates when this transaction occurred.
+
+          */
+       
       date?:number;
     }
   }