Skip to content

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

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

Open
appscisumup wants to merge 2 commits into
base: main
Choose a base branch
from
Open

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5d1e50b
chore: synced local 'openapi.json' with remote 'specs/openapi.json'
Jun 12, 2026
cc85f4a
chore: generate code
sumup-bot[bot] Jun 12, 2026
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
191 changes: 96 additions & 95 deletions openapi.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2206,7 +2206,7 @@
}
},
{
"name": "users",
"name": "users[]",
"in": "query",
"description": "Filters the returned results by user email.",
"required": false,
Expand Down Expand Up @@ -2244,7 +2244,7 @@
}
},
{
"name": "payment_types",
"name": "payment_types[]",
"in": "query",
"description": "Filters the returned results by the specified list of payment types used for the transactions.",
"required": false,
Expand All @@ -2268,7 +2268,7 @@
}
},
{
"name": "types",
"name": "types[]",
"in": "query",
"description": "Filters the returned results by the specified list of transaction types.",
"required": false,
Expand Down Expand Up @@ -3436,7 +3436,7 @@
"type": "object",
"properties": {
"nickname": {
"description": "User's preferred name. Used for display purposes only.",
"description": "User's nickname. Used for display purposes only.",
"type": "string",
"example": "Test User"
},
Expand Down Expand Up @@ -5482,7 +5482,7 @@
}
},
"PaymentTypesFilter": {
"name": "payment_types",
"name": "payment_types[]",
"in": "query",
"description": "Filters the returned results by the specified list of payment types used for the transactions.",
"required": false,
Expand Down Expand Up @@ -5540,7 +5540,7 @@
}
},
"TypesFilter": {
"name": "types",
"name": "types[]",
"in": "query",
"description": "Filters the returned results by the specified list of transaction types.",
"required": false,
Expand All @@ -5557,7 +5557,7 @@
}
},
"UsersFilter": {
"name": "users",
"name": "users[]",
"in": "query",
"description": "Filters the returned results by user email.",
"required": false,
Expand Down Expand Up @@ -8016,7 +8016,7 @@
"format": "date-time"
},
"nickname": {
"description": "User's preferred name. Used for display purposes only.",
"description": "User's nickname. Used for display purposes only.",
"type": "string",
"example": "Test User"
},
Expand Down Expand Up @@ -8044,7 +8044,8 @@
"properties": {
"user_id": {
"type": "integer",
"format": "int32"
"maximum": 2147483647,
"minimum": 0
}
},
"deprecated": true,
Expand Down Expand Up @@ -8226,57 +8227,6 @@
},
"title": "Merchant"
},
"Company": {
"description": "Information about the company or business. This is legal information that is used for verification.\n",
"type": "object",
"properties": {
"name": {
"description": "The company's legal name.",
"type": "string",
"example": "Gin & Doughnuts Bar GmbH",
"maxLength": 150,
"minLength": 1
},
"merchant_category_code": {
"description": "The merchant category code for the account as specified by [ISO18245](https://www.iso.org/standard/33365.html). MCCs are used to classify businesses based on the goods or services they provide.\n",
"type": "string",
"example": "1532",
"pattern": "^[0-9]{4}$"
},
"legal_type": {
"$ref": "#/components/schemas/LegalType"
},
"address": {
"$ref": "#/components/schemas/Address"
},
"trading_address": {
"$ref": "#/components/schemas/Address"
},
"identifiers": {
"$ref": "#/components/schemas/CompanyIdentifiers"
},
"phone_number": {
"$ref": "#/components/schemas/PhoneNumber"
},
"website": {
"description": "HTTP(S) URL of the company's website.\n",
"type": "string",
"format": "uri",
"examples": [
"https://www.sumup.com"
],
"maxLength": 255,
"nullable": true
},
"attributes": {
"$ref": "#/components/schemas/Attributes"
}
},
"externalDocs": {
"description": "Company documentation",
"url": "https://developer.sumup.com/tools/glossary/merchant#company"
}
},
"Meta": {
"description": "A set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.\n\n**Warning**: Updating Meta will overwrite the existing data. Make sure to always include the complete JSON object.",
"type": "object",
Expand Down Expand Up @@ -8308,7 +8258,6 @@
"website": {
"description": "The business's publicly available website.",
"type": "string",
"format": "uri",
"example": "https://example.com",
"maxLength": 255
},
Expand Down Expand Up @@ -8668,35 +8617,13 @@
"share"
]
},
"PersonalIdentifier": {
"type": "object",
"properties": {
"ref": {
"description": "The unique reference for the personal identifier type as defined in the country SDK.\n",
"type": "string",
"examples": [
"br.cpf"
]
},
"value": {
"description": "The company identifier value.\n",
"type": "string",
"examples": [
"847.060.136-90"
],
"maxLength": 30
}
"PersonalIdentifiers": {
"description": "A list of country-specific personal identifiers.\n",
"type": "array",
"items": {
"$ref": "#/components/schemas/PersonalIdentifier"
},
"examples": [
{
"ref": "br.cpf",
"value": "847.060.136-90"
}
],
"required": [
"ref",
"value"
]
"maxItems": 5
},
"Version": {
"description": "The version of the resource. The version reflects a specific change submitted to the API via one of the `PATCH` endpoints.\n",
Expand Down Expand Up @@ -8778,12 +8705,7 @@
"$ref": "#/components/schemas/Address"
},
"identifiers": {
"description": "A list of country-specific personal identifiers.\n",
"type": "array",
"items": {
"$ref": "#/components/schemas/PersonalIdentifier"
},
"maxItems": 5
"$ref": "#/components/schemas/PersonalIdentifiers"
},
"citizenship": {
"$ref": "#/components/schemas/CountryCode"
Expand Down Expand Up @@ -8815,6 +8737,85 @@
"id"
]
},
"PersonalIdentifier": {
"type": "object",
"properties": {
"ref": {
"description": "The unique reference for the personal identifier type as defined in the country SDK.\n",
"type": "string",
"examples": [
"br.cpf"
]
},
"value": {
"description": "The value of the personal identifier.\n",
"type": "string",
"examples": [
"847.060.136-90"
],
"maxLength": 30
}
},
"examples": [
{
"ref": "br.cpf",
"value": "847.060.136-90"
}
],
"required": [
"ref",
"value"
]
},
"Company": {
"description": "Information about the company or business. This is legal information that is used for verification.\n",
"type": "object",
"properties": {
"name": {
"description": "The company's legal name.",
"type": "string",
"example": "Gin & Doughnuts Bar GmbH",
"maxLength": 150,
"minLength": 1
},
"merchant_category_code": {
"description": "The merchant category code for the account as specified by [ISO18245](https://www.iso.org/standard/33365.html). MCCs are used to classify businesses based on the goods or services they provide.\n",
"type": "string",
"example": "1532",
"pattern": "^[0-9]{4}$"
},
"legal_type": {
"$ref": "#/components/schemas/LegalType"
},
"address": {
"$ref": "#/components/schemas/Address"
},
"trading_address": {
"$ref": "#/components/schemas/Address"
},
"identifiers": {
"$ref": "#/components/schemas/CompanyIdentifiers"
},
"phone_number": {
"$ref": "#/components/schemas/PhoneNumber"
},
"website": {
"description": "HTTP(S) URL of the company's website.\n",
"type": "string",
"examples": [
"https://www.sumup.com"
],
"maxLength": 255
},
"attributes": {
"$ref": "#/components/schemas/Attributes"
}
},
"externalDocs": {
"description": "Company documentation",
"url": "https://developer.sumup.com/tools/glossary/merchant#company"
}
},
"ClassicMerchantIdentifiers": {
"type": "object",
"properties": {
Expand Down
2 changes: 1 addition & 1 deletion src/Members/Members.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -215,7 +215,7 @@ class MembersListResponse
class MembersUpdateRequestUser
{
/**
* User's preferred name. Used for display purposes only.
* User's nickname. Used for display purposes only.
*
* @var string|null
*/
Expand Down
18 changes: 9 additions & 9 deletions src/Transactions/Transactions.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -138,7 +138,7 @@ class TransactionsListParams
*
* @var string[]|null
*/
public ?array $users = null;
public ?array $usersList = null;

/**
* Filters the returned results by the specified list of final statuses of the transactions.
Expand All @@ -152,7 +152,7 @@ class TransactionsListParams
*
* @var string[]|null
*/
public ?array $paymentTypes = null;
public ?array $paymentTypesList = null;

/**
* Filters the returned results by the specified list of entry modes.
Expand All @@ -166,7 +166,7 @@ class TransactionsListParams
*
* @var string[]|null
*/
public ?array $types = null;
public ?array $typesList = null;

/**
* 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_8601) format).
Expand Down Expand Up @@ -332,20 +332,20 @@ public function list(string $merchantCode, ?TransactionsListParams $queryParams
if (isset($queryParams->limit)) {
$queryParamsData['limit'] = $queryParams->limit;
}
if (isset($queryParams->users)) {
$queryParamsData['users'] = $queryParams->users;
if (isset($queryParams->usersList)) {
$queryParamsData['users[]'] = $queryParams->usersList;
}
if (isset($queryParams->statusesList)) {
$queryParamsData['statuses[]'] = $queryParams->statusesList;
}
if (isset($queryParams->paymentTypes)) {
$queryParamsData['payment_types'] = $queryParams->paymentTypes;
if (isset($queryParams->paymentTypesList)) {
$queryParamsData['payment_types[]'] = $queryParams->paymentTypesList;
}
if (isset($queryParams->entryModesList)) {
$queryParamsData['entry_modes[]'] = $queryParams->entryModesList;
}
if (isset($queryParams->types)) {
$queryParamsData['types'] = $queryParams->types;
if (isset($queryParams->typesList)) {
$queryParamsData['types[]'] = $queryParams->typesList;
}
if (isset($queryParams->changesSince)) {
$queryParamsData['changes_since'] = $queryParams->changesSince;
Expand Down
2 changes: 1 addition & 1 deletion src/Types/MembershipUser.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ class MembershipUser
public ?string $disabledAt = null;

/**
* User's preferred name. Used for display purposes only.
* User's nickname. Used for display purposes only.
*
* @var string|null
*/
Expand Down
2 changes: 1 addition & 1 deletion src/Types/PersonalIdentifier.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ class PersonalIdentifier
public string $ref;

/**
* The company identifier value.
* The value of the personal identifier.
*
* @var string
*/
Expand Down
Loading