Skip to main content
GET
Get a single deposit by id

Headers

x-api-key
string

API key for authentication (omit when sending Authorization)

Example:

"your-api-key"

authorization
string

Bearer platform token (e.g. forwarded by user-service). Takes precedence over x-api-key when both are present.

Example:

"Bearer eyJhbGciOi..."

Path Parameters

id
string
required

Deposit id. Returned by GET /deposits.

Pattern: ^\d+$
Example:

"12345"

Response

The deposit

id
string
required

Deposit id. Pass to GET /deposits/{id}/quotes.

Example:

"12345"

chain
string
required
txHash
string
required
token
string
required
tokenSymbol
string | null
required

Display symbol for token, resolved at read time. Null when the token could not be resolved — render the raw address.

Example:

"USDC"

tokenDecimals
integer | null
required

Decimals for token, i.e. what makes amount and sourceAmount renderable — both are raw base units. Null when unresolved; render the raw integer rather than guessing 18.

Example:

6

targetTokenSymbol
string | null
required

Display symbol for targetToken. Null when unresolved.

Example:

"USDC"

targetTokenDecimals
integer | null
required

Decimals for targetToken, applying to destinationAmount. Null when unresolved.

Example:

6

amount
string
required

Numeric string representing a bigint value

Pattern: ^\d+$
Example:

"1000000000000000000"

sender
string
required
recipient
string
required

Destination-chain address that receives the funds. Falls back to the smart account for EVM/HyperCore/Tron when no distinct recipient is configured; for Solana it is the EVM recipient, never the internal swig.

depositAddress
string
required

Source-chain address that received the deposit (EVM smart account, Solana wallet PDA, or Tron deposit address).

targetChain
string
required
targetToken
string
required
status
enum<string>
required
Available options:
pending,
processing,
completed,
failed,
rejected,
ignored,
expecting_refund,
refunded,
delayed,
reconciliation_required
sourceTxHash
string | null
required
destinationTxHash
string | null
required
sourceAmount
string | null
required

Numeric string representing a bigint value

Pattern: ^\d+$
Example:

"1000000000000000000"

destinationAmount
string | null
required

Numeric string representing a bigint value

Pattern: ^\d+$
Example:

"1000000000000000000"

createdAt
string
required
completedAt
string | null
required
errorCode
string | null
required
retryable
boolean
required
isSpam
boolean
required
sponsoredGasUsd
string

USD value of gas absorbed for the user. Absent when no sponsorship accounting exists; "0" means nothing was sponsored.

Example:

"0.42"

sponsoredBridgeFeeUsd
string

USD value of the bridge fee absorbed for the user. Excludes app fees and sponsor surcharges. Absent when no accounting exists; "0" means nothing was sponsored.

Example:

"0.13"