Class SumUp

Hierarchy

HTTPClient
- SumUp

Index

Constructors

Properties

apiKey? baseParams checkouts customers host members memberships merchants payouts readers receipts roles subaccounts transactions

Methods

delete do get patch post put request stringifyQuery

Constructors

constructor

new SumUp(__namedParameters?: APIConfig): SumUp
Parameters
- __namedParameters: APIConfig = {}
Returns SumUp
Inherited from HTTPClient.constructor
- Defined in src/client.ts:20

Properties

`Optional`apiKey

apiKey?: string

baseParams

baseParams: RequestOptions

checkouts

checkouts: Checkouts = ...

Access the Checkouts API endpoints.

customers

customers: Customers = ...

Access the Customers API endpoints.

host

host: string

members

members: Members = ...

Access the Members API endpoints.

memberships

memberships: Memberships = ...

Access the Memberships API endpoints.

merchants

merchants: Merchants = ...

Access the Merchants API endpoints.

payouts

payouts: Payouts = ...

Access the Payouts API endpoints.

readers

readers: Readers = ...

Access the Readers API endpoints.

receipts

receipts: Receipts = ...

Access the Receipts API endpoints.

roles

roles: Roles = ...

Access the Roles API endpoints.

subaccounts

subaccounts: Subaccounts = ...

Access the Subaccounts API endpoints.

transactions

transactions: Transactions = ...

Access the Transactions API endpoints.

Methods

delete

delete<R, E = APIError<unknown>>(
__namedParameters: Omit<Core.FullRequestOptions, "method">,
): APIPromise<R, E>
Type Parameters
- R
- E = APIError<unknown>
Parameters
- __namedParameters: Omit<Core.FullRequestOptions, "method">
Returns APIPromise<R, E>
Inherited from HTTPClient.delete
- Defined in src/client.ts:78

`Protected`do

do<E>(
    input: URL,
    init: RequestInit,
    options: {
        maxRetries?: number;
        signal?: AbortSignal | null;
        timeout?: number;
    },
): Promise<Response>
Type Parameters
- E
Parameters
- input: URL
- init: RequestInit
- options: { maxRetries?: number; signal?: AbortSignal | null; timeout?: number }
Returns Promise<Response>
Inherited from HTTPClient.do
- Defined in src/client.ts:117

get

get<R, E = APIError<unknown>>(
__namedParameters: Omit<Core.FullRequestOptions, "method">,
): APIPromise<R, E>
Type Parameters
- R
- E = APIError<unknown>
Parameters
- __namedParameters: Omit<Core.FullRequestOptions, "method">
Returns APIPromise<R, E>
Inherited from HTTPClient.get
- Defined in src/client.ts:42

patch

patch<R, E = APIError<unknown>>(
__namedParameters: Omit<Core.FullRequestOptions, "method">,
): APIPromise<R, E>
Type Parameters
- R
- E = APIError<unknown>
Parameters
- __namedParameters: Omit<Core.FullRequestOptions, "method">
Returns APIPromise<R, E>
Inherited from HTTPClient.patch
- Defined in src/client.ts:69

post

post<R, E = APIError<unknown>>(
__namedParameters: Omit<Core.FullRequestOptions, "method">,
): APIPromise<R, E>
Type Parameters
- R
- E = APIError<unknown>
Parameters
- __namedParameters: Omit<Core.FullRequestOptions, "method">
Returns APIPromise<R, E>
Inherited from HTTPClient.post
- Defined in src/client.ts:51

put

put<R, E = APIError<unknown>>(
__namedParameters: Omit<Core.FullRequestOptions, "method">,
): APIPromise<R, E>
Type Parameters
- R
- E = APIError<unknown>
Parameters
- __namedParameters: Omit<Core.FullRequestOptions, "method">
Returns APIPromise<R, E>
Inherited from HTTPClient.put
- Defined in src/client.ts:60

request

request<T, E = APIError<unknown>>(
__namedParameters: FullRequestOptions,
): APIPromise<T, E>
Type Parameters
- T
- E = APIError<unknown>
Parameters
- __namedParameters: FullRequestOptions
Returns APIPromise<T, E>
Inherited from HTTPClient.request
- Defined in src/client.ts:87

`Protected`stringifyQuery

stringifyQuery(query: Record<string, unknown>): string
Parameters
- query: Record<string, unknown>
Returns string
Inherited from HTTPClient.stringifyQuery
- Defined in src/client.ts:168

Class SumUp

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns SumUp

Properties

OptionalapiKey

baseParams

checkouts

customers

host

members

memberships

merchants

payouts

readers

receipts

roles

subaccounts

transactions

Methods

delete

Type Parameters

Parameters

Returns APIPromise<R, E>

Protecteddo

Type Parameters

Parameters

Returns Promise<Response>

get

Type Parameters

Parameters

Returns APIPromise<R, E>

patch

Type Parameters

Parameters

Returns APIPromise<R, E>

post

Type Parameters

Parameters

Returns APIPromise<R, E>

put

Type Parameters

Parameters

Returns APIPromise<R, E>

request

Type Parameters

Parameters

Returns APIPromise<T, E>

ProtectedstringifyQuery

Parameters

Returns string

Settings

On This Page

`Optional`apiKey

`Protected`do

`Protected`stringifyQuery