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

spec release

Browse Source
This commit is contained in:
Adyen Automation
2022-10-06 14:03:14 +00:00
parent 3d5176d521
commit 49d15b16e9
34 changed files with 1131 additions and 1037 deletions
Download Patch File Download Diff File Expand all files Collapse all files

52
json/AccountService-v3.json
View File

@@ -10,7 +10,7 @@
"x-publicVersion" : true,
"title" : "Account API",
"description" : "This API is used for the classic integration. If you are just starting your implementation, refer to our [new integration guide](https://docs.adyen.com/marketplaces-and-platforms) instead.\n\nThe Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and verification-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them.\n\nFor more information, refer to our [documentation](https://docs.adyen.com/marketplaces-and-platforms/classic).\n## Authentication\nYour Adyen contact will provide your API credential and an API key. To connect to the API, add an `X-API-Key` header with the API key as the value, for example:\n\n ```\ncurl\n-H \"Content-Type: application/json\" \\\n-H \"X-API-Key: YOUR_API_KEY\" \\\n...\n```\n\nAlternatively, you can use the username and password to connect to the API using basic authentication. For example:\n\n```\ncurl\n-U \"ws@MarketPlace.YOUR_PLATFORM_ACCOUNT\":\"YOUR_WS_PASSWORD\" \\\n-H \"Content-Type: application/json\" \\\n...\n```\nWhen going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints).\n\n## Versioning\nThe Account API supports [versioning](https://docs.adyen.com/development-resources/versioning) using 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```",
"x-timestamp" : "2022-08-29T12:22:33Z",
"x-timestamp" : "2022-09-23T17:24:11Z",
"termsOfService" : "https://www.adyen.com/legal/terms-and-conditions",
"contact" : {
"name" : "Adyen Developer Experience team",
@@ -2090,7 +2090,7 @@
"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).",
"description" : "The event.\n>Permitted values: `InactivateAccount`, `RefundNotPaidOutTransfers`.\nFor more information, refer to [Verification checks](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process).",
"enum" : [
"InactivateAccount",
"RefundNotPaidOutTransfers"
@@ -2120,7 +2120,7 @@
"$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).",
"description" : "Array of bank accounts associated with the account holder. For details about the required `bankAccountDetail` fields, see [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information).",
"items" : {
"$ref" : "#/components/schemas/BankAccountDetail"
},
@@ -2282,11 +2282,11 @@
"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.",
"description" : "The bank account number (without separators).\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) 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.",
"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 [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.",
"type" : "string"
},
"bankAccountName" : {
@@ -2298,47 +2298,47 @@
"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.",
"description" : "The bank identifier code.\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) 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.",
"description" : "The city in which the bank branch is located.\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) 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.",
"description" : "The bank code of the banking institution with which the bank account is registered.\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) 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.",
"description" : "The name of the banking institution with which the bank account is held.\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) 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.",
"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 [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) 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.",
"description" : "The check code of the bank account.\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) 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.",
"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 [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) 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.",
"description" : "The currency in which the bank account deals.\n>The permitted currency codes are defined in ISO-4217 (e.g. 'EUR').\n",
"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.",
"description" : "The international bank account number.\n>The IBAN standard is defined in ISO-13616.\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) 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.",
"description" : "The city of residence of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) 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.",
"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 [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.",
"type" : "string"
},
"ownerDateOfBirth" : {
@@ -2347,27 +2347,27 @@
"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.",
"description" : "The house name or number of the residence of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) 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.",
"description" : "The name of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) 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.",
"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 [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) 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.",
"description" : "The postal code of the residence of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) 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.",
"description" : "The state of residence of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) 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.",
"description" : "The street name of the residence of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.",
"type" : "string"
},
"primaryAccount" : {
@@ -2375,11 +2375,11 @@
"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.",
"description" : "The tax ID number.\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) 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.",
"description" : "The URL to be used for bank account verification.\nThis may be generated on bank account creation.\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.",
"type" : "string"
}
}
@@ -2402,7 +2402,7 @@
"type" : "array"
},
"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).",
"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 [our verification guide](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process#identify-ubos).",
"items" : {
"$ref" : "#/components/schemas/ShareholderContact"
},
@@ -3482,7 +3482,7 @@
"$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",
"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 Account Holder will fail with a validation Error..**\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"
},
"shareholderType" : {

52
json/AccountService-v4.json
View File

@@ -10,7 +10,7 @@
"x-publicVersion" : true,
"title" : "Account API",
"description" : "This API is used for the classic integration. If you are just starting your implementation, refer to our [new integration guide](https://docs.adyen.com/marketplaces-and-platforms) instead.\n\nThe Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and verification-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them.\n\nFor more information, refer to our [documentation](https://docs.adyen.com/marketplaces-and-platforms/classic).\n## Authentication\nYour Adyen contact will provide your API credential and an API key. To connect to the API, add an `X-API-Key` header with the API key as the value, for example:\n\n ```\ncurl\n-H \"Content-Type: application/json\" \\\n-H \"X-API-Key: YOUR_API_KEY\" \\\n...\n```\n\nAlternatively, you can use the username and password to connect to the API using basic authentication. For example:\n\n```\ncurl\n-U \"ws@MarketPlace.YOUR_PLATFORM_ACCOUNT\":\"YOUR_WS_PASSWORD\" \\\n-H \"Content-Type: application/json\" \\\n...\n```\nWhen going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints).\n\n## Versioning\nThe Account API supports [versioning](https://docs.adyen.com/development-resources/versioning) using 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```",
"x-timestamp" : "2022-08-29T12:22:33Z",
"x-timestamp" : "2022-09-23T17:24:11Z",
"termsOfService" : "https://www.adyen.com/legal/terms-and-conditions",
"contact" : {
"name" : "Adyen Developer Experience team",
@@ -2074,7 +2074,7 @@
"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).",
"description" : "The event.\n>Permitted values: `InactivateAccount`, `RefundNotPaidOutTransfers`.\nFor more information, refer to [Verification checks](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process).",
"enum" : [
"InactivateAccount",
"RefundNotPaidOutTransfers"
@@ -2104,7 +2104,7 @@
"$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).",
"description" : "Array of bank accounts associated with the account holder. For details about the required `bankAccountDetail` fields, see [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information).",
"items" : {
"$ref" : "#/components/schemas/BankAccountDetail"
},
@@ -2266,11 +2266,11 @@
"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.",
"description" : "The bank account number (without separators).\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) 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.",
"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 [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.",
"type" : "string"
},
"bankAccountName" : {
@@ -2282,47 +2282,47 @@
"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.",
"description" : "The bank identifier code.\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) 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.",
"description" : "The city in which the bank branch is located.\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) 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.",
"description" : "The bank code of the banking institution with which the bank account is registered.\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) 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.",
"description" : "The name of the banking institution with which the bank account is held.\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) 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.",
"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 [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) 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.",
"description" : "The check code of the bank account.\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) 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.",
"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 [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) 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.",
"description" : "The currency in which the bank account deals.\n>The permitted currency codes are defined in ISO-4217 (e.g. 'EUR').\n",
"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.",
"description" : "The international bank account number.\n>The IBAN standard is defined in ISO-13616.\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) 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.",
"description" : "The city of residence of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) 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.",
"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 [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.",
"type" : "string"
},
"ownerDateOfBirth" : {
@@ -2331,27 +2331,27 @@
"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.",
"description" : "The house name or number of the residence of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) 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.",
"description" : "The name of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) 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.",
"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 [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) 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.",
"description" : "The postal code of the residence of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) 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.",
"description" : "The state of residence of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) 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.",
"description" : "The street name of the residence of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.",
"type" : "string"
},
"primaryAccount" : {
@@ -2359,11 +2359,11 @@
"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.",
"description" : "The tax ID number.\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) 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.",
"description" : "The URL to be used for bank account verification.\nThis may be generated on bank account creation.\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.",
"type" : "string"
}
}
@@ -2391,7 +2391,7 @@
"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).",
"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 [our verification guide](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process#identify-ubos).",
"items" : {
"$ref" : "#/components/schemas/ShareholderContact"
},
@@ -3527,7 +3527,7 @@
"$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",
"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 Account Holder will fail with a validation Error..**\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"
},
"shareholderType" : {

64
json/AccountService-v5.json
View File

@@ -10,7 +10,7 @@
"x-publicVersion" : true,
"title" : "Account API",
"description" : "This API is used for the classic integration. If you are just starting your implementation, refer to our [new integration guide](https://docs.adyen.com/marketplaces-and-platforms) instead.\n\nThe Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and verification-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them.\n\nFor more information, refer to our [documentation](https://docs.adyen.com/marketplaces-and-platforms/classic).\n## Authentication\nYour Adyen contact will provide your API credential and an API key. To connect to the API, add an `X-API-Key` header with the API key as the value, for example:\n\n ```\ncurl\n-H \"Content-Type: application/json\" \\\n-H \"X-API-Key: YOUR_API_KEY\" \\\n...\n```\n\nAlternatively, you can use the username and password to connect to the API using basic authentication. For example:\n\n```\ncurl\n-U \"ws@MarketPlace.YOUR_PLATFORM_ACCOUNT\":\"YOUR_WS_PASSWORD\" \\\n-H \"Content-Type: application/json\" \\\n...\n```\nWhen going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints).\n\n## Versioning\nThe Account API supports [versioning](https://docs.adyen.com/development-resources/versioning) using 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/v5/createAccountHolder\n```",
"x-timestamp" : "2022-08-29T12:22:33Z",
"x-timestamp" : "2022-09-23T17:24:11Z",
"termsOfService" : "https://www.adyen.com/legal/terms-and-conditions",
"contact" : {
"name" : "Adyen Developer Experience team",
@@ -2444,7 +2444,7 @@
"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).",
"description" : "The event.\n>Permitted values: `InactivateAccount`, `RefundNotPaidOutTransfers`.\nFor more information, refer to [Verification checks](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process).",
"enum" : [
"InactivateAccount",
"RefundNotPaidOutTransfers"
@@ -2474,7 +2474,7 @@
"$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).",
"description" : "Array of bank accounts associated with the account holder. For details about the required `bankAccountDetail` fields, see [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information).",
"items" : {
"$ref" : "#/components/schemas/BankAccountDetail"
},
@@ -2518,7 +2518,7 @@
},
"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).",
"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/marketplaces-and-platforms/classic/payout-to-cards).",
"items" : {
"$ref" : "#/components/schemas/PayoutMethod"
},
@@ -2530,7 +2530,7 @@
},
"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).",
"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/marketplaces-and-platforms/classic/platforms-for-pos).",
"items" : {
"$ref" : "#/components/schemas/StoreDetail"
},
@@ -2662,11 +2662,11 @@
"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.",
"description" : "The bank account number (without separators).\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) 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.",
"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 [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.",
"type" : "string"
},
"bankAccountName" : {
@@ -2683,47 +2683,47 @@
"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.",
"description" : "The bank identifier code.\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) 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.",
"description" : "The city in which the bank branch is located.\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) 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.",
"description" : "The bank code of the banking institution with which the bank account is registered.\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) 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.",
"description" : "The name of the banking institution with which the bank account is held.\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) 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.",
"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 [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) 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.",
"description" : "The check code of the bank account.\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) 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.",
"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 [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) 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.",
"description" : "The currency in which the bank account deals.\n>The permitted currency codes are defined in ISO-4217 (e.g. 'EUR').\n",
"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.",
"description" : "The international bank account number.\n>The IBAN standard is defined in ISO-13616.\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) 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.",
"description" : "The city of residence of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) 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.",
"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 [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.",
"type" : "string"
},
"ownerDateOfBirth" : {
@@ -2732,27 +2732,27 @@
"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.",
"description" : "The house name or number of the residence of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) 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.",
"description" : "The name of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) 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.",
"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 [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) 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.",
"description" : "The postal code of the residence of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) 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.",
"description" : "The state of residence of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) 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.",
"description" : "The street name of the residence of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.",
"type" : "string"
},
"primaryAccount" : {
@@ -2760,11 +2760,11 @@
"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.",
"description" : "The tax ID number.\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) 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.",
"description" : "The URL to be used for bank account verification.\nThis may be generated on bank account creation.\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.",
"type" : "string"
}
}
@@ -2792,7 +2792,7 @@
"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).",
"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 [our verification guide](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process#identify-ubos).",
"items" : {
"$ref" : "#/components/schemas/ShareholderContact"
},
@@ -3876,7 +3876,7 @@
"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).",
"description" : "The code of the check. For possible values, refer to [Verification codes](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/verification-codes).",
"format" : "int32",
"type" : "integer"
},
@@ -3975,7 +3975,7 @@
"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).",
"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/marketplaces-and-platforms/classic/payouts/manual-payout/payout-to-cards#check-and-store).",
"type" : "string"
},
"payoutMethodCode" : {
@@ -3987,11 +3987,11 @@
"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).",
"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/marketplaces-and-platforms/classic/payouts/manual-payout/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).",
"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/marketplaces-and-platforms/classic/payouts/manual-payout/payout-to-cards#check-and-store).",
"type" : "string"
}
},
@@ -4151,7 +4151,7 @@
"$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",
"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 Account Holder will fail with a validation Error..**\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" : {

72
json/AccountService-v6.json
View File

@@ -10,7 +10,7 @@
"x-publicVersion" : true,
"title" : "Account API",
"description" : "This API is used for the classic integration. If you are just starting your implementation, refer to our [new integration guide](https://docs.adyen.com/marketplaces-and-platforms) instead.\n\nThe Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and verification-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them.\n\nFor more information, refer to our [documentation](https://docs.adyen.com/marketplaces-and-platforms/classic).\n## Authentication\nYour Adyen contact will provide your API credential and an API key. To connect to the API, add an `X-API-Key` header with the API key as the value, for example:\n\n ```\ncurl\n-H \"Content-Type: application/json\" \\\n-H \"X-API-Key: YOUR_API_KEY\" \\\n...\n```\n\nAlternatively, you can use the username and password to connect to the API using basic authentication. For example:\n\n```\ncurl\n-U \"ws@MarketPlace.YOUR_PLATFORM_ACCOUNT\":\"YOUR_WS_PASSWORD\" \\\n-H \"Content-Type: application/json\" \\\n...\n```\nWhen going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints).\n\n## Versioning\nThe Account API supports [versioning](https://docs.adyen.com/development-resources/versioning) using 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/v6/createAccountHolder\n```",
"x-timestamp" : "2022-08-29T12:22:33Z",
"x-timestamp" : "2022-10-06T13:26:47Z",
"termsOfService" : "https://www.adyen.com/legal/terms-and-conditions",
"contact" : {
"name" : "Adyen Developer Experience team",
@@ -2444,7 +2444,7 @@
"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).",
"description" : "The event.\n>Permitted values: `InactivateAccount`, `RefundNotPaidOutTransfers`.\nFor more information, refer to [Verification checks](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process).",
"enum" : [
"InactivateAccount",
"RefundNotPaidOutTransfers"
@@ -2474,7 +2474,7 @@
"$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).",
"description" : "Array of bank accounts associated with the account holder. For details about the required `bankAccountDetail` fields, see [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information).",
"items" : {
"$ref" : "#/components/schemas/BankAccountDetail"
},
@@ -2507,7 +2507,7 @@
},
"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).",
"description" : "An array containing information about the account holder's [legal arrangements](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/legal-arrangements).",
"items" : {
"$ref" : "#/components/schemas/LegalArrangementDetail"
},
@@ -2526,7 +2526,7 @@
},
"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).",
"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/marketplaces-and-platforms/classic/payout-to-cards).",
"items" : {
"$ref" : "#/components/schemas/PayoutMethod"
},
@@ -2538,7 +2538,7 @@
},
"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).",
"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/marketplaces-and-platforms/classic/platforms-for-pos).",
"items" : {
"$ref" : "#/components/schemas/StoreDetail"
},
@@ -2670,11 +2670,11 @@
"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.",
"description" : "The bank account number (without separators).\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) 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.",
"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 [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.",
"type" : "string"
},
"bankAccountName" : {
@@ -2691,47 +2691,47 @@
"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.",
"description" : "The bank identifier code.\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) 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.",
"description" : "The city in which the bank branch is located.\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) 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.",
"description" : "The bank code of the banking institution with which the bank account is registered.\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) 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.",
"description" : "The name of the banking institution with which the bank account is held.\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) 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.",
"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 [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) 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.",
"description" : "The check code of the bank account.\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) 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.",
"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 [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) 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.",
"description" : "The currency in which the bank account deals.\n>The permitted currency codes are defined in ISO-4217 (e.g. 'EUR').\n",
"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.",
"description" : "The international bank account number.\n>The IBAN standard is defined in ISO-13616.\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) 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.",
"description" : "The city of residence of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) 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.",
"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 [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.",
"type" : "string"
},
"ownerDateOfBirth" : {
@@ -2740,27 +2740,27 @@
"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.",
"description" : "The house name or number of the residence of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) 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.",
"description" : "The name of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) 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.",
"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 [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) 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.",
"description" : "The postal code of the residence of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) 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.",
"description" : "The state of residence of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) 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.",
"description" : "The street name of the residence of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.",
"type" : "string"
},
"primaryAccount" : {
@@ -2768,11 +2768,11 @@
"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.",
"description" : "The tax ID number.\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) 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.",
"description" : "The URL to be used for bank account verification.\nThis may be generated on bank account creation.\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.",
"type" : "string"
}
}
@@ -2800,7 +2800,7 @@
"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).",
"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 [our verification guide](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process#identify-ubos).",
"items" : {
"$ref" : "#/components/schemas/ShareholderContact"
},
@@ -3901,7 +3901,7 @@
"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).",
"description" : "The code of the check. For possible values, refer to [Verification codes](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/verification-codes).",
"format" : "int32",
"type" : "integer"
},
@@ -4078,7 +4078,7 @@
"$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.",
"description" : "Adyen-generated unique alphanumeric identifier (UUID) for the entry, returned in the response when you create a legal arrangement.\nUse only when updating an account holder. If you include this field when creating an account holder, the request will fail.",
"type" : "string"
},
"legalArrangementEntities" : {
@@ -4129,7 +4129,7 @@
"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",
"description" : "The [type of legal arrangement](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/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",
@@ -4168,7 +4168,7 @@
"$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.",
"description" : "Adyen-generated unique alphanumeric identifier (UUID) for the entry, returned in the response when you create a legal arrangement entity.\nUse only when updating an account holder. If you include this field when creating an account holder, the request will fail.",
"type" : "string"
},
"legalArrangementEntityReference" : {
@@ -4236,7 +4236,7 @@
"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).",
"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/marketplaces-and-platforms/classic/payouts/manual-payout/payout-to-cards#check-and-store).",
"type" : "string"
},
"payoutMethodCode" : {
@@ -4248,11 +4248,11 @@
"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).",
"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/marketplaces-and-platforms/classic/payouts/manual-payout/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).",
"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/marketplaces-and-platforms/classic/payouts/manual-payout/payout-to-cards#check-and-store).",
"type" : "string"
}
},
@@ -4412,7 +4412,7 @@
"$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",
"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 Account Holder will fail with a validation Error..**\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" : {

71
json/FundService-v3.json
View File

@@ -10,7 +10,7 @@
"x-publicVersion" : true,
"title" : "Fund API",
"description" : "This API is used for the classic integration. If you are just starting your implementation, refer to our [new integration guide](https://docs.adyen.com/marketplaces-and-platforms) instead.\n\nThe Fund API provides endpoints for managing the funds in the accounts on your platform. These management operations include, for example, the transfer of funds from one account to another, the payout of funds to an account holder, and the retrieval of balances in an account.\n\nFor more information, refer to our [documentation](https://docs.adyen.com/marketplaces-and-platforms/classic/).\n## Authentication\nYour Adyen contact will provide your API credential and an API key. To connect to the API, add an `X-API-Key` header with the API key as the value, for example:\n\n ```\ncurl\n-H \"Content-Type: application/json\" \\\n-H \"X-API-Key: YOUR_API_KEY\" \\\n...\n```\n\nAlternatively, you can use the username and password to connect to the API using basic authentication. For example:\n\n```\ncurl\n-U \"ws@MarketPlace.YOUR_PLATFORM_ACCOUNT\":\"YOUR_WS_PASSWORD\" \\\n-H \"Content-Type: application/json\" \\\n...\n```\nWhen going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints).\n\n## Versioning\nThe Fund API supports [versioning](https://docs.adyen.com/development-resources/versioning) using 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/Fund/v3/accountHolderBalance\n```",
"x-timestamp" : "2022-08-25T18:26:01Z",
"x-timestamp" : "2022-09-27T19:26:19Z",
"termsOfService" : "https://www.adyen.com/legal/terms-and-conditions",
"contact" : {
"name" : "Adyen Developer Experience team",
@@ -19,7 +19,8 @@
}
},
"x-groups" : [
"General"
"General",
"Migration"
],
"tags" : [
{
@@ -72,6 +73,16 @@
},
"description" : "OK - the request has succeeded."
},
"202" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AccountHolderBalanceResponse"
}
}
},
"description" : "Accepted - the request has been accepted for processing, but the processing has not been completed."
},
"400" : {
"content" : {
"application/json" : {
@@ -173,6 +184,16 @@
},
"description" : "OK - the request has succeeded."
},
"202" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AccountHolderTransactionListResponse"
}
}
},
"description" : "Accepted - the request has been accepted for processing, but the processing has not been completed."
},
"400" : {
"content" : {
"application/json" : {
@@ -950,6 +971,8 @@
"items" : {
"enum" : [
"BalanceNotPaidOutTransfer",
"BalancePlatformSweep",
"BalancePlatfromSweepReturned",
"Chargeback",
"ChargebackCorrection",
"ChargebackCorrectionReceived",
@@ -1066,11 +1089,11 @@
"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.",
"description" : "The bank account number (without separators).\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) 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.",
"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 [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.",
"type" : "string"
},
"bankAccountName" : {
@@ -1082,47 +1105,47 @@
"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.",
"description" : "The bank identifier code.\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) 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.",
"description" : "The city in which the bank branch is located.\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) 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.",
"description" : "The bank code of the banking institution with which the bank account is registered.\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) 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.",
"description" : "The name of the banking institution with which the bank account is held.\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) 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.",
"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 [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) 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.",
"description" : "The check code of the bank account.\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) 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.",
"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 [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) 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.",
"description" : "The currency in which the bank account deals.\n>The permitted currency codes are defined in ISO-4217 (e.g. 'EUR').\n",
"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.",
"description" : "The international bank account number.\n>The IBAN standard is defined in ISO-13616.\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) 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.",
"description" : "The city of residence of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) 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.",
"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 [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.",
"type" : "string"
},
"ownerDateOfBirth" : {
@@ -1131,27 +1154,27 @@
"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.",
"description" : "The house name or number of the residence of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) 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.",
"description" : "The name of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) 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.",
"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 [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) 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.",
"description" : "The postal code of the residence of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) 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.",
"description" : "The state of residence of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) 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.",
"description" : "The street name of the residence of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.",
"type" : "string"
},
"primaryAccount" : {
@@ -1159,11 +1182,11 @@
"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.",
"description" : "The tax ID number.\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) 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.",
"description" : "The URL to be used for bank account verification.\nThis may be generated on bank account creation.\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.",
"type" : "string"
}
}
@@ -1577,6 +1600,8 @@
"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",
"BalancePlatformSweep",
"BalancePlatfromSweepReturned",
"Chargeback",
"ChargebackCorrection",
"ChargebackCorrectionReceived",

71
json/FundService-v5.json
View File

@@ -10,7 +10,7 @@
"x-publicVersion" : true,
"title" : "Fund API",
"description" : "This API is used for the classic integration. If you are just starting your implementation, refer to our [new integration guide](https://docs.adyen.com/marketplaces-and-platforms) instead.\n\nThe Fund API provides endpoints for managing the funds in the accounts on your platform. These management operations include, for example, the transfer of funds from one account to another, the payout of funds to an account holder, and the retrieval of balances in an account.\n\nFor more information, refer to our [documentation](https://docs.adyen.com/marketplaces-and-platforms/classic/).\n## Authentication\nYour Adyen contact will provide your API credential and an API key. To connect to the API, add an `X-API-Key` header with the API key as the value, for example:\n\n ```\ncurl\n-H \"Content-Type: application/json\" \\\n-H \"X-API-Key: YOUR_API_KEY\" \\\n...\n```\n\nAlternatively, you can use the username and password to connect to the API using basic authentication. For example:\n\n```\ncurl\n-U \"ws@MarketPlace.YOUR_PLATFORM_ACCOUNT\":\"YOUR_WS_PASSWORD\" \\\n-H \"Content-Type: application/json\" \\\n...\n```\nWhen going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints).\n\n## Versioning\nThe Fund API supports [versioning](https://docs.adyen.com/development-resources/versioning) using 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/Fund/v5/accountHolderBalance\n```",
"x-timestamp" : "2022-08-25T18:26:01Z",
"x-timestamp" : "2022-09-27T19:26:20Z",
"termsOfService" : "https://www.adyen.com/legal/terms-and-conditions",
"contact" : {
"name" : "Adyen Developer Experience team",
@@ -19,7 +19,8 @@
}
},
"x-groups" : [
"General"
"General",
"Migration"
],
"tags" : [
{
@@ -72,6 +73,16 @@
},
"description" : "OK - the request has succeeded."
},
"202" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AccountHolderBalanceResponse"
}
}
},
"description" : "Accepted - the request has been accepted for processing, but the processing has not been completed."
},
"400" : {
"content" : {
"application/json" : {
@@ -173,6 +184,16 @@
},
"description" : "OK - the request has succeeded."
},
"202" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AccountHolderTransactionListResponse"
}
}
},
"description" : "Accepted - the request has been accepted for processing, but the processing has not been completed."
},
"400" : {
"content" : {
"application/json" : {
@@ -954,6 +975,8 @@
"items" : {
"enum" : [
"BalanceNotPaidOutTransfer",
"BalancePlatformSweep",
"BalancePlatfromSweepReturned",
"Chargeback",
"ChargebackCorrection",
"ChargebackCorrectionReceived",
@@ -1074,11 +1097,11 @@
"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.",
"description" : "The bank account number (without separators).\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) 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.",
"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 [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.",
"type" : "string"
},
"bankAccountName" : {
@@ -1095,47 +1118,47 @@
"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.",
"description" : "The bank identifier code.\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) 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.",
"description" : "The city in which the bank branch is located.\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) 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.",
"description" : "The bank code of the banking institution with which the bank account is registered.\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) 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.",
"description" : "The name of the banking institution with which the bank account is held.\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) 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.",
"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 [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) 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.",
"description" : "The check code of the bank account.\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) 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.",
"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 [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) 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.",
"description" : "The currency in which the bank account deals.\n>The permitted currency codes are defined in ISO-4217 (e.g. 'EUR').\n",
"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.",
"description" : "The international bank account number.\n>The IBAN standard is defined in ISO-13616.\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) 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.",
"description" : "The city of residence of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) 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.",
"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 [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.",
"type" : "string"
},
"ownerDateOfBirth" : {
@@ -1144,27 +1167,27 @@
"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.",
"description" : "The house name or number of the residence of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) 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.",
"description" : "The name of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) 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.",
"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 [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) 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.",
"description" : "The postal code of the residence of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) 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.",
"description" : "The state of residence of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) 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.",
"description" : "The street name of the residence of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.",
"type" : "string"
},
"primaryAccount" : {
@@ -1172,11 +1195,11 @@
"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.",
"description" : "The tax ID number.\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) 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.",
"description" : "The URL to be used for bank account verification.\nThis may be generated on bank account creation.\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.",
"type" : "string"
}
}
@@ -1839,6 +1862,8 @@
"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",
"BalancePlatformSweep",
"BalancePlatfromSweepReturned",
"Chargeback",
"ChargebackCorrection",
"ChargebackCorrectionReceived",

71
json/FundService-v6.json
View File

@@ -10,7 +10,7 @@
"x-publicVersion" : true,
"title" : "Fund API",
"description" : "This API is used for the classic integration. If you are just starting your implementation, refer to our [new integration guide](https://docs.adyen.com/marketplaces-and-platforms) instead.\n\nThe Fund API provides endpoints for managing the funds in the accounts on your platform. These management operations include, for example, the transfer of funds from one account to another, the payout of funds to an account holder, and the retrieval of balances in an account.\n\nFor more information, refer to our [documentation](https://docs.adyen.com/marketplaces-and-platforms/classic/).\n## Authentication\nYour Adyen contact will provide your API credential and an API key. To connect to the API, add an `X-API-Key` header with the API key as the value, for example:\n\n ```\ncurl\n-H \"Content-Type: application/json\" \\\n-H \"X-API-Key: YOUR_API_KEY\" \\\n...\n```\n\nAlternatively, you can use the username and password to connect to the API using basic authentication. For example:\n\n```\ncurl\n-U \"ws@MarketPlace.YOUR_PLATFORM_ACCOUNT\":\"YOUR_WS_PASSWORD\" \\\n-H \"Content-Type: application/json\" \\\n...\n```\nWhen going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints).\n\n## Versioning\nThe Fund API supports [versioning](https://docs.adyen.com/development-resources/versioning) using 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/Fund/v6/accountHolderBalance\n```",
"x-timestamp" : "2022-08-25T18:26:01Z",
"x-timestamp" : "2022-09-27T19:26:20Z",
"termsOfService" : "https://www.adyen.com/legal/terms-and-conditions",
"contact" : {
"name" : "Adyen Developer Experience team",
@@ -19,7 +19,8 @@
}
},
"x-groups" : [
"General"
"General",
"Migration"
],
"tags" : [
{
@@ -72,6 +73,16 @@
},
"description" : "OK - the request has succeeded."
},
"202" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AccountHolderBalanceResponse"
}
}
},
"description" : "Accepted - the request has been accepted for processing, but the processing has not been completed."
},
"400" : {
"content" : {
"application/json" : {
@@ -173,6 +184,16 @@
},
"description" : "OK - the request has succeeded."
},
"202" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AccountHolderTransactionListResponse"
}
}
},
"description" : "Accepted - the request has been accepted for processing, but the processing has not been completed."
},
"400" : {
"content" : {
"application/json" : {
@@ -954,6 +975,8 @@
"items" : {
"enum" : [
"BalanceNotPaidOutTransfer",
"BalancePlatformSweep",
"BalancePlatfromSweepReturned",
"Chargeback",
"ChargebackCorrection",
"ChargebackCorrectionReceived",
@@ -1074,11 +1097,11 @@
"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.",
"description" : "The bank account number (without separators).\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) 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.",
"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 [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.",
"type" : "string"
},
"bankAccountName" : {
@@ -1095,47 +1118,47 @@
"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.",
"description" : "The bank identifier code.\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) 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.",
"description" : "The city in which the bank branch is located.\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) 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.",
"description" : "The bank code of the banking institution with which the bank account is registered.\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) 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.",
"description" : "The name of the banking institution with which the bank account is held.\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) 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.",
"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 [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) 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.",
"description" : "The check code of the bank account.\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) 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.",
"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 [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) 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.",
"description" : "The currency in which the bank account deals.\n>The permitted currency codes are defined in ISO-4217 (e.g. 'EUR').\n",
"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.",
"description" : "The international bank account number.\n>The IBAN standard is defined in ISO-13616.\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) 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.",
"description" : "The city of residence of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) 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.",
"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 [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.",
"type" : "string"
},
"ownerDateOfBirth" : {
@@ -1144,27 +1167,27 @@
"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.",
"description" : "The house name or number of the residence of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) 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.",
"description" : "The name of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) 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.",
"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 [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) 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.",
"description" : "The postal code of the residence of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) 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.",
"description" : "The state of residence of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) 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.",
"description" : "The street name of the residence of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.",
"type" : "string"
},
"primaryAccount" : {
@@ -1172,11 +1195,11 @@
"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.",
"description" : "The tax ID number.\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) 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.",
"description" : "The URL to be used for bank account verification.\nThis may be generated on bank account creation.\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.",
"type" : "string"
}
}
@@ -1839,6 +1862,8 @@
"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",
"BalancePlatformSweep",
"BalancePlatfromSweepReturned",
"Chargeback",
"ChargebackCorrection",
"ChargebackCorrectionReceived",

60
json/MarketPayNotificationService-v3.json
View File

@@ -3,9 +3,9 @@
"info" : {
"version" : "3",
"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).",
"x-timestamp" : "2022-08-16T10:21:11Z",
"title" : "Classic Platforms - Notifications",
"description" : "This API is used for the classic integration. If you are just starting your implementation, refer to our [new integration guide](https://docs.adyen.com/marketplaces-and-platforms) instead.\n\nThe Notification API sends notifications to the endpoints specified in a given subscription. \nSubscriptions 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/marketplaces-and-platforms/classic/notifications).",
"x-timestamp" : "2022-09-27T19:26:20Z",
"termsOfService" : "https://www.adyen.com/legal/terms-and-conditions",
"contact" : {
"name" : "Adyen Developer Experience team",
@@ -775,7 +775,7 @@
"Other"
],
"summary" : "Booking for a capture or refund failed",
"description" : "Adyen sends this notification 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 or fromyour platform's liable account instead of the account specified in the split data.",
"description" : "Adyen sends this notification when a [split payment](https://docs.adyen.com/marketplaces-and-platforms/classic/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 or fromyour platform's liable account instead of the account specified in the split data.",
"operationId" : "post-PAYMENT_FAILURE",
"x-groupName" : "Other",
"x-sortIndex" : 1,
@@ -1092,7 +1092,7 @@
"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).",
"description" : "The event.\n>Permitted values: `InactivateAccount`, `RefundNotPaidOutTransfers`.\nFor more information, refer to [Verification checks](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process).",
"enum" : [
"InactivateAccount",
"RefundNotPaidOutTransfers"
@@ -1212,7 +1212,7 @@
"$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).",
"description" : "Array of bank accounts associated with the account holder. For details about the required `bankAccountDetail` fields, see [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information).",
"items" : {
"$ref" : "#/components/schemas/BankAccountDetail"
},
@@ -1769,11 +1769,11 @@
"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.",
"description" : "The bank account number (without separators).\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) 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.",
"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 [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.",
"type" : "string"
},
"bankAccountName" : {
@@ -1785,47 +1785,47 @@
"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.",
"description" : "The bank identifier code.\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) 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.",
"description" : "The city in which the bank branch is located.\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) 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.",
"description" : "The bank code of the banking institution with which the bank account is registered.\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) 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.",
"description" : "The name of the banking institution with which the bank account is held.\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) 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.",
"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 [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) 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.",
"description" : "The check code of the bank account.\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) 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.",
"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 [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) 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.",
"description" : "The currency in which the bank account deals.\n>The permitted currency codes are defined in ISO-4217 (e.g. 'EUR').\n",
"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.",
"description" : "The international bank account number.\n>The IBAN standard is defined in ISO-13616.\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) 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.",
"description" : "The city of residence of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) 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.",
"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 [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.",
"type" : "string"
},
"ownerDateOfBirth" : {
@@ -1834,27 +1834,27 @@
"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.",
"description" : "The house name or number of the residence of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) 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.",
"description" : "The name of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) 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.",
"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 [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) 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.",
"description" : "The postal code of the residence of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) 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.",
"description" : "The state of residence of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) 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.",
"description" : "The street name of the residence of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.",
"type" : "string"
},
"primaryAccount" : {
@@ -1862,11 +1862,11 @@
"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.",
"description" : "The tax ID number.\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) 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.",
"description" : "The URL to be used for bank account verification.\nThis may be generated on bank account creation.\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.",
"type" : "string"
}
}
@@ -1962,7 +1962,7 @@
"type" : "array"
},
"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).",
"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 [our verification guide](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process#identify-ubos).",
"items" : {
"$ref" : "#/components/schemas/ShareholderContact"
},
@@ -3006,7 +3006,7 @@
"$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",
"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 Account Holder will fail with a validation Error..**\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"
},
"shareholderType" : {
@@ -3189,6 +3189,8 @@
"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",
"BalancePlatformSweep",
"BalancePlatfromSweepReturned",
"Chargeback",
"ChargebackCorrection",
"ChargebackCorrectionReceived",

60
json/MarketPayNotificationService-v4.json
View File

@@ -3,9 +3,9 @@
"info" : {
"version" : "4",
"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).",
"x-timestamp" : "2022-08-16T10:21:11Z",
"title" : "Classic Platforms - Notifications",
"description" : "This API is used for the classic integration. If you are just starting your implementation, refer to our [new integration guide](https://docs.adyen.com/marketplaces-and-platforms) instead.\n\nThe Notification API sends notifications to the endpoints specified in a given subscription. \nSubscriptions 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/marketplaces-and-platforms/classic/notifications).",
"x-timestamp" : "2022-09-27T19:26:20Z",
"termsOfService" : "https://www.adyen.com/legal/terms-and-conditions",
"contact" : {
"name" : "Adyen Developer Experience team",
@@ -775,7 +775,7 @@
"Other"
],
"summary" : "Booking for a capture or refund failed",
"description" : "Adyen sends this notification 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 or fromyour platform's liable account instead of the account specified in the split data.",
"description" : "Adyen sends this notification when a [split payment](https://docs.adyen.com/marketplaces-and-platforms/classic/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 or fromyour platform's liable account instead of the account specified in the split data.",
"operationId" : "post-PAYMENT_FAILURE",
"x-groupName" : "Other",
"x-sortIndex" : 1,
@@ -1106,7 +1106,7 @@
"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).",
"description" : "The event.\n>Permitted values: `InactivateAccount`, `RefundNotPaidOutTransfers`.\nFor more information, refer to [Verification checks](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process).",
"enum" : [
"InactivateAccount",
"RefundNotPaidOutTransfers"
@@ -1240,7 +1240,7 @@
"$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).",
"description" : "Array of bank accounts associated with the account holder. For details about the required `bankAccountDetail` fields, see [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information).",
"items" : {
"$ref" : "#/components/schemas/BankAccountDetail"
},
@@ -1843,11 +1843,11 @@
"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.",
"description" : "The bank account number (without separators).\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) 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.",
"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 [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.",
"type" : "string"
},
"bankAccountName" : {
@@ -1859,47 +1859,47 @@
"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.",
"description" : "The bank identifier code.\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) 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.",
"description" : "The city in which the bank branch is located.\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) 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.",
"description" : "The bank code of the banking institution with which the bank account is registered.\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) 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.",
"description" : "The name of the banking institution with which the bank account is held.\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) 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.",
"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 [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) 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.",
"description" : "The check code of the bank account.\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) 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.",
"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 [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) 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.",
"description" : "The currency in which the bank account deals.\n>The permitted currency codes are defined in ISO-4217 (e.g. 'EUR').\n",
"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.",
"description" : "The international bank account number.\n>The IBAN standard is defined in ISO-13616.\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) 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.",
"description" : "The city of residence of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) 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.",
"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 [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.",
"type" : "string"
},
"ownerDateOfBirth" : {
@@ -1908,27 +1908,27 @@
"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.",
"description" : "The house name or number of the residence of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) 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.",
"description" : "The name of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) 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.",
"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 [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) 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.",
"description" : "The postal code of the residence of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) 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.",
"description" : "The state of residence of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) 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.",
"description" : "The street name of the residence of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.",
"type" : "string"
},
"primaryAccount" : {
@@ -1936,11 +1936,11 @@
"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.",
"description" : "The tax ID number.\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) 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.",
"description" : "The URL to be used for bank account verification.\nThis may be generated on bank account creation.\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.",
"type" : "string"
}
}
@@ -2048,7 +2048,7 @@
"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).",
"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 [our verification guide](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process#identify-ubos).",
"items" : {
"$ref" : "#/components/schemas/ShareholderContact"
},
@@ -3146,7 +3146,7 @@
"$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",
"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 Account Holder will fail with a validation Error..**\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"
},
"shareholderType" : {
@@ -3329,6 +3329,8 @@
"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",
"BalancePlatformSweep",
"BalancePlatfromSweepReturned",
"Chargeback",
"ChargebackCorrection",
"ChargebackCorrectionReceived",

72
json/MarketPayNotificationService-v5.json
View File

@@ -3,9 +3,9 @@
"info" : {
"version" : "5",
"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).",
"x-timestamp" : "2022-08-16T10:21:11Z",
"title" : "Classic Platforms - Notifications",
"description" : "This API is used for the classic integration. If you are just starting your implementation, refer to our [new integration guide](https://docs.adyen.com/marketplaces-and-platforms) instead.\n\nThe Notification API sends notifications to the endpoints specified in a given subscription. \nSubscriptions 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/marketplaces-and-platforms/classic/notifications).",
"x-timestamp" : "2022-09-27T19:26:20Z",
"termsOfService" : "https://www.adyen.com/legal/terms-and-conditions",
"contact" : {
"name" : "Adyen Developer Experience team",
@@ -789,7 +789,7 @@
"Other"
],
"summary" : "Booking for a capture or refund failed",
"description" : "Adyen sends this notification 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 or fromyour platform's liable account instead of the account specified in the split data.",
"description" : "Adyen sends this notification when a [split payment](https://docs.adyen.com/marketplaces-and-platforms/classic/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 or fromyour platform's liable account instead of the account specified in the split data.",
"operationId" : "post-PAYMENT_FAILURE",
"x-groupName" : "Other",
"x-sortIndex" : 1,
@@ -1140,7 +1140,7 @@
"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).",
"description" : "The event.\n>Permitted values: `InactivateAccount`, `RefundNotPaidOutTransfers`.\nFor more information, refer to [Verification checks](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process).",
"enum" : [
"InactivateAccount",
"RefundNotPaidOutTransfers"
@@ -1284,7 +1284,7 @@
"$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).",
"description" : "Array of bank accounts associated with the account holder. For details about the required `bankAccountDetail` fields, see [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information).",
"items" : {
"$ref" : "#/components/schemas/BankAccountDetail"
},
@@ -1328,7 +1328,7 @@
},
"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).",
"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/marketplaces-and-platforms/classic/payout-to-cards).",
"items" : {
"$ref" : "#/components/schemas/PayoutMethod"
},
@@ -1340,7 +1340,7 @@
},
"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).",
"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/marketplaces-and-platforms/classic/platforms-for-pos).",
"items" : {
"$ref" : "#/components/schemas/StoreDetail"
},
@@ -2014,11 +2014,11 @@
"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.",
"description" : "The bank account number (without separators).\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) 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.",
"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 [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.",
"type" : "string"
},
"bankAccountName" : {
@@ -2035,47 +2035,47 @@
"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.",
"description" : "The bank identifier code.\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) 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.",
"description" : "The city in which the bank branch is located.\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) 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.",
"description" : "The bank code of the banking institution with which the bank account is registered.\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) 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.",
"description" : "The name of the banking institution with which the bank account is held.\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) 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.",
"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 [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) 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.",
"description" : "The check code of the bank account.\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) 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.",
"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 [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) 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.",
"description" : "The currency in which the bank account deals.\n>The permitted currency codes are defined in ISO-4217 (e.g. 'EUR').\n",
"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.",
"description" : "The international bank account number.\n>The IBAN standard is defined in ISO-13616.\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) 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.",
"description" : "The city of residence of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) 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.",
"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 [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.",
"type" : "string"
},
"ownerDateOfBirth" : {
@@ -2084,27 +2084,27 @@
"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.",
"description" : "The house name or number of the residence of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) 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.",
"description" : "The name of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) 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.",
"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 [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) 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.",
"description" : "The postal code of the residence of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) 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.",
"description" : "The state of residence of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) 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.",
"description" : "The street name of the residence of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.",
"type" : "string"
},
"primaryAccount" : {
@@ -2112,11 +2112,11 @@
"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.",
"description" : "The tax ID number.\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) 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.",
"description" : "The URL to be used for bank account verification.\nThis may be generated on bank account creation.\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.",
"type" : "string"
}
}
@@ -2231,7 +2231,7 @@
"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).",
"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 [our verification guide](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process#identify-ubos).",
"items" : {
"$ref" : "#/components/schemas/ShareholderContact"
},
@@ -2903,7 +2903,7 @@
"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).",
"description" : "The code of the check. For possible values, refer to [Verification codes](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/verification-codes).",
"format" : "int32",
"type" : "integer"
},
@@ -3118,7 +3118,7 @@
"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).",
"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/marketplaces-and-platforms/classic/payouts/manual-payout/payout-to-cards#check-and-store).",
"type" : "string"
},
"payoutMethodCode" : {
@@ -3130,11 +3130,11 @@
"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).",
"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/marketplaces-and-platforms/classic/payouts/manual-payout/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).",
"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/marketplaces-and-platforms/classic/payouts/manual-payout/payout-to-cards#check-and-store).",
"type" : "string"
}
},
@@ -3481,7 +3481,7 @@
"$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",
"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 Account Holder will fail with a validation Error..**\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" : {
@@ -3756,6 +3756,8 @@
"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",
"BalancePlatformSweep",
"BalancePlatfromSweepReturned",
"Chargeback",
"ChargebackCorrection",
"ChargebackCorrectionReceived",

80
json/MarketPayNotificationService-v6.json
View File

@@ -3,9 +3,9 @@
"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).",
"x-timestamp" : "2022-08-16T10:21:11Z",
"title" : "Classic Platforms - Notifications",
"description" : "This API is used for the classic integration. If you are just starting your implementation, refer to our [new integration guide](https://docs.adyen.com/marketplaces-and-platforms) instead.\n\nThe Notification API sends notifications to the endpoints specified in a given subscription. \nSubscriptions 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/marketplaces-and-platforms/classic/notifications).",
"x-timestamp" : "2022-10-06T13:26:47Z",
"termsOfService" : "https://www.adyen.com/legal/terms-and-conditions",
"contact" : {
"name" : "Adyen Developer Experience team",
@@ -789,7 +789,7 @@
"Other"
],
"summary" : "Booking for a capture or refund failed",
"description" : "Adyen sends this notification 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 or fromyour platform's liable account instead of the account specified in the split data.",
"description" : "Adyen sends this notification when a [split payment](https://docs.adyen.com/marketplaces-and-platforms/classic/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 or fromyour platform's liable account instead of the account specified in the split data.",
"operationId" : "post-PAYMENT_FAILURE",
"x-groupName" : "Other",
"x-sortIndex" : 1,
@@ -1140,7 +1140,7 @@
"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).",
"description" : "The event.\n>Permitted values: `InactivateAccount`, `RefundNotPaidOutTransfers`.\nFor more information, refer to [Verification checks](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process).",
"enum" : [
"InactivateAccount",
"RefundNotPaidOutTransfers"
@@ -1284,7 +1284,7 @@
"$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).",
"description" : "Array of bank accounts associated with the account holder. For details about the required `bankAccountDetail` fields, see [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information).",
"items" : {
"$ref" : "#/components/schemas/BankAccountDetail"
},
@@ -1317,7 +1317,7 @@
},
"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).",
"description" : "An array containing information about the account holder's [legal arrangements](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/legal-arrangements).",
"items" : {
"$ref" : "#/components/schemas/LegalArrangementDetail"
},
@@ -1336,7 +1336,7 @@
},
"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).",
"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/marketplaces-and-platforms/classic/payout-to-cards).",
"items" : {
"$ref" : "#/components/schemas/PayoutMethod"
},
@@ -1348,7 +1348,7 @@
},
"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).",
"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/marketplaces-and-platforms/classic/platforms-for-pos).",
"items" : {
"$ref" : "#/components/schemas/StoreDetail"
},
@@ -2060,11 +2060,11 @@
"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.",
"description" : "The bank account number (without separators).\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) 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.",
"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 [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.",
"type" : "string"
},
"bankAccountName" : {
@@ -2081,47 +2081,47 @@
"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.",
"description" : "The bank identifier code.\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) 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.",
"description" : "The city in which the bank branch is located.\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) 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.",
"description" : "The bank code of the banking institution with which the bank account is registered.\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) 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.",
"description" : "The name of the banking institution with which the bank account is held.\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) 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.",
"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 [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) 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.",
"description" : "The check code of the bank account.\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) 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.",
"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 [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) 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.",
"description" : "The currency in which the bank account deals.\n>The permitted currency codes are defined in ISO-4217 (e.g. 'EUR').\n",
"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.",
"description" : "The international bank account number.\n>The IBAN standard is defined in ISO-13616.\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) 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.",
"description" : "The city of residence of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) 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.",
"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 [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.",
"type" : "string"
},
"ownerDateOfBirth" : {
@@ -2130,27 +2130,27 @@
"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.",
"description" : "The house name or number of the residence of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) 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.",
"description" : "The name of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) 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.",
"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 [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) 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.",
"description" : "The postal code of the residence of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) 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.",
"description" : "The state of residence of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) 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.",
"description" : "The street name of the residence of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.",
"type" : "string"
},
"primaryAccount" : {
@@ -2158,11 +2158,11 @@
"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.",
"description" : "The tax ID number.\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) 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.",
"description" : "The URL to be used for bank account verification.\nThis may be generated on bank account creation.\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.",
"type" : "string"
}
}
@@ -2277,7 +2277,7 @@
"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).",
"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 [our verification guide](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process#identify-ubos).",
"items" : {
"$ref" : "#/components/schemas/ShareholderContact"
},
@@ -2941,7 +2941,7 @@
"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).",
"description" : "The code of the check. For possible values, refer to [Verification codes](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/verification-codes).",
"format" : "int32",
"type" : "integer"
},
@@ -3118,7 +3118,7 @@
"$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.",
"description" : "Adyen-generated unique alphanumeric identifier (UUID) for the entry, returned in the response when you create a legal arrangement.\nUse only when updating an account holder. If you include this field when creating an account holder, the request will fail.",
"type" : "string"
},
"legalArrangementEntities" : {
@@ -3169,7 +3169,7 @@
"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",
"description" : "The [type of legal arrangement](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/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",
@@ -3208,7 +3208,7 @@
"$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.",
"description" : "Adyen-generated unique alphanumeric identifier (UUID) for the entry, returned in the response when you create a legal arrangement entity.\nUse only when updating an account holder. If you include this field when creating an account holder, the request will fail.",
"type" : "string"
},
"legalArrangementEntityReference" : {
@@ -3392,7 +3392,7 @@
"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).",
"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/marketplaces-and-platforms/classic/payouts/manual-payout/payout-to-cards#check-and-store).",
"type" : "string"
},
"payoutMethodCode" : {
@@ -3404,11 +3404,11 @@
"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).",
"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/marketplaces-and-platforms/classic/payouts/manual-payout/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).",
"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/marketplaces-and-platforms/classic/payouts/manual-payout/payout-to-cards#check-and-store).",
"type" : "string"
}
},
@@ -3755,7 +3755,7 @@
"$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",
"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 Account Holder will fail with a validation Error..**\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" : {
@@ -4030,6 +4030,8 @@
"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",
"BalancePlatformSweep",
"BalancePlatfromSweepReturned",
"Chargeback",
"ChargebackCorrection",
"ChargebackCorrectionReceived",

16
json/NotificationConfigurationService-v1.json
View File

@@ -10,7 +10,7 @@
"x-publicVersion" : true,
"title" : "Notification Configuration API",
"description" : "This API is used for the classic integration. If you are just starting your implementation, refer to our [new integration guide](https://docs.adyen.com/marketplaces-and-platforms) instead.\n\nThe Notification Configuration API provides endpoints for setting up and testing notifications that inform you of events on your platform, for example when a verification check or a payout has been completed.\n\nFor more information, refer to our [documentation](https://docs.adyen.com/marketplaces-and-platforms/classic/notifications).\n## Authentication\nYour Adyen contact will provide your API credential and an API key. To connect to the API, add an `X-API-Key` header with the API key as the value, for example:\n\n ```\ncurl\n-H \"Content-Type: application/json\" \\\n-H \"X-API-Key: YOUR_API_KEY\" \\\n...\n```\n\nAlternatively, you can use the username and password to connect to the API using basic authentication. For example:\n\n```\ncurl\n-U \"ws@MarketPlace.YOUR_PLATFORM_ACCOUNT\":\"YOUR_WS_PASSWORD\" \\\n-H \"Content-Type: application/json\" \\\n...\n```\nWhen going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints).\n\n## Versioning\nThe Notification Configuration API supports [versioning](https://docs.adyen.com/development-resources/versioning) using 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/Notification/v1/createNotificationConfiguration\n```",
"x-timestamp" : "2022-07-28T16:19:58Z",
"x-timestamp" : "2022-10-03T13:24:04Z",
"termsOfService" : "https://www.adyen.com/legal/terms-and-conditions",
"contact" : {
"name" : "Adyen Developer Experience team",
@@ -818,15 +818,10 @@
"type" : "boolean"
},
"sslProtocol" : {
"description" : "The SSL protocol employed by the endpoint.\n>Permitted values: `SSL`, `SSLInsecureCiphers`, `TLS`, `TLSv10`, `TLSv10InsecureCiphers`, `TLSv11`, `TLSv12`.",
"description" : "The SSL protocol employed by the endpoint.\n>Permitted values: `TLSv12`, `TLSv13`.",
"enum" : [
"SSL",
"SSLInsecureCiphers",
"TLS",
"TLSv10",
"TLSv10InsecureCiphers",
"TLSv11",
"TLSv12"
"TLSv12",
"TLSv13"
],
"type" : "string"
}
@@ -846,6 +841,7 @@
"ACCOUNT_FUNDS_BELOW_THRESHOLD",
"ACCOUNT_HOLDER_CREATED",
"ACCOUNT_HOLDER_LIMIT_REACHED",
"ACCOUNT_HOLDER_MIGRATED",
"ACCOUNT_HOLDER_PAYOUT",
"ACCOUNT_HOLDER_STATUS_CHANGE",
"ACCOUNT_HOLDER_STORE_STATUS_CHANGE",
@@ -917,6 +913,7 @@
"ACCOUNT_FUNDS_BELOW_THRESHOLD",
"ACCOUNT_HOLDER_CREATED",
"ACCOUNT_HOLDER_LIMIT_REACHED",
"ACCOUNT_HOLDER_MIGRATED",
"ACCOUNT_HOLDER_PAYOUT",
"ACCOUNT_HOLDER_STATUS_CHANGE",
"ACCOUNT_HOLDER_STORE_STATUS_CHANGE",
@@ -968,6 +965,7 @@
"ACCOUNT_FUNDS_BELOW_THRESHOLD",
"ACCOUNT_HOLDER_CREATED",
"ACCOUNT_HOLDER_LIMIT_REACHED",
"ACCOUNT_HOLDER_MIGRATED",
"ACCOUNT_HOLDER_PAYOUT",
"ACCOUNT_HOLDER_STATUS_CHANGE",
"ACCOUNT_HOLDER_STORE_STATUS_CHANGE",

16
json/NotificationConfigurationService-v2.json
View File

@@ -10,7 +10,7 @@
"x-publicVersion" : true,
"title" : "Notification Configuration API",
"description" : "This API is used for the classic integration. If you are just starting your implementation, refer to our [new integration guide](https://docs.adyen.com/marketplaces-and-platforms) instead.\n\nThe Notification Configuration API provides endpoints for setting up and testing notifications that inform you of events on your platform, for example when a verification check or a payout has been completed.\n\nFor more information, refer to our [documentation](https://docs.adyen.com/marketplaces-and-platforms/classic/notifications).\n## Authentication\nYour Adyen contact will provide your API credential and an API key. To connect to the API, add an `X-API-Key` header with the API key as the value, for example:\n\n ```\ncurl\n-H \"Content-Type: application/json\" \\\n-H \"X-API-Key: YOUR_API_KEY\" \\\n...\n```\n\nAlternatively, you can use the username and password to connect to the API using basic authentication. For example:\n\n```\ncurl\n-U \"ws@MarketPlace.YOUR_PLATFORM_ACCOUNT\":\"YOUR_WS_PASSWORD\" \\\n-H \"Content-Type: application/json\" \\\n...\n```\nWhen going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints).\n\n## Versioning\nThe Notification Configuration API supports [versioning](https://docs.adyen.com/development-resources/versioning) using 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/Notification/v2/createNotificationConfiguration\n```",
"x-timestamp" : "2022-07-28T16:19:58Z",
"x-timestamp" : "2022-10-03T13:24:04Z",
"termsOfService" : "https://www.adyen.com/legal/terms-and-conditions",
"contact" : {
"name" : "Adyen Developer Experience team",
@@ -818,15 +818,10 @@
"type" : "boolean"
},
"sslProtocol" : {
"description" : "The SSL protocol employed by the endpoint.\n>Permitted values: `SSL`, `SSLInsecureCiphers`, `TLS`, `TLSv10`, `TLSv10InsecureCiphers`, `TLSv11`, `TLSv12`.",
"description" : "The SSL protocol employed by the endpoint.\n>Permitted values: `TLSv12`, `TLSv13`.",
"enum" : [
"SSL",
"SSLInsecureCiphers",
"TLS",
"TLSv10",
"TLSv10InsecureCiphers",
"TLSv11",
"TLSv12"
"TLSv12",
"TLSv13"
],
"type" : "string"
}
@@ -846,6 +841,7 @@
"ACCOUNT_FUNDS_BELOW_THRESHOLD",
"ACCOUNT_HOLDER_CREATED",
"ACCOUNT_HOLDER_LIMIT_REACHED",
"ACCOUNT_HOLDER_MIGRATED",
"ACCOUNT_HOLDER_PAYOUT",
"ACCOUNT_HOLDER_STATUS_CHANGE",
"ACCOUNT_HOLDER_STORE_STATUS_CHANGE",
@@ -917,6 +913,7 @@
"ACCOUNT_FUNDS_BELOW_THRESHOLD",
"ACCOUNT_HOLDER_CREATED",
"ACCOUNT_HOLDER_LIMIT_REACHED",
"ACCOUNT_HOLDER_MIGRATED",
"ACCOUNT_HOLDER_PAYOUT",
"ACCOUNT_HOLDER_STATUS_CHANGE",
"ACCOUNT_HOLDER_STORE_STATUS_CHANGE",
@@ -968,6 +965,7 @@
"ACCOUNT_FUNDS_BELOW_THRESHOLD",
"ACCOUNT_HOLDER_CREATED",
"ACCOUNT_HOLDER_LIMIT_REACHED",
"ACCOUNT_HOLDER_MIGRATED",
"ACCOUNT_HOLDER_PAYOUT",
"ACCOUNT_HOLDER_STATUS_CHANGE",
"ACCOUNT_HOLDER_STORE_STATUS_CHANGE",

16
json/NotificationConfigurationService-v3.json
View File

@@ -10,7 +10,7 @@
"x-publicVersion" : true,
"title" : "Notification Configuration API",
"description" : "This API is used for the classic integration. If you are just starting your implementation, refer to our [new integration guide](https://docs.adyen.com/marketplaces-and-platforms) instead.\n\nThe Notification Configuration API provides endpoints for setting up and testing notifications that inform you of events on your platform, for example when a verification check or a payout has been completed.\n\nFor more information, refer to our [documentation](https://docs.adyen.com/marketplaces-and-platforms/classic/notifications).\n## Authentication\nYour Adyen contact will provide your API credential and an API key. To connect to the API, add an `X-API-Key` header with the API key as the value, for example:\n\n ```\ncurl\n-H \"Content-Type: application/json\" \\\n-H \"X-API-Key: YOUR_API_KEY\" \\\n...\n```\n\nAlternatively, you can use the username and password to connect to the API using basic authentication. For example:\n\n```\ncurl\n-U \"ws@MarketPlace.YOUR_PLATFORM_ACCOUNT\":\"YOUR_WS_PASSWORD\" \\\n-H \"Content-Type: application/json\" \\\n...\n```\nWhen going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints).\n\n## Versioning\nThe Notification Configuration API supports [versioning](https://docs.adyen.com/development-resources/versioning) using 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/Notification/v3/createNotificationConfiguration\n```",
"x-timestamp" : "2022-07-28T16:19:58Z",
"x-timestamp" : "2022-10-03T13:24:04Z",
"termsOfService" : "https://www.adyen.com/legal/terms-and-conditions",
"contact" : {
"name" : "Adyen Developer Experience team",
@@ -818,15 +818,10 @@
"type" : "boolean"
},
"sslProtocol" : {
"description" : "The SSL protocol employed by the endpoint.\n>Permitted values: `SSL`, `SSLInsecureCiphers`, `TLS`, `TLSv10`, `TLSv10InsecureCiphers`, `TLSv11`, `TLSv12`.",
"description" : "The SSL protocol employed by the endpoint.\n>Permitted values: `TLSv12`, `TLSv13`.",
"enum" : [
"SSL",
"SSLInsecureCiphers",
"TLS",
"TLSv10",
"TLSv10InsecureCiphers",
"TLSv11",
"TLSv12"
"TLSv12",
"TLSv13"
],
"type" : "string"
}
@@ -846,6 +841,7 @@
"ACCOUNT_FUNDS_BELOW_THRESHOLD",
"ACCOUNT_HOLDER_CREATED",
"ACCOUNT_HOLDER_LIMIT_REACHED",
"ACCOUNT_HOLDER_MIGRATED",
"ACCOUNT_HOLDER_PAYOUT",
"ACCOUNT_HOLDER_STATUS_CHANGE",
"ACCOUNT_HOLDER_STORE_STATUS_CHANGE",
@@ -917,6 +913,7 @@
"ACCOUNT_FUNDS_BELOW_THRESHOLD",
"ACCOUNT_HOLDER_CREATED",
"ACCOUNT_HOLDER_LIMIT_REACHED",
"ACCOUNT_HOLDER_MIGRATED",
"ACCOUNT_HOLDER_PAYOUT",
"ACCOUNT_HOLDER_STATUS_CHANGE",
"ACCOUNT_HOLDER_STORE_STATUS_CHANGE",
@@ -968,6 +965,7 @@
"ACCOUNT_FUNDS_BELOW_THRESHOLD",
"ACCOUNT_HOLDER_CREATED",
"ACCOUNT_HOLDER_LIMIT_REACHED",
"ACCOUNT_HOLDER_MIGRATED",
"ACCOUNT_HOLDER_PAYOUT",
"ACCOUNT_HOLDER_STATUS_CHANGE",
"ACCOUNT_HOLDER_STORE_STATUS_CHANGE",

16
json/NotificationConfigurationService-v4.json
View File

@@ -10,7 +10,7 @@
"x-publicVersion" : true,
"title" : "Notification Configuration API",
"description" : "This API is used for the classic integration. If you are just starting your implementation, refer to our [new integration guide](https://docs.adyen.com/marketplaces-and-platforms) instead.\n\nThe Notification Configuration API provides endpoints for setting up and testing notifications that inform you of events on your platform, for example when a verification check or a payout has been completed.\n\nFor more information, refer to our [documentation](https://docs.adyen.com/marketplaces-and-platforms/classic/notifications).\n## Authentication\nYour Adyen contact will provide your API credential and an API key. To connect to the API, add an `X-API-Key` header with the API key as the value, for example:\n\n ```\ncurl\n-H \"Content-Type: application/json\" \\\n-H \"X-API-Key: YOUR_API_KEY\" \\\n...\n```\n\nAlternatively, you can use the username and password to connect to the API using basic authentication. For example:\n\n```\ncurl\n-U \"ws@MarketPlace.YOUR_PLATFORM_ACCOUNT\":\"YOUR_WS_PASSWORD\" \\\n-H \"Content-Type: application/json\" \\\n...\n```\nWhen going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints).\n\n## Versioning\nThe Notification Configuration API supports [versioning](https://docs.adyen.com/development-resources/versioning) using 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/Notification/v4/createNotificationConfiguration\n```",
"x-timestamp" : "2022-07-28T16:19:58Z",
"x-timestamp" : "2022-10-03T13:24:04Z",
"termsOfService" : "https://www.adyen.com/legal/terms-and-conditions",
"contact" : {
"name" : "Adyen Developer Experience team",
@@ -818,15 +818,10 @@
"type" : "boolean"
},
"sslProtocol" : {
"description" : "The SSL protocol employed by the endpoint.\n>Permitted values: `SSL`, `SSLInsecureCiphers`, `TLS`, `TLSv10`, `TLSv10InsecureCiphers`, `TLSv11`, `TLSv12`.",
"description" : "The SSL protocol employed by the endpoint.\n>Permitted values: `TLSv12`, `TLSv13`.",
"enum" : [
"SSL",
"SSLInsecureCiphers",
"TLS",
"TLSv10",
"TLSv10InsecureCiphers",
"TLSv11",
"TLSv12"
"TLSv12",
"TLSv13"
],
"type" : "string"
}
@@ -846,6 +841,7 @@
"ACCOUNT_FUNDS_BELOW_THRESHOLD",
"ACCOUNT_HOLDER_CREATED",
"ACCOUNT_HOLDER_LIMIT_REACHED",
"ACCOUNT_HOLDER_MIGRATED",
"ACCOUNT_HOLDER_PAYOUT",
"ACCOUNT_HOLDER_STATUS_CHANGE",
"ACCOUNT_HOLDER_STORE_STATUS_CHANGE",
@@ -917,6 +913,7 @@
"ACCOUNT_FUNDS_BELOW_THRESHOLD",
"ACCOUNT_HOLDER_CREATED",
"ACCOUNT_HOLDER_LIMIT_REACHED",
"ACCOUNT_HOLDER_MIGRATED",
"ACCOUNT_HOLDER_PAYOUT",
"ACCOUNT_HOLDER_STATUS_CHANGE",
"ACCOUNT_HOLDER_STORE_STATUS_CHANGE",
@@ -968,6 +965,7 @@
"ACCOUNT_FUNDS_BELOW_THRESHOLD",
"ACCOUNT_HOLDER_CREATED",
"ACCOUNT_HOLDER_LIMIT_REACHED",
"ACCOUNT_HOLDER_MIGRATED",
"ACCOUNT_HOLDER_PAYOUT",
"ACCOUNT_HOLDER_STATUS_CHANGE",
"ACCOUNT_HOLDER_STORE_STATUS_CHANGE",

16
json/NotificationConfigurationService-v5.json
View File

@@ -10,7 +10,7 @@
"x-publicVersion" : true,
"title" : "Notification Configuration API",
"description" : "This API is used for the classic integration. If you are just starting your implementation, refer to our [new integration guide](https://docs.adyen.com/marketplaces-and-platforms) instead.\n\nThe Notification Configuration API provides endpoints for setting up and testing notifications that inform you of events on your platform, for example when a verification check or a payout has been completed.\n\nFor more information, refer to our [documentation](https://docs.adyen.com/marketplaces-and-platforms/classic/notifications).\n## Authentication\nYour Adyen contact will provide your API credential and an API key. To connect to the API, add an `X-API-Key` header with the API key as the value, for example:\n\n ```\ncurl\n-H \"Content-Type: application/json\" \\\n-H \"X-API-Key: YOUR_API_KEY\" \\\n...\n```\n\nAlternatively, you can use the username and password to connect to the API using basic authentication. For example:\n\n```\ncurl\n-U \"ws@MarketPlace.YOUR_PLATFORM_ACCOUNT\":\"YOUR_WS_PASSWORD\" \\\n-H \"Content-Type: application/json\" \\\n...\n```\nWhen going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints).\n\n## Versioning\nThe Notification Configuration API supports [versioning](https://docs.adyen.com/development-resources/versioning) using 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/Notification/v5/createNotificationConfiguration\n```",
"x-timestamp" : "2022-07-28T16:19:58Z",
"x-timestamp" : "2022-10-03T13:24:04Z",
"termsOfService" : "https://www.adyen.com/legal/terms-and-conditions",
"contact" : {
"name" : "Adyen Developer Experience team",
@@ -1015,15 +1015,10 @@
"type" : "string"
},
"sslProtocol" : {
"description" : "The SSL protocol employed by the endpoint.\n>Permitted values: `SSL`, `SSLInsecureCiphers`, `TLS`, `TLSv10`, `TLSv10InsecureCiphers`, `TLSv11`, `TLSv12`.",
"description" : "The SSL protocol employed by the endpoint.\n>Permitted values: `TLSv12`, `TLSv13`.",
"enum" : [
"SSL",
"SSLInsecureCiphers",
"TLS",
"TLSv10",
"TLSv10InsecureCiphers",
"TLSv11",
"TLSv12"
"TLSv12",
"TLSv13"
],
"type" : "string"
}
@@ -1043,6 +1038,7 @@
"ACCOUNT_FUNDS_BELOW_THRESHOLD",
"ACCOUNT_HOLDER_CREATED",
"ACCOUNT_HOLDER_LIMIT_REACHED",
"ACCOUNT_HOLDER_MIGRATED",
"ACCOUNT_HOLDER_PAYOUT",
"ACCOUNT_HOLDER_STATUS_CHANGE",
"ACCOUNT_HOLDER_STORE_STATUS_CHANGE",
@@ -1114,6 +1110,7 @@
"ACCOUNT_FUNDS_BELOW_THRESHOLD",
"ACCOUNT_HOLDER_CREATED",
"ACCOUNT_HOLDER_LIMIT_REACHED",
"ACCOUNT_HOLDER_MIGRATED",
"ACCOUNT_HOLDER_PAYOUT",
"ACCOUNT_HOLDER_STATUS_CHANGE",
"ACCOUNT_HOLDER_STORE_STATUS_CHANGE",
@@ -1165,6 +1162,7 @@
"ACCOUNT_FUNDS_BELOW_THRESHOLD",
"ACCOUNT_HOLDER_CREATED",
"ACCOUNT_HOLDER_LIMIT_REACHED",
"ACCOUNT_HOLDER_MIGRATED",
"ACCOUNT_HOLDER_PAYOUT",
"ACCOUNT_HOLDER_STATUS_CHANGE",
"ACCOUNT_HOLDER_STORE_STATUS_CHANGE",

16
json/NotificationConfigurationService-v6.json
View File

@@ -10,7 +10,7 @@
"x-publicVersion" : true,
"title" : "Notification Configuration API",
"description" : "This API is used for the classic integration. If you are just starting your implementation, refer to our [new integration guide](https://docs.adyen.com/marketplaces-and-platforms) instead.\n\nThe Notification Configuration API provides endpoints for setting up and testing notifications that inform you of events on your platform, for example when a verification check or a payout has been completed.\n\nFor more information, refer to our [documentation](https://docs.adyen.com/marketplaces-and-platforms/classic/notifications).\n## Authentication\nYour Adyen contact will provide your API credential and an API key. To connect to the API, add an `X-API-Key` header with the API key as the value, for example:\n\n ```\ncurl\n-H \"Content-Type: application/json\" \\\n-H \"X-API-Key: YOUR_API_KEY\" \\\n...\n```\n\nAlternatively, you can use the username and password to connect to the API using basic authentication. For example:\n\n```\ncurl\n-U \"ws@MarketPlace.YOUR_PLATFORM_ACCOUNT\":\"YOUR_WS_PASSWORD\" \\\n-H \"Content-Type: application/json\" \\\n...\n```\nWhen going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints).\n\n## Versioning\nThe Notification Configuration API supports [versioning](https://docs.adyen.com/development-resources/versioning) using 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/Notification/v6/createNotificationConfiguration\n```",
"x-timestamp" : "2022-07-28T16:19:58Z",
"x-timestamp" : "2022-10-03T13:24:04Z",
"termsOfService" : "https://www.adyen.com/legal/terms-and-conditions",
"contact" : {
"name" : "Adyen Developer Experience team",
@@ -1015,15 +1015,10 @@
"type" : "string"
},
"sslProtocol" : {
"description" : "The SSL protocol employed by the endpoint.\n>Permitted values: `SSL`, `SSLInsecureCiphers`, `TLS`, `TLSv10`, `TLSv10InsecureCiphers`, `TLSv11`, `TLSv12`.",
"description" : "The SSL protocol employed by the endpoint.\n>Permitted values: `TLSv12`, `TLSv13`.",
"enum" : [
"SSL",
"SSLInsecureCiphers",
"TLS",
"TLSv10",
"TLSv10InsecureCiphers",
"TLSv11",
"TLSv12"
"TLSv12",
"TLSv13"
],
"type" : "string"
}
@@ -1043,6 +1038,7 @@
"ACCOUNT_FUNDS_BELOW_THRESHOLD",
"ACCOUNT_HOLDER_CREATED",
"ACCOUNT_HOLDER_LIMIT_REACHED",
"ACCOUNT_HOLDER_MIGRATED",
"ACCOUNT_HOLDER_PAYOUT",
"ACCOUNT_HOLDER_STATUS_CHANGE",
"ACCOUNT_HOLDER_STORE_STATUS_CHANGE",
@@ -1114,6 +1110,7 @@
"ACCOUNT_FUNDS_BELOW_THRESHOLD",
"ACCOUNT_HOLDER_CREATED",
"ACCOUNT_HOLDER_LIMIT_REACHED",
"ACCOUNT_HOLDER_MIGRATED",
"ACCOUNT_HOLDER_PAYOUT",
"ACCOUNT_HOLDER_STATUS_CHANGE",
"ACCOUNT_HOLDER_STORE_STATUS_CHANGE",
@@ -1165,6 +1162,7 @@
"ACCOUNT_FUNDS_BELOW_THRESHOLD",
"ACCOUNT_HOLDER_CREATED",
"ACCOUNT_HOLDER_LIMIT_REACHED",
"ACCOUNT_HOLDER_MIGRATED",
"ACCOUNT_HOLDER_PAYOUT",
"ACCOUNT_HOLDER_STATUS_CHANGE",
"ACCOUNT_HOLDER_STORE_STATUS_CHANGE",

97
yaml/AccountService-v3.yaml
View File

@@ -24,7 +24,7 @@ info:
\ using 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\
```"
x-timestamp: '2022-08-29T12:22:33Z'
x-timestamp: '2022-09-23T17:24:11Z'
termsOfService: https://www.adyen.com/legal/terms-and-conditions
contact:
name: Adyen Developer Experience team
@@ -1304,7 +1304,7 @@ components:
>Permitted values: `InactivateAccount`, `RefundNotPaidOutTransfers`.
For more information, refer to [Verification checks](https://docs.adyen.com/platforms/verification-checks).'
For more information, refer to [Verification checks](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process).'
enum:
- InactivateAccount
- RefundNotPaidOutTransfers
@@ -1327,8 +1327,8 @@ components:
$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).
For details about the required `bankAccountDetail` fields, see [Required
information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information).
items:
$ref: '#/components/schemas/BankAccountDetail'
type: array
@@ -1490,8 +1490,8 @@ components:
accountNumber:
description: 'The bank account number (without separators).
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
accountType:
description: 'The type of bank account.
@@ -1501,8 +1501,8 @@ components:
The permitted values are: `checking`, `savings`.
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
bankAccountName:
description: The name of the bank account.
@@ -1534,31 +1534,31 @@ components:
bankBicSwift:
description: 'The bank identifier code.
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
bankCity:
description: 'The city in which the bank branch is located.
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
bankCode:
description: 'The bank code of the banking institution with which the bank
account is registered.
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
bankName:
description: 'The name of the banking institution with which the bank account
is held.
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
branchCode:
description: 'The branch code of the branch under which the bank account
@@ -1571,15 +1571,15 @@ components:
* Germany - Bankleitzahl
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
checkCode:
description: 'The check code of the bank account.
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
countryCode:
description: 'The two-letter country code in which the bank account is registered.
@@ -1587,17 +1587,15 @@ components:
>The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. ''NL'').
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
currencyCode:
description: 'The currency in which the bank account deals.
>The permitted currency codes are defined in ISO-4217 (e.g. ''EUR'').
>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.
@@ -1605,14 +1603,14 @@ components:
>The IBAN standard is defined in ISO-13616.
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
ownerCity:
description: 'The city of residence of the bank account owner.
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
ownerCountryCode:
description: 'The country code of the country of residence of the bank account
@@ -1621,8 +1619,8 @@ components:
>The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. ''NL'').
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
ownerDateOfBirth:
deprecated: true
@@ -1634,14 +1632,14 @@ components:
description: 'The house name or number of the residence of the bank account
owner.
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
ownerName:
description: 'The name of the bank account owner.
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
ownerNationality:
description: 'The country code of the country of nationality of the bank
@@ -1650,26 +1648,26 @@ components:
>The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. ''NL'').
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
ownerPostalCode:
description: 'The postal code of the residence of the bank account owner.
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
ownerState:
description: 'The state of residence of the bank account owner.
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
ownerStreet:
description: 'The street name of the residence of the bank account owner.
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
primaryAccount:
description: If set to true, the bank account is a primary account.
@@ -1678,8 +1676,8 @@ components:
description: 'The tax ID number.
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
urlForVerification:
description: 'The URL to be used for bank account verification.
@@ -1687,8 +1685,8 @@ components:
This may be generated on bank account creation.
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
BusinessDetails:
properties:
@@ -1708,7 +1706,7 @@ components:
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).
how you can identify them, refer to [our verification guide](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process#identify-ubos).
items:
$ref: '#/components/schemas/ShareholderContact'
type: array
@@ -2743,8 +2741,7 @@ components:
>**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.**
creation of Account Holder will fail with a validation Error..**
>**If, during an Account Holder update request, a UUID that is not correlated

97
yaml/AccountService-v4.yaml
View File

@@ -24,7 +24,7 @@ info:
\ using 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\
```"
x-timestamp: '2022-08-29T12:22:33Z'
x-timestamp: '2022-09-23T17:24:11Z'
termsOfService: https://www.adyen.com/legal/terms-and-conditions
contact:
name: Adyen Developer Experience team
@@ -1297,7 +1297,7 @@ components:
>Permitted values: `InactivateAccount`, `RefundNotPaidOutTransfers`.
For more information, refer to [Verification checks](https://docs.adyen.com/platforms/verification-checks).'
For more information, refer to [Verification checks](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process).'
enum:
- InactivateAccount
- RefundNotPaidOutTransfers
@@ -1320,8 +1320,8 @@ components:
$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).
For details about the required `bankAccountDetail` fields, see [Required
information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information).
items:
$ref: '#/components/schemas/BankAccountDetail'
type: array
@@ -1483,8 +1483,8 @@ components:
accountNumber:
description: 'The bank account number (without separators).
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
accountType:
description: 'The type of bank account.
@@ -1494,8 +1494,8 @@ components:
The permitted values are: `checking`, `savings`.
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
bankAccountName:
description: The name of the bank account.
@@ -1527,31 +1527,31 @@ components:
bankBicSwift:
description: 'The bank identifier code.
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
bankCity:
description: 'The city in which the bank branch is located.
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
bankCode:
description: 'The bank code of the banking institution with which the bank
account is registered.
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
bankName:
description: 'The name of the banking institution with which the bank account
is held.
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
branchCode:
description: 'The branch code of the branch under which the bank account
@@ -1564,15 +1564,15 @@ components:
* Germany - Bankleitzahl
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
checkCode:
description: 'The check code of the bank account.
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
countryCode:
description: 'The two-letter country code in which the bank account is registered.
@@ -1580,17 +1580,15 @@ components:
>The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. ''NL'').
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
currencyCode:
description: 'The currency in which the bank account deals.
>The permitted currency codes are defined in ISO-4217 (e.g. ''EUR'').
>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.
@@ -1598,14 +1596,14 @@ components:
>The IBAN standard is defined in ISO-13616.
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
ownerCity:
description: 'The city of residence of the bank account owner.
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
ownerCountryCode:
description: 'The country code of the country of residence of the bank account
@@ -1614,8 +1612,8 @@ components:
>The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. ''NL'').
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
ownerDateOfBirth:
deprecated: true
@@ -1627,14 +1625,14 @@ components:
description: 'The house name or number of the residence of the bank account
owner.
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
ownerName:
description: 'The name of the bank account owner.
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
ownerNationality:
description: 'The country code of the country of nationality of the bank
@@ -1643,26 +1641,26 @@ components:
>The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. ''NL'').
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
ownerPostalCode:
description: 'The postal code of the residence of the bank account owner.
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
ownerState:
description: 'The state of residence of the bank account owner.
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
ownerStreet:
description: 'The street name of the residence of the bank account owner.
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
primaryAccount:
description: If set to true, the bank account is a primary account.
@@ -1671,8 +1669,8 @@ components:
description: 'The tax ID number.
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
urlForVerification:
description: 'The URL to be used for bank account verification.
@@ -1680,8 +1678,8 @@ components:
This may be generated on bank account creation.
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
BusinessDetails:
properties:
@@ -1705,7 +1703,7 @@ components:
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).
how you can identify them, refer to [our verification guide](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process#identify-ubos).
items:
$ref: '#/components/schemas/ShareholderContact'
type: array
@@ -2792,8 +2790,7 @@ components:
>**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.**
creation of Account Holder will fail with a validation Error..**
>**If, during an Account Holder update request, a UUID that is not correlated

109
yaml/AccountService-v5.yaml
View File

@@ -24,7 +24,7 @@ info:
\ using 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/v5/createAccountHolder\n\
```"
x-timestamp: '2022-08-29T12:22:33Z'
x-timestamp: '2022-09-23T17:24:11Z'
termsOfService: https://www.adyen.com/legal/terms-and-conditions
contact:
name: Adyen Developer Experience team
@@ -1536,7 +1536,7 @@ components:
>Permitted values: `InactivateAccount`, `RefundNotPaidOutTransfers`.
For more information, refer to [Verification checks](https://docs.adyen.com/platforms/verification-checks).'
For more information, refer to [Verification checks](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process).'
enum:
- InactivateAccount
- RefundNotPaidOutTransfers
@@ -1559,8 +1559,8 @@ components:
$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).
For details about the required `bankAccountDetail` fields, see [Required
information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information).
items:
$ref: '#/components/schemas/BankAccountDetail'
type: array
@@ -1620,7 +1620,7 @@ components:
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).
to [Pay out to cards](https://docs.adyen.com/marketplaces-and-platforms/classic/payout-to-cards).
items:
$ref: '#/components/schemas/PayoutMethod'
type: array
@@ -1630,7 +1630,7 @@ components:
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).
when onboarding account holders that have an Adyen [point of sale](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-pos).
items:
$ref: '#/components/schemas/StoreDetail'
type: array
@@ -1749,8 +1749,8 @@ components:
accountNumber:
description: 'The bank account number (without separators).
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
accountType:
description: 'The type of bank account.
@@ -1760,8 +1760,8 @@ components:
The permitted values are: `checking`, `savings`.
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
bankAccountName:
description: The name of the bank account.
@@ -1797,31 +1797,31 @@ components:
bankBicSwift:
description: 'The bank identifier code.
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
bankCity:
description: 'The city in which the bank branch is located.
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
bankCode:
description: 'The bank code of the banking institution with which the bank
account is registered.
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
bankName:
description: 'The name of the banking institution with which the bank account
is held.
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
branchCode:
description: 'The branch code of the branch under which the bank account
@@ -1834,15 +1834,15 @@ components:
* Germany - Bankleitzahl
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
checkCode:
description: 'The check code of the bank account.
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
countryCode:
description: 'The two-letter country code in which the bank account is registered.
@@ -1850,17 +1850,15 @@ components:
>The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. ''NL'').
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
currencyCode:
description: 'The currency in which the bank account deals.
>The permitted currency codes are defined in ISO-4217 (e.g. ''EUR'').
>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.
@@ -1868,14 +1866,14 @@ components:
>The IBAN standard is defined in ISO-13616.
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
ownerCity:
description: 'The city of residence of the bank account owner.
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
ownerCountryCode:
description: 'The country code of the country of residence of the bank account
@@ -1884,8 +1882,8 @@ components:
>The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. ''NL'').
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
ownerDateOfBirth:
deprecated: true
@@ -1897,14 +1895,14 @@ components:
description: 'The house name or number of the residence of the bank account
owner.
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
ownerName:
description: 'The name of the bank account owner.
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
ownerNationality:
description: 'The country code of the country of nationality of the bank
@@ -1913,26 +1911,26 @@ components:
>The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. ''NL'').
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
ownerPostalCode:
description: 'The postal code of the residence of the bank account owner.
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
ownerState:
description: 'The state of residence of the bank account owner.
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
ownerStreet:
description: 'The street name of the residence of the bank account owner.
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
primaryAccount:
description: If set to true, the bank account is a primary account.
@@ -1941,8 +1939,8 @@ components:
description: 'The tax ID number.
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
urlForVerification:
description: 'The URL to be used for bank account verification.
@@ -1950,8 +1948,8 @@ components:
This may be generated on bank account creation.
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
BusinessDetails:
properties:
@@ -1975,7 +1973,7 @@ components:
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).
how you can identify them, refer to [our verification guide](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process#identify-ubos).
items:
$ref: '#/components/schemas/ShareholderContact'
type: array
@@ -2959,7 +2957,7 @@ components:
kycCheckCode:
x-addedInVersion: '5'
description: The code of the check. For possible values, refer to [Verification
codes](https://docs.adyen.com/platforms/verification-codes).
codes](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/verification-codes).
format: int32
type: integer
kycCheckDescription:
@@ -3030,7 +3028,7 @@ components:
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).
card details](https://docs.adyen.com/marketplaces-and-platforms/classic/payouts/manual-payout/payout-to-cards#check-and-store).
type: string
payoutMethodCode:
description: Adyen-generated unique alphanumeric identifier (UUID) for the
@@ -3044,12 +3042,12 @@ components:
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).
details](https://docs.adyen.com/marketplaces-and-platforms/classic/payouts/manual-payout/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).
card details](https://docs.adyen.com/marketplaces-and-platforms/classic/payouts/manual-payout/payout-to-cards#check-and-store).
type: string
required:
- merchantAccount
@@ -3201,8 +3199,7 @@ components:
>**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.**
creation of Account Holder will fail with a validation Error..**
>**If, during an Account Holder update request, a UUID that is not correlated

132
yaml/AccountService-v6.yaml
View File

@@ -24,7 +24,7 @@ info:
\ using 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/v6/createAccountHolder\n\
```"
x-timestamp: '2022-08-29T12:22:33Z'
x-timestamp: '2022-10-06T13:26:47Z'
termsOfService: https://www.adyen.com/legal/terms-and-conditions
contact:
name: Adyen Developer Experience team
@@ -1536,7 +1536,7 @@ components:
>Permitted values: `InactivateAccount`, `RefundNotPaidOutTransfers`.
For more information, refer to [Verification checks](https://docs.adyen.com/platforms/verification-checks).'
For more information, refer to [Verification checks](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process).'
enum:
- InactivateAccount
- RefundNotPaidOutTransfers
@@ -1559,8 +1559,8 @@ components:
$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).
For details about the required `bankAccountDetail` fields, see [Required
information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information).
items:
$ref: '#/components/schemas/BankAccountDetail'
type: array
@@ -1598,7 +1598,7 @@ components:
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).
[legal arrangements](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/legal-arrangements).
items:
$ref: '#/components/schemas/LegalArrangementDetail'
type: array
@@ -1627,7 +1627,7 @@ components:
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).
to [Pay out to cards](https://docs.adyen.com/marketplaces-and-platforms/classic/payout-to-cards).
items:
$ref: '#/components/schemas/PayoutMethod'
type: array
@@ -1637,7 +1637,7 @@ components:
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).
when onboarding account holders that have an Adyen [point of sale](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-pos).
items:
$ref: '#/components/schemas/StoreDetail'
type: array
@@ -1756,8 +1756,8 @@ components:
accountNumber:
description: 'The bank account number (without separators).
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
accountType:
description: 'The type of bank account.
@@ -1767,8 +1767,8 @@ components:
The permitted values are: `checking`, `savings`.
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
bankAccountName:
description: The name of the bank account.
@@ -1804,31 +1804,31 @@ components:
bankBicSwift:
description: 'The bank identifier code.
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
bankCity:
description: 'The city in which the bank branch is located.
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
bankCode:
description: 'The bank code of the banking institution with which the bank
account is registered.
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
bankName:
description: 'The name of the banking institution with which the bank account
is held.
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
branchCode:
description: 'The branch code of the branch under which the bank account
@@ -1841,15 +1841,15 @@ components:
* Germany - Bankleitzahl
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
checkCode:
description: 'The check code of the bank account.
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
countryCode:
description: 'The two-letter country code in which the bank account is registered.
@@ -1857,17 +1857,15 @@ components:
>The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. ''NL'').
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
currencyCode:
description: 'The currency in which the bank account deals.
>The permitted currency codes are defined in ISO-4217 (e.g. ''EUR'').
>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.
@@ -1875,14 +1873,14 @@ components:
>The IBAN standard is defined in ISO-13616.
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
ownerCity:
description: 'The city of residence of the bank account owner.
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
ownerCountryCode:
description: 'The country code of the country of residence of the bank account
@@ -1891,8 +1889,8 @@ components:
>The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. ''NL'').
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
ownerDateOfBirth:
deprecated: true
@@ -1904,14 +1902,14 @@ components:
description: 'The house name or number of the residence of the bank account
owner.
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
ownerName:
description: 'The name of the bank account owner.
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
ownerNationality:
description: 'The country code of the country of nationality of the bank
@@ -1920,26 +1918,26 @@ components:
>The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. ''NL'').
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
ownerPostalCode:
description: 'The postal code of the residence of the bank account owner.
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
ownerState:
description: 'The state of residence of the bank account owner.
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
ownerStreet:
description: 'The street name of the residence of the bank account owner.
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
primaryAccount:
description: If set to true, the bank account is a primary account.
@@ -1948,8 +1946,8 @@ components:
description: 'The tax ID number.
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
urlForVerification:
description: 'The URL to be used for bank account verification.
@@ -1957,8 +1955,8 @@ components:
This may be generated on bank account creation.
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
BusinessDetails:
properties:
@@ -1982,7 +1980,7 @@ components:
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).
how you can identify them, refer to [our verification guide](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process#identify-ubos).
items:
$ref: '#/components/schemas/ShareholderContact'
type: array
@@ -2987,7 +2985,7 @@ components:
kycCheckCode:
x-addedInVersion: '5'
description: The code of the check. For possible values, refer to [Verification
codes](https://docs.adyen.com/platforms/verification-codes).
codes](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/verification-codes).
format: int32
type: integer
kycCheckDescription:
@@ -3116,10 +3114,11 @@ components:
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.
description: 'Adyen-generated unique alphanumeric identifier (UUID) for
the entry, returned in the response when you create a legal arrangement.
Use only when updating an account holder. If you include this field when
creating an account holder, the request will fail.'
type: string
legalArrangementEntities:
description: An array containing information about other entities that are
@@ -3179,7 +3178,7 @@ components:
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\
description: "The [type of legal arrangement](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/legal-arrangements#types-of-legal-arrangements).\n\
\nPossible values:\n\n- **Association** \n\n- **Partnership** \n\n- **SoleProprietorship**\
\ \n\n- **Trust** \n\n"
enum:
@@ -3214,10 +3213,12 @@ components:
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.
description: 'Adyen-generated unique alphanumeric identifier (UUID) for
the entry, returned in the response when you create a legal arrangement
entity.
Use only when updating an account holder. If you include this field when
creating an account holder, the request will fail.'
type: string
legalArrangementEntityReference:
description: Your reference for the legal arrangement entity.
@@ -3290,7 +3291,7 @@ components:
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).
card details](https://docs.adyen.com/marketplaces-and-platforms/classic/payouts/manual-payout/payout-to-cards#check-and-store).
type: string
payoutMethodCode:
description: Adyen-generated unique alphanumeric identifier (UUID) for the
@@ -3304,12 +3305,12 @@ components:
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).
details](https://docs.adyen.com/marketplaces-and-platforms/classic/payouts/manual-payout/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).
card details](https://docs.adyen.com/marketplaces-and-platforms/classic/payouts/manual-payout/payout-to-cards#check-and-store).
type: string
required:
- merchantAccount
@@ -3461,8 +3462,7 @@ components:
>**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.**
creation of Account Holder will fail with a validation Error..**
>**If, during an Account Holder update request, a UUID that is not correlated

105
yaml/FundService-v3.yaml
View File

@@ -24,7 +24,7 @@ info:
\ using 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/Fund/v3/accountHolderBalance\n\
```"
x-timestamp: '2022-08-25T18:26:01Z'
x-timestamp: '2022-09-27T19:26:19Z'
termsOfService: https://www.adyen.com/legal/terms-and-conditions
contact:
name: Adyen Developer Experience team
@@ -32,6 +32,7 @@ info:
email: developer-experience@adyen.com
x-groups:
- General
- Migration
tags:
- name: General
paths:
@@ -64,6 +65,13 @@ paths:
schema:
$ref: '#/components/schemas/AccountHolderBalanceResponse'
description: OK - the request has succeeded.
'202':
content:
application/json:
schema:
$ref: '#/components/schemas/AccountHolderBalanceResponse'
description: Accepted - the request has been accepted for processing, but
the processing has not been completed.
'400':
content:
application/json:
@@ -128,6 +136,13 @@ paths:
schema:
$ref: '#/components/schemas/AccountHolderTransactionListResponse'
description: OK - the request has succeeded.
'202':
content:
application/json:
schema:
$ref: '#/components/schemas/AccountHolderTransactionListResponse'
description: Accepted - the request has been accepted for processing, but
the processing has not been completed.
'400':
content:
application/json:
@@ -675,6 +690,8 @@ components:
items:
enum:
- BalanceNotPaidOutTransfer
- BalancePlatformSweep
- BalancePlatfromSweepReturned
- Chargeback
- ChargebackCorrection
- ChargebackCorrectionReceived
@@ -778,8 +795,8 @@ components:
accountNumber:
description: 'The bank account number (without separators).
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
accountType:
description: 'The type of bank account.
@@ -789,8 +806,8 @@ components:
The permitted values are: `checking`, `savings`.
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
bankAccountName:
description: The name of the bank account.
@@ -822,31 +839,31 @@ components:
bankBicSwift:
description: 'The bank identifier code.
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
bankCity:
description: 'The city in which the bank branch is located.
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
bankCode:
description: 'The bank code of the banking institution with which the bank
account is registered.
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
bankName:
description: 'The name of the banking institution with which the bank account
is held.
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
branchCode:
description: 'The branch code of the branch under which the bank account
@@ -859,15 +876,15 @@ components:
* Germany - Bankleitzahl
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
checkCode:
description: 'The check code of the bank account.
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
countryCode:
description: 'The two-letter country code in which the bank account is registered.
@@ -875,17 +892,15 @@ components:
>The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. ''NL'').
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
currencyCode:
description: 'The currency in which the bank account deals.
>The permitted currency codes are defined in ISO-4217 (e.g. ''EUR'').
>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.
@@ -893,14 +908,14 @@ components:
>The IBAN standard is defined in ISO-13616.
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
ownerCity:
description: 'The city of residence of the bank account owner.
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
ownerCountryCode:
description: 'The country code of the country of residence of the bank account
@@ -909,8 +924,8 @@ components:
>The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. ''NL'').
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
ownerDateOfBirth:
deprecated: true
@@ -922,14 +937,14 @@ components:
description: 'The house name or number of the residence of the bank account
owner.
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
ownerName:
description: 'The name of the bank account owner.
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
ownerNationality:
description: 'The country code of the country of nationality of the bank
@@ -938,26 +953,26 @@ components:
>The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. ''NL'').
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
ownerPostalCode:
description: 'The postal code of the residence of the bank account owner.
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
ownerState:
description: 'The state of residence of the bank account owner.
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
ownerStreet:
description: 'The street name of the residence of the bank account owner.
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
primaryAccount:
description: If set to true, the bank account is a primary account.
@@ -966,8 +981,8 @@ components:
description: 'The tax ID number.
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
urlForVerification:
description: 'The URL to be used for bank account verification.
@@ -975,8 +990,8 @@ components:
This may be generated on bank account creation.
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
DebitAccountHolderRequest:
properties:
@@ -1380,6 +1395,8 @@ components:
`ManualCorrected`.'
enum:
- BalanceNotPaidOutTransfer
- BalancePlatformSweep
- BalancePlatfromSweepReturned
- Chargeback
- ChargebackCorrection
- ChargebackCorrectionReceived

105
yaml/FundService-v5.yaml
View File

@@ -24,7 +24,7 @@ info:
\ using 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/Fund/v5/accountHolderBalance\n\
```"
x-timestamp: '2022-08-25T18:26:01Z'
x-timestamp: '2022-09-27T19:26:20Z'
termsOfService: https://www.adyen.com/legal/terms-and-conditions
contact:
name: Adyen Developer Experience team
@@ -32,6 +32,7 @@ info:
email: developer-experience@adyen.com
x-groups:
- General
- Migration
tags:
- name: General
paths:
@@ -64,6 +65,13 @@ paths:
schema:
$ref: '#/components/schemas/AccountHolderBalanceResponse'
description: OK - the request has succeeded.
'202':
content:
application/json:
schema:
$ref: '#/components/schemas/AccountHolderBalanceResponse'
description: Accepted - the request has been accepted for processing, but
the processing has not been completed.
'400':
content:
application/json:
@@ -128,6 +136,13 @@ paths:
schema:
$ref: '#/components/schemas/AccountHolderTransactionListResponse'
description: OK - the request has succeeded.
'202':
content:
application/json:
schema:
$ref: '#/components/schemas/AccountHolderTransactionListResponse'
description: Accepted - the request has been accepted for processing, but
the processing has not been completed.
'400':
content:
application/json:
@@ -671,6 +686,8 @@ components:
items:
enum:
- BalanceNotPaidOutTransfer
- BalancePlatformSweep
- BalancePlatfromSweepReturned
- Chargeback
- ChargebackCorrection
- ChargebackCorrectionReceived
@@ -770,8 +787,8 @@ components:
accountNumber:
description: 'The bank account number (without separators).
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
accountType:
description: 'The type of bank account.
@@ -781,8 +798,8 @@ components:
The permitted values are: `checking`, `savings`.
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
bankAccountName:
description: The name of the bank account.
@@ -818,31 +835,31 @@ components:
bankBicSwift:
description: 'The bank identifier code.
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
bankCity:
description: 'The city in which the bank branch is located.
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
bankCode:
description: 'The bank code of the banking institution with which the bank
account is registered.
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
bankName:
description: 'The name of the banking institution with which the bank account
is held.
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
branchCode:
description: 'The branch code of the branch under which the bank account
@@ -855,15 +872,15 @@ components:
* Germany - Bankleitzahl
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
checkCode:
description: 'The check code of the bank account.
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
countryCode:
description: 'The two-letter country code in which the bank account is registered.
@@ -871,17 +888,15 @@ components:
>The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. ''NL'').
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
currencyCode:
description: 'The currency in which the bank account deals.
>The permitted currency codes are defined in ISO-4217 (e.g. ''EUR'').
>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.
@@ -889,14 +904,14 @@ components:
>The IBAN standard is defined in ISO-13616.
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
ownerCity:
description: 'The city of residence of the bank account owner.
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
ownerCountryCode:
description: 'The country code of the country of residence of the bank account
@@ -905,8 +920,8 @@ components:
>The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. ''NL'').
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
ownerDateOfBirth:
deprecated: true
@@ -918,14 +933,14 @@ components:
description: 'The house name or number of the residence of the bank account
owner.
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
ownerName:
description: 'The name of the bank account owner.
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
ownerNationality:
description: 'The country code of the country of nationality of the bank
@@ -934,26 +949,26 @@ components:
>The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. ''NL'').
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
ownerPostalCode:
description: 'The postal code of the residence of the bank account owner.
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
ownerState:
description: 'The state of residence of the bank account owner.
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
ownerStreet:
description: 'The street name of the residence of the bank account owner.
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
primaryAccount:
description: If set to true, the bank account is a primary account.
@@ -962,8 +977,8 @@ components:
description: 'The tax ID number.
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
urlForVerification:
description: 'The URL to be used for bank account verification.
@@ -971,8 +986,8 @@ components:
This may be generated on bank account creation.
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
DebitAccountHolderRequest:
properties:
@@ -1573,6 +1588,8 @@ components:
`ManualCorrected`.'
enum:
- BalanceNotPaidOutTransfer
- BalancePlatformSweep
- BalancePlatfromSweepReturned
- Chargeback
- ChargebackCorrection
- ChargebackCorrectionReceived

105
yaml/FundService-v6.yaml
View File

@@ -24,7 +24,7 @@ info:
\ using 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/Fund/v6/accountHolderBalance\n\
```"
x-timestamp: '2022-08-25T18:26:01Z'
x-timestamp: '2022-09-27T19:26:20Z'
termsOfService: https://www.adyen.com/legal/terms-and-conditions
contact:
name: Adyen Developer Experience team
@@ -32,6 +32,7 @@ info:
email: developer-experience@adyen.com
x-groups:
- General
- Migration
tags:
- name: General
paths:
@@ -64,6 +65,13 @@ paths:
schema:
$ref: '#/components/schemas/AccountHolderBalanceResponse'
description: OK - the request has succeeded.
'202':
content:
application/json:
schema:
$ref: '#/components/schemas/AccountHolderBalanceResponse'
description: Accepted - the request has been accepted for processing, but
the processing has not been completed.
'400':
content:
application/json:
@@ -128,6 +136,13 @@ paths:
schema:
$ref: '#/components/schemas/AccountHolderTransactionListResponse'
description: OK - the request has succeeded.
'202':
content:
application/json:
schema:
$ref: '#/components/schemas/AccountHolderTransactionListResponse'
description: Accepted - the request has been accepted for processing, but
the processing has not been completed.
'400':
content:
application/json:
@@ -671,6 +686,8 @@ components:
items:
enum:
- BalanceNotPaidOutTransfer
- BalancePlatformSweep
- BalancePlatfromSweepReturned
- Chargeback
- ChargebackCorrection
- ChargebackCorrectionReceived
@@ -770,8 +787,8 @@ components:
accountNumber:
description: 'The bank account number (without separators).
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
accountType:
description: 'The type of bank account.
@@ -781,8 +798,8 @@ components:
The permitted values are: `checking`, `savings`.
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
bankAccountName:
description: The name of the bank account.
@@ -818,31 +835,31 @@ components:
bankBicSwift:
description: 'The bank identifier code.
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
bankCity:
description: 'The city in which the bank branch is located.
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
bankCode:
description: 'The bank code of the banking institution with which the bank
account is registered.
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
bankName:
description: 'The name of the banking institution with which the bank account
is held.
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
branchCode:
description: 'The branch code of the branch under which the bank account
@@ -855,15 +872,15 @@ components:
* Germany - Bankleitzahl
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
checkCode:
description: 'The check code of the bank account.
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
countryCode:
description: 'The two-letter country code in which the bank account is registered.
@@ -871,17 +888,15 @@ components:
>The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. ''NL'').
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
currencyCode:
description: 'The currency in which the bank account deals.
>The permitted currency codes are defined in ISO-4217 (e.g. ''EUR'').
>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.
@@ -889,14 +904,14 @@ components:
>The IBAN standard is defined in ISO-13616.
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
ownerCity:
description: 'The city of residence of the bank account owner.
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
ownerCountryCode:
description: 'The country code of the country of residence of the bank account
@@ -905,8 +920,8 @@ components:
>The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. ''NL'').
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
ownerDateOfBirth:
deprecated: true
@@ -918,14 +933,14 @@ components:
description: 'The house name or number of the residence of the bank account
owner.
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
ownerName:
description: 'The name of the bank account owner.
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
ownerNationality:
description: 'The country code of the country of nationality of the bank
@@ -934,26 +949,26 @@ components:
>The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. ''NL'').
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
ownerPostalCode:
description: 'The postal code of the residence of the bank account owner.
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
ownerState:
description: 'The state of residence of the bank account owner.
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
ownerStreet:
description: 'The street name of the residence of the bank account owner.
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
primaryAccount:
description: If set to true, the bank account is a primary account.
@@ -962,8 +977,8 @@ components:
description: 'The tax ID number.
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
urlForVerification:
description: 'The URL to be used for bank account verification.
@@ -971,8 +986,8 @@ components:
This may be generated on bank account creation.
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
DebitAccountHolderRequest:
properties:
@@ -1573,6 +1588,8 @@ components:
`ManualCorrected`.'
enum:
- BalanceNotPaidOutTransfer
- BalancePlatformSweep
- BalancePlatfromSweepReturned
- Chargeback
- ChargebackCorrection
- ChargebackCorrectionReceived

115
yaml/MarketPayNotificationService-v3.yaml
View File

@@ -2,14 +2,14 @@ openapi: 3.1.0
info:
version: '3'
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.
For more information, refer to our [documentation](https://docs.adyen.com/platforms/notifications).'
x-timestamp: '2022-08-16T10:21:11Z'
title: Classic Platforms - Notifications
description: "This API is used for the classic integration. If you are just starting\
\ your implementation, refer to our [new integration guide](https://docs.adyen.com/marketplaces-and-platforms)\
\ instead.\n\nThe Notification API sends notifications to the endpoints specified\
\ in a given subscription. \nSubscriptions 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/marketplaces-and-platforms/classic/notifications)."
x-timestamp: '2022-09-27T19:26:20Z'
termsOfService: https://www.adyen.com/legal/terms-and-conditions
contact:
name: Adyen Developer Experience team
@@ -459,7 +459,7 @@ webhooks:
tags:
- Other
summary: Booking for a capture or refund failed
description: Adyen sends this notification when a [split payment](https://docs.adyen.com/platforms/processing-payments#providing-split-information)
description: Adyen sends this notification when a [split payment](https://docs.adyen.com/marketplaces-and-platforms/classic/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 or fromyour platform's liable account instead of the account specified
@@ -670,7 +670,7 @@ components:
>Permitted values: `InactivateAccount`, `RefundNotPaidOutTransfers`.
For more information, refer to [Verification checks](https://docs.adyen.com/platforms/verification-checks).'
For more information, refer to [Verification checks](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process).'
enum:
- InactivateAccount
- RefundNotPaidOutTransfers
@@ -767,8 +767,8 @@ components:
$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).
For details about the required `bankAccountDetail` fields, see [Required
information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information).
items:
$ref: '#/components/schemas/BankAccountDetail'
type: array
@@ -1256,8 +1256,8 @@ components:
accountNumber:
description: 'The bank account number (without separators).
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
accountType:
description: 'The type of bank account.
@@ -1267,8 +1267,8 @@ components:
The permitted values are: `checking`, `savings`.
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
bankAccountName:
description: The name of the bank account.
@@ -1300,31 +1300,31 @@ components:
bankBicSwift:
description: 'The bank identifier code.
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
bankCity:
description: 'The city in which the bank branch is located.
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
bankCode:
description: 'The bank code of the banking institution with which the bank
account is registered.
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
bankName:
description: 'The name of the banking institution with which the bank account
is held.
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
branchCode:
description: 'The branch code of the branch under which the bank account
@@ -1337,15 +1337,15 @@ components:
* Germany - Bankleitzahl
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
checkCode:
description: 'The check code of the bank account.
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
countryCode:
description: 'The two-letter country code in which the bank account is registered.
@@ -1353,17 +1353,15 @@ components:
>The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. ''NL'').
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
currencyCode:
description: 'The currency in which the bank account deals.
>The permitted currency codes are defined in ISO-4217 (e.g. ''EUR'').
>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.
@@ -1371,14 +1369,14 @@ components:
>The IBAN standard is defined in ISO-13616.
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
ownerCity:
description: 'The city of residence of the bank account owner.
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
ownerCountryCode:
description: 'The country code of the country of residence of the bank account
@@ -1387,8 +1385,8 @@ components:
>The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. ''NL'').
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
ownerDateOfBirth:
deprecated: true
@@ -1400,14 +1398,14 @@ components:
description: 'The house name or number of the residence of the bank account
owner.
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
ownerName:
description: 'The name of the bank account owner.
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
ownerNationality:
description: 'The country code of the country of nationality of the bank
@@ -1416,26 +1414,26 @@ components:
>The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. ''NL'').
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
ownerPostalCode:
description: 'The postal code of the residence of the bank account owner.
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
ownerState:
description: 'The state of residence of the bank account owner.
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
ownerStreet:
description: 'The street name of the residence of the bank account owner.
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
primaryAccount:
description: If set to true, the bank account is a primary account.
@@ -1444,8 +1442,8 @@ components:
description: 'The tax ID number.
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
urlForVerification:
description: 'The URL to be used for bank account verification.
@@ -1453,8 +1451,8 @@ components:
This may be generated on bank account creation.
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
BeneficiarySetupNotification:
properties:
@@ -1535,7 +1533,7 @@ components:
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).
how you can identify them, refer to [our verification guide](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process#identify-ubos).
items:
$ref: '#/components/schemas/ShareholderContact'
type: array
@@ -2437,8 +2435,7 @@ components:
>**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.**
creation of Account Holder will fail with a validation Error..**
>**If, during an Account Holder update request, a UUID that is not correlated
@@ -2649,6 +2646,8 @@ components:
`ManualCorrected`.'
enum:
- BalanceNotPaidOutTransfer
- BalancePlatformSweep
- BalancePlatfromSweepReturned
- Chargeback
- ChargebackCorrection
- ChargebackCorrectionReceived

115
yaml/MarketPayNotificationService-v4.yaml
View File

@@ -2,14 +2,14 @@ openapi: 3.1.0
info:
version: '4'
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.
For more information, refer to our [documentation](https://docs.adyen.com/platforms/notifications).'
x-timestamp: '2022-08-16T10:21:11Z'
title: Classic Platforms - Notifications
description: "This API is used for the classic integration. If you are just starting\
\ your implementation, refer to our [new integration guide](https://docs.adyen.com/marketplaces-and-platforms)\
\ instead.\n\nThe Notification API sends notifications to the endpoints specified\
\ in a given subscription. \nSubscriptions 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/marketplaces-and-platforms/classic/notifications)."
x-timestamp: '2022-09-27T19:26:20Z'
termsOfService: https://www.adyen.com/legal/terms-and-conditions
contact:
name: Adyen Developer Experience team
@@ -459,7 +459,7 @@ webhooks:
tags:
- Other
summary: Booking for a capture or refund failed
description: Adyen sends this notification when a [split payment](https://docs.adyen.com/platforms/processing-payments#providing-split-information)
description: Adyen sends this notification when a [split payment](https://docs.adyen.com/marketplaces-and-platforms/classic/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 or fromyour platform's liable account instead of the account specified
@@ -682,7 +682,7 @@ components:
>Permitted values: `InactivateAccount`, `RefundNotPaidOutTransfers`.
For more information, refer to [Verification checks](https://docs.adyen.com/platforms/verification-checks).'
For more information, refer to [Verification checks](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process).'
enum:
- InactivateAccount
- RefundNotPaidOutTransfers
@@ -791,8 +791,8 @@ components:
$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).
For details about the required `bankAccountDetail` fields, see [Required
information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information).
items:
$ref: '#/components/schemas/BankAccountDetail'
type: array
@@ -1320,8 +1320,8 @@ components:
accountNumber:
description: 'The bank account number (without separators).
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
accountType:
description: 'The type of bank account.
@@ -1331,8 +1331,8 @@ components:
The permitted values are: `checking`, `savings`.
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
bankAccountName:
description: The name of the bank account.
@@ -1364,31 +1364,31 @@ components:
bankBicSwift:
description: 'The bank identifier code.
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
bankCity:
description: 'The city in which the bank branch is located.
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
bankCode:
description: 'The bank code of the banking institution with which the bank
account is registered.
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
bankName:
description: 'The name of the banking institution with which the bank account
is held.
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
branchCode:
description: 'The branch code of the branch under which the bank account
@@ -1401,15 +1401,15 @@ components:
* Germany - Bankleitzahl
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
checkCode:
description: 'The check code of the bank account.
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
countryCode:
description: 'The two-letter country code in which the bank account is registered.
@@ -1417,17 +1417,15 @@ components:
>The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. ''NL'').
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
currencyCode:
description: 'The currency in which the bank account deals.
>The permitted currency codes are defined in ISO-4217 (e.g. ''EUR'').
>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.
@@ -1435,14 +1433,14 @@ components:
>The IBAN standard is defined in ISO-13616.
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
ownerCity:
description: 'The city of residence of the bank account owner.
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
ownerCountryCode:
description: 'The country code of the country of residence of the bank account
@@ -1451,8 +1449,8 @@ components:
>The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. ''NL'').
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
ownerDateOfBirth:
deprecated: true
@@ -1464,14 +1462,14 @@ components:
description: 'The house name or number of the residence of the bank account
owner.
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
ownerName:
description: 'The name of the bank account owner.
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
ownerNationality:
description: 'The country code of the country of nationality of the bank
@@ -1480,26 +1478,26 @@ components:
>The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. ''NL'').
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
ownerPostalCode:
description: 'The postal code of the residence of the bank account owner.
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
ownerState:
description: 'The state of residence of the bank account owner.
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
ownerStreet:
description: 'The street name of the residence of the bank account owner.
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
primaryAccount:
description: If set to true, the bank account is a primary account.
@@ -1508,8 +1506,8 @@ components:
description: 'The tax ID number.
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
urlForVerification:
description: 'The URL to be used for bank account verification.
@@ -1517,8 +1515,8 @@ components:
This may be generated on bank account creation.
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
BeneficiarySetupNotification:
properties:
@@ -1609,7 +1607,7 @@ components:
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).
how you can identify them, refer to [our verification guide](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process#identify-ubos).
items:
$ref: '#/components/schemas/ShareholderContact'
type: array
@@ -2559,8 +2557,7 @@ components:
>**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.**
creation of Account Holder will fail with a validation Error..**
>**If, during an Account Holder update request, a UUID that is not correlated
@@ -2771,6 +2768,8 @@ components:
`ManualCorrected`.'
enum:
- BalanceNotPaidOutTransfer
- BalancePlatformSweep
- BalancePlatfromSweepReturned
- Chargeback
- ChargebackCorrection
- ChargebackCorrectionReceived

127
yaml/MarketPayNotificationService-v5.yaml
View File

@@ -2,14 +2,14 @@ openapi: 3.1.0
info:
version: '5'
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.
For more information, refer to our [documentation](https://docs.adyen.com/platforms/notifications).'
x-timestamp: '2022-08-16T10:21:11Z'
title: Classic Platforms - Notifications
description: "This API is used for the classic integration. If you are just starting\
\ your implementation, refer to our [new integration guide](https://docs.adyen.com/marketplaces-and-platforms)\
\ instead.\n\nThe Notification API sends notifications to the endpoints specified\
\ in a given subscription. \nSubscriptions 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/marketplaces-and-platforms/classic/notifications)."
x-timestamp: '2022-09-27T19:26:20Z'
termsOfService: https://www.adyen.com/legal/terms-and-conditions
contact:
name: Adyen Developer Experience team
@@ -467,7 +467,7 @@ webhooks:
tags:
- Other
summary: Booking for a capture or refund failed
description: Adyen sends this notification when a [split payment](https://docs.adyen.com/platforms/processing-payments#providing-split-information)
description: Adyen sends this notification when a [split payment](https://docs.adyen.com/marketplaces-and-platforms/classic/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 or fromyour platform's liable account instead of the account specified
@@ -706,7 +706,7 @@ components:
>Permitted values: `InactivateAccount`, `RefundNotPaidOutTransfers`.
For more information, refer to [Verification checks](https://docs.adyen.com/platforms/verification-checks).'
For more information, refer to [Verification checks](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process).'
enum:
- InactivateAccount
- RefundNotPaidOutTransfers
@@ -825,8 +825,8 @@ components:
$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).
For details about the required `bankAccountDetail` fields, see [Required
information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information).
items:
$ref: '#/components/schemas/BankAccountDetail'
type: array
@@ -886,7 +886,7 @@ components:
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).
to [Pay out to cards](https://docs.adyen.com/marketplaces-and-platforms/classic/payout-to-cards).
items:
$ref: '#/components/schemas/PayoutMethod'
type: array
@@ -896,7 +896,7 @@ components:
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).
when onboarding account holders that have an Adyen [point of sale](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-pos).
items:
$ref: '#/components/schemas/StoreDetail'
type: array
@@ -1470,8 +1470,8 @@ components:
accountNumber:
description: 'The bank account number (without separators).
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
accountType:
description: 'The type of bank account.
@@ -1481,8 +1481,8 @@ components:
The permitted values are: `checking`, `savings`.
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
bankAccountName:
description: The name of the bank account.
@@ -1518,31 +1518,31 @@ components:
bankBicSwift:
description: 'The bank identifier code.
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
bankCity:
description: 'The city in which the bank branch is located.
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
bankCode:
description: 'The bank code of the banking institution with which the bank
account is registered.
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
bankName:
description: 'The name of the banking institution with which the bank account
is held.
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
branchCode:
description: 'The branch code of the branch under which the bank account
@@ -1555,15 +1555,15 @@ components:
* Germany - Bankleitzahl
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
checkCode:
description: 'The check code of the bank account.
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
countryCode:
description: 'The two-letter country code in which the bank account is registered.
@@ -1571,17 +1571,15 @@ components:
>The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. ''NL'').
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
currencyCode:
description: 'The currency in which the bank account deals.
>The permitted currency codes are defined in ISO-4217 (e.g. ''EUR'').
>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.
@@ -1589,14 +1587,14 @@ components:
>The IBAN standard is defined in ISO-13616.
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
ownerCity:
description: 'The city of residence of the bank account owner.
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
ownerCountryCode:
description: 'The country code of the country of residence of the bank account
@@ -1605,8 +1603,8 @@ components:
>The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. ''NL'').
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
ownerDateOfBirth:
deprecated: true
@@ -1618,14 +1616,14 @@ components:
description: 'The house name or number of the residence of the bank account
owner.
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
ownerName:
description: 'The name of the bank account owner.
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
ownerNationality:
description: 'The country code of the country of nationality of the bank
@@ -1634,26 +1632,26 @@ components:
>The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. ''NL'').
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
ownerPostalCode:
description: 'The postal code of the residence of the bank account owner.
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
ownerState:
description: 'The state of residence of the bank account owner.
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
ownerStreet:
description: 'The street name of the residence of the bank account owner.
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
primaryAccount:
description: If set to true, the bank account is a primary account.
@@ -1662,8 +1660,8 @@ components:
description: 'The tax ID number.
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
urlForVerification:
description: 'The URL to be used for bank account verification.
@@ -1671,8 +1669,8 @@ components:
This may be generated on bank account creation.
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
BeneficiarySetupNotification:
properties:
@@ -1770,7 +1768,7 @@ components:
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).
how you can identify them, refer to [our verification guide](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process#identify-ubos).
items:
$ref: '#/components/schemas/ShareholderContact'
type: array
@@ -2352,7 +2350,7 @@ components:
kycCheckCode:
x-addedInVersion: '5'
description: The code of the check. For possible values, refer to [Verification
codes](https://docs.adyen.com/platforms/verification-codes).
codes](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/verification-codes).
format: int32
type: integer
kycCheckDescription:
@@ -2511,7 +2509,7 @@ components:
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).
card details](https://docs.adyen.com/marketplaces-and-platforms/classic/payouts/manual-payout/payout-to-cards#check-and-store).
type: string
payoutMethodCode:
description: Adyen-generated unique alphanumeric identifier (UUID) for the
@@ -2525,12 +2523,12 @@ components:
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).
details](https://docs.adyen.com/marketplaces-and-platforms/classic/payouts/manual-payout/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).
card details](https://docs.adyen.com/marketplaces-and-platforms/classic/payouts/manual-payout/payout-to-cards#check-and-store).
type: string
required:
- merchantAccount
@@ -2837,8 +2835,7 @@ components:
>**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.**
creation of Account Holder will fail with a validation Error..**
>**If, during an Account Holder update request, a UUID that is not correlated
@@ -3139,6 +3136,8 @@ components:
`ManualCorrected`.'
enum:
- BalanceNotPaidOutTransfer
- BalancePlatformSweep
- BalancePlatfromSweepReturned
- Chargeback
- ChargebackCorrection
- ChargebackCorrectionReceived

150
yaml/MarketPayNotificationService-v6.yaml
View File

@@ -2,14 +2,14 @@ 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.
For more information, refer to our [documentation](https://docs.adyen.com/platforms/notifications).'
x-timestamp: '2022-08-16T10:21:11Z'
title: Classic Platforms - Notifications
description: "This API is used for the classic integration. If you are just starting\
\ your implementation, refer to our [new integration guide](https://docs.adyen.com/marketplaces-and-platforms)\
\ instead.\n\nThe Notification API sends notifications to the endpoints specified\
\ in a given subscription. \nSubscriptions 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/marketplaces-and-platforms/classic/notifications)."
x-timestamp: '2022-10-06T13:26:47Z'
termsOfService: https://www.adyen.com/legal/terms-and-conditions
contact:
name: Adyen Developer Experience team
@@ -467,7 +467,7 @@ webhooks:
tags:
- Other
summary: Booking for a capture or refund failed
description: Adyen sends this notification when a [split payment](https://docs.adyen.com/platforms/processing-payments#providing-split-information)
description: Adyen sends this notification when a [split payment](https://docs.adyen.com/marketplaces-and-platforms/classic/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 or fromyour platform's liable account instead of the account specified
@@ -706,7 +706,7 @@ components:
>Permitted values: `InactivateAccount`, `RefundNotPaidOutTransfers`.
For more information, refer to [Verification checks](https://docs.adyen.com/platforms/verification-checks).'
For more information, refer to [Verification checks](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process).'
enum:
- InactivateAccount
- RefundNotPaidOutTransfers
@@ -825,8 +825,8 @@ components:
$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).
For details about the required `bankAccountDetail` fields, see [Required
information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information).
items:
$ref: '#/components/schemas/BankAccountDetail'
type: array
@@ -864,7 +864,7 @@ components:
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).
[legal arrangements](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/legal-arrangements).
items:
$ref: '#/components/schemas/LegalArrangementDetail'
type: array
@@ -893,7 +893,7 @@ components:
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).
to [Pay out to cards](https://docs.adyen.com/marketplaces-and-platforms/classic/payout-to-cards).
items:
$ref: '#/components/schemas/PayoutMethod'
type: array
@@ -903,7 +903,7 @@ components:
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).
when onboarding account holders that have an Adyen [point of sale](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-pos).
items:
$ref: '#/components/schemas/StoreDetail'
type: array
@@ -1509,8 +1509,8 @@ components:
accountNumber:
description: 'The bank account number (without separators).
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
accountType:
description: 'The type of bank account.
@@ -1520,8 +1520,8 @@ components:
The permitted values are: `checking`, `savings`.
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
bankAccountName:
description: The name of the bank account.
@@ -1557,31 +1557,31 @@ components:
bankBicSwift:
description: 'The bank identifier code.
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
bankCity:
description: 'The city in which the bank branch is located.
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
bankCode:
description: 'The bank code of the banking institution with which the bank
account is registered.
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
bankName:
description: 'The name of the banking institution with which the bank account
is held.
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
branchCode:
description: 'The branch code of the branch under which the bank account
@@ -1594,15 +1594,15 @@ components:
* Germany - Bankleitzahl
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
checkCode:
description: 'The check code of the bank account.
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
countryCode:
description: 'The two-letter country code in which the bank account is registered.
@@ -1610,17 +1610,15 @@ components:
>The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. ''NL'').
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
currencyCode:
description: 'The currency in which the bank account deals.
>The permitted currency codes are defined in ISO-4217 (e.g. ''EUR'').
>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.
@@ -1628,14 +1626,14 @@ components:
>The IBAN standard is defined in ISO-13616.
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
ownerCity:
description: 'The city of residence of the bank account owner.
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
ownerCountryCode:
description: 'The country code of the country of residence of the bank account
@@ -1644,8 +1642,8 @@ components:
>The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. ''NL'').
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
ownerDateOfBirth:
deprecated: true
@@ -1657,14 +1655,14 @@ components:
description: 'The house name or number of the residence of the bank account
owner.
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
ownerName:
description: 'The name of the bank account owner.
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
ownerNationality:
description: 'The country code of the country of nationality of the bank
@@ -1673,26 +1671,26 @@ components:
>The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. ''NL'').
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
ownerPostalCode:
description: 'The postal code of the residence of the bank account owner.
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
ownerState:
description: 'The state of residence of the bank account owner.
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
ownerStreet:
description: 'The street name of the residence of the bank account owner.
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
primaryAccount:
description: If set to true, the bank account is a primary account.
@@ -1701,8 +1699,8 @@ components:
description: 'The tax ID number.
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
urlForVerification:
description: 'The URL to be used for bank account verification.
@@ -1710,8 +1708,8 @@ components:
This may be generated on bank account creation.
>Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
section for details on field requirements.'
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
for details on field requirements.'
type: string
BeneficiarySetupNotification:
properties:
@@ -1809,7 +1807,7 @@ components:
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).
how you can identify them, refer to [our verification guide](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process#identify-ubos).
items:
$ref: '#/components/schemas/ShareholderContact'
type: array
@@ -2389,7 +2387,7 @@ components:
kycCheckCode:
x-addedInVersion: '5'
description: The code of the check. For possible values, refer to [Verification
codes](https://docs.adyen.com/platforms/verification-codes).
codes](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/verification-codes).
format: int32
type: integer
kycCheckDescription:
@@ -2518,10 +2516,11 @@ components:
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.
description: 'Adyen-generated unique alphanumeric identifier (UUID) for
the entry, returned in the response when you create a legal arrangement.
Use only when updating an account holder. If you include this field when
creating an account holder, the request will fail.'
type: string
legalArrangementEntities:
description: An array containing information about other entities that are
@@ -2581,7 +2580,7 @@ components:
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\
description: "The [type of legal arrangement](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/legal-arrangements#types-of-legal-arrangements).\n\
\nPossible values:\n\n- **Association** \n\n- **Partnership** \n\n- **SoleProprietorship**\
\ \n\n- **Trust** \n\n"
enum:
@@ -2616,10 +2615,12 @@ components:
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.
description: 'Adyen-generated unique alphanumeric identifier (UUID) for
the entry, returned in the response when you create a legal arrangement
entity.
Use only when updating an account holder. If you include this field when
creating an account holder, the request will fail.'
type: string
legalArrangementEntityReference:
description: Your reference for the legal arrangement entity.
@@ -2780,7 +2781,7 @@ components:
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).
card details](https://docs.adyen.com/marketplaces-and-platforms/classic/payouts/manual-payout/payout-to-cards#check-and-store).
type: string
payoutMethodCode:
description: Adyen-generated unique alphanumeric identifier (UUID) for the
@@ -2794,12 +2795,12 @@ components:
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).
details](https://docs.adyen.com/marketplaces-and-platforms/classic/payouts/manual-payout/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).
card details](https://docs.adyen.com/marketplaces-and-platforms/classic/payouts/manual-payout/payout-to-cards#check-and-store).
type: string
required:
- merchantAccount
@@ -3106,8 +3107,7 @@ components:
>**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.**
creation of Account Holder will fail with a validation Error..**
>**If, during an Account Holder update request, a UUID that is not correlated
@@ -3408,6 +3408,8 @@ components:
`ManualCorrected`.'
enum:
- BalanceNotPaidOutTransfer
- BalancePlatformSweep
- BalancePlatfromSweepReturned
- Chargeback
- ChargebackCorrection
- ChargebackCorrectionReceived

15
yaml/NotificationConfigurationService-v1.yaml
View File

@@ -23,7 +23,7 @@ info:
\ using 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/Notification/v1/createNotificationConfiguration\n\
```"
x-timestamp: '2022-07-28T16:19:58Z'
x-timestamp: '2022-10-03T13:24:04Z'
termsOfService: https://www.adyen.com/legal/terms-and-conditions
contact:
name: Adyen Developer Experience team
@@ -570,16 +570,10 @@ components:
sslProtocol:
description: 'The SSL protocol employed by the endpoint.
>Permitted values: `SSL`, `SSLInsecureCiphers`, `TLS`, `TLSv10`, `TLSv10InsecureCiphers`,
`TLSv11`, `TLSv12`.'
>Permitted values: `TLSv12`, `TLSv13`.'
enum:
- SSL
- SSLInsecureCiphers
- TLS
- TLSv10
- TLSv10InsecureCiphers
- TLSv11
- TLSv12
- TLSv13
type: string
required:
- eventConfigs
@@ -603,6 +597,7 @@ components:
- ACCOUNT_FUNDS_BELOW_THRESHOLD
- ACCOUNT_HOLDER_CREATED
- ACCOUNT_HOLDER_LIMIT_REACHED
- ACCOUNT_HOLDER_MIGRATED
- ACCOUNT_HOLDER_PAYOUT
- ACCOUNT_HOLDER_STATUS_CHANGE
- ACCOUNT_HOLDER_STORE_STATUS_CHANGE
@@ -675,6 +670,7 @@ components:
- ACCOUNT_FUNDS_BELOW_THRESHOLD
- ACCOUNT_HOLDER_CREATED
- ACCOUNT_HOLDER_LIMIT_REACHED
- ACCOUNT_HOLDER_MIGRATED
- ACCOUNT_HOLDER_PAYOUT
- ACCOUNT_HOLDER_STATUS_CHANGE
- ACCOUNT_HOLDER_STORE_STATUS_CHANGE
@@ -724,6 +720,7 @@ components:
- ACCOUNT_FUNDS_BELOW_THRESHOLD
- ACCOUNT_HOLDER_CREATED
- ACCOUNT_HOLDER_LIMIT_REACHED
- ACCOUNT_HOLDER_MIGRATED
- ACCOUNT_HOLDER_PAYOUT
- ACCOUNT_HOLDER_STATUS_CHANGE
- ACCOUNT_HOLDER_STORE_STATUS_CHANGE

15
yaml/NotificationConfigurationService-v2.yaml
View File

@@ -23,7 +23,7 @@ info:
\ using 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/Notification/v2/createNotificationConfiguration\n\
```"
x-timestamp: '2022-07-28T16:19:58Z'
x-timestamp: '2022-10-03T13:24:04Z'
termsOfService: https://www.adyen.com/legal/terms-and-conditions
contact:
name: Adyen Developer Experience team
@@ -570,16 +570,10 @@ components:
sslProtocol:
description: 'The SSL protocol employed by the endpoint.
>Permitted values: `SSL`, `SSLInsecureCiphers`, `TLS`, `TLSv10`, `TLSv10InsecureCiphers`,
`TLSv11`, `TLSv12`.'
>Permitted values: `TLSv12`, `TLSv13`.'
enum:
- SSL
- SSLInsecureCiphers
- TLS
- TLSv10
- TLSv10InsecureCiphers
- TLSv11
- TLSv12
- TLSv13
type: string
required:
- eventConfigs
@@ -603,6 +597,7 @@ components:
- ACCOUNT_FUNDS_BELOW_THRESHOLD
- ACCOUNT_HOLDER_CREATED
- ACCOUNT_HOLDER_LIMIT_REACHED
- ACCOUNT_HOLDER_MIGRATED
- ACCOUNT_HOLDER_PAYOUT
- ACCOUNT_HOLDER_STATUS_CHANGE
- ACCOUNT_HOLDER_STORE_STATUS_CHANGE
@@ -675,6 +670,7 @@ components:
- ACCOUNT_FUNDS_BELOW_THRESHOLD
- ACCOUNT_HOLDER_CREATED
- ACCOUNT_HOLDER_LIMIT_REACHED
- ACCOUNT_HOLDER_MIGRATED
- ACCOUNT_HOLDER_PAYOUT
- ACCOUNT_HOLDER_STATUS_CHANGE
- ACCOUNT_HOLDER_STORE_STATUS_CHANGE
@@ -724,6 +720,7 @@ components:
- ACCOUNT_FUNDS_BELOW_THRESHOLD
- ACCOUNT_HOLDER_CREATED
- ACCOUNT_HOLDER_LIMIT_REACHED
- ACCOUNT_HOLDER_MIGRATED
- ACCOUNT_HOLDER_PAYOUT
- ACCOUNT_HOLDER_STATUS_CHANGE
- ACCOUNT_HOLDER_STORE_STATUS_CHANGE

15
yaml/NotificationConfigurationService-v3.yaml
View File

@@ -23,7 +23,7 @@ info:
\ using 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/Notification/v3/createNotificationConfiguration\n\
```"
x-timestamp: '2022-07-28T16:19:58Z'
x-timestamp: '2022-10-03T13:24:04Z'
termsOfService: https://www.adyen.com/legal/terms-and-conditions
contact:
name: Adyen Developer Experience team
@@ -570,16 +570,10 @@ components:
sslProtocol:
description: 'The SSL protocol employed by the endpoint.
>Permitted values: `SSL`, `SSLInsecureCiphers`, `TLS`, `TLSv10`, `TLSv10InsecureCiphers`,
`TLSv11`, `TLSv12`.'
>Permitted values: `TLSv12`, `TLSv13`.'
enum:
- SSL
- SSLInsecureCiphers
- TLS
- TLSv10
- TLSv10InsecureCiphers
- TLSv11
- TLSv12
- TLSv13
type: string
required:
- eventConfigs
@@ -603,6 +597,7 @@ components:
- ACCOUNT_FUNDS_BELOW_THRESHOLD
- ACCOUNT_HOLDER_CREATED
- ACCOUNT_HOLDER_LIMIT_REACHED
- ACCOUNT_HOLDER_MIGRATED
- ACCOUNT_HOLDER_PAYOUT
- ACCOUNT_HOLDER_STATUS_CHANGE
- ACCOUNT_HOLDER_STORE_STATUS_CHANGE
@@ -675,6 +670,7 @@ components:
- ACCOUNT_FUNDS_BELOW_THRESHOLD
- ACCOUNT_HOLDER_CREATED
- ACCOUNT_HOLDER_LIMIT_REACHED
- ACCOUNT_HOLDER_MIGRATED
- ACCOUNT_HOLDER_PAYOUT
- ACCOUNT_HOLDER_STATUS_CHANGE
- ACCOUNT_HOLDER_STORE_STATUS_CHANGE
@@ -724,6 +720,7 @@ components:
- ACCOUNT_FUNDS_BELOW_THRESHOLD
- ACCOUNT_HOLDER_CREATED
- ACCOUNT_HOLDER_LIMIT_REACHED
- ACCOUNT_HOLDER_MIGRATED
- ACCOUNT_HOLDER_PAYOUT
- ACCOUNT_HOLDER_STATUS_CHANGE
- ACCOUNT_HOLDER_STORE_STATUS_CHANGE

15
yaml/NotificationConfigurationService-v4.yaml
View File

@@ -23,7 +23,7 @@ info:
\ using 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/Notification/v4/createNotificationConfiguration\n\
```"
x-timestamp: '2022-07-28T16:19:58Z'
x-timestamp: '2022-10-03T13:24:04Z'
termsOfService: https://www.adyen.com/legal/terms-and-conditions
contact:
name: Adyen Developer Experience team
@@ -570,16 +570,10 @@ components:
sslProtocol:
description: 'The SSL protocol employed by the endpoint.
>Permitted values: `SSL`, `SSLInsecureCiphers`, `TLS`, `TLSv10`, `TLSv10InsecureCiphers`,
`TLSv11`, `TLSv12`.'
>Permitted values: `TLSv12`, `TLSv13`.'
enum:
- SSL
- SSLInsecureCiphers
- TLS
- TLSv10
- TLSv10InsecureCiphers
- TLSv11
- TLSv12
- TLSv13
type: string
required:
- eventConfigs
@@ -603,6 +597,7 @@ components:
- ACCOUNT_FUNDS_BELOW_THRESHOLD
- ACCOUNT_HOLDER_CREATED
- ACCOUNT_HOLDER_LIMIT_REACHED
- ACCOUNT_HOLDER_MIGRATED
- ACCOUNT_HOLDER_PAYOUT
- ACCOUNT_HOLDER_STATUS_CHANGE
- ACCOUNT_HOLDER_STORE_STATUS_CHANGE
@@ -675,6 +670,7 @@ components:
- ACCOUNT_FUNDS_BELOW_THRESHOLD
- ACCOUNT_HOLDER_CREATED
- ACCOUNT_HOLDER_LIMIT_REACHED
- ACCOUNT_HOLDER_MIGRATED
- ACCOUNT_HOLDER_PAYOUT
- ACCOUNT_HOLDER_STATUS_CHANGE
- ACCOUNT_HOLDER_STORE_STATUS_CHANGE
@@ -724,6 +720,7 @@ components:
- ACCOUNT_FUNDS_BELOW_THRESHOLD
- ACCOUNT_HOLDER_CREATED
- ACCOUNT_HOLDER_LIMIT_REACHED
- ACCOUNT_HOLDER_MIGRATED
- ACCOUNT_HOLDER_PAYOUT
- ACCOUNT_HOLDER_STATUS_CHANGE
- ACCOUNT_HOLDER_STORE_STATUS_CHANGE

15
yaml/NotificationConfigurationService-v5.yaml
View File

@@ -23,7 +23,7 @@ info:
\ using 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/Notification/v5/createNotificationConfiguration\n\
```"
x-timestamp: '2022-07-28T16:19:58Z'
x-timestamp: '2022-10-03T13:24:04Z'
termsOfService: https://www.adyen.com/legal/terms-and-conditions
contact:
name: Adyen Developer Experience team
@@ -745,16 +745,10 @@ components:
sslProtocol:
description: 'The SSL protocol employed by the endpoint.
>Permitted values: `SSL`, `SSLInsecureCiphers`, `TLS`, `TLSv10`, `TLSv10InsecureCiphers`,
`TLSv11`, `TLSv12`.'
>Permitted values: `TLSv12`, `TLSv13`.'
enum:
- SSL
- SSLInsecureCiphers
- TLS
- TLSv10
- TLSv10InsecureCiphers
- TLSv11
- TLSv12
- TLSv13
type: string
required:
- eventConfigs
@@ -778,6 +772,7 @@ components:
- ACCOUNT_FUNDS_BELOW_THRESHOLD
- ACCOUNT_HOLDER_CREATED
- ACCOUNT_HOLDER_LIMIT_REACHED
- ACCOUNT_HOLDER_MIGRATED
- ACCOUNT_HOLDER_PAYOUT
- ACCOUNT_HOLDER_STATUS_CHANGE
- ACCOUNT_HOLDER_STORE_STATUS_CHANGE
@@ -850,6 +845,7 @@ components:
- ACCOUNT_FUNDS_BELOW_THRESHOLD
- ACCOUNT_HOLDER_CREATED
- ACCOUNT_HOLDER_LIMIT_REACHED
- ACCOUNT_HOLDER_MIGRATED
- ACCOUNT_HOLDER_PAYOUT
- ACCOUNT_HOLDER_STATUS_CHANGE
- ACCOUNT_HOLDER_STORE_STATUS_CHANGE
@@ -899,6 +895,7 @@ components:
- ACCOUNT_FUNDS_BELOW_THRESHOLD
- ACCOUNT_HOLDER_CREATED
- ACCOUNT_HOLDER_LIMIT_REACHED
- ACCOUNT_HOLDER_MIGRATED
- ACCOUNT_HOLDER_PAYOUT
- ACCOUNT_HOLDER_STATUS_CHANGE
- ACCOUNT_HOLDER_STORE_STATUS_CHANGE

15
yaml/NotificationConfigurationService-v6.yaml
View File

@@ -23,7 +23,7 @@ info:
\ using 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/Notification/v6/createNotificationConfiguration\n\
```"
x-timestamp: '2022-07-28T16:19:58Z'
x-timestamp: '2022-10-03T13:24:04Z'
termsOfService: https://www.adyen.com/legal/terms-and-conditions
contact:
name: Adyen Developer Experience team
@@ -745,16 +745,10 @@ components:
sslProtocol:
description: 'The SSL protocol employed by the endpoint.
>Permitted values: `SSL`, `SSLInsecureCiphers`, `TLS`, `TLSv10`, `TLSv10InsecureCiphers`,
`TLSv11`, `TLSv12`.'
>Permitted values: `TLSv12`, `TLSv13`.'
enum:
- SSL
- SSLInsecureCiphers
- TLS
- TLSv10
- TLSv10InsecureCiphers
- TLSv11
- TLSv12
- TLSv13
type: string
required:
- eventConfigs
@@ -778,6 +772,7 @@ components:
- ACCOUNT_FUNDS_BELOW_THRESHOLD
- ACCOUNT_HOLDER_CREATED
- ACCOUNT_HOLDER_LIMIT_REACHED
- ACCOUNT_HOLDER_MIGRATED
- ACCOUNT_HOLDER_PAYOUT
- ACCOUNT_HOLDER_STATUS_CHANGE
- ACCOUNT_HOLDER_STORE_STATUS_CHANGE
@@ -850,6 +845,7 @@ components:
- ACCOUNT_FUNDS_BELOW_THRESHOLD
- ACCOUNT_HOLDER_CREATED
- ACCOUNT_HOLDER_LIMIT_REACHED
- ACCOUNT_HOLDER_MIGRATED
- ACCOUNT_HOLDER_PAYOUT
- ACCOUNT_HOLDER_STATUS_CHANGE
- ACCOUNT_HOLDER_STORE_STATUS_CHANGE
@@ -899,6 +895,7 @@ components:
- ACCOUNT_FUNDS_BELOW_THRESHOLD
- ACCOUNT_HOLDER_CREATED
- ACCOUNT_HOLDER_LIMIT_REACHED
- ACCOUNT_HOLDER_MIGRATED
- ACCOUNT_HOLDER_PAYOUT
- ACCOUNT_HOLDER_STATUS_CHANGE
- ACCOUNT_HOLDER_STORE_STATUS_CHANGE