Mayson Monorepo Documentation
    Preparing search index...

    Interface Card

    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.

    Related guide: Card payments with Sources

    interface Card {
        id: string;
        object: "card";
        account?: string | Stripe.Account;
        address_city: string;
        address_country: string;
        address_line1: string;
        address_line1_check: string;
        address_line2: string;
        address_state: string;
        address_zip: string;
        address_zip_check: string;
        allow_redisplay?: Stripe.Card.AllowRedisplay;
        available_payout_methods?: Stripe.Card.AvailablePayoutMethod[];
        brand: string;
        country: string;
        currency?: string;
        customer?: string | Stripe.Customer | DeletedCustomer;
        cvc_check: string;
        default_for_currency?: boolean;
        deleted?: void;
        description?: string;
        dynamic_last4: string;
        exp_month: number;
        exp_year: number;
        fingerprint?: string;
        funding: string;
        iin?: string;
        issuer?: string;
        last4: string;
        metadata: Metadata;
        name: string;
        networks?: Stripe.Card.Networks;
        regulated_status: Stripe.Card.RegulatedStatus;
        status?: string;
        tokenization_method: string;
    }
    Index

    Properties

    id object account? address_city address_country address_line1 address_line1_check address_line2 address_state address_zip address_zip_check allow_redisplay? available_payout_methods? brand country currency? customer? cvc_check default_for_currency? deleted? description? dynamic_last4 exp_month exp_year fingerprint? funding iin? issuer? last4 metadata name networks? regulated_status status? tokenization_method

    Properties

    id: string

    Unique identifier for the object.

    object: "card"

    String representing the object's type. Objects of the same type share the same value.

    account?: string | Stripe.Account
    address_city: string

    City/District/Suburb/Town/Village.

    address_country: string

    Billing address country, if provided when creating card.

    address_line1: string

    Address line 1 (Street address/PO Box/Company name).

    address_line1_check: string

    If address_line1 was provided, results of the check: pass, fail, unavailable, or unchecked.

    address_line2: string

    Address line 2 (Apartment/Suite/Unit/Building).

    address_state: string

    State/County/Province/Region.

    address_zip: string

    ZIP or postal code.

    address_zip_check: string

    If address_zip was provided, results of the check: pass, fail, unavailable, or unchecked.

    allow_redisplay?: Stripe.Card.AllowRedisplay

    This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow. The field defaults to “unspecified”.

    available_payout_methods?: Stripe.Card.AvailablePayoutMethod[]

    A set of available payout methods for this card. Only values from this set should be passed as the method when creating a payout.

    brand: string

    Card brand. Can be American Express, Cartes Bancaires, Diners Club, Discover, Eftpos Australia, Girocard, JCB, MasterCard, UnionPay, Visa, or Unknown.

    country: string

    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.

    currency?: string

    Three-letter ISO code for currency in lowercase. Must be a supported currency. Only applicable on accounts (not customers or recipients). The card can be used as a transfer destination for funds in this currency. This property is only available when returned as an External Account where controller.is_controller is true.

    customer?: string | Stripe.Customer | DeletedCustomer

    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.

    cvc_check: string

    If a CVC was provided, results of the check: pass, fail, unavailable, or 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 Check if a card is valid without a charge.

    default_for_currency?: boolean

    Whether this card is the default external account for its currency. This property is only available for accounts where controller.requirement_collection is application, which includes Custom accounts.

    deleted?: void

    Always true for a deleted object

    description?: string

    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.)

    dynamic_last4: string

    (For tokenized numbers only.) The last four digits of the device account number.

    exp_month: number

    Two-digit number representing the card's expiration month.

    exp_year: number

    Four-digit number representing the card's expiration year.

    fingerprint?: string

    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.

    As of May 1, 2021, card fingerprint in India for Connect changed to allow two fingerprints for the same card---one for India and one for the rest of the world.

    funding: string

    Card funding type. Can be credit, debit, prepaid, or unknown.

    iin?: string

    Issuer identification number of the card. (For internal use only and not typically available in standard API requests.)

    issuer?: string

    The name of the card's issuing bank. (For internal use only and not typically available in standard API requests.)

    last4: string

    The last four digits of the card.

    metadata: Metadata

    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.

    name: string

    Cardholder name.

    networks?: Stripe.Card.Networks
    regulated_status: Stripe.Card.RegulatedStatus

    Status of a card based on the card issuer.

    status?: string

    For external accounts that are cards, possible values are new and errored. If a payout fails, the status is set to errored and scheduled payouts are stopped until account details are updated.

    tokenization_method: string

    If the card number is tokenized, this is the method that was used. Can be android_pay (includes Google Pay), apple_pay, masterpass, visa_checkout, or null.

    Settings

    Member Visibility

    On This Page

    Properties