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-05 17:26:49 +01:00
parent fcc380e5a3
commit 5ec2d192fd
40 changed files with 1572 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

63
json/AccountService-v3.json
View File

@@ -2061,6 +2061,7 @@
"components" : {
"schemas" : {
"Account" : {
"additionalProperties" : false,
"properties" : {
"accountCode" : {
"description" : "The code of the account.",
@@ -2082,6 +2083,7 @@
"type" : "object"
},
"AccountEvent" : {
"additionalProperties" : false,
"properties" : {
"event" : {
"description" : "The event.\n>Permitted values: `InactivateAccount`, `RefundNotPaidOutTransfers`.\nFor more information, refer to [Verification checks](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process).",
@@ -2111,6 +2113,7 @@
}
},
"AccountHolderDetails" : {
"additionalProperties" : false,
"properties" : {
"address" : {
"description" : "The address of the account holder.",
@@ -2169,6 +2172,7 @@
"type" : "object"
},
"AccountHolderStatus" : {
"additionalProperties" : false,
"properties" : {
"events" : {
"description" : "A list of events scheduled for the account holder.",
@@ -2206,6 +2210,7 @@
"type" : "object"
},
"AccountPayoutState" : {
"additionalProperties" : false,
"properties" : {
"allowPayout" : {
"description" : "Indicates whether payouts are allowed. This field is the overarching payout status, and is the aggregate of multiple conditions (e.g., KYC status, disabled flag, etc). If this field is false, no payouts will be permitted for any of the account holder's accounts. If this field is true, payouts will be permitted for any of the account holder's accounts.",
@@ -2233,6 +2238,7 @@
"type" : "object"
},
"AccountProcessingState" : {
"additionalProperties" : false,
"properties" : {
"disableReason" : {
"description" : "The reason why processing has been disabled.",
@@ -2267,6 +2273,7 @@
}
},
"Amount" : {
"additionalProperties" : false,
"properties" : {
"currency" : {
"description" : "The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes).",
@@ -2287,6 +2294,7 @@
"type" : "object"
},
"BankAccountDetail" : {
"additionalProperties" : false,
"properties" : {
"accountNumber" : {
"description" : "The bank account number (without separators).\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.",
@@ -2400,6 +2408,7 @@
}
},
"BusinessDetails" : {
"additionalProperties" : false,
"properties" : {
"doingBusinessAs" : {
"description" : "The registered name of the company (if it differs from the legal name of the company).",
@@ -2438,6 +2447,7 @@
"type" : "object"
},
"CloseAccountHolderRequest" : {
"additionalProperties" : false,
"properties" : {
"accountHolderCode" : {
"description" : "The code of the Account Holder to be closed.",
@@ -2450,6 +2460,7 @@
"type" : "object"
},
"CloseAccountHolderResponse" : {
"additionalProperties" : false,
"properties" : {
"accountHolderStatus" : {
"description" : "The new status of the Account Holder.",
@@ -2471,6 +2482,7 @@
"type" : "object"
},
"CloseAccountRequest" : {
"additionalProperties" : false,
"properties" : {
"accountCode" : {
"description" : "The code of account to be closed.",
@@ -2483,6 +2495,7 @@
"type" : "object"
},
"CloseAccountResponse" : {
"additionalProperties" : false,
"properties" : {
"pspReference" : {
"description" : "The reference of a request. Can be used to uniquely identify the request.",
@@ -2511,6 +2524,7 @@
"type" : "object"
},
"CreateAccountHolderRequest" : {
"additionalProperties" : false,
"properties" : {
"accountHolderCode" : {
"description" : "Your unique identifier for the prospective account holder.\nThe length must be between three (3) and fifty (50) characters long. Only letters, digits, and hyphens (-) are allowed.",
@@ -2548,6 +2562,7 @@
"type" : "object"
},
"CreateAccountHolderResponse" : {
"additionalProperties" : false,
"properties" : {
"accountCode" : {
"description" : "The code of a new account created for the account holder.",
@@ -2595,6 +2610,7 @@
"type" : "object"
},
"CreateAccountRequest" : {
"additionalProperties" : false,
"properties" : {
"accountHolderCode" : {
"description" : "The code of Account Holder under which to create the account.",
@@ -2632,6 +2648,7 @@
"type" : "object"
},
"CreateAccountResponse" : {
"additionalProperties" : false,
"properties" : {
"accountCode" : {
"description" : "The code of the new account.",
@@ -2672,6 +2689,7 @@
"type" : "object"
},
"DeleteBankAccountRequest" : {
"additionalProperties" : false,
"properties" : {
"accountHolderCode" : {
"description" : "The code of the Account Holder from which to delete the Bank Account(s).",
@@ -2692,6 +2710,7 @@
"type" : "object"
},
"DeleteLegalArrangementRequest" : {
"additionalProperties" : false,
"properties" : {
"accountHolderCode" : {
"description" : "The code of the account holder.",
@@ -2712,6 +2731,7 @@
"type" : "object"
},
"DeleteShareholderRequest" : {
"additionalProperties" : false,
"properties" : {
"accountHolderCode" : {
"description" : "The code of the Account Holder from which to delete the Shareholders.",
@@ -2732,6 +2752,7 @@
"type" : "object"
},
"DeleteSignatoriesRequest" : {
"additionalProperties" : false,
"properties" : {
"accountHolderCode" : {
"description" : "The code of the account holder from which to delete the signatories.",
@@ -2752,6 +2773,7 @@
"type" : "object"
},
"DocumentDetail" : {
"additionalProperties" : false,
"properties" : {
"accountHolderCode" : {
"x-addedInVersion" : "2",
@@ -2811,6 +2833,7 @@
}
},
"ErrorFieldType" : {
"additionalProperties" : false,
"properties" : {
"errorCode" : {
"description" : "The validation error code.",
@@ -2836,6 +2859,7 @@
}
},
"FieldType" : {
"additionalProperties" : false,
"properties" : {
"field" : {
"description" : "The full name of the property.",
@@ -3021,6 +3045,7 @@
}
},
"GenericResponse" : {
"additionalProperties" : false,
"properties" : {
"pspReference" : {
"description" : "The reference of a request. Can be used to uniquely identify the request.",
@@ -3038,6 +3063,7 @@
"type" : "object"
},
"GetAccountHolderRequest" : {
"additionalProperties" : false,
"properties" : {
"accountCode" : {
"description" : "The code of the account of which to retrieve the details.\n> Required if no `accountHolderCode` is provided.",
@@ -3051,6 +3077,7 @@
"type" : "object"
},
"GetAccountHolderResponse" : {
"additionalProperties" : false,
"properties" : {
"accountHolderCode" : {
"description" : "The code of the account holder.",
@@ -3102,6 +3129,7 @@
"type" : "object"
},
"GetAccountHolderStatusResponse" : {
"additionalProperties" : false,
"properties" : {
"accountHolderCode" : {
"description" : "The code of the Account Holder.",
@@ -3128,6 +3156,7 @@
"type" : "object"
},
"GetTaxFormRequest" : {
"additionalProperties" : false,
"properties" : {
"accountHolderCode" : {
"description" : "The account holder code you provided when you created the account holder.",
@@ -3151,6 +3180,7 @@
"type" : "object"
},
"GetTaxFormResponse" : {
"additionalProperties" : false,
"properties" : {
"content" : {
"description" : "The content of the tax form in the Base64 binary format.",
@@ -3177,6 +3207,7 @@
"type" : "object"
},
"GetUploadedDocumentsRequest" : {
"additionalProperties" : false,
"properties" : {
"accountHolderCode" : {
"description" : "The code of the Account Holder for which to retrieve the documents.",
@@ -3198,6 +3229,7 @@
"type" : "object"
},
"GetUploadedDocumentsResponse" : {
"additionalProperties" : false,
"properties" : {
"documentDetails" : {
"description" : "A list of the documents and their details.",
@@ -3222,6 +3254,7 @@
"type" : "object"
},
"IndividualDetails" : {
"additionalProperties" : false,
"properties" : {
"name" : {
"description" : "The name of the individual.\n>Make sure your account holder registers using the name shown on their Photo ID.",
@@ -3235,6 +3268,7 @@
"type" : "object"
},
"KYCBankAccountCheckResult" : {
"additionalProperties" : false,
"properties" : {
"bankAccountUUID" : {
"description" : "The unique ID of the bank account to which the check applies.",
@@ -3251,6 +3285,7 @@
"type" : "object"
},
"KYCCheckResult" : {
"additionalProperties" : false,
"properties" : {
"checks" : {
"description" : "A list of the checks and their statuses.",
@@ -3263,6 +3298,7 @@
"type" : "object"
},
"KYCCheckStatusData" : {
"additionalProperties" : false,
"properties" : {
"requiredFields" : {
"description" : "A list of the fields required for execution of the check.",
@@ -3313,6 +3349,7 @@
"type" : "object"
},
"KYCCheckSummary" : {
"additionalProperties" : false,
"properties" : {
"code" : {
"description" : "The code of the check.",
@@ -3330,6 +3367,7 @@
"type" : "object"
},
"KYCShareholderCheckResult" : {
"additionalProperties" : false,
"properties" : {
"checks" : {
"description" : "A list of the checks and their statuses.",
@@ -3346,6 +3384,7 @@
"type" : "object"
},
"KYCSignatoryCheckResult" : {
"additionalProperties" : false,
"properties" : {
"checks" : {
"description" : "A list of the checks and their statuses.",
@@ -3362,6 +3401,7 @@
"type" : "object"
},
"KYCVerificationResult" : {
"additionalProperties" : false,
"properties" : {
"accountHolder" : {
"description" : "The results of the checks on the account holder.",
@@ -3392,6 +3432,7 @@
"type" : "object"
},
"LegalArrangementRequest" : {
"additionalProperties" : false,
"properties" : {
"legalArrangementCode" : {
"description" : "The code of the legal arrangement to be deleted. If you also send `legalArrangementEntityCodes`, only the entities listed will be deleted.",
@@ -3418,6 +3459,7 @@
}
},
"PayoutScheduleResponse" : {
"additionalProperties" : false,
"properties" : {
"nextScheduledPayout" : {
"description" : "The date of the next scheduled payout.",
@@ -3449,6 +3491,7 @@
"type" : "object"
},
"PersonalDocumentData" : {
"additionalProperties" : false,
"properties" : {
"expirationDate" : {
"description" : "The expiry date of the document, \n in ISO-8601 YYYY-MM-DD format. For example, **2000-01-31**.",
@@ -3493,6 +3536,7 @@
}
},
"ServiceError" : {
"additionalProperties" : false,
"properties" : {
"errorCode" : {
"description" : "The error code mapped to the error message.",
@@ -3519,6 +3563,7 @@
"type" : "object"
},
"ShareholderContact" : {
"additionalProperties" : false,
"properties" : {
"address" : {
"description" : "The address of the person.",
@@ -3576,6 +3621,7 @@
}
},
"SignatoryContact" : {
"additionalProperties" : false,
"properties" : {
"address" : {
"description" : "The address of the person.",
@@ -3628,6 +3674,7 @@
}
},
"SuspendAccountHolderRequest" : {
"additionalProperties" : false,
"properties" : {
"accountHolderCode" : {
"description" : "The code of the account holder to be suspended.",
@@ -3640,6 +3687,7 @@
"type" : "object"
},
"SuspendAccountHolderResponse" : {
"additionalProperties" : false,
"properties" : {
"accountHolderStatus" : {
"description" : "The new status of the Account Holder.",
@@ -3661,6 +3709,7 @@
"type" : "object"
},
"UltimateParentCompany" : {
"additionalProperties" : false,
"properties" : {
"address" : {
"description" : "Address of the ultimate parent company.",
@@ -3678,6 +3727,7 @@
"type" : "object"
},
"UltimateParentCompanyBusinessDetails" : {
"additionalProperties" : false,
"properties" : {
"legalBusinessName" : {
"description" : "The legal name of the company.",
@@ -3710,6 +3760,7 @@
}
},
"UnSuspendAccountHolderRequest" : {
"additionalProperties" : false,
"properties" : {
"accountHolderCode" : {
"description" : "The code of the account holder to be reinstated.",
@@ -3722,6 +3773,7 @@
"type" : "object"
},
"UnSuspendAccountHolderResponse" : {
"additionalProperties" : false,
"properties" : {
"accountHolderStatus" : {
"description" : "The new status of the Account Holder.",
@@ -3743,6 +3795,7 @@
"type" : "object"
},
"UpdateAccountHolderRequest" : {
"additionalProperties" : false,
"properties" : {
"accountHolderCode" : {
"description" : "The code of the Account Holder to be updated.",
@@ -3765,6 +3818,7 @@
"type" : "object"
},
"UpdateAccountHolderResponse" : {
"additionalProperties" : false,
"properties" : {
"accountHolderCode" : {
"description" : "The code of the account holder.",
@@ -3815,6 +3869,7 @@
"type" : "object"
},
"UpdateAccountHolderStateRequest" : {
"additionalProperties" : false,
"properties" : {
"accountHolderCode" : {
"description" : "The code of the Account Holder on which to update the state.",
@@ -3849,6 +3904,7 @@
"type" : "object"
},
"UpdateAccountRequest" : {
"additionalProperties" : false,
"properties" : {
"accountCode" : {
"description" : "The code of the account to update.",
@@ -3866,6 +3922,7 @@
"type" : "object"
},
"UpdateAccountResponse" : {
"additionalProperties" : false,
"properties" : {
"accountCode" : {
"description" : "The code of the account.",
@@ -3894,6 +3951,7 @@
"type" : "object"
},
"UpdatePayoutScheduleRequest" : {
"additionalProperties" : false,
"properties" : {
"action" : {
"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.",
@@ -3936,6 +3994,7 @@
"type" : "object"
},
"UploadDocumentRequest" : {
"additionalProperties" : false,
"properties" : {
"accountHolderCode" : {
"deprecated" : true,
@@ -3969,6 +4028,7 @@
"type" : "object"
},
"ViasAddress" : {
"additionalProperties" : false,
"properties" : {
"city" : {
"description" : "The name of the city. Required if the `houseNumberOrName`, `street`, `postalCode`, or `stateOrProvince` are provided.",
@@ -4001,6 +4061,7 @@
"type" : "object"
},
"ViasName" : {
"additionalProperties" : false,
"properties" : {
"firstName" : {
"description" : "The first name.",
@@ -4031,6 +4092,7 @@
"type" : "object"
},
"ViasPersonalData" : {
"additionalProperties" : false,
"properties" : {
"dateOfBirth" : {
"description" : "The person's date of birth, in ISO-8601 YYYY-MM-DD format. For example, **2000-01-31**.",
@@ -4061,6 +4123,7 @@
"type" : "object"
},
"ViasPhoneNumber" : {
"additionalProperties" : false,
"properties" : {
"phoneCountryCode" : {
"description" : "The two-character country code of the phone number.\n>The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL').",

63
json/AccountService-v4.json
View File

@@ -2057,6 +2057,7 @@
"components" : {
"schemas" : {
"Account" : {
"additionalProperties" : false,
"properties" : {
"accountCode" : {
"description" : "The code of the account.",
@@ -2088,6 +2089,7 @@
"type" : "object"
},
"AccountEvent" : {
"additionalProperties" : false,
"properties" : {
"event" : {
"description" : "The event.\n>Permitted values: `InactivateAccount`, `RefundNotPaidOutTransfers`.\nFor more information, refer to [Verification checks](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process).",
@@ -2117,6 +2119,7 @@
}
},
"AccountHolderDetails" : {
"additionalProperties" : false,
"properties" : {
"address" : {
"description" : "The address of the account holder.",
@@ -2175,6 +2178,7 @@
"type" : "object"
},
"AccountHolderStatus" : {
"additionalProperties" : false,
"properties" : {
"events" : {
"description" : "A list of events scheduled for the account holder.",
@@ -2212,6 +2216,7 @@
"type" : "object"
},
"AccountPayoutState" : {
"additionalProperties" : false,
"properties" : {
"allowPayout" : {
"description" : "Indicates whether payouts are allowed. This field is the overarching payout status, and is the aggregate of multiple conditions (e.g., KYC status, disabled flag, etc). If this field is false, no payouts will be permitted for any of the account holder's accounts. If this field is true, payouts will be permitted for any of the account holder's accounts.",
@@ -2239,6 +2244,7 @@
"type" : "object"
},
"AccountProcessingState" : {
"additionalProperties" : false,
"properties" : {
"disableReason" : {
"description" : "The reason why processing has been disabled.",
@@ -2273,6 +2279,7 @@
}
},
"Amount" : {
"additionalProperties" : false,
"properties" : {
"currency" : {
"description" : "The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes).",
@@ -2293,6 +2300,7 @@
"type" : "object"
},
"BankAccountDetail" : {
"additionalProperties" : false,
"properties" : {
"accountNumber" : {
"description" : "The bank account number (without separators).\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.",
@@ -2406,6 +2414,7 @@
}
},
"BusinessDetails" : {
"additionalProperties" : false,
"properties" : {
"doingBusinessAs" : {
"description" : "The registered name of the company (if it differs from the legal name of the company).",
@@ -2449,6 +2458,7 @@
"type" : "object"
},
"CloseAccountHolderRequest" : {
"additionalProperties" : false,
"properties" : {
"accountHolderCode" : {
"description" : "The code of the Account Holder to be closed.",
@@ -2461,6 +2471,7 @@
"type" : "object"
},
"CloseAccountHolderResponse" : {
"additionalProperties" : false,
"properties" : {
"accountHolderStatus" : {
"description" : "The new status of the Account Holder.",
@@ -2482,6 +2493,7 @@
"type" : "object"
},
"CloseAccountRequest" : {
"additionalProperties" : false,
"properties" : {
"accountCode" : {
"description" : "The code of account to be closed.",
@@ -2494,6 +2506,7 @@
"type" : "object"
},
"CloseAccountResponse" : {
"additionalProperties" : false,
"properties" : {
"pspReference" : {
"description" : "The reference of a request. Can be used to uniquely identify the request.",
@@ -2522,6 +2535,7 @@
"type" : "object"
},
"CreateAccountHolderRequest" : {
"additionalProperties" : false,
"properties" : {
"accountHolderCode" : {
"description" : "Your unique identifier for the prospective account holder.\nThe length must be between three (3) and fifty (50) characters long. Only letters, digits, and hyphens (-) are allowed.",
@@ -2570,6 +2584,7 @@
"type" : "object"
},
"CreateAccountHolderResponse" : {
"additionalProperties" : false,
"properties" : {
"accountCode" : {
"description" : "The code of a new account created for the account holder.",
@@ -2632,6 +2647,7 @@
"type" : "object"
},
"CreateAccountRequest" : {
"additionalProperties" : false,
"properties" : {
"accountHolderCode" : {
"description" : "The code of Account Holder under which to create the account.",
@@ -2674,6 +2690,7 @@
"type" : "object"
},
"CreateAccountResponse" : {
"additionalProperties" : false,
"properties" : {
"accountCode" : {
"description" : "The code of the new account.",
@@ -2719,6 +2736,7 @@
"type" : "object"
},
"DeleteBankAccountRequest" : {
"additionalProperties" : false,
"properties" : {
"accountHolderCode" : {
"description" : "The code of the Account Holder from which to delete the Bank Account(s).",
@@ -2739,6 +2757,7 @@
"type" : "object"
},
"DeleteLegalArrangementRequest" : {
"additionalProperties" : false,
"properties" : {
"accountHolderCode" : {
"description" : "The code of the account holder.",
@@ -2759,6 +2778,7 @@
"type" : "object"
},
"DeleteShareholderRequest" : {
"additionalProperties" : false,
"properties" : {
"accountHolderCode" : {
"description" : "The code of the Account Holder from which to delete the Shareholders.",
@@ -2779,6 +2799,7 @@
"type" : "object"
},
"DeleteSignatoriesRequest" : {
"additionalProperties" : false,
"properties" : {
"accountHolderCode" : {
"description" : "The code of the account holder from which to delete the signatories.",
@@ -2799,6 +2820,7 @@
"type" : "object"
},
"DocumentDetail" : {
"additionalProperties" : false,
"properties" : {
"accountHolderCode" : {
"x-addedInVersion" : "2",
@@ -2858,6 +2880,7 @@
}
},
"ErrorFieldType" : {
"additionalProperties" : false,
"properties" : {
"errorCode" : {
"description" : "The validation error code.",
@@ -2883,6 +2906,7 @@
}
},
"FieldType" : {
"additionalProperties" : false,
"properties" : {
"field" : {
"description" : "The full name of the property.",
@@ -3072,6 +3096,7 @@
}
},
"GenericResponse" : {
"additionalProperties" : false,
"properties" : {
"pspReference" : {
"description" : "The reference of a request. Can be used to uniquely identify the request.",
@@ -3089,6 +3114,7 @@
"type" : "object"
},
"GetAccountHolderRequest" : {
"additionalProperties" : false,
"properties" : {
"accountCode" : {
"description" : "The code of the account of which to retrieve the details.\n> Required if no `accountHolderCode` is provided.",
@@ -3107,6 +3133,7 @@
"type" : "object"
},
"GetAccountHolderResponse" : {
"additionalProperties" : false,
"properties" : {
"accountHolderCode" : {
"description" : "The code of the account holder.",
@@ -3168,6 +3195,7 @@
"type" : "object"
},
"GetAccountHolderStatusResponse" : {
"additionalProperties" : false,
"properties" : {
"accountHolderCode" : {
"description" : "The code of the Account Holder.",
@@ -3194,6 +3222,7 @@
"type" : "object"
},
"GetTaxFormRequest" : {
"additionalProperties" : false,
"properties" : {
"accountHolderCode" : {
"description" : "The account holder code you provided when you created the account holder.",
@@ -3217,6 +3246,7 @@
"type" : "object"
},
"GetTaxFormResponse" : {
"additionalProperties" : false,
"properties" : {
"content" : {
"description" : "The content of the tax form in the Base64 binary format.",
@@ -3243,6 +3273,7 @@
"type" : "object"
},
"GetUploadedDocumentsRequest" : {
"additionalProperties" : false,
"properties" : {
"accountHolderCode" : {
"description" : "The code of the Account Holder for which to retrieve the documents.",
@@ -3264,6 +3295,7 @@
"type" : "object"
},
"GetUploadedDocumentsResponse" : {
"additionalProperties" : false,
"properties" : {
"documentDetails" : {
"description" : "A list of the documents and their details.",
@@ -3288,6 +3320,7 @@
"type" : "object"
},
"IndividualDetails" : {
"additionalProperties" : false,
"properties" : {
"name" : {
"description" : "The name of the individual.\n>Make sure your account holder registers using the name shown on their Photo ID.",
@@ -3301,6 +3334,7 @@
"type" : "object"
},
"KYCBankAccountCheckResult" : {
"additionalProperties" : false,
"properties" : {
"bankAccountUUID" : {
"description" : "The unique ID of the bank account to which the check applies.",
@@ -3317,6 +3351,7 @@
"type" : "object"
},
"KYCCheckResult" : {
"additionalProperties" : false,
"properties" : {
"checks" : {
"description" : "A list of the checks and their statuses.",
@@ -3329,6 +3364,7 @@
"type" : "object"
},
"KYCCheckStatusData" : {
"additionalProperties" : false,
"properties" : {
"requiredFields" : {
"description" : "A list of the fields required for execution of the check.",
@@ -3379,6 +3415,7 @@
"type" : "object"
},
"KYCCheckSummary" : {
"additionalProperties" : false,
"properties" : {
"code" : {
"description" : "The code of the check.",
@@ -3396,6 +3433,7 @@
"type" : "object"
},
"KYCShareholderCheckResult" : {
"additionalProperties" : false,
"properties" : {
"checks" : {
"description" : "A list of the checks and their statuses.",
@@ -3412,6 +3450,7 @@
"type" : "object"
},
"KYCSignatoryCheckResult" : {
"additionalProperties" : false,
"properties" : {
"checks" : {
"description" : "A list of the checks and their statuses.",
@@ -3428,6 +3467,7 @@
"type" : "object"
},
"KYCVerificationResult" : {
"additionalProperties" : false,
"properties" : {
"accountHolder" : {
"description" : "The results of the checks on the account holder.",
@@ -3458,6 +3498,7 @@
"type" : "object"
},
"LegalArrangementRequest" : {
"additionalProperties" : false,
"properties" : {
"legalArrangementCode" : {
"description" : "The code of the legal arrangement to be deleted. If you also send `legalArrangementEntityCodes`, only the entities listed will be deleted.",
@@ -3484,6 +3525,7 @@
}
},
"PayoutScheduleResponse" : {
"additionalProperties" : false,
"properties" : {
"nextScheduledPayout" : {
"description" : "The date of the next scheduled payout.",
@@ -3515,6 +3557,7 @@
"type" : "object"
},
"PersonalDocumentData" : {
"additionalProperties" : false,
"properties" : {
"expirationDate" : {
"description" : "The expiry date of the document, \n in ISO-8601 YYYY-MM-DD format. For example, **2000-01-31**.",
@@ -3559,6 +3602,7 @@
}
},
"ServiceError" : {
"additionalProperties" : false,
"properties" : {
"errorCode" : {
"description" : "The error code mapped to the error message.",
@@ -3585,6 +3629,7 @@
"type" : "object"
},
"ShareholderContact" : {
"additionalProperties" : false,
"properties" : {
"address" : {
"description" : "The address of the person.",
@@ -3642,6 +3687,7 @@
}
},
"SignatoryContact" : {
"additionalProperties" : false,
"properties" : {
"address" : {
"description" : "The address of the person.",
@@ -3694,6 +3740,7 @@
}
},
"SuspendAccountHolderRequest" : {
"additionalProperties" : false,
"properties" : {
"accountHolderCode" : {
"description" : "The code of the account holder to be suspended.",
@@ -3706,6 +3753,7 @@
"type" : "object"
},
"SuspendAccountHolderResponse" : {
"additionalProperties" : false,
"properties" : {
"accountHolderStatus" : {
"description" : "The new status of the Account Holder.",
@@ -3727,6 +3775,7 @@
"type" : "object"
},
"UltimateParentCompany" : {
"additionalProperties" : false,
"properties" : {
"address" : {
"description" : "Address of the ultimate parent company.",
@@ -3744,6 +3793,7 @@
"type" : "object"
},
"UltimateParentCompanyBusinessDetails" : {
"additionalProperties" : false,
"properties" : {
"legalBusinessName" : {
"description" : "The legal name of the company.",
@@ -3776,6 +3826,7 @@
}
},
"UnSuspendAccountHolderRequest" : {
"additionalProperties" : false,
"properties" : {
"accountHolderCode" : {
"description" : "The code of the account holder to be reinstated.",
@@ -3788,6 +3839,7 @@
"type" : "object"
},
"UnSuspendAccountHolderResponse" : {
"additionalProperties" : false,
"properties" : {
"accountHolderStatus" : {
"description" : "The new status of the Account Holder.",
@@ -3809,6 +3861,7 @@
"type" : "object"
},
"UpdateAccountHolderRequest" : {
"additionalProperties" : false,
"properties" : {
"accountHolderCode" : {
"description" : "The code of the Account Holder to be updated.",
@@ -3842,6 +3895,7 @@
"type" : "object"
},
"UpdateAccountHolderResponse" : {
"additionalProperties" : false,
"properties" : {
"accountHolderCode" : {
"description" : "The code of the account holder.",
@@ -3907,6 +3961,7 @@
"type" : "object"
},
"UpdateAccountHolderStateRequest" : {
"additionalProperties" : false,
"properties" : {
"accountHolderCode" : {
"description" : "The code of the Account Holder on which to update the state.",
@@ -3941,6 +3996,7 @@
"type" : "object"
},
"UpdateAccountRequest" : {
"additionalProperties" : false,
"properties" : {
"accountCode" : {
"description" : "The code of the account to update.",
@@ -3962,6 +4018,7 @@
"type" : "object"
},
"UpdateAccountResponse" : {
"additionalProperties" : false,
"properties" : {
"accountCode" : {
"description" : "The code of the account.",
@@ -3995,6 +4052,7 @@
"type" : "object"
},
"UpdatePayoutScheduleRequest" : {
"additionalProperties" : false,
"properties" : {
"action" : {
"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.",
@@ -4037,6 +4095,7 @@
"type" : "object"
},
"UploadDocumentRequest" : {
"additionalProperties" : false,
"properties" : {
"accountHolderCode" : {
"deprecated" : true,
@@ -4070,6 +4129,7 @@
"type" : "object"
},
"ViasAddress" : {
"additionalProperties" : false,
"properties" : {
"city" : {
"description" : "The name of the city. Required if the `houseNumberOrName`, `street`, `postalCode`, or `stateOrProvince` are provided.",
@@ -4102,6 +4162,7 @@
"type" : "object"
},
"ViasName" : {
"additionalProperties" : false,
"properties" : {
"firstName" : {
"description" : "The first name.",
@@ -4132,6 +4193,7 @@
"type" : "object"
},
"ViasPersonalData" : {
"additionalProperties" : false,
"properties" : {
"dateOfBirth" : {
"description" : "The person's date of birth, in ISO-8601 YYYY-MM-DD format. For example, **2000-01-31**.",
@@ -4162,6 +4224,7 @@
"type" : "object"
},
"ViasPhoneNumber" : {
"additionalProperties" : false,
"properties" : {
"phoneCountryCode" : {
"description" : "The two-character country code of the phone number.\n>The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL').",

73
json/AccountService-v5.json
View File

@@ -2399,6 +2399,7 @@
"components" : {
"schemas" : {
"Account" : {
"additionalProperties" : false,
"properties" : {
"accountCode" : {
"description" : "The code of the account.",
@@ -2458,6 +2459,7 @@
"type" : "object"
},
"AccountEvent" : {
"additionalProperties" : false,
"properties" : {
"event" : {
"description" : "The event.\n>Permitted values: `InactivateAccount`, `RefundNotPaidOutTransfers`.\nFor more information, refer to [Verification checks](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process).",
@@ -2480,6 +2482,7 @@
"type" : "object"
},
"AccountHolderDetails" : {
"additionalProperties" : false,
"properties" : {
"address" : {
"description" : "The address of the account holder.",
@@ -2559,6 +2562,7 @@
"type" : "object"
},
"AccountHolderStatus" : {
"additionalProperties" : false,
"properties" : {
"events" : {
"description" : "A list of events scheduled for the account holder.",
@@ -2596,6 +2600,7 @@
"type" : "object"
},
"AccountPayoutState" : {
"additionalProperties" : false,
"properties" : {
"allowPayout" : {
"description" : "Indicates whether payouts are allowed. This field is the overarching payout status, and is the aggregate of multiple conditions (e.g., KYC status, disabled flag, etc). If this field is false, no payouts will be permitted for any of the account holder's accounts. If this field is true, payouts will be permitted for any of the account holder's accounts.",
@@ -2628,6 +2633,7 @@
"type" : "object"
},
"AccountProcessingState" : {
"additionalProperties" : false,
"properties" : {
"disableReason" : {
"description" : "The reason why processing has been disabled.",
@@ -2655,6 +2661,7 @@
"type" : "object"
},
"Amount" : {
"additionalProperties" : false,
"properties" : {
"currency" : {
"description" : "The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes).",
@@ -2675,6 +2682,7 @@
"type" : "object"
},
"BankAccountDetail" : {
"additionalProperties" : false,
"properties" : {
"accountNumber" : {
"description" : "The bank account number (without separators).\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.",
@@ -2786,6 +2794,7 @@
"type" : "object"
},
"BusinessDetails" : {
"additionalProperties" : false,
"properties" : {
"doingBusinessAs" : {
"description" : "The registered name of the company (if it differs from the legal name of the company).",
@@ -2829,6 +2838,7 @@
"type" : "object"
},
"CloseAccountHolderRequest" : {
"additionalProperties" : false,
"properties" : {
"accountHolderCode" : {
"description" : "The code of the Account Holder to be closed.",
@@ -2841,6 +2851,7 @@
"type" : "object"
},
"CloseAccountHolderResponse" : {
"additionalProperties" : false,
"properties" : {
"accountHolderStatus" : {
"description" : "The new status of the Account Holder.",
@@ -2866,6 +2877,7 @@
"type" : "object"
},
"CloseAccountRequest" : {
"additionalProperties" : false,
"properties" : {
"accountCode" : {
"description" : "The code of account to be closed.",
@@ -2878,6 +2890,7 @@
"type" : "object"
},
"CloseAccountResponse" : {
"additionalProperties" : false,
"properties" : {
"accountCode" : {
"x-addedInVersion" : "5",
@@ -2915,6 +2928,7 @@
"type" : "object"
},
"CloseStoresRequest" : {
"additionalProperties" : false,
"properties" : {
"accountHolderCode" : {
"description" : "The code of the account holder.",
@@ -2935,6 +2949,7 @@
"type" : "object"
},
"CreateAccountHolderRequest" : {
"additionalProperties" : false,
"properties" : {
"accountHolderCode" : {
"description" : "Your unique identifier for the prospective account holder.\nThe length must be between three (3) and fifty (50) characters long. Only letters, digits, and hyphens (-) are allowed.",
@@ -2983,6 +2998,7 @@
"type" : "object"
},
"CreateAccountHolderResponse" : {
"additionalProperties" : false,
"properties" : {
"accountCode" : {
"description" : "The code of a new account created for the account holder.",
@@ -3047,6 +3063,7 @@
"type" : "object"
},
"CreateAccountRequest" : {
"additionalProperties" : false,
"properties" : {
"accountHolderCode" : {
"description" : "The code of Account Holder under which to create the account.",
@@ -3118,6 +3135,7 @@
"type" : "object"
},
"CreateAccountResponse" : {
"additionalProperties" : false,
"properties" : {
"accountCode" : {
"description" : "The code of the new account.",
@@ -3195,6 +3213,7 @@
"type" : "object"
},
"DeleteBankAccountRequest" : {
"additionalProperties" : false,
"properties" : {
"accountHolderCode" : {
"description" : "The code of the Account Holder from which to delete the Bank Account(s).",
@@ -3215,6 +3234,7 @@
"type" : "object"
},
"DeleteLegalArrangementRequest" : {
"additionalProperties" : false,
"properties" : {
"accountHolderCode" : {
"description" : "The code of the account holder.",
@@ -3235,6 +3255,7 @@
"type" : "object"
},
"DeletePayoutMethodRequest" : {
"additionalProperties" : false,
"properties" : {
"accountHolderCode" : {
"description" : "The code of the account holder, from which to delete the payout methods.",
@@ -3255,6 +3276,7 @@
"type" : "object"
},
"DeleteShareholderRequest" : {
"additionalProperties" : false,
"properties" : {
"accountHolderCode" : {
"description" : "The code of the Account Holder from which to delete the Shareholders.",
@@ -3275,6 +3297,7 @@
"type" : "object"
},
"DeleteSignatoriesRequest" : {
"additionalProperties" : false,
"properties" : {
"accountHolderCode" : {
"description" : "The code of the account holder from which to delete the signatories.",
@@ -3295,6 +3318,7 @@
"type" : "object"
},
"DocumentDetail" : {
"additionalProperties" : false,
"properties" : {
"accountHolderCode" : {
"x-addedInVersion" : "2",
@@ -3349,6 +3373,7 @@
"type" : "object"
},
"ErrorFieldType" : {
"additionalProperties" : false,
"properties" : {
"errorCode" : {
"description" : "The validation error code.",
@@ -3367,6 +3392,7 @@
"type" : "object"
},
"FieldType" : {
"additionalProperties" : false,
"properties" : {
"field" : {
"description" : "The full name of the property.",
@@ -3549,6 +3575,7 @@
"type" : "object"
},
"GenericResponse" : {
"additionalProperties" : false,
"properties" : {
"invalidFields" : {
"x-addedInVersion" : "5",
@@ -3570,6 +3597,7 @@
"type" : "object"
},
"GetAccountHolderRequest" : {
"additionalProperties" : false,
"properties" : {
"accountCode" : {
"description" : "The code of the account of which to retrieve the details.\n> Required if no `accountHolderCode` is provided.",
@@ -3588,6 +3616,7 @@
"type" : "object"
},
"GetAccountHolderResponse" : {
"additionalProperties" : false,
"properties" : {
"accountHolderCode" : {
"description" : "The code of the account holder.",
@@ -3664,6 +3693,7 @@
"type" : "object"
},
"GetAccountHolderStatusResponse" : {
"additionalProperties" : false,
"properties" : {
"accountHolderCode" : {
"description" : "The code of the Account Holder.",
@@ -3694,6 +3724,7 @@
"type" : "object"
},
"GetTaxFormRequest" : {
"additionalProperties" : false,
"properties" : {
"accountHolderCode" : {
"description" : "The account holder code you provided when you created the account holder.",
@@ -3717,6 +3748,7 @@
"type" : "object"
},
"GetTaxFormResponse" : {
"additionalProperties" : false,
"properties" : {
"content" : {
"description" : "The content of the tax form in the Base64 binary format.",
@@ -3747,6 +3779,7 @@
"type" : "object"
},
"GetUploadedDocumentsRequest" : {
"additionalProperties" : false,
"properties" : {
"accountHolderCode" : {
"description" : "The code of the Account Holder for which to retrieve the documents.",
@@ -3768,6 +3801,7 @@
"type" : "object"
},
"GetUploadedDocumentsResponse" : {
"additionalProperties" : false,
"properties" : {
"documentDetails" : {
"description" : "A list of the documents and their details.",
@@ -3796,6 +3830,7 @@
"type" : "object"
},
"IndividualDetails" : {
"additionalProperties" : false,
"properties" : {
"name" : {
"description" : "The name of the individual.\n>Make sure your account holder registers using the name shown on their Photo ID.",
@@ -3809,6 +3844,7 @@
"type" : "object"
},
"KYCBankAccountCheckResult" : {
"additionalProperties" : false,
"properties" : {
"bankAccountUUID" : {
"description" : "The unique ID of the bank account to which the check applies.",
@@ -3825,6 +3861,7 @@
"type" : "object"
},
"KYCCardCheckResult" : {
"additionalProperties" : false,
"properties" : {
"checks" : {
"description" : "A list of the checks and their statuses.",
@@ -3841,6 +3878,7 @@
"type" : "object"
},
"KYCCheckResult" : {
"additionalProperties" : false,
"properties" : {
"checks" : {
"description" : "A list of the checks and their statuses.",
@@ -3853,6 +3891,7 @@
"type" : "object"
},
"KYCCheckStatusData" : {
"additionalProperties" : false,
"properties" : {
"requiredFields" : {
"description" : "A list of the fields required for execution of the check.",
@@ -3903,6 +3942,7 @@
"type" : "object"
},
"KYCCheckSummary" : {
"additionalProperties" : false,
"properties" : {
"kycCheckCode" : {
"x-addedInVersion" : "5",
@@ -3919,6 +3959,7 @@
"type" : "object"
},
"KYCShareholderCheckResult" : {
"additionalProperties" : false,
"properties" : {
"checks" : {
"description" : "A list of the checks and their statuses.",
@@ -3935,6 +3976,7 @@
"type" : "object"
},
"KYCSignatoryCheckResult" : {
"additionalProperties" : false,
"properties" : {
"checks" : {
"description" : "A list of the checks and their statuses.",
@@ -3951,6 +3993,7 @@
"type" : "object"
},
"KYCVerificationResult" : {
"additionalProperties" : false,
"properties" : {
"accountHolder" : {
"description" : "The results of the checks on the account holder.",
@@ -3989,6 +4032,7 @@
"type" : "object"
},
"LegalArrangementRequest" : {
"additionalProperties" : false,
"properties" : {
"legalArrangementCode" : {
"description" : "The code of the legal arrangement to be deleted. If you also send `legalArrangementEntityCodes`, only the entities listed will be deleted.",
@@ -4008,6 +4052,7 @@
"type" : "object"
},
"MigratedAccounts" : {
"additionalProperties" : false,
"properties" : {
"accountCode" : {
"description" : "The unique identifier of the account of the migrated account holder in the classic integration.",
@@ -4021,6 +4066,7 @@
"type" : "object"
},
"MigratedShareholders" : {
"additionalProperties" : false,
"properties" : {
"legalEntityCode" : {
"description" : "The unique identifier of the legal entity of that shareholder in the balance platform.",
@@ -4034,6 +4080,7 @@
"type" : "object"
},
"MigratedStores" : {
"additionalProperties" : false,
"properties" : {
"businessLineId" : {
"description" : "The unique identifier of the business line associated with the migrated account holder in the balance platform.",
@@ -4055,6 +4102,7 @@
"type" : "object"
},
"MigrationData" : {
"additionalProperties" : false,
"properties" : {
"accountHolderId" : {
"description" : "The unique identifier of the account holder in the balance platform.",
@@ -4098,6 +4146,7 @@
"type" : "object"
},
"PayoutMethod" : {
"additionalProperties" : false,
"properties" : {
"merchantAccount" : {
"description" : "The [`merchantAccount`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__reqParam_merchantAccount) you used in the `/payments` request when you [saved the account holder's card details](https://docs.adyen.com/marketplaces-and-platforms/classic/payouts/manual-payout/payout-to-cards#check-and-store).",
@@ -4128,6 +4177,7 @@
"type" : "object"
},
"PayoutScheduleResponse" : {
"additionalProperties" : false,
"properties" : {
"nextScheduledPayout" : {
"description" : "The date of the next scheduled payout.",
@@ -4159,6 +4209,7 @@
"type" : "object"
},
"PerformVerificationRequest" : {
"additionalProperties" : false,
"properties" : {
"accountHolderCode" : {
"description" : "The code of the account holder to verify.",
@@ -4190,6 +4241,7 @@
"type" : "object"
},
"PersonalDocumentData" : {
"additionalProperties" : false,
"properties" : {
"expirationDate" : {
"description" : "The expiry date of the document, \n in ISO-8601 YYYY-MM-DD format. For example, **2000-01-31**.",
@@ -4227,6 +4279,7 @@
"type" : "object"
},
"ServiceError" : {
"additionalProperties" : false,
"properties" : {
"errorCode" : {
"description" : "The error code mapped to the error message.",
@@ -4253,6 +4306,7 @@
"type" : "object"
},
"ShareholderContact" : {
"additionalProperties" : false,
"properties" : {
"address" : {
"description" : "The address of the person.",
@@ -4308,6 +4362,7 @@
"type" : "object"
},
"SignatoryContact" : {
"additionalProperties" : false,
"properties" : {
"address" : {
"description" : "The address of the person.",
@@ -4353,6 +4408,7 @@
"type" : "object"
},
"StoreDetail" : {
"additionalProperties" : false,
"properties" : {
"address" : {
"description" : "The address of the physical store where the account holder will process payments from.",
@@ -4440,6 +4496,7 @@
"type" : "object"
},
"SuspendAccountHolderRequest" : {
"additionalProperties" : false,
"properties" : {
"accountHolderCode" : {
"description" : "The code of the account holder to be suspended.",
@@ -4452,6 +4509,7 @@
"type" : "object"
},
"SuspendAccountHolderResponse" : {
"additionalProperties" : false,
"properties" : {
"accountHolderStatus" : {
"description" : "The new status of the Account Holder.",
@@ -4477,6 +4535,7 @@
"type" : "object"
},
"UltimateParentCompany" : {
"additionalProperties" : false,
"properties" : {
"address" : {
"description" : "Address of the ultimate parent company.",
@@ -4494,6 +4553,7 @@
"type" : "object"
},
"UltimateParentCompanyBusinessDetails" : {
"additionalProperties" : false,
"properties" : {
"legalBusinessName" : {
"description" : "The legal name of the company.",
@@ -4519,6 +4579,7 @@
"type" : "object"
},
"UnSuspendAccountHolderRequest" : {
"additionalProperties" : false,
"properties" : {
"accountHolderCode" : {
"description" : "The code of the account holder to be reinstated.",
@@ -4531,6 +4592,7 @@
"type" : "object"
},
"UnSuspendAccountHolderResponse" : {
"additionalProperties" : false,
"properties" : {
"accountHolderStatus" : {
"description" : "The new status of the Account Holder.",
@@ -4556,6 +4618,7 @@
"type" : "object"
},
"UpdateAccountHolderRequest" : {
"additionalProperties" : false,
"properties" : {
"accountHolderCode" : {
"description" : "The code of the Account Holder to be updated.",
@@ -4599,6 +4662,7 @@
"type" : "object"
},
"UpdateAccountHolderResponse" : {
"additionalProperties" : false,
"properties" : {
"accountHolderCode" : {
"description" : "The code of the account holder.",
@@ -4659,6 +4723,7 @@
"type" : "object"
},
"UpdateAccountHolderStateRequest" : {
"additionalProperties" : false,
"properties" : {
"accountHolderCode" : {
"description" : "The code of the Account Holder on which to update the state.",
@@ -4693,6 +4758,7 @@
"type" : "object"
},
"UpdateAccountRequest" : {
"additionalProperties" : false,
"properties" : {
"accountCode" : {
"description" : "The code of the account to update.",
@@ -4742,6 +4808,7 @@
"type" : "object"
},
"UpdateAccountResponse" : {
"additionalProperties" : false,
"properties" : {
"accountCode" : {
"description" : "The code of the account.",
@@ -4807,6 +4874,7 @@
"type" : "object"
},
"UpdatePayoutScheduleRequest" : {
"additionalProperties" : false,
"properties" : {
"action" : {
"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.",
@@ -4849,6 +4917,7 @@
"type" : "object"
},
"UploadDocumentRequest" : {
"additionalProperties" : false,
"properties" : {
"documentContent" : {
"description" : "The content of the document, in Base64-encoded string format.\n\nTo learn about document requirements, refer to [Verification checks](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-checks).",
@@ -4867,6 +4936,7 @@
"type" : "object"
},
"ViasAddress" : {
"additionalProperties" : false,
"properties" : {
"city" : {
"description" : "The name of the city. Required if the `houseNumberOrName`, `street`, `postalCode`, or `stateOrProvince` are provided.",
@@ -4899,6 +4969,7 @@
"type" : "object"
},
"ViasName" : {
"additionalProperties" : false,
"properties" : {
"firstName" : {
"description" : "The first name.",
@@ -4929,6 +5000,7 @@
"type" : "object"
},
"ViasPersonalData" : {
"additionalProperties" : false,
"properties" : {
"dateOfBirth" : {
"description" : "The person's date of birth, in ISO-8601 YYYY-MM-DD format. For example, **2000-01-31**.",
@@ -4952,6 +5024,7 @@
"type" : "object"
},
"ViasPhoneNumber" : {
"additionalProperties" : false,
"properties" : {
"phoneCountryCode" : {
"description" : "The two-character country code of the phone number.\n>The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL').",

77
json/AccountService-v6.json
View File

@@ -2399,6 +2399,7 @@
"components" : {
"schemas" : {
"Account" : {
"additionalProperties" : false,
"properties" : {
"accountCode" : {
"description" : "The code of the account.",
@@ -2458,6 +2459,7 @@
"type" : "object"
},
"AccountEvent" : {
"additionalProperties" : false,
"properties" : {
"event" : {
"description" : "The event.\n>Permitted values: `InactivateAccount`, `RefundNotPaidOutTransfers`.\nFor more information, refer to [Verification checks](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process).",
@@ -2480,6 +2482,7 @@
"type" : "object"
},
"AccountHolderDetails" : {
"additionalProperties" : false,
"properties" : {
"address" : {
"description" : "The address of the account holder.",
@@ -2567,6 +2570,7 @@
"type" : "object"
},
"AccountHolderStatus" : {
"additionalProperties" : false,
"properties" : {
"events" : {
"description" : "A list of events scheduled for the account holder.",
@@ -2604,6 +2608,7 @@
"type" : "object"
},
"AccountPayoutState" : {
"additionalProperties" : false,
"properties" : {
"allowPayout" : {
"description" : "Indicates whether payouts are allowed. This field is the overarching payout status, and is the aggregate of multiple conditions (e.g., KYC status, disabled flag, etc). If this field is false, no payouts will be permitted for any of the account holder's accounts. If this field is true, payouts will be permitted for any of the account holder's accounts.",
@@ -2636,6 +2641,7 @@
"type" : "object"
},
"AccountProcessingState" : {
"additionalProperties" : false,
"properties" : {
"disableReason" : {
"description" : "The reason why processing has been disabled.",
@@ -2663,6 +2669,7 @@
"type" : "object"
},
"Amount" : {
"additionalProperties" : false,
"properties" : {
"currency" : {
"description" : "The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes).",
@@ -2683,6 +2690,7 @@
"type" : "object"
},
"BankAccountDetail" : {
"additionalProperties" : false,
"properties" : {
"accountNumber" : {
"description" : "The bank account number (without separators).\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.",
@@ -2794,6 +2802,7 @@
"type" : "object"
},
"BusinessDetails" : {
"additionalProperties" : false,
"properties" : {
"doingBusinessAs" : {
"description" : "The registered name of the company (if it differs from the legal name of the company).",
@@ -2852,6 +2861,7 @@
"type" : "object"
},
"CloseAccountHolderRequest" : {
"additionalProperties" : false,
"properties" : {
"accountHolderCode" : {
"description" : "The code of the Account Holder to be closed.",
@@ -2864,6 +2874,7 @@
"type" : "object"
},
"CloseAccountHolderResponse" : {
"additionalProperties" : false,
"properties" : {
"accountHolderStatus" : {
"description" : "The new status of the Account Holder.",
@@ -2889,6 +2900,7 @@
"type" : "object"
},
"CloseAccountRequest" : {
"additionalProperties" : false,
"properties" : {
"accountCode" : {
"description" : "The code of account to be closed.",
@@ -2901,6 +2913,7 @@
"type" : "object"
},
"CloseAccountResponse" : {
"additionalProperties" : false,
"properties" : {
"accountCode" : {
"x-addedInVersion" : "5",
@@ -2938,6 +2951,7 @@
"type" : "object"
},
"CloseStoresRequest" : {
"additionalProperties" : false,
"properties" : {
"accountHolderCode" : {
"description" : "The code of the account holder.",
@@ -2958,6 +2972,7 @@
"type" : "object"
},
"CreateAccountHolderRequest" : {
"additionalProperties" : false,
"properties" : {
"accountHolderCode" : {
"description" : "Your unique identifier for the prospective account holder.\nThe length must be between three (3) and fifty (50) characters long. Only letters, digits, and hyphens (-) are allowed.",
@@ -3013,6 +3028,7 @@
"type" : "object"
},
"CreateAccountHolderResponse" : {
"additionalProperties" : false,
"properties" : {
"accountCode" : {
"description" : "The code of a new account created for the account holder.",
@@ -3084,6 +3100,7 @@
"type" : "object"
},
"CreateAccountRequest" : {
"additionalProperties" : false,
"properties" : {
"accountHolderCode" : {
"description" : "The code of Account Holder under which to create the account.",
@@ -3155,6 +3172,7 @@
"type" : "object"
},
"CreateAccountResponse" : {
"additionalProperties" : false,
"properties" : {
"accountCode" : {
"description" : "The code of the new account.",
@@ -3232,6 +3250,7 @@
"type" : "object"
},
"DeleteBankAccountRequest" : {
"additionalProperties" : false,
"properties" : {
"accountHolderCode" : {
"description" : "The code of the Account Holder from which to delete the Bank Account(s).",
@@ -3252,6 +3271,7 @@
"type" : "object"
},
"DeleteLegalArrangementRequest" : {
"additionalProperties" : false,
"properties" : {
"accountHolderCode" : {
"description" : "The code of the account holder.",
@@ -3272,6 +3292,7 @@
"type" : "object"
},
"DeletePayoutMethodRequest" : {
"additionalProperties" : false,
"properties" : {
"accountHolderCode" : {
"description" : "The code of the account holder, from which to delete the payout methods.",
@@ -3292,6 +3313,7 @@
"type" : "object"
},
"DeleteShareholderRequest" : {
"additionalProperties" : false,
"properties" : {
"accountHolderCode" : {
"description" : "The code of the Account Holder from which to delete the Shareholders.",
@@ -3312,6 +3334,7 @@
"type" : "object"
},
"DeleteSignatoriesRequest" : {
"additionalProperties" : false,
"properties" : {
"accountHolderCode" : {
"description" : "The code of the account holder from which to delete the signatories.",
@@ -3332,6 +3355,7 @@
"type" : "object"
},
"DocumentDetail" : {
"additionalProperties" : false,
"properties" : {
"accountHolderCode" : {
"x-addedInVersion" : "2",
@@ -3397,6 +3421,7 @@
"type" : "object"
},
"ErrorFieldType" : {
"additionalProperties" : false,
"properties" : {
"errorCode" : {
"description" : "The validation error code.",
@@ -3415,6 +3440,7 @@
"type" : "object"
},
"FieldType" : {
"additionalProperties" : false,
"properties" : {
"field" : {
"description" : "The full name of the property.",
@@ -3597,6 +3623,7 @@
"type" : "object"
},
"GenericResponse" : {
"additionalProperties" : false,
"properties" : {
"invalidFields" : {
"x-addedInVersion" : "5",
@@ -3618,6 +3645,7 @@
"type" : "object"
},
"GetAccountHolderRequest" : {
"additionalProperties" : false,
"properties" : {
"accountCode" : {
"description" : "The code of the account of which to retrieve the details.\n> Required if no `accountHolderCode` is provided.",
@@ -3636,6 +3664,7 @@
"type" : "object"
},
"GetAccountHolderResponse" : {
"additionalProperties" : false,
"properties" : {
"accountHolderCode" : {
"description" : "The code of the account holder.",
@@ -3719,6 +3748,7 @@
"type" : "object"
},
"GetAccountHolderStatusResponse" : {
"additionalProperties" : false,
"properties" : {
"accountHolderCode" : {
"description" : "The code of the Account Holder.",
@@ -3749,6 +3779,7 @@
"type" : "object"
},
"GetTaxFormRequest" : {
"additionalProperties" : false,
"properties" : {
"accountHolderCode" : {
"description" : "The account holder code you provided when you created the account holder.",
@@ -3772,6 +3803,7 @@
"type" : "object"
},
"GetTaxFormResponse" : {
"additionalProperties" : false,
"properties" : {
"content" : {
"description" : "The content of the tax form in the Base64 binary format.",
@@ -3802,6 +3834,7 @@
"type" : "object"
},
"GetUploadedDocumentsRequest" : {
"additionalProperties" : false,
"properties" : {
"accountHolderCode" : {
"description" : "The code of the Account Holder for which to retrieve the documents.",
@@ -3823,6 +3856,7 @@
"type" : "object"
},
"GetUploadedDocumentsResponse" : {
"additionalProperties" : false,
"properties" : {
"documentDetails" : {
"description" : "A list of the documents and their details.",
@@ -3851,6 +3885,7 @@
"type" : "object"
},
"IndividualDetails" : {
"additionalProperties" : false,
"properties" : {
"name" : {
"description" : "The name of the individual.\n>Make sure your account holder registers using the name shown on their Photo ID.",
@@ -3864,6 +3899,7 @@
"type" : "object"
},
"KYCCheckResult" : {
"additionalProperties" : false,
"properties" : {
"checks" : {
"description" : "A list of the checks and their statuses.",
@@ -3876,6 +3912,7 @@
"type" : "object"
},
"KYCCheckStatusData" : {
"additionalProperties" : false,
"properties" : {
"requiredFields" : {
"description" : "A list of the fields required for execution of the check.",
@@ -3926,6 +3963,7 @@
"type" : "object"
},
"KYCCheckSummary" : {
"additionalProperties" : false,
"properties" : {
"kycCheckCode" : {
"x-addedInVersion" : "5",
@@ -3942,6 +3980,7 @@
"type" : "object"
},
"KYCLegalArrangementCheckResult" : {
"additionalProperties" : false,
"properties" : {
"checks" : {
"description" : "A list of the checks and their statuses.",
@@ -3958,6 +3997,7 @@
"type" : "object"
},
"KYCLegalArrangementEntityCheckResult" : {
"additionalProperties" : false,
"properties" : {
"checks" : {
"description" : "A list of the checks and their statuses.",
@@ -3978,6 +4018,7 @@
"type" : "object"
},
"KYCPayoutMethodCheckResult" : {
"additionalProperties" : false,
"properties" : {
"checks" : {
"description" : "A list of the checks and their statuses.",
@@ -3994,6 +4035,7 @@
"type" : "object"
},
"KYCShareholderCheckResult" : {
"additionalProperties" : false,
"properties" : {
"checks" : {
"description" : "A list of the checks and their statuses.",
@@ -4020,6 +4062,7 @@
"type" : "object"
},
"KYCSignatoryCheckResult" : {
"additionalProperties" : false,
"properties" : {
"checks" : {
"description" : "A list of the checks and their statuses.",
@@ -4036,6 +4079,7 @@
"type" : "object"
},
"KYCUltimateParentCompanyCheckResult" : {
"additionalProperties" : false,
"properties" : {
"checks" : {
"description" : "A list of the checks and their statuses.",
@@ -4053,6 +4097,7 @@
"type" : "object"
},
"KYCVerificationResult" : {
"additionalProperties" : false,
"properties" : {
"accountHolder" : {
"description" : "The results of the checks on the account holder.",
@@ -4108,6 +4153,7 @@
"type" : "object"
},
"LegalArrangementDetail" : {
"additionalProperties" : false,
"properties" : {
"address" : {
"description" : "The address of the legal arrangement.",
@@ -4183,6 +4229,7 @@
"type" : "object"
},
"LegalArrangementEntityDetail" : {
"additionalProperties" : false,
"properties" : {
"address" : {
"description" : "The address of the entity.",
@@ -4251,6 +4298,7 @@
"type" : "object"
},
"LegalArrangementRequest" : {
"additionalProperties" : false,
"properties" : {
"legalArrangementCode" : {
"description" : "The code of the legal arrangement to be deleted. If you also send `legalArrangementEntityCodes`, only the entities listed will be deleted.",
@@ -4270,6 +4318,7 @@
"type" : "object"
},
"MigratedAccounts" : {
"additionalProperties" : false,
"properties" : {
"accountCode" : {
"description" : "The unique identifier of the account of the migrated account holder in the classic integration.",
@@ -4283,6 +4332,7 @@
"type" : "object"
},
"MigratedShareholders" : {
"additionalProperties" : false,
"properties" : {
"legalEntityCode" : {
"description" : "The unique identifier of the legal entity of that shareholder in the balance platform.",
@@ -4296,6 +4346,7 @@
"type" : "object"
},
"MigratedStores" : {
"additionalProperties" : false,
"properties" : {
"businessLineId" : {
"description" : "The unique identifier of the business line associated with the migrated account holder in the balance platform.",
@@ -4317,6 +4368,7 @@
"type" : "object"
},
"MigrationData" : {
"additionalProperties" : false,
"properties" : {
"accountHolderId" : {
"description" : "The unique identifier of the account holder in the balance platform.",
@@ -4360,6 +4412,7 @@
"type" : "object"
},
"PayoutMethod" : {
"additionalProperties" : false,
"properties" : {
"merchantAccount" : {
"description" : "The [`merchantAccount`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__reqParam_merchantAccount) you used in the `/payments` request when you [saved the account holder's card details](https://docs.adyen.com/marketplaces-and-platforms/classic/payouts/manual-payout/payout-to-cards#check-and-store).",
@@ -4390,6 +4443,7 @@
"type" : "object"
},
"PayoutScheduleResponse" : {
"additionalProperties" : false,
"properties" : {
"nextScheduledPayout" : {
"description" : "The date of the next scheduled payout.",
@@ -4421,6 +4475,7 @@
"type" : "object"
},
"PerformVerificationRequest" : {
"additionalProperties" : false,
"properties" : {
"accountHolderCode" : {
"description" : "The code of the account holder to verify.",
@@ -4452,6 +4507,7 @@
"type" : "object"
},
"PersonalDocumentData" : {
"additionalProperties" : false,
"properties" : {
"expirationDate" : {
"description" : "The expiry date of the document, \n in ISO-8601 YYYY-MM-DD format. For example, **2000-01-31**.",
@@ -4489,6 +4545,7 @@
"type" : "object"
},
"ServiceError" : {
"additionalProperties" : false,
"properties" : {
"errorCode" : {
"description" : "The error code mapped to the error message.",
@@ -4515,6 +4572,7 @@
"type" : "object"
},
"ShareholderContact" : {
"additionalProperties" : false,
"properties" : {
"address" : {
"description" : "The address of the person.",
@@ -4570,6 +4628,7 @@
"type" : "object"
},
"SignatoryContact" : {
"additionalProperties" : false,
"properties" : {
"address" : {
"description" : "The address of the person.",
@@ -4615,6 +4674,7 @@
"type" : "object"
},
"StoreDetail" : {
"additionalProperties" : false,
"properties" : {
"address" : {
"description" : "The address of the physical store where the account holder will process payments from.",
@@ -4702,6 +4762,7 @@
"type" : "object"
},
"SuspendAccountHolderRequest" : {
"additionalProperties" : false,
"properties" : {
"accountHolderCode" : {
"description" : "The code of the account holder to be suspended.",
@@ -4714,6 +4775,7 @@
"type" : "object"
},
"SuspendAccountHolderResponse" : {
"additionalProperties" : false,
"properties" : {
"accountHolderStatus" : {
"description" : "The new status of the Account Holder.",
@@ -4739,6 +4801,7 @@
"type" : "object"
},
"UltimateParentCompany" : {
"additionalProperties" : false,
"properties" : {
"address" : {
"description" : "Address of the ultimate parent company.",
@@ -4756,6 +4819,7 @@
"type" : "object"
},
"UltimateParentCompanyBusinessDetails" : {
"additionalProperties" : false,
"properties" : {
"legalBusinessName" : {
"description" : "The legal name of the company.",
@@ -4781,6 +4845,7 @@
"type" : "object"
},
"UnSuspendAccountHolderRequest" : {
"additionalProperties" : false,
"properties" : {
"accountHolderCode" : {
"description" : "The code of the account holder to be reinstated.",
@@ -4793,6 +4858,7 @@
"type" : "object"
},
"UnSuspendAccountHolderResponse" : {
"additionalProperties" : false,
"properties" : {
"accountHolderStatus" : {
"description" : "The new status of the Account Holder.",
@@ -4818,6 +4884,7 @@
"type" : "object"
},
"UpdateAccountHolderRequest" : {
"additionalProperties" : false,
"properties" : {
"accountHolderCode" : {
"description" : "The code of the Account Holder to be updated.",
@@ -4868,6 +4935,7 @@
"type" : "object"
},
"UpdateAccountHolderResponse" : {
"additionalProperties" : false,
"properties" : {
"accountHolderCode" : {
"description" : "The code of the account holder.",
@@ -4935,6 +5003,7 @@
"type" : "object"
},
"UpdateAccountHolderStateRequest" : {
"additionalProperties" : false,
"properties" : {
"accountHolderCode" : {
"description" : "The code of the Account Holder on which to update the state.",
@@ -4969,6 +5038,7 @@
"type" : "object"
},
"UpdateAccountRequest" : {
"additionalProperties" : false,
"properties" : {
"accountCode" : {
"description" : "The code of the account to update.",
@@ -5018,6 +5088,7 @@
"type" : "object"
},
"UpdateAccountResponse" : {
"additionalProperties" : false,
"properties" : {
"accountCode" : {
"description" : "The code of the account.",
@@ -5083,6 +5154,7 @@
"type" : "object"
},
"UpdatePayoutScheduleRequest" : {
"additionalProperties" : false,
"properties" : {
"action" : {
"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.",
@@ -5125,6 +5197,7 @@
"type" : "object"
},
"UploadDocumentRequest" : {
"additionalProperties" : false,
"properties" : {
"documentContent" : {
"description" : "The content of the document, in Base64-encoded string format.\n\nTo learn about document requirements, refer to [Verification checks](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-checks).",
@@ -5143,6 +5216,7 @@
"type" : "object"
},
"ViasAddress" : {
"additionalProperties" : false,
"properties" : {
"city" : {
"description" : "The name of the city. Required if the `houseNumberOrName`, `street`, `postalCode`, or `stateOrProvince` are provided.",
@@ -5175,6 +5249,7 @@
"type" : "object"
},
"ViasName" : {
"additionalProperties" : false,
"properties" : {
"firstName" : {
"description" : "The first name.",
@@ -5205,6 +5280,7 @@
"type" : "object"
},
"ViasPersonalData" : {
"additionalProperties" : false,
"properties" : {
"dateOfBirth" : {
"description" : "The person's date of birth, in ISO-8601 YYYY-MM-DD format. For example, **2000-01-31**.",
@@ -5228,6 +5304,7 @@
"type" : "object"
},
"ViasPhoneNumber" : {
"additionalProperties" : false,
"properties" : {
"phoneCountryCode" : {
"description" : "The two-character country code of the phone number.\n>The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL').",

26
json/FundService-v3.json
View File

@@ -901,6 +901,7 @@
"components" : {
"schemas" : {
"AccountDetailBalance" : {
"additionalProperties" : false,
"properties" : {
"accountCode" : {
"description" : "The code of the account that holds the balance.",
@@ -921,6 +922,7 @@
}
},
"AccountHolderBalanceRequest" : {
"additionalProperties" : false,
"properties" : {
"accountHolderCode" : {
"description" : "The code of the Account Holder of which to retrieve the balance.",
@@ -933,6 +935,7 @@
"type" : "object"
},
"AccountHolderBalanceResponse" : {
"additionalProperties" : false,
"properties" : {
"balancePerAccount" : {
"description" : "A list of each account and their balances.",
@@ -961,6 +964,7 @@
"type" : "object"
},
"AccountHolderTransactionListRequest" : {
"additionalProperties" : false,
"properties" : {
"accountHolderCode" : {
"description" : "The code of the account holder that owns the account(s) of which retrieve the transaction list.",
@@ -1039,6 +1043,7 @@
"type" : "object"
},
"AccountHolderTransactionListResponse" : {
"additionalProperties" : false,
"properties" : {
"accountTransactionLists" : {
"description" : "A list of the transactions.",
@@ -1063,6 +1068,7 @@
"type" : "object"
},
"AccountTransactionList" : {
"additionalProperties" : false,
"properties" : {
"accountCode" : {
"description" : "The code of the account.",
@@ -1090,6 +1096,7 @@
}
},
"Amount" : {
"additionalProperties" : false,
"properties" : {
"currency" : {
"description" : "The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes).",
@@ -1117,6 +1124,7 @@
}
},
"BankAccountDetail" : {
"additionalProperties" : false,
"properties" : {
"accountNumber" : {
"description" : "The bank account number (without separators).\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.",
@@ -1223,6 +1231,7 @@
"type" : "object"
},
"DebitAccountHolderRequest" : {
"additionalProperties" : false,
"properties" : {
"accountHolderCode" : {
"description" : "The code of the account holder.",
@@ -1263,6 +1272,7 @@
"type" : "object"
},
"DebitAccountHolderResponse" : {
"additionalProperties" : false,
"properties" : {
"accountHolderCode" : {
"description" : "The code of the account holder.",
@@ -1295,6 +1305,7 @@
"type" : "object"
},
"DetailBalance" : {
"additionalProperties" : false,
"properties" : {
"balance" : {
"description" : "The list of balances held by the account.",
@@ -1314,6 +1325,7 @@
"type" : "object"
},
"PayoutAccountHolderRequest" : {
"additionalProperties" : false,
"properties" : {
"accountCode" : {
"description" : "The code of the account from which the payout is to be made.",
@@ -1349,6 +1361,7 @@
"type" : "object"
},
"PayoutAccountHolderResponse" : {
"additionalProperties" : false,
"properties" : {
"bankAccountUUID" : {
"description" : "The unique ID of the Bank Account to which the payout was made.",
@@ -1375,6 +1388,7 @@
"type" : "object"
},
"RefundFundsTransferRequest" : {
"additionalProperties" : false,
"properties" : {
"amount" : {
"description" : "The amount to be transferred.",
@@ -1396,6 +1410,7 @@
"type" : "object"
},
"RefundFundsTransferResponse" : {
"additionalProperties" : false,
"properties" : {
"merchantReference" : {
"description" : "The value supplied by the executing user when initiating the transfer refund; may be used to link multiple transactions.",
@@ -1425,6 +1440,7 @@
"type" : "object"
},
"RefundNotPaidOutTransfersRequest" : {
"additionalProperties" : false,
"properties" : {
"accountCode" : {
"description" : "The code of the account from which to perform the refund(s).",
@@ -1442,6 +1458,7 @@
"type" : "object"
},
"RefundNotPaidOutTransfersResponse" : {
"additionalProperties" : false,
"properties" : {
"pspReference" : {
"description" : "The reference of a request. Can be used to uniquely identify the request.",
@@ -1459,6 +1476,7 @@
"type" : "object"
},
"ServiceError" : {
"additionalProperties" : false,
"properties" : {
"errorCode" : {
"description" : "The error code mapped to the error message.",
@@ -1485,6 +1503,7 @@
"type" : "object"
},
"SetupBeneficiaryRequest" : {
"additionalProperties" : false,
"properties" : {
"destinationAccountCode" : {
"description" : "The destination account code.",
@@ -1506,6 +1525,7 @@
"type" : "object"
},
"SetupBeneficiaryResponse" : {
"additionalProperties" : false,
"properties" : {
"pspReference" : {
"description" : "The reference of a request. Can be used to uniquely identify the request.",
@@ -1523,6 +1543,7 @@
"type" : "object"
},
"Split" : {
"additionalProperties" : false,
"properties" : {
"account" : {
"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.",
@@ -1568,6 +1589,7 @@
"type" : "object"
},
"SplitAmount" : {
"additionalProperties" : false,
"properties" : {
"currency" : {
"description" : "The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes). By default, this is the original payment currency.",
@@ -1587,6 +1609,7 @@
"type" : "object"
},
"Transaction" : {
"additionalProperties" : false,
"properties" : {
"amount" : {
"description" : "The amount of the transaction.",
@@ -1711,6 +1734,7 @@
"type" : "object"
},
"TransactionListForAccount" : {
"additionalProperties" : false,
"properties" : {
"accountCode" : {
"description" : "The account for which to retrieve the transactions.",
@@ -1743,6 +1767,7 @@
}
},
"TransferFundsRequest" : {
"additionalProperties" : false,
"properties" : {
"amount" : {
"description" : "The amount to be transferred.",
@@ -1775,6 +1800,7 @@
"type" : "object"
},
"TransferFundsResponse" : {
"additionalProperties" : false,
"properties" : {
"merchantReference" : {
"x-addedInVersion" : "2",

28
json/FundService-v5.json
View File

@@ -901,6 +901,7 @@
"components" : {
"schemas" : {
"AccountDetailBalance" : {
"additionalProperties" : false,
"properties" : {
"accountCode" : {
"description" : "The code of the account that holds the balance.",
@@ -914,6 +915,7 @@
"type" : "object"
},
"AccountHolderBalanceRequest" : {
"additionalProperties" : false,
"properties" : {
"accountHolderCode" : {
"description" : "The code of the Account Holder of which to retrieve the balance.",
@@ -926,6 +928,7 @@
"type" : "object"
},
"AccountHolderBalanceResponse" : {
"additionalProperties" : false,
"properties" : {
"balancePerAccount" : {
"description" : "A list of each account and their balances.",
@@ -958,6 +961,7 @@
"type" : "object"
},
"AccountHolderTransactionListRequest" : {
"additionalProperties" : false,
"properties" : {
"accountHolderCode" : {
"description" : "The code of the account holder that owns the account(s) of which retrieve the transaction list.",
@@ -1036,6 +1040,7 @@
"type" : "object"
},
"AccountHolderTransactionListResponse" : {
"additionalProperties" : false,
"properties" : {
"accountTransactionLists" : {
"description" : "A list of the transactions.",
@@ -1064,6 +1069,7 @@
"type" : "object"
},
"AccountTransactionList" : {
"additionalProperties" : false,
"properties" : {
"accountCode" : {
"description" : "The code of the account.",
@@ -1084,6 +1090,7 @@
"type" : "object"
},
"Amount" : {
"additionalProperties" : false,
"properties" : {
"currency" : {
"description" : "The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes).",
@@ -1104,6 +1111,7 @@
"type" : "object"
},
"BankAccountDetail" : {
"additionalProperties" : false,
"properties" : {
"accountNumber" : {
"description" : "The bank account number (without separators).\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.",
@@ -1215,6 +1223,7 @@
"type" : "object"
},
"DebitAccountHolderRequest" : {
"additionalProperties" : false,
"properties" : {
"accountHolderCode" : {
"description" : "The code of the account holder.",
@@ -1255,6 +1264,7 @@
"type" : "object"
},
"DebitAccountHolderResponse" : {
"additionalProperties" : false,
"properties" : {
"accountHolderCode" : {
"description" : "The code of the account holder.",
@@ -1291,6 +1301,7 @@
"type" : "object"
},
"DetailBalance" : {
"additionalProperties" : false,
"properties" : {
"balance" : {
"description" : "The list of balances held by the account.",
@@ -1318,6 +1329,7 @@
"type" : "object"
},
"ErrorFieldType" : {
"additionalProperties" : false,
"properties" : {
"errorCode" : {
"description" : "The validation error code.",
@@ -1336,6 +1348,7 @@
"type" : "object"
},
"FieldType" : {
"additionalProperties" : false,
"properties" : {
"field" : {
"description" : "The full name of the property.",
@@ -1518,6 +1531,7 @@
"type" : "object"
},
"PayoutAccountHolderRequest" : {
"additionalProperties" : false,
"properties" : {
"accountCode" : {
"description" : "The code of the account from which the payout is to be made.",
@@ -1569,6 +1583,7 @@
"type" : "object"
},
"PayoutAccountHolderResponse" : {
"additionalProperties" : false,
"properties" : {
"bankAccountUUID" : {
"description" : "The unique ID of the Bank Account to which the payout was made.",
@@ -1610,6 +1625,7 @@
"type" : "object"
},
"RefundFundsTransferRequest" : {
"additionalProperties" : false,
"properties" : {
"amount" : {
"description" : "The amount to be transferred.",
@@ -1631,6 +1647,7 @@
"type" : "object"
},
"RefundFundsTransferResponse" : {
"additionalProperties" : false,
"properties" : {
"invalidFields" : {
"x-addedInVersion" : "5",
@@ -1664,6 +1681,7 @@
"type" : "object"
},
"RefundNotPaidOutTransfersRequest" : {
"additionalProperties" : false,
"properties" : {
"accountCode" : {
"description" : "The code of the account from which to perform the refund(s).",
@@ -1681,6 +1699,7 @@
"type" : "object"
},
"RefundNotPaidOutTransfersResponse" : {
"additionalProperties" : false,
"properties" : {
"invalidFields" : {
"x-addedInVersion" : "5",
@@ -1702,6 +1721,7 @@
"type" : "object"
},
"ServiceError" : {
"additionalProperties" : false,
"properties" : {
"errorCode" : {
"description" : "The error code mapped to the error message.",
@@ -1728,6 +1748,7 @@
"type" : "object"
},
"SetupBeneficiaryRequest" : {
"additionalProperties" : false,
"properties" : {
"destinationAccountCode" : {
"description" : "The destination account code.",
@@ -1749,6 +1770,7 @@
"type" : "object"
},
"SetupBeneficiaryResponse" : {
"additionalProperties" : false,
"properties" : {
"invalidFields" : {
"x-addedInVersion" : "5",
@@ -1770,6 +1792,7 @@
"type" : "object"
},
"Split" : {
"additionalProperties" : false,
"properties" : {
"account" : {
"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.",
@@ -1815,6 +1838,7 @@
"type" : "object"
},
"SplitAmount" : {
"additionalProperties" : false,
"properties" : {
"currency" : {
"description" : "The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes). By default, this is the original payment currency.",
@@ -1834,6 +1858,7 @@
"type" : "object"
},
"Transaction" : {
"additionalProperties" : false,
"properties" : {
"amount" : {
"description" : "The amount of the transaction.",
@@ -1958,6 +1983,7 @@
"type" : "object"
},
"TransactionListForAccount" : {
"additionalProperties" : false,
"properties" : {
"accountCode" : {
"description" : "The account for which to retrieve the transactions.",
@@ -1976,6 +2002,7 @@
"type" : "object"
},
"TransferFundsRequest" : {
"additionalProperties" : false,
"properties" : {
"amount" : {
"description" : "The amount to be transferred.",
@@ -2008,6 +2035,7 @@
"type" : "object"
},
"TransferFundsResponse" : {
"additionalProperties" : false,
"properties" : {
"invalidFields" : {
"x-addedInVersion" : "5",

28
json/FundService-v6.json
View File

@@ -901,6 +901,7 @@
"components" : {
"schemas" : {
"AccountDetailBalance" : {
"additionalProperties" : false,
"properties" : {
"accountCode" : {
"description" : "The code of the account that holds the balance.",
@@ -914,6 +915,7 @@
"type" : "object"
},
"AccountHolderBalanceRequest" : {
"additionalProperties" : false,
"properties" : {
"accountHolderCode" : {
"description" : "The code of the Account Holder of which to retrieve the balance.",
@@ -926,6 +928,7 @@
"type" : "object"
},
"AccountHolderBalanceResponse" : {
"additionalProperties" : false,
"properties" : {
"balancePerAccount" : {
"description" : "A list of each account and their balances.",
@@ -958,6 +961,7 @@
"type" : "object"
},
"AccountHolderTransactionListRequest" : {
"additionalProperties" : false,
"properties" : {
"accountHolderCode" : {
"description" : "The code of the account holder that owns the account(s) of which retrieve the transaction list.",
@@ -1036,6 +1040,7 @@
"type" : "object"
},
"AccountHolderTransactionListResponse" : {
"additionalProperties" : false,
"properties" : {
"accountTransactionLists" : {
"description" : "A list of the transactions.",
@@ -1064,6 +1069,7 @@
"type" : "object"
},
"AccountTransactionList" : {
"additionalProperties" : false,
"properties" : {
"accountCode" : {
"description" : "The code of the account.",
@@ -1084,6 +1090,7 @@
"type" : "object"
},
"Amount" : {
"additionalProperties" : false,
"properties" : {
"currency" : {
"description" : "The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes).",
@@ -1104,6 +1111,7 @@
"type" : "object"
},
"BankAccountDetail" : {
"additionalProperties" : false,
"properties" : {
"accountNumber" : {
"description" : "The bank account number (without separators).\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.",
@@ -1215,6 +1223,7 @@
"type" : "object"
},
"DebitAccountHolderRequest" : {
"additionalProperties" : false,
"properties" : {
"accountHolderCode" : {
"description" : "The code of the account holder.",
@@ -1255,6 +1264,7 @@
"type" : "object"
},
"DebitAccountHolderResponse" : {
"additionalProperties" : false,
"properties" : {
"accountHolderCode" : {
"description" : "The code of the account holder.",
@@ -1291,6 +1301,7 @@
"type" : "object"
},
"DetailBalance" : {
"additionalProperties" : false,
"properties" : {
"balance" : {
"description" : "The list of balances held by the account.",
@@ -1318,6 +1329,7 @@
"type" : "object"
},
"ErrorFieldType" : {
"additionalProperties" : false,
"properties" : {
"errorCode" : {
"description" : "The validation error code.",
@@ -1336,6 +1348,7 @@
"type" : "object"
},
"FieldType" : {
"additionalProperties" : false,
"properties" : {
"field" : {
"description" : "The full name of the property.",
@@ -1518,6 +1531,7 @@
"type" : "object"
},
"PayoutAccountHolderRequest" : {
"additionalProperties" : false,
"properties" : {
"accountCode" : {
"description" : "The code of the account from which the payout is to be made.",
@@ -1569,6 +1583,7 @@
"type" : "object"
},
"PayoutAccountHolderResponse" : {
"additionalProperties" : false,
"properties" : {
"bankAccountUUID" : {
"description" : "The unique ID of the Bank Account to which the payout was made.",
@@ -1610,6 +1625,7 @@
"type" : "object"
},
"RefundFundsTransferRequest" : {
"additionalProperties" : false,
"properties" : {
"amount" : {
"description" : "The amount to be transferred.",
@@ -1631,6 +1647,7 @@
"type" : "object"
},
"RefundFundsTransferResponse" : {
"additionalProperties" : false,
"properties" : {
"invalidFields" : {
"x-addedInVersion" : "5",
@@ -1664,6 +1681,7 @@
"type" : "object"
},
"RefundNotPaidOutTransfersRequest" : {
"additionalProperties" : false,
"properties" : {
"accountCode" : {
"description" : "The code of the account from which to perform the refund(s).",
@@ -1681,6 +1699,7 @@
"type" : "object"
},
"RefundNotPaidOutTransfersResponse" : {
"additionalProperties" : false,
"properties" : {
"invalidFields" : {
"x-addedInVersion" : "5",
@@ -1702,6 +1721,7 @@
"type" : "object"
},
"ServiceError" : {
"additionalProperties" : false,
"properties" : {
"errorCode" : {
"description" : "The error code mapped to the error message.",
@@ -1728,6 +1748,7 @@
"type" : "object"
},
"SetupBeneficiaryRequest" : {
"additionalProperties" : false,
"properties" : {
"destinationAccountCode" : {
"description" : "The destination account code.",
@@ -1749,6 +1770,7 @@
"type" : "object"
},
"SetupBeneficiaryResponse" : {
"additionalProperties" : false,
"properties" : {
"invalidFields" : {
"x-addedInVersion" : "5",
@@ -1770,6 +1792,7 @@
"type" : "object"
},
"Split" : {
"additionalProperties" : false,
"properties" : {
"account" : {
"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.",
@@ -1815,6 +1838,7 @@
"type" : "object"
},
"SplitAmount" : {
"additionalProperties" : false,
"properties" : {
"currency" : {
"description" : "The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes). By default, this is the original payment currency.",
@@ -1834,6 +1858,7 @@
"type" : "object"
},
"Transaction" : {
"additionalProperties" : false,
"properties" : {
"amount" : {
"description" : "The amount of the transaction.",
@@ -1958,6 +1983,7 @@
"type" : "object"
},
"TransactionListForAccount" : {
"additionalProperties" : false,
"properties" : {
"accountCode" : {
"description" : "The account for which to retrieve the transactions.",
@@ -1976,6 +2002,7 @@
"type" : "object"
},
"TransferFundsRequest" : {
"additionalProperties" : false,
"properties" : {
"amount" : {
"description" : "The amount to be transferred.",
@@ -2008,6 +2035,7 @@
"type" : "object"
},
"TransferFundsResponse" : {
"additionalProperties" : false,
"properties" : {
"invalidFields" : {
"x-addedInVersion" : "5",

9
json/HopService-v1.json
View File

@@ -235,6 +235,7 @@
"components" : {
"schemas" : {
"CollectInformation" : {
"additionalProperties" : false,
"properties" : {
"bankDetails" : {
"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**.",
@@ -264,6 +265,7 @@
"type" : "object"
},
"ErrorFieldType" : {
"additionalProperties" : false,
"properties" : {
"errorCode" : {
"description" : "The validation error code.",
@@ -289,6 +291,7 @@
}
},
"FieldType" : {
"additionalProperties" : false,
"properties" : {
"field" : {
"description" : "The full name of the property.",
@@ -467,6 +470,7 @@
"type" : "object"
},
"GetOnboardingUrlRequest" : {
"additionalProperties" : false,
"properties" : {
"accountHolderCode" : {
"description" : "The account holder code you provided when you created the account holder.",
@@ -507,6 +511,7 @@
"type" : "object"
},
"GetOnboardingUrlResponse" : {
"additionalProperties" : false,
"properties" : {
"invalidFields" : {
"x-addedInVersion" : "5",
@@ -536,6 +541,7 @@
"type" : "object"
},
"GetPciUrlRequest" : {
"additionalProperties" : false,
"properties" : {
"accountHolderCode" : {
"description" : "The account holder code you provided when you created the account holder.",
@@ -552,6 +558,7 @@
"type" : "object"
},
"GetPciUrlResponse" : {
"additionalProperties" : false,
"properties" : {
"invalidFields" : {
"x-addedInVersion" : "5",
@@ -581,6 +588,7 @@
"type" : "object"
},
"ServiceError" : {
"additionalProperties" : false,
"properties" : {
"errorCode" : {
"description" : "The error code mapped to the error message.",
@@ -607,6 +615,7 @@
"type" : "object"
},
"ShowPages" : {
"additionalProperties" : false,
"properties" : {
"bankDetailsSummaryPage" : {
"description" : "Indicates whether the page with bank account details must be shown. Defaults to **true**.",

9
json/HopService-v5.json
View File

@@ -235,6 +235,7 @@
"components" : {
"schemas" : {
"CollectInformation" : {
"additionalProperties" : false,
"properties" : {
"bankDetails" : {
"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**.",
@@ -264,6 +265,7 @@
"type" : "object"
},
"ErrorFieldType" : {
"additionalProperties" : false,
"properties" : {
"errorCode" : {
"description" : "The validation error code.",
@@ -282,6 +284,7 @@
"type" : "object"
},
"FieldType" : {
"additionalProperties" : false,
"properties" : {
"field" : {
"description" : "The full name of the property.",
@@ -464,6 +467,7 @@
"type" : "object"
},
"GetOnboardingUrlRequest" : {
"additionalProperties" : false,
"properties" : {
"accountHolderCode" : {
"description" : "The account holder code you provided when you created the account holder.",
@@ -504,6 +508,7 @@
"type" : "object"
},
"GetOnboardingUrlResponse" : {
"additionalProperties" : false,
"properties" : {
"invalidFields" : {
"x-addedInVersion" : "5",
@@ -529,6 +534,7 @@
"type" : "object"
},
"GetPciUrlRequest" : {
"additionalProperties" : false,
"properties" : {
"accountHolderCode" : {
"description" : "The account holder code you provided when you created the account holder.",
@@ -545,6 +551,7 @@
"type" : "object"
},
"GetPciUrlResponse" : {
"additionalProperties" : false,
"properties" : {
"invalidFields" : {
"x-addedInVersion" : "5",
@@ -570,6 +577,7 @@
"type" : "object"
},
"ServiceError" : {
"additionalProperties" : false,
"properties" : {
"errorCode" : {
"description" : "The error code mapped to the error message.",
@@ -596,6 +604,7 @@
"type" : "object"
},
"ShowPages" : {
"additionalProperties" : false,
"properties" : {
"bankDetailsSummaryPage" : {
"description" : "Indicates whether the page with bank account details must be shown. Defaults to **true**.",

9
json/HopService-v6.json
View File

@@ -235,6 +235,7 @@
"components" : {
"schemas" : {
"CollectInformation" : {
"additionalProperties" : false,
"properties" : {
"bankDetails" : {
"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**.",
@@ -264,6 +265,7 @@
"type" : "object"
},
"ErrorFieldType" : {
"additionalProperties" : false,
"properties" : {
"errorCode" : {
"description" : "The validation error code.",
@@ -282,6 +284,7 @@
"type" : "object"
},
"FieldType" : {
"additionalProperties" : false,
"properties" : {
"field" : {
"description" : "The full name of the property.",
@@ -464,6 +467,7 @@
"type" : "object"
},
"GetOnboardingUrlRequest" : {
"additionalProperties" : false,
"properties" : {
"accountHolderCode" : {
"description" : "The account holder code you provided when you created the account holder.",
@@ -504,6 +508,7 @@
"type" : "object"
},
"GetOnboardingUrlResponse" : {
"additionalProperties" : false,
"properties" : {
"invalidFields" : {
"x-addedInVersion" : "5",
@@ -529,6 +534,7 @@
"type" : "object"
},
"GetPciUrlRequest" : {
"additionalProperties" : false,
"properties" : {
"accountHolderCode" : {
"description" : "The account holder code you provided when you created the account holder.",
@@ -545,6 +551,7 @@
"type" : "object"
},
"GetPciUrlResponse" : {
"additionalProperties" : false,
"properties" : {
"invalidFields" : {
"x-addedInVersion" : "5",
@@ -570,6 +577,7 @@
"type" : "object"
},
"ServiceError" : {
"additionalProperties" : false,
"properties" : {
"errorCode" : {
"description" : "The error code mapped to the error message.",
@@ -596,6 +604,7 @@
"type" : "object"
},
"ShowPages" : {
"additionalProperties" : false,
"properties" : {
"bankDetailsSummaryPage" : {
"description" : "Indicates whether the page with bank account details must be shown. Defaults to **true**.",

76
json/MarketPayNotificationService-v3.json
View File

@@ -864,6 +864,7 @@
"components" : {
"schemas" : {
"AccountCloseNotification" : {
"additionalProperties" : false,
"properties" : {
"content" : {
"description" : "The details of the Account update.",
@@ -895,6 +896,7 @@
"type" : "object"
},
"AccountCreateNotification" : {
"additionalProperties" : false,
"properties" : {
"content" : {
"description" : "The details of the account creation.",
@@ -926,6 +928,7 @@
"type" : "object"
},
"AccountEvent" : {
"additionalProperties" : false,
"properties" : {
"event" : {
"description" : "The event.\n>Permitted values: `InactivateAccount`, `RefundNotPaidOutTransfers`.\nFor more information, refer to [Verification checks](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process).",
@@ -955,6 +958,7 @@
}
},
"AccountFundsBelowThresholdNotification" : {
"additionalProperties" : false,
"properties" : {
"content" : {
"description" : "Details of the liable account with funds under threshold.",
@@ -986,6 +990,7 @@
"type" : "object"
},
"AccountFundsBelowThresholdNotificationContent" : {
"additionalProperties" : false,
"properties" : {
"accountCode" : {
"description" : "The code of the account with funds under threshold",
@@ -1015,6 +1020,7 @@
"type" : "object"
},
"AccountHolderCreateNotification" : {
"additionalProperties" : false,
"properties" : {
"content" : {
"description" : "The details of the account holder creation.",
@@ -1046,6 +1052,7 @@
"type" : "object"
},
"AccountHolderDetails" : {
"additionalProperties" : false,
"properties" : {
"address" : {
"description" : "The address of the account holder.",
@@ -1104,6 +1111,7 @@
"type" : "object"
},
"AccountHolderPayoutNotification" : {
"additionalProperties" : false,
"properties" : {
"content" : {
"description" : "Details of the payout to the Account Holder.",
@@ -1135,6 +1143,7 @@
"type" : "object"
},
"AccountHolderPayoutNotificationContent" : {
"additionalProperties" : false,
"properties" : {
"accountCode" : {
"description" : "The code of the account from which the payout was made.",
@@ -1176,6 +1185,7 @@
"type" : "object"
},
"AccountHolderStatus" : {
"additionalProperties" : false,
"properties" : {
"events" : {
"description" : "A list of events scheduled for the account holder.",
@@ -1213,6 +1223,7 @@
"type" : "object"
},
"AccountHolderStatusChangeNotification" : {
"additionalProperties" : false,
"properties" : {
"content" : {
"description" : "The details of the Account Holder status change.",
@@ -1244,6 +1255,7 @@
"type" : "object"
},
"AccountHolderStatusChangeNotificationContent" : {
"additionalProperties" : false,
"properties" : {
"accountHolderCode" : {
"description" : "The code of the account holder.",
@@ -1270,6 +1282,7 @@
"type" : "object"
},
"AccountHolderStoreStatusChangeNotification" : {
"additionalProperties" : false,
"properties" : {
"content" : {
"description" : "The details of the Account Holder Store status change.",
@@ -1301,9 +1314,11 @@
"type" : "object"
},
"AccountHolderStoreStatusChangeNotificationContent" : {
"additionalProperties" : false,
"type" : "object"
},
"AccountHolderUpcomingDeadlineNotification" : {
"additionalProperties" : false,
"properties" : {
"content" : {
"description" : "The details of the upcoming event.",
@@ -1335,6 +1350,7 @@
"type" : "object"
},
"AccountHolderUpcomingDeadlineNotificationContent" : {
"additionalProperties" : false,
"properties" : {
"accountHolderCode" : {
"description" : "The code of the account holder whom the event refers to.",
@@ -1384,6 +1400,7 @@
"type" : "object"
},
"AccountHolderUpdateNotification" : {
"additionalProperties" : false,
"properties" : {
"content" : {
"description" : "The details of the Account Holder update.",
@@ -1415,6 +1432,7 @@
"type" : "object"
},
"AccountHolderVerificationNotification" : {
"additionalProperties" : false,
"properties" : {
"content" : {
"description" : "The details of the Account Holder verification.",
@@ -1446,6 +1464,7 @@
"type" : "object"
},
"AccountHolderVerificationNotificationContent" : {
"additionalProperties" : false,
"properties" : {
"accountHolderCode" : {
"description" : "The code of the account holder.",
@@ -1505,6 +1524,7 @@
"type" : "object"
},
"AccountPayoutState" : {
"additionalProperties" : false,
"properties" : {
"allowPayout" : {
"description" : "Indicates whether payouts are allowed. This field is the overarching payout status, and is the aggregate of multiple conditions (e.g., KYC status, disabled flag, etc). If this field is false, no payouts will be permitted for any of the account holder's accounts. If this field is true, payouts will be permitted for any of the account holder's accounts.",
@@ -1532,6 +1552,7 @@
"type" : "object"
},
"AccountProcessingState" : {
"additionalProperties" : false,
"properties" : {
"disableReason" : {
"description" : "The reason why processing has been disabled.",
@@ -1559,6 +1580,7 @@
"type" : "object"
},
"AccountUpdateNotification" : {
"additionalProperties" : false,
"properties" : {
"content" : {
"description" : "The details of the Account update.",
@@ -1590,6 +1612,7 @@
"type" : "object"
},
"Amount" : {
"additionalProperties" : false,
"properties" : {
"currency" : {
"description" : "The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes).",
@@ -1617,6 +1640,7 @@
}
},
"BankAccountDetail" : {
"additionalProperties" : false,
"properties" : {
"accountNumber" : {
"description" : "The bank account number (without separators).\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.",
@@ -1730,6 +1754,7 @@
}
},
"BeneficiarySetupNotification" : {
"additionalProperties" : false,
"properties" : {
"content" : {
"description" : "Details of the beneficiary setup.",
@@ -1761,6 +1786,7 @@
"type" : "object"
},
"BeneficiarySetupNotificationContent" : {
"additionalProperties" : false,
"properties" : {
"destinationAccountCode" : {
"description" : "The code of the beneficiary account.",
@@ -1796,6 +1822,7 @@
"type" : "object"
},
"BusinessDetails" : {
"additionalProperties" : false,
"properties" : {
"doingBusinessAs" : {
"description" : "The registered name of the company (if it differs from the legal name of the company).",
@@ -1834,6 +1861,7 @@
"type" : "object"
},
"CloseAccountResponse" : {
"additionalProperties" : false,
"properties" : {
"pspReference" : {
"description" : "The reference of a request. Can be used to uniquely identify the request.",
@@ -1862,6 +1890,7 @@
"type" : "object"
},
"CompensateNegativeBalanceNotification" : {
"additionalProperties" : false,
"properties" : {
"content" : {
"description" : "Details of the negative balance compensation.",
@@ -1893,6 +1922,7 @@
"type" : "object"
},
"CompensateNegativeBalanceNotificationContent" : {
"additionalProperties" : false,
"properties" : {
"records" : {
"description" : "A list of the negative balances compensated.",
@@ -1905,6 +1935,7 @@
"type" : "object"
},
"CompensateNegativeBalanceNotificationRecord" : {
"additionalProperties" : false,
"properties" : {
"accountCode" : {
"description" : "The code of the account whose negative balance has been compensated.",
@@ -1930,6 +1961,7 @@
}
},
"CreateAccountHolderResponse" : {
"additionalProperties" : false,
"properties" : {
"accountCode" : {
"description" : "The code of a new account created for the account holder.",
@@ -1977,6 +2009,7 @@
"type" : "object"
},
"CreateAccountResponse" : {
"additionalProperties" : false,
"properties" : {
"accountCode" : {
"description" : "The code of the new account.",
@@ -2017,6 +2050,7 @@
"type" : "object"
},
"DirectDebitInitiatedNotification" : {
"additionalProperties" : false,
"properties" : {
"content" : {
"description" : "Details of the direct debit.",
@@ -2048,6 +2082,7 @@
"type" : "object"
},
"DirectDebitInitiatedNotificationContent" : {
"additionalProperties" : false,
"properties" : {
"accountCode" : {
"description" : "The code of the account.",
@@ -2092,6 +2127,7 @@
"type" : "object"
},
"ErrorFieldType" : {
"additionalProperties" : false,
"properties" : {
"errorCode" : {
"description" : "The validation error code.",
@@ -2117,6 +2153,7 @@
}
},
"FieldType" : {
"additionalProperties" : false,
"properties" : {
"field" : {
"description" : "The full name of the property.",
@@ -2302,6 +2339,7 @@
}
},
"IndividualDetails" : {
"additionalProperties" : false,
"properties" : {
"name" : {
"description" : "The name of the individual.\n>Make sure your account holder registers using the name shown on their Photo ID.",
@@ -2315,6 +2353,7 @@
"type" : "object"
},
"KYCBankAccountCheckResult" : {
"additionalProperties" : false,
"properties" : {
"bankAccountUUID" : {
"description" : "The unique ID of the bank account to which the check applies.",
@@ -2331,6 +2370,7 @@
"type" : "object"
},
"KYCCheckDataSummaryItem" : {
"additionalProperties" : false,
"properties" : {
"itemCode" : {
"description" : "The code of the item reviewed.",
@@ -2352,6 +2392,7 @@
}
},
"KYCCheckResult" : {
"additionalProperties" : false,
"properties" : {
"checks" : {
"description" : "A list of the checks and their statuses.",
@@ -2364,6 +2405,7 @@
"type" : "object"
},
"KYCCheckStatusData" : {
"additionalProperties" : false,
"properties" : {
"requiredFields" : {
"description" : "A list of the fields required for execution of the check.",
@@ -2414,6 +2456,7 @@
"type" : "object"
},
"KYCCheckSummary" : {
"additionalProperties" : false,
"properties" : {
"code" : {
"description" : "The code of the check.",
@@ -2431,6 +2474,7 @@
"type" : "object"
},
"KYCShareholderCheckResult" : {
"additionalProperties" : false,
"properties" : {
"checks" : {
"description" : "A list of the checks and their statuses.",
@@ -2447,6 +2491,7 @@
"type" : "object"
},
"KYCSignatoryCheckResult" : {
"additionalProperties" : false,
"properties" : {
"checks" : {
"description" : "A list of the checks and their statuses.",
@@ -2463,6 +2508,7 @@
"type" : "object"
},
"KYCVerificationResult" : {
"additionalProperties" : false,
"properties" : {
"accountHolder" : {
"description" : "The results of the checks on the account holder.",
@@ -2493,6 +2539,7 @@
"type" : "object"
},
"LocalDate" : {
"additionalProperties" : false,
"properties" : {
"month" : {
"format" : "int32",
@@ -2506,6 +2553,7 @@
"type" : "object"
},
"Message" : {
"additionalProperties" : false,
"properties" : {
"code" : {
"description" : "The message code.",
@@ -2519,6 +2567,7 @@
"type" : "object"
},
"NotificationResponse" : {
"additionalProperties" : false,
"properties" : {
"notificationResponse" : {
"description" : "Set this parameter to **[accepted]** to acknowledge that you received a notification from Adyen.",
@@ -2528,6 +2577,7 @@
"type" : "object"
},
"OperationStatus" : {
"additionalProperties" : false,
"properties" : {
"message" : {
"description" : "The message regarding the operation status.",
@@ -2541,6 +2591,7 @@
"type" : "object"
},
"PaymentFailureNotification" : {
"additionalProperties" : false,
"properties" : {
"content" : {
"description" : "The details of the payment failure.",
@@ -2572,6 +2623,7 @@
"type" : "object"
},
"PaymentFailureNotificationContent" : {
"additionalProperties" : false,
"properties" : {
"errorFields" : {
"description" : "Missing or invalid fields that caused the payment error.",
@@ -2604,6 +2656,7 @@
"type" : "object"
},
"PayoutScheduleResponse" : {
"additionalProperties" : false,
"properties" : {
"nextScheduledPayout" : {
"description" : "The date of the next scheduled payout.",
@@ -2635,6 +2688,7 @@
"type" : "object"
},
"PersonalDocumentData" : {
"additionalProperties" : false,
"properties" : {
"expirationDate" : {
"description" : "The expiry date of the document, \n in ISO-8601 YYYY-MM-DD format. For example, **2000-01-31**.",
@@ -2679,6 +2733,7 @@
}
},
"RefundFundsTransferNotification" : {
"additionalProperties" : false,
"properties" : {
"content" : {
"description" : "Details of the fund transfer refund.",
@@ -2710,6 +2765,7 @@
"type" : "object"
},
"RefundFundsTransferNotificationContent" : {
"additionalProperties" : false,
"properties" : {
"amount" : {
"description" : "The amount to be refunded.",
@@ -2735,6 +2791,7 @@
"type" : "object"
},
"RefundResult" : {
"additionalProperties" : false,
"properties" : {
"originalTransaction" : {
"description" : "The transaction that has been refunded.",
@@ -2759,6 +2816,7 @@
}
},
"ReportAvailableNotification" : {
"additionalProperties" : false,
"properties" : {
"content" : {
"description" : "Details of the report.",
@@ -2790,6 +2848,7 @@
"type" : "object"
},
"ReportAvailableNotificationContent" : {
"additionalProperties" : false,
"properties" : {
"accountCode" : {
"description" : "The code of the Account to which the report applies.",
@@ -2816,6 +2875,7 @@
"type" : "object"
},
"ScheduledRefundsNotification" : {
"additionalProperties" : false,
"properties" : {
"content" : {
"description" : "Details of the scheduling of the refunds.",
@@ -2847,6 +2907,7 @@
"type" : "object"
},
"ScheduledRefundsNotificationContent" : {
"additionalProperties" : false,
"properties" : {
"accountCode" : {
"description" : "The code of the account.",
@@ -2871,6 +2932,7 @@
"type" : "object"
},
"ShareholderContact" : {
"additionalProperties" : false,
"properties" : {
"address" : {
"description" : "The address of the person.",
@@ -2928,6 +2990,7 @@
}
},
"SignatoryContact" : {
"additionalProperties" : false,
"properties" : {
"address" : {
"description" : "The address of the person.",
@@ -2980,6 +3043,7 @@
}
},
"Split" : {
"additionalProperties" : false,
"properties" : {
"account" : {
"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.",
@@ -3025,6 +3089,7 @@
"type" : "object"
},
"SplitAmount" : {
"additionalProperties" : false,
"properties" : {
"currency" : {
"description" : "The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes). By default, this is the original payment currency.",
@@ -3044,6 +3109,7 @@
"type" : "object"
},
"Transaction" : {
"additionalProperties" : false,
"properties" : {
"amount" : {
"description" : "The amount of the transaction.",
@@ -3168,6 +3234,7 @@
"type" : "object"
},
"TransferFundsNotification" : {
"additionalProperties" : false,
"properties" : {
"content" : {
"description" : "Details of the fund transfer.",
@@ -3199,6 +3266,7 @@
"type" : "object"
},
"TransferFundsNotificationContent" : {
"additionalProperties" : false,
"properties" : {
"amount" : {
"description" : "The amount transferred.",
@@ -3229,6 +3297,7 @@
"type" : "object"
},
"UltimateParentCompany" : {
"additionalProperties" : false,
"properties" : {
"address" : {
"description" : "Address of the ultimate parent company.",
@@ -3246,6 +3315,7 @@
"type" : "object"
},
"UltimateParentCompanyBusinessDetails" : {
"additionalProperties" : false,
"properties" : {
"legalBusinessName" : {
"description" : "The legal name of the company.",
@@ -3278,6 +3348,7 @@
}
},
"UpdateAccountHolderResponse" : {
"additionalProperties" : false,
"properties" : {
"accountHolderCode" : {
"description" : "The code of the account holder.",
@@ -3328,6 +3399,7 @@
"type" : "object"
},
"UpdateAccountResponse" : {
"additionalProperties" : false,
"properties" : {
"accountCode" : {
"description" : "The code of the account.",
@@ -3356,6 +3428,7 @@
"type" : "object"
},
"ViasAddress" : {
"additionalProperties" : false,
"properties" : {
"city" : {
"description" : "The name of the city. Required if the `houseNumberOrName`, `street`, `postalCode`, or `stateOrProvince` are provided.",
@@ -3388,6 +3461,7 @@
"type" : "object"
},
"ViasName" : {
"additionalProperties" : false,
"properties" : {
"firstName" : {
"description" : "The first name.",
@@ -3418,6 +3492,7 @@
"type" : "object"
},
"ViasPersonalData" : {
"additionalProperties" : false,
"properties" : {
"dateOfBirth" : {
"description" : "The person's date of birth, in ISO-8601 YYYY-MM-DD format. For example, **2000-01-31**.",
@@ -3448,6 +3523,7 @@
"type" : "object"
},
"ViasPhoneNumber" : {
"additionalProperties" : false,
"properties" : {
"phoneCountryCode" : {
"description" : "The two-character country code of the phone number.\n>The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL').",

75
json/MarketPayNotificationService-v4.json
View File

@@ -864,6 +864,7 @@
"components" : {
"schemas" : {
"AccountCloseNotification" : {
"additionalProperties" : false,
"properties" : {
"content" : {
"description" : "The details of the Account update.",
@@ -902,6 +903,7 @@
"type" : "object"
},
"AccountCreateNotification" : {
"additionalProperties" : false,
"properties" : {
"content" : {
"description" : "The details of the account creation.",
@@ -940,6 +942,7 @@
"type" : "object"
},
"AccountEvent" : {
"additionalProperties" : false,
"properties" : {
"event" : {
"description" : "The event.\n>Permitted values: `InactivateAccount`, `RefundNotPaidOutTransfers`.\nFor more information, refer to [Verification checks](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process).",
@@ -969,6 +972,7 @@
}
},
"AccountFundsBelowThresholdNotification" : {
"additionalProperties" : false,
"properties" : {
"content" : {
"description" : "Details of the liable account with funds under threshold.",
@@ -1007,6 +1011,7 @@
"type" : "object"
},
"AccountFundsBelowThresholdNotificationContent" : {
"additionalProperties" : false,
"properties" : {
"accountCode" : {
"description" : "The code of the account with funds under threshold",
@@ -1036,6 +1041,7 @@
"type" : "object"
},
"AccountHolderCreateNotification" : {
"additionalProperties" : false,
"properties" : {
"content" : {
"description" : "The details of the account holder creation.",
@@ -1074,6 +1080,7 @@
"type" : "object"
},
"AccountHolderDetails" : {
"additionalProperties" : false,
"properties" : {
"address" : {
"description" : "The address of the account holder.",
@@ -1132,6 +1139,7 @@
"type" : "object"
},
"AccountHolderPayoutNotification" : {
"additionalProperties" : false,
"properties" : {
"content" : {
"description" : "Details of the payout to the Account Holder.",
@@ -1170,6 +1178,7 @@
"type" : "object"
},
"AccountHolderPayoutNotificationContent" : {
"additionalProperties" : false,
"properties" : {
"accountCode" : {
"description" : "The code of the account from which the payout was made.",
@@ -1211,6 +1220,7 @@
"type" : "object"
},
"AccountHolderStatus" : {
"additionalProperties" : false,
"properties" : {
"events" : {
"description" : "A list of events scheduled for the account holder.",
@@ -1248,6 +1258,7 @@
"type" : "object"
},
"AccountHolderStatusChangeNotification" : {
"additionalProperties" : false,
"properties" : {
"content" : {
"description" : "The details of the Account Holder status change.",
@@ -1286,6 +1297,7 @@
"type" : "object"
},
"AccountHolderStatusChangeNotificationContent" : {
"additionalProperties" : false,
"properties" : {
"accountHolderCode" : {
"description" : "The code of the account holder.",
@@ -1312,6 +1324,7 @@
"type" : "object"
},
"AccountHolderStoreStatusChangeNotification" : {
"additionalProperties" : false,
"properties" : {
"content" : {
"description" : "The details of the Account Holder Store status change.",
@@ -1350,9 +1363,11 @@
"type" : "object"
},
"AccountHolderStoreStatusChangeNotificationContent" : {
"additionalProperties" : false,
"type" : "object"
},
"AccountHolderUpcomingDeadlineNotification" : {
"additionalProperties" : false,
"properties" : {
"content" : {
"description" : "The details of the upcoming event.",
@@ -1391,6 +1406,7 @@
"type" : "object"
},
"AccountHolderUpcomingDeadlineNotificationContent" : {
"additionalProperties" : false,
"properties" : {
"accountHolderCode" : {
"description" : "The code of the account holder whom the event refers to.",
@@ -1440,6 +1456,7 @@
"type" : "object"
},
"AccountHolderUpdateNotification" : {
"additionalProperties" : false,
"properties" : {
"content" : {
"description" : "The details of the Account Holder update.",
@@ -1478,6 +1495,7 @@
"type" : "object"
},
"AccountHolderVerificationNotification" : {
"additionalProperties" : false,
"properties" : {
"content" : {
"description" : "The details of the Account Holder verification.",
@@ -1516,6 +1534,7 @@
"type" : "object"
},
"AccountHolderVerificationNotificationContent" : {
"additionalProperties" : false,
"properties" : {
"accountHolderCode" : {
"description" : "The code of the account holder.",
@@ -1572,6 +1591,7 @@
"type" : "object"
},
"AccountPayoutState" : {
"additionalProperties" : false,
"properties" : {
"allowPayout" : {
"description" : "Indicates whether payouts are allowed. This field is the overarching payout status, and is the aggregate of multiple conditions (e.g., KYC status, disabled flag, etc). If this field is false, no payouts will be permitted for any of the account holder's accounts. If this field is true, payouts will be permitted for any of the account holder's accounts.",
@@ -1599,6 +1619,7 @@
"type" : "object"
},
"AccountProcessingState" : {
"additionalProperties" : false,
"properties" : {
"disableReason" : {
"description" : "The reason why processing has been disabled.",
@@ -1626,6 +1647,7 @@
"type" : "object"
},
"AccountUpdateNotification" : {
"additionalProperties" : false,
"properties" : {
"content" : {
"description" : "The details of the Account update.",
@@ -1664,6 +1686,7 @@
"type" : "object"
},
"Amount" : {
"additionalProperties" : false,
"properties" : {
"currency" : {
"description" : "The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes).",
@@ -1691,6 +1714,7 @@
}
},
"BankAccountDetail" : {
"additionalProperties" : false,
"properties" : {
"accountNumber" : {
"description" : "The bank account number (without separators).\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.",
@@ -1804,6 +1828,7 @@
}
},
"BeneficiarySetupNotification" : {
"additionalProperties" : false,
"properties" : {
"content" : {
"description" : "Details of the beneficiary setup.",
@@ -1842,6 +1867,7 @@
"type" : "object"
},
"BeneficiarySetupNotificationContent" : {
"additionalProperties" : false,
"properties" : {
"destinationAccountCode" : {
"description" : "The code of the beneficiary account.",
@@ -1877,6 +1903,7 @@
"type" : "object"
},
"BusinessDetails" : {
"additionalProperties" : false,
"properties" : {
"doingBusinessAs" : {
"description" : "The registered name of the company (if it differs from the legal name of the company).",
@@ -1920,6 +1947,7 @@
"type" : "object"
},
"CloseAccountResponse" : {
"additionalProperties" : false,
"properties" : {
"pspReference" : {
"description" : "The reference of a request. Can be used to uniquely identify the request.",
@@ -1948,6 +1976,7 @@
"type" : "object"
},
"CompensateNegativeBalanceNotification" : {
"additionalProperties" : false,
"properties" : {
"content" : {
"description" : "Details of the negative balance compensation.",
@@ -1986,6 +2015,7 @@
"type" : "object"
},
"CompensateNegativeBalanceNotificationContent" : {
"additionalProperties" : false,
"properties" : {
"records" : {
"description" : "A list of the negative balances compensated.",
@@ -1998,6 +2028,7 @@
"type" : "object"
},
"CompensateNegativeBalanceNotificationRecord" : {
"additionalProperties" : false,
"properties" : {
"accountCode" : {
"description" : "The code of the account whose negative balance has been compensated.",
@@ -2023,6 +2054,7 @@
}
},
"CreateAccountHolderResponse" : {
"additionalProperties" : false,
"properties" : {
"accountCode" : {
"description" : "The code of a new account created for the account holder.",
@@ -2085,6 +2117,7 @@
"type" : "object"
},
"CreateAccountResponse" : {
"additionalProperties" : false,
"properties" : {
"accountCode" : {
"description" : "The code of the new account.",
@@ -2130,6 +2163,7 @@
"type" : "object"
},
"DirectDebitInitiatedNotification" : {
"additionalProperties" : false,
"properties" : {
"content" : {
"description" : "Details of the direct debit.",
@@ -2168,6 +2202,7 @@
"type" : "object"
},
"DirectDebitInitiatedNotificationContent" : {
"additionalProperties" : false,
"properties" : {
"accountCode" : {
"description" : "The code of the account.",
@@ -2212,6 +2247,7 @@
"type" : "object"
},
"ErrorFieldType" : {
"additionalProperties" : false,
"properties" : {
"errorCode" : {
"description" : "The validation error code.",
@@ -2237,6 +2273,7 @@
}
},
"FieldType" : {
"additionalProperties" : false,
"properties" : {
"field" : {
"description" : "The full name of the property.",
@@ -2426,6 +2463,7 @@
}
},
"IndividualDetails" : {
"additionalProperties" : false,
"properties" : {
"name" : {
"description" : "The name of the individual.\n>Make sure your account holder registers using the name shown on their Photo ID.",
@@ -2439,6 +2477,7 @@
"type" : "object"
},
"KYCBankAccountCheckResult" : {
"additionalProperties" : false,
"properties" : {
"bankAccountUUID" : {
"description" : "The unique ID of the bank account to which the check applies.",
@@ -2455,6 +2494,7 @@
"type" : "object"
},
"KYCCheckResult" : {
"additionalProperties" : false,
"properties" : {
"checks" : {
"description" : "A list of the checks and their statuses.",
@@ -2467,6 +2507,7 @@
"type" : "object"
},
"KYCCheckStatusData" : {
"additionalProperties" : false,
"properties" : {
"requiredFields" : {
"description" : "A list of the fields required for execution of the check.",
@@ -2517,6 +2558,7 @@
"type" : "object"
},
"KYCCheckSummary" : {
"additionalProperties" : false,
"properties" : {
"code" : {
"description" : "The code of the check.",
@@ -2534,6 +2576,7 @@
"type" : "object"
},
"KYCShareholderCheckResult" : {
"additionalProperties" : false,
"properties" : {
"checks" : {
"description" : "A list of the checks and their statuses.",
@@ -2550,6 +2593,7 @@
"type" : "object"
},
"KYCSignatoryCheckResult" : {
"additionalProperties" : false,
"properties" : {
"checks" : {
"description" : "A list of the checks and their statuses.",
@@ -2566,6 +2610,7 @@
"type" : "object"
},
"KYCVerificationResult" : {
"additionalProperties" : false,
"properties" : {
"accountHolder" : {
"description" : "The results of the checks on the account holder.",
@@ -2596,6 +2641,7 @@
"type" : "object"
},
"LocalDate" : {
"additionalProperties" : false,
"properties" : {
"month" : {
"format" : "int32",
@@ -2609,6 +2655,7 @@
"type" : "object"
},
"Message" : {
"additionalProperties" : false,
"properties" : {
"code" : {
"description" : "The message code.",
@@ -2622,6 +2669,7 @@
"type" : "object"
},
"NotificationResponse" : {
"additionalProperties" : false,
"properties" : {
"notificationResponse" : {
"description" : "Set this parameter to **[accepted]** to acknowledge that you received a notification from Adyen.",
@@ -2631,6 +2679,7 @@
"type" : "object"
},
"OperationStatus" : {
"additionalProperties" : false,
"properties" : {
"message" : {
"description" : "The message regarding the operation status.",
@@ -2644,6 +2693,7 @@
"type" : "object"
},
"PaymentFailureNotification" : {
"additionalProperties" : false,
"properties" : {
"content" : {
"description" : "The details of the payment failure.",
@@ -2682,6 +2732,7 @@
"type" : "object"
},
"PaymentFailureNotificationContent" : {
"additionalProperties" : false,
"properties" : {
"errorFields" : {
"description" : "Missing or invalid fields that caused the payment error.",
@@ -2714,6 +2765,7 @@
"type" : "object"
},
"PayoutScheduleResponse" : {
"additionalProperties" : false,
"properties" : {
"nextScheduledPayout" : {
"description" : "The date of the next scheduled payout.",
@@ -2745,6 +2797,7 @@
"type" : "object"
},
"PersonalDocumentData" : {
"additionalProperties" : false,
"properties" : {
"expirationDate" : {
"description" : "The expiry date of the document, \n in ISO-8601 YYYY-MM-DD format. For example, **2000-01-31**.",
@@ -2789,6 +2842,7 @@
}
},
"RefundFundsTransferNotification" : {
"additionalProperties" : false,
"properties" : {
"content" : {
"description" : "Details of the fund transfer refund.",
@@ -2827,6 +2881,7 @@
"type" : "object"
},
"RefundFundsTransferNotificationContent" : {
"additionalProperties" : false,
"properties" : {
"amount" : {
"description" : "The amount to be refunded.",
@@ -2852,6 +2907,7 @@
"type" : "object"
},
"RefundResult" : {
"additionalProperties" : false,
"properties" : {
"originalTransaction" : {
"description" : "The transaction that has been refunded.",
@@ -2876,6 +2932,7 @@
}
},
"ReportAvailableNotification" : {
"additionalProperties" : false,
"properties" : {
"content" : {
"description" : "Details of the report.",
@@ -2914,6 +2971,7 @@
"type" : "object"
},
"ReportAvailableNotificationContent" : {
"additionalProperties" : false,
"properties" : {
"accountCode" : {
"description" : "The code of the Account to which the report applies.",
@@ -2940,6 +2998,7 @@
"type" : "object"
},
"ScheduledRefundsNotification" : {
"additionalProperties" : false,
"properties" : {
"content" : {
"description" : "Details of the scheduling of the refunds.",
@@ -2978,6 +3037,7 @@
"type" : "object"
},
"ScheduledRefundsNotificationContent" : {
"additionalProperties" : false,
"properties" : {
"accountCode" : {
"description" : "The code of the account.",
@@ -3002,6 +3062,7 @@
"type" : "object"
},
"ShareholderContact" : {
"additionalProperties" : false,
"properties" : {
"address" : {
"description" : "The address of the person.",
@@ -3059,6 +3120,7 @@
}
},
"SignatoryContact" : {
"additionalProperties" : false,
"properties" : {
"address" : {
"description" : "The address of the person.",
@@ -3111,6 +3173,7 @@
}
},
"Split" : {
"additionalProperties" : false,
"properties" : {
"account" : {
"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.",
@@ -3156,6 +3219,7 @@
"type" : "object"
},
"SplitAmount" : {
"additionalProperties" : false,
"properties" : {
"currency" : {
"description" : "The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes). By default, this is the original payment currency.",
@@ -3175,6 +3239,7 @@
"type" : "object"
},
"Transaction" : {
"additionalProperties" : false,
"properties" : {
"amount" : {
"description" : "The amount of the transaction.",
@@ -3299,6 +3364,7 @@
"type" : "object"
},
"TransferFundsNotification" : {
"additionalProperties" : false,
"properties" : {
"content" : {
"description" : "Details of the fund transfer.",
@@ -3337,6 +3403,7 @@
"type" : "object"
},
"TransferFundsNotificationContent" : {
"additionalProperties" : false,
"properties" : {
"amount" : {
"description" : "The amount transferred.",
@@ -3367,6 +3434,7 @@
"type" : "object"
},
"UltimateParentCompany" : {
"additionalProperties" : false,
"properties" : {
"address" : {
"description" : "Address of the ultimate parent company.",
@@ -3384,6 +3452,7 @@
"type" : "object"
},
"UltimateParentCompanyBusinessDetails" : {
"additionalProperties" : false,
"properties" : {
"legalBusinessName" : {
"description" : "The legal name of the company.",
@@ -3416,6 +3485,7 @@
}
},
"UpdateAccountHolderResponse" : {
"additionalProperties" : false,
"properties" : {
"accountHolderCode" : {
"description" : "The code of the account holder.",
@@ -3481,6 +3551,7 @@
"type" : "object"
},
"UpdateAccountResponse" : {
"additionalProperties" : false,
"properties" : {
"accountCode" : {
"description" : "The code of the account.",
@@ -3514,6 +3585,7 @@
"type" : "object"
},
"ViasAddress" : {
"additionalProperties" : false,
"properties" : {
"city" : {
"description" : "The name of the city. Required if the `houseNumberOrName`, `street`, `postalCode`, or `stateOrProvince` are provided.",
@@ -3546,6 +3618,7 @@
"type" : "object"
},
"ViasName" : {
"additionalProperties" : false,
"properties" : {
"firstName" : {
"description" : "The first name.",
@@ -3576,6 +3649,7 @@
"type" : "object"
},
"ViasPersonalData" : {
"additionalProperties" : false,
"properties" : {
"dateOfBirth" : {
"description" : "The person's date of birth, in ISO-8601 YYYY-MM-DD format. For example, **2000-01-31**.",
@@ -3606,6 +3680,7 @@
"type" : "object"
},
"ViasPhoneNumber" : {
"additionalProperties" : false,
"properties" : {
"phoneCountryCode" : {
"description" : "The two-character country code of the phone number.\n>The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL').",

79
json/MarketPayNotificationService-v5.json
View File

@@ -876,6 +876,7 @@
"components" : {
"schemas" : {
"AccountCloseNotification" : {
"additionalProperties" : false,
"properties" : {
"content" : {
"description" : "The details of the Account update.",
@@ -919,6 +920,7 @@
"type" : "object"
},
"AccountCreateNotification" : {
"additionalProperties" : false,
"properties" : {
"content" : {
"description" : "The details of the account creation.",
@@ -962,6 +964,7 @@
"type" : "object"
},
"AccountEvent" : {
"additionalProperties" : false,
"properties" : {
"event" : {
"description" : "The event.\n>Permitted values: `InactivateAccount`, `RefundNotPaidOutTransfers`.\nFor more information, refer to [Verification checks](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process).",
@@ -984,6 +987,7 @@
"type" : "object"
},
"AccountFundsBelowThresholdNotification" : {
"additionalProperties" : false,
"properties" : {
"content" : {
"description" : "Details of the liable account with funds under threshold.",
@@ -1027,6 +1031,7 @@
"type" : "object"
},
"AccountFundsBelowThresholdNotificationContent" : {
"additionalProperties" : false,
"properties" : {
"accountCode" : {
"description" : "The code of the account with funds under threshold",
@@ -1056,6 +1061,7 @@
"type" : "object"
},
"AccountHolderCreateNotification" : {
"additionalProperties" : false,
"properties" : {
"content" : {
"description" : "The details of the account holder creation.",
@@ -1099,6 +1105,7 @@
"type" : "object"
},
"AccountHolderDetails" : {
"additionalProperties" : false,
"properties" : {
"address" : {
"description" : "The address of the account holder.",
@@ -1178,6 +1185,7 @@
"type" : "object"
},
"AccountHolderPayoutNotification" : {
"additionalProperties" : false,
"properties" : {
"content" : {
"description" : "Details of the payout to the Account Holder.",
@@ -1221,6 +1229,7 @@
"type" : "object"
},
"AccountHolderPayoutNotificationContent" : {
"additionalProperties" : false,
"properties" : {
"accountCode" : {
"description" : "The code of the account from which the payout was made.",
@@ -1290,6 +1299,7 @@
"type" : "object"
},
"AccountHolderStatus" : {
"additionalProperties" : false,
"properties" : {
"events" : {
"description" : "A list of events scheduled for the account holder.",
@@ -1327,6 +1337,7 @@
"type" : "object"
},
"AccountHolderStatusChangeNotification" : {
"additionalProperties" : false,
"properties" : {
"content" : {
"description" : "The details of the Account Holder status change.",
@@ -1370,6 +1381,7 @@
"type" : "object"
},
"AccountHolderStatusChangeNotificationContent" : {
"additionalProperties" : false,
"properties" : {
"accountHolderCode" : {
"description" : "The code of the account holder.",
@@ -1404,6 +1416,7 @@
"type" : "object"
},
"AccountHolderStoreStatusChangeNotification" : {
"additionalProperties" : false,
"properties" : {
"content" : {
"description" : "The details of the Account Holder Store status change.",
@@ -1447,6 +1460,7 @@
"type" : "object"
},
"AccountHolderStoreStatusChangeNotificationContent" : {
"additionalProperties" : false,
"properties" : {
"accountHolderCode" : {
"x-addedInVersion" : "5",
@@ -1511,6 +1525,7 @@
"type" : "object"
},
"AccountHolderUpcomingDeadlineNotification" : {
"additionalProperties" : false,
"properties" : {
"content" : {
"description" : "The details of the upcoming event.",
@@ -1554,6 +1569,7 @@
"type" : "object"
},
"AccountHolderUpcomingDeadlineNotificationContent" : {
"additionalProperties" : false,
"properties" : {
"accountHolderCode" : {
"description" : "The code of the account holder whom the event refers to.",
@@ -1603,6 +1619,7 @@
"type" : "object"
},
"AccountHolderUpdateNotification" : {
"additionalProperties" : false,
"properties" : {
"content" : {
"description" : "The details of the Account Holder update.",
@@ -1646,6 +1663,7 @@
"type" : "object"
},
"AccountHolderVerificationNotification" : {
"additionalProperties" : false,
"properties" : {
"content" : {
"description" : "The details of the Account Holder verification.",
@@ -1689,6 +1707,7 @@
"type" : "object"
},
"AccountHolderVerificationNotificationContent" : {
"additionalProperties" : false,
"properties" : {
"accountHolderCode" : {
"description" : "The code of the account holder.",
@@ -1715,6 +1734,7 @@
"type" : "object"
},
"AccountPayoutState" : {
"additionalProperties" : false,
"properties" : {
"allowPayout" : {
"description" : "Indicates whether payouts are allowed. This field is the overarching payout status, and is the aggregate of multiple conditions (e.g., KYC status, disabled flag, etc). If this field is false, no payouts will be permitted for any of the account holder's accounts. If this field is true, payouts will be permitted for any of the account holder's accounts.",
@@ -1747,6 +1767,7 @@
"type" : "object"
},
"AccountProcessingState" : {
"additionalProperties" : false,
"properties" : {
"disableReason" : {
"description" : "The reason why processing has been disabled.",
@@ -1774,6 +1795,7 @@
"type" : "object"
},
"AccountUpdateNotification" : {
"additionalProperties" : false,
"properties" : {
"content" : {
"description" : "The details of the Account update.",
@@ -1817,6 +1839,7 @@
"type" : "object"
},
"Amount" : {
"additionalProperties" : false,
"properties" : {
"currency" : {
"description" : "The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes).",
@@ -1837,6 +1860,7 @@
"type" : "object"
},
"BankAccountDetail" : {
"additionalProperties" : false,
"properties" : {
"accountNumber" : {
"description" : "The bank account number (without separators).\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.",
@@ -1948,6 +1972,7 @@
"type" : "object"
},
"BeneficiarySetupNotification" : {
"additionalProperties" : false,
"properties" : {
"content" : {
"description" : "Details of the beneficiary setup.",
@@ -1991,6 +2016,7 @@
"type" : "object"
},
"BeneficiarySetupNotificationContent" : {
"additionalProperties" : false,
"properties" : {
"destinationAccountCode" : {
"description" : "The code of the beneficiary account.",
@@ -2029,6 +2055,7 @@
"type" : "object"
},
"BusinessDetails" : {
"additionalProperties" : false,
"properties" : {
"doingBusinessAs" : {
"description" : "The registered name of the company (if it differs from the legal name of the company).",
@@ -2072,6 +2099,7 @@
"type" : "object"
},
"CloseAccountResponse" : {
"additionalProperties" : false,
"properties" : {
"accountCode" : {
"x-addedInVersion" : "5",
@@ -2109,6 +2137,7 @@
"type" : "object"
},
"CompensateNegativeBalanceNotification" : {
"additionalProperties" : false,
"properties" : {
"content" : {
"description" : "Details of the negative balance compensation.",
@@ -2152,6 +2181,7 @@
"type" : "object"
},
"CompensateNegativeBalanceNotificationContent" : {
"additionalProperties" : false,
"properties" : {
"records" : {
"description" : "A list of the negative balances compensated.",
@@ -2164,6 +2194,7 @@
"type" : "object"
},
"CompensateNegativeBalanceNotificationRecord" : {
"additionalProperties" : false,
"properties" : {
"accountCode" : {
"description" : "The code of the account whose negative balance has been compensated.",
@@ -2182,6 +2213,7 @@
"type" : "object"
},
"CreateAccountHolderResponse" : {
"additionalProperties" : false,
"properties" : {
"accountCode" : {
"description" : "The code of a new account created for the account holder.",
@@ -2246,6 +2278,7 @@
"type" : "object"
},
"CreateAccountResponse" : {
"additionalProperties" : false,
"properties" : {
"accountCode" : {
"description" : "The code of the new account.",
@@ -2323,6 +2356,7 @@
"type" : "object"
},
"DirectDebitInitiatedNotification" : {
"additionalProperties" : false,
"properties" : {
"content" : {
"description" : "Details of the direct debit.",
@@ -2366,6 +2400,7 @@
"type" : "object"
},
"DirectDebitInitiatedNotificationContent" : {
"additionalProperties" : false,
"properties" : {
"accountCode" : {
"description" : "The code of the account.",
@@ -2410,6 +2445,7 @@
"type" : "object"
},
"ErrorFieldType" : {
"additionalProperties" : false,
"properties" : {
"errorCode" : {
"description" : "The validation error code.",
@@ -2428,6 +2464,7 @@
"type" : "object"
},
"FieldType" : {
"additionalProperties" : false,
"properties" : {
"field" : {
"description" : "The full name of the property.",
@@ -2610,6 +2647,7 @@
"type" : "object"
},
"IndividualDetails" : {
"additionalProperties" : false,
"properties" : {
"name" : {
"description" : "The name of the individual.\n>Make sure your account holder registers using the name shown on their Photo ID.",
@@ -2623,6 +2661,7 @@
"type" : "object"
},
"KYCBankAccountCheckResult" : {
"additionalProperties" : false,
"properties" : {
"bankAccountUUID" : {
"description" : "The unique ID of the bank account to which the check applies.",
@@ -2639,6 +2678,7 @@
"type" : "object"
},
"KYCCardCheckResult" : {
"additionalProperties" : false,
"properties" : {
"checks" : {
"description" : "A list of the checks and their statuses.",
@@ -2655,6 +2695,7 @@
"type" : "object"
},
"KYCCheckResult" : {
"additionalProperties" : false,
"properties" : {
"checks" : {
"description" : "A list of the checks and their statuses.",
@@ -2667,6 +2708,7 @@
"type" : "object"
},
"KYCCheckStatusData" : {
"additionalProperties" : false,
"properties" : {
"requiredFields" : {
"description" : "A list of the fields required for execution of the check.",
@@ -2717,6 +2759,7 @@
"type" : "object"
},
"KYCCheckSummary" : {
"additionalProperties" : false,
"properties" : {
"kycCheckCode" : {
"x-addedInVersion" : "5",
@@ -2733,6 +2776,7 @@
"type" : "object"
},
"KYCShareholderCheckResult" : {
"additionalProperties" : false,
"properties" : {
"checks" : {
"description" : "A list of the checks and their statuses.",
@@ -2749,6 +2793,7 @@
"type" : "object"
},
"KYCSignatoryCheckResult" : {
"additionalProperties" : false,
"properties" : {
"checks" : {
"description" : "A list of the checks and their statuses.",
@@ -2765,6 +2810,7 @@
"type" : "object"
},
"KYCVerificationResult" : {
"additionalProperties" : false,
"properties" : {
"accountHolder" : {
"description" : "The results of the checks on the account holder.",
@@ -2803,6 +2849,7 @@
"type" : "object"
},
"LocalDate" : {
"additionalProperties" : false,
"properties" : {
"month" : {
"format" : "int32",
@@ -2816,6 +2863,7 @@
"type" : "object"
},
"Message" : {
"additionalProperties" : false,
"properties" : {
"code" : {
"description" : "The message code.",
@@ -2829,6 +2877,7 @@
"type" : "object"
},
"NotificationErrorContainer" : {
"additionalProperties" : false,
"properties" : {
"errorCode" : {
"description" : "The Adyen code that is mapped to the error message.",
@@ -2842,6 +2891,7 @@
"type" : "object"
},
"NotificationResponse" : {
"additionalProperties" : false,
"properties" : {
"notificationResponse" : {
"description" : "Set this parameter to **[accepted]** to acknowledge that you received a notification from Adyen.",
@@ -2851,6 +2901,7 @@
"type" : "object"
},
"OperationStatus" : {
"additionalProperties" : false,
"properties" : {
"message" : {
"description" : "The message regarding the operation status.",
@@ -2864,6 +2915,7 @@
"type" : "object"
},
"PaymentFailureNotification" : {
"additionalProperties" : false,
"properties" : {
"content" : {
"description" : "The details of the payment failure.",
@@ -2907,6 +2959,7 @@
"type" : "object"
},
"PaymentFailureNotificationContent" : {
"additionalProperties" : false,
"properties" : {
"errorFields" : {
"description" : "Missing or invalid fields that caused the payment error.",
@@ -2939,6 +2992,7 @@
"type" : "object"
},
"PayoutMethod" : {
"additionalProperties" : false,
"properties" : {
"merchantAccount" : {
"description" : "The [`merchantAccount`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__reqParam_merchantAccount) you used in the `/payments` request when you [saved the account holder's card details](https://docs.adyen.com/marketplaces-and-platforms/classic/payouts/manual-payout/payout-to-cards#check-and-store).",
@@ -2969,6 +3023,7 @@
"type" : "object"
},
"PayoutScheduleResponse" : {
"additionalProperties" : false,
"properties" : {
"nextScheduledPayout" : {
"description" : "The date of the next scheduled payout.",
@@ -3000,6 +3055,7 @@
"type" : "object"
},
"PersonalDocumentData" : {
"additionalProperties" : false,
"properties" : {
"expirationDate" : {
"description" : "The expiry date of the document, \n in ISO-8601 YYYY-MM-DD format. For example, **2000-01-31**.",
@@ -3037,6 +3093,7 @@
"type" : "object"
},
"RefundFundsTransferNotification" : {
"additionalProperties" : false,
"properties" : {
"content" : {
"description" : "Details of the fund transfer refund.",
@@ -3080,6 +3137,7 @@
"type" : "object"
},
"RefundFundsTransferNotificationContent" : {
"additionalProperties" : false,
"properties" : {
"amount" : {
"description" : "The amount to be refunded.",
@@ -3113,6 +3171,7 @@
"type" : "object"
},
"RefundResult" : {
"additionalProperties" : false,
"properties" : {
"originalTransaction" : {
"description" : "The transaction that has been refunded.",
@@ -3130,6 +3189,7 @@
"type" : "object"
},
"ReportAvailableNotification" : {
"additionalProperties" : false,
"properties" : {
"content" : {
"description" : "Details of the report.",
@@ -3173,6 +3233,7 @@
"type" : "object"
},
"ReportAvailableNotificationContent" : {
"additionalProperties" : false,
"properties" : {
"accountCode" : {
"description" : "The code of the Account to which the report applies.",
@@ -3199,6 +3260,7 @@
"type" : "object"
},
"ScheduledRefundsNotification" : {
"additionalProperties" : false,
"properties" : {
"content" : {
"description" : "Details of the scheduling of the refunds.",
@@ -3242,6 +3304,7 @@
"type" : "object"
},
"ScheduledRefundsNotificationContent" : {
"additionalProperties" : false,
"properties" : {
"accountCode" : {
"description" : "The code of the account.",
@@ -3274,6 +3337,7 @@
"type" : "object"
},
"ShareholderContact" : {
"additionalProperties" : false,
"properties" : {
"address" : {
"description" : "The address of the person.",
@@ -3329,6 +3393,7 @@
"type" : "object"
},
"SignatoryContact" : {
"additionalProperties" : false,
"properties" : {
"address" : {
"description" : "The address of the person.",
@@ -3374,6 +3439,7 @@
"type" : "object"
},
"Split" : {
"additionalProperties" : false,
"properties" : {
"account" : {
"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.",
@@ -3419,6 +3485,7 @@
"type" : "object"
},
"SplitAmount" : {
"additionalProperties" : false,
"properties" : {
"currency" : {
"description" : "The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes). By default, this is the original payment currency.",
@@ -3438,6 +3505,7 @@
"type" : "object"
},
"StoreDetail" : {
"additionalProperties" : false,
"properties" : {
"address" : {
"description" : "The address of the physical store where the account holder will process payments from.",
@@ -3525,6 +3593,7 @@
"type" : "object"
},
"Transaction" : {
"additionalProperties" : false,
"properties" : {
"amount" : {
"description" : "The amount of the transaction.",
@@ -3649,6 +3718,7 @@
"type" : "object"
},
"TransferFundsNotification" : {
"additionalProperties" : false,
"properties" : {
"content" : {
"description" : "Details of the fund transfer.",
@@ -3692,6 +3762,7 @@
"type" : "object"
},
"TransferFundsNotificationContent" : {
"additionalProperties" : false,
"properties" : {
"amount" : {
"description" : "The amount transferred.",
@@ -3730,6 +3801,7 @@
"type" : "object"
},
"UltimateParentCompany" : {
"additionalProperties" : false,
"properties" : {
"address" : {
"description" : "Address of the ultimate parent company.",
@@ -3747,6 +3819,7 @@
"type" : "object"
},
"UltimateParentCompanyBusinessDetails" : {
"additionalProperties" : false,
"properties" : {
"legalBusinessName" : {
"description" : "The legal name of the company.",
@@ -3772,6 +3845,7 @@
"type" : "object"
},
"UpdateAccountHolderResponse" : {
"additionalProperties" : false,
"properties" : {
"accountHolderCode" : {
"description" : "The code of the account holder.",
@@ -3832,6 +3906,7 @@
"type" : "object"
},
"UpdateAccountResponse" : {
"additionalProperties" : false,
"properties" : {
"accountCode" : {
"description" : "The code of the account.",
@@ -3897,6 +3972,7 @@
"type" : "object"
},
"ViasAddress" : {
"additionalProperties" : false,
"properties" : {
"city" : {
"description" : "The name of the city. Required if the `houseNumberOrName`, `street`, `postalCode`, or `stateOrProvince` are provided.",
@@ -3929,6 +4005,7 @@
"type" : "object"
},
"ViasName" : {
"additionalProperties" : false,
"properties" : {
"firstName" : {
"description" : "The first name.",
@@ -3959,6 +4036,7 @@
"type" : "object"
},
"ViasPersonalData" : {
"additionalProperties" : false,
"properties" : {
"dateOfBirth" : {
"description" : "The person's date of birth, in ISO-8601 YYYY-MM-DD format. For example, **2000-01-31**.",
@@ -3982,6 +4060,7 @@
"type" : "object"
},
"ViasPhoneNumber" : {
"additionalProperties" : false,
"properties" : {
"phoneCountryCode" : {
"description" : "The two-character country code of the phone number.\n>The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL').",

83
json/MarketPayNotificationService-v6.json
View File

@@ -876,6 +876,7 @@
"components" : {
"schemas" : {
"AccountCloseNotification" : {
"additionalProperties" : false,
"properties" : {
"content" : {
"description" : "The details of the Account update.",
@@ -919,6 +920,7 @@
"type" : "object"
},
"AccountCreateNotification" : {
"additionalProperties" : false,
"properties" : {
"content" : {
"description" : "The details of the account creation.",
@@ -962,6 +964,7 @@
"type" : "object"
},
"AccountEvent" : {
"additionalProperties" : false,
"properties" : {
"event" : {
"description" : "The event.\n>Permitted values: `InactivateAccount`, `RefundNotPaidOutTransfers`.\nFor more information, refer to [Verification checks](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process).",
@@ -984,6 +987,7 @@
"type" : "object"
},
"AccountFundsBelowThresholdNotification" : {
"additionalProperties" : false,
"properties" : {
"content" : {
"description" : "Details of the liable account with funds under threshold.",
@@ -1027,6 +1031,7 @@
"type" : "object"
},
"AccountFundsBelowThresholdNotificationContent" : {
"additionalProperties" : false,
"properties" : {
"accountCode" : {
"description" : "The code of the account with funds under threshold",
@@ -1056,6 +1061,7 @@
"type" : "object"
},
"AccountHolderCreateNotification" : {
"additionalProperties" : false,
"properties" : {
"content" : {
"description" : "The details of the account holder creation.",
@@ -1099,6 +1105,7 @@
"type" : "object"
},
"AccountHolderDetails" : {
"additionalProperties" : false,
"properties" : {
"address" : {
"description" : "The address of the account holder.",
@@ -1186,6 +1193,7 @@
"type" : "object"
},
"AccountHolderPayoutNotification" : {
"additionalProperties" : false,
"properties" : {
"content" : {
"description" : "Details of the payout to the Account Holder.",
@@ -1229,6 +1237,7 @@
"type" : "object"
},
"AccountHolderPayoutNotificationContent" : {
"additionalProperties" : false,
"properties" : {
"accountCode" : {
"description" : "The code of the account from which the payout was made.",
@@ -1325,6 +1334,7 @@
"type" : "object"
},
"AccountHolderStatus" : {
"additionalProperties" : false,
"properties" : {
"events" : {
"description" : "A list of events scheduled for the account holder.",
@@ -1362,6 +1372,7 @@
"type" : "object"
},
"AccountHolderStatusChangeNotification" : {
"additionalProperties" : false,
"properties" : {
"content" : {
"description" : "The details of the Account Holder status change.",
@@ -1405,6 +1416,7 @@
"type" : "object"
},
"AccountHolderStatusChangeNotificationContent" : {
"additionalProperties" : false,
"properties" : {
"accountHolderCode" : {
"description" : "The code of the account holder.",
@@ -1439,6 +1451,7 @@
"type" : "object"
},
"AccountHolderStoreStatusChangeNotification" : {
"additionalProperties" : false,
"properties" : {
"content" : {
"description" : "The details of the Account Holder Store status change.",
@@ -1482,6 +1495,7 @@
"type" : "object"
},
"AccountHolderStoreStatusChangeNotificationContent" : {
"additionalProperties" : false,
"properties" : {
"accountHolderCode" : {
"x-addedInVersion" : "5",
@@ -1546,6 +1560,7 @@
"type" : "object"
},
"AccountHolderUpcomingDeadlineNotification" : {
"additionalProperties" : false,
"properties" : {
"content" : {
"description" : "The details of the upcoming event.",
@@ -1589,6 +1604,7 @@
"type" : "object"
},
"AccountHolderUpcomingDeadlineNotificationContent" : {
"additionalProperties" : false,
"properties" : {
"accountHolderCode" : {
"description" : "The code of the account holder whom the event refers to.",
@@ -1638,6 +1654,7 @@
"type" : "object"
},
"AccountHolderUpdateNotification" : {
"additionalProperties" : false,
"properties" : {
"content" : {
"description" : "The details of the Account Holder update.",
@@ -1681,6 +1698,7 @@
"type" : "object"
},
"AccountHolderVerificationNotification" : {
"additionalProperties" : false,
"properties" : {
"content" : {
"description" : "The details of the Account Holder verification.",
@@ -1724,6 +1742,7 @@
"type" : "object"
},
"AccountHolderVerificationNotificationContent" : {
"additionalProperties" : false,
"properties" : {
"accountHolderCode" : {
"description" : "The code of the account holder.",
@@ -1761,6 +1780,7 @@
"type" : "object"
},
"AccountPayoutState" : {
"additionalProperties" : false,
"properties" : {
"allowPayout" : {
"description" : "Indicates whether payouts are allowed. This field is the overarching payout status, and is the aggregate of multiple conditions (e.g., KYC status, disabled flag, etc). If this field is false, no payouts will be permitted for any of the account holder's accounts. If this field is true, payouts will be permitted for any of the account holder's accounts.",
@@ -1793,6 +1813,7 @@
"type" : "object"
},
"AccountProcessingState" : {
"additionalProperties" : false,
"properties" : {
"disableReason" : {
"description" : "The reason why processing has been disabled.",
@@ -1820,6 +1841,7 @@
"type" : "object"
},
"AccountUpdateNotification" : {
"additionalProperties" : false,
"properties" : {
"content" : {
"description" : "The details of the Account update.",
@@ -1863,6 +1885,7 @@
"type" : "object"
},
"Amount" : {
"additionalProperties" : false,
"properties" : {
"currency" : {
"description" : "The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes).",
@@ -1883,6 +1906,7 @@
"type" : "object"
},
"BankAccountDetail" : {
"additionalProperties" : false,
"properties" : {
"accountNumber" : {
"description" : "The bank account number (without separators).\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.",
@@ -1994,6 +2018,7 @@
"type" : "object"
},
"BeneficiarySetupNotification" : {
"additionalProperties" : false,
"properties" : {
"content" : {
"description" : "Details of the beneficiary setup.",
@@ -2037,6 +2062,7 @@
"type" : "object"
},
"BeneficiarySetupNotificationContent" : {
"additionalProperties" : false,
"properties" : {
"destinationAccountCode" : {
"description" : "The code of the beneficiary account.",
@@ -2075,6 +2101,7 @@
"type" : "object"
},
"BusinessDetails" : {
"additionalProperties" : false,
"properties" : {
"doingBusinessAs" : {
"description" : "The registered name of the company (if it differs from the legal name of the company).",
@@ -2133,6 +2160,7 @@
"type" : "object"
},
"CloseAccountResponse" : {
"additionalProperties" : false,
"properties" : {
"accountCode" : {
"x-addedInVersion" : "5",
@@ -2170,6 +2198,7 @@
"type" : "object"
},
"CompensateNegativeBalanceNotification" : {
"additionalProperties" : false,
"properties" : {
"content" : {
"description" : "Details of the negative balance compensation.",
@@ -2213,6 +2242,7 @@
"type" : "object"
},
"CompensateNegativeBalanceNotificationContent" : {
"additionalProperties" : false,
"properties" : {
"records" : {
"description" : "A list of the negative balances compensated.",
@@ -2225,6 +2255,7 @@
"type" : "object"
},
"CompensateNegativeBalanceNotificationRecord" : {
"additionalProperties" : false,
"properties" : {
"accountCode" : {
"description" : "The code of the account whose negative balance has been compensated.",
@@ -2243,6 +2274,7 @@
"type" : "object"
},
"CreateAccountHolderResponse" : {
"additionalProperties" : false,
"properties" : {
"accountCode" : {
"description" : "The code of a new account created for the account holder.",
@@ -2314,6 +2346,7 @@
"type" : "object"
},
"CreateAccountResponse" : {
"additionalProperties" : false,
"properties" : {
"accountCode" : {
"description" : "The code of the new account.",
@@ -2391,6 +2424,7 @@
"type" : "object"
},
"DirectDebitInitiatedNotification" : {
"additionalProperties" : false,
"properties" : {
"content" : {
"description" : "Details of the direct debit.",
@@ -2434,6 +2468,7 @@
"type" : "object"
},
"DirectDebitInitiatedNotificationContent" : {
"additionalProperties" : false,
"properties" : {
"accountCode" : {
"description" : "The code of the account.",
@@ -2478,6 +2513,7 @@
"type" : "object"
},
"ErrorFieldType" : {
"additionalProperties" : false,
"properties" : {
"errorCode" : {
"description" : "The validation error code.",
@@ -2496,6 +2532,7 @@
"type" : "object"
},
"FieldType" : {
"additionalProperties" : false,
"properties" : {
"field" : {
"description" : "The full name of the property.",
@@ -2678,6 +2715,7 @@
"type" : "object"
},
"IndividualDetails" : {
"additionalProperties" : false,
"properties" : {
"name" : {
"description" : "The name of the individual.\n>Make sure your account holder registers using the name shown on their Photo ID.",
@@ -2691,6 +2729,7 @@
"type" : "object"
},
"KYCCheckResult" : {
"additionalProperties" : false,
"properties" : {
"checks" : {
"description" : "A list of the checks and their statuses.",
@@ -2703,6 +2742,7 @@
"type" : "object"
},
"KYCCheckStatusData" : {
"additionalProperties" : false,
"properties" : {
"requiredFields" : {
"description" : "A list of the fields required for execution of the check.",
@@ -2753,6 +2793,7 @@
"type" : "object"
},
"KYCCheckSummary" : {
"additionalProperties" : false,
"properties" : {
"kycCheckCode" : {
"x-addedInVersion" : "5",
@@ -2769,6 +2810,7 @@
"type" : "object"
},
"KYCLegalArrangementCheckResult" : {
"additionalProperties" : false,
"properties" : {
"checks" : {
"description" : "A list of the checks and their statuses.",
@@ -2785,6 +2827,7 @@
"type" : "object"
},
"KYCLegalArrangementEntityCheckResult" : {
"additionalProperties" : false,
"properties" : {
"checks" : {
"description" : "A list of the checks and their statuses.",
@@ -2805,6 +2848,7 @@
"type" : "object"
},
"KYCPayoutMethodCheckResult" : {
"additionalProperties" : false,
"properties" : {
"checks" : {
"description" : "A list of the checks and their statuses.",
@@ -2821,6 +2865,7 @@
"type" : "object"
},
"KYCShareholderCheckResult" : {
"additionalProperties" : false,
"properties" : {
"checks" : {
"description" : "A list of the checks and their statuses.",
@@ -2847,6 +2892,7 @@
"type" : "object"
},
"KYCSignatoryCheckResult" : {
"additionalProperties" : false,
"properties" : {
"checks" : {
"description" : "A list of the checks and their statuses.",
@@ -2863,6 +2909,7 @@
"type" : "object"
},
"KYCUltimateParentCompanyCheckResult" : {
"additionalProperties" : false,
"properties" : {
"checks" : {
"description" : "A list of the checks and their statuses.",
@@ -2880,6 +2927,7 @@
"type" : "object"
},
"KYCVerificationResult" : {
"additionalProperties" : false,
"properties" : {
"accountHolder" : {
"description" : "The results of the checks on the account holder.",
@@ -2935,6 +2983,7 @@
"type" : "object"
},
"LegalArrangementDetail" : {
"additionalProperties" : false,
"properties" : {
"address" : {
"description" : "The address of the legal arrangement.",
@@ -3010,6 +3059,7 @@
"type" : "object"
},
"LegalArrangementEntityDetail" : {
"additionalProperties" : false,
"properties" : {
"address" : {
"description" : "The address of the entity.",
@@ -3078,6 +3128,7 @@
"type" : "object"
},
"LocalDate" : {
"additionalProperties" : false,
"properties" : {
"month" : {
"format" : "int32",
@@ -3091,6 +3142,7 @@
"type" : "object"
},
"Message" : {
"additionalProperties" : false,
"properties" : {
"code" : {
"description" : "The message code.",
@@ -3104,6 +3156,7 @@
"type" : "object"
},
"NotificationErrorContainer" : {
"additionalProperties" : false,
"properties" : {
"errorCode" : {
"description" : "The Adyen code that is mapped to the error message.",
@@ -3117,6 +3170,7 @@
"type" : "object"
},
"NotificationResponse" : {
"additionalProperties" : false,
"properties" : {
"notificationResponse" : {
"description" : "Set this parameter to **[accepted]** to acknowledge that you received a notification from Adyen.",
@@ -3126,6 +3180,7 @@
"type" : "object"
},
"OperationStatus" : {
"additionalProperties" : false,
"properties" : {
"message" : {
"description" : "The message regarding the operation status.",
@@ -3139,6 +3194,7 @@
"type" : "object"
},
"PaymentFailureNotification" : {
"additionalProperties" : false,
"properties" : {
"content" : {
"description" : "The details of the payment failure.",
@@ -3182,6 +3238,7 @@
"type" : "object"
},
"PaymentFailureNotificationContent" : {
"additionalProperties" : false,
"properties" : {
"errorFields" : {
"description" : "Missing or invalid fields that caused the payment error.",
@@ -3214,6 +3271,7 @@
"type" : "object"
},
"PayoutMethod" : {
"additionalProperties" : false,
"properties" : {
"merchantAccount" : {
"description" : "The [`merchantAccount`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__reqParam_merchantAccount) you used in the `/payments` request when you [saved the account holder's card details](https://docs.adyen.com/marketplaces-and-platforms/classic/payouts/manual-payout/payout-to-cards#check-and-store).",
@@ -3244,6 +3302,7 @@
"type" : "object"
},
"PayoutScheduleResponse" : {
"additionalProperties" : false,
"properties" : {
"nextScheduledPayout" : {
"description" : "The date of the next scheduled payout.",
@@ -3275,6 +3334,7 @@
"type" : "object"
},
"PersonalDocumentData" : {
"additionalProperties" : false,
"properties" : {
"expirationDate" : {
"description" : "The expiry date of the document, \n in ISO-8601 YYYY-MM-DD format. For example, **2000-01-31**.",
@@ -3312,6 +3372,7 @@
"type" : "object"
},
"RefundFundsTransferNotification" : {
"additionalProperties" : false,
"properties" : {
"content" : {
"description" : "Details of the fund transfer refund.",
@@ -3355,6 +3416,7 @@
"type" : "object"
},
"RefundFundsTransferNotificationContent" : {
"additionalProperties" : false,
"properties" : {
"amount" : {
"description" : "The amount to be refunded.",
@@ -3388,6 +3450,7 @@
"type" : "object"
},
"RefundResult" : {
"additionalProperties" : false,
"properties" : {
"originalTransaction" : {
"description" : "The transaction that has been refunded.",
@@ -3405,6 +3468,7 @@
"type" : "object"
},
"ReportAvailableNotification" : {
"additionalProperties" : false,
"properties" : {
"content" : {
"description" : "Details of the report.",
@@ -3448,6 +3512,7 @@
"type" : "object"
},
"ReportAvailableNotificationContent" : {
"additionalProperties" : false,
"properties" : {
"accountCode" : {
"description" : "The code of the Account to which the report applies.",
@@ -3474,6 +3539,7 @@
"type" : "object"
},
"ScheduledRefundsNotification" : {
"additionalProperties" : false,
"properties" : {
"content" : {
"description" : "Details of the scheduling of the refunds.",
@@ -3517,6 +3583,7 @@
"type" : "object"
},
"ScheduledRefundsNotificationContent" : {
"additionalProperties" : false,
"properties" : {
"accountCode" : {
"description" : "The code of the account.",
@@ -3549,6 +3616,7 @@
"type" : "object"
},
"ShareholderContact" : {
"additionalProperties" : false,
"properties" : {
"address" : {
"description" : "The address of the person.",
@@ -3604,6 +3672,7 @@
"type" : "object"
},
"SignatoryContact" : {
"additionalProperties" : false,
"properties" : {
"address" : {
"description" : "The address of the person.",
@@ -3649,6 +3718,7 @@
"type" : "object"
},
"Split" : {
"additionalProperties" : false,
"properties" : {
"account" : {
"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.",
@@ -3694,6 +3764,7 @@
"type" : "object"
},
"SplitAmount" : {
"additionalProperties" : false,
"properties" : {
"currency" : {
"description" : "The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes). By default, this is the original payment currency.",
@@ -3713,6 +3784,7 @@
"type" : "object"
},
"StoreDetail" : {
"additionalProperties" : false,
"properties" : {
"address" : {
"description" : "The address of the physical store where the account holder will process payments from.",
@@ -3800,6 +3872,7 @@
"type" : "object"
},
"Transaction" : {
"additionalProperties" : false,
"properties" : {
"amount" : {
"description" : "The amount of the transaction.",
@@ -3924,6 +3997,7 @@
"type" : "object"
},
"TransferFundsNotification" : {
"additionalProperties" : false,
"properties" : {
"content" : {
"description" : "Details of the fund transfer.",
@@ -3967,6 +4041,7 @@
"type" : "object"
},
"TransferFundsNotificationContent" : {
"additionalProperties" : false,
"properties" : {
"amount" : {
"description" : "The amount transferred.",
@@ -4005,6 +4080,7 @@
"type" : "object"
},
"UltimateParentCompany" : {
"additionalProperties" : false,
"properties" : {
"address" : {
"description" : "Address of the ultimate parent company.",
@@ -4022,6 +4098,7 @@
"type" : "object"
},
"UltimateParentCompanyBusinessDetails" : {
"additionalProperties" : false,
"properties" : {
"legalBusinessName" : {
"description" : "The legal name of the company.",
@@ -4047,6 +4124,7 @@
"type" : "object"
},
"UpdateAccountHolderResponse" : {
"additionalProperties" : false,
"properties" : {
"accountHolderCode" : {
"description" : "The code of the account holder.",
@@ -4114,6 +4192,7 @@
"type" : "object"
},
"UpdateAccountResponse" : {
"additionalProperties" : false,
"properties" : {
"accountCode" : {
"description" : "The code of the account.",
@@ -4179,6 +4258,7 @@
"type" : "object"
},
"ViasAddress" : {
"additionalProperties" : false,
"properties" : {
"city" : {
"description" : "The name of the city. Required if the `houseNumberOrName`, `street`, `postalCode`, or `stateOrProvince` are provided.",
@@ -4211,6 +4291,7 @@
"type" : "object"
},
"ViasName" : {
"additionalProperties" : false,
"properties" : {
"firstName" : {
"description" : "The first name.",
@@ -4241,6 +4322,7 @@
"type" : "object"
},
"ViasPersonalData" : {
"additionalProperties" : false,
"properties" : {
"dateOfBirth" : {
"description" : "The person's date of birth, in ISO-8601 YYYY-MM-DD format. For example, **2000-01-31**.",
@@ -4264,6 +4346,7 @@
"type" : "object"
},
"ViasPhoneNumber" : {
"additionalProperties" : false,
"properties" : {
"phoneCountryCode" : {
"description" : "The two-character country code of the phone number.\n>The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL').",

14
json/NotificationConfigurationService-v1.json
View File

@@ -644,6 +644,7 @@
"components" : {
"schemas" : {
"CreateNotificationConfigurationRequest" : {
"additionalProperties" : false,
"properties" : {
"configurationDetails" : {
"description" : "Details of the prospective notification subscription configuration.",
@@ -656,6 +657,7 @@
"type" : "object"
},
"DeleteNotificationConfigurationRequest" : {
"additionalProperties" : false,
"properties" : {
"notificationIds" : {
"description" : "A list of IDs of the notification subscription configurations to be deleted.",
@@ -672,9 +674,11 @@
"type" : "object"
},
"EmptyRequest" : {
"additionalProperties" : false,
"type" : "object"
},
"ExchangeMessage" : {
"additionalProperties" : false,
"properties" : {
"messageCode" : {
"type" : "string"
@@ -693,6 +697,7 @@
}
},
"GenericResponse" : {
"additionalProperties" : false,
"properties" : {
"pspReference" : {
"description" : "The reference of a request. Can be used to uniquely identify the request.",
@@ -710,6 +715,7 @@
"type" : "object"
},
"GetNotificationConfigurationListResponse" : {
"additionalProperties" : false,
"properties" : {
"configurations" : {
"description" : "Details of the notification subscription configurations.",
@@ -734,6 +740,7 @@
"type" : "object"
},
"GetNotificationConfigurationRequest" : {
"additionalProperties" : false,
"properties" : {
"notificationId" : {
"description" : "The ID of the notification subscription configuration whose details are to be retrieved.",
@@ -747,6 +754,7 @@
"type" : "object"
},
"GetNotificationConfigurationResponse" : {
"additionalProperties" : false,
"properties" : {
"configurationDetails" : {
"description" : "Details of the notification subscription configuration.",
@@ -771,6 +779,7 @@
"type" : "object"
},
"NotificationConfigurationDetails" : {
"additionalProperties" : false,
"properties" : {
"active" : {
"description" : "Indicates whether the notification subscription is active.",
@@ -842,6 +851,7 @@
}
},
"NotificationEventConfiguration" : {
"additionalProperties" : false,
"properties" : {
"eventType" : {
"description" : "The type of event.\n\nPossible values: **ACCOUNT_CLOSED**, **ACCOUNT_CREATED**, **ACCOUNT_FUNDS_BELOW_THRESHOLD**, **ACCOUNT_HOLDER_CREATED**, **ACCOUNT_HOLDER_LIMIT_REACHED**, **ACCOUNT_HOLDER_PAYOUT**, **ACCOUNT_HOLDER_STATUS_CHANGE**, **ACCOUNT_HOLDER_STORE_STATUS_CHANGE**, **ACCOUNT_HOLDER_UPCOMING_DEADLINE**, **ACCOUNT_HOLDER_UPDATED**, **ACCOUNT_HOLDER_VERIFICATION**, **ACCOUNT_UPDATED**, **BENEFICIARY_SETUP**, **COMPENSATE_NEGATIVE_BALANCE**, **DIRECT_DEBIT_INITIATED**, **PAYMENT_FAILURE**, **REFUND_FUNDS_TRANSFER**, **REPORT_AVAILABLE**, **SCHEDULED_REFUNDS**, **TRANSFER_FUNDS**.",
@@ -897,6 +907,7 @@
}
},
"ServiceError" : {
"additionalProperties" : false,
"properties" : {
"errorCode" : {
"description" : "The error code mapped to the error message.",
@@ -923,6 +934,7 @@
"type" : "object"
},
"TestNotificationConfigurationRequest" : {
"additionalProperties" : false,
"properties" : {
"eventTypes" : {
"description" : "The event types to test. If left blank, then all of the configured event types will be tested.\n>Permitted values: `ACCOUNT_HOLDER_CREATED`, `ACCOUNT_CREATED`, `ACCOUNT_UPDATED`, `ACCOUNT_HOLDER_UPDATED`, `ACCOUNT_HOLDER_STATUS_CHANGE`, `ACCOUNT_HOLDER_STORE_STATUS_CHANGE` `ACCOUNT_HOLDER_VERIFICATION`, `ACCOUNT_HOLDER_LIMIT_REACHED`, `ACCOUNT_HOLDER_PAYOUT`, `PAYMENT_FAILURE`, `SCHEDULED_REFUNDS`, `REPORT_AVAILABLE`, `TRANSFER_FUNDS`, `BENEFICIARY_SETUP`, `COMPENSATE_NEGATIVE_BALANCE`.",
@@ -970,6 +982,7 @@
"type" : "object"
},
"TestNotificationConfigurationResponse" : {
"additionalProperties" : false,
"properties" : {
"errorMessages" : {
"description" : "Any error messages encountered.",
@@ -1050,6 +1063,7 @@
"type" : "object"
},
"UpdateNotificationConfigurationRequest" : {
"additionalProperties" : false,
"properties" : {
"configurationDetails" : {
"description" : "Details of the notification subscription configuration to be updated.",

14
json/NotificationConfigurationService-v2.json
View File

@@ -644,6 +644,7 @@
"components" : {
"schemas" : {
"CreateNotificationConfigurationRequest" : {
"additionalProperties" : false,
"properties" : {
"configurationDetails" : {
"description" : "Details of the prospective notification subscription configuration.",
@@ -656,6 +657,7 @@
"type" : "object"
},
"DeleteNotificationConfigurationRequest" : {
"additionalProperties" : false,
"properties" : {
"notificationIds" : {
"description" : "A list of IDs of the notification subscription configurations to be deleted.",
@@ -672,9 +674,11 @@
"type" : "object"
},
"EmptyRequest" : {
"additionalProperties" : false,
"type" : "object"
},
"ExchangeMessage" : {
"additionalProperties" : false,
"properties" : {
"messageCode" : {
"type" : "string"
@@ -693,6 +697,7 @@
}
},
"GenericResponse" : {
"additionalProperties" : false,
"properties" : {
"pspReference" : {
"description" : "The reference of a request. Can be used to uniquely identify the request.",
@@ -710,6 +715,7 @@
"type" : "object"
},
"GetNotificationConfigurationListResponse" : {
"additionalProperties" : false,
"properties" : {
"configurations" : {
"description" : "Details of the notification subscription configurations.",
@@ -734,6 +740,7 @@
"type" : "object"
},
"GetNotificationConfigurationRequest" : {
"additionalProperties" : false,
"properties" : {
"notificationId" : {
"description" : "The ID of the notification subscription configuration whose details are to be retrieved.",
@@ -747,6 +754,7 @@
"type" : "object"
},
"GetNotificationConfigurationResponse" : {
"additionalProperties" : false,
"properties" : {
"configurationDetails" : {
"description" : "Details of the notification subscription configuration.",
@@ -771,6 +779,7 @@
"type" : "object"
},
"NotificationConfigurationDetails" : {
"additionalProperties" : false,
"properties" : {
"active" : {
"description" : "Indicates whether the notification subscription is active.",
@@ -842,6 +851,7 @@
}
},
"NotificationEventConfiguration" : {
"additionalProperties" : false,
"properties" : {
"eventType" : {
"description" : "The type of event.\n\nPossible values: **ACCOUNT_CLOSED**, **ACCOUNT_CREATED**, **ACCOUNT_FUNDS_BELOW_THRESHOLD**, **ACCOUNT_HOLDER_CREATED**, **ACCOUNT_HOLDER_LIMIT_REACHED**, **ACCOUNT_HOLDER_PAYOUT**, **ACCOUNT_HOLDER_STATUS_CHANGE**, **ACCOUNT_HOLDER_STORE_STATUS_CHANGE**, **ACCOUNT_HOLDER_UPCOMING_DEADLINE**, **ACCOUNT_HOLDER_UPDATED**, **ACCOUNT_HOLDER_VERIFICATION**, **ACCOUNT_UPDATED**, **BENEFICIARY_SETUP**, **COMPENSATE_NEGATIVE_BALANCE**, **DIRECT_DEBIT_INITIATED**, **PAYMENT_FAILURE**, **REFUND_FUNDS_TRANSFER**, **REPORT_AVAILABLE**, **SCHEDULED_REFUNDS**, **TRANSFER_FUNDS**.",
@@ -897,6 +907,7 @@
}
},
"ServiceError" : {
"additionalProperties" : false,
"properties" : {
"errorCode" : {
"description" : "The error code mapped to the error message.",
@@ -923,6 +934,7 @@
"type" : "object"
},
"TestNotificationConfigurationRequest" : {
"additionalProperties" : false,
"properties" : {
"eventTypes" : {
"description" : "The event types to test. If left blank, then all of the configured event types will be tested.\n>Permitted values: `ACCOUNT_HOLDER_CREATED`, `ACCOUNT_CREATED`, `ACCOUNT_UPDATED`, `ACCOUNT_HOLDER_UPDATED`, `ACCOUNT_HOLDER_STATUS_CHANGE`, `ACCOUNT_HOLDER_STORE_STATUS_CHANGE` `ACCOUNT_HOLDER_VERIFICATION`, `ACCOUNT_HOLDER_LIMIT_REACHED`, `ACCOUNT_HOLDER_PAYOUT`, `PAYMENT_FAILURE`, `SCHEDULED_REFUNDS`, `REPORT_AVAILABLE`, `TRANSFER_FUNDS`, `BENEFICIARY_SETUP`, `COMPENSATE_NEGATIVE_BALANCE`.",
@@ -970,6 +982,7 @@
"type" : "object"
},
"TestNotificationConfigurationResponse" : {
"additionalProperties" : false,
"properties" : {
"errorMessages" : {
"description" : "Any error messages encountered.",
@@ -1050,6 +1063,7 @@
"type" : "object"
},
"UpdateNotificationConfigurationRequest" : {
"additionalProperties" : false,
"properties" : {
"configurationDetails" : {
"description" : "Details of the notification subscription configuration to be updated.",

14
json/NotificationConfigurationService-v3.json
View File

@@ -644,6 +644,7 @@
"components" : {
"schemas" : {
"CreateNotificationConfigurationRequest" : {
"additionalProperties" : false,
"properties" : {
"configurationDetails" : {
"description" : "Details of the prospective notification subscription configuration.",
@@ -656,6 +657,7 @@
"type" : "object"
},
"DeleteNotificationConfigurationRequest" : {
"additionalProperties" : false,
"properties" : {
"notificationIds" : {
"description" : "A list of IDs of the notification subscription configurations to be deleted.",
@@ -672,9 +674,11 @@
"type" : "object"
},
"EmptyRequest" : {
"additionalProperties" : false,
"type" : "object"
},
"ExchangeMessage" : {
"additionalProperties" : false,
"properties" : {
"messageCode" : {
"type" : "string"
@@ -693,6 +697,7 @@
}
},
"GenericResponse" : {
"additionalProperties" : false,
"properties" : {
"pspReference" : {
"description" : "The reference of a request. Can be used to uniquely identify the request.",
@@ -710,6 +715,7 @@
"type" : "object"
},
"GetNotificationConfigurationListResponse" : {
"additionalProperties" : false,
"properties" : {
"configurations" : {
"description" : "Details of the notification subscription configurations.",
@@ -734,6 +740,7 @@
"type" : "object"
},
"GetNotificationConfigurationRequest" : {
"additionalProperties" : false,
"properties" : {
"notificationId" : {
"description" : "The ID of the notification subscription configuration whose details are to be retrieved.",
@@ -747,6 +754,7 @@
"type" : "object"
},
"GetNotificationConfigurationResponse" : {
"additionalProperties" : false,
"properties" : {
"configurationDetails" : {
"description" : "Details of the notification subscription configuration.",
@@ -771,6 +779,7 @@
"type" : "object"
},
"NotificationConfigurationDetails" : {
"additionalProperties" : false,
"properties" : {
"active" : {
"description" : "Indicates whether the notification subscription is active.",
@@ -842,6 +851,7 @@
}
},
"NotificationEventConfiguration" : {
"additionalProperties" : false,
"properties" : {
"eventType" : {
"description" : "The type of event.\n\nPossible values: **ACCOUNT_CLOSED**, **ACCOUNT_CREATED**, **ACCOUNT_FUNDS_BELOW_THRESHOLD**, **ACCOUNT_HOLDER_CREATED**, **ACCOUNT_HOLDER_LIMIT_REACHED**, **ACCOUNT_HOLDER_PAYOUT**, **ACCOUNT_HOLDER_STATUS_CHANGE**, **ACCOUNT_HOLDER_STORE_STATUS_CHANGE**, **ACCOUNT_HOLDER_UPCOMING_DEADLINE**, **ACCOUNT_HOLDER_UPDATED**, **ACCOUNT_HOLDER_VERIFICATION**, **ACCOUNT_UPDATED**, **BENEFICIARY_SETUP**, **COMPENSATE_NEGATIVE_BALANCE**, **DIRECT_DEBIT_INITIATED**, **PAYMENT_FAILURE**, **REFUND_FUNDS_TRANSFER**, **REPORT_AVAILABLE**, **SCHEDULED_REFUNDS**, **TRANSFER_FUNDS**.",
@@ -897,6 +907,7 @@
}
},
"ServiceError" : {
"additionalProperties" : false,
"properties" : {
"errorCode" : {
"description" : "The error code mapped to the error message.",
@@ -923,6 +934,7 @@
"type" : "object"
},
"TestNotificationConfigurationRequest" : {
"additionalProperties" : false,
"properties" : {
"eventTypes" : {
"description" : "The event types to test. If left blank, then all of the configured event types will be tested.\n>Permitted values: `ACCOUNT_HOLDER_CREATED`, `ACCOUNT_CREATED`, `ACCOUNT_UPDATED`, `ACCOUNT_HOLDER_UPDATED`, `ACCOUNT_HOLDER_STATUS_CHANGE`, `ACCOUNT_HOLDER_STORE_STATUS_CHANGE` `ACCOUNT_HOLDER_VERIFICATION`, `ACCOUNT_HOLDER_LIMIT_REACHED`, `ACCOUNT_HOLDER_PAYOUT`, `PAYMENT_FAILURE`, `SCHEDULED_REFUNDS`, `REPORT_AVAILABLE`, `TRANSFER_FUNDS`, `BENEFICIARY_SETUP`, `COMPENSATE_NEGATIVE_BALANCE`.",
@@ -970,6 +982,7 @@
"type" : "object"
},
"TestNotificationConfigurationResponse" : {
"additionalProperties" : false,
"properties" : {
"errorMessages" : {
"description" : "Any error messages encountered.",
@@ -1050,6 +1063,7 @@
"type" : "object"
},
"UpdateNotificationConfigurationRequest" : {
"additionalProperties" : false,
"properties" : {
"configurationDetails" : {
"description" : "Details of the notification subscription configuration to be updated.",

14
json/NotificationConfigurationService-v4.json
View File

@@ -644,6 +644,7 @@
"components" : {
"schemas" : {
"CreateNotificationConfigurationRequest" : {
"additionalProperties" : false,
"properties" : {
"configurationDetails" : {
"description" : "Details of the prospective notification subscription configuration.",
@@ -656,6 +657,7 @@
"type" : "object"
},
"DeleteNotificationConfigurationRequest" : {
"additionalProperties" : false,
"properties" : {
"notificationIds" : {
"description" : "A list of IDs of the notification subscription configurations to be deleted.",
@@ -672,9 +674,11 @@
"type" : "object"
},
"EmptyRequest" : {
"additionalProperties" : false,
"type" : "object"
},
"ExchangeMessage" : {
"additionalProperties" : false,
"properties" : {
"messageCode" : {
"type" : "string"
@@ -693,6 +697,7 @@
}
},
"GenericResponse" : {
"additionalProperties" : false,
"properties" : {
"pspReference" : {
"description" : "The reference of a request. Can be used to uniquely identify the request.",
@@ -710,6 +715,7 @@
"type" : "object"
},
"GetNotificationConfigurationListResponse" : {
"additionalProperties" : false,
"properties" : {
"configurations" : {
"description" : "Details of the notification subscription configurations.",
@@ -734,6 +740,7 @@
"type" : "object"
},
"GetNotificationConfigurationRequest" : {
"additionalProperties" : false,
"properties" : {
"notificationId" : {
"description" : "The ID of the notification subscription configuration whose details are to be retrieved.",
@@ -747,6 +754,7 @@
"type" : "object"
},
"GetNotificationConfigurationResponse" : {
"additionalProperties" : false,
"properties" : {
"configurationDetails" : {
"description" : "Details of the notification subscription configuration.",
@@ -771,6 +779,7 @@
"type" : "object"
},
"NotificationConfigurationDetails" : {
"additionalProperties" : false,
"properties" : {
"active" : {
"description" : "Indicates whether the notification subscription is active.",
@@ -842,6 +851,7 @@
}
},
"NotificationEventConfiguration" : {
"additionalProperties" : false,
"properties" : {
"eventType" : {
"description" : "The type of event.\n\nPossible values: **ACCOUNT_CLOSED**, **ACCOUNT_CREATED**, **ACCOUNT_FUNDS_BELOW_THRESHOLD**, **ACCOUNT_HOLDER_CREATED**, **ACCOUNT_HOLDER_LIMIT_REACHED**, **ACCOUNT_HOLDER_PAYOUT**, **ACCOUNT_HOLDER_STATUS_CHANGE**, **ACCOUNT_HOLDER_STORE_STATUS_CHANGE**, **ACCOUNT_HOLDER_UPCOMING_DEADLINE**, **ACCOUNT_HOLDER_UPDATED**, **ACCOUNT_HOLDER_VERIFICATION**, **ACCOUNT_UPDATED**, **BENEFICIARY_SETUP**, **COMPENSATE_NEGATIVE_BALANCE**, **DIRECT_DEBIT_INITIATED**, **PAYMENT_FAILURE**, **REFUND_FUNDS_TRANSFER**, **REPORT_AVAILABLE**, **SCHEDULED_REFUNDS**, **TRANSFER_FUNDS**.",
@@ -897,6 +907,7 @@
}
},
"ServiceError" : {
"additionalProperties" : false,
"properties" : {
"errorCode" : {
"description" : "The error code mapped to the error message.",
@@ -923,6 +934,7 @@
"type" : "object"
},
"TestNotificationConfigurationRequest" : {
"additionalProperties" : false,
"properties" : {
"eventTypes" : {
"description" : "The event types to test. If left blank, then all of the configured event types will be tested.\n>Permitted values: `ACCOUNT_HOLDER_CREATED`, `ACCOUNT_CREATED`, `ACCOUNT_UPDATED`, `ACCOUNT_HOLDER_UPDATED`, `ACCOUNT_HOLDER_STATUS_CHANGE`, `ACCOUNT_HOLDER_STORE_STATUS_CHANGE` `ACCOUNT_HOLDER_VERIFICATION`, `ACCOUNT_HOLDER_LIMIT_REACHED`, `ACCOUNT_HOLDER_PAYOUT`, `PAYMENT_FAILURE`, `SCHEDULED_REFUNDS`, `REPORT_AVAILABLE`, `TRANSFER_FUNDS`, `BENEFICIARY_SETUP`, `COMPENSATE_NEGATIVE_BALANCE`.",
@@ -970,6 +982,7 @@
"type" : "object"
},
"TestNotificationConfigurationResponse" : {
"additionalProperties" : false,
"properties" : {
"errorMessages" : {
"description" : "Any error messages encountered.",
@@ -1050,6 +1063,7 @@
"type" : "object"
},
"UpdateNotificationConfigurationRequest" : {
"additionalProperties" : false,
"properties" : {
"configurationDetails" : {
"description" : "Details of the notification subscription configuration to be updated.",

16
json/NotificationConfigurationService-v5.json
View File

@@ -644,6 +644,7 @@
"components" : {
"schemas" : {
"CreateNotificationConfigurationRequest" : {
"additionalProperties" : false,
"properties" : {
"configurationDetails" : {
"description" : "Details of the prospective notification subscription configuration.",
@@ -656,6 +657,7 @@
"type" : "object"
},
"DeleteNotificationConfigurationRequest" : {
"additionalProperties" : false,
"properties" : {
"notificationIds" : {
"description" : "A list of IDs of the notification subscription configurations to be deleted.",
@@ -672,9 +674,11 @@
"type" : "object"
},
"EmptyRequest" : {
"additionalProperties" : false,
"type" : "object"
},
"ErrorFieldType" : {
"additionalProperties" : false,
"properties" : {
"errorCode" : {
"description" : "The validation error code.",
@@ -693,6 +697,7 @@
"type" : "object"
},
"ExchangeMessage" : {
"additionalProperties" : false,
"properties" : {
"messageCode" : {
"type" : "string"
@@ -704,6 +709,7 @@
"type" : "object"
},
"FieldType" : {
"additionalProperties" : false,
"properties" : {
"field" : {
"description" : "The full name of the property.",
@@ -886,6 +892,7 @@
"type" : "object"
},
"GenericResponse" : {
"additionalProperties" : false,
"properties" : {
"invalidFields" : {
"x-addedInVersion" : "5",
@@ -907,6 +914,7 @@
"type" : "object"
},
"GetNotificationConfigurationListResponse" : {
"additionalProperties" : false,
"properties" : {
"configurations" : {
"description" : "Details of the notification subscription configurations.",
@@ -935,6 +943,7 @@
"type" : "object"
},
"GetNotificationConfigurationRequest" : {
"additionalProperties" : false,
"properties" : {
"notificationId" : {
"description" : "The ID of the notification subscription configuration whose details are to be retrieved.",
@@ -948,6 +957,7 @@
"type" : "object"
},
"GetNotificationConfigurationResponse" : {
"additionalProperties" : false,
"properties" : {
"configurationDetails" : {
"description" : "Details of the notification subscription configuration.",
@@ -976,6 +986,7 @@
"type" : "object"
},
"NotificationConfigurationDetails" : {
"additionalProperties" : false,
"properties" : {
"active" : {
"description" : "Indicates whether the notification subscription is active.",
@@ -1031,6 +1042,7 @@
"type" : "object"
},
"NotificationEventConfiguration" : {
"additionalProperties" : false,
"properties" : {
"eventType" : {
"description" : "The type of event.\n\nPossible values: **ACCOUNT_CLOSED**, **ACCOUNT_CREATED**, **ACCOUNT_FUNDS_BELOW_THRESHOLD**, **ACCOUNT_HOLDER_CREATED**, **ACCOUNT_HOLDER_LIMIT_REACHED**, **ACCOUNT_HOLDER_PAYOUT**, **ACCOUNT_HOLDER_STATUS_CHANGE**, **ACCOUNT_HOLDER_STORE_STATUS_CHANGE**, **ACCOUNT_HOLDER_UPCOMING_DEADLINE**, **ACCOUNT_HOLDER_UPDATED**, **ACCOUNT_HOLDER_VERIFICATION**, **ACCOUNT_UPDATED**, **BENEFICIARY_SETUP**, **COMPENSATE_NEGATIVE_BALANCE**, **DIRECT_DEBIT_INITIATED**, **PAYMENT_FAILURE**, **REFUND_FUNDS_TRANSFER**, **REPORT_AVAILABLE**, **SCHEDULED_REFUNDS**, **TRANSFER_FUNDS**.",
@@ -1079,6 +1091,7 @@
"type" : "object"
},
"ServiceError" : {
"additionalProperties" : false,
"properties" : {
"errorCode" : {
"description" : "The error code mapped to the error message.",
@@ -1105,6 +1118,7 @@
"type" : "object"
},
"TestNotificationConfigurationRequest" : {
"additionalProperties" : false,
"properties" : {
"eventTypes" : {
"description" : "The event types to test. If left blank, then all of the configured event types will be tested.\n>Permitted values: `ACCOUNT_HOLDER_CREATED`, `ACCOUNT_CREATED`, `ACCOUNT_UPDATED`, `ACCOUNT_HOLDER_UPDATED`, `ACCOUNT_HOLDER_STATUS_CHANGE`, `ACCOUNT_HOLDER_STORE_STATUS_CHANGE` `ACCOUNT_HOLDER_VERIFICATION`, `ACCOUNT_HOLDER_LIMIT_REACHED`, `ACCOUNT_HOLDER_PAYOUT`, `PAYMENT_FAILURE`, `SCHEDULED_REFUNDS`, `REPORT_AVAILABLE`, `TRANSFER_FUNDS`, `BENEFICIARY_SETUP`, `COMPENSATE_NEGATIVE_BALANCE`.",
@@ -1152,6 +1166,7 @@
"type" : "object"
},
"TestNotificationConfigurationResponse" : {
"additionalProperties" : false,
"properties" : {
"errorMessages" : {
"description" : "Any error messages encountered.",
@@ -1236,6 +1251,7 @@
"type" : "object"
},
"UpdateNotificationConfigurationRequest" : {
"additionalProperties" : false,
"properties" : {
"configurationDetails" : {
"description" : "Details of the notification subscription configuration to be updated.",

16
json/NotificationConfigurationService-v6.json
View File

@@ -644,6 +644,7 @@
"components" : {
"schemas" : {
"CreateNotificationConfigurationRequest" : {
"additionalProperties" : false,
"properties" : {
"configurationDetails" : {
"description" : "Details of the prospective notification subscription configuration.",
@@ -656,6 +657,7 @@
"type" : "object"
},
"DeleteNotificationConfigurationRequest" : {
"additionalProperties" : false,
"properties" : {
"notificationIds" : {
"description" : "A list of IDs of the notification subscription configurations to be deleted.",
@@ -672,9 +674,11 @@
"type" : "object"
},
"EmptyRequest" : {
"additionalProperties" : false,
"type" : "object"
},
"ErrorFieldType" : {
"additionalProperties" : false,
"properties" : {
"errorCode" : {
"description" : "The validation error code.",
@@ -693,6 +697,7 @@
"type" : "object"
},
"ExchangeMessage" : {
"additionalProperties" : false,
"properties" : {
"messageCode" : {
"type" : "string"
@@ -704,6 +709,7 @@
"type" : "object"
},
"FieldType" : {
"additionalProperties" : false,
"properties" : {
"field" : {
"description" : "The full name of the property.",
@@ -886,6 +892,7 @@
"type" : "object"
},
"GenericResponse" : {
"additionalProperties" : false,
"properties" : {
"invalidFields" : {
"x-addedInVersion" : "5",
@@ -907,6 +914,7 @@
"type" : "object"
},
"GetNotificationConfigurationListResponse" : {
"additionalProperties" : false,
"properties" : {
"configurations" : {
"description" : "Details of the notification subscription configurations.",
@@ -935,6 +943,7 @@
"type" : "object"
},
"GetNotificationConfigurationRequest" : {
"additionalProperties" : false,
"properties" : {
"notificationId" : {
"description" : "The ID of the notification subscription configuration whose details are to be retrieved.",
@@ -948,6 +957,7 @@
"type" : "object"
},
"GetNotificationConfigurationResponse" : {
"additionalProperties" : false,
"properties" : {
"configurationDetails" : {
"description" : "Details of the notification subscription configuration.",
@@ -976,6 +986,7 @@
"type" : "object"
},
"NotificationConfigurationDetails" : {
"additionalProperties" : false,
"properties" : {
"active" : {
"description" : "Indicates whether the notification subscription is active.",
@@ -1031,6 +1042,7 @@
"type" : "object"
},
"NotificationEventConfiguration" : {
"additionalProperties" : false,
"properties" : {
"eventType" : {
"description" : "The type of event.\n\nPossible values: **ACCOUNT_CLOSED**, **ACCOUNT_CREATED**, **ACCOUNT_FUNDS_BELOW_THRESHOLD**, **ACCOUNT_HOLDER_CREATED**, **ACCOUNT_HOLDER_LIMIT_REACHED**, **ACCOUNT_HOLDER_PAYOUT**, **ACCOUNT_HOLDER_STATUS_CHANGE**, **ACCOUNT_HOLDER_STORE_STATUS_CHANGE**, **ACCOUNT_HOLDER_UPCOMING_DEADLINE**, **ACCOUNT_HOLDER_UPDATED**, **ACCOUNT_HOLDER_VERIFICATION**, **ACCOUNT_UPDATED**, **BENEFICIARY_SETUP**, **COMPENSATE_NEGATIVE_BALANCE**, **DIRECT_DEBIT_INITIATED**, **PAYMENT_FAILURE**, **REFUND_FUNDS_TRANSFER**, **REPORT_AVAILABLE**, **SCHEDULED_REFUNDS**, **TRANSFER_FUNDS**.",
@@ -1079,6 +1091,7 @@
"type" : "object"
},
"ServiceError" : {
"additionalProperties" : false,
"properties" : {
"errorCode" : {
"description" : "The error code mapped to the error message.",
@@ -1105,6 +1118,7 @@
"type" : "object"
},
"TestNotificationConfigurationRequest" : {
"additionalProperties" : false,
"properties" : {
"eventTypes" : {
"description" : "The event types to test. If left blank, then all of the configured event types will be tested.\n>Permitted values: `ACCOUNT_HOLDER_CREATED`, `ACCOUNT_CREATED`, `ACCOUNT_UPDATED`, `ACCOUNT_HOLDER_UPDATED`, `ACCOUNT_HOLDER_STATUS_CHANGE`, `ACCOUNT_HOLDER_STORE_STATUS_CHANGE` `ACCOUNT_HOLDER_VERIFICATION`, `ACCOUNT_HOLDER_LIMIT_REACHED`, `ACCOUNT_HOLDER_PAYOUT`, `PAYMENT_FAILURE`, `SCHEDULED_REFUNDS`, `REPORT_AVAILABLE`, `TRANSFER_FUNDS`, `BENEFICIARY_SETUP`, `COMPENSATE_NEGATIVE_BALANCE`.",
@@ -1152,6 +1166,7 @@
"type" : "object"
},
"TestNotificationConfigurationResponse" : {
"additionalProperties" : false,
"properties" : {
"errorMessages" : {
"description" : "Any error messages encountered.",
@@ -1236,6 +1251,7 @@
"type" : "object"
},
"UpdateNotificationConfigurationRequest" : {
"additionalProperties" : false,
"properties" : {
"configurationDetails" : {
"description" : "Details of the notification subscription configuration to be updated.",

63
yaml/AccountService-v3.yaml
View File

@@ -1276,6 +1276,7 @@ paths:
components:
schemas:
Account:
additionalProperties: false
properties:
accountCode:
description: The code of the account.
@@ -1293,6 +1294,7 @@ components:
$ref: '#/components/schemas/PayoutScheduleResponse'
type: object
AccountEvent:
additionalProperties: false
properties:
event:
description: 'The event.
@@ -1317,6 +1319,7 @@ components:
AccountEvent:
$ref: '#/components/schemas/AccountEvent'
AccountHolderDetails:
additionalProperties: false
properties:
address:
description: The address of the account holder.
@@ -1385,6 +1388,7 @@ components:
- address
type: object
AccountHolderStatus:
additionalProperties: false
properties:
events:
description: A list of events scheduled for the account holder.
@@ -1414,6 +1418,7 @@ components:
- status
type: object
AccountPayoutState:
additionalProperties: false
properties:
allowPayout:
description: Indicates whether payouts are allowed. This field is the overarching
@@ -1446,6 +1451,7 @@ components:
type: integer
type: object
AccountProcessingState:
additionalProperties: false
properties:
disableReason:
description: The reason why processing has been disabled.
@@ -1474,6 +1480,7 @@ components:
Account:
$ref: '#/components/schemas/Account'
Amount:
additionalProperties: false
properties:
currency:
description: The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes).
@@ -1489,6 +1496,7 @@ components:
- currency
type: object
BankAccountDetail:
additionalProperties: false
properties:
accountNumber:
description: 'The bank account number (without separators).
@@ -1697,6 +1705,7 @@ components:
BankAccountDetail:
$ref: '#/components/schemas/BankAccountDetail'
BusinessDetails:
additionalProperties: false
properties:
doingBusinessAs:
description: The registered name of the company (if it differs from the
@@ -1730,6 +1739,7 @@ components:
type: string
type: object
CloseAccountHolderRequest:
additionalProperties: false
properties:
accountHolderCode:
description: The code of the Account Holder to be closed.
@@ -1738,6 +1748,7 @@ components:
- accountHolderCode
type: object
CloseAccountHolderResponse:
additionalProperties: false
properties:
accountHolderStatus:
description: The new status of the Account Holder.
@@ -1762,6 +1773,7 @@ components:
type: boolean
type: object
CloseAccountRequest:
additionalProperties: false
properties:
accountCode:
description: The code of account to be closed.
@@ -1770,6 +1782,7 @@ components:
- accountCode
type: object
CloseAccountResponse:
additionalProperties: false
properties:
pspReference:
description: The reference of a request. Can be used to uniquely identify
@@ -1802,6 +1815,7 @@ components:
type: boolean
type: object
CreateAccountHolderRequest:
additionalProperties: false
properties:
accountHolderCode:
description: 'Your unique identifier for the prospective account holder.
@@ -1850,6 +1864,7 @@ components:
- accountHolderDetails
type: object
CreateAccountHolderResponse:
additionalProperties: false
properties:
accountCode:
description: The code of a new account created for the account holder.
@@ -1895,6 +1910,7 @@ components:
$ref: '#/components/schemas/KYCVerificationResult'
type: object
CreateAccountRequest:
additionalProperties: false
properties:
accountHolderCode:
description: The code of Account Holder under which to create the account.
@@ -1936,6 +1952,7 @@ components:
- accountHolderCode
type: object
CreateAccountResponse:
additionalProperties: false
properties:
accountCode:
description: The code of the new account.
@@ -1977,6 +1994,7 @@ components:
type: boolean
type: object
DeleteBankAccountRequest:
additionalProperties: false
properties:
accountHolderCode:
description: The code of the Account Holder from which to delete the Bank
@@ -1992,6 +2010,7 @@ components:
- bankAccountUUIDs
type: object
DeleteLegalArrangementRequest:
additionalProperties: false
properties:
accountHolderCode:
description: The code of the account holder.
@@ -2006,6 +2025,7 @@ components:
- legalArrangements
type: object
DeleteShareholderRequest:
additionalProperties: false
properties:
accountHolderCode:
description: The code of the Account Holder from which to delete the Shareholders.
@@ -2020,6 +2040,7 @@ components:
- shareholderCodes
type: object
DeleteSignatoriesRequest:
additionalProperties: false
properties:
accountHolderCode:
description: The code of the account holder from which to delete the signatories.
@@ -2034,6 +2055,7 @@ components:
- signatoryCodes
type: object
DocumentDetail:
additionalProperties: false
properties:
accountHolderCode:
x-addedInVersion: '2'
@@ -2127,6 +2149,7 @@ components:
DocumentDetail:
$ref: '#/components/schemas/DocumentDetail'
ErrorFieldType:
additionalProperties: false
properties:
errorCode:
description: The validation error code.
@@ -2144,6 +2167,7 @@ components:
ErrorFieldType:
$ref: '#/components/schemas/ErrorFieldType'
FieldType:
additionalProperties: false
properties:
field:
description: The full name of the property.
@@ -2321,6 +2345,7 @@ components:
FieldType:
$ref: '#/components/schemas/FieldType'
GenericResponse:
additionalProperties: false
properties:
pspReference:
description: The reference of a request. Can be used to uniquely identify
@@ -2342,6 +2367,7 @@ components:
type: boolean
type: object
GetAccountHolderRequest:
additionalProperties: false
properties:
accountCode:
description: 'The code of the account of which to retrieve the details.
@@ -2355,6 +2381,7 @@ components:
type: string
type: object
GetAccountHolderResponse:
additionalProperties: false
properties:
accountHolderCode:
description: The code of the account holder.
@@ -2402,6 +2429,7 @@ components:
$ref: '#/components/schemas/KYCVerificationResult'
type: object
GetAccountHolderStatusResponse:
additionalProperties: false
properties:
accountHolderCode:
description: The code of the Account Holder.
@@ -2430,6 +2458,7 @@ components:
type: boolean
type: object
GetTaxFormRequest:
additionalProperties: false
properties:
accountHolderCode:
description: The account holder code you provided when you created the account
@@ -2448,6 +2477,7 @@ components:
- year
type: object
GetTaxFormResponse:
additionalProperties: false
properties:
content:
description: The content of the tax form in the Base64 binary format.
@@ -2476,6 +2506,7 @@ components:
type: boolean
type: object
GetUploadedDocumentsRequest:
additionalProperties: false
properties:
accountHolderCode:
description: The code of the Account Holder for which to retrieve the documents.
@@ -2491,6 +2522,7 @@ components:
- accountHolderCode
type: object
GetUploadedDocumentsResponse:
additionalProperties: false
properties:
documentDetails:
description: A list of the documents and their details.
@@ -2517,6 +2549,7 @@ components:
type: boolean
type: object
IndividualDetails:
additionalProperties: false
properties:
name:
description: 'The name of the individual.
@@ -2529,6 +2562,7 @@ components:
$ref: '#/components/schemas/ViasPersonalData'
type: object
KYCBankAccountCheckResult:
additionalProperties: false
properties:
bankAccountUUID:
description: The unique ID of the bank account to which the check applies.
@@ -2540,6 +2574,7 @@ components:
type: array
type: object
KYCCheckResult:
additionalProperties: false
properties:
checks:
description: A list of the checks and their statuses.
@@ -2548,6 +2583,7 @@ components:
type: array
type: object
KYCCheckStatusData:
additionalProperties: false
properties:
requiredFields:
description: A list of the fields required for execution of the check.
@@ -2597,6 +2633,7 @@ components:
- status
type: object
KYCCheckSummary:
additionalProperties: false
properties:
code:
description: The code of the check.
@@ -2609,6 +2646,7 @@ components:
- code
type: object
KYCShareholderCheckResult:
additionalProperties: false
properties:
checks:
description: A list of the checks and their statuses.
@@ -2620,6 +2658,7 @@ components:
type: string
type: object
KYCSignatoryCheckResult:
additionalProperties: false
properties:
checks:
description: A list of the checks and their statuses.
@@ -2631,6 +2670,7 @@ components:
type: string
type: object
KYCVerificationResult:
additionalProperties: false
properties:
accountHolder:
description: The results of the checks on the account holder.
@@ -2652,6 +2692,7 @@ components:
type: array
type: object
LegalArrangementRequest:
additionalProperties: false
properties:
legalArrangementCode:
description: The code of the legal arrangement to be deleted. If you also
@@ -2670,6 +2711,7 @@ components:
LegalArrangementRequest:
$ref: '#/components/schemas/LegalArrangementRequest'
PayoutScheduleResponse:
additionalProperties: false
properties:
nextScheduledPayout:
description: The date of the next scheduled payout.
@@ -2704,6 +2746,7 @@ components:
type: string
type: object
PersonalDocumentData:
additionalProperties: false
properties:
expirationDate:
description: "The expiry date of the document, \n in ISO-8601 YYYY-MM-DD\
@@ -2744,6 +2787,7 @@ components:
PersonalDocumentData:
$ref: '#/components/schemas/PersonalDocumentData'
ServiceError:
additionalProperties: false
properties:
errorCode:
description: The error code mapped to the error message.
@@ -2763,6 +2807,7 @@ components:
type: integer
type: object
ShareholderContact:
additionalProperties: false
properties:
address:
description: The address of the person.
@@ -2838,6 +2883,7 @@ components:
ShareholderContact:
$ref: '#/components/schemas/ShareholderContact'
SignatoryContact:
additionalProperties: false
properties:
address:
description: The address of the person.
@@ -2905,6 +2951,7 @@ components:
SignatoryContact:
$ref: '#/components/schemas/SignatoryContact'
SuspendAccountHolderRequest:
additionalProperties: false
properties:
accountHolderCode:
description: The code of the account holder to be suspended.
@@ -2913,6 +2960,7 @@ components:
- accountHolderCode
type: object
SuspendAccountHolderResponse:
additionalProperties: false
properties:
accountHolderStatus:
description: The new status of the Account Holder.
@@ -2937,6 +2985,7 @@ components:
type: boolean
type: object
UltimateParentCompany:
additionalProperties: false
properties:
address:
description: Address of the ultimate parent company.
@@ -2952,6 +3001,7 @@ components:
type: string
type: object
UltimateParentCompanyBusinessDetails:
additionalProperties: false
properties:
legalBusinessName:
description: The legal name of the company.
@@ -2974,6 +3024,7 @@ components:
UltimateParentCompany:
$ref: '#/components/schemas/UltimateParentCompany'
UnSuspendAccountHolderRequest:
additionalProperties: false
properties:
accountHolderCode:
description: The code of the account holder to be reinstated.
@@ -2982,6 +3033,7 @@ components:
- accountHolderCode
type: object
UnSuspendAccountHolderResponse:
additionalProperties: false
properties:
accountHolderStatus:
description: The new status of the Account Holder.
@@ -3006,6 +3058,7 @@ components:
type: boolean
type: object
UpdateAccountHolderRequest:
additionalProperties: false
properties:
accountHolderCode:
description: The code of the Account Holder to be updated.
@@ -3031,6 +3084,7 @@ components:
- accountHolderCode
type: object
UpdateAccountHolderResponse:
additionalProperties: false
properties:
accountHolderCode:
description: The code of the account holder.
@@ -3078,6 +3132,7 @@ components:
$ref: '#/components/schemas/KYCVerificationResult'
type: object
UpdateAccountHolderStateRequest:
additionalProperties: false
properties:
accountHolderCode:
description: The code of the Account Holder on which to update the state.
@@ -3109,6 +3164,7 @@ components:
- disable
type: object
UpdateAccountRequest:
additionalProperties: false
properties:
accountCode:
description: The code of the account to update.
@@ -3122,6 +3178,7 @@ components:
- payoutSchedule
type: object
UpdateAccountResponse:
additionalProperties: false
properties:
accountCode:
description: The code of the account.
@@ -3152,6 +3209,7 @@ components:
- accountCode
type: object
UpdatePayoutScheduleRequest:
additionalProperties: false
properties:
action:
description: 'Direction on how to handle any payouts that have already been
@@ -3206,6 +3264,7 @@ components:
- schedule
type: object
UploadDocumentRequest:
additionalProperties: false
properties:
accountHolderCode:
deprecated: true
@@ -3240,6 +3299,7 @@ components:
- documentContent
type: object
ViasAddress:
additionalProperties: false
properties:
city:
description: The name of the city. Required if the `houseNumberOrName`,
@@ -3279,6 +3339,7 @@ components:
- country
type: object
ViasName:
additionalProperties: false
properties:
firstName:
description: The first name.
@@ -3306,6 +3367,7 @@ components:
type: string
type: object
ViasPersonalData:
additionalProperties: false
properties:
dateOfBirth:
description: The person's date of birth, in ISO-8601 YYYY-MM-DD format.
@@ -3336,6 +3398,7 @@ components:
type: string
type: object
ViasPhoneNumber:
additionalProperties: false
properties:
phoneCountryCode:
description: 'The two-character country code of the phone number.

63
yaml/AccountService-v4.yaml
View File

@@ -1274,6 +1274,7 @@ paths:
components:
schemas:
Account:
additionalProperties: false
properties:
accountCode:
description: The code of the account.
@@ -1300,6 +1301,7 @@ components:
type: string
type: object
AccountEvent:
additionalProperties: false
properties:
event:
description: 'The event.
@@ -1324,6 +1326,7 @@ components:
AccountEvent:
$ref: '#/components/schemas/AccountEvent'
AccountHolderDetails:
additionalProperties: false
properties:
address:
description: The address of the account holder.
@@ -1392,6 +1395,7 @@ components:
- address
type: object
AccountHolderStatus:
additionalProperties: false
properties:
events:
description: A list of events scheduled for the account holder.
@@ -1421,6 +1425,7 @@ components:
- status
type: object
AccountPayoutState:
additionalProperties: false
properties:
allowPayout:
description: Indicates whether payouts are allowed. This field is the overarching
@@ -1453,6 +1458,7 @@ components:
type: integer
type: object
AccountProcessingState:
additionalProperties: false
properties:
disableReason:
description: The reason why processing has been disabled.
@@ -1481,6 +1487,7 @@ components:
Account:
$ref: '#/components/schemas/Account'
Amount:
additionalProperties: false
properties:
currency:
description: The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes).
@@ -1496,6 +1503,7 @@ components:
- currency
type: object
BankAccountDetail:
additionalProperties: false
properties:
accountNumber:
description: 'The bank account number (without separators).
@@ -1704,6 +1712,7 @@ components:
BankAccountDetail:
$ref: '#/components/schemas/BankAccountDetail'
BusinessDetails:
additionalProperties: false
properties:
doingBusinessAs:
description: The registered name of the company (if it differs from the
@@ -1741,6 +1750,7 @@ components:
type: string
type: object
CloseAccountHolderRequest:
additionalProperties: false
properties:
accountHolderCode:
description: The code of the Account Holder to be closed.
@@ -1749,6 +1759,7 @@ components:
- accountHolderCode
type: object
CloseAccountHolderResponse:
additionalProperties: false
properties:
accountHolderStatus:
description: The new status of the Account Holder.
@@ -1773,6 +1784,7 @@ components:
type: boolean
type: object
CloseAccountRequest:
additionalProperties: false
properties:
accountCode:
description: The code of account to be closed.
@@ -1781,6 +1793,7 @@ components:
- accountCode
type: object
CloseAccountResponse:
additionalProperties: false
properties:
pspReference:
description: The reference of a request. Can be used to uniquely identify
@@ -1813,6 +1826,7 @@ components:
type: boolean
type: object
CreateAccountHolderRequest:
additionalProperties: false
properties:
accountHolderCode:
description: 'Your unique identifier for the prospective account holder.
@@ -1873,6 +1887,7 @@ components:
- accountHolderDetails
type: object
CreateAccountHolderResponse:
additionalProperties: false
properties:
accountCode:
description: The code of a new account created for the account holder.
@@ -1930,6 +1945,7 @@ components:
$ref: '#/components/schemas/KYCVerificationResult'
type: object
CreateAccountRequest:
additionalProperties: false
properties:
accountHolderCode:
description: The code of Account Holder under which to create the account.
@@ -1977,6 +1993,7 @@ components:
- accountHolderCode
type: object
CreateAccountResponse:
additionalProperties: false
properties:
accountCode:
description: The code of the new account.
@@ -2022,6 +2039,7 @@ components:
type: boolean
type: object
DeleteBankAccountRequest:
additionalProperties: false
properties:
accountHolderCode:
description: The code of the Account Holder from which to delete the Bank
@@ -2037,6 +2055,7 @@ components:
- bankAccountUUIDs
type: object
DeleteLegalArrangementRequest:
additionalProperties: false
properties:
accountHolderCode:
description: The code of the account holder.
@@ -2051,6 +2070,7 @@ components:
- legalArrangements
type: object
DeleteShareholderRequest:
additionalProperties: false
properties:
accountHolderCode:
description: The code of the Account Holder from which to delete the Shareholders.
@@ -2065,6 +2085,7 @@ components:
- shareholderCodes
type: object
DeleteSignatoriesRequest:
additionalProperties: false
properties:
accountHolderCode:
description: The code of the account holder from which to delete the signatories.
@@ -2079,6 +2100,7 @@ components:
- signatoryCodes
type: object
DocumentDetail:
additionalProperties: false
properties:
accountHolderCode:
x-addedInVersion: '2'
@@ -2172,6 +2194,7 @@ components:
DocumentDetail:
$ref: '#/components/schemas/DocumentDetail'
ErrorFieldType:
additionalProperties: false
properties:
errorCode:
description: The validation error code.
@@ -2189,6 +2212,7 @@ components:
ErrorFieldType:
$ref: '#/components/schemas/ErrorFieldType'
FieldType:
additionalProperties: false
properties:
field:
description: The full name of the property.
@@ -2370,6 +2394,7 @@ components:
FieldType:
$ref: '#/components/schemas/FieldType'
GenericResponse:
additionalProperties: false
properties:
pspReference:
description: The reference of a request. Can be used to uniquely identify
@@ -2391,6 +2416,7 @@ components:
type: boolean
type: object
GetAccountHolderRequest:
additionalProperties: false
properties:
accountCode:
description: 'The code of the account of which to retrieve the details.
@@ -2408,6 +2434,7 @@ components:
type: boolean
type: object
GetAccountHolderResponse:
additionalProperties: false
properties:
accountHolderCode:
description: The code of the account holder.
@@ -2464,6 +2491,7 @@ components:
$ref: '#/components/schemas/KYCVerificationResult'
type: object
GetAccountHolderStatusResponse:
additionalProperties: false
properties:
accountHolderCode:
description: The code of the Account Holder.
@@ -2492,6 +2520,7 @@ components:
type: boolean
type: object
GetTaxFormRequest:
additionalProperties: false
properties:
accountHolderCode:
description: The account holder code you provided when you created the account
@@ -2510,6 +2539,7 @@ components:
- year
type: object
GetTaxFormResponse:
additionalProperties: false
properties:
content:
description: The content of the tax form in the Base64 binary format.
@@ -2538,6 +2568,7 @@ components:
type: boolean
type: object
GetUploadedDocumentsRequest:
additionalProperties: false
properties:
accountHolderCode:
description: The code of the Account Holder for which to retrieve the documents.
@@ -2553,6 +2584,7 @@ components:
- accountHolderCode
type: object
GetUploadedDocumentsResponse:
additionalProperties: false
properties:
documentDetails:
description: A list of the documents and their details.
@@ -2579,6 +2611,7 @@ components:
type: boolean
type: object
IndividualDetails:
additionalProperties: false
properties:
name:
description: 'The name of the individual.
@@ -2591,6 +2624,7 @@ components:
$ref: '#/components/schemas/ViasPersonalData'
type: object
KYCBankAccountCheckResult:
additionalProperties: false
properties:
bankAccountUUID:
description: The unique ID of the bank account to which the check applies.
@@ -2602,6 +2636,7 @@ components:
type: array
type: object
KYCCheckResult:
additionalProperties: false
properties:
checks:
description: A list of the checks and their statuses.
@@ -2610,6 +2645,7 @@ components:
type: array
type: object
KYCCheckStatusData:
additionalProperties: false
properties:
requiredFields:
description: A list of the fields required for execution of the check.
@@ -2659,6 +2695,7 @@ components:
- status
type: object
KYCCheckSummary:
additionalProperties: false
properties:
code:
description: The code of the check.
@@ -2671,6 +2708,7 @@ components:
- code
type: object
KYCShareholderCheckResult:
additionalProperties: false
properties:
checks:
description: A list of the checks and their statuses.
@@ -2682,6 +2720,7 @@ components:
type: string
type: object
KYCSignatoryCheckResult:
additionalProperties: false
properties:
checks:
description: A list of the checks and their statuses.
@@ -2693,6 +2732,7 @@ components:
type: string
type: object
KYCVerificationResult:
additionalProperties: false
properties:
accountHolder:
description: The results of the checks on the account holder.
@@ -2714,6 +2754,7 @@ components:
type: array
type: object
LegalArrangementRequest:
additionalProperties: false
properties:
legalArrangementCode:
description: The code of the legal arrangement to be deleted. If you also
@@ -2732,6 +2773,7 @@ components:
LegalArrangementRequest:
$ref: '#/components/schemas/LegalArrangementRequest'
PayoutScheduleResponse:
additionalProperties: false
properties:
nextScheduledPayout:
description: The date of the next scheduled payout.
@@ -2766,6 +2808,7 @@ components:
type: string
type: object
PersonalDocumentData:
additionalProperties: false
properties:
expirationDate:
description: "The expiry date of the document, \n in ISO-8601 YYYY-MM-DD\
@@ -2806,6 +2849,7 @@ components:
PersonalDocumentData:
$ref: '#/components/schemas/PersonalDocumentData'
ServiceError:
additionalProperties: false
properties:
errorCode:
description: The error code mapped to the error message.
@@ -2825,6 +2869,7 @@ components:
type: integer
type: object
ShareholderContact:
additionalProperties: false
properties:
address:
description: The address of the person.
@@ -2900,6 +2945,7 @@ components:
ShareholderContact:
$ref: '#/components/schemas/ShareholderContact'
SignatoryContact:
additionalProperties: false
properties:
address:
description: The address of the person.
@@ -2967,6 +3013,7 @@ components:
SignatoryContact:
$ref: '#/components/schemas/SignatoryContact'
SuspendAccountHolderRequest:
additionalProperties: false
properties:
accountHolderCode:
description: The code of the account holder to be suspended.
@@ -2975,6 +3022,7 @@ components:
- accountHolderCode
type: object
SuspendAccountHolderResponse:
additionalProperties: false
properties:
accountHolderStatus:
description: The new status of the Account Holder.
@@ -2999,6 +3047,7 @@ components:
type: boolean
type: object
UltimateParentCompany:
additionalProperties: false
properties:
address:
description: Address of the ultimate parent company.
@@ -3014,6 +3063,7 @@ components:
type: string
type: object
UltimateParentCompanyBusinessDetails:
additionalProperties: false
properties:
legalBusinessName:
description: The legal name of the company.
@@ -3036,6 +3086,7 @@ components:
UltimateParentCompany:
$ref: '#/components/schemas/UltimateParentCompany'
UnSuspendAccountHolderRequest:
additionalProperties: false
properties:
accountHolderCode:
description: The code of the account holder to be reinstated.
@@ -3044,6 +3095,7 @@ components:
- accountHolderCode
type: object
UnSuspendAccountHolderResponse:
additionalProperties: false
properties:
accountHolderStatus:
description: The new status of the Account Holder.
@@ -3068,6 +3120,7 @@ components:
type: boolean
type: object
UpdateAccountHolderRequest:
additionalProperties: false
properties:
accountHolderCode:
description: The code of the Account Holder to be updated.
@@ -3105,6 +3158,7 @@ components:
- accountHolderCode
type: object
UpdateAccountHolderResponse:
additionalProperties: false
properties:
accountHolderCode:
description: The code of the account holder.
@@ -3164,6 +3218,7 @@ components:
$ref: '#/components/schemas/KYCVerificationResult'
type: object
UpdateAccountHolderStateRequest:
additionalProperties: false
properties:
accountHolderCode:
description: The code of the Account Holder on which to update the state.
@@ -3195,6 +3250,7 @@ components:
- disable
type: object
UpdateAccountRequest:
additionalProperties: false
properties:
accountCode:
description: The code of the account to update.
@@ -3213,6 +3269,7 @@ components:
- accountCode
type: object
UpdateAccountResponse:
additionalProperties: false
properties:
accountCode:
description: The code of the account.
@@ -3247,6 +3304,7 @@ components:
- accountCode
type: object
UpdatePayoutScheduleRequest:
additionalProperties: false
properties:
action:
description: 'Direction on how to handle any payouts that have already been
@@ -3301,6 +3359,7 @@ components:
- schedule
type: object
UploadDocumentRequest:
additionalProperties: false
properties:
accountHolderCode:
deprecated: true
@@ -3335,6 +3394,7 @@ components:
- documentContent
type: object
ViasAddress:
additionalProperties: false
properties:
city:
description: The name of the city. Required if the `houseNumberOrName`,
@@ -3374,6 +3434,7 @@ components:
- country
type: object
ViasName:
additionalProperties: false
properties:
firstName:
description: The first name.
@@ -3401,6 +3462,7 @@ components:
type: string
type: object
ViasPersonalData:
additionalProperties: false
properties:
dateOfBirth:
description: The person's date of birth, in ISO-8601 YYYY-MM-DD format.
@@ -3431,6 +3493,7 @@ components:
type: string
type: object
ViasPhoneNumber:
additionalProperties: false
properties:
phoneCountryCode:
description: 'The two-character country code of the phone number.

73
yaml/AccountService-v5.yaml
View File

@@ -1478,6 +1478,7 @@ paths:
components:
schemas:
Account:
additionalProperties: false
properties:
accountCode:
description: The code of the account.
@@ -1539,6 +1540,7 @@ components:
type: string
type: object
AccountEvent:
additionalProperties: false
properties:
event:
description: 'The event.
@@ -1559,6 +1561,7 @@ components:
type: string
type: object
AccountHolderDetails:
additionalProperties: false
properties:
address:
description: The address of the account holder.
@@ -1647,6 +1650,7 @@ components:
- address
type: object
AccountHolderStatus:
additionalProperties: false
properties:
events:
description: A list of events scheduled for the account holder.
@@ -1676,6 +1680,7 @@ components:
- status
type: object
AccountPayoutState:
additionalProperties: false
properties:
allowPayout:
description: Indicates whether payouts are allowed. This field is the overarching
@@ -1715,6 +1720,7 @@ components:
type: integer
type: object
AccountProcessingState:
additionalProperties: false
properties:
disableReason:
description: The reason why processing has been disabled.
@@ -1739,6 +1745,7 @@ components:
type: integer
type: object
Amount:
additionalProperties: false
properties:
currency:
description: The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes).
@@ -1754,6 +1761,7 @@ components:
- currency
type: object
BankAccountDetail:
additionalProperties: false
properties:
accountNumber:
description: 'The bank account number (without separators).
@@ -1962,6 +1970,7 @@ components:
type: string
type: object
BusinessDetails:
additionalProperties: false
properties:
doingBusinessAs:
description: The registered name of the company (if it differs from the
@@ -1999,6 +2008,7 @@ components:
type: string
type: object
CloseAccountHolderRequest:
additionalProperties: false
properties:
accountHolderCode:
description: The code of the Account Holder to be closed.
@@ -2007,6 +2017,7 @@ components:
- accountHolderCode
type: object
CloseAccountHolderResponse:
additionalProperties: false
properties:
accountHolderStatus:
description: The new status of the Account Holder.
@@ -2027,6 +2038,7 @@ components:
type: string
type: object
CloseAccountRequest:
additionalProperties: false
properties:
accountCode:
description: The code of account to be closed.
@@ -2035,6 +2047,7 @@ components:
- accountCode
type: object
CloseAccountResponse:
additionalProperties: false
properties:
accountCode:
x-addedInVersion: '5'
@@ -2067,6 +2080,7 @@ components:
type: string
type: object
CloseStoresRequest:
additionalProperties: false
properties:
accountHolderCode:
description: The code of the account holder.
@@ -2081,6 +2095,7 @@ components:
- stores
type: object
CreateAccountHolderRequest:
additionalProperties: false
properties:
accountHolderCode:
description: 'Your unique identifier for the prospective account holder.
@@ -2141,6 +2156,7 @@ components:
- accountHolderDetails
type: object
CreateAccountHolderResponse:
additionalProperties: false
properties:
accountCode:
description: The code of a new account created for the account holder.
@@ -2193,6 +2209,7 @@ components:
$ref: '#/components/schemas/KYCVerificationResult'
type: object
CreateAccountRequest:
additionalProperties: false
properties:
accountHolderCode:
description: The code of Account Holder under which to create the account.
@@ -2278,6 +2295,7 @@ components:
- accountHolderCode
type: object
CreateAccountResponse:
additionalProperties: false
properties:
accountCode:
description: The code of the new account.
@@ -2348,6 +2366,7 @@ components:
type: string
type: object
DeleteBankAccountRequest:
additionalProperties: false
properties:
accountHolderCode:
description: The code of the Account Holder from which to delete the Bank
@@ -2363,6 +2382,7 @@ components:
- bankAccountUUIDs
type: object
DeleteLegalArrangementRequest:
additionalProperties: false
properties:
accountHolderCode:
description: The code of the account holder.
@@ -2377,6 +2397,7 @@ components:
- legalArrangements
type: object
DeletePayoutMethodRequest:
additionalProperties: false
properties:
accountHolderCode:
description: The code of the account holder, from which to delete the payout
@@ -2392,6 +2413,7 @@ components:
- payoutMethodCodes
type: object
DeleteShareholderRequest:
additionalProperties: false
properties:
accountHolderCode:
description: The code of the Account Holder from which to delete the Shareholders.
@@ -2406,6 +2428,7 @@ components:
- shareholderCodes
type: object
DeleteSignatoriesRequest:
additionalProperties: false
properties:
accountHolderCode:
description: The code of the account holder from which to delete the signatories.
@@ -2420,6 +2443,7 @@ components:
- signatoryCodes
type: object
DocumentDetail:
additionalProperties: false
properties:
accountHolderCode:
x-addedInVersion: '2'
@@ -2511,6 +2535,7 @@ components:
- documentType
type: object
ErrorFieldType:
additionalProperties: false
properties:
errorCode:
description: The validation error code.
@@ -2524,6 +2549,7 @@ components:
$ref: '#/components/schemas/FieldType'
type: object
FieldType:
additionalProperties: false
properties:
field:
description: The full name of the property.
@@ -2701,6 +2727,7 @@ components:
type: string
type: object
GenericResponse:
additionalProperties: false
properties:
invalidFields:
x-addedInVersion: '5'
@@ -2718,6 +2745,7 @@ components:
type: string
type: object
GetAccountHolderRequest:
additionalProperties: false
properties:
accountCode:
description: 'The code of the account of which to retrieve the details.
@@ -2735,6 +2763,7 @@ components:
type: boolean
type: object
GetAccountHolderResponse:
additionalProperties: false
properties:
accountHolderCode:
description: The code of the account holder.
@@ -2797,6 +2826,7 @@ components:
$ref: '#/components/schemas/KYCVerificationResult'
type: object
GetAccountHolderStatusResponse:
additionalProperties: false
properties:
accountHolderCode:
description: The code of the Account Holder.
@@ -2821,6 +2851,7 @@ components:
type: string
type: object
GetTaxFormRequest:
additionalProperties: false
properties:
accountHolderCode:
description: The account holder code you provided when you created the account
@@ -2839,6 +2870,7 @@ components:
- year
type: object
GetTaxFormResponse:
additionalProperties: false
properties:
content:
description: The content of the tax form in the Base64 binary format.
@@ -2863,6 +2895,7 @@ components:
type: string
type: object
GetUploadedDocumentsRequest:
additionalProperties: false
properties:
accountHolderCode:
description: The code of the Account Holder for which to retrieve the documents.
@@ -2878,6 +2911,7 @@ components:
- accountHolderCode
type: object
GetUploadedDocumentsResponse:
additionalProperties: false
properties:
documentDetails:
description: A list of the documents and their details.
@@ -2900,6 +2934,7 @@ components:
type: string
type: object
IndividualDetails:
additionalProperties: false
properties:
name:
description: 'The name of the individual.
@@ -2912,6 +2947,7 @@ components:
$ref: '#/components/schemas/ViasPersonalData'
type: object
KYCBankAccountCheckResult:
additionalProperties: false
properties:
bankAccountUUID:
description: The unique ID of the bank account to which the check applies.
@@ -2923,6 +2959,7 @@ components:
type: array
type: object
KYCCardCheckResult:
additionalProperties: false
properties:
checks:
description: A list of the checks and their statuses.
@@ -2934,6 +2971,7 @@ components:
type: string
type: object
KYCCheckResult:
additionalProperties: false
properties:
checks:
description: A list of the checks and their statuses.
@@ -2942,6 +2980,7 @@ components:
type: array
type: object
KYCCheckStatusData:
additionalProperties: false
properties:
requiredFields:
description: A list of the fields required for execution of the check.
@@ -2991,6 +3030,7 @@ components:
- status
type: object
KYCCheckSummary:
additionalProperties: false
properties:
kycCheckCode:
x-addedInVersion: '5'
@@ -3004,6 +3044,7 @@ components:
type: string
type: object
KYCShareholderCheckResult:
additionalProperties: false
properties:
checks:
description: A list of the checks and their statuses.
@@ -3015,6 +3056,7 @@ components:
type: string
type: object
KYCSignatoryCheckResult:
additionalProperties: false
properties:
checks:
description: A list of the checks and their statuses.
@@ -3026,6 +3068,7 @@ components:
type: string
type: object
KYCVerificationResult:
additionalProperties: false
properties:
accountHolder:
description: The results of the checks on the account holder.
@@ -3053,6 +3096,7 @@ components:
type: array
type: object
LegalArrangementRequest:
additionalProperties: false
properties:
legalArrangementCode:
description: The code of the legal arrangement to be deleted. If you also
@@ -3067,6 +3111,7 @@ components:
- legalArrangementCode
type: object
MigratedAccounts:
additionalProperties: false
properties:
accountCode:
description: The unique identifier of the account of the migrated account
@@ -3078,6 +3123,7 @@ components:
type: string
type: object
MigratedShareholders:
additionalProperties: false
properties:
legalEntityCode:
description: The unique identifier of the legal entity of that shareholder
@@ -3089,6 +3135,7 @@ components:
type: string
type: object
MigratedStores:
additionalProperties: false
properties:
businessLineId:
description: The unique identifier of the business line associated with
@@ -3109,6 +3156,7 @@ components:
type: string
type: object
MigrationData:
additionalProperties: false
properties:
accountHolderId:
description: The unique identifier of the account holder in the balance
@@ -3146,6 +3194,7 @@ components:
type: string
type: object
PayoutMethod:
additionalProperties: false
properties:
merchantAccount:
description: The [`merchantAccount`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__reqParam_merchantAccount)
@@ -3177,6 +3226,7 @@ components:
- recurringDetailReference
type: object
PayoutScheduleResponse:
additionalProperties: false
properties:
nextScheduledPayout:
description: The date of the next scheduled payout.
@@ -3211,6 +3261,7 @@ components:
type: string
type: object
PerformVerificationRequest:
additionalProperties: false
properties:
accountHolderCode:
description: The code of the account holder to verify.
@@ -3237,6 +3288,7 @@ components:
- tier
type: object
PersonalDocumentData:
additionalProperties: false
properties:
expirationDate:
description: "The expiry date of the document, \n in ISO-8601 YYYY-MM-DD\
@@ -3273,6 +3325,7 @@ components:
- type
type: object
ServiceError:
additionalProperties: false
properties:
errorCode:
description: The error code mapped to the error message.
@@ -3292,6 +3345,7 @@ components:
type: integer
type: object
ShareholderContact:
additionalProperties: false
properties:
address:
description: The address of the person.
@@ -3367,6 +3421,7 @@ components:
type: string
type: object
SignatoryContact:
additionalProperties: false
properties:
address:
description: The address of the person.
@@ -3430,6 +3485,7 @@ components:
type: string
type: object
StoreDetail:
additionalProperties: false
properties:
address:
description: The address of the physical store where the account holder
@@ -3518,6 +3574,7 @@ components:
- merchantAccount
type: object
SuspendAccountHolderRequest:
additionalProperties: false
properties:
accountHolderCode:
description: The code of the account holder to be suspended.
@@ -3526,6 +3583,7 @@ components:
- accountHolderCode
type: object
SuspendAccountHolderResponse:
additionalProperties: false
properties:
accountHolderStatus:
description: The new status of the Account Holder.
@@ -3546,6 +3604,7 @@ components:
type: string
type: object
UltimateParentCompany:
additionalProperties: false
properties:
address:
description: Address of the ultimate parent company.
@@ -3561,6 +3620,7 @@ components:
type: string
type: object
UltimateParentCompanyBusinessDetails:
additionalProperties: false
properties:
legalBusinessName:
description: The legal name of the company.
@@ -3579,6 +3639,7 @@ components:
type: string
type: object
UnSuspendAccountHolderRequest:
additionalProperties: false
properties:
accountHolderCode:
description: The code of the account holder to be reinstated.
@@ -3587,6 +3648,7 @@ components:
- accountHolderCode
type: object
UnSuspendAccountHolderResponse:
additionalProperties: false
properties:
accountHolderStatus:
description: The new status of the Account Holder.
@@ -3607,6 +3669,7 @@ components:
type: string
type: object
UpdateAccountHolderRequest:
additionalProperties: false
properties:
accountHolderCode:
description: The code of the Account Holder to be updated.
@@ -3665,6 +3728,7 @@ components:
- accountHolderCode
type: object
UpdateAccountHolderResponse:
additionalProperties: false
properties:
accountHolderCode:
description: The code of the account holder.
@@ -3714,6 +3778,7 @@ components:
$ref: '#/components/schemas/KYCVerificationResult'
type: object
UpdateAccountHolderStateRequest:
additionalProperties: false
properties:
accountHolderCode:
description: The code of the Account Holder on which to update the state.
@@ -3745,6 +3810,7 @@ components:
- disable
type: object
UpdateAccountRequest:
additionalProperties: false
properties:
accountCode:
description: The code of the account to update.
@@ -3800,6 +3866,7 @@ components:
- accountCode
type: object
UpdateAccountResponse:
additionalProperties: false
properties:
accountCode:
description: The code of the account.
@@ -3861,6 +3928,7 @@ components:
- accountCode
type: object
UpdatePayoutScheduleRequest:
additionalProperties: false
properties:
action:
description: 'Direction on how to handle any payouts that have already been
@@ -3915,6 +3983,7 @@ components:
- schedule
type: object
UploadDocumentRequest:
additionalProperties: false
properties:
documentContent:
description: 'The content of the document, in Base64-encoded string format.
@@ -3931,6 +4000,7 @@ components:
- documentContent
type: object
ViasAddress:
additionalProperties: false
properties:
city:
description: The name of the city. Required if the `houseNumberOrName`,
@@ -3970,6 +4040,7 @@ components:
- country
type: object
ViasName:
additionalProperties: false
properties:
firstName:
description: The first name.
@@ -3997,6 +4068,7 @@ components:
type: string
type: object
ViasPersonalData:
additionalProperties: false
properties:
dateOfBirth:
description: The person's date of birth, in ISO-8601 YYYY-MM-DD format.
@@ -4020,6 +4092,7 @@ components:
type: string
type: object
ViasPhoneNumber:
additionalProperties: false
properties:
phoneCountryCode:
description: 'The two-character country code of the phone number.

77
yaml/AccountService-v6.yaml
View File

@@ -1478,6 +1478,7 @@ paths:
components:
schemas:
Account:
additionalProperties: false
properties:
accountCode:
description: The code of the account.
@@ -1539,6 +1540,7 @@ components:
type: string
type: object
AccountEvent:
additionalProperties: false
properties:
event:
description: 'The event.
@@ -1559,6 +1561,7 @@ components:
type: string
type: object
AccountHolderDetails:
additionalProperties: false
properties:
address:
description: The address of the account holder.
@@ -1654,6 +1657,7 @@ components:
- address
type: object
AccountHolderStatus:
additionalProperties: false
properties:
events:
description: A list of events scheduled for the account holder.
@@ -1683,6 +1687,7 @@ components:
- status
type: object
AccountPayoutState:
additionalProperties: false
properties:
allowPayout:
description: Indicates whether payouts are allowed. This field is the overarching
@@ -1722,6 +1727,7 @@ components:
type: integer
type: object
AccountProcessingState:
additionalProperties: false
properties:
disableReason:
description: The reason why processing has been disabled.
@@ -1746,6 +1752,7 @@ components:
type: integer
type: object
Amount:
additionalProperties: false
properties:
currency:
description: The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes).
@@ -1761,6 +1768,7 @@ components:
- currency
type: object
BankAccountDetail:
additionalProperties: false
properties:
accountNumber:
description: 'The bank account number (without separators).
@@ -1969,6 +1977,7 @@ components:
type: string
type: object
BusinessDetails:
additionalProperties: false
properties:
doingBusinessAs:
description: The registered name of the company (if it differs from the
@@ -2018,6 +2027,7 @@ components:
type: string
type: object
CloseAccountHolderRequest:
additionalProperties: false
properties:
accountHolderCode:
description: The code of the Account Holder to be closed.
@@ -2026,6 +2036,7 @@ components:
- accountHolderCode
type: object
CloseAccountHolderResponse:
additionalProperties: false
properties:
accountHolderStatus:
description: The new status of the Account Holder.
@@ -2046,6 +2057,7 @@ components:
type: string
type: object
CloseAccountRequest:
additionalProperties: false
properties:
accountCode:
description: The code of account to be closed.
@@ -2054,6 +2066,7 @@ components:
- accountCode
type: object
CloseAccountResponse:
additionalProperties: false
properties:
accountCode:
x-addedInVersion: '5'
@@ -2086,6 +2099,7 @@ components:
type: string
type: object
CloseStoresRequest:
additionalProperties: false
properties:
accountHolderCode:
description: The code of the account holder.
@@ -2100,6 +2114,7 @@ components:
- stores
type: object
CreateAccountHolderRequest:
additionalProperties: false
properties:
accountHolderCode:
description: 'Your unique identifier for the prospective account holder.
@@ -2166,6 +2181,7 @@ components:
- accountHolderDetails
type: object
CreateAccountHolderResponse:
additionalProperties: false
properties:
accountCode:
description: The code of a new account created for the account holder.
@@ -2224,6 +2240,7 @@ components:
type: string
type: object
CreateAccountRequest:
additionalProperties: false
properties:
accountHolderCode:
description: The code of Account Holder under which to create the account.
@@ -2309,6 +2326,7 @@ components:
- accountHolderCode
type: object
CreateAccountResponse:
additionalProperties: false
properties:
accountCode:
description: The code of the new account.
@@ -2379,6 +2397,7 @@ components:
type: string
type: object
DeleteBankAccountRequest:
additionalProperties: false
properties:
accountHolderCode:
description: The code of the Account Holder from which to delete the Bank
@@ -2394,6 +2413,7 @@ components:
- bankAccountUUIDs
type: object
DeleteLegalArrangementRequest:
additionalProperties: false
properties:
accountHolderCode:
description: The code of the account holder.
@@ -2408,6 +2428,7 @@ components:
- legalArrangements
type: object
DeletePayoutMethodRequest:
additionalProperties: false
properties:
accountHolderCode:
description: The code of the account holder, from which to delete the payout
@@ -2423,6 +2444,7 @@ components:
- payoutMethodCodes
type: object
DeleteShareholderRequest:
additionalProperties: false
properties:
accountHolderCode:
description: The code of the Account Holder from which to delete the Shareholders.
@@ -2437,6 +2459,7 @@ components:
- shareholderCodes
type: object
DeleteSignatoriesRequest:
additionalProperties: false
properties:
accountHolderCode:
description: The code of the account holder from which to delete the signatories.
@@ -2451,6 +2474,7 @@ components:
- signatoryCodes
type: object
DocumentDetail:
additionalProperties: false
properties:
accountHolderCode:
x-addedInVersion: '2'
@@ -2553,6 +2577,7 @@ components:
- documentType
type: object
ErrorFieldType:
additionalProperties: false
properties:
errorCode:
description: The validation error code.
@@ -2566,6 +2591,7 @@ components:
$ref: '#/components/schemas/FieldType'
type: object
FieldType:
additionalProperties: false
properties:
field:
description: The full name of the property.
@@ -2743,6 +2769,7 @@ components:
type: string
type: object
GenericResponse:
additionalProperties: false
properties:
invalidFields:
x-addedInVersion: '5'
@@ -2760,6 +2787,7 @@ components:
type: string
type: object
GetAccountHolderRequest:
additionalProperties: false
properties:
accountCode:
description: 'The code of the account of which to retrieve the details.
@@ -2777,6 +2805,7 @@ components:
type: boolean
type: object
GetAccountHolderResponse:
additionalProperties: false
properties:
accountHolderCode:
description: The code of the account holder.
@@ -2845,6 +2874,7 @@ components:
type: string
type: object
GetAccountHolderStatusResponse:
additionalProperties: false
properties:
accountHolderCode:
description: The code of the Account Holder.
@@ -2869,6 +2899,7 @@ components:
type: string
type: object
GetTaxFormRequest:
additionalProperties: false
properties:
accountHolderCode:
description: The account holder code you provided when you created the account
@@ -2887,6 +2918,7 @@ components:
- year
type: object
GetTaxFormResponse:
additionalProperties: false
properties:
content:
description: The content of the tax form in the Base64 binary format.
@@ -2911,6 +2943,7 @@ components:
type: string
type: object
GetUploadedDocumentsRequest:
additionalProperties: false
properties:
accountHolderCode:
description: The code of the Account Holder for which to retrieve the documents.
@@ -2926,6 +2959,7 @@ components:
- accountHolderCode
type: object
GetUploadedDocumentsResponse:
additionalProperties: false
properties:
documentDetails:
description: A list of the documents and their details.
@@ -2948,6 +2982,7 @@ components:
type: string
type: object
IndividualDetails:
additionalProperties: false
properties:
name:
description: 'The name of the individual.
@@ -2960,6 +2995,7 @@ components:
$ref: '#/components/schemas/ViasPersonalData'
type: object
KYCCheckResult:
additionalProperties: false
properties:
checks:
description: A list of the checks and their statuses.
@@ -2968,6 +3004,7 @@ components:
type: array
type: object
KYCCheckStatusData:
additionalProperties: false
properties:
requiredFields:
description: A list of the fields required for execution of the check.
@@ -3017,6 +3054,7 @@ components:
- status
type: object
KYCCheckSummary:
additionalProperties: false
properties:
kycCheckCode:
x-addedInVersion: '5'
@@ -3030,6 +3068,7 @@ components:
type: string
type: object
KYCLegalArrangementCheckResult:
additionalProperties: false
properties:
checks:
description: A list of the checks and their statuses.
@@ -3041,6 +3080,7 @@ components:
type: string
type: object
KYCLegalArrangementEntityCheckResult:
additionalProperties: false
properties:
checks:
description: A list of the checks and their statuses.
@@ -3057,6 +3097,7 @@ components:
type: string
type: object
KYCPayoutMethodCheckResult:
additionalProperties: false
properties:
checks:
description: A list of the checks and their statuses.
@@ -3068,6 +3109,7 @@ components:
type: string
type: object
KYCShareholderCheckResult:
additionalProperties: false
properties:
checks:
description: A list of the checks and their statuses.
@@ -3089,6 +3131,7 @@ components:
type: string
type: object
KYCSignatoryCheckResult:
additionalProperties: false
properties:
checks:
description: A list of the checks and their statuses.
@@ -3100,6 +3143,7 @@ components:
type: string
type: object
KYCUltimateParentCompanyCheckResult:
additionalProperties: false
properties:
checks:
description: A list of the checks and their statuses.
@@ -3113,6 +3157,7 @@ components:
type: string
type: object
KYCVerificationResult:
additionalProperties: false
properties:
accountHolder:
description: The results of the checks on the account holder.
@@ -3153,6 +3198,7 @@ components:
type: array
type: object
LegalArrangementDetail:
additionalProperties: false
properties:
address:
description: The address of the legal arrangement.
@@ -3237,6 +3283,7 @@ components:
- address
type: object
LegalArrangementEntityDetail:
additionalProperties: false
properties:
address:
description: The address of the entity.
@@ -3318,6 +3365,7 @@ components:
type: string
type: object
LegalArrangementRequest:
additionalProperties: false
properties:
legalArrangementCode:
description: The code of the legal arrangement to be deleted. If you also
@@ -3332,6 +3380,7 @@ components:
- legalArrangementCode
type: object
MigratedAccounts:
additionalProperties: false
properties:
accountCode:
description: The unique identifier of the account of the migrated account
@@ -3343,6 +3392,7 @@ components:
type: string
type: object
MigratedShareholders:
additionalProperties: false
properties:
legalEntityCode:
description: The unique identifier of the legal entity of that shareholder
@@ -3354,6 +3404,7 @@ components:
type: string
type: object
MigratedStores:
additionalProperties: false
properties:
businessLineId:
description: The unique identifier of the business line associated with
@@ -3374,6 +3425,7 @@ components:
type: string
type: object
MigrationData:
additionalProperties: false
properties:
accountHolderId:
description: The unique identifier of the account holder in the balance
@@ -3411,6 +3463,7 @@ components:
type: string
type: object
PayoutMethod:
additionalProperties: false
properties:
merchantAccount:
description: The [`merchantAccount`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__reqParam_merchantAccount)
@@ -3442,6 +3495,7 @@ components:
- recurringDetailReference
type: object
PayoutScheduleResponse:
additionalProperties: false
properties:
nextScheduledPayout:
description: The date of the next scheduled payout.
@@ -3476,6 +3530,7 @@ components:
type: string
type: object
PerformVerificationRequest:
additionalProperties: false
properties:
accountHolderCode:
description: The code of the account holder to verify.
@@ -3502,6 +3557,7 @@ components:
- tier
type: object
PersonalDocumentData:
additionalProperties: false
properties:
expirationDate:
description: "The expiry date of the document, \n in ISO-8601 YYYY-MM-DD\
@@ -3538,6 +3594,7 @@ components:
- type
type: object
ServiceError:
additionalProperties: false
properties:
errorCode:
description: The error code mapped to the error message.
@@ -3557,6 +3614,7 @@ components:
type: integer
type: object
ShareholderContact:
additionalProperties: false
properties:
address:
description: The address of the person.
@@ -3632,6 +3690,7 @@ components:
type: string
type: object
SignatoryContact:
additionalProperties: false
properties:
address:
description: The address of the person.
@@ -3695,6 +3754,7 @@ components:
type: string
type: object
StoreDetail:
additionalProperties: false
properties:
address:
description: The address of the physical store where the account holder
@@ -3783,6 +3843,7 @@ components:
- merchantAccount
type: object
SuspendAccountHolderRequest:
additionalProperties: false
properties:
accountHolderCode:
description: The code of the account holder to be suspended.
@@ -3791,6 +3852,7 @@ components:
- accountHolderCode
type: object
SuspendAccountHolderResponse:
additionalProperties: false
properties:
accountHolderStatus:
description: The new status of the Account Holder.
@@ -3811,6 +3873,7 @@ components:
type: string
type: object
UltimateParentCompany:
additionalProperties: false
properties:
address:
description: Address of the ultimate parent company.
@@ -3826,6 +3889,7 @@ components:
type: string
type: object
UltimateParentCompanyBusinessDetails:
additionalProperties: false
properties:
legalBusinessName:
description: The legal name of the company.
@@ -3844,6 +3908,7 @@ components:
type: string
type: object
UnSuspendAccountHolderRequest:
additionalProperties: false
properties:
accountHolderCode:
description: The code of the account holder to be reinstated.
@@ -3852,6 +3917,7 @@ components:
- accountHolderCode
type: object
UnSuspendAccountHolderResponse:
additionalProperties: false
properties:
accountHolderStatus:
description: The new status of the Account Holder.
@@ -3872,6 +3938,7 @@ components:
type: string
type: object
UpdateAccountHolderRequest:
additionalProperties: false
properties:
accountHolderCode:
description: The code of the Account Holder to be updated.
@@ -3936,6 +4003,7 @@ components:
- accountHolderCode
type: object
UpdateAccountHolderResponse:
additionalProperties: false
properties:
accountHolderCode:
description: The code of the account holder.
@@ -3991,6 +4059,7 @@ components:
type: string
type: object
UpdateAccountHolderStateRequest:
additionalProperties: false
properties:
accountHolderCode:
description: The code of the Account Holder on which to update the state.
@@ -4022,6 +4091,7 @@ components:
- disable
type: object
UpdateAccountRequest:
additionalProperties: false
properties:
accountCode:
description: The code of the account to update.
@@ -4077,6 +4147,7 @@ components:
- accountCode
type: object
UpdateAccountResponse:
additionalProperties: false
properties:
accountCode:
description: The code of the account.
@@ -4138,6 +4209,7 @@ components:
- accountCode
type: object
UpdatePayoutScheduleRequest:
additionalProperties: false
properties:
action:
description: 'Direction on how to handle any payouts that have already been
@@ -4192,6 +4264,7 @@ components:
- schedule
type: object
UploadDocumentRequest:
additionalProperties: false
properties:
documentContent:
description: 'The content of the document, in Base64-encoded string format.
@@ -4208,6 +4281,7 @@ components:
- documentContent
type: object
ViasAddress:
additionalProperties: false
properties:
city:
description: The name of the city. Required if the `houseNumberOrName`,
@@ -4247,6 +4321,7 @@ components:
- country
type: object
ViasName:
additionalProperties: false
properties:
firstName:
description: The first name.
@@ -4274,6 +4349,7 @@ components:
type: string
type: object
ViasPersonalData:
additionalProperties: false
properties:
dateOfBirth:
description: The person's date of birth, in ISO-8601 YYYY-MM-DD format.
@@ -4297,6 +4373,7 @@ components:
type: string
type: object
ViasPhoneNumber:
additionalProperties: false
properties:
phoneCountryCode:
description: 'The two-character country code of the phone number.

26
yaml/FundService-v3.yaml
View File

@@ -580,6 +580,7 @@ paths:
components:
schemas:
AccountDetailBalance:
additionalProperties: false
properties:
accountCode:
description: The code of the account that holds the balance.
@@ -593,6 +594,7 @@ components:
AccountDetailBalance:
$ref: '#/components/schemas/AccountDetailBalance'
AccountHolderBalanceRequest:
additionalProperties: false
properties:
accountHolderCode:
description: The code of the Account Holder of which to retrieve the balance.
@@ -601,6 +603,7 @@ components:
- accountHolderCode
type: object
AccountHolderBalanceResponse:
additionalProperties: false
properties:
balancePerAccount:
description: A list of each account and their balances.
@@ -630,6 +633,7 @@ components:
$ref: '#/components/schemas/DetailBalance'
type: object
AccountHolderTransactionListRequest:
additionalProperties: false
properties:
accountHolderCode:
description: The code of the account holder that owns the account(s) of
@@ -748,6 +752,7 @@ components:
- accountHolderCode
type: object
AccountHolderTransactionListResponse:
additionalProperties: false
properties:
accountTransactionLists:
description: A list of the transactions.
@@ -774,6 +779,7 @@ components:
type: boolean
type: object
AccountTransactionList:
additionalProperties: false
properties:
accountCode:
description: The code of the account.
@@ -792,6 +798,7 @@ components:
AccountTransactionList:
$ref: '#/components/schemas/AccountTransactionList'
Amount:
additionalProperties: false
properties:
currency:
description: The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes).
@@ -811,6 +818,7 @@ components:
Amount:
$ref: '#/components/schemas/Amount'
BankAccountDetail:
additionalProperties: false
properties:
accountNumber:
description: 'The bank account number (without separators).
@@ -1015,6 +1023,7 @@ components:
type: string
type: object
DebitAccountHolderRequest:
additionalProperties: false
properties:
accountHolderCode:
description: The code of the account holder.
@@ -1051,6 +1060,7 @@ components:
- merchantAccount
type: object
DebitAccountHolderResponse:
additionalProperties: false
properties:
accountHolderCode:
description: The code of the account holder.
@@ -1085,6 +1095,7 @@ components:
type: boolean
type: object
DetailBalance:
additionalProperties: false
properties:
balance:
description: The list of balances held by the account.
@@ -1098,6 +1109,7 @@ components:
type: array
type: object
PayoutAccountHolderRequest:
additionalProperties: false
properties:
accountCode:
description: The code of the account from which the payout is to be made.
@@ -1142,6 +1154,7 @@ components:
- accountCode
type: object
PayoutAccountHolderResponse:
additionalProperties: false
properties:
bankAccountUUID:
description: The unique ID of the Bank Account to which the payout was made.
@@ -1171,6 +1184,7 @@ components:
type: boolean
type: object
RefundFundsTransferRequest:
additionalProperties: false
properties:
amount:
description: The amount to be transferred.
@@ -1187,6 +1201,7 @@ components:
- amount
type: object
RefundFundsTransferResponse:
additionalProperties: false
properties:
merchantReference:
description: The value supplied by the executing user when initiating the
@@ -1218,6 +1233,7 @@ components:
type: boolean
type: object
RefundNotPaidOutTransfersRequest:
additionalProperties: false
properties:
accountCode:
description: The code of the account from which to perform the refund(s).
@@ -1231,6 +1247,7 @@ components:
- accountCode
type: object
RefundNotPaidOutTransfersResponse:
additionalProperties: false
properties:
pspReference:
description: The reference of a request. Can be used to uniquely identify
@@ -1252,6 +1269,7 @@ components:
type: boolean
type: object
ServiceError:
additionalProperties: false
properties:
errorCode:
description: The error code mapped to the error message.
@@ -1271,6 +1289,7 @@ components:
type: integer
type: object
SetupBeneficiaryRequest:
additionalProperties: false
properties:
destinationAccountCode:
description: The destination account code.
@@ -1287,6 +1306,7 @@ components:
- destinationAccountCode
type: object
SetupBeneficiaryResponse:
additionalProperties: false
properties:
pspReference:
description: The reference of a request. Can be used to uniquely identify
@@ -1308,6 +1328,7 @@ components:
type: boolean
type: object
Split:
additionalProperties: false
properties:
account:
description: 'The unique identifier of the account to which the split amount
@@ -1381,6 +1402,7 @@ components:
- type
type: object
SplitAmount:
additionalProperties: false
properties:
currency:
description: The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes).
@@ -1396,6 +1418,7 @@ components:
- value
type: object
Transaction:
additionalProperties: false
properties:
amount:
description: The amount of the transaction.
@@ -1509,6 +1532,7 @@ components:
type: string
type: object
TransactionListForAccount:
additionalProperties: false
properties:
accountCode:
description: The account for which to retrieve the transactions.
@@ -1533,6 +1557,7 @@ components:
Transaction:
$ref: '#/components/schemas/Transaction'
TransferFundsRequest:
additionalProperties: false
properties:
amount:
description: The amount to be transferred.
@@ -1566,6 +1591,7 @@ components:
- amount
type: object
TransferFundsResponse:
additionalProperties: false
properties:
merchantReference:
x-addedInVersion: '2'

28
yaml/FundService-v5.yaml
View File

@@ -580,6 +580,7 @@ paths:
components:
schemas:
AccountDetailBalance:
additionalProperties: false
properties:
accountCode:
description: The code of the account that holds the balance.
@@ -589,6 +590,7 @@ components:
$ref: '#/components/schemas/DetailBalance'
type: object
AccountHolderBalanceRequest:
additionalProperties: false
properties:
accountHolderCode:
description: The code of the Account Holder of which to retrieve the balance.
@@ -597,6 +599,7 @@ components:
- accountHolderCode
type: object
AccountHolderBalanceResponse:
additionalProperties: false
properties:
balancePerAccount:
description: A list of each account and their balances.
@@ -622,6 +625,7 @@ components:
$ref: '#/components/schemas/DetailBalance'
type: object
AccountHolderTransactionListRequest:
additionalProperties: false
properties:
accountHolderCode:
description: The code of the account holder that owns the account(s) of
@@ -740,6 +744,7 @@ components:
- accountHolderCode
type: object
AccountHolderTransactionListResponse:
additionalProperties: false
properties:
accountTransactionLists:
description: A list of the transactions.
@@ -762,6 +767,7 @@ components:
type: string
type: object
AccountTransactionList:
additionalProperties: false
properties:
accountCode:
description: The code of the account.
@@ -776,6 +782,7 @@ components:
type: array
type: object
Amount:
additionalProperties: false
properties:
currency:
description: The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes).
@@ -791,6 +798,7 @@ components:
- currency
type: object
BankAccountDetail:
additionalProperties: false
properties:
accountNumber:
description: 'The bank account number (without separators).
@@ -999,6 +1007,7 @@ components:
type: string
type: object
DebitAccountHolderRequest:
additionalProperties: false
properties:
accountHolderCode:
description: The code of the account holder.
@@ -1035,6 +1044,7 @@ components:
- merchantAccount
type: object
DebitAccountHolderResponse:
additionalProperties: false
properties:
accountHolderCode:
description: The code of the account holder.
@@ -1065,6 +1075,7 @@ components:
type: string
type: object
DetailBalance:
additionalProperties: false
properties:
balance:
description: The list of balances held by the account.
@@ -1084,6 +1095,7 @@ components:
type: array
type: object
ErrorFieldType:
additionalProperties: false
properties:
errorCode:
description: The validation error code.
@@ -1097,6 +1109,7 @@ components:
$ref: '#/components/schemas/FieldType'
type: object
FieldType:
additionalProperties: false
properties:
field:
description: The full name of the property.
@@ -1274,6 +1287,7 @@ components:
type: string
type: object
PayoutAccountHolderRequest:
additionalProperties: false
properties:
accountCode:
description: The code of the account from which the payout is to be made.
@@ -1335,6 +1349,7 @@ components:
- accountCode
type: object
PayoutAccountHolderResponse:
additionalProperties: false
properties:
bankAccountUUID:
description: The unique ID of the Bank Account to which the payout was made.
@@ -1370,6 +1385,7 @@ components:
type: string
type: object
RefundFundsTransferRequest:
additionalProperties: false
properties:
amount:
description: The amount to be transferred.
@@ -1386,6 +1402,7 @@ components:
- amount
type: object
RefundFundsTransferResponse:
additionalProperties: false
properties:
invalidFields:
x-addedInVersion: '5'
@@ -1413,6 +1430,7 @@ components:
type: string
type: object
RefundNotPaidOutTransfersRequest:
additionalProperties: false
properties:
accountCode:
description: The code of the account from which to perform the refund(s).
@@ -1426,6 +1444,7 @@ components:
- accountCode
type: object
RefundNotPaidOutTransfersResponse:
additionalProperties: false
properties:
invalidFields:
x-addedInVersion: '5'
@@ -1443,6 +1462,7 @@ components:
type: string
type: object
ServiceError:
additionalProperties: false
properties:
errorCode:
description: The error code mapped to the error message.
@@ -1462,6 +1482,7 @@ components:
type: integer
type: object
SetupBeneficiaryRequest:
additionalProperties: false
properties:
destinationAccountCode:
description: The destination account code.
@@ -1478,6 +1499,7 @@ components:
- destinationAccountCode
type: object
SetupBeneficiaryResponse:
additionalProperties: false
properties:
invalidFields:
x-addedInVersion: '5'
@@ -1495,6 +1517,7 @@ components:
type: string
type: object
Split:
additionalProperties: false
properties:
account:
description: 'The unique identifier of the account to which the split amount
@@ -1568,6 +1591,7 @@ components:
- type
type: object
SplitAmount:
additionalProperties: false
properties:
currency:
description: The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes).
@@ -1583,6 +1607,7 @@ components:
- value
type: object
Transaction:
additionalProperties: false
properties:
amount:
description: The amount of the transaction.
@@ -1696,6 +1721,7 @@ components:
type: string
type: object
TransactionListForAccount:
additionalProperties: false
properties:
accountCode:
description: The account for which to retrieve the transactions.
@@ -1712,6 +1738,7 @@ components:
- page
type: object
TransferFundsRequest:
additionalProperties: false
properties:
amount:
description: The amount to be transferred.
@@ -1745,6 +1772,7 @@ components:
- amount
type: object
TransferFundsResponse:
additionalProperties: false
properties:
invalidFields:
x-addedInVersion: '5'

28
yaml/FundService-v6.yaml
View File

@@ -580,6 +580,7 @@ paths:
components:
schemas:
AccountDetailBalance:
additionalProperties: false
properties:
accountCode:
description: The code of the account that holds the balance.
@@ -589,6 +590,7 @@ components:
$ref: '#/components/schemas/DetailBalance'
type: object
AccountHolderBalanceRequest:
additionalProperties: false
properties:
accountHolderCode:
description: The code of the Account Holder of which to retrieve the balance.
@@ -597,6 +599,7 @@ components:
- accountHolderCode
type: object
AccountHolderBalanceResponse:
additionalProperties: false
properties:
balancePerAccount:
description: A list of each account and their balances.
@@ -622,6 +625,7 @@ components:
$ref: '#/components/schemas/DetailBalance'
type: object
AccountHolderTransactionListRequest:
additionalProperties: false
properties:
accountHolderCode:
description: The code of the account holder that owns the account(s) of
@@ -740,6 +744,7 @@ components:
- accountHolderCode
type: object
AccountHolderTransactionListResponse:
additionalProperties: false
properties:
accountTransactionLists:
description: A list of the transactions.
@@ -762,6 +767,7 @@ components:
type: string
type: object
AccountTransactionList:
additionalProperties: false
properties:
accountCode:
description: The code of the account.
@@ -776,6 +782,7 @@ components:
type: array
type: object
Amount:
additionalProperties: false
properties:
currency:
description: The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes).
@@ -791,6 +798,7 @@ components:
- currency
type: object
BankAccountDetail:
additionalProperties: false
properties:
accountNumber:
description: 'The bank account number (without separators).
@@ -999,6 +1007,7 @@ components:
type: string
type: object
DebitAccountHolderRequest:
additionalProperties: false
properties:
accountHolderCode:
description: The code of the account holder.
@@ -1035,6 +1044,7 @@ components:
- merchantAccount
type: object
DebitAccountHolderResponse:
additionalProperties: false
properties:
accountHolderCode:
description: The code of the account holder.
@@ -1065,6 +1075,7 @@ components:
type: string
type: object
DetailBalance:
additionalProperties: false
properties:
balance:
description: The list of balances held by the account.
@@ -1084,6 +1095,7 @@ components:
type: array
type: object
ErrorFieldType:
additionalProperties: false
properties:
errorCode:
description: The validation error code.
@@ -1097,6 +1109,7 @@ components:
$ref: '#/components/schemas/FieldType'
type: object
FieldType:
additionalProperties: false
properties:
field:
description: The full name of the property.
@@ -1274,6 +1287,7 @@ components:
type: string
type: object
PayoutAccountHolderRequest:
additionalProperties: false
properties:
accountCode:
description: The code of the account from which the payout is to be made.
@@ -1335,6 +1349,7 @@ components:
- accountCode
type: object
PayoutAccountHolderResponse:
additionalProperties: false
properties:
bankAccountUUID:
description: The unique ID of the Bank Account to which the payout was made.
@@ -1370,6 +1385,7 @@ components:
type: string
type: object
RefundFundsTransferRequest:
additionalProperties: false
properties:
amount:
description: The amount to be transferred.
@@ -1386,6 +1402,7 @@ components:
- amount
type: object
RefundFundsTransferResponse:
additionalProperties: false
properties:
invalidFields:
x-addedInVersion: '5'
@@ -1413,6 +1430,7 @@ components:
type: string
type: object
RefundNotPaidOutTransfersRequest:
additionalProperties: false
properties:
accountCode:
description: The code of the account from which to perform the refund(s).
@@ -1426,6 +1444,7 @@ components:
- accountCode
type: object
RefundNotPaidOutTransfersResponse:
additionalProperties: false
properties:
invalidFields:
x-addedInVersion: '5'
@@ -1443,6 +1462,7 @@ components:
type: string
type: object
ServiceError:
additionalProperties: false
properties:
errorCode:
description: The error code mapped to the error message.
@@ -1462,6 +1482,7 @@ components:
type: integer
type: object
SetupBeneficiaryRequest:
additionalProperties: false
properties:
destinationAccountCode:
description: The destination account code.
@@ -1478,6 +1499,7 @@ components:
- destinationAccountCode
type: object
SetupBeneficiaryResponse:
additionalProperties: false
properties:
invalidFields:
x-addedInVersion: '5'
@@ -1495,6 +1517,7 @@ components:
type: string
type: object
Split:
additionalProperties: false
properties:
account:
description: 'The unique identifier of the account to which the split amount
@@ -1568,6 +1591,7 @@ components:
- type
type: object
SplitAmount:
additionalProperties: false
properties:
currency:
description: The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes).
@@ -1583,6 +1607,7 @@ components:
- value
type: object
Transaction:
additionalProperties: false
properties:
amount:
description: The amount of the transaction.
@@ -1696,6 +1721,7 @@ components:
type: string
type: object
TransactionListForAccount:
additionalProperties: false
properties:
accountCode:
description: The account for which to retrieve the transactions.
@@ -1712,6 +1738,7 @@ components:
- page
type: object
TransferFundsRequest:
additionalProperties: false
properties:
amount:
description: The amount to be transferred.
@@ -1745,6 +1772,7 @@ components:
- amount
type: object
TransferFundsResponse:
additionalProperties: false
properties:
invalidFields:
x-addedInVersion: '5'

9
yaml/HopService-v1.yaml
View File

@@ -158,6 +158,7 @@ paths:
components:
schemas:
CollectInformation:
additionalProperties: false
properties:
bankDetails:
description: Indicates whether [bank account details](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/accepted-data-format/#bank-accounts)
@@ -185,6 +186,7 @@ components:
type: boolean
type: object
ErrorFieldType:
additionalProperties: false
properties:
errorCode:
description: The validation error code.
@@ -202,6 +204,7 @@ components:
ErrorFieldType:
$ref: '#/components/schemas/ErrorFieldType'
FieldType:
additionalProperties: false
properties:
field:
description: The full name of the property.
@@ -375,6 +378,7 @@ components:
type: string
type: object
GetOnboardingUrlRequest:
additionalProperties: false
properties:
accountHolderCode:
description: The account holder code you provided when you created the account
@@ -420,6 +424,7 @@ components:
- accountHolderCode
type: object
GetOnboardingUrlResponse:
additionalProperties: false
properties:
invalidFields:
x-addedInVersion: '5'
@@ -452,6 +457,7 @@ components:
type: boolean
type: object
GetPciUrlRequest:
additionalProperties: false
properties:
accountHolderCode:
description: The account holder code you provided when you created the account
@@ -466,6 +472,7 @@ components:
- accountHolderCode
type: object
GetPciUrlResponse:
additionalProperties: false
properties:
invalidFields:
x-addedInVersion: '5'
@@ -498,6 +505,7 @@ components:
type: boolean
type: object
ServiceError:
additionalProperties: false
properties:
errorCode:
description: The error code mapped to the error message.
@@ -517,6 +525,7 @@ components:
type: integer
type: object
ShowPages:
additionalProperties: false
properties:
bankDetailsSummaryPage:
description: Indicates whether the page with bank account details must be

9
yaml/HopService-v5.yaml
View File

@@ -158,6 +158,7 @@ paths:
components:
schemas:
CollectInformation:
additionalProperties: false
properties:
bankDetails:
description: Indicates whether [bank account details](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/accepted-data-format/#bank-accounts)
@@ -185,6 +186,7 @@ components:
type: boolean
type: object
ErrorFieldType:
additionalProperties: false
properties:
errorCode:
description: The validation error code.
@@ -198,6 +200,7 @@ components:
$ref: '#/components/schemas/FieldType'
type: object
FieldType:
additionalProperties: false
properties:
field:
description: The full name of the property.
@@ -375,6 +378,7 @@ components:
type: string
type: object
GetOnboardingUrlRequest:
additionalProperties: false
properties:
accountHolderCode:
description: The account holder code you provided when you created the account
@@ -420,6 +424,7 @@ components:
- accountHolderCode
type: object
GetOnboardingUrlResponse:
additionalProperties: false
properties:
invalidFields:
x-addedInVersion: '5'
@@ -441,6 +446,7 @@ components:
type: string
type: object
GetPciUrlRequest:
additionalProperties: false
properties:
accountHolderCode:
description: The account holder code you provided when you created the account
@@ -455,6 +461,7 @@ components:
- accountHolderCode
type: object
GetPciUrlResponse:
additionalProperties: false
properties:
invalidFields:
x-addedInVersion: '5'
@@ -476,6 +483,7 @@ components:
type: string
type: object
ServiceError:
additionalProperties: false
properties:
errorCode:
description: The error code mapped to the error message.
@@ -495,6 +503,7 @@ components:
type: integer
type: object
ShowPages:
additionalProperties: false
properties:
bankDetailsSummaryPage:
description: Indicates whether the page with bank account details must be

9
yaml/HopService-v6.yaml
View File

@@ -158,6 +158,7 @@ paths:
components:
schemas:
CollectInformation:
additionalProperties: false
properties:
bankDetails:
description: Indicates whether [bank account details](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/accepted-data-format/#bank-accounts)
@@ -185,6 +186,7 @@ components:
type: boolean
type: object
ErrorFieldType:
additionalProperties: false
properties:
errorCode:
description: The validation error code.
@@ -198,6 +200,7 @@ components:
$ref: '#/components/schemas/FieldType'
type: object
FieldType:
additionalProperties: false
properties:
field:
description: The full name of the property.
@@ -375,6 +378,7 @@ components:
type: string
type: object
GetOnboardingUrlRequest:
additionalProperties: false
properties:
accountHolderCode:
description: The account holder code you provided when you created the account
@@ -420,6 +424,7 @@ components:
- accountHolderCode
type: object
GetOnboardingUrlResponse:
additionalProperties: false
properties:
invalidFields:
x-addedInVersion: '5'
@@ -441,6 +446,7 @@ components:
type: string
type: object
GetPciUrlRequest:
additionalProperties: false
properties:
accountHolderCode:
description: The account holder code you provided when you created the account
@@ -455,6 +461,7 @@ components:
- accountHolderCode
type: object
GetPciUrlResponse:
additionalProperties: false
properties:
invalidFields:
x-addedInVersion: '5'
@@ -476,6 +483,7 @@ components:
type: string
type: object
ServiceError:
additionalProperties: false
properties:
errorCode:
description: The error code mapped to the error message.
@@ -495,6 +503,7 @@ components:
type: integer
type: object
ShowPages:
additionalProperties: false
properties:
bankDetailsSummaryPage:
description: Indicates whether the page with bank account details must be

76
yaml/MarketPayNotificationService-v3.yaml
View File

@@ -532,6 +532,7 @@ webhooks:
components:
schemas:
AccountCloseNotification:
additionalProperties: false
properties:
content:
description: The details of the Account update.
@@ -559,6 +560,7 @@ components:
- live
type: object
AccountCreateNotification:
additionalProperties: false
properties:
content:
description: The details of the account creation.
@@ -586,6 +588,7 @@ components:
- live
type: object
AccountEvent:
additionalProperties: false
properties:
event:
description: 'The event.
@@ -610,6 +613,7 @@ components:
AccountEvent:
$ref: '#/components/schemas/AccountEvent'
AccountFundsBelowThresholdNotification:
additionalProperties: false
properties:
content:
description: Details of the liable account with funds under threshold.
@@ -637,6 +641,7 @@ components:
- live
type: object
AccountFundsBelowThresholdNotificationContent:
additionalProperties: false
properties:
accountCode:
description: The code of the account with funds under threshold
@@ -658,6 +663,7 @@ components:
- fundThreshold
type: object
AccountHolderCreateNotification:
additionalProperties: false
properties:
content:
description: The details of the account holder creation.
@@ -685,6 +691,7 @@ components:
- live
type: object
AccountHolderDetails:
additionalProperties: false
properties:
address:
description: The address of the account holder.
@@ -753,6 +760,7 @@ components:
- address
type: object
AccountHolderPayoutNotification:
additionalProperties: false
properties:
content:
description: Details of the payout to the Account Holder.
@@ -780,6 +788,7 @@ components:
- live
type: object
AccountHolderPayoutNotificationContent:
additionalProperties: false
properties:
accountCode:
description: The code of the account from which the payout was made.
@@ -810,6 +819,7 @@ components:
$ref: '#/components/schemas/OperationStatus'
type: object
AccountHolderStatus:
additionalProperties: false
properties:
events:
description: A list of events scheduled for the account holder.
@@ -839,6 +849,7 @@ components:
- status
type: object
AccountHolderStatusChangeNotification:
additionalProperties: false
properties:
content:
description: The details of the Account Holder status change.
@@ -866,6 +877,7 @@ components:
- live
type: object
AccountHolderStatusChangeNotificationContent:
additionalProperties: false
properties:
accountHolderCode:
description: The code of the account holder.
@@ -885,6 +897,7 @@ components:
- accountHolderCode
type: object
AccountHolderStoreStatusChangeNotification:
additionalProperties: false
properties:
content:
description: The details of the Account Holder Store status change.
@@ -912,8 +925,10 @@ components:
- live
type: object
AccountHolderStoreStatusChangeNotificationContent:
additionalProperties: false
type: object
AccountHolderUpcomingDeadlineNotification:
additionalProperties: false
properties:
content:
description: The details of the upcoming event.
@@ -941,6 +956,7 @@ components:
- live
type: object
AccountHolderUpcomingDeadlineNotificationContent:
additionalProperties: false
properties:
accountHolderCode:
description: The code of the account holder whom the event refers to.
@@ -983,6 +999,7 @@ components:
type: string
type: object
AccountHolderUpdateNotification:
additionalProperties: false
properties:
content:
description: The details of the Account Holder update.
@@ -1010,6 +1027,7 @@ components:
- live
type: object
AccountHolderVerificationNotification:
additionalProperties: false
properties:
content:
description: The details of the Account Holder verification.
@@ -1037,6 +1055,7 @@ components:
- live
type: object
AccountHolderVerificationNotificationContent:
additionalProperties: false
properties:
accountHolderCode:
description: The code of the account holder.
@@ -1084,6 +1103,7 @@ components:
type: string
type: object
AccountPayoutState:
additionalProperties: false
properties:
allowPayout:
description: Indicates whether payouts are allowed. This field is the overarching
@@ -1116,6 +1136,7 @@ components:
type: integer
type: object
AccountProcessingState:
additionalProperties: false
properties:
disableReason:
description: The reason why processing has been disabled.
@@ -1140,6 +1161,7 @@ components:
type: integer
type: object
AccountUpdateNotification:
additionalProperties: false
properties:
content:
description: The details of the Account update.
@@ -1167,6 +1189,7 @@ components:
- live
type: object
Amount:
additionalProperties: false
properties:
currency:
description: The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes).
@@ -1186,6 +1209,7 @@ components:
Amount:
$ref: '#/components/schemas/Amount'
BankAccountDetail:
additionalProperties: false
properties:
accountNumber:
description: 'The bank account number (without separators).
@@ -1394,6 +1418,7 @@ components:
BankAccountDetail:
$ref: '#/components/schemas/BankAccountDetail'
BeneficiarySetupNotification:
additionalProperties: false
properties:
content:
description: Details of the beneficiary setup.
@@ -1421,6 +1446,7 @@ components:
- live
type: object
BeneficiarySetupNotificationContent:
additionalProperties: false
properties:
destinationAccountCode:
description: The code of the beneficiary account.
@@ -1449,6 +1475,7 @@ components:
type: integer
type: object
BusinessDetails:
additionalProperties: false
properties:
doingBusinessAs:
description: The registered name of the company (if it differs from the
@@ -1482,6 +1509,7 @@ components:
type: string
type: object
CloseAccountResponse:
additionalProperties: false
properties:
pspReference:
description: The reference of a request. Can be used to uniquely identify
@@ -1514,6 +1542,7 @@ components:
type: boolean
type: object
CompensateNegativeBalanceNotification:
additionalProperties: false
properties:
content:
description: Details of the negative balance compensation.
@@ -1541,6 +1570,7 @@ components:
- live
type: object
CompensateNegativeBalanceNotificationContent:
additionalProperties: false
properties:
records:
description: A list of the negative balances compensated.
@@ -1549,6 +1579,7 @@ components:
type: array
type: object
CompensateNegativeBalanceNotificationRecord:
additionalProperties: false
properties:
accountCode:
description: The code of the account whose negative balance has been compensated.
@@ -1566,6 +1597,7 @@ components:
CompensateNegativeBalanceNotificationRecord:
$ref: '#/components/schemas/CompensateNegativeBalanceNotificationRecord'
CreateAccountHolderResponse:
additionalProperties: false
properties:
accountCode:
description: The code of a new account created for the account holder.
@@ -1611,6 +1643,7 @@ components:
$ref: '#/components/schemas/KYCVerificationResult'
type: object
CreateAccountResponse:
additionalProperties: false
properties:
accountCode:
description: The code of the new account.
@@ -1652,6 +1685,7 @@ components:
type: boolean
type: object
DirectDebitInitiatedNotification:
additionalProperties: false
properties:
content:
description: Details of the direct debit.
@@ -1679,6 +1713,7 @@ components:
- live
type: object
DirectDebitInitiatedNotificationContent:
additionalProperties: false
properties:
accountCode:
description: The code of the account.
@@ -1711,6 +1746,7 @@ components:
- merchantAccountCode
type: object
ErrorFieldType:
additionalProperties: false
properties:
errorCode:
description: The validation error code.
@@ -1728,6 +1764,7 @@ components:
ErrorFieldType:
$ref: '#/components/schemas/ErrorFieldType'
FieldType:
additionalProperties: false
properties:
field:
description: The full name of the property.
@@ -1905,6 +1942,7 @@ components:
FieldType:
$ref: '#/components/schemas/FieldType'
IndividualDetails:
additionalProperties: false
properties:
name:
description: 'The name of the individual.
@@ -1917,6 +1955,7 @@ components:
$ref: '#/components/schemas/ViasPersonalData'
type: object
KYCBankAccountCheckResult:
additionalProperties: false
properties:
bankAccountUUID:
description: The unique ID of the bank account to which the check applies.
@@ -1928,6 +1967,7 @@ components:
type: array
type: object
KYCCheckDataSummaryItem:
additionalProperties: false
properties:
itemCode:
description: The code of the item reviewed.
@@ -1942,6 +1982,7 @@ components:
KYCCheckDataSummaryItem:
$ref: '#/components/schemas/KYCCheckDataSummaryItem'
KYCCheckResult:
additionalProperties: false
properties:
checks:
description: A list of the checks and their statuses.
@@ -1950,6 +1991,7 @@ components:
type: array
type: object
KYCCheckStatusData:
additionalProperties: false
properties:
requiredFields:
description: A list of the fields required for execution of the check.
@@ -1999,6 +2041,7 @@ components:
- status
type: object
KYCCheckSummary:
additionalProperties: false
properties:
code:
description: The code of the check.
@@ -2011,6 +2054,7 @@ components:
- code
type: object
KYCShareholderCheckResult:
additionalProperties: false
properties:
checks:
description: A list of the checks and their statuses.
@@ -2022,6 +2066,7 @@ components:
type: string
type: object
KYCSignatoryCheckResult:
additionalProperties: false
properties:
checks:
description: A list of the checks and their statuses.
@@ -2033,6 +2078,7 @@ components:
type: string
type: object
KYCVerificationResult:
additionalProperties: false
properties:
accountHolder:
description: The results of the checks on the account holder.
@@ -2054,6 +2100,7 @@ components:
type: array
type: object
LocalDate:
additionalProperties: false
properties:
month:
format: int32
@@ -2063,6 +2110,7 @@ components:
type: integer
type: object
Message:
additionalProperties: false
properties:
code:
description: The message code.
@@ -2072,6 +2120,7 @@ components:
type: string
type: object
NotificationResponse:
additionalProperties: false
properties:
notificationResponse:
description: Set this parameter to **[accepted]** to acknowledge that you
@@ -2079,6 +2128,7 @@ components:
type: string
type: object
OperationStatus:
additionalProperties: false
properties:
message:
description: The message regarding the operation status.
@@ -2088,6 +2138,7 @@ components:
type: string
type: object
PaymentFailureNotification:
additionalProperties: false
properties:
content:
description: The details of the payment failure.
@@ -2115,6 +2166,7 @@ components:
- live
type: object
PaymentFailureNotificationContent:
additionalProperties: false
properties:
errorFields:
description: Missing or invalid fields that caused the payment error.
@@ -2138,6 +2190,7 @@ components:
type: string
type: object
PayoutScheduleResponse:
additionalProperties: false
properties:
nextScheduledPayout:
description: The date of the next scheduled payout.
@@ -2172,6 +2225,7 @@ components:
type: string
type: object
PersonalDocumentData:
additionalProperties: false
properties:
expirationDate:
description: "The expiry date of the document, \n in ISO-8601 YYYY-MM-DD\
@@ -2212,6 +2266,7 @@ components:
PersonalDocumentData:
$ref: '#/components/schemas/PersonalDocumentData'
RefundFundsTransferNotification:
additionalProperties: false
properties:
content:
description: Details of the fund transfer refund.
@@ -2239,6 +2294,7 @@ components:
- live
type: object
RefundFundsTransferNotificationContent:
additionalProperties: false
properties:
amount:
description: The amount to be refunded.
@@ -2258,6 +2314,7 @@ components:
- amount
type: object
RefundResult:
additionalProperties: false
properties:
originalTransaction:
description: The transaction that has been refunded.
@@ -2275,6 +2332,7 @@ components:
RefundResult:
$ref: '#/components/schemas/RefundResult'
ReportAvailableNotification:
additionalProperties: false
properties:
content:
description: Details of the report.
@@ -2302,6 +2360,7 @@ components:
- live
type: object
ReportAvailableNotificationContent:
additionalProperties: false
properties:
accountCode:
description: The code of the Account to which the report applies.
@@ -2321,6 +2380,7 @@ components:
type: boolean
type: object
ScheduledRefundsNotification:
additionalProperties: false
properties:
content:
description: Details of the scheduling of the refunds.
@@ -2348,6 +2408,7 @@ components:
- live
type: object
ScheduledRefundsNotificationContent:
additionalProperties: false
properties:
accountCode:
description: The code of the account.
@@ -2366,6 +2427,7 @@ components:
type: array
type: object
ShareholderContact:
additionalProperties: false
properties:
address:
description: The address of the person.
@@ -2441,6 +2503,7 @@ components:
ShareholderContact:
$ref: '#/components/schemas/ShareholderContact'
SignatoryContact:
additionalProperties: false
properties:
address:
description: The address of the person.
@@ -2508,6 +2571,7 @@ components:
SignatoryContact:
$ref: '#/components/schemas/SignatoryContact'
Split:
additionalProperties: false
properties:
account:
description: 'The unique identifier of the account to which the split amount
@@ -2581,6 +2645,7 @@ components:
- type
type: object
SplitAmount:
additionalProperties: false
properties:
currency:
description: The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes).
@@ -2596,6 +2661,7 @@ components:
- value
type: object
Transaction:
additionalProperties: false
properties:
amount:
description: The amount of the transaction.
@@ -2709,6 +2775,7 @@ components:
type: string
type: object
TransferFundsNotification:
additionalProperties: false
properties:
content:
description: Details of the fund transfer.
@@ -2736,6 +2803,7 @@ components:
- live
type: object
TransferFundsNotificationContent:
additionalProperties: false
properties:
amount:
description: The amount transferred.
@@ -2758,6 +2826,7 @@ components:
type: string
type: object
UltimateParentCompany:
additionalProperties: false
properties:
address:
description: Address of the ultimate parent company.
@@ -2773,6 +2842,7 @@ components:
type: string
type: object
UltimateParentCompanyBusinessDetails:
additionalProperties: false
properties:
legalBusinessName:
description: The legal name of the company.
@@ -2795,6 +2865,7 @@ components:
UltimateParentCompany:
$ref: '#/components/schemas/UltimateParentCompany'
UpdateAccountHolderResponse:
additionalProperties: false
properties:
accountHolderCode:
description: The code of the account holder.
@@ -2842,6 +2913,7 @@ components:
$ref: '#/components/schemas/KYCVerificationResult'
type: object
UpdateAccountResponse:
additionalProperties: false
properties:
accountCode:
description: The code of the account.
@@ -2872,6 +2944,7 @@ components:
- accountCode
type: object
ViasAddress:
additionalProperties: false
properties:
city:
description: The name of the city. Required if the `houseNumberOrName`,
@@ -2911,6 +2984,7 @@ components:
- country
type: object
ViasName:
additionalProperties: false
properties:
firstName:
description: The first name.
@@ -2938,6 +3012,7 @@ components:
type: string
type: object
ViasPersonalData:
additionalProperties: false
properties:
dateOfBirth:
description: The person's date of birth, in ISO-8601 YYYY-MM-DD format.
@@ -2968,6 +3043,7 @@ components:
type: string
type: object
ViasPhoneNumber:
additionalProperties: false
properties:
phoneCountryCode:
description: 'The two-character country code of the phone number.

75
yaml/MarketPayNotificationService-v4.yaml
View File

@@ -532,6 +532,7 @@ webhooks:
components:
schemas:
AccountCloseNotification:
additionalProperties: false
properties:
content:
description: The details of the Account update.
@@ -565,6 +566,7 @@ components:
- eventDate
type: object
AccountCreateNotification:
additionalProperties: false
properties:
content:
description: The details of the account creation.
@@ -598,6 +600,7 @@ components:
- eventDate
type: object
AccountEvent:
additionalProperties: false
properties:
event:
description: 'The event.
@@ -622,6 +625,7 @@ components:
AccountEvent:
$ref: '#/components/schemas/AccountEvent'
AccountFundsBelowThresholdNotification:
additionalProperties: false
properties:
content:
description: Details of the liable account with funds under threshold.
@@ -655,6 +659,7 @@ components:
- eventDate
type: object
AccountFundsBelowThresholdNotificationContent:
additionalProperties: false
properties:
accountCode:
description: The code of the account with funds under threshold
@@ -676,6 +681,7 @@ components:
- fundThreshold
type: object
AccountHolderCreateNotification:
additionalProperties: false
properties:
content:
description: The details of the account holder creation.
@@ -709,6 +715,7 @@ components:
- eventDate
type: object
AccountHolderDetails:
additionalProperties: false
properties:
address:
description: The address of the account holder.
@@ -777,6 +784,7 @@ components:
- address
type: object
AccountHolderPayoutNotification:
additionalProperties: false
properties:
content:
description: Details of the payout to the Account Holder.
@@ -810,6 +818,7 @@ components:
- eventDate
type: object
AccountHolderPayoutNotificationContent:
additionalProperties: false
properties:
accountCode:
description: The code of the account from which the payout was made.
@@ -840,6 +849,7 @@ components:
$ref: '#/components/schemas/OperationStatus'
type: object
AccountHolderStatus:
additionalProperties: false
properties:
events:
description: A list of events scheduled for the account holder.
@@ -869,6 +879,7 @@ components:
- status
type: object
AccountHolderStatusChangeNotification:
additionalProperties: false
properties:
content:
description: The details of the Account Holder status change.
@@ -902,6 +913,7 @@ components:
- eventDate
type: object
AccountHolderStatusChangeNotificationContent:
additionalProperties: false
properties:
accountHolderCode:
description: The code of the account holder.
@@ -921,6 +933,7 @@ components:
- accountHolderCode
type: object
AccountHolderStoreStatusChangeNotification:
additionalProperties: false
properties:
content:
description: The details of the Account Holder Store status change.
@@ -954,8 +967,10 @@ components:
- eventDate
type: object
AccountHolderStoreStatusChangeNotificationContent:
additionalProperties: false
type: object
AccountHolderUpcomingDeadlineNotification:
additionalProperties: false
properties:
content:
description: The details of the upcoming event.
@@ -989,6 +1004,7 @@ components:
- eventDate
type: object
AccountHolderUpcomingDeadlineNotificationContent:
additionalProperties: false
properties:
accountHolderCode:
description: The code of the account holder whom the event refers to.
@@ -1031,6 +1047,7 @@ components:
type: string
type: object
AccountHolderUpdateNotification:
additionalProperties: false
properties:
content:
description: The details of the Account Holder update.
@@ -1064,6 +1081,7 @@ components:
- eventDate
type: object
AccountHolderVerificationNotification:
additionalProperties: false
properties:
content:
description: The details of the Account Holder verification.
@@ -1097,6 +1115,7 @@ components:
- eventDate
type: object
AccountHolderVerificationNotificationContent:
additionalProperties: false
properties:
accountHolderCode:
description: The code of the account holder.
@@ -1142,6 +1161,7 @@ components:
type: string
type: object
AccountPayoutState:
additionalProperties: false
properties:
allowPayout:
description: Indicates whether payouts are allowed. This field is the overarching
@@ -1174,6 +1194,7 @@ components:
type: integer
type: object
AccountProcessingState:
additionalProperties: false
properties:
disableReason:
description: The reason why processing has been disabled.
@@ -1198,6 +1219,7 @@ components:
type: integer
type: object
AccountUpdateNotification:
additionalProperties: false
properties:
content:
description: The details of the Account update.
@@ -1231,6 +1253,7 @@ components:
- eventDate
type: object
Amount:
additionalProperties: false
properties:
currency:
description: The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes).
@@ -1250,6 +1273,7 @@ components:
Amount:
$ref: '#/components/schemas/Amount'
BankAccountDetail:
additionalProperties: false
properties:
accountNumber:
description: 'The bank account number (without separators).
@@ -1458,6 +1482,7 @@ components:
BankAccountDetail:
$ref: '#/components/schemas/BankAccountDetail'
BeneficiarySetupNotification:
additionalProperties: false
properties:
content:
description: Details of the beneficiary setup.
@@ -1491,6 +1516,7 @@ components:
- eventDate
type: object
BeneficiarySetupNotificationContent:
additionalProperties: false
properties:
destinationAccountCode:
description: The code of the beneficiary account.
@@ -1519,6 +1545,7 @@ components:
type: integer
type: object
BusinessDetails:
additionalProperties: false
properties:
doingBusinessAs:
description: The registered name of the company (if it differs from the
@@ -1556,6 +1583,7 @@ components:
type: string
type: object
CloseAccountResponse:
additionalProperties: false
properties:
pspReference:
description: The reference of a request. Can be used to uniquely identify
@@ -1588,6 +1616,7 @@ components:
type: boolean
type: object
CompensateNegativeBalanceNotification:
additionalProperties: false
properties:
content:
description: Details of the negative balance compensation.
@@ -1621,6 +1650,7 @@ components:
- eventDate
type: object
CompensateNegativeBalanceNotificationContent:
additionalProperties: false
properties:
records:
description: A list of the negative balances compensated.
@@ -1629,6 +1659,7 @@ components:
type: array
type: object
CompensateNegativeBalanceNotificationRecord:
additionalProperties: false
properties:
accountCode:
description: The code of the account whose negative balance has been compensated.
@@ -1646,6 +1677,7 @@ components:
CompensateNegativeBalanceNotificationRecord:
$ref: '#/components/schemas/CompensateNegativeBalanceNotificationRecord'
CreateAccountHolderResponse:
additionalProperties: false
properties:
accountCode:
description: The code of a new account created for the account holder.
@@ -1703,6 +1735,7 @@ components:
$ref: '#/components/schemas/KYCVerificationResult'
type: object
CreateAccountResponse:
additionalProperties: false
properties:
accountCode:
description: The code of the new account.
@@ -1748,6 +1781,7 @@ components:
type: boolean
type: object
DirectDebitInitiatedNotification:
additionalProperties: false
properties:
content:
description: Details of the direct debit.
@@ -1781,6 +1815,7 @@ components:
- eventDate
type: object
DirectDebitInitiatedNotificationContent:
additionalProperties: false
properties:
accountCode:
description: The code of the account.
@@ -1813,6 +1848,7 @@ components:
- merchantAccountCode
type: object
ErrorFieldType:
additionalProperties: false
properties:
errorCode:
description: The validation error code.
@@ -1830,6 +1866,7 @@ components:
ErrorFieldType:
$ref: '#/components/schemas/ErrorFieldType'
FieldType:
additionalProperties: false
properties:
field:
description: The full name of the property.
@@ -2011,6 +2048,7 @@ components:
FieldType:
$ref: '#/components/schemas/FieldType'
IndividualDetails:
additionalProperties: false
properties:
name:
description: 'The name of the individual.
@@ -2023,6 +2061,7 @@ components:
$ref: '#/components/schemas/ViasPersonalData'
type: object
KYCBankAccountCheckResult:
additionalProperties: false
properties:
bankAccountUUID:
description: The unique ID of the bank account to which the check applies.
@@ -2034,6 +2073,7 @@ components:
type: array
type: object
KYCCheckResult:
additionalProperties: false
properties:
checks:
description: A list of the checks and their statuses.
@@ -2042,6 +2082,7 @@ components:
type: array
type: object
KYCCheckStatusData:
additionalProperties: false
properties:
requiredFields:
description: A list of the fields required for execution of the check.
@@ -2091,6 +2132,7 @@ components:
- status
type: object
KYCCheckSummary:
additionalProperties: false
properties:
code:
description: The code of the check.
@@ -2103,6 +2145,7 @@ components:
- code
type: object
KYCShareholderCheckResult:
additionalProperties: false
properties:
checks:
description: A list of the checks and their statuses.
@@ -2114,6 +2157,7 @@ components:
type: string
type: object
KYCSignatoryCheckResult:
additionalProperties: false
properties:
checks:
description: A list of the checks and their statuses.
@@ -2125,6 +2169,7 @@ components:
type: string
type: object
KYCVerificationResult:
additionalProperties: false
properties:
accountHolder:
description: The results of the checks on the account holder.
@@ -2146,6 +2191,7 @@ components:
type: array
type: object
LocalDate:
additionalProperties: false
properties:
month:
format: int32
@@ -2155,6 +2201,7 @@ components:
type: integer
type: object
Message:
additionalProperties: false
properties:
code:
description: The message code.
@@ -2164,6 +2211,7 @@ components:
type: string
type: object
NotificationResponse:
additionalProperties: false
properties:
notificationResponse:
description: Set this parameter to **[accepted]** to acknowledge that you
@@ -2171,6 +2219,7 @@ components:
type: string
type: object
OperationStatus:
additionalProperties: false
properties:
message:
description: The message regarding the operation status.
@@ -2180,6 +2229,7 @@ components:
type: string
type: object
PaymentFailureNotification:
additionalProperties: false
properties:
content:
description: The details of the payment failure.
@@ -2213,6 +2263,7 @@ components:
- eventDate
type: object
PaymentFailureNotificationContent:
additionalProperties: false
properties:
errorFields:
description: Missing or invalid fields that caused the payment error.
@@ -2236,6 +2287,7 @@ components:
type: string
type: object
PayoutScheduleResponse:
additionalProperties: false
properties:
nextScheduledPayout:
description: The date of the next scheduled payout.
@@ -2270,6 +2322,7 @@ components:
type: string
type: object
PersonalDocumentData:
additionalProperties: false
properties:
expirationDate:
description: "The expiry date of the document, \n in ISO-8601 YYYY-MM-DD\
@@ -2310,6 +2363,7 @@ components:
PersonalDocumentData:
$ref: '#/components/schemas/PersonalDocumentData'
RefundFundsTransferNotification:
additionalProperties: false
properties:
content:
description: Details of the fund transfer refund.
@@ -2343,6 +2397,7 @@ components:
- eventDate
type: object
RefundFundsTransferNotificationContent:
additionalProperties: false
properties:
amount:
description: The amount to be refunded.
@@ -2362,6 +2417,7 @@ components:
- amount
type: object
RefundResult:
additionalProperties: false
properties:
originalTransaction:
description: The transaction that has been refunded.
@@ -2379,6 +2435,7 @@ components:
RefundResult:
$ref: '#/components/schemas/RefundResult'
ReportAvailableNotification:
additionalProperties: false
properties:
content:
description: Details of the report.
@@ -2412,6 +2469,7 @@ components:
- eventDate
type: object
ReportAvailableNotificationContent:
additionalProperties: false
properties:
accountCode:
description: The code of the Account to which the report applies.
@@ -2431,6 +2489,7 @@ components:
type: boolean
type: object
ScheduledRefundsNotification:
additionalProperties: false
properties:
content:
description: Details of the scheduling of the refunds.
@@ -2464,6 +2523,7 @@ components:
- eventDate
type: object
ScheduledRefundsNotificationContent:
additionalProperties: false
properties:
accountCode:
description: The code of the account.
@@ -2482,6 +2542,7 @@ components:
type: array
type: object
ShareholderContact:
additionalProperties: false
properties:
address:
description: The address of the person.
@@ -2557,6 +2618,7 @@ components:
ShareholderContact:
$ref: '#/components/schemas/ShareholderContact'
SignatoryContact:
additionalProperties: false
properties:
address:
description: The address of the person.
@@ -2624,6 +2686,7 @@ components:
SignatoryContact:
$ref: '#/components/schemas/SignatoryContact'
Split:
additionalProperties: false
properties:
account:
description: 'The unique identifier of the account to which the split amount
@@ -2697,6 +2760,7 @@ components:
- type
type: object
SplitAmount:
additionalProperties: false
properties:
currency:
description: The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes).
@@ -2712,6 +2776,7 @@ components:
- value
type: object
Transaction:
additionalProperties: false
properties:
amount:
description: The amount of the transaction.
@@ -2825,6 +2890,7 @@ components:
type: string
type: object
TransferFundsNotification:
additionalProperties: false
properties:
content:
description: Details of the fund transfer.
@@ -2858,6 +2924,7 @@ components:
- eventDate
type: object
TransferFundsNotificationContent:
additionalProperties: false
properties:
amount:
description: The amount transferred.
@@ -2880,6 +2947,7 @@ components:
type: string
type: object
UltimateParentCompany:
additionalProperties: false
properties:
address:
description: Address of the ultimate parent company.
@@ -2895,6 +2963,7 @@ components:
type: string
type: object
UltimateParentCompanyBusinessDetails:
additionalProperties: false
properties:
legalBusinessName:
description: The legal name of the company.
@@ -2917,6 +2986,7 @@ components:
UltimateParentCompany:
$ref: '#/components/schemas/UltimateParentCompany'
UpdateAccountHolderResponse:
additionalProperties: false
properties:
accountHolderCode:
description: The code of the account holder.
@@ -2976,6 +3046,7 @@ components:
$ref: '#/components/schemas/KYCVerificationResult'
type: object
UpdateAccountResponse:
additionalProperties: false
properties:
accountCode:
description: The code of the account.
@@ -3010,6 +3081,7 @@ components:
- accountCode
type: object
ViasAddress:
additionalProperties: false
properties:
city:
description: The name of the city. Required if the `houseNumberOrName`,
@@ -3049,6 +3121,7 @@ components:
- country
type: object
ViasName:
additionalProperties: false
properties:
firstName:
description: The first name.
@@ -3076,6 +3149,7 @@ components:
type: string
type: object
ViasPersonalData:
additionalProperties: false
properties:
dateOfBirth:
description: The person's date of birth, in ISO-8601 YYYY-MM-DD format.
@@ -3106,6 +3180,7 @@ components:
type: string
type: object
ViasPhoneNumber:
additionalProperties: false
properties:
phoneCountryCode:
description: 'The two-character country code of the phone number.

79
yaml/MarketPayNotificationService-v5.yaml
View File

@@ -539,6 +539,7 @@ webhooks:
components:
schemas:
AccountCloseNotification:
additionalProperties: false
properties:
content:
description: The details of the Account update.
@@ -577,6 +578,7 @@ components:
- eventDate
type: object
AccountCreateNotification:
additionalProperties: false
properties:
content:
description: The details of the account creation.
@@ -615,6 +617,7 @@ components:
- eventDate
type: object
AccountEvent:
additionalProperties: false
properties:
event:
description: 'The event.
@@ -635,6 +638,7 @@ components:
type: string
type: object
AccountFundsBelowThresholdNotification:
additionalProperties: false
properties:
content:
description: Details of the liable account with funds under threshold.
@@ -673,6 +677,7 @@ components:
- eventDate
type: object
AccountFundsBelowThresholdNotificationContent:
additionalProperties: false
properties:
accountCode:
description: The code of the account with funds under threshold
@@ -694,6 +699,7 @@ components:
- fundThreshold
type: object
AccountHolderCreateNotification:
additionalProperties: false
properties:
content:
description: The details of the account holder creation.
@@ -732,6 +738,7 @@ components:
- eventDate
type: object
AccountHolderDetails:
additionalProperties: false
properties:
address:
description: The address of the account holder.
@@ -820,6 +827,7 @@ components:
- address
type: object
AccountHolderPayoutNotification:
additionalProperties: false
properties:
content:
description: Details of the payout to the Account Holder.
@@ -858,6 +866,7 @@ components:
- eventDate
type: object
AccountHolderPayoutNotificationContent:
additionalProperties: false
properties:
accountCode:
description: The code of the account from which the payout was made.
@@ -911,6 +920,7 @@ components:
$ref: '#/components/schemas/OperationStatus'
type: object
AccountHolderStatus:
additionalProperties: false
properties:
events:
description: A list of events scheduled for the account holder.
@@ -940,6 +950,7 @@ components:
- status
type: object
AccountHolderStatusChangeNotification:
additionalProperties: false
properties:
content:
description: The details of the Account Holder status change.
@@ -978,6 +989,7 @@ components:
- eventDate
type: object
AccountHolderStatusChangeNotificationContent:
additionalProperties: false
properties:
accountHolderCode:
description: The code of the account holder.
@@ -1004,6 +1016,7 @@ components:
- accountHolderCode
type: object
AccountHolderStoreStatusChangeNotification:
additionalProperties: false
properties:
content:
description: The details of the Account Holder Store status change.
@@ -1042,6 +1055,7 @@ components:
- eventDate
type: object
AccountHolderStoreStatusChangeNotificationContent:
additionalProperties: false
properties:
accountHolderCode:
x-addedInVersion: '5'
@@ -1094,6 +1108,7 @@ components:
- newStatus
type: object
AccountHolderUpcomingDeadlineNotification:
additionalProperties: false
properties:
content:
description: The details of the upcoming event.
@@ -1132,6 +1147,7 @@ components:
- eventDate
type: object
AccountHolderUpcomingDeadlineNotificationContent:
additionalProperties: false
properties:
accountHolderCode:
description: The code of the account holder whom the event refers to.
@@ -1174,6 +1190,7 @@ components:
type: string
type: object
AccountHolderUpdateNotification:
additionalProperties: false
properties:
content:
description: The details of the Account Holder update.
@@ -1212,6 +1229,7 @@ components:
- eventDate
type: object
AccountHolderVerificationNotification:
additionalProperties: false
properties:
content:
description: The details of the Account Holder verification.
@@ -1250,6 +1268,7 @@ components:
- eventDate
type: object
AccountHolderVerificationNotificationContent:
additionalProperties: false
properties:
accountHolderCode:
description: The code of the account holder.
@@ -1269,6 +1288,7 @@ components:
type: string
type: object
AccountPayoutState:
additionalProperties: false
properties:
allowPayout:
description: Indicates whether payouts are allowed. This field is the overarching
@@ -1308,6 +1328,7 @@ components:
type: integer
type: object
AccountProcessingState:
additionalProperties: false
properties:
disableReason:
description: The reason why processing has been disabled.
@@ -1332,6 +1353,7 @@ components:
type: integer
type: object
AccountUpdateNotification:
additionalProperties: false
properties:
content:
description: The details of the Account update.
@@ -1370,6 +1392,7 @@ components:
- eventDate
type: object
Amount:
additionalProperties: false
properties:
currency:
description: The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes).
@@ -1385,6 +1408,7 @@ components:
- currency
type: object
BankAccountDetail:
additionalProperties: false
properties:
accountNumber:
description: 'The bank account number (without separators).
@@ -1593,6 +1617,7 @@ components:
type: string
type: object
BeneficiarySetupNotification:
additionalProperties: false
properties:
content:
description: Details of the beneficiary setup.
@@ -1631,6 +1656,7 @@ components:
- eventDate
type: object
BeneficiarySetupNotificationContent:
additionalProperties: false
properties:
destinationAccountCode:
description: The code of the beneficiary account.
@@ -1662,6 +1688,7 @@ components:
type: string
type: object
BusinessDetails:
additionalProperties: false
properties:
doingBusinessAs:
description: The registered name of the company (if it differs from the
@@ -1699,6 +1726,7 @@ components:
type: string
type: object
CloseAccountResponse:
additionalProperties: false
properties:
accountCode:
x-addedInVersion: '5'
@@ -1731,6 +1759,7 @@ components:
type: string
type: object
CompensateNegativeBalanceNotification:
additionalProperties: false
properties:
content:
description: Details of the negative balance compensation.
@@ -1769,6 +1798,7 @@ components:
- eventDate
type: object
CompensateNegativeBalanceNotificationContent:
additionalProperties: false
properties:
records:
description: A list of the negative balances compensated.
@@ -1777,6 +1807,7 @@ components:
type: array
type: object
CompensateNegativeBalanceNotificationRecord:
additionalProperties: false
properties:
accountCode:
description: The code of the account whose negative balance has been compensated.
@@ -1790,6 +1821,7 @@ components:
type: string
type: object
CreateAccountHolderResponse:
additionalProperties: false
properties:
accountCode:
description: The code of a new account created for the account holder.
@@ -1842,6 +1874,7 @@ components:
$ref: '#/components/schemas/KYCVerificationResult'
type: object
CreateAccountResponse:
additionalProperties: false
properties:
accountCode:
description: The code of the new account.
@@ -1912,6 +1945,7 @@ components:
type: string
type: object
DirectDebitInitiatedNotification:
additionalProperties: false
properties:
content:
description: Details of the direct debit.
@@ -1950,6 +1984,7 @@ components:
- eventDate
type: object
DirectDebitInitiatedNotificationContent:
additionalProperties: false
properties:
accountCode:
description: The code of the account.
@@ -1982,6 +2017,7 @@ components:
- merchantAccountCode
type: object
ErrorFieldType:
additionalProperties: false
properties:
errorCode:
description: The validation error code.
@@ -1995,6 +2031,7 @@ components:
$ref: '#/components/schemas/FieldType'
type: object
FieldType:
additionalProperties: false
properties:
field:
description: The full name of the property.
@@ -2172,6 +2209,7 @@ components:
type: string
type: object
IndividualDetails:
additionalProperties: false
properties:
name:
description: 'The name of the individual.
@@ -2184,6 +2222,7 @@ components:
$ref: '#/components/schemas/ViasPersonalData'
type: object
KYCBankAccountCheckResult:
additionalProperties: false
properties:
bankAccountUUID:
description: The unique ID of the bank account to which the check applies.
@@ -2195,6 +2234,7 @@ components:
type: array
type: object
KYCCardCheckResult:
additionalProperties: false
properties:
checks:
description: A list of the checks and their statuses.
@@ -2206,6 +2246,7 @@ components:
type: string
type: object
KYCCheckResult:
additionalProperties: false
properties:
checks:
description: A list of the checks and their statuses.
@@ -2214,6 +2255,7 @@ components:
type: array
type: object
KYCCheckStatusData:
additionalProperties: false
properties:
requiredFields:
description: A list of the fields required for execution of the check.
@@ -2263,6 +2305,7 @@ components:
- status
type: object
KYCCheckSummary:
additionalProperties: false
properties:
kycCheckCode:
x-addedInVersion: '5'
@@ -2276,6 +2319,7 @@ components:
type: string
type: object
KYCShareholderCheckResult:
additionalProperties: false
properties:
checks:
description: A list of the checks and their statuses.
@@ -2287,6 +2331,7 @@ components:
type: string
type: object
KYCSignatoryCheckResult:
additionalProperties: false
properties:
checks:
description: A list of the checks and their statuses.
@@ -2298,6 +2343,7 @@ components:
type: string
type: object
KYCVerificationResult:
additionalProperties: false
properties:
accountHolder:
description: The results of the checks on the account holder.
@@ -2325,6 +2371,7 @@ components:
type: array
type: object
LocalDate:
additionalProperties: false
properties:
month:
format: int32
@@ -2334,6 +2381,7 @@ components:
type: integer
type: object
Message:
additionalProperties: false
properties:
code:
description: The message code.
@@ -2343,6 +2391,7 @@ components:
type: string
type: object
NotificationErrorContainer:
additionalProperties: false
properties:
errorCode:
description: The Adyen code that is mapped to the error message.
@@ -2352,6 +2401,7 @@ components:
type: string
type: object
NotificationResponse:
additionalProperties: false
properties:
notificationResponse:
description: Set this parameter to **[accepted]** to acknowledge that you
@@ -2359,6 +2409,7 @@ components:
type: string
type: object
OperationStatus:
additionalProperties: false
properties:
message:
description: The message regarding the operation status.
@@ -2368,6 +2419,7 @@ components:
type: string
type: object
PaymentFailureNotification:
additionalProperties: false
properties:
content:
description: The details of the payment failure.
@@ -2406,6 +2458,7 @@ components:
- eventDate
type: object
PaymentFailureNotificationContent:
additionalProperties: false
properties:
errorFields:
description: Missing or invalid fields that caused the payment error.
@@ -2429,6 +2482,7 @@ components:
type: string
type: object
PayoutMethod:
additionalProperties: false
properties:
merchantAccount:
description: The [`merchantAccount`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__reqParam_merchantAccount)
@@ -2460,6 +2514,7 @@ components:
- recurringDetailReference
type: object
PayoutScheduleResponse:
additionalProperties: false
properties:
nextScheduledPayout:
description: The date of the next scheduled payout.
@@ -2494,6 +2549,7 @@ components:
type: string
type: object
PersonalDocumentData:
additionalProperties: false
properties:
expirationDate:
description: "The expiry date of the document, \n in ISO-8601 YYYY-MM-DD\
@@ -2530,6 +2586,7 @@ components:
- type
type: object
RefundFundsTransferNotification:
additionalProperties: false
properties:
content:
description: Details of the fund transfer refund.
@@ -2568,6 +2625,7 @@ components:
- eventDate
type: object
RefundFundsTransferNotificationContent:
additionalProperties: false
properties:
amount:
description: The amount to be refunded.
@@ -2593,6 +2651,7 @@ components:
- amount
type: object
RefundResult:
additionalProperties: false
properties:
originalTransaction:
description: The transaction that has been refunded.
@@ -2606,6 +2665,7 @@ components:
type: string
type: object
ReportAvailableNotification:
additionalProperties: false
properties:
content:
description: Details of the report.
@@ -2644,6 +2704,7 @@ components:
- eventDate
type: object
ReportAvailableNotificationContent:
additionalProperties: false
properties:
accountCode:
description: The code of the Account to which the report applies.
@@ -2663,6 +2724,7 @@ components:
type: boolean
type: object
ScheduledRefundsNotification:
additionalProperties: false
properties:
content:
description: Details of the scheduling of the refunds.
@@ -2701,6 +2763,7 @@ components:
- eventDate
type: object
ScheduledRefundsNotificationContent:
additionalProperties: false
properties:
accountCode:
description: The code of the account.
@@ -2725,6 +2788,7 @@ components:
type: array
type: object
ShareholderContact:
additionalProperties: false
properties:
address:
description: The address of the person.
@@ -2800,6 +2864,7 @@ components:
type: string
type: object
SignatoryContact:
additionalProperties: false
properties:
address:
description: The address of the person.
@@ -2863,6 +2928,7 @@ components:
type: string
type: object
Split:
additionalProperties: false
properties:
account:
description: 'The unique identifier of the account to which the split amount
@@ -2936,6 +3002,7 @@ components:
- type
type: object
SplitAmount:
additionalProperties: false
properties:
currency:
description: The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes).
@@ -2951,6 +3018,7 @@ components:
- value
type: object
StoreDetail:
additionalProperties: false
properties:
address:
description: The address of the physical store where the account holder
@@ -3039,6 +3107,7 @@ components:
- merchantAccount
type: object
Transaction:
additionalProperties: false
properties:
amount:
description: The amount of the transaction.
@@ -3152,6 +3221,7 @@ components:
type: string
type: object
TransferFundsNotification:
additionalProperties: false
properties:
content:
description: Details of the fund transfer.
@@ -3190,6 +3260,7 @@ components:
- eventDate
type: object
TransferFundsNotificationContent:
additionalProperties: false
properties:
amount:
description: The amount transferred.
@@ -3218,6 +3289,7 @@ components:
type: string
type: object
UltimateParentCompany:
additionalProperties: false
properties:
address:
description: Address of the ultimate parent company.
@@ -3233,6 +3305,7 @@ components:
type: string
type: object
UltimateParentCompanyBusinessDetails:
additionalProperties: false
properties:
legalBusinessName:
description: The legal name of the company.
@@ -3251,6 +3324,7 @@ components:
type: string
type: object
UpdateAccountHolderResponse:
additionalProperties: false
properties:
accountHolderCode:
description: The code of the account holder.
@@ -3300,6 +3374,7 @@ components:
$ref: '#/components/schemas/KYCVerificationResult'
type: object
UpdateAccountResponse:
additionalProperties: false
properties:
accountCode:
description: The code of the account.
@@ -3361,6 +3436,7 @@ components:
- accountCode
type: object
ViasAddress:
additionalProperties: false
properties:
city:
description: The name of the city. Required if the `houseNumberOrName`,
@@ -3400,6 +3476,7 @@ components:
- country
type: object
ViasName:
additionalProperties: false
properties:
firstName:
description: The first name.
@@ -3427,6 +3504,7 @@ components:
type: string
type: object
ViasPersonalData:
additionalProperties: false
properties:
dateOfBirth:
description: The person's date of birth, in ISO-8601 YYYY-MM-DD format.
@@ -3450,6 +3528,7 @@ components:
type: string
type: object
ViasPhoneNumber:
additionalProperties: false
properties:
phoneCountryCode:
description: 'The two-character country code of the phone number.

83
yaml/MarketPayNotificationService-v6.yaml
View File

@@ -539,6 +539,7 @@ webhooks:
components:
schemas:
AccountCloseNotification:
additionalProperties: false
properties:
content:
description: The details of the Account update.
@@ -577,6 +578,7 @@ components:
- eventDate
type: object
AccountCreateNotification:
additionalProperties: false
properties:
content:
description: The details of the account creation.
@@ -615,6 +617,7 @@ components:
- eventDate
type: object
AccountEvent:
additionalProperties: false
properties:
event:
description: 'The event.
@@ -635,6 +638,7 @@ components:
type: string
type: object
AccountFundsBelowThresholdNotification:
additionalProperties: false
properties:
content:
description: Details of the liable account with funds under threshold.
@@ -673,6 +677,7 @@ components:
- eventDate
type: object
AccountFundsBelowThresholdNotificationContent:
additionalProperties: false
properties:
accountCode:
description: The code of the account with funds under threshold
@@ -694,6 +699,7 @@ components:
- fundThreshold
type: object
AccountHolderCreateNotification:
additionalProperties: false
properties:
content:
description: The details of the account holder creation.
@@ -732,6 +738,7 @@ components:
- eventDate
type: object
AccountHolderDetails:
additionalProperties: false
properties:
address:
description: The address of the account holder.
@@ -827,6 +834,7 @@ components:
- address
type: object
AccountHolderPayoutNotification:
additionalProperties: false
properties:
content:
description: Details of the payout to the Account Holder.
@@ -865,6 +873,7 @@ components:
- eventDate
type: object
AccountHolderPayoutNotificationContent:
additionalProperties: false
properties:
accountCode:
description: The code of the account from which the payout was made.
@@ -940,6 +949,7 @@ components:
$ref: '#/components/schemas/OperationStatus'
type: object
AccountHolderStatus:
additionalProperties: false
properties:
events:
description: A list of events scheduled for the account holder.
@@ -969,6 +979,7 @@ components:
- status
type: object
AccountHolderStatusChangeNotification:
additionalProperties: false
properties:
content:
description: The details of the Account Holder status change.
@@ -1007,6 +1018,7 @@ components:
- eventDate
type: object
AccountHolderStatusChangeNotificationContent:
additionalProperties: false
properties:
accountHolderCode:
description: The code of the account holder.
@@ -1033,6 +1045,7 @@ components:
- accountHolderCode
type: object
AccountHolderStoreStatusChangeNotification:
additionalProperties: false
properties:
content:
description: The details of the Account Holder Store status change.
@@ -1071,6 +1084,7 @@ components:
- eventDate
type: object
AccountHolderStoreStatusChangeNotificationContent:
additionalProperties: false
properties:
accountHolderCode:
x-addedInVersion: '5'
@@ -1123,6 +1137,7 @@ components:
- newStatus
type: object
AccountHolderUpcomingDeadlineNotification:
additionalProperties: false
properties:
content:
description: The details of the upcoming event.
@@ -1161,6 +1176,7 @@ components:
- eventDate
type: object
AccountHolderUpcomingDeadlineNotificationContent:
additionalProperties: false
properties:
accountHolderCode:
description: The code of the account holder whom the event refers to.
@@ -1203,6 +1219,7 @@ components:
type: string
type: object
AccountHolderUpdateNotification:
additionalProperties: false
properties:
content:
description: The details of the Account Holder update.
@@ -1241,6 +1258,7 @@ components:
- eventDate
type: object
AccountHolderVerificationNotification:
additionalProperties: false
properties:
content:
description: The details of the Account Holder verification.
@@ -1279,6 +1297,7 @@ components:
- eventDate
type: object
AccountHolderVerificationNotificationContent:
additionalProperties: false
properties:
accountHolderCode:
description: The code of the account holder.
@@ -1308,6 +1327,7 @@ components:
type: string
type: object
AccountPayoutState:
additionalProperties: false
properties:
allowPayout:
description: Indicates whether payouts are allowed. This field is the overarching
@@ -1347,6 +1367,7 @@ components:
type: integer
type: object
AccountProcessingState:
additionalProperties: false
properties:
disableReason:
description: The reason why processing has been disabled.
@@ -1371,6 +1392,7 @@ components:
type: integer
type: object
AccountUpdateNotification:
additionalProperties: false
properties:
content:
description: The details of the Account update.
@@ -1409,6 +1431,7 @@ components:
- eventDate
type: object
Amount:
additionalProperties: false
properties:
currency:
description: The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes).
@@ -1424,6 +1447,7 @@ components:
- currency
type: object
BankAccountDetail:
additionalProperties: false
properties:
accountNumber:
description: 'The bank account number (without separators).
@@ -1632,6 +1656,7 @@ components:
type: string
type: object
BeneficiarySetupNotification:
additionalProperties: false
properties:
content:
description: Details of the beneficiary setup.
@@ -1670,6 +1695,7 @@ components:
- eventDate
type: object
BeneficiarySetupNotificationContent:
additionalProperties: false
properties:
destinationAccountCode:
description: The code of the beneficiary account.
@@ -1701,6 +1727,7 @@ components:
type: string
type: object
BusinessDetails:
additionalProperties: false
properties:
doingBusinessAs:
description: The registered name of the company (if it differs from the
@@ -1750,6 +1777,7 @@ components:
type: string
type: object
CloseAccountResponse:
additionalProperties: false
properties:
accountCode:
x-addedInVersion: '5'
@@ -1782,6 +1810,7 @@ components:
type: string
type: object
CompensateNegativeBalanceNotification:
additionalProperties: false
properties:
content:
description: Details of the negative balance compensation.
@@ -1820,6 +1849,7 @@ components:
- eventDate
type: object
CompensateNegativeBalanceNotificationContent:
additionalProperties: false
properties:
records:
description: A list of the negative balances compensated.
@@ -1828,6 +1858,7 @@ components:
type: array
type: object
CompensateNegativeBalanceNotificationRecord:
additionalProperties: false
properties:
accountCode:
description: The code of the account whose negative balance has been compensated.
@@ -1841,6 +1872,7 @@ components:
type: string
type: object
CreateAccountHolderResponse:
additionalProperties: false
properties:
accountCode:
description: The code of a new account created for the account holder.
@@ -1899,6 +1931,7 @@ components:
type: string
type: object
CreateAccountResponse:
additionalProperties: false
properties:
accountCode:
description: The code of the new account.
@@ -1969,6 +2002,7 @@ components:
type: string
type: object
DirectDebitInitiatedNotification:
additionalProperties: false
properties:
content:
description: Details of the direct debit.
@@ -2007,6 +2041,7 @@ components:
- eventDate
type: object
DirectDebitInitiatedNotificationContent:
additionalProperties: false
properties:
accountCode:
description: The code of the account.
@@ -2039,6 +2074,7 @@ components:
- merchantAccountCode
type: object
ErrorFieldType:
additionalProperties: false
properties:
errorCode:
description: The validation error code.
@@ -2052,6 +2088,7 @@ components:
$ref: '#/components/schemas/FieldType'
type: object
FieldType:
additionalProperties: false
properties:
field:
description: The full name of the property.
@@ -2229,6 +2266,7 @@ components:
type: string
type: object
IndividualDetails:
additionalProperties: false
properties:
name:
description: 'The name of the individual.
@@ -2241,6 +2279,7 @@ components:
$ref: '#/components/schemas/ViasPersonalData'
type: object
KYCCheckResult:
additionalProperties: false
properties:
checks:
description: A list of the checks and their statuses.
@@ -2249,6 +2288,7 @@ components:
type: array
type: object
KYCCheckStatusData:
additionalProperties: false
properties:
requiredFields:
description: A list of the fields required for execution of the check.
@@ -2298,6 +2338,7 @@ components:
- status
type: object
KYCCheckSummary:
additionalProperties: false
properties:
kycCheckCode:
x-addedInVersion: '5'
@@ -2311,6 +2352,7 @@ components:
type: string
type: object
KYCLegalArrangementCheckResult:
additionalProperties: false
properties:
checks:
description: A list of the checks and their statuses.
@@ -2322,6 +2364,7 @@ components:
type: string
type: object
KYCLegalArrangementEntityCheckResult:
additionalProperties: false
properties:
checks:
description: A list of the checks and their statuses.
@@ -2338,6 +2381,7 @@ components:
type: string
type: object
KYCPayoutMethodCheckResult:
additionalProperties: false
properties:
checks:
description: A list of the checks and their statuses.
@@ -2349,6 +2393,7 @@ components:
type: string
type: object
KYCShareholderCheckResult:
additionalProperties: false
properties:
checks:
description: A list of the checks and their statuses.
@@ -2370,6 +2415,7 @@ components:
type: string
type: object
KYCSignatoryCheckResult:
additionalProperties: false
properties:
checks:
description: A list of the checks and their statuses.
@@ -2381,6 +2427,7 @@ components:
type: string
type: object
KYCUltimateParentCompanyCheckResult:
additionalProperties: false
properties:
checks:
description: A list of the checks and their statuses.
@@ -2394,6 +2441,7 @@ components:
type: string
type: object
KYCVerificationResult:
additionalProperties: false
properties:
accountHolder:
description: The results of the checks on the account holder.
@@ -2434,6 +2482,7 @@ components:
type: array
type: object
LegalArrangementDetail:
additionalProperties: false
properties:
address:
description: The address of the legal arrangement.
@@ -2518,6 +2567,7 @@ components:
- address
type: object
LegalArrangementEntityDetail:
additionalProperties: false
properties:
address:
description: The address of the entity.
@@ -2599,6 +2649,7 @@ components:
type: string
type: object
LocalDate:
additionalProperties: false
properties:
month:
format: int32
@@ -2608,6 +2659,7 @@ components:
type: integer
type: object
Message:
additionalProperties: false
properties:
code:
description: The message code.
@@ -2617,6 +2669,7 @@ components:
type: string
type: object
NotificationErrorContainer:
additionalProperties: false
properties:
errorCode:
description: The Adyen code that is mapped to the error message.
@@ -2626,6 +2679,7 @@ components:
type: string
type: object
NotificationResponse:
additionalProperties: false
properties:
notificationResponse:
description: Set this parameter to **[accepted]** to acknowledge that you
@@ -2633,6 +2687,7 @@ components:
type: string
type: object
OperationStatus:
additionalProperties: false
properties:
message:
description: The message regarding the operation status.
@@ -2642,6 +2697,7 @@ components:
type: string
type: object
PaymentFailureNotification:
additionalProperties: false
properties:
content:
description: The details of the payment failure.
@@ -2680,6 +2736,7 @@ components:
- eventDate
type: object
PaymentFailureNotificationContent:
additionalProperties: false
properties:
errorFields:
description: Missing or invalid fields that caused the payment error.
@@ -2703,6 +2760,7 @@ components:
type: string
type: object
PayoutMethod:
additionalProperties: false
properties:
merchantAccount:
description: The [`merchantAccount`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__reqParam_merchantAccount)
@@ -2734,6 +2792,7 @@ components:
- recurringDetailReference
type: object
PayoutScheduleResponse:
additionalProperties: false
properties:
nextScheduledPayout:
description: The date of the next scheduled payout.
@@ -2768,6 +2827,7 @@ components:
type: string
type: object
PersonalDocumentData:
additionalProperties: false
properties:
expirationDate:
description: "The expiry date of the document, \n in ISO-8601 YYYY-MM-DD\
@@ -2804,6 +2864,7 @@ components:
- type
type: object
RefundFundsTransferNotification:
additionalProperties: false
properties:
content:
description: Details of the fund transfer refund.
@@ -2842,6 +2903,7 @@ components:
- eventDate
type: object
RefundFundsTransferNotificationContent:
additionalProperties: false
properties:
amount:
description: The amount to be refunded.
@@ -2867,6 +2929,7 @@ components:
- amount
type: object
RefundResult:
additionalProperties: false
properties:
originalTransaction:
description: The transaction that has been refunded.
@@ -2880,6 +2943,7 @@ components:
type: string
type: object
ReportAvailableNotification:
additionalProperties: false
properties:
content:
description: Details of the report.
@@ -2918,6 +2982,7 @@ components:
- eventDate
type: object
ReportAvailableNotificationContent:
additionalProperties: false
properties:
accountCode:
description: The code of the Account to which the report applies.
@@ -2937,6 +3002,7 @@ components:
type: boolean
type: object
ScheduledRefundsNotification:
additionalProperties: false
properties:
content:
description: Details of the scheduling of the refunds.
@@ -2975,6 +3041,7 @@ components:
- eventDate
type: object
ScheduledRefundsNotificationContent:
additionalProperties: false
properties:
accountCode:
description: The code of the account.
@@ -2999,6 +3066,7 @@ components:
type: array
type: object
ShareholderContact:
additionalProperties: false
properties:
address:
description: The address of the person.
@@ -3074,6 +3142,7 @@ components:
type: string
type: object
SignatoryContact:
additionalProperties: false
properties:
address:
description: The address of the person.
@@ -3137,6 +3206,7 @@ components:
type: string
type: object
Split:
additionalProperties: false
properties:
account:
description: 'The unique identifier of the account to which the split amount
@@ -3210,6 +3280,7 @@ components:
- type
type: object
SplitAmount:
additionalProperties: false
properties:
currency:
description: The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes).
@@ -3225,6 +3296,7 @@ components:
- value
type: object
StoreDetail:
additionalProperties: false
properties:
address:
description: The address of the physical store where the account holder
@@ -3313,6 +3385,7 @@ components:
- merchantAccount
type: object
Transaction:
additionalProperties: false
properties:
amount:
description: The amount of the transaction.
@@ -3426,6 +3499,7 @@ components:
type: string
type: object
TransferFundsNotification:
additionalProperties: false
properties:
content:
description: Details of the fund transfer.
@@ -3464,6 +3538,7 @@ components:
- eventDate
type: object
TransferFundsNotificationContent:
additionalProperties: false
properties:
amount:
description: The amount transferred.
@@ -3492,6 +3567,7 @@ components:
type: string
type: object
UltimateParentCompany:
additionalProperties: false
properties:
address:
description: Address of the ultimate parent company.
@@ -3507,6 +3583,7 @@ components:
type: string
type: object
UltimateParentCompanyBusinessDetails:
additionalProperties: false
properties:
legalBusinessName:
description: The legal name of the company.
@@ -3525,6 +3602,7 @@ components:
type: string
type: object
UpdateAccountHolderResponse:
additionalProperties: false
properties:
accountHolderCode:
description: The code of the account holder.
@@ -3580,6 +3658,7 @@ components:
type: string
type: object
UpdateAccountResponse:
additionalProperties: false
properties:
accountCode:
description: The code of the account.
@@ -3641,6 +3720,7 @@ components:
- accountCode
type: object
ViasAddress:
additionalProperties: false
properties:
city:
description: The name of the city. Required if the `houseNumberOrName`,
@@ -3680,6 +3760,7 @@ components:
- country
type: object
ViasName:
additionalProperties: false
properties:
firstName:
description: The first name.
@@ -3707,6 +3788,7 @@ components:
type: string
type: object
ViasPersonalData:
additionalProperties: false
properties:
dateOfBirth:
description: The person's date of birth, in ISO-8601 YYYY-MM-DD format.
@@ -3730,6 +3812,7 @@ components:
type: string
type: object
ViasPhoneNumber:
additionalProperties: false
properties:
phoneCountryCode:
description: 'The two-character country code of the phone number.

14
yaml/NotificationConfigurationService-v1.yaml
View File

@@ -407,6 +407,7 @@ paths:
components:
schemas:
CreateNotificationConfigurationRequest:
additionalProperties: false
properties:
configurationDetails:
description: Details of the prospective notification subscription configuration.
@@ -415,6 +416,7 @@ components:
- configurationDetails
type: object
DeleteNotificationConfigurationRequest:
additionalProperties: false
properties:
notificationIds:
description: A list of IDs of the notification subscription configurations
@@ -427,8 +429,10 @@ components:
- notificationIds
type: object
EmptyRequest:
additionalProperties: false
type: object
ExchangeMessage:
additionalProperties: false
properties:
messageCode:
type: string
@@ -440,6 +444,7 @@ components:
ExchangeMessage:
$ref: '#/components/schemas/ExchangeMessage'
GenericResponse:
additionalProperties: false
properties:
pspReference:
description: The reference of a request. Can be used to uniquely identify
@@ -461,6 +466,7 @@ components:
type: boolean
type: object
GetNotificationConfigurationListResponse:
additionalProperties: false
properties:
configurations:
description: Details of the notification subscription configurations.
@@ -487,6 +493,7 @@ components:
type: boolean
type: object
GetNotificationConfigurationRequest:
additionalProperties: false
properties:
notificationId:
description: The ID of the notification subscription configuration whose
@@ -497,6 +504,7 @@ components:
- notificationId
type: object
GetNotificationConfigurationResponse:
additionalProperties: false
properties:
configurationDetails:
description: Details of the notification subscription configuration.
@@ -523,6 +531,7 @@ components:
- configurationDetails
type: object
NotificationConfigurationDetails:
additionalProperties: false
properties:
active:
description: Indicates whether the notification subscription is active.
@@ -587,6 +596,7 @@ components:
NotificationConfigurationDetails:
$ref: '#/components/schemas/NotificationConfigurationDetails'
NotificationEventConfiguration:
additionalProperties: false
properties:
eventType:
description: 'The type of event.
@@ -649,6 +659,7 @@ components:
NotificationEventConfiguration:
$ref: '#/components/schemas/NotificationEventConfiguration'
ServiceError:
additionalProperties: false
properties:
errorCode:
description: The error code mapped to the error message.
@@ -668,6 +679,7 @@ components:
type: integer
type: object
TestNotificationConfigurationRequest:
additionalProperties: false
properties:
eventTypes:
description: 'The event types to test. If left blank, then all of the configured
@@ -716,6 +728,7 @@ components:
- notificationId
type: object
TestNotificationConfigurationResponse:
additionalProperties: false
properties:
errorMessages:
description: Any error messages encountered.
@@ -795,6 +808,7 @@ components:
- notificationId
type: object
UpdateNotificationConfigurationRequest:
additionalProperties: false
properties:
configurationDetails:
description: Details of the notification subscription configuration to be

14
yaml/NotificationConfigurationService-v2.yaml
View File

@@ -407,6 +407,7 @@ paths:
components:
schemas:
CreateNotificationConfigurationRequest:
additionalProperties: false
properties:
configurationDetails:
description: Details of the prospective notification subscription configuration.
@@ -415,6 +416,7 @@ components:
- configurationDetails
type: object
DeleteNotificationConfigurationRequest:
additionalProperties: false
properties:
notificationIds:
description: A list of IDs of the notification subscription configurations
@@ -427,8 +429,10 @@ components:
- notificationIds
type: object
EmptyRequest:
additionalProperties: false
type: object
ExchangeMessage:
additionalProperties: false
properties:
messageCode:
type: string
@@ -440,6 +444,7 @@ components:
ExchangeMessage:
$ref: '#/components/schemas/ExchangeMessage'
GenericResponse:
additionalProperties: false
properties:
pspReference:
description: The reference of a request. Can be used to uniquely identify
@@ -461,6 +466,7 @@ components:
type: boolean
type: object
GetNotificationConfigurationListResponse:
additionalProperties: false
properties:
configurations:
description: Details of the notification subscription configurations.
@@ -487,6 +493,7 @@ components:
type: boolean
type: object
GetNotificationConfigurationRequest:
additionalProperties: false
properties:
notificationId:
description: The ID of the notification subscription configuration whose
@@ -497,6 +504,7 @@ components:
- notificationId
type: object
GetNotificationConfigurationResponse:
additionalProperties: false
properties:
configurationDetails:
description: Details of the notification subscription configuration.
@@ -523,6 +531,7 @@ components:
- configurationDetails
type: object
NotificationConfigurationDetails:
additionalProperties: false
properties:
active:
description: Indicates whether the notification subscription is active.
@@ -587,6 +596,7 @@ components:
NotificationConfigurationDetails:
$ref: '#/components/schemas/NotificationConfigurationDetails'
NotificationEventConfiguration:
additionalProperties: false
properties:
eventType:
description: 'The type of event.
@@ -649,6 +659,7 @@ components:
NotificationEventConfiguration:
$ref: '#/components/schemas/NotificationEventConfiguration'
ServiceError:
additionalProperties: false
properties:
errorCode:
description: The error code mapped to the error message.
@@ -668,6 +679,7 @@ components:
type: integer
type: object
TestNotificationConfigurationRequest:
additionalProperties: false
properties:
eventTypes:
description: 'The event types to test. If left blank, then all of the configured
@@ -716,6 +728,7 @@ components:
- notificationId
type: object
TestNotificationConfigurationResponse:
additionalProperties: false
properties:
errorMessages:
description: Any error messages encountered.
@@ -795,6 +808,7 @@ components:
- notificationId
type: object
UpdateNotificationConfigurationRequest:
additionalProperties: false
properties:
configurationDetails:
description: Details of the notification subscription configuration to be

14
yaml/NotificationConfigurationService-v3.yaml
View File

@@ -407,6 +407,7 @@ paths:
components:
schemas:
CreateNotificationConfigurationRequest:
additionalProperties: false
properties:
configurationDetails:
description: Details of the prospective notification subscription configuration.
@@ -415,6 +416,7 @@ components:
- configurationDetails
type: object
DeleteNotificationConfigurationRequest:
additionalProperties: false
properties:
notificationIds:
description: A list of IDs of the notification subscription configurations
@@ -427,8 +429,10 @@ components:
- notificationIds
type: object
EmptyRequest:
additionalProperties: false
type: object
ExchangeMessage:
additionalProperties: false
properties:
messageCode:
type: string
@@ -440,6 +444,7 @@ components:
ExchangeMessage:
$ref: '#/components/schemas/ExchangeMessage'
GenericResponse:
additionalProperties: false
properties:
pspReference:
description: The reference of a request. Can be used to uniquely identify
@@ -461,6 +466,7 @@ components:
type: boolean
type: object
GetNotificationConfigurationListResponse:
additionalProperties: false
properties:
configurations:
description: Details of the notification subscription configurations.
@@ -487,6 +493,7 @@ components:
type: boolean
type: object
GetNotificationConfigurationRequest:
additionalProperties: false
properties:
notificationId:
description: The ID of the notification subscription configuration whose
@@ -497,6 +504,7 @@ components:
- notificationId
type: object
GetNotificationConfigurationResponse:
additionalProperties: false
properties:
configurationDetails:
description: Details of the notification subscription configuration.
@@ -523,6 +531,7 @@ components:
- configurationDetails
type: object
NotificationConfigurationDetails:
additionalProperties: false
properties:
active:
description: Indicates whether the notification subscription is active.
@@ -587,6 +596,7 @@ components:
NotificationConfigurationDetails:
$ref: '#/components/schemas/NotificationConfigurationDetails'
NotificationEventConfiguration:
additionalProperties: false
properties:
eventType:
description: 'The type of event.
@@ -649,6 +659,7 @@ components:
NotificationEventConfiguration:
$ref: '#/components/schemas/NotificationEventConfiguration'
ServiceError:
additionalProperties: false
properties:
errorCode:
description: The error code mapped to the error message.
@@ -668,6 +679,7 @@ components:
type: integer
type: object
TestNotificationConfigurationRequest:
additionalProperties: false
properties:
eventTypes:
description: 'The event types to test. If left blank, then all of the configured
@@ -716,6 +728,7 @@ components:
- notificationId
type: object
TestNotificationConfigurationResponse:
additionalProperties: false
properties:
errorMessages:
description: Any error messages encountered.
@@ -795,6 +808,7 @@ components:
- notificationId
type: object
UpdateNotificationConfigurationRequest:
additionalProperties: false
properties:
configurationDetails:
description: Details of the notification subscription configuration to be

14
yaml/NotificationConfigurationService-v4.yaml
View File

@@ -407,6 +407,7 @@ paths:
components:
schemas:
CreateNotificationConfigurationRequest:
additionalProperties: false
properties:
configurationDetails:
description: Details of the prospective notification subscription configuration.
@@ -415,6 +416,7 @@ components:
- configurationDetails
type: object
DeleteNotificationConfigurationRequest:
additionalProperties: false
properties:
notificationIds:
description: A list of IDs of the notification subscription configurations
@@ -427,8 +429,10 @@ components:
- notificationIds
type: object
EmptyRequest:
additionalProperties: false
type: object
ExchangeMessage:
additionalProperties: false
properties:
messageCode:
type: string
@@ -440,6 +444,7 @@ components:
ExchangeMessage:
$ref: '#/components/schemas/ExchangeMessage'
GenericResponse:
additionalProperties: false
properties:
pspReference:
description: The reference of a request. Can be used to uniquely identify
@@ -461,6 +466,7 @@ components:
type: boolean
type: object
GetNotificationConfigurationListResponse:
additionalProperties: false
properties:
configurations:
description: Details of the notification subscription configurations.
@@ -487,6 +493,7 @@ components:
type: boolean
type: object
GetNotificationConfigurationRequest:
additionalProperties: false
properties:
notificationId:
description: The ID of the notification subscription configuration whose
@@ -497,6 +504,7 @@ components:
- notificationId
type: object
GetNotificationConfigurationResponse:
additionalProperties: false
properties:
configurationDetails:
description: Details of the notification subscription configuration.
@@ -523,6 +531,7 @@ components:
- configurationDetails
type: object
NotificationConfigurationDetails:
additionalProperties: false
properties:
active:
description: Indicates whether the notification subscription is active.
@@ -587,6 +596,7 @@ components:
NotificationConfigurationDetails:
$ref: '#/components/schemas/NotificationConfigurationDetails'
NotificationEventConfiguration:
additionalProperties: false
properties:
eventType:
description: 'The type of event.
@@ -649,6 +659,7 @@ components:
NotificationEventConfiguration:
$ref: '#/components/schemas/NotificationEventConfiguration'
ServiceError:
additionalProperties: false
properties:
errorCode:
description: The error code mapped to the error message.
@@ -668,6 +679,7 @@ components:
type: integer
type: object
TestNotificationConfigurationRequest:
additionalProperties: false
properties:
eventTypes:
description: 'The event types to test. If left blank, then all of the configured
@@ -716,6 +728,7 @@ components:
- notificationId
type: object
TestNotificationConfigurationResponse:
additionalProperties: false
properties:
errorMessages:
description: Any error messages encountered.
@@ -795,6 +808,7 @@ components:
- notificationId
type: object
UpdateNotificationConfigurationRequest:
additionalProperties: false
properties:
configurationDetails:
description: Details of the notification subscription configuration to be

16
yaml/NotificationConfigurationService-v5.yaml
View File

@@ -407,6 +407,7 @@ paths:
components:
schemas:
CreateNotificationConfigurationRequest:
additionalProperties: false
properties:
configurationDetails:
description: Details of the prospective notification subscription configuration.
@@ -415,6 +416,7 @@ components:
- configurationDetails
type: object
DeleteNotificationConfigurationRequest:
additionalProperties: false
properties:
notificationIds:
description: A list of IDs of the notification subscription configurations
@@ -427,8 +429,10 @@ components:
- notificationIds
type: object
EmptyRequest:
additionalProperties: false
type: object
ErrorFieldType:
additionalProperties: false
properties:
errorCode:
description: The validation error code.
@@ -442,6 +446,7 @@ components:
$ref: '#/components/schemas/FieldType'
type: object
ExchangeMessage:
additionalProperties: false
properties:
messageCode:
type: string
@@ -449,6 +454,7 @@ components:
type: string
type: object
FieldType:
additionalProperties: false
properties:
field:
description: The full name of the property.
@@ -626,6 +632,7 @@ components:
type: string
type: object
GenericResponse:
additionalProperties: false
properties:
invalidFields:
x-addedInVersion: '5'
@@ -643,6 +650,7 @@ components:
type: string
type: object
GetNotificationConfigurationListResponse:
additionalProperties: false
properties:
configurations:
description: Details of the notification subscription configurations.
@@ -665,6 +673,7 @@ components:
type: string
type: object
GetNotificationConfigurationRequest:
additionalProperties: false
properties:
notificationId:
description: The ID of the notification subscription configuration whose
@@ -675,6 +684,7 @@ components:
- notificationId
type: object
GetNotificationConfigurationResponse:
additionalProperties: false
properties:
configurationDetails:
description: Details of the notification subscription configuration.
@@ -697,6 +707,7 @@ components:
- configurationDetails
type: object
NotificationConfigurationDetails:
additionalProperties: false
properties:
active:
description: Indicates whether the notification subscription is active.
@@ -760,6 +771,7 @@ components:
type: string
type: object
NotificationEventConfiguration:
additionalProperties: false
properties:
eventType:
description: 'The type of event.
@@ -818,6 +830,7 @@ components:
- includeMode
type: object
ServiceError:
additionalProperties: false
properties:
errorCode:
description: The error code mapped to the error message.
@@ -837,6 +850,7 @@ components:
type: integer
type: object
TestNotificationConfigurationRequest:
additionalProperties: false
properties:
eventTypes:
description: 'The event types to test. If left blank, then all of the configured
@@ -885,6 +899,7 @@ components:
- notificationId
type: object
TestNotificationConfigurationResponse:
additionalProperties: false
properties:
errorMessages:
description: Any error messages encountered.
@@ -960,6 +975,7 @@ components:
- notificationId
type: object
UpdateNotificationConfigurationRequest:
additionalProperties: false
properties:
configurationDetails:
description: Details of the notification subscription configuration to be

16
yaml/NotificationConfigurationService-v6.yaml
View File

@@ -407,6 +407,7 @@ paths:
components:
schemas:
CreateNotificationConfigurationRequest:
additionalProperties: false
properties:
configurationDetails:
description: Details of the prospective notification subscription configuration.
@@ -415,6 +416,7 @@ components:
- configurationDetails
type: object
DeleteNotificationConfigurationRequest:
additionalProperties: false
properties:
notificationIds:
description: A list of IDs of the notification subscription configurations
@@ -427,8 +429,10 @@ components:
- notificationIds
type: object
EmptyRequest:
additionalProperties: false
type: object
ErrorFieldType:
additionalProperties: false
properties:
errorCode:
description: The validation error code.
@@ -442,6 +446,7 @@ components:
$ref: '#/components/schemas/FieldType'
type: object
ExchangeMessage:
additionalProperties: false
properties:
messageCode:
type: string
@@ -449,6 +454,7 @@ components:
type: string
type: object
FieldType:
additionalProperties: false
properties:
field:
description: The full name of the property.
@@ -626,6 +632,7 @@ components:
type: string
type: object
GenericResponse:
additionalProperties: false
properties:
invalidFields:
x-addedInVersion: '5'
@@ -643,6 +650,7 @@ components:
type: string
type: object
GetNotificationConfigurationListResponse:
additionalProperties: false
properties:
configurations:
description: Details of the notification subscription configurations.
@@ -665,6 +673,7 @@ components:
type: string
type: object
GetNotificationConfigurationRequest:
additionalProperties: false
properties:
notificationId:
description: The ID of the notification subscription configuration whose
@@ -675,6 +684,7 @@ components:
- notificationId
type: object
GetNotificationConfigurationResponse:
additionalProperties: false
properties:
configurationDetails:
description: Details of the notification subscription configuration.
@@ -697,6 +707,7 @@ components:
- configurationDetails
type: object
NotificationConfigurationDetails:
additionalProperties: false
properties:
active:
description: Indicates whether the notification subscription is active.
@@ -760,6 +771,7 @@ components:
type: string
type: object
NotificationEventConfiguration:
additionalProperties: false
properties:
eventType:
description: 'The type of event.
@@ -818,6 +830,7 @@ components:
- includeMode
type: object
ServiceError:
additionalProperties: false
properties:
errorCode:
description: The error code mapped to the error message.
@@ -837,6 +850,7 @@ components:
type: integer
type: object
TestNotificationConfigurationRequest:
additionalProperties: false
properties:
eventTypes:
description: 'The event types to test. If left blank, then all of the configured
@@ -885,6 +899,7 @@ components:
- notificationId
type: object
TestNotificationConfigurationResponse:
additionalProperties: false
properties:
errorMessages:
description: Any error messages encountered.
@@ -960,6 +975,7 @@ components:
- notificationId
type: object
UpdateNotificationConfigurationRequest:
additionalProperties: false
properties:
configurationDetails:
description: Details of the notification subscription configuration to be