RHrhinestonewtf
Utilities

Get a deposit

Changed on

Returns a deposit for the authenticated project.

get/deposits/{id}

Request

Path parameters

idstring required

Deposit id. Returned by GET /deposits.

Example:12345

Headers

x-api-keystring

API key for authentication

Example:your-api-key

Response

The deposit

idstring required

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

chainstring required
txHashstring required
tokenstring required
tokenSymbolstring nullable required

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

tokenDecimalsinteger nullable 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.

targetTokenSymbolstring nullable required

Display symbol for targetToken. Null when unresolved.

targetTokenDecimalsinteger nullable required

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

amountstring required

Numeric string representing a bigint value

senderstring required
recipientstring 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.

depositAddressstring required

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

targetChainstring required
targetTokenstring required
status'pending' | 'processing' | 'completed' | 'failed' | 'rejected' | 'ignored' | 'expecting_refund' | 'refunded' | 'delayed' | 'reconciliation_required' required
sourceTxHashstring nullable required
destinationTxHashstring nullable required
sourceAmountstring nullable required

Numeric string representing a bigint value

destinationAmountstring nullable required

Numeric string representing a bigint value

sponsoredGasUsdstring

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

sponsoredBridgeFeeUsdstring

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.

createdAtstring required
completedAtstring nullable required
errorCodestring nullable required
creditKind'deposit' | 'collector_return' required
retryableboolean required
isSpamboolean required

Example response

{
  "id": "12345",
  "tokenSymbol": "USDC",
  "tokenDecimals": 6,
  "targetTokenSymbol": "USDC",
  "targetTokenDecimals": 6,
  "amount": "1000000000000000000",
  "sourceAmount": "1000000000000000000",
  "destinationAmount": "1000000000000000000",
  "sponsoredGasUsd": "0.42",
  "sponsoredBridgeFeeUsd": "0.13",
  "timing": {
    "expectedSeconds": 42,
    "softDelaySeconds": 90,
    "escalatedDelaySeconds": 300
  }
}

Changes

  • aa1767d704faRevision changes
    • info

      the endpoint scheme security internalProjectBearer was added to the API

    • info

      the endpoint scheme security tenantApiKey was added to the API

    • info

      the header request parameter x-api-key became optional

    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the required property to the response with the status

  • 676300ac19ffRevision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status