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
Files
92a23f981b3358ee09174a00a85f5bf7a95fcb88
adyen-openapi/json/MarketPayNotificationService-v6.json
aleksei 92a23f981b Updated JSON specs
2021-11-01 09:25:58 +01:00

4276 lines
184 KiB
JSON
Raw Blame History

{
"openapi" : "3.1.0",
"info" : {
"version" : "6",
"x-publicVersion" : true,
"title" : "Adyen for Platforms: Notifications",
"description" : "The Notification API sends notifications to the endpoints specified in a given subscription. Subscriptions are managed through the Notification Configuration API. The API specifications listed here detail the format of each notification.\n\nFor more information, refer to our [documentation](https://docs.adyen.com/platforms/notifications).",
"termsOfService" : "https://www.adyen.com/legal/terms-and-conditions",
"contact" : {
"name" : "Adyen Developer Experience team",
"url" : "https://www.adyen.help/hc/en-us/community/topics",
"email" : "developer-experience@adyen.com"
}
},
"x-groups" : [
"Account holders",
"Accounts",
"Fund management",
"Other"
],
"x-staticResponse" : "response.json",
"webhooks" : {
"/ACCOUNT_CLOSED" : {
"post" : {
"tags" : [
"Accounts"
],
"summary" : "Triggered upon the closure of an account.",
"description" : "This notification is sent when an account has been closed.",
"operationId" : "post-ACCOUNT_CLOSED",
"x-groupName" : "Accounts",
"x-sortIndex" : 3,
"security" : [
{
"BasicAuth" : [
]
},
{
"ApiKeyAuth" : [
]
}
],
"requestBody" : {
"content" : {
"application/json" : {
"examples" : {
"accountClosed" : {
"$ref" : "#/components/examples/post-ACCOUNT_CLOSED-accountClosed"
}
},
"schema" : {
"$ref" : "#/components/schemas/AccountCloseNotification"
}
}
}
},
"responses" : {
"200" : {
"content" : {
"application/json" : {
"examples" : {
"accountClosed" : {
"$ref" : "#/components/examples/WebhookAck"
}
},
"schema" : {
"$ref" : "#/components/schemas/NotificationResponse"
}
}
},
"description" : "OK - the request has succeeded."
}
}
}
},
"/ACCOUNT_CREATED" : {
"post" : {
"tags" : [
"Accounts"
],
"summary" : "Triggered upon the creation of an account.",
"description" : "This notification is sent when an account has been created.",
"operationId" : "post-ACCOUNT_CREATED",
"x-groupName" : "Accounts",
"x-sortIndex" : 1,
"security" : [
{
"BasicAuth" : [
]
},
{
"ApiKeyAuth" : [
]
}
],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AccountCreateNotification"
}
}
}
},
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotificationResponse"
}
}
},
"description" : "OK - the request has succeeded."
}
}
}
},
"/ACCOUNT_FUNDS_BELOW_THRESHOLD" : {
"post" : {
"tags" : [
"Fund management"
],
"summary" : "Triggered when a liable account current funds are below configured threshold.",
"description" : "This notification is sent when a liable account's current funds are below configured threshold from the Adyen platform.",
"operationId" : "post-ACCOUNT_FUNDS_BELOW_THRESHOLD",
"x-groupName" : "Fund management",
"x-sortIndex" : 7,
"security" : [
{
"BasicAuth" : [
]
},
{
"ApiKeyAuth" : [
]
}
],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AccountFundsBelowThresholdNotification"
}
}
}
},
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotificationResponse"
}
}
},
"description" : "OK - the request has succeeded."
}
}
}
},
"/ACCOUNT_HOLDER_CREATED" : {
"post" : {
"tags" : [
"Account holders"
],
"summary" : "Triggered upon the creation of an account holder.",
"description" : "This notification is sent when an account holder has been created.",
"operationId" : "post-ACCOUNT_HOLDER_CREATED",
"x-groupName" : "Account holders",
"x-sortIndex" : 1,
"security" : [
{
"BasicAuth" : [
]
},
{
"ApiKeyAuth" : [
]
}
],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AccountHolderCreateNotification"
}
}
}
},
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotificationResponse"
}
}
},
"description" : "OK - the request has succeeded."
}
}
}
},
"/ACCOUNT_HOLDER_PAYOUT" : {
"post" : {
"tags" : [
"Fund management"
],
"summary" : "Triggered upon a payout to an account holder.",
"description" : "This notification is sent when a payout request to an account holder has been processed and the payout has been scheduled.",
"operationId" : "post-ACCOUNT_HOLDER_PAYOUT",
"x-groupName" : "Fund management",
"x-sortIndex" : 1,
"security" : [
{
"BasicAuth" : [
]
},
{
"ApiKeyAuth" : [
]
}
],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AccountHolderPayoutNotification"
}
}
}
},
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotificationResponse"
}
}
},
"description" : "OK - the request has succeeded."
}
}
}
},
"/ACCOUNT_HOLDER_STATUS_CHANGE" : {
"post" : {
"tags" : [
"Account holders"
],
"summary" : "Triggered upon the status change of an account holder.",
"description" : "This notification is sent when the status of an account holder has been changed.",
"operationId" : "post-ACCOUNT_HOLDER_STATUS_CHANGE",
"x-groupName" : "Account holders",
"x-sortIndex" : 4,
"security" : [
{
"BasicAuth" : [
]
},
{
"ApiKeyAuth" : [
]
}
],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AccountHolderStatusChangeNotification"
}
}
}
},
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotificationResponse"
}
}
},
"description" : "OK - the request has succeeded."
}
}
}
},
"/ACCOUNT_HOLDER_STORE_STATUS_CHANGE" : {
"post" : {
"tags" : [
"Account holders"
],
"summary" : "Triggered upon the status change of a store tied to an account holder.",
"description" : "This notification is sent when the status of a store tied to an account holder has been changed.",
"operationId" : "post-ACCOUNT_HOLDER_STORE_STATUS_CHANGE",
"x-groupName" : "Account holders",
"x-sortIndex" : 4,
"security" : [
{
"BasicAuth" : [
]
},
{
"ApiKeyAuth" : [
]
}
],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AccountHolderStoreStatusChangeNotification"
}
}
}
},
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotificationResponse"
}
}
},
"description" : "OK - the request has succeeded."
}
}
}
},
"/ACCOUNT_HOLDER_UPCOMING_DEADLINE" : {
"post" : {
"tags" : [
"Account holders"
],
"summary" : "Triggered upon an upcoming deadline.",
"description" : "This notification is sent when an Account Holder has a deadline, to fulfill the requirements of a specific event, coming up.",
"operationId" : "post-ACCOUNT_HOLDER_UPCOMING_DEADLINE",
"x-groupName" : "Account holders",
"x-sortIndex" : 1,
"security" : [
{
"BasicAuth" : [
]
},
{
"ApiKeyAuth" : [
]
}
],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AccountHolderUpcomingDeadlineNotification"
}
}
}
},
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotificationResponse"
}
}
},
"description" : "OK - the request has succeeded."
}
}
}
},
"/ACCOUNT_HOLDER_UPDATED" : {
"post" : {
"tags" : [
"Account holders"
],
"summary" : "Triggered upon the update of an account holder.",
"description" : "This notification is sent when an account holder has been updated.",
"operationId" : "post-ACCOUNT_HOLDER_UPDATED",
"x-groupName" : "Account holders",
"x-sortIndex" : 2,
"security" : [
{
"BasicAuth" : [
]
},
{
"ApiKeyAuth" : [
]
}
],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AccountHolderUpdateNotification"
}
}
}
},
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotificationResponse"
}
}
},
"description" : "OK - the request has succeeded."
}
}
}
},
"/ACCOUNT_HOLDER_VERIFICATION" : {
"post" : {
"tags" : [
"Account holders"
],
"summary" : "Triggered upon the receipt of KYC Verification results.",
"description" : "This notification is sent when KYC Verification results are made available.",
"operationId" : "post-ACCOUNT_HOLDER_VERIFICATION",
"x-groupName" : "Account holders",
"x-sortIndex" : 3,
"security" : [
{
"BasicAuth" : [
]
},
{
"ApiKeyAuth" : [
]
}
],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AccountHolderVerificationNotification"
}
}
}
},
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotificationResponse"
}
}
},
"description" : "OK - the request has succeeded."
}
}
}
},
"/ACCOUNT_UPDATED" : {
"post" : {
"tags" : [
"Accounts"
],
"summary" : "Triggered upon the update of an account.",
"description" : "This notification is sent when an account has been updated.",
"operationId" : "post-ACCOUNT_UPDATED",
"x-groupName" : "Accounts",
"x-sortIndex" : 2,
"security" : [
{
"BasicAuth" : [
]
},
{
"ApiKeyAuth" : [
]
}
],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AccountUpdateNotification"
}
}
}
},
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotificationResponse"
}
}
},
"description" : "OK - the request has succeeded."
}
}
}
},
"/BENEFICIARY_SETUP" : {
"post" : {
"tags" : [
"Fund management"
],
"summary" : "Triggered upon the setup of a beneficiary.",
"description" : "This notification is sent when a benefactor/beneficiary relationship between accounts has been set up.",
"operationId" : "post-BENEFICIARY_SETUP",
"x-groupName" : "Fund management",
"x-sortIndex" : 3,
"security" : [
{
"BasicAuth" : [
]
},
{
"ApiKeyAuth" : [
]
}
],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BeneficiarySetupNotification"
}
}
}
},
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotificationResponse"
}
}
},
"description" : "OK - the request has succeeded."
}
}
}
},
"/COMPENSATE_NEGATIVE_BALANCE" : {
"post" : {
"tags" : [
"Fund management"
],
"summary" : "Triggered upon the compensation of negative account balances.",
"description" : "This notification is sent when funds have been transferred from your platform's liable account to an overdrawn account in order to compensate for the overdraft.",
"operationId" : "post-COMPENSATE_NEGATIVE_BALANCE",
"x-groupName" : "Fund management",
"x-sortIndex" : 5,
"security" : [
{
"BasicAuth" : [
]
},
{
"ApiKeyAuth" : [
]
}
],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/CompensateNegativeBalanceNotification"
}
}
}
},
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotificationResponse"
}
}
},
"description" : "OK - the request has succeeded."
}
}
}
},
"/DIRECT_DEBIT_INITIATED" : {
"post" : {
"tags" : [
"Fund management"
],
"summary" : "Triggered when an automated direct debit is initiated.",
"description" : "This notification is sent when an automated direct debit is initiated from the Adyen platform.",
"operationId" : "post-DIRECT_DEBIT_INITIATED",
"x-groupName" : "Fund management",
"x-sortIndex" : 7,
"security" : [
{
"BasicAuth" : [
]
},
{
"ApiKeyAuth" : [
]
}
],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DirectDebitInitiatedNotification"
}
}
}
},
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotificationResponse"
}
}
},
"description" : "OK - the request has succeeded."
}
}
}
},
"/PAYMENT_FAILURE" : {
"post" : {
"tags" : [
"Other"
],
"summary" : "Triggered when a booking for a capture or refund fails.",
"description" : "This notification is sent when a [split payment](https://docs.adyen.com/platforms/processing-payments#providing-split-information) booking for a capture or refund fails. When a booking fails due to an invalid account status or an unknown `accountCode`, the funds are credited or debited to your platform's liable account instead of the account specified in the split data.",
"operationId" : "post-PAYMENT_FAILURE",
"x-groupName" : "Other",
"x-sortIndex" : 1,
"security" : [
{
"BasicAuth" : [
]
},
{
"ApiKeyAuth" : [
]
}
],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/PaymentFailureNotification"
}
}
}
},
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotificationResponse"
}
}
},
"description" : "OK - the request has succeeded."
}
}
}
},
"/REFUND_FUNDS_TRANSFER" : {
"post" : {
"tags" : [
"Fund management"
],
"summary" : "Triggered upon the transfer refund of funds between accounts.",
"description" : "This notification is sent when the refund of funds from an account have been transferred to another account.",
"operationId" : "post-REFUND_FUNDS_TRANSFER",
"x-groupName" : "Fund management",
"x-sortIndex" : 6,
"security" : [
{
"BasicAuth" : [
]
},
{
"ApiKeyAuth" : [
]
}
],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/RefundFundsTransferNotification"
}
}
}
},
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotificationResponse"
}
}
},
"description" : "OK - the request has succeeded."
}
}
}
},
"/REPORT_AVAILABLE" : {
"post" : {
"tags" : [
"Other"
],
"summary" : "Triggered when a report is made available.",
"description" : "This notification is sent when a report has been made available.",
"operationId" : "post-REPORT_AVAILABLE",
"x-groupName" : "Other",
"x-sortIndex" : 2,
"security" : [
{
"BasicAuth" : [
]
},
{
"ApiKeyAuth" : [
]
}
],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ReportAvailableNotification"
}
}
}
},
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotificationResponse"
}
}
},
"description" : "OK - the request has succeeded."
}
}
}
},
"/SCHEDULED_REFUNDS" : {
"post" : {
"tags" : [
"Fund management"
],
"summary" : "Triggered upon the scheduling of refunds requested by a 'Refund Transfers Not Paid Out' call.",
"description" : "This notification is sent when a 'Refund Transfers Not Paid Out' call has been processed and the associated refunds have been scheduled.",
"operationId" : "post-SCHEDULED_REFUNDS",
"x-groupName" : "Fund management",
"x-sortIndex" : 4,
"security" : [
{
"BasicAuth" : [
]
},
{
"ApiKeyAuth" : [
]
}
],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ScheduledRefundsNotification"
}
}
}
},
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotificationResponse"
}
}
},
"description" : "OK - the request has succeeded."
}
}
}
},
"/TRANSFER_FUNDS" : {
"post" : {
"tags" : [
"Fund management"
],
"summary" : "Triggered upon the transfer of funds between accounts.",
"description" : "This notification is sent when the funds from an account have been transferred to another account.",
"operationId" : "post-TRANSFER_FUNDS",
"x-groupName" : "Fund management",
"x-sortIndex" : 2,
"security" : [
{
"BasicAuth" : [
]
},
{
"ApiKeyAuth" : [
]
}
],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/TransferFundsNotification"
}
}
}
},
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotificationResponse"
}
}
},
"description" : "OK - the request has succeeded."
}
}
}
}
},
"components" : {
"schemas" : {
"AccountCloseNotification" : {
"properties" : {
"content" : {
"description" : "The details of the Account update.",
"$ref" : "#/components/schemas/CloseAccountResponse"
},
"error" : {
"x-addedInVersion" : "5",
"description" : "Error information of failed request. No value provided here if no error occurred on processing.",
"$ref" : "#/components/schemas/NotificationErrorContainer"
},
"eventDate" : {
"x-addedInVersion" : "4",
"description" : "The date and time when an event has been completed.",
"format" : "date-time",
"type" : "string"
},
"eventType" : {
"description" : "The event type of the notification.",
"type" : "string"
},
"executingUserKey" : {
"description" : "The user or process that has triggered the notification.",
"type" : "string"
},
"live" : {
"description" : "Indicates whether the notification originated from the live environment or the test environment. If true, the notification originated from the live environment. If false, the notification originated from the test environment.",
"type" : "boolean"
},
"pspReference" : {
"description" : "The PSP reference of the request from which the notification originates.",
"type" : "string"
}
},
"required" : [
"executingUserKey",
"pspReference",
"eventType",
"live",
"eventDate",
"content"
]
},
"AccountCreateNotification" : {
"properties" : {
"content" : {
"description" : "The details of the account creation.",
"$ref" : "#/components/schemas/CreateAccountResponse"
},
"error" : {
"x-addedInVersion" : "5",
"description" : "Error information of failed request. No value provided here if no error occurred on processing.",
"$ref" : "#/components/schemas/NotificationErrorContainer"
},
"eventDate" : {
"x-addedInVersion" : "4",
"description" : "The date and time when an event has been completed.",
"format" : "date-time",
"type" : "string"
},
"eventType" : {
"description" : "The event type of the notification.",
"type" : "string"
},
"executingUserKey" : {
"description" : "The user or process that has triggered the notification.",
"type" : "string"
},
"live" : {
"description" : "Indicates whether the notification originated from the live environment or the test environment. If true, the notification originated from the live environment. If false, the notification originated from the test environment.",
"type" : "boolean"
},
"pspReference" : {
"description" : "The PSP reference of the request from which the notification originates.",
"type" : "string"
}
},
"required" : [
"executingUserKey",
"pspReference",
"eventType",
"live",
"eventDate",
"content"
]
},
"AccountEvent" : {
"properties" : {
"event" : {
"description" : "The event.\n>Permitted values: `InactivateAccount`, `RefundNotPaidOutTransfers`.\nFor more information, refer to [Verification checks](https://docs.adyen.com/platforms/verification-checks).",
"enum" : [
"InactivateAccount",
"RefundNotPaidOutTransfers"
],
"type" : "string"
},
"executionDate" : {
"description" : "The date on which the event will take place.",
"format" : "date-time",
"type" : "string"
},
"reason" : {
"description" : "The reason why this event has been created.",
"type" : "string"
}
},
"required" : [
"event",
"executionDate",
"reason"
]
},
"AccountFundsBelowThresholdNotification" : {
"properties" : {
"content" : {
"description" : "Details of the liable account with funds under threshold.",
"$ref" : "#/components/schemas/AccountFundsBelowThresholdNotificationContent"
},
"error" : {
"x-addedInVersion" : "5",
"description" : "Error information of failed request. No value provided here if no error occurred on processing.",
"$ref" : "#/components/schemas/NotificationErrorContainer"
},
"eventDate" : {
"x-addedInVersion" : "4",
"description" : "The date and time when an event has been completed.",
"format" : "date-time",
"type" : "string"
},
"eventType" : {
"description" : "The event type of the notification.",
"type" : "string"
},
"executingUserKey" : {
"description" : "The user or process that has triggered the notification.",
"type" : "string"
},
"live" : {
"description" : "Indicates whether the notification originated from the live environment or the test environment. If true, the notification originated from the live environment. If false, the notification originated from the test environment.",
"type" : "boolean"
},
"pspReference" : {
"description" : "The PSP reference of the request from which the notification originates.",
"type" : "string"
}
},
"required" : [
"executingUserKey",
"pspReference",
"eventType",
"live",
"eventDate"
]
},
"AccountFundsBelowThresholdNotificationContent" : {
"properties" : {
"accountCode" : {
"description" : "The code of the account with funds under threshold",
"type" : "string"
},
"balanceDate" : {
"description" : "The date of the funds were found to be below threshold.",
"$ref" : "#/components/schemas/LocalDate"
},
"currentFunds" : {
"description" : "The current funds in the liable account.",
"$ref" : "#/components/schemas/Amount"
},
"fundThreshold" : {
"description" : "The configured fund threshold for the liable account",
"$ref" : "#/components/schemas/Amount"
},
"merchantAccountCode" : {
"description" : "The code of the merchant account.",
"type" : "string"
}
},
"required" : [
"accountCode",
"merchantAccountCode",
"fundThreshold"
]
},
"AccountHolderCreateNotification" : {
"properties" : {
"content" : {
"description" : "The details of the account holder creation.",
"$ref" : "#/components/schemas/CreateAccountHolderResponse"
},
"error" : {
"x-addedInVersion" : "5",
"description" : "Error information of failed request. No value provided here if no error occurred on processing.",
"$ref" : "#/components/schemas/NotificationErrorContainer"
},
"eventDate" : {
"x-addedInVersion" : "4",
"description" : "The date and time when an event has been completed.",
"format" : "date-time",
"type" : "string"
},
"eventType" : {
"description" : "The event type of the notification.",
"type" : "string"
},
"executingUserKey" : {
"description" : "The user or process that has triggered the notification.",
"type" : "string"
},
"live" : {
"description" : "Indicates whether the notification originated from the live environment or the test environment. If true, the notification originated from the live environment. If false, the notification originated from the test environment.",
"type" : "boolean"
},
"pspReference" : {
"description" : "The PSP reference of the request from which the notification originates.",
"type" : "string"
}
},
"required" : [
"executingUserKey",
"pspReference",
"eventType",
"live",
"eventDate",
"content"
]
},
"AccountHolderDetails" : {
"properties" : {
"address" : {
"description" : "The address of the account holder.",
"$ref" : "#/components/schemas/ViasAddress"
},
"bankAccountDetails" : {
"description" : "Array of bank accounts associated with the account holder. For details about the required `BankAccountDetail` fields, refer to [Bank account check](https://docs.adyen.com/platforms/verification-checks/bank-account-check).",
"items" : {
"$ref" : "#/components/schemas/BankAccountDetail"
},
"type" : "array"
},
"bankAggregatorDataReference" : {
"x-addedInVersion" : "5",
"description" : "The opaque reference value returned by the Adyen API during bank account login.",
"type" : "string"
},
"businessDetails" : {
"description" : "Details about the business or nonprofit account holder.\nRequired when creating an account holder with `legalEntity` **Business** or **NonProfit**.",
"$ref" : "#/components/schemas/BusinessDetails"
},
"email" : {
"description" : "The email address of the account holder.",
"type" : "string"
},
"fullPhoneNumber" : {
"description" : "The phone number of the account holder provided as a single string. It will be handled as a landline phone.\n**Examples:** \"0031 6 11 22 33 44\", \"+316/1122-3344\", \"(0031) 611223344\"",
"type" : "string"
},
"individualDetails" : {
"description" : "Details about the individual account holder.\nRequired when creating an account holder with `legalEntity` **Individual**.\n",
"$ref" : "#/components/schemas/IndividualDetails"
},
"legalArrangements" : {
"x-addedInVersion" : "6",
"description" : "An array containing information about the account holder's [legal arrangements](https://docs.adyen.com/platforms/verification-checks/legal-arrangements).",
"items" : {
"$ref" : "#/components/schemas/LegalArrangementDetail"
},
"type" : "array"
},
"merchantCategoryCode" : {
"description" : "The Merchant Category Code of the account holder.\n> If not specified in the request, this will be derived from the platform account (which is configured by Adyen).",
"type" : "string"
},
"metadata" : {
"additionalProperties" : {
"type" : "string"
},
"description" : "A set of key and value pairs for general use by the account holder or merchant.\nThe keys do not have specific names and may be used for storing miscellaneous data as desired.\n> The values being stored have a maximum length of eighty (80) characters and will be truncated if necessary.\n> Note that during an update of metadata, the omission of existing key-value pairs will result in the deletion of those key-value pairs.",
"type" : "object"
},
"payoutMethods" : {
"x-addedInVersion" : "5",
"description" : "Array of tokenized card details associated with the account holder. For details about how you can use the tokens to pay out, refer to [Pay out to cards](https://docs.adyen.com/platforms/payout-to-cards).",
"items" : {
"$ref" : "#/components/schemas/PayoutMethod"
},
"type" : "array"
},
"principalBusinessAddress" : {
"description" : "The principal business address of the account holder.",
"$ref" : "#/components/schemas/ViasAddress"
},
"storeDetails" : {
"x-addedInVersion" : "5",
"description" : "Array of stores associated with the account holder. Required when onboarding account holders that have an Adyen [point of sale](https://docs.adyen.com/platforms/platforms-for-pos).",
"items" : {
"$ref" : "#/components/schemas/StoreDetail"
},
"type" : "array"
},
"webAddress" : {
"description" : "The URL of the website of the account holder.",
"type" : "string"
}
},
"required" : [
"fullPhoneNumber",
"email",
"webAddress"
]
},
"AccountHolderPayoutNotification" : {
"properties" : {
"content" : {
"description" : "Details of the payout to the Account Holder.",
"$ref" : "#/components/schemas/AccountHolderPayoutNotificationContent"
},
"error" : {
"x-addedInVersion" : "5",
"description" : "Error information of failed request. No value provided here if no error occurred on processing.",
"$ref" : "#/components/schemas/NotificationErrorContainer"
},
"eventDate" : {
"x-addedInVersion" : "4",
"description" : "The date and time when an event has been completed.",
"format" : "date-time",
"type" : "string"
},
"eventType" : {
"description" : "The event type of the notification.",
"type" : "string"
},
"executingUserKey" : {
"description" : "The user or process that has triggered the notification.",
"type" : "string"
},
"live" : {
"description" : "Indicates whether the notification originated from the live environment or the test environment. If true, the notification originated from the live environment. If false, the notification originated from the test environment.",
"type" : "boolean"
},
"pspReference" : {
"description" : "The PSP reference of the request from which the notification originates.",
"type" : "string"
}
},
"required" : [
"executingUserKey",
"pspReference",
"eventType",
"live",
"eventDate",
"content"
]
},
"AccountHolderPayoutNotificationContent" : {
"properties" : {
"accountCode" : {
"description" : "The code of the account from which the payout was made.",
"type" : "string"
},
"accountHolderCode" : {
"description" : "The code of the Account Holder to which the payout was made.",
"type" : "string"
},
"amounts" : {
"description" : "The payout amounts (per currency).",
"items" : {
"$ref" : "#/components/schemas/Amount"
},
"type" : "array"
},
"bankAccountDetail" : {
"description" : "Details of the Bank Account to which the payout was made.",
"$ref" : "#/components/schemas/BankAccountDetail"
},
"description" : {
"description" : "A description of the payout.",
"type" : "string"
},
"estimatedArrivalDate" : {
"x-addedInVersion" : "5",
"description" : "The estimated date of arrival.",
"$ref" : "#/components/schemas/LocalDate"
},
"invalidFields" : {
"x-addedInVersion" : "5",
"description" : "Invalid fields list.",
"items" : {
"$ref" : "#/components/schemas/ErrorFieldType"
},
"type" : "array"
},
"merchantReference" : {
"x-addedInVersion" : "2",
"description" : "The merchant reference.",
"type" : "string"
},
"originalPspReference" : {
"x-addedInVersion" : "5",
"description" : "The PSP reference of the original payout.",
"type" : "string"
},
"payoutAccountCountry" : {
"x-addedInVersion" : "6",
"description" : "The country code of the bank from which the payout was initiated.",
"type" : "string"
},
"payoutAccountNumber" : {
"x-addedInVersion" : "6",
"description" : "The account number of the bank from which the payout was initiated.",
"type" : "string"
},
"payoutBankName" : {
"x-addedInVersion" : "6",
"description" : "The name of the bank the payout from which the payout was initiated.",
"type" : "string"
},
"payoutBranchCode" : {
"x-addedInVersion" : "6",
"description" : "The branch code of the bank from which the payout was initiated.",
"type" : "string"
},
"payoutReference" : {
"x-addedInVersion" : "6",
"description" : "The unique payout identifier.",
"format" : "int64",
"type" : "integer"
},
"payoutSpeed" : {
"x-addedInVersion" : "5",
"description" : "Speed with which payouts for this account are processed. Permitted values: `STANDARD`, `SAME_DAY`.",
"enum" : [
"INSTANT",
"SAME_DAY",
"STANDARD"
],
"type" : "string"
},
"status" : {
"description" : "The payout status.",
"$ref" : "#/components/schemas/OperationStatus"
}
},
"required" : [
"accountHolderCode",
"accountCode"
]
},
"AccountHolderStatus" : {
"properties" : {
"events" : {
"description" : "A list of events scheduled for the account holder.",
"items" : {
"$ref" : "#/components/schemas/AccountEvent"
},
"type" : "array"
},
"payoutState" : {
"description" : "The payout state of the account holder.",
"$ref" : "#/components/schemas/AccountPayoutState"
},
"processingState" : {
"description" : "The processing state of the account holder.",
"$ref" : "#/components/schemas/AccountProcessingState"
},
"status" : {
"description" : "The status of the account holder.\n>Permitted values: `Active`, `Inactive`, `Suspended`, `Closed`.",
"enum" : [
"Active",
"Closed",
"Inactive",
"Suspended"
],
"type" : "string"
},
"statusReason" : {
"description" : "The reason why the status was assigned to the account holder.",
"type" : "string"
}
},
"required" : [
"status"
]
},
"AccountHolderStatusChangeNotification" : {
"properties" : {
"content" : {
"description" : "The details of the Account Holder status change.",
"$ref" : "#/components/schemas/AccountHolderStatusChangeNotificationContent"
},
"error" : {
"x-addedInVersion" : "5",
"description" : "Error information of failed request. No value provided here if no error occurred on processing.",
"$ref" : "#/components/schemas/NotificationErrorContainer"
},
"eventDate" : {
"x-addedInVersion" : "4",
"description" : "The date and time when an event has been completed.",
"format" : "date-time",
"type" : "string"
},
"eventType" : {
"description" : "The event type of the notification.",
"type" : "string"
},
"executingUserKey" : {
"description" : "The user or process that has triggered the notification.",
"type" : "string"
},
"live" : {
"description" : "Indicates whether the notification originated from the live environment or the test environment. If true, the notification originated from the live environment. If false, the notification originated from the test environment.",
"type" : "boolean"
},
"pspReference" : {
"description" : "The PSP reference of the request from which the notification originates.",
"type" : "string"
}
},
"required" : [
"executingUserKey",
"pspReference",
"eventType",
"live",
"eventDate"
]
},
"AccountHolderStatusChangeNotificationContent" : {
"properties" : {
"accountHolderCode" : {
"description" : "The code of the account holder.",
"type" : "string"
},
"invalidFields" : {
"x-addedInVersion" : "5",
"description" : "in case the account holder has not been updated, contains account holder fields, that did not pass the validation.",
"items" : {
"$ref" : "#/components/schemas/ErrorFieldType"
},
"type" : "array"
},
"newStatus" : {
"x-addedInVersion" : "2",
"description" : "The new status of the account holder.",
"$ref" : "#/components/schemas/AccountHolderStatus"
},
"oldStatus" : {
"x-addedInVersion" : "2",
"description" : "The former status of the account holder.",
"$ref" : "#/components/schemas/AccountHolderStatus"
},
"reason" : {
"description" : "The reason for the status change.",
"type" : "string"
}
},
"required" : [
"accountHolderCode",
"oldStatus",
"newStatus"
]
},
"AccountHolderStoreStatusChangeNotification" : {
"properties" : {
"content" : {
"description" : "The details of the Account Holder Store status change.",
"$ref" : "#/components/schemas/AccountHolderStoreStatusChangeNotificationContent"
},
"error" : {
"x-addedInVersion" : "5",
"description" : "Error information of failed request. No value provided here if no error occurred on processing.",
"$ref" : "#/components/schemas/NotificationErrorContainer"
},
"eventDate" : {
"x-addedInVersion" : "4",
"description" : "The date and time when an event has been completed.",
"format" : "date-time",
"type" : "string"
},
"eventType" : {
"description" : "The event type of the notification.",
"type" : "string"
},
"executingUserKey" : {
"description" : "The user or process that has triggered the notification.",
"type" : "string"
},
"live" : {
"description" : "Indicates whether the notification originated from the live environment or the test environment. If true, the notification originated from the live environment. If false, the notification originated from the test environment.",
"type" : "boolean"
},
"pspReference" : {
"description" : "The PSP reference of the request from which the notification originates.",
"type" : "string"
}
},
"required" : [
"executingUserKey",
"pspReference",
"eventType",
"live",
"eventDate"
]
},
"AccountHolderStoreStatusChangeNotificationContent" : {
"properties" : {
"accountHolderCode" : {
"x-addedInVersion" : "5",
"description" : "The code of the account holder.",
"type" : "string"
},
"invalidFields" : {
"x-addedInVersion" : "5",
"description" : "In case the store status has not been updated, contains fields that did not pass the validation.",
"items" : {
"$ref" : "#/components/schemas/ErrorFieldType"
},
"type" : "array"
},
"newStatus" : {
"x-addedInVersion" : "5",
"description" : "The new status of the account holder.",
"enum" : [
"Active",
"Closed",
"Inactive",
"InactiveWithModifications",
"Pending"
],
"type" : "string"
},
"oldStatus" : {
"x-addedInVersion" : "5",
"description" : "The former status of the account holder.",
"enum" : [
"Active",
"Closed",
"Inactive",
"InactiveWithModifications",
"Pending"
],
"type" : "string"
},
"reason" : {
"x-addedInVersion" : "5",
"description" : "The reason for the status change.",
"type" : "string"
},
"store" : {
"x-addedInVersion" : "5",
"description" : "Alphanumeric identifier of the store.",
"type" : "string"
},
"storeReference" : {
"x-addedInVersion" : "5",
"description" : "Store store reference.",
"type" : "string"
}
},
"required" : [
"accountHolderCode",
"store",
"storeReference",
"oldStatus",
"newStatus"
]
},
"AccountHolderUpcomingDeadlineNotification" : {
"properties" : {
"content" : {
"description" : "The details of the upcoming event.",
"$ref" : "#/components/schemas/AccountHolderUpcomingDeadlineNotificationContent"
},
"error" : {
"x-addedInVersion" : "5",
"description" : "Error information of failed request. No value provided here if no error occurred on processing.",
"$ref" : "#/components/schemas/NotificationErrorContainer"
},
"eventDate" : {
"x-addedInVersion" : "4",
"description" : "The date and time when an event has been completed.",
"format" : "date-time",
"type" : "string"
},
"eventType" : {
"description" : "The event type of the notification.",
"type" : "string"
},
"executingUserKey" : {
"description" : "The user or process that has triggered the notification.",
"type" : "string"
},
"live" : {
"description" : "Indicates whether the notification originated from the live environment or the test environment. If true, the notification originated from the live environment. If false, the notification originated from the test environment.",
"type" : "boolean"
},
"pspReference" : {
"description" : "The PSP reference of the request from which the notification originates.",
"type" : "string"
}
},
"required" : [
"executingUserKey",
"pspReference",
"eventType",
"live",
"eventDate"
]
},
"AccountHolderUpcomingDeadlineNotificationContent" : {
"properties" : {
"accountHolderCode" : {
"description" : "The code of the account holder whom the event refers to.",
"type" : "string"
},
"event" : {
"description" : "The event name that will be trigger if no action is taken.",
"enum" : [
"AccessPii",
"ApiTierUpdate",
"CloseAccount",
"CloseStores",
"DeleteBankAccounts",
"DeletePayoutMethods",
"DeleteShareholders",
"DeleteSignatories",
"InactivateAccount",
"KYCDeadlineExtension",
"RecalculateAccountStatusAndProcessingTier",
"RefundNotPaidOutTransfers",
"ResolveEvents",
"SaveAccountHolder",
"SaveCriminalityAndPEPChecks",
"SaveKYCCheckStatus",
"SuspendAccount",
"UnSuspendAccount",
"UpdateAccountHolderState",
"Verification"
],
"type" : "string"
},
"executionDate" : {
"description" : "The execution date scheduled for the event.",
"format" : "date-time",
"type" : "string"
},
"reason" : {
"description" : "The reason that leads to scheduling of the event.",
"type" : "string"
}
}
},
"AccountHolderUpdateNotification" : {
"properties" : {
"content" : {
"description" : "The details of the Account Holder update.",
"$ref" : "#/components/schemas/UpdateAccountHolderResponse"
},
"error" : {
"x-addedInVersion" : "5",
"description" : "Error information of failed request. No value provided here if no error occurred on processing.",
"$ref" : "#/components/schemas/NotificationErrorContainer"
},
"eventDate" : {
"x-addedInVersion" : "4",
"description" : "The date and time when an event has been completed.",
"format" : "date-time",
"type" : "string"
},
"eventType" : {
"description" : "The event type of the notification.",
"type" : "string"
},
"executingUserKey" : {
"description" : "The user or process that has triggered the notification.",
"type" : "string"
},
"live" : {
"description" : "Indicates whether the notification originated from the live environment or the test environment. If true, the notification originated from the live environment. If false, the notification originated from the test environment.",
"type" : "boolean"
},
"pspReference" : {
"description" : "The PSP reference of the request from which the notification originates.",
"type" : "string"
}
},
"required" : [
"executingUserKey",
"pspReference",
"eventType",
"live",
"eventDate",
"content"
]
},
"AccountHolderVerificationNotification" : {
"properties" : {
"content" : {
"description" : "The details of the Account Holder verification.",
"$ref" : "#/components/schemas/AccountHolderVerificationNotificationContent"
},
"error" : {
"x-addedInVersion" : "5",
"description" : "Error information of failed request. No value provided here if no error occurred on processing.",
"$ref" : "#/components/schemas/NotificationErrorContainer"
},
"eventDate" : {
"x-addedInVersion" : "4",
"description" : "The date and time when an event has been completed.",
"format" : "date-time",
"type" : "string"
},
"eventType" : {
"description" : "The event type of the notification.",
"type" : "string"
},
"executingUserKey" : {
"description" : "The user or process that has triggered the notification.",
"type" : "string"
},
"live" : {
"description" : "Indicates whether the notification originated from the live environment or the test environment. If true, the notification originated from the live environment. If false, the notification originated from the test environment.",
"type" : "boolean"
},
"pspReference" : {
"description" : "The PSP reference of the request from which the notification originates.",
"type" : "string"
}
},
"required" : [
"executingUserKey",
"pspReference",
"eventType",
"live",
"eventDate",
"content"
]
},
"AccountHolderVerificationNotificationContent" : {
"properties" : {
"accountHolderCode" : {
"description" : "The code of the account holder.",
"type" : "string"
},
"kycCheckStatusData" : {
"x-addedInVersion" : "5",
"description" : "Information on the verification status",
"$ref" : "#/components/schemas/KYCCheckStatusData"
},
"legalArrangementCode" : {
"x-addedInVersion" : "6",
"description" : "The unique ID of the legal arrangement that has been verified.",
"type" : "string"
},
"legalArrangementEntityCode" : {
"x-addedInVersion" : "6",
"description" : "The unique ID of the legal arrangement entity that has been verified.",
"type" : "string"
},
"payoutMethodCode" : {
"x-addedInVersion" : "6",
"description" : "The unique code of the payout method that has been verified.",
"type" : "string"
},
"shareholderCode" : {
"description" : "The code of the shareholder that has been verified.",
"type" : "string"
},
"signatoryCode" : {
"description" : "The code of the signatory that has been verified.",
"type" : "string"
}
},
"required" : [
"accountHolderCode"
]
},
"AccountPayoutState" : {
"properties" : {
"allowPayout" : {
"description" : "Indicates whether payouts are allowed. This field is the overarching payout status, and is the aggregate of multiple conditions (e.g., KYC status, disabled flag, etc). If this field is false, no payouts will be permitted for any of the account holder's accounts. If this field is true, payouts will be permitted for any of the account holder's accounts.",
"type" : "boolean"
},
"disableReason" : {
"description" : "The reason why payouts (to all of the account holder's accounts) have been disabled (by the platform). If the `disabled` field is true, this field can be used to explain why.",
"type" : "string"
},
"disabled" : {
"description" : "Indicates whether payouts have been disabled (by the platform) for all of the account holder's accounts. A platform may enable and disable this field at their discretion. If this field is true, `allowPayout` will be false and no payouts will be permitted for any of the account holder's accounts. If this field is false, `allowPayout` may or may not be enabled, depending on other factors.",
"type" : "boolean"
},
"notAllowedReason" : {
"x-addedInVersion" : "5",
"description" : "The reason why payouts (to all of the account holder's accounts) have been disabled (by Adyen). If payouts have been disabled by Adyen, this field will explain why. If this field is blank, payouts have not been disabled by Adyen.",
"type" : "string"
},
"payoutLimit" : {
"description" : "The maximum amount that payouts are limited to. Only applies if payouts are allowed but limited.",
"$ref" : "#/components/schemas/Amount"
},
"tierNumber" : {
"x-addedInVersion" : "3",
"description" : "The payout tier that the account holder occupies.",
"format" : "int32",
"type" : "integer"
}
}
},
"AccountProcessingState" : {
"properties" : {
"disableReason" : {
"description" : "The reason why processing has been disabled.",
"type" : "string"
},
"disabled" : {
"description" : "Indicates whether the processing of payments is allowed.",
"type" : "boolean"
},
"processedFrom" : {
"description" : "The lower bound of the processing tier (i.e., an account holder must have processed at least this amount of money in order to be placed into this tier).",
"$ref" : "#/components/schemas/Amount"
},
"processedTo" : {
"description" : "The upper bound of the processing tier (i.e., an account holder must have processed less than this amount of money in order to be placed into this tier).",
"$ref" : "#/components/schemas/Amount"
},
"tierNumber" : {
"x-addedInVersion" : "3",
"description" : "The processing tier that the account holder occupies.",
"format" : "int32",
"type" : "integer"
}
}
},
"AccountUpdateNotification" : {
"properties" : {
"content" : {
"description" : "The details of the Account update.",
"$ref" : "#/components/schemas/UpdateAccountResponse"
},
"error" : {
"x-addedInVersion" : "5",
"description" : "Error information of failed request. No value provided here if no error occurred on processing.",
"$ref" : "#/components/schemas/NotificationErrorContainer"
},
"eventDate" : {
"x-addedInVersion" : "4",
"description" : "The date and time when an event has been completed.",
"format" : "date-time",
"type" : "string"
},
"eventType" : {
"description" : "The event type of the notification.",
"type" : "string"
},
"executingUserKey" : {
"description" : "The user or process that has triggered the notification.",
"type" : "string"
},
"live" : {
"description" : "Indicates whether the notification originated from the live environment or the test environment. If true, the notification originated from the live environment. If false, the notification originated from the test environment.",
"type" : "boolean"
},
"pspReference" : {
"description" : "The PSP reference of the request from which the notification originates.",
"type" : "string"
}
},
"required" : [
"executingUserKey",
"pspReference",
"eventType",
"live",
"eventDate",
"content"
]
},
"Amount" : {
"properties" : {
"currency" : {
"description" : "The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes).",
"maxLength" : 3,
"minLength" : 3,
"type" : "string"
},
"value" : {
"description" : "The amount of the transaction, in [minor units](https://docs.adyen.com/development-resources/currency-codes).",
"format" : "int64",
"type" : "integer"
}
},
"required" : [
"value",
"currency"
]
},
"BankAccountDetail" : {
"properties" : {
"accountNumber" : {
"description" : "The bank account number (without separators).\n>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on field requirements.",
"type" : "string"
},
"accountType" : {
"description" : "The type of bank account.\nOnly applicable to bank accounts held in the USA.\nThe permitted values are: `checking`, `savings`.\n\n>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on field requirements.",
"type" : "string"
},
"bankAccountName" : {
"description" : "The name of the bank account.",
"type" : "string"
},
"bankAccountReference" : {
"x-addedInVersion" : "5",
"description" : "Merchant reference to the bank account.",
"type" : "string"
},
"bankAccountUUID" : {
"description" : "The unique identifier (UUID) of the Bank Account.\n>If, during an account holder create or update request, this field is left blank (but other fields provided), a new Bank Account will be created with a procedurally-generated UUID.\n\n>If, during an account holder create request, a UUID is provided, the creation of the Bank Account will fail while the creation of the account holder will continue.\n\n>If, during an account holder update request, a UUID that is not correlated with an existing Bank Account is provided, the update of the account holder will fail.\n\n>If, during an account holder update request, a UUID that is correlated with an existing Bank Account is provided, the existing Bank Account will be updated.\n",
"type" : "string"
},
"bankBicSwift" : {
"description" : "The bank identifier code.\n>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on field requirements.",
"type" : "string"
},
"bankCity" : {
"description" : "The city in which the bank branch is located.\n\n>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on field requirements.",
"type" : "string"
},
"bankCode" : {
"description" : "The bank code of the banking institution with which the bank account is registered.\n\n>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on field requirements.",
"type" : "string"
},
"bankName" : {
"description" : "The name of the banking institution with which the bank account is held.\n\n>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on field requirements.",
"type" : "string"
},
"branchCode" : {
"description" : "The branch code of the branch under which the bank account is registered. The value to be specified in this parameter depends on the country of the bank account:\n* United States - Routing number\n* United Kingdom - Sort code\n* Germany - Bankleitzahl\n>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on field requirements.",
"type" : "string"
},
"checkCode" : {
"description" : "The check code of the bank account.\n\n>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on field requirements.",
"type" : "string"
},
"countryCode" : {
"description" : "The two-letter country code in which the bank account is registered.\n>The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL').\n\n>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on field requirements.",
"type" : "string"
},
"currencyCode" : {
"description" : "The currency in which the bank account deals.\n>The permitted currency codes are defined in ISO-4217 (e.g. 'EUR').\n\n>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on field requirements.",
"type" : "string"
},
"iban" : {
"description" : "The international bank account number.\n>The IBAN standard is defined in ISO-13616.\n\n>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on field requirements.",
"type" : "string"
},
"ownerCity" : {
"description" : "The city of residence of the bank account owner.\n>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on field requirements.",
"type" : "string"
},
"ownerCountryCode" : {
"description" : "The country code of the country of residence of the bank account owner.\n>The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL').\n\n>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on field requirements.",
"type" : "string"
},
"ownerDateOfBirth" : {
"description" : "The date of birth of the bank account owner.\n",
"type" : "string"
},
"ownerHouseNumberOrName" : {
"description" : "The house name or number of the residence of the bank account owner.\n>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on field requirements.",
"type" : "string"
},
"ownerName" : {
"description" : "The name of the bank account owner.\n>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on field requirements.",
"type" : "string"
},
"ownerNationality" : {
"description" : "The country code of the country of nationality of the bank account owner.\n>The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL').\n\n>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on field requirements.",
"type" : "string"
},
"ownerPostalCode" : {
"description" : "The postal code of the residence of the bank account owner.\n>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on field requirements.",
"type" : "string"
},
"ownerState" : {
"description" : "The state of residence of the bank account owner.\n>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on field requirements.",
"type" : "string"
},
"ownerStreet" : {
"description" : "The street name of the residence of the bank account owner.\n>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on field requirements.",
"type" : "string"
},
"primaryAccount" : {
"description" : "If set to true, the bank account is a primary account.",
"type" : "boolean"
},
"taxId" : {
"description" : "The tax ID number.\n\n>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on field requirements.",
"type" : "string"
},
"urlForVerification" : {
"description" : "The URL to be used for bank account verification.\nThis may be generated on bank account creation.\n\n>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on field requirements.",
"type" : "string"
}
}
},
"BeneficiarySetupNotification" : {
"properties" : {
"content" : {
"description" : "Details of the beneficiary setup.",
"$ref" : "#/components/schemas/BeneficiarySetupNotificationContent"
},
"error" : {
"x-addedInVersion" : "5",
"description" : "Error information of failed request. No value provided here if no error occurred on processing.",
"$ref" : "#/components/schemas/NotificationErrorContainer"
},
"eventDate" : {
"x-addedInVersion" : "4",
"description" : "The date and time when an event has been completed.",
"format" : "date-time",
"type" : "string"
},
"eventType" : {
"description" : "The event type of the notification.",
"type" : "string"
},
"executingUserKey" : {
"description" : "The user or process that has triggered the notification.",
"type" : "string"
},
"live" : {
"description" : "Indicates whether the notification originated from the live environment or the test environment. If true, the notification originated from the live environment. If false, the notification originated from the test environment.",
"type" : "boolean"
},
"pspReference" : {
"description" : "The PSP reference of the request from which the notification originates.",
"type" : "string"
}
},
"required" : [
"executingUserKey",
"pspReference",
"eventType",
"live",
"eventDate",
"content"
]
},
"BeneficiarySetupNotificationContent" : {
"properties" : {
"destinationAccountCode" : {
"description" : "The code of the beneficiary account.",
"type" : "string"
},
"destinationAccountHolderCode" : {
"description" : "The code of the beneficiary Account Holder.",
"type" : "string"
},
"invalidFields" : {
"x-addedInVersion" : "5",
"description" : "A listing of the invalid fields which have caused the Setup Beneficiary request to fail. If this is empty, the Setup Beneficiary request has succeeded.",
"items" : {
"$ref" : "#/components/schemas/ErrorFieldType"
},
"type" : "array"
},
"merchantReference" : {
"description" : "The reference provided by the merchant.",
"type" : "string"
},
"sourceAccountCode" : {
"description" : "The code of the benefactor account.",
"type" : "string"
},
"sourceAccountHolderCode" : {
"description" : "The code of the benefactor Account Holder.",
"type" : "string"
},
"transferDate" : {
"description" : "The date on which the beneficiary was set up and funds transferred from benefactor to beneficiary.",
"format" : "date-time",
"type" : "string"
}
},
"required" : [
"sourceAccountHolderCode",
"sourceAccountCode",
"destinationAccountHolderCode",
"destinationAccountCode",
"transferDate"
]
},
"BusinessDetails" : {
"properties" : {
"doingBusinessAs" : {
"description" : "The registered name of the company (if it differs from the legal name of the company).",
"type" : "string"
},
"legalBusinessName" : {
"description" : "The legal name of the company.",
"type" : "string"
},
"listedUltimateParentCompany" : {
"description" : "Information about the parent public company. Required if the account holder is 100% owned by a publicly listed company.",
"items" : {
"$ref" : "#/components/schemas/UltimateParentCompany"
},
"type" : "array"
},
"registrationNumber" : {
"x-addedInVersion" : "4",
"description" : "The registration number of the company.",
"type" : "string"
},
"shareholders" : {
"description" : "Array containing information about individuals associated with the account holder either through ownership or control. For details about how you can identify them, refer to [Identity check](https://docs.adyen.com/platforms/verification-checks/identity-check).",
"items" : {
"$ref" : "#/components/schemas/ShareholderContact"
},
"type" : "array"
},
"signatories" : {
"description" : "Signatories associated with the company.\nEach array entry should represent one signatory.",
"items" : {
"$ref" : "#/components/schemas/SignatoryContact"
},
"type" : "array"
},
"stockExchange" : {
"x-addedInVersion" : "6",
"description" : "Market Identifier Code (MIC).",
"type" : "string"
},
"stockNumber" : {
"x-addedInVersion" : "6",
"description" : "International Securities Identification Number (ISIN).",
"type" : "string"
},
"stockTicker" : {
"x-addedInVersion" : "6",
"description" : "Stock Ticker symbol.",
"type" : "string"
},
"taxId" : {
"description" : "The tax ID of the company.",
"type" : "string"
}
}
},
"CloseAccountResponse" : {
"properties" : {
"accountCode" : {
"x-addedInVersion" : "5",
"description" : "The account code of the account that is closed.",
"type" : "string"
},
"invalidFields" : {
"x-addedInVersion" : "5",
"description" : "Contains field validation errors that would prevent requests from being processed.",
"items" : {
"$ref" : "#/components/schemas/ErrorFieldType"
},
"type" : "array"
},
"pspReference" : {
"description" : "The reference of a request. Can be used to uniquely identify the request.",
"type" : "string"
},
"resultCode" : {
"description" : "The result code.",
"type" : "string"
},
"status" : {
"x-addedInVersion" : "2",
"description" : "The new status of the account.\n>Permitted values: `Active`, `Inactive`, `Suspended`, `Closed`.",
"enum" : [
"Active",
"Closed",
"Inactive",
"Suspended"
],
"type" : "string"
}
},
"required" : [
"status"
]
},
"CompensateNegativeBalanceNotification" : {
"properties" : {
"content" : {
"description" : "Details of the negative balance compensation.",
"$ref" : "#/components/schemas/CompensateNegativeBalanceNotificationContent"
},
"error" : {
"x-addedInVersion" : "5",
"description" : "Error information of failed request. No value provided here if no error occurred on processing.",
"$ref" : "#/components/schemas/NotificationErrorContainer"
},
"eventDate" : {
"x-addedInVersion" : "4",
"description" : "The date and time when an event has been completed.",
"format" : "date-time",
"type" : "string"
},
"eventType" : {
"description" : "The event type of the notification.",
"type" : "string"
},
"executingUserKey" : {
"description" : "The user or process that has triggered the notification.",
"type" : "string"
},
"live" : {
"description" : "Indicates whether the notification originated from the live environment or the test environment. If true, the notification originated from the live environment. If false, the notification originated from the test environment.",
"type" : "boolean"
},
"pspReference" : {
"description" : "The PSP reference of the request from which the notification originates.",
"type" : "string"
}
},
"required" : [
"executingUserKey",
"pspReference",
"eventType",
"live",
"eventDate"
]
},
"CompensateNegativeBalanceNotificationContent" : {
"properties" : {
"records" : {
"description" : "A list of the negative balances compensated.",
"items" : {
"$ref" : "#/components/schemas/CompensateNegativeBalanceNotificationRecord"
},
"type" : "array"
}
},
"required" : [
"records"
]
},
"CompensateNegativeBalanceNotificationRecord" : {
"properties" : {
"accountCode" : {
"description" : "The code of the account whose negative balance has been compensated.",
"type" : "string"
},
"amount" : {
"description" : "The amount compensated.",
"$ref" : "#/components/schemas/Amount"
},
"transferDate" : {
"description" : "The date on which the compensation took place.",
"format" : "date-time",
"type" : "string"
}
},
"required" : [
"accountCode",
"transferDate",
"amount"
]
},
"CreateAccountHolderResponse" : {
"properties" : {
"accountCode" : {
"description" : "The code of a new account created for the account holder.",
"type" : "string"
},
"accountHolderCode" : {
"description" : "The code of the new account holder.",
"type" : "string"
},
"accountHolderDetails" : {
"description" : "Details of the new account holder.",
"$ref" : "#/components/schemas/AccountHolderDetails"
},
"accountHolderStatus" : {
"x-addedInVersion" : "2",
"description" : "The status of the new account holder.",
"$ref" : "#/components/schemas/AccountHolderStatus"
},
"description" : {
"x-addedInVersion" : "4",
"description" : "The description of the new account holder.",
"type" : "string"
},
"invalidFields" : {
"x-addedInVersion" : "5",
"description" : "A list of fields that caused the `/createAccountHolder` request to fail.",
"items" : {
"$ref" : "#/components/schemas/ErrorFieldType"
},
"type" : "array"
},
"legalEntity" : {
"x-addedInVersion" : "4",
"description" : "The type of legal entity of the new account holder.",
"enum" : [
"Business",
"Individual",
"NonProfit",
"Partnership",
"PublicCompany"
],
"type" : "string"
},
"primaryCurrency" : {
"x-addedInVersion" : "5",
"description" : "The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes), with which the prospective account holder primarily deals.",
"type" : "string"
},
"pspReference" : {
"description" : "The reference of a request. Can be used to uniquely identify the request.",
"type" : "string"
},
"resultCode" : {
"description" : "The result code.",
"type" : "string"
},
"verification" : {
"x-addedInVersion" : "2",
"description" : "The details of KYC Verification of the account holder.",
"$ref" : "#/components/schemas/KYCVerificationResult2"
},
"verificationProfile" : {
"x-addedInVersion" : "6",
"description" : "The identifier of the profile that applies to this entity.",
"type" : "string"
}
},
"required" : [
"accountHolderCode",
"accountHolderStatus",
"accountHolderDetails",
"verification",
"legalEntity"
]
},
"CreateAccountResponse" : {
"properties" : {
"accountCode" : {
"description" : "The code of the new account.",
"type" : "string"
},
"accountHolderCode" : {
"description" : "The code of the account holder.",
"type" : "string"
},
"bankAccountUUID" : {
"x-addedInVersion" : "5",
"description" : "The bankAccountUUID of the bank account held by the account holder to couple the account with. Scheduled payouts in currencies matching the currency of this bank account will be sent to this bank account. Payouts in different currencies will be sent to a matching bank account of the account holder.",
"type" : "string"
},
"description" : {
"x-addedInVersion" : "4",
"description" : "The description of the account.",
"type" : "string"
},
"invalidFields" : {
"x-addedInVersion" : "5",
"description" : "A list of fields that caused the `/createAccount` request to fail.",
"items" : {
"$ref" : "#/components/schemas/ErrorFieldType"
},
"type" : "array"
},
"metadata" : {
"x-addedInVersion" : "5",
"additionalProperties" : {
"type" : "string"
},
"description" : "A set of key and value pairs containing metadata.",
"type" : "object"
},
"payoutMethodCode" : {
"x-addedInVersion" : "5",
"description" : "The payout method code held by the account holder to couple the account with. Scheduled card payouts will be sent using this payout method code.",
"type" : "string"
},
"payoutSchedule" : {
"description" : "The payout schedule of the account.",
"$ref" : "#/components/schemas/PayoutScheduleResponse"
},
"payoutSpeed" : {
"x-addedInVersion" : "5",
"description" : "Speed with which payouts for this account are processed. Permitted values: `STANDARD`, `SAME_DAY`.",
"enum" : [
"INSTANT",
"SAME_DAY",
"STANDARD"
],
"type" : "string"
},
"pspReference" : {
"description" : "The reference of a request. Can be used to uniquely identify the request.",
"type" : "string"
},
"resultCode" : {
"description" : "The result code.",
"type" : "string"
},
"status" : {
"x-addedInVersion" : "2",
"description" : "The status of the account.\n>Permitted values: `Active`.",
"enum" : [
"Active",
"Closed",
"Inactive",
"Suspended"
],
"type" : "string"
}
},
"required" : [
"accountHolderCode",
"accountCode",
"status"
]
},
"DirectDebitInitiatedNotification" : {
"properties" : {
"content" : {
"description" : "Details of the direct debit.",
"$ref" : "#/components/schemas/DirectDebitInitiatedNotificationContent"
},
"error" : {
"x-addedInVersion" : "5",
"description" : "Error information of failed request. No value provided here if no error occurred on processing.",
"$ref" : "#/components/schemas/NotificationErrorContainer"
},
"eventDate" : {
"x-addedInVersion" : "4",
"description" : "The date and time when an event has been completed.",
"format" : "date-time",
"type" : "string"
},
"eventType" : {
"description" : "The event type of the notification.",
"type" : "string"
},
"executingUserKey" : {
"description" : "The user or process that has triggered the notification.",
"type" : "string"
},
"live" : {
"description" : "Indicates whether the notification originated from the live environment or the test environment. If true, the notification originated from the live environment. If false, the notification originated from the test environment.",
"type" : "boolean"
},
"pspReference" : {
"description" : "The PSP reference of the request from which the notification originates.",
"type" : "string"
}
},
"required" : [
"executingUserKey",
"pspReference",
"eventType",
"live",
"eventDate"
]
},
"DirectDebitInitiatedNotificationContent" : {
"properties" : {
"accountCode" : {
"description" : "The code of the account.",
"type" : "string"
},
"amount" : {
"description" : "The amount to be debited from the funding account.",
"$ref" : "#/components/schemas/Amount"
},
"debitInitiationDate" : {
"description" : "The date of the debit initiation.",
"$ref" : "#/components/schemas/LocalDate"
},
"invalidFields" : {
"description" : "Invalid fields list.",
"items" : {
"$ref" : "#/components/schemas/ErrorFieldType"
},
"type" : "array"
},
"merchantAccountCode" : {
"description" : "The code of the merchant account.",
"type" : "string"
},
"splits" : {
"description" : "The split data for the debit request",
"items" : {
"$ref" : "#/components/schemas/Split"
},
"type" : "array"
},
"status" : {
"description" : "Direct debit status.",
"$ref" : "#/components/schemas/OperationStatus"
}
},
"required" : [
"amount",
"accountCode",
"merchantAccountCode"
]
},
"ErrorFieldType" : {
"properties" : {
"errorCode" : {
"description" : "The validation error code.",
"format" : "int32",
"type" : "integer"
},
"errorDescription" : {
"description" : "A description of the validation error.",
"type" : "string"
},
"fieldType" : {
"description" : "The type of error field.",
"$ref" : "#/components/schemas/FieldType"
}
}
},
"FieldType" : {
"properties" : {
"field" : {
"description" : "The full name of the property.",
"type" : "string"
},
"fieldName" : {
"description" : "The type of the field.",
"enum" : [
"accountCode",
"accountHolderCode",
"accountHolderDetails",
"accountNumber",
"accountStateType",
"accountStatus",
"accountType",
"address",
"bankAccount",
"bankAccountCode",
"bankAccountName",
"bankAccountUUID",
"bankBicSwift",
"bankCity",
"bankCode",
"bankName",
"bankStatement",
"branchCode",
"businessContact",
"cardToken",
"checkCode",
"city",
"companyRegistration",
"constitutionalDocument",
"country",
"countryCode",
"currency",
"currencyCode",
"dateOfBirth",
"description",
"destinationAccountCode",
"document",
"documentExpirationDate",
"documentIssuerCountry",
"documentIssuerState",
"documentName",
"documentNumber",
"documentType",
"doingBusinessAs",
"drivingLicence",
"drivingLicenceBack",
"drivingLicense",
"email",
"firstName",
"formType",
"fullPhoneNumber",
"gender",
"hopWebserviceUser",
"houseNumberOrName",
"iban",
"idCard",
"idCardBack",
"idCardFront",
"idNumber",
"identityDocument",
"individualDetails",
"jobTitle",
"lastName",
"legalArrangement",
"legalArrangementCode",
"legalArrangementEntity",
"legalArrangementEntityCode",
"legalArrangementLegalForm",
"legalArrangementMember",
"legalArrangementMembers",
"legalArrangementName",
"legalArrangementReference",
"legalArrangementRegistrationNumber",
"legalArrangementTaxNumber",
"legalArrangementType",
"legalBusinessName",
"legalEntity",
"legalEntityType",
"merchantAccount",
"merchantCategoryCode",
"merchantReference",
"microDeposit",
"name",
"nationality",
"originalReference",
"ownerCity",
"ownerCountryCode",
"ownerHouseNumberOrName",
"ownerName",
"ownerPostalCode",
"ownerState",
"ownerStreet",
"passport",
"passportNumber",
"payoutMethodCode",
"payoutSchedule",
"pciSelfAssessment",
"personalData",
"phoneCountryCode",
"phoneNumber",
"postalCode",
"primaryCurrency",
"reason",
"registrationNumber",
"returnUrl",
"schedule",
"shareholder",
"shareholderCode",
"shareholderCodeAndSignatoryCode",
"shareholderCodeOrSignatoryCode",
"shareholderType",
"shopperInteraction",
"signatory",
"signatoryCode",
"socialSecurityNumber",
"sourceAccountCode",
"splitAccount",
"splitConfigurationUUID",
"splitCurrency",
"splitValue",
"splits",
"stateOrProvince",
"status",
"stockExchange",
"stockNumber",
"stockTicker",
"store",
"storeDetail",
"storeName",
"storeReference",
"street",
"taxId",
"tier",
"tierNumber",
"transferCode",
"ultimateParentCompany",
"ultimateParentCompanyAddressDetails",
"ultimateParentCompanyAddressDetailsCountry",
"ultimateParentCompanyBusinessDetails",
"ultimateParentCompanyBusinessDetailsLegalBusinessName",
"ultimateParentCompanyBusinessDetailsRegistrationNumber",
"ultimateParentCompanyCode",
"ultimateParentCompanyStockExchange",
"ultimateParentCompanyStockNumber",
"ultimateParentCompanyStockNumberOrStockTicker",
"ultimateParentCompanyStockTicker",
"unknown",
"value",
"verificationType",
"virtualAccount",
"visaNumber",
"webAddress",
"year"
],
"type" : "string"
},
"shareholderCode" : {
"description" : "The code of the shareholder that the field belongs to. If empty, the field belongs to an account holder.",
"type" : "string"
}
}
},
"IndividualDetails" : {
"properties" : {
"name" : {
"description" : "The name of the individual.\n>Make sure your account holder registers using the name shown on their Photo ID.",
"$ref" : "#/components/schemas/ViasName"
},
"personalData" : {
"description" : "Personal information of the individual.",
"$ref" : "#/components/schemas/ViasPersonalData"
}
}
},
"KYCCheckResult2" : {
"properties" : {
"checks" : {
"description" : "A list of the checks and their statuses.",
"items" : {
"$ref" : "#/components/schemas/KYCCheckStatusData"
},
"type" : "array"
}
}
},
"KYCCheckStatusData" : {
"properties" : {
"requiredFields" : {
"description" : "A list of the fields required for execution of the check.",
"items" : {
"type" : "string"
},
"type" : "array"
},
"status" : {
"description" : "The status of the check.\n\nPossible values: **AWAITING_DATA** , **DATA_PROVIDED**, **FAILED**, **INVALID_DATA**, **PASSED**, **PENDING**, **RETRY_LIMIT_REACHED**.",
"enum" : [
"AWAITING_DATA",
"DATA_PROVIDED",
"FAILED",
"INVALID_DATA",
"PASSED",
"PENDING",
"PENDING_REVIEW",
"RETRY_LIMIT_REACHED",
"UNCHECKED"
],
"type" : "string"
},
"summary" : {
"description" : "A summary of the execution of the check.",
"$ref" : "#/components/schemas/KYCCheckSummary"
},
"type" : {
"description" : "The type of check.\n\nPossible values:\n\n * **BANK_ACCOUNT_VERIFICATION**: Used in v5 and earlier. Replaced by **PAYOUT_METHOD_VERIFICATION** in v6 and later.\n\n * **COMPANY_VERIFICATION**\n\n * **CARD_VERIFICATION**\n\n* **IDENTITY_VERIFICATION**\n\n* **LEGAL_ARRANGEMENT_VERIFICATION**\n\n* **NONPROFIT_VERIFICATION**\n\n * **PASSPORT_VERIFICATION**\n\n* **PAYOUT_METHOD_VERIFICATION**: Used in v6 and later.\n\n* **PCI_VERIFICATION**",
"enum" : [
"BANK_ACCOUNT_VERIFICATION",
"CARD_VERIFICATION",
"COMPANY_VERIFICATION",
"IDENTITY_VERIFICATION",
"LEGAL_ARRANGEMENT_VERIFICATION",
"NONPROFIT_VERIFICATION",
"PASSPORT_VERIFICATION",
"PAYOUT_METHOD_VERIFICATION",
"PCI_VERIFICATION"
],
"type" : "string"
}
},
"required" : [
"type",
"status"
]
},
"KYCCheckSummary" : {
"properties" : {
"kycCheckCode" : {
"x-addedInVersion" : "5",
"description" : "The code of the check. For possible values, refer to [Verification codes](https://docs.adyen.com/platforms/verification-codes).",
"format" : "int32",
"type" : "integer"
},
"kycCheckDescription" : {
"x-addedInVersion" : "5",
"description" : "A description of the check.",
"type" : "string"
}
}
},
"KYCLegalArrangementCheckResult" : {
"properties" : {
"checks" : {
"description" : "A list of the checks and their statuses.",
"items" : {
"$ref" : "#/components/schemas/KYCCheckStatusData"
},
"type" : "array"
},
"legalArrangementCode" : {
"description" : "The unique ID of the legal arrangement to which the check applies.",
"type" : "string"
}
}
},
"KYCLegalArrangementEntityCheckResult" : {
"properties" : {
"checks" : {
"description" : "A list of the checks and their statuses.",
"items" : {
"$ref" : "#/components/schemas/KYCCheckStatusData"
},
"type" : "array"
},
"legalArrangementCode" : {
"description" : "The unique ID of the legal arrangement to which the entity belongs.",
"type" : "string"
},
"legalArrangementEntityCode" : {
"description" : "The unique ID of the legal arrangement entity to which the check applies.",
"type" : "string"
}
}
},
"KYCPayoutMethodCheckResult" : {
"properties" : {
"checks" : {
"description" : "A list of the checks and their statuses.",
"items" : {
"$ref" : "#/components/schemas/KYCCheckStatusData"
},
"type" : "array"
},
"payoutMethodCode" : {
"description" : "The unique ID of the payoput method to which the check applies.",
"type" : "string"
}
}
},
"KYCShareholderCheckResult" : {
"properties" : {
"checks" : {
"description" : "A list of the checks and their statuses.",
"items" : {
"$ref" : "#/components/schemas/KYCCheckStatusData"
},
"type" : "array"
},
"legalArrangementCode" : {
"x-addedInVersion" : "6",
"description" : "The unique ID of the legal arrangement to which the shareholder belongs, if applicable.",
"type" : "string"
},
"legalArrangementEntityCode" : {
"x-addedInVersion" : "6",
"description" : "The unique ID of the legal arrangement entity to which the shareholder belongs, if applicable.",
"type" : "string"
},
"shareholderCode" : {
"description" : "The code of the shareholder to which the check applies.",
"type" : "string"
}
}
},
"KYCSignatoryCheckResult" : {
"properties" : {
"checks" : {
"description" : "A list of the checks and their statuses.",
"items" : {
"$ref" : "#/components/schemas/KYCCheckStatusData"
},
"type" : "array"
},
"signatoryCode" : {
"description" : "The code of the signatory to which the check applies.",
"type" : "string"
}
}
},
"KYCUltimateParentCompanyCheckResult" : {
"properties" : {
"checks" : {
"description" : "A list of the checks and their statuses.",
"items" : {
"$ref" : "#/components/schemas/KYCCheckStatusData"
},
"type" : "array"
},
"ultimateParentCompanyCode" : {
"x-addedInVersion" : "6",
"description" : "The code of the Ultimate Parent Company to which the check applies.",
"type" : "string"
}
}
},
"KYCVerificationResult2" : {
"properties" : {
"accountHolder" : {
"description" : "The results of the checks on the account holder.",
"$ref" : "#/components/schemas/KYCCheckResult2"
},
"legalArrangements" : {
"x-addedInVersion" : "6",
"description" : "The results of the checks on the legal arrangements.",
"items" : {
"$ref" : "#/components/schemas/KYCLegalArrangementCheckResult"
},
"type" : "array"
},
"legalArrangementsEntities" : {
"x-addedInVersion" : "6",
"description" : "The results of the checks on the legal arrangement entities.",
"items" : {
"$ref" : "#/components/schemas/KYCLegalArrangementEntityCheckResult"
},
"type" : "array"
},
"payoutMethods" : {
"x-addedInVersion" : "6",
"description" : "The results of the checks on the payout methods.",
"items" : {
"$ref" : "#/components/schemas/KYCPayoutMethodCheckResult"
},
"type" : "array"
},
"shareholders" : {
"description" : "The results of the checks on the shareholders.",
"items" : {
"$ref" : "#/components/schemas/KYCShareholderCheckResult"
},
"type" : "array"
},
"signatories" : {
"description" : "The results of the checks on the signatories.",
"items" : {
"$ref" : "#/components/schemas/KYCSignatoryCheckResult"
},
"type" : "array"
},
"ultimateParentCompany" : {
"x-addedInVersion" : "6",
"description" : "The result of the check on the Ultimate Parent Company.",
"items" : {
"$ref" : "#/components/schemas/KYCUltimateParentCompanyCheckResult"
},
"type" : "array"
}
}
},
"LegalArrangementDetail" : {
"properties" : {
"address" : {
"description" : "The address of the legal arrangement.",
"$ref" : "#/components/schemas/ViasAddress"
},
"legalArrangementCode" : {
"description" : "Adyen-generated unique alphanumeric identifier (UUID) for the entry, returned in the response when you create a legal arrangement. Required when updating an existing legal arrangement entry in an `/updateAccountHolder` request.",
"type" : "string"
},
"legalArrangementEntities" : {
"description" : "An array containing information about other entities that are part of the legal arrangement.",
"items" : {
"$ref" : "#/components/schemas/LegalArrangementEntityDetail"
},
"type" : "array"
},
"legalArrangementReference" : {
"description" : "Your reference for the legal arrangement. Must be between 3 to 128 characters.",
"type" : "string"
},
"legalForm" : {
"description" : "The form of legal arrangement. Required if `type` is **Trust** or **Partnership**.\n\nThe possible values depend on the `type`.\n\n- For `type` **Trust**: **CashManagementTrust**, **CorporateUnitTrust**, **DeceasedEstate**, **DiscretionaryInvestmentTrust**, **DiscretionaryServicesManagementTrust**, **DiscretionaryTradingTrust**, **FirstHomeSaverAccountsTrust**, **FixedTrust**, **FixedUnitTrust**, **HybridTrust**, **ListedPublicUnitTrust**, **OtherTrust**, **PooledSuperannuationTrust**, **PublicTradingTrust**, or **UnlistedPublicUnitTrust**.\n\n- For `type` **Partnership**: **LimitedPartnership**, **FamilyPartnership**, or **OtherPartnership**",
"enum" : [
"CashManagementTrust",
"CorporateUnitTrust",
"DeceasedEstate",
"DiscretionaryInvestmentTrust",
"DiscretionaryServicesManagementTrust",
"DiscretionaryTradingTrust",
"FirstHomeSaverAccountsTrust",
"FixedTrust",
"FixedUnitTrust",
"HybridTrust",
"ListedPublicUnitTrust",
"OtherTrust",
"PooledSuperannuationTrust",
"PublicTradingTrust",
"UnlistedPublicUnitTrust",
"LimitedPartnership",
"FamilyPartnership",
"OtherPartnership"
],
"type" : "string"
},
"name" : {
"description" : "The legal name of the legal arrangement. Minimum length: 3 characters.",
"type" : "string"
},
"registrationNumber" : {
"description" : "The registration number of the legal arrangement.",
"type" : "string"
},
"taxNumber" : {
"description" : "The tax identification number of the legal arrangement.",
"type" : "string"
},
"type" : {
"description" : "The [type of legal arrangement](https://docs.adyen.com/platforms/verification-checks/legal-arrangements#types-of-legal-arrangements).\n\nPossible values:\n\n- **Association** \n\n- **Partnership** \n\n- **SoleProprietorship** \n\n- **Trust** \n\n",
"enum" : [
"Association",
"Partnership",
"SoleProprietorship",
"Trust"
],
"type" : "string"
}
},
"required" : [
"type",
"name",
"address"
]
},
"LegalArrangementEntityDetail" : {
"properties" : {
"address" : {
"description" : "The address of the entity.",
"$ref" : "#/components/schemas/ViasAddress"
},
"businessDetails" : {
"description" : "Required when creating an entity with `legalEntityType` **Business**, **NonProfit**, **PublicCompany**, or **Partnership**.",
"$ref" : "#/components/schemas/BusinessDetails"
},
"email" : {
"description" : "The e-mail address of the entity.",
"type" : "string"
},
"fullPhoneNumber" : {
"description" : "The phone number of the contact provided as a single string. It will be handled as a landline phone.\n**Examples:** \"0031 6 11 22 33 44\", \"+316/1122-3344\", \"(0031) 611223344\"",
"type" : "string"
},
"individualDetails" : {
"description" : "Required when creating an entity with `legalEntityType` **Individual**.",
"$ref" : "#/components/schemas/IndividualDetails"
},
"legalArrangementEntityCode" : {
"description" : "Adyen-generated unique alphanumeric identifier (UUID) for the entry, returned in the response when you create a legal arrangement entity. Required when updating an existing legal arrangement entity entry in an `/updateAccountHolder` request.",
"type" : "string"
},
"legalArrangementEntityReference" : {
"description" : "Your reference for the legal arrangement entity.",
"type" : "string"
},
"legalArrangementMembers" : {
"description" : "An array containing the roles of the entity in the legal arrangement.\n\nThe possible values depend on the legal arrangement `type`.\n\n- For `type` **Association**: **ControllingPerson** and **Shareholder**.\n\n- For `type` **Partnership**: **Partner** and **Shareholder**.\n\n- For `type` **Trust**: **Trustee**, **Settlor**, **Protector**, **Beneficiary**, and **Shareholder**.\n\n",
"items" : {
"enum" : [
"Beneficiary",
"ControllingPerson",
"Partner",
"Protector",
"Settlor",
"Shareholder",
"Trustee"
],
"type" : "string"
},
"type" : "array"
},
"legalEntityType" : {
"description" : "The legal entity type.\n\nPossible values: **Business**, **Individual**, **NonProfit**, **PublicCompany**, or **Partnership**. ",
"enum" : [
"Business",
"Individual",
"NonProfit",
"Partnership",
"PublicCompany"
],
"type" : "string"
},
"phoneNumber" : {
"description" : "The phone number of the entity.",
"$ref" : "#/components/schemas/ViasPhoneNumber"
},
"webAddress" : {
"description" : "The URL of the website of the contact.",
"type" : "string"
}
},
"required" : [
"legalEntityType"
]
},
"LocalDate" : {
"properties" : {
"month" : {
"format" : "int32",
"type" : "integer"
},
"year" : {
"format" : "int32",
"type" : "integer"
}
}
},
"Message" : {
"properties" : {
"code" : {
"description" : "The message code.",
"type" : "string"
},
"text" : {
"description" : "The message text.",
"type" : "string"
}
}
},
"NotificationErrorContainer" : {
"properties" : {
"errorCode" : {
"description" : "The Adyen code that is mapped to the error message.",
"type" : "string"
},
"message" : {
"description" : "A short explanation of the issue.",
"type" : "string"
}
}
},
"NotificationResponse" : {
"properties" : {
"notificationResponse" : {
"description" : "Set this parameter to **[accepted]** to acknowledge that you received a notification from Adyen.",
"type" : "string"
}
}
},
"OperationStatus" : {
"properties" : {
"message" : {
"description" : "The message regarding the operation status.",
"$ref" : "#/components/schemas/Message"
},
"statusCode" : {
"description" : "The status code.",
"type" : "string"
}
}
},
"PaymentFailureNotification" : {
"properties" : {
"content" : {
"description" : "The details of the payment failure.",
"$ref" : "#/components/schemas/PaymentFailureNotificationContent"
},
"error" : {
"x-addedInVersion" : "5",
"description" : "Error information of failed request. No value provided here if no error occurred on processing.",
"$ref" : "#/components/schemas/NotificationErrorContainer"
},
"eventDate" : {
"x-addedInVersion" : "4",
"description" : "The date and time when an event has been completed.",
"format" : "date-time",
"type" : "string"
},
"eventType" : {
"description" : "The event type of the notification.",
"type" : "string"
},
"executingUserKey" : {
"description" : "The user or process that has triggered the notification.",
"type" : "string"
},
"live" : {
"description" : "Indicates whether the notification originated from the live environment or the test environment. If true, the notification originated from the live environment. If false, the notification originated from the test environment.",
"type" : "boolean"
},
"pspReference" : {
"description" : "The PSP reference of the request from which the notification originates.",
"type" : "string"
}
},
"required" : [
"executingUserKey",
"pspReference",
"eventType",
"live",
"eventDate",
"content"
]
},
"PaymentFailureNotificationContent" : {
"properties" : {
"errorFields" : {
"description" : "Missing or invalid fields that caused the payment error.",
"items" : {
"$ref" : "#/components/schemas/ErrorFieldType"
},
"type" : "array"
},
"errorMessage" : {
"description" : "The error message.",
"$ref" : "#/components/schemas/Message"
},
"modificationMerchantReference" : {
"description" : "The `reference` of the capture or refund.",
"type" : "string"
},
"modificationPspReference" : {
"description" : "The `pspReference` of the capture or refund.",
"type" : "string"
},
"paymentMerchantReference" : {
"description" : "The `reference` of the payment.",
"type" : "string"
},
"paymentPspReference" : {
"description" : "The `pspReference` of the payment.",
"type" : "string"
}
},
"required" : [
"errorMessage",
"errorFields"
]
},
"PayoutMethod" : {
"properties" : {
"merchantAccount" : {
"description" : "The [`merchantAccount`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__reqParam_merchantAccount) you used in the `/payments` request when you [saved the account holder's card details](https://docs.adyen.com/platforms/payout-to-cards#check-and-store).",
"type" : "string"
},
"payoutMethodCode" : {
"description" : "Adyen-generated unique alphanumeric identifier (UUID) for the payout method, returned in the response when you create a payout method. Required when updating an existing payout method in an `/updateAccountHolder` request.",
"type" : "string"
},
"payoutMethodReference" : {
"description" : "Your reference for the payout method.",
"type" : "string"
},
"recurringDetailReference" : {
"description" : "The [`recurringDetailReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_additionalData-ResponseAdditionalDataCommon-recurring-recurringDetailReference) returned in the `/payments` response when you [saved the account holder's card details](https://docs.adyen.com/platforms/payout-to-cards#check-and-store).",
"type" : "string"
},
"shopperReference" : {
"description" : "The [`shopperReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__reqParam_shopperReference) you sent in the `/payments` request when you [saved the account holder's card details](https://docs.adyen.com/platforms/payout-to-cards#check-and-store).",
"type" : "string"
}
},
"required" : [
"merchantAccount",
"shopperReference",
"recurringDetailReference"
]
},
"PayoutScheduleResponse" : {
"properties" : {
"nextScheduledPayout" : {
"description" : "The date of the next scheduled payout.",
"format" : "date-time",
"type" : "string"
},
"schedule" : {
"description" : "The payout schedule of the account.\n>Permitted values: `DEFAULT`, `HOLD`, `DAILY`, `WEEKLY`, `MONTHLY`.",
"enum" : [
"BIWEEKLY_ON_1ST_AND_15TH_AT_MIDNIGHT",
"BIWEEKLY_ON_1ST_AND_15TH_AT_NOON",
"BI_DAILY_AU",
"BI_DAILY_EU",
"BI_DAILY_US",
"DAILY",
"DAILY_6PM",
"DAILY_AU",
"DAILY_EU",
"DAILY_SG",
"DAILY_US",
"DEFAULT",
"EVERY_6_HOURS_FROM_MIDNIGHT",
"HOLD",
"MONTHLY",
"MONTHLY_ON_15TH_AT_MIDNIGHT",
"WEEKLY",
"WEEKLY_ON_TUE_FRI_MIDNIGHT",
"YEARLY"
],
"type" : "string"
}
},
"required" : [
"schedule"
]
},
"PersonalDocumentData" : {
"properties" : {
"expirationDate" : {
"description" : "The expiry date of the document, \n in ISO-8601 YYYY-MM-DD format. For example, **2000-01-31**.",
"type" : "string"
},
"issuerCountry" : {
"description" : "The country where the document was issued, in the two-character \n[ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. For example, **NL**.",
"maxLength" : 2,
"minLength" : 2,
"type" : "string"
},
"issuerState" : {
"description" : "The state where the document was issued (if applicable).",
"type" : "string"
},
"number" : {
"description" : "The number in the document.",
"type" : "string"
},
"type" : {
"description" : "The type of the document. Possible values: **ID**, **DRIVINGLICENSE**, **PASSPORT**, **SOCIALSECURITY**, **VISA**.\n\nTo delete an existing entry for a document `type`, send only the `type` field in your request. ",
"enum" : [
"DRIVINGLICENSE",
"ID",
"PASSPORT",
"SOCIALSECURITY",
"VISA"
],
"type" : "string"
}
},
"required" : [
"type"
]
},
"RefundFundsTransferNotification" : {
"properties" : {
"content" : {
"description" : "Details of the fund transfer refund.",
"$ref" : "#/components/schemas/RefundFundsTransferNotificationContent"
},
"error" : {
"x-addedInVersion" : "5",
"description" : "Error information of failed request. No value provided here if no error occurred on processing.",
"$ref" : "#/components/schemas/NotificationErrorContainer"
},
"eventDate" : {
"x-addedInVersion" : "4",
"description" : "The date and time when an event has been completed.",
"format" : "date-time",
"type" : "string"
},
"eventType" : {
"description" : "The event type of the notification.",
"type" : "string"
},
"executingUserKey" : {
"description" : "The user or process that has triggered the notification.",
"type" : "string"
},
"live" : {
"description" : "Indicates whether the notification originated from the live environment or the test environment. If true, the notification originated from the live environment. If false, the notification originated from the test environment.",
"type" : "boolean"
},
"pspReference" : {
"description" : "The PSP reference of the request from which the notification originates.",
"type" : "string"
}
},
"required" : [
"executingUserKey",
"pspReference",
"eventType",
"live",
"eventDate",
"content"
]
},
"RefundFundsTransferNotificationContent" : {
"properties" : {
"amount" : {
"description" : "The amount to be refunded.",
"$ref" : "#/components/schemas/Amount"
},
"invalidFields" : {
"x-addedInVersion" : "5",
"description" : "Invalid fields list.",
"items" : {
"$ref" : "#/components/schemas/ErrorFieldType"
},
"type" : "array"
},
"merchantReference" : {
"description" : "A value that can be supplied at the discretion of the executing user in order to link multiple transactions to one another.",
"type" : "string"
},
"originalReference" : {
"description" : "A PSP reference of the original fund transfer.",
"type" : "string"
},
"status" : {
"description" : "The status of the fund transfer refund.",
"$ref" : "#/components/schemas/OperationStatus"
}
},
"required" : [
"originalReference",
"amount"
]
},
"RefundResult" : {
"properties" : {
"originalTransaction" : {
"description" : "The transaction that has been refunded.",
"$ref" : "#/components/schemas/Transaction"
},
"pspReference" : {
"description" : "The reference of the refund.",
"type" : "string"
},
"response" : {
"description" : "The response indicating if the refund has been received for processing.",
"type" : "string"
}
},
"required" : [
"pspReference",
"originalTransaction"
]
},
"ReportAvailableNotification" : {
"properties" : {
"content" : {
"description" : "Details of the report.",
"$ref" : "#/components/schemas/ReportAvailableNotificationContent"
},
"error" : {
"x-addedInVersion" : "5",
"description" : "Error information of failed request. No value provided here if no error occurred on processing.",
"$ref" : "#/components/schemas/NotificationErrorContainer"
},
"eventDate" : {
"x-addedInVersion" : "4",
"description" : "The date and time when an event has been completed.",
"format" : "date-time",
"type" : "string"
},
"eventType" : {
"description" : "The event type of the notification.",
"type" : "string"
},
"executingUserKey" : {
"description" : "The user or process that has triggered the notification.",
"type" : "string"
},
"live" : {
"description" : "Indicates whether the notification originated from the live environment or the test environment. If true, the notification originated from the live environment. If false, the notification originated from the test environment.",
"type" : "boolean"
},
"pspReference" : {
"description" : "The PSP reference of the request from which the notification originates.",
"type" : "string"
}
},
"required" : [
"executingUserKey",
"pspReference",
"eventType",
"live",
"eventDate",
"content"
]
},
"ReportAvailableNotificationContent" : {
"properties" : {
"accountCode" : {
"description" : "The code of the Account to which the report applies.",
"type" : "string"
},
"accountType" : {
"description" : "The type of Account to which the report applies.",
"type" : "string"
},
"eventDate" : {
"description" : "The date of the event to which the report applies.",
"format" : "date-time",
"type" : "string"
},
"remoteAccessUrl" : {
"description" : "The URL at which the report can be accessed.",
"type" : "string"
},
"success" : {
"description" : "Indicates whether the event resulted in a success.",
"type" : "boolean"
}
}
},
"ScheduledRefundsNotification" : {
"properties" : {
"content" : {
"description" : "Details of the scheduling of the refunds.",
"$ref" : "#/components/schemas/ScheduledRefundsNotificationContent"
},
"error" : {
"x-addedInVersion" : "5",
"description" : "Error information of failed request. No value provided here if no error occurred on processing.",
"$ref" : "#/components/schemas/NotificationErrorContainer"
},
"eventDate" : {
"x-addedInVersion" : "4",
"description" : "The date and time when an event has been completed.",
"format" : "date-time",
"type" : "string"
},
"eventType" : {
"description" : "The event type of the notification.",
"type" : "string"
},
"executingUserKey" : {
"description" : "The user or process that has triggered the notification.",
"type" : "string"
},
"live" : {
"description" : "Indicates whether the notification originated from the live environment or the test environment. If true, the notification originated from the live environment. If false, the notification originated from the test environment.",
"type" : "boolean"
},
"pspReference" : {
"description" : "The PSP reference of the request from which the notification originates.",
"type" : "string"
}
},
"required" : [
"executingUserKey",
"pspReference",
"eventType",
"live",
"eventDate",
"content"
]
},
"ScheduledRefundsNotificationContent" : {
"properties" : {
"accountCode" : {
"description" : "The code of the account.",
"type" : "string"
},
"accountHolderCode" : {
"description" : "The code of the Account Holder.",
"type" : "string"
},
"invalidFields" : {
"x-addedInVersion" : "5",
"description" : "Invalid fields list.",
"items" : {
"$ref" : "#/components/schemas/ErrorFieldType"
},
"type" : "array"
},
"lastPayout" : {
"description" : "The most recent payout (after which all transactions were scheduled to be refunded).",
"$ref" : "#/components/schemas/Transaction"
},
"refundResults" : {
"description" : "A list of the refunds that have been scheduled and their results.",
"items" : {
"$ref" : "#/components/schemas/RefundResult"
},
"type" : "array"
}
},
"required" : [
"accountHolderCode",
"accountCode",
"refundResults"
]
},
"ShareholderContact" : {
"properties" : {
"address" : {
"description" : "The address of the person.",
"$ref" : "#/components/schemas/ViasAddress"
},
"email" : {
"description" : "The e-mail address of the person.",
"type" : "string"
},
"fullPhoneNumber" : {
"description" : "The phone number of the person provided as a single string. It will be handled as a landline phone.\nExamples: \"0031 6 11 22 33 44\", \"+316/1122-3344\", \"(0031) 611223344\"",
"type" : "string"
},
"jobTitle" : {
"description" : "Job title of the person. Required when the `shareholderType` is **Controller**.\n\nExample values: **Chief Executive Officer**, **Chief Financial Officer**, **Chief Operating Officer**, **President**, **Vice President**, **Executive President**, **Managing Member**, **Partner**, **Treasurer**, **Director**, or **Other**.",
"type" : "string"
},
"name" : {
"description" : "The name of the person.",
"$ref" : "#/components/schemas/ViasName"
},
"personalData" : {
"description" : "Contains information about the person.",
"$ref" : "#/components/schemas/ViasPersonalData"
},
"phoneNumber" : {
"description" : "The phone number of the person.",
"$ref" : "#/components/schemas/ViasPhoneNumber"
},
"shareholderCode" : {
"description" : "The unique identifier (UUID) of the shareholder entry.\n>**If, during an Account Holder create or update request, this field is left blank (but other fields provided), a new Shareholder will be created with a procedurally-generated UUID.**\n\n>**If, during an Account Holder create request, a UUID is provided, the creation of the Shareholder will fail while the creation of the Account Holder will continue.**\n\n>**If, during an Account Holder update request, a UUID that is not correlated with an existing Shareholder is provided, the update of the Shareholder will fail.**\n\n>**If, during an Account Holder update request, a UUID that is correlated with an existing Shareholder is provided, the existing Shareholder will be updated.**\n",
"type" : "string"
},
"shareholderReference" : {
"x-addedInVersion" : "5",
"description" : "Your reference for the shareholder entry.",
"type" : "string"
},
"shareholderType" : {
"description" : "Specifies how the person is associated with the account holder. \n\nPossible values: \n\n* **Owner**: Individuals who directly or indirectly own 25% or more of a company.\n\n* **Controller**: Individuals who are members of senior management staff responsible for managing a company or organization.",
"enum" : [
"Controller",
"Owner",
"Signatory"
],
"type" : "string"
},
"webAddress" : {
"description" : "The URL of the person's website.",
"type" : "string"
}
}
},
"SignatoryContact" : {
"properties" : {
"address" : {
"description" : "The address of the person.",
"$ref" : "#/components/schemas/ViasAddress"
},
"email" : {
"description" : "The e-mail address of the person.",
"type" : "string"
},
"fullPhoneNumber" : {
"description" : "The phone number of the person provided as a single string. It will be handled as a landline phone.\nExamples: \"0031 6 11 22 33 44\", \"+316/1122-3344\", \"(0031) 611223344\"",
"type" : "string"
},
"jobTitle" : {
"description" : "Job title of the signatory.\n\nExample values: **Chief Executive Officer**, **Chief Financial Officer**, **Chief Operating Officer**, **President**, **Vice President**, **Executive President**, **Managing Member**, **Partner**, **Treasurer**, **Director**, or **Other**.",
"type" : "string"
},
"name" : {
"description" : "The name of the person.",
"$ref" : "#/components/schemas/ViasName"
},
"personalData" : {
"description" : "Contains information about the person.",
"$ref" : "#/components/schemas/ViasPersonalData"
},
"phoneNumber" : {
"description" : "The phone number of the person.",
"$ref" : "#/components/schemas/ViasPhoneNumber"
},
"signatoryCode" : {
"description" : "The unique identifier (UUID) of the signatory.\n>**If, during an Account Holder create or update request, this field is left blank (but other fields provided), a new Signatory will be created with a procedurally-generated UUID.**\n\n>**If, during an Account Holder create request, a UUID is provided, the creation of the Signatory will fail while the creation of the Account Holder will continue.**\n\n>**If, during an Account Holder update request, a UUID that is not correlated with an existing Signatory is provided, the update of the Signatory will fail.**\n\n>**If, during an Account Holder update request, a UUID that is correlated with an existing Signatory is provided, the existing Signatory will be updated.**\n",
"type" : "string"
},
"signatoryReference" : {
"description" : "Your reference for the signatory.",
"type" : "string"
},
"webAddress" : {
"description" : "The URL of the person's website.",
"type" : "string"
}
}
},
"Split" : {
"properties" : {
"account" : {
"description" : "Unique identifier of the account where the split amount should be sent. This is required if `type` is **MarketPlace** or **BalanceAccount**.\n\n",
"type" : "string"
},
"amount" : {
"description" : "The amount of this split.",
"$ref" : "#/components/schemas/SplitAmount"
},
"description" : {
"description" : "A description of this split.",
"type" : "string"
},
"reference" : {
"description" : "Your reference for the split, which you can use to link the split to other operations such as captures and refunds.\n\nThis is required if `type` is **MarketPlace** or **BalanceAccount**. For the other types, we also recommend sending a reference so you can reconcile the split and the associated payment in the transaction overview and in the reports. If the reference is not provided, the split is reported as part of the aggregated [TransferBalance record type](https://docs.adyen.com/reporting/marketpay-payments-accounting-report) in Adyen for Platforms.",
"type" : "string"
},
"type" : {
"description" : "The type of split.\nPossible values: **Default**, **PaymentFee**, **VAT**, **Commission**, **MarketPlace**, **BalanceAccount**.",
"enum" : [
"BalanceAccount",
"Commission",
"Default",
"MarketPlace",
"PaymentFee",
"VAT",
"Verification"
],
"type" : "string"
}
},
"required" : [
"amount",
"type"
]
},
"SplitAmount" : {
"properties" : {
"currency" : {
"description" : "The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes).\n\nIf this value is not provided, the currency in which the payment is made will be used.",
"maxLength" : 3,
"minLength" : 3,
"type" : "string"
},
"value" : {
"description" : "The amount in [minor units](https://docs.adyen.com/development-resources/currency-codes).",
"format" : "int64",
"type" : "integer"
}
},
"required" : [
"value"
]
},
"StoreDetail" : {
"properties" : {
"address" : {
"description" : "The address of the physical store where the account holder will process payments from.",
"$ref" : "#/components/schemas/ViasAddress"
},
"fullPhoneNumber" : {
"description" : "The phone number of the store provided as a single string. It will be handled as a landline phone.\n\nExamples: \"0031 6 11 22 33 44\", \"+316/1122-3344\", \"(0031) 611223344\"",
"type" : "string"
},
"merchantAccount" : {
"description" : "The merchant account to which the store belongs.",
"type" : "string"
},
"merchantCategoryCode" : {
"description" : "The merchant category code (MCC) that classifies the business of the account holder.",
"type" : "string"
},
"phoneNumber" : {
"description" : "The phone number of the store.",
"readOnly" : true,
"$ref" : "#/components/schemas/ViasPhoneNumber"
},
"shopperInteraction" : {
"x-addedInVersion" : "5",
"description" : "The sales channel. Possible values: **Ecommerce**, **POS**.",
"enum" : [
"Ecommerce",
"POS"
],
"type" : "string"
},
"splitConfigurationUUID" : {
"x-addedInVersion" : "5",
"description" : "The unique reference for the split configuration, returned when you configure splits in your Customer Area. When this is provided, the `virtualAccount` is also required. Adyen uses the configuration and the `virtualAccount` to split funds between accounts in your platform.",
"type" : "string"
},
"status" : {
"description" : "The status of the store. Possible values: **Pending**, **Active**, **Inactive**, **InactiveWithModifications**, **Closed**.",
"enum" : [
"Active",
"Closed",
"Inactive",
"InactiveWithModifications",
"Pending"
],
"readOnly" : true,
"type" : "string"
},
"store" : {
"description" : "Adyen-generated unique alphanumeric identifier (UUID) for the store, returned in the response when you create a store. Required when updating an existing store in an `/updateAccountHolder` request.",
"type" : "string"
},
"storeName" : {
"description" : "The name of the account holder's store, between 3 to 22 characters in length.\nThis value will be shown in shopper statements.",
"type" : "string"
},
"storeReference" : {
"description" : "Your unique identifier for the store, between 3 to 128 characters in length.\nThis value will be shown as the store description in your Customer Area.",
"type" : "string"
},
"virtualAccount" : {
"x-addedInVersion" : "5",
"description" : "The account holder's `accountCode` where the split amount will be sent. Required when you provide the `splitConfigurationUUID`.",
"type" : "string"
},
"webAddress" : {
"x-addedInVersion" : "5",
"description" : "URL of the ecommerce store.",
"type" : "string"
}
},
"required" : [
"storeReference",
"merchantCategoryCode",
"address",
"merchantAccount"
]
},
"Transaction" : {
"properties" : {
"amount" : {
"description" : "The amount of the transaction.",
"$ref" : "#/components/schemas/Amount"
},
"bankAccountDetail" : {
"description" : "The details of the bank account to where a payout was made.",
"$ref" : "#/components/schemas/BankAccountDetail"
},
"captureMerchantReference" : {
"description" : "The merchant reference of a related capture.",
"type" : "string"
},
"capturePspReference" : {
"description" : "The psp reference of a related capture.",
"type" : "string"
},
"creationDate" : {
"description" : "The date on which the transaction was performed.",
"format" : "date-time",
"type" : "string"
},
"description" : {
"description" : "A description of the transaction.",
"type" : "string"
},
"destinationAccountCode" : {
"description" : "The code of the account to which funds were credited during an outgoing fund transfer.",
"type" : "string"
},
"disputePspReference" : {
"description" : "The psp reference of the related dispute.",
"type" : "string"
},
"disputeReasonCode" : {
"description" : "The reason code of a dispute.",
"type" : "string"
},
"merchantReference" : {
"description" : "The merchant reference of a transaction.",
"type" : "string"
},
"paymentPspReference" : {
"x-addedInVersion" : "3",
"description" : "The psp reference of the related authorisation or transfer.",
"type" : "string"
},
"payoutPspReference" : {
"x-addedInVersion" : "3",
"description" : "The psp reference of the related payout.",
"type" : "string"
},
"pspReference" : {
"description" : "The psp reference of a transaction.",
"type" : "string"
},
"sourceAccountCode" : {
"description" : "The code of the account from which funds were debited during an incoming fund transfer.",
"type" : "string"
},
"transactionStatus" : {
"description" : "The status of the transaction.\n>Permitted values: `PendingCredit`, `CreditFailed`, `CreditClosed`, `CreditSuspended`, `Credited`, `Converted`, `PendingDebit`, `DebitFailed`, `Debited`, `DebitReversedReceived`, `DebitedReversed`, `ChargebackReceived`, `Chargeback`, `ChargebackReversedReceived`, `ChargebackReversed`, `Payout`, `PayoutReversed`, `FundTransfer`, `PendingFundTransfer`, `ManualCorrected`.",
"enum" : [
"BalanceNotPaidOutTransfer",
"Chargeback",
"ChargebackCorrection",
"ChargebackCorrectionReceived",
"ChargebackReceived",
"ChargebackReversed",
"ChargebackReversedCorrection",
"ChargebackReversedCorrectionReceived",
"ChargebackReversedReceived",
"Converted",
"CreditClosed",
"CreditFailed",
"CreditReversed",
"CreditReversedReceived",
"CreditSuspended",
"Credited",
"DebitFailed",
"DebitReversedReceived",
"Debited",
"DebitedReversed",
"DepositCorrectionCredited",
"DepositCorrectionDebited",
"Fee",
"FundTransfer",
"FundTransferReversed",
"InvoiceDeductionCredited",
"InvoiceDeductionDebited",
"ManualCorrected",
"ManualCorrectionCredited",
"ManualCorrectionDebited",
"MerchantPayin",
"MerchantPayinReversed",
"Payout",
"PayoutReversed",
"PendingCredit",
"PendingDebit",
"PendingFundTransfer",
"SecondChargeback",
"SecondChargebackCorrection",
"SecondChargebackCorrectionReceived",
"SecondChargebackReceived"
],
"type" : "string"
},
"transferCode" : {
"description" : "The transfer code of the transaction.",
"type" : "string"
}
}
},
"TransferFundsNotification" : {
"properties" : {
"content" : {
"description" : "Details of the fund transfer.",
"$ref" : "#/components/schemas/TransferFundsNotificationContent"
},
"error" : {
"x-addedInVersion" : "5",
"description" : "Error information of failed request. No value provided here if no error occurred on processing.",
"$ref" : "#/components/schemas/NotificationErrorContainer"
},
"eventDate" : {
"x-addedInVersion" : "4",
"description" : "The date and time when an event has been completed.",
"format" : "date-time",
"type" : "string"
},
"eventType" : {
"description" : "The event type of the notification.",
"type" : "string"
},
"executingUserKey" : {
"description" : "The user or process that has triggered the notification.",
"type" : "string"
},
"live" : {
"description" : "Indicates whether the notification originated from the live environment or the test environment. If true, the notification originated from the live environment. If false, the notification originated from the test environment.",
"type" : "boolean"
},
"pspReference" : {
"description" : "The PSP reference of the request from which the notification originates.",
"type" : "string"
}
},
"required" : [
"executingUserKey",
"pspReference",
"eventType",
"live",
"eventDate",
"content"
]
},
"TransferFundsNotificationContent" : {
"properties" : {
"amount" : {
"description" : "The amount transferred.",
"$ref" : "#/components/schemas/Amount"
},
"destinationAccountCode" : {
"description" : "The code of the Account to which funds were credited.",
"type" : "string"
},
"invalidFields" : {
"x-addedInVersion" : "5",
"description" : "Invalid fields list.",
"items" : {
"$ref" : "#/components/schemas/ErrorFieldType"
},
"type" : "array"
},
"merchantReference" : {
"x-addedInVersion" : "2",
"description" : "The reference provided by the merchant.",
"type" : "string"
},
"sourceAccountCode" : {
"description" : "The code of the Account from which funds were debited.",
"type" : "string"
},
"status" : {
"description" : "The status of the fund transfer.",
"$ref" : "#/components/schemas/OperationStatus"
},
"transferCode" : {
"description" : "The transfer code.",
"type" : "string"
}
},
"required" : [
"sourceAccountCode",
"destinationAccountCode",
"amount",
"transferCode"
]
},
"UltimateParentCompany" : {
"properties" : {
"address" : {
"description" : "Address of the ultimate parent company.",
"$ref" : "#/components/schemas/ViasAddress"
},
"businessDetails" : {
"description" : "Details about the ultimate parent company's business.",
"$ref" : "#/components/schemas/UltimateParentCompanyBusinessDetails"
},
"ultimateParentCompanyCode" : {
"description" : "Adyen-generated unique alphanumeric identifier (UUID) for the entry, returned in the response when you create an ultimate parent company. Required when updating an existing entry in an `/updateAccountHolder` request.",
"type" : "string"
}
}
},
"UltimateParentCompanyBusinessDetails" : {
"properties" : {
"legalBusinessName" : {
"description" : "The legal name of the company.",
"type" : "string"
},
"registrationNumber" : {
"description" : "The registration number of the company.",
"type" : "string"
},
"stockExchange" : {
"description" : "Market Identifier Code (MIC).",
"type" : "string"
},
"stockNumber" : {
"description" : "International Securities Identification Number (ISIN).",
"type" : "string"
},
"stockTicker" : {
"description" : "Stock Ticker symbol.",
"type" : "string"
}
}
},
"UpdateAccountHolderResponse" : {
"properties" : {
"accountHolderCode" : {
"description" : "The code of the account holder.",
"type" : "string"
},
"accountHolderDetails" : {
"description" : "Details of the account holder.",
"$ref" : "#/components/schemas/AccountHolderDetails"
},
"accountHolderStatus" : {
"x-addedInVersion" : "2",
"description" : "The new status of the account holder.",
"$ref" : "#/components/schemas/AccountHolderStatus"
},
"description" : {
"x-addedInVersion" : "4",
"description" : "The description of the account holder.",
"type" : "string"
},
"invalidFields" : {
"x-addedInVersion" : "5",
"description" : "in case the account holder has not been updated, contains account holder fields, that did not pass the validation.",
"items" : {
"$ref" : "#/components/schemas/ErrorFieldType"
},
"type" : "array"
},
"legalEntity" : {
"x-addedInVersion" : "4",
"description" : "The legal entity of the account holder.",
"enum" : [
"Business",
"Individual",
"NonProfit",
"Partnership",
"PublicCompany"
],
"type" : "string"
},
"primaryCurrency" : {
"x-addedInVersion" : "5",
"description" : "The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes), with which the prospective account holder primarily deals.",
"type" : "string"
},
"pspReference" : {
"description" : "The reference of a request. Can be used to uniquely identify the request.",
"type" : "string"
},
"resultCode" : {
"description" : "The result code.",
"type" : "string"
},
"verification" : {
"x-addedInVersion" : "2",
"description" : "The details of KYC Verification of the account holder.",
"$ref" : "#/components/schemas/KYCVerificationResult2"
},
"verificationProfile" : {
"x-addedInVersion" : "6",
"description" : "The identifier of the profile that applies to this entity.",
"type" : "string"
}
},
"required" : [
"accountHolderStatus",
"verification",
"legalEntity"
]
},
"UpdateAccountResponse" : {
"properties" : {
"accountCode" : {
"description" : "The code of the account.",
"type" : "string"
},
"bankAccountUUID" : {
"x-addedInVersion" : "5",
"description" : "The bankAccountUUID of the bank account held by the account holder to couple the account with. Scheduled payouts in currencies matching the currency of this bank account will be sent to this bank account. Payouts in different currencies will be sent to a matching bank account of the account holder.",
"type" : "string"
},
"description" : {
"x-addedInVersion" : "4",
"description" : "The description of the account.",
"type" : "string"
},
"invalidFields" : {
"x-addedInVersion" : "5",
"description" : "A list of fields that caused the `/updateAccount` request to fail.",
"items" : {
"$ref" : "#/components/schemas/ErrorFieldType"
},
"type" : "array"
},
"metadata" : {
"x-addedInVersion" : "5",
"additionalProperties" : {
"type" : "string"
},
"description" : "A set of key and value pairs containing metadata.",
"type" : "object"
},
"payoutMethodCode" : {
"x-addedInVersion" : "5",
"description" : "The payout method code held by the account holder to couple the account with. Scheduled card payouts will be sent using this payout method code.",
"type" : "string"
},
"payoutSchedule" : {
"description" : "The payout schedule of the account.",
"$ref" : "#/components/schemas/PayoutScheduleResponse"
},
"payoutSpeed" : {
"x-addedInVersion" : "5",
"description" : "Speed with which payouts for this account are processed. Permitted values: `STANDARD`, `SAME_DAY`.",
"enum" : [
"INSTANT",
"SAME_DAY",
"STANDARD"
],
"type" : "string"
},
"pspReference" : {
"description" : "The reference of a request. Can be used to uniquely identify the request.",
"type" : "string"
},
"resultCode" : {
"description" : "The result code.",
"type" : "string"
}
},
"required" : [
"accountCode"
]
},
"ViasAddress" : {
"properties" : {
"city" : {
"description" : "The name of the city.\n>Required if either `houseNumberOrName`, `street`, `postalCode`, or `stateOrProvince` are provided.",
"type" : "string"
},
"country" : {
"description" : "The two-character country code of the address. The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL').\n> If you don't know the country or are not collecting the country from the shopper, provide `country` as `ZZ`.",
"type" : "string"
},
"houseNumberOrName" : {
"description" : "The number or name of the house.",
"type" : "string"
},
"postalCode" : {
"description" : "The postal code.\n>A maximum of five (5) digits for an address in the USA, or a maximum of ten (10) characters for an address in all other countries.\n>Required if either `houseNumberOrName`, `street`, `city`, or `stateOrProvince` are provided.",
"type" : "string"
},
"stateOrProvince" : {
"description" : "The abbreviation of the state or province.\n>Two (2) characters for an address in the USA or Canada, or a maximum of three (3) characters for an address in all other countries.\n>Required for an address in the USA or Canada if either `houseNumberOrName`, `street`, `city`, or `postalCode` are provided.",
"type" : "string"
},
"street" : {
"description" : "The name of the street.\n>The house number should not be included in this field; it should be separately provided via `houseNumberOrName`.\n>Required if either `houseNumberOrName`, `city`, `postalCode`, or `stateOrProvince` are provided.",
"type" : "string"
}
},
"required" : [
"country"
]
},
"ViasName" : {
"properties" : {
"firstName" : {
"description" : "The first name.",
"type" : "string"
},
"gender" : {
"description" : "The gender.\n>The following values are permitted: `MALE`, `FEMALE`, `UNKNOWN`.",
"enum" : [
"MALE",
"FEMALE",
"UNKNOWN"
],
"maxLength" : 1,
"type" : "string"
},
"infix" : {
"description" : "The name's infix, if applicable.\n>A maximum length of twenty (20) characters is imposed.",
"type" : "string"
},
"lastName" : {
"description" : "The last name.",
"type" : "string"
}
},
"required" : [
"firstName",
"lastName"
]
},
"ViasPersonalData" : {
"properties" : {
"dateOfBirth" : {
"description" : "The person's date of birth, in ISO-8601 YYYY-MM-DD format. For example, **2000-01-31**.",
"type" : "string"
},
"documentData" : {
"x-addedInVersion" : "3",
"description" : "Array that contains information about the person's identification document. You can submit only one entry per document type.",
"items" : {
"$ref" : "#/components/schemas/PersonalDocumentData"
},
"type" : "array"
},
"nationality" : {
"description" : "The nationality of the person represented by a two-character country code, in [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. For example, **NL**.\n",
"maxLength" : 2,
"minLength" : 2,
"type" : "string"
}
}
},
"ViasPhoneNumber" : {
"properties" : {
"phoneCountryCode" : {
"description" : "The two-character country code of the phone number.\n>The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL').",
"type" : "string"
},
"phoneNumber" : {
"description" : "The phone number.\n>The inclusion of the phone number country code is not necessary.",
"type" : "string"
},
"phoneType" : {
"description" : "The type of the phone number.\n>The following values are permitted: `Landline`, `Mobile`, `SIP`, `Fax`.",
"enum" : [
"Fax",
"Landline",
"Mobile",
"SIP"
],
"type" : "string"
}
},
"required" : [
"phoneCountryCode",
"phoneNumber"
]
}
},
"securitySchemes" : {
"ApiKeyAuth" : {
"in" : "header",
"name" : "X-API-Key",
"type" : "apiKey"
},
"BasicAuth" : {
"scheme" : "basic",
"type" : "http"
}
},
"examples" : {
"WebhookAck" : {
"summary" : "Acknowledge Webhook",
"value" : {
"notificationResponse" : "[accepted]"
}
},
"post-ACCOUNT_CLOSED-accountClosed" : {
"summary" : "ACCOUNT CLOSED example",
"value" : {
"error" : {
"errorCode" : "000",
"message" : "test error message"
},
"eventDate" : "2019-01-01T01:00:00+01:00",
"eventType" : "ACCOUNT_CLOSED",
"executingUserKey" : "executing-user-key",
"live" : false,
"pspReference" : "TSTPSPR0001",
"content" : {
"invalidFields" : [
{
"errorCode" : 1,
"errorDescription" : "Field is missing",
"fieldType" : {
"field" : "AccountHolderDetails.BusinessDetails.Shareholders.unknown",
"fieldName" : "unknown",
"shareholderCode" : "SH00001"
}
}
],
"pspReference" : "TSTPSPR0001",
"resultCode" : "Success",
"status" : "Closed"
}
}
}
}
}
}
Reference in New Issue View Git Blame Copy Permalink