Class UserStatusesApi

UserStatusesApi - object-oriented interface export UserStatusesApi

Hierarchy (view full)

BaseAPI
- UserStatusesApi

Index

Constructors

Properties

axios basePath configuration

Methods

apiUserStatusesGet

Constructors

constructor

new UserStatusesApi(configuration?, basePath?, axios?): UserStatusesApi
Parameters
- Optionalconfiguration: Configuration
- basePath: string = BASE_PATH
- axios: AxiosInstance = globalAxios
Returns UserStatusesApi
Inherited from BaseAPI.constructor
- Defined in src/api/base.ts:53

Properties

`Protected`axios

axios: AxiosInstance = globalAxios

`Protected`basePath

basePath: string = BASE_PATH

`Protected`configuration

configuration: undefined | Configuration

Methods

apiUserStatusesGet

apiUserStatusesGet(userId?, options?): Promise<AxiosResponse<UserStatus, any>>
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 Promise<AxiosResponse<UserStatus, any>>
Throws
memberof UserStatusesApi
- Defined in src/api/api.ts:28374