Inttegro PHP SDK

Payouts
in package

Payouts resource for managing automatic settlements and balance withdrawals.

Payouts transfer funds from your Inttegro balance to configured financial accounts. Control payout schedules, set currency-specific destinations, and enable foreign exchange conversion.

Tags
see
https://studio.inttegro.com/payouts

for detailed guides

Table of Contents

Methods

__construct()  : mixed
Creates the payouts resource client.
cancel()  : Payout
Cancel a scheduled payout before execution.
disableAutomatic()  : SettingsMutation
Switch payout schedule to manual mode, stopping automatic weekly transfers.
disableFx()  : SettingsMutation
Disable foreign exchange conversion for payouts.
enableAutomatic()  : SettingsMutation
Enable automatic payouts.
enableFx()  : SettingsMutation
Enable foreign exchange conversion for multi-currency payouts.
lookup()  : Payout
Lookup a payout by ID.
page()  : Page
Retrieve a paginated list of payout history.
schedule()  : Payout
Schedule a payout to a financial account.
search()  : ResourceSearchPage
Search payouts with a typed resource-local query.
setDestinations()  : SettingsMutation
Configure which financial account receives payouts for each currency.
settings()  : SettingsLookup
Retrieve current payout configuration including schedule and destination accounts.

Methods

__construct()

Creates the payouts resource client.

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

Shared authenticated HTTP transport used by this resource client.

cancel()

Cancel a scheduled payout before execution.

public cancel(string $payoutId) : Payout

Only payouts with scheduled status and future execution windows can be canceled.

Parameters
$payoutId : string

Scheduled payout ID

Return values
Payout —

Canceled payout payload

disableAutomatic()

Switch payout schedule to manual mode, stopping automatic weekly transfers.

public disableAutomatic() : SettingsMutation

When automatic payouts are disabled, you control when funds are transferred to your financial accounts. Use the schedule endpoint to trigger payouts on-demand. Useful for marketplace platforms or when you need explicit control over cash flow timing.

Tags
example

Disable automatic payouts

$settings = $client->payouts->disableAutomatic();
if ($settings->schedule?->type === 'manual') {
    echo "Automatic payouts disabled. You now control payout timing.\n";
}
see
https://studio.inttegro.com/disable-automatic-payouts

for manual payout guide

Return values
SettingsMutation —

Updated payout settings with manual schedule

disableFx()

Disable foreign exchange conversion for payouts.

public disableFx() : SettingsMutation

After disabling FX, payouts will only be sent in currencies matching your balance currencies. Any financial accounts configured for non-matching currencies will not receive payouts.

Tags
example

Disable FX payouts

$result = $client->payouts->disableFx();
echo "FX conversion disabled. Payouts will match balance currencies.\n";
see
https://studio.inttegro.com/payouts-fx-conversion

for FX details

Return values
SettingsMutation —

Updated payout settings

enableAutomatic()

Enable automatic payouts.

public enableAutomatic() : SettingsMutation

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

Return values
SettingsMutation —

The resulting settings mutation.

enableFx()

Enable foreign exchange conversion for multi-currency payouts.

public enableFx() : SettingsMutation

When FX is enabled, you can receive payouts in a different currency than your balance currency. Inttegro converts funds at market rates during payout execution.

Tags
example

Enable FX payouts

$result = $client->payouts->enableFx();
echo "FX conversion enabled for payouts\n";
see
https://studio.inttegro.com/enable-fx-payouts

for FX payout guide

Return values
SettingsMutation —

Updated payout settings

lookup()

Lookup a payout by ID.

public lookup(string $payoutId) : Payout

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

Parameters
$payoutId : string

Unique identifier of the payout.

Return values
Payout —

The requested payout.

page()

Retrieve a paginated list of payout history.

public page(PageRequest $payload) : Page

Returns payouts sorted by initiated_at in descending order (most recent first). Each payout includes amount, currency, destination account, status, and execution timestamps.

Parameters
$payload : PageRequest

Typed pagination parameters.

Tags
example

Get recent payouts

$page = $client->payouts->page(new \Inttegro\Payout\PageRequest([
    'page_number' => 1,
    'page_size' => 20
]));

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

foreach ($page->payouts ?? [] as $payout) {
    echo "Payout {$payout->id}: {$payout->amount?->value} {$payout->amount?->currency}\n";
}
see
https://studio.inttegro.com/pagination

for pagination guide

https://studio.inttegro.com/payouts

for payout overview

Return values
Page —

Paginated payout list with page details

schedule()

Schedule a payout to a financial account.

public schedule(ScheduleRequest $payload) : Payout

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

Parameters
$payload : ScheduleRequest

Typed destination, amount, reference, and execution fields.

Return values
Payout —

The resulting payout.

setDestinations()

Configure which financial account receives payouts for each currency.

public setDestinations(Destinations $destinations) : SettingsMutation

Maps currency codes to financial account IDs. Each account must support push operations and match the currency it's assigned to. Only balance transactions that have aged at least 168 hours (7 days) are included in payouts.

Parameters
$destinations : Destinations

Supported destination assignments.

Tags
example

Set payout destinations

$settings = $client->payouts->setDestinations(
    new \Inttegro\Payout\Destinations(['ghs' => 'fa_mtnmomo_account'])
);
echo "GHS payouts go to {$settings->destinations?->ghs}\n";
see
https://studio.inttegro.com/manage-payout-destinations

for payout destination guide

Return values
SettingsMutation —

Updated payout settings

settings()

Retrieve current payout configuration including schedule and destination accounts.

public settings() : SettingsLookup

Returns the payout schedule (automatic or manual) and the financial accounts configured for each currency. Use this to display current settings to users or verify configuration.

Tags
example

Get payout settings

$settings = $client->payouts->settings();
echo "Schedule: {$settings->schedule?->name}\n";
echo "Type: {$settings->schedule?->type}\n";
see
https://studio.inttegro.com/payouts

for payout overview

Return values
SettingsLookup —

Payout settings with schedule and destinations

On this page

Search results