Class SumUp

Hierarchy

HTTPClient
- SumUp

Constructors

constructor

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

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.

transactions

transactions: Transactions = ...

Access the Transactions API endpoints.

Methods

delete

delete<R>(
__namedParameters: Omit<Core.FullRequestOptions, "method">,
): Promise<R>
Type Parameters
- R
Parameters
- __namedParameters: Omit<Core.FullRequestOptions, "method">
Returns Promise<R>
Inherited from HTTPClient.delete
- Defined in src/client.ts:116

deleteWithResponse

deleteWithResponse<R>(
__namedParameters: Omit<Core.FullRequestOptions, "method">,
): Promise<WithResponse<R>>
Type Parameters
- R
Parameters
- __namedParameters: Omit<Core.FullRequestOptions, "method">
Returns Promise<WithResponse<R>>
Inherited from HTTPClient.deleteWithResponse
- Defined in src/client.ts:125

`Protected`do

do(
    input: URL,
    init: RequestInit,
    options: {
        maxRetries?: number;
        signal?: AbortSignal | null;
        timeout?: number;
    },
): Promise<Response>
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:169

eventsHandler

eventsHandler(secret: string, fallback: EventCallback): EventsHandler
Create an event handler bound to this API client. Register typed callbacks with on(); events without a callback reach fallback.
Parameters
- secret: string
  Your event signing secret, not an API key.
- fallback: EventCallback
  Required callback for unregistered or unrecognized event types.
Returns EventsHandler
- Defined in src/index.ts:88

get

get<R>(__namedParameters: Omit<Core.FullRequestOptions, "method">): Promise<R>
Type Parameters
- R
Parameters
- __namedParameters: Omit<Core.FullRequestOptions, "method">
Returns Promise<R>
Inherited from HTTPClient.get
- Defined in src/client.ts:44

getWithResponse

getWithResponse<R>(
__namedParameters: Omit<Core.FullRequestOptions, "method">,
): Promise<WithResponse<R>>
Type Parameters
- R
Parameters
- __namedParameters: Omit<Core.FullRequestOptions, "method">
Returns Promise<WithResponse<R>>
Inherited from HTTPClient.getWithResponse
- Defined in src/client.ts:53

parseEventNotification

parseEventNotification(
    secret: string,
    body: EventBody,
    signature: string,
): Promise<EventNotification>
Verify an incoming event's signature and timestamp, then parse it without running callbacks. For already verified, trusted payloads, use SumUp.parseEventNotificationWithoutVerification.
Parameters
- secret: string
  Your event signing secret, not an API key.
- body: EventBody
  Unchanged request body, read before JSON parsing.
- signature: string
  Complete value of the SIGNATURE_HEADER header.
Returns Promise<EventNotification>
A typed notification, or UnknownEvent for an unrecognized type.

Throws
EventSignatureError If verification fails, including the five-minute timestamp check.

Throws
EventPayloadError If the body cannot be decoded as a JSON object.
- Defined in src/index.ts:102

parseEventNotificationWithoutVerification

parseEventNotificationWithoutVerification(body: EventBody): EventNotification
Parse an event without checking its signature or signing timestamp. Use only for fixtures or trusted payloads verified before being queued. Use SumUp.parseEventNotification for incoming HTTP deliveries.
Parameters
- body: EventBody
  The stored event payload.
Returns EventNotification
A typed notification, or UnknownEvent for an unrecognized type.

Throws
EventPayloadError If the body cannot be decoded as a JSON object.
- Defined in src/index.ts:118

patch

patch<R>(__namedParameters: Omit<Core.FullRequestOptions, "method">): Promise<R>
Type Parameters
- R
Parameters
- __namedParameters: Omit<Core.FullRequestOptions, "method">
Returns Promise<R>
Inherited from HTTPClient.patch
- Defined in src/client.ts:98

patchWithResponse

patchWithResponse<R>(
__namedParameters: Omit<Core.FullRequestOptions, "method">,
): Promise<WithResponse<R>>
Type Parameters
- R
Parameters
- __namedParameters: Omit<Core.FullRequestOptions, "method">
Returns Promise<WithResponse<R>>
Inherited from HTTPClient.patchWithResponse
- Defined in src/client.ts:107

post

post<R>(__namedParameters: Omit<Core.FullRequestOptions, "method">): Promise<R>
Type Parameters
- R
Parameters
- __namedParameters: Omit<Core.FullRequestOptions, "method">
Returns Promise<R>
Inherited from HTTPClient.post
- Defined in src/client.ts:62

postWithResponse

postWithResponse<R>(
__namedParameters: Omit<Core.FullRequestOptions, "method">,
): Promise<WithResponse<R>>
Type Parameters
- R
Parameters
- __namedParameters: Omit<Core.FullRequestOptions, "method">
Returns Promise<WithResponse<R>>
Inherited from HTTPClient.postWithResponse
- Defined in src/client.ts:71

put

put<R>(__namedParameters: Omit<Core.FullRequestOptions, "method">): Promise<R>
Type Parameters
- R
Parameters
- __namedParameters: Omit<Core.FullRequestOptions, "method">
Returns Promise<R>
Inherited from HTTPClient.put
- Defined in src/client.ts:80

putWithResponse

putWithResponse<R>(
__namedParameters: Omit<Core.FullRequestOptions, "method">,
): Promise<WithResponse<R>>
Type Parameters
- R
Parameters
- __namedParameters: Omit<Core.FullRequestOptions, "method">
Returns Promise<WithResponse<R>>
Inherited from HTTPClient.putWithResponse
- Defined in src/client.ts:89

request

request<T>(__namedParameters: FullRequestOptions): Promise<T>
Type Parameters
- T
Parameters
- __namedParameters: FullRequestOptions
Returns Promise<T>
Inherited from HTTPClient.request
- Defined in src/client.ts:134

requestWithResponse

requestWithResponse<T>(
__namedParameters: FullRequestOptions,
): Promise<WithResponse<T>>
Type Parameters
- T
Parameters
- __namedParameters: FullRequestOptions
Returns Promise<WithResponse<T>>
Inherited from HTTPClient.requestWithResponse
- Defined in src/client.ts:138

`Protected`stringifyQuery

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

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

transactions

Methods

delete

Type Parameters

Parameters

Returns Promise<R>

deleteWithResponse

Type Parameters

Parameters

Returns Promise<WithResponse<R>>

Protecteddo

Parameters

Returns Promise<Response>

eventsHandler

Parameters

Returns EventsHandler

get

Type Parameters

Parameters

Returns Promise<R>

getWithResponse

Type Parameters

Parameters

Returns Promise<WithResponse<R>>

parseEventNotification

Parameters

Returns Promise<EventNotification>

Throws

Throws

parseEventNotificationWithoutVerification

Parameters

Returns EventNotification

Throws

patch

Type Parameters

Parameters

Returns Promise<R>

patchWithResponse

Type Parameters

Parameters

Returns Promise<WithResponse<R>>

post

Type Parameters

Parameters

Returns Promise<R>

postWithResponse

Type Parameters

Parameters

Returns Promise<WithResponse<R>>

put

Type Parameters

Parameters

Returns Promise<R>

putWithResponse

Type Parameters

Parameters

Returns Promise<WithResponse<R>>

`Optional`apiKey

`Protected`do

`Protected`stringifyQuery