Class OnboardingApi

OnboardingApi - object-oriented interface

Export

Hierarchy

  • BaseAPI
    • OnboardingApi

Constructors

  • Parameters

    • Optional configuration: Configuration
    • basePath: string = BASE_PATH
    • axios: AxiosInstance = globalAxios

    Returns OnboardingApi

Properties

axios: AxiosInstance = globalAxios
basePath: string = BASE_PATH
configuration: undefined | Configuration

Methods

  • 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

    Memberof

    OnboardingApi

    Parameters

    Returns Promise<AxiosResponse<MerchantApplication, any>>

  • 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

    Memberof

    OnboardingApi

    Parameters

    Returns Promise<AxiosResponse<object, any>>

Generated using TypeDoc