The SumUp CLI, sumup, lets you manage your SumUp account and call SumUp APIs from a terminal. Use it to explore API operations, run development workflows, or write scripts without setting up an SDK project.
The API reference includes a CLI sample for every operation supported by the tool.
Install the CLI
Choose one of the following installation methods:
# Homebrew
brew install sumup/cli/sumup
# mise
mise use -g github:sumup/sumup-cli@latest
# Go
go install github.com/sumup/sumup-cli/cmd/sumupConfirm that the installation succeeded:
sumup versionConfigure Authentication
Create a secret API key in the developer dashboard(Opens in a new tab), then expose it to the CLI through the SUMUP_API_KEY environment variable:
export SUMUP_API_KEY=sup_sk_your_api_keyYou can also pass an API key with the global --api-key option. Avoid saving secret API keys in shell history or source control.
Set Your Merchant Context
Commands that operate on a merchant accept the --merchant-code option. To avoid repeating it, select a merchant interactively and save it as your current context:
sumup context setView or clear the saved context with:
sumup context get
sumup context unsetAn explicit --merchant-code option overrides the saved context.
Run Commands
Create an online checkout:
sumup checkouts create \
--reference order-123 \
--amount 19.99 \
--currency EUR \
--merchant-code M123 \
--description "Ticket purchase"List the readers paired with a merchant:
sumup readers list --merchant-code M123Add the global --json option when a script needs machine-readable output:
sumup --json readers list --merchant-code M123Use the built-in help to discover available resources, operations, and options:
sumup --help
sumup checkouts --help
sumup checkouts create --helpEnable Shell Completion
Generate and load a completion script for your shell:
# bash
source <(sumup completion bash)
# zsh
source <(sumup completion zsh)
# fish
sumup completion fish > ~/.config/fish/completions/sumup.fishRelease archives also include pre-generated completion scripts and a man page.
Next Steps
- Browse the API reference and select the CLI tab for operation-specific commands.
- Review authorization options before using the CLI with production accounts.
- Use an official server SDK when you need typed clients and application-level integration.