From 07c672eff109fb3c5b7dbe5082fe5d29ec440482 Mon Sep 17 00:00:00 2001 From: Adyen Automation Date: Tue, 4 Mar 2025 13:45:25 +0100 Subject: [PATCH] spec release --- json/BalancePlatformAcsNotification-v1.json | 197 ------------------ ...BalancePlatformPaymentNotification-v1.json | 7 +- ...ncePlatformTransactionNotification-v4.json | 3 +- ...alancePlatformTransferNotification-v3.json | 21 +- ...alancePlatformTransferNotification-v4.json | 43 +--- json/TransferService-v1.json | 6 +- json/TransferService-v2.json | 6 +- json/TransferService-v3.json | 13 +- json/TransferService-v4.json | 50 ++--- yaml/BalancePlatformAcsNotification-v1.yaml | 143 ------------- ...BalancePlatformPaymentNotification-v1.yaml | 7 +- ...ncePlatformTransactionNotification-v4.yaml | 5 - ...alancePlatformTransferNotification-v3.yaml | 27 +-- ...alancePlatformTransferNotification-v4.yaml | 43 +--- yaml/TransferService-v1.yaml | 6 +- yaml/TransferService-v2.yaml | 6 +- yaml/TransferService-v3.yaml | 11 +- yaml/TransferService-v4.yaml | 48 +---- 18 files changed, 88 insertions(+), 554 deletions(-) diff --git a/json/BalancePlatformAcsNotification-v1.json b/json/BalancePlatformAcsNotification-v1.json index 1ca22fe..6ad8c39 100644 --- a/json/BalancePlatformAcsNotification-v1.json +++ b/json/BalancePlatformAcsNotification-v1.json @@ -14,9 +14,6 @@ "tags" : [ { "name" : "General" - }, - { - "name" : "Out-of-band" } ], "webhooks" : { @@ -81,96 +78,6 @@ } } } - }, - "balancePlatform.authentication.relayed" : { - "post" : { - "tags" : [ - "Out-of-band" - ], - "summary" : "Out-of-band authentication requested", - "description" : "Adyen sends this webhook when a cardholder must perform [out-of-band authentication](https://docs.adyen.com/issuing/3d-secure/oob-auth-sdk/authenticate-cardholders).\n\nTo complete the authentication process, respond to this webhook with an **HTTP 200** response. Include the `authenticationDecision` in the response body.\n\nIf we do not receive the response within two seconds, the authentication process stops.", - "x-addedInVersion" : "1", - "operationId" : "post-balancePlatform.authentication.relayed", - "x-sortIndex" : 2, - "x-methodName" : "outofbandAuthenticationRequested", - "security" : [ - { - "BasicAuth" : [ - ] - } - ], - "requestBody" : { - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/RelayedAuthenticationRequest" - } - } - } - }, - "responses" : { - "200" : { - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/RelayedAuthenticationResponse" - } - } - }, - "description" : "OK - the request has succeeded." - }, - "400" : { - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ServiceError" - } - } - }, - "description" : "Bad Request - a problem reading or understanding the request." - }, - "401" : { - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ServiceError" - } - } - }, - "description" : "Unauthorized - authentication required." - }, - "403" : { - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ServiceError" - } - } - }, - "description" : "Forbidden - insufficient permissions to process the request." - }, - "422" : { - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ServiceError" - } - } - }, - "description" : "Unprocessable Entity - a request validation error." - }, - "500" : { - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ServiceError" - } - } - }, - "description" : "Internal Server Error - the server could not process the request." - } - } - } } }, "components" : { @@ -196,23 +103,6 @@ ], "type" : "object" }, - "AuthenticationDecision" : { - "additionalProperties" : false, - "properties" : { - "status" : { - "description" : "The status of the authentication. \n\nPossible values: \n\n* **refused** \n\n* **proceed** \n\nFor more information, refer to [Authenticate cardholders using the Authentication SDK](https://docs.adyen.com/issuing/3d-secure/oob-auth-sdk/authenticate-cardholders/).", - "enum" : [ - "proceed", - "refused" - ], - "type" : "string" - } - }, - "required" : [ - "status" - ], - "type" : "object" - }, "AuthenticationInfo" : { "additionalProperties" : false, "properties" : { @@ -507,30 +397,6 @@ ], "type" : "object" }, - "Purchase" : { - "additionalProperties" : false, - "properties" : { - "date" : { - "description" : "The time of the purchase.", - "format" : "date-time", - "type" : "string" - }, - "merchantName" : { - "description" : "The name of the merchant.", - "type" : "string" - }, - "originalAmount" : { - "description" : "The amount of the purchase in the original currency.", - "$ref" : "#/components/schemas/Amount" - } - }, - "required" : [ - "date", - "merchantName", - "originalAmount" - ], - "type" : "object" - }, "PurchaseInfo" : { "additionalProperties" : false, "properties" : { @@ -554,42 +420,6 @@ ], "type" : "object" }, - "RelayedAuthenticationRequest" : { - "additionalProperties" : false, - "properties" : { - "id" : { - "description" : "The unique identifier of the challenge.", - "type" : "string" - }, - "paymentInstrumentId" : { - "description" : "The unique identifier of the [payment instrument](https://docs.adyen.com/api-explorer/balanceplatform/latest/get/paymentInstruments/_id_) used for the purchase.", - "type" : "string" - }, - "purchase" : { - "description" : "The details of the purchase.", - "$ref" : "#/components/schemas/Purchase" - } - }, - "required" : [ - "id", - "purchase", - "paymentInstrumentId" - ], - "type" : "object" - }, - "RelayedAuthenticationResponse" : { - "additionalProperties" : false, - "properties" : { - "authenticationDecision" : { - "description" : "The decision regarding the authentication.", - "$ref" : "#/components/schemas/AuthenticationDecision" - } - }, - "required" : [ - "authenticationDecision" - ], - "type" : "object" - }, "Resource" : { "additionalProperties" : false, "properties" : { @@ -608,33 +438,6 @@ } }, "type" : "object" - }, - "ServiceError" : { - "additionalProperties" : false, - "properties" : { - "errorCode" : { - "description" : "The error code mapped to the error message.", - "type" : "string" - }, - "errorType" : { - "description" : "The category of the error.", - "type" : "string" - }, - "message" : { - "description" : "A short explanation of the issue.", - "type" : "string" - }, - "pspReference" : { - "description" : "The PSP reference of the payment.", - "type" : "string" - }, - "status" : { - "description" : "The HTTP response status.", - "format" : "int32", - "type" : "integer" - } - }, - "type" : "object" } }, "securitySchemes" : { diff --git a/json/BalancePlatformPaymentNotification-v1.json b/json/BalancePlatformPaymentNotification-v1.json index 91f1319..8058ef9 100644 --- a/json/BalancePlatformPaymentNotification-v1.json +++ b/json/BalancePlatformPaymentNotification-v1.json @@ -559,15 +559,15 @@ "type" : "string" }, "merchantId" : { - "description" : "The unique identifier of the merchant.", + "description" : "The merchant identifier.", "type" : "string" }, "nameLocation" : { - "description" : "Contains the name and location of the merchant.", + "description" : "Contains the merchant's name and location.", "$ref" : "#/components/schemas/NameLocation" }, "postalCode" : { - "description" : "The postal code of the merchant.", + "description" : "The merchant postal code.", "type" : "string" } }, @@ -958,7 +958,6 @@ "AdyenMarkup", "BalanceAccount", "Commission", - "DCCPlatformCommission", "Default", "Interchange", "PaymentFee", diff --git a/json/BalancePlatformTransactionNotification-v4.json b/json/BalancePlatformTransactionNotification-v4.json index 2ebffb9..498deb7 100644 --- a/json/BalancePlatformTransactionNotification-v4.json +++ b/json/BalancePlatformTransactionNotification-v4.json @@ -267,7 +267,7 @@ }, "platformPaymentType" : { "x-addedInVersion" : "4", - "description" : "Specifies the nature of the transfer. This parameter helps categorize transfers so you can reconcile transactions at a later time, using the Balance Platform Accounting Report for [marketplaces](https://docs.adyen.com/marketplaces/reports-and-fees/balance-platform-accounting-report/) or [platforms](https://docs.adyen.com/platforms/reports-and-fees/balance-platform-accounting-report/).\n\nPossible values:\n\n* **AcquiringFees**: for the acquiring fee incurred on a transaction.\n\n* **AdyenCommission**: for 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\n* **AdyenFees**: for all the transaction fees due to Adyen. This is the sum of Adyen's commission and Adyen's markup.\n\n* **AdyenMarkup**: for the transaction fee due to Adyen under [Interchange++ pricing](https://www.adyen.com/pricing).\n\n* **BalanceAccount**: or the sale amount of a transaction.\n\n* **Commission**: for your platform's commission on a transaction.\n\n* **DCCPlatformCommission**: for the DCC Commission for the platform on a transaction.\n\n* **Interchange**: for the interchange fee (fee paid to the issuer) incurred on a transaction.\n\n* **PaymentFee**: for all of the transaction fees.\n\n* **Remainder**: for the left over amount after currency conversion.\n\n* **SchemeFee**: for the scheme fee incurred on a transaction. This is the sum of the interchange fees and the acquiring fees.\n\n* **Surcharge**: for the surcharge paid by the customer on a transaction.\n\n* **Tip**: for the tip paid by the customer.\n\n* **TopUp**: for an incoming transfer to top up your user's balance account.\n\n* **VAT**: for the Value Added Tax.", + "description" : "Specifies the nature of the transfer. This parameter helps categorize transfers so you can reconcile transactions at a later time, using the Balance Platform Accounting Report for [marketplaces](https://docs.adyen.com/marketplaces/reports-and-fees/balance-platform-accounting-report/) or [platforms](https://docs.adyen.com/platforms/reports-and-fees/balance-platform-accounting-report/).\n\nPossible values:\n\n* **AcquiringFees**: for the acquiring fee incurred on a transaction.\n\n* **AdyenCommission**: for 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\n* **AdyenFees**: for all the transaction fees due to Adyen. This is the sum of Adyen's commission and Adyen's markup.\n\n* **AdyenMarkup**: for the transaction fee due to Adyen under [Interchange++ pricing](https://www.adyen.com/pricing).\n\n* **BalanceAccount**: or the sale amount of a transaction.\n\n* **Commission**: for your platform's commission on a transaction.\n\n* **Interchange**: for the interchange fee (fee paid to the issuer) incurred on a transaction.\n\n* **PaymentFee**: for all of the transaction fees.\n\n* **Remainder**: for the left over amount after currency conversion.\n\n* **SchemeFee**: for the scheme fee incurred on a transaction. This is the sum of the interchange fees and the acquiring fees.\n\n* **Surcharge**: for the surcharge paid by the customer on a transaction.\n\n* **Tip**: for the tip paid by the customer.\n\n* **TopUp**: for an incoming transfer to top up your user's balance account.\n\n* **VAT**: for the Value Added Tax.", "enum" : [ "AcquiringFees", "AdyenCommission", @@ -275,7 +275,6 @@ "AdyenMarkup", "BalanceAccount", "Commission", - "DCCPlatformCommission", "Default", "Interchange", "PaymentFee", diff --git a/json/BalancePlatformTransferNotification-v3.json b/json/BalancePlatformTransferNotification-v3.json index 33abd2c..c2688b7 100644 --- a/json/BalancePlatformTransferNotification-v3.json +++ b/json/BalancePlatformTransferNotification-v3.json @@ -794,15 +794,15 @@ "type" : "string" }, "merchantId" : { - "description" : "The unique identifier of the merchant.", + "description" : "The merchant identifier.", "type" : "string" }, "nameLocation" : { - "description" : "Contains the name and location of the merchant.", + "description" : "Contains the merchant's name and location.", "$ref" : "#/components/schemas/NameLocation" }, "postalCode" : { - "description" : "The postal code of the merchant.", + "description" : "The merchant postal code.", "type" : "string" } }, @@ -1454,7 +1454,7 @@ "deprecated" : true, "x-deprecatedInVersion" : "3", "x-deprecatedMessage" : "This property will be removed in version 4 and included in the `categoryData` object.", - "description" : "Specifies the nature of the transfer. This parameter helps categorize transfers so you can reconcile transactions at a later time, using the Balance Platform Accounting Report for [marketplaces](https://docs.adyen.com/marketplaces/reports-and-fees/balance-platform-accounting-report/) or [platforms](https://docs.adyen.com/platforms/reports-and-fees/balance-platform-accounting-report/).\n\nPossible values:\n\n* **AcquiringFees**: for the acquiring fee incurred on a transaction.\n\n* **AdyenCommission**: for 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\n* **AdyenFees**: for all the transaction fees due to Adyen. This is the sum of Adyen's commission and Adyen's markup.\n\n* **AdyenMarkup**: for the transaction fee due to Adyen under [Interchange++ pricing](https://www.adyen.com/pricing).\n\n* **BalanceAccount**: or the sale amount of a transaction.\n\n* **Commission**: for your platform's commission on a transaction.\n\n* **DCCPlatformCommission**: for the DCC Commission for the platform on a transaction.\n\n* **Interchange**: for the interchange fee (fee paid to the issuer) incurred on a transaction.\n\n* **PaymentFee**: for all of the transaction fees.\n\n* **Remainder**: for the left over amount after currency conversion.\n\n* **SchemeFee**: for the scheme fee incurred on a transaction. This is the sum of the interchange fees and the acquiring fees.\n\n* **Surcharge**: for the surcharge paid by the customer on a transaction.\n\n* **Tip**: for the tip paid by the customer.\n\n* **TopUp**: for an incoming transfer to top up your user's balance account.\n\n* **VAT**: for the Value Added Tax.", + "description" : "Specifies the nature of the transfer. This parameter helps categorize transfers so you can reconcile transactions at a later time, using the Balance Platform Accounting Report for [marketplaces](https://docs.adyen.com/marketplaces/reports-and-fees/balance-platform-accounting-report/) or [platforms](https://docs.adyen.com/platforms/reports-and-fees/balance-platform-accounting-report/).\n\nPossible values:\n\n* **AcquiringFees**: for the acquiring fee incurred on a transaction.\n\n* **AdyenCommission**: for 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\n* **AdyenFees**: for all the transaction fees due to Adyen. This is the sum of Adyen's commission and Adyen's markup.\n\n* **AdyenMarkup**: for the transaction fee due to Adyen under [Interchange++ pricing](https://www.adyen.com/pricing).\n\n* **BalanceAccount**: or the sale amount of a transaction.\n\n* **Commission**: for your platform's commission on a transaction.\n\n* **Interchange**: for the interchange fee (fee paid to the issuer) incurred on a transaction.\n\n* **PaymentFee**: for all of the transaction fees.\n\n* **Remainder**: for the left over amount after currency conversion.\n\n* **SchemeFee**: for the scheme fee incurred on a transaction. This is the sum of the interchange fees and the acquiring fees.\n\n* **Surcharge**: for the surcharge paid by the customer on a transaction.\n\n* **Tip**: for the tip paid by the customer.\n\n* **TopUp**: for an incoming transfer to top up your user's balance account.\n\n* **VAT**: for the Value Added Tax.", "enum" : [ "AcquiringFees", "AdyenCommission", @@ -1462,7 +1462,6 @@ "AdyenMarkup", "BalanceAccount", "Commission", - "DCCPlatformCommission", "Default", "Interchange", "PaymentFee", @@ -1745,12 +1744,12 @@ "properties" : { "amount" : { "x-addedInVersion" : "3", - "description" : "The original journal amount. Only applicable for [issuing](https://docs.adyen.com/issuing/) integrations.", + "description" : "The original journal amount.", "$ref" : "#/components/schemas/Amount" }, "amountAdjustments" : { "x-addedInVersion" : "3", - "description" : "The amount adjustments in this transfer. Only applicable for [issuing](https://docs.adyen.com/issuing/) integrations.", + "description" : "The amount adjustments in this transfer.", "items" : { "$ref" : "#/components/schemas/AmountAdjustment" }, @@ -1780,7 +1779,7 @@ }, "modification" : { "x-addedInVersion" : "3", - "description" : "The payment modification. Only applicable for [returned internal transfers](https://docs.adyen.com/platforms/internal-fund-transfers/internal-transfer-webhooks/#returned-internal-transfer).", + "description" : "Payment modification.", "$ref" : "#/components/schemas/Modification" }, "mutations" : { @@ -1793,7 +1792,7 @@ }, "originalAmount" : { "x-addedInVersion" : "3", - "description" : "The amount in the original currency. Only applicable for [issuing](https://docs.adyen.com/issuing/) integrations. ", + "description" : "The amount in the original currency.", "$ref" : "#/components/schemas/Amount" }, "reason" : { @@ -2000,7 +1999,7 @@ "type" : "string" }, "merchantId" : { - "description" : "The unique identifier of the merchant.", + "description" : "The merchant identifier.", "type" : "string" }, "name" : { @@ -2008,7 +2007,7 @@ "type" : "string" }, "postalCode" : { - "description" : "The postal code of the merchant.", + "description" : "The merchant postal code.", "type" : "string" } }, diff --git a/json/BalancePlatformTransferNotification-v4.json b/json/BalancePlatformTransferNotification-v4.json index bdc6d65..f910e5d 100644 --- a/json/BalancePlatformTransferNotification-v4.json +++ b/json/BalancePlatformTransferNotification-v4.json @@ -988,21 +988,6 @@ }, "type" : "object" }, - "Lodging" : { - "additionalProperties" : false, - "properties" : { - "checkInDate" : { - "description" : "The check-in date.", - "type" : "string" - }, - "numberOfNights" : { - "description" : "The total number of nights the room is booked for.", - "format" : "int32", - "type" : "integer" - } - }, - "type" : "object" - }, "MerchantData" : { "additionalProperties" : false, "properties" : { @@ -1015,15 +1000,15 @@ "type" : "string" }, "merchantId" : { - "description" : "The unique identifier of the merchant.", + "description" : "The merchant identifier.", "type" : "string" }, "nameLocation" : { - "description" : "Contains the name and location of the merchant.", + "description" : "Contains the merchant's name and location.", "$ref" : "#/components/schemas/NameLocation" }, "postalCode" : { - "description" : "The postal code of the merchant.", + "description" : "The merchant postal code.", "type" : "string" } }, @@ -1036,13 +1021,6 @@ "description" : "Airline information.", "$ref" : "#/components/schemas/Airline" }, - "lodging" : { - "description" : "Lodging information.", - "items" : { - "$ref" : "#/components/schemas/Lodging" - }, - "type" : "array" - }, "type" : { "default" : "merchantPurchaseData", "description" : "The type of events data. \n\nPossible values: \n\n - **merchantPurchaseData**: merchant purchase data", @@ -1378,7 +1356,7 @@ }, "platformPaymentType" : { "x-addedInVersion" : "4", - "description" : "Specifies the nature of the transfer. This parameter helps categorize transfers so you can reconcile transactions at a later time, using the Balance Platform Accounting Report for [marketplaces](https://docs.adyen.com/marketplaces/reports-and-fees/balance-platform-accounting-report/) or [platforms](https://docs.adyen.com/platforms/reports-and-fees/balance-platform-accounting-report/).\n\nPossible values:\n\n* **AcquiringFees**: for the acquiring fee incurred on a transaction.\n\n* **AdyenCommission**: for 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\n* **AdyenFees**: for all the transaction fees due to Adyen. This is the sum of Adyen's commission and Adyen's markup.\n\n* **AdyenMarkup**: for the transaction fee due to Adyen under [Interchange++ pricing](https://www.adyen.com/pricing).\n\n* **BalanceAccount**: or the sale amount of a transaction.\n\n* **Commission**: for your platform's commission on a transaction.\n\n* **DCCPlatformCommission**: for the DCC Commission for the platform on a transaction.\n\n* **Interchange**: for the interchange fee (fee paid to the issuer) incurred on a transaction.\n\n* **PaymentFee**: for all of the transaction fees.\n\n* **Remainder**: for the left over amount after currency conversion.\n\n* **SchemeFee**: for the scheme fee incurred on a transaction. This is the sum of the interchange fees and the acquiring fees.\n\n* **Surcharge**: for the surcharge paid by the customer on a transaction.\n\n* **Tip**: for the tip paid by the customer.\n\n* **TopUp**: for an incoming transfer to top up your user's balance account.\n\n* **VAT**: for the Value Added Tax.", + "description" : "Specifies the nature of the transfer. This parameter helps categorize transfers so you can reconcile transactions at a later time, using the Balance Platform Accounting Report for [marketplaces](https://docs.adyen.com/marketplaces/reports-and-fees/balance-platform-accounting-report/) or [platforms](https://docs.adyen.com/platforms/reports-and-fees/balance-platform-accounting-report/).\n\nPossible values:\n\n* **AcquiringFees**: for the acquiring fee incurred on a transaction.\n\n* **AdyenCommission**: for 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\n* **AdyenFees**: for all the transaction fees due to Adyen. This is the sum of Adyen's commission and Adyen's markup.\n\n* **AdyenMarkup**: for the transaction fee due to Adyen under [Interchange++ pricing](https://www.adyen.com/pricing).\n\n* **BalanceAccount**: or the sale amount of a transaction.\n\n* **Commission**: for your platform's commission on a transaction.\n\n* **Interchange**: for the interchange fee (fee paid to the issuer) incurred on a transaction.\n\n* **PaymentFee**: for all of the transaction fees.\n\n* **Remainder**: for the left over amount after currency conversion.\n\n* **SchemeFee**: for the scheme fee incurred on a transaction. This is the sum of the interchange fees and the acquiring fees.\n\n* **Surcharge**: for the surcharge paid by the customer on a transaction.\n\n* **Tip**: for the tip paid by the customer.\n\n* **TopUp**: for an incoming transfer to top up your user's balance account.\n\n* **VAT**: for the Value Added Tax.", "enum" : [ "AcquiringFees", "AdyenCommission", @@ -1386,7 +1364,6 @@ "AdyenMarkup", "BalanceAccount", "Commission", - "DCCPlatformCommission", "Default", "Interchange", "PaymentFee", @@ -1938,12 +1915,12 @@ "properties" : { "amount" : { "x-addedInVersion" : "3", - "description" : "The original journal amount. Only applicable for [issuing](https://docs.adyen.com/issuing/) integrations.", + "description" : "The original journal amount.", "$ref" : "#/components/schemas/Amount" }, "amountAdjustments" : { "x-addedInVersion" : "3", - "description" : "The amount adjustments in this transfer. Only applicable for [issuing](https://docs.adyen.com/issuing/) integrations.", + "description" : "The amount adjustments in this transfer.", "items" : { "$ref" : "#/components/schemas/AmountAdjustment" }, @@ -1990,7 +1967,7 @@ }, "modification" : { "x-addedInVersion" : "3", - "description" : "The payment modification. Only applicable for [returned internal transfers](https://docs.adyen.com/platforms/internal-fund-transfers/internal-transfer-webhooks/#returned-internal-transfer).", + "description" : "Payment modification.", "$ref" : "#/components/schemas/Modification" }, "mutations" : { @@ -2003,7 +1980,7 @@ }, "originalAmount" : { "x-addedInVersion" : "3", - "description" : "The amount in the original currency. Only applicable for [issuing](https://docs.adyen.com/issuing/) integrations. ", + "description" : "The amount in the original currency.", "$ref" : "#/components/schemas/Amount" }, "reason" : { @@ -2200,7 +2177,7 @@ "type" : "string" }, "merchantId" : { - "description" : "The unique identifier of the merchant.", + "description" : "The merchant identifier.", "type" : "string" }, "name" : { @@ -2208,7 +2185,7 @@ "type" : "string" }, "postalCode" : { - "description" : "The postal code of the merchant.", + "description" : "The merchant postal code.", "type" : "string" } }, diff --git a/json/TransferService-v1.json b/json/TransferService-v1.json index 107f367..c27740e 100644 --- a/json/TransferService-v1.json +++ b/json/TransferService-v1.json @@ -587,15 +587,15 @@ "type" : "string" }, "merchantId" : { - "description" : "The unique identifier of the merchant.", + "description" : "The merchant identifier.", "type" : "string" }, "nameLocation" : { - "description" : "Contains the name and location of the merchant.", + "description" : "Contains the merchant's name and location.", "$ref" : "#/components/schemas/NameLocation" }, "postalCode" : { - "description" : "The postal code of the merchant.", + "description" : "The merchant postal code.", "type" : "string" } }, diff --git a/json/TransferService-v2.json b/json/TransferService-v2.json index 9074dd2..93ddd49 100644 --- a/json/TransferService-v2.json +++ b/json/TransferService-v2.json @@ -626,15 +626,15 @@ "type" : "string" }, "merchantId" : { - "description" : "The unique identifier of the merchant.", + "description" : "The merchant identifier.", "type" : "string" }, "nameLocation" : { - "description" : "Contains the name and location of the merchant.", + "description" : "Contains the merchant's name and location.", "$ref" : "#/components/schemas/NameLocation" }, "postalCode" : { - "description" : "The postal code of the merchant.", + "description" : "The merchant postal code.", "type" : "string" } }, diff --git a/json/TransferService-v3.json b/json/TransferService-v3.json index 765efe0..9c4ee86 100644 --- a/json/TransferService-v3.json +++ b/json/TransferService-v3.json @@ -1494,14 +1494,11 @@ "$ref" : "#/components/schemas/Repayment" }, "status" : { - "description" : "The current status of the grant. Possible values: **Pending**, **Active**, **Repaid**, **WrittenOff**, **Failed**, **Revoked**.", + "description" : "The current status of the grant. Possible values: **Pending**, **Active**, **Repaid**.", "enum" : [ "Pending", "Active", - "Repaid", - "Failed", - "WrittenOff", - "Revoked" + "Repaid" ], "type" : "string" } @@ -1890,15 +1887,15 @@ "type" : "string" }, "merchantId" : { - "description" : "The unique identifier of the merchant.", + "description" : "The merchant identifier.", "type" : "string" }, "nameLocation" : { - "description" : "Contains the name and location of the merchant.", + "description" : "Contains the merchant's name and location.", "$ref" : "#/components/schemas/NameLocation" }, "postalCode" : { - "description" : "The postal code of the merchant.", + "description" : "The merchant postal code.", "type" : "string" } }, diff --git a/json/TransferService-v4.json b/json/TransferService-v4.json index 0e2549a..78b216d 100644 --- a/json/TransferService-v4.json +++ b/json/TransferService-v4.json @@ -1954,14 +1954,11 @@ "$ref" : "#/components/schemas/Repayment" }, "status" : { - "description" : "The current status of the grant. Possible values: **Pending**, **Active**, **Repaid**, **WrittenOff**, **Failed**, **Revoked**.", + "description" : "The current status of the grant. Possible values: **Pending**, **Active**, **Repaid**.", "enum" : [ "Pending", "Active", - "Repaid", - "Failed", - "WrittenOff", - "Revoked" + "Repaid" ], "type" : "string" } @@ -2579,21 +2576,6 @@ }, "type" : "object" }, - "Lodging" : { - "additionalProperties" : false, - "properties" : { - "checkInDate" : { - "description" : "The check-in date.", - "type" : "string" - }, - "numberOfNights" : { - "description" : "The total number of nights the room is booked for.", - "format" : "int32", - "type" : "integer" - } - }, - "type" : "object" - }, "MerchantData" : { "additionalProperties" : false, "properties" : { @@ -2606,15 +2588,15 @@ "type" : "string" }, "merchantId" : { - "description" : "The unique identifier of the merchant.", + "description" : "The merchant identifier.", "type" : "string" }, "nameLocation" : { - "description" : "Contains the name and location of the merchant.", + "description" : "Contains the merchant's name and location.", "$ref" : "#/components/schemas/NameLocation" }, "postalCode" : { - "description" : "The postal code of the merchant.", + "description" : "The merchant postal code.", "type" : "string" } }, @@ -2627,13 +2609,6 @@ "description" : "Airline information.", "$ref" : "#/components/schemas/Airline" }, - "lodging" : { - "description" : "Lodging information.", - "items" : { - "$ref" : "#/components/schemas/Lodging" - }, - "type" : "array" - }, "type" : { "default" : "merchantPurchaseData", "description" : "The type of events data. \n\nPossible values: \n\n - **merchantPurchaseData**: merchant purchase data", @@ -2969,7 +2944,7 @@ }, "platformPaymentType" : { "x-addedInVersion" : "4", - "description" : "Specifies the nature of the transfer. This parameter helps categorize transfers so you can reconcile transactions at a later time, using the Balance Platform Accounting Report for [marketplaces](https://docs.adyen.com/marketplaces/reports-and-fees/balance-platform-accounting-report/) or [platforms](https://docs.adyen.com/platforms/reports-and-fees/balance-platform-accounting-report/).\n\nPossible values:\n\n* **AcquiringFees**: for the acquiring fee incurred on a transaction.\n\n* **AdyenCommission**: for 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\n* **AdyenFees**: for all the transaction fees due to Adyen. This is the sum of Adyen's commission and Adyen's markup.\n\n* **AdyenMarkup**: for the transaction fee due to Adyen under [Interchange++ pricing](https://www.adyen.com/pricing).\n\n* **BalanceAccount**: or the sale amount of a transaction.\n\n* **Commission**: for your platform's commission on a transaction.\n\n* **DCCPlatformCommission**: for the DCC Commission for the platform on a transaction.\n\n* **Interchange**: for the interchange fee (fee paid to the issuer) incurred on a transaction.\n\n* **PaymentFee**: for all of the transaction fees.\n\n* **Remainder**: for the left over amount after currency conversion.\n\n* **SchemeFee**: for the scheme fee incurred on a transaction. This is the sum of the interchange fees and the acquiring fees.\n\n* **Surcharge**: for the surcharge paid by the customer on a transaction.\n\n* **Tip**: for the tip paid by the customer.\n\n* **TopUp**: for an incoming transfer to top up your user's balance account.\n\n* **VAT**: for the Value Added Tax.", + "description" : "Specifies the nature of the transfer. This parameter helps categorize transfers so you can reconcile transactions at a later time, using the Balance Platform Accounting Report for [marketplaces](https://docs.adyen.com/marketplaces/reports-and-fees/balance-platform-accounting-report/) or [platforms](https://docs.adyen.com/platforms/reports-and-fees/balance-platform-accounting-report/).\n\nPossible values:\n\n* **AcquiringFees**: for the acquiring fee incurred on a transaction.\n\n* **AdyenCommission**: for 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\n* **AdyenFees**: for all the transaction fees due to Adyen. This is the sum of Adyen's commission and Adyen's markup.\n\n* **AdyenMarkup**: for the transaction fee due to Adyen under [Interchange++ pricing](https://www.adyen.com/pricing).\n\n* **BalanceAccount**: or the sale amount of a transaction.\n\n* **Commission**: for your platform's commission on a transaction.\n\n* **Interchange**: for the interchange fee (fee paid to the issuer) incurred on a transaction.\n\n* **PaymentFee**: for all of the transaction fees.\n\n* **Remainder**: for the left over amount after currency conversion.\n\n* **SchemeFee**: for the scheme fee incurred on a transaction. This is the sum of the interchange fees and the acquiring fees.\n\n* **Surcharge**: for the surcharge paid by the customer on a transaction.\n\n* **Tip**: for the tip paid by the customer.\n\n* **TopUp**: for an incoming transfer to top up your user's balance account.\n\n* **VAT**: for the Value Added Tax.", "enum" : [ "AcquiringFees", "AdyenCommission", @@ -2977,7 +2952,6 @@ "AdyenMarkup", "BalanceAccount", "Commission", - "DCCPlatformCommission", "Default", "Interchange", "PaymentFee", @@ -4084,12 +4058,12 @@ "properties" : { "amount" : { "x-addedInVersion" : "3", - "description" : "The original journal amount. Only applicable for [issuing](https://docs.adyen.com/issuing/) integrations.", + "description" : "The original journal amount.", "$ref" : "#/components/schemas/Amount" }, "amountAdjustments" : { "x-addedInVersion" : "3", - "description" : "The amount adjustments in this transfer. Only applicable for [issuing](https://docs.adyen.com/issuing/) integrations.", + "description" : "The amount adjustments in this transfer.", "items" : { "$ref" : "#/components/schemas/AmountAdjustment" }, @@ -4136,7 +4110,7 @@ }, "modification" : { "x-addedInVersion" : "3", - "description" : "The payment modification. Only applicable for [returned internal transfers](https://docs.adyen.com/platforms/internal-fund-transfers/internal-transfer-webhooks/#returned-internal-transfer).", + "description" : "Payment modification.", "$ref" : "#/components/schemas/Modification" }, "mutations" : { @@ -4149,7 +4123,7 @@ }, "originalAmount" : { "x-addedInVersion" : "3", - "description" : "The amount in the original currency. Only applicable for [issuing](https://docs.adyen.com/issuing/) integrations. ", + "description" : "The amount in the original currency.", "$ref" : "#/components/schemas/Amount" }, "reason" : { @@ -4454,7 +4428,7 @@ "type" : "string" }, "merchantId" : { - "description" : "The unique identifier of the merchant.", + "description" : "The merchant identifier.", "type" : "string" }, "name" : { @@ -4462,7 +4436,7 @@ "type" : "string" }, "postalCode" : { - "description" : "The postal code of the merchant.", + "description" : "The merchant postal code.", "type" : "string" } }, diff --git a/yaml/BalancePlatformAcsNotification-v1.yaml b/yaml/BalancePlatformAcsNotification-v1.yaml index 4aabd83..5631fa2 100644 --- a/yaml/BalancePlatformAcsNotification-v1.yaml +++ b/yaml/BalancePlatformAcsNotification-v1.yaml @@ -11,7 +11,6 @@ info: url: https://github.com/Adyen/adyen-openapi tags: - name: General -- name: Out-of-band webhooks: balancePlatform.authentication.created: post: @@ -52,69 +51,6 @@ webhooks: schema: $ref: '#/components/schemas/BalancePlatformNotificationResponse' description: OK - the request has succeeded. - balancePlatform.authentication.relayed: - post: - tags: - - Out-of-band - summary: Out-of-band authentication requested - description: 'Adyen sends this webhook when a cardholder must perform [out-of-band - authentication](https://docs.adyen.com/issuing/3d-secure/oob-auth-sdk/authenticate-cardholders). - - - To complete the authentication process, respond to this webhook with an **HTTP - 200** response. Include the `authenticationDecision` in the response body. - - - If we do not receive the response within two seconds, the authentication process - stops.' - x-addedInVersion: '1' - operationId: post-balancePlatform.authentication.relayed - x-sortIndex: 2 - x-methodName: outofbandAuthenticationRequested - security: - - BasicAuth: [] - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/RelayedAuthenticationRequest' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/RelayedAuthenticationResponse' - description: OK - the request has succeeded. - '400': - content: - application/json: - schema: - $ref: '#/components/schemas/ServiceError' - description: Bad Request - a problem reading or understanding the request. - '401': - content: - application/json: - schema: - $ref: '#/components/schemas/ServiceError' - description: Unauthorized - authentication required. - '403': - content: - application/json: - schema: - $ref: '#/components/schemas/ServiceError' - description: Forbidden - insufficient permissions to process the request. - '422': - content: - application/json: - schema: - $ref: '#/components/schemas/ServiceError' - description: Unprocessable Entity - a request validation error. - '500': - content: - application/json: - schema: - $ref: '#/components/schemas/ServiceError' - description: Internal Server Error - the server could not process the request. components: schemas: Amount: @@ -133,20 +69,6 @@ components: - value - currency type: object - AuthenticationDecision: - additionalProperties: false - properties: - status: - description: "The status of the authentication. \n\nPossible values: \n\n\ - * **refused** \n\n* **proceed** \n\nFor more information, refer to [Authenticate\ - \ cardholders using the Authentication SDK](https://docs.adyen.com/issuing/3d-secure/oob-auth-sdk/authenticate-cardholders/)." - enum: - - proceed - - refused - type: string - required: - - status - type: object AuthenticationInfo: additionalProperties: false properties: @@ -497,24 +419,6 @@ components: - flow - lastInteraction type: object - Purchase: - additionalProperties: false - properties: - date: - description: The time of the purchase. - format: date-time - type: string - merchantName: - description: The name of the merchant. - type: string - originalAmount: - description: The amount of the purchase in the original currency. - $ref: '#/components/schemas/Amount' - required: - - date - - merchantName - - originalAmount - type: object PurchaseInfo: additionalProperties: false properties: @@ -532,33 +436,6 @@ components: - date - originalAmount type: object - RelayedAuthenticationRequest: - additionalProperties: false - properties: - id: - description: The unique identifier of the challenge. - type: string - paymentInstrumentId: - description: The unique identifier of the [payment instrument](https://docs.adyen.com/api-explorer/balanceplatform/latest/get/paymentInstruments/_id_) - used for the purchase. - type: string - purchase: - description: The details of the purchase. - $ref: '#/components/schemas/Purchase' - required: - - id - - purchase - - paymentInstrumentId - type: object - RelayedAuthenticationResponse: - additionalProperties: false - properties: - authenticationDecision: - description: The decision regarding the authentication. - $ref: '#/components/schemas/AuthenticationDecision' - required: - - authenticationDecision - type: object Resource: additionalProperties: false properties: @@ -574,26 +451,6 @@ components: description: The ID of the resource. type: string type: object - ServiceError: - additionalProperties: false - properties: - errorCode: - description: The error code mapped to the error message. - type: string - errorType: - description: The category of the error. - type: string - message: - description: A short explanation of the issue. - type: string - pspReference: - description: The PSP reference of the payment. - type: string - status: - description: The HTTP response status. - format: int32 - type: integer - type: object securitySchemes: BasicAuth: scheme: basic diff --git a/yaml/BalancePlatformPaymentNotification-v1.yaml b/yaml/BalancePlatformPaymentNotification-v1.yaml index edbd610..2266efe 100644 --- a/yaml/BalancePlatformPaymentNotification-v1.yaml +++ b/yaml/BalancePlatformPaymentNotification-v1.yaml @@ -474,13 +474,13 @@ components: description: The merchant category code. type: string merchantId: - description: The unique identifier of the merchant. + description: The merchant identifier. type: string nameLocation: - description: Contains the name and location of the merchant. + description: Contains the merchant's name and location. $ref: '#/components/schemas/NameLocation' postalCode: - description: The postal code of the merchant. + description: The merchant postal code. type: string type: object Name: @@ -861,7 +861,6 @@ components: - AdyenMarkup - BalanceAccount - Commission - - DCCPlatformCommission - Default - Interchange - PaymentFee diff --git a/yaml/BalancePlatformTransactionNotification-v4.yaml b/yaml/BalancePlatformTransactionNotification-v4.yaml index ece9423..1052e85 100644 --- a/yaml/BalancePlatformTransactionNotification-v4.yaml +++ b/yaml/BalancePlatformTransactionNotification-v4.yaml @@ -281,10 +281,6 @@ components: * **Commission**: for your platform''s commission on a transaction. - * **DCCPlatformCommission**: for the DCC Commission for the platform on - a transaction. - - * **Interchange**: for the interchange fee (fee paid to the issuer) incurred on a transaction. @@ -316,7 +312,6 @@ components: - AdyenMarkup - BalanceAccount - Commission - - DCCPlatformCommission - Default - Interchange - PaymentFee diff --git a/yaml/BalancePlatformTransferNotification-v3.yaml b/yaml/BalancePlatformTransferNotification-v3.yaml index 1f15388..e20a221 100644 --- a/yaml/BalancePlatformTransferNotification-v3.yaml +++ b/yaml/BalancePlatformTransferNotification-v3.yaml @@ -672,13 +672,13 @@ components: description: The merchant category code. type: string merchantId: - description: The unique identifier of the merchant. + description: The merchant identifier. type: string nameLocation: - description: Contains the name and location of the merchant. + description: Contains the merchant's name and location. $ref: '#/components/schemas/NameLocation' postalCode: - description: The postal code of the merchant. + description: The merchant postal code. type: string type: object Modification: @@ -1302,10 +1302,6 @@ components: * **Commission**: for your platform''s commission on a transaction. - * **DCCPlatformCommission**: for the DCC Commission for the platform on - a transaction. - - * **Interchange**: for the interchange fee (fee paid to the issuer) incurred on a transaction. @@ -1337,7 +1333,6 @@ components: - AdyenMarkup - BalanceAccount - Commission - - DCCPlatformCommission - Default - Interchange - PaymentFee @@ -1637,13 +1632,11 @@ components: properties: amount: x-addedInVersion: '3' - description: The original journal amount. Only applicable for [issuing](https://docs.adyen.com/issuing/) - integrations. + description: The original journal amount. $ref: '#/components/schemas/Amount' amountAdjustments: x-addedInVersion: '3' - description: The amount adjustments in this transfer. Only applicable for - [issuing](https://docs.adyen.com/issuing/) integrations. + description: The amount adjustments in this transfer. items: $ref: '#/components/schemas/AmountAdjustment' type: array @@ -1668,8 +1661,7 @@ components: type: string modification: x-addedInVersion: '3' - description: The payment modification. Only applicable for [returned internal - transfers](https://docs.adyen.com/platforms/internal-fund-transfers/internal-transfer-webhooks/#returned-internal-transfer). + description: Payment modification. $ref: '#/components/schemas/Modification' mutations: x-addedInVersion: '3' @@ -1679,8 +1671,7 @@ components: type: array originalAmount: x-addedInVersion: '3' - description: 'The amount in the original currency. Only applicable for [issuing](https://docs.adyen.com/issuing/) - integrations. ' + description: The amount in the original currency. $ref: '#/components/schemas/Amount' reason: x-addedInVersion: '3' @@ -1858,13 +1849,13 @@ components: description: The merchant category code. type: string merchantId: - description: The unique identifier of the merchant. + description: The merchant identifier. type: string name: description: The name of the merchant's shop or service. type: string postalCode: - description: The postal code of the merchant. + description: The merchant postal code. type: string type: object TransferNotificationRequest: diff --git a/yaml/BalancePlatformTransferNotification-v4.yaml b/yaml/BalancePlatformTransferNotification-v4.yaml index bdfa44f..e7a4184 100644 --- a/yaml/BalancePlatformTransferNotification-v4.yaml +++ b/yaml/BalancePlatformTransferNotification-v4.yaml @@ -860,17 +860,6 @@ components: description: The flight identifier. type: string type: object - Lodging: - additionalProperties: false - properties: - checkInDate: - description: The check-in date. - type: string - numberOfNights: - description: The total number of nights the room is booked for. - format: int32 - type: integer - type: object MerchantData: additionalProperties: false properties: @@ -881,13 +870,13 @@ components: description: The merchant category code. type: string merchantId: - description: The unique identifier of the merchant. + description: The merchant identifier. type: string nameLocation: - description: Contains the name and location of the merchant. + description: Contains the merchant's name and location. $ref: '#/components/schemas/NameLocation' postalCode: - description: The postal code of the merchant. + description: The merchant postal code. type: string type: object MerchantPurchaseData: @@ -896,11 +885,6 @@ components: airline: description: Airline information. $ref: '#/components/schemas/Airline' - lodging: - description: Lodging information. - items: - $ref: '#/components/schemas/Lodging' - type: array type: default: merchantPurchaseData description: "The type of events data. \n\nPossible values: \n\n - **merchantPurchaseData**:\ @@ -1230,10 +1214,6 @@ components: * **Commission**: for your platform''s commission on a transaction. - * **DCCPlatformCommission**: for the DCC Commission for the platform on - a transaction. - - * **Interchange**: for the interchange fee (fee paid to the issuer) incurred on a transaction. @@ -1265,7 +1245,6 @@ components: - AdyenMarkup - BalanceAccount - Commission - - DCCPlatformCommission - Default - Interchange - PaymentFee @@ -1757,13 +1736,11 @@ components: properties: amount: x-addedInVersion: '3' - description: The original journal amount. Only applicable for [issuing](https://docs.adyen.com/issuing/) - integrations. + description: The original journal amount. $ref: '#/components/schemas/Amount' amountAdjustments: x-addedInVersion: '3' - description: The amount adjustments in this transfer. Only applicable for - [issuing](https://docs.adyen.com/issuing/) integrations. + description: The amount adjustments in this transfer. items: $ref: '#/components/schemas/AmountAdjustment' type: array @@ -1800,8 +1777,7 @@ components: type: string modification: x-addedInVersion: '3' - description: The payment modification. Only applicable for [returned internal - transfers](https://docs.adyen.com/platforms/internal-fund-transfers/internal-transfer-webhooks/#returned-internal-transfer). + description: Payment modification. $ref: '#/components/schemas/Modification' mutations: x-addedInVersion: '3' @@ -1811,8 +1787,7 @@ components: type: array originalAmount: x-addedInVersion: '3' - description: 'The amount in the original currency. Only applicable for [issuing](https://docs.adyen.com/issuing/) - integrations. ' + description: The amount in the original currency. $ref: '#/components/schemas/Amount' reason: x-addedInVersion: '3' @@ -1982,13 +1957,13 @@ components: description: The merchant category code. type: string merchantId: - description: The unique identifier of the merchant. + description: The merchant identifier. type: string name: description: The name of the merchant's shop or service. type: string postalCode: - description: The postal code of the merchant. + description: The merchant postal code. type: string type: object TransferNotificationRequest: diff --git a/yaml/TransferService-v1.yaml b/yaml/TransferService-v1.yaml index adb5341..f7979dd 100644 --- a/yaml/TransferService-v1.yaml +++ b/yaml/TransferService-v1.yaml @@ -480,13 +480,13 @@ components: description: The merchant category code. type: string merchantId: - description: The unique identifier of the merchant. + description: The merchant identifier. type: string nameLocation: - description: Contains the name and location of the merchant. + description: Contains the merchant's name and location. $ref: '#/components/schemas/NameLocation' postalCode: - description: The postal code of the merchant. + description: The merchant postal code. type: string type: object Name: diff --git a/yaml/TransferService-v2.yaml b/yaml/TransferService-v2.yaml index 2b06dbd..acf4d56 100644 --- a/yaml/TransferService-v2.yaml +++ b/yaml/TransferService-v2.yaml @@ -551,13 +551,13 @@ components: description: The merchant category code. type: string merchantId: - description: The unique identifier of the merchant. + description: The merchant identifier. type: string nameLocation: - description: Contains the name and location of the merchant. + description: Contains the merchant's name and location. $ref: '#/components/schemas/NameLocation' postalCode: - description: The postal code of the merchant. + description: The merchant postal code. type: string type: object Name: diff --git a/yaml/TransferService-v3.yaml b/yaml/TransferService-v3.yaml index 41567e0..b0b9562 100644 --- a/yaml/TransferService-v3.yaml +++ b/yaml/TransferService-v3.yaml @@ -1099,14 +1099,11 @@ components: $ref: '#/components/schemas/Repayment' status: description: 'The current status of the grant. Possible values: **Pending**, - **Active**, **Repaid**, **WrittenOff**, **Failed**, **Revoked**.' + **Active**, **Repaid**.' enum: - Pending - Active - Repaid - - Failed - - WrittenOff - - Revoked type: string required: - grantAccountId @@ -1441,13 +1438,13 @@ components: description: The merchant category code. type: string merchantId: - description: The unique identifier of the merchant. + description: The merchant identifier. type: string nameLocation: - description: Contains the name and location of the merchant. + description: Contains the merchant's name and location. $ref: '#/components/schemas/NameLocation' postalCode: - description: The postal code of the merchant. + description: The merchant postal code. type: string type: object NOLocalAccountIdentification: diff --git a/yaml/TransferService-v4.yaml b/yaml/TransferService-v4.yaml index 3fda6e8..36d59c3 100644 --- a/yaml/TransferService-v4.yaml +++ b/yaml/TransferService-v4.yaml @@ -1485,14 +1485,11 @@ components: $ref: '#/components/schemas/Repayment' status: description: 'The current status of the grant. Possible values: **Pending**, - **Active**, **Repaid**, **WrittenOff**, **Failed**, **Revoked**.' + **Active**, **Repaid**.' enum: - Pending - Active - Repaid - - Failed - - WrittenOff - - Revoked type: string required: - grantAccountId @@ -2027,17 +2024,6 @@ components: description: Contains a link to the previous page. $ref: '#/components/schemas/Link' type: object - Lodging: - additionalProperties: false - properties: - checkInDate: - description: The check-in date. - type: string - numberOfNights: - description: The total number of nights the room is booked for. - format: int32 - type: integer - type: object MerchantData: additionalProperties: false properties: @@ -2048,13 +2034,13 @@ components: description: The merchant category code. type: string merchantId: - description: The unique identifier of the merchant. + description: The merchant identifier. type: string nameLocation: - description: Contains the name and location of the merchant. + description: Contains the merchant's name and location. $ref: '#/components/schemas/NameLocation' postalCode: - description: The postal code of the merchant. + description: The merchant postal code. type: string type: object MerchantPurchaseData: @@ -2063,11 +2049,6 @@ components: airline: description: Airline information. $ref: '#/components/schemas/Airline' - lodging: - description: Lodging information. - items: - $ref: '#/components/schemas/Lodging' - type: array type: default: merchantPurchaseData description: "The type of events data. \n\nPossible values: \n\n - **merchantPurchaseData**:\ @@ -2397,10 +2378,6 @@ components: * **Commission**: for your platform''s commission on a transaction. - * **DCCPlatformCommission**: for the DCC Commission for the platform on - a transaction. - - * **Interchange**: for the interchange fee (fee paid to the issuer) incurred on a transaction. @@ -2432,7 +2409,6 @@ components: - AdyenMarkup - BalanceAccount - Commission - - DCCPlatformCommission - Default - Interchange - PaymentFee @@ -3462,13 +3438,11 @@ components: properties: amount: x-addedInVersion: '3' - description: The original journal amount. Only applicable for [issuing](https://docs.adyen.com/issuing/) - integrations. + description: The original journal amount. $ref: '#/components/schemas/Amount' amountAdjustments: x-addedInVersion: '3' - description: The amount adjustments in this transfer. Only applicable for - [issuing](https://docs.adyen.com/issuing/) integrations. + description: The amount adjustments in this transfer. items: $ref: '#/components/schemas/AmountAdjustment' type: array @@ -3505,8 +3479,7 @@ components: type: string modification: x-addedInVersion: '3' - description: The payment modification. Only applicable for [returned internal - transfers](https://docs.adyen.com/platforms/internal-fund-transfers/internal-transfer-webhooks/#returned-internal-transfer). + description: Payment modification. $ref: '#/components/schemas/Modification' mutations: x-addedInVersion: '3' @@ -3516,8 +3489,7 @@ components: type: array originalAmount: x-addedInVersion: '3' - description: 'The amount in the original currency. Only applicable for [issuing](https://docs.adyen.com/issuing/) - integrations. ' + description: The amount in the original currency. $ref: '#/components/schemas/Amount' reason: x-addedInVersion: '3' @@ -3858,13 +3830,13 @@ components: description: The merchant category code. type: string merchantId: - description: The unique identifier of the merchant. + description: The merchant identifier. type: string name: description: The name of the merchant's shop or service. type: string postalCode: - description: The postal code of the merchant. + description: The merchant postal code. type: string type: object TransferNotificationValidationFact: