@adyen/api-library
Version:
The Adyen API Library for NodeJS enables you to work with Adyen APIs.
1,225 lines • 70.4 kB
TypeScript
declare namespace IMarketPayNotifications {
interface AccountCloseNotification {
/**
* The details of the Account update.
*/
content: IMarketPayNotifications.CloseAccountResponse;
/**
* Error information of failed request. No value provided here if no error occurred on processing.
*/
error?: IMarketPayNotifications.NotificationErrorContainer;
/**
* The date and time when an event has been completed.
*/
eventDate: string;
/**
* The event type of the notification.
*/
eventType: string;
/**
* The user or process that has triggered the notification.
*/
executingUserKey: string;
/**
* Indicates whether the notification originated from the live environment or the test environment. If true, the notification originated from the live environment. If false, the notification originated from the test environment.
*/
live: boolean;
/**
* The PSP reference of the request from which the notification originates.
*/
pspReference: string;
}
interface AccountCreateNotification {
/**
* The details of the account creation.
*/
content: IMarketPayNotifications.CreateAccountResponse;
/**
* Error information of failed request. No value provided here if no error occurred on processing.
*/
error?: IMarketPayNotifications.NotificationErrorContainer;
/**
* The date and time when an event has been completed.
*/
eventDate: string;
/**
* The event type of the notification.
*/
eventType: string;
/**
* The user or process that has triggered the notification.
*/
executingUserKey: string;
/**
* Indicates whether the notification originated from the live environment or the test environment. If true, the notification originated from the live environment. If false, the notification originated from the test environment.
*/
live: boolean;
/**
* The PSP reference of the request from which the notification originates.
*/
pspReference: string;
}
interface AccountEvent {
/**
* The event.
* >Permitted values: `InactivateAccount`, `RefundNotPaidOutTransfers`.
* For more information, refer to [Verification checks](https://docs.adyen.com/marketpay/onboarding-and-verification/verification-checks).
*/
event: "InactivateAccount" | "RefundNotPaidOutTransfers";
/**
* The date on which the event will take place.
*/
executionDate: string;
/**
* The reason why this event has been created.
*/
reason: string;
}
interface AccountHolderCreateNotification {
/**
* The details of the account holder creation.
*/
content: IMarketPayNotifications.CreateAccountHolderResponse;
/**
* Error information of failed request. No value provided here if no error occurred on processing.
*/
error?: IMarketPayNotifications.NotificationErrorContainer;
/**
* The date and time when an event has been completed.
*/
eventDate: string;
/**
* The event type of the notification.
*/
eventType: string;
/**
* The user or process that has triggered the notification.
*/
executingUserKey: string;
/**
* Indicates whether the notification originated from the live environment or the test environment. If true, the notification originated from the live environment. If false, the notification originated from the test environment.
*/
live: boolean;
/**
* The PSP reference of the request from which the notification originates.
*/
pspReference: string;
}
interface AccountHolderDetails {
/**
* The address of the account holder.
*/
address?: IMarketPayNotifications.ViasAddress;
/**
* Each of the bank accounts associated with the account holder.
* > Each array entry should represent one bank account.
* > For comprehensive detail regarding the required `BankAccountDetail` fields, please refer to the [KYC Verification documentation](https://docs.adyen.com/marketpay/onboarding-and-verification/verification-checks).
*/
bankAccountDetails?: IMarketPayNotifications.BankAccountDetail[];
/**
* Details applicable to `Business` legal entities.
* Populated only if the account holder's legal entity is of type `Business`.
* > Required when being used in a `/createAccountHolder` request in which the legal entity is `Business`.
*/
businessDetails?: IMarketPayNotifications.BusinessDetails;
/**
* The email address of the account holder.
*/
email: string;
/**
* The phone number of the account holder provided as a single string. It will be handled as a landline phone.
* **Examples:** "0031 6 11 22 33 44", "+316/1122-3344", "(0031) 611223344"
*/
fullPhoneNumber: string;
/**
* Details applicable to `Individual` legal entities.
* Populated only if the account holder's legal entity is of type `Individual`.
* > Required when being used in a `/createAccountHolder` request in which the legal entity is `Individual`.
*/
individualDetails?: IMarketPayNotifications.IndividualDetails;
/**
* The Merchant Category Code of the account holder.
* > If not specified in the request, this will be derived from the platform account (which is configured by Adyen).
*/
merchantCategoryCode?: string;
/**
* A set of key and value pairs for general use by the account holder or merchant.
* The keys do not have specific names and may be used for storing miscellaneous data as desired.
* > The values being stored have a maximum length of eighty (80) characters and will be truncated if necessary.
* > Note that during an update of metadata, the omission of existing key-value pairs will result in the deletion of those key-value pairs.
*/
metadata?: {};
/**
* Each of the card tokens associated with the account holder.
* > Each array entry should represent one card token.
* > For comprehensive detail regarding the required `CardToken` fields, please refer to the [KYC Verification documentation](https://docs.adyen.com/marketpay/onboarding-and-verification/verification-checks).
*/
payoutMethods?: IMarketPayNotifications.PayoutMethod[];
/**
* The URL of the website of the account holder.
*/
webAddress: string;
}
interface AccountHolderPayoutNotification {
/**
* Details of the payout to the Account Holder.
*/
content: IMarketPayNotifications.AccountHolderPayoutNotificationContent;
/**
* Error information of failed request. No value provided here if no error occurred on processing.
*/
error?: IMarketPayNotifications.NotificationErrorContainer;
/**
* The date and time when an event has been completed.
*/
eventDate: string;
/**
* The event type of the notification.
*/
eventType: string;
/**
* The user or process that has triggered the notification.
*/
executingUserKey: string;
/**
* Indicates whether the notification originated from the live environment or the test environment. If true, the notification originated from the live environment. If false, the notification originated from the test environment.
*/
live: boolean;
/**
* The PSP reference of the request from which the notification originates.
*/
pspReference: string;
}
interface AccountHolderPayoutNotificationContent {
/**
* The code of the account from which the payout was made.
*/
accountCode: string;
/**
* The code of the Account Holder to which the payout was made.
*/
accountHolderCode: string;
/**
* payout amount
*/
amount?: IMarketPayNotifications.Amount;
/**
* payout amounts (per currency)
*/
amounts?: IMarketPayNotifications.Amount[];
/**
* Details of the Bank Account to which the payout was made.
*/
bankAccountDetail?: IMarketPayNotifications.BankAccountDetail;
/**
* A description of the payout.
*/
description?: string;
/**
* The estimated date of arrival.
*/
estimatedArrivalDate?: IMarketPayNotifications.LocalDate;
/**
* Invalid fields list.
*/
invalidFields?: IMarketPayNotifications.ErrorFieldType[];
/**
* merchant reference
*/
merchantReference?: string;
/**
* payout status
*/
status?: IMarketPayNotifications.OperationStatus;
}
interface AccountHolderStatus {
/**
* A list of events scheduled for the account holder.
*/
events: IMarketPayNotifications.AccountEvent[];
/**
* The payout state of the account holder.
*/
payoutState: IMarketPayNotifications.AccountPayoutState;
/**
* The processing state of the account holder.
*/
processingState: IMarketPayNotifications.AccountProcessingState;
/**
* The status of the account holder.
* >Permitted values: `Active`, `Inactive`, `Suspended`, `Closed`.
*/
status: "Active" | "Closed" | "Inactive" | "Suspended";
/**
* The reason why the status was assigned to the account holder.
*/
statusReason: string;
}
interface AccountHolderStatusChangeNotification {
/**
* The details of the Account Holder status change.
*/
content?: IMarketPayNotifications.AccountHolderStatusChangeNotificationContent;
/**
* Error information of failed request. No value provided here if no error occurred on processing.
*/
error?: IMarketPayNotifications.NotificationErrorContainer;
/**
* The date and time when an event has been completed.
*/
eventDate: string;
/**
* The event type of the notification.
*/
eventType: string;
/**
* The user or process that has triggered the notification.
*/
executingUserKey: string;
/**
* Indicates whether the notification originated from the live environment or the test environment. If true, the notification originated from the live environment. If false, the notification originated from the test environment.
*/
live: boolean;
/**
* The PSP reference of the request from which the notification originates.
*/
pspReference: string;
}
interface AccountHolderStatusChangeNotificationContent {
/**
* The code of the account holder.
*/
accountHolderCode: string;
/**
* in case the account holder has not been updated, contains account holder fields, that did not pass the validation.
*/
invalidFields?: IMarketPayNotifications.ErrorFieldType[];
/**
* The new status of the account holder.
*/
newStatus: IMarketPayNotifications.AccountHolderStatus;
/**
* The former status of the account holder.
*/
oldStatus: IMarketPayNotifications.AccountHolderStatus;
/**
* The reason for the status change.
*/
reason: string;
}
interface AccountHolderStoreStatusChangeNotification {
/**
* The details of the Account Holder Store status change.
*/
content?: IMarketPayNotifications.AccountHolderStoreStatusChangeNotificationContent;
/**
* Error information of failed request. No value provided here if no error occurred on processing.
*/
error?: IMarketPayNotifications.NotificationErrorContainer;
/**
* The date and time when an event has been completed.
*/
eventDate: string;
/**
* The event type of the notification.
*/
eventType: string;
/**
* The user or process that has triggered the notification.
*/
executingUserKey: string;
/**
* Indicates whether the notification originated from the live environment or the test environment. If true, the notification originated from the live environment. If false, the notification originated from the test environment.
*/
live: boolean;
/**
* The PSP reference of the request from which the notification originates.
*/
pspReference: string;
}
interface AccountHolderStoreStatusChangeNotificationContent {
/**
* The code of the account holder.
*/
accountHolderCode: string;
/**
* In case the store status has not been updated, contains fields that did not pass the validation.
*/
invalidFields?: IMarketPayNotifications.ErrorFieldType[];
/**
* The new status of the account holder.
*/
newStatus: "Active" | "Closed" | "Inactive" | "InactiveWithModifications" | "Pending";
/**
* The former status of the account holder.
*/
oldStatus: "Active" | "Closed" | "Inactive" | "InactiveWithModifications" | "Pending";
/**
* The reason for the status change.
*/
reason: string;
/**
* Alphanumeric identifier of the store.
*/
store: string;
/**
* Store store reference.
*/
storeReference: string;
}
interface AccountHolderUpcomingDeadlineNotification {
/**
* The details of the upcoming event.
*/
content?: IMarketPayNotifications.AccountHolderUpcomingDeadlineNotificationContent;
/**
* Error information of failed request. No value provided here if no error occurred on processing.
*/
error?: IMarketPayNotifications.NotificationErrorContainer;
/**
* The date and time when an event has been completed.
*/
eventDate: string;
/**
* The event type of the notification.
*/
eventType: string;
/**
* The user or process that has triggered the notification.
*/
executingUserKey: string;
/**
* Indicates whether the notification originated from the live environment or the test environment. If true, the notification originated from the live environment. If false, the notification originated from the test environment.
*/
live: boolean;
/**
* The PSP reference of the request from which the notification originates.
*/
pspReference: string;
}
interface AccountHolderUpcomingDeadlineNotificationContent {
/**
* The code of the account holder whom the event refers to.
*/
accountHolderCode?: string;
/**
* The event name that will be trigger if no action is taken.
*/
event?: "AccessPii" | "CloseAccount" | "CloseStores" | "DeleteBankAccounts" | "DeletePayoutInstrumentTokens" | "DeletePayoutMethods" | "DeleteShareholders" | "InactivateAccount" | "RecalculateAccountStatusAndProcessingTier" | "RefundNotPaidOutTransfers" | "ResolveEvents" | "SaveAccountHolder" | "SaveKYCCheckStatus" | "SuspendAccount" | "UnSuspendAccount" | "UpdateAccountHolderState" | "Verification";
/**
* The execution date scheduled for the event.
*/
executionDate?: IMarketPayNotifications.LocalDate;
/**
* The reason that leads to scheduling of the event.
*/
reason?: string;
}
interface AccountHolderUpdateNotification {
/**
* The details of the Account Holder update.
*/
content: IMarketPayNotifications.UpdateAccountHolderResponse;
/**
* Error information of failed request. No value provided here if no error occurred on processing.
*/
error?: IMarketPayNotifications.NotificationErrorContainer;
/**
* The date and time when an event has been completed.
*/
eventDate: string;
/**
* The event type of the notification.
*/
eventType: string;
/**
* The user or process that has triggered the notification.
*/
executingUserKey: string;
/**
* Indicates whether the notification originated from the live environment or the test environment. If true, the notification originated from the live environment. If false, the notification originated from the test environment.
*/
live: boolean;
/**
* The PSP reference of the request from which the notification originates.
*/
pspReference: string;
}
interface AccountHolderVerificationNotification {
/**
* The details of the Account Holder verification.
*/
content: IMarketPayNotifications.AccountHolderVerificationNotificationContent;
/**
* Error information of failed request. No value provided here if no error occurred on processing.
*/
error?: IMarketPayNotifications.NotificationErrorContainer;
/**
* The date and time when an event has been completed.
*/
eventDate: string;
/**
* The event type of the notification.
*/
eventType: string;
/**
* The user or process that has triggered the notification.
*/
executingUserKey: string;
/**
* Indicates whether the notification originated from the live environment or the test environment. If true, the notification originated from the live environment. If false, the notification originated from the test environment.
*/
live: boolean;
/**
* The PSP reference of the request from which the notification originates.
*/
pspReference: string;
}
interface AccountHolderVerificationNotificationContent {
/**
* The code of the account holder.
*/
accountHolderCode: string;
/**
* The unique ID of the bank account that has been verified.
*/
bankAccountUUID?: string;
/**
* Information on the verification status
*/
kycCheckStatusData?: IMarketPayNotifications.KYCCheckStatusData;
/**
* The code of the shareholder that has been verified.
*/
shareholderCode?: string;
}
interface AccountPayoutState {
/**
* 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.
*/
allowPayout: boolean;
/**
* The reason why payouts (to all of the account holder's accounts) have been disabled (by the platform). If the `disabled` field is true, this field can be used to explain why.
*/
disableReason: string;
/**
* Indicates whether payouts have been disabled (by the platform) for all of the account holder's accounts. A platform may enable and disable this field at their discretion. If this field is true, `allowPayout` will be false and no payouts will be permitted for any of the account holder's accounts. If this field is false, `allowPayout` may or may not be enabled, depending on other factors.
*/
disabled: boolean;
/**
* The reason why payouts (to all of the account holder's accounts) have been disabled (by Adyen). If payouts have been disabled by Adyen, this field will explain why. If this field is blank, payouts have not been disabled by Adyen.
*/
notAllowedReason: string;
/**
* The maximum amount that payouts are limited to. Only applies if payouts are allowed but limited.
*/
payoutLimit: IMarketPayNotifications.Amount;
/**
* The payout tier that the account holder occupies.
*/
tierNumber: number;
}
interface AccountProcessingState {
/**
* The reason why processing has been disabled.
*/
disableReason: string;
/**
* Indicates whether the processing of payments is allowed.
*/
disabled: boolean;
/**
* The lower bound of the processing tier (i.e., an account holder must have processed at least this amount of money in order to be placed into this tier).
*/
processedFrom: IMarketPayNotifications.Amount;
/**
* The upper bound of the processing tier (i.e., an account holder must have processed less than this amount of money in order to be placed into this tier).
*/
processedTo: IMarketPayNotifications.Amount;
/**
* The processing tier that the account holder occupies.
*/
tierNumber: number;
}
interface AccountUpdateNotification {
/**
* The details of the Account update.
*/
content: IMarketPayNotifications.UpdateAccountResponse;
/**
* Error information of failed request. No value provided here if no error occurred on processing.
*/
error?: IMarketPayNotifications.NotificationErrorContainer;
/**
* The date and time when an event has been completed.
*/
eventDate: string;
/**
* The event type of the notification.
*/
eventType: string;
/**
* The user or process that has triggered the notification.
*/
executingUserKey: string;
/**
* Indicates whether the notification originated from the live environment or the test environment. If true, the notification originated from the live environment. If false, the notification originated from the test environment.
*/
live: boolean;
/**
* The PSP reference of the request from which the notification originates.
*/
pspReference: string;
}
interface Amount {
/**
* The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes).
*/
currency: string;
/**
* The payable amount that can be charged for the transaction.
*
* The transaction amount needs to be represented in minor units according to the [following table](https://docs.adyen.com/development-resources/currency-codes).
*/
value: number;
}
interface BankAccountDetail {
/**
* The bank account number (without separators).
* >Refer to the [Onboarding and verification](https://docs.adyen.com/marketpay/onboarding-and-verification) section for details on field requirements.
*/
accountNumber?: string;
/**
* The type of bank account.
* Only applicable to bank accounts held in the USA.
* The permitted values are: `checking`, `savings`.
*
* >Refer to the [Onboarding and verification](https://docs.adyen.com/marketpay/onboarding-and-verification) section for details on field requirements.
*/
accountType?: string;
/**
* The name of the bank account.
*/
bankAccountName?: string;
/**
* Merchant reference to the bank account.
*/
bankAccountReference?: string;
/**
* The unique identifier (UUID) of the Bank Account.
* >If, during an account holder create or update request, this field is left blank (but other fields provided), a new Bank Account will be created with a procedurally-generated UUID.
*
* >If, during an account holder create request, a UUID is provided, the creation of the Bank Account will fail while the creation of the account holder will continue.
*
* >If, during an account holder update request, a UUID that is not correlated with an existing Bank Account is provided, the update of the account holder will fail.
*
* >If, during an account holder update request, a UUID that is correlated with an existing Bank Account is provided, the existing Bank Account will be updated.
*
*/
bankAccountUUID?: string;
/**
* The bank identifier code.
* >Refer to the [Onboarding and verification](https://docs.adyen.com/marketpay/onboarding-and-verification) section for details on field requirements.
*/
bankBicSwift?: string;
/**
* The city in which the bank branch is located.
*
* >Refer to the [Onboarding and verification](https://docs.adyen.com/marketpay/onboarding-and-verification) section for details on field requirements.
*/
bankCity?: string;
/**
* The bank code of the banking institution with which the bank account is registered.
*
* >Refer to the [Onboarding and verification](https://docs.adyen.com/marketpay/onboarding-and-verification) section for details on field requirements.
*/
bankCode?: string;
/**
* The name of the banking institution with which the bank account is held.
*
* >Refer to the [Onboarding and verification](https://docs.adyen.com/marketpay/onboarding-and-verification) section for details on field requirements.
*/
bankName?: string;
/**
* The branch code of the branch under which the bank account is registered. The value to be specified in this parameter depends on the country of the bank account:
* * United States - Routing number
* * United Kingdom - Sort code
* * Germany - Bankleitzahl
* >Refer to the [Onboarding and verification](https://docs.adyen.com/marketpay/onboarding-and-verification) section for details on field requirements.
*/
branchCode?: string;
/**
* The check code of the bank account.
*
* >Refer to the [Onboarding and verification](https://docs.adyen.com/marketpay/onboarding-and-verification) section for details on field requirements.
*/
checkCode?: string;
/**
* The two-letter country code in which the bank account is registered.
* >The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL').
*
* >Refer to the [Onboarding and verification](https://docs.adyen.com/marketpay/onboarding-and-verification) section for details on field requirements.
*/
countryCode?: string;
/**
* The currency in which the bank account deals.
* >The permitted currency codes are defined in ISO-4217 (e.g. 'EUR').
*
* >Refer to the [Onboarding and verification](https://docs.adyen.com/marketpay/onboarding-and-verification) section for details on field requirements.
*/
currencyCode?: string;
/**
* The international bank account number.
* >The IBAN standard is defined in ISO-13616.
*
* >Refer to the [Onboarding and verification](https://docs.adyen.com/marketpay/onboarding-and-verification) section for details on field requirements.
*/
iban?: string;
/**
* The city of residence of the bank account owner.
* >Refer to the [Onboarding and verification](https://docs.adyen.com/marketpay/onboarding-and-verification) section for details on field requirements.
*/
ownerCity?: string;
/**
* The country code of the country of residence of the bank account owner.
* >The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL').
*
* >Refer to the [Onboarding and verification](https://docs.adyen.com/marketpay/onboarding-and-verification) section for details on field requirements.
*/
ownerCountryCode?: string;
/**
* The date of birth of the bank account owner.
*
*/
ownerDateOfBirth?: string;
/**
* The house name or number of the residence of the bank account owner.
* >Refer to the [Onboarding and verification](https://docs.adyen.com/marketpay/onboarding-and-verification) section for details on field requirements.
*/
ownerHouseNumberOrName?: string;
/**
* The name of the bank account owner.
* >Refer to the [Onboarding and verification](https://docs.adyen.com/marketpay/onboarding-and-verification) section for details on field requirements.
*/
ownerName?: string;
/**
* The country code of the country of nationality of the bank account owner.
* >The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL').
*
* >Refer to the [Onboarding and verification](https://docs.adyen.com/marketpay/onboarding-and-verification) section for details on field requirements.
*/
ownerNationality?: string;
/**
* The postal code of the residence of the bank account owner.
* >Refer to the [Onboarding and verification](https://docs.adyen.com/marketpay/onboarding-and-verification) section for details on field requirements.
*/
ownerPostalCode?: string;
/**
* The state of residence of the bank account owner.
* >Refer to the [Onboarding and verification](https://docs.adyen.com/marketpay/onboarding-and-verification) section for details on field requirements.
*/
ownerState?: string;
/**
* The street name of the residence of the bank account owner.
* >Refer to the [Onboarding and verification](https://docs.adyen.com/marketpay/onboarding-and-verification) section for details on field requirements.
*/
ownerStreet?: string;
/**
* If set to true, the bank account is a primary account.
*/
primaryAccount?: boolean;
/**
* The tax ID number.
*
* >Refer to the [Onboarding and verification](https://docs.adyen.com/marketpay/onboarding-and-verification) section for details on field requirements.
*/
taxId?: string;
/**
* The URL to be used for bank account verification.
* This may be generated on bank account creation.
*
* >Refer to the [Onboarding and verification](https://docs.adyen.com/marketpay/onboarding-and-verification) section for details on field requirements.
*/
urlForVerification?: string;
}
interface BeneficiarySetupNotification {
/**
* Details of the beneficiary setup.
*/
content: IMarketPayNotifications.BeneficiarySetupNotificationContent;
/**
* Error information of failed request. No value provided here if no error occurred on processing.
*/
error?: IMarketPayNotifications.NotificationErrorContainer;
/**
* The date and time when an event has been completed.
*/
eventDate: string;
/**
* The event type of the notification.
*/
eventType: string;
/**
* The user or process that has triggered the notification.
*/
executingUserKey: string;
/**
* Indicates whether the notification originated from the live environment or the test environment. If true, the notification originated from the live environment. If false, the notification originated from the test environment.
*/
live: boolean;
/**
* The PSP reference of the request from which the notification originates.
*/
pspReference: string;
}
interface BeneficiarySetupNotificationContent {
/**
* The code of the beneficiary account.
*/
destinationAccountCode: string;
/**
* The code of the beneficiary Account Holder.
*/
destinationAccountHolderCode: string;
/**
* A listing of the invalid fields which have caused the Setup Beneficiary request to fail. If this is empty, the Setup Beneficiary request has succeeded.
*/
invalidFields?: IMarketPayNotifications.ErrorFieldType[];
/**
* The reference provided by the merchant.
*/
merchantReference?: string;
/**
* The code of the benefactor account.
*/
sourceAccountCode: string;
/**
* The code of the benefactor Account Holder.
*/
sourceAccountHolderCode: string;
/**
* The date on which the beneficiary was set up and funds transferred from benefactor to beneficiary.
*/
transferDate: string;
}
interface BusinessDetails {
/**
* The registered name of the company (if it differs from the legal name of the company).
*/
doingBusinessAs?: string;
/**
* The jurisdiction of incorporation of the company.
* >Two (2) characters for a business in the USA or Canada, or a maximum of three (3) characters for an address in all other countries, or 'FEDERAL'
*/
incorporatedAt?: string;
/**
* The legal name of the company.
*/
legalBusinessName?: string;
/**
* The registration number of the company.
*/
registrationNumber?: string;
/**
* Each of the shareholders associated with the company.
* Each array entry should represent one shareholder.
*/
shareholders?: IMarketPayNotifications.ShareholderContact[];
/**
* The tax ID of the company.
*/
taxId?: string;
}
interface CloseAccountResponse {
/**
* Contains field validation errors that would prevent requests from being processed.
*/
invalidFields?: IMarketPayNotifications.ErrorFieldType[];
/**
* The reference of a request. Can be used to uniquely identify the request.
*/
pspReference: string;
/**
* The result code.
*/
resultCode?: string;
/**
* The new status of the account.
* >Permitted values: `Active`, `Inactive`, `Suspended`, `Closed`.
*/
status: "Active" | "Closed" | "Inactive" | "Suspended";
}
interface CompensateNegativeBalanceNotification {
/**
* Details of the negative balance compensation.
*/
content?: IMarketPayNotifications.CompensateNegativeBalanceNotificationContent;
/**
* Error information of failed request. No value provided here if no error occurred on processing.
*/
error?: IMarketPayNotifications.NotificationErrorContainer;
/**
* The date and time when an event has been completed.
*/
eventDate: string;
/**
* The event type of the notification.
*/
eventType: string;
/**
* The user or process that has triggered the notification.
*/
executingUserKey: string;
/**
* Indicates whether the notification originated from the live environment or the test environment. If true, the notification originated from the live environment. If false, the notification originated from the test environment.
*/
live: boolean;
/**
* The PSP reference of the request from which the notification originates.
*/
pspReference: string;
}
interface CompensateNegativeBalanceNotificationContent {
/**
* A list of the negative balances compensated.
*/
records: IMarketPayNotifications.CompensateNegativeBalanceNotificationRecord[];
}
interface CompensateNegativeBalanceNotificationRecord {
/**
* The code of the account whose negative balance has been compensated.
*/
accountCode: string;
/**
* The amount compensated.
*/
amount: IMarketPayNotifications.Amount;
/**
* The date on which the compensation took place.
*/
transferDate: string;
}
interface CreateAccountHolderResponse {
/**
* The code of a new account created for the account holder.
*/
accountCode?: string;
/**
* The code of the new account holder.
*/
accountHolderCode: string;
/**
* Details of the new account holder.
*/
accountHolderDetails: IMarketPayNotifications.AccountHolderDetails;
/**
* The status of the new account holder.
*/
accountHolderStatus: IMarketPayNotifications.AccountHolderStatus;
/**
* The description of the new account holder.
*/
description?: string;
/**
* A list of fields that caused the `/createAccountHolder` request to fail.
*/
invalidFields?: IMarketPayNotifications.ErrorFieldType[];
/**
* The type of legal entity of the new account holder.
*/
legalEntity: "Business" | "Individual" | "NonProfit" | "PublicCompany";
/**
* The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes), with which the prospective account holder primarily deals.
*/
primaryCurrency?: string;
/**
* The reference of a request. Can be used to uniquely identify the request.
*/
pspReference: string;
/**
* The result code.
*/
resultCode?: string;
/**
* The details of KYC Verification of the account holder.
*/
verification: IMarketPayNotifications.KYCVerificationResult;
}
interface CreateAccountResponse {
/**
* The code of the new account.
*/
accountCode: string;
/**
* The code of the account holder.
*/
accountHolderCode: string;
/**
* The description of the account.
*/
description?: string;
/**
* A list of fields that caused the `/createAccount` request to fail.
*/
invalidFields?: IMarketPayNotifications.ErrorFieldType[];
metadata?: {
[name: string]: string;
};
/**
* The payout schedule of the account.
*/
payoutSchedule?: IMarketPayNotifications.PayoutScheduleResponse;
/**
* The reference of a request. Can be used to uniquely identify the request.
*/
pspReference: string;
/**
* The result code.
*/
resultCode?: string;
/**
* The status of the account.
* >Permitted values: `Active`.
*/
status: "Active" | "Closed" | "Inactive" | "Suspended";
}
interface DirectDebitInitiatedNotification {
/**
* Details of the direct debit.
*/
content?: IMarketPayNotifications.DirectDebitInitiatedNotificationContent;
/**
* Error information of failed request. No value provided here if no error occurred on processing.
*/
error?: IMarketPayNotifications.NotificationErrorContainer;
/**
* The date and time when an event has been completed.
*/
eventDate: string;
/**
* The event type of the notification.
*/
eventType: string;
/**
* The user or process that has triggered the notification.
*/
executingUserKey: string;
/**
* Indicates whether the notification originated from the live environment or the test environment. If true, the notification originated from the live environment. If false, the notification originated from the test environment.
*/
live: boolean;
/**
* The PSP reference of the request from which the notification originates.
*/
pspReference: string;
}
interface DirectDebitInitiatedNotificationContent {
/**
* The code of the account.
*/
accountCode: string;
/**
* The amount to be debited from the funding account.
*/
amount: IMarketPayNotifications.Amount;
/**
* The date of the debit initiation.
*/
debitInitiationDate?: IMarketPayNotifications.LocalDate;
/**
* The code of the merchant account.
*/
merchantAccountCode: string;
/**
* Direct debit status.
*/
status?: IMarketPayNotifications.OperationStatus;
}
interface ErrorFieldType {
/**
* The validation error code.
*/
errorCode?: number;
/**
* A description of the validation error.
*/
errorDescription?: string;
/**
* The type of error field.
*/
fieldType?: IMarketPayNotifications.FieldType;
}
interface FieldType {
/**
* The full name of the property.
*/
field?: string;
/**
* The type of the field.
*/
fieldName?: "accountCode" | "accountHolderCode" | "accountHolderDetails" | "accountNumber" | "accountStateType" | "accountStatus" | "accountType" | "address" | "bankAccount" | "bankAccountCode" | "bankAccountName" | "bankAccountUUID" | "bankBicSwift" | "bankCity" | "bankCode" | "bankName" | "bankStatement" | "branchCode" | "businessContact" | "cardToken" | "checkCode" | "city" | "country" | "countryCode" | "currency" | "currencyCode" | "dateOfBirth" | "description" | "destinationAccountCode" | "document" | "documentExpirationDate" | "documentIssuerCountry" | "documentIssuerState" | "documentName" | "documentNumber" | "documentType" | "doingBusinessAs" | "drivingLicence" | "drivingLicenceBack" | "drivingLicense" | "email" | "firstName" | "fullPhoneNumber" | "gender" | "hopWebserviceUser" | "houseNumberOrName" | "iban" | "idCard" | "idCardBack" | "idCardFront" | "idNumber" | "identityDocument" | "incorporatedAt" | "individualDetails" | "lastName" | "legalBusinessName" | "legalEntity" | "legalEntityType" | "merchantAccount" | "merchantCategoryCode" | "merchantReference" | "microDeposit" | "name" | "nationality" | "originalReference" | "ownerCity" | "ownerCountryCode" | "ownerHouseNumberOrName" | "ownerName" | "ownerPostalCode" | "ownerState" | "ownerStreet" | "passport" | "passportNumber" | "payoutMethodCode" | "personalData" | "phoneCountryCode" | "phoneNumber" | "postalCode" | "primaryCurrency" | "reason" | "registrationNumber" | "returnUrl" | "schedule" | "shareholder" | "shareholderCode" | "socialSecurityNumber" | "sourceAccountCode" | "stateOrProvince" | "status" | "store" | "storeDetail" | "storeReference" | "street" | "taxId" | "tier" | "tierNumber" | "transferCode" | "unknown" | "value" | "virtualAccount" | "visaNumber" | "webAddress";
/**
* The code of the shareholder that the field belongs to. If empty, the field belongs to an account holder.
*/
shareholderCode?: string;
}
interface IndividualDetails {
/**
* The name of the individual.
* >Make sure your account holder registers using the name shown on their Photo ID.
*/
name?: IMarketPayNotifications.ViasName;
/**
* Personal information of the individual.
*/
personalData?: IMarketPayNotifications.ViasPersonalData;
}
interface KYCBankAccountCheckResult {
/**
* The unique ID of the bank account to which the check applies.
*/
bankAccountUUID: string;
/**
* A list of the checks and their statuses.
*/
checks: IMarketPayNotifications.KYCCheckStatusData[];
}
interface KYCCheckResult {
/**
* A list of the checks and their statuses.
*/
checks: IMarketPayNotifications.KYCCheckStatusData[];
}
interface KYCCheckStatusData {
/**
* A list of the fields required for execution of the check.
*/
requiredFields: string[];
/**
* The status of the check.
* >Permitted Values: `UNCHECKED`, `DATA_PROVIDED`, `PASSED`, `PENDING`, `AWAITING_DATA`, `RETRY_LIMIT_REACHED`, `INVALID_DATA`, `FAILED`.
*/
status: "AWAITING_DATA" | "DATA_PROVIDED" | "FAILED" | "INVALID_DATA" | "PASSED" | "PENDING" | "PENDING_REVIEW" | "RETRY_LIMIT_REACHED" | "UNCHECKED";
/**
* A summary of the execution of the check.
*/
summary: IMarketPayNotifications.KYCCheckSummary;
/**
* The type of check.
* >Permitted Values: `COMPANY_VERIFICATION`, `IDENTITY_VERIFICATION`, `PASSPORT_VERIFICATION`, `BANK_ACCOUNT_VERIFICATION`, `NONPROFIT_VERIFICATION`.
*/
type: "BANK_ACCOUNT_VERIFICATION" | "COMPANY_VERIFICATION" | "IDENTITY_VERIFICATION" | "NONPROFIT_VERIFICATION" | "PASSPORT_VERIFICATION";
}
interface KYCCheckSummary {
/**
* The code of the check.
*/
kycCheckCode?: number;
/**
* A description of the check.
*/
kycCheckDescription?: string;
}
interface KYCShareholderCheckResult {
/**
* A list of the checks and their statuses.
*/
checks: IMarketPayNotifications.KYCCheckStatusData[];
/**
* The code of the shareholder to which the check applies.
*/
shareholderCode: string;
}
interface KYCVerificationResult {
/**
* The result(s) of the checks on the account holder.
*/
accountHolder: IMarketPayNotifications.KYCCheckResult;
/**
* The result(s) of the checks on the bank account(s).
*/
bankAccounts: IMarketPayNotifications.KYCBankAccountCheckResult[];
/**
* The result(s) of the checks on the shareholder(s).
*/
shareholders: IMarketPayNotifications.KYCShareholderCheckResult[];
}
interface LocalDate {
month?: number;
year?: number;
}
interface Message {
/**
* The message code.
*/
code?: string;
/**
* The message text.
*/
text?: string;
}
interface NotificationErrorContainer {
/**
* The Adyen code that is mapped to the error message.
*/
errorCode?: string;
/**
* A short explanation of the issue.
*/
message?: string;
}
interface NotificationResponse {
/**
* Set this property to **[accepted]** to acknowledge that you received a notification from Adyen.
*/
notificationResponse: string;
}
interface OperationStatus {
/**
* The message regarding the operation status.
*/
message?: IMarketPayNotifications.Message;
/**
* The status code.
*/
statusCode?: string;
}
interface PaymentFailureNotification {
/**
* The details of the payment failure.
*/
content: IMarketPayNotifications.PaymentFailureNotificationContent;
/**
* Error information of failed request. No value provided here if no error occurred on processing.
*/
error?: IMarketPayNotifications.NotificationErrorContainer;
/**
* The date and time when an event has been completed.
*/
eventDate: string;
/**
* The event type of the notification.
*/
eventType: string;
/**
* The user or process that has triggered the notification.
*/
executingUserKey: string;
/**
* Indicates whether the notification originated from the live environment or the test environment. If true, the notification originated from the live environment. If false, the notification originated from the test environment.
*/
live: boolean;
/**
* The PSP reference of the request from which the notification originates.
*/
pspReference: string;
}
interface PaymentFailureNotificationContent {
/**
* Missing or invalid fields that caused the payment error.
*/
errorFields: IMarketPayNotifications.ErrorFieldType[];
/**
* The error message.
*/
errorMessage: IMarketPayNotifications.Message