Skip to content

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

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
sumup-release-bot wants to merge 3 commits into
base: main
Choose a base branch
from
Open

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

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
de8bf90
chore: synced local 'openapi.yaml' with remote 'specs/openapi.yaml'
sumup-release-bot[bot] Nov 6, 2026
523a522
chore: created local 'openapi31.json' from remote 'specs/openapi31.json'
sumup-release-bot[bot] Nov 6, 2026
62b7538
chore: created local 'openapi31.yaml' from remote 'specs/openapi31.yaml'
sumup-release-bot[bot] Nov 6, 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
177 changes: 55 additions & 122 deletions openapi.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8073,19 +8073,15 @@ components:
allOf:
- $ref: '#/components/schemas/Amount'
gross_amount:
description: 'Gross amount after applying the tax.

description: |
Gross amount after applying the tax.
The value of the amount in minor units of the currency according to the Sale.currency.scale.

'
allOf:
- $ref: '#/components/schemas/Amount'
tax_amount:
description: 'Amount of tax.

description: |
Amount of tax.
The value of the amount in minor units of the currency according to the Sale.currency.scale.

'
allOf:
- $ref: '#/components/schemas/Amount'
DiscountLevel:
Expand Down Expand Up @@ -8156,13 +8152,10 @@ components:
DiscountClass:
type: string
nullable: true
description: 'The method used to target items to discount.

description: |
The method used to target items to discount.
Must be populated for ITEM level discounts, and must be null for CART level discounts (CART level targets all

items, therefore none of these categories apply).

'
enum:
- ITEM
- CATEGORY
Expand Down Expand Up @@ -8270,13 +8263,10 @@ components:
format: int64
nullable: true
minimum: 1
description: 'The number of points used for this loyalty discount.

description: |
The number of points used for this loyalty discount.
Must be a positive integer if the scheme type is POINTS.

Must not be populated if the scheme type is STAMPS.

'
example: 50
name:
type: string
Expand Down Expand Up @@ -8319,29 +8309,22 @@ components:
- percentage.'
properties:
absolute:
description: 'The absolute value in minor units of the currency according to the Sale.currency.scale.

description: |
The absolute value in minor units of the currency according to the Sale.currency.scale.
Example: 10000 = 10.00

'
allOf:
- $ref: '#/components/schemas/PositiveAmount'
percentage:
type: integer
format: int64
minimum: 0
description: 'The percentage in minor units (1/100000).

description: |
The percentage in minor units (1/100000).

Examples:

- 10% -> 0.10 (decimal) = 10000 (minor units)

- 15.5% -> 0.155 (decimal) = 15500 (minor units)

- 0.001% -> 0.00001 (decimal) = 1 (minor units)

'
example: 10000
DiscountLine:
type: object
Expand Down Expand Up @@ -8371,27 +8354,21 @@ components:
value:
$ref: '#/components/schemas/DiscountValue'
net_amount:
description: 'The net amount of the discount.

description: |
The net amount of the discount.
The value of the amount in minor units of the currency according to the Sale.currency.scale.

'
allOf:
- $ref: '#/components/schemas/PositiveAmount'
gross_amount:
description: 'The gross amount of the discount.

description: |
The gross amount of the discount.
The value of the amount in minor units of the currency according to the Sale.currency.scale.

'
allOf:
- $ref: '#/components/schemas/PositiveAmount'
tax_amount:
description: 'The tax amount of the discount.

description: |
The tax amount of the discount.
The value of the amount in minor units of the currency according to the Sale.currency.scale.

'
allOf:
- $ref: '#/components/schemas/PositiveAmount'
LineItemPriceV10:
Expand All @@ -8417,11 +8394,9 @@ components:
- taxes_final
properties:
unit_amount:
description: 'The price of a single unit. If the tax_mode is GROSS it includes taxes,

description: |
The price of a single unit. If the tax_mode is GROSS it includes taxes,
otherwise no tax is included. It does NOT include discounts.

'
allOf:
- $ref: '#/components/schemas/PositiveAmount'
example: 300
Expand Down Expand Up @@ -8450,11 +8425,9 @@ components:
discounts:
type: array
maxItems: 1000
description: 'Discounts applied. Discount amounts do not affect `total_net_amount` /

description: |
Discounts applied. Discount amounts do not affect `total_net_amount` /
`total_gross_amount`; they are reflected in the `*_final` amounts.

'
items:
$ref: '#/components/schemas/DiscountLine'
example: []
Expand Down Expand Up @@ -8506,13 +8479,10 @@ components:
- total_gross_amount
properties:
unit_amount:
description: 'The price of a single unit.

description: |
The price of a single unit.
If the tax_mode is GROSS, it includes taxes, otherwise no tax included.

It doesn''t include discounts.

'
It doesn't include discounts.
allOf:
- $ref: '#/components/schemas/PositiveAmount'
total_net_amount:
Expand Down Expand Up @@ -8544,19 +8514,15 @@ components:
allOf:
- $ref: '#/components/schemas/PositiveAmount'
gross_amount:
description: 'Gross amount after applying the tax.

description: |
Gross amount after applying the tax.
The value of the amount in minor units of the currency according to the Sale.currency.scale.

'
allOf:
- $ref: '#/components/schemas/PositiveAmount'
tax_amount:
description: 'Amount of tax.

description: |
Amount of tax.
The value of the amount in minor units of the currency according to the Sale.currency.scale.

'
allOf:
- $ref: '#/components/schemas/PositiveAmount'
PositivePriceWithTaxes:
Expand Down Expand Up @@ -8600,11 +8566,9 @@ components:
type: array
minItems: 1
maxItems: 1000
description: 'Taxes applied on top of `total_net_amount_final` amount resulting in `total_gross_amount_final` amount.

description: |
Taxes applied on top of `total_net_amount_final` amount resulting in `total_gross_amount_final` amount.
If no discounts are applied, it should be equal to `taxes`.

'
items:
$ref: '#/components/schemas/PositiveTaxLine'
ModifierSet:
Expand Down Expand Up @@ -8783,11 +8747,9 @@ components:
$ref: '#/components/schemas/LineItemPriceV10'
categories:
type: array
description: 'Categories the line belongs to. A shared optional structure available to any

description: |
Categories the line belongs to. A shared optional structure available to any
line; not a per-type field.

'
maxItems: 1000
items:
$ref: '#/components/schemas/CategoryV10'
Expand All @@ -8796,11 +8758,9 @@ components:
name: Hot Drinks
modifiers:
type: array
description: 'Modifiers customise a line (e.g. "oat milk" on a cappuccino). A shared

description: |
Modifiers customise a line (e.g. "oat milk" on a cappuccino). A shared
optional structure available to any line; not a per-type field.

'
maxItems: 50
items:
$ref: '#/components/schemas/ModifierItem'
Expand All @@ -8809,11 +8769,9 @@ components:
$ref: '#/components/schemas/ItemReferencesV10'
features:
type: array
description: 'Named, typed, type-specific data. New item types add their data here as

description: |
Named, typed, type-specific data. New item types add their data here as
features instead of new schema variants. See `Feature` for per-type examples.

'
maxItems: 100
items:
$ref: '#/components/schemas/FeatureV10'
Expand Down Expand Up @@ -8881,19 +8839,13 @@ components:
tax_amount: 148
TaxMode:
type: string
description: 'The tax mode used by merchant for displaying prices and calculating taxes:

- NO_TAX: The prices don''t contain any taxes, merchant don''t report taxes

description: |
The tax mode used by merchant for displaying prices and calculating taxes:
- NO_TAX: The prices don't contain any taxes, merchant don't report taxes
- GROSS: The prices used by merchant already include taxes (common in EU), the tax is calculated from the gross price

- NET: The prices used by merchant don''t include taxes (common in US), the tax is calculated from the net price

- NET: The prices used by merchant don't include taxes (common in US), the tax is calculated from the net price
Since tax values can be different for the same net price depending if the tax

was calculated from gross or net price, this info is necessary to be able to reconcile tax calculations.

'
enum:
- NO_TAX
- GROSS
Expand All @@ -8920,13 +8872,10 @@ components:
$ref: '#/components/schemas/SalesChannel'
sub_channel:
type: string
description: 'The sub_channel is an optional field that can be used to provide more

description: |
The sub_channel is an optional field that can be used to provide more
information about the sale_channel. For example, if the sale_channel is

ONLINE_PAYMENTS, the sub_channel could be "WIX" or "QR_CODE" or "WOOCOMMERCE".

'
example: QR_CODE
maxLength: 50
external_id:
Expand All @@ -8936,13 +8885,10 @@ components:
maxLength: 250
external_sub_channel_id:
type: string
description: 'An external reference ID for the sub-channel.

description: |
An external reference ID for the sub-channel.
For example, when channel is BOOKINGS and sub_channel is POS,

this can hold the OMS order ID while external_id holds the appointment ID.

'
example: 9736e947-6f1f-487f-846a-c5954fb06a5a
maxLength: 250
required:
Expand Down Expand Up @@ -9037,26 +8983,18 @@ components:
type:
type: string
default: purchase
description: 'Payment operation type.

description: |
Payment operation type.
This is distinct from the payment instrument in `method`.

Input is case-insensitive; the canonical form is lowercase snake_case.

**VALUES**: [purchase, unreferenced_refund]

Defaults to "purchase" if unspecified. Either a normal purchase or an unreferenced refund for negative

sales like deposit returns.

'
example: purchase
amount:
description: 'The amount of the payment including tips.

description: |
The amount of the payment including tips.
The value of the amount in minor units of `Sale.currency`.

'
allOf:
- $ref: '#/components/schemas/PositiveAmount'
example: 975
Expand Down Expand Up @@ -9142,11 +9080,9 @@ components:
type: array
minItems: 1
maxItems: 1000
description: 'The lines sold in this sale, in the order they were added to the cart.

description: |
The lines sold in this sale, in the order they were added to the cart.
Includes merchant fees (`type: "FEE"`) when present; fee details are in `features`.

'
items:
$ref: '#/components/schemas/SaleLineItemV10'
price:
Expand All @@ -9158,9 +9094,8 @@ components:
payments:
type: array
maxItems: 1000
description: 'Payments on this sale, in the order they were recorded.

'
description: |
Payments on this sale, in the order they were recorded.
items:
$ref: '#/components/schemas/PublicPaymentV10'
example:
Expand Down Expand Up @@ -9207,12 +9142,10 @@ components:
example: 66bcbtzelrubzeuzruzgu76678trncH
ProblemV10:
type: object
description: 'A RFC 9457 problem details object.

description: |
A RFC 9457 problem details object.

Additional properties specific to the problem type may be present.

'
required:
- type
additionalProperties: true
Expand Down
Loading
Loading