Skip to content

Latest commit

 

History

History
274 lines (199 loc) · 44 KB

README.md

File metadata and controls

274 lines (199 loc) · 44 KB

Onboarding

(onboarding())

Overview

Available Operations

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

  • listInvites - List all the onboarding invites created by the caller's account.

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

  • getInvite - Retrieve details about an onboarding invite.

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

  • revokeInvite - Revoke an onboarding invite, rendering the invitation link unusable.

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

createInvite

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

package hello.world;

import io.moov.sdk.Moov;
import io.moov.sdk.models.components.AccountType;
import io.moov.sdk.models.components.ApplicationScope;
import io.moov.sdk.models.components.CapabilityID;
import io.moov.sdk.models.components.CreateAccount;
import io.moov.sdk.models.components.CreateBusinessProfile;
import io.moov.sdk.models.components.CreateProfile;
import io.moov.sdk.models.components.OnboardingInviteRequest;
import io.moov.sdk.models.components.Security;
import io.moov.sdk.models.errors.GenericError;
import io.moov.sdk.models.errors.OnboardingInviteError;
import io.moov.sdk.models.operations.CreateOnboardingInviteResponse;
import java.lang.Exception;
import java.util.List;

public class Application {

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

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

        CreateOnboardingInviteResponse res = sdk.onboarding().createInvite()
                .xMoovVersion("v2024.01")
                .onboardingInviteRequest(OnboardingInviteRequest.builder()
                    .scopes(List.of(
                        ApplicationScope.ACCOUNTS_READ))
                    .capabilities(List.of(
                        CapabilityID.TRANSFERS))
                    .feePlanCodes(List.of(
                        "merchant-direct"))
                    .prefill(CreateAccount.builder()
                        .accountType(AccountType.BUSINESS)
                        .profile(CreateProfile.builder()
                            .business(CreateBusinessProfile.builder()
                                .legalBusinessName("Classbooker, LLC")
                                .build())
                            .build())
                        .build())
                    .build())
                .call();

        if (res.onboardingInvite().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 an optional build number starting at .01 for subsequent builds in the same quarter.
- If no build number is specified, the version refers to the initial release of the quarter.

The latest version represents the most recent development state. It may include breaking changes and should be treated as a beta release.
onboardingInviteRequest OnboardingInviteRequest ✔️ N/A

Response

CreateOnboardingInviteResponse

Errors

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

listInvites

List all the onboarding invites created by the caller's account.

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

        ListOnboardingInvitesResponse res = sdk.onboarding().listInvites()
                .xMoovVersion("v2024.01")
                .call();

        if (res.onboardingInvites().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 an optional build number starting at .01 for subsequent builds in the same quarter.
- If no build number is specified, the version refers to the initial release of the quarter.

The latest version represents the most recent development state. It may include breaking changes and should be treated as a beta release.

Response

ListOnboardingInvitesResponse

Errors

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

getInvite

Retrieve details about an onboarding invite.

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

        GetOnboardingInviteResponse res = sdk.onboarding().getInvite()
                .xMoovVersion("v2024.01")
                .code("N1IA5eWYNh")
                .call();

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

Parameters

Parameter Type Required Description Example
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 an optional build number starting at .01 for subsequent builds in the same quarter.
- If no build number is specified, the version refers to the initial release of the quarter.

The latest version represents the most recent development state. It may include breaking changes and should be treated as a beta release.
code String ✔️ N/A N1IA5eWYNh

Response

GetOnboardingInviteResponse

Errors

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

revokeInvite

Revoke an onboarding invite, rendering the invitation link unusable.

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

Example Usage

package hello.world;

import io.moov.sdk.Moov;
import io.moov.sdk.models.components.Security;
import io.moov.sdk.models.operations.RevokeOnboardingInviteResponse;
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();

        RevokeOnboardingInviteResponse res = sdk.onboarding().revokeInvite()
                .xMoovVersion("v2024.01")
                .code("N1IA5eWYNh")
                .call();

        // handle response
    }
}

Parameters

Parameter Type Required Description Example
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 an optional build number starting at .01 for subsequent builds in the same quarter.
- If no build number is specified, the version refers to the initial release of the quarter.

The latest version represents the most recent development state. It may include breaking changes and should be treated as a beta release.
code String ✔️ N/A N1IA5eWYNh

Response

RevokeOnboardingInviteResponse

Errors

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