Skip to content

Commit 1b559ea

Browse files
author
appscisumup
committed
chore: synced local 'openapi.json' with remote 'specs/openapi.json'
1 parent 57234f7 commit 1b559ea

1 file changed

Lines changed: 96 additions & 77 deletions

File tree

‎openapi.json‎

Lines changed: 96 additions & 77 deletions
Original file line numberDiff line numberDiff line change
@@ -2148,7 +2148,7 @@
21482148
"schema": {
21492149
"type": "array",
21502150
"items": {
2151-
"$ref": "#/components/schemas/EntryModeFilter"
2151+
"$ref": "#/components/schemas/EntryMode"
21522152
}
21532153
}
21542154
},
@@ -5959,7 +5959,7 @@
59595959
"schema": {
59605960
"type": "array",
59615961
"items": {
5962-
"$ref": "#/components/schemas/EntryModeFilter"
5962+
"$ref": "#/components/schemas/EntryMode"
59635963
}
59645964
}
59655965
},
@@ -7202,6 +7202,21 @@
72027202
},
72037203
"title": "Receipt Card"
72047204
},
7205+
"ReceiptReader": {
7206+
"description": "Card reader details displayed on the receipt.",
7207+
"type": "object",
7208+
"properties": {
7209+
"code": {
7210+
"description": "Reader serial number.",
7211+
"type": "string"
7212+
},
7213+
"type": {
7214+
"description": "Reader type.",
7215+
"type": "string"
7216+
}
7217+
},
7218+
"title": "Receipt Reader"
7219+
},
72057220
"ReceiptMerchantData": {
72067221
"description": "Receipt merchant data",
72077222
"type": "object",
@@ -7217,15 +7232,30 @@
72177232
"business_name": {
72187233
"type": "string"
72197234
},
7235+
"company_registration_number": {
7236+
"type": "string"
7237+
},
7238+
"vat_id": {
7239+
"type": "string"
7240+
},
7241+
"website": {
7242+
"type": "string"
7243+
},
72207244
"email": {
72217245
"type": "string"
72227246
},
7247+
"language": {
7248+
"type": "string"
7249+
},
72237250
"address": {
72247251
"type": "object",
72257252
"properties": {
72267253
"address_line1": {
72277254
"type": "string"
72287255
},
7256+
"address_line2": {
7257+
"type": "string"
7258+
},
72297259
"city": {
72307260
"type": "string"
72317261
},
@@ -7238,6 +7268,9 @@
72387268
"country_native_name": {
72397269
"type": "string"
72407270
},
7271+
"region_name": {
7272+
"type": "string"
7273+
},
72417274
"post_code": {
72427275
"type": "string"
72437276
},
@@ -7263,6 +7296,13 @@
72637296
"description": "Transaction code.",
72647297
"type": "string"
72657298
},
7299+
"transaction_id": {
7300+
"$ref": "#/components/schemas/TransactionID"
7301+
},
7302+
"merchant_code": {
7303+
"description": "Merchant code.",
7304+
"type": "string"
7305+
},
72667306
"amount": {
72677307
"description": "Transaction amount.",
72687308
"type": "string"
@@ -7300,13 +7340,25 @@
73007340
"description": "Cardholder verification method.",
73017341
"type": "string"
73027342
},
7343+
"card_reader": {
7344+
"$ref": "#/components/schemas/ReceiptReader"
7345+
},
73037346
"card": {
73047347
"$ref": "#/components/schemas/ReceiptCard"
73057348
},
73067349
"installments_count": {
73077350
"description": "Number of installments.",
73087351
"type": "integer"
73097352
},
7353+
"process_as": {
7354+
"description": "Debit/Credit.",
7355+
"type": "string",
7356+
"example": "CREDIT",
7357+
"enum": [
7358+
"CREDIT",
7359+
"DEBIT"
7360+
]
7361+
},
73107362
"products": {
73117363
"description": "Products",
73127364
"type": "array",
@@ -7318,6 +7370,10 @@
73187370
"type": "string",
73197371
"example": "Coffee"
73207372
},
7373+
"description": {
7374+
"description": "Product description",
7375+
"type": "string"
7376+
},
73217377
"price": {
73227378
"description": "Product price",
73237379
"type": "string",
@@ -7657,33 +7713,33 @@
76577713
"description": "Entry mode of the payment details.",
76587714
"type": "string",
76597715
"enum": [
7660-
"none",
7661-
"magstripe",
7662-
"chip",
7663-
"manual entry",
7664-
"customer entry",
7665-
"magstripe fallback",
7666-
"contactless",
7667-
"moto",
7668-
"contactless magstripe",
7669-
"boleto",
7670-
"direct debit",
7671-
"sofort",
7672-
"ideal",
7673-
"bancontact",
7674-
"eps",
7675-
"mybank",
7676-
"satispay",
7677-
"blik",
7678-
"p24",
7679-
"giropay",
7680-
"pix",
7681-
"qr code pix",
7682-
"apple pay",
7683-
"google pay",
7684-
"paypal",
7685-
"twint",
7686-
"na"
7716+
"BOLETO",
7717+
"SOFORT",
7718+
"IDEAL",
7719+
"BANCONTACT",
7720+
"EPS",
7721+
"MYBANK",
7722+
"SATISPAY",
7723+
"BLIK",
7724+
"P24",
7725+
"GIROPAY",
7726+
"PIX",
7727+
"QR_CODE_PIX",
7728+
"APPLE_PAY",
7729+
"GOOGLE_PAY",
7730+
"PAYPAL",
7731+
"TWINT",
7732+
"NONE",
7733+
"CHIP",
7734+
"MANUAL_ENTRY",
7735+
"CUSTOMER_ENTRY",
7736+
"MAGSTRIPE_FALLBACK",
7737+
"MAGSTRIPE",
7738+
"DIRECT_DEBIT",
7739+
"CONTACTLESS",
7740+
"MOTO",
7741+
"CONTACTLESS_MAGSTRIPE",
7742+
"N/A"
76877743
],
76887744
"title": "Entry Mode"
76897745
},
@@ -8734,7 +8790,7 @@
87348790
"avatar": {
87358791
"description": "A user-facing small-format logo for use in dashboards and other user-facing applications. For customer-facing branding see `merchant.business_profile.branding`.\n",
87368792
"type": "string",
8737-
"format": "url"
8793+
"format": "uri"
87388794
},
87398795
"alias": {
87408796
"description": "A user-facing name of the merchant account for use in dashboards and other user-facing applications. For customer-facing business name see `merchant.business_profile`.\n",
@@ -8792,7 +8848,8 @@
87928848
"description": "The company's legal name.",
87938849
"type": "string",
87948850
"example": "Gin & Doughnuts Bar GmbH",
8795-
"maxLength": 512
8851+
"maxLength": 150,
8852+
"minLength": 1
87968853
},
87978854
"merchant_category_code": {
87988855
"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",
@@ -8818,6 +8875,7 @@
88188875
"website": {
88198876
"description": "HTTP(S) URL of the company's website.\n",
88208877
"type": "string",
8878+
"format": "uri",
88218879
"examples": [
88228880
"https://www.sumup.com"
88238881
],
@@ -8850,26 +8908,29 @@
88508908
"description": "The customer-facing business name.",
88518909
"type": "string",
88528910
"example": "Example Coffee",
8853-
"maxLength": 512
8911+
"maxLength": 150,
8912+
"minLength": 1
88548913
},
88558914
"dynamic_descriptor": {
88568915
"description": "The descriptor is the text that your customer sees on their bank account statement.\nThe more recognisable your descriptor is, the less risk you have of receiving disputes (e.g. chargebacks).\n",
88578916
"type": "string",
88588917
"example": "Example Coffee",
88598918
"maxLength": 30,
8919+
"minLength": 1,
88608920
"pattern": "^[a-zA-Z0-9 \\-+\\'_.]{0,30}$"
88618921
},
88628922
"website": {
88638923
"description": "The business's publicly available website.",
88648924
"type": "string",
8925+
"format": "uri",
88658926
"example": "https://example.com",
8866-
"maxLength": 512
8927+
"maxLength": 255
88678928
},
88688929
"email": {
88698930
"description": "A publicly available email address.",
88708931
"type": "string",
88718932
"example": "contact@example.com",
8872-
"maxLength": 256
8933+
"maxLength": 255
88738934
},
88748935
"phone_number": {
88758936
"$ref": "#/components/schemas/PhoneNumber"
@@ -8893,7 +8954,7 @@
88938954
"description": "A publicly available phone number in [E.164](https://en.wikipedia.org/wiki/E.164) format.\n",
88948955
"type": "string",
88958956
"example": "+420123456789",
8896-
"maxLength": 64
8957+
"maxLength": 16
88978958
},
88988959
"Branding": {
88998960
"description": "Settings used to apply the Merchant's branding to email receipts, invoices, checkouts, and other products.",
@@ -9932,10 +9993,6 @@
99329993
"description": "Country ISO 3166-1 code",
99339994
"type": "string"
99349995
},
9935-
"region_id": {
9936-
"description": "Country region id",
9937-
"type": "number"
9938-
},
99399996
"region_name": {
99409997
"description": "Country region name",
99419998
"type": "string"
@@ -10023,10 +10080,6 @@
1002310080
"description": "Country ISO 3166-1 code",
1002410081
"type": "string"
1002510082
},
10026-
"region_id": {
10027-
"description": "Country region id",
10028-
"type": "number"
10029-
},
1003010083
"region_name": {
1003110084
"description": "Region name",
1003210085
"type": "string"
@@ -10439,40 +10492,6 @@
1043910492
}
1044010493
},
1044110494
"title": "Personal Profile Legacy"
10442-
},
10443-
"EntryModeFilter": {
10444-
"description": "Entry mode value accepted by the `entry_modes[]` filter.",
10445-
"type": "string",
10446-
"enum": [
10447-
"BOLETO",
10448-
"SOFORT",
10449-
"IDEAL",
10450-
"BANCONTACT",
10451-
"EPS",
10452-
"MYBANK",
10453-
"SATISPAY",
10454-
"BLIK",
10455-
"P24",
10456-
"GIROPAY",
10457-
"PIX",
10458-
"QR_CODE_PIX",
10459-
"APPLE_PAY",
10460-
"GOOGLE_PAY",
10461-
"PAYPAL",
10462-
"TWINT",
10463-
"NONE",
10464-
"CHIP",
10465-
"MANUAL_ENTRY",
10466-
"CUSTOMER_ENTRY",
10467-
"MAGSTRIPE_FALLBACK",
10468-
"MAGSTRIPE",
10469-
"DIRECT_DEBIT",
10470-
"CONTACTLESS",
10471-
"MOTO",
10472-
"CONTACTLESS_MAGSTRIPE",
10473-
"N/A"
10474-
],
10475-
"title": "Entry Mode Filter"
1047610495
}
1047710496
},
1047810497
"examples": {

0 commit comments

Comments
 (0)