Function OnboardingApiAxiosParamCreator

  • OnboardingApi - axios parameter creator

    Export

    Parameters

    Returns {
        getMerchantApplication: ((account_id, options?) => Promise<RequestArgs>);
        submitMerchantApplication: ((account_id, options?) => Promise<RequestArgs>);
        updateMerchantApplication: ((account_id, MerchantApplicationCreateParams, options?) => 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

          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>

    • 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

          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>

    • 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

          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>

Generated using TypeDoc