@types/stripejs/customer.d.ts

TypeScript definitions for stripejs

export interface Customer {
    /**
     * The Address of the customer
     */
    address: Address;

    /**
     * The email address of the customer
     */
    email: string;

    /**
     * The full name of the owner
     */
    name: string;

    /**
     * The phone number of the customer
     * NOTE: This includes the extension
     */
    phone: string;

    /**
     * Verified customer’s address
     */
    readonly verified_address: Address;

    /**
     * Verified customer’s email address
     */
    readonly verified_email: string;

    /**
     * Verified customer’s full name
     */
    readonly verified_name: string;

    /**
     * Verified customer’s phone number
     */
    readonly verified_phone: string;
}

// --- CUSTOMER ADDRESS --- //
export interface Address {
    /**
     * City/District/Suburb/Town/Village.
     */
    city: string;

    /**
     * Two-letter country code, capitalized
     * NOTE: The codes are specified by the ISO3166 alpha-2
     */
    country: string;

    /**
     * Address line 1 (Street address/PO Box/Company name).
     */
    line1: string;

    /**
     * Address line 2 (Apartment/Suite/Unit/Building).
     */
    line2: string;

    /**
     * ZIP or postal code
     */
    postal_code: string;

    /**
     * State/County/Province/Region.
     */
    state: string;
}

// --- CARD PAYMENT OPTION --- //
/**
 * @see https://stripe.com/docs/api#card_object
 */
export interface Card {
    /**
     * The unique identifier of the bank account
     */
    id: string;

    /**
     * The account this card belongs to.
     * NOTE: This attribute will not be in the card object if the card belongs to a customer or recipient instead.
     */
    object: "card";

    account?: string | undefined;

    /**
     * City/District/Suburb/Town/Village
     */
    address_city: string;

    /**
     * The country in which the address is located
     */
    address_country: string;

    /**
     * Address line 1 (Street address/PO Box/Company name)
     */
    address_line1: string;

    /**
     * The results of address_line1 if it was provided
     */
    address_line1_check: checkStatus;

    /**
     * Address line 2 (Apartment/Suite/Unit/Building)
     */
    address_line2: string;

    /**
     * State/County/Province/Region.
     */
    address_state: string;

    /**
     * ZIP or postal code
     */
    address_zip: string;

    /**
     * The results of address_zip if it was provided
     */
    address_zip_check: checkStatus;

    /**
     * A set of available payout methods for this card
     * NOTE: Only values from this set should be passed as the method when creating a transfer
     */
    available_payout_methods: ["standard"] | ["standard", "instant"];

    /**
     * The brand of the card
     */
    brand: "American Express" | "Diners Club" | "Discover" | "JCB" | "MasterCard" | "UnionPay" | "Visa" | "Unknown";

    /**
     * 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
     */
    country: string;

    /**
     * Three-letter ISO code for currency
     * Only applicable on accounts (not customers or recipients).
     * The card can be used as a transfer destination for funds in this currency
     */
    currency?: string | undefined;

    /**
     * The customer that this card belongs to
     * NOTE: This attribute will not be in the card object if the card belongs to an account or recipient instead
     */
    customer?: any;

    /**
     * If a CVC was provided, results of the check
     */
    cvc_check: checkStatus;

    /**
     * Only applicable on accounts (not customers or recipients)
     * This indicates whether this card is the default external account for its currency
     */
    default_for_currency?: boolean | undefined;

    /**
     * The last four digits of the device account number.
     * NOTE: For tokenized numbers only
     */
    dynamic_last4: string;

    /**
     * Two-digit number representing the card’s expiration month
     */
    exp_month: number;

    /**
     * Four-digit number representing the card’s expiration year
     */
    exp_year: number;

    /**
     * Uniquely identifies this particular card number
     */
    fingerprint: string;

    /**
     * Card funding type
     */
    funding: "credit" | "debit" | "prepaid" | "unknown";

    /**
     * The last four digits of the card
     */
    last4: string;

    /**
     * The name of the cardholder
     */
    name: string;

    /**
     * The recipient that this card belongs to.
     * NOTE: This attribute will not be in the card object if the card belongs to a customer or account instead
     */
    recipient?: string | undefined;

    /**
     * If the card number is tokenized, this is the method that was used
     */
    tokenization_method: "apple_pay" | "android_pay";

    /**
     * Your own saved information with this card
     */
    metadata: { [key: string]: string };
}

export type checkStatus = "pass" | "fail" | "unavailable" | "unchecked";

// --- BANK ACCOUNT PAYMENT OPTION --- //
/**
 * @see https://stripe.com/docs/api#customer_bank_account_object
 */
export interface BankAccount {
    /**
     * The unique identifier of the bank account
     */
    id: string;

    object: "bank_account";

    /**
     * The name of the person or business that owns the bank account.
     */
    account_holder_name: string;

    /**
     * The type of entity that holds the account.
     */
    account_holder_type: "individual" | "company";

    /**
     * Name of the bank associated with the routing number
     * @example 'STRIPE TEST BANK'
     */
    bank_name: string;

    /**
     * The routing transit number for the bank account
     */
    routing_number: string;

    /**
     * Two-letter ISO code representing the country the bank account is located in
     * @example 'US'
     */
    country: string;
    /**
     * Three-letter ISO code for the currency paid out to the bank account
     * @example 'usd'
     */
    currency: string;

    customer: string;

    /**
     * Uniquely identifies this particular bank account.
     * NOTE: You can use this attribute to check whether two bank accounts are the same
     */
    fingerprint: string;

    /**
     * The last 4 digits of the bank number
     */
    last4: string;

    /**
     * Your own saved information with this bank account
     */
    metadata: { [key: string]: string };

    /**
     * The status of the bank account
     * @see https://stripe.com/docs/api#customer_bank_account_object-status
     */
    status: "new" | "validated" | "verified" | "verification_failed" | "errored";
}