Money that came in, newest first

GET

/v1/deposits

const url = 'https://api.sotirea.com/v1/deposits';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://api.sotirea.com/v1/deposits \
  --header 'Authorization: Bearer <token>'

A deposit is “arriving” from the moment it is seen on the network and “received” once final, when it is added to the vault’s available balance. One with sweep true is one of your sweeps moving your own money into one of your vaults, not somebody paying you: do not credit a customer for it.

Authorizations

bearer

Parameters

Query Parameters

vault

integer

Only this vault’s.

page

integer

Which page, from 1.

page_size

integer

How many per page, at most 100. 25 when not given.

Responses

200

Done.

application/json

object

data

required

Array<object>

object

amount

required

In the asset’s smallest unit.

string

asset

required

string

chain_id

required

string

chain_name

required

string

credited_at

required

Any of:

string
null

string format: date-time

decimals

required

Any of:

integer
null

integer

from

required

string

held

required

Whether it is held for a compliance review: credited, but counted only in available, not spendable, until Sotirea releases it. Sotirea will contact you.

boolean

required

integer

paused

required

The network or asset is not available right now. The deposit is still credited.

boolean

recognised

required

True for the network’s coin and for tokens on Sotirea’s recognised list. Any other token’s symbol is whatever its contract calls itself, so do not trust it by name.

boolean

seen_at

required

string format: date-time

state

required

Arriving until the network has made it final, then received.

string

sweep

required

Whether one of your sweep rules moved it here from another of your vaults, rather than somebody paying you. Do not credit a customer for it.

boolean

symbol

required

string

required

string

tx_hash

required

string

vault_id

required

Any of:

integer
null

integer

vault_name

required

Any of:

string
null

string

vault_reference

required

Any of:

string
null

string

meta

object

page

object

has_next

boolean

page

integer

page_size

integer

total

integer

total_pages

integer

request_id

Quote it when asking about a request; it is in the X-Request-Id header too.

string

success

required

Example

{
  "success": true
}

default

Refused or failed, in words a person can act on.

application/json

object

error

required

object

code

required

string

fields

object

key

additional properties

string

message

required

string

meta

object

request_id

Quote it when asking about a request.

string

success

required

Example

{
  "success": false
}