Function OnboardingApiAxiosParamCreator

Returns {
    getEsignatureSigner: ((tilled_account, id, document_id, options?) => Promise<RequestArgs>);
    getMccDescriptions: ((tilled_account, options?) => Promise<RequestArgs>);
    getMerchantApplication: ((account_id, options?) => Promise<RequestArgs>);
    getOnboardingApplication: ((tilled_account, options?) => Promise<RequestArgs>);
    regenerateSigningLinks: ((tilled_account, RegenerateSigningLinksParams, options?) => Promise<RequestArgs>);
    resendEsignatureDocumentEmail: ((tilled_account, id, document_id, options?) => Promise<RequestArgs>);
    submitMerchantApplication: ((account_id, options?) => Promise<RequestArgs>);
    submitOnboardingApplication: ((tilled_account, SubmitApplicationParams, options?) => Promise<RequestArgs>);
    updateMerchantApplication: ((account_id, MerchantApplicationCreateParams, options?) => Promise<RequestArgs>);
    updateOnboardingApplication: ((tilled_account, OnboardingApplicationCreateParams, options?) => Promise<RequestArgs>);
}

• getEsignatureSigner: ((tilled_account, id, document_id, options?) => Promise<RequestArgs>)

  • • (tilled_account, id, document_id, options?): Promise<RequestArgs>

    • Retrieves an Esignature Signer.

      Summary

      Get Esignature Signer

      Throws

      Parameters

      • tilled_account: string

        The id of the Tilled Account (usually starting with the prefix `acct_`) that the request is performed on behalf of.

      • id: string

      • document_id: string

      • Optional options: RawAxiosRequestConfig<any> = {}

        Override http request option.

      Returns Promise<RequestArgs>

• getMccDescriptions: ((tilled_account, options?) => Promise<RequestArgs>)

  • • (tilled_account, options?): Promise<RequestArgs>

    • Retrieves descriptions for all valid merchant category codes (MCC).

      Summary

      Get MCC Descriptions

      Throws

      Parameters

      • tilled_account: string

        The id of the Tilled Account (usually starting with the prefix `acct_`) that the request is performed on behalf of.

      • Optional options: RawAxiosRequestConfig<any> = {}

        Override http request option.

      Returns Promise<RequestArgs>

• getMerchantApplication: ((account_id, options?) => Promise<RequestArgs>)

  • • (account_id, options?): Promise<RequestArgs>

    • Retrieves the details of an existing merchant application. The application can only be accessed if its status is created or started. Once the application is submitted or active, it is no longer accessible.

      Summary

      Get a Merchant Application

      Deprecated

      Throws

      Parameters

      • account_id: string

        The id of the associated connected (i.e. merchant) account.

      • Optional options: RawAxiosRequestConfig<any> = {}

        Override http request option.

      Returns Promise<RequestArgs>

• getOnboardingApplication: ((tilled_account, options?) => Promise<RequestArgs>)

  • • (tilled_account, options?): Promise<RequestArgs>

    • Retrieves an onboarding application.

      Summary

      Get an Onboarding Application

      Throws

      Parameters

      • tilled_account: string

        The id of the Tilled Account (usually starting with the prefix `acct_`) that the request is performed on behalf of.

      • Optional options: RawAxiosRequestConfig<any> = {}

        Override http request option.

      Returns Promise<RequestArgs>

• regenerateSigningLinks: ((tilled_account, RegenerateSigningLinksParams, options?) => Promise<RequestArgs>)

  • • (tilled_account, RegenerateSigningLinksParams, options?): Promise<RequestArgs>

    • Returns an array of Signing Links if the merchant signature has not been acquired yet.

      Summary

      Regenerate Signing Links

      Throws

      Parameters

      • tilled_account: string

        The id of the Tilled Account (usually starting with the prefix `acct_`) that the request is performed on behalf of.

      • RegenerateSigningLinksParams: RegenerateSigningLinksParams

      • Optional options: RawAxiosRequestConfig<any> = {}

        Override http request option.

      Returns Promise<RequestArgs>

• resendEsignatureDocumentEmail: ((tilled_account, id, document_id, options?) => Promise<RequestArgs>)

  • • (tilled_account, id, document_id, options?): Promise<RequestArgs>

    • Resend an Esignature Document email to a specific Esignature Signer.

      Summary

      Resend Esignature Document email

      Throws

      Parameters

      • tilled_account: string

        The id of the Tilled Account (usually starting with the prefix `acct_`) that the request is performed on behalf of.

      • id: string

      • document_id: string

      • Optional options: RawAxiosRequestConfig<any> = {}

        Override http request option.

      Returns Promise<RequestArgs>

• submitMerchantApplication: ((account_id, options?) => Promise<RequestArgs>)

  • • (account_id, options?): Promise<RequestArgs>

    • Submits a merchant application for processing. If there are any validation errors, they must be corrected before re-submitting. Once successfully submitted, the application is no longer accessible.

      Summary

      Submit a Merchant Application

      Deprecated

      Throws

      Parameters

      • account_id: string

        The id of the associated connected (i.e. merchant) account.

      • Optional options: RawAxiosRequestConfig<any> = {}

        Override http request option.

      Returns Promise<RequestArgs>

• submitOnboardingApplication: ((tilled_account, SubmitApplicationParams, options?) => Promise<RequestArgs>)

  • • (tilled_account, SubmitApplicationParams, options?): Promise<RequestArgs>

    • Submits an onboarding application to be processed. If any validation errors exist, they must be corrected before re-submitting. Returns an array of Signing Links if a merchant signature is required.

      Summary

      Submit an Onboarding Application

      Throws

      Parameters

      • tilled_account: string

        The id of the Tilled Account (usually starting with the prefix `acct_`) that the request is performed on behalf of.

      • SubmitApplicationParams: SubmitApplicationParams

      • Optional options: RawAxiosRequestConfig<any> = {}

        Override http request option.

      Returns Promise<RequestArgs>

• updateMerchantApplication: ((account_id, MerchantApplicationCreateParams, options?) => Promise<RequestArgs>)

  • • (account_id, MerchantApplicationCreateParams, options?): Promise<RequestArgs>

    • Updates a merchant application by overwriting all properties.

      Summary

      Update a Merchant Application

      Deprecated

      Throws

      Parameters

      • account_id: string

        The id of the associated connected (i.e. merchant) account.

      • MerchantApplicationCreateParams: MerchantApplicationCreateParams

      • Optional options: RawAxiosRequestConfig<any> = {}

        Override http request option.

      Returns Promise<RequestArgs>

• updateOnboardingApplication: ((tilled_account, OnboardingApplicationCreateParams, options?) => Promise<RequestArgs>)

  • • (tilled_account, OnboardingApplicationCreateParams, options?): Promise<RequestArgs>

    • Updates an onboarding application by overwriting all properties. You must pass the entire payload each time.

      Summary

      Update an Onboarding Application

      Throws

      Parameters

      • tilled_account: string

        The id of the Tilled Account (usually starting with the prefix `acct_`) that the request is performed on behalf of.

      • OnboardingApplicationCreateParams: OnboardingApplicationCreateParams

      • Optional options: RawAxiosRequestConfig<any> = {}

        Override http request option.

      Returns Promise<RequestArgs>