RefundAllocation
extends DomainValue
in package
Caller-safe allocation of part of a payment balance transaction to a refund.
Table of Contents
Properties
- $completedAt : DateTimeImmutable|null
- Completion time when completed. PHP type: `DateTimeImmutable|null`; wire field: `completed_at` (`date-time`).
- $createdAt : DateTimeImmutable
- Reservation creation time. PHP type: `DateTimeImmutable`; wire field: `created_at` (`date-time`).
- $id : string
- Stable allocation identifier. PHP type: `string`; wire field: `id` (`string`).
- $refund : AllocationUse
- Refund details and amount. PHP type: `AllocationUse`; wire field: `refund` (`object`).
- $status : string
- Caller-visible state. PHP type: `string`; wire field: `status` (`string`).
- $type : string
- Discriminant fixed to refund. PHP type: `string`; wire field: `type` (`string`).
- $updatedAt : DateTimeImmutable
- Last public state change time. PHP type: `DateTimeImmutable`; wire field: `updated_at` (`date-time`).
Methods
- __construct() : mixed
- Hydrates a refund allocation from API data.
- fromArray() : static
- Creates a refund allocation from API data.
- 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
$completedAt read-only
Completion time when completed. PHP type: `DateTimeImmutable|null`; wire field: `completed_at` (`date-time`).
public
DateTimeImmutable|null
$completedAt
$createdAt read-only
Reservation creation time. PHP type: `DateTimeImmutable`; wire field: `created_at` (`date-time`).
public
DateTimeImmutable
$createdAt
$id read-only
Stable allocation identifier. PHP type: `string`; wire field: `id` (`string`).
public
string
$id
$refund read-only
Refund details and amount. PHP type: `AllocationUse`; wire field: `refund` (`object`).
public
AllocationUse
$refund
$status read-only
Caller-visible state. PHP type: `string`; wire field: `status` (`string`).
public
string
$status
$type read-only
Discriminant fixed to refund. PHP type: `string`; wire field: `type` (`string`).
public
string
$type
$updatedAt read-only
Last public state change time. PHP type: `DateTimeImmutable`; wire field: `updated_at` (`date-time`).
public
DateTimeImmutable
$updatedAt
Methods
__construct()
Hydrates a refund allocation from API data.
public
__construct(array<string|int, mixed> $data) : mixed
@param array<string, mixed> $data
Parameters
- $data : array<string|int, mixed>
fromArray()
Creates a refund allocation from API data.
public
static fromArray(array<string|int, mixed> $data) : static
@param array<string, mixed> $data
Parameters
- $data : array<string|int, mixed>
-
Wire object keyed by
snake_caseAPI field names.
Return values
static —A typed, immutable domain 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
camelCaseor wiresnake_casefield name.
Return values
booloffsetGet()
Reads a typed property through PHP `ArrayAccess`.
public
offsetGet(mixed $offset) : mixed
Parameters
- $offset : mixed
-
PHP
camelCaseor wiresnake_casefield 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
offsetUnset()
Rejects unsetting because domain values are immutable.
public
offsetUnset(mixed $offset) : void
Parameters
- $offset : mixed
-
Ignored field name.
Tags
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.