From d1f265ed37f9971a287fb6d48a84a70eceab609b Mon Sep 17 00:00:00 2001 From: Adyen Automation Date: Wed, 20 Nov 2024 11:58:55 +0100 Subject: [PATCH] spec release --- ...ePlatformConfigurationNotification-v1.json | 4 + ...ePlatformConfigurationNotification-v2.json | 4 + ...nceCompensationWarningNotification-v1.json | 223 ++++++++++++++++++ json/BalancePlatformService-v2.json | 17 +- ...ePlatformConfigurationNotification-v1.yaml | 3 + ...ePlatformConfigurationNotification-v2.yaml | 3 + ...nceCompensationWarningNotification-v1.yaml | 175 ++++++++++++++ yaml/BalancePlatformService-v2.yaml | 14 +- 8 files changed, 441 insertions(+), 2 deletions(-) create mode 100644 json/BalancePlatformNegativeBalanceCompensationWarningNotification-v1.json create mode 100644 yaml/BalancePlatformNegativeBalanceCompensationWarningNotification-v1.yaml diff --git a/json/BalancePlatformConfigurationNotification-v1.json b/json/BalancePlatformConfigurationNotification-v1.json index 7ceb5f86..d67724a1 100644 --- a/json/BalancePlatformConfigurationNotification-v1.json +++ b/json/BalancePlatformConfigurationNotification-v1.json @@ -1892,6 +1892,10 @@ ], "type" : "string" }, + "reasonDetail" : { + "description" : "The human readable reason for disabling the sweep.", + "type" : "string" + }, "reference" : { "description" : "Your reference for the sweep configuration.", "maxLength" : 80, diff --git a/json/BalancePlatformConfigurationNotification-v2.json b/json/BalancePlatformConfigurationNotification-v2.json index 4567962e..df3005aa 100644 --- a/json/BalancePlatformConfigurationNotification-v2.json +++ b/json/BalancePlatformConfigurationNotification-v2.json @@ -1939,6 +1939,10 @@ ], "type" : "string" }, + "reasonDetail" : { + "description" : "The human readable reason for disabling the sweep.", + "type" : "string" + }, "reference" : { "description" : "Your reference for the sweep configuration.", "maxLength" : 80, diff --git a/json/BalancePlatformNegativeBalanceCompensationWarningNotification-v1.json b/json/BalancePlatformNegativeBalanceCompensationWarningNotification-v1.json new file mode 100644 index 00000000..3129ced5 --- /dev/null +++ b/json/BalancePlatformNegativeBalanceCompensationWarningNotification-v1.json @@ -0,0 +1,223 @@ +{ + "openapi" : "3.1.0", + "info" : { + "version" : "1", + "x-publicVersion" : true, + "title" : "Negative balance compensation warning\n", + "description" : "Adyen sends webhooks to inform you about balance accounts whose balance has been negative for 20 or more days. If you do not transfer funds to that balance account to cover the negative balance before the scheduled compensation date, a transfer is made from your liable balance account on that date.", + "termsOfService" : "https://www.adyen.com/legal/terms-and-conditions", + "contact" : { + "name" : "Adyen Developer Experience team", + "url" : "https://github.com/Adyen/adyen-openapi" + } + }, + "tags" : [ + { + "name" : "General" + }, + { + "name" : "Balance account" + } + ], + "webhooks" : { + "balancePlatform.negativeBalanceCompensationWarning.scheduled" : { + "post" : { + "tags" : [ + "General" + ], + "summary" : "Negative balance compensation scheduled", + "description" : "Adyen sends this webhook to inform you about a balance account whose balance has been negative for 20 or more days. If you do not transfer funds to that balance account to cover the negative balance before the scheduled compensation date, a transfer is made from your liable balance account on that date.", + "operationId" : "post-balancePlatform.negativeBalanceCompensationWarning.scheduled", + "x-sortIndex" : 0, + "x-methodName" : "negativeBalanceCompensationScheduled", + "security" : [ + { + "BasicAuth" : [ + ] + } + ], + "requestBody" : { + "content" : { + "application/json" : { + "examples" : { + "balancePlatform.negativeBalanceCompensationWarning.scheduled" : { + "$ref" : "#/components/examples/post-balancePlatform.negativeBalanceCompensationWarning.scheduled-balancePlatform.negativeBalanceCompensationWarning.scheduled" + } + }, + "schema" : { + "$ref" : "#/components/schemas/NegativeBalanceCompensationWarningNotificationRequest" + } + } + } + }, + "responses" : { + "200" : { + "description" : "No Content - webhook events are accepted on the basis of the HTTP status code." + } + } + } + } + }, + "components" : { + "schemas" : { + "Amount" : { + "additionalProperties" : false, + "properties" : { + "currency" : { + "description" : "The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes).", + "maxLength" : 3, + "minLength" : 3, + "type" : "string" + }, + "value" : { + "description" : "The amount of the transaction, in [minor units](https://docs.adyen.com/development-resources/currency-codes).", + "format" : "int64", + "type" : "integer" + } + }, + "required" : [ + "value", + "currency" + ], + "type" : "object" + }, + "NegativeBalanceCompensationWarningNotificationData" : { + "additionalProperties" : false, + "properties" : { + "accountHolder" : { + "description" : "The details of the account holder who owns the balance account with a negative balance.", + "$ref" : "#/components/schemas/ResourceReference" + }, + "amount" : { + "description" : "The negative balance amount of the balance account.", + "$ref" : "#/components/schemas/Amount" + }, + "balancePlatform" : { + "description" : "The unique identifier of the balance platform.", + "type" : "string" + }, + "creationDate" : { + "description" : "The date and time when the event was triggered, in ISO 8601 extended format. For example, **2020-12-18T10:15:30+01:00**.", + "format" : "date-time", + "type" : "string" + }, + "id" : { + "description" : "The ID of the resource.", + "type" : "string" + }, + "liableBalanceAccountId" : { + "description" : "The balance account ID of the account that will be used to compensate the balance account whose balance is negative.", + "type" : "string" + }, + "negativeBalanceSince" : { + "description" : "The date the balance for the account became negative.", + "format" : "date-time", + "type" : "string" + }, + "scheduledCompensationAt" : { + "description" : "The date when a compensation transfer to the account is scheduled to happen.", + "format" : "date-time", + "type" : "string" + } + }, + "type" : "object" + }, + "NegativeBalanceCompensationWarningNotificationRequest" : { + "additionalProperties" : false, + "properties" : { + "data" : { + "description" : "Contains event details.", + "$ref" : "#/components/schemas/NegativeBalanceCompensationWarningNotificationData" + }, + "environment" : { + "description" : "The environment from which the webhook originated.\n\nPossible values: **test**, **live**.", + "type" : "string" + }, + "type" : { + "description" : "Type of webhook.", + "enum" : [ + "balancePlatform.negativeBalanceCompensationWarning.scheduled" + ], + "type" : "string" + } + }, + "required" : [ + "environment", + "type", + "data" + ], + "type" : "object" + }, + "Resource" : { + "additionalProperties" : false, + "properties" : { + "balancePlatform" : { + "description" : "The unique identifier of the balance platform.", + "type" : "string" + }, + "creationDate" : { + "description" : "The date and time when the event was triggered, in ISO 8601 extended format. For example, **2020-12-18T10:15:30+01:00**.", + "format" : "date-time", + "type" : "string" + }, + "id" : { + "description" : "The ID of the resource.", + "type" : "string" + } + }, + "type" : "object" + }, + "ResourceReference" : { + "additionalProperties" : false, + "properties" : { + "description" : { + "description" : "The description of the resource.", + "type" : "string" + }, + "id" : { + "description" : "The unique identifier of the resource.", + "type" : "string" + }, + "reference" : { + "description" : "The reference for the resource.", + "type" : "string" + } + }, + "type" : "object" + } + }, + "securitySchemes" : { + "BasicAuth" : { + "scheme" : "basic", + "type" : "http" + } + }, + "examples" : { + "post-balancePlatform.negativeBalanceCompensationWarning.scheduled-balancePlatform.negativeBalanceCompensationWarning.scheduled" : { + "summary" : "Negative balance compensation scheduled", + "description" : "Example webhook sent as warning when a negative balance compensation is scheduled.", + "value" : { + "data" : { + "balancePlatform" : "YOUR_BALANCE_PLATFORM", + "creationDate" : "2024-10-22T00:00:00+02:00", + "id" : "BA00000000000000000001", + "accountHolder" : { + "description" : "Description for the account holder.", + "reference" : "YOUR_REFERENCE", + "id" : "AH00000000000000000001" + }, + "amount" : { + "currency" : "EUR", + "value" : -145050 + }, + "liableBalanceAccountId" : "BA11111111111111111111", + "negativeBalanceSince" : "2024-10-19T00:33:13+02:00", + "scheduledCompensationAt" : "2024-12-01T01:00:00+01:00" + }, + "environment" : "test", + "type" : "balancePlatform.negativeBalanceCompensationWarning.scheduled" + } + } + } + } +} \ No newline at end of file diff --git a/json/BalancePlatformService-v2.json b/json/BalancePlatformService-v2.json index cf3ac63f..72159d78 100644 --- a/json/BalancePlatformService-v2.json +++ b/json/BalancePlatformService-v2.json @@ -5666,7 +5666,7 @@ "description" : "Deletes an SCA device from the list of registered devices of a specific payment instrument.", "x-addedInVersion" : "1", "operationId" : "delete-registeredDevices-id", - "x-sortIndex" : 4, + "x-sortIndex" : 6, "x-methodName" : "deleteRegistrationOfScaDevice", "security" : [ { @@ -8659,6 +8659,11 @@ "readOnly" : true, "type" : "string" }, + "reasonDetail" : { + "description" : "The human readable reason for disabling the sweep.", + "readOnly" : true, + "type" : "string" + }, "reference" : { "description" : "Your reference for the sweep configuration.", "maxLength" : 80, @@ -10755,6 +10760,11 @@ "readOnly" : true, "type" : "string" }, + "reasonDetail" : { + "description" : "The human readable reason for disabling the sweep.", + "readOnly" : true, + "type" : "string" + }, "reference" : { "description" : "Your reference for the sweep configuration.", "maxLength" : 80, @@ -11701,6 +11711,11 @@ "readOnly" : true, "type" : "string" }, + "reasonDetail" : { + "description" : "The human readable reason for disabling the sweep.", + "readOnly" : true, + "type" : "string" + }, "reference" : { "description" : "Your reference for the sweep configuration.", "maxLength" : 80, diff --git a/yaml/BalancePlatformConfigurationNotification-v1.yaml b/yaml/BalancePlatformConfigurationNotification-v1.yaml index e9388eeb..377c0967 100644 --- a/yaml/BalancePlatformConfigurationNotification-v1.yaml +++ b/yaml/BalancePlatformConfigurationNotification-v1.yaml @@ -1697,6 +1697,9 @@ components: - transferInstrumentDoesNotExist - unknown type: string + reasonDetail: + description: The human readable reason for disabling the sweep. + type: string reference: description: Your reference for the sweep configuration. maxLength: 80 diff --git a/yaml/BalancePlatformConfigurationNotification-v2.yaml b/yaml/BalancePlatformConfigurationNotification-v2.yaml index 1a6fb749..3f0b0da7 100644 --- a/yaml/BalancePlatformConfigurationNotification-v2.yaml +++ b/yaml/BalancePlatformConfigurationNotification-v2.yaml @@ -1791,6 +1791,9 @@ components: - transferInstrumentDoesNotExist - unknown type: string + reasonDetail: + description: The human readable reason for disabling the sweep. + type: string reference: description: Your reference for the sweep configuration. maxLength: 80 diff --git a/yaml/BalancePlatformNegativeBalanceCompensationWarningNotification-v1.yaml b/yaml/BalancePlatformNegativeBalanceCompensationWarningNotification-v1.yaml new file mode 100644 index 00000000..b6f89b67 --- /dev/null +++ b/yaml/BalancePlatformNegativeBalanceCompensationWarningNotification-v1.yaml @@ -0,0 +1,175 @@ +openapi: 3.1.0 +info: + version: '1' + x-publicVersion: true + title: 'Negative balance compensation warning + + ' + description: Adyen sends webhooks to inform you about balance accounts whose balance + has been negative for 20 or more days. If you do not transfer funds to that balance + account to cover the negative balance before the scheduled compensation date, + a transfer is made from your liable balance account on that date. + termsOfService: https://www.adyen.com/legal/terms-and-conditions + contact: + name: Adyen Developer Experience team + url: https://github.com/Adyen/adyen-openapi +tags: +- name: General +- name: Balance account +webhooks: + balancePlatform.negativeBalanceCompensationWarning.scheduled: + post: + tags: + - General + summary: Negative balance compensation scheduled + description: Adyen sends this webhook to inform you about a balance account + whose balance has been negative for 20 or more days. If you do not transfer + funds to that balance account to cover the negative balance before the scheduled + compensation date, a transfer is made from your liable balance account on + that date. + operationId: post-balancePlatform.negativeBalanceCompensationWarning.scheduled + x-sortIndex: 0 + x-methodName: negativeBalanceCompensationScheduled + security: + - BasicAuth: [] + requestBody: + content: + application/json: + examples: + balancePlatform.negativeBalanceCompensationWarning.scheduled: + $ref: '#/components/examples/post-balancePlatform.negativeBalanceCompensationWarning.scheduled-balancePlatform.negativeBalanceCompensationWarning.scheduled' + schema: + $ref: '#/components/schemas/NegativeBalanceCompensationWarningNotificationRequest' + responses: + '200': + description: No Content - webhook events are accepted on the basis of the + HTTP status code. +components: + schemas: + Amount: + additionalProperties: false + properties: + currency: + description: The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes). + maxLength: 3 + minLength: 3 + type: string + value: + description: The amount of the transaction, in [minor units](https://docs.adyen.com/development-resources/currency-codes). + format: int64 + type: integer + required: + - value + - currency + type: object + NegativeBalanceCompensationWarningNotificationData: + additionalProperties: false + properties: + accountHolder: + description: The details of the account holder who owns the balance account + with a negative balance. + $ref: '#/components/schemas/ResourceReference' + amount: + description: The negative balance amount of the balance account. + $ref: '#/components/schemas/Amount' + balancePlatform: + description: The unique identifier of the balance platform. + type: string + creationDate: + description: The date and time when the event was triggered, in ISO 8601 + extended format. For example, **2020-12-18T10:15:30+01:00**. + format: date-time + type: string + id: + description: The ID of the resource. + type: string + liableBalanceAccountId: + description: The balance account ID of the account that will be used to + compensate the balance account whose balance is negative. + type: string + negativeBalanceSince: + description: The date the balance for the account became negative. + format: date-time + type: string + scheduledCompensationAt: + description: The date when a compensation transfer to the account is scheduled + to happen. + format: date-time + type: string + type: object + NegativeBalanceCompensationWarningNotificationRequest: + additionalProperties: false + properties: + data: + description: Contains event details. + $ref: '#/components/schemas/NegativeBalanceCompensationWarningNotificationData' + environment: + description: 'The environment from which the webhook originated. + + + Possible values: **test**, **live**.' + type: string + type: + description: Type of webhook. + enum: + - balancePlatform.negativeBalanceCompensationWarning.scheduled + type: string + required: + - environment + - type + - data + type: object + Resource: + additionalProperties: false + properties: + balancePlatform: + description: The unique identifier of the balance platform. + type: string + creationDate: + description: The date and time when the event was triggered, in ISO 8601 + extended format. For example, **2020-12-18T10:15:30+01:00**. + format: date-time + type: string + id: + description: The ID of the resource. + type: string + type: object + ResourceReference: + additionalProperties: false + properties: + description: + description: The description of the resource. + type: string + id: + description: The unique identifier of the resource. + type: string + reference: + description: The reference for the resource. + type: string + type: object + securitySchemes: + BasicAuth: + scheme: basic + type: http + examples: + ? post-balancePlatform.negativeBalanceCompensationWarning.scheduled-balancePlatform.negativeBalanceCompensationWarning.scheduled + : summary: Negative balance compensation scheduled + description: Example webhook sent as warning when a negative balance compensation + is scheduled. + value: + data: + balancePlatform: YOUR_BALANCE_PLATFORM + creationDate: '2024-10-22T00:00:00+02:00' + id: BA00000000000000000001 + accountHolder: + description: Description for the account holder. + reference: YOUR_REFERENCE + id: AH00000000000000000001 + amount: + currency: EUR + value: -145050 + liableBalanceAccountId: BA11111111111111111111 + negativeBalanceSince: '2024-10-19T00:33:13+02:00' + scheduledCompensationAt: '2024-12-01T01:00:00+01:00' + environment: test + type: balancePlatform.negativeBalanceCompensationWarning.scheduled diff --git a/yaml/BalancePlatformService-v2.yaml b/yaml/BalancePlatformService-v2.yaml index 627e4152..766d67fb 100644 --- a/yaml/BalancePlatformService-v2.yaml +++ b/yaml/BalancePlatformService-v2.yaml @@ -3479,7 +3479,7 @@ paths: specific payment instrument. x-addedInVersion: '1' operationId: delete-registeredDevices-id - x-sortIndex: 4 + x-sortIndex: 6 x-methodName: deleteRegistrationOfScaDevice security: - clientKey: [] @@ -6007,6 +6007,10 @@ components: - unknown readOnly: true type: string + reasonDetail: + description: The human readable reason for disabling the sweep. + readOnly: true + type: string reference: description: Your reference for the sweep configuration. maxLength: 80 @@ -7910,6 +7914,10 @@ components: - unknown readOnly: true type: string + reasonDetail: + description: The human readable reason for disabling the sweep. + readOnly: true + type: string reference: description: Your reference for the sweep configuration. maxLength: 80 @@ -9126,6 +9134,10 @@ components: - unknown readOnly: true type: string + reasonDetail: + description: The human readable reason for disabling the sweep. + readOnly: true + type: string reference: description: Your reference for the sweep configuration. maxLength: 80