---
title: "GET /payment/stats"
method: GET
path: "/payment/stats"
tags: ["payment-statistics"]
---

# GET /payment/stats

`GET /payment/stats`

## Query parameters

- `type` 'invoice' | 'white_label' | 'static_address'
- `network` string
- `pay_currency` string
- `from_date` integer
- `to_date` integer

## Headers

- `merchant_api_key` string, required
- `Content-Type` string, required

## Response `200`

Successful operation

- object
  - `data` object
    - `list` object[] — A list of aggregated payment statistics grouped by cryptocurrency.
      - `pay_currency` string — The cryptocurrency symbol in which the payment was received.
      - `total` integer — The total number of payments for this cryptocurrency.
      - `received_amount` string — The total received amount for this cryptocurrency. Returned as a decimal string to preserve precision.
    - `meta` object
      - `page` integer — The current page number of the result set.
      - `last_page` integer — The total number of pages available based on the number of records and page size.
      - `total` integer — The total number of statistic records available for the specified criteria.
  - `message` string — A message containing additional information about the result of the request.
  - `error` object, nullable — An object that provides details about any errors that occurred.
    - `type` string — Type of the error.
    - `key` string — Key related to the error.
    - `message` string — Error message.
  - `status` integer — The status of the request response. Typically provided as a numeric code.
  - `version` string — The version of the API being used.

## Other responses

- `400` — Bad request

---

[API](https://skmtc.dev/oxapay/apis/payments.md) · [All operations](https://skmtc.dev/oxapay/apis/payments/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/oxapay/payments/revisions/19b6abc20c8d/schema)