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

Class AcatsApi

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

  • getACATSTransfer: Get transfer details
  • listACATSAssets: List assets for a transfer
  • listACATSContraBrokers: List contra brokers
  • listACATSTransfers: List transfers
  • listACATSTransfersByAccount: List transfers for an account
  • requestACATSTransfer: Initiate an incoming transfer

  • Constructor Details

    • AcatsApi

      public AcatsApi()

    • AcatsApi

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

    • getACATSTransferCall

      public okhttp3.Call getACATSTransferCall(@Nonnull UUID accountId, @Nonnull UUID acatsId, ApiCallback _callback) throws ApiException
      Build call for getACATSTransfer
      Parameters:
      accountId - Account ID associated with the ACATS transfer (required)
      acatsId - The ID of the ACATS transfer (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 OK -
      403 Forbidden -
      404 Not Found. No transfer with this `acats_id` exists for the given `account_id`. -
      500 Internal Server Error -

    • getACATSTransfer

      public AcatsTransfer getACATSTransfer(@Nonnull UUID accountId, @Nonnull UUID acatsId) throws ApiException
      Get transfer details Includes the same information returned by the list transfers endpoints, but for just one transfer.
      Parameters:
      accountId - Account ID associated with the ACATS transfer (required)
      acatsId - The ID of the ACATS transfer (required)
      Returns:
      AcatsTransfer
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      HTTP Response Details:
      Response Details
      Status Code Description Response Headers
      200 OK -
      403 Forbidden -
      404 Not Found. No transfer with this `acats_id` exists for the given `account_id`. -
      500 Internal Server Error -

    • getACATSTransferWithHttpInfo

      public ApiResponse<AcatsTransfer> getACATSTransferWithHttpInfo(@Nonnull UUID accountId, @Nonnull UUID acatsId) throws ApiException
      Get transfer details Includes the same information returned by the list transfers endpoints, but for just one transfer.
      Parameters:
      accountId - Account ID associated with the ACATS transfer (required)
      acatsId - The ID of the ACATS transfer (required)
      Returns:
      ApiResponse<AcatsTransfer>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      HTTP Response Details:
      Response Details
      Status Code Description Response Headers
      200 OK -
      403 Forbidden -
      404 Not Found. No transfer with this `acats_id` exists for the given `account_id`. -
      500 Internal Server Error -

    • getACATSTransferAsync

      public okhttp3.Call getACATSTransferAsync(@Nonnull UUID accountId, @Nonnull UUID acatsId, ApiCallback<AcatsTransfer> _callback) throws ApiException
      Get transfer details (asynchronously) Includes the same information returned by the list transfers endpoints, but for just one transfer.
      Parameters:
      accountId - Account ID associated with the ACATS transfer (required)
      acatsId - The ID of the ACATS transfer (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 OK -
      403 Forbidden -
      404 Not Found. No transfer with this `acats_id` exists for the given `account_id`. -
      500 Internal Server Error -

    • listACATSAssetsCall

      public okhttp3.Call listACATSAssetsCall(@Nonnull UUID accountId, @Nonnull UUID acatsId, ApiCallback _callback) throws ApiException
      Build call for listACATSAssets
      Parameters:
      accountId - Account ID associated with the ACATS transfer (required)
      acatsId - The ID of the ACATS transfer (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 OK -
      403 Forbidden -
      404 Not Found. No transfer with this `acats_id` exists for the given `account_id`. -
      500 Internal Server Error -

    • listACATSAssets

      public List<AcatsAsset> listACATSAssets(@Nonnull UUID accountId, @Nonnull UUID acatsId) throws ApiException
      List assets for a transfer Assets are only available for partial transfers and for transfers where the deliverer has already responded with the list of assets. The asset list may change as the transfer is updated by the deliverer, all the way up until the transfer settles.
      Parameters:
      accountId - Account ID associated with the ACATS transfer (required)
      acatsId - The ID of the ACATS transfer (required)
      Returns:
      List<AcatsAsset>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      HTTP Response Details:
      Response Details
      Status Code Description Response Headers
      200 OK -
      403 Forbidden -
      404 Not Found. No transfer with this `acats_id` exists for the given `account_id`. -
      500 Internal Server Error -

    • listACATSAssetsWithHttpInfo

      public ApiResponse<List<AcatsAsset>> listACATSAssetsWithHttpInfo(@Nonnull UUID accountId, @Nonnull UUID acatsId) throws ApiException
      List assets for a transfer Assets are only available for partial transfers and for transfers where the deliverer has already responded with the list of assets. The asset list may change as the transfer is updated by the deliverer, all the way up until the transfer settles.
      Parameters:
      accountId - Account ID associated with the ACATS transfer (required)
      acatsId - The ID of the ACATS transfer (required)
      Returns:
      ApiResponse<List<AcatsAsset>>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      HTTP Response Details:
      Response Details
      Status Code Description Response Headers
      200 OK -
      403 Forbidden -
      404 Not Found. No transfer with this `acats_id` exists for the given `account_id`. -
      500 Internal Server Error -

    • listACATSAssetsAsync

      public okhttp3.Call listACATSAssetsAsync(@Nonnull UUID accountId, @Nonnull UUID acatsId, ApiCallback<List<AcatsAsset>> _callback) throws ApiException
      List assets for a transfer (asynchronously) Assets are only available for partial transfers and for transfers where the deliverer has already responded with the list of assets. The asset list may change as the transfer is updated by the deliverer, all the way up until the transfer settles.
      Parameters:
      accountId - Account ID associated with the ACATS transfer (required)
      acatsId - The ID of the ACATS transfer (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 OK -
      403 Forbidden -
      404 Not Found. No transfer with this `acats_id` exists for the given `account_id`. -
      500 Internal Server Error -

    • listACATSContraBrokersCall

      public okhttp3.Call listACATSContraBrokersCall(ApiCallback _callback) throws ApiException
      Build call for listACATSContraBrokers
      Parameters:
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
      HTTP Response Details:
      Response Details
      Status Code Description Response Headers
      200 OK -
      403 Forbidden -
      500 Internal Server Error -

    • listACATSContraBrokers

      public AcatsListContraBrokersResponse listACATSContraBrokers() throws ApiException
      List contra brokers This information is provided based on the latest ACATS Participant Master File, and contains the DTCC account numbers of valid contra brokers. Only participants that are either brokers or banks are returned. These numbers are the valid values for the `broker_number` property that is required for initiating transfers.
      Returns:
      AcatsListContraBrokersResponse
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      HTTP Response Details:
      Response Details
      Status Code Description Response Headers
      200 OK -
      403 Forbidden -
      500 Internal Server Error -

    • listACATSContraBrokersWithHttpInfo

      public ApiResponse<AcatsListContraBrokersResponse> listACATSContraBrokersWithHttpInfo() throws ApiException
      List contra brokers This information is provided based on the latest ACATS Participant Master File, and contains the DTCC account numbers of valid contra brokers. Only participants that are either brokers or banks are returned. These numbers are the valid values for the `broker_number` property that is required for initiating transfers.
      Returns:
      ApiResponse<AcatsListContraBrokersResponse>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      HTTP Response Details:
      Response Details
      Status Code Description Response Headers
      200 OK -
      403 Forbidden -
      500 Internal Server Error -

    • listACATSContraBrokersAsync

      public okhttp3.Call listACATSContraBrokersAsync(ApiCallback<AcatsListContraBrokersResponse> _callback) throws ApiException
      List contra brokers (asynchronously) This information is provided based on the latest ACATS Participant Master File, and contains the DTCC account numbers of valid contra brokers. Only participants that are either brokers or banks are returned. These numbers are the valid values for the `broker_number` property that is required for initiating transfers.
      Parameters:
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object
      HTTP Response Details:
      Response Details
      Status Code Description Response Headers
      200 OK -
      403 Forbidden -
      500 Internal Server Error -

    • listACATSTransfersCall

      public okhttp3.Call listACATSTransfersCall(@Nullable String accountNumber, @Nullable AcatsDtccTransferType transferType, @Nullable AcatsTransferDirection transferDirection, @Nullable AcatsTransferStatus transferStatus, @Nullable AcatsDtccStatus dtccStatus, @Nullable String contraBrokerNumber, @Nullable OffsetDateTime since, @Nullable OffsetDateTime until, @Nullable AcatsSortDirection sortDirection, @Nullable String sortBy, @Nullable Integer limit, @Nullable String pageToken, ApiCallback _callback) throws ApiException
      Build call for listACATSTransfers
      Parameters:
      accountNumber - Filter by the account number associated with the transfer (optional)
      transferType - Filter by the type of the transfer (optional)
      transferDirection - Filter by the direction of the transfer (optional)
      transferStatus - Filter by the current status of the transfer (optional)
      dtccStatus - Filter by the current DTCC status of the transfer (optional)
      contraBrokerNumber - Filter by the contra broker number of the transfer (optional)
      since - List transfers created at or after this RFC-3339 timestamp (e.g. `2026-01-01T00:00:00Z`). (optional)
      until - List transfers created strictly before this RFC-3339 timestamp (exclusive -- e.g. `2026-01-01T00:00:00Z` excludes transfers created exactly at that instant). (optional)
      sortDirection - Specify whether transfers should be sorted by creation time in ascending or descending order (optional, default to DESC)
      sortBy - Specify the field to sort by. Defaults to `created_at`. (optional, default to created_at)
      limit - Maximum number of transfers to return on one page (optional)
      pageToken - Page token for the next or previous page, used to continue listing transfers (optional)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
      HTTP Response Details:
      Response Details
      Status Code Description Response Headers
      200 OK -
      400 Bad Request -
      403 Forbidden -
      500 Internal Server Error -

    • listACATSTransfers

      public AcatsListTransfersResponse listACATSTransfers(@Nullable String accountNumber, @Nullable AcatsDtccTransferType transferType, @Nullable AcatsTransferDirection transferDirection, @Nullable AcatsTransferStatus transferStatus, @Nullable AcatsDtccStatus dtccStatus, @Nullable String contraBrokerNumber, @Nullable OffsetDateTime since, @Nullable OffsetDateTime until, @Nullable AcatsSortDirection sortDirection, @Nullable String sortBy, @Nullable Integer limit, @Nullable String pageToken) throws ApiException
      List transfers List all incoming and outgoing transfers, for all accounts. The list may include transfers not initiated using this API. The list is paginated: use the `page_token` query parameter with the value returned in the response to continue listing transfers.
      Parameters:
      accountNumber - Filter by the account number associated with the transfer (optional)
      transferType - Filter by the type of the transfer (optional)
      transferDirection - Filter by the direction of the transfer (optional)
      transferStatus - Filter by the current status of the transfer (optional)
      dtccStatus - Filter by the current DTCC status of the transfer (optional)
      contraBrokerNumber - Filter by the contra broker number of the transfer (optional)
      since - List transfers created at or after this RFC-3339 timestamp (e.g. `2026-01-01T00:00:00Z`). (optional)
      until - List transfers created strictly before this RFC-3339 timestamp (exclusive -- e.g. `2026-01-01T00:00:00Z` excludes transfers created exactly at that instant). (optional)
      sortDirection - Specify whether transfers should be sorted by creation time in ascending or descending order (optional, default to DESC)
      sortBy - Specify the field to sort by. Defaults to `created_at`. (optional, default to created_at)
      limit - Maximum number of transfers to return on one page (optional)
      pageToken - Page token for the next or previous page, used to continue listing transfers (optional)
      Returns:
      AcatsListTransfersResponse
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      HTTP Response Details:
      Response Details
      Status Code Description Response Headers
      200 OK -
      400 Bad Request -
      403 Forbidden -
      500 Internal Server Error -

    • listACATSTransfersWithHttpInfo

      public ApiResponse<AcatsListTransfersResponse> listACATSTransfersWithHttpInfo(@Nullable String accountNumber, @Nullable AcatsDtccTransferType transferType, @Nullable AcatsTransferDirection transferDirection, @Nullable AcatsTransferStatus transferStatus, @Nullable AcatsDtccStatus dtccStatus, @Nullable String contraBrokerNumber, @Nullable OffsetDateTime since, @Nullable OffsetDateTime until, @Nullable AcatsSortDirection sortDirection, @Nullable String sortBy, @Nullable Integer limit, @Nullable String pageToken) throws ApiException
      List transfers List all incoming and outgoing transfers, for all accounts. The list may include transfers not initiated using this API. The list is paginated: use the `page_token` query parameter with the value returned in the response to continue listing transfers.
      Parameters:
      accountNumber - Filter by the account number associated with the transfer (optional)
      transferType - Filter by the type of the transfer (optional)
      transferDirection - Filter by the direction of the transfer (optional)
      transferStatus - Filter by the current status of the transfer (optional)
      dtccStatus - Filter by the current DTCC status of the transfer (optional)
      contraBrokerNumber - Filter by the contra broker number of the transfer (optional)
      since - List transfers created at or after this RFC-3339 timestamp (e.g. `2026-01-01T00:00:00Z`). (optional)
      until - List transfers created strictly before this RFC-3339 timestamp (exclusive -- e.g. `2026-01-01T00:00:00Z` excludes transfers created exactly at that instant). (optional)
      sortDirection - Specify whether transfers should be sorted by creation time in ascending or descending order (optional, default to DESC)
      sortBy - Specify the field to sort by. Defaults to `created_at`. (optional, default to created_at)
      limit - Maximum number of transfers to return on one page (optional)
      pageToken - Page token for the next or previous page, used to continue listing transfers (optional)
      Returns:
      ApiResponse<AcatsListTransfersResponse>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      HTTP Response Details:
      Response Details
      Status Code Description Response Headers
      200 OK -
      400 Bad Request -
      403 Forbidden -
      500 Internal Server Error -

    • listACATSTransfersAsync

      public okhttp3.Call listACATSTransfersAsync(@Nullable String accountNumber, @Nullable AcatsDtccTransferType transferType, @Nullable AcatsTransferDirection transferDirection, @Nullable AcatsTransferStatus transferStatus, @Nullable AcatsDtccStatus dtccStatus, @Nullable String contraBrokerNumber, @Nullable OffsetDateTime since, @Nullable OffsetDateTime until, @Nullable AcatsSortDirection sortDirection, @Nullable String sortBy, @Nullable Integer limit, @Nullable String pageToken, ApiCallback<AcatsListTransfersResponse> _callback) throws ApiException
      List transfers (asynchronously) List all incoming and outgoing transfers, for all accounts. The list may include transfers not initiated using this API. The list is paginated: use the `page_token` query parameter with the value returned in the response to continue listing transfers.
      Parameters:
      accountNumber - Filter by the account number associated with the transfer (optional)
      transferType - Filter by the type of the transfer (optional)
      transferDirection - Filter by the direction of the transfer (optional)
      transferStatus - Filter by the current status of the transfer (optional)
      dtccStatus - Filter by the current DTCC status of the transfer (optional)
      contraBrokerNumber - Filter by the contra broker number of the transfer (optional)
      since - List transfers created at or after this RFC-3339 timestamp (e.g. `2026-01-01T00:00:00Z`). (optional)
      until - List transfers created strictly before this RFC-3339 timestamp (exclusive -- e.g. `2026-01-01T00:00:00Z` excludes transfers created exactly at that instant). (optional)
      sortDirection - Specify whether transfers should be sorted by creation time in ascending or descending order (optional, default to DESC)
      sortBy - Specify the field to sort by. Defaults to `created_at`. (optional, default to created_at)
      limit - Maximum number of transfers to return on one page (optional)
      pageToken - Page token for the next or previous page, used to continue listing transfers (optional)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object
      HTTP Response Details:
      Response Details
      Status Code Description Response Headers
      200 OK -
      400 Bad Request -
      403 Forbidden -
      500 Internal Server Error -

    • listACATSTransfersByAccountCall

      public okhttp3.Call listACATSTransfersByAccountCall(@Nonnull UUID accountId, @Nullable Integer limit, @Nullable String pageToken, ApiCallback _callback) throws ApiException
      Build call for listACATSTransfersByAccount
      Parameters:
      accountId - Account ID associated with the ACATS transfer (required)
      limit - Maximum number of transfers to return on one page (optional)
      pageToken - Page token for the next or previous page, used to continue listing transfers (optional)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
      HTTP Response Details:
      Response Details
      Status Code Description Response Headers
      200 OK -
      403 Forbidden -
      500 Internal Server Error -

    • listACATSTransfersByAccount

      public AcatsListTransfersResponse listACATSTransfersByAccount(@Nonnull UUID accountId, @Nullable Integer limit, @Nullable String pageToken) throws ApiException
      List transfers for an account List all incoming and outgoing transfers where the account was one of the parties. The list may include transfers not initiated using this API. By default, the response includes all transfers for the account for backwards compatibility. To paginate results, provide the `limit` query parameter and use the `page_token` value returned in the response to continue listing transfers.
      Parameters:
      accountId - Account ID associated with the ACATS transfer (required)
      limit - Maximum number of transfers to return on one page (optional)
      pageToken - Page token for the next or previous page, used to continue listing transfers (optional)
      Returns:
      AcatsListTransfersResponse
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      HTTP Response Details:
      Response Details
      Status Code Description Response Headers
      200 OK -
      403 Forbidden -
      500 Internal Server Error -

    • listACATSTransfersByAccountWithHttpInfo

      public ApiResponse<AcatsListTransfersResponse> listACATSTransfersByAccountWithHttpInfo(@Nonnull UUID accountId, @Nullable Integer limit, @Nullable String pageToken) throws ApiException
      List transfers for an account List all incoming and outgoing transfers where the account was one of the parties. The list may include transfers not initiated using this API. By default, the response includes all transfers for the account for backwards compatibility. To paginate results, provide the `limit` query parameter and use the `page_token` value returned in the response to continue listing transfers.
      Parameters:
      accountId - Account ID associated with the ACATS transfer (required)
      limit - Maximum number of transfers to return on one page (optional)
      pageToken - Page token for the next or previous page, used to continue listing transfers (optional)
      Returns:
      ApiResponse<AcatsListTransfersResponse>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      HTTP Response Details:
      Response Details
      Status Code Description Response Headers
      200 OK -
      403 Forbidden -
      500 Internal Server Error -

    • listACATSTransfersByAccountAsync

      public okhttp3.Call listACATSTransfersByAccountAsync(@Nonnull UUID accountId, @Nullable Integer limit, @Nullable String pageToken, ApiCallback<AcatsListTransfersResponse> _callback) throws ApiException
      List transfers for an account (asynchronously) List all incoming and outgoing transfers where the account was one of the parties. The list may include transfers not initiated using this API. By default, the response includes all transfers for the account for backwards compatibility. To paginate results, provide the `limit` query parameter and use the `page_token` value returned in the response to continue listing transfers.
      Parameters:
      accountId - Account ID associated with the ACATS transfer (required)
      limit - Maximum number of transfers to return on one page (optional)
      pageToken - Page token for the next or previous page, used to continue listing transfers (optional)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object
      HTTP Response Details:
      Response Details
      Status Code Description Response Headers
      200 OK -
      403 Forbidden -
      500 Internal Server Error -

    • requestACATSTransferCall

      public okhttp3.Call requestACATSTransferCall(@Nonnull UUID accountId, @Nonnull AcatsInitiateTransferRequest acatsInitiateTransferRequest, ApiCallback _callback) throws ApiException
      Build call for requestACATSTransfer
      Parameters:
      accountId - Account ID associated with the ACATS transfer (required)
      acatsInitiateTransferRequest - Details of the incoming ACATS transfer to initiate. (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
      202 Accepted -
      400 Bad Request -
      403 Forbidden -
      422 Unprocessable Entity. Returned when: - the cleansed contra account number contains no digit at all; - `validate_account_number` is `true` and the contra account number matches none of the contra broker's enabled format rules; - the calling correspondent is pending migration, in which case the account is treated as being in distribution. -
      500 Internal Server Error -

    • requestACATSTransfer

      public AcatsInitiateTransferResponse requestACATSTransfer(@Nonnull UUID accountId, @Nonnull AcatsInitiateTransferRequest acatsInitiateTransferRequest) throws ApiException
      Initiate an incoming transfer This endpoint allows you to create new incoming ACATS requests. We currently support full and partial transfer types, for US equities and cash. Note that after submitting a request, it might take some time for the transfer to show up on the other endpoints. Transfers are not immediately sent to DTCC, and will appear in the `PENDING` state initially.
      Parameters:
      accountId - Account ID associated with the ACATS transfer (required)
      acatsInitiateTransferRequest - Details of the incoming ACATS transfer to initiate. (required)
      Returns:
      AcatsInitiateTransferResponse
      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
      202 Accepted -
      400 Bad Request -
      403 Forbidden -
      422 Unprocessable Entity. Returned when: - the cleansed contra account number contains no digit at all; - `validate_account_number` is `true` and the contra account number matches none of the contra broker's enabled format rules; - the calling correspondent is pending migration, in which case the account is treated as being in distribution. -
      500 Internal Server Error -

    • requestACATSTransferWithHttpInfo

      public ApiResponse<AcatsInitiateTransferResponse> requestACATSTransferWithHttpInfo(@Nonnull UUID accountId, @Nonnull AcatsInitiateTransferRequest acatsInitiateTransferRequest) throws ApiException
      Initiate an incoming transfer This endpoint allows you to create new incoming ACATS requests. We currently support full and partial transfer types, for US equities and cash. Note that after submitting a request, it might take some time for the transfer to show up on the other endpoints. Transfers are not immediately sent to DTCC, and will appear in the `PENDING` state initially.
      Parameters:
      accountId - Account ID associated with the ACATS transfer (required)
      acatsInitiateTransferRequest - Details of the incoming ACATS transfer to initiate. (required)
      Returns:
      ApiResponse<AcatsInitiateTransferResponse>
      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
      202 Accepted -
      400 Bad Request -
      403 Forbidden -
      422 Unprocessable Entity. Returned when: - the cleansed contra account number contains no digit at all; - `validate_account_number` is `true` and the contra account number matches none of the contra broker's enabled format rules; - the calling correspondent is pending migration, in which case the account is treated as being in distribution. -
      500 Internal Server Error -

    • requestACATSTransferAsync

      public okhttp3.Call requestACATSTransferAsync(@Nonnull UUID accountId, @Nonnull AcatsInitiateTransferRequest acatsInitiateTransferRequest, ApiCallback<AcatsInitiateTransferResponse> _callback) throws ApiException
      Initiate an incoming transfer (asynchronously) This endpoint allows you to create new incoming ACATS requests. We currently support full and partial transfer types, for US equities and cash. Note that after submitting a request, it might take some time for the transfer to show up on the other endpoints. Transfers are not immediately sent to DTCC, and will appear in the `PENDING` state initially.
      Parameters:
      accountId - Account ID associated with the ACATS transfer (required)
      acatsInitiateTransferRequest - Details of the incoming ACATS transfer to initiate. (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
      202 Accepted -
      400 Bad Request -
      403 Forbidden -
      422 Unprocessable Entity. Returned when: - the cleansed contra account number contains no digit at all; - `validate_account_number` is `true` and the contra account number matches none of the contra broker's enabled format rules; - the calling correspondent is pending migration, in which case the account is treated as being in distribution. -
      500 Internal Server Error -