Skip to main content
GET
Retrieve a virtual account

Authorizations

Authorization
string
header
required

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

Path Parameters

userId
string
required

ID of the user

accountId
string
required

ID of the virtual account

Query Parameters

limit
string

Number of micro deposit records return for the virtual account, default to 10 maximum to 100

createdBefore
string

Return the micro deposit records that created before this eventId

createdAfter
string

Return the micro deposit records that created after this eventId

Response

Success

id
string<uuid>
createdAt
string<date-time>
updatedAt
string<date-time>
userId
string<uuid>
source
object
destination
object
status
enum<string>
Available options:
activated,
deactivated
maxBps
integer | null

Maximum USDT conversion fee, as a whole number of basis points from 0 through 10,000, allowed for automatic onramps through this virtual account. null means disabled.

Required range: 0 <= x <= 10000
microDeposits
object
depositInstructions
object
settlementRuleId
string<uuid>