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
const params = {
startDate: '2021-05-10',
endDate: '2021-05-12',
status: 'processing',
limit: 100,
offset: 0
};
const settlements = await client.getSettlements(params)