FeePlans

(feePlans())

Overview

Available Operations

listFeePlanAgreements - List all fee plan agreements associated with an account.

To access this endpoint using an access token you'll need to specify the /accounts/{accountID}/profile.read scope.

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 you'll need to specify the /accounts/{accountID}/profile.write scope.

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 you'll need to specify the /accounts/{accountID}/profile.read scope.

retrieveFees - Retrieve fees associated with an account.

To access this endpoint using an access token you'll need to specify the /accounts/{accountID}/transfers.read scope.

listFeesFetch - List fees associated with an account.

To access this endpoint using an access token you'll need to specify the /accounts/{accountID}/transfers.read scope.

listPartnerPricing - List all partner pricing plans available for use by an account.

To access this endpoint using an access token you'll need to specify the /accounts/{accountID}/profile.read scope.

listPartnerPricingAgreements - List all partner pricing agreements associated with an account.

To access this endpoint using an access token you'll need to specify the /accounts/{accountID}/profile.read scope.

listFeePlanAgreements

List all fee plan agreements associated with an account.

To access this endpoint using an access token you'll need to specify the /accounts/{accountID}/profile.read scope.

Example Usage

package hello.world;

import io.moov.sdk.Moov;
import io.moov.sdk.models.components.Security;
import io.moov.sdk.models.operations.ListFeePlanAgreementsRequest;
import io.moov.sdk.models.operations.ListFeePlanAgreementsResponse;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws Exception {

        Moov sdk = Moov.builder()
                .security(Security.builder()
                    .username("")
                    .password("")
                    .build())
            .build();

        ListFeePlanAgreementsRequest req = ListFeePlanAgreementsRequest.builder()
                .accountID("4c49ae91-2b32-4a4d-91bf-f062f3c2f38d")
                .skip(60L)
                .count(20L)
                .build();

        ListFeePlanAgreementsResponse res = sdk.feePlans().listFeePlanAgreements()
                .request(req)
                .call();

        if (res.feePlanAgreements().isPresent()) {
            // handle response
        }
    }
}

Parameters

Parameter	Type	Required	Description
`request`	ListFeePlanAgreementsRequest	✔️	The request object to use for the request.

Response

ListFeePlanAgreementsResponse

Errors

Error Type	Status Code	Content Type
models/errors/APIException	4XX, 5XX	/

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 you'll need to specify the /accounts/{accountID}/profile.write scope.

Example Usage

package hello.world;

import io.moov.sdk.Moov;
import io.moov.sdk.models.components.CreateFeePlanAgreement;
import io.moov.sdk.models.components.Security;
import io.moov.sdk.models.errors.FeePlanAgreementError;
import io.moov.sdk.models.errors.GenericError;
import io.moov.sdk.models.operations.CreateFeePlanAgreementsResponse;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws GenericError, FeePlanAgreementError, Exception {

        Moov sdk = Moov.builder()
                .security(Security.builder()
                    .username("")
                    .password("")
                    .build())
            .build();

        CreateFeePlanAgreementsResponse res = sdk.feePlans().createFeePlanAgreements()
                .accountID("19962eb8-00cd-44e5-8a66-a1ebaf88c2fe")
                .createFeePlanAgreement(CreateFeePlanAgreement.builder()
                    .planID("b97c2d59-80c5-49ac-b1fc-40e3a81d8daf")
                    .build())
                .call();

        if (res.feePlanAgreement().isPresent()) {
            // handle response
        }
    }
}

Parameters

Parameter	Type	Required	Description
`xMoovVersion`	Optional<String>	➖	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`	String	✔️	N/A
`createFeePlanAgreement`	CreateFeePlanAgreement	✔️	N/A

Response

CreateFeePlanAgreementsResponse

Errors

Error Type	Status Code	Content Type
models/errors/GenericError	400, 409	application/json
models/errors/FeePlanAgreementError	422	application/json
models/errors/APIException	4XX, 5XX	/

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 you'll need to specify the /accounts/{accountID}/profile.read scope.

Example Usage

package hello.world;

import io.moov.sdk.Moov;
import io.moov.sdk.models.components.Security;
import io.moov.sdk.models.operations.ListFeePlansResponse;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws Exception {

        Moov sdk = Moov.builder()
                .security(Security.builder()
                    .username("")
                    .password("")
                    .build())
            .build();

        ListFeePlansResponse res = sdk.feePlans().listFeePlans()
                .accountID("ac8fa716-4b75-4902-b296-d734524ca45c")
                .call();

        if (res.feePlans().isPresent()) {
            // handle response
        }
    }
}

Parameters

Parameter	Type	Required	Description
`xMoovVersion`	Optional<String>	➖	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`	String	✔️	N/A
`planIDs`	List<String>	➖	A comma-separated list of plan IDs to filter the results by.

Response

ListFeePlansResponse

Errors

Error Type	Status Code	Content Type
models/errors/APIException	4XX, 5XX	/

retrieveFees

Retrieve fees associated with an account.

To access this endpoint using an access token you'll need to specify the /accounts/{accountID}/transfers.read scope.

Example Usage

package hello.world;

import io.moov.sdk.Moov;
import io.moov.sdk.models.components.Security;
import io.moov.sdk.models.operations.RetrieveFeesRequest;
import io.moov.sdk.models.operations.RetrieveFeesResponse;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws Exception {

        Moov sdk = Moov.builder()
                .security(Security.builder()
                    .username("")
                    .password("")
                    .build())
            .build();

        RetrieveFeesRequest req = RetrieveFeesRequest.builder()
                .accountID("45954656-ded3-4bbc-9ef3-d42c2b99db12")
                .skip(60L)
                .count(20L)
                .build();

        RetrieveFeesResponse res = sdk.feePlans().retrieveFees()
                .request(req)
                .call();

        if (res.incurredFees().isPresent()) {
            // handle response
        }
    }
}

Parameters

Parameter	Type	Required	Description
`request`	RetrieveFeesRequest	✔️	The request object to use for the request.

Response

RetrieveFeesResponse

Errors

Error Type	Status Code	Content Type
models/errors/APIException	4XX, 5XX	/

listFeesFetch

List fees associated with an account.

To access this endpoint using an access token you'll need to specify the /accounts/{accountID}/transfers.read scope.

Example Usage

package hello.world;

import io.moov.sdk.Moov;
import io.moov.sdk.models.components.Security;
import io.moov.sdk.models.operations.ListFeesFetchResponse;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws Exception {

        Moov sdk = Moov.builder()
                .security(Security.builder()
                    .username("")
                    .password("")
                    .build())
            .build();

        ListFeesFetchResponse res = sdk.feePlans().listFeesFetch()
                .accountID("7b85e951-a6d9-4e67-a155-4d18e9d1ac58")
                .call();

        if (res.incurredFees().isPresent()) {
            // handle response
        }
    }
}

Parameters

Parameter	Type	Required	Description
`xMoovVersion`	Optional<String>	➖	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`	String	✔️	N/A
`listFeesFetchRequest`	Optional<ListFeesFetchRequest>	➖	N/A

Response

ListFeesFetchResponse

Errors

Error Type	Status Code	Content Type
models/errors/APIException	4XX, 5XX	/

listPartnerPricing

List all partner pricing plans available for use by an account.

To access this endpoint using an access token you'll need to specify the /accounts/{accountID}/profile.read scope.

Example Usage

package hello.world;

import io.moov.sdk.Moov;
import io.moov.sdk.models.components.Security;
import io.moov.sdk.models.operations.ListPartnerPricingResponse;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws Exception {

        Moov sdk = Moov.builder()
                .security(Security.builder()
                    .username("")
                    .password("")
                    .build())
            .build();

        ListPartnerPricingResponse res = sdk.feePlans().listPartnerPricing()
                .accountID("85f15b07-5c44-4302-ab6f-d22f8d45b7f4")
                .call();

        if (res.partnerPricings().isPresent()) {
            // handle response
        }
    }
}

Parameters

Parameter	Type	Required	Description
`xMoovVersion`	Optional<String>	➖	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`	String	✔️	N/A
`planIDs`	List<String>	➖	A comma-separated list of plan IDs to filter the results by.

Response

ListPartnerPricingResponse

Errors

Error Type	Status Code	Content Type
models/errors/APIException	4XX, 5XX	/

listPartnerPricingAgreements

List all partner pricing agreements associated with an account.

To access this endpoint using an access token you'll need to specify the /accounts/{accountID}/profile.read scope.

Example Usage

package hello.world;

import io.moov.sdk.Moov;
import io.moov.sdk.models.components.Security;
import io.moov.sdk.models.operations.ListPartnerPricingAgreementsRequest;
import io.moov.sdk.models.operations.ListPartnerPricingAgreementsResponse;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws Exception {

        Moov sdk = Moov.builder()
                .security(Security.builder()
                    .username("")
                    .password("")
                    .build())
            .build();

        ListPartnerPricingAgreementsRequest req = ListPartnerPricingAgreementsRequest.builder()
                .accountID("9366921a-25de-4c52-8ec6-4cd4ef557223")
                .skip(60L)
                .count(20L)
                .build();

        ListPartnerPricingAgreementsResponse res = sdk.feePlans().listPartnerPricingAgreements()
                .request(req)
                .call();

        if (res.partnerPricingAgreements().isPresent()) {
            // handle response
        }
    }
}

Parameters

Parameter	Type	Required	Description
`request`	ListPartnerPricingAgreementsRequest	✔️	The request object to use for the request.

Response

ListPartnerPricingAgreementsResponse

Errors

Error Type	Status Code	Content Type
models/errors/APIException	4XX, 5XX	/

Files

README.md

Latest commit

History

README.md

File metadata and controls

FeePlans

Overview

Available Operations

listFeePlanAgreements

Example Usage

Parameters

Response

Errors

createFeePlanAgreements

Example Usage

Parameters

Response

Errors

listFeePlans

Example Usage

Parameters

Response

Errors

retrieveFees

Example Usage

Parameters

Response

Errors

listFeesFetch

Example Usage

Parameters

Response

Errors

listPartnerPricing

Example Usage

Parameters

Response

Errors

listPartnerPricingAgreements

Example Usage

Parameters

Response

Errors