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

  • getTokenizationRequestByClientRequestIDBroker: Get Tokenization Request by `client_request_id`
  • getTokenizationRequestByIDBroker: Get Tokenization Request by ID
  • getTokenizationRequestByIssuerRequestIDBroker: Get Tokenization Request by `issuer_request_id`
  • 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)

    • getTokenizationRequestByClientRequestIDBrokerCall

      public okhttp3.Call getTokenizationRequestByClientRequestIDBrokerCall(@Nonnull UUID accountId, @Nonnull String clientRequestId, ApiCallback _callback) throws ApiException
      Build call for getTokenizationRequestByClientRequestIDBroker
      Parameters:
      accountId - Account identifier. (required)
      clientRequestId - AP-supplied request identifier originally passed on the mint request, echoed back on the tokenization-request response. (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 Successful response -
      401 Authentication credentials are missing or invalid. -
      403 Caller is not authorized to perform this operation. -
      404 No tokenization request with the supplied `client_request_id` exists for this account. -
      422 The `client_request_id` query parameter is missing. -

    • getTokenizationRequestByClientRequestIDBroker

      public TokenizationRequest getTokenizationRequestByClientRequestIDBroker(@Nonnull UUID accountId, @Nonnull String clientRequestId) throws ApiException
      Get Tokenization Request by `client_request_id` Retrieve a single tokenization request by the Authorized Participant's `client_request_id`, the AP-supplied label originally passed on the mint request. Available to Authorized Participants and to issuers that are affiliated with the AP. Returns the matching mint request. If the AP has reused a `client_request_id` across multiple requests, the most recently created request is returned.
      Parameters:
      accountId - Account identifier. (required)
      clientRequestId - AP-supplied request identifier originally passed on the mint request, echoed back on the tokenization-request response. (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 Successful response -
      401 Authentication credentials are missing or invalid. -
      403 Caller is not authorized to perform this operation. -
      404 No tokenization request with the supplied `client_request_id` exists for this account. -
      422 The `client_request_id` query parameter is missing. -

    • getTokenizationRequestByClientRequestIDBrokerWithHttpInfo

      public ApiResponse<TokenizationRequest> getTokenizationRequestByClientRequestIDBrokerWithHttpInfo(@Nonnull UUID accountId, @Nonnull String clientRequestId) throws ApiException
      Get Tokenization Request by `client_request_id` Retrieve a single tokenization request by the Authorized Participant's `client_request_id`, the AP-supplied label originally passed on the mint request. Available to Authorized Participants and to issuers that are affiliated with the AP. Returns the matching mint request. If the AP has reused a `client_request_id` across multiple requests, the most recently created request is returned.
      Parameters:
      accountId - Account identifier. (required)
      clientRequestId - AP-supplied request identifier originally passed on the mint request, echoed back on the tokenization-request response. (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 Successful response -
      401 Authentication credentials are missing or invalid. -
      403 Caller is not authorized to perform this operation. -
      404 No tokenization request with the supplied `client_request_id` exists for this account. -
      422 The `client_request_id` query parameter is missing. -

    • getTokenizationRequestByClientRequestIDBrokerAsync

      public okhttp3.Call getTokenizationRequestByClientRequestIDBrokerAsync(@Nonnull UUID accountId, @Nonnull String clientRequestId, ApiCallback<TokenizationRequest> _callback) throws ApiException
      Get Tokenization Request by `client_request_id` (asynchronously) Retrieve a single tokenization request by the Authorized Participant's `client_request_id`, the AP-supplied label originally passed on the mint request. Available to Authorized Participants and to issuers that are affiliated with the AP. Returns the matching mint request. If the AP has reused a `client_request_id` across multiple requests, the most recently created request is returned.
      Parameters:
      accountId - Account identifier. (required)
      clientRequestId - AP-supplied request identifier originally passed on the mint request, echoed back on the tokenization-request response. (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 Successful response -
      401 Authentication credentials are missing or invalid. -
      403 Caller is not authorized to perform this operation. -
      404 No tokenization request with the supplied `client_request_id` exists for this account. -
      422 The `client_request_id` query parameter is missing. -

    • getTokenizationRequestByIDBrokerCall

      public okhttp3.Call getTokenizationRequestByIDBrokerCall(@Nonnull UUID accountId, @Nonnull UUID tokenizationRequestId, ApiCallback _callback) throws ApiException
      Build call for getTokenizationRequestByIDBroker
      Parameters:
      accountId - Account identifier. (required)
      tokenizationRequestId - Unique identifier of the tokenization request, as returned by the mint endpoint or the list-requests endpoint. (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 Successful response -
      401 Authentication credentials are missing or invalid. -
      403 Caller is not authorized to perform this operation. -
      404 No tokenization request with the supplied `tokenization_request_id` exists for this account. -
      422 The `tokenization_request_id` path parameter is not a valid UUID. -

    • getTokenizationRequestByIDBroker

      public TokenizationRequest getTokenizationRequestByIDBroker(@Nonnull UUID accountId, @Nonnull UUID tokenizationRequestId) throws ApiException
      Get Tokenization Request by ID Retrieve a single tokenization request by its `tokenization_request_id`. This endpoint may be used by the tokenized asset issuer or by an Authorized Participant (AP), and returns either a mint or a redeem request.
      Parameters:
      accountId - Account identifier. (required)
      tokenizationRequestId - Unique identifier of the tokenization request, as returned by the mint endpoint or the list-requests endpoint. (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 Successful response -
      401 Authentication credentials are missing or invalid. -
      403 Caller is not authorized to perform this operation. -
      404 No tokenization request with the supplied `tokenization_request_id` exists for this account. -
      422 The `tokenization_request_id` path parameter is not a valid UUID. -

    • getTokenizationRequestByIDBrokerWithHttpInfo

      public ApiResponse<TokenizationRequest> getTokenizationRequestByIDBrokerWithHttpInfo(@Nonnull UUID accountId, @Nonnull UUID tokenizationRequestId) throws ApiException
      Get Tokenization Request by ID Retrieve a single tokenization request by its `tokenization_request_id`. This endpoint may be used by the tokenized asset issuer or by an Authorized Participant (AP), and returns either a mint or a redeem request.
      Parameters:
      accountId - Account identifier. (required)
      tokenizationRequestId - Unique identifier of the tokenization request, as returned by the mint endpoint or the list-requests endpoint. (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 Successful response -
      401 Authentication credentials are missing or invalid. -
      403 Caller is not authorized to perform this operation. -
      404 No tokenization request with the supplied `tokenization_request_id` exists for this account. -
      422 The `tokenization_request_id` path parameter is not a valid UUID. -

    • getTokenizationRequestByIDBrokerAsync

      public okhttp3.Call getTokenizationRequestByIDBrokerAsync(@Nonnull UUID accountId, @Nonnull UUID tokenizationRequestId, ApiCallback<TokenizationRequest> _callback) throws ApiException
      Get Tokenization Request by ID (asynchronously) Retrieve a single tokenization request by its `tokenization_request_id`. This endpoint may be used by the tokenized asset issuer or by an Authorized Participant (AP), and returns either a mint or a redeem request.
      Parameters:
      accountId - Account identifier. (required)
      tokenizationRequestId - Unique identifier of the tokenization request, as returned by the mint endpoint or the list-requests endpoint. (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 Successful response -
      401 Authentication credentials are missing or invalid. -
      403 Caller is not authorized to perform this operation. -
      404 No tokenization request with the supplied `tokenization_request_id` exists for this account. -
      422 The `tokenization_request_id` path parameter is not a valid UUID. -

    • getTokenizationRequestByIssuerRequestIDBrokerCall

      public okhttp3.Call getTokenizationRequestByIssuerRequestIDBrokerCall(@Nonnull UUID accountId, @Nonnull String issuerRequestId, ApiCallback _callback) throws ApiException
      Build call for getTokenizationRequestByIssuerRequestIDBroker
      Parameters:
      accountId - Account identifier. (required)
      issuerRequestId - Issuer-assigned request identifier returned to the AP on the original mint or redeem response and visible to the issuer on rows it owns. (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 Successful response -
      401 Authentication credentials are missing or invalid. -
      403 Caller is not authorized to perform this operation. -
      404 No tokenization request with the supplied `issuer_request_id` exists for this account, or the caller is not the tokenized asset issuer. -
      422 The `issuer_request_id` query parameter is missing. -

    • getTokenizationRequestByIssuerRequestIDBroker

      public TokenizationRequest getTokenizationRequestByIssuerRequestIDBroker(@Nonnull UUID accountId, @Nonnull String issuerRequestId) throws ApiException
      Get Tokenization Request by `issuer_request_id` Retrieve a single tokenization request by the `issuer_request_id`. Returns either a mint or a redeem request. Can be called by issuers only.
      Parameters:
      accountId - Account identifier. (required)
      issuerRequestId - Issuer-assigned request identifier returned to the AP on the original mint or redeem response and visible to the issuer on rows it owns. (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 Successful response -
      401 Authentication credentials are missing or invalid. -
      403 Caller is not authorized to perform this operation. -
      404 No tokenization request with the supplied `issuer_request_id` exists for this account, or the caller is not the tokenized asset issuer. -
      422 The `issuer_request_id` query parameter is missing. -

    • getTokenizationRequestByIssuerRequestIDBrokerWithHttpInfo

      public ApiResponse<TokenizationRequest> getTokenizationRequestByIssuerRequestIDBrokerWithHttpInfo(@Nonnull UUID accountId, @Nonnull String issuerRequestId) throws ApiException
      Get Tokenization Request by `issuer_request_id` Retrieve a single tokenization request by the `issuer_request_id`. Returns either a mint or a redeem request. Can be called by issuers only.
      Parameters:
      accountId - Account identifier. (required)
      issuerRequestId - Issuer-assigned request identifier returned to the AP on the original mint or redeem response and visible to the issuer on rows it owns. (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 Successful response -
      401 Authentication credentials are missing or invalid. -
      403 Caller is not authorized to perform this operation. -
      404 No tokenization request with the supplied `issuer_request_id` exists for this account, or the caller is not the tokenized asset issuer. -
      422 The `issuer_request_id` query parameter is missing. -

    • getTokenizationRequestByIssuerRequestIDBrokerAsync

      public okhttp3.Call getTokenizationRequestByIssuerRequestIDBrokerAsync(@Nonnull UUID accountId, @Nonnull String issuerRequestId, ApiCallback<TokenizationRequest> _callback) throws ApiException
      Get Tokenization Request by `issuer_request_id` (asynchronously) Retrieve a single tokenization request by the `issuer_request_id`. Returns either a mint or a redeem request. Can be called by issuers only.
      Parameters:
      accountId - Account identifier. (required)
      issuerRequestId - Issuer-assigned request identifier returned to the AP on the original mint or redeem response and visible to the issuer on rows it owns. (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 Successful response -
      401 Authentication credentials are missing or invalid. -
      403 Caller is not authorized to perform this operation. -
      404 No tokenization request with the supplied `issuer_request_id` exists for this account, or the caller is not the tokenized asset issuer. -
      422 The `issuer_request_id` query parameter is missing. -

    • 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, @Nullable String idempotencyKey, ApiCallback _callback) throws ApiException
      Build call for postTokenizationMintBroker
      Parameters:
      accountId - Account identifier. (required)
      tokenizationMintRequest - (required)
      idempotencyKey - Optional client-generated key for safe retries and duplicate request detection. This endpoint currently accepts keys up to 128 characters. Alpaca is moving toward a 36-character maximum; new implementations should generate a unique UUIDv7 or UUIDv4 value (36 characters including hyphens) for each logical operation. Do not reuse a key across operations. (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 Successfully requested minting of a tokenized asset. -
      400 Bad request (e.g. malformed input, insufficient position, or account not authorized to mint). Also returned when the `Idempotency-Key` header is malformed, or when replaying a request that was originally rejected. -
      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, or the same `Idempotency-Key` was reused with a different request body. -

    • postTokenizationMintBroker

      public TokenizationMintResponse postTokenizationMintBroker(@Nonnull UUID accountId, @Nonnull TokenizationMintRequest tokenizationMintRequest, @Nullable String idempotencyKey) 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. **Idempotency**: When the `Idempotency-Key` header is supplied, this endpoint is idempotent. Multiple requests with the same key and identical request body will create only one mint request. A subsequent request returns the previously created request with the same response (no duplicate is created). If the same key is used with a different request body, the API returns `422 Unprocessable Entity`. **Recommended for production**: Always supply `Idempotency-Key` when requesting a mint. This allows safe retries on timeouts, network errors, or 5xx responses without risking duplicate requests. Use a client-generated unique value (e.g. UUID).
      Parameters:
      accountId - Account identifier. (required)
      tokenizationMintRequest - (required)
      idempotencyKey - Optional client-generated key for safe retries and duplicate request detection. This endpoint currently accepts keys up to 128 characters. Alpaca is moving toward a 36-character maximum; new implementations should generate a unique UUIDv7 or UUIDv4 value (36 characters including hyphens) for each logical operation. Do not reuse a key across operations. (optional)
      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). Also returned when the `Idempotency-Key` header is malformed, or when replaying a request that was originally rejected. -
      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, or the same `Idempotency-Key` was reused with a different request body. -

    • postTokenizationMintBrokerWithHttpInfo

      public ApiResponse<TokenizationMintResponse> postTokenizationMintBrokerWithHttpInfo(@Nonnull UUID accountId, @Nonnull TokenizationMintRequest tokenizationMintRequest, @Nullable String idempotencyKey) 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. **Idempotency**: When the `Idempotency-Key` header is supplied, this endpoint is idempotent. Multiple requests with the same key and identical request body will create only one mint request. A subsequent request returns the previously created request with the same response (no duplicate is created). If the same key is used with a different request body, the API returns `422 Unprocessable Entity`. **Recommended for production**: Always supply `Idempotency-Key` when requesting a mint. This allows safe retries on timeouts, network errors, or 5xx responses without risking duplicate requests. Use a client-generated unique value (e.g. UUID).
      Parameters:
      accountId - Account identifier. (required)
      tokenizationMintRequest - (required)
      idempotencyKey - Optional client-generated key for safe retries and duplicate request detection. This endpoint currently accepts keys up to 128 characters. Alpaca is moving toward a 36-character maximum; new implementations should generate a unique UUIDv7 or UUIDv4 value (36 characters including hyphens) for each logical operation. Do not reuse a key across operations. (optional)
      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). Also returned when the `Idempotency-Key` header is malformed, or when replaying a request that was originally rejected. -
      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, or the same `Idempotency-Key` was reused with a different request body. -

    • postTokenizationMintBrokerAsync

      public okhttp3.Call postTokenizationMintBrokerAsync(@Nonnull UUID accountId, @Nonnull TokenizationMintRequest tokenizationMintRequest, @Nullable String idempotencyKey, 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. **Idempotency**: When the `Idempotency-Key` header is supplied, this endpoint is idempotent. Multiple requests with the same key and identical request body will create only one mint request. A subsequent request returns the previously created request with the same response (no duplicate is created). If the same key is used with a different request body, the API returns `422 Unprocessable Entity`. **Recommended for production**: Always supply `Idempotency-Key` when requesting a mint. This allows safe retries on timeouts, network errors, or 5xx responses without risking duplicate requests. Use a client-generated unique value (e.g. UUID).
      Parameters:
      accountId - Account identifier. (required)
      tokenizationMintRequest - (required)
      idempotencyKey - Optional client-generated key for safe retries and duplicate request detection. This endpoint currently accepts keys up to 128 characters. Alpaca is moving toward a 36-character maximum; new implementations should generate a unique UUIDv7 or UUIDv4 value (36 characters including hyphens) for each logical operation. Do not reuse a key across operations. (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 Successfully requested minting of a tokenized asset. -
      400 Bad request (e.g. malformed input, insufficient position, or account not authorized to mint). Also returned when the `Idempotency-Key` header is malformed, or when replaying a request that was originally rejected. -
      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, or the same `Idempotency-Key` was reused with a different request body. -

    • postTokenizationRedeemCall

      public okhttp3.Call postTokenizationRedeemCall(@Nonnull UUID accountId, @Nonnull TokenizationRedeemRequest tokenizationRedeemRequest, @Nullable String idempotencyKey, ApiCallback _callback) throws ApiException
      Build call for postTokenizationRedeem
      Parameters:
      accountId - Account identifier. (required)
      tokenizationRedeemRequest - (required)
      idempotencyKey - Optional client-generated key for safe retries and duplicate request detection. This endpoint currently accepts keys up to 128 characters. Alpaca is moving toward a 36-character maximum; new implementations should generate a unique UUIDv7 or UUIDv4 value (36 characters including hyphens) for each logical operation. Do not reuse a key across operations. (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 Successfully requested redemption of a tokenized asset. -
      400 Bad request (e.g. malformed input, insufficient quantity, or account not authorized to redeem). Also returned when the `Idempotency-Key` header is malformed, or when replaying a request that was originally rejected. -
      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, or the same `Idempotency-Key` was reused with a different request body. -

    • postTokenizationRedeem

      public TokenizationRedeemResponse postTokenizationRedeem(@Nonnull UUID accountId, @Nonnull TokenizationRedeemRequest tokenizationRedeemRequest, @Nullable String idempotencyKey) 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. **Idempotency**: When the `Idempotency-Key` header is supplied, this endpoint is idempotent. Multiple requests with the same key and identical request body will create only one redeem request. A subsequent request returns the previously created request with the same response (no duplicate is created). If the same key is used with a different request body, the API returns `422 Unprocessable Entity`. **Recommended for production**: Always supply `Idempotency-Key` when requesting a redemption. This allows safe retries on timeouts, network errors, or 5xx responses without risking duplicate requests. Use a client-generated unique value (e.g. UUID).
      Parameters:
      accountId - Account identifier. (required)
      tokenizationRedeemRequest - (required)
      idempotencyKey - Optional client-generated key for safe retries and duplicate request detection. This endpoint currently accepts keys up to 128 characters. Alpaca is moving toward a 36-character maximum; new implementations should generate a unique UUIDv7 or UUIDv4 value (36 characters including hyphens) for each logical operation. Do not reuse a key across operations. (optional)
      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). Also returned when the `Idempotency-Key` header is malformed, or when replaying a request that was originally rejected. -
      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, or the same `Idempotency-Key` was reused with a different request body. -

    • postTokenizationRedeemWithHttpInfo

      public ApiResponse<TokenizationRedeemResponse> postTokenizationRedeemWithHttpInfo(@Nonnull UUID accountId, @Nonnull TokenizationRedeemRequest tokenizationRedeemRequest, @Nullable String idempotencyKey) 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. **Idempotency**: When the `Idempotency-Key` header is supplied, this endpoint is idempotent. Multiple requests with the same key and identical request body will create only one redeem request. A subsequent request returns the previously created request with the same response (no duplicate is created). If the same key is used with a different request body, the API returns `422 Unprocessable Entity`. **Recommended for production**: Always supply `Idempotency-Key` when requesting a redemption. This allows safe retries on timeouts, network errors, or 5xx responses without risking duplicate requests. Use a client-generated unique value (e.g. UUID).
      Parameters:
      accountId - Account identifier. (required)
      tokenizationRedeemRequest - (required)
      idempotencyKey - Optional client-generated key for safe retries and duplicate request detection. This endpoint currently accepts keys up to 128 characters. Alpaca is moving toward a 36-character maximum; new implementations should generate a unique UUIDv7 or UUIDv4 value (36 characters including hyphens) for each logical operation. Do not reuse a key across operations. (optional)
      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). Also returned when the `Idempotency-Key` header is malformed, or when replaying a request that was originally rejected. -
      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, or the same `Idempotency-Key` was reused with a different request body. -

    • postTokenizationRedeemAsync

      public okhttp3.Call postTokenizationRedeemAsync(@Nonnull UUID accountId, @Nonnull TokenizationRedeemRequest tokenizationRedeemRequest, @Nullable String idempotencyKey, 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. **Idempotency**: When the `Idempotency-Key` header is supplied, this endpoint is idempotent. Multiple requests with the same key and identical request body will create only one redeem request. A subsequent request returns the previously created request with the same response (no duplicate is created). If the same key is used with a different request body, the API returns `422 Unprocessable Entity`. **Recommended for production**: Always supply `Idempotency-Key` when requesting a redemption. This allows safe retries on timeouts, network errors, or 5xx responses without risking duplicate requests. Use a client-generated unique value (e.g. UUID).
      Parameters:
      accountId - Account identifier. (required)
      tokenizationRedeemRequest - (required)
      idempotencyKey - Optional client-generated key for safe retries and duplicate request detection. This endpoint currently accepts keys up to 128 characters. Alpaca is moving toward a 36-character maximum; new implementations should generate a unique UUIDv7 or UUIDv4 value (36 characters including hyphens) for each logical operation. Do not reuse a key across operations. (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 Successfully requested redemption of a tokenized asset. -
      400 Bad request (e.g. malformed input, insufficient quantity, or account not authorized to redeem). Also returned when the `Idempotency-Key` header is malformed, or when replaying a request that was originally rejected. -
      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, or the same `Idempotency-Key` was reused with a different request body. -