Sign in

v26

latestOpenAPI 3.1.0raw.githubusercontent.com2024-09-162077261.3 KB
Account holders

Update an account holder

Updates the accountHolderDetails and processingTier of an account holder, and adds bank accounts and shareholders.

When updating accountHolderDetails, parameters that are not included in the request are left unchanged except for the following object:

  • metadata: Updating the metadata replaces the entire object. This means that to update an existing key-value pair, you must provide the changes, as well as other existing key-value pairs.

When updating any field in the following objects, you must submit all the fields required for validation:

  • address

  • fullPhoneNumber

  • bankAccountDetails.BankAccountDetail

  • businessDetails.shareholders.ShareholderContact

For example, to update the address.postalCode, you must also submit the address.country, .city, .street, .postalCode, and possibly .stateOrProvince so that the address can be validated.

To add a bank account or shareholder, provide the bank account or shareholder details without a bankAccountUUID or a shareholderCode.

post/updateAccountHolder

Request body

accountHolderCodestring required

The code of the Account Holder to be updated.

descriptionstring

A description of the account holder, maximum 256 characters. You can use alphanumeric characters (A-Z, a-z, 0-9), white spaces, and underscores _.

legalEntity'Business' | 'Individual' | 'NonProfit' | 'Partnership' | 'PublicCompany'

The legal entity type of the account holder. This determines the information that should be provided in the request.

Possible values: Business, Individual, or NonProfit.

  • If set to Business or NonProfit, then accountHolderDetails.businessDetails must be provided, with at least one entry in the accountHolderDetails.businessDetails.shareholders list.

  • If set to Individual, then accountHolderDetails.individualDetails must be provided.

primaryCurrencystring

The primary three-character ISO currency code, to which the account holder should be updated.

processingTierinteger

The processing tier to which the Account Holder should be updated.

The processing tier can not be lowered through this request.

Required if accountHolderDetails are not provided.

verificationProfilestring

The identifier of the profile that applies to this entity.

Response

OK - the request has succeeded.

accountHolderCodestring

The code of the account holder.

descriptionstring

The description of the account holder.

legalEntity'Business' | 'Individual' | 'NonProfit' | 'Partnership' | 'PublicCompany'

The legal entity of the account holder.

primaryCurrencystring

The three-character ISO currency code, with which the prospective account holder primarily deals.

pspReferencestring

The reference of a request. Can be used to uniquely identify the request.

resultCodestring

The result code.

verificationProfilestring

The identifier of the profile that applies to this entity.