Skip to main content

Charge

Struct Charge 

Source
pub struct Charge { /* private fields */ }
Expand description

A Charge as returned by Stripe’s REST API.

A charge is the moment money actually moves or is reserved. It is created by a PaymentIntent rather than requested directly, so its identifier is what a refund references.

Implementations§

Source§

impl Charge

Source

pub fn new( id: String, amount: Money, status: ChargeStatus, payment_method_kind: PaymentMethodKind, ) -> Charge

Build a Charge from its wire fields.

§Arguments
  • String - Stripe’s identifier for the charge.
  • Money - the amount captured.
  • ChargeStatus - whether the charge moved money.
  • PaymentMethodKind - how the customer paid.
§Returns
  • Self - the assembled charge.
Source

pub fn get_amount(&self) -> Result<Money, StripeParseError>

Return the amount this charge captured.

§Returns
  • Result<Money, StripeParseError> - the amount, or an error when the response carried a currency this crate does not model.
Source

pub fn is_disputed(&self) -> bool

Return whether the charge is under dispute.

§Returns
  • bool - true once a customer has challenged the charge.
Source

pub fn is_captured(&self) -> bool

Return whether this charge actually moved the customer’s money.

An authorised charge has reserved funds but not taken them, so it is deliberately not counted as captured.

§Returns
  • bool - true only for a succeeded charge.
Source§

impl Charge

Trait Implementations§

Source§

impl Clone for Charge

Source§

fn clone(&self) -> Charge

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Charge

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for Charge

Source§

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

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Eq for Charge

Source§

impl PartialEq for Charge

Source§

fn eq(&self, other: &Charge) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl Serialize for Charge

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for Charge

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.