---
title: "Get Settlement Report"
method: GET
path: "/v3/report/volume"
---

# Get Settlement Report

`GET /v3/report/volume`

## Query parameters

- `merchants` integer, required
- `startDate` string, date, required
- `endDate` string, date, required
- `groupBy` string, required
- `limit` integer
- `offset` integer

## Response `200`

200

- union
  - object
    - `records` object[]
      - `merchantId` integer
      - `dba` string
      - `xmid` string
      - `merchants` integer
      - `cubeDate` string
      - `bankCardTransactions` integer
      - `bankCardAmount` string
      - `nonBankCardTransactions` integer
      - `nonBankCardAmount` string
      - `pinDebitAmount` string
      - `transactions` integer
      - `totalAmount` string
      - `devices` integer
      - `batches` integer
      - `cardTypes` integer
    - `recordCount` integer
    - `totals` object
      - `totalAmount` string
  - object
    - `records` object[]
      - `merchantId` integer
      - `dba` string
      - `xmid` string
      - `merchants` integer
      - `cubeDate` string
      - `bankCardTransactions` integer
      - `bankCardAmount` string
      - `nonBankCardTransactions` integer
      - `nonBankCardAmount` string
      - `pinDebitAmount` string
      - `transactions` integer
      - `totalAmount` string
      - `deviceId` integer
      - `device` string
      - `batchNumberId` integer
      - `clearingId` integer
      - `batchNumber` string
      - `paymentType` string
      - `cardTypes` integer
      - `clearingReference` string
    - `recordCount` integer
    - `totals` object
      - `totalAmount` string

---

[API](https://skmtc.net/mxmerchant/apis/checkout-api.md) · [All operations](https://skmtc.net/mxmerchant/apis/checkout-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/mxmerchant/checkout-api/versions/6807b698abcb/schema)