Skip to content

Commit 7992aec

Browse files
author
appscisumup
committed
chore: synced local 'openapi.json' with remote 'specs/openapi31.json'
1 parent 13ee611 commit 7992aec

1 file changed

Lines changed: 40 additions & 64 deletions

File tree

‎openapi.json‎

Lines changed: 40 additions & 64 deletions
Original file line numberDiff line numberDiff line change
@@ -243,7 +243,7 @@
243243
"post": {
244244
"operationId": "CreateCheckout",
245245
"summary": "Create a checkout",
246-
"description": "Creates a new payment checkout resource. The unique `checkout_reference` created by this request, is used for further manipulation of the checkout.\n\nFor 3DS checkouts, add the `redirect_url` parameter to your request body schema.\nTo use the [Hosted Checkout](https://developer.sumup.com/online-payments/checkouts/hosted-checkout/) page, set the `hosted_checkout.enabled` to `true`.\n\nFollow by processing a checkout to charge the provided payment instrument.",
246+
"description": "Creates a payment checkout for the specified merchant, amount, and currency. Supply a `checkout_reference` to identify the payment attempt in your own systems. Creating a checkout does not charge a payment instrument.\n\nSet `hosted_checkout.enabled` to `true` to receive a [Hosted Checkout](https://developer.sumup.com/online-payments/checkouts/hosted-checkout/) URL where the customer can complete the payment.\nUse `redirect_url` for redirect-based payment and 3DS flows. If `return_url` is provided, SumUp sends processing updates to that backend callback URL.\n\nComplete the payment through [Hosted Checkout](https://developer.sumup.com/online-payments/checkouts/hosted-checkout/) or the [Payment Widget](https://developer.sumup.com/online-payments/checkouts/card-widget).",
247247
"tags": [
248248
"Checkouts"
249249
],
@@ -746,7 +746,7 @@
746746
"patch": {
747747
"operationId": "UpdateCheckout",
748748
"summary": "Update a checkout",
749-
"description": "Updates an identified checkout resource.",
749+
"description": "Updates the amount, currency, description, reference, expiration, or customer associated with an existing checkout. Only the supplied fields are updated.\n\nThis request changes the checkout details; it does not charge a payment instrument. Process the checkout separately to attempt a payment.",
750750
"tags": [
751751
"Checkouts"
752752
],
@@ -3443,28 +3443,30 @@
34433443
"type": "string"
34443444
}
34453445
},
3446+
{
3447+
"name": "resource.id",
3448+
"in": "query",
3449+
"description": "Filter memberships by the ID of the resource the membership is in.",
3450+
"schema": {
3451+
"type": "string"
3452+
}
3453+
},
34463454
{
34473455
"name": "resource.parent.id",
34483456
"in": "query",
3449-
"description": "Filter memberships by the parent of the resource the membership is in.\nWhen filtering by parent both `resource.parent.id` and `resource.parent.type` must be present. Pass explicit null to filter for resources without a parent.",
3457+
"allowEmptyValue": true,
3458+
"description": "Filter memberships by the parent of the resource the membership is in.\nOmit both `resource.parent.id` and `resource.parent.type` to skip parent filtering. When filtering by parent, both parameters must be present. To select resources without a parent, set each parameter to an empty value. Otherwise, both parameters must identify a parent.",
34503459
"schema": {
3451-
"type": [
3452-
"string",
3453-
"null"
3454-
]
3460+
"type": "string"
34553461
}
34563462
},
34573463
{
34583464
"name": "resource.parent.type",
34593465
"in": "query",
3460-
"description": "Filter memberships by the parent of the resource the membership is in.\nWhen filtering by parent both `resource.parent.id` and `resource.parent.type` must be present. Pass explicit null to filter for resources without a parent.",
3466+
"allowEmptyValue": true,
3467+
"description": "Filter memberships by the parent of the resource the membership is in.\nOmit both `resource.parent.id` and `resource.parent.type` to skip parent filtering. When filtering by parent, both parameters must be present. To select resources without a parent, set each parameter to an empty value. Otherwise, both parameters must identify a parent.",
34613468
"schema": {
3462-
"allOf": [
3463-
{
3464-
"$ref": "#/components/schemas/ResourceType"
3465-
}
3466-
],
3467-
"type": "null"
3469+
"$ref": "#/components/schemas/ResourceType"
34683470
}
34693471
},
34703472
{
@@ -3603,19 +3605,6 @@
36033605
"example": "245b2ead-85bf-45ff-856f-311a88a5d454"
36043606
}
36053607
},
3606-
{
3607-
"name": "user.type",
3608-
"in": "query",
3609-
"description": "Filter the returned members by user type. Repeat this parameter to include multiple user types.",
3610-
"schema": {
3611-
"type": "array",
3612-
"items": {
3613-
"$ref": "#/components/schemas/UserType"
3614-
}
3615-
},
3616-
"style": "form",
3617-
"explode": true
3618-
},
36193608
{
36203609
"name": "status",
36213610
"in": "query",
@@ -3730,7 +3719,7 @@
37303719
"post": {
37313720
"operationId": "CreateMerchantMember",
37323721
"summary": "Create a member",
3733-
"description": "Create a merchant member.",
3722+
"description": "Adds a member to the merchant account with the specified roles.\n\nBy default, sends an invitation email to the provided address. The recipient must accept the invitation to join the account.\nWhen `is_managed_user` is `true`, creates a managed user with the provided password and optional nickname and assigns the roles directly, without sending an invitation.",
37343723
"tags": [
37353724
"Members"
37363725
],
@@ -3795,6 +3784,7 @@
37953784
"roles": {
37963785
"type": "array",
37973786
"description": "List of roles to assign to the new member.",
3787+
"minItems": 1,
37983788
"maxItems": 124,
37993789
"items": {
38003790
"type": "string",
@@ -3978,7 +3968,7 @@
39783968
},
39793969
"put": {
39803970
"summary": "Update a member",
3981-
"description": "Update the merchant member.",
3971+
"description": "Updates a merchant member and returns the updated member.\n\nProviding `roles` replaces the member's assigned roles and can grant or revoke access. Providing `metadata` replaces the entire metadata object.\nFor managed users, `user.nickname` changes the display name and `user.password` replaces the password. Updating the password also enables the managed user account.",
39823972
"tags": [
39833973
"Members"
39843974
],
@@ -4017,6 +4007,7 @@
40174007
"properties": {
40184008
"roles": {
40194009
"type": "array",
4010+
"minItems": 1,
40204011
"maxItems": 124,
40214012
"items": {
40224013
"type": "string",
@@ -4392,6 +4383,7 @@
43924383
"permissions": {
43934384
"type": "array",
43944385
"description": "User's permissions.",
4386+
"minItems": 1,
43954387
"maxItems": 100,
43964388
"items": {
43974389
"type": "string"
@@ -4652,7 +4644,7 @@
46524644
"patch": {
46534645
"operationId": "UpdateMerchantRole",
46544646
"summary": "Update a role",
4655-
"description": "Update a custom role.",
4647+
"description": "Updates a custom role's name, description, or permissions and returns the updated role.\n\nProviding `permissions` replaces the role's permission list and changes the access granted to members assigned to that role. Omitted fields remain unchanged.",
46564648
"tags": [
46574649
"Roles"
46584650
],
@@ -4696,6 +4688,7 @@
46964688
"permissions": {
46974689
"type": "array",
46984690
"description": "User's permissions.",
4691+
"minItems": 1,
46994692
"maxItems": 100,
47004693
"items": {
47014694
"type": "string"
@@ -5438,7 +5431,7 @@
54385431
},
54395432
"patch": {
54405433
"summary": "Update a Reader",
5441-
"description": "Update a Reader.",
5434+
"description": "Updates a reader's name or metadata and returns the updated reader.\n\nProviding `metadata` replaces the entire metadata object; include all entries that should be retained. Omitted fields remain unchanged.",
54425435
"operationId": "UpdateReader",
54435436
"tags": [
54445437
"Readers"
@@ -6246,6 +6239,11 @@
62466239
},
62476240
"type": {
62486241
"$ref": "#/components/schemas/CardType"
6242+
},
6243+
"payment_account_reference": {
6244+
"type": "string",
6245+
"description": "PAR (Payment account reference) if available for the card.",
6246+
"example": "5665ABCDEFGHIJKLMNOPQRSTUVWXY"
62496247
}
62506248
}
62516249
},
@@ -8319,7 +8317,6 @@
83198317
"type": "string",
83208318
"description": "Three-letter [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code of the amount.",
83218319
"enum": [
8322-
"BGN",
83238320
"BRL",
83248321
"CHF",
83258322
"CLP",
@@ -8923,17 +8920,6 @@
89238920
}
89248921
}
89258922
},
8926-
"UserType": {
8927-
"type": "string",
8928-
"description": "Type of the user account.",
8929-
"enum": [
8930-
"user",
8931-
"managed_user",
8932-
"service_account",
8933-
"system_account"
8934-
],
8935-
"example": "user"
8936-
},
89378923
"Metadata": {
89388924
"description": "Set of user-defined key-value pairs attached to the object. Partial updates are not supported. When updating, always submit whole metadata. Maximum of 64 parameters are allowed in the object.",
89398925
"type": "object",
@@ -8947,6 +8933,17 @@
89478933
"example": {},
89488934
"additionalProperties": true
89498935
},
8936+
"UserType": {
8937+
"type": "string",
8938+
"description": "Type of the user account.",
8939+
"enum": [
8940+
"user",
8941+
"managed_user",
8942+
"service_account",
8943+
"system_account"
8944+
],
8945+
"example": "user"
8946+
},
89508947
"Address": {
89518948
"externalDocs": {
89528949
"description": "Address documentation",
@@ -11382,27 +11379,6 @@
1138211379
"payouts.read": "View payouts.",
1138311380
"user.subaccounts": "View and manage the user profile details of your employees."
1138411381
}
11385-
},
11386-
"clientCredentials": {
11387-
"tokenUrl": "https://api.sumup.com/token",
11388-
"scopes": {
11389-
"payments": "Make payments by creating and processing checkouts.",
11390-
"checkouts.read": "View checkouts.",
11391-
"checkouts.write": "Create, process, and deactivate checkouts.",
11392-
"transactions.history": "View transactions and transaction history.",
11393-
"transactions.read": "View transactions and transaction history.",
11394-
"refunds.write": "Refund transactions.",
11395-
"receipts.read": "View receipts.",
11396-
"user.profile_readonly": "View user profile details.",
11397-
"user.profile": "View and manage your user profile.",
11398-
"user.app-settings": "View and manage the SumUp mobile application settings.",
11399-
"payment_instruments": "Manage customers and their payment instruments.",
11400-
"customers.read": "View customers and their payment instruments.",
11401-
"customers.write": "Create and manage customers and their payment instruments.",
11402-
"user.payout-settings": "View and manage your payout settings.",
11403-
"payouts.read": "View payouts.",
11404-
"user.subaccounts": "View and manage the user profile details of your employee."
11405-
}
1140611382
}
1140711383
}
1140811384
}

0 commit comments

Comments
 (0)