Skip to main content
GET
JavaScript

التفويضات

Authorization
string
header
مطلوب

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

معلمات المسار

refund_id
string
مطلوب

Refund Id

الاستجابة

brand_id
string
مطلوب

Brand id this refund belongs to

business_id
string
مطلوب

The unique identifier of the business issuing the refund.

created_at
string<date-time>
مطلوب

The timestamp of when the refund was created in UTC.

customer
object
مطلوب

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

is_partial
boolean
مطلوب

If true the refund is a partial refund

metadata
Metadata · object
مطلوب

Additional metadata stored with the refund.

payment_id
string
مطلوب

The unique identifier of the payment associated with the refund.

refund_id
string
مطلوب

The unique identifier of the refund.

status
enum<string>
مطلوب

The current status of the refund.

الخيارات المتاحة:
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.

الخيارات المتاحة:
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.

الخيارات المتاحة:
acquirer_reference_number,
system_trace_audit_number,
retrieval_reference_number,
other
reason
string | null

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

آخر تعديل في ١ أبريل ٢٠٢٦