Inttegro PHP SDK

BalanceTransactions
in package

Balance transactions resource for payment- and refund-sourced merchant balance entries.

Every transaction has type payment or refund. The type describes its semantic source, not accounting direction, and exactly one matching payment_id or refund_id.

Tags
see
https://studio.inttegro.com/balance-transactions

for detailed guide

Table of Contents

Methods

__construct()  : mixed
Creates the balance transactions resource client.
lookup()  : BalanceTransaction
Retrieve one transaction with required id, type, order_id, amount, and created_at. When type is payment the response has payment_id; when refund it has refund_id.
page()  : Page
Retrieve a paginated list of balance transactions.

Methods

__construct()

Creates the balance transactions resource client.

public __construct(HttpClient $http) : mixed
Parameters
$http : HttpClient

Shared authenticated HTTP transport used by this resource client.

lookup()

Retrieve one transaction with required id, type, order_id, amount, and created_at. When type is payment the response has payment_id; when refund it has refund_id.

public lookup(string $transactionId) : BalanceTransaction

Sends the documented request through the shared authenticated transport and hydrates the successful response into the declared return type.

Parameters
$transactionId : string

Unique identifier of the transaction.

Return values
BalanceTransaction —

The requested balance transaction.

page()

Retrieve a paginated list of balance transactions.

public page([array<string, mixed> $payload = [] ]) : Page

Returns transactions sorted by created_at in descending order (most recent first). Required transaction fields are id, type, order_id, amount, and created_at. Optional payout_id, available_at, claimed_at, and paid_at are included when applicable.

Parameters
$payload : array<string, mixed> = []

Pagination parameters (optional)

  • page_number: int - 0-based page index (0-10, default: 0)
  • page_size: int - Results per page (1-256, default varies)
Tags
example

Get recent balance transactions

$page = $client->balanceTransactions->page([
    'page_number' => 0,
    'page_size' => 25
]);

echo "Page {$page->number} contains {$page->size} transactions\n";

foreach ($page->transactions as $txn) {
    $sourceId = $txn->type === 'payment' ? $txn->paymentId : $txn->refundId;
    echo "Transaction {$txn->id} ({$txn->type} {$sourceId}): "
        . "{$txn->amount->value} {$txn->amount->currency}\n";
}
see
https://studio.inttegro.com/balance-transactions

for balance transaction guide

https://studio.inttegro.com/pagination

for pagination guide

Return values
Page —

Paginated transaction list with page details

On this page

Search results