> ## 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. # Deactivate an orchestration address > Deactivate an orchestration address so it no longer processes deposits. ## OpenAPI ````yaml https://production.hifi.com/api/v3/openapi.json delete /v3/users/{userId}/orchestration-addresses/{orchestrationAddressId} 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}: delete: tags: - Orchestration Address summary: Deactivate an orchestration address description: Deactivate an orchestration address so it no longer processes deposits. operationId: v3DeactivateOrchestrationAddress parameters: - $ref: '#/components/parameters/UserIdPathParameter' - $ref: '#/components/parameters/OrchestrationAddressIdPathParameter' requestBody: $ref: '#/components/requestBodies/DeactivateOrchestrationAddressBody' responses: '200': $ref: '#/components/responses/OrchestrationAddressResponse' '400': $ref: '#/components/responses/BadRequestResponse' '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. requestBodies: DeactivateOrchestrationAddressBody: required: true content: application/json: schema: $ref: '#/components/schemas/DeactivateOrchestrationAddress' responses: OrchestrationAddressResponse: description: A single orchestration address record. content: application/json: schema: $ref: '#/components/schemas/OrchestrationAddressObject' BadRequestResponse: description: Bad Request — the request was malformed or failed validation. content: application/json: schema: $ref: '#/components/schemas/ApiError' example: type: VALIDATION_ERROR message: One or more fields are invalid or missing. fields: - code: invalid_value message: Must be a valid email address field: email 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: DeactivateOrchestrationAddress: type: object title: Deactivate Orchestration Address description: > Body for deactivating an orchestration address. Any deposits still `PENDING` (not yet rolled into a batch) are refunded in-kind to `walletAddress`. required: - walletAddress properties: walletAddress: type: string description: > Destination address for the in-kind refund of the address's `PENDING` deposits. Must be a valid address for the orchestration address's `chain` (else `400 FIELD_VALIDATION_ERROR`). Required even when there are no pending deposits to refund. OrchestrationAddressObject: type: object description: An orchestration address record. properties: id: type: string format: uuid description: Unique orchestration address ID. userId: type: string format: uuid description: ID of the user that owns this orchestration address. address: type: string nullable: true description: | The on-chain wallet address that accepts deposits. `null` while `status=PENDING_WALLET` (provisioning in flight); populated once the wallet exists. example: '0xAbC0123456789AbCdEf0123456789AbCdEf01234' source: type: object description: Source token + chain the address accepts. properties: currency: type: string enum: - usdc - usdt chain: type: string description: > Abbreviated chain name (e.g. `BASE`, `ETHEREUM`, `SOLANA`) — the same form accepted on create and used across the v2 API. example: BASE destination: type: object description: Destination payout configuration. properties: currency: type: string enum: - usd accountId: type: string format: uuid mode: $ref: '#/components/schemas/OrchestrationAddressModeEnum' schedule: description: | Populated only when `mode=SCHEDULED`; `null` otherwise. nullable: true type: object properties: interval: $ref: '#/components/schemas/OrchestrationScheduleIntervalEnum' nextRunAt: type: string format: date-time description: ISO 8601 timestamp of the next scheduled batch. thresholdAmount: type: string nullable: true description: > Populated only when `mode=THRESHOLD`; `null` otherwise. Decimal amount in the source `currency`. example: '100.00' status: $ref: '#/components/schemas/OrchestrationAddressStatusEnum' createdAt: type: string format: date-time updatedAt: type: string format: date-time deactivatedAt: type: string format: date-time nullable: true description: >- ISO 8601 timestamp when the address was deactivated. `null` if still active. balance: type: object nullable: true description: > The escrow wallet's live on-chain balance of the source token. Present ONLY on the single-address GET (`GET /orchestration-addresses/{id}`); the list endpoint omits it to avoid a provider call per row. `null` if the wallet isn't provisioned yet or the balance lookup failed — the GET still returns `200`. properties: currency: type: string enum: - usdc - usdt amount: type: string description: Decimal balance in the source `currency` (e.g. `"100.500000"`). example: currency: usdc amount: '100.500000' ApiError: type: object description: >- Standard v3 error shape, returned by validation failures and business-logic errors alike. properties: type: type: string description: >- Machine-readable error type, e.g. VALIDATION_ERROR, ACTION_NOT_ALLOWED, RESOURCE_CONFLICT. example: VALIDATION_ERROR message: type: string description: Human-readable error message. example: One or more fields are invalid or missing. fields: type: array description: >- Present on field-level validation errors. One entry per problem field. 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. 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 OrchestrationAddressModeEnum: type: string enum: - PER_DEPOSIT - SCHEDULED - THRESHOLD description: | Determines when deposits are converted into an offramp. * `PER_DEPOSIT` — each deposit is batched into its own offramp immediately, UNLESS the cumulative `PENDING` amount is below the destination rail's offramp minimum, in which case the deposit is held `PENDING` and all pending deposits are batched together once their cumulative amount reaches the minimum. * `SCHEDULED` — deposits accumulate until the next schedule boundary (`HOURLY`/`DAILY`/`WEEKLY`), then the entire pending pool is batched together (only if it meets the offramp minimum; otherwise it rolls into the next tick). * `THRESHOLD` — deposits accumulate until their summed amount reaches `thresholdAmount`, then the entire pending pool is batched. OrchestrationScheduleIntervalEnum: type: string enum: - HOURLY - DAILY - WEEKLY description: >- How often a `SCHEDULED` orchestration address rolls up pending deposits into a batch. OrchestrationAddressStatusEnum: type: string enum: - PENDING_WALLET - ACTIVE - DEACTIVATED description: | Lifecycle status of the orchestration address. * `PENDING_WALLET` — created but the escrow wallet is still being provisioned. The on-chain `address` is null. Typically transient (a few seconds). * `ACTIVE` — wallet provisioned, ready to receive deposits. * `DEACTIVATED` — soft-deleted. The on-chain wallet still exists and can receive funds, but incoming deposits are recorded with `status=IGNORED` and never offramped. securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: JWT ````