Struct CreateCharge

pub struct CreateCharge { /* private fields */ }

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.

Implementations

impl CreateCharge

pub fn new() -> Self

Construct a new CreateCharge.

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

Amount 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).

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

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

A fee in cents (or local equivalent) that will be applied to the charge and transferred to the application owner’s Stripe account. The request must be made with an OAuth key or the Stripe-Account header in order to take an application fee. For more information, see the application fees documentation.

pub fn capture(self, capture: impl Into<bool>) -> Self

Whether to immediately capture the charge. Defaults to true. When false, the charge issues an authorization (or pre-authorization), and will need to be captured later. Uncaptured charges expire after a set number of days (7 by default). For more information, see the authorizing charges and settling later documentation.

pub fn currency(self, currency: impl Into<Currency>) -> Self

Three-letter ISO currency code, in lowercase. Must be a supported currency.

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

The ID of an existing customer that will be charged in this request.

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

An arbitrary string which you can attach to a Charge object. It is displayed when in the web interface alongside the charge. Note that if you use Stripe to send automatic email receipts to your customers, your receipt emails will include the description of the charge(s) that they are describing.

pub fn destination( self, destination: impl Into<CreateChargeDestination>, ) -> Self

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

Specifies which fields in the response should be expanded.

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

Set 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.

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

The Stripe account ID for which these funds are intended. Automatically set if you use the destination parameter. For details, see Creating Separate Charges and Transfers.

pub fn radar_options( self, radar_options: impl Into<CreateChargeRadarOptions>, ) -> Self

Options to configure Radar. See Radar Session for more information.

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

The email address to which this charge’s receipt will be sent. The receipt will not be sent until the charge is paid, and no receipts will be sent for test mode charges. If this charge is for a Customer, the email address specified here will override the customer’s email address. If receipt_email is specified for a charge in live mode, a receipt will be sent regardless of your email settings.

pub fn shipping(self, shipping: impl Into<OptionalFieldsShipping>) -> Self

Shipping information for the charge. Helps prevent fraud on charges for physical goods.

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

A payment source to be charged. This can be the ID of a card (i.e., credit or debit card), a bank account, a source, a token, or a connected account. For certain sources—namely, cards, bank accounts, and attached sources—you must also pass the ID of the associated customer.

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<CreateChargeTransferData>, ) -> 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. For details, see Grouping transactions.

impl CreateCharge

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 CreateCharge

fn clone(&self) -> CreateCharge

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CreateCharge

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

Formats the value using the given formatter.

impl Default for CreateCharge

fn default() -> Self

Returns the “default value” for a type.

impl Serialize for CreateCharge

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 CreateCharge

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.