Get deposit details by id [Private]

Returns information about the deposit by its id.


To call any private endpoint, headers should include authorization key(s).

You may use a single API key or a public-private key pair based on your current tasks. Here you may find typical Header configurations for both options.

Method name:/v4/deposit/private/details/{depositId}
Request type:GET

Data dictionary

NameTypeParameter typeRequiredRangeDescription
depositIdstringQUERYYES-Deposit ID.

You can get depositId via "Get deposit history" endpoint.

Only for Merchant accounts! We return the depositId via callbackUrl when using the "Generate a temporary crypto address for deposit" endpoint.

Exemplary request

const apiKey = "YOUR_API_KEY"; // put here your Api key

const url = "";
const path = "/v4/deposit/private/details/a201cb3c-5830-57ac-ad2c-f6a588dd55eb";
const options = {
  method: "GET",
  headers: {
    accept: "application/json",
    "Content-Type": "application/json",
    "api-key": apiKey,

fetch(url + path, options)
    .then((response) => response.json())
    .then((showResponse) => console.log(;
import requests

api_key = "YOUR_API_KEY"  # put here your Api key

url = ""
path = "/v4/deposit/private/details/a201cb3c-5830-57ac-ad2c-f6a588dd55eb"
headers = {
    "accept": "application/json",
    "Content-Type": "application/json",
    "api-key": api_key,

request = requests.get(url + path, headers=headers)

How to call private endpoints here

Swagger here


      "id": "a201cb3c-5830-57ac-ad2c-f6a588dd55eb",                               // Unique ID of deposit
      "amount": "9.9",                                                            // Amount credited to your account
      "asset": "USDT",                                                            // Deposit currency
      "merchantId": "16214228-5c0c-5abc-be6a-c90259b21d4e",                       // Internal ID (not for use)
      "paymentCode": "TRX",                                                       // Blockchain name
      "status": "Processed",                                                      // Transactions status
      "type": "Deposit",                                                          // Transaction type
      "reason": [],                                                               // Reason for manual transaction processing
      "address": "TNeBQz8RyGGiAYAR7r8G6QGxtTWDkpH4dV",                            // Deposit address
      "memo": "",                                                                 // Deposit memo
      "txId": "8a0b0c5a2ac5679879b71b2fa63b0a5c39f90bc8ff6c41e708906b398ac3d4ef", // Deposit transaction hash
      "fee": "0.1",                                                               // Deposit fee
      "processedAmount": "10",                                                    // Amount of deposit
      "createdAt": "2023-06-13T12:55:01.256Z",                                    // Deposit receipt date
      "updatedAt": "2023-06-13T12:55:01.696Z"                                     // Deposit credit date