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
2024-03-04 13:10:16 +01:00
parent ed8525a0ae
commit ac2556f4b0
40 changed files with 3188 additions and 2106 deletions
Download Patch File Download Diff File Expand all files Collapse all files

46
json/AccountService-v3.json
View File

@@ -10,27 +10,21 @@
"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" : "2023-05-30T15:27:20Z",
"termsOfService" : "https://www.adyen.com/legal/terms-and-conditions",
"contact" : {
"name" : "Adyen Developer Experience team",
"url" : "https://github.com/Adyen/adyen-openapi"
}
},
"x-groups" : [
"Account holders",
"Accounts",
"Verification"
],
"tags" : [
{
"name" : "Account holders"
},
{
"name" : "Verification"
"name" : "Accounts"
},
{
"name" : "Accounts"
"name" : "Verification"
}
],
"paths" : {
@@ -42,7 +36,6 @@
"summary" : "Close an account",
"description" : "Closes an account. If an account is closed, you cannot process transactions, pay out its funds, or reopen it. If payments are made to a closed account, the payments are sent to your liable account.",
"operationId" : "post-closeAccount",
"x-groupName" : "Accounts",
"x-sortIndex" : 3,
"x-methodName" : "closeAccount",
"security" : [
@@ -161,7 +154,6 @@
"summary" : "Close an account holder",
"description" : "Changes the [status of an account holder](https://docs.adyen.com/marketplaces-and-platforms/classic/account-holders-and-accounts#account-holder-statuses) to **Closed**. This state is final. If an account holder is closed, you can't process transactions, pay out funds, or reopen it. If payments are made to an account of an account holder with a **Closed** [`status`](https://docs.adyen.com/api-explorer/#/Account/latest/post/getAccountHolder__resParam_verification-accountHolder-checks-status), the payments are sent to your liable account.",
"operationId" : "post-closeAccountHolder",
"x-groupName" : "Account holders",
"x-sortIndex" : 7,
"x-methodName" : "closeAccountHolder",
"security" : [
@@ -280,7 +272,6 @@
"summary" : "Create an account",
"description" : "Creates an account under an account holder. An account holder can have [multiple accounts](https://docs.adyen.com/marketplaces-and-platforms/classic/account-holders-and-accounts#create-additional-accounts).",
"operationId" : "post-createAccount",
"x-groupName" : "Accounts",
"x-sortIndex" : 1,
"x-methodName" : "createAccount",
"security" : [
@@ -399,7 +390,6 @@
"summary" : "Create an account holder",
"description" : "Creates an account holder that [represents the sub-merchant's entity](https://docs.adyen.com/marketplaces-and-platforms/classic/account-structure#your-platform) in your platform. The details that you need to provide in the request depend on the sub-merchant's legal entity type. For more information, refer to [Account holder and accounts](https://docs.adyen.com/marketplaces-and-platforms/classic/account-holders-and-accounts#legal-entity-types).",
"operationId" : "post-createAccountHolder",
"x-groupName" : "Account holders",
"x-sortIndex" : 1,
"x-methodName" : "createAccountHolder",
"security" : [
@@ -537,7 +527,6 @@
"summary" : "Delete bank accounts",
"description" : "Deletes bank accounts associated with an account holder. ",
"operationId" : "post-deleteBankAccounts",
"x-groupName" : "Verification",
"x-sortIndex" : 4,
"x-methodName" : "deleteBankAccounts",
"security" : [
@@ -656,7 +645,6 @@
"summary" : "Delete legal arrangements",
"description" : "Deletes legal arrangements and/or legal arrangement entities associated with an account holder.",
"operationId" : "post-deleteLegalArrangements",
"x-groupName" : "Verification",
"x-sortIndex" : 6,
"x-methodName" : "deleteLegalArrangements",
"security" : [
@@ -792,7 +780,6 @@
"summary" : "Delete shareholders",
"description" : "Deletes shareholders associated with an account holder.",
"operationId" : "post-deleteShareholders",
"x-groupName" : "Verification",
"x-sortIndex" : 7,
"x-methodName" : "deleteShareholders",
"security" : [
@@ -911,7 +898,6 @@
"summary" : "Delete signatories",
"description" : "Deletes signatories associated with an account holder.",
"operationId" : "post-deleteSignatories",
"x-groupName" : "Verification",
"x-sortIndex" : 8,
"x-methodName" : "deleteSignatories",
"security" : [
@@ -1025,7 +1011,6 @@
"summary" : "Get an account holder",
"description" : "Returns the details of an account holder.",
"operationId" : "post-getAccountHolder",
"x-groupName" : "Account holders",
"x-sortIndex" : 2,
"x-methodName" : "getAccountHolder",
"security" : [
@@ -1147,7 +1132,6 @@
"summary" : "Get a tax form",
"description" : "Generates a tax form for account holders operating in the US. For more information, refer to [Providing tax forms](https://docs.adyen.com/marketplaces-and-platforms/classic/tax-forms).",
"operationId" : "post-getTaxForm",
"x-groupName" : "Account holders",
"x-sortIndex" : 8,
"x-methodName" : "getTaxForm",
"security" : [
@@ -1256,7 +1240,6 @@
"summary" : "Get documents",
"description" : "Returns documents that were previously uploaded for an account holder. Adyen uses the documents during the [verification process](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process).\n",
"operationId" : "post-getUploadedDocuments",
"x-groupName" : "Verification",
"x-sortIndex" : 2,
"x-methodName" : "getUploadedDocuments",
"security" : [
@@ -1365,7 +1348,6 @@
"summary" : "Suspend an account holder",
"description" : "Changes the [status of an account holder](https://docs.adyen.com/marketplaces-and-platforms/classic/account-holders-and-accounts#account-holder-statuses) to **Suspended**.",
"operationId" : "post-suspendAccountHolder",
"x-groupName" : "Account holders",
"x-sortIndex" : 5,
"x-methodName" : "suspendAccountHolder",
"security" : [
@@ -1484,7 +1466,6 @@
"summary" : "Unsuspend an account holder",
"description" : "Changes the [status of an account holder](https://docs.adyen.com/marketplaces-and-platforms/classic/account-holders-and-accounts#account-holder-statuses) from **Suspended** to **Inactive**. \nAccount holders can have a **Suspended** [`status`](https://docs.adyen.com/api-explorer/#/Account/latest/post/getAccountHolder__resParam_verification-accountHolder-checks-status) if you suspend them through the [`/suspendAccountHolder`](https://docs.adyen.com/api-explorer/#/Account/v5/post/suspendAccountHolder) endpoint or if a verification deadline expires.\n\nYou can only unsuspend account holders if they do not have verification checks with a **FAILED** [`status`](https://docs.adyen.com/api-explorer/#/Account/latest/post/getAccountHolder__resParam_verification-accountHolder-checks-status).",
"operationId" : "post-unSuspendAccountHolder",
"x-groupName" : "Account holders",
"x-sortIndex" : 6,
"x-methodName" : "unSuspendAccountHolder",
"security" : [
@@ -1603,7 +1584,6 @@
"summary" : "Update an account",
"description" : "Updates the description or payout schedule of an account.",
"operationId" : "post-updateAccount",
"x-groupName" : "Accounts",
"x-sortIndex" : 2,
"x-methodName" : "updateAccount",
"security" : [
@@ -1722,7 +1702,6 @@
"summary" : "Update an account holder",
"description" : "Updates the `accountHolderDetails` and `processingTier` of an account holder, and adds bank accounts and shareholders.\n\nWhen updating `accountHolderDetails`, parameters that are not included in the request are left unchanged except for the following object:\n\n* `metadata`: Updating the metadata replaces the entire object. This means that to update an existing key-value pair, you must provide the changes, as well as other existing key-value pairs.\n\nWhen updating any field in the following objects, you must submit all the fields required for validation:\n\n * `address`\n\n* `fullPhoneNumber`\n\n* `bankAccountDetails.BankAccountDetail`\n\n* `businessDetails.shareholders.ShareholderContact`\n\n For example, to update the `address.postalCode`, you must also submit the `address.country`, `.city`, `.street`, `.postalCode`, and possibly `.stateOrProvince` so that the address can be validated.\n\nTo add a bank account or shareholder, provide the bank account or shareholder details without a `bankAccountUUID` or a `shareholderCode`.\n\n",
"operationId" : "post-updateAccountHolder",
"x-groupName" : "Account holders",
"x-sortIndex" : 3,
"x-methodName" : "updateAccountHolder",
"security" : [
@@ -1850,7 +1829,6 @@
"summary" : "Update payout or processing state",
"description" : "Disables or enables the processing or payout state of an account holder.",
"operationId" : "post-updateAccountHolderState",
"x-groupName" : "Account holders",
"x-sortIndex" : 4,
"x-methodName" : "updateAccountHolderState",
"security" : [
@@ -1969,7 +1947,6 @@
"summary" : "Upload a document",
"description" : "Uploads a document for an account holder. Adyen uses the documents during the [verification process](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process).",
"operationId" : "post-uploadDocument",
"x-groupName" : "Verification",
"x-sortIndex" : 1,
"x-methodName" : "uploadDocument",
"security" : [
@@ -2624,7 +2601,7 @@
"type" : "string"
},
"payoutSchedule" : {
"description" : "The payout schedule of the prospective account.\n>Permitted values: `DEFAULT`, `HOLD`, `DAILY`, `WEEKLY`, `MONTHLY`.",
"description" : "The payout schedule for the account.\n\nPossible values: `DEFAULT`, `DAILY`, `DAILY_US`, `DAILY_EU`, `DAILY_AU`, `DAILY_SG`, `WEEKLY`, `WEEKLY_ON_TUE_FRI_MIDNIGHT`, `BIWEEKLY_ON_1ST_AND_15TH_AT_MIDNIGHT`, `MONTHLY`, `HOLD`.\n> `HOLD` prevents scheduled payouts, but you can still initiate payouts manually.",
"enum" : [
"BIWEEKLY_ON_1ST_AND_15TH_AT_MIDNIGHT",
"DAILY",
@@ -2645,7 +2622,7 @@
"type" : "string"
},
"payoutScheduleReason" : {
"description" : "The reason for the payout schedule choice.\n>Required if the payoutSchedule is `HOLD`.",
"description" : "The reason for the payout schedule choice.\n> This field is required when the `payoutSchedule` parameter is set to `HOLD`.",
"type" : "string"
}
},
@@ -2665,7 +2642,7 @@
"type" : "string"
},
"payoutSchedule" : {
"description" : "The payout schedule of the account.",
"description" : "The details of the payout schedule added to the account.",
"$ref" : "#/components/schemas/PayoutScheduleResponse"
},
"pspReference" : {
@@ -2946,6 +2923,7 @@
"legalBusinessName",
"legalEntity",
"legalEntityType",
"linkedViasVirtualAccount",
"logo",
"merchantAccount",
"merchantCategoryCode",
@@ -3447,7 +3425,7 @@
"type" : "string"
},
"schedule" : {
"description" : "The payout schedule of the account.\nPermitted values: `DEFAULT`, `DAILY`, `DAILY_US`, `DAILY_EU`, `DAILY_AU`, `DAILY_SG`, `WEEKLY`, `WEEKLY_ON_TUE_FRI_MIDNIGHT`, `BIWEEKLY_ON_1ST_AND_15TH_AT_MIDNIGHT`, `MONTHLY`, `HOLD`.",
"description" : "The payout schedule for the account.\n\nPossible values: `DEFAULT`, `DAILY`, `DAILY_US`, `DAILY_EU`, `DAILY_AU`, `DAILY_SG`, `WEEKLY`, `WEEKLY_ON_TUE_FRI_MIDNIGHT`, `BIWEEKLY_ON_1ST_AND_15TH_AT_MIDNIGHT`, `MONTHLY`, `HOLD`.\n> `HOLD` prevents scheduled payouts, but you can still initiate payouts manually.",
"enum" : [
"BIWEEKLY_ON_1ST_AND_15TH_AT_MIDNIGHT",
"DAILY",
@@ -3877,7 +3855,7 @@
"type" : "string"
},
"payoutSchedule" : {
"description" : "The details of the payout schedule, to which the account should be updated.",
"description" : "The details of the payout schedule to which the account must be updated.",
"$ref" : "#/components/schemas/UpdatePayoutScheduleRequest"
}
},
@@ -3894,7 +3872,7 @@
"type" : "string"
},
"payoutSchedule" : {
"description" : "The payout schedule of the account.",
"description" : "The details of the payout schedule to which the account is updated.",
"$ref" : "#/components/schemas/PayoutScheduleResponse"
},
"pspReference" : {
@@ -3918,7 +3896,7 @@
"UpdatePayoutScheduleRequest" : {
"properties" : {
"action" : {
"description" : "Direction on how to handle any payouts that have already been scheduled.\nPermitted values:\n* `CLOSE` will close the existing batch of payouts.\n* `UPDATE` will reschedule the existing batch to the new schedule.\n* `NOTHING` (**default**) will allow the payout to proceed.",
"description" : "Direction on how to handle any payouts that have already been scheduled.\n\nPossible values:\n* `CLOSE`: close the existing batch of payouts.\n* `UPDATE`: reschedule the existing batch to the new schedule.\n* `NOTHING` (**default**): allow the payout to proceed.",
"enum" : [
"CLOSE",
"NOTHING",
@@ -3931,7 +3909,7 @@
"type" : "string"
},
"schedule" : {
"description" : "The payout schedule to which the account is to be updated.\nPermitted values: `DAILY`, `DAILY_US`, `DAILY_EU`, `DAILY_AU`, `DAILY_SG`, `WEEKLY`, `WEEKLY_ON_TUE_FRI_MIDNIGHT`, `BIWEEKLY_ON_1ST_AND_15TH_AT_MIDNIGHT`, `MONTHLY`, `HOLD`.\n`HOLD` will prevent scheduled payouts from happening but will still allow manual payouts to occur.",
"description" : "The new payout schedule for the account.\n\nPossible values: `DEFAULT`, `DAILY`, `DAILY_US`, `DAILY_EU`, `DAILY_AU`, `DAILY_SG`, `WEEKLY`, `WEEKLY_ON_TUE_FRI_MIDNIGHT`, `BIWEEKLY_ON_1ST_AND_15TH_AT_MIDNIGHT`, `MONTHLY`, `HOLD`.\n> `HOLD` prevents scheduled payouts, but you can still initiate payouts manually.",
"enum" : [
"BIWEEKLY_ON_1ST_AND_15TH_AT_MIDNIGHT",
"DAILY",
@@ -4128,7 +4106,7 @@
}
},
"generic-403" : {
"summary" : "Response code 401. Forbidden.",
"summary" : "Response code 403. Forbidden.",
"value" : {
"status" : 403,
"errorCode" : "10_003",

535
json/AccountService-v4.json
View File

@@ -10,27 +10,21 @@
"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" : "2023-05-30T15:27:20Z",
"termsOfService" : "https://www.adyen.com/legal/terms-and-conditions",
"contact" : {
"name" : "Adyen Developer Experience team",
"url" : "https://github.com/Adyen/adyen-openapi"
}
},
"x-groups" : [
"Account holders",
"Accounts",
"Verification"
],
"tags" : [
{
"name" : "Account holders"
},
{
"name" : "Verification"
"name" : "Accounts"
},
{
"name" : "Accounts"
"name" : "Verification"
}
],
"paths" : {
@@ -42,7 +36,6 @@
"summary" : "Close an account",
"description" : "Closes an account. If an account is closed, you cannot process transactions, pay out its funds, or reopen it. If payments are made to a closed account, the payments are sent to your liable account.",
"operationId" : "post-closeAccount",
"x-groupName" : "Accounts",
"x-sortIndex" : 3,
"x-methodName" : "closeAccount",
"security" : [
@@ -161,7 +154,6 @@
"summary" : "Close an account holder",
"description" : "Changes the [status of an account holder](https://docs.adyen.com/marketplaces-and-platforms/classic/account-holders-and-accounts#account-holder-statuses) to **Closed**. This state is final. If an account holder is closed, you can't process transactions, pay out funds, or reopen it. If payments are made to an account of an account holder with a **Closed** [`status`](https://docs.adyen.com/api-explorer/#/Account/latest/post/getAccountHolder__resParam_verification-accountHolder-checks-status), the payments are sent to your liable account.",
"operationId" : "post-closeAccountHolder",
"x-groupName" : "Account holders",
"x-sortIndex" : 7,
"x-methodName" : "closeAccountHolder",
"security" : [
@@ -280,7 +272,6 @@
"summary" : "Create an account",
"description" : "Creates an account under an account holder. An account holder can have [multiple accounts](https://docs.adyen.com/marketplaces-and-platforms/classic/account-holders-and-accounts#create-additional-accounts).",
"operationId" : "post-createAccount",
"x-groupName" : "Accounts",
"x-sortIndex" : 1,
"x-methodName" : "createAccount",
"security" : [
@@ -399,7 +390,6 @@
"summary" : "Create an account holder",
"description" : "Creates an account holder that [represents the sub-merchant's entity](https://docs.adyen.com/marketplaces-and-platforms/classic/account-structure#your-platform) in your platform. The details that you need to provide in the request depend on the sub-merchant's legal entity type. For more information, refer to [Account holder and accounts](https://docs.adyen.com/marketplaces-and-platforms/classic/account-holders-and-accounts#legal-entity-types).",
"operationId" : "post-createAccountHolder",
"x-groupName" : "Account holders",
"x-sortIndex" : 1,
"x-methodName" : "createAccountHolder",
"security" : [
@@ -433,6 +423,14 @@
"200" : {
"content" : {
"application/json" : {
"examples" : {
"business" : {
"$ref" : "#/components/examples/post-createAccountHolder-business-200"
},
"individual" : {
"$ref" : "#/components/examples/post-createAccountHolder-individual-200"
}
},
"schema" : {
"$ref" : "#/components/schemas/CreateAccountHolderResponse"
}
@@ -511,7 +509,6 @@
"summary" : "Delete bank accounts",
"description" : "Deletes bank accounts associated with an account holder. ",
"operationId" : "post-deleteBankAccounts",
"x-groupName" : "Verification",
"x-sortIndex" : 4,
"x-methodName" : "deleteBankAccounts",
"security" : [
@@ -630,7 +627,6 @@
"summary" : "Delete legal arrangements",
"description" : "Deletes legal arrangements and/or legal arrangement entities associated with an account holder.",
"operationId" : "post-deleteLegalArrangements",
"x-groupName" : "Verification",
"x-sortIndex" : 6,
"x-methodName" : "deleteLegalArrangements",
"security" : [
@@ -766,7 +762,6 @@
"summary" : "Delete shareholders",
"description" : "Deletes shareholders associated with an account holder.",
"operationId" : "post-deleteShareholders",
"x-groupName" : "Verification",
"x-sortIndex" : 7,
"x-methodName" : "deleteShareholders",
"security" : [
@@ -885,7 +880,6 @@
"summary" : "Delete signatories",
"description" : "Deletes signatories associated with an account holder.",
"operationId" : "post-deleteSignatories",
"x-groupName" : "Verification",
"x-sortIndex" : 8,
"x-methodName" : "deleteSignatories",
"security" : [
@@ -999,7 +993,6 @@
"summary" : "Get an account holder",
"description" : "Returns the details of an account holder.",
"operationId" : "post-getAccountHolder",
"x-groupName" : "Account holders",
"x-sortIndex" : 2,
"x-methodName" : "getAccountHolder",
"security" : [
@@ -1121,7 +1114,6 @@
"summary" : "Get a tax form",
"description" : "Generates a tax form for account holders operating in the US. For more information, refer to [Providing tax forms](https://docs.adyen.com/marketplaces-and-platforms/classic/tax-forms).",
"operationId" : "post-getTaxForm",
"x-groupName" : "Account holders",
"x-sortIndex" : 8,
"x-methodName" : "getTaxForm",
"security" : [
@@ -1230,7 +1222,6 @@
"summary" : "Get documents",
"description" : "Returns documents that were previously uploaded for an account holder. Adyen uses the documents during the [verification process](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process).\n",
"operationId" : "post-getUploadedDocuments",
"x-groupName" : "Verification",
"x-sortIndex" : 2,
"x-methodName" : "getUploadedDocuments",
"security" : [
@@ -1339,7 +1330,6 @@
"summary" : "Suspend an account holder",
"description" : "Changes the [status of an account holder](https://docs.adyen.com/marketplaces-and-platforms/classic/account-holders-and-accounts#account-holder-statuses) to **Suspended**.",
"operationId" : "post-suspendAccountHolder",
"x-groupName" : "Account holders",
"x-sortIndex" : 5,
"x-methodName" : "suspendAccountHolder",
"security" : [
@@ -1458,7 +1448,6 @@
"summary" : "Unsuspend an account holder",
"description" : "Changes the [status of an account holder](https://docs.adyen.com/marketplaces-and-platforms/classic/account-holders-and-accounts#account-holder-statuses) from **Suspended** to **Inactive**. \nAccount holders can have a **Suspended** [`status`](https://docs.adyen.com/api-explorer/#/Account/latest/post/getAccountHolder__resParam_verification-accountHolder-checks-status) if you suspend them through the [`/suspendAccountHolder`](https://docs.adyen.com/api-explorer/#/Account/v5/post/suspendAccountHolder) endpoint or if a verification deadline expires.\n\nYou can only unsuspend account holders if they do not have verification checks with a **FAILED** [`status`](https://docs.adyen.com/api-explorer/#/Account/latest/post/getAccountHolder__resParam_verification-accountHolder-checks-status).",
"operationId" : "post-unSuspendAccountHolder",
"x-groupName" : "Account holders",
"x-sortIndex" : 6,
"x-methodName" : "unSuspendAccountHolder",
"security" : [
@@ -1577,7 +1566,6 @@
"summary" : "Update an account",
"description" : "Updates the description or payout schedule of an account.",
"operationId" : "post-updateAccount",
"x-groupName" : "Accounts",
"x-sortIndex" : 2,
"x-methodName" : "updateAccount",
"security" : [
@@ -1696,7 +1684,6 @@
"summary" : "Update an account holder",
"description" : "Updates the `accountHolderDetails` and `processingTier` of an account holder, and adds bank accounts and shareholders.\n\nWhen updating `accountHolderDetails`, parameters that are not included in the request are left unchanged except for the following object:\n\n* `metadata`: Updating the metadata replaces the entire object. This means that to update an existing key-value pair, you must provide the changes, as well as other existing key-value pairs.\n\nWhen updating any field in the following objects, you must submit all the fields required for validation:\n\n * `address`\n\n* `fullPhoneNumber`\n\n* `bankAccountDetails.BankAccountDetail`\n\n* `businessDetails.shareholders.ShareholderContact`\n\n For example, to update the `address.postalCode`, you must also submit the `address.country`, `.city`, `.street`, `.postalCode`, and possibly `.stateOrProvince` so that the address can be validated.\n\nTo add a bank account or shareholder, provide the bank account or shareholder details without a `bankAccountUUID` or a `shareholderCode`.\n\n",
"operationId" : "post-updateAccountHolder",
"x-groupName" : "Account holders",
"x-sortIndex" : 3,
"x-methodName" : "updateAccountHolder",
"security" : [
@@ -1736,6 +1723,20 @@
"200" : {
"content" : {
"application/json" : {
"examples" : {
"addShareholders" : {
"$ref" : "#/components/examples/post-updateAccountHolder-addShareholders-200"
},
"bankAccountDetails" : {
"$ref" : "#/components/examples/post-updateAccountHolder-bankAccountDetails-200"
},
"businessDetails" : {
"$ref" : "#/components/examples/post-updateAccountHolder-businessDetails-200"
},
"general" : {
"$ref" : "#/components/examples/post-updateAccountHolder-general-200"
}
},
"schema" : {
"$ref" : "#/components/schemas/UpdateAccountHolderResponse"
}
@@ -1824,7 +1825,6 @@
"summary" : "Update payout or processing state",
"description" : "Disables or enables the processing or payout state of an account holder.",
"operationId" : "post-updateAccountHolderState",
"x-groupName" : "Account holders",
"x-sortIndex" : 4,
"x-methodName" : "updateAccountHolderState",
"security" : [
@@ -1943,7 +1943,6 @@
"summary" : "Upload a document",
"description" : "Uploads a document for an account holder. Adyen uses the documents during the [verification process](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process).",
"operationId" : "post-uploadDocument",
"x-groupName" : "Verification",
"x-sortIndex" : 1,
"x-methodName" : "uploadDocument",
"security" : [
@@ -2644,7 +2643,7 @@
"type" : "string"
},
"payoutSchedule" : {
"description" : "The payout schedule of the prospective account.\n>Permitted values: `DEFAULT`, `HOLD`, `DAILY`, `WEEKLY`, `MONTHLY`.",
"description" : "The payout schedule for the account.\n\nPossible values: `DEFAULT`, `DAILY`, `DAILY_US`, `DAILY_EU`, `DAILY_AU`, `DAILY_SG`, `WEEKLY`, `WEEKLY_ON_TUE_FRI_MIDNIGHT`, `BIWEEKLY_ON_1ST_AND_15TH_AT_MIDNIGHT`, `MONTHLY`, `HOLD`.\n> `HOLD` prevents scheduled payouts, but you can still initiate payouts manually.",
"enum" : [
"BIWEEKLY_ON_1ST_AND_15TH_AT_MIDNIGHT",
"DAILY",
@@ -2665,7 +2664,7 @@
"type" : "string"
},
"payoutScheduleReason" : {
"description" : "The reason for the payout schedule choice.\n>Required if the payoutSchedule is `HOLD`.",
"description" : "The reason for the payout schedule choice.\n> This field is required when the `payoutSchedule` parameter is set to `HOLD`.",
"type" : "string"
}
},
@@ -2690,7 +2689,7 @@
"type" : "string"
},
"payoutSchedule" : {
"description" : "The payout schedule of the account.",
"description" : "The details of the payout schedule added to the account.",
"$ref" : "#/components/schemas/PayoutScheduleResponse"
},
"pspReference" : {
@@ -2974,6 +2973,7 @@
"legalBusinessName",
"legalEntity",
"legalEntityType",
"linkedViasVirtualAccount",
"logo",
"merchantAccount",
"merchantCategoryCode",
@@ -3491,7 +3491,7 @@
"type" : "string"
},
"schedule" : {
"description" : "The payout schedule of the account.\nPermitted values: `DEFAULT`, `DAILY`, `DAILY_US`, `DAILY_EU`, `DAILY_AU`, `DAILY_SG`, `WEEKLY`, `WEEKLY_ON_TUE_FRI_MIDNIGHT`, `BIWEEKLY_ON_1ST_AND_15TH_AT_MIDNIGHT`, `MONTHLY`, `HOLD`.",
"description" : "The payout schedule for the account.\n\nPossible values: `DEFAULT`, `DAILY`, `DAILY_US`, `DAILY_EU`, `DAILY_AU`, `DAILY_SG`, `WEEKLY`, `WEEKLY_ON_TUE_FRI_MIDNIGHT`, `BIWEEKLY_ON_1ST_AND_15TH_AT_MIDNIGHT`, `MONTHLY`, `HOLD`.\n> `HOLD` prevents scheduled payouts, but you can still initiate payouts manually.",
"enum" : [
"BIWEEKLY_ON_1ST_AND_15TH_AT_MIDNIGHT",
"DAILY",
@@ -3952,7 +3952,7 @@
"type" : "string"
},
"payoutSchedule" : {
"description" : "The details of the payout schedule, to which the account should be updated.",
"description" : "The details of the payout schedule to which the account must be updated.",
"$ref" : "#/components/schemas/UpdatePayoutScheduleRequest"
}
},
@@ -3973,7 +3973,7 @@
"type" : "string"
},
"payoutSchedule" : {
"description" : "The payout schedule of the account.",
"description" : "The details of the payout schedule to which the account is updated.",
"$ref" : "#/components/schemas/PayoutScheduleResponse"
},
"pspReference" : {
@@ -3997,7 +3997,7 @@
"UpdatePayoutScheduleRequest" : {
"properties" : {
"action" : {
"description" : "Direction on how to handle any payouts that have already been scheduled.\nPermitted values:\n* `CLOSE` will close the existing batch of payouts.\n* `UPDATE` will reschedule the existing batch to the new schedule.\n* `NOTHING` (**default**) will allow the payout to proceed.",
"description" : "Direction on how to handle any payouts that have already been scheduled.\n\nPossible values:\n* `CLOSE`: close the existing batch of payouts.\n* `UPDATE`: reschedule the existing batch to the new schedule.\n* `NOTHING` (**default**): allow the payout to proceed.",
"enum" : [
"CLOSE",
"NOTHING",
@@ -4010,7 +4010,7 @@
"type" : "string"
},
"schedule" : {
"description" : "The payout schedule to which the account is to be updated.\nPermitted values: `DAILY`, `DAILY_US`, `DAILY_EU`, `DAILY_AU`, `DAILY_SG`, `WEEKLY`, `WEEKLY_ON_TUE_FRI_MIDNIGHT`, `BIWEEKLY_ON_1ST_AND_15TH_AT_MIDNIGHT`, `MONTHLY`, `HOLD`.\n`HOLD` will prevent scheduled payouts from happening but will still allow manual payouts to occur.",
"description" : "The new payout schedule for the account.\n\nPossible values: `DEFAULT`, `DAILY`, `DAILY_US`, `DAILY_EU`, `DAILY_AU`, `DAILY_SG`, `WEEKLY`, `WEEKLY_ON_TUE_FRI_MIDNIGHT`, `BIWEEKLY_ON_1ST_AND_15TH_AT_MIDNIGHT`, `MONTHLY`, `HOLD`.\n> `HOLD` prevents scheduled payouts, but you can still initiate payouts manually.",
"enum" : [
"BIWEEKLY_ON_1ST_AND_15TH_AT_MIDNIGHT",
"DAILY",
@@ -4207,7 +4207,7 @@
}
},
"generic-403" : {
"summary" : "Response code 401. Forbidden.",
"summary" : "Response code 403. Forbidden.",
"value" : {
"status" : 403,
"errorCode" : "10_003",
@@ -4234,9 +4234,9 @@
}
},
"post-createAccountHolder-business" : {
"summary" : "Create a business account holder",
"summary" : "Create business account holder with shareholder",
"value" : {
"accountHolderCode" : "GENERATE_CODE",
"accountHolderCode" : "YOUR_UNIQUE_ACCOUNT_HOLDER_CODE",
"accountHolderDetails" : {
"address" : {
"country" : "US"
@@ -4247,6 +4247,7 @@
"shareholders" : [
{
"ShareholderContact" : {
"shareholderType" : "Owner",
"name" : {
"firstName" : "John",
"lastName" : "Carpenter"
@@ -4262,10 +4263,80 @@
"legalEntity" : "Business"
}
},
"post-createAccountHolder-business-200" : {
"summary" : "Business account holder with shareholder created",
"value" : {
"pspReference" : "ALPHANUMERIC_UNIQUE_RESPONSE_REFERENCE",
"submittedAsync" : "false",
"accountCode" : "UNIQUE_ACCOUNT_CODE",
"accountHolderCode" : "YOUR_UNIQUE_ACCOUNT_HOLDER_CODE",
"accountHolderDetails" : {
"address" : {
"country" : "US"
},
"bankAccountDetails" : [
],
"businessDetails" : {
"doingBusinessAs" : "Real Good Restaurant",
"legalBusinessName" : "Real Good Restaurant Inc.",
"shareholders" : [
{
"ShareholderContact" : {
"email" : "testshareholder@adyen.com",
"legalEntityId" : "SHAREHOLDER_LEGAL_ENTITY_ID",
"name" : {
"firstName" : "John",
"lastName" : "Carpenter"
},
"shareholderCode" : "SHAREHOLDER_CODE",
"shareholderType" : "Owner"
}
}
]
},
"email" : "test@adyen.com",
"legalEntityId" : "LE",
"merchantCategoryCode" : "MCC_DEFAULT_VALUE",
"webAddress" : "https://www.your-website.com"
},
"accountHolderStatus" : {
"status" : "Active",
"processingState" : {
"disabled" : "false",
"processedFrom" : {
"currency" : "USD",
"value" : 0
},
"processedTo" : {
"currency" : "USD",
"value" : 0
},
"tierNumber" : 0
},
"payoutState" : {
"allowPayout" : "true",
"payoutLimit" : {
"currency" : "USD",
"value" : 0
},
"disabled" : "false",
"tierNumber" : 0
},
"events" : [
]
},
"invalidFields" : [
],
"legalEntity" : "Business",
"verification" : {
}
}
},
"post-createAccountHolder-individual" : {
"summary" : "Create an individual account holder",
"value" : {
"accountHolderCode" : "GENERATE_CODE",
"accountHolderCode" : "YOUR_UNIQUE_ACCOUNT_HOLDER_CODE",
"accountHolderDetails" : {
"email" : "tim@green.com",
"individualDetails" : {
@@ -4282,6 +4353,64 @@
"legalEntity" : "Individual"
}
},
"post-createAccountHolder-individual-200" : {
"summary" : "Individual account holder created",
"value" : {
"pspReference" : "ALPHANUMERIC_UNIQUE_RESPONSE_REFERENCE",
"submittedAsync" : "false",
"accountCode" : "UNIQUE_ACCOUNT_CODE",
"accountHolderCode" : "YOUR_UNIQUE_ACCOUNT_HOLDER_CODE",
"accountHolderDetails" : {
"address" : {
"country" : "US"
},
"bankAccountDetails" : [
],
"email" : "tim@green.com",
"individualDetails" : {
"name" : {
"firstName" : "Tim",
"lastName" : "Green"
}
},
"legalEntityId" : "LEGAL_ENTITY_ID",
"merchantCategoryCode" : "MCC_DEFAULT_VALUE",
"webAddress" : "https://www.your-website.com"
},
"accountHolderStatus" : {
"status" : "Active",
"processingState" : {
"disabled" : "false",
"processedFrom" : {
"currency" : "USD",
"value" : 0
},
"processedTo" : {
"currency" : "USD",
"value" : 0
},
"tierNumber" : 0
},
"payoutState" : {
"allowPayout" : "true",
"payoutLimit" : {
"currency" : "USD",
"value" : 0
},
"disabled" : "false",
"tierNumber" : 0
},
"events" : [
]
},
"invalidFields" : [
],
"legalEntity" : "Individual",
"verification" : {
}
}
},
"post-deleteBankAccounts-basic" : {
"summary" : "Delete bank accounts",
"value" : {
@@ -4425,9 +4554,9 @@
}
},
"post-updateAccountHolder-addShareholders" : {
"summary" : "Add shareholders",
"summary" : "Add shareholder to existing account holder",
"value" : {
"accountHolderCode" : "CODE_OF_ACCOUNT_HOLDER",
"accountHolderCode" : "YOUR_UNIQUE_ACCOUNT_HOLDER_CODE",
"accountHolderDetails" : {
"bankAccountDetails" : [
],
@@ -4436,30 +4565,101 @@
"shareholders" : [
{
"ShareholderContact" : {
"email" : "testEmail@gmail.com",
"shareholderType" : "Controller",
"email" : "s.eller@company.com",
"personalData" : {
"idNumber" : "12345"
},
"name" : {
"firstName" : "Shelly",
"lastName" : "Eller"
}
}
}
],
"taxId" : "taxid"
"taxId" : "123456"
}
}
}
},
"post-updateAccountHolder-addShareholders-200" : {
"summary" : "Added shareholder to existing account holder",
"value" : {
"pspReference" : "ALPHANUMERIC_UNIQUE_RESPONSE_REFERENCE",
"submittedAsync" : "false",
"accountHolderCode" : "YOUR_UNIQUE_ACCOUNT_HOLDER_CODE",
"accountHolderDetails" : {
"address" : {
"country" : "US"
},
"bankAccountDetails" : [
],
"businessDetails" : {
"doingBusinessAs" : "Real Good Restaurant",
"legalBusinessName" : "Real Good Restaurant Inc.",
"shareholders" : [
{
"ShareholderContact" : {
"email" : "s.eller@company.com",
"legalEntityId" : "SHAREHOLDER_LEGAL_ENTITY_ID",
"name" : {
"firstName" : "Shelly",
"lastName" : "Eller"
},
"personalData" : {
"idNumber" : "12345"
},
"shareholderCode" : "SHAREHOLDER_CODE",
"shareholderType" : "Controller"
}
}
],
"taxId" : "123456"
},
"email" : "test@company.com",
"legalEntityId" : "AH_LEGAL_ENTITY_ID",
"merchantCategoryCode" : "MCC_DEFAULT_VALUE",
"webAddress" : "https://www.your-website.com"
},
"accountHolderStatus" : {
"status" : "Active",
"processingState" : {
"disabled" : "false",
"processedFrom" : {
"currency" : "USD",
"value" : 0
},
"processedTo" : {
"currency" : "USD",
"value" : 0
},
"tierNumber" : 0
},
"payoutState" : {
"allowPayout" : "true",
"payoutLimit" : {
"currency" : "USD",
"value" : 0
},
"disabled" : "false",
"tierNumber" : 0
}
},
"invalidFields" : [
],
"legalEntity" : "Business",
"updatedFields" : [
],
"verification" : {
}
}
},
"post-updateAccountHolder-bankAccountDetails" : {
"summary" : "Update bank account details",
"value" : {
"accountHolderCode" : "CODE_OF_ACCOUNT_HOLDER",
"accountHolderCode" : "YOUR_UNIQUE_ACCOUNT_HOLDER_CODE",
"accountHolderDetails" : {
"email" : "tim@green.com",
"individualDetails" : {
"name" : {
"firstName" : "Tim",
"lastName" : "Green"
}
},
"bankAccountDetails" : [
{
"BankAccountDetail" : {
@@ -4480,38 +4680,187 @@
}
}
},
"post-updateAccountHolder-bankAccountDetails-200" : {
"summary" : "Bank account details updated",
"value" : {
"pspReference" : "ALPHANUMERIC_UNIQUE_RESPONSE_REFERENCE",
"submittedAsync" : "false",
"accountHolderCode" : "YOUR_UNIQUE_ACCOUNT_HOLDER_CODE",
"accountHolderDetails" : {
"address" : {
"city" : "Amsterdam",
"country" : "US",
"postalCode" : "12345",
"stateOrProvince" : "NH",
"street" : "Main Street"
},
"bankAccountDetails" : [
{
"BankAccountDetail" : {
"accountNumber" : "######6852",
"bankAccountUUID" : "BANK_ACCOUNT_UUID",
"branchCode" : "053101273",
"countryCode" : "US",
"currencyCode" : "USD",
"ownerCity" : "Springfield",
"ownerCountryCode" : "US",
"ownerHouseNumberOrName" : "100",
"ownerName" : "Tim Green",
"ownerPostalCode" : "02894",
"ownerState" : "AZ",
"ownerStreet" : "Main Street",
"primaryAccount" : "false"
}
}
],
"email" : "tim@green.com",
"individualDetails" : {
"name" : {
"firstName" : "Tim",
"lastName" : "Green"
},
"personalData" : {
"dateOfBirth" : "1970-01-01",
"idNumber" : "1234567890",
"nationality" : "NL"
}
},
"legalEntityId" : "LEGAL_ENTITY_ID",
"merchantCategoryCode" : "MCC_DEFAULT_VALUE",
"phoneNumber" : {
"phoneCountryCode" : "NL",
"phoneNumber" : "0612345678",
"phoneType" : "Mobile"
},
"webAddress" : "http://www.accountholderwebsite.com"
},
"accountHolderStatus" : {
"status" : "Active",
"processingState" : {
"disabled" : "false",
"processedFrom" : {
"currency" : "USD",
"value" : 100000
},
"processedTo" : {
"currency" : "USD",
"value" : 499999
},
"tierNumber" : 2
},
"payoutState" : {
"allowPayout" : "false",
"disabled" : "false"
}
},
"description" : "Description",
"invalidFields" : [
],
"legalEntity" : "Individual",
"updatedFields" : [
]
}
},
"post-updateAccountHolder-businessDetails" : {
"summary" : "Update business details",
"value" : {
"accountHolderCode" : "CODE_OF_ACCOUNT_HOLDER",
"accountHolderCode" : "YOUR_UNIQUE_ACCOUNT_HOLDER_CODE",
"accountHolderDetails" : {
"businessDetails" : {
"doingBusinessAs" : "Updated Company Name",
"legalBusinessName" : "Company Name B.V.",
"taxId" : "BV123456789"
}
}
}
},
"post-updateAccountHolder-businessDetails-200" : {
"summary" : "Business details updated",
"value" : {
"pspReference" : "ALPHANUMERIC_UNIQUE_RESPONSE_REFERENCE",
"submittedAsync" : "false",
"accountCode" : "UNIQUE_ACCOUNT_CODE",
"accountHolderCode" : "YOUR_UNIQUE_ACCOUNT_HOLDER_CODE",
"accountHolderDetails" : {
"address" : {
"country" : "US"
},
"bankAccountDetails" : [
],
"businessDetails" : {
"doingBusinessAs" : "Test company B.V.",
"legalBusinessName" : "Test company",
"doingBusinessAs" : "Update Company Name",
"legalBusinessName" : "Company Name B.V.",
"shareholders" : [
{
"ShareholderContact" : {
"address" : {
"city" : "Amsterdam",
"country" : "NL",
"houseNumberOrName" : "1",
"postalCode" : "1111AA",
"stateOrProvince" : "NH",
"street" : "Teststreet"
},
"email" : "testShareholder@adyen.com",
"email" : "testshareholder@adyen.com",
"legalEntityId" : "SHAREHOLDER_LEGAL_ENTITY_ID",
"name" : {
"firstName" : "TestFirstName",
"lastName" : "TestLastName"
}
"firstName" : "John",
"lastName" : "Carpenter"
},
"shareholderCode" : "SHAREHOLDER_CODE",
"shareholderType" : "Owner"
}
}
],
"taxId" : "BV123456789"
},
"email" : "test@adyen.com",
"email" : "test@company.com",
"legalEntityId" : "AH_LEGAL_ENTITY_ID",
"merchantCategoryCode" : "MCC_DEFAULT_VALUE",
"webAddress" : "https://www.your-website.com"
},
"accountHolderStatus" : {
"status" : "Active",
"processingState" : {
"disabled" : "false",
"processedFrom" : {
"currency" : "USD",
"value" : 0
},
"processedTo" : {
"currency" : "USD",
"value" : 0
},
"tierNumber" : 0
},
"payoutState" : {
"allowPayout" : "true",
"payoutLimit" : {
"currency" : "USD",
"value" : 0
},
"disabled" : "false",
"tierNumber" : 0
},
"events" : [
]
},
"invalidFields" : [
],
"legalEntity" : "Business",
"verification" : {
}
}
},
"post-updateAccountHolder-general" : {
"summary" : "Update multiple details of account holder",
"value" : {
"accountHolderCode" : "YOUR_UNIQUE_ACCOUNT_HOLDER_CODE",
"accountHolderDetails" : {
"address" : {
"city" : "Amsterdam",
"country" : "NL",
"postalCode" : "12345",
"stateOrProvince" : "NH",
"street" : "Main Street"
},
"bankAccountDetails" : [
],
"email" : "test@company.com",
"merchantCategoryCode" : "7999",
"phoneNumber" : {
"phoneCountryCode" : "NL",
"phoneNumber" : "0612345678",
@@ -4521,39 +4870,69 @@
}
}
},
"post-updateAccountHolder-general" : {
"summary" : "Update account holder details",
"post-updateAccountHolder-general-200" : {
"summary" : "Updated multiple details of account holder",
"value" : {
"accountHolderCode" : "CODE_OF_ACCOUNT_HOLDER",
"pspReference" : "ALPHANUMERIC_UNIQUE_RESPONSE_REFERENCE",
"submittedAsync" : "false",
"accountHolderCode" : "YOUR_UNIQUE_ACCOUNT_HOLDER_CODE",
"accountHolderDetails" : {
"address" : {
"city" : "Amsterdam",
"country" : "NL",
"postalCode" : "12345",
"stateOrProvince" : "NH",
"street" : "Teststreet 1"
"street" : "Main Street"
},
"bankAccountDetails" : [
],
"email" : "test@adyen.com",
"email" : "test@company.com",
"individualDetails" : {
"name" : {
"firstName" : "First name",
"lastName" : "Last Name"
},
"personalData" : {
"dateOfBirth" : "1970-01-01",
"idNumber" : "1234567890",
"nationality" : "NL"
"firstName" : "Tim",
"lastName" : "Green"
}
},
"merchantCategoryCode" : "7999",
"legalEntityId" : "LEGAL_ENTITY_ID",
"merchantCategoryCode" : "MCC_DEFAULT_VALUE",
"phoneNumber" : {
"phoneCountryCode" : "NL",
"phoneNumber" : "0612345678",
"phoneType" : "Mobile"
},
"webAddress" : "http://www.accountholderwebsite.com"
},
"accountHolderStatus" : {
"status" : "Active",
"processingState" : {
"disabled" : "false",
"processedFrom" : {
"currency" : "EUR",
"value" : 0
},
"processedTo" : {
"currency" : "EUR",
"value" : 0
},
"tierNumber" : 0
},
"payoutState" : {
"allowPayout" : "true",
"payoutLimit" : {
"currency" : "EUR",
"value" : 0
},
"disabled" : "false",
"tierNumber" : 0
}
},
"invalidFields" : [
],
"legalEntity" : "Individual",
"updatedFields" : [
],
"verification" : {
}
}
},

508
json/AccountService-v5.json
View File

@@ -10,27 +10,21 @@
"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" : "2023-05-30T15:27:20Z",
"termsOfService" : "https://www.adyen.com/legal/terms-and-conditions",
"contact" : {
"name" : "Adyen Developer Experience team",
"url" : "https://github.com/Adyen/adyen-openapi"
}
},
"x-groups" : [
"Account holders",
"Accounts",
"Verification"
],
"tags" : [
{
"name" : "Account holders"
},
{
"name" : "Verification"
"name" : "Accounts"
},
{
"name" : "Accounts"
"name" : "Verification"
}
],
"paths" : {
@@ -43,7 +37,6 @@
"description" : "Triggers the verification of an account holder even if the checks are not yet required for the volume that they are currently processing.",
"x-addedInVersion" : "5",
"operationId" : "post-checkAccountHolder",
"x-groupName" : "Verification",
"x-sortIndex" : 3,
"x-methodName" : "checkAccountHolder",
"security" : [
@@ -162,7 +155,6 @@
"summary" : "Close an account",
"description" : "Closes an account. If an account is closed, you cannot process transactions, pay out its funds, or reopen it. If payments are made to a closed account, the payments are sent to your liable account.",
"operationId" : "post-closeAccount",
"x-groupName" : "Accounts",
"x-sortIndex" : 3,
"x-methodName" : "closeAccount",
"security" : [
@@ -281,7 +273,6 @@
"summary" : "Close an account holder",
"description" : "Changes the [status of an account holder](https://docs.adyen.com/marketplaces-and-platforms/classic/account-holders-and-accounts#account-holder-statuses) to **Closed**. This state is final. If an account holder is closed, you can't process transactions, pay out funds, or reopen it. If payments are made to an account of an account holder with a **Closed** [`status`](https://docs.adyen.com/api-explorer/#/Account/latest/post/getAccountHolder__resParam_verification-accountHolder-checks-status), the payments are sent to your liable account.",
"operationId" : "post-closeAccountHolder",
"x-groupName" : "Account holders",
"x-sortIndex" : 7,
"x-methodName" : "closeAccountHolder",
"security" : [
@@ -401,7 +392,6 @@
"description" : "Closes stores associated with an account holder.",
"x-addedInVersion" : "5",
"operationId" : "post-closeStores",
"x-groupName" : "Account holders",
"x-sortIndex" : 9,
"x-methodName" : "closeStores",
"security" : [
@@ -505,7 +495,6 @@
"summary" : "Create an account",
"description" : "Creates an account under an account holder. An account holder can have [multiple accounts](https://docs.adyen.com/marketplaces-and-platforms/classic/account-holders-and-accounts#create-additional-accounts).",
"operationId" : "post-createAccount",
"x-groupName" : "Accounts",
"x-sortIndex" : 1,
"x-methodName" : "createAccount",
"security" : [
@@ -624,7 +613,6 @@
"summary" : "Create an account holder",
"description" : "Creates an account holder that [represents the sub-merchant's entity](https://docs.adyen.com/marketplaces-and-platforms/classic/account-structure#your-platform) in your platform. The details that you need to provide in the request depend on the sub-merchant's legal entity type. For more information, refer to [Account holder and accounts](https://docs.adyen.com/marketplaces-and-platforms/classic/account-holders-and-accounts#legal-entity-types).",
"operationId" : "post-createAccountHolder",
"x-groupName" : "Account holders",
"x-sortIndex" : 1,
"x-methodName" : "createAccountHolder",
"security" : [
@@ -658,6 +646,14 @@
"200" : {
"content" : {
"application/json" : {
"examples" : {
"business" : {
"$ref" : "#/components/examples/post-createAccountHolder-business-200"
},
"individual" : {
"$ref" : "#/components/examples/post-createAccountHolder-individual-200"
}
},
"schema" : {
"$ref" : "#/components/schemas/CreateAccountHolderResponse"
}
@@ -736,7 +732,6 @@
"summary" : "Delete bank accounts",
"description" : "Deletes bank accounts associated with an account holder. ",
"operationId" : "post-deleteBankAccounts",
"x-groupName" : "Verification",
"x-sortIndex" : 4,
"x-methodName" : "deleteBankAccounts",
"security" : [
@@ -855,7 +850,6 @@
"summary" : "Delete legal arrangements",
"description" : "Deletes legal arrangements and/or legal arrangement entities associated with an account holder.",
"operationId" : "post-deleteLegalArrangements",
"x-groupName" : "Verification",
"x-sortIndex" : 6,
"x-methodName" : "deleteLegalArrangements",
"security" : [
@@ -992,7 +986,6 @@
"description" : "Deletes payout methods associated with an account holder.",
"x-addedInVersion" : "5",
"operationId" : "post-deletePayoutMethods",
"x-groupName" : "Verification",
"x-sortIndex" : 5,
"x-methodName" : "deletePayoutMethods",
"security" : [
@@ -1111,7 +1104,6 @@
"summary" : "Delete shareholders",
"description" : "Deletes shareholders associated with an account holder.",
"operationId" : "post-deleteShareholders",
"x-groupName" : "Verification",
"x-sortIndex" : 7,
"x-methodName" : "deleteShareholders",
"security" : [
@@ -1230,7 +1222,6 @@
"summary" : "Delete signatories",
"description" : "Deletes signatories associated with an account holder.",
"operationId" : "post-deleteSignatories",
"x-groupName" : "Verification",
"x-sortIndex" : 8,
"x-methodName" : "deleteSignatories",
"security" : [
@@ -1344,7 +1335,6 @@
"summary" : "Get an account holder",
"description" : "Returns the details of an account holder.",
"operationId" : "post-getAccountHolder",
"x-groupName" : "Account holders",
"x-sortIndex" : 2,
"x-methodName" : "getAccountHolder",
"security" : [
@@ -1466,7 +1456,6 @@
"summary" : "Get a tax form",
"description" : "Generates a tax form for account holders operating in the US. For more information, refer to [Providing tax forms](https://docs.adyen.com/marketplaces-and-platforms/classic/tax-forms).",
"operationId" : "post-getTaxForm",
"x-groupName" : "Account holders",
"x-sortIndex" : 8,
"x-methodName" : "getTaxForm",
"security" : [
@@ -1575,7 +1564,6 @@
"summary" : "Get documents",
"description" : "Returns documents that were previously uploaded for an account holder. Adyen uses the documents during the [verification process](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process).\n",
"operationId" : "post-getUploadedDocuments",
"x-groupName" : "Verification",
"x-sortIndex" : 2,
"x-methodName" : "getUploadedDocuments",
"security" : [
@@ -1684,7 +1672,6 @@
"summary" : "Suspend an account holder",
"description" : "Changes the [status of an account holder](https://docs.adyen.com/marketplaces-and-platforms/classic/account-holders-and-accounts#account-holder-statuses) to **Suspended**.",
"operationId" : "post-suspendAccountHolder",
"x-groupName" : "Account holders",
"x-sortIndex" : 5,
"x-methodName" : "suspendAccountHolder",
"security" : [
@@ -1803,7 +1790,6 @@
"summary" : "Unsuspend an account holder",
"description" : "Changes the [status of an account holder](https://docs.adyen.com/marketplaces-and-platforms/classic/account-holders-and-accounts#account-holder-statuses) from **Suspended** to **Inactive**. \nAccount holders can have a **Suspended** [`status`](https://docs.adyen.com/api-explorer/#/Account/latest/post/getAccountHolder__resParam_verification-accountHolder-checks-status) if you suspend them through the [`/suspendAccountHolder`](https://docs.adyen.com/api-explorer/#/Account/v5/post/suspendAccountHolder) endpoint or if a verification deadline expires.\n\nYou can only unsuspend account holders if they do not have verification checks with a **FAILED** [`status`](https://docs.adyen.com/api-explorer/#/Account/latest/post/getAccountHolder__resParam_verification-accountHolder-checks-status).",
"operationId" : "post-unSuspendAccountHolder",
"x-groupName" : "Account holders",
"x-sortIndex" : 6,
"x-methodName" : "unSuspendAccountHolder",
"security" : [
@@ -1922,7 +1908,6 @@
"summary" : "Update an account",
"description" : "Updates the description or payout schedule of an account.",
"operationId" : "post-updateAccount",
"x-groupName" : "Accounts",
"x-sortIndex" : 2,
"x-methodName" : "updateAccount",
"security" : [
@@ -2041,7 +2026,6 @@
"summary" : "Update an account holder",
"description" : "Updates the `accountHolderDetails` and `processingTier` of an account holder, and adds bank accounts and shareholders.\n\nWhen updating `accountHolderDetails`, parameters that are not included in the request are left unchanged except for the following object:\n\n* `metadata`: Updating the metadata replaces the entire object. This means that to update an existing key-value pair, you must provide the changes, as well as other existing key-value pairs.\n\nWhen updating any field in the following objects, you must submit all the fields required for validation:\n\n * `address`\n\n* `fullPhoneNumber`\n\n* `bankAccountDetails.BankAccountDetail`\n\n* `businessDetails.shareholders.ShareholderContact`\n\n For example, to update the `address.postalCode`, you must also submit the `address.country`, `.city`, `.street`, `.postalCode`, and possibly `.stateOrProvince` so that the address can be validated.\n\nTo add a bank account or shareholder, provide the bank account or shareholder details without a `bankAccountUUID` or a `shareholderCode`.\n\n",
"operationId" : "post-updateAccountHolder",
"x-groupName" : "Account holders",
"x-sortIndex" : 3,
"x-methodName" : "updateAccountHolder",
"security" : [
@@ -2081,6 +2065,20 @@
"200" : {
"content" : {
"application/json" : {
"examples" : {
"addShareholders" : {
"$ref" : "#/components/examples/post-updateAccountHolder-addShareholders-200"
},
"bankAccountDetails" : {
"$ref" : "#/components/examples/post-updateAccountHolder-bankAccountDetails-200"
},
"businessDetails" : {
"$ref" : "#/components/examples/post-updateAccountHolder-businessDetails-200"
},
"general" : {
"$ref" : "#/components/examples/post-updateAccountHolder-general-200"
}
},
"schema" : {
"$ref" : "#/components/schemas/UpdateAccountHolderResponse"
}
@@ -2169,7 +2167,6 @@
"summary" : "Update payout or processing state",
"description" : "Disables or enables the processing or payout state of an account holder.",
"operationId" : "post-updateAccountHolderState",
"x-groupName" : "Account holders",
"x-sortIndex" : 4,
"x-methodName" : "updateAccountHolderState",
"security" : [
@@ -2288,7 +2285,6 @@
"summary" : "Upload a document",
"description" : "Uploads a document for an account holder. Adyen uses the documents during the [verification process](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process).",
"operationId" : "post-uploadDocument",
"x-groupName" : "Verification",
"x-sortIndex" : 1,
"x-methodName" : "uploadDocument",
"security" : [
@@ -3080,7 +3076,7 @@
"type" : "string"
},
"payoutSchedule" : {
"description" : "The payout schedule of the prospective account.\n>Permitted values: `DEFAULT`, `HOLD`, `DAILY`, `WEEKLY`, `MONTHLY`.",
"description" : "The payout schedule for the account.\n\nPossible values: `DEFAULT`, `DAILY`, `DAILY_US`, `DAILY_EU`, `DAILY_AU`, `DAILY_SG`, `WEEKLY`, `WEEKLY_ON_TUE_FRI_MIDNIGHT`, `BIWEEKLY_ON_1ST_AND_15TH_AT_MIDNIGHT`, `MONTHLY`, `HOLD`.\n> `HOLD` prevents scheduled payouts, but you can still initiate payouts manually.",
"enum" : [
"BIWEEKLY_ON_1ST_AND_15TH_AT_MIDNIGHT",
"DAILY",
@@ -3101,13 +3097,13 @@
"type" : "string"
},
"payoutScheduleReason" : {
"description" : "The reason for the payout schedule choice.\n>Required if the payoutSchedule is `HOLD`.",
"description" : "The reason for the payout schedule choice.\n> This field is required when the `payoutSchedule` parameter is set to `HOLD`.",
"type" : "string"
},
"payoutSpeed" : {
"x-addedInVersion" : "5",
"default" : "STANDARD",
"description" : "Speed with which payouts for this account are processed. Permitted values: `STANDARD`, `SAME_DAY`.",
"description" : "Speed at which payouts for this account are processed.\n\nPossible values: `STANDARD` (default), `SAME_DAY`.",
"enum" : [
"INSTANT",
"SAME_DAY",
@@ -3163,7 +3159,7 @@
"type" : "string"
},
"payoutSchedule" : {
"description" : "The payout schedule of the account.",
"description" : "The details of the payout schedule added to the account.",
"$ref" : "#/components/schemas/PayoutScheduleResponse"
},
"payoutSpeed" : {
@@ -3461,6 +3457,7 @@
"legalBusinessName",
"legalEntity",
"legalEntityType",
"linkedViasVirtualAccount",
"logo",
"merchantAccount",
"merchantCategoryCode",
@@ -4012,12 +4009,12 @@
},
"MigratedAccounts" : {
"properties" : {
"balanceAccountId" : {
"description" : "The unique identifier of the account of the migrated account holder in the balance platform.",
"accountCode" : {
"description" : "The unique identifier of the account of the migrated account holder in the classic integration.",
"type" : "string"
},
"virtualAccountCode" : {
"description" : "The unique identifier of the account of the migrated account holder in the classic integration.",
"balanceAccountId" : {
"description" : "The unique identifier of the account of the migrated account holder in the balance platform.",
"type" : "string"
}
},
@@ -4138,7 +4135,7 @@
"type" : "string"
},
"schedule" : {
"description" : "The payout schedule of the account.\nPermitted values: `DEFAULT`, `DAILY`, `DAILY_US`, `DAILY_EU`, `DAILY_AU`, `DAILY_SG`, `WEEKLY`, `WEEKLY_ON_TUE_FRI_MIDNIGHT`, `BIWEEKLY_ON_1ST_AND_15TH_AT_MIDNIGHT`, `MONTHLY`, `HOLD`.",
"description" : "The payout schedule for the account.\n\nPossible values: `DEFAULT`, `DAILY`, `DAILY_US`, `DAILY_EU`, `DAILY_AU`, `DAILY_SG`, `WEEKLY`, `WEEKLY_ON_TUE_FRI_MIDNIGHT`, `BIWEEKLY_ON_1ST_AND_15TH_AT_MIDNIGHT`, `MONTHLY`, `HOLD`.\n> `HOLD` prevents scheduled payouts, but you can still initiate payouts manually.",
"enum" : [
"BIWEEKLY_ON_1ST_AND_15TH_AT_MIDNIGHT",
"DAILY",
@@ -4417,7 +4414,7 @@
"type" : "string"
},
"storeName" : {
"description" : "The name of the account holder's store. This value is shown in shopper statements.\n\n* Length: Between 3 to 22 characters \n\n* The following characters are *not* supported: **:;}{$#@!|<>%^*+=\\\\**",
"description" : "The name of the account holder's store. This value is shown in shopper statements.\n\n * Length: Between 3 to 22 characters \n\n * The following characters are *not* supported: **:;}{$#@!|<>%^*+=\\\\**\n\n**Note:** storeName does not appear in American Express shopper statements by default. Contact Adyen Support to enable this for American Express.",
"type" : "string"
},
"storeReference" : {
@@ -4725,12 +4722,12 @@
"type" : "string"
},
"payoutSchedule" : {
"description" : "The details of the payout schedule, to which the account should be updated.",
"description" : "The details of the payout schedule to which the account must be updated.",
"$ref" : "#/components/schemas/UpdatePayoutScheduleRequest"
},
"payoutSpeed" : {
"x-addedInVersion" : "5",
"description" : "Speed with which payouts for this account are processed. Permitted values: `STANDARD`, `SAME_DAY`.",
"description" : "Speed at which payouts for this account are processed.\n\nPossible values: `STANDARD` (default), `SAME_DAY`.",
"enum" : [
"INSTANT",
"SAME_DAY",
@@ -4782,12 +4779,12 @@
"type" : "string"
},
"payoutSchedule" : {
"description" : "The payout schedule of the account.",
"description" : "The details of the payout schedule to which the account is updated.",
"$ref" : "#/components/schemas/PayoutScheduleResponse"
},
"payoutSpeed" : {
"x-addedInVersion" : "5",
"description" : "Speed with which payouts for this account are processed. Permitted values: `STANDARD`, `SAME_DAY`.",
"description" : "Speed at which payouts for this account are processed.\n\nPossible values: `STANDARD`, `SAME_DAY`.",
"enum" : [
"INSTANT",
"SAME_DAY",
@@ -4812,7 +4809,7 @@
"UpdatePayoutScheduleRequest" : {
"properties" : {
"action" : {
"description" : "Direction on how to handle any payouts that have already been scheduled.\nPermitted values:\n* `CLOSE` will close the existing batch of payouts.\n* `UPDATE` will reschedule the existing batch to the new schedule.\n* `NOTHING` (**default**) will allow the payout to proceed.",
"description" : "Direction on how to handle any payouts that have already been scheduled.\n\nPossible values:\n* `CLOSE`: close the existing batch of payouts.\n* `UPDATE`: reschedule the existing batch to the new schedule.\n* `NOTHING` (**default**): allow the payout to proceed.",
"enum" : [
"CLOSE",
"NOTHING",
@@ -4825,7 +4822,7 @@
"type" : "string"
},
"schedule" : {
"description" : "The payout schedule to which the account is to be updated.\nPermitted values: `DAILY`, `DAILY_US`, `DAILY_EU`, `DAILY_AU`, `DAILY_SG`, `WEEKLY`, `WEEKLY_ON_TUE_FRI_MIDNIGHT`, `BIWEEKLY_ON_1ST_AND_15TH_AT_MIDNIGHT`, `MONTHLY`, `HOLD`.\n`HOLD` will prevent scheduled payouts from happening but will still allow manual payouts to occur.",
"description" : "The new payout schedule for the account.\n\nPossible values: `DEFAULT`, `DAILY`, `DAILY_US`, `DAILY_EU`, `DAILY_AU`, `DAILY_SG`, `WEEKLY`, `WEEKLY_ON_TUE_FRI_MIDNIGHT`, `BIWEEKLY_ON_1ST_AND_15TH_AT_MIDNIGHT`, `MONTHLY`, `HOLD`.\n> `HOLD` prevents scheduled payouts, but you can still initiate payouts manually.",
"enum" : [
"BIWEEKLY_ON_1ST_AND_15TH_AT_MIDNIGHT",
"DAILY",
@@ -5000,7 +4997,7 @@
}
},
"generic-403" : {
"summary" : "Response code 401. Forbidden.",
"summary" : "Response code 403. Forbidden.",
"value" : {
"status" : 403,
"errorCode" : "10_003",
@@ -5035,7 +5032,7 @@
}
},
"post-createAccountHolder-business" : {
"summary" : "Create a business account holder",
"summary" : "Create business account holder",
"value" : {
"accountHolderCode" : "YOUR_UNIQUE_ACCOUNT_HOLDER_CODE",
"accountHolderDetails" : {
@@ -5047,6 +5044,7 @@
"legalBusinessName" : "Real Good Restaurant Inc.",
"shareholders" : [
{
"shareholderType" : "Controller",
"name" : {
"firstName" : "John",
"lastName" : "Carpenter"
@@ -5064,10 +5062,79 @@
"legalEntity" : "Business"
}
},
"post-createAccountHolder-individual" : {
"summary" : "Create an individual account holder",
"post-createAccountHolder-business-200" : {
"summary" : "Business account holder created",
"value" : {
"accountHolderCode" : "GENERATE_CODE",
"pspReference" : "ALPHANUMERIC_UNIQUE_RESPONSE_REFERENCE",
"accountHolderCode" : "YOUR_UNIQUE_ACCOUNT_HOLDER_CODE",
"accountHolderDetails" : {
"address" : {
"country" : "US"
},
"bankAccountDetails" : [
],
"businessDetails" : {
"doingBusinessAs" : "Real Good Restaurant",
"legalBusinessName" : "Real Good Restaurant Inc.",
"shareholders" : [
{
"address" : {
"country" : "NL"
},
"email" : "testshareholder@email.com",
"name" : {
"firstName" : "John",
"lastName" : "Carpenter"
},
"shareholderCode" : "SHAREHOLDER_CODE",
"shareholderType" : "Controller"
}
]
},
"email" : "test@email.com",
"merchantCategoryCode" : "MCC_DEFAULT_VALUE",
"payoutMethods" : [
],
"webAddress" : "https://www.your-website.com"
},
"accountHolderStatus" : {
"status" : "Active",
"processingState" : {
"disabled" : false,
"processedFrom" : {
"currency" : "USD",
"value" : 0
},
"processedTo" : {
"currency" : "USD",
"value" : 0
},
"tierNumber" : 0
},
"payoutState" : {
"allowPayout" : true,
"payoutLimit" : {
"currency" : "USD",
"value" : 0
},
"disabled" : false,
"tierNumber" : 0
},
"events" : [
]
},
"legalEntity" : "Business",
"invalidFields" : [
],
"verification" : {
}
}
},
"post-createAccountHolder-individual" : {
"summary" : "Create individual account holder",
"value" : {
"accountHolderCode" : "YOUR_UNIQUE_ACCOUNT_HOLDER_CODE",
"accountHolderDetails" : {
"email" : "tim@green.com",
"individualDetails" : {
@@ -5084,6 +5151,63 @@
"legalEntity" : "Individual"
}
},
"post-createAccountHolder-individual-200" : {
"summary" : "Individual account holder created",
"value" : {
"pspReference" : "ALPHANUMERIC_UNIQUE_RESPONSE_REFERENCE",
"accountHolderCode" : "YOUR_UNIQUE_ACCOUNT_HOLDER_CODE",
"accountHolderDetails" : {
"address" : {
"country" : "US"
},
"bankAccountDetails" : [
],
"email" : "tim@green.com",
"individualDetails" : {
"name" : {
"firstName" : "Tim",
"lastName" : "Green"
}
},
"merchantCategoryCode" : "5045",
"payoutMethods" : [
],
"webAddress" : "https://www.your-website.com"
},
"accountHolderStatus" : {
"status" : "Active",
"processingState" : {
"disabled" : false,
"processedFrom" : {
"currency" : "USD",
"value" : 0
},
"processedTo" : {
"currency" : "USD",
"value" : 0
},
"tierNumber" : 0
},
"payoutState" : {
"allowPayout" : true,
"payoutLimit" : {
"currency" : "USD",
"value" : 0
},
"disabled" : false,
"tierNumber" : 0
},
"events" : [
]
},
"legalEntity" : "Individual",
"invalidFields" : [
],
"verification" : {
}
}
},
"post-deleteBankAccounts-basic" : {
"summary" : "Delete bank accounts",
"value" : {
@@ -5243,9 +5367,10 @@
"businessDetails" : {
"shareholders" : [
{
"shareholderType" : "Controller",
"name" : {
"firstName" : "Alice",
"lastName" : "Fields"
"firstName" : "Shelly",
"lastName" : "Eller"
},
"address" : {
"city" : "San Francisco",
@@ -5275,10 +5400,58 @@
}
}
},
"post-updateAccountHolder-addShareholders-200" : {
"summary" : "Shareholders added",
"value" : {
"invalidFields" : [
],
"pspReference" : "ALPHANUMERIC_UNIQUE_RESPONSE_REFERENCE",
"accountHolderCode" : "YOUR_UNIQUE_ACCOUNT_HOLDER_CODE",
"accountHolderDetails" : {
"bankAccountDetails" : [
],
"businessDetails" : {
"shareholders" : [
{
"address" : {
"city" : "San Francisco",
"country" : "US",
"houseNumberOrName" : "274",
"postalCode" : "94107",
"stateOrProvince" : "CA",
"street" : "Brannan"
},
"email" : "testshareholder2@email.com",
"name" : {
"firstName" : "Shelly",
"lastName" : "Eller"
},
"personalData" : {
"dateOfBirth" : "1970-01-01",
"documentData" : [
{
"number" : "1234567890",
"type" : "ID"
}
]
},
"shareholderCode" : "SHAREHOLDER_CODE",
"shareholderType" : "Controller"
}
],
"taxId" : "123456789"
},
"email" : "test@email.com",
"payoutMethods" : [
],
"webAddress" : "http://www.accountholderwebsite.com"
}
}
},
"post-updateAccountHolder-bankAccountDetails" : {
"summary" : "Update bank account details",
"value" : {
"accountHolderCode" : "CODE_OF_ACCOUNT_HOLDER",
"accountHolderCode" : "YOUR_UNIQUE_ACCOUNT_HOLDER_CODE",
"accountHolderDetails" : {
"email" : "tim@green.com",
"individualDetails" : {
@@ -5305,26 +5478,109 @@
}
}
},
"post-updateAccountHolder-bankAccountDetails-200" : {
"summary" : "Bank account details updated",
"value" : {
"invalidFields" : [
],
"pspReference" : "ALPHANUMERIC_UNIQUE_RESPONSE_REFERENCE",
"accountHolderCode" : "YOUR_UNIQUE_ACCOUNT_HOLDER_CODE",
"accountHolderDetails" : {
"address" : {
"country" : "US"
},
"bankAccountDetails" : [
{
"accountNumber" : "######6852",
"bankAccountUUID" : "BANK_ACCOUNT_UUID",
"branchCode" : "053101273",
"countryCode" : "US",
"currencyCode" : "USD",
"ownerCity" : "Springfield",
"ownerCountryCode" : "US",
"ownerHouseNumberOrName" : "100",
"ownerName" : "Tim Green",
"ownerPostalCode" : "02894",
"ownerState" : "AZ",
"ownerStreet" : "Main Street",
"primaryAccount" : false
}
],
"businessDetails" : {
"doingBusinessAs" : "Real Good Restaurant",
"legalBusinessName" : "Real Good Restaurant Inc.",
"shareholders" : [
{
"address" : {
"country" : "NL"
},
"email" : "testshareholder@email.com",
"name" : {
"firstName" : "John",
"lastName" : "Carpenter"
},
"shareholderCode" : "SHAREHOLDER_CODE",
"shareholderType" : "Controller"
}
]
},
"email" : "tim@green.com",
"merchantCategoryCode" : "MCC_DEFAULT_VALUE",
"payoutMethods" : [
],
"webAddress" : "https://www.your-website.com"
},
"accountHolderStatus" : {
"status" : "Active",
"processingState" : {
"disabled" : false,
"processedFrom" : {
"currency" : "USD",
"value" : 0
},
"processedTo" : {
"currency" : "USD",
"value" : 0
},
"tierNumber" : 0
},
"payoutState" : {
"allowPayout" : true,
"payoutLimit" : {
"currency" : "USD",
"value" : 0
},
"disabled" : false,
"tierNumber" : 0
}
},
"legalEntity" : "Business",
"verification" : {
}
}
},
"post-updateAccountHolder-businessDetails" : {
"summary" : "Update business details",
"value" : {
"accountHolderCode" : "CODE_OF_ACCOUNT_HOLDER",
"accountHolderCode" : "YOUR_UNIQUE_ACCOUNT_HOLDER_CODE",
"accountHolderDetails" : {
"businessDetails" : {
"shareholders" : [
{
"shareholderType" : "Owner",
"address" : {
"city" : "Amsterdam",
"country" : "NL",
"houseNumberOrName" : "1",
"postalCode" : "1111AA",
"stateOrProvince" : "NH",
"street" : "Awesome St"
"street" : "Main Street"
},
"email" : "testshareholder2@email.com",
"name" : {
"firstName" : "Alice",
"lastName" : "Fields"
"firstName" : "Shelly",
"lastName" : "Eller"
}
}
],
@@ -5336,42 +5592,142 @@
}
}
},
"post-updateAccountHolder-general" : {
"summary" : "Update account holder details",
"post-updateAccountHolder-businessDetails-200" : {
"summary" : "Business details updated",
"value" : {
"accountHolderCode" : "CODE_OF_ACCOUNT_HOLDER",
"invalidFields" : [
],
"pspReference" : "ALPHANUMERIC_UNIQUE_RESPONSE_REFERENCE",
"accountHolderCode" : "YOUR_UNIQUE_ACCOUNT_HOLDER_CODE",
"accountHolderDetails" : {
"bankAccountDetails" : [
],
"businessDetails" : {
"shareholders" : [
{
"address" : {
"city" : "Amsterdam",
"country" : "NL",
"houseNumberOrName" : "1",
"postalCode" : "1111AA",
"stateOrProvince" : "NH",
"street" : "Main Street"
},
"email" : "testshareholder2@email.com",
"name" : {
"firstName" : "Shelly",
"lastName" : "Eller"
},
"shareholderCode" : "SHAREHOLDER_CODE",
"shareholderType" : "Owner"
}
],
"taxId" : "BV123456789"
},
"email" : "test@email.com",
"payoutMethods" : [
],
"webAddress" : "http://www.accountholderwebsite.com"
}
}
},
"post-updateAccountHolder-general" : {
"summary" : "Update individual with documentData property",
"value" : {
"accountHolderCode" : "YOUR_UNIQUE_ACCOUNT_HOLDER_CODE",
"accountHolderDetails" : {
"address" : {
"city" : "NY",
"country" : "US",
"postalCode" : "12345",
"stateOrProvince" : "NH",
"street" : "Teststreet 1",
"street" : "Main Street",
"houseNumberOrName" : "100"
},
"email" : "test@adyen.com",
"individualDetails" : {
"name" : {
"firstName" : "Simon",
"lastName" : "Hopper"
},
"personalData" : {
"dateOfBirth" : "1970-01-01",
"documentData" : [
{
"number" : "1234567890",
"type" : "ID"
}
],
"nationality" : "NL"
}
},
"merchantCategoryCode" : "7999",
"fullPhoneNumber" : "+31612345678",
"webAddress" : "http://www.accountholderwebsite.com"
}
}
},
"post-updateAccountHolder-general-200" : {
"summary" : "Individual updated with documentData property",
"value" : {
"invalidFields" : [
],
"pspReference" : "ALPHANUMERIC_UNIQUE_RESPONSE_REFERENCE",
"accountHolderCode" : "YOUR_UNIQUE_ACCOUNT_HOLDER_CODE",
"accountHolderDetails" : {
"address" : {
"city" : "NY",
"country" : "US",
"houseNumberOrName" : "100",
"postalCode" : "12345",
"stateOrProvince" : "NH",
"street" : "Main Street"
},
"bankAccountDetails" : [
],
"businessDetails" : {
"doingBusinessAs" : "Real Good Restaurant",
"legalBusinessName" : "Real Good Restaurant Inc.",
"shareholders" : [
{
"address" : {
"country" : "NL"
},
"email" : "testshareholder@email.com",
"name" : {
"firstName" : "John",
"lastName" : "Carpenter"
},
"shareholderCode" : "SHAREHOLDER_CODE",
"shareholderType" : "Controller"
}
]
},
"email" : "test@adyen.com",
"merchantCategoryCode" : "UPDATE_MCC",
"payoutMethods" : [
],
"phoneNumber" : {
"phoneCountryCode" : "NL",
"phoneNumber" : "612345678",
"phoneType" : "Landline"
},
"webAddress" : "http://www.accountholderwebsite.com"
},
"accountHolderStatus" : {
"status" : "Active",
"processingState" : {
"disabled" : false,
"processedFrom" : {
"currency" : "USD",
"value" : 0
},
"processedTo" : {
"currency" : "USD",
"value" : 0
},
"tierNumber" : 0
},
"payoutState" : {
"allowPayout" : true,
"payoutLimit" : {
"currency" : "USD",
"value" : 0
},
"disabled" : false,
"tierNumber" : 0
}
},
"legalEntity" : "Business",
"verification" : {
}
}
},
"post-updateAccountHolderState-basic" : {
"summary" : "Update account holder state",
"value" : {

508
json/AccountService-v6.json
View File

@@ -10,27 +10,21 @@
"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" : "2023-05-30T15:27:20Z",
"termsOfService" : "https://www.adyen.com/legal/terms-and-conditions",
"contact" : {
"name" : "Adyen Developer Experience team",
"url" : "https://github.com/Adyen/adyen-openapi"
}
},
"x-groups" : [
"Account holders",
"Accounts",
"Verification"
],
"tags" : [
{
"name" : "Account holders"
},
{
"name" : "Verification"
"name" : "Accounts"
},
{
"name" : "Accounts"
"name" : "Verification"
}
],
"paths" : {
@@ -43,7 +37,6 @@
"description" : "Triggers the verification of an account holder even if the checks are not yet required for the volume that they are currently processing.",
"x-addedInVersion" : "5",
"operationId" : "post-checkAccountHolder",
"x-groupName" : "Verification",
"x-sortIndex" : 3,
"x-methodName" : "checkAccountHolder",
"security" : [
@@ -162,7 +155,6 @@
"summary" : "Close an account",
"description" : "Closes an account. If an account is closed, you cannot process transactions, pay out its funds, or reopen it. If payments are made to a closed account, the payments are sent to your liable account.",
"operationId" : "post-closeAccount",
"x-groupName" : "Accounts",
"x-sortIndex" : 3,
"x-methodName" : "closeAccount",
"security" : [
@@ -281,7 +273,6 @@
"summary" : "Close an account holder",
"description" : "Changes the [status of an account holder](https://docs.adyen.com/marketplaces-and-platforms/classic/account-holders-and-accounts#account-holder-statuses) to **Closed**. This state is final. If an account holder is closed, you can't process transactions, pay out funds, or reopen it. If payments are made to an account of an account holder with a **Closed** [`status`](https://docs.adyen.com/api-explorer/#/Account/latest/post/getAccountHolder__resParam_verification-accountHolder-checks-status), the payments are sent to your liable account.",
"operationId" : "post-closeAccountHolder",
"x-groupName" : "Account holders",
"x-sortIndex" : 7,
"x-methodName" : "closeAccountHolder",
"security" : [
@@ -401,7 +392,6 @@
"description" : "Closes stores associated with an account holder.",
"x-addedInVersion" : "5",
"operationId" : "post-closeStores",
"x-groupName" : "Account holders",
"x-sortIndex" : 9,
"x-methodName" : "closeStores",
"security" : [
@@ -505,7 +495,6 @@
"summary" : "Create an account",
"description" : "Creates an account under an account holder. An account holder can have [multiple accounts](https://docs.adyen.com/marketplaces-and-platforms/classic/account-holders-and-accounts#create-additional-accounts).",
"operationId" : "post-createAccount",
"x-groupName" : "Accounts",
"x-sortIndex" : 1,
"x-methodName" : "createAccount",
"security" : [
@@ -624,7 +613,6 @@
"summary" : "Create an account holder",
"description" : "Creates an account holder that [represents the sub-merchant's entity](https://docs.adyen.com/marketplaces-and-platforms/classic/account-structure#your-platform) in your platform. The details that you need to provide in the request depend on the sub-merchant's legal entity type. For more information, refer to [Account holder and accounts](https://docs.adyen.com/marketplaces-and-platforms/classic/account-holders-and-accounts#legal-entity-types).",
"operationId" : "post-createAccountHolder",
"x-groupName" : "Account holders",
"x-sortIndex" : 1,
"x-methodName" : "createAccountHolder",
"security" : [
@@ -658,6 +646,14 @@
"200" : {
"content" : {
"application/json" : {
"examples" : {
"business" : {
"$ref" : "#/components/examples/post-createAccountHolder-business-200"
},
"individual" : {
"$ref" : "#/components/examples/post-createAccountHolder-individual-200"
}
},
"schema" : {
"$ref" : "#/components/schemas/CreateAccountHolderResponse"
}
@@ -736,7 +732,6 @@
"summary" : "Delete bank accounts",
"description" : "Deletes bank accounts associated with an account holder. ",
"operationId" : "post-deleteBankAccounts",
"x-groupName" : "Verification",
"x-sortIndex" : 4,
"x-methodName" : "deleteBankAccounts",
"security" : [
@@ -855,7 +850,6 @@
"summary" : "Delete legal arrangements",
"description" : "Deletes legal arrangements and/or legal arrangement entities associated with an account holder.",
"operationId" : "post-deleteLegalArrangements",
"x-groupName" : "Verification",
"x-sortIndex" : 6,
"x-methodName" : "deleteLegalArrangements",
"security" : [
@@ -992,7 +986,6 @@
"description" : "Deletes payout methods associated with an account holder.",
"x-addedInVersion" : "5",
"operationId" : "post-deletePayoutMethods",
"x-groupName" : "Verification",
"x-sortIndex" : 5,
"x-methodName" : "deletePayoutMethods",
"security" : [
@@ -1111,7 +1104,6 @@
"summary" : "Delete shareholders",
"description" : "Deletes shareholders associated with an account holder.",
"operationId" : "post-deleteShareholders",
"x-groupName" : "Verification",
"x-sortIndex" : 7,
"x-methodName" : "deleteShareholders",
"security" : [
@@ -1230,7 +1222,6 @@
"summary" : "Delete signatories",
"description" : "Deletes signatories associated with an account holder.",
"operationId" : "post-deleteSignatories",
"x-groupName" : "Verification",
"x-sortIndex" : 8,
"x-methodName" : "deleteSignatories",
"security" : [
@@ -1344,7 +1335,6 @@
"summary" : "Get an account holder",
"description" : "Returns the details of an account holder.",
"operationId" : "post-getAccountHolder",
"x-groupName" : "Account holders",
"x-sortIndex" : 2,
"x-methodName" : "getAccountHolder",
"security" : [
@@ -1466,7 +1456,6 @@
"summary" : "Get a tax form",
"description" : "Generates a tax form for account holders operating in the US. For more information, refer to [Providing tax forms](https://docs.adyen.com/marketplaces-and-platforms/classic/tax-forms).",
"operationId" : "post-getTaxForm",
"x-groupName" : "Account holders",
"x-sortIndex" : 8,
"x-methodName" : "getTaxForm",
"security" : [
@@ -1575,7 +1564,6 @@
"summary" : "Get documents",
"description" : "Returns documents that were previously uploaded for an account holder. Adyen uses the documents during the [verification process](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process).\n",
"operationId" : "post-getUploadedDocuments",
"x-groupName" : "Verification",
"x-sortIndex" : 2,
"x-methodName" : "getUploadedDocuments",
"security" : [
@@ -1684,7 +1672,6 @@
"summary" : "Suspend an account holder",
"description" : "Changes the [status of an account holder](https://docs.adyen.com/marketplaces-and-platforms/classic/account-holders-and-accounts#account-holder-statuses) to **Suspended**.",
"operationId" : "post-suspendAccountHolder",
"x-groupName" : "Account holders",
"x-sortIndex" : 5,
"x-methodName" : "suspendAccountHolder",
"security" : [
@@ -1803,7 +1790,6 @@
"summary" : "Unsuspend an account holder",
"description" : "Changes the [status of an account holder](https://docs.adyen.com/marketplaces-and-platforms/classic/account-holders-and-accounts#account-holder-statuses) from **Suspended** to **Inactive**. \nAccount holders can have a **Suspended** [`status`](https://docs.adyen.com/api-explorer/#/Account/latest/post/getAccountHolder__resParam_verification-accountHolder-checks-status) if you suspend them through the [`/suspendAccountHolder`](https://docs.adyen.com/api-explorer/#/Account/v5/post/suspendAccountHolder) endpoint or if a verification deadline expires.\n\nYou can only unsuspend account holders if they do not have verification checks with a **FAILED** [`status`](https://docs.adyen.com/api-explorer/#/Account/latest/post/getAccountHolder__resParam_verification-accountHolder-checks-status).",
"operationId" : "post-unSuspendAccountHolder",
"x-groupName" : "Account holders",
"x-sortIndex" : 6,
"x-methodName" : "unSuspendAccountHolder",
"security" : [
@@ -1922,7 +1908,6 @@
"summary" : "Update an account",
"description" : "Updates the description or payout schedule of an account.",
"operationId" : "post-updateAccount",
"x-groupName" : "Accounts",
"x-sortIndex" : 2,
"x-methodName" : "updateAccount",
"security" : [
@@ -2041,7 +2026,6 @@
"summary" : "Update an account holder",
"description" : "Updates the `accountHolderDetails` and `processingTier` of an account holder, and adds bank accounts and shareholders.\n\nWhen updating `accountHolderDetails`, parameters that are not included in the request are left unchanged except for the following object:\n\n* `metadata`: Updating the metadata replaces the entire object. This means that to update an existing key-value pair, you must provide the changes, as well as other existing key-value pairs.\n\nWhen updating any field in the following objects, you must submit all the fields required for validation:\n\n * `address`\n\n* `fullPhoneNumber`\n\n* `bankAccountDetails.BankAccountDetail`\n\n* `businessDetails.shareholders.ShareholderContact`\n\n For example, to update the `address.postalCode`, you must also submit the `address.country`, `.city`, `.street`, `.postalCode`, and possibly `.stateOrProvince` so that the address can be validated.\n\nTo add a bank account or shareholder, provide the bank account or shareholder details without a `bankAccountUUID` or a `shareholderCode`.\n\n",
"operationId" : "post-updateAccountHolder",
"x-groupName" : "Account holders",
"x-sortIndex" : 3,
"x-methodName" : "updateAccountHolder",
"security" : [
@@ -2081,6 +2065,20 @@
"200" : {
"content" : {
"application/json" : {
"examples" : {
"addShareholders" : {
"$ref" : "#/components/examples/post-updateAccountHolder-addShareholders-200"
},
"bankAccountDetails" : {
"$ref" : "#/components/examples/post-updateAccountHolder-bankAccountDetails-200"
},
"businessDetails" : {
"$ref" : "#/components/examples/post-updateAccountHolder-businessDetails-200"
},
"general" : {
"$ref" : "#/components/examples/post-updateAccountHolder-general-200"
}
},
"schema" : {
"$ref" : "#/components/schemas/UpdateAccountHolderResponse"
}
@@ -2169,7 +2167,6 @@
"summary" : "Update payout or processing state",
"description" : "Disables or enables the processing or payout state of an account holder.",
"operationId" : "post-updateAccountHolderState",
"x-groupName" : "Account holders",
"x-sortIndex" : 4,
"x-methodName" : "updateAccountHolderState",
"security" : [
@@ -2288,7 +2285,6 @@
"summary" : "Upload a document",
"description" : "Uploads a document for an account holder. Adyen uses the documents during the [verification process](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process).",
"operationId" : "post-uploadDocument",
"x-groupName" : "Verification",
"x-sortIndex" : 1,
"x-methodName" : "uploadDocument",
"security" : [
@@ -3117,7 +3113,7 @@
"type" : "string"
},
"payoutSchedule" : {
"description" : "The payout schedule of the prospective account.\n>Permitted values: `DEFAULT`, `HOLD`, `DAILY`, `WEEKLY`, `MONTHLY`.",
"description" : "The payout schedule for the account.\n\nPossible values: `DEFAULT`, `DAILY`, `DAILY_US`, `DAILY_EU`, `DAILY_AU`, `DAILY_SG`, `WEEKLY`, `WEEKLY_ON_TUE_FRI_MIDNIGHT`, `BIWEEKLY_ON_1ST_AND_15TH_AT_MIDNIGHT`, `MONTHLY`, `HOLD`.\n> `HOLD` prevents scheduled payouts, but you can still initiate payouts manually.",
"enum" : [
"BIWEEKLY_ON_1ST_AND_15TH_AT_MIDNIGHT",
"DAILY",
@@ -3138,13 +3134,13 @@
"type" : "string"
},
"payoutScheduleReason" : {
"description" : "The reason for the payout schedule choice.\n>Required if the payoutSchedule is `HOLD`.",
"description" : "The reason for the payout schedule choice.\n> This field is required when the `payoutSchedule` parameter is set to `HOLD`.",
"type" : "string"
},
"payoutSpeed" : {
"x-addedInVersion" : "5",
"default" : "STANDARD",
"description" : "Speed with which payouts for this account are processed. Permitted values: `STANDARD`, `SAME_DAY`.",
"description" : "Speed at which payouts for this account are processed.\n\nPossible values: `STANDARD` (default), `SAME_DAY`.",
"enum" : [
"INSTANT",
"SAME_DAY",
@@ -3200,7 +3196,7 @@
"type" : "string"
},
"payoutSchedule" : {
"description" : "The payout schedule of the account.",
"description" : "The details of the payout schedule added to the account.",
"$ref" : "#/components/schemas/PayoutScheduleResponse"
},
"payoutSpeed" : {
@@ -3509,6 +3505,7 @@
"legalBusinessName",
"legalEntity",
"legalEntityType",
"linkedViasVirtualAccount",
"logo",
"merchantAccount",
"merchantCategoryCode",
@@ -4274,12 +4271,12 @@
},
"MigratedAccounts" : {
"properties" : {
"balanceAccountId" : {
"description" : "The unique identifier of the account of the migrated account holder in the balance platform.",
"accountCode" : {
"description" : "The unique identifier of the account of the migrated account holder in the classic integration.",
"type" : "string"
},
"virtualAccountCode" : {
"description" : "The unique identifier of the account of the migrated account holder in the classic integration.",
"balanceAccountId" : {
"description" : "The unique identifier of the account of the migrated account holder in the balance platform.",
"type" : "string"
}
},
@@ -4400,7 +4397,7 @@
"type" : "string"
},
"schedule" : {
"description" : "The payout schedule of the account.\nPermitted values: `DEFAULT`, `DAILY`, `DAILY_US`, `DAILY_EU`, `DAILY_AU`, `DAILY_SG`, `WEEKLY`, `WEEKLY_ON_TUE_FRI_MIDNIGHT`, `BIWEEKLY_ON_1ST_AND_15TH_AT_MIDNIGHT`, `MONTHLY`, `HOLD`.",
"description" : "The payout schedule for the account.\n\nPossible values: `DEFAULT`, `DAILY`, `DAILY_US`, `DAILY_EU`, `DAILY_AU`, `DAILY_SG`, `WEEKLY`, `WEEKLY_ON_TUE_FRI_MIDNIGHT`, `BIWEEKLY_ON_1ST_AND_15TH_AT_MIDNIGHT`, `MONTHLY`, `HOLD`.\n> `HOLD` prevents scheduled payouts, but you can still initiate payouts manually.",
"enum" : [
"BIWEEKLY_ON_1ST_AND_15TH_AT_MIDNIGHT",
"DAILY",
@@ -4679,7 +4676,7 @@
"type" : "string"
},
"storeName" : {
"description" : "The name of the account holder's store. This value is shown in shopper statements.\n\n* Length: Between 3 to 22 characters \n\n* The following characters are *not* supported: **:;}{$#@!|<>%^*+=\\\\**",
"description" : "The name of the account holder's store. This value is shown in shopper statements.\n\n * Length: Between 3 to 22 characters \n\n * The following characters are *not* supported: **:;}{$#@!|<>%^*+=\\\\**\n\n**Note:** storeName does not appear in American Express shopper statements by default. Contact Adyen Support to enable this for American Express.",
"type" : "string"
},
"storeReference" : {
@@ -5001,12 +4998,12 @@
"type" : "string"
},
"payoutSchedule" : {
"description" : "The details of the payout schedule, to which the account should be updated.",
"description" : "The details of the payout schedule to which the account must be updated.",
"$ref" : "#/components/schemas/UpdatePayoutScheduleRequest"
},
"payoutSpeed" : {
"x-addedInVersion" : "5",
"description" : "Speed with which payouts for this account are processed. Permitted values: `STANDARD`, `SAME_DAY`.",
"description" : "Speed at which payouts for this account are processed.\n\nPossible values: `STANDARD` (default), `SAME_DAY`.",
"enum" : [
"INSTANT",
"SAME_DAY",
@@ -5058,12 +5055,12 @@
"type" : "string"
},
"payoutSchedule" : {
"description" : "The payout schedule of the account.",
"description" : "The details of the payout schedule to which the account is updated.",
"$ref" : "#/components/schemas/PayoutScheduleResponse"
},
"payoutSpeed" : {
"x-addedInVersion" : "5",
"description" : "Speed with which payouts for this account are processed. Permitted values: `STANDARD`, `SAME_DAY`.",
"description" : "Speed at which payouts for this account are processed.\n\nPossible values: `STANDARD`, `SAME_DAY`.",
"enum" : [
"INSTANT",
"SAME_DAY",
@@ -5088,7 +5085,7 @@
"UpdatePayoutScheduleRequest" : {
"properties" : {
"action" : {
"description" : "Direction on how to handle any payouts that have already been scheduled.\nPermitted values:\n* `CLOSE` will close the existing batch of payouts.\n* `UPDATE` will reschedule the existing batch to the new schedule.\n* `NOTHING` (**default**) will allow the payout to proceed.",
"description" : "Direction on how to handle any payouts that have already been scheduled.\n\nPossible values:\n* `CLOSE`: close the existing batch of payouts.\n* `UPDATE`: reschedule the existing batch to the new schedule.\n* `NOTHING` (**default**): allow the payout to proceed.",
"enum" : [
"CLOSE",
"NOTHING",
@@ -5101,7 +5098,7 @@
"type" : "string"
},
"schedule" : {
"description" : "The payout schedule to which the account is to be updated.\nPermitted values: `DAILY`, `DAILY_US`, `DAILY_EU`, `DAILY_AU`, `DAILY_SG`, `WEEKLY`, `WEEKLY_ON_TUE_FRI_MIDNIGHT`, `BIWEEKLY_ON_1ST_AND_15TH_AT_MIDNIGHT`, `MONTHLY`, `HOLD`.\n`HOLD` will prevent scheduled payouts from happening but will still allow manual payouts to occur.",
"description" : "The new payout schedule for the account.\n\nPossible values: `DEFAULT`, `DAILY`, `DAILY_US`, `DAILY_EU`, `DAILY_AU`, `DAILY_SG`, `WEEKLY`, `WEEKLY_ON_TUE_FRI_MIDNIGHT`, `BIWEEKLY_ON_1ST_AND_15TH_AT_MIDNIGHT`, `MONTHLY`, `HOLD`.\n> `HOLD` prevents scheduled payouts, but you can still initiate payouts manually.",
"enum" : [
"BIWEEKLY_ON_1ST_AND_15TH_AT_MIDNIGHT",
"DAILY",
@@ -5276,7 +5273,7 @@
}
},
"generic-403" : {
"summary" : "Response code 401. Forbidden.",
"summary" : "Response code 403. Forbidden.",
"value" : {
"status" : 403,
"errorCode" : "10_003",
@@ -5311,7 +5308,7 @@
}
},
"post-createAccountHolder-business" : {
"summary" : "Create a business account holder",
"summary" : "Create business account holder",
"value" : {
"accountHolderCode" : "YOUR_UNIQUE_ACCOUNT_HOLDER_CODE",
"accountHolderDetails" : {
@@ -5323,6 +5320,7 @@
"legalBusinessName" : "Real Good Restaurant Inc.",
"shareholders" : [
{
"shareholderType" : "Controller",
"name" : {
"firstName" : "John",
"lastName" : "Carpenter"
@@ -5340,10 +5338,79 @@
"legalEntity" : "Business"
}
},
"post-createAccountHolder-individual" : {
"summary" : "Create an individual account holder",
"post-createAccountHolder-business-200" : {
"summary" : "Business account holder created",
"value" : {
"accountHolderCode" : "GENERATE_CODE",
"pspReference" : "ALPHANUMERIC_UNIQUE_RESPONSE_REFERENCE",
"accountHolderCode" : "YOUR_UNIQUE_ACCOUNT_HOLDER_CODE",
"accountHolderDetails" : {
"address" : {
"country" : "US"
},
"bankAccountDetails" : [
],
"businessDetails" : {
"doingBusinessAs" : "Real Good Restaurant",
"legalBusinessName" : "Real Good Restaurant Inc.",
"shareholders" : [
{
"address" : {
"country" : "NL"
},
"email" : "testshareholder@email.com",
"name" : {
"firstName" : "John",
"lastName" : "Carpenter"
},
"shareholderCode" : "SHAREHOLDER_CODE",
"shareholderType" : "Controller"
}
]
},
"email" : "test@email.com",
"merchantCategoryCode" : "MCC_DEFAULT_VALUE",
"payoutMethods" : [
],
"webAddress" : "https://www.your-website.com"
},
"accountHolderStatus" : {
"status" : "Active",
"processingState" : {
"disabled" : false,
"processedFrom" : {
"currency" : "USD",
"value" : 0
},
"processedTo" : {
"currency" : "USD",
"value" : 0
},
"tierNumber" : 0
},
"payoutState" : {
"allowPayout" : true,
"payoutLimit" : {
"currency" : "USD",
"value" : 0
},
"disabled" : false,
"tierNumber" : 0
},
"events" : [
]
},
"legalEntity" : "Business",
"invalidFields" : [
],
"verification" : {
}
}
},
"post-createAccountHolder-individual" : {
"summary" : "Create individual account holder",
"value" : {
"accountHolderCode" : "YOUR_UNIQUE_ACCOUNT_HOLDER_CODE",
"accountHolderDetails" : {
"email" : "tim@green.com",
"individualDetails" : {
@@ -5360,6 +5427,63 @@
"legalEntity" : "Individual"
}
},
"post-createAccountHolder-individual-200" : {
"summary" : "Individual account holder created",
"value" : {
"pspReference" : "ALPHANUMERIC_UNIQUE_RESPONSE_REFERENCE",
"accountHolderCode" : "YOUR_UNIQUE_ACCOUNT_HOLDER_CODE",
"accountHolderDetails" : {
"address" : {
"country" : "US"
},
"bankAccountDetails" : [
],
"email" : "tim@green.com",
"individualDetails" : {
"name" : {
"firstName" : "Tim",
"lastName" : "Green"
}
},
"merchantCategoryCode" : "5045",
"payoutMethods" : [
],
"webAddress" : "https://www.your-website.com"
},
"accountHolderStatus" : {
"status" : "Active",
"processingState" : {
"disabled" : false,
"processedFrom" : {
"currency" : "USD",
"value" : 0
},
"processedTo" : {
"currency" : "USD",
"value" : 0
},
"tierNumber" : 0
},
"payoutState" : {
"allowPayout" : true,
"payoutLimit" : {
"currency" : "USD",
"value" : 0
},
"disabled" : false,
"tierNumber" : 0
},
"events" : [
]
},
"legalEntity" : "Individual",
"invalidFields" : [
],
"verification" : {
}
}
},
"post-deleteBankAccounts-basic" : {
"summary" : "Delete bank accounts",
"value" : {
@@ -5519,9 +5643,10 @@
"businessDetails" : {
"shareholders" : [
{
"shareholderType" : "Controller",
"name" : {
"firstName" : "Alice",
"lastName" : "Fields"
"firstName" : "Shelly",
"lastName" : "Eller"
},
"address" : {
"city" : "San Francisco",
@@ -5551,10 +5676,58 @@
}
}
},
"post-updateAccountHolder-addShareholders-200" : {
"summary" : "Shareholders added",
"value" : {
"invalidFields" : [
],
"pspReference" : "ALPHANUMERIC_UNIQUE_RESPONSE_REFERENCE",
"accountHolderCode" : "YOUR_UNIQUE_ACCOUNT_HOLDER_CODE",
"accountHolderDetails" : {
"bankAccountDetails" : [
],
"businessDetails" : {
"shareholders" : [
{
"address" : {
"city" : "San Francisco",
"country" : "US",
"houseNumberOrName" : "274",
"postalCode" : "94107",
"stateOrProvince" : "CA",
"street" : "Brannan"
},
"email" : "testshareholder2@email.com",
"name" : {
"firstName" : "Shelly",
"lastName" : "Eller"
},
"personalData" : {
"dateOfBirth" : "1970-01-01",
"documentData" : [
{
"number" : "1234567890",
"type" : "ID"
}
]
},
"shareholderCode" : "SHAREHOLDER_CODE",
"shareholderType" : "Controller"
}
],
"taxId" : "123456789"
},
"email" : "test@email.com",
"payoutMethods" : [
],
"webAddress" : "http://www.accountholderwebsite.com"
}
}
},
"post-updateAccountHolder-bankAccountDetails" : {
"summary" : "Update bank account details",
"value" : {
"accountHolderCode" : "CODE_OF_ACCOUNT_HOLDER",
"accountHolderCode" : "YOUR_UNIQUE_ACCOUNT_HOLDER_CODE",
"accountHolderDetails" : {
"email" : "tim@green.com",
"individualDetails" : {
@@ -5581,26 +5754,109 @@
}
}
},
"post-updateAccountHolder-bankAccountDetails-200" : {
"summary" : "Bank account details updated",
"value" : {
"invalidFields" : [
],
"pspReference" : "ALPHANUMERIC_UNIQUE_RESPONSE_REFERENCE",
"accountHolderCode" : "YOUR_UNIQUE_ACCOUNT_HOLDER_CODE",
"accountHolderDetails" : {
"address" : {
"country" : "US"
},
"bankAccountDetails" : [
{
"accountNumber" : "######6852",
"bankAccountUUID" : "BANK_ACCOUNT_UUID",
"branchCode" : "053101273",
"countryCode" : "US",
"currencyCode" : "USD",
"ownerCity" : "Springfield",
"ownerCountryCode" : "US",
"ownerHouseNumberOrName" : "100",
"ownerName" : "Tim Green",
"ownerPostalCode" : "02894",
"ownerState" : "AZ",
"ownerStreet" : "Main Street",
"primaryAccount" : false
}
],
"businessDetails" : {
"doingBusinessAs" : "Real Good Restaurant",
"legalBusinessName" : "Real Good Restaurant Inc.",
"shareholders" : [
{
"address" : {
"country" : "NL"
},
"email" : "testshareholder@email.com",
"name" : {
"firstName" : "John",
"lastName" : "Carpenter"
},
"shareholderCode" : "SHAREHOLDER_CODE",
"shareholderType" : "Controller"
}
]
},
"email" : "tim@green.com",
"merchantCategoryCode" : "MCC_DEFAULT_VALUE",
"payoutMethods" : [
],
"webAddress" : "https://www.your-website.com"
},
"accountHolderStatus" : {
"status" : "Active",
"processingState" : {
"disabled" : false,
"processedFrom" : {
"currency" : "USD",
"value" : 0
},
"processedTo" : {
"currency" : "USD",
"value" : 0
},
"tierNumber" : 0
},
"payoutState" : {
"allowPayout" : true,
"payoutLimit" : {
"currency" : "USD",
"value" : 0
},
"disabled" : false,
"tierNumber" : 0
}
},
"legalEntity" : "Business",
"verification" : {
}
}
},
"post-updateAccountHolder-businessDetails" : {
"summary" : "Update business details",
"value" : {
"accountHolderCode" : "CODE_OF_ACCOUNT_HOLDER",
"accountHolderCode" : "YOUR_UNIQUE_ACCOUNT_HOLDER_CODE",
"accountHolderDetails" : {
"businessDetails" : {
"shareholders" : [
{
"shareholderType" : "Owner",
"address" : {
"city" : "Amsterdam",
"country" : "NL",
"houseNumberOrName" : "1",
"postalCode" : "1111AA",
"stateOrProvince" : "NH",
"street" : "Awesome St"
"street" : "Main Street"
},
"email" : "testshareholder2@email.com",
"name" : {
"firstName" : "Alice",
"lastName" : "Fields"
"firstName" : "Shelly",
"lastName" : "Eller"
}
}
],
@@ -5612,42 +5868,142 @@
}
}
},
"post-updateAccountHolder-general" : {
"summary" : "Update account holder details",
"post-updateAccountHolder-businessDetails-200" : {
"summary" : "Business details updated",
"value" : {
"accountHolderCode" : "CODE_OF_ACCOUNT_HOLDER",
"invalidFields" : [
],
"pspReference" : "ALPHANUMERIC_UNIQUE_RESPONSE_REFERENCE",
"accountHolderCode" : "YOUR_UNIQUE_ACCOUNT_HOLDER_CODE",
"accountHolderDetails" : {
"bankAccountDetails" : [
],
"businessDetails" : {
"shareholders" : [
{
"address" : {
"city" : "Amsterdam",
"country" : "NL",
"houseNumberOrName" : "1",
"postalCode" : "1111AA",
"stateOrProvince" : "NH",
"street" : "Main Street"
},
"email" : "testshareholder2@email.com",
"name" : {
"firstName" : "Shelly",
"lastName" : "Eller"
},
"shareholderCode" : "SHAREHOLDER_CODE",
"shareholderType" : "Owner"
}
],
"taxId" : "BV123456789"
},
"email" : "test@email.com",
"payoutMethods" : [
],
"webAddress" : "http://www.accountholderwebsite.com"
}
}
},
"post-updateAccountHolder-general" : {
"summary" : "Update individual with documentData property",
"value" : {
"accountHolderCode" : "YOUR_UNIQUE_ACCOUNT_HOLDER_CODE",
"accountHolderDetails" : {
"address" : {
"city" : "NY",
"country" : "US",
"postalCode" : "12345",
"stateOrProvince" : "NH",
"street" : "Teststreet 1",
"street" : "Main Street",
"houseNumberOrName" : "100"
},
"email" : "test@adyen.com",
"individualDetails" : {
"name" : {
"firstName" : "Simon",
"lastName" : "Hopper"
},
"personalData" : {
"dateOfBirth" : "1970-01-01",
"documentData" : [
{
"number" : "1234567890",
"type" : "ID"
}
],
"nationality" : "NL"
}
},
"merchantCategoryCode" : "7999",
"fullPhoneNumber" : "+31612345678",
"webAddress" : "http://www.accountholderwebsite.com"
}
}
},
"post-updateAccountHolder-general-200" : {
"summary" : "Individual updated with documentData property",
"value" : {
"invalidFields" : [
],
"pspReference" : "ALPHANUMERIC_UNIQUE_RESPONSE_REFERENCE",
"accountHolderCode" : "YOUR_UNIQUE_ACCOUNT_HOLDER_CODE",
"accountHolderDetails" : {
"address" : {
"city" : "NY",
"country" : "US",
"houseNumberOrName" : "100",
"postalCode" : "12345",
"stateOrProvince" : "NH",
"street" : "Main Street"
},
"bankAccountDetails" : [
],
"businessDetails" : {
"doingBusinessAs" : "Real Good Restaurant",
"legalBusinessName" : "Real Good Restaurant Inc.",
"shareholders" : [
{
"address" : {
"country" : "NL"
},
"email" : "testshareholder@email.com",
"name" : {
"firstName" : "John",
"lastName" : "Carpenter"
},
"shareholderCode" : "SHAREHOLDER_CODE",
"shareholderType" : "Controller"
}
]
},
"email" : "test@adyen.com",
"merchantCategoryCode" : "UPDATE_MCC",
"payoutMethods" : [
],
"phoneNumber" : {
"phoneCountryCode" : "NL",
"phoneNumber" : "612345678",
"phoneType" : "Landline"
},
"webAddress" : "http://www.accountholderwebsite.com"
},
"accountHolderStatus" : {
"status" : "Active",
"processingState" : {
"disabled" : false,
"processedFrom" : {
"currency" : "USD",
"value" : 0
},
"processedTo" : {
"currency" : "USD",
"value" : 0
},
"tierNumber" : 0
},
"payoutState" : {
"allowPayout" : true,
"payoutLimit" : {
"currency" : "USD",
"value" : 0
},
"disabled" : false,
"tierNumber" : 0
}
},
"legalEntity" : "Business",
"verification" : {
}
}
},
"post-updateAccountHolderState-basic" : {
"summary" : "Update account holder state",
"value" : {

56
json/FundService-v3.json
View File

@@ -10,20 +10,18 @@
"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" : "2023-05-30T15:27:19Z",
"termsOfService" : "https://www.adyen.com/legal/terms-and-conditions",
"contact" : {
"name" : "Adyen Developer Experience team",
"url" : "https://github.com/Adyen/adyen-openapi"
}
},
"x-groups" : [
"General",
"Migration"
],
"tags" : [
{
"name" : "General"
},
{
"name" : "Migration"
}
],
"paths" : {
@@ -35,7 +33,6 @@
"summary" : "Get the balances of an account holder",
"description" : "Returns the account balances of an account holder. An account's balances are organized according by currencies. This mean that an account may have multiple balances: one for each currency.",
"operationId" : "post-accountHolderBalance",
"x-groupName" : "General",
"x-sortIndex" : 1,
"x-methodName" : "accountHolderBalance",
"security" : [
@@ -144,7 +141,6 @@
"summary" : "Get a list of transactions",
"description" : "Returns a list of transactions for an account holder's accounts. You can specify the accounts and transaction statuses to be included on the list. The call returns a maximum of 50 transactions for each account. To retrieve all transactions, you must make another call with the 'page' value incremented. Transactions are listed in chronological order, with the most recent transaction first.",
"operationId" : "post-accountHolderTransactionList",
"x-groupName" : "General",
"x-sortIndex" : 2,
"x-methodName" : "accountHolderTransactionList",
"security" : [
@@ -256,7 +252,6 @@
"summary" : "Send a direct debit request",
"description" : "Sends a direct debit request to an account holder's bank account. If the direct debit is successful, the funds are settled in the accounts specified in the split instructions. Adyen sends the result of the direct debit in a [`DIRECT_DEBIT_INITIATED`](https://docs.adyen.com/api-explorer/#/NotificationService/latest/post/DIRECT_DEBIT_INITIATED) notification webhook.\n\n To learn more about direct debits, see [Top up accounts](https://docs.adyen.com/marketplaces-and-platforms/classic/top-up-accounts).",
"operationId" : "post-debitAccountHolder",
"x-groupName" : "General",
"x-sortIndex" : 8,
"x-methodName" : "debitAccountHolder",
"security" : [
@@ -370,7 +365,6 @@
"summary" : "Pay out from an account to the account holder",
"description" : "Pays out a specified amount from an account to the bank account of account holder.",
"operationId" : "post-payoutAccountHolder",
"x-groupName" : "General",
"x-sortIndex" : 3,
"x-methodName" : "payoutAccountHolder",
"security" : [
@@ -479,7 +473,6 @@
"summary" : "Refund a funds transfer",
"description" : "Refunds funds transferred from one account to another. Both accounts must be in the same platform, but can have different account holders. ",
"operationId" : "post-refundFundsTransfer",
"x-groupName" : "General",
"x-sortIndex" : 5,
"x-methodName" : "refundFundsTransfer",
"security" : [
@@ -588,7 +581,6 @@
"summary" : "Refund all transactions of an account since the most recent payout",
"description" : "Refunds all the transactions of an account that have taken place since the most recent payout. This request is on a account basis (as opposed to a payment basis), so only the portion of the payment that was made to the specified account is refunded. The commissions, fees, and payments to other accounts remain in the accounts to which they were sent as designated by the original payment's split details.",
"operationId" : "post-refundNotPaidOutTransfers",
"x-groupName" : "General",
"x-sortIndex" : 7,
"x-methodName" : "refundNotPaidOutTransfers",
"security" : [
@@ -697,7 +689,6 @@
"summary" : "Designate a beneficiary account and transfer the benefactor's current balance",
"description" : "Defines a benefactor and a beneficiary relationship between two accounts. At the time of benefactor/beneficiary setup, the funds in the benefactor account are transferred to the beneficiary account, and any further payments to the benefactor account are automatically sent to the beneficiary account. A series of benefactor/beneficiaries may not exceed four beneficiaries and may not have a cycle in it.",
"operationId" : "post-setupBeneficiary",
"x-groupName" : "General",
"x-sortIndex" : 6,
"x-methodName" : "setupBeneficiary",
"security" : [
@@ -806,7 +797,6 @@
"summary" : "Transfer funds between platform accounts",
"description" : "Transfers funds from one account to another account. Both accounts must be in the same platform, but can have different account holders. The transfer must include a transfer code, which should be determined by the platform, in compliance with local regulations.",
"operationId" : "post-transferFunds",
"x-groupName" : "General",
"x-sortIndex" : 4,
"x-methodName" : "transferFunds",
"security" : [
@@ -988,6 +978,7 @@
"items" : {
"enum" : [
"BalanceNotPaidOutTransfer",
"BalancePlatformFundTransfer",
"BalancePlatformSweep",
"BalancePlatformSweepReturned",
"Chargeback",
@@ -1011,15 +1002,19 @@
"DebitedReversed",
"DepositCorrectionCredited",
"DepositCorrectionDebited",
"DepositCorrectionReceived",
"Fee",
"FeeReceived",
"FundTransfer",
"FundTransferReversed",
"InvoiceDeductionCredited",
"InvoiceDeductionDebited",
"InvoiceDeductionReceived",
"ManualCorrected",
"ManualCorrectionCredited",
"ManualCorrectionDebited",
"MerchantPayin",
"MerchantPayinReceived",
"MerchantPayinReversed",
"Payout",
"PayoutReversed",
@@ -1530,46 +1525,44 @@
"Split" : {
"properties" : {
"account" : {
"description" : "Unique identifier of the account where the split amount should be sent. This is required if `type` is **MarketPlace** or **BalanceAccount**.\n\n",
"description" : "The unique identifier of the account to which the split amount is booked. Required if `type` is **MarketPlace** or **BalanceAccount**.\n\n* [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic): The [`accountCode`](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccount#request-accountCode) of the account to which the split amount is booked.\n* [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms): The [`balanceAccountId`](https://docs.adyen.com/api-explorer/balanceplatform/latest/get/balanceAccounts/_id_#path-id) of the account to which the split amount is booked.",
"type" : "string"
},
"amount" : {
"description" : "The amount of this split.",
"description" : "The amount of the split item.\n\n* Required for all split types in the [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic).\n* Required if `type` is **BalanceAccount**, **Commission**, **Default**, or **VAT** in your [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms) integration.",
"$ref" : "#/components/schemas/SplitAmount"
},
"description" : {
"description" : "A description of this split.",
"description" : "Your description for the split item.",
"type" : "string"
},
"reference" : {
"description" : "Your reference for the split, which you can use to link the split to other operations such as captures and refunds.\n\nThis is required if `type` is **MarketPlace** or **BalanceAccount**. For the other types, we also recommend sending a reference so you can reconcile the split and the associated payment in the transaction overview and in the reports. If the reference is not provided, the split is reported as part of the aggregated [TransferBalance record type](https://docs.adyen.com/reporting/marketpay-payments-accounting-report) in Adyen for Platforms.",
"description" : "Your unique reference for the split item.\n\nThis is required if `type` is **MarketPlace** ([Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic)) or **BalanceAccount** ([Balance Platform](https://docs.adyen.com/marketplaces-and-platforms)).\n\nFor the other types, we also recommend providing a **unique** reference so you can reconcile the split and the associated payment in the transaction overview and in the reports.",
"type" : "string"
},
"type" : {
"description" : "The type of split.\nPossible values: **Default**, **PaymentFee**, **VAT**, **Commission**, **MarketPlace**, **BalanceAccount**, **Remainder**, **Surcharge**, **Tip**.",
"description" : "The type of the split item.\n\nPossible values:\n\n* [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic): **Commission**, **Default**, **Marketplace**, **PaymentFee**, **VAT**.\n* [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms): **BalanceAccount**, **Commission**, **Default**, **PaymentFee**, **Remainder**, **Surcharge**, **Tip**, **VAT**.",
"enum" : [
"AcquiringFees",
"AdyenCommission",
"AdyenFees",
"AdyenMarkup",
"BalanceAccount",
"Commission",
"Default",
"Interchange",
"MarketPlace",
"PaymentFee",
"PaymentFeeAcquiring",
"PaymentFeeAdyen",
"PaymentFeeAdyenCommission",
"PaymentFeeAdyenMarkup",
"PaymentFeeInterchange",
"PaymentFeeSchemeFee",
"Remainder",
"SchemeFee",
"Surcharge",
"Tip",
"VAT",
"Verification"
"VAT"
],
"type" : "string"
}
},
"required" : [
"amount",
"type"
],
"type" : "object"
@@ -1577,13 +1570,13 @@
"SplitAmount" : {
"properties" : {
"currency" : {
"description" : "The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes).\n\nIf this value is not provided, the currency in which the payment is made will be used.",
"description" : "The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes). By default, this is the original payment currency.",
"maxLength" : 3,
"minLength" : 3,
"type" : "string"
},
"value" : {
"description" : "The amount in [minor units](https://docs.adyen.com/development-resources/currency-codes).",
"description" : "The value of the split amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).",
"format" : "int64",
"type" : "integer"
}
@@ -1658,6 +1651,7 @@
"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",
"BalancePlatformFundTransfer",
"BalancePlatformSweep",
"BalancePlatformSweepReturned",
"Chargeback",
@@ -1681,15 +1675,19 @@
"DebitedReversed",
"DepositCorrectionCredited",
"DepositCorrectionDebited",
"DepositCorrectionReceived",
"Fee",
"FeeReceived",
"FundTransfer",
"FundTransferReversed",
"InvoiceDeductionCredited",
"InvoiceDeductionDebited",
"InvoiceDeductionReceived",
"ManualCorrected",
"ManualCorrectionCredited",
"ManualCorrectionDebited",
"MerchantPayin",
"MerchantPayinReceived",
"MerchantPayinReversed",
"Payout",
"PayoutReversed",

57
json/FundService-v5.json
View File

@@ -10,20 +10,18 @@
"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" : "2023-05-30T15:27:19Z",
"termsOfService" : "https://www.adyen.com/legal/terms-and-conditions",
"contact" : {
"name" : "Adyen Developer Experience team",
"url" : "https://github.com/Adyen/adyen-openapi"
}
},
"x-groups" : [
"General",
"Migration"
],
"tags" : [
{
"name" : "General"
},
{
"name" : "Migration"
}
],
"paths" : {
@@ -35,7 +33,6 @@
"summary" : "Get the balances of an account holder",
"description" : "Returns the account balances of an account holder. An account's balances are organized according by currencies. This mean that an account may have multiple balances: one for each currency.",
"operationId" : "post-accountHolderBalance",
"x-groupName" : "General",
"x-sortIndex" : 1,
"x-methodName" : "accountHolderBalance",
"security" : [
@@ -144,7 +141,6 @@
"summary" : "Get a list of transactions",
"description" : "Returns a list of transactions for an account holder's accounts. You can specify the accounts and transaction statuses to be included on the list. The call returns a maximum of 50 transactions for each account. To retrieve all transactions, you must make another call with the 'page' value incremented. Transactions are listed in chronological order, with the most recent transaction first.",
"operationId" : "post-accountHolderTransactionList",
"x-groupName" : "General",
"x-sortIndex" : 2,
"x-methodName" : "accountHolderTransactionList",
"security" : [
@@ -256,7 +252,6 @@
"summary" : "Send a direct debit request",
"description" : "Sends a direct debit request to an account holder's bank account. If the direct debit is successful, the funds are settled in the accounts specified in the split instructions. Adyen sends the result of the direct debit in a [`DIRECT_DEBIT_INITIATED`](https://docs.adyen.com/api-explorer/#/NotificationService/latest/post/DIRECT_DEBIT_INITIATED) notification webhook.\n\n To learn more about direct debits, see [Top up accounts](https://docs.adyen.com/marketplaces-and-platforms/classic/top-up-accounts).",
"operationId" : "post-debitAccountHolder",
"x-groupName" : "General",
"x-sortIndex" : 8,
"x-methodName" : "debitAccountHolder",
"security" : [
@@ -370,7 +365,6 @@
"summary" : "Pay out from an account to the account holder",
"description" : "Pays out a specified amount from an account to the bank account of account holder.",
"operationId" : "post-payoutAccountHolder",
"x-groupName" : "General",
"x-sortIndex" : 3,
"x-methodName" : "payoutAccountHolder",
"security" : [
@@ -479,7 +473,6 @@
"summary" : "Refund a funds transfer",
"description" : "Refunds funds transferred from one account to another. Both accounts must be in the same platform, but can have different account holders. ",
"operationId" : "post-refundFundsTransfer",
"x-groupName" : "General",
"x-sortIndex" : 5,
"x-methodName" : "refundFundsTransfer",
"security" : [
@@ -588,7 +581,6 @@
"summary" : "Refund all transactions of an account since the most recent payout",
"description" : "Refunds all the transactions of an account that have taken place since the most recent payout. This request is on a account basis (as opposed to a payment basis), so only the portion of the payment that was made to the specified account is refunded. The commissions, fees, and payments to other accounts remain in the accounts to which they were sent as designated by the original payment's split details.",
"operationId" : "post-refundNotPaidOutTransfers",
"x-groupName" : "General",
"x-sortIndex" : 7,
"x-methodName" : "refundNotPaidOutTransfers",
"security" : [
@@ -697,7 +689,6 @@
"summary" : "Designate a beneficiary account and transfer the benefactor's current balance",
"description" : "Defines a benefactor and a beneficiary relationship between two accounts. At the time of benefactor/beneficiary setup, the funds in the benefactor account are transferred to the beneficiary account, and any further payments to the benefactor account are automatically sent to the beneficiary account. A series of benefactor/beneficiaries may not exceed four beneficiaries and may not have a cycle in it.",
"operationId" : "post-setupBeneficiary",
"x-groupName" : "General",
"x-sortIndex" : 6,
"x-methodName" : "setupBeneficiary",
"security" : [
@@ -806,7 +797,6 @@
"summary" : "Transfer funds between platform accounts",
"description" : "Transfers funds from one account to another account. Both accounts must be in the same platform, but can have different account holders. The transfer must include a transfer code, which should be determined by the platform, in compliance with local regulations.",
"operationId" : "post-transferFunds",
"x-groupName" : "General",
"x-sortIndex" : 4,
"x-methodName" : "transferFunds",
"security" : [
@@ -985,6 +975,7 @@
"items" : {
"enum" : [
"BalanceNotPaidOutTransfer",
"BalancePlatformFundTransfer",
"BalancePlatformSweep",
"BalancePlatformSweepReturned",
"Chargeback",
@@ -1008,15 +999,19 @@
"DebitedReversed",
"DepositCorrectionCredited",
"DepositCorrectionDebited",
"DepositCorrectionReceived",
"Fee",
"FeeReceived",
"FundTransfer",
"FundTransferReversed",
"InvoiceDeductionCredited",
"InvoiceDeductionDebited",
"InvoiceDeductionReceived",
"ManualCorrected",
"ManualCorrectionCredited",
"ManualCorrectionDebited",
"MerchantPayin",
"MerchantPayinReceived",
"MerchantPayinReversed",
"Payout",
"PayoutReversed",
@@ -1431,6 +1426,7 @@
"legalBusinessName",
"legalEntity",
"legalEntityType",
"linkedViasVirtualAccount",
"logo",
"merchantAccount",
"merchantCategoryCode",
@@ -1776,46 +1772,44 @@
"Split" : {
"properties" : {
"account" : {
"description" : "Unique identifier of the account where the split amount should be sent. This is required if `type` is **MarketPlace** or **BalanceAccount**.\n\n",
"description" : "The unique identifier of the account to which the split amount is booked. Required if `type` is **MarketPlace** or **BalanceAccount**.\n\n* [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic): The [`accountCode`](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccount#request-accountCode) of the account to which the split amount is booked.\n* [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms): The [`balanceAccountId`](https://docs.adyen.com/api-explorer/balanceplatform/latest/get/balanceAccounts/_id_#path-id) of the account to which the split amount is booked.",
"type" : "string"
},
"amount" : {
"description" : "The amount of this split.",
"description" : "The amount of the split item.\n\n* Required for all split types in the [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic).\n* Required if `type` is **BalanceAccount**, **Commission**, **Default**, or **VAT** in your [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms) integration.",
"$ref" : "#/components/schemas/SplitAmount"
},
"description" : {
"description" : "A description of this split.",
"description" : "Your description for the split item.",
"type" : "string"
},
"reference" : {
"description" : "Your reference for the split, which you can use to link the split to other operations such as captures and refunds.\n\nThis is required if `type` is **MarketPlace** or **BalanceAccount**. For the other types, we also recommend sending a reference so you can reconcile the split and the associated payment in the transaction overview and in the reports. If the reference is not provided, the split is reported as part of the aggregated [TransferBalance record type](https://docs.adyen.com/reporting/marketpay-payments-accounting-report) in Adyen for Platforms.",
"description" : "Your unique reference for the split item.\n\nThis is required if `type` is **MarketPlace** ([Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic)) or **BalanceAccount** ([Balance Platform](https://docs.adyen.com/marketplaces-and-platforms)).\n\nFor the other types, we also recommend providing a **unique** reference so you can reconcile the split and the associated payment in the transaction overview and in the reports.",
"type" : "string"
},
"type" : {
"description" : "The type of split.\nPossible values: **Default**, **PaymentFee**, **VAT**, **Commission**, **MarketPlace**, **BalanceAccount**, **Remainder**, **Surcharge**, **Tip**.",
"description" : "The type of the split item.\n\nPossible values:\n\n* [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic): **Commission**, **Default**, **Marketplace**, **PaymentFee**, **VAT**.\n* [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms): **BalanceAccount**, **Commission**, **Default**, **PaymentFee**, **Remainder**, **Surcharge**, **Tip**, **VAT**.",
"enum" : [
"AcquiringFees",
"AdyenCommission",
"AdyenFees",
"AdyenMarkup",
"BalanceAccount",
"Commission",
"Default",
"Interchange",
"MarketPlace",
"PaymentFee",
"PaymentFeeAcquiring",
"PaymentFeeAdyen",
"PaymentFeeAdyenCommission",
"PaymentFeeAdyenMarkup",
"PaymentFeeInterchange",
"PaymentFeeSchemeFee",
"Remainder",
"SchemeFee",
"Surcharge",
"Tip",
"VAT",
"Verification"
"VAT"
],
"type" : "string"
}
},
"required" : [
"amount",
"type"
],
"type" : "object"
@@ -1823,13 +1817,13 @@
"SplitAmount" : {
"properties" : {
"currency" : {
"description" : "The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes).\n\nIf this value is not provided, the currency in which the payment is made will be used.",
"description" : "The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes). By default, this is the original payment currency.",
"maxLength" : 3,
"minLength" : 3,
"type" : "string"
},
"value" : {
"description" : "The amount in [minor units](https://docs.adyen.com/development-resources/currency-codes).",
"description" : "The value of the split amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).",
"format" : "int64",
"type" : "integer"
}
@@ -1904,6 +1898,7 @@
"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",
"BalancePlatformFundTransfer",
"BalancePlatformSweep",
"BalancePlatformSweepReturned",
"Chargeback",
@@ -1927,15 +1922,19 @@
"DebitedReversed",
"DepositCorrectionCredited",
"DepositCorrectionDebited",
"DepositCorrectionReceived",
"Fee",
"FeeReceived",
"FundTransfer",
"FundTransferReversed",
"InvoiceDeductionCredited",
"InvoiceDeductionDebited",
"InvoiceDeductionReceived",
"ManualCorrected",
"ManualCorrectionCredited",
"ManualCorrectionDebited",
"MerchantPayin",
"MerchantPayinReceived",
"MerchantPayinReversed",
"Payout",
"PayoutReversed",

57
json/FundService-v6.json
View File

@@ -10,20 +10,18 @@
"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" : "2023-05-30T15:27:19Z",
"termsOfService" : "https://www.adyen.com/legal/terms-and-conditions",
"contact" : {
"name" : "Adyen Developer Experience team",
"url" : "https://github.com/Adyen/adyen-openapi"
}
},
"x-groups" : [
"General",
"Migration"
],
"tags" : [
{
"name" : "General"
},
{
"name" : "Migration"
}
],
"paths" : {
@@ -35,7 +33,6 @@
"summary" : "Get the balances of an account holder",
"description" : "Returns the account balances of an account holder. An account's balances are organized according by currencies. This mean that an account may have multiple balances: one for each currency.",
"operationId" : "post-accountHolderBalance",
"x-groupName" : "General",
"x-sortIndex" : 1,
"x-methodName" : "accountHolderBalance",
"security" : [
@@ -144,7 +141,6 @@
"summary" : "Get a list of transactions",
"description" : "Returns a list of transactions for an account holder's accounts. You can specify the accounts and transaction statuses to be included on the list. The call returns a maximum of 50 transactions for each account. To retrieve all transactions, you must make another call with the 'page' value incremented. Transactions are listed in chronological order, with the most recent transaction first.",
"operationId" : "post-accountHolderTransactionList",
"x-groupName" : "General",
"x-sortIndex" : 2,
"x-methodName" : "accountHolderTransactionList",
"security" : [
@@ -256,7 +252,6 @@
"summary" : "Send a direct debit request",
"description" : "Sends a direct debit request to an account holder's bank account. If the direct debit is successful, the funds are settled in the accounts specified in the split instructions. Adyen sends the result of the direct debit in a [`DIRECT_DEBIT_INITIATED`](https://docs.adyen.com/api-explorer/#/NotificationService/latest/post/DIRECT_DEBIT_INITIATED) notification webhook.\n\n To learn more about direct debits, see [Top up accounts](https://docs.adyen.com/marketplaces-and-platforms/classic/top-up-accounts).",
"operationId" : "post-debitAccountHolder",
"x-groupName" : "General",
"x-sortIndex" : 8,
"x-methodName" : "debitAccountHolder",
"security" : [
@@ -370,7 +365,6 @@
"summary" : "Pay out from an account to the account holder",
"description" : "Pays out a specified amount from an account to the bank account of account holder.",
"operationId" : "post-payoutAccountHolder",
"x-groupName" : "General",
"x-sortIndex" : 3,
"x-methodName" : "payoutAccountHolder",
"security" : [
@@ -479,7 +473,6 @@
"summary" : "Refund a funds transfer",
"description" : "Refunds funds transferred from one account to another. Both accounts must be in the same platform, but can have different account holders. ",
"operationId" : "post-refundFundsTransfer",
"x-groupName" : "General",
"x-sortIndex" : 5,
"x-methodName" : "refundFundsTransfer",
"security" : [
@@ -588,7 +581,6 @@
"summary" : "Refund all transactions of an account since the most recent payout",
"description" : "Refunds all the transactions of an account that have taken place since the most recent payout. This request is on a account basis (as opposed to a payment basis), so only the portion of the payment that was made to the specified account is refunded. The commissions, fees, and payments to other accounts remain in the accounts to which they were sent as designated by the original payment's split details.",
"operationId" : "post-refundNotPaidOutTransfers",
"x-groupName" : "General",
"x-sortIndex" : 7,
"x-methodName" : "refundNotPaidOutTransfers",
"security" : [
@@ -697,7 +689,6 @@
"summary" : "Designate a beneficiary account and transfer the benefactor's current balance",
"description" : "Defines a benefactor and a beneficiary relationship between two accounts. At the time of benefactor/beneficiary setup, the funds in the benefactor account are transferred to the beneficiary account, and any further payments to the benefactor account are automatically sent to the beneficiary account. A series of benefactor/beneficiaries may not exceed four beneficiaries and may not have a cycle in it.",
"operationId" : "post-setupBeneficiary",
"x-groupName" : "General",
"x-sortIndex" : 6,
"x-methodName" : "setupBeneficiary",
"security" : [
@@ -806,7 +797,6 @@
"summary" : "Transfer funds between platform accounts",
"description" : "Transfers funds from one account to another account. Both accounts must be in the same platform, but can have different account holders. The transfer must include a transfer code, which should be determined by the platform, in compliance with local regulations.",
"operationId" : "post-transferFunds",
"x-groupName" : "General",
"x-sortIndex" : 4,
"x-methodName" : "transferFunds",
"security" : [
@@ -985,6 +975,7 @@
"items" : {
"enum" : [
"BalanceNotPaidOutTransfer",
"BalancePlatformFundTransfer",
"BalancePlatformSweep",
"BalancePlatformSweepReturned",
"Chargeback",
@@ -1008,15 +999,19 @@
"DebitedReversed",
"DepositCorrectionCredited",
"DepositCorrectionDebited",
"DepositCorrectionReceived",
"Fee",
"FeeReceived",
"FundTransfer",
"FundTransferReversed",
"InvoiceDeductionCredited",
"InvoiceDeductionDebited",
"InvoiceDeductionReceived",
"ManualCorrected",
"ManualCorrectionCredited",
"ManualCorrectionDebited",
"MerchantPayin",
"MerchantPayinReceived",
"MerchantPayinReversed",
"Payout",
"PayoutReversed",
@@ -1431,6 +1426,7 @@
"legalBusinessName",
"legalEntity",
"legalEntityType",
"linkedViasVirtualAccount",
"logo",
"merchantAccount",
"merchantCategoryCode",
@@ -1776,46 +1772,44 @@
"Split" : {
"properties" : {
"account" : {
"description" : "Unique identifier of the account where the split amount should be sent. This is required if `type` is **MarketPlace** or **BalanceAccount**.\n\n",
"description" : "The unique identifier of the account to which the split amount is booked. Required if `type` is **MarketPlace** or **BalanceAccount**.\n\n* [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic): The [`accountCode`](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccount#request-accountCode) of the account to which the split amount is booked.\n* [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms): The [`balanceAccountId`](https://docs.adyen.com/api-explorer/balanceplatform/latest/get/balanceAccounts/_id_#path-id) of the account to which the split amount is booked.",
"type" : "string"
},
"amount" : {
"description" : "The amount of this split.",
"description" : "The amount of the split item.\n\n* Required for all split types in the [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic).\n* Required if `type` is **BalanceAccount**, **Commission**, **Default**, or **VAT** in your [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms) integration.",
"$ref" : "#/components/schemas/SplitAmount"
},
"description" : {
"description" : "A description of this split.",
"description" : "Your description for the split item.",
"type" : "string"
},
"reference" : {
"description" : "Your reference for the split, which you can use to link the split to other operations such as captures and refunds.\n\nThis is required if `type` is **MarketPlace** or **BalanceAccount**. For the other types, we also recommend sending a reference so you can reconcile the split and the associated payment in the transaction overview and in the reports. If the reference is not provided, the split is reported as part of the aggregated [TransferBalance record type](https://docs.adyen.com/reporting/marketpay-payments-accounting-report) in Adyen for Platforms.",
"description" : "Your unique reference for the split item.\n\nThis is required if `type` is **MarketPlace** ([Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic)) or **BalanceAccount** ([Balance Platform](https://docs.adyen.com/marketplaces-and-platforms)).\n\nFor the other types, we also recommend providing a **unique** reference so you can reconcile the split and the associated payment in the transaction overview and in the reports.",
"type" : "string"
},
"type" : {
"description" : "The type of split.\nPossible values: **Default**, **PaymentFee**, **VAT**, **Commission**, **MarketPlace**, **BalanceAccount**, **Remainder**, **Surcharge**, **Tip**.",
"description" : "The type of the split item.\n\nPossible values:\n\n* [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic): **Commission**, **Default**, **Marketplace**, **PaymentFee**, **VAT**.\n* [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms): **BalanceAccount**, **Commission**, **Default**, **PaymentFee**, **Remainder**, **Surcharge**, **Tip**, **VAT**.",
"enum" : [
"AcquiringFees",
"AdyenCommission",
"AdyenFees",
"AdyenMarkup",
"BalanceAccount",
"Commission",
"Default",
"Interchange",
"MarketPlace",
"PaymentFee",
"PaymentFeeAcquiring",
"PaymentFeeAdyen",
"PaymentFeeAdyenCommission",
"PaymentFeeAdyenMarkup",
"PaymentFeeInterchange",
"PaymentFeeSchemeFee",
"Remainder",
"SchemeFee",
"Surcharge",
"Tip",
"VAT",
"Verification"
"VAT"
],
"type" : "string"
}
},
"required" : [
"amount",
"type"
],
"type" : "object"
@@ -1823,13 +1817,13 @@
"SplitAmount" : {
"properties" : {
"currency" : {
"description" : "The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes).\n\nIf this value is not provided, the currency in which the payment is made will be used.",
"description" : "The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes). By default, this is the original payment currency.",
"maxLength" : 3,
"minLength" : 3,
"type" : "string"
},
"value" : {
"description" : "The amount in [minor units](https://docs.adyen.com/development-resources/currency-codes).",
"description" : "The value of the split amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).",
"format" : "int64",
"type" : "integer"
}
@@ -1904,6 +1898,7 @@
"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",
"BalancePlatformFundTransfer",
"BalancePlatformSweep",
"BalancePlatformSweepReturned",
"Chargeback",
@@ -1927,15 +1922,19 @@
"DebitedReversed",
"DepositCorrectionCredited",
"DepositCorrectionDebited",
"DepositCorrectionReceived",
"Fee",
"FeeReceived",
"FundTransfer",
"FundTransferReversed",
"InvoiceDeductionCredited",
"InvoiceDeductionDebited",
"InvoiceDeductionReceived",
"ManualCorrected",
"ManualCorrectionCredited",
"ManualCorrectionDebited",
"MerchantPayin",
"MerchantPayinReceived",
"MerchantPayinReversed",
"Payout",
"PayoutReversed",

16
json/HopService-v1.json
View File

@@ -10,17 +10,12 @@
"x-publicVersion" : true,
"title" : "Hosted onboarding 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 Hosted onboarding API provides endpoints that you can use to generate links to Adyen-hosted pages, such as an [onboarding page](https://docs.adyen.com/marketplaces-and-platforms/classic/hosted-onboarding-page) or a [PCI compliance questionnaire](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners). You can provide these links to your account holders so that they can complete their onboarding.\n\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 Hosted onboarding 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/Hop/v1/getOnboardingUrl\n```",
"x-timestamp" : "2023-05-30T15:27:20Z",
"termsOfService" : "https://www.adyen.com/legal/terms-and-conditions",
"contact" : {
"name" : "Adyen Developer Experience team",
"url" : "https://github.com/Adyen/adyen-openapi"
}
},
"x-groups" : [
"Hosted Onboarding Page",
"PCI Compliance Questionnaire Page"
],
"tags" : [
{
"name" : "Hosted Onboarding Page"
@@ -38,7 +33,6 @@
"summary" : "Get a link to a Adyen-hosted onboarding page",
"description" : "Returns a link to an Adyen-hosted onboarding page (HOP) that you can send to your account holder. For more information on how to use HOP, refer to [Hosted onboarding](https://docs.adyen.com/marketplaces-and-platforms/classic/collect-verification-details/hosted-onboarding-page). ",
"operationId" : "post-getOnboardingUrl",
"x-groupName" : "Hosted Onboarding Page",
"x-sortIndex" : 1,
"x-methodName" : "getOnboardingUrl",
"security" : [
@@ -142,7 +136,6 @@
"summary" : "Get a link to a PCI compliance questionnaire",
"description" : "Returns a link to a PCI compliance questionnaire that you can send to your account holder.\n > You should only use this endpoint if you have a [partner platform setup](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners).",
"operationId" : "post-getPciQuestionnaireUrl",
"x-groupName" : "PCI Compliance Questionnaire Page",
"x-sortIndex" : 1,
"x-methodName" : "getPciQuestionnaireUrl",
"security" : [
@@ -244,15 +237,15 @@
"CollectInformation" : {
"properties" : {
"bankDetails" : {
"description" : "Indicates whether [bank account details](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-checks/bank-account-check) must be collected. Default is **true**.",
"description" : "Indicates whether [bank account details](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/accepted-data-format/#bank-accounts) must be collected. Default is **true**.",
"type" : "boolean"
},
"businessDetails" : {
"description" : "Indicates whether [business details](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-checks/company-check) must be collected. Default is **true**.",
"description" : "Indicates whether [business details](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/accepted-data-format/#organizations) must be collected. Default is **true**.",
"type" : "boolean"
},
"individualDetails" : {
"description" : "Indicates whether [individual details](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-checks/identity-check) must be collected. Default is **true**.",
"description" : "Indicates whether [individual details](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/accepted-data-format/#individuals) must be collected. Default is **true**.",
"type" : "boolean"
},
"legalArrangementDetails" : {
@@ -264,7 +257,7 @@
"type" : "boolean"
},
"shareholderDetails" : {
"description" : "Indicates whether [shareholder details](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-checks/identity-check) must be collected. Defaults to **true**.",
"description" : "Indicates whether [shareholder details](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/accepted-data-format/#individuals) must be collected. Defaults to **true**.",
"type" : "boolean"
}
},
@@ -383,6 +376,7 @@
"legalBusinessName",
"legalEntity",
"legalEntityType",
"linkedViasVirtualAccount",
"logo",
"merchantAccount",
"merchantCategoryCode",

16
json/HopService-v5.json
View File

@@ -10,17 +10,12 @@
"x-publicVersion" : true,
"title" : "Hosted onboarding 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 Hosted onboarding API provides endpoints that you can use to generate links to Adyen-hosted pages, such as an [onboarding page](https://docs.adyen.com/marketplaces-and-platforms/classic/hosted-onboarding-page) or a [PCI compliance questionnaire](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners). You can provide these links to your account holders so that they can complete their onboarding.\n\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 Hosted onboarding 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/Hop/v5/getOnboardingUrl\n```",
"x-timestamp" : "2023-05-30T15:27:20Z",
"termsOfService" : "https://www.adyen.com/legal/terms-and-conditions",
"contact" : {
"name" : "Adyen Developer Experience team",
"url" : "https://github.com/Adyen/adyen-openapi"
}
},
"x-groups" : [
"Hosted Onboarding Page",
"PCI Compliance Questionnaire Page"
],
"tags" : [
{
"name" : "Hosted Onboarding Page"
@@ -38,7 +33,6 @@
"summary" : "Get a link to a Adyen-hosted onboarding page",
"description" : "Returns a link to an Adyen-hosted onboarding page (HOP) that you can send to your account holder. For more information on how to use HOP, refer to [Hosted onboarding](https://docs.adyen.com/marketplaces-and-platforms/classic/collect-verification-details/hosted-onboarding-page). ",
"operationId" : "post-getOnboardingUrl",
"x-groupName" : "Hosted Onboarding Page",
"x-sortIndex" : 1,
"x-methodName" : "getOnboardingUrl",
"security" : [
@@ -142,7 +136,6 @@
"summary" : "Get a link to a PCI compliance questionnaire",
"description" : "Returns a link to a PCI compliance questionnaire that you can send to your account holder.\n > You should only use this endpoint if you have a [partner platform setup](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners).",
"operationId" : "post-getPciQuestionnaireUrl",
"x-groupName" : "PCI Compliance Questionnaire Page",
"x-sortIndex" : 1,
"x-methodName" : "getPciQuestionnaireUrl",
"security" : [
@@ -244,15 +237,15 @@
"CollectInformation" : {
"properties" : {
"bankDetails" : {
"description" : "Indicates whether [bank account details](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-checks/bank-account-check) must be collected. Default is **true**.",
"description" : "Indicates whether [bank account details](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/accepted-data-format/#bank-accounts) must be collected. Default is **true**.",
"type" : "boolean"
},
"businessDetails" : {
"description" : "Indicates whether [business details](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-checks/company-check) must be collected. Default is **true**.",
"description" : "Indicates whether [business details](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/accepted-data-format/#organizations) must be collected. Default is **true**.",
"type" : "boolean"
},
"individualDetails" : {
"description" : "Indicates whether [individual details](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-checks/identity-check) must be collected. Default is **true**.",
"description" : "Indicates whether [individual details](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/accepted-data-format/#individuals) must be collected. Default is **true**.",
"type" : "boolean"
},
"legalArrangementDetails" : {
@@ -264,7 +257,7 @@
"type" : "boolean"
},
"shareholderDetails" : {
"description" : "Indicates whether [shareholder details](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-checks/identity-check) must be collected. Defaults to **true**.",
"description" : "Indicates whether [shareholder details](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/accepted-data-format/#individuals) must be collected. Defaults to **true**.",
"type" : "boolean"
}
},
@@ -379,6 +372,7 @@
"legalBusinessName",
"legalEntity",
"legalEntityType",
"linkedViasVirtualAccount",
"logo",
"merchantAccount",
"merchantCategoryCode",

16
json/HopService-v6.json
View File

@@ -10,17 +10,12 @@
"x-publicVersion" : true,
"title" : "Hosted onboarding 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 Hosted onboarding API provides endpoints that you can use to generate links to Adyen-hosted pages, such as an [onboarding page](https://docs.adyen.com/marketplaces-and-platforms/classic/hosted-onboarding-page) or a [PCI compliance questionnaire](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners). You can provide these links to your account holders so that they can complete their onboarding.\n\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 Hosted onboarding 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/Hop/v6/getOnboardingUrl\n```",
"x-timestamp" : "2023-05-30T15:27:20Z",
"termsOfService" : "https://www.adyen.com/legal/terms-and-conditions",
"contact" : {
"name" : "Adyen Developer Experience team",
"url" : "https://github.com/Adyen/adyen-openapi"
}
},
"x-groups" : [
"Hosted Onboarding Page",
"PCI Compliance Questionnaire Page"
],
"tags" : [
{
"name" : "Hosted Onboarding Page"
@@ -38,7 +33,6 @@
"summary" : "Get a link to a Adyen-hosted onboarding page",
"description" : "Returns a link to an Adyen-hosted onboarding page (HOP) that you can send to your account holder. For more information on how to use HOP, refer to [Hosted onboarding](https://docs.adyen.com/marketplaces-and-platforms/classic/collect-verification-details/hosted-onboarding-page). ",
"operationId" : "post-getOnboardingUrl",
"x-groupName" : "Hosted Onboarding Page",
"x-sortIndex" : 1,
"x-methodName" : "getOnboardingUrl",
"security" : [
@@ -142,7 +136,6 @@
"summary" : "Get a link to a PCI compliance questionnaire",
"description" : "Returns a link to a PCI compliance questionnaire that you can send to your account holder.\n > You should only use this endpoint if you have a [partner platform setup](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners).",
"operationId" : "post-getPciQuestionnaireUrl",
"x-groupName" : "PCI Compliance Questionnaire Page",
"x-sortIndex" : 1,
"x-methodName" : "getPciQuestionnaireUrl",
"security" : [
@@ -244,15 +237,15 @@
"CollectInformation" : {
"properties" : {
"bankDetails" : {
"description" : "Indicates whether [bank account details](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-checks/bank-account-check) must be collected. Default is **true**.",
"description" : "Indicates whether [bank account details](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/accepted-data-format/#bank-accounts) must be collected. Default is **true**.",
"type" : "boolean"
},
"businessDetails" : {
"description" : "Indicates whether [business details](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-checks/company-check) must be collected. Default is **true**.",
"description" : "Indicates whether [business details](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/accepted-data-format/#organizations) must be collected. Default is **true**.",
"type" : "boolean"
},
"individualDetails" : {
"description" : "Indicates whether [individual details](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-checks/identity-check) must be collected. Default is **true**.",
"description" : "Indicates whether [individual details](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/accepted-data-format/#individuals) must be collected. Default is **true**.",
"type" : "boolean"
},
"legalArrangementDetails" : {
@@ -264,7 +257,7 @@
"type" : "boolean"
},
"shareholderDetails" : {
"description" : "Indicates whether [shareholder details](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-checks/identity-check) must be collected. Defaults to **true**.",
"description" : "Indicates whether [shareholder details](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/accepted-data-format/#individuals) must be collected. Defaults to **true**.",
"type" : "boolean"
}
},
@@ -379,6 +372,7 @@
"legalBusinessName",
"legalEntity",
"legalEntityType",
"linkedViasVirtualAccount",
"logo",
"merchantAccount",
"merchantCategoryCode",

186
json/MarketPayNotificationService-v3.json
View File

@@ -5,21 +5,26 @@
"x-publicVersion" : true,
"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" : "2023-06-02T11:23:47Z",
"termsOfService" : "https://www.adyen.com/legal/terms-and-conditions",
"contact" : {
"name" : "Adyen Developer Experience team",
"url" : "https://github.com/Adyen/adyen-openapi"
}
},
"x-groups" : [
"Account holders",
"Accounts",
"Fund management",
"Other"
],
"tags" : [
],
{
"name" : "Account holders"
},
{
"name" : "Accounts"
},
{
"name" : "Fund management"
},
{
"name" : "Other"
}
],
"x-staticResponse" : "response.json",
"webhooks" : {
"/ACCOUNT_CLOSED" : {
@@ -30,7 +35,6 @@
"summary" : "Account closed",
"description" : "Adyen sends this webhook when [an account is closed](https://docs.adyen.com/api-explorer/#/Account/latest/post/closeAccount).",
"operationId" : "post-ACCOUNT_CLOSED",
"x-groupName" : "Accounts",
"x-sortIndex" : 3,
"x-methodName" : "accountClosed",
"security" : [
@@ -57,11 +61,6 @@
"200" : {
"content" : {
"application/json" : {
"examples" : {
"accountClosed" : {
"$ref" : "#/components/examples/WebhookAck"
}
},
"schema" : {
"$ref" : "#/components/schemas/NotificationResponse"
}
@@ -80,7 +79,6 @@
"summary" : "Account created",
"description" : "Adyen sends this webhook when [an account is created](https://docs.adyen.com/api-explorer/#/Account/latest/post/createAccount).",
"operationId" : "post-ACCOUNT_CREATED",
"x-groupName" : "Accounts",
"x-sortIndex" : 1,
"x-methodName" : "accountCreated",
"security" : [
@@ -107,11 +105,6 @@
"200" : {
"content" : {
"application/json" : {
"examples" : {
"accountCreated" : {
"$ref" : "#/components/examples/WebhookAck"
}
},
"schema" : {
"$ref" : "#/components/schemas/NotificationResponse"
}
@@ -130,7 +123,6 @@
"summary" : "Liable account's funds are below configured threshold",
"description" : "Adyen sends this notification when the current funds of your liable account are below the configured threshold.",
"operationId" : "post-ACCOUNT_FUNDS_BELOW_THRESHOLD",
"x-groupName" : "Fund management",
"x-sortIndex" : 7,
"x-methodName" : "liableAccountsFundsAreBelowConfiguredThreshold",
"security" : [
@@ -170,7 +162,6 @@
"summary" : "Account holder created",
"description" : "Adyen sends this webhook when [an account holder is created](https://docs.adyen.com/api-explorer/#/Account/latest/post/createAccountHolder).",
"operationId" : "post-ACCOUNT_HOLDER_CREATED",
"x-groupName" : "Account holders",
"x-sortIndex" : 1,
"x-methodName" : "accountHolderCreated",
"security" : [
@@ -203,17 +194,6 @@
"200" : {
"content" : {
"application/json" : {
"examples" : {
"accountHolderCreated-businesses" : {
"$ref" : "#/components/examples/WebhookAck"
},
"accountHolderCreated-failed" : {
"$ref" : "#/components/examples/WebhookAck"
},
"accountHolderCreated-individuals" : {
"$ref" : "#/components/examples/WebhookAck"
}
},
"schema" : {
"$ref" : "#/components/schemas/NotificationResponse"
}
@@ -232,7 +212,6 @@
"summary" : "Paid out to account holder",
"description" : "Adyen sends this notification when a [payout request](https://docs.adyen.com/api-explorer/#/Fund/latest/post/payoutAccountHolder) to an account holder is processed and the payout is scheduled.",
"operationId" : "post-ACCOUNT_HOLDER_PAYOUT",
"x-groupName" : "Fund management",
"x-sortIndex" : 1,
"x-methodName" : "paidOutToAccountHolder",
"security" : [
@@ -262,14 +241,6 @@
"200" : {
"content" : {
"application/json" : {
"examples" : {
"accountHolderPayout-failed" : {
"$ref" : "#/components/examples/WebhookAck"
},
"accountHolderPayout-initiated" : {
"$ref" : "#/components/examples/WebhookAck"
}
},
"schema" : {
"$ref" : "#/components/schemas/NotificationResponse"
}
@@ -288,7 +259,6 @@
"summary" : "Account holder status changed",
"description" : "Adyen sends this webhook when [the status of an account holder is changed](https://docs.adyen.com/api-explorer/#/Account/latest/post/updateAccountHolderState).",
"operationId" : "post-ACCOUNT_HOLDER_STATUS_CHANGE",
"x-groupName" : "Account holders",
"x-sortIndex" : 4,
"x-methodName" : "accountHolderStatusChanged",
"security" : [
@@ -315,11 +285,6 @@
"200" : {
"content" : {
"application/json" : {
"examples" : {
"accountHolderStatusChange" : {
"$ref" : "#/components/examples/WebhookAck"
}
},
"schema" : {
"$ref" : "#/components/schemas/NotificationResponse"
}
@@ -338,7 +303,6 @@
"summary" : "Store status changed",
"description" : "Adyen sends this webhook when [the status of a store](https://docs.adyen.com/api-explorer/#/Account/latest/post/createAccountHolder__reqParam_accountHolderDetails-storeDetails-status) associated with an account holder is changed.",
"operationId" : "post-ACCOUNT_HOLDER_STORE_STATUS_CHANGE",
"x-groupName" : "Account holders",
"x-sortIndex" : 4,
"x-methodName" : "storeStatusChanged",
"security" : [
@@ -365,11 +329,6 @@
"200" : {
"content" : {
"application/json" : {
"examples" : {
"accountHolderStoreStatusChange" : {
"$ref" : "#/components/examples/WebhookAck"
}
},
"schema" : {
"$ref" : "#/components/schemas/NotificationResponse"
}
@@ -388,7 +347,6 @@
"summary" : "Upcoming deadline",
"description" : "Adyen sends this notification when an account holder's deadline to fulfill the requirements of a specific event is coming up.",
"operationId" : "post-ACCOUNT_HOLDER_UPCOMING_DEADLINE",
"x-groupName" : "Account holders",
"x-sortIndex" : 1,
"x-methodName" : "upcomingDeadline",
"security" : [
@@ -428,7 +386,6 @@
"summary" : "Account holder updated",
"description" : "Adyen sends this webhook when [an account holder is updated](https://docs.adyen.com/api-explorer/#/Account/latest/post/updateAccountHolder).",
"operationId" : "post-ACCOUNT_HOLDER_UPDATED",
"x-groupName" : "Account holders",
"x-sortIndex" : 2,
"x-methodName" : "accountHolderUpdated",
"security" : [
@@ -455,11 +412,6 @@
"200" : {
"content" : {
"application/json" : {
"examples" : {
"accountHolderUpdated" : {
"$ref" : "#/components/examples/WebhookAck"
}
},
"schema" : {
"$ref" : "#/components/schemas/NotificationResponse"
}
@@ -478,7 +430,6 @@
"summary" : "Verification results received",
"description" : "Adyen sends this webhook when verification results are available.",
"operationId" : "post-ACCOUNT_HOLDER_VERIFICATION",
"x-groupName" : "Account holders",
"x-sortIndex" : 3,
"x-methodName" : "verificationResultsReceived",
"security" : [
@@ -505,11 +456,6 @@
"200" : {
"content" : {
"application/json" : {
"examples" : {
"accountHolderVerification" : {
"$ref" : "#/components/examples/WebhookAck"
}
},
"schema" : {
"$ref" : "#/components/schemas/NotificationResponse"
}
@@ -528,7 +474,6 @@
"summary" : "Account updated",
"description" : "Adyen sends this webhook when [an account is updated](https://docs.adyen.com/api-explorer/#/Account/latest/post/updateAccount).",
"operationId" : "post-ACCOUNT_UPDATED",
"x-groupName" : "Accounts",
"x-sortIndex" : 2,
"x-methodName" : "accountUpdated",
"security" : [
@@ -555,11 +500,6 @@
"200" : {
"content" : {
"application/json" : {
"examples" : {
"accountUpdated" : {
"$ref" : "#/components/examples/WebhookAck"
}
},
"schema" : {
"$ref" : "#/components/schemas/NotificationResponse"
}
@@ -578,7 +518,6 @@
"summary" : "Beneficiary defined",
"description" : "Adyen sends this notification when a [benefactor/beneficiary relationship is created](https://docs.adyen.com/api-explorer/#/Fund/latest/post/transferFunds).",
"operationId" : "post-BENEFICIARY_SETUP",
"x-groupName" : "Fund management",
"x-sortIndex" : 3,
"x-methodName" : "beneficiaryDefined",
"security" : [
@@ -605,11 +544,6 @@
"200" : {
"content" : {
"application/json" : {
"examples" : {
"beneficiarySetup" : {
"$ref" : "#/components/examples/WebhookAck"
}
},
"schema" : {
"$ref" : "#/components/schemas/NotificationResponse"
}
@@ -628,7 +562,6 @@
"summary" : "Negative account balances compensated",
"description" : "Adyen sends this notification when funds are transferred from your platform's liable account to an overdrawn account to compensate for the overdraft.",
"operationId" : "post-COMPENSATE_NEGATIVE_BALANCE",
"x-groupName" : "Fund management",
"x-sortIndex" : 5,
"x-methodName" : "negativeAccountBalancesCompensated",
"security" : [
@@ -655,11 +588,6 @@
"200" : {
"content" : {
"application/json" : {
"examples" : {
"compensateNegativeBalance" : {
"$ref" : "#/components/examples/WebhookAck"
}
},
"schema" : {
"$ref" : "#/components/schemas/NotificationResponse"
}
@@ -678,7 +606,6 @@
"summary" : "Automated direct debit initiated",
"description" : "Adyen sends this notification when a [direct debit is initiated](https://docs.adyen.com/api-explorer/#/Fund/latest/post/debitAccountHolder).",
"operationId" : "post-DIRECT_DEBIT_INITIATED",
"x-groupName" : "Fund management",
"x-sortIndex" : 7,
"x-methodName" : "automatedDirectDebitInitiated",
"security" : [
@@ -708,14 +635,6 @@
"200" : {
"content" : {
"application/json" : {
"examples" : {
"directDebitInitiated" : {
"$ref" : "#/components/examples/WebhookAck"
},
"directDebitInitiated-failed" : {
"$ref" : "#/components/examples/WebhookAck"
}
},
"schema" : {
"$ref" : "#/components/schemas/NotificationResponse"
}
@@ -734,7 +653,6 @@
"summary" : "Booking for a capture or refund failed",
"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,
"x-methodName" : "bookingForCaptureOrRefundFailed",
"security" : [
@@ -761,11 +679,6 @@
"200" : {
"content" : {
"application/json" : {
"examples" : {
"paymentFailure" : {
"$ref" : "#/components/examples/WebhookAck"
}
},
"schema" : {
"$ref" : "#/components/schemas/NotificationResponse"
}
@@ -784,7 +697,6 @@
"summary" : "Funds transfer between accounts refunded",
"description" : "Adyen sends this notification when [funds transferred between accounts are refunded](https://docs.adyen.com/api-explorer/#/Fund/v6/latest/refundFundsTransfer).",
"operationId" : "post-REFUND_FUNDS_TRANSFER",
"x-groupName" : "Fund management",
"x-sortIndex" : 6,
"x-methodName" : "fundsTransferBetweenAccountsRefunded",
"security" : [
@@ -824,7 +736,6 @@
"summary" : "Report available",
"description" : "Adyen sends this notification when a report has been generated and it is available for download.",
"operationId" : "post-REPORT_AVAILABLE",
"x-groupName" : "Other",
"x-sortIndex" : 2,
"x-methodName" : "reportAvailable",
"security" : [
@@ -851,11 +762,6 @@
"200" : {
"content" : {
"application/json" : {
"examples" : {
"reportAvailable" : {
"$ref" : "#/components/examples/WebhookAck"
}
},
"schema" : {
"$ref" : "#/components/schemas/NotificationResponse"
}
@@ -874,7 +780,6 @@
"summary" : "'Refund Transfers Not Paid Out' call processed and refunds scheduled",
"description" : "Adyen sends this notification when a request to [refund transfers that are not yet paid out](https://docs.adyen.com/api-explorer/#/Fund/latest/refundNotPaidOutTransfers) is processed and the associated refunds are scheduled.",
"operationId" : "post-SCHEDULED_REFUNDS",
"x-groupName" : "Fund management",
"x-sortIndex" : 4,
"x-methodName" : "refundTransfersNotPaidOutCallProcessedAndRefundsScheduled",
"security" : [
@@ -901,11 +806,6 @@
"200" : {
"content" : {
"application/json" : {
"examples" : {
"scheduledRefunds" : {
"$ref" : "#/components/examples/WebhookAck"
}
},
"schema" : {
"$ref" : "#/components/schemas/NotificationResponse"
}
@@ -924,7 +824,6 @@
"summary" : "Funds transferred between accounts",
"description" : "Adyen sends this notification when [funds are transferred between accounts](https://docs.adyen.com/api-explorer/#/Fund/latest/post/transferFunds).",
"operationId" : "post-TRANSFER_FUNDS",
"x-groupName" : "Fund management",
"x-sortIndex" : 2,
"x-methodName" : "fundsTransferredBetweenAccounts",
"security" : [
@@ -951,11 +850,6 @@
"200" : {
"content" : {
"application/json" : {
"examples" : {
"transferFunds" : {
"$ref" : "#/components/examples/WebhookAck"
}
},
"schema" : {
"$ref" : "#/components/schemas/NotificationResponse"
}
@@ -1459,7 +1353,9 @@
"DeleteLiableBankAccount",
"DeletePayoutMethods",
"DeleteShareholders",
"DeleteShareholdersNoKyc",
"DeleteSignatories",
"DeleteUnusedAccount",
"InactivateAccount",
"KYCDeadlineExtension",
"MigrateAccountToBP",
@@ -1468,7 +1364,6 @@
"ResolveEvents",
"SaveAccountHolder",
"SaveKYCCheckStatus",
"SavePEPChecks",
"SuspendAccount",
"UnSuspendAccount",
"UpdateAccountHolderState",
@@ -2092,7 +1987,7 @@
"type" : "string"
},
"payoutSchedule" : {
"description" : "The payout schedule of the account.",
"description" : "The details of the payout schedule added to the account.",
"$ref" : "#/components/schemas/PayoutScheduleResponse"
},
"pspReference" : {
@@ -2309,6 +2204,7 @@
"legalBusinessName",
"legalEntity",
"legalEntityType",
"linkedViasVirtualAccount",
"logo",
"merchantAccount",
"merchantCategoryCode",
@@ -2715,7 +2611,7 @@
"type" : "string"
},
"schedule" : {
"description" : "The payout schedule of the account.\nPermitted values: `DEFAULT`, `DAILY`, `DAILY_US`, `DAILY_EU`, `DAILY_AU`, `DAILY_SG`, `WEEKLY`, `WEEKLY_ON_TUE_FRI_MIDNIGHT`, `BIWEEKLY_ON_1ST_AND_15TH_AT_MIDNIGHT`, `MONTHLY`, `HOLD`.",
"description" : "The payout schedule for the account.\n\nPossible values: `DEFAULT`, `DAILY`, `DAILY_US`, `DAILY_EU`, `DAILY_AU`, `DAILY_SG`, `WEEKLY`, `WEEKLY_ON_TUE_FRI_MIDNIGHT`, `BIWEEKLY_ON_1ST_AND_15TH_AT_MIDNIGHT`, `MONTHLY`, `HOLD`.\n> `HOLD` prevents scheduled payouts, but you can still initiate payouts manually.",
"enum" : [
"BIWEEKLY_ON_1ST_AND_15TH_AT_MIDNIGHT",
"DAILY",
@@ -3086,46 +2982,44 @@
"Split" : {
"properties" : {
"account" : {
"description" : "Unique identifier of the account where the split amount should be sent. This is required if `type` is **MarketPlace** or **BalanceAccount**.\n\n",
"description" : "The unique identifier of the account to which the split amount is booked. Required if `type` is **MarketPlace** or **BalanceAccount**.\n\n* [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic): The [`accountCode`](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccount#request-accountCode) of the account to which the split amount is booked.\n* [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms): The [`balanceAccountId`](https://docs.adyen.com/api-explorer/balanceplatform/latest/get/balanceAccounts/_id_#path-id) of the account to which the split amount is booked.",
"type" : "string"
},
"amount" : {
"description" : "The amount of this split.",
"description" : "The amount of the split item.\n\n* Required for all split types in the [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic).\n* Required if `type` is **BalanceAccount**, **Commission**, **Default**, or **VAT** in your [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms) integration.",
"$ref" : "#/components/schemas/SplitAmount"
},
"description" : {
"description" : "A description of this split.",
"description" : "Your description for the split item.",
"type" : "string"
},
"reference" : {
"description" : "Your reference for the split, which you can use to link the split to other operations such as captures and refunds.\n\nThis is required if `type` is **MarketPlace** or **BalanceAccount**. For the other types, we also recommend sending a reference so you can reconcile the split and the associated payment in the transaction overview and in the reports. If the reference is not provided, the split is reported as part of the aggregated [TransferBalance record type](https://docs.adyen.com/reporting/marketpay-payments-accounting-report) in Adyen for Platforms.",
"description" : "Your unique reference for the split item.\n\nThis is required if `type` is **MarketPlace** ([Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic)) or **BalanceAccount** ([Balance Platform](https://docs.adyen.com/marketplaces-and-platforms)).\n\nFor the other types, we also recommend providing a **unique** reference so you can reconcile the split and the associated payment in the transaction overview and in the reports.",
"type" : "string"
},
"type" : {
"description" : "The type of split.\nPossible values: **Default**, **PaymentFee**, **VAT**, **Commission**, **MarketPlace**, **BalanceAccount**, **Remainder**, **Surcharge**, **Tip**.",
"description" : "The type of the split item.\n\nPossible values:\n\n* [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic): **Commission**, **Default**, **Marketplace**, **PaymentFee**, **VAT**.\n* [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms): **BalanceAccount**, **Commission**, **Default**, **PaymentFee**, **Remainder**, **Surcharge**, **Tip**, **VAT**.",
"enum" : [
"AcquiringFees",
"AdyenCommission",
"AdyenFees",
"AdyenMarkup",
"BalanceAccount",
"Commission",
"Default",
"Interchange",
"MarketPlace",
"PaymentFee",
"PaymentFeeAcquiring",
"PaymentFeeAdyen",
"PaymentFeeAdyenCommission",
"PaymentFeeAdyenMarkup",
"PaymentFeeInterchange",
"PaymentFeeSchemeFee",
"Remainder",
"SchemeFee",
"Surcharge",
"Tip",
"VAT",
"Verification"
"VAT"
],
"type" : "string"
}
},
"required" : [
"amount",
"type"
],
"type" : "object"
@@ -3133,13 +3027,13 @@
"SplitAmount" : {
"properties" : {
"currency" : {
"description" : "The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes).\n\nIf this value is not provided, the currency in which the payment is made will be used.",
"description" : "The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes). By default, this is the original payment currency.",
"maxLength" : 3,
"minLength" : 3,
"type" : "string"
},
"value" : {
"description" : "The amount in [minor units](https://docs.adyen.com/development-resources/currency-codes).",
"description" : "The value of the split amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).",
"format" : "int64",
"type" : "integer"
}
@@ -3214,6 +3108,7 @@
"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",
"BalancePlatformFundTransfer",
"BalancePlatformSweep",
"BalancePlatformSweepReturned",
"Chargeback",
@@ -3237,15 +3132,19 @@
"DebitedReversed",
"DepositCorrectionCredited",
"DepositCorrectionDebited",
"DepositCorrectionReceived",
"Fee",
"FeeReceived",
"FundTransfer",
"FundTransferReversed",
"InvoiceDeductionCredited",
"InvoiceDeductionDebited",
"InvoiceDeductionReceived",
"ManualCorrected",
"ManualCorrectionCredited",
"ManualCorrectionDebited",
"MerchantPayin",
"MerchantPayinReceived",
"MerchantPayinReversed",
"Payout",
"PayoutReversed",
@@ -3435,7 +3334,7 @@
"type" : "string"
},
"payoutSchedule" : {
"description" : "The payout schedule of the account.",
"description" : "The details of the payout schedule to which the account is updated.",
"$ref" : "#/components/schemas/PayoutScheduleResponse"
},
"pspReference" : {
@@ -3579,10 +3478,6 @@
}
},
"examples" : {
"WebhookAck" : {
"summary" : "Acknowledge Webhook",
"value" : "[accepted]"
},
"post-ACCOUNT_CLOSED-accountClosed" : {
"summary" : "ACCOUNT_CLOSED example",
"value" : {
@@ -3687,7 +3582,6 @@
"fullPhoneNumber" : "+31858888138",
"name" : {
"firstName" : "Firstname",
"gender" : "UNKNOWN",
"infix" : "infix",
"lastName" : "Lastname"
},
@@ -3721,7 +3615,6 @@
"individualDetails" : {
"name" : {
"firstName" : "Firstname",
"gender" : "UNKNOWN",
"infix" : "infix",
"lastName" : "Lastname"
},
@@ -3944,7 +3837,6 @@
"individualDetails" : {
"name" : {
"firstName" : "Firstname",
"gender" : "UNKNOWN",
"infix" : "infix",
"lastName" : "Lastname"
},
@@ -4337,7 +4229,6 @@
"fullPhoneNumber" : "+31858888138",
"name" : {
"firstName" : "Firstname",
"gender" : "UNKNOWN",
"infix" : "infix",
"lastName" : "Lastname"
},
@@ -4371,7 +4262,6 @@
"individualDetails" : {
"name" : {
"firstName" : "Firstname",
"gender" : "UNKNOWN",
"infix" : "infix",
"lastName" : "Lastname"
},

185
json/MarketPayNotificationService-v4.json
View File

@@ -5,21 +5,26 @@
"x-publicVersion" : true,
"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" : "2023-06-02T11:23:48Z",
"termsOfService" : "https://www.adyen.com/legal/terms-and-conditions",
"contact" : {
"name" : "Adyen Developer Experience team",
"url" : "https://github.com/Adyen/adyen-openapi"
}
},
"x-groups" : [
"Account holders",
"Accounts",
"Fund management",
"Other"
],
"tags" : [
],
{
"name" : "Account holders"
},
{
"name" : "Accounts"
},
{
"name" : "Fund management"
},
{
"name" : "Other"
}
],
"x-staticResponse" : "response.json",
"webhooks" : {
"/ACCOUNT_CLOSED" : {
@@ -30,7 +35,6 @@
"summary" : "Account closed",
"description" : "Adyen sends this webhook when [an account is closed](https://docs.adyen.com/api-explorer/#/Account/latest/post/closeAccount).",
"operationId" : "post-ACCOUNT_CLOSED",
"x-groupName" : "Accounts",
"x-sortIndex" : 3,
"x-methodName" : "accountClosed",
"security" : [
@@ -57,11 +61,6 @@
"200" : {
"content" : {
"application/json" : {
"examples" : {
"accountClosed" : {
"$ref" : "#/components/examples/WebhookAck"
}
},
"schema" : {
"$ref" : "#/components/schemas/NotificationResponse"
}
@@ -80,7 +79,6 @@
"summary" : "Account created",
"description" : "Adyen sends this webhook when [an account is created](https://docs.adyen.com/api-explorer/#/Account/latest/post/createAccount).",
"operationId" : "post-ACCOUNT_CREATED",
"x-groupName" : "Accounts",
"x-sortIndex" : 1,
"x-methodName" : "accountCreated",
"security" : [
@@ -107,11 +105,6 @@
"200" : {
"content" : {
"application/json" : {
"examples" : {
"accountCreated" : {
"$ref" : "#/components/examples/WebhookAck"
}
},
"schema" : {
"$ref" : "#/components/schemas/NotificationResponse"
}
@@ -130,7 +123,6 @@
"summary" : "Liable account's funds are below configured threshold",
"description" : "Adyen sends this notification when the current funds of your liable account are below the configured threshold.",
"operationId" : "post-ACCOUNT_FUNDS_BELOW_THRESHOLD",
"x-groupName" : "Fund management",
"x-sortIndex" : 7,
"x-methodName" : "liableAccountsFundsAreBelowConfiguredThreshold",
"security" : [
@@ -170,7 +162,6 @@
"summary" : "Account holder created",
"description" : "Adyen sends this webhook when [an account holder is created](https://docs.adyen.com/api-explorer/#/Account/latest/post/createAccountHolder).",
"operationId" : "post-ACCOUNT_HOLDER_CREATED",
"x-groupName" : "Account holders",
"x-sortIndex" : 1,
"x-methodName" : "accountHolderCreated",
"security" : [
@@ -203,17 +194,6 @@
"200" : {
"content" : {
"application/json" : {
"examples" : {
"accountHolderCreated-businesses" : {
"$ref" : "#/components/examples/WebhookAck"
},
"accountHolderCreated-failed" : {
"$ref" : "#/components/examples/WebhookAck"
},
"accountHolderCreated-individuals" : {
"$ref" : "#/components/examples/WebhookAck"
}
},
"schema" : {
"$ref" : "#/components/schemas/NotificationResponse"
}
@@ -232,7 +212,6 @@
"summary" : "Paid out to account holder",
"description" : "Adyen sends this notification when a [payout request](https://docs.adyen.com/api-explorer/#/Fund/latest/post/payoutAccountHolder) to an account holder is processed and the payout is scheduled.",
"operationId" : "post-ACCOUNT_HOLDER_PAYOUT",
"x-groupName" : "Fund management",
"x-sortIndex" : 1,
"x-methodName" : "paidOutToAccountHolder",
"security" : [
@@ -262,14 +241,6 @@
"200" : {
"content" : {
"application/json" : {
"examples" : {
"accountHolderPayout-failed" : {
"$ref" : "#/components/examples/WebhookAck"
},
"accountHolderPayout-initiated" : {
"$ref" : "#/components/examples/WebhookAck"
}
},
"schema" : {
"$ref" : "#/components/schemas/NotificationResponse"
}
@@ -288,7 +259,6 @@
"summary" : "Account holder status changed",
"description" : "Adyen sends this webhook when [the status of an account holder is changed](https://docs.adyen.com/api-explorer/#/Account/latest/post/updateAccountHolderState).",
"operationId" : "post-ACCOUNT_HOLDER_STATUS_CHANGE",
"x-groupName" : "Account holders",
"x-sortIndex" : 4,
"x-methodName" : "accountHolderStatusChanged",
"security" : [
@@ -315,11 +285,6 @@
"200" : {
"content" : {
"application/json" : {
"examples" : {
"accountHolderStatusChange" : {
"$ref" : "#/components/examples/WebhookAck"
}
},
"schema" : {
"$ref" : "#/components/schemas/NotificationResponse"
}
@@ -338,7 +303,6 @@
"summary" : "Store status changed",
"description" : "Adyen sends this webhook when [the status of a store](https://docs.adyen.com/api-explorer/#/Account/latest/post/createAccountHolder__reqParam_accountHolderDetails-storeDetails-status) associated with an account holder is changed.",
"operationId" : "post-ACCOUNT_HOLDER_STORE_STATUS_CHANGE",
"x-groupName" : "Account holders",
"x-sortIndex" : 4,
"x-methodName" : "storeStatusChanged",
"security" : [
@@ -365,11 +329,6 @@
"200" : {
"content" : {
"application/json" : {
"examples" : {
"accountHolderStoreStatusChange" : {
"$ref" : "#/components/examples/WebhookAck"
}
},
"schema" : {
"$ref" : "#/components/schemas/NotificationResponse"
}
@@ -388,7 +347,6 @@
"summary" : "Upcoming deadline",
"description" : "Adyen sends this notification when an account holder's deadline to fulfill the requirements of a specific event is coming up.",
"operationId" : "post-ACCOUNT_HOLDER_UPCOMING_DEADLINE",
"x-groupName" : "Account holders",
"x-sortIndex" : 1,
"x-methodName" : "upcomingDeadline",
"security" : [
@@ -428,7 +386,6 @@
"summary" : "Account holder updated",
"description" : "Adyen sends this webhook when [an account holder is updated](https://docs.adyen.com/api-explorer/#/Account/latest/post/updateAccountHolder).",
"operationId" : "post-ACCOUNT_HOLDER_UPDATED",
"x-groupName" : "Account holders",
"x-sortIndex" : 2,
"x-methodName" : "accountHolderUpdated",
"security" : [
@@ -455,11 +412,6 @@
"200" : {
"content" : {
"application/json" : {
"examples" : {
"accountHolderUpdated" : {
"$ref" : "#/components/examples/WebhookAck"
}
},
"schema" : {
"$ref" : "#/components/schemas/NotificationResponse"
}
@@ -478,7 +430,6 @@
"summary" : "Verification results received",
"description" : "Adyen sends this webhook when verification results are available.",
"operationId" : "post-ACCOUNT_HOLDER_VERIFICATION",
"x-groupName" : "Account holders",
"x-sortIndex" : 3,
"x-methodName" : "verificationResultsReceived",
"security" : [
@@ -505,11 +456,6 @@
"200" : {
"content" : {
"application/json" : {
"examples" : {
"accountHolderVerification" : {
"$ref" : "#/components/examples/WebhookAck"
}
},
"schema" : {
"$ref" : "#/components/schemas/NotificationResponse"
}
@@ -528,7 +474,6 @@
"summary" : "Account updated",
"description" : "Adyen sends this webhook when [an account is updated](https://docs.adyen.com/api-explorer/#/Account/latest/post/updateAccount).",
"operationId" : "post-ACCOUNT_UPDATED",
"x-groupName" : "Accounts",
"x-sortIndex" : 2,
"x-methodName" : "accountUpdated",
"security" : [
@@ -555,11 +500,6 @@
"200" : {
"content" : {
"application/json" : {
"examples" : {
"accountUpdated" : {
"$ref" : "#/components/examples/WebhookAck"
}
},
"schema" : {
"$ref" : "#/components/schemas/NotificationResponse"
}
@@ -578,7 +518,6 @@
"summary" : "Beneficiary defined",
"description" : "Adyen sends this notification when a [benefactor/beneficiary relationship is created](https://docs.adyen.com/api-explorer/#/Fund/latest/post/transferFunds).",
"operationId" : "post-BENEFICIARY_SETUP",
"x-groupName" : "Fund management",
"x-sortIndex" : 3,
"x-methodName" : "beneficiaryDefined",
"security" : [
@@ -605,11 +544,6 @@
"200" : {
"content" : {
"application/json" : {
"examples" : {
"beneficiarySetup" : {
"$ref" : "#/components/examples/WebhookAck"
}
},
"schema" : {
"$ref" : "#/components/schemas/NotificationResponse"
}
@@ -628,7 +562,6 @@
"summary" : "Negative account balances compensated",
"description" : "Adyen sends this notification when funds are transferred from your platform's liable account to an overdrawn account to compensate for the overdraft.",
"operationId" : "post-COMPENSATE_NEGATIVE_BALANCE",
"x-groupName" : "Fund management",
"x-sortIndex" : 5,
"x-methodName" : "negativeAccountBalancesCompensated",
"security" : [
@@ -655,11 +588,6 @@
"200" : {
"content" : {
"application/json" : {
"examples" : {
"compensateNegativeBalance" : {
"$ref" : "#/components/examples/WebhookAck"
}
},
"schema" : {
"$ref" : "#/components/schemas/NotificationResponse"
}
@@ -678,7 +606,6 @@
"summary" : "Automated direct debit initiated",
"description" : "Adyen sends this notification when a [direct debit is initiated](https://docs.adyen.com/api-explorer/#/Fund/latest/post/debitAccountHolder).",
"operationId" : "post-DIRECT_DEBIT_INITIATED",
"x-groupName" : "Fund management",
"x-sortIndex" : 7,
"x-methodName" : "automatedDirectDebitInitiated",
"security" : [
@@ -708,14 +635,6 @@
"200" : {
"content" : {
"application/json" : {
"examples" : {
"directDebitInitiated" : {
"$ref" : "#/components/examples/WebhookAck"
},
"directDebitInitiated-failed" : {
"$ref" : "#/components/examples/WebhookAck"
}
},
"schema" : {
"$ref" : "#/components/schemas/NotificationResponse"
}
@@ -734,7 +653,6 @@
"summary" : "Booking for a capture or refund failed",
"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,
"x-methodName" : "bookingForCaptureOrRefundFailed",
"security" : [
@@ -761,11 +679,6 @@
"200" : {
"content" : {
"application/json" : {
"examples" : {
"paymentFailure" : {
"$ref" : "#/components/examples/WebhookAck"
}
},
"schema" : {
"$ref" : "#/components/schemas/NotificationResponse"
}
@@ -784,7 +697,6 @@
"summary" : "Funds transfer between accounts refunded",
"description" : "Adyen sends this notification when [funds transferred between accounts are refunded](https://docs.adyen.com/api-explorer/#/Fund/v6/latest/refundFundsTransfer).",
"operationId" : "post-REFUND_FUNDS_TRANSFER",
"x-groupName" : "Fund management",
"x-sortIndex" : 6,
"x-methodName" : "fundsTransferBetweenAccountsRefunded",
"security" : [
@@ -824,7 +736,6 @@
"summary" : "Report available",
"description" : "Adyen sends this notification when a report has been generated and it is available for download.",
"operationId" : "post-REPORT_AVAILABLE",
"x-groupName" : "Other",
"x-sortIndex" : 2,
"x-methodName" : "reportAvailable",
"security" : [
@@ -851,11 +762,6 @@
"200" : {
"content" : {
"application/json" : {
"examples" : {
"reportAvailable" : {
"$ref" : "#/components/examples/WebhookAck"
}
},
"schema" : {
"$ref" : "#/components/schemas/NotificationResponse"
}
@@ -874,7 +780,6 @@
"summary" : "'Refund Transfers Not Paid Out' call processed and refunds scheduled",
"description" : "Adyen sends this notification when a request to [refund transfers that are not yet paid out](https://docs.adyen.com/api-explorer/#/Fund/latest/refundNotPaidOutTransfers) is processed and the associated refunds are scheduled.",
"operationId" : "post-SCHEDULED_REFUNDS",
"x-groupName" : "Fund management",
"x-sortIndex" : 4,
"x-methodName" : "refundTransfersNotPaidOutCallProcessedAndRefundsScheduled",
"security" : [
@@ -901,11 +806,6 @@
"200" : {
"content" : {
"application/json" : {
"examples" : {
"scheduledRefunds" : {
"$ref" : "#/components/examples/WebhookAck"
}
},
"schema" : {
"$ref" : "#/components/schemas/NotificationResponse"
}
@@ -924,7 +824,6 @@
"summary" : "Funds transferred between accounts",
"description" : "Adyen sends this notification when [funds are transferred between accounts](https://docs.adyen.com/api-explorer/#/Fund/latest/post/transferFunds).",
"operationId" : "post-TRANSFER_FUNDS",
"x-groupName" : "Fund management",
"x-sortIndex" : 2,
"x-methodName" : "fundsTransferredBetweenAccounts",
"security" : [
@@ -951,11 +850,6 @@
"200" : {
"content" : {
"application/json" : {
"examples" : {
"transferFunds" : {
"$ref" : "#/components/examples/WebhookAck"
}
},
"schema" : {
"$ref" : "#/components/schemas/NotificationResponse"
}
@@ -1515,7 +1409,9 @@
"DeleteLiableBankAccount",
"DeletePayoutMethods",
"DeleteShareholders",
"DeleteShareholdersNoKyc",
"DeleteSignatories",
"DeleteUnusedAccount",
"InactivateAccount",
"KYCDeadlineExtension",
"MigrateAccountToBP",
@@ -1524,7 +1420,6 @@
"ResolveEvents",
"SaveAccountHolder",
"SaveKYCCheckStatus",
"SavePEPChecks",
"SuspendAccount",
"UnSuspendAccount",
"UpdateAccountHolderState",
@@ -2205,7 +2100,7 @@
"type" : "string"
},
"payoutSchedule" : {
"description" : "The payout schedule of the account.",
"description" : "The details of the payout schedule added to the account.",
"$ref" : "#/components/schemas/PayoutScheduleResponse"
},
"pspReference" : {
@@ -2432,6 +2327,7 @@
"legalBusinessName",
"legalEntity",
"legalEntityType",
"linkedViasVirtualAccount",
"logo",
"merchantAccount",
"merchantCategoryCode",
@@ -2825,7 +2721,7 @@
"type" : "string"
},
"schedule" : {
"description" : "The payout schedule of the account.\nPermitted values: `DEFAULT`, `DAILY`, `DAILY_US`, `DAILY_EU`, `DAILY_AU`, `DAILY_SG`, `WEEKLY`, `WEEKLY_ON_TUE_FRI_MIDNIGHT`, `BIWEEKLY_ON_1ST_AND_15TH_AT_MIDNIGHT`, `MONTHLY`, `HOLD`.",
"description" : "The payout schedule for the account.\n\nPossible values: `DEFAULT`, `DAILY`, `DAILY_US`, `DAILY_EU`, `DAILY_AU`, `DAILY_SG`, `WEEKLY`, `WEEKLY_ON_TUE_FRI_MIDNIGHT`, `BIWEEKLY_ON_1ST_AND_15TH_AT_MIDNIGHT`, `MONTHLY`, `HOLD`.\n> `HOLD` prevents scheduled payouts, but you can still initiate payouts manually.",
"enum" : [
"BIWEEKLY_ON_1ST_AND_15TH_AT_MIDNIGHT",
"DAILY",
@@ -3217,46 +3113,44 @@
"Split" : {
"properties" : {
"account" : {
"description" : "Unique identifier of the account where the split amount should be sent. This is required if `type` is **MarketPlace** or **BalanceAccount**.\n\n",
"description" : "The unique identifier of the account to which the split amount is booked. Required if `type` is **MarketPlace** or **BalanceAccount**.\n\n* [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic): The [`accountCode`](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccount#request-accountCode) of the account to which the split amount is booked.\n* [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms): The [`balanceAccountId`](https://docs.adyen.com/api-explorer/balanceplatform/latest/get/balanceAccounts/_id_#path-id) of the account to which the split amount is booked.",
"type" : "string"
},
"amount" : {
"description" : "The amount of this split.",
"description" : "The amount of the split item.\n\n* Required for all split types in the [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic).\n* Required if `type` is **BalanceAccount**, **Commission**, **Default**, or **VAT** in your [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms) integration.",
"$ref" : "#/components/schemas/SplitAmount"
},
"description" : {
"description" : "A description of this split.",
"description" : "Your description for the split item.",
"type" : "string"
},
"reference" : {
"description" : "Your reference for the split, which you can use to link the split to other operations such as captures and refunds.\n\nThis is required if `type` is **MarketPlace** or **BalanceAccount**. For the other types, we also recommend sending a reference so you can reconcile the split and the associated payment in the transaction overview and in the reports. If the reference is not provided, the split is reported as part of the aggregated [TransferBalance record type](https://docs.adyen.com/reporting/marketpay-payments-accounting-report) in Adyen for Platforms.",
"description" : "Your unique reference for the split item.\n\nThis is required if `type` is **MarketPlace** ([Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic)) or **BalanceAccount** ([Balance Platform](https://docs.adyen.com/marketplaces-and-platforms)).\n\nFor the other types, we also recommend providing a **unique** reference so you can reconcile the split and the associated payment in the transaction overview and in the reports.",
"type" : "string"
},
"type" : {
"description" : "The type of split.\nPossible values: **Default**, **PaymentFee**, **VAT**, **Commission**, **MarketPlace**, **BalanceAccount**, **Remainder**, **Surcharge**, **Tip**.",
"description" : "The type of the split item.\n\nPossible values:\n\n* [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic): **Commission**, **Default**, **Marketplace**, **PaymentFee**, **VAT**.\n* [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms): **BalanceAccount**, **Commission**, **Default**, **PaymentFee**, **Remainder**, **Surcharge**, **Tip**, **VAT**.",
"enum" : [
"AcquiringFees",
"AdyenCommission",
"AdyenFees",
"AdyenMarkup",
"BalanceAccount",
"Commission",
"Default",
"Interchange",
"MarketPlace",
"PaymentFee",
"PaymentFeeAcquiring",
"PaymentFeeAdyen",
"PaymentFeeAdyenCommission",
"PaymentFeeAdyenMarkup",
"PaymentFeeInterchange",
"PaymentFeeSchemeFee",
"Remainder",
"SchemeFee",
"Surcharge",
"Tip",
"VAT",
"Verification"
"VAT"
],
"type" : "string"
}
},
"required" : [
"amount",
"type"
],
"type" : "object"
@@ -3264,13 +3158,13 @@
"SplitAmount" : {
"properties" : {
"currency" : {
"description" : "The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes).\n\nIf this value is not provided, the currency in which the payment is made will be used.",
"description" : "The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes). By default, this is the original payment currency.",
"maxLength" : 3,
"minLength" : 3,
"type" : "string"
},
"value" : {
"description" : "The amount in [minor units](https://docs.adyen.com/development-resources/currency-codes).",
"description" : "The value of the split amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).",
"format" : "int64",
"type" : "integer"
}
@@ -3345,6 +3239,7 @@
"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",
"BalancePlatformFundTransfer",
"BalancePlatformSweep",
"BalancePlatformSweepReturned",
"Chargeback",
@@ -3368,15 +3263,19 @@
"DebitedReversed",
"DepositCorrectionCredited",
"DepositCorrectionDebited",
"DepositCorrectionReceived",
"Fee",
"FeeReceived",
"FundTransfer",
"FundTransferReversed",
"InvoiceDeductionCredited",
"InvoiceDeductionDebited",
"InvoiceDeductionReceived",
"ManualCorrected",
"ManualCorrectionCredited",
"ManualCorrectionDebited",
"MerchantPayin",
"MerchantPayinReceived",
"MerchantPayinReversed",
"Payout",
"PayoutReversed",
@@ -3593,7 +3492,7 @@
"type" : "string"
},
"payoutSchedule" : {
"description" : "The payout schedule of the account.",
"description" : "The details of the payout schedule to which the account is updated.",
"$ref" : "#/components/schemas/PayoutScheduleResponse"
},
"pspReference" : {
@@ -3737,10 +3636,6 @@
}
},
"examples" : {
"WebhookAck" : {
"summary" : "Acknowledge Webhook",
"value" : "[accepted]"
},
"post-ACCOUNT_CLOSED-accountClosed" : {
"summary" : "ACCOUNT_CLOSED example",
"value" : {
@@ -3850,7 +3745,6 @@
"fullPhoneNumber" : "+31858888138",
"name" : {
"firstName" : "Firstname",
"gender" : "UNKNOWN",
"infix" : "infix",
"lastName" : "Lastname"
},
@@ -4089,7 +3983,6 @@
"individualDetails" : {
"name" : {
"firstName" : "Firstname",
"gender" : "UNKNOWN",
"infix" : "infix",
"lastName" : "Lastname"
},
@@ -4489,7 +4382,6 @@
"fullPhoneNumber" : "+31858888138",
"name" : {
"firstName" : "Firstname",
"gender" : "UNKNOWN",
"infix" : "infix",
"lastName" : "Lastname"
},
@@ -4523,7 +4415,6 @@
"individualDetails" : {
"name" : {
"firstName" : "Firstname",
"gender" : "UNKNOWN",
"infix" : "infix",
"lastName" : "Lastname"
},

200
json/MarketPayNotificationService-v5.json
View File

@@ -5,21 +5,26 @@
"x-publicVersion" : true,
"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" : "2023-06-02T11:23:48Z",
"termsOfService" : "https://www.adyen.com/legal/terms-and-conditions",
"contact" : {
"name" : "Adyen Developer Experience team",
"url" : "https://github.com/Adyen/adyen-openapi"
}
},
"x-groups" : [
"Account holders",
"Accounts",
"Fund management",
"Other"
],
"tags" : [
],
{
"name" : "Account holders"
},
{
"name" : "Accounts"
},
{
"name" : "Fund management"
},
{
"name" : "Other"
}
],
"x-staticResponse" : "response.json",
"webhooks" : {
"/ACCOUNT_CLOSED" : {
@@ -30,7 +35,6 @@
"summary" : "Account closed",
"description" : "Adyen sends this webhook when [an account is closed](https://docs.adyen.com/api-explorer/#/Account/latest/post/closeAccount).",
"operationId" : "post-ACCOUNT_CLOSED",
"x-groupName" : "Accounts",
"x-sortIndex" : 3,
"x-methodName" : "accountClosed",
"security" : [
@@ -57,11 +61,6 @@
"200" : {
"content" : {
"application/json" : {
"examples" : {
"accountClosed" : {
"$ref" : "#/components/examples/WebhookAck"
}
},
"schema" : {
"$ref" : "#/components/schemas/NotificationResponse"
}
@@ -80,7 +79,6 @@
"summary" : "Account created",
"description" : "Adyen sends this webhook when [an account is created](https://docs.adyen.com/api-explorer/#/Account/latest/post/createAccount).",
"operationId" : "post-ACCOUNT_CREATED",
"x-groupName" : "Accounts",
"x-sortIndex" : 1,
"x-methodName" : "accountCreated",
"security" : [
@@ -107,11 +105,6 @@
"200" : {
"content" : {
"application/json" : {
"examples" : {
"accountCreated" : {
"$ref" : "#/components/examples/WebhookAck"
}
},
"schema" : {
"$ref" : "#/components/schemas/NotificationResponse"
}
@@ -130,7 +123,6 @@
"summary" : "Liable account's funds are below configured threshold",
"description" : "Adyen sends this notification when the current funds of your liable account are below the configured threshold.",
"operationId" : "post-ACCOUNT_FUNDS_BELOW_THRESHOLD",
"x-groupName" : "Fund management",
"x-sortIndex" : 7,
"x-methodName" : "liableAccountsFundsAreBelowConfiguredThreshold",
"security" : [
@@ -157,11 +149,6 @@
"200" : {
"content" : {
"application/json" : {
"examples" : {
"accountFundsBelowThreshold" : {
"$ref" : "#/components/examples/WebhookAck"
}
},
"schema" : {
"$ref" : "#/components/schemas/NotificationResponse"
}
@@ -180,7 +167,6 @@
"summary" : "Account holder created",
"description" : "Adyen sends this webhook when [an account holder is created](https://docs.adyen.com/api-explorer/#/Account/latest/post/createAccountHolder).",
"operationId" : "post-ACCOUNT_HOLDER_CREATED",
"x-groupName" : "Account holders",
"x-sortIndex" : 1,
"x-methodName" : "accountHolderCreated",
"security" : [
@@ -213,17 +199,6 @@
"200" : {
"content" : {
"application/json" : {
"examples" : {
"accountHolderCreated-businesses" : {
"$ref" : "#/components/examples/WebhookAck"
},
"accountHolderCreated-failed" : {
"$ref" : "#/components/examples/WebhookAck"
},
"accountHolderCreated-individuals" : {
"$ref" : "#/components/examples/WebhookAck"
}
},
"schema" : {
"$ref" : "#/components/schemas/NotificationResponse"
}
@@ -242,7 +217,6 @@
"summary" : "Paid out to account holder",
"description" : "Adyen sends this notification when a [payout request](https://docs.adyen.com/api-explorer/#/Fund/latest/post/payoutAccountHolder) to an account holder is processed and the payout is scheduled.",
"operationId" : "post-ACCOUNT_HOLDER_PAYOUT",
"x-groupName" : "Fund management",
"x-sortIndex" : 1,
"x-methodName" : "paidOutToAccountHolder",
"security" : [
@@ -272,14 +246,6 @@
"200" : {
"content" : {
"application/json" : {
"examples" : {
"accountHolderPayout-failed" : {
"$ref" : "#/components/examples/WebhookAck"
},
"accountHolderPayout-initiated" : {
"$ref" : "#/components/examples/WebhookAck"
}
},
"schema" : {
"$ref" : "#/components/schemas/NotificationResponse"
}
@@ -298,7 +264,6 @@
"summary" : "Account holder status changed",
"description" : "Adyen sends this webhook when [the status of an account holder is changed](https://docs.adyen.com/api-explorer/#/Account/latest/post/updateAccountHolderState).",
"operationId" : "post-ACCOUNT_HOLDER_STATUS_CHANGE",
"x-groupName" : "Account holders",
"x-sortIndex" : 4,
"x-methodName" : "accountHolderStatusChanged",
"security" : [
@@ -325,11 +290,6 @@
"200" : {
"content" : {
"application/json" : {
"examples" : {
"accountHolderStatusChange" : {
"$ref" : "#/components/examples/WebhookAck"
}
},
"schema" : {
"$ref" : "#/components/schemas/NotificationResponse"
}
@@ -348,7 +308,6 @@
"summary" : "Store status changed",
"description" : "Adyen sends this webhook when [the status of a store](https://docs.adyen.com/api-explorer/#/Account/latest/post/createAccountHolder__reqParam_accountHolderDetails-storeDetails-status) associated with an account holder is changed.",
"operationId" : "post-ACCOUNT_HOLDER_STORE_STATUS_CHANGE",
"x-groupName" : "Account holders",
"x-sortIndex" : 4,
"x-methodName" : "storeStatusChanged",
"security" : [
@@ -375,11 +334,6 @@
"200" : {
"content" : {
"application/json" : {
"examples" : {
"accountHolderStoreStatusChange" : {
"$ref" : "#/components/examples/WebhookAck"
}
},
"schema" : {
"$ref" : "#/components/schemas/NotificationResponse"
}
@@ -398,7 +352,6 @@
"summary" : "Upcoming deadline",
"description" : "Adyen sends this notification when an account holder's deadline to fulfill the requirements of a specific event is coming up.",
"operationId" : "post-ACCOUNT_HOLDER_UPCOMING_DEADLINE",
"x-groupName" : "Account holders",
"x-sortIndex" : 1,
"x-methodName" : "upcomingDeadline",
"security" : [
@@ -425,11 +378,6 @@
"200" : {
"content" : {
"application/json" : {
"examples" : {
"accountHolderUpcomingDeadline" : {
"$ref" : "#/components/examples/WebhookAck"
}
},
"schema" : {
"$ref" : "#/components/schemas/NotificationResponse"
}
@@ -448,7 +396,6 @@
"summary" : "Account holder updated",
"description" : "Adyen sends this webhook when [an account holder is updated](https://docs.adyen.com/api-explorer/#/Account/latest/post/updateAccountHolder).",
"operationId" : "post-ACCOUNT_HOLDER_UPDATED",
"x-groupName" : "Account holders",
"x-sortIndex" : 2,
"x-methodName" : "accountHolderUpdated",
"security" : [
@@ -475,11 +422,6 @@
"200" : {
"content" : {
"application/json" : {
"examples" : {
"accountHolderUpdated" : {
"$ref" : "#/components/examples/WebhookAck"
}
},
"schema" : {
"$ref" : "#/components/schemas/NotificationResponse"
}
@@ -498,7 +440,6 @@
"summary" : "Verification results received",
"description" : "Adyen sends this webhook when verification results are available.",
"operationId" : "post-ACCOUNT_HOLDER_VERIFICATION",
"x-groupName" : "Account holders",
"x-sortIndex" : 3,
"x-methodName" : "verificationResultsReceived",
"security" : [
@@ -525,11 +466,6 @@
"200" : {
"content" : {
"application/json" : {
"examples" : {
"accountHolderVerification" : {
"$ref" : "#/components/examples/WebhookAck"
}
},
"schema" : {
"$ref" : "#/components/schemas/NotificationResponse"
}
@@ -548,7 +484,6 @@
"summary" : "Account updated",
"description" : "Adyen sends this webhook when [an account is updated](https://docs.adyen.com/api-explorer/#/Account/latest/post/updateAccount).",
"operationId" : "post-ACCOUNT_UPDATED",
"x-groupName" : "Accounts",
"x-sortIndex" : 2,
"x-methodName" : "accountUpdated",
"security" : [
@@ -575,11 +510,6 @@
"200" : {
"content" : {
"application/json" : {
"examples" : {
"accountUpdated" : {
"$ref" : "#/components/examples/WebhookAck"
}
},
"schema" : {
"$ref" : "#/components/schemas/NotificationResponse"
}
@@ -598,7 +528,6 @@
"summary" : "Beneficiary defined",
"description" : "Adyen sends this notification when a [benefactor/beneficiary relationship is created](https://docs.adyen.com/api-explorer/#/Fund/latest/post/transferFunds).",
"operationId" : "post-BENEFICIARY_SETUP",
"x-groupName" : "Fund management",
"x-sortIndex" : 3,
"x-methodName" : "beneficiaryDefined",
"security" : [
@@ -625,11 +554,6 @@
"200" : {
"content" : {
"application/json" : {
"examples" : {
"beneficiarySetup" : {
"$ref" : "#/components/examples/WebhookAck"
}
},
"schema" : {
"$ref" : "#/components/schemas/NotificationResponse"
}
@@ -648,7 +572,6 @@
"summary" : "Negative account balances compensated",
"description" : "Adyen sends this notification when funds are transferred from your platform's liable account to an overdrawn account to compensate for the overdraft.",
"operationId" : "post-COMPENSATE_NEGATIVE_BALANCE",
"x-groupName" : "Fund management",
"x-sortIndex" : 5,
"x-methodName" : "negativeAccountBalancesCompensated",
"security" : [
@@ -675,11 +598,6 @@
"200" : {
"content" : {
"application/json" : {
"examples" : {
"compensateNegativeBalance" : {
"$ref" : "#/components/examples/WebhookAck"
}
},
"schema" : {
"$ref" : "#/components/schemas/NotificationResponse"
}
@@ -698,7 +616,6 @@
"summary" : "Automated direct debit initiated",
"description" : "Adyen sends this notification when a [direct debit is initiated](https://docs.adyen.com/api-explorer/#/Fund/latest/post/debitAccountHolder).",
"operationId" : "post-DIRECT_DEBIT_INITIATED",
"x-groupName" : "Fund management",
"x-sortIndex" : 7,
"x-methodName" : "automatedDirectDebitInitiated",
"security" : [
@@ -725,11 +642,6 @@
"200" : {
"content" : {
"application/json" : {
"examples" : {
"directDebitInitiated" : {
"$ref" : "#/components/examples/WebhookAck"
}
},
"schema" : {
"$ref" : "#/components/schemas/NotificationResponse"
}
@@ -748,7 +660,6 @@
"summary" : "Booking for a capture or refund failed",
"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,
"x-methodName" : "bookingForCaptureOrRefundFailed",
"security" : [
@@ -775,11 +686,6 @@
"200" : {
"content" : {
"application/json" : {
"examples" : {
"paymentFailure" : {
"$ref" : "#/components/examples/WebhookAck"
}
},
"schema" : {
"$ref" : "#/components/schemas/NotificationResponse"
}
@@ -798,7 +704,6 @@
"summary" : "Funds transfer between accounts refunded",
"description" : "Adyen sends this notification when [funds transferred between accounts are refunded](https://docs.adyen.com/api-explorer/#/Fund/v6/latest/refundFundsTransfer).",
"operationId" : "post-REFUND_FUNDS_TRANSFER",
"x-groupName" : "Fund management",
"x-sortIndex" : 6,
"x-methodName" : "fundsTransferBetweenAccountsRefunded",
"security" : [
@@ -825,11 +730,6 @@
"200" : {
"content" : {
"application/json" : {
"examples" : {
"refundFundsTransfer" : {
"$ref" : "#/components/examples/WebhookAck"
}
},
"schema" : {
"$ref" : "#/components/schemas/NotificationResponse"
}
@@ -848,7 +748,6 @@
"summary" : "Report available",
"description" : "Adyen sends this notification when a report has been generated and it is available for download.",
"operationId" : "post-REPORT_AVAILABLE",
"x-groupName" : "Other",
"x-sortIndex" : 2,
"x-methodName" : "reportAvailable",
"security" : [
@@ -875,11 +774,6 @@
"200" : {
"content" : {
"application/json" : {
"examples" : {
"reportAvailable" : {
"$ref" : "#/components/examples/WebhookAck"
}
},
"schema" : {
"$ref" : "#/components/schemas/NotificationResponse"
}
@@ -898,7 +792,6 @@
"summary" : "'Refund Transfers Not Paid Out' call processed and refunds scheduled",
"description" : "Adyen sends this notification when a request to [refund transfers that are not yet paid out](https://docs.adyen.com/api-explorer/#/Fund/latest/refundNotPaidOutTransfers) is processed and the associated refunds are scheduled.",
"operationId" : "post-SCHEDULED_REFUNDS",
"x-groupName" : "Fund management",
"x-sortIndex" : 4,
"x-methodName" : "refundTransfersNotPaidOutCallProcessedAndRefundsScheduled",
"security" : [
@@ -925,11 +818,6 @@
"200" : {
"content" : {
"application/json" : {
"examples" : {
"scheduledRefunds" : {
"$ref" : "#/components/examples/WebhookAck"
}
},
"schema" : {
"$ref" : "#/components/schemas/NotificationResponse"
}
@@ -948,7 +836,6 @@
"summary" : "Funds transferred between accounts",
"description" : "Adyen sends this notification when [funds are transferred between accounts](https://docs.adyen.com/api-explorer/#/Fund/latest/post/transferFunds).",
"operationId" : "post-TRANSFER_FUNDS",
"x-groupName" : "Fund management",
"x-sortIndex" : 2,
"x-methodName" : "fundsTransferredBetweenAccounts",
"security" : [
@@ -975,11 +862,6 @@
"200" : {
"content" : {
"application/json" : {
"examples" : {
"transferFunds" : {
"$ref" : "#/components/examples/WebhookAck"
}
},
"schema" : {
"$ref" : "#/components/schemas/NotificationResponse"
}
@@ -1690,7 +1572,9 @@
"DeleteLiableBankAccount",
"DeletePayoutMethods",
"DeleteShareholders",
"DeleteShareholdersNoKyc",
"DeleteSignatories",
"DeleteUnusedAccount",
"InactivateAccount",
"KYCDeadlineExtension",
"MigrateAccountToBP",
@@ -1699,7 +1583,6 @@
"ResolveEvents",
"SaveAccountHolder",
"SaveKYCCheckStatus",
"SavePEPChecks",
"SuspendAccount",
"UnSuspendAccount",
"UpdateAccountHolderState",
@@ -2404,7 +2287,7 @@
"type" : "string"
},
"payoutSchedule" : {
"description" : "The payout schedule of the account.",
"description" : "The details of the payout schedule added to the account.",
"$ref" : "#/components/schemas/PayoutScheduleResponse"
},
"payoutSpeed" : {
@@ -2635,6 +2518,7 @@
"legalBusinessName",
"legalEntity",
"legalEntityType",
"linkedViasVirtualAccount",
"logo",
"merchantAccount",
"merchantCategoryCode",
@@ -3092,7 +2976,7 @@
"type" : "string"
},
"schedule" : {
"description" : "The payout schedule of the account.\nPermitted values: `DEFAULT`, `DAILY`, `DAILY_US`, `DAILY_EU`, `DAILY_AU`, `DAILY_SG`, `WEEKLY`, `WEEKLY_ON_TUE_FRI_MIDNIGHT`, `BIWEEKLY_ON_1ST_AND_15TH_AT_MIDNIGHT`, `MONTHLY`, `HOLD`.",
"description" : "The payout schedule for the account.\n\nPossible values: `DEFAULT`, `DAILY`, `DAILY_US`, `DAILY_EU`, `DAILY_AU`, `DAILY_SG`, `WEEKLY`, `WEEKLY_ON_TUE_FRI_MIDNIGHT`, `BIWEEKLY_ON_1ST_AND_15TH_AT_MIDNIGHT`, `MONTHLY`, `HOLD`.\n> `HOLD` prevents scheduled payouts, but you can still initiate payouts manually.",
"enum" : [
"BIWEEKLY_ON_1ST_AND_15TH_AT_MIDNIGHT",
"DAILY",
@@ -3492,46 +3376,44 @@
"Split" : {
"properties" : {
"account" : {
"description" : "Unique identifier of the account where the split amount should be sent. This is required if `type` is **MarketPlace** or **BalanceAccount**.\n\n",
"description" : "The unique identifier of the account to which the split amount is booked. Required if `type` is **MarketPlace** or **BalanceAccount**.\n\n* [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic): The [`accountCode`](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccount#request-accountCode) of the account to which the split amount is booked.\n* [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms): The [`balanceAccountId`](https://docs.adyen.com/api-explorer/balanceplatform/latest/get/balanceAccounts/_id_#path-id) of the account to which the split amount is booked.",
"type" : "string"
},
"amount" : {
"description" : "The amount of this split.",
"description" : "The amount of the split item.\n\n* Required for all split types in the [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic).\n* Required if `type` is **BalanceAccount**, **Commission**, **Default**, or **VAT** in your [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms) integration.",
"$ref" : "#/components/schemas/SplitAmount"
},
"description" : {
"description" : "A description of this split.",
"description" : "Your description for the split item.",
"type" : "string"
},
"reference" : {
"description" : "Your reference for the split, which you can use to link the split to other operations such as captures and refunds.\n\nThis is required if `type` is **MarketPlace** or **BalanceAccount**. For the other types, we also recommend sending a reference so you can reconcile the split and the associated payment in the transaction overview and in the reports. If the reference is not provided, the split is reported as part of the aggregated [TransferBalance record type](https://docs.adyen.com/reporting/marketpay-payments-accounting-report) in Adyen for Platforms.",
"description" : "Your unique reference for the split item.\n\nThis is required if `type` is **MarketPlace** ([Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic)) or **BalanceAccount** ([Balance Platform](https://docs.adyen.com/marketplaces-and-platforms)).\n\nFor the other types, we also recommend providing a **unique** reference so you can reconcile the split and the associated payment in the transaction overview and in the reports.",
"type" : "string"
},
"type" : {
"description" : "The type of split.\nPossible values: **Default**, **PaymentFee**, **VAT**, **Commission**, **MarketPlace**, **BalanceAccount**, **Remainder**, **Surcharge**, **Tip**.",
"description" : "The type of the split item.\n\nPossible values:\n\n* [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic): **Commission**, **Default**, **Marketplace**, **PaymentFee**, **VAT**.\n* [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms): **BalanceAccount**, **Commission**, **Default**, **PaymentFee**, **Remainder**, **Surcharge**, **Tip**, **VAT**.",
"enum" : [
"AcquiringFees",
"AdyenCommission",
"AdyenFees",
"AdyenMarkup",
"BalanceAccount",
"Commission",
"Default",
"Interchange",
"MarketPlace",
"PaymentFee",
"PaymentFeeAcquiring",
"PaymentFeeAdyen",
"PaymentFeeAdyenCommission",
"PaymentFeeAdyenMarkup",
"PaymentFeeInterchange",
"PaymentFeeSchemeFee",
"Remainder",
"SchemeFee",
"Surcharge",
"Tip",
"VAT",
"Verification"
"VAT"
],
"type" : "string"
}
},
"required" : [
"amount",
"type"
],
"type" : "object"
@@ -3539,13 +3421,13 @@
"SplitAmount" : {
"properties" : {
"currency" : {
"description" : "The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes).\n\nIf this value is not provided, the currency in which the payment is made will be used.",
"description" : "The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes). By default, this is the original payment currency.",
"maxLength" : 3,
"minLength" : 3,
"type" : "string"
},
"value" : {
"description" : "The amount in [minor units](https://docs.adyen.com/development-resources/currency-codes).",
"description" : "The value of the split amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).",
"format" : "int64",
"type" : "integer"
}
@@ -3617,7 +3499,7 @@
"type" : "string"
},
"storeName" : {
"description" : "The name of the account holder's store. This value is shown in shopper statements.\n\n* Length: Between 3 to 22 characters \n\n* The following characters are *not* supported: **:;}{$#@!|<>%^*+=\\\\**",
"description" : "The name of the account holder's store. This value is shown in shopper statements.\n\n * Length: Between 3 to 22 characters \n\n * The following characters are *not* supported: **:;}{$#@!|<>%^*+=\\\\**\n\n**Note:** storeName does not appear in American Express shopper statements by default. Contact Adyen Support to enable this for American Express.",
"type" : "string"
},
"storeReference" : {
@@ -3707,6 +3589,7 @@
"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",
"BalancePlatformFundTransfer",
"BalancePlatformSweep",
"BalancePlatformSweepReturned",
"Chargeback",
@@ -3730,15 +3613,19 @@
"DebitedReversed",
"DepositCorrectionCredited",
"DepositCorrectionDebited",
"DepositCorrectionReceived",
"Fee",
"FeeReceived",
"FundTransfer",
"FundTransferReversed",
"InvoiceDeductionCredited",
"InvoiceDeductionDebited",
"InvoiceDeductionReceived",
"ManualCorrected",
"ManualCorrectionCredited",
"ManualCorrectionDebited",
"MerchantPayin",
"MerchantPayinReceived",
"MerchantPayinReversed",
"Payout",
"PayoutReversed",
@@ -3982,12 +3869,12 @@
"type" : "string"
},
"payoutSchedule" : {
"description" : "The payout schedule of the account.",
"description" : "The details of the payout schedule to which the account is updated.",
"$ref" : "#/components/schemas/PayoutScheduleResponse"
},
"payoutSpeed" : {
"x-addedInVersion" : "5",
"description" : "Speed with which payouts for this account are processed. Permitted values: `STANDARD`, `SAME_DAY`.",
"description" : "Speed at which payouts for this account are processed.\n\nPossible values: `STANDARD`, `SAME_DAY`.",
"enum" : [
"INSTANT",
"SAME_DAY",
@@ -4125,10 +4012,6 @@
}
},
"examples" : {
"WebhookAck" : {
"summary" : "Acknowledge Webhook",
"value" : "[accepted]"
},
"post-ACCOUNT_CLOSED-accountClosed" : {
"summary" : "ACCOUNT_CLOSED example",
"value" : {
@@ -4326,7 +4209,6 @@
"fullPhoneNumber" : "+3112345678",
"name" : {
"firstName" : "Firstname",
"gender" : "UNKNOWN",
"infix" : "infix",
"lastName" : "Lastname"
},
@@ -4360,7 +4242,6 @@
"individualDetails" : {
"name" : {
"firstName" : "Firstname",
"gender" : "UNKNOWN",
"infix" : "infix",
"lastName" : "Lastname"
},
@@ -4605,7 +4486,6 @@
"individualDetails" : {
"name" : {
"firstName" : "Firstname",
"gender" : "UNKNOWN",
"infix" : "infix",
"lastName" : "Lastname"
},

200
json/MarketPayNotificationService-v6.json
View File

@@ -5,21 +5,26 @@
"x-publicVersion" : true,
"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" : "2023-06-02T11:23:48Z",
"termsOfService" : "https://www.adyen.com/legal/terms-and-conditions",
"contact" : {
"name" : "Adyen Developer Experience team",
"url" : "https://github.com/Adyen/adyen-openapi"
}
},
"x-groups" : [
"Account holders",
"Accounts",
"Fund management",
"Other"
],
"tags" : [
],
{
"name" : "Account holders"
},
{
"name" : "Accounts"
},
{
"name" : "Fund management"
},
{
"name" : "Other"
}
],
"x-staticResponse" : "response.json",
"webhooks" : {
"/ACCOUNT_CLOSED" : {
@@ -30,7 +35,6 @@
"summary" : "Account closed",
"description" : "Adyen sends this webhook when [an account is closed](https://docs.adyen.com/api-explorer/#/Account/latest/post/closeAccount).",
"operationId" : "post-ACCOUNT_CLOSED",
"x-groupName" : "Accounts",
"x-sortIndex" : 3,
"x-methodName" : "accountClosed",
"security" : [
@@ -57,11 +61,6 @@
"200" : {
"content" : {
"application/json" : {
"examples" : {
"accountClosed" : {
"$ref" : "#/components/examples/WebhookAck"
}
},
"schema" : {
"$ref" : "#/components/schemas/NotificationResponse"
}
@@ -80,7 +79,6 @@
"summary" : "Account created",
"description" : "Adyen sends this webhook when [an account is created](https://docs.adyen.com/api-explorer/#/Account/latest/post/createAccount).",
"operationId" : "post-ACCOUNT_CREATED",
"x-groupName" : "Accounts",
"x-sortIndex" : 1,
"x-methodName" : "accountCreated",
"security" : [
@@ -107,11 +105,6 @@
"200" : {
"content" : {
"application/json" : {
"examples" : {
"accountCreated" : {
"$ref" : "#/components/examples/WebhookAck"
}
},
"schema" : {
"$ref" : "#/components/schemas/NotificationResponse"
}
@@ -130,7 +123,6 @@
"summary" : "Liable account's funds are below configured threshold",
"description" : "Adyen sends this notification when the current funds of your liable account are below the configured threshold.",
"operationId" : "post-ACCOUNT_FUNDS_BELOW_THRESHOLD",
"x-groupName" : "Fund management",
"x-sortIndex" : 7,
"x-methodName" : "liableAccountsFundsAreBelowConfiguredThreshold",
"security" : [
@@ -157,11 +149,6 @@
"200" : {
"content" : {
"application/json" : {
"examples" : {
"accountFundsBelowThreshold" : {
"$ref" : "#/components/examples/WebhookAck"
}
},
"schema" : {
"$ref" : "#/components/schemas/NotificationResponse"
}
@@ -180,7 +167,6 @@
"summary" : "Account holder created",
"description" : "Adyen sends this webhook when [an account holder is created](https://docs.adyen.com/api-explorer/#/Account/latest/post/createAccountHolder).",
"operationId" : "post-ACCOUNT_HOLDER_CREATED",
"x-groupName" : "Account holders",
"x-sortIndex" : 1,
"x-methodName" : "accountHolderCreated",
"security" : [
@@ -213,17 +199,6 @@
"200" : {
"content" : {
"application/json" : {
"examples" : {
"accountHolderCreated-businesses" : {
"$ref" : "#/components/examples/WebhookAck"
},
"accountHolderCreated-failed" : {
"$ref" : "#/components/examples/WebhookAck"
},
"accountHolderCreated-individuals" : {
"$ref" : "#/components/examples/WebhookAck"
}
},
"schema" : {
"$ref" : "#/components/schemas/NotificationResponse"
}
@@ -242,7 +217,6 @@
"summary" : "Paid out to account holder",
"description" : "Adyen sends this notification when a [payout request](https://docs.adyen.com/api-explorer/#/Fund/latest/post/payoutAccountHolder) to an account holder is processed and the payout is scheduled.",
"operationId" : "post-ACCOUNT_HOLDER_PAYOUT",
"x-groupName" : "Fund management",
"x-sortIndex" : 1,
"x-methodName" : "paidOutToAccountHolder",
"security" : [
@@ -272,14 +246,6 @@
"200" : {
"content" : {
"application/json" : {
"examples" : {
"accountHolderPayout-failed" : {
"$ref" : "#/components/examples/WebhookAck"
},
"accountHolderPayout-initiated" : {
"$ref" : "#/components/examples/WebhookAck"
}
},
"schema" : {
"$ref" : "#/components/schemas/NotificationResponse"
}
@@ -298,7 +264,6 @@
"summary" : "Account holder status changed",
"description" : "Adyen sends this webhook when [the status of an account holder is changed](https://docs.adyen.com/api-explorer/#/Account/latest/post/updateAccountHolderState).",
"operationId" : "post-ACCOUNT_HOLDER_STATUS_CHANGE",
"x-groupName" : "Account holders",
"x-sortIndex" : 4,
"x-methodName" : "accountHolderStatusChanged",
"security" : [
@@ -325,11 +290,6 @@
"200" : {
"content" : {
"application/json" : {
"examples" : {
"accountHolderStatusChange" : {
"$ref" : "#/components/examples/WebhookAck"
}
},
"schema" : {
"$ref" : "#/components/schemas/NotificationResponse"
}
@@ -348,7 +308,6 @@
"summary" : "Store status changed",
"description" : "Adyen sends this webhook when [the status of a store](https://docs.adyen.com/api-explorer/#/Account/latest/post/createAccountHolder__reqParam_accountHolderDetails-storeDetails-status) associated with an account holder is changed.",
"operationId" : "post-ACCOUNT_HOLDER_STORE_STATUS_CHANGE",
"x-groupName" : "Account holders",
"x-sortIndex" : 4,
"x-methodName" : "storeStatusChanged",
"security" : [
@@ -375,11 +334,6 @@
"200" : {
"content" : {
"application/json" : {
"examples" : {
"accountHolderStoreStatusChange" : {
"$ref" : "#/components/examples/WebhookAck"
}
},
"schema" : {
"$ref" : "#/components/schemas/NotificationResponse"
}
@@ -398,7 +352,6 @@
"summary" : "Upcoming deadline",
"description" : "Adyen sends this notification when an account holder's deadline to fulfill the requirements of a specific event is coming up.",
"operationId" : "post-ACCOUNT_HOLDER_UPCOMING_DEADLINE",
"x-groupName" : "Account holders",
"x-sortIndex" : 1,
"x-methodName" : "upcomingDeadline",
"security" : [
@@ -425,11 +378,6 @@
"200" : {
"content" : {
"application/json" : {
"examples" : {
"accountHolderUpcomingDeadline" : {
"$ref" : "#/components/examples/WebhookAck"
}
},
"schema" : {
"$ref" : "#/components/schemas/NotificationResponse"
}
@@ -448,7 +396,6 @@
"summary" : "Account holder updated",
"description" : "Adyen sends this webhook when [an account holder is updated](https://docs.adyen.com/api-explorer/#/Account/latest/post/updateAccountHolder).",
"operationId" : "post-ACCOUNT_HOLDER_UPDATED",
"x-groupName" : "Account holders",
"x-sortIndex" : 2,
"x-methodName" : "accountHolderUpdated",
"security" : [
@@ -475,11 +422,6 @@
"200" : {
"content" : {
"application/json" : {
"examples" : {
"accountHolderUpdated" : {
"$ref" : "#/components/examples/WebhookAck"
}
},
"schema" : {
"$ref" : "#/components/schemas/NotificationResponse"
}
@@ -498,7 +440,6 @@
"summary" : "Verification results received",
"description" : "Adyen sends this webhook when verification results are available.",
"operationId" : "post-ACCOUNT_HOLDER_VERIFICATION",
"x-groupName" : "Account holders",
"x-sortIndex" : 3,
"x-methodName" : "verificationResultsReceived",
"security" : [
@@ -525,11 +466,6 @@
"200" : {
"content" : {
"application/json" : {
"examples" : {
"accountHolderVerification" : {
"$ref" : "#/components/examples/WebhookAck"
}
},
"schema" : {
"$ref" : "#/components/schemas/NotificationResponse"
}
@@ -548,7 +484,6 @@
"summary" : "Account updated",
"description" : "Adyen sends this webhook when [an account is updated](https://docs.adyen.com/api-explorer/#/Account/latest/post/updateAccount).",
"operationId" : "post-ACCOUNT_UPDATED",
"x-groupName" : "Accounts",
"x-sortIndex" : 2,
"x-methodName" : "accountUpdated",
"security" : [
@@ -575,11 +510,6 @@
"200" : {
"content" : {
"application/json" : {
"examples" : {
"accountUpdated" : {
"$ref" : "#/components/examples/WebhookAck"
}
},
"schema" : {
"$ref" : "#/components/schemas/NotificationResponse"
}
@@ -598,7 +528,6 @@
"summary" : "Beneficiary defined",
"description" : "Adyen sends this notification when a [benefactor/beneficiary relationship is created](https://docs.adyen.com/api-explorer/#/Fund/latest/post/transferFunds).",
"operationId" : "post-BENEFICIARY_SETUP",
"x-groupName" : "Fund management",
"x-sortIndex" : 3,
"x-methodName" : "beneficiaryDefined",
"security" : [
@@ -625,11 +554,6 @@
"200" : {
"content" : {
"application/json" : {
"examples" : {
"beneficiarySetup" : {
"$ref" : "#/components/examples/WebhookAck"
}
},
"schema" : {
"$ref" : "#/components/schemas/NotificationResponse"
}
@@ -648,7 +572,6 @@
"summary" : "Negative account balances compensated",
"description" : "Adyen sends this notification when funds are transferred from your platform's liable account to an overdrawn account to compensate for the overdraft.",
"operationId" : "post-COMPENSATE_NEGATIVE_BALANCE",
"x-groupName" : "Fund management",
"x-sortIndex" : 5,
"x-methodName" : "negativeAccountBalancesCompensated",
"security" : [
@@ -675,11 +598,6 @@
"200" : {
"content" : {
"application/json" : {
"examples" : {
"compensateNegativeBalance" : {
"$ref" : "#/components/examples/WebhookAck"
}
},
"schema" : {
"$ref" : "#/components/schemas/NotificationResponse"
}
@@ -698,7 +616,6 @@
"summary" : "Automated direct debit initiated",
"description" : "Adyen sends this notification when a [direct debit is initiated](https://docs.adyen.com/api-explorer/#/Fund/latest/post/debitAccountHolder).",
"operationId" : "post-DIRECT_DEBIT_INITIATED",
"x-groupName" : "Fund management",
"x-sortIndex" : 7,
"x-methodName" : "automatedDirectDebitInitiated",
"security" : [
@@ -725,11 +642,6 @@
"200" : {
"content" : {
"application/json" : {
"examples" : {
"directDebitInitiated" : {
"$ref" : "#/components/examples/WebhookAck"
}
},
"schema" : {
"$ref" : "#/components/schemas/NotificationResponse"
}
@@ -748,7 +660,6 @@
"summary" : "Booking for a capture or refund failed",
"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,
"x-methodName" : "bookingForCaptureOrRefundFailed",
"security" : [
@@ -775,11 +686,6 @@
"200" : {
"content" : {
"application/json" : {
"examples" : {
"paymentFailure" : {
"$ref" : "#/components/examples/WebhookAck"
}
},
"schema" : {
"$ref" : "#/components/schemas/NotificationResponse"
}
@@ -798,7 +704,6 @@
"summary" : "Funds transfer between accounts refunded",
"description" : "Adyen sends this notification when [funds transferred between accounts are refunded](https://docs.adyen.com/api-explorer/#/Fund/v6/latest/refundFundsTransfer).",
"operationId" : "post-REFUND_FUNDS_TRANSFER",
"x-groupName" : "Fund management",
"x-sortIndex" : 6,
"x-methodName" : "fundsTransferBetweenAccountsRefunded",
"security" : [
@@ -825,11 +730,6 @@
"200" : {
"content" : {
"application/json" : {
"examples" : {
"refundFundsTransfer" : {
"$ref" : "#/components/examples/WebhookAck"
}
},
"schema" : {
"$ref" : "#/components/schemas/NotificationResponse"
}
@@ -848,7 +748,6 @@
"summary" : "Report available",
"description" : "Adyen sends this notification when a report has been generated and it is available for download.",
"operationId" : "post-REPORT_AVAILABLE",
"x-groupName" : "Other",
"x-sortIndex" : 2,
"x-methodName" : "reportAvailable",
"security" : [
@@ -875,11 +774,6 @@
"200" : {
"content" : {
"application/json" : {
"examples" : {
"reportAvailable" : {
"$ref" : "#/components/examples/WebhookAck"
}
},
"schema" : {
"$ref" : "#/components/schemas/NotificationResponse"
}
@@ -898,7 +792,6 @@
"summary" : "'Refund Transfers Not Paid Out' call processed and refunds scheduled",
"description" : "Adyen sends this notification when a request to [refund transfers that are not yet paid out](https://docs.adyen.com/api-explorer/#/Fund/latest/refundNotPaidOutTransfers) is processed and the associated refunds are scheduled.",
"operationId" : "post-SCHEDULED_REFUNDS",
"x-groupName" : "Fund management",
"x-sortIndex" : 4,
"x-methodName" : "refundTransfersNotPaidOutCallProcessedAndRefundsScheduled",
"security" : [
@@ -925,11 +818,6 @@
"200" : {
"content" : {
"application/json" : {
"examples" : {
"scheduledRefunds" : {
"$ref" : "#/components/examples/WebhookAck"
}
},
"schema" : {
"$ref" : "#/components/schemas/NotificationResponse"
}
@@ -948,7 +836,6 @@
"summary" : "Funds transferred between accounts",
"description" : "Adyen sends this notification when [funds are transferred between accounts](https://docs.adyen.com/api-explorer/#/Fund/latest/post/transferFunds).",
"operationId" : "post-TRANSFER_FUNDS",
"x-groupName" : "Fund management",
"x-sortIndex" : 2,
"x-methodName" : "fundsTransferredBetweenAccounts",
"security" : [
@@ -975,11 +862,6 @@
"200" : {
"content" : {
"application/json" : {
"examples" : {
"transferFunds" : {
"$ref" : "#/components/examples/WebhookAck"
}
},
"schema" : {
"$ref" : "#/components/schemas/NotificationResponse"
}
@@ -1725,7 +1607,9 @@
"DeleteLiableBankAccount",
"DeletePayoutMethods",
"DeleteShareholders",
"DeleteShareholdersNoKyc",
"DeleteSignatories",
"DeleteUnusedAccount",
"InactivateAccount",
"KYCDeadlineExtension",
"MigrateAccountToBP",
@@ -1734,7 +1618,6 @@
"ResolveEvents",
"SaveAccountHolder",
"SaveKYCCheckStatus",
"SavePEPChecks",
"SuspendAccount",
"UnSuspendAccount",
"UpdateAccountHolderState",
@@ -2472,7 +2355,7 @@
"type" : "string"
},
"payoutSchedule" : {
"description" : "The payout schedule of the account.",
"description" : "The details of the payout schedule added to the account.",
"$ref" : "#/components/schemas/PayoutScheduleResponse"
},
"payoutSpeed" : {
@@ -2703,6 +2586,7 @@
"legalBusinessName",
"legalEntity",
"legalEntityType",
"linkedViasVirtualAccount",
"logo",
"merchantAccount",
"merchantCategoryCode",
@@ -3367,7 +3251,7 @@
"type" : "string"
},
"schedule" : {
"description" : "The payout schedule of the account.\nPermitted values: `DEFAULT`, `DAILY`, `DAILY_US`, `DAILY_EU`, `DAILY_AU`, `DAILY_SG`, `WEEKLY`, `WEEKLY_ON_TUE_FRI_MIDNIGHT`, `BIWEEKLY_ON_1ST_AND_15TH_AT_MIDNIGHT`, `MONTHLY`, `HOLD`.",
"description" : "The payout schedule for the account.\n\nPossible values: `DEFAULT`, `DAILY`, `DAILY_US`, `DAILY_EU`, `DAILY_AU`, `DAILY_SG`, `WEEKLY`, `WEEKLY_ON_TUE_FRI_MIDNIGHT`, `BIWEEKLY_ON_1ST_AND_15TH_AT_MIDNIGHT`, `MONTHLY`, `HOLD`.\n> `HOLD` prevents scheduled payouts, but you can still initiate payouts manually.",
"enum" : [
"BIWEEKLY_ON_1ST_AND_15TH_AT_MIDNIGHT",
"DAILY",
@@ -3767,46 +3651,44 @@
"Split" : {
"properties" : {
"account" : {
"description" : "Unique identifier of the account where the split amount should be sent. This is required if `type` is **MarketPlace** or **BalanceAccount**.\n\n",
"description" : "The unique identifier of the account to which the split amount is booked. Required if `type` is **MarketPlace** or **BalanceAccount**.\n\n* [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic): The [`accountCode`](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccount#request-accountCode) of the account to which the split amount is booked.\n* [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms): The [`balanceAccountId`](https://docs.adyen.com/api-explorer/balanceplatform/latest/get/balanceAccounts/_id_#path-id) of the account to which the split amount is booked.",
"type" : "string"
},
"amount" : {
"description" : "The amount of this split.",
"description" : "The amount of the split item.\n\n* Required for all split types in the [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic).\n* Required if `type` is **BalanceAccount**, **Commission**, **Default**, or **VAT** in your [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms) integration.",
"$ref" : "#/components/schemas/SplitAmount"
},
"description" : {
"description" : "A description of this split.",
"description" : "Your description for the split item.",
"type" : "string"
},
"reference" : {
"description" : "Your reference for the split, which you can use to link the split to other operations such as captures and refunds.\n\nThis is required if `type` is **MarketPlace** or **BalanceAccount**. For the other types, we also recommend sending a reference so you can reconcile the split and the associated payment in the transaction overview and in the reports. If the reference is not provided, the split is reported as part of the aggregated [TransferBalance record type](https://docs.adyen.com/reporting/marketpay-payments-accounting-report) in Adyen for Platforms.",
"description" : "Your unique reference for the split item.\n\nThis is required if `type` is **MarketPlace** ([Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic)) or **BalanceAccount** ([Balance Platform](https://docs.adyen.com/marketplaces-and-platforms)).\n\nFor the other types, we also recommend providing a **unique** reference so you can reconcile the split and the associated payment in the transaction overview and in the reports.",
"type" : "string"
},
"type" : {
"description" : "The type of split.\nPossible values: **Default**, **PaymentFee**, **VAT**, **Commission**, **MarketPlace**, **BalanceAccount**, **Remainder**, **Surcharge**, **Tip**.",
"description" : "The type of the split item.\n\nPossible values:\n\n* [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic): **Commission**, **Default**, **Marketplace**, **PaymentFee**, **VAT**.\n* [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms): **BalanceAccount**, **Commission**, **Default**, **PaymentFee**, **Remainder**, **Surcharge**, **Tip**, **VAT**.",
"enum" : [
"AcquiringFees",
"AdyenCommission",
"AdyenFees",
"AdyenMarkup",
"BalanceAccount",
"Commission",
"Default",
"Interchange",
"MarketPlace",
"PaymentFee",
"PaymentFeeAcquiring",
"PaymentFeeAdyen",
"PaymentFeeAdyenCommission",
"PaymentFeeAdyenMarkup",
"PaymentFeeInterchange",
"PaymentFeeSchemeFee",
"Remainder",
"SchemeFee",
"Surcharge",
"Tip",
"VAT",
"Verification"
"VAT"
],
"type" : "string"
}
},
"required" : [
"amount",
"type"
],
"type" : "object"
@@ -3814,13 +3696,13 @@
"SplitAmount" : {
"properties" : {
"currency" : {
"description" : "The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes).\n\nIf this value is not provided, the currency in which the payment is made will be used.",
"description" : "The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes). By default, this is the original payment currency.",
"maxLength" : 3,
"minLength" : 3,
"type" : "string"
},
"value" : {
"description" : "The amount in [minor units](https://docs.adyen.com/development-resources/currency-codes).",
"description" : "The value of the split amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).",
"format" : "int64",
"type" : "integer"
}
@@ -3892,7 +3774,7 @@
"type" : "string"
},
"storeName" : {
"description" : "The name of the account holder's store. This value is shown in shopper statements.\n\n* Length: Between 3 to 22 characters \n\n* The following characters are *not* supported: **:;}{$#@!|<>%^*+=\\\\**",
"description" : "The name of the account holder's store. This value is shown in shopper statements.\n\n * Length: Between 3 to 22 characters \n\n * The following characters are *not* supported: **:;}{$#@!|<>%^*+=\\\\**\n\n**Note:** storeName does not appear in American Express shopper statements by default. Contact Adyen Support to enable this for American Express.",
"type" : "string"
},
"storeReference" : {
@@ -3982,6 +3864,7 @@
"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",
"BalancePlatformFundTransfer",
"BalancePlatformSweep",
"BalancePlatformSweepReturned",
"Chargeback",
@@ -4005,15 +3888,19 @@
"DebitedReversed",
"DepositCorrectionCredited",
"DepositCorrectionDebited",
"DepositCorrectionReceived",
"Fee",
"FeeReceived",
"FundTransfer",
"FundTransferReversed",
"InvoiceDeductionCredited",
"InvoiceDeductionDebited",
"InvoiceDeductionReceived",
"ManualCorrected",
"ManualCorrectionCredited",
"ManualCorrectionDebited",
"MerchantPayin",
"MerchantPayinReceived",
"MerchantPayinReversed",
"Payout",
"PayoutReversed",
@@ -4264,12 +4151,12 @@
"type" : "string"
},
"payoutSchedule" : {
"description" : "The payout schedule of the account.",
"description" : "The details of the payout schedule to which the account is updated.",
"$ref" : "#/components/schemas/PayoutScheduleResponse"
},
"payoutSpeed" : {
"x-addedInVersion" : "5",
"description" : "Speed with which payouts for this account are processed. Permitted values: `STANDARD`, `SAME_DAY`.",
"description" : "Speed at which payouts for this account are processed.\n\nPossible values: `STANDARD`, `SAME_DAY`.",
"enum" : [
"INSTANT",
"SAME_DAY",
@@ -4407,10 +4294,6 @@
}
},
"examples" : {
"WebhookAck" : {
"summary" : "Acknowledge Webhook",
"value" : "[accepted]"
},
"post-ACCOUNT_CLOSED-accountClosed" : {
"summary" : "ACCOUNT_CLOSED example",
"value" : {
@@ -4608,7 +4491,6 @@
"fullPhoneNumber" : "+3112345678",
"name" : {
"firstName" : "Firstname",
"gender" : "UNKNOWN",
"infix" : "infix",
"lastName" : "Lastname"
},
@@ -4642,7 +4524,6 @@
"individualDetails" : {
"name" : {
"firstName" : "Firstname",
"gender" : "UNKNOWN",
"infix" : "infix",
"lastName" : "Lastname"
},
@@ -4887,7 +4768,6 @@
"individualDetails" : {
"name" : {
"firstName" : "Firstname",
"gender" : "UNKNOWN",
"infix" : "infix",
"lastName" : "Lastname"
},

12
json/NotificationConfigurationService-v1.json
View File

@@ -10,16 +10,12 @@
"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" : "2023-05-30T15:27:19Z",
"termsOfService" : "https://www.adyen.com/legal/terms-and-conditions",
"contact" : {
"name" : "Adyen Developer Experience team",
"url" : "https://github.com/Adyen/adyen-openapi"
}
},
"x-groups" : [
"General"
],
"tags" : [
{
"name" : "General"
@@ -34,7 +30,6 @@
"summary" : "Subscribe to notifications",
"description" : "Creates a subscription to notifications informing you of events on your platform. After the subscription is created, the events specified in the configuration will be sent to the URL specified in the configuration. Subscriptions must be configured on a per-event basis (as opposed to, for example, a per-account holder basis), so all event notifications of a marketplace and of a given type will be sent to the same endpoint(s). A marketplace may have multiple endpoints if desired; an event notification may be sent to as many or as few different endpoints as configured.",
"operationId" : "post-createNotificationConfiguration",
"x-groupName" : "General",
"x-sortIndex" : 1,
"x-methodName" : "createNotificationConfiguration",
"security" : [
@@ -138,7 +133,6 @@
"summary" : "Delete a notification subscription configuration",
"description" : "Deletes an existing notification subscription configuration. After the subscription is deleted, no further event notifications will be sent to the URL defined in the subscription.",
"operationId" : "post-deleteNotificationConfigurations",
"x-groupName" : "General",
"x-sortIndex" : 6,
"x-methodName" : "deleteNotificationConfigurations",
"security" : [
@@ -242,7 +236,6 @@
"summary" : "Get a notification subscription configuration",
"description" : "Returns the details of the configuration of a notification subscription.",
"operationId" : "post-getNotificationConfiguration",
"x-groupName" : "General",
"x-sortIndex" : 2,
"x-methodName" : "getNotificationConfiguration",
"security" : [
@@ -346,7 +339,6 @@
"summary" : "Get a list of notification subscription configurations",
"description" : "Returns the details of the configurations of all of the notification subscriptions in the platform of the executing user.",
"operationId" : "post-getNotificationConfigurationList",
"x-groupName" : "General",
"x-sortIndex" : 3,
"x-methodName" : "getNotificationConfigurationList",
"security" : [
@@ -450,7 +442,6 @@
"summary" : "Test a notification configuration",
"description" : "Tests an existing notification subscription configuration. For each event type specified, a test notification will be generated and sent to the URL configured in the subscription specified.",
"operationId" : "post-testNotificationConfiguration",
"x-groupName" : "General",
"x-sortIndex" : 4,
"x-methodName" : "testNotificationConfiguration",
"security" : [
@@ -554,7 +545,6 @@
"summary" : "Update a notification subscription configuration",
"description" : "Updates an existing notification subscription configuration. If you are updating the event types, you must provide all event types, otherwise the previous event type configuration will be overwritten.",
"operationId" : "post-updateNotificationConfiguration",
"x-groupName" : "General",
"x-sortIndex" : 5,
"x-methodName" : "updateNotificationConfiguration",
"security" : [
@@ -1252,7 +1242,7 @@
"value" : {
"pspReference" : "8616480452462678",
"errorMessages" : [
"The required string \"[accepted]\" is not in all the results"
"The server did not respond with HTTP 2XX"
],
"eventTypes" : [
"ACCOUNT_HOLDER_VERIFICATION"

12
json/NotificationConfigurationService-v2.json
View File

@@ -10,16 +10,12 @@
"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" : "2023-05-30T15:27:19Z",
"termsOfService" : "https://www.adyen.com/legal/terms-and-conditions",
"contact" : {
"name" : "Adyen Developer Experience team",
"url" : "https://github.com/Adyen/adyen-openapi"
}
},
"x-groups" : [
"General"
],
"tags" : [
{
"name" : "General"
@@ -34,7 +30,6 @@
"summary" : "Subscribe to notifications",
"description" : "Creates a subscription to notifications informing you of events on your platform. After the subscription is created, the events specified in the configuration will be sent to the URL specified in the configuration. Subscriptions must be configured on a per-event basis (as opposed to, for example, a per-account holder basis), so all event notifications of a marketplace and of a given type will be sent to the same endpoint(s). A marketplace may have multiple endpoints if desired; an event notification may be sent to as many or as few different endpoints as configured.",
"operationId" : "post-createNotificationConfiguration",
"x-groupName" : "General",
"x-sortIndex" : 1,
"x-methodName" : "createNotificationConfiguration",
"security" : [
@@ -138,7 +133,6 @@
"summary" : "Delete a notification subscription configuration",
"description" : "Deletes an existing notification subscription configuration. After the subscription is deleted, no further event notifications will be sent to the URL defined in the subscription.",
"operationId" : "post-deleteNotificationConfigurations",
"x-groupName" : "General",
"x-sortIndex" : 6,
"x-methodName" : "deleteNotificationConfigurations",
"security" : [
@@ -242,7 +236,6 @@
"summary" : "Get a notification subscription configuration",
"description" : "Returns the details of the configuration of a notification subscription.",
"operationId" : "post-getNotificationConfiguration",
"x-groupName" : "General",
"x-sortIndex" : 2,
"x-methodName" : "getNotificationConfiguration",
"security" : [
@@ -346,7 +339,6 @@
"summary" : "Get a list of notification subscription configurations",
"description" : "Returns the details of the configurations of all of the notification subscriptions in the platform of the executing user.",
"operationId" : "post-getNotificationConfigurationList",
"x-groupName" : "General",
"x-sortIndex" : 3,
"x-methodName" : "getNotificationConfigurationList",
"security" : [
@@ -450,7 +442,6 @@
"summary" : "Test a notification configuration",
"description" : "Tests an existing notification subscription configuration. For each event type specified, a test notification will be generated and sent to the URL configured in the subscription specified.",
"operationId" : "post-testNotificationConfiguration",
"x-groupName" : "General",
"x-sortIndex" : 4,
"x-methodName" : "testNotificationConfiguration",
"security" : [
@@ -554,7 +545,6 @@
"summary" : "Update a notification subscription configuration",
"description" : "Updates an existing notification subscription configuration. If you are updating the event types, you must provide all event types, otherwise the previous event type configuration will be overwritten.",
"operationId" : "post-updateNotificationConfiguration",
"x-groupName" : "General",
"x-sortIndex" : 5,
"x-methodName" : "updateNotificationConfiguration",
"security" : [
@@ -1252,7 +1242,7 @@
"value" : {
"pspReference" : "8616480452462678",
"errorMessages" : [
"The required string \"[accepted]\" is not in all the results"
"The server did not respond with HTTP 2XX"
],
"eventTypes" : [
"ACCOUNT_HOLDER_VERIFICATION"

12
json/NotificationConfigurationService-v3.json
View File

@@ -10,16 +10,12 @@
"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" : "2023-05-30T15:27:19Z",
"termsOfService" : "https://www.adyen.com/legal/terms-and-conditions",
"contact" : {
"name" : "Adyen Developer Experience team",
"url" : "https://github.com/Adyen/adyen-openapi"
}
},
"x-groups" : [
"General"
],
"tags" : [
{
"name" : "General"
@@ -34,7 +30,6 @@
"summary" : "Subscribe to notifications",
"description" : "Creates a subscription to notifications informing you of events on your platform. After the subscription is created, the events specified in the configuration will be sent to the URL specified in the configuration. Subscriptions must be configured on a per-event basis (as opposed to, for example, a per-account holder basis), so all event notifications of a marketplace and of a given type will be sent to the same endpoint(s). A marketplace may have multiple endpoints if desired; an event notification may be sent to as many or as few different endpoints as configured.",
"operationId" : "post-createNotificationConfiguration",
"x-groupName" : "General",
"x-sortIndex" : 1,
"x-methodName" : "createNotificationConfiguration",
"security" : [
@@ -138,7 +133,6 @@
"summary" : "Delete a notification subscription configuration",
"description" : "Deletes an existing notification subscription configuration. After the subscription is deleted, no further event notifications will be sent to the URL defined in the subscription.",
"operationId" : "post-deleteNotificationConfigurations",
"x-groupName" : "General",
"x-sortIndex" : 6,
"x-methodName" : "deleteNotificationConfigurations",
"security" : [
@@ -242,7 +236,6 @@
"summary" : "Get a notification subscription configuration",
"description" : "Returns the details of the configuration of a notification subscription.",
"operationId" : "post-getNotificationConfiguration",
"x-groupName" : "General",
"x-sortIndex" : 2,
"x-methodName" : "getNotificationConfiguration",
"security" : [
@@ -346,7 +339,6 @@
"summary" : "Get a list of notification subscription configurations",
"description" : "Returns the details of the configurations of all of the notification subscriptions in the platform of the executing user.",
"operationId" : "post-getNotificationConfigurationList",
"x-groupName" : "General",
"x-sortIndex" : 3,
"x-methodName" : "getNotificationConfigurationList",
"security" : [
@@ -450,7 +442,6 @@
"summary" : "Test a notification configuration",
"description" : "Tests an existing notification subscription configuration. For each event type specified, a test notification will be generated and sent to the URL configured in the subscription specified.",
"operationId" : "post-testNotificationConfiguration",
"x-groupName" : "General",
"x-sortIndex" : 4,
"x-methodName" : "testNotificationConfiguration",
"security" : [
@@ -554,7 +545,6 @@
"summary" : "Update a notification subscription configuration",
"description" : "Updates an existing notification subscription configuration. If you are updating the event types, you must provide all event types, otherwise the previous event type configuration will be overwritten.",
"operationId" : "post-updateNotificationConfiguration",
"x-groupName" : "General",
"x-sortIndex" : 5,
"x-methodName" : "updateNotificationConfiguration",
"security" : [
@@ -1252,7 +1242,7 @@
"value" : {
"pspReference" : "8616480452462678",
"errorMessages" : [
"The required string \"[accepted]\" is not in all the results"
"The server did not respond with HTTP 2XX"
],
"eventTypes" : [
"ACCOUNT_HOLDER_VERIFICATION"

12
json/NotificationConfigurationService-v4.json
View File

@@ -10,16 +10,12 @@
"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" : "2023-05-30T15:27:19Z",
"termsOfService" : "https://www.adyen.com/legal/terms-and-conditions",
"contact" : {
"name" : "Adyen Developer Experience team",
"url" : "https://github.com/Adyen/adyen-openapi"
}
},
"x-groups" : [
"General"
],
"tags" : [
{
"name" : "General"
@@ -34,7 +30,6 @@
"summary" : "Subscribe to notifications",
"description" : "Creates a subscription to notifications informing you of events on your platform. After the subscription is created, the events specified in the configuration will be sent to the URL specified in the configuration. Subscriptions must be configured on a per-event basis (as opposed to, for example, a per-account holder basis), so all event notifications of a marketplace and of a given type will be sent to the same endpoint(s). A marketplace may have multiple endpoints if desired; an event notification may be sent to as many or as few different endpoints as configured.",
"operationId" : "post-createNotificationConfiguration",
"x-groupName" : "General",
"x-sortIndex" : 1,
"x-methodName" : "createNotificationConfiguration",
"security" : [
@@ -138,7 +133,6 @@
"summary" : "Delete a notification subscription configuration",
"description" : "Deletes an existing notification subscription configuration. After the subscription is deleted, no further event notifications will be sent to the URL defined in the subscription.",
"operationId" : "post-deleteNotificationConfigurations",
"x-groupName" : "General",
"x-sortIndex" : 6,
"x-methodName" : "deleteNotificationConfigurations",
"security" : [
@@ -242,7 +236,6 @@
"summary" : "Get a notification subscription configuration",
"description" : "Returns the details of the configuration of a notification subscription.",
"operationId" : "post-getNotificationConfiguration",
"x-groupName" : "General",
"x-sortIndex" : 2,
"x-methodName" : "getNotificationConfiguration",
"security" : [
@@ -346,7 +339,6 @@
"summary" : "Get a list of notification subscription configurations",
"description" : "Returns the details of the configurations of all of the notification subscriptions in the platform of the executing user.",
"operationId" : "post-getNotificationConfigurationList",
"x-groupName" : "General",
"x-sortIndex" : 3,
"x-methodName" : "getNotificationConfigurationList",
"security" : [
@@ -450,7 +442,6 @@
"summary" : "Test a notification configuration",
"description" : "Tests an existing notification subscription configuration. For each event type specified, a test notification will be generated and sent to the URL configured in the subscription specified.",
"operationId" : "post-testNotificationConfiguration",
"x-groupName" : "General",
"x-sortIndex" : 4,
"x-methodName" : "testNotificationConfiguration",
"security" : [
@@ -554,7 +545,6 @@
"summary" : "Update a notification subscription configuration",
"description" : "Updates an existing notification subscription configuration. If you are updating the event types, you must provide all event types, otherwise the previous event type configuration will be overwritten.",
"operationId" : "post-updateNotificationConfiguration",
"x-groupName" : "General",
"x-sortIndex" : 5,
"x-methodName" : "updateNotificationConfiguration",
"security" : [
@@ -1252,7 +1242,7 @@
"value" : {
"pspReference" : "8616480452462678",
"errorMessages" : [
"The required string \"[accepted]\" is not in all the results"
"The server did not respond with HTTP 2XX"
],
"eventTypes" : [
"ACCOUNT_HOLDER_VERIFICATION"

13
json/NotificationConfigurationService-v5.json
View File

@@ -10,16 +10,12 @@
"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" : "2023-05-30T15:27:19Z",
"termsOfService" : "https://www.adyen.com/legal/terms-and-conditions",
"contact" : {
"name" : "Adyen Developer Experience team",
"url" : "https://github.com/Adyen/adyen-openapi"
}
},
"x-groups" : [
"General"
],
"tags" : [
{
"name" : "General"
@@ -34,7 +30,6 @@
"summary" : "Subscribe to notifications",
"description" : "Creates a subscription to notifications informing you of events on your platform. After the subscription is created, the events specified in the configuration will be sent to the URL specified in the configuration. Subscriptions must be configured on a per-event basis (as opposed to, for example, a per-account holder basis), so all event notifications of a marketplace and of a given type will be sent to the same endpoint(s). A marketplace may have multiple endpoints if desired; an event notification may be sent to as many or as few different endpoints as configured.",
"operationId" : "post-createNotificationConfiguration",
"x-groupName" : "General",
"x-sortIndex" : 1,
"x-methodName" : "createNotificationConfiguration",
"security" : [
@@ -138,7 +133,6 @@
"summary" : "Delete a notification subscription configuration",
"description" : "Deletes an existing notification subscription configuration. After the subscription is deleted, no further event notifications will be sent to the URL defined in the subscription.",
"operationId" : "post-deleteNotificationConfigurations",
"x-groupName" : "General",
"x-sortIndex" : 6,
"x-methodName" : "deleteNotificationConfigurations",
"security" : [
@@ -242,7 +236,6 @@
"summary" : "Get a notification subscription configuration",
"description" : "Returns the details of the configuration of a notification subscription.",
"operationId" : "post-getNotificationConfiguration",
"x-groupName" : "General",
"x-sortIndex" : 2,
"x-methodName" : "getNotificationConfiguration",
"security" : [
@@ -346,7 +339,6 @@
"summary" : "Get a list of notification subscription configurations",
"description" : "Returns the details of the configurations of all of the notification subscriptions in the platform of the executing user.",
"operationId" : "post-getNotificationConfigurationList",
"x-groupName" : "General",
"x-sortIndex" : 3,
"x-methodName" : "getNotificationConfigurationList",
"security" : [
@@ -450,7 +442,6 @@
"summary" : "Test a notification configuration",
"description" : "Tests an existing notification subscription configuration. For each event type specified, a test notification will be generated and sent to the URL configured in the subscription specified.",
"operationId" : "post-testNotificationConfiguration",
"x-groupName" : "General",
"x-sortIndex" : 4,
"x-methodName" : "testNotificationConfiguration",
"security" : [
@@ -554,7 +545,6 @@
"summary" : "Update a notification subscription configuration",
"description" : "Updates an existing notification subscription configuration. If you are updating the event types, you must provide all event types, otherwise the previous event type configuration will be overwritten.",
"operationId" : "post-updateNotificationConfiguration",
"x-groupName" : "General",
"x-sortIndex" : 5,
"x-methodName" : "updateNotificationConfiguration",
"security" : [
@@ -804,6 +794,7 @@
"legalBusinessName",
"legalEntity",
"legalEntityType",
"linkedViasVirtualAccount",
"logo",
"merchantAccount",
"merchantCategoryCode",
@@ -1409,7 +1400,7 @@
"value" : {
"pspReference" : "8616480452462678",
"errorMessages" : [
"The required string \"[accepted]\" is not in all the results"
"The server did not respond with HTTP 2XX"
],
"eventTypes" : [
"ACCOUNT_HOLDER_VERIFICATION"

13
json/NotificationConfigurationService-v6.json
View File

@@ -10,16 +10,12 @@
"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" : "2023-05-30T15:27:19Z",
"termsOfService" : "https://www.adyen.com/legal/terms-and-conditions",
"contact" : {
"name" : "Adyen Developer Experience team",
"url" : "https://github.com/Adyen/adyen-openapi"
}
},
"x-groups" : [
"General"
],
"tags" : [
{
"name" : "General"
@@ -34,7 +30,6 @@
"summary" : "Subscribe to notifications",
"description" : "Creates a subscription to notifications informing you of events on your platform. After the subscription is created, the events specified in the configuration will be sent to the URL specified in the configuration. Subscriptions must be configured on a per-event basis (as opposed to, for example, a per-account holder basis), so all event notifications of a marketplace and of a given type will be sent to the same endpoint(s). A marketplace may have multiple endpoints if desired; an event notification may be sent to as many or as few different endpoints as configured.",
"operationId" : "post-createNotificationConfiguration",
"x-groupName" : "General",
"x-sortIndex" : 1,
"x-methodName" : "createNotificationConfiguration",
"security" : [
@@ -138,7 +133,6 @@
"summary" : "Delete a notification subscription configuration",
"description" : "Deletes an existing notification subscription configuration. After the subscription is deleted, no further event notifications will be sent to the URL defined in the subscription.",
"operationId" : "post-deleteNotificationConfigurations",
"x-groupName" : "General",
"x-sortIndex" : 6,
"x-methodName" : "deleteNotificationConfigurations",
"security" : [
@@ -242,7 +236,6 @@
"summary" : "Get a notification subscription configuration",
"description" : "Returns the details of the configuration of a notification subscription.",
"operationId" : "post-getNotificationConfiguration",
"x-groupName" : "General",
"x-sortIndex" : 2,
"x-methodName" : "getNotificationConfiguration",
"security" : [
@@ -346,7 +339,6 @@
"summary" : "Get a list of notification subscription configurations",
"description" : "Returns the details of the configurations of all of the notification subscriptions in the platform of the executing user.",
"operationId" : "post-getNotificationConfigurationList",
"x-groupName" : "General",
"x-sortIndex" : 3,
"x-methodName" : "getNotificationConfigurationList",
"security" : [
@@ -450,7 +442,6 @@
"summary" : "Test a notification configuration",
"description" : "Tests an existing notification subscription configuration. For each event type specified, a test notification will be generated and sent to the URL configured in the subscription specified.",
"operationId" : "post-testNotificationConfiguration",
"x-groupName" : "General",
"x-sortIndex" : 4,
"x-methodName" : "testNotificationConfiguration",
"security" : [
@@ -554,7 +545,6 @@
"summary" : "Update a notification subscription configuration",
"description" : "Updates an existing notification subscription configuration. If you are updating the event types, you must provide all event types, otherwise the previous event type configuration will be overwritten.",
"operationId" : "post-updateNotificationConfiguration",
"x-groupName" : "General",
"x-sortIndex" : 5,
"x-methodName" : "updateNotificationConfiguration",
"security" : [
@@ -804,6 +794,7 @@
"legalBusinessName",
"legalEntity",
"legalEntityType",
"linkedViasVirtualAccount",
"logo",
"merchantAccount",
"merchantCategoryCode",
@@ -1409,7 +1400,7 @@
"value" : {
"pspReference" : "8616480452462678",
"errorMessages" : [
"The required string \"[accepted]\" is not in all the results"
"The server did not respond with HTTP 2XX"
],
"eventTypes" : [
"ACCOUNT_HOLDER_VERIFICATION"

77
yaml/AccountService-v3.yaml
View File

@@ -24,19 +24,14 @@ 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: '2023-05-30T15:27:20Z'
termsOfService: https://www.adyen.com/legal/terms-and-conditions
contact:
name: Adyen Developer Experience team
url: https://github.com/Adyen/adyen-openapi
x-groups:
- Account holders
- Accounts
- Verification
tags:
- name: Account holders
- name: Verification
- name: Accounts
- name: Verification
paths:
/closeAccount:
post:
@@ -47,7 +42,6 @@ paths:
transactions, pay out its funds, or reopen it. If payments are made to a closed
account, the payments are sent to your liable account.
operationId: post-closeAccount
x-groupName: Accounts
x-sortIndex: 3
x-methodName: closeAccount
security:
@@ -122,7 +116,6 @@ paths:
an account of an account holder with a **Closed** [`status`](https://docs.adyen.com/api-explorer/#/Account/latest/post/getAccountHolder__resParam_verification-accountHolder-checks-status),
the payments are sent to your liable account.
operationId: post-closeAccountHolder
x-groupName: Account holders
x-sortIndex: 7
x-methodName: closeAccountHolder
security:
@@ -194,7 +187,6 @@ paths:
description: Creates an account under an account holder. An account holder can
have [multiple accounts](https://docs.adyen.com/marketplaces-and-platforms/classic/account-holders-and-accounts#create-additional-accounts).
operationId: post-createAccount
x-groupName: Accounts
x-sortIndex: 1
x-methodName: createAccount
security:
@@ -268,7 +260,6 @@ paths:
on the sub-merchant's legal entity type. For more information, refer to [Account
holder and accounts](https://docs.adyen.com/marketplaces-and-platforms/classic/account-holders-and-accounts#legal-entity-types).
operationId: post-createAccountHolder
x-groupName: Account holders
x-sortIndex: 1
x-methodName: createAccountHolder
security:
@@ -350,7 +341,6 @@ paths:
summary: Delete bank accounts
description: 'Deletes bank accounts associated with an account holder. '
operationId: post-deleteBankAccounts
x-groupName: Verification
x-sortIndex: 4
x-methodName: deleteBankAccounts
security:
@@ -422,7 +412,6 @@ paths:
description: Deletes legal arrangements and/or legal arrangement entities associated
with an account holder.
operationId: post-deleteLegalArrangements
x-groupName: Verification
x-sortIndex: 6
x-methodName: deleteLegalArrangements
security:
@@ -504,7 +493,6 @@ paths:
summary: Delete shareholders
description: Deletes shareholders associated with an account holder.
operationId: post-deleteShareholders
x-groupName: Verification
x-sortIndex: 7
x-methodName: deleteShareholders
security:
@@ -575,7 +563,6 @@ paths:
summary: Delete signatories
description: Deletes signatories associated with an account holder.
operationId: post-deleteSignatories
x-groupName: Verification
x-sortIndex: 8
x-methodName: deleteSignatories
security:
@@ -643,7 +630,6 @@ paths:
summary: Get an account holder
description: Returns the details of an account holder.
operationId: post-getAccountHolder
x-groupName: Account holders
x-sortIndex: 2
x-methodName: getAccountHolder
security:
@@ -717,7 +703,6 @@ paths:
description: Generates a tax form for account holders operating in the US. For
more information, refer to [Providing tax forms](https://docs.adyen.com/marketplaces-and-platforms/classic/tax-forms).
operationId: post-getTaxForm
x-groupName: Account holders
x-sortIndex: 8
x-methodName: getTaxForm
security:
@@ -784,7 +769,6 @@ paths:
'
operationId: post-getUploadedDocuments
x-groupName: Verification
x-sortIndex: 2
x-methodName: getUploadedDocuments
security:
@@ -849,7 +833,6 @@ paths:
description: Changes the [status of an account holder](https://docs.adyen.com/marketplaces-and-platforms/classic/account-holders-and-accounts#account-holder-statuses)
to **Suspended**.
operationId: post-suspendAccountHolder
x-groupName: Account holders
x-sortIndex: 5
x-methodName: suspendAccountHolder
security:
@@ -926,7 +909,6 @@ paths:
\ account holders if they do not have verification checks with a **FAILED**\
\ [`status`](https://docs.adyen.com/api-explorer/#/Account/latest/post/getAccountHolder__resParam_verification-accountHolder-checks-status)."
operationId: post-unSuspendAccountHolder
x-groupName: Account holders
x-sortIndex: 6
x-methodName: unSuspendAccountHolder
security:
@@ -997,7 +979,6 @@ paths:
summary: Update an account
description: Updates the description or payout schedule of an account.
operationId: post-updateAccount
x-groupName: Accounts
x-sortIndex: 2
x-methodName: updateAccount
security:
@@ -1081,7 +1062,6 @@ paths:
\ provide the bank account or shareholder details without a `bankAccountUUID`\
\ or a `shareholderCode`.\n\n"
operationId: post-updateAccountHolder
x-groupName: Account holders
x-sortIndex: 3
x-methodName: updateAccountHolder
security:
@@ -1159,7 +1139,6 @@ paths:
description: Disables or enables the processing or payout state of an account
holder.
operationId: post-updateAccountHolderState
x-groupName: Account holders
x-sortIndex: 4
x-methodName: updateAccountHolderState
security:
@@ -1231,7 +1210,6 @@ paths:
description: Uploads a document for an account holder. Adyen uses the documents
during the [verification process](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process).
operationId: post-uploadDocument
x-groupName: Verification
x-sortIndex: 1
x-methodName: uploadDocument
security:
@@ -1922,9 +1900,15 @@ components:
description: The code of Account Holder under which to create the account.
type: string
payoutSchedule:
description: 'The payout schedule of the prospective account.
description: 'The payout schedule for the account.
>Permitted values: `DEFAULT`, `HOLD`, `DAILY`, `WEEKLY`, `MONTHLY`.'
Possible values: `DEFAULT`, `DAILY`, `DAILY_US`, `DAILY_EU`, `DAILY_AU`,
`DAILY_SG`, `WEEKLY`, `WEEKLY_ON_TUE_FRI_MIDNIGHT`, `BIWEEKLY_ON_1ST_AND_15TH_AT_MIDNIGHT`,
`MONTHLY`, `HOLD`.
> `HOLD` prevents scheduled payouts, but you can still initiate payouts
manually.'
enum:
- BIWEEKLY_ON_1ST_AND_15TH_AT_MIDNIGHT
- DAILY
@@ -1945,7 +1929,8 @@ components:
payoutScheduleReason:
description: 'The reason for the payout schedule choice.
>Required if the payoutSchedule is `HOLD`.'
> This field is required when the `payoutSchedule` parameter is set to
`HOLD`.'
type: string
required:
- accountHolderCode
@@ -1959,7 +1944,7 @@ components:
description: The code of the account holder.
type: string
payoutSchedule:
description: The payout schedule of the account.
description: The details of the payout schedule added to the account.
$ref: '#/components/schemas/PayoutScheduleResponse'
pspReference:
description: The reference of a request. Can be used to uniquely identify
@@ -2245,6 +2230,7 @@ components:
- legalBusinessName
- legalEntity
- legalEntityType
- linkedViasVirtualAccount
- logo
- merchantAccount
- merchantCategoryCode
@@ -2690,11 +2676,15 @@ components:
format: date-time
type: string
schedule:
description: 'The payout schedule of the account.
description: 'The payout schedule for the account.
Permitted values: `DEFAULT`, `DAILY`, `DAILY_US`, `DAILY_EU`, `DAILY_AU`,
Possible values: `DEFAULT`, `DAILY`, `DAILY_US`, `DAILY_EU`, `DAILY_AU`,
`DAILY_SG`, `WEEKLY`, `WEEKLY_ON_TUE_FRI_MIDNIGHT`, `BIWEEKLY_ON_1ST_AND_15TH_AT_MIDNIGHT`,
`MONTHLY`, `HOLD`.'
`MONTHLY`, `HOLD`.
> `HOLD` prevents scheduled payouts, but you can still initiate payouts
manually.'
enum:
- BIWEEKLY_ON_1ST_AND_15TH_AT_MIDNIGHT
- DAILY
@@ -3124,7 +3114,7 @@ components:
description: The code of the account to update.
type: string
payoutSchedule:
description: The details of the payout schedule, to which the account should
description: The details of the payout schedule to which the account must
be updated.
$ref: '#/components/schemas/UpdatePayoutScheduleRequest'
required:
@@ -3137,7 +3127,8 @@ components:
description: The code of the account.
type: string
payoutSchedule:
description: The payout schedule of the account.
description: The details of the payout schedule to which the account is
updated.
$ref: '#/components/schemas/PayoutScheduleResponse'
pspReference:
description: The reference of a request. Can be used to uniquely identify
@@ -3166,13 +3157,14 @@ components:
description: 'Direction on how to handle any payouts that have already been
scheduled.
Permitted values:
* `CLOSE` will close the existing batch of payouts.
Possible values:
* `UPDATE` will reschedule the existing batch to the new schedule.
* `CLOSE`: close the existing batch of payouts.
* `NOTHING` (**default**) will allow the payout to proceed.'
* `UPDATE`: reschedule the existing batch to the new schedule.
* `NOTHING` (**default**): allow the payout to proceed.'
enum:
- CLOSE
- NOTHING
@@ -3184,14 +3176,15 @@ components:
> This field is required when the `schedule` parameter is set to `HOLD`.'
type: string
schedule:
description: 'The payout schedule to which the account is to be updated.
description: 'The new payout schedule for the account.
Permitted values: `DAILY`, `DAILY_US`, `DAILY_EU`, `DAILY_AU`, `DAILY_SG`,
`WEEKLY`, `WEEKLY_ON_TUE_FRI_MIDNIGHT`, `BIWEEKLY_ON_1ST_AND_15TH_AT_MIDNIGHT`,
Possible values: `DEFAULT`, `DAILY`, `DAILY_US`, `DAILY_EU`, `DAILY_AU`,
`DAILY_SG`, `WEEKLY`, `WEEKLY_ON_TUE_FRI_MIDNIGHT`, `BIWEEKLY_ON_1ST_AND_15TH_AT_MIDNIGHT`,
`MONTHLY`, `HOLD`.
`HOLD` will prevent scheduled payouts from happening but will still allow
manual payouts to occur.'
> `HOLD` prevents scheduled payouts, but you can still initiate payouts
manually.'
enum:
- BIWEEKLY_ON_1ST_AND_15TH_AT_MIDNIGHT
- DAILY
@@ -3382,7 +3375,7 @@ components:
message: 'Unexpected input: I'
errorType: validation
generic-403:
summary: Response code 401. Forbidden.
summary: Response code 403. Forbidden.
value:
status: 403
errorCode: '10_003'

460
yaml/AccountService-v4.yaml
View File

@@ -24,19 +24,14 @@ 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: '2023-05-30T15:27:20Z'
termsOfService: https://www.adyen.com/legal/terms-and-conditions
contact:
name: Adyen Developer Experience team
url: https://github.com/Adyen/adyen-openapi
x-groups:
- Account holders
- Accounts
- Verification
tags:
- name: Account holders
- name: Verification
- name: Accounts
- name: Verification
paths:
/closeAccount:
post:
@@ -47,7 +42,6 @@ paths:
transactions, pay out its funds, or reopen it. If payments are made to a closed
account, the payments are sent to your liable account.
operationId: post-closeAccount
x-groupName: Accounts
x-sortIndex: 3
x-methodName: closeAccount
security:
@@ -122,7 +116,6 @@ paths:
an account of an account holder with a **Closed** [`status`](https://docs.adyen.com/api-explorer/#/Account/latest/post/getAccountHolder__resParam_verification-accountHolder-checks-status),
the payments are sent to your liable account.
operationId: post-closeAccountHolder
x-groupName: Account holders
x-sortIndex: 7
x-methodName: closeAccountHolder
security:
@@ -194,7 +187,6 @@ paths:
description: Creates an account under an account holder. An account holder can
have [multiple accounts](https://docs.adyen.com/marketplaces-and-platforms/classic/account-holders-and-accounts#create-additional-accounts).
operationId: post-createAccount
x-groupName: Accounts
x-sortIndex: 1
x-methodName: createAccount
security:
@@ -268,7 +260,6 @@ paths:
on the sub-merchant's legal entity type. For more information, refer to [Account
holder and accounts](https://docs.adyen.com/marketplaces-and-platforms/classic/account-holders-and-accounts#legal-entity-types).
operationId: post-createAccountHolder
x-groupName: Account holders
x-sortIndex: 1
x-methodName: createAccountHolder
security:
@@ -288,6 +279,11 @@ paths:
'200':
content:
application/json:
examples:
business:
$ref: '#/components/examples/post-createAccountHolder-business-200'
individual:
$ref: '#/components/examples/post-createAccountHolder-individual-200'
schema:
$ref: '#/components/schemas/CreateAccountHolderResponse'
description: OK - the request has succeeded.
@@ -334,7 +330,6 @@ paths:
summary: Delete bank accounts
description: 'Deletes bank accounts associated with an account holder. '
operationId: post-deleteBankAccounts
x-groupName: Verification
x-sortIndex: 4
x-methodName: deleteBankAccounts
security:
@@ -406,7 +401,6 @@ paths:
description: Deletes legal arrangements and/or legal arrangement entities associated
with an account holder.
operationId: post-deleteLegalArrangements
x-groupName: Verification
x-sortIndex: 6
x-methodName: deleteLegalArrangements
security:
@@ -488,7 +482,6 @@ paths:
summary: Delete shareholders
description: Deletes shareholders associated with an account holder.
operationId: post-deleteShareholders
x-groupName: Verification
x-sortIndex: 7
x-methodName: deleteShareholders
security:
@@ -559,7 +552,6 @@ paths:
summary: Delete signatories
description: Deletes signatories associated with an account holder.
operationId: post-deleteSignatories
x-groupName: Verification
x-sortIndex: 8
x-methodName: deleteSignatories
security:
@@ -627,7 +619,6 @@ paths:
summary: Get an account holder
description: Returns the details of an account holder.
operationId: post-getAccountHolder
x-groupName: Account holders
x-sortIndex: 2
x-methodName: getAccountHolder
security:
@@ -701,7 +692,6 @@ paths:
description: Generates a tax form for account holders operating in the US. For
more information, refer to [Providing tax forms](https://docs.adyen.com/marketplaces-and-platforms/classic/tax-forms).
operationId: post-getTaxForm
x-groupName: Account holders
x-sortIndex: 8
x-methodName: getTaxForm
security:
@@ -768,7 +758,6 @@ paths:
'
operationId: post-getUploadedDocuments
x-groupName: Verification
x-sortIndex: 2
x-methodName: getUploadedDocuments
security:
@@ -833,7 +822,6 @@ paths:
description: Changes the [status of an account holder](https://docs.adyen.com/marketplaces-and-platforms/classic/account-holders-and-accounts#account-holder-statuses)
to **Suspended**.
operationId: post-suspendAccountHolder
x-groupName: Account holders
x-sortIndex: 5
x-methodName: suspendAccountHolder
security:
@@ -910,7 +898,6 @@ paths:
\ account holders if they do not have verification checks with a **FAILED**\
\ [`status`](https://docs.adyen.com/api-explorer/#/Account/latest/post/getAccountHolder__resParam_verification-accountHolder-checks-status)."
operationId: post-unSuspendAccountHolder
x-groupName: Account holders
x-sortIndex: 6
x-methodName: unSuspendAccountHolder
security:
@@ -981,7 +968,6 @@ paths:
summary: Update an account
description: Updates the description or payout schedule of an account.
operationId: post-updateAccount
x-groupName: Accounts
x-sortIndex: 2
x-methodName: updateAccount
security:
@@ -1065,7 +1051,6 @@ paths:
\ provide the bank account or shareholder details without a `bankAccountUUID`\
\ or a `shareholderCode`.\n\n"
operationId: post-updateAccountHolder
x-groupName: Account holders
x-sortIndex: 3
x-methodName: updateAccountHolder
security:
@@ -1089,6 +1074,15 @@ paths:
'200':
content:
application/json:
examples:
addShareholders:
$ref: '#/components/examples/post-updateAccountHolder-addShareholders-200'
bankAccountDetails:
$ref: '#/components/examples/post-updateAccountHolder-bankAccountDetails-200'
businessDetails:
$ref: '#/components/examples/post-updateAccountHolder-businessDetails-200'
general:
$ref: '#/components/examples/post-updateAccountHolder-general-200'
schema:
$ref: '#/components/schemas/UpdateAccountHolderResponse'
description: OK - the request has succeeded.
@@ -1143,7 +1137,6 @@ paths:
description: Disables or enables the processing or payout state of an account
holder.
operationId: post-updateAccountHolderState
x-groupName: Account holders
x-sortIndex: 4
x-methodName: updateAccountHolderState
security:
@@ -1215,7 +1208,6 @@ paths:
description: Uploads a document for an account holder. Adyen uses the documents
during the [verification process](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process).
operationId: post-uploadDocument
x-groupName: Verification
x-sortIndex: 1
x-methodName: uploadDocument
security:
@@ -1949,9 +1941,15 @@ components:
`_`.
type: string
payoutSchedule:
description: 'The payout schedule of the prospective account.
description: 'The payout schedule for the account.
>Permitted values: `DEFAULT`, `HOLD`, `DAILY`, `WEEKLY`, `MONTHLY`.'
Possible values: `DEFAULT`, `DAILY`, `DAILY_US`, `DAILY_EU`, `DAILY_AU`,
`DAILY_SG`, `WEEKLY`, `WEEKLY_ON_TUE_FRI_MIDNIGHT`, `BIWEEKLY_ON_1ST_AND_15TH_AT_MIDNIGHT`,
`MONTHLY`, `HOLD`.
> `HOLD` prevents scheduled payouts, but you can still initiate payouts
manually.'
enum:
- BIWEEKLY_ON_1ST_AND_15TH_AT_MIDNIGHT
- DAILY
@@ -1972,7 +1970,8 @@ components:
payoutScheduleReason:
description: 'The reason for the payout schedule choice.
>Required if the payoutSchedule is `HOLD`.'
> This field is required when the `payoutSchedule` parameter is set to
`HOLD`.'
type: string
required:
- accountHolderCode
@@ -1990,7 +1989,7 @@ components:
description: The description of the account.
type: string
payoutSchedule:
description: The payout schedule of the account.
description: The details of the payout schedule added to the account.
$ref: '#/components/schemas/PayoutScheduleResponse'
pspReference:
description: The reference of a request. Can be used to uniquely identify
@@ -2279,6 +2278,7 @@ components:
- legalBusinessName
- legalEntity
- legalEntityType
- linkedViasVirtualAccount
- logo
- merchantAccount
- merchantCategoryCode
@@ -2738,11 +2738,15 @@ components:
format: date-time
type: string
schedule:
description: 'The payout schedule of the account.
description: 'The payout schedule for the account.
Permitted values: `DEFAULT`, `DAILY`, `DAILY_US`, `DAILY_EU`, `DAILY_AU`,
Possible values: `DEFAULT`, `DAILY`, `DAILY_US`, `DAILY_EU`, `DAILY_AU`,
`DAILY_SG`, `WEEKLY`, `WEEKLY_ON_TUE_FRI_MIDNIGHT`, `BIWEEKLY_ON_1ST_AND_15TH_AT_MIDNIGHT`,
`MONTHLY`, `HOLD`.'
`MONTHLY`, `HOLD`.
> `HOLD` prevents scheduled payouts, but you can still initiate payouts
manually.'
enum:
- BIWEEKLY_ON_1ST_AND_15TH_AT_MIDNIGHT
- DAILY
@@ -3202,7 +3206,7 @@ components:
`_`.
type: string
payoutSchedule:
description: The details of the payout schedule, to which the account should
description: The details of the payout schedule to which the account must
be updated.
$ref: '#/components/schemas/UpdatePayoutScheduleRequest'
required:
@@ -3218,7 +3222,8 @@ components:
description: The description of the account.
type: string
payoutSchedule:
description: The payout schedule of the account.
description: The details of the payout schedule to which the account is
updated.
$ref: '#/components/schemas/PayoutScheduleResponse'
pspReference:
description: The reference of a request. Can be used to uniquely identify
@@ -3247,13 +3252,14 @@ components:
description: 'Direction on how to handle any payouts that have already been
scheduled.
Permitted values:
* `CLOSE` will close the existing batch of payouts.
Possible values:
* `UPDATE` will reschedule the existing batch to the new schedule.
* `CLOSE`: close the existing batch of payouts.
* `NOTHING` (**default**) will allow the payout to proceed.'
* `UPDATE`: reschedule the existing batch to the new schedule.
* `NOTHING` (**default**): allow the payout to proceed.'
enum:
- CLOSE
- NOTHING
@@ -3265,14 +3271,15 @@ components:
> This field is required when the `schedule` parameter is set to `HOLD`.'
type: string
schedule:
description: 'The payout schedule to which the account is to be updated.
description: 'The new payout schedule for the account.
Permitted values: `DAILY`, `DAILY_US`, `DAILY_EU`, `DAILY_AU`, `DAILY_SG`,
`WEEKLY`, `WEEKLY_ON_TUE_FRI_MIDNIGHT`, `BIWEEKLY_ON_1ST_AND_15TH_AT_MIDNIGHT`,
Possible values: `DEFAULT`, `DAILY`, `DAILY_US`, `DAILY_EU`, `DAILY_AU`,
`DAILY_SG`, `WEEKLY`, `WEEKLY_ON_TUE_FRI_MIDNIGHT`, `BIWEEKLY_ON_1ST_AND_15TH_AT_MIDNIGHT`,
`MONTHLY`, `HOLD`.
`HOLD` will prevent scheduled payouts from happening but will still allow
manual payouts to occur.'
> `HOLD` prevents scheduled payouts, but you can still initiate payouts
manually.'
enum:
- BIWEEKLY_ON_1ST_AND_15TH_AT_MIDNIGHT
- DAILY
@@ -3463,7 +3470,7 @@ components:
message: 'Unexpected input: I'
errorType: validation
generic-403:
summary: Response code 401. Forbidden.
summary: Response code 403. Forbidden.
value:
status: 403
errorCode: '10_003'
@@ -3482,9 +3489,9 @@ components:
value:
accountHolderCode: CODE_OF_ACCOUNT_HOLDER
post-createAccountHolder-business:
summary: Create a business account holder
summary: Create business account holder with shareholder
value:
accountHolderCode: GENERATE_CODE
accountHolderCode: YOUR_UNIQUE_ACCOUNT_HOLDER_CODE
accountHolderDetails:
address:
country: US
@@ -3493,6 +3500,7 @@ components:
legalBusinessName: Real Good Restaurant Inc.
shareholders:
- ShareholderContact:
shareholderType: Owner
name:
firstName: John
lastName: Carpenter
@@ -3500,10 +3508,59 @@ components:
email: test@adyen.com
webAddress: https://www.your-website.com
legalEntity: Business
post-createAccountHolder-business-200:
summary: Business account holder with shareholder created
value:
pspReference: ALPHANUMERIC_UNIQUE_RESPONSE_REFERENCE
submittedAsync: 'false'
accountCode: UNIQUE_ACCOUNT_CODE
accountHolderCode: YOUR_UNIQUE_ACCOUNT_HOLDER_CODE
accountHolderDetails:
address:
country: US
bankAccountDetails: []
businessDetails:
doingBusinessAs: Real Good Restaurant
legalBusinessName: Real Good Restaurant Inc.
shareholders:
- ShareholderContact:
email: testshareholder@adyen.com
legalEntityId: SHAREHOLDER_LEGAL_ENTITY_ID
name:
firstName: John
lastName: Carpenter
shareholderCode: SHAREHOLDER_CODE
shareholderType: Owner
email: test@adyen.com
legalEntityId: LE
merchantCategoryCode: MCC_DEFAULT_VALUE
webAddress: https://www.your-website.com
accountHolderStatus:
status: Active
processingState:
disabled: 'false'
processedFrom:
currency: USD
value: 0
processedTo:
currency: USD
value: 0
tierNumber: 0
payoutState:
allowPayout: 'true'
payoutLimit:
currency: USD
value: 0
disabled: 'false'
tierNumber: 0
events: []
invalidFields: []
legalEntity: Business
verification: {}
post-createAccountHolder-individual:
summary: Create an individual account holder
value:
accountHolderCode: GENERATE_CODE
accountHolderCode: YOUR_UNIQUE_ACCOUNT_HOLDER_CODE
accountHolderDetails:
email: tim@green.com
individualDetails:
@@ -3514,6 +3571,47 @@ components:
country: US
webAddress: https://www.your-website.com
legalEntity: Individual
post-createAccountHolder-individual-200:
summary: Individual account holder created
value:
pspReference: ALPHANUMERIC_UNIQUE_RESPONSE_REFERENCE
submittedAsync: 'false'
accountCode: UNIQUE_ACCOUNT_CODE
accountHolderCode: YOUR_UNIQUE_ACCOUNT_HOLDER_CODE
accountHolderDetails:
address:
country: US
bankAccountDetails: []
email: tim@green.com
individualDetails:
name:
firstName: Tim
lastName: Green
legalEntityId: LEGAL_ENTITY_ID
merchantCategoryCode: MCC_DEFAULT_VALUE
webAddress: https://www.your-website.com
accountHolderStatus:
status: Active
processingState:
disabled: 'false'
processedFrom:
currency: USD
value: 0
processedTo:
currency: USD
value: 0
tierNumber: 0
payoutState:
allowPayout: 'true'
payoutLimit:
currency: USD
value: 0
disabled: 'false'
tierNumber: 0
events: []
invalidFields: []
legalEntity: Individual
verification: {}
post-deleteBankAccounts-basic:
summary: Delete bank accounts
value:
@@ -3609,29 +3707,79 @@ components:
schedule: WEEKLY
action: CLOSE
post-updateAccountHolder-addShareholders:
summary: Add shareholders
summary: Add shareholder to existing account holder
value:
accountHolderCode: CODE_OF_ACCOUNT_HOLDER
accountHolderCode: YOUR_UNIQUE_ACCOUNT_HOLDER_CODE
accountHolderDetails:
bankAccountDetails: []
businessDetails:
legalBusinessName: legalBusinessName
shareholders:
- ShareholderContact:
email: testEmail@gmail.com
shareholderType: Controller
email: s.eller@company.com
personalData:
idNumber: '12345'
taxId: taxid
name:
firstName: Shelly
lastName: Eller
taxId: '123456'
post-updateAccountHolder-addShareholders-200:
summary: Added shareholder to existing account holder
value:
pspReference: ALPHANUMERIC_UNIQUE_RESPONSE_REFERENCE
submittedAsync: 'false'
accountHolderCode: YOUR_UNIQUE_ACCOUNT_HOLDER_CODE
accountHolderDetails:
address:
country: US
bankAccountDetails: []
businessDetails:
doingBusinessAs: Real Good Restaurant
legalBusinessName: Real Good Restaurant Inc.
shareholders:
- ShareholderContact:
email: s.eller@company.com
legalEntityId: SHAREHOLDER_LEGAL_ENTITY_ID
name:
firstName: Shelly
lastName: Eller
personalData:
idNumber: '12345'
shareholderCode: SHAREHOLDER_CODE
shareholderType: Controller
taxId: '123456'
email: test@company.com
legalEntityId: AH_LEGAL_ENTITY_ID
merchantCategoryCode: MCC_DEFAULT_VALUE
webAddress: https://www.your-website.com
accountHolderStatus:
status: Active
processingState:
disabled: 'false'
processedFrom:
currency: USD
value: 0
processedTo:
currency: USD
value: 0
tierNumber: 0
payoutState:
allowPayout: 'true'
payoutLimit:
currency: USD
value: 0
disabled: 'false'
tierNumber: 0
invalidFields: []
legalEntity: Business
updatedFields: []
verification: {}
post-updateAccountHolder-bankAccountDetails:
summary: Update bank account details
value:
accountHolderCode: CODE_OF_ACCOUNT_HOLDER
accountHolderCode: YOUR_UNIQUE_ACCOUNT_HOLDER_CODE
accountHolderDetails:
email: tim@green.com
individualDetails:
name:
firstName: Tim
lastName: Green
bankAccountDetails:
- BankAccountDetail:
accountNumber: '1678116852'
@@ -3645,62 +3793,194 @@ components:
ownerCity: Springfield
ownerState: AZ
ownerCountryCode: US
post-updateAccountHolder-businessDetails:
summary: Update business details
post-updateAccountHolder-bankAccountDetails-200:
summary: Bank account details updated
value:
accountHolderCode: CODE_OF_ACCOUNT_HOLDER
pspReference: ALPHANUMERIC_UNIQUE_RESPONSE_REFERENCE
submittedAsync: 'false'
accountHolderCode: YOUR_UNIQUE_ACCOUNT_HOLDER_CODE
accountHolderDetails:
bankAccountDetails: []
businessDetails:
doingBusinessAs: Test company B.V.
legalBusinessName: Test company
shareholders:
- ShareholderContact:
address:
city: Amsterdam
country: NL
houseNumberOrName: '1'
postalCode: 1111AA
stateOrProvince: NH
street: Teststreet
email: testShareholder@adyen.com
name:
firstName: TestFirstName
lastName: TestLastName
taxId: BV123456789
email: test@adyen.com
address:
city: Amsterdam
country: US
postalCode: '12345'
stateOrProvince: NH
street: Main Street
bankAccountDetails:
- BankAccountDetail:
accountNumber: '######6852'
bankAccountUUID: BANK_ACCOUNT_UUID
branchCode: '053101273'
countryCode: US
currencyCode: USD
ownerCity: Springfield
ownerCountryCode: US
ownerHouseNumberOrName: '100'
ownerName: Tim Green
ownerPostalCode: 02894
ownerState: AZ
ownerStreet: Main Street
primaryAccount: 'false'
email: tim@green.com
individualDetails:
name:
firstName: Tim
lastName: Green
personalData:
dateOfBirth: '1970-01-01'
idNumber: '1234567890'
nationality: NL
legalEntityId: LEGAL_ENTITY_ID
merchantCategoryCode: MCC_DEFAULT_VALUE
phoneNumber:
phoneCountryCode: NL
phoneNumber: 0612345678
phoneType: Mobile
webAddress: http://www.accountholderwebsite.com
post-updateAccountHolder-general:
summary: Update account holder details
accountHolderStatus:
status: Active
processingState:
disabled: 'false'
processedFrom:
currency: USD
value: 100000
processedTo:
currency: USD
value: 499999
tierNumber: 2
payoutState:
allowPayout: 'false'
disabled: 'false'
description: Description
invalidFields: []
legalEntity: Individual
updatedFields: []
post-updateAccountHolder-businessDetails:
summary: Update business details
value:
accountHolderCode: CODE_OF_ACCOUNT_HOLDER
accountHolderCode: YOUR_UNIQUE_ACCOUNT_HOLDER_CODE
accountHolderDetails:
businessDetails:
doingBusinessAs: Updated Company Name
legalBusinessName: Company Name B.V.
taxId: BV123456789
post-updateAccountHolder-businessDetails-200:
summary: Business details updated
value:
pspReference: ALPHANUMERIC_UNIQUE_RESPONSE_REFERENCE
submittedAsync: 'false'
accountCode: UNIQUE_ACCOUNT_CODE
accountHolderCode: YOUR_UNIQUE_ACCOUNT_HOLDER_CODE
accountHolderDetails:
address:
country: US
bankAccountDetails: []
businessDetails:
doingBusinessAs: Update Company Name
legalBusinessName: Company Name B.V.
shareholders:
- ShareholderContact:
email: testshareholder@adyen.com
legalEntityId: SHAREHOLDER_LEGAL_ENTITY_ID
name:
firstName: John
lastName: Carpenter
shareholderCode: SHAREHOLDER_CODE
shareholderType: Owner
taxId: BV123456789
email: test@company.com
legalEntityId: AH_LEGAL_ENTITY_ID
merchantCategoryCode: MCC_DEFAULT_VALUE
webAddress: https://www.your-website.com
accountHolderStatus:
status: Active
processingState:
disabled: 'false'
processedFrom:
currency: USD
value: 0
processedTo:
currency: USD
value: 0
tierNumber: 0
payoutState:
allowPayout: 'true'
payoutLimit:
currency: USD
value: 0
disabled: 'false'
tierNumber: 0
events: []
invalidFields: []
legalEntity: Business
verification: {}
post-updateAccountHolder-general:
summary: Update multiple details of account holder
value:
accountHolderCode: YOUR_UNIQUE_ACCOUNT_HOLDER_CODE
accountHolderDetails:
address:
city: Amsterdam
country: NL
postalCode: '12345'
stateOrProvince: NH
street: Teststreet 1
street: Main Street
bankAccountDetails: []
email: test@adyen.com
individualDetails:
name:
firstName: First name
lastName: Last Name
personalData:
dateOfBirth: '1970-01-01'
idNumber: '1234567890'
nationality: NL
email: test@company.com
merchantCategoryCode: '7999'
phoneNumber:
phoneCountryCode: NL
phoneNumber: 0612345678
phoneType: Mobile
webAddress: http://www.accountholderwebsite.com
post-updateAccountHolder-general-200:
summary: Updated multiple details of account holder
value:
pspReference: ALPHANUMERIC_UNIQUE_RESPONSE_REFERENCE
submittedAsync: 'false'
accountHolderCode: YOUR_UNIQUE_ACCOUNT_HOLDER_CODE
accountHolderDetails:
address:
city: Amsterdam
country: NL
postalCode: '12345'
stateOrProvince: NH
street: Main Street
bankAccountDetails: []
email: test@company.com
individualDetails:
name:
firstName: Tim
lastName: Green
legalEntityId: LEGAL_ENTITY_ID
merchantCategoryCode: MCC_DEFAULT_VALUE
phoneNumber:
phoneCountryCode: NL
phoneNumber: 0612345678
phoneType: Mobile
webAddress: http://www.accountholderwebsite.com
accountHolderStatus:
status: Active
processingState:
disabled: 'false'
processedFrom:
currency: EUR
value: 0
processedTo:
currency: EUR
value: 0
tierNumber: 0
payoutState:
allowPayout: 'true'
payoutLimit:
currency: EUR
value: 0
disabled: 'false'
tierNumber: 0
invalidFields: []
legalEntity: Individual
updatedFields: []
verification: {}
post-updateAccountHolderState-basic:
summary: Update account holder state
value:

434
yaml/AccountService-v5.yaml
View File

@@ -24,19 +24,14 @@ 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: '2023-05-30T15:27:20Z'
termsOfService: https://www.adyen.com/legal/terms-and-conditions
contact:
name: Adyen Developer Experience team
url: https://github.com/Adyen/adyen-openapi
x-groups:
- Account holders
- Accounts
- Verification
tags:
- name: Account holders
- name: Verification
- name: Accounts
- name: Verification
paths:
/checkAccountHolder:
post:
@@ -47,7 +42,6 @@ paths:
are not yet required for the volume that they are currently processing.
x-addedInVersion: '5'
operationId: post-checkAccountHolder
x-groupName: Verification
x-sortIndex: 3
x-methodName: checkAccountHolder
security:
@@ -120,7 +114,6 @@ paths:
transactions, pay out its funds, or reopen it. If payments are made to a closed
account, the payments are sent to your liable account.
operationId: post-closeAccount
x-groupName: Accounts
x-sortIndex: 3
x-methodName: closeAccount
security:
@@ -195,7 +188,6 @@ paths:
an account of an account holder with a **Closed** [`status`](https://docs.adyen.com/api-explorer/#/Account/latest/post/getAccountHolder__resParam_verification-accountHolder-checks-status),
the payments are sent to your liable account.
operationId: post-closeAccountHolder
x-groupName: Account holders
x-sortIndex: 7
x-methodName: closeAccountHolder
security:
@@ -267,7 +259,6 @@ paths:
description: Closes stores associated with an account holder.
x-addedInVersion: '5'
operationId: post-closeStores
x-groupName: Account holders
x-sortIndex: 9
x-methodName: closeStores
security:
@@ -329,7 +320,6 @@ paths:
description: Creates an account under an account holder. An account holder can
have [multiple accounts](https://docs.adyen.com/marketplaces-and-platforms/classic/account-holders-and-accounts#create-additional-accounts).
operationId: post-createAccount
x-groupName: Accounts
x-sortIndex: 1
x-methodName: createAccount
security:
@@ -403,7 +393,6 @@ paths:
on the sub-merchant's legal entity type. For more information, refer to [Account
holder and accounts](https://docs.adyen.com/marketplaces-and-platforms/classic/account-holders-and-accounts#legal-entity-types).
operationId: post-createAccountHolder
x-groupName: Account holders
x-sortIndex: 1
x-methodName: createAccountHolder
security:
@@ -423,6 +412,11 @@ paths:
'200':
content:
application/json:
examples:
business:
$ref: '#/components/examples/post-createAccountHolder-business-200'
individual:
$ref: '#/components/examples/post-createAccountHolder-individual-200'
schema:
$ref: '#/components/schemas/CreateAccountHolderResponse'
description: OK - the request has succeeded.
@@ -469,7 +463,6 @@ paths:
summary: Delete bank accounts
description: 'Deletes bank accounts associated with an account holder. '
operationId: post-deleteBankAccounts
x-groupName: Verification
x-sortIndex: 4
x-methodName: deleteBankAccounts
security:
@@ -541,7 +534,6 @@ paths:
description: Deletes legal arrangements and/or legal arrangement entities associated
with an account holder.
operationId: post-deleteLegalArrangements
x-groupName: Verification
x-sortIndex: 6
x-methodName: deleteLegalArrangements
security:
@@ -624,7 +616,6 @@ paths:
description: Deletes payout methods associated with an account holder.
x-addedInVersion: '5'
operationId: post-deletePayoutMethods
x-groupName: Verification
x-sortIndex: 5
x-methodName: deletePayoutMethods
security:
@@ -695,7 +686,6 @@ paths:
summary: Delete shareholders
description: Deletes shareholders associated with an account holder.
operationId: post-deleteShareholders
x-groupName: Verification
x-sortIndex: 7
x-methodName: deleteShareholders
security:
@@ -766,7 +756,6 @@ paths:
summary: Delete signatories
description: Deletes signatories associated with an account holder.
operationId: post-deleteSignatories
x-groupName: Verification
x-sortIndex: 8
x-methodName: deleteSignatories
security:
@@ -834,7 +823,6 @@ paths:
summary: Get an account holder
description: Returns the details of an account holder.
operationId: post-getAccountHolder
x-groupName: Account holders
x-sortIndex: 2
x-methodName: getAccountHolder
security:
@@ -908,7 +896,6 @@ paths:
description: Generates a tax form for account holders operating in the US. For
more information, refer to [Providing tax forms](https://docs.adyen.com/marketplaces-and-platforms/classic/tax-forms).
operationId: post-getTaxForm
x-groupName: Account holders
x-sortIndex: 8
x-methodName: getTaxForm
security:
@@ -975,7 +962,6 @@ paths:
'
operationId: post-getUploadedDocuments
x-groupName: Verification
x-sortIndex: 2
x-methodName: getUploadedDocuments
security:
@@ -1040,7 +1026,6 @@ paths:
description: Changes the [status of an account holder](https://docs.adyen.com/marketplaces-and-platforms/classic/account-holders-and-accounts#account-holder-statuses)
to **Suspended**.
operationId: post-suspendAccountHolder
x-groupName: Account holders
x-sortIndex: 5
x-methodName: suspendAccountHolder
security:
@@ -1117,7 +1102,6 @@ paths:
\ account holders if they do not have verification checks with a **FAILED**\
\ [`status`](https://docs.adyen.com/api-explorer/#/Account/latest/post/getAccountHolder__resParam_verification-accountHolder-checks-status)."
operationId: post-unSuspendAccountHolder
x-groupName: Account holders
x-sortIndex: 6
x-methodName: unSuspendAccountHolder
security:
@@ -1188,7 +1172,6 @@ paths:
summary: Update an account
description: Updates the description or payout schedule of an account.
operationId: post-updateAccount
x-groupName: Accounts
x-sortIndex: 2
x-methodName: updateAccount
security:
@@ -1272,7 +1255,6 @@ paths:
\ provide the bank account or shareholder details without a `bankAccountUUID`\
\ or a `shareholderCode`.\n\n"
operationId: post-updateAccountHolder
x-groupName: Account holders
x-sortIndex: 3
x-methodName: updateAccountHolder
security:
@@ -1296,6 +1278,15 @@ paths:
'200':
content:
application/json:
examples:
addShareholders:
$ref: '#/components/examples/post-updateAccountHolder-addShareholders-200'
bankAccountDetails:
$ref: '#/components/examples/post-updateAccountHolder-bankAccountDetails-200'
businessDetails:
$ref: '#/components/examples/post-updateAccountHolder-businessDetails-200'
general:
$ref: '#/components/examples/post-updateAccountHolder-general-200'
schema:
$ref: '#/components/schemas/UpdateAccountHolderResponse'
description: OK - the request has succeeded.
@@ -1350,7 +1341,6 @@ paths:
description: Disables or enables the processing or payout state of an account
holder.
operationId: post-updateAccountHolderState
x-groupName: Account holders
x-sortIndex: 4
x-methodName: updateAccountHolderState
security:
@@ -1422,7 +1412,6 @@ paths:
description: Uploads a document for an account holder. Adyen uses the documents
during the [verification process](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process).
operationId: post-uploadDocument
x-groupName: Verification
x-sortIndex: 1
x-methodName: uploadDocument
security:
@@ -2241,9 +2230,15 @@ components:
method code.
type: string
payoutSchedule:
description: 'The payout schedule of the prospective account.
description: 'The payout schedule for the account.
>Permitted values: `DEFAULT`, `HOLD`, `DAILY`, `WEEKLY`, `MONTHLY`.'
Possible values: `DEFAULT`, `DAILY`, `DAILY_US`, `DAILY_EU`, `DAILY_AU`,
`DAILY_SG`, `WEEKLY`, `WEEKLY_ON_TUE_FRI_MIDNIGHT`, `BIWEEKLY_ON_1ST_AND_15TH_AT_MIDNIGHT`,
`MONTHLY`, `HOLD`.
> `HOLD` prevents scheduled payouts, but you can still initiate payouts
manually.'
enum:
- BIWEEKLY_ON_1ST_AND_15TH_AT_MIDNIGHT
- DAILY
@@ -2264,13 +2259,16 @@ components:
payoutScheduleReason:
description: 'The reason for the payout schedule choice.
>Required if the payoutSchedule is `HOLD`.'
> This field is required when the `payoutSchedule` parameter is set to
`HOLD`.'
type: string
payoutSpeed:
x-addedInVersion: '5'
default: STANDARD
description: 'Speed with which payouts for this account are processed. Permitted
values: `STANDARD`, `SAME_DAY`.'
description: 'Speed at which payouts for this account are processed.
Possible values: `STANDARD` (default), `SAME_DAY`.'
enum:
- INSTANT
- SAME_DAY
@@ -2319,7 +2317,7 @@ components:
method code.
type: string
payoutSchedule:
description: The payout schedule of the account.
description: The details of the payout schedule added to the account.
$ref: '#/components/schemas/PayoutScheduleResponse'
payoutSpeed:
x-addedInVersion: '5'
@@ -2615,6 +2613,7 @@ components:
- legalBusinessName
- legalEntity
- legalEntityType
- linkedViasVirtualAccount
- logo
- merchantAccount
- merchantCategoryCode
@@ -3069,14 +3068,14 @@ components:
type: object
MigratedAccounts:
properties:
accountCode:
description: The unique identifier of the account of the migrated account
holder in the classic integration.
type: string
balanceAccountId:
description: The unique identifier of the account of the migrated account
holder in the balance platform.
type: string
virtualAccountCode:
description: The unique identifier of the account of the migrated account
holder in the classic integration.
type: string
type: object
MigratedShareholders:
properties:
@@ -3184,11 +3183,15 @@ components:
format: date-time
type: string
schedule:
description: 'The payout schedule of the account.
description: 'The payout schedule for the account.
Permitted values: `DEFAULT`, `DAILY`, `DAILY_US`, `DAILY_EU`, `DAILY_AU`,
Possible values: `DEFAULT`, `DAILY`, `DAILY_US`, `DAILY_EU`, `DAILY_AU`,
`DAILY_SG`, `WEEKLY`, `WEEKLY_ON_TUE_FRI_MIDNIGHT`, `BIWEEKLY_ON_1ST_AND_15TH_AT_MIDNIGHT`,
`MONTHLY`, `HOLD`.'
`MONTHLY`, `HOLD`.
> `HOLD` prevents scheduled payouts, but you can still initiate payouts
manually.'
enum:
- BIWEEKLY_ON_1ST_AND_15TH_AT_MIDNIGHT
- DAILY
@@ -3488,9 +3491,11 @@ components:
type: string
storeName:
description: "The name of the account holder's store. This value is shown\
\ in shopper statements.\n\n* Length: Between 3 to 22 characters \n\n\
* The following characters are *not* supported: **:;}{$#@!|<>%^*+=\\\\\
**"
\ in shopper statements.\n\n * Length: Between 3 to 22 characters \n\n\
\ * The following characters are *not* supported: **:;}{$#@!|<>%^*+=\\\
\\**\n\n**Note:** storeName does not appear in American Express shopper\
\ statements by default. Contact Adyen Support to enable this for American\
\ Express."
type: string
storeReference:
description: "Your unique identifier for the store. The Customer Area also\
@@ -3777,13 +3782,15 @@ components:
method code.
type: string
payoutSchedule:
description: The details of the payout schedule, to which the account should
description: The details of the payout schedule to which the account must
be updated.
$ref: '#/components/schemas/UpdatePayoutScheduleRequest'
payoutSpeed:
x-addedInVersion: '5'
description: 'Speed with which payouts for this account are processed. Permitted
values: `STANDARD`, `SAME_DAY`.'
description: 'Speed at which payouts for this account are processed.
Possible values: `STANDARD` (default), `SAME_DAY`.'
enum:
- INSTANT
- SAME_DAY
@@ -3829,12 +3836,15 @@ components:
method code.
type: string
payoutSchedule:
description: The payout schedule of the account.
description: The details of the payout schedule to which the account is
updated.
$ref: '#/components/schemas/PayoutScheduleResponse'
payoutSpeed:
x-addedInVersion: '5'
description: 'Speed with which payouts for this account are processed. Permitted
values: `STANDARD`, `SAME_DAY`.'
description: 'Speed at which payouts for this account are processed.
Possible values: `STANDARD`, `SAME_DAY`.'
enum:
- INSTANT
- SAME_DAY
@@ -3856,13 +3866,14 @@ components:
description: 'Direction on how to handle any payouts that have already been
scheduled.
Permitted values:
* `CLOSE` will close the existing batch of payouts.
Possible values:
* `UPDATE` will reschedule the existing batch to the new schedule.
* `CLOSE`: close the existing batch of payouts.
* `NOTHING` (**default**) will allow the payout to proceed.'
* `UPDATE`: reschedule the existing batch to the new schedule.
* `NOTHING` (**default**): allow the payout to proceed.'
enum:
- CLOSE
- NOTHING
@@ -3874,14 +3885,15 @@ components:
> This field is required when the `schedule` parameter is set to `HOLD`.'
type: string
schedule:
description: 'The payout schedule to which the account is to be updated.
description: 'The new payout schedule for the account.
Permitted values: `DAILY`, `DAILY_US`, `DAILY_EU`, `DAILY_AU`, `DAILY_SG`,
`WEEKLY`, `WEEKLY_ON_TUE_FRI_MIDNIGHT`, `BIWEEKLY_ON_1ST_AND_15TH_AT_MIDNIGHT`,
Possible values: `DEFAULT`, `DAILY`, `DAILY_US`, `DAILY_EU`, `DAILY_AU`,
`DAILY_SG`, `WEEKLY`, `WEEKLY_ON_TUE_FRI_MIDNIGHT`, `BIWEEKLY_ON_1ST_AND_15TH_AT_MIDNIGHT`,
`MONTHLY`, `HOLD`.
`HOLD` will prevent scheduled payouts from happening but will still allow
manual payouts to occur.'
> `HOLD` prevents scheduled payouts, but you can still initiate payouts
manually.'
enum:
- BIWEEKLY_ON_1ST_AND_15TH_AT_MIDNIGHT
- DAILY
@@ -4047,7 +4059,7 @@ components:
message: 'Unexpected input: I'
errorType: validation
generic-403:
summary: Response code 401. Forbidden.
summary: Response code 403. Forbidden.
value:
status: 403
errorCode: '10_003'
@@ -4072,7 +4084,7 @@ components:
value:
accountHolderCode: CODE_OF_ACCOUNT_HOLDER
post-createAccountHolder-business:
summary: Create a business account holder
summary: Create business account holder
value:
accountHolderCode: YOUR_UNIQUE_ACCOUNT_HOLDER_CODE
accountHolderDetails:
@@ -4082,7 +4094,8 @@ components:
doingBusinessAs: Real Good Restaurant
legalBusinessName: Real Good Restaurant Inc.
shareholders:
- name:
- shareholderType: Controller
name:
firstName: John
lastName: Carpenter
address:
@@ -4091,10 +4104,57 @@ components:
email: test@email.com
webAddress: https://www.your-website.com
legalEntity: Business
post-createAccountHolder-individual:
summary: Create an individual account holder
post-createAccountHolder-business-200:
summary: Business account holder created
value:
accountHolderCode: GENERATE_CODE
pspReference: ALPHANUMERIC_UNIQUE_RESPONSE_REFERENCE
accountHolderCode: YOUR_UNIQUE_ACCOUNT_HOLDER_CODE
accountHolderDetails:
address:
country: US
bankAccountDetails: []
businessDetails:
doingBusinessAs: Real Good Restaurant
legalBusinessName: Real Good Restaurant Inc.
shareholders:
- address:
country: NL
email: testshareholder@email.com
name:
firstName: John
lastName: Carpenter
shareholderCode: SHAREHOLDER_CODE
shareholderType: Controller
email: test@email.com
merchantCategoryCode: MCC_DEFAULT_VALUE
payoutMethods: []
webAddress: https://www.your-website.com
accountHolderStatus:
status: Active
processingState:
disabled: false
processedFrom:
currency: USD
value: 0
processedTo:
currency: USD
value: 0
tierNumber: 0
payoutState:
allowPayout: true
payoutLimit:
currency: USD
value: 0
disabled: false
tierNumber: 0
events: []
legalEntity: Business
invalidFields: []
verification: {}
post-createAccountHolder-individual:
summary: Create individual account holder
value:
accountHolderCode: YOUR_UNIQUE_ACCOUNT_HOLDER_CODE
accountHolderDetails:
email: tim@green.com
individualDetails:
@@ -4105,6 +4165,45 @@ components:
country: US
webAddress: https://www.your-website.com
legalEntity: Individual
post-createAccountHolder-individual-200:
summary: Individual account holder created
value:
pspReference: ALPHANUMERIC_UNIQUE_RESPONSE_REFERENCE
accountHolderCode: YOUR_UNIQUE_ACCOUNT_HOLDER_CODE
accountHolderDetails:
address:
country: US
bankAccountDetails: []
email: tim@green.com
individualDetails:
name:
firstName: Tim
lastName: Green
merchantCategoryCode: '5045'
payoutMethods: []
webAddress: https://www.your-website.com
accountHolderStatus:
status: Active
processingState:
disabled: false
processedFrom:
currency: USD
value: 0
processedTo:
currency: USD
value: 0
tierNumber: 0
payoutState:
allowPayout: true
payoutLimit:
currency: USD
value: 0
disabled: false
tierNumber: 0
events: []
legalEntity: Individual
invalidFields: []
verification: {}
post-deleteBankAccounts-basic:
summary: Delete bank accounts
value:
@@ -4212,9 +4311,10 @@ components:
accountHolderDetails:
businessDetails:
shareholders:
- name:
firstName: Alice
lastName: Fields
- shareholderType: Controller
name:
firstName: Shelly
lastName: Eller
address:
city: San Francisco
country: US
@@ -4232,10 +4332,42 @@ components:
email: test@email.com
fullPhoneNumber: '+14154890281'
webAddress: http://www.accountholderwebsite.com
post-updateAccountHolder-addShareholders-200:
summary: Shareholders added
value:
invalidFields: []
pspReference: ALPHANUMERIC_UNIQUE_RESPONSE_REFERENCE
accountHolderCode: YOUR_UNIQUE_ACCOUNT_HOLDER_CODE
accountHolderDetails:
bankAccountDetails: []
businessDetails:
shareholders:
- address:
city: San Francisco
country: US
houseNumberOrName: '274'
postalCode: '94107'
stateOrProvince: CA
street: Brannan
email: testshareholder2@email.com
name:
firstName: Shelly
lastName: Eller
personalData:
dateOfBirth: '1970-01-01'
documentData:
- number: '1234567890'
type: ID
shareholderCode: SHAREHOLDER_CODE
shareholderType: Controller
taxId: '123456789'
email: test@email.com
payoutMethods: []
webAddress: http://www.accountholderwebsite.com
post-updateAccountHolder-bankAccountDetails:
summary: Update bank account details
value:
accountHolderCode: CODE_OF_ACCOUNT_HOLDER
accountHolderCode: YOUR_UNIQUE_ACCOUNT_HOLDER_CODE
accountHolderDetails:
email: tim@green.com
individualDetails:
@@ -4254,11 +4386,96 @@ components:
ownerCity: Springfield
ownerState: AZ
ownerCountryCode: US
post-updateAccountHolder-bankAccountDetails-200:
summary: Bank account details updated
value:
invalidFields: []
pspReference: ALPHANUMERIC_UNIQUE_RESPONSE_REFERENCE
accountHolderCode: YOUR_UNIQUE_ACCOUNT_HOLDER_CODE
accountHolderDetails:
address:
country: US
bankAccountDetails:
- accountNumber: '######6852'
bankAccountUUID: BANK_ACCOUNT_UUID
branchCode: '053101273'
countryCode: US
currencyCode: USD
ownerCity: Springfield
ownerCountryCode: US
ownerHouseNumberOrName: '100'
ownerName: Tim Green
ownerPostalCode: 02894
ownerState: AZ
ownerStreet: Main Street
primaryAccount: false
businessDetails:
doingBusinessAs: Real Good Restaurant
legalBusinessName: Real Good Restaurant Inc.
shareholders:
- address:
country: NL
email: testshareholder@email.com
name:
firstName: John
lastName: Carpenter
shareholderCode: SHAREHOLDER_CODE
shareholderType: Controller
email: tim@green.com
merchantCategoryCode: MCC_DEFAULT_VALUE
payoutMethods: []
webAddress: https://www.your-website.com
accountHolderStatus:
status: Active
processingState:
disabled: false
processedFrom:
currency: USD
value: 0
processedTo:
currency: USD
value: 0
tierNumber: 0
payoutState:
allowPayout: true
payoutLimit:
currency: USD
value: 0
disabled: false
tierNumber: 0
legalEntity: Business
verification: {}
post-updateAccountHolder-businessDetails:
summary: Update business details
value:
accountHolderCode: CODE_OF_ACCOUNT_HOLDER
accountHolderCode: YOUR_UNIQUE_ACCOUNT_HOLDER_CODE
accountHolderDetails:
businessDetails:
shareholders:
- shareholderType: Owner
address:
city: Amsterdam
country: NL
houseNumberOrName: '1'
postalCode: 1111AA
stateOrProvince: NH
street: Main Street
email: testshareholder2@email.com
name:
firstName: Shelly
lastName: Eller
taxId: BV123456789
email: test@email.com
fullPhoneNumber: '+31612345678'
webAddress: http://www.accountholderwebsite.com
post-updateAccountHolder-businessDetails-200:
summary: Business details updated
value:
invalidFields: []
pspReference: ALPHANUMERIC_UNIQUE_RESPONSE_REFERENCE
accountHolderCode: YOUR_UNIQUE_ACCOUNT_HOLDER_CODE
accountHolderDetails:
bankAccountDetails: []
businessDetails:
shareholders:
- address:
@@ -4267,41 +4484,88 @@ components:
houseNumberOrName: '1'
postalCode: 1111AA
stateOrProvince: NH
street: Awesome St
street: Main Street
email: testshareholder2@email.com
name:
firstName: Alice
lastName: Fields
firstName: Shelly
lastName: Eller
shareholderCode: SHAREHOLDER_CODE
shareholderType: Owner
taxId: BV123456789
email: test@email.com
fullPhoneNumber: '+31612345678'
payoutMethods: []
webAddress: http://www.accountholderwebsite.com
post-updateAccountHolder-general:
summary: Update account holder details
summary: Update individual with documentData property
value:
accountHolderCode: CODE_OF_ACCOUNT_HOLDER
accountHolderCode: YOUR_UNIQUE_ACCOUNT_HOLDER_CODE
accountHolderDetails:
address:
city: NY
country: US
postalCode: '12345'
stateOrProvince: NH
street: Teststreet 1
street: Main Street
houseNumberOrName: '100'
email: test@adyen.com
individualDetails:
name:
firstName: Simon
lastName: Hopper
personalData:
dateOfBirth: '1970-01-01'
documentData:
- number: '1234567890'
type: ID
nationality: NL
merchantCategoryCode: '7999'
fullPhoneNumber: '+31612345678'
webAddress: http://www.accountholderwebsite.com
post-updateAccountHolder-general-200:
summary: Individual updated with documentData property
value:
invalidFields: []
pspReference: ALPHANUMERIC_UNIQUE_RESPONSE_REFERENCE
accountHolderCode: YOUR_UNIQUE_ACCOUNT_HOLDER_CODE
accountHolderDetails:
address:
city: NY
country: US
houseNumberOrName: '100'
postalCode: '12345'
stateOrProvince: NH
street: Main Street
bankAccountDetails: []
businessDetails:
doingBusinessAs: Real Good Restaurant
legalBusinessName: Real Good Restaurant Inc.
shareholders:
- address:
country: NL
email: testshareholder@email.com
name:
firstName: John
lastName: Carpenter
shareholderCode: SHAREHOLDER_CODE
shareholderType: Controller
email: test@adyen.com
merchantCategoryCode: UPDATE_MCC
payoutMethods: []
phoneNumber:
phoneCountryCode: NL
phoneNumber: '612345678'
phoneType: Landline
webAddress: http://www.accountholderwebsite.com
accountHolderStatus:
status: Active
processingState:
disabled: false
processedFrom:
currency: USD
value: 0
processedTo:
currency: USD
value: 0
tierNumber: 0
payoutState:
allowPayout: true
payoutLimit:
currency: USD
value: 0
disabled: false
tierNumber: 0
legalEntity: Business
verification: {}
post-updateAccountHolderState-basic:
summary: Update account holder state
value:

434
yaml/AccountService-v6.yaml
View File

@@ -24,19 +24,14 @@ 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: '2023-05-30T15:27:20Z'
termsOfService: https://www.adyen.com/legal/terms-and-conditions
contact:
name: Adyen Developer Experience team
url: https://github.com/Adyen/adyen-openapi
x-groups:
- Account holders
- Accounts
- Verification
tags:
- name: Account holders
- name: Verification
- name: Accounts
- name: Verification
paths:
/checkAccountHolder:
post:
@@ -47,7 +42,6 @@ paths:
are not yet required for the volume that they are currently processing.
x-addedInVersion: '5'
operationId: post-checkAccountHolder
x-groupName: Verification
x-sortIndex: 3
x-methodName: checkAccountHolder
security:
@@ -120,7 +114,6 @@ paths:
transactions, pay out its funds, or reopen it. If payments are made to a closed
account, the payments are sent to your liable account.
operationId: post-closeAccount
x-groupName: Accounts
x-sortIndex: 3
x-methodName: closeAccount
security:
@@ -195,7 +188,6 @@ paths:
an account of an account holder with a **Closed** [`status`](https://docs.adyen.com/api-explorer/#/Account/latest/post/getAccountHolder__resParam_verification-accountHolder-checks-status),
the payments are sent to your liable account.
operationId: post-closeAccountHolder
x-groupName: Account holders
x-sortIndex: 7
x-methodName: closeAccountHolder
security:
@@ -267,7 +259,6 @@ paths:
description: Closes stores associated with an account holder.
x-addedInVersion: '5'
operationId: post-closeStores
x-groupName: Account holders
x-sortIndex: 9
x-methodName: closeStores
security:
@@ -329,7 +320,6 @@ paths:
description: Creates an account under an account holder. An account holder can
have [multiple accounts](https://docs.adyen.com/marketplaces-and-platforms/classic/account-holders-and-accounts#create-additional-accounts).
operationId: post-createAccount
x-groupName: Accounts
x-sortIndex: 1
x-methodName: createAccount
security:
@@ -403,7 +393,6 @@ paths:
on the sub-merchant's legal entity type. For more information, refer to [Account
holder and accounts](https://docs.adyen.com/marketplaces-and-platforms/classic/account-holders-and-accounts#legal-entity-types).
operationId: post-createAccountHolder
x-groupName: Account holders
x-sortIndex: 1
x-methodName: createAccountHolder
security:
@@ -423,6 +412,11 @@ paths:
'200':
content:
application/json:
examples:
business:
$ref: '#/components/examples/post-createAccountHolder-business-200'
individual:
$ref: '#/components/examples/post-createAccountHolder-individual-200'
schema:
$ref: '#/components/schemas/CreateAccountHolderResponse'
description: OK - the request has succeeded.
@@ -469,7 +463,6 @@ paths:
summary: Delete bank accounts
description: 'Deletes bank accounts associated with an account holder. '
operationId: post-deleteBankAccounts
x-groupName: Verification
x-sortIndex: 4
x-methodName: deleteBankAccounts
security:
@@ -541,7 +534,6 @@ paths:
description: Deletes legal arrangements and/or legal arrangement entities associated
with an account holder.
operationId: post-deleteLegalArrangements
x-groupName: Verification
x-sortIndex: 6
x-methodName: deleteLegalArrangements
security:
@@ -624,7 +616,6 @@ paths:
description: Deletes payout methods associated with an account holder.
x-addedInVersion: '5'
operationId: post-deletePayoutMethods
x-groupName: Verification
x-sortIndex: 5
x-methodName: deletePayoutMethods
security:
@@ -695,7 +686,6 @@ paths:
summary: Delete shareholders
description: Deletes shareholders associated with an account holder.
operationId: post-deleteShareholders
x-groupName: Verification
x-sortIndex: 7
x-methodName: deleteShareholders
security:
@@ -766,7 +756,6 @@ paths:
summary: Delete signatories
description: Deletes signatories associated with an account holder.
operationId: post-deleteSignatories
x-groupName: Verification
x-sortIndex: 8
x-methodName: deleteSignatories
security:
@@ -834,7 +823,6 @@ paths:
summary: Get an account holder
description: Returns the details of an account holder.
operationId: post-getAccountHolder
x-groupName: Account holders
x-sortIndex: 2
x-methodName: getAccountHolder
security:
@@ -908,7 +896,6 @@ paths:
description: Generates a tax form for account holders operating in the US. For
more information, refer to [Providing tax forms](https://docs.adyen.com/marketplaces-and-platforms/classic/tax-forms).
operationId: post-getTaxForm
x-groupName: Account holders
x-sortIndex: 8
x-methodName: getTaxForm
security:
@@ -975,7 +962,6 @@ paths:
'
operationId: post-getUploadedDocuments
x-groupName: Verification
x-sortIndex: 2
x-methodName: getUploadedDocuments
security:
@@ -1040,7 +1026,6 @@ paths:
description: Changes the [status of an account holder](https://docs.adyen.com/marketplaces-and-platforms/classic/account-holders-and-accounts#account-holder-statuses)
to **Suspended**.
operationId: post-suspendAccountHolder
x-groupName: Account holders
x-sortIndex: 5
x-methodName: suspendAccountHolder
security:
@@ -1117,7 +1102,6 @@ paths:
\ account holders if they do not have verification checks with a **FAILED**\
\ [`status`](https://docs.adyen.com/api-explorer/#/Account/latest/post/getAccountHolder__resParam_verification-accountHolder-checks-status)."
operationId: post-unSuspendAccountHolder
x-groupName: Account holders
x-sortIndex: 6
x-methodName: unSuspendAccountHolder
security:
@@ -1188,7 +1172,6 @@ paths:
summary: Update an account
description: Updates the description or payout schedule of an account.
operationId: post-updateAccount
x-groupName: Accounts
x-sortIndex: 2
x-methodName: updateAccount
security:
@@ -1272,7 +1255,6 @@ paths:
\ provide the bank account or shareholder details without a `bankAccountUUID`\
\ or a `shareholderCode`.\n\n"
operationId: post-updateAccountHolder
x-groupName: Account holders
x-sortIndex: 3
x-methodName: updateAccountHolder
security:
@@ -1296,6 +1278,15 @@ paths:
'200':
content:
application/json:
examples:
addShareholders:
$ref: '#/components/examples/post-updateAccountHolder-addShareholders-200'
bankAccountDetails:
$ref: '#/components/examples/post-updateAccountHolder-bankAccountDetails-200'
businessDetails:
$ref: '#/components/examples/post-updateAccountHolder-businessDetails-200'
general:
$ref: '#/components/examples/post-updateAccountHolder-general-200'
schema:
$ref: '#/components/schemas/UpdateAccountHolderResponse'
description: OK - the request has succeeded.
@@ -1350,7 +1341,6 @@ paths:
description: Disables or enables the processing or payout state of an account
holder.
operationId: post-updateAccountHolderState
x-groupName: Account holders
x-sortIndex: 4
x-methodName: updateAccountHolderState
security:
@@ -1422,7 +1412,6 @@ paths:
description: Uploads a document for an account holder. Adyen uses the documents
during the [verification process](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process).
operationId: post-uploadDocument
x-groupName: Verification
x-sortIndex: 1
x-methodName: uploadDocument
security:
@@ -2272,9 +2261,15 @@ components:
method code.
type: string
payoutSchedule:
description: 'The payout schedule of the prospective account.
description: 'The payout schedule for the account.
>Permitted values: `DEFAULT`, `HOLD`, `DAILY`, `WEEKLY`, `MONTHLY`.'
Possible values: `DEFAULT`, `DAILY`, `DAILY_US`, `DAILY_EU`, `DAILY_AU`,
`DAILY_SG`, `WEEKLY`, `WEEKLY_ON_TUE_FRI_MIDNIGHT`, `BIWEEKLY_ON_1ST_AND_15TH_AT_MIDNIGHT`,
`MONTHLY`, `HOLD`.
> `HOLD` prevents scheduled payouts, but you can still initiate payouts
manually.'
enum:
- BIWEEKLY_ON_1ST_AND_15TH_AT_MIDNIGHT
- DAILY
@@ -2295,13 +2290,16 @@ components:
payoutScheduleReason:
description: 'The reason for the payout schedule choice.
>Required if the payoutSchedule is `HOLD`.'
> This field is required when the `payoutSchedule` parameter is set to
`HOLD`.'
type: string
payoutSpeed:
x-addedInVersion: '5'
default: STANDARD
description: 'Speed with which payouts for this account are processed. Permitted
values: `STANDARD`, `SAME_DAY`.'
description: 'Speed at which payouts for this account are processed.
Possible values: `STANDARD` (default), `SAME_DAY`.'
enum:
- INSTANT
- SAME_DAY
@@ -2350,7 +2348,7 @@ components:
method code.
type: string
payoutSchedule:
description: The payout schedule of the account.
description: The details of the payout schedule added to the account.
$ref: '#/components/schemas/PayoutScheduleResponse'
payoutSpeed:
x-addedInVersion: '5'
@@ -2657,6 +2655,7 @@ components:
- legalBusinessName
- legalEntity
- legalEntityType
- linkedViasVirtualAccount
- logo
- merchantAccount
- merchantCategoryCode
@@ -3334,14 +3333,14 @@ components:
type: object
MigratedAccounts:
properties:
accountCode:
description: The unique identifier of the account of the migrated account
holder in the classic integration.
type: string
balanceAccountId:
description: The unique identifier of the account of the migrated account
holder in the balance platform.
type: string
virtualAccountCode:
description: The unique identifier of the account of the migrated account
holder in the classic integration.
type: string
type: object
MigratedShareholders:
properties:
@@ -3449,11 +3448,15 @@ components:
format: date-time
type: string
schedule:
description: 'The payout schedule of the account.
description: 'The payout schedule for the account.
Permitted values: `DEFAULT`, `DAILY`, `DAILY_US`, `DAILY_EU`, `DAILY_AU`,
Possible values: `DEFAULT`, `DAILY`, `DAILY_US`, `DAILY_EU`, `DAILY_AU`,
`DAILY_SG`, `WEEKLY`, `WEEKLY_ON_TUE_FRI_MIDNIGHT`, `BIWEEKLY_ON_1ST_AND_15TH_AT_MIDNIGHT`,
`MONTHLY`, `HOLD`.'
`MONTHLY`, `HOLD`.
> `HOLD` prevents scheduled payouts, but you can still initiate payouts
manually.'
enum:
- BIWEEKLY_ON_1ST_AND_15TH_AT_MIDNIGHT
- DAILY
@@ -3753,9 +3756,11 @@ components:
type: string
storeName:
description: "The name of the account holder's store. This value is shown\
\ in shopper statements.\n\n* Length: Between 3 to 22 characters \n\n\
* The following characters are *not* supported: **:;}{$#@!|<>%^*+=\\\\\
**"
\ in shopper statements.\n\n * Length: Between 3 to 22 characters \n\n\
\ * The following characters are *not* supported: **:;}{$#@!|<>%^*+=\\\
\\**\n\n**Note:** storeName does not appear in American Express shopper\
\ statements by default. Contact Adyen Support to enable this for American\
\ Express."
type: string
storeReference:
description: "Your unique identifier for the store. The Customer Area also\
@@ -4054,13 +4059,15 @@ components:
method code.
type: string
payoutSchedule:
description: The details of the payout schedule, to which the account should
description: The details of the payout schedule to which the account must
be updated.
$ref: '#/components/schemas/UpdatePayoutScheduleRequest'
payoutSpeed:
x-addedInVersion: '5'
description: 'Speed with which payouts for this account are processed. Permitted
values: `STANDARD`, `SAME_DAY`.'
description: 'Speed at which payouts for this account are processed.
Possible values: `STANDARD` (default), `SAME_DAY`.'
enum:
- INSTANT
- SAME_DAY
@@ -4106,12 +4113,15 @@ components:
method code.
type: string
payoutSchedule:
description: The payout schedule of the account.
description: The details of the payout schedule to which the account is
updated.
$ref: '#/components/schemas/PayoutScheduleResponse'
payoutSpeed:
x-addedInVersion: '5'
description: 'Speed with which payouts for this account are processed. Permitted
values: `STANDARD`, `SAME_DAY`.'
description: 'Speed at which payouts for this account are processed.
Possible values: `STANDARD`, `SAME_DAY`.'
enum:
- INSTANT
- SAME_DAY
@@ -4133,13 +4143,14 @@ components:
description: 'Direction on how to handle any payouts that have already been
scheduled.
Permitted values:
* `CLOSE` will close the existing batch of payouts.
Possible values:
* `UPDATE` will reschedule the existing batch to the new schedule.
* `CLOSE`: close the existing batch of payouts.
* `NOTHING` (**default**) will allow the payout to proceed.'
* `UPDATE`: reschedule the existing batch to the new schedule.
* `NOTHING` (**default**): allow the payout to proceed.'
enum:
- CLOSE
- NOTHING
@@ -4151,14 +4162,15 @@ components:
> This field is required when the `schedule` parameter is set to `HOLD`.'
type: string
schedule:
description: 'The payout schedule to which the account is to be updated.
description: 'The new payout schedule for the account.
Permitted values: `DAILY`, `DAILY_US`, `DAILY_EU`, `DAILY_AU`, `DAILY_SG`,
`WEEKLY`, `WEEKLY_ON_TUE_FRI_MIDNIGHT`, `BIWEEKLY_ON_1ST_AND_15TH_AT_MIDNIGHT`,
Possible values: `DEFAULT`, `DAILY`, `DAILY_US`, `DAILY_EU`, `DAILY_AU`,
`DAILY_SG`, `WEEKLY`, `WEEKLY_ON_TUE_FRI_MIDNIGHT`, `BIWEEKLY_ON_1ST_AND_15TH_AT_MIDNIGHT`,
`MONTHLY`, `HOLD`.
`HOLD` will prevent scheduled payouts from happening but will still allow
manual payouts to occur.'
> `HOLD` prevents scheduled payouts, but you can still initiate payouts
manually.'
enum:
- BIWEEKLY_ON_1ST_AND_15TH_AT_MIDNIGHT
- DAILY
@@ -4324,7 +4336,7 @@ components:
message: 'Unexpected input: I'
errorType: validation
generic-403:
summary: Response code 401. Forbidden.
summary: Response code 403. Forbidden.
value:
status: 403
errorCode: '10_003'
@@ -4349,7 +4361,7 @@ components:
value:
accountHolderCode: CODE_OF_ACCOUNT_HOLDER
post-createAccountHolder-business:
summary: Create a business account holder
summary: Create business account holder
value:
accountHolderCode: YOUR_UNIQUE_ACCOUNT_HOLDER_CODE
accountHolderDetails:
@@ -4359,7 +4371,8 @@ components:
doingBusinessAs: Real Good Restaurant
legalBusinessName: Real Good Restaurant Inc.
shareholders:
- name:
- shareholderType: Controller
name:
firstName: John
lastName: Carpenter
address:
@@ -4368,10 +4381,57 @@ components:
email: test@email.com
webAddress: https://www.your-website.com
legalEntity: Business
post-createAccountHolder-individual:
summary: Create an individual account holder
post-createAccountHolder-business-200:
summary: Business account holder created
value:
accountHolderCode: GENERATE_CODE
pspReference: ALPHANUMERIC_UNIQUE_RESPONSE_REFERENCE
accountHolderCode: YOUR_UNIQUE_ACCOUNT_HOLDER_CODE
accountHolderDetails:
address:
country: US
bankAccountDetails: []
businessDetails:
doingBusinessAs: Real Good Restaurant
legalBusinessName: Real Good Restaurant Inc.
shareholders:
- address:
country: NL
email: testshareholder@email.com
name:
firstName: John
lastName: Carpenter
shareholderCode: SHAREHOLDER_CODE
shareholderType: Controller
email: test@email.com
merchantCategoryCode: MCC_DEFAULT_VALUE
payoutMethods: []
webAddress: https://www.your-website.com
accountHolderStatus:
status: Active
processingState:
disabled: false
processedFrom:
currency: USD
value: 0
processedTo:
currency: USD
value: 0
tierNumber: 0
payoutState:
allowPayout: true
payoutLimit:
currency: USD
value: 0
disabled: false
tierNumber: 0
events: []
legalEntity: Business
invalidFields: []
verification: {}
post-createAccountHolder-individual:
summary: Create individual account holder
value:
accountHolderCode: YOUR_UNIQUE_ACCOUNT_HOLDER_CODE
accountHolderDetails:
email: tim@green.com
individualDetails:
@@ -4382,6 +4442,45 @@ components:
country: US
webAddress: https://www.your-website.com
legalEntity: Individual
post-createAccountHolder-individual-200:
summary: Individual account holder created
value:
pspReference: ALPHANUMERIC_UNIQUE_RESPONSE_REFERENCE
accountHolderCode: YOUR_UNIQUE_ACCOUNT_HOLDER_CODE
accountHolderDetails:
address:
country: US
bankAccountDetails: []
email: tim@green.com
individualDetails:
name:
firstName: Tim
lastName: Green
merchantCategoryCode: '5045'
payoutMethods: []
webAddress: https://www.your-website.com
accountHolderStatus:
status: Active
processingState:
disabled: false
processedFrom:
currency: USD
value: 0
processedTo:
currency: USD
value: 0
tierNumber: 0
payoutState:
allowPayout: true
payoutLimit:
currency: USD
value: 0
disabled: false
tierNumber: 0
events: []
legalEntity: Individual
invalidFields: []
verification: {}
post-deleteBankAccounts-basic:
summary: Delete bank accounts
value:
@@ -4489,9 +4588,10 @@ components:
accountHolderDetails:
businessDetails:
shareholders:
- name:
firstName: Alice
lastName: Fields
- shareholderType: Controller
name:
firstName: Shelly
lastName: Eller
address:
city: San Francisco
country: US
@@ -4509,10 +4609,42 @@ components:
email: test@email.com
fullPhoneNumber: '+14154890281'
webAddress: http://www.accountholderwebsite.com
post-updateAccountHolder-addShareholders-200:
summary: Shareholders added
value:
invalidFields: []
pspReference: ALPHANUMERIC_UNIQUE_RESPONSE_REFERENCE
accountHolderCode: YOUR_UNIQUE_ACCOUNT_HOLDER_CODE
accountHolderDetails:
bankAccountDetails: []
businessDetails:
shareholders:
- address:
city: San Francisco
country: US
houseNumberOrName: '274'
postalCode: '94107'
stateOrProvince: CA
street: Brannan
email: testshareholder2@email.com
name:
firstName: Shelly
lastName: Eller
personalData:
dateOfBirth: '1970-01-01'
documentData:
- number: '1234567890'
type: ID
shareholderCode: SHAREHOLDER_CODE
shareholderType: Controller
taxId: '123456789'
email: test@email.com
payoutMethods: []
webAddress: http://www.accountholderwebsite.com
post-updateAccountHolder-bankAccountDetails:
summary: Update bank account details
value:
accountHolderCode: CODE_OF_ACCOUNT_HOLDER
accountHolderCode: YOUR_UNIQUE_ACCOUNT_HOLDER_CODE
accountHolderDetails:
email: tim@green.com
individualDetails:
@@ -4531,11 +4663,96 @@ components:
ownerCity: Springfield
ownerState: AZ
ownerCountryCode: US
post-updateAccountHolder-bankAccountDetails-200:
summary: Bank account details updated
value:
invalidFields: []
pspReference: ALPHANUMERIC_UNIQUE_RESPONSE_REFERENCE
accountHolderCode: YOUR_UNIQUE_ACCOUNT_HOLDER_CODE
accountHolderDetails:
address:
country: US
bankAccountDetails:
- accountNumber: '######6852'
bankAccountUUID: BANK_ACCOUNT_UUID
branchCode: '053101273'
countryCode: US
currencyCode: USD
ownerCity: Springfield
ownerCountryCode: US
ownerHouseNumberOrName: '100'
ownerName: Tim Green
ownerPostalCode: 02894
ownerState: AZ
ownerStreet: Main Street
primaryAccount: false
businessDetails:
doingBusinessAs: Real Good Restaurant
legalBusinessName: Real Good Restaurant Inc.
shareholders:
- address:
country: NL
email: testshareholder@email.com
name:
firstName: John
lastName: Carpenter
shareholderCode: SHAREHOLDER_CODE
shareholderType: Controller
email: tim@green.com
merchantCategoryCode: MCC_DEFAULT_VALUE
payoutMethods: []
webAddress: https://www.your-website.com
accountHolderStatus:
status: Active
processingState:
disabled: false
processedFrom:
currency: USD
value: 0
processedTo:
currency: USD
value: 0
tierNumber: 0
payoutState:
allowPayout: true
payoutLimit:
currency: USD
value: 0
disabled: false
tierNumber: 0
legalEntity: Business
verification: {}
post-updateAccountHolder-businessDetails:
summary: Update business details
value:
accountHolderCode: CODE_OF_ACCOUNT_HOLDER
accountHolderCode: YOUR_UNIQUE_ACCOUNT_HOLDER_CODE
accountHolderDetails:
businessDetails:
shareholders:
- shareholderType: Owner
address:
city: Amsterdam
country: NL
houseNumberOrName: '1'
postalCode: 1111AA
stateOrProvince: NH
street: Main Street
email: testshareholder2@email.com
name:
firstName: Shelly
lastName: Eller
taxId: BV123456789
email: test@email.com
fullPhoneNumber: '+31612345678'
webAddress: http://www.accountholderwebsite.com
post-updateAccountHolder-businessDetails-200:
summary: Business details updated
value:
invalidFields: []
pspReference: ALPHANUMERIC_UNIQUE_RESPONSE_REFERENCE
accountHolderCode: YOUR_UNIQUE_ACCOUNT_HOLDER_CODE
accountHolderDetails:
bankAccountDetails: []
businessDetails:
shareholders:
- address:
@@ -4544,41 +4761,88 @@ components:
houseNumberOrName: '1'
postalCode: 1111AA
stateOrProvince: NH
street: Awesome St
street: Main Street
email: testshareholder2@email.com
name:
firstName: Alice
lastName: Fields
firstName: Shelly
lastName: Eller
shareholderCode: SHAREHOLDER_CODE
shareholderType: Owner
taxId: BV123456789
email: test@email.com
fullPhoneNumber: '+31612345678'
payoutMethods: []
webAddress: http://www.accountholderwebsite.com
post-updateAccountHolder-general:
summary: Update account holder details
summary: Update individual with documentData property
value:
accountHolderCode: CODE_OF_ACCOUNT_HOLDER
accountHolderCode: YOUR_UNIQUE_ACCOUNT_HOLDER_CODE
accountHolderDetails:
address:
city: NY
country: US
postalCode: '12345'
stateOrProvince: NH
street: Teststreet 1
street: Main Street
houseNumberOrName: '100'
email: test@adyen.com
individualDetails:
name:
firstName: Simon
lastName: Hopper
personalData:
dateOfBirth: '1970-01-01'
documentData:
- number: '1234567890'
type: ID
nationality: NL
merchantCategoryCode: '7999'
fullPhoneNumber: '+31612345678'
webAddress: http://www.accountholderwebsite.com
post-updateAccountHolder-general-200:
summary: Individual updated with documentData property
value:
invalidFields: []
pspReference: ALPHANUMERIC_UNIQUE_RESPONSE_REFERENCE
accountHolderCode: YOUR_UNIQUE_ACCOUNT_HOLDER_CODE
accountHolderDetails:
address:
city: NY
country: US
houseNumberOrName: '100'
postalCode: '12345'
stateOrProvince: NH
street: Main Street
bankAccountDetails: []
businessDetails:
doingBusinessAs: Real Good Restaurant
legalBusinessName: Real Good Restaurant Inc.
shareholders:
- address:
country: NL
email: testshareholder@email.com
name:
firstName: John
lastName: Carpenter
shareholderCode: SHAREHOLDER_CODE
shareholderType: Controller
email: test@adyen.com
merchantCategoryCode: UPDATE_MCC
payoutMethods: []
phoneNumber:
phoneCountryCode: NL
phoneNumber: '612345678'
phoneType: Landline
webAddress: http://www.accountholderwebsite.com
accountHolderStatus:
status: Active
processingState:
disabled: false
processedFrom:
currency: USD
value: 0
processedTo:
currency: USD
value: 0
tierNumber: 0
payoutState:
allowPayout: true
payoutLimit:
currency: USD
value: 0
disabled: false
tierNumber: 0
legalEntity: Business
verification: {}
post-updateAccountHolderState-basic:
summary: Update account holder state
value:

99
yaml/FundService-v3.yaml
View File

@@ -24,16 +24,13 @@ 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: '2023-05-30T15:27:19Z'
termsOfService: https://www.adyen.com/legal/terms-and-conditions
contact:
name: Adyen Developer Experience team
url: https://github.com/Adyen/adyen-openapi
x-groups:
- General
- Migration
tags:
- name: General
- name: Migration
paths:
/accountHolderBalance:
post:
@@ -44,7 +41,6 @@ paths:
balances are organized according by currencies. This mean that an account
may have multiple balances: one for each currency.'
operationId: post-accountHolderBalance
x-groupName: General
x-sortIndex: 1
x-methodName: accountHolderBalance
security:
@@ -114,7 +110,6 @@ paths:
Transactions are listed in chronological order, with the most recent transaction
first.
operationId: post-accountHolderTransactionList
x-groupName: General
x-sortIndex: 2
x-methodName: accountHolderTransactionList
security:
@@ -186,7 +181,6 @@ paths:
\ notification webhook.\n\n To learn more about direct debits, see [Top up\
\ accounts](https://docs.adyen.com/marketplaces-and-platforms/classic/top-up-accounts)."
operationId: post-debitAccountHolder
x-groupName: General
x-sortIndex: 8
x-methodName: debitAccountHolder
security:
@@ -255,7 +249,6 @@ paths:
description: Pays out a specified amount from an account to the bank account
of account holder.
operationId: post-payoutAccountHolder
x-groupName: General
x-sortIndex: 3
x-methodName: payoutAccountHolder
security:
@@ -321,7 +314,6 @@ paths:
description: 'Refunds funds transferred from one account to another. Both accounts
must be in the same platform, but can have different account holders. '
operationId: post-refundFundsTransfer
x-groupName: General
x-sortIndex: 5
x-methodName: refundFundsTransfer
security:
@@ -391,7 +383,6 @@ paths:
accounts remain in the accounts to which they were sent as designated by the
original payment's split details.
operationId: post-refundNotPaidOutTransfers
x-groupName: General
x-sortIndex: 7
x-methodName: refundNotPaidOutTransfers
security:
@@ -462,7 +453,6 @@ paths:
A series of benefactor/beneficiaries may not exceed four beneficiaries and
may not have a cycle in it.
operationId: post-setupBeneficiary
x-groupName: General
x-sortIndex: 6
x-methodName: setupBeneficiary
security:
@@ -530,7 +520,6 @@ paths:
transfer must include a transfer code, which should be determined by the platform,
in compliance with local regulations.
operationId: post-transferFunds
x-groupName: General
x-sortIndex: 4
x-methodName: transferFunds
security:
@@ -704,6 +693,7 @@ components:
items:
enum:
- BalanceNotPaidOutTransfer
- BalancePlatformFundTransfer
- BalancePlatformSweep
- BalancePlatformSweepReturned
- Chargeback
@@ -727,15 +717,19 @@ components:
- DebitedReversed
- DepositCorrectionCredited
- DepositCorrectionDebited
- DepositCorrectionReceived
- Fee
- FeeReceived
- FundTransfer
- FundTransferReversed
- InvoiceDeductionCredited
- InvoiceDeductionDebited
- InvoiceDeductionReceived
- ManualCorrected
- ManualCorrectionCredited
- ManualCorrectionDebited
- MerchantPayin
- MerchantPayinReceived
- MerchantPayinReversed
- Payout
- PayoutReversed
@@ -1316,70 +1310,86 @@ components:
Split:
properties:
account:
description: 'Unique identifier of the account where the split amount should
be sent. This is required if `type` is **MarketPlace** or **BalanceAccount**.
description: 'The unique identifier of the account to which the split amount
is booked. Required if `type` is **MarketPlace** or **BalanceAccount**.
'
* [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic):
The [`accountCode`](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccount#request-accountCode)
of the account to which the split amount is booked.
* [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms):
The [`balanceAccountId`](https://docs.adyen.com/api-explorer/balanceplatform/latest/get/balanceAccounts/_id_#path-id)
of the account to which the split amount is booked.'
type: string
amount:
description: The amount of this split.
description: 'The amount of the split item.
* Required for all split types in the [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic).
* Required if `type` is **BalanceAccount**, **Commission**, **Default**,
or **VAT** in your [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms)
integration.'
$ref: '#/components/schemas/SplitAmount'
description:
description: A description of this split.
description: Your description for the split item.
type: string
reference:
description: 'Your reference for the split, which you can use to link the
split to other operations such as captures and refunds.
description: 'Your unique reference for the split item.
This is required if `type` is **MarketPlace** or **BalanceAccount**. For
the other types, we also recommend sending a reference so you can reconcile
the split and the associated payment in the transaction overview and in
the reports. If the reference is not provided, the split is reported as
part of the aggregated [TransferBalance record type](https://docs.adyen.com/reporting/marketpay-payments-accounting-report)
in Adyen for Platforms.'
This is required if `type` is **MarketPlace** ([Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic))
or **BalanceAccount** ([Balance Platform](https://docs.adyen.com/marketplaces-and-platforms)).
For the other types, we also recommend providing a **unique** reference
so you can reconcile the split and the associated payment in the transaction
overview and in the reports.'
type: string
type:
description: 'The type of split.
description: 'The type of the split item.
Possible values: **Default**, **PaymentFee**, **VAT**, **Commission**,
**MarketPlace**, **BalanceAccount**, **Remainder**, **Surcharge**, **Tip**.'
Possible values:
* [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic):
**Commission**, **Default**, **Marketplace**, **PaymentFee**, **VAT**.
* [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms):
**BalanceAccount**, **Commission**, **Default**, **PaymentFee**, **Remainder**,
**Surcharge**, **Tip**, **VAT**.'
enum:
- AcquiringFees
- AdyenCommission
- AdyenFees
- AdyenMarkup
- BalanceAccount
- Commission
- Default
- Interchange
- MarketPlace
- PaymentFee
- PaymentFeeAcquiring
- PaymentFeeAdyen
- PaymentFeeAdyenCommission
- PaymentFeeAdyenMarkup
- PaymentFeeInterchange
- PaymentFeeSchemeFee
- Remainder
- SchemeFee
- Surcharge
- Tip
- VAT
- Verification
type: string
required:
- amount
- type
type: object
SplitAmount:
properties:
currency:
description: 'The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes).
If this value is not provided, the currency in which the payment is made
will be used.'
description: The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes).
By default, this is the original payment currency.
maxLength: 3
minLength: 3
type: string
value:
description: The amount in [minor units](https://docs.adyen.com/development-resources/currency-codes).
description: The value of the split amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).
format: int64
type: integer
required:
@@ -1444,6 +1454,7 @@ components:
`ManualCorrected`.'
enum:
- BalanceNotPaidOutTransfer
- BalancePlatformFundTransfer
- BalancePlatformSweep
- BalancePlatformSweepReturned
- Chargeback
@@ -1467,15 +1478,19 @@ components:
- DebitedReversed
- DepositCorrectionCredited
- DepositCorrectionDebited
- DepositCorrectionReceived
- Fee
- FeeReceived
- FundTransfer
- FundTransferReversed
- InvoiceDeductionCredited
- InvoiceDeductionDebited
- InvoiceDeductionReceived
- ManualCorrected
- ManualCorrectionCredited
- ManualCorrectionDebited
- MerchantPayin
- MerchantPayinReceived
- MerchantPayinReversed
- Payout
- PayoutReversed

100
yaml/FundService-v5.yaml
View File

@@ -24,16 +24,13 @@ 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: '2023-05-30T15:27:19Z'
termsOfService: https://www.adyen.com/legal/terms-and-conditions
contact:
name: Adyen Developer Experience team
url: https://github.com/Adyen/adyen-openapi
x-groups:
- General
- Migration
tags:
- name: General
- name: Migration
paths:
/accountHolderBalance:
post:
@@ -44,7 +41,6 @@ paths:
balances are organized according by currencies. This mean that an account
may have multiple balances: one for each currency.'
operationId: post-accountHolderBalance
x-groupName: General
x-sortIndex: 1
x-methodName: accountHolderBalance
security:
@@ -114,7 +110,6 @@ paths:
Transactions are listed in chronological order, with the most recent transaction
first.
operationId: post-accountHolderTransactionList
x-groupName: General
x-sortIndex: 2
x-methodName: accountHolderTransactionList
security:
@@ -186,7 +181,6 @@ paths:
\ notification webhook.\n\n To learn more about direct debits, see [Top up\
\ accounts](https://docs.adyen.com/marketplaces-and-platforms/classic/top-up-accounts)."
operationId: post-debitAccountHolder
x-groupName: General
x-sortIndex: 8
x-methodName: debitAccountHolder
security:
@@ -255,7 +249,6 @@ paths:
description: Pays out a specified amount from an account to the bank account
of account holder.
operationId: post-payoutAccountHolder
x-groupName: General
x-sortIndex: 3
x-methodName: payoutAccountHolder
security:
@@ -321,7 +314,6 @@ paths:
description: 'Refunds funds transferred from one account to another. Both accounts
must be in the same platform, but can have different account holders. '
operationId: post-refundFundsTransfer
x-groupName: General
x-sortIndex: 5
x-methodName: refundFundsTransfer
security:
@@ -391,7 +383,6 @@ paths:
accounts remain in the accounts to which they were sent as designated by the
original payment's split details.
operationId: post-refundNotPaidOutTransfers
x-groupName: General
x-sortIndex: 7
x-methodName: refundNotPaidOutTransfers
security:
@@ -462,7 +453,6 @@ paths:
A series of benefactor/beneficiaries may not exceed four beneficiaries and
may not have a cycle in it.
operationId: post-setupBeneficiary
x-groupName: General
x-sortIndex: 6
x-methodName: setupBeneficiary
security:
@@ -530,7 +520,6 @@ paths:
transfer must include a transfer code, which should be determined by the platform,
in compliance with local regulations.
operationId: post-transferFunds
x-groupName: General
x-sortIndex: 4
x-methodName: transferFunds
security:
@@ -696,6 +685,7 @@ components:
items:
enum:
- BalanceNotPaidOutTransfer
- BalancePlatformFundTransfer
- BalancePlatformSweep
- BalancePlatformSweepReturned
- Chargeback
@@ -719,15 +709,19 @@ components:
- DebitedReversed
- DepositCorrectionCredited
- DepositCorrectionDebited
- DepositCorrectionReceived
- Fee
- FeeReceived
- FundTransfer
- FundTransferReversed
- InvoiceDeductionCredited
- InvoiceDeductionDebited
- InvoiceDeductionReceived
- ManualCorrected
- ManualCorrectionCredited
- ManualCorrectionDebited
- MerchantPayin
- MerchantPayinReceived
- MerchantPayinReversed
- Payout
- PayoutReversed
@@ -1192,6 +1186,7 @@ components:
- legalBusinessName
- legalEntity
- legalEntityType
- linkedViasVirtualAccount
- logo
- merchantAccount
- merchantCategoryCode
@@ -1502,70 +1497,86 @@ components:
Split:
properties:
account:
description: 'Unique identifier of the account where the split amount should
be sent. This is required if `type` is **MarketPlace** or **BalanceAccount**.
description: 'The unique identifier of the account to which the split amount
is booked. Required if `type` is **MarketPlace** or **BalanceAccount**.
'
* [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic):
The [`accountCode`](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccount#request-accountCode)
of the account to which the split amount is booked.
* [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms):
The [`balanceAccountId`](https://docs.adyen.com/api-explorer/balanceplatform/latest/get/balanceAccounts/_id_#path-id)
of the account to which the split amount is booked.'
type: string
amount:
description: The amount of this split.
description: 'The amount of the split item.
* Required for all split types in the [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic).
* Required if `type` is **BalanceAccount**, **Commission**, **Default**,
or **VAT** in your [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms)
integration.'
$ref: '#/components/schemas/SplitAmount'
description:
description: A description of this split.
description: Your description for the split item.
type: string
reference:
description: 'Your reference for the split, which you can use to link the
split to other operations such as captures and refunds.
description: 'Your unique reference for the split item.
This is required if `type` is **MarketPlace** or **BalanceAccount**. For
the other types, we also recommend sending a reference so you can reconcile
the split and the associated payment in the transaction overview and in
the reports. If the reference is not provided, the split is reported as
part of the aggregated [TransferBalance record type](https://docs.adyen.com/reporting/marketpay-payments-accounting-report)
in Adyen for Platforms.'
This is required if `type` is **MarketPlace** ([Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic))
or **BalanceAccount** ([Balance Platform](https://docs.adyen.com/marketplaces-and-platforms)).
For the other types, we also recommend providing a **unique** reference
so you can reconcile the split and the associated payment in the transaction
overview and in the reports.'
type: string
type:
description: 'The type of split.
description: 'The type of the split item.
Possible values: **Default**, **PaymentFee**, **VAT**, **Commission**,
**MarketPlace**, **BalanceAccount**, **Remainder**, **Surcharge**, **Tip**.'
Possible values:
* [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic):
**Commission**, **Default**, **Marketplace**, **PaymentFee**, **VAT**.
* [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms):
**BalanceAccount**, **Commission**, **Default**, **PaymentFee**, **Remainder**,
**Surcharge**, **Tip**, **VAT**.'
enum:
- AcquiringFees
- AdyenCommission
- AdyenFees
- AdyenMarkup
- BalanceAccount
- Commission
- Default
- Interchange
- MarketPlace
- PaymentFee
- PaymentFeeAcquiring
- PaymentFeeAdyen
- PaymentFeeAdyenCommission
- PaymentFeeAdyenMarkup
- PaymentFeeInterchange
- PaymentFeeSchemeFee
- Remainder
- SchemeFee
- Surcharge
- Tip
- VAT
- Verification
type: string
required:
- amount
- type
type: object
SplitAmount:
properties:
currency:
description: 'The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes).
If this value is not provided, the currency in which the payment is made
will be used.'
description: The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes).
By default, this is the original payment currency.
maxLength: 3
minLength: 3
type: string
value:
description: The amount in [minor units](https://docs.adyen.com/development-resources/currency-codes).
description: The value of the split amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).
format: int64
type: integer
required:
@@ -1630,6 +1641,7 @@ components:
`ManualCorrected`.'
enum:
- BalanceNotPaidOutTransfer
- BalancePlatformFundTransfer
- BalancePlatformSweep
- BalancePlatformSweepReturned
- Chargeback
@@ -1653,15 +1665,19 @@ components:
- DebitedReversed
- DepositCorrectionCredited
- DepositCorrectionDebited
- DepositCorrectionReceived
- Fee
- FeeReceived
- FundTransfer
- FundTransferReversed
- InvoiceDeductionCredited
- InvoiceDeductionDebited
- InvoiceDeductionReceived
- ManualCorrected
- ManualCorrectionCredited
- ManualCorrectionDebited
- MerchantPayin
- MerchantPayinReceived
- MerchantPayinReversed
- Payout
- PayoutReversed

100
yaml/FundService-v6.yaml
View File

@@ -24,16 +24,13 @@ 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: '2023-05-30T15:27:19Z'
termsOfService: https://www.adyen.com/legal/terms-and-conditions
contact:
name: Adyen Developer Experience team
url: https://github.com/Adyen/adyen-openapi
x-groups:
- General
- Migration
tags:
- name: General
- name: Migration
paths:
/accountHolderBalance:
post:
@@ -44,7 +41,6 @@ paths:
balances are organized according by currencies. This mean that an account
may have multiple balances: one for each currency.'
operationId: post-accountHolderBalance
x-groupName: General
x-sortIndex: 1
x-methodName: accountHolderBalance
security:
@@ -114,7 +110,6 @@ paths:
Transactions are listed in chronological order, with the most recent transaction
first.
operationId: post-accountHolderTransactionList
x-groupName: General
x-sortIndex: 2
x-methodName: accountHolderTransactionList
security:
@@ -186,7 +181,6 @@ paths:
\ notification webhook.\n\n To learn more about direct debits, see [Top up\
\ accounts](https://docs.adyen.com/marketplaces-and-platforms/classic/top-up-accounts)."
operationId: post-debitAccountHolder
x-groupName: General
x-sortIndex: 8
x-methodName: debitAccountHolder
security:
@@ -255,7 +249,6 @@ paths:
description: Pays out a specified amount from an account to the bank account
of account holder.
operationId: post-payoutAccountHolder
x-groupName: General
x-sortIndex: 3
x-methodName: payoutAccountHolder
security:
@@ -321,7 +314,6 @@ paths:
description: 'Refunds funds transferred from one account to another. Both accounts
must be in the same platform, but can have different account holders. '
operationId: post-refundFundsTransfer
x-groupName: General
x-sortIndex: 5
x-methodName: refundFundsTransfer
security:
@@ -391,7 +383,6 @@ paths:
accounts remain in the accounts to which they were sent as designated by the
original payment's split details.
operationId: post-refundNotPaidOutTransfers
x-groupName: General
x-sortIndex: 7
x-methodName: refundNotPaidOutTransfers
security:
@@ -462,7 +453,6 @@ paths:
A series of benefactor/beneficiaries may not exceed four beneficiaries and
may not have a cycle in it.
operationId: post-setupBeneficiary
x-groupName: General
x-sortIndex: 6
x-methodName: setupBeneficiary
security:
@@ -530,7 +520,6 @@ paths:
transfer must include a transfer code, which should be determined by the platform,
in compliance with local regulations.
operationId: post-transferFunds
x-groupName: General
x-sortIndex: 4
x-methodName: transferFunds
security:
@@ -696,6 +685,7 @@ components:
items:
enum:
- BalanceNotPaidOutTransfer
- BalancePlatformFundTransfer
- BalancePlatformSweep
- BalancePlatformSweepReturned
- Chargeback
@@ -719,15 +709,19 @@ components:
- DebitedReversed
- DepositCorrectionCredited
- DepositCorrectionDebited
- DepositCorrectionReceived
- Fee
- FeeReceived
- FundTransfer
- FundTransferReversed
- InvoiceDeductionCredited
- InvoiceDeductionDebited
- InvoiceDeductionReceived
- ManualCorrected
- ManualCorrectionCredited
- ManualCorrectionDebited
- MerchantPayin
- MerchantPayinReceived
- MerchantPayinReversed
- Payout
- PayoutReversed
@@ -1192,6 +1186,7 @@ components:
- legalBusinessName
- legalEntity
- legalEntityType
- linkedViasVirtualAccount
- logo
- merchantAccount
- merchantCategoryCode
@@ -1502,70 +1497,86 @@ components:
Split:
properties:
account:
description: 'Unique identifier of the account where the split amount should
be sent. This is required if `type` is **MarketPlace** or **BalanceAccount**.
description: 'The unique identifier of the account to which the split amount
is booked. Required if `type` is **MarketPlace** or **BalanceAccount**.
'
* [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic):
The [`accountCode`](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccount#request-accountCode)
of the account to which the split amount is booked.
* [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms):
The [`balanceAccountId`](https://docs.adyen.com/api-explorer/balanceplatform/latest/get/balanceAccounts/_id_#path-id)
of the account to which the split amount is booked.'
type: string
amount:
description: The amount of this split.
description: 'The amount of the split item.
* Required for all split types in the [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic).
* Required if `type` is **BalanceAccount**, **Commission**, **Default**,
or **VAT** in your [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms)
integration.'
$ref: '#/components/schemas/SplitAmount'
description:
description: A description of this split.
description: Your description for the split item.
type: string
reference:
description: 'Your reference for the split, which you can use to link the
split to other operations such as captures and refunds.
description: 'Your unique reference for the split item.
This is required if `type` is **MarketPlace** or **BalanceAccount**. For
the other types, we also recommend sending a reference so you can reconcile
the split and the associated payment in the transaction overview and in
the reports. If the reference is not provided, the split is reported as
part of the aggregated [TransferBalance record type](https://docs.adyen.com/reporting/marketpay-payments-accounting-report)
in Adyen for Platforms.'
This is required if `type` is **MarketPlace** ([Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic))
or **BalanceAccount** ([Balance Platform](https://docs.adyen.com/marketplaces-and-platforms)).
For the other types, we also recommend providing a **unique** reference
so you can reconcile the split and the associated payment in the transaction
overview and in the reports.'
type: string
type:
description: 'The type of split.
description: 'The type of the split item.
Possible values: **Default**, **PaymentFee**, **VAT**, **Commission**,
**MarketPlace**, **BalanceAccount**, **Remainder**, **Surcharge**, **Tip**.'
Possible values:
* [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic):
**Commission**, **Default**, **Marketplace**, **PaymentFee**, **VAT**.
* [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms):
**BalanceAccount**, **Commission**, **Default**, **PaymentFee**, **Remainder**,
**Surcharge**, **Tip**, **VAT**.'
enum:
- AcquiringFees
- AdyenCommission
- AdyenFees
- AdyenMarkup
- BalanceAccount
- Commission
- Default
- Interchange
- MarketPlace
- PaymentFee
- PaymentFeeAcquiring
- PaymentFeeAdyen
- PaymentFeeAdyenCommission
- PaymentFeeAdyenMarkup
- PaymentFeeInterchange
- PaymentFeeSchemeFee
- Remainder
- SchemeFee
- Surcharge
- Tip
- VAT
- Verification
type: string
required:
- amount
- type
type: object
SplitAmount:
properties:
currency:
description: 'The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes).
If this value is not provided, the currency in which the payment is made
will be used.'
description: The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes).
By default, this is the original payment currency.
maxLength: 3
minLength: 3
type: string
value:
description: The amount in [minor units](https://docs.adyen.com/development-resources/currency-codes).
description: The value of the split amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).
format: int64
type: integer
required:
@@ -1630,6 +1641,7 @@ components:
`ManualCorrected`.'
enum:
- BalanceNotPaidOutTransfer
- BalancePlatformFundTransfer
- BalancePlatformSweep
- BalancePlatformSweepReturned
- Chargeback
@@ -1653,15 +1665,19 @@ components:
- DebitedReversed
- DepositCorrectionCredited
- DepositCorrectionDebited
- DepositCorrectionReceived
- Fee
- FeeReceived
- FundTransfer
- FundTransferReversed
- InvoiceDeductionCredited
- InvoiceDeductionDebited
- InvoiceDeductionReceived
- ManualCorrected
- ManualCorrectionCredited
- ManualCorrectionDebited
- MerchantPayin
- MerchantPayinReceived
- MerchantPayinReversed
- Payout
- PayoutReversed

15
yaml/HopService-v1.yaml
View File

@@ -23,14 +23,10 @@ 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/Hop/v1/getOnboardingUrl\n\
```"
x-timestamp: '2023-05-30T15:27:20Z'
termsOfService: https://www.adyen.com/legal/terms-and-conditions
contact:
name: Adyen Developer Experience team
url: https://github.com/Adyen/adyen-openapi
x-groups:
- Hosted Onboarding Page
- PCI Compliance Questionnaire Page
tags:
- name: Hosted Onboarding Page
- name: PCI Compliance Questionnaire Page
@@ -44,7 +40,6 @@ paths:
can send to your account holder. For more information on how to use HOP, refer
to [Hosted onboarding](https://docs.adyen.com/marketplaces-and-platforms/classic/collect-verification-details/hosted-onboarding-page). '
operationId: post-getOnboardingUrl
x-groupName: Hosted Onboarding Page
x-sortIndex: 1
x-methodName: getOnboardingUrl
security:
@@ -107,7 +102,6 @@ paths:
\ send to your account holder.\n > You should only use this endpoint if you\
\ have a [partner platform setup](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners)."
operationId: post-getPciQuestionnaireUrl
x-groupName: PCI Compliance Questionnaire Page
x-sortIndex: 1
x-methodName: getPciQuestionnaireUrl
security:
@@ -166,15 +160,15 @@ components:
CollectInformation:
properties:
bankDetails:
description: Indicates whether [bank account details](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-checks/bank-account-check)
description: Indicates whether [bank account details](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/accepted-data-format/#bank-accounts)
must be collected. Default is **true**.
type: boolean
businessDetails:
description: Indicates whether [business details](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-checks/company-check)
description: Indicates whether [business details](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/accepted-data-format/#organizations)
must be collected. Default is **true**.
type: boolean
individualDetails:
description: Indicates whether [individual details](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-checks/identity-check)
description: Indicates whether [individual details](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/accepted-data-format/#individuals)
must be collected. Default is **true**.
type: boolean
legalArrangementDetails:
@@ -186,7 +180,7 @@ components:
must be collected. Applies only to partner platforms. Default is **true**.
type: boolean
shareholderDetails:
description: Indicates whether [shareholder details](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-checks/identity-check)
description: Indicates whether [shareholder details](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/accepted-data-format/#individuals)
must be collected. Defaults to **true**.
type: boolean
type: object
@@ -294,6 +288,7 @@ components:
- legalBusinessName
- legalEntity
- legalEntityType
- linkedViasVirtualAccount
- logo
- merchantAccount
- merchantCategoryCode

15
yaml/HopService-v5.yaml
View File

@@ -23,14 +23,10 @@ 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/Hop/v5/getOnboardingUrl\n\
```"
x-timestamp: '2023-05-30T15:27:20Z'
termsOfService: https://www.adyen.com/legal/terms-and-conditions
contact:
name: Adyen Developer Experience team
url: https://github.com/Adyen/adyen-openapi
x-groups:
- Hosted Onboarding Page
- PCI Compliance Questionnaire Page
tags:
- name: Hosted Onboarding Page
- name: PCI Compliance Questionnaire Page
@@ -44,7 +40,6 @@ paths:
can send to your account holder. For more information on how to use HOP, refer
to [Hosted onboarding](https://docs.adyen.com/marketplaces-and-platforms/classic/collect-verification-details/hosted-onboarding-page). '
operationId: post-getOnboardingUrl
x-groupName: Hosted Onboarding Page
x-sortIndex: 1
x-methodName: getOnboardingUrl
security:
@@ -107,7 +102,6 @@ paths:
\ send to your account holder.\n > You should only use this endpoint if you\
\ have a [partner platform setup](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners)."
operationId: post-getPciQuestionnaireUrl
x-groupName: PCI Compliance Questionnaire Page
x-sortIndex: 1
x-methodName: getPciQuestionnaireUrl
security:
@@ -166,15 +160,15 @@ components:
CollectInformation:
properties:
bankDetails:
description: Indicates whether [bank account details](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-checks/bank-account-check)
description: Indicates whether [bank account details](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/accepted-data-format/#bank-accounts)
must be collected. Default is **true**.
type: boolean
businessDetails:
description: Indicates whether [business details](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-checks/company-check)
description: Indicates whether [business details](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/accepted-data-format/#organizations)
must be collected. Default is **true**.
type: boolean
individualDetails:
description: Indicates whether [individual details](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-checks/identity-check)
description: Indicates whether [individual details](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/accepted-data-format/#individuals)
must be collected. Default is **true**.
type: boolean
legalArrangementDetails:
@@ -186,7 +180,7 @@ components:
must be collected. Applies only to partner platforms. Default is **true**.
type: boolean
shareholderDetails:
description: Indicates whether [shareholder details](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-checks/identity-check)
description: Indicates whether [shareholder details](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/accepted-data-format/#individuals)
must be collected. Defaults to **true**.
type: boolean
type: object
@@ -293,6 +287,7 @@ components:
- legalBusinessName
- legalEntity
- legalEntityType
- linkedViasVirtualAccount
- logo
- merchantAccount
- merchantCategoryCode

15
yaml/HopService-v6.yaml
View File

@@ -23,14 +23,10 @@ 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/Hop/v6/getOnboardingUrl\n\
```"
x-timestamp: '2023-05-30T15:27:20Z'
termsOfService: https://www.adyen.com/legal/terms-and-conditions
contact:
name: Adyen Developer Experience team
url: https://github.com/Adyen/adyen-openapi
x-groups:
- Hosted Onboarding Page
- PCI Compliance Questionnaire Page
tags:
- name: Hosted Onboarding Page
- name: PCI Compliance Questionnaire Page
@@ -44,7 +40,6 @@ paths:
can send to your account holder. For more information on how to use HOP, refer
to [Hosted onboarding](https://docs.adyen.com/marketplaces-and-platforms/classic/collect-verification-details/hosted-onboarding-page). '
operationId: post-getOnboardingUrl
x-groupName: Hosted Onboarding Page
x-sortIndex: 1
x-methodName: getOnboardingUrl
security:
@@ -107,7 +102,6 @@ paths:
\ send to your account holder.\n > You should only use this endpoint if you\
\ have a [partner platform setup](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners)."
operationId: post-getPciQuestionnaireUrl
x-groupName: PCI Compliance Questionnaire Page
x-sortIndex: 1
x-methodName: getPciQuestionnaireUrl
security:
@@ -166,15 +160,15 @@ components:
CollectInformation:
properties:
bankDetails:
description: Indicates whether [bank account details](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-checks/bank-account-check)
description: Indicates whether [bank account details](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/accepted-data-format/#bank-accounts)
must be collected. Default is **true**.
type: boolean
businessDetails:
description: Indicates whether [business details](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-checks/company-check)
description: Indicates whether [business details](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/accepted-data-format/#organizations)
must be collected. Default is **true**.
type: boolean
individualDetails:
description: Indicates whether [individual details](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-checks/identity-check)
description: Indicates whether [individual details](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/accepted-data-format/#individuals)
must be collected. Default is **true**.
type: boolean
legalArrangementDetails:
@@ -186,7 +180,7 @@ components:
must be collected. Applies only to partner platforms. Default is **true**.
type: boolean
shareholderDetails:
description: Indicates whether [shareholder details](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-checks/identity-check)
description: Indicates whether [shareholder details](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/accepted-data-format/#individuals)
must be collected. Defaults to **true**.
type: boolean
type: object
@@ -293,6 +287,7 @@ components:
- legalBusinessName
- legalEntity
- legalEntityType
- linkedViasVirtualAccount
- logo
- merchantAccount
- merchantCategoryCode

195
yaml/MarketPayNotificationService-v3.yaml
View File

@@ -9,17 +9,15 @@ info:
\ 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: '2023-06-02T11:23:47Z'
termsOfService: https://www.adyen.com/legal/terms-and-conditions
contact:
name: Adyen Developer Experience team
url: https://github.com/Adyen/adyen-openapi
x-groups:
- Account holders
- Accounts
- Fund management
- Other
tags: []
tags:
- name: Account holders
- name: Accounts
- name: Fund management
- name: Other
x-staticResponse: response.json
webhooks:
/ACCOUNT_CLOSED:
@@ -29,7 +27,6 @@ webhooks:
summary: Account closed
description: Adyen sends this webhook when [an account is closed](https://docs.adyen.com/api-explorer/#/Account/latest/post/closeAccount).
operationId: post-ACCOUNT_CLOSED
x-groupName: Accounts
x-sortIndex: 3
x-methodName: accountClosed
security:
@@ -46,9 +43,6 @@ webhooks:
'200':
content:
application/json:
examples:
accountClosed:
$ref: '#/components/examples/WebhookAck'
schema:
$ref: '#/components/schemas/NotificationResponse'
description: OK - the request has succeeded.
@@ -59,7 +53,6 @@ webhooks:
summary: Account created
description: Adyen sends this webhook when [an account is created](https://docs.adyen.com/api-explorer/#/Account/latest/post/createAccount).
operationId: post-ACCOUNT_CREATED
x-groupName: Accounts
x-sortIndex: 1
x-methodName: accountCreated
security:
@@ -76,9 +69,6 @@ webhooks:
'200':
content:
application/json:
examples:
accountCreated:
$ref: '#/components/examples/WebhookAck'
schema:
$ref: '#/components/schemas/NotificationResponse'
description: OK - the request has succeeded.
@@ -90,7 +80,6 @@ webhooks:
description: Adyen sends this notification when the current funds of your liable
account are below the configured threshold.
operationId: post-ACCOUNT_FUNDS_BELOW_THRESHOLD
x-groupName: Fund management
x-sortIndex: 7
x-methodName: liableAccountsFundsAreBelowConfiguredThreshold
security:
@@ -114,7 +103,6 @@ webhooks:
summary: Account holder created
description: Adyen sends this webhook when [an account holder is created](https://docs.adyen.com/api-explorer/#/Account/latest/post/createAccountHolder).
operationId: post-ACCOUNT_HOLDER_CREATED
x-groupName: Account holders
x-sortIndex: 1
x-methodName: accountHolderCreated
security:
@@ -135,13 +123,6 @@ webhooks:
'200':
content:
application/json:
examples:
accountHolderCreated-businesses:
$ref: '#/components/examples/WebhookAck'
accountHolderCreated-failed:
$ref: '#/components/examples/WebhookAck'
accountHolderCreated-individuals:
$ref: '#/components/examples/WebhookAck'
schema:
$ref: '#/components/schemas/NotificationResponse'
description: OK - the request has succeeded.
@@ -153,7 +134,6 @@ webhooks:
description: Adyen sends this notification when a [payout request](https://docs.adyen.com/api-explorer/#/Fund/latest/post/payoutAccountHolder)
to an account holder is processed and the payout is scheduled.
operationId: post-ACCOUNT_HOLDER_PAYOUT
x-groupName: Fund management
x-sortIndex: 1
x-methodName: paidOutToAccountHolder
security:
@@ -172,11 +152,6 @@ webhooks:
'200':
content:
application/json:
examples:
accountHolderPayout-failed:
$ref: '#/components/examples/WebhookAck'
accountHolderPayout-initiated:
$ref: '#/components/examples/WebhookAck'
schema:
$ref: '#/components/schemas/NotificationResponse'
description: OK - the request has succeeded.
@@ -188,7 +163,6 @@ webhooks:
description: Adyen sends this webhook when [the status of an account holder
is changed](https://docs.adyen.com/api-explorer/#/Account/latest/post/updateAccountHolderState).
operationId: post-ACCOUNT_HOLDER_STATUS_CHANGE
x-groupName: Account holders
x-sortIndex: 4
x-methodName: accountHolderStatusChanged
security:
@@ -205,9 +179,6 @@ webhooks:
'200':
content:
application/json:
examples:
accountHolderStatusChange:
$ref: '#/components/examples/WebhookAck'
schema:
$ref: '#/components/schemas/NotificationResponse'
description: OK - the request has succeeded.
@@ -219,7 +190,6 @@ webhooks:
description: Adyen sends this webhook when [the status of a store](https://docs.adyen.com/api-explorer/#/Account/latest/post/createAccountHolder__reqParam_accountHolderDetails-storeDetails-status)
associated with an account holder is changed.
operationId: post-ACCOUNT_HOLDER_STORE_STATUS_CHANGE
x-groupName: Account holders
x-sortIndex: 4
x-methodName: storeStatusChanged
security:
@@ -236,9 +206,6 @@ webhooks:
'200':
content:
application/json:
examples:
accountHolderStoreStatusChange:
$ref: '#/components/examples/WebhookAck'
schema:
$ref: '#/components/schemas/NotificationResponse'
description: OK - the request has succeeded.
@@ -250,7 +217,6 @@ webhooks:
description: Adyen sends this notification when an account holder's deadline
to fulfill the requirements of a specific event is coming up.
operationId: post-ACCOUNT_HOLDER_UPCOMING_DEADLINE
x-groupName: Account holders
x-sortIndex: 1
x-methodName: upcomingDeadline
security:
@@ -274,7 +240,6 @@ webhooks:
summary: Account holder updated
description: Adyen sends this webhook when [an account holder is updated](https://docs.adyen.com/api-explorer/#/Account/latest/post/updateAccountHolder).
operationId: post-ACCOUNT_HOLDER_UPDATED
x-groupName: Account holders
x-sortIndex: 2
x-methodName: accountHolderUpdated
security:
@@ -291,9 +256,6 @@ webhooks:
'200':
content:
application/json:
examples:
accountHolderUpdated:
$ref: '#/components/examples/WebhookAck'
schema:
$ref: '#/components/schemas/NotificationResponse'
description: OK - the request has succeeded.
@@ -304,7 +266,6 @@ webhooks:
summary: Verification results received
description: Adyen sends this webhook when verification results are available.
operationId: post-ACCOUNT_HOLDER_VERIFICATION
x-groupName: Account holders
x-sortIndex: 3
x-methodName: verificationResultsReceived
security:
@@ -321,9 +282,6 @@ webhooks:
'200':
content:
application/json:
examples:
accountHolderVerification:
$ref: '#/components/examples/WebhookAck'
schema:
$ref: '#/components/schemas/NotificationResponse'
description: OK - the request has succeeded.
@@ -334,7 +292,6 @@ webhooks:
summary: Account updated
description: Adyen sends this webhook when [an account is updated](https://docs.adyen.com/api-explorer/#/Account/latest/post/updateAccount).
operationId: post-ACCOUNT_UPDATED
x-groupName: Accounts
x-sortIndex: 2
x-methodName: accountUpdated
security:
@@ -351,9 +308,6 @@ webhooks:
'200':
content:
application/json:
examples:
accountUpdated:
$ref: '#/components/examples/WebhookAck'
schema:
$ref: '#/components/schemas/NotificationResponse'
description: OK - the request has succeeded.
@@ -365,7 +319,6 @@ webhooks:
description: Adyen sends this notification when a [benefactor/beneficiary relationship
is created](https://docs.adyen.com/api-explorer/#/Fund/latest/post/transferFunds).
operationId: post-BENEFICIARY_SETUP
x-groupName: Fund management
x-sortIndex: 3
x-methodName: beneficiaryDefined
security:
@@ -382,9 +335,6 @@ webhooks:
'200':
content:
application/json:
examples:
beneficiarySetup:
$ref: '#/components/examples/WebhookAck'
schema:
$ref: '#/components/schemas/NotificationResponse'
description: OK - the request has succeeded.
@@ -396,7 +346,6 @@ webhooks:
description: Adyen sends this notification when funds are transferred from your
platform's liable account to an overdrawn account to compensate for the overdraft.
operationId: post-COMPENSATE_NEGATIVE_BALANCE
x-groupName: Fund management
x-sortIndex: 5
x-methodName: negativeAccountBalancesCompensated
security:
@@ -413,9 +362,6 @@ webhooks:
'200':
content:
application/json:
examples:
compensateNegativeBalance:
$ref: '#/components/examples/WebhookAck'
schema:
$ref: '#/components/schemas/NotificationResponse'
description: OK - the request has succeeded.
@@ -426,7 +372,6 @@ webhooks:
summary: Automated direct debit initiated
description: Adyen sends this notification when a [direct debit is initiated](https://docs.adyen.com/api-explorer/#/Fund/latest/post/debitAccountHolder).
operationId: post-DIRECT_DEBIT_INITIATED
x-groupName: Fund management
x-sortIndex: 7
x-methodName: automatedDirectDebitInitiated
security:
@@ -445,11 +390,6 @@ webhooks:
'200':
content:
application/json:
examples:
directDebitInitiated:
$ref: '#/components/examples/WebhookAck'
directDebitInitiated-failed:
$ref: '#/components/examples/WebhookAck'
schema:
$ref: '#/components/schemas/NotificationResponse'
description: OK - the request has succeeded.
@@ -464,7 +404,6 @@ webhooks:
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
x-methodName: bookingForCaptureOrRefundFailed
security:
@@ -481,9 +420,6 @@ webhooks:
'200':
content:
application/json:
examples:
paymentFailure:
$ref: '#/components/examples/WebhookAck'
schema:
$ref: '#/components/schemas/NotificationResponse'
description: OK - the request has succeeded.
@@ -495,7 +431,6 @@ webhooks:
description: Adyen sends this notification when [funds transferred between accounts
are refunded](https://docs.adyen.com/api-explorer/#/Fund/v6/latest/refundFundsTransfer).
operationId: post-REFUND_FUNDS_TRANSFER
x-groupName: Fund management
x-sortIndex: 6
x-methodName: fundsTransferBetweenAccountsRefunded
security:
@@ -520,7 +455,6 @@ webhooks:
description: Adyen sends this notification when a report has been generated
and it is available for download.
operationId: post-REPORT_AVAILABLE
x-groupName: Other
x-sortIndex: 2
x-methodName: reportAvailable
security:
@@ -537,9 +471,6 @@ webhooks:
'200':
content:
application/json:
examples:
reportAvailable:
$ref: '#/components/examples/WebhookAck'
schema:
$ref: '#/components/schemas/NotificationResponse'
description: OK - the request has succeeded.
@@ -552,7 +483,6 @@ webhooks:
that are not yet paid out](https://docs.adyen.com/api-explorer/#/Fund/latest/refundNotPaidOutTransfers)
is processed and the associated refunds are scheduled.
operationId: post-SCHEDULED_REFUNDS
x-groupName: Fund management
x-sortIndex: 4
x-methodName: refundTransfersNotPaidOutCallProcessedAndRefundsScheduled
security:
@@ -569,9 +499,6 @@ webhooks:
'200':
content:
application/json:
examples:
scheduledRefunds:
$ref: '#/components/examples/WebhookAck'
schema:
$ref: '#/components/schemas/NotificationResponse'
description: OK - the request has succeeded.
@@ -583,7 +510,6 @@ webhooks:
description: Adyen sends this notification when [funds are transferred between
accounts](https://docs.adyen.com/api-explorer/#/Fund/latest/post/transferFunds).
operationId: post-TRANSFER_FUNDS
x-groupName: Fund management
x-sortIndex: 2
x-methodName: fundsTransferredBetweenAccounts
security:
@@ -600,9 +526,6 @@ webhooks:
'200':
content:
application/json:
examples:
transferFunds:
$ref: '#/components/examples/WebhookAck'
schema:
$ref: '#/components/schemas/NotificationResponse'
description: OK - the request has succeeded.
@@ -1035,7 +958,9 @@ components:
- DeleteLiableBankAccount
- DeletePayoutMethods
- DeleteShareholders
- DeleteShareholdersNoKyc
- DeleteSignatories
- DeleteUnusedAccount
- InactivateAccount
- KYCDeadlineExtension
- MigrateAccountToBP
@@ -1044,7 +969,6 @@ components:
- ResolveEvents
- SaveAccountHolder
- SaveKYCCheckStatus
- SavePEPChecks
- SuspendAccount
- UnSuspendAccount
- UpdateAccountHolderState
@@ -1695,7 +1619,7 @@ components:
description: The code of the account holder.
type: string
payoutSchedule:
description: The payout schedule of the account.
description: The details of the payout schedule added to the account.
$ref: '#/components/schemas/PayoutScheduleResponse'
pspReference:
description: The reference of a request. Can be used to uniquely identify
@@ -1890,6 +1814,7 @@ components:
- legalBusinessName
- legalEntity
- legalEntityType
- linkedViasVirtualAccount
- logo
- merchantAccount
- merchantCategoryCode
@@ -2219,11 +2144,15 @@ components:
format: date-time
type: string
schedule:
description: 'The payout schedule of the account.
description: 'The payout schedule for the account.
Permitted values: `DEFAULT`, `DAILY`, `DAILY_US`, `DAILY_EU`, `DAILY_AU`,
Possible values: `DEFAULT`, `DAILY`, `DAILY_US`, `DAILY_EU`, `DAILY_AU`,
`DAILY_SG`, `WEEKLY`, `WEEKLY_ON_TUE_FRI_MIDNIGHT`, `BIWEEKLY_ON_1ST_AND_15TH_AT_MIDNIGHT`,
`MONTHLY`, `HOLD`.'
`MONTHLY`, `HOLD`.
> `HOLD` prevents scheduled payouts, but you can still initiate payouts
manually.'
enum:
- BIWEEKLY_ON_1ST_AND_15TH_AT_MIDNIGHT
- DAILY
@@ -2581,70 +2510,86 @@ components:
Split:
properties:
account:
description: 'Unique identifier of the account where the split amount should
be sent. This is required if `type` is **MarketPlace** or **BalanceAccount**.
description: 'The unique identifier of the account to which the split amount
is booked. Required if `type` is **MarketPlace** or **BalanceAccount**.
'
* [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic):
The [`accountCode`](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccount#request-accountCode)
of the account to which the split amount is booked.
* [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms):
The [`balanceAccountId`](https://docs.adyen.com/api-explorer/balanceplatform/latest/get/balanceAccounts/_id_#path-id)
of the account to which the split amount is booked.'
type: string
amount:
description: The amount of this split.
description: 'The amount of the split item.
* Required for all split types in the [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic).
* Required if `type` is **BalanceAccount**, **Commission**, **Default**,
or **VAT** in your [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms)
integration.'
$ref: '#/components/schemas/SplitAmount'
description:
description: A description of this split.
description: Your description for the split item.
type: string
reference:
description: 'Your reference for the split, which you can use to link the
split to other operations such as captures and refunds.
description: 'Your unique reference for the split item.
This is required if `type` is **MarketPlace** or **BalanceAccount**. For
the other types, we also recommend sending a reference so you can reconcile
the split and the associated payment in the transaction overview and in
the reports. If the reference is not provided, the split is reported as
part of the aggregated [TransferBalance record type](https://docs.adyen.com/reporting/marketpay-payments-accounting-report)
in Adyen for Platforms.'
This is required if `type` is **MarketPlace** ([Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic))
or **BalanceAccount** ([Balance Platform](https://docs.adyen.com/marketplaces-and-platforms)).
For the other types, we also recommend providing a **unique** reference
so you can reconcile the split and the associated payment in the transaction
overview and in the reports.'
type: string
type:
description: 'The type of split.
description: 'The type of the split item.
Possible values: **Default**, **PaymentFee**, **VAT**, **Commission**,
**MarketPlace**, **BalanceAccount**, **Remainder**, **Surcharge**, **Tip**.'
Possible values:
* [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic):
**Commission**, **Default**, **Marketplace**, **PaymentFee**, **VAT**.
* [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms):
**BalanceAccount**, **Commission**, **Default**, **PaymentFee**, **Remainder**,
**Surcharge**, **Tip**, **VAT**.'
enum:
- AcquiringFees
- AdyenCommission
- AdyenFees
- AdyenMarkup
- BalanceAccount
- Commission
- Default
- Interchange
- MarketPlace
- PaymentFee
- PaymentFeeAcquiring
- PaymentFeeAdyen
- PaymentFeeAdyenCommission
- PaymentFeeAdyenMarkup
- PaymentFeeInterchange
- PaymentFeeSchemeFee
- Remainder
- SchemeFee
- Surcharge
- Tip
- VAT
- Verification
type: string
required:
- amount
- type
type: object
SplitAmount:
properties:
currency:
description: 'The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes).
If this value is not provided, the currency in which the payment is made
will be used.'
description: The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes).
By default, this is the original payment currency.
maxLength: 3
minLength: 3
type: string
value:
description: The amount in [minor units](https://docs.adyen.com/development-resources/currency-codes).
description: The value of the split amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).
format: int64
type: integer
required:
@@ -2709,6 +2654,7 @@ components:
`ManualCorrected`.'
enum:
- BalanceNotPaidOutTransfer
- BalancePlatformFundTransfer
- BalancePlatformSweep
- BalancePlatformSweepReturned
- Chargeback
@@ -2732,15 +2678,19 @@ components:
- DebitedReversed
- DepositCorrectionCredited
- DepositCorrectionDebited
- DepositCorrectionReceived
- Fee
- FeeReceived
- FundTransfer
- FundTransferReversed
- InvoiceDeductionCredited
- InvoiceDeductionDebited
- InvoiceDeductionReceived
- ManualCorrected
- ManualCorrectionCredited
- ManualCorrectionDebited
- MerchantPayin
- MerchantPayinReceived
- MerchantPayinReversed
- Payout
- PayoutReversed
@@ -2897,7 +2847,8 @@ components:
description: The code of the account.
type: string
payoutSchedule:
description: The payout schedule of the account.
description: The details of the payout schedule to which the account is
updated.
$ref: '#/components/schemas/PayoutScheduleResponse'
pspReference:
description: The reference of a request. Can be used to uniquely identify
@@ -3044,9 +2995,6 @@ components:
scheme: basic
type: http
examples:
WebhookAck:
summary: Acknowledge Webhook
value: '[accepted]'
post-ACCOUNT_CLOSED-accountClosed:
summary: ACCOUNT_CLOSED example
value:
@@ -3138,7 +3086,6 @@ components:
fullPhoneNumber: '+31858888138'
name:
firstName: Firstname
gender: UNKNOWN
infix: infix
lastName: Lastname
personalData:
@@ -3163,7 +3110,6 @@ components:
individualDetails:
name:
firstName: Firstname
gender: UNKNOWN
infix: infix
lastName: Lastname
personalData:
@@ -3327,7 +3273,6 @@ components:
individualDetails:
name:
firstName: Firstname
gender: UNKNOWN
infix: infix
lastName: Lastname
personalData:
@@ -3632,7 +3577,6 @@ components:
fullPhoneNumber: '+31858888138'
name:
firstName: Firstname
gender: UNKNOWN
infix: infix
lastName: Lastname
personalData:
@@ -3657,7 +3601,6 @@ components:
individualDetails:
name:
firstName: Firstname
gender: UNKNOWN
infix: infix
lastName: Lastname
personalData:

194
yaml/MarketPayNotificationService-v4.yaml
View File

@@ -9,17 +9,15 @@ info:
\ 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: '2023-06-02T11:23:48Z'
termsOfService: https://www.adyen.com/legal/terms-and-conditions
contact:
name: Adyen Developer Experience team
url: https://github.com/Adyen/adyen-openapi
x-groups:
- Account holders
- Accounts
- Fund management
- Other
tags: []
tags:
- name: Account holders
- name: Accounts
- name: Fund management
- name: Other
x-staticResponse: response.json
webhooks:
/ACCOUNT_CLOSED:
@@ -29,7 +27,6 @@ webhooks:
summary: Account closed
description: Adyen sends this webhook when [an account is closed](https://docs.adyen.com/api-explorer/#/Account/latest/post/closeAccount).
operationId: post-ACCOUNT_CLOSED
x-groupName: Accounts
x-sortIndex: 3
x-methodName: accountClosed
security:
@@ -46,9 +43,6 @@ webhooks:
'200':
content:
application/json:
examples:
accountClosed:
$ref: '#/components/examples/WebhookAck'
schema:
$ref: '#/components/schemas/NotificationResponse'
description: OK - the request has succeeded.
@@ -59,7 +53,6 @@ webhooks:
summary: Account created
description: Adyen sends this webhook when [an account is created](https://docs.adyen.com/api-explorer/#/Account/latest/post/createAccount).
operationId: post-ACCOUNT_CREATED
x-groupName: Accounts
x-sortIndex: 1
x-methodName: accountCreated
security:
@@ -76,9 +69,6 @@ webhooks:
'200':
content:
application/json:
examples:
accountCreated:
$ref: '#/components/examples/WebhookAck'
schema:
$ref: '#/components/schemas/NotificationResponse'
description: OK - the request has succeeded.
@@ -90,7 +80,6 @@ webhooks:
description: Adyen sends this notification when the current funds of your liable
account are below the configured threshold.
operationId: post-ACCOUNT_FUNDS_BELOW_THRESHOLD
x-groupName: Fund management
x-sortIndex: 7
x-methodName: liableAccountsFundsAreBelowConfiguredThreshold
security:
@@ -114,7 +103,6 @@ webhooks:
summary: Account holder created
description: Adyen sends this webhook when [an account holder is created](https://docs.adyen.com/api-explorer/#/Account/latest/post/createAccountHolder).
operationId: post-ACCOUNT_HOLDER_CREATED
x-groupName: Account holders
x-sortIndex: 1
x-methodName: accountHolderCreated
security:
@@ -135,13 +123,6 @@ webhooks:
'200':
content:
application/json:
examples:
accountHolderCreated-businesses:
$ref: '#/components/examples/WebhookAck'
accountHolderCreated-failed:
$ref: '#/components/examples/WebhookAck'
accountHolderCreated-individuals:
$ref: '#/components/examples/WebhookAck'
schema:
$ref: '#/components/schemas/NotificationResponse'
description: OK - the request has succeeded.
@@ -153,7 +134,6 @@ webhooks:
description: Adyen sends this notification when a [payout request](https://docs.adyen.com/api-explorer/#/Fund/latest/post/payoutAccountHolder)
to an account holder is processed and the payout is scheduled.
operationId: post-ACCOUNT_HOLDER_PAYOUT
x-groupName: Fund management
x-sortIndex: 1
x-methodName: paidOutToAccountHolder
security:
@@ -172,11 +152,6 @@ webhooks:
'200':
content:
application/json:
examples:
accountHolderPayout-failed:
$ref: '#/components/examples/WebhookAck'
accountHolderPayout-initiated:
$ref: '#/components/examples/WebhookAck'
schema:
$ref: '#/components/schemas/NotificationResponse'
description: OK - the request has succeeded.
@@ -188,7 +163,6 @@ webhooks:
description: Adyen sends this webhook when [the status of an account holder
is changed](https://docs.adyen.com/api-explorer/#/Account/latest/post/updateAccountHolderState).
operationId: post-ACCOUNT_HOLDER_STATUS_CHANGE
x-groupName: Account holders
x-sortIndex: 4
x-methodName: accountHolderStatusChanged
security:
@@ -205,9 +179,6 @@ webhooks:
'200':
content:
application/json:
examples:
accountHolderStatusChange:
$ref: '#/components/examples/WebhookAck'
schema:
$ref: '#/components/schemas/NotificationResponse'
description: OK - the request has succeeded.
@@ -219,7 +190,6 @@ webhooks:
description: Adyen sends this webhook when [the status of a store](https://docs.adyen.com/api-explorer/#/Account/latest/post/createAccountHolder__reqParam_accountHolderDetails-storeDetails-status)
associated with an account holder is changed.
operationId: post-ACCOUNT_HOLDER_STORE_STATUS_CHANGE
x-groupName: Account holders
x-sortIndex: 4
x-methodName: storeStatusChanged
security:
@@ -236,9 +206,6 @@ webhooks:
'200':
content:
application/json:
examples:
accountHolderStoreStatusChange:
$ref: '#/components/examples/WebhookAck'
schema:
$ref: '#/components/schemas/NotificationResponse'
description: OK - the request has succeeded.
@@ -250,7 +217,6 @@ webhooks:
description: Adyen sends this notification when an account holder's deadline
to fulfill the requirements of a specific event is coming up.
operationId: post-ACCOUNT_HOLDER_UPCOMING_DEADLINE
x-groupName: Account holders
x-sortIndex: 1
x-methodName: upcomingDeadline
security:
@@ -274,7 +240,6 @@ webhooks:
summary: Account holder updated
description: Adyen sends this webhook when [an account holder is updated](https://docs.adyen.com/api-explorer/#/Account/latest/post/updateAccountHolder).
operationId: post-ACCOUNT_HOLDER_UPDATED
x-groupName: Account holders
x-sortIndex: 2
x-methodName: accountHolderUpdated
security:
@@ -291,9 +256,6 @@ webhooks:
'200':
content:
application/json:
examples:
accountHolderUpdated:
$ref: '#/components/examples/WebhookAck'
schema:
$ref: '#/components/schemas/NotificationResponse'
description: OK - the request has succeeded.
@@ -304,7 +266,6 @@ webhooks:
summary: Verification results received
description: Adyen sends this webhook when verification results are available.
operationId: post-ACCOUNT_HOLDER_VERIFICATION
x-groupName: Account holders
x-sortIndex: 3
x-methodName: verificationResultsReceived
security:
@@ -321,9 +282,6 @@ webhooks:
'200':
content:
application/json:
examples:
accountHolderVerification:
$ref: '#/components/examples/WebhookAck'
schema:
$ref: '#/components/schemas/NotificationResponse'
description: OK - the request has succeeded.
@@ -334,7 +292,6 @@ webhooks:
summary: Account updated
description: Adyen sends this webhook when [an account is updated](https://docs.adyen.com/api-explorer/#/Account/latest/post/updateAccount).
operationId: post-ACCOUNT_UPDATED
x-groupName: Accounts
x-sortIndex: 2
x-methodName: accountUpdated
security:
@@ -351,9 +308,6 @@ webhooks:
'200':
content:
application/json:
examples:
accountUpdated:
$ref: '#/components/examples/WebhookAck'
schema:
$ref: '#/components/schemas/NotificationResponse'
description: OK - the request has succeeded.
@@ -365,7 +319,6 @@ webhooks:
description: Adyen sends this notification when a [benefactor/beneficiary relationship
is created](https://docs.adyen.com/api-explorer/#/Fund/latest/post/transferFunds).
operationId: post-BENEFICIARY_SETUP
x-groupName: Fund management
x-sortIndex: 3
x-methodName: beneficiaryDefined
security:
@@ -382,9 +335,6 @@ webhooks:
'200':
content:
application/json:
examples:
beneficiarySetup:
$ref: '#/components/examples/WebhookAck'
schema:
$ref: '#/components/schemas/NotificationResponse'
description: OK - the request has succeeded.
@@ -396,7 +346,6 @@ webhooks:
description: Adyen sends this notification when funds are transferred from your
platform's liable account to an overdrawn account to compensate for the overdraft.
operationId: post-COMPENSATE_NEGATIVE_BALANCE
x-groupName: Fund management
x-sortIndex: 5
x-methodName: negativeAccountBalancesCompensated
security:
@@ -413,9 +362,6 @@ webhooks:
'200':
content:
application/json:
examples:
compensateNegativeBalance:
$ref: '#/components/examples/WebhookAck'
schema:
$ref: '#/components/schemas/NotificationResponse'
description: OK - the request has succeeded.
@@ -426,7 +372,6 @@ webhooks:
summary: Automated direct debit initiated
description: Adyen sends this notification when a [direct debit is initiated](https://docs.adyen.com/api-explorer/#/Fund/latest/post/debitAccountHolder).
operationId: post-DIRECT_DEBIT_INITIATED
x-groupName: Fund management
x-sortIndex: 7
x-methodName: automatedDirectDebitInitiated
security:
@@ -445,11 +390,6 @@ webhooks:
'200':
content:
application/json:
examples:
directDebitInitiated:
$ref: '#/components/examples/WebhookAck'
directDebitInitiated-failed:
$ref: '#/components/examples/WebhookAck'
schema:
$ref: '#/components/schemas/NotificationResponse'
description: OK - the request has succeeded.
@@ -464,7 +404,6 @@ webhooks:
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
x-methodName: bookingForCaptureOrRefundFailed
security:
@@ -481,9 +420,6 @@ webhooks:
'200':
content:
application/json:
examples:
paymentFailure:
$ref: '#/components/examples/WebhookAck'
schema:
$ref: '#/components/schemas/NotificationResponse'
description: OK - the request has succeeded.
@@ -495,7 +431,6 @@ webhooks:
description: Adyen sends this notification when [funds transferred between accounts
are refunded](https://docs.adyen.com/api-explorer/#/Fund/v6/latest/refundFundsTransfer).
operationId: post-REFUND_FUNDS_TRANSFER
x-groupName: Fund management
x-sortIndex: 6
x-methodName: fundsTransferBetweenAccountsRefunded
security:
@@ -520,7 +455,6 @@ webhooks:
description: Adyen sends this notification when a report has been generated
and it is available for download.
operationId: post-REPORT_AVAILABLE
x-groupName: Other
x-sortIndex: 2
x-methodName: reportAvailable
security:
@@ -537,9 +471,6 @@ webhooks:
'200':
content:
application/json:
examples:
reportAvailable:
$ref: '#/components/examples/WebhookAck'
schema:
$ref: '#/components/schemas/NotificationResponse'
description: OK - the request has succeeded.
@@ -552,7 +483,6 @@ webhooks:
that are not yet paid out](https://docs.adyen.com/api-explorer/#/Fund/latest/refundNotPaidOutTransfers)
is processed and the associated refunds are scheduled.
operationId: post-SCHEDULED_REFUNDS
x-groupName: Fund management
x-sortIndex: 4
x-methodName: refundTransfersNotPaidOutCallProcessedAndRefundsScheduled
security:
@@ -569,9 +499,6 @@ webhooks:
'200':
content:
application/json:
examples:
scheduledRefunds:
$ref: '#/components/examples/WebhookAck'
schema:
$ref: '#/components/schemas/NotificationResponse'
description: OK - the request has succeeded.
@@ -583,7 +510,6 @@ webhooks:
description: Adyen sends this notification when [funds are transferred between
accounts](https://docs.adyen.com/api-explorer/#/Fund/latest/post/transferFunds).
operationId: post-TRANSFER_FUNDS
x-groupName: Fund management
x-sortIndex: 2
x-methodName: fundsTransferredBetweenAccounts
security:
@@ -600,9 +526,6 @@ webhooks:
'200':
content:
application/json:
examples:
transferFunds:
$ref: '#/components/examples/WebhookAck'
schema:
$ref: '#/components/schemas/NotificationResponse'
description: OK - the request has succeeded.
@@ -1083,7 +1006,9 @@ components:
- DeleteLiableBankAccount
- DeletePayoutMethods
- DeleteShareholders
- DeleteShareholdersNoKyc
- DeleteSignatories
- DeleteUnusedAccount
- InactivateAccount
- KYCDeadlineExtension
- MigrateAccountToBP
@@ -1092,7 +1017,6 @@ components:
- ResolveEvents
- SaveAccountHolder
- SaveKYCCheckStatus
- SavePEPChecks
- SuspendAccount
- UnSuspendAccount
- UpdateAccountHolderState
@@ -1791,7 +1715,7 @@ components:
description: The description of the account.
type: string
payoutSchedule:
description: The payout schedule of the account.
description: The details of the payout schedule added to the account.
$ref: '#/components/schemas/PayoutScheduleResponse'
pspReference:
description: The reference of a request. Can be used to uniquely identify
@@ -1995,6 +1919,7 @@ components:
- legalBusinessName
- legalEntity
- legalEntityType
- linkedViasVirtualAccount
- logo
- merchantAccount
- merchantCategoryCode
@@ -2317,11 +2242,15 @@ components:
format: date-time
type: string
schedule:
description: 'The payout schedule of the account.
description: 'The payout schedule for the account.
Permitted values: `DEFAULT`, `DAILY`, `DAILY_US`, `DAILY_EU`, `DAILY_AU`,
Possible values: `DEFAULT`, `DAILY`, `DAILY_US`, `DAILY_EU`, `DAILY_AU`,
`DAILY_SG`, `WEEKLY`, `WEEKLY_ON_TUE_FRI_MIDNIGHT`, `BIWEEKLY_ON_1ST_AND_15TH_AT_MIDNIGHT`,
`MONTHLY`, `HOLD`.'
`MONTHLY`, `HOLD`.
> `HOLD` prevents scheduled payouts, but you can still initiate payouts
manually.'
enum:
- BIWEEKLY_ON_1ST_AND_15TH_AT_MIDNIGHT
- DAILY
@@ -2697,70 +2626,86 @@ components:
Split:
properties:
account:
description: 'Unique identifier of the account where the split amount should
be sent. This is required if `type` is **MarketPlace** or **BalanceAccount**.
description: 'The unique identifier of the account to which the split amount
is booked. Required if `type` is **MarketPlace** or **BalanceAccount**.
'
* [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic):
The [`accountCode`](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccount#request-accountCode)
of the account to which the split amount is booked.
* [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms):
The [`balanceAccountId`](https://docs.adyen.com/api-explorer/balanceplatform/latest/get/balanceAccounts/_id_#path-id)
of the account to which the split amount is booked.'
type: string
amount:
description: The amount of this split.
description: 'The amount of the split item.
* Required for all split types in the [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic).
* Required if `type` is **BalanceAccount**, **Commission**, **Default**,
or **VAT** in your [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms)
integration.'
$ref: '#/components/schemas/SplitAmount'
description:
description: A description of this split.
description: Your description for the split item.
type: string
reference:
description: 'Your reference for the split, which you can use to link the
split to other operations such as captures and refunds.
description: 'Your unique reference for the split item.
This is required if `type` is **MarketPlace** or **BalanceAccount**. For
the other types, we also recommend sending a reference so you can reconcile
the split and the associated payment in the transaction overview and in
the reports. If the reference is not provided, the split is reported as
part of the aggregated [TransferBalance record type](https://docs.adyen.com/reporting/marketpay-payments-accounting-report)
in Adyen for Platforms.'
This is required if `type` is **MarketPlace** ([Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic))
or **BalanceAccount** ([Balance Platform](https://docs.adyen.com/marketplaces-and-platforms)).
For the other types, we also recommend providing a **unique** reference
so you can reconcile the split and the associated payment in the transaction
overview and in the reports.'
type: string
type:
description: 'The type of split.
description: 'The type of the split item.
Possible values: **Default**, **PaymentFee**, **VAT**, **Commission**,
**MarketPlace**, **BalanceAccount**, **Remainder**, **Surcharge**, **Tip**.'
Possible values:
* [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic):
**Commission**, **Default**, **Marketplace**, **PaymentFee**, **VAT**.
* [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms):
**BalanceAccount**, **Commission**, **Default**, **PaymentFee**, **Remainder**,
**Surcharge**, **Tip**, **VAT**.'
enum:
- AcquiringFees
- AdyenCommission
- AdyenFees
- AdyenMarkup
- BalanceAccount
- Commission
- Default
- Interchange
- MarketPlace
- PaymentFee
- PaymentFeeAcquiring
- PaymentFeeAdyen
- PaymentFeeAdyenCommission
- PaymentFeeAdyenMarkup
- PaymentFeeInterchange
- PaymentFeeSchemeFee
- Remainder
- SchemeFee
- Surcharge
- Tip
- VAT
- Verification
type: string
required:
- amount
- type
type: object
SplitAmount:
properties:
currency:
description: 'The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes).
If this value is not provided, the currency in which the payment is made
will be used.'
description: The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes).
By default, this is the original payment currency.
maxLength: 3
minLength: 3
type: string
value:
description: The amount in [minor units](https://docs.adyen.com/development-resources/currency-codes).
description: The value of the split amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).
format: int64
type: integer
required:
@@ -2825,6 +2770,7 @@ components:
`ManualCorrected`.'
enum:
- BalanceNotPaidOutTransfer
- BalancePlatformFundTransfer
- BalancePlatformSweep
- BalancePlatformSweepReturned
- Chargeback
@@ -2848,15 +2794,19 @@ components:
- DebitedReversed
- DepositCorrectionCredited
- DepositCorrectionDebited
- DepositCorrectionReceived
- Fee
- FeeReceived
- FundTransfer
- FundTransferReversed
- InvoiceDeductionCredited
- InvoiceDeductionDebited
- InvoiceDeductionReceived
- ManualCorrected
- ManualCorrectionCredited
- ManualCorrectionDebited
- MerchantPayin
- MerchantPayinReceived
- MerchantPayinReversed
- Payout
- PayoutReversed
@@ -3035,7 +2985,8 @@ components:
description: The description of the account.
type: string
payoutSchedule:
description: The payout schedule of the account.
description: The details of the payout schedule to which the account is
updated.
$ref: '#/components/schemas/PayoutScheduleResponse'
pspReference:
description: The reference of a request. Can be used to uniquely identify
@@ -3182,9 +3133,6 @@ components:
scheme: basic
type: http
examples:
WebhookAck:
summary: Acknowledge Webhook
value: '[accepted]'
post-ACCOUNT_CLOSED-accountClosed:
summary: ACCOUNT_CLOSED example
value:
@@ -3281,7 +3229,6 @@ components:
fullPhoneNumber: '+31858888138'
name:
firstName: Firstname
gender: UNKNOWN
infix: infix
lastName: Lastname
personalData:
@@ -3458,7 +3405,6 @@ components:
individualDetails:
name:
firstName: Firstname
gender: UNKNOWN
infix: infix
lastName: Lastname
personalData:
@@ -3770,7 +3716,6 @@ components:
fullPhoneNumber: '+31858888138'
name:
firstName: Firstname
gender: UNKNOWN
infix: infix
lastName: Lastname
personalData:
@@ -3795,7 +3740,6 @@ components:
individualDetails:
name:
firstName: Firstname
gender: UNKNOWN
infix: infix
lastName: Lastname
personalData:

214
yaml/MarketPayNotificationService-v5.yaml
View File

@@ -9,17 +9,15 @@ info:
\ 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: '2023-06-02T11:23:48Z'
termsOfService: https://www.adyen.com/legal/terms-and-conditions
contact:
name: Adyen Developer Experience team
url: https://github.com/Adyen/adyen-openapi
x-groups:
- Account holders
- Accounts
- Fund management
- Other
tags: []
tags:
- name: Account holders
- name: Accounts
- name: Fund management
- name: Other
x-staticResponse: response.json
webhooks:
/ACCOUNT_CLOSED:
@@ -29,7 +27,6 @@ webhooks:
summary: Account closed
description: Adyen sends this webhook when [an account is closed](https://docs.adyen.com/api-explorer/#/Account/latest/post/closeAccount).
operationId: post-ACCOUNT_CLOSED
x-groupName: Accounts
x-sortIndex: 3
x-methodName: accountClosed
security:
@@ -46,9 +43,6 @@ webhooks:
'200':
content:
application/json:
examples:
accountClosed:
$ref: '#/components/examples/WebhookAck'
schema:
$ref: '#/components/schemas/NotificationResponse'
description: OK - the request has succeeded.
@@ -59,7 +53,6 @@ webhooks:
summary: Account created
description: Adyen sends this webhook when [an account is created](https://docs.adyen.com/api-explorer/#/Account/latest/post/createAccount).
operationId: post-ACCOUNT_CREATED
x-groupName: Accounts
x-sortIndex: 1
x-methodName: accountCreated
security:
@@ -76,9 +69,6 @@ webhooks:
'200':
content:
application/json:
examples:
accountCreated:
$ref: '#/components/examples/WebhookAck'
schema:
$ref: '#/components/schemas/NotificationResponse'
description: OK - the request has succeeded.
@@ -90,7 +80,6 @@ webhooks:
description: Adyen sends this notification when the current funds of your liable
account are below the configured threshold.
operationId: post-ACCOUNT_FUNDS_BELOW_THRESHOLD
x-groupName: Fund management
x-sortIndex: 7
x-methodName: liableAccountsFundsAreBelowConfiguredThreshold
security:
@@ -107,9 +96,6 @@ webhooks:
'200':
content:
application/json:
examples:
accountFundsBelowThreshold:
$ref: '#/components/examples/WebhookAck'
schema:
$ref: '#/components/schemas/NotificationResponse'
description: OK - the request has succeeded.
@@ -120,7 +106,6 @@ webhooks:
summary: Account holder created
description: Adyen sends this webhook when [an account holder is created](https://docs.adyen.com/api-explorer/#/Account/latest/post/createAccountHolder).
operationId: post-ACCOUNT_HOLDER_CREATED
x-groupName: Account holders
x-sortIndex: 1
x-methodName: accountHolderCreated
security:
@@ -141,13 +126,6 @@ webhooks:
'200':
content:
application/json:
examples:
accountHolderCreated-businesses:
$ref: '#/components/examples/WebhookAck'
accountHolderCreated-failed:
$ref: '#/components/examples/WebhookAck'
accountHolderCreated-individuals:
$ref: '#/components/examples/WebhookAck'
schema:
$ref: '#/components/schemas/NotificationResponse'
description: OK - the request has succeeded.
@@ -159,7 +137,6 @@ webhooks:
description: Adyen sends this notification when a [payout request](https://docs.adyen.com/api-explorer/#/Fund/latest/post/payoutAccountHolder)
to an account holder is processed and the payout is scheduled.
operationId: post-ACCOUNT_HOLDER_PAYOUT
x-groupName: Fund management
x-sortIndex: 1
x-methodName: paidOutToAccountHolder
security:
@@ -178,11 +155,6 @@ webhooks:
'200':
content:
application/json:
examples:
accountHolderPayout-failed:
$ref: '#/components/examples/WebhookAck'
accountHolderPayout-initiated:
$ref: '#/components/examples/WebhookAck'
schema:
$ref: '#/components/schemas/NotificationResponse'
description: OK - the request has succeeded.
@@ -194,7 +166,6 @@ webhooks:
description: Adyen sends this webhook when [the status of an account holder
is changed](https://docs.adyen.com/api-explorer/#/Account/latest/post/updateAccountHolderState).
operationId: post-ACCOUNT_HOLDER_STATUS_CHANGE
x-groupName: Account holders
x-sortIndex: 4
x-methodName: accountHolderStatusChanged
security:
@@ -211,9 +182,6 @@ webhooks:
'200':
content:
application/json:
examples:
accountHolderStatusChange:
$ref: '#/components/examples/WebhookAck'
schema:
$ref: '#/components/schemas/NotificationResponse'
description: OK - the request has succeeded.
@@ -225,7 +193,6 @@ webhooks:
description: Adyen sends this webhook when [the status of a store](https://docs.adyen.com/api-explorer/#/Account/latest/post/createAccountHolder__reqParam_accountHolderDetails-storeDetails-status)
associated with an account holder is changed.
operationId: post-ACCOUNT_HOLDER_STORE_STATUS_CHANGE
x-groupName: Account holders
x-sortIndex: 4
x-methodName: storeStatusChanged
security:
@@ -242,9 +209,6 @@ webhooks:
'200':
content:
application/json:
examples:
accountHolderStoreStatusChange:
$ref: '#/components/examples/WebhookAck'
schema:
$ref: '#/components/schemas/NotificationResponse'
description: OK - the request has succeeded.
@@ -256,7 +220,6 @@ webhooks:
description: Adyen sends this notification when an account holder's deadline
to fulfill the requirements of a specific event is coming up.
operationId: post-ACCOUNT_HOLDER_UPCOMING_DEADLINE
x-groupName: Account holders
x-sortIndex: 1
x-methodName: upcomingDeadline
security:
@@ -273,9 +236,6 @@ webhooks:
'200':
content:
application/json:
examples:
accountHolderUpcomingDeadline:
$ref: '#/components/examples/WebhookAck'
schema:
$ref: '#/components/schemas/NotificationResponse'
description: OK - the request has succeeded.
@@ -286,7 +246,6 @@ webhooks:
summary: Account holder updated
description: Adyen sends this webhook when [an account holder is updated](https://docs.adyen.com/api-explorer/#/Account/latest/post/updateAccountHolder).
operationId: post-ACCOUNT_HOLDER_UPDATED
x-groupName: Account holders
x-sortIndex: 2
x-methodName: accountHolderUpdated
security:
@@ -303,9 +262,6 @@ webhooks:
'200':
content:
application/json:
examples:
accountHolderUpdated:
$ref: '#/components/examples/WebhookAck'
schema:
$ref: '#/components/schemas/NotificationResponse'
description: OK - the request has succeeded.
@@ -316,7 +272,6 @@ webhooks:
summary: Verification results received
description: Adyen sends this webhook when verification results are available.
operationId: post-ACCOUNT_HOLDER_VERIFICATION
x-groupName: Account holders
x-sortIndex: 3
x-methodName: verificationResultsReceived
security:
@@ -333,9 +288,6 @@ webhooks:
'200':
content:
application/json:
examples:
accountHolderVerification:
$ref: '#/components/examples/WebhookAck'
schema:
$ref: '#/components/schemas/NotificationResponse'
description: OK - the request has succeeded.
@@ -346,7 +298,6 @@ webhooks:
summary: Account updated
description: Adyen sends this webhook when [an account is updated](https://docs.adyen.com/api-explorer/#/Account/latest/post/updateAccount).
operationId: post-ACCOUNT_UPDATED
x-groupName: Accounts
x-sortIndex: 2
x-methodName: accountUpdated
security:
@@ -363,9 +314,6 @@ webhooks:
'200':
content:
application/json:
examples:
accountUpdated:
$ref: '#/components/examples/WebhookAck'
schema:
$ref: '#/components/schemas/NotificationResponse'
description: OK - the request has succeeded.
@@ -377,7 +325,6 @@ webhooks:
description: Adyen sends this notification when a [benefactor/beneficiary relationship
is created](https://docs.adyen.com/api-explorer/#/Fund/latest/post/transferFunds).
operationId: post-BENEFICIARY_SETUP
x-groupName: Fund management
x-sortIndex: 3
x-methodName: beneficiaryDefined
security:
@@ -394,9 +341,6 @@ webhooks:
'200':
content:
application/json:
examples:
beneficiarySetup:
$ref: '#/components/examples/WebhookAck'
schema:
$ref: '#/components/schemas/NotificationResponse'
description: OK - the request has succeeded.
@@ -408,7 +352,6 @@ webhooks:
description: Adyen sends this notification when funds are transferred from your
platform's liable account to an overdrawn account to compensate for the overdraft.
operationId: post-COMPENSATE_NEGATIVE_BALANCE
x-groupName: Fund management
x-sortIndex: 5
x-methodName: negativeAccountBalancesCompensated
security:
@@ -425,9 +368,6 @@ webhooks:
'200':
content:
application/json:
examples:
compensateNegativeBalance:
$ref: '#/components/examples/WebhookAck'
schema:
$ref: '#/components/schemas/NotificationResponse'
description: OK - the request has succeeded.
@@ -438,7 +378,6 @@ webhooks:
summary: Automated direct debit initiated
description: Adyen sends this notification when a [direct debit is initiated](https://docs.adyen.com/api-explorer/#/Fund/latest/post/debitAccountHolder).
operationId: post-DIRECT_DEBIT_INITIATED
x-groupName: Fund management
x-sortIndex: 7
x-methodName: automatedDirectDebitInitiated
security:
@@ -455,9 +394,6 @@ webhooks:
'200':
content:
application/json:
examples:
directDebitInitiated:
$ref: '#/components/examples/WebhookAck'
schema:
$ref: '#/components/schemas/NotificationResponse'
description: OK - the request has succeeded.
@@ -472,7 +408,6 @@ webhooks:
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
x-methodName: bookingForCaptureOrRefundFailed
security:
@@ -489,9 +424,6 @@ webhooks:
'200':
content:
application/json:
examples:
paymentFailure:
$ref: '#/components/examples/WebhookAck'
schema:
$ref: '#/components/schemas/NotificationResponse'
description: OK - the request has succeeded.
@@ -503,7 +435,6 @@ webhooks:
description: Adyen sends this notification when [funds transferred between accounts
are refunded](https://docs.adyen.com/api-explorer/#/Fund/v6/latest/refundFundsTransfer).
operationId: post-REFUND_FUNDS_TRANSFER
x-groupName: Fund management
x-sortIndex: 6
x-methodName: fundsTransferBetweenAccountsRefunded
security:
@@ -520,9 +451,6 @@ webhooks:
'200':
content:
application/json:
examples:
refundFundsTransfer:
$ref: '#/components/examples/WebhookAck'
schema:
$ref: '#/components/schemas/NotificationResponse'
description: OK - the request has succeeded.
@@ -534,7 +462,6 @@ webhooks:
description: Adyen sends this notification when a report has been generated
and it is available for download.
operationId: post-REPORT_AVAILABLE
x-groupName: Other
x-sortIndex: 2
x-methodName: reportAvailable
security:
@@ -551,9 +478,6 @@ webhooks:
'200':
content:
application/json:
examples:
reportAvailable:
$ref: '#/components/examples/WebhookAck'
schema:
$ref: '#/components/schemas/NotificationResponse'
description: OK - the request has succeeded.
@@ -566,7 +490,6 @@ webhooks:
that are not yet paid out](https://docs.adyen.com/api-explorer/#/Fund/latest/refundNotPaidOutTransfers)
is processed and the associated refunds are scheduled.
operationId: post-SCHEDULED_REFUNDS
x-groupName: Fund management
x-sortIndex: 4
x-methodName: refundTransfersNotPaidOutCallProcessedAndRefundsScheduled
security:
@@ -583,9 +506,6 @@ webhooks:
'200':
content:
application/json:
examples:
scheduledRefunds:
$ref: '#/components/examples/WebhookAck'
schema:
$ref: '#/components/schemas/NotificationResponse'
description: OK - the request has succeeded.
@@ -597,7 +517,6 @@ webhooks:
description: Adyen sends this notification when [funds are transferred between
accounts](https://docs.adyen.com/api-explorer/#/Fund/latest/post/transferFunds).
operationId: post-TRANSFER_FUNDS
x-groupName: Fund management
x-sortIndex: 2
x-methodName: fundsTransferredBetweenAccounts
security:
@@ -614,9 +533,6 @@ webhooks:
'200':
content:
application/json:
examples:
transferFunds:
$ref: '#/components/examples/WebhookAck'
schema:
$ref: '#/components/schemas/NotificationResponse'
description: OK - the request has succeeded.
@@ -1233,7 +1149,9 @@ components:
- DeleteLiableBankAccount
- DeletePayoutMethods
- DeleteShareholders
- DeleteShareholdersNoKyc
- DeleteSignatories
- DeleteUnusedAccount
- InactivateAccount
- KYCDeadlineExtension
- MigrateAccountToBP
@@ -1242,7 +1160,6 @@ components:
- ResolveEvents
- SaveAccountHolder
- SaveKYCCheckStatus
- SavePEPChecks
- SuspendAccount
- UnSuspendAccount
- UpdateAccountHolderState
@@ -1964,7 +1881,7 @@ components:
method code.
type: string
payoutSchedule:
description: The payout schedule of the account.
description: The details of the payout schedule added to the account.
$ref: '#/components/schemas/PayoutScheduleResponse'
payoutSpeed:
x-addedInVersion: '5'
@@ -2167,6 +2084,7 @@ components:
- legalBusinessName
- legalEntity
- legalEntityType
- linkedViasVirtualAccount
- logo
- merchantAccount
- merchantCategoryCode
@@ -2548,11 +2466,15 @@ components:
format: date-time
type: string
schedule:
description: 'The payout schedule of the account.
description: 'The payout schedule for the account.
Permitted values: `DEFAULT`, `DAILY`, `DAILY_US`, `DAILY_EU`, `DAILY_AU`,
Possible values: `DEFAULT`, `DAILY`, `DAILY_US`, `DAILY_EU`, `DAILY_AU`,
`DAILY_SG`, `WEEKLY`, `WEEKLY_ON_TUE_FRI_MIDNIGHT`, `BIWEEKLY_ON_1ST_AND_15TH_AT_MIDNIGHT`,
`MONTHLY`, `HOLD`.'
`MONTHLY`, `HOLD`.
> `HOLD` prevents scheduled payouts, but you can still initiate payouts
manually.'
enum:
- BIWEEKLY_ON_1ST_AND_15TH_AT_MIDNIGHT
- DAILY
@@ -2943,70 +2865,86 @@ components:
Split:
properties:
account:
description: 'Unique identifier of the account where the split amount should
be sent. This is required if `type` is **MarketPlace** or **BalanceAccount**.
description: 'The unique identifier of the account to which the split amount
is booked. Required if `type` is **MarketPlace** or **BalanceAccount**.
'
* [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic):
The [`accountCode`](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccount#request-accountCode)
of the account to which the split amount is booked.
* [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms):
The [`balanceAccountId`](https://docs.adyen.com/api-explorer/balanceplatform/latest/get/balanceAccounts/_id_#path-id)
of the account to which the split amount is booked.'
type: string
amount:
description: The amount of this split.
description: 'The amount of the split item.
* Required for all split types in the [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic).
* Required if `type` is **BalanceAccount**, **Commission**, **Default**,
or **VAT** in your [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms)
integration.'
$ref: '#/components/schemas/SplitAmount'
description:
description: A description of this split.
description: Your description for the split item.
type: string
reference:
description: 'Your reference for the split, which you can use to link the
split to other operations such as captures and refunds.
description: 'Your unique reference for the split item.
This is required if `type` is **MarketPlace** or **BalanceAccount**. For
the other types, we also recommend sending a reference so you can reconcile
the split and the associated payment in the transaction overview and in
the reports. If the reference is not provided, the split is reported as
part of the aggregated [TransferBalance record type](https://docs.adyen.com/reporting/marketpay-payments-accounting-report)
in Adyen for Platforms.'
This is required if `type` is **MarketPlace** ([Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic))
or **BalanceAccount** ([Balance Platform](https://docs.adyen.com/marketplaces-and-platforms)).
For the other types, we also recommend providing a **unique** reference
so you can reconcile the split and the associated payment in the transaction
overview and in the reports.'
type: string
type:
description: 'The type of split.
description: 'The type of the split item.
Possible values: **Default**, **PaymentFee**, **VAT**, **Commission**,
**MarketPlace**, **BalanceAccount**, **Remainder**, **Surcharge**, **Tip**.'
Possible values:
* [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic):
**Commission**, **Default**, **Marketplace**, **PaymentFee**, **VAT**.
* [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms):
**BalanceAccount**, **Commission**, **Default**, **PaymentFee**, **Remainder**,
**Surcharge**, **Tip**, **VAT**.'
enum:
- AcquiringFees
- AdyenCommission
- AdyenFees
- AdyenMarkup
- BalanceAccount
- Commission
- Default
- Interchange
- MarketPlace
- PaymentFee
- PaymentFeeAcquiring
- PaymentFeeAdyen
- PaymentFeeAdyenCommission
- PaymentFeeAdyenMarkup
- PaymentFeeInterchange
- PaymentFeeSchemeFee
- Remainder
- SchemeFee
- Surcharge
- Tip
- VAT
- Verification
type: string
required:
- amount
- type
type: object
SplitAmount:
properties:
currency:
description: 'The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes).
If this value is not provided, the currency in which the payment is made
will be used.'
description: The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes).
By default, this is the original payment currency.
maxLength: 3
minLength: 3
type: string
value:
description: The amount in [minor units](https://docs.adyen.com/development-resources/currency-codes).
description: The value of the split amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).
format: int64
type: integer
required:
@@ -3074,9 +3012,11 @@ components:
type: string
storeName:
description: "The name of the account holder's store. This value is shown\
\ in shopper statements.\n\n* Length: Between 3 to 22 characters \n\n\
* The following characters are *not* supported: **:;}{$#@!|<>%^*+=\\\\\
**"
\ in shopper statements.\n\n * Length: Between 3 to 22 characters \n\n\
\ * The following characters are *not* supported: **:;}{$#@!|<>%^*+=\\\
\\**\n\n**Note:** storeName does not appear in American Express shopper\
\ statements by default. Contact Adyen Support to enable this for American\
\ Express."
type: string
storeReference:
description: "Your unique identifier for the store. The Customer Area also\
@@ -3157,6 +3097,7 @@ components:
`ManualCorrected`.'
enum:
- BalanceNotPaidOutTransfer
- BalancePlatformFundTransfer
- BalancePlatformSweep
- BalancePlatformSweepReturned
- Chargeback
@@ -3180,15 +3121,19 @@ components:
- DebitedReversed
- DepositCorrectionCredited
- DepositCorrectionDebited
- DepositCorrectionReceived
- Fee
- FeeReceived
- FundTransfer
- FundTransferReversed
- InvoiceDeductionCredited
- InvoiceDeductionDebited
- InvoiceDeductionReceived
- ManualCorrected
- ManualCorrectionCredited
- ManualCorrectionDebited
- MerchantPayin
- MerchantPayinReceived
- MerchantPayinReversed
- Payout
- PayoutReversed
@@ -3391,12 +3336,15 @@ components:
method code.
type: string
payoutSchedule:
description: The payout schedule of the account.
description: The details of the payout schedule to which the account is
updated.
$ref: '#/components/schemas/PayoutScheduleResponse'
payoutSpeed:
x-addedInVersion: '5'
description: 'Speed with which payouts for this account are processed. Permitted
values: `STANDARD`, `SAME_DAY`.'
description: 'Speed at which payouts for this account are processed.
Possible values: `STANDARD`, `SAME_DAY`.'
enum:
- INSTANT
- SAME_DAY
@@ -3529,9 +3477,6 @@ components:
scheme: basic
type: http
examples:
WebhookAck:
summary: Acknowledge Webhook
value: '[accepted]'
post-ACCOUNT_CLOSED-accountClosed:
summary: ACCOUNT_CLOSED example
value:
@@ -3689,7 +3634,6 @@ components:
fullPhoneNumber: '+3112345678'
name:
firstName: Firstname
gender: UNKNOWN
infix: infix
lastName: Lastname
personalData:
@@ -3714,7 +3658,6 @@ components:
individualDetails:
name:
firstName: Firstname
gender: UNKNOWN
infix: infix
lastName: Lastname
personalData:
@@ -3895,7 +3838,6 @@ components:
individualDetails:
name:
firstName: Firstname
gender: UNKNOWN
infix: infix
lastName: Lastname
personalData:

214
yaml/MarketPayNotificationService-v6.yaml
View File

@@ -9,17 +9,15 @@ info:
\ 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: '2023-06-02T11:23:48Z'
termsOfService: https://www.adyen.com/legal/terms-and-conditions
contact:
name: Adyen Developer Experience team
url: https://github.com/Adyen/adyen-openapi
x-groups:
- Account holders
- Accounts
- Fund management
- Other
tags: []
tags:
- name: Account holders
- name: Accounts
- name: Fund management
- name: Other
x-staticResponse: response.json
webhooks:
/ACCOUNT_CLOSED:
@@ -29,7 +27,6 @@ webhooks:
summary: Account closed
description: Adyen sends this webhook when [an account is closed](https://docs.adyen.com/api-explorer/#/Account/latest/post/closeAccount).
operationId: post-ACCOUNT_CLOSED
x-groupName: Accounts
x-sortIndex: 3
x-methodName: accountClosed
security:
@@ -46,9 +43,6 @@ webhooks:
'200':
content:
application/json:
examples:
accountClosed:
$ref: '#/components/examples/WebhookAck'
schema:
$ref: '#/components/schemas/NotificationResponse'
description: OK - the request has succeeded.
@@ -59,7 +53,6 @@ webhooks:
summary: Account created
description: Adyen sends this webhook when [an account is created](https://docs.adyen.com/api-explorer/#/Account/latest/post/createAccount).
operationId: post-ACCOUNT_CREATED
x-groupName: Accounts
x-sortIndex: 1
x-methodName: accountCreated
security:
@@ -76,9 +69,6 @@ webhooks:
'200':
content:
application/json:
examples:
accountCreated:
$ref: '#/components/examples/WebhookAck'
schema:
$ref: '#/components/schemas/NotificationResponse'
description: OK - the request has succeeded.
@@ -90,7 +80,6 @@ webhooks:
description: Adyen sends this notification when the current funds of your liable
account are below the configured threshold.
operationId: post-ACCOUNT_FUNDS_BELOW_THRESHOLD
x-groupName: Fund management
x-sortIndex: 7
x-methodName: liableAccountsFundsAreBelowConfiguredThreshold
security:
@@ -107,9 +96,6 @@ webhooks:
'200':
content:
application/json:
examples:
accountFundsBelowThreshold:
$ref: '#/components/examples/WebhookAck'
schema:
$ref: '#/components/schemas/NotificationResponse'
description: OK - the request has succeeded.
@@ -120,7 +106,6 @@ webhooks:
summary: Account holder created
description: Adyen sends this webhook when [an account holder is created](https://docs.adyen.com/api-explorer/#/Account/latest/post/createAccountHolder).
operationId: post-ACCOUNT_HOLDER_CREATED
x-groupName: Account holders
x-sortIndex: 1
x-methodName: accountHolderCreated
security:
@@ -141,13 +126,6 @@ webhooks:
'200':
content:
application/json:
examples:
accountHolderCreated-businesses:
$ref: '#/components/examples/WebhookAck'
accountHolderCreated-failed:
$ref: '#/components/examples/WebhookAck'
accountHolderCreated-individuals:
$ref: '#/components/examples/WebhookAck'
schema:
$ref: '#/components/schemas/NotificationResponse'
description: OK - the request has succeeded.
@@ -159,7 +137,6 @@ webhooks:
description: Adyen sends this notification when a [payout request](https://docs.adyen.com/api-explorer/#/Fund/latest/post/payoutAccountHolder)
to an account holder is processed and the payout is scheduled.
operationId: post-ACCOUNT_HOLDER_PAYOUT
x-groupName: Fund management
x-sortIndex: 1
x-methodName: paidOutToAccountHolder
security:
@@ -178,11 +155,6 @@ webhooks:
'200':
content:
application/json:
examples:
accountHolderPayout-failed:
$ref: '#/components/examples/WebhookAck'
accountHolderPayout-initiated:
$ref: '#/components/examples/WebhookAck'
schema:
$ref: '#/components/schemas/NotificationResponse'
description: OK - the request has succeeded.
@@ -194,7 +166,6 @@ webhooks:
description: Adyen sends this webhook when [the status of an account holder
is changed](https://docs.adyen.com/api-explorer/#/Account/latest/post/updateAccountHolderState).
operationId: post-ACCOUNT_HOLDER_STATUS_CHANGE
x-groupName: Account holders
x-sortIndex: 4
x-methodName: accountHolderStatusChanged
security:
@@ -211,9 +182,6 @@ webhooks:
'200':
content:
application/json:
examples:
accountHolderStatusChange:
$ref: '#/components/examples/WebhookAck'
schema:
$ref: '#/components/schemas/NotificationResponse'
description: OK - the request has succeeded.
@@ -225,7 +193,6 @@ webhooks:
description: Adyen sends this webhook when [the status of a store](https://docs.adyen.com/api-explorer/#/Account/latest/post/createAccountHolder__reqParam_accountHolderDetails-storeDetails-status)
associated with an account holder is changed.
operationId: post-ACCOUNT_HOLDER_STORE_STATUS_CHANGE
x-groupName: Account holders
x-sortIndex: 4
x-methodName: storeStatusChanged
security:
@@ -242,9 +209,6 @@ webhooks:
'200':
content:
application/json:
examples:
accountHolderStoreStatusChange:
$ref: '#/components/examples/WebhookAck'
schema:
$ref: '#/components/schemas/NotificationResponse'
description: OK - the request has succeeded.
@@ -256,7 +220,6 @@ webhooks:
description: Adyen sends this notification when an account holder's deadline
to fulfill the requirements of a specific event is coming up.
operationId: post-ACCOUNT_HOLDER_UPCOMING_DEADLINE
x-groupName: Account holders
x-sortIndex: 1
x-methodName: upcomingDeadline
security:
@@ -273,9 +236,6 @@ webhooks:
'200':
content:
application/json:
examples:
accountHolderUpcomingDeadline:
$ref: '#/components/examples/WebhookAck'
schema:
$ref: '#/components/schemas/NotificationResponse'
description: OK - the request has succeeded.
@@ -286,7 +246,6 @@ webhooks:
summary: Account holder updated
description: Adyen sends this webhook when [an account holder is updated](https://docs.adyen.com/api-explorer/#/Account/latest/post/updateAccountHolder).
operationId: post-ACCOUNT_HOLDER_UPDATED
x-groupName: Account holders
x-sortIndex: 2
x-methodName: accountHolderUpdated
security:
@@ -303,9 +262,6 @@ webhooks:
'200':
content:
application/json:
examples:
accountHolderUpdated:
$ref: '#/components/examples/WebhookAck'
schema:
$ref: '#/components/schemas/NotificationResponse'
description: OK - the request has succeeded.
@@ -316,7 +272,6 @@ webhooks:
summary: Verification results received
description: Adyen sends this webhook when verification results are available.
operationId: post-ACCOUNT_HOLDER_VERIFICATION
x-groupName: Account holders
x-sortIndex: 3
x-methodName: verificationResultsReceived
security:
@@ -333,9 +288,6 @@ webhooks:
'200':
content:
application/json:
examples:
accountHolderVerification:
$ref: '#/components/examples/WebhookAck'
schema:
$ref: '#/components/schemas/NotificationResponse'
description: OK - the request has succeeded.
@@ -346,7 +298,6 @@ webhooks:
summary: Account updated
description: Adyen sends this webhook when [an account is updated](https://docs.adyen.com/api-explorer/#/Account/latest/post/updateAccount).
operationId: post-ACCOUNT_UPDATED
x-groupName: Accounts
x-sortIndex: 2
x-methodName: accountUpdated
security:
@@ -363,9 +314,6 @@ webhooks:
'200':
content:
application/json:
examples:
accountUpdated:
$ref: '#/components/examples/WebhookAck'
schema:
$ref: '#/components/schemas/NotificationResponse'
description: OK - the request has succeeded.
@@ -377,7 +325,6 @@ webhooks:
description: Adyen sends this notification when a [benefactor/beneficiary relationship
is created](https://docs.adyen.com/api-explorer/#/Fund/latest/post/transferFunds).
operationId: post-BENEFICIARY_SETUP
x-groupName: Fund management
x-sortIndex: 3
x-methodName: beneficiaryDefined
security:
@@ -394,9 +341,6 @@ webhooks:
'200':
content:
application/json:
examples:
beneficiarySetup:
$ref: '#/components/examples/WebhookAck'
schema:
$ref: '#/components/schemas/NotificationResponse'
description: OK - the request has succeeded.
@@ -408,7 +352,6 @@ webhooks:
description: Adyen sends this notification when funds are transferred from your
platform's liable account to an overdrawn account to compensate for the overdraft.
operationId: post-COMPENSATE_NEGATIVE_BALANCE
x-groupName: Fund management
x-sortIndex: 5
x-methodName: negativeAccountBalancesCompensated
security:
@@ -425,9 +368,6 @@ webhooks:
'200':
content:
application/json:
examples:
compensateNegativeBalance:
$ref: '#/components/examples/WebhookAck'
schema:
$ref: '#/components/schemas/NotificationResponse'
description: OK - the request has succeeded.
@@ -438,7 +378,6 @@ webhooks:
summary: Automated direct debit initiated
description: Adyen sends this notification when a [direct debit is initiated](https://docs.adyen.com/api-explorer/#/Fund/latest/post/debitAccountHolder).
operationId: post-DIRECT_DEBIT_INITIATED
x-groupName: Fund management
x-sortIndex: 7
x-methodName: automatedDirectDebitInitiated
security:
@@ -455,9 +394,6 @@ webhooks:
'200':
content:
application/json:
examples:
directDebitInitiated:
$ref: '#/components/examples/WebhookAck'
schema:
$ref: '#/components/schemas/NotificationResponse'
description: OK - the request has succeeded.
@@ -472,7 +408,6 @@ webhooks:
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
x-methodName: bookingForCaptureOrRefundFailed
security:
@@ -489,9 +424,6 @@ webhooks:
'200':
content:
application/json:
examples:
paymentFailure:
$ref: '#/components/examples/WebhookAck'
schema:
$ref: '#/components/schemas/NotificationResponse'
description: OK - the request has succeeded.
@@ -503,7 +435,6 @@ webhooks:
description: Adyen sends this notification when [funds transferred between accounts
are refunded](https://docs.adyen.com/api-explorer/#/Fund/v6/latest/refundFundsTransfer).
operationId: post-REFUND_FUNDS_TRANSFER
x-groupName: Fund management
x-sortIndex: 6
x-methodName: fundsTransferBetweenAccountsRefunded
security:
@@ -520,9 +451,6 @@ webhooks:
'200':
content:
application/json:
examples:
refundFundsTransfer:
$ref: '#/components/examples/WebhookAck'
schema:
$ref: '#/components/schemas/NotificationResponse'
description: OK - the request has succeeded.
@@ -534,7 +462,6 @@ webhooks:
description: Adyen sends this notification when a report has been generated
and it is available for download.
operationId: post-REPORT_AVAILABLE
x-groupName: Other
x-sortIndex: 2
x-methodName: reportAvailable
security:
@@ -551,9 +478,6 @@ webhooks:
'200':
content:
application/json:
examples:
reportAvailable:
$ref: '#/components/examples/WebhookAck'
schema:
$ref: '#/components/schemas/NotificationResponse'
description: OK - the request has succeeded.
@@ -566,7 +490,6 @@ webhooks:
that are not yet paid out](https://docs.adyen.com/api-explorer/#/Fund/latest/refundNotPaidOutTransfers)
is processed and the associated refunds are scheduled.
operationId: post-SCHEDULED_REFUNDS
x-groupName: Fund management
x-sortIndex: 4
x-methodName: refundTransfersNotPaidOutCallProcessedAndRefundsScheduled
security:
@@ -583,9 +506,6 @@ webhooks:
'200':
content:
application/json:
examples:
scheduledRefunds:
$ref: '#/components/examples/WebhookAck'
schema:
$ref: '#/components/schemas/NotificationResponse'
description: OK - the request has succeeded.
@@ -597,7 +517,6 @@ webhooks:
description: Adyen sends this notification when [funds are transferred between
accounts](https://docs.adyen.com/api-explorer/#/Fund/latest/post/transferFunds).
operationId: post-TRANSFER_FUNDS
x-groupName: Fund management
x-sortIndex: 2
x-methodName: fundsTransferredBetweenAccounts
security:
@@ -614,9 +533,6 @@ webhooks:
'200':
content:
application/json:
examples:
transferFunds:
$ref: '#/components/examples/WebhookAck'
schema:
$ref: '#/components/schemas/NotificationResponse'
description: OK - the request has succeeded.
@@ -1262,7 +1178,9 @@ components:
- DeleteLiableBankAccount
- DeletePayoutMethods
- DeleteShareholders
- DeleteShareholdersNoKyc
- DeleteSignatories
- DeleteUnusedAccount
- InactivateAccount
- KYCDeadlineExtension
- MigrateAccountToBP
@@ -1271,7 +1189,6 @@ components:
- ResolveEvents
- SaveAccountHolder
- SaveKYCCheckStatus
- SavePEPChecks
- SuspendAccount
- UnSuspendAccount
- UpdateAccountHolderState
@@ -2021,7 +1938,7 @@ components:
method code.
type: string
payoutSchedule:
description: The payout schedule of the account.
description: The details of the payout schedule added to the account.
$ref: '#/components/schemas/PayoutScheduleResponse'
payoutSpeed:
x-addedInVersion: '5'
@@ -2224,6 +2141,7 @@ components:
- legalBusinessName
- legalEntity
- legalEntityType
- linkedViasVirtualAccount
- logo
- merchantAccount
- merchantCategoryCode
@@ -2822,11 +2740,15 @@ components:
format: date-time
type: string
schedule:
description: 'The payout schedule of the account.
description: 'The payout schedule for the account.
Permitted values: `DEFAULT`, `DAILY`, `DAILY_US`, `DAILY_EU`, `DAILY_AU`,
Possible values: `DEFAULT`, `DAILY`, `DAILY_US`, `DAILY_EU`, `DAILY_AU`,
`DAILY_SG`, `WEEKLY`, `WEEKLY_ON_TUE_FRI_MIDNIGHT`, `BIWEEKLY_ON_1ST_AND_15TH_AT_MIDNIGHT`,
`MONTHLY`, `HOLD`.'
`MONTHLY`, `HOLD`.
> `HOLD` prevents scheduled payouts, but you can still initiate payouts
manually.'
enum:
- BIWEEKLY_ON_1ST_AND_15TH_AT_MIDNIGHT
- DAILY
@@ -3217,70 +3139,86 @@ components:
Split:
properties:
account:
description: 'Unique identifier of the account where the split amount should
be sent. This is required if `type` is **MarketPlace** or **BalanceAccount**.
description: 'The unique identifier of the account to which the split amount
is booked. Required if `type` is **MarketPlace** or **BalanceAccount**.
'
* [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic):
The [`accountCode`](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccount#request-accountCode)
of the account to which the split amount is booked.
* [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms):
The [`balanceAccountId`](https://docs.adyen.com/api-explorer/balanceplatform/latest/get/balanceAccounts/_id_#path-id)
of the account to which the split amount is booked.'
type: string
amount:
description: The amount of this split.
description: 'The amount of the split item.
* Required for all split types in the [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic).
* Required if `type` is **BalanceAccount**, **Commission**, **Default**,
or **VAT** in your [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms)
integration.'
$ref: '#/components/schemas/SplitAmount'
description:
description: A description of this split.
description: Your description for the split item.
type: string
reference:
description: 'Your reference for the split, which you can use to link the
split to other operations such as captures and refunds.
description: 'Your unique reference for the split item.
This is required if `type` is **MarketPlace** or **BalanceAccount**. For
the other types, we also recommend sending a reference so you can reconcile
the split and the associated payment in the transaction overview and in
the reports. If the reference is not provided, the split is reported as
part of the aggregated [TransferBalance record type](https://docs.adyen.com/reporting/marketpay-payments-accounting-report)
in Adyen for Platforms.'
This is required if `type` is **MarketPlace** ([Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic))
or **BalanceAccount** ([Balance Platform](https://docs.adyen.com/marketplaces-and-platforms)).
For the other types, we also recommend providing a **unique** reference
so you can reconcile the split and the associated payment in the transaction
overview and in the reports.'
type: string
type:
description: 'The type of split.
description: 'The type of the split item.
Possible values: **Default**, **PaymentFee**, **VAT**, **Commission**,
**MarketPlace**, **BalanceAccount**, **Remainder**, **Surcharge**, **Tip**.'
Possible values:
* [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic):
**Commission**, **Default**, **Marketplace**, **PaymentFee**, **VAT**.
* [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms):
**BalanceAccount**, **Commission**, **Default**, **PaymentFee**, **Remainder**,
**Surcharge**, **Tip**, **VAT**.'
enum:
- AcquiringFees
- AdyenCommission
- AdyenFees
- AdyenMarkup
- BalanceAccount
- Commission
- Default
- Interchange
- MarketPlace
- PaymentFee
- PaymentFeeAcquiring
- PaymentFeeAdyen
- PaymentFeeAdyenCommission
- PaymentFeeAdyenMarkup
- PaymentFeeInterchange
- PaymentFeeSchemeFee
- Remainder
- SchemeFee
- Surcharge
- Tip
- VAT
- Verification
type: string
required:
- amount
- type
type: object
SplitAmount:
properties:
currency:
description: 'The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes).
If this value is not provided, the currency in which the payment is made
will be used.'
description: The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes).
By default, this is the original payment currency.
maxLength: 3
minLength: 3
type: string
value:
description: The amount in [minor units](https://docs.adyen.com/development-resources/currency-codes).
description: The value of the split amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).
format: int64
type: integer
required:
@@ -3348,9 +3286,11 @@ components:
type: string
storeName:
description: "The name of the account holder's store. This value is shown\
\ in shopper statements.\n\n* Length: Between 3 to 22 characters \n\n\
* The following characters are *not* supported: **:;}{$#@!|<>%^*+=\\\\\
**"
\ in shopper statements.\n\n * Length: Between 3 to 22 characters \n\n\
\ * The following characters are *not* supported: **:;}{$#@!|<>%^*+=\\\
\\**\n\n**Note:** storeName does not appear in American Express shopper\
\ statements by default. Contact Adyen Support to enable this for American\
\ Express."
type: string
storeReference:
description: "Your unique identifier for the store. The Customer Area also\
@@ -3431,6 +3371,7 @@ components:
`ManualCorrected`.'
enum:
- BalanceNotPaidOutTransfer
- BalancePlatformFundTransfer
- BalancePlatformSweep
- BalancePlatformSweepReturned
- Chargeback
@@ -3454,15 +3395,19 @@ components:
- DebitedReversed
- DepositCorrectionCredited
- DepositCorrectionDebited
- DepositCorrectionReceived
- Fee
- FeeReceived
- FundTransfer
- FundTransferReversed
- InvoiceDeductionCredited
- InvoiceDeductionDebited
- InvoiceDeductionReceived
- ManualCorrected
- ManualCorrectionCredited
- ManualCorrectionDebited
- MerchantPayin
- MerchantPayinReceived
- MerchantPayinReversed
- Payout
- PayoutReversed
@@ -3671,12 +3616,15 @@ components:
method code.
type: string
payoutSchedule:
description: The payout schedule of the account.
description: The details of the payout schedule to which the account is
updated.
$ref: '#/components/schemas/PayoutScheduleResponse'
payoutSpeed:
x-addedInVersion: '5'
description: 'Speed with which payouts for this account are processed. Permitted
values: `STANDARD`, `SAME_DAY`.'
description: 'Speed at which payouts for this account are processed.
Possible values: `STANDARD`, `SAME_DAY`.'
enum:
- INSTANT
- SAME_DAY
@@ -3809,9 +3757,6 @@ components:
scheme: basic
type: http
examples:
WebhookAck:
summary: Acknowledge Webhook
value: '[accepted]'
post-ACCOUNT_CLOSED-accountClosed:
summary: ACCOUNT_CLOSED example
value:
@@ -3969,7 +3914,6 @@ components:
fullPhoneNumber: '+3112345678'
name:
firstName: Firstname
gender: UNKNOWN
infix: infix
lastName: Lastname
personalData:
@@ -3994,7 +3938,6 @@ components:
individualDetails:
name:
firstName: Firstname
gender: UNKNOWN
infix: infix
lastName: Lastname
personalData:
@@ -4175,7 +4118,6 @@ components:
individualDetails:
name:
firstName: Firstname
gender: UNKNOWN
infix: infix
lastName: Lastname
personalData:

11
yaml/NotificationConfigurationService-v1.yaml
View File

@@ -23,13 +23,10 @@ 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: '2023-05-30T15:27:19Z'
termsOfService: https://www.adyen.com/legal/terms-and-conditions
contact:
name: Adyen Developer Experience team
url: https://github.com/Adyen/adyen-openapi
x-groups:
- General
tags:
- name: General
paths:
@@ -47,7 +44,6 @@ paths:
have multiple endpoints if desired; an event notification may be sent to as
many or as few different endpoints as configured.
operationId: post-createNotificationConfiguration
x-groupName: General
x-sortIndex: 1
x-methodName: createNotificationConfiguration
security:
@@ -110,7 +106,6 @@ paths:
the subscription is deleted, no further event notifications will be sent to
the URL defined in the subscription.
operationId: post-deleteNotificationConfigurations
x-groupName: General
x-sortIndex: 6
x-methodName: deleteNotificationConfigurations
security:
@@ -171,7 +166,6 @@ paths:
summary: Get a notification subscription configuration
description: Returns the details of the configuration of a notification subscription.
operationId: post-getNotificationConfiguration
x-groupName: General
x-sortIndex: 2
x-methodName: getNotificationConfiguration
security:
@@ -233,7 +227,6 @@ paths:
description: Returns the details of the configurations of all of the notification
subscriptions in the platform of the executing user.
operationId: post-getNotificationConfigurationList
x-groupName: General
x-sortIndex: 3
x-methodName: getNotificationConfigurationList
security:
@@ -296,7 +289,6 @@ paths:
each event type specified, a test notification will be generated and sent
to the URL configured in the subscription specified.
operationId: post-testNotificationConfiguration
x-groupName: General
x-sortIndex: 4
x-methodName: testNotificationConfiguration
security:
@@ -359,7 +351,6 @@ paths:
you are updating the event types, you must provide all event types, otherwise
the previous event type configuration will be overwritten.
operationId: post-updateNotificationConfiguration
x-groupName: General
x-sortIndex: 5
x-methodName: updateNotificationConfiguration
security:
@@ -940,7 +931,7 @@ components:
value:
pspReference: '8616480452462678'
errorMessages:
- The required string "[accepted]" is not in all the results
- The server did not respond with HTTP 2XX
eventTypes:
- ACCOUNT_HOLDER_VERIFICATION
exchangeMessages:

11
yaml/NotificationConfigurationService-v2.yaml
View File

@@ -23,13 +23,10 @@ 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: '2023-05-30T15:27:19Z'
termsOfService: https://www.adyen.com/legal/terms-and-conditions
contact:
name: Adyen Developer Experience team
url: https://github.com/Adyen/adyen-openapi
x-groups:
- General
tags:
- name: General
paths:
@@ -47,7 +44,6 @@ paths:
have multiple endpoints if desired; an event notification may be sent to as
many or as few different endpoints as configured.
operationId: post-createNotificationConfiguration
x-groupName: General
x-sortIndex: 1
x-methodName: createNotificationConfiguration
security:
@@ -110,7 +106,6 @@ paths:
the subscription is deleted, no further event notifications will be sent to
the URL defined in the subscription.
operationId: post-deleteNotificationConfigurations
x-groupName: General
x-sortIndex: 6
x-methodName: deleteNotificationConfigurations
security:
@@ -171,7 +166,6 @@ paths:
summary: Get a notification subscription configuration
description: Returns the details of the configuration of a notification subscription.
operationId: post-getNotificationConfiguration
x-groupName: General
x-sortIndex: 2
x-methodName: getNotificationConfiguration
security:
@@ -233,7 +227,6 @@ paths:
description: Returns the details of the configurations of all of the notification
subscriptions in the platform of the executing user.
operationId: post-getNotificationConfigurationList
x-groupName: General
x-sortIndex: 3
x-methodName: getNotificationConfigurationList
security:
@@ -296,7 +289,6 @@ paths:
each event type specified, a test notification will be generated and sent
to the URL configured in the subscription specified.
operationId: post-testNotificationConfiguration
x-groupName: General
x-sortIndex: 4
x-methodName: testNotificationConfiguration
security:
@@ -359,7 +351,6 @@ paths:
you are updating the event types, you must provide all event types, otherwise
the previous event type configuration will be overwritten.
operationId: post-updateNotificationConfiguration
x-groupName: General
x-sortIndex: 5
x-methodName: updateNotificationConfiguration
security:
@@ -940,7 +931,7 @@ components:
value:
pspReference: '8616480452462678'
errorMessages:
- The required string "[accepted]" is not in all the results
- The server did not respond with HTTP 2XX
eventTypes:
- ACCOUNT_HOLDER_VERIFICATION
exchangeMessages:

11
yaml/NotificationConfigurationService-v3.yaml
View File

@@ -23,13 +23,10 @@ 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: '2023-05-30T15:27:19Z'
termsOfService: https://www.adyen.com/legal/terms-and-conditions
contact:
name: Adyen Developer Experience team
url: https://github.com/Adyen/adyen-openapi
x-groups:
- General
tags:
- name: General
paths:
@@ -47,7 +44,6 @@ paths:
have multiple endpoints if desired; an event notification may be sent to as
many or as few different endpoints as configured.
operationId: post-createNotificationConfiguration
x-groupName: General
x-sortIndex: 1
x-methodName: createNotificationConfiguration
security:
@@ -110,7 +106,6 @@ paths:
the subscription is deleted, no further event notifications will be sent to
the URL defined in the subscription.
operationId: post-deleteNotificationConfigurations
x-groupName: General
x-sortIndex: 6
x-methodName: deleteNotificationConfigurations
security:
@@ -171,7 +166,6 @@ paths:
summary: Get a notification subscription configuration
description: Returns the details of the configuration of a notification subscription.
operationId: post-getNotificationConfiguration
x-groupName: General
x-sortIndex: 2
x-methodName: getNotificationConfiguration
security:
@@ -233,7 +227,6 @@ paths:
description: Returns the details of the configurations of all of the notification
subscriptions in the platform of the executing user.
operationId: post-getNotificationConfigurationList
x-groupName: General
x-sortIndex: 3
x-methodName: getNotificationConfigurationList
security:
@@ -296,7 +289,6 @@ paths:
each event type specified, a test notification will be generated and sent
to the URL configured in the subscription specified.
operationId: post-testNotificationConfiguration
x-groupName: General
x-sortIndex: 4
x-methodName: testNotificationConfiguration
security:
@@ -359,7 +351,6 @@ paths:
you are updating the event types, you must provide all event types, otherwise
the previous event type configuration will be overwritten.
operationId: post-updateNotificationConfiguration
x-groupName: General
x-sortIndex: 5
x-methodName: updateNotificationConfiguration
security:
@@ -940,7 +931,7 @@ components:
value:
pspReference: '8616480452462678'
errorMessages:
- The required string "[accepted]" is not in all the results
- The server did not respond with HTTP 2XX
eventTypes:
- ACCOUNT_HOLDER_VERIFICATION
exchangeMessages:

11
yaml/NotificationConfigurationService-v4.yaml
View File

@@ -23,13 +23,10 @@ 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: '2023-05-30T15:27:19Z'
termsOfService: https://www.adyen.com/legal/terms-and-conditions
contact:
name: Adyen Developer Experience team
url: https://github.com/Adyen/adyen-openapi
x-groups:
- General
tags:
- name: General
paths:
@@ -47,7 +44,6 @@ paths:
have multiple endpoints if desired; an event notification may be sent to as
many or as few different endpoints as configured.
operationId: post-createNotificationConfiguration
x-groupName: General
x-sortIndex: 1
x-methodName: createNotificationConfiguration
security:
@@ -110,7 +106,6 @@ paths:
the subscription is deleted, no further event notifications will be sent to
the URL defined in the subscription.
operationId: post-deleteNotificationConfigurations
x-groupName: General
x-sortIndex: 6
x-methodName: deleteNotificationConfigurations
security:
@@ -171,7 +166,6 @@ paths:
summary: Get a notification subscription configuration
description: Returns the details of the configuration of a notification subscription.
operationId: post-getNotificationConfiguration
x-groupName: General
x-sortIndex: 2
x-methodName: getNotificationConfiguration
security:
@@ -233,7 +227,6 @@ paths:
description: Returns the details of the configurations of all of the notification
subscriptions in the platform of the executing user.
operationId: post-getNotificationConfigurationList
x-groupName: General
x-sortIndex: 3
x-methodName: getNotificationConfigurationList
security:
@@ -296,7 +289,6 @@ paths:
each event type specified, a test notification will be generated and sent
to the URL configured in the subscription specified.
operationId: post-testNotificationConfiguration
x-groupName: General
x-sortIndex: 4
x-methodName: testNotificationConfiguration
security:
@@ -359,7 +351,6 @@ paths:
you are updating the event types, you must provide all event types, otherwise
the previous event type configuration will be overwritten.
operationId: post-updateNotificationConfiguration
x-groupName: General
x-sortIndex: 5
x-methodName: updateNotificationConfiguration
security:
@@ -940,7 +931,7 @@ components:
value:
pspReference: '8616480452462678'
errorMessages:
- The required string "[accepted]" is not in all the results
- The server did not respond with HTTP 2XX
eventTypes:
- ACCOUNT_HOLDER_VERIFICATION
exchangeMessages:

12
yaml/NotificationConfigurationService-v5.yaml
View File

@@ -23,13 +23,10 @@ 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: '2023-05-30T15:27:19Z'
termsOfService: https://www.adyen.com/legal/terms-and-conditions
contact:
name: Adyen Developer Experience team
url: https://github.com/Adyen/adyen-openapi
x-groups:
- General
tags:
- name: General
paths:
@@ -47,7 +44,6 @@ paths:
have multiple endpoints if desired; an event notification may be sent to as
many or as few different endpoints as configured.
operationId: post-createNotificationConfiguration
x-groupName: General
x-sortIndex: 1
x-methodName: createNotificationConfiguration
security:
@@ -110,7 +106,6 @@ paths:
the subscription is deleted, no further event notifications will be sent to
the URL defined in the subscription.
operationId: post-deleteNotificationConfigurations
x-groupName: General
x-sortIndex: 6
x-methodName: deleteNotificationConfigurations
security:
@@ -171,7 +166,6 @@ paths:
summary: Get a notification subscription configuration
description: Returns the details of the configuration of a notification subscription.
operationId: post-getNotificationConfiguration
x-groupName: General
x-sortIndex: 2
x-methodName: getNotificationConfiguration
security:
@@ -233,7 +227,6 @@ paths:
description: Returns the details of the configurations of all of the notification
subscriptions in the platform of the executing user.
operationId: post-getNotificationConfigurationList
x-groupName: General
x-sortIndex: 3
x-methodName: getNotificationConfigurationList
security:
@@ -296,7 +289,6 @@ paths:
each event type specified, a test notification will be generated and sent
to the URL configured in the subscription specified.
operationId: post-testNotificationConfiguration
x-groupName: General
x-sortIndex: 4
x-methodName: testNotificationConfiguration
security:
@@ -359,7 +351,6 @@ paths:
you are updating the event types, you must provide all event types, otherwise
the previous event type configuration will be overwritten.
operationId: post-updateNotificationConfiguration
x-groupName: General
x-sortIndex: 5
x-methodName: updateNotificationConfiguration
security:
@@ -547,6 +538,7 @@ components:
- legalBusinessName
- legalEntity
- legalEntityType
- linkedViasVirtualAccount
- logo
- merchantAccount
- merchantCategoryCode
@@ -1083,7 +1075,7 @@ components:
value:
pspReference: '8616480452462678'
errorMessages:
- The required string "[accepted]" is not in all the results
- The server did not respond with HTTP 2XX
eventTypes:
- ACCOUNT_HOLDER_VERIFICATION
exchangeMessages:

12
yaml/NotificationConfigurationService-v6.yaml
View File

@@ -23,13 +23,10 @@ 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: '2023-05-30T15:27:19Z'
termsOfService: https://www.adyen.com/legal/terms-and-conditions
contact:
name: Adyen Developer Experience team
url: https://github.com/Adyen/adyen-openapi
x-groups:
- General
tags:
- name: General
paths:
@@ -47,7 +44,6 @@ paths:
have multiple endpoints if desired; an event notification may be sent to as
many or as few different endpoints as configured.
operationId: post-createNotificationConfiguration
x-groupName: General
x-sortIndex: 1
x-methodName: createNotificationConfiguration
security:
@@ -110,7 +106,6 @@ paths:
the subscription is deleted, no further event notifications will be sent to
the URL defined in the subscription.
operationId: post-deleteNotificationConfigurations
x-groupName: General
x-sortIndex: 6
x-methodName: deleteNotificationConfigurations
security:
@@ -171,7 +166,6 @@ paths:
summary: Get a notification subscription configuration
description: Returns the details of the configuration of a notification subscription.
operationId: post-getNotificationConfiguration
x-groupName: General
x-sortIndex: 2
x-methodName: getNotificationConfiguration
security:
@@ -233,7 +227,6 @@ paths:
description: Returns the details of the configurations of all of the notification
subscriptions in the platform of the executing user.
operationId: post-getNotificationConfigurationList
x-groupName: General
x-sortIndex: 3
x-methodName: getNotificationConfigurationList
security:
@@ -296,7 +289,6 @@ paths:
each event type specified, a test notification will be generated and sent
to the URL configured in the subscription specified.
operationId: post-testNotificationConfiguration
x-groupName: General
x-sortIndex: 4
x-methodName: testNotificationConfiguration
security:
@@ -359,7 +351,6 @@ paths:
you are updating the event types, you must provide all event types, otherwise
the previous event type configuration will be overwritten.
operationId: post-updateNotificationConfiguration
x-groupName: General
x-sortIndex: 5
x-methodName: updateNotificationConfiguration
security:
@@ -547,6 +538,7 @@ components:
- legalBusinessName
- legalEntity
- legalEntityType
- linkedViasVirtualAccount
- logo
- merchantAccount
- merchantCategoryCode
@@ -1083,7 +1075,7 @@ components:
value:
pspReference: '8616480452462678'
errorMessages:
- The required string "[accepted]" is not in all the results
- The server did not respond with HTTP 2XX
eventTypes:
- ACCOUNT_HOLDER_VERIFICATION
exchangeMessages: