Attributes

• idstring

  Unique identifier for the object.

• amountinteger

  Amount, in the smallest currency unit.

• chargenullable stringExpandable

  ID of the charge that’s refunded.

• currencyenum

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

• descriptionnullable string

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

• metadatanullable map

  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.

• payment_intentnullable stringExpandable

  ID of the PaymentIntent that’s refunded.

• reasonnullable enum

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

  Possible enum values

  duplicate

  expired_uncaptured_charge

  fraudulent

  requested_by_customer

• statusnullable string

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

More attributes

Expand all

• objectstring, value is "refund"

• balance_transactionnullable stringExpandable

• createdtimestamp

• customernullable stringExpandable

• customer_accountnullable string

• destination_detailsnullable object

• failure_balance_transactionnullable stringExpandable

• failure_reasonnullable string

• instructions_emailnullable string

• next_actionnullable object

• payment_methodnullable stringExpandable

• pending_reasonnullable enum

• presentment_detailsnullable object

• receipt_numbernullable string

• source_transfer_reversalnullable stringExpandableConnect only

• transfer_reversalnullable stringExpandableConnect only

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.

Parameters

• amountinteger

  A positive integer in the smallest currency unit representing how much of this charge to refund. Can refund only up to the remaining, unrefunded amount of the charge.

• chargestring

  The identifier of the charge to refund.

• currencyenum

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

• customerstring

  Customer whose customer balance to refund from.

• instructions_emailstring

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

  The maximum length is 800 characters.

• metadatamap

  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.

• originenum

  Origin of the refund

  Possible enum values

  customer_balance

• payment_intentstring

  The identifier of the PaymentIntent to refund.

• reasonenum

  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.

  Possible enum values

  duplicate

  fraudulent

  requested_by_customer

• transfer_dataobjectConnect only

  An optional dictionary including the account to automatically transfer to as part of a destination charge. See the Connect documentation for details.

  Show child parameters

More parameters

Expand all

• refund_application_feebooleanConnect only

• reverse_transferbooleanConnect only

Updates the refund that you specify by setting the values of the passed parameters. Any parameters that you don’t provide remain unchanged.

This request only accepts metadata as an argument.

Parameters

• metadatamap

  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.

More parameters

Expand all

• idstringRequired