API Reference
Client PortalAPI StatusWebsite

Account activity report

post
https://www.bankingcircleconnect.com/api/v2/reports/requests/account-activity-report
Body Params

Contains parameters for the requested report

string
required
length ≥ 1

Format type the report should be generated as

Available options:

  • json
  • csv
  • mt940
uuid
required

Id of the account on which activities have been booked

Criteria: Exact match on the Id of the account

date-time
required

Minimum transaction date

FromTransactionDate and ToTransactionDate form a date range

Format: ISO 8601 | YYYY-MM-DD

date-time
required

Maximum transaction date

FromTransactionDate and ToTransactionDate form a date range

Format: ISO 8601 | YYYY-MM-DD

includeProperties
array of strings | null

Properties of AccountActivity object to include in result

If IncludeProperties is set, ExcludeProperties 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)
includeProperties
excludeProperties
array of strings | null

Properties of AccountActivity object to exclude from result

To get all available properties send an empty ExcludeProperties list If ExcludeProperties is set, IncludeProperties need not be set

excludeProperties
int32
enum
Allowed:
string | null

Optional field for custom information

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

403

Forbidden Authorization error

Updated 7 months ago

Language
Credentials
Bearer
Response 
 Choose an example:
*/*
application/json
text/plain
Updated 7 months ago