POST Multiple Invoice Collection

Merchants can perform multiple invoice collections by providing a list of the invoice query numbers for the invoices they wish to pay together.

Service Address: /invoices/multipleinvoicepayment

Request

Header
Parameter Name Parameter Type Description
ApiKey string Required

Example: 3f0126be-*-*-**-06025352594a

SecretKey string Required

Example: 3f0126be-*-*-**-06025352594a

Body Parameter
Parameter Name Parameter Type Description
InvoiceQueryId

Required

integer It is the "invoiceQueryId" value returned in invoice query operations.
PartialAmount

Optional

integer The partial collection amount. The value to be sent must be an integer and must not exceed the invoice amount. It should be sent if a payment lower than the invoice amount will be made. Otherwise, it should not be sent. (Currently only available for ISKI payments.)

Request Sample
[
    {
        "InvoiceQueryId": 644178,
        "PartialAmount": 30
    },
    {
        "InvoiceQueryId": 644179
    }
]

Response

Response Parameter
Parameter Name Parameter Type Description
Result boolean Query result as successful or unsuccessful.
ResultCode integer The code returned as a result of the query.
ResultMessage string The explanation returned as a result of the query.
PayofinPaymentDetails class Returns the invoice details to be collected.

PayofinPaymentDetails Parameter
Parameter Name Parameter Type Description
InvoicePaymentId integer The collection Id value of the processed transaction. This value will be used in invoice verification processes.
Balance decimal The available balance remaining at the end of the collection process.
PaymentAmount decimal The debt amount collected.
Profit decimal The service fee charged for the collection process.
PaymentDate string Payment Date

Response Sample
[
    {
        "payofinPaymentDetails": {
            "invoicePaymentId": 3711,
            "balance": 50794.61,
            "paymentAmount": 496.00,
            "profit": 10.00,
            "paymentDate": "5.08.2024 10:33:19"
        },
        "result": true,
        "resultCode": 1,
        "resultMessage": "İşlem Başarılı"
    },
    {
        "payofinPaymentDetails": {
            "invoicePaymentId": 3712,
            "balance": 50714.61,
            "paymentAmount": 79.00,
            "profit": 1.00,
            "paymentDate": "5.08.2024 10:33:21"
        },
        "result": true,
        "resultCode": 1,
        "resultMessage": "İşlem Başarılı"
    }
]