pub struct Charge {Show 47 fields
pub id: ChargeId,
pub amount: i64,
pub amount_captured: i64,
pub amount_refunded: i64,
pub application: Option<Expandable<Application>>,
pub application_fee: Option<Expandable<ApplicationFee>>,
pub application_fee_amount: Option<i64>,
pub authorization_code: Option<String>,
pub balance_transaction: Option<Expandable<BalanceTransaction>>,
pub billing_details: BillingDetails,
pub calculated_statement_descriptor: Option<String>,
pub captured: bool,
pub created: Timestamp,
pub currency: Currency,
pub customer: Option<Expandable<Customer>>,
pub description: Option<String>,
pub disputed: bool,
pub failure_balance_transaction: Option<Expandable<BalanceTransaction>>,
pub failure_code: Option<String>,
pub failure_message: Option<String>,
pub fraud_details: Option<FraudDetails>,
pub invoice: Option<Expandable<Invoice>>,
pub level3: Option<Level3>,
pub livemode: bool,
pub metadata: Metadata,
pub on_behalf_of: Option<Expandable<Account>>,
pub outcome: Option<ChargeOutcome>,
pub paid: bool,
pub payment_intent: Option<Expandable<PaymentIntent>>,
pub payment_method: Option<String>,
pub payment_method_details: Option<PaymentMethodDetails>,
pub radar_options: Option<RadarRadarOptions>,
pub receipt_email: Option<String>,
pub receipt_number: Option<String>,
pub receipt_url: Option<String>,
pub refunded: bool,
pub refunds: Option<List<Refund>>,
pub review: Option<Expandable<Review>>,
pub shipping: Option<Shipping>,
pub source: Option<PaymentSource>,
pub source_transfer: Option<Expandable<Transfer>>,
pub statement_descriptor: Option<String>,
pub statement_descriptor_suffix: Option<String>,
pub status: ChargeStatus,
pub transfer: Option<Expandable<Transfer>>,
pub transfer_data: Option<TransferData>,
pub transfer_group: Option<String>,
}Expand description
The resource representing a Stripe “Charge”.
For more details see https://stripe.com/docs/api/charges/object
Fields§
§id: ChargeIdUnique identifier for the object.
amount: i64Amount intended to be collected by this payment.
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_captured: i64Amount in cents (or local equivalent) captured (can be less than the amount attribute on the charge if a partial capture was made).
amount_refunded: i64Amount in cents (or local equivalent) refunded (can be less than the amount attribute on the charge if a partial refund was issued).
application: Option<Expandable<Application>>ID of the Connect application that created the charge.
application_fee: Option<Expandable<ApplicationFee>>The application fee (if any) for the charge.
See the Connect documentation for details.
application_fee_amount: Option<i64>The amount of the application fee (if any) requested for the charge.
See the Connect documentation for details.
Authorization code on the charge.
balance_transaction: Option<Expandable<BalanceTransaction>>ID of the balance transaction that describes the impact of this charge on your account balance (not including refunds or disputes).
billing_details: BillingDetails§calculated_statement_descriptor: Option<String>The full statement descriptor that is passed to card networks, and that is displayed on your customers’ credit card and bank statements.
Allows you to see what the statement descriptor looks like after the static and dynamic portions are combined.
captured: boolIf the charge was created without capturing, this Boolean represents whether it is still uncaptured or has since been captured.
created: TimestampTime 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 charge is for if one exists.
description: Option<String>An arbitrary string attached to the object.
Often useful for displaying to users.
disputed: boolWhether the charge has been disputed.
failure_balance_transaction: Option<Expandable<BalanceTransaction>>ID of the balance transaction that describes the reversal of the balance on your account due to payment failure.
failure_code: Option<String>Error code explaining reason for charge failure if available (see the errors section for a list of codes).
failure_message: Option<String>Message to user further explaining reason for charge failure if available.
fraud_details: Option<FraudDetails>Information on fraud assessments for the charge.
invoice: Option<Expandable<Invoice>>ID of the invoice this charge is for if one exists.
level3: Option<Level3>§livemode: boolHas the value true if the object exists in live mode or the value false if the object exists in test mode.
metadata: MetadataSet 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.
on_behalf_of: Option<Expandable<Account>>The account (if any) the charge was made on behalf of without triggering an automatic transfer.
See the Connect documentation for details.
outcome: Option<ChargeOutcome>Details about whether the payment was accepted, and why.
See understanding declines for details.
paid: booltrue if the charge succeeded, or was successfully authorized for later capture.
payment_intent: Option<Expandable<PaymentIntent>>ID of the PaymentIntent associated with this charge, if one exists.
payment_method: Option<String>ID of the payment method used in this charge.
payment_method_details: Option<PaymentMethodDetails>Details about the payment method at the time of the transaction.
radar_options: Option<RadarRadarOptions>§receipt_email: Option<String>This is the email address that the receipt for this charge was sent to.
receipt_number: Option<String>This is the transaction number that appears on email receipts sent for this charge.
This attribute will be null until a receipt has been sent.
receipt_url: Option<String>This is the URL to view the receipt for this charge.
The receipt is kept up-to-date to the latest state of the charge, including any refunds. If the charge is for an Invoice, the receipt will be stylized as an Invoice receipt.
refunded: boolWhether the charge has been fully refunded.
If the charge is only partially refunded, this attribute will still be false.
refunds: Option<List<Refund>>A list of refunds that have been applied to the charge.
review: Option<Expandable<Review>>ID of the review associated with this charge if one exists.
shipping: Option<Shipping>Shipping information for the charge.
source: Option<PaymentSource>This is a legacy field that will be removed in the future.
It contains the Source, Card, or BankAccount object used for the charge.
For details about the payment method used for this charge, refer to payment_method or payment_method_details instead.
source_transfer: Option<Expandable<Transfer>>The transfer ID which created this charge.
Only present if the charge came from another Stripe account. See the Connect documentation for details.
statement_descriptor: Option<String>For card charges, use statement_descriptor_suffix instead.
Otherwise, you can use this value as the complete description of a charge on your customers’ statements. Must contain at least one letter, maximum 22 characters.
statement_descriptor_suffix: Option<String>Provides information about the charge that customers see on their statements.
Concatenated with the prefix (shortened descriptor) or statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters for the concatenated descriptor.
status: ChargeStatusThe status of the payment is either succeeded, pending, or failed.
transfer: Option<Expandable<Transfer>>ID of the transfer to the destination account (only applicable if the charge was created using the destination parameter).
transfer_data: Option<TransferData>An optional dictionary including the account to automatically transfer to as part of a destination charge.
See the Connect documentation for details.
transfer_group: Option<String>A string that identifies this transaction as part of a group.
See the Connect documentation for details.
Implementations§
source§impl Charge
impl Charge
sourcepub fn list(client: &Client, params: &ListCharges<'_>) -> Response<List<Charge>>
pub fn list(client: &Client, params: &ListCharges<'_>) -> Response<List<Charge>>
Returns a list of charges you’ve previously created.
The charges are returned in sorted order, with the most recent charges appearing first.
sourcepub fn create(client: &Client, params: CreateCharge<'_>) -> Response<Charge>
pub fn create(client: &Client, params: CreateCharge<'_>) -> Response<Charge>
This method is no longer recommended—use the Payment Intents API to initiate a new payment instead.
Confirmation of the PaymentIntent creates the Charge object used to request payment.
sourcepub fn retrieve(
client: &Client,
id: &ChargeId,
expand: &[&str]
) -> Response<Charge>
pub fn retrieve( client: &Client, id: &ChargeId, expand: &[&str] ) -> Response<Charge>
Retrieves the details of a charge that has previously been created.
Supply the unique charge ID that was returned from your previous request, and Stripe will return the corresponding charge information. The same information is returned when creating or refunding the charge.
source§impl Charge
impl Charge
sourcepub fn capture(
client: &Client,
charge_id: &ChargeId,
params: CaptureCharge<'_>
) -> Response<Charge>
pub fn capture( client: &Client, charge_id: &ChargeId, params: CaptureCharge<'_> ) -> Response<Charge>
Capture captures a previously created charge with capture set to false.
For more details see https://stripe.com/docs/api#charge_capture.
sourcepub fn search(
client: &Client,
params: ChargeSearchParams<'_>
) -> Response<SearchList<Charge>>
pub fn search( client: &Client, params: ChargeSearchParams<'_> ) -> Response<SearchList<Charge>>
Searches for a charge.
For more details see https://stripe.com/docs/api/charges/search.