Struct stripe::generated::core::refund::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 failure_balance_transaction: Option<Expandable<BalanceTransaction>>,
    pub failure_reason: Option<String>,
    pub instructions_email: Option<String>,
    pub metadata: 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 %s.

balance_transaction: Option<Expandable<BalanceTransaction>>

Balance transaction that describes the impact on your account balance.

charge: Option<Expandable<Charge>>

ID of the charge that was 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.

Often useful for displaying to users. (Available on non-card refunds only).

failure_balance_transaction: Option<Expandable<BalanceTransaction>>

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

failure_reason: Option<String>

If the refund failed, the reason for refund failure if known.

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>

Email to which refund instructions, if required, are sent to.

metadata: 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 was refunded.

reason: Option<RefundReason>

Reason for the refund, 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 is associated with the refund.

Only present if the charge came from another Stripe account. See the Connect documentation for details.

status: Option<String>

Status of the refund.

For credit card refunds, this can be pending, succeeded, or failed. For other types of refunds, it can be pending, requires_action, succeeded, failed, or canceled. Refer to our refunds documentation for more details.

transfer_reversal: Option<Expandable<TransferReversal>>

If the accompanying transfer was reversed, the transfer reversal object.

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’ve previously created.

The refunds are returned in sorted order, with the most recent refunds appearing first. For convenience, the 10 most recent refunds are always available by default on the charge object.

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

Create a refund.

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 specified refund by setting the values of the parameters passed.

Any parameters not provided will be left 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.