Function OnboardingApiFactory

Returns {
    getMerchantApplication(requestParameters, options?) => AxiosPromise<MerchantApplication>;
    submitMerchantApplication(requestParameters, options?) => AxiosPromise<object>;
    updateMerchantApplication(requestParameters, options?) => AxiosPromise<MerchantApplication>;
}

• 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

    Throws

    Parameters

    • requestParameters: OnboardingApiGetMerchantApplicationRequest

      Request parameters.

    • Optional options: RawAxiosRequestConfig<any>

      Override http request option.

    Returns AxiosPromise<MerchantApplication>

• 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

    Throws

    Parameters

    • requestParameters: OnboardingApiSubmitMerchantApplicationRequest

      Request parameters.

    • Optional options: RawAxiosRequestConfig<any>

      Override http request option.

    Returns AxiosPromise<object>

• updateMerchantApplication:function

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

  • Updates a merchant application by overwriting all properties.

    Summary

    Update a Merchant Application

    Throws

    Parameters

    • requestParameters: OnboardingApiUpdateMerchantApplicationRequest

      Request parameters.

    • Optional options: RawAxiosRequestConfig<any>

      Override http request option.

    Returns AxiosPromise<MerchantApplication>