CompanyOperations - Reopen Company

When should this function be used?

This function is intended for cases where a provider wants to reopen a merchant to which it provides services.

Below is a link to the function in the JSON API documentation.

Request method: POST.

Reopen company
https://secure.cardcom.solutions/api/v11/CompanyOperations/ReOpenCompany

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 is optional.

No.	Parameter	Example possible values	Description
1	SupplierUserName	(String)	Provider username.
2	SupplierPassword	(String)	Provider password.
3	Secret	(String)	Secret?
7	TerminalInfo – object	BankCode – (String) ---- BankBranchCode – (String) ---- BankAccountNumber – (String) ---- ModuleList – an array containing the ModuleID parameter	BankCode – bank code. BankBranchCode – bank branch code. BankAccountNumber – bank account number. ModuleList – an array of module IDs.

CompanyInfo object values (4).

No.	Parameter	Example possible values	Description
1	Activity	(String)	?
2	BusinessRegistrationNumber	(String)	?
3	ContactPerson	(String)	Contact person.
4	Email	(String)	Merchant email address.
5	Name	(String)	Merchant name.
6	Fax	(String)	Merchant 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 merchant a nonprofit organization?
11	Citizenship	"Unknown" – Unknown "Israel" – Israel "Expatriate" – Foreign resident "ResidentArea" – Area resident	Merchant citizenship.
12	CompanyInternalID	(String)	Merchant internal number.
13	NameEng	(String)	Merchant name in English.
14	CityCode	(Int)	City code.
15	StreetCode	(Int)	Street code.
16	HouseNumber	(String)	Building number.
17	WebSiteUrl	(String)	Merchant website URL.
18	Entrance	(String)	Entrance?
19	CountryCode	(Int)	Country code.
20	NameLegalCorporation	(String)	Merchant's legal name.
21	AgreementInfo – object	AgreementId – (Int)	?

UserInfo object values (5).

No.	Parameter	Example possible values	Description
1	StreetCode	(Int)	Street code.
2	CityCode	(Int)	City code.
3	Email	(String)	Merchant 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)	Merchant fax number.
9	PhoneNumber	(String)	Merchant's 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	"Unknown" "male" "female"	Gender.
15	IdentityIssueDate	(String)	ID issue 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 (8.1).

A nested object of KycInfo.

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 installments for an average transaction. This field accepts an integer.
8	SalePlatform	(String) "PhysicalSale" – Physical sale "Phone" – Telephone "Web" – Internet "LandingPage" – Payment landing page	The platform on which the sale is expected to take place. Not in use; this field accepts an integer.
9	SalePlatforms – array of (String)	[(String),(String)]	The platforms on which sales are expected to take place. This field accepts a list of integers in the format [0,1,2]: PhysicalSale = 0, Phone = 1, Web = 2, LandingPage = 3.
10	IsPaymentsFacilitator	Boolean – true / false	Aggregation of charges for other providers – 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, reloadable 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 in other businesses?
15	TypeOfPlannedService	(String)	What is the type of service planned?
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" – Late "Continuous" – Continuous	Expected delivery timeframe for the store's products.
22	TimeTillProductShips	(Int)	Expected time 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 merchant previously been denied activity with a banking corporation?
26	GeneralBusinessFieldMccCode	(Int)	General business category.
27	SpecifiedBusinessFieldMccCode	(Int)	Detailed business category.
28	TypeOfRecruitment	(String) "Independent" – Independent "Telephone" – Telephone "UsingARemoteRepresentative" – Using a remote representative	Recruitment method.

KycInfoOsekMurshe values (8.2).

A 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)	Building number in the business owner's residential address.
3	BusinessOwnerEntranceNumber	(String)	Entrance 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.

Reopen 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 was unsuccessful.
2	Description	"OK"	Response description. "OK" indicates success.
3	CompanyInternalID	21348	Internal merchant number.
4	TerminalNumber	1000	Terminal number.
5	APIUserName	"test2025"	Merchant API username.
6	APISecret	"test5000$"	Merchant API password.
7	ModulesList Array of strings.	"Direct Debit", "Payment Landing Pages", "Low Profile"	An array containing the list of modules.
8	UpayAPIKey	(String)	UPAY API key.
9	ShowErrorToEndUser	Boolean – true / false	Whether to display an error to the customer.
10	CardComSapakNumber	(String)	Cardcom provider number, if available.
11	CompanyNumber	21351	Merchant internal 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 - Reopen Company

When should this function be used?

Reopen Company response

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

Was this article helpful?