jlengrand/adyen-openapi
1
0
Fork 0
mirror of https://github.com/gcatanese/adyen-openapi.git synced 2026-03-10 08:01:24 +00:00
Code Issues Packages Projects Releases Wiki Activity

spec release

Browse Source
This commit is contained in:
Adyen Automation
2023-12-04 11:17:27 +01:00
parent d0ceae3890
commit 2181f50023
6 changed files with 468 additions and 24 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
json/LegalEntityService-v1.json
View File

@@ -4429,7 +4429,7 @@
"type" : "string"
},
"realLastFour" : {
"description" : "Four last digits of the bank account number.",
"description" : "Four last digits of the bank account number. If the transfer instrument is created using [instant bank account verification](https://docs.adyen.com/release-notes/platforms-and-financial-products#releaseNote=2023-05-08-hosted-onboarding), and it is a virtual bank account, these digits may be different from the last four digits of the masked account number.",
"type" : "string"
},
"trustedSource" : {

122
json/LegalEntityService-v2.json
View File

@@ -1390,6 +1390,108 @@
}
}
},
"/legalEntities/{id}/confirmDataReview" : {
"post" : {
"tags" : [
"Legal entities"
],
"summary" : "Confirm data review",
"description" : "Confirms that your user has reviewed the data for the legal entity specified in the path. Call this endpoint to inform Adyen that your user reviewed and verified that the data is up-to-date. The endpoint returns the timestamp of when Adyen received the request.",
"x-addedInVersion" : "2",
"operationId" : "post-legalEntities-id-confirmDataReview",
"x-groupName" : "Legal entities",
"x-sortIndex" : 22,
"x-methodName" : "confirmDataReview",
"security" : [
{
"BasicAuth" : [
]
},
{
"ApiKeyAuth" : [
]
}
],
"parameters" : [
{
"description" : "The unique identifier of the legal entity.",
"name" : "id",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
}
}
],
"responses" : {
"200" : {
"content" : {
"application/json" : {
"examples" : {
"confirmDataReview" : {
"$ref" : "#/components/examples/post-legalEntities-id-confirmDataReview-confirmDataReview-200"
}
},
"schema" : {
"$ref" : "#/components/schemas/DataReviewConfirmationResponse"
}
}
},
"description" : "OK - the request has succeeded."
},
"400" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Bad Request - a problem reading or understanding the request."
},
"401" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Unauthorized - authentication required."
},
"403" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Forbidden - insufficient permissions to process the request."
},
"422" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Unprocessable Entity - a request validation error."
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Internal Server Error - the server could not process the request."
}
}
}
},
"/legalEntities/{id}/onboardingLinks" : {
"post" : {
"tags" : [
@@ -3521,6 +3623,15 @@
},
"type" : "object"
},
"DataReviewConfirmationResponse" : {
"properties" : {
"dataReviewedAt" : {
"description" : "Date when data review was confirmed.",
"type" : "string"
}
},
"type" : "object"
},
"Document" : {
"properties" : {
"attachment" : {
@@ -4891,7 +5002,7 @@
"type" : "string"
},
"realLastFour" : {
"description" : "Four last digits of the bank account number.",
"description" : "Four last digits of the bank account number. If the transfer instrument is created using [instant bank account verification](https://docs.adyen.com/release-notes/platforms-and-financial-products#releaseNote=2023-05-08-hosted-onboarding), and it is a virtual bank account, these digits may be different from the last four digits of the masked account number.",
"type" : "string"
},
"trustedSource" : {
@@ -5488,7 +5599,7 @@
"transferInstruments" : [
{
"id" : "SE322KH223222F5GXZFNM3BGP",
"accountIdentifier" : "NL************0123",
"accountIdentifier" : "NL**ABNA******0123",
"trustedSource" : false
}
]
@@ -6365,6 +6476,13 @@
"id" : "LE322KH223222J5HJ6JRB75C5"
}
},
"post-legalEntities-id-confirmDataReview-confirmDataReview-200" : {
"summary" : "Data review for a legal entity",
"description" : "Example response when reviewing the data for a legal entity",
"value" : {
"dataReviewedAt" : "2023-11-13T15:19:02Z"
}
},
"post-legalEntities-id-onboardingLinks-createOnboardingLink" : {
"summary" : "Create a hosted onboarding link",
"description" : "Example request for creating a hosted onboarding link",

148
json/LegalEntityService-v3.json
View File

@@ -1498,6 +1498,108 @@
}
}
},
"/legalEntities/{id}/confirmDataReview" : {
"post" : {
"tags" : [
"Legal entities"
],
"summary" : "Confirm data review",
"description" : "Confirms that your user has reviewed the data for the legal entity specified in the path. Call this endpoint to inform Adyen that your user reviewed and verified that the data is up-to-date. The endpoint returns the timestamp of when Adyen received the request.",
"x-addedInVersion" : "2",
"operationId" : "post-legalEntities-id-confirmDataReview",
"x-groupName" : "Legal entities",
"x-sortIndex" : 22,
"x-methodName" : "confirmDataReview",
"security" : [
{
"BasicAuth" : [
]
},
{
"ApiKeyAuth" : [
]
}
],
"parameters" : [
{
"description" : "The unique identifier of the legal entity.",
"name" : "id",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
}
}
],
"responses" : {
"200" : {
"content" : {
"application/json" : {
"examples" : {
"confirmDataReview" : {
"$ref" : "#/components/examples/post-legalEntities-id-confirmDataReview-confirmDataReview-200"
}
},
"schema" : {
"$ref" : "#/components/schemas/DataReviewConfirmationResponse"
}
}
},
"description" : "OK - the request has succeeded."
},
"400" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Bad Request - a problem reading or understanding the request."
},
"401" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Unauthorized - authentication required."
},
"403" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Forbidden - insufficient permissions to process the request."
},
"422" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Unprocessable Entity - a request validation error."
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Internal Server Error - the server could not process the request."
}
}
}
},
"/legalEntities/{id}/onboardingLinks" : {
"post" : {
"tags" : [
@@ -3445,10 +3547,9 @@
},
"service" : {
"x-addedInVersion" : "3",
"description" : "The service for which you are creating the business line.\n\nPossible values: **paymentProcessing**, **issuing**, **banking**",
"description" : "The service for which you are creating the business line.\n\n\n\nPossible values:\n* **paymentProcessing**\n* **banking**\n\n",
"enum" : [
"paymentProcessing",
"issuing",
"banking"
],
"type" : "string"
@@ -3508,10 +3609,9 @@
},
"service" : {
"x-addedInVersion" : "3",
"description" : "The service for which you are creating the business line.\n\nPossible values: **paymentProcessing**, **issuing**, **banking**",
"description" : "The service for which you are creating the business line.\n\n\n\nPossible values:\n* **paymentProcessing**\n* **banking**\n\n",
"enum" : [
"paymentProcessing",
"issuing",
"banking"
],
"type" : "string"
@@ -3570,10 +3670,9 @@
},
"service" : {
"x-addedInVersion" : "3",
"description" : "The service for which you are creating the business line.\n\nPossible values: **paymentProcessing**, **issuing**, **banking**",
"description" : "The service for which you are creating the business line.\n\n\n\nPossible values:\n* **paymentProcessing**\n* **banking**\n\n",
"enum" : [
"paymentProcessing",
"issuing",
"banking"
],
"type" : "string"
@@ -3849,6 +3948,15 @@
],
"type" : "object"
},
"DataReviewConfirmationResponse" : {
"properties" : {
"dataReviewedAt" : {
"description" : "Date when data review was confirmed.",
"type" : "string"
}
},
"type" : "object"
},
"Document" : {
"properties" : {
"attachment" : {
@@ -5186,6 +5294,11 @@
"description" : "The date when the legal arrangement was incorporated in YYYY-MM-DD format.",
"type" : "string"
},
"description" : {
"x-addedInVersion" : "3",
"description" : "Short description about the Legal Arrangement.",
"type" : "string"
},
"doingBusinessAs" : {
"description" : "The registered name, if different from the `name`.",
"type" : "string"
@@ -5492,7 +5605,7 @@
"type" : "string"
},
"realLastFour" : {
"description" : "Four last digits of the bank account number.",
"description" : "Four last digits of the bank account number. If the transfer instrument is created using [instant bank account verification](https://docs.adyen.com/release-notes/platforms-and-financial-products#releaseNote=2023-05-08-hosted-onboarding), and it is a virtual bank account, these digits may be different from the last four digits of the masked account number.",
"type" : "string"
},
"trustedSource" : {
@@ -5518,6 +5631,11 @@
"description" : "The date when the legal arrangement was incorporated in YYYY-MM-DD format.",
"type" : "string"
},
"description" : {
"x-addedInVersion" : "3",
"description" : "Short description about the trust.",
"type" : "string"
},
"doingBusinessAs" : {
"description" : "The registered name, if different from the `name`.",
"type" : "string"
@@ -5691,6 +5809,11 @@
"description" : "The date when the legal arrangement was incorporated in YYYY-MM-DD format.",
"type" : "string"
},
"description" : {
"x-addedInVersion" : "3",
"description" : "Short description about the Legal Arrangement.",
"type" : "string"
},
"doingBusinessAs" : {
"description" : "The registered name, if different from the `name`.",
"type" : "string"
@@ -5764,7 +5887,7 @@
"VerificationDeadline" : {
"properties" : {
"capabilities" : {
"description" : "The names of the capabilities to be disallowed.",
"description" : "The list of capabilities that will be disallowed if information is not reviewed by the time of the deadline",
"items" : {
"enum" : [
"acceptExternalFunding",
@@ -6256,7 +6379,7 @@
"transferInstruments" : [
{
"id" : "SE322KH223222F5GXZFNM3BGP",
"accountIdentifier" : "NL************0123",
"accountIdentifier" : "NL**ABNA******0123",
"trustedSource" : false
}
]
@@ -7355,6 +7478,13 @@
]
}
},
"post-legalEntities-id-confirmDataReview-confirmDataReview-200" : {
"summary" : "Data review for a legal entity",
"description" : "Example response when reviewing the data for a legal entity",
"value" : {
"dataReviewedAt" : "2023-11-13T15:19:02Z"
}
},
"post-legalEntities-id-onboardingLinks-createOnboardingLink" : {
"summary" : "Create a hosted onboarding link",
"description" : "Example request for creating a hosted onboarding link",

5
yaml/LegalEntityService-v1.yaml
View File

@@ -3350,7 +3350,10 @@ components:
description: The unique identifier of the resource.
type: string
realLastFour:
description: Four last digits of the bank account number.
description: Four last digits of the bank account number. If the transfer
instrument is created using [instant bank account verification](https://docs.adyen.com/release-notes/platforms-and-financial-products#releaseNote=2023-05-08-hosted-onboarding),
and it is a virtual bank account, these digits may be different from the
last four digits of the masked account number.
type: string
trustedSource:
description: Identifies if the bank account was created through [instant

82
yaml/LegalEntityService-v2.yaml
View File

@@ -883,6 +883,70 @@ paths:
schema:
$ref: '#/components/schemas/ServiceError'
description: Internal Server Error - the server could not process the request.
/legalEntities/{id}/confirmDataReview:
post:
tags:
- Legal entities
summary: Confirm data review
description: Confirms that your user has reviewed the data for the legal entity
specified in the path. Call this endpoint to inform Adyen that your user reviewed
and verified that the data is up-to-date. The endpoint returns the timestamp
of when Adyen received the request.
x-addedInVersion: '2'
operationId: post-legalEntities-id-confirmDataReview
x-groupName: Legal entities
x-sortIndex: 22
x-methodName: confirmDataReview
security:
- BasicAuth: []
- ApiKeyAuth: []
parameters:
- description: The unique identifier of the legal entity.
name: id
in: path
required: true
schema:
type: string
responses:
'200':
content:
application/json:
examples:
confirmDataReview:
$ref: '#/components/examples/post-legalEntities-id-confirmDataReview-confirmDataReview-200'
schema:
$ref: '#/components/schemas/DataReviewConfirmationResponse'
description: OK - the request has succeeded.
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceError'
description: Bad Request - a problem reading or understanding the request.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceError'
description: Unauthorized - authentication required.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceError'
description: Forbidden - insufficient permissions to process the request.
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceError'
description: Unprocessable Entity - a request validation error.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceError'
description: Internal Server Error - the server could not process the request.
/legalEntities/{id}/onboardingLinks:
post:
tags:
@@ -2368,6 +2432,12 @@ components:
description: The maximum amount a card holder can withdraw per day.
$ref: '#/components/schemas/Amount'
type: object
DataReviewConfirmationResponse:
properties:
dataReviewedAt:
description: Date when data review was confirmed.
type: string
type: object
Document:
properties:
attachment:
@@ -3764,7 +3834,10 @@ components:
description: The unique identifier of the resource.
type: string
realLastFour:
description: Four last digits of the bank account number.
description: Four last digits of the bank account number. If the transfer
instrument is created using [instant bank account verification](https://docs.adyen.com/release-notes/platforms-and-financial-products#releaseNote=2023-05-08-hosted-onboarding),
and it is a virtual bank account, these digits may be different from the
last four digits of the masked account number.
type: string
trustedSource:
description: Identifies if the bank account was created through [instant
@@ -4268,7 +4341,7 @@ components:
id: YOUR_LEGAL_ENTITY
transferInstruments:
- id: SE322KH223222F5GXZFNM3BGP
accountIdentifier: NL************0123
accountIdentifier: NL**ABNA******0123
trustedSource: false
get-legalEntities-id-termsOfServiceAcceptanceInfos-success-200:
summary: Terms of Service information for a legal entity
@@ -4918,6 +4991,11 @@ components:
reference: SE322KH223222J5HJ6JRB75HQ
type: trust
id: LE322KH223222J5HJ6JRB75C5
post-legalEntities-id-confirmDataReview-confirmDataReview-200:
summary: Data review for a legal entity
description: Example response when reviewing the data for a legal entity
value:
dataReviewedAt: '2023-11-13T15:19:02Z'
post-legalEntities-id-onboardingLinks-createOnboardingLink:
summary: Create a hosted onboarding link
description: Example request for creating a hosted onboarding link

133
yaml/LegalEntityService-v3.yaml
View File

@@ -949,6 +949,70 @@ paths:
schema:
$ref: '#/components/schemas/ServiceError'
description: Internal Server Error - the server could not process the request.
/legalEntities/{id}/confirmDataReview:
post:
tags:
- Legal entities
summary: Confirm data review
description: Confirms that your user has reviewed the data for the legal entity
specified in the path. Call this endpoint to inform Adyen that your user reviewed
and verified that the data is up-to-date. The endpoint returns the timestamp
of when Adyen received the request.
x-addedInVersion: '2'
operationId: post-legalEntities-id-confirmDataReview
x-groupName: Legal entities
x-sortIndex: 22
x-methodName: confirmDataReview
security:
- BasicAuth: []
- ApiKeyAuth: []
parameters:
- description: The unique identifier of the legal entity.
name: id
in: path
required: true
schema:
type: string
responses:
'200':
content:
application/json:
examples:
confirmDataReview:
$ref: '#/components/examples/post-legalEntities-id-confirmDataReview-confirmDataReview-200'
schema:
$ref: '#/components/schemas/DataReviewConfirmationResponse'
description: OK - the request has succeeded.
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceError'
description: Bad Request - a problem reading or understanding the request.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceError'
description: Unauthorized - authentication required.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceError'
description: Forbidden - insufficient permissions to process the request.
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceError'
description: Unprocessable Entity - a request validation error.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceError'
description: Internal Server Error - the server could not process the request.
/legalEntities/{id}/onboardingLinks:
post:
tags:
@@ -2253,10 +2317,18 @@ components:
description: 'The service for which you are creating the business line.
Possible values: **paymentProcessing**, **issuing**, **banking**'
Possible values:
* **paymentProcessing**
* **banking**
'
enum:
- paymentProcessing
- issuing
- banking
type: string
sourceOfFunds:
@@ -2319,10 +2391,18 @@ components:
description: 'The service for which you are creating the business line.
Possible values: **paymentProcessing**, **issuing**, **banking**'
Possible values:
* **paymentProcessing**
* **banking**
'
enum:
- paymentProcessing
- issuing
- banking
type: string
sourceOfFunds:
@@ -2381,10 +2461,18 @@ components:
description: 'The service for which you are creating the business line.
Possible values: **paymentProcessing**, **issuing**, **banking**'
Possible values:
* **paymentProcessing**
* **banking**
'
enum:
- paymentProcessing
- issuing
- banking
type: string
sourceOfFunds:
@@ -2605,6 +2693,12 @@ components:
- accountNumber
- bankCode
type: object
DataReviewConfirmationResponse:
properties:
dataReviewedAt:
description: Date when data review was confirmed.
type: string
type: object
Document:
properties:
attachment:
@@ -3899,6 +3993,10 @@ components:
description: The date when the legal arrangement was incorporated in YYYY-MM-DD
format.
type: string
description:
x-addedInVersion: '3'
description: Short description about the Legal Arrangement.
type: string
doingBusinessAs:
description: The registered name, if different from the `name`.
type: string
@@ -4221,7 +4319,10 @@ components:
description: The unique identifier of the resource.
type: string
realLastFour:
description: Four last digits of the bank account number.
description: Four last digits of the bank account number. If the transfer
instrument is created using [instant bank account verification](https://docs.adyen.com/release-notes/platforms-and-financial-products#releaseNote=2023-05-08-hosted-onboarding),
and it is a virtual bank account, these digits may be different from the
last four digits of the masked account number.
type: string
trustedSource:
description: Identifies if the bank account was created through [instant
@@ -4243,6 +4344,10 @@ components:
description: The date when the legal arrangement was incorporated in YYYY-MM-DD
format.
type: string
description:
x-addedInVersion: '3'
description: Short description about the trust.
type: string
doingBusinessAs:
description: The registered name, if different from the `name`.
type: string
@@ -4396,6 +4501,10 @@ components:
description: The date when the legal arrangement was incorporated in YYYY-MM-DD
format.
type: string
description:
x-addedInVersion: '3'
description: Short description about the Legal Arrangement.
type: string
doingBusinessAs:
description: The registered name, if different from the `name`.
type: string
@@ -4465,7 +4574,8 @@ components:
VerificationDeadline:
properties:
capabilities:
description: The names of the capabilities to be disallowed.
description: The list of capabilities that will be disallowed if information
is not reviewed by the time of the deadline
items:
enum:
- acceptExternalFunding
@@ -4870,7 +4980,7 @@ components:
id: YOUR_LEGAL_ENTITY
transferInstruments:
- id: SE322KH223222F5GXZFNM3BGP
accountIdentifier: NL************0123
accountIdentifier: NL**ABNA******0123
trustedSource: false
get-legalEntities-id-termsOfServiceAcceptanceInfos-success-200:
summary: Terms of Service information for a legal entity
@@ -5659,6 +5769,11 @@ components:
- code: '2_117'
message: Add 'organization.registrationNumber' to legal entity
type: dataMissing
post-legalEntities-id-confirmDataReview-confirmDataReview-200:
summary: Data review for a legal entity
description: Example response when reviewing the data for a legal entity
value:
dataReviewedAt: '2023-11-13T15:19:02Z'
post-legalEntities-id-onboardingLinks-createOnboardingLink:
summary: Create a hosted onboarding link
description: Example request for creating a hosted onboarding link