SumUp Node.js SDK: Configuration

The SumUp Node.js SDK client is highly configurable, allowing you to tailor its behavior to your specific needs, such as setting authentication credentials, specifying the API host, or providing custom fetch parameters.

APIConfig Type

The primary way to configure the SDK client is by passing an APIConfig object to the SumUp constructor. The APIConfig type is defined as follows:

Let's break down each of these properties.

apiKey

• Type: string
• Purpose: This is your SumUp API Key, essential for authenticating all requests made to the SumUp API.
• Required: Yes, for most API operations. If not provided, requests will likely fail with authentication errors.
• Example: sup_sk_MvxmLOl0...

Example: The most basic configuration involves providing your API key:

host

• Type: string
• Purpose: Allows you to override the base URL for the SumUp API. This is particularly useful for testing against staging environments or specific regional endpoints.
• Default: https://api.sumup.com

Example: To use a custom host:

baseParams

• Type: Core.FetchParams

• Purpose: This property allows you to provide an object containing fetch parameters that will be merged into every request made by the SDK client. Core.FetchParams is essentially Omit<RequestInit, "body" | "method">, meaning you can specify properties like headers, signal for aborting requests, cache strategy, etc.

• Default Headers: The SDK automatically sets default headers. When baseParams is provided, its headers are merged with these defaults.

  • Accept: application/json
  • Content-Type: application/json
  • User-Agent: sumup-ts/v<SDK_VERSION> (e.g., sumup-ts/v0.0.5)
  • Authorization: Bearer <apiKey> (if apiKey is provided)

  When merging headers, custom headers provided in baseParams will override the SDK's default headers if they share the same key.

Example: Adding a custom header to all requests, and setting a global timeout (assuming your fetch polyfill or environment supports it):

Merging baseParams with Request-Specific Parameters

When you make an individual API call, you can also pass FetchParams as an optional last argument. These request-specific parameters will be merged with the baseParams provided during client instantiation. Request-specific parameters take precedence over baseParams in case of conflicts.

For example, to override X-Custom-Header for a single request:

Complete Configuration Example

Here's an example combining all available configuration options:

By understanding and utilizing these configuration options, you can effectively control how the SumUp Node.js SDK interacts with the SumUp API, adapting it to various deployment scenarios and integration requirements.

For more details on getting started, refer to the [Getting Started] page.