Get Settlements

Facades: merchant

Overview

Get settlements filtered by query parameters.

Parameters

ParameterDescription
currencyThe three digit currency string for the ledger to retrieve
date_startThe start date for the query
date_endThe end date for the query
statusCan be processing, completed, or failed
limitMaximum number of settlements to retrieve
offsetOffset for paging

Example

📘

Note

In this example, we assume that a Client has already been initialized and assigned to the bitpay variable.

bitpay.get_settlements('USD', '2023-08-14', '2023-08-22')