HIhifi
Orchestration Address

Retrieve a deposit

Fetch a single deposit by ID. Returns 404 RESOURCE_NOT_FOUND if the deposit doesn't exist, doesn't belong to the named orchestration address, or the orchestration address doesn't belong to the named user.

get/v2/users/{userId}/orchestration-addresses/{orchestrationAddressId}/deposits/{depositId}

Request

  • Base URL
    https://production.hifibridge.com
  • URL
    https://production.hifibridge.com/v2/users/{userId}/orchestration-addresses/{orchestrationAddressId}/deposits/{depositId}
  • Auth
    HTTP bearer

Path parameters

userIdstring required

ID of the user

orchestrationAddressIdstring uuid required

ID of the orchestration address.

depositIdstring 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.

idstring uuid

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

orchestrationAddressIdstring uuid
batchIdstring uuid nullable

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

amountstring

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

currency'usdc' | 'usdt'
chainstring

Abbreviated chain name (e.g. BASE).

sourceAddressstring

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

transactionHashstring

On-chain transaction hash.

status'PENDING' | 'BATCHED' | 'IGNORED' | 'REFUNDED'

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.
ignoredReason'ADDRESS_DEACTIVATED' | 'UNSUPPORTED_TOKEN'

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).
createdAtstring date-time
updatedAtstring date-time

Changes

No recorded changes to this operation across all 2 revisions of this API.