Function OnboardingApiFactory

Returns {
    getEsignatureSigner(requestParameters, options?) => AxiosPromise<EsignatureSigner>;
    getMccDescriptions(requestParameters, options?) => AxiosPromise<MccDescription[]>;
    getMerchantApplication(requestParameters, options?) => AxiosPromise<MerchantApplication>;
    getOnboardingApplication(requestParameters, options?) => AxiosPromise<OnboardingApplication>;
    regenerateSigningLinks(requestParameters, options?) => AxiosPromise<SigningLink[]>;
    resendEsignatureDocumentEmail(requestParameters, options?) => AxiosPromise<void>;
    submitMerchantApplication(requestParameters, options?) => AxiosPromise<object>;
    submitOnboardingApplication(requestParameters, options?) => AxiosPromise<SubmitApplicationResponse>;
    updateMerchantApplication(requestParameters, options?) => AxiosPromise<MerchantApplication>;
    updateOnboardingApplication(requestParameters, options?) => AxiosPromise<OnboardingApplication>;
}

• getEsignatureSigner:function

  • getEsignatureSigner(requestParameters, options?): AxiosPromise<EsignatureSigner>

  • Retrieves an Esignature Signer.

    Summary

    Get Esignature Signer

    Throws

    Parameters

    • requestParameters: OnboardingApiGetEsignatureSignerRequest

      Request parameters.

    • Optional options: RawAxiosRequestConfig<any>

      Override http request option.

    Returns AxiosPromise<EsignatureSigner>

• getMccDescriptions:function

  • getMccDescriptions(requestParameters, options?): AxiosPromise<MccDescription[]>

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

    Summary

    Get MCC Descriptions

    Throws

    Parameters

    • requestParameters: OnboardingApiGetMccDescriptionsRequest

      Request parameters.

    • Optional options: RawAxiosRequestConfig<any>

      Override http request option.

    Returns AxiosPromise<MccDescription[]>

• getMerchantApplication:function

  • getMerchantApplication(requestParameters, options?): AxiosPromise<MerchantApplication>

  • 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

    • requestParameters: OnboardingApiGetMerchantApplicationRequest

      Request parameters.

    • Optional options: RawAxiosRequestConfig<any>

      Override http request option.

    Returns AxiosPromise<MerchantApplication>

• getOnboardingApplication:function

  • getOnboardingApplication(requestParameters, options?): AxiosPromise<OnboardingApplication>

  • Retrieves an onboarding application.

    Summary

    Get an Onboarding Application

    Throws

    Parameters

    • requestParameters: OnboardingApiGetOnboardingApplicationRequest

      Request parameters.

    • Optional options: RawAxiosRequestConfig<any>

      Override http request option.

    Returns AxiosPromise<OnboardingApplication>

• regenerateSigningLinks:function

  • regenerateSigningLinks(requestParameters, options?): AxiosPromise<SigningLink[]>

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

    Summary

    Regenerate Signing Links

    Throws

    Parameters

    • requestParameters: OnboardingApiRegenerateSigningLinksRequest

      Request parameters.

    • Optional options: RawAxiosRequestConfig<any>

      Override http request option.

    Returns AxiosPromise<SigningLink[]>

• resendEsignatureDocumentEmail:function

  • resendEsignatureDocumentEmail(requestParameters, options?): AxiosPromise<void>

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

    Summary

    Resend Esignature Document email

    Throws

    Parameters

    • requestParameters: OnboardingApiResendEsignatureDocumentEmailRequest

      Request parameters.

    • Optional options: RawAxiosRequestConfig<any>

      Override http request option.

    Returns AxiosPromise<void>

• submitMerchantApplication:function

  • submitMerchantApplication(requestParameters, options?): AxiosPromise<object>

  • 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

    • requestParameters: OnboardingApiSubmitMerchantApplicationRequest

      Request parameters.

    • Optional options: RawAxiosRequestConfig<any>

      Override http request option.

    Returns AxiosPromise<object>

• submitOnboardingApplication:function

  • submitOnboardingApplication(requestParameters, options?): AxiosPromise<SubmitApplicationResponse>

  • 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

    • requestParameters: OnboardingApiSubmitOnboardingApplicationRequest

      Request parameters.

    • Optional options: RawAxiosRequestConfig<any>

      Override http request option.

    Returns AxiosPromise<SubmitApplicationResponse>

• updateMerchantApplication:function

  • updateMerchantApplication(requestParameters, options?): AxiosPromise<MerchantApplication>

  • Updates a merchant application by overwriting all properties.

    Summary

    Update a Merchant Application

    Deprecated

    Throws

    Parameters

    • requestParameters: OnboardingApiUpdateMerchantApplicationRequest

      Request parameters.

    • Optional options: RawAxiosRequestConfig<any>

      Override http request option.

    Returns AxiosPromise<MerchantApplication>

• updateOnboardingApplication:function

  • updateOnboardingApplication(requestParameters, options?): AxiosPromise<OnboardingApplication>

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

    Summary

    Update an Onboarding Application

    Throws

    Parameters

    • requestParameters: OnboardingApiUpdateOnboardingApplicationRequest

      Request parameters.

    • Optional options: RawAxiosRequestConfig<any>

      Override http request option.

    Returns AxiosPromise<OnboardingApplication>