README.md

FeePlans

(feePlans)

Overview

Available Operations

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

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

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

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

list

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

declare(strict_types=1);

require 'vendor/autoload.php';

use Moov\MoovPhp;
use Moov\MoovPhp\Models\Components;
use Moov\MoovPhp\Models\Operations;

$sdk = MoovPhp\Moov::builder()
    ->setSecurity(
        new Components\Security(
            username: '',
            password: '',
        )
    )
    ->build();

$request = new Operations\ListFeePlanAgreementsRequest(
    skip: 60,
    count: 20,
    accountID: 'c8a232aa-0b11-4b8a-b005-71e9e705d0e6',
);

$response = $sdk->feePlans->list(
    request: $request
);

if ($response->feePlanAgreements !== null) {
    // handle response
}

Parameters

Parameter	Type	Required	Description
$request	Operations\ListFeePlanAgreementsRequest	✔️	The request object to use for the request.

Response

?Operations\ListFeePlanAgreementsResponse

Errors

Error Type	Status Code	Content Type
Errors\APIException	4XX, 5XX	*/*

createAgreements

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

declare(strict_types=1);

require 'vendor/autoload.php';

use Moov\MoovPhp;
use Moov\MoovPhp\Models\Components;

$sdk = MoovPhp\Moov::builder()
    ->setSecurity(
        new Components\Security(
            username: '',
            password: '',
        )
    )
    ->build();

$createFeePlanAgreement = new Components\CreateFeePlanAgreement(
    planID: 'b700714f-83b3-45f6-91b3-1f9081d9e23c',
);

$response = $sdk->feePlans->createAgreements(
    accountID: 'a39319c8-13f2-4af4-9f8c-e0ce6779fd54',
    createFeePlanAgreement: $createFeePlanAgreement,
    xMoovVersion: 'v2024.01.00'

);

if ($response->feePlanAgreement !== null) {
    // handle response
}

Parameters

Parameter	Type	Required	Description
accountID	string	✔️	N/A
createFeePlanAgreement	Components\CreateFeePlanAgreement	✔️	N/A
xMoovVersion	?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.

Response

?Operations\CreateFeePlanAgreementsResponse

Errors

Error Type	Status Code	Content Type
Errors\GenericError	400, 409	application/json
Errors\FeePlanAgreementError	422	application/json
Errors\APIException	4XX, 5XX	*/*

listByAccount

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

declare(strict_types=1);

require 'vendor/autoload.php';

use Moov\MoovPhp;
use Moov\MoovPhp\Models\Components;

$sdk = MoovPhp\Moov::builder()
    ->setSecurity(
        new Components\Security(
            username: '',
            password: '',
        )
    )
    ->build();



$response = $sdk->feePlans->listByAccount(
    accountID: 'cf8ce25e-dc08-408d-aec3-84d726ece8b0',
    xMoovVersion: 'v2024.01.00',
    planIDs: [
        'b8982d80-a6fc-45af-b31d-a145a6d82699',
    ]

);

if ($response->feePlans !== null) {
    // handle response
}

Parameters

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

Response

?Operations\ListFeePlansResponse

Errors

Error Type	Status Code	Content Type
Errors\APIException	4XX, 5XX	*/*

fetchFees

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

declare(strict_types=1);

require 'vendor/autoload.php';

use Moov\MoovPhp;
use Moov\MoovPhp\Models\Components;

$sdk = MoovPhp\Moov::builder()
    ->setSecurity(
        new Components\Security(
            username: '',
            password: '',
        )
    )
    ->build();

$listFeesFetchRequest = new Components\ListFeesFetchRequest();

$response = $sdk->feePlans->fetchFees(
    accountID: 'abb6dc0f-1b14-4754-8489-20b0216c093f',
    xMoovVersion: 'v2024.01.00',
    listFeesFetchRequest: $listFeesFetchRequest

);

if ($response->incurredFees !== null) {
    // handle response
}

Parameters

Parameter	Type	Required	Description
accountID	string	✔️	N/A
xMoovVersion	?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.
listFeesFetchRequest	?Components\ListFeesFetchRequest	➖	N/A

Response

?Operations\ListFeesFetchResponse

Errors

Error Type	Status Code	Content Type
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

declare(strict_types=1);

require 'vendor/autoload.php';

use Moov\MoovPhp;
use Moov\MoovPhp\Models\Components;

$sdk = MoovPhp\Moov::builder()
    ->setSecurity(
        new Components\Security(
            username: '',
            password: '',
        )
    )
    ->build();



$response = $sdk->feePlans->listPartnerPricing(
    accountID: '85f15b07-5c44-4302-ab6f-d22f8d45b7f4',
    xMoovVersion: 'v2024.01.00',
    planIDs: [
        '<value>',
    ]

);

if ($response->partnerPricings !== null) {
    // handle response
}

Parameters

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

Response

?Operations\ListPartnerPricingResponse

Errors

Error Type	Status Code	Content Type
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

declare(strict_types=1);

require 'vendor/autoload.php';

use Moov\MoovPhp;
use Moov\MoovPhp\Models\Components;
use Moov\MoovPhp\Models\Operations;

$sdk = MoovPhp\Moov::builder()
    ->setSecurity(
        new Components\Security(
            username: '',
            password: '',
        )
    )
    ->build();

$request = new Operations\ListPartnerPricingAgreementsRequest(
    skip: 60,
    count: 20,
    accountID: '9366921a-25de-4c52-8ec6-4cd4ef557223',
);

$response = $sdk->feePlans->listPartnerPricingAgreements(
    request: $request
);

if ($response->partnerPricingAgreements !== null) {
    // handle response
}

Parameters

Parameter	Type	Required	Description
$request	Operations\ListPartnerPricingAgreementsRequest	✔️	The request object to use for the request.

Response

?Operations\ListPartnerPricingAgreementsResponse

Errors

Error Type	Status Code	Content Type
Errors\APIException	4XX, 5XX	*/*