Core Resources
Payment Methods
Money Management
Products
Product Catalog
Commerce
Agentic Commerce
Checkout
Payment Links
Billing
Capital
Connect
Reserves
Fraud
Issuing
Terminal
Treasury for Platforms
Payment Records
Account Evaluation
Entitlements
Sigma
Reporting
Financial Connections
Tax
Identity
Crypto
Climate
Tax Reporting
Forwarding
Privacy
Webhooks

Create a refund v1

POST /v1/refunds

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.

More parameters

  • refund_application_feebooleanConnect only

  • reverse_transferbooleanConnect only

Returns

Returns the Refund object if the refund succeeded. Raises an error if the Charge/PaymentIntent has already been refunded, or if an invalid identifier was provided.

curl https://api.stripe.com/v1/refunds \
  -u "sk_test_...sk_test_...:" \
  -H "Stripe-Version: 2026-10-28.endive" \
  -d charge=
Response
{
  "id": "",
  "object": "refund",
  "amount": 1000,
  "balance_transaction": "",
  "charge": "",
  "created": 1692942318,
  "currency": "usd",
  "destination_details": {
    "card": {
      "reference": "123456789012",
      "reference_status": "available",
      "reference_type": "acquirer_reference_number",
      "type": "refund"
    },
    "type": "card"
  },
  "metadata": {},
  "payment_intent": "",
  "reason": null,
  "receipt_number": null,
  "source_transfer_reversal": null,
  "status": "succeeded",
  "transfer_reversal": null
}

Update a refund v1

POST /v1/refunds/:id

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

  • idstringRequired

Returns

Returns the refund object if the update succeeds. This call raises an error if update parameters are invalid.

curl https://api.stripe.com/v1/refunds/ \
  -u "sk_test_...sk_test_...:" \
  -H "Stripe-Version: 2026-10-28.endive" \
  -d "metadata[order_id]=6735"
Response
{
  "id": "",
  "object": "refund",
  "amount": 1000,
  "balance_transaction": "",
  "charge": "",
  "created": 1692942318,
  "currency": "usd",
  "destination_details": {
    "card": {
      "reference": "123456789012",
      "reference_status": "available",
      "reference_type": "acquirer_reference_number",
      "type": "refund"
    },
    "type": "card"
  },
  "metadata": {
    "order_id": "6735"
  },
  "payment_intent": "",
  "reason": null,
  "receipt_number": null,
  "source_transfer_reversal": null,
  "status": "succeeded",
  "transfer_reversal": null
}

Retrieve a refund v1

GET /v1/refunds/:id

Retrieves the details of an existing refund.

Parameters

  • idstringRequired

    Unique identifier for the object.

Returns

Returns a refund if you provide a valid ID. Raises an error otherwise.

curl https://api.stripe.com/v1/refunds/ \
  -u "sk_test_...sk_test_...:" \
  -H "Stripe-Version: 2026-10-28.endive"
Response
{
  "id": "",
  "object": "refund",
  "amount": 1000,
  "balance_transaction": "",
  "charge": "",
  "created": 1692942318,
  "currency": "usd",
  "destination_details": {
    "card": {
      "reference": "123456789012",
      "reference_status": "available",
      "reference_type": "acquirer_reference_number",
      "type": "refund"
    },
    "type": "card"
  },
  "metadata": {},
  "payment_intent": "",
  "reason": null,
  "receipt_number": null,
  "source_transfer_reversal": null,
  "status": "succeeded",
  "transfer_reversal": null
}