View Source Stripe.PaymentIntent (stripity_stripe v3.2.0)

A PaymentIntent guides you through the process of collecting a payment from your customer. We recommend that you create exactly one PaymentIntent for each order or customer session in your system. You can reference the PaymentIntent later to see the history of payment attempts for a particular session.

A PaymentIntent transitions through multiple statuses throughout its lifetime as it interfaces with Stripe.js to perform authentication flows and ultimately creates at most one successful charge.

Related guide: Payment Intents API

Summary

Types

acss_debit()

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

address()

Shipping address.

affirm()
afterpay_clearpay()
alipay()
au_becs_debit()
automatic_payment_methods()

When you enable this parameter, this PaymentIntent accepts payment methods that you enable in the Dashboard and that are compatible with this PaymentIntent's other parameters.

bacs_debit()
bancontact()
bank_transfer()

Configuration for the bank transfer funding type, if the funding_type is set to bank_transfer.

billing_details()

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

blik()
boleto()
card()
card_present()
cartes_bancaires()

Cartes Bancaires-specific 3DS fields.

cashapp()
created()
customer_acceptance()

This hash contains details about the customer acceptance of the Mandate.

customer_balance()
dob()

Customer's date of birth

eps()
eu_bank_transfer()

Configuration for the eu_bank_transfer funding type.

financial_connections()

Additional fields for Financial Connections Session creation

fpx()
giropay()
grabpay()
ideal()

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

installments()

Installment configuration for payments attempted on this PaymentIntent (Mexico Only).

klarna()
konbini()
link()
mandate_data()
mandate_options()

Configuration options for setting up an eMandate for cards issued in India.

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

networks()

Additional fields for network related functions

online()

If this is a Mandate accepted online, this hash contains details about the online acceptance.

oxxo()
p24()
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.

paynow()
paypal()
pix()
plan()
promptpay()
radar_options()

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

revolut_pay()
sepa_debit()
shipping()

Shipping information for this PaymentIntent.

sofort()
t()

The payment_intent type.

three_d_secure()

If 3D Secure authentication was performed with a third-party provider, the authentication details to use for this payment.

transfer_data()

The parameters that you can use to automatically create a Transfer. Learn more about the use case for connected accounts.

us_bank_account()

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

wechat_pay()
zip()

Functions

apply_customer_balance(intent, params \\ %{}, opts \\ [])

Manually reconcile the remaining amount for a customer_balance PaymentIntent.

cancel(intent, params \\ %{}, opts \\ [])

You can cancel a PaymentIntent object when it’s in one of these statuses: requires_payment_method, requires_capture, requires_confirmation, requires_action or, in rare cases, processing.

capture(intent, params \\ %{}, opts \\ [])

Capture the funds of an existing uncaptured PaymentIntent when its status is requires_capture.

confirm(intent, params \\ %{}, opts \\ [])

Confirm that your customer intends to pay with current or providedpayment method. Upon confirmation, the PaymentIntent will attempt to initiate a payment. If the selected payment method requires additional authentication steps, the PaymentIntent will transition to the requires_action status and suggest additional actions via next_action. If payment fails, the PaymentIntent transitions to the requires_payment_method status or the canceled status if the confirmation limit is reached. If payment succeeds, the PaymentIntent will transition to the succeeded status (or requires_capture, if capture_method is set to manual). If the confirmation_method is automatic, payment may be attempted using our client SDKs and the PaymentIntent’s client_secret. After next_actions are handled by the client, no additional confirmation is required to complete the payment. If the confirmation_method is manual, all payment attempts must be initiated using a secret key. If any actions are required for the payment, the PaymentIntent will return to the requires_confirmation state after those actions are completed. Your server needs to then explicitly re-confirm the PaymentIntent to initiate the next payment attempt. Read the expanded documentation to learn more about manual confirmation.

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

Creates a PaymentIntent object.

increment_authorization(intent, params \\ %{}, opts \\ [])

Perform an incremental authorization on an eligiblePaymentIntent. To be eligible, the PaymentIntent’s status must be requires_capture and incremental_authorization_supported must be true.

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

Returns a list of PaymentIntents.

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

Retrieves the details of a PaymentIntent that has previously been created.

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

Search for PaymentIntents you’ve previously created using Stripe’s Search Query Language.Don’t use search in read-after-write flows where strict consistency is necessary. Under normal operating conditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up to an hour behind during outages. Search functionality is not available to merchants in India.

update(intent, params \\ %{}, opts \\ [])

Updates properties on a PaymentIntent object without confirming.

verify_microdeposits(intent, params \\ %{}, opts \\ [])

Verifies microdeposits on a PaymentIntent object.

Types

Link to this type

acss_debit()

View Source 
@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.

Link to this type

address()

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

Shipping address.

Link to this type

affirm()

View Source 
@type affirm() :: %{
  optional(:capture_method) => :manual,
  optional(:preferred_locale) => binary(),
  optional(:setup_future_usage) => :none
}
Link to this type

afterpay_clearpay()

View Source 
@type afterpay_clearpay() :: %{
  optional(:capture_method) => :manual,
  optional(:reference) => binary(),
  optional(:setup_future_usage) => :none
}
Link to this type

alipay()

View Source 
@type alipay() :: %{optional(:setup_future_usage) => :none | :off_session}
Link to this type

au_becs_debit()

View Source 
@type au_becs_debit() :: %{
  optional(:setup_future_usage) => :none | :off_session | :on_session
}
Link to this type

automatic_payment_methods()

View Source 
@type automatic_payment_methods() :: %{
  optional(:allow_redirects) => :always | :never,
  optional(:enabled) => boolean()
}

When you enable this parameter, this PaymentIntent accepts payment methods that you enable in the Dashboard and that are compatible with this PaymentIntent's other parameters.

Link to this type

bacs_debit()

View Source 
@type bacs_debit() :: %{
  optional(:setup_future_usage) => :none | :off_session | :on_session
}
Link to this type

bancontact()

View Source 
@type bancontact() :: %{
  optional(:preferred_language) => :de | :en | :fr | :nl,
  optional(:setup_future_usage) => :none | :off_session
}
Link to this type

bank_transfer()

View Source 
@type bank_transfer() :: %{
  optional(:eu_bank_transfer) => eu_bank_transfer(),
  optional(:requested_address_types) => [
    :aba | :iban | :sepa | :sort_code | :spei | :swift | :zengin
  ],
  optional(:type) =>
    :eu_bank_transfer
    | :gb_bank_transfer
    | :jp_bank_transfer
    | :mx_bank_transfer
    | :us_bank_transfer
}

Configuration for the bank transfer funding type, if the funding_type is set to bank_transfer.

Link to this type

billing_details()

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

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

Link to this type

blik()

View Source 
@type blik() :: %{optional(:code) => binary()}
Link to this type

boleto()

View Source 
@type boleto() :: %{
  optional(:expires_after_days) => integer(),
  optional(:setup_future_usage) => :none | :off_session | :on_session
}
Link to this type

card()

View Source 
@type card() :: %{
  optional(:capture_method) => :manual,
  optional(:cvc_token) => binary(),
  optional(:installments) => installments(),
  optional(:mandate_options) => mandate_options(),
  optional(:moto) => boolean(),
  optional(:network) =>
    :amex
    | :cartes_bancaires
    | :diners
    | :discover
    | :eftpos_au
    | :interac
    | :jcb
    | :mastercard
    | :unionpay
    | :unknown
    | :visa,
  optional(:request_extended_authorization) => :if_available | :never,
  optional(:request_incremental_authorization) => :if_available | :never,
  optional(:request_multicapture) => :if_available | :never,
  optional(:request_overcapture) => :if_available | :never,
  optional(:request_three_d_secure) => :any | :automatic | :challenge,
  optional(:setup_future_usage) => :none | :off_session | :on_session,
  optional(:statement_descriptor_suffix_kana) => binary() | binary(),
  optional(:statement_descriptor_suffix_kanji) => binary() | binary(),
  optional(:three_d_secure) => three_d_secure()
}
Link to this type

card_present()

View Source 
@type card_present() :: %{
  optional(:request_extended_authorization) => boolean(),
  optional(:request_incremental_authorization_support) => boolean()
}
Link to this type

cartes_bancaires()

View Source 
@type cartes_bancaires() :: %{
  optional(:cb_avalgo) => :"0" | :"1" | :"2" | :"3" | :"4" | :A,
  optional(:cb_exemption) => binary(),
  optional(:cb_score) => integer()
}

Cartes Bancaires-specific 3DS fields.

Link to this type

cashapp()

View Source 
@type cashapp() :: %{
  optional(:capture_method) => :manual,
  optional(:setup_future_usage) => :none | :off_session | :on_session
}
Link to this type

created()

View Source 
@type created() :: %{
  optional(:gt) => integer(),
  optional(:gte) => integer(),
  optional(:lt) => integer(),
  optional(:lte) => integer()
}
Link to this type

customer_acceptance()

View Source 
@type customer_acceptance() :: %{
  optional(:accepted_at) => integer(),
  optional(:offline) => map(),
  optional(:online) => online(),
  optional(:type) => :offline | :online
}

This hash contains details about the customer acceptance of the Mandate.

Link to this type

customer_balance()

View Source 
@type customer_balance() :: %{
  optional(:bank_transfer) => bank_transfer(),
  optional(:funding_type) => :bank_transfer,
  optional(:setup_future_usage) => :none
}
Link to this type

dob()

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

Customer's date of birth

Link to this type

eps()

View Source 
@type eps() :: %{optional(:setup_future_usage) => :none}
Link to this type

eu_bank_transfer()

View Source 
@type eu_bank_transfer() :: %{optional(:country) => binary()}

Configuration for the eu_bank_transfer funding type.

Link to this type

financial_connections()

View Source 
@type financial_connections() :: %{
  optional(:permissions) => [
    :balances | :ownership | :payment_method | :transactions
  ],
  optional(:prefetch) => [:balances | :transactions],
  optional(:return_url) => binary()
}

Additional fields for Financial Connections Session creation

Link to this type

fpx()

View Source 
@type fpx() :: %{optional(:setup_future_usage) => :none}
Link to this type

giropay()

View Source 
@type giropay() :: %{optional(:setup_future_usage) => :none}
Link to this type

grabpay()

View Source 
@type grabpay() :: %{optional(:setup_future_usage) => :none}
Link to this type

ideal()

View Source 
@type ideal() :: %{
  optional(:bank) =>
    :abn_amro
    | :asn_bank
    | :bunq
    | :handelsbanken
    | :ing
    | :knab
    | :moneyou
    | :n26
    | :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.

Link to this type

installments()

View Source 
@type installments() :: %{
  optional(:enabled) => boolean(),
  optional(:plan) => plan() | binary()
}

Installment configuration for payments attempted on this PaymentIntent (Mexico Only).

For more information, see the installments integration guide.

Link to this type

klarna()

View Source 
@type klarna() :: %{
  optional(:capture_method) => :manual,
  optional(:preferred_locale) =>
    :"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-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"
    | :"sv-FI"
    | :"sv-SE",
  optional(:setup_future_usage) => :none
}
Link to this type

konbini()

View Source 
@type konbini() :: %{
  optional(:confirmation_number) => binary() | binary(),
  optional(:expires_after_days) => integer() | binary(),
  optional(:expires_at) => integer() | binary(),
  optional(:product_description) => binary() | binary(),
  optional(:setup_future_usage) => :none
}
Link to this type

link()

View Source 
@type link() :: %{
  optional(:capture_method) => :manual,
  optional(:persistent_token) => binary(),
  optional(:setup_future_usage) => :none | :off_session
}
Link to this type

mandate_data()

View Source 
@type mandate_data() :: %{optional(:customer_acceptance) => customer_acceptance()}
Link to this type

mandate_options()

View Source 
@type mandate_options() :: %{
  optional(:amount) => integer(),
  optional(:amount_type) => :fixed | :maximum,
  optional(:description) => binary(),
  optional(:end_date) => integer(),
  optional(:interval) => :day | :month | :sporadic | :week | :year,
  optional(:interval_count) => integer(),
  optional(:reference) => binary(),
  optional(:start_date) => integer(),
  optional(:supported_types) => [:india]
}

Configuration options for setting up an eMandate for cards issued in India.

Link to this type

network_options()

View Source 
@type network_options() :: %{optional(:cartes_bancaires) => cartes_bancaires()}

Network specific 3DS fields. Network specific arguments require an explicit card brand choice. The parameter `payment_method_options.card.network`` must be populated accordingly

Link to this type

networks()

View Source 
@type networks() :: %{optional(:requested) => [:ach | :us_domestic_wire]}

Additional fields for network related functions

Link to this type

online()

View Source 
@type online() :: %{
  optional(:ip_address) => binary(),
  optional(:user_agent) => binary()
}

If this is a Mandate accepted online, this hash contains details about the online acceptance.

Link to this type

oxxo()

View Source 
@type oxxo() :: %{
  optional(:expires_after_days) => integer(),
  optional(:setup_future_usage) => :none
}
Link to this type

p24()

View Source 
@type p24() :: %{
  optional(:setup_future_usage) => :none,
  optional(:tos_shown_and_accepted) => boolean()
}
Link to this type

payment_method_data()

View Source 
@type payment_method_data() :: %{
  optional(:pix) => map(),
  optional(:fpx) => fpx(),
  optional(:affirm) => map(),
  optional(:acss_debit) => acss_debit(),
  optional(:bacs_debit) => bacs_debit(),
  optional(:alipay) => map(),
  optional(:giropay) => map(),
  optional(:ideal) => ideal(),
  optional(:revolut_pay) => map(),
  optional(:radar_options) => radar_options(),
  optional(:metadata) => %{optional(binary()) => binary()},
  optional(:link) => map(),
  optional(:promptpay) => map(),
  optional(:cashapp) => map(),
  optional(:oxxo) => map(),
  optional(:interac_present) => map(),
  optional(:us_bank_account) => us_bank_account(),
  optional(:zip) => map(),
  optional(:paypal) => map(),
  optional(:boleto) => boleto(),
  optional(:konbini) => map(),
  optional(:billing_details) => billing_details(),
  optional(:blik) => map(),
  optional(:wechat_pay) => map(),
  optional(:sofort) => sofort(),
  optional(:p24) => p24(),
  optional(:afterpay_clearpay) => map(),
  optional(:type) =>
    :acss_debit
    | :affirm
    | :afterpay_clearpay
    | :alipay
    | :au_becs_debit
    | :bacs_debit
    | :bancontact
    | :blik
    | :boleto
    | :cashapp
    | :customer_balance
    | :eps
    | :fpx
    | :giropay
    | :grabpay
    | :ideal
    | :klarna
    | :konbini
    | :link
    | :oxxo
    | :p24
    | :paynow
    | :paypal
    | :pix
    | :promptpay
    | :revolut_pay
    | :sepa_debit
    | :sofort
    | :us_bank_account
    | :wechat_pay
    | :zip,
  optional(:grabpay) => map(),
  optional(:bancontact) => map(),
  optional(:au_becs_debit) => au_becs_debit(),
  optional(:customer_balance) => map(),
  optional(:sepa_debit) => sepa_debit(),
  optional(:klarna) => klarna(),
  optional(:paynow) => map(),
  optional(:eps) => eps()
}

If provided, this hash will be used to create a PaymentMethod. The new PaymentMethod will appear in the payment_method property on the PaymentIntent.

Link to this type

payment_method_options()

View Source 
@type payment_method_options() :: %{
  optional(:pix) => pix() | binary(),
  optional(:fpx) => fpx() | binary(),
  optional(:affirm) => affirm() | binary(),
  optional(:acss_debit) => acss_debit() | binary(),
  optional(:bacs_debit) => bacs_debit() | binary(),
  optional(:alipay) => alipay() | binary(),
  optional(:giropay) => giropay() | binary(),
  optional(:ideal) => ideal() | binary(),
  optional(:revolut_pay) => revolut_pay() | binary(),
  optional(:card) => card() | binary(),
  optional(:link) => link() | binary(),
  optional(:promptpay) => promptpay() | binary(),
  optional(:cashapp) => cashapp() | binary(),
  optional(:oxxo) => oxxo() | binary(),
  optional(:interac_present) => map() | binary(),
  optional(:us_bank_account) => us_bank_account() | binary(),
  optional(:zip) => zip() | binary(),
  optional(:paypal) => paypal() | binary(),
  optional(:boleto) => boleto() | binary(),
  optional(:konbini) => konbini() | binary(),
  optional(:blik) => blik() | binary(),
  optional(:wechat_pay) => wechat_pay() | binary(),
  optional(:sofort) => sofort() | binary(),
  optional(:p24) => p24() | binary(),
  optional(:afterpay_clearpay) => afterpay_clearpay() | binary(),
  optional(:grabpay) => grabpay() | binary(),
  optional(:bancontact) => bancontact() | binary(),
  optional(:au_becs_debit) => au_becs_debit() | binary(),
  optional(:customer_balance) => customer_balance() | binary(),
  optional(:card_present) => card_present() | binary(),
  optional(:sepa_debit) => sepa_debit() | binary(),
  optional(:klarna) => klarna() | binary(),
  optional(:paynow) => paynow() | binary(),
  optional(:eps) => eps() | binary()
}

Payment method-specific configuration for this PaymentIntent.

Link to this type

paynow()

View Source 
@type paynow() :: %{optional(:setup_future_usage) => :none}
Link to this type

paypal()

View Source 
@type paypal() :: %{
  optional(:capture_method) => :manual,
  optional(:preferred_locale) =>
    :"cs-CZ"
    | :"da-DK"
    | :"de-AT"
    | :"de-DE"
    | :"de-LU"
    | :"el-GR"
    | :"en-GB"
    | :"en-US"
    | :"es-ES"
    | :"fi-FI"
    | :"fr-BE"
    | :"fr-FR"
    | :"fr-LU"
    | :"hu-HU"
    | :"it-IT"
    | :"nl-BE"
    | :"nl-NL"
    | :"pl-PL"
    | :"pt-PT"
    | :"sk-SK"
    | :"sv-SE",
  optional(:reference) => binary(),
  optional(:risk_correlation_id) => binary(),
  optional(:setup_future_usage) => :none | :off_session
}
Link to this type

pix()

View Source 
@type pix() :: %{
  optional(:expires_after_seconds) => integer(),
  optional(:expires_at) => integer(),
  optional(:setup_future_usage) => :none
}
Link to this type

plan()

View Source 
@type plan() :: %{
  optional(:count) => integer(),
  optional(:interval) => :month,
  optional(:type) => :fixed_count
}
Link to this type

promptpay()

View Source 
@type promptpay() :: %{optional(:setup_future_usage) => :none}
Link to this type

radar_options()

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

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

Link to this type

revolut_pay()

View Source 
@type revolut_pay() :: %{optional(:setup_future_usage) => :none | :off_session}
Link to this type

sepa_debit()

View Source 
@type sepa_debit() :: %{
  optional(:mandate_options) => map(),
  optional(:setup_future_usage) => :none | :off_session | :on_session
}
Link to this type

shipping()

View Source 
@type shipping() :: %{
  optional(:address) => address(),
  optional(:carrier) => binary(),
  optional(:name) => binary(),
  optional(:phone) => binary(),
  optional(:tracking_number) => binary()
}

Shipping information for this PaymentIntent.

Link to this type

sofort()

View Source 
@type sofort() :: %{
  optional(:preferred_language) => :de | :en | :es | :fr | :it | :nl | :pl,
  optional(:setup_future_usage) => :none | :off_session
}
Link to this type

t()

View Source 
@type t() :: %Stripe.PaymentIntent{
  amount: integer(),
  amount_capturable: integer(),
  amount_details: term(),
  amount_received: integer(),
  application: (binary() | term()) | nil,
  application_fee_amount: integer() | nil,
  automatic_payment_methods: term() | nil,
  canceled_at: integer() | nil,
  cancellation_reason: binary() | nil,
  capture_method: binary(),
  client_secret: binary() | nil,
  confirmation_method: binary(),
  created: integer(),
  currency: binary(),
  customer: (binary() | Stripe.Customer.t() | Stripe.DeletedCustomer.t()) | nil,
  description: binary() | nil,
  id: binary(),
  invoice: (binary() | Stripe.Invoice.t()) | nil,
  last_payment_error: Stripe.ApiErrors.t() | nil,
  latest_charge: (binary() | Stripe.Charge.t()) | nil,
  livemode: boolean(),
  metadata: term(),
  next_action: term() | nil,
  object: binary(),
  on_behalf_of: (binary() | Stripe.Account.t()) | nil,
  payment_method: (binary() | Stripe.PaymentMethod.t()) | nil,
  payment_method_configuration_details: term() | nil,
  payment_method_options: term() | nil,
  payment_method_types: term(),
  processing: term() | nil,
  receipt_email: binary() | nil,
  review: (binary() | Stripe.Review.t()) | nil,
  setup_future_usage: binary() | nil,
  shipping: term() | nil,
  source:
    (binary() | Stripe.PaymentSource.t() | Stripe.DeletedPaymentSource.t())
    | nil,
  statement_descriptor: binary() | nil,
  statement_descriptor_suffix: binary() | nil,
  status: binary(),
  transfer_data: term() | nil,
  transfer_group: binary() | nil
}

The payment_intent type.

  • amount Amount intended to be collected by this PaymentIntent. A positive integer representing how much to charge in the smallest currency unit (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The minimum amount is $0.50 US or equivalent in charge currency. The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99).
  • amount_capturable Amount that can be captured from this PaymentIntent.
  • amount_details
  • amount_received Amount that this PaymentIntent collects.
  • application ID of the Connect application that created the PaymentIntent.
  • application_fee_amount The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. The amount of the application fee collected will be capped at the total payment amount. For more information, see the PaymentIntents use case for connected accounts.
  • automatic_payment_methods Settings to configure compatible payment methods from the Stripe Dashboard
  • canceled_at Populated when status is canceled, this is the time at which the PaymentIntent was canceled. Measured in seconds since the Unix epoch.
  • cancellation_reason Reason for cancellation of this PaymentIntent, either user-provided (duplicate, fraudulent, requested_by_customer, or abandoned) or generated by Stripe internally (failed_invoice, void_invoice, or automatic).
  • capture_method Controls when the funds will be captured from the customer's account.
  • client_secret The client secret of this PaymentIntent. Used for client-side retrieval using a publishable key.

The client secret can be used to complete a payment from your frontend. It should not be stored, logged, or exposed to anyone other than the customer. Make sure that you have TLS enabled on any page that includes the client secret.

Refer to our docs to accept a payment and learn about how client_secret should be handled.

  • confirmation_method Describes whether we can confirm this PaymentIntent automatically, or if it requires customer action to confirm the payment.
  • created Time at which the object was created. Measured in seconds since the Unix epoch.
  • currency Three-letter ISO currency code, in lowercase. Must be a supported currency.
  • customer ID of the Customer this PaymentIntent belongs to, if one exists.

Payment methods attached to other Customers cannot be used with this PaymentIntent.

If present in combination with setup_future_usage, this PaymentIntent's payment method will be attached to the Customer after the PaymentIntent has been confirmed and any required actions from the user are complete.

  • description An arbitrary string attached to the object. Often useful for displaying to users.
  • id Unique identifier for the object.
  • invoice ID of the invoice that created this PaymentIntent, if it exists.
  • last_payment_error The payment error encountered in the previous PaymentIntent confirmation. It will be cleared if the PaymentIntent is later updated for any reason.
  • latest_charge The latest charge created by this PaymentIntent.
  • livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
  • 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. Learn more about storing information in metadata.
  • next_action If present, this property tells you what actions you need to take in order for your customer to fulfill a payment using the provided source.
  • object String representing the object's type. Objects of the same type share the same value.
  • on_behalf_of The account (if any) for which the funds of the PaymentIntent are intended. See the PaymentIntents use case for connected accounts for details.
  • payment_method ID of the payment method used in this PaymentIntent.
  • payment_method_configuration_details Information about the payment method configuration used for this PaymentIntent.
  • payment_method_options Payment-method-specific configuration for this PaymentIntent.
  • payment_method_types The list of payment method types (e.g. card) that this PaymentIntent is allowed to use.
  • processing If present, this property tells you about the processing state of the payment.
  • 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.
  • review ID of the review associated with this PaymentIntent, if any.
  • setup_future_usage Indicates that you intend to make future payments with this PaymentIntent's payment method.

Providing this parameter 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. If no Customer was provided, the payment method can still be attached to a Customer after the transaction completes.

When processing card payments, Stripe also uses setup_future_usage to dynamically optimize your payment flow and comply with regional legislation and network rules, such as SCA.

  • shipping Shipping information for this PaymentIntent.
  • source This is a legacy field that will be removed in the future. It is the ID of the Source object that is associated with this PaymentIntent, if one was supplied.
  • statement_descriptor For card charges, use statement_descriptor_suffix. Otherwise, you can use this value as the complete description of a charge on your customers' statements. It must contain at least one letter and be 1–22 characters long.
  • statement_descriptor_suffix Provides information about a card payment that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters for the concatenated descriptor.
  • status Status of this PaymentIntent, one of requires_payment_method, requires_confirmation, requires_action, processing, requires_capture, canceled, or succeeded. Read more about each PaymentIntent status.
  • transfer_data The data that automatically creates a Transfer after the payment finalizes. Learn more about the use case for connected accounts.
  • transfer_group A string that identifies the resulting payment as part of a group. Learn more about the use case for connected accounts.
Link to this type

three_d_secure()

View Source 
@type three_d_secure() :: %{
  optional(:ares_trans_status) => :A | :C | :I | :N | :R | :U | :Y,
  optional(:cryptogram) => binary(),
  optional(:electronic_commerce_indicator) =>
    :"01" | :"02" | :"05" | :"06" | :"07",
  optional(:exemption_indicator) => :low_risk | :none,
  optional(:network_options) => network_options(),
  optional(:requestor_challenge_indicator) => binary(),
  optional(:transaction_id) => binary(),
  optional(:version) => :"1.0.2" | :"2.1.0" | :"2.2.0"
}

If 3D Secure authentication was performed with a third-party provider, the authentication details to use for this payment.

Link to this type

transfer_data()

View Source 
@type transfer_data() :: %{
  optional(:amount) => integer(),
  optional(:destination) => binary()
}

The parameters that you can use to automatically create a Transfer. Learn more about the use case for connected accounts.

Link to this type

us_bank_account()

View Source 
@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.

Link to this type

wechat_pay()

View Source 
@type wechat_pay() :: %{
  optional(:app_id) => binary(),
  optional(:client) => :android | :ios | :web,
  optional(:setup_future_usage) => :none
}
Link to this type

zip()

View Source 
@type zip() :: %{optional(:setup_future_usage) => :none}

Functions

Link to this function

apply_customer_balance(intent, params \\ %{}, opts \\ [])

View Source 
@spec apply_customer_balance(
  intent :: binary(),
  params :: %{
    optional(:amount) => integer(),
    optional(:currency) => binary(),
    optional(:expand) => [binary()]
  },
  opts :: Keyword.t()
) :: {:ok, t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()}

Manually reconcile the remaining amount for a customer_balance PaymentIntent.

Details

  • Method: post
  • Path: /v1/payment_intents/{intent}/apply_customer_balance
Link to this function

cancel(intent, params \\ %{}, opts \\ [])

View Source 
@spec cancel(
  intent :: binary(),
  params :: %{
    optional(:cancellation_reason) =>
      :abandoned | :duplicate | :fraudulent | :requested_by_customer,
    optional(:expand) => [binary()]
  },
  opts :: Keyword.t()
) :: {:ok, t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()}

You can cancel a PaymentIntent object when it’s in one of these statuses: requires_payment_method, requires_capture, requires_confirmation, requires_action or, in rare cases, processing.

After it’s canceled, no additional charges are made by the PaymentIntent and any operations on the PaymentIntent fail with an error. For PaymentIntents with a status of requires_capture, the remaining amount_capturable is automatically refunded.

You can’t cancel the PaymentIntent for a Checkout Session. Expire the Checkout Session instead.

Details

  • Method: post
  • Path: /v1/payment_intents/{intent}/cancel
Link to this function

capture(intent, params \\ %{}, opts \\ [])

View Source 
@spec capture(
  intent :: binary(),
  params :: %{
    optional(:amount_to_capture) => integer(),
    optional(:application_fee_amount) => integer(),
    optional(:expand) => [binary()],
    optional(:final_capture) => boolean(),
    optional(:metadata) => %{optional(binary()) => binary()} | binary(),
    optional(:statement_descriptor) => binary(),
    optional(:statement_descriptor_suffix) => binary(),
    optional(:transfer_data) => transfer_data()
  },
  opts :: Keyword.t()
) :: {:ok, t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()}

Capture the funds of an existing uncaptured PaymentIntent when its status is requires_capture.

Uncaptured PaymentIntents are cancelled a set number of days (7 by default) after their creation.

Learn more about separate authorization and capture.

Details

  • Method: post
  • Path: /v1/payment_intents/{intent}/capture
Link to this function

confirm(intent, params \\ %{}, opts \\ [])

View Source 
@spec confirm(
  intent :: binary(),
  params :: %{
    optional(:capture_method) => :automatic | :automatic_async | :manual,
    optional(:error_on_requires_action) => boolean(),
    optional(:expand) => [binary()],
    optional(:mandate) => binary(),
    optional(:mandate_data) => mandate_data() | binary() | mandate_data(),
    optional(:off_session) => boolean() | :one_off | :recurring,
    optional(:payment_method) => binary(),
    optional(:payment_method_data) => payment_method_data(),
    optional(:payment_method_options) => payment_method_options(),
    optional(:radar_options) => radar_options(),
    optional(:receipt_email) => binary() | binary(),
    optional(:return_url) => binary(),
    optional(:setup_future_usage) => :off_session | :on_session,
    optional(:shipping) => shipping() | binary(),
    optional(:use_stripe_sdk) => boolean()
  },
  opts :: Keyword.t()
) :: {:ok, t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()}

Confirm that your customer intends to pay with current or providedpayment method. Upon confirmation, the PaymentIntent will attempt to initiate a payment. If the selected payment method requires additional authentication steps, the PaymentIntent will transition to the requires_action status and suggest additional actions via next_action. If payment fails, the PaymentIntent transitions to the requires_payment_method status or the canceled status if the confirmation limit is reached. If payment succeeds, the PaymentIntent will transition to the succeeded status (or requires_capture, if capture_method is set to manual). If the confirmation_method is automatic, payment may be attempted using our client SDKs and the PaymentIntent’s client_secret. After next_actions are handled by the client, no additional confirmation is required to complete the payment. If the confirmation_method is manual, all payment attempts must be initiated using a secret key. If any actions are required for the payment, the PaymentIntent will return to the requires_confirmation state after those actions are completed. Your server needs to then explicitly re-confirm the PaymentIntent to initiate the next payment attempt. Read the expanded documentation to learn more about manual confirmation.

#### Details * Method: `post` * Path: `/v1/payment_intents/{intent}/confirm`

Link to this function

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

View Source 
@spec create(
  params :: %{
    optional(:amount) => integer(),
    optional(:application_fee_amount) => integer(),
    optional(:automatic_payment_methods) => automatic_payment_methods(),
    optional(:capture_method) => :automatic | :automatic_async | :manual,
    optional(:confirm) => boolean(),
    optional(:confirmation_method) => :automatic | :manual,
    optional(:currency) => binary(),
    optional(:customer) => binary(),
    optional(:description) => binary(),
    optional(:error_on_requires_action) => boolean(),
    optional(:expand) => [binary()],
    optional(:mandate) => binary(),
    optional(:mandate_data) => mandate_data() | binary(),
    optional(:metadata) => %{optional(binary()) => binary()},
    optional(:off_session) => boolean() | :one_off | :recurring,
    optional(:on_behalf_of) => binary(),
    optional(:payment_method) => binary(),
    optional(:payment_method_configuration) => binary(),
    optional(:payment_method_data) => payment_method_data(),
    optional(:payment_method_options) => payment_method_options(),
    optional(:payment_method_types) => [binary()],
    optional(:radar_options) => radar_options(),
    optional(:receipt_email) => binary(),
    optional(:return_url) => binary(),
    optional(:setup_future_usage) => :off_session | :on_session,
    optional(:shipping) => shipping(),
    optional(:statement_descriptor) => binary(),
    optional(:statement_descriptor_suffix) => binary(),
    optional(:transfer_data) => transfer_data(),
    optional(:transfer_group) => binary(),
    optional(:use_stripe_sdk) => boolean()
  },
  opts :: Keyword.t()
) :: {:ok, t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()}

Creates a PaymentIntent object.

After the PaymentIntent is created, attach a payment method and confirmto continue the payment. Learn more about the available payment flows with the Payment Intents API.

When you use confirm=true during creation, it’s equivalent to creatingand confirming the PaymentIntent in the same call. You can use any parameters available in the confirm API when you supply confirm=true.

#### Details * Method: `post` * Path: `/v1/payment_intents`

Link to this function

increment_authorization(intent, params \\ %{}, opts \\ [])

View Source 
@spec increment_authorization(
  intent :: binary(),
  params :: %{
    optional(:amount) => integer(),
    optional(:application_fee_amount) => integer(),
    optional(:description) => binary(),
    optional(:expand) => [binary()],
    optional(:metadata) => %{optional(binary()) => binary()},
    optional(:statement_descriptor) => binary(),
    optional(:transfer_data) => transfer_data()
  },
  opts :: Keyword.t()
) :: {:ok, t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()}

Perform an incremental authorization on an eligiblePaymentIntent. To be eligible, the PaymentIntent’s status must be requires_capture and incremental_authorization_supported must be true.

Incremental authorizations attempt to increase the authorized amount onyour customer’s card to the new, higher amount provided. Similar to the initial authorization, incremental authorizations can be declined. A single PaymentIntent can call this endpoint multiple times to further increase the authorized amount.

If the incremental authorization succeeds, the PaymentIntent objectreturns with the updated amount. If the incremental authorization fails, a card_declined error returns, and no other fields on the PaymentIntent or Charge update. The PaymentIntent object remains capturable for the previously authorized amount.

Each PaymentIntent can have a maximum of 10 incremental authorization attempts, including declines.After it’s captured, a PaymentIntent can no longer be incremented.

Learn more about incremental authorizations.

#### Details * Method: `post` * Path: `/v1/payment_intents/{intent}/increment_authorization`

Link to this function

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

View Source 
@spec list(
  params :: %{
    optional(:created) => created() | integer(),
    optional(:customer) => binary(),
    optional(:ending_before) => binary(),
    optional(:expand) => [binary()],
    optional(:limit) => integer(),
    optional(:starting_after) => binary()
  },
  opts :: Keyword.t()
) ::
  {:ok, Stripe.List.t(t())} | {:error, Stripe.ApiErrors.t()} | {:error, term()}

Returns a list of PaymentIntents.

Details

  • Method: get
  • Path: /v1/payment_intents
Link to this function

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

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

Retrieves the details of a PaymentIntent that has previously been created.

You can retrieve a PaymentIntent client-side using a publishable key when the client_secret is in the query string.

If you retrieve a PaymentIntent with a publishable key, it only returns a subset of properties. Refer to the payment intent object reference for more details.

Details

  • Method: get
  • Path: /v1/payment_intents/{intent}
Link to this function

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

View Source 
@spec search(
  params :: %{
    optional(:expand) => [binary()],
    optional(:limit) => integer(),
    optional(:page) => binary(),
    optional(:query) => binary()
  },
  opts :: Keyword.t()
) ::
  {:ok, Stripe.SearchResult.t(t())}
  | {:error, Stripe.ApiErrors.t()}
  | {:error, term()}

Search for PaymentIntents you’ve previously created using Stripe’s Search Query Language.Don’t use search in read-after-write flows where strict consistency is necessary. Under normal operating conditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up to an hour behind during outages. Search functionality is not available to merchants in India.

#### Details * Method: `get` * Path: `/v1/payment_intents/search`

Link to this function

update(intent, params \\ %{}, opts \\ [])

View Source 
@spec update(
  intent :: binary(),
  params :: %{
    optional(:amount) => integer(),
    optional(:application_fee_amount) => integer() | binary(),
    optional(:capture_method) => :automatic | :automatic_async | :manual,
    optional(:currency) => binary(),
    optional(:customer) => binary(),
    optional(:description) => binary(),
    optional(:expand) => [binary()],
    optional(:metadata) => %{optional(binary()) => binary()} | binary(),
    optional(:payment_method) => binary(),
    optional(:payment_method_configuration) => binary(),
    optional(:payment_method_data) => payment_method_data(),
    optional(:payment_method_options) => payment_method_options(),
    optional(:payment_method_types) => [binary()],
    optional(:receipt_email) => binary() | binary(),
    optional(:setup_future_usage) => :off_session | :on_session,
    optional(:shipping) => shipping() | binary(),
    optional(:statement_descriptor) => binary(),
    optional(:statement_descriptor_suffix) => binary(),
    optional(:transfer_data) => transfer_data(),
    optional(:transfer_group) => binary()
  },
  opts :: Keyword.t()
) :: {:ok, t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()}

Updates properties on a PaymentIntent object without confirming.

Depending on which properties you update, you might need to confirm thePaymentIntent again. For example, updating the payment_method always requires you to confirm the PaymentIntent again. If you prefer to update and confirm at the same time, we recommend updating properties through the confirm API instead.

#### Details * Method: `post` * Path: `/v1/payment_intents/{intent}`

Link to this function

verify_microdeposits(intent, params \\ %{}, opts \\ [])

View Source 
@spec verify_microdeposits(
  intent :: binary(),
  params :: %{
    optional(:amounts) => [integer()],
    optional(:descriptor_code) => binary(),
    optional(:expand) => [binary()]
  },
  opts :: Keyword.t()
) :: {:ok, t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()}

Verifies microdeposits on a PaymentIntent object.

Details

  • Method: post
  • Path: /v1/payment_intents/{intent}/verify_microdeposits