chargebee 2.29.0 → 2.31.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +67 -0
- package/lib/chargebee.js +1 -1
- package/lib/resources/api_endpoints.js +16 -7
- package/package.json +1 -1
- package/types/core.d.ts +6 -5
- package/types/index.d.ts +2 -0
- package/types/resources/Card.d.ts +2 -2
- package/types/resources/CreditNote.d.ts +23 -2
- package/types/resources/CreditNoteEstimate.d.ts +2 -2
- package/types/resources/Customer.d.ts +98 -74
- package/types/resources/Entitlement.d.ts +78 -0
- package/types/resources/Export.d.ts +7 -7
- package/types/resources/Feature.d.ts +89 -17
- package/types/resources/Hierarchy.d.ts +5 -5
- package/types/resources/Invoice.d.ts +99 -49
- package/types/resources/InvoiceEstimate.d.ts +26 -20
- package/types/resources/ItemPrice.d.ts +21 -0
- package/types/resources/PaymentReferenceNumber.d.ts +1 -1
- package/types/resources/PaymentSource.d.ts +380 -246
- package/types/resources/Quote.d.ts +47 -26
- package/types/resources/QuoteLineGroup.d.ts +23 -17
- package/types/resources/Subscription.d.ts +29 -17
- package/types/resources/SubscriptionEntitlement.d.ts +1 -1
- package/types/resources/SubscriptionEstimate.d.ts +12 -12
- package/types/resources/ThirdPartyPaymentMethod.d.ts +1 -1
- package/types/resources/Token.d.ts +0 -116
- package/types/resources/Transaction.d.ts +35 -3
- package/types/resources/VirtualBankAccount.d.ts +4 -4
- package/types/resources/Media.d.ts +0 -33
- package/types/resources/NonSubscription.d.ts +0 -65
|
@@ -6,7 +6,7 @@ declare module 'chargebee' {
|
|
|
6
6
|
|
|
7
7
|
currency_code:string;
|
|
8
8
|
|
|
9
|
-
status?:'in_trial' | 'paused' | 'future' | 'active' | 'cancelled' | 'non_renewing';
|
|
9
|
+
status?:'in_trial' | 'paused' | 'transferred' | 'future' | 'active' | 'cancelled' | 'non_renewing';
|
|
10
10
|
|
|
11
11
|
trial_end_action?:TrialEndAction;
|
|
12
12
|
|
|
@@ -52,30 +52,30 @@ declare module 'chargebee' {
|
|
|
52
52
|
|
|
53
53
|
validation_status?:ValidationStatus;
|
|
54
54
|
|
|
55
|
-
index
|
|
55
|
+
index:number;
|
|
56
56
|
}
|
|
57
57
|
export interface ContractTerm {
|
|
58
|
-
id
|
|
58
|
+
id:string;
|
|
59
59
|
|
|
60
|
-
status
|
|
60
|
+
status:'active' | 'cancelled' | 'completed' | 'terminated';
|
|
61
61
|
|
|
62
|
-
contract_start
|
|
62
|
+
contract_start:number;
|
|
63
63
|
|
|
64
|
-
contract_end
|
|
64
|
+
contract_end:number;
|
|
65
65
|
|
|
66
|
-
billing_cycle
|
|
66
|
+
billing_cycle:number;
|
|
67
67
|
|
|
68
|
-
action_at_term_end
|
|
68
|
+
action_at_term_end:'cancel' | 'renew_once' | 'renew' | 'evergreen';
|
|
69
69
|
|
|
70
|
-
total_contract_value
|
|
70
|
+
total_contract_value:number;
|
|
71
71
|
|
|
72
|
-
total_contract_value_before_tax
|
|
72
|
+
total_contract_value_before_tax:number;
|
|
73
73
|
|
|
74
74
|
cancellation_cutoff_period?:number;
|
|
75
75
|
|
|
76
|
-
created_at
|
|
76
|
+
created_at:number;
|
|
77
77
|
|
|
78
|
-
subscription_id
|
|
78
|
+
subscription_id:string;
|
|
79
79
|
|
|
80
80
|
remaining_billing_cycles?:number;
|
|
81
81
|
}
|
|
@@ -10,7 +10,7 @@ declare module 'chargebee' {
|
|
|
10
10
|
type:Type;
|
|
11
11
|
|
|
12
12
|
/**
|
|
13
|
-
* @description Name of the gateway this card is stored with. \* ecentric - Ecentric provides a seamless payment processing service in South Africa specializing on omnichannel capabilities. \* bluesnap - BlueSnap is a payment gateway. \* tco - 2Checkout is a payment gateway. \* first_data_global - First Data Global Gateway Virtual Terminal Account \* exact - Exact Payments is a payment gateway. \* bluepay - BluePay is a payment gateway. \* paypal_express_checkout - PayPal Express Checkout is a payment gateway. \* eway - eWAY Account is a payment gateway. \* metrics_global - Metrics global is a leading payment service provider providing unified payment services in the US. \* 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. \* amazon_payments - Amazon Payments is a payment service provider. \* not_applicable - Indicates that payment gateway is not applicable for this resource. \* windcave - Windcave provides an end to end payment processing solution in ANZ and other leading global markets. \* 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. \* quickbooks - Intuit QuickBooks Payments gateway \* wepay - WePay is a payment gateway. \* worldpay - WorldPay 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. \* moneris_us - Moneris USA is a payment gateway. \* pin - Pin is a payment gateway \* authorize_net - Authorize.net 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. \* stripe - Stripe is a payment gateway. \* vantiv - Vantiv is a payment gateway. \* moneris - Moneris is a payment gateway. \* bank_of_america - Bank of America Gateway \* chargebee - Chargebee test 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 \* cybersource - CyberSource is a payment gateway.
|
|
13
|
+
* @description Name of the gateway this card is stored with. \* ecentric - Ecentric provides a seamless payment processing service in South Africa specializing on omnichannel capabilities. \* bluesnap - BlueSnap is a payment gateway. \* tco - 2Checkout is a payment gateway. \* first_data_global - First Data Global Gateway Virtual Terminal Account \* exact - Exact Payments is a payment gateway. \* bluepay - BluePay is a payment gateway. \* paypal_express_checkout - PayPal Express Checkout is a payment gateway. \* eway - eWAY Account is a payment gateway. \* metrics_global - Metrics global is a leading payment service provider providing unified payment services in the US. \* 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. \* amazon_payments - Amazon Payments is a payment service provider. \* not_applicable - Indicates that payment gateway is not applicable for this resource. \* windcave - Windcave provides an end to end payment processing solution in ANZ and other leading global markets. \* 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. \* quickbooks - Intuit QuickBooks Payments gateway \* wepay - WePay is a payment gateway. \* worldpay - WorldPay 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. \* moneris_us - Moneris USA is a payment gateway. \* pin - Pin is a payment gateway \* authorize_net - Authorize.net 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. \* stripe - Stripe is a payment gateway. \* vantiv - Vantiv is a payment gateway. \* moneris - Moneris is a payment gateway. \* bank_of_america - Bank of America Gateway \* chargebee - Chargebee test 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 \* cybersource - CyberSource is a payment gateway. \* ebanx - EBANX is a payment gateway, enabling businesses to accept diverse local payment methods from various countries for increased market reach and conversion.
|
|
14
14
|
|
|
15
15
|
*/
|
|
16
16
|
|
|
@@ -86,120 +86,4 @@ declare module 'chargebee' {
|
|
|
86
86
|
|
|
87
87
|
expired_at?:number;
|
|
88
88
|
}
|
|
89
|
-
export namespace Token {
|
|
90
|
-
export class TokenResource {
|
|
91
|
-
/**
|
|
92
|
-
* @description Generate a token that holds card related information.
|
|
93
|
-
|
|
94
|
-
*/
|
|
95
|
-
|
|
96
|
-
create_for_card(input?:CreateForCardInputParam):ChargebeeRequest<CreateForCardResponse>;
|
|
97
|
-
|
|
98
|
-
/**
|
|
99
|
-
* @description Generate a token using the one time token created by payment gateways for any specific payment method.
|
|
100
|
-
|
|
101
|
-
*/
|
|
102
|
-
|
|
103
|
-
create_using_temp_token(input:CreateUsingTempTokenInputParam):ChargebeeRequest<CreateUsingTempTokenResponse>;
|
|
104
|
-
|
|
105
|
-
/**
|
|
106
|
-
* @description Retrieve a token using token ID.
|
|
107
|
-
|
|
108
|
-
*/
|
|
109
|
-
|
|
110
|
-
retrieve(cb_token_id:string):ChargebeeRequest<RetrieveResponse>;
|
|
111
|
-
}
|
|
112
|
-
export interface CreateForCardResponse {
|
|
113
|
-
token:Token;
|
|
114
|
-
}
|
|
115
|
-
export interface CreateForCardInputParam {
|
|
116
|
-
|
|
117
|
-
/**
|
|
118
|
-
* @description Parameters for card
|
|
119
|
-
|
|
120
|
-
*/
|
|
121
|
-
|
|
122
|
-
card?:{additional_information?:object,billing_addr1?:string,billing_addr2?:string,billing_city?:string,billing_country?:string,billing_state?:string,billing_state_code?:string,billing_zip?:string,card_type?:'discover' | 'bancontact' | 'other' | 'visa' | 'jcb' | 'diners_club' | 'mastercard' | 'not_applicable' | 'american_express',cvv?:string,expiry_month:number,expiry_year:number,first_name?:string,gateway_account_id?:string,last_name?:string,number:string};
|
|
123
|
-
}
|
|
124
|
-
export interface CreateUsingTempTokenResponse {
|
|
125
|
-
token:Token;
|
|
126
|
-
}
|
|
127
|
-
export interface CreateUsingTempTokenInputParam {
|
|
128
|
-
|
|
129
|
-
/**
|
|
130
|
-
* @description The gateway account to which the token is associated.
|
|
131
|
-
|
|
132
|
-
*/
|
|
133
|
-
|
|
134
|
-
gateway_account_id?:string;
|
|
135
|
-
|
|
136
|
-
/**
|
|
137
|
-
* @description Type of payment method of the token. \* google_pay - Payments made via Google Pay. \* apple_pay - Payments made via Apple Pay. \* unionpay - Payments made via UnionPay. \* ideal - Payments made via iDEAL. \* amazon_payments - Payments made via Amazon Payments. \* bancontact - Payments made via Bancontact Card. \* netbanking_emandates - Netbanking (eMandates) Payments. \* alipay - Payments made via Alipay. \* card - Card based payment including credit cards and debit cards. Details about the card can be obtained from the card resource. \* dotpay - Payments made via Dotpay. \* giropay - Payments made via giropay. \* upi - UPI Payments. \* sofort - Payments made via Sofort. \* direct_debit - Represents bank account for which the direct debit or ACH agreement/mandate is created. \* generic - Payments made via Generic Payment Method. \* wechat_pay - Payments made via WeChat Pay. \* paypal_express_checkout - Payments made via PayPal Express Checkout.
|
|
138
|
-
|
|
139
|
-
*/
|
|
140
|
-
|
|
141
|
-
payment_method_type:PaymentMethodType;
|
|
142
|
-
|
|
143
|
-
/**
|
|
144
|
-
* @description Single-use token created by payment gateways. In Stripe, a single-use token is created for Apple Pay Wallet, card details or direct debit. In Braintree, a nonce is created for Apple Pay Wallet, PayPal, or card details. In Authorize.net, a nonce is created for card details. In Adyen, an encrypted data is created from the card details.
|
|
145
|
-
|
|
146
|
-
*/
|
|
147
|
-
|
|
148
|
-
id_at_vault:string;
|
|
149
|
-
|
|
150
|
-
/**
|
|
151
|
-
* @description Represents what type of object at gateway eg. "token" in case Stripe token and "source" in case of Stripe Source.
|
|
152
|
-
|
|
153
|
-
*/
|
|
154
|
-
|
|
155
|
-
gw_obj_type?:string;
|
|
156
|
-
|
|
157
|
-
/**
|
|
158
|
-
* @description Used to derieve Bank Account Scheme by default will take site default currency.
|
|
159
|
-
|
|
160
|
-
*/
|
|
161
|
-
|
|
162
|
-
currency_code?:string;
|
|
163
|
-
|
|
164
|
-
/**
|
|
165
|
-
* @description * `checkout_com`: While adding a new payment method using [permanent token](./payment_sources?#create_using_permanent_token) or passing raw card details to Checkout.com, `document` ID and `country_of_residence` are required to support payments through [dLocal](https://www.checkout.com/docs/previous/payments/payment-methods/cards/dlocal).
|
|
166
|
-
* `payer`: User related information.
|
|
167
|
-
* `country_of_residence`: This is required since the billing country associated with the user's payment method may not be the same as their country of residence. Hence the user's country of residence needs to be specified. The country code should be a [two-character ISO code](https://www.checkout.com/docs/developer-resources/testing/codes/country-codes).
|
|
168
|
-
* `document`: Document ID is the user's [identification number](https://docs.dlocal.com/reference/country-reference#documents) based on their country.
|
|
169
|
-
* `bluesnap`: While passing raw card details to BlueSnap, if `fraud_session_id` is added, [additional validation](https://developers.bluesnap.com/reference/fraud-prevention) is performed to avoid fraudulent transactions.
|
|
170
|
-
* `fraud`: Fraud identification related information.
|
|
171
|
-
* `fraud_session_id`: Your [BlueSnap fraud session ID](https://developers.bluesnap.com/reference/fraud-prevention#section-implementing-device-data-collector) required to perform anti-fraud validation.
|
|
172
|
-
* `braintree`: While passing raw card details to Braintree, your `fraud_merchant_id` and the user's `device_session_id` can be added to perform [additional validation](https://developer.paypal.com/braintree/docs/guides/premium-fraud-management-tools/device-data-collection/javascript/v3#collecting-device-data) and avoid fraudulent transactions.
|
|
173
|
-
* `fraud`: Fraud identification related information.
|
|
174
|
-
* `device_session_id`: Session ID associated with the user's device.
|
|
175
|
-
* `fraud_merchant_id`: Your [merchant ID](https://developer.paypal.com/braintree/docs/guides/premium-fraud-management-tools/device-data-collection/javascript/v3#collecting-device-data) for fraud detection.
|
|
176
|
-
* `chargebee_payments`: While passing raw card details to Chargebee Payments, if `fraud_session_id` is added, additional validation is performed to avoid fraudulent transactions.
|
|
177
|
-
* `fraud`: Fraud identification related information.
|
|
178
|
-
* `fraud_session_id`: Your Chargebee Payments fraud session ID required to perform anti-fraud validation.
|
|
179
|
-
.
|
|
180
|
-
|
|
181
|
-
*/
|
|
182
|
-
|
|
183
|
-
additional_information?:object;
|
|
184
|
-
|
|
185
|
-
/**
|
|
186
|
-
* @description Parameters for token_additional_detail
|
|
187
|
-
|
|
188
|
-
*/
|
|
189
|
-
|
|
190
|
-
token_additional_detail?:{expiry_month?:number,expiry_year?:number,first_name?:string,last_name?:string};
|
|
191
|
-
|
|
192
|
-
/**
|
|
193
|
-
* @description Parameters for token_billing_address
|
|
194
|
-
|
|
195
|
-
*/
|
|
196
|
-
|
|
197
|
-
token_billing_address?:{city?:string,country_code?:string,line1?:string,line2?:string,state?:string,state_code?:string,zip?:string};
|
|
198
|
-
}
|
|
199
|
-
export interface RetrieveResponse {
|
|
200
|
-
token:Token;
|
|
201
|
-
}
|
|
202
|
-
|
|
203
|
-
|
|
204
|
-
}
|
|
205
89
|
}
|
|
@@ -52,7 +52,7 @@ declare module 'chargebee' {
|
|
|
52
52
|
reference_number?:string;
|
|
53
53
|
|
|
54
54
|
/**
|
|
55
|
-
* @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.
|
|
55
|
+
* @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. \* ebanx - EBANX is a payment gateway, enabling businesses to accept diverse local payment methods from various countries for increased market reach and conversion.
|
|
56
56
|
|
|
57
57
|
*/
|
|
58
58
|
|
|
@@ -184,6 +184,8 @@ declare module 'chargebee' {
|
|
|
184
184
|
|
|
185
185
|
fraud_reason?:string;
|
|
186
186
|
|
|
187
|
+
custom_payment_method_id?:string;
|
|
188
|
+
|
|
187
189
|
/**
|
|
188
190
|
* @description This is the part of the `amount` which has not been invoiced yet and is therefore added to [excess_payments](customers#customer_excess_payments) for the customer. Applicable only for a transaction of `type` = `payment`.
|
|
189
191
|
|
|
@@ -275,6 +277,8 @@ declare module 'chargebee' {
|
|
|
275
277
|
|
|
276
278
|
payment_method_details?:string;
|
|
277
279
|
|
|
280
|
+
custom_payment_method_name?:string;
|
|
281
|
+
|
|
278
282
|
/**
|
|
279
283
|
* @description Applicable only for 'Payment' transactions. The list of invoices this 'payment' transaction is applied to.
|
|
280
284
|
|
|
@@ -302,6 +306,8 @@ declare module 'chargebee' {
|
|
|
302
306
|
*/
|
|
303
307
|
|
|
304
308
|
linked_payments?:Transaction.LinkedPayment[];
|
|
309
|
+
|
|
310
|
+
error_detail?:Transaction.GatewayErrorDetail;
|
|
305
311
|
}
|
|
306
312
|
export namespace Transaction {
|
|
307
313
|
export class TransactionResource {
|
|
@@ -431,6 +437,13 @@ declare module 'chargebee' {
|
|
|
431
437
|
|
|
432
438
|
reference_number?:string;
|
|
433
439
|
|
|
440
|
+
/**
|
|
441
|
+
* @description Records a refund made offline. Applicable only for `transaction`s of [type](transactions#transaction_type) = `payment`.
|
|
442
|
+
|
|
443
|
+
*/
|
|
444
|
+
|
|
445
|
+
custom_payment_method_id?:string;
|
|
446
|
+
|
|
434
447
|
/**
|
|
435
448
|
* @description Remarks, if any, on the refund.
|
|
436
449
|
|
|
@@ -528,14 +541,14 @@ declare module 'chargebee' {
|
|
|
528
541
|
|
|
529
542
|
*/
|
|
530
543
|
|
|
531
|
-
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};
|
|
544
|
+
payment_method?:{in?:string,is?:'other' | 'netbanking_emandates' | 'ach_credit' | 'dotpay' | 'boleto' | 'direct_debit' | 'automated_bank_transfer' | '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' | 'automated_bank_transfer' | '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};
|
|
532
545
|
|
|
533
546
|
/**
|
|
534
547
|
* @description Lists all the transactions.
|
|
535
548
|
|
|
536
549
|
*/
|
|
537
550
|
|
|
538
|
-
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};
|
|
551
|
+
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' | 'dlocal' | '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' | 'dlocal' | '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};
|
|
539
552
|
|
|
540
553
|
/**
|
|
541
554
|
* @description Lists all the transactions.
|
|
@@ -821,5 +834,24 @@ The [invoice](/docs/api/invoices?prod_cat_ver=1#invoice_status) is yet to b
|
|
|
821
834
|
|
|
822
835
|
date?:number;
|
|
823
836
|
}
|
|
837
|
+
export interface GatewayErrorDetail {
|
|
838
|
+
request_id?:string;
|
|
839
|
+
|
|
840
|
+
error_category?:string;
|
|
841
|
+
|
|
842
|
+
error_code?:string;
|
|
843
|
+
|
|
844
|
+
error_message?:string;
|
|
845
|
+
|
|
846
|
+
decline_code?:string;
|
|
847
|
+
|
|
848
|
+
decline_message?:string;
|
|
849
|
+
|
|
850
|
+
network_error_code?:string;
|
|
851
|
+
|
|
852
|
+
error_field?:string;
|
|
853
|
+
|
|
854
|
+
recommendation_code?:string;
|
|
855
|
+
}
|
|
824
856
|
}
|
|
825
857
|
}
|
|
@@ -28,7 +28,7 @@ declare module 'chargebee' {
|
|
|
28
28
|
|
|
29
29
|
*/
|
|
30
30
|
|
|
31
|
-
scheme?:'ach_credit' | 'sepa_credit';
|
|
31
|
+
scheme?:'eu_automated_bank_transfer' | 'gb_automated_bank_transfer' | 'mx_automated_bank_transfer' | 'ach_credit' | 'us_automated_bank_transfer' | 'jp_automated_bank_transfer' | 'sepa_credit';
|
|
32
32
|
|
|
33
33
|
/**
|
|
34
34
|
* @description Name of the bank
|
|
@@ -59,7 +59,7 @@ declare module 'chargebee' {
|
|
|
59
59
|
swift_code:string;
|
|
60
60
|
|
|
61
61
|
/**
|
|
62
|
-
* @description Name of the gateway this virtual bank account is stored in. \* ecentric - Ecentric provides a seamless payment processing service in South Africa specializing on omnichannel capabilities. \* bluesnap - BlueSnap is a payment gateway. \* tco - 2Checkout is a payment gateway. \* first_data_global - First Data Global Gateway Virtual Terminal Account \* exact - Exact Payments is a payment gateway. \* bluepay - BluePay is a payment gateway. \* paypal_express_checkout - PayPal Express Checkout is a payment gateway. \* eway - eWAY Account is a payment gateway. \* metrics_global - Metrics global is a leading payment service provider providing unified payment services in the US. \* 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. \* amazon_payments - Amazon Payments is a payment service provider. \* not_applicable - Indicates that payment gateway is not applicable for this resource. \* windcave - Windcave provides an end to end payment processing solution in ANZ and other leading global markets. \* 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. \* quickbooks - Intuit QuickBooks Payments gateway \* wepay - WePay is a payment gateway. \* worldpay - WorldPay 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. \* moneris_us - Moneris USA is a payment gateway. \* pin - Pin is a payment gateway \* authorize_net - Authorize.net 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. \* stripe - Stripe is a payment gateway. \* vantiv - Vantiv is a payment gateway. \* moneris - Moneris is a payment gateway. \* bank_of_america - Bank of America Gateway \* chargebee - Chargebee test 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 \* cybersource - CyberSource is a payment gateway.
|
|
62
|
+
* @description Name of the gateway this virtual bank account is stored in. \* ecentric - Ecentric provides a seamless payment processing service in South Africa specializing on omnichannel capabilities. \* bluesnap - BlueSnap is a payment gateway. \* tco - 2Checkout is a payment gateway. \* first_data_global - First Data Global Gateway Virtual Terminal Account \* exact - Exact Payments is a payment gateway. \* bluepay - BluePay is a payment gateway. \* paypal_express_checkout - PayPal Express Checkout is a payment gateway. \* eway - eWAY Account is a payment gateway. \* metrics_global - Metrics global is a leading payment service provider providing unified payment services in the US. \* 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. \* amazon_payments - Amazon Payments is a payment service provider. \* not_applicable - Indicates that payment gateway is not applicable for this resource. \* windcave - Windcave provides an end to end payment processing solution in ANZ and other leading global markets. \* 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. \* quickbooks - Intuit QuickBooks Payments gateway \* wepay - WePay is a payment gateway. \* worldpay - WorldPay 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. \* moneris_us - Moneris USA is a payment gateway. \* pin - Pin is a payment gateway \* authorize_net - Authorize.net 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. \* stripe - Stripe is a payment gateway. \* vantiv - Vantiv is a payment gateway. \* moneris - Moneris is a payment gateway. \* bank_of_america - Bank of America Gateway \* chargebee - Chargebee test 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 \* cybersource - CyberSource is a payment gateway. \* ebanx - EBANX is a payment gateway, enabling businesses to accept diverse local payment methods from various countries for increased market reach and conversion.
|
|
63
63
|
|
|
64
64
|
*/
|
|
65
65
|
|
|
@@ -177,7 +177,7 @@ declare module 'chargebee' {
|
|
|
177
177
|
|
|
178
178
|
*/
|
|
179
179
|
|
|
180
|
-
scheme?:'ach_credit' | 'sepa_credit';
|
|
180
|
+
scheme?:'eu_automated_bank_transfer' | 'gb_automated_bank_transfer' | 'mx_automated_bank_transfer' | 'ach_credit' | 'us_automated_bank_transfer' | 'jp_automated_bank_transfer' | 'sepa_credit';
|
|
181
181
|
}
|
|
182
182
|
export interface CreateResponse {
|
|
183
183
|
virtual_bank_account:VirtualBankAccount;
|
|
@@ -205,7 +205,7 @@ declare module 'chargebee' {
|
|
|
205
205
|
|
|
206
206
|
*/
|
|
207
207
|
|
|
208
|
-
scheme?:'ach_credit' | 'sepa_credit';
|
|
208
|
+
scheme?:'eu_automated_bank_transfer' | 'gb_automated_bank_transfer' | 'mx_automated_bank_transfer' | 'ach_credit' | 'us_automated_bank_transfer' | 'jp_automated_bank_transfer' | 'sepa_credit';
|
|
209
209
|
}
|
|
210
210
|
export interface RetrieveResponse {
|
|
211
211
|
virtual_bank_account:VirtualBankAccount;
|
|
@@ -1,33 +0,0 @@
|
|
|
1
|
-
///<reference path='./../core.d.ts'/>
|
|
2
|
-
declare module 'chargebee' {
|
|
3
|
-
export interface Media {
|
|
4
|
-
|
|
5
|
-
/**
|
|
6
|
-
* @description The unique identifier for the media file. This is auto-generated by Chargebee.
|
|
7
|
-
|
|
8
|
-
*/
|
|
9
|
-
|
|
10
|
-
id:string;
|
|
11
|
-
|
|
12
|
-
/**
|
|
13
|
-
* @description The public URL for accessing the media file. This is auto-generated by Chargebee.
|
|
14
|
-
|
|
15
|
-
*/
|
|
16
|
-
|
|
17
|
-
url?:string;
|
|
18
|
-
|
|
19
|
-
/**
|
|
20
|
-
* @description The [alternative text](https://webaim.org/techniques/alttext/) for the image. Applicable only when the top-level `media_type` is `image`.
|
|
21
|
-
|
|
22
|
-
*/
|
|
23
|
-
|
|
24
|
-
alt_text?:string;
|
|
25
|
-
|
|
26
|
-
/**
|
|
27
|
-
* @description The [media type](https://en.wikipedia.org/wiki/Media_type) of the file.
|
|
28
|
-
|
|
29
|
-
*/
|
|
30
|
-
|
|
31
|
-
media_type?:string;
|
|
32
|
-
}
|
|
33
|
-
}
|
|
@@ -1,65 +0,0 @@
|
|
|
1
|
-
///<reference path='./../core.d.ts'/>
|
|
2
|
-
declare module 'chargebee' {
|
|
3
|
-
export interface NonSubscription {
|
|
4
|
-
|
|
5
|
-
/**
|
|
6
|
-
* @description The unique immutable identifier of the invoice imported in Chargebee for which the receipt was sent.
|
|
7
|
-
|
|
8
|
-
*/
|
|
9
|
-
|
|
10
|
-
invoice_id:string;
|
|
11
|
-
|
|
12
|
-
/**
|
|
13
|
-
* @description The unique immutable identifier of the customer object to which the invoice belongs.
|
|
14
|
-
|
|
15
|
-
*/
|
|
16
|
-
|
|
17
|
-
customer_id?:string;
|
|
18
|
-
|
|
19
|
-
/**
|
|
20
|
-
* @description The [`subscription_item.item_price_id`](https://apidocs.chargebee.com/docs/api/subscriptions?prod_cat_ver=2#subscription_item_tiers_item_price_id) where the `item_type` is `charge`.
|
|
21
|
-
|
|
22
|
-
*/
|
|
23
|
-
|
|
24
|
-
charge_id:string;
|
|
25
|
-
}
|
|
26
|
-
export namespace NonSubscription {
|
|
27
|
-
export class NonSubscriptionResource {
|
|
28
|
-
/**
|
|
29
|
-
* @description This API is used to sync consumable, non-consumable, and non-renewing product payments in Chargebee.
|
|
30
|
-
|
|
31
|
-
*/
|
|
32
|
-
|
|
33
|
-
process_receipt(non_subscription_app_id:string, input:ProcessReceiptInputParam):ChargebeeRequest<ProcessReceiptResponse>;
|
|
34
|
-
}
|
|
35
|
-
export interface ProcessReceiptResponse {
|
|
36
|
-
non_subscription:NonSubscription;
|
|
37
|
-
}
|
|
38
|
-
export interface ProcessReceiptInputParam {
|
|
39
|
-
|
|
40
|
-
/**
|
|
41
|
-
* @description **Google Play Store** : The purchase `token` taken from the Android device after successful creation of the in-app purchase.
|
|
42
|
-
|
|
43
|
-
**Apple App Store** : The Base64 encoded [App Store in-app purchase receipt](https://developer.apple.com/documentation/storekit/original_api_for_in-app_purchase/validating_receipts_with_the_app_store?language=objc#overview) taken from the Apple device after successful creation of the in-app purchase.
|
|
44
|
-
|
|
45
|
-
*/
|
|
46
|
-
|
|
47
|
-
receipt:string;
|
|
48
|
-
|
|
49
|
-
/**
|
|
50
|
-
* @description Parameters for product
|
|
51
|
-
|
|
52
|
-
*/
|
|
53
|
-
|
|
54
|
-
product?:{currency_code:string,id:string,name?:string,price:number,price_in_decimal?:string,type:'non_consumable' | 'consumable' | 'non_renewing_subscription'};
|
|
55
|
-
|
|
56
|
-
/**
|
|
57
|
-
* @description Parameters for customer
|
|
58
|
-
|
|
59
|
-
*/
|
|
60
|
-
|
|
61
|
-
customer?:{email?:string,first_name?:string,id?:string,last_name?:string};
|
|
62
|
-
}
|
|
63
|
-
|
|
64
|
-
}
|
|
65
|
-
}
|