Skip to main content
GET
List check deposits

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

status
enum<string>

Only deposits in this state.

Available options:
PROCESSING,
DEPOSITED,
RETURNED,
REJECTED
unappliedOnly
boolean

When true, only deposits with money left to apply (unappliedAmountCents above zero).

accountId
string

Only deposits into this account (an id from List Nickel Banking accounts).

limit
integer

Maximum deposits to return, newest first. Default 20, maximum 100; larger values are clamped to 100.

Required range: x >= 1
Example:

20

Response

Successful operation

checkDeposits
object[]
hasMore
boolean

True when more deposits matched than limit allowed.