diff --git a/json/BalancePlatformAcsNotification-v1.json b/json/BalancePlatformAcsNotification-v1.json index b703646c..9368d249 100644 --- a/json/BalancePlatformAcsNotification-v1.json +++ b/json/BalancePlatformAcsNotification-v1.json @@ -86,13 +86,13 @@ "additionalProperties" : false, "properties" : { "currency" : { - "description" : "The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes).", + "description" : "The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes#currency-codes).", "maxLength" : 3, "minLength" : 3, "type" : "string" }, "value" : { - "description" : "The amount of the transaction, in [minor units](https://docs.adyen.com/development-resources/currency-codes).", + "description" : "The amount of the transaction, in [minor units](https://docs.adyen.com/development-resources/currency-codes#minor-units).", "format" : "int64", "type" : "integer" } @@ -315,6 +315,11 @@ "description" : "The environment from which the webhook originated.\n\nPossible values: **test**, **live**.", "type" : "string" }, + "timestamp" : { + "description" : "When the event was queued.", + "format" : "date-time", + "type" : "string" + }, "type" : { "description" : "Type of notification.", "enum" : [ diff --git a/json/BalancePlatformPaymentNotification-v1.json b/json/BalancePlatformPaymentNotification-v1.json index b31702f7..ee339f3c 100644 --- a/json/BalancePlatformPaymentNotification-v1.json +++ b/json/BalancePlatformPaymentNotification-v1.json @@ -370,13 +370,13 @@ "additionalProperties" : false, "properties" : { "currency" : { - "description" : "The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes).", + "description" : "The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes#currency-codes).", "maxLength" : 3, "minLength" : 3, "type" : "string" }, "value" : { - "description" : "The amount of the transaction, in [minor units](https://docs.adyen.com/development-resources/currency-codes).", + "description" : "The amount of the transaction, in [minor units](https://docs.adyen.com/development-resources/currency-codes#minor-units).", "format" : "int64", "type" : "integer" } @@ -526,6 +526,11 @@ "description" : "The environment from which the webhook originated.\n\nPossible values: **test**, **live**.", "type" : "string" }, + "timestamp" : { + "description" : "When the event was queued.", + "format" : "date-time", + "type" : "string" + }, "type" : { "description" : "Type of webhook.", "enum" : [ @@ -757,6 +762,11 @@ "description" : "The environment from which the webhook originated.\n\nPossible values: **test**, **live**.", "type" : "string" }, + "timestamp" : { + "description" : "When the event was queued.", + "format" : "date-time", + "type" : "string" + }, "type" : { "description" : "Type of webhook.", "enum" : [ @@ -887,6 +897,11 @@ "description" : "The environment from which the webhook originated.\n\nPossible values: **test**, **live**.", "type" : "string" }, + "timestamp" : { + "description" : "When the event was queued.", + "format" : "date-time", + "type" : "string" + }, "type" : { "description" : "Type of webhook.", "enum" : [ diff --git a/json/BalancePlatformTransactionNotification-v4.json b/json/BalancePlatformTransactionNotification-v4.json index 76766d65..745cd788 100644 --- a/json/BalancePlatformTransactionNotification-v4.json +++ b/json/BalancePlatformTransactionNotification-v4.json @@ -75,13 +75,13 @@ "additionalProperties" : false, "properties" : { "currency" : { - "description" : "The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes).", + "description" : "The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes#currency-codes).", "maxLength" : 3, "minLength" : 3, "type" : "string" }, "value" : { - "description" : "The amount of the transaction, in [minor units](https://docs.adyen.com/development-resources/currency-codes).", + "description" : "The amount of the transaction, in [minor units](https://docs.adyen.com/development-resources/currency-codes#minor-units).", "format" : "int64", "type" : "integer" } @@ -267,7 +267,7 @@ }, "platformPaymentType" : { "x-addedInVersion" : "4", - "description" : "The type of the related split.", + "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", @@ -457,6 +457,11 @@ "description" : "The environment from which the webhook originated.\n\nPossible values: **test**, **live**.", "type" : "string" }, + "timestamp" : { + "description" : "When the event was queued.", + "format" : "date-time", + "type" : "string" + }, "type" : { "description" : "Type of the webhook.", "enum" : [ diff --git a/json/BalancePlatformTransferNotification-v3.json b/json/BalancePlatformTransferNotification-v3.json index 73db4c36..3861e96b 100644 --- a/json/BalancePlatformTransferNotification-v3.json +++ b/json/BalancePlatformTransferNotification-v3.json @@ -188,13 +188,13 @@ "additionalProperties" : false, "properties" : { "currency" : { - "description" : "The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes).", + "description" : "The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes#currency-codes).", "maxLength" : 3, "minLength" : 3, "type" : "string" }, "value" : { - "description" : "The amount of the transaction, in [minor units](https://docs.adyen.com/development-resources/currency-codes).", + "description" : "The amount of the transaction, in [minor units](https://docs.adyen.com/development-resources/currency-codes#minor-units).", "format" : "int64", "type" : "integer" } @@ -1342,13 +1342,14 @@ }, "category" : { "x-addedInVersion" : "3", - "description" : "The category of the transfer.\n\nPossible values:\n\n - **bank**: a transfer involving a [transfer instrument](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/transferInstruments__resParam_id) or a bank account.\n\n- **card**: a transfer involving a third-party card.\n\n- **internal**: a transfer between [balance accounts](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/balanceAccounts__resParam_id) within your platform.\n\n- **issuedCard**: a transfer initiated by an Adyen-issued card.\n\n- **platformPayment**: funds movements related to payments that are acquired for your users.", + "description" : "The category of the transfer.\n\nPossible values:\n\n - **bank**: a transfer involving a [transfer instrument](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/transferInstruments__resParam_id) or a bank account.\n\n- **card**: a transfer involving a third-party card.\n\n- **internal**: a transfer between [balance accounts](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/balanceAccounts__resParam_id) within your platform.\n\n- **issuedCard**: a transfer initiated by a Adyen-issued card.\n\n- **platformPayment**: funds movements related to payments that are acquired for your users.\n\n- **topUp**: an incoming transfer initiated by your user to top up their balance account.", "enum" : [ "bank", "card", "internal", "issuedCard", - "platformPayment" + "platformPayment", + "topUp" ], "type" : "string" }, @@ -1453,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* **BalanceAccount**: for the sale amount of the transaction.\n* **Commission**: for your platform's commission on the transaction.\n* **PaymentFee**: for the transaction fees.\n* **Remainder**: for the left over amount after currency conversion.\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", @@ -2023,6 +2024,11 @@ "description" : "The environment from which the webhook originated.\n\nPossible values: **test**, **live**.", "type" : "string" }, + "timestamp" : { + "description" : "When the event was queued.", + "format" : "date-time", + "type" : "string" + }, "type" : { "description" : "The type of webhook.", "enum" : [ diff --git a/json/BalancePlatformTransferNotification-v4.json b/json/BalancePlatformTransferNotification-v4.json index 9db8c682..ebfa8c54 100644 --- a/json/BalancePlatformTransferNotification-v4.json +++ b/json/BalancePlatformTransferNotification-v4.json @@ -221,17 +221,34 @@ ], "type" : "object" }, + "Airline" : { + "additionalProperties" : false, + "properties" : { + "legs" : { + "description" : "Details about the flight legs for this ticket.", + "items" : { + "$ref" : "#/components/schemas/Leg" + }, + "type" : "array" + }, + "ticketNumber" : { + "description" : "The ticket's unique identifier", + "type" : "string" + } + }, + "type" : "object" + }, "Amount" : { "additionalProperties" : false, "properties" : { "currency" : { - "description" : "The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes).", + "description" : "The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes#currency-codes).", "maxLength" : 3, "minLength" : 3, "type" : "string" }, "value" : { - "description" : "The amount of the transaction, in [minor units](https://docs.adyen.com/development-resources/currency-codes).", + "description" : "The amount of the transaction, in [minor units](https://docs.adyen.com/development-resources/currency-codes#minor-units).", "format" : "int64", "type" : "integer" } @@ -941,6 +958,36 @@ }, "type" : "object" }, + "Leg" : { + "additionalProperties" : false, + "properties" : { + "arrivalAirportCode" : { + "description" : "The IATA 3-letter airport code of the destination airport. This field is required if the airline data includes leg details.", + "type" : "string" + }, + "basicFareCode" : { + "description" : "The basic fare code for this leg.", + "type" : "string" + }, + "carrierCode" : { + "description" : "IATA code of the carrier operating the flight.", + "type" : "string" + }, + "departureAirportCode" : { + "description" : "The IATA three-letter airport code of the departure airport. This field is required if the airline data includes leg details", + "type" : "string" + }, + "departureDate" : { + "description" : "The flight departure date.", + "type" : "string" + }, + "flightNumber" : { + "description" : "The flight identifier.", + "type" : "string" + } + }, + "type" : "object" + }, "MerchantData" : { "additionalProperties" : false, "properties" : { @@ -967,6 +1014,27 @@ }, "type" : "object" }, + "MerchantPurchaseData" : { + "additionalProperties" : false, + "properties" : { + "airline" : { + "description" : "Airline information.", + "$ref" : "#/components/schemas/Airline" + }, + "type" : { + "default" : "merchantPurchaseData", + "description" : "The type of events data. \n\nPossible values: \n\n - **merchantPurchaseData**: merchant purchase data", + "enum" : [ + "merchantPurchaseData" + ], + "type" : "string" + } + }, + "required" : [ + "type" + ], + "type" : "object" + }, "Modification" : { "additionalProperties" : false, "properties" : { @@ -1288,7 +1356,7 @@ }, "platformPaymentType" : { "x-addedInVersion" : "4", - "description" : "The type of the related split.", + "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", @@ -1562,13 +1630,14 @@ }, "category" : { "x-addedInVersion" : "3", - "description" : "The category of the transfer.\n\nPossible values:\n\n - **bank**: a transfer involving a [transfer instrument](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/transferInstruments__resParam_id) or a bank account.\n\n- **card**: a transfer involving a third-party card.\n\n- **internal**: a transfer between [balance accounts](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/balanceAccounts__resParam_id) within your platform.\n\n- **issuedCard**: a transfer initiated by an Adyen-issued card.\n\n- **platformPayment**: funds movements related to payments that are acquired for your users.", + "description" : "The category of the transfer.\n\nPossible values:\n\n - **bank**: a transfer involving a [transfer instrument](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/transferInstruments__resParam_id) or a bank account.\n\n- **card**: a transfer involving a third-party card.\n\n- **internal**: a transfer between [balance accounts](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/balanceAccounts__resParam_id) within your platform.\n\n- **issuedCard**: a transfer initiated by a Adyen-issued card.\n\n- **platformPayment**: funds movements related to payments that are acquired for your users.\n\n- **topUp**: an incoming transfer initiated by your user to top up their balance account.", "enum" : [ "bank", "card", "internal", "issuedCard", - "platformPayment" + "platformPayment", + "topUp" ], "type" : "string" }, @@ -1620,6 +1689,11 @@ ], "type" : "string" }, + "eventId" : { + "x-addedInVersion" : "4", + "description" : "The event id listed under events, that triggered the notification.", + "type" : "string" + }, "events" : { "x-addedInVersion" : "3", "description" : "The list of events leading up to the current status of the transfer.", @@ -1869,6 +1943,18 @@ "format" : "date-time", "type" : "string" }, + "eventsData" : { + "x-addedInVersion" : "4", + "description" : "A list of event data.", + "items" : { + "oneOf" : [ + { + "$ref" : "#/components/schemas/MerchantPurchaseData" + } + ] + }, + "type" : "array" + }, "externalReason" : { "x-addedInVersion" : "3", "description" : "The external reason for the transfer status.", @@ -2116,6 +2202,11 @@ "description" : "The environment from which the webhook originated.\n\nPossible values: **test**, **live**.", "type" : "string" }, + "timestamp" : { + "description" : "When the event was queued.", + "format" : "date-time", + "type" : "string" + }, "type" : { "description" : "The type of webhook.", "enum" : [ diff --git a/json/TransferService-v1.json b/json/TransferService-v1.json index 474582ea..2cf242c0 100644 --- a/json/TransferService-v1.json +++ b/json/TransferService-v1.json @@ -454,13 +454,13 @@ "additionalProperties" : false, "properties" : { "currency" : { - "description" : "The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes).", + "description" : "The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes#currency-codes).", "maxLength" : 3, "minLength" : 3, "type" : "string" }, "value" : { - "description" : "The amount of the transaction, in [minor units](https://docs.adyen.com/development-resources/currency-codes).", + "description" : "The amount of the transaction, in [minor units](https://docs.adyen.com/development-resources/currency-codes#minor-units).", "format" : "int64", "type" : "integer" } diff --git a/json/TransferService-v2.json b/json/TransferService-v2.json index e02a1a4e..03ac6a12 100644 --- a/json/TransferService-v2.json +++ b/json/TransferService-v2.json @@ -470,13 +470,13 @@ "additionalProperties" : false, "properties" : { "currency" : { - "description" : "The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes).", + "description" : "The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes#currency-codes).", "maxLength" : 3, "minLength" : 3, "type" : "string" }, "value" : { - "description" : "The amount of the transaction, in [minor units](https://docs.adyen.com/development-resources/currency-codes).", + "description" : "The amount of the transaction, in [minor units](https://docs.adyen.com/development-resources/currency-codes#minor-units).", "format" : "int64", "type" : "integer" } diff --git a/json/TransferService-v3.json b/json/TransferService-v3.json index 7a92c556..64610ad6 100644 --- a/json/TransferService-v3.json +++ b/json/TransferService-v3.json @@ -1195,13 +1195,13 @@ "additionalProperties" : false, "properties" : { "currency" : { - "description" : "The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes).", + "description" : "The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes#currency-codes).", "maxLength" : 3, "minLength" : 3, "type" : "string" }, "value" : { - "description" : "The amount of the transaction, in [minor units](https://docs.adyen.com/development-resources/currency-codes).", + "description" : "The amount of the transaction, in [minor units](https://docs.adyen.com/development-resources/currency-codes#minor-units).", "format" : "int64", "type" : "integer" } @@ -2616,13 +2616,14 @@ }, "category" : { "x-addedInVersion" : "3", - "description" : "The category of the transfer.\n\nPossible values:\n\n - **bank**: a transfer involving a [transfer instrument](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/transferInstruments__resParam_id) or a bank account.\n\n- **card**: a transfer involving a third-party card.\n\n- **internal**: a transfer between [balance accounts](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/balanceAccounts__resParam_id) within your platform.\n\n- **issuedCard**: a transfer initiated by an Adyen-issued card.\n\n- **platformPayment**: funds movements related to payments that are acquired for your users.", + "description" : "The category of the transfer.\n\nPossible values:\n\n - **bank**: a transfer involving a [transfer instrument](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/transferInstruments__resParam_id) or a bank account.\n\n- **card**: a transfer involving a third-party card.\n\n- **internal**: a transfer between [balance accounts](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/balanceAccounts__resParam_id) within your platform.\n\n- **issuedCard**: a transfer initiated by a Adyen-issued card.\n\n- **platformPayment**: funds movements related to payments that are acquired for your users.\n\n- **topUp**: an incoming transfer initiated by your user to top up their balance account.", "enum" : [ "bank", "card", "internal", "issuedCard", - "platformPayment" + "platformPayment", + "topUp" ], "type" : "string" }, @@ -2874,13 +2875,14 @@ }, "category" : { "x-addedInVersion" : "3", - "description" : "The category of the transfer.\n\nPossible values:\n\n - **bank**: a transfer involving a [transfer instrument](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/transferInstruments__resParam_id) or a bank account.\n\n- **card**: a transfer involving a third-party card.\n\n- **internal**: a transfer between [balance accounts](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/balanceAccounts__resParam_id) within your platform.\n\n- **issuedCard**: a transfer initiated by a Adyen-issued card.\n\n- **platformPayment**: funds movements related to payments that are acquired for your users.", + "description" : "The category of the transfer.\n\nPossible values:\n\n - **bank**: a transfer involving a [transfer instrument](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/transferInstruments__resParam_id) or a bank account.\n\n- **card**: a transfer involving a third-party card.\n\n- **internal**: a transfer between [balance accounts](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/balanceAccounts__resParam_id) within your platform.\n\n- **issuedCard**: a transfer initiated by a Adyen-issued card.\n\n- **platformPayment**: funds movements related to payments that are acquired for your users.\n\n- **topUp**: an incoming transfer initiated by your user to top up their balance account.", "enum" : [ "bank", "card", "internal", "issuedCard", - "platformPayment" + "platformPayment", + "topUp" ], "type" : "string" }, diff --git a/json/TransferService-v4.json b/json/TransferService-v4.json index 0ce73a29..2268dae3 100644 --- a/json/TransferService-v4.json +++ b/json/TransferService-v4.json @@ -1513,17 +1513,34 @@ ], "type" : "object" }, + "Airline" : { + "additionalProperties" : false, + "properties" : { + "legs" : { + "description" : "Details about the flight legs for this ticket.", + "items" : { + "$ref" : "#/components/schemas/Leg" + }, + "type" : "array" + }, + "ticketNumber" : { + "description" : "The ticket's unique identifier", + "type" : "string" + } + }, + "type" : "object" + }, "Amount" : { "additionalProperties" : false, "properties" : { "currency" : { - "description" : "The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes).", + "description" : "The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes#currency-codes).", "maxLength" : 3, "minLength" : 3, "type" : "string" }, "value" : { - "description" : "The amount of the transaction, in [minor units](https://docs.adyen.com/development-resources/currency-codes).", + "description" : "The amount of the transaction, in [minor units](https://docs.adyen.com/development-resources/currency-codes#minor-units).", "format" : "int64", "type" : "integer" } @@ -2468,6 +2485,36 @@ "JSONObject" : { "type" : "object" }, + "Leg" : { + "additionalProperties" : false, + "properties" : { + "arrivalAirportCode" : { + "description" : "The IATA 3-letter airport code of the destination airport. This field is required if the airline data includes leg details.", + "type" : "string" + }, + "basicFareCode" : { + "description" : "The basic fare code for this leg.", + "type" : "string" + }, + "carrierCode" : { + "description" : "IATA code of the carrier operating the flight.", + "type" : "string" + }, + "departureAirportCode" : { + "description" : "The IATA three-letter airport code of the departure airport. This field is required if the airline data includes leg details", + "type" : "string" + }, + "departureDate" : { + "description" : "The flight departure date.", + "type" : "string" + }, + "flightNumber" : { + "description" : "The flight identifier.", + "type" : "string" + } + }, + "type" : "object" + }, "Link" : { "additionalProperties" : false, "properties" : { @@ -2518,6 +2565,27 @@ }, "type" : "object" }, + "MerchantPurchaseData" : { + "additionalProperties" : false, + "properties" : { + "airline" : { + "description" : "Airline information.", + "$ref" : "#/components/schemas/Airline" + }, + "type" : { + "default" : "merchantPurchaseData", + "description" : "The type of events data. \n\nPossible values: \n\n - **merchantPurchaseData**: merchant purchase data", + "enum" : [ + "merchantPurchaseData" + ], + "type" : "string" + } + }, + "required" : [ + "type" + ], + "type" : "object" + }, "Modification" : { "additionalProperties" : false, "properties" : { @@ -2839,7 +2907,7 @@ }, "platformPaymentType" : { "x-addedInVersion" : "4", - "description" : "The type of the related split.", + "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", @@ -3394,13 +3462,14 @@ }, "category" : { "x-addedInVersion" : "3", - "description" : "The category of the transfer.\n\nPossible values:\n\n - **bank**: a transfer involving a [transfer instrument](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/transferInstruments__resParam_id) or a bank account.\n\n- **card**: a transfer involving a third-party card.\n\n- **internal**: a transfer between [balance accounts](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/balanceAccounts__resParam_id) within your platform.\n\n- **issuedCard**: a transfer initiated by an Adyen-issued card.\n\n- **platformPayment**: funds movements related to payments that are acquired for your users.", + "description" : "The category of the transfer.\n\nPossible values:\n\n - **bank**: a transfer involving a [transfer instrument](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/transferInstruments__resParam_id) or a bank account.\n\n- **card**: a transfer involving a third-party card.\n\n- **internal**: a transfer between [balance accounts](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/balanceAccounts__resParam_id) within your platform.\n\n- **issuedCard**: a transfer initiated by a Adyen-issued card.\n\n- **platformPayment**: funds movements related to payments that are acquired for your users.\n\n- **topUp**: an incoming transfer initiated by your user to top up their balance account.", "enum" : [ "bank", "card", "internal", "issuedCard", - "platformPayment" + "platformPayment", + "topUp" ], "type" : "string" }, @@ -3667,13 +3736,14 @@ }, "category" : { "x-addedInVersion" : "3", - "description" : "The category of the transfer.\n\nPossible values:\n\n - **bank**: a transfer involving a [transfer instrument](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/transferInstruments__resParam_id) or a bank account.\n\n- **card**: a transfer involving a third-party card.\n\n- **internal**: a transfer between [balance accounts](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/balanceAccounts__resParam_id) within your platform.\n\n- **issuedCard**: a transfer initiated by an Adyen-issued card.\n\n- **platformPayment**: funds movements related to payments that are acquired for your users.", + "description" : "The category of the transfer.\n\nPossible values:\n\n - **bank**: a transfer involving a [transfer instrument](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/transferInstruments__resParam_id) or a bank account.\n\n- **card**: a transfer involving a third-party card.\n\n- **internal**: a transfer between [balance accounts](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/balanceAccounts__resParam_id) within your platform.\n\n- **issuedCard**: a transfer initiated by a Adyen-issued card.\n\n- **platformPayment**: funds movements related to payments that are acquired for your users.\n\n- **topUp**: an incoming transfer initiated by your user to top up their balance account.", "enum" : [ "bank", "card", "internal", "issuedCard", - "platformPayment" + "platformPayment", + "topUp" ], "type" : "string" }, @@ -3725,6 +3795,11 @@ ], "type" : "string" }, + "eventId" : { + "x-addedInVersion" : "4", + "description" : "The event id listed under events, that triggered the notification.", + "type" : "string" + }, "events" : { "x-addedInVersion" : "3", "description" : "The list of events leading up to the current status of the transfer.", @@ -3974,6 +4049,18 @@ "format" : "date-time", "type" : "string" }, + "eventsData" : { + "x-addedInVersion" : "4", + "description" : "A list of event data.", + "items" : { + "oneOf" : [ + { + "$ref" : "#/components/schemas/MerchantPurchaseData" + } + ] + }, + "type" : "array" + }, "externalReason" : { "x-addedInVersion" : "3", "description" : "The external reason for the transfer status.", @@ -4164,13 +4251,14 @@ }, "category" : { "x-addedInVersion" : "3", - "description" : "The category of the transfer.\n\nPossible values:\n\n - **bank**: a transfer involving a [transfer instrument](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/transferInstruments__resParam_id) or a bank account.\n\n- **card**: a transfer involving a third-party card.\n\n- **internal**: a transfer between [balance accounts](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/balanceAccounts__resParam_id) within your platform.\n\n- **issuedCard**: a transfer initiated by a Adyen-issued card.\n\n- **platformPayment**: funds movements related to payments that are acquired for your users.", + "description" : "The category of the transfer.\n\nPossible values:\n\n - **bank**: a transfer involving a [transfer instrument](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/transferInstruments__resParam_id) or a bank account.\n\n- **card**: a transfer involving a third-party card.\n\n- **internal**: a transfer between [balance accounts](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/balanceAccounts__resParam_id) within your platform.\n\n- **issuedCard**: a transfer initiated by a Adyen-issued card.\n\n- **platformPayment**: funds movements related to payments that are acquired for your users.\n\n- **topUp**: an incoming transfer initiated by your user to top up their balance account.", "enum" : [ "bank", "card", "internal", "issuedCard", - "platformPayment" + "platformPayment", + "topUp" ], "type" : "string" }, diff --git a/yaml/BalancePlatformAcsNotification-v1.yaml b/yaml/BalancePlatformAcsNotification-v1.yaml index 53ddc7fb..0208e840 100644 --- a/yaml/BalancePlatformAcsNotification-v1.yaml +++ b/yaml/BalancePlatformAcsNotification-v1.yaml @@ -57,12 +57,12 @@ components: additionalProperties: false properties: currency: - description: The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes). + description: The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes#currency-codes). maxLength: 3 minLength: 3 type: string value: - description: The amount of the transaction, in [minor units](https://docs.adyen.com/development-resources/currency-codes). + description: The amount of the transaction, in [minor units](https://docs.adyen.com/development-resources/currency-codes#minor-units). format: int64 type: integer required: @@ -343,6 +343,10 @@ components: Possible values: **test**, **live**.' type: string + timestamp: + description: When the event was queued. + format: date-time + type: string type: description: Type of notification. enum: diff --git a/yaml/BalancePlatformPaymentNotification-v1.yaml b/yaml/BalancePlatformPaymentNotification-v1.yaml index e37ae227..ebd1ad76 100644 --- a/yaml/BalancePlatformPaymentNotification-v1.yaml +++ b/yaml/BalancePlatformPaymentNotification-v1.yaml @@ -305,12 +305,12 @@ components: additionalProperties: false properties: currency: - description: The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes). + description: The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes#currency-codes). maxLength: 3 minLength: 3 type: string value: - description: The amount of the transaction, in [minor units](https://docs.adyen.com/development-resources/currency-codes). + description: The amount of the transaction, in [minor units](https://docs.adyen.com/development-resources/currency-codes#minor-units). format: int64 type: integer required: @@ -449,6 +449,10 @@ components: Possible values: **test**, **live**.' type: string + timestamp: + description: When the event was queued. + format: date-time + type: string type: description: Type of webhook. enum: @@ -673,6 +677,10 @@ components: Possible values: **test**, **live**.' type: string + timestamp: + description: When the event was queued. + format: date-time + type: string type: description: Type of webhook. enum: @@ -805,6 +813,10 @@ components: Possible values: **test**, **live**.' type: string + timestamp: + description: When the event was queued. + format: date-time + type: string type: description: Type of webhook. enum: diff --git a/yaml/BalancePlatformTransactionNotification-v4.yaml b/yaml/BalancePlatformTransactionNotification-v4.yaml index 13f256a6..93ee6946 100644 --- a/yaml/BalancePlatformTransactionNotification-v4.yaml +++ b/yaml/BalancePlatformTransactionNotification-v4.yaml @@ -60,12 +60,12 @@ components: additionalProperties: false properties: currency: - description: The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes). + description: The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes#currency-codes). maxLength: 3 minLength: 3 type: string value: - description: The amount of the transaction, in [minor units](https://docs.adyen.com/development-resources/currency-codes). + description: The amount of the transaction, in [minor units](https://docs.adyen.com/development-resources/currency-codes#minor-units). format: int64 type: integer required: @@ -251,7 +251,60 @@ components: type: string platformPaymentType: x-addedInVersion: '4' - description: The type of the related split. + 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/). + + + Possible values: + + + * **AcquiringFees**: for the acquiring fee incurred on a transaction. + + + * **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). + + + * **AdyenFees**: for all the transaction fees due to Adyen. This is the + sum of Adyen''s commission and Adyen''s markup. + + + * **AdyenMarkup**: for the transaction fee due to Adyen under [Interchange++ + pricing](https://www.adyen.com/pricing). + + + * **BalanceAccount**: or the sale amount of a transaction. + + + * **Commission**: for your platform''s commission on a transaction. + + + * **Interchange**: for the interchange fee (fee paid to the issuer) incurred + on a transaction. + + + * **PaymentFee**: for all of the transaction fees. + + + * **Remainder**: for the left over amount after currency conversion. + + + * **SchemeFee**: for the scheme fee incurred on a transaction. This is + the sum of the interchange fees and the acquiring fees. + + + * **Surcharge**: for the surcharge paid by the customer on a transaction. + + + * **Tip**: for the tip paid by the customer. + + + * **TopUp**: for an incoming transfer to top up your user''s balance account. + + + * **VAT**: for the Value Added Tax.' enum: - AcquiringFees - AdyenCommission @@ -415,6 +468,10 @@ components: Possible values: **test**, **live**.' type: string + timestamp: + description: When the event was queued. + format: date-time + type: string type: description: Type of the webhook. enum: diff --git a/yaml/BalancePlatformTransferNotification-v3.yaml b/yaml/BalancePlatformTransferNotification-v3.yaml index d897316e..962fc7c1 100644 --- a/yaml/BalancePlatformTransferNotification-v3.yaml +++ b/yaml/BalancePlatformTransferNotification-v3.yaml @@ -162,12 +162,12 @@ components: additionalProperties: false properties: currency: - description: The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes). + description: The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes#currency-codes). maxLength: 3 minLength: 3 type: string value: - description: The amount of the transaction, in [minor units](https://docs.adyen.com/development-resources/currency-codes). + description: The amount of the transaction, in [minor units](https://docs.adyen.com/development-resources/currency-codes#minor-units). format: int64 type: integer required: @@ -1148,15 +1148,17 @@ components: \ a transfer involving a [transfer instrument](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/transferInstruments__resParam_id)\ \ or a bank account.\n\n- **card**: a transfer involving a third-party\ \ card.\n\n- **internal**: a transfer between [balance accounts](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/balanceAccounts__resParam_id)\ - \ within your platform.\n\n- **issuedCard**: a transfer initiated by an\ + \ within your platform.\n\n- **issuedCard**: a transfer initiated by a\ \ Adyen-issued card.\n\n- **platformPayment**: funds movements related\ - \ to payments that are acquired for your users." + \ to payments that are acquired for your users.\n\n- **topUp**: an incoming\ + \ transfer initiated by your user to top up their balance account." enum: - bank - card - internal - issuedCard - platformPayment + - topUp type: string counterparty: x-addedInVersion: '3' @@ -1279,14 +1281,50 @@ components: Possible values: - * **BalanceAccount**: for the sale amount of the transaction. + * **AcquiringFees**: for the acquiring fee incurred on a transaction. + + + * **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). + + + * **AdyenFees**: for all the transaction fees due to Adyen. This is the + sum of Adyen''s commission and Adyen''s markup. + + + * **AdyenMarkup**: for the transaction fee due to Adyen under [Interchange++ + pricing](https://www.adyen.com/pricing). + + + * **BalanceAccount**: or the sale amount of a transaction. + + + * **Commission**: for your platform''s commission on a transaction. + + + * **Interchange**: for the interchange fee (fee paid to the issuer) incurred + on a transaction. - * **Commission**: for your platform''s commission on the transaction. - * **PaymentFee**: for the transaction fees. + * **PaymentFee**: for all of the transaction fees. + * **Remainder**: for the left over amount after currency conversion. + + * **SchemeFee**: for the scheme fee incurred on a transaction. This is + the sum of the interchange fees and the acquiring fees. + + + * **Surcharge**: for the surcharge paid by the customer on a transaction. + + + * **Tip**: for the tip paid by the customer. + + + * **TopUp**: for an incoming transfer to top up your user''s balance account. + + * **VAT**: for the Value Added Tax.' enum: - AcquiringFees @@ -1832,6 +1870,10 @@ components: Possible values: **test**, **live**.' type: string + timestamp: + description: When the event was queued. + format: date-time + type: string type: description: The type of webhook. enum: diff --git a/yaml/BalancePlatformTransferNotification-v4.yaml b/yaml/BalancePlatformTransferNotification-v4.yaml index b2082bfd..eab5a3b7 100644 --- a/yaml/BalancePlatformTransferNotification-v4.yaml +++ b/yaml/BalancePlatformTransferNotification-v4.yaml @@ -182,16 +182,28 @@ components: required: - country type: object + Airline: + additionalProperties: false + properties: + legs: + description: Details about the flight legs for this ticket. + items: + $ref: '#/components/schemas/Leg' + type: array + ticketNumber: + description: The ticket's unique identifier + type: string + type: object Amount: additionalProperties: false properties: currency: - description: The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes). + description: The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes#currency-codes). maxLength: 3 minLength: 3 type: string value: - description: The amount of the transaction, in [minor units](https://docs.adyen.com/development-resources/currency-codes). + description: The amount of the transaction, in [minor units](https://docs.adyen.com/development-resources/currency-codes#minor-units). format: int64 type: integer required: @@ -824,6 +836,30 @@ components: $ref: '#/components/schemas/TransferNotificationValidationFact' type: array type: object + Leg: + additionalProperties: false + properties: + arrivalAirportCode: + description: The IATA 3-letter airport code of the destination airport. + This field is required if the airline data includes leg details. + type: string + basicFareCode: + description: The basic fare code for this leg. + type: string + carrierCode: + description: IATA code of the carrier operating the flight. + type: string + departureAirportCode: + description: The IATA three-letter airport code of the departure airport. + This field is required if the airline data includes leg details + type: string + departureDate: + description: The flight departure date. + type: string + flightNumber: + description: The flight identifier. + type: string + type: object MerchantData: additionalProperties: false properties: @@ -843,6 +879,22 @@ components: description: The merchant postal code. type: string type: object + MerchantPurchaseData: + additionalProperties: false + properties: + airline: + description: Airline information. + $ref: '#/components/schemas/Airline' + type: + default: merchantPurchaseData + description: "The type of events data. \n\nPossible values: \n\n - **merchantPurchaseData**:\ + \ merchant purchase data" + enum: + - merchantPurchaseData + type: string + required: + - type + type: object Modification: additionalProperties: false properties: @@ -1132,7 +1184,60 @@ components: type: string platformPaymentType: x-addedInVersion: '4' - description: The type of the related split. + 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/). + + + Possible values: + + + * **AcquiringFees**: for the acquiring fee incurred on a transaction. + + + * **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). + + + * **AdyenFees**: for all the transaction fees due to Adyen. This is the + sum of Adyen''s commission and Adyen''s markup. + + + * **AdyenMarkup**: for the transaction fee due to Adyen under [Interchange++ + pricing](https://www.adyen.com/pricing). + + + * **BalanceAccount**: or the sale amount of a transaction. + + + * **Commission**: for your platform''s commission on a transaction. + + + * **Interchange**: for the interchange fee (fee paid to the issuer) incurred + on a transaction. + + + * **PaymentFee**: for all of the transaction fees. + + + * **Remainder**: for the left over amount after currency conversion. + + + * **SchemeFee**: for the scheme fee incurred on a transaction. This is + the sum of the interchange fees and the acquiring fees. + + + * **Surcharge**: for the surcharge paid by the customer on a transaction. + + + * **Tip**: for the tip paid by the customer. + + + * **TopUp**: for an incoming transfer to top up your user''s balance account. + + + * **VAT**: for the Value Added Tax.' enum: - AcquiringFees - AdyenCommission @@ -1359,15 +1464,17 @@ components: \ a transfer involving a [transfer instrument](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/transferInstruments__resParam_id)\ \ or a bank account.\n\n- **card**: a transfer involving a third-party\ \ card.\n\n- **internal**: a transfer between [balance accounts](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/balanceAccounts__resParam_id)\ - \ within your platform.\n\n- **issuedCard**: a transfer initiated by an\ + \ within your platform.\n\n- **issuedCard**: a transfer initiated by a\ \ Adyen-issued card.\n\n- **platformPayment**: funds movements related\ - \ to payments that are acquired for your users." + \ to payments that are acquired for your users.\n\n- **topUp**: an incoming\ + \ transfer initiated by your user to top up their balance account." enum: - bank - card - internal - issuedCard - platformPayment + - topUp type: string categoryData: x-addedInVersion: '4' @@ -1414,6 +1521,10 @@ components: - incoming - outgoing type: string + eventId: + x-addedInVersion: '4' + description: The event id listed under events, that triggered the notification. + type: string events: x-addedInVersion: '3' description: The list of events leading up to the current status of the @@ -1649,6 +1760,13 @@ components: to the funds. format: date-time type: string + eventsData: + x-addedInVersion: '4' + description: A list of event data. + items: + oneOf: + - $ref: '#/components/schemas/MerchantPurchaseData' + type: array externalReason: x-addedInVersion: '3' description: The external reason for the transfer status. @@ -1860,6 +1978,10 @@ components: Possible values: **test**, **live**.' type: string + timestamp: + description: When the event was queued. + format: date-time + type: string type: description: The type of webhook. enum: diff --git a/yaml/TransferService-v1.yaml b/yaml/TransferService-v1.yaml index e228f722..5ca9f7fe 100644 --- a/yaml/TransferService-v1.yaml +++ b/yaml/TransferService-v1.yaml @@ -382,12 +382,12 @@ components: additionalProperties: false properties: currency: - description: The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes). + description: The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes#currency-codes). maxLength: 3 minLength: 3 type: string value: - description: The amount of the transaction, in [minor units](https://docs.adyen.com/development-resources/currency-codes). + description: The amount of the transaction, in [minor units](https://docs.adyen.com/development-resources/currency-codes#minor-units). format: int64 type: integer required: diff --git a/yaml/TransferService-v2.yaml b/yaml/TransferService-v2.yaml index d422e3f0..2c164759 100644 --- a/yaml/TransferService-v2.yaml +++ b/yaml/TransferService-v2.yaml @@ -408,12 +408,12 @@ components: additionalProperties: false properties: currency: - description: The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes). + description: The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes#currency-codes). maxLength: 3 minLength: 3 type: string value: - description: The amount of the transaction, in [minor units](https://docs.adyen.com/development-resources/currency-codes). + description: The amount of the transaction, in [minor units](https://docs.adyen.com/development-resources/currency-codes#minor-units). format: int64 type: integer required: diff --git a/yaml/TransferService-v3.yaml b/yaml/TransferService-v3.yaml index 4901143d..bd07ce86 100644 --- a/yaml/TransferService-v3.yaml +++ b/yaml/TransferService-v3.yaml @@ -872,12 +872,12 @@ components: additionalProperties: false properties: currency: - description: The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes). + description: The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes#currency-codes). maxLength: 3 minLength: 3 type: string value: - description: The amount of the transaction, in [minor units](https://docs.adyen.com/development-resources/currency-codes). + description: The amount of the transaction, in [minor units](https://docs.adyen.com/development-resources/currency-codes#minor-units). format: int64 type: integer required: @@ -2113,15 +2113,17 @@ components: \ a transfer involving a [transfer instrument](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/transferInstruments__resParam_id)\ \ or a bank account.\n\n- **card**: a transfer involving a third-party\ \ card.\n\n- **internal**: a transfer between [balance accounts](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/balanceAccounts__resParam_id)\ - \ within your platform.\n\n- **issuedCard**: a transfer initiated by an\ + \ within your platform.\n\n- **issuedCard**: a transfer initiated by a\ \ Adyen-issued card.\n\n- **platformPayment**: funds movements related\ - \ to payments that are acquired for your users." + \ to payments that are acquired for your users.\n\n- **topUp**: an incoming\ + \ transfer initiated by your user to top up their balance account." enum: - bank - card - internal - issuedCard - platformPayment + - topUp type: string counterparty: x-addedInVersion: '3' @@ -2412,13 +2414,15 @@ components: \ card.\n\n- **internal**: a transfer between [balance accounts](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/balanceAccounts__resParam_id)\ \ within your platform.\n\n- **issuedCard**: a transfer initiated by a\ \ Adyen-issued card.\n\n- **platformPayment**: funds movements related\ - \ to payments that are acquired for your users." + \ to payments that are acquired for your users.\n\n- **topUp**: an incoming\ + \ transfer initiated by your user to top up their balance account." enum: - bank - card - internal - issuedCard - platformPayment + - topUp type: string counterparty: x-addedInVersion: '3' diff --git a/yaml/TransferService-v4.yaml b/yaml/TransferService-v4.yaml index 8bd9af59..00216349 100644 --- a/yaml/TransferService-v4.yaml +++ b/yaml/TransferService-v4.yaml @@ -1114,16 +1114,28 @@ components: required: - country type: object + Airline: + additionalProperties: false + properties: + legs: + description: Details about the flight legs for this ticket. + items: + $ref: '#/components/schemas/Leg' + type: array + ticketNumber: + description: The ticket's unique identifier + type: string + type: object Amount: additionalProperties: false properties: currency: - description: The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes). + description: The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes#currency-codes). maxLength: 3 minLength: 3 type: string value: - description: The amount of the transaction, in [minor units](https://docs.adyen.com/development-resources/currency-codes). + description: The amount of the transaction, in [minor units](https://docs.adyen.com/development-resources/currency-codes#minor-units). format: int64 type: integer required: @@ -1942,6 +1954,30 @@ components: type: object JSONObject: type: object + Leg: + additionalProperties: false + properties: + arrivalAirportCode: + description: The IATA 3-letter airport code of the destination airport. + This field is required if the airline data includes leg details. + type: string + basicFareCode: + description: The basic fare code for this leg. + type: string + carrierCode: + description: IATA code of the carrier operating the flight. + type: string + departureAirportCode: + description: The IATA three-letter airport code of the departure airport. + This field is required if the airline data includes leg details + type: string + departureDate: + description: The flight departure date. + type: string + flightNumber: + description: The flight identifier. + type: string + type: object Link: additionalProperties: false properties: @@ -1978,6 +2014,22 @@ components: description: The merchant postal code. type: string type: object + MerchantPurchaseData: + additionalProperties: false + properties: + airline: + description: Airline information. + $ref: '#/components/schemas/Airline' + type: + default: merchantPurchaseData + description: "The type of events data. \n\nPossible values: \n\n - **merchantPurchaseData**:\ + \ merchant purchase data" + enum: + - merchantPurchaseData + type: string + required: + - type + type: object Modification: additionalProperties: false properties: @@ -2267,7 +2319,60 @@ components: type: string platformPaymentType: x-addedInVersion: '4' - description: The type of the related split. + 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/). + + + Possible values: + + + * **AcquiringFees**: for the acquiring fee incurred on a transaction. + + + * **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). + + + * **AdyenFees**: for all the transaction fees due to Adyen. This is the + sum of Adyen''s commission and Adyen''s markup. + + + * **AdyenMarkup**: for the transaction fee due to Adyen under [Interchange++ + pricing](https://www.adyen.com/pricing). + + + * **BalanceAccount**: or the sale amount of a transaction. + + + * **Commission**: for your platform''s commission on a transaction. + + + * **Interchange**: for the interchange fee (fee paid to the issuer) incurred + on a transaction. + + + * **PaymentFee**: for all of the transaction fees. + + + * **Remainder**: for the left over amount after currency conversion. + + + * **SchemeFee**: for the scheme fee incurred on a transaction. This is + the sum of the interchange fees and the acquiring fees. + + + * **Surcharge**: for the surcharge paid by the customer on a transaction. + + + * **Tip**: for the tip paid by the customer. + + + * **TopUp**: for an incoming transfer to top up your user''s balance account. + + + * **VAT**: for the Value Added Tax.' enum: - AcquiringFees - AdyenCommission @@ -2764,15 +2869,17 @@ components: \ a transfer involving a [transfer instrument](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/transferInstruments__resParam_id)\ \ or a bank account.\n\n- **card**: a transfer involving a third-party\ \ card.\n\n- **internal**: a transfer between [balance accounts](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/balanceAccounts__resParam_id)\ - \ within your platform.\n\n- **issuedCard**: a transfer initiated by an\ + \ within your platform.\n\n- **issuedCard**: a transfer initiated by a\ \ Adyen-issued card.\n\n- **platformPayment**: funds movements related\ - \ to payments that are acquired for your users." + \ to payments that are acquired for your users.\n\n- **topUp**: an incoming\ + \ transfer initiated by your user to top up their balance account." enum: - bank - card - internal - issuedCard - platformPayment + - topUp type: string categoryData: x-addedInVersion: '4' @@ -3030,15 +3137,17 @@ components: \ a transfer involving a [transfer instrument](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/transferInstruments__resParam_id)\ \ or a bank account.\n\n- **card**: a transfer involving a third-party\ \ card.\n\n- **internal**: a transfer between [balance accounts](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/balanceAccounts__resParam_id)\ - \ within your platform.\n\n- **issuedCard**: a transfer initiated by an\ + \ within your platform.\n\n- **issuedCard**: a transfer initiated by a\ \ Adyen-issued card.\n\n- **platformPayment**: funds movements related\ - \ to payments that are acquired for your users." + \ to payments that are acquired for your users.\n\n- **topUp**: an incoming\ + \ transfer initiated by your user to top up their balance account." enum: - bank - card - internal - issuedCard - platformPayment + - topUp type: string categoryData: x-addedInVersion: '4' @@ -3085,6 +3194,10 @@ components: - incoming - outgoing type: string + eventId: + x-addedInVersion: '4' + description: The event id listed under events, that triggered the notification. + type: string events: x-addedInVersion: '3' description: The list of events leading up to the current status of the @@ -3320,6 +3433,13 @@ components: to the funds. format: date-time type: string + eventsData: + x-addedInVersion: '4' + description: A list of event data. + items: + oneOf: + - $ref: '#/components/schemas/MerchantPurchaseData' + type: array externalReason: x-addedInVersion: '3' description: The external reason for the transfer status. @@ -3500,13 +3620,15 @@ components: \ card.\n\n- **internal**: a transfer between [balance accounts](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/balanceAccounts__resParam_id)\ \ within your platform.\n\n- **issuedCard**: a transfer initiated by a\ \ Adyen-issued card.\n\n- **platformPayment**: funds movements related\ - \ to payments that are acquired for your users." + \ to payments that are acquired for your users.\n\n- **topUp**: an incoming\ + \ transfer initiated by your user to top up their balance account." enum: - bank - card - internal - issuedCard - platformPayment + - topUp type: string counterparty: x-addedInVersion: '3'