-
Notifications
You must be signed in to change notification settings - Fork 357
/
Card.java
480 lines (429 loc) · 16.2 KB
/
Card.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
// File generated from our OpenAPI spec
package com.stripe.model;
import com.google.gson.annotations.SerializedName;
import com.stripe.Stripe;
import com.stripe.exception.InvalidRequestException;
import com.stripe.exception.StripeException;
import com.stripe.net.ApiResource;
import com.stripe.net.RequestOptions;
import com.stripe.param.CardUpdateOnAccountParams;
import com.stripe.param.CardUpdateOnCustomerParams;
import java.util.List;
import java.util.Map;
import lombok.EqualsAndHashCode;
import lombok.Getter;
import lombok.Setter;
/**
* You can store multiple cards on a customer in order to charge the customer later. You can also
* store multiple debit cards on a recipient in order to transfer to those cards later.
*
* <p>Related guide: <a href="https://stripe.com/docs/sources/cards">Card Payments with Sources</a>.
*/
@Getter
@Setter
@EqualsAndHashCode(callSuper = false)
public class Card extends ApiResource
implements MetadataStore<Card>, ExternalAccount, PaymentSource {
/**
* The account this card belongs to. This attribute will not be in the card object if the card
* belongs to a customer or recipient instead.
*/
@SerializedName("account")
@Getter(lombok.AccessLevel.NONE)
@Setter(lombok.AccessLevel.NONE)
ExpandableField<Account> account;
/** City/District/Suburb/Town/Village. */
@SerializedName("address_city")
String addressCity;
/** Billing address country, if provided when creating card. */
@SerializedName("address_country")
String addressCountry;
/** Address line 1 (Street address/PO Box/Company name). */
@SerializedName("address_line1")
String addressLine1;
/**
* If {@code address_line1} was provided, results of the check: {@code pass}, {@code fail}, {@code
* unavailable}, or {@code unchecked}.
*/
@SerializedName("address_line1_check")
String addressLine1Check;
/** Address line 2 (Apartment/Suite/Unit/Building). */
@SerializedName("address_line2")
String addressLine2;
/** State/County/Province/Region. */
@SerializedName("address_state")
String addressState;
/** ZIP or postal code. */
@SerializedName("address_zip")
String addressZip;
/**
* If {@code address_zip} was provided, results of the check: {@code pass}, {@code fail}, {@code
* unavailable}, or {@code unchecked}.
*/
@SerializedName("address_zip_check")
String addressZipCheck;
/**
* A set of available payout methods for this card. Only values from this set should be passed as
* the {@code method} when creating a payout.
*/
@SerializedName("available_payout_methods")
List<String> availablePayoutMethods;
/**
* Card brand. Can be {@code American Express}, {@code Diners Club}, {@code Discover}, {@code
* JCB}, {@code MasterCard}, {@code UnionPay}, {@code Visa}, or {@code Unknown}.
*/
@SerializedName("brand")
String brand;
/**
* Two-letter ISO code representing the country of the card. You could use this attribute to get a
* sense of the international breakdown of cards you've collected.
*/
@SerializedName("country")
String country;
/**
* Three-letter <a href="https://stripe.com/docs/payouts">ISO code for currency</a>. Only
* applicable on accounts (not customers or recipients). The card can be used as a transfer
* destination for funds in this currency.
*/
@SerializedName("currency")
String currency;
/**
* The customer that this card belongs to. This attribute will not be in the card object if the
* card belongs to an account or recipient instead.
*/
@SerializedName("customer")
@Getter(lombok.AccessLevel.NONE)
@Setter(lombok.AccessLevel.NONE)
ExpandableField<Customer> customer;
/**
* If a CVC was provided, results of the check: {@code pass}, {@code fail}, {@code unavailable},
* or {@code unchecked}. A result of unchecked indicates that CVC was provided but hasn't been
* checked yet. Checks are typically performed when attaching a card to a Customer object, or when
* creating a charge. For more details, see <a
* href="https://support.stripe.com/questions/check-if-a-card-is-valid-without-a-charge">Check if
* a card is valid without a charge</a>.
*/
@SerializedName("cvc_check")
String cvcCheck;
/** Whether this card is the default external account for its currency. */
@SerializedName("default_for_currency")
Boolean defaultForCurrency;
/** Always true for a deleted object. */
@SerializedName("deleted")
Boolean deleted;
/**
* A high-level description of the type of cards issued in this range. (For internal use only and
* not typically available in standard API requests.)
*/
@SerializedName("description")
String description;
/** (For tokenized numbers only.) The last four digits of the device account number. */
@SerializedName("dynamic_last4")
String dynamicLast4;
/** Two-digit number representing the card's expiration month. */
@SerializedName("exp_month")
Long expMonth;
/** Four-digit number representing the card's expiration year. */
@SerializedName("exp_year")
Long expYear;
/**
* Uniquely identifies this particular card number. You can use this attribute to check whether
* two customers who’ve signed up with you are using the same card number, for example. For
* payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number
* might be provided instead of the underlying card number.
*
* <p><em>Starting May 1, 2021, card fingerprint in India for Connect will change to allow two
* fingerprints for the same card --- one for India and one for the rest of the world.</em>
*/
@SerializedName("fingerprint")
String fingerprint;
/**
* Card funding type. Can be {@code credit}, {@code debit}, {@code prepaid}, or {@code unknown}.
*/
@SerializedName("funding")
String funding;
/** Unique identifier for the object. */
@Getter(onMethod_ = {@Override})
@SerializedName("id")
String id;
/**
* Issuer identification number of the card. (For internal use only and not typically available in
* standard API requests.)
*/
@SerializedName("iin")
String iin;
/**
* The name of the card's issuing bank. (For internal use only and not typically available in
* standard API requests.)
*/
@SerializedName("issuer")
String issuer;
/** The last four digits of the card. */
@SerializedName("last4")
String last4;
/**
* Set of <a href="https://stripe.com/docs/api/metadata">key-value pairs</a> that you can attach
* to an object. This can be useful for storing additional information about the object in a
* structured format.
*/
@Getter(onMethod_ = {@Override})
@SerializedName("metadata")
Map<String, String> metadata;
/** Cardholder name. */
@SerializedName("name")
String name;
/**
* String representing the object's type. Objects of the same type share the same value.
*
* <p>Equal to {@code card}.
*/
@SerializedName("object")
String object;
/**
* For external accounts, possible values are {@code new} and {@code errored}. If a transfer
* fails, the status is set to {@code errored} and transfers are stopped until account details are
* updated.
*/
@SerializedName("status")
String status;
/**
* If the card number is tokenized, this is the method that was used. Can be {@code android_pay}
* (includes Google Pay), {@code apple_pay}, {@code masterpass}, {@code visa_checkout}, or null.
*/
@SerializedName("tokenization_method")
String tokenizationMethod;
/** Get ID of expandable {@code account} object. */
public String getAccount() {
return (this.account != null) ? this.account.getId() : null;
}
public void setAccount(String id) {
this.account = ApiResource.setExpandableFieldId(id, this.account);
}
/** Get expanded {@code account}. */
public Account getAccountObject() {
return (this.account != null) ? this.account.getExpanded() : null;
}
public void setAccountObject(Account expandableObject) {
this.account = new ExpandableField<Account>(expandableObject.getId(), expandableObject);
}
/** Get ID of expandable {@code customer} object. */
public String getCustomer() {
return (this.customer != null) ? this.customer.getId() : null;
}
public void setCustomer(String id) {
this.customer = ApiResource.setExpandableFieldId(id, this.customer);
}
/** Get expanded {@code customer}. */
public Customer getCustomerObject() {
return (this.customer != null) ? this.customer.getExpanded() : null;
}
public void setCustomerObject(Customer expandableObject) {
this.customer = new ExpandableField<Customer>(expandableObject.getId(), expandableObject);
}
/**
* If you need to update only some card details, like the billing address or expiration date, you
* can do so without having to re-enter the full card details. Stripe also works directly with
* card networks so that your customers can <a
* href="https://stripe.com/docs/saving-cards#automatic-card-updates">continue using your
* service</a> without interruption.
*
* <p>Updates a specified card for a given customer.
*/
@Override
public Card update(Map<String, Object> params) throws StripeException {
return update(params, (RequestOptions) null);
}
/**
* If you need to update only some card details, like the billing address or expiration date, you
* can do so without having to re-enter the full card details. Stripe also works directly with
* card networks so that your customers can <a
* href="https://stripe.com/docs/saving-cards#automatic-card-updates">continue using your
* service</a> without interruption.
*
* <p>Updates a specified card for a given customer.
*/
@Override
public Card update(Map<String, Object> params, RequestOptions options) throws StripeException {
String url;
if (this.getAccount() != null) {
url =
String.format(
"%s%s",
Stripe.getApiBase(),
String.format(
"/v1/accounts/%s/external_accounts/%s",
ApiResource.urlEncodeId(this.getAccount()),
ApiResource.urlEncodeId(this.getId())));
} else if (this.getCustomer() != null) {
url =
String.format(
"%s%s",
Stripe.getApiBase(),
String.format(
"/v1/customers/%s/sources/%s",
ApiResource.urlEncodeId(this.getCustomer()),
ApiResource.urlEncodeId(this.getId())));
} else {
throw new InvalidRequestException(
"Unable to construct url because [account, customer] field(s) are all null",
null,
null,
null,
0,
null);
}
return request(ApiResource.RequestMethod.POST, url, params, Card.class, options);
}
/**
* If you need to update only some card details, like the billing address or expiration date, you
* can do so without having to re-enter the full card details. Stripe also works directly with
* card networks so that your customers can <a
* href="https://stripe.com/docs/saving-cards#automatic-card-updates">continue using your
* service</a> without interruption.
*
* <p>Updates a specified card for a given customer.
*/
public Card update(CardUpdateOnAccountParams params) throws StripeException {
return update(params, (RequestOptions) null);
}
/**
* If you need to update only some card details, like the billing address or expiration date, you
* can do so without having to re-enter the full card details. Stripe also works directly with
* card networks so that your customers can <a
* href="https://stripe.com/docs/saving-cards#automatic-card-updates">continue using your
* service</a> without interruption.
*
* <p>Updates a specified card for a given customer.
*/
public Card update(CardUpdateOnAccountParams params, RequestOptions options)
throws StripeException {
String url;
if (this.getAccount() != null) {
url =
String.format(
"%s%s",
Stripe.getApiBase(),
String.format(
"/v1/accounts/%s/external_accounts/%s",
ApiResource.urlEncodeId(this.getAccount()),
ApiResource.urlEncodeId(this.getId())));
} else {
throw new InvalidRequestException(
"Unable to construct url because [account] field(s) are all null",
null,
null,
null,
0,
null);
}
return request(ApiResource.RequestMethod.POST, url, params, Card.class, options);
}
/**
* If you need to update only some card details, like the billing address or expiration date, you
* can do so without having to re-enter the full card details. Stripe also works directly with
* card networks so that your customers can <a
* href="https://stripe.com/docs/saving-cards#automatic-card-updates">continue using your
* service</a> without interruption.
*
* <p>Updates a specified card for a given customer.
*/
public Card update(CardUpdateOnCustomerParams params) throws StripeException {
return update(params, (RequestOptions) null);
}
/**
* If you need to update only some card details, like the billing address or expiration date, you
* can do so without having to re-enter the full card details. Stripe also works directly with
* card networks so that your customers can <a
* href="https://stripe.com/docs/saving-cards#automatic-card-updates">continue using your
* service</a> without interruption.
*
* <p>Updates a specified card for a given customer.
*/
public Card update(CardUpdateOnCustomerParams params, RequestOptions options)
throws StripeException {
String url;
if (this.getCustomer() != null) {
url =
String.format(
"%s%s",
Stripe.getApiBase(),
String.format(
"/v1/customers/%s/sources/%s",
ApiResource.urlEncodeId(this.getCustomer()),
ApiResource.urlEncodeId(this.getId())));
} else {
throw new InvalidRequestException(
"Unable to construct url because [customer] field(s) are all null",
null,
null,
null,
0,
null);
}
return request(ApiResource.RequestMethod.POST, url, params, Card.class, options);
}
/**
* Delete a specified external account for a given account.
*
* <p>Delete a specified source for a given customer.
*/
@Override
public Card delete() throws StripeException {
return delete((Map<String, Object>) null, (RequestOptions) null);
}
/**
* Delete a specified external account for a given account.
*
* <p>Delete a specified source for a given customer.
*/
@Override
public Card delete(RequestOptions options) throws StripeException {
return delete((Map<String, Object>) null, options);
}
/**
* Delete a specified external account for a given account.
*
* <p>Delete a specified source for a given customer.
*/
@Override
public Card delete(Map<String, Object> params) throws StripeException {
return delete(params, (RequestOptions) null);
}
/**
* Delete a specified external account for a given account.
*
* <p>Delete a specified source for a given customer.
*/
@Override
public Card delete(Map<String, Object> params, RequestOptions options) throws StripeException {
String url;
if (this.getAccount() != null) {
url =
String.format(
"%s%s",
Stripe.getApiBase(),
String.format(
"/v1/accounts/%s/external_accounts/%s",
ApiResource.urlEncodeId(this.getAccount()),
ApiResource.urlEncodeId(this.getId())));
} else if (this.getCustomer() != null) {
url =
String.format(
"%s%s",
Stripe.getApiBase(),
String.format(
"/v1/customers/%s/sources/%s",
ApiResource.urlEncodeId(this.getCustomer()),
ApiResource.urlEncodeId(this.getId())));
} else {
throw new InvalidRequestException(
"Unable to construct url because [account, customer] field(s) are all null",
null,
null,
null,
0,
null);
}
return request(ApiResource.RequestMethod.DELETE, url, params, Card.class, options);
}
}