Class Merchants

API resource for the Merchants endpoints.

A Merchant represents a single business which can use SumUp products like payment processing.

Hierarchy

APIResource
- Merchants

Index

Constructors

Properties

Methods

_transformQueryParams 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

`Protected`_transformQueryParams

_transformQueryParams(
query: QueryParams | undefined,
names: Record<string, string>,
): QueryParams | undefined
Parameters
- query: QueryParams | undefined
- names: Record<string, string>
Returns QueryParams | undefined
Inherited from APIResource._transformQueryParams
- Defined in src/core.ts:12

get

get(merchantCode: string, options?: RequestOptions): Promise<Merchant>
Returns a Merchant for a valid Merchant code.
Parameters
- merchantCode: string
- Optionaloptions: RequestOptions
Returns Promise<Merchant>
- Defined in src/resources/merchants/index.ts:18

getPerson

getPerson(
    merchantCode: string,
    personId: string,
    options?: RequestOptions,
): Promise<BasePerson>
Returns a single Person related to a Merchant.
Parameters
- merchantCode: string
- personId: string
- Optionaloptions: RequestOptions
Returns Promise<BasePerson>
- Defined in src/resources/merchants/index.ts:61

getPersonWithResponse

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

getWithResponse

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

listPersons

listPersons(
merchantCode: string,
options?: RequestOptions,
): Promise<ListPersonsResponseBody>
Returns the Persons related to a Merchant.
Parameters
- merchantCode: string
- Optionaloptions: RequestOptions
Returns Promise<ListPersonsResponseBody>
- Defined in src/resources/merchants/index.ts:38

listPersonsWithResponse

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