Struct stripe::PaymentIntent

pub struct PaymentIntent {
    pub id: String,
    pub object: String,
    pub allowed_source_types: Vec<String>,
    pub amount: u64,
    pub amount_capturable: u64,
    pub amount_received: u64,
    pub application: Option<String>,
    pub application_fee_amount: Option<u64>,
    pub canceled_at: Option<Timestamp>,
    pub cancellation_reason: Option<CancellationReason>,
    pub capture_method: CaptureMethod,
    pub charges: List<Charge>,
    pub client_secret: Option<String>,
    pub confirmation_method: Option<ConfirmationMethod>,
    pub created: Timestamp,
    pub currency: Currency,
    pub customer: Option<String>,
    pub description: Option<String>,
    pub last_payment_error: Option<PaymentError>,
    pub livemode: bool,
    pub metadata: Metadata,
    pub next_source_action: Option<NextSourceAction>,
    pub on_behalf_of: Option<String>,
    pub receipt_email: Option<String>,
    pub review: Option<String>,
    pub shipping: Option<ShippingDetails>,
    pub source: String,
    pub statement_descriptor: Option<String>,
    pub status: PaymentIntentStatus,
    pub transfer_data: Option<TransferData>,
    pub transfer_group: Option<String>,
}

The resource representing a Stripe PaymentIntent object.

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

Fields

id: String

object: String

allowed_source_types: Vec<String>

amount: u64

amount_capturable: u64

amount_received: u64

application: Option<String>

application_fee_amount: Option<u64>

canceled_at: Option<Timestamp>

cancellation_reason: Option<CancellationReason>

capture_method: CaptureMethod

charges: List<Charge>

client_secret: Option<String>

confirmation_method: Option<ConfirmationMethod>

created: Timestamp

currency: Currency

customer: Option<String>

description: Option<String>

last_payment_error: Option<PaymentError>

livemode: bool

metadata: Metadata

next_source_action: Option<NextSourceAction>

on_behalf_of: Option<String>

receipt_email: Option<String>

review: Option<String>

shipping: Option<ShippingDetails>

source: String

statement_descriptor: Option<String>

status: PaymentIntentStatus

transfer_data: Option<TransferData>

transfer_group: Option<String>

Methods

impl PaymentIntent

pub fn create(     client: &Client,     params: PaymentIntentCreateParams ) -> 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: PaymentIntentCaptureParams ) -> 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: PaymentIntentCancelParams ) -> 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: PaymentIntentListParams ) -> 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 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.

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.