Entities

CardHolderId module-attribute

CardHolderId = NewType('CardHolderId', UUID)

CardId module-attribute

CardId = NewType('CardId', UUID)

CardOrderId module-attribute

CardOrderId = NewType('CardOrderId', UUID)

CardProvisioningId module-attribute

CardProvisioningId = NewType('CardProvisioningId', UUID)

Card dataclass

Card(
    id,
    card_holder_id,
    account_id,
    form_factor,
    display_name,
    expiration_year,
    expiration_month,
    last_four_digits,
    status,
    external_id,
    description,
    reference,
    issued_at=isodatetime_field(),
    issuance_reason=None,
    suspension_source=None,
)

Card entity.

account_id instance-attribute

account_id

card_holder_id instance-attribute

card_holder_id

description instance-attribute

description

display_name instance-attribute

display_name

expiration_month instance-attribute

expiration_month

expiration_year instance-attribute

expiration_year

external_id instance-attribute

external_id

Opaque identifier of the card in the payment service provider.

form_factor instance-attribute

form_factor

id instance-attribute

id

issuance_reason class-attribute instance-attribute

issuance_reason = None

Reason for issuing the card.

issued_at class-attribute instance-attribute

issued_at = isodatetime_field()

Date and time when the card was issued.

last_four_digits instance-attribute

last_four_digits

reference instance-attribute

reference

status instance-attribute

status

suspension_source class-attribute instance-attribute

suspension_source = None

Who initiated the suspension of the card.

CardHolder dataclass

CardHolder(
    id,
    provider,
    external_id,
    first_name,
    last_name,
    display_name=None,
    short_name=None,
)

Person owning a card.

display_name class-attribute instance-attribute

display_name = None

external_id instance-attribute

external_id

first_name instance-attribute

first_name

id instance-attribute

id

last_name instance-attribute

last_name

provider instance-attribute

provider

short_name class-attribute instance-attribute

short_name = None

CardIssuingConfiguration dataclass

CardIssuingConfiguration(
    country_code, brand, brand_variant, profile_id
)

Card issuing configuration for the payment service provider.

brand instance-attribute

brand

brand_variant instance-attribute

brand_variant

country_code instance-attribute

country_code

profile_id instance-attribute

profile_id

CardOrder dataclass

CardOrder(
    card_id,
    delivery_status,
    shipping_method,
    tracking_number=None,
)

Card order entity.

card_id instance-attribute

card_id

delivery_status instance-attribute

delivery_status

shipping_method instance-attribute

shipping_method

shipping method, known at order creation time.

tracking_number class-attribute instance-attribute

tracking_number = None

Tracking number provided by the shipping service, known at shipping time.

CardProvisioning dataclass

CardProvisioning(
    id,
    card_id,
    external_id,
    provisioning_type,
    provisioning_date,
    wallet_provider,
    provider,
)

CardProvisioning entity

card_id instance-attribute

card_id

external_id instance-attribute

external_id

id instance-attribute

id

provider instance-attribute

provider

provisioning_date instance-attribute

provisioning_date

provisioning_type instance-attribute

provisioning_type

wallet_provider instance-attribute

wallet_provider

CardRevealPANData dataclass

CardRevealPANData(encrypted_data)

Bases: DataClassJsonMixin

Encrypted card PAN reveal data.

encrypted_data instance-attribute

encrypted_data

Hex-encoded encrypted PAN data

CardRevealPINData dataclass

CardRevealPINData(encrypted_pin_block, token)

Bases: DataClassJsonMixin

Encrypted card PIN reveal data.

encrypted_pin_block instance-attribute

encrypted_pin_block

Hex-encoded encrypted PIN block data

token instance-attribute

token

Token used for extraction of the PIN from the PIN block

CardShipmentInfo dataclass

CardShipmentInfo(
    first_name,
    last_name,
    address_line1,
    postal_code,
    city,
    country,
    phone_number=None,
    address_line2=None,
    state_or_province=None,
)

Name and address to which a physical card will be shipped.

address_line1 instance-attribute

address_line1

address_line2 class-attribute instance-attribute

address_line2 = None

city instance-attribute

city

country instance-attribute

country

first_name instance-attribute

first_name

last_name instance-attribute

last_name

phone_number class-attribute instance-attribute

phone_number = None

postal_code instance-attribute

postal_code

state_or_province class-attribute instance-attribute

state_or_province = None