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
|
# -*- coding: utf-8 -*-
# File generated from our OpenAPI spec
from stripe._expandable_field import ExpandableField
from stripe._list_object import ListObject
from stripe._listable_api_resource import ListableAPIResource
from stripe._request_options import RequestOptions
from stripe._stripe_object import StripeObject
from stripe._updateable_api_resource import UpdateableAPIResource
from stripe._util import sanitize_id
from typing import ClassVar, List, Optional, cast
from typing_extensions import (
Literal,
NotRequired,
TypedDict,
Unpack,
TYPE_CHECKING,
)
if TYPE_CHECKING:
from stripe.issuing._card import Card
class Token(ListableAPIResource["Token"], UpdateableAPIResource["Token"]):
"""
An issuing token object is created when an issued card is added to a digital wallet. As a [card issuer](https://stripe.com/docs/issuing), you can [view and manage these tokens](https://stripe.com/docs/issuing/controls/token-management) through Stripe.
"""
OBJECT_NAME: ClassVar[Literal["issuing.token"]] = "issuing.token"
class NetworkData(StripeObject):
class Device(StripeObject):
device_fingerprint: Optional[str]
"""
An obfuscated ID derived from the device ID.
"""
ip_address: Optional[str]
"""
The IP address of the device at provisioning time.
"""
location: Optional[str]
"""
The geographic latitude/longitude coordinates of the device at provisioning time. The format is [+-]decimal/[+-]decimal.
"""
name: Optional[str]
"""
The name of the device used for tokenization.
"""
phone_number: Optional[str]
"""
The phone number of the device used for tokenization.
"""
type: Optional[Literal["other", "phone", "watch"]]
"""
The type of device used for tokenization.
"""
class Mastercard(StripeObject):
card_reference_id: Optional[str]
"""
A unique reference ID from MasterCard to represent the card account number.
"""
token_reference_id: str
"""
The network-unique identifier for the token.
"""
token_requestor_id: str
"""
The ID of the entity requesting tokenization, specific to MasterCard.
"""
token_requestor_name: Optional[str]
"""
The name of the entity requesting tokenization, if known. This is directly provided from MasterCard.
"""
class Visa(StripeObject):
card_reference_id: str
"""
A unique reference ID from Visa to represent the card account number.
"""
token_reference_id: str
"""
The network-unique identifier for the token.
"""
token_requestor_id: str
"""
The ID of the entity requesting tokenization, specific to Visa.
"""
token_risk_score: Optional[str]
"""
Degree of risk associated with the token between `01` and `99`, with higher number indicating higher risk. A `00` value indicates the token was not scored by Visa.
"""
class WalletProvider(StripeObject):
class CardholderAddress(StripeObject):
line1: str
"""
The street address of the cardholder tokenizing the card.
"""
postal_code: str
"""
The postal code of the cardholder tokenizing the card.
"""
account_id: Optional[str]
"""
The wallet provider-given account ID of the digital wallet the token belongs to.
"""
account_trust_score: Optional[int]
"""
An evaluation on the trustworthiness of the wallet account between 1 and 5. A higher score indicates more trustworthy.
"""
card_number_source: Optional[
Literal["app", "manual", "on_file", "other"]
]
"""
The method used for tokenizing a card.
"""
cardholder_address: Optional[CardholderAddress]
cardholder_name: Optional[str]
"""
The name of the cardholder tokenizing the card.
"""
device_trust_score: Optional[int]
"""
An evaluation on the trustworthiness of the device. A higher score indicates more trustworthy.
"""
hashed_account_email_address: Optional[str]
"""
The hashed email address of the cardholder's account with the wallet provider.
"""
reason_codes: Optional[
List[
Literal[
"account_card_too_new",
"account_recently_changed",
"account_too_new",
"account_too_new_since_launch",
"additional_device",
"data_expired",
"defer_id_v_decision",
"device_recently_lost",
"good_activity_history",
"has_suspended_tokens",
"high_risk",
"inactive_account",
"long_account_tenure",
"low_account_score",
"low_device_score",
"low_phone_number_score",
"network_service_error",
"outside_home_territory",
"provisioning_cardholder_mismatch",
"provisioning_device_and_cardholder_mismatch",
"provisioning_device_mismatch",
"same_device_no_prior_authentication",
"same_device_successful_prior_authentication",
"software_update",
"suspicious_activity",
"too_many_different_cardholders",
"too_many_recent_attempts",
"too_many_recent_tokens",
]
]
]
"""
The reasons for suggested tokenization given by the card network.
"""
suggested_decision: Optional[
Literal["approve", "decline", "require_auth"]
]
"""
The recommendation on responding to the tokenization request.
"""
suggested_decision_version: Optional[str]
"""
The version of the standard for mapping reason codes followed by the wallet provider.
"""
_inner_class_types = {"cardholder_address": CardholderAddress}
device: Optional[Device]
mastercard: Optional[Mastercard]
type: Literal["mastercard", "visa"]
"""
The network that the token is associated with. An additional hash is included with a name matching this value, containing tokenization data specific to the card network.
"""
visa: Optional[Visa]
wallet_provider: Optional[WalletProvider]
_inner_class_types = {
"device": Device,
"mastercard": Mastercard,
"visa": Visa,
"wallet_provider": WalletProvider,
}
class ListParams(RequestOptions):
card: str
"""
The Issuing card identifier to list tokens for.
"""
created: NotRequired["Token.ListParamsCreated|int"]
"""
Only return Issuing tokens that were created during the given date interval.
"""
ending_before: NotRequired[str]
"""
A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
"""
expand: NotRequired[List[str]]
"""
Specifies which fields in the response should be expanded.
"""
limit: NotRequired[int]
"""
A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
"""
starting_after: NotRequired[str]
"""
A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
"""
status: NotRequired[
Literal["active", "deleted", "requested", "suspended"]
]
"""
Select Issuing tokens with the given status.
"""
class ListParamsCreated(TypedDict):
gt: NotRequired[int]
"""
Minimum value to filter by (exclusive)
"""
gte: NotRequired[int]
"""
Minimum value to filter by (inclusive)
"""
lt: NotRequired[int]
"""
Maximum value to filter by (exclusive)
"""
lte: NotRequired[int]
"""
Maximum value to filter by (inclusive)
"""
class ModifyParams(RequestOptions):
expand: NotRequired[List[str]]
"""
Specifies which fields in the response should be expanded.
"""
status: Literal["active", "deleted", "suspended"]
"""
Specifies which status the token should be updated to.
"""
class RetrieveParams(RequestOptions):
expand: NotRequired[List[str]]
"""
Specifies which fields in the response should be expanded.
"""
card: ExpandableField["Card"]
"""
Card associated with this token.
"""
created: int
"""
Time at which the object was created. Measured in seconds since the Unix epoch.
"""
device_fingerprint: Optional[str]
"""
The hashed ID derived from the device ID from the card network associated with the token.
"""
id: str
"""
Unique identifier for the object.
"""
last4: Optional[str]
"""
The last four digits of the token.
"""
livemode: bool
"""
Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
"""
network: Literal["mastercard", "visa"]
"""
The token service provider / card network associated with the token.
"""
network_data: Optional[NetworkData]
network_updated_at: int
"""
Time at which the token was last updated by the card network. Measured in seconds since the Unix epoch.
"""
object: Literal["issuing.token"]
"""
String representing the object's type. Objects of the same type share the same value.
"""
status: Literal["active", "deleted", "requested", "suspended"]
"""
The usage state of the token.
"""
wallet_provider: Optional[
Literal["apple_pay", "google_pay", "samsung_pay"]
]
"""
The digital wallet for this token, if one was used.
"""
@classmethod
def list(cls, **params: Unpack["Token.ListParams"]) -> ListObject["Token"]:
"""
Lists all Issuing Token objects for a given card.
"""
result = cls._static_request(
"get",
cls.class_url(),
params=params,
)
if not isinstance(result, ListObject):
raise TypeError(
"Expected list object from API, got %s"
% (type(result).__name__)
)
return result
@classmethod
async def list_async(
cls, **params: Unpack["Token.ListParams"]
) -> ListObject["Token"]:
"""
Lists all Issuing Token objects for a given card.
"""
result = await cls._static_request_async(
"get",
cls.class_url(),
params=params,
)
if not isinstance(result, ListObject):
raise TypeError(
"Expected list object from API, got %s"
% (type(result).__name__)
)
return result
@classmethod
def modify(
cls, id: str, **params: Unpack["Token.ModifyParams"]
) -> "Token":
"""
Attempts to update the specified Issuing Token object to the status specified.
"""
url = "%s/%s" % (cls.class_url(), sanitize_id(id))
return cast(
"Token",
cls._static_request(
"post",
url,
params=params,
),
)
@classmethod
async def modify_async(
cls, id: str, **params: Unpack["Token.ModifyParams"]
) -> "Token":
"""
Attempts to update the specified Issuing Token object to the status specified.
"""
url = "%s/%s" % (cls.class_url(), sanitize_id(id))
return cast(
"Token",
await cls._static_request_async(
"post",
url,
params=params,
),
)
@classmethod
def retrieve(
cls, id: str, **params: Unpack["Token.RetrieveParams"]
) -> "Token":
"""
Retrieves an Issuing Token object.
"""
instance = cls(id, **params)
instance.refresh()
return instance
@classmethod
async def retrieve_async(
cls, id: str, **params: Unpack["Token.RetrieveParams"]
) -> "Token":
"""
Retrieves an Issuing Token object.
"""
instance = cls(id, **params)
await instance.refresh_async()
return instance
_inner_class_types = {"network_data": NetworkData}
|