action stripe_post_refunds { label: "PostRefunds" description: "

Create a refund.

" provider: stripe method: POST path: "/v1/refunds" encoding: form output: { type: "object" description: "`Refund` objects allow you to refund a charge that has previously been created\nbut not yet refunded. Funds will be refunded to the credit or debit card that\nwas originally charged.\n\nRelated guide: [Refunds](https://stripe.com/docs/refunds)." required: ["amount", "created", "currency", "id", "object"] properties: { amount: { type: "integer" description: "Amount, in %s." } balance_transaction: { description: "Balance transaction that describes the impact on your account balance." type: "object" } charge: { description: "ID of the charge that was refunded." type: "object" } created: { type: "integer" format: "unix-time" description: "Time at which the object was created. Measured in seconds since the Unix epoch." } currency: { type: "string" description: "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies)." } description: { type: "string" description: "An arbitrary string attached to the object. Often useful for displaying to users. (Available on non-card refunds only)" } failure_balance_transaction: { description: "If the refund failed, this balance transaction describes the adjustment made on your account balance that reverses the initial balance transaction." type: "object" } failure_reason: { type: "string" description: "If the refund failed, the reason for refund failure if known. Possible values are `lost_or_stolen_card`, `expired_or_canceled_card`, `charge_for_pending_refund_disputed`, `insufficient_funds`, `declined`, `merchant_request` or `unknown`." } id: { type: "string" description: "Unique identifier for the object." } instructions_email: { type: "string" description: "Email to which refund instructions, if required, are sent to." } metadata: { type: "object" description: "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format." } next_action: { type: "object" required: ["type"] properties: { display_details: { description: "Contains the refund details." type: "object" } type: { type: "string" description: "Type of the next action to perform." } } } object: { type: "string" description: "String representing the object's type. Objects of the same type share the same value." enum: ["refund"] } payment_intent: { description: "ID of the PaymentIntent that was refunded." type: "object" } reason: { type: "string" description: "Reason for the refund, either user-provided (`duplicate`, `fraudulent`, or `requested_by_customer`) or generated by Stripe internally (`expired_uncaptured_charge`)." enum: ["duplicate", "expired_uncaptured_charge", "fraudulent", "requested_by_customer"] } receipt_number: { type: "string" description: "This is the transaction number that appears on email receipts sent for this refund." } source_transfer_reversal: { description: "The transfer reversal that is associated with the refund. Only present if the charge came from another Stripe account. See the Connect documentation for details." type: "object" } status: { type: "string" description: "Status of the refund. For credit card refunds, this can be `pending`, `succeeded`, or `failed`. For other types of refunds, it can be `pending`, `requires_action`, `succeeded`, `failed`, or `canceled`. Refer to our [refunds](https://stripe.com/docs/refunds#failed-refunds) documentation for more details." } transfer_reversal: { description: "If the accompanying transfer was reversed, the transfer reversal object. Only applicable if the charge was created using the destination parameter." type: "object" } } } }