Skip to main content
GET
List bank deposits

Authorizations

Authorization
string
header
required

Marketplace API key

Headers

X-Organization-Id
string
required

Target clinic organization ID

Query Parameters

includePending
boolean
default:false

Include deposits the bank still reports as pending. Defaults to false. A pending deposit is replaced by a NEW row when it posts: the pending row turns superseded and names the posted row in supersededBy.

bankAccountId
string

Only deposits into this bank account (bka_…). An account outside your organization is a 404.

Example:

"bka_5f1c0000000040000000000000000001"

updatedSince
string

Only deposits whose record changed at/after this instant (ISO 8601 with an explicit UTC offset). Results are always ordered by updatedAt (millisecond) then id. A deposit changes when it posts, is excluded, gains or loses an ERA link, or an app match is recorded or revoked on it. Walk with cursorId; boundary rows re-deliver, so dedupe on id. Overlap your stored cursor by a few minutes: a change is stamped when its transaction starts and becomes visible when it commits.

Example:

"2026-10-18T00:00:00.000Z"

updatedUntil
string

Only deposits whose record changed at/before this instant. Pin it to freeze a walk's window.

Example:

"2026-10-19T00:00:00.000Z"

cursorId
string

Id of the last deposit you consumed (btx_…), for a keyset walk: pass it with updatedSince set to that row's updatedAt and always request page 1. pagination.totalCount then counts from the cursor's millisecond and shrinks as you walk; stop on a short page.

Example:

"btx_5f1c0000000040000000000000000001"

Response

Success

code
string
required

Response code

Example:

"success"

data
object
required