Create an account holder

post /createAccountHolder

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.

Endpoint destination URL
Click to copy

Request parameters

accountHolderCode string 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.

accountHolderDetails object Required

The details of the prospective account holder.

createDefaultAccount boolean

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.

description string

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

legalEntity string 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.

primaryCurrency string Deprecated

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

processingTier integer

The starting processing tier for the prospective account holder.

verificationProfile string

The identifier of the profile that applies to this entity.

Response parameters

After submitting a call, you receive a response message to inform you that your request was received and processed.

Depending on the HTTP status code of the response message, it is helpful to build some logic to handle any errors that a request or the system may return.

HTTP Responses

  • 200 - OK

    The request has succeeded.

    Show more Show less