Skip to content

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

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
Jul 12, 2025
Merged

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

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
a81b5e8
chore: synced local 'openapi.json' with remote 'specs/openapi.json'
Jul 12, 2025
455ad51
chore: synced local 'openapi.yaml' with remote 'specs/openapi.yaml'
Jul 12, 2025
8e3fe87
chore: generate latest code
matoous Jul 12, 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
83 changes: 44 additions & 39 deletions openapi.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1092,13 +1092,6 @@
"currency": {
"$ref": "#/components/schemas/Currency"
},
"pay_to_email": {
"description": "Email address of the registered user (merchant) to whom the payment is made.",
"type": "string",
"format": "email",
"deprecated": true,
"x-deprecation-notice": "`pay_to_email` is deprecated, use `merchant_code` instead."
},
"merchant_code": {
"description": "Unique identifying code of the merchant profile.",
"type": "string"
Expand Down Expand Up @@ -2029,6 +2022,22 @@
"schema": {
"type": "string"
}
},
{
"name": "foreign_transaction_id",
"in": "query",
"description": "External/foreign transaction id (passed by clients).",
"schema": {
"type": "string"
}
},
{
"name": "client_transaction_id",
"in": "query",
"description": "Client transaction id.",
"schema": {
"type": "string"
}
}
],
"responses": {
Expand Down Expand Up @@ -4147,7 +4156,7 @@
{
"name": "query",
"in": "query",
"description": "Search query used to filter users that match given query term.\n\nCurrent implementation allow querying only over the email address.\nAll operators whos email address contains the query string are returned.\n",
"description": "Search query used to filter users that match given query term.\n\nCurrent implementation allow querying only over the email address.\nAll operators whos email address contains the query string are returned.",
"schema": {
"type": "string"
}
Expand Down Expand Up @@ -4257,7 +4266,7 @@
}
},
"403": {
"description": "error response for compat API calls",
"description": "Error response for compat API calls.",
"content": {
"application/json": {
"schema": {
Expand Down Expand Up @@ -4295,6 +4304,7 @@
{
"name": "operator_id",
"in": "path",
"description": "The unique identifier for the operator.",
"required": true,
"schema": {
"type": "integer",
Expand All @@ -4304,7 +4314,7 @@
],
"responses": {
"200": {
"description": "Operator.",
"description": "Information about the requested operator.",
"content": {
"application/json": {
"schema": {
Expand Down Expand Up @@ -4340,6 +4350,7 @@
{
"name": "operator_id",
"in": "path",
"description": "The unique identifier for the operator.",
"required": true,
"schema": {
"type": "integer",
Expand Down Expand Up @@ -4435,11 +4446,13 @@
},
"delete": {
"operationId": "DeactivateSubAccount",
"summary": "Disable an operator",
"summary": "Disable an operator.",
"description": "Disable the specified operator for the merchant account.",
"parameters": [
{
"name": "operator_id",
"in": "path",
"description": "The unique identifier for the operator.",
"required": true,
"schema": {
"type": "integer",
Expand Down Expand Up @@ -4526,6 +4539,14 @@
"schema": {
"type": "boolean"
}
},
{
"name": "resource.name",
"in": "query",
"description": "Filter memberships by the name of the resource the membership is in.",
"schema": {
"type": "string"
}
}
],
"responses": {
Expand Down Expand Up @@ -5610,14 +5631,14 @@
"parameters": {
"id": "$response.body#/id"
},
"description": "Update the reader object. This can be used to set a name after using this endpoint to verify the pairing code.\n"
"description": "Update the reader object. This can be used to set a name after using this endpoint to verify the pairing code."
},
"DeleteReaderByID": {
"operationId": "DeleteReader",
"parameters": {
"id": "$response.body#/id"
},
"description": "Delete the reader.\n"
"description": "Delete the reader."
}
}
}
Expand Down Expand Up @@ -5699,7 +5720,7 @@
],
"responses": {
"200": {
"description": "Returns a Reader object for a valid identifier.\n",
"description": "Returns a Reader object for a valid identifier.",
"content": {
"application/json": {
"schema": {
Expand All @@ -5708,11 +5729,8 @@
}
}
},
"400": {
"description": "Malformed request."
},
"404": {
"description": "The requested Reader resource does not exists.\n"
"description": "The requested Reader resource does not exists."
}
},
"security": [
Expand Down Expand Up @@ -6553,13 +6571,6 @@
"currency": {
"$ref": "#/components/schemas/Currency"
},
"pay_to_email": {
"description": "Email address of the registered user (merchant) to whom the payment is made.",
"type": "string",
"format": "email",
"deprecated": true,
"x-deprecation-notice": "`pay_to_email` is deprecated, use `merchant_code` instead."
},
"merchant_code": {
"description": "Unique identifying code of the merchant profile.",
"type": "string"
Expand Down Expand Up @@ -6648,13 +6659,6 @@
"description": "Unique identifying code of the merchant profile.",
"type": "string"
},
"pay_to_email": {
"description": "Email address of the registered user (merchant) to whom the payment is made.",
"type": "string",
"format": "email",
"deprecated": true,
"x-deprecation-notice": "`pay_to_email` is deprecated, use `merchant_code` instead."
},
"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"
Expand Down Expand Up @@ -8528,6 +8532,7 @@
"format": "date-time"
},
"Operator": {
"description": "Operator account for a merchant.",
"type": "object",
"properties": {
"id": {
Expand Down Expand Up @@ -8579,7 +8584,7 @@
]
},
"CompatError": {
"description": "Error",
"description": "Error object for compat API calls.",
"type": "object",
"properties": {
"error_code": {
Expand Down Expand Up @@ -9097,7 +9102,7 @@
"maxLength": 500
},
"ReaderStatus": {
"description": "The status of the reader object gives information about the current state of the reader.\n\nPossible values:\n\n- `unknown` - The reader status is unknown.\n- `processing` - The reader is created and waits for the physical device to confirm the pairing.\n- `paired` - The reader is paired with a merchant account and can be used with SumUp APIs.\n- `expired` - The pairing is expired and no longer usable with the account. The resource needs to get recreated",
"description": "The status of the reader object gives information about the current state of the reader.\n\nPossible values:\n\n- `unknown` - The reader status is unknown.\n- `processing` - The reader is created and waits for the physical device to confirm the pairing.\n- `paired` - The reader is paired with a merchant account and can be used with SumUp APIs.\n- `expired` - The pairing is expired and no longer usable with the account. The resource needs to get recreated.",
"type": "string",
"example": "paired",
"enum": [
Expand All @@ -9108,7 +9113,7 @@
]
},
"ReaderDevice": {
"description": "Information about the underlying physical device.\n",
"description": "Information about the underlying physical device.",
"type": "object",
"properties": {
"identifier": {
Expand Down Expand Up @@ -9517,14 +9522,14 @@
"parameters": {
"id": "$response.body#/id"
},
"description": "Update the reader object. This can be used to set a name after using this endpoint to verify the pairing code.\n"
"description": "Update the reader object. This can be used to set a name after using this endpoint to verify the pairing code."
},
"DeleteReaderByID": {
"operationId": "DeleteReader",
"parameters": {
"id": "$response.body#/id"
},
"description": "Delete the reader.\n"
"description": "Delete the reader."
}
},
"requestBodies": {
Expand Down Expand Up @@ -10268,7 +10273,7 @@
}
},
"CompatErrorResponse": {
"description": "error response for compat API calls",
"description": "Error response for compat API calls.",
"content": {
"application/json": {
"schema": {
Expand Down Expand Up @@ -10484,7 +10489,7 @@
},
{
"name": "Readers",
"description": "A reader represents a device that accepts payments. You can use the SumUp Solo to accept in-person payments.\n",
"description": "A reader represents a device that accepts payments. You can use the SumUp Solo to accept in-person payments.",
"x-core-objects": [
{
"$ref": "#/components/schemas/Reader"
Expand Down
Loading
Loading