Sign in

v1

latestOpenAPI 3.1.02026-07-241660500.9 KB

Get Settlement Report

get/v3/report/volume

Query parameters

merchantsinteger required

Merchant ids

startDatestring date required

Start date in MM/DD/YYYY format

endDatestring date required

End date in MM/DD/YYYY format

groupBystring required

Options to Group results by. Values: merchantcubedate, batch

limitinteger
offsetinteger

Response

200

OR

Example response

{
  "records": [
    {
      "merchantId": 110070419,
      "dba": "Demo Test TSYS Merchant",
      "xmid": "8739xxxxxxx00001",
      "cubeDate": "2017-11-18T12:00:00Z",
      "bankCardTransactions": 1,
      "bankCardAmount": "-0.01",
      "nonBankCardAmount": "0",
      "pinDebitAmount": "0",
      "transactions": 1,
      "totalAmount": "-0.01",
      "devices": 1,
      "batches": 1,
      "cardTypes": 1
    }
  ],
  "recordCount": 5,
  "totals": {
    "totalAmount": "11.26"
  }
}