Mayson Monorepo Documentation
    Preparing search index...

    Interface StripeUser

    interface StripeUser {
        email?: string;
        url?: string;
        country?: string;
        phone_number?: string;
        business_name?: string;
        business_type?: string;
        first_name?: string;
        last_name?: string;
        dob_day?: string;
        dob_month?: string;
        dob_year?: string;
        street_address?: string;
        city?: string;
        state?: string;
        zip?: string;
        physical_product?: string;
        product_description?: string;
        currency?: string;
        first_name_kana?: string;
        first_name_kanji?: string;
        last_name_kana?: string;
        last_name_kanji?: string;
        gender?: string;
        block_kana?: string;
        block_kanji?: string;
        building_kana?: string;
        building_kanji?: string;
    }
    Index

    Properties

    email? url? country? phone_number? business_name? business_type? first_name? last_name? dob_day? dob_month? dob_year? street_address? city? state? zip? physical_product? product_description? currency? first_name_kana? first_name_kanji? last_name_kana? last_name_kanji? gender? block_kana? block_kanji? building_kana? building_kanji?

    Properties

    email?: string

    Recommended The user's email address. Must be a valid email format.

    url?: string

    Recommended The URL for the user's business. This may be the user's website, a profile page within your application, or another publicly available profile for the business, such as a LinkedIn or Facebook profile. Must be URL-encoded and include a scheme (http or https). If you will be prefilling this field, we highly recommend that the linked page contain a description of the user's products or services and their contact information. If we don't have enough information, we'll have to reach out to the user directly before initiating payouts.

    country?: string

    Two-letter country code (e.g., US or CA). Must be a country that Stripe currently supports.

    phone_number?: string

    The business phone number. Must be 10 digits only. Must also prefill stripe_user[country] with the corresponding country.

    business_name?: string

    The legal name of the business, also used for the statement descriptor.

    business_type?: string

    The type of the business. Must be one of sole_prop, corporation, non_profit, partnership, or llc.

    first_name?: string

    First name of the person who will be filling out a Stripe application.

    last_name?: string

    Last name of the person who will be filling out a Stripe application.

    dob_day?: string

    Day (0-31), month (1-12), and year (YYYY, greater than 1900) for the birth date of the person who will be filling out a Stripe application. If you choose to pass these parameters, you must pass all three.

    dob_month?: string

    Day (0-31), month (1-12), and year (YYYY, greater than 1900) for the birth date of the person who will be filling out a Stripe application. If you choose to pass these parameters, you must pass all three.

    dob_year?: string

    Day (0-31), month (1-12), and year (YYYY, greater than 1900) for the birth date of the person who will be filling out a Stripe application. If you choose to pass these parameters, you must pass all three.

    street_address?: string

    Standard only Street address of the business.

    city?: string

    Standard only Address city of the business. We highly recommend that you also prefill stripe_user[country] with the corresponding country.

    state?: string

    Standard only Address state of the business. Must be the two-letter state or province code (e.g., NY for a U.S. business or AB for a Canadian one). Must also prefill stripe_user[country] with the corresponding country.

    zip?: string

    Standard only Address ZIP code of the business. Must be a string. We highly recommend that you also prefill stripe_user[country] with the corresponding country.

    physical_product?: string

    Standard only A string: true if the user sells a physical product, false otherwise.

    product_description?: string

    A description of what the business is accepting payments for.

    currency?: string

    Standard only Three-letter ISO code representing currency, in lowercase (e.g., usd or cad). Must be a valid country and currency combination that Stripe supports. Must prefill stripe_user[country] with the corresponding country.

    first_name_kana?: string

    The Kana variation of the first name of the person who will be filling out a Stripe application. Must prefill stripe_user[country] with JP, as this parameter is only relevant for Japan.

    first_name_kanji?: string

    The Kanji variation of the first name of the person who will be filling out a Stripe application. Must prefill stripe_user[country] with JP, as this parameter is only relevant for Japan.

    last_name_kana?: string

    The Kana variation of the last name of the person who will be filling out a Stripe application. Must prefill stripe_user[country] with JP, as this parameter is only relevant for Japan.

    last_name_kanji?: string

    The Kanji variation of the last name of the person who will be filling out a Stripe application. Must prefill stripe_user[country] with JP, as this parameter is only relevant for Japan.

    gender?: string

    The gender of the person who will be filling out a Stripe application. (International regulations require either male or female.) Must prefill stripe_user[country] with JP, as this parameter is only relevant for Japan.

    block_kana?: string

    Standard only The Kana variation of the address block. This parameter is only relevant for Japan. You must prefill stripe_user[country] with JP and stripe_user[zip] with a valid Japanese postal code to use this parameter.

    block_kanji?: string

    Standard only The Kanji variation of the address block. This parameter is only relevant for Japan. You must prefill stripe_user[country] with JP and stripe_user[zip] with a valid Japanese postal code to use this parameter.

    building_kana?: string

    Standard only The Kana variation of the address building. This parameter is only relevant for Japan. You must prefill stripe_user[country] with JP and stripe_user[zip] with a valid Japanese postal code to use this parameter.

    building_kanji?: string

    Standard only The Kanji variation of the address building. This parameter is only relevant for Japan. You must prefill stripe_user[country] with JP and stripe_user[zip] with a valid Japanese postal code to use this parameter.

    Settings

    Member Visibility

    On This Page

    Properties