Class Merchants

Hierarchy

APIResource
- Merchants

Index

Constructors

Properties

Methods

get getPerson listPersons

Constructors

constructor

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

Properties

`Protected`_client

_client: SumUp

Methods

get

get(
    merchantCode: string,
    query?: GetMerchantQueryParams,
    params?: FetchParams,
): APIPromise<SumUp.Merchants.Merchant>
Retrieve a merchant.
Parameters
- merchantCode: string
- Optionalquery: GetMerchantQueryParams
- Optionalparams: FetchParams
Returns APIPromise<SumUp.Merchants.Merchant>
- Defined in resources/merchants/index.ts:467

getPerson

getPerson(
    merchantCode: string,
    personId: string,
    query?: GetPersonQueryParams,
    params?: FetchParams,
): APIPromise<BasePerson>
Returns a single person related to the merchant.
Parameters
- merchantCode: string
- personId: string
- Optionalquery: GetPersonQueryParams
- Optionalparams: FetchParams
Returns APIPromise<BasePerson>
- Defined in resources/merchants/index.ts:497

listPersons

listPersons(
    merchantCode: string,
    query?: ListPersonsQueryParams,
    params?: FetchParams,
): APIPromise<ListPersonsResponseBody>
Returns a list of persons related to the merchant.
Parameters
- merchantCode: string
- Optionalquery: ListPersonsQueryParams
- Optionalparams: FetchParams
Returns APIPromise<ListPersonsResponseBody>
- Defined in resources/merchants/index.ts:482