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>
Retrieve a profile
Parameters
- Optionalquery: GetAccountQueryParams
- Optionalparams: FetchParams
Returns APIPromise<MerchantAccount>
- Defined in resources/merchant/index.ts:597

getDoingBusinessAs

getDoingBusinessAs(params?: FetchParams): APIPromise<DoingBusinessAs>
Retrieve DBA
Parameters
- Optionalparams: FetchParams
Returns APIPromise<DoingBusinessAs>
- Defined in resources/merchant/index.ts:635

getMerchantProfile

getMerchantProfile(params?: FetchParams): APIPromise<MerchantProfile>
Retrieve a merchant profile
Parameters
- Optionalparams: FetchParams
Returns APIPromise<MerchantProfile>
- Defined in resources/merchant/index.ts:623

getPersonalProfile

getPersonalProfile(params?: FetchParams): APIPromise<PersonalProfile>
Retrieve a personal profile
Parameters
- Optionalparams: FetchParams
Returns APIPromise<PersonalProfile>
- Defined in resources/merchant/index.ts:611

getSettings

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

listBankAccounts

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

listBankAccountsDeprecated

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