Get account activity report

get

https://www.bankingcircleconnect.com/api/v1/reports/account-activity-report

This endpoint returns an account activity report. The report contains account statements detailing all payments booked on your account, and their impact on the balance, within a selected date range. There is a limitation of 50,000 payments per report for this endpoint. If you need a report for more than 50,000 payments on your account, a paginated endpoint is available.

Only data from current and previous year is available online. Contact Client Services to access older data.

Query Params

AccountId

uuid

required

Id of the account on which activities have been booked

Criteria: Exact match on the Id of the account

FromTransactionDate

date-time

required

Minimum activity transaction date

FromTransactionDate and ToTransactionDate form a date range

Criteria: AccountActivity.TransactionDate must be equal or later

Format: ISO 8601 | YYYY-MM-DD

ToTransactionDate

date-time

required

Maximum activity transaction date

FromTransactionDate and ToTransactionDate form a date range

Criteria: AccountActivity.TransactionDate must be equal or earlier

Format: ISO 8601 | YYYY-MM-DD

IncludeProperties

array of strings

deprecated

This Parameter has been deprecated. Please use PropertiesIncluded instead.

IncludeProperties

PropertiesIncluded

string

Properties of AccountActivity object to include in result

Please note: the use of IncludeProperties and PropertiesIncluded are mutual exclusive. - When both are used all IncludeProperties are ignored.

If PropertiesIncluded is set, PropertiesExcluded need not be set

If neither PropertiesIncluded nor PropertiesExcluded are specified, default value will be PropertiesIncluded

TransactionDate
ValueDate
Credit
Debit
Balance
ReferenceNumber
Description
PaymentDetails
BeneficiaryRemitter1
BeneficiaryRemitter2

Extra parameters that can be added to the array, but are not part of the default array:

StatusReasonCode
StatusReasonDescription
Viban (Note: 'Viban' property is available only while requesting this report in CSV format)

Format: comma (,) separated string

ExcludeProperties

array of strings

deprecated

This Parameter has been deprecated. Please use PropertiesExcluded instead.

ExcludeProperties

PropertiesExcluded

string

Properties of AccountActivity object to exclude from result

Please note: the use of ExcludeProperties and PropertiesExcluded are mutual exclusive. - When both are used all ExcludeProperties are ignored.

To get all available properties send an empty PropertiesExcluded

If PropertiesExcluded is set, PropertiesIncluded need not be set

Format: comma (,) separated string

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

200OK

400Bad Request