Home
API Reference

Settlements

get
https://zip.co/nz/api/reports/settlements

Retrieves a list of settlements with disbursement dates between a given date-time range in UTC

Query Params
date
required
Defaults to 2020-11-01T00:00:00.000Z

An ISO-8601 date and time in UTC to query disbursementDateUtc from (inclusive)

date
required
Defaults to 2020-12-01T00:00:00.000Z

An ISO-8601 date and time in UTC to query disbursementDateUtc to (inclusive)

int32
required
Defaults to 1

The page number

int32
required
Defaults to 100

The page size

string

The id of a merchant to filter by

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated about 1 month ago

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

Updated about 1 month ago