Skip to content

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

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-machine-user wants to merge 2 commits into
base: main
Choose a base branch
from
Open

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

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
3c9fcee
chore: synced local 'openapi.json' with remote 'specs/openapi.json'
Mar 23, 2026
0ce71db
chore: synced local 'openapi.yaml' with remote 'specs/openapi.yaml'
Mar 23, 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
76 changes: 4 additions & 72 deletions openapi.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -162,10 +162,7 @@
"currency": "EUR",
"merchant_code": "MH4H92C7",
"description": "Purchase",
"id": "2b79757a-de87-4a2e-90e4-b17c947c730d",
"status": "PAID",
"date": "2020-02-29T10:56:56+00:00",
"merchant_name": "John Doe LTD",
"valid_until": "2020-02-29T10:56:56+00:00",
"redirect_url": "https://sumup.com"
}
},
Expand Down Expand Up @@ -613,8 +610,7 @@
"expiry_year": "2023",
"expiry_month": "01",
"cvv": "123",
"zip_code": "12345",
"last_4_digits": "3456"
"zip_code": "12345"
}
}
},
Expand Down Expand Up @@ -6157,14 +6153,6 @@
"minLength": 5,
"writeOnly": true
},
"last_4_digits": {
"description": "Last 4 digits of the payment card number.",
"type": "string",
"example": "3456",
"maxLength": 4,
"minLength": 4,
"readOnly": true
},
"type": {
"$ref": "#/components/schemas/CardType"
}
Expand All @@ -6175,7 +6163,6 @@
"expiry_month",
"expiry_year",
"cvv",
"last_4_digits",
"type"
],
"title": "Card"
Expand Down Expand Up @@ -6388,51 +6375,13 @@
"SETUP_RECURRING_PAYMENT"
]
},
"id": {
"description": "Unique ID of the checkout resource.",
"type": "string",
"readOnly": true
},
"status": {
"description": "Current status of the checkout.",
"type": "string",
"enum": [
"PENDING",
"FAILED",
"PAID"
],
"readOnly": true
},
"date": {
"description": "Date and time of the creation of the payment checkout. Response format expressed according to [ISO8601](https://en.wikipedia.org/wiki/ISO_8601) code.",
"type": "string",
"format": "date-time",
"example": "2020-02-29T10:56:56+00:00",
"readOnly": true
},
"valid_until": {
"description": "Date and time of the checkout expiration before which the client application needs to send a processing request. If no value is present, the checkout does not have an expiration time.",
"type": "string",
"format": "date-time",
"example": "2020-02-29T10:56:56+00:00",
"nullable": true
},
"transactions": {
"description": "List of transactions related to the payment.",
"type": "array",
"items": {
"allOf": [
{
"$ref": "#/components/schemas/TransactionBase"
},
{
"$ref": "#/components/schemas/TransactionCheckoutInfo"
}
]
},
"readOnly": true,
"uniqueItems": true
},
"redirect_url": {
"description": "__Required__ for [APMs](https://developer.sumup.com/online-payments/apm/introduction) and __recommended__ for card payments. Refers to a url where the end user is redirected once the payment processing completes. If not specified, the [Payment Widget](https://developer.sumup.com/online-payments/tools/card-widget) renders [3DS challenge](https://developer.sumup.com/online-payments/features/3ds) within an iframe instead of performing a full-page redirect.",
"type": "string",
Expand Down Expand Up @@ -10275,17 +10224,6 @@
"description": "Details of the payment card that is saved as a payment instrument.",
"type": "object",
"properties": {
"token": {
"description": "Unique token identifying the saved payment card for a customer.",
"type": "string",
"readOnly": true
},
"active": {
"description": "Indicates whether the payment instrument is active and can be used for payments. To deactivate it, send a `DELETE` request to the resource endpoint.",
"type": "boolean",
"default": true,
"readOnly": true
},
"type": {
"description": "Type of the payment instrument.",
"type": "string",
Expand All @@ -10298,8 +10236,6 @@
}
},
"required": [
"token",
"active",
"type",
"card"
],
Expand Down Expand Up @@ -10521,10 +10457,7 @@
"currency": "EUR",
"merchant_code": "MH4H92C7",
"description": "Purchase",
"id": "2b79757a-de87-4a2e-90e4-b17c947c730d",
"status": "PAID",
"date": "2020-02-29T10:56:56+00:00",
"merchant_name": "John Doe LTD",
"valid_until": "2020-02-29T10:56:56+00:00",
"redirect_url": "https://sumup.com"
}
},
Expand Down Expand Up @@ -10581,8 +10514,7 @@
"expiry_year": "2023",
"expiry_month": "01",
"cvv": "123",
"zip_code": "12345",
"last_4_digits": "3456"
"zip_code": "12345"
}
}
},
Expand Down
58 changes: 2 additions & 56 deletions openapi.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -115,10 +115,7 @@ paths:
currency: EUR
merchant_code: MH4H92C7
description: Purchase
id: 2b79757a-de87-4a2e-90e4-b17c947c730d
status: PAID
date: '2020-02-29T10:56:56+00:00'
merchant_name: John Doe LTD
valid_until: '2020-02-29T10:56:56+00:00'
redirect_url: 'https://sumup.com'
Checkout3DS:
description: Create a 3DS checkout
Expand Down Expand Up @@ -437,7 +434,6 @@ paths:
expiry_month: '01'
cvv: '123'
zip_code: '12345'
last_4_digits: '3456'
ProcessToken:
description: Process a checkout with a token
value:
Expand Down Expand Up @@ -4150,13 +4146,6 @@ components:
maxLength: 5
minLength: 5
writeOnly: true
last_4_digits:
description: Last 4 digits of the payment card number.
type: string
example: '3456'
maxLength: 4
minLength: 4
readOnly: true
type:
$ref: '#/components/schemas/CardType'
required:
Expand All @@ -4165,7 +4154,6 @@ components:
- expiry_month
- expiry_year
- cvv
- last_4_digits
- type
title: Card
CardResponse:
Expand Down Expand Up @@ -4328,39 +4316,12 @@ components:
enum:
- CHECKOUT
- SETUP_RECURRING_PAYMENT
id:
description: Unique ID of the checkout resource.
type: string
readOnly: true
status:
description: Current status of the checkout.
type: string
enum:
- PENDING
- FAILED
- PAID
readOnly: true
date:
description: 'Date and time of the creation of the payment checkout. Response format expressed according to [ISO8601](https://en.wikipedia.org/wiki/ISO_8601) code.'
type: string
format: date-time
example: '2020-02-29T10:56:56+00:00'
readOnly: true
valid_until:
description: 'Date and time of the checkout expiration before which the client application needs to send a processing request. If no value is present, the checkout does not have an expiration time.'
type: string
format: date-time
example: '2020-02-29T10:56:56+00:00'
nullable: true
transactions:
description: List of transactions related to the payment.
type: array
items:
allOf:
- $ref: '#/components/schemas/TransactionBase'
- $ref: '#/components/schemas/TransactionCheckoutInfo'
readOnly: true
uniqueItems: true
redirect_url:
description: '__Required__ for [APMs](https://developer.sumup.com/online-payments/apm/introduction) and __recommended__ for card payments. Refers to a url where the end user is redirected once the payment processing completes. If not specified, the [Payment Widget](https://developer.sumup.com/online-payments/tools/card-widget) renders [3DS challenge](https://developer.sumup.com/online-payments/features/3ds) within an iframe instead of performing a full-page redirect.'
type: string
Expand Down Expand Up @@ -7408,15 +7369,6 @@ components:
description: Details of the payment card that is saved as a payment instrument.
type: object
properties:
token:
description: Unique token identifying the saved payment card for a customer.
type: string
readOnly: true
active:
description: 'Indicates whether the payment instrument is active and can be used for payments. To deactivate it, send a `DELETE` request to the resource endpoint.'
type: boolean
default: true
readOnly: true
type:
description: Type of the payment instrument.
type: string
Expand All @@ -7425,8 +7377,6 @@ components:
card:
$ref: '#/components/schemas/Card'
required:
- token
- active
- type
- card
title: Payment Instrument Card
Expand Down Expand Up @@ -7598,10 +7548,7 @@ components:
currency: EUR
merchant_code: MH4H92C7
description: Purchase
id: 2b79757a-de87-4a2e-90e4-b17c947c730d
status: PAID
date: '2020-02-29T10:56:56+00:00'
merchant_name: John Doe LTD
valid_until: '2020-02-29T10:56:56+00:00'
redirect_url: 'https://sumup.com'
Checkout3DS:
description: Create a 3DS checkout
Expand Down Expand Up @@ -7647,7 +7594,6 @@ components:
expiry_month: '01'
cvv: '123'
zip_code: '12345'
last_4_digits: '3456'
ProcessToken:
description: Process a checkout with a token
value:
Expand Down
Loading