Refund a payment in Stripe.

Issue a full or partial refund for a payment using Stripe.

yaml
type: "io.kestra.plugin.stripe.payment.refund"

Examples

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.RefundPayment
    apiKey: "{{ secret('STRIPE_API_KEY') }}"
    paymentIntentId: "pi_123456789"
    amount: 500  # amount in cents

Properties

apiKey *string

Stripe API Key

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

amount integerstring

The amount to refund in cents (optional). If not set, a full refund is issued.

chargeId string

The charge ID to refund. Either chargeId or paymentIntentId must be provided.

paymentIntentId string

The PaymentIntent ID to refund. Either chargeId or paymentIntentId must be provided.

Outputs

amount integer

The refunded amount in cents

currency string

The refund currency

raw string

The raw JSON response from Stripe

refundId string

The refund ID

status string

The refund status