SumUp Client API Reference

The SumUp client is the primary entry point for interacting with the SumUp API. It provides a structured interface for accessing various API resources and methods, built on top of a robust HTTP client.

SumUp Client Class

The SumUp client extends the HTTPClient class, inheriting its core request handling capabilities.

Constructor

The SumUp constructor accepts an APIConfig object for configuration. For details on the available configuration options, refer to the [Configuration] page.

Resource Properties

The SumUp client exposes various API resources as properties, each providing methods to interact with specific parts of the SumUp API. These resources are instances of classes that extend APIResource. For more information on APIResource and other core concepts, see [Core SDK Concepts].

• checkouts: Checkouts
• customers: Customers
• members: Members
• memberships: Memberships
• merchant: Merchant
• merchants: Merchants
• payouts: Payouts
• readers: Readers
• receipts: Receipts
• roles: Roles
• subaccounts: Subaccounts
• transactions: Transactions

Inherited HTTPClient Methods

The SumUp client inherits the following HTTP methods from the HTTPClient base class, allowing for direct, low-level interaction with the API.

• get<R, E = Core.APIError<unknown>>(params: Omit<Core.FullParams, "method">): Core.APIPromise<R>
• post<R, E = Core.APIError<unknown>>(params: Omit<Core.FullParams, "method">): Core.APIPromise<R>
• put<R, E = Core.APIError<unknown>>(params: Omit<Core.FullParams, "method">): Core.APIPromise<R>
• patch<R, E = Core.APIError<unknown>>(params: Omit<Core.FullParams, "method">): Core.APIPromise<R>
• delete<R, E = Core.APIError<unknown>>(params: Omit<Core.FullParams, "method">): Core.APIPromise<R>
• request<T, E = Core.APIError<unknown>>(params: Core.FullParams): Core.APIPromise<T>

Type Definitions

The SumUp client also exports several core types that are fundamental to its operation.

For a deeper understanding of APIPromise, APIError, FetchParams, and FullParams, refer to the [Core SDK Concepts] page.