1 | import {Metadata} from './shared';
|
2 |
|
3 | /**
|
4 | * The Card object.
|
5 | */
|
6 | export interface Card {
|
7 | /**
|
8 | * Unique identifier for the object.
|
9 | */
|
10 | id: string;
|
11 |
|
12 | /**
|
13 | * String representing the object's type. Objects of the same type share the same value.
|
14 | */
|
15 | object: 'card';
|
16 |
|
17 | /**
|
18 | * City/District/Suburb/Town/Village.
|
19 | */
|
20 | address_city: string | null;
|
21 |
|
22 | /**
|
23 | * Billing address country, if provided when creating card.
|
24 | */
|
25 | address_country: string | null;
|
26 |
|
27 | /**
|
28 | * Address line 1 (Street address/PO Box/Company name).
|
29 | */
|
30 | address_line1: string | null;
|
31 |
|
32 | /**
|
33 | * If `address_line1` was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`.
|
34 | */
|
35 | address_line1_check: string | null;
|
36 |
|
37 | /**
|
38 | * Address line 2 (Apartment/Suite/Unit/Building).
|
39 | */
|
40 | address_line2: string | null;
|
41 |
|
42 | /**
|
43 | * State/County/Province/Region.
|
44 | */
|
45 | address_state: string | null;
|
46 |
|
47 | /**
|
48 | * ZIP or postal code.
|
49 | */
|
50 | address_zip: string | null;
|
51 |
|
52 | /**
|
53 | * If `address_zip` was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`.
|
54 | */
|
55 | address_zip_check: string | null;
|
56 |
|
57 | /**
|
58 | * Card brand. Can be `American Express`, `Diners Club`, `Discover`, `JCB`, `MasterCard`, `UnionPay`, `Visa`, or `Unknown`.
|
59 | */
|
60 | brand: string;
|
61 |
|
62 | /**
|
63 | * 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.
|
64 | */
|
65 | country: string | null;
|
66 |
|
67 | /**
|
68 | * Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
|
69 | */
|
70 | currency?: string | null;
|
71 |
|
72 | /**
|
73 | * 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.
|
74 | */
|
75 | customer?: string | null;
|
76 |
|
77 | /**
|
78 | * If a CVC was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`.
|
79 | */
|
80 | cvc_check: string | null;
|
81 |
|
82 | /**
|
83 | * (For tokenized numbers only.) The last four digits of the device account number.
|
84 | */
|
85 | dynamic_last4: string | null;
|
86 |
|
87 | /**
|
88 | * Two-digit number representing the card's expiration month.
|
89 | */
|
90 | exp_month: number;
|
91 |
|
92 | /**
|
93 | * Four-digit number representing the card's expiration year.
|
94 | */
|
95 | exp_year: number;
|
96 |
|
97 | /**
|
98 | * 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.
|
99 | */
|
100 | fingerprint?: string | null;
|
101 |
|
102 | /**
|
103 | * Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.
|
104 | */
|
105 | funding: string;
|
106 |
|
107 | /**
|
108 | * The last four digits of the card.
|
109 | */
|
110 | last4: string;
|
111 |
|
112 | /**
|
113 | * Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
|
114 | */
|
115 | metadata: Metadata;
|
116 |
|
117 | /**
|
118 | * Cardholder name.
|
119 | */
|
120 | name: string | null;
|
121 |
|
122 | /**
|
123 | * If the card number is tokenized, this is the method that was used. Can be `apple_pay` or `google_pay`.
|
124 | */
|
125 | tokenization_method: string | null;
|
126 | }
|
127 |
|
128 | export namespace Card {
|
129 | export type AvailablePayoutMethod = 'instant' | 'standard';
|
130 | }
|