Skip to content

chore: synced file(s) with sumup/apis #111

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
matoous merged 3 commits into from
Nov 17, 2025
Merged

chore: synced file(s) with sumup/apis #111

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
27f7ccc
chore: synced local 'openapi.json' with remote 'specs/openapi.json'
Nov 17, 2025
4794eb7
chore: synced local 'openapi.yaml' with remote 'specs/openapi.yaml'
Nov 17, 2025
9f6f221
chore: generate code
sumup-bot[bot] Nov 17, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
167 changes: 42 additions & 125 deletions openapi.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@
"required": true,
"schema": {
"type": "string",
"example": "M1234"
"example": "MH4H92C7"
}
},
{
Expand Down Expand Up @@ -196,7 +196,7 @@
"checkout_reference": "f00a8f74-b05d-4605-bd73-2a901bae5802",
"amount": 10.1,
"currency": "EUR",
"merchant_code": "MDUDGLR9",
"merchant_code": "MH4H92C7",
"description": "Purchase",
"id": "2b79757a-de87-4a2e-90e4-b17c947c730d",
"status": "PAID",
Expand Down Expand Up @@ -247,7 +247,7 @@
"checkout_reference": "8ea25ec3-3293-40e9-a165-6d7f3b3073c5",
"amount": 10.1,
"currency": "EUR",
"merchant_code": "MCNPLE22",
"merchant_code": "MH4H92C7",
"merchant_country": "DE",
"description": "My Checkout",
"return_url": "http://example.com",
Expand All @@ -259,7 +259,7 @@
"mandate": {
"type": "recurrent",
"status": "active",
"merchant_code": "MDASYTPD"
"merchant_code": "MH4H92C7"
},
"transactions": [
{
Expand Down Expand Up @@ -321,7 +321,7 @@
"checkout_reference": "8ea25ec3-3293-40e9-a165-6d7f3b3073c5",
"amount": 10.1,
"currency": "EUR",
"merchant_code": "MCNPLE22",
"merchant_code": "MH4H92C7",
"description": "My Checkout",
"return_url": "http://example.com",
"id": "88fcf8de-304d-4820-8f1c-ec880290eb92",
Expand Down Expand Up @@ -772,7 +772,7 @@
"mandate": {
"type": "recurrent",
"status": "active",
"merchant_code": "MDASYTPD"
"merchant_code": "MH4H92C7"
},
"transactions": [
{
Expand Down Expand Up @@ -1071,110 +1071,21 @@
"content": {
"application/json": {
"schema": {
"description": "Details of the deleted checkout.",
"type": "object",
"properties": {
"checkout_reference": {
"description": "Unique ID of the payment checkout specified by the client application when creating the checkout resource.",
"type": "string",
"maxLength": 90
},
"id": {
"description": "Unique ID of the checkout resource.",
"type": "string",
"readOnly": true
},
"amount": {
"description": "Amount of the payment.",
"type": "number",
"format": "float"
},
"currency": {
"$ref": "#/components/schemas/Currency"
},
"merchant_code": {
"description": "Unique identifying code of the merchant profile.",
"type": "string"
},
"description": {
"description": "Short description of the checkout visible in the SumUp dashboard. The description can contribute to reporting, allowing easier identification of a checkout.",
"type": "string"
},
"purpose": {
"description": "Purpose of the checkout creation initially",
"type": "string",
"enum": [
"SETUP_RECURRING_PAYMENT",
"CHECKOUT"
]
},
"status": {
"description": "Current status of the checkout.",
"type": "string",
"enum": [
"EXPIRED"
],
"readOnly": true
},
"date": {
"description": "Date and time of the creation of the payment checkout. Response format expressed according to [ISO8601](https://en.wikipedia.org/wiki/ISO_8601) code.",
"type": "string",
"format": "date-time",
"example": "2020-02-29T10:56:56+00:00",
"readOnly": true
},
"valid_until": {
"description": "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.",
"type": "string",
"format": "date-time",
"example": "2020-02-29T10:56:56+00:00",
"nullable": true,
"readOnly": true
},
"merchant_name": {
"description": "Merchant name",
"type": "string"
},
"merchant_country": {
"description": "The merchant's country",
"type": "string"
},
"transactions": {
"description": "List of transactions related to the payment.",
"type": "array",
"items": {
"allOf": [
{
"$ref": "#/components/schemas/TransactionMixinBase"
},
{
"$ref": "#/components/schemas/TransactionMixinCheckout"
}
]
},
"readOnly": true,
"uniqueItems": true
}
}
"$ref": "#/components/schemas/Checkout"
},
"examples": {
"DeletedCheckout": {
"description": "Response body for a successfully deactivated checkout",
"value": {
"checkout_reference": "f00a8f74-b05d-4605-bd73-2a901bae5802",
"id": "817340ce-f1d9-4609-b90a-6152f8ee267j",
"amount": 2,
"currency": "EUR",
"merchant_code": "MH4H92C7",
"description": "Deletion example",
"purpose": "CHECKOUT",
"status": "EXPIRED",
"date": "2020-02-29T10:56:56+00:00",
"valid_until": "2020-02-29T10:56:56+00:00",
"merchant_name": "Sample Merchant",
"transactions": []
}
}
"example": {
"checkout_reference": "f00a8f74-b05d-4605-bd73-2a901bae5802",
"id": "817340ce-f1d9-4609-b90a-6152f8ee267j",
"amount": 2,
"currency": "EUR",
"merchant_code": "MH4H92C7",
"description": "Deletion example",
"purpose": "CHECKOUT",
"status": "EXPIRED",
"date": "2020-02-29T10:56:56+00:00",
"valid_until": "2020-02-29T10:56:56+00:00",
"merchant_name": "Sample Merchant",
"transactions": []
}
}
}
Expand Down Expand Up @@ -1993,7 +1904,7 @@
"required": true,
"schema": {
"type": "string",
"example": "MC0X0ABC"
"example": "MH4H92C7"
}
},
{
Expand Down Expand Up @@ -2257,7 +2168,7 @@
"required": true,
"schema": {
"type": "string",
"example": "MC0X0ABC"
"example": "MH4H92C7"
}
},
{
Expand Down Expand Up @@ -2833,7 +2744,7 @@
"required": true,
"schema": {
"type": "string",
"example": "MC0X0ABC"
"example": "MH4H92C7"
}
},
{
Expand Down Expand Up @@ -6507,7 +6418,8 @@
},
"merchant_code": {
"description": "Unique identifying code of the merchant profile.",
"type": "string"
"type": "string",
"example": "MH4H92C7"
},
"description": {
"description": "Short description of the checkout visible in the SumUp dashboard. The description can contribute to reporting, allowing easier identification of a checkout.",
Expand Down Expand Up @@ -6591,7 +6503,8 @@
},
"merchant_code": {
"description": "Unique identifying code of the merchant profile.",
"type": "string"
"type": "string",
"example": "MH4H92C7"
},
"description": {
"description": "Short description of the checkout visible in the SumUp dashboard. The description can contribute to reporting, allowing easier identification of a checkout.",
Expand Down Expand Up @@ -7169,13 +7082,14 @@
},
"merchant_code": {
"description": "Merchant code which has the mandate",
"type": "string"
"type": "string",
"example": "MH4H92C7"
}
},
"example": {
"type": "recurrent",
"status": "active",
"merchant_code": "MDASYTPD"
"merchant_code": "MH4H92C7"
}
},
"MerchantAccount": {
Expand Down Expand Up @@ -7206,7 +7120,8 @@
"properties": {
"merchant_code": {
"description": "Unique identifying code of the merchant profile",
"type": "string"
"type": "string",
"example": "MH4H92C7"
},
"company_name": {
"description": "Company name",
Expand Down Expand Up @@ -7415,7 +7330,7 @@
"mandate": {
"type": "recurrent",
"status": "active",
"merchant_code": "MDASYTPD"
"merchant_code": "MH4H92C7"
},
"card": {
"last_4_digits": "0001",
Expand Down Expand Up @@ -7643,7 +7558,8 @@
"type": "object",
"properties": {
"merchant_code": {
"type": "string"
"type": "string",
"example": "MH4H92C7"
},
"business_name": {
"type": "string"
Expand Down Expand Up @@ -7907,7 +7823,8 @@
"enum": [
"ECOM",
"RECURRING",
"BOLETO"
"BOLETO",
"POS"
]
},
"installments_count": {
Expand Down Expand Up @@ -10517,7 +10434,7 @@
"checkout_reference": "f00a8f74-b05d-4605-bd73-2a901bae5802",
"amount": 10.1,
"currency": "EUR",
"merchant_code": "MDUDGLR9",
"merchant_code": "MH4H92C7",
"description": "Purchase",
"id": "2b79757a-de87-4a2e-90e4-b17c947c730d",
"status": "PAID",
Expand Down Expand Up @@ -10745,7 +10662,7 @@
"checkout_reference": "8ea25ec3-3293-40e9-a165-6d7f3b3073c5",
"amount": 10.1,
"currency": "EUR",
"merchant_code": "MCNPLE22",
"merchant_code": "MH4H92C7",
"merchant_country": "DE",
"description": "My Checkout",
"return_url": "http://example.com",
Expand All @@ -10757,7 +10674,7 @@
"mandate": {
"type": "recurrent",
"status": "active",
"merchant_code": "MDASYTPD"
"merchant_code": "MH4H92C7"
},
"transactions": [
{
Expand Down Expand Up @@ -10819,7 +10736,7 @@
"checkout_reference": "8ea25ec3-3293-40e9-a165-6d7f3b3073c5",
"amount": 10.1,
"currency": "EUR",
"merchant_code": "MCNPLE22",
"merchant_code": "MH4H92C7",
"description": "My Checkout",
"return_url": "http://example.com",
"id": "88fcf8de-304d-4820-8f1c-ec880290eb92",
Expand Down Expand Up @@ -10901,7 +10818,7 @@
"mandate": {
"type": "recurrent",
"status": "active",
"merchant_code": "MDASYTPD"
"merchant_code": "MH4H92C7"
},
"transactions": [
{
Expand Down
Loading
Loading