Sign in

v1

latestOpenAPI 3.1.02026-07-201774202.6 KB
Account holders

Create an account holder

Creates an account holder that represents the sub-merchant's entity in your platform. The details that you need to provide in the request depend on the sub-merchant's legal entity type. For more information, refer to Account holder and accounts.

post/createAccountHolder

Request body

accountHolderCodestring required

Your unique identifier for the prospective account holder. The length must be between three (3) and fifty (50) characters long. Only letters, digits, and hyphens (-) are allowed.

createDefaultAccountboolean

If set to true, an account with the default options is automatically created for the account holder. By default, this field is set to true.

legalEntity'Business' | 'Individual' | 'NonProfit' required

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.

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

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.