pub struct PaymentIntent {Show 39 fields
pub amount: i64,
pub amount_capturable: i64,
pub amount_details: Option<PaymentFlowsAmountDetails>,
pub amount_received: i64,
pub application: Option<Expandable<Application>>,
pub application_fee_amount: Option<i64>,
pub automatic_payment_methods: Option<PaymentFlowsAutomaticPaymentMethodsPaymentIntent>,
pub canceled_at: Option<i64>,
pub cancellation_reason: Option<PaymentIntentCancellationReason>,
pub capture_method: PaymentIntentCaptureMethod,
pub client_secret: Option<String>,
pub confirmation_method: PaymentIntentConfirmationMethod,
pub created: i64,
pub currency: Currency,
pub customer: Option<Expandable<Customer>>,
pub description: Option<String>,
pub id: PaymentIntentId,
pub last_payment_error: Option<Box<ApiErrors>>,
pub latest_charge: Option<Expandable<Charge>>,
pub livemode: bool,
pub metadata: HashMap<String, String>,
pub next_action: Option<PaymentIntentNextAction>,
pub on_behalf_of: Option<Expandable<Account>>,
pub payment_method: Option<Expandable<PaymentMethod>>,
pub payment_method_configuration_details: Option<PaymentMethodConfigBizPaymentMethodConfigurationDetails>,
pub payment_method_options: Option<PaymentIntentPaymentMethodOptions>,
pub payment_method_types: Vec<String>,
pub presentment_details: Option<PaymentFlowsPaymentIntentPresentmentDetails>,
pub processing: Option<PaymentIntentProcessing>,
pub receipt_email: Option<String>,
pub review: Option<Expandable<Review>>,
pub setup_future_usage: Option<PaymentIntentSetupFutureUsage>,
pub shipping: Option<Shipping>,
pub source: Option<Expandable<PaymentSource>>,
pub statement_descriptor: Option<String>,
pub statement_descriptor_suffix: Option<String>,
pub status: PaymentIntentStatus,
pub transfer_data: Option<TransferData>,
pub transfer_group: Option<String>,
}Expand description
A PaymentIntent guides you through the process of collecting a payment from your customer. We recommend that you create exactly one PaymentIntent for each order or customer session in your system. You can reference the PaymentIntent later to see the history of payment attempts for a particular session.
A PaymentIntent transitions through multiple statuses throughout its lifetime as it interfaces with Stripe.js to perform authentication flows and ultimately creates at most one successful charge.
Related guide: Payment Intents API
For more details see <https://stripe.com/docs/api/payment_intents/object>.
Fields§
§amount: i64Amount intended to be collected by this PaymentIntent. A positive integer representing how much to charge in the smallest currency unit (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The minimum amount is $0.50 US or equivalent in charge currency. The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99).
amount_capturable: i64Amount that can be captured from this PaymentIntent.
amount_details: Option<PaymentFlowsAmountDetails>§amount_received: i64Amount that this PaymentIntent collects.
application: Option<Expandable<Application>>ID of the Connect application that created the PaymentIntent.
application_fee_amount: Option<i64>The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner’s Stripe account. The amount of the application fee collected will be capped at the total amount captured. For more information, see the PaymentIntents use case for connected accounts.
automatic_payment_methods: Option<PaymentFlowsAutomaticPaymentMethodsPaymentIntent>Settings to configure compatible payment methods from the Stripe Dashboard.
canceled_at: Option<i64>Populated when status is canceled, this is the time at which the PaymentIntent was canceled.
Measured in seconds since the Unix epoch.
cancellation_reason: Option<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).
capture_method: PaymentIntentCaptureMethodControls when the funds will be captured from the customer’s account.
client_secret: Option<String>The client secret of this PaymentIntent. Used for client-side retrieval using a publishable key.
The client secret can be used to complete a payment from your frontend. It should not be stored, logged, or exposed to anyone other than the customer. Make sure that you have TLS enabled on any page that includes the client secret.
Refer to our docs to accept a payment and learn about how client_secret should be handled.
confirmation_method: PaymentIntentConfirmationMethodDescribes whether we can confirm this PaymentIntent automatically, or if it requires customer action to confirm the payment.
created: i64Time at which the object was created. Measured in seconds since the Unix epoch.
currency: CurrencyThree-letter ISO currency code, in lowercase. Must be a supported currency.
customer: Option<Expandable<Customer>>ID of the Customer this PaymentIntent belongs to, if one exists.
Payment methods attached to other Customers cannot be used with this PaymentIntent.
If setup_future_usage is set and this PaymentIntent’s payment method is not card_present, then the payment method attaches to the Customer after the PaymentIntent has been confirmed and any required actions from the user are complete.
If the payment method is card_present and isn’t a digital wallet, then a generated_card payment method representing the card is created and attached to the Customer instead.
description: Option<String>An arbitrary string attached to the object. Often useful for displaying to users.
id: PaymentIntentIdUnique identifier for the object.
last_payment_error: Option<Box<ApiErrors>>The payment error encountered in the previous PaymentIntent confirmation. It will be cleared if the PaymentIntent is later updated for any reason.
latest_charge: Option<Expandable<Charge>>ID of the latest Charge object created by this PaymentIntent.
This property is null until PaymentIntent confirmation is attempted.
livemode: boolHas the value true if the object exists in live mode or the value false if the object exists in test mode.
metadata: HashMap<String, String>Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Learn more about storing information in metadata.
next_action: Option<PaymentIntentNextAction>If present, this property tells you what actions you need to take in order for your customer to fulfill a payment using the provided source.
on_behalf_of: Option<Expandable<Account>>The account (if any) for which the funds of the PaymentIntent are intended. See the PaymentIntents use case for connected accounts for details.
payment_method: Option<Expandable<PaymentMethod>>ID of the payment method used in this PaymentIntent.
payment_method_configuration_details: Option<PaymentMethodConfigBizPaymentMethodConfigurationDetails>Information about the payment method configuration used for this PaymentIntent.
payment_method_options: Option<PaymentIntentPaymentMethodOptions>Payment-method-specific configuration for this PaymentIntent.
payment_method_types: Vec<String>The list of payment method types (e.g. card) that this PaymentIntent is allowed to use. A comprehensive list of valid payment method types can be found here.
presentment_details: Option<PaymentFlowsPaymentIntentPresentmentDetails>§processing: Option<PaymentIntentProcessing>If present, this property tells you about the processing state of the payment.
receipt_email: Option<String>Email address that the receipt for the resulting payment will be sent to.
If receipt_email is specified for a payment in live mode, a receipt will be sent regardless of your email settings.
review: Option<Expandable<Review>>ID of the review associated with this PaymentIntent, if any.
setup_future_usage: Option<PaymentIntentSetupFutureUsage>Indicates that you intend to make future payments with this PaymentIntent’s payment method.
If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don’t provide a Customer, you can still attach the payment method to a Customer after the transaction completes.
If the payment method is card_present and isn’t a digital wallet, Stripe creates and attaches a generated_card payment method representing the card to the Customer instead.
When processing card payments, Stripe uses setup_future_usage to help you comply with regional legislation and network rules, such as SCA.
shipping: Option<Shipping>Shipping information for this PaymentIntent.
source: Option<Expandable<PaymentSource>>This is a legacy field that will be removed in the future. It is the ID of the Source object that is associated with this PaymentIntent, if one was supplied.
statement_descriptor: Option<String>Text that appears on the customer’s statement as the statement descriptor for a non-card charge. This value overrides the account’s default statement descriptor. For information about requirements, including the 22-character limit, see the Statement Descriptor docs.
Setting this value for a card charge returns an error. For card charges, set the statement_descriptor_suffix instead.
statement_descriptor_suffix: Option<String>Provides information about a card charge. Concatenated to the account’s statement descriptor prefix to form the complete statement descriptor that appears on the customer’s statement.
status: PaymentIntentStatusStatus of this PaymentIntent, one of requires_payment_method, requires_confirmation, requires_action, processing, requires_capture, canceled, or succeeded.
Read more about each PaymentIntent status.
transfer_data: Option<TransferData>The data that automatically creates a Transfer after the payment finalizes. Learn more about the use case for connected accounts.
transfer_group: Option<String>A string that identifies the resulting payment as part of a group. Learn more about the use case for connected accounts.
Trait Implementations§
Source§impl Clone for PaymentIntent
impl Clone for PaymentIntent
Source§fn clone(&self) -> PaymentIntent
fn clone(&self) -> PaymentIntent
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read more