GETInstitution List Inquiry
Member Businesses can query the list of institutions from which they can collect by calling the "SootList" method with the GET method.This method returns a list of all institutions open to the firm's use, with their details.
Service Address: /invoices/sootlist
Request
Header
Parameter Name | Parameter Type | Explanation |
---|---|---|
ApiKey
|
string | It is provided by the service provider .
|
SecretKey
|
string | It is provided by the service provider .
|
Response
Response Parameter
Parameter Name | Parameter Type | Explanation |
---|---|---|
Result | boolean | The result of a successful or unsuccessful query. |
ResultCode | integer | This is the code that returns the query result. |
ResultMessage | string | The description that returns as a result of the query. |
sootList[] | array | Institutions return information in the form of an array. |
SootList Parameter
Parameter Name | Parameter Type | Explanation |
---|---|---|
sootCode | integer | The code of the institution to be queried. |
sootName | string | The name of the institution to be questioned. |
invoiceType | string | Bill type (Ex: Electricity Bill, Water Bill etc.) |
description | string | Description field. |
fields | model | Institution detail |
Fields Parameter
Parameter Name | Parameter Type | Explanation |
---|---|---|
title | string | Subscriber No/Installation No Header Information |
description | string | Invoice description |
mask | string | Number/Wiring Number information indicates length and character structure. |
required | boolean | Indicates the requirement of the Subscriber Number / Installation Number field. |
additionalNoRequired | boolean | Business Code / Supplementary Number indicates the requirement of the field. |
partialAmount | boolean | Indicates that the payment can be received with partial collection. |
Response Sample
{ "result": true, "resultCode": 1, "resultMessage": "İşlem Başarılı" "sootList": [ { "sootCode": 1, "sootName": "İSKİ", "invoiceType": "Su Faturası", "description": "", "fields": { "title": "Abone No", "description": "8 Haneli olarak Abone numarasını yazınız", "mask": "99999999", "required": true, "additionalNoRequired": false, "partialAmount": true } } ] }