Skip to main content
View as Markdown

Statement global and daily balances

This method allows to view the total summary information for a specific account's statement. The method returns the full summary information, as well as the information broken down by each day.

note

This method is rate limited — 1 request per minute is allowed (per account and currency). Exceeding the limit returns 429 Too Many Requests with a Retry-After header (in seconds).

Query params​

accountNumberrequiredstring

An account number.

currencyrequiredstring

An account currency.

idrequireddate

A statement unique ID.

GET api/v2/statement/summary/{accountNumber}/{currency}/{startDate}/{endDate}

Response​

GlobalSummaryobject

A statement period summary balance.

AccountNumberstring

An account number.

Currencystring

A currency.

StartDatedate

A date of the first transaction.

EndDatedate

A date of the last transaction.

PeriodStartDatedate

A period start date.

PeriodEndDatedate

A period end date.

InAmountdecimal number

An income amount.

InAmountBasedecimal number

An income amount in the national currency.

InRatedecimal number

An income amount conversion rate.

OutAmountdecimal number

An outcome amount.

OutAmountBasedecimal number

An outcome amount in the national currency.

OutRatedecimal number

An outcome amount conversion rate.

CreditSumdecimal number

An entry summary amount (credit).

DebitSumdecimal number

An entry summary amount (debit).

DailySummariesobject

A statement of daily amounts (one or more).

Balancedecimal number

A balance.

BalanceBasedecimal number

A balance equivalent in the national currency.

CreditSumdecimal number

An entry summary amount (credit).

DebitSumdecimal number

An entry summary amount (debit).

Ratedecimal number

A conversion rate.

EntryCountinteger

An entry count for a given date.

Datedate

An entry date.

{
  "globalSummary": {
    "accountNumber": "sample string 1",
    "currency": "sample string 2",
    "startDate": "2021-06-21T10:43:17.358503+04:00",
    "endDate": "2021-06-21T10:43:17.358503+04:00",
    "periodStartDate": "2021-06-21T10:43:17.358503+04:00",
    "periodEndDate": "2021-06-21T10:43:17.358503+04:00",
    "inAmount": 7.0,
    "inAmountBase": 8.0,
    "inRate": 9.0,
    "outAmount": 10.0,
    "outAmountBase": 11.0,
    "outRate": 12.0,
    "creditSum": 13.0,
    "debitSum": 14.0
  },
  "dailySummaries": [
    {
      "balance": 1.0,
      "balanceBase": 2.0,
      "creditSum": 3.0,
      "debitSum": 4.0,
      "rate": 5.0,
      "entryCount": 6,
      "date": "2021-06-21T10:43:17.358503+04:00"
    },
    {
      "balance": 1.0,
      "balanceBase": 2.0,
      "creditSum": 3.0,
      "debitSum": 4.0,
      "rate": 5.0,
      "entryCount": 6,
      "date": "2021-06-21T10:43:17.358503+04:00"
    }
  ]
}