> ## Documentation Index > Fetch the complete documentation index at: https://docs.hifi.com/llms.txt > Use this file to discover all available pages before exploring further. # Retrieve an orchestration deposit > Retrieve a specific deposit received by an orchestration address. ## OpenAPI ````yaml https://production.hifi.com/api/v3/openapi.json get /v3/users/{userId}/orchestration-addresses/{orchestrationAddressId}/deposits/{orchestrationDepositId} openapi: 3.0.0 info: title: Hifi API version: 3.0.0 description: API documentation for HIFI servers: - url: https://production.hifi.com description: Production server - url: https://sandbox.hifi.com description: Sandbox server security: - bearerAuth: [] tags: - name: Common description: Common endpoints - name: User description: User endpoints - name: Counter Party description: Counter party endpoints - name: Crypto Transfer description: Crypto transfer and batch transfer endpoints - name: Wallet description: Wallet and wallet offer endpoints - name: External Account description: External bank account endpoints (under a counter party) - name: External Wallet description: External wallet endpoints (under a counter party) - name: External Card description: External card endpoints (under a counter party) - name: Token Swap description: Token swap endpoints - name: Bridge description: Bridge endpoints - name: Virtual Account description: Virtual account endpoints - name: Compliance description: Compliance and compliance link endpoints - name: Webhook Endpoint description: Webhook endpoint endpoints - name: File description: File upload endpoints - name: Onramp description: Onramp (fiat to crypto) endpoints - name: Offramp description: Offramp (crypto to fiat) endpoints - name: Orchestration Address description: Orchestration (liquidation) address endpoints - name: KYC Link description: Hosted and custom KYC/KYB link endpoints - name: Transfer Approval description: Transfer approval endpoints - name: Corridor description: Supported fiat/crypto transfer corridor endpoints - name: Migration description: v2-to-v3 ID mapping endpoints paths: /v3/users/{userId}/orchestration-addresses/{orchestrationAddressId}/deposits/{orchestrationDepositId}: get: tags: - Orchestration Address summary: Retrieve an orchestration deposit description: Retrieve a specific deposit received by an orchestration address. operationId: v3GetOrchestrationDeposit parameters: - $ref: '#/components/parameters/UserIdPathParameter' - $ref: '#/components/parameters/OrchestrationAddressIdPathParameter' - $ref: '#/components/parameters/OrchestrationDepositIdPathParameter' responses: '200': $ref: '#/components/responses/OrchestrationDepositResponse' '401': $ref: '#/components/responses/UnauthorizedResponse' '404': $ref: '#/components/responses/NotFoundResponse' '500': $ref: '#/components/responses/InternalServerErrorResponse' components: parameters: UserIdPathParameter: name: userId in: path schema: type: string pattern: ^user_[A-Za-z0-9]+$ description: ID of the user. required: true OrchestrationAddressIdPathParameter: name: orchestrationAddressId in: path schema: type: string format: uuid required: true description: ID of the orchestration address. OrchestrationDepositIdPathParameter: name: depositId in: path schema: type: string format: uuid required: true description: > 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. responses: OrchestrationDepositResponse: description: A single deposit record. content: application/json: schema: $ref: '#/components/schemas/OrchestrationDepositObject' UnauthorizedResponse: description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/Unauthorized' NotFoundResponse: description: Not Found content: application/json: schema: $ref: '#/components/schemas/NotFound' InternalServerErrorResponse: description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/InternalServerError' schemas: OrchestrationDepositObject: type: object description: A single on-chain deposit detected for an orchestration address. properties: id: type: string format: uuid description: >- Deterministic UUID derived from `(providerReferenceId, escrowWalletId)`. Stable across webhook re-deliveries. orchestrationAddressId: type: string format: uuid batchId: type: string format: uuid nullable: true description: >- ID of the batch that included this deposit. `null` while `status=PENDING` or `status=IGNORED`. amount: type: string description: | Decimal amount of the source token deposited (e.g. `"100.500000"`). Precision matches the token's on-chain decimals. currency: type: string enum: - usdc - usdt chain: type: string description: Abbreviated chain name (e.g. `BASE`). sourceAddress: type: string description: On-chain address that sent the deposit. Informational only. transactionHash: type: string description: On-chain transaction hash. status: $ref: '#/components/schemas/OrchestrationDepositStatusEnum' ignoredReason: $ref: '#/components/schemas/OrchestrationDepositIgnoredReasonEnum' nullable: true createdAt: type: string format: date-time updatedAt: type: string format: date-time Unauthorized: type: object properties: type: type: string description: Unauthorized enum example: UNAUTHORIZED message: type: string description: Unauthorized message example: Authentication required NotFound: type: object properties: type: type: string example: RESOURCE_NOT_FOUND description: The error type, e.g., RESOURCE_NOT_FOUND message: type: string description: A descriptive error message fields: type: array description: List of specific field errors items: type: object properties: code: type: string description: Error code related to the field issue message: type: string description: Error message for the specific issue field: type: string description: The name of the field that has an issue InternalServerError: type: object properties: type: type: string example: INTERNAL_SERVER_ERROR description: Internal server error enum message: type: string example: An internal server error occurred description: Internal server error message OrchestrationDepositStatusEnum: type: string enum: - PENDING - BATCHED - IGNORED - REFUNDED description: | 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. OrchestrationDepositIgnoredReasonEnum: type: string enum: - ADDRESS_DEACTIVATED - UNSUPPORTED_TOKEN description: | 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). securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: JWT ````