Create refund

Use stripe.createRefund to refund a Stripe charge, PaymentIntent, or customer balance.

Example

automations/stripe-create-refund.automation.ts

import { automation, onDashboardRun } from "automate.ax"
import { stripe } from "automate.ax/stripe"

export default automation("Create refund", () => {
  onDashboardRun({ title: "Create refund" })

  stripe.createRefund({
    paymentIntent: "pi_123",
    amount: 2500,
    reason: "requested_by_customer",
  })
})

Inputs

Provide exactly one refund source: a charge, a paymentIntent, or the customer-balance fields origin: "customer_balance", customer, and currency. Omit amount for the remaining refundable amount. idempotencyKey is optional. Stripe Refund IDs can use different prefixes depending on the refund source and payment method. Common examples include re_ for card refunds, rcb_ for customer-balance refunds, and pyr_ for selected local payment methods. Inputs use camel case and accept compatible signals. Automate.ax converts provider fields to Stripe’s wire format. Metadata keys remain unchanged.

Output

Returns the created Stripe Refund. Output fields use camel case.

Built-in triggers

Built-in actions

Runtime utilities

Integrations

Example

Inputs

Output

​Example

​Inputs

​Output

Example

Inputs

Output