openapi-directory/api/adyen.com/AccountService.json

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

{"openapi":"3.0.0","servers":[{"url":"https://cal-test.adyen.com/cal/services/Account/v4"}],"info":{"contact":{"email":"support@adyen.com","name":"Adyen Support","url":"https://support.adyen.com/","x-twitter":"Adyen"},"description":"The MarketPay Account API provides endpoints for managing MarketPay account-related entities. These related entities include account holders, accounts, bank accounts, shareholders, and KYC-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them.\n\nFor further information on MarketPay API, visit the [MarketPay documentation](https://docs.adyen.com/developers/marketpay/marketpay-overview).\n## Authentication\nTo connect to the MarketPay API, you must use basic authentication credentials of your web service user. If you don't have one, please contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). Then use its credentials to authenticate your request, for example:\n\n```\ncurl\n-U \"ws@Company.YourCompany\":\"YourWsPassword\" \\\n-H \"Content-Type: application/json\" \\\n...\n```\nNote that when going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/developers/api-reference/live-endpoints).\n\n## Versioning\nMarketPay API supports versioning of its endpoints through a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number.\n\nFor example:\n```\nhttps://cal-test.adyen.com/cal/services/Account/v4/createAccountHolder\n```","termsOfService":"https://docs.adyen.com/legal/terms-conditions","title":"Adyen MarketPay Account Service","version":"4","x-apisguru-categories":["payment"],"x-logo":{"url":"https://twitter.com/Adyen/profile_image?size=original"},"x-origin":[{"converter":{"url":"https://github.com/lucybot/api-spec-converter","version":"2.7.11"},"format":"openapi","url":"https://raw.githubusercontent.com/adyen/adyen-openapi/master/specs/3.0/AccountService-v4.json","version":"3.0"}],"x-preferred":true,"x-providerName":"adyen.com","x-serviceName":"AccountService"},"paths":{"/closeAccount":{"post":{"description":"This endpoint is used to close an existing account under an account holder. If an account is closed, it may not process transactions or have its funds paid out,and it may not be reopened. Any payments made to a closed account will be directed to the merchant's liable account.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CloseAccountRequest"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CloseAccountResponse"}}},"description":"OK - the request has succeeded."},"400":{"description":"Bad Request - a problem reading or understanding the request."},"401":{"description":"Unauthorized - authentication required."},"403":{"description":"Forbidden - insufficient permissions to process the request."},"422":{"description":"Unprocessable Entity - a request validation error."},"500":{"description":"Internal Server Error - the server could not process the request."}},"summary":"Close an existing account under an account holder.","x-groupName":"Accounts","x-sortIndex":3}},"/closeAccountHolder":{"post":{"description":"This endpoint is used to close an existing account holder and its accounts. If an account holder is closed, it may not process transactions or pay out funds, and it may not be reopened. Any payments made to a closed account will be directed to the merchant's liable account.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CloseAccountHolderRequest"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CloseAccountHolderResponse"}}},"description":"OK - the request has succeeded."},"400":{"description":"Bad Request - a problem reading or understanding the request."},"401":{"description":"Unauthorized - authentication required."},"403":{"description":"Forbidden - insufficient permissions to process the request."},"422":{"description":"Unprocessable Entity - a request validation error."},"500":{"description":"Internal Server Error - the server could not process the request."}},"summary":"Close an existing account holder.","x-groupName":"Account holders","x-sortIndex":7}},"/createAccount":{"post":{"callbacks":{"accountCreated":{"notificationURL":{"post":{"description":"This notification is sent when an Account has been created.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountCreateNotification"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"string"}}},"description":"[accepted]"}},"summary":"Triggered upon the creation of an Account.","x-sortIndex":0}}}},"description":"This endpoint is used to create an account under an existing account holder. An account holder may have multiple accounts.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAccountRequest"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAccountResponse"}}},"description":"OK - the request has succeeded."},"400":{"description":"Bad Request - a problem reading or understanding the request."},"401":{"description":"Unauthorized - authentication required."},"403":{"description":"Forbidden - insufficient permissions to process the request."},"422":{"description":"Unprocessable Entity - a request validation error."},"500":{"description":"Internal Server Error - the server could not process the request."}},"summary":"Create a new account under an existing account holder.","x-groupName":"Accounts","x-sortIndex":1}},"/createAccountHolder":{"post":{"callbacks":{"accountCreated":{"notificationURL":{"post":{"description":"This notification is sent when an Account has been created.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountCreateNotification"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"string"}}},"description":"[accepted]"}},"summary":"Triggered upon the creation of an Account.","x-sortIndex":0}}},"accountHolderCreated":{"notificationURL":{"post":{"description":"This notification is sent when an Account Holder has been created.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountHolderCreateNotification"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"string"}}},"description":"[accepted]"}},"summary":"Triggered upon the creation of an Account Holder.","x-sortIndex":0}}},"accountHolderVerification":{"notificationURL":{"post":{"description":"This notification is sent when KYC Verification results are made available.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountHolderVerificationNotification"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"string"}}},"description":"[accepted]"}},"summary":"Triggered upon the receipt of KYC Verification results.","x-sortIndex":0}}}},"description":"This endpoint is used to create an account holder. Each account holder represents a single sub-merchant, and each sub-merchant must be represented by an account holder. Depending on the legal entity type, different details are required to be provided in the call to this endpoint.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAccountHolderRequest"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAccountHolderResponse"}}},"description":"OK - the request has succeeded."},"400":{"description":"Bad Request - a problem reading or understanding the request."},"401":{"description":"Unauthorized - authentication required."},"403":{"description":"Forbidden - insufficient permissions to process the request."},"422":{"description":"Unprocessable Entity - a request validation error."},"500":{"description":"Internal Server Error - the server could not process the request."}},"summary":"Create a new account holder.","x-groupName":"Account holders","x-sortIndex":1}},"/deleteBankAccounts":{"post":{"description":"This endpoint is used to delete existing bank accounts from an account holder. For this, pass the `accountHolderCode` you got on the account holder creation, and one or more `bankAccountUUIDs` specifying bank accounts to delete.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteBankAccountRequest"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericResponse"}}},"description":"OK - the request has succeeded."},"400":{"description":"Bad Request - a problem reading or understanding the request."},"401":{"description":"Unauthorized - authentication required."},"403":{"description":"Forbidden - insufficient permissions to process the request."},"422":{"description":"Unprocessable Entity - a request validation error."},"500":{"description":"Internal Server Error - the server could not process the request."}},"summary":"Delete bank accounts of an existing account holder.","x-groupName":"Verification","x-sortIndex":3}},"/deleteShareholders":{"post":{"description":"This endpoint is used to delete existing shareholders from an account holder.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteShareholderRequest"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericResponse"}}},"description":"OK - the request has succeeded."},"400":{"description":"Bad Request - a problem reading or understanding the request."},"401":{"description":"Unauthorized - authentication required."},"403":{"description":"Forbidden - insufficient permissions to process the request."},"422":{"description":"Unprocessable Entity - a request validation error."},"500":{"description":"Internal Server Error - the server could not process the request."}},"summary":"Delete shareholders of an existing account holder.","x-groupName":"Verification","x-sortIndex":4}},"/getAccountHolder":{"post":{"description":"This endpoint is used to retrieve the details of an account holder.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetAccountHolderRequest"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetAccountHolderResponse"}}},"description":"OK - the request has succeeded."},"400":{"description":"Bad Request - a problem reading or understanding the request."},"401":{"description":"Unauthorized - authentication required."},"403":{"description":"Forbidden - insufficient permissions to process the request."},"422":{"description":"Unprocessable Entity - a request validation error."},"500":{"description":"Internal Server Error - the server could not process the request."}},"summary":"Retrieve the details of an account holder.","x-groupName":"Account holders","x-sortIndex":2}},"/getUploadedDocuments":{"post":{"description":"This endpoint is used to retrieve documents previously uploaded for use in the KYC Verification of an account holder.\n\nFor further information regarding KYC Verification, please refer to [Verification checks](https://docs.adyen.com/developers/marketpay/onboarding-and-verification/verification-checks).","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetUploadedDocumentsRequest"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetUploadedDocumentsResponse"}}},"description":"OK - the request has succeeded."},"400":{"description":"Bad Request - a problem reading or understanding the request."},"401":{"description":"Unauthorized - authentication required."},"403":{"description":"Forbidden - insufficient permissions to process the request."},"422":{"description":"Unprocessable Entity - a request validation error."},"500":{"description":"Internal Server Error - the server could not process the request."}},"summary":"Retrieve the uploaded documents of an existing account holder.","x-groupName":"Verification","x-sortIndex":2}},"/suspendAccountHolder":{"post":{"description":"This endpoint is used to suspend an existing account holder. If an account holder is suspended, it may not process transactions or pay out funds. Any payments made to a suspended account holder will be directed to the merchant's liable account.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuspendAccountHolderRequest"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuspendAccountHolderResponse"}}},"description":"OK - the request has succeeded."},"400":{"description":"Bad Request - a problem reading or understanding the request."},"401":{"description":"Unauthorized - authentication required."},"403":{"description":"Forbidden - insufficient permissions to process the request."},"422":{"description":"Unprocessable Entity - a request validation error."},"500":{"description":"Internal Server Error - the server could not process the request."}},"summary":"Suspend an existing account holder.","x-groupName":"Account holders","x-sortIndex":5}},"/unSuspendAccountHolder":{"post":{"description":"This endpoint is used to reinstate an existing account holder, which has been suspended through the `/suspendAccountHolder` endpoint. An account holder which has been suspended due to KYC verification issues cannot be reinstated through this endpoint.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnSuspendAccountHolderRequest"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnSuspendAccountHolderResponse"}}},"description":"OK - the request has succeeded."},"400":{"description":"Bad Request - a problem reading or understanding the request."},"401":{"description":"Unauthorized - authentication required."},"403":{"description":"Forbidden - insufficient permissions to process the request."},"422":{"description":"Unprocessable Entity - a request validation error."},"500":{"description":"Internal Server Error - the server could not process the request."}},"summary":"Reinstate a disabled account holder.","x-groupName":"Account holders","x-sortIndex":6}},"/updateAccount":{"post":{"description":"This endpoint is used to update the description or payout schedule of an existing account.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateAccountRequest"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateAccountResponse"}}},"description":"OK - the request has succeeded."},"400":{"description":"Bad Request - a problem reading or understanding the request."},"401":{"description":"Unauthorized - authentication required."},"403":{"description":"Forbidden - insufficient permissions to process the request."},"422":{"description":"Unprocessable Entity - a request validation error."},"500":{"description":"Internal Server Error - the server could not process the request."}},"summary":"Update an existing account under an account holder.","x-groupName":"Accounts","x-sortIndex":2}},"/updateAccountHolder":{"post":{"callbacks":{"accountHolderUpdated":{"notificationURL":{"post":{"description":"This notification is sent when an Account Holder has been updated.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountHolderUpdateNotification"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"string"}}},"description":"[accepted]"}},"summary":"Triggered upon the update of an Account Holder.","x-sortIndex":0}}}},"description":"This endpoint is used to update the `accountHolderDetails` or `processingTier` of an account holder.\n\nIf updating the `accountHolderDetails`, only the details which have been provided will be updated. Other details will be left as-is with the exception of the following fields:\n* `accountHolderDetails.address`\n* `accountHolderDetails.phoneNumber`\n* `accountHolderDetails.bankAccountDetails.BankAccountDetail`\n* `accountHolderDetails.businessDetails.shareholders.ShareholderContact`, which requires all fields necessary for validation (i.e. in order to update only the `accountHolderDetails.address.postalCode`, the fields `accountHolderDetails.address.country`, `.city`, `.street`, `.postalCode`, and possibly `.stateOrProvince` must be provided as well, so that the address can be properly validated).\n\nNote that this endpoint can also be used to create new bank accounts. For this, provide details of a bank account without providing a `bankAccountUUID`.\n\nSimilarly, it can also be used to create new shareholders by providing details of a shareholder without providing a `shareholderCode`.\n> The updating of the `metadata` field will overwite all of the existing account holder metadata. In order to update an existing metadata key-value pair, all otherkey-value pairs should be provided in order to not delete them.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateAccountHolderRequest"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateAccountHolderResponse"}}},"description":"OK - the request has succeeded."},"400":{"description":"Bad Request - a problem reading or understanding the request."},"401":{"description":"Unauthorized - authentication required."},"403":{"description":"Forbidden - insufficient permissions to process the request."},"422":{"description":"Unprocessable Entity - a request validation error."},"500":{"description":"Internal Server Error - the server could not process the request."}},"summary":"Update an existing account holder.","x-groupName":"Account holders","x-sortIndex":3}},"/updateAccountHolderState":{"post":{"callbacks":{"accountHolderStatusChange":{"notificationURL":{"post":{"description":"This notification is sent when the status of an Account Holder has been changed.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountHolderStatusChangeNotification"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"string"}}},"description":"[accepted]"}},"summary":"Triggered upon the status change of an Account Holder.","x-sortIndex":0}}}},"description":"This endpoint is used to disable or enable the processing or payout state of an account holder. It cannot be used to enable an account holder whose processing or payout state has not been disabled through this endpoint.\n\nFor further information regarding processing and payout states of an account holder, please refer to the [MarketPay documentation](https://docs.adyen.com/developers/marketpay/marketpay-overview).","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateAccountHolderStateRequest"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetAccountHolderStatusResponse"}}},"description":"OK - the request has succeeded."},"400":{"description":"Bad Request - a problem reading or understanding the request."},"401":{"description":"Unauthorized - authentication required."},"403":{"description":"Forbidden - insufficient permissions to process the request."},"422":{"description":"Unprocessable Entity - a request validation error."},"500":{"description":"Internal Server Error - the server could not process the request."}},"summary":"Update the state of an existing account holder.","x-groupName":"Account holders","x-sortIndex":4}},"/uploadDocument":{"post":{"description":"This endpoint is used to upload a document for use in the KYC verification of an account holder.\n\nFor further information regarding KYC Verification, please refer to [Verification checks](https://docs.adyen.com/developers/marketpay/onboarding-and-verification/verification-checks).","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UploadDocumentRequest"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateAccountHolderResponse"}}},"description":"OK - the request has succeeded."},"400":{"description":"Bad Request - a problem reading or understanding the request."},"401":{"description":"Unauthorized - authentication required."},"403":{"description":"Forbidden - insufficient permissions to process the request."},"422":{"description":"Unprocessable Entity - a request validation error."},"500":{"description":"Internal Server Error - the server could not process the request."}},"summary":"Upload a document for an existing account holder.","x-groupName":"Verification","x-sortIndex":1}}},"components":{"schemas":{"Account":{"properties":{"accountCode":{"description":"The code of the account.","type":"string"},"beneficiaryAccount":{"description":"The beneficiary of the account.","type":"string"},"beneficiaryMerchantReference":{"description":"The reason that a beneficiary has been set up for this account. This may have been supplied during the setup of a beneficiary at the discretion of the executing user.","type":"string"},"description":{"description":"A description of the account.","type":"string"},"payoutSchedule":{"$ref":"#/components/schemas/PayoutScheduleResponse","description":"The account's payout schedule."},"status":{"description":"The status of the account. Possible values: `Active`, `Inactive`, `Suspended`, `Closed`.","type":"string"}}},"AccountCreateNotification":{"properties":{"content":{"$ref":"#/components/schemas/CreateAccountResponse","description":"The details of the account creation."},"eventDate":{"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/developers/marketpay/onboarding-and-verification/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"]},"AccountHolderCreateNotification":{"properties":{"content":{"$ref":"#/components/schemas/CreateAccountHolderResponse","description":"The details of the account holder creation."},"eventDate":{"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":{"$ref":"#/components/schemas/Address","description":"The address of the account holder."},"bankAccountDetails":{"description":"Each of the the bank accounts associated with the account holder.\n> Each array entry should represent one bank account.\n> For comprehensive detail regarding the required `BankAccountDetail` fields, please refer to the [KYC Verification documentation](https://docs.adyen.com/developers/marketpay/onboarding-and-verification/verification-checks).","items":{"$ref":"#/components/schemas/BankAccountDetail"},"type":"array"},"businessDetails":{"$ref":"#/components/schemas/BusinessDetails","description":"Details applicable to `Business` legal entities.\nPopulated only if the account holder's legal entity is of type `Business`.\n> Required when being used in a `/createAccountHolder` request in which the legal entity is `Business`."},"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":{"$ref":"#/components/schemas/IndividualDetails","description":"Details applicable to `Individual` legal entities.\nPopulated only if the account holder's legal entity is of type `Individual`.\n> Required when being used in a `/createAccountHolder` request in which the legal entity is `Individual`."},"merchantCategoryCode":{"description":"The Merchant Category Code of the account holder.\n> If not specified in the request, this will be derived from the marketplace 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"},"webAddress":{"description":"The URL of the website of the account holder.","type":"string"}},"required":["fullPhoneNumber","email"]},"AccountHolderStatus":{"properties":{"events":{"description":"A list of events scheduled for the account holder.","items":{"$ref":"#/components/schemas/AccountEvent"},"type":"array"},"payoutState":{"$ref":"#/components/schemas/AccountPayoutState","description":"The payout state of the account holder."},"processingState":{"$ref":"#/components/schemas/AccountProcessingState","description":"The processing state of the account holder."},"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","statusReason","processingState","payoutState","events"]},"AccountHolderStatusChangeNotification":{"properties":{"content":{"$ref":"#/components/schemas/AccountHolderStatusChangeNotificationContent","description":"The details of the Account Holder status change."},"eventDate":{"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"},"newStatus":{"$ref":"#/components/schemas/AccountHolderStatus","description":"The new status of the account holder."},"oldStatus":{"$ref":"#/components/schemas/AccountHolderStatus","description":"The former status of the account holder."},"reason":{"description":"The reason for the status change.","type":"string"}},"required":["accountHolderCode","oldStatus","newStatus","reason"]},"AccountHolderUpdateNotification":{"properties":{"content":{"$ref":"#/components/schemas/UpdateAccountHolderResponse","description":"The details of the Account Holder update."},"eventDate":{"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":{"$ref":"#/components/schemas/AccountHolderVerificationNotificationContent","description":"The details of the Account Holder verification."},"eventDate":{"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"},"bankAccountUUID":{"description":"The unique ID of the bank account that has been verified.","type":"string"},"shareholderCode":{"description":"The code of the shareholder that has been verified.","type":"string"},"statusSummary":{"$ref":"#/components/schemas/KYCCheckSummary","description":"A summary of the verification status."},"verificationStatus":{"description":"The status of verification.","enum":["AWAITING_DATA","DATA_PROVIDED","FAILED","INVALID_DATA","PASSED","PENDING","PENDING_REVIEW","RETRY_LIMIT_REACHED","UNCHECKED"],"type":"string"},"verificationType":{"description":"The type of validation performed.","enum":["BANK_ACCOUNT_VERIFICATION","COMPANY_VERIFICATION","IDENTITY_VERIFICATION","NONPROFIT_VERIFICATION","PASSPORT_VERIFICATION"],"type":"string"}},"required":["accountHolderCode"]},"AccountPayoutState":{"properties":{"allowPayout":{"description":"Indicates whether payouts are allowed.","type":"boolean"},"disableReason":{"description":"The reason why payouts have been disabled (by the marketplace).","type":"string"},"disabled":{"description":"Indicates whether payouts have been disabled (by the marketplace) for all of the account holder's accounts.","type":"boolean"},"payoutLimit":{"$ref":"#/components/schemas/Amount","description":"The maximum amount that payouts are limited to. Only applies if payouts are allowed but limited."},"tierNumber":{"description":"The payout tier that the account holder occupies.","format":"int32","type":"integer"}},"required":["allowPayout","disabled","tierNumber","disableReason","payoutLimit"]},"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":{"$ref":"#/components/schemas/Amount","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)."},"processedTo":{"$ref":"#/components/schemas/Amount","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)."},"tierNumber":{"description":"The processing tier that the account holder occupies.","format":"int32","type":"integer"}},"required":["disabled","disableReason","processedFrom","processedTo","tierNumber"]},"Address":{"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\n>The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL').","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"]},"Amount":{"properties":{"currency":{"description":"The three-character [ISO currency code](https://docs.adyen.com/developers/currency-codes).","maxLength":3,"minLength":3,"type":"string"},"value":{"description":"The payable amount that can be charged for the transaction.\n\nThe transaction amount needs to be represented in minor units according to the [following table](https://docs.adyen.com/developers/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/developers/marketpay/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/developers/marketpay/onboarding-and-verification) section for details on field requirements.","type":"string"},"bankAccountName":{"description":"The name of 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/developers/marketpay/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/developers/marketpay/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/developers/marketpay/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/developers/marketpay/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/developers/marketpay/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/developers/marketpay/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/developers/marketpay/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/developers/marketpay/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/developers/marketpay/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/developers/marketpay/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/developers/marketpay/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/developers/marketpay/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/developers/marketpay/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/developers/marketpay/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/developers/marketpay/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/developers/marketpay/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/developers/marketpay/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/developers/marketpay/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/developers/marketpay/onboarding-and-verification) section for details on field requirements.","type":"string"}}},"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"},"registrationNumber":{"description":"The registration number of the company.","type":"string"},"shareholders":{"description":"Each of the shareholders associated with the company.\nEach array entry should represent one shareholder.","items":{"$ref":"#/components/schemas/ShareholderContact"},"type":"array"},"taxId":{"description":"The tax ID of the company.","type":"string"}}},"CloseAccountHolderRequest":{"properties":{"accountHolderCode":{"description":"The code of the Account Holder to be closed.","type":"string"}},"required":["accountHolderCode"]},"CloseAccountHolderResponse":{"properties":{"accountHolderStatus":{"$ref":"#/components/schemas/AccountHolderStatus","description":"The new status of the Account Holder."},"pspReference":{"description":"The reference of a request.  Can be used to uniquely identify the request.","type":"string"},"submittedAsync":{"description":"Indicates whether the request is processed synchronously or asynchronously.  Depending on the request's marketplace settings, the following scenarios may be applied:\n* **sync:** The processing of the request is immediately attempted; it may result in an error if the providing service is unavailable.\n* **async:** The request is queued and will be executed when the providing service is available in the order in which the requests are received.\n* **asyncOnError:** The processing of the request is immediately attempted, but if the providing service is unavailable, the request is scheduled in a queue.","type":"boolean"}},"required":["pspReference","submittedAsync","accountHolderStatus"]},"CloseAccountRequest":{"properties":{"accountCode":{"description":"The code of account to be closed.","type":"string"}},"required":["accountCode"]},"CloseAccountResponse":{"properties":{"pspReference":{"description":"The reference of a request.  Can be used to uniquely identify the request.","type":"string"},"status":{"description":"The new status of the account.\n>Permitted values: `Active`, `Inactive`, `Suspended`, `Closed`.","enum":["Active","Closed","Inactive","Suspended"],"type":"string"},"submittedAsync":{"description":"Indicates whether the request is processed synchronously or asynchronously.  Depending on the request's marketplace settings, the following scenarios may be applied:\n* **sync:** The processing of the request is immediately attempted; it may result in an error if the providing service is unavailable.\n* **async:** The request is queued and will be executed when the providing service is available in the order in which the requests are received.\n* **asyncOnError:** The processing of the request is immediately attempted, but if the providing service is unavailable, the request is scheduled in a queue.","type":"boolean"}},"required":["pspReference","submittedAsync","status"]},"CreateAccountHolderRequest":{"properties":{"accountHolderCode":{"description":"The desired code of the prospective account holder.\n> Must be between three (3) and fifty (50) characters long. Only letters, digits, and hyphens (-) are permitted.","type":"string"},"accountHolderDetails":{"$ref":"#/components/schemas/AccountHolderDetails","description":"The details of the prospective account holder."},"createDefaultAccount":{"description":"If set to true, an account with the default options is created for this account holder.\n**Default Value:** true","type":"boolean"},"description":{"description":"A description of the prospective account holder.","type":"string"},"legalEntity":{"description":"The entity type.\nPermitted values: `Business`, `Individual`\n\nIf an account holder is 'Business', then `accountHolderDetails.businessDetails` must be provided, as well as at least one entry in the `accountHolderDetails.businessDetails.shareholders` list.\n\nIf an account holder is 'Individual', then `accountHolderDetails.individualDetails` must be provided.","enum":["Business","Individual","NonProfit"],"type":"string"},"primaryCurrency":{"description":"The currency with which the prospective account holder primarily deals.","type":"string"},"processingTier":{"description":"The starting [processing tier](https://docs.adyen.com/developers/marketpay/onboarding-and-verification/verification-checks#tiers) for the prospective account holder.","format":"int32","type":"integer"}},"required":["accountHolderCode","legalEntity","accountHolderDetails","description"]},"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":{"$ref":"#/components/schemas/AccountHolderDetails","description":"Details of the new account holder."},"accountHolderStatus":{"$ref":"#/components/schemas/AccountHolderStatus","description":"The status of the new account holder."},"description":{"description":"The description of the new account holder.","type":"string"},"invalidFields":{"description":"A list of fields that caused the `/createAccountHolder` request to fail.","items":{"$ref":"#/components/schemas/ErrorFieldType"},"type":"array"},"legalEntity":{"description":"The type of legal entity of the new account holder.","enum":["Business","Individual","NonProfit"],"type":"string"},"pspReference":{"description":"The reference of a request.  Can be used to uniquely identify the request.","type":"string"},"submittedAsync":{"description":"Indicates whether the request is processed synchronously or asynchronously.  Depending on the request's marketplace settings, the following scenarios may be applied:\n* **sync:** The processing of the request is immediately attempted; it may result in an error if the providing service is unavailable.\n* **async:** The request is queued and will be executed when the providing service is available in the order in which the requests are received.\n* **asyncOnError:** The processing of the request is immediately attempted, but if the providing service is unavailable, the request is scheduled in a queue.","type":"boolean"},"verification":{"$ref":"#/components/schemas/KYCVerificationResult","description":"The details of KYC Verification of the account holder."}},"required":["pspReference","submittedAsync","accountHolderCode","accountHolderStatus","accountHolderDetails","verification","legalEntity"]},"CreateAccountRequest":{"properties":{"accountHolderCode":{"description":"The code of Account Holder under which to create the account.","type":"string"},"description":{"description":"A description of the account.","type":"string"},"payoutSchedule":{"description":"The payout schedule of the prospective account.\n>Permitted values: `DEFAULT`, `HOLD`, `DAILY`, `WEEKLY`, `MONTHLY`.","enum":["DAILY","DEFAULT","HOLD","MONTHLY","WEEKLY"],"type":"string"},"payoutScheduleReason":{"description":"The reason for the payout schedule choice.\n>Required if the payoutSchedule is `HOLD`.","type":"string"}},"required":["accountHolderCode","payoutSchedule","payoutScheduleReason","description"]},"CreateAccountResponse":{"properties":{"accountCode":{"description":"The code of