View Source Stripe.ConfirmationToken (stripity_stripe v3.3.1)

ConfirmationTokens help transport client side data collected by Stripe JS over to your server for confirming a PaymentIntent or SetupIntent. If the confirmation is successful, values present on the ConfirmationToken are written onto the Intent.

To learn more about how to use ConfirmationToken, visit the related guides:

Summary

Types

acss_debit()

If this is an acss_debit PaymentMethod, this hash contains details about the ACSS Debit payment method.

address()

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.

billing_details()

Billing information associated with the PaymentMethod that may be used or required by particular types of payment methods.

boleto()

If this is a boleto PaymentMethod, this hash contains details about the Boleto payment method.

card()

Configuration for any card payments confirmed using this ConfirmationToken.

dob()

Customer's date of birth

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.

ideal()

If this is an ideal PaymentMethod, this hash contains details about the iDEAL payment method.

installments()

Installment configuration for payments confirmed using this ConfirmationToken.

klarna()

If this is a klarna PaymentMethod, this hash contains details about the Klarna 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.

p24()

If this is a p24 PaymentMethod, this hash contains details about the P24 payment method.

payment_method_data()

If provided, this hash will be used to create a PaymentMethod.

payment_method_options()

Payment-method-specific configuration for this ConfirmationToken.

plan()

The selected installment plan to use for this payment attempt. This parameter can only be provided during confirmation.

radar_options()

Options to configure Radar. See Radar Session for more information.

sepa_debit()

If this is a sepa_debit PaymentMethod, this hash contains details about the SEPA debit bank account.

shipping()

Shipping information for this ConfirmationToken.

sofort()

If this is a sofort PaymentMethod, this hash contains details about the SOFORT payment method.

t()

The confirmation_token type.

us_bank_account()

If this is an us_bank_account PaymentMethod, this hash contains details about the US bank account payment method.

Functions

create(params \\ %{}, opts \\ [])

Creates a test mode Confirmation Token server side for your integration tests.

retrieve(confirmation_token, params \\ %{}, opts \\ [])

Retrieves an existing ConfirmationToken object

Types

acss_debit()

@type acss_debit() :: %{
  optional(:account_number) => binary(),
  optional(:institution_number) => binary(),
  optional(:transit_number) => binary()
}

If this is an acss_debit PaymentMethod, this hash contains details about the ACSS Debit payment method.

address()

@type address() :: %{
  optional(:city) => binary(),
  optional(:country) => binary(),
  optional(:line1) => binary(),
  optional(:line2) => binary(),
  optional(:postal_code) => binary(),
  optional(:state) => binary()
}

au_becs_debit()

@type au_becs_debit() :: %{
  optional(:account_number) => binary(),
  optional(:bsb_number) => binary()
}

If this is an au_becs_debit PaymentMethod, this hash contains details about the bank account.

bacs_debit()

@type bacs_debit() :: %{
  optional(:account_number) => binary(),
  optional(:sort_code) => binary()
}

If this is a bacs_debit PaymentMethod, this hash contains details about the Bacs Direct Debit bank account.

billing_details()

@type billing_details() :: %{
  optional(:address) => address() | binary(),
  optional(:email) => binary() | binary(),
  optional(:name) => binary() | binary(),
  optional(:phone) => binary() | binary(),
  optional(:tax_id) => binary()
}

Billing information associated with the PaymentMethod that may be used or required by particular types of payment methods.

boleto()

@type boleto() :: %{optional(:tax_id) => binary()}

If this is a boleto PaymentMethod, this hash contains details about the Boleto payment method.

card()

@type card() :: %{optional(:installments) => installments()}

Configuration for any card payments confirmed using this ConfirmationToken.

dob()

@type dob() :: %{
  optional(:day) => integer(),
  optional(:month) => integer(),
  optional(:year) => integer()
}

Customer's date of birth

eps()

@type eps() :: %{
  optional(:bank) =>
    :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
}

If this is an eps PaymentMethod, this hash contains details about the EPS payment method.

fpx()

@type fpx() :: %{
  optional(:account_holder_type) => :company | :individual,
  optional(:bank) =>
    :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
}

If this is an fpx PaymentMethod, this hash contains details about the FPX payment method.

ideal()

@type ideal() :: %{
  optional(:bank) =>
    :abn_amro
    | :asn_bank
    | :bunq
    | :buut
    | :finom
    | :handelsbanken
    | :ing
    | :knab
    | :moneyou
    | :n26
    | :nn
    | :rabobank
    | :regiobank
    | :revolut
    | :sns_bank
    | :triodos_bank
    | :van_lanschot
    | :yoursafe
}

If this is an ideal PaymentMethod, this hash contains details about the iDEAL payment method.

installments()

@type installments() :: %{optional(:plan) => plan()}

Installment configuration for payments confirmed using this ConfirmationToken.

klarna()

@type klarna() :: %{optional(:dob) => dob()}

If this is a klarna PaymentMethod, this hash contains details about the Klarna payment method.

naver_pay()

@type naver_pay() :: %{optional(:funding) => :card | :points}

If this is a naver_pay PaymentMethod, this hash contains details about the Naver Pay payment method.

nz_bank_account()

@type nz_bank_account() :: %{
  optional(:account_holder_name) => binary(),
  optional(:account_number) => binary(),
  optional(:bank_code) => binary(),
  optional(:branch_code) => binary(),
  optional(:reference) => binary(),
  optional(:suffix) => binary()
}

If this is an nz_bank_account PaymentMethod, this hash contains details about the nz_bank_account payment method.

p24()

@type p24() :: %{
  optional(:bank) =>
    :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
}

If this is a p24 PaymentMethod, this hash contains details about the P24 payment method.

payment_method_data()

@type payment_method_data() :: %{
  optional(:sofort) => sofort(),
  optional(:customer_balance) => map(),
  optional(:satispay) => map(),
  optional(:boleto) => boleto(),
  optional(:alipay) => map(),
  optional(:au_becs_debit) => au_becs_debit(),
  optional(:amazon_pay) => map(),
  optional(:metadata) => %{optional(binary()) => binary()},
  optional(:bancontact) => map(),
  optional(:interac_present) => map(),
  optional(:bacs_debit) => bacs_debit(),
  optional(:affirm) => map(),
  optional(:billing_details) => billing_details(),
  optional(:mobilepay) => map(),
  optional(:pay_by_bank) => map(),
  optional(:nz_bank_account) => nz_bank_account(),
  optional(:grabpay) => map(),
  optional(:eps) => eps(),
  optional(:billie) => map(),
  optional(:ideal) => ideal(),
  optional(:pix) => map(),
  optional(:giropay) => map(),
  optional(:multibanco) => map(),
  optional(:revolut_pay) => map(),
  optional(:klarna) => klarna(),
  optional(:mb_way) => map(),
  optional(:twint) => map(),
  optional(:naver_pay) => naver_pay(),
  optional(:crypto) => map(),
  optional(:acss_debit) => acss_debit(),
  optional(:link) => map(),
  optional(:kr_card) => map(),
  optional(:konbini) => map(),
  optional(:blik) => map(),
  optional(:p24) => p24(),
  optional(:paypal) => map(),
  optional(:fpx) => fpx(),
  optional(:oxxo) => map(),
  optional(:paynow) => map(),
  optional(:alma) => map(),
  optional(:wechat_pay) => map(),
  optional(:promptpay) => map(),
  optional(:type) =>
    :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
    | :pix
    | :promptpay
    | :revolut_pay
    | :samsung_pay
    | :satispay
    | :sepa_debit
    | :sofort
    | :swish
    | :twint
    | :us_bank_account
    | :wechat_pay
    | :zip,
  optional(:samsung_pay) => map(),
  optional(:kakao_pay) => map(),
  optional(:radar_options) => radar_options(),
  optional(:cashapp) => map(),
  optional(:sepa_debit) => sepa_debit(),
  optional(:afterpay_clearpay) => map(),
  optional(:payco) => map(),
  optional(:allow_redisplay) => :always | :limited | :unspecified,
  optional(:us_bank_account) => us_bank_account(),
  optional(:swish) => map(),
  optional(:zip) => map()
}

If provided, this hash will be used to create a PaymentMethod.

payment_method_options()

@type payment_method_options() :: %{optional(:card) => card()}

Payment-method-specific configuration for this ConfirmationToken.

plan()

@type plan() :: %{
  optional(:count) => integer(),
  optional(:interval) => :month,
  optional(:type) => :bonus | :fixed_count | :revolving
}

The selected installment plan to use for this payment attempt. This parameter can only be provided during confirmation.

radar_options()

@type radar_options() :: %{optional(:session) => binary()}

Options to configure Radar. See Radar Session for more information.

sepa_debit()

@type sepa_debit() :: %{optional(:iban) => binary()}

If this is a sepa_debit PaymentMethod, this hash contains details about the SEPA debit bank account.

shipping()

@type shipping() :: %{
  optional(:address) => address(),
  optional(:name) => binary(),
  optional(:phone) => binary() | binary()
}

Shipping information for this ConfirmationToken.

sofort()

@type sofort() :: %{optional(:country) => :AT | :BE | :DE | :ES | :IT | :NL}

If this is a sofort PaymentMethod, this hash contains details about the SOFORT payment method.

t()

@type t() :: %Stripe.ConfirmationToken{
  created: integer(),
  expires_at: integer() | nil,
  id: binary(),
  livemode: boolean(),
  mandate_data: term() | nil,
  object: binary(),
  payment_intent: binary() | nil,
  payment_method_options: term() | nil,
  payment_method_preview: term() | nil,
  return_url: binary() | nil,
  setup_future_usage: binary() | nil,
  setup_intent: binary() | nil,
  shipping: term() | nil,
  use_stripe_sdk: boolean()
}

The confirmation_token type.

created Time at which the object was created. Measured in seconds since the Unix epoch.
expires_at Time at which this ConfirmationToken expires and can no longer be used to confirm a PaymentIntent or SetupIntent.
id Unique identifier for the object.
livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
mandate_data Data used for generating a Mandate.
object String representing the object's type. Objects of the same type share the same value.
payment_intent ID of the PaymentIntent that this ConfirmationToken was used to confirm, or null if this ConfirmationToken has not yet been used.
payment_method_options Payment-method-specific configuration for this ConfirmationToken.
payment_method_preview Payment details collected by the Payment Element, used to create a PaymentMethod when a PaymentIntent or SetupIntent is confirmed with this ConfirmationToken.
return_url Return URL used to confirm the Intent.
setup_future_usage Indicates that you intend to make future payments with this ConfirmationToken's payment method.

The presence of this property will attach the payment method to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete.

setup_intent ID of the SetupIntent that this ConfirmationToken was used to confirm, or null if this ConfirmationToken has not yet been used.
shipping Shipping information collected on this ConfirmationToken.
use_stripe_sdk Indicates whether the Stripe SDK is used to handle confirmation flow. Defaults to true on ConfirmationToken.

us_bank_account()

@type us_bank_account() :: %{
  optional(:account_holder_type) => :company | :individual,
  optional(:account_number) => binary(),
  optional(:account_type) => :checking | :savings,
  optional(:financial_connections_account) => binary(),
  optional(:routing_number) => binary()
}

If this is an us_bank_account PaymentMethod, this hash contains details about the US bank account payment method.

Functions

create(params \\ %{}, opts \\ [])

@spec create(
  params :: %{
    optional(:expand) => [binary()],
    optional(:payment_method) => binary(),
    optional(:payment_method_data) => payment_method_data(),
    optional(:payment_method_options) => payment_method_options(),
    optional(:return_url) => binary(),
    optional(:setup_future_usage) => :off_session | :on_session,
    optional(:shipping) => shipping()
  },
  opts :: Keyword.t()
) :: {:ok, t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()}

Creates a test mode Confirmation Token server side for your integration tests.

Details

Method: post
Path: /v1/test_helpers/confirmation_tokens

retrieve(confirmation_token, params \\ %{}, opts \\ [])

@spec retrieve(
  confirmation_token :: binary(),
  params :: %{optional(:expand) => [binary()]},
  opts :: Keyword.t()
) :: {:ok, t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()}

Retrieves an existing ConfirmationToken object

Details

Method: get
Path: /v1/confirmation_tokens/{confirmation_token}