Inttegro PHP SDK

Supplied extends DomainValue
in package

FinalYes

Public provenance for how the payment method was supplied.

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

$attemptId  : string|null
Identifier of the related attempt.
$by  : string
By value for this supplied.
$channel  : string|null
Channel value for this supplied.
$resourceId  : string|null
Identifier of the related resource.
$resourceType  : string|null
Resource Type value for this supplied.
$suppliedAt  : DateTimeImmutable
Timestamp associated with supplied.

Methods

__construct()  : mixed
Hydrates a Supplied from decoded Inttegro API data.
fromArray()  : static
Creates a Supplied 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

$attemptId read-only

Identifier of the related attempt.

public string|null $attemptId

Optional response field. PHP type: string|null; wire field: attempt_id (string).

$by read-only

By value for this supplied.

public string $by

Required response field. PHP type: string; wire field: by (string).

$channel read-only

Channel value for this supplied.

public string|null $channel

Optional response field. PHP type: string|null; wire field: channel (string).

$resourceId read-only

Identifier of the related resource.

public string|null $resourceId

Optional response field. PHP type: string|null; wire field: resource_id (string).

$resourceType read-only

Resource Type value for this supplied.

public string|null $resourceType

Optional response field. PHP type: string|null; wire field: resource_type (string).

$suppliedAt read-only

Timestamp associated with supplied.

public DateTimeImmutable $suppliedAt

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

Methods

__construct()

Hydrates a Supplied 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 Supplied 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 Supplied 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