מרכז הידע / ממשקים API

שאלו את ה-AI

✦ תשובת ה-AI

חושב…

מקורות

    CompanyOperations -(חייב לעבור על זה) לאמת שדות בית עסק - (Validate company fields)

    מתי להשתמש בפונקציה זו?

    מאמת שדות בית עסק.

    להלן קישור לפונקציה בJSON.

    שיטת בקשה - POST.
    Validate company fields

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

     

    להלן הפרמטרים שצרים להעביר בפונקציה Validate company fields.

    מקרא:

    פרמטר אדום - חובה

    פרמטר מודגש - מומלץ

    פרמטר לא אדום ולא מודגש - אופציונלי

     

    מספר
    פרמטר ערכים אפשריים לדוגמא תיאור
    1 DocumentsInfo מערך של אובייקטים.

    DocType:

    • "Id" – תעודה מזהה (כולם)

    • "Passport" – דרכון

    • "CertificateOfIncorporation" – תעודת רישום חברה (חברות בע"מ ועמותות)

    • "BankConfirmationOrPhotocopyOfCheck" – אישור בנק או צילום של צ'ק (כולם)

    • "AttorneysApprovalForAGovernmentCompany" – אישור עורך דין לחברה ממשלתית (חברות בע"מ ועמותות)

    • "AuthorizedAsAuthorizedToSign" – מורשה לחתום 

    • "AttorneysProtocolAuthorizedToSign" – פרוטוקול עורך דין למורשה לחתום (חברות בע"מ ועמותות)

    • "BookkeepingAuthorization" – אישור הנהלת חשבונות

    • "AnotherCertificateForAForeignResident" – תעודה נוספת לתושב חוץ

    • "LicenseWorkPermitCertificateForABusiness" – רישיון / אישור עבודה לעסק

    • "DeclarationOfBeneficiaries" – הצהרת נהנים (כולם)

    • "ADocumentIndicatingTheCorrectAddressOfTheCompany" – מסמך המעיד על כתובת החברה הנכונה

    • "FaceToFaceRecognitionVideoFile" – קובץ וידאו לזיהוי פנים

    -----

    Name - (String)

    ----

    Content - (String)

    DocType- סוג מסמך שמעבירים.

    ----

    Name - השם בעליו מעבירים את המסמך.

    ---

    Content - תיאור לשם קובץ

     

    ערכים של AcquiredCompanyAccount (2).

    אובייקט.

    מספר
    פרמטר ערכים אפשריים לדוגמא תיאור
    1 SupplierUserName (String) שם משתמש של הספק.
    2 SupplierPassword (String) סיסמה של הספק.
    3 Secret (String) סוד ?
    6 TerminalInfo - אובייקט

    BankCode - (String)

    ----

    BankBranchCode - (String)

    ----

    BankAccountNumber - (String)

    ----

    ModuleList מערך של פרמטר ModuleID

    BankCode - קוד בנק.

    BankBranchCode - קוד סניף.

    BankAccountNumber - מספר חשבון בנק.

    ModuleList - מערך של מזהים של מודלים.

     

    ערכים של CompanyInfo (2.4).

    אובייקט מקונן בתוך AcquiredCompanyAccount.

     

    מספר
    פרמטר ערכים אפשריים לדוגמא תיאור
    1 Activity (String) תחום בית עסק.
    2 BusinessRegistrationNumber (String) מספר ת''ז או ח''פ של בית העסק.
    3 ContactPerson (String) איש קשר.
    4 Email (String) אימייל בית עסק.
    5 Name (String) שם בית עסק.
    6 Fax (String) פקס בית עסק.
    7 PhoneNumber (String) מספר טלפון קווי.
    8 MobilePhone (String) מספר טלפו נייד.
    9 ZipCode (String)  מספר מיקוד. 
    10 IsVatFreeCompany  Boolean - true \ false האם הבית עסק מלכ''ר? 
    11 Citizenship

    "Unknown" – לא ידוע

    "Israel" – ישראל

    "Expatriate" – תושב זר

    "ResidentArea" – אזור מגוריו

     אזרחות של הבית עסק.
    12 CompanyInternalID (String)  מספר פנימי של הבית עסק.
    13 NameEng (String)   שם הבית עסק באנגלית.
    14 CityCode  (Int)  קוד עיר.
    15 StreetCode (Int) קוד רחוב. 
    16 HouseNumber (String)  מספר בית. 
    17 WebSiteUrl (String)  כתובת URL של האתר בית עסק. 
    18 Entrance (String)  מספר כניסה בבניין.
    19 CountryCode (Int)  קוד מדינה.
    20 NameLegalCorporation (String)  השם החוקי של בית העסק. 
    21 AgreementInfo - אובייקט AgreementId - (Int) מספר הסכם של הספק מול קארדקום

     

    ערכים של UserInfo (2.5).

    אובייקט מקונן בתוך AcquiredCompanyAccount.

    מספר
    פרמטר ערכים אפשריים לדוגמא תיאור
    1 StreetCode  (Int) קוד רחוב.
    2 CityCode  (Int) קוד עיר.
    3 Email (String) אימייל בית עסק.
    4 IdentityNumber (String) מספר ת''ז.
    5 LogInName (String) שם משתמש לכניסה למערכת של קארדקום.
    6 LogInPassword (String) סיסמת לכניסה למערכת של קארדקום.
    7 FirstName (String) שם פרטי של בעל העסק.
    8 Fax (String)  פקס בית עסק. 
    9  PhoneNumber (String)  מספר טלפון קווי של בית העסק. 
    10 MobilePhone (String)  מספר טלפון נייד. 
    11 ZipCode (String)   קוד מיקוד.
    12  LastName (String)  שם משפחה. 
    13 BirthDate (String)  תאריך לידה. 
    14  Gender "Unknown" "male" "female" מגדר. 
    15 IdentityIssueDate (String)  תאריך הפקת ת''ז.
    16  PassportIssueCountryCode  (Int) קוד מדינת הוצאת הדרכון.
    17 IdIssueDateOrPassportIDTypes "IDNumber" "Passport" סוגי תעודות זהות דרכון.
    18 PersonalIdentificationCode (String) קוד זיהוי אישי.

     

    ערכים של KycInfoGeneric (2.7.1).

    אובייקט מקונן בתוך KycInfo שנמצא בתוך AcquiredCompanyAccount.

    מספר
    פרמטר ערכים אפשריים לדוגמא תיאור
    1 CountriesTargetedMarket (String) טקסט חופשי עד 250 תווים, עבור איזה מדינות המוצר מיועד
    2 NamesOfRelatedBusinesses (String) טקסט חופשי עד 250 תווים, רשימת העסקים הקשורים – המשך לשדה הקודם במידה וסימנו בו TRUE
    3

    ExpectedPercentagePayment

    OfOnePayment

     (Number) אחוז עסקאות צפוי של תשלום אחד
    4

    ExpectedPercentageOf

    PaymentTransactions

     (Number) אחוז עסקאות צפוי של עסקאות תשלומים
    5

    ExpectedPercentageOfCredit

    PaymentTransactions

     (Number) אחוז עסקאות צפוי של תשלומי קרדיט
    6

    ExpectedPercentageOf

    TouristTransactions

     (Int) אחוז עסקאות צפוי של עסקאות תייר
    7

    ExpectedPaymentNumber

    ForAverageTransaction

     (Int) הצפי לעסקה ממוצעת מבחינת מספר תשלומים. שדה שמקבל מספר שלם
    8 SalePlatform

    (String) - 

    PhysicalSale" – מכירה פיזית

    "Phone" – טלפון

    "Web" – אינטרנט

    "LandingPage" – דף נחיתה

    באיזה פלטפורמה המכירה צפויה להתבצע - לא בשימוש שדה שמקבל מספר שלם
    9  SalePlatforms - מערך של (String)  [(String),(String)] באיזה פלטפורמות המכירות צפויות להתבצע [שדה שמקבל רשימה של מספרים שלמים מהצורה [0,1,2 PhysicalSale = 0, Phone = 1, Web = 2, LandingPage = 3,
    10 IsPaymentsFacilitator  Boolean - true \ false ריכוז חיובים של ספקים אחרים – האם הלקוח הוא לקוח מאגד
    11

    IsBusinessFacilitate

    CashWithdrawls

     Boolean - true \ false האם הלקוח מאפשר משיכת מזומן בקופה?
    12 

    IsBusinessFacilitateVoucherOr

    RechargingCardsSales

     Boolean - true \ false  האם הלקוח מאפשר מכירת שוברים/כרטיסים נטענים/כרטיסי מתנה?
    13

    IsBusinessFacilitateCreditFor

    TransactionsOutsideBusinessScope

     Boolean - true \ false  האם הלקוח נותן אשראי שלא למטרת קנייה בחנות?
    14 

    IsBusinessPlaceCashRegisters

    InOtherBusinesses

     Boolean - true \ false  הצבת קופות בבתי עסק אחרים?
    15 TypeOfPlannedService (String) מה הוא סוג השירות המתוכנן?
    16 

    MinimumAmountOf

    CreditTransaction

     (Int) מהו הסכום המינימלי לעסקה בכרטיס אשראי?
    17

    MaximumAmountOf

    CreditTransaction

     (Int)  מהו הסכום המקסימלי לעסקה בכרטיס אשראי?
    18 IsTheBusinessSeasonal  Boolean - true \ false האם העסק בעיקר פועל בעונה מסוימת של השנה?
    19

    IsTheBusinessPreviously

    ClearedCreditCards

     Boolean - true \ false  האם העסק סלק בעבר כרטיסי אשראי ?
    20

    NumberOfYearsBusiness

    HasInClrearance

     (Int) כמה שנות ניסיון יש לעסק בתחום הסליקה? 
    21

    ExpectedStoreSupply

    DeliverySchedule

    (String) enum 

    "Immediate" – מיידי

    "Late" – מאוחר

    "Continuous" – מתמשך

    משך זמן האספקה הצפוי למוצרי החנות?
    22 TimeTillProductShips  (Int) enum  משך זמן האספקה הצפוי למשלוח?
    ערכים אפשריים:
    0 = מיידי
    1 = 1-7 ימים
    2 = 8 - 14 ימים

    3 = מעל 14 ימים
    23

    AvarageTransaction

    AmountInCreditCard

     (Int) מהו הסכום הממוצע לעסקה בכרטיס אשראי?
    24

    EstimatedMonthly

    TransactionAmount

     (Int) מספר עסקאות חודשי משוער
    25

    IsBusinessBeenDeniedAction

    VersusBankingCorporation

     Boolean - true \ false האם בית עסק סורב בעבר לפעילות אל מול תאגיד בנקאי
    26 GeneralBusinessFieldMccCode  (Int) תחום עיסוק כללי
    27 SpecifiedBusinessFieldMccCode  (Int) תחום עיסוק מפורט
    28 TypeOfRecruitment

    (String)

    "Independent" – עצמאי

    "Telephone" – טלפון

    "UsingARemoteRepresentative" – שימוש בנציג מרחוק

    דרך הגיוס

     

    ערכים של KycInfoOsekMurshe (2.7.2).

    אובייקט מקונן בתוך KycInfo שנמצא בתוך AcquiredCompanyAccount.

    מספר
    פרמטר ערכים אפשריים לדוגמא תיאור
    1

    IsOwnerAddressDifferent

    FromBusinessAddress

    Boolean - true \ false האם כתובת המגורים של הבעלים שונה מכתובת העסק
    2 BusinessOwnerHomeNumber (String) מספר הבית בכתובת המגורים של בעל בית העסק
    3 BusinessOwnerEntranceNumber (String) כניסה בכתובת המגורים של בעל בית העסק
    4 BusinessOwnerStreetCode  (Int) קוד רחוב בכתובת המגורים של בעל בית העסק
    5 BusinessOwnerCityCode  (Int) קוד עיר בכתובת המגורים של בעל בית העסק
    6 BusinessOwnerZipCode (String) מיקוד בכתובת המגורים של בעל בית העסק
    7 MotherMaidenName (String) שם משפחה של האם לפני הנישואין

     

    RESPONSE של Validate company fields.

    מספר
    פרמטר ערכים אפשריים לדוגמא תיאור
    1 ResponseCode 0 קוד תשובה, אם שווה לאפס הפונקציה בוצעה בצורה תקינה. בכל תשובה אחרת, הפעולה לא הייתה תקינה.
    2 Description "OK" תיאור התשובה. ''OK'' זה טוב.
    3

    DocumentsErrorResults

    מערך של אובייקטים.

    PropertyName - "שם העסק"

     

    Response - (STRING)

    PropertyName - שם בית עסק.

    Response -תשובה

    4

    KycErrorResults

    מערך של אובייקטים.

    PropertyName - "שם העסק"

     

    Response - (STRING)

    PropertyName - שם בית עסק.

    Response - תשובה

    5

    CompanyErrorResults

    מערך של אובייקטים.

    PropertyName - "שם העסק"

     

    Response - (STRING)

    PropertyName - שם בית עסק.

    Response - תשובה

    6

    UserErrorResults

    מערך של אובייקטים.

    PropertyName - "שם העסק"

     

    Response - (STRING)

    PropertyName - שם בית עסק.

    Response - תשובה

    7

    CompanyInternalID

    21348 מספר בית עסק פנימי.
    8

    TerminalNumber

    1000 מספר מסוף.
    9 APIUserName "test2025" שם משתמש API של הבית עסק.
    10 APISecret "test5000$" סיסמת API של בית העסק.
    11

    ModulesList

    מערך של strings.

    "הוראת קבע" דפי נחיתה" פרופיל נמוך" מערך של strings עם שמות המודלים.
    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 מספר תשובה.
    13 IsDone boolean - true \ false האם בוצע?

     

    להלן קוד לדוגמא לפונקציה ביחד עם התשובה.

    דוגמא לקריאה:

    {
      "DocumentsInfos": [
        {
          "DocType": "Id",
          "Name": "string",
          "Content": "string"
        }
      ],
      "AcquiredCompanyAccount": {
        "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"
          }
        }
      }
    }

    דוגמא לתשובה המתקבלת:

    {
      "ResponseCode": 0,
      "Description": "string",
      "DocumentsErrorResults": [
        {
          "PropertyName": "string",
          "Response": "string"
        }
      ],
      "KycErrorResults": [
        {
          "PropertyName": "string",
          "Response": "string"
        }
      ],
      "CompanyErrorResults": [
        {
          "PropertyName": "string",
          "Response": "string"
        }
      ],
      "UserErrorResults": [
        {
          "PropertyName": "string",
          "Response": "string"
        }
      ],
      "CompanyInternalID": "string",
      "TerminalNumber": 0,
      "APIUserName": "string",
      "APISecret": "string",
      "ModulesList": [
        "string"
      ],
      "Request": 100,
      "IsDone": true
    }

     

    האם המאמר הזה עזר לך?