Settlements and reporting

GET /settlements (scope settlements:read) returns every payment that settled in a date range, with a summary per currency. Use it to match Olympus Pay against your own books at the end of each period.

Parameter	Notes
`from`	Start of the range, an ISO date
`to`	End of the range, an ISO date
`splitRecipientId`	Optional. Limits the report to one split recipient
`format`	Optional. `csv` returns a download and also needs scope `reports:export`

# JSON
curl "https://merchant.olympuspay.co/api/v1/settlements?from=2026-09-01&to=2026-09-30" \
  -H "Authorization: Bearer $OLYMPUS_API_KEY"

# CSV for your accountant
curl "https://merchant.olympuspay.co/api/v1/settlements?from=2026-09-01&to=2026-09-30&format=csv" \
  -H "Authorization: Bearer $OLYMPUS_API_KEY" -o september.csv

Each payment in the report shows the gross amount, the fee, the net amount, the amount refunded and the net settled.

Check your account#

GET /account (account:read or kyc:read) returns your business profile and verification status: the verification status, how many documents you have submitted, how many owners are verified, and whether a settlement destination is on file. Use it to see whether you are ready for live keys: Go live.