Package io.moov.sdk

Class FeePlans

java.lang.Object

io.moov.sdk.FeePlans

public class FeePlans
extends java.lang.Object

Method Summary

Modifier and Type	Method	Description
CreateFeePlanAgreementsRequestBuilder	createFeePlanAgreements()	Creates the subscription of a fee plan to a merchant account.
CreateFeePlanAgreementsResponse	createFeePlanAgreements(java.lang.String accountID, CreateFeePlanAgreement createFeePlanAgreement)	Creates the subscription of a fee plan to a merchant account.
ListFeePlanAgreementsRequestBuilder	listFeePlanAgreements()	List all fee plan agreements associated with an account.
ListFeePlanAgreementsResponse	listFeePlanAgreements(ListFeePlanAgreementsRequest request)	List all fee plan agreements associated with an account.
ListFeePlansRequestBuilder	listFeePlans()	List all fee plans available for use by an account.
ListFeePlansResponse	listFeePlans(java.lang.String accountID)	List all fee plans available for use by an account.
ListFeePlansResponse	listFeePlans(java.lang.String accountID, java.util.Optional<? extends java.util.List<java.lang.String>> planIDs)	List all fee plans available for use by an account.
ListFeesFetchRequestBuilder	listFeesFetch()	List fees associated with an account.
ListFeesFetchResponse	listFeesFetch(java.lang.String accountID)	List fees associated with an account.
ListFeesFetchResponse	listFeesFetch(java.lang.String accountID, java.util.Optional<? extends ListFeesFetchRequest> listFeesFetchRequest)	List fees associated with an account.
ListPartnerPricingRequestBuilder	listPartnerPricing()	List all partner pricing plans available for use by an account.
ListPartnerPricingResponse	listPartnerPricing(java.lang.String accountID)	List all partner pricing plans available for use by an account.
ListPartnerPricingResponse	listPartnerPricing(java.lang.String accountID, java.util.Optional<? extends java.util.List<java.lang.String>> planIDs)	List all partner pricing plans available for use by an account.
ListPartnerPricingAgreementsRequestBuilder	listPartnerPricingAgreements()	List all partner pricing agreements associated with an account.
ListPartnerPricingAgreementsResponse	listPartnerPricingAgreements(ListPartnerPricingAgreementsRequest request)	List all partner pricing agreements associated with an account.
RetrieveFeesRequestBuilder	retrieveFees()	Retrieve fees associated with an account.
RetrieveFeesResponse	retrieveFees(RetrieveFeesRequest request)	Retrieve fees associated with an account.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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.

Parameters:

request - The request object containing all 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

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.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.

Parameters:

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.

Parameters:

request - The request object containing all 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.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.

Parameters:

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.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.

Parameters:

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

listPartnerPricingAgreements

public ListPartnerPricingAgreementsResponse listPartnerPricingAgreements(ListPartnerPricingAgreementsRequest request)
                                                                  throws java.lang.Exception

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.

Parameters:

request - The request object containing all the parameters for the API call.

Returns:

The response from the API call

Throws:

java.lang.Exception - if the API call fails