Explore SumUp's REST API with OpenAPI specifications and ready-to-use Postman and Bruno collections. For endpoint documentation and integration guides, visit the SumUp developer portal.
Download a specification to use with API clients, code generators, and other OpenAPI tools:
| Version | JSON | YAML |
|---|---|---|
| OpenAPI 3.0 | openapi.json | openapi.yaml |
| OpenAPI 3.1 | openapi31.json | openapi31.yaml |
Import SumUpAPICollection.json, or paste this URL into Postman's import dialog:
https://raw.githubusercontent.com/sumup/sumup-openapi/refs/heads/main/SumUpAPICollection.json
You can also fork the collection in SumUp's public Postman workspace.
In the collection's Authorization tab, select Bearer Token and enter your SumUp API key.
Import the collection directly in Bruno using its GitHub integration. Public repositories can be imported without signing in to GitHub.
- In Bruno, open Import Collection and select the GitHub tab.
- Search for
sumup/sumup-openapi, select the repository, and click Clone. - Select the SumUp API collection in the
brunodirectory and click Open. - Select the Production server environment to set the API base URL.
- In the collection settings, select Bearer Token authentication and enter your SumUp API key.
Pull updates with Git to get the latest collection. Keep your API key in a local secret variable and reference it from the authentication settings. Keep custom requests in a separate collection so you can update this one without losing your changes.
See CONTRIBUTING.md for development setup and collection generation.