SettlementClient
in package
Handles interactions with the settlement endpoints.
Tags
Table of Contents
Properties
- $instance : self|null
- $restCli : RESTcli
- $tokenCache : Tokens
Methods
- get() : Settlement
- Retrieves a summary of the specified settlement.
- getInstance() : static
- Factory method for Settlements Client.
- getReconciliationReport() : Settlement
- Gets a detailed reconciliation report of the activity within the settlement period.
- getSettlements() : array<string|int, Settlement>
- Retrieves settlement reports for the calling merchant filtered by query.
- __construct() : mixed
Properties
$instance
private
static self|null
$instance
= null
$restCli
private
RESTcli
$restCli
$tokenCache
private
Tokens
$tokenCache
Methods
get()
Retrieves a summary of the specified settlement.
public
get(string $settlementId) : Settlement
Parameters
- $settlementId : string
-
Settlement Id.
Tags
Return values
SettlementgetInstance()
Factory method for Settlements Client.
public
static getInstance(Tokens $tokenCache, RESTcli $restCli) : static
Parameters
Return values
staticgetReconciliationReport()
Gets a detailed reconciliation report of the activity within the settlement period.
public
getReconciliationReport(string $settlementId, string $settlementToken) : Settlement
Parameters
- $settlementId : string
-
Settlement ID
- $settlementToken : string
-
Settlement Token
Tags
Return values
SettlementgetSettlements()
Retrieves settlement reports for the calling merchant filtered by query.
public
getSettlements(string $currency, string $dateStart, string $dateEnd[, string|null $status = null ][, int|null $limit = null ][, int|null $offset = null ]) : array<string|int, Settlement>
The limit and offset parameters
specify pages for large query sets.
Parameters
- $currency : string
-
The three digit currency string for the ledger to retrieve.
- $dateStart : string
-
The start date for the query.
- $dateEnd : string
-
The end date for the query.
- $status : string|null = null
-
string Can be
processing,completed, orfailed. - $limit : int|null = null
-
int Maximum number of settlements to retrieve.
- $offset : int|null = null
-
int Offset for paging.
Tags
Return values
array<string|int, Settlement>__construct()
private
__construct(Tokens $tokenCache, RESTcli $restCli) : mixed