Struct CreateRefund

pub struct CreateRefund { /* private fields */ }

When you create a new refund, you must specify a Charge or a PaymentIntent object on which to create it.

Creating a new refund will refund a charge that has previously been created but not yet refunded. Funds will be refunded to the credit or debit card that was originally charged.

You can optionally refund only part of a charge. You can do so multiple times, until the entire charge has been refunded.

Once entirely refunded, a charge can’t be refunded again. This method will raise an error when called on an already-refunded charge, or when trying to refund more money than is left on a charge.

Implementations

impl CreateRefund

pub fn new() -> Self

Construct a new CreateRefund.

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

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

The identifier of the charge to refund.

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

Customer whose customer balance to refund from.

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

Specifies which fields in the response should be expanded.

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

For payment methods without native refund support (e.g., Konbini, PromptPay), use this email from the customer to receive refund instructions.

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 origin(self, origin: impl Into<CreateRefundOrigin>) -> Self

Origin of the refund

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

The identifier of the PaymentIntent to refund.

pub fn reason(self, reason: impl Into<CreateRefundReason>) -> Self

String indicating the reason for the refund. If set, possible values are duplicate, fraudulent, and requested_by_customer. If you believe the charge to be fraudulent, specifying fraudulent as the reason will add the associated card and email to your block lists, and will also help us improve our fraud detection algorithms.

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

Boolean indicating whether the application fee should be refunded when refunding this charge. If a full charge refund is given, the full application fee will be refunded. Otherwise, the application fee will be refunded in an amount proportional to the amount of the charge refunded. An application fee can be refunded only by the application that created the charge.

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

Boolean indicating whether the transfer should be reversed when refunding this charge. The transfer will be reversed proportionally to the amount being refunded (either the entire or partial amount).

A transfer can be reversed only by the application that created the charge.

impl CreateRefund

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 CreateRefund

fn clone(&self) -> CreateRefund

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CreateRefund

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

Formats the value using the given formatter.

impl Default for CreateRefund

fn default() -> Self

Returns the “default value” for a type.

impl Serialize for CreateRefund

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 CreateRefund

type Output = Refund

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.