Stripe.Params.SetupIntentUpdateParams (tiger_stripe v0.3.0)

Copy Markdown View Source

Parameters for setup intent update.

Summary

Types

t()

Types

payment_method_data()

@type payment_method_data() :: %{
  optional(:acss_debit) => payment_method_data_acss_debit() | nil,
  optional(:affirm) => map() | nil,
  optional(:afterpay_clearpay) => map() | nil,
  optional(:alipay) => map() | nil,
  optional(:allow_redisplay) => String.t() | nil,
  optional(:alma) => map() | nil,
  optional(:amazon_pay) => map() | nil,
  optional(:au_becs_debit) => payment_method_data_au_becs_debit() | nil,
  optional(:bacs_debit) => payment_method_data_bacs_debit() | nil,
  optional(:bancontact) => map() | nil,
  optional(:billie) => map() | nil,
  optional(:billing_details) => payment_method_data_billing_details() | nil,
  optional(:blik) => map() | nil,
  optional(:boleto) => payment_method_data_boleto() | nil,
  optional(:cashapp) => map() | nil,
  optional(:crypto) => map() | nil,
  optional(:customer_balance) => map() | nil,
  optional(:eps) => payment_method_data_eps() | nil,
  optional(:fpx) => payment_method_data_fpx() | nil,
  optional(:giropay) => map() | nil,
  optional(:grabpay) => map() | nil,
  optional(:ideal) => payment_method_data_ideal() | nil,
  optional(:interac_present) => map() | nil,
  optional(:kakao_pay) => map() | nil,
  optional(:klarna) => payment_method_data_klarna() | nil,
  optional(:konbini) => map() | nil,
  optional(:kr_card) => map() | nil,
  optional(:link) => map() | nil,
  optional(:mb_way) => map() | nil,
  optional(:metadata) => %{required(String.t()) => String.t()} | nil,
  optional(:mobilepay) => map() | nil,
  optional(:multibanco) => map() | nil,
  optional(:naver_pay) => payment_method_data_naver_pay() | nil,
  optional(:nz_bank_account) => payment_method_data_nz_bank_account() | nil,
  optional(:oxxo) => map() | nil,
  optional(:p24) => payment_method_data_p24() | nil,
  optional(:pay_by_bank) => map() | nil,
  optional(:payco) => map() | nil,
  optional(:paynow) => map() | nil,
  optional(:paypal) => map() | nil,
  optional(:payto) => payment_method_data_payto() | nil,
  optional(:pix) => map() | nil,
  optional(:promptpay) => map() | nil,
  optional(:radar_options) => payment_method_data_radar_options() | nil,
  optional(:revolut_pay) => map() | nil,
  optional(:samsung_pay) => map() | nil,
  optional(:satispay) => map() | nil,
  optional(:sepa_debit) => payment_method_data_sepa_debit() | nil,
  optional(:sofort) => payment_method_data_sofort() | nil,
  optional(:swish) => map() | nil,
  optional(:twint) => map() | nil,
  optional(:type) => String.t() | nil,
  optional(:us_bank_account) => payment_method_data_us_bank_account() | nil,
  optional(:wechat_pay) => map() | nil,
  optional(:zip) => map() | nil,
  optional(String.t()) => term()
}
  • 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.
  • 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.
  • 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.
  • 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 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.
  • 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 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, cashapp, crypto, 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.

payment_method_data_acss_debit()

@type payment_method_data_acss_debit() :: %{
  optional(:account_number) => String.t() | nil,
  optional(:institution_number) => String.t() | nil,
  optional(:transit_number) => String.t() | nil,
  optional(String.t()) => term()
}
  • 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.

payment_method_data_au_becs_debit()

@type payment_method_data_au_becs_debit() :: %{
  optional(:account_number) => String.t() | nil,
  optional(:bsb_number) => String.t() | nil,
  optional(String.t()) => term()
}
  • 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.

payment_method_data_bacs_debit()

@type payment_method_data_bacs_debit() :: %{
  optional(:account_number) => String.t() | nil,
  optional(:sort_code) => String.t() | nil,
  optional(String.t()) => term()
}
  • 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.

payment_method_data_billing_details()

@type payment_method_data_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()
}
  • 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.

payment_method_data_boleto()

@type payment_method_data_boleto() :: %{
  optional(:tax_id) => String.t() | nil,
  optional(String.t()) => term()
}
  • tax_id - The tax ID of the customer (CPF for individual consumers or CNPJ for businesses consumers) Max length: 5000.

payment_method_data_eps()

@type payment_method_data_eps() :: %{
  optional(:bank) => String.t() | nil,
  optional(String.t()) => term()
}
  • 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.

payment_method_data_fpx()

@type payment_method_data_fpx() :: %{
  optional(:account_holder_type) => String.t() | nil,
  optional(:bank) => String.t() | nil,
  optional(String.t()) => term()
}
  • 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.

payment_method_data_ideal()

@type payment_method_data_ideal() :: %{
  optional(:bank) => String.t() | nil,
  optional(String.t()) => term()
}
  • 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.

payment_method_data_klarna()

@type payment_method_data_klarna() :: %{
  optional(:dob) => payment_method_data_klarna_dob() | nil,
  optional(String.t()) => term()
}
  • dob - Customer's date of birth

payment_method_data_klarna_dob()

@type payment_method_data_klarna_dob() :: %{
  optional(:day) => integer() | nil,
  optional(:month) => integer() | nil,
  optional(:year) => integer() | nil,
  optional(String.t()) => term()
}
  • 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.

payment_method_data_naver_pay()

@type payment_method_data_naver_pay() :: %{
  optional(:funding) => String.t() | nil,
  optional(String.t()) => term()
}
  • 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.

payment_method_data_nz_bank_account()

@type payment_method_data_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()
}
  • 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.

payment_method_data_p24()

@type payment_method_data_p24() :: %{
  optional(:bank) => String.t() | nil,
  optional(String.t()) => term()
}
  • 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.

payment_method_data_payto()

@type payment_method_data_payto() :: %{
  optional(:account_number) => String.t() | nil,
  optional(:bsb_number) => String.t() | nil,
  optional(:pay_id) => String.t() | nil,
  optional(String.t()) => term()
}
  • 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.

payment_method_data_radar_options()

@type payment_method_data_radar_options() :: %{
  optional(:session) => String.t() | nil,
  optional(String.t()) => term()
}
  • session - A 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.

payment_method_data_sepa_debit()

@type payment_method_data_sepa_debit() :: %{
  optional(:iban) => String.t() | nil,
  optional(String.t()) => term()
}
  • iban - IBAN of the bank account. Max length: 5000.

payment_method_data_sofort()

@type payment_method_data_sofort() :: %{
  optional(:country) => String.t() | nil,
  optional(String.t()) => term()
}
  • country - Two-letter ISO code representing the country the bank account is located in. Possible values: AT, BE, DE, ES, IT, NL.

payment_method_data_us_bank_account()

@type payment_method_data_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()
}
  • 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.

payment_method_options()

@type payment_method_options() :: %{
  optional(:acss_debit) => payment_method_options_acss_debit() | nil,
  optional(:amazon_pay) => map() | nil,
  optional(:bacs_debit) => payment_method_options_bacs_debit() | nil,
  optional(:card) => payment_method_options_card() | nil,
  optional(:card_present) => map() | nil,
  optional(:klarna) => payment_method_options_klarna() | nil,
  optional(:link) => payment_method_options_link() | nil,
  optional(:paypal) => payment_method_options_paypal() | nil,
  optional(:payto) => payment_method_options_payto() | nil,
  optional(:sepa_debit) => payment_method_options_sepa_debit() | nil,
  optional(:us_bank_account) => payment_method_options_us_bank_account() | nil,
  optional(String.t()) => term()
}
  • acss_debit - If this is a acss_debit SetupIntent, this sub-hash contains details about the ACSS Debit payment method options.
  • amazon_pay - If this is a amazon_pay SetupIntent, this sub-hash contains details about the AmazonPay payment method options.
  • bacs_debit - If this is a bacs_debit SetupIntent, this sub-hash contains details about the Bacs Debit payment method options.
  • card - Configuration for any card setup attempted on this SetupIntent.
  • card_present - If this is a card_present PaymentMethod, this sub-hash contains details about the card-present payment method options.
  • klarna - If this is a klarna PaymentMethod, this hash contains details about the Klarna payment method options.
  • link - If this is a link PaymentMethod, this sub-hash contains details about the Link payment method options.
  • paypal - If this is a paypal PaymentMethod, this sub-hash contains details about the PayPal payment method options.
  • payto - If this is a payto SetupIntent, this sub-hash contains details about the PayTo payment method options.
  • sepa_debit - If this is a sepa_debit SetupIntent, this sub-hash contains details about the SEPA Debit payment method options.
  • us_bank_account - If this is a us_bank_account SetupIntent, this sub-hash contains details about the US bank account payment method options.

payment_method_options_acss_debit()

@type payment_method_options_acss_debit() :: %{
  optional(:currency) => String.t() | nil,
  optional(:mandate_options) =>
    payment_method_options_acss_debit_mandate_options() | nil,
  optional(:verification_method) => String.t() | nil,
  optional(String.t()) => term()
}
  • currency - Three-letter ISO currency code, in lowercase. Must be a supported currency. Possible values: cad, usd.
  • mandate_options - Additional fields for Mandate creation
  • verification_method - Bank account verification method. Possible values: automatic, instant, microdeposits.

payment_method_options_acss_debit_mandate_options()

@type payment_method_options_acss_debit_mandate_options() :: %{
  optional(:custom_mandate_url) => map() | nil,
  optional(:default_for) => [String.t()] | nil,
  optional(:interval_description) => String.t() | nil,
  optional(:payment_schedule) => String.t() | nil,
  optional(:transaction_type) => String.t() | nil,
  optional(String.t()) => term()
}
  • custom_mandate_url - A URL for custom mandate text to render during confirmation step. The URL will be rendered with additional GET parameters payment_intent and payment_intent_client_secret when confirming a Payment Intent, or setup_intent and setup_intent_client_secret when confirming a Setup Intent.
  • default_for - List of Stripe products where this mandate can be selected automatically.
  • interval_description - Description of the mandate interval. Only required if 'payment_schedule' parameter is 'interval' or 'combined'. Max length: 500.
  • payment_schedule - Payment schedule for the mandate. Possible values: combined, interval, sporadic.
  • transaction_type - Transaction type of the mandate. Possible values: business, personal.

payment_method_options_bacs_debit()

@type payment_method_options_bacs_debit() :: %{
  optional(:mandate_options) =>
    payment_method_options_bacs_debit_mandate_options() | nil,
  optional(String.t()) => term()
}
  • mandate_options - Additional fields for Mandate creation

payment_method_options_bacs_debit_mandate_options()

@type payment_method_options_bacs_debit_mandate_options() :: %{
  optional(:reference_prefix) => map() | nil,
  optional(String.t()) => term()
}
  • reference_prefix - Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'DDIC' or 'STRIPE'.

payment_method_options_card()

@type payment_method_options_card() :: %{
  optional(:mandate_options) =>
    payment_method_options_card_mandate_options() | nil,
  optional(:moto) => boolean() | nil,
  optional(:network) => String.t() | nil,
  optional(:request_three_d_secure) => String.t() | nil,
  optional(:three_d_secure) =>
    payment_method_options_card_three_d_secure() | nil,
  optional(String.t()) => term()
}
  • mandate_options - Configuration options for setting up an eMandate for cards issued in India.
  • moto - When specified, this parameter signals that a card has been collected as MOTO (Mail Order Telephone Order) and thus out of scope for SCA. This parameter can only be provided during confirmation.
  • network - Selected network to process this SetupIntent on. Depends on the available networks of the card attached to the SetupIntent. Can be only set confirm-time. Possible values: amex, cartes_bancaires, diners, discover, eftpos_au, girocard, interac, jcb, link, mastercard, unionpay, unknown, visa. Max length: 5000.
  • request_three_d_secure - We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and other requirements. However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. If not provided, this value defaults to automatic. Read our guide on manually requesting 3D Secure for more information on how this configuration interacts with Radar and our SCA Engine. Possible values: any, automatic, challenge.
  • three_d_secure - If 3D Secure authentication was performed with a third-party provider, the authentication details to use for this setup.

payment_method_options_card_mandate_options()

@type payment_method_options_card_mandate_options() :: %{
  optional(:amount) => integer() | nil,
  optional(:amount_type) => String.t() | nil,
  optional(:currency) => String.t() | nil,
  optional(:description) => String.t() | nil,
  optional(:end_date) => integer() | nil,
  optional(:interval) => String.t() | nil,
  optional(:interval_count) => integer() | nil,
  optional(:reference) => String.t() | nil,
  optional(:start_date) => integer() | nil,
  optional(:supported_types) => [String.t()] | nil,
  optional(String.t()) => term()
}
  • amount - Amount to be charged for future payments.
  • amount_type - One of fixed or maximum. If fixed, the amount param refers to the exact amount to be charged in future payments. If maximum, the amount charged can be up to the value passed for the amount param. Possible values: fixed, maximum.
  • currency - Currency in which future payments will be charged. Three-letter ISO currency code, in lowercase. Must be a supported currency. Format: ISO 4217 currency code.
  • description - A description of the mandate or subscription that is meant to be displayed to the customer. Max length: 200.
  • end_date - End date of the mandate or subscription. If not provided, the mandate will be active until canceled. If provided, end date should be after start date. Format: Unix timestamp.
  • interval - Specifies payment frequency. One of day, week, month, year, or sporadic. Possible values: day, month, sporadic, week, year.
  • interval_count - The number of intervals between payments. For example, interval=month and interval_count=3 indicates one payment every three months. Maximum of one year interval allowed (1 year, 12 months, or 52 weeks). This parameter is optional when interval=sporadic.
  • reference - Unique identifier for the mandate or subscription. Max length: 80.
  • start_date - Start date of the mandate or subscription. Start date should not be lesser than yesterday. Format: Unix timestamp.
  • supported_types - Specifies the type of mandates supported. Possible values are india.

payment_method_options_card_three_d_secure()

@type payment_method_options_card_three_d_secure() :: %{
  optional(:ares_trans_status) => String.t() | nil,
  optional(:cryptogram) => String.t() | nil,
  optional(:electronic_commerce_indicator) => String.t() | nil,
  optional(:network_options) =>
    payment_method_options_card_three_d_secure_network_options() | nil,
  optional(:requestor_challenge_indicator) => String.t() | nil,
  optional(:transaction_id) => String.t() | nil,
  optional(:version) => String.t() | nil,
  optional(String.t()) => term()
}
  • ares_trans_status - The transStatus returned from the card Issuer’s ACS in the ARes. Possible values: A, C, I, N, R, U, Y.
  • cryptogram - The cryptogram, also known as the "authentication value" (AAV, CAVV or AEVV). This value is 20 bytes, base64-encoded into a 28-character string. (Most 3D Secure providers will return the base64-encoded version, which is what you should specify here.) Max length: 5000.
  • electronic_commerce_indicator - The Electronic Commerce Indicator (ECI) is returned by your 3D Secure provider and indicates what degree of authentication was performed. Possible values: 01, 02, 05, 06, 07.
  • network_options - Network specific 3DS fields. Network specific arguments require an explicit card brand choice. The parameter payment_method_options.card.network must be populated accordingly
  • requestor_challenge_indicator - The challenge indicator (threeDSRequestorChallengeInd) which was requested in the AReq sent to the card Issuer's ACS. A string containing 2 digits from 01-99. Max length: 2.
  • transaction_id - For 3D Secure 1, the XID. For 3D Secure 2, the Directory Server Transaction ID (dsTransID). Max length: 5000.
  • version - The version of 3D Secure that was performed. Possible values: 1.0.2, 2.1.0, 2.2.0, 2.3.0, 2.3.1.

payment_method_options_card_three_d_secure_network_options()

@type payment_method_options_card_three_d_secure_network_options() :: %{
  optional(:cartes_bancaires) =>
    payment_method_options_card_three_d_secure_network_options_cartes_bancaires()
    | nil,
  optional(String.t()) => term()
}
  • cartes_bancaires - Cartes Bancaires-specific 3DS fields.

payment_method_options_card_three_d_secure_network_options_cartes_bancaires()

@type payment_method_options_card_three_d_secure_network_options_cartes_bancaires() ::
  %{
    optional(:cb_avalgo) => String.t() | nil,
    optional(:cb_exemption) => String.t() | nil,
    optional(:cb_score) => integer() | nil,
    optional(String.t()) => term()
  }
  • cb_avalgo - The cryptogram calculation algorithm used by the card Issuer's ACS to calculate the Authentication cryptogram. Also known as cavvAlgorithm. messageExtension: CB-AVALGO Possible values: 0, 1, 2, 3, 4, A.
  • cb_exemption - The exemption indicator returned from Cartes Bancaires in the ARes. message extension: CB-EXEMPTION; string (4 characters) This is a 3 byte bitmap (low significant byte first and most significant bit first) that has been Base64 encoded Max length: 4.
  • cb_score - The risk score returned from Cartes Bancaires in the ARes. message extension: CB-SCORE; numeric value 0-99

payment_method_options_klarna()

@type payment_method_options_klarna() :: %{
  optional(:currency) => String.t() | nil,
  optional(:on_demand) => payment_method_options_klarna_on_demand() | nil,
  optional(:preferred_locale) => String.t() | nil,
  optional(:subscriptions) => map() | nil,
  optional(String.t()) => term()
}
  • currency - The currency of the SetupIntent. Three letter ISO currency code. Format: ISO 4217 currency code.
  • on_demand - On-demand details if setting up a payment method for on-demand payments.
  • preferred_locale - Preferred language of the Klarna authorization page that the customer is redirected to Possible values: cs-CZ, da-DK, de-AT, de-CH, de-DE, el-GR, en-AT, en-AU, en-BE, en-CA, en-CH, en-CZ, en-DE, en-DK, en-ES, en-FI, en-FR, en-GB, en-GR, en-IE, en-IT, en-NL, en-NO, en-NZ, en-PL, en-PT, en-RO, en-SE, en-US, es-ES, es-US, fi-FI, fr-BE, fr-CA, fr-CH, fr-FR, it-CH, it-IT, nb-NO, nl-BE, nl-NL, pl-PL, pt-PT, ro-RO, sv-FI, sv-SE.
  • subscriptions - Subscription details if setting up or charging a subscription

payment_method_options_klarna_on_demand()

@type payment_method_options_klarna_on_demand() :: %{
  optional(:average_amount) => integer() | nil,
  optional(:maximum_amount) => integer() | nil,
  optional(:minimum_amount) => integer() | nil,
  optional(:purchase_interval) => String.t() | nil,
  optional(:purchase_interval_count) => integer() | nil,
  optional(String.t()) => term()
}
  • average_amount - Your average amount value. You can use a value across your customer base, or segment based on customer type, country, etc.
  • maximum_amount - The maximum value you may charge a customer per purchase. You can use a value across your customer base, or segment based on customer type, country, etc.
  • minimum_amount - The lowest or minimum value you may charge a customer per purchase. You can use a value across your customer base, or segment based on customer type, country, etc.
  • purchase_interval - Interval at which the customer is making purchases Possible values: day, month, week, year.
  • purchase_interval_count - The number of purchase_interval between charges

payment_method_options_link()

@type payment_method_options_link() :: %{
  optional(:persistent_token) => String.t() | nil,
  optional(String.t()) => term()
}
  • persistent_token - [Deprecated] This is a legacy parameter that no longer has any function. Max length: 5000.

payment_method_options_paypal()

@type payment_method_options_paypal() :: %{
  optional(:billing_agreement_id) => String.t() | nil,
  optional(String.t()) => term()
}
  • billing_agreement_id - The PayPal Billing Agreement ID (BAID). This is an ID generated by PayPal which represents the mandate between the merchant and the customer. Max length: 5000.

payment_method_options_payto()

@type payment_method_options_payto() :: %{
  optional(:mandate_options) =>
    payment_method_options_payto_mandate_options() | nil,
  optional(String.t()) => term()
}
  • mandate_options - Additional fields for Mandate creation.

payment_method_options_payto_mandate_options()

@type payment_method_options_payto_mandate_options() :: %{
  optional(:amount) => map() | nil,
  optional(:amount_type) => String.t() | nil,
  optional(:end_date) => map() | nil,
  optional(:payment_schedule) => String.t() | nil,
  optional(:payments_per_period) => map() | nil,
  optional(:purpose) => String.t() | nil,
  optional(:start_date) => map() | nil,
  optional(String.t()) => term()
}
  • amount - Amount that will be collected. It is required when amount_type is fixed.
  • amount_type - The type of amount that will be collected. The amount charged must be exact or up to the value of amount param for fixed or maximum type respectively. Defaults to maximum. Possible values: fixed, maximum.
  • end_date - Date, in YYYY-MM-DD format, after which payments will not be collected. Defaults to no end date.
  • payment_schedule - The periodicity at which payments will be collected. Defaults to adhoc. Possible values: adhoc, annual, daily, fortnightly, monthly, quarterly, semi_annual, weekly.
  • payments_per_period - The number of payments that will be made during a payment period. Defaults to 1 except for when payment_schedule is adhoc. In that case, it defaults to no limit.
  • purpose - The purpose for which payments are made. Has a default value based on your merchant category code. Possible values: dependant_support, government, loan, mortgage, other, pension, personal, retail, salary, tax, utility.
  • start_date - Date, in YYYY-MM-DD format, from which payments will be collected. Defaults to confirmation time.

payment_method_options_sepa_debit()

@type payment_method_options_sepa_debit() :: %{
  optional(:mandate_options) =>
    payment_method_options_sepa_debit_mandate_options() | nil,
  optional(String.t()) => term()
}
  • mandate_options - Additional fields for Mandate creation

payment_method_options_sepa_debit_mandate_options()

@type payment_method_options_sepa_debit_mandate_options() :: %{
  optional(:reference_prefix) => map() | nil,
  optional(String.t()) => term()
}
  • reference_prefix - Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'STRIPE'.

payment_method_options_us_bank_account()

@type payment_method_options_us_bank_account() :: %{
  optional(:financial_connections) =>
    payment_method_options_us_bank_account_financial_connections() | nil,
  optional(:mandate_options) =>
    payment_method_options_us_bank_account_mandate_options() | nil,
  optional(:networks) =>
    payment_method_options_us_bank_account_networks() | nil,
  optional(:verification_method) => String.t() | nil,
  optional(String.t()) => term()
}
  • financial_connections - Additional fields for Financial Connections Session creation
  • mandate_options - Additional fields for Mandate creation
  • networks - Additional fields for network related functions
  • verification_method - Bank account verification method. Possible values: automatic, instant, microdeposits.

payment_method_options_us_bank_account_financial_connections()

@type payment_method_options_us_bank_account_financial_connections() :: %{
  optional(:filters) =>
    payment_method_options_us_bank_account_financial_connections_filters() | nil,
  optional(:permissions) => [String.t()] | nil,
  optional(:prefetch) => [String.t()] | nil,
  optional(:return_url) => String.t() | nil,
  optional(String.t()) => term()
}
  • filters - Provide filters for the linked accounts that the customer can select for the payment method.
  • permissions - The list of permissions to request. If this parameter is passed, the payment_method permission must be included. Valid permissions include: balances, ownership, payment_method, and transactions.
  • prefetch - List of data features that you would like to retrieve upon account creation.
  • return_url - For webview integrations only. Upon completing OAuth login in the native browser, the user will be redirected to this URL to return to your app. Max length: 5000.

payment_method_options_us_bank_account_financial_connections_filters()

@type payment_method_options_us_bank_account_financial_connections_filters() :: %{
  optional(:account_subcategories) => [String.t()] | nil,
  optional(String.t()) => term()
}
  • account_subcategories - The account subcategories to use to filter for selectable accounts. Valid subcategories are checking and savings.

payment_method_options_us_bank_account_mandate_options()

@type payment_method_options_us_bank_account_mandate_options() :: %{
  optional(:collection_method) => String.t() | nil,
  optional(String.t()) => term()
}
  • collection_method - The method used to collect offline mandate customer acceptance. Possible values: paper.

payment_method_options_us_bank_account_networks()

@type payment_method_options_us_bank_account_networks() :: %{
  optional(:requested) => [String.t()] | nil,
  optional(String.t()) => term()
}
  • requested - Triggers validations to run across the selected networks

t()

@type t() :: %Stripe.Params.SetupIntentUpdateParams{
  attach_to_self: boolean() | nil,
  customer: String.t() | nil,
  customer_account: String.t() | nil,
  description: String.t() | nil,
  excluded_payment_method_types: map() | nil,
  expand: [String.t()] | nil,
  flow_directions: [String.t()] | nil,
  metadata: map() | nil,
  payment_method: String.t() | nil,
  payment_method_configuration: String.t() | nil,
  payment_method_data: payment_method_data() | nil,
  payment_method_options: payment_method_options() | nil,
  payment_method_types: [String.t()] | nil
}
  • attach_to_self - If present, the SetupIntent's payment method will be attached to the in-context Stripe Account.

It can only be used for this Stripe Account’s own money movement flows like InboundTransfer and OutboundTransfers. It cannot be set to true when setting up a PaymentMethod for a Customer, and defaults to false when attaching a PaymentMethod to a Customer.

  • customer - ID of the Customer this SetupIntent belongs to, if one exists.

If present, the SetupIntent's payment method will be attached to the Customer on successful setup. Payment methods attached to other Customers cannot be used with this SetupIntent. Max length: 5000.

  • customer_account - ID of the Account this SetupIntent belongs to, if one exists.

If present, the SetupIntent's payment method will be attached to the Account on successful setup. Payment methods attached to other Accounts cannot be used with this SetupIntent. Max length: 5000.

  • description - An arbitrary string attached to the object. Often useful for displaying to users. Max length: 1000.
  • excluded_payment_method_types - The list of payment method types to exclude from use with this SetupIntent.
  • expand - Specifies which fields in the response should be expanded.
  • flow_directions - Indicates the directions of money movement for which this payment method is intended to be used.

Include inbound if you intend to use the payment method as the origin to pull funds from. Include outbound if you intend to use the payment method as the destination to send funds to. You can include both if you intend to use the payment method for both purposes.

  • 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.
  • payment_method - ID of the payment method (a PaymentMethod, Card, or saved Source object) to attach to this SetupIntent. To unset this field to null, pass in an empty string. Max length: 5000.
  • payment_method_configuration - The ID of the payment method configuration to use with this SetupIntent. Max length: 100.
  • payment_method_data - When included, this hash creates a PaymentMethod that is set as the payment_method value in the SetupIntent.
  • payment_method_options - Payment method-specific configuration for this SetupIntent.
  • payment_method_types - The list of payment method types (for example, card) that this SetupIntent can set up. If you don't provide this, Stripe will dynamically show relevant payment methods from your payment method settings. A list of valid payment method types can be found here.