Skip to main content
GET
Get a virtual account statement

Authorizations

x-api-key
string
header
required

Path Parameters

customerId
string
required
Example:

"cus_1A2b3C4d5E6f7G8h9I0jKl"

virtualAccountId
string
required
Example:

"vac_1A2b3C4d5E6f7G8h9I0jKl"

Query Parameters

from
string
required

The first UTC day the statement covers, as YYYY-MM-DD. The day is included.

to
string
required

The last UTC day the statement covers, as YYYY-MM-DD. The day is included and must be fully in the past. The period holds at most 92 days.

cursor
string

Opaque cursor from a previous response to fetch the next page

Response

What an account held at the start and the end of a period, and every entry between.

account
object
required

The account the statement covers.

asset
object
required
period
object
required

The UTC days the statement covers. Both days are included.

opening
object
required

What the account held at the start of the first day.

closing
object
required

What the account held at the end of the last day.

lines
object[]
required

One page of entries, oldest first. opening and closing cover the whole period on every page.

meta
object
required