CompanyOperations - Close Company

When should this function be used?

This function is intended for cases where a supplier wants to close a business to which it provides services.

Below is a link to the function in JSON.

Request method: POST.

Close company

https://secure.cardcom.solutions/api/v11/CompanyOperations/CloseCompany

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

Legend:

Red parameter – required

Bold parameter – recommended

Parameter that is neither red nor bold – optional

No.	Parameter	Possible values/examples	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 – array of module IDs.

CompanyInfo object values (4).

No.	Parameter	Possible values/examples	Description
1	Activity	(String)	Business activity.
2	BusinessRegistrationNumber	(String)	Business registration number / ID number / company registration 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 phone number.
8	MobilePhone	(String)	Mobile phone number.
9	ZipCode	(String)	Postal code.
10	IsVatFreeCompany	Boolean – true / false	Is the business a nonprofit organization?
11	Citizenship	"Unknown" – unknown "Israel" – Israel "Expatriate" – foreign resident "ResidentArea" – area resident	Citizenship of the business.
12	CompanyInternalID	(String)	Internal business number.
13	NameEng	(String)	Business name in English.
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)	Building entrance number.
19	CountryCode	(Int)	Country code.
20	NameLegalCorporation	(String)	Legal name of the business.
21	AgreementInfo – object	AgreementId – (Int)	Number of the supplier's agreement with CardCom.

UserInfo object values (5).

No.	Parameter	Possible values/examples	Description
1	StreetCode	(Int)	Street code.
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 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 issue date.
16	PassportIssueCountryCode	(Int)	Code of the country that issued the passport.
17	IdIssueDateOrPassportIDTypes	"IDNumber" "Passport"	ID or passport document type.
18	PersonalIdentificationCode	(String)	Personal identification code.

KycInfoGeneric values (8.1).

Nested object of KycInfo.

No.	Parameter	Possible values/examples	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 containing a list of 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 sales are 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 form [0,1,2]: PhysicalSale = 0, Phone = 1, Web = 2, LandingPage = 3.
10	IsPaymentsFacilitator	Boolean – true / false	Aggregation of charges for other suppliers – 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 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 experience does the business have in payment processing?
21	ExpectedStoreSupplyDeliverySchedule	(String) "Immediate" – immediate "Late" – late "Continuous" – continuous	Expected delivery timeframe for the store's products.
22	TimeTillProductShips	(Int)	Expected delivery timeframe for the shipment.
23	AvarageTransactionAmountInCreditCard	(Int)	What is the average amount of a credit card transaction?
24	EstimatedMonthlyTransactionAmount	(Int)	Estimated number of monthly transactions.
25	IsBusinessBeenDeniedActionVersusBankingCorporation	Boolean – true / false	Has the business previously been denied activity with a banking corporation?
26	GeneralBusinessFieldMccCode	(Int)	General business activity.
27	SpecifiedBusinessFieldMccCode	(Int)	Detailed business activity.
28	TypeOfRecruitment	(String) "Independent" – independent "Telephone" – telephone "UsingARemoteRepresentative" – using a remote representative	Recruitment method.

KycInfoOsekMurshe values (8.2).

Nested object of KycInfo.

No.	Parameter	Possible values/examples	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.

Close company RESPONSE.

No.	Parameter	Possible values/examples	Description
1	ResponseCode	0	Response code. If it equals zero, the function was executed successfully. Any other response indicates that the operation was unsuccessful.
2	Description	"OK"	Response description. "OK" indicates success.
3	CompanyInternalID	21348	Internal business number.
4	TerminalNumber	1000	Terminal number.
5	APIUserName	"test2025"	Business API username.
6	APISecret	"test5000$"	Business API password.
7	ModulesList Array of strings.	"Standing Order", "Payment Landing Pages", "Low Profile"	List of the business's modules.
8	UpayAPIKey	(String)	UPAY API key.
9	ShowErrorToEndUser	Boolean – true / false	Should the error be shown to the end user?
10	CardComSapakNumber	(String)	CardCom supplier number, if applicable.
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 of the response received:

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

CompanyOperations - Close Company

When should this function be used?

Was this article helpful?