Refund

@JsonClass(generateAdapter = true)
data class Refund : Parcelable

Refund objects allow you to 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.

See the API guide for Refunds for more information.

Functions

describeContents
Link copied to clipboard
abstract fun describeContents(): Int
writeToParcel
Link copied to clipboard
abstract fun writeToParcel(p0: Parcel, p1: Int)

Properties

amount
Link copied to clipboard
val amount: Long?
Amount, in cents.
balanceTransaction
Link copied to clipboard
val balanceTransaction: String?
Balance transaction that describes the impact on your account balance.
chargeId
Link copied to clipboard
val chargeId: String?
ID of the charge that was refunded
currency
Link copied to clipboard
val currency: String?
Three-letter ISO currency code, in lowercase.
description
Link copied to clipboard
val description: String?
An arbitrary string attached to the object.
failureBalanceTransaction
Link copied to clipboard
val failureBalanceTransaction: String?
If the refund failed, this balance transaction describes the adjustment made on your account balance that reverses the initial balance transaction.
failureReason
Link copied to clipboard
val failureReason: String?
If the refund failed, the reason for refund failure if known.
id
Link copied to clipboard
val id: String
Unique identifier for the object.
metadata
Link copied to clipboard
val metadata: Map<String, String>?
Set of key-value pairs that you can attach to an object.
paymentIntentId
Link copied to clipboard
val paymentIntentId: String?
ID of the PaymentIntent that was refunded
reason
Link copied to clipboard
val reason: String?
Reason for the refund, either user-provided (duplicate, fraudulent, or requested_by_customer) or generated by Stripe internally (expired_uncaptured_charge).
receiptNumber
Link copied to clipboard
val receiptNumber: String?
This is the transaction number that appears on email receipts sent for this refund.
sourceTransferReversal
Link copied to clipboard
val sourceTransferReversal: String?
The transfer reversal that is associated with the refund.
status
Link copied to clipboard
val status: String?
Status of the refund.
transferReversal
Link copied to clipboard
val transferReversal: String?
If the accompanying transfer was reversed, the transfer reversal object.