Create customer balance refund

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

Customer whose customer balance to refund from.

Specifies which fields in the response should be expanded.

For payment methods without native refund support (e.g., Konbini, PromptPay), use this email from the customer to receive refund instructions.

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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.

Origin of the refund

The identifier of the PaymentIntent to refund.

String indicating the reason for the refund. If set, possible values are duplicate, fraudulent, and requested_by_customer. If you believe the charge to be fraudulent, specifying fraudulent as the reason will add the associated card and email to your block lists, and will also help us improve our fraud detection algorithms.

Boolean indicating whether the application fee should be refunded when refunding this charge. If a full charge refund is given, the full application fee will be refunded. Otherwise, the application fee will be refunded in an amount proportional to the amount of the charge refunded. An application fee can be refunded only by the application that created the charge.

Boolean indicating whether the transfer should be reversed when refunding this charge. The transfer will be reversed proportionally to the amount being refunded (either the entire or partial amount).<br><br>A transfer can be reversed only by the application that created the charge.

Amount, in cents (or local equivalent).

Balance transaction that describes the impact on your account balance.

ID of the charge that's refunded.

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

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

An arbitrary string attached to the object. You can use this for displaying to users (available on non-card refunds only).

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

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.

Unique identifier for the object.

For payment methods without native refund support (for example, Konbini, PromptPay), provide an email address for the customer to receive refund instructions.

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.

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

ID of the PaymentIntent that's refunded.

Provides the reason for why the refund is pending. Possible values are: processing, insufficient_funds, or charge_pending.

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

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

The transfer reversal that's associated with the refund. Only present if the charge came from another Stripe account.

Status of the refund. This can be pending, requires_action, succeeded, failed, or canceled. Learn more about failed refunds.

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.