Create a refund

Changed on

When you create a new refund, you must specify a Charge or a PaymentIntent object on which to create it.

Creating a new refund will 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.

You can optionally refund only part of a charge. You can do so multiple times, until the entire charge has been refunded.

Once entirely refunded, a charge can’t be refunded again. This method will raise an error when called on an already-refunded charge, or when trying to refund more money than is left on a charge.

post/v1/refunds

Request

  • Base URL: https://api.stripe.com
  • URL: https://api.stripe.com/v1/refunds
  • Auth: one of:
    • HTTP basic
    • HTTP bearer

Request body application/x-www-form-urlencoded

amountinteger
chargestring

The identifier of the charge to refund.

currencystring currency

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

customerstring

Customer whose customer balance to refund from.

expandstring[]

Specifies which fields in the response should be expanded.

instructions_emailstring

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

origin'customer_balance'

Origin of the refund

payment_intentstring

The identifier of the PaymentIntent to refund.

reason'duplicate' | 'fraudulent' | 'requested_by_customer'

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.

refund_application_feeboolean

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.

reverse_transferboolean

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.

Response

Successful response.

amountinteger required

Amount, in cents (or local equivalent).

createdinteger required

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

currencystring currency required

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

customer_accountstring nullable

ID of the account of this refund.

descriptionstring

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

failure_reasonstring

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.

idstring required

Unique identifier for the object.

instructions_emailstring

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

metadataobject nullable

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.

object'refund' required

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

pending_reason'charge_pending' | 'insufficient_funds' | 'processing'

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

reason'duplicate' | 'expired_uncaptured_charge' | 'fraudulent' | 'requested_by_customer' nullable

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

receipt_numberstring nullable

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

statusstring nullable

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

Changes

  • c113b1939b8fRevision changes
    • info

      added the optional property ////// to the response with the status

  • 7b8f614372caRevision changes
    • info

      added the optional property ////////// to the response with the status

Some revisions have not been checked yet.