provider POST /v1/payment_records/{id}/report_refund
@utdk/stripe /v1/payment_records/{id}/report_refund
Report a refund
<p>Report that the most recent payment attempt on the specified Payment Record was refunded.</p>
id path required
The ID of the Payment Record.
string

Try it

Authentication
Configure credentials for Stripe API
postpaymentrecordsidreportrefund
POST/v1/payment_records/{id}/report_refund
<p>Report that the most recent payment attempt on the specified Payment Record was refunded.</p>

Parameters

required

The ID of the Payment Record.

Input

A positive integer in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal) representing how much of this payment to refund. Can refund only up to the remaining, unrefunded amount of the payment.

Specifies which fields in the response should be expanded.

When the reported refund was initiated. Measured in seconds since the Unix epoch.

Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.

required

The outcome of the reported refund.

required

Processor information for this refund.

required

Information about the payment attempt refund.

Configure credentials above to enable sending.

Code snippet
Updates live as you fill in the form above.

TypeScript

import stripe from '@utdk/stripe';

await stripe.postpaymentrecordsidreportrefund()