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

Class InstantFundingApi

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

  • deleteV1InstantFundingSingle: Cancel an instant funding request
  • getV1InstantFundingAccountLimits: Get instant funding account limits
  • getV1InstantFundingCorrespondentLimits: Get instant funding limits
  • getV1InstantFundingList: Get Instant Funding List
  • getV1InstantFundingReports: Get instant funding report
  • getV1InstantFundingSettlements: List settlements
  • getV1InstantFundingSettlementsSingle: Get a single settlement
  • getV1InstantFundingSingle: Get an instant funding request
  • postV1InstantFunding: Create an instant funding request
  • postV1InstantFundingSettlements: Create a new settlement

  • Constructor Details

    • InstantFundingApi

      public InstantFundingApi()

    • InstantFundingApi

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

    • deleteV1InstantFundingSingleCall

      public okhttp3.Call deleteV1InstantFundingSingleCall(@Nonnull String instantFundingId, ApiCallback _callback) throws ApiException
      Build call for deleteV1InstantFundingSingle
      Parameters:
      instantFundingId - UUID ID of the instant funding transfer to cancel (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
      204 Successful response. -
      0 Error response. -

    • deleteV1InstantFundingSingle

      public void deleteV1InstantFundingSingle(@Nonnull String instantFundingId) throws ApiException
      Cancel an instant funding request Cancels a single instant funding request based on the ID supplied if possible.
      Parameters:
      instantFundingId - UUID ID of the instant funding transfer to cancel (required)
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      HTTP Response Details:
      Response Details
      Status Code Description Response Headers
      204 Successful response. -
      0 Error response. -

    • deleteV1InstantFundingSingleWithHttpInfo

      public ApiResponse<Void> deleteV1InstantFundingSingleWithHttpInfo(@Nonnull String instantFundingId) throws ApiException
      Cancel an instant funding request Cancels a single instant funding request based on the ID supplied if possible.
      Parameters:
      instantFundingId - UUID ID of the instant funding transfer to cancel (required)
      Returns:
      ApiResponse<Void>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      HTTP Response Details:
      Response Details
      Status Code Description Response Headers
      204 Successful response. -
      0 Error response. -

    • deleteV1InstantFundingSingleAsync

      public okhttp3.Call deleteV1InstantFundingSingleAsync(@Nonnull String instantFundingId, ApiCallback<Void> _callback) throws ApiException
      Cancel an instant funding request (asynchronously) Cancels a single instant funding request based on the ID supplied if possible.
      Parameters:
      instantFundingId - UUID ID of the instant funding transfer to cancel (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
      204 Successful response. -
      0 Error response. -

    • getV1InstantFundingAccountLimitsCall

      public okhttp3.Call getV1InstantFundingAccountLimitsCall(@Nonnull List<String> accountNumbers, ApiCallback _callback) throws ApiException
      Build call for getV1InstantFundingAccountLimits
      Parameters:
      accountNumbers - Filter limits based on comma-separated account numbers (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 invidual broker account limits -
      0 error -

    • getV1InstantFundingAccountLimits

      public List<AccountLimit> getV1InstantFundingAccountLimits(@Nonnull List<String> accountNumbers) throws ApiException
      Get instant funding account limits Returns the limits for individual partner accounts.
      Parameters:
      accountNumbers - Filter limits based on comma-separated account numbers (required)
      Returns:
      List<AccountLimit>
      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 invidual broker account limits -
      0 error -

    • getV1InstantFundingAccountLimitsWithHttpInfo

      public ApiResponse<List<AccountLimit>> getV1InstantFundingAccountLimitsWithHttpInfo(@Nonnull List<String> accountNumbers) throws ApiException
      Get instant funding account limits Returns the limits for individual partner accounts.
      Parameters:
      accountNumbers - Filter limits based on comma-separated account numbers (required)
      Returns:
      ApiResponse<List<AccountLimit>>
      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 invidual broker account limits -
      0 error -

    • getV1InstantFundingAccountLimitsAsync

      public okhttp3.Call getV1InstantFundingAccountLimitsAsync(@Nonnull List<String> accountNumbers, ApiCallback<List<AccountLimit>> _callback) throws ApiException
      Get instant funding account limits (asynchronously) Returns the limits for individual partner accounts.
      Parameters:
      accountNumbers - Filter limits based on comma-separated account numbers (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 invidual broker account limits -
      0 error -

    • getV1InstantFundingCorrespondentLimitsCall

      public okhttp3.Call getV1InstantFundingCorrespondentLimitsCall(ApiCallback _callback) throws ApiException
      Build call for getV1InstantFundingCorrespondentLimits
      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 correspondent instant funding limits -
      0 error -

    • getV1InstantFundingCorrespondentLimits

      public CorrespondentLimit getV1InstantFundingCorrespondentLimits() throws ApiException
      Get instant funding limits Returns globally configured limits for the correspondent. These limits are used to determine the maximum amount that can be extended to all accounts, and reaching this limit will result in further requests to create instant funding requests being rejected.
      Returns:
      CorrespondentLimit
      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 correspondent instant funding limits -
      0 error -

    • getV1InstantFundingCorrespondentLimitsWithHttpInfo

      public ApiResponse<CorrespondentLimit> getV1InstantFundingCorrespondentLimitsWithHttpInfo() throws ApiException
      Get instant funding limits Returns globally configured limits for the correspondent. These limits are used to determine the maximum amount that can be extended to all accounts, and reaching this limit will result in further requests to create instant funding requests being rejected.
      Returns:
      ApiResponse<CorrespondentLimit>
      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 correspondent instant funding limits -
      0 error -

    • getV1InstantFundingCorrespondentLimitsAsync

      public okhttp3.Call getV1InstantFundingCorrespondentLimitsAsync(ApiCallback<CorrespondentLimit> _callback) throws ApiException
      Get instant funding limits (asynchronously) Returns globally configured limits for the correspondent. These limits are used to determine the maximum amount that can be extended to all accounts, and reaching this limit will result in further requests to create instant funding requests being rejected.
      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 correspondent instant funding limits -
      0 error -

    • getV1InstantFundingListCall

      public okhttp3.Call getV1InstantFundingListCall(@Nullable ListSortBy sortBy, @Nullable SortOrder sortOrder, @Nullable Integer limit, @Nullable Integer offset, @Nullable LocalDate systemDate, @Nullable LocalDate deadline, @Nullable InstantFundingStatus status, @Nullable OffsetDateTime before, ApiCallback _callback) throws ApiException
      Build call for getV1InstantFundingList
      Parameters:
      sortBy - sort results based on created_at, amount, and deadline (optional)
      sortOrder - Defines the ordering of sort_by query. Defaults to ASC when not specified. (optional)
      limit - defines the number of results that will be returned from the request (optional)
      offset - defines the number of results that will be skipped before picking the results that will be returned (optional)
      systemDate - filter transfers based on system date (optional)
      deadline - filter transfers based on settlement deadline (optional)
      status - filter transfers based on status (optional)
      before - filter transfers based on the date of creation (optional)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
      HTTP Response Details:
      Response Details
      Status Code Description Response Headers
      200 list of transfers -
      0 error -

    • getV1InstantFundingList

      public List<InstantFunding> getV1InstantFundingList(@Nullable ListSortBy sortBy, @Nullable SortOrder sortOrder, @Nullable Integer limit, @Nullable Integer offset, @Nullable LocalDate systemDate, @Nullable LocalDate deadline, @Nullable InstantFundingStatus status, @Nullable OffsetDateTime before) throws ApiException
      Get Instant Funding List Returns a list of instant funding records based on the query parameters. The results are paginated, sorted, and filtered based on the parameters provided.
      Parameters:
      sortBy - sort results based on created_at, amount, and deadline (optional)
      sortOrder - Defines the ordering of sort_by query. Defaults to ASC when not specified. (optional)
      limit - defines the number of results that will be returned from the request (optional)
      offset - defines the number of results that will be skipped before picking the results that will be returned (optional)
      systemDate - filter transfers based on system date (optional)
      deadline - filter transfers based on settlement deadline (optional)
      status - filter transfers based on status (optional)
      before - filter transfers based on the date of creation (optional)
      Returns:
      List<InstantFunding>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      HTTP Response Details:
      Response Details
      Status Code Description Response Headers
      200 list of transfers -
      0 error -

    • getV1InstantFundingListWithHttpInfo

      public ApiResponse<List<InstantFunding>> getV1InstantFundingListWithHttpInfo(@Nullable ListSortBy sortBy, @Nullable SortOrder sortOrder, @Nullable Integer limit, @Nullable Integer offset, @Nullable LocalDate systemDate, @Nullable LocalDate deadline, @Nullable InstantFundingStatus status, @Nullable OffsetDateTime before) throws ApiException
      Get Instant Funding List Returns a list of instant funding records based on the query parameters. The results are paginated, sorted, and filtered based on the parameters provided.
      Parameters:
      sortBy - sort results based on created_at, amount, and deadline (optional)
      sortOrder - Defines the ordering of sort_by query. Defaults to ASC when not specified. (optional)
      limit - defines the number of results that will be returned from the request (optional)
      offset - defines the number of results that will be skipped before picking the results that will be returned (optional)
      systemDate - filter transfers based on system date (optional)
      deadline - filter transfers based on settlement deadline (optional)
      status - filter transfers based on status (optional)
      before - filter transfers based on the date of creation (optional)
      Returns:
      ApiResponse<List<InstantFunding>>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      HTTP Response Details:
      Response Details
      Status Code Description Response Headers
      200 list of transfers -
      0 error -

    • getV1InstantFundingListAsync

      public okhttp3.Call getV1InstantFundingListAsync(@Nullable ListSortBy sortBy, @Nullable SortOrder sortOrder, @Nullable Integer limit, @Nullable Integer offset, @Nullable LocalDate systemDate, @Nullable LocalDate deadline, @Nullable InstantFundingStatus status, @Nullable OffsetDateTime before, ApiCallback<List<InstantFunding>> _callback) throws ApiException
      Get Instant Funding List (asynchronously) Returns a list of instant funding records based on the query parameters. The results are paginated, sorted, and filtered based on the parameters provided.
      Parameters:
      sortBy - sort results based on created_at, amount, and deadline (optional)
      sortOrder - Defines the ordering of sort_by query. Defaults to ASC when not specified. (optional)
      limit - defines the number of results that will be returned from the request (optional)
      offset - defines the number of results that will be skipped before picking the results that will be returned (optional)
      systemDate - filter transfers based on system date (optional)
      deadline - filter transfers based on settlement deadline (optional)
      status - filter transfers based on status (optional)
      before - filter transfers based on the date of creation (optional)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object
      HTTP Response Details:
      Response Details
      Status Code Description Response Headers
      200 list of transfers -
      0 error -

    • getV1InstantFundingReportsCall

      public okhttp3.Call getV1InstantFundingReportsCall(@Nullable String reportType, @Nullable LocalDate systemDate, ApiCallback _callback) throws ApiException
      Build call for getV1InstantFundingReports
      Parameters:
      reportType - The report type to be returned; 'summary' or 'detail', defaults to 'summary' (optional)
      systemDate - The system date to be used for the report. If not provided then the last system date will be used. (optional)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
      HTTP Response Details:
      Response Details
      Status Code Description Response Headers
      200 Successful response. -
      0 Error response. -

    • getV1InstantFundingReports

      public List<ReportsResponse> getV1InstantFundingReports(@Nullable String reportType, @Nullable LocalDate systemDate) throws ApiException
      Get instant funding report Returns instant funding reports which are to be used for daily reconciliation reporting.
      Parameters:
      reportType - The report type to be returned; 'summary' or 'detail', defaults to 'summary' (optional)
      systemDate - The system date to be used for the report. If not provided then the last system date will be used. (optional)
      Returns:
      List<ReportsResponse>
      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. -
      0 Error response. -

    • getV1InstantFundingReportsWithHttpInfo

      public ApiResponse<List<ReportsResponse>> getV1InstantFundingReportsWithHttpInfo(@Nullable String reportType, @Nullable LocalDate systemDate) throws ApiException
      Get instant funding report Returns instant funding reports which are to be used for daily reconciliation reporting.
      Parameters:
      reportType - The report type to be returned; 'summary' or 'detail', defaults to 'summary' (optional)
      systemDate - The system date to be used for the report. If not provided then the last system date will be used. (optional)
      Returns:
      ApiResponse<List<ReportsResponse>>
      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. -
      0 Error response. -

    • getV1InstantFundingReportsAsync

      public okhttp3.Call getV1InstantFundingReportsAsync(@Nullable String reportType, @Nullable LocalDate systemDate, ApiCallback<List<ReportsResponse>> _callback) throws ApiException
      Get instant funding report (asynchronously) Returns instant funding reports which are to be used for daily reconciliation reporting.
      Parameters:
      reportType - The report type to be returned; 'summary' or 'detail', defaults to 'summary' (optional)
      systemDate - The system date to be used for the report. If not provided then the last system date will be used. (optional)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object
      HTTP Response Details:
      Response Details
      Status Code Description Response Headers
      200 Successful response. -
      0 Error response. -

    • getV1InstantFundingSettlementsCall

      public okhttp3.Call getV1InstantFundingSettlementsCall(@Nullable String statuses, ApiCallback _callback) throws ApiException
      Build call for getV1InstantFundingSettlements
      Parameters:
      statuses - comma delimited list of statuses to use as a filter (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. -
      0 Error response. -

    • getV1InstantFundingSettlements

      public SettlementsResponse getV1InstantFundingSettlements(@Nullable String statuses) throws ApiException
      List settlements Returns all settlements filtered by status if provided.
      Parameters:
      statuses - comma delimited list of statuses to use as a filter (optional)
      Returns:
      SettlementsResponse
      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. -
      0 Error response. -

    • getV1InstantFundingSettlementsWithHttpInfo

      public ApiResponse<SettlementsResponse> getV1InstantFundingSettlementsWithHttpInfo(@Nullable String statuses) throws ApiException
      List settlements Returns all settlements filtered by status if provided.
      Parameters:
      statuses - comma delimited list of statuses to use as a filter (optional)
      Returns:
      ApiResponse<SettlementsResponse>
      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. -
      0 Error response. -

    • getV1InstantFundingSettlementsAsync

      public okhttp3.Call getV1InstantFundingSettlementsAsync(@Nullable String statuses, ApiCallback<SettlementsResponse> _callback) throws ApiException
      List settlements (asynchronously) Returns all settlements filtered by status if provided.
      Parameters:
      statuses - comma delimited list of statuses to use as a filter (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. -
      0 Error response. -

    • getV1InstantFundingSettlementsSingleCall

      public okhttp3.Call getV1InstantFundingSettlementsSingleCall(@Nonnull UUID settlementId, ApiCallback _callback) throws ApiException
      Build call for getV1InstantFundingSettlementsSingle
      Parameters:
      settlementId - ID of the settlement (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. -
      0 Error response. -

    • getV1InstantFundingSettlementsSingle

      public SettlementResponse getV1InstantFundingSettlementsSingle(@Nonnull UUID settlementId) throws ApiException
      Get a single settlement Returns the settlement specified by the path parameter.
      Parameters:
      settlementId - ID of the settlement (required)
      Returns:
      SettlementResponse
      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. -
      0 Error response. -

    • getV1InstantFundingSettlementsSingleWithHttpInfo

      public ApiResponse<SettlementResponse> getV1InstantFundingSettlementsSingleWithHttpInfo(@Nonnull UUID settlementId) throws ApiException
      Get a single settlement Returns the settlement specified by the path parameter.
      Parameters:
      settlementId - ID of the settlement (required)
      Returns:
      ApiResponse<SettlementResponse>
      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. -
      0 Error response. -

    • getV1InstantFundingSettlementsSingleAsync

      public okhttp3.Call getV1InstantFundingSettlementsSingleAsync(@Nonnull UUID settlementId, ApiCallback<SettlementResponse> _callback) throws ApiException
      Get a single settlement (asynchronously) Returns the settlement specified by the path parameter.
      Parameters:
      settlementId - ID of the settlement (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. -
      0 Error response. -

    • getV1InstantFundingSingleCall

      public okhttp3.Call getV1InstantFundingSingleCall(@Nonnull String instantFundingId, ApiCallback _callback) throws ApiException
      Build call for getV1InstantFundingSingle
      Parameters:
      instantFundingId - ID of the instant funding 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 Successful response. -
      0 Error response. -

    • getV1InstantFundingSingle

      public InstantFunding getV1InstantFundingSingle(@Nonnull String instantFundingId) throws ApiException
      Get an instant funding request Returns an instant funding transfer based on the ID supplied.
      Parameters:
      instantFundingId - ID of the instant funding transfer (required)
      Returns:
      InstantFunding
      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. -
      0 Error response. -

    • getV1InstantFundingSingleWithHttpInfo

      public ApiResponse<InstantFunding> getV1InstantFundingSingleWithHttpInfo(@Nonnull String instantFundingId) throws ApiException
      Get an instant funding request Returns an instant funding transfer based on the ID supplied.
      Parameters:
      instantFundingId - ID of the instant funding transfer (required)
      Returns:
      ApiResponse<InstantFunding>
      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. -
      0 Error response. -

    • getV1InstantFundingSingleAsync

      public okhttp3.Call getV1InstantFundingSingleAsync(@Nonnull String instantFundingId, ApiCallback<InstantFunding> _callback) throws ApiException
      Get an instant funding request (asynchronously) Returns an instant funding transfer based on the ID supplied.
      Parameters:
      instantFundingId - ID of the instant funding 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 Successful response. -
      0 Error response. -

    • postV1InstantFundingCall

      public okhttp3.Call postV1InstantFundingCall(@Nonnull CreateIFTransferRequest createIFTransferRequest, @Nullable String idempotencyKey, ApiCallback _callback) throws ApiException
      Build call for postV1InstantFunding
      Parameters:
      createIFTransferRequest - details of the instant funding request (required)
      idempotencyKey - Unique key for idempotent create. When supplied, duplicate requests (same key and body) return the original transfer instead of creating a new one. Use a client-generated value (e.g. UUID) per logical transfer. Strongly recommended for production to prevent duplicate transfers on retries. (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 Instant transfer request created. -
      422 Unprocessable Entity. Returned when an idempotency key is reused with a different request body. -
      0 Error response. -

    • postV1InstantFunding

      public InstantFunding postV1InstantFunding(@Nonnull CreateIFTransferRequest createIFTransferRequest, @Nullable String idempotencyKey) throws ApiException
      Create an instant funding request Creates an instant funding request. The request will be processed and the funds will be made available to the account in the form of a Memopost non trade activity. Upon settlement the Memoposted will be corrected to a CSD activity. **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 transfer. A subsequent request returns the previously created transfer 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 creating transfers. This allows safe retries on timeouts, network errors, or 5xx responses without risking duplicate transfers. Use a client-generated unique value (e.g. UUID).
      Parameters:
      createIFTransferRequest - details of the instant funding request (required)
      idempotencyKey - Unique key for idempotent create. When supplied, duplicate requests (same key and body) return the original transfer instead of creating a new one. Use a client-generated value (e.g. UUID) per logical transfer. Strongly recommended for production to prevent duplicate transfers on retries. (optional)
      Returns:
      InstantFunding
      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 Instant transfer request created. -
      422 Unprocessable Entity. Returned when an idempotency key is reused with a different request body. -
      0 Error response. -

    • postV1InstantFundingWithHttpInfo

      public ApiResponse<InstantFunding> postV1InstantFundingWithHttpInfo(@Nonnull CreateIFTransferRequest createIFTransferRequest, @Nullable String idempotencyKey) throws ApiException
      Create an instant funding request Creates an instant funding request. The request will be processed and the funds will be made available to the account in the form of a Memopost non trade activity. Upon settlement the Memoposted will be corrected to a CSD activity. **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 transfer. A subsequent request returns the previously created transfer 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 creating transfers. This allows safe retries on timeouts, network errors, or 5xx responses without risking duplicate transfers. Use a client-generated unique value (e.g. UUID).
      Parameters:
      createIFTransferRequest - details of the instant funding request (required)
      idempotencyKey - Unique key for idempotent create. When supplied, duplicate requests (same key and body) return the original transfer instead of creating a new one. Use a client-generated value (e.g. UUID) per logical transfer. Strongly recommended for production to prevent duplicate transfers on retries. (optional)
      Returns:
      ApiResponse<InstantFunding>
      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 Instant transfer request created. -
      422 Unprocessable Entity. Returned when an idempotency key is reused with a different request body. -
      0 Error response. -

    • postV1InstantFundingAsync

      public okhttp3.Call postV1InstantFundingAsync(@Nonnull CreateIFTransferRequest createIFTransferRequest, @Nullable String idempotencyKey, ApiCallback<InstantFunding> _callback) throws ApiException
      Create an instant funding request (asynchronously) Creates an instant funding request. The request will be processed and the funds will be made available to the account in the form of a Memopost non trade activity. Upon settlement the Memoposted will be corrected to a CSD activity. **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 transfer. A subsequent request returns the previously created transfer 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 creating transfers. This allows safe retries on timeouts, network errors, or 5xx responses without risking duplicate transfers. Use a client-generated unique value (e.g. UUID).
      Parameters:
      createIFTransferRequest - details of the instant funding request (required)
      idempotencyKey - Unique key for idempotent create. When supplied, duplicate requests (same key and body) return the original transfer instead of creating a new one. Use a client-generated value (e.g. UUID) per logical transfer. Strongly recommended for production to prevent duplicate transfers on retries. (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 Instant transfer request created. -
      422 Unprocessable Entity. Returned when an idempotency key is reused with a different request body. -
      0 Error response. -

    • postV1InstantFundingSettlementsCall

      public okhttp3.Call postV1InstantFundingSettlementsCall(@Nonnull CreateSettlementRequest createSettlementRequest, ApiCallback _callback) throws ApiException
      Build call for postV1InstantFundingSettlements
      Parameters:
      createSettlementRequest - details of the settlement request (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 Settlement created. -
      0 Error response. -

    • postV1InstantFundingSettlements

      public SettlementResponse postV1InstantFundingSettlements(@Nonnull CreateSettlementRequest createSettlementRequest) throws ApiException
      Create a new settlement Creates a new settlement, which will trigger the reconciliation process for all included transfers and their interests. There is a limit of 50,000 transfers per settlement. If more than 50,000 transfers need to be settled, they should be batched in multiple settlements.
      Parameters:
      createSettlementRequest - details of the settlement request (required)
      Returns:
      SettlementResponse
      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 Settlement created. -
      0 Error response. -

    • postV1InstantFundingSettlementsWithHttpInfo

      public ApiResponse<SettlementResponse> postV1InstantFundingSettlementsWithHttpInfo(@Nonnull CreateSettlementRequest createSettlementRequest) throws ApiException
      Create a new settlement Creates a new settlement, which will trigger the reconciliation process for all included transfers and their interests. There is a limit of 50,000 transfers per settlement. If more than 50,000 transfers need to be settled, they should be batched in multiple settlements.
      Parameters:
      createSettlementRequest - details of the settlement request (required)
      Returns:
      ApiResponse<SettlementResponse>
      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 Settlement created. -
      0 Error response. -

    • postV1InstantFundingSettlementsAsync

      public okhttp3.Call postV1InstantFundingSettlementsAsync(@Nonnull CreateSettlementRequest createSettlementRequest, ApiCallback<SettlementResponse> _callback) throws ApiException
      Create a new settlement (asynchronously) Creates a new settlement, which will trigger the reconciliation process for all included transfers and their interests. There is a limit of 50,000 transfers per settlement. If more than 50,000 transfers need to be settled, they should be batched in multiple settlements.
      Parameters:
      createSettlementRequest - details of the settlement request (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 Settlement created. -
      0 Error response. -