Inttegro PHP SDK

PaymentMethod extends DomainValue
in package

FinalYes

Payment Method details associated with payment.

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
see
DomainValue

Table of Contents

Properties

$bankAccount  : PaymentMethodBankAccount|null
Bank Account value for this payment method.
$card  : Card|null
Card marker. Nested card credentials are not returned.
$createdAt  : DateTimeImmutable
Time at which the value was created.
$customerId  : string
Identifier of the related customer.
$id  : string
Unique identifier for this payment method.
$mobileMoney  : PaymentMethodMobileMoney|null
Mobile Money value for this payment method.
$owner  : PaymentMethodOwner|null
Owner value for this payment method.
$type  : string
Discriminator identifying the value's API variant.
$verified  : bool
Verified value for this payment method.
$verifiedAt  : DateTimeImmutable|null
Timestamp associated with verified.

Methods

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

$bankAccount read-only

Bank Account value for this payment method.

public PaymentMethodBankAccount|null $bankAccount

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

$card read-only

Card marker. Nested card credentials are not returned.

public Card|null $card

Optional response field. PHP type: \Inttegro\PaymentMethod\Card|null; wire field: card (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.

$customerId read-only

Identifier of the related customer.

public string $customerId

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

$id read-only

Unique identifier for this payment method.

public string $id

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

$mobileMoney read-only

Mobile Money value for this payment method.

public PaymentMethodMobileMoney|null $mobileMoney

Optional response field. PHP type: \Inttegro\Payment\PaymentMethodMobileMoney|null; wire field: mobile_money (object).

$owner read-only

Owner value for this payment method.

public PaymentMethodOwner|null $owner

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

$type read-only

Discriminator identifying the value's API variant.

public string $type

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

$verified read-only

Verified value for this payment method.

public bool $verified

Required response field. PHP type: bool; wire field: verified (boolean).

$verifiedAt read-only

Timestamp associated with verified.

public DateTimeImmutable|null $verifiedAt

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

Methods

__construct()

Hydrates a PaymentMethod 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 PaymentMethod 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 PaymentMethod 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