POSTCalculate Payable Amount Service

The service where the total amount to be withdrawn from the customer card is obtained in bill collection transactions to be made with virtual pos or hidden card.

Note: If the "partialAmount" parameter is sent, the amount here is included in the calculation (only valid for partially collectible invoices). If not sent, the invoice amount is included in the calculation.

serviceAddress: /invoices/calculateamountpayable

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.

for example; 3f0126be-****-****-****-06025352594a

Body Parameter
Parameter Name Parameter Type Explanation
invoicePaymentList

required

 ListArray Invoice payment data

InvoicePaymentList Details
Parameter Name Parameter Type Explanation
invoiceQueryId

required

 integer The Id value of the invoice being queried
partialAmount

optional

 integer Partial collection amount. The value to be sent must be an integer (int) and must not be larger than the invoice amount.

Request Sample
 {
        "invoicePaymentList": [
        {
            "invoiceQueryId": 615198,
            "partialAmount": 150
        },
        {
            "invoiceQueryId": 615199
        },
        {
            "invoiceQueryId": 615200
        }
 }

Response

Response Parameter
Parameter Name Parameter Type Explanation
totalInvoiceAmount decimal The total invoice amount.
totalServiceFee decimal The total service fee.
totalCardCommission decimal The total card commission amount.
generalTotal decimal The general total.
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.

Response Sample
     {
            "totalInvoiceAmount": 209.00,
            "totalServiceFee": 6.00,
            "totalCardCommission": 4.73,         
            "generalTotal": 219.73,
            "result": true,
            "resultCode": 1,
            "resultMessage": "İşlem Başarılı",
     }