Class Merchant

Hierarchy

APIResource
- Merchant

Index

Constructors

Properties

Methods

get getDoingBusinessAs getMerchantProfile getPersonalProfile getSettings listBankAccounts listBankAccountsDeprecated

Constructors

constructor

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

Properties

`Protected`_client

_client: SumUp

Methods

get

get(
query?: GetAccountQueryParams,
params?: FetchParams,
): APIPromise<MerchantAccount>
Returns user profile information.
Parameters
- Optionalquery: GetAccountQueryParams
- Optionalparams: FetchParams
Returns APIPromise<MerchantAccount>
- Defined in resources/merchant/index.ts:593

getDoingBusinessAs

getDoingBusinessAs(params?: FetchParams): APIPromise<DoingBusinessAsLegacy>
Retrieves Doing Business As profile.
Parameters
- Optionalparams: FetchParams
Returns APIPromise<DoingBusinessAsLegacy>
- Defined in resources/merchant/index.ts:631

getMerchantProfile

getMerchantProfile(params?: FetchParams): APIPromise<MerchantProfileLegacy>
Retrieves merchant profile data.
Parameters
- Optionalparams: FetchParams
Returns APIPromise<MerchantProfileLegacy>
- Defined in resources/merchant/index.ts:619

getPersonalProfile

getPersonalProfile(params?: FetchParams): APIPromise<PersonalProfileLegacy>
Retrieves personal profile data.
Parameters
- Optionalparams: FetchParams
Returns APIPromise<PersonalProfileLegacy>
- Defined in resources/merchant/index.ts:607

getSettings

getSettings(params?: FetchParams): APIPromise<MerchantSettings>
Retrieves merchant settings.
Parameters
- Optionalparams: FetchParams
Returns APIPromise<MerchantSettings>
- Defined in resources/merchant/index.ts:672

listBankAccounts

listBankAccounts(
    merchantCode: string,
    query?: ListBankAccountsV11QueryParams,
    params?: FetchParams,
): APIPromise<BankAccount[]>
Retrieves bank accounts of the merchant.
Parameters
- merchantCode: string
- Optionalquery: ListBankAccountsV11QueryParams
- Optionalparams: FetchParams
Returns APIPromise<BankAccount[]>
- Defined in resources/merchant/index.ts:643

listBankAccountsDeprecated

listBankAccountsDeprecated(
query?: ListBankAccountsQueryParams,
params?: FetchParams,
): APIPromise<BankAccount[]>
Retrieves bank accounts of the merchant.
Parameters
- Optionalquery: ListBankAccountsQueryParams
- Optionalparams: FetchParams
Returns APIPromise<BankAccount[]>
- Defined in resources/merchant/index.ts:658