Payolution
Payolution
Payolution (part of Unzer) offers invoice payments for the Austrian, German, and Swiss online markets. The currency used has to be EUR.
The consumer must be older than 18 years of age, the billing address and the delivery address must be the same and the order amount must not be below or exceed the limits as contractually agreed with payolution. The delivery country must be accepted by payolution. Gift vouchers must be excluded and may not be purchased via invoice or installment.
| The title of this payment method to be displayed in the shop may be freely chosen during shop plugin configuration. Since payolution is a white-label product it’s recommended to choose a neutral title such as "invoice". |
Payolution will communicate the required live data to merchants only after the final tests of the integration were successfully completed and the entire installation was found adequate.
Commands
Pre Transaction Commands
The first step is to generate a unique order number with the command CREATEORDER.
Transaction Commands
INITIATEPAYMENT
Request Parameters
| Required Parameters | Optional Parameters | ||
|---|---|---|---|
|
|||
|
|||
| Required Parameters | ||
|---|---|---|
Optional Parameters |
||
|
||
|
Optional request parameters CUSTOMERSTATEMENT and ORDERREFERENCE, are more restricted about their length and allowed characters than usual.
Response Parameters
| Required Parameters | Optional Parameters |
|---|---|
Additional Response Parameters
| Parameter | State | Data type | Descritpion |
|---|---|---|---|
|
Success |
Alphanumeric with special characters, up to 255. |
Technical reference number of the payment processing at QENTA. |
|
Success |
Alphanumeric with special characters, up to 255. |
Reference number of the invoice. |
gatewayReferenceNumber |
|
|---|---|
Data |
Value |
State |
Success |
Data type |
Alphanumeric with special characters, up to 255. |
Description |
Technical reference number of the payment processing at QENTA. |
|
|
Data |
Value |
State |
Success |
Data type |
Alphanumeric with special characters, up to 255. |
Description |
Reference number of the invoice. |
Initialization example
Payolution payment method can be initialized if the merchant sends INVOICE for parameter INITTYPE.
|
-
Send a request.
Example of Request for InitiationCOMMAND=INITIATEPAYMENT& MERCHANTKEY=[noTestMerchantKeyAvailable]& INITTYPE=INVOICE& ORDERNUMBER=15588820& LANGUAGE=en& AMOUNT=1& CURRENCY=EUR& SERVICEURL=http://yourimprint.com/& ORDERDESCRIPTION=Test:0000& CONSUMER_BIRTH_DATE=2000-09-01& CONSUMER_EMAIL=test@qenta.com& CONSUMER_IP_ADDRESS=195.34.137.202& CONSUMER_BILLING_FIRST_NAME=Qenta& CONSUMER_BILLING_LAST_NAME=Tester& CONSUMER_BILLING_CITY=Graz& CONSUMER_BILLING_ZIP_CODE=8020& CONSUMER_BILLING_COUNTRY=AT& CONSUMER_BILLING_ADDRESS_1=Reininghausstraße 10& APPLICATIONTYPE=S& -
The response looks like this:
Example of Response for Initiationversion=qtillserver+3.23.0.47& status=0
VERIFYPAYMENT
Response Parameters
| Required Parameters | Optional Parameters | ||
|---|---|---|---|
|
Verifying payment example
-
Send a request.
Request ParametersMERCHANTKEY=[noTestMerchantKeyAvailable]& COMMAND=VERIFYPAYMENT& APPLICATIONTYPE=S& ORDERNUMBER=8704489& LANGUAGE=en& -
The response looks like this:
Response Parametersorder.1.amount=1.00& payment.1.1.paymentNumber=8704489& payment.1.1.depositAmount=1.00& order.1.orderText=Test%3A0000& order.1.contractNumber=72ee7187-cf31-4aae-9773-20d6bec114af& payment.1.1.timeModified=31.10.2022+13%3A20%3A28& payment.1.1.paymentType=PAYOLUTION& order.1.merchantNumber=840& payment.1.1.state=payment_deposited& order.1.depositAmount=1.00& order.1.customerStatement=Test005& order.1.providerContractNumber=72ee7187-cf31-4aae-9773-20d6bec114af& order.1.timeModified=31.10.2022+13%3A20%3A28& payment.1.1.providerReferenceNumber=8704489& order.1.orderNumber=8704489& payment.1.1.gatewayReferenceNumber=8704489& payment.1.1.orderNumber=8704489& payment.1.1.approveAmount=1.00& order.1.approveAmount=0& order.1.credits=0& payment.1.1.merchantNumber=840& order.1.payments=1& order.1.currency=EUR& version=qtillserver+3.23.0.48& order.1.refundAmount=0& payment.1.1.currency=EUR& order.1.timeCreated=31.10.2022+13%3A20%3A27& order.1.state=ORDERED& order.1.orderDescription=Test%3A0000& orders=1& payment.1.1.timeCreated=31.10.2022+13%3A20%3A28& payment.1.1.batchNumber=300006200& order.1.acquirer=payolution& order.1.paymentType=PAYOLUTION& order.1.brand=Invoice& status=0
Post Transaction Commands
GETORDERDETAILS
Response Parameters
| Required Parameters | Optional Parameters | ||
|---|---|---|---|
|
Getting order details example
-
Send a request.
Request ParametersMERCHANTKEY=[noTestMerchantKeyAvailable]& COMMAND=GETORDERDETAILS& ORDERNUMBER=15588820& ADMIN_PASSWORD=9p3a0m5f& APPLICATIONTYPE=S& -
The response looks like this:
Response Parametersorder.1.amount=1.00& payment.1.1.paymentNumber=15588820& payment.1.1.depositAmount=1.00& order.1.orderText=Test%3A0000& order.1.contractNumber=72ee7187-cf31-4aae-9773-20d6bec114af& payment.1.1.timeModified=31.10.2022+13%3A20%3A28& payment.1.1.paymentType=PAYOLUTION& order.1.merchantNumber=840& payment.1.1.state=payment_deposited& order.1.depositAmount=1.00& order.1.customerStatement=Test005& order.1.providerContractNumber=72ee7187-cf31-4aae-9773-20d6bec114af& order.1.orderNumber=15588820& order.1.timeModified=31.10.2022+13%3A20%3A28& payment.1.1.providerReferenceNumber=15588820& payment.1.1.gatewayReferenceNumber=15588820& payment.1.1.orderNumber=15588820& objectsTotal=1& payment.1.1.approveAmount=1.00& order.1.approveAmount=0& order.1.credits=0& payment.1.1.merchantNumber=840& order.1.payments=1& order.1.currency=EUR& version=qtillserver+3.23.0.48& order.1.state=ORDERED& order.1.timeCreated=31.10.2022+13%3A20%3A27& payment.1.1.currency=EUR& order.1.refundAmount=0& rder.1.orderDescription=Test%3A0000& orders=1& payment.1.1.timeCreated=31.10.2022+13%3A20%3A28& order.1.paymentType=PAYOLUTION& order.1.brand=Invoice& order.1.acquirer=payolution& payment.1.1.batchNumber=300006200& status=0
DEPOSIT
The transaction can be deposited:
-
By using the command DEPOSIT (see an example!).
When the payment of a certain amount is authorized, some financial service providers offer a one-off deposit of less than the authorized amount. If e.g. the price of the item the consumer ordered is reduced.
| Split capture is possible only for invoices and it must be enabled by payolution and by our integration specialists. |
Deposit example
-
Send a request.
Request ParametersCOMMAND=DEPOSIT& MERCHANTKEY=[noTestMerchantKeyAvailable]& ORDERNUMBER=15588820& PAYMENTNUMBER=15588820& LANGUAGE=en& AMOUNT=1& CURRENCY=EUR& APPLICATIONTYPE=S& -
The response looks like this:
Response Parametersversion=qtillserver+3.23.0.48& paymentNumber=15588820& status=0
APPROVEREVERSAL
| For using the command APPROVEREVERSAL, payment needs to be in an approved state. Look at the order flow diagram of the payment method for closer information. |
Approve Reversal example
-
Send a request.
Request ParametersCOMMAND=APPROVEREVERSAL& MERCHANTKEY=[noTestMerchantKeyAvailable]& ORDERNUMBER=8704489& PAYMENTNUMBER=8704489& ADMIN_PASSWORD=9p3a0m5f& LANGUAGE=en& APPLICATIONTYPE=S -
The response looks like this:
Response Parametersversion=qtillserver+3.23.0.47& status=0
REFUND
Request Parameters
| Required Parameters | Optional Parameters | ||
|---|---|---|---|
|
Refunding example
-
Send a request.
Request ParametersMERCHANTKEY=[noTestMerchantKeyAvailable]& COMMAND=REFUND& ORDERNUMBER=15588820& CURRENCY=EUR& AMOUNT=1.00& ADMIN_PASSWORD=9p3a0m5f& APPLICATIONTYPE=S& LANGUAGE=en -
The response looks like this:
Response ParameterscreditNumber=14995999& version=qtillserver+3.23.0.48& status=0
Query Commands
For every payment method commands QUERYORDERS, QUERYCREDITS and QUERYBATCHES are used.
Order Flow Diagram
To interpret this diagram, the successful completion of a NEW PAYMENT is assumed. Starting from this operation it’s possible to carry out different commands.
| For an explanation of the different status descriptions included in this diagram have a look at GETORDERDETAILS. |
| All possible commands for specific acquirers are found here. |