Skip to main content
GET
List all deposits

Authorizations

Authorization
string
header
required

The data.access_token value from Get access token.

Headers

X-Api-Version
string

Version applied to this request. It wins over your account's pinned version — see Versioning.

Example:

"2026-06-01"

Query Parameters

page
integer
default:1

Which page to return, counting from 1. This feed pages by number, not by offset.

Required range: x >= 1
limit
integer
default:10

How many deposits to return. Between 1 and 100, and 10 when you omit it.

A value outside that range is rejected with a 400.

Required range: 1 <= x <= 100
status
string

Filter by deposit status.

Available options: PENDING, COMPLETED, FAILED, REFUNDED, KYT_PENDING, KYT_REJECTED. See Virtual account values for what each one means.

virtual_account_id
string<uuid>

Return only the deposits into this one account.

from_date
string

Return only deposits from this moment on, included. Send a full ISO 8601 timestamp or just a date as YYYY-MM-DD.

to_date
string

Return only deposits up to this moment, included. Send a full ISO 8601 timestamp or just a date as YYYY-MM-DD, which covers that whole day.

Return only the deposit whose ID or tracking reference is this one: the IMAD of a wire, the trace number of an ACH transfer, or the bank's reference number, matched whole and whatever its case. Up to 255 characters.

Maximum string length: 255
amount
string

Return only the deposits of this amount, compared as a number: 26.41 finds a deposit of 26.41000000. A plain decimal such as 26.41, with no thousands separator. Greater than zero.

Pattern: ^(?!0+(\.0+)?$)\d{1,18}(\.\d{1,8})?$
Example:

"26.41"

Response

Success.

deposits
object[]
total
integer

Total number of deposits matching the filters.

page
integer

The page returned.

limit
integer

The limit applied to this page.

total_pages
integer

How many pages the filters produce at this limit.