Inttegro PHP SDK

ScheduleRequest extends DomainValue
in package

FinalYes

Parameters for scheduling a payout to a financial account.

Amounts use the smallest currency unit. When execute_after is omitted, Inttegro may begin execution as soon as the payout is eligible.

Table of Contents

Properties

$destinationId  : string
Financial account that should receive the payout.
$executeAfter  : DateTimeImmutable|null
Optional future time after which execution may begin.
$maxAmount  : int|null
Optional maximum transfer amount in the smallest currency unit.
$reference  : string
Merchant reference carried on the payout.

Methods

__construct()  : mixed
fromArray()  : static
Creates a typed value from a decoded API object.
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

$destinationId read-only

Financial account that should receive the payout.

public string $destinationId

Required request field. PHP type: string; wire field: destination_id (string).

$executeAfter read-only

Optional future time after which execution may begin.

public DateTimeImmutable|null $executeAfter

Optional request field. PHP type: DateTimeImmutable|null; wire field: execute_after (ISO-8601 date-time string).

$maxAmount read-only

Optional maximum transfer amount in the smallest currency unit.

public int|null $maxAmount

Optional request field. PHP type: int|null; wire field: max_amount (integer).

$reference read-only

Merchant reference carried on the payout.

public string $reference

Required request field. PHP type: string; wire field: reference (string).

Methods

__construct()

public __construct(DateTimeImmutable|string|null, max_amount?: int|null, reference: string} $data) : mixed
Parameters
$data : DateTimeImmutable|string|null, max_amount?: int|null, reference: string}

fromArray()

Creates a typed value from a decoded API object.

public static fromArray(array<string, mixed> $data) : static
Parameters
$data : array<string, mixed>
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 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