Inttegro PHP SDK

Transaction extends DomainValue
in package

FinalYes

An OTP transaction returned by initiation, verification, and lookup operations.

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

$canceledAt  : DateTimeImmutable|null
Omitted unless the transaction was canceled.
$cancelReason  : string|null
Omitted unless the transaction was canceled.
$expiresAt  : DateTimeImmutable
Timestamp associated with expires.
$fullMessage  : string
Message text with the `{token}` placeholder preserved; no generated token is returned.
$id  : string
Unique identifier with ot_ prefix.
$initiatedAt  : DateTimeImmutable
Time at which processing began.
$status  : string
Current lifecycle state.
$transmission  : Transmission|null
Transmission value for this transaction.

Methods

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

$canceledAt read-only

Omitted unless the transaction was canceled.

public DateTimeImmutable|null $canceledAt

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

$cancelReason read-only

Omitted unless the transaction was canceled.

public string|null $cancelReason

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

$expiresAt read-only

Timestamp associated with expires.

public DateTimeImmutable $expiresAt

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

$fullMessage read-only

Message text with the `{token}` placeholder preserved; no generated token is returned.

public string $fullMessage

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

$id read-only

Unique identifier with ot_ prefix.

public string $id

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

$initiatedAt read-only

Time at which processing began.

public DateTimeImmutable $initiatedAt

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

$status read-only

Current lifecycle state.

public string $status

Required response field. PHP type: string; wire field: status (string). Compare against Status cases by using their ->value strings.

$transmission read-only

Transmission value for this transaction.

public Transmission|null $transmission

Optional response field. PHP type: \Inttegro\Otp\Transmission|null; wire field: transmission (object).

Methods

__construct()

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