CompanyOperations - Function for Creating a Company in Cardcom (New Company)

When should this function be used?

This function is intended for dealers or suppliers who want to add a new business under their account.

Below is a link to the JSON function.

Request method: POST.

New company
https://secure.cardcom.solutions/api/v11/CompanyOperations/NewCompany

Below are the parameters that must be passed to the function.

Legend:

Red parameter – required

Bold parameter – recommended

A parameter that is neither red nor bold – optional

No.	Parameter	Example possible values	Description
1	SupplierUserName	(String)	Supplier username.
2	SupplierPassword	(String)	Supplier password.
3	Secret	(String)	Secret.
7	TerminalInfo – object	BankCode – (String) ---- BankBranchCode – (String) ---- BankAccountNumber – (String) ---- ModuleList – array of ModuleID parameters	BankCode – bank code. ---- BankBranchCode – bank branch code. ---- BankAccountNumber – bank account number. ---- ModuleList – an array of module codes to activate.

CompanyInfo object values (4).

No.	Parameter	Example possible values	Description
1	Activity	(String)	The business's field of activity.
2	BusinessRegistrationNumber	(String)	Company registration number / business registration number / ID number.
3	ContactPerson	(String)	Contact person.
4	Email	(String)	Business email address.
5	Name	(String)	Business name.
6	Fax	(String)	Business fax number.
7	PhoneNumber	(String)	Landline telephone number.
8	MobilePhone	(String)	Mobile telephone number.
9	ZipCode	(String)	Postal code.
10	IsVatFreeCompany	Boolean – true / false	Is the business VAT-exempt?
11	Citizenship	"Unknown" – unknown "Israel" – Israel "Expatriate" – foreign resident "ResidentArea" – area resident	Citizenship of the business.
12	CompanyInternalID	(String)	Company number created in Cardcom.
13	NameEng	(String)	The business name in English. This field is required for customers using 3D Secure.
14	CityCode	(Int)	City code.
15	StreetCode	(Int)	Street code.
16	HouseNumber	(String)	House number.
17	WebSiteUrl	(String)	URL of the business website.
18	Entrance	(String)	Entrance.
19	CountryCode	(Int)	Country code.
20	NameLegalCorporation	(String)	Legal name of the business.
21	AgreementInfo – object	AgreementId – (Int)	The supplier's agreement number with Cardcom, unique to each supplier.

UserInfo object values (5).

No.	Parameter	Example possible values	Description
1	StreetCode	(Int)	Get streets
2	CityCode	(Int)	City code.
3	Email	(String)	Business email address.
4	IdentityNumber	(String)	ID number.
5	LogInName	(String)	Username for logging in to the Cardcom system.
6	LogInPassword	(String)	Password for logging in to the Cardcom system.
7	FirstName	(String)	Business owner's first name.
8	Fax	(String)	Business fax number.
9	PhoneNumber	(String)	Business landline telephone number.
10	MobilePhone	(String)	Mobile telephone number.
11	ZipCode	(String)	Postal code.
12	LastName	(String)	Last name.
13	BirthDate	(String)	Date of birth.
14	Gender	Enum: "Unknown", "male", "female"	Gender.
15	IdentityIssueDate	(String)	ID issuance date.
16	PassportIssueCountryCode	(Int)	Code of the country that issued the passport.
17	IdIssueDateOrPassportIDTypes	"IDNumber", "Passport"	Passport issuance date.
18	PersonalIdentificationCode	(String)	Passport number.

KycInfoGeneric values (8.1).

Nested object of KycInfo.

No.	Parameter	Example possible values	Description
1	CountriesTargetedMarket	(String)	Free text, up to 250 characters, specifying the countries for which the product is intended. Multiple values may be provided.
2	NamesOfRelatedBusinesses	(String)	Free text, up to 250 characters, listing related businesses, such as a subsidiary. This continues the previous field if TRUE was selected there.
3	ExpectedPercentagePaymentOfOnePayment	(Number)	Expected percentage of single-payment transactions.
4	ExpectedPercentageOfPaymentTransactions	(Number)	Expected percentage of installment transactions.
5	ExpectedPercentageOfCreditPaymentTransactions	(Number)	Expected percentage of credit-payment transactions.
6	ExpectedPercentageOfTouristTransactions	(Int)	Expected percentage of tourist transactions.
7	ExpectedPaymentNumberForAverageTransaction	(Int)	Expected number of payments for an average transaction. This field accepts an integer.
8	SalePlatform	(String) "PhysicalSale" – physical sale "Phone" – telephone sale "Web" – online sale "LandingPage" – payment landing page	The platform on which sales are expected to take place. Not in use; the field accepts an integer.
9	SalePlatforms – array of (String)	[(String), (String)] A field that accepts a list of integer enum values: PhysicalSale = 0 Phone = 1 Web = 2 LandingPage = 3	The platforms on which sales are expected to take place.
10	IsPaymentsFacilitator	Boolean – true / false	Does the customer aggregate charges for other suppliers; i.e., is the customer a payment facilitator?
11	IsBusinessFacilitateCashWithdrawls	Boolean – true / false	Does the customer allow cash withdrawals at the checkout?
12	IsBusinessFacilitateVoucherOrRechargingCardsSales	Boolean – true / false	Does the customer allow the sale of vouchers, reloadable cards, or gift cards?
13	IsBusinessFacilitateCreditForTransactionsOutsideBusinessScope	Boolean – true / false	Does the customer provide credit for purposes other than purchases at the store?
14	IsBusinessPlaceCashRegistersInOtherBusinesses	Boolean – true / false	Does the business place cash registers in other businesses?
15	TypeOfPlannedService	(String)	What is the type of service planned? Free-text field of up to 250 characters.
16	MinimumAmountOfCreditTransaction	(Int)	What is the minimum amount for a credit card transaction?
17	MaximumAmountOfCreditTransaction	(Int)	What is the maximum amount for a credit card transaction?
18	IsTheBusinessSeasonal	Boolean – true / false	Does the business mainly operate during a particular season of the year?
19	IsTheBusinessPreviouslyClearedCreditCards	Boolean – true / false	Has the business previously processed credit cards?
20	NumberOfYearsBusinessHasInClrearance	(Int)	How many years of payment-processing experience does the business have?
21	ExpectedStoreSupplyDeliverySchedule	(String) "Immediate" – immediate "Late" – delayed "Continuous" – continuous	Expected delivery timeframe for the store's products.
22	TimeTillProductShips	(Int)	Expected timeframe until the product is shipped.
23	AvarageTransactionAmountInCreditCard	(Int)	What is the average credit card transaction amount?
24	EstimatedMonthlyTransactionAmount	(Int)	Estimated number of monthly transactions.
25	IsBusinessBeenDeniedActionVersusBankingCorporation	Boolean – true / false	Has the business previously been denied activity by a banking corporation?
26	GeneralBusinessFieldMccCode	(Int)	General field of business.
27	SpecifiedBusinessFieldMccCode	(Int)	Detailed field of business.
28	TypeOfRecruitment	(String) "Independent" – independent "Telephone" – telephone "UsingARemoteRepresentative" – using a remote representative	Recruitment method.

KycInfoOsekMurshe values (8.2).

Nested object of KycInfo.

No.	Parameter	Example possible values	Description
1	IsOwnerAddressDifferentFromBusinessAddress	Boolean – true / false	Is the owner's residential address different from the business address?
2	BusinessOwnerHomeNumber	(String)	House number in the business owner's residential address.
3	BusinessOwnerEntranceNumber	(String)	Entrance number in the business owner's residential address.
4	BusinessOwnerStreetCode	(Int)	Street code in the business owner's residential address.
5	BusinessOwnerCityCode	(Int)	City code in the business owner's residential address.
6	BusinessOwnerZipCode	(String)	Postal code in the business owner's residential address.
7	MotherMaidenName	(String)	Mother's maiden name.

New Company response.

No.	Parameter	Example possible values	Description
1	ResponseCode	0	Response code. If it equals zero, the function was completed successfully. Any other response indicates that the operation failed.
2	Description	"OK"	Description of the response. "OK" indicates success.
3	CompanyInternalID	21348	Company number created in Cardcom.
4	TerminalNumber	1000	Terminal number.
5	APIUserName	"test2025"	The business's API username.
6	APISecret	"test5000$"	The business's API password.
7	ModulesList Array of strings.	"Standing Order", "Landing Pages", "Low Profile"	List of activated modules.
8	UpayAPIKey	(String)	UpayAPIKey.
9	ShowErrorToEndUser	Boolean – true / false	Whether to display error codes to the end user.
10	CardComSapakNumber	(String)	Cardcom supplier number, if one exists.
11	CompanyNumber	21351	Internal business number.

Below is sample code for the function together with the response.

Request example:

{
  "SupplierUserName": "string",
  "SupplierPassword": "string",
  "Secret": "string",
  "CompanyInfo": {
    "Activity": "string",
    "BusinessRegistrationNumber": "string",
    "ContactPerson": "string",
    "Email": "string",
    "Name": "string",
    "Fax": "string",
    "PhoneNumber": "string",
    "MobilePhone": "string",
    "ZipCode": "string",
    "IsVatFreeCompany": true,
    "Citizenship": "Israel",
    "CompanyInternalID": "string",
    "NameEng": "string",
    "CityCode": 0,
    "StreetCode": 0,
    "HouseNumber": "string",
    "WebSiteUrl": "string",
    "Entrance": "string",
    "CountryCode": 0,
    "NameLegalCorporation": "string",
    "AgreementInfo": {
      "AgreementId": 0
    }
  },
  "UserInfo": {
    "StreetCode": 0,
    "CityCode": 0,
    "Email": "string",
    "IdentityNumber": "string",
    "LogInName": "strings",
    "LogInPassword": "strings",
    "FirstName": "string",
    "Fax": "string",
    "PhoneNumber": "string",
    "MobilePhone": "string",
    "ZipCode": "string",
    "LastName": "string",
    "BirthDate": "string",
    "Gender": "Unknown",
    "IdentityIssueDate": "string",
    "PassportIssueCountryCode": 1,
    "IdIssueDateOrPassportIDTypes": "IDNumber",
    "PersonalIdentificationCode": "string"
  },
  "TerminalInfo": {
    "BankCode": "string",
    "BankBranchCode": "string",
    "BankAccountNumber": "string",
    "ModuleList": [
      {
        "ModuleID": "string"
      }
    ]
  },
  "KycInfo": {
    "KycInfoGeneric": {
      "CountriesTargetedMarket": "string",
      "NamesOfRelatedBusinesses": "string",
      "ExpectedPercentagePaymentOfOnePayment": 0,
      "ExpectedPercentageOfPaymentTransactions": 0,
      "ExpectedPercentageOfCreditPaymentTransactions": 0,
      "ExpectedPercentageOfTouristTransactions": 0,
      "ExpectedPaymentNumberForAverageTransaction": 0,
      "SalePlatform": "PhysicalSale",
      "SalePlatforms": [0],
      "IsPaymentsFacilitator": true,
      "IsBusinessFacilitateCashWithdrawls": true,
      "IsBusinessFacilitateVoucherOrRechargingCardsSales": true,
      "IsBusinessFacilitateCreditForTransactionsOutsideBusinessScope": true,
      "IsBusinessPlaceCashRegistersInOtherBusinesses": true,
      "TypeOfPlannedService": "string",
      "MinimumAmountOfCreditTransaction": 0,
      "MaximumAmountOfCreditTransaction": 0,
      "IsTheBusinessSeasonal": true,
      "IsTheBusinessPreviouslyClearedCreditCards": true,
      "NumberOfYearsBusinessHasInClrearance": 0,
      "ExpectedStoreSupplyDeliverySchedule": "Immediate",
      "TimeTillProductShips": 0,
      "AvarageTransactionAmountInCreditCard": 0,
      "EstimatedMonthlyTransactionAmount": 0,
      "IsBusinessBeenDeniedActionVersusBankingCorporation": true,
      "GeneralBusinessFieldMccCode": 0,
      "SpecifiedBusinessFieldMccCode": 0,
      "TypeOfRecruitment": "Independent"
    },
    "KycInfoOsekMurshe": {
      "IsOwnerAddressDifferentFromBusinessAddress": true,
      "BusinessOwnerHomeNumber": "string",
      "BusinessOwnerEntranceNumber": "string",
      "BusinessOwnerStreetCode": 0,
      "BusinessOwnerCityCode": 0,
      "BusinessOwnerZipCode": "string",
      "MotherMaidenName": "string"
    }
  }
}

Example response:

{
  "ResponseCode": 0,
  "Description": "string",
  "CompanyInternalID": "string",
  "TerminalNumber": 0,
  "APIUserName": "string",
  "APISecret": "string",
  "ModulesList": [
    "string"
  ],
  "UpayAPIKey": "string",
  "ShowErrorToEndUser": true,
  "CardComSapakNumber": "string",
  "CompanyNumber": 0
}

CompanyOperations - Function for Creating a Company in Cardcom (New Company)

When should this function be used?

Was this article helpful?