Reconciliation and Reporting

About reconciliation

The Banking Circle Report API offers a secure, reliable, and automated channel for communication between your system and Banking Circle reporting capabilities. Reports are generated with a synchronous request/response.

The following reports are available for get request at any given time during the day, as well as at end-of-day:

  • Reconciliation reports
  • Rejection reports
  • Account Activity reports
  • Account Balance reports

Reconciliation report

The reconciliation endpoint is used to generate a report containing relevant information on all your account movements at the given transaction date, or within a transaction date range. The report can be used to perform financial reconciliation of bookings during the day, or at end-of-day.

The report is available in CSV and JSON format. There is a limitation of 50,000 payments per report.

If the desired number of payments exceeds these limitations, you will need to use the paginated reconciliation endpoint.

You are required to specify which time frame the returned report should cover, and in addition you can apply further filters on which properties the report should contain.

Parameters in reconciliation report request

ParameterRequiredDescription
FromTransactionDateMandatoryFormat: ISO 8601 | YYYY-MM-DD. Specify from which transaction date the report should be generated.
ToTransactionDateMandatoryFormat: ISO 8601 | YYYY-MM-DD. Specify until which transaction date the report should be generated.
IncludePropertiesOptionalSpecify properties to include in the reconciliation report results. By default we will include all properties except for paymentId & lastChangedTimestamp that can be added to the array. See below table for all properties of the report.
ExcludePropertiesOptionalSpecifies properties to exclude from the reconciliation report results. By default we will include all properties. To get all available properties, send an empty exclude properties.

Properties of reconciliation report

Field NameField TypeExampleDescription
P_ID_CHANNELUSERVarcharNAMESURNAME@bankingcircle.comUser ID of the requesting client
P_TXNDATEDate (YYYY-MM-DD; MM/dd/yyyy HH:mm:ss.fff)2021-10-27T00:00:00.000+00:00Internal date that indicates when payment was instructed in Banking Circle. It does not match the processing date.
REPORT_DATEDate (DDMMYYYY)29102021Date of when the report is generated
CUSTOMERIDNumber15106Customer ID of the account
ACCOUNTVarcharDKXXXX0000000XXXXXIBAN of the account
ACCOUNT_CURRENCYText (3)EURISO currency of your account
DEBIT_AMOUNTNumber, 2 decimals22.26The amount debited, it is only populated if DBIT.In case of reversal of a debit, the amount will be given as a negative equivalent of the original amount debited
CREDIT_AMOUNTNumber, 2 decimals10.89The amount credited, it is only populated if CRDT.In case of reversal of a credit, the amount will be given as a negative equivalent of the original amount credited
VALUE_DATEDate (YYYY-MM-DD;DD/MM/YYYY)27/10/2021Value date for posting on the account
INSTRUCTED_AMOUNTNumber22.26Only for DBIT. Equivalent in original currency to the amount transferred after currency exchange. The instructed amount based on the choice of “payment currency” as provided in the payment instruction
INSTRUCTED_AMOUNT_CURRENCYText (3)EURISO currency of instruction. Contains the currency of the instructed amount as provided in the payment instruction
TRANSACTION_AMOUNTNumber18.78DBIT: actual amount transferred to beneficiary CRDT: actual amount received for credit to the beneficiary account
TRANSACTION_AMOUNT_CURRENCYText (3)GBPISO currency of transaction amount
EXCHANGE_RATENumber0.84367Currency exchange applied in the transaction, between the instructed amount and the transaction amount.
DEBTOR_BANK_CODEVarcharSXPYDKKKXXXBank Code of the debtor, only populated for CRDT
DEBTOR_ACCOUNTVarcharDKXXXX0000000XXXXXFor CRDT: Account of debtor For DBIT: Blank For DBIT using VIBAN: Viban used for the transaction (DK representation)
DEBTOR_LINE_1VarcharDebtor NameFor CRDT: Line 1 details for debtor For DBIT: Blank For DBIT using VIBAN: Name associated with Virtual account
DEBTOR_LINE_2VarcharDebtor Address line 1For CRDT: Line 2 details for debtor For DBIT: Blank
DEBTOR_LINE_3VarcharDebtor Address line 2For CRDT: Line 3 details for debtor For DBIT: Blank
DEBTOR_LINE_4VarcharDebtor Address line 3For CRDT: Line 4 details for debtor For DBIT: Blank
BENEFICIARY_BANK_CODEVarcharSXPYDKKKXXXBank code of creditor, only populated for DBIT
BENEFICIARY_ACCOUNTVarcharDKXXXX0000000XXXXXFor DBIT: Account of creditor For CRDT using VIBAN: DK IBAN representation of VIBAN used in the transaction For CRDT: Blank
BENEFICIARY_LINE_1VarcharCreditor NameFor DBIT: Line 1 details for Beneficiary For CRDT using VIBAN: Name associated with virtual account. For CRDT: Blank
BENEFICIARY_LINE_2VarcharCreditor Address Line 1For DBIT: Line 2 details for Beneficiary For CRDT: Blank
BENEFICIARY_LINE_3VarcharCreditor Address Line 2For DBIT: Line 3 details for Beneficiary For CRDT: Blank
BENEFICIARY_LINE_4VarcharCreditor Address Line 3For DBIT: Line 4 details for Beneficiary For CRDT: Blank
PAYMENT_REFERENCE_NUMBERVarchar010F10xxxx001007Banking Circle reference number, unique identifier for processed transactions
FILE_REFERENCE_NUMBER36 CHAR a-Za-Z0-9/-?:.+923578e7-7a58-4982-93f1-5862e687611dBulk id of instructed payment file, only populated for bulk payments
USER_REFERENCE_NUMBERa-Za-Z0-9/-?:.+Debtor referenceProvides the reference number of each payment record as stated in payment instruction by the debtor (DebtorReference). In case of internal transfers between banking circle accounts, this field would be blank.
PAYMENT_DETAILS_1VarcharEnd to end id for beneficiaryLine 1 of payment details ( Remitter information line 1).Reference is propagated to beneficiary.
PAYMENT_DETAILS_ 2VarcharInfo for beneficiary 2Line 2 of payment details
PAYMENT_DETAILS_ 3VarcharInfo for beneficiary 3Line 3 of payment details
PAYMENT_DETAILS_ 4VarcharInfo for beneficiary 4Line 4 of payment details
CREDIT_DEBIT_INDICATORDBIT/CRDTDBITCRDT for credit DBIT for debit
BANK_TRNS__CODE_DOMAINVarcharPMNTBank transaction code for payment type identification. PMNT= Payment transfer FORX= foreign exchange ACMT=Account management: fees, interest, teller bookings
BANK_TRNS__CODE_FAMILYVarcharICDTBank transaction sub-code for payment type identification. IDCT= Issued payment,sold leg fx or fee RCDT: Incoming payment, bough fx leg, reversal of payment fee.
Additional fields- ON REQUEST
PAYMENT_ID36 CHAR, Varchar4a1e5714-7ac3-9383-08a7-ffbadaa2f4bbUnique payment reference within Banking Circle that can be used to match the transaction instructed via API with the booking in the reconciliation report
LASTCHANGEDTIMESTAMPYYYY-MM-DDTHH:MM:SS.00000000+00:002019-11-08T11:40:25.00000000+00:00Indicates the time stamp of when a transaction was last changed in the processing system.

Paginated report

The reconciliation report is also available in a paginated version, to allow for a larger number of rows to be included in the report. The content of the file remains unchanged, and the above specification can be used.

Note, the paginated version does not support date ranges, and will instead include data for the day requested and not a date set.

Parameters in paginated reconciliation report request

ParameterRequiredDescription
TransactionDateMandatoryFormat: ISO 8601 | YYYY-MM-DD. Specify for which transaction date the report should be generated
IncludePropertiesOptionalSpecify properties to include in the reconciliation report results. By default we will include all properties except for paymentId & lastChangedTimestamp that can be added to the array. See below table for all properties of the report
ExcludePropertiesOptionalSpecifies properties to exclude from the reconciliation report results. By default we will include all properties. To get all available properties, send an empty exclude properties
PageNumberMandatoryNumber of pages returned – Valid page number is 1 to N
PageSizeMandatoryPage size is the number of items returned per page. Any positive number can be specified. Maximum allowed number is 5000, any specified value above 5000 will be reset to maximum value

Example of request and response to reconciliation report

Request

curl -X 'GET'\
'https://www.bankingcircleconnect.com/api/v1/reports/reconciliation-report?FromTransactionDate=2021-11-01&ToTransactionDate=2021-11-02'\
-H 'accept: application/json'

Response

{
  "reconciliations": [
    {
      "pIdChannelUser": "xxx@bankingcircle.com",
      "pTxnDate": "2021-10-15T00:00:00+00:00",
      "reportDate": "2021-11-01T00:00:00+00:00",
      "customerId": "999999999",
      "account": "LU000010000011110100",
      "accountCurrency": "EUR",
      "debitAmount": 8,
      "creditAmount": null,
      "valueDate": "2021-10-15T00:00:00+00:00",
      "instructedAmount": 8,
      "instructedAmountCurrency": "EUR",
      "transactionAmount": 8,
      "transactionAmountCurrency": "EUR",
      "exchangeRate": 1,
      "debtorBankCode": "SXPYDKKKXXX",
      "debtorAccount": "LU000010000011110100",
      "debtorLine1": "Hello Limited",
      "debtorLine2": "Test street 1",
      "debtorLine3": "Test town 2",
      "debtorLine4": "GB-London 567890",
      "beneficiaryBankCode": "SXPYDKKKXXX",
      "beneficiaryAccount": "DK0111000011111111",
      "beneficiaryLine1": "Test creditor name",
      "beneficiaryLine2": "Streetname 40",
      "beneficiaryLine3": "DK-8000 Aarhus C Daenemark",
      "beneficiaryLine4": "Address line 3",
      "paymentReferenceNumber": "010F101010110001",
      "fileReferenceNumber": "7495c92b-37e9-448d-a604-360d7ecc7c4b",
      "userReferenceNumber": "99999999PHX",
      "paymentDetails1": "DE iban DK debit",
      "paymentDetails2": "",
      "paymentDetails3": "",
      "paymentDetails4": "",
      "creditDebitIndicator": "DBIT",
      "bankTrnsCodeDomain": "PMNT",
      "bankTrnsCodeFamily": "ICDT"
    }
  ]
}

Rejection Report

The rejection report endpoint provides details of any payment that could not be processed on the selected transaction date. By default, the report contains any payments in the following status:

  • Missing funding
  • Pending processing
  • Rejected

If all payments have been correctly processed, the report will be empty.

Payments in status 'missing funding' will be included in the report for 5 days, after which unless the balance of the account is funded for the amount required to process the payment, they will be sent to rejections.

The rejection report is available in CSV and JSON format.

Parameters in rejection report request

ParameterRequiredDescription
TransactionDateMandatoryFormat: ISO 8601 | YYYY-MM-DD. Specify for which transaction date the report should be generated for.
IncludeReceivedOptionalBoolean, include/exclude payment with status “pending processing”. If left blank field will default to true.
IncludeMissingFundsOptionalBoolean, include/exclude payment with status “missing funding”. If left blank field will default to true.

Properties of rejection report

NameTypeExampleDescription
P_ID_CHANNELUSERVarcharNAMESURNAME@bankingcircle.comUser ID of the requesting client
P_TXNDATEDate (YYYY-MM-DD; MM/dd/yyyy HH:mm:ss.fff)2021-10-27T00:00:00.000+00:00Transaction date of payment
REPORT_DATEDate (DDMMYYYY)29102021Date of when the report is generated
CUSTOMERIDNumber1234Customer ID of the account
ACCOUNTText (35)DKXXXX0000000XXXXXIBAN of your account
ACCOUNT_CURRENCYText (3)EURCurrency of your account (in ISO standards)
VALUE_DATEDate mm/dd/yy3/25/19Value date of the payment in the original instruction to Banking Circle
PAYMENT_AMOUNTNumeric Decimals 211.09Amount of payment in account currency
PAYMENT_CURRENCYText (3)EURCurrency of the amount as indicated in the payment instruction, ISO Standards. Example: request to transfer 100 EUR to USD, this value will be EUR
TRANSFER_CURRENCYText (3)USDCurrency of equivalent amount ( if FX is applied). ISO standards Example: request to transfer 100 EUR to USD, this value will be USD
DESTINATION_IBANText (35)DKXXXX0000000XXXXXIBAN of beneficiary account
PAYMENT_REFERENCE_ NUMBERVarchar010F10xxxx001007Banking Circle reference number, unique identifier for processed transactions
USER_REFERENCE_NUMBERa-Za-Z0-9/-?:.+Debtor referenceProvides the reference number of each payment record as stated in payment instruction by the debtor (DebtorReference). In case of internal transfers between banking circle accounts, this field would be blank.
FILE_REFERENCE_NUMBER36 CHAR a-Za-Z0-9/-?:.+923578e7-7a58-4982-93f1-5862e687611dBulk id of instructed payment file, only populated for bulk payments
SOURCE_TYPETextBULKBULK: for payments initiated via bulk SINGLE: for payments initiated as single payments
STATUSTextRejectedRejected= Rejected Pending Processing= Blank Missing funding=Insufficient Funds. For error= error text
STATUS_REASONTextRequested execution date outside limitsDescriptive reason of why the payment cannot be processed.

Example of request and response for rejection report

Request

curl -X 'GET'\
'https://www.bankingcircleconnect.com/api/v1/reports/rejection-report?TransactionDate=2021-11-01&IncludeReceived=false&IncludeMissingFunds=true'\
-H 'accept: application/json'

Response

{
  "rejections": [
    {
      "pIdChanneluser": "APITestuser@bankingcircle.com",
      "pTxndate": "2021-10-30T00:00:00+00:00",
      "reportDate": "2021-11-01T00:00:00+00:00",
      "customerId": "999999999",
      "account": "LU111010000011110100",
      "accountCurrency": "EUR",
      "valueDate": "2021-10-30T00:00:00+00:00",
      "paymentAmount": 1,
      "paymentCurrency": "EUR",
      "transferCurrency": "EUR",
      "destinationIban": "DK7789000000000114",
      "paymentReferenceNumber": "",
      "userReferenceNumber": "",
      "fileReferenceNumber": "10c56a13-83a0-4a11-af61-625de2f64420",
      "sourceType": "BULK",
      "status": "Rejected",
      "statusReason": "Requested Execution Date exceeds allowed number of days in the past."
    }
  ]
}

Account activity report

The account activity report endpoint contains details regarding all activity on the account, within a selected date range.

It is available in CSV and JSON formats. There is currently a limitation of 50,000 payments per report in this version. If you need a report for more than 50,000 payments on your account, a paginated endpoint is available.

Parameters in account activity report request

ParameterRequiredDescription
FromTransactionDateMandatoryFormat: ISO 8601 | YYYY-MM-DD. Specify from which transaction date the report should be generated.
ToTransactionDateMandatoryFormat: ISO 8601 | YYYY-MM-DD. Specify until which transaction date the report should be generated.
IncludePropertiesOptionalSpecifies properties to include in the reconciliation report results. By default all properties are included. See below table for all properties.
ExcludePropertiesOptionalSpecifies properties to exclude from the reconciliation report results. By default we will include all properties. To get all available properties, send an empty exclude properties.
IncludeVIBANOptionalBy requesting this additional property on CSV,PDF format report returns an additional column with the VIBAN (DK representation) used in the instruction.

Properties of the account activity report

NameTypeExampleDescription
Transaction DateDate mm/dd/yy3/25/19What date was the transaction made
Value DateDate mm/dd/yy3/25/19Value date of the transaction
CreditDecimal (22,2)100.00The credit amount
DebitDecimal (22,2)3,728.58The debit amount
BalanceDecimal (22,2)366,993.58Running account balance including current transaction
Reference NumberText (16)010F30xx90840001Banking Circle reference number, unique identifier for processed transactions
DescriptionText (16)Incoming PaymentType of transaction ( Incoming, Outgoing, Own Payment)
Payment DetailsText (150)Information for beneficiaryLine 1 of payment details ( Remitter information line 1). Reference is propagated to beneficiary.
Beneficiary/Remitter 1Text (35)IBANCounterparty account IBAN
Beneficiary/Remitter 2Text (35)Loaners IncCounter party name
VIBAN* optional columnText (35)DK VIBANDK representation of VIBAN used in the transaction. If no VIBAN is used, blank

The account activity paged report will further include the below properties:

NameTypeExampleDescription
Customer NameText (105)Banking Circle The client name associated with the account(s)
Account NumberText (18)DKXXX000000012345The account number holding the transactions displayed
Account CurrencyText (3)USDCurrency of the account
Report DateDateApr 9, 2019The date the report was generated

The account activity report is available as MT940, following SWIFT reporting standards:

{1:F01A1111111111}{2:O940XXXXXXXXXXXXN}{3:{108:XXXXXXXXX}}{4: Header

:25: Account id (IBAN)

:28C: Statement number, unique for each statement

:60F: Opening balance: C/DYYMMDDCCYAMOUNT

:61: Transaction: VD, TD, D/C ,AMOUNT ,TYPE ,Banking circle unique reference

:86: Transaction Information: counterpart name, counterparty address, counterparty account, remitter information line 1,2,3,4

:62F: Closing balance: C/DYYMMDDCCYAMOUNT

Parameters in paginated account activity report request

The account activity report is available in a paginated version for all 4 formats, to allow a larger number of rows to be included in the report. Content of the file remains unchanged and above specification can be used. The additional parameters for the paginated report are as below:

ParameterRequiredDescription
PageNumberMandatoryNumber of pages returned. Allowed numbers are 1 to N.
PageSizeMandatoryNumber of items returned per page. Any positive number can be specified. Maximum allowed number is 5000, any specified value above 5000 will be reset to maximum value.

Example of request and response for account activity report

Request

curl -X 'GET'\
'https://www.bankingcircleconnect.com/api/v1/reports/account-activity-report?AccountId=d2404f75-e011-4683-9d2d-efd30943c6b8&FromTransactionDate=2021-11-25&ToTransactionDate=2021-11-25'\
-H 'accept: application/json'

Response

{
  "activities": [
    {
      "transactionDate": "2021-11-25T00:00:00+00:00",
      "valueDate": "2021-11-25T00:00:00+00:00",
      "credit": null,
      "debit": 4.23,
      "balance": -155.44,
      "referenceNumber": "010F210213290002",
      "description": "Outgoing Payment",
      "paymentDetails": "RemiInfoLine RemiInfoLine RemiInfoLine",
      "beneficiaryRemitter1": "DK100000000011000",
      "beneficiaryRemitter2": "CreditorName"
    }
  ],
  "auxiliaryInformation": {
    "CustomerName": "Hello Limited",
    "AccountNumber": "DK0110001110000111",
    "AccountCurrency": "GBP",
    "ReportDate": "2021-11-25",
    "AccountType": null
  }
}

Account balance report

The account balance report endpoint returns a report detailing all of your account balances at the exact time the report is requested.

Parameters in account balance report request

The request does not use any parameters.

Properties of account balance report

NameTypeExampleDescription
P_ID_CHANNELUSERVarcharNAMESURNAME@bankingcircle.comUser ID of the requesting client
P_TXNDATEDate (YYYY-MM-DD; MM/dd/yyyy HH:mm:ss.fff)2021-10-27T00:00:00.000+00:00Date for reported balance
REPORT_DATEDate (DDMMYYYY)29102021Date of when the report is generated, and therefore for which balances are being provided.
CUSTOMERIDNumber1234Customer ID of the account
ACCOUNTText (35)DKXXXX0000000XXXXXIBAN of your account
ACCOUNT_CURRENCYText (3)EURCurrency of your account (in ISO standards)
CURBALANCEDecimal(22,2)757116.24Current balance of your account. Balance includes all booked transaction with transaction date<= report date. It includes un-cleared funds received for future value date.
AVLBALANCEDecimal (22,2)759967.67Available balance on your account. Balance includes all booked transaction with value date <= report date. It does not include un-cleared funds with future value date

Example of request and response for account balance report

Request

curl -X 'GET'\
'https://www.bankingcircleconnect.com/api/v1/reports/account-balance-report'\
-H 'accept: application/json'

Response

{
  "accountBalances": [
    {
      "account": "DE01001100000000010111",
      "balance": 48432.88,
      "currency": "EUR",
      "channelUserId": "xxx@bankingcircle.com",
      "transactionDate": "2022-01-27T10:46:17.937",
      "reportDate": "2022-01-27T00:00:00+00:00",
      "customerId": "999999999",
      "availableBalance": -338.4
    }
  ]
}