The SumUp's Developer Portal provides documentation for integrations, SDKs, and public APIs that let external developers build payment-acceptance solutions. The website is built using Astro and Markdoc.
- Make sure you have Node.js v20+ installed. It is highly recommended to install a Node version manager (such as nvm) that enables you to switch between multiple versions of Node.js.
- Clone the repository
Open your terminal and navigate to the directory where you would like to store the project. Then run the following commands:
git clone git@github.com:sumup/sumup-developer.git
cd sumup-developer- Install the dependencies
Run the following command:
npm iThis command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
npm run devnpm run buildThis is a good way to test that everything will succeed when your changes are merged and are going to be deployed.
The OpenAPI specs used for the API Reference section of the developer portal are managed externally from a different repository and synchronized every time they change. If you spotted a mistake or have a suggestion for an improvement please open an issue here and we will take a look.