SumUp
Keep SumUp in step with your orders, invoices and payments without re-keying, with the right person approving what changes.
23 ways to read, 5 ways to write, each write switched on by you.
Quality checks
Built and tested with example responses.
- Ready to connect: doneEvery listed action is built in.
- Built and tested with example responses: doneEach action is built from the provider’s published API and tested against example responses, errors, rate limits and paging.
Connected, approved, proven.
The things teams do most with SumUp, an example flow with a person in the loop, and what Nexra keeps as proof.
Top actions
- Create hosted checkoutApproval by rule
- Create customerApproval by rule
- List checkoutsRead
Example flow
- SumUp · List checkoutsDone
- SumUp · Create hosted checkoutNeeds approval
- Nexra · Record the decision and result in the evidence chainProven
Example workflow. Routine runs go through on their own. Only a change your rules flag, such as one over a limit you set, waits for the right person, who sees the exact change and the rule before it reaches SumUp.
What gets logged
- Whether it ran on its own or who approved it, and under which rule
- A fingerprint of the exact request sent to SumUp
- SumUp's reply: what it created or changed
- One entry in the evidence chain, linked to the one before
Try this in the sandbox
Run the whole flow with test data in your sandbox, then connect a SumUp test account before you go live.
For developers
Technical detail
SumUp merchant, persons, transactions, refunds, charge-backs, receipts, payout lines with fees, team, memberships and readers (read); customers and hosted checkouts (read, create, update); reader names (update).
SumUp API docs- Source actions
- 23
- Destination actions
- 5
- Data types
- 17
What you can map
Reads are always available. Writes are off until you switch them on for a connection, and governed writes follow your policies.
Checkouts4
- Create hosted checkoutDestinationProvider duplicate protectionApproval before production
Create a checkout with a SumUp-hosted payment page. Creating it charges nothing; the customer pays on the hosted page.
- Get checkoutSource
One checkout with status, amount and resulting transaction.
- List checkoutsSource
Checkouts, optionally filtered by your checkout reference.
- Update pending checkoutDestinationProvider duplicate protectionApproval before production
Change the amount, currency, description, reference, expiry or customer of a checkout that is still PENDING. Nothing is charged.
Customers3
- Create customerDestinationProvider duplicate protectionApproval before production
Create a saved customer under your own customer ID. Nothing is charged.
- Get customerSource
A saved customer's personal details and address.
- Update customerDestinationProvider duplicate protectionApproval before production
Update a saved customer's personal details; fields you leave out keep their values.
Disputes1
- List charge-backsSourceIncremental
Charge-backs (card disputes) from the transaction history, with amount, status and transaction code. Charge-back deductions from payouts appear in payouts as CHARGE_BACK_DEDUCTION.
Members2
- Get team memberSource
One merchant team member.
- List team membersSource
Merchant team members with status, roles and permissions.
Memberships1
- List membershipsSource
Merchant accounts and organisations the token's user belongs to, with roles.
Merchant1
- Get merchant profileSource
The connected merchant's business profile, country, currency and locale.
Payment instruments1
- List customer payment instrumentsSource
Saved cards for a customer: token, card type, last four and mandate status.
Payment methods1
- List available payment methodsSource
Payment methods available for checkouts, optionally for an amount and currency.
Payouts1
- List payoutsSourceIncremental
Payouts and payout deductions (chargebacks, refunds, direct-debit returns) between two dates.
Persons2
- Get merchant personSource
One person on the merchant account (names, relationships and ownership only).
- List merchant personsSource
Owners, representatives and officers on the merchant account: names, relationships and ownership share only.
Reader checkouts1
- Get reader checkoutSource
Status of a checkout started on a card reader (read only).
Reader status1
- Get card reader statusSource
Live reader status: online state, battery, connection and firmware.
Readers3
- Get card readerSource
One paired card reader.
- List card readersSource
Paired card readers with status and device model.
- Update card readerDestinationProvider duplicate protectionApproval before production
Rename a paired card reader or set its metadata.
Receipts1
- Get receiptSource
Receipt data for a transaction: amounts, VAT breakdown, products and authorization.
Refunds1
- List refundsSourceIncremental
Refunds already issued, from the transaction history, with amount, status and transaction code. Nexra never creates refunds.
Roles2
- Get roleSource
One merchant role with its permissions.
- List rolesSource
Custom and predefined merchant roles with their permissions.
Transactions2
- Get transactionSource
Full transaction details by ID, transaction code or your client transaction ID, including products and payout events.
- List transaction historySourceIncremental
Read merchant transaction history; additional older pages are fetched through provider links.
Access and limits
- Authentication
- SumUp merchant access token
- Plans and access
- A SumUp merchant account with an API key or OAuth access token. OAuth tokens need the scopes for each area (transactions.history, user.profile_readonly, payments, payment_instruments, user.app-settings). Online checkouts must be enabled for the merchant.
- Test environment
- Create a sandbox merchant in the SumUp Dashboard and use its API key.
- Rate limits
- SumUp returns HTTP 429 when limits are exceeded; Nexra honours Retry-After with bounded retries. Customer and checkout creates are keyed by your IDs.
- Pagination
- Transaction history follows rel=next links; team members use offset and limit. Other lists return one page.
- Provider events
- SumUp calls the checkout return_url when a checkout's status changes. Flows run on demand, on a schedule, or when a scheduled check finds new or changed records.
Before you build a flow
- Intentional exclusions: processing or deactivating checkouts, Apple Pay sessions, refunds, reader and Go reader checkouts and terminations, reader pairing, deactivating payment instruments, member and role writes (access control), and every delete.
- SumUp's public API is small: there are no list endpoints for customers, receipts, payment instruments across customers, products or webhooks, and no balance or fee report endpoint. Fees are read from transactions and payouts.
- Reader updates change only the name and metadata.
- Checkouts are created with purpose CHECKOUT and a hosted payment page; recurring-payment setup is not exposed.
- Transaction history accepts one value per status, type and payment-type filter.
- Payouts return a single page per date range, filtered by payout date in whole days. Each payout row is a per-transaction payout line; SumUp has no separate endpoint that lists payout totals, so payout totals are the sum of their lines.
- Disputes: SumUp's API exposes charge-backs only as CHARGE_BACK transactions and payout deductions; there is no dispute case, evidence or deadline endpoint.
- Fees: there is no fee report endpoint; fees come from payout lines (fee) and the single-transaction detail (feeAmount). Transaction history rows carry no fee.
- Card PAR, ELV account details, device and location are not mapped. Persons return names, relationships and ownership only; birthdates, addresses, phone numbers, nationality and legal identifiers are never mapped.
Developer reference
- Create the SumUp credentials described above with the narrowest permissions your flows need.
- In Nexra, open Connect, then Connections, then New connection, choose SumUp, enter its settings and credentials, and tick only the write actions you need. Connection guide
- Test the connection, then use its actions as flow sources and destinations. Flow guide
Machine-readable detail: GET /api/public/connect/connectors/sumup and the Connections API.