Struct Refund

Source
pub struct Refund {
Show 21 fields pub amount: i64, pub balance_transaction: Option<Expandable<BalanceTransaction>>, pub charge: Option<Expandable<Charge>>, pub created: i64, pub currency: Currency, pub description: Option<String>, pub destination_details: Option<RefundDestinationDetails>, pub failure_balance_transaction: Option<Expandable<BalanceTransaction>>, pub failure_reason: Option<String>, pub id: RefundId, pub instructions_email: Option<String>, pub metadata: Option<HashMap<String, String>>, pub next_action: Option<RefundNextAction>, pub payment_intent: Option<Expandable<PaymentIntent>>, pub pending_reason: Option<RefundPendingReason>, pub presentment_details: Option<PaymentFlowsPaymentIntentPresentmentDetails>, pub reason: Option<RefundReason>, pub receipt_number: Option<String>, pub source_transfer_reversal: Option<Expandable<TransferReversal>>, pub status: Option<String>, pub transfer_reversal: Option<Expandable<TransferReversal>>,
}
Expand description

Refund objects allow you to refund a previously created charge that isn’t refunded yet. Funds are refunded to the credit or debit card that’s initially charged.

Related guide: Refunds

For more details see <https://stripe.com/docs/api/refunds/object>.

Fields§

§amount: i64

Amount, in cents (or local equivalent).

§balance_transaction: Option<Expandable<BalanceTransaction>>

Balance transaction that describes the impact on your account balance.

§charge: Option<Expandable<Charge>>

ID of the charge that’s refunded.

§created: i64

Time at which the object was created. Measured in seconds since the Unix epoch.

§currency: Currency

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

§description: Option<String>

An arbitrary string attached to the object. You can use this for displaying to users (available on non-card refunds only).

§destination_details: Option<RefundDestinationDetails>§failure_balance_transaction: Option<Expandable<BalanceTransaction>>

After the refund fails, this balance transaction describes the adjustment made on your account balance that reverses the initial balance transaction.

§failure_reason: Option<String>

Provides the reason for the refund failure. Possible values are: lost_or_stolen_card, expired_or_canceled_card, charge_for_pending_refund_disputed, insufficient_funds, declined, merchant_request, or unknown.

§id: RefundId

Unique identifier for the object.

§instructions_email: Option<String>

For payment methods without native refund support (for example, Konbini, PromptPay), provide an email address for the customer to receive refund instructions.

§metadata: Option<HashMap<String, String>>

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.

§next_action: Option<RefundNextAction>§payment_intent: Option<Expandable<PaymentIntent>>

ID of the PaymentIntent that’s refunded.

§pending_reason: Option<RefundPendingReason>

Provides the reason for why the refund is pending. Possible values are: processing, insufficient_funds, or charge_pending.

§presentment_details: Option<PaymentFlowsPaymentIntentPresentmentDetails>§reason: Option<RefundReason>

Reason for the refund, which is either user-provided (duplicate, fraudulent, or requested_by_customer) or generated by Stripe internally (expired_uncaptured_charge).

§receipt_number: Option<String>

This is the transaction number that appears on email receipts sent for this refund.

§source_transfer_reversal: Option<Expandable<TransferReversal>>

The transfer reversal that’s associated with the refund. Only present if the charge came from another Stripe account.

§status: Option<String>

Status of the refund. This can be pending, requires_action, succeeded, failed, or canceled. Learn more about failed refunds.

§transfer_reversal: Option<Expandable<TransferReversal>>

This refers to the transfer reversal object if the accompanying transfer reverses. This is only applicable if the charge was created using the destination parameter.

Trait Implementations§

Source§

impl Clone for Refund

Source§

fn clone(&self) -> Refund

Returns a duplicate 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 Debug for Refund

Source§

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

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

impl Deserialize for Refund

Source§

fn begin(out: &mut Option<Refund>) -> &mut dyn Visitor

The only correct implementation of this method is: Read more
Source§

impl Object for Refund

Source§

type Id = RefundId

The canonical id type for this object.
Source§

fn id(&self) -> &<Refund as Object>::Id

The id of the object.
Source§

fn into_id(self) -> <Refund as Object>::Id

The owned id of the object.
Source§

impl ObjectDeser for Refund

Source§

type Builder = RefundBuilder

Auto Trait Implementations§

§

impl Freeze for Refund

§

impl RefUnwindSafe for Refund

§

impl Send for Refund

§

impl Sync for Refund

§

impl Unpin for Refund

§

impl UnwindSafe for Refund

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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> ToOwned for T
where T: Clone,

Source§

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>,

Source§

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>,

Source§

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