Struct Refund

pub struct Refund {

    pub amount: i64,
    pub balance_transaction: Option<Value>,
    pub charge: Option<Value>,
    pub created: i64,
    pub currency: String,
    pub description: Option<String>,
    pub destination_details: Option<RefundDestinationDetails>,
    pub failure_balance_transaction: Option<Value>,
    pub failure_reason: Option<String>,
    pub id: String,
    pub instructions_email: Option<String>,
    pub metadata: Option<Value>,
    pub next_action: Option<RefundNextAction>,
    pub object: String,
    pub payment_intent: Option<Value>,
    pub reason: Option<String>,
    pub receipt_number: Option<String>,
    pub source_transfer_reversal: Option<Value>,
    pub status: Option<String>,
    pub transfer_reversal: Option<Value>,
}

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

Fields

amount: i64

Amount, in cents (or local equivalent).

balance_transaction: Option<Value>

Balance transaction that describes the impact on your account balance.

charge: Option<Value>

ID of the charge that’s refunded.

created: i64

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

currency: String

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

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: String

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

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>

object: String

String representing the object’s type. Objects of the same type share the same value.

payment_intent: Option<Value>

ID of the PaymentIntent that’s refunded.

reason: Option<String>

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

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

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

impl Clone for Refund

fn clone(&self) -> Refund

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Refund

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

Formats the value using the given formatter.

impl Default for Refund

fn default() -> Refund

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Refund

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Refund

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

Formats the value using the given formatter.

impl Serialize for Refund

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

where __S: Serializer,

Serialize this value into the given Serde serializer.