CompanyOperations - Add a Company to an Aggregator (Add Company for Meaged)
When should this function be used?
This function is intended for dealers or suppliers who want to add a company to an aggregator.
Below is a link to the function in JSON.
Request method: POST.
Add Company for Meaged
https://secure.cardcom.solutions/api/v11/CompanyOperations/MeagedAddCompany
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 | Example possible values | Description |
| 1 | IsValidationOnly | Boolean - true \ false | |
| 2 | SupplierUserName | (String) | Supplier username. |
| 3 | Secret | (String) | Secret |
| 6 | KycInfo Object | Mcc - (Int) --- MaxNumberOfPayments - (Number) --- ElectronicCommerceUrl - array of (String) --- | KycInfo - Know Your Customer --- Mcc - MCC number. --- MaxNumberOfPayments - Maximum number of payments. --- ElectronicCommerceUrl - E-commerce URL. --- |
Values of the CompanyInfo object (4).
| No. | Parameter | Example possible values | Description |
| 1 | BusinessRegistrationNumber | (String) | ? |
| 2 | NameLegalCorporation | (String) | Legal business name. |
| 3 | NameLegalCorporationEng | (String) | Legal business name in English. |
| 4 | (String) | Business email address. | |
| 5 | AdvertisingSapakName | (String) | Company name displayed to the cardholder. |
| 6 | AdvertisingSapakEngName | (String) | Company name displayed to the cardholder in English. |
| 7 | PhoneNumber1 | (String) | Phone number 1. |
| 8 | PhoneNumber2 | (String) | Phone number 2. |
| 9 | ZipCode | (String) | Postal code. |
| 10 | CityCode | (Int) | City code. |
| 11 | StreetCode | (Int) | Street code. |
| 12 | HouseNumber | (String) | House number. |
Values of the PeopleInfo object (5).
| No. | Parameter | Example possible values | Description |
| 1 | RelationType | "AuthorizedSignature" "AuthorizedSignatureForeignResident" | Relationship type: AuthorizedSignature – authorized signatory; AuthorizedSignatureForeignResident – authorized signatory who is a foreign resident. |
| 2 | IdentityNumber | (String) | ID number. |
| 3 | IdentityIssueDate_DDMMYYYY | (String) | ID issue date (DDMMYYYY). |
| 4 | IdentityExpireDate_DDMMYYYY | (String) | ID expiration date (DDMMYYYY). |
| 5 | BirthDate_DDMMYYYY | (String) | Date of birth (DDMMYYYY). |
| 6 | Gender | "Unknown" "male" "female" | Gender. |
| 7 | FirstName | (String) | Business owner's first name. |
| 8 | LastName | (String) | Last name. |
| 9 | ResedentialCountryCode | (String) | Country of residence code. |
| 10 | StreetCode | (Int) | Street code. |
| 11 | CityCode | (Int) | City code. |
| 12 | ZipCode | (String) | Postal code. |
| 13 | HouseNumber | (String) | House number. |
| 14 | PhoneNumber1 | (String) | Phone number 1. |
| 15 | PhoneNumber2 | (String) | Phone number 2. |
| 16 | Fax | (String) | Business fax number. |
| 17 | (String) | Business email address. |
Response of Add Company for Meaged.
| No. | Parameter | Example possible values | Description |
| 1 | SapakStatus | "UnderTest" "InProcess" "Approved" "Blocked" "Error" | Supplier status. |
| 2 | SapakNumber | (Int) | Supplier number. |
| 3 | IsDevError | Boolean - true \ false. | Indicates whether there is a development error. |
| 4 | IsInputError | Boolean - true \ false. | Indicates whether there is an input error. |
| 5 | ResponseCode | (Int) | Response code. |
| 6 | Description | (String) | Description. |
| 7 | InputErrorPropName | (String) | Name of the property that caused the input error. |
Below is sample code for the function together with the response.
Request example:
{
"IsValidationOnly": "<boolean>",
"SupplierUserName": "<string>",
"Secret": "<string>",
"CompnayInfo": {
"BusinessRegistrationNumber": "<long>",
"NameLegalCorporation": "<string>",
"NameLegalCorporationEng": "<string>",
"Email": "<string>",
"PhoneNumber1": "<string>",
"ZipCode": "<string>",
"CityCode": "<integer>",
"StreetCode": "<integer>",
"AdvertisingSapakName": "<string>",
"AdvertisingSapakEngName": "<string>",
"PhoneNumber2": "<string>",
"HouseNumber": "<string>"
},
"PeopleInfo": [
{
"RelationType": "AuthorizedSignature",
"IdentityNumber": "<integer>",
"IdentityIssueDate_DDMMYYYY": "<string>",
"IdentityExpireDate_DDMMYYYY": "<string>",
"BirthDate_DDMMYYYY": "<string>",
"Gender": 1,
"FirstName": "<string>",
"LastName": "<string>",
"StreetCode": "<integer>",
"CityCode": "<integer>",
"PhoneNumber1": "<string>",
"ResedentialCountryCode": "<string>",
"ZipCode": "<string>",
"HouseNumber": "<string>",
"PhoneNumber2": "<string>",
"Fax": "<string>",
"Email": "<string>"
},
{
"RelationType": "AuthorizedSignature",
"IdentityNumber": "<integer>",
"IdentityIssueDate_DDMMYYYY": "<string>",
"IdentityExpireDate_DDMMYYYY": "<string>",
"BirthDate_DDMMYYYY": "<string>",
"Gender": 0,
"FirstName": "<string>",
"LastName": "<string>",
"StreetCode": "<integer>",
"CityCode": "<integer>",
"PhoneNumber1": "<string>",
"ResedentialCountryCode": "<string>",
"ZipCode": "<string>",
"HouseNumber": "<string>",
"PhoneNumber2": "<string>",
"Fax": "<string>",
"Email": "<string>"
}
],
"KycInfo": {
"Mcc": "<integer>",
"MaxNumberOfPayments": "<number>",
"ElectronicCommerceUrl": [
"<string>",
"<string>"
]
}
}
Example response:
{
"SapakStatus": "UnderTest",
"SapakNumber": 0,
"IsDevError": true,
"IsInputError": true,
"ResponseCode": 0,
"Description": "string",
"InputErrorPropName": "string"
}