Struct stripe::PaymentIntent

pub struct PaymentIntent {
    pub id: PaymentIntentId,
    pub amount: i64,
    pub amount_capturable: Option<i64>,
    pub amount_received: Option<i64>,
    pub application: Option<Expandable<Application>>,
    pub application_fee_amount: Option<i64>,
    pub canceled_at: Option<Timestamp>,
    pub cancellation_reason: Option<PaymentIntentCancellationReason>,
    pub capture_method: PaymentIntentCaptureMethod,
    pub charges: List<Charge>,
    pub client_secret: Option<String>,
    pub confirmation_method: PaymentIntentConfirmationMethod,
    pub created: Timestamp,
    pub currency: Currency,
    pub customer: Option<Expandable<Customer>>,
    pub description: Option<String>,
    pub invoice: Option<Expandable<Invoice>>,
    pub last_payment_error: Option<PaymentError>,
    pub livemode: bool,
    pub metadata: Metadata,
    pub next_action: Option<PaymentIntentNextAction>,
    pub on_behalf_of: Option<Expandable<Account>>,
    pub payment_method: Option<Expandable<PaymentMethod>>,
    pub payment_method_types: Vec<String>,
    pub receipt_email: Option<String>,
    pub review: Option<Expandable<Review>>,
    pub shipping: Option<Shipping>,
    pub source: Option<Expandable<PaymentSource>>,
    pub off_session: Option<PaymentIntentOffSession>,
    pub statement_descriptor: Option<String>,
    pub status: PaymentIntentStatus,
    pub transfer_data: Option<TransferData>,
    pub transfer_group: Option<String>,
}

The resource representing a Stripe "PaymentIntent".

For more details see https://stripe.com/docs/api/payment_intents/object.

Fields

id: PaymentIntentId

Unique identifier for the object.

amount: i64

Amount intended to be collected by this PaymentIntent.

amount_capturable: Option<i64>

Amount that can be captured from this PaymentIntent.

amount_received: Option<i64>

Amount that was collected by this PaymentIntent.

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) for the resulting payment.

See the PaymentIntents use case for connected accounts for details.

canceled_at: Option<Timestamp>

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, or automatic).

capture_method: PaymentIntentCaptureMethod

Capture method of this PaymentIntent, one of automatic or manual.

charges: List<Charge>

Charges that were created by this PaymentIntent, if any.

client_secret: Option<String>

The client secret of this PaymentIntent.

Used for client-side retrieval using a publishable key. Please refer to our automatic confirmation quickstart guide to learn about how client_secret should be handled.

confirmation_method: PaymentIntentConfirmationMethod

Confirmation method of this PaymentIntent, one of manual or automatic.

created: Timestamp

Time at which the object was created.

Measured in seconds since the Unix epoch.

currency: Currency

Three-letter ISO currency code, in lowercase.

Must be a supported currency.

customer: Option<Expandable<Customer>>

ID of the Customer this PaymentIntent is for if one exists.

description: Option<String>

An arbitrary string attached to the object.

Often useful for displaying to users.

invoice: Option<Expandable<Invoice>>

ID of the invoice that created this PaymentIntent, if it exists.

last_payment_error: Option<PaymentError>

The payment error encountered in the previous PaymentIntent confirmation.

livemode: bool

Has the value true if the object exists in live mode or the value false if the object exists in test mode.

metadata: Metadata

Set of key-value pairs that you can attach to an object.

This can be useful for storing additional information about the object in a structured format. For more information, see the documentation.

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_types: Vec<String>

The list of payment method types (e.g.

card) that this PaymentIntent is allowed to use.

receipt_email: Option<String>

Email address that the receipt for the resulting payment will be sent to.

review: Option<Expandable<Review>>

ID of the review associated with this PaymentIntent, if any.

shipping: Option<Shipping>

Shipping information for this PaymentIntent.

source: Option<Expandable<PaymentSource>>

ID of the source used in this PaymentIntent.

off_session: Option<PaymentIntentOffSession>

Used in payment flows that collect payment details and charge later when the customer is not available to complete additional required steps for the payment.

Setting this parameter indicates that this payment attempt is happening while the customer is not in your checkout flow. Use recurring for payments made on a recurring basis (for example, subscriptions) and one_off for all other off-session payments.

statement_descriptor: Option<String>

Extra information about a PaymentIntent.

This will appear on your customer's statement when this PaymentIntent succeeds in creating a charge.

status: 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.

transfer_data: Option<TransferData>

The data with which to automatically create a Transfer when the payment is finalized.

See the PaymentIntents use case for connected accounts for details.

transfer_group: Option<String>

A string that identifies the resulting payment as part of a group.

See the PaymentIntents use case for connected accounts for details.

Implementations

impl PaymentIntent

pub fn create(
    client: &Client,
    params: CreatePaymentIntent
) -> Response<PaymentIntent>

Creates a new payment_intent.

For more details see https://stripe.com/docs/api/payment_intents/create.

pub fn retrieve(
    client: &Client,
    payment_intent_id: &str
) -> Response<PaymentIntent>

Retrieves the details of a payment_intent.

For more details see https://stripe.com/docs/api/payment_intents/retrieve.

pub fn update(
    client: &Client,
    payment_intent_id: &str,
    params: PaymentIntentUpdateParams
) -> Response<PaymentIntent>

Updates a payment_intent's properties.

For more details see https://stripe.com/docs/api/payment_intents/update.

pub fn confirm(
    client: &Client,
    payment_intent_id: &str,
    params: PaymentIntentConfirmParams
) -> Response<PaymentIntent>

Confirm that customer intends to pay with current or provided source. Upon confirmation, the PaymentIntent will attempt to initiate a payment.

For more details see https://stripe.com/docs/api/payment_intents/confirm.

pub fn capture(
    client: &Client,
    payment_intent_id: &str,
    params: CapturePaymentIntent
) -> Response<PaymentIntent>

Capture the funds of an existing uncaptured PaymentIntent where required_action="requires_capture".

For more details see https://stripe.com/docs/api/payment_intents/capture.

pub fn cancel(
    client: &Client,
    payment_intent_id: &str,
    params: CancelPaymentIntent
) -> Response<PaymentIntent>

A PaymentIntent object can be canceled when it is in one of these statuses: requires_source, requires_capture, requires_confirmation, requires_source_action.

For more details see https://stripe.com/docs/api/payment_intents/cancel.

pub fn list(
    client: &Client,
    params: ListPaymentIntents
) -> Response<List<PaymentIntent>>

List all payment_intents.

For more details see https://stripe.com/docs/api/payment_intents/list.

Trait Implementations

impl Clone for PaymentIntent

fn clone(&self) -> PaymentIntent

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for PaymentIntent

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PaymentIntent

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Object for PaymentIntent

type Id = PaymentIntentId

The canonical id type for this object.

fn id(&self) -> Self::Id

The id of the object.

fn object(&self) -> &'static str

The object's type, typically represented in wire format as the object property.

impl Serialize for PaymentIntent

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.