Skip to main content
GET
Error

Authorizations

Authorization
string
header
required

A merchant secret key (sk_…) sent as Authorization: Bearer <key>.

Path Parameters

id
string
required

The refund id (rf_…).

Response

The refund.

id
string
required

The refund id (rf_…).

object
enum<string>
required

Always refund.

Available options:
refund
livemode
boolean
required

Mirrors the mode of the underlying charge.

charge_id
string
required

The refunded charge (ch_…).

payment_intent_id
string
required

The parent payment intent (pi_…).

terminal_id
string | null
required

Terminal (tmr_…) selected for the Refund request, or null when no terminal was supplied.

amount
integer
required

The refunded amount, in minor units. Full or partial.

currency
string
required

The refund's currency, matching amount's currency.

status
enum<string>
required

pending while the Refund is being processed; uncertain when its final outcome is not known yet. Retrieve the Refund again before retrying.

Available options:
pending,
succeeded,
failed,
uncertain
reason
enum<string> | null
required

An optional audit/reporting category — one of requested_by_customer, duplicate, or fraudulent. Null when not supplied; has no effect on refund behavior.

Available options:
requested_by_customer,
duplicate,
fraudulent
settlement_batch_id
string | null
required

Terminal batch (tmb_…) containing this Refund. Null until the Refund is settled in a batch.

settled_at
integer | null
required

Unix epoch seconds when the Refund settled. Null until settlement completes.

failure_message
string | null
required

A human-readable failure detail. Nullable; present when the refund failed.

created_at
integer
required

Unix epoch seconds when the refund was created.

updated_at
integer
required

Unix epoch seconds when the refund was last updated.