This endpoint enables you to retrieve the list of settlements in a specified period. To receive the relevant settlement data, provide a starting and ending point for the period you want to fetch the settlement data from using the "since" and "until" query parameters.

Response overview

In this section, a description of the settlements array properties is provided.

	"settlements": [Settlement]

Settlement Interface

idString (UUID)A unique identifier for the settlement report.
gross.amountStringThe total amount withdrawn from the merchant balance.
gross.currencyStringThe currency of the gross amount.
fee.amountStringThe fee amount for the settlement.
fee.currencyStringThe currency of the fee amount.
net.amountStringThe net amount of the settlement which is gross minus fee.
net.currencyStringThe currency of the net amount.
payout.amountStringThe amount expected to be received from the merchant.
payout.currencyStringThe currency of the payout amount.
account.labelStringThe label of the account to which the settlement was paid out.
createTimeString (DateTime)The UTC date and time at which the settlement report was created.
Click Try It! to start a request and see the response here!