Skip to main content
GET
Retrieve Refund

Autorisationer

Authorization
string
header
påkrævet

An Account API key, an App API key, an account access token, an account-scoped user token, or a user OAuth token. Prepend the key or token with Bearer, for example Bearer ***************************. See Auth & API keys for how to get each one.

Scopes

payment:basic:read

Overskrifter

Api-Version-Date
string

Pins the request to a dated API version.

Eksempel:

"2026-11-17"

Sti-parametre

id
string
påkrævet

The refund to retrieve, prefixed rf_.

Svar

refund retrieved

account_id
string | null
påkrævet

The account that issued the refund, prefixed biz_.

Eksempel:

"biz_xxxxxxxxxxxxxx"

amount
object | null
påkrævet

The refunded amount as it settled, in the payment's settlement currency, so pages of refunds net against the payment's refunded_amount. Converted at the rate in force when the refund was issued, not the payment's original rate. Null only when no exchange rate is recorded for a legacy multi-currency payment.

created_at
string
påkrævet

When the refund was requested, as an ISO 8601 timestamp.

Eksempel:

"2026-01-01T12:00:00.000Z"

failure_message
string | null
påkrævet

A merchant-facing explanation of why the refund failed, in the request's language. Null unless the refund failed or was canceled.

Eksempel:

"The customer's card is expired or was canceled."

failure_reason
enum<string> | null
påkrævet

Why the refund failed, normalized across providers. Null unless the refund failed or was canceled.

Tilgængelige muligheder:
bank_declined,
expired_or_canceled_card,
lost_or_stolen_card,
insufficient_funds,
charge_disputed,
not_refundable,
merchant_request,
unknown,
null
Eksempel:

"expired_or_canceled_card"

id
string
påkrævet

Refund ID, prefixed rf_.

Eksempel:

"rf_xxxxxxxxxxxxxx"

metadata
object | null
påkrævet

Your own key-value data attached when the refund was requested.

Eksempel:

null

original_amount
object
påkrævet

The refunded amount in the currency the processor moved.

payment_id
string
påkrævet

The payment this refund reverses, prefixed pay_.

Eksempel:

"pay_xxxxxxxxxxxxxx"

provider
string
påkrævet

The payment provider that processed the refund, such as paypal or coinbase.

Eksempel:

"stripe"

provider_created_at
string | null
påkrævet

When the provider created the refund, as an ISO 8601 timestamp.

Eksempel:

"2026-01-01T12:00:00.000Z"

reason
enum<string> | null
påkrævet

Why the refund was issued, when recorded.

Tilgængelige muligheder:
duplicate,
fraudulent,
requested_by_customer,
expired_uncaptured_charge,
dispute_alert,
null
Eksempel:

"duplicate"

reference_status
enum<string> | null
påkrævet

Whether a banking-network tracking reference is available for this refund.

Tilgængelige muligheder:
available,
pending,
unavailable,
null
Eksempel:

"available"

reference_type
enum<string> | null
påkrævet

The kind of tracking reference, such as an acquirer reference number.

Tilgængelige muligheder:
acquirer_reference_number,
retrieval_reference_number,
system_trace_audit_number,
null
Eksempel:

"acquirer_reference_number"

reference_value
string | null
påkrævet

The tracking reference the buyer's bank can trace the refund by.

Eksempel:

null

status
enum<string>
påkrævet

Where the refund stands with the processor: pending, requires_action, succeeded, failed, or canceled.

Tilgængelige muligheder:
pending,
requires_action,
succeeded,
failed,
canceled
Eksempel:

"failed"

updated_at
string
påkrævet

When the refund last changed, as an ISO 8601 timestamp.

Eksempel:

"2026-01-01T12:00:00.000Z"

visa_rdr
boolean
påkrævet

True when the card network initiated the refund through Rapid Dispute Resolution.

Eksempel:

false