Skip to main content
GET
/
v1
/
reports
/
settlement
curl
curl -X GET "https://api.services.payward.com/v1/reports/settlement?start_date=2026-04-25T00:00:00Z&end_date=2026-04-26T00:00:00Z&report_type=price_trigger_swaps&report_type=swaps&page_size=1" \
  -H "API-Key: $PWS_API_KEY" \
  -H "API-Nonce: $PWS_API_NONCE" \
  -H "API-Sign: $PWS_API_SIGN"
{
  "data": [
    {
      "id": "00000000-0000-0000-0000-000000000001",
      "date": "2026-04-25",
      "type": "swaps",
      "size": "18342",
      "name": "settlement-2026-04-25.csv"
    },
    {
      "id": "00000000-0000-0000-0000-000000000003",
      "date": "2026-04-27",
      "type": "price_trigger_swaps",
      "size": "7341",
      "name": "settlement-2026-04-27.csv"
    },
    {
      "id": "00000000-0000-0000-0000-000000000004",
      "date": "2026-04-28",
      "type": "earn_rewards",
      "size": "8102",
      "name": "settlement-2026-04-28.csv"
    }
  ]
}

Authorizations

​
API-Key
string
header
required

Your public API key. Identifies the partner making the request.

​
API-Nonce
string
header
required

Monotonically increasing nonce included in the request signature.

​
API-Sign
string
header
required

HMAC signature over the request, computed with your private key.

Query Parameters

​
start_date
string<date-time> | null

The inclusive start date for filtering settlement reports. Use in combination with end_date to specify a date range. Format: RFC 3339 datetime.

Example:

"2026-04-25T00:00:00Z"

​
end_date
string<date-time> | null

The inclusive end date for filtering settlement reports. Use in combination with start_date to specify a date range. Format: RFC 3339 datetime.

Example:

"2026-04-26T00:00:00Z"

​
report_type
enum<string>[]

Filters the returned reports by one or more report types. If omitted, all report types are included. Repeat the query parameter to request multiple types, for example report_type=price_trigger_swaps&report_type=swaps. Unknown values return a 400 response.

Available options:
swaps,
price_trigger_swaps,
earn_rewards
Example:
["price_trigger_swaps", "swaps"]
​
page_size
integer<int32>
default:20

Maximum number of results to return on a single page. Defaults to 20, maximum 100.

Required range: 1 <= x <= 100
​
page_token
string

Opaque cursor returned by a previous response's next_page_token. Omit to start from the beginning.

Required string length: 1 - 512

Response

Successful response containing a list of settlement reports and pagination details.

​
data
object[]
required

An array of settlement report objects that match the specified filter criteria.

​
next_page_token
string

Opaque cursor for the next page of results. Absent when there are no more pages.

Required string length: 1 - 512