diff --git a/json/BalancePlatformAcsNotification-v1.json b/json/BalancePlatformAcsNotification-v1.json index 6ad8c39..1ca22fe 100644 --- a/json/BalancePlatformAcsNotification-v1.json +++ b/json/BalancePlatformAcsNotification-v1.json @@ -14,6 +14,9 @@ "tags" : [ { "name" : "General" + }, + { + "name" : "Out-of-band" } ], "webhooks" : { @@ -78,6 +81,96 @@ } } } + }, + "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" : { @@ -103,6 +196,23 @@ ], "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" : { @@ -397,6 +507,30 @@ ], "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" : { @@ -420,6 +554,42 @@ ], "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" : { @@ -438,6 +608,33 @@ } }, "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 8058ef9..91f1319 100644 --- a/json/BalancePlatformPaymentNotification-v1.json +++ b/json/BalancePlatformPaymentNotification-v1.json @@ -559,15 +559,15 @@ "type" : "string" }, "merchantId" : { - "description" : "The merchant identifier.", + "description" : "The unique identifier of the merchant.", "type" : "string" }, "nameLocation" : { - "description" : "Contains the merchant's name and location.", + "description" : "Contains the name and location of the merchant.", "$ref" : "#/components/schemas/NameLocation" }, "postalCode" : { - "description" : "The merchant postal code.", + "description" : "The postal code of the merchant.", "type" : "string" } }, @@ -958,6 +958,7 @@ "AdyenMarkup", "BalanceAccount", "Commission", + "DCCPlatformCommission", "Default", "Interchange", "PaymentFee", diff --git a/json/BalancePlatformTransactionNotification-v4.json b/json/BalancePlatformTransactionNotification-v4.json index 498deb7..2ebffb9 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* **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* **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.", "enum" : [ "AcquiringFees", "AdyenCommission", @@ -275,6 +275,7 @@ "AdyenMarkup", "BalanceAccount", "Commission", + "DCCPlatformCommission", "Default", "Interchange", "PaymentFee", diff --git a/json/BalancePlatformTransferNotification-v3.json b/json/BalancePlatformTransferNotification-v3.json index c2688b7..33abd2c 100644 --- a/json/BalancePlatformTransferNotification-v3.json +++ b/json/BalancePlatformTransferNotification-v3.json @@ -794,15 +794,15 @@ "type" : "string" }, "merchantId" : { - "description" : "The merchant identifier.", + "description" : "The unique identifier of the merchant.", "type" : "string" }, "nameLocation" : { - "description" : "Contains the merchant's name and location.", + "description" : "Contains the name and location of the merchant.", "$ref" : "#/components/schemas/NameLocation" }, "postalCode" : { - "description" : "The merchant postal code.", + "description" : "The postal code of the merchant.", "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* **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* **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.", "enum" : [ "AcquiringFees", "AdyenCommission", @@ -1462,6 +1462,7 @@ "AdyenMarkup", "BalanceAccount", "Commission", + "DCCPlatformCommission", "Default", "Interchange", "PaymentFee", @@ -1744,12 +1745,12 @@ "properties" : { "amount" : { "x-addedInVersion" : "3", - "description" : "The original journal amount.", + "description" : "The original journal amount. Only applicable for [issuing](https://docs.adyen.com/issuing/) integrations.", "$ref" : "#/components/schemas/Amount" }, "amountAdjustments" : { "x-addedInVersion" : "3", - "description" : "The amount adjustments in this transfer.", + "description" : "The amount adjustments in this transfer. Only applicable for [issuing](https://docs.adyen.com/issuing/) integrations.", "items" : { "$ref" : "#/components/schemas/AmountAdjustment" }, @@ -1779,7 +1780,7 @@ }, "modification" : { "x-addedInVersion" : "3", - "description" : "Payment modification.", + "description" : "The payment modification. Only applicable for [returned internal transfers](https://docs.adyen.com/platforms/internal-fund-transfers/internal-transfer-webhooks/#returned-internal-transfer).", "$ref" : "#/components/schemas/Modification" }, "mutations" : { @@ -1792,7 +1793,7 @@ }, "originalAmount" : { "x-addedInVersion" : "3", - "description" : "The amount in the original currency.", + "description" : "The amount in the original currency. Only applicable for [issuing](https://docs.adyen.com/issuing/) integrations. ", "$ref" : "#/components/schemas/Amount" }, "reason" : { @@ -1999,7 +2000,7 @@ "type" : "string" }, "merchantId" : { - "description" : "The merchant identifier.", + "description" : "The unique identifier of the merchant.", "type" : "string" }, "name" : { @@ -2007,7 +2008,7 @@ "type" : "string" }, "postalCode" : { - "description" : "The merchant postal code.", + "description" : "The postal code of the merchant.", "type" : "string" } }, diff --git a/json/BalancePlatformTransferNotification-v4.json b/json/BalancePlatformTransferNotification-v4.json index f910e5d..bdc6d65 100644 --- a/json/BalancePlatformTransferNotification-v4.json +++ b/json/BalancePlatformTransferNotification-v4.json @@ -988,6 +988,21 @@ }, "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" : { @@ -1000,15 +1015,15 @@ "type" : "string" }, "merchantId" : { - "description" : "The merchant identifier.", + "description" : "The unique identifier of the merchant.", "type" : "string" }, "nameLocation" : { - "description" : "Contains the merchant's name and location.", + "description" : "Contains the name and location of the merchant.", "$ref" : "#/components/schemas/NameLocation" }, "postalCode" : { - "description" : "The merchant postal code.", + "description" : "The postal code of the merchant.", "type" : "string" } }, @@ -1021,6 +1036,13 @@ "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", @@ -1356,7 +1378,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* **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* **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.", "enum" : [ "AcquiringFees", "AdyenCommission", @@ -1364,6 +1386,7 @@ "AdyenMarkup", "BalanceAccount", "Commission", + "DCCPlatformCommission", "Default", "Interchange", "PaymentFee", @@ -1915,12 +1938,12 @@ "properties" : { "amount" : { "x-addedInVersion" : "3", - "description" : "The original journal amount.", + "description" : "The original journal amount. Only applicable for [issuing](https://docs.adyen.com/issuing/) integrations.", "$ref" : "#/components/schemas/Amount" }, "amountAdjustments" : { "x-addedInVersion" : "3", - "description" : "The amount adjustments in this transfer.", + "description" : "The amount adjustments in this transfer. Only applicable for [issuing](https://docs.adyen.com/issuing/) integrations.", "items" : { "$ref" : "#/components/schemas/AmountAdjustment" }, @@ -1967,7 +1990,7 @@ }, "modification" : { "x-addedInVersion" : "3", - "description" : "Payment modification.", + "description" : "The payment modification. Only applicable for [returned internal transfers](https://docs.adyen.com/platforms/internal-fund-transfers/internal-transfer-webhooks/#returned-internal-transfer).", "$ref" : "#/components/schemas/Modification" }, "mutations" : { @@ -1980,7 +2003,7 @@ }, "originalAmount" : { "x-addedInVersion" : "3", - "description" : "The amount in the original currency.", + "description" : "The amount in the original currency. Only applicable for [issuing](https://docs.adyen.com/issuing/) integrations. ", "$ref" : "#/components/schemas/Amount" }, "reason" : { @@ -2177,7 +2200,7 @@ "type" : "string" }, "merchantId" : { - "description" : "The merchant identifier.", + "description" : "The unique identifier of the merchant.", "type" : "string" }, "name" : { @@ -2185,7 +2208,7 @@ "type" : "string" }, "postalCode" : { - "description" : "The merchant postal code.", + "description" : "The postal code of the merchant.", "type" : "string" } }, diff --git a/json/TransferService-v1.json b/json/TransferService-v1.json index c27740e..107f367 100644 --- a/json/TransferService-v1.json +++ b/json/TransferService-v1.json @@ -587,15 +587,15 @@ "type" : "string" }, "merchantId" : { - "description" : "The merchant identifier.", + "description" : "The unique identifier of the merchant.", "type" : "string" }, "nameLocation" : { - "description" : "Contains the merchant's name and location.", + "description" : "Contains the name and location of the merchant.", "$ref" : "#/components/schemas/NameLocation" }, "postalCode" : { - "description" : "The merchant postal code.", + "description" : "The postal code of the merchant.", "type" : "string" } }, diff --git a/json/TransferService-v2.json b/json/TransferService-v2.json index 93ddd49..9074dd2 100644 --- a/json/TransferService-v2.json +++ b/json/TransferService-v2.json @@ -626,15 +626,15 @@ "type" : "string" }, "merchantId" : { - "description" : "The merchant identifier.", + "description" : "The unique identifier of the merchant.", "type" : "string" }, "nameLocation" : { - "description" : "Contains the merchant's name and location.", + "description" : "Contains the name and location of the merchant.", "$ref" : "#/components/schemas/NameLocation" }, "postalCode" : { - "description" : "The merchant postal code.", + "description" : "The postal code of the merchant.", "type" : "string" } }, diff --git a/json/TransferService-v3.json b/json/TransferService-v3.json index 9c4ee86..765efe0 100644 --- a/json/TransferService-v3.json +++ b/json/TransferService-v3.json @@ -1494,11 +1494,14 @@ "$ref" : "#/components/schemas/Repayment" }, "status" : { - "description" : "The current status of the grant. Possible values: **Pending**, **Active**, **Repaid**.", + "description" : "The current status of the grant. Possible values: **Pending**, **Active**, **Repaid**, **WrittenOff**, **Failed**, **Revoked**.", "enum" : [ "Pending", "Active", - "Repaid" + "Repaid", + "Failed", + "WrittenOff", + "Revoked" ], "type" : "string" } @@ -1887,15 +1890,15 @@ "type" : "string" }, "merchantId" : { - "description" : "The merchant identifier.", + "description" : "The unique identifier of the merchant.", "type" : "string" }, "nameLocation" : { - "description" : "Contains the merchant's name and location.", + "description" : "Contains the name and location of the merchant.", "$ref" : "#/components/schemas/NameLocation" }, "postalCode" : { - "description" : "The merchant postal code.", + "description" : "The postal code of the merchant.", "type" : "string" } }, diff --git a/json/TransferService-v4.json b/json/TransferService-v4.json index 78b216d..0e2549a 100644 --- a/json/TransferService-v4.json +++ b/json/TransferService-v4.json @@ -1954,11 +1954,14 @@ "$ref" : "#/components/schemas/Repayment" }, "status" : { - "description" : "The current status of the grant. Possible values: **Pending**, **Active**, **Repaid**.", + "description" : "The current status of the grant. Possible values: **Pending**, **Active**, **Repaid**, **WrittenOff**, **Failed**, **Revoked**.", "enum" : [ "Pending", "Active", - "Repaid" + "Repaid", + "Failed", + "WrittenOff", + "Revoked" ], "type" : "string" } @@ -2576,6 +2579,21 @@ }, "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" : { @@ -2588,15 +2606,15 @@ "type" : "string" }, "merchantId" : { - "description" : "The merchant identifier.", + "description" : "The unique identifier of the merchant.", "type" : "string" }, "nameLocation" : { - "description" : "Contains the merchant's name and location.", + "description" : "Contains the name and location of the merchant.", "$ref" : "#/components/schemas/NameLocation" }, "postalCode" : { - "description" : "The merchant postal code.", + "description" : "The postal code of the merchant.", "type" : "string" } }, @@ -2609,6 +2627,13 @@ "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", @@ -2944,7 +2969,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* **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* **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.", "enum" : [ "AcquiringFees", "AdyenCommission", @@ -2952,6 +2977,7 @@ "AdyenMarkup", "BalanceAccount", "Commission", + "DCCPlatformCommission", "Default", "Interchange", "PaymentFee", @@ -4058,12 +4084,12 @@ "properties" : { "amount" : { "x-addedInVersion" : "3", - "description" : "The original journal amount.", + "description" : "The original journal amount. Only applicable for [issuing](https://docs.adyen.com/issuing/) integrations.", "$ref" : "#/components/schemas/Amount" }, "amountAdjustments" : { "x-addedInVersion" : "3", - "description" : "The amount adjustments in this transfer.", + "description" : "The amount adjustments in this transfer. Only applicable for [issuing](https://docs.adyen.com/issuing/) integrations.", "items" : { "$ref" : "#/components/schemas/AmountAdjustment" }, @@ -4110,7 +4136,7 @@ }, "modification" : { "x-addedInVersion" : "3", - "description" : "Payment modification.", + "description" : "The payment modification. Only applicable for [returned internal transfers](https://docs.adyen.com/platforms/internal-fund-transfers/internal-transfer-webhooks/#returned-internal-transfer).", "$ref" : "#/components/schemas/Modification" }, "mutations" : { @@ -4123,7 +4149,7 @@ }, "originalAmount" : { "x-addedInVersion" : "3", - "description" : "The amount in the original currency.", + "description" : "The amount in the original currency. Only applicable for [issuing](https://docs.adyen.com/issuing/) integrations. ", "$ref" : "#/components/schemas/Amount" }, "reason" : { @@ -4428,7 +4454,7 @@ "type" : "string" }, "merchantId" : { - "description" : "The merchant identifier.", + "description" : "The unique identifier of the merchant.", "type" : "string" }, "name" : { @@ -4436,7 +4462,7 @@ "type" : "string" }, "postalCode" : { - "description" : "The merchant postal code.", + "description" : "The postal code of the merchant.", "type" : "string" } }, diff --git a/yaml/BalancePlatformAcsNotification-v1.yaml b/yaml/BalancePlatformAcsNotification-v1.yaml index 5631fa2..4aabd83 100644 --- a/yaml/BalancePlatformAcsNotification-v1.yaml +++ b/yaml/BalancePlatformAcsNotification-v1.yaml @@ -11,6 +11,7 @@ info: url: https://github.com/Adyen/adyen-openapi tags: - name: General +- name: Out-of-band webhooks: balancePlatform.authentication.created: post: @@ -51,6 +52,69 @@ 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: @@ -69,6 +133,20 @@ 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: @@ -419,6 +497,24 @@ 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: @@ -436,6 +532,33 @@ 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: @@ -451,6 +574,26 @@ 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 2266efe..edbd610 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 merchant identifier. + description: The unique identifier of the merchant. type: string nameLocation: - description: Contains the merchant's name and location. + description: Contains the name and location of the merchant. $ref: '#/components/schemas/NameLocation' postalCode: - description: The merchant postal code. + description: The postal code of the merchant. type: string type: object Name: @@ -861,6 +861,7 @@ components: - AdyenMarkup - BalanceAccount - Commission + - DCCPlatformCommission - Default - Interchange - PaymentFee diff --git a/yaml/BalancePlatformTransactionNotification-v4.yaml b/yaml/BalancePlatformTransactionNotification-v4.yaml index 1052e85..ece9423 100644 --- a/yaml/BalancePlatformTransactionNotification-v4.yaml +++ b/yaml/BalancePlatformTransactionNotification-v4.yaml @@ -281,6 +281,10 @@ 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. @@ -312,6 +316,7 @@ components: - AdyenMarkup - BalanceAccount - Commission + - DCCPlatformCommission - Default - Interchange - PaymentFee diff --git a/yaml/BalancePlatformTransferNotification-v3.yaml b/yaml/BalancePlatformTransferNotification-v3.yaml index e20a221..1f15388 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 merchant identifier. + description: The unique identifier of the merchant. type: string nameLocation: - description: Contains the merchant's name and location. + description: Contains the name and location of the merchant. $ref: '#/components/schemas/NameLocation' postalCode: - description: The merchant postal code. + description: The postal code of the merchant. type: string type: object Modification: @@ -1302,6 +1302,10 @@ 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. @@ -1333,6 +1337,7 @@ components: - AdyenMarkup - BalanceAccount - Commission + - DCCPlatformCommission - Default - Interchange - PaymentFee @@ -1632,11 +1637,13 @@ components: properties: amount: x-addedInVersion: '3' - description: The original journal amount. + description: The original journal amount. Only applicable for [issuing](https://docs.adyen.com/issuing/) + integrations. $ref: '#/components/schemas/Amount' amountAdjustments: x-addedInVersion: '3' - description: The amount adjustments in this transfer. + description: The amount adjustments in this transfer. Only applicable for + [issuing](https://docs.adyen.com/issuing/) integrations. items: $ref: '#/components/schemas/AmountAdjustment' type: array @@ -1661,7 +1668,8 @@ components: type: string modification: x-addedInVersion: '3' - description: Payment modification. + description: The payment modification. Only applicable for [returned internal + transfers](https://docs.adyen.com/platforms/internal-fund-transfers/internal-transfer-webhooks/#returned-internal-transfer). $ref: '#/components/schemas/Modification' mutations: x-addedInVersion: '3' @@ -1671,7 +1679,8 @@ components: type: array originalAmount: x-addedInVersion: '3' - description: The amount in the original currency. + description: 'The amount in the original currency. Only applicable for [issuing](https://docs.adyen.com/issuing/) + integrations. ' $ref: '#/components/schemas/Amount' reason: x-addedInVersion: '3' @@ -1849,13 +1858,13 @@ components: description: The merchant category code. type: string merchantId: - description: The merchant identifier. + description: The unique identifier of the merchant. type: string name: description: The name of the merchant's shop or service. type: string postalCode: - description: The merchant postal code. + description: The postal code of the merchant. type: string type: object TransferNotificationRequest: diff --git a/yaml/BalancePlatformTransferNotification-v4.yaml b/yaml/BalancePlatformTransferNotification-v4.yaml index e7a4184..bdfa44f 100644 --- a/yaml/BalancePlatformTransferNotification-v4.yaml +++ b/yaml/BalancePlatformTransferNotification-v4.yaml @@ -860,6 +860,17 @@ 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: @@ -870,13 +881,13 @@ components: description: The merchant category code. type: string merchantId: - description: The merchant identifier. + description: The unique identifier of the merchant. type: string nameLocation: - description: Contains the merchant's name and location. + description: Contains the name and location of the merchant. $ref: '#/components/schemas/NameLocation' postalCode: - description: The merchant postal code. + description: The postal code of the merchant. type: string type: object MerchantPurchaseData: @@ -885,6 +896,11 @@ 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**:\ @@ -1214,6 +1230,10 @@ 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. @@ -1245,6 +1265,7 @@ components: - AdyenMarkup - BalanceAccount - Commission + - DCCPlatformCommission - Default - Interchange - PaymentFee @@ -1736,11 +1757,13 @@ components: properties: amount: x-addedInVersion: '3' - description: The original journal amount. + description: The original journal amount. Only applicable for [issuing](https://docs.adyen.com/issuing/) + integrations. $ref: '#/components/schemas/Amount' amountAdjustments: x-addedInVersion: '3' - description: The amount adjustments in this transfer. + description: The amount adjustments in this transfer. Only applicable for + [issuing](https://docs.adyen.com/issuing/) integrations. items: $ref: '#/components/schemas/AmountAdjustment' type: array @@ -1777,7 +1800,8 @@ components: type: string modification: x-addedInVersion: '3' - description: Payment modification. + description: The payment modification. Only applicable for [returned internal + transfers](https://docs.adyen.com/platforms/internal-fund-transfers/internal-transfer-webhooks/#returned-internal-transfer). $ref: '#/components/schemas/Modification' mutations: x-addedInVersion: '3' @@ -1787,7 +1811,8 @@ components: type: array originalAmount: x-addedInVersion: '3' - description: The amount in the original currency. + description: 'The amount in the original currency. Only applicable for [issuing](https://docs.adyen.com/issuing/) + integrations. ' $ref: '#/components/schemas/Amount' reason: x-addedInVersion: '3' @@ -1957,13 +1982,13 @@ components: description: The merchant category code. type: string merchantId: - description: The merchant identifier. + description: The unique identifier of the merchant. type: string name: description: The name of the merchant's shop or service. type: string postalCode: - description: The merchant postal code. + description: The postal code of the merchant. type: string type: object TransferNotificationRequest: diff --git a/yaml/TransferService-v1.yaml b/yaml/TransferService-v1.yaml index f7979dd..adb5341 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 merchant identifier. + description: The unique identifier of the merchant. type: string nameLocation: - description: Contains the merchant's name and location. + description: Contains the name and location of the merchant. $ref: '#/components/schemas/NameLocation' postalCode: - description: The merchant postal code. + description: The postal code of the merchant. type: string type: object Name: diff --git a/yaml/TransferService-v2.yaml b/yaml/TransferService-v2.yaml index acf4d56..2b06dbd 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 merchant identifier. + description: The unique identifier of the merchant. type: string nameLocation: - description: Contains the merchant's name and location. + description: Contains the name and location of the merchant. $ref: '#/components/schemas/NameLocation' postalCode: - description: The merchant postal code. + description: The postal code of the merchant. type: string type: object Name: diff --git a/yaml/TransferService-v3.yaml b/yaml/TransferService-v3.yaml index b0b9562..41567e0 100644 --- a/yaml/TransferService-v3.yaml +++ b/yaml/TransferService-v3.yaml @@ -1099,11 +1099,14 @@ components: $ref: '#/components/schemas/Repayment' status: description: 'The current status of the grant. Possible values: **Pending**, - **Active**, **Repaid**.' + **Active**, **Repaid**, **WrittenOff**, **Failed**, **Revoked**.' enum: - Pending - Active - Repaid + - Failed + - WrittenOff + - Revoked type: string required: - grantAccountId @@ -1438,13 +1441,13 @@ components: description: The merchant category code. type: string merchantId: - description: The merchant identifier. + description: The unique identifier of the merchant. type: string nameLocation: - description: Contains the merchant's name and location. + description: Contains the name and location of the merchant. $ref: '#/components/schemas/NameLocation' postalCode: - description: The merchant postal code. + description: The postal code of the merchant. type: string type: object NOLocalAccountIdentification: diff --git a/yaml/TransferService-v4.yaml b/yaml/TransferService-v4.yaml index 36d59c3..3fda6e8 100644 --- a/yaml/TransferService-v4.yaml +++ b/yaml/TransferService-v4.yaml @@ -1485,11 +1485,14 @@ components: $ref: '#/components/schemas/Repayment' status: description: 'The current status of the grant. Possible values: **Pending**, - **Active**, **Repaid**.' + **Active**, **Repaid**, **WrittenOff**, **Failed**, **Revoked**.' enum: - Pending - Active - Repaid + - Failed + - WrittenOff + - Revoked type: string required: - grantAccountId @@ -2024,6 +2027,17 @@ 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: @@ -2034,13 +2048,13 @@ components: description: The merchant category code. type: string merchantId: - description: The merchant identifier. + description: The unique identifier of the merchant. type: string nameLocation: - description: Contains the merchant's name and location. + description: Contains the name and location of the merchant. $ref: '#/components/schemas/NameLocation' postalCode: - description: The merchant postal code. + description: The postal code of the merchant. type: string type: object MerchantPurchaseData: @@ -2049,6 +2063,11 @@ 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**:\ @@ -2378,6 +2397,10 @@ 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. @@ -2409,6 +2432,7 @@ components: - AdyenMarkup - BalanceAccount - Commission + - DCCPlatformCommission - Default - Interchange - PaymentFee @@ -3438,11 +3462,13 @@ components: properties: amount: x-addedInVersion: '3' - description: The original journal amount. + description: The original journal amount. Only applicable for [issuing](https://docs.adyen.com/issuing/) + integrations. $ref: '#/components/schemas/Amount' amountAdjustments: x-addedInVersion: '3' - description: The amount adjustments in this transfer. + description: The amount adjustments in this transfer. Only applicable for + [issuing](https://docs.adyen.com/issuing/) integrations. items: $ref: '#/components/schemas/AmountAdjustment' type: array @@ -3479,7 +3505,8 @@ components: type: string modification: x-addedInVersion: '3' - description: Payment modification. + description: The payment modification. Only applicable for [returned internal + transfers](https://docs.adyen.com/platforms/internal-fund-transfers/internal-transfer-webhooks/#returned-internal-transfer). $ref: '#/components/schemas/Modification' mutations: x-addedInVersion: '3' @@ -3489,7 +3516,8 @@ components: type: array originalAmount: x-addedInVersion: '3' - description: The amount in the original currency. + description: 'The amount in the original currency. Only applicable for [issuing](https://docs.adyen.com/issuing/) + integrations. ' $ref: '#/components/schemas/Amount' reason: x-addedInVersion: '3' @@ -3830,13 +3858,13 @@ components: description: The merchant category code. type: string merchantId: - description: The merchant identifier. + description: The unique identifier of the merchant. type: string name: description: The name of the merchant's shop or service. type: string postalCode: - description: The merchant postal code. + description: The postal code of the merchant. type: string type: object TransferNotificationValidationFact: