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

Class TokenizationApi

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

  • getTokenizationRequestsBroker: List Tokenization Requests
  • postTokenizationCallbackMint: Confirm Tokenized Asset Minted
  • postTokenizationMintBroker: Mint a Tokenized Asset
  • postTokenizationRedeem: Redeem a Tokenized Asset

  • Constructor Details

    • TokenizationApi

      public TokenizationApi()

    • TokenizationApi

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

    • getTokenizationRequestsBrokerCall

      public okhttp3.Call getTokenizationRequestsBrokerCall(@Nonnull UUID accountId, @Nullable String type, @Nullable String status, @Nullable String underlyingSymbol, @Nullable TokenizationIssuer issuer, @Nullable TokenizationNetwork network, @Nullable OffsetDateTime after, @Nullable OffsetDateTime before, ApiCallback _callback) throws ApiException
      Build call for getTokenizationRequestsBroker
      Parameters:
      accountId - Account identifier. (required)
      type - Tokenization request type to be queried (optional)
      status - Tokenization request status to be queried (optional)
      underlyingSymbol - Underlying symbol of the tokenization requests to be queried (optional)
      issuer - Issuer of the tokenization requests to be queried (optional)
      network - Network of the tokenization requests to be queried (optional)
      after - The response will include only requests created after this timestamp (exclusive) (optional)
      before - The response will include only requests created before this timestamp (exclusive) (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 Successful response A list of tokenization requests -
      401 Authentication credentials are missing or invalid. -
      403 Caller is not authorized to perform this operation. -
      422 One or more request parameters are missing or invalid. -

    • getTokenizationRequestsBroker

      public List<TokenizationRequest> getTokenizationRequestsBroker(@Nonnull UUID accountId, @Nullable String type, @Nullable String status, @Nullable String underlyingSymbol, @Nullable TokenizationIssuer issuer, @Nullable TokenizationNetwork network, @Nullable OffsetDateTime after, @Nullable OffsetDateTime before) throws ApiException
      List Tokenization Requests Retrieve tokenization requests for the account. This endpoint may be used by the tokenized asset issuer or by an Authorized Participant (AP). The list can contain both mint and redeem requests.
      Parameters:
      accountId - Account identifier. (required)
      type - Tokenization request type to be queried (optional)
      status - Tokenization request status to be queried (optional)
      underlyingSymbol - Underlying symbol of the tokenization requests to be queried (optional)
      issuer - Issuer of the tokenization requests to be queried (optional)
      network - Network of the tokenization requests to be queried (optional)
      after - The response will include only requests created after this timestamp (exclusive) (optional)
      before - The response will include only requests created before this timestamp (exclusive) (optional)
      Returns:
      List<TokenizationRequest>
      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 response A list of tokenization requests -
      401 Authentication credentials are missing or invalid. -
      403 Caller is not authorized to perform this operation. -
      422 One or more request parameters are missing or invalid. -

    • getTokenizationRequestsBrokerWithHttpInfo

      public ApiResponse<List<TokenizationRequest>> getTokenizationRequestsBrokerWithHttpInfo(@Nonnull UUID accountId, @Nullable String type, @Nullable String status, @Nullable String underlyingSymbol, @Nullable TokenizationIssuer issuer, @Nullable TokenizationNetwork network, @Nullable OffsetDateTime after, @Nullable OffsetDateTime before) throws ApiException
      List Tokenization Requests Retrieve tokenization requests for the account. This endpoint may be used by the tokenized asset issuer or by an Authorized Participant (AP). The list can contain both mint and redeem requests.
      Parameters:
      accountId - Account identifier. (required)
      type - Tokenization request type to be queried (optional)
      status - Tokenization request status to be queried (optional)
      underlyingSymbol - Underlying symbol of the tokenization requests to be queried (optional)
      issuer - Issuer of the tokenization requests to be queried (optional)
      network - Network of the tokenization requests to be queried (optional)
      after - The response will include only requests created after this timestamp (exclusive) (optional)
      before - The response will include only requests created before this timestamp (exclusive) (optional)
      Returns:
      ApiResponse<List<TokenizationRequest>>
      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 response A list of tokenization requests -
      401 Authentication credentials are missing or invalid. -
      403 Caller is not authorized to perform this operation. -
      422 One or more request parameters are missing or invalid. -

    • getTokenizationRequestsBrokerAsync

      public okhttp3.Call getTokenizationRequestsBrokerAsync(@Nonnull UUID accountId, @Nullable String type, @Nullable String status, @Nullable String underlyingSymbol, @Nullable TokenizationIssuer issuer, @Nullable TokenizationNetwork network, @Nullable OffsetDateTime after, @Nullable OffsetDateTime before, ApiCallback<List<TokenizationRequest>> _callback) throws ApiException
      List Tokenization Requests (asynchronously) Retrieve tokenization requests for the account. This endpoint may be used by the tokenized asset issuer or by an Authorized Participant (AP). The list can contain both mint and redeem requests.
      Parameters:
      accountId - Account identifier. (required)
      type - Tokenization request type to be queried (optional)
      status - Tokenization request status to be queried (optional)
      underlyingSymbol - Underlying symbol of the tokenization requests to be queried (optional)
      issuer - Issuer of the tokenization requests to be queried (optional)
      network - Network of the tokenization requests to be queried (optional)
      after - The response will include only requests created after this timestamp (exclusive) (optional)
      before - The response will include only requests created before this timestamp (exclusive) (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 Successful response A list of tokenization requests -
      401 Authentication credentials are missing or invalid. -
      403 Caller is not authorized to perform this operation. -
      422 One or more request parameters are missing or invalid. -

    • postTokenizationCallbackMintCall

      public okhttp3.Call postTokenizationCallbackMintCall(@Nonnull UUID accountId, @Nonnull TokenizationMintCallback tokenizationMintCallback, ApiCallback _callback) throws ApiException
      Build call for postTokenizationCallbackMint
      Parameters:
      accountId - Account identifier. (required)
      tokenizationMintCallback - (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 confirmed minting of a tokenized asset. -
      400 Bad request (e.g. failed to decode request body). -
      401 Authentication credentials are missing or invalid. -
      403 Caller is not authorized to perform this operation. -
      422 One or more request parameters are missing or invalid. -

    • postTokenizationCallbackMint

      public TokenizationRequest postTokenizationCallbackMint(@Nonnull UUID accountId, @Nonnull TokenizationMintCallback tokenizationMintCallback) throws ApiException
      Confirm Tokenized Asset Minted This endpoint is used by the issuer to confirm the minting of tokenized assets previously requested by the Authorized Participant.
      Parameters:
      accountId - Account identifier. (required)
      tokenizationMintCallback - (required)
      Returns:
      TokenizationRequest
      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 confirmed minting of a tokenized asset. -
      400 Bad request (e.g. failed to decode request body). -
      401 Authentication credentials are missing or invalid. -
      403 Caller is not authorized to perform this operation. -
      422 One or more request parameters are missing or invalid. -

    • postTokenizationCallbackMintWithHttpInfo

      public ApiResponse<TokenizationRequest> postTokenizationCallbackMintWithHttpInfo(@Nonnull UUID accountId, @Nonnull TokenizationMintCallback tokenizationMintCallback) throws ApiException
      Confirm Tokenized Asset Minted This endpoint is used by the issuer to confirm the minting of tokenized assets previously requested by the Authorized Participant.
      Parameters:
      accountId - Account identifier. (required)
      tokenizationMintCallback - (required)
      Returns:
      ApiResponse<TokenizationRequest>
      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 confirmed minting of a tokenized asset. -
      400 Bad request (e.g. failed to decode request body). -
      401 Authentication credentials are missing or invalid. -
      403 Caller is not authorized to perform this operation. -
      422 One or more request parameters are missing or invalid. -

    • postTokenizationCallbackMintAsync

      public okhttp3.Call postTokenizationCallbackMintAsync(@Nonnull UUID accountId, @Nonnull TokenizationMintCallback tokenizationMintCallback, ApiCallback<TokenizationRequest> _callback) throws ApiException
      Confirm Tokenized Asset Minted (asynchronously) This endpoint is used by the issuer to confirm the minting of tokenized assets previously requested by the Authorized Participant.
      Parameters:
      accountId - Account identifier. (required)
      tokenizationMintCallback - (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 confirmed minting of a tokenized asset. -
      400 Bad request (e.g. failed to decode request body). -
      401 Authentication credentials are missing or invalid. -
      403 Caller is not authorized to perform this operation. -
      422 One or more request parameters are missing or invalid. -

    • postTokenizationMintBrokerCall

      public okhttp3.Call postTokenizationMintBrokerCall(@Nonnull UUID accountId, @Nonnull TokenizationMintRequest tokenizationMintRequest, ApiCallback _callback) throws ApiException
      Build call for postTokenizationMintBroker
      Parameters:
      accountId - Account identifier. (required)
      tokenizationMintRequest - (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 minting of a tokenized asset. -
      400 Bad request (e.g. malformed input, insufficient position, or account not authorized to mint). -
      401 Authentication credentials are missing or invalid. -
      403 Caller is not authorized to perform this operation. -
      422 One or more request parameters are missing or invalid. -

    • postTokenizationMintBroker

      public TokenizationMintResponse postTokenizationMintBroker(@Nonnull UUID accountId, @Nonnull TokenizationMintRequest tokenizationMintRequest) throws ApiException
      Mint a Tokenized Asset This endpoint is used by an Authorized Participant to request the minting of a tokenized asset. Alpaca will initiate a journal of the underlying asset from the Authorized Participant's account to the issuer's account.
      Parameters:
      accountId - Account identifier. (required)
      tokenizationMintRequest - (required)
      Returns:
      TokenizationMintResponse
      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 minting of a tokenized asset. -
      400 Bad request (e.g. malformed input, insufficient position, or account not authorized to mint). -
      401 Authentication credentials are missing or invalid. -
      403 Caller is not authorized to perform this operation. -
      422 One or more request parameters are missing or invalid. -

    • postTokenizationMintBrokerWithHttpInfo

      public ApiResponse<TokenizationMintResponse> postTokenizationMintBrokerWithHttpInfo(@Nonnull UUID accountId, @Nonnull TokenizationMintRequest tokenizationMintRequest) throws ApiException
      Mint a Tokenized Asset This endpoint is used by an Authorized Participant to request the minting of a tokenized asset. Alpaca will initiate a journal of the underlying asset from the Authorized Participant's account to the issuer's account.
      Parameters:
      accountId - Account identifier. (required)
      tokenizationMintRequest - (required)
      Returns:
      ApiResponse<TokenizationMintResponse>
      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 minting of a tokenized asset. -
      400 Bad request (e.g. malformed input, insufficient position, or account not authorized to mint). -
      401 Authentication credentials are missing or invalid. -
      403 Caller is not authorized to perform this operation. -
      422 One or more request parameters are missing or invalid. -

    • postTokenizationMintBrokerAsync

      public okhttp3.Call postTokenizationMintBrokerAsync(@Nonnull UUID accountId, @Nonnull TokenizationMintRequest tokenizationMintRequest, ApiCallback<TokenizationMintResponse> _callback) throws ApiException
      Mint a Tokenized Asset (asynchronously) This endpoint is used by an Authorized Participant to request the minting of a tokenized asset. Alpaca will initiate a journal of the underlying asset from the Authorized Participant's account to the issuer's account.
      Parameters:
      accountId - Account identifier. (required)
      tokenizationMintRequest - (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 minting of a tokenized asset. -
      400 Bad request (e.g. malformed input, insufficient position, or account not authorized to mint). -
      401 Authentication credentials are missing or invalid. -
      403 Caller is not authorized to perform this operation. -
      422 One or more request parameters are missing or invalid. -

    • postTokenizationRedeemCall

      public okhttp3.Call postTokenizationRedeemCall(@Nonnull UUID accountId, @Nonnull TokenizationRedeemRequest tokenizationRedeemRequest, ApiCallback _callback) throws ApiException
      Build call for postTokenizationRedeem
      Parameters:
      accountId - Account identifier. (required)
      tokenizationRedeemRequest - (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 redemption of a tokenized asset. -
      400 Bad request (e.g. malformed input, insufficient quantity, or account not authorized to redeem). -
      401 Authentication credentials are missing or invalid. -
      403 Caller is not authorized to perform this operation. -
      422 One or more request parameters are missing or invalid. -

    • postTokenizationRedeem

      public TokenizationRedeemResponse postTokenizationRedeem(@Nonnull UUID accountId, @Nonnull TokenizationRedeemRequest tokenizationRedeemRequest) throws ApiException
      Redeem a Tokenized Asset This endpoint is used by the tokenized asset issuer to confirm the redemption of tokens previously held in the Authorized Participant's wallet. When the issuer invokes this endpoint, Alpaca will initiate a journal of the underlying asset into the Authorized Participant's account.
      Parameters:
      accountId - Account identifier. (required)
      tokenizationRedeemRequest - (required)
      Returns:
      TokenizationRedeemResponse
      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 redemption of a tokenized asset. -
      400 Bad request (e.g. malformed input, insufficient quantity, or account not authorized to redeem). -
      401 Authentication credentials are missing or invalid. -
      403 Caller is not authorized to perform this operation. -
      422 One or more request parameters are missing or invalid. -

    • postTokenizationRedeemWithHttpInfo

      public ApiResponse<TokenizationRedeemResponse> postTokenizationRedeemWithHttpInfo(@Nonnull UUID accountId, @Nonnull TokenizationRedeemRequest tokenizationRedeemRequest) throws ApiException
      Redeem a Tokenized Asset This endpoint is used by the tokenized asset issuer to confirm the redemption of tokens previously held in the Authorized Participant's wallet. When the issuer invokes this endpoint, Alpaca will initiate a journal of the underlying asset into the Authorized Participant's account.
      Parameters:
      accountId - Account identifier. (required)
      tokenizationRedeemRequest - (required)
      Returns:
      ApiResponse<TokenizationRedeemResponse>
      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 redemption of a tokenized asset. -
      400 Bad request (e.g. malformed input, insufficient quantity, or account not authorized to redeem). -
      401 Authentication credentials are missing or invalid. -
      403 Caller is not authorized to perform this operation. -
      422 One or more request parameters are missing or invalid. -

    • postTokenizationRedeemAsync

      public okhttp3.Call postTokenizationRedeemAsync(@Nonnull UUID accountId, @Nonnull TokenizationRedeemRequest tokenizationRedeemRequest, ApiCallback<TokenizationRedeemResponse> _callback) throws ApiException
      Redeem a Tokenized Asset (asynchronously) This endpoint is used by the tokenized asset issuer to confirm the redemption of tokens previously held in the Authorized Participant's wallet. When the issuer invokes this endpoint, Alpaca will initiate a journal of the underlying asset into the Authorized Participant's account.
      Parameters:
      accountId - Account identifier. (required)
      tokenizationRedeemRequest - (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 redemption of a tokenized asset. -
      400 Bad request (e.g. malformed input, insufficient quantity, or account not authorized to redeem). -
      401 Authentication credentials are missing or invalid. -
      403 Caller is not authorized to perform this operation. -
      422 One or more request parameters are missing or invalid. -