https://github.com/sumup/sumup-ts

Node.js SDK for the SumUp API.
https://github.com/sumup/sumup-ts

nodejs payments sdk sumup typescript

Last synced: about 1 month ago
JSON representation

Node.js SDK for the SumUp API.

• Host: GitHub
• URL: https://github.com/sumup/sumup-ts
• Owner: sumup
• License: apache-2.0
• Created: 2025-02-11T11:55:37.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2026-04-24T10:57:43.000Z (about 1 month ago)
• Last Synced: 2026-04-24T12:34:08.546Z (about 1 month ago)
• Topics: nodejs, payments, sdk, sumup, typescript
• Language: TypeScript
• Homepage: https://developer.sumup.com
• Size: 1.77 MB
• Stars: 18
• Watchers: 7
• Forks: 0
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md
  • Security: SECURITY.md

Awesome Lists containing this project

README

          


# SumUp Node.js SDK

[![NPM Version](https://img.shields.io/npm/v/%40sumup%2Fsdk.svg)](https://www.npmjs.org/package/@sumup/sdk)

[![JSR Version](https://jsr.io/badges/@sumup/sdk)](https://jsr.io/@sumup/sdk)

[![Documentation][docs-badge]](https://developer.sumup.com)

[![Build Status](https://github.com/sumup/sumup-ts/workflows/CI/badge.svg)](https://github.com/sumup/sumup-ts/actions/workflows/ci.yml)

[![Downloads](https://img.shields.io/npm/dm/%40sumup%2Fsdk.svg)](https://www.npmjs.com/package/@sumup/sdk)

[![License](https://img.shields.io/github/license/sumup/sumup-ts)](./LICENSE)



_**IMPORTANT:** This SDK is under development. We might still introduce minor breaking changes before reaching v1._

The Node.js SDK for the SumUp [API](https://developer.sumup.com).

To learn more, check out our [API Reference](https://developer.sumup.com/api) and [Developer Documentation](https://developer.sumup.com). You can also find the full documentation of the SumUp Node.js SDK at [sumup.github.io/sumup-ts](https://sumup.github.io/sumup-ts/).

## Requirements

Node 18 or higher.

## Installation

Install the package with:

```bash

npm install @sumup/sdk

# or

yarn add @sumup/sdk

```

Install from jsr:

```bash

deno add jsr:@sumup/sdk

# or

npx jsr add @sumup/sdk

```

## Usage

```js

const sumup = require('@sumup/sdk')({

  apiKey: 'sup_sk_MvxmLOl0...'

});

sumup.merchant.get()

  .then(merchant => console.info(merchant))

  .catch(error => console.error(error));

```

Or using ES modules and async/await:

```ts

import SumUp from "@sumup/sdk";

const client = new SumUp({

  apiKey: 'sup_sk_MvxmLOl0...',

});

const merchant = await client.merchant.get();

console.info(merchant);

```

## Examples

Examples require an API key and your merchant code. You can run the examples using:

```bash

npx tsx examples/checkout/index.ts

```

[docs-badge]: https://img.shields.io/badge/SumUp-documentation-white.svg?logo=data:image/svg+xml;base64,PHN2ZyB3aWR0aD0iMjQiIGhlaWdodD0iMjQiIHZpZXdCb3g9IjAgMCAyNCAyNCIgZmlsbD0ibm9uZSIgY29sb3I9IndoaXRlIiB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciPgogICAgPHBhdGggZD0iTTIyLjI5IDBIMS43Qy43NyAwIDAgLjc3IDAgMS43MVYyMi4zYzAgLjkzLjc3IDEuNyAxLjcxIDEuN0gyMi4zYy45NCAwIDEuNzEtLjc3IDEuNzEtMS43MVYxLjdDMjQgLjc3IDIzLjIzIDAgMjIuMjkgMFptLTcuMjIgMTguMDdhNS42MiA1LjYyIDAgMCAxLTcuNjguMjQuMzYuMzYgMCAwIDEtLjAxLS40OWw3LjQ0LTcuNDRhLjM1LjM1IDAgMCAxIC40OSAwIDUuNiA1LjYgMCAwIDEtLjI0IDcuNjlabTEuNTUtMTEuOS03LjQ0IDcuNDVhLjM1LjM1IDAgMCAxLS41IDAgNS42MSA1LjYxIDAgMCAxIDcuOS03Ljk2bC4wMy4wM2MuMTMuMTMuMTQuMzUuMDEuNDlaIiBmaWxsPSJjdXJyZW50Q29sb3IiLz4KPC9zdmc+