Skip to main content
GET
/
v2
/
users
/
{userId}
/
orchestration-addresses
/
{orchestrationAddressId}
/
deposits
/
{depositId}
Retrieve a deposit
curl --request GET \
  --url https://production.hifibridge.com/v2/users/{userId}/orchestration-addresses/{orchestrationAddressId}/deposits/{depositId} \
  --header 'Authorization: Bearer <token>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "orchestrationAddressId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "batchId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "amount": "<string>",
  "chain": "<string>",
  "sourceAddress": "<string>",
  "transactionHash": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
userId
string
required

ID of the user

​
orchestrationAddressId
string<uuid>
required

ID of the orchestration address.

​
depositId
string<uuid>
required

ID of the orchestration deposit. Deterministically derived from the provider's deposit reference and escrow wallet ID, so the same on-chain deposit always maps to the same depositId across webhook re-deliveries.

Response

A single deposit record.

A single on-chain deposit detected for an orchestration address.

​
id
string<uuid>

Deterministic UUID derived from (providerReferenceId, escrowWalletId). Stable across webhook re-deliveries.

​
orchestrationAddressId
string<uuid>
​
batchId
string<uuid> | null

ID of the batch that included this deposit. null while status=PENDING or status=IGNORED.

​
amount
string

Decimal amount of the source token deposited (e.g. "100.500000"). Precision matches the token's on-chain decimals.

​
currency
enum<string>
Available options:
usdc,
usdt
​
chain
string

Abbreviated chain name (e.g. BASE).

​
sourceAddress
string

On-chain address that sent the deposit. Informational only.

​
transactionHash
string

On-chain transaction hash.

​
status
enum<string>

Per-deposit status.

  • PENDING — recorded, waiting to be rolled into a batch.
  • BATCHED — included in a batch (batchId is set).
  • IGNORED — recorded but never batched. See ignoredReason for why.
  • REFUNDED — was PENDING when the address was deactivated; the funds were refunded in-kind to the walletAddress supplied at deactivation.
Available options:
PENDING,
BATCHED,
IGNORED,
REFUNDED
​
ignoredReason
enum<string> | null

Why a deposit was ignored. Funds remain in the escrow wallet — a Slack alert fires for manual ops follow-up.

  • ADDRESS_DEACTIVATED — the deposit arrived after the address was deactivated.
  • UNSUPPORTED_TOKEN — the deposited token does not match the address's configured source.currency (e.g. USDT sent to a USDC-only address).
Available options:
ADDRESS_DEACTIVATED,
UNSUPPORTED_TOKEN
​
createdAt
string<date-time>
​
updatedAt
string<date-time>