Expand description
This crate provides Rust bindings to the Stripe HTTP API, specifically
for requests mentioned in the Core Resources
section of the Stripe API docs
Modules§
- balance
- balance_
transaction - cash_
balance - charge
- customer
- customer_
balance_ transaction - customer_
cash_ balance_ transaction - customer_
session - dispute
- event
- file
- file_
link - mandate
- payment_
intent - payment_
source - payout
- refund
- setup_
attempt - setup_
intent - token
Structs§
- Balance
- This is an object representing your Stripe balance. You can retrieve it to see the balance currently on your Stripe account.
- Balance
Amount - Balance
Amount Builder - Balance
Amount BySource Type - Balance
Amount BySource Type Builder - Balance
Amount Net - Balance
Amount NetBuilder - Balance
Detail - Balance
Detail Builder - Balance
NetAvailable - Balance
NetAvailable Builder - Balance
Transaction - Balance transactions represent funds moving through your Stripe account. Stripe creates them for every type of transaction that enters or leaves your Stripe account balance.
- Balance
Transaction Id - Balance
Transaction Source Builder - Cash
Balance - A customer’s
Cash balance
represents real funds. Customers can add funds to their cash balance by sending a bank transfer. These funds can be used for payment and can eventually be paid out to your bank account. - Charge
- The
Charge
object represents a single attempt to move money into your Stripe account. PaymentIntent confirmation is the most common way to create Charges, but transferring money to a different Stripe account through Connect also creates Charges. Some legacy payment flows create Charges directly, which is not recommended for new integrations. - Charge
Fraud Details - Charge
Id - Charge
Outcome - Charge
Transfer Data - Connect
Collection Transfer - Connect
Collection Transfer Id - Customer
- This object represents a customer of your business. Use it to create recurring charges, save payment and contact information,. and track payments that belong to the same customer.
- Customer
Acceptance - Customer
Balance Customer Balance Settings - Customer
Balance Resource Cash Balance Transaction Resource Adjusted ForOverdraft - Customer
Balance Resource Cash Balance Transaction Resource Applied ToPayment Transaction - Customer
Balance Resource Cash Balance Transaction Resource Funded Transaction - Customer
Balance Resource Cash Balance Transaction Resource Funded Transaction Resource Bank Transfer - Customer
Balance Resource Cash Balance Transaction Resource Funded Transaction Resource Bank Transfer Resource EuBank Transfer - Customer
Balance Resource Cash Balance Transaction Resource Funded Transaction Resource Bank Transfer Resource GbBank Transfer - Customer
Balance Resource Cash Balance Transaction Resource Funded Transaction Resource Bank Transfer Resource JpBank Transfer - Customer
Balance Resource Cash Balance Transaction Resource Funded Transaction Resource Bank Transfer Resource UsBank Transfer - Customer
Balance Resource Cash Balance Transaction Resource Refunded From Payment Transaction - Customer
Balance Resource Cash Balance Transaction Resource Transferred ToBalance - Customer
Balance Resource Cash Balance Transaction Resource Unapplied From Payment Transaction - Customer
Balance Transaction - Each customer has a Balance value,.
which denotes a debit or credit that’s automatically applied to their next invoice upon finalization.
You may modify the value directly by using the update customer API,.
or by creating a Customer Balance Transaction, which increments or decrements the customer’s
balance
by the specifiedamount
. - Customer
Balance Transaction Id - Customer
Cash Balance Transaction - Customers with certain payments enabled have a cash balance, representing funds that were paid by the customer to a merchant, but have not yet been allocated to a payment. Cash Balance Transactions. represent when funds are moved into or out of this balance. This includes funding by the customer, allocation. to payments, and refunds to the customer.
- Customer
Cash Balance Transaction Id - Customer
Id - Customer
Session - A Customer Session allows you to grant Stripe’s frontend SDKs (like Stripe.js) client-side access control over a Customer.
- Customer
Session Resource Components - Configuration for the components supported by this Customer Session.
- Customer
Session Resource Components Builder - Customer
Session Resource Components Resource BuyButton - This hash contains whether the buy button is enabled.
- Customer
Session Resource Components Resource BuyButton Builder - Customer
Session Resource Components Resource Payment Element - This hash contains whether the Payment Element is enabled and the features it supports.
- Customer
Session Resource Components Resource Payment Element Builder - Customer
Session Resource Components Resource Payment Element Resource Features - This hash contains the features the Payment Element supports.
- Customer
Session Resource Components Resource Payment Element Resource Features Builder - Customer
Session Resource Components Resource Pricing Table - This hash contains whether the pricing table is enabled.
- Customer
Session Resource Components Resource Pricing Table Builder - Customer
Tax - Customer
TaxLocation - Deleted
Customer - Destination
Details Unimplemented - Dispute
- A dispute occurs when a customer questions your charge with their card issuer. When this happens, you have the opportunity to respond to the dispute with evidence that shows that the charge is legitimate.
- Dispute
Enhanced Eligibility - Dispute
Enhanced Eligibility Visa Compelling Evidence3 - Dispute
Enhanced Eligibility Visa Compliance - Dispute
Enhanced Evidence - Dispute
Enhanced Evidence Visa Compelling Evidence3 - Dispute
Enhanced Evidence Visa Compliance - Dispute
Evidence - For more details see <https://stripe.com/docs/api/disputes/evidence_object>.
- Dispute
Evidence Details - Dispute
Id - Dispute
Payment Method Details - Dispute
Payment Method Details Amazon Pay - Dispute
Payment Method Details Card - Dispute
Payment Method Details Klarna - Dispute
Payment Method Details Paypal - Dispute
Transaction Shipping Address - Dispute
Visa Compelling Evidence3 Disputed Transaction - Dispute
Visa Compelling Evidence3 Prior Undisputed Transaction - Email
Sent - Event
- Events are our way of letting you know when something interesting happens in
your account. When an interesting event occurs, we create a new
Event
object. For example, when a charge succeeds, we create acharge.succeeded
event, and when an invoice payment attempt fails, we create aninvoice.payment_failed
event. Certain API requests might create multiple events. For example, if you create a new subscription for a customer, you receive both acustomer.subscription.created
event and acharge.succeeded
event. - EventId
- Fee
- File
- This object represents files hosted on Stripe’s servers. You can upload files with the create file request (for example, when uploading dispute evidence). Stripe also creates files independently (for example, the results of a Sigma scheduled query).
- FileId
- File
Link - To share the contents of a
File
object with non-Stripe users, you can create aFileLink
.FileLink
s contain a URL that you can use to retrieve the contents of the file without authentication. - File
Link Id - Level3
- Level3
Line Items - Linked
Account Options Common - Mandate
- A Mandate is a record of the permission that your customer gives you to debit their payment method.
- Mandate
Acss Debit - Mandate
Amazon Pay - Mandate
AuBecs Debit - Mandate
Bacs Debit - Mandate
Cashapp - Mandate
Id - Mandate
Kakao Pay - Mandate
KrCard - Mandate
Link - Mandate
Multi Use - Mandate
Naver Pay - Mandate
NzBank Account - Mandate
Payment Method Details - Mandate
Paypal - Mandate
Revolut Pay - Mandate
Sepa Debit - Mandate
Single Use - Mandate
UsBank Account - Notification
Event Data - Notification
Event Request - Offline
Acceptance - Online
Acceptance - Payment
Flows Amount Details - Payment
Flows Amount Details Client Resource Tip - Payment
Flows Automatic Payment Methods Payment Intent - Payment
Flows Automatic Payment Methods Setup Intent - Payment
Flows Payment Intent Presentment Details - Payment
Flows Private Payment Methods Financial Connections Common Linked Account Options Filters - Payment
Flows Private Payment Methods Kakao PayPayment Method Options - Payment
Flows Private Payment Methods Naver PayPayment Method Options - Payment
Flows Private Payment Methods Payco Payment Method Options - Payment
Flows Private Payment Methods Samsung PayPayment Method Options - Payment
Intent - 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.
- Payment
Intent Card Processing - Payment
Intent Id - Payment
Intent Next Action - Payment
Intent Next Action Alipay Handle Redirect - Payment
Intent Next Action Boleto - Payment
Intent Next Action Card Await Notification - Payment
Intent Next Action Cashapp Handle Redirect OrDisplay QrCode - Payment
Intent Next Action Cashapp QrCode - Payment
Intent Next Action Display Bank Transfer Instructions - Payment
Intent Next Action Display Multibanco Details - Payment
Intent Next Action Display Oxxo Details - Payment
Intent Next Action Konbini - Payment
Intent Next Action Konbini Familymart - Payment
Intent Next Action Konbini Lawson - Payment
Intent Next Action Konbini Ministop - Payment
Intent Next Action Konbini Seicomart - Payment
Intent Next Action Konbini Stores - Payment
Intent Next Action Paynow Display QrCode - Payment
Intent Next Action PixDisplay QrCode - Payment
Intent Next Action Promptpay Display QrCode - Payment
Intent Next Action Redirect ToUrl - Payment
Intent Next Action Swish Handle Redirect OrDisplay QrCode - Payment
Intent Next Action Swish QrCode - Payment
Intent Next Action Verify With Microdeposits - Payment
Intent Next Action Wechat PayDisplay QrCode - Payment
Intent Next Action Wechat PayRedirect ToAndroid App - Payment
Intent Next Action Wechat PayRedirect ToIos App - Payment
Intent Payment Method Options - Payment
Intent Payment Method Options Acss Debit - Payment
Intent Payment Method Options AuBecs Debit - Payment
Intent Payment Method Options Bacs Debit - Payment
Intent Payment Method Options Blik - Payment
Intent Payment Method Options Card - Payment
Intent Payment Method Options Eps - Payment
Intent Payment Method Options Link - Payment
Intent Payment Method Options Mandate Options Acss Debit - Payment
Intent Payment Method Options Mandate Options Bacs Debit - Payment
Intent Payment Method Options Mandate Options Sepa Debit - Payment
Intent Payment Method Options Mobilepay - Payment
Intent Payment Method Options NzBank Account - Payment
Intent Payment Method Options Sepa Debit - Payment
Intent Payment Method Options Swish - Payment
Intent Payment Method Options UsBank Account - Payment
Intent Processing - Payment
Intent Processing Customer Notification - Payment
Source Builder - Payout
- A
Payout
object is created when you receive funds from Stripe, or when you initiate a payout to either a bank account or debit card of a connected Stripe account. You can retrieve individual payouts, and list all payouts. Payouts are made on varying schedules, depending on your country and industry. - Payout
Id - Payouts
Trace Id - Refund
- Refund objects allow you to refund a previously created charge that isn’t refunded yet. Funds are refunded to the credit or debit card that’s initially charged.
- Refund
Destination Details - Refund
Destination Details Blik - Refund
Destination Details BrBank Transfer - Refund
Destination Details Card - Refund
Destination Details EuBank Transfer - Refund
Destination Details GbBank Transfer - Refund
Destination Details JpBank Transfer - Refund
Destination Details Multibanco - Refund
Destination Details MxBank Transfer - Refund
Destination Details P24 - Refund
Destination Details Swish - Refund
Destination Details ThBank Transfer - Refund
Destination Details UsBank Transfer - Refund
Id - Refund
Next Action - Refund
Next Action Display Details - Reserve
Transaction - Reserve
Transaction Id - Setup
Attempt - A SetupAttempt describes one attempted confirmation of a SetupIntent, whether that confirmation is successful or unsuccessful. You can use SetupAttempts to inspect details of a specific attempt at setting up a payment method using a SetupIntent.
- Setup
Attempt Id - Setup
Attempt Payment Method Details - Setup
Attempt Payment Method Details Acss Debit - Setup
Attempt Payment Method Details Amazon Pay - Setup
Attempt Payment Method Details AuBecs Debit - Setup
Attempt Payment Method Details Bacs Debit - Setup
Attempt Payment Method Details Bancontact - Setup
Attempt Payment Method Details Boleto - Setup
Attempt Payment Method Details Card - Setup
Attempt Payment Method Details Card Checks - Setup
Attempt Payment Method Details Card Present - Setup
Attempt Payment Method Details Card Wallet - Setup
Attempt Payment Method Details Cashapp - Setup
Attempt Payment Method Details Ideal - Setup
Attempt Payment Method Details Kakao Pay - Setup
Attempt Payment Method Details Klarna - Setup
Attempt Payment Method Details KrCard - Setup
Attempt Payment Method Details Link - Setup
Attempt Payment Method Details Naver Pay - Setup
Attempt Payment Method Details NzBank Account - Setup
Attempt Payment Method Details Paypal - Setup
Attempt Payment Method Details Revolut Pay - Setup
Attempt Payment Method Details Sepa Debit - Setup
Attempt Payment Method Details Sofort - Setup
Attempt Payment Method Details UsBank Account - Setup
Intent - A SetupIntent guides you through the process of setting up and saving a customer’s payment credentials for future payments. For example, you can use a SetupIntent to set up and save your customer’s card without immediately collecting a payment. Later, you can use PaymentIntents to drive the payment flow.
- Setup
Intent Id - Setup
Intent Next Action - Setup
Intent Next Action Redirect ToUrl - Setup
Intent Next Action Verify With Microdeposits - Setup
Intent Payment Method Options - Setup
Intent Payment Method Options Acss Debit - Setup
Intent Payment Method Options Amazon Pay - Setup
Intent Payment Method Options Bacs Debit - Setup
Intent Payment Method Options Card - Setup
Intent Payment Method Options Card Mandate Options - Setup
Intent Payment Method Options Card Present - Setup
Intent Payment Method Options Link - Setup
Intent Payment Method Options Mandate Options Acss Debit - Setup
Intent Payment Method Options Mandate Options Bacs Debit - Setup
Intent Payment Method Options Mandate Options Sepa Debit - Setup
Intent Payment Method Options Paypal - Setup
Intent Payment Method Options Sepa Debit - Setup
Intent Payment Method Options UsBank Account - TaxDeducted
AtSource - TaxDeducted
AtSource Id - ThreeD
Secure Details - Token
- Tokenization is the process Stripe uses to collect sensitive card or bank account details, or personally identifiable information (PII), directly from your customers in a secure manner. A token representing this information is returned to your server to use. Use our recommended payments integrations to perform this process on the client-side. This guarantees that no sensitive card data touches your server, and allows your integration to operate in a PCI-compliant way.
- Token
Card Networks - TokenId
Enums§
- Balance
Transaction Source - The resource representing a Stripe Polymorphic
- Balance
Transaction Type - Transaction type:
adjustment
,advance
,advance_funding
,anticipation_repayment
,application_fee
,application_fee_refund
,charge
,climate_order_purchase
,climate_order_refund
,connect_collection_transfer
,contribution
,issuing_authorization_hold
,issuing_authorization_release
,issuing_dispute
,issuing_transaction
,obligation_outbound
,obligation_reversal_inbound
,payment
,payment_failure_refund
,payment_network_reserve_hold
,payment_network_reserve_release
,payment_refund
,payment_reversal
,payment_unreconciled
,payout
,payout_cancel
,payout_failure
,payout_minimum_balance_hold
,payout_minimum_balance_release
,refund
,refund_failure
,reserve_transaction
,reserved_funds
,stripe_fee
,stripe_fx_fee
,stripe_balance_payment_debit
,stripe_balance_payment_debit_reversal
,tax_fee
,topup
,topup_reversal
,transfer
,transfer_cancel
,transfer_failure
, ortransfer_refund
. Learn more about balance transaction types and what they represent. To classify transactions for accounting purposes, considerreporting_category
instead. - Charge
Outcome Advice Code - An enumerated value providing a more detailed explanation on how to proceed with an error.
- Charge
Status - The status of the payment is either
succeeded
,pending
, orfailed
. - Customer
Acceptance Type - The mandate includes the type of customer acceptance information, such as:
online
oroffline
. - Customer
Balance Customer Balance Settings Reconciliation Mode - The configuration for how funds that land in the customer cash balance are reconciled.
- Customer
Balance Resource Cash Balance Transaction Resource Funded Transaction Resource Bank Transfer Resource UsBank Transfer Network - The banking network used for this funding.
- Customer
Balance Resource Cash Balance Transaction Resource Funded Transaction Resource Bank Transfer Type - The funding method type used to fund the customer balance.
Permitted values include:
eu_bank_transfer
,gb_bank_transfer
,jp_bank_transfer
,mx_bank_transfer
, orus_bank_transfer
. - Customer
Balance Transaction Type - Transaction type:
adjustment
,applied_to_invoice
,credit_note
,initial
,invoice_overpaid
,invoice_too_large
,invoice_too_small
,unspent_receiver_credit
,unapplied_from_invoice
,checkout_session_subscription_payment
, orcheckout_session_subscription_payment_canceled
. See the Customer Balance page to learn more about transaction types. - Customer
Cash Balance Transaction Type - The type of the cash balance transaction. New types may be added in future. See Customer Balance to learn more about these types.
- Customer
Session Resource Components Resource Payment Element Resource Features Payment Method Allow Redisplay Filters - A list of
allow_redisplay
values that controls which saved payment methods the Payment Element displays by filtering to only show payment methods with anallow_redisplay
value that is present in this list. - Customer
Session Resource Components Resource Payment Element Resource Features Payment Method Redisplay - Controls whether or not the Payment Element shows saved payment methods.
This parameter defaults to
disabled
. - Customer
Session Resource Components Resource Payment Element Resource Features Payment Method Remove - Controls whether the Payment Element displays the option to remove a saved payment method.
This parameter defaults to
disabled
. - Customer
Session Resource Components Resource Payment Element Resource Features Payment Method Save - Controls whether the Payment Element displays a checkbox offering to save a new payment method.
This parameter defaults to
disabled
. - Customer
Session Resource Components Resource Payment Element Resource Features Payment Method Save Usage - When using PaymentIntents and the customer checks the save checkbox, this field determines the
setup_future_usage
value used to confirm the PaymentIntent. - Customer
TaxAutomatic Tax - Surfaces if automatic tax computation is possible given the current customer location information.
- Customer
TaxExempt - Customer
TaxLocation Source - The data source used to infer the customer’s location.
- Dispute
Enhanced Eligibility Types - List of eligibility types that are included in
enhanced_evidence
. - Dispute
Enhanced Eligibility Visa Compelling Evidence3 Required Actions - List of actions required to qualify dispute for Visa Compelling Evidence 3.0 evidence submission.
- Dispute
Enhanced Eligibility Visa Compelling Evidence3 Status - Visa Compelling Evidence 3.0 eligibility status.
- Dispute
Enhanced Eligibility Visa Compliance Status - Visa compliance eligibility status.
- Dispute
Payment Method Details Amazon PayDispute Type - The AmazonPay dispute type, chargeback or claim
- Dispute
Payment Method Details Card Case Type - The type of dispute opened. Different case types may have varying fees and financial impact.
- Dispute
Payment Method Details Type - Payment method type.
- Dispute
Status - Current status of dispute.
Possible values are
warning_needs_response
,warning_under_review
,warning_closed
,needs_response
,under_review
,won
, orlost
. - Dispute
Visa Compelling Evidence3 Disputed Transaction Merchandise OrServices - Categorization of disputed payment.
- Event
Type - Description of the event (for example,
invoice.created
orcharge.refunded
). - File
Purpose - Linked
Account Options Common Permissions - The list of permissions to request. The
payment_method
permission must be included. - Linked
Account Options Common Prefetch - Data features requested to be retrieved upon account creation.
- Mandate
Acss Debit Default For - List of Stripe products where this mandate can be selected automatically.
- Mandate
Acss Debit Payment Schedule - Payment schedule for the mandate.
- Mandate
Acss Debit Transaction Type - Transaction type of the mandate.
- Mandate
Bacs Debit Network Status - The status of the mandate on the Bacs network.
Can be one of
pending
,revoked
,refused
, oraccepted
. - Mandate
Bacs Debit Revocation Reason - When the mandate is revoked on the Bacs network this field displays the reason for the revocation.
- Mandate
Status - The mandate status indicates whether or not you can use it to initiate a payment.
- Mandate
Type - The type of the mandate.
- Mandate
UsBank Account Collection Method - Mandate collection method
- Payment
Flows Automatic Payment Methods Payment Intent Allow Redirects - Controls whether this PaymentIntent will accept redirect-based payment methods.
- Payment
Flows Automatic Payment Methods Setup Intent Allow Redirects - Controls whether this SetupIntent will accept redirect-based payment methods.
- Payment
Flows Private Payment Methods Financial Connections Common Linked Account Options Filters Account Subcategories - The account subcategories to use to filter for possible accounts to link.
Valid subcategories are
checking
andsavings
. - Payment
Flows Private Payment Methods Kakao PayPayment Method Options Capture Method - Controls when the funds will be captured from the customer’s account.
- Payment
Flows Private Payment Methods Kakao PayPayment Method Options Setup Future Usage - Indicates that you intend to make future payments with this PaymentIntent’s payment method.
- Payment
Flows Private Payment Methods Naver PayPayment Method Options Capture Method - Controls when the funds will be captured from the customer’s account.
- Payment
Flows Private Payment Methods Naver PayPayment Method Options Setup Future Usage - Indicates that you intend to make future payments with this PaymentIntent’s payment method.
- Payment
Flows Private Payment Methods Payco Payment Method Options Capture Method - Controls when the funds will be captured from the customer’s account.
- Payment
Flows Private Payment Methods Samsung PayPayment Method Options Capture Method - Controls when the funds will be captured from the customer’s account.
- Payment
Intent Cancellation Reason - Reason for cancellation of this PaymentIntent, either user-provided (
duplicate
,fraudulent
,requested_by_customer
, orabandoned
) or generated by Stripe internally (failed_invoice
,void_invoice
,automatic
, orexpired
). - Payment
Intent Capture Method - Payment
Intent Confirmation Method - Payment
Intent Next Action Display Bank Transfer Instructions Type - Type of bank transfer
- Payment
Intent Next Action Verify With Microdeposits Microdeposit Type - The type of the microdeposit sent to the customer. Used to distinguish between different verification methods.
- Payment
Intent Payment Method Options Acss Debit Setup Future Usage - Indicates that you intend to make future payments with this PaymentIntent’s payment method.
- Payment
Intent Payment Method Options Acss Debit Verification Method - Bank account verification method.
- Payment
Intent Payment Method Options AuBecs Debit Setup Future Usage - Indicates that you intend to make future payments with this PaymentIntent’s payment method.
- Payment
Intent Payment Method Options Bacs Debit Setup Future Usage - Indicates that you intend to make future payments with this PaymentIntent’s payment method.
- Payment
Intent Payment Method Options Blik Setup Future Usage - Indicates that you intend to make future payments with this PaymentIntent’s payment method.
- Payment
Intent Payment Method Options Card Capture Method - Controls when the funds will be captured from the customer’s account.
- Payment
Intent Payment Method Options Card Network - Selected network to process this payment intent on. Depends on the available networks of the card attached to the payment intent. Can be only set confirm-time.
- Payment
Intent Payment Method Options Card Request Extended Authorization - Request ability to capture beyond the standard authorization validity window for this PaymentIntent.
- Payment
Intent Payment Method Options Card Request Incremental Authorization - Request ability to increment the authorization for this PaymentIntent.
- Payment
Intent Payment Method Options Card Request Multicapture - Request ability to make multiple captures for this PaymentIntent.
- Payment
Intent Payment Method Options Card Request Overcapture - Request ability to overcapture for this PaymentIntent.
- Payment
Intent Payment Method Options Card Request ThreeD Secure - We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and other requirements.
However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option.
If not provided, this value defaults to
automatic
. Read our guide on manually requesting 3D Secure for more information on how this configuration interacts with Radar and our SCA Engine. - Payment
Intent Payment Method Options Card Setup Future Usage - Indicates that you intend to make future payments with this PaymentIntent’s payment method.
- Payment
Intent Payment Method Options EpsSetup Future Usage - Indicates that you intend to make future payments with this PaymentIntent’s payment method.
- Payment
Intent Payment Method Options Link Capture Method - Controls when the funds will be captured from the customer’s account.
- Payment
Intent Payment Method Options Link Setup Future Usage - Indicates that you intend to make future payments with this PaymentIntent’s payment method.
- Payment
Intent Payment Method Options Mandate Options Acss Debit Payment Schedule - Payment schedule for the mandate.
- Payment
Intent Payment Method Options Mandate Options Acss Debit Transaction Type - Transaction type of the mandate.
- Payment
Intent Payment Method Options Mobilepay Capture Method - Controls when the funds will be captured from the customer’s account.
- Payment
Intent Payment Method Options Mobilepay Setup Future Usage - Indicates that you intend to make future payments with this PaymentIntent’s payment method.
- Payment
Intent Payment Method Options NzBank Account Setup Future Usage - Indicates that you intend to make future payments with this PaymentIntent’s payment method.
- Payment
Intent Payment Method Options Sepa Debit Setup Future Usage - Indicates that you intend to make future payments with this PaymentIntent’s payment method.
- Payment
Intent Payment Method Options Swish Setup Future Usage - Indicates that you intend to make future payments with this PaymentIntent’s payment method.
- Payment
Intent Payment Method Options UsBank Account Preferred Settlement Speed - Preferred transaction settlement speed
- Payment
Intent Payment Method Options UsBank Account Setup Future Usage - Indicates that you intend to make future payments with this PaymentIntent’s payment method.
- Payment
Intent Payment Method Options UsBank Account Verification Method - Bank account verification method.
- Payment
Intent Processing Type - Type of the payment method for which payment is in
processing
state, one ofcard
. - Payment
Intent Setup Future Usage - Payment
Intent Status - Status of this PaymentIntent, one of
requires_payment_method
,requires_confirmation
,requires_action
,processing
,requires_capture
,canceled
, orsucceeded
. Read more about each PaymentIntent status. - Payment
Source - The resource representing a Stripe Polymorphic
- Payout
Reconciliation Status - If
completed
, you can use the Balance Transactions API to list all balance transactions that are paid out in this payout. - Payout
Type - Can be
bank_account
orcard
. - Refund
Destination Details Card Type - The type of refund. This can be
refund
,reversal
, orpending
. - Refund
Pending Reason - Provides the reason for why the refund is pending.
Possible values are:
processing
,insufficient_funds
, orcharge_pending
. - Refund
Reason - Reason for the refund, which is either user-provided (
duplicate
,fraudulent
, orrequested_by_customer
) or generated by Stripe internally (expired_uncaptured_charge
). - Setup
Attempt Flow Directions - Indicates the directions of money movement for which this payment method is intended to be used.
- Setup
Attempt 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
- Setup
Attempt Payment Method Details Card Wallet Type - The type of the card wallet, one of
apple_pay
,google_pay
, 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. - Setup
Attempt 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
. - Setup
Attempt Payment Method Details Ideal Bic - The Bank Identifier Code of the customer’s bank.
- Setup
Attempt Payment Method Details Sofort Preferred Language - Preferred language of the Sofort authorization page that the customer is redirected to.
Can be one of
en
,de
,fr
, ornl
- Setup
Intent Cancellation Reason - Setup
Intent Flow Directions - Setup
Intent Next Action Verify With Microdeposits Microdeposit Type - The type of the microdeposit sent to the customer. Used to distinguish between different verification methods.
- Setup
Intent Payment Method Options Acss Debit Currency - Currency supported by the bank account
- Setup
Intent Payment Method Options Acss Debit Verification Method - Bank account verification method.
- Setup
Intent 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. - Setup
Intent Payment Method Options Card Mandate Options Interval - Specifies payment frequency. One of
day
,week
,month
,year
, orsporadic
. - Setup
Intent Payment Method Options Card Mandate Options Supported Types - Specifies the type of mandates supported. Possible values are
india
. - Setup
Intent Payment Method Options Card Network - Selected network to process this SetupIntent on. Depends on the available networks of the card attached to the setup intent. Can be only set confirm-time.
- Setup
Intent Payment Method Options Card Request ThreeD Secure - We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and other requirements.
However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option.
If not provided, this value defaults to
automatic
. Read our guide on manually requesting 3D Secure for more information on how this configuration interacts with Radar and our SCA Engine. - Setup
Intent Payment Method Options Mandate Options Acss Debit Default For - List of Stripe products where this mandate can be selected automatically.
- Setup
Intent Payment Method Options Mandate Options Acss Debit Payment Schedule - Payment schedule for the mandate.
- Setup
Intent Payment Method Options Mandate Options Acss Debit Transaction Type - Transaction type of the mandate.
- Setup
Intent Payment Method Options UsBank Account Verification Method - Bank account verification method.
- Setup
Intent Status - Status of this SetupIntent, one of
requires_payment_method
,requires_confirmation
,requires_action
,processing
,canceled
, orsucceeded
. - ThreeD
Secure Details Authentication Flow - For authenticated transactions: how the customer was authenticated by the issuing bank.
- ThreeD
Secure Details Electronic Commerce Indicator - The Electronic Commerce Indicator (ECI). A protocol-level field indicating what degree of authentication was performed.
- ThreeD
Secure Details Result - Indicates the outcome of 3D Secure authentication.
- ThreeD
Secure Details Result Reason - Additional information about why 3D Secure succeeded or failed based
on the
result
. - ThreeD
Secure Details Version - The version of 3D Secure that was used.