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

Update MarketPay specs

Browse Source
This commit is contained in:
Aleksei Akimov
2018-06-01 14:07:07 +02:00
committed by GitHub
parent 289fdc011d
commit f048fda89b
1 changed files with 86 additions and 86 deletions
Download Patch File Download Diff File Expand all files Collapse all files

172
specs/3.0/AccountService-v3.json
View File

@@ -8,7 +8,7 @@
"info" : {
"version" : "3",
"title" : "Adyen MarketPay Account Service",
"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/v3/createAccountHolder\n```",
"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",
"contact" : {
"name" : "Adyen Support",
@@ -325,7 +325,7 @@
"/deleteBankAccounts" : {
"post" : {
"summary" : "Delete bank accounts of an existing account holder.",
"description" : "This endpoint is used to delete existing bank accounts from an account holder.",
"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.",
"x-groupName" : "Verification",
"x-sortIndex" : 3,
"requestBody" : {
@@ -457,7 +457,7 @@
"/getUploadedDocuments" : {
"post" : {
"summary" : "Retrieve the uploaded documents of an existing account holder.",
"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 the [KYC Documentation](https://docs.adyen.com/developers/marketpay/kyc-verification).",
"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).",
"x-groupName" : "Verification",
"x-sortIndex" : 2,
"requestBody" : {
@@ -785,7 +785,7 @@
"/uploadDocument" : {
"post" : {
"summary" : "Upload a document for an existing account holder.",
"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 the [KYC Documentation](https://docs.adyen.com/developers/marketpay/kyc-verification).",
"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).",
"x-groupName" : "Verification",
"x-sortIndex" : 1,
"requestBody" : {
@@ -883,7 +883,7 @@
"AccountEvent" : {
"properties" : {
"event" : {
"description" : "The event.\n>Permitted values: `InactivateAccount`, `RefundNotPaidOutTransfers`.\nPlease refer to the KYC documentation for further information.",
"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"
@@ -944,7 +944,7 @@
"$ref" : "#/components/schemas/Address"
},
"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/kyc-verification).",
"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"
},
@@ -989,7 +989,7 @@
},
"AccountHolderStatus" : {
"properties" : {
"accountEvents" : {
"events" : {
"description" : "A list of events scheduled for the account holder.",
"items" : {
"$ref" : "#/components/schemas/AccountEvent"
@@ -1024,7 +1024,7 @@
"statusReason",
"processingState",
"payoutState",
"accountEvents"
"events"
]
},
"AccountHolderStatusChangeNotification" : {
@@ -1063,11 +1063,11 @@
"description" : "The code of the account holder.",
"type" : "string"
},
"newAccountHolderStatus" : {
"newStatus" : {
"description" : "The new status of the account holder.",
"$ref" : "#/components/schemas/AccountHolderStatus"
},
"oldAccountHolderStatus" : {
"oldStatus" : {
"description" : "The former status of the account holder.",
"$ref" : "#/components/schemas/AccountHolderStatus"
},
@@ -1078,8 +1078,8 @@
},
"required" : [
"accountHolderCode",
"oldAccountHolderStatus",
"newAccountHolderStatus",
"oldStatus",
"newStatus",
"reason"
]
},
@@ -1148,7 +1148,7 @@
"AccountHolderVerificationNotificationContent" : {
"properties" : {
"accountHolderCode" : {
"description" : "The code of the Account Holder.",
"description" : "The code of the account holder.",
"type" : "string"
},
"bankAccountUUID" : {
@@ -1201,15 +1201,15 @@
"type" : "string"
},
"disabled" : {
"description" : "Indicates whether payouts have been disabled (by the marketplace) for all of the Account Holder's accounts.",
"description" : "Indicates whether payouts have been disabled (by the marketplace) for all of the account holder's accounts.",
"type" : "boolean"
},
"payoutLimit" : {
"description" : "The maximum amount that payouts are limited to. Only applies if payouts are allowed but limited.",
"description" : "The maximum amount that payouts are limited to. Only applies if payouts are allowed but limited.",
"$ref" : "#/components/schemas/Amount"
},
"tierNumber" : {
"description" : "The payout tier that the Account Holder occupies.\n>Please refer to the KYC Verification documentation for further detail on payout tiers.",
"description" : "The payout tier that the account holder occupies.",
"format" : "int32",
"type" : "integer"
}
@@ -1233,15 +1233,15 @@
"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).\n>Please refer to the KYC Verification documentation for further detail on processing tiers.",
"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).\n>Please refer to the KYC Verification documentation for further detail on processing tiers.",
"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" : {
"description" : "The processing tier that the Account Holder occupies.\n>Please refer to the KYC Verification documentation for further detail on processing tiers.",
"description" : "The processing tier that the account holder occupies.",
"format" : "int32",
"type" : "integer"
}
@@ -1307,11 +1307,11 @@
"BankAccountDetail" : {
"properties" : {
"accountNumber" : {
"description" : "The bank account number (without separators).\n>Please refer to the KYC Verification section for details on field requirements.",
"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>Please refer to the KYC Verification section for details on field requirements.",
"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" : {
@@ -1319,51 +1319,51 @@
"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",
"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>Please refer to the KYC Verification section for details on field requirements.",
"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>Please refer to the KYC Verification section for details on field requirements.",
"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>Please refer to the KYC Verification section for details on field requirements.",
"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>Please refer to the KYC Verification section for details on field requirements.",
"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.\n\n>Please refer to the KYC Verification section for details on field requirements.",
"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>Please refer to the KYC Verification section for details on field requirements.",
"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>Please refer to the KYC Verification section for details on field requirements.",
"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>Please refer to the KYC Verification section for details on field requirements.",
"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>Please refer to the KYC Verification section for details on field requirements.",
"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>Please refer to the KYC Verification section for details on field requirements.",
"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>Please refer to the KYC Verification section for details on field requirements.",
"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" : {
@@ -1371,27 +1371,27 @@
"type" : "string"
},
"ownerHouseNumberOrName" : {
"description" : "The house name or number of the residence of the bank account owner.\n>Please refer to the KYC Verification section for details on field requirements.",
"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>Please refer to the KYC Verification section for details on field requirements.",
"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>Please refer to the KYC Verification section for details on field requirements.",
"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>Please refer to the KYC Verification section for details on field requirements.",
"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>Please refer to the KYC Verification section for details on field requirements.",
"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>Please refer to the KYC Verification section for details on field requirements.",
"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" : {
@@ -1399,11 +1399,11 @@
"type" : "boolean"
},
"taxId" : {
"description" : "The tax ID number.\n\n>Please refer to the KYC Verification section for details on field requirements.",
"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>Please refer to the KYC Verification section for details on field requirements.",
"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"
}
}
@@ -1525,7 +1525,7 @@
"type" : "string"
},
"processingTier" : {
"description" : "The starting [processing tier](https://docs.adyen.com/developers/marketpay/kyc-verification/verification-process) for the prospective account holder.",
"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"
}
@@ -1569,7 +1569,7 @@
"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"
},
"verificationResult" : {
"verification" : {
"description" : "The details of KYC Verification of the account holder.",
"$ref" : "#/components/schemas/KYCVerificationResult"
}
@@ -1580,7 +1580,7 @@
"accountHolderCode",
"accountHolderStatus",
"accountHolderDetails",
"verificationResult"
"verification"
]
},
"CreateAccountRequest" : {
@@ -1693,11 +1693,11 @@
"DocumentDetail" : {
"properties" : {
"accountHolderCode" : {
"description" : "The code of Account Holder to which the document applies.",
"description" : "The code of account holder, to which the document applies.",
"type" : "string"
},
"bankAccountUUID" : {
"description" : "The unique ID of the Bank Account to which the document applies.\n>Required if the documentType is `BANK_STATEMENT` (i.e., a document is being submitted in order to verify a bank account).\n\n>Please refer to the KYC Verification section for details on when a document should be submitted in order to verify a bank account.",
"description" : "The unique ID of the Bank Account to which the document applies.\n>Required if the documentType is `BANK_STATEMENT` (i.e., a document is being submitted in order to verify a bank account).\n\n>Refer to the [Onboarding and verification](https://docs.adyen.com/developers/marketpay/onboarding-and-verification) section for details on when a document should be submitted in order to verify a bank account.",
"type" : "string"
},
"description" : {
@@ -1705,7 +1705,7 @@
"type" : "string"
},
"documentType" : {
"description" : "The type of document.\n>Permitted values: `PASSPORT`, `ID_CARD`, `ID_CARD_FRONT`, ID_CARD_BACK`, `DRIVING_LICENSE`, `DRIVING_LICENCE_FRONT`, `DRIVING_LICENCE_BACK`, `BANK_STATEMENT`.\n>* `ID_CARD` denotes an image containing both the front and back of the ID card.\n>* `ID_CARD_FRONT` denotes an image containing only the front of the ID card. In order for a document to be usable, both the ID_CARD_FRONT and ID_CARD_BACK must be submitted.\n>* `ID_CARD_BACK` denotes an image containing only the back of the ID card. In order for a document to be usable, both the ID_CARD_FRONT and ID_CARD_BACK must be submitted.\n>* `DRIVING_LICENCE` denotes an image containing both the front and back of the driving licence.\n>* `DRIVING_LICENCE_FRONT` denotes an image containing only the front of the driving licence. In order for a document to be usable, both the DRIVING_LICENCE_FRONT and DRIVING_LICENCE_BACK must be submitted.\n>* `DRIVING_LICENCE_BACK` denotes an image containing only the back of the driving licence. In order for a document to be usable, both the DRIVING_LICENCE_FRONT and DRIVING_LICENCE_FRONT must be submitted.\n\n>Please refer to the KYC Verification section for details on when each document type should be submitted.",
"description" : "The type of document.\nPermitted values:\n* `ID_CARD` denotes an image containing both the front and back of the ID card.\n* `ID_CARD_FRONT` denotes an image containing only the front of the ID card. In order for a document to be usable, both the `ID_CARD_FRONT` and `ID_CARD_BACK` must be submitted.\n* `ID_CARD_BACK` denotes an image containing only the back of the ID card. In order for a document to be usable, both the `ID_CARD_FRONT` and `ID_CARD_BACK` must be submitted.\n* `DRIVING_LICENCE` denotes an image containing both the front and back of the driving licence.\n* `DRIVING_LICENCE_FRONT` denotes an image containing only the front of the driving licence. In order for a document to be usable, both the `DRIVING_LICENCE_FRONT` and `DRIVING_LICENCE_BACK` must be submitted.\n* `DRIVING_LICENCE_BACK` denotes an image containing only the back of the driving licence. In order for a document to be usable, both the `DRIVING_LICENCE_FRONT` and `DRIVING_LICENCE_FRONT` must be submitted.\n\n>Please refer to [Verification checks](https://docs.adyen.com/developers/marketpay/onboarding-and-verification/verification-checks) for details on when each document type should be submitted.",
"enum" : [
"BANK_STATEMENT",
"BSN",
@@ -1726,7 +1726,7 @@
"type" : "string"
},
"shareholderCode" : {
"description" : "The code of the Shareholder to which the document applies.\n>Required if the Account Holder referred to by the accountHolderCode has a legalEntity of type `Business` and the documentType is either `PASSPORT`, `ID_CARD`, ID_CARD_FRONT`, `ID_CARD_BACK`, `DRIVING_LICENCE`, `DRIVING_LICENCE_FRONT`, `DRIVING_LICENCE_BACK` (i.e. a document is being submitted in order to verify a shareholder).\n\n>Please refer to the KYC Verification section for details on when a document should be submitted in order to verify a shareholder.",
"description" : "The code of the shareholder, to which the document applies.\n>Required if the account holder referred to by the `accountHolderCode` has a `legalEntity` of type `Business` and the `documentType` is either `PASSPORT`, `ID_CARD`, `ID_CARD_FRONT`, `ID_CARD_BACK`, `DRIVING_LICENCE`, `DRIVING_LICENCE_FRONT`, `DRIVING_LICENCE_BACK` (i.e. a document is being submitted in order to verify a shareholder).\n\n>Refer to the [Onboarding and verification](https://docs.adyen.com/developers/marketpay/onboarding-and-verification) section for details on when a document should be submitted in order to verify a shareholder.",
"type" : "string"
}
},
@@ -1898,7 +1898,7 @@
"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"
},
"verificationResult" : {
"verification" : {
"description" : "The details of KYC Verification of the account holder.",
"$ref" : "#/components/schemas/KYCVerificationResult"
}
@@ -1910,7 +1910,7 @@
"legalEntity",
"accountHolderStatus",
"accountHolderDetails",
"verificationResult"
"verification"
]
},
"GetAccountHolderStatusResponse" : {
@@ -1999,7 +1999,7 @@
"description" : "The unique ID of the bank account to which the check applies.",
"type" : "string"
},
"checkStatusData" : {
"checks" : {
"description" : "A list of the checks and their statuses.",
"items" : {
"$ref" : "#/components/schemas/KYCCheckStatusData"
@@ -2008,13 +2008,13 @@
}
},
"required" : [
"checkStatusData",
"checks",
"bankAccountUUID"
]
},
"KYCCheckResult" : {
"properties" : {
"checkStatusData" : {
"checks" : {
"description" : "A list of the checks and their statuses.",
"items" : {
"$ref" : "#/components/schemas/KYCCheckStatusData"
@@ -2023,12 +2023,19 @@
}
},
"required" : [
"checkStatusData"
"checks"
]
},
"KYCCheckStatusData" : {
"properties" : {
"checkStatus" : {
"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>Permitted Values: `UNCHECKED`, `DATA_PROVIDED`, `PASSED`, `PENDING`, `AWAITING_DATA`, `RETRY_LIMIT_REACHED`, `INVALID_DATA`, `FAILED`.",
"enum" : [
"AWAITING_DATA",
@@ -2043,7 +2050,11 @@
],
"type" : "string"
},
"checkType" : {
"summary" : {
"description" : "A summary of the execution of the check.",
"$ref" : "#/components/schemas/KYCCheckSummary"
},
"type" : {
"description" : "The type of check.\n>Permitted Values: `COMPANY_VERIFICATION`, `IDENTITY_VERIFICATION`, `PASSPORT_VERIFICATION`, `BANK_ACCOUNT_VERIFICATION`, `NONPROFIT_VERIFICATION`.",
"enum" : [
"BANK_ACCOUNT_VERIFICATION",
@@ -2053,22 +2064,11 @@
"PASSPORT_VERIFICATION"
],
"type" : "string"
},
"requiredFields" : {
"description" : "A list of the fields required for execution of the check.",
"items" : {
"type" : "string"
},
"type" : "array"
},
"summary" : {
"description" : "A summary of the execution of the check.",
"$ref" : "#/components/schemas/KYCCheckSummary"
}
},
"required" : [
"checkType",
"checkStatus",
"type",
"status",
"summary",
"requiredFields"
]
@@ -2091,7 +2091,7 @@
},
"KYCShareholderCheckResult" : {
"properties" : {
"checkStatusData" : {
"checks" : {
"description" : "A list of the checks and their statuses.",
"items" : {
"$ref" : "#/components/schemas/KYCCheckStatusData"
@@ -2104,24 +2104,24 @@
}
},
"required" : [
"checkStatusData",
"checks",
"shareholderCode"
]
},
"KYCVerificationResult" : {
"properties" : {
"accountHolderCheckResult" : {
"accountHolder" : {
"description" : "The result(s) of the checks on the account holder.",
"$ref" : "#/components/schemas/KYCCheckResult"
},
"bankAccountCheckResult" : {
"bankAccounts" : {
"description" : "The result(s) of the checks on the bank account(s).",
"items" : {
"$ref" : "#/components/schemas/KYCBankAccountCheckResult"
},
"type" : "array"
},
"shareholderCheckResult" : {
"shareholders" : {
"description" : "The result(s) of the checks on the shareholder(s).",
"items" : {
"$ref" : "#/components/schemas/KYCShareholderCheckResult"
@@ -2130,9 +2130,9 @@
}
},
"required" : [
"accountHolderCheckResult",
"shareholderCheckResult",
"bankAccountCheckResult"
"accountHolder",
"shareholders",
"bankAccounts"
]
},
"Name" : {
@@ -2274,7 +2274,7 @@
"SuspendAccountHolderRequest" : {
"properties" : {
"accountHolderCode" : {
"description" : "The code of the Account Holder to be suspended.",
"description" : "The code of the account holder to be suspended.",
"type" : "string"
}
},
@@ -2306,7 +2306,7 @@
"UnSuspendAccountHolderRequest" : {
"properties" : {
"accountHolderCode" : {
"description" : "The code of the Account Holder to be reinstated.",
"description" : "The code of the account holder to be reinstated.",
"type" : "string"
}
},
@@ -2317,7 +2317,7 @@
"UnSuspendAccountHolderResponse" : {
"properties" : {
"accountHolderStatus" : {
"description" : "The new status of the Account Holder.",
"description" : "The new status of the account holder.",
"$ref" : "#/components/schemas/AccountHolderStatus"
},
"pspReference" : {
@@ -2391,7 +2391,7 @@
},
"type" : "array"
},
"verificationResult" : {
"verification" : {
"description" : "The details of KYC Verification of the account holder.",
"$ref" : "#/components/schemas/KYCVerificationResult"
}
@@ -2400,7 +2400,7 @@
"pspReference",
"submittedAsync",
"accountHolderStatus",
"verificationResult"
"verification"
]
},
"UpdateAccountHolderStateRequest" : {
@@ -2480,7 +2480,7 @@
"UpdatePayoutScheduleRequest" : {
"properties" : {
"action" : {
"description" : "Direction on how to handle any payouts that have already been scheduled.\n>Permitted values: `CLOSE`, `UPDATE`, `NOTHING` (**default**).\n>* `CLOSE` will close the existing batch of payouts.\n>* `UPDATE` will reschedule the existing batch to the new schedule.\n>* `NOTHING` will allow the payout to proceed.",
"description" : "Direction on how to handle any payouts that have already been scheduled.\nPermitted values:\n* `CLOSE` will close the existing batch of payouts.\n* `UPDATE` will reschedule the existing batch to the new schedule.\n* `NOTHING` (**default**) will allow the payout to proceed.",
"enum" : [
"CLOSE",
"NOTHING",
@@ -2489,11 +2489,11 @@
"type" : "string"
},
"reason" : {
"description" : "The reason for the payout schedule update. This field is required when the `schedule` parameter is set to **HOLD**.",
"description" : "The reason for the payout schedule update.\n> This field is required when the `schedule` parameter is set to `HOLD`.",
"type" : "string"
},
"schedule" : {
"description" : "The payout schedule to which the account is to be updated.\n> Permitted values: `DEFAULT`, `HOLD`, `DAILY`, `WEEKLY`, `MONTHLY`.",
"description" : "The payout schedule to which the account is to be updated.\nPermitted values: `DEFAULT`, `HOLD`, `DAILY`, `WEEKLY`, `MONTHLY`.",
"enum" : [
"DAILY",
"DEFAULT",
@@ -2527,4 +2527,4 @@
}
}
}
}
}