Get a list of balance records for a bank account

Returns a paginated list of deposit and withdrawal balance records for the given bank account, most recent first.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Public id of the bank account whose balance records are returned.

Query Params
string

Zero-based index of the page to return.

string

Return only records whose destination bank account matches this bank account id.

string

Free-text search across record id, description, reference, bank transaction id, transaction id, source and destination account id and account number, currency, and distributor company name.

string

Number of items returned per page. No maximum is enforced. Values below 1 are rejected.

string

Filter by record type. Case-sensitive: send uppercase. Omit to return both types.

string

Sort direction.

string

Attribute to sort by. Sort keys are the underlying field names and differ from some response field names: use dateCreated (not createdAt), dateUpdated (not updatedAt), publicId (not id), holdUntilTimestamp (not holdUntilDate) and isAdjustment (not adjustment). Records with equal sort values have no defined secondary order, so page on dateCreated when stable paging matters.

string

Return only records whose source bank account matches this bank account id.

Headers
string
required

Bearer JWT obtained from POST /mfa/login. Send as "Bearer ". Expires after 5 minutes.

Responses

400

Invalid input. Returned when a query parameter cannot be parsed, for example a type other than DEPOSIT or WITHDRAWAL, a non-numeric limit or index, or a direction other than ASC or DESC.

401

Unauthorized

403

Forbidden

404

Not found

500

Internal server error

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json