SumUp
Docs
Dashboard

API Changelog

Cloud API menu lock

Cloud APIAPI Permalink

You can now protect Solo menu access in unattended Cloud API setups with a 4-digit passcode. Menu lock is available on Solo readers running firmware 3.3.44.0 or higher.

New reader settings endpoints let you:

  • Enable or disable menu lock on a paired Solo reader
  • Set or update the 4-digit passcode
  • Retrieve the current menu lock configuration for a reader

Use PATCH /v0.1/merchants/{merchant_code}/readers/{reader_id}/settings to update settings and GET on the same path to consult them. The reader must be online for updates to apply.

See the Cloud API guide for request examples and integration notes.

SumUp CLI

CLIAPI Permalink

We are happy to announce the release of the SumUp CLI(Opens in a new tab), a command-line tool for interacting with SumUp APIs directly from your terminal.

Use the CLI to explore API operations, manage your SumUp account, create online checkouts, control paired readers, and automate workflows with JSON output. It also supports saved merchant context, shell completion, and generated man pages.

Install it with Homebrew:

brew install sumup/cli/sumup

See the SumUp CLI guide for installation, authentication, and usage instructions, or review the v0.5.0 release(Opens in a new tab) on GitHub.

Hosted Checkout

APIOnline Payments Permalink

Hosted Checkout is now available for Online Payments.

Hosted Checkout gives you a SumUp-hosted payment page. Your integration creates the checkout server-side, receives a hosted_checkout_url, and redirects the customer to a SumUp-hosted page to complete the payment.

This release is designed for merchants and platforms that want the fastest path to launch online payments without building or hosting their own checkout UI.

What you can do with Hosted Checkout:

  • Create a checkout with hosted_checkout.enabled set to true.
  • Redirect customers to the returned hosted payment page.
  • Add a redirect_url so the success page links back to your website.
  • Let SumUp handle the payment page and final status screens while your backend verifies the final state through the API or webhooks.

See the new Hosted Checkout guide for the full flow, SDK examples, and integration details.

Online Payments Test Cards

APIOnline Payments Permalink

We have updated sandbox testing for Online Payments to use a dedicated set of test cards.

This affects all Online Payments integrations tested with sandbox merchant accounts.

What changed:

  • Sandbox testing now relies on predefined test card numbers.
  • The test set covers successful payments, payment failures, and 3D Secure scenarios.

Migration note: update your QA flows to use the documented test cards and expected outcomes.

See Testing online payments for setup steps, card numbers, and expected behavior.

Cloud API

Cloud APIAPI Permalink

Today we are announcing the introduction of a new endpoint that lets you receive real-time updates from your connected card reader. You can see the current screen shown during the payment process and check the device status, including battery level, connectivity, and update progress.

Supported States

  • IDLE – Reader ready for next transaction
  • SELECTING_TIP – Waiting for tip input
  • WAITING_FOR_CARD – Awaiting card insert/tap
  • WAITING_FOR_PIN – Waiting for PIN entry
  • WAITING_FOR_SIGNATURE – Waiting for customer signature
  • UPDATING_FIRMWARE – Firmware update in progress

Device Status

  • ONLINE – Device connected and operational
  • OFFLINE – Device disconnected (last state persisted)

If you run into issues or need help, please contact our support team(Opens in a new tab).

Deprecation of Trailing Slashes in URLs

APIDeprecation Permalink

Today we are announcing the deprecation of support for API requests that include a trailing slash at the end of the URL. While our documentation has never endorsed this pattern, we identified a small number of clients still relying on it. To ensure a smooth transition, a 2-month grace period will apply before the behavior is fully removed.

Details

  • Requests using URLs that end with / (e.g., /v0.1/checkouts/) will continue to work during the grace period.
  • After the grace period ends, these requests will return an error.
  • Standard, documented URLs without trailing slashes (e.g., /v0.1/checkouts ) remain fully supported.

Timeline

  • Deprecation announcement: 17.11.2025
  • Grace period: 2 months
  • Removal date: 17.01.2026

Required Action

Please consult the API documentation and update any API calls that include a trailing slash. This change typically only requires removing the final / in affected endpoints.

If you run into issues or need help identifying affected requests, please contact our support team(Opens in a new tab).

Type to search…