Overview

The SumUp Node.js SDK (@sumup/sdk) serves as a client library designed to simplify interaction with the SumUp API from Node.js applications. Its primary purpose is to provide a programmatic interface for developers to integrate SumUp's various functionalities, such as managing checkouts, accessing merchant data, processing card reader transactions, and handling customer and transaction information.

Key features of the SDK include:

• API Client: A structured client (SumUp class) for making requests to the SumUp API.
• Resource Management: Dedicated resource classes for different API domains, such as Checkouts, Customers, Merchant, Readers, Transactions, Payouts, Members, Roles, Subaccounts, Memberships, and Receipts. This provides an organized way to interact with specific parts of the SumUp ecosystem.
• Type Safety: Generated TypeScript types for API request bodies and responses, enhancing developer experience and reducing errors.
• Request Handling: Built-in mechanisms for constructing API requests, including handling API keys, base URLs, headers, query parameters, and request bodies.
• Response Processing: Utility for parsing API responses, including JSON deserialization and structured error handling.
• Promise-based API: Utilizes APIPromise for asynchronous operations, allowing for async/await syntax and providing methods like withResponse() to access the raw HTTP response.

The SDK helps developers achieve tasks like initiating and processing checkouts, retrieving details about their merchant account, listing and managing card readers, and interacting with customer and transaction data programmatically within their Node.js applications.

Development Status:

It's important to note that this SDK is currently under development. As stated in the README, minor breaking changes might be introduced before it reaches a stable v1 release.