> ## Documentation Index
> Fetch the complete documentation index at: https://docs.rhino.fi/llms.txt
> Use this file to discover all available pages before exploring further.

# Pause, unpause, or update deposit addresses

> Pauses or unpauses deposit address(es) matching the given address, or updates the destination address using signature authorization. For Pause and Unpause, depositChain limits the action to one chain when provided; otherwise all matching deposit addresses are affected. Signature-authorized destination updates require custom per-project setup and are not generally available.



## OpenAPI

````yaml https://api.rhino.fi/sda/swagger.json patch /deposit-addresses/{depositAddress}
openapi: 3.1.0
info:
  title: SDA API
  version: 0.0.1
  description: Functionality for interacting with Rhino SDA service
servers:
  - url: https://api.rhino.fi/sda
security: []
tags:
  - name: depositAddresses
paths:
  /deposit-addresses/{depositAddress}:
    patch:
      tags:
        - depositAddresses
      summary: Pause, unpause, or update deposit addresses
      description: >-
        Pauses or unpauses deposit address(es) matching the given address, or
        updates the destination address using signature authorization. For Pause
        and Unpause, depositChain limits the action to one chain when provided;
        otherwise all matching deposit addresses are affected.
        Signature-authorized destination updates require custom per-project
        setup and are not generally available.
      operationId: depositAddresses.updateDepositAddresses
      parameters:
        - name: depositAddress
          in: path
          schema:
            anyOf:
              - $ref: '#/components/schemas/EthAddressSchema'
              - $ref: '#/components/schemas/TronAddressBasic'
              - $ref: '#/components/schemas/SolanaAddress'
              - $ref: '#/components/schemas/StellarMuxedAddress'
          required: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateDepositAddressesPayload'
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  required:
                    - depositChain
                    - depositAddress
                    - destinationChain
                    - isActive
                    - isPaused
                  properties:
                    depositChain:
                      type: string
                      description: >-
                        The blockchain network identifier where the deposit
                        address is located.
                      title: nonEmptyString
                      minLength: 1
                    depositAddress:
                      type: string
                      description: >-
                        The generated deposit address where users should send
                        tokens.
                      title: nonEmptyString
                      minLength: 1
                    destinationChain:
                      type: string
                      description: >-
                        The blockchain network identifier where bridged tokens
                        will be sent.
                      title: nonEmptyString
                      minLength: 1
                    destinationAddress:
                      allOf:
                        - $ref: '#/components/schemas/NonEmptyString'
                      description: >-
                        The destination address where bridged tokens will be
                        sent (optional).
                    addressNote:
                      type: string
                      description: >-
                        Optional note or label for the deposit address (max 80
                        characters).
                      title: maxLength(80)
                      maxLength: 80
                    isActive:
                      type: boolean
                      description: >-
                        Whether this deposit address is currently active and
                        accepting deposits.
                    isPaused:
                      type: boolean
                      description: >-
                        Whether this deposit address is currently paused. Paused
                        addresses reject incoming deposits until they are
                        unpaused.
                    postBridgeData:
                      anyOf:
                        - $ref: '#/components/schemas/ExtendedPostBridgeData'
                        - $ref: >-
                            #/components/schemas/StarkwareBtcfiCampaignPostBridgeData
                        - $ref: '#/components/schemas/WirexWrapPostBridgeData'
                        - $ref: '#/components/schemas/WirexWrapSandboxPostBridgeData'
                        - $ref: >-
                            #/components/schemas/StarkwareBtcfiCampaignV2PostBridgeData
                        - $ref: '#/components/schemas/AaveV3SupplyPostBridgeData'
                        - $ref: >-
                            #/components/schemas/RocketFoundationDepositPostBridgeData
                        - $ref: '#/components/schemas/MapleDepositPostBridgeData'
                      description: >-
                        Optional configuration for post-bridge actions (e.g.,
                        staking, lending). Must be omitted if your client does
                        not have PBA enabled. See
                        https://docs.rhino.fi/api-integration/smart-deposits#post-bridge-data
                        for details.
                    tokenOut:
                      type: string
                      description: >-
                        Optional token to receive after bridging (for token
                        swaps).
                    refundAddress:
                      allOf:
                        - $ref: '#/components/schemas/NonEmptyString'
                      description: Optional address for refunds if bridging fails.
                    bridgeIfNotSwappable:
                      type: boolean
                      description: >-
                        Whether to bridge tokens even if they cannot be swapped
                        (optional).
                    chainMetadata:
                      $ref: '#/components/schemas/ChainMetadata'
                  additionalProperties: false
        '400':
          description: The request did not match the expected schema
          content:
            application/json:
              schema:
                anyOf:
                  - $ref: '#/components/schemas/HttpApiDecodeError'
                  - $ref: '#/components/schemas/InvalidJwt'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Unauthorized'
        '403':
          description: ProjectNotAllowlistedForSdaDestinationUpdate
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/ProjectNotAllowlistedForSdaDestinationUpdate
        '422':
          description: DepositAddressNotFound
          content:
            application/json:
              schema:
                anyOf:
                  - $ref: '#/components/schemas/DepositAddressNotFound'
                  - $ref: '#/components/schemas/SdaDestinationAddressMismatch'
                  - $ref: '#/components/schemas/InvalidSdaDestinationSignature'
                  - $ref: >-
                      #/components/schemas/UnsupportedSdaVariantForDestinationUpdate
        '503':
          description: EndpointDisabledError
          content:
            application/json:
              schema:
                anyOf:
                  - $ref: '#/components/schemas/EndpointDisabledError'
                  - $ref: '#/components/schemas/SdaSignatureVerificationUnavailable'
      security:
        - bearer: []
        - legacyApiKey: []
components:
  schemas:
    EthAddressSchema:
      type: string
      description: a string that will be trimmed
    TronAddressBasic:
      type: string
      description: Tron basic address format
      pattern: T[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]+
      title: maxLength(60)
      maxLength: 60
    SolanaAddress:
      type: string
    StellarMuxedAddress:
      type: string
    UpdateDepositAddressesPayload:
      type: object
      required:
        - action
      properties:
        action:
          anyOf:
            - $ref: '#/components/schemas/PauseSdasAction'
            - $ref: '#/components/schemas/UnpauseSdasAction'
            - $ref: '#/components/schemas/UpdateDestinationAddressWithSignatureAction'
          description: >-
            Action to apply to the deposit address(es). "Pause" stops accepting
            new deposits; "Unpause" resumes;
            "UpdateDestinationAddressWithSignature" updates the destination
            address after signature verification and requires custom per-project
            setup.
      additionalProperties: false
    NonEmptyString:
      type: string
      description: a non empty string
      title: nonEmptyString
      minLength: 1
    ExtendedPostBridgeData:
      type: object
      required:
        - _tag
        - vaultId
      properties:
        _tag:
          type: string
          enum:
            - extended
        vaultId:
          $ref: '#/components/schemas/NonNegativeInt'
      additionalProperties: false
    StarkwareBtcfiCampaignPostBridgeData:
      type: object
      required:
        - _tag
      properties:
        _tag:
          type: string
          enum:
            - starkwarebtcfi
      additionalProperties: false
    WirexWrapPostBridgeData:
      type: object
      required:
        - _tag
      properties:
        _tag:
          type: string
          enum:
            - wirexwrap
      additionalProperties: false
    WirexWrapSandboxPostBridgeData:
      type: object
      required:
        - _tag
      properties:
        _tag:
          type: string
          enum:
            - wirexwrapsandbox
      additionalProperties: false
    StarkwareBtcfiCampaignV2PostBridgeData:
      type: object
      required:
        - _tag
        - spans
      properties:
        _tag:
          type: string
          enum:
            - starkwarebtcfiv2
        spans:
          type: array
          items:
            $ref: '#/components/schemas/StarknetFelt'
          description: an array of at most 70 item(s)
          title: maxItems(70)
          maxItems: 70
      additionalProperties: false
    AaveV3SupplyPostBridgeData:
      type: object
      required:
        - _tag
      properties:
        _tag:
          type: string
          enum:
            - aavev3supply
      additionalProperties: false
    RocketFoundationDepositPostBridgeData:
      type: object
      required:
        - _tag
      properties:
        _tag:
          type: string
          enum:
            - rocketfoundationdeposit
      additionalProperties: false
    MapleDepositPostBridgeData:
      type: object
      required:
        - _tag
      properties:
        _tag:
          type: string
          enum:
            - mapledeposit
      additionalProperties: false
    ChainMetadata:
      type: object
      required:
        - _tag
        - baseAddress
        - memoId
      properties:
        _tag:
          type: string
          enum:
            - STELLAR
        baseAddress:
          type: string
        memoId:
          $ref: '#/components/schemas/StellarMemoId'
      additionalProperties: false
      description: >-
        Optional chain-specific metadata. Currently only populated for Stellar
        SDAs, where it exposes the base address and memo id that the muxed
        deposit address resolves to.
    HttpApiDecodeError:
      type: object
      required:
        - issues
        - message
        - _tag
      properties:
        issues:
          type: array
          items:
            $ref: '#/components/schemas/Issue'
        message:
          type: string
        _tag:
          type: string
          enum:
            - HttpApiDecodeError
      additionalProperties: false
      description: The request did not match the expected schema
    InvalidJwt:
      type: object
      required:
        - message
        - _tag
      properties:
        message:
          type: string
        _tag:
          type: string
          enum:
            - InvalidJwt
      additionalProperties: false
    Unauthorized:
      type: object
      required:
        - message
        - _tag
      properties:
        message:
          type: string
        _tag:
          type: string
          enum:
            - Unauthorized
      additionalProperties: false
    ProjectNotAllowlistedForSdaDestinationUpdate:
      type: object
      required:
        - projectId
        - message
        - _tag
      properties:
        projectId:
          $ref: '#/components/schemas/NonEmptyString'
        message:
          type: string
        _tag:
          type: string
          enum:
            - ProjectNotAllowlistedForSdaDestinationUpdate
      additionalProperties: false
    DepositAddressNotFound:
      type: object
      required:
        - message
        - addresses
        - _tag
      properties:
        message:
          type: string
        addresses:
          type: array
          items:
            $ref: '#/components/schemas/NonEmptyString'
        _tag:
          type: string
          enum:
            - DepositAddressNotFound
      additionalProperties: false
    SdaDestinationAddressMismatch:
      type: object
      required:
        - depositAddress
        - message
        - _tag
      properties:
        depositAddress:
          $ref: '#/components/schemas/EthAddressSchema'
        message:
          type: string
        _tag:
          type: string
          enum:
            - SdaDestinationAddressMismatch
      additionalProperties: false
    InvalidSdaDestinationSignature:
      type: object
      required:
        - depositAddress
        - message
        - _tag
      properties:
        depositAddress:
          $ref: '#/components/schemas/EthAddressSchema'
        message:
          type: string
        _tag:
          type: string
          enum:
            - InvalidSdaDestinationSignature
      additionalProperties: false
    UnsupportedSdaVariantForDestinationUpdate:
      type: object
      required:
        - depositAddress
        - variant
        - message
        - _tag
      properties:
        depositAddress:
          $ref: '#/components/schemas/EthAddressSchema'
        variant:
          $ref: '#/components/schemas/NonEmptyString'
        message:
          type: string
        _tag:
          type: string
          enum:
            - UnsupportedSdaVariantForDestinationUpdate
      additionalProperties: false
    EndpointDisabledError:
      type: object
      required:
        - message
        - _tag
      properties:
        message:
          type: string
        _tag:
          type: string
          enum:
            - EndpointDisabledError
      additionalProperties: false
    SdaSignatureVerificationUnavailable:
      type: object
      required:
        - depositAddress
        - message
        - _tag
      properties:
        depositAddress:
          $ref: '#/components/schemas/EthAddressSchema'
        message:
          type: string
        _tag:
          type: string
          enum:
            - SdaSignatureVerificationUnavailable
      additionalProperties: false
    PauseSdasAction:
      type: object
      required:
        - _tag
      properties:
        depositChain:
          type: string
          description: >-
            Optional deposit chain identifier. If omitted, the action is applied
            to all deposit addresses matching the given address across all
            chains.
          title: nonEmptyString
          minLength: 1
        _tag:
          type: string
          enum:
            - Pause
      additionalProperties: false
    UnpauseSdasAction:
      type: object
      required:
        - _tag
      properties:
        depositChain:
          type: string
          description: >-
            Optional deposit chain identifier. If omitted, the action is applied
            to all deposit addresses matching the given address across all
            chains.
          title: nonEmptyString
          minLength: 1
        _tag:
          type: string
          enum:
            - Unpause
      additionalProperties: false
    UpdateDestinationAddressWithSignatureAction:
      type: object
      required:
        - newDestinationAddress
        - signature
        - _tag
      properties:
        newDestinationAddress:
          $ref: '#/components/schemas/EthAddressSchema'
        signature:
          $ref: '#/components/schemas/NonEmptyString'
        _tag:
          type: string
          enum:
            - UpdateDestinationAddressWithSignature
      additionalProperties: false
      description: >-
        Updates the destination address using proof of control of the current
        address. This action requires custom per-project setup and is not
        generally available.
    NonNegativeInt:
      type: integer
      description: an integer
      title: int
      minimum: 0
    StarknetFelt:
      type: string
      description: a string that will be trimmed
    StellarMemoId:
      type: string
    Issue:
      type: object
      required:
        - _tag
        - path
        - message
      properties:
        _tag:
          type: string
          enum:
            - Pointer
            - Unexpected
            - Missing
            - Composite
            - Refinement
            - Transformation
            - Type
            - Forbidden
          description: The tag identifying the type of parse issue
        path:
          type: array
          items:
            $ref: '#/components/schemas/PropertyKey'
          description: The path to the property where the issue occurred
        message:
          type: string
          description: A descriptive message explaining the issue
      additionalProperties: false
      description: >-
        Represents an error encountered while parsing a value to match the
        schema
    PropertyKey:
      anyOf:
        - type: string
        - type: number
        - type: object
          required:
            - _tag
            - key
          properties:
            _tag:
              type: string
              enum:
                - symbol
            key:
              type: string
          additionalProperties: false
          description: an object to be decoded into a globally shared symbol
  securitySchemes:
    bearer:
      description: JWT token for authentication
      type: http
      scheme: bearer
    legacyApiKey:
      type: apiKey
      name: authorization
      in: header

````