Struct CaptureCharge

pub struct CaptureCharge { /* private fields */ }

Capture the payment of an existing, uncaptured charge that was created with the capture option set to false.

Uncaptured payments expire a set number of days after they are created (7 by default), after which they are marked as refunded and capture attempts will fail.

Don’t use this method to capture a PaymentIntent-initiated charge. Use Capture a PaymentIntent.

Implementations

impl CaptureCharge

pub fn new(charge: impl Into<ChargeId>) -> Self

Construct a new CaptureCharge.

pub fn amount(self, amount: impl Into<i64>) -> Self

The amount to capture, which must be less than or equal to the original amount.

pub fn application_fee(self, application_fee: impl Into<i64>) -> Self

An application fee to add on to this charge.

pub fn application_fee_amount( self, application_fee_amount: impl Into<i64>, ) -> Self

An application fee amount to add on to this charge, which must be less than or equal to the original amount.

pub fn expand(self, expand: impl Into<Vec<String>>) -> Self

Specifies which fields in the response should be expanded.

pub fn receipt_email(self, receipt_email: impl Into<String>) -> Self

The email address to send this charge’s receipt to. This will override the previously-specified email address for this charge, if one was set. Receipts will not be sent in test mode.

pub fn statement_descriptor( self, statement_descriptor: impl Into<String>, ) -> Self

For a non-card charge, text that appears on the customer’s statement as the statement descriptor. This value overrides the account’s default statement descriptor. For information about requirements, including the 22-character limit, see the Statement Descriptor docs.

For a card charge, this value is ignored unless you don’t specify a statement_descriptor_suffix, in which case this value is used as the suffix.

pub fn statement_descriptor_suffix( self, statement_descriptor_suffix: impl Into<String>, ) -> Self

Provides information about a card charge. Concatenated to the account’s statement descriptor prefix to form the complete statement descriptor that appears on the customer’s statement. If the account has no prefix value, the suffix is concatenated to the account’s statement descriptor.

pub fn transfer_data( self, transfer_data: impl Into<CaptureChargeTransferData>, ) -> Self

An optional dictionary including the account to automatically transfer to as part of a destination charge. See the Connect documentation for details.

pub fn transfer_group(self, transfer_group: impl Into<String>) -> Self

A string that identifies this transaction as part of a group. transfer_group may only be provided if it has not been set. See the Connect documentation for details.

impl CaptureCharge

pub async fn send<C: StripeClient>( &self, client: &C, ) -> Result<<Self as StripeRequest>::Output, C::Err>

Send the request and return the deserialized response.

pub fn send_blocking<C: StripeBlockingClient>( &self, client: &C, ) -> Result<<Self as StripeRequest>::Output, C::Err>

Send the request and return the deserialized response, blocking until completion.

Trait Implementations

impl Clone for CaptureCharge

fn clone(&self) -> CaptureCharge

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CaptureCharge

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

Formats the value using the given formatter.

impl Serialize for CaptureCharge

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StripeRequest for CaptureCharge

type Output = Charge

The data returned from the eventual API call.

fn build(&self) -> RequestBuilder

Convert the struct into library-agnostic data that can be used by compatible clients to make API calls.

fn customize(&self) -> CustomizableStripeRequest<Self::Output>

Convert to a builder allowing per-request customization.