Crate stripe_core

Source
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.
BalanceAmount
BalanceAmountBuilder
BalanceAmountBySourceType
BalanceAmountBySourceTypeBuilder
BalanceAmountNet
BalanceAmountNetBuilder
BalanceDetail
BalanceDetailBuilder
BalanceNetAvailable
BalanceNetAvailableBuilder
BalanceTransaction
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.
BalanceTransactionId
BalanceTransactionSourceBuilder
CashBalance
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.
ChargeFraudDetails
ChargeId
ChargeOutcome
ChargeTransferData
ConnectCollectionTransfer
ConnectCollectionTransferId
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.
CustomerAcceptance
CustomerBalanceCustomerBalanceSettings
CustomerBalanceResourceCashBalanceTransactionResourceAdjustedForOverdraft
CustomerBalanceResourceCashBalanceTransactionResourceAppliedToPaymentTransaction
CustomerBalanceResourceCashBalanceTransactionResourceFundedTransaction
CustomerBalanceResourceCashBalanceTransactionResourceFundedTransactionResourceBankTransfer
CustomerBalanceResourceCashBalanceTransactionResourceFundedTransactionResourceBankTransferResourceEuBankTransfer
CustomerBalanceResourceCashBalanceTransactionResourceFundedTransactionResourceBankTransferResourceGbBankTransfer
CustomerBalanceResourceCashBalanceTransactionResourceFundedTransactionResourceBankTransferResourceJpBankTransfer
CustomerBalanceResourceCashBalanceTransactionResourceFundedTransactionResourceBankTransferResourceUsBankTransfer
CustomerBalanceResourceCashBalanceTransactionResourceRefundedFromPaymentTransaction
CustomerBalanceResourceCashBalanceTransactionResourceTransferredToBalance
CustomerBalanceResourceCashBalanceTransactionResourceUnappliedFromPaymentTransaction
CustomerBalanceTransaction
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 specified amount.
CustomerBalanceTransactionId
CustomerCashBalanceTransaction
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.
CustomerCashBalanceTransactionId
CustomerId
CustomerSession
A Customer Session allows you to grant Stripe’s frontend SDKs (like Stripe.js) client-side access control over a Customer.
CustomerSessionResourceComponents
Configuration for the components supported by this Customer Session.
CustomerSessionResourceComponentsBuilder
CustomerSessionResourceComponentsResourceBuyButton
This hash contains whether the buy button is enabled.
CustomerSessionResourceComponentsResourceBuyButtonBuilder
CustomerSessionResourceComponentsResourcePaymentElement
This hash contains whether the Payment Element is enabled and the features it supports.
CustomerSessionResourceComponentsResourcePaymentElementBuilder
CustomerSessionResourceComponentsResourcePaymentElementResourceFeatures
This hash contains the features the Payment Element supports.
CustomerSessionResourceComponentsResourcePaymentElementResourceFeaturesBuilder
CustomerSessionResourceComponentsResourcePricingTable
This hash contains whether the pricing table is enabled.
CustomerSessionResourceComponentsResourcePricingTableBuilder
CustomerTax
CustomerTaxLocation
DeletedCustomer
DestinationDetailsUnimplemented
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.
DisputeEnhancedEligibility
DisputeEnhancedEligibilityVisaCompellingEvidence3
DisputeEnhancedEligibilityVisaCompliance
DisputeEnhancedEvidence
DisputeEnhancedEvidenceVisaCompellingEvidence3
DisputeEnhancedEvidenceVisaCompliance
DisputeEvidence
For more details see <https://stripe.com/docs/api/disputes/evidence_object>.
DisputeEvidenceDetails
DisputeId
DisputePaymentMethodDetails
DisputePaymentMethodDetailsAmazonPay
DisputePaymentMethodDetailsCard
DisputePaymentMethodDetailsKlarna
DisputePaymentMethodDetailsPaypal
DisputeTransactionShippingAddress
DisputeVisaCompellingEvidence3DisputedTransaction
DisputeVisaCompellingEvidence3PriorUndisputedTransaction
EmailSent
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 a charge.succeeded event, and when an invoice payment attempt fails, we create an invoice.payment_failed event. Certain API requests might create multiple events. For example, if you create a new subscription for a customer, you receive both a customer.subscription.created event and a charge.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
FileLink
To share the contents of a File object with non-Stripe users, you can create a FileLink. FileLinks contain a URL that you can use to retrieve the contents of the file without authentication.
FileLinkId
Level3
Level3LineItems
LinkedAccountOptionsCommon
Mandate
A Mandate is a record of the permission that your customer gives you to debit their payment method.
MandateAcssDebit
MandateAmazonPay
MandateAuBecsDebit
MandateBacsDebit
MandateCashapp
MandateId
MandateKakaoPay
MandateKrCard
MandateLink
MandateMultiUse
MandateNaverPay
MandateNzBankAccount
MandatePaymentMethodDetails
MandatePaypal
MandateRevolutPay
MandateSepaDebit
MandateSingleUse
MandateUsBankAccount
NotificationEventData
NotificationEventRequest
OfflineAcceptance
OnlineAcceptance
PaymentFlowsAmountDetails
PaymentFlowsAmountDetailsClientResourceTip
PaymentFlowsAutomaticPaymentMethodsPaymentIntent
PaymentFlowsAutomaticPaymentMethodsSetupIntent
PaymentFlowsPaymentIntentPresentmentDetails
PaymentFlowsPrivatePaymentMethodsFinancialConnectionsCommonLinkedAccountOptionsFilters
PaymentFlowsPrivatePaymentMethodsKakaoPayPaymentMethodOptions
PaymentFlowsPrivatePaymentMethodsNaverPayPaymentMethodOptions
PaymentFlowsPrivatePaymentMethodsPaycoPaymentMethodOptions
PaymentFlowsPrivatePaymentMethodsSamsungPayPaymentMethodOptions
PaymentIntent
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.
PaymentIntentCardProcessing
PaymentIntentId
PaymentIntentNextAction
PaymentIntentNextActionAlipayHandleRedirect
PaymentIntentNextActionBoleto
PaymentIntentNextActionCardAwaitNotification
PaymentIntentNextActionCashappHandleRedirectOrDisplayQrCode
PaymentIntentNextActionCashappQrCode
PaymentIntentNextActionDisplayBankTransferInstructions
PaymentIntentNextActionDisplayMultibancoDetails
PaymentIntentNextActionDisplayOxxoDetails
PaymentIntentNextActionKonbini
PaymentIntentNextActionKonbiniFamilymart
PaymentIntentNextActionKonbiniLawson
PaymentIntentNextActionKonbiniMinistop
PaymentIntentNextActionKonbiniSeicomart
PaymentIntentNextActionKonbiniStores
PaymentIntentNextActionPaynowDisplayQrCode
PaymentIntentNextActionPixDisplayQrCode
PaymentIntentNextActionPromptpayDisplayQrCode
PaymentIntentNextActionRedirectToUrl
PaymentIntentNextActionSwishHandleRedirectOrDisplayQrCode
PaymentIntentNextActionSwishQrCode
PaymentIntentNextActionVerifyWithMicrodeposits
PaymentIntentNextActionWechatPayDisplayQrCode
PaymentIntentNextActionWechatPayRedirectToAndroidApp
PaymentIntentNextActionWechatPayRedirectToIosApp
PaymentIntentPaymentMethodOptions
PaymentIntentPaymentMethodOptionsAcssDebit
PaymentIntentPaymentMethodOptionsAuBecsDebit
PaymentIntentPaymentMethodOptionsBacsDebit
PaymentIntentPaymentMethodOptionsBlik
PaymentIntentPaymentMethodOptionsCard
PaymentIntentPaymentMethodOptionsEps
PaymentIntentPaymentMethodOptionsLink
PaymentIntentPaymentMethodOptionsMandateOptionsAcssDebit
PaymentIntentPaymentMethodOptionsMandateOptionsBacsDebit
PaymentIntentPaymentMethodOptionsMandateOptionsSepaDebit
PaymentIntentPaymentMethodOptionsMobilepay
PaymentIntentPaymentMethodOptionsNzBankAccount
PaymentIntentPaymentMethodOptionsSepaDebit
PaymentIntentPaymentMethodOptionsSwish
PaymentIntentPaymentMethodOptionsUsBankAccount
PaymentIntentProcessing
PaymentIntentProcessingCustomerNotification
PaymentSourceBuilder
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.
PayoutId
PayoutsTraceId
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.
RefundDestinationDetails
RefundDestinationDetailsBlik
RefundDestinationDetailsBrBankTransfer
RefundDestinationDetailsCard
RefundDestinationDetailsEuBankTransfer
RefundDestinationDetailsGbBankTransfer
RefundDestinationDetailsJpBankTransfer
RefundDestinationDetailsMultibanco
RefundDestinationDetailsMxBankTransfer
RefundDestinationDetailsP24
RefundDestinationDetailsSwish
RefundDestinationDetailsThBankTransfer
RefundDestinationDetailsUsBankTransfer
RefundId
RefundNextAction
RefundNextActionDisplayDetails
ReserveTransaction
ReserveTransactionId
SetupAttempt
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.
SetupAttemptId
SetupAttemptPaymentMethodDetails
SetupAttemptPaymentMethodDetailsAcssDebit
SetupAttemptPaymentMethodDetailsAmazonPay
SetupAttemptPaymentMethodDetailsAuBecsDebit
SetupAttemptPaymentMethodDetailsBacsDebit
SetupAttemptPaymentMethodDetailsBancontact
SetupAttemptPaymentMethodDetailsBoleto
SetupAttemptPaymentMethodDetailsCard
SetupAttemptPaymentMethodDetailsCardChecks
SetupAttemptPaymentMethodDetailsCardPresent
SetupAttemptPaymentMethodDetailsCardWallet
SetupAttemptPaymentMethodDetailsCashapp
SetupAttemptPaymentMethodDetailsIdeal
SetupAttemptPaymentMethodDetailsKakaoPay
SetupAttemptPaymentMethodDetailsKlarna
SetupAttemptPaymentMethodDetailsKrCard
SetupAttemptPaymentMethodDetailsLink
SetupAttemptPaymentMethodDetailsNaverPay
SetupAttemptPaymentMethodDetailsNzBankAccount
SetupAttemptPaymentMethodDetailsPaypal
SetupAttemptPaymentMethodDetailsRevolutPay
SetupAttemptPaymentMethodDetailsSepaDebit
SetupAttemptPaymentMethodDetailsSofort
SetupAttemptPaymentMethodDetailsUsBankAccount
SetupIntent
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.
SetupIntentId
SetupIntentNextAction
SetupIntentNextActionRedirectToUrl
SetupIntentNextActionVerifyWithMicrodeposits
SetupIntentPaymentMethodOptions
SetupIntentPaymentMethodOptionsAcssDebit
SetupIntentPaymentMethodOptionsAmazonPay
SetupIntentPaymentMethodOptionsBacsDebit
SetupIntentPaymentMethodOptionsCard
SetupIntentPaymentMethodOptionsCardMandateOptions
SetupIntentPaymentMethodOptionsCardPresent
SetupIntentPaymentMethodOptionsLink
SetupIntentPaymentMethodOptionsMandateOptionsAcssDebit
SetupIntentPaymentMethodOptionsMandateOptionsBacsDebit
SetupIntentPaymentMethodOptionsMandateOptionsSepaDebit
SetupIntentPaymentMethodOptionsPaypal
SetupIntentPaymentMethodOptionsSepaDebit
SetupIntentPaymentMethodOptionsUsBankAccount
TaxDeductedAtSource
TaxDeductedAtSourceId
ThreeDSecureDetails
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.
TokenCardNetworks
TokenId

Enums§

BalanceTransactionSource
The resource representing a Stripe Polymorphic
BalanceTransactionType
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, or transfer_refund. Learn more about balance transaction types and what they represent. To classify transactions for accounting purposes, consider reporting_category instead.
ChargeOutcomeAdviceCode
An enumerated value providing a more detailed explanation on how to proceed with an error.
ChargeStatus
The status of the payment is either succeeded, pending, or failed.
CustomerAcceptanceType
The mandate includes the type of customer acceptance information, such as: online or offline.
CustomerBalanceCustomerBalanceSettingsReconciliationMode
The configuration for how funds that land in the customer cash balance are reconciled.
CustomerBalanceResourceCashBalanceTransactionResourceFundedTransactionResourceBankTransferResourceUsBankTransferNetwork
The banking network used for this funding.
CustomerBalanceResourceCashBalanceTransactionResourceFundedTransactionResourceBankTransferType
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, or us_bank_transfer.
CustomerBalanceTransactionType
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, or checkout_session_subscription_payment_canceled. See the Customer Balance page to learn more about transaction types.
CustomerCashBalanceTransactionType
The type of the cash balance transaction. New types may be added in future. See Customer Balance to learn more about these types.
CustomerSessionResourceComponentsResourcePaymentElementResourceFeaturesPaymentMethodAllowRedisplayFilters
A list of allow_redisplay values that controls which saved payment methods the Payment Element displays by filtering to only show payment methods with an allow_redisplay value that is present in this list.
CustomerSessionResourceComponentsResourcePaymentElementResourceFeaturesPaymentMethodRedisplay
Controls whether or not the Payment Element shows saved payment methods. This parameter defaults to disabled.
CustomerSessionResourceComponentsResourcePaymentElementResourceFeaturesPaymentMethodRemove
Controls whether the Payment Element displays the option to remove a saved payment method. This parameter defaults to disabled.
CustomerSessionResourceComponentsResourcePaymentElementResourceFeaturesPaymentMethodSave
Controls whether the Payment Element displays a checkbox offering to save a new payment method. This parameter defaults to disabled.
CustomerSessionResourceComponentsResourcePaymentElementResourceFeaturesPaymentMethodSaveUsage
When using PaymentIntents and the customer checks the save checkbox, this field determines the setup_future_usage value used to confirm the PaymentIntent.
CustomerTaxAutomaticTax
Surfaces if automatic tax computation is possible given the current customer location information.
CustomerTaxExempt
CustomerTaxLocationSource
The data source used to infer the customer’s location.
DisputeEnhancedEligibilityTypes
List of eligibility types that are included in enhanced_evidence.
DisputeEnhancedEligibilityVisaCompellingEvidence3RequiredActions
List of actions required to qualify dispute for Visa Compelling Evidence 3.0 evidence submission.
DisputeEnhancedEligibilityVisaCompellingEvidence3Status
Visa Compelling Evidence 3.0 eligibility status.
DisputeEnhancedEligibilityVisaComplianceStatus
Visa compliance eligibility status.
DisputePaymentMethodDetailsAmazonPayDisputeType
The AmazonPay dispute type, chargeback or claim
DisputePaymentMethodDetailsCardCaseType
The type of dispute opened. Different case types may have varying fees and financial impact.
DisputePaymentMethodDetailsType
Payment method type.
DisputeStatus
Current status of dispute. Possible values are warning_needs_response, warning_under_review, warning_closed, needs_response, under_review, won, or lost.
DisputeVisaCompellingEvidence3DisputedTransactionMerchandiseOrServices
Categorization of disputed payment.
EventType
Description of the event (for example, invoice.created or charge.refunded).
FilePurpose
LinkedAccountOptionsCommonPermissions
The list of permissions to request. The payment_method permission must be included.
LinkedAccountOptionsCommonPrefetch
Data features requested to be retrieved upon account creation.
MandateAcssDebitDefaultFor
List of Stripe products where this mandate can be selected automatically.
MandateAcssDebitPaymentSchedule
Payment schedule for the mandate.
MandateAcssDebitTransactionType
Transaction type of the mandate.
MandateBacsDebitNetworkStatus
The status of the mandate on the Bacs network. Can be one of pending, revoked, refused, or accepted.
MandateBacsDebitRevocationReason
When the mandate is revoked on the Bacs network this field displays the reason for the revocation.
MandateStatus
The mandate status indicates whether or not you can use it to initiate a payment.
MandateType
The type of the mandate.
MandateUsBankAccountCollectionMethod
Mandate collection method
PaymentFlowsAutomaticPaymentMethodsPaymentIntentAllowRedirects
Controls whether this PaymentIntent will accept redirect-based payment methods.
PaymentFlowsAutomaticPaymentMethodsSetupIntentAllowRedirects
Controls whether this SetupIntent will accept redirect-based payment methods.
PaymentFlowsPrivatePaymentMethodsFinancialConnectionsCommonLinkedAccountOptionsFiltersAccountSubcategories
The account subcategories to use to filter for possible accounts to link. Valid subcategories are checking and savings.
PaymentFlowsPrivatePaymentMethodsKakaoPayPaymentMethodOptionsCaptureMethod
Controls when the funds will be captured from the customer’s account.
PaymentFlowsPrivatePaymentMethodsKakaoPayPaymentMethodOptionsSetupFutureUsage
Indicates that you intend to make future payments with this PaymentIntent’s payment method.
PaymentFlowsPrivatePaymentMethodsNaverPayPaymentMethodOptionsCaptureMethod
Controls when the funds will be captured from the customer’s account.
PaymentFlowsPrivatePaymentMethodsNaverPayPaymentMethodOptionsSetupFutureUsage
Indicates that you intend to make future payments with this PaymentIntent’s payment method.
PaymentFlowsPrivatePaymentMethodsPaycoPaymentMethodOptionsCaptureMethod
Controls when the funds will be captured from the customer’s account.
PaymentFlowsPrivatePaymentMethodsSamsungPayPaymentMethodOptionsCaptureMethod
Controls when the funds will be captured from the customer’s account.
PaymentIntentCancellationReason
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, automatic, or expired).
PaymentIntentCaptureMethod
PaymentIntentConfirmationMethod
PaymentIntentNextActionDisplayBankTransferInstructionsType
Type of bank transfer
PaymentIntentNextActionVerifyWithMicrodepositsMicrodepositType
The type of the microdeposit sent to the customer. Used to distinguish between different verification methods.
PaymentIntentPaymentMethodOptionsAcssDebitSetupFutureUsage
Indicates that you intend to make future payments with this PaymentIntent’s payment method.
PaymentIntentPaymentMethodOptionsAcssDebitVerificationMethod
Bank account verification method.
PaymentIntentPaymentMethodOptionsAuBecsDebitSetupFutureUsage
Indicates that you intend to make future payments with this PaymentIntent’s payment method.
PaymentIntentPaymentMethodOptionsBacsDebitSetupFutureUsage
Indicates that you intend to make future payments with this PaymentIntent’s payment method.
PaymentIntentPaymentMethodOptionsBlikSetupFutureUsage
Indicates that you intend to make future payments with this PaymentIntent’s payment method.
PaymentIntentPaymentMethodOptionsCardCaptureMethod
Controls when the funds will be captured from the customer’s account.
PaymentIntentPaymentMethodOptionsCardNetwork
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.
PaymentIntentPaymentMethodOptionsCardRequestExtendedAuthorization
Request ability to capture beyond the standard authorization validity window for this PaymentIntent.
PaymentIntentPaymentMethodOptionsCardRequestIncrementalAuthorization
Request ability to increment the authorization for this PaymentIntent.
PaymentIntentPaymentMethodOptionsCardRequestMulticapture
Request ability to make multiple captures for this PaymentIntent.
PaymentIntentPaymentMethodOptionsCardRequestOvercapture
Request ability to overcapture for this PaymentIntent.
PaymentIntentPaymentMethodOptionsCardRequestThreeDSecure
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.
PaymentIntentPaymentMethodOptionsCardSetupFutureUsage
Indicates that you intend to make future payments with this PaymentIntent’s payment method.
PaymentIntentPaymentMethodOptionsEpsSetupFutureUsage
Indicates that you intend to make future payments with this PaymentIntent’s payment method.
PaymentIntentPaymentMethodOptionsLinkCaptureMethod
Controls when the funds will be captured from the customer’s account.
PaymentIntentPaymentMethodOptionsLinkSetupFutureUsage
Indicates that you intend to make future payments with this PaymentIntent’s payment method.
PaymentIntentPaymentMethodOptionsMandateOptionsAcssDebitPaymentSchedule
Payment schedule for the mandate.
PaymentIntentPaymentMethodOptionsMandateOptionsAcssDebitTransactionType
Transaction type of the mandate.
PaymentIntentPaymentMethodOptionsMobilepayCaptureMethod
Controls when the funds will be captured from the customer’s account.
PaymentIntentPaymentMethodOptionsMobilepaySetupFutureUsage
Indicates that you intend to make future payments with this PaymentIntent’s payment method.
PaymentIntentPaymentMethodOptionsNzBankAccountSetupFutureUsage
Indicates that you intend to make future payments with this PaymentIntent’s payment method.
PaymentIntentPaymentMethodOptionsSepaDebitSetupFutureUsage
Indicates that you intend to make future payments with this PaymentIntent’s payment method.
PaymentIntentPaymentMethodOptionsSwishSetupFutureUsage
Indicates that you intend to make future payments with this PaymentIntent’s payment method.
PaymentIntentPaymentMethodOptionsUsBankAccountPreferredSettlementSpeed
Preferred transaction settlement speed
PaymentIntentPaymentMethodOptionsUsBankAccountSetupFutureUsage
Indicates that you intend to make future payments with this PaymentIntent’s payment method.
PaymentIntentPaymentMethodOptionsUsBankAccountVerificationMethod
Bank account verification method.
PaymentIntentProcessingType
Type of the payment method for which payment is in processing state, one of card.
PaymentIntentSetupFutureUsage
PaymentIntentStatus
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.
PaymentSource
The resource representing a Stripe Polymorphic
PayoutReconciliationStatus
If completed, you can use the Balance Transactions API to list all balance transactions that are paid out in this payout.
PayoutType
Can be bank_account or card.
RefundDestinationDetailsCardType
The type of refund. This can be refund, reversal, or pending.
RefundPendingReason
Provides the reason for why the refund is pending. Possible values are: processing, insufficient_funds, or charge_pending.
RefundReason
Reason for the refund, which is either user-provided (duplicate, fraudulent, or requested_by_customer) or generated by Stripe internally (expired_uncaptured_charge).
SetupAttemptFlowDirections
Indicates the directions of money movement for which this payment method is intended to be used.
SetupAttemptPaymentMethodDetailsBancontactPreferredLanguage
Preferred language of the Bancontact authorization page that the customer is redirected to. Can be one of en, de, fr, or nl
SetupAttemptPaymentMethodDetailsCardWalletType
The type of the card wallet, one of apple_pay, google_pay, or link. 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.
SetupAttemptPaymentMethodDetailsIdealBank
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, or yoursafe.
SetupAttemptPaymentMethodDetailsIdealBic
The Bank Identifier Code of the customer’s bank.
SetupAttemptPaymentMethodDetailsSofortPreferredLanguage
Preferred language of the Sofort authorization page that the customer is redirected to. Can be one of en, de, fr, or nl
SetupIntentCancellationReason
SetupIntentFlowDirections
SetupIntentNextActionVerifyWithMicrodepositsMicrodepositType
The type of the microdeposit sent to the customer. Used to distinguish between different verification methods.
SetupIntentPaymentMethodOptionsAcssDebitCurrency
Currency supported by the bank account
SetupIntentPaymentMethodOptionsAcssDebitVerificationMethod
Bank account verification method.
SetupIntentPaymentMethodOptionsCardMandateOptionsAmountType
One of fixed or maximum. If fixed, the amount param refers to the exact amount to be charged in future payments. If maximum, the amount charged can be up to the value passed for the amount param.
SetupIntentPaymentMethodOptionsCardMandateOptionsInterval
Specifies payment frequency. One of day, week, month, year, or sporadic.
SetupIntentPaymentMethodOptionsCardMandateOptionsSupportedTypes
Specifies the type of mandates supported. Possible values are india.
SetupIntentPaymentMethodOptionsCardNetwork
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.
SetupIntentPaymentMethodOptionsCardRequestThreeDSecure
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.
SetupIntentPaymentMethodOptionsMandateOptionsAcssDebitDefaultFor
List of Stripe products where this mandate can be selected automatically.
SetupIntentPaymentMethodOptionsMandateOptionsAcssDebitPaymentSchedule
Payment schedule for the mandate.
SetupIntentPaymentMethodOptionsMandateOptionsAcssDebitTransactionType
Transaction type of the mandate.
SetupIntentPaymentMethodOptionsUsBankAccountVerificationMethod
Bank account verification method.
SetupIntentStatus
Status of this SetupIntent, one of requires_payment_method, requires_confirmation, requires_action, processing, canceled, or succeeded.
ThreeDSecureDetailsAuthenticationFlow
For authenticated transactions: how the customer was authenticated by the issuing bank.
ThreeDSecureDetailsElectronicCommerceIndicator
The Electronic Commerce Indicator (ECI). A protocol-level field indicating what degree of authentication was performed.
ThreeDSecureDetailsResult
Indicates the outcome of 3D Secure authentication.
ThreeDSecureDetailsResultReason
Additional information about why 3D Secure succeeded or failed based on the result.
ThreeDSecureDetailsVersion
The version of 3D Secure that was used.