Skip to content

Commit

Permalink
spec release
Browse files Browse the repository at this point in the history
  • Loading branch information
Adyen Automation committed May 6, 2024
1 parent af350a1 commit 72adc75
Show file tree
Hide file tree
Showing 6 changed files with 383 additions and 75 deletions.
66 changes: 57 additions & 9 deletions json/LegalEntityService-v1.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1828,7 +1828,7 @@
},
"parameters" : [
{
"description" : "The unique identifier of the legal entity. For sole proprietorships, this is the individual legal entity ID of the owner.",
"description" : "The unique identifier of the legal entity. For sole proprietorships, this is the individual legal entity ID of the owner. For organizations, this is the ID of the organization.",
"name" : "id",
"in" : "path",
"required" : true,
Expand Down Expand Up @@ -1943,7 +1943,7 @@
},
"parameters" : [
{
"description" : "The unique identifier of the legal entity. For sole proprietorships, this is the individual legal entity ID of the owner.",
"description" : "The unique identifier of the legal entity. For sole proprietorships, this is the individual legal entity ID of the owner. For organizations, this is the ID of the organization.",
"name" : "id",
"in" : "path",
"required" : true,
Expand Down Expand Up @@ -2053,7 +2053,7 @@
],
"parameters" : [
{
"description" : "The unique identifier of the legal entity. For sole proprietorships, this is the individual legal entity ID of the owner.",
"description" : "The unique identifier of the legal entity. For sole proprietorships, this is the individual legal entity ID of the owner. For organizations, this is the ID of the organization.",
"name" : "id",
"in" : "path",
"required" : true,
Expand Down Expand Up @@ -2154,7 +2154,7 @@
],
"parameters" : [
{
"description" : "The unique identifier of the legal entity. For sole proprietorships, this is the individual legal entity ID of the owner.",
"description" : "The unique identifier of the legal entity. For sole proprietorships, this is the individual legal entity ID of the owner. For organizations, this is the ID of the organization.",
"name" : "id",
"in" : "path",
"required" : true,
Expand Down Expand Up @@ -4007,11 +4007,8 @@
"type" : "string"
},
"settings" : {
"additionalProperties" : {
"type" : "boolean"
},
"description" : "Boolean key-value pairs indicating the settings for the hosted onboarding page. The keys are the settings.\n\nPossible keys:\n\nBy default, these values are set to **true**. Set to **false** to not allow the action.\n\n- **changeLegalEntityType**: The user can change their legal entity type.\n\n- **editPrefilledCountry**: The user can change the country of their legal entity's address, for example the registered address of an organization.\n\nBy default, these values are set to **false**. Set to **true** to allow the action.\n\n- **allowBankAccountFormatSelection**: The user can select the format for their payout account if applicable.\n\n- **allowIntraRegionCrossBorderPayout**: The user can select a payout account in a different EU/EEA country (including Switzerland and the UK) than the country of their legal entity.\n\nBy default, these value are set to **false**. Set the following values to **true** to require the user to sign PCI questionnaires based on their sales channels. The user must sign PCI questionnaires for all relevant sales channels.\n\n- **requirePciSignEcommerce**\n\n- **requirePciSignPos**\n\n- **requirePciSignEcomMoto**\n\n- **requirePciSignPosMoto**\n\n",
"type" : "object"
"description" : "Key-value pairs indicating the settings for the hosted onboarding page. The keys are the settings.\n\nPossible keys:\n\nBy default, these values are set to **true**. Set to **false** to not allow the action.\n\n- **changeLegalEntityType**: The user can change their legal entity type.\n\n- **editPrefilledCountry**: The user can change the country of their legal entity's address, for example the registered address of an organization.\n\nBy default, these values are set to **false**. Set to **true** to allow the action.\n\n- **allowBankAccountFormatSelection**: The user can select the format for their payout account if applicable.\n\n- **allowIntraRegionCrossBorderPayout**: The user can select a payout account in a different EU/EEA country (including Switzerland and the UK) than the country of their legal entity.\n\nBy default, these values are set to **false**. Set the following values to **true** to require the user to sign PCI questionnaires based on their sales channels. The user must sign PCI questionnaires for all relevant sales channels.\n\n- **requirePciSignEcommerce**\n\n- **requirePciSignPos**\n\n- **requirePciSignEcomMoto**\n\n- **requirePciSignPosMoto**\n\nThe following value is an array of strings in the two-character [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code format. The array is empty by default and only countries supported by hosted onboarding are allowed.\n\n- **acceptedCountries**: List of countries that the user can select in hosted onboarding when `editPrefilledCountry` is allowed.\n\n",
"$ref" : "#/components/schemas/OnboardingLinkSettings"
},
"themeId" : {
"description" : "The unique identifier of the hosted onboarding theme.",
Expand All @@ -4020,6 +4017,57 @@
},
"type" : "object"
},
"OnboardingLinkSettings" : {
"additionalProperties" : false,
"properties" : {
"acceptedCountries" : {
"items" : {
"type" : "string"
},
"type" : "array"
},
"allowBankAccountFormatSelection" : {
"type" : "boolean"
},
"allowIntraRegionCrossBorderPayout" : {
"type" : "boolean"
},
"changeLegalEntityType" : {
"type" : "boolean"
},
"editPrefilledCountry" : {
"type" : "boolean"
},
"hideOnboardingIntroductionIndividual" : {
"type" : "boolean"
},
"hideOnboardingIntroductionOrganization" : {
"type" : "boolean"
},
"hideOnboardingIntroductionSoleProprietor" : {
"type" : "boolean"
},
"hideOnboardingIntroductionTrust" : {
"type" : "boolean"
},
"instantBankVerification" : {
"type" : "boolean"
},
"requirePciSignEcomMoto" : {
"type" : "boolean"
},
"requirePciSignEcommerce" : {
"type" : "boolean"
},
"requirePciSignPos" : {
"type" : "boolean"
},
"requirePciSignPosMoto" : {
"type" : "boolean"
}
},
"type" : "object"
},
"OnboardingTheme" : {
"additionalProperties" : false,
"properties" : {
Expand Down
78 changes: 69 additions & 9 deletions json/LegalEntityService-v2.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1971,7 +1971,7 @@
},
"parameters" : [
{
"description" : "The unique identifier of the legal entity. For sole proprietorships, this is the individual legal entity ID of the owner.",
"description" : "The unique identifier of the legal entity. For sole proprietorships, this is the individual legal entity ID of the owner. For organizations, this is the ID of the organization.",
"name" : "id",
"in" : "path",
"required" : true,
Expand Down Expand Up @@ -2086,7 +2086,7 @@
},
"parameters" : [
{
"description" : "The unique identifier of the legal entity. For sole proprietorships, this is the individual legal entity ID of the owner.",
"description" : "The unique identifier of the legal entity. For sole proprietorships, this is the individual legal entity ID of the owner. For organizations, this is the ID of the organization.",
"name" : "id",
"in" : "path",
"required" : true,
Expand Down Expand Up @@ -2196,7 +2196,7 @@
],
"parameters" : [
{
"description" : "The unique identifier of the legal entity. For sole proprietorships, this is the individual legal entity ID of the owner.",
"description" : "The unique identifier of the legal entity. For sole proprietorships, this is the individual legal entity ID of the owner. For organizations, this is the ID of the organization.",
"name" : "id",
"in" : "path",
"required" : true,
Expand Down Expand Up @@ -2297,7 +2297,7 @@
],
"parameters" : [
{
"description" : "The unique identifier of the legal entity. For sole proprietorships, this is the individual legal entity ID of the owner.",
"description" : "The unique identifier of the legal entity. For sole proprietorships, this is the individual legal entity ID of the owner. For organizations, this is the ID of the organization.",
"name" : "id",
"in" : "path",
"required" : true,
Expand Down Expand Up @@ -4320,11 +4320,8 @@
"type" : "string"
},
"settings" : {
"additionalProperties" : {
"type" : "boolean"
},
"description" : "Boolean key-value pairs indicating the settings for the hosted onboarding page. The keys are the settings.\n\nPossible keys:\n\nBy default, these values are set to **true**. Set to **false** to not allow the action.\n\n- **changeLegalEntityType**: The user can change their legal entity type.\n\n- **editPrefilledCountry**: The user can change the country of their legal entity's address, for example the registered address of an organization.\n\nBy default, these values are set to **false**. Set to **true** to allow the action.\n\n- **allowBankAccountFormatSelection**: The user can select the format for their payout account if applicable.\n\n- **allowIntraRegionCrossBorderPayout**: The user can select a payout account in a different EU/EEA country (including Switzerland and the UK) than the country of their legal entity.\n\nBy default, these value are set to **false**. Set the following values to **true** to require the user to sign PCI questionnaires based on their sales channels. The user must sign PCI questionnaires for all relevant sales channels.\n\n- **requirePciSignEcommerce**\n\n- **requirePciSignPos**\n\n- **requirePciSignEcomMoto**\n\n- **requirePciSignPosMoto**\n\n",
"type" : "object"
"description" : "Key-value pairs indicating the settings for the hosted onboarding page. The keys are the settings.\n\nPossible keys:\n\nBy default, these values are set to **true**. Set to **false** to not allow the action.\n\n- **changeLegalEntityType**: The user can change their legal entity type.\n\n- **editPrefilledCountry**: The user can change the country of their legal entity's address, for example the registered address of an organization.\n\nBy default, these values are set to **false**. Set to **true** to allow the action.\n\n- **allowBankAccountFormatSelection**: The user can select the format for their payout account if applicable.\n\n- **allowIntraRegionCrossBorderPayout**: The user can select a payout account in a different EU/EEA country (including Switzerland and the UK) than the country of their legal entity.\n\nBy default, these values are set to **false**. Set the following values to **true** to require the user to sign PCI questionnaires based on their sales channels. The user must sign PCI questionnaires for all relevant sales channels.\n\n- **requirePciSignEcommerce**\n\n- **requirePciSignPos**\n\n- **requirePciSignEcomMoto**\n\n- **requirePciSignPosMoto**\n\nThe following value is an array of strings in the two-character [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code format. The array is empty by default and only countries supported by hosted onboarding are allowed.\n\n- **acceptedCountries**: List of countries that the user can select in hosted onboarding when `editPrefilledCountry` is allowed.\n\n",
"$ref" : "#/components/schemas/OnboardingLinkSettings"
},
"themeId" : {
"description" : "The unique identifier of the hosted onboarding theme.",
Expand All @@ -4333,6 +4330,57 @@
},
"type" : "object"
},
"OnboardingLinkSettings" : {
"additionalProperties" : false,
"properties" : {
"acceptedCountries" : {
"items" : {
"type" : "string"
},
"type" : "array"
},
"allowBankAccountFormatSelection" : {
"type" : "boolean"
},
"allowIntraRegionCrossBorderPayout" : {
"type" : "boolean"
},
"changeLegalEntityType" : {
"type" : "boolean"
},
"editPrefilledCountry" : {
"type" : "boolean"
},
"hideOnboardingIntroductionIndividual" : {
"type" : "boolean"
},
"hideOnboardingIntroductionOrganization" : {
"type" : "boolean"
},
"hideOnboardingIntroductionSoleProprietor" : {
"type" : "boolean"
},
"hideOnboardingIntroductionTrust" : {
"type" : "boolean"
},
"instantBankVerification" : {
"type" : "boolean"
},
"requirePciSignEcomMoto" : {
"type" : "boolean"
},
"requirePciSignEcommerce" : {
"type" : "boolean"
},
"requirePciSignPos" : {
"type" : "boolean"
},
"requirePciSignPosMoto" : {
"type" : "boolean"
}
},
"type" : "object"
},
"OnboardingTheme" : {
"additionalProperties" : false,
"properties" : {
Expand Down Expand Up @@ -4653,6 +4701,12 @@
"description" : "The registration number.",
"type" : "string"
},
"taxAbsent" : {
"x-addedInVersion" : "2",
"description" : "The tax information is absent.",
"nullable" : true,
"type" : "boolean"
},
"taxInformation" : {
"x-addedInVersion" : "2",
"description" : "The tax information of the entity.",
Expand Down Expand Up @@ -4977,6 +5031,12 @@
"description" : "The registration number.",
"type" : "string"
},
"taxAbsent" : {
"x-addedInVersion" : "2",
"description" : "The tax information is absent.",
"nullable" : true,
"type" : "boolean"
},
"taxInformation" : {
"x-addedInVersion" : "2",
"description" : "The tax information of the entity.",
Expand Down
Loading

0 comments on commit 72adc75

Please sign in to comment.