Get bookings of an account

get

https://www.bankingcircleconnect.com/api/v3/bookings

You can match a booking with a payment by using either the bookingReference (corresponding to transactionReference in the Payments API) or the transactionId (corresponding to PaymentId in the Payments API).

Property balancein the response will be null, when the requests has optional filters applied (with the exception of dateTo)

Bookings for Interests and Sweeps included in response, defined in the property transactionType

Query Params

accountId

uuid

required

Account identifier | Account.accountId

DateFrom

date-time

required

Minimum transaction date of bookings

DateFrom and DateTo form a date range

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

Criteria: AccountBooking.TransactionDate must be equal or later

Format: ISO 8601 | YYYY-MM-DD

DateTo

string

Maximum transaction date of bookings

DateFrom and DateTo form a date range

Format: ISO 8601 | YYYY-MM-DD

PartialDetails

string

Filter on bookings that contain the entered information in the remittance field.

Criteria: AccountBooking.Details contains 'PartialDetails' - Case insensitive

PartialCounterparty

string

Filter on bookings where the name of the counterparty contains the entered information.

Criteria: AccountBooking.Details contains 'PartialDetails' - Case insensitive

CounterpartyAccount

string

Filter on bookings where counterparty account matches the specified account no.

Criteria: Exact match of AccountBooking.CounterpartyAccount.Account

AmountFrom

string

Minimum amount value of bookings

AmountFrom and AmountTo form a amount value range

Criteria: AccountBooking.Amount.Amount must be equal or larger

AmountTo

string

Maximum amount value of bookings

AmountFrom and AmountTo form a amount value range

Criteria: AccountBooking.Amount.Amount must be equal or smaller

PageNumber

int32

1 to 2147483647

Defaults to 1

Number of the numbered pages of the result set

PageNumber and PageSize details the pagination information

Condition: Larger than zero

Default: 1

PageSize

int32

1 to 5000

Defaults to 50

Size of the page of the result set

PageNumber and PageSize details the pagination information

Condition: Between 1 and 5000

Default: 50

Responses

200OK

400Bad request. Request is not correctly formulated. Goes for both Header, Query and Body. Verify the error description and properties.

403Forbidden. The server understood the request, but is refusing it or the access is not allowed, i.e. if resource exists but calling user does not have rights to access it.

404Not found. There is no resource behind the URL, i.e. requesting data on an account that does not exist.

500Internal Server Error. Something unexpected happened on BC Connect side.