canonical: https://jentic.com/apis/sumup.com/sumup

# SumUp REST API

SumUp’s REST API operates with [JSON](https://www.json.org/json-en.html) HTTP requests and responses. The request bodies are sent through resource-oriented URLs and use the standard [HTTP response codes](https://developer.mozilla.org/docs/Web/HTTP/Status). You can experiment and work on your integration in a sandbox that doesn't affect your regular data and doesn't process real transactions. To cr. The API exposes 45 endpoints secured with Bearer, oauth2 authentication.

## For AI agents

Programmatically get available payment methods, create a checkout. Covers 45 operations with Bearer, oauth2 authentication.

## Scope

Does not handle communications, crm, or developer tools - use for payments only.

## Capabilities

- Get available payment methods
- Create a checkout
- List checkouts
- Retrieve a checkout
- Process a checkout
- Deactivate a checkout

## Use cases

### Payments Operations

Use the SumUp REST API to perform payments operations programmatically. The API provides 45 endpoints covering core functionality including get available payment methods, create a checkout, list checkouts.

Example prompt: Call GET `/v0.1/merchants/{merchant_code}/payment-methods` to get available payment methods

### Automated Checkouts Management

Automate checkouts operations by combining multiple SumUp REST API endpoints. Agents can create a checkout and then list checkouts in a single workflow.

Example prompt: Call POST `/v0.1/checkouts` to create a checkout, then verify the result

### AI Agent Integration via Jentic

AI agents discover and call SumUp REST API endpoints through Jentic without managing credentials directly. An agent searches for the required operation by intent, receives the matching endpoint schema, and executes the call with Jentic-managed authentication. This eliminates the need to read API documentation or handle Bearer, oauth2 tokens manually.

Example prompt: Search Jentic for 'get available payment methods', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| GET | `/v0.1/merchants/{merchant_code}/payment-methods` | Get available payment methods |
| POST | `/v0.1/checkouts` | Create a checkout |
| GET | `/v0.1/checkouts` | List checkouts |
| GET | `/v0.1/checkouts/{id}` | Retrieve a checkout |
| PUT | `/v0.1/checkouts/{id}` | Process a checkout |
| DELETE | `/v0.1/checkouts/{id}` | Deactivate a checkout |
| POST | `/v0.1/customers` | Create a customer |
| GET | `/v0.1/customers/{customer_id}` | Retrieve a customer |

## Key resources

- **Checkouts** — Accept payments from your end users by adding the Checkouts model to your platform.
SumUp supports s
- **Customers** — Allow your regular customers to save their information with the Customers model.
This will prevent r
- **Transactions** — Retrieve details for a specific transaction by it’s `id`
or any other required query parameter, or l
- **Payouts** — The Payouts model will allow you to track funds you’ve received from SumUp.
You can receive a detail
- **Receipts** — The Receipts model obtains receipt-like details for specific transactions.

## Why Jentic

- **Setup:** Wiring the SumUp REST API by hand means choosing between its bearer API key and OAuth2 flows, managing scopes, and tracking merchant, checkout, and customer ids yourself. Through Jentic you install once, import the SumUp REST API from the API Directory, store the credentials once, and your agent calls it.
- **Permission scoping:** SumUp puts the checkout id in the URL path (`/v0.1/checkouts/{id}`), so a rule can pin your agent to one checkout: it can read and update that checkout and nothing else. You choose the operations it may call, so destructive ones like deactivating a checkout are not included unless you add them.
- **Credential handling:** Your SumUp credentials are stored once, encrypted, by your own Jentic One instance and injected at execution time. They never enter the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'list payment methods' or 'create a checkout', and Jentic returns the matching SumUp operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Stripe** — Alternative payments API
- **Adyen** — Alternative payments API
- **Square** — Complementary payments API
- **Paypal** — Complementary payments API

## FAQ

### What authentication does the SumUp REST API use?

The SumUp REST API uses Bearer, oauth2 authentication. Through Jentic, these credentials are stored encrypted in your Jentic One instance and injected at execution time, so raw secrets never enter the agent context.

### Can I get available payment methods with the SumUp REST API?

Yes. Use the GET `/v0.1/merchants/{merchant_code}/payment-methods` endpoint. The API returns structured JSON responses that agents can parse and act on directly.

### What are the rate limits for the SumUp REST API?

Rate limits are not specified in the OpenAPI spec. Check the vendor documentation for current limits. Through Jentic, rate limiting is handled automatically with retry logic built into the execution layer.

### How do I get available payment methods through Jentic?

Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'get available payment methods'. Jentic returns the matching SumUp REST API operation with its input schema. Load the schema and execute the call - credentials are injected automatically.

### How many endpoints does the SumUp REST API have?

The SumUp REST API exposes 45 endpoints covering checkouts, customers, transactions operations.

### Can I limit what my agent is allowed to do with the SumUp REST API?

Yes. Because Jentic One is self-hosted and runs under your own rules, you decide which SumUp operations your agent may call, so read-only work like listing payment methods or retrieving a checkout can be enabled while destructive calls such as deactivating a checkout (DELETE `/v0.1/checkouts/{id}`) stay off unless you add them. SumUp carries the checkout id in the URL path (`/v0.1/checkouts/{id}`), so a rule can pin the agent to a single checkout, letting it read and update that one checkout and nothing else. The credentials each operation uses are controlled the same way, so the agent only ever acts within the scope you grant.