Knowledge Base / API
עברית

Ask AI

✦ AI answer

Thinking…

Sources

    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.ParameterExample possible valuesDescription
    1IsValidationOnlyBoolean - true \ false 
    2SupplierUserName(String)Supplier username.
    3Secret(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.ParameterExample possible valuesDescription
    1BusinessRegistrationNumber(String)?
    2NameLegalCorporation(String)Legal business name.
    3NameLegalCorporationEng(String)Legal business name in English.
    4Email(String)Business email address.
    5AdvertisingSapakName(String)Company name displayed to the cardholder.
    6AdvertisingSapakEngName(String)Company name displayed to the cardholder in English.
    7PhoneNumber1(String)Phone number 1.
    8PhoneNumber2(String)Phone number 2.
    9ZipCode(String)Postal code.
    10CityCode(Int)City code.
    11StreetCode(Int)Street code.
    12HouseNumber(String)House number.

     

    Values of the PeopleInfo object (5).

    No.ParameterExample possible valuesDescription
    1RelationType

    "AuthorizedSignature"

    "AuthorizedSignatureForeignResident"

    Relationship type: AuthorizedSignature – authorized signatory; AuthorizedSignatureForeignResident – authorized signatory who is a foreign resident.
    2IdentityNumber(String)ID number.
    3IdentityIssueDate_DDMMYYYY(String)ID issue date (DDMMYYYY).
    4IdentityExpireDate_DDMMYYYY(String)ID expiration date (DDMMYYYY).
    5BirthDate_DDMMYYYY(String)Date of birth (DDMMYYYY).
    6Gender"Unknown" "male" "female"Gender.
    7FirstName(String)Business owner's first name.
    8LastName(String)Last name.
    9ResedentialCountryCode(String)Country of residence code.
    10StreetCode(Int)Street code.
    11CityCode(Int)City code.
    12ZipCode(String)Postal code.
    13HouseNumber(String)House number.
    14PhoneNumber1(String)Phone number 1.
    15PhoneNumber2(String)Phone number 2.
    16Fax(String)Business fax number.
    17Email(String)Business email address.

     

    Response of Add Company for Meaged.

    No.ParameterExample possible valuesDescription
    1SapakStatus

    "UnderTest" "InProcess"

    "Approved" "Blocked" "Error"

    Supplier status.
    2SapakNumber(Int)Supplier number.
    3IsDevErrorBoolean - true \ false.Indicates whether there is a development error.
    4IsInputErrorBoolean - true \ false.Indicates whether there is an input error.
    5ResponseCode(Int)Response code.
    6Description(String)Description.
    7InputErrorPropName(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"
    }

    Was this article helpful?