Struct stripe::Charge

pub struct Charge {
    pub id: String,
    pub amount: u64,
    pub amount_refunded: u64,
    pub application: Option<String>,
    pub application_fee: Option<String>,
    pub balance_transaction: Option<String>,
    pub captured: bool,
    pub created: Timestamp,
    pub currency: Currency,
    pub customer: Option<String>,
    pub description: Option<String>,
    pub destination: Option<String>,
    pub dispute: Option<String>,
    pub failure_code: Option<ErrorCode>,
    pub failure_message: Option<String>,
    pub fraud_details: FraudDetails,
    pub invoice: Option<String>,
    pub livemode: bool,
    pub metadata: Metadata,
    pub on_behalf_of: Option<String>,
    pub order: Option<String>,
    pub outcome: Option<ChargeOutcome>,
    pub paid: bool,
    pub payment_intent: Option<String>,
    pub receipt_email: Option<String>,
    pub receipt_number: Option<String>,
    pub refunded: bool,
    pub refunds: List<Refund>,
    pub review: Option<String>,
    pub shipping: Option<ShippingDetails>,
    pub source: PaymentSource,
    pub source_transfer: Option<String>,
    pub statement_descriptor: Option<String>,
    pub status: ChargeStatus,
    pub transfer_group: Option<String>,
}

The resource representing a Stripe charge object.

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

Fields

id: String

amount: u64

amount_refunded: u64

application: Option<String>

application_fee: Option<String>

balance_transaction: Option<String>

captured: bool

created: Timestamp

currency: Currency

customer: Option<String>

description: Option<String>

destination: Option<String>

dispute: Option<String>

failure_code: Option<ErrorCode>

failure_message: Option<String>

fraud_details: FraudDetails

invoice: Option<String>

livemode: bool

metadata: Metadata

on_behalf_of: Option<String>

order: Option<String>

outcome: Option<ChargeOutcome>

paid: bool

payment_intent: Option<String>

receipt_email: Option<String>

receipt_number: Option<String>

refunded: bool

refunds: List<Refund>

review: Option<String>

shipping: Option<ShippingDetails>

source: PaymentSource

source_transfer: Option<String>

statement_descriptor: Option<String>

status: ChargeStatus

transfer_group: Option<String>

Methods

impl Charge

pub fn create(client: &Client, params: ChargeParams) -> Result<Charge, Error>

Creates a new charge.

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

pub fn retrieve(client: &Client, charge_id: &str) -> Result<Charge, Error>

Retrieves the details of a charge.

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

pub fn update(     client: &Client,     charge_id: &str,     params: ChargeParams ) -> Result<Charge, Error>

Updates a charge's properties.

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

pub fn capture(     client: &Client,     charge_id: &str,     params: CaptureParams ) -> Result<Charge, Error>

Capture captures a previously created charge with capture set to false.

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

pub fn list(     client: &Client,     params: ChargeListParams ) -> Result<Vec<Charge>, Error>

List all charges.

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

Trait Implementations

impl Clone for Charge

fn clone(&self) -> Charge

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Charge

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

Formats the value using the given formatter.

impl Serialize for Charge

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 Charge

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

Deserialize this value from the given Serde deserializer.