jlengrand/adyen-openapi
1
0
Fork 0
mirror of https://github.com/gcatanese/adyen-openapi.git synced 2026-03-10 08:01:24 +00:00
Code Issues Packages Projects Releases Wiki Activity

spec release

Browse Source
This commit is contained in:
Adyen Automation
2023-10-17 14:03:05 +02:00
parent dfe5f49182
commit f2c9ecd4f1
8 changed files with 50748 additions and 202 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
json/ManagementNotificationService-v1.json
View File

@@ -16,7 +16,13 @@
"Payment method"
],
"tags" : [
],
{
"name" : "Merchant account"
},
{
"name" : "Payment method"
}
],
"x-staticResponse" : "response.json",
"webhooks" : {
"merchant.created" : {
@@ -76,7 +82,7 @@
"Merchant account"
],
"summary" : "Merchant account capability updated",
"description" : "There were changes to verification status and capabilities of a [merchant account](https://docs.adyen.com/api-explorer/#/ManagementService/latest/post/merchants). If the verification fails, this webhook includes the errors and the actions that you can take to resolve them.",
"description" : "There were changes to the verification status and capabilities of a [merchant account](https://docs.adyen.com/api-explorer/#/ManagementService/latest/post/merchants). If the verification fails, this webhook includes the errors and the actions that you can take to resolve them.",
"x-addedInVersion" : "1",
"operationId" : "post-merchant.updated",
"x-groupName" : "Merchant account",
@@ -438,11 +444,11 @@
"type" : "boolean"
},
"id" : {
"description" : "The identifier of the resource.",
"description" : "The unique identifier of the resource.",
"type" : "string"
},
"merchantId" : {
"description" : "The identifier of the merchant account.",
"description" : "The unique identifier of the merchant account.",
"type" : "string"
},
"reference" : {
@@ -458,7 +464,7 @@
"type" : "string"
},
"storeId" : {
"description" : "The identifier of the [store](https://docs.adyen.com/api-explorer/#/ManagementService/latest/post/merchants/{id}/paymentMethodSettings__reqParam_storeId), if any.",
"description" : "The unique identifier of the [store](https://docs.adyen.com/api-explorer/#/ManagementService/latest/post/merchants/{id}/paymentMethodSettings__reqParam_storeId), if any.",
"type" : "string"
},
"type" : {

372
json/ManagementNotificationService-v3.json Normal file
View File

@@ -0,0 +1,372 @@
{
"openapi" : "3.1.0",
"info" : {
"version" : "3",
"x-publicVersion" : true,
"title" : "Management Webhooks",
"description" : "Adyen uses webhooks to inform your system about events that happen with your Adyen company and merchant accounts, stores, payment terminals, and payment methods when using [Management API](https://docs.adyen.com/api-explorer/#/ManagementService/latest/overview).\n\nWhen an event occurs, Adyen makes an HTTP POST request to a URL on your server and includes the details of the event in the request body.\n\nSee [Webhooks](https://docs.adyen.com/development-resources/webhooks) for more information.",
"termsOfService" : "https://www.adyen.com/legal/terms-and-conditions",
"contact" : {
"name" : "Adyen Developer Experience team",
"url" : "https://github.com/Adyen/adyen-openapi"
}
},
"x-groups" : [
"Payment method"
],
"tags" : [
{
"name" : "Payment method"
}
],
"x-staticResponse" : "response.json",
"webhooks" : {
"paymentMethod.created" : {
"post" : {
"tags" : [
"Payment method"
],
"summary" : "Payment method created",
"description" : "A request to [add a payment method](https://docs.adyen.com/api-explorer/Management/latest/post/merchants/_merchantId_/paymentMethodSettings) was completed.",
"x-addedInVersion" : "1",
"operationId" : "post-paymentMethod.created",
"x-groupName" : "Payment method",
"x-sortIndex" : 1,
"x-methodName" : "paymentMethodCreated",
"security" : [
{
"BasicAuth" : [
]
}
],
"requestBody" : {
"content" : {
"application/json" : {
"examples" : {
"paymentMethod.created" : {
"$ref" : "#/components/examples/post-paymentMethod.created-paymentMethod.created"
}
},
"schema" : {
"$ref" : "#/components/schemas/PaymentMethodCreatedNotificationRequest"
}
}
}
},
"responses" : {
"200" : {
"content" : {
"application/json" : {
"examples" : {
"paymentMethod.created" : {
"$ref" : "#/components/examples/WebhookAck"
}
},
"schema" : {
"$ref" : "#/components/schemas/PaymentMethodNotificationResponse"
}
}
},
"description" : "OK - the request has succeeded."
}
}
}
},
"paymentMethod.requestRemoved" : {
"post" : {
"tags" : [
"Payment method"
],
"summary" : "Payment method request removed",
"description" : "A request to add a payment method is removed. You must make another request to [add a payment method](https://docs.adyen.com/api-explorer/Management/latest/post/merchants/_merchantId_/paymentMethodSettings).",
"x-addedInVersion" : "2",
"operationId" : "post-paymentMethod.requestRemoved",
"x-groupName" : "Payment method",
"x-sortIndex" : 3,
"x-methodName" : "paymentMethodRequestRemoved",
"security" : [
{
"BasicAuth" : [
]
}
],
"requestBody" : {
"content" : {
"application/json" : {
"examples" : {
"paymentMethod.requestRemoved" : {
"$ref" : "#/components/examples/post-paymentMethod.requestRemoved-paymentMethod.requestRemoved"
}
},
"schema" : {
"$ref" : "#/components/schemas/NotificationDataMessage"
}
}
}
},
"responses" : {
"200" : {
"content" : {
"application/json" : {
"examples" : {
"paymentMethod.requestRemoved" : {
"$ref" : "#/components/examples/WebhookAck"
}
},
"schema" : {
"$ref" : "#/components/schemas/PaymentMethodNotificationResponse"
}
}
},
"description" : "OK - the request has succeeded."
}
}
}
},
"paymentMethod.requestScheduledForRemoval" : {
"post" : {
"tags" : [
"Payment method"
],
"summary" : "Payment method request scheduled for removal",
"description" : "A request to [add a payment method](https://docs.adyen.com/api-explorer/Management/latest/post/merchants/_merchantId_/paymentMethodSettings) will be removed in 30 days. To make sure the payment method is added, provide the missing [KYC information](https://docs.adyen.com/marketplaces-and-platforms/collect-verification-details).",
"x-addedInVersion" : "2",
"operationId" : "post-paymentMethod.requestScheduledForRemoval",
"x-groupName" : "Payment method",
"x-sortIndex" : 2,
"x-methodName" : "paymentMethodRequestScheduledForRemoval",
"security" : [
{
"BasicAuth" : [
]
}
],
"requestBody" : {
"content" : {
"application/json" : {
"examples" : {
"paymentMethod.requestScheduledForRemoval" : {
"$ref" : "#/components/examples/post-paymentMethod.requestScheduledForRemoval-paymentMethod.requestScheduledForRemoval"
}
},
"schema" : {
"$ref" : "#/components/schemas/NotificationDataMessage"
}
}
}
},
"responses" : {
"200" : {
"content" : {
"application/json" : {
"examples" : {
"paymentMethod.requestScheduledForRemoval" : {
"$ref" : "#/components/examples/WebhookAck"
}
},
"schema" : {
"$ref" : "#/components/schemas/PaymentMethodNotificationResponse"
}
}
},
"description" : "OK - the request has succeeded."
}
}
}
}
},
"components" : {
"schemas" : {
"MidServiceNotificationData" : {
"properties" : {
"allowed" : {
"description" : "Indicates whether receiving payments is allowed. This value is set to **true** by Adyen after screening your merchant account.",
"type" : "boolean"
},
"enabled" : {
"description" : "Indicates whether the payment method is enabled (**true**) or disabled (**false**).",
"type" : "boolean"
},
"id" : {
"description" : "The unique identifier of the resource.",
"type" : "string"
},
"merchantId" : {
"description" : "The unique identifier of the merchant account.",
"type" : "string"
},
"reference" : {
"description" : "Your reference for the payment method.",
"type" : "string"
},
"status" : {
"x-addedInVersion" : "2",
"description" : "The status of the request to add a payment method. Possible values:\n\n* **success**: the payment method was added.\n* **failure**: the request failed.\n* **dataRequired**: the request is in a draft state because the required KYC data are missing. To check what data are missing, [get the details of the legal entity](https://docs.adyen.com/api-explorer/legalentity/latest/get/legalEntities/_id_).\n* **capabilityPending**: the **receivePayments** capability is not allowed.\n* **updatesExpected**: the **receivePayments** capability is not allowed and the required KYC data are missing. To check what data are missing, [get the details of the legal entity](https://docs.adyen.com/api-explorer/legalentity/latest/get/legalEntities/_id_).",
"enum" : [
"success",
"failure",
"capabilityPending",
"dataRequired",
"updatesExpected"
],
"type" : "string"
},
"storeId" : {
"description" : "The unique identifier of the [store](https://docs.adyen.com/api-explorer/#/ManagementService/latest/post/merchants/{id}/paymentMethodSettings__reqParam_storeId), if any.",
"type" : "string"
},
"type" : {
"description" : "Payment method [variant](https://docs.adyen.com/development-resources/paymentmethodvariant#management-api).",
"type" : "string"
},
"verificationStatus" : {
"description" : "Payment method status. Possible values:\n* **valid**\n* **pending**\n* **invalid**\n* **rejected**",
"enum" : [
"valid",
"pending",
"invalid",
"rejected"
],
"type" : "string"
}
},
"required" : [
"status",
"merchantId",
"id",
"type"
],
"type" : "object"
},
"NotificationDataMessage" : {
"properties" : {
"createdAt" : {
"description" : "Timestamp for when the webhook was created.",
"format" : "date-time",
"type" : "string"
},
"data" : {
"description" : "Contains event details.",
"$ref" : "#/components/schemas/MidServiceNotificationData"
},
"environment" : {
"description" : "The environment from which the webhook originated.\n\nPossible values: **test**, **live**.",
"type" : "string"
},
"type" : {
"description" : "Type of notification.",
"type" : "string"
}
},
"required" : [
"type",
"environment",
"createdAt",
"data"
],
"type" : "object"
},
"PaymentMethodCreatedNotificationRequest" : {
"properties" : {
"createdAt" : {
"description" : "Timestamp for when the webhook was created.",
"format" : "date-time",
"type" : "string"
},
"data" : {
"description" : "Contains event details.",
"$ref" : "#/components/schemas/MidServiceNotificationData"
},
"environment" : {
"description" : "The environment from which the webhook originated.\n\nPossible values: **test**, **live**.",
"type" : "string"
},
"type" : {
"description" : "Type of notification.",
"enum" : [
"paymentMethod.created"
],
"type" : "string"
}
},
"required" : [
"environment",
"createdAt",
"data",
"type"
],
"type" : "object"
},
"PaymentMethodNotificationResponse" : {
"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).",
"type" : "string"
}
},
"type" : "object"
}
},
"securitySchemes" : {
"BasicAuth" : {
"scheme" : "basic",
"type" : "http"
}
},
"examples" : {
"WebhookAck" : {
"summary" : "Acknowledge Webhook",
"value" : {
"notificationResponse" : "[accepted]"
}
},
"post-paymentMethod.created-paymentMethod.created" : {
"summary" : "Payment method Visa created",
"value" : {
"createdAt" : "2022-01-24T14:59:11+01:00",
"data" : {
"id" : "PM3224R223224K5FH4M2K9B86",
"merchantId" : "MERCHANT_ACCOUNT",
"status" : "success",
"storeId" : "ST322LJ223223K5F4SQNR9XL5",
"type" : "visa"
},
"environment" : "test",
"type" : "paymentMethod.created"
}
},
"post-paymentMethod.requestRemoved-paymentMethod.requestRemoved" : {
"summary" : "Payment method request is removed",
"value" : {
"type" : "paymentMethod.requestRemoved",
"environment" : "devl",
"createdAt" : "2023-06-12T18:59:17+02:00",
"data" : {
"id" : "PM322WP223224M5HJ6PX77BW8",
"storeId" : "TestStore",
"type" : "amex",
"status" : "dataRequired",
"merchantId" : "TestMerchant",
"enabled" : false
}
}
},
"post-paymentMethod.requestScheduledForRemoval-paymentMethod.requestScheduledForRemoval" : {
"summary" : "Payment method request scheduled for removal",
"value" : {
"type" : "paymentMethod.requestScheduledForRemoval",
"environment" : "devl",
"createdAt" : "2023-06-12T19:02:42+02:00",
"data" : {
"id" : "PM322WP223224M5HJ6PX77BW8",
"storeId" : "TestStore",
"type" : "visa",
"status" : "updatesExpected",
"merchantId" : "TestMerchant",
"enabled" : false
}
}
}
}
}
}

377
json/ManagementService-v1.json
View File

@@ -49,91 +49,91 @@
],
"tags" : [
{
"name" : "API key - merchant level"
"name" : "Account - company level"
},
{
"name" : "Account - merchant level"
},
{
"name" : "Split configuration - merchant level"
},
{
"name" : "Allowed origins - company level"
},
{
"name" : "API key - company level"
},
{
"name" : "Client key - company level"
},
{
"name" : "Users - company level"
},
{
"name" : "Terminal actions - terminal level"
},
{
"name" : "Terminal settings - terminal level"
"name" : "Account - store level"
},
{
"name" : "Payout settings - merchant level"
},
{
"name" : "Webhooks - merchant level"
},
{
"name" : "Client key - merchant level"
},
{
"name" : "Terminal orders - company level"
},
{
"name" : "Allowed origins - merchant level"
},
{
"name" : "API credentials - merchant level"
"name" : "Users - company level"
},
{
"name" : "Users - merchant level"
},
{
"name" : "Terminal actions - company level"
},
{
"name" : "Payment methods - merchant level"
},
{
"name" : "My API credential"
},
{
"name" : "Terminal settings - merchant level"
},
{
"name" : "Webhooks - company level"
},
{
"name" : "Terminals - terminal level"
},
{
"name" : "Android files - company level"
},
{
"name" : "Account - store level"
},
{
"name" : "Terminal settings - company level"
},
{
"name" : "API credentials - company level"
},
{
"name" : "API credentials - merchant level"
},
{
"name" : "API key - company level"
},
{
"name" : "API key - merchant level"
},
{
"name" : "Client key - company level"
},
{
"name" : "Client key - merchant level"
},
{
"name" : "Allowed origins - company level"
},
{
"name" : "Allowed origins - merchant level"
},
{
"name" : "Webhooks - company level"
},
{
"name" : "Webhooks - merchant level"
},
{
"name" : "Payment methods - merchant level"
},
{
"name" : "Terminals - terminal level"
},
{
"name" : "Terminal actions - company level"
},
{
"name" : "Terminal actions - terminal level"
},
{
"name" : "Terminal orders - company level"
},
{
"name" : "Terminal orders - merchant level"
},
{
"name" : "Account - company level"
"name" : "Terminal settings - company level"
},
{
"name" : "Terminal settings - merchant level"
},
{
"name" : "Terminal settings - store level"
},
{
"name" : "Terminal settings - terminal level"
},
{
"name" : "Android files - company level"
},
{
"name" : "Split configuration - merchant level"
}
],
"paths" : {
@@ -1475,7 +1475,7 @@
],
"responses" : {
"204" : {
"description" : "No Content - look at the actual response code for the status of the request "
"description" : "No Content - look at the actual response code for the status of the request. "
},
"400" : {
"content" : {
@@ -4604,7 +4604,7 @@
],
"responses" : {
"204" : {
"description" : "No Content - look at the actual response code for the status of the request "
"description" : "No Content - look at the actual response code for the status of the request. "
},
"400" : {
"content" : {
@@ -5419,7 +5419,7 @@
],
"responses" : {
"204" : {
"description" : "No Content - look at the actual response code for the status of the request "
"description" : "No Content - look at the actual response code for the status of the request. "
},
"400" : {
"content" : {
@@ -6759,7 +6759,7 @@
],
"responses" : {
"204" : {
"description" : "No Content - look at the actual response code for the status of the request "
"description" : "No Content - look at the actual response code for the status of the request. "
},
"400" : {
"content" : {
@@ -7802,7 +7802,7 @@
],
"responses" : {
"204" : {
"description" : "No Content - look at the actual response code for the status of the request "
"description" : "No Content - look at the actual response code for the status of the request. "
},
"400" : {
"content" : {
@@ -8213,7 +8213,7 @@
],
"responses" : {
"204" : {
"description" : "No Content - look at the actual response code for the status of the request "
"description" : "No Content - look at the actual response code for the status of the request. "
},
"400" : {
"content" : {
@@ -12895,7 +12895,7 @@
],
"responses" : {
"204" : {
"description" : "No Content - look at the actual response code for the status of the request "
"description" : "No Content - look at the actual response code for the status of the request. "
},
"400" : {
"content" : {
@@ -15426,6 +15426,9 @@
"type" : "array"
}
},
"required" : [
"domains"
],
"type" : "object"
},
"BcmcInfo" : {
@@ -16749,7 +16752,7 @@
"type" : "integer"
},
"restartHour" : {
"description" : "The hour (0 - 23) in which the device will reboot, reboot will happen in the timezone of the device",
"description" : "The hour of the day when the terminal is set to reboot to apply the configuration and software updates. By default, the restart hour is at 6:00 AM in the timezone of the terminal Minimum vaoue: 0, maximum value: 23.",
"format" : "int32",
"type" : "integer"
}
@@ -16912,6 +16915,7 @@
}
},
"required" : [
"region",
"supportEmail",
"disputeEmail"
],
@@ -17166,7 +17170,7 @@
"$ref" : "#/components/schemas/PaginationLinks"
},
"data" : {
"description" : "The list of terminals.",
"description" : "The list of terminals and their details.",
"items" : {
"$ref" : "#/components/schemas/Terminal"
},
@@ -17484,7 +17488,7 @@
"type" : "array"
},
"notification" : {
"description" : "Setting to manage the notification configuration.",
"description" : "Configures the event notification button on the terminal screen, for example used for pay-at-table.",
"$ref" : "#/components/schemas/Notification"
}
},
@@ -17493,7 +17497,7 @@
"Notification" : {
"properties" : {
"showButton" : {
"description" : "Toggle to show or hide Notification button on the terminal",
"description" : "Shows or hides the event notification button on the terminal screen.",
"type" : "boolean"
}
},
@@ -17673,6 +17677,12 @@
},
"Payment" : {
"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.",
"maxLength" : 3,
"minLength" : 3,
"type" : "string"
},
"hideMinorUnitsInCurrencies" : {
"description" : "Hides the minor units for the listed [ISO currency codes](https://en.wikipedia.org/wiki/ISO_4217).",
"items" : {
@@ -17862,7 +17872,7 @@
"$ref" : "#/components/schemas/PaginationLinks"
},
"data" : {
"description" : "Payment methods details.",
"description" : "The list of supported payment methods and their details.",
"items" : {
"$ref" : "#/components/schemas/PaymentMethodWrapper"
},
@@ -17893,7 +17903,6 @@
"clearpay",
"cup",
"diners",
"directEbanking",
"directdebit_GB",
"discover",
"ebanking_FI",
@@ -18096,7 +18105,6 @@
"clearpay",
"cup",
"diners",
"directEbanking",
"directdebit_GB",
"discover",
"ebanking_FI",
@@ -18147,6 +18155,9 @@
"$ref" : "#/components/schemas/GenericPmWithTdiInfo"
}
},
"required" : [
"type"
],
"type" : "object"
},
"PaymentMethodWrapper" : {
@@ -18735,10 +18746,42 @@
},
"SplitConfigurationLogic" : {
"properties" : {
"acquiringFees" : {
"description" : "Specifies the logic to apply when booking the transaction fees. Should be combined with adyenFees.\n\nPossible values: **deductFromLiableAccount**, **deductFromOneBalanceAccount**.",
"enum" : [
"deductFromLiableAccount",
"deductFromOneBalanceAccount"
],
"type" : "string"
},
"additionalCommission" : {
"description" : "Contains the logic used to calculate your user's commission, booked directly to their balance account.",
"$ref" : "#/components/schemas/AdditionalCommission"
},
"adyenCommission" : {
"description" : "Specifies the logic to apply when booking the transaction fees. Should be combined with schemeFee, interchange & adyenMarkup.\n\nPossible values: **deductFromLiableAccount**, **deductFromOneBalanceAccount**.",
"enum" : [
"deductFromLiableAccount",
"deductFromOneBalanceAccount"
],
"type" : "string"
},
"adyenFees" : {
"description" : "Specifies the logic to apply when booking the transaction fees. Should be combined with acquiringFees.\n\nPossible values: **deductFromLiableAccount**, **deductFromOneBalanceAccount**.",
"enum" : [
"deductFromLiableAccount",
"deductFromOneBalanceAccount"
],
"type" : "string"
},
"adyenMarkup" : {
"description" : "Specifies the logic to apply when booking the transaction fees. Should be combined with schemeFee, adyenCommission & interchange.\n\nPossible values: **deductFromLiableAccount**, **deductFromOneBalanceAccount**.",
"enum" : [
"deductFromLiableAccount",
"deductFromOneBalanceAccount"
],
"type" : "string"
},
"chargeback" : {
"description" : "Specifies the logic to apply when booking the chargeback amount.\n\nPossible values: **deductFromLiableAccount**, **deductFromOneBalanceAccount**, **deductAccordingToSplitRatio**.",
"enum" : [
@@ -18748,12 +18791,28 @@
],
"type" : "string"
},
"chargebackCostAllocation" : {
"description" : "Specifies the logic to apply when allocating the chargeback costs.\n\nPossible values: **deductFromLiableAccount**, **deductFromOneBalanceAccount**",
"enum" : [
"deductFromLiableAccount",
"deductFromOneBalanceAccount"
],
"type" : "string"
},
"commission" : {
"description" : "Contains the logic used to the calculate your platform's commission, booked to your liable balance account.",
"$ref" : "#/components/schemas/Commission"
},
"interchange" : {
"description" : "Specifies the logic to apply when booking the transaction fees. Should be combined with schemeFee, adyenCommission & adyenMarkup.\n\nPossible values: **deductFromLiableAccount**, **deductFromOneBalanceAccount**.",
"enum" : [
"deductFromLiableAccount",
"deductFromOneBalanceAccount"
],
"type" : "string"
},
"paymentFee" : {
"description" : "Specifies the logic to apply when booking the transaction fees.\n\nPossible values: **deductFromLiableAccount**, **deductFromOneBalanceAccount**.",
"description" : "Specifies the logic to apply when booking the transaction fees. Cannot be combined with other fees.\n\nPossible values: **deductFromLiableAccount**, **deductFromOneBalanceAccount**.",
"enum" : [
"deductFromLiableAccount",
"deductFromOneBalanceAccount"
@@ -18768,6 +18827,14 @@
],
"type" : "string"
},
"schemeFee" : {
"description" : "Specifies the logic to apply when booking the transaction fees. Should be combined with interchange, adyenCommission & adyenMarkup.\n\nPossible values: **deductFromLiableAccount**, **deductFromOneBalanceAccount**.",
"enum" : [
"deductFromLiableAccount",
"deductFromOneBalanceAccount"
],
"type" : "string"
},
"splitLogicId" : {
"description" : "Unique identifier of the split logic that is applied when the split configuration conditions are met.",
"readOnly" : true,
@@ -18791,7 +18858,6 @@
}
},
"required" : [
"paymentFee",
"commission"
],
"type" : "object"
@@ -18897,7 +18963,7 @@
"type" : "string"
},
"reference" : {
"description" : "A reference to recognize the store by. Also known as the store code.\n Allowed characters: Lowercase and uppercase letters without diacritics, numbers 0 through 9, hyphen (-), and underscore (_)",
"description" : "A reference to recognize the store by. Also known as the store code.\n Allowed characters: lowercase and uppercase letters without diacritics, numbers 0 through 9, hyphen (-), and underscore (_)",
"type" : "string"
},
"shopperStatement" : {
@@ -18938,7 +19004,7 @@
"type" : "string"
},
"externalReferenceId" : {
"description" : "Used by certain payment methods and tax authorities to uniquely identify the store.\n\nFor CNPJ in Brazil, ZIP in Australia and SIRET in France. This field is conditionally required if the store is in Brazil, Australia or France.\n\nFor CNPJ the format is 00.000.000/0000-00, can be submitted as just digits, or with dots, slash & hyphen.\n\nFor Australian stores ZIP an optional field used by the Zip payment method.\n\nFor SIRET the format is 14 digits.",
"description" : "The unique identifier of the store, used by certain payment methods and tax authorities. Accepts up to 14 digits.\n\nRequired for CNPJ in Brazil, in the format 00.000.000/00git00-00 separated by dots, slashes, hyphens, or without separators.\n\nOptional for Zip in Australia and SIRET in France, required except for nonprofit organizations and incorporated associations.\n\n",
"type" : "string"
},
"phoneNumber" : {
@@ -18984,7 +19050,7 @@
"type" : "string"
},
"externalReferenceId" : {
"description" : "Used by certain payment methods and tax authorities to uniquely identify the store.\n\nFor CNPJ in Brazil, ZIP in Australia and SIRET in France. This field is conditionally required if the store is in Brazil, Australia or France.\n\nFor CNPJ the format is 00.000.000/0000-00, can be submitted as just digits, or with dots, slash & hyphen.\n\nFor Australian stores ZIP an optional field used by the Zip payment method.\n\nFor SIRET the format is 14 digits.",
"description" : "The unique identifier of the store, used by certain payment methods and tax authorities. Accepts up to 14 digits.\n\nRequired for CNPJ in Brazil, in the format 00.000.000/00git00-00 separated by dots, slashes, hyphens, or without separators.\n\nOptional for Zip in Australia and SIRET in France, required except for nonprofit organizations and incorporated associations.\n\n",
"type" : "string"
},
"merchantId" : {
@@ -19091,43 +19157,55 @@
"type" : "string"
}
},
"required" : [
"swishNumber"
],
"type" : "object"
},
"Terminal" : {
"properties" : {
"assigned" : {
"deprecated" : true,
"description" : "The [assignment status](https://docs.adyen.com/point-of-sale/automating-terminal-management/assign-terminals-api) of the terminal. If true, the terminal is assigned. If false, the terminal is in inventory and can't be boarded.",
"type" : "boolean"
},
"bluetoothIp" : {
"deprecated" : true,
"description" : "The Bluetooth IP address of the terminal.",
"type" : "string"
},
"bluetoothMac" : {
"deprecated" : true,
"description" : "The Bluetooth MAC address of the terminal.",
"type" : "string"
},
"city" : {
"deprecated" : true,
"description" : "The city where the terminal is located.",
"type" : "string"
},
"companyAccount" : {
"deprecated" : true,
"description" : "The company account that the terminal is associated with. If this is the only account level shown in the response, the terminal is assigned to the inventory of the company account.",
"type" : "string"
},
"countryCode" : {
"deprecated" : true,
"description" : "The country code of the country where the terminal is located.",
"type" : "string"
},
"deviceModel" : {
"deprecated" : true,
"description" : "The model name of the terminal.",
"type" : "string"
},
"ethernetIp" : {
"deprecated" : true,
"description" : "The ethernet IP address of the terminal.",
"type" : "string"
},
"ethernetMac" : {
"deprecated" : true,
"description" : "The ethernet MAC address of the terminal.",
"type" : "string"
},
@@ -19136,6 +19214,7 @@
"type" : "string"
},
"iccid" : {
"deprecated" : true,
"description" : "The integrated circuit card identifier (ICCID) of the SIM card in the terminal.",
"type" : "string"
},
@@ -19144,16 +19223,19 @@
"type" : "string"
},
"lastActivityDateTime" : {
"deprecated" : true,
"description" : "Date and time of the last activity on the terminal. Not included when the last activity was more than 14 days ago.",
"format" : "date-time",
"type" : "string"
},
"lastTransactionDateTime" : {
"description" : "Date and time of the last transaction on the terminal. Not included when the last transaction was more than 14 days ago.",
"deprecated" : true,
"description" : "Date and time of the last transaction on the terminal.",
"format" : "date-time",
"type" : "string"
},
"linkNegotiation" : {
"deprecated" : true,
"description" : "The Ethernet link negotiation that the terminal uses:\n\n- `auto`: Auto-negotiation\n\n- `100full`: 100 Mbps full duplex",
"type" : "string"
},
@@ -19162,26 +19244,32 @@
"type" : "string"
},
"simStatus" : {
"deprecated" : true,
"description" : "On a terminal that supports 3G or 4G connectivity, indicates the status of the SIM card in the terminal: ACTIVE or INVENTORY.",
"type" : "string"
},
"status" : {
"deprecated" : true,
"description" : "Indicates when the terminal was last online, whether the terminal is being reassigned, or whether the terminal is turned off. If the terminal was last online more that a week ago, it is also shown as turned off.",
"type" : "string"
},
"storeStatus" : {
"deprecated" : true,
"description" : "The status of the store that the terminal is assigned to.",
"type" : "string"
},
"wifiIp" : {
"deprecated" : true,
"description" : "The terminal's IP address in your Wi-Fi network.",
"type" : "string"
},
"wifiMac" : {
"deprecated" : true,
"description" : "The terminal's MAC address in your Wi-Fi network.",
"type" : "string"
},
"wifiSsid" : {
"deprecated" : true,
"description" : "The SSID of the Wi-Fi network that your terminal is connected to.",
"type" : "string"
}
@@ -20019,10 +20107,42 @@
},
"UpdateSplitConfigurationLogicRequest" : {
"properties" : {
"acquiringFees" : {
"description" : "Specifies the logic to apply when booking the transaction fees. Should be combined with adyenFees.\n\nPossible values: **deductFromLiableAccount**, **deductFromOneBalanceAccount**.",
"enum" : [
"deductFromLiableAccount",
"deductFromOneBalanceAccount"
],
"type" : "string"
},
"additionalCommission" : {
"description" : "Contains the logic used to calculate your user's commission, booked directly to their balance account.",
"$ref" : "#/components/schemas/AdditionalCommission"
},
"adyenCommission" : {
"description" : "Specifies the logic to apply when booking the transaction fees. Should be combined with schemeFee, interchange & adyenMarkup.\n\nPossible values: **deductFromLiableAccount**, **deductFromOneBalanceAccount**.",
"enum" : [
"deductFromLiableAccount",
"deductFromOneBalanceAccount"
],
"type" : "string"
},
"adyenFees" : {
"description" : "Specifies the logic to apply when booking the transaction fees. Should be combined with acquiringFees.\n\nPossible values: **deductFromLiableAccount**, **deductFromOneBalanceAccount**.",
"enum" : [
"deductFromLiableAccount",
"deductFromOneBalanceAccount"
],
"type" : "string"
},
"adyenMarkup" : {
"description" : "Specifies the logic to apply when booking the transaction fees. Should be combined with schemeFee, adyenCommission & interchange.\n\nPossible values: **deductFromLiableAccount**, **deductFromOneBalanceAccount**.",
"enum" : [
"deductFromLiableAccount",
"deductFromOneBalanceAccount"
],
"type" : "string"
},
"chargeback" : {
"description" : "Specifies the logic to apply when booking the chargeback amount.\n\nPossible values: **deductFromLiableAccount**, **deductFromOneBalanceAccount**, **deductAccordingToSplitRatio**.",
"enum" : [
@@ -20032,12 +20152,28 @@
],
"type" : "string"
},
"chargebackCostAllocation" : {
"description" : "Specifies the logic to apply when allocating the chargeback costs.\n\nPossible values: **deductFromLiableAccount**, **deductFromOneBalanceAccount**",
"enum" : [
"deductFromLiableAccount",
"deductFromOneBalanceAccount"
],
"type" : "string"
},
"commission" : {
"description" : "Contains the logic used to the calculate your platform's commission, booked to your liable balance account.",
"$ref" : "#/components/schemas/Commission"
},
"interchange" : {
"description" : "Specifies the logic to apply when booking the transaction fees. Should be combined with schemeFee, adyenCommission & adyenMarkup.\n\nPossible values: **deductFromLiableAccount**, **deductFromOneBalanceAccount**.",
"enum" : [
"deductFromLiableAccount",
"deductFromOneBalanceAccount"
],
"type" : "string"
},
"paymentFee" : {
"description" : "Specifies the logic to apply when booking the transaction fees.\n\nPossible values: **deductFromLiableAccount**, **deductFromOneBalanceAccount**.",
"description" : "Specifies the logic to apply when booking the transaction fees. Cannot be combined with other fees.\n\nPossible values: **deductFromLiableAccount**, **deductFromOneBalanceAccount**.",
"enum" : [
"deductFromLiableAccount",
"deductFromOneBalanceAccount"
@@ -20052,6 +20188,14 @@
],
"type" : "string"
},
"schemeFee" : {
"description" : "Specifies the logic to apply when booking the transaction fees. Should be combined with interchange, adyenCommission & adyenMarkup.\n\nPossible values: **deductFromLiableAccount**, **deductFromOneBalanceAccount**.",
"enum" : [
"deductFromLiableAccount",
"deductFromOneBalanceAccount"
],
"type" : "string"
},
"splitLogicId" : {
"description" : "Unique identifier of the split logic that is applied when the split configuration conditions are met.",
"readOnly" : true,
@@ -20075,7 +20219,6 @@
}
},
"required" : [
"paymentFee",
"commission"
],
"type" : "object"
@@ -20126,7 +20269,7 @@
"$ref" : "#/components/schemas/UpdatableAddress"
},
"businessLineIds" : {
"description" : "The unique identifiers of the [business lines](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/businesslines__resParam_id) that the store is associated with.",
"description" : "The unique identifiers of the [business lines](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/businessLines__resParam_id) that the store is associated with.",
"items" : {
"type" : "string"
},
@@ -20446,7 +20589,7 @@
"summary" : "Response code - 200 OK",
"description" : "Example response when getting a list of Android apps",
"value" : {
"androidApps" : [
"data" : [
{
"id" : "ANDA422LZ223223K5F694GCCF732K8",
"packageName" : "com.your_company.posapp",
@@ -20472,7 +20615,7 @@
"summary" : "Response code - 200 OK",
"description" : "Example response when getting a list of Android certificates",
"value" : {
"androidCertificates" : [
"data" : [
{
"id" : "ANDC422LZ223223K5F78NVN9SL4VPH",
"name" : "mycert",
@@ -20488,7 +20631,7 @@
"extension" : ".pem",
"description" : "",
"status" : "ready",
"notBefore" : "20018-04-20T00:00:00+02:00",
"notBefore" : "2008-04-20T00:00:00+02:00",
"notAfter" : "2048-04-12T00:00:00+02:00"
}
]
@@ -21318,18 +21461,14 @@
"summary" : "Response code - 200 OK",
"description" : "Example response with the details of the specified terminal action",
"value" : {
"data" : [
{
"actionType" : "InstallAndroidCertificate",
"config" : "{\"certificates\":\"5dff6b...\"}",
"confirmedAt" : "2022-06-27T17:44:54+02:00",
"id" : "TRAC4224Z223223K5GD89RLBWQ6CWT",
"result" : "Ok",
"scheduledAt" : "2022-06-27T15:44:07+02:00",
"status" : "successful",
"terminalId" : "S1F2-000150183300034"
}
]
"actionType" : "InstallAndroidCertificate",
"config" : "{\"certificates\":\"5dff6b...\"}",
"confirmedAt" : "2022-06-27T17:44:54+02:00",
"id" : "TRAC4224Z223223K5GD89RLBWQ6CWT",
"result" : "Ok",
"scheduledAt" : "2022-06-27T15:44:07+02:00",
"status" : "successful",
"terminalId" : "S1F2-000150183300034"
}
},
"get-companies-companyId-terminalActions-success-200" : {
@@ -22848,7 +22987,7 @@
"pagesTotal" : 1,
"data" : [
{
"storeId" : "ST322LJ223223K5F4SQNR9XL5",
"id" : "ST322LJ223223K5F4SQNR9XL5",
"address" : {
"city" : "Springfield",
"country" : "US",
@@ -22870,7 +23009,7 @@
}
},
{
"storeId" : "ST322LJ223223K5F4SQNR9XL6",
"id" : "ST322LJ223223K5F4SQNR9XL6",
"address" : {
"city" : "North Madison",
"country" : "US",
@@ -23871,7 +24010,7 @@
"summary" : "Response code - 200 OK",
"description" : "Example response when getting the details of a store",
"value" : {
"storeId" : "ST322LJ223223K5F4SQNR9XL5",
"id" : "ST322LJ223223K5F4SQNR9XL5",
"address" : {
"city" : "Springfield",
"country" : "US",
@@ -24018,7 +24157,7 @@
"pagesTotal" : 1,
"data" : [
{
"storeId" : "ST322LJ223223K5F4SQNR9XL5",
"id" : "ST322LJ223223K5F4SQNR9XL5",
"address" : {
"city" : "Springfield",
"country" : "US",
@@ -24040,7 +24179,7 @@
}
},
{
"storeId" : "ST322LJ223223K5F4SQNR9XL6",
"id" : "ST322LJ223223K5F4SQNR9XL6",
"address" : {
"city" : "North Madison",
"country" : "US",
@@ -24157,6 +24296,9 @@
"username" : "BASIC_AUTH_USERNAME"
}
]
},
"notification" : {
"showButton" : true
}
},
"opi" : {
@@ -24207,7 +24349,14 @@
"fromActiveToSleep" : 30
},
"hardware" : {
"displayMaximumBackLight" : 75
"displayMaximumBackLight" : 75,
"restartHour" : 5
},
"passcodes" : {
"adminMenuPin" : "1234",
"txMenuPin" : "1234",
"refundPin" : "123456",
"screenLockPin" : "1111"
},
"connectivity" : {
"simcardStatus" : "INVENTORY"
@@ -26491,6 +26640,9 @@
"username" : "BASIC_AUTH_USERNAME"
}
]
},
"notification" : {
"showButton" : true
}
},
"opi" : {
@@ -26564,7 +26716,14 @@
"fromActiveToSleep" : 30
},
"hardware" : {
"displayMaximumBackLight" : 75
"displayMaximumBackLight" : 75,
"restartHour" : 5
},
"passcodes" : {
"adminMenuPin" : "1234",
"txMenuPin" : "1234",
"refundPin" : "123456",
"screenLockPin" : "1111"
},
"connectivity" : {
"simcardStatus" : "INVENTORY"
@@ -26654,6 +26813,9 @@
"username" : "BASIC_AUTH_USERNAME"
}
]
},
"notification" : {
"showButton" : true
}
},
"opi" : {
@@ -26719,7 +26881,14 @@
"fromActiveToSleep" : 30
},
"hardware" : {
"displayMaximumBackLight" : 75
"displayMaximumBackLight" : 75,
"restartHour" : 5
},
"passcodes" : {
"adminMenuPin" : "1234",
"txMenuPin" : "1234",
"refundPin" : "123456",
"screenLockPin" : "1111"
},
"connectivity" : {
"simcardStatus" : "INVENTORY"

28546
json/ManagementService-v3.json Normal file
View File

File diff suppressed because it is too large Load Diff

14
yaml/ManagementNotificationService-v1.yaml
View File

@@ -21,7 +21,9 @@ info:
x-groups:
- Merchant account
- Payment method
tags: []
tags:
- name: Merchant account
- name: Payment method
x-staticResponse: response.json
webhooks:
merchant.created:
@@ -60,8 +62,8 @@ webhooks:
tags:
- Merchant account
summary: Merchant account capability updated
description: There were changes to verification status and capabilities of a
[merchant account](https://docs.adyen.com/api-explorer/#/ManagementService/latest/post/merchants).
description: There were changes to the verification status and capabilities
of a [merchant account](https://docs.adyen.com/api-explorer/#/ManagementService/latest/post/merchants).
If the verification fails, this webhook includes the errors and the actions
that you can take to resolve them.
x-addedInVersion: '1'
@@ -415,10 +417,10 @@ components:
or disabled (**false**).
type: boolean
id:
description: The identifier of the resource.
description: The unique identifier of the resource.
type: string
merchantId:
description: The identifier of the merchant account.
description: The unique identifier of the merchant account.
type: string
reference:
description: Your reference for the payment method.
@@ -430,7 +432,7 @@ components:
- FAILURE
type: string
storeId:
description: The identifier of the [store](https://docs.adyen.com/api-explorer/#/ManagementService/latest/post/merchants/{id}/paymentMethodSettings__reqParam_storeId),
description: The unique identifier of the [store](https://docs.adyen.com/api-explorer/#/ManagementService/latest/post/merchants/{id}/paymentMethodSettings__reqParam_storeId),
if any.
type: string
type:

303
yaml/ManagementNotificationService-v3.yaml Normal file
View File

@@ -0,0 +1,303 @@
openapi: 3.1.0
info:
version: '3'
x-publicVersion: true
title: Management Webhooks
description: 'Adyen uses webhooks to inform your system about events that happen
with your Adyen company and merchant accounts, stores, payment terminals, and
payment methods when using [Management API](https://docs.adyen.com/api-explorer/#/ManagementService/latest/overview).
When an event occurs, Adyen makes an HTTP POST request to a URL on your server
and includes the details of the event in the request body.
See [Webhooks](https://docs.adyen.com/development-resources/webhooks) for more
information.'
termsOfService: https://www.adyen.com/legal/terms-and-conditions
contact:
name: Adyen Developer Experience team
url: https://github.com/Adyen/adyen-openapi
x-groups:
- Payment method
tags:
- name: Payment method
x-staticResponse: response.json
webhooks:
paymentMethod.created:
post:
tags:
- Payment method
summary: Payment method created
description: A request to [add a payment method](https://docs.adyen.com/api-explorer/Management/latest/post/merchants/_merchantId_/paymentMethodSettings)
was completed.
x-addedInVersion: '1'
operationId: post-paymentMethod.created
x-groupName: Payment method
x-sortIndex: 1
x-methodName: paymentMethodCreated
security:
- BasicAuth: []
requestBody:
content:
application/json:
examples:
paymentMethod.created:
$ref: '#/components/examples/post-paymentMethod.created-paymentMethod.created'
schema:
$ref: '#/components/schemas/PaymentMethodCreatedNotificationRequest'
responses:
'200':
content:
application/json:
examples:
paymentMethod.created:
$ref: '#/components/examples/WebhookAck'
schema:
$ref: '#/components/schemas/PaymentMethodNotificationResponse'
description: OK - the request has succeeded.
paymentMethod.requestRemoved:
post:
tags:
- Payment method
summary: Payment method request removed
description: A request to add a payment method is removed. You must make another
request to [add a payment method](https://docs.adyen.com/api-explorer/Management/latest/post/merchants/_merchantId_/paymentMethodSettings).
x-addedInVersion: '2'
operationId: post-paymentMethod.requestRemoved
x-groupName: Payment method
x-sortIndex: 3
x-methodName: paymentMethodRequestRemoved
security:
- BasicAuth: []
requestBody:
content:
application/json:
examples:
paymentMethod.requestRemoved:
$ref: '#/components/examples/post-paymentMethod.requestRemoved-paymentMethod.requestRemoved'
schema:
$ref: '#/components/schemas/NotificationDataMessage'
responses:
'200':
content:
application/json:
examples:
paymentMethod.requestRemoved:
$ref: '#/components/examples/WebhookAck'
schema:
$ref: '#/components/schemas/PaymentMethodNotificationResponse'
description: OK - the request has succeeded.
paymentMethod.requestScheduledForRemoval:
post:
tags:
- Payment method
summary: Payment method request scheduled for removal
description: A request to [add a payment method](https://docs.adyen.com/api-explorer/Management/latest/post/merchants/_merchantId_/paymentMethodSettings)
will be removed in 30 days. To make sure the payment method is added, provide
the missing [KYC information](https://docs.adyen.com/marketplaces-and-platforms/collect-verification-details).
x-addedInVersion: '2'
operationId: post-paymentMethod.requestScheduledForRemoval
x-groupName: Payment method
x-sortIndex: 2
x-methodName: paymentMethodRequestScheduledForRemoval
security:
- BasicAuth: []
requestBody:
content:
application/json:
examples:
paymentMethod.requestScheduledForRemoval:
$ref: '#/components/examples/post-paymentMethod.requestScheduledForRemoval-paymentMethod.requestScheduledForRemoval'
schema:
$ref: '#/components/schemas/NotificationDataMessage'
responses:
'200':
content:
application/json:
examples:
paymentMethod.requestScheduledForRemoval:
$ref: '#/components/examples/WebhookAck'
schema:
$ref: '#/components/schemas/PaymentMethodNotificationResponse'
description: OK - the request has succeeded.
components:
schemas:
MidServiceNotificationData:
properties:
allowed:
description: Indicates whether receiving payments is allowed. This value
is set to **true** by Adyen after screening your merchant account.
type: boolean
enabled:
description: Indicates whether the payment method is enabled (**true**)
or disabled (**false**).
type: boolean
id:
description: The unique identifier of the resource.
type: string
merchantId:
description: The unique identifier of the merchant account.
type: string
reference:
description: Your reference for the payment method.
type: string
status:
x-addedInVersion: '2'
description: 'The status of the request to add a payment method. Possible
values:
* **success**: the payment method was added.
* **failure**: the request failed.
* **dataRequired**: the request is in a draft state because the required
KYC data are missing. To check what data are missing, [get the details
of the legal entity](https://docs.adyen.com/api-explorer/legalentity/latest/get/legalEntities/_id_).
* **capabilityPending**: the **receivePayments** capability is not allowed.
* **updatesExpected**: the **receivePayments** capability is not allowed
and the required KYC data are missing. To check what data are missing,
[get the details of the legal entity](https://docs.adyen.com/api-explorer/legalentity/latest/get/legalEntities/_id_).'
enum:
- success
- failure
- capabilityPending
- dataRequired
- updatesExpected
type: string
storeId:
description: The unique identifier of the [store](https://docs.adyen.com/api-explorer/#/ManagementService/latest/post/merchants/{id}/paymentMethodSettings__reqParam_storeId),
if any.
type: string
type:
description: Payment method [variant](https://docs.adyen.com/development-resources/paymentmethodvariant#management-api).
type: string
verificationStatus:
description: 'Payment method status. Possible values:
* **valid**
* **pending**
* **invalid**
* **rejected**'
enum:
- valid
- pending
- invalid
- rejected
type: string
required:
- status
- merchantId
- id
- type
type: object
NotificationDataMessage:
properties:
createdAt:
description: Timestamp for when the webhook was created.
format: date-time
type: string
data:
description: Contains event details.
$ref: '#/components/schemas/MidServiceNotificationData'
environment:
description: 'The environment from which the webhook originated.
Possible values: **test**, **live**.'
type: string
type:
description: Type of notification.
type: string
required:
- type
- environment
- createdAt
- data
type: object
PaymentMethodCreatedNotificationRequest:
properties:
createdAt:
description: Timestamp for when the webhook was created.
format: date-time
type: string
data:
description: Contains event details.
$ref: '#/components/schemas/MidServiceNotificationData'
environment:
description: 'The environment from which the webhook originated.
Possible values: **test**, **live**.'
type: string
type:
description: Type of notification.
enum:
- paymentMethod.created
type: string
required:
- environment
- createdAt
- data
- type
type: object
PaymentMethodNotificationResponse:
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).
type: string
type: object
securitySchemes:
BasicAuth:
scheme: basic
type: http
examples:
WebhookAck:
summary: Acknowledge Webhook
value:
notificationResponse: '[accepted]'
post-paymentMethod.created-paymentMethod.created:
summary: Payment method Visa created
value:
createdAt: '2022-01-24T14:59:11+01:00'
data:
id: PM3224R223224K5FH4M2K9B86
merchantId: MERCHANT_ACCOUNT
status: success
storeId: ST322LJ223223K5F4SQNR9XL5
type: visa
environment: test
type: paymentMethod.created
post-paymentMethod.requestRemoved-paymentMethod.requestRemoved:
summary: Payment method request is removed
value:
type: paymentMethod.requestRemoved
environment: devl
createdAt: '2023-06-12T18:59:17+02:00'
data:
id: PM322WP223224M5HJ6PX77BW8
storeId: TestStore
type: amex
status: dataRequired
merchantId: TestMerchant
enabled: false
post-paymentMethod.requestScheduledForRemoval-paymentMethod.requestScheduledForRemoval:
summary: Payment method request scheduled for removal
value:
type: paymentMethod.requestScheduledForRemoval
environment: devl
createdAt: '2023-06-12T19:02:42+02:00'
data:
id: PM322WP223224M5HJ6PX77BW8
storeId: TestStore
type: visa
status: updatesExpected
merchantId: TestMerchant
enabled: false

363
yaml/ManagementService-v1.yaml
View File

@@ -80,35 +80,35 @@ x-groups:
- Android files - company level
- Split configuration - merchant level
tags:
- name: API key - merchant level
- name: Account - merchant level
- name: Split configuration - merchant level
- name: Allowed origins - company level
- name: API key - company level
- name: Client key - company level
- name: Users - company level
- name: Terminal actions - terminal level
- name: Terminal settings - terminal level
- name: Payout settings - merchant level
- name: Webhooks - merchant level
- name: Client key - merchant level
- name: Terminal orders - company level
- name: Allowed origins - merchant level
- name: API credentials - merchant level
- name: Users - merchant level
- name: Terminal actions - company level
- name: Payment methods - merchant level
- name: My API credential
- name: Terminal settings - merchant level
- name: Webhooks - company level
- name: Terminals - terminal level
- name: Android files - company level
- name: Account - store level
- name: Terminal settings - company level
- name: API credentials - company level
- name: Terminal orders - merchant level
- name: Account - company level
- name: Account - merchant level
- name: Account - store level
- name: Payout settings - merchant level
- name: Users - company level
- name: Users - merchant level
- name: My API credential
- name: API credentials - company level
- name: API credentials - merchant level
- name: API key - company level
- name: API key - merchant level
- name: Client key - company level
- name: Client key - merchant level
- name: Allowed origins - company level
- name: Allowed origins - merchant level
- name: Webhooks - company level
- name: Webhooks - merchant level
- name: Payment methods - merchant level
- name: Terminals - terminal level
- name: Terminal actions - company level
- name: Terminal actions - terminal level
- name: Terminal orders - company level
- name: Terminal orders - merchant level
- name: Terminal settings - company level
- name: Terminal settings - merchant level
- name: Terminal settings - store level
- name: Terminal settings - terminal level
- name: Android files - company level
- name: Split configuration - merchant level
paths:
/companies:
get:
@@ -988,7 +988,7 @@ paths:
responses:
'204':
description: 'No Content - look at the actual response code for the status
of the request '
of the request. '
'400':
content:
application/json:
@@ -3026,7 +3026,7 @@ paths:
responses:
'204':
description: 'No Content - look at the actual response code for the status
of the request '
of the request. '
'400':
content:
application/json:
@@ -3561,7 +3561,7 @@ paths:
responses:
'204':
description: 'No Content - look at the actual response code for the status
of the request '
of the request. '
'400':
content:
application/json:
@@ -4434,7 +4434,7 @@ paths:
responses:
'204':
description: 'No Content - look at the actual response code for the status
of the request '
of the request. '
'400':
content:
application/json:
@@ -5110,7 +5110,7 @@ paths:
responses:
'204':
description: 'No Content - look at the actual response code for the status
of the request '
of the request. '
'400':
content:
application/json:
@@ -5382,7 +5382,7 @@ paths:
responses:
'204':
description: 'No Content - look at the actual response code for the status
of the request '
of the request. '
'400':
content:
application/json:
@@ -8461,7 +8461,7 @@ paths:
responses:
'204':
description: 'No Content - look at the actual response code for the status
of the request '
of the request. '
'400':
content:
application/json:
@@ -10197,6 +10197,8 @@ components:
items:
type: string
type: array
required:
- domains
type: object
BcmcInfo:
properties:
@@ -11489,8 +11491,10 @@ components:
format: int32
type: integer
restartHour:
description: The hour (0 - 23) in which the device will reboot, reboot will
happen in the timezone of the device
description: 'The hour of the day when the terminal is set to reboot to
apply the configuration and software updates. By default, the restart
hour is at 6:00 AM in the timezone of the terminal Minimum vaoue: 0, maximum
value: 23.'
format: int32
type: integer
type: object
@@ -11606,6 +11610,7 @@ components:
description: The email address of merchant support.
type: string
required:
- region
- supportEmail
- disputeEmail
type: object
@@ -11790,7 +11795,7 @@ components:
description: Pagination references.
$ref: '#/components/schemas/PaginationLinks'
data:
description: The list of terminals.
description: The list of terminals and their details.
items:
$ref: '#/components/schemas/Terminal'
type: array
@@ -12086,13 +12091,15 @@ components:
type: string
type: array
notification:
description: Setting to manage the notification configuration.
description: Configures the event notification button on the terminal screen,
for example used for pay-at-table.
$ref: '#/components/schemas/Notification'
type: object
Notification:
properties:
showButton:
description: Toggle to show or hide Notification button on the terminal
description: Shows or hides the event notification button on the terminal
screen.
type: boolean
type: object
NotificationUrl:
@@ -12230,6 +12237,13 @@ components:
type: object
Payment:
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.
maxLength: 3
minLength: 3
type: string
hideMinorUnitsInCurrencies:
description: Hides the minor units for the listed [ISO currency codes](https://en.wikipedia.org/wiki/ISO_4217).
items:
@@ -12385,7 +12399,7 @@ components:
description: Pagination references.
$ref: '#/components/schemas/PaginationLinks'
data:
description: Payment methods details.
description: The list of supported payment methods and their details.
items:
$ref: '#/components/schemas/PaymentMethodWrapper'
type: array
@@ -12412,7 +12426,6 @@ components:
- clearpay
- cup
- diners
- directEbanking
- directdebit_GB
- discover
- ebanking_FI
@@ -12585,7 +12598,6 @@ components:
- clearpay
- cup
- diners
- directEbanking
- directdebit_GB
- discover
- ebanking_FI
@@ -12631,6 +12643,8 @@ components:
visa:
description: Visa details.
$ref: '#/components/schemas/GenericPmWithTdiInfo'
required:
- type
type: object
PaymentMethodWrapper:
properties:
@@ -13176,10 +13190,50 @@ components:
type: object
SplitConfigurationLogic:
properties:
acquiringFees:
description: 'Specifies the logic to apply when booking the transaction
fees. Should be combined with adyenFees.
Possible values: **deductFromLiableAccount**, **deductFromOneBalanceAccount**.'
enum:
- deductFromLiableAccount
- deductFromOneBalanceAccount
type: string
additionalCommission:
description: Contains the logic used to calculate your user's commission,
booked directly to their balance account.
$ref: '#/components/schemas/AdditionalCommission'
adyenCommission:
description: 'Specifies the logic to apply when booking the transaction
fees. Should be combined with schemeFee, interchange & adyenMarkup.
Possible values: **deductFromLiableAccount**, **deductFromOneBalanceAccount**.'
enum:
- deductFromLiableAccount
- deductFromOneBalanceAccount
type: string
adyenFees:
description: 'Specifies the logic to apply when booking the transaction
fees. Should be combined with acquiringFees.
Possible values: **deductFromLiableAccount**, **deductFromOneBalanceAccount**.'
enum:
- deductFromLiableAccount
- deductFromOneBalanceAccount
type: string
adyenMarkup:
description: 'Specifies the logic to apply when booking the transaction
fees. Should be combined with schemeFee, adyenCommission & interchange.
Possible values: **deductFromLiableAccount**, **deductFromOneBalanceAccount**.'
enum:
- deductFromLiableAccount
- deductFromOneBalanceAccount
type: string
chargeback:
description: 'Specifies the logic to apply when booking the chargeback amount.
@@ -13191,13 +13245,33 @@ components:
- deductFromOneBalanceAccount
- deductAccordingToSplitRatio
type: string
chargebackCostAllocation:
description: 'Specifies the logic to apply when allocating the chargeback
costs.
Possible values: **deductFromLiableAccount**, **deductFromOneBalanceAccount**'
enum:
- deductFromLiableAccount
- deductFromOneBalanceAccount
type: string
commission:
description: Contains the logic used to the calculate your platform's commission,
booked to your liable balance account.
$ref: '#/components/schemas/Commission'
interchange:
description: 'Specifies the logic to apply when booking the transaction
fees. Should be combined with schemeFee, adyenCommission & adyenMarkup.
Possible values: **deductFromLiableAccount**, **deductFromOneBalanceAccount**.'
enum:
- deductFromLiableAccount
- deductFromOneBalanceAccount
type: string
paymentFee:
description: 'Specifies the logic to apply when booking the transaction
fees.
fees. Cannot be combined with other fees.
Possible values: **deductFromLiableAccount**, **deductFromOneBalanceAccount**.'
@@ -13215,6 +13289,16 @@ components:
- addToLiableAccount
- addToOneBalanceAccount
type: string
schemeFee:
description: 'Specifies the logic to apply when booking the transaction
fees. Should be combined with interchange, adyenCommission & adyenMarkup.
Possible values: **deductFromLiableAccount**, **deductFromOneBalanceAccount**.'
enum:
- deductFromLiableAccount
- deductFromOneBalanceAccount
type: string
splitLogicId:
description: Unique identifier of the split logic that is applied when the
split configuration conditions are met.
@@ -13239,7 +13323,6 @@ components:
- addToOneBalanceAccount
type: string
required:
- paymentFee
- commission
type: object
SplitConfigurationRule:
@@ -13361,7 +13444,7 @@ components:
type: string
reference:
description: "A reference to recognize the store by. Also known as the store\
\ code.\n Allowed characters: Lowercase and uppercase letters without\
\ code.\n Allowed characters: lowercase and uppercase letters without\
\ diacritics, numbers 0 through 9, hyphen (-), and underscore (_)"
type: string
shopperStatement:
@@ -13403,22 +13486,19 @@ components:
description: Your description of the store.
type: string
externalReferenceId:
description: 'Used by certain payment methods and tax authorities to uniquely
identify the store.
description: 'The unique identifier of the store, used by certain payment
methods and tax authorities. Accepts up to 14 digits.
For CNPJ in Brazil, ZIP in Australia and SIRET in France. This field is
conditionally required if the store is in Brazil, Australia or France.
Required for CNPJ in Brazil, in the format 00.000.000/00git00-00 separated
by dots, slashes, hyphens, or without separators.
For CNPJ the format is 00.000.000/0000-00, can be submitted as just digits,
or with dots, slash & hyphen.
Optional for Zip in Australia and SIRET in France, required except for
nonprofit organizations and incorporated associations.
For Australian stores ZIP an optional field used by the Zip payment method.
For SIRET the format is 14 digits.'
'
type: string
phoneNumber:
description: The phone number of the store, including '+' and country code.
@@ -13463,22 +13543,19 @@ components:
description: Your description of the store.
type: string
externalReferenceId:
description: 'Used by certain payment methods and tax authorities to uniquely
identify the store.
description: 'The unique identifier of the store, used by certain payment
methods and tax authorities. Accepts up to 14 digits.
For CNPJ in Brazil, ZIP in Australia and SIRET in France. This field is
conditionally required if the store is in Brazil, Australia or France.
Required for CNPJ in Brazil, in the format 00.000.000/00git00-00 separated
by dots, slashes, hyphens, or without separators.
For CNPJ the format is 00.000.000/0000-00, can be submitted as just digits,
or with dots, slash & hyphen.
Optional for Zip in Australia and SIRET in France, required except for
nonprofit organizations and incorporated associations.
For Australian stores ZIP an optional field used by the Zip payment method.
For SIRET the format is 14 digits.'
'
type: string
merchantId:
description: The unique identifier of the merchant account that the store
@@ -13572,44 +13649,56 @@ components:
maxLength: 10
minLength: 10
type: string
required:
- swishNumber
type: object
Terminal:
properties:
assigned:
deprecated: true
description: The [assignment status](https://docs.adyen.com/point-of-sale/automating-terminal-management/assign-terminals-api)
of the terminal. If true, the terminal is assigned. If false, the terminal
is in inventory and can't be boarded.
type: boolean
bluetoothIp:
deprecated: true
description: The Bluetooth IP address of the terminal.
type: string
bluetoothMac:
deprecated: true
description: The Bluetooth MAC address of the terminal.
type: string
city:
deprecated: true
description: The city where the terminal is located.
type: string
companyAccount:
deprecated: true
description: The company account that the terminal is associated with. If
this is the only account level shown in the response, the terminal is
assigned to the inventory of the company account.
type: string
countryCode:
deprecated: true
description: The country code of the country where the terminal is located.
type: string
deviceModel:
deprecated: true
description: The model name of the terminal.
type: string
ethernetIp:
deprecated: true
description: The ethernet IP address of the terminal.
type: string
ethernetMac:
deprecated: true
description: The ethernet MAC address of the terminal.
type: string
firmwareVersion:
description: The software release currently in use on the terminal.
type: string
iccid:
deprecated: true
description: The integrated circuit card identifier (ICCID) of the SIM card
in the terminal.
type: string
@@ -13617,16 +13706,18 @@ components:
description: The unique identifier of the terminal.
type: string
lastActivityDateTime:
deprecated: true
description: Date and time of the last activity on the terminal. Not included
when the last activity was more than 14 days ago.
format: date-time
type: string
lastTransactionDateTime:
description: Date and time of the last transaction on the terminal. Not
included when the last transaction was more than 14 days ago.
deprecated: true
description: Date and time of the last transaction on the terminal.
format: date-time
type: string
linkNegotiation:
deprecated: true
description: 'The Ethernet link negotiation that the terminal uses:
@@ -13639,24 +13730,30 @@ components:
description: The serial number of the terminal.
type: string
simStatus:
deprecated: true
description: 'On a terminal that supports 3G or 4G connectivity, indicates
the status of the SIM card in the terminal: ACTIVE or INVENTORY.'
type: string
status:
deprecated: true
description: Indicates when the terminal was last online, whether the terminal
is being reassigned, or whether the terminal is turned off. If the terminal
was last online more that a week ago, it is also shown as turned off.
type: string
storeStatus:
deprecated: true
description: The status of the store that the terminal is assigned to.
type: string
wifiIp:
deprecated: true
description: The terminal's IP address in your Wi-Fi network.
type: string
wifiMac:
deprecated: true
description: The terminal's MAC address in your Wi-Fi network.
type: string
wifiSsid:
deprecated: true
description: The SSID of the Wi-Fi network that your terminal is connected
to.
type: string
@@ -14468,10 +14565,50 @@ components:
type: object
UpdateSplitConfigurationLogicRequest:
properties:
acquiringFees:
description: 'Specifies the logic to apply when booking the transaction
fees. Should be combined with adyenFees.
Possible values: **deductFromLiableAccount**, **deductFromOneBalanceAccount**.'
enum:
- deductFromLiableAccount
- deductFromOneBalanceAccount
type: string
additionalCommission:
description: Contains the logic used to calculate your user's commission,
booked directly to their balance account.
$ref: '#/components/schemas/AdditionalCommission'
adyenCommission:
description: 'Specifies the logic to apply when booking the transaction
fees. Should be combined with schemeFee, interchange & adyenMarkup.
Possible values: **deductFromLiableAccount**, **deductFromOneBalanceAccount**.'
enum:
- deductFromLiableAccount
- deductFromOneBalanceAccount
type: string
adyenFees:
description: 'Specifies the logic to apply when booking the transaction
fees. Should be combined with acquiringFees.
Possible values: **deductFromLiableAccount**, **deductFromOneBalanceAccount**.'
enum:
- deductFromLiableAccount
- deductFromOneBalanceAccount
type: string
adyenMarkup:
description: 'Specifies the logic to apply when booking the transaction
fees. Should be combined with schemeFee, adyenCommission & interchange.
Possible values: **deductFromLiableAccount**, **deductFromOneBalanceAccount**.'
enum:
- deductFromLiableAccount
- deductFromOneBalanceAccount
type: string
chargeback:
description: 'Specifies the logic to apply when booking the chargeback amount.
@@ -14483,13 +14620,33 @@ components:
- deductFromOneBalanceAccount
- deductAccordingToSplitRatio
type: string
chargebackCostAllocation:
description: 'Specifies the logic to apply when allocating the chargeback
costs.
Possible values: **deductFromLiableAccount**, **deductFromOneBalanceAccount**'
enum:
- deductFromLiableAccount
- deductFromOneBalanceAccount
type: string
commission:
description: Contains the logic used to the calculate your platform's commission,
booked to your liable balance account.
$ref: '#/components/schemas/Commission'
interchange:
description: 'Specifies the logic to apply when booking the transaction
fees. Should be combined with schemeFee, adyenCommission & adyenMarkup.
Possible values: **deductFromLiableAccount**, **deductFromOneBalanceAccount**.'
enum:
- deductFromLiableAccount
- deductFromOneBalanceAccount
type: string
paymentFee:
description: 'Specifies the logic to apply when booking the transaction
fees.
fees. Cannot be combined with other fees.
Possible values: **deductFromLiableAccount**, **deductFromOneBalanceAccount**.'
@@ -14507,6 +14664,16 @@ components:
- addToLiableAccount
- addToOneBalanceAccount
type: string
schemeFee:
description: 'Specifies the logic to apply when booking the transaction
fees. Should be combined with interchange, adyenCommission & adyenMarkup.
Possible values: **deductFromLiableAccount**, **deductFromOneBalanceAccount**.'
enum:
- deductFromLiableAccount
- deductFromOneBalanceAccount
type: string
splitLogicId:
description: Unique identifier of the split logic that is applied when the
split configuration conditions are met.
@@ -14531,7 +14698,6 @@ components:
- addToOneBalanceAccount
type: string
required:
- paymentFee
- commission
type: object
UpdateSplitConfigurationRequest:
@@ -14602,7 +14768,7 @@ components:
country of the store.
$ref: '#/components/schemas/UpdatableAddress'
businessLineIds:
description: The unique identifiers of the [business lines](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/businesslines__resParam_id)
description: The unique identifiers of the [business lines](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/businessLines__resParam_id)
that the store is associated with.
items:
type: string
@@ -14932,7 +15098,7 @@ components:
summary: Response code - 200 OK
description: Example response when getting a list of Android apps
value:
androidApps:
data:
- id: ANDA422LZ223223K5F694GCCF732K8
packageName: com.your_company.posapp
versionCode: 7700203
@@ -14951,7 +15117,7 @@ components:
summary: Response code - 200 OK
description: Example response when getting a list of Android certificates
value:
androidCertificates:
data:
- id: ANDC422LZ223223K5F78NVN9SL4VPH
name: mycert
extension: .crt
@@ -14964,7 +15130,7 @@ components:
extension: .pem
description: ''
status: ready
notBefore: 20018-04-20T00:00:00+02:00
notBefore: '2008-04-20T00:00:00+02:00'
notAfter: '2048-04-12T00:00:00+02:00'
get-companies-companyId-apiCredentials-apiCredentialId-allowedOrigins-get-allowed-origins-200:
summary: OK 200 - Get the list of allowed origins for the API credential
@@ -15524,15 +15690,14 @@ components:
summary: Response code - 200 OK
description: Example response with the details of the specified terminal action
value:
data:
- actionType: InstallAndroidCertificate
config: '{"certificates":"5dff6b..."}'
confirmedAt: '2022-06-27T17:44:54+02:00'
id: TRAC4224Z223223K5GD89RLBWQ6CWT
result: Ok
scheduledAt: '2022-06-27T15:44:07+02:00'
status: successful
terminalId: S1F2-000150183300034
actionType: InstallAndroidCertificate
config: '{"certificates":"5dff6b..."}'
confirmedAt: '2022-06-27T17:44:54+02:00'
id: TRAC4224Z223223K5GD89RLBWQ6CWT
result: Ok
scheduledAt: '2022-06-27T15:44:07+02:00'
status: successful
terminalId: S1F2-000150183300034
get-companies-companyId-terminalActions-success-200:
summary: Response code - 200 OK
description: Example response when getting a list of scheduled terminal actions
@@ -16615,7 +16780,7 @@ components:
itemsTotal: 2
pagesTotal: 1
data:
- storeId: ST322LJ223223K5F4SQNR9XL5
- id: ST322LJ223223K5F4SQNR9XL5
address:
city: Springfield
country: US
@@ -16632,7 +16797,7 @@ components:
_links:
self:
href: https://management-test.adyen.com/v1/stores/ST322LJ223223K5F4SQNR9XL5
- storeId: ST322LJ223223K5F4SQNR9XL6
- id: ST322LJ223223K5F4SQNR9XL6
address:
city: North Madison
country: US
@@ -17349,7 +17514,7 @@ components:
summary: Response code - 200 OK
description: Example response when getting the details of a store
value:
storeId: ST322LJ223223K5F4SQNR9XL5
id: ST322LJ223223K5F4SQNR9XL5
address:
city: Springfield
country: US
@@ -17454,7 +17619,7 @@ components:
itemsTotal: 2
pagesTotal: 1
data:
- storeId: ST322LJ223223K5F4SQNR9XL5
- id: ST322LJ223223K5F4SQNR9XL5
address:
city: Springfield
country: US
@@ -17471,7 +17636,7 @@ components:
_links:
self:
href: https://management-test.adyen.com/v1/stores/ST322LJ223223K5F4SQNR9XL5
- storeId: ST322LJ223223K5F4SQNR9XL6
- id: ST322LJ223223K5F4SQNR9XL6
address:
city: North Madison
country: US
@@ -17560,6 +17725,8 @@ components:
- password: BASIC_AUTH_PASSWORD
url: https://your-event-notifications-endpoint.com
username: BASIC_AUTH_USERNAME
notification:
showButton: true
opi:
enablePayAtTable: true
payAtTableStoreNumber: '1'
@@ -17598,6 +17765,12 @@ components:
fromActiveToSleep: 30
hardware:
displayMaximumBackLight: 75
restartHour: 5
passcodes:
adminMenuPin: '1234'
txMenuPin: '1234'
refundPin: '123456'
screenLockPin: '1111'
connectivity:
simcardStatus: INVENTORY
patch-companies-companyId-apiCredentials-apiCredentialId-patch-company-credential:
@@ -19334,6 +19507,8 @@ components:
- password: BASIC_AUTH_PASSWORD
url: https://your-event-notifications-endpoint.com
username: BASIC_AUTH_USERNAME
notification:
showButton: true
opi:
enablePayAtTable: true
payAtTableStoreNumber: '1'
@@ -19391,6 +19566,12 @@ components:
fromActiveToSleep: 30
hardware:
displayMaximumBackLight: 75
restartHour: 5
passcodes:
adminMenuPin: '1234'
txMenuPin: '1234'
refundPin: '123456'
screenLockPin: '1111'
connectivity:
simcardStatus: INVENTORY
patch-terminals-terminalId-terminalSettings-add-eap-tls-wifi-profile:
@@ -19453,6 +19634,8 @@ components:
- password: BASIC_AUTH_PASSWORD
url: https://your-event-notifications-endpoint.com
username: BASIC_AUTH_USERNAME
notification:
showButton: true
opi:
enablePayAtTable: true
payAtTableStoreNumber: '1'
@@ -19503,6 +19686,12 @@ components:
fromActiveToSleep: 30
hardware:
displayMaximumBackLight: 75
restartHour: 5
passcodes:
adminMenuPin: '1234'
txMenuPin: '1234'
refundPin: '123456'
screenLockPin: '1111'
connectivity:
simcardStatus: INVENTORY
post-companies-companyId-apiCredentials-apiCredentialId-allowedOrigins-add-allowed-origin:

20959
yaml/ManagementService-v3.yaml Normal file
View File

File diff suppressed because it is too large Load Diff