Skip to main content
GET
List settlement files

Authorizations

x-api-key
string
header
required

Query Parameters

createdFrom
string<date-time>
required

Start of the time period (ISO 8601, UTC, no timezone offset). To retrieve a full day, set this to 00:00:00 of the target date.

createdTo
string<date-time>
required

End of the time period (ISO 8601, UTC, no timezone offset). To retrieve a full day, set this to 23:59:59 of the target date.

merchantId
integer<int64>

Filter results to files for a specific merchant.

storeId
integer<int64>

Filter results to files for a specific store.

Response

A list of settlement files for the requested period.

data
object[]