Inttegro PHP SDK

CurrencySnapshot extends DomainValue
in package

FinalYes

Currency Snapshot details associated with balance.

This immutable value hydrates decoded API snake_case data into typed camelCase properties. Use fromArray() for wire data; toArray(), array access, and JSON serialization expose the API wire representation. Nullable properties correspond to optional API fields.

Tags
see
DomainValue

Table of Contents

Properties

$available  : Value
Available value for this currency snapshot.
$includesTransactionsBefore  : DateTimeImmutable
The snapshot includes transactions created before this timestamp.
$pending  : Value
Pending value for this currency snapshot.
$refund  : CurrencySnapshotRefund
Funds assigned to refund activity at the snapshot cutoff.
$reserved  : CurrencySnapshotReserved
Funds held back from payout at the snapshot cutoff.

Methods

__construct()  : mixed
Hydrates a CurrencySnapshot from decoded Inttegro API data.
fromArray()  : static
Creates a CurrencySnapshot from its decoded API wire representation.
jsonSerialize()  : array<string, mixed>
Returns the same API wire object as `toArray()` for `json_encode()`.
offsetExists()  : bool
Reports whether a non-null property exists for a PHP or API field name.
offsetGet()  : mixed
Reads a typed property through PHP `ArrayAccess`.
offsetSet()  : void
Rejects mutation because domain values are immutable.
offsetUnset()  : void
Rejects unsetting because domain values are immutable.
toArray()  : array<string, mixed>
Converts typed properties back to the API's wire representation.

Properties

$available read-only

Available value for this currency snapshot.

public Value $available

Required response field. PHP type: \Inttegro\Balance\Value; wire field: available (object).

$includesTransactionsBefore read-only

The snapshot includes transactions created before this timestamp.

public DateTimeImmutable $includesTransactionsBefore

Required response field. PHP type: DateTimeImmutable; wire field: includes_transactions_before (ISO-8601 string with UTC offset). The SDK parses the offset-bearing timestamp into an immutable PHP date-time value.

$pending read-only

Pending value for this currency snapshot.

public Value $pending

Required response field. PHP type: \Inttegro\Balance\Value; wire field: pending (object).

$refund read-only

Funds assigned to refund activity at the snapshot cutoff.

public CurrencySnapshotRefund $refund

Required response field. PHP type: \Inttegro\Balance\CurrencySnapshotRefund; wire field: refund (object).

$reserved read-only

Funds held back from payout at the snapshot cutoff.

public CurrencySnapshotReserved $reserved

Required response field. PHP type: \Inttegro\Balance\CurrencySnapshotReserved; wire field: reserved (object).

Methods

__construct()

Hydrates a CurrencySnapshot from decoded Inttegro API data.

public __construct(array<string, mixed> $data) : mixed
Parameters
$data : array<string, mixed>

Wire object keyed by snake_case API field names.

fromArray()

Creates a CurrencySnapshot from its decoded API wire representation.

public static fromArray(array<string, mixed> $data) : static
Parameters
$data : array<string, mixed>

Wire object keyed by snake_case API field names.

Return values
static —

A typed, immutable CurrencySnapshot value.

jsonSerialize()

Returns the same API wire object as `toArray()` for `json_encode()`.

public jsonSerialize() : array<string, mixed>
Return values
array<string, mixed>

offsetExists()

Reports whether a non-null property exists for a PHP or API field name.

public offsetExists(mixed $offset) : bool

Both paymentId and payment_id address the same typed property.

Parameters
$offset : mixed

PHP camelCase or wire snake_case field name.

Return values
bool

offsetGet()

Reads a typed property through PHP `ArrayAccess`.

public offsetGet(mixed $offset) : mixed
Parameters
$offset : mixed

PHP camelCase or wire snake_case field name.

Return values
mixed —

The PHP-native property value.

offsetSet()

Rejects mutation because domain values are immutable.

public offsetSet(mixed $offset, mixed $value) : void
Parameters
$offset : mixed

Ignored field name.

$value : mixed

Ignored replacement value.

Tags
throws
LogicException

Always.

offsetUnset()

Rejects unsetting because domain values are immutable.

public offsetUnset(mixed $offset) : void
Parameters
$offset : mixed

Ignored field name.

Tags
throws
LogicException

Always.

toArray()

Converts typed properties back to the API's wire representation.

public toArray() : array<string, mixed>

Property names become snake_case. Nested values, arrays, backed enums, and timestamps are normalized recursively so the result is safe to pass to json_encode().

Return values
array<string, mixed> —

The recursively normalized API object.

On this page

Search results