Package io.moov.sdk

Class FeePlans

    • Method Detail

      • listFeePlanAgreements

        public ListFeePlanAgreementsRequestBuilder listFeePlanAgreements()
        List all fee plan agreements associated with an account.

        To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/) you'll need to specify the `/accounts/{accountID}/profile.read` scope.

        Returns:
        The call builder

      • listFeePlanAgreements

        public ListFeePlanAgreementsResponse listFeePlanAgreements​(ListFeePlanAgreementsRequest request)
                                                    throws java.lang.Exception
        List all fee plan agreements associated with an account.

        To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/) you'll need to specify the `/accounts/{accountID}/profile.read` scope.

        Specified by:
        listFeePlanAgreements in interface SDKMethodInterfaces.MethodCallListFeePlanAgreements
        Parameters:
        request - The request object containing all of the parameters for the API call.
        Returns:
        The response from the API call
        Throws:
        java.lang.Exception - if the API call fails

      • createFeePlanAgreements

        public CreateFeePlanAgreementsRequestBuilder createFeePlanAgreements()
        Creates the subscription of a fee plan to a merchant account. Merchants are required to accept the fee plan terms prior to activation.

        To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/) you'll need to specify the `/accounts/{accountID}/profile.write` scope.

        Returns:
        The call builder

      • createFeePlanAgreements

        public CreateFeePlanAgreementsResponse createFeePlanAgreements​(java.lang.String accountID,
                                                               CreateFeePlanAgreement createFeePlanAgreement)
                                                        throws java.lang.Exception
        Creates the subscription of a fee plan to a merchant account. Merchants are required to accept the fee plan terms prior to activation.

        To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/) you'll need to specify the `/accounts/{accountID}/profile.write` scope.

        Parameters:
        accountID -
        createFeePlanAgreement -
        Returns:
        The response from the API call
        Throws:
        java.lang.Exception - if the API call fails

      • createFeePlanAgreements

        public CreateFeePlanAgreementsResponse createFeePlanAgreements​(java.util.Optional<java.lang.String> xMoovVersion,
                                                               java.lang.String accountID,
                                                               CreateFeePlanAgreement createFeePlanAgreement)
                                                        throws java.lang.Exception
        Creates the subscription of a fee plan to a merchant account. Merchants are required to accept the fee plan terms prior to activation.

        To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/) you'll need to specify the `/accounts/{accountID}/profile.write` scope.

        Specified by:
        createFeePlanAgreements in interface SDKMethodInterfaces.MethodCallCreateFeePlanAgreements
        Parameters:
        xMoovVersion - Specify an API version. API versioning follows the format `vYYYY.QQ.BB`, where - `YYYY` is the year - `QQ` is the two-digit month for the first month of the quarter (e.g., 01, 04, 07, 10) - `BB` is the build number, starting at `.01`, for subsequent builds in the same quarter. - For example, `v2024.01.00` is the initial release of the first quarter of 2024. The `latest` version represents the most recent development state. It may include breaking changes and should be treated as a beta release.
        accountID -
        createFeePlanAgreement -
        Returns:
        The response from the API call
        Throws:
        java.lang.Exception - if the API call fails

      • listFeePlans

        public ListFeePlansRequestBuilder listFeePlans()
        List all fee plans available for use by an account. This is intended to be used by an account when selecting a fee plan to apply to a connected account.

        To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/) you'll need to specify the `/accounts/{accountID}/profile.read` scope.

        Returns:
        The call builder

      • listFeePlans

        public ListFeePlansResponse listFeePlans​(java.lang.String accountID)
                                  throws java.lang.Exception
        List all fee plans available for use by an account. This is intended to be used by an account when selecting a fee plan to apply to a connected account.

        To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/) you'll need to specify the `/accounts/{accountID}/profile.read` scope.

        Parameters:
        accountID -
        Returns:
        The response from the API call
        Throws:
        java.lang.Exception - if the API call fails

      • listFeePlans

        public ListFeePlansResponse listFeePlans​(java.util.Optional<java.lang.String> xMoovVersion,
                                         java.lang.String accountID,
                                         java.util.Optional<? extends java.util.List<java.lang.String>> planIDs)
                                  throws java.lang.Exception
        List all fee plans available for use by an account. This is intended to be used by an account when selecting a fee plan to apply to a connected account.

        To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/) you'll need to specify the `/accounts/{accountID}/profile.read` scope.

        Specified by:
        listFeePlans in interface SDKMethodInterfaces.MethodCallListFeePlans
        Parameters:
        xMoovVersion - Specify an API version. API versioning follows the format `vYYYY.QQ.BB`, where - `YYYY` is the year - `QQ` is the two-digit month for the first month of the quarter (e.g., 01, 04, 07, 10) - `BB` is the build number, starting at `.01`, for subsequent builds in the same quarter. - For example, `v2024.01.00` is the initial release of the first quarter of 2024. The `latest` version represents the most recent development state. It may include breaking changes and should be treated as a beta release.
        accountID -
        planIDs - A comma-separated list of plan IDs to filter the results by.
        Returns:
        The response from the API call
        Throws:
        java.lang.Exception - if the API call fails

      • retrieveFees

        public RetrieveFeesRequestBuilder retrieveFees()
        Retrieve fees associated with an account.

        To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/) you'll need to specify the `/accounts/{accountID}/transfers.read` scope.

        Returns:
        The call builder

      • retrieveFees

        public RetrieveFeesResponse retrieveFees​(RetrieveFeesRequest request)
                                  throws java.lang.Exception
        Retrieve fees associated with an account.

        To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/) you'll need to specify the `/accounts/{accountID}/transfers.read` scope.

        Specified by:
        retrieveFees in interface SDKMethodInterfaces.MethodCallRetrieveFees
        Parameters:
        request - The request object containing all of the parameters for the API call.
        Returns:
        The response from the API call
        Throws:
        java.lang.Exception - if the API call fails

      • listFeesFetch

        public ListFeesFetchRequestBuilder listFeesFetch()
        List fees associated with an account.

        To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/) you'll need to specify the `/accounts/{accountID}/transfers.read` scope.

        Returns:
        The call builder

      • listFeesFetch

        public ListFeesFetchResponse listFeesFetch​(java.lang.String accountID)
                                    throws java.lang.Exception
        List fees associated with an account.

        To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/) you'll need to specify the `/accounts/{accountID}/transfers.read` scope.

        Parameters:
        accountID -
        Returns:
        The response from the API call
        Throws:
        java.lang.Exception - if the API call fails

      • listFeesFetch

        public ListFeesFetchResponse listFeesFetch​(java.util.Optional<java.lang.String> xMoovVersion,
                                           java.lang.String accountID,
                                           java.util.Optional<? extends ListFeesFetchRequest> listFeesFetchRequest)
                                    throws java.lang.Exception
        List fees associated with an account.

        To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/) you'll need to specify the `/accounts/{accountID}/transfers.read` scope.

        Specified by:
        listFeesFetch in interface SDKMethodInterfaces.MethodCallListFeesFetch
        Parameters:
        xMoovVersion - Specify an API version. API versioning follows the format `vYYYY.QQ.BB`, where - `YYYY` is the year - `QQ` is the two-digit month for the first month of the quarter (e.g., 01, 04, 07, 10) - `BB` is the build number, starting at `.01`, for subsequent builds in the same quarter. - For example, `v2024.01.00` is the initial release of the first quarter of 2024. The `latest` version represents the most recent development state. It may include breaking changes and should be treated as a beta release.
        accountID -
        listFeesFetchRequest - Array of fee IDs to fetch.
        Returns:
        The response from the API call
        Throws:
        java.lang.Exception - if the API call fails

      • listPartnerPricing

        public ListPartnerPricingRequestBuilder listPartnerPricing()
        List all partner pricing plans available for use by an account.

        To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/) you'll need to specify the `/accounts/{accountID}/profile.read` scope.

        Returns:
        The call builder

      • listPartnerPricing

        public ListPartnerPricingResponse listPartnerPricing​(java.lang.String accountID)
                                              throws java.lang.Exception
        List all partner pricing plans available for use by an account.

        To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/) you'll need to specify the `/accounts/{accountID}/profile.read` scope.

        Parameters:
        accountID -
        Returns:
        The response from the API call
        Throws:
        java.lang.Exception - if the API call fails

      • listPartnerPricing

        public ListPartnerPricingResponse listPartnerPricing​(java.util.Optional<java.lang.String> xMoovVersion,
                                                     java.lang.String accountID,
                                                     java.util.Optional<? extends java.util.List<java.lang.String>> planIDs)
                                              throws java.lang.Exception
        List all partner pricing plans available for use by an account.

        To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/) you'll need to specify the `/accounts/{accountID}/profile.read` scope.

        Specified by:
        listPartnerPricing in interface SDKMethodInterfaces.MethodCallListPartnerPricing
        Parameters:
        xMoovVersion - Specify an API version. API versioning follows the format `vYYYY.QQ.BB`, where - `YYYY` is the year - `QQ` is the two-digit month for the first month of the quarter (e.g., 01, 04, 07, 10) - `BB` is the build number, starting at `.01`, for subsequent builds in the same quarter. - For example, `v2024.01.00` is the initial release of the first quarter of 2024. The `latest` version represents the most recent development state. It may include breaking changes and should be treated as a beta release.
        accountID -
        planIDs - A comma-separated list of plan IDs to filter the results by.
        Returns:
        The response from the API call
        Throws:
        java.lang.Exception - if the API call fails

      • listPartnerPricingAgreements

        public ListPartnerPricingAgreementsRequestBuilder listPartnerPricingAgreements()
        List all partner pricing agreements associated with an account.

        To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/) you'll need to specify the `/accounts/{accountID}/profile.read` scope.

        Returns:
        The call builder