Skip to main content
Schema2020-08-27object

refund

`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. Related guide: [Refunds](https://stripe.com/docs/refunds).

Source
openapi/spec3.json
Commit
d70de345383d
Active snapshot
da69df7e6e11

Refund

object

`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. Related guide: [Refunds](https://stripe.com/docs/refunds).

amount integer
required

Amount, in %s.

balance_transaction
optionalnullable

Balance transaction that describes the impact on your account balance.

charge
optionalnullable

ID of the charge that was refunded.

created integer (unix-time)
required

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

currency string
required

Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).

description string
optional

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

failure_balance_transaction
optional

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

failure_reason string
optional

If the refund failed, the reason for refund failure if known. Possible values are `lost_or_stolen_card`, `expired_or_canceled_card`, or `unknown`.

id string
required

Unique identifier for the object.

metadata object
optionalnullable

Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

object string
required

String representing the object's type. Objects of the same type share the same value.

payment_intent
optionalnullable

ID of the PaymentIntent that was refunded.

reason string
optionalnullable

Reason for the refund, either user-provided (`duplicate`, `fraudulent`, or `requested_by_customer`) or generated by Stripe internally (`expired_uncaptured_charge`).

receipt_number string
optionalnullable

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

source_transfer_reversal
optionalnullable

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 string
optionalnullable

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](https://stripe.com/docs/refunds#failed-refunds) documentation for more details.

transfer_reversal
optionalnullable

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