Function UserStatusesApiFactory

UserStatusesApi - factory interface export

  • UserStatusesApiFactory(configuration?, basePath?, axios?): {
        apiUserStatusesGet(userId?: string, options?: RawAxiosRequestConfig): AxiosPromise<UserStatus>;
    }

  • Parameters

    • Optionalconfiguration: Configuration
    • OptionalbasePath: string
    • Optionalaxios: AxiosInstance

    Returns {
        apiUserStatusesGet(userId?: string, options?: RawAxiosRequestConfig): AxiosPromise<UserStatus>;
    }

    • apiUserStatusesGet:function
      • apiUserStatusesGet(userId?, options?): AxiosPromise<UserStatus>

      • The UserStatus object provides information on whether a user is fully on-boarded, can accept payouts and can charge payments

        summary Gets the UserStatus object

        Parameters

        • OptionaluserId: string

          UserId of the user (Tenant level access required)

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns AxiosPromise<UserStatus>

        Throws

Settings

Member Visibility