Export Settlements

Exports every settlement that matches a search to a CSV or Excel file and returns a short-lived download link.

Takes the same filter and sort as Search Settlements, without paging.

Permission: Merchant Read.

Errors

  • 400 INVALID_FILE_TYPE: fileType is not csv or xlsx.
  • 400 INVALID_TIMEZONE_OFFSET: timezoneOffset is outside -840 to 720.
  • 400 VALIDATION_ERROR or 400 INVALID_REQUEST: the filter or sort is invalid, as in Search Settlements.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
enum
Defaults to csv

File format of the export: csv or xlsx. Defaults to csv.

Allowed:
number
Defaults to 0

Offset in minutes subtracted from UTC when the file's dates are formatted, as returned by JavaScript's
Date.getTimezoneOffset(): 180 for UTC-3, -60 for UTC+1. Between -840 and 720. Defaults to 0 (UTC).

Body Params

An export request: the same filter and sort as the matching search, without paging. Every matching record is
exported.

SearchAllConditions<SettlementSearchField> | SearchAnyConditions<SettlementSearchField>

Conditions a record must match. Omit to export every record. Use all for AND and any for OR; groups can be nested.

sort
array of objects

Sort order of the rows, applied in the order listed.

sort
Responses

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json