Sign in

Create a new account holder.

This endpoint is used to create an account holder. Each account holder represents a single sub-merchant, and each sub-merchant must be represented by an account holder. Depending on the legal entity type, different details are required to be provided in the call to this endpoint.

post/createAccountHolder

Request body

accountHolderCodestring required

The desired code of the prospective account holder.

Must be between three (3) and fifty (50) characters long. Only letters, digits, and hyphens (-) are permitted.

createDefaultAccountboolean

If set to true, an account with the default options is created for this account holder. Default Value: true

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

The entity type. Permitted values: Business, Individual

If an account holder is 'Business', then accountHolderDetails.businessDetails must be provided, as well as at least one entry in the accountHolderDetails.businessDetails.shareholders list.

If an account holder is 'Individual', then accountHolderDetails.individualDetails must be provided.

processingTierinteger

The starting processing tier for the prospective account holder.

Response

OK - the request has succeeded.

accountCodestring

The code of a new account created for the account holder.

accountHolderCodestring required

The code of the new account holder.

pspReferencestring

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

resultCodestring

The result code.

submittedAsyncboolean

Indicates whether the request is processed asynchronously. Depending on the request's platform settings, the following scenarios may be applied:

  • true: The request is queued and will be executed when the providing service is available in the order in which the requests are received.
  • false: The processing of the request is immediately attempted; it may result in an error if the providing service is unavailable.

Changes