Data objects and enums.

Every modeled PayRex response is hydrated into a readonly data object under ByRcsc\LaravelPayrex\Data. These objects provide typed, camel-cased properties without discarding the original API payload.

$intent = Payrex::paymentIntents()->retrieve('pi_...');

$intent->id;              // string
$intent->amount;          // ?int
$intent->status;          // ?PaymentIntentStatus
$intent->latestPayment;   // ?Payment
$intent->createdAt;       // ?CarbonImmutable
$intent->raw;             // untouched response array

Main response types

All applicable objects also expose livemode, metadata, createdAt, updatedAt, and raw.

Nested objects and dates

Nested PayRex objects are hydrated recursively. For example, $intent->latestPayment is a Payment; that payment's $payment->billing is a Billing object, whose $billing->address is a BillingAddress.

Two payment-method shapes exist because PayRex embeds a shorter one. The PaymentMethod returned by customers()->listPaymentMethods() carries an id, billingDetails, and allowRedisplay. The $payment->paymentMethod embedded in a payment is a PaymentMethodSummary: type, details, and raw only. Read the identifier from $intent->paymentMethodId rather than from the summary.

Unix timestamps decode to CarbonImmutable. Missing or malformed optional values become null rather than producing guessed defaults.

Raw payloads

Every data object retains the untouched API object on $raw:

$networkReference = $payment->raw['network_reference'] ?? null;

This preserves access to a new PayRex field before the package adds a typed property. It is also useful when diagnosing a sanitized response. Prefer typed properties for established fields and keep raw access localized.

Unknown enum values

Response enums are decoded with tryFrom(). If PayRex introduces a new value, the typed property becomes null instead of throwing:

$intent->status;        // null for an unknown future status
$intent->raw['status']; // the exact value PayRex returned

This makes additive API changes non-fatal while keeping the unknown value observable.

Enum catalog

Backed enums may be passed directly to supported resource methods:

use ByRcsc\LaravelPayrex\Enums\PaymentMethodType;

$intent = Payrex::paymentIntents()->create(
    amount: 10_000,
    paymentMethods: [
        PaymentMethodType::Card,
        PaymentMethodType::Gcash,
    ],
);

Convenience methods

Several objects answer common state questions:

$intent->hasSucceeded();
$intent->requiresAction();
$intent->redirectUrl();

$session->isCompleted();
$customer->isDeleted();
$statement->isDraft();
$endpoint->isEnabled();
$lineItem->total();

Listing implements Countable and IteratorAggregate, and provides first(), collect(), and isEmpty().

What to read next

• Client and resources to see which methods return each data object.
• Pagination to work with Listing responses.
• Errors and retries to inspect typed API failures.