FeePlans

(fee_plans)

Overview

Available Operations

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

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

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

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

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

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

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

list_fee_plan_agreements

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

from moovio_sdk import Moov
from moovio_sdk.models import components


with Moov(
    security=components.Security(
        username="",
        password="",
    ),
) as moov:

    res = moov.fee_plans.list_fee_plan_agreements(account_id="4c49ae91-2b32-4a4d-91bf-f062f3c2f38d", skip=60, count=20)

    # Handle response
    print(res)

Parameters

Parameter	Type	Required	Description	Example
`account_id`	str	✔️	N/A
`skip`	Optional[int]	➖	N/A	60
`count`	Optional[int]	➖	N/A	20
`agreement_id`	List[str]	➖	A comma-separated list of agreement IDs to filter the results by.
`status`	List[components.FeePlanAgreementStatus]	➖	A comma-separated list of statuses to filter the results by.
`retries`	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

operations.ListFeePlanAgreementsResponse

Errors

Error Type	Status Code	Content Type
errors.APIError	4XX, 5XX	/

create_fee_plan_agreements

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

from moovio_sdk import Moov
from moovio_sdk.models import components


with Moov(
    security=components.Security(
        username="",
        password="",
    ),
) as moov:

    res = moov.fee_plans.create_fee_plan_agreements(account_id="19962eb8-00cd-44e5-8a66-a1ebaf88c2fe", plan_id="b97c2d59-80c5-49ac-b1fc-40e3a81d8daf")

    # Handle response
    print(res)

Parameters

Parameter	Type	Required	Description
`account_id`	str	✔️	N/A
`plan_id`	str	✔️	N/A
`retries`	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

operations.CreateFeePlanAgreementsResponse

Errors

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

list_fee_plans

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

from moovio_sdk import Moov
from moovio_sdk.models import components


with Moov(
    security=components.Security(
        username="",
        password="",
    ),
) as moov:

    res = moov.fee_plans.list_fee_plans(account_id="ac8fa716-4b75-4902-b296-d734524ca45c")

    # Handle response
    print(res)

Parameters

Parameter	Type	Required	Description
`account_id`	str	✔️	N/A
`plan_i_ds`	List[str]	➖	A comma-separated list of plan IDs to filter the results by.
`retries`	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

operations.ListFeePlansResponse

Errors

Error Type	Status Code	Content Type
errors.APIError	4XX, 5XX	/

retrieve_fees

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

from moovio_sdk import Moov
from moovio_sdk.models import components


with Moov(
    security=components.Security(
        username="",
        password="",
    ),
) as moov:

    res = moov.fee_plans.retrieve_fees(account_id="45954656-ded3-4bbc-9ef3-d42c2b99db12", skip=60, count=20)

    # Handle response
    print(res)

Parameters

Parameter	Type	Required	Description	Example
`account_id`	str	✔️	N/A
`transfer_id`	Optional[str]	➖	Optional transfer ID to filter the results by.
`dispute_id`	Optional[str]	➖	Optional dispute ID to filter the results by.
`start_date_time`	Optional[str]	➖	Optional date-time to inclusively filter all fees created after this date-time.
`end_date_time`	Optional[str]	➖	Optional date-time to exclusively filter all fees created before this date-time.
`skip`	Optional[int]	➖	N/A	60
`count`	Optional[int]	➖	N/A	20
`retries`	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

operations.RetrieveFeesResponse

Errors

Error Type	Status Code	Content Type
errors.APIError	4XX, 5XX	/

list_fees_fetch

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

from moovio_sdk import Moov
from moovio_sdk.models import components


with Moov(
    security=components.Security(
        username="",
        password="",
    ),
) as moov:

    res = moov.fee_plans.list_fees_fetch(account_id="7b85e951-a6d9-4e67-a155-4d18e9d1ac58")

    # Handle response
    print(res)

Parameters

Parameter	Type	Required	Description
`account_id`	str	✔️	N/A
`fee_i_ds`	List[str]	➖	N/A
`retries`	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

operations.ListFeesFetchResponse

Errors

Error Type	Status Code	Content Type
errors.APIError	4XX, 5XX	/

list_partner_pricing

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

from moovio_sdk import Moov
from moovio_sdk.models import components


with Moov(
    security=components.Security(
        username="",
        password="",
    ),
) as moov:

    res = moov.fee_plans.list_partner_pricing(account_id="85f15b07-5c44-4302-ab6f-d22f8d45b7f4")

    # Handle response
    print(res)

Parameters

Parameter	Type	Required	Description
`account_id`	str	✔️	N/A
`plan_i_ds`	List[str]	➖	A comma-separated list of plan IDs to filter the results by.
`retries`	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

operations.ListPartnerPricingResponse

Errors

Error Type	Status Code	Content Type
errors.APIError	4XX, 5XX	/

list_partner_pricing_agreements

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

from moovio_sdk import Moov
from moovio_sdk.models import components


with Moov(
    security=components.Security(
        username="",
        password="",
    ),
) as moov:

    res = moov.fee_plans.list_partner_pricing_agreements(account_id="9366921a-25de-4c52-8ec6-4cd4ef557223", skip=60, count=20)

    # Handle response
    print(res)

Parameters

Parameter	Type	Required	Description	Example
`account_id`	str	✔️	N/A
`skip`	Optional[int]	➖	N/A	60
`count`	Optional[int]	➖	N/A	20
`agreement_id`	List[str]	➖	A comma-separated list of agreement IDs to filter the results by.
`status`	List[components.FeePlanAgreementStatus]	➖	A comma-separated list of statuses to filter the results by.
`retries`	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

operations.ListPartnerPricingAgreementsResponse

Errors

Error Type	Status Code	Content Type
errors.APIError	4XX, 5XX	/

Files

README.md

Latest commit

History

README.md

File metadata and controls

FeePlans

Overview

Available Operations

list_fee_plan_agreements

Example Usage

Parameters

Response

Errors

create_fee_plan_agreements

Example Usage

Parameters

Response

Errors

list_fee_plans

Example Usage

Parameters

Response

Errors

retrieve_fees

Example Usage

Parameters

Response

Errors

list_fees_fetch

Example Usage

Parameters

Response

Errors

list_partner_pricing

Example Usage

Parameters

Response

Errors

list_partner_pricing_agreements

Example Usage

Parameters

Response

Errors