Get Settlements

Facades: merchant

Overview

Get settlements filtered by query parameters.

Parameters

ParameterDescription
currencyThe three digit currency string for the ledger to retrieve.
dateStartThe start date for the query.
dateEndThe end date for the query.
statusCan be processing, completed, or failed.
limitMaximum number of settlements to retrieve.
offsetOffset 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)