The object is everything inside data. The field names below are relative to it: attributes.amount is data.attributes.amount in the response.
Fields
string
required
Refund ID (rfd_*).
string
required
Resource type. Always refund.
object
required
The refund’s details.
Hide attributes
integer
required
Amount in US cents.
string
required
Currency code. Always USD.
string | null
required
Why the refund was requested. One of: duplicate, fraudulent, requestedByPayer.
string
required
Refund status. Succeeded means the refund was processed, but the cardholder’s bank may not have posted the credit yet. One of: pending, succeeded, failed. See Statuses.
object | null
required
Failure details. Null unless the refund failed.
Hide failure
string | null
required
Failure code, when known. New codes may be added.
string | null
required
Explanation of the failure.
string | null
required
The refunded payment’s hosted receipt page, which lists this refund.
string
required
RFC 3339 timestamp when the refund was created.
string
required
RFC 3339 timestamp when the refund was last updated.
object
required
Related resources, each by type and ID.
Hide relationships
object
required
The intent whose payment is refunded.
Hide paymentIntent
object
required
Related resource identifier.
Hide data
string
required
Resource type. Always paymentIntent.
string
required
Payment intent ID (pmi_*).
object
required
The card payment refunded.
Hide cardPayment
object
required
Related resource identifier.
Hide data
string
required
Resource type. Always cardPayment.
string
required
Card payment ID (cpy_*).
object
required
The party that received the original payment.
Hide customerParty
object
required
Related resource identifier.
Hide data
string
required
Resource type. Always party.
string
required
ID of the party that received the original payment (pty_*).
Statuses
Status
Meaning
Can become
pending
Natural recorded the refund and is waiting for its outcome.
succeeded, failed
succeeded
The refund was processed. It does not confirm that the payer’s bank has posted the credit.
Final
failed
The refund didn’t go through. failure contains the available reason.
Final
Permissions
Create needs refunds.create. List and get need refunds.read.