Parameters for account create.
Summary
Types
@type configuration() :: %{ optional(:customer) => configuration_customer() | nil, optional(:merchant) => configuration_merchant() | nil, optional(:recipient) => configuration_recipient() | nil, optional(String.t()) => term() }
customer- The Customer Configuration allows the Account to be used in inbound payment flows.merchant- Enables the Account to act as a connected account and collect payments facilitated by a Connect platform. You must onboard your platform to Connect before you can add this configuration to your connected accounts. Utilize this configuration when the Account will be the Merchant of Record, like with Direct charges or Destination Charges with on_behalf_of set.recipient- The Recipient Configuration allows the Account to receive funds. Utilize this configuration if the Account will not be the Merchant of Record, like with Separate Charges & Transfers, or Destination Charges without on_behalf_of set.
@type configuration_customer() :: %{ optional(:automatic_indirect_tax) => configuration_customer_automatic_indirect_tax() | nil, optional(:billing) => configuration_customer_billing() | nil, optional(:capabilities) => configuration_customer_capabilities() | nil, optional(:shipping) => configuration_customer_shipping() | nil, optional(:test_clock) => String.t() | nil, optional(String.t()) => term() }
automatic_indirect_tax- Automatic indirect tax settings to be used when automatic tax calculation is enabled on the customer's invoices, subscriptions, checkout sessions, or payment links. Surfaces if automatic tax calculation is possible given the current customer location information.billing- Billing settings - default settings used for this customer in Billing flows such as Invoices and Subscriptions.capabilities- Capabilities that have been requested on the Customer Configuration.shipping- The customer's shipping information. Appears on invoices emailed to this customer.test_clock- ID of the test clock to attach to the customer. Can only be set on testmode Accounts, and when the Customer Configuration is first set on an Account.
@type configuration_customer_automatic_indirect_tax() :: %{ optional(:exempt) => String.t() | nil, optional(:ip_address) => String.t() | nil, optional(String.t()) => term() }
exempt- Describes the customer's tax exemption status, which isnone,exempt, orreverse. When set to reverse, invoice and receipt PDFs include the following text: “Reverse charge”. Possible values:exempt,none,reverse.ip_address- A recent IP address of the customer used for tax reporting and tax location inference.
@type configuration_customer_billing() :: %{ optional(:invoice) => configuration_customer_billing_invoice() | nil, optional(String.t()) => term() }
invoice- Default invoice settings for the customer account.
@type configuration_customer_billing_invoice() :: %{ optional(:custom_fields) => [configuration_customer_billing_invoice_custom_fields()] | nil, optional(:footer) => String.t() | nil, optional(:next_sequence) => integer() | nil, optional(:prefix) => String.t() | nil, optional(:rendering) => configuration_customer_billing_invoice_rendering() | nil, optional(String.t()) => term() }
custom_fields- The list of up to 4 default custom fields to be displayed on invoices for this customer.footer- Default invoice footer.next_sequence- Sequence number to use on the customer account's next invoice. Defaults to 1.prefix- Prefix used to generate unique invoice numbers. Must be 3-12 uppercase letters or numbers.rendering- Default invoice PDF rendering options.
@type configuration_customer_billing_invoice_custom_fields() :: %{ optional(:name) => String.t() | nil, optional(:value) => String.t() | nil, optional(String.t()) => term() }
name- The name of the custom field. This may be up to 40 characters.value- The value of the custom field. This may be up to 140 characters. When updating, pass an empty string to remove previously-defined values.
@type configuration_customer_billing_invoice_rendering() :: %{ optional(:amount_tax_display) => String.t() | nil, optional(:template) => String.t() | nil, optional(String.t()) => term() }
amount_tax_display- Indicates whether displayed line item prices and amounts on invoice PDFs include inclusive tax amounts. Must be eitherinclude_inclusive_taxorexclude_tax. Possible values:exclude_tax,include_inclusive_tax.template- ID of the invoice rendering template to use for future invoices.
@type configuration_customer_capabilities() :: %{ optional(:automatic_indirect_tax) => configuration_customer_capabilities_automatic_indirect_tax() | nil, optional(String.t()) => term() }
automatic_indirect_tax- Generates requirements for enabling automatic indirect tax calculation on this customer's invoices or subscriptions. Recommended to request this capability if planning to enable automatic tax calculation on this customer's invoices or subscriptions.
@type configuration_customer_capabilities_automatic_indirect_tax() :: %{ optional(:requested) => boolean() | nil, optional(String.t()) => term() }
requested- To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.
@type configuration_customer_shipping() :: %{ optional(:address) => configuration_customer_shipping_address() | nil, optional(:name) => String.t() | nil, optional(:phone) => String.t() | nil, optional(String.t()) => term() }
address- Customer shipping address.name- Customer name.phone- Customer phone (including extension).
@type configuration_customer_shipping_address() :: %{ optional(:city) => String.t() | nil, optional(:country) => String.t() | nil, optional(:line1) => String.t() | nil, optional(:line2) => String.t() | nil, optional(:postal_code) => String.t() | nil, optional(:state) => String.t() | nil, optional(String.t()) => term() }
city- City, district, suburb, town, or village.country- Two-letter country code (ISO 3166-1 alpha-2).line1- Address line 1 (e.g., street, PO Box, or company name).line2- Address line 2 (e.g., apartment, suite, unit, or building).postal_code- ZIP or postal code.state- State, county, province, or region.
@type configuration_merchant() :: %{ optional(:bacs_debit_payments) => configuration_merchant_bacs_debit_payments() | nil, optional(:branding) => configuration_merchant_branding() | nil, optional(:capabilities) => configuration_merchant_capabilities() | nil, optional(:card_payments) => configuration_merchant_card_payments() | nil, optional(:konbini_payments) => configuration_merchant_konbini_payments() | nil, optional(:mcc) => String.t() | nil, optional(:script_statement_descriptor) => configuration_merchant_script_statement_descriptor() | nil, optional(:statement_descriptor) => configuration_merchant_statement_descriptor() | nil, optional(:support) => configuration_merchant_support() | nil, optional(String.t()) => term() }
bacs_debit_payments- Settings used for Bacs debit payments.branding- Settings used to apply the merchant's branding to email receipts, invoices, Checkout, and other products.capabilities- Capabilities to request on the Merchant Configuration.card_payments- Card payments settings.konbini_payments- Settings specific to Konbini payments on the account.mcc- The Merchant Category Code (MCC) for the Merchant Configuration. MCCs classify businesses based on the goods or services they provide.script_statement_descriptor- Settings for the default text that appears on statements for language variations.statement_descriptor- Statement descriptor.support- Publicly available contact information for sending support issues to.
@type configuration_merchant_bacs_debit_payments() :: %{ optional(:display_name) => String.t() | nil, optional(String.t()) => term() }
display_name- Display name for Bacs Direct Debit payments.
@type configuration_merchant_branding() :: %{ optional(:icon) => String.t() | nil, optional(:logo) => String.t() | nil, optional(:primary_color) => String.t() | nil, optional(:secondary_color) => String.t() | nil, optional(String.t()) => term() }
icon- ID of a file upload: An icon for the merchant. Must be square and at least 128px x 128px.logo- ID of a file upload: A logo for the merchant that will be used in Checkout instead of the icon and without the merchant's name next to it if provided. Must be at least 128px x 128px.primary_color- A CSS hex color value representing the primary branding color for the merchant.secondary_color- A CSS hex color value representing the secondary branding color for the merchant.
@type configuration_merchant_capabilities() :: %{ optional(:ach_debit_payments) => configuration_merchant_capabilities_ach_debit_payments() | nil, optional(:acss_debit_payments) => configuration_merchant_capabilities_acss_debit_payments() | nil, optional(:affirm_payments) => configuration_merchant_capabilities_affirm_payments() | nil, optional(:afterpay_clearpay_payments) => configuration_merchant_capabilities_afterpay_clearpay_payments() | nil, optional(:alma_payments) => configuration_merchant_capabilities_alma_payments() | nil, optional(:amazon_pay_payments) => configuration_merchant_capabilities_amazon_pay_payments() | nil, optional(:au_becs_debit_payments) => configuration_merchant_capabilities_au_becs_debit_payments() | nil, optional(:bacs_debit_payments) => configuration_merchant_capabilities_bacs_debit_payments() | nil, optional(:bancontact_payments) => configuration_merchant_capabilities_bancontact_payments() | nil, optional(:blik_payments) => configuration_merchant_capabilities_blik_payments() | nil, optional(:boleto_payments) => configuration_merchant_capabilities_boleto_payments() | nil, optional(:card_payments) => configuration_merchant_capabilities_card_payments() | nil, optional(:cartes_bancaires_payments) => configuration_merchant_capabilities_cartes_bancaires_payments() | nil, optional(:cashapp_payments) => configuration_merchant_capabilities_cashapp_payments() | nil, optional(:eps_payments) => configuration_merchant_capabilities_eps_payments() | nil, optional(:fpx_payments) => configuration_merchant_capabilities_fpx_payments() | nil, optional(:gb_bank_transfer_payments) => configuration_merchant_capabilities_gb_bank_transfer_payments() | nil, optional(:grabpay_payments) => configuration_merchant_capabilities_grabpay_payments() | nil, optional(:ideal_payments) => configuration_merchant_capabilities_ideal_payments() | nil, optional(:jcb_payments) => configuration_merchant_capabilities_jcb_payments() | nil, optional(:jp_bank_transfer_payments) => configuration_merchant_capabilities_jp_bank_transfer_payments() | nil, optional(:kakao_pay_payments) => configuration_merchant_capabilities_kakao_pay_payments() | nil, optional(:klarna_payments) => configuration_merchant_capabilities_klarna_payments() | nil, optional(:konbini_payments) => configuration_merchant_capabilities_konbini_payments() | nil, optional(:kr_card_payments) => configuration_merchant_capabilities_kr_card_payments() | nil, optional(:link_payments) => configuration_merchant_capabilities_link_payments() | nil, optional(:mobilepay_payments) => configuration_merchant_capabilities_mobilepay_payments() | nil, optional(:multibanco_payments) => configuration_merchant_capabilities_multibanco_payments() | nil, optional(:mx_bank_transfer_payments) => configuration_merchant_capabilities_mx_bank_transfer_payments() | nil, optional(:naver_pay_payments) => configuration_merchant_capabilities_naver_pay_payments() | nil, optional(:oxxo_payments) => configuration_merchant_capabilities_oxxo_payments() | nil, optional(:p24_payments) => configuration_merchant_capabilities_p24_payments() | nil, optional(:pay_by_bank_payments) => configuration_merchant_capabilities_pay_by_bank_payments() | nil, optional(:payco_payments) => configuration_merchant_capabilities_payco_payments() | nil, optional(:paynow_payments) => configuration_merchant_capabilities_paynow_payments() | nil, optional(:promptpay_payments) => configuration_merchant_capabilities_promptpay_payments() | nil, optional(:revolut_pay_payments) => configuration_merchant_capabilities_revolut_pay_payments() | nil, optional(:samsung_pay_payments) => configuration_merchant_capabilities_samsung_pay_payments() | nil, optional(:sepa_bank_transfer_payments) => configuration_merchant_capabilities_sepa_bank_transfer_payments() | nil, optional(:sepa_debit_payments) => configuration_merchant_capabilities_sepa_debit_payments() | nil, optional(:swish_payments) => configuration_merchant_capabilities_swish_payments() | nil, optional(:twint_payments) => configuration_merchant_capabilities_twint_payments() | nil, optional(:us_bank_transfer_payments) => configuration_merchant_capabilities_us_bank_transfer_payments() | nil, optional(:zip_payments) => configuration_merchant_capabilities_zip_payments() | nil, optional(String.t()) => term() }
ach_debit_payments- Allow the merchant to process ACH debit payments.acss_debit_payments- Allow the merchant to process ACSS debit payments.affirm_payments- Allow the merchant to process Affirm payments.afterpay_clearpay_payments- Allow the merchant to process Afterpay/Clearpay payments.alma_payments- Allow the merchant to process Alma payments.amazon_pay_payments- Allow the merchant to process Amazon Pay payments.au_becs_debit_payments- Allow the merchant to process Australian BECS Direct Debit payments.bacs_debit_payments- Allow the merchant to process BACS Direct Debit payments.bancontact_payments- Allow the merchant to process Bancontact payments.blik_payments- Allow the merchant to process BLIK payments.boleto_payments- Allow the merchant to process Boleto payments.card_payments- Allow the merchant to collect card payments.cartes_bancaires_payments- Allow the merchant to process Cartes Bancaires payments.cashapp_payments- Allow the merchant to process Cash App payments.eps_payments- Allow the merchant to process EPS payments.fpx_payments- Allow the merchant to process FPX payments.gb_bank_transfer_payments- Allow the merchant to process UK bank transfer payments.grabpay_payments- Allow the merchant to process GrabPay payments.ideal_payments- Allow the merchant to process iDEAL payments.jcb_payments- Allow the merchant to process JCB card payments.jp_bank_transfer_payments- Allow the merchant to process Japanese bank transfer payments.kakao_pay_payments- Allow the merchant to process Kakao Pay payments.klarna_payments- Allow the merchant to process Klarna payments.konbini_payments- Allow the merchant to process Konbini convenience store payments.kr_card_payments- Allow the merchant to process Korean card payments.link_payments- Allow the merchant to process Link payments.mobilepay_payments- Allow the merchant to process MobilePay payments.multibanco_payments- Allow the merchant to process Multibanco payments.mx_bank_transfer_payments- Allow the merchant to process Mexican bank transfer payments.naver_pay_payments- Allow the merchant to process Naver Pay payments.oxxo_payments- Allow the merchant to process OXXO payments.p24_payments- Allow the merchant to process Przelewy24 (P24) payments.pay_by_bank_payments- Allow the merchant to process Pay by Bank payments.payco_payments- Allow the merchant to process PAYCO payments.paynow_payments- Allow the merchant to process PayNow payments.promptpay_payments- Allow the merchant to process PromptPay payments.revolut_pay_payments- Allow the merchant to process Revolut Pay payments.samsung_pay_payments- Allow the merchant to process Samsung Pay payments.sepa_bank_transfer_payments- Allow the merchant to process SEPA bank transfer payments.sepa_debit_payments- Allow the merchant to process SEPA Direct Debit payments.swish_payments- Allow the merchant to process Swish payments.twint_payments- Allow the merchant to process TWINT payments.us_bank_transfer_payments- Allow the merchant to process US bank transfer payments.zip_payments- Allow the merchant to process Zip payments.
@type configuration_merchant_capabilities_ach_debit_payments() :: %{ optional(:requested) => boolean() | nil, optional(String.t()) => term() }
requested- To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.
@type configuration_merchant_capabilities_acss_debit_payments() :: %{ optional(:requested) => boolean() | nil, optional(String.t()) => term() }
requested- To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.
@type configuration_merchant_capabilities_affirm_payments() :: %{ optional(:requested) => boolean() | nil, optional(String.t()) => term() }
requested- To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.
@type configuration_merchant_capabilities_afterpay_clearpay_payments() :: %{ optional(:requested) => boolean() | nil, optional(String.t()) => term() }
requested- To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.
@type configuration_merchant_capabilities_alma_payments() :: %{ optional(:requested) => boolean() | nil, optional(String.t()) => term() }
requested- To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.
@type configuration_merchant_capabilities_amazon_pay_payments() :: %{ optional(:requested) => boolean() | nil, optional(String.t()) => term() }
requested- To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.
@type configuration_merchant_capabilities_au_becs_debit_payments() :: %{ optional(:requested) => boolean() | nil, optional(String.t()) => term() }
requested- To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.
@type configuration_merchant_capabilities_bacs_debit_payments() :: %{ optional(:requested) => boolean() | nil, optional(String.t()) => term() }
requested- To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.
@type configuration_merchant_capabilities_bancontact_payments() :: %{ optional(:requested) => boolean() | nil, optional(String.t()) => term() }
requested- To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.
@type configuration_merchant_capabilities_blik_payments() :: %{ optional(:requested) => boolean() | nil, optional(String.t()) => term() }
requested- To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.
@type configuration_merchant_capabilities_boleto_payments() :: %{ optional(:requested) => boolean() | nil, optional(String.t()) => term() }
requested- To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.
@type configuration_merchant_capabilities_card_payments() :: %{ optional(:requested) => boolean() | nil, optional(String.t()) => term() }
requested- To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.
@type configuration_merchant_capabilities_cartes_bancaires_payments() :: %{ optional(:requested) => boolean() | nil, optional(String.t()) => term() }
requested- To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.
@type configuration_merchant_capabilities_cashapp_payments() :: %{ optional(:requested) => boolean() | nil, optional(String.t()) => term() }
requested- To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.
@type configuration_merchant_capabilities_eps_payments() :: %{ optional(:requested) => boolean() | nil, optional(String.t()) => term() }
requested- To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.
@type configuration_merchant_capabilities_fpx_payments() :: %{ optional(:requested) => boolean() | nil, optional(String.t()) => term() }
requested- To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.
@type configuration_merchant_capabilities_gb_bank_transfer_payments() :: %{ optional(:requested) => boolean() | nil, optional(String.t()) => term() }
requested- To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.
@type configuration_merchant_capabilities_grabpay_payments() :: %{ optional(:requested) => boolean() | nil, optional(String.t()) => term() }
requested- To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.
@type configuration_merchant_capabilities_ideal_payments() :: %{ optional(:requested) => boolean() | nil, optional(String.t()) => term() }
requested- To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.
@type configuration_merchant_capabilities_jcb_payments() :: %{ optional(:requested) => boolean() | nil, optional(String.t()) => term() }
requested- To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.
@type configuration_merchant_capabilities_jp_bank_transfer_payments() :: %{ optional(:requested) => boolean() | nil, optional(String.t()) => term() }
requested- To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.
@type configuration_merchant_capabilities_kakao_pay_payments() :: %{ optional(:requested) => boolean() | nil, optional(String.t()) => term() }
requested- To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.
@type configuration_merchant_capabilities_klarna_payments() :: %{ optional(:requested) => boolean() | nil, optional(String.t()) => term() }
requested- To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.
@type configuration_merchant_capabilities_konbini_payments() :: %{ optional(:requested) => boolean() | nil, optional(String.t()) => term() }
requested- To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.
@type configuration_merchant_capabilities_kr_card_payments() :: %{ optional(:requested) => boolean() | nil, optional(String.t()) => term() }
requested- To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.
@type configuration_merchant_capabilities_link_payments() :: %{ optional(:requested) => boolean() | nil, optional(String.t()) => term() }
requested- To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.
@type configuration_merchant_capabilities_mobilepay_payments() :: %{ optional(:requested) => boolean() | nil, optional(String.t()) => term() }
requested- To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.
@type configuration_merchant_capabilities_multibanco_payments() :: %{ optional(:requested) => boolean() | nil, optional(String.t()) => term() }
requested- To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.
@type configuration_merchant_capabilities_mx_bank_transfer_payments() :: %{ optional(:requested) => boolean() | nil, optional(String.t()) => term() }
requested- To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.
@type configuration_merchant_capabilities_oxxo_payments() :: %{ optional(:requested) => boolean() | nil, optional(String.t()) => term() }
requested- To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.
@type configuration_merchant_capabilities_p24_payments() :: %{ optional(:requested) => boolean() | nil, optional(String.t()) => term() }
requested- To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.
@type configuration_merchant_capabilities_pay_by_bank_payments() :: %{ optional(:requested) => boolean() | nil, optional(String.t()) => term() }
requested- To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.
@type configuration_merchant_capabilities_payco_payments() :: %{ optional(:requested) => boolean() | nil, optional(String.t()) => term() }
requested- To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.
@type configuration_merchant_capabilities_paynow_payments() :: %{ optional(:requested) => boolean() | nil, optional(String.t()) => term() }
requested- To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.
@type configuration_merchant_capabilities_promptpay_payments() :: %{ optional(:requested) => boolean() | nil, optional(String.t()) => term() }
requested- To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.
@type configuration_merchant_capabilities_revolut_pay_payments() :: %{ optional(:requested) => boolean() | nil, optional(String.t()) => term() }
requested- To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.
@type configuration_merchant_capabilities_samsung_pay_payments() :: %{ optional(:requested) => boolean() | nil, optional(String.t()) => term() }
requested- To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.
@type configuration_merchant_capabilities_sepa_bank_transfer_payments() :: %{ optional(:requested) => boolean() | nil, optional(String.t()) => term() }
requested- To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.
@type configuration_merchant_capabilities_sepa_debit_payments() :: %{ optional(:requested) => boolean() | nil, optional(String.t()) => term() }
requested- To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.
@type configuration_merchant_capabilities_swish_payments() :: %{ optional(:requested) => boolean() | nil, optional(String.t()) => term() }
requested- To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.
@type configuration_merchant_capabilities_twint_payments() :: %{ optional(:requested) => boolean() | nil, optional(String.t()) => term() }
requested- To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.
@type configuration_merchant_capabilities_us_bank_transfer_payments() :: %{ optional(:requested) => boolean() | nil, optional(String.t()) => term() }
requested- To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.
@type configuration_merchant_capabilities_zip_payments() :: %{ optional(:requested) => boolean() | nil, optional(String.t()) => term() }
requested- To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.
@type configuration_merchant_card_payments() :: %{ optional(:decline_on) => configuration_merchant_card_payments_decline_on() | nil, optional(String.t()) => term() }
decline_on- Automatically declines certain charge types regardless of whether the card issuer accepted or declined the charge.
@type configuration_merchant_card_payments_decline_on() :: %{ optional(:avs_failure) => boolean() | nil, optional(:cvc_failure) => boolean() | nil, optional(String.t()) => term() }
avs_failure- Whether Stripe automatically declines charges with an incorrect ZIP or postal code. This setting only applies when a ZIP or postal code is provided and they fail bank verification.cvc_failure- Whether Stripe automatically declines charges with an incorrect CVC. This setting only applies when a CVC is provided and it fails bank verification.
@type configuration_merchant_konbini_payments() :: %{ optional(:support) => configuration_merchant_konbini_payments_support() | nil, optional(String.t()) => term() }
support- Support for Konbini payments.
@type configuration_merchant_konbini_payments_support() :: %{ optional(:email) => String.t() | nil, optional(:hours) => configuration_merchant_konbini_payments_support_hours() | nil, optional(:phone) => String.t() | nil, optional(String.t()) => term() }
email- Support email address for Konbini payments.hours- Support hours for Konbini payments.phone- Support phone number for Konbini payments.
@type configuration_merchant_konbini_payments_support_hours() :: %{ optional(:end_time) => String.t() | nil, optional(:start_time) => String.t() | nil, optional(String.t()) => term() }
end_time- Support hours end time (JST time of day) for inHH:MMformat.start_time- Support hours start time (JST time of day) for inHH:MMformat.
@type configuration_merchant_script_statement_descriptor() :: %{ optional(:kana) => configuration_merchant_script_statement_descriptor_kana() | nil, optional(:kanji) => configuration_merchant_script_statement_descriptor_kanji() | nil, optional(String.t()) => term() }
kana- The Kana variation of statement_descriptor used for charges in Japan. Japanese statement descriptors have special requirements.kanji- The Kanji variation of statement_descriptor used for charges in Japan. Japanese statement descriptors have special requirements.
@type configuration_merchant_script_statement_descriptor_kana() :: %{ optional(:descriptor) => String.t() | nil, optional(:prefix) => String.t() | nil, optional(String.t()) => term() }
descriptor- The default text that appears on statements for non-card charges outside of Japan. For card charges, if you don’t set a statement_descriptor_prefix, this text is also used as the statement descriptor prefix. In that case, if concatenating the statement descriptor suffix causes the combined statement descriptor to exceed 22 characters, we truncate the statement_descriptor text to limit the full descriptor to 22 characters. For more information about statement descriptors and their requirements, see the Merchant Configuration settings documentation.prefix- Default text that appears on statements for card charges outside of Japan, prefixing any dynamic statement_descriptor_suffix specified on the charge. To maximize space for the dynamic part of the descriptor, keep this text short. If you don’t specify this value, statement_descriptor is used as the prefix. For more information about statement descriptors and their requirements, see the Merchant Configuration settings documentation.
@type configuration_merchant_script_statement_descriptor_kanji() :: %{ optional(:descriptor) => String.t() | nil, optional(:prefix) => String.t() | nil, optional(String.t()) => term() }
descriptor- The default text that appears on statements for non-card charges outside of Japan. For card charges, if you don’t set a statement_descriptor_prefix, this text is also used as the statement descriptor prefix. In that case, if concatenating the statement descriptor suffix causes the combined statement descriptor to exceed 22 characters, we truncate the statement_descriptor text to limit the full descriptor to 22 characters. For more information about statement descriptors and their requirements, see the Merchant Configuration settings documentation.prefix- Default text that appears on statements for card charges outside of Japan, prefixing any dynamic statement_descriptor_suffix specified on the charge. To maximize space for the dynamic part of the descriptor, keep this text short. If you don’t specify this value, statement_descriptor is used as the prefix. For more information about statement descriptors and their requirements, see the Merchant Configuration settings documentation.
@type configuration_merchant_statement_descriptor() :: %{ optional(:descriptor) => String.t() | nil, optional(:prefix) => String.t() | nil, optional(String.t()) => term() }
descriptor- The default text that appears on statements for non-card charges outside of Japan. For card charges, if you don’t set a statement_descriptor_prefix, this text is also used as the statement descriptor prefix. In that case, if concatenating the statement descriptor suffix causes the combined statement descriptor to exceed 22 characters, we truncate the statement_descriptor text to limit the full descriptor to 22 characters. For more information about statement descriptors and their requirements, see the Merchant Configuration settings documentation.prefix- Default text that appears on statements for card charges outside of Japan, prefixing any dynamic statement_descriptor_suffix specified on the charge. To maximize space for the dynamic part of the descriptor, keep this text short. If you don’t specify this value, statement_descriptor is used as the prefix. For more information about statement descriptors and their requirements, see the Merchant Configuration settings documentation.
@type configuration_merchant_support() :: %{ optional(:address) => configuration_merchant_support_address() | nil, optional(:email) => String.t() | nil, optional(:phone) => String.t() | nil, optional(:url) => String.t() | nil, optional(String.t()) => term() }
address- A publicly available mailing address for sending support issues to.email- A publicly available email address for sending support issues to.phone- A publicly available phone number to call with support issues.url- A publicly available website for handling support issues.
@type configuration_merchant_support_address() :: %{ optional(:city) => String.t() | nil, optional(:country) => String.t() | nil, optional(:line1) => String.t() | nil, optional(:line2) => String.t() | nil, optional(:postal_code) => String.t() | nil, optional(:state) => String.t() | nil, optional(:town) => String.t() | nil, optional(String.t()) => term() }
city- City, district, suburb, town, or village.country- Two-letter country code (ISO 3166-1 alpha-2).line1- Address line 1 (e.g., street, PO Box, or company name).line2- Address line 2 (e.g., apartment, suite, unit, or building).postal_code- ZIP or postal code.state- State, county, province, or region.town- Town or district.
@type configuration_recipient() :: %{ optional(:capabilities) => configuration_recipient_capabilities() | nil, optional(String.t()) => term() }
capabilities- Capabilities to be requested on the Recipient Configuration.
@type configuration_recipient_capabilities() :: %{ optional(:stripe_balance) => configuration_recipient_capabilities_stripe_balance() | nil, optional(String.t()) => term() }
stripe_balance- Capabilities that enable the recipient to manage their Stripe Balance (/v1/balance).
@type configuration_recipient_capabilities_stripe_balance() :: %{ optional(:stripe_transfers) => configuration_recipient_capabilities_stripe_balance_stripe_transfers() | nil, optional(String.t()) => term() }
stripe_transfers- Enables this Account to receive /v1/transfers into their Stripe Balance (/v1/balance).
@type configuration_recipient_capabilities_stripe_balance_stripe_transfers() :: %{ optional(:requested) => boolean() | nil, optional(String.t()) => term() }
requested- To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.
@type defaults() :: %{ optional(:currency) => String.t() | nil, optional(:locales) => [String.t()] | nil, optional(:profile) => defaults_profile() | nil, optional(:responsibilities) => defaults_responsibilities() | nil, optional(String.t()) => term() }
currency- Three-letter ISO currency code, in lowercase. Must be a supported currency.locales- The Account's preferred locales (languages), ordered by preference.profile- Account profile information.responsibilities- Default responsibilities held by either Stripe or the platform.
@type defaults_profile() :: %{ optional(:business_url) => String.t() | nil, optional(:doing_business_as) => String.t() | nil, optional(:product_description) => String.t() | nil, optional(String.t()) => term() }
business_url- The business's publicly-available website.doing_business_as- The name which is used by the business.product_description- Internal-only description of the product sold or service provided by the business. It's used by Stripe for risk and underwriting purposes.
@type defaults_responsibilities() :: %{ optional(:fees_collector) => String.t() | nil, optional(:losses_collector) => String.t() | nil, optional(String.t()) => term() }
fees_collector- A value indicating the party responsible for collecting fees from this account. Possible values:application,application_custom,application_express,stripe.losses_collector- A value indicating who is responsible for losses when this Account can’t pay back negative balances from payments. Possible values:application,stripe.
@type identity() :: %{ optional(:attestations) => identity_attestations() | nil, optional(:business_details) => identity_business_details() | nil, optional(:country) => String.t() | nil, optional(:entity_type) => String.t() | nil, optional(:individual) => identity_individual() | nil, optional(String.t()) => term() }
attestations- Attestations from the identity's key people, e.g. owners, executives, directors, representatives.business_details- Information about the company or business.country- The country in which the account holder resides, or in which the business is legally established. This should be an ISO 3166-1 alpha-2 country code.entity_type- The entity type. Possible values:company,government_entity,individual,non_profit.individual- Information about the person represented by the account.
@type identity_attestations() :: %{ optional(:directorship_declaration) => identity_attestations_directorship_declaration() | nil, optional(:ownership_declaration) => identity_attestations_ownership_declaration() | nil, optional(:persons_provided) => identity_attestations_persons_provided() | nil, optional(:representative_declaration) => identity_attestations_representative_declaration() | nil, optional(:terms_of_service) => identity_attestations_terms_of_service() | nil, optional(String.t()) => term() }
directorship_declaration- This hash is used to attest that the directors information provided to Stripe is both current and correct.ownership_declaration- This hash is used to attest that the beneficial owner information provided to Stripe is both current and correct.persons_provided- Attestation that all Persons with a specific Relationship value have been provided.representative_declaration- This hash is used to attest that the representative is authorized to act as the representative of their legal entity.terms_of_service- Attestations of accepted terms of service agreements.
@type identity_attestations_directorship_declaration() :: %{ optional(:date) => String.t() | nil, optional(:ip) => String.t() | nil, optional(:user_agent) => String.t() | nil, optional(String.t()) => term() }
date- The time marking when the director attestation was made. Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z. Format: date-time.ip- The IP address from which the director attestation was made.user_agent- The user agent of the browser from which the director attestation was made.
@type identity_attestations_ownership_declaration() :: %{ optional(:date) => String.t() | nil, optional(:ip) => String.t() | nil, optional(:user_agent) => String.t() | nil, optional(String.t()) => term() }
date- The time marking when the beneficial owner attestation was made. Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z. Format: date-time.ip- The IP address from which the beneficial owner attestation was made.user_agent- The user agent of the browser from which the beneficial owner attestation was made.
@type identity_attestations_persons_provided() :: %{ optional(:directors) => boolean() | nil, optional(:executives) => boolean() | nil, optional(:owners) => boolean() | nil, optional(:ownership_exemption_reason) => String.t() | nil, optional(String.t()) => term() }
directors- Whether the company’s directors have been provided. Set this Boolean to true after creating all the company’s directors with the Persons API.executives- Whether the company’s executives have been provided. Set this Boolean to true after creating all the company’s executives with the Persons API.owners- Whether the company’s owners have been provided. Set this Boolean to true after creating all the company’s owners with the Persons API.ownership_exemption_reason- Reason for why the company is exempt from providing ownership information. Possible values:qualified_entity_exceeds_ownership_threshold,qualifies_as_financial_institution.
@type identity_attestations_representative_declaration() :: %{ optional(:date) => String.t() | nil, optional(:ip) => String.t() | nil, optional(:user_agent) => String.t() | nil, optional(String.t()) => term() }
date- The time marking when the representative attestation was made. Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z. Format: date-time.ip- The IP address from which the representative attestation was made.user_agent- The user agent of the browser from which the representative attestation was made.
@type identity_attestations_terms_of_service() :: %{ optional(:account) => identity_attestations_terms_of_service_account() | nil, optional(String.t()) => term() }
account- Details on the Account's acceptance of the Stripe Services Agreement.
@type identity_attestations_terms_of_service_account() :: %{ optional(:date) => String.t() | nil, optional(:ip) => String.t() | nil, optional(:user_agent) => String.t() | nil, optional(String.t()) => term() }
date- The time when the Account's representative accepted the terms of service. Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z. Format: date-time.ip- The IP address from which the Account's representative accepted the terms of service.user_agent- The user agent of the browser from which the Account's representative accepted the terms of service.
@type identity_business_details() :: %{ optional(:address) => identity_business_details_address() | nil, optional(:annual_revenue) => identity_business_details_annual_revenue() | nil, optional(:documents) => identity_business_details_documents() | nil, optional(:estimated_worker_count) => integer() | nil, optional(:id_numbers) => [identity_business_details_id_numbers()] | nil, optional(:monthly_estimated_revenue) => identity_business_details_monthly_estimated_revenue() | nil, optional(:phone) => String.t() | nil, optional(:registered_name) => String.t() | nil, optional(:registration_date) => identity_business_details_registration_date() | nil, optional(:script_addresses) => identity_business_details_script_addresses() | nil, optional(:script_names) => identity_business_details_script_names() | nil, optional(:structure) => String.t() | nil, optional(String.t()) => term() }
address- The business registration address of the business entity.annual_revenue- The business gross annual revenue for its preceding fiscal year.documents- A document verifying the business.estimated_worker_count- Estimated maximum number of workers currently engaged by the business (including employees, contractors, and vendors).id_numbers- The ID numbers of a business entity.monthly_estimated_revenue- An estimate of the monthly revenue of the business.phone- The phone number of the Business Entity.registered_name- The business legal name.registration_date- When the business was incorporated or registered.script_addresses- The business registration address of the business entity in non latin script.script_names- The business legal name in non latin script.structure- The category identifying the legal structure of the business. Possible values:cooperative,free_zone_establishment,free_zone_llc,governmental_unit,government_instrumentality,incorporated_association,incorporated_non_profit,incorporated_partnership,limited_liability_partnership,llc,multi_member_llc,private_company,private_corporation,private_partnership,public_company,public_corporation,public_listed_corporation,public_partnership,registered_charity,single_member_llc,sole_establishment,sole_proprietorship,tax_exempt_government_instrumentality,trust,unincorporated_association,unincorporated_non_profit,unincorporated_partnership.
@type identity_business_details_address() :: %{ optional(:city) => String.t() | nil, optional(:country) => String.t() | nil, optional(:line1) => String.t() | nil, optional(:line2) => String.t() | nil, optional(:postal_code) => String.t() | nil, optional(:state) => String.t() | nil, optional(:town) => String.t() | nil, optional(String.t()) => term() }
city- City, district, suburb, town, or village.country- Two-letter country code (ISO 3166-1 alpha-2).line1- Address line 1 (e.g., street, PO Box, or company name).line2- Address line 2 (e.g., apartment, suite, unit, or building).postal_code- ZIP or postal code.state- State, county, province, or region.town- Town or district.
@type identity_business_details_annual_revenue() :: %{ optional(:amount) => identity_business_details_annual_revenue_amount() | nil, optional(:fiscal_year_end) => String.t() | nil, optional(String.t()) => term() }
amount- A non-negative integer representing the amount in the smallest currency unit.fiscal_year_end- The close-out date of the preceding fiscal year in ISO 8601 format. E.g. 2023-12-31 for the 31st of December, 2023.
@type identity_business_details_annual_revenue_amount() :: %{ optional(:currency) => String.t() | nil, optional(:value) => integer() | nil, optional(String.t()) => term() }
currency- Three-letter ISO currency code, in lowercase. Must be a supported currency.value- A non-negative integer representing how much to charge in the smallest currency unit.
@type identity_business_details_documents() :: %{ optional(:bank_account_ownership_verification) => identity_business_details_documents_bank_account_ownership_verification() | nil, optional(:company_license) => identity_business_details_documents_company_license() | nil, optional(:company_memorandum_of_association) => identity_business_details_documents_company_memorandum_of_association() | nil, optional(:company_ministerial_decree) => identity_business_details_documents_company_ministerial_decree() | nil, optional(:company_registration_verification) => identity_business_details_documents_company_registration_verification() | nil, optional(:company_tax_id_verification) => identity_business_details_documents_company_tax_id_verification() | nil, optional(:primary_verification) => identity_business_details_documents_primary_verification() | nil, optional(:proof_of_address) => identity_business_details_documents_proof_of_address() | nil, optional(:proof_of_registration) => identity_business_details_documents_proof_of_registration() | nil, optional(:proof_of_ultimate_beneficial_ownership) => identity_business_details_documents_proof_of_ultimate_beneficial_ownership() | nil, optional(String.t()) => term() }
bank_account_ownership_verification- One or more documents that support the bank account ownership verification requirement. Must be a document associated with the account’s primary active bank account that displays the last 4 digits of the account number, either a statement or a check.company_license- One or more documents that demonstrate proof of a company’s license to operate.company_memorandum_of_association- One or more documents showing the company’s Memorandum of Association.company_ministerial_decree- Certain countries only: One or more documents showing the ministerial decree legalizing the company’s establishment.company_registration_verification- One or more documents that demonstrate proof of a company’s registration with the appropriate local authorities.company_tax_id_verification- One or more documents that demonstrate proof of a company’s tax ID.primary_verification- A document verifying the business.proof_of_address- One or more documents that demonstrate proof of address.proof_of_registration- One or more documents showing the company’s proof of registration with the national business registry.proof_of_ultimate_beneficial_ownership- One or more documents that demonstrate proof of ultimate beneficial ownership.
@type identity_business_details_documents_bank_account_ownership_verification() :: %{ optional(:files) => [String.t()] | nil, optional(:type) => String.t() | nil, optional(String.t()) => term() }
files- One or more document IDs returned by a file upload with a purpose value ofaccount_requirement.type- The format of the document. Currently supportsfilesonly. Possible values:files.
@type identity_business_details_documents_company_license() :: %{ optional(:files) => [String.t()] | nil, optional(:type) => String.t() | nil, optional(String.t()) => term() }
files- One or more document IDs returned by a file upload with a purpose value ofaccount_requirement.type- The format of the document. Currently supportsfilesonly. Possible values:files.
@type identity_business_details_documents_company_memorandum_of_association() :: %{ optional(:files) => [String.t()] | nil, optional(:type) => String.t() | nil, optional(String.t()) => term() }
files- One or more document IDs returned by a file upload with a purpose value ofaccount_requirement.type- The format of the document. Currently supportsfilesonly. Possible values:files.
@type identity_business_details_documents_company_ministerial_decree() :: %{ optional(:files) => [String.t()] | nil, optional(:type) => String.t() | nil, optional(String.t()) => term() }
files- One or more document IDs returned by a file upload with a purpose value ofaccount_requirement.type- The format of the document. Currently supportsfilesonly. Possible values:files.
@type identity_business_details_documents_company_registration_verification() :: %{ optional(:files) => [String.t()] | nil, optional(:type) => String.t() | nil, optional(String.t()) => term() }
files- One or more document IDs returned by a file upload with a purpose value ofaccount_requirement.type- The format of the document. Currently supportsfilesonly. Possible values:files.
@type identity_business_details_documents_company_tax_id_verification() :: %{ optional(:files) => [String.t()] | nil, optional(:type) => String.t() | nil, optional(String.t()) => term() }
files- One or more document IDs returned by a file upload with a purpose value ofaccount_requirement.type- The format of the document. Currently supportsfilesonly. Possible values:files.
@type identity_business_details_documents_primary_verification() :: %{ optional(:front_back) => identity_business_details_documents_primary_verification_front_back() | nil, optional(:type) => String.t() | nil, optional(String.t()) => term() }
front_back- The file upload tokens referring to each side of the document.type- The format of the verification document. Currently supportsfront_backonly. Possible values:front_back.
@type identity_business_details_documents_primary_verification_front_back() :: %{ optional(:back) => String.t() | nil, optional(:front) => String.t() | nil, optional(String.t()) => term() }
back- A file upload token representing the back of the verification document. The purpose of the uploaded file should be 'identity_document'. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.front- A file upload token representing the front of the verification document. The purpose of the uploaded file should be 'identity_document'. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.
@type identity_business_details_documents_proof_of_address() :: %{ optional(:files) => [String.t()] | nil, optional(:type) => String.t() | nil, optional(String.t()) => term() }
files- One or more document IDs returned by a file upload with a purpose value ofaccount_requirement.type- The format of the document. Currently supportsfilesonly. Possible values:files.
@type identity_business_details_documents_proof_of_registration() :: %{ optional(:files) => [String.t()] | nil, optional(:type) => String.t() | nil, optional(String.t()) => term() }
files- One or more document IDs returned by a file upload with a purpose value ofaccount_requirement.type- The format of the document. Currently supportsfilesonly. Possible values:files.
@type identity_business_details_documents_proof_of_ultimate_beneficial_ownership() :: %{ optional(:files) => [String.t()] | nil, optional(:type) => String.t() | nil, optional(String.t()) => term() }
files- One or more document IDs returned by a file upload with a purpose value ofaccount_requirement.type- The format of the document. Currently supportsfilesonly. Possible values:files.
@type identity_business_details_id_numbers() :: %{ optional(:registrar) => String.t() | nil, optional(:type) => String.t() | nil, optional(:value) => String.t() | nil, optional(String.t()) => term() }
registrar- The registrar of the ID number (Only valid for DE ID number types).type- Open Enum. The ID number type of a business entity. Possible values:ae_crn,ae_vat,ao_nif,ar_cuit,at_fn,at_stn,at_vat,au_abn,au_acn,au_in,az_tin,bd_etin,be_cbe,be_vat,bg_uic,bg_vat,br_cnpj,ca_cn,ca_crarr,ca_gst_hst,ca_neq,ca_rid,ch_chid,ch_uid,cr_cpj,cr_nite,cy_he,cy_tic,cy_vat,cz_ico,cz_vat,de_hrn,de_stn,de_vat,dk_cvr,dk_vat,do_rcn,ee_rk,ee_vat,es_cif,es_vat,fi_vat,fi_yt,fr_rna,fr_siren,fr_vat,gb_crn,gb_vat,gi_crn,gr_afm,gr_gemi,gr_vat,gt_nit,hk_br,hk_cr,hr_mbs,hr_oib,hr_vat,hu_cjs,hu_tin,hu_vat,ie_crn,ie_trn,ie_vat,it_rea,it_vat,jp_cn,kz_bin,li_uid,lt_ccrn,lt_vat,lu_nif,lu_rcs,lu_vat,lv_urn,lv_vat,mt_crn,mt_tin,mt_vat,mx_rfc,my_brn,my_coid,my_itn,my_sst,mz_nuit,nl_kvk,nl_rsin,nl_vat,no_orgnr,nz_bn,nz_ird,pe_ruc,pk_ntn,pl_nip,pl_regon,pl_vat,pt_vat,ro_cui,ro_orc,ro_vat,sa_crn,sa_tin,se_orgnr,se_vat,sg_uen,si_msp,si_tin,si_vat,sk_dic,sk_ico,sk_vat,th_crn,th_prn,th_tin,us_ein.value- The value of the ID number.
@type identity_business_details_monthly_estimated_revenue() :: %{ optional(:amount) => identity_business_details_monthly_estimated_revenue_amount() | nil, optional(String.t()) => term() }
amount- A non-negative integer representing the amount in the smallest currency unit.
@type identity_business_details_monthly_estimated_revenue_amount() :: %{ optional(:currency) => String.t() | nil, optional(:value) => integer() | nil, optional(String.t()) => term() }
currency- Three-letter ISO currency code, in lowercase. Must be a supported currency.value- A non-negative integer representing how much to charge in the smallest currency unit.
@type identity_business_details_registration_date() :: %{ optional(:day) => integer() | nil, optional(:month) => integer() | nil, optional(:year) => integer() | nil, optional(String.t()) => term() }
day- The day of registration, between 1 and 31.month- The month of registration, between 1 and 12.year- The four-digit year of registration.
@type identity_business_details_script_addresses() :: %{ optional(:kana) => identity_business_details_script_addresses_kana() | nil, optional(:kanji) => identity_business_details_script_addresses_kanji() | nil, optional(String.t()) => term() }
kana- Kana Address.kanji- Kanji Address.
@type identity_business_details_script_addresses_kana() :: %{ optional(:city) => String.t() | nil, optional(:country) => String.t() | nil, optional(:line1) => String.t() | nil, optional(:line2) => String.t() | nil, optional(:postal_code) => String.t() | nil, optional(:state) => String.t() | nil, optional(:town) => String.t() | nil, optional(String.t()) => term() }
city- City, district, suburb, town, or village.country- Two-letter country code (ISO 3166-1 alpha-2).line1- Address line 1 (e.g., street, PO Box, or company name).line2- Address line 2 (e.g., apartment, suite, unit, or building).postal_code- ZIP or postal code.state- State, county, province, or region.town- Town or district.
@type identity_business_details_script_addresses_kanji() :: %{ optional(:city) => String.t() | nil, optional(:country) => String.t() | nil, optional(:line1) => String.t() | nil, optional(:line2) => String.t() | nil, optional(:postal_code) => String.t() | nil, optional(:state) => String.t() | nil, optional(:town) => String.t() | nil, optional(String.t()) => term() }
city- City, district, suburb, town, or village.country- Two-letter country code (ISO 3166-1 alpha-2).line1- Address line 1 (e.g., street, PO Box, or company name).line2- Address line 2 (e.g., apartment, suite, unit, or building).postal_code- ZIP or postal code.state- State, county, province, or region.town- Town or district.
@type identity_business_details_script_names() :: %{ optional(:kana) => identity_business_details_script_names_kana() | nil, optional(:kanji) => identity_business_details_script_names_kanji() | nil, optional(String.t()) => term() }
kana- Kana name.kanji- Kanji name.
@type identity_business_details_script_names_kana() :: %{ optional(:registered_name) => String.t() | nil, optional(String.t()) => term() }
registered_name- Registered name of the business.
@type identity_business_details_script_names_kanji() :: %{ optional(:registered_name) => String.t() | nil, optional(String.t()) => term() }
registered_name- Registered name of the business.
@type identity_individual() :: %{ optional(:additional_addresses) => [identity_individual_additional_addresses()] | nil, optional(:additional_names) => [identity_individual_additional_names()] | nil, optional(:address) => identity_individual_address() | nil, optional(:date_of_birth) => identity_individual_date_of_birth() | nil, optional(:documents) => identity_individual_documents() | nil, optional(:email) => String.t() | nil, optional(:given_name) => String.t() | nil, optional(:id_numbers) => [identity_individual_id_numbers()] | nil, optional(:legal_gender) => String.t() | nil, optional(:metadata) => %{required(String.t()) => String.t()} | nil, optional(:nationalities) => [String.t()] | nil, optional(:phone) => String.t() | nil, optional(:political_exposure) => String.t() | nil, optional(:relationship) => identity_individual_relationship() | nil, optional(:script_addresses) => identity_individual_script_addresses() | nil, optional(:script_names) => identity_individual_script_names() | nil, optional(:surname) => String.t() | nil, optional(String.t()) => term() }
additional_addresses- Additional addresses associated with the individual.additional_names- Additional names (e.g. aliases) associated with the individual.address- The individual's residential address.date_of_birth- The individual's date of birth.documents- Documents that may be submitted to satisfy various informational requests.email- The individual's email address.given_name- The individual's first name.id_numbers- The identification numbers (e.g., SSN) associated with the individual.legal_gender- The individual's gender (International regulations require either "male" or "female"). Possible values:female,male.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.nationalities- The countries where the individual is a national. Two-letter country code (ISO 3166-1 alpha-2).phone- The individual's phone number.political_exposure- The individual's political exposure. Possible values:existing,none.relationship- The relationship that this individual has with the account's identity.script_addresses- The script addresses (e.g., non-Latin characters) associated with the individual.script_names- The individuals primary name in non latin script.surname- The individual's last name.
@type identity_individual_additional_addresses() :: %{ optional(:city) => String.t() | nil, optional(:country) => String.t() | nil, optional(:line1) => String.t() | nil, optional(:line2) => String.t() | nil, optional(:postal_code) => String.t() | nil, optional(:purpose) => String.t() | nil, optional(:state) => String.t() | nil, optional(:town) => String.t() | nil, optional(String.t()) => term() }
city- City, district, suburb, town, or village.country- Two-letter country code (ISO 3166-1 alpha-2).line1- Address line 1 (e.g., street, PO Box, or company name).line2- Address line 2 (e.g., apartment, suite, unit, or building).postal_code- ZIP or postal code.purpose- Purpose of additional address. Possible values:registered.state- State, county, province, or region.town- Town or district.
@type identity_individual_additional_names() :: %{ optional(:full_name) => String.t() | nil, optional(:given_name) => String.t() | nil, optional(:purpose) => String.t() | nil, optional(:surname) => String.t() | nil, optional(String.t()) => term() }
full_name- The person's full name.given_name- The person's first or given name.purpose- The purpose or type of the additional name. Possible values:alias,maiden.surname- The person's last or family name.
@type identity_individual_address() :: %{ optional(:city) => String.t() | nil, optional(:country) => String.t() | nil, optional(:line1) => String.t() | nil, optional(:line2) => String.t() | nil, optional(:postal_code) => String.t() | nil, optional(:state) => String.t() | nil, optional(:town) => String.t() | nil, optional(String.t()) => term() }
city- City, district, suburb, town, or village.country- Two-letter country code (ISO 3166-1 alpha-2).line1- Address line 1 (e.g., street, PO Box, or company name).line2- Address line 2 (e.g., apartment, suite, unit, or building).postal_code- ZIP or postal code.state- State, county, province, or region.town- Town or district.
@type identity_individual_date_of_birth() :: %{ optional(:day) => integer() | nil, optional(:month) => integer() | nil, optional(:year) => integer() | nil, optional(String.t()) => term() }
day- The day of birth.month- The month of birth.year- The year of birth.
@type identity_individual_documents() :: %{ optional(:company_authorization) => identity_individual_documents_company_authorization() | nil, optional(:passport) => identity_individual_documents_passport() | nil, optional(:primary_verification) => identity_individual_documents_primary_verification() | nil, optional(:secondary_verification) => identity_individual_documents_secondary_verification() | nil, optional(:visa) => identity_individual_documents_visa() | nil, optional(String.t()) => term() }
company_authorization- One or more documents that demonstrate proof that this person is authorized to represent the company.passport- One or more documents showing the person’s passport page with photo and personal data.primary_verification- An identifying document showing the person's name, either a passport or local ID card.secondary_verification- A document showing address, either a passport, local ID card, or utility bill from a well-known utility company.visa- One or more documents showing the person’s visa required for living in the country where they are residing.
@type identity_individual_documents_company_authorization() :: %{ optional(:files) => [String.t()] | nil, optional(:type) => String.t() | nil, optional(String.t()) => term() }
files- One or more document IDs returned by a file upload with a purpose value ofaccount_requirement.type- The format of the document. Currently supportsfilesonly. Possible values:files.
@type identity_individual_documents_passport() :: %{ optional(:files) => [String.t()] | nil, optional(:type) => String.t() | nil, optional(String.t()) => term() }
files- One or more document IDs returned by a file upload with a purpose value ofaccount_requirement.type- The format of the document. Currently supportsfilesonly. Possible values:files.
@type identity_individual_documents_primary_verification() :: %{ optional(:front_back) => identity_individual_documents_primary_verification_front_back() | nil, optional(:type) => String.t() | nil, optional(String.t()) => term() }
front_back- The file upload tokens referring to each side of the document.type- The format of the verification document. Currently supportsfront_backonly. Possible values:front_back.
@type identity_individual_documents_primary_verification_front_back() :: %{ optional(:back) => String.t() | nil, optional(:front) => String.t() | nil, optional(String.t()) => term() }
back- A file upload token representing the back of the verification document. The purpose of the uploaded file should be 'identity_document'. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.front- A file upload token representing the front of the verification document. The purpose of the uploaded file should be 'identity_document'. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.
@type identity_individual_documents_secondary_verification() :: %{ optional(:front_back) => identity_individual_documents_secondary_verification_front_back() | nil, optional(:type) => String.t() | nil, optional(String.t()) => term() }
front_back- The file upload tokens referring to each side of the document.type- The format of the verification document. Currently supportsfront_backonly. Possible values:front_back.
@type identity_individual_documents_secondary_verification_front_back() :: %{ optional(:back) => String.t() | nil, optional(:front) => String.t() | nil, optional(String.t()) => term() }
back- A file upload token representing the back of the verification document. The purpose of the uploaded file should be 'identity_document'. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.front- A file upload token representing the front of the verification document. The purpose of the uploaded file should be 'identity_document'. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.
@type identity_individual_documents_visa() :: %{ optional(:files) => [String.t()] | nil, optional(:type) => String.t() | nil, optional(String.t()) => term() }
files- One or more document IDs returned by a file upload with a purpose value ofaccount_requirement.type- The format of the document. Currently supportsfilesonly. Possible values:files.
@type identity_individual_id_numbers() :: %{ optional(:type) => String.t() | nil, optional(:value) => String.t() | nil, optional(String.t()) => term() }
type- The ID number type of an individual. Possible values:ae_eid,ao_nif,ar_cuil,ar_dni,at_stn,az_tin,bd_brc,bd_etin,bd_nid,be_nrn,bg_ucn,bn_nric,br_cpf,ca_sin,ch_oasi,cl_rut,cn_pp,co_nuip,cr_ci,cr_cpf,cr_dimex,cr_nite,cy_tic,cz_rc,de_stn,dk_cpr,do_cie,do_rcn,ec_ci,ee_ik,es_nif,fi_hetu,fr_nir,gb_nino,gr_afm,gt_nit,hk_id,hr_oib,hu_ad,id_nik,ie_ppsn,is_kt,it_cf,jp_inc,ke_pin,kz_iin,li_peid,lt_ak,lu_nif,lv_pk,mx_rfc,my_nric,mz_nuit,ng_nin,nl_bsn,no_nin,nz_ird,pe_dni,pk_cnic,pk_snic,pl_pesel,pt_nif,ro_cnp,sa_tin,se_pin,sg_fin,sg_nric,sk_dic,th_lc,th_pin,tr_tin,us_itin,us_itin_last_4,us_ssn,us_ssn_last_4,uy_dni,za_id.value- The value of the ID number.
@type identity_individual_relationship() :: %{ optional(:director) => boolean() | nil, optional(:executive) => boolean() | nil, optional(:owner) => boolean() | nil, optional(:percent_ownership) => String.t() | nil, optional(:title) => String.t() | nil, optional(String.t()) => term() }
director- Whether the person is a director of the account's identity. Directors are typically members of the governing board of the company, or responsible for ensuring the company meets its regulatory obligations.executive- Whether the person has significant responsibility to control, manage, or direct the organization.owner- Whether the person is an owner of the account’s identity.percent_ownership- The percent owned by the person of the account's legal entity. Format: decimal string.title- The person's title (e.g., CEO, Support Engineer).
@type identity_individual_script_addresses() :: %{ optional(:kana) => identity_individual_script_addresses_kana() | nil, optional(:kanji) => identity_individual_script_addresses_kanji() | nil, optional(String.t()) => term() }
kana- Kana Address.kanji- Kanji Address.
@type identity_individual_script_addresses_kana() :: %{ optional(:city) => String.t() | nil, optional(:country) => String.t() | nil, optional(:line1) => String.t() | nil, optional(:line2) => String.t() | nil, optional(:postal_code) => String.t() | nil, optional(:state) => String.t() | nil, optional(:town) => String.t() | nil, optional(String.t()) => term() }
city- City, district, suburb, town, or village.country- Two-letter country code (ISO 3166-1 alpha-2).line1- Address line 1 (e.g., street, PO Box, or company name).line2- Address line 2 (e.g., apartment, suite, unit, or building).postal_code- ZIP or postal code.state- State, county, province, or region.town- Town or district.
@type identity_individual_script_addresses_kanji() :: %{ optional(:city) => String.t() | nil, optional(:country) => String.t() | nil, optional(:line1) => String.t() | nil, optional(:line2) => String.t() | nil, optional(:postal_code) => String.t() | nil, optional(:state) => String.t() | nil, optional(:town) => String.t() | nil, optional(String.t()) => term() }
city- City, district, suburb, town, or village.country- Two-letter country code (ISO 3166-1 alpha-2).line1- Address line 1 (e.g., street, PO Box, or company name).line2- Address line 2 (e.g., apartment, suite, unit, or building).postal_code- ZIP or postal code.state- State, county, province, or region.town- Town or district.
@type identity_individual_script_names() :: %{ optional(:kana) => identity_individual_script_names_kana() | nil, optional(:kanji) => identity_individual_script_names_kanji() | nil, optional(String.t()) => term() }
kana- Persons name in kana script.kanji- Persons name in kanji script.
@type identity_individual_script_names_kana() :: %{ optional(:given_name) => String.t() | nil, optional(:surname) => String.t() | nil, optional(String.t()) => term() }
given_name- The person's first or given name.surname- The person's last or family name.
@type identity_individual_script_names_kanji() :: %{ optional(:given_name) => String.t() | nil, optional(:surname) => String.t() | nil, optional(String.t()) => term() }
given_name- The person's first or given name.surname- The person's last or family name.
@type t() :: %Stripe.Params.V2.Core.AccountCreateParams{ account_token: String.t() | nil, configuration: configuration() | nil, contact_email: String.t() | nil, contact_phone: String.t() | nil, dashboard: String.t() | nil, defaults: defaults() | nil, display_name: String.t() | nil, identity: identity() | nil, include: [String.t()] | nil, metadata: %{required(String.t()) => String.t()} | nil }
account_token- The account token generated by the account token api.configuration- An Account Configuration which allows the Account to take on a key persona across Stripe products.contact_email- The default contact email address for the Account. Required when configuring the account as a merchant or recipient.contact_phone- The default contact phone for the Account.dashboard- A value indicating the Stripe dashboard this Account has access to. This will depend on which configurations are enabled for this account. Possible values:express,full,none.defaults- Default values to be used on Account Configurations.display_name- A descriptive name for the Account. This name will be surfaced in the Stripe Dashboard and on any invoices sent to the Account.identity- Information about the company, individual, and business represented by the Account.include- Additional fields to include in the response.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.