Deribit Wallet API

The Wallet API from Deribit β€” 21 operation(s) for wallet.

OpenAPI Specification

deribit-wallet-api-openapi.yml Raw ↑
openapi: 3.0.0
info:
  title: Deribit Account Management Wallet API
  version: 2.1.1
servers:
- url: https://test.deribit.com/api/v2
tags:
- name: Wallet
paths:
  /private/get_deposits:
    get:
      parameters:
      - name: currency
        required: true
        in: query
        schema:
          $ref: '#/components/schemas/currency'
        description: The currency symbol
      - name: count
        required: false
        in: query
        schema:
          type: integer
          maximum: 1000
          minimum: 1
        description: Number of requested items, default - `10`, maximum - `1000`
      - name: offset
        in: query
        required: false
        schema:
          example: 10
          type: integer
        description: The offset for pagination, default - `0`
      responses:
        '200':
          $ref: '#/components/responses/PrivateGetDepositsResponse'
      tags:
      - Wallet
      requestBody:
        content:
          application/json:
            examples:
              request:
                value:
                  jsonrpc: '2.0'
                  id: 5611
                  method: private/get_deposits
                  params:
                    currency: BTC
                    count: 10
                    offset: 0
                description: JSON-RPC Request Example
        description: JSON-RPC request body
      description: 'Retrieve the latest user deposits. Returns a list of deposit transactions with their status, amounts, addresses, confirmations, and other relevant details.


        **πŸ“– Related Article:** [Managing Deposits](https://docs.deribit.com/articles/managing-deposits-api)


        **Scope:** `wallet:read`


        [Try in API console](https://test.deribit.com/api_console?method=%2Fprivate%2Fget_deposits)


        '
      x-mint:
        metadata:
          title: private/get_deposits
          og:title: private/get_deposits
          keywords:
          - private/get_deposits
          - currency
          - count
          - offset
          - data
          - address
          - amount
          - state
          - transaction_id
          - source_address
          - received_timestamp
          - updated_timestamp
          - note
          - clearance_state
          - refund_transaction_id
        href: /api-reference/wallet/private-get_deposits
  /private/create_deposit_address:
    get:
      parameters:
      - name: currency
        required: true
        in: query
        schema:
          $ref: '#/components/schemas/currency'
        description: The currency symbol
      responses:
        '200':
          $ref: '#/components/responses/PrivateDepositAddressResponse'
      tags:
      - Wallet
      requestBody:
        content:
          application/json:
            examples:
              request:
                value:
                  jsonrpc: '2.0'
                  id: 7538
                  method: private/create_deposit_address
                  params:
                    currency: BTC
                description: JSON-RPC Request Example
        description: JSON-RPC request body
      description: 'Creates a new deposit address for the specified currency. Each currency can have multiple deposit addresses. Use this method to generate a new address for receiving deposits.


        **Note:**


        For Bitcoin, a new address can be generated every 24 hours.


        For ERC20, Solana and XRP only one address can be generated.


        **Note:**


        If an ERC20 address is generated, this address will be automatically added for every asset that uses ERC20 addresses.


        **πŸ“– Related Article:** [Managing Deposits](https://docs.deribit.com/articles/managing-deposits-api)


        **Scope:** `wallet:read_write`


        [Try in API console](https://test.deribit.com/api_console?method=%2Fprivate%2Fcreate_deposit_address)


        '
      x-mint:
        metadata:
          title: private/create_deposit_address
          og:title: private/create_deposit_address
          keywords:
          - private/create_deposit_address
          - currency
          - creation_timestamp
          - address
          - type
        href: /api-reference/wallet/private-create_deposit_address
  /private/get_current_deposit_address:
    get:
      parameters:
      - name: currency
        required: true
        in: query
        schema:
          $ref: '#/components/schemas/currency'
        description: The currency symbol
      responses:
        '200':
          $ref: '#/components/responses/PrivateDepositAddressResponse'
      tags:
      - Wallet
      requestBody:
        content:
          application/json:
            examples:
              request:
                value:
                  jsonrpc: '2.0'
                  id: 3461
                  method: private/get_current_deposit_address
                  params:
                    currency: BTC
                description: JSON-RPC Request Example
        description: JSON-RPC request body
      description: 'Retrieve the current deposit address for the specified currency. Returns the most recently created or used deposit address for receiving funds.


        **πŸ“– Related Article:** [Managing Deposits](https://docs.deribit.com/articles/managing-deposits-api)


        **Scope:** `wallet:read`


        [Try in API console](https://test.deribit.com/api_console?method=%2Fprivate%2Fget_current_deposit_address)


        '
      x-mint:
        metadata:
          title: private/get_current_deposit_address
          og:title: private/get_current_deposit_address
          keywords:
          - private/get_current_deposit_address
          - currency
          - creation_timestamp
          - address
          - type
        href: /api-reference/wallet/private-get_current_deposit_address
  /private/withdraw:
    get:
      parameters:
      - name: currency
        required: true
        in: query
        schema:
          $ref: '#/components/schemas/currency'
        description: The currency symbol
      - name: address
        in: query
        schema:
          type: string
        required: true
        description: Address in currency format, it must be in address book
      - name: amount
        in: query
        schema:
          type: number
        required: true
        description: Amount of funds to be withdrawn
      - name: priority
        in: query
        schema:
          type: string
          enum:
          - insane
          - extreme_high
          - very_high
          - high
          - mid
          - low
          - very_low
        required: false
        description: 'Withdrawal priority, optional for BTC, default: `high`'
      - in: query
        name: nonce
        required: false
        schema:
          $ref: '#/components/schemas/nonce'
        description: Optional idempotency nonce. If provided, subsequent requests with the same nonce will return the previously created transaction instead of creating a new one. Must be 8-128 characters. The nonce is persisted on the resulting transaction and returned in the response.
      responses:
        '200':
          $ref: '#/components/responses/PrivateWithdrawResponse'
      tags:
      - Wallet
      requestBody:
        content:
          application/json:
            examples:
              request:
                value:
                  jsonrpc: '2.0'
                  id: 6931
                  method: private/withdraw
                  params:
                    currency: BTC
                    address: 2NBqqD5GRJ8wHy1PYyCXTe9ke5226FhavBz
                    amount: 0.4
                    priority: mid
                description: JSON-RPC Request Example
        description: JSON-RPC request body
      description: 'Creates a new withdrawal request. This method allows you to withdraw funds from your account to an external address. The withdrawal can be configured with priority settings and must use an address from your address book.


        **Withdrawal Checks & Balance Updates**


        Withdrawal funds are checked twice: when a user requests a withdrawal and again when they confirm it via the email link. If available funds decrease between these steps, the withdrawal may be rejected.


        A withdrawal may also be rejected if the on-chain fee increases between the request and confirmation.


        The withdrawal amount is deducted only after all checks pass and the transaction is scheduled. The web-interface Withdrawal tab displays all withdrawals regardless of their status (pending, cancelled, rejected, or completed).


        **πŸ“– Related Article:** [Managing Withdrawals](https://docs.deribit.com/articles/managing-withdrawals-api)


        **Scope:** `wallet:read_write` and mainaccount


        [Try in API console](https://test.deribit.com/api_console?method=%2Fprivate%2Fwithdraw)


        '
      x-mint:
        metadata:
          title: private/withdraw
          og:title: private/withdraw
          keywords:
          - private/withdraw
          - currency
          - address
          - amount
          - priority
          - nonce
          - confirmed_timestamp
          - created_timestamp
          - fee
          - state
          - transaction_id
          - updated_timestamp
        href: /api-reference/wallet/private-withdraw
  /private/cancel_withdrawal:
    get:
      parameters:
      - name: currency
        required: true
        in: query
        schema:
          $ref: '#/components/schemas/currency'
        description: The currency symbol
      - in: query
        name: id
        required: true
        schema:
          type: number
          example: 1
        description: The withdrawal id
      responses:
        '200':
          $ref: '#/components/responses/PrivateWithdrawResponse'
      tags:
      - Wallet
      requestBody:
        content:
          application/json:
            examples:
              request:
                value:
                  jsonrpc: '2.0'
                  id: 7420
                  method: private/cancel_withdrawal
                  params:
                    currency: BTC
                    id: 1
                description: JSON-RPC Request Example
        description: JSON-RPC request body
      description: 'Cancels a pending withdrawal request. This method allows you to cancel a withdrawal that has not yet been processed. Once a withdrawal is processed, it cannot be cancelled.


        **πŸ“– Related Article:** [Managing Withdrawals](https://docs.deribit.com/articles/managing-withdrawals-api)


        **Scope:** `wallet:read_write`


        [Try in API console](https://test.deribit.com/api_console?method=%2Fprivate%2Fcancel_withdrawal)


        '
      x-mint:
        metadata:
          title: private/cancel_withdrawal
          og:title: private/cancel_withdrawal
          keywords:
          - private/cancel_withdrawal
          - currency
          - id
          - address
          - amount
          - confirmed_timestamp
          - created_timestamp
          - fee
          - priority
          - state
          - transaction_id
          - updated_timestamp
          - nonce
        href: /api-reference/wallet/private-cancel_withdrawal
  /private/get_withdrawals:
    get:
      parameters:
      - name: currency
        required: true
        in: query
        schema:
          $ref: '#/components/schemas/currency'
        description: The currency symbol
      - name: count
        required: false
        in: query
        schema:
          type: integer
          maximum: 1000
          minimum: 1
        description: Number of requested items, default - `10`, maximum - `1000`
      - name: offset
        in: query
        required: false
        schema:
          example: 10
          type: integer
        description: The offset for pagination, default - `0`
      responses:
        '200':
          $ref: '#/components/responses/PrivateGetWithdrawalsResponse'
      tags:
      - Wallet
      requestBody:
        content:
          application/json:
            examples:
              request:
                value:
                  jsonrpc: '2.0'
                  id: 2745
                  method: private/get_withdrawals
                  params:
                    currency: BTC
                    count: 10
                    offset: 0
                description: JSON-RPC Request Example
        description: JSON-RPC request body
      description: 'Retrieve the latest user withdrawals. Returns a list of withdrawal requests with their status, amounts, addresses, and other relevant details.


        **πŸ“– Related Article:** [Managing Withdrawals](https://docs.deribit.com/articles/managing-withdrawals-api)


        **Scope:** `wallet:read`


        [Try in API console](https://test.deribit.com/api_console?method=%2Fprivate%2Fget_withdrawals)


        '
      x-mint:
        metadata:
          title: private/get_withdrawals
          og:title: private/get_withdrawals
          keywords:
          - private/get_withdrawals
          - currency
          - count
          - offset
          - data
          - address
          - amount
          - confirmed_timestamp
          - created_timestamp
          - fee
          - priority
          - state
          - transaction_id
          - updated_timestamp
          - nonce
        href: /api-reference/wallet/private-get_withdrawals
  /private/get_address_book:
    get:
      parameters:
      - name: currency
        required: true
        in: query
        schema:
          $ref: '#/components/schemas/wallet_currency'
        description: The currency symbol
      - name: type
        in: query
        schema:
          $ref: '#/components/schemas/address_book_type'
        required: true
        description: Address book type
      responses:
        '200':
          $ref: '#/components/responses/PrivateAddressBookResponse'
      tags:
      - Wallet
      requestBody:
        content:
          application/json:
            examples:
              request:
                value:
                  jsonrpc: '2.0'
                  id: 31
                  method: private/get_address_book
                  params:
                    currency: BTC
                    type: withdrawal
                description: JSON-RPC Request Example
        description: JSON-RPC request body
      description: 'Retrieves the address book entries of the given type. Returns all saved addresses that can be used for withdrawals, along with their labels and beneficiary information if available.


        **πŸ“– Related Article:** [Managing Withdrawals](https://docs.deribit.com/articles/managing-withdrawals-api)


        **Scope:** `wallet:read`


        [Try in API console](https://test.deribit.com/api_console?method=%2Fprivate%2Fget_address_book)


        '
      x-mint:
        metadata:
          title: private/get_address_book
          og:title: private/get_address_book
          keywords:
          - private/get_address_book
          - currency
          - type
          - address
          - creation_timestamp
          - label
          - beneficiary_vasp_name
          - beneficiary_vasp_did
          - beneficiary_vasp_website
          - beneficiary_first_name
          - beneficiary_last_name
          - beneficiary_company_name
          - beneficiary_address
          - agreed
          - personal
          - info_required
          - status
          - waiting_timestamp
          - requires_confirmation
          - requires_confirmation_change
        href: /api-reference/wallet/private-get_address_book
  /private/add_to_address_book:
    get:
      parameters:
      - name: currency
        required: true
        in: query
        schema:
          $ref: '#/components/schemas/wallet_currency'
        description: The currency symbol
      - name: type
        in: query
        schema:
          $ref: '#/components/schemas/address_book_type'
        required: true
        description: Address book type
      - name: address
        in: query
        schema:
          type: string
        required: true
        description: Address in currency format
      - name: label
        in: query
        schema:
          $ref: '#/components/schemas/address_label'
        required: true
        description: Label of the address book entry
      - name: beneficiary_vasp_name
        in: query
        schema:
          $ref: '#/components/schemas/beneficiary_vasp_name'
        required: true
        description: Name of beneficiary VASP
      - name: beneficiary_vasp_did
        in: query
        schema:
          $ref: '#/components/schemas/beneficiary_vasp_did'
        required: true
        description: DID of beneficiary VASP
      - name: beneficiary_vasp_website
        in: query
        schema:
          $ref: '#/components/schemas/beneficiary_vasp_website'
        required: false
        description: Website of the beneficiary VASP. Required if the address book entry is associated with a VASP that is not included in the list of known VASPs
      - name: beneficiary_first_name
        in: query
        schema:
          $ref: '#/components/schemas/beneficiary_first_name'
        description: First name of beneficiary (if beneficiary is a person)
        required: false
      - name: beneficiary_last_name
        in: query
        schema:
          $ref: '#/components/schemas/beneficiary_last_name'
        description: First name of beneficiary (if beneficiary is a person)
        required: false
      - name: beneficiary_company_name
        in: query
        schema:
          $ref: '#/components/schemas/beneficiary_company_name'
        description: Beneficiary company name (if beneficiary is a company)
        required: false
      - name: beneficiary_address
        in: query
        schema:
          $ref: '#/components/schemas/beneficiary_address'
        required: true
        description: Geographical address of the beneficiary
      - name: agreed
        in: query
        schema:
          $ref: '#/components/schemas/agree_to_share_with_3rd_party'
        required: true
        description: Indicates that the user agreed to shared provided information with 3rd parties
      - name: personal
        in: query
        schema:
          $ref: '#/components/schemas/personal_wallet'
        required: true
        description: The user confirms that he provided address belongs to him and he has access to it via an un-hosted wallet software
      - name: extra_currencies
        in: query
        schema:
          $ref: '#/components/schemas/extra_currencies'
        description: The user can pass a list of currencies to add the address for. It is currently available ONLY for ERC20 currencies. Without passing this paramater for an ERC20 currency, the address will be added to ALL of the ERC20 currencies.
        required: false
      responses:
        '200':
          $ref: '#/components/responses/PrivateAddToAddressBookResponse'
      tags:
      - Wallet
      requestBody:
        content:
          application/json:
            examples:
              request:
                value:
                  jsonrpc: '2.0'
                  id: 42
                  method: private/add_to_address_book
                  params:
                    currency: BTC
                    type: withdrawal
                    address: bc1qar0srrr7xfkvy5l643lydnw9re59gtzzwf0uyj
                    label: Main address
                    beneficiary_vasp_name: Money`s Gone
                    beneficiary_vasp_did: did:example:123456789abcdefghi
                    beneficiary_first_name: John
                    beneficiary_last_name: Doe
                    beneficiary_address: NL, Amsterdam, Street, 1
                    agreed: true
                    personal: false
                description: JSON-RPC Request Example
        description: JSON-RPC request body
      description: 'Adds a new address to the address book. The address book allows you to store addresses for withdrawals, along with beneficiary information for compliance purposes.


        **πŸ“– Related Article:** [Managing Withdrawals](https://docs.deribit.com/articles/managing-withdrawals-api)


        **Scope:** `wallet:read_write`


        [Try in API console](https://test.deribit.com/api_console?method=%2Fprivate%2Fadd_to_address_book)


        '
      x-mint:
        metadata:
          title: private/add_to_address_book
          og:title: private/add_to_address_book
          keywords:
          - private/add_to_address_book
          - currency
          - type
          - address
          - label
          - beneficiary_vasp_name
          - beneficiary_vasp_did
          - beneficiary_vasp_website
          - beneficiary_first_name
          - beneficiary_last_name
          - beneficiary_company_name
          - beneficiary_address
          - agreed
          - personal
          - extra_currencies
          - creation_timestamp
          - info_required
          - status
          - waiting_timestamp
          - requires_confirmation
          - requires_confirmation_change
        href: /api-reference/wallet/private-add_to_address_book
  /private/remove_from_address_book:
    get:
      parameters:
      - name: currency
        required: true
        in: query
        schema:
          $ref: '#/components/schemas/wallet_currency'
        description: The currency symbol
      - name: type
        in: query
        schema:
          $ref: '#/components/schemas/address_book_type'
        required: true
        description: Address book type
      - name: address
        in: query
        schema:
          type: string
        required: true
        description: Address in currency format, it must be in address book
      responses:
        '200':
          $ref: '#/components/responses/PrivateRemoveFromAddressBookResponse'
      tags:
      - Wallet
      requestBody:
        content:
          application/json:
            examples:
              request:
                value:
                  jsonrpc: '2.0'
                  id: 42
                  method: private/remove_from_address_book
                  params:
                    currency: BTC
                    type: transfer
                    address: bc1qar0srrr7xfkvy5l643lydnw9re59gtzzwf0uyj
                description: JSON-RPC Request Example
        description: JSON-RPC request body
      description: 'Removes an entry from the address book. This method allows you to delete a saved address that is no longer needed.


        **πŸ“– Related Article:** [Managing Withdrawals](https://docs.deribit.com/articles/managing-withdrawals-api)


        **Scope:** `wallet:read_write`


        [Try in API console](https://test.deribit.com/api_console?method=%2Fprivate%2Fremove_from_address_book)


        '
      x-mint:
        metadata:
          title: private/remove_from_address_book
          og:title: private/remove_from_address_book
          keywords:
          - private/remove_from_address_book
          - currency
          - type
          - address
        href: /api-reference/wallet/private-remove_from_address_book
  /private/update_in_address_book:
    get:
      parameters:
      - name: currency
        required: true
        in: query
        schema:
          $ref: '#/components/schemas/wallet_currency'
        description: The currency symbol
      - name: type
        in: query
        schema:
          $ref: '#/components/schemas/address_book_type'
        required: true
        description: Address book type
      - name: address
        in: query
        schema:
          type: string
        required: true
        description: Address in currency format, it must be in address book
      - name: beneficiary_vasp_name
        in: query
        schema:
          $ref: '#/components/schemas/beneficiary_vasp_name'
        required: true
        description: Name of beneficiary VASP
      - name: beneficiary_vasp_did
        in: query
        schema:
          $ref: '#/components/schemas/beneficiary_vasp_did'
        required: true
        description: DID of beneficiary VASP
      - name: beneficiary_vasp_website
        in: query
        schema:
          $ref: '#/components/schemas/beneficiary_vasp_website'
        required: false
        description: Website of the beneficiary VASP. Required if the address book entry is associated with a VASP that is not included in the list of known VASPs
      - name: beneficiary_first_name
        in: query
        schema:
          $ref: '#/components/schemas/beneficiary_first_name'
        description: First name of beneficiary (if beneficiary is a person)
        required: false
      - name: beneficiary_last_name
        in: query
        schema:
          $ref: '#/components/schemas/beneficiary_last_name'
        description: First name of beneficiary (if beneficiary is a person)
        required: false
      - name: beneficiary_company_name
        in: query
        schema:
          $ref: '#/components/schemas/beneficiary_company_name'
        description: Beneficiary company name (if beneficiary is a company)
        required: false
      - name: beneficiary_address
        in: query
        schema:
          $ref: '#/components/schemas/beneficiary_address'
        required: true
        description: Geographical address of the beneficiary
      - name: agreed
        in: query
        schema:
          $ref: '#/components/schemas/agree_to_share_with_3rd_party'
        required: true
        description: Indicates that the user agreed to shared provided information with 3rd parties
      - name: personal
        in: query
        schema:
          $ref: '#/components/schemas/personal_wallet'
        required: true
        description: The user confirms that he provided address belongs to him and he has access to it via an un-hosted wallet software
      - name: label
        in: query
        schema:
          $ref: '#/components/schemas/address_label'
        required: true
        description: Label of the address book entry
      responses:
        '200':
          $ref: '#/components/responses/PrivateUpdateInAddressBookResponse'
      tags:
      - Wallet
      requestBody:
        content:
          application/json:
            examples:
              request:
                value:
                  jsonrpc: '2.0'
                  id: 42
                  method: private/update_in_address_book
                  params:
                    currency: BTC
                    type: withdrawal
                    address: bc1qar0srrr7xfkvy5l643lydnw9re59gtzzwf0uyj
                    label: Main address
                    beneficiary_vasp_name: Money`s Gone
                    beneficiary_vasp_did: did:example:123456789abcdefghi
                    beneficiary_first_name: John
                    beneficiary_last_name: Doe
                    beneficiary_address: NL, Amsterdam, Street, 1
                    agreed: true
                    personal: false
                description: JSON-RPC Request Example
        description: JSON-RPC request body
      description: 'Updates beneficiary information for an address in the address book. This method allows you to add or modify beneficiary details required for compliance purposes when making withdrawals to certain addresses.


        **πŸ“– Related Article:** [Managing Withdrawals](https://docs.deribit.com/articles/managing-withdrawals-api)


        **Scope:** `wallet:read_write`


        [Try in API console](https://test.deribit.com/api_console?method=%2Fprivate%2Fupdate_in_address_book)


        '
      x-mint:
        metadata:
          title: private/update_in_address_book
          og:title: private/update_in_address_book
          keywords:
          - private/update_in_address_book
          - currency
          - type
          - address
          - beneficiary_vasp_name
          - beneficiary_vasp_did
          - beneficiary_vasp_website
          - beneficiary_first_name
          - beneficiary_last_name
          - beneficiary_company_name
          - beneficiary_address
          - agreed
          - personal
          - label
        href: /api-reference/wallet/private-update_in_address_book
  /private/save_address_beneficiary:
    get:
      parameters:
      - name: currency
        required: true
        in: query
        schema:
          $ref: '#/components/schemas/wallet_currency'
        description: The currency symbol
      - name: address
        in: query
        schema:
          type: string
        required: true
        description: Address in currency format
      - name: tag
        in: query
        schema:
          type: string
        required: false
        description: Tag for XRP addresses
      - name: agreed
        in: query
        schema:
          $ref: '#/components/schemas/agree_to_share_with_3rd_party'
        required: true
        description: Indicates that the user agreed to shared provided information with 3rd parties
      - name: personal
        in: query
        schema:
          $ref: '#/components/schemas/personal_wallet'
        required: true
        description: The user confirms that he provided address belongs to him and he has access to it via an un-hosted wallet software
      - name: unhosted
        in: query
        schema:
          type: boolean
        required: true
        description: Indicates if the address belongs to an unhosted wallet
      - name: beneficiary_vasp_name
        in: query
        schema:
          $ref: '#/components/schemas/beneficiary_vasp_name'
        required: true
        description: Name of beneficiary VASP
      - name: beneficiary_vasp_did
        in: query
        schema:
          $ref: '#/components/schemas/beneficiary_vasp_did'
        required: true
        description: DID of beneficiary VASP
      - name: beneficiary_vasp_website
        in: query
        schema:
          $ref: '#/components/schemas/beneficiary_vasp_website'
        required: false
        description: Website of the beneficiary VASP. Required if the address book entry is associated with a VASP that is not included in the list of known VASPs
      - name: beneficiary_first_name
        in: query
        schema:
          $ref: '#/components/schemas/beneficiary_first_name'
        description: First name of beneficiary (if beneficiary is a person)
        required: false
      - name: beneficiary_last_name
        in: query
        schema:
          $ref: '#/components/schemas/beneficiary_last_name'
        description: First name of beneficiary (if beneficiary is a person)
        required: false
      - name: beneficiary_company_name
        in: query
        schema:
          $ref: '#/components/schemas/beneficiary_company_name'
        description: Beneficiary company name (if beneficiary is a company)
        required: false
      - name: beneficiary_address
        in: query
        schema:
          $ref: '#/components/schemas/beneficiary_address'
        required: true
        description: Geographical address of the beneficiary
      responses:
        '200':
          $ref: '#/components/responses/PrivateSaveAddressBeneficiaryResponse'
      tags:
      - Wallet
      requestBody:
        content:
          application/json:
            examples:
              request:
                value:
                  jsonrpc: '2.0'
                  id: 42
                  method: private/save_address_beneficiary
                  params:
                    currency: BTC
                    address: bc1qar0srrr7xfkvy5l643lydnw9re59gtzzwf0uyj
                    agreed: true
                    personal: false
                    unhosted: false
                    beneficiary_vasp_name: Money's Gone
                    beneficiary_vasp_did: did:example:123456789abcdefghi
                    beneficiary_vasp_website: https://example.com
                    beneficiary_first_name: John
                    beneficiary_last_name: Doe
                    beneficiary_company_name: Example Corp
                    beneficiary_address: NL, Amsterdam, Street, 1
                description: JSON-RPC Request Example
        description: JSON-RPC request body
      description: 'Saves beneficiary information for an address. This method allows you to store beneficiary details required for compliance purposes, including VASP information, personal details, and wallet type classification.


        **πŸ“– Related Article:** [Managing Withdrawals](https://docs.deribit.com/articles/managing-withdrawals-api)


  

# --- truncated at 32 KB (93 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/deribit/refs/heads/main/openapi/deribit-wallet-api-openapi.yml