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

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

Properties

Link copied to clipboard
val amount: Long?

Amount, in cents.

Link copied to clipboard
val balanceTransaction: String?

Balance transaction that describes the impact on your account balance.

Link copied to clipboard
val chargeId: String?

ID of the charge that was refunded

Link copied to clipboard
val created: Long?

Time at which the refund was created. Measured in seconds since the Unix epoch.

Link copied to clipboard
val currency: String?

Three-letter ISO currency code, in lowercase. Must be a supported currency.

Link copied to clipboard
val description: String?

An arbitrary string attached to the object. Often useful for displaying to users. (Available on non-card refunds only)

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.

Link copied to clipboard
val failureReason: 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.

Link copied to clipboard
val id: String

Unique identifier for the object.

Link copied to clipboard
val metadata: Map<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.

Link copied to clipboard
val paymentIntentId: String?

ID of the PaymentIntent that was refunded

Link copied to clipboard
val paymentMethodDetails: PaymentMethodDetails? = null

A PaymentMethodDetails object containing more details about the refund

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

Link copied to clipboard
val receiptNumber: String?

This is the transaction number that appears on email receipts sent for this refund.

Link copied to clipboard
val sourceTransferReversal: String?

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.

Link copied to clipboard
val status: 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.

Link copied to clipboard
val transferReversal: String?

If the accompanying transfer was reversed, the transfer reversal object. Only applicable if the charge was created using the destination parameter.