> ## 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. # List deposits for an orchestration address > List on-chain deposits detected for the address, most recent first. Filterable by status, batch ID, and a created-at window. ## OpenAPI ````yaml https://production.hifi.com/api/v2/openapi.json get /v2/users/{userId}/orchestration-addresses/{orchestrationAddressId}/deposits openapi: 3.0.0 info: title: Hifi API version: 2.0.0 description: API documentation for Hifi servers: - url: https://production.hifibridge.com description: Production server - url: https://sandbox.hifibridge.com description: Sandbox server security: - bearerAuth: [] tags: - name: Common description: Common endpoints - name: User description: User endpoints - name: Kyc description: Kyc endpoints - name: Wallet description: Wallet endpoints - name: Account description: Account endpoints - name: External Account description: External Account endpoints for managing beneficiary bank accounts - name: Fiat Account description: Fiat Account endpoints - name: Virtual Account description: Virtual Account endpoints - name: Onramp description: Onramp endpoints - name: Offramp description: Offramp endpoints - name: Orchestration Address description: >- Orchestration Address endpoints — persistent on-chain wallets that automatically off-ramp incoming stablecoin deposits to a USD bank account - name: Crypto Transfer description: Crypto Transfer endpoints - name: Cross-Chain Bridge description: Cross-Chain Bridge endpoints - name: Token Swap description: Token Swap endpoints - name: Canton Offers description: Canton Offers endpoints - name: Transfer Rules description: Transfer approval rules and configuration - name: Transfer Approvals description: Transfer approval workflow and admin actions - name: File description: File endpoints - name: Reporting description: Reporting and metrics endpoints paths: /v2/users/{userId}/orchestration-addresses/{orchestrationAddressId}/deposits: get: tags: - Orchestration Address summary: List deposits for an orchestration address description: | List on-chain deposits detected for the address, most recent first. Filterable by status, batch ID, and a created-at window. parameters: - $ref: '#/components/parameters/UserIdPathParameter' - $ref: '#/components/parameters/OrchestrationAddressIdPathParameter' - $ref: '#/components/parameters/OrchestrationDepositStatusQueryParameter' - $ref: '#/components/parameters/OrchestrationDepositBatchIdQueryParameter' - $ref: '#/components/parameters/OrchestrationCreatedAfterQueryParameter' - $ref: '#/components/parameters/OrchestrationCreatedBeforeQueryParameter' - $ref: '#/components/parameters/OrchestrationLimitQueryParameter' - $ref: '#/components/parameters/OrchestrationOffsetQueryParameter' responses: '200': $ref: '#/components/responses/OrchestrationDepositAllRecordsResponse' '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 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. OrchestrationDepositStatusQueryParameter: name: status in: query schema: type: string enum: - PENDING - BATCHED - IGNORED - REFUNDED required: false description: Filter deposits by status. OrchestrationDepositBatchIdQueryParameter: name: batchId in: query schema: type: string format: uuid required: false description: Filter deposits to those included in a specific batch. OrchestrationCreatedAfterQueryParameter: name: createdAfter in: query schema: type: string format: date-time required: false description: >- Inclusive lower bound on `createdAt` (ISO 8601). Only records created at or after this timestamp are returned. OrchestrationCreatedBeforeQueryParameter: name: createdBefore in: query schema: type: string format: date-time required: false description: >- Exclusive upper bound on `createdAt` (ISO 8601). Only records created strictly before this timestamp are returned. OrchestrationLimitQueryParameter: name: limit in: query schema: type: integer minimum: 1 maximum: 200 default: 50 required: false description: Maximum number of records to return. 1–200, defaults to 50. OrchestrationOffsetQueryParameter: name: offset in: query schema: type: integer minimum: 0 default: 0 required: false description: Number of records to skip (offset-based pagination). responses: OrchestrationDepositAllRecordsResponse: description: A paginated list of deposits for the named orchestration address. content: application/json: schema: $ref: '#/components/schemas/OrchestrationDepositAllRecordsObject' UnauthorizedResponse: description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/Unauthorized' NotFoundResponse: description: Resource not found content: application/json: schema: type: object properties: status: type: string enum: - error error: type: object properties: code: type: string message: type: string InternalServerErrorResponse: description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/InternalServerError' schemas: OrchestrationDepositAllRecordsObject: type: object description: Paginated list of deposits for an orchestration address. properties: count: type: integer records: type: array items: $ref: '#/components/schemas/OrchestrationDepositObject' Unauthorized: type: object properties: code: type: integer description: Error code error: type: string description: Error type errorDetails: type: string description: Detailed error message InternalServerError: type: object properties: code: type: integer description: Error code error: type: string description: Error type errorDetails: type: string description: Detailed error message 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 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 ````