Struct stripe::Refund [−][src]
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
, or unknown
.
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.
payment_intent: Option<Expandable<PaymentIntent>>
ID of the PaymentIntent that was refunded.
reason: Option<String>
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
, 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
[src]
pub fn list(client: &Client, params: ListRefunds<'_>) -> Response<List<Refund>>
[src]
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>
[src]
Create a refund.
pub fn retrieve(
client: &Client,
id: &RefundId,
expand: &[&str]
) -> Response<Refund>
[src]
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>
[src]
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
[src]
impl Debug for Refund
[src]
impl<'de> Deserialize<'de> for Refund
[src]
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
[src]
__D: Deserializer<'de>,
impl Object for Refund
[src]
type Id = RefundId
The canonical id type for this object.
fn id(&self) -> Self::Id
[src]
fn object(&self) -> &'static str
[src]
impl Serialize for Refund
[src]
Auto Trait Implementations
impl RefUnwindSafe for Refund
[src]
impl Send for Refund
[src]
impl Sync for Refund
[src]
impl Unpin for Refund
[src]
impl UnwindSafe for Refund
[src]
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
pub fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> DeserializeOwned for T where
T: for<'de> Deserialize<'de>,
[src]
T: for<'de> Deserialize<'de>,
impl<T> From<T> for T
[src]
impl<T> Instrument for T
[src]
pub fn instrument(self, span: Span) -> Instrumented<Self>
[src]
pub fn in_current_span(self) -> Instrumented<Self>
[src]
impl<T> Instrument for T
[src]
pub fn instrument(self, span: Span) -> Instrumented<Self>
[src]
pub fn in_current_span(self) -> Instrumented<Self>
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> Same<T> for T
type Output = T
Should always be Self
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
pub fn to_owned(&self) -> T
[src]
pub fn clone_into(&self, target: &mut T)
[src]
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
[src]
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
V: MultiLane<T>,
pub fn vzip(self) -> V
impl<T> WithSubscriber for T
[src]
pub fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
[src]
S: Into<Dispatch>,