FinancialInstitutionBank
extends DomainValue
in package
Financial Institution Bank details associated with 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.
Tags
Table of Contents
Properties
- $bankAccountType : string
- Bank Account Type value for this financial institution bank.
- $branch : FinancialInstitutionBankBranch|null
- Branch value for this financial institution bank.
- $codeScheme : string
- Code Scheme value for this financial institution bank.
- $sortCodePrefix : string|null
- Sort Code Prefix value for this financial institution bank.
- $swiftCode : string|null
- Swift Code value for this financial institution bank.
Methods
- __construct() : mixed
- Hydrates a FinancialInstitutionBank from decoded Inttegro API data.
- fromArray() : static
- Creates a FinancialInstitutionBank 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
$bankAccountType read-only
Bank Account Type value for this financial institution bank.
public
string
$bankAccountType
Required response field. PHP type: string; wire field: bank_account_type (string).
$branch read-only
Branch value for this financial institution bank.
public
FinancialInstitutionBankBranch|null
$branch
Optional response field. PHP type:
\Inttegro\FinancialAccount\FinancialInstitutionBankBranch|null; wire field: branch
(object).
$codeScheme read-only
Code Scheme value for this financial institution bank.
public
string
$codeScheme
Required response field. PHP type: string; wire field: code_scheme (string).
$sortCodePrefix read-only
Sort Code Prefix value for this financial institution bank.
public
string|null
$sortCodePrefix
Optional response field. PHP type: string|null; wire field: sort_code_prefix (string).
$swiftCode read-only
Swift Code value for this financial institution bank.
public
string|null
$swiftCode
Optional response field. PHP type: string|null; wire field: swift_code (string).
Methods
__construct()
Hydrates a FinancialInstitutionBank 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 FinancialInstitutionBank 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 FinancialInstitutionBank 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.