Response Data

All API methods return typed, immutable data objects — not plain arrays. Each resource has its own class (e.g., PaymentIntent, Customer, Refund) extending PayrexObject, with readonly camelCase properties:

use LegionHQ\LaravelPayrex\Data\PaymentIntent;

$paymentIntent = Payrex::paymentIntents()->create([...]); // Returns PaymentIntent

// Typed properties (recommended) — camelCase with full IDE autocompletion
$paymentIntent->id;              // 'pi_xxxxx'
$paymentIntent->amount;          // 10000
$paymentIntent->status;          // PaymentIntentStatus::AwaitingPaymentMethod (enum)
$paymentIntent->clientSecret;    // 'pi_xxxxx_secret_xxxxx'
$paymentIntent->livemode;        // false
$paymentIntent->createdAt;       // 1700407880

// Nested objects are arrays — access with array syntax
$paymentIntent->nextAction['redirect_url'];
$paymentIntent->paymentMethodOptions['card']['capture_type'];

// Expandable fields depend on the API response:
// When the API returns the full nested object, access as a typed DTO
$paymentIntent->latestPayment->id;     // 'pay_xxxxx' (Payment object)
$paymentIntent->customer->name;        // 'Juan Dela Cruz' (Customer object)
// When the API returns only the ID string, the property remains a string
$paymentIntent->latestPayment;         // 'pay_xxxxx' (string)

// Array access also works — snake_case keys matching the raw API response
$paymentIntent['id'];            // 'pi_xxxxx'
$paymentIntent['status'];        // 'awaiting_payment_method' (raw string, not enum)

// Convert to array or JSON
$paymentIntent->toArray();
json_encode($paymentIntent);

Typed properties vs array access

• Typed properties (->status) return enum instances (e.g., PaymentIntentStatus::Succeeded) and provide IDE autocompletion.
• Array access (['status']) returns the raw string value ('succeeded') — useful for serialization or when you need the raw API value.

Both are valid. We recommend typed properties for application logic and array access when you need raw values.

Immutable objects

All data objects are read-only. Attempting to set or unset a property via array access will throw a LogicException:

$paymentIntent['amount'] = 5000; // throws LogicException
unset($paymentIntent['amount']); // throws LogicException

Response Metadata

After any API call, you can inspect response headers (request IDs, rate limit info) via getLastResponse():

$paymentIntent = Payrex::paymentIntents()->create([...]);

$metadata = Payrex::getLastResponse();
$metadata->statusCode;                // 200
$metadata->header('X-Request-Id');    // 'req_abc123' (case-insensitive)

See Response Metadata for full details.

Further Reading

• Error Handling — Exception types, error codes, and response metadata
• Enums — All status and type enum values
• Pagination — Navigate paginated results with auto-pagination