From 45c4525f1c65a1c669399992ca585f9e9ee5ae39 Mon Sep 17 00:00:00 2001 From: Adyen Automation Date: Sat, 31 May 2025 10:10:43 +0200 Subject: [PATCH] spec release --- json/LegalEntityService-v1.json | 9 ++--- json/LegalEntityService-v2.json | 9 ++--- json/LegalEntityService-v3.json | 67 ++++++++++++++++++++++++++++++--- json/LegalEntityService-v4.json | 67 ++++++++++++++++++++++++++++++--- yaml/LegalEntityService-v1.yaml | 9 ++--- yaml/LegalEntityService-v2.yaml | 9 ++--- yaml/LegalEntityService-v3.yaml | 50 +++++++++++++++++++++--- yaml/LegalEntityService-v4.yaml | 50 +++++++++++++++++++++--- 8 files changed, 222 insertions(+), 48 deletions(-) diff --git a/json/LegalEntityService-v1.json b/json/LegalEntityService-v1.json index def814f..b2a64fe 100644 --- a/json/LegalEntityService-v1.json +++ b/json/LegalEntityService-v1.json @@ -4030,8 +4030,7 @@ "additionalProperties" : { "$ref" : "#/components/schemas/LegalEntityCapability" }, - "description" : "Contains key-value pairs that specify the actions that the legal entity can do in your platform.The key is a capability required for your integration. For example, **issueCard** for Issuing.The value is an object containing the settings for the capability.", - "readOnly" : true, + "description" : "Contains key-value pairs that specify the actions that the legal entity can do in your platform.The key is a capability required for your integration. For example, **issueCard** for Issuing. The value is an object containing the settings for the capability.", "type" : "object" }, "documents" : { @@ -4236,8 +4235,7 @@ "additionalProperties" : { "$ref" : "#/components/schemas/LegalEntityCapability" }, - "description" : "Contains key-value pairs that specify the actions that the legal entity can do in your platform.The key is a capability required for your integration. For example, **issueCard** for Issuing.The value is an object containing the settings for the capability.", - "readOnly" : true, + "description" : "Contains key-value pairs that specify the actions that the legal entity can do in your platform.The key is a capability required for your integration. For example, **issueCard** for Issuing. The value is an object containing the settings for the capability.", "type" : "object" }, "entityAssociations" : { @@ -4290,8 +4288,7 @@ "additionalProperties" : { "$ref" : "#/components/schemas/LegalEntityCapability" }, - "description" : "Contains key-value pairs that specify the actions that the legal entity can do in your platform.The key is a capability required for your integration. For example, **issueCard** for Issuing.The value is an object containing the settings for the capability.", - "readOnly" : true, + "description" : "Contains key-value pairs that specify the actions that the legal entity can do in your platform.The key is a capability required for your integration. For example, **issueCard** for Issuing. The value is an object containing the settings for the capability.", "type" : "object" }, "entityAssociations" : { diff --git a/json/LegalEntityService-v2.json b/json/LegalEntityService-v2.json index 95a7642..b887758 100644 --- a/json/LegalEntityService-v2.json +++ b/json/LegalEntityService-v2.json @@ -4455,8 +4455,7 @@ "additionalProperties" : { "$ref" : "#/components/schemas/LegalEntityCapability" }, - "description" : "Contains key-value pairs that specify the actions that the legal entity can do in your platform.The key is a capability required for your integration. For example, **issueCard** for Issuing.The value is an object containing the settings for the capability.", - "readOnly" : true, + "description" : "Contains key-value pairs that specify the actions that the legal entity can do in your platform.The key is a capability required for your integration. For example, **issueCard** for Issuing. The value is an object containing the settings for the capability.", "type" : "object" }, "documentDetails" : { @@ -4691,8 +4690,7 @@ "additionalProperties" : { "$ref" : "#/components/schemas/LegalEntityCapability" }, - "description" : "Contains key-value pairs that specify the actions that the legal entity can do in your platform.The key is a capability required for your integration. For example, **issueCard** for Issuing.The value is an object containing the settings for the capability.", - "readOnly" : true, + "description" : "Contains key-value pairs that specify the actions that the legal entity can do in your platform.The key is a capability required for your integration. For example, **issueCard** for Issuing. The value is an object containing the settings for the capability.", "type" : "object" }, "entityAssociations" : { @@ -4753,8 +4751,7 @@ "additionalProperties" : { "$ref" : "#/components/schemas/LegalEntityCapability" }, - "description" : "Contains key-value pairs that specify the actions that the legal entity can do in your platform.The key is a capability required for your integration. For example, **issueCard** for Issuing.The value is an object containing the settings for the capability.", - "readOnly" : true, + "description" : "Contains key-value pairs that specify the actions that the legal entity can do in your platform.The key is a capability required for your integration. For example, **issueCard** for Issuing. The value is an object containing the settings for the capability.", "type" : "object" }, "entityAssociations" : { diff --git a/json/LegalEntityService-v3.json b/json/LegalEntityService-v3.json index edc9d82..98e5492 100644 --- a/json/LegalEntityService-v3.json +++ b/json/LegalEntityService-v3.json @@ -928,6 +928,9 @@ "createLegalEntityOrganizationUS" : { "$ref" : "#/components/examples/post-legalEntities-createLegalEntityOrganizationUS" }, + "createLegalEntityPaymentInstrumentUser" : { + "$ref" : "#/components/examples/post-legalEntities-createLegalEntityPaymentInstrumentUser" + }, "createLegalEntitySolePropNL" : { "$ref" : "#/components/examples/post-legalEntities-createLegalEntitySolePropNL" }, @@ -978,6 +981,9 @@ "createLegalEntityOrganizationUS" : { "$ref" : "#/components/examples/post-legalEntities-createLegalEntityOrganizationUS-200" }, + "createLegalEntityPaymentInstrumentUser" : { + "$ref" : "#/components/examples/post-legalEntities-createLegalEntityPaymentInstrumentUser-200" + }, "createLegalEntitySolePropNL" : { "$ref" : "#/components/examples/post-legalEntities-createLegalEntitySolePropNL-200" }, @@ -4996,8 +5002,7 @@ "additionalProperties" : { "$ref" : "#/components/schemas/LegalEntityCapability" }, - "description" : "Contains key-value pairs that specify the actions that the legal entity can do in your platform.The key is a capability required for your integration. For example, **issueCard** for Issuing.The value is an object containing the settings for the capability.", - "readOnly" : true, + "description" : "Contains key-value pairs that specify the actions that the legal entity can do in your platform.The key is a capability required for your integration. For example, **issueCard** for Issuing. The value is an object containing the settings for the capability.", "type" : "object" }, "documentDetails" : { @@ -5243,8 +5248,7 @@ "additionalProperties" : { "$ref" : "#/components/schemas/LegalEntityCapability" }, - "description" : "Contains key-value pairs that specify the actions that the legal entity can do in your platform.The key is a capability required for your integration. For example, **issueCard** for Issuing.The value is an object containing the settings for the capability.", - "readOnly" : true, + "description" : "Contains key-value pairs that specify the actions that the legal entity can do in your platform.The key is a capability required for your integration. For example, **issueCard** for Issuing. The value is an object containing the settings for the capability.", "type" : "object" }, "entityAssociations" : { @@ -5305,8 +5309,7 @@ "additionalProperties" : { "$ref" : "#/components/schemas/LegalEntityCapability" }, - "description" : "Contains key-value pairs that specify the actions that the legal entity can do in your platform.The key is a capability required for your integration. For example, **issueCard** for Issuing.The value is an object containing the settings for the capability.", - "readOnly" : true, + "description" : "Contains key-value pairs that specify the actions that the legal entity can do in your platform.The key is a capability required for your integration. For example, **issueCard** for Issuing. The value is an object containing the settings for the capability.", "type" : "object" }, "entityAssociations" : { @@ -8036,6 +8039,58 @@ "id" : "LE00000000000000000000001" } }, + "post-legalEntities-createLegalEntityPaymentInstrumentUser" : { + "summary" : "Create an authorized user for an issued card.", + "description" : "Example request for creating an authorized user for an issued card", + "value" : { + "type" : "individual", + "individual" : { + "residentialAddress" : { + "country" : "NL" + }, + "name" : { + "firstName" : "John", + "lastName" : "Test" + }, + "birthData" : { + "dateOfBirth" : "1990-01-01" + } + }, + "capabilities" : { + "authorisedPaymentInstrumentUser" : { + "requested" : true, + "requestedLevel" : "notApplicable" + } + } + } + }, + "post-legalEntities-createLegalEntityPaymentInstrumentUser-200" : { + "summary" : "Authorized user for an issued card created.", + "description" : "Example response for creating an authorized user for an issued card", + "value" : { + "capabilities" : { + "authorisedPaymentInstrumentUser" : { + "allowed" : false, + "requested" : true, + "verificationStatus" : "pending" + } + }, + "individual" : { + "birthData" : { + "dateOfBirth" : "1990-01-01" + }, + "name" : { + "firstName" : "John", + "lastName" : "Test" + }, + "residentialAddress" : { + "country" : "NL" + } + }, + "type" : "individual", + "id" : "LE32DBK223226C5M7MSG8CPD2" + } + }, "post-legalEntities-createLegalEntitySolePropNL" : { "summary" : "Create a legal entity for a Dutch sole proprietor", "description" : "Example request for creating a legal entity for a sole proprietor operating in the Netherlands", diff --git a/json/LegalEntityService-v4.json b/json/LegalEntityService-v4.json index 01ec2db..14f7f2f 100644 --- a/json/LegalEntityService-v4.json +++ b/json/LegalEntityService-v4.json @@ -934,6 +934,9 @@ "createLegalEntityOrganizationUS" : { "$ref" : "#/components/examples/post-legalEntities-createLegalEntityOrganizationUS" }, + "createLegalEntityPaymentInstrumentUser" : { + "$ref" : "#/components/examples/post-legalEntities-createLegalEntityPaymentInstrumentUser" + }, "createLegalEntitySolePropNL" : { "$ref" : "#/components/examples/post-legalEntities-createLegalEntitySolePropNL" }, @@ -984,6 +987,9 @@ "createLegalEntityOrganizationUS" : { "$ref" : "#/components/examples/post-legalEntities-createLegalEntityOrganizationUS-200" }, + "createLegalEntityPaymentInstrumentUser" : { + "$ref" : "#/components/examples/post-legalEntities-createLegalEntityPaymentInstrumentUser-200" + }, "createLegalEntitySolePropNL" : { "$ref" : "#/components/examples/post-legalEntities-createLegalEntitySolePropNL-200" }, @@ -5014,8 +5020,7 @@ "additionalProperties" : { "$ref" : "#/components/schemas/LegalEntityCapability" }, - "description" : "Contains key-value pairs that specify the actions that the legal entity can do in your platform.The key is a capability required for your integration. For example, **issueCard** for Issuing.The value is an object containing the settings for the capability.", - "readOnly" : true, + "description" : "Contains key-value pairs that specify the actions that the legal entity can do in your platform.The key is a capability required for your integration. For example, **issueCard** for Issuing. The value is an object containing the settings for the capability.", "type" : "object" }, "documentDetails" : { @@ -5261,8 +5266,7 @@ "additionalProperties" : { "$ref" : "#/components/schemas/LegalEntityCapability" }, - "description" : "Contains key-value pairs that specify the actions that the legal entity can do in your platform.The key is a capability required for your integration. For example, **issueCard** for Issuing.The value is an object containing the settings for the capability.", - "readOnly" : true, + "description" : "Contains key-value pairs that specify the actions that the legal entity can do in your platform.The key is a capability required for your integration. For example, **issueCard** for Issuing. The value is an object containing the settings for the capability.", "type" : "object" }, "entityAssociations" : { @@ -5323,8 +5327,7 @@ "additionalProperties" : { "$ref" : "#/components/schemas/LegalEntityCapability" }, - "description" : "Contains key-value pairs that specify the actions that the legal entity can do in your platform.The key is a capability required for your integration. For example, **issueCard** for Issuing.The value is an object containing the settings for the capability.", - "readOnly" : true, + "description" : "Contains key-value pairs that specify the actions that the legal entity can do in your platform.The key is a capability required for your integration. For example, **issueCard** for Issuing. The value is an object containing the settings for the capability.", "type" : "object" }, "entityAssociations" : { @@ -8223,6 +8226,58 @@ "id" : "LE00000000000000000000001" } }, + "post-legalEntities-createLegalEntityPaymentInstrumentUser" : { + "summary" : "Create an authorized user for an issued card.", + "description" : "Example request for creating an authorized user for an issued card", + "value" : { + "type" : "individual", + "individual" : { + "residentialAddress" : { + "country" : "NL" + }, + "name" : { + "firstName" : "John", + "lastName" : "Test" + }, + "birthData" : { + "dateOfBirth" : "1990-01-01" + } + }, + "capabilities" : { + "authorisedPaymentInstrumentUser" : { + "requested" : true, + "requestedLevel" : "notApplicable" + } + } + } + }, + "post-legalEntities-createLegalEntityPaymentInstrumentUser-200" : { + "summary" : "Authorized user for an issued card created.", + "description" : "Example response for creating an authorized user for an issued card", + "value" : { + "capabilities" : { + "authorisedPaymentInstrumentUser" : { + "allowed" : false, + "requested" : true, + "verificationStatus" : "pending" + } + }, + "individual" : { + "birthData" : { + "dateOfBirth" : "1990-01-01" + }, + "name" : { + "firstName" : "John", + "lastName" : "Test" + }, + "residentialAddress" : { + "country" : "NL" + } + }, + "type" : "individual", + "id" : "LE32DBK223226C5M7MSG8CPD2" + } + }, "post-legalEntities-createLegalEntitySolePropNL" : { "summary" : "Create a legal entity for a Dutch sole proprietor", "description" : "Example request for creating a legal entity for a sole proprietor operating in the Netherlands", diff --git a/yaml/LegalEntityService-v1.yaml b/yaml/LegalEntityService-v1.yaml index 20bd5e6..76c30a2 100644 --- a/yaml/LegalEntityService-v1.yaml +++ b/yaml/LegalEntityService-v1.yaml @@ -2860,9 +2860,8 @@ components: $ref: '#/components/schemas/LegalEntityCapability' description: Contains key-value pairs that specify the actions that the legal entity can do in your platform.The key is a capability required - for your integration. For example, **issueCard** for Issuing.The value + for your integration. For example, **issueCard** for Issuing. The value is an object containing the settings for the capability. - readOnly: true type: object documents: deprecated: true @@ -3107,9 +3106,8 @@ components: $ref: '#/components/schemas/LegalEntityCapability' description: Contains key-value pairs that specify the actions that the legal entity can do in your platform.The key is a capability required - for your integration. For example, **issueCard** for Issuing.The value + for your integration. For example, **issueCard** for Issuing. The value is an object containing the settings for the capability. - readOnly: true type: object entityAssociations: description: 'List of legal entities associated with the current legal entity. @@ -3156,9 +3154,8 @@ components: $ref: '#/components/schemas/LegalEntityCapability' description: Contains key-value pairs that specify the actions that the legal entity can do in your platform.The key is a capability required - for your integration. For example, **issueCard** for Issuing.The value + for your integration. For example, **issueCard** for Issuing. The value is an object containing the settings for the capability. - readOnly: true type: object entityAssociations: description: 'List of legal entities associated with the current legal entity. diff --git a/yaml/LegalEntityService-v2.yaml b/yaml/LegalEntityService-v2.yaml index cddc560..0c48bca 100644 --- a/yaml/LegalEntityService-v2.yaml +++ b/yaml/LegalEntityService-v2.yaml @@ -3174,9 +3174,8 @@ components: $ref: '#/components/schemas/LegalEntityCapability' description: Contains key-value pairs that specify the actions that the legal entity can do in your platform.The key is a capability required - for your integration. For example, **issueCard** for Issuing.The value + for your integration. For example, **issueCard** for Issuing. The value is an object containing the settings for the capability. - readOnly: true type: object documentDetails: x-addedInVersion: '2' @@ -3451,9 +3450,8 @@ components: $ref: '#/components/schemas/LegalEntityCapability' description: Contains key-value pairs that specify the actions that the legal entity can do in your platform.The key is a capability required - for your integration. For example, **issueCard** for Issuing.The value + for your integration. For example, **issueCard** for Issuing. The value is an object containing the settings for the capability. - readOnly: true type: object entityAssociations: description: 'List of legal entities associated with the current legal entity. @@ -3511,9 +3509,8 @@ components: $ref: '#/components/schemas/LegalEntityCapability' description: Contains key-value pairs that specify the actions that the legal entity can do in your platform.The key is a capability required - for your integration. For example, **issueCard** for Issuing.The value + for your integration. For example, **issueCard** for Issuing. The value is an object containing the settings for the capability. - readOnly: true type: object entityAssociations: description: 'List of legal entities associated with the current legal entity. diff --git a/yaml/LegalEntityService-v3.yaml b/yaml/LegalEntityService-v3.yaml index 1e58547..9f90082 100644 --- a/yaml/LegalEntityService-v3.yaml +++ b/yaml/LegalEntityService-v3.yaml @@ -592,6 +592,8 @@ paths: $ref: '#/components/examples/post-legalEntities-createLegalEntityOrganizationNL' createLegalEntityOrganizationUS: $ref: '#/components/examples/post-legalEntities-createLegalEntityOrganizationUS' + createLegalEntityPaymentInstrumentUser: + $ref: '#/components/examples/post-legalEntities-createLegalEntityPaymentInstrumentUser' createLegalEntitySolePropNL: $ref: '#/components/examples/post-legalEntities-createLegalEntitySolePropNL' createLegalEntitySolePropUS: @@ -626,6 +628,8 @@ paths: $ref: '#/components/examples/post-legalEntities-createLegalEntityOrganizationNL-200' createLegalEntityOrganizationUS: $ref: '#/components/examples/post-legalEntities-createLegalEntityOrganizationUS-200' + createLegalEntityPaymentInstrumentUser: + $ref: '#/components/examples/post-legalEntities-createLegalEntityPaymentInstrumentUser-200' createLegalEntitySolePropNL: $ref: '#/components/examples/post-legalEntities-createLegalEntitySolePropNL-200' createLegalEntitySolePropUS: @@ -3576,9 +3580,8 @@ components: $ref: '#/components/schemas/LegalEntityCapability' description: Contains key-value pairs that specify the actions that the legal entity can do in your platform.The key is a capability required - for your integration. For example, **issueCard** for Issuing.The value + for your integration. For example, **issueCard** for Issuing. The value is an object containing the settings for the capability. - readOnly: true type: object documentDetails: x-addedInVersion: '2' @@ -3863,9 +3866,8 @@ components: $ref: '#/components/schemas/LegalEntityCapability' description: Contains key-value pairs that specify the actions that the legal entity can do in your platform.The key is a capability required - for your integration. For example, **issueCard** for Issuing.The value + for your integration. For example, **issueCard** for Issuing. The value is an object containing the settings for the capability. - readOnly: true type: object entityAssociations: description: 'List of legal entities associated with the current legal entity. @@ -3923,9 +3925,8 @@ components: $ref: '#/components/schemas/LegalEntityCapability' description: Contains key-value pairs that specify the actions that the legal entity can do in your platform.The key is a capability required - for your integration. For example, **issueCard** for Issuing.The value + for your integration. For example, **issueCard** for Issuing. The value is an object containing the settings for the capability. - readOnly: true type: object entityAssociations: description: 'List of legal entities associated with the current legal entity. @@ -6384,6 +6385,43 @@ components: type: privateCompany type: organization id: LE00000000000000000000001 + post-legalEntities-createLegalEntityPaymentInstrumentUser: + summary: Create an authorized user for an issued card. + description: Example request for creating an authorized user for an issued card + value: + type: individual + individual: + residentialAddress: + country: NL + name: + firstName: John + lastName: Test + birthData: + dateOfBirth: '1990-01-01' + capabilities: + authorisedPaymentInstrumentUser: + requested: true + requestedLevel: notApplicable + post-legalEntities-createLegalEntityPaymentInstrumentUser-200: + summary: Authorized user for an issued card created. + description: Example response for creating an authorized user for an issued + card + value: + capabilities: + authorisedPaymentInstrumentUser: + allowed: false + requested: true + verificationStatus: pending + individual: + birthData: + dateOfBirth: '1990-01-01' + name: + firstName: John + lastName: Test + residentialAddress: + country: NL + type: individual + id: LE32DBK223226C5M7MSG8CPD2 post-legalEntities-createLegalEntitySolePropNL: summary: Create a legal entity for a Dutch sole proprietor description: Example request for creating a legal entity for a sole proprietor diff --git a/yaml/LegalEntityService-v4.yaml b/yaml/LegalEntityService-v4.yaml index fd2cc01..33b53cd 100644 --- a/yaml/LegalEntityService-v4.yaml +++ b/yaml/LegalEntityService-v4.yaml @@ -596,6 +596,8 @@ paths: $ref: '#/components/examples/post-legalEntities-createLegalEntityOrganizationNL' createLegalEntityOrganizationUS: $ref: '#/components/examples/post-legalEntities-createLegalEntityOrganizationUS' + createLegalEntityPaymentInstrumentUser: + $ref: '#/components/examples/post-legalEntities-createLegalEntityPaymentInstrumentUser' createLegalEntitySolePropNL: $ref: '#/components/examples/post-legalEntities-createLegalEntitySolePropNL' createLegalEntitySolePropUS: @@ -630,6 +632,8 @@ paths: $ref: '#/components/examples/post-legalEntities-createLegalEntityOrganizationNL-200' createLegalEntityOrganizationUS: $ref: '#/components/examples/post-legalEntities-createLegalEntityOrganizationUS-200' + createLegalEntityPaymentInstrumentUser: + $ref: '#/components/examples/post-legalEntities-createLegalEntityPaymentInstrumentUser-200' createLegalEntitySolePropNL: $ref: '#/components/examples/post-legalEntities-createLegalEntitySolePropNL-200' createLegalEntitySolePropUS: @@ -3584,9 +3588,8 @@ components: $ref: '#/components/schemas/LegalEntityCapability' description: Contains key-value pairs that specify the actions that the legal entity can do in your platform.The key is a capability required - for your integration. For example, **issueCard** for Issuing.The value + for your integration. For example, **issueCard** for Issuing. The value is an object containing the settings for the capability. - readOnly: true type: object documentDetails: x-addedInVersion: '2' @@ -3871,9 +3874,8 @@ components: $ref: '#/components/schemas/LegalEntityCapability' description: Contains key-value pairs that specify the actions that the legal entity can do in your platform.The key is a capability required - for your integration. For example, **issueCard** for Issuing.The value + for your integration. For example, **issueCard** for Issuing. The value is an object containing the settings for the capability. - readOnly: true type: object entityAssociations: description: 'List of legal entities associated with the current legal entity. @@ -3931,9 +3933,8 @@ components: $ref: '#/components/schemas/LegalEntityCapability' description: Contains key-value pairs that specify the actions that the legal entity can do in your platform.The key is a capability required - for your integration. For example, **issueCard** for Issuing.The value + for your integration. For example, **issueCard** for Issuing. The value is an object containing the settings for the capability. - readOnly: true type: object entityAssociations: description: 'List of legal entities associated with the current legal entity. @@ -6606,6 +6607,43 @@ components: type: privateCompany type: organization id: LE00000000000000000000001 + post-legalEntities-createLegalEntityPaymentInstrumentUser: + summary: Create an authorized user for an issued card. + description: Example request for creating an authorized user for an issued card + value: + type: individual + individual: + residentialAddress: + country: NL + name: + firstName: John + lastName: Test + birthData: + dateOfBirth: '1990-01-01' + capabilities: + authorisedPaymentInstrumentUser: + requested: true + requestedLevel: notApplicable + post-legalEntities-createLegalEntityPaymentInstrumentUser-200: + summary: Authorized user for an issued card created. + description: Example response for creating an authorized user for an issued + card + value: + capabilities: + authorisedPaymentInstrumentUser: + allowed: false + requested: true + verificationStatus: pending + individual: + birthData: + dateOfBirth: '1990-01-01' + name: + firstName: John + lastName: Test + residentialAddress: + country: NL + type: individual + id: LE32DBK223226C5M7MSG8CPD2 post-legalEntities-createLegalEntitySolePropNL: summary: Create a legal entity for a Dutch sole proprietor description: Example request for creating a legal entity for a sole proprietor