Get balance report

Balance Report Endpoint

get

https://merchants-api.onekeypayments.com/v1https://merchants-api-stg.onekeypayments.com/v1

/balance/report

Retrieve the details of your daily Balance Report in a given time.

Authorizations

bearerAuthcookieAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

fromintegerOptional

Transaction creation date interval in Unix TimeStamp format.

tointegerOptional

Transaction creation date interval in Unix TimeStamp format, max difference with 'from' value 60 days.

pageintegerOptional

The page number.

Default: 0

Responses

200

A paginated list of daily balance reports.

application/json

get

/balance/report

HTTPcURLJavaScriptPython

GET /v1/balance/report HTTP/1.1
Host: merchants-api.onekeypayments.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

A paginated list of daily balance reports.

{
  "page": 0,
  "rows": 2,
  "maxRows": 50,
  "data": [
    {
      "idMerchant": 4,
      "depositTotal": 12.5,
      "cashoutTotal": 0,
      "noteTotal": 0,
      "settlementTotal": 0,
      "cancelledSettlementTotal": 0,
      "depositFeeTotal": 0.1,
      "netAmount": 12.4,
      "totalBalance": 104655.38,
      "date": "2020-01-31T00:00:00Z",
      "currency": "USD"
    }
  ]
}