NextActionConfirmPayment
extends DomainValue
in package
Details for customer payment confirmation.
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
Table of Contents
Properties
- $attempt : NextActionConfirmPaymentAttempt|null
- Latest confirmation attempt.
- $confirmed : bool
- Whether the payment confirmation has completed.
- $expiresAt : DateTimeImmutable
- When the confirmation request expires.
- $request : NextActionConfirmPaymentRequest|null
- Confirmation request details.
- $scheme : string
- Authentication scheme used.
- $status : string
- Confirmation status.
Methods
- __construct() : mixed
- Hydrates a NextActionConfirmPayment from decoded Inttegro API data.
- fromArray() : static
- Creates a NextActionConfirmPayment 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
$attempt read-only
Latest confirmation attempt.
public
NextActionConfirmPaymentAttempt|null
$attempt
Optional response field. PHP type: \Inttegro\Payment\NextActionConfirmPaymentAttempt|null;
wire field: attempt (object).
$confirmed read-only
Whether the payment confirmation has completed.
public
bool
$confirmed
Required response field. PHP type: bool; wire field: confirmed (boolean).
$expiresAt read-only
When the confirmation request 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.
$request read-only
Confirmation request details.
public
NextActionConfirmPaymentRequest|null
$request
Optional response field. PHP type: \Inttegro\Payment\NextActionConfirmPaymentRequest|null;
wire field: request (object).
$scheme read-only
Authentication scheme used.
public
string
$scheme
Required response field. PHP type: string; wire field: scheme (string).
$status read-only
Confirmation status.
public
string
$status
Required response field. PHP type: string; wire field: status (string).
Compare against Status cases by using their ->value strings.
Methods
__construct()
Hydrates a NextActionConfirmPayment from decoded Inttegro API data.
public
__construct(array<string, mixed> $data) : mixed
Parameters
- $data : array<string, mixed>
-
Wire object keyed by
snake_caseAPI field names.
fromArray()
Creates a NextActionConfirmPayment from its decoded API wire representation.
public
static fromArray(array<string, mixed> $data) : static
Parameters
- $data : array<string, mixed>
-
Wire object keyed by
snake_caseAPI field names.
Return values
static —A typed, immutable NextActionConfirmPayment 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.