Get Settlements List in a Period

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.

interface

{
	"settlements": [Settlement]
}

Settlement Interface

Property	Type	Description
id	String (UUID)	A unique identifier for the settlement report.
gross.amount	String	The total amount withdrawn from the merchant balance.
gross.currency	String	The currency of the gross amount.
fee.amount	String	The fee amount for the settlement.
fee.currency	String	The currency of the fee amount.
net.amount	String	The net amount of the settlement which is gross minus fee.
net.currency	String	The currency of the net amount.
payout.amount	String	The amount expected to be received from the merchant.
payout.currency	String	The currency of the payout amount.
account.label	String	The label of the account to which the settlement was paid out.
createTime	String (DateTime)	The UTC date and time at which the settlement report was created.