POSTCollecting Invoice Debt

Merchant merchants can make invoice collections with virtual pos by sending a POST request containing the following parameters to the "InvoicePaymentVpos" method.

Service address: /invoices/invoicepaymentvpos

Request

Header
Parameter Name Parameter Type Description
ApiKey

Required

 string It is provided by the service provider .

Example; 3f0126be-*-*-**-06025352594a

SecretKey

Required

 string It is provided by the service provider .

Example ; 3f0126be-*-*-**-06025352594a

Body Parameter
Parameter Name Parameter Type Description
InvoiceQueryList

Required

 List It is the "invoiceQueryId" value returned in invoice query operations.
CardData

Required

 Class It is the parameter class to which the card information will be transmitted.

InvoiceQueryList Details
Parameter Name Parameter Type Description
invoiceQueryId

Required

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

optional

 integer Partial Collection Amount.The value to be sent must be an integer. must be (int) and must not be larger than the invoice amount. If a payment is less than the invoice amount, it must be sent. It should not be sent otherwise. (Currently, it can only be used for İSKİ payments.)
CardDara Details
Parameter Name Parameter Type Description
cardHolderName

Required

 string Cardholder name
cardNo

Required

 string Card number (16 digits must be sent.)
expDate

Required

 string Kartın son kullanma tarihi (mm/yy)
cvv

Required

 string Security number of the card
installment

Required

 integer Taksit sayısı
callBackUrl

Required

 string The url information to which the payment result will be sent at the end of the 3D verification
Request Sample
{
    "invoiceQueryList": [
        {
            "invoiceQueryId": 10307,
            "partialAmount": 5
        },
        {
            "invoiceQueryId": 10306
        }
    ],
    "cardData": {
        "cardHolderName": "Test User",
        "cardNo": "4508034508034509",
        "expDate": "12/26",
        "cvv": "000",
        "installment": 1,
        "callBackUrl": "https://merchant-test.payofin.com/vpostest"
    }
}

Response

Response Parameter
Parameter Name Parameter Type Description
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.
VPosPaymentData class Returns the invoice detail to be collected.

VPosPaymentData Parameter
Parameter Name Parameter Type Description
PaymentUrl string 3D sayfasına yönlenledirme yapalacak url bilgisi
InvoiceAmount decimal Komisyon dahil toplam fatura tutarı

Response Sample
{
    "Result": true,
    "ResultCode": 1,
    "ResultMessage": "İşlem Başarılı",
    "VPosPaymentData": {
    "PaymentUrl": "https://merchant-test.parafix.com.tr/payment-threed-T0JJT1BybTFZZW1iTXhxb3h6M2VWQ0R0RG4xMldxMVFYcTcrVTBNZW9hZz0=",
    "InvoiceAmount": 6.50
    }
}
3D Response
It is mailed to the address specified in the "callBackUrl" parameter, which requests a shipment containing the 3D process completion details. Announcement of the detail information of the sent mail content.

3D Response Parameter
Parameter Name Parameter Type Description
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.
PaymentDetails JSON Array Returns the invoice detail to be collected.
Token string Token information of the payment transaction. It is used to verify that the payment response is received by the service provider. Please check the Token Check page to verify the token information

PaymentDetails JSON Array Parameter
Parameter Name Parameter Type Description
InvoiceQueryId integer Invoice inquiry number to which payment request is sent
InvoicePaymentId integer The collection Id of the transaction that was paid for. This value will be used in invoice control processes.
Balance decimal It is the available balance amount remaining at the end of the collection process.
PaymentAmount decimal It is the amount of debt collected.
Profit decimal It is the service fee charged for the collection process.
PaymentDate string Payment Date
Response Sample
 Result : true
 ResultCode : 1
 ResultMessage : Kart çekim işlemi başarıyla tamamlanmıştır.
 PaymentDetails : [
    {
        "InvoiceQueryId": 10311,
        "InvoicePaymentId": 1280,
        "Balance": 61.72,
        "PaymentAmount": 5.00,
        "Profit": 0.50,
        "PaymentDate": "04.01.2022 15:13:43"
    }
]
Token : 93cb6bfe737331a6de86c17cf4218a9adee12397d9d24f1b451bc6b17f301d71