Skip to content

Commit

Permalink
spec release
Browse files Browse the repository at this point in the history
  • Loading branch information
Adyen Automation committed Sep 16, 2024
1 parent b9bc67e commit 8e528c4
Show file tree
Hide file tree
Showing 28 changed files with 211 additions and 134 deletions.
6 changes: 5 additions & 1 deletion json/AccountService-v3.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2157,6 +2157,10 @@
"description" : "A set of key and value pairs for general use by the account holder or merchant.\nThe keys do not have specific names and may be used for storing miscellaneous data as desired.\n> The values being stored have a maximum length of eighty (80) characters and will be truncated if necessary.\n> Note that during an update of metadata, the omission of existing key-value pairs will result in the deletion of those key-value pairs.",
"type" : "object"
},
"phoneNumber" : {
"description" : "The phone number of the account holder.\n> Required if a `fullPhoneNumber` is not provided.",
"$ref" : "#/components/schemas/ViasPhoneNumber"
},
"principalBusinessAddress" : {
"description" : "The principal business address of the account holder.",
"$ref" : "#/components/schemas/ViasAddress"
Expand Down Expand Up @@ -3257,7 +3261,7 @@
"additionalProperties" : false,
"properties" : {
"name" : {
"description" : "The name of the individual.\n>Make sure your account holder registers using the name shown on their Photo ID.",
"description" : "The name of the individual.\n>Make sure your account holder registers using the name shown on their Photo ID. \n Maximum length: 80 characters \n Cannot contain numbers. /n Cannot be empty.",
"$ref" : "#/components/schemas/ViasName"
},
"personalData" : {
Expand Down
6 changes: 5 additions & 1 deletion json/AccountService-v4.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2163,6 +2163,10 @@
"description" : "A set of key and value pairs for general use by the account holder or merchant.\nThe keys do not have specific names and may be used for storing miscellaneous data as desired.\n> The values being stored have a maximum length of eighty (80) characters and will be truncated if necessary.\n> Note that during an update of metadata, the omission of existing key-value pairs will result in the deletion of those key-value pairs.",
"type" : "object"
},
"phoneNumber" : {
"description" : "The phone number of the account holder.\n> Required if a `fullPhoneNumber` is not provided.",
"$ref" : "#/components/schemas/ViasPhoneNumber"
},
"principalBusinessAddress" : {
"description" : "The principal business address of the account holder.",
"$ref" : "#/components/schemas/ViasAddress"
Expand Down Expand Up @@ -3323,7 +3327,7 @@
"additionalProperties" : false,
"properties" : {
"name" : {
"description" : "The name of the individual.\n>Make sure your account holder registers using the name shown on their Photo ID.",
"description" : "The name of the individual.\n>Make sure your account holder registers using the name shown on their Photo ID. \n Maximum length: 80 characters \n Cannot contain numbers. /n Cannot be empty.",
"$ref" : "#/components/schemas/ViasName"
},
"personalData" : {
Expand Down
6 changes: 5 additions & 1 deletion json/AccountService-v5.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2539,6 +2539,10 @@
},
"type" : "array"
},
"phoneNumber" : {
"description" : "The phone number of the account holder.\n> Required if a `fullPhoneNumber` is not provided.",
"$ref" : "#/components/schemas/ViasPhoneNumber"
},
"principalBusinessAddress" : {
"description" : "The principal business address of the account holder.",
"$ref" : "#/components/schemas/ViasAddress"
Expand Down Expand Up @@ -3833,7 +3837,7 @@
"additionalProperties" : false,
"properties" : {
"name" : {
"description" : "The name of the individual.\n>Make sure your account holder registers using the name shown on their Photo ID.",
"description" : "The name of the individual.\n>Make sure your account holder registers using the name shown on their Photo ID. \n Maximum length: 80 characters \n Cannot contain numbers. /n Cannot be empty.",
"$ref" : "#/components/schemas/ViasName"
},
"personalData" : {
Expand Down
6 changes: 5 additions & 1 deletion json/AccountService-v6.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2547,6 +2547,10 @@
},
"type" : "array"
},
"phoneNumber" : {
"description" : "The phone number of the account holder.\n> Required if a `fullPhoneNumber` is not provided.",
"$ref" : "#/components/schemas/ViasPhoneNumber"
},
"principalBusinessAddress" : {
"description" : "The principal business address of the account holder.",
"$ref" : "#/components/schemas/ViasAddress"
Expand Down Expand Up @@ -3888,7 +3892,7 @@
"additionalProperties" : false,
"properties" : {
"name" : {
"description" : "The name of the individual.\n>Make sure your account holder registers using the name shown on their Photo ID.",
"description" : "The name of the individual.\n>Make sure your account holder registers using the name shown on their Photo ID. \n Maximum length: 80 characters \n Cannot contain numbers. /n Cannot be empty.",
"$ref" : "#/components/schemas/ViasName"
},
"personalData" : {
Expand Down
2 changes: 1 addition & 1 deletion json/FundService-v3.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1562,7 +1562,7 @@
"type" : "string"
},
"type" : {
"description" : "The part of the payment you want to book to the specified `account`.\n\nPossible values for the [Balance Platform](https://docs.adyen.com/adyen-for-platforms-model):\n* **BalanceAccount**: books part of the payment (specified in `amount`) to the specified `account`.\n* Transaction fees types that you can book to the specified `account`:\n * **AcquiringFees**: the aggregated amount of the interchange and scheme fees.\n * **PaymentFee**: the aggregated amount of all transaction fees.\n * **AdyenFees**: the aggregated amount of Adyen's commission and markup fees.\n * **AdyenCommission**: the transaction fees due to Adyen under [blended rates](https://www.adyen.com/knowledge-hub/interchange-fees-explained).\n * **AdyenMarkup**: the transaction fees due to Adyen under [Interchange ++ pricing](https://www.adyen.com/knowledge-hub/interchange-fees-explained).\n * **Interchange**: the fees paid to the issuer for each payment made with the card network.\n * **SchemeFee**: the fees paid to the card scheme for using their network. \n* **Remainder**: the amount left over after a currency conversion, booked to the specified `account`.\n* **VAT**: the value-added tax charged on the payment, booked to your platforms liable balance account.\n* **Commission**: your platform's commission (specified in `amount`) on the payment, booked to your liable balance account.\n* **Default**: in very specific use cases, allows you to book the specified `amount` to the specified `account`. For more information, contact Adyen support.\n\nPossible values for the [Classic Platforms integration](https://docs.adyen.com/classic-platforms): **Commission**, **Default**, **Marketplace**, **PaymentFee**, **VAT**.",
"description" : "The part of the payment you want to book to the specified `account`.\n\nPossible values for the [Balance Platform](https://docs.adyen.com/adyen-for-platforms-model):\n* **BalanceAccount**: books part of the payment (specified in `amount`) to the specified `account`.\n* Transaction fees types that you can book to the specified `account`:\n * **AcquiringFees**: the aggregated amount of the interchange and scheme fees.\n * **PaymentFee**: the aggregated amount of all transaction fees.\n * **AdyenFees**: the aggregated amount of Adyen's commission and markup fees.\n * **AdyenCommission**: the transaction fees due to Adyen under [blended rates](https://www.adyen.com/knowledge-hub/interchange-fees-explained).\n * **AdyenMarkup**: the transaction fees due to Adyen under [Interchange ++ pricing](https://www.adyen.com/knowledge-hub/interchange-fees-explained).\n * **Interchange**: the fees paid to the issuer for each payment made with the card network.\n * **SchemeFee**: the fees paid to the card scheme for using their network. \n* **Commission**: your platform's commission on the payment (specified in `amount`), booked to your liable balance account.\n* **Remainder**: the amount left over after a currency conversion, booked to the specified `account`.\n* **TopUp**: allows you and your users to top up balance accounts using direct debit, card payments, or other payment methods.\n* **VAT**: the value-added tax charged on the payment, booked to your platforms liable balance account.\n* **Commission**: your platform's commission (specified in `amount`) on the payment, booked to your liable balance account.\n* **Default**: in very specific use cases, allows you to book the specified `amount` to the specified `account`. For more information, contact Adyen support.\n\nPossible values for the [Classic Platforms integration](https://docs.adyen.com/classic-platforms): **Commission**, **Default**, **Marketplace**, **PaymentFee**, **VAT**.",
"enum" : [
"AcquiringFees",
"AdyenCommission",
Expand Down
2 changes: 1 addition & 1 deletion json/FundService-v5.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1811,7 +1811,7 @@
"type" : "string"
},
"type" : {
"description" : "The part of the payment you want to book to the specified `account`.\n\nPossible values for the [Balance Platform](https://docs.adyen.com/adyen-for-platforms-model):\n* **BalanceAccount**: books part of the payment (specified in `amount`) to the specified `account`.\n* Transaction fees types that you can book to the specified `account`:\n * **AcquiringFees**: the aggregated amount of the interchange and scheme fees.\n * **PaymentFee**: the aggregated amount of all transaction fees.\n * **AdyenFees**: the aggregated amount of Adyen's commission and markup fees.\n * **AdyenCommission**: the transaction fees due to Adyen under [blended rates](https://www.adyen.com/knowledge-hub/interchange-fees-explained).\n * **AdyenMarkup**: the transaction fees due to Adyen under [Interchange ++ pricing](https://www.adyen.com/knowledge-hub/interchange-fees-explained).\n * **Interchange**: the fees paid to the issuer for each payment made with the card network.\n * **SchemeFee**: the fees paid to the card scheme for using their network. \n* **Remainder**: the amount left over after a currency conversion, booked to the specified `account`.\n* **VAT**: the value-added tax charged on the payment, booked to your platforms liable balance account.\n* **Commission**: your platform's commission (specified in `amount`) on the payment, booked to your liable balance account.\n* **Default**: in very specific use cases, allows you to book the specified `amount` to the specified `account`. For more information, contact Adyen support.\n\nPossible values for the [Classic Platforms integration](https://docs.adyen.com/classic-platforms): **Commission**, **Default**, **Marketplace**, **PaymentFee**, **VAT**.",
"description" : "The part of the payment you want to book to the specified `account`.\n\nPossible values for the [Balance Platform](https://docs.adyen.com/adyen-for-platforms-model):\n* **BalanceAccount**: books part of the payment (specified in `amount`) to the specified `account`.\n* Transaction fees types that you can book to the specified `account`:\n * **AcquiringFees**: the aggregated amount of the interchange and scheme fees.\n * **PaymentFee**: the aggregated amount of all transaction fees.\n * **AdyenFees**: the aggregated amount of Adyen's commission and markup fees.\n * **AdyenCommission**: the transaction fees due to Adyen under [blended rates](https://www.adyen.com/knowledge-hub/interchange-fees-explained).\n * **AdyenMarkup**: the transaction fees due to Adyen under [Interchange ++ pricing](https://www.adyen.com/knowledge-hub/interchange-fees-explained).\n * **Interchange**: the fees paid to the issuer for each payment made with the card network.\n * **SchemeFee**: the fees paid to the card scheme for using their network. \n* **Commission**: your platform's commission on the payment (specified in `amount`), booked to your liable balance account.\n* **Remainder**: the amount left over after a currency conversion, booked to the specified `account`.\n* **TopUp**: allows you and your users to top up balance accounts using direct debit, card payments, or other payment methods.\n* **VAT**: the value-added tax charged on the payment, booked to your platforms liable balance account.\n* **Commission**: your platform's commission (specified in `amount`) on the payment, booked to your liable balance account.\n* **Default**: in very specific use cases, allows you to book the specified `amount` to the specified `account`. For more information, contact Adyen support.\n\nPossible values for the [Classic Platforms integration](https://docs.adyen.com/classic-platforms): **Commission**, **Default**, **Marketplace**, **PaymentFee**, **VAT**.",
"enum" : [
"AcquiringFees",
"AdyenCommission",
Expand Down
2 changes: 1 addition & 1 deletion json/FundService-v6.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1811,7 +1811,7 @@
"type" : "string"
},
"type" : {
"description" : "The part of the payment you want to book to the specified `account`.\n\nPossible values for the [Balance Platform](https://docs.adyen.com/adyen-for-platforms-model):\n* **BalanceAccount**: books part of the payment (specified in `amount`) to the specified `account`.\n* Transaction fees types that you can book to the specified `account`:\n * **AcquiringFees**: the aggregated amount of the interchange and scheme fees.\n * **PaymentFee**: the aggregated amount of all transaction fees.\n * **AdyenFees**: the aggregated amount of Adyen's commission and markup fees.\n * **AdyenCommission**: the transaction fees due to Adyen under [blended rates](https://www.adyen.com/knowledge-hub/interchange-fees-explained).\n * **AdyenMarkup**: the transaction fees due to Adyen under [Interchange ++ pricing](https://www.adyen.com/knowledge-hub/interchange-fees-explained).\n * **Interchange**: the fees paid to the issuer for each payment made with the card network.\n * **SchemeFee**: the fees paid to the card scheme for using their network. \n* **Remainder**: the amount left over after a currency conversion, booked to the specified `account`.\n* **VAT**: the value-added tax charged on the payment, booked to your platforms liable balance account.\n* **Commission**: your platform's commission (specified in `amount`) on the payment, booked to your liable balance account.\n* **Default**: in very specific use cases, allows you to book the specified `amount` to the specified `account`. For more information, contact Adyen support.\n\nPossible values for the [Classic Platforms integration](https://docs.adyen.com/classic-platforms): **Commission**, **Default**, **Marketplace**, **PaymentFee**, **VAT**.",
"description" : "The part of the payment you want to book to the specified `account`.\n\nPossible values for the [Balance Platform](https://docs.adyen.com/adyen-for-platforms-model):\n* **BalanceAccount**: books part of the payment (specified in `amount`) to the specified `account`.\n* Transaction fees types that you can book to the specified `account`:\n * **AcquiringFees**: the aggregated amount of the interchange and scheme fees.\n * **PaymentFee**: the aggregated amount of all transaction fees.\n * **AdyenFees**: the aggregated amount of Adyen's commission and markup fees.\n * **AdyenCommission**: the transaction fees due to Adyen under [blended rates](https://www.adyen.com/knowledge-hub/interchange-fees-explained).\n * **AdyenMarkup**: the transaction fees due to Adyen under [Interchange ++ pricing](https://www.adyen.com/knowledge-hub/interchange-fees-explained).\n * **Interchange**: the fees paid to the issuer for each payment made with the card network.\n * **SchemeFee**: the fees paid to the card scheme for using their network. \n* **Commission**: your platform's commission on the payment (specified in `amount`), booked to your liable balance account.\n* **Remainder**: the amount left over after a currency conversion, booked to the specified `account`.\n* **TopUp**: allows you and your users to top up balance accounts using direct debit, card payments, or other payment methods.\n* **VAT**: the value-added tax charged on the payment, booked to your platforms liable balance account.\n* **Commission**: your platform's commission (specified in `amount`) on the payment, booked to your liable balance account.\n* **Default**: in very specific use cases, allows you to book the specified `amount` to the specified `account`. For more information, contact Adyen support.\n\nPossible values for the [Classic Platforms integration](https://docs.adyen.com/classic-platforms): **Commission**, **Default**, **Marketplace**, **PaymentFee**, **VAT**.",
"enum" : [
"AcquiringFees",
"AdyenCommission",
Expand Down
2 changes: 1 addition & 1 deletion json/HopService-v1.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@
"Hosted Onboarding Page"
],
"summary" : "Get a link to a Adyen-hosted onboarding page",
"description" : "Returns a link to an Adyen-hosted onboarding page (HOP) that you can send to your account holder. For more information on how to use HOP, refer to [Hosted onboarding](https://docs.adyen.com/classic-platforms/collect-verification-details/hosted-onboarding-page). ",
"description" : "Returns a link to an Adyen-hosted onboarding page (HOP) that you can send to your account holder. For more information on how to use HOP, refer to [Hosted onboarding](https://docs.adyen.com/classic-platforms/onboard-users/hosted-onboarding-page).",
"operationId" : "post-getOnboardingUrl",
"x-sortIndex" : 1,
"x-methodName" : "getOnboardingUrl",
Expand Down
2 changes: 1 addition & 1 deletion json/HopService-v5.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@
"Hosted Onboarding Page"
],
"summary" : "Get a link to a Adyen-hosted onboarding page",
"description" : "Returns a link to an Adyen-hosted onboarding page (HOP) that you can send to your account holder. For more information on how to use HOP, refer to [Hosted onboarding](https://docs.adyen.com/classic-platforms/collect-verification-details/hosted-onboarding-page). ",
"description" : "Returns a link to an Adyen-hosted onboarding page (HOP) that you can send to your account holder. For more information on how to use HOP, refer to [Hosted onboarding](https://docs.adyen.com/classic-platforms/onboard-users/hosted-onboarding-page).",
"operationId" : "post-getOnboardingUrl",
"x-sortIndex" : 1,
"x-methodName" : "getOnboardingUrl",
Expand Down
2 changes: 1 addition & 1 deletion json/HopService-v6.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@
"Hosted Onboarding Page"
],
"summary" : "Get a link to a Adyen-hosted onboarding page",
"description" : "Returns a link to an Adyen-hosted onboarding page (HOP) that you can send to your account holder. For more information on how to use HOP, refer to [Hosted onboarding](https://docs.adyen.com/classic-platforms/collect-verification-details/hosted-onboarding-page). ",
"description" : "Returns a link to an Adyen-hosted onboarding page (HOP) that you can send to your account holder. For more information on how to use HOP, refer to [Hosted onboarding](https://docs.adyen.com/classic-platforms/onboard-users/hosted-onboarding-page).",
"operationId" : "post-getOnboardingUrl",
"x-sortIndex" : 1,
"x-methodName" : "getOnboardingUrl",
Expand Down
Loading

0 comments on commit 8e528c4

Please sign in to comment.