Chuyển đến nội dung chính
brand_id
string
bắt buộc

Brand id this refund belongs to

business_id
string
bắt buộc

The unique identifier of the business issuing the refund.

created_at
string<date-time>
bắt buộc

The timestamp of when the refund was created in UTC.

customer
object
bắt buộc

Details about the customer for this refund (from the associated payment)

is_partial
boolean
bắt buộc

If true the refund is a partial refund

metadata
Metadata · object
bắt buộc

Additional metadata stored with the refund.

payment_id
string
bắt buộc

The unique identifier of the payment associated with the refund.

refund_id
string
bắt buộc

The unique identifier of the refund.

status
enum<string>
bắt buộc

The current status of the refund.

Tùy chọn có sẵn:
succeeded,
failed,
pending,
review
amount
integer<int32> | null

The refunded amount.

currency
null | enum<string>

The currency of the refund, represented as an ISO 4217 currency code.

Tùy chọn có sẵn:
AED,
ALL,
AMD,
ANG,
AOA,
ARS,
AUD,
AWG,
AZN,
BAM,
BBD,
BDT,
BGN,
BHD,
BIF,
BMD,
BND,
BOB,
BRL,
BSD,
BWP,
BYN,
BZD,
CAD,
CHF,
CLP,
CNY,
COP,
CRC,
CUP,
CVE,
CZK,
DJF,
DKK,
DOP,
DZD,
EGP,
ETB,
EUR,
FJD,
FKP,
GBP,
GEL,
GHS,
GIP,
GMD,
GNF,
GTQ,
GYD,
HKD,
HNL,
HRK,
HTG,
HUF,
IDR,
ILS,
INR,
IQD,
JMD,
JOD,
JPY,
KES,
KGS,
KHR,
KMF,
KRW,
KWD,
KYD,
KZT,
LAK,
LBP,
LKR,
LRD,
LSL,
LYD,
MAD,
MDL,
MGA,
MKD,
MMK,
MNT,
MOP,
MRU,
MUR,
MVR,
MWK,
MXN,
MYR,
MZN,
NAD,
NGN,
NIO,
NOK,
NPR,
NZD,
OMR,
PAB,
PEN,
PGK,
PHP,
PKR,
PLN,
PYG,
QAR,
RON,
RSD,
RUB,
RWF,
SAR,
SBD,
SCR,
SEK,
SGD,
SHP,
SLE,
SLL,
SOS,
SRD,
SSP,
STN,
SVC,
SZL,
THB,
TND,
TOP,
TRY,
TTD,
TWD,
TZS,
UAH,
UGX,
USD,
UYU,
UZS,
VES,
VND,
VUV,
WST,
XAF,
XCD,
XOF,
XPF,
YER,
ZAR,
ZMW
network_reference
string | null

The reference number that the card network or the bank gives to the refund. The customer can give this number to their bank to trace the refund. It is null until the reference is available.

network_reference_type
null | enum<string>

The kind of network_reference: ARN, STAN or RRN.

Tùy chọn có sẵn:
acquirer_reference_number,
system_trace_audit_number,
retrieval_reference_number,
other
network_reference_updated_at
string<date-time> | null

The time in UTC when network_reference became available. It is null when the reference is not available, or when it became available before this field existed.

reason
string | null

The reason provided for the refund, if any. Optional.

Lần sửa đổi cuối 1 tháng 4, 2026