# File generated from our OpenAPI spec defmodule Stripe.Params.PaymentMethodCreateParams do @moduledoc "Parameters for payment method create." @typedoc """ * `acss_debit` - If this is an `acss_debit` PaymentMethod, this hash contains details about the ACSS Debit payment method. * `affirm` - If this is an `affirm` PaymentMethod, this hash contains details about the Affirm payment method. * `afterpay_clearpay` - If this is an `AfterpayClearpay` PaymentMethod, this hash contains details about the AfterpayClearpay payment method. * `alipay` - If this is an `Alipay` PaymentMethod, this hash contains details about the Alipay payment method. * `allow_redisplay` - 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`. Possible values: `always`, `limited`, `unspecified`. * `alma` - If this is a Alma PaymentMethod, this hash contains details about the Alma payment method. * `amazon_pay` - If this is a AmazonPay PaymentMethod, this hash contains details about the AmazonPay payment method. * `au_becs_debit` - If this is an `au_becs_debit` PaymentMethod, this hash contains details about the bank account. * `bacs_debit` - If this is a `bacs_debit` PaymentMethod, this hash contains details about the Bacs Direct Debit bank account. * `bancontact` - If this is a `bancontact` PaymentMethod, this hash contains details about the Bancontact payment method. * `billie` - If this is a `billie` PaymentMethod, this hash contains details about the Billie payment method. * `billing_details` - Billing information associated with the PaymentMethod that may be used or required by particular types of payment methods. * `blik` - If this is a `blik` PaymentMethod, this hash contains details about the BLIK payment method. * `boleto` - If this is a `boleto` PaymentMethod, this hash contains details about the Boleto payment method. * `card` - If this is a `card` PaymentMethod, this hash contains the user's card details. For backwards compatibility, you can alternatively provide a Stripe token (e.g., for Apple Pay, Amex Express Checkout, or legacy Checkout) into the card hash with format `card: {token: "tok_visa"}`. When providing a card number, you must meet the requirements for [PCI compliance](https://stripe.com/docs/security#validating-pci-compliance). We strongly recommend using Stripe.js instead of interacting with this API directly. * `cashapp` - If this is a `cashapp` PaymentMethod, this hash contains details about the Cash App Pay payment method. * `crypto` - If this is a Crypto PaymentMethod, this hash contains details about the Crypto payment method. * `custom` - If this is a `custom` PaymentMethod, this hash contains details about the Custom payment method. * `customer` - The `Customer` to whom the original PaymentMethod is attached. Max length: 5000. * `customer_balance` - If this is a `customer_balance` PaymentMethod, this hash contains details about the CustomerBalance payment method. * `eps` - If this is an `eps` PaymentMethod, this hash contains details about the EPS payment method. * `expand` - Specifies which fields in the response should be expanded. * `fpx` - If this is an `fpx` PaymentMethod, this hash contains details about the FPX payment method. * `giropay` - If this is a `giropay` PaymentMethod, this hash contains details about the Giropay payment method. * `grabpay` - If this is a `grabpay` PaymentMethod, this hash contains details about the GrabPay payment method. * `ideal` - If this is an `ideal` PaymentMethod, this hash contains details about the iDEAL payment method. * `interac_present` - If this is an `interac_present` PaymentMethod, this hash contains details about the Interac Present payment method. * `kakao_pay` - If this is a `kakao_pay` PaymentMethod, this hash contains details about the Kakao Pay payment method. * `klarna` - If this is a `klarna` PaymentMethod, this hash contains details about the Klarna payment method. * `konbini` - If this is a `konbini` PaymentMethod, this hash contains details about the Konbini payment method. * `kr_card` - If this is a `kr_card` PaymentMethod, this hash contains details about the Korean Card payment method. * `link` - If this is an `Link` PaymentMethod, this hash contains details about the Link payment method. * `mb_way` - If this is a MB WAY PaymentMethod, this hash contains details about the MB WAY payment method. * `metadata` - Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. * `mobilepay` - If this is a `mobilepay` PaymentMethod, this hash contains details about the MobilePay payment method. * `multibanco` - If this is a `multibanco` PaymentMethod, this hash contains details about the Multibanco payment method. * `naver_pay` - If this is a `naver_pay` PaymentMethod, this hash contains details about the Naver Pay payment method. * `nz_bank_account` - If this is an nz_bank_account PaymentMethod, this hash contains details about the nz_bank_account payment method. * `oxxo` - If this is an `oxxo` PaymentMethod, this hash contains details about the OXXO payment method. * `p24` - If this is a `p24` PaymentMethod, this hash contains details about the P24 payment method. * `pay_by_bank` - If this is a `pay_by_bank` PaymentMethod, this hash contains details about the PayByBank payment method. * `payco` - If this is a `payco` PaymentMethod, this hash contains details about the PAYCO payment method. * `payment_method` - The PaymentMethod to share. Max length: 5000. * `paynow` - If this is a `paynow` PaymentMethod, this hash contains details about the PayNow payment method. * `paypal` - If this is a `paypal` PaymentMethod, this hash contains details about the PayPal payment method. * `payto` - If this is a `payto` PaymentMethod, this hash contains details about the PayTo payment method. * `pix` - If this is a `pix` PaymentMethod, this hash contains details about the Pix payment method. * `promptpay` - If this is a `promptpay` PaymentMethod, this hash contains details about the PromptPay payment method. * `radar_options` - Options to configure Radar. See [Radar Session](https://docs.stripe.com/radar/radar-session) for more information. * `revolut_pay` - If this is a `revolut_pay` PaymentMethod, this hash contains details about the Revolut Pay payment method. * `samsung_pay` - If this is a `samsung_pay` PaymentMethod, this hash contains details about the SamsungPay payment method. * `satispay` - If this is a `satispay` PaymentMethod, this hash contains details about the Satispay payment method. * `sepa_debit` - If this is a `sepa_debit` PaymentMethod, this hash contains details about the SEPA debit bank account. * `sofort` - If this is a `sofort` PaymentMethod, this hash contains details about the SOFORT payment method. * `swish` - If this is a `swish` PaymentMethod, this hash contains details about the Swish payment method. * `twint` - If this is a TWINT PaymentMethod, this hash contains details about the TWINT payment method. * `type` - The type of the PaymentMethod. An additional hash is included on the PaymentMethod with a name matching this value. It contains additional information specific to the PaymentMethod type. Possible values: `acss_debit`, `affirm`, `afterpay_clearpay`, `alipay`, `alma`, `amazon_pay`, `au_becs_debit`, `bacs_debit`, `bancontact`, `billie`, `blik`, `boleto`, `card`, `cashapp`, `crypto`, `custom`, `customer_balance`, `eps`, `fpx`, `giropay`, `grabpay`, `ideal`, `kakao_pay`, `klarna`, `konbini`, `kr_card`, `link`, `mb_way`, `mobilepay`, `multibanco`, `naver_pay`, `nz_bank_account`, `oxxo`, `p24`, `pay_by_bank`, `payco`, `paynow`, `paypal`, `payto`, `pix`, `promptpay`, `revolut_pay`, `samsung_pay`, `satispay`, `sepa_debit`, `sofort`, `swish`, `twint`, `us_bank_account`, `wechat_pay`, `zip`. * `us_bank_account` - If this is an `us_bank_account` PaymentMethod, this hash contains details about the US bank account payment method. * `wechat_pay` - If this is an `wechat_pay` PaymentMethod, this hash contains details about the wechat_pay payment method. * `zip` - If this is a `zip` PaymentMethod, this hash contains details about the Zip payment method. """ @type t :: %__MODULE__{ acss_debit: acss_debit() | nil, affirm: map() | nil, afterpay_clearpay: map() | nil, alipay: map() | nil, allow_redisplay: String.t() | nil, alma: map() | nil, amazon_pay: map() | nil, au_becs_debit: au_becs_debit() | nil, bacs_debit: bacs_debit() | nil, bancontact: map() | nil, billie: map() | nil, billing_details: billing_details() | nil, blik: map() | nil, boleto: boleto() | nil, card: map() | nil, cashapp: map() | nil, crypto: map() | nil, custom: custom() | nil, customer: String.t() | nil, customer_balance: map() | nil, eps: eps() | nil, expand: [String.t()] | nil, fpx: fpx() | nil, giropay: map() | nil, grabpay: map() | nil, ideal: ideal() | nil, interac_present: map() | nil, kakao_pay: map() | nil, klarna: klarna() | nil, konbini: map() | nil, kr_card: map() | nil, link: map() | nil, mb_way: map() | nil, metadata: %{String.t() => String.t()} | nil, mobilepay: map() | nil, multibanco: map() | nil, naver_pay: naver_pay() | nil, nz_bank_account: nz_bank_account() | nil, oxxo: map() | nil, p24: p24() | nil, pay_by_bank: map() | nil, payco: map() | nil, payment_method: String.t() | nil, paynow: map() | nil, paypal: map() | nil, payto: payto() | nil, pix: map() | nil, promptpay: map() | nil, radar_options: radar_options() | nil, revolut_pay: map() | nil, samsung_pay: map() | nil, satispay: map() | nil, sepa_debit: sepa_debit() | nil, sofort: sofort() | nil, swish: map() | nil, twint: map() | nil, type: String.t() | nil, us_bank_account: us_bank_account() | nil, wechat_pay: map() | nil, zip: map() | nil } defstruct [ :acss_debit, :affirm, :afterpay_clearpay, :alipay, :allow_redisplay, :alma, :amazon_pay, :au_becs_debit, :bacs_debit, :bancontact, :billie, :billing_details, :blik, :boleto, :card, :cashapp, :crypto, :custom, :customer, :customer_balance, :eps, :expand, :fpx, :giropay, :grabpay, :ideal, :interac_present, :kakao_pay, :klarna, :konbini, :kr_card, :link, :mb_way, :metadata, :mobilepay, :multibanco, :naver_pay, :nz_bank_account, :oxxo, :p24, :pay_by_bank, :payco, :payment_method, :paynow, :paypal, :payto, :pix, :promptpay, :radar_options, :revolut_pay, :samsung_pay, :satispay, :sepa_debit, :sofort, :swish, :twint, :type, :us_bank_account, :wechat_pay, :zip ] @typedoc """ * `account_number` - Customer's bank account number. Max length: 5000. * `institution_number` - Institution number of the customer's bank. Max length: 5000. * `transit_number` - Transit number of the customer's bank. Max length: 5000. """ @type acss_debit :: %{ optional(:account_number) => String.t() | nil, optional(:institution_number) => String.t() | nil, optional(:transit_number) => String.t() | nil, optional(String.t()) => term() } @typedoc """ * `account_number` - The account number for the bank account. Max length: 5000. * `bsb_number` - Bank-State-Branch number of the bank account. Max length: 5000. """ @type au_becs_debit :: %{ optional(:account_number) => String.t() | nil, optional(:bsb_number) => String.t() | nil, optional(String.t()) => term() } @typedoc """ * `account_number` - Account number of the bank account that the funds will be debited from. Max length: 5000. * `sort_code` - Sort code of the bank account. (e.g., `10-20-30`) Max length: 5000. """ @type bacs_debit :: %{ optional(:account_number) => String.t() | nil, optional(:sort_code) => String.t() | nil, optional(String.t()) => term() } @typedoc """ * `address` - Billing address. * `email` - Email address. * `name` - Full name. * `phone` - Billing phone number (including extension). * `tax_id` - Taxpayer identification number. Used only for transactions between LATAM buyers and non-LATAM sellers. Max length: 5000. """ @type billing_details :: %{ optional(:address) => map() | nil, optional(:email) => map() | nil, optional(:name) => map() | nil, optional(:phone) => map() | nil, optional(:tax_id) => String.t() | nil, optional(String.t()) => term() } @typedoc """ * `tax_id` - The tax ID of the customer (CPF for individual consumers or CNPJ for businesses consumers) Max length: 5000. """ @type boleto :: %{ optional(:tax_id) => String.t() | nil, optional(String.t()) => term() } @typedoc """ * `type` - ID of the Dashboard-only CustomPaymentMethodType. This field is used by Stripe products' internal code to support CPMs. Max length: 5000. """ @type custom :: %{ optional(:type) => String.t() | nil, optional(String.t()) => term() } @typedoc """ * `bank` - The customer's bank. Possible values: `arzte_und_apotheker_bank`, `austrian_anadi_bank_ag`, `bank_austria`, `bankhaus_carl_spangler`, `bankhaus_schelhammer_und_schattera_ag`, `bawag_psk_ag`, `bks_bank_ag`, `brull_kallmus_bank_ag`, `btv_vier_lander_bank`, `capital_bank_grawe_gruppe_ag`, `deutsche_bank_ag`, `dolomitenbank`, `easybank_ag`, `erste_bank_und_sparkassen`, `hypo_alpeadriabank_international_ag`, `hypo_bank_burgenland_aktiengesellschaft`, `hypo_noe_lb_fur_niederosterreich_u_wien`, `hypo_oberosterreich_salzburg_steiermark`, `hypo_tirol_bank_ag`, `hypo_vorarlberg_bank_ag`, `marchfelder_bank`, `oberbank_ag`, `raiffeisen_bankengruppe_osterreich`, `schoellerbank_ag`, `sparda_bank_wien`, `volksbank_gruppe`, `volkskreditbank_ag`, `vr_bank_braunau`. Max length: 5000. """ @type eps :: %{ optional(:bank) => String.t() | nil, optional(String.t()) => term() } @typedoc """ * `account_holder_type` - Account holder type for FPX transaction Possible values: `company`, `individual`. Max length: 5000. * `bank` - The customer's bank. Possible values: `affin_bank`, `agrobank`, `alliance_bank`, `ambank`, `bank_islam`, `bank_muamalat`, `bank_of_china`, `bank_rakyat`, `bsn`, `cimb`, `deutsche_bank`, `hong_leong_bank`, `hsbc`, `kfh`, `maybank2e`, `maybank2u`, `ocbc`, `pb_enterprise`, `public_bank`, `rhb`, `standard_chartered`, `uob`. Max length: 5000. """ @type fpx :: %{ optional(:account_holder_type) => String.t() | nil, optional(:bank) => String.t() | nil, optional(String.t()) => term() } @typedoc """ * `bank` - The customer's bank. Only use this parameter for existing customers. Don't use it for new customers. Possible values: `abn_amro`, `adyen`, `asn_bank`, `bunq`, `buut`, `finom`, `handelsbanken`, `ing`, `knab`, `mollie`, `moneyou`, `n26`, `nn`, `rabobank`, `regiobank`, `revolut`, `sns_bank`, `triodos_bank`, `van_lanschot`, `yoursafe`. Max length: 5000. """ @type ideal :: %{ optional(:bank) => String.t() | nil, optional(String.t()) => term() } @typedoc """ * `dob` - Customer's date of birth """ @type klarna :: %{ optional(:dob) => klarna_dob() | nil, optional(String.t()) => term() } @typedoc """ * `day` - The day of birth, between 1 and 31. * `month` - The month of birth, between 1 and 12. * `year` - The four-digit year of birth. """ @type klarna_dob :: %{ optional(:day) => integer() | nil, optional(:month) => integer() | nil, optional(:year) => integer() | nil, optional(String.t()) => term() } @typedoc """ * `funding` - Whether to use Naver Pay points or a card to fund this transaction. If not provided, this defaults to `card`. Possible values: `card`, `points`. """ @type naver_pay :: %{ optional(:funding) => String.t() | nil, optional(String.t()) => term() } @typedoc """ * `account_holder_name` - The name on the bank account. Only required if the account holder name is different from the name of the authorized signatory collected in the PaymentMethod’s billing details. Max length: 5000. * `account_number` - The account number for the bank account. Max length: 5000. * `bank_code` - The numeric code for the bank account's bank. Max length: 5000. * `branch_code` - The numeric code for the bank account's bank branch. Max length: 5000. * `reference` - Max length: 128. * `suffix` - The suffix of the bank account number. Max length: 5000. """ @type nz_bank_account :: %{ optional(:account_holder_name) => String.t() | nil, optional(:account_number) => String.t() | nil, optional(:bank_code) => String.t() | nil, optional(:branch_code) => String.t() | nil, optional(:reference) => String.t() | nil, optional(:suffix) => String.t() | nil, optional(String.t()) => term() } @typedoc """ * `bank` - The customer's bank. Possible values: `alior_bank`, `bank_millennium`, `bank_nowy_bfg_sa`, `bank_pekao_sa`, `banki_spbdzielcze`, `blik`, `bnp_paribas`, `boz`, `citi_handlowy`, `credit_agricole`, `envelobank`, `etransfer_pocztowy24`, `getin_bank`, `ideabank`, `ing`, `inteligo`, `mbank_mtransfer`, `nest_przelew`, `noble_pay`, `pbac_z_ipko`, `plus_bank`, `santander_przelew24`, `tmobile_usbugi_bankowe`, `toyota_bank`, `velobank`, `volkswagen_bank`. """ @type p24 :: %{ optional(:bank) => String.t() | nil, optional(String.t()) => term() } @typedoc """ * `account_number` - The account number for the bank account. Max length: 5000. * `bsb_number` - Bank-State-Branch number of the bank account. Max length: 5000. * `pay_id` - The PayID alias for the bank account. Max length: 5000. """ @type payto :: %{ optional(:account_number) => String.t() | nil, optional(:bsb_number) => String.t() | nil, optional(:pay_id) => String.t() | nil, optional(String.t()) => term() } @typedoc """ * `session` - A [Radar Session](https://docs.stripe.com/radar/radar-session) is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments. Max length: 5000. """ @type radar_options :: %{ optional(:session) => String.t() | nil, optional(String.t()) => term() } @typedoc """ * `iban` - IBAN of the bank account. Max length: 5000. """ @type sepa_debit :: %{ optional(:iban) => String.t() | nil, optional(String.t()) => term() } @typedoc """ * `country` - Two-letter ISO code representing the country the bank account is located in. Possible values: `AT`, `BE`, `DE`, `ES`, `IT`, `NL`. """ @type sofort :: %{ optional(:country) => String.t() | nil, optional(String.t()) => term() } @typedoc """ * `account_holder_type` - Account holder type: individual or company. Possible values: `company`, `individual`. * `account_number` - Account number of the bank account. Max length: 5000. * `account_type` - Account type: checkings or savings. Defaults to checking if omitted. Possible values: `checking`, `savings`. * `financial_connections_account` - The ID of a Financial Connections Account to use as a payment method. Max length: 5000. * `routing_number` - Routing number of the bank account. Max length: 5000. """ @type us_bank_account :: %{ optional(:account_holder_type) => String.t() | nil, optional(:account_number) => String.t() | nil, optional(:account_type) => String.t() | nil, optional(:financial_connections_account) => String.t() | nil, optional(:routing_number) => String.t() | nil, optional(String.t()) => term() } end