Skip to content

Commit

Permalink
spec release
Browse files Browse the repository at this point in the history
  • Loading branch information
Adyen Automation committed Oct 17, 2023
1 parent f2c9ecd commit 1b58f92
Show file tree
Hide file tree
Showing 6 changed files with 307 additions and 197 deletions.
49 changes: 8 additions & 41 deletions json/LegalEntityService-v1.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@
"name" : "Legal entities"
},
{
"name" : "Hosted Onboarding"
"name" : "Transfer instruments"
},
{
"name" : "Business lines"
Expand All @@ -42,7 +42,7 @@
"name" : "Terms of Service"
},
{
"name" : "Transfer instruments"
"name" : "Hosted Onboarding"
},
{
"name" : "PCI questionnaires"
Expand Down Expand Up @@ -3598,7 +3598,7 @@
"type" : {
"description" : "Type of identity data. For **individual**, the `type` value is **nationalIdNumber**.",
"enum" : [
"proofOfNationalIdNumber"
"nationalIdNumber"
],
"type" : "string"
}
Expand Down Expand Up @@ -3762,7 +3762,7 @@
"LegalEntityCapability" : {
"properties" : {
"allowed" : {
"description" : "Indicates whether the capability is allowed. Adyen sets this to **true** if the verification is successful ",
"description" : "Indicates whether the capability is allowed. Adyen sets this to **true** if the verification is successful.",
"readOnly" : true,
"type" : "boolean"
},
Expand All @@ -3778,7 +3778,7 @@
"type" : "string"
},
"allowedSettings" : {
"description" : "The settings that were allowed for the Legal Entity.",
"description" : "The settings that are allowed for the legal entity.",
"readOnly" : true,
"$ref" : "#/components/schemas/CapabilitySettings"
},
Expand All @@ -3791,7 +3791,7 @@
"type" : "array"
},
"requested" : {
"description" : "Indicates whether the capability is requested. To check whether the Legal Entity is permitted to use the capability, ",
"description" : "Indicates whether the capability is requested. To check whether the legal entity is permitted to use the capability, refer to the `allowed` field.",
"readOnly" : true,
"type" : "boolean"
},
Expand All @@ -3807,18 +3807,10 @@
"type" : "string"
},
"requestedSettings" : {
"description" : "The settings that are requested for the Legal Entity.",
"description" : "The settings that are requested for the legal entity.",
"readOnly" : true,
"$ref" : "#/components/schemas/CapabilitySettings"
},
"transferInstruments" : {
"description" : "Capability status for transfer instruments associated with legal entity",
"items" : {
"$ref" : "#/components/schemas/SupportingEntityCapability"
},
"readOnly" : true,
"type" : "array"
},
"verificationStatus" : {
"description" : "The status of the verification checks for the capability.\n\nPossible values:\n\n* **pending**: Adyen is running the verification.\n\n* **invalid**: The verification failed. Check if the `errors` array contains more information.\n\n* **valid**: The verification has been successfully completed.\n\n* **rejected**: Adyen has verified the information, but found reasons to not allow the capability.\n",
"readOnly" : true,
Expand Down Expand Up @@ -3956,7 +3948,7 @@
"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, this value is 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 than the country of their legal entity.\n\n",
"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 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"
},
"themeId" : {
Expand Down Expand Up @@ -4274,31 +4266,6 @@
},
"type" : "object"
},
"SupportingEntityCapability" : {
"properties" : {
"allowed" : {
"description" : "Indicates whether the supporting entity capability is allowed.\n\nIf a supporting entity is allowed but its parent legal entity is not, it means there are other supporting entities that failed validation.\n\n**The allowed supporting entity can still be used**",
"readOnly" : true,
"type" : "boolean"
},
"id" : {
"description" : "Supporting entity reference ",
"readOnly" : true,
"type" : "string"
},
"requested" : {
"description" : "Indicates whether the supporting entity capability is requested. ",
"readOnly" : true,
"type" : "boolean"
},
"verificationStatus" : {
"description" : "The status of the verification checks for the supporting entity capability.\n\nPossible values:\n\n* **pending**: Adyen is running the verification.\n\n* **invalid**: The verification failed. Check if the `errors` array contains more information.\n\n* **valid**: The verification has been successfully completed.\n\n* **rejected**: Adyen has verified the information, but found reasons to not allow the capability.\n",
"readOnly" : true,
"type" : "string"
}
},
"type" : "object"
},
"TermsOfServiceAcceptanceInfo" : {
"properties" : {
"acceptedBy" : {
Expand Down
77 changes: 59 additions & 18 deletions json/LegalEntityService-v2.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@
"name" : "Legal entities"
},
{
"name" : "Hosted Onboarding"
"name" : "Transfer instruments"
},
{
"name" : "Business lines"
Expand All @@ -42,7 +42,7 @@
"name" : "Terms of Service"
},
{
"name" : "Transfer instruments"
"name" : "Hosted Onboarding"
},
{
"name" : "PCI questionnaires"
Expand Down Expand Up @@ -3835,7 +3835,7 @@
"type" : {
"description" : "Type of identity data. For **individual**, the `type` value is **nationalIdNumber**.",
"enum" : [
"proofOfNationalIdNumber"
"nationalIdNumber"
],
"type" : "string"
}
Expand Down Expand Up @@ -4026,7 +4026,7 @@
"LegalEntityCapability" : {
"properties" : {
"allowed" : {
"description" : "Indicates whether the capability is allowed. Adyen sets this to **true** if the verification is successful ",
"description" : "Indicates whether the capability is allowed. Adyen sets this to **true** if the verification is successful.",
"readOnly" : true,
"type" : "boolean"
},
Expand All @@ -4042,7 +4042,7 @@
"type" : "string"
},
"allowedSettings" : {
"description" : "The settings that were allowed for the Legal Entity.",
"description" : "The settings that are allowed for the legal entity.",
"readOnly" : true,
"$ref" : "#/components/schemas/CapabilitySettings"
},
Expand All @@ -4055,7 +4055,7 @@
"type" : "array"
},
"requested" : {
"description" : "Indicates whether the capability is requested. To check whether the Legal Entity is permitted to use the capability, ",
"description" : "Indicates whether the capability is requested. To check whether the legal entity is permitted to use the capability, refer to the `allowed` field.",
"readOnly" : true,
"type" : "boolean"
},
Expand All @@ -4071,12 +4071,13 @@
"type" : "string"
},
"requestedSettings" : {
"description" : "The settings that are requested for the Legal Entity.",
"description" : "The settings that are requested for the legal entity.",
"readOnly" : true,
"$ref" : "#/components/schemas/CapabilitySettings"
},
"transferInstruments" : {
"description" : "Capability status for transfer instruments associated with legal entity",
"x-addedInVersion" : "2",
"description" : "The capability status of transfer instruments associated with the legal entity.",
"items" : {
"$ref" : "#/components/schemas/SupportingEntityCapability"
},
Expand Down Expand Up @@ -4236,7 +4237,7 @@
"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, this value is 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 than the country of their legal entity.\n\n",
"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 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"
},
"themeId" : {
Expand Down Expand Up @@ -4619,7 +4620,7 @@
"SupportingEntityCapability" : {
"properties" : {
"allowed" : {
"description" : "Indicates whether the supporting entity capability is allowed.\n\nIf a supporting entity is allowed but its parent legal entity is not, it means there are other supporting entities that failed validation.\n\n**The allowed supporting entity can still be used**",
"description" : "Indicates whether the capability is allowed for the supporting entity.\n\nIf a capability is allowed for a supporting entity but not for the parent legal entity, this means the legal entity has other supporting entities that failed verification.\n\n**You can use the allowed supporting entity** regardless of the verification status of other supporting entities.",
"readOnly" : true,
"type" : "boolean"
},
Expand All @@ -4634,7 +4635,7 @@
"type" : "boolean"
},
"verificationStatus" : {
"description" : "The status of the verification checks for the supporting entity capability.\n\nPossible values:\n\n* **pending**: Adyen is running the verification.\n\n* **invalid**: The verification failed. Check if the `errors` array contains more information.\n\n* **valid**: The verification has been successfully completed.\n\n* **rejected**: Adyen has verified the information, but found reasons to not allow the capability.\n",
"description" : "The status of the verification checks for the capability of the supporting entity.\n\nPossible values:\n\n* **pending**: Adyen is running the verification.\n\n* **invalid**: The verification failed. Check if the `errors` array contains more information.\n\n* **valid**: The verification has been successfully completed.\n\n* **rejected**: Adyen has verified the information, but found reasons to not allow the capability.\n",
"readOnly" : true,
"type" : "string"
}
Expand Down Expand Up @@ -5178,6 +5179,14 @@
"sendToTransferInstrument" : {
"allowed" : false,
"requested" : true,
"transferInstruments" : [
{
"allowed" : false,
"id" : "SE322KH223222F5GXZFNM3BGP",
"requested" : true,
"verificationStatus" : "pending"
}
],
"verificationStatus" : "pending"
},
"receivePayments" : {
Expand Down Expand Up @@ -5219,7 +5228,14 @@
}
},
"type" : "individual",
"id" : "LE00000000000000000000001"
"id" : "YOUR_LEGAL_ENTITY",
"transferInstruments" : [
{
"id" : "SE322KH223222F5GXZFNM3BGP",
"accountIdentifier" : "NL************0123",
"trustedSource" : false
}
]
}
},
"get-legalEntities-id-termsOfServiceAcceptanceInfos-success-200" : {
Expand Down Expand Up @@ -5307,16 +5323,26 @@
},
"get-transferInstruments-id-success-200" : {
"summary" : "Details of a transfer instrument",
"description" : "Example response when getting the details of a transfer instrument",
"description" : "Example response when getting the details of a new transfer instrument",
"value" : {
"bankAccount" : {
"accountIdentification" : {
"type" : "iban",
"iban" : "NL62ABNA0000000123"
},
"countryCode" : "NL",
"currencyCode" : "EUR",
"iban" : "NL62ABNA0000000123"
"currencyCode" : "EUR"
},
"legalEntityId" : "LE00000000000000000000001",
"type" : "bankAccount",
"id" : "SE322JV223222F5GNXSR89TMW"
"capabilities" : {
"sendToTransferInstrument" : {
"allowed" : false,
"requested" : true,
"verificationStatus" : "pending"
}
},
"id" : "SE322KH223222F5GXZFNM3BGP"
}
},
"patch-businessLines-id-updateBusinessLine" : {
Expand Down Expand Up @@ -5986,7 +6012,8 @@
"bankAccount" : {
"countryCode" : "NL",
"currencyCode" : "EUR",
"iban" : "NL62ABNA0000000123"
"iban" : "NL62ABNA0000000123",
"trustedSource" : false
}
}
},
Expand All @@ -6002,7 +6029,14 @@
},
"legalEntityId" : "LE00000000000000000000001",
"type" : "bankAccount",
"id" : "SE576BH223222F5GJVKHH6BDT"
"capabilities" : {
"sendToTransferInstrument" : {
"allowed" : false,
"requested" : true,
"verificationStatus" : "pending"
}
},
"id" : "SE322KH223222F5GXZFNM3BGP"
}
},
"post-transferInstruments-createTransferInstrumentUSD" : {
Expand Down Expand Up @@ -6034,6 +6068,13 @@
},
"legalEntityId" : "LE00000000000000000000001",
"type" : "bankAccount",
"capabilities" : {
"sendToTransferInstrument" : {
"allowed" : false,
"requested" : true,
"verificationStatus" : "pending"
}
},
"id" : "SE322JV223222F5GJVKHH8DTC"
}
}
Expand Down
Loading

0 comments on commit 1b58f92

Please sign in to comment.