SumUp MCP Server
NPM · @SUMUP/MCP · SCANNED AUG 7
Tools to explore SumUp accounts, payments, customers, and payouts.
Available components
How this component scores in each security and reliability category. Every signal is checked automatically from public evidence about the published package, including repeated runs of it in an isolated sandbox, and we only credit what we can confirm. How we score →
Supply Chain Security80
- No malware found by supply-chain analysis.Pass
- CVE check failed: a known high-severity CVE affects langsmith 0.3.87, reached via @sumup/agent-toolkit > @langchain/core > langsmith. A fixed version is available. View diagnostics → Fail
- No install/post-install scripts declared.Pass
- Dependency health was assessed across the 167 of 171 dependencies we could resolve, so this covers what we could see, not the whole tree. View diagnostics → Partial
Provenance & Transparency71
- Repository check failed: the declared repository URL redirects; it must resolve directly. See how to fix → View diagnostics → Fail
- Cryptographically verified build provenance (signed, bound to sumup/sumup-agent-toolkit). View diagnostics → Pass
- Clear OSI-approved license (Apache-2.0).Pass
- Actively maintained (last published 26 days ago).Pass
- Disclosure check failed: no security disclosure policy was found in the source repository. See how to fix → Fail
Schema Quality & AI Usability41
- 0% of prompts and resources have a non-trivial description (not blank, and not just the item's name).Fail
- AI-judged instruction clarity (good).Pass
- Tool/resource definitions use about 4899 tokens (~96/item across 51 items; 49 tools + 2 resources), lean.Pass
- Usage-examples check failed: none of the tools include examples. See how to fix → Fail
Stability & Change Management0
- Stability not yet verified: not enough scan history yet (needs a 30-day window).Unverified
Tool Coverage94
- 98% of tools have a non-trivial description (not blank, and not just the tool's name).Partial
- 85% of tool parameters carry a description.Partial
Capabilities100
- Implements a supported MCP spec version (2025-11-25); the latest is 2026-07-28.Pass
Unverified: 1 category
A category scored 0 because we could not verify it: a data source with nothing on this package, evidence we could not reach, or a check we could not run. We only credit what we can confirm.
Add this component to your MCP client. Where a client-specific snippet is available, pick your client below and copy it straight into your config; otherwise use the connection detail shown.
npm · @sumup/mcp
claude mcp add sumup-mcp -- npx -y @sumup/mcp
codex mcp add sumup-mcp -- npx -y @sumup/mcp
{
"$schema": "https://opencode.ai/config.json",
"mcp": {
"sumup-mcp": {
"type": "local",
"command": [
"npx",
"-y",
"@sumup/mcp"
],
"enabled": true
}
}
} openclaw mcp add sumup-mcp --command npx --arg -y --arg @sumup/mcp
mcp_servers:
sumup-mcp:
command: "npx"
args: ["-y", "@sumup/mcp"] {
"mcpServers": {
"sumup-mcp": {
"command": "npx",
"args": [
"-y",
"@sumup/mcp"
]
}
}
} Every change we have recorded for this component, newest first. Security-relevant changes are always shown. ▲ marks a change for the better, ▼ a change for the worse; unmarked changes are neutral.
- 5 Aug 26 +23
- Stability: Stability not yet verified: not enough scan history yet (needs a 30-day window). security
- Schema quality: unverified → 0 ▲ functional
- MCP protocol: unverified → pass ▲ functional
- Tool coverage: unverified → 98 ▲ functional
- First check of Schema quality: good functional
- First check of Schema quality: pass functional
- First check of Tool coverage: 85 functional
- First check of Schema quality: fail functional
- 2 Aug 26 +38
- CVE-2026-41182 affects this package: high ▼ security
- CVE-2026-41907 affects this package: high ▼ security
- CVE-2026-25528 affects this package: high ▼ security
- CVE-2025-9910 affects this package: high ▼ security
- CVE-2026-40190 affects this package: high ▼ security
- CVE-2026-45134 affects this package: high ▼ security
- CVE-2025-48985 affects this package: high ▼ security
- Known CVEs: unverified → fail ▼ security
- Install scripts: unverified → pass ▲ security
- Provenance: unverified → pass ▲ security
- Malware scan: unverified → pass ▲ security
- Stability: Stability not yet verified: we do not have a sandbox capture of the MCP schema this version of the package serves yet. security
- The attested source repository moved: sumup/sumup-agent-toolkit security
- Security disclosure: fail → unverified ▼ functional
- License: unverified → pass ▲ functional
- Maintenance: unverified → pass ▲ functional
- Dependency health: unverified → partial ▲ functional
- Capabilities: Protocol version not yet verified: we do not have a sandbox capture of the MCP handshake this version of the package performs yet. functional
- Tool coverage: Tool coverage not yet verified: we do not have a sandbox capture of the tool definitions this version of the package serves yet. functional
- Schema quality: Schema quality not yet verified: we do not have a sandbox capture of the MCP schema this version of the package serves yet. functional
- Licence: Apache-2.0 functional
- 1 Aug 26 0
- Stability: Stability not yet verified: our sandbox run of this package did not complete, so we have no schema to compare. security
- Security disclosure: unverified → fail ▼ functional
- Capabilities: Protocol version not yet verified: our sandbox run of this package did not complete, so we never saw its MCP handshake. functional
- Tool coverage: Tool coverage not yet verified: our sandbox run of this package did not complete, so we have no tool definitions to assess. functional
- Schema quality: Schema quality not yet verified: our sandbox run of this package did not complete, so we have no schema to assess. functional
- 31 Jul 26 0
- We updated how we score, so this day's move reflects our rubric, not a change to the server See what changed → functional
- 30 Jul 26 −18
- Malware scan: pass → unverified ▼ security
- Tool coverage: Tool coverage not yet verified: our sandbox run of this package did not complete, so we have no tool definitions to assess. functional
- Schema quality: Schema quality not yet verified: our sandbox run of this package did not complete, so we have no schema to assess. functional
- 28 Jul 26 0
- Schema quality: Schema quality not yet verified: we do not have a sandbox capture of the MCP schema this version of the package serves yet. functional
- Tool coverage: Tool coverage not yet verified: we do not have a sandbox capture of the tool definitions this version of the package serves yet. functional
- 27 Jul 26 18
First indexed and scored.
Diagnostic detail from the automated scan of this channel: what the scanner observed at each step, so you can see exactly where a check passed or failed. It is informational only and never changes the trust score.
Captured 7 Aug 2026 · Analysed npm/@sumup/[email protected]
Provenance Verified
A signed build attestation was found and verified, binding this exact artifact to the source repository it claims to come from.
| Result | Verified |
|---|---|
| Ecosystem | npm |
| Reason | Verified |
| Discovered via | Registry attestation endpoint |
| Source repo | sumup/sumup-agent-toolkit |
| Certificate issuer | https://token.actions.githubusercontent.com |
| Certificate SAN | https://github.com/sumup/sumup-agent-toolkit/.github/workflows/publish-mcp.yaml@refs/tags/mcp-v0.1.1 |
| Rekor log index | 660962568 |
| Predicate type | https://slsa.dev/provenance/v1 |
| Subject digest | sha512:81cc44852d6905019a1666f6244daf11e6b11ffb8d8ffe6607eebb3562e3fd08d3533439a2688551edf41b07338ff3cac415f6d22fb065c0deeefe49a |
Vulnerabilities 8 findings
| ID | CVE | Severity | Vector | Fix available |
|---|---|---|---|---|
| GHSA-866g-f22w-33x8 | CVE-2026-8769 | medium | CVSS:3.1/AV:N/AC:L/PR:L/UI:N/S:U/C:N/I:N/A:L | no |
| GHSA-rwvc-j5jr-mgvh | CVE-2025-48985 | low | CVSS:3.1/AV:N/AC:H/PR:N/UI:N/S:U/C:N/I:L/A:N | yes |
| GHSA-33vc-wfww-vjfv | CVE-2025-9910 | medium | CVSS:3.1/AV:N/AC:H/PR:N/UI:R/S:C/C:L/I:L/A:N | yes |
| GHSA-3644-q5cj-c5c7 | CVE-2026-45134 | high | CVSS:3.1/AV:N/AC:L/PR:N/UI:R/S:U/C:H/I:L/A:N | yes |
| GHSA-fw9q-39r9-c252 | CVE-2026-40190 | medium | CVSS:3.1/AV:N/AC:H/PR:N/UI:N/S:U/C:L/I:L/A:L | yes |
| GHSA-rr7j-v2q5-chgv | CVE-2026-41182 | medium | CVSS:3.1/AV:N/AC:L/PR:N/UI:N/S:U/C:L/I:N/A:N | yes |
| GHSA-v34v-rq6j-cj6p | CVE-2026-25528 | medium | CVSS:3.1/AV:N/AC:L/PR:N/UI:N/S:C/C:L/I:N/A:N | yes |
| GHSA-w5hq-g745-h8pq | CVE-2026-41907 | high | CVSS:3.1/AV:N/AC:L/PR:N/UI:N/S:U/C:N/I:H/A:N | yes |
Dependencies 167 packages
| Packages resolved | 167 |
|---|---|
| Deprecated | 154 |
| Stale | 46 |
| Tree resolution | Partial |
The dependency tree was only partially resolved, so these counts may be incomplete.
The tools this component advertises to a client, with an estimated token cost for each. Expand a tool to see its parameters and schema. The per-tool counts are indicative and are not scored directly; the schema's total context footprint is one signal in Schema Quality & AI Usability.
compat_get_operator ~21
Returns specific operator.
| Name | Type | Req | Description |
|---|---|---|---|
| operatorId | integer | yes | – |
No output schema declared.
No examples provided.
create_checkout ~509
Creates a new payment checkout resource. The unique `checkout_reference` created by this request, is used for further manipulation of the checkout. For 3DS checkouts, add the `redirect_url` parameter to your request body schema. Follow by processing a checkout to charge the provided payment instrument.
| Name | Type | Req | Description |
|---|---|---|---|
| amount | number | yes | Amount of the payment. |
| checkout_reference | string | yes | Unique ID of the payment checkout specified by the client application when creating the checkout resource. |
| currency | string | yes | Three-letter [ISO4217](https://en.wikipedia.org/wiki/ISO_4217) code of the currency for the amount. Currently supported currency values are enumerated above. |
| customer_id | string | – | Unique identification of a customer. If specified, the checkout session and payment instrument are associated with the referenced customer. |
| date | string | – | Date and time of the creation of the payment checkout. Response format expressed according to [ISO8601](https://en.wikipedia.org/wiki/ISO_8601) code. |
| description | string | – | Short description of the checkout visible in the SumUp dashboard. The description can contribute to reporting, allowing easier identification of a checkout. |
| id | string | – | Unique ID of the checkout resource. |
| merchant_code | string | yes | Unique identifying code of the merchant profile. |
| pay_to_email | string | – | Email address of the registered user (merchant) to whom the payment is made. |
| purpose | string | – | Purpose of the checkout. |
| redirect_url | string | – | __Required__ for [APMs](https://developer.sumup.com/online-payments/apm/introduction) and __recommended__ for card payments. Refers to a url where the end user is redirected once the payment processi… |
| return_url | string | – | URL to which the SumUp platform sends the processing status of the payment checkout. |
| status | string | – | Current status of the checkout. |
| transactions | array | – | List of transactions related to the payment. |
| valid_until | string | – | Date and time of the checkout expiration before which the client application needs to send a processing request. If no value is present, the checkout does not have an expiration time. |
No output schema declared.
No examples provided.
create_customer ~51
Creates a new saved customer resource which you can later manipulate and save payment instruments to.
| Name | Type | Req | Description |
|---|---|---|---|
| customer_id | string | yes | Unique ID of the customer. |
| personal_details | object | – | Personal details for the customer. |
No output schema declared.
No examples provided.
create_merchant_member ~257
Create a merchant member.
| Name | Type | Req | Description |
|---|---|---|---|
| attributes | object | – | Object attributes that modifiable only by SumUp applications. |
| string | yes | Email address of the member to add. | |
| is_managed_user | boolean | – | True if the user is managed by the merchant. In this case, we'll created a virtual user with the provided password and nickname. |
| is_service_account | boolean | – | True if the user is a service account. It can later be used to create OAuth2 clients. |
| merchantCode | string | yes | Merchant code. |
| metadata | object | – | Set of user-defined key-value pairs attached to the object. Partial updates are not supported. When updating, always submit whole metadata. |
| nickname | string | – | Nickname of the member to add. Only used if `is_managed_user` is true. Used for display purposes only. |
| password | string | – | Password of the member to add. Only used if `is_managed_user` is true. In the case of service accounts, the password is not used and can not be defined by the caller. |
| roles | array | yes | List of roles to assign to the new member. In the case of service accounts, the roles are predefined. |
No output schema declared.
No examples provided.
create_merchant_role ~116
Create a custom role for the merchant. Roles are defined by the set of permissions that they grant to the members that they are assigned to.
| Name | Type | Req | Description |
|---|---|---|---|
| description | string | – | User-defined description of the role. |
| merchantCode | string | yes | Merchant code. |
| metadata | object | – | Set of user-defined key-value pairs attached to the object. Partial updates are not supported. When updating, always submit whole metadata. |
| name | string | yes | User-defined name of the role. |
| permissions | array | yes | User's permissions. |
No output schema declared.
No examples provided.
create_reader ~116
Create a new Reader for the merchant account.
| Name | Type | Req | Description |
|---|---|---|---|
| merchantCode | string | yes | Unique identifier of the merchant account. |
| meta | object | – | Set of user-defined key-value pairs attached to the object. |
| name | string | – | Custom human-readable, user-defined name for easier identification of the reader. |
| pairing_code | string | yes | The pairing code is a 8 or 9 character alphanumeric string that is displayed on a SumUp Device after initiating the pairing. It is used to link the physical device to the created pairing. |
No output schema declared.
No examples provided.
create_reader_checkout ~384
Create a Checkout for a Reader. This process is asynchronous and the actual transaction may take some time to be stared on the device. There are some caveats when using this endpoint: * The target device must be online, otherwise checkout won't be accepted * After the checkout is accepted, the system has 60 seconds to start the payment on the target device. During this time, any other checkout for the same device will be rejected. **Note**: If the target device is a Solo, it must be in version 3.3.24.3 or higher.
| Name | Type | Req | Description |
|---|---|---|---|
| affiliate | object | – | Affiliate metadata for the transaction. It is an optional field that allow for integrators to track the source of the transaction. |
| card_type | string | – | The card type of the card used for the transaction. Is is required only for some countries (e.g: Brazil). |
| description | string | – | Description of the checkout to be shown in the Merchant Sales |
| id | string | yes | The unique identifier of the reader. |
| installments | integer | – | Number of installments for the transaction. It may vary according to the merchant country. For example, in Brazil, the maximum number of installments is 12. |
| merchantCode | string | yes | – |
| return_url | string | – | Webhook URL to which the payment result will be sent. It must be a HTTPS url. |
| tip_rates | array | – | List of tipping rates to be displayed to the cardholder. The rates are in percentage and should be between 0.01 and 0.99. The list should be sorted in ascending order. |
| total_amount | object | yes | Amount of the transaction. The amount is represented as an integer value altogether with the currency and the minor unit. For example, EUR 1.00 is represented as value 100 with minor unit of 2. |
No output schema declared.
No examples provided.
create_reader_terminate ~190
Create a Terminate action for a Reader. It stops the current transaction on the target device. This process is asynchronous and the actual termination may take some time to be performed on the device. There are some caveats when using this endpoint: * The target device must be online, otherwise terminate won't be accepted * The action will succeed only if the device is waiting for cardholder action: e.g: waiting for card, waiting for PIN, etc. * There is no confirmation of the termination. If a transaction is successfully terminated and `return_url` was provided on Checkout, the transaction status will be sent as `failed` to the provided URL. **Note**: If the target device is a Solo, it must be in version 3.3.28.0 or higher.
| Name | Type | Req | Description |
|---|---|---|---|
| id | string | yes | The unique identifier of the reader. |
| merchantCode | string | yes | – |
No output schema declared.
No examples provided.
create_sub_account ~47
Creates new operator for currently authorized users' merchant.
| Name | Type | Req | Description |
|---|---|---|---|
| nickname | string | – | – |
| password | string | yes | – |
| permissions | object | – | – |
| username | string | yes | – |
No output schema declared.
No examples provided.
deactivate_checkout ~43
Deactivates an identified checkout resource. If the checkout has already been processed it can not be deactivated.
| Name | Type | Req | Description |
|---|---|---|---|
| id | string | yes | Unique ID of the checkout resource. |
No output schema declared.
No examples provided.
deactivate_payment_instrument ~56
Deactivates an identified card payment instrument resource for a customer.
| Name | Type | Req | Description |
|---|---|---|---|
| customerId | string | yes | Unique ID of the saved customer resource. |
| token | string | yes | Unique token identifying the card saved as a payment instrument resource. |
No output schema declared.
No examples provided.
deactivate_sub_account ~19
undefined
| Name | Type | Req | Description |
|---|---|---|---|
| operatorId | integer | yes | – |
No output schema declared.
No examples provided.
delete_merchant_member ~40
Deletes a merchant member.
| Name | Type | Req | Description |
|---|---|---|---|
| memberId | string | yes | The ID of the member to retrieve. |
| merchantCode | string | yes | Merchant code. |
No output schema declared.
No examples provided.
delete_merchant_role ~40
Delete a custom role.
| Name | Type | Req | Description |
|---|---|---|---|
| merchantCode | string | yes | Merchant code. |
| roleId | string | yes | The ID of the role to retrieve. |
No output schema declared.
No examples provided.
delete_reader ~39
Delete a reader.
| Name | Type | Req | Description |
|---|---|---|---|
| id | string | yes | The unique identifier of the reader. |
| merchantCode | string | yes | Unique identifier of the merchant account. |
No output schema declared.
No examples provided.
get_account ~13
Returns user profile information.
Input schema present but exposes no named parameters.
No output schema declared.
No examples provided.
get_checkout ~45
Retrieves an identified checkout resource. Use this request after processing a checkout to confirm its status and inform the end user respectively.
| Name | Type | Req | Description |
|---|---|---|---|
| id | string | yes | Unique ID of the checkout resource. |
No output schema declared.
No examples provided.
get_customer ~43
Retrieves an identified saved customer resource through the unique `customer_id` parameter, generated upon customer creation.
| Name | Type | Req | Description |
|---|---|---|---|
| customerId | string | yes | Unique ID of the saved customer resource. |
No output schema declared.
No examples provided.
get_doing_business_as ~17
Retrieves Doing Business As profile.
Input schema present but exposes no named parameters.
No output schema declared.
No examples provided.
get_merchant_member ~40
Retrieve a merchant member.
| Name | Type | Req | Description |
|---|---|---|---|
| memberId | string | yes | The ID of the member to retrieve. |
| merchantCode | string | yes | Merchant code. |
No output schema declared.
No examples provided.
get_merchant_profile ~15
Retrieves merchant profile data.
Input schema present but exposes no named parameters.
No output schema declared.
No examples provided.
get_merchant_role ~42
Retrieve a custom role by ID.
| Name | Type | Req | Description |
|---|---|---|---|
| merchantCode | string | yes | Merchant code. |
| roleId | string | yes | The ID of the role to retrieve. |
No output schema declared.
No examples provided.
get_payment_methods ~86
Get payment methods available for the given merchant to use with a checkout.
| Name | Type | Req | Description |
|---|---|---|---|
| amount | number | – | The amount for which the payment methods should be eligible, in major units. Note that currency must also be provided when filtering by amount. |
| currency | string | – | The currency for which the payment methods should be eligible. |
| merchantCode | string | yes | The SumUp merchant code. |
No output schema declared.
No examples provided.
get_personal_profile ~15
Retrieves personal profile data.
Input schema present but exposes no named parameters.
No output schema declared.
No examples provided.
get_reader ~39
Retrieve a Reader.
| Name | Type | Req | Description |
|---|---|---|---|
| id | string | yes | The unique identifier of the reader. |
| merchantCode | string | yes | Unique identifier of the merchant account. |
No output schema declared.
No examples provided.
get_receipt ~68
Retrieves receipt specific data for a transaction.
| Name | Type | Req | Description |
|---|---|---|---|
| id | string | yes | SumUp unique transaction ID or transaction code, e.g. TS7HDYLSKD. |
| mid | string | yes | Merchant code. |
| tx_event_id | integer | – | The ID of the transaction event (refund). |
No output schema declared.
No examples provided.
get_settings ~12
Retrieves merchant settings.
Input schema present but exposes no named parameters.
No output schema declared.
No examples provided.
get_transaction ~139
Retrieves the full details of an identified transaction. The transaction resource is identified by a query parameter and *one* of following parameters is required: * `id` * `internal_id` * `transaction_code` * `foreign_transaction_id` * `client_transaction_id`
| Name | Type | Req | Description |
|---|---|---|---|
| id | string | – | Retrieves the transaction resource with the specified transaction ID (the `id` parameter in the transaction resource). |
| internal_id | string | – | Retrieves the transaction resource with the specified internal transaction ID (the `internal_id` parameter in the transaction resource). |
| transaction_code | string | – | Retrieves the transaction resource with the specified transaction code. |
No output schema declared.
No examples provided.
get_transaction_v2_1 ~151
Retrieves the full details of an identified transaction. The transaction resource is identified by a query parameter and *one* of following parameters is required: * `id` * `internal_id` * `transaction_code` * `foreign_transaction_id` * `client_transaction_id`
| Name | Type | Req | Description |
|---|---|---|---|
| id | string | – | Retrieves the transaction resource with the specified transaction ID (the `id` parameter in the transaction resource). |
| internal_id | string | – | Retrieves the transaction resource with the specified internal transaction ID (the `internal_id` parameter in the transaction resource). |
| merchantCode | string | yes | – |
| transaction_code | string | – | Retrieves the transaction resource with the specified transaction code. |
No output schema declared.
No examples provided.
list_bank_accounts ~40
Retrieves bank accounts of the merchant.
| Name | Type | Req | Description |
|---|---|---|---|
| primary | boolean | – | If true only the primary bank account (the one used for payouts) will be returned. |
No output schema declared.
No examples provided.
list_bank_accounts_v11 ~50
Retrieves bank accounts of the merchant.
| Name | Type | Req | Description |
|---|---|---|---|
| merchantCode | string | yes | – |
| primary | boolean | – | If true only the primary bank account (the one used for payouts) will be returned. |
No output schema declared.
No examples provided.
list_checkouts ~42
Lists created checkout resources according to the applied `checkout_reference`.
| Name | Type | Req | Description |
|---|---|---|---|
| checkout_reference | string | – | Filters the list of checkout resources by the unique ID of the checkout. |
No output schema declared.
No examples provided.
list_memberships ~55
List memberships of the current user.
| Name | Type | Req | Description |
|---|---|---|---|
| kind | string | – | Filter memberships by resource kind. |
| limit | integer | – | Maximum number of members to return. |
| offset | integer | – | Offset of the first member to return. |
No output schema declared.
No examples provided.
list_merchant_members ~106
Lists merchant members.
| Name | Type | Req | Description |
|---|---|---|---|
| string | – | Filter the returned members by email address prefix. | |
| limit | integer | – | Maximum number of members to return. |
| merchantCode | string | yes | Merchant code. |
| offset | integer | – | Offset of the first member to return. |
| roles | array | – | Filter the returned members by role. |
| scroll | boolean | – | Indicates to skip count query. |
| status | string | – | Filter the returned members by the membership status. |
No output schema declared.
No examples provided.
list_merchant_roles ~26
List merchant's custom roles.
| Name | Type | Req | Description |
|---|---|---|---|
| merchantCode | string | yes | Merchant code. |
No output schema declared.
No examples provided.
list_payment_instruments ~38
Lists all payment instrument resources that are saved for an identified customer.
| Name | Type | Req | Description |
|---|---|---|---|
| customerId | string | yes | Unique ID of the saved customer resource. |
No output schema declared.
No examples provided.
list_payouts ~99
Lists ordered payouts for the merchant profile.
| Name | Type | Req | Description |
|---|---|---|---|
| end_date | string | yes | End date (in [ISO8601](https://en.wikipedia.org/wiki/ISO_8601) format). |
| format | string | – | – |
| limit | integer | – | – |
| order | string | – | – |
| start_date | string | yes | Start date (in [ISO8601](https://en.wikipedia.org/wiki/ISO_8601) format). |
No output schema declared.
No examples provided.
list_payouts_v1 ~109
Lists ordered payouts for the merchant profile.
| Name | Type | Req | Description |
|---|---|---|---|
| end_date | string | yes | End date (in [ISO8601](https://en.wikipedia.org/wiki/ISO_8601) format). |
| format | string | – | – |
| limit | integer | – | – |
| merchantCode | string | yes | – |
| order | string | – | – |
| start_date | string | yes | Start date (in [ISO8601](https://en.wikipedia.org/wiki/ISO_8601) format). |
No output schema declared.
No examples provided.
list_readers ~30
List all readers of the merchant.
| Name | Type | Req | Description |
|---|---|---|---|
| merchantCode | string | yes | Unique identifier of the merchant account. |
No output schema declared.
No examples provided.
list_sub_accounts ~80
Returns list of operators for currently authorized user's merchant.
| Name | Type | Req | Description |
|---|---|---|---|
| include_primary | boolean | – | If true the list of operators will include also the primary user. |
| query | string | – | Search query used to filter users that match given query term. Current implementation allow querying only over the email address. All operators whos email address contains the query string are retur… |
No output schema declared.
No examples provided.
list_transactions ~426
Lists detailed history of all transactions associated with the merchant profile.
| Name | Type | Req | Description |
|---|---|---|---|
| changes_since | string | – | Filters the results by the latest modification time of resources and returns only transactions that are modified *at or after* the specified timestamp (in [ISO8601](https://en.wikipedia.org/wiki/ISO_… |
| limit | integer | – | Specifies the maximum number of results per page. Value must be a positive integer and if not specified, will return 10 results. |
| newest_ref | string | – | Filters the results by the reference ID of transaction events and returns only transactions with events whose IDs are *smaller* than the specified value. This parameters supersedes the `newest_time`… |
| newest_time | string | – | Filters the results by the creation time of resources and returns only transactions that are created *before* the specified timestamp (in [ISO8601](https://en.wikipedia.org/wiki/ISO_8601) format). |
| oldest_ref | string | – | Filters the results by the reference ID of transaction events and returns only transactions with events whose IDs are *greater* than the specified value. This parameters supersedes the `oldest_time`… |
| oldest_time | string | – | Filters the results by the creation time of resources and returns only transactions that are created *at or after* the specified timestamp (in [ISO8601](https://en.wikipedia.org/wiki/ISO_8601) format… |
| order | string | – | Specifies the order in which the returned results are displayed. |
| payment_types | array | – | Filters the returned results by the specified list of payment types used for the transactions. |
| statuses | array | – | Filters the returned results by the specified list of final statuses of the transactions. |
| transaction_code | string | – | Retrieves the transaction resource with the specified transaction code. |
| types | array | – | Filters the returned results by the specified list of transaction types. |
| users | array | – | Filters the returned results by user email. |
No output schema declared.
No examples provided.
list_transactions_v2_1 ~438
Lists detailed history of all transactions associated with the merchant profile.
| Name | Type | Req | Description |
|---|---|---|---|
| changes_since | string | – | Filters the results by the latest modification time of resources and returns only transactions that are modified *at or after* the specified timestamp (in [ISO8601](https://en.wikipedia.org/wiki/ISO_… |
| limit | integer | – | Specifies the maximum number of results per page. Value must be a positive integer and if not specified, will return 10 results. |
| merchantCode | string | yes | – |
| newest_ref | string | – | Filters the results by the reference ID of transaction events and returns only transactions with events whose IDs are *smaller* than the specified value. This parameters supersedes the `newest_time`… |
| newest_time | string | – | Filters the results by the creation time of resources and returns only transactions that are created *before* the specified timestamp (in [ISO8601](https://en.wikipedia.org/wiki/ISO_8601) format). |
| oldest_ref | string | – | Filters the results by the reference ID of transaction events and returns only transactions with events whose IDs are *greater* than the specified value. This parameters supersedes the `oldest_time`… |
| oldest_time | string | – | Filters the results by the creation time of resources and returns only transactions that are created *at or after* the specified timestamp (in [ISO8601](https://en.wikipedia.org/wiki/ISO_8601) format… |
| order | string | – | Specifies the order in which the returned results are displayed. |
| payment_types | array | – | Filters the returned results by the specified list of payment types used for the transactions. |
| statuses | array | – | Filters the returned results by the specified list of final statuses of the transactions. |
| transaction_code | string | – | Retrieves the transaction resource with the specified transaction code. |
| types | array | – | Filters the returned results by the specified list of transaction types. |
| users | array | – | Filters the returned results by user email. |
No output schema declared.
No examples provided.
process_checkout ~208
Processing a checkout will attempt to charge the provided payment instrument for the amount of the specified checkout resource initiated in the `Create a checkout` endpoint. Follow this request with `Retrieve a checkout` to confirm its status.
| Name | Type | Req | Description |
|---|---|---|---|
| card | object | – | __Required when payment type is `card`.__ Details of the payment card. |
| customer_id | string | – | __Required when `token` is provided.__ Unique ID of the customer. |
| id | string | yes | Unique ID of the checkout resource. |
| installments | integer | – | Number of installments for deferred payments. Available only to merchant users in Brazil. |
| mandate | object | – | Mandate is passed when a card is to be tokenized |
| payment_type | string | yes | Describes the payment method used to attempt processing |
| personal_details | object | – | Personal details for the customer. |
| token | string | – | __Required when using a tokenized card to process a checkout.__ Unique token identifying the saved payment card for a customer. |
No output schema declared.
No examples provided.
refund_transaction ~78
Refunds an identified transaction either in full or partially.
| Name | Type | Req | Description |
|---|---|---|---|
| amount | number | – | Amount to be refunded. Eligible amount can't exceed the amount of the transaction and varies based on country and currency. If you do not specify a value, the system performs a full refund of the tra… |
| txnId | string | yes | Unique ID of the transaction. |
No output schema declared.
No examples provided.
update_customer ~69
Updates an identified saved customer resource's personal details. The request only overwrites the parameters included in the request, all other parameters will remain with their initially assigned values.
| Name | Type | Req | Description |
|---|---|---|---|
| customerId | string | yes | Unique ID of the saved customer resource. |
| personal_details | object | – | Personal details for the customer. |
No output schema declared.
No examples provided.
update_merchant_member ~112
Update the merchant member.
| Name | Type | Req | Description |
|---|---|---|---|
| attributes | object | – | Object attributes that modifiable only by SumUp applications. |
| memberId | string | yes | The ID of the member to retrieve. |
| merchantCode | string | yes | Merchant code. |
| metadata | object | – | Set of user-defined key-value pairs attached to the object. Partial updates are not supported. When updating, always submit whole metadata. |
| roles | array | – | – |
| user | object | – | Allows you to update user data of managed users. |
No output schema declared.
No examples provided.
update_merchant_role ~76
Update a custom role.
| Name | Type | Req | Description |
|---|---|---|---|
| description | string | – | User-defined description of the role. |
| merchantCode | string | yes | Merchant code. |
| name | string | – | User-defined name of the role. |
| permissions | array | – | User's permissions. |
| roleId | string | yes | The ID of the role to retrieve. |
No output schema declared.
No examples provided.
update_reader ~77
Update a Reader.
| Name | Type | Req | Description |
|---|---|---|---|
| id | string | yes | The unique identifier of the reader. |
| merchantCode | string | yes | Unique identifier of the merchant account. |
| meta | object | – | Set of user-defined key-value pairs attached to the object. |
| name | string | – | Custom human-readable, user-defined name for easier identification of the reader. |
No output schema declared.
No examples provided.
update_sub_account ~71
Updates operator. If the operator was disabled and their password is updated they will be unblocked.
| Name | Type | Req | Description |
|---|---|---|---|
| disabled | boolean | – | – |
| nickname | string | – | – |
| operatorId | integer | yes | – |
| password | string | – | – |
| permissions | object | – | – |
| username | string | – | – |
No output schema declared.
No examples provided.