From 774415b37d1a551be68743ad074b90b6360af1be Mon Sep 17 00:00:00 2001 From: Adyen Automation Date: Wed, 6 Mar 2024 10:57:21 +0100 Subject: [PATCH] spec release --- json/ManagementNotificationService-v1.json | 15 ++ json/ManagementNotificationService-v3.json | 17 ++ json/ManagementService-v1.json | 234 +++++++++++++++++++- json/ManagementService-v3.json | 243 ++++++++++++++++++++- yaml/ManagementNotificationService-v1.yaml | 15 ++ yaml/ManagementNotificationService-v3.yaml | 17 ++ yaml/ManagementService-v1.yaml | 232 +++++++++++++++++++- yaml/ManagementService-v3.yaml | 241 +++++++++++++++++++- 8 files changed, 1002 insertions(+), 12 deletions(-) diff --git a/json/ManagementNotificationService-v1.json b/json/ManagementNotificationService-v1.json index a56b0944..1d40c9b8 100644 --- a/json/ManagementNotificationService-v1.json +++ b/json/ManagementNotificationService-v1.json @@ -163,6 +163,7 @@ "components" : { "schemas" : { "AccountCapabilityData" : { + "additionalProperties" : false, "properties" : { "allowed" : { "description" : "Indicates whether the capability is allowed. Adyen sets this to **true** if the verification is successful.", @@ -208,6 +209,7 @@ "type" : "object" }, "AccountCreateNotificationData" : { + "additionalProperties" : false, "properties" : { "capabilities" : { "additionalProperties" : { @@ -242,6 +244,7 @@ "type" : "object" }, "AccountNotificationResponse" : { + "additionalProperties" : false, "properties" : { "notificationResponse" : { "description" : "Respond with **HTTP 200 OK** and `[accepted]` in the response body to [accept the webhook](https://docs.adyen.com/development-resources/webhooks#accept-notifications).", @@ -251,6 +254,7 @@ "type" : "object" }, "AccountUpdateNotificationData" : { + "additionalProperties" : false, "properties" : { "capabilities" : { "additionalProperties" : { @@ -280,6 +284,7 @@ "type" : "object" }, "CapabilityProblem" : { + "additionalProperties" : false, "properties" : { "entity" : { "description" : "The ID and the type of entity that has verification errors.", @@ -296,6 +301,7 @@ "type" : "object" }, "CapabilityProblemEntity" : { + "additionalProperties" : false, "properties" : { "documents" : { "description" : "List of document IDs to which the verification errors related to the capabilities correspond to.", @@ -325,6 +331,7 @@ "type" : "object" }, "CapabilityProblemEntity-recursive" : { + "additionalProperties" : false, "properties" : { "documents" : { "description" : "List of document IDs to which the verification errors related to the capabilities correspond to.", @@ -352,6 +359,7 @@ "type" : "object" }, "MerchantCreatedNotificationRequest" : { + "additionalProperties" : false, "properties" : { "createdAt" : { "description" : "Timestamp for when the webhook was created.", @@ -383,6 +391,7 @@ "type" : "object" }, "MerchantUpdatedNotificationRequest" : { + "additionalProperties" : false, "properties" : { "createdAt" : { "description" : "Timestamp for when the webhook was created.", @@ -414,6 +423,7 @@ "type" : "object" }, "MidServiceNotificationData" : { + "additionalProperties" : false, "properties" : { "allowed" : { "description" : "Indicates whether receiving payments is allowed. This value is set to **true** by Adyen after screening your merchant account.", @@ -471,6 +481,7 @@ "type" : "object" }, "PaymentMethodCreatedNotificationRequest" : { + "additionalProperties" : false, "properties" : { "createdAt" : { "description" : "Timestamp for when the webhook was created.", @@ -502,6 +513,7 @@ "type" : "object" }, "PaymentMethodNotificationResponse" : { + "additionalProperties" : false, "properties" : { "notificationResponse" : { "description" : "Respond with **HTTP 200 OK** and `[accepted]` in the response body to [accept the webhook](https://docs.adyen.com/development-resources/webhooks#accept-notifications).", @@ -511,6 +523,7 @@ "type" : "object" }, "RemediatingAction" : { + "additionalProperties" : false, "properties" : { "code" : { "description" : "The remediating action code.", @@ -524,6 +537,7 @@ "type" : "object" }, "VerificationError" : { + "additionalProperties" : false, "properties" : { "code" : { "description" : "The verification error code.", @@ -560,6 +574,7 @@ "type" : "object" }, "VerificationError-recursive" : { + "additionalProperties" : false, "properties" : { "code" : { "description" : "The verification error code.", diff --git a/json/ManagementNotificationService-v3.json b/json/ManagementNotificationService-v3.json index 9a3d0a38..9d67f928 100644 --- a/json/ManagementNotificationService-v3.json +++ b/json/ManagementNotificationService-v3.json @@ -253,6 +253,7 @@ "components" : { "schemas" : { "AccountCapabilityData" : { + "additionalProperties" : false, "properties" : { "allowed" : { "description" : "Indicates whether the capability is allowed. Adyen sets this to **true** if the verification is successful.", @@ -298,6 +299,7 @@ "type" : "object" }, "AccountCreateNotificationData" : { + "additionalProperties" : false, "properties" : { "capabilities" : { "additionalProperties" : { @@ -332,6 +334,7 @@ "type" : "object" }, "AccountNotificationResponse" : { + "additionalProperties" : false, "properties" : { "notificationResponse" : { "description" : "Respond with **HTTP 200 OK** and `[accepted]` in the response body to [accept the webhook](https://docs.adyen.com/development-resources/webhooks#accept-notifications).", @@ -341,6 +344,7 @@ "type" : "object" }, "AccountUpdateNotificationData" : { + "additionalProperties" : false, "properties" : { "capabilities" : { "additionalProperties" : { @@ -370,6 +374,7 @@ "type" : "object" }, "CapabilityProblem" : { + "additionalProperties" : false, "properties" : { "entity" : { "description" : "The ID and the type of entity that has verification errors.", @@ -386,6 +391,7 @@ "type" : "object" }, "CapabilityProblemEntity" : { + "additionalProperties" : false, "properties" : { "documents" : { "description" : "List of document IDs to which the verification errors related to the capabilities correspond to.", @@ -415,6 +421,7 @@ "type" : "object" }, "CapabilityProblemEntity-recursive" : { + "additionalProperties" : false, "properties" : { "documents" : { "description" : "List of document IDs to which the verification errors related to the capabilities correspond to.", @@ -442,6 +449,7 @@ "type" : "object" }, "MerchantCreatedNotificationRequest" : { + "additionalProperties" : false, "properties" : { "createdAt" : { "description" : "Timestamp for when the webhook was created.", @@ -473,6 +481,7 @@ "type" : "object" }, "MerchantUpdatedNotificationRequest" : { + "additionalProperties" : false, "properties" : { "createdAt" : { "description" : "Timestamp for when the webhook was created.", @@ -504,6 +513,7 @@ "type" : "object" }, "MidServiceNotificationData" : { + "additionalProperties" : false, "properties" : { "allowed" : { "description" : "Indicates whether receiving payments is allowed. This value is set to **true** by Adyen after screening your merchant account.", @@ -565,6 +575,7 @@ "type" : "object" }, "PaymentMethodCreatedNotificationRequest" : { + "additionalProperties" : false, "properties" : { "createdAt" : { "description" : "Timestamp for when the webhook was created.", @@ -596,6 +607,7 @@ "type" : "object" }, "PaymentMethodNotificationResponse" : { + "additionalProperties" : false, "properties" : { "notificationResponse" : { "description" : "Respond with **HTTP 200 OK** and `[accepted]` in the response body to [accept the webhook](https://docs.adyen.com/development-resources/webhooks#accept-notifications).", @@ -605,6 +617,7 @@ "type" : "object" }, "PaymentMethodRequestRemovedNotificationRequest" : { + "additionalProperties" : false, "properties" : { "createdAt" : { "description" : "Timestamp for when the webhook was created.", @@ -636,6 +649,7 @@ "type" : "object" }, "PaymentMethodScheduledForRemovalNotificationRequest" : { + "additionalProperties" : false, "properties" : { "createdAt" : { "description" : "Timestamp for when the webhook was created.", @@ -667,6 +681,7 @@ "type" : "object" }, "RemediatingAction" : { + "additionalProperties" : false, "properties" : { "code" : { "description" : "The remediating action code.", @@ -680,6 +695,7 @@ "type" : "object" }, "VerificationError" : { + "additionalProperties" : false, "properties" : { "code" : { "description" : "The verification error code.", @@ -716,6 +732,7 @@ "type" : "object" }, "VerificationError-recursive" : { + "additionalProperties" : false, "properties" : { "code" : { "description" : "The verification error code.", diff --git a/json/ManagementService-v1.json b/json/ManagementService-v1.json index 4d561f65..57e6f596 100644 --- a/json/ManagementService-v1.json +++ b/json/ManagementService-v1.json @@ -15034,6 +15034,7 @@ "components" : { "schemas" : { "AdditionalCommission" : { + "additionalProperties" : false, "properties" : { "balanceAccountId" : { "description" : "Unique identifier of the balance account to which the additional commission is booked.", @@ -15053,6 +15054,7 @@ "type" : "object" }, "AdditionalSettings" : { + "additionalProperties" : false, "properties" : { "includeEventCodes" : { "description" : "Object containing list of event codes for which the notifcation will be sent. ", @@ -15072,6 +15074,7 @@ "type" : "object" }, "AdditionalSettingsResponse" : { + "additionalProperties" : false, "properties" : { "excludeEventCodes" : { "description" : "Object containing list of event codes for which the notifcation will not be sent. ", @@ -15098,6 +15101,7 @@ "type" : "object" }, "Address" : { + "additionalProperties" : false, "properties" : { "city" : { "description" : "The name of the city.", @@ -15131,6 +15135,7 @@ "type" : "object" }, "AfterpayTouchInfo" : { + "additionalProperties" : false, "properties" : { "supportUrl" : { "description" : "Support Url", @@ -15143,6 +15148,7 @@ "type" : "object" }, "AllowedOrigin" : { + "additionalProperties" : false, "properties" : { "_links" : { "description" : "References to resources linked to the allowed origin.", @@ -15164,6 +15170,7 @@ "type" : "object" }, "AllowedOriginsResponse" : { + "additionalProperties" : false, "properties" : { "data" : { "description" : "List of allowed origins.", @@ -15176,6 +15183,7 @@ "type" : "object" }, "Amount" : { + "additionalProperties" : false, "properties" : { "currency" : { "description" : "The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes).", @@ -15196,6 +15204,7 @@ "type" : "object" }, "AndroidApp" : { + "additionalProperties" : false, "properties" : { "description" : { "description" : "The description that was provided when uploading the app. The description is not shown on the terminal.", @@ -15238,6 +15247,7 @@ "type" : "object" }, "AndroidAppsResponse" : { + "additionalProperties" : false, "properties" : { "data" : { "description" : "Apps uploaded for Android payment terminals.", @@ -15250,6 +15260,7 @@ "type" : "object" }, "AndroidCertificate" : { + "additionalProperties" : false, "properties" : { "description" : { "description" : "The description that was provided when uploading the certificate.", @@ -15288,6 +15299,7 @@ "type" : "object" }, "AndroidCertificatesResponse" : { + "additionalProperties" : false, "properties" : { "data" : { "description" : "Uploaded Android certificates for Android payment terminals.", @@ -15300,6 +15312,7 @@ "type" : "object" }, "ApiCredential" : { + "additionalProperties" : false, "properties" : { "_links" : { "description" : "References to resources linked to the API credential.", @@ -15359,6 +15372,7 @@ "type" : "object" }, "ApiCredentialLinks" : { + "additionalProperties" : false, "properties" : { "allowedOrigins" : { "description" : "List of allowed origins.", @@ -15391,6 +15405,7 @@ "type" : "object" }, "ApplePayInfo" : { + "additionalProperties" : false, "properties" : { "domains" : { "description" : "The list of merchant domains. Maximum: 99 domains per request.\n\nFor more information, see [Apple Pay documentation](https://docs.adyen.com/payment-methods/apple-pay/web-drop-in?tab=adyen-certificate-live_1#going-live).", @@ -15406,6 +15421,7 @@ "type" : "object" }, "BcmcInfo" : { + "additionalProperties" : false, "properties" : { "enableBcmcMobile" : { "description" : "Indicates if [Bancontact mobile](https://docs.adyen.com/payment-methods/bancontact/bancontact-mobile) is enabled.", @@ -15419,6 +15435,7 @@ "type" : "object" }, "BillingEntitiesResponse" : { + "additionalProperties" : false, "properties" : { "data" : { "description" : "List of legal entities that can be used for the billing of orders.", @@ -15431,6 +15448,7 @@ "type" : "object" }, "BillingEntity" : { + "additionalProperties" : false, "properties" : { "address" : { "description" : "The address details of the billing entity.", @@ -15456,6 +15474,7 @@ "type" : "object" }, "CardholderReceipt" : { + "additionalProperties" : false, "properties" : { "headerForAuthorizedReceipt" : { "description" : "A custom header to show on the shopper receipt for an authorised transaction. Allows one or two comma-separated header lines, and blank lines. For example, `header,header,filler`", @@ -15465,6 +15484,7 @@ "type" : "object" }, "CartesBancairesInfo" : { + "additionalProperties" : false, "properties" : { "siret" : { "description" : "Cartes Bancaires SIRET. Format: 14 digits.", @@ -15481,6 +15501,7 @@ "type" : "object" }, "ClearpayInfo" : { + "additionalProperties" : false, "properties" : { "supportUrl" : { "description" : "Support Url", @@ -15493,6 +15514,7 @@ "type" : "object" }, "Commission" : { + "additionalProperties" : false, "properties" : { "fixedAmount" : { "description" : "A fixed commission fee, in minor units.", @@ -15508,6 +15530,7 @@ "type" : "object" }, "Company" : { + "additionalProperties" : false, "properties" : { "_links" : { "description" : "References to resources connected with this company.", @@ -15544,6 +15567,7 @@ "type" : "object" }, "CompanyApiCredential" : { + "additionalProperties" : false, "properties" : { "_links" : { "description" : "References to resources linked to the API credential.", @@ -15610,6 +15634,7 @@ "type" : "object" }, "CompanyLinks" : { + "additionalProperties" : false, "properties" : { "apiCredentials" : { "$ref" : "#/components/schemas/LinksElement" @@ -15631,6 +15656,7 @@ "type" : "object" }, "CompanyUser" : { + "additionalProperties" : false, "properties" : { "_links" : { "description" : "References to resources connected with this user.", @@ -15701,6 +15727,7 @@ "type" : "object" }, "Configuration" : { + "additionalProperties" : false, "properties" : { "brand" : { "description" : "Payment method, like **eftpos_australia** or **mc**. See the [possible values](https://docs.adyen.com/development-resources/paymentmethodvariant#management-api). ", @@ -15735,6 +15762,7 @@ "type" : "object" }, "Connectivity" : { + "additionalProperties" : false, "properties" : { "simcardStatus" : { "description" : "Indicates the status of the SIM card in the payment terminal. Can be updated and received only at terminal level, and only for models that support cellular connectivity.\n\nPossible values:\n* **ACTIVATED**: the SIM card is activated. Cellular connectivity may still need to be enabled on the terminal itself, in the **Network** settings.\n* **INVENTORY**: the SIM card is not activated. The terminal can't use cellular connectivity.", @@ -15748,6 +15776,7 @@ "type" : "object" }, "Contact" : { + "additionalProperties" : false, "properties" : { "email" : { "description" : "The individual's email address.", @@ -15773,6 +15802,7 @@ "type" : "object" }, "CreateAllowedOriginRequest" : { + "additionalProperties" : false, "properties" : { "_links" : { "description" : "References to resources linked to the allowed origin.", @@ -15794,6 +15824,7 @@ "type" : "object" }, "CreateApiCredentialResponse" : { + "additionalProperties" : false, "properties" : { "_links" : { "description" : "References to resources linked to the API credential.", @@ -15863,6 +15894,7 @@ "type" : "object" }, "CreateCompanyApiCredentialRequest" : { + "additionalProperties" : false, "properties" : { "allowedOrigins" : { "description" : "List of [allowed origins](https://docs.adyen.com/development-resources/client-side-authentication#allowed-origins) for the new API credential.", @@ -15893,6 +15925,7 @@ "type" : "object" }, "CreateCompanyApiCredentialResponse" : { + "additionalProperties" : false, "properties" : { "_links" : { "description" : "References to resources linked to the API credential.", @@ -15970,6 +16003,7 @@ "type" : "object" }, "CreateCompanyUserRequest" : { + "additionalProperties" : false, "properties" : { "accountGroups" : { "description" : "The list of [account groups](https://docs.adyen.com/account/account-structure#account-groups) associated with this user.", @@ -16021,6 +16055,7 @@ "type" : "object" }, "CreateCompanyUserResponse" : { + "additionalProperties" : false, "properties" : { "_links" : { "description" : "References to resources connected with this user.", @@ -16091,6 +16126,7 @@ "type" : "object" }, "CreateCompanyWebhookRequest" : { + "additionalProperties" : false, "properties" : { "acceptsExpiredCertificate" : { "description" : "Indicates if expired SSL certificates are accepted. Default value: **false**.", @@ -16194,6 +16230,7 @@ "type" : "object" }, "CreateMerchantApiCredentialRequest" : { + "additionalProperties" : false, "properties" : { "allowedOrigins" : { "description" : "The list of [allowed origins](https://docs.adyen.com/development-resources/client-side-authentication#allowed-origins) for the new API credential.", @@ -16217,6 +16254,7 @@ "type" : "object" }, "CreateMerchantRequest" : { + "additionalProperties" : false, "properties" : { "businessLineId" : { "description" : "The unique identifier of the [business line](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/businessLines). Required for an Adyen for Platforms Manage integration.", @@ -16257,6 +16295,7 @@ "type" : "object" }, "CreateMerchantResponse" : { + "additionalProperties" : false, "properties" : { "businessLineId" : { "description" : "The unique identifier of the [business line](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/businessLines).", @@ -16291,6 +16330,7 @@ "type" : "object" }, "CreateMerchantUserRequest" : { + "additionalProperties" : false, "properties" : { "accountGroups" : { "description" : "The list of [account groups](https://docs.adyen.com/account/account-structure#account-groups) associated with this user.", @@ -16335,6 +16375,7 @@ "type" : "object" }, "CreateMerchantWebhookRequest" : { + "additionalProperties" : false, "properties" : { "acceptsExpiredCertificate" : { "description" : "Indicates if expired SSL certificates are accepted. Default value: **false**.", @@ -16420,6 +16461,7 @@ "type" : "object" }, "CreateUserResponse" : { + "additionalProperties" : false, "properties" : { "_links" : { "description" : "References to resources connected with this user.", @@ -16483,6 +16525,7 @@ "type" : "object" }, "Currency" : { + "additionalProperties" : false, "properties" : { "amount" : { "description" : "Surcharge amount per transaction, in [minor units](https://docs.adyen.com/development-resources/currency-codes).", @@ -16505,6 +16548,7 @@ "type" : "object" }, "CustomNotification" : { + "additionalProperties" : false, "properties" : { "amount" : { "description" : "The amount of the payment that the notification is about. Set the value in [minor units](https://docs.adyen.com/development-resources/currency-codes).", @@ -16539,6 +16583,7 @@ "type" : "object" }, "DataCenter" : { + "additionalProperties" : false, "properties" : { "livePrefix" : { "description" : "The unique [live URL prefix](https://docs.adyen.com/development-resources/live-endpoints#live-url-prefix) for your live endpoint. Each data center has its own live URL prefix.\n\nThis field is empty for requests made in the test environment.", @@ -16552,6 +16597,7 @@ "type" : "object" }, "EventUrl" : { + "additionalProperties" : false, "properties" : { "eventLocalUrls" : { "description" : "One or more local URLs to send event notifications to when using Terminal API.", @@ -16571,6 +16617,7 @@ "type" : "object" }, "ExternalTerminalAction" : { + "additionalProperties" : false, "properties" : { "actionType" : { "description" : "The type of terminal action: **InstallAndroidApp**, **UninstallAndroidApp**, **InstallAndroidCertificate**, or **UninstallAndroidCertificate**.", @@ -16610,6 +16657,7 @@ "type" : "object" }, "File" : { + "additionalProperties" : false, "properties" : { "data" : { "description" : "The certificate content converted to a Base64-encoded string.", @@ -16627,6 +16675,7 @@ "type" : "object" }, "GenerateApiKeyResponse" : { + "additionalProperties" : false, "properties" : { "apiKey" : { "description" : "The generated API key.", @@ -16639,6 +16688,7 @@ "type" : "object" }, "GenerateClientKeyResponse" : { + "additionalProperties" : false, "properties" : { "clientKey" : { "description" : "Generated client key", @@ -16651,6 +16701,7 @@ "type" : "object" }, "GenerateHmacKeyResponse" : { + "additionalProperties" : false, "properties" : { "hmacKey" : { "description" : "The HMAC key generated for this webhook.", @@ -16663,6 +16714,7 @@ "type" : "object" }, "GenericPmWithTdiInfo" : { + "additionalProperties" : false, "properties" : { "transactionDescription" : { "description" : "Information regarding the transaction description.", @@ -16672,6 +16724,7 @@ "type" : "object" }, "GiroPayInfo" : { + "additionalProperties" : false, "properties" : { "supportEmail" : { "description" : "The email address of merchant support.", @@ -16684,6 +16737,7 @@ "type" : "object" }, "GooglePayInfo" : { + "additionalProperties" : false, "properties" : { "merchantId" : { "description" : "Google Pay [Merchant ID](https://support.google.com/paymentscenter/answer/7163092?hl=en). Character length and limitations: 16 alphanumeric characters or 20 numeric characters.", @@ -16702,6 +16756,7 @@ "type" : "object" }, "Gratuity" : { + "additionalProperties" : false, "properties" : { "allowCustomAmount" : { "description" : "Indicates whether one of the predefined tipping options is to let the shopper enter a custom tip. If **true**, only three of the other options defined in `predefinedTipEntries` are shown.", @@ -16726,6 +16781,7 @@ "type" : "object" }, "Hardware" : { + "additionalProperties" : false, "properties" : { "displayMaximumBackLight" : { "description" : "The brightness of the display when the terminal is being used, expressed as a percentage.", @@ -16746,6 +16802,7 @@ "type" : "object" }, "IdName" : { + "additionalProperties" : false, "properties" : { "id" : { "description" : "The identifier of the terminal model.", @@ -16795,6 +16852,7 @@ "type" : "object" }, "InvalidField" : { + "additionalProperties" : false, "properties" : { "message" : { "description" : "Description of the validation error.", @@ -16827,6 +16885,7 @@ "type" : "object" }, "Key" : { + "additionalProperties" : false, "properties" : { "identifier" : { "description" : "The unique identifier of the shared key.", @@ -16845,6 +16904,7 @@ "type" : "object" }, "KlarnaInfo" : { + "additionalProperties" : false, "properties" : { "autoCapture" : { "description" : "Indicates the status of [Automatic capture](https://docs.adyen.com/online-payments/capture#automatic-capture). Default value: **false**.", @@ -16879,6 +16939,7 @@ "type" : "object" }, "Links" : { + "additionalProperties" : false, "properties" : { "self" : { "description" : "Link to the resource itself.", @@ -16891,6 +16952,7 @@ "type" : "object" }, "LinksElement" : { + "additionalProperties" : false, "properties" : { "href" : { "type" : "string" @@ -16899,6 +16961,7 @@ "type" : "object" }, "ListCompanyApiCredentialsResponse" : { + "additionalProperties" : false, "properties" : { "_links" : { "description" : "Pagination references.", @@ -16929,6 +16992,7 @@ "type" : "object" }, "ListCompanyResponse" : { + "additionalProperties" : false, "properties" : { "_links" : { "description" : "Pagination references.", @@ -16959,6 +17023,7 @@ "type" : "object" }, "ListCompanyUsersResponse" : { + "additionalProperties" : false, "properties" : { "_links" : { "description" : "Pagination references.", @@ -16989,6 +17054,7 @@ "type" : "object" }, "ListExternalTerminalActionsResponse" : { + "additionalProperties" : false, "properties" : { "data" : { "description" : "The list of terminal actions.", @@ -17001,6 +17067,7 @@ "type" : "object" }, "ListMerchantApiCredentialsResponse" : { + "additionalProperties" : false, "properties" : { "_links" : { "description" : "Pagination references.", @@ -17031,6 +17098,7 @@ "type" : "object" }, "ListMerchantResponse" : { + "additionalProperties" : false, "properties" : { "_links" : { "description" : "Pagination references.", @@ -17061,6 +17129,7 @@ "type" : "object" }, "ListMerchantUsersResponse" : { + "additionalProperties" : false, "properties" : { "_links" : { "description" : "Pagination references.", @@ -17091,6 +17160,7 @@ "type" : "object" }, "ListStoresResponse" : { + "additionalProperties" : false, "properties" : { "_links" : { "description" : "Pagination references.", @@ -17121,6 +17191,7 @@ "type" : "object" }, "ListTerminalsResponse" : { + "additionalProperties" : false, "properties" : { "_links" : { "description" : "Pagination references.", @@ -17151,6 +17222,7 @@ "type" : "object" }, "ListWebhooksResponse" : { + "additionalProperties" : false, "properties" : { "_links" : { "description" : "Pagination references.", @@ -17185,6 +17257,7 @@ "type" : "object" }, "Localization" : { + "additionalProperties" : false, "properties" : { "language" : { "description" : "Language of the terminal.", @@ -17202,6 +17275,7 @@ "type" : "object" }, "Logo" : { + "additionalProperties" : false, "properties" : { "data" : { "description" : "The image file, converted to a Base64-encoded string, of the logo to be shown on the terminal.", @@ -17212,6 +17286,7 @@ "type" : "object" }, "MeApiCredential" : { + "additionalProperties" : false, "properties" : { "_links" : { "description" : "References to resources linked to the API credential.", @@ -17282,6 +17357,7 @@ "type" : "object" }, "MealVoucherFRInfo" : { + "additionalProperties" : false, "properties" : { "conecsId" : { "description" : "Meal Voucher conecsId. Format: digits only", @@ -17309,6 +17385,7 @@ "type" : "object" }, "Merchant" : { + "additionalProperties" : false, "properties" : { "_links" : { "description" : "References to resources connected with this merchant.", @@ -17373,6 +17450,7 @@ "type" : "object" }, "MerchantLinks" : { + "additionalProperties" : false, "properties" : { "apiCredentials" : { "$ref" : "#/components/schemas/LinksElement" @@ -17394,6 +17472,7 @@ "type" : "object" }, "MinorUnitsMonetaryValue" : { + "additionalProperties" : false, "properties" : { "amount" : { "description" : "The transaction amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).", @@ -17408,6 +17487,7 @@ "type" : "object" }, "Name" : { + "additionalProperties" : false, "properties" : { "firstName" : { "description" : "The first name.", @@ -17427,6 +17507,7 @@ "type" : "object" }, "Name2" : { + "additionalProperties" : false, "properties" : { "firstName" : { "description" : "The first name.", @@ -17442,6 +17523,7 @@ "type" : "object" }, "Nexo" : { + "additionalProperties" : false, "properties" : { "displayUrls" : { "description" : "The list of local and public URLs to send display notifications to when using Terminal API.", @@ -17473,6 +17555,7 @@ "type" : "object" }, "Notification" : { + "additionalProperties" : false, "properties" : { "category" : { "description" : "The type of event notification sent when you select the notification button.", @@ -17503,6 +17586,7 @@ "type" : "object" }, "NotificationUrl" : { + "additionalProperties" : false, "properties" : { "localUrls" : { "description" : "One or more local URLs to send notifications to when using Terminal API.", @@ -17522,6 +17606,7 @@ "type" : "object" }, "OfflineProcessing" : { + "additionalProperties" : false, "properties" : { "chipFloorLimit" : { "description" : "The maximum offline transaction amount for chip cards, in the processing currency and specified in [minor units](https://docs.adyen.com/development-resources/currency-codes).", @@ -17539,6 +17624,7 @@ "type" : "object" }, "Opi" : { + "additionalProperties" : false, "properties" : { "enablePayAtTable" : { "description" : "Indicates if Pay at table is enabled.", @@ -17556,6 +17642,7 @@ "type" : "object" }, "OrderItem" : { + "additionalProperties" : false, "properties" : { "id" : { "description" : "The unique identifier of the product.", @@ -17579,6 +17666,7 @@ "type" : "object" }, "PaginationLinks" : { + "additionalProperties" : false, "properties" : { "first" : { "description" : "The first page.", @@ -17609,6 +17697,7 @@ "type" : "object" }, "Passcodes" : { + "additionalProperties" : false, "properties" : { "adminMenuPin" : { "description" : "The passcode for the Admin menu and the Settings menu.", @@ -17635,6 +17724,7 @@ "type" : "object" }, "PayAtTable" : { + "additionalProperties" : false, "properties" : { "authenticationMethod" : { "description" : "Allowed authentication methods: Magswipe, Manual Entry.", @@ -17661,6 +17751,7 @@ "type" : "object" }, "PayPalInfo" : { + "additionalProperties" : false, "properties" : { "directCapture" : { "description" : "Indicates if direct (immediate) capture for PayPal is enabled. If set to **true**, this setting overrides the [capture](https://docs.adyen.com/online-payments/capture) settings of your merchant account. Default value: **true**.", @@ -17684,6 +17775,7 @@ "type" : "object" }, "Payment" : { + "additionalProperties" : false, "properties" : { "contactlessCurrency" : { "description" : "The default currency for contactless payments on the payment terminal, as the three-letter [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code.", @@ -17702,6 +17794,7 @@ "type" : "object" }, "PaymentMethod" : { + "additionalProperties" : false, "properties" : { "afterpayTouch" : { "description" : "Afterpay Touch details.", @@ -17874,6 +17967,7 @@ "type" : "object" }, "PaymentMethodResponse" : { + "additionalProperties" : false, "properties" : { "_links" : { "description" : "Pagination references.", @@ -17962,6 +18056,7 @@ "type" : "object" }, "PaymentMethodSetupInfo" : { + "additionalProperties" : false, "properties" : { "afterpayTouch" : { "description" : "Afterpay Touch details.", @@ -18176,6 +18271,7 @@ } }, "PayoutSettings" : { + "additionalProperties" : false, "properties" : { "allowed" : { "description" : "Indicates if payouts to the bank account are allowed. This value is set automatically based on the status of the verification process. The value is:\n\n* **true** if `verificationStatus` is **valid**.\n* **false** for all other values.", @@ -18224,6 +18320,7 @@ "type" : "object" }, "PayoutSettingsRequest" : { + "additionalProperties" : false, "properties" : { "enabled" : { "description" : "Indicates if payouts to this bank account are enabled. Default: **true**.\n\nTo receive payouts into this bank account, both `enabled` and `allowed` must be **true**.", @@ -18244,6 +18341,7 @@ "type" : "object" }, "PayoutSettingsResponse" : { + "additionalProperties" : false, "properties" : { "data" : { "description" : "The list of payout accounts.", @@ -18256,6 +18354,7 @@ "type" : "object" }, "Profile" : { + "additionalProperties" : false, "properties" : { "authType" : { "description" : "The type of Wi-Fi network. Possible values: **wpa-psk**, **wpa2-psk**, **wpa-eap**, **wpa2-eap**.", @@ -18340,6 +18439,7 @@ "type" : "object" }, "ReceiptOptions" : { + "additionalProperties" : false, "properties" : { "logo" : { "description" : "The receipt logo converted to a Base64-encoded string. The image must be a .bmp file of < 256 KB, dimensions 240 (H) x 384 (W) px.", @@ -18358,6 +18458,7 @@ "type" : "object" }, "ReceiptPrinting" : { + "additionalProperties" : false, "properties" : { "merchantApproved" : { "description" : "Print a merchant receipt when the payment is approved.", @@ -18427,6 +18528,7 @@ "type" : "object" }, "Referenced" : { + "additionalProperties" : false, "properties" : { "enableStandaloneRefunds" : { "description" : "Indicates whether referenced refunds are enabled on the standalone terminal.", @@ -18436,6 +18538,7 @@ "type" : "object" }, "Refunds" : { + "additionalProperties" : false, "properties" : { "referenced" : { "description" : "Settings for referenced refunds.", @@ -18463,6 +18566,7 @@ "type" : "object" }, "RequestActivationResponse" : { + "additionalProperties" : false, "properties" : { "companyId" : { "description" : "The unique identifier of the company account.", @@ -18476,6 +18580,7 @@ "type" : "object" }, "RestServiceError" : { + "additionalProperties" : false, "properties" : { "detail" : { "description" : "A human-readable explanation specific to this occurrence of the problem.", @@ -18528,6 +18633,7 @@ "type" : "object" }, "ScheduleTerminalActionsRequest" : { + "additionalProperties" : false, "properties" : { "actionDetails" : { "description" : "Information about the action to take.", @@ -18568,6 +18674,7 @@ "type" : "object" }, "ScheduleTerminalActionsResponse" : { + "additionalProperties" : false, "properties" : { "actionDetails" : { "description" : "Information about the action to take.", @@ -18639,6 +18746,7 @@ "type" : "object" }, "Settings" : { + "additionalProperties" : false, "properties" : { "band" : { "description" : "The preferred Wi-Fi band, for use if the terminals support multiple bands. Possible values: All, 2.4GHz, 5GHz.", @@ -18657,6 +18765,7 @@ "type" : "object" }, "ShippingLocation" : { + "additionalProperties" : false, "properties" : { "address" : { "description" : "The address details of the shipping location.", @@ -18678,6 +18787,7 @@ "type" : "object" }, "ShippingLocationsResponse" : { + "additionalProperties" : false, "properties" : { "data" : { "description" : "Physical locations where orders can be shipped to.", @@ -18690,6 +18800,7 @@ "type" : "object" }, "Signature" : { + "additionalProperties" : false, "properties" : { "askSignatureOnScreen" : { "description" : "If `skipSignature` is false, indicates whether the shopper should provide a signature on the display (**true**) or on the merchant receipt (**false**).", @@ -18712,6 +18823,7 @@ "type" : "object" }, "SofortInfo" : { + "additionalProperties" : false, "properties" : { "currencyCode" : { "description" : "Sofort currency code. For example, **EUR**.", @@ -18729,6 +18841,7 @@ "type" : "object" }, "SplitConfiguration" : { + "additionalProperties" : false, "properties" : { "description" : { "description" : "Your description for the split configuration.", @@ -18763,6 +18876,7 @@ "type" : "object" }, "SplitConfigurationList" : { + "additionalProperties" : false, "properties" : { "data" : { "description" : "List of split configurations applied to the stores under the merchant account.", @@ -18775,6 +18889,7 @@ "type" : "object" }, "SplitConfigurationLogic" : { + "additionalProperties" : false, "properties" : { "acquiringFees" : { "description" : "Deducts the acquiring fees (the aggregated amount of interchange and scheme fee) from the specified balance account.\n\nPossible values: **deductFromLiableAccount**, **deductFromOneBalanceAccount**.", @@ -18842,7 +18957,7 @@ "type" : "string" }, "paymentFee" : { - "description" : "Deducts all transaction fees incurred by the payment from the specified balance account. The transaction fees include the acquiring fees (interchange and scheme fee), and the fees due to Adyen (markup or commission). You can book any and all these fees to different balance account by specifying other transaction fee parameters in your split configuration profile:\n\n- [`adyenCommission`](https://docs.adyen.com/api-explorer/Management/latest/post/merchants/(merchantId)/splitConfigurations#request-rules-splitLogic-adyenCommission): The transaction fee due to Adyen under [blended rates](https://www.adyen.com/knowledge-hub/guides/payments-training-guide/get-the-best-from-your-card-processing).\n- [`adyenMarkup`](https://docs.adyen.com/api-explorer/Management/latest/post/merchants/(merchantId)/splitConfigurations#request-rules-splitLogic-adyenMarkup): The transaction fee due to Adyen under [Interchange ++ pricing](https://www.adyen.com/what-is-interchange).\n- [`schemeFee`](https://docs.adyen.com/api-explorer/Management/latest/post/merchants/(merchantId)/splitConfigurations#request-rules-splitLogic-schemeFee): The fee paid to the card scheme for using their network.\n- [`interchange`](https://docs.adyen.com/api-explorer/Management/latest/post/merchants/(merchantId)/splitConfigurations#request-rules-splitLogic-interchange): The fee paid to the issuer for each payment transaction made with the card network.\n- [`adyenFees`](https://docs.adyen.com/api-explorer/Management/latest/post/merchants/(merchantId)/splitConfigurations#request-rules-splitLogic-adyenFees): The aggregated amount of Adyen's commission and markup.\n- [`acquiringFees`](https://docs.adyen.com/api-explorer/Management/latest/post/merchants/(merchantId)/splitConfigurations#request-rules-splitLogic-acquiringFees): The aggregated amount of the interchange and scheme fees.\n\nIf you don't include at least one transaction fee type in the `splitLogic` object, Adyen updates the payment request with the `paymentFee` parameter, booking all transaction fees to your platform's liable balance account.\n\nPossible values: **deductFromLiableAccount**, **deductFromOneBalanceAccount**.", + "description" : "Deducts all transaction fees incurred by the payment from the specified balance account. The transaction fees include the acquiring fees (interchange and scheme fee), and the fees due to Adyen (markup or commission). You can book any and all these fees to different balance account by specifying other transaction fee parameters in your split configuration profile:\n\n- [`adyenCommission`](https://docs.adyen.com/api-explorer/Management/latest/post/merchants/(merchantId)/splitConfigurations#request-rules-splitLogic-adyenCommission): The transaction fee due to Adyen under [blended rates](https://www.adyen.com/knowledge-hub/interchange-fees-explained#interchange-vs-blended).\n- [`adyenMarkup`](https://docs.adyen.com/api-explorer/Management/latest/post/merchants/(merchantId)/splitConfigurations#request-rules-splitLogic-adyenMarkup): The transaction fee due to Adyen under [Interchange ++ pricing](https://www.adyen.com/knowledge-hub/interchange-fees-explained#interchange-vs-blended).\n- [`schemeFee`](https://docs.adyen.com/api-explorer/Management/latest/post/merchants/(merchantId)/splitConfigurations#request-rules-splitLogic-schemeFee): The fee paid to the card scheme for using their network.\n- [`interchange`](https://docs.adyen.com/api-explorer/Management/latest/post/merchants/(merchantId)/splitConfigurations#request-rules-splitLogic-interchange): The fee paid to the issuer for each payment transaction made with the card network.\n- [`adyenFees`](https://docs.adyen.com/api-explorer/Management/latest/post/merchants/(merchantId)/splitConfigurations#request-rules-splitLogic-adyenFees): The aggregated amount of Adyen's commission and markup.\n- [`acquiringFees`](https://docs.adyen.com/api-explorer/Management/latest/post/merchants/(merchantId)/splitConfigurations#request-rules-splitLogic-acquiringFees): The aggregated amount of the interchange and scheme fees.\n\nIf you don't include at least one transaction fee type in the `splitLogic` object, Adyen updates the payment request with the `paymentFee` parameter, booking all transaction fees to your platform's liable balance account.\n\nPossible values: **deductFromLiableAccount**, **deductFromOneBalanceAccount**.", "enum" : [ "deductFromLiableAccount", "deductFromOneBalanceAccount" @@ -18858,6 +18973,14 @@ ], "type" : "string" }, + "refundCostAllocation" : { + "description" : "Deducts the refund costs from the specified balance account.\n\nPossible values: **deductFromLiableAccount**, **deductFromOneBalanceAccount**", + "enum" : [ + "deductFromLiableAccount", + "deductFromOneBalanceAccount" + ], + "type" : "string" + }, "remainder" : { "description" : "Books the amount left over after currency conversion to the specified balance account.\n\nPossible values: **addToLiableAccount**, **addToOneBalanceAccount**.", "enum" : [ @@ -18902,6 +19025,7 @@ "type" : "object" }, "SplitConfigurationRule" : { + "additionalProperties" : false, "properties" : { "currency" : { "description" : "The currency condition that defines whether the split logic applies.\nIts value must be a three-character [ISO currency code](https://en.wikipedia.org/wiki/ISO_4217).", @@ -18950,6 +19074,7 @@ "type" : "object" }, "Standalone" : { + "additionalProperties" : false, "properties" : { "currencyCode" : { "description" : "The default currency of the standalone payment terminal as an [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code.", @@ -18965,6 +19090,7 @@ "type" : "object" }, "Store" : { + "additionalProperties" : false, "properties" : { "_links" : { "description" : "Reference to resources connected with the store.", @@ -19025,7 +19151,30 @@ }, "type" : "object" }, + "StoreAndForward" : { + "additionalProperties" : false, + "properties" : { + "maxAmount" : { + "description" : "The maximum amount that the terminal accepts for a single store-and-forward payment.", + "items" : { + "$ref" : "#/components/schemas/MinorUnitsMonetaryValue" + }, + "type" : "array" + }, + "maxPayments" : { + "description" : "The maximum number of store-and-forward transactions per terminal that you can process while offline.", + "format" : "int32", + "type" : "integer" + }, + "supportedCardTypes" : { + "description" : "The type of card for which the terminal accepts store-and-forward payments. You can specify multiple card types. ", + "$ref" : "#/components/schemas/SupportedCardTypes" + } + }, + "type" : "object" + }, "StoreCreationRequest" : { + "additionalProperties" : false, "properties" : { "address" : { "description" : "The address of the store.", @@ -19072,6 +19221,7 @@ "type" : "object" }, "StoreCreationWithMerchantCodeRequest" : { + "additionalProperties" : false, "properties" : { "address" : { "description" : "The address of the store.", @@ -19123,6 +19273,7 @@ "type" : "object" }, "StoreLocation" : { + "additionalProperties" : false, "properties" : { "city" : { "description" : "The name of the city.", @@ -19159,6 +19310,7 @@ "type" : "object" }, "StoreSplitConfiguration" : { + "additionalProperties" : false, "properties" : { "balanceAccountId" : { "description" : "The [unique identifier of the balance account](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/get/balanceAccounts/{id}__queryParam_id) to which the split amount must be booked, depending on the defined [split logic](https://docs.adyen.com/api-explorer/Management/latest/post/merchants/_merchantId_/splitConfigurations#request-rules-splitLogic).", @@ -19171,7 +19323,34 @@ }, "type" : "object" }, + "SupportedCardTypes" : { + "additionalProperties" : false, + "properties" : { + "credit" : { + "description" : "Set to **true** to accept credit cards.", + "type" : "boolean" + }, + "debit" : { + "description" : "Set to **true** to accept debit cards.", + "type" : "boolean" + }, + "deferredDebit" : { + "description" : "Set to **true** to accept cards that allow deferred debit.", + "type" : "boolean" + }, + "prepaid" : { + "description" : "Set to **true** to accept prepaid cards.", + "type" : "boolean" + }, + "unknown" : { + "description" : "Set to **true** to accept card types for which the terminal can't determine the funding source while offline.", + "type" : "boolean" + } + }, + "type" : "object" + }, "Surcharge" : { + "additionalProperties" : false, "properties" : { "askConfirmation" : { "description" : "Show the surcharge details on the terminal, so the shopper can confirm.", @@ -19188,6 +19367,7 @@ "type" : "object" }, "SwishInfo" : { + "additionalProperties" : false, "properties" : { "swishNumber" : { "description" : "Swish number. Format: 10 digits without spaces. For example, **1231111111**.", @@ -19202,6 +19382,7 @@ "type" : "object" }, "TapToPay" : { + "additionalProperties" : false, "properties" : { "merchantDisplayName" : { "description" : "The text shown on the screen during the Tap to Pay transaction.", @@ -19211,6 +19392,7 @@ "type" : "object" }, "Terminal" : { + "additionalProperties" : false, "properties" : { "assigned" : { "deprecated" : true, @@ -19325,6 +19507,7 @@ "type" : "object" }, "TerminalActionScheduleDetail" : { + "additionalProperties" : false, "properties" : { "id" : { "description" : "The ID of the action on the specified terminal.", @@ -19338,6 +19521,7 @@ "type" : "object" }, "TerminalInstructions" : { + "additionalProperties" : false, "properties" : { "adyenAppRestart" : { "description" : "Indicates whether the Adyen app on the payment terminal restarts automatically when the configuration is updated.", @@ -19347,6 +19531,7 @@ "type" : "object" }, "TerminalModelsResponse" : { + "additionalProperties" : false, "properties" : { "data" : { "description" : "The terminal models that the API credential has access to.", @@ -19359,6 +19544,7 @@ "type" : "object" }, "TerminalOrder" : { + "additionalProperties" : false, "properties" : { "billingEntity" : { "description" : "The details of the entity that the order is billed to.", @@ -19399,6 +19585,7 @@ "type" : "object" }, "TerminalOrderRequest" : { + "additionalProperties" : false, "properties" : { "billingEntityId" : { "description" : "The identification of the billing entity to use for the order.", @@ -19431,6 +19618,7 @@ "type" : "object" }, "TerminalOrdersResponse" : { + "additionalProperties" : false, "properties" : { "data" : { "description" : "List of orders for payment terminal packages and parts.", @@ -19443,6 +19631,7 @@ "type" : "object" }, "TerminalProduct" : { + "additionalProperties" : false, "properties" : { "description" : { "description" : "Information about items included and integration options.", @@ -19471,6 +19660,7 @@ "type" : "object" }, "TerminalProductPrice" : { + "additionalProperties" : false, "properties" : { "currency" : { "description" : "The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes).", @@ -19485,6 +19675,7 @@ "type" : "object" }, "TerminalProductsResponse" : { + "additionalProperties" : false, "properties" : { "data" : { "description" : "Terminal products that can be ordered.", @@ -19497,6 +19688,7 @@ "type" : "object" }, "TerminalSettings" : { + "additionalProperties" : false, "properties" : { "cardholderReceipt" : { "description" : "Settings to define the header of the shopper receipt.", @@ -19565,6 +19757,10 @@ "description" : "Settings for [standalone](https://docs.adyen.com/point-of-sale/standalone/standalone-build/set-up-standalone#set-up-standalone-using-an-api-call) features.", "$ref" : "#/components/schemas/Standalone" }, + "storeAndForward" : { + "description" : "Settings for store-and-forward offline payments. The maxAmount, maxPayments, and supportedCardTypes parameters must be configured, either in the request or inherited from a higher level in your account structure.", + "$ref" : "#/components/schemas/StoreAndForward" + }, "surcharge" : { "description" : "Settings for payment [surcharge](https://docs.adyen.com/point-of-sale/surcharge) features.", "$ref" : "#/components/schemas/Surcharge" @@ -19589,6 +19785,7 @@ "type" : "object" }, "TestCompanyWebhookRequest" : { + "additionalProperties" : false, "properties" : { "merchantIds" : { "description" : "List of `merchantId` values for which test webhooks will be sent. The list can have a maximum of 20 `merchantId` values.\n\nIf not specified, we send sample notifications to all the merchant accounts that the webhook is configured for. If this is more than 20 merchant accounts, use this list to specify a subset of the merchant accounts for which to send test notifications.", @@ -19612,6 +19809,7 @@ "type" : "object" }, "TestOutput" : { + "additionalProperties" : false, "properties" : { "merchantId" : { "description" : "Unique identifier of the merchant account that the notification is about.", @@ -19645,6 +19843,7 @@ "type" : "object" }, "TestWebhookRequest" : { + "additionalProperties" : false, "properties" : { "notification" : { "description" : "Custom test notification object. Required when the [`types`](https://docs.adyen.com/api-explorer/#/ManagementService/v1/post/companies/{companyId}/webhooks/{webhookId}/test__reqParam_types) list contains **CUSTOM**.", @@ -19661,6 +19860,7 @@ "type" : "object" }, "TestWebhookResponse" : { + "additionalProperties" : false, "properties" : { "data" : { "description" : "List with test results. Each test webhook we send has a list element with the result.", @@ -19673,6 +19873,7 @@ "type" : "object" }, "Timeouts" : { + "additionalProperties" : false, "properties" : { "fromActiveToSleep" : { "description" : "Indicates the number of seconds of inactivity after which the terminal display goes into sleep mode.", @@ -19683,6 +19884,7 @@ "type" : "object" }, "TransactionDescriptionInfo" : { + "additionalProperties" : false, "properties" : { "doingBusinessAsName" : { "description" : "The text to be shown on the shopper's bank statement.\n We recommend sending a maximum of 22 characters, otherwise banks might truncate the string.\n Allowed characters: **a-z**, **A-Z**, **0-9**, spaces, and special characters **. , ' _ - ? + * /**.", @@ -19703,6 +19905,7 @@ "type" : "object" }, "TwintInfo" : { + "additionalProperties" : false, "properties" : { "logo" : { "description" : "Twint logo. Format: Base64-encoded string.", @@ -19751,6 +19954,7 @@ "type" : "object" }, "UpdatableAddress" : { + "additionalProperties" : false, "properties" : { "city" : { "description" : "The name of the city.", @@ -19780,6 +19984,7 @@ "type" : "object" }, "UpdateCompanyApiCredentialRequest" : { + "additionalProperties" : false, "properties" : { "active" : { "description" : "Indicates if the API credential is enabled.", @@ -19814,6 +20019,7 @@ "type" : "object" }, "UpdateCompanyUserRequest" : { + "additionalProperties" : false, "properties" : { "accountGroups" : { "description" : "The list of [account groups](https://docs.adyen.com/account/account-structure#account-groups) associated with this user.", @@ -19858,6 +20064,7 @@ "type" : "object" }, "UpdateCompanyWebhookRequest" : { + "additionalProperties" : false, "properties" : { "acceptsExpiredCertificate" : { "description" : "Indicates if expired SSL certificates are accepted. Default value: **false**.", @@ -19949,6 +20156,7 @@ "type" : "object" }, "UpdateMerchantApiCredentialRequest" : { + "additionalProperties" : false, "properties" : { "active" : { "description" : "Indicates if the API credential is enabled.", @@ -19976,6 +20184,7 @@ "type" : "object" }, "UpdateMerchantUserRequest" : { + "additionalProperties" : false, "properties" : { "accountGroups" : { "description" : "The list of [account groups](https://docs.adyen.com/account/account-structure#account-groups) associated with this user.", @@ -20013,6 +20222,7 @@ "type" : "object" }, "UpdateMerchantWebhookRequest" : { + "additionalProperties" : false, "properties" : { "acceptsExpiredCertificate" : { "description" : "Indicates if expired SSL certificates are accepted. Default value: **false**.", @@ -20088,6 +20298,7 @@ "type" : "object" }, "UpdatePaymentMethodInfo" : { + "additionalProperties" : false, "properties" : { "bcmc" : { "description" : "Bancontact details.", @@ -20177,6 +20388,7 @@ "type" : "object" }, "UpdatePayoutSettingsRequest" : { + "additionalProperties" : false, "properties" : { "enabled" : { "description" : "Indicates if payouts to this bank account are enabled. Default: **true**.\n\nTo receive payouts into this bank account, both `enabled` and `allowed` must be **true**.", @@ -20186,6 +20398,7 @@ "type" : "object" }, "UpdateSplitConfigurationLogicRequest" : { + "additionalProperties" : false, "properties" : { "acquiringFees" : { "description" : "Deducts the acquiring fees (the aggregated amount of interchange and scheme fee) from the specified balance account.\n\nPossible values: **deductFromLiableAccount**, **deductFromOneBalanceAccount**.", @@ -20253,7 +20466,7 @@ "type" : "string" }, "paymentFee" : { - "description" : "Deducts all transaction fees incurred by the payment from the specified balance account. The transaction fees include the acquiring fees (interchange and scheme fee), and the fees due to Adyen (markup or commission). You can book any and all these fees to different balance account by specifying other transaction fee parameters in your split configuration profile:\n\n- [`adyenCommission`](https://docs.adyen.com/api-explorer/Management/latest/post/merchants/(merchantId)/splitConfigurations#request-rules-splitLogic-adyenCommission): The transaction fee due to Adyen under [blended rates](https://www.adyen.com/knowledge-hub/guides/payments-training-guide/get-the-best-from-your-card-processing).\n- [`adyenMarkup`](https://docs.adyen.com/api-explorer/Management/latest/post/merchants/(merchantId)/splitConfigurations#request-rules-splitLogic-adyenMarkup): The transaction fee due to Adyen under [Interchange ++ pricing](https://www.adyen.com/what-is-interchange).\n- [`schemeFee`](https://docs.adyen.com/api-explorer/Management/latest/post/merchants/(merchantId)/splitConfigurations#request-rules-splitLogic-schemeFee): The fee paid to the card scheme for using their network.\n- [`interchange`](https://docs.adyen.com/api-explorer/Management/latest/post/merchants/(merchantId)/splitConfigurations#request-rules-splitLogic-interchange): The fee paid to the issuer for each payment transaction made with the card network.\n- [`adyenFees`](https://docs.adyen.com/api-explorer/Management/latest/post/merchants/(merchantId)/splitConfigurations#request-rules-splitLogic-adyenFees): The aggregated amount of Adyen's commission and markup.\n- [`acquiringFees`](https://docs.adyen.com/api-explorer/Management/latest/post/merchants/(merchantId)/splitConfigurations#request-rules-splitLogic-acquiringFees): The aggregated amount of the interchange and scheme fees.\n\nIf you don't include at least one transaction fee type in the `splitLogic` object, Adyen updates the payment request with the `paymentFee` parameter, booking all transaction fees to your platform's liable balance account.\n\nPossible values: **deductFromLiableAccount**, **deductFromOneBalanceAccount**.", + "description" : "Deducts all transaction fees incurred by the payment from the specified balance account. The transaction fees include the acquiring fees (interchange and scheme fee), and the fees due to Adyen (markup or commission). You can book any and all these fees to different balance account by specifying other transaction fee parameters in your split configuration profile:\n\n- [`adyenCommission`](https://docs.adyen.com/api-explorer/Management/latest/post/merchants/(merchantId)/splitConfigurations#request-rules-splitLogic-adyenCommission): The transaction fee due to Adyen under [blended rates](https://www.adyen.com/knowledge-hub/interchange-fees-explained#interchange-vs-blended).\n- [`adyenMarkup`](https://docs.adyen.com/api-explorer/Management/latest/post/merchants/(merchantId)/splitConfigurations#request-rules-splitLogic-adyenMarkup): The transaction fee due to Adyen under [Interchange ++ pricing](https://www.adyen.com/knowledge-hub/interchange-fees-explained#interchange-vs-blended).\n- [`schemeFee`](https://docs.adyen.com/api-explorer/Management/latest/post/merchants/(merchantId)/splitConfigurations#request-rules-splitLogic-schemeFee): The fee paid to the card scheme for using their network.\n- [`interchange`](https://docs.adyen.com/api-explorer/Management/latest/post/merchants/(merchantId)/splitConfigurations#request-rules-splitLogic-interchange): The fee paid to the issuer for each payment transaction made with the card network.\n- [`adyenFees`](https://docs.adyen.com/api-explorer/Management/latest/post/merchants/(merchantId)/splitConfigurations#request-rules-splitLogic-adyenFees): The aggregated amount of Adyen's commission and markup.\n- [`acquiringFees`](https://docs.adyen.com/api-explorer/Management/latest/post/merchants/(merchantId)/splitConfigurations#request-rules-splitLogic-acquiringFees): The aggregated amount of the interchange and scheme fees.\n\nIf you don't include at least one transaction fee type in the `splitLogic` object, Adyen updates the payment request with the `paymentFee` parameter, booking all transaction fees to your platform's liable balance account.\n\nPossible values: **deductFromLiableAccount**, **deductFromOneBalanceAccount**.", "enum" : [ "deductFromLiableAccount", "deductFromOneBalanceAccount" @@ -20269,6 +20482,14 @@ ], "type" : "string" }, + "refundCostAllocation" : { + "description" : "Deducts the refund costs from the specified balance account.\n\nPossible values: **deductFromLiableAccount**, **deductFromOneBalanceAccount**", + "enum" : [ + "deductFromLiableAccount", + "deductFromOneBalanceAccount" + ], + "type" : "string" + }, "remainder" : { "description" : "Books the amount left over after currency conversion to the specified balance account.\n\nPossible values: **addToLiableAccount**, **addToOneBalanceAccount**.", "enum" : [ @@ -20313,6 +20534,7 @@ "type" : "object" }, "UpdateSplitConfigurationRequest" : { + "additionalProperties" : false, "properties" : { "description" : { "description" : "Your description for the split configuration.", @@ -20326,6 +20548,7 @@ "type" : "object" }, "UpdateSplitConfigurationRuleRequest" : { + "additionalProperties" : false, "properties" : { "currency" : { "description" : "The currency condition that defines whether the split logic applies.\nIts value must be a three-character [ISO currency code](https://en.wikipedia.org/wiki/ISO_4217).", @@ -20352,6 +20575,7 @@ "type" : "object" }, "UpdateStoreRequest" : { + "additionalProperties" : false, "properties" : { "address" : { "description" : "The address of the store. It is not possible to update the country of the store.", @@ -20393,6 +20617,7 @@ "type" : "object" }, "Url" : { + "additionalProperties" : false, "properties" : { "encrypted" : { "description" : "Indicates if the message sent to this URL should be encrypted.", @@ -20414,6 +20639,7 @@ "type" : "object" }, "User" : { + "additionalProperties" : false, "properties" : { "_links" : { "description" : "References to resources connected with this user.", @@ -20477,6 +20703,7 @@ "type" : "object" }, "VippsInfo" : { + "additionalProperties" : false, "properties" : { "logo" : { "description" : "Vipps logo. Format: Base64-encoded string.", @@ -20493,6 +20720,7 @@ "type" : "object" }, "Webhook" : { + "additionalProperties" : false, "properties" : { "_links" : { "description" : "References to resources connected with this webhook.", @@ -20617,6 +20845,7 @@ "type" : "object" }, "WebhookLinks" : { + "additionalProperties" : false, "properties" : { "company" : { "description" : "The company account that the webhook is configured for. Only present for company-level webhooks.", @@ -20647,6 +20876,7 @@ "type" : "object" }, "WifiProfiles" : { + "additionalProperties" : false, "properties" : { "profiles" : { "description" : "List of remote Wi-Fi profiles.", diff --git a/json/ManagementService-v3.json b/json/ManagementService-v3.json index d3d20d7b..60a6327d 100644 --- a/json/ManagementService-v3.json +++ b/json/ManagementService-v3.json @@ -15226,6 +15226,7 @@ "components" : { "schemas" : { "AdditionalCommission" : { + "additionalProperties" : false, "properties" : { "balanceAccountId" : { "description" : "Unique identifier of the balance account to which the additional commission is booked.", @@ -15245,6 +15246,7 @@ "type" : "object" }, "AdditionalSettings" : { + "additionalProperties" : false, "properties" : { "includeEventCodes" : { "description" : "Object containing list of event codes for which the notifcation will be sent. ", @@ -15264,6 +15266,7 @@ "type" : "object" }, "AdditionalSettingsResponse" : { + "additionalProperties" : false, "properties" : { "excludeEventCodes" : { "description" : "Object containing list of event codes for which the notifcation will not be sent. ", @@ -15290,6 +15293,7 @@ "type" : "object" }, "Address" : { + "additionalProperties" : false, "properties" : { "city" : { "description" : "The name of the city.", @@ -15323,6 +15327,7 @@ "type" : "object" }, "AfterpayTouchInfo" : { + "additionalProperties" : false, "properties" : { "supportUrl" : { "description" : "Support Url", @@ -15335,6 +15340,7 @@ "type" : "object" }, "AllowedOrigin" : { + "additionalProperties" : false, "properties" : { "_links" : { "description" : "References to resources linked to the allowed origin.", @@ -15356,6 +15362,7 @@ "type" : "object" }, "AllowedOriginsResponse" : { + "additionalProperties" : false, "properties" : { "data" : { "description" : "List of allowed origins.", @@ -15368,6 +15375,7 @@ "type" : "object" }, "Amount" : { + "additionalProperties" : false, "properties" : { "currency" : { "description" : "The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes).", @@ -15388,6 +15396,7 @@ "type" : "object" }, "AndroidApp" : { + "additionalProperties" : false, "properties" : { "description" : { "description" : "The description that was provided when uploading the app. The description is not shown on the terminal.", @@ -15430,6 +15439,7 @@ "type" : "object" }, "AndroidAppsResponse" : { + "additionalProperties" : false, "properties" : { "data" : { "description" : "Apps uploaded for Android payment terminals.", @@ -15442,6 +15452,7 @@ "type" : "object" }, "AndroidCertificate" : { + "additionalProperties" : false, "properties" : { "description" : { "description" : "The description that was provided when uploading the certificate.", @@ -15480,6 +15491,7 @@ "type" : "object" }, "AndroidCertificatesResponse" : { + "additionalProperties" : false, "properties" : { "data" : { "description" : "Uploaded Android certificates for Android payment terminals.", @@ -15492,6 +15504,7 @@ "type" : "object" }, "ApiCredential" : { + "additionalProperties" : false, "properties" : { "_links" : { "description" : "References to resources linked to the API credential.", @@ -15551,6 +15564,7 @@ "type" : "object" }, "ApiCredentialLinks" : { + "additionalProperties" : false, "properties" : { "allowedOrigins" : { "description" : "List of allowed origins.", @@ -15583,6 +15597,7 @@ "type" : "object" }, "ApplePayInfo" : { + "additionalProperties" : false, "properties" : { "domains" : { "description" : "The list of merchant domains. Maximum: 99 domains per request.\n\nFor more information, see [Apple Pay documentation](https://docs.adyen.com/payment-methods/apple-pay/web-drop-in?tab=adyen-certificate-live_1#going-live).", @@ -15598,6 +15613,7 @@ "type" : "object" }, "BcmcInfo" : { + "additionalProperties" : false, "properties" : { "enableBcmcMobile" : { "description" : "Indicates if [Bancontact mobile](https://docs.adyen.com/payment-methods/bancontact/bancontact-mobile) is enabled.", @@ -15611,6 +15627,7 @@ "type" : "object" }, "BillingEntitiesResponse" : { + "additionalProperties" : false, "properties" : { "data" : { "description" : "List of legal entities that can be used for the billing of orders.", @@ -15623,6 +15640,7 @@ "type" : "object" }, "BillingEntity" : { + "additionalProperties" : false, "properties" : { "address" : { "description" : "The address details of the billing entity.", @@ -15648,6 +15666,7 @@ "type" : "object" }, "CardholderReceipt" : { + "additionalProperties" : false, "properties" : { "headerForAuthorizedReceipt" : { "description" : "A custom header to show on the shopper receipt for an authorised transaction. Allows one or two comma-separated header lines, and blank lines. For example, `header,header,filler`", @@ -15657,6 +15676,7 @@ "type" : "object" }, "CartesBancairesInfo" : { + "additionalProperties" : false, "properties" : { "siret" : { "description" : "Cartes Bancaires SIRET. Format: 14 digits.", @@ -15673,6 +15693,7 @@ "type" : "object" }, "ClearpayInfo" : { + "additionalProperties" : false, "properties" : { "supportUrl" : { "description" : "Support Url", @@ -15685,6 +15706,7 @@ "type" : "object" }, "Commission" : { + "additionalProperties" : false, "properties" : { "fixedAmount" : { "description" : "A fixed commission fee, in minor units.", @@ -15700,6 +15722,7 @@ "type" : "object" }, "Company" : { + "additionalProperties" : false, "properties" : { "_links" : { "description" : "References to resources connected with this company.", @@ -15736,6 +15759,7 @@ "type" : "object" }, "CompanyApiCredential" : { + "additionalProperties" : false, "properties" : { "_links" : { "description" : "References to resources linked to the API credential.", @@ -15802,6 +15826,7 @@ "type" : "object" }, "CompanyLinks" : { + "additionalProperties" : false, "properties" : { "apiCredentials" : { "$ref" : "#/components/schemas/LinksElement" @@ -15823,6 +15848,7 @@ "type" : "object" }, "CompanyUser" : { + "additionalProperties" : false, "properties" : { "_links" : { "description" : "References to resources connected with this user.", @@ -15893,6 +15919,7 @@ "type" : "object" }, "Configuration" : { + "additionalProperties" : false, "properties" : { "brand" : { "description" : "Payment method, like **eftpos_australia** or **mc**. See the [possible values](https://docs.adyen.com/development-resources/paymentmethodvariant#management-api). ", @@ -15927,6 +15954,7 @@ "type" : "object" }, "Connectivity" : { + "additionalProperties" : false, "properties" : { "simcardStatus" : { "description" : "Indicates the status of the SIM card in the payment terminal. Can be updated and received only at terminal level, and only for models that support cellular connectivity.\n\nPossible values:\n* **ACTIVATED**: the SIM card is activated. Cellular connectivity may still need to be enabled on the terminal itself, in the **Network** settings.\n* **INVENTORY**: the SIM card is not activated. The terminal can't use cellular connectivity.", @@ -15940,6 +15968,7 @@ "type" : "object" }, "Contact" : { + "additionalProperties" : false, "properties" : { "email" : { "description" : "The individual's email address.", @@ -15965,6 +15994,7 @@ "type" : "object" }, "CreateAllowedOriginRequest" : { + "additionalProperties" : false, "properties" : { "_links" : { "description" : "References to resources linked to the allowed origin.", @@ -15986,6 +16016,7 @@ "type" : "object" }, "CreateApiCredentialResponse" : { + "additionalProperties" : false, "properties" : { "_links" : { "description" : "References to resources linked to the API credential.", @@ -16055,6 +16086,7 @@ "type" : "object" }, "CreateCompanyApiCredentialRequest" : { + "additionalProperties" : false, "properties" : { "allowedOrigins" : { "description" : "List of [allowed origins](https://docs.adyen.com/development-resources/client-side-authentication#allowed-origins) for the new API credential.", @@ -16085,6 +16117,7 @@ "type" : "object" }, "CreateCompanyApiCredentialResponse" : { + "additionalProperties" : false, "properties" : { "_links" : { "description" : "References to resources linked to the API credential.", @@ -16162,6 +16195,7 @@ "type" : "object" }, "CreateCompanyUserRequest" : { + "additionalProperties" : false, "properties" : { "accountGroups" : { "description" : "The list of [account groups](https://docs.adyen.com/account/account-structure#account-groups) associated with this user.", @@ -16213,6 +16247,7 @@ "type" : "object" }, "CreateCompanyUserResponse" : { + "additionalProperties" : false, "properties" : { "_links" : { "description" : "References to resources connected with this user.", @@ -16283,6 +16318,7 @@ "type" : "object" }, "CreateCompanyWebhookRequest" : { + "additionalProperties" : false, "properties" : { "acceptsExpiredCertificate" : { "description" : "Indicates if expired SSL certificates are accepted. Default value: **false**.", @@ -16387,6 +16423,7 @@ "type" : "object" }, "CreateMerchantApiCredentialRequest" : { + "additionalProperties" : false, "properties" : { "allowedOrigins" : { "description" : "The list of [allowed origins](https://docs.adyen.com/development-resources/client-side-authentication#allowed-origins) for the new API credential.", @@ -16410,6 +16447,7 @@ "type" : "object" }, "CreateMerchantRequest" : { + "additionalProperties" : false, "properties" : { "businessLineId" : { "description" : "The unique identifier of the [business line](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/businessLines). Required for an Adyen for Platforms Manage integration.", @@ -16450,6 +16488,7 @@ "type" : "object" }, "CreateMerchantResponse" : { + "additionalProperties" : false, "properties" : { "businessLineId" : { "description" : "The unique identifier of the [business line](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/businessLines).", @@ -16484,6 +16523,7 @@ "type" : "object" }, "CreateMerchantUserRequest" : { + "additionalProperties" : false, "properties" : { "accountGroups" : { "description" : "The list of [account groups](https://docs.adyen.com/account/account-structure#account-groups) associated with this user.", @@ -16528,6 +16568,7 @@ "type" : "object" }, "CreateMerchantWebhookRequest" : { + "additionalProperties" : false, "properties" : { "acceptsExpiredCertificate" : { "description" : "Indicates if expired SSL certificates are accepted. Default value: **false**.", @@ -16614,6 +16655,7 @@ "type" : "object" }, "CreateUserResponse" : { + "additionalProperties" : false, "properties" : { "_links" : { "description" : "References to resources connected with this user.", @@ -16677,6 +16719,7 @@ "type" : "object" }, "Currency" : { + "additionalProperties" : false, "properties" : { "amount" : { "description" : "Surcharge amount per transaction, in [minor units](https://docs.adyen.com/development-resources/currency-codes).", @@ -16699,6 +16742,7 @@ "type" : "object" }, "CustomNotification" : { + "additionalProperties" : false, "properties" : { "amount" : { "description" : "The amount of the payment that the notification is about. Set the value in [minor units](https://docs.adyen.com/development-resources/currency-codes).", @@ -16733,6 +16777,7 @@ "type" : "object" }, "DataCenter" : { + "additionalProperties" : false, "properties" : { "livePrefix" : { "description" : "The unique [live URL prefix](https://docs.adyen.com/development-resources/live-endpoints#live-url-prefix) for your live endpoint. Each data center has its own live URL prefix.\n\nThis field is empty for requests made in the test environment.", @@ -16746,6 +16791,7 @@ "type" : "object" }, "EventUrl" : { + "additionalProperties" : false, "properties" : { "eventLocalUrls" : { "description" : "One or more local URLs to send event notifications to when using Terminal API.", @@ -16765,6 +16811,7 @@ "type" : "object" }, "ExternalTerminalAction" : { + "additionalProperties" : false, "properties" : { "actionType" : { "description" : "The type of terminal action: **InstallAndroidApp**, **UninstallAndroidApp**, **InstallAndroidCertificate**, or **UninstallAndroidCertificate**.", @@ -16804,6 +16851,7 @@ "type" : "object" }, "File" : { + "additionalProperties" : false, "properties" : { "data" : { "description" : "The certificate content converted to a Base64-encoded string.", @@ -16821,6 +16869,7 @@ "type" : "object" }, "GenerateApiKeyResponse" : { + "additionalProperties" : false, "properties" : { "apiKey" : { "description" : "The generated API key.", @@ -16833,6 +16882,7 @@ "type" : "object" }, "GenerateClientKeyResponse" : { + "additionalProperties" : false, "properties" : { "clientKey" : { "description" : "Generated client key", @@ -16845,6 +16895,7 @@ "type" : "object" }, "GenerateHmacKeyResponse" : { + "additionalProperties" : false, "properties" : { "hmacKey" : { "description" : "The HMAC key generated for this webhook.", @@ -16857,6 +16908,7 @@ "type" : "object" }, "GenericPmWithTdiInfo" : { + "additionalProperties" : false, "properties" : { "transactionDescription" : { "description" : "Information regarding the transaction description.", @@ -16866,6 +16918,7 @@ "type" : "object" }, "GiroPayInfo" : { + "additionalProperties" : false, "properties" : { "supportEmail" : { "description" : "The email address of merchant support.", @@ -16878,6 +16931,7 @@ "type" : "object" }, "GooglePayInfo" : { + "additionalProperties" : false, "properties" : { "merchantId" : { "description" : "Google Pay [Merchant ID](https://support.google.com/paymentscenter/answer/7163092?hl=en). Character length and limitations: 16 alphanumeric characters or 20 numeric characters.", @@ -16896,6 +16950,7 @@ "type" : "object" }, "Gratuity" : { + "additionalProperties" : false, "properties" : { "allowCustomAmount" : { "description" : "Indicates whether one of the predefined tipping options is to let the shopper enter a custom tip. If **true**, only three of the other options defined in `predefinedTipEntries` are shown.", @@ -16920,6 +16975,7 @@ "type" : "object" }, "Hardware" : { + "additionalProperties" : false, "properties" : { "displayMaximumBackLight" : { "description" : "The brightness of the display when the terminal is being used, expressed as a percentage.", @@ -16940,6 +16996,7 @@ "type" : "object" }, "IdName" : { + "additionalProperties" : false, "properties" : { "id" : { "description" : "The identifier of the terminal model.", @@ -16989,6 +17046,7 @@ "type" : "object" }, "InvalidField" : { + "additionalProperties" : false, "properties" : { "message" : { "description" : "Description of the validation error.", @@ -17014,6 +17072,7 @@ "type" : "object" }, "Key" : { + "additionalProperties" : false, "properties" : { "identifier" : { "description" : "The unique identifier of the shared key.", @@ -17032,6 +17091,7 @@ "type" : "object" }, "KlarnaInfo" : { + "additionalProperties" : false, "properties" : { "autoCapture" : { "description" : "Indicates the status of [Automatic capture](https://docs.adyen.com/online-payments/capture#automatic-capture). Default value: **false**.", @@ -17066,6 +17126,7 @@ "type" : "object" }, "Links" : { + "additionalProperties" : false, "properties" : { "self" : { "description" : "Link to the resource itself.", @@ -17078,6 +17139,7 @@ "type" : "object" }, "LinksElement" : { + "additionalProperties" : false, "properties" : { "href" : { "type" : "string" @@ -17086,6 +17148,7 @@ "type" : "object" }, "ListCompanyApiCredentialsResponse" : { + "additionalProperties" : false, "properties" : { "_links" : { "description" : "Pagination references.", @@ -17116,6 +17179,7 @@ "type" : "object" }, "ListCompanyResponse" : { + "additionalProperties" : false, "properties" : { "_links" : { "description" : "Pagination references.", @@ -17146,6 +17210,7 @@ "type" : "object" }, "ListCompanyUsersResponse" : { + "additionalProperties" : false, "properties" : { "_links" : { "description" : "Pagination references.", @@ -17176,6 +17241,7 @@ "type" : "object" }, "ListExternalTerminalActionsResponse" : { + "additionalProperties" : false, "properties" : { "data" : { "description" : "The list of terminal actions.", @@ -17188,6 +17254,7 @@ "type" : "object" }, "ListMerchantApiCredentialsResponse" : { + "additionalProperties" : false, "properties" : { "_links" : { "description" : "Pagination references.", @@ -17218,6 +17285,7 @@ "type" : "object" }, "ListMerchantResponse" : { + "additionalProperties" : false, "properties" : { "_links" : { "description" : "Pagination references.", @@ -17248,6 +17316,7 @@ "type" : "object" }, "ListMerchantUsersResponse" : { + "additionalProperties" : false, "properties" : { "_links" : { "description" : "Pagination references.", @@ -17278,6 +17347,7 @@ "type" : "object" }, "ListStoresResponse" : { + "additionalProperties" : false, "properties" : { "_links" : { "description" : "Pagination references.", @@ -17308,6 +17378,7 @@ "type" : "object" }, "ListTerminalsResponse" : { + "additionalProperties" : false, "properties" : { "_links" : { "description" : "Pagination references.", @@ -17338,6 +17409,7 @@ "type" : "object" }, "ListWebhooksResponse" : { + "additionalProperties" : false, "properties" : { "_links" : { "description" : "Pagination references.", @@ -17372,6 +17444,7 @@ "type" : "object" }, "Localization" : { + "additionalProperties" : false, "properties" : { "language" : { "description" : "Language of the terminal.", @@ -17389,6 +17462,7 @@ "type" : "object" }, "Logo" : { + "additionalProperties" : false, "properties" : { "data" : { "description" : "The image file, converted to a Base64-encoded string, of the logo to be shown on the terminal.", @@ -17399,6 +17473,7 @@ "type" : "object" }, "MeApiCredential" : { + "additionalProperties" : false, "properties" : { "_links" : { "description" : "References to resources linked to the API credential.", @@ -17469,6 +17544,7 @@ "type" : "object" }, "MealVoucherFRInfo" : { + "additionalProperties" : false, "properties" : { "conecsId" : { "description" : "Meal Voucher conecsId. Format: digits only", @@ -17496,6 +17572,7 @@ "type" : "object" }, "Merchant" : { + "additionalProperties" : false, "properties" : { "_links" : { "description" : "References to resources connected with this merchant.", @@ -17560,6 +17637,7 @@ "type" : "object" }, "MerchantLinks" : { + "additionalProperties" : false, "properties" : { "apiCredentials" : { "$ref" : "#/components/schemas/LinksElement" @@ -17581,6 +17659,7 @@ "type" : "object" }, "MinorUnitsMonetaryValue" : { + "additionalProperties" : false, "properties" : { "amount" : { "description" : "The transaction amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).", @@ -17595,6 +17674,7 @@ "type" : "object" }, "Name" : { + "additionalProperties" : false, "properties" : { "firstName" : { "description" : "The first name.", @@ -17614,6 +17694,7 @@ "type" : "object" }, "Name2" : { + "additionalProperties" : false, "properties" : { "firstName" : { "description" : "The first name.", @@ -17629,6 +17710,7 @@ "type" : "object" }, "Nexo" : { + "additionalProperties" : false, "properties" : { "displayUrls" : { "description" : "The list of local and public URLs to send display notifications to when using Terminal API.", @@ -17660,6 +17742,7 @@ "type" : "object" }, "Notification" : { + "additionalProperties" : false, "properties" : { "category" : { "description" : "The type of event notification sent when you select the notification button.", @@ -17690,6 +17773,7 @@ "type" : "object" }, "NotificationUrl" : { + "additionalProperties" : false, "properties" : { "localUrls" : { "description" : "One or more local URLs to send notifications to when using Terminal API.", @@ -17709,6 +17793,7 @@ "type" : "object" }, "OfflineProcessing" : { + "additionalProperties" : false, "properties" : { "chipFloorLimit" : { "description" : "The maximum offline transaction amount for chip cards, in the processing currency and specified in [minor units](https://docs.adyen.com/development-resources/currency-codes).", @@ -17726,6 +17811,7 @@ "type" : "object" }, "Opi" : { + "additionalProperties" : false, "properties" : { "enablePayAtTable" : { "description" : "Indicates if Pay at table is enabled.", @@ -17743,6 +17829,7 @@ "type" : "object" }, "OrderItem" : { + "additionalProperties" : false, "properties" : { "id" : { "description" : "The unique identifier of the product.", @@ -17766,6 +17853,7 @@ "type" : "object" }, "PaginationLinks" : { + "additionalProperties" : false, "properties" : { "first" : { "description" : "The first page.", @@ -17796,6 +17884,7 @@ "type" : "object" }, "Passcodes" : { + "additionalProperties" : false, "properties" : { "adminMenuPin" : { "description" : "The passcode for the Admin menu and the Settings menu.", @@ -17822,6 +17911,7 @@ "type" : "object" }, "PayAtTable" : { + "additionalProperties" : false, "properties" : { "authenticationMethod" : { "description" : "Allowed authentication methods: Magswipe, Manual Entry.", @@ -17848,6 +17938,7 @@ "type" : "object" }, "PayPalInfo" : { + "additionalProperties" : false, "properties" : { "directCapture" : { "description" : "Indicates if direct (immediate) capture for PayPal is enabled. If set to **true**, this setting overrides the [capture](https://docs.adyen.com/online-payments/capture) settings of your merchant account. Default value: **true**.", @@ -17871,6 +17962,7 @@ "type" : "object" }, "Payment" : { + "additionalProperties" : false, "properties" : { "contactlessCurrency" : { "description" : "The default currency for contactless payments on the payment terminal, as the three-letter [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code.", @@ -17889,6 +17981,7 @@ "type" : "object" }, "PaymentMethod" : { + "additionalProperties" : false, "properties" : { "afterpayTouch" : { "description" : "Afterpay Touch details.", @@ -18065,6 +18158,7 @@ "type" : "object" }, "PaymentMethodResponse" : { + "additionalProperties" : false, "properties" : { "_links" : { "description" : "Pagination references.", @@ -18153,6 +18247,7 @@ "type" : "object" }, "PaymentMethodSetupInfo" : { + "additionalProperties" : false, "properties" : { "afterpayTouch" : { "description" : "Afterpay Touch details.", @@ -18364,6 +18459,7 @@ "type" : "object" }, "PayoutSettings" : { + "additionalProperties" : false, "properties" : { "allowed" : { "description" : "Indicates if payouts to the bank account are allowed. This value is set automatically based on the status of the verification process. The value is:\n\n* **true** if `verificationStatus` is **valid**.\n* **false** for all other values.", @@ -18412,6 +18508,7 @@ "type" : "object" }, "PayoutSettingsRequest" : { + "additionalProperties" : false, "properties" : { "enabled" : { "description" : "Indicates if payouts to this bank account are enabled. Default: **true**.\n\nTo receive payouts into this bank account, both `enabled` and `allowed` must be **true**.", @@ -18432,6 +18529,7 @@ "type" : "object" }, "PayoutSettingsResponse" : { + "additionalProperties" : false, "properties" : { "data" : { "description" : "The list of payout accounts.", @@ -18444,6 +18542,7 @@ "type" : "object" }, "Profile" : { + "additionalProperties" : false, "properties" : { "authType" : { "description" : "The type of Wi-Fi network. Possible values: **wpa-psk**, **wpa2-psk**, **wpa-eap**, **wpa2-eap**.", @@ -18528,6 +18627,7 @@ "type" : "object" }, "ReceiptOptions" : { + "additionalProperties" : false, "properties" : { "logo" : { "description" : "The receipt logo converted to a Base64-encoded string. The image must be a .bmp file of < 256 KB, dimensions 240 (H) x 384 (W) px.", @@ -18546,6 +18646,7 @@ "type" : "object" }, "ReceiptPrinting" : { + "additionalProperties" : false, "properties" : { "merchantApproved" : { "description" : "Print a merchant receipt when the payment is approved.", @@ -18615,6 +18716,7 @@ "type" : "object" }, "Referenced" : { + "additionalProperties" : false, "properties" : { "enableStandaloneRefunds" : { "description" : "Indicates whether referenced refunds are enabled on the standalone terminal.", @@ -18624,6 +18726,7 @@ "type" : "object" }, "Refunds" : { + "additionalProperties" : false, "properties" : { "referenced" : { "description" : "Settings for referenced refunds.", @@ -18651,6 +18754,7 @@ "type" : "object" }, "RequestActivationResponse" : { + "additionalProperties" : false, "properties" : { "companyId" : { "description" : "The unique identifier of the company account.", @@ -18664,6 +18768,7 @@ "type" : "object" }, "RestServiceError" : { + "additionalProperties" : false, "properties" : { "detail" : { "description" : "A human-readable explanation specific to this occurrence of the problem.", @@ -18716,6 +18821,7 @@ "type" : "object" }, "ScheduleTerminalActionsRequest" : { + "additionalProperties" : false, "properties" : { "actionDetails" : { "description" : "Information about the action to take.", @@ -18756,6 +18862,7 @@ "type" : "object" }, "ScheduleTerminalActionsResponse" : { + "additionalProperties" : false, "properties" : { "actionDetails" : { "description" : "Information about the action to take.", @@ -18817,6 +18924,7 @@ "type" : "object" }, "Settings" : { + "additionalProperties" : false, "properties" : { "band" : { "description" : "The preferred Wi-Fi band, for use if the terminals support multiple bands. Possible values: All, 2.4GHz, 5GHz.", @@ -18835,6 +18943,7 @@ "type" : "object" }, "ShippingLocation" : { + "additionalProperties" : false, "properties" : { "address" : { "description" : "The address details of the shipping location.", @@ -18856,6 +18965,7 @@ "type" : "object" }, "ShippingLocationsResponse" : { + "additionalProperties" : false, "properties" : { "data" : { "description" : "Physical locations where orders can be shipped to.", @@ -18868,6 +18978,7 @@ "type" : "object" }, "Signature" : { + "additionalProperties" : false, "properties" : { "askSignatureOnScreen" : { "description" : "If `skipSignature` is false, indicates whether the shopper should provide a signature on the display (**true**) or on the merchant receipt (**false**).", @@ -18890,6 +19001,7 @@ "type" : "object" }, "SofortInfo" : { + "additionalProperties" : false, "properties" : { "currencyCode" : { "description" : "Sofort currency code. For example, **EUR**.", @@ -18907,6 +19019,7 @@ "type" : "object" }, "SplitConfiguration" : { + "additionalProperties" : false, "properties" : { "description" : { "description" : "Your description for the split configuration.", @@ -18941,6 +19054,7 @@ "type" : "object" }, "SplitConfigurationList" : { + "additionalProperties" : false, "properties" : { "data" : { "description" : "List of split configurations applied to the stores under the merchant account.", @@ -18953,6 +19067,7 @@ "type" : "object" }, "SplitConfigurationLogic" : { + "additionalProperties" : false, "properties" : { "acquiringFees" : { "description" : "Deducts the acquiring fees (the aggregated amount of interchange and scheme fee) from the specified balance account.\n\nPossible values: **deductFromLiableAccount**, **deductFromOneBalanceAccount**.", @@ -19020,7 +19135,7 @@ "type" : "string" }, "paymentFee" : { - "description" : "Deducts all transaction fees incurred by the payment from the specified balance account. The transaction fees include the acquiring fees (interchange and scheme fee), and the fees due to Adyen (markup or commission). You can book any and all these fees to different balance account by specifying other transaction fee parameters in your split configuration profile:\n\n- [`adyenCommission`](https://docs.adyen.com/api-explorer/Management/latest/post/merchants/(merchantId)/splitConfigurations#request-rules-splitLogic-adyenCommission): The transaction fee due to Adyen under [blended rates](https://www.adyen.com/knowledge-hub/guides/payments-training-guide/get-the-best-from-your-card-processing).\n- [`adyenMarkup`](https://docs.adyen.com/api-explorer/Management/latest/post/merchants/(merchantId)/splitConfigurations#request-rules-splitLogic-adyenMarkup): The transaction fee due to Adyen under [Interchange ++ pricing](https://www.adyen.com/what-is-interchange).\n- [`schemeFee`](https://docs.adyen.com/api-explorer/Management/latest/post/merchants/(merchantId)/splitConfigurations#request-rules-splitLogic-schemeFee): The fee paid to the card scheme for using their network.\n- [`interchange`](https://docs.adyen.com/api-explorer/Management/latest/post/merchants/(merchantId)/splitConfigurations#request-rules-splitLogic-interchange): The fee paid to the issuer for each payment transaction made with the card network.\n- [`adyenFees`](https://docs.adyen.com/api-explorer/Management/latest/post/merchants/(merchantId)/splitConfigurations#request-rules-splitLogic-adyenFees): The aggregated amount of Adyen's commission and markup.\n- [`acquiringFees`](https://docs.adyen.com/api-explorer/Management/latest/post/merchants/(merchantId)/splitConfigurations#request-rules-splitLogic-acquiringFees): The aggregated amount of the interchange and scheme fees.\n\nIf you don't include at least one transaction fee type in the `splitLogic` object, Adyen updates the payment request with the `paymentFee` parameter, booking all transaction fees to your platform's liable balance account.\n\nPossible values: **deductFromLiableAccount**, **deductFromOneBalanceAccount**.", + "description" : "Deducts all transaction fees incurred by the payment from the specified balance account. The transaction fees include the acquiring fees (interchange and scheme fee), and the fees due to Adyen (markup or commission). You can book any and all these fees to different balance account by specifying other transaction fee parameters in your split configuration profile:\n\n- [`adyenCommission`](https://docs.adyen.com/api-explorer/Management/latest/post/merchants/(merchantId)/splitConfigurations#request-rules-splitLogic-adyenCommission): The transaction fee due to Adyen under [blended rates](https://www.adyen.com/knowledge-hub/interchange-fees-explained#interchange-vs-blended).\n- [`adyenMarkup`](https://docs.adyen.com/api-explorer/Management/latest/post/merchants/(merchantId)/splitConfigurations#request-rules-splitLogic-adyenMarkup): The transaction fee due to Adyen under [Interchange ++ pricing](https://www.adyen.com/knowledge-hub/interchange-fees-explained#interchange-vs-blended).\n- [`schemeFee`](https://docs.adyen.com/api-explorer/Management/latest/post/merchants/(merchantId)/splitConfigurations#request-rules-splitLogic-schemeFee): The fee paid to the card scheme for using their network.\n- [`interchange`](https://docs.adyen.com/api-explorer/Management/latest/post/merchants/(merchantId)/splitConfigurations#request-rules-splitLogic-interchange): The fee paid to the issuer for each payment transaction made with the card network.\n- [`adyenFees`](https://docs.adyen.com/api-explorer/Management/latest/post/merchants/(merchantId)/splitConfigurations#request-rules-splitLogic-adyenFees): The aggregated amount of Adyen's commission and markup.\n- [`acquiringFees`](https://docs.adyen.com/api-explorer/Management/latest/post/merchants/(merchantId)/splitConfigurations#request-rules-splitLogic-acquiringFees): The aggregated amount of the interchange and scheme fees.\n\nIf you don't include at least one transaction fee type in the `splitLogic` object, Adyen updates the payment request with the `paymentFee` parameter, booking all transaction fees to your platform's liable balance account.\n\nPossible values: **deductFromLiableAccount**, **deductFromOneBalanceAccount**.", "enum" : [ "deductFromLiableAccount", "deductFromOneBalanceAccount" @@ -19036,6 +19151,14 @@ ], "type" : "string" }, + "refundCostAllocation" : { + "description" : "Deducts the refund costs from the specified balance account.\n\nPossible values: **deductFromLiableAccount**, **deductFromOneBalanceAccount**", + "enum" : [ + "deductFromLiableAccount", + "deductFromOneBalanceAccount" + ], + "type" : "string" + }, "remainder" : { "description" : "Books the amount left over after currency conversion to the specified balance account.\n\nPossible values: **addToLiableAccount**, **addToOneBalanceAccount**.", "enum" : [ @@ -19080,6 +19203,7 @@ "type" : "object" }, "SplitConfigurationRule" : { + "additionalProperties" : false, "properties" : { "currency" : { "description" : "The currency condition that defines whether the split logic applies.\nIts value must be a three-character [ISO currency code](https://en.wikipedia.org/wiki/ISO_4217).", @@ -19128,6 +19252,7 @@ "type" : "object" }, "Standalone" : { + "additionalProperties" : false, "properties" : { "currencyCode" : { "description" : "The default currency of the standalone payment terminal as an [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code.", @@ -19143,6 +19268,7 @@ "type" : "object" }, "Store" : { + "additionalProperties" : false, "properties" : { "_links" : { "description" : "Reference to resources connected with the store.", @@ -19203,7 +19329,30 @@ }, "type" : "object" }, + "StoreAndForward" : { + "additionalProperties" : false, + "properties" : { + "maxAmount" : { + "description" : "The maximum amount that the terminal accepts for a single store-and-forward payment.", + "items" : { + "$ref" : "#/components/schemas/MinorUnitsMonetaryValue" + }, + "type" : "array" + }, + "maxPayments" : { + "description" : "The maximum number of store-and-forward transactions per terminal that you can process while offline.", + "format" : "int32", + "type" : "integer" + }, + "supportedCardTypes" : { + "description" : "The type of card for which the terminal accepts store-and-forward payments. You can specify multiple card types. ", + "$ref" : "#/components/schemas/SupportedCardTypes" + } + }, + "type" : "object" + }, "StoreCreationRequest" : { + "additionalProperties" : false, "properties" : { "address" : { "description" : "The address of the store.", @@ -19250,6 +19399,7 @@ "type" : "object" }, "StoreCreationWithMerchantCodeRequest" : { + "additionalProperties" : false, "properties" : { "address" : { "description" : "The address of the store.", @@ -19301,6 +19451,7 @@ "type" : "object" }, "StoreLocation" : { + "additionalProperties" : false, "properties" : { "city" : { "description" : "The name of the city.", @@ -19337,6 +19488,7 @@ "type" : "object" }, "StoreSplitConfiguration" : { + "additionalProperties" : false, "properties" : { "balanceAccountId" : { "description" : "The [unique identifier of the balance account](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/get/balanceAccounts/{id}__queryParam_id) to which the split amount must be booked, depending on the defined [split logic](https://docs.adyen.com/api-explorer/Management/latest/post/merchants/_merchantId_/splitConfigurations#request-rules-splitLogic).", @@ -19349,7 +19501,34 @@ }, "type" : "object" }, + "SupportedCardTypes" : { + "additionalProperties" : false, + "properties" : { + "credit" : { + "description" : "Set to **true** to accept credit cards.", + "type" : "boolean" + }, + "debit" : { + "description" : "Set to **true** to accept debit cards.", + "type" : "boolean" + }, + "deferredDebit" : { + "description" : "Set to **true** to accept cards that allow deferred debit.", + "type" : "boolean" + }, + "prepaid" : { + "description" : "Set to **true** to accept prepaid cards.", + "type" : "boolean" + }, + "unknown" : { + "description" : "Set to **true** to accept card types for which the terminal can't determine the funding source while offline.", + "type" : "boolean" + } + }, + "type" : "object" + }, "Surcharge" : { + "additionalProperties" : false, "properties" : { "askConfirmation" : { "description" : "Show the surcharge details on the terminal, so the shopper can confirm.", @@ -19366,6 +19545,7 @@ "type" : "object" }, "SwishInfo" : { + "additionalProperties" : false, "properties" : { "swishNumber" : { "description" : "Swish number. Format: 10 digits without spaces. For example, **1231111111**.", @@ -19380,6 +19560,7 @@ "type" : "object" }, "TapToPay" : { + "additionalProperties" : false, "properties" : { "merchantDisplayName" : { "description" : "The text shown on the screen during the Tap to Pay transaction.", @@ -19389,6 +19570,7 @@ "type" : "object" }, "Terminal" : { + "additionalProperties" : false, "properties" : { "assignment" : { "x-addedInVersion" : "2", @@ -19433,6 +19615,7 @@ "type" : "object" }, "TerminalActionScheduleDetail" : { + "additionalProperties" : false, "properties" : { "id" : { "description" : "The ID of the action on the specified terminal.", @@ -19446,6 +19629,7 @@ "type" : "object" }, "TerminalAssignment" : { + "additionalProperties" : false, "properties" : { "companyId" : { "description" : "The unique identifier of the company account to which terminal is assigned.", @@ -19481,6 +19665,7 @@ "type" : "object" }, "TerminalConnectivity" : { + "additionalProperties" : false, "properties" : { "bluetooth" : { "$ref" : "#/components/schemas/TerminalConnectivityBluetooth" @@ -19498,6 +19683,7 @@ "type" : "object" }, "TerminalConnectivityBluetooth" : { + "additionalProperties" : false, "properties" : { "ipAddress" : { "description" : "The terminal's Bluetooth IP address.", @@ -19511,6 +19697,7 @@ "type" : "object" }, "TerminalConnectivityCellular" : { + "additionalProperties" : false, "properties" : { "iccid" : { "description" : "The integrated circuit card identifier (ICCID) of the SIM card in the terminal.", @@ -19531,6 +19718,7 @@ "type" : "object" }, "TerminalConnectivityEthernet" : { + "additionalProperties" : false, "properties" : { "ipAddress" : { "description" : "The terminal's ethernet IP address.", @@ -19548,6 +19736,7 @@ "type" : "object" }, "TerminalConnectivityWifi" : { + "additionalProperties" : false, "properties" : { "ipAddress" : { "description" : "The terminal's IP address in the Wi-Fi network.", @@ -19565,6 +19754,7 @@ "type" : "object" }, "TerminalInstructions" : { + "additionalProperties" : false, "properties" : { "adyenAppRestart" : { "description" : "Indicates whether the Adyen app on the payment terminal restarts automatically when the configuration is updated.", @@ -19574,6 +19764,7 @@ "type" : "object" }, "TerminalModelsResponse" : { + "additionalProperties" : false, "properties" : { "data" : { "description" : "The terminal models that the API credential has access to.", @@ -19586,6 +19777,7 @@ "type" : "object" }, "TerminalOrder" : { + "additionalProperties" : false, "properties" : { "billingEntity" : { "description" : "The details of the entity that the order is billed to.", @@ -19626,6 +19818,7 @@ "type" : "object" }, "TerminalOrderRequest" : { + "additionalProperties" : false, "properties" : { "billingEntityId" : { "description" : "The identification of the billing entity to use for the order.", @@ -19658,6 +19851,7 @@ "type" : "object" }, "TerminalOrdersResponse" : { + "additionalProperties" : false, "properties" : { "data" : { "description" : "List of orders for payment terminal packages and parts.", @@ -19670,6 +19864,7 @@ "type" : "object" }, "TerminalProduct" : { + "additionalProperties" : false, "properties" : { "description" : { "description" : "Information about items included and integration options.", @@ -19698,6 +19893,7 @@ "type" : "object" }, "TerminalProductPrice" : { + "additionalProperties" : false, "properties" : { "currency" : { "description" : "The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes).", @@ -19712,6 +19908,7 @@ "type" : "object" }, "TerminalProductsResponse" : { + "additionalProperties" : false, "properties" : { "data" : { "description" : "Terminal products that can be ordered.", @@ -19724,6 +19921,7 @@ "type" : "object" }, "TerminalReassignmentRequest" : { + "additionalProperties" : false, "properties" : { "companyId" : { "description" : "The unique identifier of the company account to which the terminal is reassigned.", @@ -19745,6 +19943,7 @@ "type" : "object" }, "TerminalReassignmentTarget" : { + "additionalProperties" : false, "properties" : { "companyId" : { "description" : "The unique identifier of the company account to which the terminal is reassigned.", @@ -19769,6 +19968,7 @@ "type" : "object" }, "TerminalSettings" : { + "additionalProperties" : false, "properties" : { "cardholderReceipt" : { "description" : "Settings to define the header of the shopper receipt.", @@ -19837,6 +20037,10 @@ "description" : "Settings for [standalone](https://docs.adyen.com/point-of-sale/standalone/standalone-build/set-up-standalone#set-up-standalone-using-an-api-call) features.", "$ref" : "#/components/schemas/Standalone" }, + "storeAndForward" : { + "description" : "Settings for store-and-forward offline payments. The maxAmount, maxPayments, and supportedCardTypes parameters must be configured, either in the request or inherited from a higher level in your account structure.", + "$ref" : "#/components/schemas/StoreAndForward" + }, "surcharge" : { "description" : "Settings for payment [surcharge](https://docs.adyen.com/point-of-sale/surcharge) features.", "$ref" : "#/components/schemas/Surcharge" @@ -19861,6 +20065,7 @@ "type" : "object" }, "TestCompanyWebhookRequest" : { + "additionalProperties" : false, "properties" : { "merchantIds" : { "description" : "List of `merchantId` values for which test webhooks will be sent. The list can have a maximum of 20 `merchantId` values.\n\nIf not specified, we send sample notifications to all the merchant accounts that the webhook is configured for. If this is more than 20 merchant accounts, use this list to specify a subset of the merchant accounts for which to send test notifications.", @@ -19884,6 +20089,7 @@ "type" : "object" }, "TestOutput" : { + "additionalProperties" : false, "properties" : { "merchantId" : { "description" : "Unique identifier of the merchant account that the notification is about.", @@ -19917,6 +20123,7 @@ "type" : "object" }, "TestWebhookRequest" : { + "additionalProperties" : false, "properties" : { "notification" : { "description" : "Custom test notification object. Required when the [`types`](https://docs.adyen.com/api-explorer/#/ManagementService/v1/post/companies/{companyId}/webhooks/{webhookId}/test__reqParam_types) list contains **CUSTOM**.", @@ -19933,6 +20140,7 @@ "type" : "object" }, "TestWebhookResponse" : { + "additionalProperties" : false, "properties" : { "data" : { "description" : "List with test results. Each test webhook we send has a list element with the result.", @@ -19945,6 +20153,7 @@ "type" : "object" }, "Timeouts" : { + "additionalProperties" : false, "properties" : { "fromActiveToSleep" : { "description" : "Indicates the number of seconds of inactivity after which the terminal display goes into sleep mode.", @@ -19955,6 +20164,7 @@ "type" : "object" }, "TransactionDescriptionInfo" : { + "additionalProperties" : false, "properties" : { "doingBusinessAsName" : { "description" : "The text to be shown on the shopper's bank statement.\n We recommend sending a maximum of 22 characters, otherwise banks might truncate the string.\n Allowed characters: **a-z**, **A-Z**, **0-9**, spaces, and special characters **. , ' _ - ? + * /**.", @@ -19975,6 +20185,7 @@ "type" : "object" }, "TwintInfo" : { + "additionalProperties" : false, "properties" : { "logo" : { "description" : "Twint logo. Format: Base64-encoded string.", @@ -20023,6 +20234,7 @@ "type" : "object" }, "UpdatableAddress" : { + "additionalProperties" : false, "properties" : { "city" : { "description" : "The name of the city.", @@ -20052,6 +20264,7 @@ "type" : "object" }, "UpdateCompanyApiCredentialRequest" : { + "additionalProperties" : false, "properties" : { "active" : { "description" : "Indicates if the API credential is enabled.", @@ -20086,6 +20299,7 @@ "type" : "object" }, "UpdateCompanyUserRequest" : { + "additionalProperties" : false, "properties" : { "accountGroups" : { "description" : "The list of [account groups](https://docs.adyen.com/account/account-structure#account-groups) associated with this user.", @@ -20130,6 +20344,7 @@ "type" : "object" }, "UpdateCompanyWebhookRequest" : { + "additionalProperties" : false, "properties" : { "acceptsExpiredCertificate" : { "description" : "Indicates if expired SSL certificates are accepted. Default value: **false**.", @@ -20222,6 +20437,7 @@ "type" : "object" }, "UpdateMerchantApiCredentialRequest" : { + "additionalProperties" : false, "properties" : { "active" : { "description" : "Indicates if the API credential is enabled.", @@ -20249,6 +20465,7 @@ "type" : "object" }, "UpdateMerchantUserRequest" : { + "additionalProperties" : false, "properties" : { "accountGroups" : { "description" : "The list of [account groups](https://docs.adyen.com/account/account-structure#account-groups) associated with this user.", @@ -20286,6 +20503,7 @@ "type" : "object" }, "UpdateMerchantWebhookRequest" : { + "additionalProperties" : false, "properties" : { "acceptsExpiredCertificate" : { "description" : "Indicates if expired SSL certificates are accepted. Default value: **false**.", @@ -20362,6 +20580,7 @@ "type" : "object" }, "UpdatePaymentMethodInfo" : { + "additionalProperties" : false, "properties" : { "bcmc" : { "description" : "Bancontact details.", @@ -20451,6 +20670,7 @@ "type" : "object" }, "UpdatePayoutSettingsRequest" : { + "additionalProperties" : false, "properties" : { "enabled" : { "description" : "Indicates if payouts to this bank account are enabled. Default: **true**.\n\nTo receive payouts into this bank account, both `enabled` and `allowed` must be **true**.", @@ -20460,6 +20680,7 @@ "type" : "object" }, "UpdateSplitConfigurationLogicRequest" : { + "additionalProperties" : false, "properties" : { "acquiringFees" : { "description" : "Deducts the acquiring fees (the aggregated amount of interchange and scheme fee) from the specified balance account.\n\nPossible values: **deductFromLiableAccount**, **deductFromOneBalanceAccount**.", @@ -20527,7 +20748,7 @@ "type" : "string" }, "paymentFee" : { - "description" : "Deducts all transaction fees incurred by the payment from the specified balance account. The transaction fees include the acquiring fees (interchange and scheme fee), and the fees due to Adyen (markup or commission). You can book any and all these fees to different balance account by specifying other transaction fee parameters in your split configuration profile:\n\n- [`adyenCommission`](https://docs.adyen.com/api-explorer/Management/latest/post/merchants/(merchantId)/splitConfigurations#request-rules-splitLogic-adyenCommission): The transaction fee due to Adyen under [blended rates](https://www.adyen.com/knowledge-hub/guides/payments-training-guide/get-the-best-from-your-card-processing).\n- [`adyenMarkup`](https://docs.adyen.com/api-explorer/Management/latest/post/merchants/(merchantId)/splitConfigurations#request-rules-splitLogic-adyenMarkup): The transaction fee due to Adyen under [Interchange ++ pricing](https://www.adyen.com/what-is-interchange).\n- [`schemeFee`](https://docs.adyen.com/api-explorer/Management/latest/post/merchants/(merchantId)/splitConfigurations#request-rules-splitLogic-schemeFee): The fee paid to the card scheme for using their network.\n- [`interchange`](https://docs.adyen.com/api-explorer/Management/latest/post/merchants/(merchantId)/splitConfigurations#request-rules-splitLogic-interchange): The fee paid to the issuer for each payment transaction made with the card network.\n- [`adyenFees`](https://docs.adyen.com/api-explorer/Management/latest/post/merchants/(merchantId)/splitConfigurations#request-rules-splitLogic-adyenFees): The aggregated amount of Adyen's commission and markup.\n- [`acquiringFees`](https://docs.adyen.com/api-explorer/Management/latest/post/merchants/(merchantId)/splitConfigurations#request-rules-splitLogic-acquiringFees): The aggregated amount of the interchange and scheme fees.\n\nIf you don't include at least one transaction fee type in the `splitLogic` object, Adyen updates the payment request with the `paymentFee` parameter, booking all transaction fees to your platform's liable balance account.\n\nPossible values: **deductFromLiableAccount**, **deductFromOneBalanceAccount**.", + "description" : "Deducts all transaction fees incurred by the payment from the specified balance account. The transaction fees include the acquiring fees (interchange and scheme fee), and the fees due to Adyen (markup or commission). You can book any and all these fees to different balance account by specifying other transaction fee parameters in your split configuration profile:\n\n- [`adyenCommission`](https://docs.adyen.com/api-explorer/Management/latest/post/merchants/(merchantId)/splitConfigurations#request-rules-splitLogic-adyenCommission): The transaction fee due to Adyen under [blended rates](https://www.adyen.com/knowledge-hub/interchange-fees-explained#interchange-vs-blended).\n- [`adyenMarkup`](https://docs.adyen.com/api-explorer/Management/latest/post/merchants/(merchantId)/splitConfigurations#request-rules-splitLogic-adyenMarkup): The transaction fee due to Adyen under [Interchange ++ pricing](https://www.adyen.com/knowledge-hub/interchange-fees-explained#interchange-vs-blended).\n- [`schemeFee`](https://docs.adyen.com/api-explorer/Management/latest/post/merchants/(merchantId)/splitConfigurations#request-rules-splitLogic-schemeFee): The fee paid to the card scheme for using their network.\n- [`interchange`](https://docs.adyen.com/api-explorer/Management/latest/post/merchants/(merchantId)/splitConfigurations#request-rules-splitLogic-interchange): The fee paid to the issuer for each payment transaction made with the card network.\n- [`adyenFees`](https://docs.adyen.com/api-explorer/Management/latest/post/merchants/(merchantId)/splitConfigurations#request-rules-splitLogic-adyenFees): The aggregated amount of Adyen's commission and markup.\n- [`acquiringFees`](https://docs.adyen.com/api-explorer/Management/latest/post/merchants/(merchantId)/splitConfigurations#request-rules-splitLogic-acquiringFees): The aggregated amount of the interchange and scheme fees.\n\nIf you don't include at least one transaction fee type in the `splitLogic` object, Adyen updates the payment request with the `paymentFee` parameter, booking all transaction fees to your platform's liable balance account.\n\nPossible values: **deductFromLiableAccount**, **deductFromOneBalanceAccount**.", "enum" : [ "deductFromLiableAccount", "deductFromOneBalanceAccount" @@ -20543,6 +20764,14 @@ ], "type" : "string" }, + "refundCostAllocation" : { + "description" : "Deducts the refund costs from the specified balance account.\n\nPossible values: **deductFromLiableAccount**, **deductFromOneBalanceAccount**", + "enum" : [ + "deductFromLiableAccount", + "deductFromOneBalanceAccount" + ], + "type" : "string" + }, "remainder" : { "description" : "Books the amount left over after currency conversion to the specified balance account.\n\nPossible values: **addToLiableAccount**, **addToOneBalanceAccount**.", "enum" : [ @@ -20587,6 +20816,7 @@ "type" : "object" }, "UpdateSplitConfigurationRequest" : { + "additionalProperties" : false, "properties" : { "description" : { "description" : "Your description for the split configuration.", @@ -20600,6 +20830,7 @@ "type" : "object" }, "UpdateSplitConfigurationRuleRequest" : { + "additionalProperties" : false, "properties" : { "currency" : { "description" : "The currency condition that defines whether the split logic applies.\nIts value must be a three-character [ISO currency code](https://en.wikipedia.org/wiki/ISO_4217).", @@ -20626,6 +20857,7 @@ "type" : "object" }, "UpdateStoreRequest" : { + "additionalProperties" : false, "properties" : { "address" : { "description" : "The address of the store. It is not possible to update the country of the store.", @@ -20667,6 +20899,7 @@ "type" : "object" }, "UploadAndroidAppResponse" : { + "additionalProperties" : false, "properties" : { "id" : { "description" : "The unique identifier of the uploaded Android app.", @@ -20676,6 +20909,7 @@ "type" : "object" }, "Url" : { + "additionalProperties" : false, "properties" : { "encrypted" : { "description" : "Indicates if the message sent to this URL should be encrypted.", @@ -20697,6 +20931,7 @@ "type" : "object" }, "User" : { + "additionalProperties" : false, "properties" : { "_links" : { "description" : "References to resources connected with this user.", @@ -20760,6 +20995,7 @@ "type" : "object" }, "VippsInfo" : { + "additionalProperties" : false, "properties" : { "logo" : { "description" : "Vipps logo. Format: Base64-encoded string.", @@ -20776,6 +21012,7 @@ "type" : "object" }, "Webhook" : { + "additionalProperties" : false, "properties" : { "_links" : { "description" : "References to resources connected with this webhook.", @@ -20901,6 +21138,7 @@ "type" : "object" }, "WebhookLinks" : { + "additionalProperties" : false, "properties" : { "company" : { "description" : "The company account that the webhook is configured for. Only present for company-level webhooks.", @@ -20931,6 +21169,7 @@ "type" : "object" }, "WifiProfiles" : { + "additionalProperties" : false, "properties" : { "profiles" : { "description" : "List of remote Wi-Fi profiles.", diff --git a/yaml/ManagementNotificationService-v1.yaml b/yaml/ManagementNotificationService-v1.yaml index 33b8fc84..ecd497a2 100644 --- a/yaml/ManagementNotificationService-v1.yaml +++ b/yaml/ManagementNotificationService-v1.yaml @@ -113,6 +113,7 @@ webhooks: components: schemas: AccountCapabilityData: + additionalProperties: false properties: allowed: description: Indicates whether the capability is allowed. Adyen sets this @@ -175,6 +176,7 @@ components: - requested type: object AccountCreateNotificationData: + additionalProperties: false properties: capabilities: additionalProperties: @@ -227,6 +229,7 @@ components: - capabilities type: object AccountNotificationResponse: + additionalProperties: false properties: notificationResponse: description: Respond with **HTTP 200 OK** and `[accepted]` in the response @@ -234,6 +237,7 @@ components: type: string type: object AccountUpdateNotificationData: + additionalProperties: false properties: capabilities: additionalProperties: @@ -282,6 +286,7 @@ components: - capabilities type: object CapabilityProblem: + additionalProperties: false properties: entity: description: The ID and the type of entity that has verification errors. @@ -293,6 +298,7 @@ components: type: array type: object CapabilityProblemEntity: + additionalProperties: false properties: documents: description: List of document IDs to which the verification errors related @@ -320,6 +326,7 @@ components: type: string type: object CapabilityProblemEntity-recursive: + additionalProperties: false properties: documents: description: List of document IDs to which the verification errors related @@ -343,6 +350,7 @@ components: required: [] type: object MerchantCreatedNotificationRequest: + additionalProperties: false properties: createdAt: description: Timestamp for when the webhook was created. @@ -369,6 +377,7 @@ components: - type type: object MerchantUpdatedNotificationRequest: + additionalProperties: false properties: createdAt: description: Timestamp for when the webhook was created. @@ -395,6 +404,7 @@ components: - type type: object MidServiceNotificationData: + additionalProperties: false properties: allowed: description: Indicates whether receiving payments is allowed. This value @@ -449,6 +459,7 @@ components: - type type: object PaymentMethodCreatedNotificationRequest: + additionalProperties: false properties: createdAt: description: Timestamp for when the webhook was created. @@ -475,6 +486,7 @@ components: - type type: object PaymentMethodNotificationResponse: + additionalProperties: false properties: notificationResponse: description: Respond with **HTTP 200 OK** and `[accepted]` in the response @@ -482,6 +494,7 @@ components: type: string type: object RemediatingAction: + additionalProperties: false properties: code: description: The remediating action code. @@ -491,6 +504,7 @@ components: type: string type: object VerificationError: + additionalProperties: false properties: code: description: The verification error code. @@ -520,6 +534,7 @@ components: type: string type: object VerificationError-recursive: + additionalProperties: false properties: code: description: The verification error code. diff --git a/yaml/ManagementNotificationService-v3.yaml b/yaml/ManagementNotificationService-v3.yaml index 75c5dbcb..fb85d09c 100644 --- a/yaml/ManagementNotificationService-v3.yaml +++ b/yaml/ManagementNotificationService-v3.yaml @@ -170,6 +170,7 @@ webhooks: components: schemas: AccountCapabilityData: + additionalProperties: false properties: allowed: description: Indicates whether the capability is allowed. Adyen sets this @@ -232,6 +233,7 @@ components: - requested type: object AccountCreateNotificationData: + additionalProperties: false properties: capabilities: additionalProperties: @@ -284,6 +286,7 @@ components: - capabilities type: object AccountNotificationResponse: + additionalProperties: false properties: notificationResponse: description: Respond with **HTTP 200 OK** and `[accepted]` in the response @@ -291,6 +294,7 @@ components: type: string type: object AccountUpdateNotificationData: + additionalProperties: false properties: capabilities: additionalProperties: @@ -339,6 +343,7 @@ components: - capabilities type: object CapabilityProblem: + additionalProperties: false properties: entity: description: The ID and the type of entity that has verification errors. @@ -350,6 +355,7 @@ components: type: array type: object CapabilityProblemEntity: + additionalProperties: false properties: documents: description: List of document IDs to which the verification errors related @@ -377,6 +383,7 @@ components: type: string type: object CapabilityProblemEntity-recursive: + additionalProperties: false properties: documents: description: List of document IDs to which the verification errors related @@ -400,6 +407,7 @@ components: required: [] type: object MerchantCreatedNotificationRequest: + additionalProperties: false properties: createdAt: description: Timestamp for when the webhook was created. @@ -426,6 +434,7 @@ components: - type type: object MerchantUpdatedNotificationRequest: + additionalProperties: false properties: createdAt: description: Timestamp for when the webhook was created. @@ -452,6 +461,7 @@ components: - type type: object MidServiceNotificationData: + additionalProperties: false properties: allowed: description: Indicates whether receiving payments is allowed. This value @@ -520,6 +530,7 @@ components: - type type: object PaymentMethodCreatedNotificationRequest: + additionalProperties: false properties: createdAt: description: Timestamp for when the webhook was created. @@ -546,6 +557,7 @@ components: - type type: object PaymentMethodNotificationResponse: + additionalProperties: false properties: notificationResponse: description: Respond with **HTTP 200 OK** and `[accepted]` in the response @@ -553,6 +565,7 @@ components: type: string type: object PaymentMethodRequestRemovedNotificationRequest: + additionalProperties: false properties: createdAt: description: Timestamp for when the webhook was created. @@ -579,6 +592,7 @@ components: - type type: object PaymentMethodScheduledForRemovalNotificationRequest: + additionalProperties: false properties: createdAt: description: Timestamp for when the webhook was created. @@ -605,6 +619,7 @@ components: - type type: object RemediatingAction: + additionalProperties: false properties: code: description: The remediating action code. @@ -614,6 +629,7 @@ components: type: string type: object VerificationError: + additionalProperties: false properties: code: description: The verification error code. @@ -643,6 +659,7 @@ components: type: string type: object VerificationError-recursive: + additionalProperties: false properties: code: description: The verification error code. diff --git a/yaml/ManagementService-v1.yaml b/yaml/ManagementService-v1.yaml index 6ecc7f70..7f13a65a 100644 --- a/yaml/ManagementService-v1.yaml +++ b/yaml/ManagementService-v1.yaml @@ -9823,6 +9823,7 @@ paths: components: schemas: AdditionalCommission: + additionalProperties: false properties: balanceAccountId: description: Unique identifier of the balance account to which the additional @@ -9838,6 +9839,7 @@ components: type: integer type: object AdditionalSettings: + additionalProperties: false properties: includeEventCodes: description: 'Object containing list of event codes for which the notifcation @@ -9858,6 +9860,7 @@ components: type: object type: object AdditionalSettingsResponse: + additionalProperties: false properties: excludeEventCodes: description: 'Object containing list of event codes for which the notifcation @@ -9884,6 +9887,7 @@ components: type: object type: object Address: + additionalProperties: false properties: city: description: The name of the city. @@ -9912,6 +9916,7 @@ components: type: string type: object AfterpayTouchInfo: + additionalProperties: false properties: supportUrl: description: Support Url @@ -9920,6 +9925,7 @@ components: - supportUrl type: object AllowedOrigin: + additionalProperties: false properties: _links: description: References to resources linked to the allowed origin. @@ -9935,6 +9941,7 @@ components: - domain type: object AllowedOriginsResponse: + additionalProperties: false properties: data: description: List of allowed origins. @@ -9943,6 +9950,7 @@ components: type: array type: object Amount: + additionalProperties: false properties: currency: description: The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes). @@ -9958,6 +9966,7 @@ components: - currency type: object AndroidApp: + additionalProperties: false properties: description: description: The description that was provided when uploading the app. The @@ -9997,6 +10006,7 @@ components: - status type: object AndroidAppsResponse: + additionalProperties: false properties: data: description: Apps uploaded for Android payment terminals. @@ -10005,6 +10015,7 @@ components: type: array type: object AndroidCertificate: + additionalProperties: false properties: description: description: The description that was provided when uploading the certificate. @@ -10034,6 +10045,7 @@ components: - id type: object AndroidCertificatesResponse: + additionalProperties: false properties: data: description: Uploaded Android certificates for Android payment terminals. @@ -10042,6 +10054,7 @@ components: type: array type: object ApiCredential: + additionalProperties: false properties: _links: description: References to resources linked to the API credential. @@ -10097,6 +10110,7 @@ components: - active type: object ApiCredentialLinks: + additionalProperties: false properties: allowedOrigins: description: List of allowed origins. @@ -10125,6 +10139,7 @@ components: - self type: object ApplePayInfo: + additionalProperties: false properties: domains: description: 'The list of merchant domains. Maximum: 99 domains per request. @@ -10138,6 +10153,7 @@ components: - domains type: object BcmcInfo: + additionalProperties: false properties: enableBcmcMobile: description: Indicates if [Bancontact mobile](https://docs.adyen.com/payment-methods/bancontact/bancontact-mobile) @@ -10148,6 +10164,7 @@ components: $ref: '#/components/schemas/TransactionDescriptionInfo' type: object BillingEntitiesResponse: + additionalProperties: false properties: data: description: List of legal entities that can be used for the billing of @@ -10157,6 +10174,7 @@ components: type: array type: object BillingEntity: + additionalProperties: false properties: address: description: The address details of the billing entity. @@ -10176,6 +10194,7 @@ components: type: string type: object CardholderReceipt: + additionalProperties: false properties: headerForAuthorizedReceipt: description: A custom header to show on the shopper receipt for an authorised @@ -10184,6 +10203,7 @@ components: type: string type: object CartesBancairesInfo: + additionalProperties: false properties: siret: description: 'Cartes Bancaires SIRET. Format: 14 digits.' @@ -10195,6 +10215,7 @@ components: - siret type: object ClearpayInfo: + additionalProperties: false properties: supportUrl: description: Support Url @@ -10203,6 +10224,7 @@ components: - supportUrl type: object Commission: + additionalProperties: false properties: fixedAmount: description: A fixed commission fee, in minor units. @@ -10214,6 +10236,7 @@ components: type: integer type: object Company: + additionalProperties: false properties: _links: description: References to resources connected with this company. @@ -10257,6 +10280,7 @@ components: type: string type: object CompanyApiCredential: + additionalProperties: false properties: _links: description: References to resources linked to the API credential. @@ -10320,6 +10344,7 @@ components: - active type: object CompanyLinks: + additionalProperties: false properties: apiCredentials: $ref: '#/components/schemas/LinksElement' @@ -10334,6 +10359,7 @@ components: - self type: object CompanyUser: + additionalProperties: false properties: _links: description: References to resources connected with this user. @@ -10390,6 +10416,7 @@ components: - roles type: object Configuration: + additionalProperties: false properties: brand: description: 'Payment method, like **eftpos_australia** or **mc**. See the @@ -10420,6 +10447,7 @@ components: - currencies type: object Connectivity: + additionalProperties: false properties: simcardStatus: description: 'Indicates the status of the SIM card in the payment terminal. @@ -10440,6 +10468,7 @@ components: type: string type: object Contact: + additionalProperties: false properties: email: description: The individual's email address. @@ -10459,6 +10488,7 @@ components: type: string type: object CreateAllowedOriginRequest: + additionalProperties: false properties: _links: description: References to resources linked to the allowed origin. @@ -10474,6 +10504,7 @@ components: - domain type: object CreateApiCredentialResponse: + additionalProperties: false properties: _links: description: References to resources linked to the API credential. @@ -10537,6 +10568,7 @@ components: - apiKey type: object CreateCompanyApiCredentialRequest: + additionalProperties: false properties: allowedOrigins: description: List of [allowed origins](https://docs.adyen.com/development-resources/client-side-authentication#allowed-origins) @@ -10562,6 +10594,7 @@ components: type: array type: object CreateCompanyApiCredentialResponse: + additionalProperties: false properties: _links: description: References to resources linked to the API credential. @@ -10632,6 +10665,7 @@ components: - associatedMerchantAccounts type: object CreateCompanyUserRequest: + additionalProperties: false properties: accountGroups: description: The list of [account groups](https://docs.adyen.com/account/account-structure#account-groups) @@ -10675,6 +10709,7 @@ components: - username type: object CreateCompanyUserResponse: + additionalProperties: false properties: _links: description: References to resources connected with this user. @@ -10731,6 +10766,7 @@ components: - roles type: object CreateCompanyWebhookRequest: + additionalProperties: false properties: acceptsExpiredCertificate: description: 'Indicates if expired SSL certificates are accepted. Default @@ -10890,6 +10926,7 @@ components: - filterMerchantAccounts type: object CreateMerchantApiCredentialRequest: + additionalProperties: false properties: allowedOrigins: description: The list of [allowed origins](https://docs.adyen.com/development-resources/client-side-authentication#allowed-origins) @@ -10909,6 +10946,7 @@ components: type: array type: object CreateMerchantRequest: + additionalProperties: false properties: businessLineId: description: The unique identifier of the [business line](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/businessLines). @@ -10948,6 +10986,7 @@ components: - companyId type: object CreateMerchantResponse: + additionalProperties: false properties: businessLineId: description: The unique identifier of the [business line](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/businessLines). @@ -10977,6 +11016,7 @@ components: type: string type: object CreateMerchantUserRequest: + additionalProperties: false properties: accountGroups: description: The list of [account groups](https://docs.adyen.com/account/account-structure#account-groups) @@ -11014,6 +11054,7 @@ components: - username type: object CreateMerchantWebhookRequest: + additionalProperties: false properties: acceptsExpiredCertificate: description: 'Indicates if expired SSL certificates are accepted. Default @@ -11141,6 +11182,7 @@ components: - type type: object CreateUserResponse: + additionalProperties: false properties: _links: description: References to resources connected with this user. @@ -11191,6 +11233,7 @@ components: - roles type: object Currency: + additionalProperties: false properties: amount: description: Surcharge amount per transaction, in [minor units](https://docs.adyen.com/development-resources/currency-codes). @@ -11209,6 +11252,7 @@ components: - currencyCode type: object CustomNotification: + additionalProperties: false properties: amount: description: The amount of the payment that the notification is about. Set @@ -11269,6 +11313,7 @@ components: type: boolean type: object DataCenter: + additionalProperties: false properties: livePrefix: description: 'The unique [live URL prefix](https://docs.adyen.com/development-resources/live-endpoints#live-url-prefix) @@ -11285,6 +11330,7 @@ components: type: string type: object EventUrl: + additionalProperties: false properties: eventLocalUrls: description: One or more local URLs to send event notifications to when @@ -11300,6 +11346,7 @@ components: type: array type: object ExternalTerminalAction: + additionalProperties: false properties: actionType: description: 'The type of terminal action: **InstallAndroidApp**, **UninstallAndroidApp**, @@ -11331,6 +11378,7 @@ components: type: string type: object File: + additionalProperties: false properties: data: description: The certificate content converted to a Base64-encoded string. @@ -11343,6 +11391,7 @@ components: - data type: object GenerateApiKeyResponse: + additionalProperties: false properties: apiKey: description: The generated API key. @@ -11351,6 +11400,7 @@ components: - apiKey type: object GenerateClientKeyResponse: + additionalProperties: false properties: clientKey: description: Generated client key @@ -11359,6 +11409,7 @@ components: - clientKey type: object GenerateHmacKeyResponse: + additionalProperties: false properties: hmacKey: description: The HMAC key generated for this webhook. @@ -11367,12 +11418,14 @@ components: - hmacKey type: object GenericPmWithTdiInfo: + additionalProperties: false properties: transactionDescription: description: Information regarding the transaction description. $ref: '#/components/schemas/TransactionDescriptionInfo' type: object GiroPayInfo: + additionalProperties: false properties: supportEmail: description: The email address of merchant support. @@ -11381,6 +11434,7 @@ components: - supportEmail type: object GooglePayInfo: + additionalProperties: false properties: merchantId: description: 'Google Pay [Merchant ID](https://support.google.com/paymentscenter/answer/7163092?hl=en). @@ -11397,6 +11451,7 @@ components: - merchantId type: object Gratuity: + additionalProperties: false properties: allowCustomAmount: description: Indicates whether one of the predefined tipping options is @@ -11427,6 +11482,7 @@ components: type: boolean type: object Hardware: + additionalProperties: false properties: displayMaximumBackLight: description: The brightness of the display when the terminal is being used, @@ -11448,6 +11504,7 @@ components: type: integer type: object IdName: + additionalProperties: false properties: id: description: The identifier of the terminal model. @@ -11483,6 +11540,7 @@ components: type: string type: object InvalidField: + additionalProperties: false properties: message: description: Description of the validation error. @@ -11505,6 +11563,7 @@ components: JSONObject: type: object Key: + additionalProperties: false properties: identifier: description: The unique identifier of the shared key. @@ -11518,6 +11577,7 @@ components: type: integer type: object KlarnaInfo: + additionalProperties: false properties: autoCapture: description: 'Indicates the status of [Automatic capture](https://docs.adyen.com/online-payments/capture#automatic-capture). @@ -11546,6 +11606,7 @@ components: - disputeEmail type: object Links: + additionalProperties: false properties: self: description: Link to the resource itself. @@ -11554,11 +11615,13 @@ components: - self type: object LinksElement: + additionalProperties: false properties: href: type: string type: object ListCompanyApiCredentialsResponse: + additionalProperties: false properties: _links: description: Pagination references. @@ -11581,6 +11644,7 @@ components: - pagesTotal type: object ListCompanyResponse: + additionalProperties: false properties: _links: description: Pagination references. @@ -11603,6 +11667,7 @@ components: - pagesTotal type: object ListCompanyUsersResponse: + additionalProperties: false properties: _links: description: Pagination references. @@ -11625,6 +11690,7 @@ components: - pagesTotal type: object ListExternalTerminalActionsResponse: + additionalProperties: false properties: data: description: The list of terminal actions. @@ -11633,6 +11699,7 @@ components: type: array type: object ListMerchantApiCredentialsResponse: + additionalProperties: false properties: _links: description: Pagination references. @@ -11655,6 +11722,7 @@ components: - pagesTotal type: object ListMerchantResponse: + additionalProperties: false properties: _links: description: Pagination references. @@ -11677,6 +11745,7 @@ components: - pagesTotal type: object ListMerchantUsersResponse: + additionalProperties: false properties: _links: description: Pagination references. @@ -11699,6 +11768,7 @@ components: - pagesTotal type: object ListStoresResponse: + additionalProperties: false properties: _links: description: Pagination references. @@ -11721,6 +11791,7 @@ components: - pagesTotal type: object ListTerminalsResponse: + additionalProperties: false properties: _links: description: Pagination references. @@ -11743,6 +11814,7 @@ components: - pagesTotal type: object ListWebhooksResponse: + additionalProperties: false properties: _links: description: Pagination references. @@ -11768,6 +11840,7 @@ components: - pagesTotal type: object Localization: + additionalProperties: false properties: language: description: Language of the terminal. @@ -11780,6 +11853,7 @@ components: type: string type: object Logo: + additionalProperties: false properties: data: description: The image file, converted to a Base64-encoded string, of the @@ -11788,6 +11862,7 @@ components: type: string type: object MeApiCredential: + additionalProperties: false properties: _links: description: References to resources linked to the API credential. @@ -11854,6 +11929,7 @@ components: - active type: object MealVoucherFRInfo: + additionalProperties: false properties: conecsId: description: 'Meal Voucher conecsId. Format: digits only' @@ -11875,6 +11951,7 @@ components: - subTypes type: object Merchant: + additionalProperties: false properties: _links: description: References to resources connected with this merchant. @@ -11966,6 +12043,7 @@ components: type: string type: object MerchantLinks: + additionalProperties: false properties: apiCredentials: $ref: '#/components/schemas/LinksElement' @@ -11980,6 +12058,7 @@ components: - self type: object MinorUnitsMonetaryValue: + additionalProperties: false properties: amount: description: The transaction amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes). @@ -11990,6 +12069,7 @@ components: type: string type: object Name: + additionalProperties: false properties: firstName: description: The first name. @@ -12004,6 +12084,7 @@ components: - lastName type: object Name2: + additionalProperties: false properties: firstName: description: The first name. @@ -12015,6 +12096,7 @@ components: type: string type: object Nexo: + additionalProperties: false properties: displayUrls: description: The list of local and public URLs to send display notifications @@ -12043,6 +12125,7 @@ components: $ref: '#/components/schemas/Notification' type: object Notification: + additionalProperties: false properties: category: description: The type of event notification sent when you select the notification @@ -12071,6 +12154,7 @@ components: type: string type: object NotificationUrl: + additionalProperties: false properties: localUrls: description: One or more local URLs to send notifications to when using @@ -12086,6 +12170,7 @@ components: type: array type: object OfflineProcessing: + additionalProperties: false properties: chipFloorLimit: description: The maximum offline transaction amount for chip cards, in the @@ -12100,6 +12185,7 @@ components: type: array type: object Opi: + additionalProperties: false properties: enablePayAtTable: description: Indicates if Pay at table is enabled. @@ -12112,6 +12198,7 @@ components: type: string type: object OrderItem: + additionalProperties: false properties: id: description: The unique identifier of the product. @@ -12130,6 +12217,7 @@ components: type: integer type: object PaginationLinks: + additionalProperties: false properties: first: description: The first page. @@ -12152,6 +12240,7 @@ components: - last type: object Passcodes: + additionalProperties: false properties: adminMenuPin: description: The passcode for the Admin menu and the Settings menu. @@ -12173,6 +12262,7 @@ components: type: string type: object PayAtTable: + additionalProperties: false properties: authenticationMethod: description: 'Allowed authentication methods: Magswipe, Manual Entry.' @@ -12193,6 +12283,7 @@ components: type: string type: object PayPalInfo: + additionalProperties: false properties: directCapture: description: 'Indicates if direct (immediate) capture for PayPal is enabled. @@ -12213,6 +12304,7 @@ components: - payerId type: object Payment: + additionalProperties: false properties: contactlessCurrency: description: The default currency for contactless payments on the payment @@ -12228,6 +12320,7 @@ components: type: array type: object PaymentMethod: + additionalProperties: false properties: afterpayTouch: description: Afterpay Touch details. @@ -12372,6 +12465,7 @@ components: - id type: object PaymentMethodResponse: + additionalProperties: false properties: _links: description: Pagination references. @@ -12449,6 +12543,7 @@ components: - pagesTotal type: object PaymentMethodSetupInfo: + additionalProperties: false properties: afterpayTouch: description: Afterpay Touch details. @@ -12630,6 +12725,7 @@ components: PaymentMethod: $ref: '#/components/schemas/PaymentMethod' PayoutSettings: + additionalProperties: false properties: allowed: description: 'Indicates if payouts to the bank account are allowed. This @@ -12713,6 +12809,7 @@ components: - id type: object PayoutSettingsRequest: + additionalProperties: false properties: enabled: description: 'Indicates if payouts to this bank account are enabled. Default: @@ -12751,6 +12848,7 @@ components: - transferInstrumentId type: object PayoutSettingsResponse: + additionalProperties: false properties: data: description: The list of payout accounts. @@ -12759,6 +12857,7 @@ components: type: array type: object Profile: + additionalProperties: false properties: authType: description: 'The type of Wi-Fi network. Possible values: **wpa-psk**, **wpa2-psk**, @@ -12841,6 +12940,7 @@ components: - wsec type: object ReceiptOptions: + additionalProperties: false properties: logo: description: The receipt logo converted to a Base64-encoded string. The @@ -12859,6 +12959,7 @@ components: type: string type: object ReceiptPrinting: + additionalProperties: false properties: merchantApproved: description: Print a merchant receipt when the payment is approved. @@ -12910,6 +13011,7 @@ components: type: boolean type: object Referenced: + additionalProperties: false properties: enableStandaloneRefunds: description: Indicates whether referenced refunds are enabled on the standalone @@ -12917,6 +13019,7 @@ components: type: boolean type: object Refunds: + additionalProperties: false properties: referenced: description: Settings for referenced refunds. @@ -12938,6 +13041,7 @@ components: type: boolean type: object RequestActivationResponse: + additionalProperties: false properties: companyId: description: The unique identifier of the company account. @@ -12948,6 +13052,7 @@ components: type: string type: object RestServiceError: + additionalProperties: false properties: detail: description: A human-readable explanation specific to this occurrence of @@ -12991,6 +13096,7 @@ components: - status type: object ScheduleTerminalActionsRequest: + additionalProperties: false properties: actionDetails: description: Information about the action to take. @@ -13023,6 +13129,7 @@ components: type: array type: object ScheduleTerminalActionsResponse: + additionalProperties: false properties: actionDetails: description: Information about the action to take. @@ -13081,6 +13188,7 @@ components: type: integer type: object Settings: + additionalProperties: false properties: band: description: 'The preferred Wi-Fi band, for use if the terminals support @@ -13095,6 +13203,7 @@ components: type: integer type: object ShippingLocation: + additionalProperties: false properties: address: description: The address details of the shipping location. @@ -13111,6 +13220,7 @@ components: type: string type: object ShippingLocationsResponse: + additionalProperties: false properties: data: description: Physical locations where orders can be shipped to. @@ -13119,6 +13229,7 @@ components: type: array type: object Signature: + additionalProperties: false properties: askSignatureOnScreen: description: If `skipSignature` is false, indicates whether the shopper @@ -13139,6 +13250,7 @@ components: type: boolean type: object SofortInfo: + additionalProperties: false properties: currencyCode: description: Sofort currency code. For example, **EUR**. @@ -13151,6 +13263,7 @@ components: - currencyCode type: object SplitConfiguration: + additionalProperties: false properties: description: description: Your description for the split configuration. @@ -13176,6 +13289,7 @@ components: - rules type: object SplitConfigurationList: + additionalProperties: false properties: data: description: List of split configurations applied to the stores under the @@ -13185,6 +13299,7 @@ components: type: array type: object SplitConfigurationLogic: + additionalProperties: false properties: acquiringFees: description: 'Deducts the acquiring fees (the aggregated amount of interchange @@ -13279,10 +13394,10 @@ components: - [`adyenCommission`](https://docs.adyen.com/api-explorer/Management/latest/post/merchants/(merchantId)/splitConfigurations#request-rules-splitLogic-adyenCommission): - The transaction fee due to Adyen under [blended rates](https://www.adyen.com/knowledge-hub/guides/payments-training-guide/get-the-best-from-your-card-processing). + The transaction fee due to Adyen under [blended rates](https://www.adyen.com/knowledge-hub/interchange-fees-explained#interchange-vs-blended). - [`adyenMarkup`](https://docs.adyen.com/api-explorer/Management/latest/post/merchants/(merchantId)/splitConfigurations#request-rules-splitLogic-adyenMarkup): - The transaction fee due to Adyen under [Interchange ++ pricing](https://www.adyen.com/what-is-interchange). + The transaction fee due to Adyen under [Interchange ++ pricing](https://www.adyen.com/knowledge-hub/interchange-fees-explained#interchange-vs-blended). - [`schemeFee`](https://docs.adyen.com/api-explorer/Management/latest/post/merchants/(merchantId)/splitConfigurations#request-rules-splitLogic-schemeFee): The fee paid to the card scheme for using their network. @@ -13320,6 +13435,15 @@ components: - deductFromOneBalanceAccount - deductAccordingToSplitRatio type: string + refundCostAllocation: + description: 'Deducts the refund costs from the specified balance account. + + + Possible values: **deductFromLiableAccount**, **deductFromOneBalanceAccount**' + enum: + - deductFromLiableAccount + - deductFromOneBalanceAccount + type: string remainder: description: 'Books the amount left over after currency conversion to the specified balance account. @@ -13366,6 +13490,7 @@ components: - commission type: object SplitConfigurationRule: + additionalProperties: false properties: currency: description: 'The currency condition that defines whether the split logic @@ -13437,6 +13562,7 @@ components: - splitLogic type: object Standalone: + additionalProperties: false properties: currencyCode: description: The default currency of the standalone payment terminal as @@ -13449,6 +13575,7 @@ components: type: boolean type: object Store: + additionalProperties: false properties: _links: description: Reference to resources connected with the store. @@ -13519,7 +13646,27 @@ components: - inactive type: string type: object + StoreAndForward: + additionalProperties: false + properties: + maxAmount: + description: The maximum amount that the terminal accepts for a single store-and-forward + payment. + items: + $ref: '#/components/schemas/MinorUnitsMonetaryValue' + type: array + maxPayments: + description: The maximum number of store-and-forward transactions per terminal + that you can process while offline. + format: int32 + type: integer + supportedCardTypes: + description: 'The type of card for which the terminal accepts store-and-forward + payments. You can specify multiple card types. ' + $ref: '#/components/schemas/SupportedCardTypes' + type: object StoreCreationRequest: + additionalProperties: false properties: address: description: The address of the store. @@ -13578,6 +13725,7 @@ components: - address type: object StoreCreationWithMerchantCodeRequest: + additionalProperties: false properties: address: description: The address of the store. @@ -13641,6 +13789,7 @@ components: - merchantId type: object StoreLocation: + additionalProperties: false properties: city: description: The name of the city. @@ -13671,6 +13820,7 @@ components: - country type: object StoreSplitConfiguration: + additionalProperties: false properties: balanceAccountId: description: The [unique identifier of the balance account](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/get/balanceAccounts/{id}__queryParam_id) @@ -13681,7 +13831,28 @@ components: description: The unique identifier of the [split configuration profile](https://docs.adyen.com/marketplaces-and-platforms/automatic-split-configuration/create-split-configuration/). type: string type: object + SupportedCardTypes: + additionalProperties: false + properties: + credit: + description: Set to **true** to accept credit cards. + type: boolean + debit: + description: Set to **true** to accept debit cards. + type: boolean + deferredDebit: + description: Set to **true** to accept cards that allow deferred debit. + type: boolean + prepaid: + description: Set to **true** to accept prepaid cards. + type: boolean + unknown: + description: Set to **true** to accept card types for which the terminal + can't determine the funding source while offline. + type: boolean + type: object Surcharge: + additionalProperties: false properties: askConfirmation: description: Show the surcharge details on the terminal, so the shopper @@ -13695,6 +13866,7 @@ components: type: array type: object SwishInfo: + additionalProperties: false properties: swishNumber: description: 'Swish number. Format: 10 digits without spaces. For example, @@ -13706,12 +13878,14 @@ components: - swishNumber type: object TapToPay: + additionalProperties: false properties: merchantDisplayName: description: The text shown on the screen during the Tap to Pay transaction. type: string type: object Terminal: + additionalProperties: false properties: assigned: deprecated: true @@ -13818,6 +13992,7 @@ components: type: string type: object TerminalActionScheduleDetail: + additionalProperties: false properties: id: description: The ID of the action on the specified terminal. @@ -13827,6 +14002,7 @@ components: type: string type: object TerminalInstructions: + additionalProperties: false properties: adyenAppRestart: description: Indicates whether the Adyen app on the payment terminal restarts @@ -13834,6 +14010,7 @@ components: type: boolean type: object TerminalModelsResponse: + additionalProperties: false properties: data: description: The terminal models that the API credential has access to. @@ -13842,6 +14019,7 @@ components: type: array type: object TerminalOrder: + additionalProperties: false properties: billingEntity: description: The details of the entity that the order is billed to. @@ -13874,6 +14052,7 @@ components: type: string type: object TerminalOrderRequest: + additionalProperties: false properties: billingEntityId: description: The identification of the billing entity to use for the order. @@ -13898,6 +14077,7 @@ components: type: string type: object TerminalOrdersResponse: + additionalProperties: false properties: data: description: List of orders for payment terminal packages and parts. @@ -13906,6 +14086,7 @@ components: type: array type: object TerminalProduct: + additionalProperties: false properties: description: description: Information about items included and integration options. @@ -13926,6 +14107,7 @@ components: $ref: '#/components/schemas/TerminalProductPrice' type: object TerminalProductPrice: + additionalProperties: false properties: currency: description: The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes). @@ -13936,6 +14118,7 @@ components: type: number type: object TerminalProductsResponse: + additionalProperties: false properties: data: description: Terminal products that can be ordered. @@ -13944,6 +14127,7 @@ components: type: array type: object TerminalSettings: + additionalProperties: false properties: cardholderReceipt: description: Settings to define the header of the shopper receipt. @@ -14002,6 +14186,11 @@ components: description: Settings for [standalone](https://docs.adyen.com/point-of-sale/standalone/standalone-build/set-up-standalone#set-up-standalone-using-an-api-call) features. $ref: '#/components/schemas/Standalone' + storeAndForward: + description: Settings for store-and-forward offline payments. The maxAmount, + maxPayments, and supportedCardTypes parameters must be configured, either + in the request or inherited from a higher level in your account structure. + $ref: '#/components/schemas/StoreAndForward' surcharge: description: Settings for payment [surcharge](https://docs.adyen.com/point-of-sale/surcharge) features. @@ -14020,6 +14209,7 @@ components: $ref: '#/components/schemas/WifiProfiles' type: object TestCompanyWebhookRequest: + additionalProperties: false properties: merchantIds: description: 'List of `merchantId` values for which test webhooks will be @@ -14054,6 +14244,7 @@ components: type: array type: object TestOutput: + additionalProperties: false properties: merchantId: description: Unique identifier of the merchant account that the notification @@ -14107,6 +14298,7 @@ components: - status type: object TestWebhookRequest: + additionalProperties: false properties: notification: description: Custom test notification object. Required when the [`types`](https://docs.adyen.com/api-explorer/#/ManagementService/v1/post/companies/{companyId}/webhooks/{webhookId}/test__reqParam_types) @@ -14129,6 +14321,7 @@ components: type: array type: object TestWebhookResponse: + additionalProperties: false properties: data: description: List with test results. Each test webhook we send has a list @@ -14138,6 +14331,7 @@ components: type: array type: object Timeouts: + additionalProperties: false properties: fromActiveToSleep: description: Indicates the number of seconds of inactivity after which the @@ -14146,6 +14340,7 @@ components: type: integer type: object TransactionDescriptionInfo: + additionalProperties: false properties: doingBusinessAsName: description: "The text to be shown on the shopper's bank statement.\n We\ @@ -14177,6 +14372,7 @@ components: type: string type: object TwintInfo: + additionalProperties: false properties: logo: description: 'Twint logo. Format: Base64-encoded string.' @@ -14211,6 +14407,7 @@ components: type: string type: object UpdatableAddress: + additionalProperties: false properties: city: description: The name of the city. @@ -14235,6 +14432,7 @@ components: type: string type: object UpdateCompanyApiCredentialRequest: + additionalProperties: false properties: active: description: Indicates if the API credential is enabled. @@ -14263,6 +14461,7 @@ components: type: array type: object UpdateCompanyUserRequest: + additionalProperties: false properties: accountGroups: description: The list of [account groups](https://docs.adyen.com/account/account-structure#account-groups) @@ -14299,6 +14498,7 @@ components: type: string type: object UpdateCompanyWebhookRequest: + additionalProperties: false properties: acceptsExpiredCertificate: description: 'Indicates if expired SSL certificates are accepted. Default @@ -14424,6 +14624,7 @@ components: type: string type: object UpdateMerchantApiCredentialRequest: + additionalProperties: false properties: active: description: Indicates if the API credential is enabled. @@ -14446,6 +14647,7 @@ components: type: array type: object UpdateMerchantUserRequest: + additionalProperties: false properties: accountGroups: description: The list of [account groups](https://docs.adyen.com/account/account-structure#account-groups) @@ -14477,6 +14679,7 @@ components: type: string type: object UpdateMerchantWebhookRequest: + additionalProperties: false properties: acceptsExpiredCertificate: description: 'Indicates if expired SSL certificates are accepted. Default @@ -14568,6 +14771,7 @@ components: type: string type: object UpdatePaymentMethodInfo: + additionalProperties: false properties: bcmc: description: Bancontact details. @@ -14636,6 +14840,7 @@ components: $ref: '#/components/schemas/GenericPmWithTdiInfo' type: object UpdatePayoutSettingsRequest: + additionalProperties: false properties: enabled: description: 'Indicates if payouts to this bank account are enabled. Default: @@ -14647,6 +14852,7 @@ components: type: boolean type: object UpdateSplitConfigurationLogicRequest: + additionalProperties: false properties: acquiringFees: description: 'Deducts the acquiring fees (the aggregated amount of interchange @@ -14741,10 +14947,10 @@ components: - [`adyenCommission`](https://docs.adyen.com/api-explorer/Management/latest/post/merchants/(merchantId)/splitConfigurations#request-rules-splitLogic-adyenCommission): - The transaction fee due to Adyen under [blended rates](https://www.adyen.com/knowledge-hub/guides/payments-training-guide/get-the-best-from-your-card-processing). + The transaction fee due to Adyen under [blended rates](https://www.adyen.com/knowledge-hub/interchange-fees-explained#interchange-vs-blended). - [`adyenMarkup`](https://docs.adyen.com/api-explorer/Management/latest/post/merchants/(merchantId)/splitConfigurations#request-rules-splitLogic-adyenMarkup): - The transaction fee due to Adyen under [Interchange ++ pricing](https://www.adyen.com/what-is-interchange). + The transaction fee due to Adyen under [Interchange ++ pricing](https://www.adyen.com/knowledge-hub/interchange-fees-explained#interchange-vs-blended). - [`schemeFee`](https://docs.adyen.com/api-explorer/Management/latest/post/merchants/(merchantId)/splitConfigurations#request-rules-splitLogic-schemeFee): The fee paid to the card scheme for using their network. @@ -14782,6 +14988,15 @@ components: - deductFromOneBalanceAccount - deductAccordingToSplitRatio type: string + refundCostAllocation: + description: 'Deducts the refund costs from the specified balance account. + + + Possible values: **deductFromLiableAccount**, **deductFromOneBalanceAccount**' + enum: + - deductFromLiableAccount + - deductFromOneBalanceAccount + type: string remainder: description: 'Books the amount left over after currency conversion to the specified balance account. @@ -14828,6 +15043,7 @@ components: - commission type: object UpdateSplitConfigurationRequest: + additionalProperties: false properties: description: description: Your description for the split configuration. @@ -14837,6 +15053,7 @@ components: - description type: object UpdateSplitConfigurationRuleRequest: + additionalProperties: false properties: currency: description: 'The currency condition that defines whether the split logic @@ -14889,6 +15106,7 @@ components: - currency type: object UpdateStoreRequest: + additionalProperties: false properties: address: description: The address of the store. It is not possible to update the @@ -14941,6 +15159,7 @@ components: type: string type: object Url: + additionalProperties: false properties: encrypted: description: Indicates if the message sent to this URL should be encrypted. @@ -14956,6 +15175,7 @@ components: type: string type: object User: + additionalProperties: false properties: _links: description: References to resources connected with this user. @@ -15006,6 +15226,7 @@ components: - roles type: object VippsInfo: + additionalProperties: false properties: logo: description: 'Vipps logo. Format: Base64-encoded string.' @@ -15018,6 +15239,7 @@ components: - logo type: object Webhook: + additionalProperties: false properties: _links: description: References to resources connected with this webhook. @@ -15190,6 +15412,7 @@ components: - communicationFormat type: object WebhookLinks: + additionalProperties: false properties: company: description: The company account that the webhook is configured for. Only @@ -15214,6 +15437,7 @@ components: - generateHmac type: object WifiProfiles: + additionalProperties: false properties: profiles: description: List of remote Wi-Fi profiles. diff --git a/yaml/ManagementService-v3.yaml b/yaml/ManagementService-v3.yaml index 62e41bcc..1bb9021d 100644 --- a/yaml/ManagementService-v3.yaml +++ b/yaml/ManagementService-v3.yaml @@ -9947,6 +9947,7 @@ paths: components: schemas: AdditionalCommission: + additionalProperties: false properties: balanceAccountId: description: Unique identifier of the balance account to which the additional @@ -9962,6 +9963,7 @@ components: type: integer type: object AdditionalSettings: + additionalProperties: false properties: includeEventCodes: description: 'Object containing list of event codes for which the notifcation @@ -9982,6 +9984,7 @@ components: type: object type: object AdditionalSettingsResponse: + additionalProperties: false properties: excludeEventCodes: description: 'Object containing list of event codes for which the notifcation @@ -10008,6 +10011,7 @@ components: type: object type: object Address: + additionalProperties: false properties: city: description: The name of the city. @@ -10036,6 +10040,7 @@ components: type: string type: object AfterpayTouchInfo: + additionalProperties: false properties: supportUrl: description: Support Url @@ -10044,6 +10049,7 @@ components: - supportUrl type: object AllowedOrigin: + additionalProperties: false properties: _links: description: References to resources linked to the allowed origin. @@ -10059,6 +10065,7 @@ components: - domain type: object AllowedOriginsResponse: + additionalProperties: false properties: data: description: List of allowed origins. @@ -10067,6 +10074,7 @@ components: type: array type: object Amount: + additionalProperties: false properties: currency: description: The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes). @@ -10082,6 +10090,7 @@ components: - currency type: object AndroidApp: + additionalProperties: false properties: description: description: The description that was provided when uploading the app. The @@ -10121,6 +10130,7 @@ components: - status type: object AndroidAppsResponse: + additionalProperties: false properties: data: description: Apps uploaded for Android payment terminals. @@ -10129,6 +10139,7 @@ components: type: array type: object AndroidCertificate: + additionalProperties: false properties: description: description: The description that was provided when uploading the certificate. @@ -10158,6 +10169,7 @@ components: - id type: object AndroidCertificatesResponse: + additionalProperties: false properties: data: description: Uploaded Android certificates for Android payment terminals. @@ -10166,6 +10178,7 @@ components: type: array type: object ApiCredential: + additionalProperties: false properties: _links: description: References to resources linked to the API credential. @@ -10221,6 +10234,7 @@ components: - active type: object ApiCredentialLinks: + additionalProperties: false properties: allowedOrigins: description: List of allowed origins. @@ -10249,6 +10263,7 @@ components: - self type: object ApplePayInfo: + additionalProperties: false properties: domains: description: 'The list of merchant domains. Maximum: 99 domains per request. @@ -10262,6 +10277,7 @@ components: - domains type: object BcmcInfo: + additionalProperties: false properties: enableBcmcMobile: description: Indicates if [Bancontact mobile](https://docs.adyen.com/payment-methods/bancontact/bancontact-mobile) @@ -10272,6 +10288,7 @@ components: $ref: '#/components/schemas/TransactionDescriptionInfo' type: object BillingEntitiesResponse: + additionalProperties: false properties: data: description: List of legal entities that can be used for the billing of @@ -10281,6 +10298,7 @@ components: type: array type: object BillingEntity: + additionalProperties: false properties: address: description: The address details of the billing entity. @@ -10300,6 +10318,7 @@ components: type: string type: object CardholderReceipt: + additionalProperties: false properties: headerForAuthorizedReceipt: description: A custom header to show on the shopper receipt for an authorised @@ -10308,6 +10327,7 @@ components: type: string type: object CartesBancairesInfo: + additionalProperties: false properties: siret: description: 'Cartes Bancaires SIRET. Format: 14 digits.' @@ -10319,6 +10339,7 @@ components: - siret type: object ClearpayInfo: + additionalProperties: false properties: supportUrl: description: Support Url @@ -10327,6 +10348,7 @@ components: - supportUrl type: object Commission: + additionalProperties: false properties: fixedAmount: description: A fixed commission fee, in minor units. @@ -10338,6 +10360,7 @@ components: type: integer type: object Company: + additionalProperties: false properties: _links: description: References to resources connected with this company. @@ -10381,6 +10404,7 @@ components: type: string type: object CompanyApiCredential: + additionalProperties: false properties: _links: description: References to resources linked to the API credential. @@ -10444,6 +10468,7 @@ components: - active type: object CompanyLinks: + additionalProperties: false properties: apiCredentials: $ref: '#/components/schemas/LinksElement' @@ -10458,6 +10483,7 @@ components: - self type: object CompanyUser: + additionalProperties: false properties: _links: description: References to resources connected with this user. @@ -10514,6 +10540,7 @@ components: - roles type: object Configuration: + additionalProperties: false properties: brand: description: 'Payment method, like **eftpos_australia** or **mc**. See the @@ -10544,6 +10571,7 @@ components: - currencies type: object Connectivity: + additionalProperties: false properties: simcardStatus: description: 'Indicates the status of the SIM card in the payment terminal. @@ -10564,6 +10592,7 @@ components: type: string type: object Contact: + additionalProperties: false properties: email: description: The individual's email address. @@ -10583,6 +10612,7 @@ components: type: string type: object CreateAllowedOriginRequest: + additionalProperties: false properties: _links: description: References to resources linked to the allowed origin. @@ -10598,6 +10628,7 @@ components: - domain type: object CreateApiCredentialResponse: + additionalProperties: false properties: _links: description: References to resources linked to the API credential. @@ -10661,6 +10692,7 @@ components: - apiKey type: object CreateCompanyApiCredentialRequest: + additionalProperties: false properties: allowedOrigins: description: List of [allowed origins](https://docs.adyen.com/development-resources/client-side-authentication#allowed-origins) @@ -10686,6 +10718,7 @@ components: type: array type: object CreateCompanyApiCredentialResponse: + additionalProperties: false properties: _links: description: References to resources linked to the API credential. @@ -10756,6 +10789,7 @@ components: - associatedMerchantAccounts type: object CreateCompanyUserRequest: + additionalProperties: false properties: accountGroups: description: The list of [account groups](https://docs.adyen.com/account/account-structure#account-groups) @@ -10799,6 +10833,7 @@ components: - username type: object CreateCompanyUserResponse: + additionalProperties: false properties: _links: description: References to resources connected with this user. @@ -10855,6 +10890,7 @@ components: - roles type: object CreateCompanyWebhookRequest: + additionalProperties: false properties: acceptsExpiredCertificate: description: 'Indicates if expired SSL certificates are accepted. Default @@ -11015,6 +11051,7 @@ components: - filterMerchantAccounts type: object CreateMerchantApiCredentialRequest: + additionalProperties: false properties: allowedOrigins: description: The list of [allowed origins](https://docs.adyen.com/development-resources/client-side-authentication#allowed-origins) @@ -11034,6 +11071,7 @@ components: type: array type: object CreateMerchantRequest: + additionalProperties: false properties: businessLineId: description: The unique identifier of the [business line](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/businessLines). @@ -11073,6 +11111,7 @@ components: - companyId type: object CreateMerchantResponse: + additionalProperties: false properties: businessLineId: description: The unique identifier of the [business line](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/businessLines). @@ -11102,6 +11141,7 @@ components: type: string type: object CreateMerchantUserRequest: + additionalProperties: false properties: accountGroups: description: The list of [account groups](https://docs.adyen.com/account/account-structure#account-groups) @@ -11139,6 +11179,7 @@ components: - username type: object CreateMerchantWebhookRequest: + additionalProperties: false properties: acceptsExpiredCertificate: description: 'Indicates if expired SSL certificates are accepted. Default @@ -11267,6 +11308,7 @@ components: - type type: object CreateUserResponse: + additionalProperties: false properties: _links: description: References to resources connected with this user. @@ -11317,6 +11359,7 @@ components: - roles type: object Currency: + additionalProperties: false properties: amount: description: Surcharge amount per transaction, in [minor units](https://docs.adyen.com/development-resources/currency-codes). @@ -11335,6 +11378,7 @@ components: - currencyCode type: object CustomNotification: + additionalProperties: false properties: amount: description: The amount of the payment that the notification is about. Set @@ -11395,6 +11439,7 @@ components: type: boolean type: object DataCenter: + additionalProperties: false properties: livePrefix: description: 'The unique [live URL prefix](https://docs.adyen.com/development-resources/live-endpoints#live-url-prefix) @@ -11411,6 +11456,7 @@ components: type: string type: object EventUrl: + additionalProperties: false properties: eventLocalUrls: description: One or more local URLs to send event notifications to when @@ -11426,6 +11472,7 @@ components: type: array type: object ExternalTerminalAction: + additionalProperties: false properties: actionType: description: 'The type of terminal action: **InstallAndroidApp**, **UninstallAndroidApp**, @@ -11457,6 +11504,7 @@ components: type: string type: object File: + additionalProperties: false properties: data: description: The certificate content converted to a Base64-encoded string. @@ -11469,6 +11517,7 @@ components: - data type: object GenerateApiKeyResponse: + additionalProperties: false properties: apiKey: description: The generated API key. @@ -11477,6 +11526,7 @@ components: - apiKey type: object GenerateClientKeyResponse: + additionalProperties: false properties: clientKey: description: Generated client key @@ -11485,6 +11535,7 @@ components: - clientKey type: object GenerateHmacKeyResponse: + additionalProperties: false properties: hmacKey: description: The HMAC key generated for this webhook. @@ -11493,12 +11544,14 @@ components: - hmacKey type: object GenericPmWithTdiInfo: + additionalProperties: false properties: transactionDescription: description: Information regarding the transaction description. $ref: '#/components/schemas/TransactionDescriptionInfo' type: object GiroPayInfo: + additionalProperties: false properties: supportEmail: description: The email address of merchant support. @@ -11507,6 +11560,7 @@ components: - supportEmail type: object GooglePayInfo: + additionalProperties: false properties: merchantId: description: 'Google Pay [Merchant ID](https://support.google.com/paymentscenter/answer/7163092?hl=en). @@ -11523,6 +11577,7 @@ components: - merchantId type: object Gratuity: + additionalProperties: false properties: allowCustomAmount: description: Indicates whether one of the predefined tipping options is @@ -11553,6 +11608,7 @@ components: type: boolean type: object Hardware: + additionalProperties: false properties: displayMaximumBackLight: description: The brightness of the display when the terminal is being used, @@ -11574,6 +11630,7 @@ components: type: integer type: object IdName: + additionalProperties: false properties: id: description: The identifier of the terminal model. @@ -11609,6 +11666,7 @@ components: type: string type: object InvalidField: + additionalProperties: false properties: message: description: Description of the validation error. @@ -11627,6 +11685,7 @@ components: JSONObject: type: object Key: + additionalProperties: false properties: identifier: description: The unique identifier of the shared key. @@ -11640,6 +11699,7 @@ components: type: integer type: object KlarnaInfo: + additionalProperties: false properties: autoCapture: description: 'Indicates the status of [Automatic capture](https://docs.adyen.com/online-payments/capture#automatic-capture). @@ -11668,6 +11728,7 @@ components: - disputeEmail type: object Links: + additionalProperties: false properties: self: description: Link to the resource itself. @@ -11676,11 +11737,13 @@ components: - self type: object LinksElement: + additionalProperties: false properties: href: type: string type: object ListCompanyApiCredentialsResponse: + additionalProperties: false properties: _links: description: Pagination references. @@ -11703,6 +11766,7 @@ components: - pagesTotal type: object ListCompanyResponse: + additionalProperties: false properties: _links: description: Pagination references. @@ -11725,6 +11789,7 @@ components: - pagesTotal type: object ListCompanyUsersResponse: + additionalProperties: false properties: _links: description: Pagination references. @@ -11747,6 +11812,7 @@ components: - pagesTotal type: object ListExternalTerminalActionsResponse: + additionalProperties: false properties: data: description: The list of terminal actions. @@ -11755,6 +11821,7 @@ components: type: array type: object ListMerchantApiCredentialsResponse: + additionalProperties: false properties: _links: description: Pagination references. @@ -11777,6 +11844,7 @@ components: - pagesTotal type: object ListMerchantResponse: + additionalProperties: false properties: _links: description: Pagination references. @@ -11799,6 +11867,7 @@ components: - pagesTotal type: object ListMerchantUsersResponse: + additionalProperties: false properties: _links: description: Pagination references. @@ -11821,6 +11890,7 @@ components: - pagesTotal type: object ListStoresResponse: + additionalProperties: false properties: _links: description: Pagination references. @@ -11843,6 +11913,7 @@ components: - pagesTotal type: object ListTerminalsResponse: + additionalProperties: false properties: _links: description: Pagination references. @@ -11865,6 +11936,7 @@ components: - pagesTotal type: object ListWebhooksResponse: + additionalProperties: false properties: _links: description: Pagination references. @@ -11890,6 +11962,7 @@ components: - pagesTotal type: object Localization: + additionalProperties: false properties: language: description: Language of the terminal. @@ -11902,6 +11975,7 @@ components: type: string type: object Logo: + additionalProperties: false properties: data: description: The image file, converted to a Base64-encoded string, of the @@ -11910,6 +11984,7 @@ components: type: string type: object MeApiCredential: + additionalProperties: false properties: _links: description: References to resources linked to the API credential. @@ -11976,6 +12051,7 @@ components: - active type: object MealVoucherFRInfo: + additionalProperties: false properties: conecsId: description: 'Meal Voucher conecsId. Format: digits only' @@ -11997,6 +12073,7 @@ components: - subTypes type: object Merchant: + additionalProperties: false properties: _links: description: References to resources connected with this merchant. @@ -12088,6 +12165,7 @@ components: type: string type: object MerchantLinks: + additionalProperties: false properties: apiCredentials: $ref: '#/components/schemas/LinksElement' @@ -12102,6 +12180,7 @@ components: - self type: object MinorUnitsMonetaryValue: + additionalProperties: false properties: amount: description: The transaction amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes). @@ -12112,6 +12191,7 @@ components: type: string type: object Name: + additionalProperties: false properties: firstName: description: The first name. @@ -12126,6 +12206,7 @@ components: - lastName type: object Name2: + additionalProperties: false properties: firstName: description: The first name. @@ -12137,6 +12218,7 @@ components: type: string type: object Nexo: + additionalProperties: false properties: displayUrls: description: The list of local and public URLs to send display notifications @@ -12165,6 +12247,7 @@ components: $ref: '#/components/schemas/Notification' type: object Notification: + additionalProperties: false properties: category: description: The type of event notification sent when you select the notification @@ -12193,6 +12276,7 @@ components: type: string type: object NotificationUrl: + additionalProperties: false properties: localUrls: description: One or more local URLs to send notifications to when using @@ -12208,6 +12292,7 @@ components: type: array type: object OfflineProcessing: + additionalProperties: false properties: chipFloorLimit: description: The maximum offline transaction amount for chip cards, in the @@ -12222,6 +12307,7 @@ components: type: array type: object Opi: + additionalProperties: false properties: enablePayAtTable: description: Indicates if Pay at table is enabled. @@ -12234,6 +12320,7 @@ components: type: string type: object OrderItem: + additionalProperties: false properties: id: description: The unique identifier of the product. @@ -12252,6 +12339,7 @@ components: type: integer type: object PaginationLinks: + additionalProperties: false properties: first: description: The first page. @@ -12274,6 +12362,7 @@ components: - last type: object Passcodes: + additionalProperties: false properties: adminMenuPin: description: The passcode for the Admin menu and the Settings menu. @@ -12295,6 +12384,7 @@ components: type: string type: object PayAtTable: + additionalProperties: false properties: authenticationMethod: description: 'Allowed authentication methods: Magswipe, Manual Entry.' @@ -12315,6 +12405,7 @@ components: type: string type: object PayPalInfo: + additionalProperties: false properties: directCapture: description: 'Indicates if direct (immediate) capture for PayPal is enabled. @@ -12335,6 +12426,7 @@ components: - payerId type: object Payment: + additionalProperties: false properties: contactlessCurrency: description: The default currency for contactless payments on the payment @@ -12350,6 +12442,7 @@ components: type: array type: object PaymentMethod: + additionalProperties: false properties: afterpayTouch: description: Afterpay Touch details. @@ -12497,6 +12590,7 @@ components: - id type: object PaymentMethodResponse: + additionalProperties: false properties: _links: description: Pagination references. @@ -12574,6 +12668,7 @@ components: - pagesTotal type: object PaymentMethodSetupInfo: + additionalProperties: false properties: afterpayTouch: description: Afterpay Touch details. @@ -12754,6 +12849,7 @@ components: - type type: object PayoutSettings: + additionalProperties: false properties: allowed: description: 'Indicates if payouts to the bank account are allowed. This @@ -12837,6 +12933,7 @@ components: - id type: object PayoutSettingsRequest: + additionalProperties: false properties: enabled: description: 'Indicates if payouts to this bank account are enabled. Default: @@ -12875,6 +12972,7 @@ components: - transferInstrumentId type: object PayoutSettingsResponse: + additionalProperties: false properties: data: description: The list of payout accounts. @@ -12883,6 +12981,7 @@ components: type: array type: object Profile: + additionalProperties: false properties: authType: description: 'The type of Wi-Fi network. Possible values: **wpa-psk**, **wpa2-psk**, @@ -12965,6 +13064,7 @@ components: - wsec type: object ReceiptOptions: + additionalProperties: false properties: logo: description: The receipt logo converted to a Base64-encoded string. The @@ -12983,6 +13083,7 @@ components: type: string type: object ReceiptPrinting: + additionalProperties: false properties: merchantApproved: description: Print a merchant receipt when the payment is approved. @@ -13034,6 +13135,7 @@ components: type: boolean type: object Referenced: + additionalProperties: false properties: enableStandaloneRefunds: description: Indicates whether referenced refunds are enabled on the standalone @@ -13041,6 +13143,7 @@ components: type: boolean type: object Refunds: + additionalProperties: false properties: referenced: description: Settings for referenced refunds. @@ -13062,6 +13165,7 @@ components: type: boolean type: object RequestActivationResponse: + additionalProperties: false properties: companyId: description: The unique identifier of the company account. @@ -13072,6 +13176,7 @@ components: type: string type: object RestServiceError: + additionalProperties: false properties: detail: description: A human-readable explanation specific to this occurrence of @@ -13115,6 +13220,7 @@ components: - status type: object ScheduleTerminalActionsRequest: + additionalProperties: false properties: actionDetails: description: Information about the action to take. @@ -13147,6 +13253,7 @@ components: type: array type: object ScheduleTerminalActionsResponse: + additionalProperties: false properties: actionDetails: description: Information about the action to take. @@ -13196,6 +13303,7 @@ components: type: integer type: object Settings: + additionalProperties: false properties: band: description: 'The preferred Wi-Fi band, for use if the terminals support @@ -13210,6 +13318,7 @@ components: type: integer type: object ShippingLocation: + additionalProperties: false properties: address: description: The address details of the shipping location. @@ -13226,6 +13335,7 @@ components: type: string type: object ShippingLocationsResponse: + additionalProperties: false properties: data: description: Physical locations where orders can be shipped to. @@ -13234,6 +13344,7 @@ components: type: array type: object Signature: + additionalProperties: false properties: askSignatureOnScreen: description: If `skipSignature` is false, indicates whether the shopper @@ -13254,6 +13365,7 @@ components: type: boolean type: object SofortInfo: + additionalProperties: false properties: currencyCode: description: Sofort currency code. For example, **EUR**. @@ -13266,6 +13378,7 @@ components: - currencyCode type: object SplitConfiguration: + additionalProperties: false properties: description: description: Your description for the split configuration. @@ -13291,6 +13404,7 @@ components: - rules type: object SplitConfigurationList: + additionalProperties: false properties: data: description: List of split configurations applied to the stores under the @@ -13300,6 +13414,7 @@ components: type: array type: object SplitConfigurationLogic: + additionalProperties: false properties: acquiringFees: description: 'Deducts the acquiring fees (the aggregated amount of interchange @@ -13394,10 +13509,10 @@ components: - [`adyenCommission`](https://docs.adyen.com/api-explorer/Management/latest/post/merchants/(merchantId)/splitConfigurations#request-rules-splitLogic-adyenCommission): - The transaction fee due to Adyen under [blended rates](https://www.adyen.com/knowledge-hub/guides/payments-training-guide/get-the-best-from-your-card-processing). + The transaction fee due to Adyen under [blended rates](https://www.adyen.com/knowledge-hub/interchange-fees-explained#interchange-vs-blended). - [`adyenMarkup`](https://docs.adyen.com/api-explorer/Management/latest/post/merchants/(merchantId)/splitConfigurations#request-rules-splitLogic-adyenMarkup): - The transaction fee due to Adyen under [Interchange ++ pricing](https://www.adyen.com/what-is-interchange). + The transaction fee due to Adyen under [Interchange ++ pricing](https://www.adyen.com/knowledge-hub/interchange-fees-explained#interchange-vs-blended). - [`schemeFee`](https://docs.adyen.com/api-explorer/Management/latest/post/merchants/(merchantId)/splitConfigurations#request-rules-splitLogic-schemeFee): The fee paid to the card scheme for using their network. @@ -13435,6 +13550,15 @@ components: - deductFromOneBalanceAccount - deductAccordingToSplitRatio type: string + refundCostAllocation: + description: 'Deducts the refund costs from the specified balance account. + + + Possible values: **deductFromLiableAccount**, **deductFromOneBalanceAccount**' + enum: + - deductFromLiableAccount + - deductFromOneBalanceAccount + type: string remainder: description: 'Books the amount left over after currency conversion to the specified balance account. @@ -13481,6 +13605,7 @@ components: - commission type: object SplitConfigurationRule: + additionalProperties: false properties: currency: description: 'The currency condition that defines whether the split logic @@ -13552,6 +13677,7 @@ components: - splitLogic type: object Standalone: + additionalProperties: false properties: currencyCode: description: The default currency of the standalone payment terminal as @@ -13564,6 +13690,7 @@ components: type: boolean type: object Store: + additionalProperties: false properties: _links: description: Reference to resources connected with the store. @@ -13637,7 +13764,27 @@ components: - inactive type: string type: object + StoreAndForward: + additionalProperties: false + properties: + maxAmount: + description: The maximum amount that the terminal accepts for a single store-and-forward + payment. + items: + $ref: '#/components/schemas/MinorUnitsMonetaryValue' + type: array + maxPayments: + description: The maximum number of store-and-forward transactions per terminal + that you can process while offline. + format: int32 + type: integer + supportedCardTypes: + description: 'The type of card for which the terminal accepts store-and-forward + payments. You can specify multiple card types. ' + $ref: '#/components/schemas/SupportedCardTypes' + type: object StoreCreationRequest: + additionalProperties: false properties: address: description: The address of the store. @@ -13699,6 +13846,7 @@ components: - address type: object StoreCreationWithMerchantCodeRequest: + additionalProperties: false properties: address: description: The address of the store. @@ -13765,6 +13913,7 @@ components: - merchantId type: object StoreLocation: + additionalProperties: false properties: city: description: The name of the city. @@ -13795,6 +13944,7 @@ components: - country type: object StoreSplitConfiguration: + additionalProperties: false properties: balanceAccountId: description: The [unique identifier of the balance account](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/get/balanceAccounts/{id}__queryParam_id) @@ -13805,7 +13955,28 @@ components: description: The unique identifier of the [split configuration profile](https://docs.adyen.com/marketplaces-and-platforms/automatic-split-configuration/create-split-configuration/). type: string type: object + SupportedCardTypes: + additionalProperties: false + properties: + credit: + description: Set to **true** to accept credit cards. + type: boolean + debit: + description: Set to **true** to accept debit cards. + type: boolean + deferredDebit: + description: Set to **true** to accept cards that allow deferred debit. + type: boolean + prepaid: + description: Set to **true** to accept prepaid cards. + type: boolean + unknown: + description: Set to **true** to accept card types for which the terminal + can't determine the funding source while offline. + type: boolean + type: object Surcharge: + additionalProperties: false properties: askConfirmation: description: Show the surcharge details on the terminal, so the shopper @@ -13819,6 +13990,7 @@ components: type: array type: object SwishInfo: + additionalProperties: false properties: swishNumber: description: 'Swish number. Format: 10 digits without spaces. For example, @@ -13830,12 +14002,14 @@ components: - swishNumber type: object TapToPay: + additionalProperties: false properties: merchantDisplayName: description: The text shown on the screen during the Tap to Pay transaction. type: string type: object Terminal: + additionalProperties: false properties: assignment: x-addedInVersion: '2' @@ -13875,6 +14049,7 @@ components: type: string type: object TerminalActionScheduleDetail: + additionalProperties: false properties: id: description: The ID of the action on the specified terminal. @@ -13884,6 +14059,7 @@ components: type: string type: object TerminalAssignment: + additionalProperties: false properties: companyId: description: The unique identifier of the company account to which terminal @@ -13919,6 +14095,7 @@ components: - status type: object TerminalConnectivity: + additionalProperties: false properties: bluetooth: $ref: '#/components/schemas/TerminalConnectivityBluetooth' @@ -13930,6 +14107,7 @@ components: $ref: '#/components/schemas/TerminalConnectivityWifi' type: object TerminalConnectivityBluetooth: + additionalProperties: false properties: ipAddress: description: The terminal's Bluetooth IP address. @@ -13939,6 +14117,7 @@ components: type: string type: object TerminalConnectivityCellular: + additionalProperties: false properties: iccid: description: The integrated circuit card identifier (ICCID) of the SIM card @@ -13956,6 +14135,7 @@ components: type: string type: object TerminalConnectivityEthernet: + additionalProperties: false properties: ipAddress: description: The terminal's ethernet IP address. @@ -13968,6 +14148,7 @@ components: type: string type: object TerminalConnectivityWifi: + additionalProperties: false properties: ipAddress: description: The terminal's IP address in the Wi-Fi network. @@ -13981,6 +14162,7 @@ components: type: string type: object TerminalInstructions: + additionalProperties: false properties: adyenAppRestart: description: Indicates whether the Adyen app on the payment terminal restarts @@ -13988,6 +14170,7 @@ components: type: boolean type: object TerminalModelsResponse: + additionalProperties: false properties: data: description: The terminal models that the API credential has access to. @@ -13996,6 +14179,7 @@ components: type: array type: object TerminalOrder: + additionalProperties: false properties: billingEntity: description: The details of the entity that the order is billed to. @@ -14028,6 +14212,7 @@ components: type: string type: object TerminalOrderRequest: + additionalProperties: false properties: billingEntityId: description: The identification of the billing entity to use for the order. @@ -14052,6 +14237,7 @@ components: type: string type: object TerminalOrdersResponse: + additionalProperties: false properties: data: description: List of orders for payment terminal packages and parts. @@ -14060,6 +14246,7 @@ components: type: array type: object TerminalProduct: + additionalProperties: false properties: description: description: Information about items included and integration options. @@ -14080,6 +14267,7 @@ components: $ref: '#/components/schemas/TerminalProductPrice' type: object TerminalProductPrice: + additionalProperties: false properties: currency: description: The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes). @@ -14090,6 +14278,7 @@ components: type: number type: object TerminalProductsResponse: + additionalProperties: false properties: data: description: Terminal products that can be ordered. @@ -14098,6 +14287,7 @@ components: type: array type: object TerminalReassignmentRequest: + additionalProperties: false properties: companyId: description: The unique identifier of the company account to which the terminal @@ -14126,6 +14316,7 @@ components: type: string type: object TerminalReassignmentTarget: + additionalProperties: false properties: companyId: description: The unique identifier of the company account to which the terminal @@ -14153,6 +14344,7 @@ components: - inventory type: object TerminalSettings: + additionalProperties: false properties: cardholderReceipt: description: Settings to define the header of the shopper receipt. @@ -14211,6 +14403,11 @@ components: description: Settings for [standalone](https://docs.adyen.com/point-of-sale/standalone/standalone-build/set-up-standalone#set-up-standalone-using-an-api-call) features. $ref: '#/components/schemas/Standalone' + storeAndForward: + description: Settings for store-and-forward offline payments. The maxAmount, + maxPayments, and supportedCardTypes parameters must be configured, either + in the request or inherited from a higher level in your account structure. + $ref: '#/components/schemas/StoreAndForward' surcharge: description: Settings for payment [surcharge](https://docs.adyen.com/point-of-sale/surcharge) features. @@ -14229,6 +14426,7 @@ components: $ref: '#/components/schemas/WifiProfiles' type: object TestCompanyWebhookRequest: + additionalProperties: false properties: merchantIds: description: 'List of `merchantId` values for which test webhooks will be @@ -14263,6 +14461,7 @@ components: type: array type: object TestOutput: + additionalProperties: false properties: merchantId: description: Unique identifier of the merchant account that the notification @@ -14316,6 +14515,7 @@ components: - status type: object TestWebhookRequest: + additionalProperties: false properties: notification: description: Custom test notification object. Required when the [`types`](https://docs.adyen.com/api-explorer/#/ManagementService/v1/post/companies/{companyId}/webhooks/{webhookId}/test__reqParam_types) @@ -14338,6 +14538,7 @@ components: type: array type: object TestWebhookResponse: + additionalProperties: false properties: data: description: List with test results. Each test webhook we send has a list @@ -14347,6 +14548,7 @@ components: type: array type: object Timeouts: + additionalProperties: false properties: fromActiveToSleep: description: Indicates the number of seconds of inactivity after which the @@ -14355,6 +14557,7 @@ components: type: integer type: object TransactionDescriptionInfo: + additionalProperties: false properties: doingBusinessAsName: description: "The text to be shown on the shopper's bank statement.\n We\ @@ -14386,6 +14589,7 @@ components: type: string type: object TwintInfo: + additionalProperties: false properties: logo: description: 'Twint logo. Format: Base64-encoded string.' @@ -14420,6 +14624,7 @@ components: type: string type: object UpdatableAddress: + additionalProperties: false properties: city: description: The name of the city. @@ -14444,6 +14649,7 @@ components: type: string type: object UpdateCompanyApiCredentialRequest: + additionalProperties: false properties: active: description: Indicates if the API credential is enabled. @@ -14472,6 +14678,7 @@ components: type: array type: object UpdateCompanyUserRequest: + additionalProperties: false properties: accountGroups: description: The list of [account groups](https://docs.adyen.com/account/account-structure#account-groups) @@ -14508,6 +14715,7 @@ components: type: string type: object UpdateCompanyWebhookRequest: + additionalProperties: false properties: acceptsExpiredCertificate: description: 'Indicates if expired SSL certificates are accepted. Default @@ -14634,6 +14842,7 @@ components: type: string type: object UpdateMerchantApiCredentialRequest: + additionalProperties: false properties: active: description: Indicates if the API credential is enabled. @@ -14656,6 +14865,7 @@ components: type: array type: object UpdateMerchantUserRequest: + additionalProperties: false properties: accountGroups: description: The list of [account groups](https://docs.adyen.com/account/account-structure#account-groups) @@ -14687,6 +14897,7 @@ components: type: string type: object UpdateMerchantWebhookRequest: + additionalProperties: false properties: acceptsExpiredCertificate: description: 'Indicates if expired SSL certificates are accepted. Default @@ -14779,6 +14990,7 @@ components: type: string type: object UpdatePaymentMethodInfo: + additionalProperties: false properties: bcmc: description: Bancontact details. @@ -14847,6 +15059,7 @@ components: $ref: '#/components/schemas/GenericPmWithTdiInfo' type: object UpdatePayoutSettingsRequest: + additionalProperties: false properties: enabled: description: 'Indicates if payouts to this bank account are enabled. Default: @@ -14858,6 +15071,7 @@ components: type: boolean type: object UpdateSplitConfigurationLogicRequest: + additionalProperties: false properties: acquiringFees: description: 'Deducts the acquiring fees (the aggregated amount of interchange @@ -14952,10 +15166,10 @@ components: - [`adyenCommission`](https://docs.adyen.com/api-explorer/Management/latest/post/merchants/(merchantId)/splitConfigurations#request-rules-splitLogic-adyenCommission): - The transaction fee due to Adyen under [blended rates](https://www.adyen.com/knowledge-hub/guides/payments-training-guide/get-the-best-from-your-card-processing). + The transaction fee due to Adyen under [blended rates](https://www.adyen.com/knowledge-hub/interchange-fees-explained#interchange-vs-blended). - [`adyenMarkup`](https://docs.adyen.com/api-explorer/Management/latest/post/merchants/(merchantId)/splitConfigurations#request-rules-splitLogic-adyenMarkup): - The transaction fee due to Adyen under [Interchange ++ pricing](https://www.adyen.com/what-is-interchange). + The transaction fee due to Adyen under [Interchange ++ pricing](https://www.adyen.com/knowledge-hub/interchange-fees-explained#interchange-vs-blended). - [`schemeFee`](https://docs.adyen.com/api-explorer/Management/latest/post/merchants/(merchantId)/splitConfigurations#request-rules-splitLogic-schemeFee): The fee paid to the card scheme for using their network. @@ -14993,6 +15207,15 @@ components: - deductFromOneBalanceAccount - deductAccordingToSplitRatio type: string + refundCostAllocation: + description: 'Deducts the refund costs from the specified balance account. + + + Possible values: **deductFromLiableAccount**, **deductFromOneBalanceAccount**' + enum: + - deductFromLiableAccount + - deductFromOneBalanceAccount + type: string remainder: description: 'Books the amount left over after currency conversion to the specified balance account. @@ -15039,6 +15262,7 @@ components: - commission type: object UpdateSplitConfigurationRequest: + additionalProperties: false properties: description: description: Your description for the split configuration. @@ -15048,6 +15272,7 @@ components: - description type: object UpdateSplitConfigurationRuleRequest: + additionalProperties: false properties: currency: description: 'The currency condition that defines whether the split logic @@ -15100,6 +15325,7 @@ components: - currency type: object UpdateStoreRequest: + additionalProperties: false properties: address: description: The address of the store. It is not possible to update the @@ -15155,12 +15381,14 @@ components: type: string type: object UploadAndroidAppResponse: + additionalProperties: false properties: id: description: The unique identifier of the uploaded Android app. type: string type: object Url: + additionalProperties: false properties: encrypted: description: Indicates if the message sent to this URL should be encrypted. @@ -15176,6 +15404,7 @@ components: type: string type: object User: + additionalProperties: false properties: _links: description: References to resources connected with this user. @@ -15226,6 +15455,7 @@ components: - roles type: object VippsInfo: + additionalProperties: false properties: logo: description: 'Vipps logo. Format: Base64-encoded string.' @@ -15238,6 +15468,7 @@ components: - logo type: object Webhook: + additionalProperties: false properties: _links: description: References to resources connected with this webhook. @@ -15411,6 +15642,7 @@ components: - communicationFormat type: object WebhookLinks: + additionalProperties: false properties: company: description: The company account that the webhook is configured for. Only @@ -15435,6 +15667,7 @@ components: - generateHmac type: object WifiProfiles: + additionalProperties: false properties: profiles: description: List of remote Wi-Fi profiles.