Query Commands

Query Commands

QUERYORDERS

With this operation, it’s possible to get information about orders and their payment/credit status from the payment server.

Request Parameters

Table 1. Request Parameters
Required Parameters Optional Parameters

MERCHANTKEY

FOR

COMMAND

PAYMENTTYPE

ADMIN_PASSWORD

BATCHNUMBER

ORDERNUMBER

MINAMOUNT

MAXAMOUNT

CURRENCY

CREATEBEGINTIME

CREATEENDTIME

MODIFYBEGINTIME

MODIFYENDTIME

BRAND

SKIPFIRST

RETURNATMOST

ORDERBY

ORDERTEXT

ORDERREFERENCE

REFERENCENUMBER

APPLICATIONTYPE

ORIGINATOR

Example of Request Parameters
MERCHANTKEY=43gADp5.UOZxPTet6O8o8K6o-7RefQB3BO21OMu4chB65LJUI_&
COMMAND=QUERYORDERS&
ORDERNUMBER=1181521&
ADMIN_PASSWORD=9p3a0m5f&
APPLICATIONTYPE=S&

Response Parameters

Table 2. Response Parameters
Required Parameters Optional Parameters

status

errorCode

version

message

paySysMessage

originator

objectsTotal

orders

Order as a basis type of properties in the response can be returned for this command.
Example of Response Parameters
order.1.amount=1.00&
order.1.orderText=Test%3A0000&
order.1.contractNumber=Qenta_Test1&
order.1.merchantNumber=840&
order.1.depositAmount=0&
order.1.customerStatement=Test005&
order.1.providerContractNumber=Qenta_Test1&
order.1.orderNumber=1181521&
order.1.timeModified=31.08.2022+16%3A24%3A43&
objectsTotal=1&
order.1.approveAmount=0&
order.1.credits=0&
order.1.payments=0&
order.1.currency=EUR&
version=qtillserver+3.23.0.47&
order.1.state=ORDERED&
order.1.timeCreated=31.08.2022+16%3A24%3A43&
order.1.refundAmount=0&
order.1.orderDescription=Test%3A0000&orders=1&
order.1.paymentType=CREDITCARD&
order.1.brand=Verified+by+Visa&
order.1.acquirer=QENTA&
status=0

QUERYCREDITS

With this operation, it’s possible to get information about credit notes from the payment server.

Request Parameters

Table 3. Request Parameters
Required Parameters Optional Parameters

MERCHANTKEY

FOR

COMMAND

BATCHNUMBER

ADMIN_PASSWORD

CREDITNUMBER

ORDERNUMBER

MINAMOUNT

MAXAMOUNT

CURRENCY

CREATEBEGINTIME

CREATEENDTIME

MODIFYBEGINTIME

MODIFYENDTIME

SKIPFIRST

RETURNATMOST

ORDERBY

APPLICATIONTYPE

ORIGINATOR

Example of Request Parameters
MERCHANTKEY=43gADp5.UOZxPTet6O8o8K6o-7RefQB3BO21OMu4chB65LJUI_&
COMMAND=QUERYCREDITS&
ORDERNUMBER=16047605&
ADMIN_PASSWORD=9p3a0m5f&
APPLICATIONTYPE=S&

Response Parameters

Table 4. Response Parameters
Required Parameters Optional Parameters

status

errorCode

version

message

paySysMessage

originator

objectsTotal

credits

Credit notes as a basis type of properties in the response can be returned for this command.
Example of Response Parameters
order.1.1.brand=Verified+by+Visa&
order.1.1.operationsAllowed=REFUND&
credit.1.batchNumber=0&
credit.1.merchantNumber=840&
order.1.1.timeModified=16.09.2022+00%3A01%3A01&
credit.1.amount=0.00&
credit.1.timeCreated=16.09.2022+11%3A24%3A37&
credit.1.gatewayReferenceNumber=5bd058c5de434979a46a0c2fb844956a&
order.1.1.currency=EUR&credits=1&
credit.1.currency=EUR&
credit.1.creditNumber=2199841&
order.1.1.merchantNumber=840&
order.1.1.paymentType=CREDITCARD&
credit.1.state=credit_void&objectsTotal=1&
order.1.1.state=REFUNDABLE&
credit.1.orderNumber=16047605&
order.1.1.orderDescription=Test%3A0000&
version=qtillserver+3.23.0.47&
order.1.1.orderText=Test%3A0000&
credit.1.timeModified=16.09.2022+12%3A00%3A38&
order.1.1.contractNumber=Qenta_Test1&
order.1.1.acquirer=QENTA&
order.1.1.orderNumber=16047605&
order.1.1.timeCreated=15.09.2022+12%3A24%3A56&
credit.1.providerReferenceNumber=85e27fd12cdf48989c8ad73b6cb8244e&
order.1.1.amount=1.00&
order.1.1.customerStatement=Test005&
status=0

QUERYBATCHES

With this operation, it’s possible to obtain information about performed daily closings from the payment server.

Request Parameters

Table 5. Request Parameters
Required Parameters Optional Parameters

MERCHANTKEY

FOR

COMMAND

BATCHNUMBER

ADMIN_PASSWORD

STATE

ORDERNUMBER

MINTIMEOPENED

MAXTIMEOPENED

MINTIMECLOSED

MAXTIMECLOSED

ACCOUNTID

SKIPFIRST

RETURNATMOST

ORDERBY

APPLICATIONTYPE

ORIGINATOR

Example of Request Parameters
MERCHANTKEY=43gADp5.UOZxPTet6O8o8K6o-7RefQB3BO21OMu4chB65LJUI_&
COMMAND=QUERYBATCHES&
ORDERNUMBER=9365926&
ADMIN_PASSWORD=9p3a0m5f&
APPLICATIONTYPE=S&

Response Parameters

Table 6. Response Parameters
Required Parameters Optional Parameters

status

errorCode

version

message

paySysMessage

originator

objectsTotal

batches

Daily closing as a basis type of properties in the response can be returned for this command.
Example of Response Parameters
batchTotal.36.1.credits=0&
batch.372.state=closed&
batch.72.contractNumber=Qenta_Test1&
batch.21.acquirer=PayPal&
batch.7.brand=MasterCard+SecureCode&
batch.131.timeOpened=11.08.2022+00%3A29%3A50&
batch.5.timeClosed=16.09.2022+00%3A01%3A01&
batch.197.paymentType=CREDITCARD&
batchTotal.446.1.payments=16&
batch.159.merchantNumber=840&
batch.56.status=balanced&
batch.123.brand=MasterCard+SecureCode&
batch.307.merchantNumber=840&
batch.435.acquirer=QENTA&
batchTotal.27.1.credits=0&
batch.267.state=closed&
batch.335.contractNumber=28978%2F473003&
batchTotal.353.1.totalCreditAmount=0.00&
batchTotal.363.1.currency=EUR&
batch.275.brand=MasterCard+SecureCode&
batch.187.contractNumber=Qenta_Test1&
batch.454.timeOpened=17.02.2022+08%3A14%3A14&
batch.63.state=closed&
batchTotal.330.1.totalPaymentAmount=88.20&
batchTotal.387.1.totalCreditAmount=0.00&
batchTotal.13.1.totalPaymentAmount=3.00&
batchTotal.403.1.credits=0&
batch.44.merchantNumber=840&
batchTotal.150.1.currency=EUR&
batch.177.timeClosed=29.07.2022+00%3A00%3A55&
batch.449.brand=sofortueberweisung&
batch.318.status=balanced&
batch.260.timeClosed=29.06.2022+00%3A00%3A25&
batchTotal.115.1.totalPaymentAmount=7.40&
batch.218.acquirer=PayPal&
batchTotal.54.1.credits=0&
batch.402.brand=PayPal&
batchTotal.428.1.totalCreditAmount=0.00&
batchTotal.372.1.totalCreditAmount=0.00&
batchTotal.126.1.totalCreditAmount=0.00&
batch.372.contractNumber=Qenta_Test1&
batch.255.acquirer=SOFORT&
batchTotal.421.1.credits=0&
batchTotal.47.1.payments=5&
batch.207.timeClosed=17.07.2022+00%3A00%3A23&
batchTotal.375.1.totalPaymentAmount=1202.68&
batch.344.timeOpened=04.05.2022+00%3A29%3A37&
batchTotal.63.1.credits=0&
batchTotal.159.1.credits=0&
batch.293.status=balanced&
batch.326.state=closed&
batch.71.brand=EPS-SO&
batch.431.state=closed&
batch.351.timeOpened=28.04.2022+09%3A59%3A33&
batch.35.contractNumber=qenta+test&
batchTotal.226.1.payments=1&
batchTotal.351.1.credits=0&
batch.220.state=closed&