Package com.inttegro

Class Client.PayoutsClient

java.lang.Object

com.inttegro.Client.PayoutsClient

Enclosing class:

Client

public static class Client.PayoutsClient
extends Object

Constructor Summary

Constructors

Constructor	Description
PayoutsClient(Client client)

Method Summary

Modifier and Type	Method	Description
Payout	cancel(String payoutId)	Cancels a scheduled payout before execution (POST /payouts/cancel).
PayoutSettings	disableAutomatic()	Disables automatic payouts and switches to manual mode (POST /payouts/disable).
PayoutSettings	disableFX()	Disables foreign exchange conversion for payouts (POST /payouts/disable_fx).
PayoutSettings	enableAutomatic()
PayoutSettings	enableFX()	Enables foreign exchange conversion for payouts (POST /payouts/enable_fx).
Payout	lookup(LookupPayoutParams params)
Payout	lookup(String payoutId)
PayoutPage	page(PayoutPageParams params)	Retrieves a paginated list of payouts (POST /payouts/page).
Payout	schedule(SchedulePayoutParams params)
PayoutSettings	setDestinations(Map<String,String> destinations)	Configures payout destination financial accounts per currency (POST /payouts/set_destinations).
PayoutSettings	settings()	Retrieves current payout settings for your application (POST /payouts/settings).

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

PayoutsClient

public PayoutsClient(Client client)

Method Details

setDestinations

public PayoutSettings setDestinations(Map<String,String> destinations)
                               throws IOException,
InterruptedException,
ApiException

Configures payout destination financial accounts per currency (POST /payouts/set_destinations).

Maps each currency to a financial account ID where payouts in that currency should be sent. For example, map "ghs" to a Ghana mobile money account and "usd" to a US bank account. Payouts will automatically route to the appropriate destination based on the balance currency.

Parameters:

destinations - map of currency codes to financial account IDs (e.g., {"ghs": "fa_123", "usd": "fa_456"})

Returns:

PayoutSettings with updated payout settings

Throws:

IOException - if network communication fails

InterruptedException - if the request is interrupted

ApiException - if invalid account IDs, unsupported currencies, or accounts not compatible with currencies

settings

public PayoutSettings settings()
                        throws IOException,
InterruptedException,
ApiException

Retrieves current payout settings for your application (POST /payouts/settings).

Returns payout schedule configuration (automatic or manual), destination mappings per currency, FX conversion settings, and any schedule-specific parameters.

Returns:

PayoutSettings with payout configuration

Throws:

IOException - if network communication fails

InterruptedException - if the request is interrupted

ApiException - if unauthorized (401)

disableAutomatic

public PayoutSettings disableAutomatic()
                                throws IOException,
InterruptedException,
ApiException

Disables automatic payouts and switches to manual mode (POST /payouts/disable).

Changes the payout schedule from automatic (e.g., weekly) to manual. In manual mode, payouts only occur when explicitly triggered by you. Use this when you need full control over when funds are transferred from your balance to your bank accounts.

Returns:

PayoutSettings with updated settings showing manual schedule

Throws:

IOException - if network communication fails

InterruptedException - if the request is interrupted

ApiException - if unauthorized (401) or already in manual mode

enableAutomatic

public PayoutSettings enableAutomatic()
                               throws IOException,
InterruptedException,
ApiException

Throws:

IOException

InterruptedException

ApiException

enableFX

public PayoutSettings enableFX()
                        throws IOException,
InterruptedException,
ApiException

Enables foreign exchange conversion for payouts (POST /payouts/enable_fx).

Allows payouts to be converted from the balance currency to the destination account currency. For example, a GHS balance can be paid out to a USD bank account with automatic conversion. Exchange rates are applied at the time of payout execution.

Returns:

PayoutSettings with FX enabled in settings

Throws:

IOException - if network communication fails

InterruptedException - if the request is interrupted

ApiException - if unauthorized (401) or FX not supported for your account

disableFX

public PayoutSettings disableFX()
                         throws IOException,
InterruptedException,
ApiException

Disables foreign exchange conversion for payouts (POST /payouts/disable_fx).

Prevents currency conversion during payouts. When disabled, payouts can only be sent to destination accounts that match the balance currency. Attempting to payout to a mismatched currency account will fail.

Returns:

PayoutSettings with FX disabled in settings

Throws:

IOException - if network communication fails

InterruptedException - if the request is interrupted

ApiException - if unauthorized (401)

page

public PayoutPage page(PayoutPageParams params)
                throws IOException,
InterruptedException,
ApiException

Retrieves a paginated list of payouts (POST /payouts/page).

Returns recent payouts with pagination support. Use page_index and page_size to control pagination. Payouts are returned in reverse chronological order (newest first). Each payout includes amount, destination, status, and timestamps.

Parameters:

params - pagination parameters including page index and size

Returns:

PayoutPage containing list of payouts and pagination details

Throws:

IOException - if network communication fails

InterruptedException - if the request is interrupted

ApiException - if invalid pagination parameters (400) or unauthorized (401)

lookup

public Payout lookup(String payoutId)
              throws IOException,
InterruptedException,
ApiException

Throws:

IOException

InterruptedException

ApiException

lookup

public Payout lookup(LookupPayoutParams params)
              throws IOException,
InterruptedException,
ApiException

Throws:

IOException

InterruptedException

ApiException

schedule

public Payout schedule(SchedulePayoutParams params)
                throws IOException,
InterruptedException,
ApiException

Throws:

IOException

InterruptedException

ApiException

cancel

public Payout cancel(String payoutId)
              throws IOException,
InterruptedException,
ApiException

Cancels a scheduled payout before execution (POST /payouts/cancel).

Only payouts in scheduled status with future execution windows can be canceled. Once canceled, the payout is permanently stopped.

Parameters:

payoutId - scheduled payout identifier

Returns:

Payout containing the canceled payout

Throws:

IOException - if network communication fails

InterruptedException - if the request is interrupted

ApiException - if payout cannot be canceled or request is invalid