createMerchantForCompany

This call creates Merchant Account for an existing Company Account. The call has the following elements:

  • companyData (should not be present)
  • merchantData
  • bankDetailData (optional)

See bankDetailData Element fields for a detailed explanation of this field:

  • documentData (optional)

See documentData Element fields for a detailed explanation of this field:

  • shareholderData (optional)

See shareHolderData Element fields for a detailed explanation of this field:

merchantData Element fields

Fields Type Required Description
address Class (tick)

Address of the merchant. The following fields are required:

  • city
  • country
  • houseNumberOrName
  • postalCode
  • stateOrProvince
  • street

city

String (tick) City of the merchant.
country String (tick) Country of the merchant. A valid value is an ISO 2-character country code.

houseNumberOrName

String (tick) House name or number of the merchant.
postalCode String (tick) Postal code with a maximum of 5 characters for USA and maximum of 10 characters for any other country.

stateOrProvince

String (tick)

For USA or Canada, a valid 2-character abbreviation for the state or province respectively. For other countries any abbreviation with maximum 3 characters for the state or province.

street String (tick) Street name.

allowedPaymentMethodAmexCurrencies

String (tick)

This element is mandatory if American Express is set up as a payment method. It has the following subelements:

  • amexCurrencyType

amexCurrencyType

String (tick) enum { 'AUD', 'CAD', 'CHF', 'DKK', 'EUR', 'GBP', 'HKD', 'NOK', 'NZD', 'PLN', 'SEK', 'SGD', 'USD', 'THB', 'JPY' }

allowedPaymentMethods

String (error) List of payment methods. enum { 'Amex', 'Visa', 'MasterCard', 'iDeal', 'Sofort', 'SepaDirectDebit', 'GiroPay' }

averageNumberOfDeliveryDays

Int (tick) Average number of days between transaction and delivery of the product/service. Valid values are numeric values.

averageTransactionValue

Int (tick)

The average transaction amount should be provided in minor units, according to ISO standards. The minor currency unit is the divisory or sub divisory currency of the main currency in a monetary system.
The applicable currency for the averageTransactionValue field is the euro, whose minor unit is the eurocent. For example:

  • averageTransactionValue = 1means EUR 0.01
  • averageTransactionValue = 100means EUR 1.00

captureDelayCode

String (tick) Indication of the delay, if any, that occurs between authorising a payment and sending it for capture.
enum { 'Immediate', 'OneDay', 'TwoDays', 'ThreeDays', 'FourDays', 'FiveDays', 'SixDays', 'SevenDays', 'Manual' }

createPosWsUser

String (error)

This indicates whether a WS user is going to be created for POS or not.
Valid values are:

  • True
  • False

The default value is false.

defaultShopperInteraction

String (tick) enum { 'Ecommerce', 'POS', 'MOTO' }

descriptionOfProductsOrServices

String (error) A brief summary of the type of products or services offered by the merchant.

expectedNumberOfTransactions

Int (tick) The expected number of transactions on a monthly basis.

externalReference

String (error) Reference defined by the merchant. If provided, the system checks if the entry already exists for a different merchant account

financialContact

Class (error)

The contact details for the financial contact. The following fields are required:

  • address
  • email
  • name
  • personalData (optional)
  • phoneNumber
  • fullPhoneNumber
address Class (error)

Address of the financial contact. The following fields are required:

  • city
  • country
  • houseNumberOrName
  • postalCode
  • stateOrProvince
  • street

city

String (error) City of the financial contact.
country String (error) Country of the financial contact. A valid value is an ISO 2-character country code.

houseNumberOrName

String (error) House name or number of the financial contact.
postalCode String (error) Postal code with a maximum of 5 characters for USA and maximum of 10 characters for any other country.

stateOrProvince

String (error)

For USA or Canada, a valid 2-character abbreviation for the state or province respectively. For other countries any abbreviation for the state or province.

street String (error) Street name.
email String (error) Email of the user.
name Class (error)

Full name of the user. The following fields are required:

  • firstName
  • lastName
  • gender

firstName

String (tick) First name of the user.

lastName

String (tick) Last name of the user.
gender String (tick) enum { 'MALE', 'FEMALE', 'UNKNOWN' }
personalData Class (error)

Personal information of the user. The following fields are required:

  • dateOfBirth
  • idNumber
  • nationality

dateOfBirth

String (error) The date of birth of the financial contact, the date should be in ISO format yyyy-mm-dd (e.g. 2000-01-31).

idNumber

String (error) An ID number of the financial contact.

nationality

String (error) Nationality of the financial contact represented by an ISO 2-character country code (e.g. 'NL').

phoneNumber

Class (tick)

Either phoneNumber or fullPhoneNumber should be provided. The phone number length needs to be at least 6 characters long, including the + leading symbol.

The following fields are required:

  • phoneCountryCode
  • phoneNumber
  • phoneType

phoneCountryCode

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

phoneNumber

String (tick) No need to include the country code in the number (e.g. '06-11223344').

phoneType

String (tick) enum { 'Landline', 'Mobile', 'SIP', 'Fax' }

fullPhoneNumber

String (tick) 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").
merchantCode String (error) If the merchantCode is available the given value is used. The merchantCode should include the prefix, if applicable, and must be unique.

merchantCategoryCode

int (tick) The merchant category code (MCC) is a four-digit number which relates to a particular market segment. This code reflects the predominant activity that is conducted by the merchant. 
The list of MCCs can be found in https://en.wikipedia.org/wiki/Merchant_category_code.

merchantCostContract

String (error) If the merchantCostContract is not available, the company's costContract is applied. In case the merchantCostContract is available but is invalid, the error message is given back the list of possible costContracts.

name

String (tick) Registered legal name of the merchant.

primarySettlementCurrency

String (tick) Currency code indicating the primary currency in which payouts are made to the Merchant.
Valid value is an ISO 3-character currency code.

shopWebAddress

String (tick) URL for the Merchant's web shop. 
Valid web address should include HTTP or HTTPS protocol.

tradingName

String (tick) Based on the tradingName the merchantCode name is generated. The merchantCode is the name of the merchant account and will appear on the customer's bank statements.
vatNumber String (error)

Minimum 2 (valid) characters long countryCode or EL for Greece, only alphanumeric characters allowed.

It can be left empty or set to case-insensitive N/A or Exempted.

Also see:  https://en.wikipedia.org/wiki/VAT_identification_number

registrationNumber String (error)

Company registration number.

Also see: https://en.wikipedia.org/wiki/European_business_register

Refer the given code examples.