Expand description
This crate provides Rust bindings to the Stripe HTTP API, specifically
for requests mentioned in the Payment Methods
and Payment Links
sections
of the Stripe API docs
Modules§
- bank_
account - card
- confirmation_
token - payment_
link - payment_
method - payment_
method_ configuration - payment_
method_ domain - source
Structs§
- Amazon
PayUnderlying Payment Method Funding Details - Bank
Account - These bank accounts are payment methods on
Customer
objects. - Bank
Account Id - Card
- You can store multiple cards on a customer in order to charge the customer later. You can also store multiple debit cards on a recipient in order to transfer to those cards later.
- Card
Generated From Payment Method Details - CardId
- Card
Issuing Account Terms OfService - Card
Mandate Payment Method Details - Confirmation
Token - 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.
- Confirmation
Token Id - Confirmation
Tokens Resource Mandate Data - Data used for generating a Mandate.
- Confirmation
Tokens Resource Mandate Data Builder - Confirmation
Tokens Resource Mandate Data Resource Customer Acceptance - This hash contains details about the customer acceptance of the Mandate.
- Confirmation
Tokens Resource Mandate Data Resource Customer Acceptance Builder - Confirmation
Tokens Resource Mandate Data Resource Customer Acceptance Resource Online - This hash contains details about the online acceptance.
- Confirmation
Tokens Resource Mandate Data Resource Customer Acceptance Resource Online Builder - Confirmation
Tokens Resource Payment Method Options - Payment-method-specific configuration
- Confirmation
Tokens Resource Payment Method Options Builder - Confirmation
Tokens Resource Payment Method Options Resource Card - This hash contains the card payment method options.
- Confirmation
Tokens Resource Payment Method Options Resource Card Builder - Confirmation
Tokens Resource Payment Method Options Resource Card Resource Installment - Installment configuration for payments.
- Confirmation
Tokens Resource Payment Method Options Resource Card Resource Installment Builder - Confirmation
Tokens Resource Payment Method Preview - Details of the PaymentMethod collected by Payment Element
- Confirmation
Tokens Resource Payment Method Preview Builder - Confirmation
Tokens Resource Shipping - Confirmation
Tokens Resource Shipping Builder - Deleted
Bank Account - Deleted
Card - Deleted
External Account Builder - Deleted
Payment Source Builder - External
Account Requirements - Internal
Card - Klarna
Address - Klarna
Payer Details - Networks
- Payment
Flows Private Payment Methods Alipay - Payment
Flows Private Payment Methods Alipay Details - Payment
Flows Private Payment Methods Card Details ApiResource Enterprise Features Extended Authorization Extended Authorization - Payment
Flows Private Payment Methods Card Details ApiResource Enterprise Features Incremental Authorization Incremental Authorization - Payment
Flows Private Payment Methods Card Details ApiResource Enterprise Features Overcapture Overcapture - Payment
Flows Private Payment Methods Card Details ApiResource Multicapture - Payment
Flows Private Payment Methods Card Present Common Wallet - Payment
Flows Private Payment Methods Klarna Dob - Payment
Link - A payment link is a shareable URL that will take your customers to a hosted payment page. A payment link can be shared and used multiple times.
- Payment
Link Id - Payment
Links Resource After Completion - Payment
Links Resource Automatic Tax - Payment
Links Resource Completed Sessions - Payment
Links Resource Completion Behavior Confirmation Page - Payment
Links Resource Completion Behavior Redirect - Payment
Links Resource Consent Collection - Payment
Links Resource Custom Fields - Payment
Links Resource Custom Fields Dropdown - Payment
Links Resource Custom Fields Dropdown Option - Payment
Links Resource Custom Fields Label - Payment
Links Resource Custom Fields Numeric - Payment
Links Resource Custom Fields Text - Payment
Links Resource Custom Text - Payment
Links Resource Custom Text Position - Payment
Links Resource Invoice Creation - Payment
Links Resource Invoice Settings - Payment
Links Resource Optional Item - Payment
Links Resource Optional Item Adjustable Quantity - Payment
Links Resource Payment Intent Data - Payment
Links Resource Payment Method Reuse Agreement - Payment
Links Resource Phone Number Collection - Payment
Links Resource Restrictions - Payment
Links Resource Shipping Address Collection - Payment
Links Resource Shipping Option - Payment
Links Resource Subscription Data - Payment
Links Resource Subscription Data Invoice Settings - Payment
Links Resource TaxId Collection - Payment
Links Resource Transfer Data - Payment
Method - PaymentMethod objects represent your customer’s payment instruments. You can use them with PaymentIntents to collect payments or save them to. Customer objects to store instrument details for future payments.
- Payment
Method Acss Debit - Payment
Method Affirm - Payment
Method Afterpay Clearpay - Payment
Method Alma - Payment
Method Amazon Pay - Payment
Method AuBecs Debit - Payment
Method Bacs Debit - Payment
Method Bancontact - Payment
Method Billie - Payment
Method Blik - Payment
Method Boleto - Payment
Method Card - Payment
Method Card Checks - Payment
Method Card Generated Card - Payment
Method Card Present - Payment
Method Card Present Networks - Payment
Method Card Wallet - Payment
Method Card Wallet Amex Express Checkout - Payment
Method Card Wallet Apple Pay - Payment
Method Card Wallet Google Pay - Payment
Method Card Wallet Link - Payment
Method Card Wallet Masterpass - Payment
Method Card Wallet Samsung Pay - Payment
Method Card Wallet Visa Checkout - Payment
Method Cashapp - Payment
Method Config BizPayment Method Configuration Details - Payment
Method Config Resource Display Preference - Payment
Method Config Resource Display Preference Builder - Payment
Method Config Resource Payment Method Properties - Payment
Method Config Resource Payment Method Properties Builder - Payment
Method Configuration - PaymentMethodConfigurations control which payment methods are displayed to your customers when you don’t explicitly specify payment method types. You can have multiple configurations with different sets of payment methods for different scenarios.
- Payment
Method Configuration Id - Payment
Method Customer Balance - Payment
Method Details - Payment
Method Details AchCredit Transfer - Payment
Method Details AchDebit - Payment
Method Details Acss Debit - Payment
Method Details Affirm - Payment
Method Details Afterpay Clearpay - Payment
Method Details Alma - Payment
Method Details Amazon Pay - Payment
Method Details AuBecs Debit - Payment
Method Details Bacs Debit - Payment
Method Details Bancontact - Payment
Method Details Billie - Payment
Method Details Blik - Payment
Method Details Boleto - Payment
Method Details Card - Payment
Method Details Card Checks - Payment
Method Details Card Installments - Payment
Method Details Card Installments Plan - Payment
Method Details Card Network Token - Payment
Method Details Card Present - Payment
Method Details Card Present Offline - Payment
Method Details Card Present Receipt - Payment
Method Details Card Wallet - Payment
Method Details Card Wallet Amex Express Checkout - Payment
Method Details Card Wallet Apple Pay - Payment
Method Details Card Wallet Google Pay - Payment
Method Details Card Wallet Link - Payment
Method Details Card Wallet Masterpass - Payment
Method Details Card Wallet Samsung Pay - Payment
Method Details Card Wallet Visa Checkout - Payment
Method Details Cashapp - Payment
Method Details Customer Balance - Payment
Method Details Eps - Payment
Method Details Fpx - Payment
Method Details Giropay - Payment
Method Details Grabpay - Payment
Method Details Ideal - Payment
Method Details Interac Present - Payment
Method Details Interac Present Receipt - Payment
Method Details Kakao Pay - Payment
Method Details Klarna - Payment
Method Details Konbini - Payment
Method Details Konbini Store - Payment
Method Details KrCard - Payment
Method Details Link - Payment
Method Details Mobilepay - Payment
Method Details Multibanco - Payment
Method Details Naver Pay - Payment
Method Details NzBank Account - Payment
Method Details Oxxo - Payment
Method Details P24 - Payment
Method Details Passthrough Card - Payment
Method Details PayBy Bank - Payment
Method Details Payco - Payment
Method Details Paynow - Payment
Method Details Paypal - Payment
Method Details Pix - Payment
Method Details Promptpay - Payment
Method Details Revolut Pay - Payment
Method Details Samsung Pay - Payment
Method Details Satispay - Payment
Method Details Sepa Credit Transfer - Payment
Method Details Sepa Debit - Payment
Method Details Sofort - Payment
Method Details Stripe Account - Payment
Method Details Swish - Payment
Method Details Twint - Payment
Method Details UsBank Account - Payment
Method Details Wechat - Payment
Method Details Wechat Pay - Payment
Method Details Zip - Payment
Method Domain - A payment method domain represents a web domain that you have registered with Stripe. Stripe Elements use registered payment method domains to control where certain payment methods are shown.
- Payment
Method Domain Id - Payment
Method Domain Resource Payment Method Status - Indicates the status of a specific payment method on a payment method domain.
- Payment
Method Domain Resource Payment Method Status Builder - Payment
Method Domain Resource Payment Method Status Details - Contains additional details about the status of a payment method for a specific payment method domain.
- Payment
Method Domain Resource Payment Method Status Details Builder - Payment
Method Eps - Payment
Method Fpx - Payment
Method Giropay - Payment
Method Grabpay - Payment
Method Id - Payment
Method Ideal - Payment
Method Interac Present - Payment
Method Kakao Pay - Payment
Method Klarna - Payment
Method Konbini - Payment
Method KrCard - Payment
Method Link - Payment
Method Mobilepay - Payment
Method Multibanco - Payment
Method Naver Pay - Payment
Method NzBank Account - Payment
Method Options Affirm - Payment
Method Options Afterpay Clearpay - Payment
Method Options Alipay - Payment
Method Options Alma - Payment
Method Options Amazon Pay - Payment
Method Options Bancontact - Payment
Method Options Billie - Payment
Method Options Boleto - Payment
Method Options Card Installments - Payment
Method Options Card Mandate Options - Payment
Method Options Card Present - Payment
Method Options Card Present Routing - Payment
Method Options Cashapp - Payment
Method Options Customer Balance - Payment
Method Options Customer Balance Bank Transfer - Payment
Method Options Customer Balance EuBank Account - Payment
Method Options Fpx - Payment
Method Options Giropay - Payment
Method Options Grabpay - Payment
Method Options Ideal - Payment
Method Options Interac Present - Payment
Method Options Klarna - Payment
Method Options Konbini - Payment
Method Options KrCard - Payment
Method Options Multibanco - Payment
Method Options Oxxo - Payment
Method Options P24 - Payment
Method Options PayBy Bank - Payment
Method Options Paynow - Payment
Method Options Paypal - Payment
Method Options Pix - Payment
Method Options Promptpay - Payment
Method Options Revolut Pay - Payment
Method Options Sofort - Payment
Method Options Twint - Payment
Method Options UsBank Account Mandate Options - Payment
Method Options Wechat Pay - Payment
Method Options Zip - Payment
Method Oxxo - Payment
Method P24 - Payment
Method PayBy Bank - Payment
Method Payco - Payment
Method Paynow - Payment
Method Paypal - Payment
Method Pix - Payment
Method Promptpay - Payment
Method Revolut Pay - Payment
Method Samsung Pay - Payment
Method Satispay - Payment
Method Sepa Debit - Payment
Method Sofort - Payment
Method Swish - Payment
Method Twint - Payment
Method UsBank Account - Payment
Method UsBank Account Blocked - Payment
Method UsBank Account Status Details - Payment
Method Wechat Pay - Payment
Method Zip - Paypal
Seller Protection - Revolut
PayUnderlying Payment Method Funding Details - Sepa
Debit Generated From - Source
Source
objects allow you to accept a variety of payment methods. They represent a customer’s payment instrument, and can be used with the Stripe API just like aCard
object: once chargeable, they can be charged, or can be attached to customers.- Source
Code Verification Flow - Source
Id - Source
Mandate Notification - Source mandate notifications should be created when a notification related to a source mandate must be sent to the payer. They will trigger a webhook or deliver an email to the customer.
- Source
Mandate Notification Acss Debit Data - Source
Mandate Notification Acss Debit Data Builder - Source
Mandate Notification Bacs Debit Data - Source
Mandate Notification Bacs Debit Data Builder - Source
Mandate Notification Builder - Source
Mandate Notification Id - Source
Mandate Notification Sepa Debit Data - Source
Mandate Notification Sepa Debit Data Builder - Source
Order - Source
Order Item - Source
Owner - Source
Receiver Flow - Source
Redirect Flow - Source
Transaction - Some payment methods have no required amount that a customer must send. Customers can be instructed to send any amount, and it can be made up of multiple transactions. As such, sources can have multiple associated transactions.
- Source
Transaction AchCredit Transfer Data - Source
Transaction ChfCredit Transfer Data - Source
Transaction GbpCredit Transfer Data - Source
Transaction Id - Source
Transaction Paper Check Data - Source
Transaction Sepa Credit Transfer Data - Source
Type AchCredit Transfer - Source
Type AchDebit - Source
Type Acss Debit - Source
Type Alipay - Source
Type AuBecs Debit - Source
Type Bancontact - Source
Type Card - Source
Type Card Present - Source
Type Eps - Source
Type Giropay - Source
Type Ideal - Source
Type Klarna - Source
Type Multibanco - Source
Type P24 - Source
Type Sepa Credit Transfer - Source
Type Sepa Debit - Source
Type Sofort - Source
Type ThreeD Secure - Source
Type Wechat - ThreeD
Secure Details Charge - ThreeD
Secure Usage - UsBank
Account Networks
Enums§
- Amazon
PayUnderlying Payment Method Funding Details Type - funding type of the underlying payment method.
- Bank
Account Available Payout Methods - A set of available payout methods for this bank account.
Only values from this set should be passed as the
method
when creating a payout. - Card
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”.
- Card
Available Payout Methods - A set of available payout methods for this card.
Only values from this set should be passed as the
method
when creating a payout. - Card
Regulated Status - Status of a card based on the card issuer.
- Confirmation
Token Setup Future Usage - Confirmation
Tokens Resource Payment Method Preview 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”.
- Confirmation
Tokens Resource Payment Method Preview 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.
- Deleted
External Account - The resource representing a Stripe Polymorphic
- Deleted
Payment Source - The resource representing a Stripe Polymorphic
- Payment
Flows Private Payment Methods Card Details ApiResource Enterprise Features Extended Authorization Extended Authorization Status - Indicates whether or not the capture window is extended beyond the standard authorization.
- Payment
Flows Private Payment Methods Card Details ApiResource Enterprise Features Incremental Authorization Incremental Authorization Status - Indicates whether or not the incremental authorization feature is supported.
- Payment
Flows Private Payment Methods Card Details ApiResource Enterprise Features Overcapture Overcapture Status - Indicates whether or not the authorized amount can be over-captured.
- Payment
Flows Private Payment Methods Card Details ApiResource Multicapture Status - Indicates whether or not multiple captures are supported.
- Payment
Flows Private Payment Methods Card Present Common Wallet Type - The type of mobile wallet, one of
apple_pay
,google_pay
,samsung_pay
, orunknown
. - Payment
Link Billing Address Collection - Payment
Link Customer Creation - Configuration for Customer creation during checkout.
- Payment
Link Payment Method Collection - Configuration for collecting a payment method during checkout. Defaults to
always
. - Payment
Link Payment Method Types - Payment
Link Submit Type - Payment
Links Resource After Completion Type - The specified behavior after the purchase is complete.
- Payment
Links Resource Consent Collection Promotions - If set to
auto
, enables the collection of customer consent for promotional communications. - Payment
Links Resource Consent Collection Terms OfService - If set to
required
, it requires cutomers to accept the terms of service before being able to pay. If set tonone
, customers won’t be shown a checkbox to accept the terms of service. - Payment
Links Resource Custom Fields Label Type - The type of the label.
- Payment
Links Resource Custom Fields Type - The type of the field.
- Payment
Links Resource Payment Intent Data Capture Method - Indicates when the funds will be captured from the customer’s account.
- Payment
Links Resource Payment Intent Data Setup Future Usage - Indicates that you intend to make future payments with the payment method collected during checkout.
- Payment
Links Resource Payment Method Reuse Agreement Position - Determines the position and visibility of the payment method reuse agreement in the UI.
When set to
auto
, Stripe’s defaults will be used. - Payment
Links Resource Shipping Address Collection Allowed Countries - An array of two-letter ISO country codes representing which countries Checkout should provide as options for shipping locations.
Unsupported country codes:
AS, CX, CC, CU, HM, IR, KP, MH, FM, NF, MP, PW, SD, SY, UM, VI
. - Payment
Links Resource TaxId Collection Required - Payment
Method Allow Redisplay - Payment
Method Card Present Read Method - How card details were read in this transaction.
- Payment
Method Card Regulated Status - Status of a card based on the card issuer.
- Payment
Method Card Wallet Type - The type of the card wallet, one of
amex_express_checkout
,apple_pay
,google_pay
,masterpass
,samsung_pay
,visa_checkout
, orlink
. An additional hash is included on the Wallet subhash with a name matching this value. It contains additional information specific to the card wallet type. - Payment
Method Config Resource Display Preference Preference - The account’s display preference.
- Payment
Method Config Resource Display Preference Value - The effective display preference value.
- Payment
Method Details AchDebit Account Holder Type - Type of entity that holds the account. This can be either
individual
orcompany
. - Payment
Method Details Bancontact Preferred Language - Preferred language of the Bancontact authorization page that the customer is redirected to.
Can be one of
en
,de
,fr
, ornl
- Payment
Method Details Card Installments Plan Interval - For
fixed_count
installment plans, this is the interval between installment payments your customer will make to their credit card. One ofmonth
. - Payment
Method Details Card Installments Plan Type - Type of installment plan, one of
fixed_count
. - Payment
Method Details Card Present Offline Type - The method used to process this payment method offline. Only deferred is allowed.
- Payment
Method Details Card Present Read Method - How card details were read in this transaction.
- Payment
Method Details Card Present Receipt Account Type - The type of account being debited or credited
- Payment
Method Details Card Regulated Status - Status of a card based on the card issuer.
- Payment
Method Details Card Wallet Type - The type of the card wallet, one of
amex_express_checkout
,apple_pay
,google_pay
,masterpass
,samsung_pay
,visa_checkout
, orlink
. An additional hash is included on the Wallet subhash with a name matching this value. It contains additional information specific to the card wallet type. - Payment
Method Details EpsBank - The customer’s bank.
Should be one of
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_noe_lb_fur_niederosterreich_u_wien
,hypo_oberosterreich_salzburg_steiermark
,hypo_tirol_bank_ag
,hypo_vorarlberg_bank_ag
,hypo_bank_burgenland_aktiengesellschaft
,marchfelder_bank
,oberbank_ag
,raiffeisen_bankengruppe_osterreich
,schoellerbank_ag
,sparda_bank_wien
,volksbank_gruppe
,volkskreditbank_ag
, orvr_bank_braunau
. - Payment
Method Details FpxAccount Holder Type - Account holder type, if provided. Can be one of
individual
orcompany
. - Payment
Method Details FpxBank - The customer’s bank.
Can be one of
affin_bank
,agrobank
,alliance_bank
,ambank
,bank_islam
,bank_muamalat
,bank_rakyat
,bsn
,cimb
,hong_leong_bank
,hsbc
,kfh
,maybank2u
,ocbc
,public_bank
,rhb
,standard_chartered
,uob
,deutsche_bank
,maybank2e
,pb_enterprise
, orbank_of_china
. - Payment
Method Details Ideal Bank - The customer’s bank.
Can be one of
abn_amro
,asn_bank
,bunq
,handelsbanken
,ing
,knab
,moneyou
,n26
,nn
,rabobank
,regiobank
,revolut
,sns_bank
,triodos_bank
,van_lanschot
, oryoursafe
. - Payment
Method Details Ideal Bic - The Bank Identifier Code of the customer’s bank.
- Payment
Method Details Interac Present Read Method - How card details were read in this transaction.
- Payment
Method Details Interac Present Receipt Account Type - The type of account being debited or credited
- Payment
Method Details Konbini Store Chain - The name of the convenience store chain where the payment was completed.
- Payment
Method Details KrCard Brand - The local credit or debit card brand.
- Payment
Method Details P24Bank - The customer’s bank.
Can be one of
ing
,citi_handlowy
,tmobile_usbugi_bankowe
,plus_bank
,etransfer_pocztowy24
,banki_spbdzielcze
,bank_nowy_bfg_sa
,getin_bank
,velobank
,blik
,noble_pay
,ideabank
,envelobank
,santander_przelew24
,nest_przelew
,mbank_mtransfer
,inteligo
,pbac_z_ipko
,bnp_paribas
,credit_agricole
,toyota_bank
,bank_pekao_sa
,volkswagen_bank
,bank_millennium
,alior_bank
, orboz
. - Payment
Method Details Sofort Preferred Language - Preferred language of the SOFORT authorization page that the customer is redirected to.
Can be one of
de
,en
,es
,fr
,it
,nl
, orpl
- Payment
Method Details UsBank Account Account Holder Type - Account holder type: individual or company.
- Payment
Method Details UsBank Account Account Type - Account type: checkings or savings. Defaults to checking if omitted.
- Payment
Method Domain Resource Payment Method Status Status - The status of the payment method on the domain.
- Payment
Method EpsBank - The customer’s bank.
Should be one of
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_noe_lb_fur_niederosterreich_u_wien
,hypo_oberosterreich_salzburg_steiermark
,hypo_tirol_bank_ag
,hypo_vorarlberg_bank_ag
,hypo_bank_burgenland_aktiengesellschaft
,marchfelder_bank
,oberbank_ag
,raiffeisen_bankengruppe_osterreich
,schoellerbank_ag
,sparda_bank_wien
,volksbank_gruppe
,volkskreditbank_ag
, orvr_bank_braunau
. - Payment
Method FpxAccount Holder Type - Account holder type, if provided. Can be one of
individual
orcompany
. - Payment
Method FpxBank - The customer’s bank, if provided.
Can be one of
affin_bank
,agrobank
,alliance_bank
,ambank
,bank_islam
,bank_muamalat
,bank_rakyat
,bsn
,cimb
,hong_leong_bank
,hsbc
,kfh
,maybank2u
,ocbc
,public_bank
,rhb
,standard_chartered
,uob
,deutsche_bank
,maybank2e
,pb_enterprise
, orbank_of_china
. - Payment
Method Ideal Bank - The customer’s bank, if provided.
Can be one of
abn_amro
,asn_bank
,bunq
,handelsbanken
,ing
,knab
,moneyou
,n26
,nn
,rabobank
,regiobank
,revolut
,sns_bank
,triodos_bank
,van_lanschot
, oryoursafe
. - Payment
Method Ideal Bic - The Bank Identifier Code of the customer’s bank, if the bank was provided.
- Payment
Method Interac Present Read Method - How card details were read in this transaction.
- Payment
Method KrCard Brand - The local credit or debit card brand.
- Payment
Method Naver PayFunding - Whether to fund this transaction with Naver Pay points or a card.
- Payment
Method Options Affirm Capture Method - Controls when the funds will be captured from the customer’s account.
- Payment
Method Options Affirm Setup Future Usage - Indicates that you intend to make future payments with this PaymentIntent’s payment method.
- Payment
Method Options Afterpay Clearpay Capture Method - Controls when the funds will be captured from the customer’s account.
- Payment
Method Options Afterpay Clearpay Setup Future Usage - Indicates that you intend to make future payments with this PaymentIntent’s payment method.
- Payment
Method Options Alipay Setup Future Usage - Indicates that you intend to make future payments with this PaymentIntent’s payment method.
- Payment
Method Options Alma Capture Method - Controls when the funds will be captured from the customer’s account.
- Payment
Method Options Amazon PayCapture Method - Controls when the funds will be captured from the customer’s account.
- Payment
Method Options Amazon PaySetup Future Usage - Indicates that you intend to make future payments with this PaymentIntent’s payment method.
- Payment
Method Options Bancontact Preferred Language - Preferred language of the Bancontact authorization page that the customer is redirected to.
- Payment
Method Options Bancontact Setup Future Usage - Indicates that you intend to make future payments with this PaymentIntent’s payment method.
- Payment
Method Options Boleto Setup Future Usage - Indicates that you intend to make future payments with this PaymentIntent’s payment method.
- Payment
Method Options Card Mandate Options Amount Type - One of
fixed
ormaximum
. Iffixed
, theamount
param refers to the exact amount to be charged in future payments. Ifmaximum
, the amount charged can be up to the value passed for theamount
param. - Payment
Method Options Card Mandate Options Interval - Specifies payment frequency. One of
day
,week
,month
,year
, orsporadic
. - Payment
Method Options Card Mandate Options Supported Types - Specifies the type of mandates supported. Possible values are
india
. - Payment
Method Options Card Present Routing Requested Priority - Requested routing priority
- Payment
Method Options Cashapp Capture Method - Controls when the funds will be captured from the customer’s account.
- Payment
Method Options Cashapp Setup Future Usage - Indicates that you intend to make future payments with this PaymentIntent’s payment method.
- Payment
Method Options Customer Balance Bank Transfer Requested Address Types - List of address types that should be returned in the financial_addresses response. If not specified, all valid types will be returned.
- Payment
Method Options Customer Balance Bank Transfer Type - The bank transfer type that this PaymentIntent is allowed to use for funding Permitted values include:
eu_bank_transfer
,gb_bank_transfer
,jp_bank_transfer
,mx_bank_transfer
, orus_bank_transfer
. - Payment
Method Options Customer Balance EuBank Account Country - The desired country code of the bank account information.
Permitted values include:
BE
,DE
,ES
,FR
,IE
, orNL
. - Payment
Method Options Customer Balance Funding Type - The funding method type to be used when there are not enough funds in the customer balance.
Permitted values include:
bank_transfer
. - Payment
Method Options Customer Balance Setup Future Usage - Indicates that you intend to make future payments with this PaymentIntent’s payment method.
- Payment
Method Options FpxSetup Future Usage - Indicates that you intend to make future payments with this PaymentIntent’s payment method.
- Payment
Method Options Giropay Setup Future Usage - Indicates that you intend to make future payments with this PaymentIntent’s payment method.
- Payment
Method Options Grabpay Setup Future Usage - Indicates that you intend to make future payments with this PaymentIntent’s payment method.
- Payment
Method Options Ideal Setup Future Usage - Indicates that you intend to make future payments with this PaymentIntent’s payment method.
- Payment
Method Options Klarna Capture Method - Controls when the funds will be captured from the customer’s account.
- Payment
Method Options Klarna Setup Future Usage - Indicates that you intend to make future payments with this PaymentIntent’s payment method.
- Payment
Method Options Konbini Setup Future Usage - Indicates that you intend to make future payments with this PaymentIntent’s payment method.
- Payment
Method Options KrCard Capture Method - Controls when the funds will be captured from the customer’s account.
- Payment
Method Options KrCard Setup Future Usage - Indicates that you intend to make future payments with this PaymentIntent’s payment method.
- Payment
Method Options Multibanco Setup Future Usage - Indicates that you intend to make future payments with this PaymentIntent’s payment method.
- Payment
Method Options Oxxo Setup Future Usage - Indicates that you intend to make future payments with this PaymentIntent’s payment method.
- Payment
Method Options P24Setup Future Usage - Indicates that you intend to make future payments with this PaymentIntent’s payment method.
- Payment
Method Options Paynow Setup Future Usage - Indicates that you intend to make future payments with this PaymentIntent’s payment method.
- Payment
Method Options Paypal Capture Method - Controls when the funds will be captured from the customer’s account.
- Payment
Method Options Paypal Setup Future Usage - Indicates that you intend to make future payments with this PaymentIntent’s payment method.
- Payment
Method Options PixSetup Future Usage - Indicates that you intend to make future payments with this PaymentIntent’s payment method.
- Payment
Method Options Promptpay Setup Future Usage - Indicates that you intend to make future payments with this PaymentIntent’s payment method.
- Payment
Method Options Revolut PayCapture Method - Controls when the funds will be captured from the customer’s account.
- Payment
Method Options Revolut PaySetup Future Usage - Indicates that you intend to make future payments with this PaymentIntent’s payment method.
- Payment
Method Options Sofort Preferred Language - Preferred language of the SOFORT authorization page that the customer is redirected to.
- Payment
Method Options Sofort Setup Future Usage - Indicates that you intend to make future payments with this PaymentIntent’s payment method.
- Payment
Method Options Twint Setup Future Usage - Indicates that you intend to make future payments with this PaymentIntent’s payment method.
- Payment
Method Options UsBank Account Mandate Options Collection Method - Mandate collection method
- Payment
Method Options Wechat PayClient - The client type that the end customer will pay from
- Payment
Method Options Wechat PaySetup Future Usage - Indicates that you intend to make future payments with this PaymentIntent’s payment method.
- Payment
Method Options ZipSetup Future Usage - Indicates that you intend to make future payments with this PaymentIntent’s payment method.
- Payment
Method P24Bank - The customer’s bank, if provided.
- 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.
- Payment
Method UsBank Account Account Holder Type - Account holder type: individual or company.
- Payment
Method UsBank Account Account Type - Account type: checkings or savings. Defaults to checking if omitted.
- Payment
Method UsBank Account Blocked Network Code - The ACH network code that resulted in this block.
- Payment
Method UsBank Account Blocked Reason - The reason why this PaymentMethod’s fingerprint has been blocked
- Paypal
Seller Protection Dispute Categories - An array of conditions that are covered for the transaction, if applicable.
- Paypal
Seller Protection Status - Indicates whether the transaction is eligible for PayPal’s seller protection.
- Revolut
PayUnderlying Payment Method Funding Details Type - funding type of the underlying payment method.
- Source
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”.
- Source
Transaction Type - The type of source this transaction is attached to.
- Source
Type - The
type
of the source. Thetype
is a payment method, one ofach_credit_transfer
,ach_debit
,alipay
,bancontact
,card
,card_present
,eps
,giropay
,ideal
,multibanco
,klarna
,p24
,sepa_debit
,sofort
,three_d_secure
, orwechat
. An additional hash is included on the source with a name matching this value. It contains additional information specific to the payment method used. - ThreeD
Secure Details Charge Authentication Flow - For authenticated transactions: how the customer was authenticated by the issuing bank.
- ThreeD
Secure Details Charge Electronic Commerce Indicator - The Electronic Commerce Indicator (ECI). A protocol-level field indicating what degree of authentication was performed.
- ThreeD
Secure Details Charge Exemption Indicator - The exemption requested via 3DS and accepted by the issuer at authentication time.
- ThreeD
Secure Details Charge Result - Indicates the outcome of 3D Secure authentication.
- ThreeD
Secure Details Charge Result Reason - Additional information about why 3D Secure succeeded or failed based
on the
result
. - ThreeD
Secure Details Charge Version - The version of 3D Secure that was used.
- UsBank
Account Networks Supported - All supported networks.