CompanyOperations – (Must Be Reviewed) Validate Company Fields
When should this function be used?
Validates merchant fields.
Below is a link to the function in the JSON documentation.
Request method: POST.
Validate company fields
https://secure.cardcom.solutions/api/v11/CompanyOperations/ValidateCompanyCreation
Below are the parameters that must be passed to the Validate company fields function.
Legend:
Red parameter – required
Bold parameter – recommended
Parameter that is neither red nor bold – optional
| No. | Parameter | Example possible values | Description |
|---|---|---|---|
| 1 | DocumentsInfo – array of objects |
DocType:
---- Name – (String) ---- Content – (String) | DocType – the type of document being submitted. ---- Name – the name under which the document is submitted. ---- Content – file name description. |
AcquiredCompanyAccount values (2).
Object.
| No. | Parameter | Example possible values | Description |
|---|---|---|---|
| 1 | SupplierUserName | (String) | Supplier username. |
| 2 | SupplierPassword | (String) | Supplier password. |
| 3 | Secret | (String) | Secret. |
| 6 | TerminalInfo – object | BankCode – (String) ---- BankBranchCode – (String) ---- BankAccountNumber – (String) ---- ModuleList – an array of ModuleID parameters | BankCode – bank code. BankBranchCode – bank branch code. BankAccountNumber – bank account number. ModuleList – an array of module IDs. |
CompanyInfo values (2.4).
An object nested within AcquiredCompanyAccount.
| No. | Parameter | Example possible values | Description |
|---|---|---|---|
| 1 | Activity | (String) | Merchant's business sector. |
| 2 | BusinessRegistrationNumber | (String) | Merchant's ID number or company registration number. |
| 3 | ContactPerson | (String) | Contact person. |
| 4 | (String) | Merchant email address. | |
| 5 | Name | (String) | Merchant name. |
| 6 | Fax | (String) | Merchant fax number. |
| 7 | PhoneNumber | (String) | Landline phone number. |
| 8 | MobilePhone | (String) | Mobile phone number. |
| 9 | ZipCode | (String) | Postal code. |
| 10 | IsVatFreeCompany | Boolean – true / false | Is the merchant a nonprofit organization? |
| 11 | Citizenship | "Unknown" – unknown "Israel" – Israel "Expatriate" – foreign resident "ResidentArea" – area of residence | Merchant citizenship. |
| 12 | CompanyInternalID | (String) | Merchant's internal number. |
| 13 | NameEng | (String) | Merchant name in English. |
| 14 | CityCode | (Int) | City code. |
| 15 | StreetCode | (Int) | Street code. |
| 16 | HouseNumber | (String) | House number. |
| 17 | WebSiteUrl | (String) | Merchant website URL. |
| 18 | Entrance | (String) | Building entrance number. |
| 19 | CountryCode | (Int) | Country code. |
| 20 | NameLegalCorporation | (String) | Merchant's legal name. |
| 21 | AgreementInfo – object | AgreementId – (Int) | Number of the supplier's agreement with Cardcom. |
UserInfo values (2.5).
An object nested within AcquiredCompanyAccount.
| No. | Parameter | Example possible values | Description |
|---|---|---|---|
| 1 | StreetCode | (Int) | Street code. |
| 2 | CityCode | (Int) | City code. |
| 3 | (String) | Merchant email address. | |
| 4 | IdentityNumber | (String) | ID number. |
| 5 | LogInName | (String) | Username for signing in to the Cardcom system. |
| 6 | LogInPassword | (String) | Password for signing in to the Cardcom system. |
| 7 | FirstName | (String) | Business owner's first name. |
| 8 | Fax | (String) | Merchant fax number. |
| 9 | PhoneNumber | (String) | Merchant's landline phone number. |
| 10 | MobilePhone | (String) | Mobile phone number. |
| 11 | ZipCode | (String) | Postal code. |
| 12 | LastName | (String) | Last name. |
| 13 | BirthDate | (String) | Date of birth. |
| 14 | Gender | "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" | Identification document type: ID card or passport. |
| 18 | PersonalIdentificationCode | (String) | Personal identification code. |
KycInfoGeneric values (2.7.1).
An object nested within KycInfo, which is nested within AcquiredCompanyAccount.
| No. | Parameter | Example possible values | Description |
|---|---|---|---|
| 1 | CountriesTargetedMarket | (String) | Free text of up to 250 characters specifying the countries for which the product is intended. |
| 2 | NamesOfRelatedBusinesses | (String) | Free text of up to 250 characters listing related businesses. 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" – phone "Web" – internet "LandingPage" – payment landing page | The platform on which the sale is expected to take place. Not in use; the field accepts an integer. |
| 9 | SalePlatforms – array of (String) | [(String), (String)] | Platforms on which sales are expected to take place. This field accepts a list of integers in the form [0,1,2]: PhysicalSale = 0, Phone = 1, Web = 2, LandingPage = 3. |
| 10 | IsPaymentsFacilitator | Boolean – true / false | Aggregation of charges for other suppliers—whether the customer is a payment facilitator. |
| 11 | IsBusinessFacilitateCashWithdrawls | Boolean – true / false | Does the customer allow cash withdrawals at the register? |
| 12 | IsBusinessFacilitateVoucherOrRechargingCardsSales | Boolean – true / false | Does the customer allow the sale of vouchers, rechargeable cards, or gift cards? |
| 13 | IsBusinessFacilitateCreditForTransactionsOutsideBusinessScope | Boolean – true / false | Does the customer provide credit for purposes other than purchases from the store? |
| 14 | IsBusinessPlaceCashRegistersInOtherBusinesses | Boolean – true / false | Does the business place cash registers at other businesses? |
| 15 | TypeOfPlannedService | (String) | What is the type of service planned? |
| 16 | MinimumAmountOfCreditTransaction | (Int) | What is the minimum credit-card transaction amount? |
| 17 | MaximumAmountOfCreditTransaction | (Int) | What is the maximum credit-card transaction amount? |
| 18 | IsTheBusinessSeasonal | Boolean – true / false | Does the business primarily operate during a particular season of the year? |
| 19 | IsTheBusinessPreviouslyClearedCreditCards | Boolean – true / false | Has the business processed credit cards in the past? |
| 20 | NumberOfYearsBusinessHasInClrearance | (Int) | How many years of payment-processing experience does the business have? |
| 21 | ExpectedStoreSupplyDeliverySchedule | (String) enum "Immediate" – immediate "Late" – delayed "Continuous" – continuous | Expected delivery timeframe for the store's products. |
| 22 | TimeTillProductShips | (Int) enum | Expected delivery timeframe for shipment: 0 = immediate 1 = 1–7 days 2 = 8–14 days 3 = more than 14 days |
| 23 | AvarageTransactionAmountInCreditCard | (Int) | What is the average credit-card transaction amount? |
| 24 | EstimatedMonthlyTransactionAmount | (Int) | Estimated monthly number of transactions. |
| 25 | IsBusinessBeenDeniedActionVersusBankingCorporation | Boolean – true / false | Has the merchant previously been denied activity with a banking corporation? |
| 26 | GeneralBusinessFieldMccCode | (Int) | General business sector. |
| 27 | SpecifiedBusinessFieldMccCode | (Int) | Specific business sector. |
| 28 | TypeOfRecruitment | (String) "Independent" – independently "Telephone" – by phone "UsingARemoteRepresentative" – using a remote representative | Recruitment method. |
KycInfoOsekMurshe values (2.7.2).
An object nested within KycInfo, which is nested within AcquiredCompanyAccount.
| 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 at the business owner's residential address. |
| 3 | BusinessOwnerEntranceNumber | (String) | Entrance number at the business owner's residential address. |
| 4 | BusinessOwnerStreetCode | (Int) | Street code for the business owner's residential address. |
| 5 | BusinessOwnerCityCode | (Int) | City code for the business owner's residential address. |
| 6 | BusinessOwnerZipCode | (String) | Postal code for the business owner's residential address. |
| 7 | MotherMaidenName | (String) | Mother's maiden name. |
Validate company fields 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 was unsuccessful. |
| 2 | Description | "OK" | Response description. "OK" indicates success. |
| 3 | DocumentsErrorResults – array of objects | PropertyName – "Business name" Response – (STRING) | PropertyName – merchant name. Response – response. |
| 4 | KycErrorResults – array of objects | PropertyName – "Business name" Response – (STRING) | PropertyName – merchant name. Response – response. |
| 5 | CompanyErrorResults – array of objects | PropertyName – "Business name" Response – (STRING) | PropertyName – merchant name. Response – response. |
| 6 | UserErrorResults – array of objects | PropertyName – "Business name" Response – (STRING) | PropertyName – merchant name. Response – response. |
| 7 | CompanyInternalID | 21348 | Internal merchant number. |
| 8 | TerminalNumber | 1000 | Terminal number. |
| 9 | APIUserName | "test2025" | Merchant's API username. |
| 10 | APISecret | "test5000$" | Merchant's API password. |
| 11 | ModulesList – array of strings | "Standing Order", "Payment Landing Pages", "Low Profile" | An array of strings containing module names. |
| 12 | Request | 100 101 200 201 202 203 204 205 206 300 300 301 301 302 302 303 303 304 305 306 307 307 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 426 500 501 502 503 504 505 | Response number. |
| 13 | IsDone | Boolean – true / false | Was the operation completed? |
Below is sample code for the function together with its response.
Request example:
{
"DocumentsInfos": [
{
"DocType": "Id",
"Name": "string",
"Content": "string"
}
],
"AcquiredCompanyAccount": {
"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",
"DocumentsErrorResults": [
{
"PropertyName": "string",
"Response": "string"
}
],
"KycErrorResults": [
{
"PropertyName": "string",
"Response": "string"
}
],
"CompanyErrorResults": [
{
"PropertyName": "string",
"Response": "string"
}
],
"UserErrorResults": [
{
"PropertyName": "string",
"Response": "string"
}
],
"CompanyInternalID": "string",
"TerminalNumber": 0,
"APIUserName": "string",
"APISecret": "string",
"ModulesList": [
"string"
],
"Request": 100,
"IsDone": true
}