Skip to content

Commit

Permalink
spec release
Browse files Browse the repository at this point in the history
  • Loading branch information
Adyen Automation committed Dec 6, 2024
1 parent e933e70 commit 8a60868
Show file tree
Hide file tree
Showing 18 changed files with 647 additions and 72 deletions.
9 changes: 7 additions & 2 deletions json/BalancePlatformAcsNotification-v1.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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"
}
Expand Down Expand Up @@ -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" : [
Expand Down
19 changes: 17 additions & 2 deletions json/BalancePlatformPaymentNotification-v1.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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"
}
Expand Down Expand Up @@ -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" : [
Expand Down Expand Up @@ -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" : [
Expand Down Expand Up @@ -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" : [
Expand Down
11 changes: 8 additions & 3 deletions json/BalancePlatformTransactionNotification-v4.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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"
}
Expand Down Expand Up @@ -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",
Expand Down Expand Up @@ -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" : [
Expand Down
16 changes: 11 additions & 5 deletions json/BalancePlatformTransferNotification-v3.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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"
}
Expand Down Expand Up @@ -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"
},
Expand Down Expand Up @@ -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",
Expand Down Expand Up @@ -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" : [
Expand Down
Loading

0 comments on commit 8a60868

Please sign in to comment.