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.