Stripe.Params.PaymentIntentConfirmParams (tiger_stripe v0.3.0)

Copy Markdown View Source

Parameters for payment intent confirm.

Summary

Types

hooks()

@type hooks() :: %{
  optional(:inputs) => hooks_inputs() | nil,
  optional(String.t()) => term()
}
  • inputs - Arguments passed in automations

hooks_inputs()

@type hooks_inputs() :: %{
  optional(:tax) => hooks_inputs_tax() | nil,
  optional(String.t()) => term()
}
  • tax - Tax arguments for automations

hooks_inputs_tax()

@type hooks_inputs_tax() :: %{
  optional(:calculation) => map() | nil,
  optional(String.t()) => term()
}

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) => map() | nil,
  optional(:affirm) => map() | nil,
  optional(:afterpay_clearpay) => map() | nil,
  optional(:alipay) => map() | nil,
  optional(:alma) => map() | nil,
  optional(:amazon_pay) => map() | nil,
  optional(:au_becs_debit) => map() | nil,
  optional(:bacs_debit) => map() | nil,
  optional(:bancontact) => map() | nil,
  optional(:billie) => map() | nil,
  optional(:blik) => map() | nil,
  optional(:boleto) => map() | nil,
  optional(:card) => map() | nil,
  optional(:card_present) => map() | nil,
  optional(:cashapp) => map() | nil,
  optional(:crypto) => map() | nil,
  optional(:customer_balance) => map() | nil,
  optional(:eps) => map() | nil,
  optional(:fpx) => map() | nil,
  optional(:giropay) => map() | nil,
  optional(:grabpay) => map() | nil,
  optional(:ideal) => map() | nil,
  optional(:interac_present) => map() | nil,
  optional(:kakao_pay) => map() | nil,
  optional(:klarna) => map() | nil,
  optional(:konbini) => map() | nil,
  optional(:kr_card) => map() | nil,
  optional(:link) => map() | nil,
  optional(:mb_way) => map() | nil,
  optional(:mobilepay) => map() | nil,
  optional(:multibanco) => map() | nil,
  optional(:naver_pay) => map() | nil,
  optional(:nz_bank_account) => map() | nil,
  optional(:oxxo) => map() | nil,
  optional(:p24) => map() | nil,
  optional(:pay_by_bank) => map() | nil,
  optional(:payco) => map() | nil,
  optional(:paynow) => map() | nil,
  optional(:paypal) => map() | nil,
  optional(:payto) => map() | nil,
  optional(:pix) => map() | nil,
  optional(:promptpay) => map() | nil,
  optional(:revolut_pay) => map() | nil,
  optional(:samsung_pay) => map() | nil,
  optional(:satispay) => map() | nil,
  optional(:sepa_debit) => map() | nil,
  optional(:sofort) => map() | nil,
  optional(:swish) => map() | nil,
  optional(:twint) => map() | nil,
  optional(:us_bank_account) => map() | nil,
  optional(:wechat_pay) => map() | nil,
  optional(:zip) => map() | nil,
  optional(String.t()) => term()
}
  • acss_debit - If this is a acss_debit PaymentMethod, this sub-hash contains details about the ACSS Debit payment method options.
  • affirm - If this is an affirm PaymentMethod, this sub-hash contains details about the Affirm payment method options.
  • afterpay_clearpay - If this is a afterpay_clearpay PaymentMethod, this sub-hash contains details about the Afterpay Clearpay payment method options.
  • alipay - If this is a alipay PaymentMethod, this sub-hash contains details about the Alipay payment method options.
  • alma - If this is a alma PaymentMethod, this sub-hash contains details about the Alma payment method options.
  • amazon_pay - If this is a amazon_pay PaymentMethod, this sub-hash contains details about the Amazon Pay payment method options.
  • au_becs_debit - If this is a au_becs_debit PaymentMethod, this sub-hash contains details about the AU BECS Direct Debit payment method options.
  • bacs_debit - If this is a bacs_debit PaymentMethod, this sub-hash contains details about the BACS Debit payment method options.
  • bancontact - If this is a bancontact PaymentMethod, this sub-hash contains details about the Bancontact payment method options.
  • billie - If this is a billie PaymentMethod, this sub-hash contains details about the Billie payment method options.
  • blik - If this is a blik PaymentMethod, this sub-hash contains details about the BLIK payment method options.
  • boleto - If this is a boleto PaymentMethod, this sub-hash contains details about the Boleto payment method options.
  • card - Configuration for any card payments attempted on this PaymentIntent.
  • card_present - If this is a card_present PaymentMethod, this sub-hash contains details about the Card Present payment method options.
  • cashapp - If this is a cashapp PaymentMethod, this sub-hash contains details about the Cash App Pay payment method options.
  • crypto - If this is a crypto PaymentMethod, this sub-hash contains details about the Crypto payment method options.
  • customer_balance - If this is a customer balance PaymentMethod, this sub-hash contains details about the customer balance payment method options.
  • eps - If this is a eps PaymentMethod, this sub-hash contains details about the EPS payment method options.
  • fpx - If this is a fpx PaymentMethod, this sub-hash contains details about the FPX payment method options.
  • giropay - If this is a giropay PaymentMethod, this sub-hash contains details about the Giropay payment method options.
  • grabpay - If this is a grabpay PaymentMethod, this sub-hash contains details about the Grabpay payment method options.
  • ideal - If this is a ideal PaymentMethod, this sub-hash contains details about the Ideal payment method options.
  • interac_present - If this is a interac_present PaymentMethod, this sub-hash contains details about the Card Present payment method options.
  • kakao_pay - If this is a kakao_pay PaymentMethod, this sub-hash contains details about the Kakao Pay payment method options.
  • klarna - If this is a klarna PaymentMethod, this sub-hash contains details about the Klarna payment method options.
  • konbini - If this is a konbini PaymentMethod, this sub-hash contains details about the Konbini payment method options.
  • kr_card - If this is a kr_card PaymentMethod, this sub-hash contains details about the KR Card payment method options.
  • link - If this is a link PaymentMethod, this sub-hash contains details about the Link payment method options.
  • mb_way - If this is a mb_way PaymentMethod, this sub-hash contains details about the MB WAY payment method options.
  • mobilepay - If this is a MobilePay PaymentMethod, this sub-hash contains details about the MobilePay payment method options.
  • multibanco - If this is a multibanco PaymentMethod, this sub-hash contains details about the Multibanco payment method options.
  • naver_pay - If this is a naver_pay PaymentMethod, this sub-hash contains details about the Naver Pay payment method options.
  • nz_bank_account - If this is a nz_bank_account PaymentMethod, this sub-hash contains details about the NZ BECS Direct Debit payment method options.
  • oxxo - If this is a oxxo PaymentMethod, this sub-hash contains details about the OXXO payment method options.
  • p24 - If this is a p24 PaymentMethod, this sub-hash contains details about the Przelewy24 payment method options.
  • pay_by_bank - If this is a pay_by_bank PaymentMethod, this sub-hash contains details about the PayByBank payment method options.
  • payco - If this is a payco PaymentMethod, this sub-hash contains details about the PAYCO payment method options.
  • paynow - If this is a paynow PaymentMethod, this sub-hash contains details about the PayNow 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 PaymentMethod, this sub-hash contains details about the PayTo payment method options.
  • pix - If this is a pix PaymentMethod, this sub-hash contains details about the Pix payment method options.
  • promptpay - If this is a promptpay PaymentMethod, this sub-hash contains details about the PromptPay payment method options.
  • revolut_pay - If this is a revolut_pay PaymentMethod, this sub-hash contains details about the Revolut Pay payment method options.
  • samsung_pay - If this is a samsung_pay PaymentMethod, this sub-hash contains details about the Samsung Pay payment method options.
  • satispay - If this is a satispay PaymentMethod, this sub-hash contains details about the Satispay payment method options.
  • sepa_debit - If this is a sepa_debit PaymentIntent, this sub-hash contains details about the SEPA Debit payment method options.
  • sofort - If this is a sofort PaymentMethod, this sub-hash contains details about the SOFORT payment method options.
  • swish - If this is a Swish PaymentMethod, this sub-hash contains details about the Swish payment method options.
  • twint - If this is a twint PaymentMethod, this sub-hash contains details about the TWINT payment method options.
  • us_bank_account - If this is a us_bank_account PaymentMethod, this sub-hash contains details about the US bank account payment method options.
  • wechat_pay - If this is a wechat_pay PaymentMethod, this sub-hash contains details about the WeChat Pay payment method options.
  • zip - If this is a zip PaymentMethod, this sub-hash contains details about the Zip payment method options.

radar_options()

@type 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.

t()

@type t() :: %Stripe.Params.PaymentIntentConfirmParams{
  amount_details: map() | nil,
  capture_method: String.t() | nil,
  confirmation_token: String.t() | nil,
  error_on_requires_action: boolean() | nil,
  excluded_payment_method_types: map() | nil,
  expand: [String.t()] | nil,
  hooks: hooks() | nil,
  mandate: String.t() | nil,
  mandate_data: map() | nil,
  off_session: map() | nil,
  payment_details: map() | nil,
  payment_method: String.t() | nil,
  payment_method_data: payment_method_data() | nil,
  payment_method_options: payment_method_options() | nil,
  payment_method_types: [String.t()] | nil,
  radar_options: radar_options() | nil,
  receipt_email: map() | nil,
  return_url: String.t() | nil,
  setup_future_usage: String.t() | nil,
  shipping: map() | nil,
  use_stripe_sdk: boolean() | nil
}
  • amount_details - Provides industry-specific information about the amount.
  • capture_method - Controls when the funds will be captured from the customer's account. Possible values: automatic, automatic_async, manual.
  • confirmation_token - ID of the ConfirmationToken used to confirm this PaymentIntent.

If the provided ConfirmationToken contains properties that are also being provided in this request, such as payment_method, then the values in this request will take precedence. Max length: 5000.

  • error_on_requires_action - Set to true to fail the payment attempt if the PaymentIntent transitions into requires_action. This parameter is intended for simpler integrations that do not handle customer actions, like saving cards without authentication.
  • excluded_payment_method_types - The list of payment method types to exclude from use with this payment.
  • expand - Specifies which fields in the response should be expanded.
  • hooks - Automations to be run during the PaymentIntent lifecycle
  • mandate - ID of the mandate that's used for this payment. Max length: 5000.
  • mandate_data
  • off_session - Set to true to indicate that the customer isn't in your checkout flow during this payment attempt and can't authenticate. Use this parameter in scenarios where you collect card details and charge them later.
  • payment_details - Provides industry-specific information about the charge.
  • payment_method - ID of the payment method (a PaymentMethod, Card, or compatible Source object) to attach to this PaymentIntent. If the payment method is attached to a Customer, it must match the customer that is set on this PaymentIntent. Max length: 5000.
  • payment_method_data - If provided, this hash will be used to create a PaymentMethod. The new PaymentMethod will appear in the payment_method property on the PaymentIntent.
  • payment_method_options - Payment method-specific configuration for this PaymentIntent.
  • payment_method_types - The list of payment method types (for example, a card) that this PaymentIntent can use. Use automatic_payment_methods to manage payment methods from the Stripe Dashboard. A list of valid payment method types can be found here.
  • radar_options - Options to configure Radar. Learn more about Radar Sessions.
  • receipt_email - Email address that the receipt for the resulting payment will be sent to. If receipt_email is specified for a payment in live mode, a receipt will be sent regardless of your email settings.
  • return_url - The URL to redirect your customer back to after they authenticate or cancel their payment on the payment method's app or site. If you'd prefer to redirect to a mobile application, you can alternatively supply an application URI scheme. This parameter is only used for cards and other redirect-based payment methods.
  • setup_future_usage - Indicates that you intend to make future payments with this PaymentIntent's payment method.

If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still attach the payment method to a Customer after the transaction completes.

If the payment method is card_present and isn't a digital wallet, Stripe creates and attaches a generated_card payment method representing the card to the Customer instead.

When processing card payments, Stripe uses setup_future_usage to help you comply with regional legislation and network rules, such as SCA.

If you've already set setup_future_usage and you're performing a request using a publishable key, you can only update the value from on_session to off_session. Possible values: off_session, on_session.

  • shipping - Shipping information for this PaymentIntent.
  • use_stripe_sdk - Set to true when confirming server-side and using Stripe.js, iOS, or Android client-side SDKs to handle the next actions.