chargebee 2.42.0 → 2.43.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 +23 -0
- package/lib/chargebee.js +1 -1
- package/lib/resources/api_endpoints.js +7 -0
- package/package.json +1 -1
- package/types/core.d.ts +2 -1
- package/types/index.d.ts +1 -0
- package/types/resources/Card.d.ts +1 -1
- package/types/resources/Estimate.d.ts +26 -7
- package/types/resources/ItemPrice.d.ts +78 -844
- package/types/resources/PaymentScheduleEstimate.d.ts +35 -0
- package/types/resources/PaymentScheduleScheme.d.ts +2 -0
- package/types/resources/PaymentSource.d.ts +25 -896
- package/types/resources/PricingPageSession.d.ts +4 -0
- package/types/resources/Quote.d.ts +41 -38
- package/types/resources/QuotedSubscription.d.ts +53 -378
- package/types/resources/Subscription.d.ts +4 -2
|
@@ -3,358 +3,88 @@
|
|
|
3
3
|
declare module 'chargebee' {
|
|
4
4
|
export interface PaymentSource {
|
|
5
5
|
|
|
6
|
-
/**
|
|
7
|
-
* @description Identifier of the payment source
|
|
8
6
|
|
|
9
|
-
*/
|
|
10
|
-
|
|
11
7
|
id:string;
|
|
12
|
-
|
|
13
|
-
/**
|
|
14
|
-
* @description Version number of this resource. The `resource_version` is updated with a new timestamp in milliseconds for every change made to the resource. This attribute will be present only if the resource has been updated after 2016-09-28.
|
|
15
8
|
|
|
16
|
-
*/
|
|
17
|
-
|
|
18
9
|
resource_version?:number;
|
|
19
|
-
|
|
20
|
-
/**
|
|
21
|
-
* @description Timestamp indicating when this payment source resource was last updated.
|
|
22
10
|
|
|
23
|
-
*/
|
|
24
|
-
|
|
25
11
|
updated_at?:number;
|
|
26
|
-
|
|
27
|
-
/**
|
|
28
|
-
* @description Timestamp indicating when this payment source resource is created.
|
|
29
12
|
|
|
30
|
-
*/
|
|
31
|
-
|
|
32
13
|
created_at:number;
|
|
33
|
-
|
|
34
|
-
/**
|
|
35
|
-
* @description Identifier of the customer with whom this payment source is associated.
|
|
36
14
|
|
|
37
|
-
*/
|
|
38
|
-
|
|
39
15
|
customer_id:string;
|
|
40
|
-
|
|
41
|
-
/**
|
|
42
|
-
* @description Type of payment source \* direct_debit - Represents bank account for which the direct debit or ACH agreement/mandate is created. \* unionpay - Payments made via UnionPay. \* google_pay - Payments made via Google Pay. \* dotpay - Payments made via Dotpay. \* giropay - Payments made via giropay. \* alipay - Payments made via Alipay. \* sofort - Payments made via Sofort. \* wechat_pay - Payments made via WeChat Pay. \* netbanking_emandates - Netbanking (eMandates) Payments. \* bancontact - Payments made via Bancontact Card. \* card - Card based payment including credit cards and debit cards. Details about the card can be obtained from the card resource. \* amazon_payments - Payments made via Amazon Payments. \* generic - Payments made via Generic Payment Method. \* paypal_express_checkout - Payments made via PayPal Express Checkout. \* ideal - Payments made via iDEAL. \* upi - UPI Payments. \* apple_pay - Payments made via Apple Pay.
|
|
43
16
|
|
|
44
|
-
*/
|
|
45
|
-
|
|
46
17
|
type:Type;
|
|
47
|
-
|
|
48
|
-
/**
|
|
49
|
-
* @description The reference id. In the case of Amazon and PayPal this will be the 'billing agreement id'. For GoCardless direct debit this will be 'mandate id'. In the case of card payments this will be the identifier provided by the gateway/card vault for the specific payment method resource.
|
|
50
|
-
**Note:** This is not the one time temporary token provided by gateways like Stripe.
|
|
51
18
|
|
|
52
|
-
*/
|
|
53
|
-
|
|
54
19
|
reference_id:string;
|
|
55
|
-
|
|
56
|
-
/**
|
|
57
|
-
* @description Current status of the payment source. \* valid - A payment source that is valid and active. \* expiring - A payment source that is expiring (like card's status based on its expiry date). \* invalid - The billing agreement cannot be used. It might become valid again either automatically or due to customer action. \* pending_verification - The payment source needs to be verified \* expired - A payment source that has expired
|
|
58
20
|
|
|
59
|
-
*/
|
|
60
|
-
|
|
61
21
|
status:'valid' | 'expiring' | 'expired' | 'invalid' | 'pending_verification';
|
|
62
|
-
|
|
63
|
-
/**
|
|
64
|
-
* @description Name of the gateway this payment source is stored with. \* 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. \* 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. \* metrics_global - Metrics global is a leading payment service provider providing unified payment services in the US. \* amazon_payments - Amazon Payments is a payment service provider. \* 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 \* 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. \* bank_of_america - Bank of America 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 \* ebanx - EBANX is a payment gateway, enabling businesses to accept diverse local payment methods from various countries for increased market reach and conversion.
|
|
65
22
|
|
|
66
|
-
*/
|
|
67
|
-
|
|
68
23
|
gateway:Gateway;
|
|
69
|
-
|
|
70
|
-
/**
|
|
71
|
-
* @description The gateway account to which this payment source is stored with.
|
|
72
24
|
|
|
73
|
-
*/
|
|
74
|
-
|
|
75
25
|
gateway_account_id?:string;
|
|
76
|
-
|
|
77
|
-
/**
|
|
78
|
-
* @description The IP address of the customer. Used primarily for referral integration and EU VAT validation.
|
|
79
26
|
|
|
80
|
-
*/
|
|
81
|
-
|
|
82
27
|
ip_address?:string;
|
|
83
|
-
|
|
84
|
-
/**
|
|
85
|
-
* @description [two-letter(alpha2)](https://www.iso.org/iso-3166-country-codes.html) ISO country code.
|
|
86
28
|
|
|
87
|
-
*/
|
|
88
|
-
|
|
89
29
|
issuing_country?:string;
|
|
90
|
-
|
|
91
|
-
/**
|
|
92
|
-
* @description Indicates that this resource has been deleted.
|
|
93
|
-
|
|
94
|
-
*/
|
|
95
|
-
|
|
96
|
-
deleted:boolean;
|
|
97
|
-
|
|
98
|
-
/**
|
|
99
|
-
* @description The unique ID of the [business entity](/docs/api/advanced-features?prod_cat_ver=2#mbe) of this `payment_source`. This is always the same as the business entity of the [customer](/docs/api/payment_sources?prod_cat_ver=2#payment_source_customer_id).
|
|
100
|
-
|
|
101
|
-
*/
|
|
102
|
-
|
|
103
|
-
business_entity_id?:string;
|
|
104
|
-
|
|
105
|
-
/**
|
|
106
|
-
* @description Card details associated with this payment source.
|
|
107
30
|
|
|
108
|
-
*/
|
|
109
|
-
|
|
110
31
|
card?:PaymentSource.Card;
|
|
111
|
-
|
|
112
|
-
/**
|
|
113
|
-
* @description Bank account details the direct debit or ACH or NetBanking agreement/mandate created with this payment source.
|
|
114
32
|
|
|
115
|
-
*/
|
|
116
|
-
|
|
117
33
|
bank_account?:PaymentSource.BankAccount;
|
|
118
|
-
|
|
119
|
-
/**
|
|
120
|
-
* @description Boleto payment source details of the customer
|
|
121
34
|
|
|
122
|
-
*/
|
|
123
|
-
|
|
124
35
|
boleto?:PaymentSource.CustVoucherSource;
|
|
125
|
-
|
|
126
|
-
/**
|
|
127
|
-
* @description Billing address for the payment source.
|
|
128
36
|
|
|
129
|
-
*/
|
|
130
|
-
|
|
131
37
|
billing_address?:PaymentSource.BillingAddress;
|
|
132
|
-
|
|
133
|
-
/**
|
|
134
|
-
* @description Amazon payments details associated with this payment source.
|
|
135
38
|
|
|
136
|
-
*/
|
|
137
|
-
|
|
138
39
|
amazon_payment?:PaymentSource.AmazonPayment;
|
|
139
|
-
|
|
140
|
-
/**
|
|
141
|
-
* @description Represents the payment method that allows you to make payments directly using a bank account.
|
|
142
40
|
|
|
143
|
-
*/
|
|
144
|
-
|
|
145
41
|
upi?:PaymentSource.Upi;
|
|
146
|
-
|
|
147
|
-
/**
|
|
148
|
-
* @description PayPal Express Checkout details associated with this payment source.
|
|
149
42
|
|
|
150
|
-
*/
|
|
151
|
-
|
|
152
43
|
paypal?:PaymentSource.Paypal;
|
|
153
|
-
|
|
44
|
+
|
|
154
45
|
venmo?:PaymentSource.Venmo;
|
|
155
|
-
|
|
46
|
+
|
|
156
47
|
klarna_pay_now?:PaymentSource.KlarnaPayNow;
|
|
157
|
-
|
|
158
|
-
/**
|
|
159
|
-
* @description Mandate details associated with the payment source.
|
|
160
48
|
|
|
161
|
-
*/
|
|
162
|
-
|
|
163
49
|
mandates?:PaymentSource.Mandate[];
|
|
50
|
+
|
|
51
|
+
deleted:boolean;
|
|
52
|
+
|
|
53
|
+
business_entity_id?:string;
|
|
54
|
+
|
|
164
55
|
}
|
|
165
56
|
export namespace PaymentSource {
|
|
166
57
|
export class PaymentSourceResource {
|
|
167
|
-
/**
|
|
168
|
-
* @description This API offers an alternative way to create a payment source using a single-use gateway temporary token, which is generally provided by your payment gateway. In the case of Stripe, this temporary token is generated according to the instruction detailed in [Stripe documentation](https://stripe.com/docs/api/tokens/create_card).
|
|
169
|
-
Storing card after successful 3DS completion is not supported in this API. Use [create using Payment Intent API](/docs/api/payment_sources#create_using_payment_intent) under Payment source to store the card after successful 3DS flow completion.
|
|
170
|
-
|
|
171
|
-
*/
|
|
172
|
-
|
|
173
58
|
create_using_temp_token(input:CreateUsingTempTokenInputParam):ChargebeeRequest<CreateUsingTempTokenResponse>;
|
|
174
59
|
|
|
175
|
-
/**
|
|
176
|
-
* @description This API provides an alternative way to create a payment source using a permanent token, instead of having to add the full payment method details via API or the Chargebee UI. Permanent tokens are provided by payment gateways such as Stripe.
|
|
177
|
-
Storing card after successful 3DS completion is not supported in this API. Use [create using Payment Intent API](/docs/api/payment_sources#create_using_payment_intent) under Payment source to store the card after successful 3DS flow completion.
|
|
178
|
-
|
|
179
|
-
*/
|
|
180
|
-
|
|
181
60
|
create_using_permanent_token(input:CreateUsingPermanentTokenInputParam):ChargebeeRequest<CreateUsingPermanentTokenResponse>;
|
|
182
61
|
|
|
183
|
-
/**
|
|
184
|
-
* @description Storing card after successful 3DS completion is not supported in this API. Use [create using Payment Intent API](/docs/api/payment_sources#create_using_payment_intent) under Payment source to store the card after successful 3DS flow completion.
|
|
185
|
-
|
|
186
|
-
*/
|
|
187
|
-
|
|
188
62
|
create_using_token(input:CreateUsingTokenInputParam):ChargebeeRequest<CreateUsingTokenResponse>;
|
|
189
63
|
|
|
190
|
-
/**
|
|
191
|
-
* @description Used to attach the card to the customer after 3DS completion. [Learn more](/docs/api/3ds_card_payments) on the 3DS implementation via Chargebee APIs.
|
|
192
|
-
|
|
193
|
-
*/
|
|
194
|
-
|
|
195
64
|
create_using_payment_intent(input:CreateUsingPaymentIntentInputParam):ChargebeeRequest<CreateUsingPaymentIntentResponse>;
|
|
196
65
|
|
|
197
|
-
/**
|
|
198
|
-
* @description Create a voucher payment method for the payment source.
|
|
199
|
-
|
|
200
|
-
*/
|
|
201
|
-
|
|
202
66
|
create_voucher_payment_source(input:CreateVoucherPaymentSourceInputParam):ChargebeeRequest<CreateVoucherPaymentSourceResponse>;
|
|
203
67
|
|
|
204
|
-
/**
|
|
205
|
-
* @description Storing card after successful 3DS completion is not supported in this API. Use [create using Payment Intent API](/docs/api/payment_sources#create_using_payment_intent) under Payment source to store the card after successful 3DS flow completion.
|
|
206
|
-
|
|
207
|
-
*/
|
|
208
|
-
|
|
209
68
|
create_card(input:CreateCardInputParam):ChargebeeRequest<CreateCardResponse>;
|
|
210
69
|
|
|
211
|
-
/**
|
|
212
|
-
* @description This API adds a Direct Debit payment source for a customer. The bank account details collected from your customer are passed as input to this API.
|
|
213
|
-
|
|
214
|
-
#### [Automated Clearing House (ACH) Network](https://www.chargebee.com/docs/direct-debit-payments.html#direct-debit-payments-in-the-united-states)
|
|
215
|
-
|
|
216
|
-
ACH is an electronic network for passing financial transactions in the US. Chargebee currently supports ACH via [Stripe](https://www.chargebee.com/docs/ach-payments-stripe.html) , [Authorize.Net](https://www.chargebee.com/docs/ach-payments-authorize_net.html), and [GoCardless](https://www.chargebee.com/docs/2.0/gocardless.html).
|
|
217
|
-
**Note:**
|
|
218
|
-
|
|
219
|
-
* For ACH via Stripe, it is mandatory to pass [user details](/docs/api/advanced-features#user_details) such as IP address(`chargebee-request-origin-ip`) and the device information(`chargebee-request-origin-device`).
|
|
220
|
-
|
|
221
|
-
##### Bank account verification
|
|
222
|
-
|
|
223
|
-
Once the bank account has been added, it needs to be verified.
|
|
224
|
-
|
|
225
|
-
* For Stripe, perform this verification using the [Verify bank account payment source API](/docs/api/payment_sources#verify_bank_account_payment_source).
|
|
226
|
-
* For [Authorize.net](https://www.authorize.net/), the verification is done by them in 2-3 days after the account is added. No intervention is needed from your side or your customer.
|
|
227
|
-
|
|
228
|
-
|
|
229
|
-
|
|
230
|
-
#### Single Euro Payment Area (SEPA)
|
|
231
|
-
|
|
232
|
-
SEPA is an initiative that integrates bank transfer payments denominated in euro. It is supported via [GoCardless](https://www.chargebee.com/docs/gocardless.html), [Stripe](https://www.chargebee.com/docs/sepa-stripe.html) and [Adyen](https://www.chargebee.com/docs/adyen-sepa.html).
|
|
233
|
-
**Note:**
|
|
234
|
-
|
|
235
|
-
* For SEPA via Stripe, it is mandatory to pass [user details](/docs/api/advanced-features#user_details) such as IP address and device information.
|
|
236
|
-
* For GoCardless, [local bank details](https://developer.gocardless.com/api-reference/#appendix-local-bank-details) can be passed instead of IBAN.
|
|
237
|
-
|
|
238
|
-
#### Bacs Payment Schemes Limited (BACS) and Bg Autogiro
|
|
239
|
-
|
|
240
|
-
Bacs is an organization that manages the Direct Debit and Direct Credit payment methods in the UK. Bg Autogiro is a Direct Debit scheme for krona denominated payments in Sweden. Both Bacs and Bg Autogiro are supported via [GoCardless](https://www.chargebee.com/docs/gocardless.html).
|
|
241
|
-
**Note:**
|
|
242
|
-
|
|
243
|
-
* For BACS via Stripe, it is mandatory to pass [user details](/docs/api/advanced-features#user_details) such as IP address(`chargebee-request-origin-ip`) and the device information(`chargebee-request-origin-device`).
|
|
244
|
-
|
|
245
|
-
#### Bulk Electronic Clearing System (BECS) and Pre-Authorized Debit (PAD)
|
|
246
|
-
|
|
247
|
-
BECS is an automated payment method for Direct Debit in Australia and New Zealand while PAD does the same for Canada. [GoCardless](https://www.chargebee.com/docs/gocardless.html) supports both.
|
|
248
|
-
|
|
249
|
-
For Direct Debit, the customer needs to accept a mandate that allows the merchant to debit their bank account. This agreement PDF can be obtained using the [Retrieve direct debit agreement PDF API](/docs/api/hosted_pages#retrieve_direct_debit_agreement_pdf).
|
|
250
|
-
|
|
251
|
-
If the customer has already reached the payment source limit allowed for the site, pass `replace_primary_payment_source` as `true`. Alternatively, [delete](/docs/api/payment_sources#delete_a_payment_source) one of the payment sources first and then add the bank account payment source for the customer.
|
|
252
|
-
**Note:**
|
|
253
|
-
|
|
254
|
-
* For BECS via Stripe, it is mandatory to pass [user details](/docs/api/advanced-features#user_details) such as IP address(`chargebee-request-origin-ip`) and the device information(`chargebee-request-origin-device`).
|
|
255
|
-
|
|
256
|
-
*/
|
|
257
|
-
|
|
258
70
|
create_bank_account(input:CreateBankAccountInputParam):ChargebeeRequest<CreateBankAccountResponse>;
|
|
259
71
|
|
|
260
|
-
/**
|
|
261
|
-
* @description Merchants look to update card details when:
|
|
262
|
-
|
|
263
|
-
* The billing address of a customer has changed. In such a case, modify the billing address in the Chargebee and the payment gateway.
|
|
264
|
-
* The expiration date of the card has been extended by the bank. (This usually happens when the date of card expiry is in near future).
|
|
265
|
-
|
|
266
|
-
Multiple parameters such as address, expiry date, month, and so on, can be updated through this API.
|
|
267
|
-
|
|
268
|
-
Meta data can also be added additionally(supported in Stripe only). Metadata is a JSON object. It is used to store additional information about customers.
|
|
269
|
-
|
|
270
|
-
In **Stripe** and **Braintree** payment gateways, changes in card details are auto-updated. This feature can also be used for other payment gateways in which auto-update is not enabled or is not supported by Chargebee.
|
|
271
|
-
**Note** : This endpoint supports Chargebee Test Gateway, [Stripe](https://www.chargebee.com/docs/2.0/stripe.html), [Braintree](https://www.chargebee.com/docs/2.0/braintree.html), [Authorize.net](https://www.chargebee.com/docs/2.0/authorize-index.html), [Worldpay US eCom](https://www.chargebee.com/docs/2.0/vantiv_worldpay.html), and [WorldPay Direct Integration](https://www.chargebee.com/docs/2.0/worldpay-direct.html). For all other gateways, your customers must re-enter the full [card details](/docs/api/payment_sources#update_a_card_payment_source_card_first_name) to update existing card details. For example, consider a customer not using the gateways mentioned above and wants to update the [card\[billing_addr1\]](/docs/api/payment_sources#update_a_card_payment_source_card_billing_addr1) parameter. In such a case, the customer must re-enter the value of all the parameters present in the [card](/docs/api/payment_sources#update_a_card_payment_source_card_first_name) object.
|
|
272
|
-
|
|
273
|
-
*/
|
|
274
|
-
|
|
275
72
|
update_card(cust_payment_source_id:string, input?:UpdateCardInputParam):ChargebeeRequest<UpdateCardResponse>;
|
|
276
73
|
|
|
277
|
-
/**
|
|
278
|
-
* @description This API is used to update the payment source details of a customer. Information related to bank account payment source such as email, first name, and last name can be updated.
|
|
279
|
-
|
|
280
|
-
* For GoCardless, Chargebee supports (ACH,BACS,SEPA,AUTOGIRO,BECS,BECS_NZ,PAD).
|
|
281
|
-
* For Stripe, Chargebee only supports SEPA.
|
|
282
|
-
|
|
283
|
-
|
|
284
|
-
|
|
285
|
-
|
|
286
|
-
*/
|
|
287
|
-
|
|
288
74
|
update_bank_account(cust_payment_source_id:string, input?:UpdateBankAccountInputParam):ChargebeeRequest<UpdateBankAccountResponse>;
|
|
289
75
|
|
|
290
|
-
/**
|
|
291
|
-
* @description This API can be used to verify bank accounts which have been added as payment source. This is applicable for **Stripe ACH with micro-deposit mode bank accounts** only. Stripe handles verification in two ways - via Plaid, and micro-deposit.
|
|
292
|
-
|
|
293
|
-
For verifying bank accounts via **micro-deposit**, Stripe deposits two small amounts to the bank account being added. These deposits will take 1-2 business days to appear on the customer's bank statement. The bank statement description for the two micro-deposits contains the amount and the values deposited. Your customer will need to relay the value of the two deposits to you, after which you can verify the bank account. Once the bank account has been verified, the payment source will be marked as "Valid".
|
|
294
|
-
|
|
295
|
-
*/
|
|
296
|
-
|
|
297
76
|
verify_bank_account(cust_payment_source_id:string, input:VerifyBankAccountInputParam):ChargebeeRequest<VerifyBankAccountResponse>;
|
|
298
77
|
|
|
299
|
-
/**
|
|
300
|
-
* @description Retrieves the payment source identified by the unique identifier.
|
|
301
|
-
|
|
302
|
-
*/
|
|
303
|
-
|
|
304
78
|
retrieve(cust_payment_source_id:string):ChargebeeRequest<RetrieveResponse>;
|
|
305
79
|
|
|
306
|
-
/**
|
|
307
|
-
* @description Lists all the payment sources
|
|
308
|
-
|
|
309
|
-
*/
|
|
310
|
-
|
|
311
80
|
list(input?:ListInputParam):ChargebeeRequest<ListResponse>;
|
|
312
81
|
|
|
313
|
-
/**
|
|
314
|
-
* @description Switches the gateway in which this payment source information is stored.
|
|
315
|
-
|
|
316
|
-
This is applicable only if the payment source is present in Spreedly vault.
|
|
317
|
-
|
|
318
|
-
*/
|
|
319
|
-
|
|
320
82
|
switch_gateway_account(cust_payment_source_id:string, input:SwitchGatewayAccountInputParam):ChargebeeRequest<SwitchGatewayAccountResponse>;
|
|
321
83
|
|
|
322
|
-
/**
|
|
323
|
-
* @description Copies this payment source information to the gateway specified in the API.
|
|
324
|
-
|
|
325
|
-
This is useful if you want to port your customer's card details into another gateway.
|
|
326
|
-
|
|
327
|
-
*/
|
|
328
|
-
|
|
329
84
|
export_payment_source(cust_payment_source_id:string, input:ExportPaymentSourceInputParam):ChargebeeRequest<ExportPaymentSourceResponse>;
|
|
330
85
|
|
|
331
|
-
/**
|
|
332
|
-
* @description Deletes a payment source. Once the payment source is deleted, if
|
|
333
|
-
|
|
334
|
-
* **Deleted payment source is Primary, and Backup is available**
|
|
335
|
-
* The Backup payment source will become the Primary payment source.
|
|
336
|
-
* **Deleted payment source is Primary, and no Backup is available**
|
|
337
|
-
* The other payment source available, but not assigned to any subscription, will become the Primary payment source. **Note** : *When multiple payment sources exist, the payment method added most recently will be considered*.
|
|
338
|
-
|
|
339
|
-
* If other payment sources available are assigned to subscriptions, the auto collection attribute for the customer will be set to Off, and the events *card_deleted* and *payment_source_deleted* will be triggered.
|
|
340
|
-
* **Deleted payment source is attached to subscriptions**
|
|
341
|
-
* Dunning will be initiated for subscriptions attached to this payment source if auto collection is set to On, and when no customer default is present.
|
|
342
|
-
|
|
343
|
-
|
|
344
|
-
|
|
345
|
-
If there is no such payment source present in the gateway for the customer, this API will return successfully without throwing any error.
|
|
346
|
-
**Note** :
|
|
347
|
-
If you delete the only available payment method of a customer in Chargebee, it also deletes the customer's record at the gateway. To delete the payment method locally(delete only in Chargebee), use [Local Delete a Payment Source API](/docs/api/payment_sources#local_delete_a_payment_source).
|
|
348
|
-
|
|
349
|
-
*/
|
|
350
|
-
|
|
351
86
|
delete(cust_payment_source_id:string):ChargebeeRequest<DeleteResponse>;
|
|
352
87
|
|
|
353
|
-
/**
|
|
354
|
-
* @description Deletes a payment method from Chargebee. Payment method in the payment gateway will not be affected.
|
|
355
|
-
|
|
356
|
-
*/
|
|
357
|
-
|
|
358
88
|
delete_local(cust_payment_source_id:string):ChargebeeRequest<DeleteLocalResponse>;
|
|
359
89
|
}
|
|
360
90
|
export interface CreateUsingTempTokenResponse {
|
|
@@ -364,78 +94,18 @@ If you delete the only available payment method of a customer in Chargebee, it a
|
|
|
364
94
|
}
|
|
365
95
|
export interface CreateUsingTempTokenInputParam {
|
|
366
96
|
|
|
367
|
-
/**
|
|
368
|
-
* @description Identifier of the customer with whom this payment source is associated.
|
|
369
|
-
|
|
370
|
-
*/
|
|
371
|
-
|
|
372
97
|
customer_id:string;
|
|
373
98
|
|
|
374
|
-
/**
|
|
375
|
-
* @description The gateway account to which the payment source is associated.
|
|
376
|
-
|
|
377
|
-
*/
|
|
378
|
-
|
|
379
99
|
gateway_account_id?:string;
|
|
380
100
|
|
|
381
|
-
/**
|
|
382
|
-
* @description Type of payment source. \* direct_debit - Represents bank account for which the direct debit or ACH agreement/mandate is created. \* dotpay - Payments made via Dotpay. \* bancontact - Payments made via Bancontact Card. \* unionpay - Payments made via UnionPay. \* paypal_express_checkout - Payments made via PayPal Express Checkout. \* 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. \* sofort - Payments made via Sofort. \* generic - Payments made via Generic Payment Method. \* amazon_payments - Payments made via Amazon Payments. \* google_pay - Payments made via Google Pay. \* giropay - Payments made via giropay. \* wechat_pay - Payments made via WeChat Pay. \* ideal - Payments made via iDEAL. \* netbanking_emandates - Netbanking (eMandates) Payments. \* apple_pay - Payments made via Apple Pay. \* upi - UPI Payments.
|
|
383
|
-
|
|
384
|
-
*/
|
|
385
|
-
|
|
386
101
|
type:Type;
|
|
387
102
|
|
|
388
|
-
/**
|
|
389
|
-
* @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.
|
|
390
|
-
|
|
391
|
-
*/
|
|
392
|
-
|
|
393
103
|
tmp_token:string;
|
|
394
104
|
|
|
395
|
-
/**
|
|
396
|
-
* @description 2-letter (alpha2) ISO country code. Indicates your customer's payment method country of issuance. Applicable for PayPal via Braintree.
|
|
397
|
-
|
|
398
|
-
*/
|
|
399
|
-
|
|
400
105
|
issuing_country?:string;
|
|
401
106
|
|
|
402
|
-
/**
|
|
403
|
-
* @description Indicates whether the primary payment source should be replaced with this payment source. In case of Create Subscription for Customer endpoint, the default value is True. Otherwise, the default value is False.
|
|
404
|
-
|
|
405
|
-
*/
|
|
406
|
-
|
|
407
107
|
replace_primary_payment_source?:boolean;
|
|
408
108
|
|
|
409
|
-
/**
|
|
410
|
-
* @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://docs.checkout.com/payment-methods/cards/dlocal).
|
|
411
|
-
* `payer`: User related information.
|
|
412
|
-
* `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://docs.checkout.com/resources/codes/country-codes).
|
|
413
|
-
* `document`: Document ID is the user's [identification number](https://docs.dlocal.com/api-documentation/payins-api-reference/country-reference#documents) based on their country.
|
|
414
|
-
* `bluesnap`: While passing raw card details to BlueSnap, if `fraud_session_id` is added, [additional validation](https://developers.bluesnap.com/docs/fraud-prevention) is performed to avoid fraudulent transactions.
|
|
415
|
-
* `fraud`: Fraud identification related information.
|
|
416
|
-
* `fraud_session_id`: Your [BlueSnap fraud session ID](https://developers.bluesnap.com/docs/fraud-prevention#section-implementing-device-data-collector) required to perform anti-fraud validation.
|
|
417
|
-
* `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://developers.braintreepayments.com/guides/premium-fraud-management-tools/device-data-collection/javascript/v3#collecting-device-data) and avoid fraudulent transactions.
|
|
418
|
-
* `fraud`: Fraud identification related information.
|
|
419
|
-
* `device_session_id`: Session ID associated with the user's device.
|
|
420
|
-
* `fraud_merchant_id`: Your [merchant ID](https://developers.braintreepayments.com/guides/premium-fraud-management-tools/device-data-collection/javascript/v3#collecting-device-data) for fraud detection.
|
|
421
|
-
* `chargebee_payments`: While passing raw card details to Chargebee Payments, if `fraud_session_id` is added, additional validation is performed to avoid fraudulent transactions.
|
|
422
|
-
* `fraud`: Fraud identification related information.
|
|
423
|
-
* `fraud_session_id`: Your Chargebee Payments fraud session ID required to perform anti-fraud validation.
|
|
424
|
-
* `bank_of_america`: While passing raw card details to Bank of America, your user's `device_session_id` can be added to perform additional validation and avoid fraudulent transactions.
|
|
425
|
-
* `fraud`: Fraud identification related information.
|
|
426
|
-
* `device_session_id`: Session ID associated with the user's device.
|
|
427
|
-
* `ecentric`: This parameter is used to verify and process payment method details in Ecentric. If the `merchant_id` parameter is included, Chargebee will vault it / perform a lookup and verification against this `merchant_id`, overriding the one configured in Chargebee. If tokens and processing occur in the same Merchant GUID, you can just skip this part.
|
|
428
|
-
* `merchant_id`: Merchant GUID where the card is vaulted or need to be vaulted.
|
|
429
|
-
* `ebanx`: While passing raw card details to EBANX, the user's `document` is required for some countries and `device_session_id` can be added to perform [additional validation](https://developer.ebanx.com/docs/payments/guides/features/device-fingerprint#device-fingerprint) and avoid fraudulent transactions.
|
|
430
|
-
* `payer`: User related information.
|
|
431
|
-
* `document`: Document is the user's identification number based on their country.
|
|
432
|
-
* `fraud`: Fraud identification related information.
|
|
433
|
-
* `device_session_id`: Session ID associated with the user's device
|
|
434
|
-
|
|
435
|
-
.
|
|
436
|
-
|
|
437
|
-
*/
|
|
438
|
-
|
|
439
109
|
additional_information?:object;
|
|
440
110
|
}
|
|
441
111
|
export interface CreateUsingPermanentTokenResponse {
|
|
@@ -445,155 +115,33 @@ If you delete the only available payment method of a customer in Chargebee, it a
|
|
|
445
115
|
}
|
|
446
116
|
export interface CreateUsingPermanentTokenInputParam {
|
|
447
117
|
|
|
448
|
-
|
|
449
|
-
* @description Identifier of the customer with whom this payment source is associated.
|
|
450
|
-
|
|
451
|
-
*/
|
|
118
|
+
card?:{brand?:'visa' | 'mastercard' | 'american_express' | 'discover' | 'jcb' | 'diners_club' | 'other' | 'bancontact' | 'cmr_falabella' | 'tarjeta_naranja' | 'nativa' | 'cencosud' | 'cabal' | 'argencard' | 'elo' | 'hipercard' | 'carnet' | 'rupay' | 'maestro' | 'dankort' | 'cartes_bancaires',expiry_month?:number,expiry_year?:number,funding_type?:'credit' | 'debit' | 'prepaid' | 'not_known',iin?:string,last4?:string};
|
|
452
119
|
|
|
453
|
-
|
|
120
|
+
billing_address?:{city?:string,country?:string,email?:string,first_name?:string,last_name?:string,line1?:string,line2?:string,line3?:string,state?:string,state_code?:string,zip?:string};
|
|
454
121
|
|
|
455
|
-
|
|
456
|
-
* @description The type of payment method. For more details refer [Update payment method for a customer](customers#update_payment_method_for_a_customer) API under Customer resource. \* direct_debit - Represents bank account for which the direct debit or ACH agreement/mandate is created. \* unionpay - Payments made via UnionPay. \* faster_payments - Payments made via Faster Payments \* google_pay - Payments made via Google Pay. \* sepa_instant_transfer - Payments made via Sepa Instant Transfer \* dotpay - Payments made via Dotpay. \* pay_to - Payments made via PayTo \* generic - Payments made via Generic Payment Method. \* giropay - Payments made via giropay. \* paypal_express_checkout - Payments made via PayPal Express Checkout. \* alipay - Payments made via Alipay. \* venmo - Payments made via Venmo \* sofort - Payments made via Sofort. \* wechat_pay - Payments made via WeChat Pay. \* ideal - Payments made via iDEAL. \* netbanking_emandates - Netbanking (eMandates) Payments. \* upi - UPI Payments. \* bancontact - Payments made via Bancontact Card. \* card - Card based payment including credit cards and debit cards. Details about the card can be obtained from the card resource. \* amazon_payments - Payments made via Amazon Payments. \* apple_pay - Payments made via Apple Pay.
|
|
457
|
-
|
|
458
|
-
*/
|
|
122
|
+
customer_id:string;
|
|
459
123
|
|
|
460
124
|
type:Type;
|
|
461
125
|
|
|
462
|
-
/**
|
|
463
|
-
* @description The gateway account to which the payment source is associated.
|
|
464
|
-
|
|
465
|
-
*/
|
|
466
|
-
|
|
467
126
|
gateway_account_id?:string;
|
|
468
127
|
|
|
469
|
-
/**
|
|
470
|
-
* @description The reference id. In the case of Amazon and PayPal, this will be the billing agreement ID. For GoCardless direct debit this will be `mandate_id`. In the case of a card, this will be the identifier provided by the gateway or card vault for the specific payment method resource.
|
|
471
|
-
**Note:**
|
|
472
|
-
|
|
473
|
-
* This is not the one-time temporary token provided by gateways like Stripe.
|
|
474
|
-
|
|
475
|
-
* `reference_id` is an alternative for `payment_method_token`, `customer_profile_token`, `network_transaction_id`, or `mandate_id`.
|
|
476
|
-
|
|
477
|
-
* `payment_method_token`, `customer_profile_token`, `network_transaction_id`, or `mandate_id` cannot be used with `reference_id`.
|
|
478
|
-
|
|
479
|
-
* `reference_id` is a combination of multiple tokens available at the gateway. Learn more about the combination of each gateway from this [document](https://apidocs.chargebee.com/docs/api/payment_parameters).
|
|
480
|
-
|
|
481
|
-
|
|
482
|
-
*/
|
|
483
|
-
|
|
484
128
|
reference_id?:string;
|
|
485
129
|
|
|
486
|
-
/**
|
|
487
|
-
* @description 2-letter (alpha2) ISO country code. Indicates your customer's payment method country of issuance. Applicable for PayPal via Braintree.
|
|
488
|
-
|
|
489
|
-
*/
|
|
490
|
-
|
|
491
130
|
issuing_country?:string;
|
|
492
131
|
|
|
493
|
-
/**
|
|
494
|
-
* @description Indicates whether the primary payment source should be replaced with this payment source. In case of Create Subscription for Customer endpoint, the default value is True. Otherwise, the default value is False.
|
|
495
|
-
|
|
496
|
-
*/
|
|
497
|
-
|
|
498
132
|
replace_primary_payment_source?:boolean;
|
|
499
133
|
|
|
500
|
-
/**
|
|
501
|
-
* @description An identifier provided by the gateway or card vault for the specific payment method resource.
|
|
502
|
-
**Note:**
|
|
503
|
-
|
|
504
|
-
`payment_method_token` is an alternative for reference_id and cannot be used with `reference_id`.
|
|
505
|
-
|
|
506
|
-
*/
|
|
507
|
-
|
|
508
134
|
payment_method_token?:string;
|
|
509
135
|
|
|
510
|
-
/**
|
|
511
|
-
* @description A unique identifier associated with a customer\`s profile within a payment gateway.
|
|
512
|
-
**Note:**
|
|
513
|
-
|
|
514
|
-
`customer_profile_token` is an alternative for reference_id and cannot be used with `reference_id`.
|
|
515
|
-
|
|
516
|
-
*/
|
|
517
|
-
|
|
518
136
|
customer_profile_token?:string;
|
|
519
137
|
|
|
520
|
-
/**
|
|
521
|
-
* @description An identifier of the payment or authorization transaction at the gateway initiated using this payment method.
|
|
522
|
-
**Note:**
|
|
523
|
-
|
|
524
|
-
`network_transaction_id` is an alternative for reference_id and cannot be used with `reference_id`.
|
|
525
|
-
|
|
526
|
-
*/
|
|
527
|
-
|
|
528
138
|
network_transaction_id?:string;
|
|
529
139
|
|
|
530
|
-
/**
|
|
531
|
-
* @description An identifier of mandates which is an authorization given by the payer (usually a customer or account holder) to allow a third party such as a merchant or service provider to initiate payments from their account.
|
|
532
|
-
**Note:**
|
|
533
|
-
|
|
534
|
-
`mandate_id` is an alternative for reference_id and cannot be used with `reference_id`.
|
|
535
|
-
|
|
536
|
-
*/
|
|
537
|
-
|
|
538
140
|
mandate_id?:string;
|
|
539
141
|
|
|
540
|
-
/**
|
|
541
|
-
* @description By default, the value is `false` and payment method details will be retrieved from the selected payment gateway using `reference_id` or `payment_method_token` / `customer_profile_token` / `network_transaction_id` / `mandate_id`. Learn more about the multiple token combinations of each gateway from this [document](https://apidocs.chargebee.com/docs/api/payment_parameters).
|
|
542
|
-
|
|
543
|
-
Enter the value as `true` for the payment gateways that do not allow to retrieve the payment method details. Once passed, it will create payment method at Chargebee with the provided attributes in `payment_method_token`, `customer_profile_token`, `network_transaction_id`, `mandate_id`, `card`, and `billing_address`.
|
|
544
|
-
**Note:**
|
|
545
|
-
|
|
546
|
-
Currently, the `skip_retrieval` value as `true` is only supported for the Vantiv payment gateway.
|
|
547
|
-
|
|
548
|
-
*/
|
|
549
|
-
|
|
550
142
|
skip_retrieval?:boolean;
|
|
551
143
|
|
|
552
|
-
/**
|
|
553
|
-
* @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://docs.checkout.com/payment-methods/cards/dlocal).
|
|
554
|
-
* `payer`: User related information.
|
|
555
|
-
* `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://docs.checkout.com/resources/codes/country-codes).
|
|
556
|
-
* `document`: Document ID is the user's [identification number](https://docs.dlocal.com/api-documentation/payins-api-reference/country-reference#documents) based on their country.
|
|
557
|
-
* `bluesnap`: While passing raw card details to BlueSnap, if `fraud_session_id` is added, [additional validation](https://developers.bluesnap.com/docs/fraud-prevention) is performed to avoid fraudulent transactions.
|
|
558
|
-
* `fraud`: Fraud identification related information.
|
|
559
|
-
* `fraud_session_id`: Your [BlueSnap fraud session ID](https://developers.bluesnap.com/docs/fraud-prevention#section-implementing-device-data-collector) required to perform anti-fraud validation.
|
|
560
|
-
* `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://developers.braintreepayments.com/guides/premium-fraud-management-tools/device-data-collection/javascript/v3#collecting-device-data) and avoid fraudulent transactions.
|
|
561
|
-
* `fraud`: Fraud identification related information.
|
|
562
|
-
* `device_session_id`: Session ID associated with the user's device.
|
|
563
|
-
* `fraud_merchant_id`: Your [merchant ID](https://developers.braintreepayments.com/guides/premium-fraud-management-tools/device-data-collection/javascript/v3#collecting-device-data) for fraud detection.
|
|
564
|
-
* `chargebee_payments`: While passing raw card details to Chargebee Payments, if `fraud_session_id` is added, additional validation is performed to avoid fraudulent transactions.
|
|
565
|
-
* `fraud`: Fraud identification related information.
|
|
566
|
-
* `fraud_session_id`: Your Chargebee Payments fraud session ID required to perform anti-fraud validation.
|
|
567
|
-
* `bank_of_america`: While passing raw card details to Bank of America, your user's `device_session_id` can be added to perform additional validation and avoid fraudulent transactions.
|
|
568
|
-
* `fraud`: Fraud identification related information.
|
|
569
|
-
* `device_session_id`: Session ID associated with the user's device.
|
|
570
|
-
* `ecentric`: This parameter is used to verify and process payment method details in Ecentric. If the `merchant_id` parameter is included, Chargebee will vault it / perform a lookup and verification against this `merchant_id`, overriding the one configured in Chargebee. If tokens and processing occur in the same Merchant GUID, you can just skip this part.
|
|
571
|
-
* `merchant_id`: Merchant GUID where the card is vaulted or need to be vaulted.
|
|
572
|
-
* `ebanx`: While passing raw card details to EBANX, the user's `document` is required for some countries and `device_session_id` can be added to perform [additional validation](https://developer.ebanx.com/docs/payments/guides/features/device-fingerprint#device-fingerprint) and avoid fraudulent transactions.
|
|
573
|
-
* `payer`: User related information.
|
|
574
|
-
* `document`: Document is the user's identification number based on their country.
|
|
575
|
-
* `fraud`: Fraud identification related information.
|
|
576
|
-
* `device_session_id`: Session ID associated with the user's device
|
|
577
|
-
|
|
578
|
-
.
|
|
579
|
-
|
|
580
|
-
*/
|
|
581
|
-
|
|
582
144
|
additional_information?:object;
|
|
583
|
-
|
|
584
|
-
/**
|
|
585
|
-
* @description Parameters of tokenized card details
|
|
586
|
-
|
|
587
|
-
*/
|
|
588
|
-
|
|
589
|
-
card?:{brand?:'discover' | 'other' | 'argencard' | 'jcb' | 'mastercard' | 'elo' | 'cencosud' | 'cmr_falabella' | 'american_express' | 'cabal' | 'nativa' | 'bancontact' | 'tarjeta_naranja' | 'carnet' | 'visa' | 'diners_club' | 'rupay' | 'hipercard' | 'maestro',expiry_month?:number,expiry_year?:number,funding_type?:'not_known' | 'prepaid' | 'credit' | 'debit',iin?:string,last4?:string};
|
|
590
|
-
|
|
591
|
-
/**
|
|
592
|
-
* @description Parameters for billing_address
|
|
593
|
-
|
|
594
|
-
*/
|
|
595
|
-
|
|
596
|
-
billing_address?:{city?:string,country?:string,email?:string,first_name?:string,last_name?:string,line1?:string,line2?:string,line3?:string,state?:string,state_code?:string,zip?:string};
|
|
597
145
|
}
|
|
598
146
|
export interface CreateUsingTokenResponse {
|
|
599
147
|
customer:Customer;
|
|
@@ -602,25 +150,10 @@ Currently, the `skip_retrieval` value as `true` is only supp
|
|
|
602
150
|
}
|
|
603
151
|
export interface CreateUsingTokenInputParam {
|
|
604
152
|
|
|
605
|
-
/**
|
|
606
|
-
* @description Identifier of the customer with whom this payment source is associated.
|
|
607
|
-
|
|
608
|
-
*/
|
|
609
|
-
|
|
610
153
|
customer_id:string;
|
|
611
154
|
|
|
612
|
-
/**
|
|
613
|
-
* @description Indicates whether the primary payment source should be replaced with this payment source. In case of Create Subscription for Customer endpoint, the default value is True. Otherwise, the default value is False.
|
|
614
|
-
|
|
615
|
-
*/
|
|
616
|
-
|
|
617
155
|
replace_primary_payment_source?:boolean;
|
|
618
156
|
|
|
619
|
-
/**
|
|
620
|
-
* @description Token generated by Chargebee JS representing payment method details.
|
|
621
|
-
|
|
622
|
-
*/
|
|
623
|
-
|
|
624
157
|
token_id:string;
|
|
625
158
|
}
|
|
626
159
|
export interface CreateUsingPaymentIntentResponse {
|
|
@@ -630,26 +163,11 @@ Currently, the `skip_retrieval` value as `true` is only supp
|
|
|
630
163
|
}
|
|
631
164
|
export interface CreateUsingPaymentIntentInputParam {
|
|
632
165
|
|
|
633
|
-
|
|
634
|
-
* @description Identifier of the customer with whom this payment source is associated.
|
|
635
|
-
|
|
636
|
-
*/
|
|
166
|
+
payment_intent?:{additional_info?:object,additional_information?:object,gateway_account_id?:string,gw_payment_method_id?:string,gw_token?:string,id?:string,payment_method_type?:'card' | 'ideal' | 'sofort' | 'bancontact' | 'google_pay' | 'dotpay' | 'giropay' | 'apple_pay' | 'upi' | 'netbanking_emandates' | 'paypal_express_checkout' | 'direct_debit' | 'boleto' | 'venmo' | 'amazon_payments' | 'pay_to' | 'faster_payments' | 'sepa_instant_transfer' | 'klarna_pay_now' | 'online_banking_poland',reference_id?:string};
|
|
637
167
|
|
|
638
168
|
customer_id:string;
|
|
639
169
|
|
|
640
|
-
/**
|
|
641
|
-
* @description Indicates whether the primary payment source should be replaced with this payment source. In case of Create Subscription for Customer endpoint, the default value is True. Otherwise, the default value is False.
|
|
642
|
-
|
|
643
|
-
*/
|
|
644
|
-
|
|
645
170
|
replace_primary_payment_source?:boolean;
|
|
646
|
-
|
|
647
|
-
/**
|
|
648
|
-
* @description Parameters for payment_intent
|
|
649
|
-
|
|
650
|
-
*/
|
|
651
|
-
|
|
652
|
-
payment_intent?:{additional_info?:object,additional_information?:object,gateway_account_id?:string,gw_token?:string,id?:string,payment_method_type?:'giropay' | 'ideal' | 'sepa_instant_transfer' | 'google_pay' | 'netbanking_emandates' | 'klarna_pay_now' | 'dotpay' | 'boleto' | 'direct_debit' | 'faster_payments' | 'sofort' | 'upi' | 'venmo' | 'amazon_payments' | 'apple_pay' | 'bancontact' | 'paypal_express_checkout' | 'pay_to' | 'card',reference_id?:string};
|
|
653
171
|
}
|
|
654
172
|
export interface CreateVoucherPaymentSourceResponse {
|
|
655
173
|
customer:Customer;
|
|
@@ -658,19 +176,9 @@ Currently, the `skip_retrieval` value as `true` is only supp
|
|
|
658
176
|
}
|
|
659
177
|
export interface CreateVoucherPaymentSourceInputParam {
|
|
660
178
|
|
|
661
|
-
|
|
662
|
-
* @description Identifier of the customer with whom this payment source is associated.
|
|
663
|
-
|
|
664
|
-
*/
|
|
179
|
+
voucher_payment_source:{billing_address?:object,gateway_account_id?:string,tax_id?:string,voucher_type:VoucherType};
|
|
665
180
|
|
|
666
181
|
customer_id:string;
|
|
667
|
-
|
|
668
|
-
/**
|
|
669
|
-
* @description Parameters for voucher_payment_source
|
|
670
|
-
|
|
671
|
-
*/
|
|
672
|
-
|
|
673
|
-
voucher_payment_source:{billing_address?:object,gateway_account_id?:string,tax_id?:string,voucher_type:VoucherType};
|
|
674
182
|
}
|
|
675
183
|
export interface CreateCardResponse {
|
|
676
184
|
customer:Customer;
|
|
@@ -679,26 +187,11 @@ Currently, the `skip_retrieval` value as `true` is only supp
|
|
|
679
187
|
}
|
|
680
188
|
export interface CreateCardInputParam {
|
|
681
189
|
|
|
682
|
-
|
|
683
|
-
* @description Identifier of the customer with whom this payment source is associated.
|
|
684
|
-
|
|
685
|
-
*/
|
|
190
|
+
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,cvv?:string,expiry_month:number,expiry_year:number,first_name?:string,gateway_account_id?:string,last_name?:string,number:string};
|
|
686
191
|
|
|
687
192
|
customer_id:string;
|
|
688
193
|
|
|
689
|
-
/**
|
|
690
|
-
* @description Indicates whether the primary payment source should be replaced with this payment source. In case of Create Subscription for Customer endpoint, the default value is True. Otherwise, the default value is False.
|
|
691
|
-
|
|
692
|
-
*/
|
|
693
|
-
|
|
694
194
|
replace_primary_payment_source?:boolean;
|
|
695
|
-
|
|
696
|
-
/**
|
|
697
|
-
* @description Parameters for card
|
|
698
|
-
|
|
699
|
-
*/
|
|
700
|
-
|
|
701
|
-
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,cvv?:string,expiry_month:number,expiry_year:number,first_name?:string,gateway_account_id?:string,last_name?:string,number:string};
|
|
702
195
|
}
|
|
703
196
|
export interface CreateBankAccountResponse {
|
|
704
197
|
customer:Customer;
|
|
@@ -707,33 +200,13 @@ Currently, the `skip_retrieval` value as `true` is only supp
|
|
|
707
200
|
}
|
|
708
201
|
export interface CreateBankAccountInputParam {
|
|
709
202
|
|
|
710
|
-
|
|
711
|
-
* @description Identifier of the customer with whom this payment source is associated.
|
|
712
|
-
|
|
713
|
-
*/
|
|
203
|
+
bank_account?:{account_holder_type?:AccountHolderType,account_number?:string,account_type?:AccountType,bank_code?:string,bank_name?:string,billing_address?:object,company?:string,echeck_type?:EcheckType,email?:string,first_name?:string,gateway_account_id?:string,iban?:string,last_name?:string,phone?:string,routing_number?:string,swedish_identity_number?:string};
|
|
714
204
|
|
|
715
205
|
customer_id:string;
|
|
716
206
|
|
|
717
|
-
/**
|
|
718
|
-
* @description 2-letter(alpha2) ISO country code. Required when local bank details are provided, and not IBAN.
|
|
719
|
-
|
|
720
|
-
*/
|
|
721
|
-
|
|
722
207
|
issuing_country?:string;
|
|
723
208
|
|
|
724
|
-
/**
|
|
725
|
-
* @description Indicates whether the primary payment source should be replaced with this payment source. In case of Create Subscription for Customer endpoint, the default value is True. Otherwise, the default value is False.
|
|
726
|
-
|
|
727
|
-
*/
|
|
728
|
-
|
|
729
209
|
replace_primary_payment_source?:boolean;
|
|
730
|
-
|
|
731
|
-
/**
|
|
732
|
-
* @description Parameters for bank_account
|
|
733
|
-
|
|
734
|
-
*/
|
|
735
|
-
|
|
736
|
-
bank_account?:{account_holder_type?:AccountHolderType,account_number?:string,account_type?:AccountType,bank_code?:string,bank_name?:string,billing_address?:object,company?:string,echeck_type?:EcheckType,email?:string,first_name?:string,gateway_account_id?:string,iban?:string,last_name?:string,phone?:string,routing_number?:string,swedish_identity_number?:string};
|
|
737
210
|
}
|
|
738
211
|
export interface UpdateCardResponse {
|
|
739
212
|
customer:Customer;
|
|
@@ -742,26 +215,11 @@ Currently, the `skip_retrieval` value as `true` is only supp
|
|
|
742
215
|
}
|
|
743
216
|
export interface UpdateCardInputParam {
|
|
744
217
|
|
|
745
|
-
|
|
746
|
-
* @description Additional data about this resource can be passed to **Stripe** gateway here in the JSON Format. This will be stored along with payment source at the gateway account.
|
|
747
|
-
|
|
748
|
-
*/
|
|
218
|
+
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,expiry_month?:number,expiry_year?:number,first_name?:string,last_name?:string};
|
|
749
219
|
|
|
750
220
|
gateway_meta_data?:object;
|
|
751
221
|
|
|
752
|
-
/**
|
|
753
|
-
* @description Reference transaction is used for future purchases. This is only applicable for Vantiv.
|
|
754
|
-
|
|
755
|
-
*/
|
|
756
|
-
|
|
757
222
|
reference_transaction?:string;
|
|
758
|
-
|
|
759
|
-
/**
|
|
760
|
-
* @description Parameters for card
|
|
761
|
-
|
|
762
|
-
*/
|
|
763
|
-
|
|
764
|
-
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,expiry_month?:number,expiry_year?:number,first_name?:string,last_name?:string};
|
|
765
223
|
}
|
|
766
224
|
export interface UpdateBankAccountResponse {
|
|
767
225
|
customer:Customer;
|
|
@@ -770,11 +228,6 @@ Currently, the `skip_retrieval` value as `true` is only supp
|
|
|
770
228
|
}
|
|
771
229
|
export interface UpdateBankAccountInputParam {
|
|
772
230
|
|
|
773
|
-
/**
|
|
774
|
-
* @description Parameters for bank_account
|
|
775
|
-
|
|
776
|
-
*/
|
|
777
|
-
|
|
778
231
|
bank_account?:{email?:string,first_name?:string,last_name?:string};
|
|
779
232
|
}
|
|
780
233
|
export interface VerifyBankAccountResponse {
|
|
@@ -782,18 +235,8 @@ Currently, the `skip_retrieval` value as `true` is only supp
|
|
|
782
235
|
}
|
|
783
236
|
export interface VerifyBankAccountInputParam {
|
|
784
237
|
|
|
785
|
-
/**
|
|
786
|
-
* @description Value of the micro-deposits sent to the bank account.
|
|
787
|
-
|
|
788
|
-
*/
|
|
789
|
-
|
|
790
238
|
amount1:number;
|
|
791
239
|
|
|
792
|
-
/**
|
|
793
|
-
* @description Value of the micro-deposits sent to the bank account.
|
|
794
|
-
|
|
795
|
-
*/
|
|
796
|
-
|
|
797
240
|
amount2:number;
|
|
798
241
|
}
|
|
799
242
|
export interface RetrieveResponse {
|
|
@@ -801,84 +244,59 @@ Currently, the `skip_retrieval` value as `true` is only supp
|
|
|
801
244
|
}
|
|
802
245
|
|
|
803
246
|
export interface ListResponse {
|
|
804
|
-
/**
|
|
805
|
-
* @description Lists all the payment sources
|
|
806
|
-
|
|
807
|
-
*/
|
|
808
|
-
|
|
809
247
|
list:{payment_source:PaymentSource}[];
|
|
810
248
|
|
|
811
|
-
/**
|
|
812
|
-
* @description Lists all the payment sources
|
|
813
|
-
|
|
814
|
-
*/
|
|
815
|
-
|
|
816
249
|
next_offset?:string;
|
|
817
250
|
}
|
|
818
251
|
export interface ListInputParam {
|
|
819
252
|
[key : string]: any;
|
|
820
253
|
/**
|
|
821
|
-
* @description
|
|
254
|
+
* @description The number of resources to be returned.
|
|
822
255
|
|
|
823
256
|
*/
|
|
824
257
|
|
|
825
258
|
limit?:number;
|
|
826
259
|
|
|
827
260
|
/**
|
|
828
|
-
* @description
|
|
261
|
+
* @description Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set \`offset\` to the value of \`next_offset\` obtained in the previous iteration of the API call.
|
|
829
262
|
|
|
830
263
|
*/
|
|
831
264
|
|
|
832
265
|
offset?:string;
|
|
833
266
|
|
|
834
|
-
/**
|
|
835
|
-
* @description Lists all the payment sources
|
|
836
|
-
|
|
837
|
-
*/
|
|
838
|
-
|
|
839
267
|
subscription_id?:string;
|
|
840
268
|
|
|
841
|
-
/**
|
|
842
|
-
* @description Lists all the payment sources
|
|
843
|
-
|
|
844
|
-
*/
|
|
845
|
-
|
|
846
269
|
customer_id?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string};
|
|
847
270
|
|
|
848
271
|
/**
|
|
849
|
-
* @description
|
|
272
|
+
* @description Type of payment source
|
|
850
273
|
|
|
851
274
|
*/
|
|
852
275
|
|
|
853
|
-
type?:{in?:string,is?:'
|
|
276
|
+
type?:{in?:string,is?:'card' | 'paypal_express_checkout' | 'amazon_payments' | 'direct_debit' | 'generic' | 'alipay' | 'unionpay' | 'apple_pay' | 'wechat_pay' | 'ideal' | 'google_pay' | 'sofort' | 'bancontact' | 'giropay' | 'dotpay' | 'upi' | 'netbanking_emandates' | 'venmo' | 'pay_to' | 'faster_payments' | 'sepa_instant_transfer' | 'automated_bank_transfer' | 'klarna_pay_now' | 'online_banking_poland',is_not?:'card' | 'paypal_express_checkout' | 'amazon_payments' | 'direct_debit' | 'generic' | 'alipay' | 'unionpay' | 'apple_pay' | 'wechat_pay' | 'ideal' | 'google_pay' | 'sofort' | 'bancontact' | 'giropay' | 'dotpay' | 'upi' | 'netbanking_emandates' | 'venmo' | 'pay_to' | 'faster_payments' | 'sepa_instant_transfer' | 'automated_bank_transfer' | 'klarna_pay_now' | 'online_banking_poland',not_in?:string};
|
|
854
277
|
|
|
855
278
|
/**
|
|
856
|
-
* @description
|
|
279
|
+
* @description Current status of the payment source.
|
|
857
280
|
|
|
858
281
|
*/
|
|
859
282
|
|
|
860
283
|
status?:{in?:string,is?:'valid' | 'expiring' | 'expired' | 'invalid' | 'pending_verification',is_not?:'valid' | 'expiring' | 'expired' | 'invalid' | 'pending_verification',not_in?:string};
|
|
861
284
|
|
|
862
285
|
/**
|
|
863
|
-
* @description
|
|
286
|
+
* @description Timestamp indicating when this payment source resource was last updated.
|
|
864
287
|
|
|
865
288
|
*/
|
|
866
289
|
|
|
867
290
|
updated_at?:{after?:string,before?:string,between?:string,on?:string};
|
|
868
291
|
|
|
869
292
|
/**
|
|
870
|
-
* @description
|
|
293
|
+
* @description Timestamp indicating when this payment source resource is created.
|
|
871
294
|
|
|
872
295
|
*/
|
|
873
296
|
|
|
874
297
|
created_at?:{after?:string,before?:string,between?:string,on?:string};
|
|
875
298
|
|
|
876
|
-
|
|
877
|
-
* @description Lists all the payment sources
|
|
878
|
-
|
|
879
|
-
*/
|
|
880
|
-
|
|
881
|
-
sort_by?:{asc?:'updated_at' | 'created_at',desc?:'updated_at' | 'created_at'};
|
|
299
|
+
sort_by?:{asc?:'created_at' | 'updated_at',desc?:'created_at' | 'updated_at'};
|
|
882
300
|
}
|
|
883
301
|
export interface SwitchGatewayAccountResponse {
|
|
884
302
|
customer:Customer;
|
|
@@ -887,11 +305,6 @@ Currently, the `skip_retrieval` value as `true` is only supp
|
|
|
887
305
|
}
|
|
888
306
|
export interface SwitchGatewayAccountInputParam {
|
|
889
307
|
|
|
890
|
-
/**
|
|
891
|
-
* @description The gateway account you want to switch to.
|
|
892
|
-
|
|
893
|
-
*/
|
|
894
|
-
|
|
895
308
|
gateway_account_id:string;
|
|
896
309
|
}
|
|
897
310
|
export interface ExportPaymentSourceResponse {
|
|
@@ -899,11 +312,6 @@ Currently, the `skip_retrieval` value as `true` is only supp
|
|
|
899
312
|
}
|
|
900
313
|
export interface ExportPaymentSourceInputParam {
|
|
901
314
|
|
|
902
|
-
/**
|
|
903
|
-
* @description The gateway account you want to copy the card.
|
|
904
|
-
|
|
905
|
-
*/
|
|
906
|
-
|
|
907
315
|
gateway_account_id:string;
|
|
908
316
|
}
|
|
909
317
|
export interface DeleteResponse {
|
|
@@ -919,374 +327,110 @@ Currently, the `skip_retrieval` value as `true` is only supp
|
|
|
919
327
|
}
|
|
920
328
|
|
|
921
329
|
export interface Card {
|
|
922
|
-
/**
|
|
923
|
-
* @description Cardholder's first name
|
|
924
|
-
|
|
925
|
-
*/
|
|
926
|
-
|
|
927
330
|
first_name?:string;
|
|
928
331
|
|
|
929
|
-
/**
|
|
930
|
-
* @description Cardholder's last name
|
|
931
|
-
|
|
932
|
-
*/
|
|
933
|
-
|
|
934
332
|
last_name?:string;
|
|
935
333
|
|
|
936
|
-
/**
|
|
937
|
-
* @description The Issuer Identification Number, i.e. the first six digits of the card number
|
|
938
|
-
|
|
939
|
-
*/
|
|
940
|
-
|
|
941
334
|
iin:string;
|
|
942
335
|
|
|
943
|
-
/**
|
|
944
|
-
* @description Last four digits of the card number
|
|
945
|
-
|
|
946
|
-
*/
|
|
947
|
-
|
|
948
336
|
last4:string;
|
|
949
337
|
|
|
950
|
-
|
|
951
|
-
* @description Card brand \* american_express - An American Express card. \* visa - A Visa card. \* not_applicable - Used for offline entries in transactions. Not applicable for cards \* mastercard - A MasterCard. \* jcb - A JCB card. \* other - Card belonging to types other than those listed above. \* bancontact - A Bancontact card. \* discover - A Discover card. \* diners_club - A Diner's Club card.
|
|
952
|
-
|
|
953
|
-
*/
|
|
954
|
-
|
|
955
|
-
brand:'discover' | 'other' | 'argencard' | 'jcb' | 'mastercard' | 'elo' | 'cencosud' | 'cmr_falabella' | 'american_express' | 'cabal' | 'nativa' | 'bancontact' | 'tarjeta_naranja' | 'carnet' | 'visa' | 'diners_club' | 'rupay' | 'not_applicable' | 'hipercard' | 'maestro';
|
|
956
|
-
|
|
957
|
-
/**
|
|
958
|
-
* @description Card Funding type \* not_known - An unknown card. \* debit - A debit card. \* credit - A credit card. \* prepaid - A prepaid card. \* not_applicable - Used for ACH. Not applicable for cards
|
|
959
|
-
|
|
960
|
-
*/
|
|
961
|
-
|
|
962
|
-
funding_type:'not_known' | 'prepaid' | 'not_applicable' | 'credit' | 'debit';
|
|
338
|
+
brand:'visa' | 'mastercard' | 'american_express' | 'discover' | 'jcb' | 'diners_club' | 'other' | 'bancontact' | 'cmr_falabella' | 'tarjeta_naranja' | 'nativa' | 'cencosud' | 'cabal' | 'argencard' | 'elo' | 'hipercard' | 'carnet' | 'rupay' | 'maestro' | 'dankort' | 'cartes_bancaires' | 'not_applicable';
|
|
963
339
|
|
|
964
|
-
|
|
965
|
-
* @description Card expiry month.
|
|
966
|
-
|
|
967
|
-
*/
|
|
340
|
+
funding_type:'credit' | 'debit' | 'prepaid' | 'not_known' | 'not_applicable';
|
|
968
341
|
|
|
969
342
|
expiry_month:number;
|
|
970
343
|
|
|
971
|
-
/**
|
|
972
|
-
* @description Card expiry year.
|
|
973
|
-
|
|
974
|
-
*/
|
|
975
|
-
|
|
976
344
|
expiry_year:number;
|
|
977
345
|
|
|
978
|
-
/**
|
|
979
|
-
* @description Address line 1, as available in card billing address.
|
|
980
|
-
|
|
981
|
-
*/
|
|
982
|
-
|
|
983
346
|
billing_addr1?:string;
|
|
984
347
|
|
|
985
|
-
/**
|
|
986
|
-
* @description Address line 2, as available in card billing address.
|
|
987
|
-
|
|
988
|
-
*/
|
|
989
|
-
|
|
990
348
|
billing_addr2?:string;
|
|
991
349
|
|
|
992
|
-
/**
|
|
993
|
-
* @description City, as available in card billing address.
|
|
994
|
-
|
|
995
|
-
*/
|
|
996
|
-
|
|
997
350
|
billing_city?:string;
|
|
998
351
|
|
|
999
|
-
/**
|
|
1000
|
-
* @description The [ISO 3166-2 state/province code](https://www.iso.org/obp/ui/#search) without the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set `state_code` as `AZ` (not `US-AZ`). For Tamil Nadu (India), set as `TN` (not `IN-TN`). For British Columbia (Canada), set as `BC` (not `CA-BC`).
|
|
1001
|
-
|
|
1002
|
-
*/
|
|
1003
|
-
|
|
1004
352
|
billing_state_code?:string;
|
|
1005
353
|
|
|
1006
|
-
/**
|
|
1007
|
-
* @description The state/province name.
|
|
1008
|
-
|
|
1009
|
-
*/
|
|
1010
|
-
|
|
1011
354
|
billing_state?:string;
|
|
1012
355
|
|
|
1013
|
-
/**
|
|
1014
|
-
* @description The billing address country of the customer. Must be one of [ISO 3166 alpha-2 country code](https://www.iso.org/iso-3166-country-codes.html).
|
|
1015
|
-
|
|
1016
|
-
**Note** : If you enter an invalid country code, the system will return an error.
|
|
1017
|
-
|
|
1018
|
-
**Brexit**
|
|
1019
|
-
|
|
1020
|
-
|
|
1021
|
-
If you have enabled [EU VAT](https://www.chargebee.com/docs/eu-vat.html) in 2021 or later, or have [manually enable](https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee) the Brexit configuration, then `XI` (the code for **United Kingdom -- Northern Ireland**) is available as an option.
|
|
1022
|
-
|
|
1023
|
-
*/
|
|
1024
|
-
|
|
1025
356
|
billing_country?:string;
|
|
1026
357
|
|
|
1027
|
-
/**
|
|
1028
|
-
* @description Postal or Zip code, as available in card billing address.
|
|
1029
|
-
|
|
1030
|
-
*/
|
|
1031
|
-
|
|
1032
358
|
billing_zip?:string;
|
|
1033
359
|
|
|
1034
|
-
/**
|
|
1035
|
-
* @description Masked credit card number that is safe to show.
|
|
1036
|
-
|
|
1037
|
-
*/
|
|
1038
|
-
|
|
1039
360
|
masked_number?:string;
|
|
1040
361
|
}
|
|
1041
362
|
export interface BankAccount {
|
|
1042
|
-
/**
|
|
1043
|
-
* @description Last four digits of the bank account number
|
|
1044
|
-
|
|
1045
|
-
*/
|
|
1046
|
-
|
|
1047
363
|
last4:string;
|
|
1048
364
|
|
|
1049
|
-
/**
|
|
1050
|
-
* @description Account holder's name as per bank account.
|
|
1051
|
-
|
|
1052
|
-
*/
|
|
1053
|
-
|
|
1054
365
|
name_on_account?:string;
|
|
1055
366
|
|
|
1056
|
-
/**
|
|
1057
|
-
* @description Account holder's first name as per bank account.
|
|
1058
|
-
|
|
1059
|
-
*/
|
|
1060
|
-
|
|
1061
367
|
first_name?:string;
|
|
1062
368
|
|
|
1063
|
-
/**
|
|
1064
|
-
* @description Account holder's last name as per bank account.
|
|
1065
|
-
|
|
1066
|
-
*/
|
|
1067
|
-
|
|
1068
369
|
last_name?:string;
|
|
1069
370
|
|
|
1070
|
-
/**
|
|
1071
|
-
* @description Bank account's scheme to which the mandate and associated payments are submitted. \* becs_nz - The Bulk Electronic Clearing System (BECS) is a Direct Debit scheme and followed in New-Zealand for Direct Debit system. \* bacs - Automated payments are at the very centre of the UK's financial system, providing an essential service for both consumers and organisations. Bacs is the company which runs Direct Debit in the UK. \* becs - The Bulk Electronic Clearing System (BECS) is a Direct Debit scheme and followed in Australia for Direct Debit system. \* pad - Pre-Authorized Debit (PAD) is the scheme used for collecting Direct Debit payments from customers in Canada. \* ach - US Bank Account \* not_applicable - not_applicable \* sepa_core - SEPA Direct Debit is a Europe-wide Direct Debit system that allows merchants to collect Euro-denominated payments. \* autogiro - Bg Autogiro is a Direct Debit scheme for collecting Krona-denominated payments from a bank account in Sweden.
|
|
1072
|
-
|
|
1073
|
-
*/
|
|
1074
|
-
|
|
1075
371
|
direct_debit_scheme?:DirectDebitScheme;
|
|
1076
372
|
|
|
1077
|
-
/**
|
|
1078
|
-
* @description Name of account holder's bank.
|
|
1079
|
-
|
|
1080
|
-
*/
|
|
1081
|
-
|
|
1082
373
|
bank_name?:string;
|
|
1083
374
|
|
|
1084
|
-
/**
|
|
1085
|
-
* @description Mandate Id. Applicable for SEPA, BACS, Autogiro, and BECS.
|
|
1086
|
-
|
|
1087
|
-
*/
|
|
1088
|
-
|
|
1089
375
|
mandate_id?:string;
|
|
1090
376
|
|
|
1091
|
-
/**
|
|
1092
|
-
* @description Represents the account type used to create a payment source. Available for [Authorize.net](https://www.authorize.net/) ACH and Razorpay NetBanking users only. If not passed, account type is taken as null. \* checking - Checking Account \* business_checking - Business Checking Account \* savings - Savings Account \* current - Current Account
|
|
1093
|
-
|
|
1094
|
-
*/
|
|
1095
|
-
|
|
1096
377
|
account_type?:AccountType;
|
|
1097
378
|
|
|
1098
|
-
/**
|
|
1099
|
-
* @description For Authorize.net ACH users only. Indicates the type of eCheck. \* ppd - Payment Authorization is prearranged between the customer and the merchant. \* web - Payment Authorization obtained from the customer via the internet. \* ccd - Payment Authorization agreement from the corporate customer is required. Applicable for business_checking account_type.
|
|
1100
|
-
|
|
1101
|
-
*/
|
|
1102
|
-
|
|
1103
379
|
echeck_type?:EcheckType;
|
|
1104
380
|
|
|
1105
|
-
/**
|
|
1106
|
-
* @description For Stripe ACH users only. Indicates the account holder type. \* company - Company Account. \* individual - Individual Account.
|
|
1107
|
-
|
|
1108
|
-
*/
|
|
1109
|
-
|
|
1110
381
|
account_holder_type?:AccountHolderType;
|
|
1111
382
|
|
|
1112
|
-
/**
|
|
1113
|
-
* @description Account holder's email address. If not passed, details from customer details will be considered. All Direct Debit compliant emails will be sent to this email address.
|
|
1114
|
-
|
|
1115
|
-
*/
|
|
1116
|
-
|
|
1117
383
|
email?:string;
|
|
1118
384
|
}
|
|
1119
385
|
export interface CustVoucherSource {
|
|
1120
|
-
/**
|
|
1121
|
-
* @description Last four digits of unique id for voucher payment source ex: tax_id
|
|
1122
|
-
|
|
1123
|
-
*/
|
|
1124
|
-
|
|
1125
386
|
last4:string;
|
|
1126
387
|
|
|
1127
|
-
/**
|
|
1128
|
-
* @description Customer first name as per voucher payment source.
|
|
1129
|
-
|
|
1130
|
-
*/
|
|
1131
|
-
|
|
1132
388
|
first_name?:string;
|
|
1133
389
|
|
|
1134
|
-
/**
|
|
1135
|
-
* @description Customer last name as per voucher payment source.
|
|
1136
|
-
|
|
1137
|
-
*/
|
|
1138
|
-
|
|
1139
390
|
last_name?:string;
|
|
1140
391
|
|
|
1141
|
-
/**
|
|
1142
|
-
* @description Email address associated Customer's voucher payment source.
|
|
1143
|
-
|
|
1144
|
-
*/
|
|
1145
|
-
|
|
1146
392
|
email?:string;
|
|
1147
393
|
}
|
|
1148
394
|
export interface BillingAddress {
|
|
1149
|
-
/**
|
|
1150
|
-
* @description The first name of the billing contact.
|
|
1151
|
-
|
|
1152
|
-
*/
|
|
1153
|
-
|
|
1154
395
|
first_name?:string;
|
|
1155
396
|
|
|
1156
|
-
/**
|
|
1157
|
-
* @description The last name of the billing contact.
|
|
1158
|
-
|
|
1159
|
-
*/
|
|
1160
|
-
|
|
1161
397
|
last_name?:string;
|
|
1162
398
|
|
|
1163
|
-
/**
|
|
1164
|
-
* @description The email address.
|
|
1165
|
-
|
|
1166
|
-
*/
|
|
1167
|
-
|
|
1168
399
|
email?:string;
|
|
1169
400
|
|
|
1170
|
-
/**
|
|
1171
|
-
* @description The company name.
|
|
1172
|
-
|
|
1173
|
-
*/
|
|
1174
|
-
|
|
1175
401
|
company?:string;
|
|
1176
402
|
|
|
1177
|
-
/**
|
|
1178
|
-
* @description The phone number.
|
|
1179
|
-
|
|
1180
|
-
*/
|
|
1181
|
-
|
|
1182
403
|
phone?:string;
|
|
1183
404
|
|
|
1184
|
-
/**
|
|
1185
|
-
* @description Address line 1
|
|
1186
|
-
|
|
1187
|
-
*/
|
|
1188
|
-
|
|
1189
405
|
line1?:string;
|
|
1190
406
|
|
|
1191
|
-
/**
|
|
1192
|
-
* @description Address line 2
|
|
1193
|
-
|
|
1194
|
-
*/
|
|
1195
|
-
|
|
1196
407
|
line2?:string;
|
|
1197
408
|
|
|
1198
|
-
/**
|
|
1199
|
-
* @description Address line 3
|
|
1200
|
-
|
|
1201
|
-
*/
|
|
1202
|
-
|
|
1203
409
|
line3?:string;
|
|
1204
410
|
|
|
1205
|
-
/**
|
|
1206
|
-
* @description The name of the city.
|
|
1207
|
-
|
|
1208
|
-
*/
|
|
1209
|
-
|
|
1210
411
|
city?:string;
|
|
1211
412
|
|
|
1212
|
-
/**
|
|
1213
|
-
* @description The [ISO 3166-2 state/province code](https://www.iso.org/obp/ui/#search) without the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set `state_code` as `AZ` (not `US-AZ`). For Tamil Nadu (India), set as `TN` (not `IN-TN`). For British Columbia (Canada), set as `BC` (not `CA-BC`).
|
|
1214
|
-
|
|
1215
|
-
*/
|
|
1216
|
-
|
|
1217
413
|
state_code?:string;
|
|
1218
414
|
|
|
1219
|
-
/**
|
|
1220
|
-
* @description State or Province
|
|
1221
|
-
|
|
1222
|
-
*/
|
|
1223
|
-
|
|
1224
415
|
state?:string;
|
|
1225
416
|
|
|
1226
|
-
/**
|
|
1227
|
-
* @description The billing address country of the customer. Must be one of [ISO 3166 alpha-2 country code](https://www.iso.org/iso-3166-country-codes.html).
|
|
1228
|
-
|
|
1229
|
-
**Note** : If you enter an invalid country code, the system will return an error.
|
|
1230
|
-
|
|
1231
|
-
**Brexit**
|
|
1232
|
-
|
|
1233
|
-
|
|
1234
|
-
If you have enabled [EU VAT](https://www.chargebee.com/docs/eu-vat.html) in 2021 or later, or have [manually enable](https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee) the Brexit configuration, then `XI` (the code for **United Kingdom -- Northern Ireland**) is available as an option.
|
|
1235
|
-
|
|
1236
|
-
*/
|
|
1237
|
-
|
|
1238
417
|
country?:string;
|
|
1239
418
|
|
|
1240
|
-
/**
|
|
1241
|
-
* @description Zip or postal code. The number of characters is validated according to the rules [specified here](https://i18napis.appspot.com/address).
|
|
1242
|
-
|
|
1243
|
-
*/
|
|
1244
|
-
|
|
1245
419
|
zip?:string;
|
|
1246
420
|
|
|
1247
|
-
/**
|
|
1248
|
-
* @description The address verification status. \* valid - Address was validated successfully. \* partially_valid - The address is valid for taxability but has not been validated for shipping. \* invalid - Address is invalid. \* not_validated - Address is not yet validated.
|
|
1249
|
-
|
|
1250
|
-
*/
|
|
1251
|
-
|
|
1252
421
|
validation_status?:ValidationStatus;
|
|
1253
422
|
}
|
|
1254
423
|
export interface AmazonPayment {
|
|
1255
|
-
/**
|
|
1256
|
-
* @description Email address associated with Amazon payment account
|
|
1257
|
-
|
|
1258
|
-
*/
|
|
1259
|
-
|
|
1260
424
|
email?:string;
|
|
1261
425
|
|
|
1262
|
-
/**
|
|
1263
|
-
* @description Billing agreement id
|
|
1264
|
-
|
|
1265
|
-
*/
|
|
1266
|
-
|
|
1267
426
|
agreement_id?:string;
|
|
1268
427
|
}
|
|
1269
428
|
export interface Upi {
|
|
1270
|
-
/**
|
|
1271
|
-
* @description A unique identifier mapped with an individuals bank account to help UPI track the account.
|
|
1272
|
-
|
|
1273
|
-
*/
|
|
1274
|
-
|
|
1275
429
|
vpa?:string;
|
|
1276
430
|
}
|
|
1277
431
|
export interface Paypal {
|
|
1278
|
-
/**
|
|
1279
|
-
* @description Email address associated with PayPal Express Checkout
|
|
1280
|
-
|
|
1281
|
-
*/
|
|
1282
|
-
|
|
1283
432
|
email?:string;
|
|
1284
433
|
|
|
1285
|
-
/**
|
|
1286
|
-
* @description Billing agreement id
|
|
1287
|
-
|
|
1288
|
-
*/
|
|
1289
|
-
|
|
1290
434
|
agreement_id?:string;
|
|
1291
435
|
}
|
|
1292
436
|
export interface Venmo {
|
|
@@ -1296,25 +440,10 @@ If you have enabled [EU VAT](https://www.chargebee.com/docs/eu-vat.html) in 2021
|
|
|
1296
440
|
email?:string;
|
|
1297
441
|
}
|
|
1298
442
|
export interface Mandate {
|
|
1299
|
-
/**
|
|
1300
|
-
* @description A unique mandate identifier used for recurring payments.
|
|
1301
|
-
|
|
1302
|
-
*/
|
|
1303
|
-
|
|
1304
443
|
id:string;
|
|
1305
444
|
|
|
1306
|
-
/**
|
|
1307
|
-
* @description Chargebee's subscription id used to find the mapping between the payment source and the Subscription.
|
|
1308
|
-
|
|
1309
|
-
*/
|
|
1310
|
-
|
|
1311
445
|
subscription_id:string;
|
|
1312
446
|
|
|
1313
|
-
/**
|
|
1314
|
-
* @description Timestamp indicating when the mandate is created
|
|
1315
|
-
|
|
1316
|
-
*/
|
|
1317
|
-
|
|
1318
447
|
created_at:number;
|
|
1319
448
|
}
|
|
1320
449
|
}
|