TransactionRefundPayment
in package
Represents a single refund payment made to the user.
Contains details about an individual refund payment including the payment ID, type, amount, and associated fee.
Tags
Table of Contents
Properties
Methods
- __construct() : mixed
- fromJson() : TransactionRefundPayment
- Constructs a new instance of TransactionRefundPayment by using the given data.
Properties
$amount
public
string
$amount
$fee
public
string
$fee
$id
public
string
$id
$idType
public
string
$idType
Methods
__construct()
public
__construct(string $id, string $idType, string $amount, string $fee) : mixed
Parameters
- $id : string
-
The payment ID that can be used to identify the refund payment. This is either a Stellar transaction hash or an off-chain payment identifier, such as a reference number provided to the user when the refund was initiated. This id is not guaranteed to be unique.
- $idType : string
-
stellar or external.
- $amount : string
-
The amount sent back to the user for the payment identified by id, in units of amount_in_asset.
- $fee : string
-
The amount charged as a fee for processing the refund, in units of amount_in_asset.
fromJson()
Constructs a new instance of TransactionRefundPayment by using the given data.
public
static fromJson(array<string|int, mixed> $json) : TransactionRefundPayment
Parameters
- $json : array<string|int, mixed>
-
the data to construct the object from.
Return values
TransactionRefundPayment —the object containing the parsed data.