Stripe Refund

Stripe Refund

Certified

Create a Stripe refund

Issues a full or partial refund for a charge or PaymentIntent. Requires either chargeId or paymentIntentId; amount defaults to full if omitted.

yaml
type: io.kestra.plugin.stripe.payment.Refund

Refund a payment by Charge ID

yaml
id: refund_payment
namespace: company.team

tasks:
  - id: refund_payment
    type: io.kestra.plugin.stripe.payment.Refund
    apiKey: "{{ secret('STRIPE_API_KEY') }}"
    chargeId: "ch_123456789"

Refund a specific amount for a PaymentIntent

yaml
id: refund_partial
namespace: company.team

tasks:
  - id: refund_partial
    type: io.kestra.plugin.stripe.payment.Refund
    apiKey: "{{ secret('STRIPE_API_KEY') }}"
    paymentIntentId: "pi_123456789"
    amount: 500  # amount in cents
Properties

Stripe API Key

Secret key for authenticating with Stripe. Starts with 'sk_' for live/test keys.

Refund amount

Amount in the smallest currency unit; defaults to full refund when null

Charge ID

Charge to refund; provide this or paymentIntentId

PaymentIntent ID

PaymentIntent to refund; provide this or chargeId

Reference (ref) of the pluginDefaults to apply to this task.

Refunded amount

Amount in the smallest currency unit

Refund currency

Raw Stripe response

Refund ID

Refund status