Class Subaccounts

Hierarchy

APIResource
- Subaccounts

Index

Constructors

Properties

Methods

compatGetOperator createSubAccount deactivateSubAccount listSubAccounts updateSubAccount

Constructors

constructor

new Subaccounts(client: SumUp): SumUp.Subaccounts
Parameters
- client: SumUp
Returns SumUp.Subaccounts
Inherited from Core.APIResource.constructor
- Defined in core.ts:8

Properties

`Protected`_client

_client: SumUp

Methods

compatGetOperator

compatGetOperator(
operatorId: number,
params?: FetchParams,
): APIPromise<Operator>
Returns specific operator.
Parameters
- operatorId: number
- Optionalparams: FetchParams
Returns APIPromise<Operator>
- Defined in resources/subaccounts/index.ts:105

createSubAccount

createSubAccount(
body: CreateSubAccountParams,
params?: FetchParams,
): APIPromise<Operator>
Creates new operator for currently authorized users' merchant.
Parameters
- body: CreateSubAccountParams
- Optionalparams: FetchParams
Returns APIPromise<Operator>
- Defined in resources/subaccounts/index.ts:91

deactivateSubAccount

deactivateSubAccount(
operatorId: number,
params?: FetchParams,
): APIPromise<Operator>
Disable the specified operator for the merchant account.
Parameters
- operatorId: number
- Optionalparams: FetchParams
Returns APIPromise<Operator>
- Defined in resources/subaccounts/index.ts:133

listSubAccounts

listSubAccounts(
query?: ListSubAccountsQueryParams,
params?: FetchParams,
): APIPromise<Operator[]>
Returns list of operators for currently authorized user's merchant.
Parameters
- Optionalquery: ListSubAccountsQueryParams
- Optionalparams: FetchParams
Returns APIPromise<Operator[]>
- Defined in resources/subaccounts/index.ts:77

updateSubAccount

updateSubAccount(
    operatorId: number,
    body: UpdateSubAccountParams,
    params?: FetchParams,
): APIPromise<Operator>
Updates operator. If the operator was disabled and their password is updated they will be unblocked.
Parameters
- operatorId: number
- body: UpdateSubAccountParams
- Optionalparams: FetchParams
Returns APIPromise<Operator>
- Defined in resources/subaccounts/index.ts:118