TransactionRefunds
in package
Describes the overall refund information for a transaction.
Contains the total refunded amount, total fees charged for refunds, and a list of individual refund payments.
Tags
Table of Contents
Properties
- $amountFee : string
- $amountRefunded : string
- $payments : array<string|int, mixed>
Methods
- __construct() : mixed
- fromJson() : TransactionRefunds
- Constructs a new instance of TransactionRefunds by using the given data.
Properties
$amountFee
public
string
$amountFee
$amountRefunded
public
string
$amountRefunded
$payments
public
array<string|int, mixed>
$payments
Methods
__construct()
public
__construct(string $amountRefunded, string $amountFee, array<string|int, TransactionRefundPayment> $payments) : mixed
Parameters
- $amountRefunded : string
-
The total amount refunded to the user, in units of amount_in_asset. If a full refund was issued, this amount should match amount_in.
- $amountFee : string
-
The total amount charged in fees for processing all refund payments, in units of amount_in_asset. The sum of all fee values in the payments object list should equal this value.
- $payments : array<string|int, TransactionRefundPayment>
-
A list of objects containing information on the individual payments made back to the user as refunds.
fromJson()
Constructs a new instance of TransactionRefunds by using the given data.
public
static fromJson(array<string|int, mixed> $json) : TransactionRefunds
Parameters
- $json : array<string|int, mixed>
-
the data to construct the object from.
Return values
TransactionRefunds —the object containing the parsed data.