
Stripe Refund
CertifiedCreate a Stripe refund
Stripe Refund
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.
type: io.kestra.plugin.stripe.payment.RefundExamples
Refund a payment by Charge ID
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
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
apiKey *Requiredstring
Stripe API Key
Secret key for authenticating with Stripe. Starts with 'sk_' for live/test keys.
amount integerstring
Refund amount
Amount in the smallest currency unit; defaults to full refund when null
chargeId string
Charge ID
Charge to refund; provide this or paymentIntentId
paymentIntentId string
PaymentIntent ID
PaymentIntent to refund; provide this or chargeId
pluginDefaultsRef Non-dynamicstring
Reference (ref) of the pluginDefaults to apply to this task.
Outputs
amount integer
Refunded amount
Amount in the smallest currency unit
currency string
Refund currency
raw string
Raw Stripe response
refundId string
Refund ID
status string
Refund status