Reconciliation report

post

https://www.bankingcircleconnect.com/api/v2/reports/requests/reconciliation-report

Body Params

Contains parameters for the requested report

reportFormatType

string

required

length ≥ 1

Format type the report should be generated as

Available options:

csv
json

fromTransactionDate

date-time

required

Minimum transaction date

FromTransactionDate and ToTransactionDate form a date range

Criteria: Reconciliation.ReportDate must be equal or later

Format: ISO 8601 | YYYY-MM-DD

toTransactionDate

date-time

required

Maximum transaction date

FromTransactionDate and ToTransactionDate form a date range

Criteria: Reconciliation.ReportDate must be equal or earlier

Format: ISO 8601 | YYYY-MM-DD

includeProperties

array of strings | null

Properties of Reconciliation object to include in result

If IncludeProperties is set, ExcludeProperties need not be set

If neither IncludeProperties nor ExcludeProperties are specified, default value will be IncludeProperties =

	PIdChannelUser

	PTxnDate

	ReportDate

	CustomerId

	Account

	AccountCurrency

	DebitAmount

	CreditAmount

	ValueDate

	InstructedAmount

	InstructedAmountCurrency

	TransactionAmount

	TransactionAmountCurrency

	ExchangeRate

	DebtorBankCode

	DebtorAccount

	DebtorLine1

	DebtorLine2

	DebtorLine3

	DebtorLine4

	BeneficiaryBankCode

	BeneficiaryAccount

	BeneficiaryLine1

	BeneficiaryLine2

	BeneficiaryLine3

	BeneficiaryLine4

	PaymentReferenceNumber

	FileReferenceNumber

	UserReferenceNumber

	PaymentDetails1

	PaymentDetails2

	PaymentDetails3

	PaymentDetails4

	CreditDebitIndicator

	BankTrnsCodeDomain

	BankTrnsCodeFamily

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

 PaymentId

 LastChangedTimestamp

 BankTrnsCodeSubFamily

	CreatedAt

 DebtorAgentBankCode

	UltimateDebtorLine1

	UltimateDebtorLine2

	UltimateDebtorLine3

	UltimateDebtorLine4

	UltimateDebtorAccount

	UltimateBeneficiaryAccount

	StatusReasonCode

	StatusReasonDescription

    AdditionalRemittanceInformation1

    AdditionalRemittanceInformation2

    AdditionalRemittanceInformation3

    AdditionalRemittanceInformation4

    AdditionalRemittanceInformation5

    InstructedChargeBearer

    ChargeBearer

    PaymentRail

    Return

    DirectDebitMandateId

    LatestStatusChangedTimestamp

    ProcessedTimestamp

    ClientOrderId

Format: comma (,) separated string

includeProperties

excludeProperties

array of strings | null

Properties of Reconciliation 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

accountIds

array of uuids | null

List of account Ids

Criteria: Exact match on the Id of the account

accountIds

reportVersion

int32

enum

Allowed:

name

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

202Accepted Returned when the request is found and report generation is in progress. See details in headers

400Bad request Invalid request parameter or header

404Not Found ReportRequest id not found