Skip to content

Commit 6ada3a6

Browse files
author
appscisumup
committed
chore: synced local 'openapi.json' with remote 'specs/openapi.json'
1 parent 8340bbd commit 6ada3a6

1 file changed

Lines changed: 105 additions & 114 deletions

File tree

‎openapi.json‎

Lines changed: 105 additions & 114 deletions
Original file line numberDiff line numberDiff line change
@@ -543,10 +543,10 @@
543543
]
544544
}
545545
},
546-
"/v0.1/checkouts/{id}": {
546+
"/v0.1/checkouts/{checkout_id}": {
547547
"parameters": [
548548
{
549-
"name": "id",
549+
"name": "checkout_id",
550550
"in": "path",
551551
"description": "Unique ID of the checkout resource.",
552552
"required": true,
@@ -1150,14 +1150,14 @@
11501150
]
11511151
}
11521152
},
1153-
"/v0.2/checkouts/{id}/apple-pay-session": {
1153+
"/v0.2/checkouts/{checkout_id}/apple-pay-session": {
11541154
"put": {
11551155
"operationId": "CreateApplePaySession",
11561156
"summary": "Create an Apple Pay session",
11571157
"description": "Creates an Apple Pay merchant session for the specified checkout.\n\nUse this endpoint after the customer selects Apple Pay and before calling\n`ApplePaySession.completeMerchantValidation(...)` in the browser.\nSumUp validates the merchant session request and returns the Apple Pay\nsession object that your frontend should pass to Apple's JavaScript API.\n",
11581158
"parameters": [
11591159
{
1160-
"name": "id",
1160+
"name": "checkout_id",
11611161
"in": "path",
11621162
"description": "Unique ID of the checkout resource.",
11631163
"required": true,
@@ -1900,7 +1900,7 @@
19001900
]
19011901
}
19021902
},
1903-
"/v1.0/merchants/{merchant_code}/payments/{id}/refunds": {
1903+
"/v1.0/merchants/{merchant_code}/payments/{transaction_id}/refunds": {
19041904
"parameters": [
19051905
{
19061906
"name": "merchant_code",
@@ -1913,7 +1913,7 @@
19131913
}
19141914
},
19151915
{
1916-
"name": "id",
1916+
"name": "transaction_id",
19171917
"in": "path",
19181918
"description": "Unique ID of the transaction.",
19191919
"required": true,
@@ -2658,14 +2658,14 @@
26582658
]
26592659
}
26602660
},
2661-
"/v1.1/receipts/{id}": {
2661+
"/v1.1/receipts/{transaction_id}": {
26622662
"get": {
26632663
"operationId": "GetReceipt",
26642664
"summary": "Retrieve receipt details",
26652665
"description": "Retrieves receipt specific data for a transaction.",
26662666
"parameters": [
26672667
{
2668-
"name": "id",
2668+
"name": "transaction_id",
26692669
"in": "path",
26702670
"description": "SumUp unique transaction ID or transaction code, e.g. TS7HDYLSKD.",
26712671
"required": true,
@@ -3436,7 +3436,7 @@
34363436
"type": "object",
34373437
"properties": {
34383438
"nickname": {
3439-
"description": "User's preferred name. Used for display purposes only.",
3439+
"description": "User's nickname. Used for display purposes only.",
34403440
"type": "string",
34413441
"example": "Test User"
34423442
},
@@ -4549,14 +4549,14 @@
45494549
"UpdateReaderByID": {
45504550
"operationId": "UpdateReader",
45514551
"parameters": {
4552-
"id": "$response.body#/id"
4552+
"reader_id": "$response.body#/id"
45534553
},
45544554
"description": "Update the reader object. This can be used to set a name after using this endpoint to verify the pairing code."
45554555
},
45564556
"DeleteReaderByID": {
45574557
"operationId": "DeleteReader",
45584558
"parameters": {
4559-
"id": "$response.body#/id"
4559+
"reader_id": "$response.body#/id"
45604560
},
45614561
"description": "Delete the reader."
45624562
}
@@ -4639,7 +4639,7 @@
46394639
]
46404640
}
46414641
},
4642-
"/v0.1/merchants/{merchant_code}/readers/{id}": {
4642+
"/v0.1/merchants/{merchant_code}/readers/{reader_id}": {
46434643
"get": {
46444644
"operationId": "GetReader",
46454645
"summary": "Retrieve a Reader",
@@ -4677,7 +4677,7 @@
46774677
}
46784678
},
46794679
{
4680-
"name": "id",
4680+
"name": "reader_id",
46814681
"in": "path",
46824682
"description": "The unique identifier of the reader.",
46834683
"required": true,
@@ -4757,7 +4757,7 @@
47574757
}
47584758
},
47594759
{
4760-
"name": "id",
4760+
"name": "reader_id",
47614761
"in": "path",
47624762
"description": "The unique identifier of the reader.",
47634763
"required": true,
@@ -4830,7 +4830,7 @@
48304830
}
48314831
},
48324832
{
4833-
"name": "id",
4833+
"name": "reader_id",
48344834
"in": "path",
48354835
"description": "The unique identifier of the reader.",
48364836
"required": true,
@@ -5403,7 +5403,7 @@
54035403
}
54045404
},
54055405
"CheckoutID": {
5406-
"name": "id",
5406+
"name": "checkout_id",
54075407
"in": "path",
54085408
"required": true,
54095409
"description": "Unique ID of the checkout resource.",
@@ -5539,15 +5539,6 @@
55395539
"type": "string"
55405540
}
55415541
},
5542-
"TxnID": {
5543-
"in": "path",
5544-
"name": "txn_id",
5545-
"required": true,
5546-
"description": "Unique ID of the transaction.",
5547-
"schema": {
5548-
"type": "string"
5549-
}
5550-
},
55515542
"TypesFilter": {
55525543
"name": "types",
55535544
"in": "query",
@@ -8025,7 +8016,7 @@
80258016
"format": "date-time"
80268017
},
80278018
"nickname": {
8028-
"description": "User's preferred name. Used for display purposes only.",
8019+
"description": "User's nickname. Used for display purposes only.",
80298020
"type": "string",
80308021
"example": "Test User"
80318022
},
@@ -8235,57 +8226,6 @@
82358226
},
82368227
"title": "Merchant"
82378228
},
8238-
"Company": {
8239-
"description": "Information about the company or business. This is legal information that is used for verification.\n",
8240-
"type": "object",
8241-
"properties": {
8242-
"name": {
8243-
"description": "The company's legal name.",
8244-
"type": "string",
8245-
"example": "Gin & Doughnuts Bar GmbH",
8246-
"maxLength": 150,
8247-
"minLength": 1
8248-
},
8249-
"merchant_category_code": {
8250-
"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",
8251-
"type": "string",
8252-
"example": "1532",
8253-
"pattern": "^[0-9]{4}$"
8254-
},
8255-
"legal_type": {
8256-
"$ref": "#/components/schemas/LegalType"
8257-
},
8258-
"address": {
8259-
"$ref": "#/components/schemas/Address"
8260-
},
8261-
"trading_address": {
8262-
"$ref": "#/components/schemas/Address"
8263-
},
8264-
"identifiers": {
8265-
"$ref": "#/components/schemas/CompanyIdentifiers"
8266-
},
8267-
"phone_number": {
8268-
"$ref": "#/components/schemas/PhoneNumber"
8269-
},
8270-
"website": {
8271-
"description": "HTTP(S) URL of the company's website.\n",
8272-
"type": "string",
8273-
"format": "uri",
8274-
"examples": [
8275-
"https://www.sumup.com"
8276-
],
8277-
"maxLength": 255,
8278-
"nullable": true
8279-
},
8280-
"attributes": {
8281-
"$ref": "#/components/schemas/Attributes"
8282-
}
8283-
},
8284-
"externalDocs": {
8285-
"description": "Company documentation",
8286-
"url": "https://developer.sumup.com/tools/glossary/merchant#company"
8287-
}
8288-
},
82898229
"Meta": {
82908230
"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.",
82918231
"type": "object",
@@ -8317,7 +8257,6 @@
83178257
"website": {
83188258
"description": "The business's publicly available website.",
83198259
"type": "string",
8320-
"format": "uri",
83218260
"example": "https://example.com",
83228261
"maxLength": 255
83238262
},
@@ -8677,35 +8616,13 @@
86778616
"share"
86788617
]
86798618
},
8680-
"PersonalIdentifier": {
8681-
"type": "object",
8682-
"properties": {
8683-
"ref": {
8684-
"description": "The unique reference for the personal identifier type as defined in the country SDK.\n",
8685-
"type": "string",
8686-
"examples": [
8687-
"br.cpf"
8688-
]
8689-
},
8690-
"value": {
8691-
"description": "The company identifier value.\n",
8692-
"type": "string",
8693-
"examples": [
8694-
"847.060.136-90"
8695-
],
8696-
"maxLength": 30
8697-
}
8619+
"PersonalIdentifiers": {
8620+
"description": "A list of country-specific personal identifiers.\n",
8621+
"type": "array",
8622+
"items": {
8623+
"$ref": "#/components/schemas/PersonalIdentifier"
86988624
},
8699-
"examples": [
8700-
{
8701-
"ref": "br.cpf",
8702-
"value": "847.060.136-90"
8703-
}
8704-
],
8705-
"required": [
8706-
"ref",
8707-
"value"
8708-
]
8625+
"maxItems": 5
87098626
},
87108627
"Version": {
87118628
"description": "The version of the resource. The version reflects a specific change submitted to the API via one of the `PATCH` endpoints.\n",
@@ -8787,12 +8704,7 @@
87878704
"$ref": "#/components/schemas/Address"
87888705
},
87898706
"identifiers": {
8790-
"description": "A list of country-specific personal identifiers.\n",
8791-
"type": "array",
8792-
"items": {
8793-
"$ref": "#/components/schemas/PersonalIdentifier"
8794-
},
8795-
"maxItems": 5
8707+
"$ref": "#/components/schemas/PersonalIdentifiers"
87968708
},
87978709
"citizenship": {
87988710
"$ref": "#/components/schemas/CountryCode"
@@ -8824,6 +8736,85 @@
88248736
"id"
88258737
]
88268738
},
8739+
"PersonalIdentifier": {
8740+
"type": "object",
8741+
"properties": {
8742+
"ref": {
8743+
"description": "The unique reference for the personal identifier type as defined in the country SDK.\n",
8744+
"type": "string",
8745+
"examples": [
8746+
"br.cpf"
8747+
]
8748+
},
8749+
"value": {
8750+
"description": "The value of the personal identifier.\n",
8751+
"type": "string",
8752+
"examples": [
8753+
"847.060.136-90"
8754+
],
8755+
"maxLength": 30
8756+
}
8757+
},
8758+
"examples": [
8759+
{
8760+
"ref": "br.cpf",
8761+
"value": "847.060.136-90"
8762+
}
8763+
],
8764+
"required": [
8765+
"ref",
8766+
"value"
8767+
]
8768+
},
8769+
"Company": {
8770+
"description": "Information about the company or business. This is legal information that is used for verification.\n",
8771+
"type": "object",
8772+
"properties": {
8773+
"name": {
8774+
"description": "The company's legal name.",
8775+
"type": "string",
8776+
"example": "Gin & Doughnuts Bar GmbH",
8777+
"maxLength": 150,
8778+
"minLength": 1
8779+
},
8780+
"merchant_category_code": {
8781+
"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",
8782+
"type": "string",
8783+
"example": "1532",
8784+
"pattern": "^[0-9]{4}$"
8785+
},
8786+
"legal_type": {
8787+
"$ref": "#/components/schemas/LegalType"
8788+
},
8789+
"address": {
8790+
"$ref": "#/components/schemas/Address"
8791+
},
8792+
"trading_address": {
8793+
"$ref": "#/components/schemas/Address"
8794+
},
8795+
"identifiers": {
8796+
"$ref": "#/components/schemas/CompanyIdentifiers"
8797+
},
8798+
"phone_number": {
8799+
"$ref": "#/components/schemas/PhoneNumber"
8800+
},
8801+
"website": {
8802+
"description": "HTTP(S) URL of the company's website.\n",
8803+
"type": "string",
8804+
"examples": [
8805+
"https://www.sumup.com"
8806+
],
8807+
"maxLength": 255
8808+
},
8809+
"attributes": {
8810+
"$ref": "#/components/schemas/Attributes"
8811+
}
8812+
},
8813+
"externalDocs": {
8814+
"description": "Company documentation",
8815+
"url": "https://developer.sumup.com/tools/glossary/merchant#company"
8816+
}
8817+
},
88278818
"ClassicMerchantIdentifiers": {
88288819
"type": "object",
88298820
"properties": {
@@ -9595,14 +9586,14 @@
95959586
"UpdateReaderByID": {
95969587
"operationId": "UpdateReader",
95979588
"parameters": {
9598-
"id": "$response.body#/id"
9589+
"reader_id": "$response.body#/id"
95999590
},
96009591
"description": "Update the reader object. This can be used to set a name after using this endpoint to verify the pairing code."
96019592
},
96029593
"DeleteReaderByID": {
96039594
"operationId": "DeleteReader",
96049595
"parameters": {
9605-
"id": "$response.body#/id"
9596+
"reader_id": "$response.body#/id"
96069597
},
96079598
"description": "Delete the reader."
96089599
}

0 commit comments

Comments
 (0)