POSTInvoice Status Inquiry

Merchant merchants can query the status of the Invoices they collect by sending a POST request containing the following parameters to the "InvoiceCheck" method.

Service Address: /invoices/invoicecheck

Request

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
invoicePaymentId

zorunlu

integer It is the "InvoicePaymentId" value returned as a result of the collection process.

Request Sample
    { 
        "invoicePaymentId": 1786
    }

Response

Response Parameter
Parameter Name Parameter Type Explanation
Result boolen The result of a successful or unsuccessful query.
ResultCode integer The code that returns the query result.
ResultMessage string The description that returns as a result of the query.
invoiceDetail class It returns the details of the queried invoice.

InvoiceDetail Parameter
Parameter Name Parameter Type Explanation
invoicePaymentId integer It is the "InvoicePaymentId" value returned as a result of the collection process.
invoiceType string Bill type (Ex: Electricity Bill, Water Bill etc.)
sootName string Company Name
subscriberNo string It is the subscriber (installation) number on the invoice.
customerName string Subscriber's name and surname
invoiceNo string Invoice number
expDate string It is the last payment date of the invoice.
invoiceAmount decimal Amount of the invoice
profit decimal It is the service fee charged for the collection process.
paymentDate string It is the transaction date on which the collection is made.
status string Status of the invoice Status = Paid “Invoice Paid” Status = Cancelled “Invoice Canceled”

Response Sample
  {
         "invoiceDetail": {
         "invoicePaymentId": 1786,
         "invoiceType": "Su Faturası",
         "sootName": "İSKİ",
         "subscriberNo": "01345677000",
         "customerName": "DE*** ÖZ****",
         "invoiceNo": "0000000",
         "expDate": "10.05.2022",
         "invoiceAmount": 1.00,
         "profit": 0.50,
         "paymentDate": "10.05.2022",
         "status": "Paid"
    },
        "result": true,
        "resultCode": 1,
        "resultMessage": "İşlem Başarılı"
    }
  }