Header

Parameter Name	Parameter Type	Explanation
ApiKey Required	string	It is provided by the service provider . for Example ; 3f0126be-*-*-**-06025352594a
SecretKey Required	string	It is provided by the service provider . Örneğin ; 3f0126be-*-*-**-06025352594a

Body Parameter

Parameter Name	Parameter Type	Explanation
sootCode Required	integer	The code of the institution to be queried.
subscriberNo Required	string	It is the subscriber (installation) number on the invoice.
additionalNo Optional	string	It is the additional number of the invoice. Note: If there is no business code, it should be sent blank.
firmRefNo Required	string	It is the unique reference number created by the merchant. It should be a maximum of 15 characters.

Request Sample

    {
     "sootCode": 1,
     "subscriberNo": "1345677000",
     "additionalNo": "",
     "firmRefNo": "2021081617570"
    }

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.
invoiceList[]	array	The invoice debt list returns as an array.

InvoiceList Parameter

Parameter Name	Parameter Type	Explanation
invoiceQueryId	integer	The Id value of the invoice being queried. This value is the required field to be used in the payment process.
subscriberNo	string	It is the subscriber (installation) number on the invoice.
customerName	string	Subscriber's name and surname
invoiceNo	string	Invoice number
expDate	string	The last payment date of the invoice.
invoiceAmount	decimal	Amount of the invoice
merchantProfit	decimal	Service fee
totalAmount	decimal	Total amount
sootCode	integer	The code of the institution to be queried.

Response Sample

     {
         "invoiceList": [
        {
           "invoiceQueryId": 615202,
           "subscriberNo": "01345677000",
           "customerName": "DE*** ÖZ****",
           "invoiceNo": "0000000",
           "expDate": "10.05.2022",
           "invoiceAmount": 560.0,
           "merchantProfit": 2.00,
           "totalAmount": 562.00,
           "sootCode": 1
        }
    ],
        "result": true,
        "resultCode": 1,
        "resultMessage": "İşlem Başarılı"
     }