POSTList institutions by type / province

Lists institutions according to the given institution type code and province code. Filtering is done according to which of the province code and institution type code is provided in the request. If an empty JSON object is created, it returns all institutions.

Service: /invoices/sootListByType

Request

Header
Parameter Name Parameter Type Explanation
ApiKey

Required

 string API Key

Example ; 3f0126be-*-*-**-06025352594a

SecretKey

Required

 string API Key

Example ; 3f0126be-*-*-**-06025352594a

Body Parameter
Parameter Name Parameter Type Explanation
sootTypeCode

optional

 integer Institution Type Code (1: Electricity, 2: Water, 3: Natural Gas, 4: Telephone, 5: Internet, 6: Television, 7: Tax, 8: Social Security, 9: Other Institutions)
cityCode

optional

 integer Province code (license plate), institutions in TRNC should be queried as 200.

Request Sample
{
    "sootTypeCode": 2,
    "cityCode": 34
}

Response

Response Parameter
Parameter Name Parameter Type Explanation
Result boolean Result
ResultCode integer Result Code
ResultMessage string Result Message
sootList[] array Institution List

SootList Parameter
Parameter Name Parameter Type Explanation
sootCode integer Institution Code
sootName string Institution Name
invoiceType string Invoice Type
description string Description
payofinCommission string Payofin Commission Amount
totalCommission string Total Service Amount
fields model Fields

Fields Parameter
Parameter Name Parameter Type Explanation
title string Subscriber No/Installation No Title Information
description string Invoice description
mask string Specifies the length and character structure of the No/Installation No information
required boolean Specifies the necessity of the Subscriber No / Installation No field.
additionalNoRequired boolean Specifies the necessity of the Business Code / Additional No field
partialAmount boolean Provides information that the payment can be taken with partial collection.

Response Sample
{
      "result": true,
      "resultCode": 1,
      "resultMessage": "İşlem Başarılı"
      "sootList":
      [
        {
            "sootCode": 1,
            "sootName": "İSKİ",
            "invoiceType": "Su Faturası",
            "description": "",
            "payofinCommission": 1.00,
            "merchantProfit": 1.00,
            "fields": {
                "title": "Abone No",
                "description": "8 Haneli olarak Abone numarasını yazınız",
                "mask": "99999999",
                "required": true,
                "additionalNoRequired": false,
                "partialAmount": true
                }
         }
      ]
 }