Skip to main content
GET
/
settlements
/
reports
Lists all settlement reports
curl --request GET \
  --url https://commerce1.on-hellgate.dev/settlements/reports \
  --header 'X-API-Key: <api-key>'
{
  "data": [
    {
      "currency_code": "<string>",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "items": [
        {
          "date": "2023-11-07T05:31:56Z",
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "settlement_report_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "commission": 123,
          "fee_type": "<string>",
          "gross_credit_amount": 123,
          "gross_debit_amount": 123,
          "net_credit_amount": 123,
          "net_debit_amount": 123,
          "payment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        }
      ],
      "reporting_period_end": "2023-11-07T05:31:56Z",
      "reporting_period_start": "2023-11-07T05:31:56Z"
    }
  ],
  "next_page": 123
}

Authorizations

​
X-API-Key
string
header
required

Headers

​
X-Account-ID
string

Identifies the account. Required when authenticating via mTLS — omit when using an API key (account is inferred from the key).

Query Parameters

​
from
string<date-time>

filter for reporting period start

​
to
string<date-time>

ffilter for reporting period end

​
page
integer

Page cursor for pagination

​
limit
integer

Maximum items per page

Response

Success

​
data
SettlementReportResponse · object[]
​
next_page
integer | null