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 getPersonWithResponse getWithResponse listPersons listPersonsWithResponse

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,
): Promise<Merchant>
Retrieve a merchant.
Parameters
- merchantCode: string
- Optionalquery: GetMerchantQueryParams
- Optionaloptions: RequestOptions
Returns Promise<Merchant>
- Defined in src/resources/merchants/index.ts:30

getPerson

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

getPersonWithResponse

getPersonWithResponse(
    merchantCode: string,
    personId: string,
    query?: GetPersonQueryParams,
    options?: RequestOptions,
): Promise<WithResponse<BasePerson>>
Parameters
- merchantCode: string
- personId: string
- Optionalquery: GetPersonQueryParams
- Optionaloptions: RequestOptions
Returns Promise<WithResponse<BasePerson>>
- Defined in src/resources/merchants/index.ts:97

getWithResponse

getWithResponse(
    merchantCode: string,
    query?: GetMerchantQueryParams,
    options?: RequestOptions,
): Promise<WithResponse<Merchant>>
Parameters
- merchantCode: string
- Optionalquery: GetMerchantQueryParams
- Optionaloptions: RequestOptions
Returns Promise<WithResponse<Merchant>>
- Defined in src/resources/merchants/index.ts:42

listPersons

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

listPersonsWithResponse

listPersonsWithResponse(
    merchantCode: string,
    query?: ListPersonsQueryParams,
    options?: RequestOptions,
): Promise<WithResponse<ListPersonsResponseBody>>
Parameters
- merchantCode: string
- Optionalquery: ListPersonsQueryParams
- Optionaloptions: RequestOptions
Returns Promise<WithResponse<ListPersonsResponseBody>>
- Defined in src/resources/merchants/index.ts:69