{"openapi":"3.1.0","info":{"title":"SumUp (BYOK) API","version":"0.1.0","description":"SumUp (BYOK) lets an AI assistant read your own SumUp data through the SumUp API with a key you supply (SumUp API key (starts with sup_sk_)). Read-only: 9 tools (list_memberships, get_merchant, list_transactions, get_transaction, list_payouts, list_checkouts, get_checkout, list_readers, list_payment_methods). The BYOK key travels with each request, is used for that one call only and is never...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-sumup.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-sumup/docs"},"termsOfService":"https://connectorbay.com/byok-sumup/terms"},"servers":[{"url":"https://byok-sumup.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-sumup/docs"},"security":[{"upstreamKey":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","description":"Optional. A Pro API key raises rate limits; no credentials are required."},"upstreamKey":{"type":"apiKey","in":"header","name":"X-Upstream-Key","description":"Your own key for the service this connector wraps (bring your own key). Used for that one call only; never stored, logged or cached."}},"schemas":{"Error":{"type":"object","properties":{"ok":{"const":false},"error":{"type":"object"}}}}},"paths":{"/v1/tools/list_memberships":{"post":{"operationId":"list_memberships","summary":"List the accounts the key's user belongs to; the membership with resource type merchant shows your merchant code as reso","description":"List the accounts the key's user belongs to; the membership with resource type merchant shows your merchant code as resource.id. Use for \"What is my SumUp merchant code\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":10,"description":"Number of memberships (1 to 100).","title":"Limit"},"offset":{"anyOf":[{"maximum":10000,"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"Number of memberships to skip.","title":"Offset"},"status":{"anyOf":[{"enum":["accepted","pending","expired","disabled","unknown"],"type":"string"},{"type":"null"}],"default":null,"description":"Only this membership status.","title":"Status"},"resource_type":{"anyOf":[{"maxLength":40,"type":"string"},{"type":"null"}],"default":null,"description":"Only memberships of this resource type, for example merchant.","title":"Resource Type"}},"title":"list_membershipsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_merchant":{"post":{"operationId":"get_merchant","summary":"Get the merchant profile: code, business type, country, default currency and locale, company name, business name, websit","description":"Get the merchant profile: code, business type, country, default currency and locale, company name, business name, website and sandbox flag. Use for \"What is my SumUp merchant's country and default currency\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"merchant_code":{"description":"Your merchant code (for example MH4H92C7); list_memberships shows it as resource.id of the merchant membership.","maxLength":200,"title":"Merchant Code","type":"string"}},"required":["merchant_code"],"title":"get_merchantArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_transactions":{"post":{"operationId":"list_transactions","summary":"List the merchant's transactions with amount, currency, status, payment type, card type, payout info and refunds; filter","description":"List the merchant's transactions with amount, currency, status, payment type, card type, payout info and refunds; filter by status, type, payment type and dates. Newer pages come from the links entry. Use for \"Show my last 20 SumUp card payments\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"merchant_code":{"description":"Your merchant code (for example MH4H92C7); list_memberships shows it as resource.id of the merchant membership.","maxLength":200,"title":"Merchant Code","type":"string"},"limit":{"anyOf":[{"maximum":1000,"minimum":1,"type":"integer"},{"type":"null"}],"default":null,"description":"Number of transactions per page (1 to 1000; the API default is 10).","title":"Limit"},"order":{"anyOf":[{"enum":["ascending","descending"],"type":"string"},{"type":"null"}],"default":null,"description":"ascending or descending by time (the API default is ascending).","title":"Order"},"status":{"anyOf":[{"maxLength":30,"type":"string"},{"type":"null"}],"default":null,"description":"Only this final status, for example SUCCESSFUL, FAILED, REFUNDED or CANCELLED.","title":"Status"},"payment_type":{"anyOf":[{"maxLength":30,"type":"string"},{"type":"null"}],"default":null,"description":"Only this payment type, for example CASH, POS or ECOM.","title":"Payment Type"},"type":{"anyOf":[{"maxLength":30,"type":"string"},{"type":"null"}],"default":null,"description":"Only this transaction type, for example PAYMENT or REFUND.","title":"Type"},"oldest_time":{"anyOf":[{"maxLength":40,"type":"string"},{"type":"null"}],"default":null,"description":"Only transactions created at or after this time. ISO 8601 date-time such as 2026-09-01T00:00:00Z.","title":"Oldest Time"},"newest_time":{"anyOf":[{"maxLength":40,"type":"string"},{"type":"null"}],"default":null,"description":"Only transactions created before this time. ISO 8601 date-time such as 2026-09-01T00:00:00Z.","title":"Newest Time"},"changes_since":{"anyOf":[{"maxLength":40,"type":"string"},{"type":"null"}],"default":null,"description":"Only transactions modified at or after this time. ISO 8601 date-time such as 2026-09-01T00:00:00Z.","title":"Changes Since"},"oldest_ref":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Pagination reference from a links entry: results after it.","title":"Oldest Ref"},"newest_ref":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Pagination reference from a links entry: results before it.","title":"Newest Ref"}},"required":["merchant_code"],"title":"list_transactionsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_transaction":{"post":{"operationId":"get_transaction","summary":"Get one transaction by its id or transaction code with amount, fees, tip, VAT, status, payment type, entry mode, payout ","description":"Get one transaction by its id or transaction code with amount, fees, tip, VAT, status, payment type, entry mode, payout dates and refunds. Use for \"Show SumUp transaction TEENSK4W2K\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"merchant_code":{"description":"Your merchant code (for example MH4H92C7); list_memberships shows it as resource.id of the merchant membership.","maxLength":200,"title":"Merchant Code","type":"string"},"transaction_code":{"anyOf":[{"maxLength":40,"type":"string"},{"type":"null"}],"default":null,"description":"Transaction code such as TEENSK4W2K.","title":"Transaction Code"},"id":{"anyOf":[{"maxLength":60,"type":"string"},{"type":"null"}],"default":null,"description":"Transaction id (UUID).","title":"Id"}},"required":["merchant_code"],"title":"get_transactionArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_payouts":{"post":{"operationId":"list_payouts","summary":"List payouts and payout deductions between two dates with amount, fee, status, reference and the related transaction cod","description":"List payouts and payout deductions between two dates with amount, fee, status, reference and the related transaction code. Use for \"What did SumUp pay out to me in September\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"merchant_code":{"description":"Your merchant code (for example MH4H92C7); list_memberships shows it as resource.id of the merchant membership.","maxLength":200,"title":"Merchant Code","type":"string"},"start_date":{"description":"First day, inclusive, YYYY-MM-DD.","maxLength":10,"title":"Start Date","type":"string"},"end_date":{"description":"Last day, inclusive, YYYY-MM-DD.","maxLength":10,"title":"End Date","type":"string"},"limit":{"anyOf":[{"maximum":1000,"minimum":1,"type":"integer"},{"type":"null"}],"default":null,"description":"Maximum payouts to return (1 to 1000).","title":"Limit"},"order":{"anyOf":[{"enum":["asc","desc"],"type":"string"},{"type":"null"}],"default":null,"description":"asc or desc by date (the API default is asc).","title":"Order"}},"required":["merchant_code","start_date","end_date"],"title":"list_payoutsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_checkouts":{"post":{"operationId":"list_checkouts","summary":"List online checkouts, optionally only those with a given checkout reference, with amount, currency, status, dates and l","description":"List online checkouts, optionally only those with a given checkout reference, with amount, currency, status, dates and linked transaction code. Use for \"Which SumUp checkouts have the reference order-1001\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"checkout_reference":{"anyOf":[{"maxLength":90,"type":"string"},{"type":"null"}],"default":null,"description":"Only checkouts created with this merchant-defined reference.","title":"Checkout Reference"}},"title":"list_checkoutsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_checkout":{"post":{"operationId":"get_checkout","summary":"Get one checkout by id with amount, currency, status, reference, dates and the linked transaction code. Use for \"Is SumU","description":"Get one checkout by id with amount, currency, status, reference, dates and the linked transaction code. Use for \"Is SumUp checkout 88df3898-1a5c-4c4d-9b19-2a66a1a3ad08 paid\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"checkout_id":{"description":"Checkout id (UUID) from list_checkouts.","maxLength":200,"title":"Checkout Id","type":"string"}},"required":["checkout_id"],"title":"get_checkoutArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_readers":{"post":{"operationId":"list_readers","summary":"List the card readers paired with the merchant with name, status, model and creation dates. Use for \"Which card readers ","description":"List the card readers paired with the merchant with name, status, model and creation dates. Use for \"Which card readers are paired with my SumUp account\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"merchant_code":{"description":"Your merchant code (for example MH4H92C7); list_memberships shows it as resource.id of the merchant membership.","maxLength":200,"title":"Merchant Code","type":"string"}},"required":["merchant_code"],"title":"list_readersArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_payment_methods":{"post":{"operationId":"list_payment_methods","summary":"List the payment methods available to the merchant for checkouts, optionally for an amount and currency. Use for \"Which ","description":"List the payment methods available to the merchant for checkouts, optionally for an amount and currency. Use for \"Which payment methods can I offer for a 25 EUR SumUp checkout\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"merchant_code":{"description":"Your merchant code (for example MH4H92C7); list_memberships shows it as resource.id of the merchant membership.","maxLength":200,"title":"Merchant Code","type":"string"},"amount":{"anyOf":[{"maximum":1000000,"minimum":0,"type":"number"},{"type":"null"}],"default":null,"description":"Amount to check eligibility for.","title":"Amount"},"currency":{"anyOf":[{"maxLength":3,"type":"string"},{"type":"null"}],"default":null,"description":"ISO 4217 currency code such as EUR.","title":"Currency"}},"required":["merchant_code"],"title":"list_payment_methodsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}}}}