Class Subaccounts

API resource for the Subaccounts endpoints.

Endpoints for managing merchant sub-accounts (operators).

Hierarchy

APIResource
- Subaccounts

Index

Constructors

Properties

Methods

compatGetOperator createSubAccount listSubAccounts updateSubAccount

Constructors

constructor

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

Properties

`Protected`_client

_client: SumUp

Methods

compatGetOperator

compatGetOperator(
operatorId: number,
options?: RequestOptions,
): APIPromise<Operator, Problem>
Returns specific operator.
Parameters
- operatorId: number
- Optionaloptions: RequestOptions
Returns APIPromise<Operator, Problem>
- Defined in src/resources/subaccounts/index.ts:74

createSubAccount

createSubAccount(
body: CreateSubAccountParams,
options?: RequestOptions,
): APIPromise<Operator, Problem>
Creates new operator for currently authorized users' merchant.
Parameters
- body: CreateSubAccountParams
- Optionaloptions: RequestOptions
Returns APIPromise<Operator, Problem>
- Defined in src/resources/subaccounts/index.ts:60

listSubAccounts

listSubAccounts(
query?: ListSubAccountsQueryParams,
options?: RequestOptions,
): APIPromise<Operator[], Problem>
Returns list of operators for currently authorized user's merchant.
Parameters
- Optionalquery: ListSubAccountsQueryParams
- Optionaloptions: RequestOptions
Returns APIPromise<Operator[], Problem>
- Defined in src/resources/subaccounts/index.ts:46

updateSubAccount

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