README.md

OnboardingInvites

(onboardingInvites)

Overview

Available Operations

• create - Create an invitation containing a unique link that allows the recipient to onboard their organization with Moov.

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

create

Create an invitation containing a unique link that allows the recipient to onboard their organization with Moov.

To access this endpoint using an access token you'll need to specify the /accounts.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();

$onboardingInviteRequest = new Components\OnboardingInviteRequest(
    scopes: [
        Components\ApplicationScope::AccountsRead,
    ],
    capabilities: [
        Components\CapabilityID::Transfers,
    ],
    feePlanCodes: [
        'merchant-direct',
    ],
    prefill: new Components\CreateAccount(
        accountType: Components\AccountType::Business,
        profile: new Components\CreateProfile(
            business: new Components\CreateBusinessProfile(
                legalBusinessName: 'Whole Body Fitness LLC',
            ),
        ),
    ),
);

$response = $sdk->onboardingInvites->create(
    onboardingInviteRequest: $onboardingInviteRequest,
    xMoovVersion: 'v2024.01.00'

);

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

Parameters

Parameter	Type	Required	Description
onboardingInviteRequest	Components\OnboardingInviteRequest	✔️	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\CreateOnboardingInviteResponse

Errors

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