Inttegro PHP SDK

Payout extends DomainValue
in package

Application

FinalYes

A transfer scheduled from an Inttegro balance to a destination financial account.

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.

Properties

$amount : Amount|null: Monetary amount in integer minor units and its currency.
$balanceTransactionId : string|null: The payout's own immutable debit balance transaction ID.
$balanceTransactions : array<int, BalanceTransaction>|null: Balance transactions that contributed to this payout.
$canceledAt : DateTimeImmutable|null: When the payout was canceled.
$customData : CustomData|null: Merchant-defined string values attached to a resource. SDKs expose this as a semantic collection rather than a raw map.
$destinationId : string: Financial account receiving the funds.
$error : Error|null: Deprecated compatibility projection of the terminal failure.
$executeAfter : DateTimeImmutable: Earliest moment payout execution may begin.
$executedBy : string|null: Actor that executed the payout.
$expectedAt : DateTimeImmutable|null: Expected completion time.
$failedAt : DateTimeImmutable|null: When the payout entered its unsuccessful terminal state.
$failure : Failure|null: Stable failure information when the payout status is `failed`.
$id : string: Unique payout identifier.
$initiatedAt : DateTimeImmutable: When the payout was created.
$initiatedBy : string|null: Actor that initiated the payout.
$maxAmount : Amount: Max Amount value for this payout.
$reference : string|null: Merchant reference carried on the payout.
$scheduledAt : DateTimeImmutable|null: When the payout was scheduled.
$scheduledBy : string|null: Actor that scheduled the payout.
$scheduleId : string|null: Schedule associated with the payout.
$sentAt : DateTimeImmutable|null: When the transfer was sent.
$sourceId : string|null: Source identifier associated with the payout.
$status : string: Current payout lifecycle state.
$succeededAt : DateTimeImmutable|null: When the payout succeeded.

Methods

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

$amount read-only

Monetary amount in integer minor units and its currency.


        public
            Amount|null
    $amount

Optional response field. PHP type: Amount|null; wire field: amount (object).

$balanceTransactionId read-only

The payout's own immutable debit balance transaction ID.


        public
            string|null
    $balanceTransactionId

Optional response field. PHP type: string|null; wire field: balance_transaction_id

$balanceTransactions read-only

Balance transactions that contributed to this payout.


        public
            array<int, BalanceTransaction>|null
    $balanceTransactions

Optional response field. PHP type: list<BalanceTransaction>|null; wire field: balance_transactions (array<object>).

$canceledAt read-only

When the payout 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.

$customData read-only

Merchant-defined string values attached to a resource. SDKs expose this as a semantic collection rather than a raw map.


        public
            CustomData|null
    $customData

Optional response field. PHP type: \Inttegro\CustomData|null; wire field: custom_data (object).

$destinationId read-only

Financial account receiving the funds.


        public
            string
    $destinationId

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

$error read-only

Deprecated compatibility projection of the terminal failure.


        public
            Error|null
    $error

Optional response field. PHP type: \Inttegro\Payout\Error|null; wire field: error (object). Use $failure for stable, caller-safe failure information.

$executeAfter read-only

Earliest moment payout execution may begin.


        public
            DateTimeImmutable
    $executeAfter

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

$executedBy read-only

Actor that executed the payout.


        public
            string|null
    $executedBy

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

$expectedAt read-only

Expected completion time.


        public
            DateTimeImmutable|null
    $expectedAt

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

$failedAt read-only

When the payout entered its unsuccessful terminal state.


        public
            DateTimeImmutable|null
    $failedAt

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

$failure read-only

Stable failure information when the payout status is `failed`.


        public
            Failure|null
    $failure

Optional response field. PHP type: Failure|null; wire field: failure (object).

$id read-only

Unique payout identifier.


        public
            string
    $id

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

$initiatedAt read-only

When the payout was created.


        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.

$initiatedBy read-only

Actor that initiated the payout.


        public
            string|null
    $initiatedBy

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

$maxAmount read-only

Max Amount value for this payout.


        public
            Amount
    $maxAmount

Required response field. PHP type: Amount; wire field: max_amount (object).

$reference read-only

Merchant reference carried on the payout.


        public
            string|null
    $reference

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

$scheduledAt read-only

When the payout was scheduled.


        public
            DateTimeImmutable|null
    $scheduledAt

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

$scheduledBy read-only

Actor that scheduled the payout.


        public
            string|null
    $scheduledBy

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

$scheduleId read-only

Schedule associated with the payout.


        public
            string|null
    $scheduleId

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

$sentAt read-only

When the transfer was sent.


        public
            DateTimeImmutable|null
    $sentAt

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

$sourceId read-only

Source identifier associated with the payout.


        public
            string|null
    $sourceId

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

$status read-only

Current payout lifecycle state.


        public
            string
    $status

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

$succeededAt read-only

When the payout succeeded.


        public
            DateTimeImmutable|null
    $succeededAt

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

__construct()

Hydrates a Payout 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 Payout 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 Payout 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.

offsetUnset()

Rejects unsetting because domain values are immutable.


    public
                    offsetUnset(mixed $offset) : void

Parameters

$offset : mixed: Ignored field name.

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.

Payout extends DomainValue in package Application

Tags

Table of Contents

Properties

Methods

Properties

$amount read-only

$balanceTransactionId read-only

$balanceTransactions read-only

$canceledAt read-only

$customData read-only

$destinationId read-only

$error read-only

$executeAfter read-only

$executedBy read-only

$expectedAt read-only

$failedAt read-only

$failure read-only

$id read-only

$initiatedAt read-only

$initiatedBy read-only

$maxAmount read-only

$reference read-only

$scheduledAt read-only

$scheduledBy read-only

$scheduleId read-only

$sentAt read-only

$sourceId read-only

$status read-only

$succeededAt read-only

Methods

__construct()

Parameters

fromArray()

Parameters

Return values

jsonSerialize()

Return values

offsetExists()

Parameters

Return values

offsetGet()

Parameters

Return values

offsetSet()

Parameters

Tags

offsetUnset()

Parameters

Tags

toArray()

Return values

Payout extends DomainValue
in package

Application