Integration Guide
Version 6.9
Contents
Table of Contents |
---|
Document history
Date
Name
Change
01.09.2019
Peter Posse
First version Confluence
About eps
General information about eps
In Austria Computop Paygate the Payment platform supports online money transfer with the Austrian Electronic Payment Standard (EPS). EPS is an established system for e-commerce payments in Austria offering a payment guarantee to the merchant. The customer can use the familiar and trusted online banking of its own credit institution, just the same as with online banking.
With online banking, the data disclosed in the online transfer is encrypted with SSL (Secure Sockets Layer) to prevent manipulation.
In Austria the online bank transfer with eps is very widespread in E-commerce and thus an interesting addition to the payment mix. Additionally the merchant gets a payment guarantee. |
Further information can be found on the webpage of eps / STUZZA (www.stuzza.at).
Process flow chart
eps process flow
Payment platform interface
Multiexcerpt include | ||||||
---|---|---|---|---|---|---|
|
Calling the eps interface
The eps connection with a Paygate form can be either direct or via PPRO, where the interface form and process are largely identical. With the PPRO connection there are a few added parameters which are explained separately in the table. Subsequent credits and batch transfer credits can only be made with the PPRO connection.To make a payment in Austria with eps online transfer via a Paygate Payment platform form, go to the following URL:
Notice: For security reasons, Paygate Payment platform rejects all payment requests with formatting errors. Therefore please use the correct data type for each parameter.
Notice: An eps connection via iFrame is not possible due to eps regulations and will be prevented technically.
The following table describes the encrypted payment request parameters:
Parameter | Format | CND | Description | |||||
---|---|---|---|---|---|---|---|---|
MerchantID | ans..30 | M | MerchantID, assigned by ComputopID of merchant. Additionally this parameter has to be passed in plain language too. | |||||
TransID | ans..64 | M | TransactionID which should be unique for each payment | |||||
RefNr | nsans..3040 | M | Unique Merchant's unique reference numberIn case of PPRO: . Only characters a-zA-Z0-9,-_ are allowed, format ans..40. | |||||
Amount | n..1210 | M | Amount in the smallest currency unit (e.g. EUR Cent) Please contact the helpdesk, if you want to capture amounts < 100 (smallest currency unit). | |||||
Currency | a3 | M | Currency, three digits DIN / ISO 4217 Only EUR is permissible.OptionDate | |||||
ans10 | OC | Not with PPRO: desired payment execution date in the format YYYY-MM-DD | OrderDesc | ans..768 | MIntended use on statement of account (max 35 digits) | With PPRO: Description of purchased goods, unit prices etc. | OrderDesc2 | ans..384C |
Not with PPRO: Number and description of purchased products, individual prices, comma-separated list, no special characters allowed | AccOwner | ans..50 | OCM | Obligatory for PPRO: Name of account holder | ||||
IBAN | ans..34 | OCM | Obligatory for PPRO: International Bank Account Number for SEPA | |||||
BIC | ans..11 | OCM | Obligatory for PPRO: Bank Identifier Code for SEPA | |||||
MAC | an64 | M | Hash Message Authentication Code (HMAC) with SHA-256 algorithm | |||||
UserData | ans..1024 | O | If specified at request, Paygate Payment platform forwards the parameter with the payment result to the shop | |||||
URLSuccess | ans..256 | M | Complete URL which calls up Paygate Payment platform if payment has been successful. The URL may be called up only via port 443 This URL may not contain parameters: In order to exchange values between Paygate Payment platform and shop, please use the parameter UserData. | |||||
URLFailure | ans..256 | M | Complete URL which calls up Paygate Payment platform if payment has been unsuccessful. The URL may be called up only via port 443 This URL may not contain parameters: In order to exchange values between Paygate Payment platform and shop, please use the parameter UserData. | |||||
Response | a7 | O | Status response sent by Paygate Payment platform to URLSuccess and URLFailure, should be encrypted. For this purpose, transmit Response=encrypt parameter. | |||||
URLNotify | ans..256 | O | Complete URL which Paygate Payment platform calls up in order to notify the shop about the payment result. The URL may be called up only via port 443 It may not contain parameters: Use the UserData parameter instead. | |||||
ReqID | ans..32 | O | To avoid double payments, enter an alphanumeric value which identifies your transaction and may be assigned only once. If the transaction is submitted again with the same ReqID, Paygate the payment platform will not carry out the payment, but will just return the status of the original transaction. Please note that the payment platform must have a finalized transaction status for the first initial action. Submissions with identical ReqID for an open status will be processed regularly. | |||||
SellingPoint | ans..50 | CO | Only with PPRO: Selling point | |||||
Service | ans..50 | C | O | Products Only with PPRO: products or service sold | ||||
Channel | ans..64 | OC | O | Configuration Only with PPRO: configuration channel of the PPRO contract (account and ContractID are stored in the system). If it exists, it may overwrite channels stored in the system. | ||||
Language | a2 | =O | Only with PPRO: 2-letter language code (e.g.. de) that should be preferred when presenting payment pages to the consumer | |||||
Plain | ans..50 | O | A value to be set by the merchant to return some information unencrypted, e.g. the MID | |||||
Custom | ans..1024 | O | The merchant can submit several values separated by | which are returned unencrypted and separated by &. Custom=session=123|id=456 will change in the answer to Session=123&id=456 |
Parameters for online transfers with eps
The following table gives the result parameters which the Paygate Payment platform transmits to URLSuccess or URLFailure and URLNotify. If you have specified the Response=encrypt parameter, the following parameters are forwarded Blowfish encrypted to your system:
Parameter | Format | CND | Description | |
---|---|---|---|---|
MID | ans..30 | MMerchantID, assigned by Computop | ID of merchant | |
PayID | an32 | M | ID assigned by Paygate Payment platform for the payment, e.g. for referencing in batch files. | |
XID | an32 | M | ID for all single transactions (authorisation, capture, credit note) for one payment assigned by Paygate Payment platform | |
TransID | ans..64 | M | Merchant transaction number, which must be unique | |
Status | a..50 | M | OK, AUTHORIZED (URLSuccess) or FAILED (URLFailure) .with PPRO and also AUTHORIZE_REQUEST | |
Description | ans..1024 | M | Further details in the event that payment is rejected. Please do not use the Description but the Code parameter for the transaction status analysis! | |
Code | n8 | M | Error code according to Paygate Payment platform Response Codes Excel file (part of the software client from https://www.computop.com/us/downloads/) | |
RefNr | nsans..3040 | O | Merchant’s unique reference numberIn case of PPRO: . Only characters a-zA-Z0-9,-_ are allowed, format ans..40. | |
UserData | ans..1024 | O | If specified at request, Paygate Payment platform forwards the parameter with the payment result to the shop | |
MAC | an64 | M | Hash Message Authentication Code (HMAC) with SHA-256 algorithm | |
AccOwner | ans..50 | M | Name of account holder | |
IBAN | ans..34 | OCM | Obligatory for PPRO: International Bank Account Number for SEPA | |
BIC | ans..11 | OCM | Obligatory for PPRO: Bank Identifier Code for SEPA | |
PaymentPurpose | ans..26 | CO | Only with PPRO: Purpose of payment | |
PaymentGuarantee | a..12 | CO | Only with PPRO: NONE= no payment guarantee, VALIDATED= customer account valid, but no payment guarantee, FULL= payment guarantee Notice: This parameter is only returned if the Status=OK. | |
ErrorText | ans..128 | CO | Only with PPRO: Detailed PPRO error message. Notice: Is returned only if Status=FAILED. Use is possible only in agreement with Computop support. | |
TransactionID | an..20 | O | Only with PPRO: Unique transaction number from PPRO | |
Plain | ans..50 | O | A value to be set by the merchant to return some information unencrypted, e.g. the MID | |
Custom | ans..1024 | O | The merchant can submit several values separated by | which are returned unencrypted and separated by &. Custom=session=123|id=456 will change in the answer to Session=123&id=456 |
Result parameters for URLNotify, URLSuccess and URLFailure in case of eps
Credit with reference
Credits (refunds) are possible via a Server-to-Server connection. Eps credits are only allowed with the PPRO connection. Paygate Payment platform permits only credits for eps that reference on a capture previously made via PaygatePayment platform. The amount of the Credit is limited to the amount of the previous capture.
To carry out a credit with a reference transaction, please use the following URL:
Notice: For security reasons, Paygate Payment platform rejects all payment requests with formatting errors. Therefore please use the correct data type for each parameter.
The following table describes the encrypted payment request parameters:
Parameter | Format | CND | Description |
---|---|---|---|
MerchantID | ans..30 | M | MerchantID, assigned by ComputopID of merchant. Additionally this parameter has to be passed in plain language too. |
PayID | an32 | M | ID assigned by Paygate Payment platform for the payment to be credited |
TransID | ans..64 | M | TransactionID which should be unique for each payment |
MAC | an64 | M | Hash Message Authentication Code (HMAC) with SHA-256 algorithm |
Amount | n..1210 | M | Amount in the smallest currency unit (e.g. EUR Cent) Please contact the helpdesk, if you want to capture amounts < 100 (smallest currency unit). |
Currency | a..3 | M | Currency code, three digits DIN / ISO 4217 |
ReqID | ans.32 | O | To avoid double payments, enter an alphanumeric value which identifies your transaction and may be assigned only once. If the transaction is submitted again with the same ReqID, the payment platform will not carry out the payment, but will just return the status of the original transaction. Please note that the payment platform must have a finalized transaction status for the first initial action. Submissions with identical ReqID for an open status will be processed regularly. |
Parameters for credits of eps payments
The following table describes the Paygate Payment platform response parameters:
Parameter | Format | CND | Description | ||||
---|---|---|---|---|---|---|---|
MID | ans..30 | CMerchantID, assigned by Computop | ID of merchant | ||||
PayID | an32 | M | ID assigned by Paygate Payment platform for the payment, e.g. for referencing in batch files. | ||||
XID | an32 | M | ID for all single transactions (authorisation, capture, credit note) for one payment assigned by Paygate Payment platform | ||||
TransID | ans..64 | M | Merchant’s transaction number | ||||
Status | a..30 | M | OK, AUTHORIZE_REQUEST or FAILED | ||||
Description | ans..1024 | M | Further details in the event that payment is rejected. Please do not use the Description but the Code parameter for the transaction status analysis! | ||||
Code | n8 | M | Error code according to Paygate Payment platform Response Codes Excel file (part of the software client from https://www.computop.com/us/downloads/) | ||||
ErrorText | ans..128 | O | Detailed PPRO error message Notice: Is returned only if Status=FAILED. Use is possible only in agreement with Computop support. | TransactionID | an..20 | O | Only with PPRO: Unique transaction number from PPRO |
Result parameters for credits of eps payments
Batch processing via the interface
Basic information about using Batch files and about their structure can be found in the Batch Manager manual. Within batch processing not alle functions are available which are usually available for the online interface.
This section describes the parameters which must be transferred with the data set (Record) for executing an eps credit and which information can be found within the response file about the payment status.
Notice: Please note that Batch processing for eps is possible only via PPRO connection.
Following table gives an overview of all batch versions that are possible for a specific action an their specialities:
Action | Version | Description |
---|---|---|
Credit | 1.0 / 2.0 | Standard version without return of parameter Code |
| 1.x / 2.x | with RefNr (valid for all versions other than 1.0) |
Description of the possible batch versions
The structure for an eps credit within a Batch file to be submitted is the following:
HEAD,<MerchantID>,<Date>,<Version> EPS,Credit,<PayID>,<TransID>,(<RefNr>),<Amount>,<Currency> FOOT,<CountRecords>,<SumAmount> |
Example for Master MID Funktion:
HEAD,[Master]MerchantID,Date,2.x Type,Action,[Slave]MID,Amount,Currency,TransID,Data (depends on Action) FOOT,CountRecords,SumAmount |
The following table describes the individual fields and values used within the data set (record) in the batch file:
Parameter | Format | CND | Description |
---|---|---|---|
Type | a..11 | M | HEAD for Header, FOOT for Footer, EPS for direct eps |
Action | a..20 | M | The parameter Action defines the type of transaction: Credit |
Amount | n..1210 | M | Amount in the smallest currency unit (e.g. EUR Cent) Please contact the helpdesk, if you want to capture amounts < 100 (smallest currency unit). |
Currency | a3 | M | Currency code, three digits DIN / ISO 4217 |
TransID | ans..64 | M | TransactionID which should be unique for each payment |
RefNr | nsans..3040 | O | Unique Merchant's unique reference numberIn case of PPRO: . Only characters a-zA-Z0-9,-_ are allowed, format ans..40. |
PayID | an32 | M | ID for this transaction given by Paygate Payment platform |
Description of fields within the record for Batch files
The record area within the response file for Batch transactions looks the following way:
HEAD,<MerchantID>,<Date>,<Version> EPS,Credit,<PayID>,<TransID>,(<RefNr>),<Amount>,<Currency>,<Status>,<Code> FOOT,<CountRecords>,<SumAmount> |
The following table describes the response parameters which the Batch Manager saves in the Record area for each transaction (standard parameters not explained here, such as <TransID> or <RefNR> and request parameters are returned unchanged and correspond to the call as specified before):
Parameter | Format | CND | Description |
---|---|---|---|
Action | a..20 | M | The parameter Action defines the type of transaction: Credit |
PayID | an32 | M | ID for this transaction given by Paygate Payment platform |
Status | a..50 | M | OK or FAILED |
Code | n8 | M | Error code according to Paygate Payment platform Response Codes Excel file (part of the software client from https://www.computop.com/us/downloads/) |
Description of result parameters within the record for Batch files