Package markets.alpaca.client.openapi.trading.api

Class CryptoFundingApi

java.lang.Object
markets.alpaca.client.openapi.trading.api.CryptoFundingApi
public class CryptoFundingApi extends Object
Generated client for CryptoFundingApi operations.

This class is generated from the configured OpenAPI spec. Operation method Javadocs include OAS summaries, descriptions, parameters, return types, response details, and external documentation links when present in the spec.

Operations

  • createCryptoTransferForAccount: Request a New Withdrawal
  • createWhitelistedAddress: Request a new whitelisted address
  • deleteWhitelistedAddress: Delete a whitelisted address
  • getCryptoFundingTransfer: Retrieve a Crypto Funding Transfer
  • getCryptoTransferEstimate: Returns the estimated gas fee for a proposed transaction.
  • listCryptoFundingTransfers: Retrieve Crypto Funding Transfers
  • listCryptoFundingWallets: Retrieve Crypto Funding Wallets
  • listWhitelistedAddress: An array of whitelisted addresses
  • searchVASPs: Search for VASPs
  • updateWhitelistedAddressTravelRuleInfo: Update travel rule information for a whitelisted wallet

  • Constructor Details

    • CryptoFundingApi

      public CryptoFundingApi()

    • CryptoFundingApi

      public CryptoFundingApi(ApiClient apiClient)

  • Method Details

    • getApiClient

      public ApiClient getApiClient()

    • setApiClient

      public void setApiClient(ApiClient apiClient)

    • getHostIndex

      public int getHostIndex()

    • setHostIndex

      public void setHostIndex(int hostIndex)

    • getCustomBaseUrl

      public String getCustomBaseUrl()

    • setCustomBaseUrl

      public void setCustomBaseUrl(String customBaseUrl)

    • createCryptoTransferForAccountCall

      @Deprecated public okhttp3.Call createCryptoTransferForAccountCall(@Nonnull CreateCryptoTransferRequest createCryptoTransferRequest, ApiCallback _callback) throws ApiException
      Deprecated.
      Build call for createCryptoTransferForAccount
      Parameters:
      createCryptoTransferRequest - (required)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
      HTTP Response Details:
      Response Details
      Status Code Description Response Headers
      200 Successfully requested a transfer. -
      400 The request or travel rule information is invalid. -

    • createCryptoTransferForAccount

      @Deprecated public CryptoTransfer createCryptoTransferForAccount(@Nonnull CreateCryptoTransferRequest createCryptoTransferRequest) throws ApiException
      Deprecated.
      Request a New Withdrawal **Deprecation notice:** This endpoint is deprecated. Use the Alpaca web application to initiate withdrawals. Since: 2026-07-09 Sunset: 2026-10-09 --- Creates a withdrawal request. Note that outgoing withdrawals must be sent to a whitelisted address and you must whitelist addresses at least 24 hours in advance. If you attempt to withdraw funds to a non-whitelisted address then the transfer will be rejected.
      Parameters:
      createCryptoTransferRequest - (required)
      Returns:
      CryptoTransfer
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      HTTP Response Details:
      Response Details
      Status Code Description Response Headers
      200 Successfully requested a transfer. -
      400 The request or travel rule information is invalid. -

    • createCryptoTransferForAccountWithHttpInfo

      @Deprecated public ApiResponse<CryptoTransfer> createCryptoTransferForAccountWithHttpInfo(@Nonnull CreateCryptoTransferRequest createCryptoTransferRequest) throws ApiException
      Deprecated.
      Request a New Withdrawal **Deprecation notice:** This endpoint is deprecated. Use the Alpaca web application to initiate withdrawals. Since: 2026-07-09 Sunset: 2026-10-09 --- Creates a withdrawal request. Note that outgoing withdrawals must be sent to a whitelisted address and you must whitelist addresses at least 24 hours in advance. If you attempt to withdraw funds to a non-whitelisted address then the transfer will be rejected.
      Parameters:
      createCryptoTransferRequest - (required)
      Returns:
      ApiResponse<CryptoTransfer>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      HTTP Response Details:
      Response Details
      Status Code Description Response Headers
      200 Successfully requested a transfer. -
      400 The request or travel rule information is invalid. -

    • createCryptoTransferForAccountAsync

      @Deprecated public okhttp3.Call createCryptoTransferForAccountAsync(@Nonnull CreateCryptoTransferRequest createCryptoTransferRequest, ApiCallback<CryptoTransfer> _callback) throws ApiException
      Deprecated.
      Request a New Withdrawal (asynchronously) **Deprecation notice:** This endpoint is deprecated. Use the Alpaca web application to initiate withdrawals. Since: 2026-07-09 Sunset: 2026-10-09 --- Creates a withdrawal request. Note that outgoing withdrawals must be sent to a whitelisted address and you must whitelist addresses at least 24 hours in advance. If you attempt to withdraw funds to a non-whitelisted address then the transfer will be rejected.
      Parameters:
      createCryptoTransferRequest - (required)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object
      HTTP Response Details:
      Response Details
      Status Code Description Response Headers
      200 Successfully requested a transfer. -
      400 The request or travel rule information is invalid. -

    • createWhitelistedAddressCall

      public okhttp3.Call createWhitelistedAddressCall(@Nonnull CreateWhitelistedAddressRequest createWhitelistedAddressRequest, ApiCallback _callback) throws ApiException
      Build call for createWhitelistedAddress
      Parameters:
      createWhitelistedAddressRequest - (required)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
      HTTP Response Details:
      Response Details
      Status Code Description Response Headers
      200 Successfully requested a whitelisted address -
      400 The request or travel rule information is invalid. -

    • createWhitelistedAddress

      public WhitelistedAddress createWhitelistedAddress(@Nonnull CreateWhitelistedAddressRequest createWhitelistedAddressRequest) throws ApiException
      Request a new whitelisted address Submits a new whitelisted withdrawal address for your account. The chain is derived from the supplied asset symbol and address, and the same address cannot be whitelisted twice on the same chain. Where travel rule reporting applies to your account, supply travel rule information for the destination wallet. Use the `Search VASPs` endpoint to find the VASP DID for the destination exchange. For a self-hosted wallet, set `beneficiary_is_self_hosted` to true. If the exchange is not in the directory, provide its information in `beneficiary_manual_entry`. Note that whitelisted addresses must wait at least 24 hours before they can be used as a withdrawal destination.
      Parameters:
      createWhitelistedAddressRequest - (required)
      Returns:
      WhitelistedAddress
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      HTTP Response Details:
      Response Details
      Status Code Description Response Headers
      200 Successfully requested a whitelisted address -
      400 The request or travel rule information is invalid. -

    • createWhitelistedAddressWithHttpInfo

      public ApiResponse<WhitelistedAddress> createWhitelistedAddressWithHttpInfo(@Nonnull CreateWhitelistedAddressRequest createWhitelistedAddressRequest) throws ApiException
      Request a new whitelisted address Submits a new whitelisted withdrawal address for your account. The chain is derived from the supplied asset symbol and address, and the same address cannot be whitelisted twice on the same chain. Where travel rule reporting applies to your account, supply travel rule information for the destination wallet. Use the `Search VASPs` endpoint to find the VASP DID for the destination exchange. For a self-hosted wallet, set `beneficiary_is_self_hosted` to true. If the exchange is not in the directory, provide its information in `beneficiary_manual_entry`. Note that whitelisted addresses must wait at least 24 hours before they can be used as a withdrawal destination.
      Parameters:
      createWhitelistedAddressRequest - (required)
      Returns:
      ApiResponse<WhitelistedAddress>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      HTTP Response Details:
      Response Details
      Status Code Description Response Headers
      200 Successfully requested a whitelisted address -
      400 The request or travel rule information is invalid. -

    • createWhitelistedAddressAsync

      public okhttp3.Call createWhitelistedAddressAsync(@Nonnull CreateWhitelistedAddressRequest createWhitelistedAddressRequest, ApiCallback<WhitelistedAddress> _callback) throws ApiException
      Request a new whitelisted address (asynchronously) Submits a new whitelisted withdrawal address for your account. The chain is derived from the supplied asset symbol and address, and the same address cannot be whitelisted twice on the same chain. Where travel rule reporting applies to your account, supply travel rule information for the destination wallet. Use the `Search VASPs` endpoint to find the VASP DID for the destination exchange. For a self-hosted wallet, set `beneficiary_is_self_hosted` to true. If the exchange is not in the directory, provide its information in `beneficiary_manual_entry`. Note that whitelisted addresses must wait at least 24 hours before they can be used as a withdrawal destination.
      Parameters:
      createWhitelistedAddressRequest - (required)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object
      HTTP Response Details:
      Response Details
      Status Code Description Response Headers
      200 Successfully requested a whitelisted address -
      400 The request or travel rule information is invalid. -

    • deleteWhitelistedAddressCall

      public okhttp3.Call deleteWhitelistedAddressCall(@Nonnull String whitelistedAddressId, ApiCallback _callback) throws ApiException
      Build call for deleteWhitelistedAddress
      Parameters:
      whitelistedAddressId - The whitelisted address to delete (required)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
      HTTP Response Details:
      Response Details
      Status Code Description Response Headers
      200 Successfully deleted a whitelisted address -

    • deleteWhitelistedAddress

      public void deleteWhitelistedAddress(@Nonnull String whitelistedAddressId) throws ApiException
      Delete a whitelisted address Deletes a whitelisted withdrawal address by ID. Subsequent withdrawals targeting the deleted address will be rejected.
      Parameters:
      whitelistedAddressId - The whitelisted address to delete (required)
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      HTTP Response Details:
      Response Details
      Status Code Description Response Headers
      200 Successfully deleted a whitelisted address -

    • deleteWhitelistedAddressWithHttpInfo

      public ApiResponse<Void> deleteWhitelistedAddressWithHttpInfo(@Nonnull String whitelistedAddressId) throws ApiException
      Delete a whitelisted address Deletes a whitelisted withdrawal address by ID. Subsequent withdrawals targeting the deleted address will be rejected.
      Parameters:
      whitelistedAddressId - The whitelisted address to delete (required)
      Returns:
      ApiResponse<Void>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      HTTP Response Details:
      Response Details
      Status Code Description Response Headers
      200 Successfully deleted a whitelisted address -

    • deleteWhitelistedAddressAsync

      public okhttp3.Call deleteWhitelistedAddressAsync(@Nonnull String whitelistedAddressId, ApiCallback<Void> _callback) throws ApiException
      Delete a whitelisted address (asynchronously) Deletes a whitelisted withdrawal address by ID. Subsequent withdrawals targeting the deleted address will be rejected.
      Parameters:
      whitelistedAddressId - The whitelisted address to delete (required)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object
      HTTP Response Details:
      Response Details
      Status Code Description Response Headers
      200 Successfully deleted a whitelisted address -

    • getCryptoFundingTransferCall

      public okhttp3.Call getCryptoFundingTransferCall(@Nonnull String transferId, ApiCallback _callback) throws ApiException
      Build call for getCryptoFundingTransfer
      Parameters:
      transferId - The crypto transfer to retrieve (required)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
      HTTP Response Details:
      Response Details
      Status Code Description Response Headers
      200 A single crypto transfer object -

    • getCryptoFundingTransfer

      public CryptoTransfer getCryptoFundingTransfer(@Nonnull String transferId) throws ApiException
      Retrieve a Crypto Funding Transfer Returns a specific wallet transfer by passing into the query the transfer_id.
      Parameters:
      transferId - The crypto transfer to retrieve (required)
      Returns:
      CryptoTransfer
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      HTTP Response Details:
      Response Details
      Status Code Description Response Headers
      200 A single crypto transfer object -

    • getCryptoFundingTransferWithHttpInfo

      public ApiResponse<CryptoTransfer> getCryptoFundingTransferWithHttpInfo(@Nonnull String transferId) throws ApiException
      Retrieve a Crypto Funding Transfer Returns a specific wallet transfer by passing into the query the transfer_id.
      Parameters:
      transferId - The crypto transfer to retrieve (required)
      Returns:
      ApiResponse<CryptoTransfer>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      HTTP Response Details:
      Response Details
      Status Code Description Response Headers
      200 A single crypto transfer object -

    • getCryptoFundingTransferAsync

      public okhttp3.Call getCryptoFundingTransferAsync(@Nonnull String transferId, ApiCallback<CryptoTransfer> _callback) throws ApiException
      Retrieve a Crypto Funding Transfer (asynchronously) Returns a specific wallet transfer by passing into the query the transfer_id.
      Parameters:
      transferId - The crypto transfer to retrieve (required)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object
      HTTP Response Details:
      Response Details
      Status Code Description Response Headers
      200 A single crypto transfer object -

    • getCryptoTransferEstimateCall

      public okhttp3.Call getCryptoTransferEstimateCall(@Nullable String asset, @Nullable String fromAddress, @Nullable String toAddress, @Nullable String amount, ApiCallback _callback) throws ApiException
      Build call for getCryptoTransferEstimate
      Parameters:
      asset - The asset for the proposed transaction (optional)
      fromAddress - The originating address of the proposed transaction (optional)
      toAddress - The destination address of the proposed transaction (optional)
      amount - The amount, denoted in the specified asset, of the proposed transaction (optional)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
      HTTP Response Details:
      Response Details
      Status Code Description Response Headers
      200 OK -

    • getCryptoTransferEstimate

      public WalletFeeEstimateResponse getCryptoTransferEstimate(@Nullable String asset, @Nullable String fromAddress, @Nullable String toAddress, @Nullable String amount) throws ApiException
      Returns the estimated gas fee for a proposed transaction. Returns the estimated on-chain network (gas) fee for a proposed crypto withdrawal at current chain conditions. Pass the `asset`, `from_address`, `to_address`, and `amount` you intend to send; the response reports the network fee that would be charged for the corresponding transaction.
      Parameters:
      asset - The asset for the proposed transaction (optional)
      fromAddress - The originating address of the proposed transaction (optional)
      toAddress - The destination address of the proposed transaction (optional)
      amount - The amount, denoted in the specified asset, of the proposed transaction (optional)
      Returns:
      WalletFeeEstimateResponse
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      HTTP Response Details:
      Response Details
      Status Code Description Response Headers
      200 OK -

    • getCryptoTransferEstimateWithHttpInfo

      public ApiResponse<WalletFeeEstimateResponse> getCryptoTransferEstimateWithHttpInfo(@Nullable String asset, @Nullable String fromAddress, @Nullable String toAddress, @Nullable String amount) throws ApiException
      Returns the estimated gas fee for a proposed transaction. Returns the estimated on-chain network (gas) fee for a proposed crypto withdrawal at current chain conditions. Pass the `asset`, `from_address`, `to_address`, and `amount` you intend to send; the response reports the network fee that would be charged for the corresponding transaction.
      Parameters:
      asset - The asset for the proposed transaction (optional)
      fromAddress - The originating address of the proposed transaction (optional)
      toAddress - The destination address of the proposed transaction (optional)
      amount - The amount, denoted in the specified asset, of the proposed transaction (optional)
      Returns:
      ApiResponse<WalletFeeEstimateResponse>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      HTTP Response Details:
      Response Details
      Status Code Description Response Headers
      200 OK -

    • getCryptoTransferEstimateAsync

      public okhttp3.Call getCryptoTransferEstimateAsync(@Nullable String asset, @Nullable String fromAddress, @Nullable String toAddress, @Nullable String amount, ApiCallback<WalletFeeEstimateResponse> _callback) throws ApiException
      Returns the estimated gas fee for a proposed transaction. (asynchronously) Returns the estimated on-chain network (gas) fee for a proposed crypto withdrawal at current chain conditions. Pass the `asset`, `from_address`, `to_address`, and `amount` you intend to send; the response reports the network fee that would be charged for the corresponding transaction.
      Parameters:
      asset - The asset for the proposed transaction (optional)
      fromAddress - The originating address of the proposed transaction (optional)
      toAddress - The destination address of the proposed transaction (optional)
      amount - The amount, denoted in the specified asset, of the proposed transaction (optional)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object
      HTTP Response Details:
      Response Details
      Status Code Description Response Headers
      200 OK -

    • listCryptoFundingTransfersCall

      public okhttp3.Call listCryptoFundingTransfersCall(ApiCallback _callback) throws ApiException
      Build call for listCryptoFundingTransfers
      Parameters:
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
      HTTP Response Details:
      Response Details
      Status Code Description Response Headers
      200 An array of transfer objects -

    • listCryptoFundingTransfers

      public CryptoTransfer listCryptoFundingTransfers() throws ApiException
      Retrieve Crypto Funding Transfers Returns an array of all transfers associated with the given account across all wallets.
      Returns:
      CryptoTransfer
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      HTTP Response Details:
      Response Details
      Status Code Description Response Headers
      200 An array of transfer objects -

    • listCryptoFundingTransfersWithHttpInfo

      public ApiResponse<CryptoTransfer> listCryptoFundingTransfersWithHttpInfo() throws ApiException
      Retrieve Crypto Funding Transfers Returns an array of all transfers associated with the given account across all wallets.
      Returns:
      ApiResponse<CryptoTransfer>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      HTTP Response Details:
      Response Details
      Status Code Description Response Headers
      200 An array of transfer objects -

    • listCryptoFundingTransfersAsync

      public okhttp3.Call listCryptoFundingTransfersAsync(ApiCallback<CryptoTransfer> _callback) throws ApiException
      Retrieve Crypto Funding Transfers (asynchronously) Returns an array of all transfers associated with the given account across all wallets.
      Parameters:
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object
      HTTP Response Details:
      Response Details
      Status Code Description Response Headers
      200 An array of transfer objects -

    • listCryptoFundingWalletsCall

      public okhttp3.Call listCryptoFundingWalletsCall(@Nullable String asset, @Nullable CryptoChain chain, @Nullable String network, ApiCallback _callback) throws ApiException
      Build call for listCryptoFundingWallets
      Parameters:
      asset - Filter by crypto asset symbol, e.g. BTC, ETH, USDT. If specified and no wallet exists, one will be created. (optional)
      chain - Optional chain identifier. Use to request wallets for a specific chain when asset is a multi-chain crypto asset. If not specified, network is considered. (optional)
      network - Deprecated. Use chain instead. Optional network identifier which is used to request wallets for a specific network when asset is a multi-chain crypto asset. When both 'chain' and 'network' are specified, 'chain' will take precedence and 'network' will be ignored. If 'chain' and 'network' are not specified, the default 'network' (ethereum) will be used. (optional)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
      HTTP Response Details:
      Response Details
      Status Code Description Response Headers
      200 A single wallet object if an asset is specified or an array of wallet objects if no asset is specified -

    • listCryptoFundingWallets

      public CryptoWallet listCryptoFundingWallets(@Nullable String asset, @Nullable CryptoChain chain, @Nullable String network) throws ApiException
      Retrieve Crypto Funding Wallets Lists wallets for the account given in the path parameter. If an asset is specified and no wallet for the account and asset pair exists one will be created. If no asset is specified only existing wallets will be listed for the account. An account may have at most one wallet per asset.
      Parameters:
      asset - Filter by crypto asset symbol, e.g. BTC, ETH, USDT. If specified and no wallet exists, one will be created. (optional)
      chain - Optional chain identifier. Use to request wallets for a specific chain when asset is a multi-chain crypto asset. If not specified, network is considered. (optional)
      network - Deprecated. Use chain instead. Optional network identifier which is used to request wallets for a specific network when asset is a multi-chain crypto asset. When both 'chain' and 'network' are specified, 'chain' will take precedence and 'network' will be ignored. If 'chain' and 'network' are not specified, the default 'network' (ethereum) will be used. (optional)
      Returns:
      CryptoWallet
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      HTTP Response Details:
      Response Details
      Status Code Description Response Headers
      200 A single wallet object if an asset is specified or an array of wallet objects if no asset is specified -

    • listCryptoFundingWalletsWithHttpInfo

      public ApiResponse<CryptoWallet> listCryptoFundingWalletsWithHttpInfo(@Nullable String asset, @Nullable CryptoChain chain, @Nullable String network) throws ApiException
      Retrieve Crypto Funding Wallets Lists wallets for the account given in the path parameter. If an asset is specified and no wallet for the account and asset pair exists one will be created. If no asset is specified only existing wallets will be listed for the account. An account may have at most one wallet per asset.
      Parameters:
      asset - Filter by crypto asset symbol, e.g. BTC, ETH, USDT. If specified and no wallet exists, one will be created. (optional)
      chain - Optional chain identifier. Use to request wallets for a specific chain when asset is a multi-chain crypto asset. If not specified, network is considered. (optional)
      network - Deprecated. Use chain instead. Optional network identifier which is used to request wallets for a specific network when asset is a multi-chain crypto asset. When both 'chain' and 'network' are specified, 'chain' will take precedence and 'network' will be ignored. If 'chain' and 'network' are not specified, the default 'network' (ethereum) will be used. (optional)
      Returns:
      ApiResponse<CryptoWallet>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      HTTP Response Details:
      Response Details
      Status Code Description Response Headers
      200 A single wallet object if an asset is specified or an array of wallet objects if no asset is specified -

    • listCryptoFundingWalletsAsync

      public okhttp3.Call listCryptoFundingWalletsAsync(@Nullable String asset, @Nullable CryptoChain chain, @Nullable String network, ApiCallback<CryptoWallet> _callback) throws ApiException
      Retrieve Crypto Funding Wallets (asynchronously) Lists wallets for the account given in the path parameter. If an asset is specified and no wallet for the account and asset pair exists one will be created. If no asset is specified only existing wallets will be listed for the account. An account may have at most one wallet per asset.
      Parameters:
      asset - Filter by crypto asset symbol, e.g. BTC, ETH, USDT. If specified and no wallet exists, one will be created. (optional)
      chain - Optional chain identifier. Use to request wallets for a specific chain when asset is a multi-chain crypto asset. If not specified, network is considered. (optional)
      network - Deprecated. Use chain instead. Optional network identifier which is used to request wallets for a specific network when asset is a multi-chain crypto asset. When both 'chain' and 'network' are specified, 'chain' will take precedence and 'network' will be ignored. If 'chain' and 'network' are not specified, the default 'network' (ethereum) will be used. (optional)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object
      HTTP Response Details:
      Response Details
      Status Code Description Response Headers
      200 A single wallet object if an asset is specified or an array of wallet objects if no asset is specified -

    • listWhitelistedAddressCall

      public okhttp3.Call listWhitelistedAddressCall(ApiCallback _callback) throws ApiException
      Build call for listWhitelistedAddress
      Parameters:
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
      HTTP Response Details:
      Response Details
      Status Code Description Response Headers
      200 An array of whitelisted objects -

    • listWhitelistedAddress

      public WhitelistedAddress listWhitelistedAddress() throws ApiException
      An array of whitelisted addresses Returns the list of whitelisted withdrawal addresses for your account.
      Returns:
      WhitelistedAddress
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      HTTP Response Details:
      Response Details
      Status Code Description Response Headers
      200 An array of whitelisted objects -

    • listWhitelistedAddressWithHttpInfo

      public ApiResponse<WhitelistedAddress> listWhitelistedAddressWithHttpInfo() throws ApiException
      An array of whitelisted addresses Returns the list of whitelisted withdrawal addresses for your account.
      Returns:
      ApiResponse<WhitelistedAddress>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      HTTP Response Details:
      Response Details
      Status Code Description Response Headers
      200 An array of whitelisted objects -

    • listWhitelistedAddressAsync

      public okhttp3.Call listWhitelistedAddressAsync(ApiCallback<WhitelistedAddress> _callback) throws ApiException
      An array of whitelisted addresses (asynchronously) Returns the list of whitelisted withdrawal addresses for your account.
      Parameters:
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object
      HTTP Response Details:
      Response Details
      Status Code Description Response Headers
      200 An array of whitelisted objects -

    • searchVASPsCall

      public okhttp3.Call searchVASPsCall(@Nullable String q, @Nullable String emailDomain, @Nullable String chainalysisName, @Nullable String fields, @Nullable Integer page, @Nullable Integer perPage, @Nullable String order, @Nullable Boolean includeSubsidiaryVASPs, ApiCallback _callback) throws ApiException
      Build call for searchVASPs
      Parameters:
      q - General search query string. (optional)
      emailDomain - Filter by VASP email domain. (optional)
      chainalysisName - Filter by Chainalysis-specific VASP name. (optional)
      fields - Specify which fields to return (comma-separated). (optional)
      page - The zero-based page number to retrieve. (optional, default to 0)
      perPage - Number of items per page. (optional, default to 10)
      order - Field-based sort expression, such as name:ASC. Multiple expressions may be comma-separated. Defaults to name:ASC. (optional, default to name:ASC)
      includeSubsidiaryVASPs - Whether to include child/subsidiary entities. (optional, default to false)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
      HTTP Response Details:
      Response Details
      Status Code Description Response Headers
      200 Successful request. Returns an array of VASPs or an empty list if no matches found. -

    • searchVASPs

      public SearchVASPsResponse searchVASPs(@Nullable String q, @Nullable String emailDomain, @Nullable String chainalysisName, @Nullable String fields, @Nullable Integer page, @Nullable Integer perPage, @Nullable String order, @Nullable Boolean includeSubsidiaryVASPs) throws ApiException
      Search for VASPs Search for Virtual Asset Service Providers, or crypto exchanges, on Notabene's network. This endpoint can be used to find the VASP DID for your beneficiary's exchange when submitting travel rule information for your whitelisted wallets. Use the `q` parameter to search for exchanges.
      Parameters:
      q - General search query string. (optional)
      emailDomain - Filter by VASP email domain. (optional)
      chainalysisName - Filter by Chainalysis-specific VASP name. (optional)
      fields - Specify which fields to return (comma-separated). (optional)
      page - The zero-based page number to retrieve. (optional, default to 0)
      perPage - Number of items per page. (optional, default to 10)
      order - Field-based sort expression, such as name:ASC. Multiple expressions may be comma-separated. Defaults to name:ASC. (optional, default to name:ASC)
      includeSubsidiaryVASPs - Whether to include child/subsidiary entities. (optional, default to false)
      Returns:
      SearchVASPsResponse
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      HTTP Response Details:
      Response Details
      Status Code Description Response Headers
      200 Successful request. Returns an array of VASPs or an empty list if no matches found. -

    • searchVASPsWithHttpInfo

      public ApiResponse<SearchVASPsResponse> searchVASPsWithHttpInfo(@Nullable String q, @Nullable String emailDomain, @Nullable String chainalysisName, @Nullable String fields, @Nullable Integer page, @Nullable Integer perPage, @Nullable String order, @Nullable Boolean includeSubsidiaryVASPs) throws ApiException
      Search for VASPs Search for Virtual Asset Service Providers, or crypto exchanges, on Notabene's network. This endpoint can be used to find the VASP DID for your beneficiary's exchange when submitting travel rule information for your whitelisted wallets. Use the `q` parameter to search for exchanges.
      Parameters:
      q - General search query string. (optional)
      emailDomain - Filter by VASP email domain. (optional)
      chainalysisName - Filter by Chainalysis-specific VASP name. (optional)
      fields - Specify which fields to return (comma-separated). (optional)
      page - The zero-based page number to retrieve. (optional, default to 0)
      perPage - Number of items per page. (optional, default to 10)
      order - Field-based sort expression, such as name:ASC. Multiple expressions may be comma-separated. Defaults to name:ASC. (optional, default to name:ASC)
      includeSubsidiaryVASPs - Whether to include child/subsidiary entities. (optional, default to false)
      Returns:
      ApiResponse<SearchVASPsResponse>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      HTTP Response Details:
      Response Details
      Status Code Description Response Headers
      200 Successful request. Returns an array of VASPs or an empty list if no matches found. -

    • searchVASPsAsync

      public okhttp3.Call searchVASPsAsync(@Nullable String q, @Nullable String emailDomain, @Nullable String chainalysisName, @Nullable String fields, @Nullable Integer page, @Nullable Integer perPage, @Nullable String order, @Nullable Boolean includeSubsidiaryVASPs, ApiCallback<SearchVASPsResponse> _callback) throws ApiException
      Search for VASPs (asynchronously) Search for Virtual Asset Service Providers, or crypto exchanges, on Notabene's network. This endpoint can be used to find the VASP DID for your beneficiary's exchange when submitting travel rule information for your whitelisted wallets. Use the `q` parameter to search for exchanges.
      Parameters:
      q - General search query string. (optional)
      emailDomain - Filter by VASP email domain. (optional)
      chainalysisName - Filter by Chainalysis-specific VASP name. (optional)
      fields - Specify which fields to return (comma-separated). (optional)
      page - The zero-based page number to retrieve. (optional, default to 0)
      perPage - Number of items per page. (optional, default to 10)
      order - Field-based sort expression, such as name:ASC. Multiple expressions may be comma-separated. Defaults to name:ASC. (optional, default to name:ASC)
      includeSubsidiaryVASPs - Whether to include child/subsidiary entities. (optional, default to false)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object
      HTTP Response Details:
      Response Details
      Status Code Description Response Headers
      200 Successful request. Returns an array of VASPs or an empty list if no matches found. -

    • updateWhitelistedAddressTravelRuleInfoCall

      public okhttp3.Call updateWhitelistedAddressTravelRuleInfoCall(@Nonnull UUID whitelistedAddressId, @Nonnull UpdateWhitelistedAddressTravelRuleInfoRequest updateWhitelistedAddressTravelRuleInfoRequest, ApiCallback _callback) throws ApiException
      Build call for updateWhitelistedAddressTravelRuleInfo
      Parameters:
      whitelistedAddressId - The whitelisted address update travel rule information for (required)
      updateWhitelistedAddressTravelRuleInfoRequest - Travel rule information to associate with the whitelisted address. (required)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
      HTTP Response Details:
      Response Details
      Status Code Description Response Headers
      200 Successfully updated travel rule information -
      400 The request or travel rule information is invalid. -

    • updateWhitelistedAddressTravelRuleInfo

      public void updateWhitelistedAddressTravelRuleInfo(@Nonnull UUID whitelistedAddressId, @Nonnull UpdateWhitelistedAddressTravelRuleInfoRequest updateWhitelistedAddressTravelRuleInfoRequest) throws ApiException
      Update travel rule information for a whitelisted wallet You are required to supply travel rule information for the crypto wallets you're withdrawing to. It is preferred that you use the `Search VASPs` endpoint to find the VASP DID for the exchange you are withdrawing to, otherwise, if it's a self-hosted wallet, please set `beneficiary_is_self_hosted` to true. If the exchange cannot be found in our directory, please supply the information manually using the `beneficiary_manual_entry` object.
      Parameters:
      whitelistedAddressId - The whitelisted address update travel rule information for (required)
      updateWhitelistedAddressTravelRuleInfoRequest - Travel rule information to associate with the whitelisted address. (required)
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      HTTP Response Details:
      Response Details
      Status Code Description Response Headers
      200 Successfully updated travel rule information -
      400 The request or travel rule information is invalid. -

    • updateWhitelistedAddressTravelRuleInfoWithHttpInfo

      public ApiResponse<Void> updateWhitelistedAddressTravelRuleInfoWithHttpInfo(@Nonnull UUID whitelistedAddressId, @Nonnull UpdateWhitelistedAddressTravelRuleInfoRequest updateWhitelistedAddressTravelRuleInfoRequest) throws ApiException
      Update travel rule information for a whitelisted wallet You are required to supply travel rule information for the crypto wallets you're withdrawing to. It is preferred that you use the `Search VASPs` endpoint to find the VASP DID for the exchange you are withdrawing to, otherwise, if it's a self-hosted wallet, please set `beneficiary_is_self_hosted` to true. If the exchange cannot be found in our directory, please supply the information manually using the `beneficiary_manual_entry` object.
      Parameters:
      whitelistedAddressId - The whitelisted address update travel rule information for (required)
      updateWhitelistedAddressTravelRuleInfoRequest - Travel rule information to associate with the whitelisted address. (required)
      Returns:
      ApiResponse<Void>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      HTTP Response Details:
      Response Details
      Status Code Description Response Headers
      200 Successfully updated travel rule information -
      400 The request or travel rule information is invalid. -

    • updateWhitelistedAddressTravelRuleInfoAsync

      public okhttp3.Call updateWhitelistedAddressTravelRuleInfoAsync(@Nonnull UUID whitelistedAddressId, @Nonnull UpdateWhitelistedAddressTravelRuleInfoRequest updateWhitelistedAddressTravelRuleInfoRequest, ApiCallback<Void> _callback) throws ApiException
      Update travel rule information for a whitelisted wallet (asynchronously) You are required to supply travel rule information for the crypto wallets you're withdrawing to. It is preferred that you use the `Search VASPs` endpoint to find the VASP DID for the exchange you are withdrawing to, otherwise, if it's a self-hosted wallet, please set `beneficiary_is_self_hosted` to true. If the exchange cannot be found in our directory, please supply the information manually using the `beneficiary_manual_entry` object.
      Parameters:
      whitelistedAddressId - The whitelisted address update travel rule information for (required)
      updateWhitelistedAddressTravelRuleInfoRequest - Travel rule information to associate with the whitelisted address. (required)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object
      HTTP Response Details:
      Response Details
      Status Code Description Response Headers
      200 Successfully updated travel rule information -
      400 The request or travel rule information is invalid. -