Skip to content

Commit 35fd83d

Browse files
appscisumupappscisumup
authored
chore: synced file(s) with sumup/apis (#32)
1 parent 74b0855 commit 35fd83d

File tree

7 files changed

+254
-105
lines changed

7 files changed

+254
-105
lines changed

‎openapi.json‎

Lines changed: 143 additions & 78 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
},
@@ -6474,7 +6474,9 @@
64746474
"boleto",
64756475
"ideal",
64766476
"blik",
6477-
"bancontact"
6477+
"bancontact",
6478+
"google_pay",
6479+
"apple_pay"
64786480
]
64796481
},
64806482
"installments": {
@@ -6489,6 +6491,50 @@
64896491
"card": {
64906492
"$ref": "#/components/schemas/Card"
64916493
},
6494+
"google_pay": {
6495+
"description": "Raw `PaymentData` object received from Google Pay. Send the Google Pay response payload as-is.",
6496+
"type": "object",
6497+
"example": {
6498+
"apiVersionMinor": 0,
6499+
"apiVersion": 2,
6500+
"paymentMethodData": {
6501+
"description": "Visa •••• 1111",
6502+
"tokenizationData": {
6503+
"type": "PAYMENT_GATEWAY",
6504+
"token": "token-data"
6505+
},
6506+
"type": "CARD",
6507+
"info": {
6508+
"cardNetwork": "VISA",
6509+
"cardDetails": "1111"
6510+
}
6511+
}
6512+
}
6513+
},
6514+
"apple_pay": {
6515+
"description": "Raw payment token object received from Apple Pay. Send the Apple Pay response payload as-is.",
6516+
"type": "object",
6517+
"example": {
6518+
"token": {
6519+
"paymentData": {
6520+
"data": "si2xuT2ArQo689SfE-long-token",
6521+
"signature": "MIAGCSqGSIb3DQEHA-long-signature",
6522+
"header": {
6523+
"publicKeyHash": "PWfjDi3TSwgZ20TY/A7f3V6J/1rhHyRDCspbeljM0io=",
6524+
"ephemeralPublicKey": "MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEaBtz7UN2MNV0qInJVEEhXy10PU0KfO6KxFjXm93oKWL6lCsxZZGDl/EKioUHVSlKgpsKGin0xvgldfxeJVgy0g==",
6525+
"transactionId": "62e0568bc9258e9d0e059d745650fc8211d05ef7a7a1589a6411bf9b12cdfd04"
6526+
},
6527+
"version": "EC_v1"
6528+
},
6529+
"paymentMethod": {
6530+
"displayName": "MasterCard 8837",
6531+
"network": "MasterCard",
6532+
"type": "debit"
6533+
},
6534+
"transactionIdentifier": "62E0568BC9258E9D0E059D745650FC8211D05EF7A7A1589A6411BF9B12CDFD04"
6535+
}
6536+
}
6537+
},
64926538
"token": {
64936539
"description": "__Required when using a tokenized card to process a checkout.__ Unique token identifying the saved payment card for a customer.",
64946540
"type": "string"
@@ -7202,6 +7248,21 @@
72027248
},
72037249
"title": "Receipt Card"
72047250
},
7251+
"ReceiptReader": {
7252+
"description": "Card reader details displayed on the receipt.",
7253+
"type": "object",
7254+
"properties": {
7255+
"code": {
7256+
"description": "Reader serial number.",
7257+
"type": "string"
7258+
},
7259+
"type": {
7260+
"description": "Reader type.",
7261+
"type": "string"
7262+
}
7263+
},
7264+
"title": "Receipt Reader"
7265+
},
72057266
"ReceiptMerchantData": {
72067267
"description": "Receipt merchant data",
72077268
"type": "object",
@@ -7217,15 +7278,30 @@
72177278
"business_name": {
72187279
"type": "string"
72197280
},
7281+
"company_registration_number": {
7282+
"type": "string"
7283+
},
7284+
"vat_id": {
7285+
"type": "string"
7286+
},
7287+
"website": {
7288+
"type": "string"
7289+
},
72207290
"email": {
72217291
"type": "string"
72227292
},
7293+
"language": {
7294+
"type": "string"
7295+
},
72237296
"address": {
72247297
"type": "object",
72257298
"properties": {
72267299
"address_line1": {
72277300
"type": "string"
72287301
},
7302+
"address_line2": {
7303+
"type": "string"
7304+
},
72297305
"city": {
72307306
"type": "string"
72317307
},
@@ -7238,6 +7314,9 @@
72387314
"country_native_name": {
72397315
"type": "string"
72407316
},
7317+
"region_name": {
7318+
"type": "string"
7319+
},
72417320
"post_code": {
72427321
"type": "string"
72437322
},
@@ -7263,6 +7342,13 @@
72637342
"description": "Transaction code.",
72647343
"type": "string"
72657344
},
7345+
"transaction_id": {
7346+
"$ref": "#/components/schemas/TransactionID"
7347+
},
7348+
"merchant_code": {
7349+
"description": "Merchant code.",
7350+
"type": "string"
7351+
},
72667352
"amount": {
72677353
"description": "Transaction amount.",
72687354
"type": "string"
@@ -7300,13 +7386,25 @@
73007386
"description": "Cardholder verification method.",
73017387
"type": "string"
73027388
},
7389+
"card_reader": {
7390+
"$ref": "#/components/schemas/ReceiptReader"
7391+
},
73037392
"card": {
73047393
"$ref": "#/components/schemas/ReceiptCard"
73057394
},
73067395
"installments_count": {
73077396
"description": "Number of installments.",
73087397
"type": "integer"
73097398
},
7399+
"process_as": {
7400+
"description": "Debit/Credit.",
7401+
"type": "string",
7402+
"example": "CREDIT",
7403+
"enum": [
7404+
"CREDIT",
7405+
"DEBIT"
7406+
]
7407+
},
73107408
"products": {
73117409
"description": "Products",
73127410
"type": "array",
@@ -7318,6 +7416,10 @@
73187416
"type": "string",
73197417
"example": "Coffee"
73207418
},
7419+
"description": {
7420+
"description": "Product description",
7421+
"type": "string"
7422+
},
73217423
"price": {
73227424
"description": "Product price",
73237425
"type": "string",
@@ -7657,33 +7759,33 @@
76577759
"description": "Entry mode of the payment details.",
76587760
"type": "string",
76597761
"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"
7762+
"BOLETO",
7763+
"SOFORT",
7764+
"IDEAL",
7765+
"BANCONTACT",
7766+
"EPS",
7767+
"MYBANK",
7768+
"SATISPAY",
7769+
"BLIK",
7770+
"P24",
7771+
"GIROPAY",
7772+
"PIX",
7773+
"QR_CODE_PIX",
7774+
"APPLE_PAY",
7775+
"GOOGLE_PAY",
7776+
"PAYPAL",
7777+
"TWINT",
7778+
"NONE",
7779+
"CHIP",
7780+
"MANUAL_ENTRY",
7781+
"CUSTOMER_ENTRY",
7782+
"MAGSTRIPE_FALLBACK",
7783+
"MAGSTRIPE",
7784+
"DIRECT_DEBIT",
7785+
"CONTACTLESS",
7786+
"MOTO",
7787+
"CONTACTLESS_MAGSTRIPE",
7788+
"N/A"
76877789
],
76887790
"title": "Entry Mode"
76897791
},
@@ -8734,7 +8836,7 @@
87348836
"avatar": {
87358837
"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",
87368838
"type": "string",
8737-
"format": "url"
8839+
"format": "uri"
87388840
},
87398841
"alias": {
87408842
"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 +8894,8 @@
87928894
"description": "The company's legal name.",
87938895
"type": "string",
87948896
"example": "Gin & Doughnuts Bar GmbH",
8795-
"maxLength": 512
8897+
"maxLength": 150,
8898+
"minLength": 1
87968899
},
87978900
"merchant_category_code": {
87988901
"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 +8921,7 @@
88188921
"website": {
88198922
"description": "HTTP(S) URL of the company's website.\n",
88208923
"type": "string",
8924+
"format": "uri",
88218925
"examples": [
88228926
"https://www.sumup.com"
88238927
],
@@ -8850,26 +8954,29 @@
88508954
"description": "The customer-facing business name.",
88518955
"type": "string",
88528956
"example": "Example Coffee",
8853-
"maxLength": 512
8957+
"maxLength": 150,
8958+
"minLength": 1
88548959
},
88558960
"dynamic_descriptor": {
88568961
"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",
88578962
"type": "string",
88588963
"example": "Example Coffee",
88598964
"maxLength": 30,
8965+
"minLength": 1,
88608966
"pattern": "^[a-zA-Z0-9 \\-+\\'_.]{0,30}$"
88618967
},
88628968
"website": {
88638969
"description": "The business's publicly available website.",
88648970
"type": "string",
8971+
"format": "uri",
88658972
"example": "https://example.com",
8866-
"maxLength": 512
8973+
"maxLength": 255
88678974
},
88688975
"email": {
88698976
"description": "A publicly available email address.",
88708977
"type": "string",
88718978
"example": "contact@example.com",
8872-
"maxLength": 256
8979+
"maxLength": 255
88738980
},
88748981
"phone_number": {
88758982
"$ref": "#/components/schemas/PhoneNumber"
@@ -8893,7 +9000,7 @@
88939000
"description": "A publicly available phone number in [E.164](https://en.wikipedia.org/wiki/E.164) format.\n",
88949001
"type": "string",
88959002
"example": "+420123456789",
8896-
"maxLength": 64
9003+
"maxLength": 16
88979004
},
88989005
"Branding": {
88999006
"description": "Settings used to apply the Merchant's branding to email receipts, invoices, checkouts, and other products.",
@@ -9932,10 +10039,6 @@
993210039
"description": "Country ISO 3166-1 code",
993310040
"type": "string"
993410041
},
9935-
"region_id": {
9936-
"description": "Country region id",
9937-
"type": "number"
9938-
},
993910042
"region_name": {
994010043
"description": "Country region name",
994110044
"type": "string"
@@ -10023,10 +10126,6 @@
1002310126
"description": "Country ISO 3166-1 code",
1002410127
"type": "string"
1002510128
},
10026-
"region_id": {
10027-
"description": "Country region id",
10028-
"type": "number"
10029-
},
1003010129
"region_name": {
1003110130
"description": "Region name",
1003210131
"type": "string"
@@ -10439,40 +10538,6 @@
1043910538
}
1044010539
},
1044110540
"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"
1047610541
}
1047710542
},
1047810543
"examples": {

0 commit comments

Comments
 (0)