Skip to content
Nappai Documentation

Stripe Refund

Stripe Refund manages the refunds in your Stripe account. It can refund a whole charge or only part of it, look up one refund or the list of refunds, and add a note to a refund.

When to use it

  • A customer cancels an order and you want to refund them without opening Stripe.
  • Your support team approves a partial refund for a damaged product.
  • You spot a duplicate charge and want to refund one of them, stating the reason.
  • You want a report of the refunds made.

Configuration

You need a Stripe API credential with the secret key of your Stripe account. See Credentials.

FieldWhat it does
Credential (required)The Stripe API credential of your account.
Operation (required)The action the component performs. Defaults to Create. See Operations.
ModeOnly in Get. By ID looks up one refund; All returns the list of refunds. Defaults to By ID.
Refund IDThe refund’s identifier in Stripe (starts with re_). Required in Get with By ID and in Update.
Charge IDOnly in Create, and required there. The charge being refunded (starts with ch_).
AmountOnly in Create. The amount to refund in the smallest unit of the currency, for example cents: 1500 is 15.00. Left empty, the whole charge is refunded.
ReasonOnly in Create. The reason for the refund: duplicate, fraudulent or requested_by_customer. Optional.
DescriptionOnly in Update. A note saved on the refund.
LimitOnly in Get with All. Maximum number of refunds returned, between 1 and 100. Defaults to 100.

Operations

  • Create: refunds a charge, in full or for the given amount.
  • Get: with By ID returns one refund; with All returns the list of refunds.
  • Update: saves a note on an existing refund.

Output

The Data output returns the refund that was created, looked up or updated. With Get and All, it returns one item per refund. Each item includes the refund’s identifier, the charge it belongs to, the amount and its status.

You can connect it to a confirmation email for the customer or to your support system to close the ticket. The component can also be connected to an Agent as a tool, so the agent decides when to use it. See Tool Mode.

Example

An online shop refunds the amount when support approves a return.

  1. When the return is approved in your support tool, the flow receives the charge’s identifier.
  2. Add Stripe Refund with Operation set to Create and pass the identifier to Charge ID.
  3. Leave Amount empty to refund everything and set Reason to requested_by_customer.
  4. Connect the Data output to an email that confirms the refund to the customer.

Good practices

  • Before refunding, check the charge with Stripe Charge so you do not refund the same amount twice.
  • If an agent uses this component as a tool, make clear in its instructions when it may refund money and up to what amount.