DepositAsset
in package
Describes anchor support and parameters for a deposit asset.
Contains information about whether deposits are enabled for an asset, authentication requirements, fee structure, amount limits, and deprecated field requirements.
Returned as part of the info endpoint response to indicate which assets are available for deposit operations and under what conditions.
Tags
Table of Contents
Properties
- $authenticationRequired : bool|null
- $enabled : bool
- $feeFixed : float|null
- $feePercent : float|null
- $fields : array<string, AnchorField>|null
- $maxAmount : float|null
- $minAmount : float|null
Methods
- __construct() : mixed
- fromJson() : DepositAsset
- Constructs a new instance of DepositAsset by using the given data.
Properties
$authenticationRequired
public
bool|null
$authenticationRequired
= null
Optional. true if client must be authenticated before accessing the deposit endpoint for this asset. false if not specified.
$enabled
public
bool
$enabled
true if SEP-6 deposit for this asset is supported
$feeFixed
public
float|null
$feeFixed
= null
Optional fixed (flat) fee for deposit, in units of the Stellar asset. Null if there is no fee or the fee schedule is complex.
$feePercent
public
float|null
$feePercent
= null
Optional percentage fee for deposit, in percentage points of the Stellar asset. Null if there is no fee or the fee schedule is complex.
$fields
public
array<string, AnchorField>|null
$fields
= null
(Deprecated) Accepting personally identifiable information through request parameters is a security risk due to web server request logging. KYC information should be supplied to the Anchor via SEP-12).
$maxAmount
public
float|null
$maxAmount
= null
Optional maximum amount. No limit if not specified.
$minAmount
public
float|null
$minAmount
= null
Optional minimum amount. No limit if not specified.
Methods
__construct()
public
__construct(bool $enabled) : mixed
Parameters
- $enabled : bool
-
true if SEP-6 deposit for this asset is supported
fromJson()
Constructs a new instance of DepositAsset by using the given data.
public
static fromJson(array<string|int, mixed> $json) : DepositAsset
Parameters
- $json : array<string|int, mixed>
-
the data to construct the object from.
Return values
DepositAsset —the object containing the parsed data.