Package markets.alpaca.client.openapi.broker.api

Class FundingWalletsApi

java.lang.Object
markets.alpaca.client.openapi.broker.api.FundingWalletsApi
public class FundingWalletsApi extends Object
Generated client for FundingWalletsApi 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

  • batchCreateFundingWallets: Batch create funding wallets
  • createFundingWallet: Creates a funding wallet
  • createFundingWalletRecipientBank: Create a recipient bank
  • createFundingWalletWithdrawal: Create a withdrawal
  • deleteFundingWalletRecipientBank: Delete a recipient bank
  • demoDepositFunding: Create sandbox deposit transfer
  • getFundingWallet: Retrieve funding wallet
  • getFundingWalletRecipientBank: Retrieve recipient bank
  • getFundingWalletTransferByID: Retrieve funding wallet transfer by ID
  • getFundingWalletTransfers: Retrieve funding wallet transfers
  • listFundingDetails: Retrieve funding details

  • Constructor Details

    • FundingWalletsApi

      public FundingWalletsApi()

    • FundingWalletsApi

      public FundingWalletsApi(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)

    • batchCreateFundingWalletsCall

      public okhttp3.Call batchCreateFundingWalletsCall(@Nonnull BatchCreateFundingWalletRequest batchCreateFundingWalletRequest, ApiCallback _callback) throws ApiException
      Build call for batchCreateFundingWallets
      Parameters:
      batchCreateFundingWalletRequest - (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 Funding wallets -
      0 Error response. -

    • batchCreateFundingWallets

      public BatchCreateFundingWalletResponse batchCreateFundingWallets(@Nonnull BatchCreateFundingWalletRequest batchCreateFundingWalletRequest) throws ApiException
      Batch create funding wallets Creates funding wallets for a list of accounts in a single request. Every `account_id` in the request must belong to your firm, and the request is rejected if a funding wallet already exists for any of the supplied accounts.
      Parameters:
      batchCreateFundingWalletRequest - (required)
      Returns:
      BatchCreateFundingWalletResponse
      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 Funding wallets -
      0 Error response. -

    • batchCreateFundingWalletsWithHttpInfo

      public ApiResponse<BatchCreateFundingWalletResponse> batchCreateFundingWalletsWithHttpInfo(@Nonnull BatchCreateFundingWalletRequest batchCreateFundingWalletRequest) throws ApiException
      Batch create funding wallets Creates funding wallets for a list of accounts in a single request. Every `account_id` in the request must belong to your firm, and the request is rejected if a funding wallet already exists for any of the supplied accounts.
      Parameters:
      batchCreateFundingWalletRequest - (required)
      Returns:
      ApiResponse<BatchCreateFundingWalletResponse>
      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 Funding wallets -
      0 Error response. -

    • batchCreateFundingWalletsAsync

      public okhttp3.Call batchCreateFundingWalletsAsync(@Nonnull BatchCreateFundingWalletRequest batchCreateFundingWalletRequest, ApiCallback<BatchCreateFundingWalletResponse> _callback) throws ApiException
      Batch create funding wallets (asynchronously) Creates funding wallets for a list of accounts in a single request. Every `account_id` in the request must belong to your firm, and the request is rejected if a funding wallet already exists for any of the supplied accounts.
      Parameters:
      batchCreateFundingWalletRequest - (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 Funding wallets -
      0 Error response. -

    • createFundingWalletCall

      public okhttp3.Call createFundingWalletCall(@Nonnull String accountId, ApiCallback _callback) throws ApiException
      Build call for createFundingWallet
      Parameters:
      accountId - UUID alpaca account ID (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 funding wallet -
      0 error -

    • createFundingWallet

      public FundingWallet createFundingWallet(@Nonnull String accountId) throws ApiException
      Creates a funding wallet Creates a funding wallet for the specified account. The request is rejected if the account already has a funding wallet.
      Parameters:
      accountId - UUID alpaca account ID (required)
      Returns:
      FundingWallet
      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 funding wallet -
      0 error -

    • createFundingWalletWithHttpInfo

      public ApiResponse<FundingWallet> createFundingWalletWithHttpInfo(@Nonnull String accountId) throws ApiException
      Creates a funding wallet Creates a funding wallet for the specified account. The request is rejected if the account already has a funding wallet.
      Parameters:
      accountId - UUID alpaca account ID (required)
      Returns:
      ApiResponse<FundingWallet>
      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 funding wallet -
      0 error -

    • createFundingWalletAsync

      public okhttp3.Call createFundingWalletAsync(@Nonnull String accountId, ApiCallback<FundingWallet> _callback) throws ApiException
      Creates a funding wallet (asynchronously) Creates a funding wallet for the specified account. The request is rejected if the account already has a funding wallet.
      Parameters:
      accountId - UUID alpaca account ID (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 funding wallet -
      0 error -

    • createFundingWalletRecipientBankCall

      public okhttp3.Call createFundingWalletRecipientBankCall(@Nonnull String accountId, @Nullable CreateFundingWalletRecipientBankRequest createFundingWalletRecipientBankRequest, ApiCallback _callback) throws ApiException
      Build call for createFundingWalletRecipientBank
      Parameters:
      accountId - UUID alpaca account ID (required)
      createFundingWalletRecipientBankRequest - (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 Success. -
      0 error -

    • createFundingWalletRecipientBank

      public FundingWalletRecipientBank createFundingWalletRecipientBank(@Nonnull String accountId, @Nullable CreateFundingWalletRecipientBankRequest createFundingWalletRecipientBankRequest) throws ApiException
      Create a recipient bank Creates a new recipient bank. Returns the new recipient bank entity on success. entity.
      Parameters:
      accountId - UUID alpaca account ID (required)
      createFundingWalletRecipientBankRequest - (optional)
      Returns:
      FundingWalletRecipientBank
      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 Success. -
      0 error -

    • createFundingWalletRecipientBankWithHttpInfo

      public ApiResponse<FundingWalletRecipientBank> createFundingWalletRecipientBankWithHttpInfo(@Nonnull String accountId, @Nullable CreateFundingWalletRecipientBankRequest createFundingWalletRecipientBankRequest) throws ApiException
      Create a recipient bank Creates a new recipient bank. Returns the new recipient bank entity on success. entity.
      Parameters:
      accountId - UUID alpaca account ID (required)
      createFundingWalletRecipientBankRequest - (optional)
      Returns:
      ApiResponse<FundingWalletRecipientBank>
      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 Success. -
      0 error -

    • createFundingWalletRecipientBankAsync

      public okhttp3.Call createFundingWalletRecipientBankAsync(@Nonnull String accountId, @Nullable CreateFundingWalletRecipientBankRequest createFundingWalletRecipientBankRequest, ApiCallback<FundingWalletRecipientBank> _callback) throws ApiException
      Create a recipient bank (asynchronously) Creates a new recipient bank. Returns the new recipient bank entity on success. entity.
      Parameters:
      accountId - UUID alpaca account ID (required)
      createFundingWalletRecipientBankRequest - (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 Success. -
      0 error -

    • createFundingWalletWithdrawalCall

      public okhttp3.Call createFundingWalletWithdrawalCall(@Nonnull String accountId, @Nonnull CreateFundingWalletWithdrawalRequest createFundingWalletWithdrawalRequest, ApiCallback _callback) throws ApiException
      Build call for createFundingWalletWithdrawal
      Parameters:
      accountId - UUID alpaca account ID (required)
      createFundingWalletWithdrawalRequest - (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 Transfer -
      0 Error response. -

    • createFundingWalletWithdrawal

      public FundingWalletTransfer createFundingWalletWithdrawal(@Nonnull String accountId, @Nonnull CreateFundingWalletWithdrawalRequest createFundingWalletWithdrawalRequest) throws ApiException
      Create a withdrawal Creates a withdrawal
      Parameters:
      accountId - UUID alpaca account ID (required)
      createFundingWalletWithdrawalRequest - (required)
      Returns:
      FundingWalletTransfer
      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 Transfer -
      0 Error response. -

    • createFundingWalletWithdrawalWithHttpInfo

      public ApiResponse<FundingWalletTransfer> createFundingWalletWithdrawalWithHttpInfo(@Nonnull String accountId, @Nonnull CreateFundingWalletWithdrawalRequest createFundingWalletWithdrawalRequest) throws ApiException
      Create a withdrawal Creates a withdrawal
      Parameters:
      accountId - UUID alpaca account ID (required)
      createFundingWalletWithdrawalRequest - (required)
      Returns:
      ApiResponse<FundingWalletTransfer>
      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 Transfer -
      0 Error response. -

    • createFundingWalletWithdrawalAsync

      public okhttp3.Call createFundingWalletWithdrawalAsync(@Nonnull String accountId, @Nonnull CreateFundingWalletWithdrawalRequest createFundingWalletWithdrawalRequest, ApiCallback<FundingWalletTransfer> _callback) throws ApiException
      Create a withdrawal (asynchronously) Creates a withdrawal
      Parameters:
      accountId - UUID alpaca account ID (required)
      createFundingWalletWithdrawalRequest - (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 Transfer -
      0 Error response. -

    • deleteFundingWalletRecipientBankCall

      public okhttp3.Call deleteFundingWalletRecipientBankCall(@Nonnull String accountId, ApiCallback _callback) throws ApiException
      Build call for deleteFundingWalletRecipientBank
      Parameters:
      accountId - UUID alpaca account ID (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 recipient bank -
      0 Error response. -

    • deleteFundingWalletRecipientBank

      public void deleteFundingWalletRecipientBank(@Nonnull String accountId) throws ApiException
      Delete a recipient bank deletes a recipient bank.
      Parameters:
      accountId - UUID alpaca account ID (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 recipient bank -
      0 Error response. -

    • deleteFundingWalletRecipientBankWithHttpInfo

      public ApiResponse<Void> deleteFundingWalletRecipientBankWithHttpInfo(@Nonnull String accountId) throws ApiException
      Delete a recipient bank deletes a recipient bank.
      Parameters:
      accountId - UUID alpaca account ID (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 recipient bank -
      0 Error response. -

    • deleteFundingWalletRecipientBankAsync

      public okhttp3.Call deleteFundingWalletRecipientBankAsync(@Nonnull String accountId, ApiCallback<Void> _callback) throws ApiException
      Delete a recipient bank (asynchronously) deletes a recipient bank.
      Parameters:
      accountId - UUID alpaca account ID (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 recipient bank -
      0 Error response. -

    • demoDepositFundingCall

      public okhttp3.Call demoDepositFundingCall(@Nonnull DemoFundingTransfer demoFundingTransfer, ApiCallback _callback) throws ApiException
      Build call for demoDepositFunding
      Parameters:
      demoFundingTransfer - (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 Demo deposit funding transfer -
      0 Error response. -

    • demoDepositFunding

      public DemoFundingTransfer demoDepositFunding(@Nonnull DemoFundingTransfer demoFundingTransfer) throws ApiException
      Create sandbox deposit transfer Simulates an inbound deposit into an account's funding wallet for end-to-end testing of the deposit flow. The transfer can only credit accounts that belong to your firm. Available in non-production (sandbox) environments only.
      Parameters:
      demoFundingTransfer - (required)
      Returns:
      DemoFundingTransfer
      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 Demo deposit funding transfer -
      0 Error response. -

    • demoDepositFundingWithHttpInfo

      public ApiResponse<DemoFundingTransfer> demoDepositFundingWithHttpInfo(@Nonnull DemoFundingTransfer demoFundingTransfer) throws ApiException
      Create sandbox deposit transfer Simulates an inbound deposit into an account's funding wallet for end-to-end testing of the deposit flow. The transfer can only credit accounts that belong to your firm. Available in non-production (sandbox) environments only.
      Parameters:
      demoFundingTransfer - (required)
      Returns:
      ApiResponse<DemoFundingTransfer>
      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 Demo deposit funding transfer -
      0 Error response. -

    • demoDepositFundingAsync

      public okhttp3.Call demoDepositFundingAsync(@Nonnull DemoFundingTransfer demoFundingTransfer, ApiCallback<DemoFundingTransfer> _callback) throws ApiException
      Create sandbox deposit transfer (asynchronously) Simulates an inbound deposit into an account's funding wallet for end-to-end testing of the deposit flow. The transfer can only credit accounts that belong to your firm. Available in non-production (sandbox) environments only.
      Parameters:
      demoFundingTransfer - (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 Demo deposit funding transfer -
      0 Error response. -

    • getFundingWalletCall

      public okhttp3.Call getFundingWalletCall(@Nonnull String accountId, ApiCallback _callback) throws ApiException
      Build call for getFundingWallet
      Parameters:
      accountId - UUID alpaca account ID (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 funding wallet -
      0 error -

    • getFundingWallet

      public FundingWallet getFundingWallet(@Nonnull String accountId) throws ApiException
      Retrieve funding wallet Returns the funding wallet for the specified account. Responds with 404 if the account has not been onboarded to funding wallets or a wallet has not been created.
      Parameters:
      accountId - UUID alpaca account ID (required)
      Returns:
      FundingWallet
      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 funding wallet -
      0 error -

    • getFundingWalletWithHttpInfo

      public ApiResponse<FundingWallet> getFundingWalletWithHttpInfo(@Nonnull String accountId) throws ApiException
      Retrieve funding wallet Returns the funding wallet for the specified account. Responds with 404 if the account has not been onboarded to funding wallets or a wallet has not been created.
      Parameters:
      accountId - UUID alpaca account ID (required)
      Returns:
      ApiResponse<FundingWallet>
      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 funding wallet -
      0 error -

    • getFundingWalletAsync

      public okhttp3.Call getFundingWalletAsync(@Nonnull String accountId, ApiCallback<FundingWallet> _callback) throws ApiException
      Retrieve funding wallet (asynchronously) Returns the funding wallet for the specified account. Responds with 404 if the account has not been onboarded to funding wallets or a wallet has not been created.
      Parameters:
      accountId - UUID alpaca account ID (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 funding wallet -
      0 error -

    • getFundingWalletRecipientBankCall

      public okhttp3.Call getFundingWalletRecipientBankCall(@Nonnull String accountId, ApiCallback _callback) throws ApiException
      Build call for getFundingWalletRecipientBank
      Parameters:
      accountId - UUID alpaca account ID (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 recipient bank -
      0 Error response. -

    • getFundingWalletRecipientBank

      public void getFundingWalletRecipientBank(@Nonnull String accountId) throws ApiException
      Retrieve recipient bank Returns the recipient bank registered against the specified account's funding wallet. Responds with 404 if no recipient bank has been registered for the account.
      Parameters:
      accountId - UUID alpaca account ID (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 recipient bank -
      0 Error response. -

    • getFundingWalletRecipientBankWithHttpInfo

      public ApiResponse<Void> getFundingWalletRecipientBankWithHttpInfo(@Nonnull String accountId) throws ApiException
      Retrieve recipient bank Returns the recipient bank registered against the specified account's funding wallet. Responds with 404 if no recipient bank has been registered for the account.
      Parameters:
      accountId - UUID alpaca account ID (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 recipient bank -
      0 Error response. -

    • getFundingWalletRecipientBankAsync

      public okhttp3.Call getFundingWalletRecipientBankAsync(@Nonnull String accountId, ApiCallback<Void> _callback) throws ApiException
      Retrieve recipient bank (asynchronously) Returns the recipient bank registered against the specified account's funding wallet. Responds with 404 if no recipient bank has been registered for the account.
      Parameters:
      accountId - UUID alpaca account ID (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 recipient bank -
      0 Error response. -

    • getFundingWalletTransferByIDCall

      public okhttp3.Call getFundingWalletTransferByIDCall(@Nonnull String accountId, @Nonnull String transferId, ApiCallback _callback) throws ApiException
      Build call for getFundingWalletTransferByID
      Parameters:
      accountId - Alpaca account UUID (required)
      transferId - transfer UUID (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 transfer response if found -
      404 error response if transfer is not found -
      0 error -

    • getFundingWalletTransferByID

      public FundingWalletTransfer getFundingWalletTransferByID(@Nonnull String accountId, @Nonnull String transferId) throws ApiException
      Retrieve funding wallet transfer by ID Returns a single funding wallet transfer for the specified account by `transfer_id`. Responds with 404 if no matching transfer exists for the account.
      Parameters:
      accountId - Alpaca account UUID (required)
      transferId - transfer UUID (required)
      Returns:
      FundingWalletTransfer
      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 transfer response if found -
      404 error response if transfer is not found -
      0 error -

    • getFundingWalletTransferByIDWithHttpInfo

      public ApiResponse<FundingWalletTransfer> getFundingWalletTransferByIDWithHttpInfo(@Nonnull String accountId, @Nonnull String transferId) throws ApiException
      Retrieve funding wallet transfer by ID Returns a single funding wallet transfer for the specified account by `transfer_id`. Responds with 404 if no matching transfer exists for the account.
      Parameters:
      accountId - Alpaca account UUID (required)
      transferId - transfer UUID (required)
      Returns:
      ApiResponse<FundingWalletTransfer>
      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 transfer response if found -
      404 error response if transfer is not found -
      0 error -

    • getFundingWalletTransferByIDAsync

      public okhttp3.Call getFundingWalletTransferByIDAsync(@Nonnull String accountId, @Nonnull String transferId, ApiCallback<FundingWalletTransfer> _callback) throws ApiException
      Retrieve funding wallet transfer by ID (asynchronously) Returns a single funding wallet transfer for the specified account by `transfer_id`. Responds with 404 if no matching transfer exists for the account.
      Parameters:
      accountId - Alpaca account UUID (required)
      transferId - transfer UUID (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 transfer response if found -
      404 error response if transfer is not found -
      0 error -

    • getFundingWalletTransfersCall

      public okhttp3.Call getFundingWalletTransfersCall(@Nonnull String accountId, ApiCallback _callback) throws ApiException
      Build call for getFundingWalletTransfers
      Parameters:
      accountId - UUID alpaca account ID (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 transfers -
      0 error -

    • getFundingWalletTransfers

      public ListTransfersResponse getFundingWalletTransfers(@Nonnull String accountId) throws ApiException
      Retrieve funding wallet transfers Returns all funding wallet transfers (deposits and withdrawals) associated with the specified account.
      Parameters:
      accountId - UUID alpaca account ID (required)
      Returns:
      ListTransfersResponse
      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 transfers -
      0 error -

    • getFundingWalletTransfersWithHttpInfo

      public ApiResponse<ListTransfersResponse> getFundingWalletTransfersWithHttpInfo(@Nonnull String accountId) throws ApiException
      Retrieve funding wallet transfers Returns all funding wallet transfers (deposits and withdrawals) associated with the specified account.
      Parameters:
      accountId - UUID alpaca account ID (required)
      Returns:
      ApiResponse<ListTransfersResponse>
      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 transfers -
      0 error -

    • getFundingWalletTransfersAsync

      public okhttp3.Call getFundingWalletTransfersAsync(@Nonnull String accountId, ApiCallback<ListTransfersResponse> _callback) throws ApiException
      Retrieve funding wallet transfers (asynchronously) Returns all funding wallet transfers (deposits and withdrawals) associated with the specified account.
      Parameters:
      accountId - UUID alpaca account ID (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 transfers -
      0 error -

    • listFundingDetailsCall

      public okhttp3.Call listFundingDetailsCall(@Nonnull String accountId, @Nullable FundingDetailPaymentType paymentType, @Nullable String currency, ApiCallback _callback) throws ApiException
      Build call for listFundingDetails
      Parameters:
      accountId - UUID alpaca account ID (required)
      paymentType - The type of SSI to be returned, priority (SWIFT) or regular (local). A null value returns all payment types. (optional)
      currency - Should be provided in ISO 4217 standard (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 list of wallets -
      0 error -

    • listFundingDetails

      public List<ListFundingDetails> listFundingDetails(@Nonnull String accountId, @Nullable FundingDetailPaymentType paymentType, @Nullable String currency) throws ApiException
      Retrieve funding details Returns a list of funding details if it exists. Query parameters must be passed to create a new funding details object if none exist.
      Parameters:
      accountId - UUID alpaca account ID (required)
      paymentType - The type of SSI to be returned, priority (SWIFT) or regular (local). A null value returns all payment types. (optional)
      currency - Should be provided in ISO 4217 standard (optional)
      Returns:
      List<ListFundingDetails>
      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 list of wallets -
      0 error -

    • listFundingDetailsWithHttpInfo

      public ApiResponse<List<ListFundingDetails>> listFundingDetailsWithHttpInfo(@Nonnull String accountId, @Nullable FundingDetailPaymentType paymentType, @Nullable String currency) throws ApiException
      Retrieve funding details Returns a list of funding details if it exists. Query parameters must be passed to create a new funding details object if none exist.
      Parameters:
      accountId - UUID alpaca account ID (required)
      paymentType - The type of SSI to be returned, priority (SWIFT) or regular (local). A null value returns all payment types. (optional)
      currency - Should be provided in ISO 4217 standard (optional)
      Returns:
      ApiResponse<List<ListFundingDetails>>
      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 list of wallets -
      0 error -

    • listFundingDetailsAsync

      public okhttp3.Call listFundingDetailsAsync(@Nonnull String accountId, @Nullable FundingDetailPaymentType paymentType, @Nullable String currency, ApiCallback<List<ListFundingDetails>> _callback) throws ApiException
      Retrieve funding details (asynchronously) Returns a list of funding details if it exists. Query parameters must be passed to create a new funding details object if none exist.
      Parameters:
      accountId - UUID alpaca account ID (required)
      paymentType - The type of SSI to be returned, priority (SWIFT) or regular (local). A null value returns all payment types. (optional)
      currency - Should be provided in ISO 4217 standard (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 list of wallets -
      0 error -