For the complete documentation index, see llms.txt. This page is also available as Markdown.

Get a deposit

GET /2.0/deposit/get?id={uuid}

One deposit of yours, by id.

Permission: can_invoice - deposits are the incoming-payment side of the same permission, and there is no separate deposit flag.

Query parameter
Required
Type

id

yes

UUID

Response 200

{
  "id": "{uuid}",
  "status": "success",
  "amount": "50000000000000000000",
  "assetId": "{assetId}",
  "crypto": {
    "id": "{cryptoId}",
    "title": "Binance Pegged USDT",
    "symbol": "USDT",
    "contractAddress": "0x0000000000000000000000000000000000000000",
    "decimals": 18,
    "logoURI": "https://raw.githubusercontent.com/0xsquid/assets/main/images/tokens/usdt.svg"
  },
  "network": {
    "id": "{networkId}",
    "title": "BNB Chain",
    "symbol": "BSC",
    "chainId": "56",
    "networkType": "evm"
  },
  "txHash": "{txHash}",
  "txFrom": "0x0000000000000000000000000000000000000000",
  "fee": {
    "network": null,
    "service": {
      "amount": "1050000000000000000",
      "amountFormatted": "1.05",
      "currency": "USDT",
      "cryptoId": "{cryptoId}",
      "networkId": "{networkId}",
      "amountInUsd": "1.05",
      "isChargedToMerchant": true
    },
    "exchange": null,
    "totalInUsd": "1.05"
  },
  "createdAt": "2026-07-28T10:42:08+00:00"
}

status is one of success, frozen, refunded - a deposit is never in an intermediate state by the time you can read it.

For a deposit created before this release, service.amountInUsd and totalInUsd are null (the USD value was not recorded back then and is never backfilled). service.amount is present.

Codes

Code
When

200

OK

400

id is not a valid UUID, or missing

401

Missing or invalid apiKey

403

The apiKey has no can_invoice permission

404

No such deposit - or it belongs to another merchant. The two are deliberately indistinguishable

429

Rate limit (50 rps)

Last updated