Facades: merchant
Overview
Get settlements filtered by query parameters.
Parameters
| Parameter | Description |
|---|---|
| currency | The three digit currency string for the ledger to retrieve. |
| dateStart | The start date for the query. |
| dateEnd | The end date for the query. |
| status | Can be processing, completed, or failed. |
| limit | Maximum number of settlements to retrieve. |
| offset | Offset for paging. |
Example
$date = new \DateTime();
$today = $date->format("Y-m-d");
$dateBefore = $date->modify('-365 day');
$oneMonthAgo = $dateBefore->format("Y-m-d");
$settlements = $bitpay->getSettlements(Currency::USD, $oneMonthAgo, $today);