Struct stripe::Refund

pub struct Refund {

    pub id: RefundId,
    pub amount: i64,
    pub balance_transaction: Option<Expandable<BalanceTransaction>>,
    pub charge: Option<Expandable<Charge>>,
    pub created: Timestamp,
    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 instructions_email: Option<String>,
    pub metadata: Option<Metadata>,
    pub next_action: Option<RefundNextAction>,
    pub payment_intent: Option<Expandable<PaymentIntent>>,
    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>>,
}

The resource representing a Stripe “Refund”.

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

Fields

id: RefundId

Unique identifier for the object.

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

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.

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

next_action: Option<RefundNextAction>

payment_intent: Option<Expandable<PaymentIntent>>

ID of the PaymentIntent that’s refunded.

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.

Implementations

impl Refund

pub fn list(client: &Client, params: &ListRefunds<'_>) -> Response<List<Refund>>

Returns a list of all refunds you created.

We return the refunds in sorted order, with the most recent refunds appearing first The 10 most recent refunds are always available by default on the Charge object.

pub fn create(client: &Client, params: CreateRefund<'_>) -> Response<Refund>

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.

pub fn retrieve( client: &Client, id: &RefundId, expand: &[&str] ) -> Response<Refund>

Retrieves the details of an existing refund.

pub fn update( client: &Client, id: &RefundId, params: UpdateRefund<'_> ) -> Response<Refund>

Updates the refund that you specify by setting the values of the passed parameters.

Any parameters that you don’t provide remain unchanged. This request only accepts metadata as an argument.

Trait Implementations

impl Clone for Refund

fn clone(&self) -> Refund

Returns a copy 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 Object for Refund

type Id = RefundId

The canonical id type for this object.

fn id(&self) -> Self::Id

The id of the object.

fn object(&self) -> &'static str

The object’s type, typically represented in wire format as the object property.

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.