Package com.flutterwave.services

Class Settlements

java.lang.Object

com.flutterwave.services.Settlements

public class Settlements
extends Object

APIs needed for managing your settlements.

Author:

Cleopatra Douglas

Constructor Summary

Constructors

Constructor	Description
Settlements()

Method Summary

Modifier and Type	Method	Description
SettlementListResponse	runGetAllSettlements(Optional<Integer> page, Optional<String> from, Optional<String> to, Optional<String> subaccount_id)	Query all settlements made to an account.
SettlementResponse	runGetSettlement(int id, Optional<String> from, Optional<String> to)	Get details on a particular settlement specified by its ID.

Methods inherited from class java.lang.Object

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

Constructor Details

Settlements

public Settlements()

Method Details

runGetAllSettlements

public SettlementListResponse runGetAllSettlements(Optional<Integer> page,
 Optional<String> from,
 Optional<String> to,
 Optional<String> subaccount_id)

Query all settlements made to an account.

Parameters:

page - Optional This is the page number to retrieve e.g. setting 1 retrieves the first page.

from - Optional This is the specified date to start the list from. YYYY-MM-DD.

to - Optional The is the specified end period for the search . YYYY-MM-DD.

subaccount_id - Optional This is the unique id of the sub account you want to fetch. It is returned in the call to create a sub account.

Returns:

SettlementListResponse

runGetSettlement

public SettlementResponse runGetSettlement(int id,
 Optional<String> from,
 Optional<String> to)

Get details on a particular settlement specified by its ID.

Parameters:

id - int This is a unique identifier for the particular settlement you want to fetch. It is returned in the call to list all settlements as data.id.

from - Optional The start date range to retrieve data from. Expected format is YYYY-MM-DD.

to - Optional The end date range to retrieve data. Expected format is YYYY-MM-DD.

Returns:

SettlementResponse