From 1b58f92d21ed046904c6c83e3e24eced452c06f9 Mon Sep 17 00:00:00 2001 From: Adyen Automation Date: Tue, 17 Oct 2023 22:37:31 +0200 Subject: [PATCH] spec release --- json/LegalEntityService-v1.json | 49 +++------------ json/LegalEntityService-v2.json | 77 +++++++++++++++++------ json/LegalEntityService-v3.json | 78 +++++++++++++++++------ yaml/LegalEntityService-v1.yaml | 94 +++++++++------------------ yaml/LegalEntityService-v2.yaml | 98 ++++++++++++++++++++++------- yaml/LegalEntityService-v3.yaml | 108 +++++++++++++++++++++++--------- 6 files changed, 307 insertions(+), 197 deletions(-) diff --git a/json/LegalEntityService-v1.json b/json/LegalEntityService-v1.json index 3afcf6f1..baac4a8f 100644 --- a/json/LegalEntityService-v1.json +++ b/json/LegalEntityService-v1.json @@ -30,7 +30,7 @@ "name" : "Legal entities" }, { - "name" : "Hosted Onboarding" + "name" : "Transfer instruments" }, { "name" : "Business lines" @@ -42,7 +42,7 @@ "name" : "Terms of Service" }, { - "name" : "Transfer instruments" + "name" : "Hosted Onboarding" }, { "name" : "PCI questionnaires" @@ -3598,7 +3598,7 @@ "type" : { "description" : "Type of identity data. For **individual**, the `type` value is **nationalIdNumber**.", "enum" : [ - "proofOfNationalIdNumber" + "nationalIdNumber" ], "type" : "string" } @@ -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" }, @@ -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" }, @@ -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" }, @@ -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, @@ -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" : { @@ -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" : { diff --git a/json/LegalEntityService-v2.json b/json/LegalEntityService-v2.json index 9ea48128..acaf519b 100644 --- a/json/LegalEntityService-v2.json +++ b/json/LegalEntityService-v2.json @@ -30,7 +30,7 @@ "name" : "Legal entities" }, { - "name" : "Hosted Onboarding" + "name" : "Transfer instruments" }, { "name" : "Business lines" @@ -42,7 +42,7 @@ "name" : "Terms of Service" }, { - "name" : "Transfer instruments" + "name" : "Hosted Onboarding" }, { "name" : "PCI questionnaires" @@ -3835,7 +3835,7 @@ "type" : { "description" : "Type of identity data. For **individual**, the `type` value is **nationalIdNumber**.", "enum" : [ - "proofOfNationalIdNumber" + "nationalIdNumber" ], "type" : "string" } @@ -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" }, @@ -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" }, @@ -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" }, @@ -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" }, @@ -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" : { @@ -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" }, @@ -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" } @@ -5178,6 +5179,14 @@ "sendToTransferInstrument" : { "allowed" : false, "requested" : true, + "transferInstruments" : [ + { + "allowed" : false, + "id" : "SE322KH223222F5GXZFNM3BGP", + "requested" : true, + "verificationStatus" : "pending" + } + ], "verificationStatus" : "pending" }, "receivePayments" : { @@ -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" : { @@ -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" : { @@ -5986,7 +6012,8 @@ "bankAccount" : { "countryCode" : "NL", "currencyCode" : "EUR", - "iban" : "NL62ABNA0000000123" + "iban" : "NL62ABNA0000000123", + "trustedSource" : false } } }, @@ -6002,7 +6029,14 @@ }, "legalEntityId" : "LE00000000000000000000001", "type" : "bankAccount", - "id" : "SE576BH223222F5GJVKHH6BDT" + "capabilities" : { + "sendToTransferInstrument" : { + "allowed" : false, + "requested" : true, + "verificationStatus" : "pending" + } + }, + "id" : "SE322KH223222F5GXZFNM3BGP" } }, "post-transferInstruments-createTransferInstrumentUSD" : { @@ -6034,6 +6068,13 @@ }, "legalEntityId" : "LE00000000000000000000001", "type" : "bankAccount", + "capabilities" : { + "sendToTransferInstrument" : { + "allowed" : false, + "requested" : true, + "verificationStatus" : "pending" + } + }, "id" : "SE322JV223222F5GJVKHH8DTC" } } diff --git a/json/LegalEntityService-v3.json b/json/LegalEntityService-v3.json index f2a0bc3b..2545e6c5 100644 --- a/json/LegalEntityService-v3.json +++ b/json/LegalEntityService-v3.json @@ -30,7 +30,7 @@ "name" : "Legal entities" }, { - "name" : "Hosted Onboarding" + "name" : "Transfer instruments" }, { "name" : "Business lines" @@ -42,7 +42,7 @@ "name" : "Terms of Service" }, { - "name" : "Transfer instruments" + "name" : "Hosted Onboarding" }, { "name" : "PCI questionnaires" @@ -3412,7 +3412,7 @@ }, "problems" : { "x-addedInVersion" : "3", - "description" : "List of the verification errors from capabilities for this supporting entity.", + "description" : "The verification errors related to capabilities for this supporting entity.", "items" : { "$ref" : "#/components/schemas/CapabilityProblem" }, @@ -4134,8 +4134,8 @@ "additionalProperties" : false, "properties" : { "accountNumber" : { - "description" : "The 9- to 12-character bank account number (alphanumeric), without separators or whitespace. Starts with the 3-digit branch code.", - "maxLength" : 12, + "description" : "The 9- to 15-character bank account number (alphanumeric), without separators or whitespace. Starts with the 3-digit branch code.", + "maxLength" : 15, "minLength" : 9, "type" : "string" }, @@ -4240,7 +4240,7 @@ "type" : { "description" : "Type of identity data. For **individual**, the `type` value is **nationalIdNumber**.", "enum" : [ - "proofOfNationalIdNumber" + "nationalIdNumber" ], "type" : "string" } @@ -4351,7 +4351,7 @@ }, "problems" : { "x-addedInVersion" : "3", - "description" : "List of the verification errors from capabilities for the legal entity.", + "description" : "List of verification errors related to capabilities for the legal entity.", "items" : { "$ref" : "#/components/schemas/CapabilityProblem" }, @@ -4448,7 +4448,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" }, @@ -4464,12 +4464,12 @@ "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" }, "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" }, @@ -4485,12 +4485,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" }, @@ -4732,7 +4733,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" : { @@ -5203,7 +5204,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" }, @@ -5218,7 +5219,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" } @@ -5332,7 +5333,7 @@ "additionalProperties" : { "$ref" : "#/components/schemas/SupportingEntityCapability" }, - "description" : "List of capabilities for this supporting entity.", + "description" : "List of capabilities for this transfer instrument.", "type" : "object" }, "documentDetails" : { @@ -5354,7 +5355,7 @@ }, "problems" : { "x-addedInVersion" : "3", - "description" : "List of the verification errors from capabilities for this supporting entity.", + "description" : "The verification errors related to capabilities for this transfer instrument.", "items" : { "$ref" : "#/components/schemas/CapabilityProblem" }, @@ -5945,6 +5946,14 @@ "sendToTransferInstrument" : { "allowed" : false, "requested" : true, + "transferInstruments" : [ + { + "allowed" : false, + "id" : "SE322KH223222F5GXZFNM3BGP", + "requested" : true, + "verificationStatus" : "pending" + } + ], "verificationStatus" : "pending" }, "receivePayments" : { @@ -5986,7 +5995,14 @@ } }, "type" : "individual", - "id" : "LE00000000000000000000001" + "id" : "YOUR_LEGAL_ENTITY", + "transferInstruments" : [ + { + "id" : "SE322KH223222F5GXZFNM3BGP", + "accountIdentifier" : "NL************0123", + "trustedSource" : false + } + ] } }, "get-legalEntities-id-termsOfServiceAcceptanceInfos-success-200" : { @@ -6074,17 +6090,25 @@ }, "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" + "countryCode" : "NL", + "currencyCode" : "EUR" }, "legalEntityId" : "LE00000000000000000000001", "type" : "bankAccount", + "capabilities" : { + "sendToTransferInstrument" : { + "allowed" : false, + "requested" : true, + "verificationStatus" : "pending" + } + }, "id" : "SE322KH223222F5GXZFNM3BGP" } }, @@ -6996,6 +7020,13 @@ }, "legalEntityId" : "LE00000000000000000000001", "type" : "bankAccount", + "capabilities" : { + "sendToTransferInstrument" : { + "allowed" : false, + "requested" : true, + "verificationStatus" : "pending" + } + }, "id" : "SE322KH223222F5GXZFNM3BGP" } }, @@ -7030,6 +7061,13 @@ }, "legalEntityId" : "LE00000000000000000000001", "type" : "bankAccount", + "capabilities" : { + "sendToTransferInstrument" : { + "allowed" : false, + "requested" : true, + "verificationStatus" : "pending" + } + }, "id" : "SE322JV223222F5GJVKHH8DTC" } } diff --git a/yaml/LegalEntityService-v1.yaml b/yaml/LegalEntityService-v1.yaml index fd7bb241..2b599c63 100644 --- a/yaml/LegalEntityService-v1.yaml +++ b/yaml/LegalEntityService-v1.yaml @@ -36,11 +36,11 @@ x-groups: - PCI questionnaires tags: - name: Legal entities -- name: Hosted Onboarding +- name: Transfer instruments - name: Business lines - name: Documents - name: Terms of Service -- name: Transfer instruments +- name: Hosted Onboarding - name: PCI questionnaires paths: /businessLines: @@ -2446,7 +2446,7 @@ components: description: Type of identity data. For **individual**, the `type` value is **nationalIdNumber**. enum: - - proofOfNationalIdNumber + - nationalIdNumber type: string required: - type @@ -2596,8 +2596,8 @@ components: 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 allowedLevel: @@ -2613,7 +2613,7 @@ components: readOnly: true 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' problems: @@ -2624,8 +2624,9 @@ components: readOnly: true 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 requestedLevel: @@ -2644,16 +2645,9 @@ components: readOnly: true 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. @@ -2815,8 +2809,8 @@ components: entity''s address, for example the registered address of an organization. - By default, this value is set to **false**. Set to **true** to allow the - action. + By default, these values are set to **false**. Set to **true** to allow + the action. - **allowBankAccountFormatSelection**: The user can select the format @@ -2828,6 +2822,24 @@ components: entity. + By 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. + + + - **requirePciSignEcommerce** + + + - **requirePciSignPos** + + + - **requirePciSignEcomMoto** + + + - **requirePciSignPosMoto** + + ' type: object themeId: @@ -3093,52 +3105,6 @@ components: description: The stock ticker symbol. type: string type: object - SupportingEntityCapability: - properties: - allowed: - description: 'Indicates whether the supporting entity capability is allowed. - - - If a supporting entity is allowed but its parent legal entity is not, - it means there are other supporting entities that failed validation. - - - **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. - - - Possible values: - - - * **pending**: Adyen is running the verification. - - - * **invalid**: The verification failed. Check if the `errors` array contains - more information. - - - * **valid**: The verification has been successfully completed. - - - * **rejected**: Adyen has verified the information, but found reasons - to not allow the capability. - - ' - readOnly: true - type: string - type: object TermsOfServiceAcceptanceInfo: properties: acceptedBy: diff --git a/yaml/LegalEntityService-v2.yaml b/yaml/LegalEntityService-v2.yaml index 84a79dcc..dbf0f239 100644 --- a/yaml/LegalEntityService-v2.yaml +++ b/yaml/LegalEntityService-v2.yaml @@ -36,11 +36,11 @@ x-groups: - PCI questionnaires tags: - name: Legal entities -- name: Hosted Onboarding +- name: Transfer instruments - name: Business lines - name: Documents - name: Terms of Service -- name: Transfer instruments +- name: Hosted Onboarding - name: PCI questionnaires paths: /businessLines: @@ -2624,7 +2624,7 @@ components: description: Type of identity data. For **individual**, the `type` value is **nationalIdNumber**. enum: - - proofOfNationalIdNumber + - nationalIdNumber type: string required: - type @@ -2797,8 +2797,8 @@ components: 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 allowedLevel: @@ -2814,7 +2814,7 @@ components: readOnly: true 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' problems: @@ -2825,8 +2825,9 @@ components: readOnly: true 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 requestedLevel: @@ -2845,12 +2846,13 @@ components: readOnly: true 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' readOnly: true @@ -3032,8 +3034,8 @@ components: entity''s address, for example the registered address of an organization. - By default, this value is set to **false**. Set to **true** to allow the - action. + By default, these values are set to **false**. Set to **true** to allow + the action. - **allowBankAccountFormatSelection**: The user can select the format @@ -3045,6 +3047,24 @@ components: entity. + By 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. + + + - **requirePciSignEcommerce** + + + - **requirePciSignPos** + + + - **requirePciSignEcomMoto** + + + - **requirePciSignPosMoto** + + ' type: object themeId: @@ -3365,14 +3385,17 @@ components: SupportingEntityCapability: properties: allowed: - description: 'Indicates whether the supporting entity capability is allowed. + description: 'Indicates whether the capability is allowed for the supporting + entity. - If a supporting entity is allowed but its parent legal entity is not, - it means there are other supporting entities that failed validation. + If 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. - **The allowed supporting entity can still be used**' + **You can use the allowed supporting entity** regardless of the verification + status of other supporting entities.' readOnly: true type: boolean id: @@ -3384,8 +3407,8 @@ components: readOnly: true type: boolean verificationStatus: - description: 'The status of the verification checks for the supporting entity - capability. + description: 'The status of the verification checks for the capability of + the supporting entity. Possible values: @@ -3865,6 +3888,11 @@ components: sendToTransferInstrument: allowed: false requested: true + transferInstruments: + - allowed: false + id: SE322KH223222F5GXZFNM3BGP + requested: true + verificationStatus: pending verificationStatus: pending receivePayments: allowed: false @@ -3896,7 +3924,11 @@ components: street: Simon Carmiggeltstraat 6 - 50 street2: '274' type: individual - id: LE00000000000000000000001 + id: YOUR_LEGAL_ENTITY + transferInstruments: + - id: SE322KH223222F5GXZFNM3BGP + accountIdentifier: NL************0123 + trustedSource: false get-legalEntities-id-termsOfServiceAcceptanceInfos-success-200: summary: Terms of Service information for a legal entity description: Example response when getting Terms of Service information for @@ -3963,15 +3995,22 @@ components: updatedAt: '2022-08-25T00:00:00+02:00' 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 legalEntityId: LE00000000000000000000001 type: bankAccount - id: SE322JV223222F5GNXSR89TMW + capabilities: + sendToTransferInstrument: + allowed: false + requested: true + verificationStatus: pending + id: SE322KH223222F5GXZFNM3BGP patch-businessLines-id-updateBusinessLine: summary: Update a business line description: Example request for updating the industry code of a business line @@ -4481,6 +4520,7 @@ components: countryCode: NL currencyCode: EUR iban: NL62ABNA0000000123 + trustedSource: false post-transferInstruments-createTransferInstrumentEUR-200: summary: Bank account added description: Example response for adding a bank account as a transfer instrument @@ -4493,7 +4533,12 @@ components: trustedSource: false legalEntityId: LE00000000000000000000001 type: bankAccount - id: SE576BH223222F5GJVKHH6BDT + capabilities: + sendToTransferInstrument: + allowed: false + requested: true + verificationStatus: pending + id: SE322KH223222F5GXZFNM3BGP post-transferInstruments-createTransferInstrumentUSD: summary: Add a USD bank account description: Example request for creating a transfer instrument for USD @@ -4520,4 +4565,9 @@ components: trustedSource: false legalEntityId: LE00000000000000000000001 type: bankAccount + capabilities: + sendToTransferInstrument: + allowed: false + requested: true + verificationStatus: pending id: SE322JV223222F5GJVKHH8DTC diff --git a/yaml/LegalEntityService-v3.yaml b/yaml/LegalEntityService-v3.yaml index 317cec8b..873f48d5 100644 --- a/yaml/LegalEntityService-v3.yaml +++ b/yaml/LegalEntityService-v3.yaml @@ -36,11 +36,11 @@ x-groups: - PCI questionnaires tags: - name: Legal entities -- name: Hosted Onboarding +- name: Transfer instruments - name: Business lines - name: Documents - name: Terms of Service -- name: Transfer instruments +- name: Hosted Onboarding - name: PCI questionnaires paths: /businessLines: @@ -2202,8 +2202,8 @@ components: type: string problems: x-addedInVersion: '3' - description: List of the verification errors from capabilities for this - supporting entity. + description: The verification errors related to capabilities for this supporting + entity. items: $ref: '#/components/schemas/CapabilityProblem' type: array @@ -2834,9 +2834,9 @@ components: additionalProperties: false properties: accountNumber: - description: The 9- to 12-character bank account number (alphanumeric), + description: The 9- to 15-character bank account number (alphanumeric), without separators or whitespace. Starts with the 3-digit branch code. - maxLength: 12 + maxLength: 15 minLength: 9 type: string clearingCode: @@ -2921,7 +2921,7 @@ components: description: Type of identity data. For **individual**, the `type` value is **nationalIdNumber**. enum: - - proofOfNationalIdNumber + - nationalIdNumber type: string required: - type @@ -3009,8 +3009,8 @@ components: $ref: '#/components/schemas/Organization' problems: x-addedInVersion: '3' - description: List of the verification errors from capabilities for the legal - entity. + description: List of verification errors related to capabilities for the + legal entity. items: $ref: '#/components/schemas/CapabilityProblem' type: array @@ -3109,8 +3109,8 @@ components: 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 allowedLevel: @@ -3126,12 +3126,13 @@ components: readOnly: true 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' 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 requestedLevel: @@ -3150,12 +3151,13 @@ components: readOnly: true 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' readOnly: true @@ -3403,8 +3405,8 @@ components: entity''s address, for example the registered address of an organization. - By default, this value is set to **false**. Set to **true** to allow the - action. + By default, these values are set to **false**. Set to **true** to allow + the action. - **allowBankAccountFormatSelection**: The user can select the format @@ -3416,6 +3418,24 @@ components: entity. + By 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. + + + - **requirePciSignEcommerce** + + + - **requirePciSignPos** + + + - **requirePciSignEcomMoto** + + + - **requirePciSignPosMoto** + + ' type: object themeId: @@ -3808,14 +3828,17 @@ components: SupportingEntityCapability: properties: allowed: - description: 'Indicates whether the supporting entity capability is allowed. + description: 'Indicates whether the capability is allowed for the supporting + entity. - If a supporting entity is allowed but its parent legal entity is not, - it means there are other supporting entities that failed validation. + If 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. - **The allowed supporting entity can still be used**' + **You can use the allowed supporting entity** regardless of the verification + status of other supporting entities.' readOnly: true type: boolean id: @@ -3827,8 +3850,8 @@ components: readOnly: true type: boolean verificationStatus: - description: 'The status of the verification checks for the supporting entity - capability. + description: 'The status of the verification checks for the capability of + the supporting entity. Possible values: @@ -3954,7 +3977,7 @@ components: x-addedInVersion: '3' additionalProperties: $ref: '#/components/schemas/SupportingEntityCapability' - description: List of capabilities for this supporting entity. + description: List of capabilities for this transfer instrument. type: object documentDetails: x-addedInVersion: '2' @@ -3972,8 +3995,8 @@ components: type: string problems: x-addedInVersion: '3' - description: List of the verification errors from capabilities for this - supporting entity. + description: The verification errors related to capabilities for this transfer + instrument. items: $ref: '#/components/schemas/CapabilityProblem' type: array @@ -4466,6 +4489,11 @@ components: sendToTransferInstrument: allowed: false requested: true + transferInstruments: + - allowed: false + id: SE322KH223222F5GXZFNM3BGP + requested: true + verificationStatus: pending verificationStatus: pending receivePayments: allowed: false @@ -4497,7 +4525,11 @@ components: street: Simon Carmiggeltstraat 6 - 50 street2: '274' type: individual - id: LE00000000000000000000001 + id: YOUR_LEGAL_ENTITY + transferInstruments: + - id: SE322KH223222F5GXZFNM3BGP + accountIdentifier: NL************0123 + trustedSource: false get-legalEntities-id-termsOfServiceAcceptanceInfos-success-200: summary: Terms of Service information for a legal entity description: Example response when getting Terms of Service information for @@ -4564,15 +4596,21 @@ components: updatedAt: '2022-08-25T00:00:00+02:00' 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 legalEntityId: LE00000000000000000000001 type: bankAccount + capabilities: + sendToTransferInstrument: + allowed: false + requested: true + verificationStatus: pending id: SE322KH223222F5GXZFNM3BGP patch-businessLines-id-updateBusinessLine: summary: Update a business line @@ -5235,6 +5273,11 @@ components: trustedSource: false legalEntityId: LE00000000000000000000001 type: bankAccount + capabilities: + sendToTransferInstrument: + allowed: false + requested: true + verificationStatus: pending id: SE322KH223222F5GXZFNM3BGP post-transferInstruments-createTransferInstrumentUSD: summary: Add a USD bank account @@ -5262,4 +5305,9 @@ components: trustedSource: false legalEntityId: LE00000000000000000000001 type: bankAccount + capabilities: + sendToTransferInstrument: + allowed: false + requested: true + verificationStatus: pending id: SE322JV223222F5GJVKHH8DTC