README.md

Capabilities

Overview

Available Operations

• list - Retrieve all the capabilities an account has requested.

Read our capabilities reference to learn more.

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

• request - Request capabilities for a specific account. Read our capabilities reference to learn more.

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

• get - Retrieve a specific capability that an account has requested. Read our capabilities reference to learn more.

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

• disable - Disable a specific capability that an account has requested. Read our capabilities reference to learn more.

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

list

Retrieve all the capabilities an account has requested.

Read our capabilities reference to learn more.

To access this endpoint using an access token you'll need to specify the /accounts/{accountID}/capabilities.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.capabilities.list(account_id="1a50ab1c-1714-49e7-a016-cea17b33511a")

    # Handle response
    print(res)

Parameters

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

Response

operations.ListCapabilitiesResponse

Errors

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

request

Request capabilities for a specific account. Read our capabilities reference to learn more.

To access this endpoint using an access token you'll need to specify the /accounts/{accountID}/capabilities.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.capabilities.request(account_id="0de140d5-cc78-4eeb-ab00-1f51aaf6c814", capabilities=[
        components.CapabilityID.COLLECT_FUNDS,
    ])

    # Handle response
    print(res)

Parameters

Parameter	Type	Required	Description
account_id	str	✔️	N/A
capabilities	List[components.CapabilityID]	✔️	Capabilities to request for the account. Request granular capability IDs that match your use case. Read our capabilities reference to choose the right capabilities for your integration. The send-funds, collect-funds, and wallet capability IDs are deprecated. Use granular values such as send-funds.ach, collect-funds.card-payments, or wallet.balance instead.
retries	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

operations.RequestCapabilitiesResponse

Errors

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

get

Retrieve a specific capability that an account has requested. Read our capabilities reference to learn more.

To access this endpoint using an access token you'll need to specify the /accounts/{accountID}/capabilities.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.capabilities.get(account_id="c1697ea6-c984-4ba1-9b81-93e5e18660af", capability_id=components.CapabilityID.SEND_FUNDS)

    # Handle response
    print(res)

Parameters

Parameter	Type	Required	Description
account_id	str	✔️	N/A
capability_id	components.CapabilityID	✔️	Moov account capabilities. Deprecated capabilities The send-funds, collect-funds, and wallet capability IDs are deprecated. Request granular capabilities instead (for example, send-funds.ach, collect-funds.card-payments, or wallet.balance). Deprecated values will be removed in a future API version. Read our capabilities reference to choose the right capabilities for your integration. The production-app, platform.production-app, and / or platform.wallet-transfers capabilities might appear in the list for your Partner account. These are read-only capabilities that Moov requests. These capabilities remain active with your account and require no additional action.
retries	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

operations.GetCapabilityResponse

Errors

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

disable

Disable a specific capability that an account has requested. Read our capabilities reference to learn more.

To access this endpoint using an access token you'll need to specify the /accounts/{accountID}/capabilities.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.capabilities.disable(account_id="2be80c4e-d409-49ea-8a8a-76dfa4006d69", capability_id=components.CapabilityID.TRANSFERS)

    # Handle response
    print(res)

Parameters

Parameter	Type	Required	Description
account_id	str	✔️	N/A
capability_id	components.CapabilityID	✔️	Moov account capabilities. Deprecated capabilities The send-funds, collect-funds, and wallet capability IDs are deprecated. Request granular capabilities instead (for example, send-funds.ach, collect-funds.card-payments, or wallet.balance). Deprecated values will be removed in a future API version. Read our capabilities reference to choose the right capabilities for your integration. The production-app, platform.production-app, and / or platform.wallet-transfers capabilities might appear in the list for your Partner account. These are read-only capabilities that Moov requests. These capabilities remain active with your account and require no additional action.
retries	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

operations.DisableCapabilityResponse

Errors

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