Struct stripe::CreateRefund

source ·
pub struct CreateRefund<'a> {
    pub amount: Option<i64>,
    pub charge: Option<ChargeId>,
    pub currency: Option<Currency>,
    pub customer: Option<CustomerId>,
    pub expand: &'a [&'a str],
    pub instructions_email: Option<&'a str>,
    pub metadata: Option<Metadata>,
    pub origin: Option<RefundOrigin>,
    pub payment_intent: Option<PaymentIntentId>,
    pub reason: Option<RefundReasonFilter>,
    pub refund_application_fee: Option<bool>,
    pub reverse_transfer: Option<bool>,
}
Expand description

The parameters for Refund::create.

Fields§

§amount: Option<i64>§charge: Option<ChargeId>

The identifier of the charge to refund.

§currency: Option<Currency>

Three-letter ISO currency code, in lowercase.

Must be a supported currency.

§customer: Option<CustomerId>

Customer whose customer balance to refund from.

§expand: &'a [&'a str]

Specifies which fields in the response should be expanded.

§instructions_email: Option<&'a str>

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

§metadata: Option<Metadata>

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.

§origin: Option<RefundOrigin>

Origin of the refund.

§payment_intent: Option<PaymentIntentId>

The identifier of the PaymentIntent to refund.

§reason: Option<RefundReasonFilter>

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.

§refund_application_fee: Option<bool>

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.

§reverse_transfer: Option<bool>

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.

Implementations§

source§

impl<'a> CreateRefund<'a>

source

pub fn new() -> Self

Trait Implementations§

source§

impl<'a> Clone for CreateRefund<'a>

source§

fn clone(&self) -> CreateRefund<'a>

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl<'a> Debug for CreateRefund<'a>

source§

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

Formats the value using the given formatter. Read more
source§

impl<'a> Default for CreateRefund<'a>

source§

fn default() -> CreateRefund<'a>

Returns the “default value” for a type. Read more
source§

impl<'a> Serialize for CreateRefund<'a>

source§

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

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

§

impl<'a> RefUnwindSafe for CreateRefund<'a>

§

impl<'a> Send for CreateRefund<'a>

§

impl<'a> Sync for CreateRefund<'a>

§

impl<'a> Unpin for CreateRefund<'a>

§

impl<'a> UnwindSafe for CreateRefund<'a>

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> Same for T

§

type Output = T

Should always be Self
source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

source§

impl<T> WithSubscriber for T

source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more