Skip to main content
GET
Retrieve refund
This page documents the Legacy API. For new integrations, use Retrieve Refund in the Current API.
Required permissions:
  • payment:basic:read
  • plan:basic:read
  • access_pass:basic:read
  • member:email:read
  • member:basic:read
  • member:phone:read

인증

Authorization
string
header
필수

An Account API key, account-scoped JWT, App API key, or user OAuth token. Prepend the key or token with Bearer, for example Bearer ***************************.

Scopes

payment:basic:read
plan:basic:read
access_pass:basic:read
member:email:read
member:basic:read
member:phone:read

경로 매개변수

id
string
필수

The unique identifier of the refund.

예시:

"rf_xxxxxxxxxxxxxxx"

응답

A successful response

A refund represents a full or partial reversal of a payment, including the amount, status, and payment provider.

amount
number
필수

The refunded amount as a decimal in the specified currency, such as 10.43 for $10.43 USD.

예시:

6.9

created_at
string<date-time>
필수

The datetime the refund was created.

예시:

"2023-12-01T05:00:00.401Z"

currency
enum<string>
필수

The three-letter ISO currency code for the refunded amount.

사용 가능한 옵션:
usd,
sgd,
inr,
aud,
brl,
cad,
dkk,
eur,
nok,
gbp,
sek,
chf,
hkd,
huf,
jpy,
mxn,
myr,
pln,
czk,
nzd,
aed,
eth,
ape,
cop,
ron,
thb,
bgn,
idr,
dop,
php,
try,
krw,
twd,
vnd,
pkr,
clp,
uyu,
ars,
zar,
dzd,
tnd,
mad,
kes,
kwd,
jod,
all,
xcd,
amd,
bsd,
bhd,
bob,
bam,
khr,
crc,
xof,
egp,
etb,
gmd,
ghs,
gtq,
gyd,
ils,
jmd,
mop,
mga,
mur,
mdl,
mnt,
nad,
ngn,
mkd,
omr,
pyg,
pen,
qar,
rwf,
sar,
rsd,
lkr,
tzs,
ttd,
uzs,
rub,
btc,
cny,
usdt,
kzt,
awg,
whop_usd,
xau,
hnl
id
string
필수

The unique identifier for the refund.

예시:

"rf_xxxxxxxxxxxxxxx"

metadata
object | null
필수

The custom metadata attached when this refund was requested.

payment
object | null
필수

The original payment that this refund was issued against. Null if the payment is no longer available.

provider
enum<string>
필수

The payment provider that processed the refund.

사용 가능한 옵션:
stripe,
coinbase,
paypal,
apple,
sezzle,
splitit,
platform_balance,
multi_psp,
adyen,
claritypay,
flex_pay,
checkout_dot_com,
airwallex,
coinflow,
sequra,
dlocal,
masspay,
braintree
provider_created_at
string<date-time> | null
필수

The timestamp when the refund was created in the payment provider's system. Null if not available from the provider.

예시:

"2023-12-01T05:00:00.401Z"

reference_status
enum<string> | null
필수

The availability status of the refund tracking reference from the payment processor. Null if no reference was provided.

사용 가능한 옵션:
available,
pending,
unavailable
reference_type
enum<string> | null
필수

The type of tracking reference provided by the payment processor, such as an acquirer reference number. Null if no reference was provided.

사용 가능한 옵션:
acquirer_reference_number,
retrieval_reference_number,
system_trace_audit_number
reference_value
string | null
필수

The tracking reference value from the payment processor, used to trace the refund through banking networks. Null if no reference was provided.

예시:

"74850120752"

status
enum<string>
필수

The current processing status of the refund, such as pending, succeeded, or failed.

사용 가능한 옵션:
pending,
requires_action,
succeeded,
failed,
canceled