Class Merchants

API resource for the Merchants endpoints.

Merchant account represents a single business entity at SumUp.

Hierarchy

APIResource
- Merchants

Index

Constructors

Properties

Methods

get getPerson listPersons

Constructors

constructor

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

Properties

`Protected`_client

_client: SumUp

Methods

get

get(
    merchantCode: string,
    query?: GetMerchantQueryParams,
    options?: RequestOptions,
): APIPromise<Merchant, Problem>
Retrieve a merchant.
Parameters
- merchantCode: string
- Optionalquery: GetMerchantQueryParams
- Optionaloptions: RequestOptions
Returns APIPromise<Merchant, Problem>
- Defined in src/resources/merchants/index.ts:31

getPerson

getPerson(
    merchantCode: string,
    personId: string,
    query?: GetPersonQueryParams,
    options?: RequestOptions,
): APIPromise<BasePerson, Problem>
Returns a single person related to the merchant.
Parameters
- merchantCode: string
- personId: string
- Optionalquery: GetPersonQueryParams
- Optionaloptions: RequestOptions
Returns APIPromise<BasePerson, Problem>
- Defined in src/resources/merchants/index.ts:61

listPersons

listPersons(
    merchantCode: string,
    query?: ListPersonsQueryParams,
    options?: RequestOptions,
): APIPromise<ListPersonsResponseBody, Problem>
Returns a list of persons related to the merchant.
Parameters
- merchantCode: string
- Optionalquery: ListPersonsQueryParams
- Optionaloptions: RequestOptions
Returns APIPromise<ListPersonsResponseBody, Problem>
- Defined in src/resources/merchants/index.ts:46