https://github.com/sumup/sumup-go
Go SDK for the SumUp API.
https://github.com/sumup/sumup-go
golang payments sdk sumup
Last synced: 4 months ago
JSON representation
Go SDK for the SumUp API.
- Host: GitHub
- URL: https://github.com/sumup/sumup-go
- Owner: sumup
- License: apache-2.0
- Created: 2023-09-18T19:48:42.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2026-01-26T12:20:35.000Z (4 months ago)
- Last Synced: 2026-01-27T00:35:14.874Z (4 months ago)
- Topics: golang, payments, sdk, sumup
- Language: Go
- Homepage: https://developer.sumup.com
- Size: 1.17 MB
- Stars: 13
- Watchers: 10
- Forks: 5
- Open Issues: 6
-
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 Go SDK
[](https://github.com/sumup/sumup-go/)
[](https://pkg.go.dev/github.com/sumup/sumup-go)
[![Documentation][docs-badge]](https://developer.sumup.com)
[](https://github.com/sumup/sumup-go/actions/workflows/ci.yml)
[](./LICENSE)
_**IMPORTANT:** This SDK is under development. We might still introduce minor breaking changes before reaching v1._
The [Go](https://go.dev/) SDK for the SumUp [API](https://developer.sumup.com).
To learn more, check out our [API Reference](https://developer.sumup.com/api) and [Documentation](https://developer.sumup.com).
## Installation
`sumup-go` is compatible with projects using Go Modules.
Import the SDK using:
```go
import (
"github.com/sumup/sumup-go"
)
```
And run any of `go build`/`go install`/`go test` which will resolve the package automatically.
Alternatively, you can install the SDK using:
```bash
go get github.com/sumup/sumup-go
```
## Documentation
For complete documentation of SumUp APIs visit [developer.sumup.com](https://developer.sumup.com).
Alternatively, refer to this simple example to get started:
```go
package main
import (
"context"
"log"
"github.com/sumup/sumup-go"
)
func main() {
client := sumup.NewClient()
merchant, err := client.Merchants.Get(context.Background(), "MCNPLE22", sumup.MerchantsGetParams{})
if err != nil {
log.Printf("[ERROR] get merchant account: %v", err)
return
}
log.Printf("[INFO] merchant code: %s", merchant.MerchantCode)
}
```
## Authentication
The easiest form of authenticating with SumUp APIs is using [API keys](https://developer.sumup.com/docs/online-payments/introduction/authorization/#api-keys). You can create API keys in the [API key section](https://developer.sumup.com/protected/api-keys/) of the developer portal. Store them securely. The SDK by default loads the API key from `SUMUP_API_KEY` environment variable. Alternatively, provide API key on your own:
```go
client := sumup.NewClient(client.WithAPIKey("sup_sk_LZFWoLyd..."))
```
## Examples
The repository includes several examples demonstrating different use cases:
**[simple](./example/simple)** - Basic merchant account information retrieval showing how to initialize the SDK and make a simple API call.
```sh
go run example/simple/main.go
```
**[checkout](./example/checkout)** - Creating and processing a checkout programmatically using test card details.
```sh
go run example/checkout/main.go
```
**[full](./example/full)** - Complete web application demonstrating the full checkout flow with the SumUp payment widget. Shows how to create checkouts and integrate the widget in a real application.
```sh
go run example/full/main.go
```
and visit http://localhost:8080
## Support
Our APIs and their public offering is limited and under heavy development. If you have any questions or inquiries reach out to our support team via the [Contact Form](https://developer.sumup.com/contact/).
For question specifically related to this Golang SDK please [Open an Issue](https://github.com/sumup/sumup-go/issues/new).
`sumup-go` SDK will always support latest 3 version of golang following the Golang [Release Policy](https://go.dev/doc/devel/release).
[docs-badge]: https://img.shields.io/badge/SumUp-documentation-white.svg?logo=data:image/svg+xml;base64,PHN2ZyB3aWR0aD0iMjQiIGhlaWdodD0iMjQiIHZpZXdCb3g9IjAgMCAyNCAyNCIgZmlsbD0ibm9uZSIgY29sb3I9IndoaXRlIiB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciPgogICAgPHBhdGggZD0iTTIyLjI5IDBIMS43Qy43NyAwIDAgLjc3IDAgMS43MVYyMi4zYzAgLjkzLjc3IDEuNyAxLjcxIDEuN0gyMi4zYy45NCAwIDEuNzEtLjc3IDEuNzEtMS43MVYxLjdDMjQgLjc3IDIzLjIzIDAgMjIuMjkgMFptLTcuMjIgMTguMDdhNS42MiA1LjYyIDAgMCAxLTcuNjguMjQuMzYuMzYgMCAwIDEtLjAxLS40OWw3LjQ0LTcuNDRhLjM1LjM1IDAgMCAxIC40OSAwIDUuNiA1LjYgMCAwIDEtLjI0IDcuNjlabTEuNTUtMTEuOS03LjQ0IDcuNDVhLjM1LjM1IDAgMCAxLS41IDAgNS42MSA1LjYxIDAgMCAxIDcuOS03Ljk2bC4wMy4wM2MuMTMuMTMuMTQuMzUuMDEuNDlaIiBmaWxsPSJjdXJyZW50Q29sb3IiLz4KPC9zdmc+