spec release

This commit is contained in:
Adyen Automation
2024-03-05 17:26:49 +01:00
parent fcc380e5a3
commit 5ec2d192fd
40 changed files with 1572 additions and 0 deletions

View File

@@ -532,6 +532,7 @@ webhooks:
components:
schemas:
AccountCloseNotification:
additionalProperties: false
properties:
content:
description: The details of the Account update.
@@ -565,6 +566,7 @@ components:
- eventDate
type: object
AccountCreateNotification:
additionalProperties: false
properties:
content:
description: The details of the account creation.
@@ -598,6 +600,7 @@ components:
- eventDate
type: object
AccountEvent:
additionalProperties: false
properties:
event:
description: 'The event.
@@ -622,6 +625,7 @@ components:
AccountEvent:
$ref: '#/components/schemas/AccountEvent'
AccountFundsBelowThresholdNotification:
additionalProperties: false
properties:
content:
description: Details of the liable account with funds under threshold.
@@ -655,6 +659,7 @@ components:
- eventDate
type: object
AccountFundsBelowThresholdNotificationContent:
additionalProperties: false
properties:
accountCode:
description: The code of the account with funds under threshold
@@ -676,6 +681,7 @@ components:
- fundThreshold
type: object
AccountHolderCreateNotification:
additionalProperties: false
properties:
content:
description: The details of the account holder creation.
@@ -709,6 +715,7 @@ components:
- eventDate
type: object
AccountHolderDetails:
additionalProperties: false
properties:
address:
description: The address of the account holder.
@@ -777,6 +784,7 @@ components:
- address
type: object
AccountHolderPayoutNotification:
additionalProperties: false
properties:
content:
description: Details of the payout to the Account Holder.
@@ -810,6 +818,7 @@ components:
- eventDate
type: object
AccountHolderPayoutNotificationContent:
additionalProperties: false
properties:
accountCode:
description: The code of the account from which the payout was made.
@@ -840,6 +849,7 @@ components:
$ref: '#/components/schemas/OperationStatus'
type: object
AccountHolderStatus:
additionalProperties: false
properties:
events:
description: A list of events scheduled for the account holder.
@@ -869,6 +879,7 @@ components:
- status
type: object
AccountHolderStatusChangeNotification:
additionalProperties: false
properties:
content:
description: The details of the Account Holder status change.
@@ -902,6 +913,7 @@ components:
- eventDate
type: object
AccountHolderStatusChangeNotificationContent:
additionalProperties: false
properties:
accountHolderCode:
description: The code of the account holder.
@@ -921,6 +933,7 @@ components:
- accountHolderCode
type: object
AccountHolderStoreStatusChangeNotification:
additionalProperties: false
properties:
content:
description: The details of the Account Holder Store status change.
@@ -954,8 +967,10 @@ components:
- eventDate
type: object
AccountHolderStoreStatusChangeNotificationContent:
additionalProperties: false
type: object
AccountHolderUpcomingDeadlineNotification:
additionalProperties: false
properties:
content:
description: The details of the upcoming event.
@@ -989,6 +1004,7 @@ components:
- eventDate
type: object
AccountHolderUpcomingDeadlineNotificationContent:
additionalProperties: false
properties:
accountHolderCode:
description: The code of the account holder whom the event refers to.
@@ -1031,6 +1047,7 @@ components:
type: string
type: object
AccountHolderUpdateNotification:
additionalProperties: false
properties:
content:
description: The details of the Account Holder update.
@@ -1064,6 +1081,7 @@ components:
- eventDate
type: object
AccountHolderVerificationNotification:
additionalProperties: false
properties:
content:
description: The details of the Account Holder verification.
@@ -1097,6 +1115,7 @@ components:
- eventDate
type: object
AccountHolderVerificationNotificationContent:
additionalProperties: false
properties:
accountHolderCode:
description: The code of the account holder.
@@ -1142,6 +1161,7 @@ components:
type: string
type: object
AccountPayoutState:
additionalProperties: false
properties:
allowPayout:
description: Indicates whether payouts are allowed. This field is the overarching
@@ -1174,6 +1194,7 @@ components:
type: integer
type: object
AccountProcessingState:
additionalProperties: false
properties:
disableReason:
description: The reason why processing has been disabled.
@@ -1198,6 +1219,7 @@ components:
type: integer
type: object
AccountUpdateNotification:
additionalProperties: false
properties:
content:
description: The details of the Account update.
@@ -1231,6 +1253,7 @@ components:
- eventDate
type: object
Amount:
additionalProperties: false
properties:
currency:
description: The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes).
@@ -1250,6 +1273,7 @@ components:
Amount:
$ref: '#/components/schemas/Amount'
BankAccountDetail:
additionalProperties: false
properties:
accountNumber:
description: 'The bank account number (without separators).
@@ -1458,6 +1482,7 @@ components:
BankAccountDetail:
$ref: '#/components/schemas/BankAccountDetail'
BeneficiarySetupNotification:
additionalProperties: false
properties:
content:
description: Details of the beneficiary setup.
@@ -1491,6 +1516,7 @@ components:
- eventDate
type: object
BeneficiarySetupNotificationContent:
additionalProperties: false
properties:
destinationAccountCode:
description: The code of the beneficiary account.
@@ -1519,6 +1545,7 @@ components:
type: integer
type: object
BusinessDetails:
additionalProperties: false
properties:
doingBusinessAs:
description: The registered name of the company (if it differs from the
@@ -1556,6 +1583,7 @@ components:
type: string
type: object
CloseAccountResponse:
additionalProperties: false
properties:
pspReference:
description: The reference of a request. Can be used to uniquely identify
@@ -1588,6 +1616,7 @@ components:
type: boolean
type: object
CompensateNegativeBalanceNotification:
additionalProperties: false
properties:
content:
description: Details of the negative balance compensation.
@@ -1621,6 +1650,7 @@ components:
- eventDate
type: object
CompensateNegativeBalanceNotificationContent:
additionalProperties: false
properties:
records:
description: A list of the negative balances compensated.
@@ -1629,6 +1659,7 @@ components:
type: array
type: object
CompensateNegativeBalanceNotificationRecord:
additionalProperties: false
properties:
accountCode:
description: The code of the account whose negative balance has been compensated.
@@ -1646,6 +1677,7 @@ components:
CompensateNegativeBalanceNotificationRecord:
$ref: '#/components/schemas/CompensateNegativeBalanceNotificationRecord'
CreateAccountHolderResponse:
additionalProperties: false
properties:
accountCode:
description: The code of a new account created for the account holder.
@@ -1703,6 +1735,7 @@ components:
$ref: '#/components/schemas/KYCVerificationResult'
type: object
CreateAccountResponse:
additionalProperties: false
properties:
accountCode:
description: The code of the new account.
@@ -1748,6 +1781,7 @@ components:
type: boolean
type: object
DirectDebitInitiatedNotification:
additionalProperties: false
properties:
content:
description: Details of the direct debit.
@@ -1781,6 +1815,7 @@ components:
- eventDate
type: object
DirectDebitInitiatedNotificationContent:
additionalProperties: false
properties:
accountCode:
description: The code of the account.
@@ -1813,6 +1848,7 @@ components:
- merchantAccountCode
type: object
ErrorFieldType:
additionalProperties: false
properties:
errorCode:
description: The validation error code.
@@ -1830,6 +1866,7 @@ components:
ErrorFieldType:
$ref: '#/components/schemas/ErrorFieldType'
FieldType:
additionalProperties: false
properties:
field:
description: The full name of the property.
@@ -2011,6 +2048,7 @@ components:
FieldType:
$ref: '#/components/schemas/FieldType'
IndividualDetails:
additionalProperties: false
properties:
name:
description: 'The name of the individual.
@@ -2023,6 +2061,7 @@ components:
$ref: '#/components/schemas/ViasPersonalData'
type: object
KYCBankAccountCheckResult:
additionalProperties: false
properties:
bankAccountUUID:
description: The unique ID of the bank account to which the check applies.
@@ -2034,6 +2073,7 @@ components:
type: array
type: object
KYCCheckResult:
additionalProperties: false
properties:
checks:
description: A list of the checks and their statuses.
@@ -2042,6 +2082,7 @@ components:
type: array
type: object
KYCCheckStatusData:
additionalProperties: false
properties:
requiredFields:
description: A list of the fields required for execution of the check.
@@ -2091,6 +2132,7 @@ components:
- status
type: object
KYCCheckSummary:
additionalProperties: false
properties:
code:
description: The code of the check.
@@ -2103,6 +2145,7 @@ components:
- code
type: object
KYCShareholderCheckResult:
additionalProperties: false
properties:
checks:
description: A list of the checks and their statuses.
@@ -2114,6 +2157,7 @@ components:
type: string
type: object
KYCSignatoryCheckResult:
additionalProperties: false
properties:
checks:
description: A list of the checks and their statuses.
@@ -2125,6 +2169,7 @@ components:
type: string
type: object
KYCVerificationResult:
additionalProperties: false
properties:
accountHolder:
description: The results of the checks on the account holder.
@@ -2146,6 +2191,7 @@ components:
type: array
type: object
LocalDate:
additionalProperties: false
properties:
month:
format: int32
@@ -2155,6 +2201,7 @@ components:
type: integer
type: object
Message:
additionalProperties: false
properties:
code:
description: The message code.
@@ -2164,6 +2211,7 @@ components:
type: string
type: object
NotificationResponse:
additionalProperties: false
properties:
notificationResponse:
description: Set this parameter to **[accepted]** to acknowledge that you
@@ -2171,6 +2219,7 @@ components:
type: string
type: object
OperationStatus:
additionalProperties: false
properties:
message:
description: The message regarding the operation status.
@@ -2180,6 +2229,7 @@ components:
type: string
type: object
PaymentFailureNotification:
additionalProperties: false
properties:
content:
description: The details of the payment failure.
@@ -2213,6 +2263,7 @@ components:
- eventDate
type: object
PaymentFailureNotificationContent:
additionalProperties: false
properties:
errorFields:
description: Missing or invalid fields that caused the payment error.
@@ -2236,6 +2287,7 @@ components:
type: string
type: object
PayoutScheduleResponse:
additionalProperties: false
properties:
nextScheduledPayout:
description: The date of the next scheduled payout.
@@ -2270,6 +2322,7 @@ components:
type: string
type: object
PersonalDocumentData:
additionalProperties: false
properties:
expirationDate:
description: "The expiry date of the document, \n in ISO-8601 YYYY-MM-DD\
@@ -2310,6 +2363,7 @@ components:
PersonalDocumentData:
$ref: '#/components/schemas/PersonalDocumentData'
RefundFundsTransferNotification:
additionalProperties: false
properties:
content:
description: Details of the fund transfer refund.
@@ -2343,6 +2397,7 @@ components:
- eventDate
type: object
RefundFundsTransferNotificationContent:
additionalProperties: false
properties:
amount:
description: The amount to be refunded.
@@ -2362,6 +2417,7 @@ components:
- amount
type: object
RefundResult:
additionalProperties: false
properties:
originalTransaction:
description: The transaction that has been refunded.
@@ -2379,6 +2435,7 @@ components:
RefundResult:
$ref: '#/components/schemas/RefundResult'
ReportAvailableNotification:
additionalProperties: false
properties:
content:
description: Details of the report.
@@ -2412,6 +2469,7 @@ components:
- eventDate
type: object
ReportAvailableNotificationContent:
additionalProperties: false
properties:
accountCode:
description: The code of the Account to which the report applies.
@@ -2431,6 +2489,7 @@ components:
type: boolean
type: object
ScheduledRefundsNotification:
additionalProperties: false
properties:
content:
description: Details of the scheduling of the refunds.
@@ -2464,6 +2523,7 @@ components:
- eventDate
type: object
ScheduledRefundsNotificationContent:
additionalProperties: false
properties:
accountCode:
description: The code of the account.
@@ -2482,6 +2542,7 @@ components:
type: array
type: object
ShareholderContact:
additionalProperties: false
properties:
address:
description: The address of the person.
@@ -2557,6 +2618,7 @@ components:
ShareholderContact:
$ref: '#/components/schemas/ShareholderContact'
SignatoryContact:
additionalProperties: false
properties:
address:
description: The address of the person.
@@ -2624,6 +2686,7 @@ components:
SignatoryContact:
$ref: '#/components/schemas/SignatoryContact'
Split:
additionalProperties: false
properties:
account:
description: 'The unique identifier of the account to which the split amount
@@ -2697,6 +2760,7 @@ components:
- type
type: object
SplitAmount:
additionalProperties: false
properties:
currency:
description: The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes).
@@ -2712,6 +2776,7 @@ components:
- value
type: object
Transaction:
additionalProperties: false
properties:
amount:
description: The amount of the transaction.
@@ -2825,6 +2890,7 @@ components:
type: string
type: object
TransferFundsNotification:
additionalProperties: false
properties:
content:
description: Details of the fund transfer.
@@ -2858,6 +2924,7 @@ components:
- eventDate
type: object
TransferFundsNotificationContent:
additionalProperties: false
properties:
amount:
description: The amount transferred.
@@ -2880,6 +2947,7 @@ components:
type: string
type: object
UltimateParentCompany:
additionalProperties: false
properties:
address:
description: Address of the ultimate parent company.
@@ -2895,6 +2963,7 @@ components:
type: string
type: object
UltimateParentCompanyBusinessDetails:
additionalProperties: false
properties:
legalBusinessName:
description: The legal name of the company.
@@ -2917,6 +2986,7 @@ components:
UltimateParentCompany:
$ref: '#/components/schemas/UltimateParentCompany'
UpdateAccountHolderResponse:
additionalProperties: false
properties:
accountHolderCode:
description: The code of the account holder.
@@ -2976,6 +3046,7 @@ components:
$ref: '#/components/schemas/KYCVerificationResult'
type: object
UpdateAccountResponse:
additionalProperties: false
properties:
accountCode:
description: The code of the account.
@@ -3010,6 +3081,7 @@ components:
- accountCode
type: object
ViasAddress:
additionalProperties: false
properties:
city:
description: The name of the city. Required if the `houseNumberOrName`,
@@ -3049,6 +3121,7 @@ components:
- country
type: object
ViasName:
additionalProperties: false
properties:
firstName:
description: The first name.
@@ -3076,6 +3149,7 @@ components:
type: string
type: object
ViasPersonalData:
additionalProperties: false
properties:
dateOfBirth:
description: The person's date of birth, in ISO-8601 YYYY-MM-DD format.
@@ -3106,6 +3180,7 @@ components:
type: string
type: object
ViasPhoneNumber:
additionalProperties: false
properties:
phoneCountryCode:
description: 'The two-character country code of the phone number.