Account

To communicate with the Adyen API you should submit HTTP POST requests to corresponding endpoints. These endpoints differ for test and live accounts, and also depend on the data format (SOAP, JSON, or FORM) you use to submit data to the Adyen payments platform.

This document lists all endpoints available for you to integrate with the test platform and run QA checks.

Endpoints

SOAP

For the SOAP messaging protocol, all test payment requests must be posted to the following endpoints:

The data schemas for corresponding SOAP objects are available at:

JSON and FORM

This is an overview of the test URL endpoints to communicate with our API using JSON or FORM (key-value parameters passed in an Http POST URL).

After you are ready to go live, you should switch to either generic or custom live endpoints. For more information, refer to Live endpoints.

AccountEvent

This object contains information on the event planned for an account holder.

Field Type Required Description
event Enum (tick)

Possible values:

  • InactivateAccount
  • RefundNotPaidOutTransfers

For more information, refer to Verification process.

executionDate String (tick) The date on which the event should happen.
reason String (tick) A message explaining why this event has been created.
resolvedByStateType String (tick)

DEPRECATED This field is obsolete and has been removed in v2. 

The type of a state, which should be reached by an account holder to resolve this event before the executionDate.

AccountHolderDetails

This object contains detailed information on the account holder.

Field Type Required Description
address Address (error) An account holder's address.
bankAccountDetails Array (error)

This array includes one or more BankAccountDetail objects.

We have bank account validations, which differ per country and currency. See Bank account check to know more.

businessDetails
BusinessDetails (error) Contains detailed information on the business type.
email
String (tick) An account holder's email.
fullPhoneNumber
String (error) Either phoneNumber or fullPhoneNumber has to be provided. The full phone number is a string handled as a landline phoneType (e.g. "0031 6 11 22 33 44", "+316/1122-3344", "(0031) 611223344").
individualDetails IndividualDetails (error)

Individual details of the account holder.

merchantCategoryCode
String (error)

Merchant category code.

If merchantCategoryCode is not specified in the request, then it is derived from the Marketplace (configured by Adyen).

metadata Object (error)

Metadata consists of entries, each of which includes the key and value.

This field takes the following children:

  • Key
  • Value

Limitations:

  • Error "177", "Metadata size exceeds limit"
  Key String (error)

Key for the information to be provided. Example: key = 'storeCountry'

Limitations:

Error "178", "Metadata key size exceeds limit"

  Value String (error)

Information value. Example: value = 'US'

Maximum length: 80 characters, value is truncated to 80 characters with '...' appended to it.

phoneNumber
PhoneNumber (error) Either phoneNumber or fullPhoneNumber should be provided. The phone number length needs to be at least 6 characters long, including the + leading symbol.
webAddress
String (error) A valid URL.

AccountHolderStatus

This object contains detailed information on the account holder's status.

Field Type Required Description
events Array of AccountEvent  (error) A list of events scheduled for this account holder.
payoutState PayoutState (error) The current payout state.
processingState ProcessingState (error) The current processing state.
status Enum (tick)

The current status of the account holder.

Allowed values:

  • Active
  • Inactive
  • Suspended
  • Closed
statusReason String (error) When required, stores a reason explaining why the current status was assigned to the account holder.

AccountState

DEPRECATED This type is obsolete and will be removed in a future version. Use AccountHolderStatus instead.

This object contains detailed information on the account holder's state.

Field Type Required Description
allowPayout Boolean (error) true or false.
allowProcessing Boolean (error) true or false.
disableReason String (error)

Describes why the state has been disabled.

disabled Boolean (error) true or false.
stateDeadline String (error)

Indicates the expiration time for an account holder in a certain state. After this deadline expires the account holder is suspended.

This deadline starts after the account holder has received more than $100 (or equivalent) in donations.

stateLimit Amount (error)

The state limit to be configured on the account holder level.

stateType String (error)

The type of an account holder's state.

Allowed values:

  • LimitedProcessing
  • LimitlessProcessing
  • LimitedPayout
  • LimitlessPayout
  • Processing
  • Payout

State types Processing and Payout are sent/returned only in case of UpdateAccountHolderStateRequest.

For more information on these states, refer to Verification process.

AccountStateLimit

State limit to be configured on account holder level.

Field Type Required Description

amount

String (tick) The amount value.

currency

String (tick) The three-character  ISO currency code.


AccountStateRequirement

This object contains information on the fields to be provided for the account holder to reach a specific state.

Field Type Required Description
requiredFields Array (error)

Properties that need to be provided for the account holder to reach the next processing state.

This array contains the FieldType elements.

state AccountState (error)

The processing state that can be reached if the given properties are provided.

For more information on account holder states, refer to Verification process.

AccountStatus

DEPRECATED This type is obsolete and will be removed in a future version. Use AccountHolderStatus instead.

This object contains information on an account holder's status, its detailed states, as well as planned events.

Field Type Required Description
status Enum (error)

Status of the account holder.

Allowed values:

  • Active
  • Inactive
  • Suspended
  • Closed

For more information on these statuses, refer to Verification process.

states Array (error)

The account holder's states.

Contains elements of the AccountState type.

accountEvents Array (error)

An array of events that are planned for this account holder.

Contains elements of the AccountEvent type.

BankAccountDetail

This object provides fields to hold information on all possible bank account details. Depending on the country of the account holder and the country/currency combination, some of these fields may be required, while others are highly recommended for successful bank account verification. For more information, refer to Bank account check.

Field Type Required Description
accountNumber String (error) The bank account number (without separators).
accountType String (error)

The type of a bank account.

Allowed values:

  • checking
  • savings

This field can be used only for US bank accounts. If it is submitted for a non-US bank account, an error is returned in a response.

bankAccountName String (error) The bank account name.
bankAccountUUID String (error)

The bank account's unique identifier, generated on bank account creation.

bankBicSwift String (error) A unique identifier for a bank, BIC code.
bankCity String (error) The bank city.
bankCode String (error) The bank code.
bankName String (error) The bank name.
branchCode String (error) The branch code.
checkCode String (error) The check code.
countryCode String (error)

Country code where the bank is located.

A valid value is an ISO 2-character country code (e.g. 'NL').

currencyCode String (error) The bank account currency.
iban String (error) IBAN code of the bank account.
ownerCity String (error) The bank account holder's city.
ownerCountryCode String (error) The bank account holder's two-letter country code (ISO 3166-1).
ownerDateOfBirth String (error) The bank account holder's date of birth.
ownerHouseNumberOrName String (error) The bank account holder's house name or number.
ownerName String (tick) Name of the account owner.
ownerNationality String (error) The bank account holder's nationality.
ownerPostalCode String (error) Bank account holder postal code.
ownerState String (error) The bank account holder's state.

ownerStreet

String (error)

Bank account holder street name.

primaryAccount String (error) Indicates if the current bank account is a primary account.
taxId String (error)

Tax identification number.

Mandatory only for BR and MX.

BusinessDetails

This object contains business details of an account holder.

Field Type Required Description
doingBusinessAs String (error) If the registered name of the business differs from the legalBusinessName.
legalBusinessName String (error) The legal name of the business.
shareholders Array (error) If an account holder represents a company, this array includes one or more ShareholderContact objects with information on company shareholders.
taxId String (error) Tax ID of the account holder.

CheckResult

A result of performing a KYC check.

Field Type Required Description
checks Array of CheckStatus (error) Contains all required checks and their status.

CheckStatus

A status of a particular KYC check.

Field Type Required Description
type Enum (tick)

A KYC check type.

Possible values:
  • COMPANY_VERIFICATION
  • IDENTITY_VERIFICATION
  • PASSPORT_VERIFICATION
  • BANK_ACCOUNT_VERIFICATION

For more information, refer to KYC verification.

status Enum (tick)

A KYC check status.

Possible values:
  • PASSED
  • FAILED
  • PENDING
  • INVALID_DATA
  • AWAITING_DATA
  • DATA_PROVIDED
  • RETRY_LIMIT_REACHED

For more information, refer to KYC verification.

summary KYCCheckSummary (error) A summary of performing a KYC check.
requiredFields Array of String (error) Fields that need to be provided for the account holder to pass this KYC check.

CloseAccountHolderRequest

This class contains data that should be passed in the /closeAccountHolder request to close an account holder.

Field
Type
Required
Description
accountHolderCode String (tick)

A code identifying the account holder.

CloseAccountRequest

This class contains data that should be passed in the /closeAccount request to close an account.

Field
Type
Required
Description
accountCode String (tick)

A code of the account to be closed.

CloseAccountResponse

This class contains data that is returned as a response to the /closeAccount request.

Field Type Returned by default Description
pspReference String (tick)

A reference to uniquely identify the request.

status Enum (tick)

Status of the account. Possible values:

  • Closed
submittedAsync Boolean (tick)

Indicates whether the call is processed synchronously or asynchronously.

Depending on your marketplace settings, the following scenarios may be applied:

  • sync – The processing of the request is immediately attempted; it might result in an error if the corresponding service is momentarily unavailable.
  • async – The request is queued and will be executed when the corresponding service is available, in the order the requests are received.
  • asyncOnError – The processing of the request is immediately attempted, but in case the corresponding service is unavailable, the request is scheduled in a queue.

CreateAccountHolderRequest

This class contains data that should be passed in the /createAccountHolder request to create an account holder.

Field Type Required Description
accountHolderCode String (tick)

Account holder code you want to create the account holder with.

It should be between 3-50 characters long, only letters, digits, and dashes (-) are allowed.

accountHolderDetails AccountHolderDetails (tick) Details of the account holder.
legalEntity Enum (tick)

Entity type. Allowed values:

  • Business
  • Individual
metadata Object (error)

Metadata consists of entries, each of which includes the key and value.

This field takes the following children:

  • key
  • value

Limitations:

  • Error "177", "Metadata size exceeds limit"
  key String (error)

Key for the information to be provided. Example: key = 'storeCountry'

Limitations:

Error "178", "Metadata key size exceeds limit"

  value

String

(error)

Information value. Example: value = 'US'

Limitations:

Maximum length: 80 characters, value is truncated to 80 characters with '...' appended to it.

createDefaultAccount Boolean (error)

Creates a default account if set to true.

By default set to true.

processingTier Integer (error)

V3 This object was added in the version 3.

The processing tier, in which the account holder needs to start.

CreateAccountHolderResponse

This class contains data that is returned as a response to a /createAccountHolder request.

Field Type Returned by default Description
pspReference String (tick)

A reference to uniquely identify the request.

accountHolderCode String (tick)

A code identifying the account holder.

accountCode String (error) A code identifying the account (if it has been created for the account holder).
accountHolderDetails AccountHolderDetails (tick)

Details of the created account holder.

accountHolderStatus AccountHolderStatus (tick)

Status of the created account holder.

invalidFields Array (error)

In case the account holder has not been created, contains account holder fields that did not pass the validation.

This array contains the ErrorFieldType elements.

submittedAsync Boolean (tick)

Indicates whether the call is processed synchronously or asynchronously.

Depending on your marketplace settings, the following scenarios may be applied:

  • sync – The processing of the request is immediately attempted; it might result in an error if the corresponding service is momentarily unavailable.
  • async – The request is queued and will be executed when the corresponding service is available, in the order the requests are received.
  • asyncOnError – The processing of the request is immediately attempted, but in case the corresponding service is unavailable, the request is scheduled in a queue.

verification Verification (tick)

KYC verification results. For more information, refer to KYC verification.

CreateAccountRequest

This class contains data that should be passed in the /createAccount request to create an account in the existing account holder.

Field
Type
Required
Description
accountHolderCode String (tick)

A code of the account holder in which a new account should be created.

CreateAccountResponse

This class contains data that is returned as a response to a /createAccount request.

Field Type Returned by default Description
pspReference String (tick)

A reference to uniquely identify the request.

accountHolderCode String (tick) A code identifying the account holder, which owns the created account.
accountCode String (tick) A code identifying the created account.
status Enum (tick)

The current status of the account.

Allowed values:

  • Active
  • Inactive
  • Suspended
  • Closed
submittedAsync Boolean (tick)

Indicates whether the call is processed synchronously or asynchronously.

Depending on your marketplace settings, the following scenarios may be applied:

  • sync – The processing of the request is immediately attempted; it might result in an error if the corresponding service is momentarily unavailable.
  • async – The request is queued and will be executed when the corresponding service is available, in the order the requests are received.
  • asyncOnError – The processing of the request is immediately attempted, but in case the corresponding service is unavailable, the request is scheduled in a queue.

DeleteBankAccountsRequest

This class contains data that should be passed in the /deleteBankAccounts request to delete your bank accounts.

Field Type Required Description

accountHolderCode

String (tick)

A code identifying the account holder.

bankAccountUUIDs

Array (tick) An array of bank IDs, each ID is represented by a unique string value.

DeleteShareholdersRequest

This class contains data that should be passed in the /deleteShareholders request to remove shareholders from an account holder.

Field
Type
Required
Description
accountHolderCode String (tick)

A code identifying the account holder.

shareholderCodes

Array (error)

An array of string codes that correspond to shareholders to be removed.

DocumentDetail

This object helps to represent any document, including information on its type and file.

Field Type Required Description
accountHolderCode String (tick)

A code identifying the account holder.

bankAccountUUID String (error)

If a documentType is BANK_STATEMENT, you also need to specify for which bank account this statement is provided.

The following error codes can be returned if the bank account UUID is missing or incorrect:

  • 10_004 – Account with the provided account code does not exist.

  • 10_074 – The bankAccountUUID is missing, this is required for bank statement upload.

description String (error) Description of the document.
documentType Enum (tick)

Type of the document:

  • PASSPORT
  • ID_CARD – for European ID cards (both front and back pages).
  • DRIVING_LICENCE – only the front page of a license document.
  • DRIVING_LICENCE_FRONT – the front page of a driver license.
  • DRIVING_LICENCE_BACK – the back page of a driver license, where necessary.
  • BANK_STATEMENT
filename String (error) Name of the document.
shareholderCode String (error)

Shareholder code.

Mandatory if an uploaded document is for the shareholder.

GetAccountHolderRequest

This class contains data that should be passed in the /getAccountHolder request to receive all the details of the account holder.

Field
Type
Required
Description
accountHolderCode String (error)

A code identifying the account holder.

accountCode String (error) A code identifying the account to lookup.

Either an accountHolderCode or accountCode must be specified in this call; otherwise, the error code 10_080 is returned ("No account holder or account specified").

GetTierConfigurationRequest

Use the /getTierConfiguration request to receive the tier configuration for the account holder. This call doesn't require any fields passed in a request body.

GetTierConfigurationResponse

This class contains data that is returned as a response to the /getTierConfiguration request.

Field Type Returned by default Description
pspReference String (tick)

A reference to uniquely identify the request.

submittedAsync Boolean (tick)

Indicates whether the call is processed synchronously or asynchronously.

Depending on your marketplace settings, the following scenarios may be applied:

  • sync – The processing of the request is immediately attempted; it might result in an error if the corresponding service is momentarily unavailable.
  • async – The request is queued and will be executed when the corresponding service is available, in the order the requests are received.
  • asyncOnError – The processing of the request is immediately attempted, but in case the corresponding service is unavailable, the request is scheduled in a queue.

tierConfiguration Array of TierConfiguration (tick) Contains a list of tiers configured for this marketplace, per country. For more information, refer to Verification process.

GetUploadedDocumentsRequest

This class contains data that should be passed in the /getUploadedDocuments required to get the details of the previously uploaded documents.

Field Type Required Description
accountHolderCode String (tick)

A code identifying the account holder.

bankAccountUUID String (error) The unique identifier of the bank account, for which the statement needs to be retrieved.
shareholderCode String (error)

A code of the shareholder, whose uploaded documents have to be retrieved.

This call returns the following documents depending on the passed parameters:

  • when only the accountHolderCode is specified, both the account holder's and all its shareholders (if any) documents are returned.
  • when accountHolderCode and bankAccountUUID are specified, MarketPay returns only the bank statement for this UUID.
  • when accountHolderCode and shareholderCode are provided, only the shareholder's documents are returned.
  • when all three fields (accountHolderCodeshareholderCode, and bankAccountUUID) are passed in a request, only the shareholder's documents are returned.

IndividualDetails

This object contains detailed information about the individual.

Field Type Required Description
name Name (error)

The name of the individual.

personalData PersonalData (error)

Personal information of the individual.

KYCCheckDataSummaryItem

This object contains summary of performing a specific KYC check during account holder verification.

Field Type Returned by default Description
itemCode String (tick)

Code of the item.

itemDescription String (tick)

Description of the item.

KYCCheckOwner

This object contains information about the owner of a KYC check.

Field Type Required Description
accountHolderCode String (tick) A code of the account holder, for which KYC verification has been performed.
bankAccountUUID String (error)

A bank ID represented by a unique string value.

shareholderCode String (error)

A code of the shareholder.

KYCCheckResult

This object contains information on the results of a specific KYC check.

Field Type Required Description

checkType

Enum (tick)

The type of a check, which result is contained in this object.

Possible values:
  • COMPANY_VERIFICATION
  • IDENTITY_VERIFICATION
  • PASSPORT_VERIFICATION
  • BANK_ACCOUNT_VERIFICATION

For more information, refer to KYC verification.

verificationStatus

Enum (tick)

The status of a verification check.

Possible values:
  • PASSED
  • FAILED
  • PENDING
  • INVALID_DATA
  • AWAITING_DATA
  • DATA_PROVIDED
  • RETRY_LIMIT_REACHED

For more information, refer to KYC verification.

summary

Object (error)

Summary information on the check result.

 

code

Int (tick)
 

description

String (error)

The description message. For more information, refer to KYC verification codes (1000-99999).

KYCCheckSummary

This object contains summary of performing a specific KYC check.

Field Type Returned by default Description
code String (tick)

Code of the item.

description String (error)

Description of the item.

KYCVerificationResult

This object contains information on the results of KYC verification.

Field Type Required Description
accountHolderCode String (tick) A code of the account holder, for which KYC verification has been performed.
bankAccountUUID String (error)

A bank ID represented by a unique string value.

shareholderCode String (error)

A code of the shareholder.

checkResults Array (tick)

An array with detailed descriptions why each KYC check got a specific state.

This array contains the KYCCheckResult elements.

verificationStatuses Object (tick) This field consists of entries, each of which includes the key and value.
  key String (tick)

Possible values:
  • COMPANY_VERIFICATION
  • IDENTITY_VERIFICATION
  • PASSPORT_VERIFICATION
  • BANK_ACCOUNT_VERIFICATION

For more information, refer to KYC verification.

  value String (tick)

Possible values:
  • PASSED
  • FAILED
  • PENDING
  • INVALID_DATA
  • AWAITING_DATA
  • DATA_PROVIDED
  • RETRY_LIMIT_REACHED

For more information, refer to KYC verification.

PayoutState

This object contains information on the current payout state of the account holder.

Field Type Required Description
allowPayout Boolean (error) Indicates whether a payout is allowed.
disabled Boolean (error) Indicates whether the payout schedule is disabled for all accounts of this account holder.
disableReason String (error) If the payout schedule was disabled, this value stores the disabling reason.
payoutLimit Amount (error)

In case the payout is allowed but limited, this value stores the maximum allowed value to be paid out.

tierNumber Integer (error)

V3 This object was added in the version 3.

The tier, in which the account holder currently resides.

ProcessingState

This object contains information on the current processing state of the account holder.

Field Type Required Description
disabled Boolean (error) Indicates whether processing payments is disabled for all accounts of this account holder.
disableReason String (error) If processing payments was disabled, this value stores the disabling reason.
processedFrom Amount (error)

An account holder has processed an amount, equal or more than processedFrom amount.

processedTo Amount (error)

An account holder has processed an amount, less than processedTo amount.

tierNumber Integer (error)

V3 This object was added in the version 3.

The tier, in which the account holder currently resides.

Shareholder

This object contains information on KYC checks to be performed for a particular shareholder.

Field Type Returned by default Description
shareholderCode String (error) A code of the shareholder.
checks Array of CheckStatus (error) A list of KYC checks to be performed for the shareholder.

ShareholderContact

This object provides information on a shareholder contact.

Field Type Required Description
shareholderCode String (tick) A shareholder's code.
name Name (error) The name of the user.
personalData PersonalData (error) Personal information of the user.
address Address (error) Address of the user.
email String (error) Valid email address.
webAddress String (error) Valid URL.
fullPhoneNumber String (error)

Either phoneNumber or fullPhoneNumber has to be provided.

The full phone number is a string handled as a landline phoneType (e.g. "0031 6 11 22 33 44", "+316/1122-3344", "(0031) 611223344").

phoneNumber PhoneNumber (error)

Either phoneNumber or fullPhoneNumber should be provided.

The phone number length needs to be at least 6 characters long, including the + leading symbol.

SuspendAccountHolderRequest

This class contains data that should be passed in the /suspendAccountHolder request to suspend an existing account holder.

Field Type Required Description
accountHolderCode String (tick)

A code identifying the account holder.

Tier

Contains information on an account holder's tier. For more information, refer to Verification process.

Field Type Required Description
deadlineConfiguration String (tick)

The configuration that defines when a deadline is reached for a certain tier. This will result in events being scheduled.

Format: {"duration":"value","durationUnit":"DAY|WEEK|MONTH"}

fromAmount Amount (tick) The minimum processed amount for this tier.
toAmount Amount  (tick)

The maximum processed amount for this tier.

tierNumber Int (short) (tick)

An index of a tier, for which the configuration is hold in this object. The tier indices can match the default numbers described in the Verification process topic, or you can contact Support Team to define custom tier numbers.

TierConfiguration

Contains information on tiers configured for this marketplace in a specific country. For more information, refer to Verification process.

Field Type Required Description
countryCode String (tick)

A code defining the country where this configuration must be applied to. A valid value is an ISO two-character country code (e.g. 'NL').

tiers Array of Tier (tick) A collection of tiers configured for this country.

UnSuspendAccountHolderRequest

This class contains data that should be passed in the /unSuspendAccountHolder request to un-suspend an existing account holder.

Field Type Required Description
accountHolderCode String (tick)

A code identifying the account holder.

UpdateAccountHolderRequest

This class contains data that should be passed in the /updateAccountHolder request to update the details of an account holder.

Field

Type Required Description
accountHolderCode String (tick)

A code of the account holder to be updated.

metadata Object (error)

Metadata consists of entries, each of which includes the key and value.

This field takes the following children:

  • key
  • value

Limitations:

  • Error "177", "Metadata size exceeds limit"
  key String (error)

Key for the information to be provided. Example: key = 'storeCountry'

Limitations:

Error "178", "Metadata key size exceeds limit"

  value String (error)

Information value. Example: value = 'US'

Limitations:

Maximum length: 80 characters, value is truncated to 80 characters with '...' appended to it.

accountHolderDetails AccountHolderDetails (tick)

Details of the account holder.

processingTier Integer (error)

V3 This object was added in the version 3.

The processing tier, in which the account holder needs to start.

UpdateAccountHolderResponse

This class contains data that is returned as a response to a /updateAccountHolder request.

Field Type Returned by default Description
pspReference String (tick)

A reference to uniquely identify the request.

accountHolderCode String (tick)

A code identifying the account holder.

accountHolderDetails AccountHolderDetails (tick)

Details of the updated account holder.

accountHolderStatus AccountHolderStatus (tick)

Status of the updated account holder.

invalidFields Array (error)

In case the account holder has not been updated, contains account holder fields that did not pass the validation.

This array contains the ErrorFieldType elements.

submittedAsync Boolean (tick)

Indicates whether the call is processed synchronously or asynchronously.

Depending on your marketplace settings, the following scenarios may be applied:

  • sync – The processing of the request is immediately attempted; it might result in an error if the corresponding service is momentarily unavailable.
  • async – The request is queued and will be executed when the corresponding service is available, in the order the requests are received.
  • asyncOnError – The processing of the request is immediately attempted, but in case the corresponding service is unavailable, the request is scheduled in a queue.

updatedFields Array (error)

Contains account holder fields that have been updated.

This array contains the ErrorFieldType elements.

verification Verification (tick)

KYC verification results. For more information, refer to KYC verification.

UpdateAccountHolderStateRequest

This class contains data that should be passed in the /updateAccountHolderState request to update the account holder's state.

Field Type Required Description
accountHolderCode String (tick)

A code identifying the account holder.

stateType Enum (tick)

State of the account.

Allowed values:

  • Processing
  • Payout
disable Boolean (tick) True/False
reason String (error)

Reason to update the state.

Required if the account holder state is being disabled.

UpdateAccountRequest

This class contains data that should be passed in the /updateAccount request to update an existing account and change its payout schedule.

Note that a payout schedule can be also specified at a marketplace level. For more information, contact the Support Team.

Field
Type
Required
Description
accountCode String (tick)

A code of the account, which should be updated.

payoutSchedule Object (tick) A container for schedule details.
  schedule Enum (tick)

The new schedule interval.

Allowed values:

  • DAILY – every day;
  • WEEKLY – every Monday;
  • MONTHLY – on the first day of the month;
  • HOLD – not scheduled, the payout should be initiated manually.
  action Enum (tick)

If another payout schedule was already set in the past, this value specifies the behavior for the current payout period. If no payout schedule exists, this value is ignored.

Allowed values:

  • CLOSE – close the current period and pay out on the next day;
  • UPDATE – update the current period with a new schedule;
  • NOTHING – finish the current period first, and then use a new schedule.

UploadDocumentRequest

This class contains data that should be passed in the /uploadDocument request to upload a document either for an account holder or for a shareholder.

Field Type Required Description
documentContent String (tick)

The document's content, represented by a Base64-encoded string.

Restrictions:

  • Allowed formats: jpeg, jpg, pdf, png
  • Maximum allowed size: 10 MB
  • Minimum allowed size: 1000 bytes
accountHolderCode  String (tick) The Account Holder for whom you are uploading a document.

documentDetail

DocumentDetail (tick)

Specific properties of the document.

Verification

This object provides details on KYC verifications and their status.

Field Type Required Description
accountHolder CheckResult (error) A result of performing KYC checks for an account holder.
shareholders Array of Shareholder (error) A result of performing KYC checks for shareholders.
bankAccounts Array of BankAccount (error) A result of performing KYC checks for bank accounts.

Questions

Can't find something you are looking for? Look at our FAQ for answers or contact Support.