Skip to content

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

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 4 commits into
base: main
Choose a base branch
from
+36 −792
Open

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
f590acf
chore: synced local 'openapi.json' with remote 'specs/openapi.json'
Aug 10, 2026
789b172
chore: synced local 'openapi.yaml' with remote 'specs/openapi.yaml'
Aug 10, 2026
56cc34b
chore: synced local 'openapi31.json' with remote 'specs/openapi31.json'
Aug 10, 2026
31a53d3
chore: synced local 'openapi31.yaml' with remote 'specs/openapi31.yaml'
Aug 10, 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
240 changes: 9 additions & 231 deletions openapi.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4970,7 +4970,7 @@
},
"x-permissions": [
{
"relation": "readers_list",
"relation": "readers.list",
"object_type": "merchant",
"object_id_param": "merchant_code"
}
Expand Down Expand Up @@ -5054,7 +5054,7 @@
},
"x-permissions": [
{
"relation": "readers_create",
"relation": "readers.create",
"object_type": "merchant",
"object_id_param": "merchant_code"
}
Expand Down Expand Up @@ -5218,7 +5218,7 @@
},
"x-permissions": [
{
"relation": "readers_view",
"relation": "readers.view",
"object_type": "merchant",
"object_id_param": "merchant_code"
}
Expand Down Expand Up @@ -5321,7 +5321,7 @@
},
"x-permissions": [
{
"relation": "readers_delete",
"relation": "readers.delete",
"object_type": "merchant",
"object_id_param": "merchant_code"
}
Expand Down Expand Up @@ -5396,7 +5396,7 @@
},
"x-permissions": [
{
"relation": "readers_update",
"relation": "readers.update",
"object_type": "merchant",
"object_id_param": "merchant_code"
}
Expand Down Expand Up @@ -5676,7 +5676,7 @@
"method_name": "create_checkout"
},
"x-permissions": [
"readers_checkout_create"
"readers.checkouts.create"
],
"x-scopes": [
"readers.write"
Expand Down Expand Up @@ -5803,7 +5803,7 @@
"method_name": "get_status"
},
"x-permissions": [
"readers_view"
"readers.view"
],
"x-scopes": [
"readers.read"
Expand Down Expand Up @@ -5954,7 +5954,7 @@
"method_name": "terminate_checkout"
},
"x-permissions": [
"readers_checkout_create"
"readers.checkouts.delete"
],
"x-scopes": [
"readers.write"
Expand Down Expand Up @@ -6070,7 +6070,7 @@
"method_name": "get_checkout"
},
"x-permissions": [
"readers_checkout_view"
"readers.checkouts.view"
],
"x-scopes": [
"readers.read"
Expand Down Expand Up @@ -11484,227 +11484,5 @@
"description": "Delete the reader."
}
}
},
"webhooks": {
"readers.created": {
"post": {
"operationId": "ReaderCreatedWebhook",
"tags": [
"Readers"
],
"summary": "Reader created",
"description": "Sent when a reader is paired to a merchant account and becomes available through the Readers API.",
"x-object": {
"$ref": "#/components/schemas/Reader"
},
"x-object-type": "reader",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Event"
},
"examples": {
"created": {
"summary": "A reader created webhook event.",
"value": {
"id": "evt_reader_123",
"type": "readers.created",
"created_at": "2023-05-09T14:52:58.714Z",
"object": {
"id": "rdr_3MSAFM23CK82VSTT4BN6RWSQ65",
"type": "reader",
"url": "https://api.sumup.com/v0.1/merchants/MC0DE/readers/rdr_3MSAFM23CK82VSTT4BN6RWSQ65"
}
}
}
}
}
}
},
"responses": {
"2XX": {
"description": "Return any 2xx response to acknowledge successful delivery."
}
}
}
},
"readers.deleted": {
"post": {
"operationId": "ReaderDeletedWebhook",
"tags": [
"Readers"
],
"summary": "Reader deleted",
"description": "Sent when a reader is unpaired from a merchant account and is no longer available through the Readers API.",
"x-object": {
"$ref": "#/components/schemas/Reader"
},
"x-object-type": "reader",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Event"
},
"examples": {
"deleted": {
"summary": "A reader deleted webhook event.",
"value": {
"id": "evt_reader_456",
"type": "readers.deleted",
"created_at": "2023-05-10T09:21:33.004Z",
"object": {
"id": "rdr_3MSAFM23CK82VSTT4BN6RWSQ65",
"type": "reader",
"url": "https://api.sumup.com/v0.1/merchants/MC0DE/readers/rdr_3MSAFM23CK82VSTT4BN6RWSQ65"
}
}
}
}
}
}
},
"responses": {
"2XX": {
"description": "Return any 2xx response to acknowledge successful delivery."
}
}
}
},
"members.created": {
"post": {
"operationId": "MemberCreatedWebhook",
"tags": [
"Members"
],
"summary": "Member created",
"description": "Sent when a member is created, invited, or accepts an invitation for a merchant account.",
"x-object": {
"$ref": "#/components/schemas/Member"
},
"x-object-type": "member",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Event"
},
"examples": {
"created": {
"summary": "A member created webhook event.",
"value": {
"id": "evt_membership_123",
"type": "members.created",
"created_at": "2026-05-14T08:30:00Z",
"object": {
"id": "mem_123",
"type": "member",
"url": "https://api.sumup.com/v0.1/merchants/MC0DE/members/mem_123"
}
}
}
}
}
}
},
"responses": {
"2XX": {
"description": "Return any 2xx response to acknowledge successful delivery."
}
}
}
},
"members.updated": {
"post": {
"operationId": "MemberUpdatedWebhook",
"tags": [
"Members"
],
"summary": "Member updated",
"description": "Sent when a member is updated, disabled, rejected, or expires for a merchant account.",
"x-object": {
"$ref": "#/components/schemas/Member"
},
"x-object-type": "member",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Event"
},
"examples": {
"updated": {
"summary": "A member updated webhook event.",
"value": {
"id": "evt_membership_456",
"type": "members.updated",
"created_at": "2026-05-14T09:15:00Z",
"object": {
"id": "mem_123",
"type": "member",
"url": "https://api.sumup.com/v0.1/merchants/MC0DE/members/mem_123"
}
}
}
}
}
}
},
"responses": {
"2XX": {
"description": "Return any 2xx response to acknowledge successful delivery."
}
}
}
},
"members.deleted": {
"post": {
"operationId": "MemberDeletedWebhook",
"tags": [
"Members"
],
"summary": "Member deleted",
"description": "Sent when a member is deleted from a merchant account.",
"x-object": {
"$ref": "#/components/schemas/Member"
},
"x-object-type": "member",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Event"
},
"examples": {
"deleted": {
"summary": "A member deleted webhook event.",
"value": {
"id": "evt_membership_789",
"type": "members.deleted",
"created_at": "2026-05-14T10:45:00Z",
"object": {
"id": "mem_123",
"type": "member",
"url": "https://api.sumup.com/v0.1/merchants/MC0DE/members/mem_123"
}
}
}
}
}
}
},
"responses": {
"2XX": {
"description": "Return any 2xx response to acknowledge successful delivery."
}
}
}
}
}
}
Loading