Deposit

List all deposits for product

1 credit per API call.


Lists all deposits for API key.

SecurityX-API-Key
Request
query Parameters
pageSize
number [ 1 .. 50 ]

Max number of items per page is 50.

Example: pageSize=20
page
number

Page number

Example: page=0
sort
string

Direction of sorting. Can be asc or desc

Enum: "asc" "desc"
Example: sort=asc
status
string

Status of the deposit

Enum: "Done" "InProgress"
Example: status=Done
currency
string

Filter by currency

Example: currency=BTC
txId
string [ 10 .. 80 ] characters

Filter by txId

Example: txId=2.0589336591536965e+76
to
string

Filter by to address

Example: to=9.557027372635822e+47
accountId
string

Filter by account id

Example: accountId=628bae6095e9ad06b52eb229
Responses
200

OK

400

Bad Request. Validation failed for the given object in the HTTP Body or Request parameters.

401

Unauthorized. Not valid or inactive subscription key present in the HTTP Header.

500

Internal server error. There was an error on the server while processing the request.

get/v3/ledger/deposits
Request samples
curl -i -X GET \
  'https://api-eu1.tatum.io/v3/ledger/deposits?pageSize=20&page=0&sort=asc&status=Done&currency=BTC&txId=2.0589336591536965e%2B76&to=9.557027372635822e%2B47&accountId=628bae6095e9ad06b52eb229' \
  -H 'x-api-key: YOUR_API_KEY_HERE'
Response samples
application/json
[
  • {
    }
]

Count of found entities for get deposits request

1 credit per API call.


Counts total entities found by get deposits request.

SecurityX-API-Key
Request
query Parameters
pageSize
number [ 1 .. 50 ]

Max number of items per page is 50.

Example: pageSize=20
page
number

Page number

Example: page=0
sort
string

Direction of sorting. Can be asc or desc

Enum: "asc" "desc"
Example: sort=asc
status
string

Type of the deposit

Enum: "Done" "InProgress"
Example: status=Done
currency
string

Filter by currency

Example: currency=BTC
txId
string [ 10 .. 80 ] characters

Filter by txId

Example: txId=2.0589336591536965e+76
to
string

Filter by to address

Example: to=9.557027372635822e+47
accountId
string

Filter by account id

Example: accountId=628bae6095e9ad06b52eb229
Responses
200

OK

400

Bad Request. Validation failed for the given object in the HTTP Body or Request parameters.

401

Unauthorized. Not valid or inactive subscription key present in the HTTP Header.

500

Internal server error. There was an error on the server while processing the request.

get/v3/ledger/deposits/count
Request samples
curl -i -X GET \
  'https://api-eu1.tatum.io/v3/ledger/deposits/count?pageSize=20&page=0&sort=asc&status=Done&currency=BTC&txId=2.0589336591536965e%2B76&to=9.557027372635822e%2B47&accountId=628bae6095e9ad06b52eb229' \
  -H 'x-api-key: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "total": 20
}