Inttegro PHP SDK

FinancialAccount extends DomainValue
in package

Application

FinalYes

A verified destination or source account used to push or pull funds.

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

$archivedAt : DateTimeImmutable|null: Time at which the value was archived.
$bankAccount : BankAccount|null: Bank Account value for this financial account.
$createdAt : DateTimeImmutable: Time at which the value was created.
$currency : string: ISO 4217 currency for the amount.
$customData : CustomData|null: Merchant-defined string values attached to a resource. SDKs expose this as a semantic collection rather than a raw map.
$description : string|null: Human-readable description.
$disconnectedAt : DateTimeImmutable|null: Timestamp associated with disconnected.
$doshAccount : array<string|int, mixed>|null: Dosh Account value for this financial account.
$fingerprint : string: A stable identifier for the underlying financial account within your application. Use it to recognize when the same account has been connected more than once.
$id : string: Unique identifier for this financial account.
$institution : FinancialInstitution|null: Institution value for this financial account.
$label : string|null: Label value for this financial account.
$owner : Owner|null: Owner value for this financial account.
$pullConfiguration : PullConfiguration|null: Pull Configuration value for this financial account.
$pushConfiguration : PushConfiguration|null: Push Configuration value for this financial account.
$reference : string|null: Reference value for this financial account.
$supplied : ResourceSupply|null: Supplied value for this financial account.
$type : string: Discriminator identifying the value's API variant.
$verification : array<string, mixed>|null: Verification value for this financial account.
$wallet : Wallet|null: Wallet value for this financial account.

Methods

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

$archivedAt read-only

Time at which the value was archived.


        public
            DateTimeImmutable|null
    $archivedAt

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

$bankAccount read-only

Bank Account value for this financial account.


        public
            BankAccount|null
    $bankAccount

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

$createdAt read-only

Time at which the value was created.


        public
            DateTimeImmutable
    $createdAt

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

$currency read-only

ISO 4217 currency for the amount.


        public
            string
    $currency

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

$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).

$description read-only

Human-readable description.


        public
            string|null
    $description

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

$disconnectedAt read-only

Timestamp associated with disconnected.


        public
            DateTimeImmutable|null
    $disconnectedAt

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

$doshAccount read-only

Dosh Account value for this financial account.


        public
            array<string|int, mixed>|null
    $doshAccount

Optional response field. PHP type: array<mixed>|null; wire field: dosh_account (array).

$fingerprint read-only

A stable identifier for the underlying financial account within your application. Use it to recognize when the same account has been connected more than once.


        public
            string
    $fingerprint

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

$id read-only

Unique identifier for this financial account.


        public
            string
    $id

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

$institution read-only

Institution value for this financial account.


        public
            FinancialInstitution|null
    $institution

Optional response field. PHP type: \Inttegro\FinancialAccount\FinancialInstitution|null; wire field: institution (object).

$label read-only

Label value for this financial account.


        public
            string|null
    $label

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

$owner read-only

Owner value for this financial account.


        public
            Owner|null
    $owner

Optional response field. PHP type: \Inttegro\BankAccount\Owner|null; wire field: owner (object).

$pullConfiguration read-only

Pull Configuration value for this financial account.


        public
            PullConfiguration|null
    $pullConfiguration

Optional response field. PHP type: \Inttegro\FinancialAccount\PullConfiguration|null; wire field: pull_configuration (object).

$pushConfiguration read-only

Push Configuration value for this financial account.


        public
            PushConfiguration|null
    $pushConfiguration

Optional response field. PHP type: \Inttegro\FinancialAccount\PushConfiguration|null; wire field: push_configuration (object).

$reference read-only

Reference value for this financial account.


        public
            string|null
    $reference

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

$supplied read-only

Supplied value for this financial account.


        public
            ResourceSupply|null
    $supplied

Optional response field. PHP type: \Inttegro\Shared\ResourceSupply|null; wire field: supplied (object).

$type read-only

Discriminator identifying the value's API variant.


        public
            string
    $type

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

$verification read-only

Verification value for this financial account.


        public
            array<string, mixed>|null
    $verification

Optional response field. PHP type: array<string, mixed>|null; wire field: verification (object).

$wallet read-only

Wallet value for this financial account.


        public
            Wallet|null
    $wallet

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

__construct()

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

FinancialAccount extends DomainValue in package Application

Tags

Table of Contents

Properties

Methods

Properties

$archivedAt read-only

$bankAccount read-only

$createdAt read-only

$currency read-only

$customData read-only

$description read-only

$disconnectedAt read-only

$doshAccount read-only

$fingerprint read-only

$id read-only

$institution read-only

$label read-only

$owner read-only

$pullConfiguration read-only

$pushConfiguration read-only

$reference read-only

$supplied read-only

$type read-only

$verification read-only

$wallet 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

FinancialAccount extends DomainValue
in package

Application