createCompanyAndMerchant

This call creates both a company account and a merchant account. The call contains the following elements:

  • companyData
  • merchantData

See merchantData Element fields for a detailed explanation of this field.

  • 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.

companyData element fields

Fields Type Required Description
companyData Class (tick)

 The account under which the merchant account is created. The call has the following elements:

  • adminUser
  • collectInvoiceFromSettlement
  • countryCode
  • createExtendedInvoice
  • financialContact
  • invoiceCurrency
  • name
  • registrationNumber
  • sendAPaperInvoice
  • sendInvoiceViaEmail
  • timeZoneCode
  • vatNumber

adminUser

Class (tick)

The following fields need to be provided for the created user:

  • email
  • name
  • personalData

email

String (tick) Email of the user.

name

Class (tick)

Name of the user. The following fields should be provided

  • 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 about the user. The following fields needs to be provided:

  • dateOfBirth
  • idNumber
  • nationality

dateOfBirth

String (error) The date of birth of the admin user, the date is in ISOformatyyyy-mm-dd (e.g. 2000-01-31).

idNumber

String (error) An ID number of the admin user.

nationality

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

collectInvoiceFromSettlement

String (tick) Valid values are true or false.

countryCode

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

createExtendedInvoice

String (tick) This field indicates whether an extended version of the invoice should be created. This provides a breakdown of the financials per Merchant.
Valid values are true or false.

financialContact

Class (error)

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

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

Address of the user. The following fields are required:

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

city

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

houseNumberOrName

String (error) House name or number of the user.
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 with maximum 3 characters 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
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) The 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) Contact number. It is not mandatory 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").

invoiceCurrency

String (tick) Currency the company is invoiced in. This is usually the same as the primary settlement currency of the main processing merchant.
Valid ISO 3-character currency code.

name

String (tick) Registered legal name of the company.

registrationNumber

Int (error) Registration Number recorded for the company from, for example, the Chamber of Commerce.

sendAPaperInvoice

String (error)

This indicates whether a paper invoice should be sent to the financial contact.
Valid values are:

  • True
  • False

The default value is false.

sendInvoiceViaEmail

String (tick)

This indicates whether a PDF version of the invoice should be emailed to the financial contact.
Valid values are:

  • True
  • False

timeZoneCode

String (tick)
This influences dates and times shown within the Customer Area
enum { 'EST', 'AEST', 'PST', 'UTC', 'CET_CEST', 'WET_WEST', 'BRT_BRST' }
vatNumber String (error)

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

It can be set to N/A or Exempted (case-insensitive).

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.