CompanyOperations - Request Merchant Status (Get Company Status - Validate KYC Info)
When should this function be used?
Dealers who want to retrieve information about a merchant associated with them, such as the API username and password, the merchant's enabled modules, or the merchant's status and documents, can use this function.
Below is a link to the function in JSON.
https://secure.cardcom.solutions/api/v11/CompanyOperations/GetCompanyStatus
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 values | Description |
| 1 | terminalNumber | 1000 | The merchant's terminal number. |
Response for Get company status - Validate KYC info.
| No. |
Parameter | Example values | Description |
| 1 | ResponseCode | 0 | Response code. If it equals zero, the function was executed successfully. Any other value indicates that the operation failed. |
| 2 | Description | "OK" | Description of the response. "OK" indicates success. |
| 3 | DocumentsErrorResults Array of objects. |
PropertyName - "Omelet Sandwich in Netanya"
Response - (STRING) |
PropertyName - Merchant name. Response - Response |
| 4 | KycErrorResults Array of objects. |
PropertyName - "Omelet Sandwich in Netanya"
Response - (STRING) |
PropertyName - Merchant name. Response - Response |
| 5 | CompanyErrorResults Array of objects. |
PropertyName - "Omelet Sandwich in Netanya"
Response - (STRING) |
PropertyName - Merchant name. Response - Response |
| 6 | UserErrorResults Array of objects. |
PropertyName - "Omelet Sandwich in Netanya"
Response - (STRING) |
PropertyName - Merchant name. Response - Response |
| 7 | CompanyInternalID | 21348 | Internal merchant ID. |
| 8 | TerminalNumber | 1000 | Terminal number. |
| 9 | APIUserName | "test2025" | The merchant's API username. |
| 10 | APISecret | "test5000$" | The merchant's API password. |
| 11 | ModulesList Array of strings. |
"Standing Orders" "Payment Pages" "Low Profile" | List of modules. |
| 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 | Request number. |
| 13 | IsDone | boolean - true / false | Has the process been completed? |
Below is sample code for the function, together with the response.
Request example:
Example response: