Integration Guide |
Version 6.9 |
As of 01.09.2019 |
Contents
Document history
Date | Name | Change |
|---|---|---|
01.09.2019 | Peter Posse | First version Confluence |
About paysafecard
General information about paysafecard
Paysafecard is a prepaid card that consumers buy in shops in order to subsequently shop online. Since this is a prepaid means of payment, this system is free from chargebacks. In addition it offers merchants a payment guarantee.
Paysafecard is widespread in the gaming, gambling and adult content sectors. The previous Wallie-card has now been adopted into the paysafecard system. You can tap into additional target groups with this prepaid system:
- customers who do not want to disclose personal data such as bank account or credit card number
- young people who are denied access to classic payment systems such as credit cards
- customers who do not obtain a credit card from their bank
- as well as customers who prefer to pay with paysafecard
The prepaid system is international: the paysafecard Group operates in 27 countries in Europe as well as in North and Latin America and processes around 20 million prepaid payments annually.
| paysafecard is a prepaid card which is a widespread micropayment method for gaming, gambling and adult-content. |
Further information can be found on the webpage of paysafecard (www.paysafecard.com).
Connections to paysafecard
You can link paysafecard payment methods either directly or via PPRO. If via PPRO, all transactions are posted as sales without further posting. However cancellation and batch processing is not possible. In this case the additional PPRO parameters are required.
With direct connection via the Computop Paygate the merchant can choose whether to carry out sales transactions or separately posted transactions. Please contact Computop Support for help with the necessary merchant configuration. In the variant with separate posting you can also carry out cancellations for the whole amount or for amounts not yet posted. In addition in this case batch processing is also possible for postings and cancellations.
Process flow chart
paysafecard process flow
Paygate interface
Payment with paysafecard via Paygate form interface
To make a payment with paysafecard over a Paygate form, go to the following URL:
Notice: For security reasons, Paygate 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 Computop. Additionally this parameter has to be passed in plain language too. | |
TransID | ans..64 | M | Merchant transaction number, which must be unique | |
RefNr | ns..30 | O | Unique reference number. In case of PPRO: Only characters a-zA-Z0-9,-_ are allowed, format ans..40. | |
Amount | n..12 | 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 | |
MAC | an64 | M | Hash Message Authentication Code (HMAC) with SHA-256 algorithm | |
OrderDesc | ans..768 | M | Description of delivered products, services etc. | |
Capture | a..6 | O | Determines the type and time of capture. <AUTO>: capturing immediately after authorisation (default value). <MANUAL>: capturing made by the merchant. <Number>: Delay in hours until the capture. paysafecard permits max. 1 hour delay until the capture. Other values must be agreed upon bilaterally. | |
Language | a2 | O | Language: <de> German (default), <en> English | |
URLSuccess | ans..256 | M | Complete URL which calls up Paygate 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 and shop, please use the parameter UserData. | |
URLFailure | ans..256 | M | Complete URL which calls up Paygate 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 and shop, please use the parameter UserData. | |
Response | a7 | O | Status response sent by Paygate to URLSuccess and URLFailure, should be encrypted. For this purpose, transmit Response=encrypt parameter. | |
URLNotify | ans..256 | M | Complete URL which Paygate 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. | |
UserData | ans..1024 | O | If specified at request, Paygate forwards the parameter with the payment result to the shop | |
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 will not carry out the payment, but will just return the status of the original transaction. | |
CustomerID | ans..50 | M | ID for uniquely identifying the customer | |
DispositionRestrictionAge | n..3 | O | Age restriction for the paysafecard user account | |
DispositionRestrichtionKYC | ans..20 | O | Restriction of KYC level (Know Your Customer) | |
DispositionRestrictionCountry | a2 | O | Restriction to a given country. Two characters country code according to ISO 3166 | |
SubID | ans..8 | O | Support for reporting filters for paysafecard payments; must be agreed with paysafecard. | |
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 | |
Additional parameters for connection via PPRO | ||||
AccOwner | ans..50 | M | Name of account holder | |
AddrCountryCode | a2 | M | Two characters country code according to ISO 3166 | |
SellingPoint | ans..50 | O | Selling point | |
Service | ans..50 | O | products or service sold | |
Channel | ans..64 | O | 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 | |
Parameters for payments with paysafecard
The following table describes the result parameters that the Paygate transmits to your URLSuccess, URLFailure or 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 | M | MerchantID, assigned by Computop |
PayID | an32 | M | ID assigned by Paygate for the payment, e.g. for referencing in batch files. |
XID | an32 | M | ID for all single transactions for one payment assigned by Paygate |
TransID | ans..64 | M | Merchant’s transaction number |
RefNr | ns..30 | O | Merchant’s unique reference number. In case of PPRO: Only characters a-zA-Z0-9,-_ are allowed, format ans..40. |
Status | a..30 | M | OK in the case of URLSuccess and AUTHORIZE_REQUEST or FAILED in the case of URLFailure |
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 Response Codes Excel file (part of the software client from https://www.computop.com/us/downloads/) |
MAC | an64 | M | Hash Message Authentication Code (HMAC) with SHA-256 algorithm |
UserData | ans..1024 | O | If specified at request, Paygate forwards the parameter with the payment result to the shop |
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 |
Additional parameters for connection via PPRO | |||
PaymentGuarantee | a..12 | C | NONE = no payment guarantee, Notice: This parameter is only returned if the Status=OK. |
ErrorText | ans..256 | C | Detailed PPRO error message. Notice: Is returned only if Status=FAILED. Use is possible only in agreement with Computop support. |
TransactionID | an..20 | O | Unique transaction number from PPRO |
Return parameters for URLSuccess, URLFailure and URLNotify with paysafecard
Capture of a payment with paysafecard
Captures are possible via a Server-to-Server connection. Captures are possible only if you have a direct connection to paysafecard and if this is configured for the merchant at Computop. To carry out a Capture for paysafecard via a Server-to-Server connection please use the following URL:
Notice: For security reasons, Paygate 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 Computop. Additionally this parameter has to be passed in plain language too. |
PayID | an32 | M | ID assigned by Paygate for the payment to be captured |
TransID | ans..40 | M | TransactionID which should be unique for each payment |
Amount | n..12 | 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 |
MAC | an64 | M | Hash Message Authentication Code (HMAC) with SHA-256 algorithm |
Parameters for captures of paysafecard via socket connections
The following table describes the Paygate response parameters:
Parameter | Format | CND | Description |
|---|---|---|---|
MID | ans..30 | M | MerchantID, assigned by Computop |
PayID | an32 | M | ID assigned by Paygate 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 |
TransID | ans..40 | M | TransactionID which should be unique for each payment |
Status | a..50 | M | OK 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 Response Codes Excel file (part of the software client from https://www.computop.com/us/downloads/) |
MAC | an64 | M | Hash Message Authentication Code (HMAC) with SHA-256 algorithm |
Response parameters for captures of paysafecard via socket connections
Reversal
Reversals are possible via a Server-to-Server connection. Reversals are possible only if you have a direct connection to paysafecard and if this is configured for the merchant at Computop. The Paygate permits only reversals that reference on a capture previously made via Paygate. Depending on the previous transaction status all as-yet unposted amounts can be cancelled.
To carry out a reversal with a reference transaction, please use the following URL:
Notice: For security reasons, Paygate 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 Computop. Additionally this parameter has to be passed in plain language too. |
PayID | an32 | M | ID assigned by Paygate for the payment to be reverted |
TransID | ans..40 | M | TransactionID which should be unique for each payment |
Amount | n..12 | 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 |
MAC | an64 | M | Hash Message Authentication Code (HMAC) with SHA-256 algorithm |
Parameters for reversal of payments with paysafecard via socket connection
The following table describes the Paygate response parameters:
Parameter | Format | CND | Description |
|---|---|---|---|
MID | ans..30 | M | MerchantID, assigned by Computop |
PayID | an32 | M | ID assigned by Paygate 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 |
TransID | ans..40 | M | TransactionID which should be unique for each payment |
Status | a..30 | M | OK 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 Response Codes Excel file (part of the software client from https://www.computop.com/us/downloads/) |
MAC | an64 | M | Hash Message Authentication Code (HMAC) with SHA-256 algorithm |
Response parameters for reversals of paysafecard via socket connections
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 within the data set (Record) for executing of payments / reversal for paysafecard and which information can be found within the response file about the payment status. Batch processing is possible only if you have a direct connection to paysafecard and if this is configured for the merchant at Computop.
Following table gives an overview of all batch versions that are possible for a specific action and their specialities:
Action | Version | Description |
|---|---|---|
Capture | 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) |
Reverse | 1.0 / 2.0 | Standard version without return of parameter Code |
| 1.x / 2x. | with RefNr (valid for all versions other than 1.0) |
Description of the possible batch versions
The structure for a paysafecard payment within a Batch file to be submitted is the following:
HEAD,<MerchantID>,<Date>,<Version> Paysafecard,Capture,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID> Paysafecard,Reverse,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID> 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, Paysafecard for paysafecard |
Action | a..20 | M | The parameter Action defines the type of transaction: Capture Reverse (cancellation) |
Amount | n..12 | 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..40 | M | TransactionID which should be unique for each payment |
RefNr | ns..30 | O | Unique reference number. In case of PPRO: Only characters a-zA-Z0-9,-_ are allowed, format ans..40. |
PayID | an32 | M | ID for this transaction given by Paygate |
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> Paysafecard,Capture,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>,<Status>, <Code> Paysafecard,Reverse,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>,<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: Capture |
PayID | an32 | M | ID for this transaction given by Paygate |
Status | a..50 | M | OK or FAILED |
Code | n8 | M | Error code according to Paygate 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